From 01b04318e8d465fc9697cf4eba97b7ce112705d0 Mon Sep 17 00:00:00 2001
From: Albert Ting <altlist@gmail.com>
Date: Thu, 8 Jan 2015 12:49:25 -0500
Subject: [PATCH] Bug 832095 - Request new buglist/query hooks

---
 Bugzilla/Hook.pm                | 66 +++++++++++++++++++++++++++++++++
 buglist.cgi                     |  9 ++++-
 extensions/Example/Extension.pm | 23 ++++++++++++
 query.cgi                       |  2 +
 4 files changed, 98 insertions(+), 2 deletions(-)

diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index 430d5af49a..40fdff155e 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -533,6 +533,33 @@ table should be joined with the C<bugs> table. If omitted, LEFT is used.
 
 =back
 
+=head2 buglist_format
+
+This happens in F<buglist.cgi>, used to change the template variables before
+processing the associated template hook.
+
+Params:
+
+=over
+
+=item C<vars>
+
+This is the entire set of variables that the current template
+can see.
+
+=item C<file>
+
+The name of the template file being processed. This is
+relative to the main template directory for the language (i.e. for
+F<template/en/default/list/list.html.tmpl>, this variable will contain
+C<list/list.html.tmpl>).
+
+=item C<params>
+
+A hashref. The set of named parameters extracted from cgi.
+
+=back
+
 =head2 search_operator_field_override
 
 This allows you to modify L<Bugzilla::Search/OPERATOR_FIELD_OVERRIDE>,
@@ -1417,6 +1444,45 @@ Params:
 
 =back
 
+=head2 query_default_list
+
+This happens in F<query.cgi>, used to include additional cgi params to be
+searched for in order to create the set of default values.
+
+Params:
+
+=over
+
+=item C<list>
+
+The current list of cgi params to search for.
+
+=back
+
+=head2 query_format
+
+This happens in F<query.cgi>, used to to add/modify $vars before
+processing the template.  For example, one could supply or modify the
+default values for a custom query format.
+
+Params:
+
+=over
+
+=item C<vars>
+
+This is the entire set of variables that the current template
+can see.
+
+=item C<file>
+
+The name of the template file being processed. This is
+relative to the main template directory for the language (i.e. for
+F<template/en/default/list/list.html.tmpl>, this variable will contain
+C<list/list.html.tmpl>).
+
+=back
+
 =head2 quicksearch_map
 
 This hook allows you to alter the Quicksearch syntax to include e.g. special 
diff --git a/buglist.cgi b/buglist.cgi
index b03cc94818..2d39367ab7 100755
--- a/buglist.cgi
+++ b/buglist.cgi
@@ -25,6 +25,7 @@ use Bugzilla::Product;
 use Bugzilla::Field;
 use Bugzilla::Status;
 use Bugzilla::Token;
+use Bugzilla::Hook;
 
 use Date::Parse;
 
@@ -447,8 +448,8 @@ if (!$params->param('query_format')) {
 # Determine the format in which the user would like to receive the output.
 # Uses the default format if the user did not specify an output format;
 # otherwise validates the user's choice against the list of available formats.
-my $format = $template->get_format("list/list", scalar $cgi->param('format'),
-                                   scalar $cgi->param('ctype'));
+my $format = $template->get_format("list/list", scalar $params->param('format'),
+                                   scalar $params->param('ctype'));
 
 # Use server push to display a "Please wait..." message for the user while
 # executing their query if their browser supports it and they are viewing
@@ -1124,6 +1125,10 @@ $cgi->close_standby_message($contenttype, $disposition, $disp_prefix, $format->{
 # Content Generation
 ################################################################################
 
+Bugzilla::Hook::process("buglist_format", {'vars' => $vars,
+                                           'format' => $format,
+                                           'params' => $params});
+
 # Generate and return the UI (HTML page) from the appropriate template.
 $template->process($format->{'template'}, $vars)
   || ThrowTemplateError($template->error());
diff --git a/extensions/Example/Extension.pm b/extensions/Example/Extension.pm
index af36b107af..0ab5220a77 100644
--- a/extensions/Example/Extension.pm
+++ b/extensions/Example/Extension.pm
@@ -304,6 +304,17 @@ sub buglist_column_joins {
     };
 }
 
+sub buglist_format {
+    my ($self, $args) = @_;
+    my $vars = $args->{'vars'};
+    my $format = $args->{'format'};
+    my $params = $args->{'params'};
+
+    if ($format->{'template'} eq "list/list-example.html.tmpl") {
+        $vars->{'example'} = $params->param('example');
+    }
+}
+
 sub search_operator_field_override {
     my ($self, $args) = @_;
     
@@ -856,6 +867,18 @@ sub product_end_of_create {
     }
 }
 
+sub query_format {
+    my ($self, $args) = @_;
+    my $vars = $args->{'vars'};
+    my $default = $vars->{'default'};
+    my $format = $args->{'format'};
+
+    # change some default values
+    if ($format->{'template'} eq "search/search-example.html.tmpl") {
+        $default->{'example'}[0] = $default->{'example'}[0] || "example";
+    }
+}
+
 sub quicksearch_map {
     my ($self, $args) = @_;
     my $map = $args->{'map'};
diff --git a/query.cgi b/query.cgi
index faf670d231..d98bb09795 100755
--- a/query.cgi
+++ b/query.cgi
@@ -301,6 +301,8 @@ my $format = $template->get_format("search/search",
                                    $vars->{'query_format'} || $vars->{'format'}, 
                                    scalar $cgi->param('ctype'));
 
+Bugzilla::Hook::process("query_format", {'vars' => $vars, 'format' => $format});
+
 print $cgi->header($format->{'ctype'});
 
 $template->process($format->{'template'}, $vars)
-- 
2.47.2