summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormkanat%bugzilla.org <>2009-12-15 00:07:08 +0100
committermkanat%bugzilla.org <>2009-12-15 00:07:08 +0100
commit7d331618db87ff7ae268b3c73d5f07ec122af9c2 (patch)
treee8920de2fbefac7c0523832dacc2586431c85eb4
parent6ffb51d5e4588d65895854b88a1d1ef089cd2283 (diff)
downloadbugzilla-7d331618db87ff7ae268b3c73d5f07ec122af9c2.tar.gz
bugzilla-7d331618db87ff7ae268b3c73d5f07ec122af9c2.tar.xz
Bug 523762: Prevent the template_before_process hook from causing an infinite recursion when an error is thrown
Patch by Max Kanat-Alexander <mkanat@bugzilla.org> r=dkl, a=mkanat
-rw-r--r--Bugzilla/Hook.pm34
-rw-r--r--Bugzilla/Template.pm12
2 files changed, 43 insertions, 3 deletions
diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index b042f36ad..5093db903 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -25,11 +25,32 @@ use strict;
sub process {
my ($name, $args) = @_;
+
+ _entering($name);
+
foreach my $extension (@{ Bugzilla->extensions }) {
if ($extension->can($name)) {
$extension->$name($args);
}
}
+
+ _leaving($name);
+}
+
+sub in {
+ my $hook_name = shift;
+ my $currently_in = Bugzilla->request_cache->{hook_stack}->[-1] || '';
+ return $hook_name eq $currently_in ? 1 : 0;
+}
+
+sub _entering {
+ my ($hook_name) = @_;
+ my $hook_stack = Bugzilla->request_cache->{hook_stack} ||= [];
+ push(@$hook_stack, $hook_name);
+}
+
+sub _leaving {
+ pop @{ Bugzilla->request_cache->{hook_stack} };
}
1;
@@ -395,6 +416,8 @@ L</config_add_panels> if you want to add new panels.
=head2 enter_bug_entrydefaultvars
+B<DEPRECATED> - Use L</template_before_process> instead.
+
This happens right before the template is loaded on enter_bug.cgi.
Params:
@@ -635,6 +658,8 @@ your template.
=head2 product_confirm_delete
+B<DEPRECATED> - Use L</template_before_process> instead.
+
Called before displaying the confirmation message when deleting a product.
Params:
@@ -715,6 +740,10 @@ to operating only if a certain file is being loaded (which is why you
get a C<file> argument below). Otherwise, modifying the C<vars> argument
will affect every single template in Bugzilla.
+Note that this is only called on the top-level C<< $template->process >>
+call. It is not called for C<[% PROCESS %]> or C<[% INCLUDE %]> statements
+in templates.
+
Params:
=over
@@ -738,6 +767,11 @@ The L<Bugzilla::Template> object that C<process> was called on.
=back
+B<Note:> This hook is not called if you are already in this hook.
+(That is, it won't call itself recursively.) This prevents infinite
+recursion in situations where this hook needs to process a template
+(such as if this hook throws an error).
+
=head2 webservice
This hook allows you to add your own modules to the WebService. (See
diff --git a/Bugzilla/Template.pm b/Bugzilla/Template.pm
index 028914164..c8e3bc69c 100644
--- a/Bugzilla/Template.pm
+++ b/Bugzilla/Template.pm
@@ -86,9 +86,15 @@ sub process {
my $self = shift;
my ($file, $vars) = @_;
- #Bugzilla::Hook::process('template_before_process',
- # { vars => $vars, file => $file,
- # template => $self });
+ # This hook can't call itself recursively, because otherwise we
+ # end up with problems when we throw an error inside of extensions
+ # (they end up in infinite recursion, because throwing an error involves
+ # processing a template).
+ if (!Bugzilla::Hook::in('template_before_process')) {
+ Bugzilla::Hook::process('template_before_process',
+ { vars => $vars, file => $file,
+ template => $self });
+ }
return $self->SUPER::process(@_);
}