summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormkanat%bugzilla.org <>2006-08-01 07:17:09 +0200
committermkanat%bugzilla.org <>2006-08-01 07:17:09 +0200
commitef536b4a8ff4f9c8ff82da5d4e3114721c20926e (patch)
tree41a4f6ad9052180bacf12b3bb32041a4aa5aa214
parent18c57070565d1218935168b437f4adcfe9b38ce4 (diff)
downloadbugzilla-ef536b4a8ff4f9c8ff82da5d4e3114721c20926e.tar.gz
bugzilla-ef536b4a8ff4f9c8ff82da5d4e3114721c20926e.tar.xz
Bug 346493: Move Template pre-compilation code into a module
Patch By Max Kanat-Alexander <mkanat@bugzilla.org> (module owner) a=myk
-rw-r--r--Bugzilla/Template.pm95
-rwxr-xr-xchecksetup.pl69
2 files changed, 99 insertions, 65 deletions
diff --git a/Bugzilla/Template.pm b/Bugzilla/Template.pm
index cf076171d..f3625ee22 100644
--- a/Bugzilla/Template.pm
+++ b/Bugzilla/Template.pm
@@ -43,6 +43,10 @@ use Bugzilla::Bug;
# for time2str - replace by TT Date plugin??
use Date::Format ();
+use File::Find;
+use File::Path;
+use File::Spec;
+use IO::Dir;
use base qw(Template);
@@ -801,6 +805,81 @@ sub create {
}) || die("Template creation failed: " . $class->error());
}
+# Used as part of the two subroutines below.
+our (%_templates_to_precompile, $_current_path);
+
+sub precompile_templates {
+ my ($output) = @_;
+
+ # Remove the compiled templates.
+ my $datadir = bz_locations()->{'datadir'};
+ if (-e "$datadir/template") {
+ print "Removing existing compiled templates ...\n" if $output;
+
+ # XXX This frequently fails if the webserver made the files, because
+ # then the webserver owns the directories. We could fix that by
+ # doing a chmod/chown on all the directories here.
+ rmtree("$datadir/template");
+
+ # Check that the directory was really removed
+ if(-e "$datadir/template") {
+ print "\n\n";
+ print "The directory '$datadir/template' could not be removed.\n";
+ print "Please remove it manually and rerun checksetup.pl.\n\n";
+ exit;
+ }
+ }
+
+ print "Precompiling templates...\n" if $output;
+
+ my $templatedir = bz_locations()->{'templatedir'};
+ # Don't hang on templates which use the CGI library
+ eval("use CGI qw(-no_debug)");
+
+ my $dir_reader = new IO::Dir($templatedir) || die "$templatedir: $!";
+ my @language_dirs = grep { /^[a-z-]+$/i } $dir_reader->read;
+ $dir_reader->close;
+
+ foreach my $dir (@language_dirs) {
+ next if ($dir eq 'CVS');
+ -d "$templatedir/$dir/default" || -d "$templatedir/$dir/custom"
+ || next;
+ local $ENV{'HTTP_ACCEPT_LANGUAGE'} = $dir;
+ # We locally hack this parameter so that Bugzilla::Template
+ # accepts this language no matter what.
+ local Bugzilla->params->{'languages'} = "$dir,en";
+ my $template = Bugzilla::Template->create(clean_cache => 1);
+
+ # Precompile all the templates found in all the directories.
+ %_templates_to_precompile = ();
+ foreach my $subdir (qw(custom extension default), bz_locations()->{'project'}) {
+ $_current_path = File::Spec->catdir($templatedir, $dir, $subdir);
+ next unless -d $_current_path;
+ # Traverse the template hierarchy.
+ find({ wanted => \&_precompile_push, no_chdir => 1 }, $_current_path);
+ }
+ # The sort isn't totally necessary, but it makes debugging easier
+ # by making the templates always be compiled in the same order.
+ foreach my $file (sort keys %_templates_to_precompile) {
+ my $path = File::Spec->catdir($templatedir, $dir);
+ # Compile the template but throw away the result. This has the side-
+ # effect of writing the compiled version to disk.
+ $template->context->template($file);
+ }
+ }
+}
+
+# Helper for precompile_templates
+sub _precompile_push {
+ my $name = $File::Find::name;
+ return if (-d $name);
+ return if ($name =~ /\/CVS\//);
+ return if ($name !~ /\.tmpl$/);
+
+ $name =~ s/\Q$_current_path\E\///;
+ $_templates_to_precompile{$name} = 1;
+}
+
1;
__END__
@@ -828,6 +907,22 @@ the C<Template> constructor.
It should not be used directly by scripts or modules - instead, use
C<Bugzilla-E<gt>instance-E<gt>template> to get an already created module.
+=head1 SUBROUTINES
+
+=over
+
+=item C<precompile_templates($output)>
+
+Description: Compiles all of Bugzilla's templates in every language.
+ Used mostly by F<checksetup.pl>.
+
+Params: C<$output> - C<true> if you want the function to print
+ out information about what it's doing.
+
+Returns: nothing
+
+=back
+
=head1 METHODS
=over
diff --git a/checksetup.pl b/checksetup.pl
index 00230e5c5..6eeeac0ed 100755
--- a/checksetup.pl
+++ b/checksetup.pl
@@ -222,7 +222,6 @@ L<Bugzilla::DB/CONNECTION>
use strict;
use 5.008;
use File::Basename;
-use File::Find;
use Getopt::Long qw(:config bundling);
use Pod::Usage;
use Safe;
@@ -316,6 +315,7 @@ require Bugzilla::Install::Filesystem;
import Bugzilla::Install::Filesystem qw(update_filesystem create_htaccess);
require Bugzilla::DB;
+require Bugzilla::Template;
###########################################################################
# Check and update --LOCAL-- configuration
@@ -372,70 +372,8 @@ update_params({ answer => \%answer});
# Pre-compile --TEMPLATE-- code
###########################################################################
-my $templatedir = bz_locations()->{'templatedir'};
-unless ($switch{'no-templates'}) {
- if (-e "$datadir/template") {
- print "Removing existing compiled templates ...\n" unless $silent;
-
- File::Path::rmtree("$datadir/template");
-
- #Check that the directory was really removed
- if(-e "$datadir/template") {
- print "\n\n";
- print "The directory '$datadir/template' could not be removed.\n";
- print "Please remove it manually and rerun checksetup.pl.\n\n";
- exit;
- }
- }
-
- # Precompile stuff. This speeds up initial access (so the template isn't
- # compiled multiple times simultaneously by different servers), and helps
- # to get the permissions right.
- sub compile {
- my $name = $File::Find::name;
-
- return if (-d $name);
- return if ($name =~ /\/CVS\//);
- return if ($name !~ /\.tmpl$/);
- $name =~ s/\Q$::templatepath\E\///; # trim the bit we don't pass to TT
-
- # Compile the template but throw away the result. This has the side-
- # effect of writing the compiled version to disk.
- $::template->context()->template($name);
- }
-
- eval("use Template");
-
- {
- print "Precompiling templates ...\n" unless $silent;
-
- require Bugzilla::Template;
-
- # Don't hang on templates which use the CGI library
- eval("use CGI qw(-no_debug)");
-
- require File::Spec;
- opendir(DIR, $templatedir) || die "Can't open '$templatedir': $!";
- my @files = grep { /^[a-z-]+$/i } readdir(DIR);
- closedir DIR;
-
- foreach my $dir (@files) {
- next if($dir =~ /^CVS$/i);
- -d "$templatedir/$dir/custom" || -d "$templatedir/$dir/default"
- || next;
- local $ENV{'HTTP_ACCEPT_LANGUAGE'} = $dir;
- SetParam("languages", "$dir,en");
- $::template = Bugzilla::Template->create(clean_cache => 1);
- my @templatepaths;
- foreach my $subdir (qw(custom extension default)) {
- $::templatepath = File::Spec->catdir($templatedir, $dir, $subdir);
- next unless -d $::templatepath;
- # Traverse the template hierarchy.
- find({ wanted => \&compile, no_chdir => 1 }, $::templatepath);
- }
- }
- }
-}
+Bugzilla::Template::precompile_templates(!$silent)
+ unless $switch{'no-templates'};
###########################################################################
# Set proper rights
@@ -534,6 +472,7 @@ sub fixPerms {
}
if ($^O !~ /MSWin32/i) {
+ my $templatedir = bz_locations()->{'templatedir'};
if ($my_webservergroup) {
# Funny! getgrname returns the GID if fed with NAME ...
my $webservergid = getgrnam($my_webservergroup)