From: mkanat%bugzilla.org <>
Date: Mon, 23 Nov 2009 06:37:01 +0000 (+0000)
Subject: Bug 523999: New Hook: template-before_create
X-Git-Tag: bugzilla-3.5.3~104
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c4b313b45914fd0a98dd23e485b778f092e9ba3b;p=thirdparty%2Fbugzilla.git

Bug 523999: New Hook: template-before_create
Patch by Max Kanat-Alexander <mkanat@bugzilla.org> (module owner) a=mkanat
---

diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index b922559b5c..dc1cd6be1d 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -786,6 +786,25 @@ to the user. (F<sanitycheck.cgi>'s C<Status>)
 
 =back
 
+=head2 template-before_create
+
+This hook allows you to modify the configuration of L<Bugzilla::Template>
+objects before they are created. For example, you could add a new
+global template variable this way.
+
+Params:
+
+=over
+
+=item C<config>
+
+A hashref--the configuration that will be passed to L<Template/new>.
+See L<http://template-toolkit.org/docs/modules/Template.html#section_CONFIGURATION_SUMMARY>
+for information on how this configuration variable is structured (or just
+look at the code for C<create> in L<Bugzilla::Template>.)
+
+=back
+
 =head2 template-before_process
 
 This hook allows you to define additional variables that will be available to
diff --git a/Bugzilla/Template.pm b/Bugzilla/Template.pm
index 17429a2e2e..b61d28bc71 100644
--- a/Bugzilla/Template.pm
+++ b/Bugzilla/Template.pm
@@ -36,6 +36,7 @@ use strict;
 
 use Bugzilla::Bug;
 use Bugzilla::Constants;
+use Bugzilla::Hook;
 use Bugzilla::Install::Requirements;
 use Bugzilla::Install::Util qw(install_string template_include_path 
                                include_languages);
@@ -470,7 +471,7 @@ sub create {
     # IMPORTANT - If you make any configuration changes here, make sure to
     # make them in t/004.template.t and checksetup.pl.
 
-    return $class->new({
+    my $config = {
         # Colon-separated list of directories containing templates.
         INCLUDE_PATH => [\&getTemplateIncludePath],
 
@@ -797,8 +798,12 @@ sub create {
                 return \@optional;
             },
         },
+    };
 
-   }) || die("Template creation failed: " . $class->error());
+    Bugzilla::Hook::process('template-before_create', { config => $config });
+    my $template = $class->new($config) 
+        || die("Template creation failed: " . $class->error());
+    return $template;
 }
 
 # Used as part of the two subroutines below.
diff --git a/extensions/example/code/template-before_create.pl b/extensions/example/code/template-before_create.pl
new file mode 100644
index 0000000000..fa21f08cc6
--- /dev/null
+++ b/extensions/example/code/template-before_create.pl
@@ -0,0 +1,30 @@
+# -*- 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 Example Plugin.
+#
+# 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>
+
+use strict;
+use warnings;
+use Bugzilla;
+
+my $config = Bugzilla->hook_args->{'config'};
+# This will be accessible as "example_global_variable" in every
+# template in Bugzilla. See Bugzilla/Template.pm's create() function
+# for more things that you can set.
+$config->{VARIABLES}->{example_global_variable} = sub { return 'value' };