# Zet Maximum template parser
#
# 2002-2009
# Version 0.7.2 production
# Author Maxim Kashliak (max@zmaximum.ru)
# Aleksey V. Ivanov (avimail@zmaximum.ru)
#
# For latest releases, documentation, faqs, etc see the homepage at
# http://perl.zmaximum.ru
#
#
package ZM::Template;
use strict;
use vars qw($AUTOLOAD);
use Carp;
use MIME::Base64;
no strict 'refs';
$ZM::Template::VERSION = '0.7.2';
sub new()
{
my $class = shift;
my %baseHtml=@_;
$baseHtml{tag}="__" if (!defined $baseHtml{tag} || $baseHtml{tag} eq "");
$baseHtml{_loops_filled}=0;
bless \%baseHtml, $class;
return \%baseHtml
}
sub src()
{
if ($#_ !=1)
{
die_msg("Error! template function requires a single parameter\n");
}
my $self = shift;
my $src = shift;
my $suxx=$/;
undef $/;
open(HTML, "<$src") || die_msg("Cannot open html template file!
($src)");
my $tmplString = ;
close HTML;
$/=$suxx;
# обработка SSI деректив внутри темплейта
eval('require ZM::SSI;');
$tmplString = ZM::SSI::parse($tmplString) unless $@;
# задаем папку для хранения кеша, если она не была указана при создании объекта
unless (defined $self->{cacheDIR})
{
$src=~s/\/.*?$//;
$self->{cacheDIR}=$src.'/cache';
}
$self->srcString($tmplString);
}
sub srcString
{
my $self = shift;
my $str = shift;
$self->{html}=$str;
_parse_tokens($self,$str);
}
sub srcStringSSI
{
my $self = shift;
my $str = shift;
eval('require ZM::SSI;');
$str = ZM::SSI::parse($str) unless $@;
$self->{html}=$str;
_parse_tokens($self,$str);
}
sub listAllTokens
{
my $self=shift;
return(keys %{$self->{tokens}});
}
sub _parse_tokens
{
my $self=shift;
my $htmlString=shift;
my ($padding, $token, $remainder);
# while ($htmlString =~ /.*?(($self->{tag}x_.+?$self->{tag}\n)|($self->{tag}([^_]).*?$self->{tag}))/sg)
# while ($htmlString =~ /.*?$self->{tag}((x_)?.+?)$self->{tag}/sg) #orig
while ($htmlString =~ /.*?$self->{tag}([\da-zA-Z]([\_\-]*[\da-zA-Z])*?)$self->{tag}/sg)
{
$token = $1;
$token =~ s/\n$//g; # chomp $token (chomp bust as $/ undef'd)
# $token =~ s/(^$self->{tag}|$self->{tag}$)//g;
$self->{tokens}{$token}=1;
}
}
sub AUTOLOAD
{
my $token = $AUTOLOAD;
my ($self, $value, $block) = @_;
$token =~ s/.*:://;
# здесь надо проверить не выглядит ли наша замена как токен, иначе она сотрется в последствии
#while ($value =~ /.*?$self->{tag}([^_].*?)$self->{tag}/s)
#{
# my $vtoken = $1;
# $vtoken =~ s/\n$//g;
# $nottokens{$vtoken}=1;
#}
if (defined $self->{tokens}{$token})
{
if (defined $block and $block ne "")
{
my $bl_new=$block."_new";
$bl_new=~s/^x_//; #надо обойтись без регекспа
my $loop;
if (defined $self->{loops}{$bl_new})
{
my $flag=0;
foreach $loop(@{$self->{loops}{$bl_new}})
{
if(strstr($loop,"$self->{tag}".$token."$self->{tag}"))
{
$flag++;
last;
}
}
$self->_post_loop($block) unless($flag);
}
$self->_set_loop($token,$value,$block);
}
else
{
$self->{html}=$self->set_to_str($token,$value,$self->{html});
}
}
}
sub setif
{
my $self = shift;
my $token = shift;
my $loop = shift;
if(!defined $loop or $loop eq "")
{
$self->{ifs}->{$token}=1;
}
else
{
$self->{ifs_loop}->{$loop}->{$token}=1;
}
}
sub delif
{
my $self = shift;
my $token = shift;
my $loop = shift;
if(!defined $loop or $loop eq "")
{
delete $self->{ifs}->{$token};
}
else
{
delete $self->{ifs_loop}->{$loop}->{$token};
}
}
sub fromfile
{
my $self = shift;
my $token = shift;
my $file = shift;
my $block = shift;
open (my $f,"<$file") or return;
my $suxx=$/;
undef $/;
my $filecontent=<$f>;
$/=$suxx;
close($f);
$self->$token($filecontent,$block);
}
sub _set_loop
{
my $self=shift;
my $token=shift;
my $value=shift;
my $block=shift;
$block=~s/^x_//;
my ($loop, $loop_name, $loop_begin, $num, $loop2, $loop3, $loop_after, $loops_ref);
my @loops=();
if(defined $self->{loops}{$block."_new"})
{
# если уже выставлялись токены в этом цикле
$loops_ref=$self->{loops}{$block."_new"};
}
else
{
# если еще не вставлялись токены в этом цикле,
# то выдираем тело цикла из всего шаблона
$loop_name="$self->{tag}x_".$block."$self->{tag}";
# мы ищем все циклы с таким именем во всем документе
$loop_after=$self->{html};
while($loop_begin=strstr($loop_after,$loop_name))
{
$loop_begin=substr($loop_begin,length($loop_name));
($loop,$loop_after)=str_split($loop_begin,$loop_name);
push(@{$loops_ref},$loop);
}
}
my $loop_number=0;
foreach $loop(@$loops_ref)
{
if(strstr($loop,"$self->{tag}z_".$block."$self->{tag}"))
{
$self->{strnum}{$block}++;
$num=$self->{strnum}{$block};
$loop2=$loop3=$loop;
while(($num)&&(($loop2=str_before($loop3,"$self->{tag}z_".$block."$self->{tag}")) ne $loop3))
{
$num--;
$loop3=str_after($loop3,"$self->{tag}z_".$block."$self->{tag}");
}
if($num==0)
{
$loop=$loop2;
#$self->{strnum}{$block}++;
}
elsif($num>=1)
{
#$loop=str_before($loop,"$self->{tag}z_".$block."$self->{tag}");
$loop=$loop3;
$self->{strcount}{$block}=$self->{strnum}{$block}-1; #запомним номер последнего блока перед переходом на первый
$self->{strnum}{$block}=0;
}
}
$self->{loops}{$block.'_new'}[$loop_number]=$self->set_to_str($token,$value,$loop);
$loop_number++;
}
}
sub _post_loop
{
my $self=shift;
my $block=shift;
$block=~s/^x_//;
my ($text,$pos, $before_loop, $loop, $loop_name, $after_loop);
my $loop_number;
if($self->{strnum}{$block}>1)
{
$loop_number=$self->{strnum}{$block}-1;
}
elsif(defined $self->{strnum}{$block} && $self->{strnum}{$block}==0)
{
$loop_number=$self->{strcount}{$block};
}
else
{
$loop_number=0;
}
my $i=0;
foreach $text (@{$self->{loops}{$block."_new"}})
{
#Find and post inner loops
my %found_loops;
while($pos=strstr($text,"$self->{tag}x_"))
{
$before_loop=substr($text,0,length($text)-length($pos));
$loop_name=substr($pos,4);
$loop_name=substr($loop_name,0,length($loop_name)-length(strstr($loop_name,"$self->{tag}")));
$loop=strstr($text,"$self->{tag}x_".$loop_name."$self->{tag}");
$after_loop=str_after(str_after($loop,"$self->{tag}x_".$loop_name."$self->{tag}"),"$self->{tag}x_".$loop_name."$self->{tag}");
$loop=substr($loop,0,length($loop)-length($after_loop));
$self->_post_loop($loop_name) if (defined $self->{loops}{$loop_name.'_new'});
$found_loops{$loop_name}++;
$text=$before_loop.$self->{loops}{$loop_name}[$loop_number].$after_loop;
}
# delete inner loops
foreach $loop_name (keys %found_loops)
{
delete $self->{loops}{$loop_name};
delete $self->{strnum}{$loop_name};
delete $self->{strcount}{$loop_name};
}
$text=_fill_ifs($self,$text,'x_'.$block);
#$self->{loops}{$block."_new"}=$text;
#POST
$self->{loops}{$block}[$i] .= $text;
$i++;
}
delete $self->{ifs_loop}->{'x_'.$block}; # we must clear IFs for this loop
delete $self->{loops}{$block.'_new'};
}
sub set_to_str
{
my $self=shift;
my $token=shift;
my $value=shift;
my $str=shift;
my $ret="";
my $sub_str;
my $loop_name;
while(($sub_str=str_before($str,"$self->{tag}x_")) ne $str)
{
# получаем имя цикла
$loop_name=str_before(substr($str,length($sub_str)+4),"$self->{tag}");
# заменяем переменную перед циклом, если она там есть
$ret.=str_replace("$self->{tag}".$token."$self->{tag}",$value,$sub_str);
$ret.="$self->{tag}x_".$loop_name."$self->{tag}".str_before(substr($str,length($sub_str)+length($loop_name)+6),"$self->{tag}x_".$loop_name."$self->{tag}")."$self->{tag}x_".$loop_name."$self->{tag}";
$str=str_after(substr($str,length($sub_str)+length($loop_name)+6),"$self->{tag}x_".$loop_name."$self->{tag}");
}
$ret.=str_replace("$self->{tag}".$token."$self->{tag}",$value,$str);
return($ret);
}
sub _fill_ifs
{
my $self=shift;
my $text=shift;
my $l_name=shift;
my ($pos,$before_loop,$if_name,$loop,$loop_name,$after_loop,$h_ifs);
if(!defined $l_name || $l_name eq '')
{
$h_ifs=$self->{ifs};
}
else
{
# надо заполнить IF для цикла
$h_ifs=$self->{ifs_loop}->{$l_name};
}
# удаляем незаполненные IF и вставляем заполненные в окончательный текст
while($pos=strstr($text,"$self->{tag}if_"))
{
$before_loop=substr($text,0,length($text)-length($pos));
$loop_name=substr($pos,5);
$loop_name=substr($loop_name,0,length($loop_name)-length(strstr($loop_name,"$self->{tag}")));
$if_name="$self->{tag}if_".$loop_name."$self->{tag}";
$loop=$pos;
$after_loop=str_after(str_after($loop,$if_name),$if_name);
$loop=substr($loop,length($if_name),length($loop)-length($after_loop)-length($if_name)*2);
unless(defined $h_ifs->{$loop_name})
{
#IF не выставлялся
if($pos=strstr($loop,"$self->{tag}else_".$loop_name))
{
#else есть и его надо оставить
$loop=substr($pos,9+length($loop_name));
}
else
{
#else нет
$loop="";
}
}
else
{
#убираем содержимое ELSE, если таковой есть
if($pos=strstr($loop,"$self->{tag}else_".$loop_name))
{
#else есть и его надо оставить
$loop=str_before($loop,$pos);
}
#undef $h_ifs->{$loop_name} if(!defined $l_name || $l_name eq '')
}
$text=$before_loop.$loop.$after_loop;
}
return($text);
}
sub _fill_loops
{
my $self=shift;
my $text=shift;
unless($self->{_loops_filled})
{
my ($pos, $before_loop, $loop_name, $loop, $after_loop);
# постим те лупы, что запонились, но не заполнились
foreach(keys %{$self->{loops}})
{
if (($loop_name=str_before($_,"_new")) ne $_)
{
$self->_post_loop($loop_name) if($self->{loops}{$_} ne "");
}
}
# удаляем незаполненные лупы и вставляем заполненные в окончательный текст
while($pos=strstr($text,"$self->{tag}x_"))
{
$before_loop=substr($text,0,length($text)-length($pos));
$loop_name=substr($pos,4);
$loop_name=substr($loop_name,0,length($loop_name)-length(strstr($loop_name,"$self->{tag}")));
#$loop=strstr($text,"$self->{tag}x_".$loop_name."$self->{tag}");
$loop=$pos;
$after_loop=str_after(str_after($loop,"$self->{tag}x_".$loop_name."$self->{tag}"),"$self->{tag}x_".$loop_name."$self->{tag}");
$loop=substr($loop,0,length($loop)-length($after_loop));
$text=$before_loop.shift(@{$self->{loops}{$loop_name}}).$after_loop;
}
my $tag=$self->{tag};
my $if_name;
$text=_fill_ifs($self,$text);
$text=~s/($tag)[\da-zA-Z\-][\w\-]*?($tag)//g;
$self->{_loops_filled}=1;
}
return($text);
}
sub strstr
{
my $str=shift;
my $str2=shift;
my $index=index($str,$str2);
if ($index>-1)
{
$str=substr($str,$index,length($str)-$index);
return($str);
}
else
{
return undef;
}
}
sub str_before
{
my $str=shift;
my $str2=shift;
my $indx=index($str,$str2);
if($indx!=-1)
{
$str=substr($str,0,$indx);
}
return $str;
}
sub str_split
{
my $str=shift;
my $str2=shift;
my $indx=index($str,$str2);
if($indx!=-1)
{
my $lstr2=length($str2);
$str2=substr($str,$indx+$lstr2,length($str)-$indx-$lstr2);
$str=substr($str,0,$indx);
}
else
{
$str2='';
}
return ($str,$str2);
}
sub str_3_split
{
my $str=shift;
my $str1=shift;
my $str2=shift;
($str1,$str)=str_split($str,$str1);
if($str ne '')
{
($str2,$str)=str_split($str,$str2);
}
else
{
$str2='';
}
return($str1,$str2,$str);
}
sub str_after
{
my $str=shift;
my $str2=shift;
my $indx=index($str,$str2);
if($indx!=-1)
{
$str=substr($str,$indx+length($str2),length($str)-$indx-length($str2));
}
return($str);
}
sub str_between
{
my $str=shift;
my $str1=shift;
my $str2=shift;
my $ret=str_after($str,$str1);
return(str_before($ret,$str2));
}
sub str_replace
{
my $str=shift;
my $str1=shift;
my $str2=shift;
$str2=~s/$str/$str1/g;
return($str2);
}
sub output()
{
my $self = shift;
my $hdr;
foreach $hdr (@_)
{
print "$hdr\n";
}
print "\n";
# $self->{html}=$self->_fill_loops($self->{html});
print $self->htmlString();
}
sub setCache
{
my $self = shift;
my $cacheKey = shift;
return 0 unless (defined $self->{cacheDIR});
mkdir($self->{cacheDIR}) unless(-d $self->{cacheDIR});
my $encodedKey=encode_base64($cacheKey);
# chomp($encodedKey);
$encodedKey=~s/[\n\s]//sg;
open(my $f,'>'.$self->{cacheDIR}.'/'.$encodedKey);
print $f $self->htmlString();
close($f);
return 1;
}
sub getCache
{
my $self = shift;
my $cacheKey = shift;
return 0 unless (defined $self->{cacheDIR});
my $encodedKey=encode_base64($cacheKey);
# chomp($encodedKey);
$encodedKey=~s/[\n\s]//sg;
my $cacheFile = $self->{cacheDIR}.'/'.$encodedKey;
return 0 unless(-f $cacheFile);
my $suxx=$/;
undef $/;
open(my $f, $cacheFile);
$self->{html}=<$f>;
close($f);
$/=$suxx;
$self->{_loops_filled}=1;
return 1;
}
sub rmCache
{
my $self = shift;
my $cacheKey = shift;
my $encodedKey=encode_base64($cacheKey);
$encodedKey=~s/[\n\s]//sg;
# chomp($encodedKey);
return unlink($self->{cacheDIR}.'/'.$encodedKey);
}
sub clearCache
{
my $self = shift;
return 0 unless (defined $self->{cacheDIR});
unlink (glob($self->{cacheDIR}.'/*'));
return 1;
}
sub htmlString()
{
my $self = shift;
$self->{html}=$self->_fill_loops($self->{html});
return $self->{html};
}
sub DESTROY()
{
}
sub die_msg
{
my $msg = shift;
print "Content-type: text/html\n\n";
print <
ZM::Template Error: $msg
EOF
exit;
}
1;
__END__
=head1 NAME
ZM::Template - Merges runtime data with static HTML or Plain Text template file.
=head1 VERSION
Template.pm v 0.7.2
=head1 SYNOPSIS
How to merge data with a template.
The template :
parser Example 1
My name is __firstname__ __surname__ but my friends call me __nickname__.
The code :
use ZM::Template;
# Create a template object and load the template source.
$templ = new ZM::Template;
$templ->src('example1.html');
# Set values for tokens within the page
$templ->surname('Smyth');
$templ->firstname('Arthur');
$templ->nickname('Art!');
# Send the merged page and data to the web server as a standard text/html mime
# type document
$templ->output('Content-Type: text/html');
Produces this output :
parser Example 1
My name is Arthur Smyth but my friends call me Art!.
=head1 DESCRIPTION
In an ideal web system, the HTML used to build a web page would
be kept distinct from the application logic populating the web page.
This module tries to achieve this by taking over the chore of merging runtime
data with a static html template.
Template can contain SSI derectives like
and
It is used ZM::SSI for SSI parsing. If module ZM::SSI not installed SSI
derectives will be ignoring.
The ZM::Template module can address the following template scenarios :
=over 3
=item *
Single values assigned to tokens
=item *
Multiple values assigned to tokens (as in html table rows)
=item *
Single pages built from multiple templates (ie: header, footer, body)
=item *
html tables with runtime determined number of columns
=back
An template consists of 2 parts; the boilerplate and the tokens (place
holders) where the variable data will sit.
A token has the format __tokenName__ and can be placed anywhere within the
template file. If it occurs in more than one location, when the data is merged
with the template, all occurences of the token will be replaced.
My name is __userName__ and I am aged __age__.
My friends often call me __nickName__ although my name is __userName__.
When an html table is being populated, it will be necessary to
output several values for each token. This will result in multiple rows in the
table. However, this will only work if the tokens appear within a repeating
block.
To mark a section of the template as repeating, it needs to be enclosed within
a matching pair of repeating block tokens. These have the format __x_blockName__. They must always come in pairs.
and I have the following friends
__x_friends__
| __friendName__ | __friendNickName__ |
__x_friends__
For interleave data in loop used __z_ token
and I have the following friends
__x_friends__
| __friendName__ | __friendNickName__ |
__z_friends__
| __friendName__ | __friendNickName__ |
__x_friends__
Count of __z_ token is UNLIMITED.
Template engine understand inner loops like this
List of companies:
__x_companies__
Company name: __name__
Company address: __address__
Company e-mails:
__x_emails__
__email__
__x_emails__
Company web: __web__
__x_companies__
For condition __if_ token. They must always come in pairs.
List of companies:
__x_companies__
Company name: __name__
Company address: __address__
Company e-mails:
__x_emails__
__email__
__x_emails__
__if_company_web__
Company web: __web__
__if_company_web__
__x_companies__
Template engine understand __else_ token within __if_ token.
List of companies:
__x_companies__
Company name: __name__
Company address: __address__
Company e-mails:
__x_emails__
__email__
__x_emails__
__if_company_web__
Company web: __web__
__else_company_web__
Company have not web site
__if_company_web__
__x_companies__
=head1 METHODS
src($)
The single parameter specifies the name of the template file to use.
srcString($)
If the template is within a string rather than a file, use this method to
populate the template object.
output(@)
Merges the data already passed to the ZM::Template instance with the template file
specified in src().
The optional parameter is output first, followed by a blank line. These form
the HTTP headers.
htmlString()
Returns a string of html produced by merging the data passed to the ZM::Template
instance with the template specified in the src() method. No http headers are
sent to the output string.
listAllTokens()
Returns an array. The array contains the names of all tokens found within
the template specifed to src() method.
tokenName($)
Assigns to the 'tokenName' token the value specified as parameter.
tokenName($$)
Assigns to the 'tokenName' token, within the repeating block specified in 2nd
parameter, the value specified as the first parameter.
setif(tokenName)
Set true for __if_ token type.
fromfile($$)
Assigns to the token specified as parameter the content of file specified in 2nd
parameter.
fromfile($$$)
Assigns to the token specified as parameter, within the repeating block specified
in 3nd parameter, the value specified in 2nd parameter.
=head1 EXAMPLES
=head2 Example 1.
A simple template with single values assigned to each token.
The template :
parser Example 1
My name is __firstname__ __surname__ but my friends call me __nickname__.
The code :
use ZM::Template;
# Create a template object and load the template source.
$templ = new ZM::Template;
$templ->src('example1.html');
# Set values for tokens within the page
$templ->surname('Smyth');
$templ->firstname('Arthur');
$templ->nickname('Art!');
# Send the merged page and data to the web server as a standard text/html mime
# type document
$templ->output('Content-Type: text/html');
Produces this output :
parser Example 1
My name is Arthur Smyth but my friends call me Art!.
=head2 Example 2
Produces an html table with a variable number of rows.
The template :
Example 2 - blocks
__x_details__
| __id__ |
__name__ |
__desc__ |
__x_details__
__x_customer_det__
- __customer__
__x_customer_det__
The code :
use ZM::Template;
# Create the template object and load it.
$templ = new ZM::Template;
$templ->src('example2.html');
# Simulate obtaining data from database, etc and populate 300 blocks.
for ($i=0; $i<300; $i++)
{
# Ensure that the token is qualified by the name of the block and load
# values for the tokens.
$templ->id($i, 'x_details');
$templ->name("the name is $i", 'x_details');
$templ->desc("the desc for $i", 'x_details');
}
for ($i=0; $i<4; $i++)
{
$templ->customer("And more $i", 'x_customer_det');
}
# Send the completed html document to the web server.
$templ->output('Content-Type: text/html');
=head2 Example 3.
Uses 2 seperate templates to produce a single web page :
The overall page template :
Example 5 - sub templates
Surname : __surname__
First Name : __firstname__
My friends (both of them) call me : __nickname__
Now to include a sub template...
__guts__
And this is the end of the outer template.
The subtemplate which will be slotted into the 'guts' token position :
The code :
use ZM::Template;
# Create a template object and load the template source.
my($templ) = new ZM::Template;
$templ->src('example5.html');
# Set values for tokens within the page
$templ->surname('Smyth');
$templ->firstname('Arthur');
$templ->nickname('Art!');
my $subTmpl = new ZM::Template;
$subTmpl->src('example5a.html');
$subTmpl->widget('this is widget');
$subTmpl->wodget('this is wodget');
$templ->guts($subTmpl->htmlString);
# Send the merged page and data to the web server as a standard text/html mime
# type document
$templ->output('Content-Type: text/html');
=head1 HISTORY
Jun 2009 Version 0.7.2 Added setCache, getCache, rmCache, clearCache methods.
Apr 2007 Version 0.5.3 Perfomance fixes.
Jun 2004 Version 0.5.2 Parse SSI before template parsing.
Oct 2003 Version 0.5.0 Added __else_ token type.
Oct 2003 Version 0.4.1 Fixed some errors with __z_ token type.
Oct 2003 Version 0.4.0 Added __if_ token type.
Oct 2003 Version 0.3.1 Fixed some errors.
Oct 2003 Version 0.3.0 Added SSI parsing inside template.
Oct 2003 Version 0.2.0 Added fromfile method.
Oct 2003 Version 0.1.1 Some fixes in documentation, messages and code.
Oct 2003 Version 0.1.0 Added __z_ token type.
Oct 2003 Version 0.0.3 First release.
=head1 AUTHOR
Zet Maximum ltd.
Maxim Kashliak
Aleksey V. Ivanov
http://www.zmaximum.ru/
http://perl.zmaximum.ru