105 lines
4.1 KiB
Perl
105 lines
4.1 KiB
Perl
# -*- Mode: perl; indent-tabs-mode: nil -*-
|
|
#
|
|
# The contents of this file are subject to the Mozilla Public
|
|
# License Version 1.1 (the "License"); you may not use this file
|
|
# except in compliance with the License. You may obtain a copy of
|
|
# the License at http://www.mozilla.org/MPL/
|
|
#
|
|
# Software distributed under the License is distributed on an "AS
|
|
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
# implied. See the License for the specific language governing
|
|
# rights and limitations under the License.
|
|
#
|
|
# The Original Code is the Bugzilla Bug Tracking System.
|
|
#
|
|
# The Initial Developer of the Original Code is ITA Software.
|
|
# Portions created by the Initial Developer are Copyright (C) 2009
|
|
# the Initial Developer. All Rights Reserved.
|
|
#
|
|
# Contributor(s):
|
|
# Max Kanat-Alexander <mkanat@bugzilla.org>
|
|
|
|
# This exists to implement the template-before_process hook.
|
|
package Bugzilla::Template::Context;
|
|
use strict;
|
|
use base qw(Template::Context);
|
|
|
|
use Bugzilla::Hook;
|
|
use Scalar::Util qw(blessed);
|
|
|
|
sub process {
|
|
my $self = shift;
|
|
# We don't want to run the template_before_process hook for
|
|
# template hooks (but we do want it to run if a hook calls
|
|
# PROCESS inside itself). The problem is that the {component}->{name} of
|
|
# hooks is unreliable--sometimes it starts with ./ and it's the
|
|
# full path to the hook template, and sometimes it's just the relative
|
|
# name (like hook/global/field-descs-end.none.tmpl). Also, calling
|
|
# template_before_process for hook templates doesn't seem too useful,
|
|
# because that's already part of the extension and they should be able
|
|
# to modify their hook if they want (or just modify the variables in the
|
|
# calling template).
|
|
if (not delete $self->{bz_in_hook}) {
|
|
$self->{bz_in_process} = 1;
|
|
}
|
|
my $result = $self->SUPER::process(@_);
|
|
delete $self->{bz_in_process};
|
|
return $result;
|
|
}
|
|
|
|
# This method is called by Template-Toolkit exactly once per template or
|
|
# block (look at a compiled template) so this is an ideal place for us to
|
|
# modify the variables before a template or block runs.
|
|
#
|
|
# We don't do it during Context::process because at that time
|
|
# our stash hasn't been set correctly--the parameters we were passed
|
|
# in the PROCESS or INCLUDE directive haven't been set, and if we're
|
|
# in an INCLUDE, the stash is not yet localized during process().
|
|
sub stash {
|
|
my $self = shift;
|
|
my $stash = $self->SUPER::stash(@_);
|
|
|
|
my $name = $stash->get([ 'component', 0, 'name', 0 ]);
|
|
my $pre_process = $self->config->{PRE_PROCESS};
|
|
|
|
# Checking bz_in_process tells us that we were indeed called as part of a
|
|
# Context::process, and not at some other point.
|
|
#
|
|
# Checking $name makes sure that we're processing a file, and not just a
|
|
# block, by checking that the name has a period in it. We don't allow
|
|
# blocks because their names are too unreliable--an extension could have
|
|
# a block with the same name, or multiple files could have a same-named
|
|
# block, and then your extension would malfunction.
|
|
#
|
|
# We also make sure that we don't run, ever, during the PRE_PROCESS
|
|
# templates, because if somebody calls Throw*Error globally inside of
|
|
# template_before_process, that causes an infinite recursion into
|
|
# the PRE_PROCESS templates (because Bugzilla, while inside
|
|
# global/intialize.none.tmpl, loads the template again to create the
|
|
# template object for Throw*Error).
|
|
#
|
|
# Checking Bugzilla::Hook::in prevents infinite recursion on this hook.
|
|
if ($self->{bz_in_process} and $name =~ /\./
|
|
and !grep($_ eq $name, @$pre_process)
|
|
and !Bugzilla::Hook::in('template_before_process'))
|
|
{
|
|
Bugzilla::Hook::process("template_before_process",
|
|
{ vars => $stash, context => $self,
|
|
file => $name });
|
|
}
|
|
|
|
# This prevents other calls to stash() that might somehow happen
|
|
# later in the file from also triggering the hook.
|
|
delete $self->{bz_in_process};
|
|
|
|
return $stash;
|
|
}
|
|
|
|
# We need a DESTROY sub for the same reason that Bugzilla::CGI does.
|
|
sub DESTROY {
|
|
my $self = shift;
|
|
$self->SUPER::DESTROY(@_);
|
|
};
|
|
|
|
1;
|