rewrote the template api and added lots of caching options
This commit is contained in:
JT Smith
parent
6613992f3d
commit
20482def49
24 changed files with 252 additions and 100 deletions
|
|
@ -18,6 +18,7 @@ package WebGUI::Template;
|
|||
|
||||
use HTML::Template;
|
||||
use strict;
|
||||
use WebGUI::Attachment;
|
||||
use WebGUI::ErrorHandler;
|
||||
use WebGUI::International;
|
||||
use WebGUI::Session;
|
||||
|
|
@ -35,9 +36,10 @@ This package contains utility methods for WebGUI's template system.
|
|||
=head1 SYNOPSIS
|
||||
|
||||
use WebGUI::Template;
|
||||
$template = WebGUI::Template::get($templateId, $namespace);
|
||||
$hashRef = WebGUI::Template::get($templateId, $namespace);
|
||||
$hashRef = WebGUI::Template::getList($namespace);
|
||||
$html = WebGUI::Template::process($template);
|
||||
$html = WebGUI::Template::process($templateId, $namespace, $vars);
|
||||
$templateId = WebGUI::Template::set(\%data);
|
||||
|
||||
=head1 METHODS
|
||||
|
||||
|
|
@ -47,10 +49,47 @@ These subroutines are available from this package:
|
|||
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
sub _getTemplateFile {
|
||||
my $templateId = shift;
|
||||
my $namespace = shift;
|
||||
my $filename = $namespace."-".$templateId.".tmpl";
|
||||
$filename =~ s/\//-/g;
|
||||
$filename =~ s/ /-/g;
|
||||
return WebGUI::Attachment->new($filename,"temp","templates");
|
||||
}
|
||||
|
||||
=head2 get ( [ templateId, namespace ] )
|
||||
|
||||
Returns a template.
|
||||
#-------------------------------------------------------------------
|
||||
sub _execute {
|
||||
my $params = shift;
|
||||
my $vars = shift;
|
||||
my $t;
|
||||
eval {
|
||||
$t = HTML::Template->new(%{$params});
|
||||
};
|
||||
unless ($@) {
|
||||
while (my ($section, $hash) = each %session) {
|
||||
next unless (ref $hash eq 'HASH');
|
||||
while (my ($key, $value) = each %$hash) {
|
||||
unless (lc($key) eq "password" || lc($key) eq "identifier") {
|
||||
$t->param("session.".$section.".".$key=>$value);
|
||||
}
|
||||
}
|
||||
}
|
||||
$t->param(%{$vars});
|
||||
$t->param("webgui.version"=>$WebGUI::VERSION);
|
||||
return $t->output;
|
||||
} else {
|
||||
WebGUI::ErrorHandler::warn("Error in template. ".$@);
|
||||
return WebGUI::International::get(848).$@;
|
||||
}
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 get ( templateId, namespace )
|
||||
|
||||
Returns a hash reference containing all of the template parameters.
|
||||
|
||||
=over
|
||||
|
||||
|
|
@ -67,11 +106,9 @@ Defaults to "Page". Specify the namespace of the template to retrieve.
|
|||
=cut
|
||||
|
||||
sub get {
|
||||
my $templateId = $_[0] || 1;
|
||||
my $namespace = $_[1] || "Page";
|
||||
my ($template) = WebGUI::SQL->quickArray("select template from template
|
||||
where templateId=".$templateId." and namespace=".quote($namespace));
|
||||
return $template;
|
||||
my $templateId = shift || 1;
|
||||
my $namespace = shift || "Page";
|
||||
return WebGUI::SQL->quickHashRef("select * from template where templateId=".$templateId." and namespace=".quote($namespace));
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -99,15 +136,19 @@ sub getList {
|
|||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 process ( template [ , vars ] )
|
||||
=head2 process ( templateId, namespace, vars )
|
||||
|
||||
Evaluate a template replacing template commands for HTML.
|
||||
|
||||
=over
|
||||
|
||||
=item template
|
||||
=item templateId
|
||||
|
||||
The template to process.
|
||||
Defaults to "1". Specify the templateId of the template to retrieve.
|
||||
|
||||
=item namespace
|
||||
|
||||
Defaults to "Page". Specify the namespace of the template to retrieve.
|
||||
|
||||
=item vars
|
||||
|
||||
|
|
@ -118,35 +159,117 @@ A hash reference containing template variables and loops. Automatically includes
|
|||
=cut
|
||||
|
||||
sub process {
|
||||
my ($t, $test, $html);
|
||||
$html = $_[0];
|
||||
eval {
|
||||
$t = HTML::Template->new(
|
||||
scalarref=>\$html,
|
||||
global_vars=>1,
|
||||
loop_context_vars=>1,
|
||||
die_on_bad_params=>0,
|
||||
strict=>0
|
||||
);
|
||||
};
|
||||
unless ($@) {
|
||||
while (my ($section, $hash) = each %session) {
|
||||
next unless (ref $hash eq 'HASH');
|
||||
while (my ($key, $value) = each %$hash) {
|
||||
unless (lc($key) eq "password" || lc($key) eq "identifier") {
|
||||
$t->param("session.".$section.".".$key=>$value);
|
||||
}
|
||||
}
|
||||
}
|
||||
$t->param(%{$_[1]});
|
||||
$t->param("webgui.version"=>$WebGUI::VERSION);
|
||||
return $t->output;
|
||||
} else {
|
||||
WebGUI::ErrorHandler::warn("Error in template. ".$@);
|
||||
return WebGUI::International::get(848).$html;
|
||||
my $templateId = shift || 1;
|
||||
my $namespace = shift || "Page";
|
||||
my $vars = shift;
|
||||
my $file = _getTemplateFile($templateId,$namespace);
|
||||
my %params = (
|
||||
filename=>$file->getPath,
|
||||
global_vars=>1,
|
||||
loop_context_vars=>1,
|
||||
die_on_bad_params=>0,
|
||||
no_includes=>1,
|
||||
file_cache_dir=>$session{config}{uploadsPath}.$session{os}{slash}."temp".$session{os}{slash}."templatecache",
|
||||
strict=>0
|
||||
);
|
||||
if ($session{config}{templateCacheType} eq "file") {
|
||||
$params{file_cache} = 1;
|
||||
} elsif ($session{config}{templateCacheType} eq "memory") {
|
||||
$params{cache} = 1;
|
||||
} elsif ($session{config}{templateCacheType} eq "ipc") {
|
||||
$params{shared_cache} = 1;
|
||||
} elsif ($session{config}{templateCacheType} eq "memory-ipc") {
|
||||
$params{double_cache} = 1;
|
||||
} elsif ($session{config}{templateCacheType} eq "memory-file") {
|
||||
$params{double_file_cache} = 1;
|
||||
}
|
||||
unless (-f $file->getPath) {
|
||||
my ($template) = WebGUI::SQL->quickArray("select template from template where templateId=".$templateId." and namespace=".quote($namespace));
|
||||
$file->saveFromScalar($template);
|
||||
}
|
||||
return _execute(\%params,$vars);
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 processRaw ( template, vars )
|
||||
|
||||
Evaluate a template replacing template commands for HTML.
|
||||
|
||||
=over
|
||||
|
||||
=item template
|
||||
|
||||
A scalar variable containing the template.
|
||||
|
||||
=item vars
|
||||
|
||||
A hash reference containing template variables and loops. Automatically includes the entire WebGUI session.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub processRaw {
|
||||
my $template = shift;
|
||||
my $vars = shift;
|
||||
return _execute({
|
||||
scalarref=>\$template,
|
||||
global_vars=>1,
|
||||
loop_context_vars=>1,
|
||||
die_on_bad_params=>0,
|
||||
no_includes=>1,
|
||||
strict=>0
|
||||
},$vars);
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 set ( data )
|
||||
|
||||
Store a template and it's metadata.
|
||||
|
||||
=over
|
||||
|
||||
=item data
|
||||
|
||||
A hash reference containing the data to be stored. At minimum the hash reference must include "templateId" and "namespace". The following are the elements allowed to be stored.
|
||||
|
||||
templateId - The unique id for the template. If set to "new" then a new one will be generated.
|
||||
|
||||
namespace - The namespace division for this template.
|
||||
|
||||
template - The content of the template.
|
||||
|
||||
name - A human friendly name for the template.
|
||||
|
||||
showInForms - A boolean indicating whether this template should appear when using the "template" subroutine in WebGUI::Form.
|
||||
|
||||
isEditable - A boolean indicating whether this template should be editable through the template manager.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub set {
|
||||
my $data = shift;
|
||||
if ($data->{templateId} eq "new") {
|
||||
($data->{templateId}) = WebGUI::SQL->quickArray("select max(templateId) from template where namespace=".quote($data->{namespace}));
|
||||
$data->{templateId}++;
|
||||
if ($data->{templateId} < 1000) {
|
||||
$data->{templateId} = 1000;
|
||||
}
|
||||
WebGUI::SQL->write("insert into template (templateId,namespace) values (".$data->{templateId}.",".quote($data->{namespace}).")");
|
||||
}
|
||||
my @pairs;
|
||||
foreach my $key (keys %{$data}) {
|
||||
push(@pairs, $key."=".quote($data->{$key})) unless ($key eq "namespace" || $key eq "templateId");
|
||||
}
|
||||
WebGUI::SQL->write("update template set ".join(",",@pairs)." where templateId=".$data->{templateId}." and namespace=".quote($data->{namespace}));
|
||||
my $file = _getTemplateFile($data->{templateId},$data->{namespace});
|
||||
$file->delete;
|
||||
return $data->{templateId};
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue