Bug 832095 - Request new buglist/query hooks

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());

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'};

query.cgi

@@ -95,7 +95,7 @@ my $userdefaultquery;
 if ($userid) {
     $userdefaultquery = $dbh->selectrow_array(
         "SELECT query FROM namedqueries " .
-         "WHERE userid = ? AND name = ?", 
+         "WHERE userid = ? AND name = ?",
          undef, ($userid, DEFAULT_QUERY_NAME));
 }
 
@@ -128,7 +128,7 @@ sub PrefillForm {
         next if grep { $_ eq $name } @skip;
         $foundone = 1;
         my @values = $buf->param($name);
-        
+
         # If the name is a single letter followed by numbers, it's part
         # of Custom Search. We store these as an array of hashes.
         if ($name =~ /^([[:lower:]])(\d+)$/) {
@@ -158,9 +158,9 @@ if (!PrefillForm($buffer)) {
     }
 }
 
-# if using groups for entry, then we don't want people to see products they 
+# if using groups for entry, then we don't want people to see products they
 # don't have access to. Remove them from the list.
-my @selectable_products = sort {lc($a->name) cmp lc($b->name)} 
+my @selectable_products = sort {lc($a->name) cmp lc($b->name)}
                                @{$user->get_selectable_products};
 Bugzilla::Product::preload(\@selectable_products);
 $vars->{'product'} = \@selectable_products;
@@ -297,10 +297,12 @@ if (defined($vars->{'format'}) && IsValidQueryType($vars->{'format'})) {
 # If we submit back to ourselves (for e.g. boolean charts), we need to
 # preserve format information; hence query_format taking priority over
 # format.
-my $format = $template->get_format("search/search", 
-                                   $vars->{'query_format'} || $vars->{'format'}, 
+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)