/usr/share/perl5/Tenjin/Context.pm is in libtenjin-perl 0.070001-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | package Tenjin::Context;
use strict;
use warnings;
use Tenjin::Util;
use Carp;
our $VERSION = "0.070001";
$VERSION = eval $VERSION;
=head1 NAME
Tenjin::Context - In charge of managing variables passed to Tenjin templates.
=head1 VERSION
version 0.070001
=head1 SYNOPSIS
# this module is used internally, but if you insist, it is
# in charge of the context object:
# in your templates (unnecessary, for illustration purposes):
<title>[== $_context->{title} =]</title>
# instead use:
<title>[== $title =]</title>
=head1 DESCRIPTION
This module is in charge of managing Perl variables that are passed to
templates upon rendering for direct usage. The context object is simply
a hash-ref of key-value pairs, which are made available for templates
as "standalone variables" named for each key in the hash-ref.
This module is also in charge of the actual rendering of the templates,
or more correctly, for evaluating the Perl code created from the templates,
first integrating the context variables to them, and returning the rendered
output.
Finally, this module makes the Tenjin utility methods of L<Tenjin::Util>
available natively inside templates. See L<Tenjin::Util> for more info.
=head1 INTERNAL METHODS
=head2 new( [\%vars] )
Constructs a new context object, which is basically a hash-ref of key-value pairs
which are passed to templates as variables. If a C<$vars> hash-ref is passed
to the constructor, it will be augmented into the created object.
To illustrate the context object, suppose it looks like so:
{
scalar => 'I am a scalar',
arrayref => [qw/I am an array/],
hashref => { i => 'am', a => 'hash-ref' },
}
Then the variables C<$scalar>, C<$arrayref> and C<$hashref> will be available for
direct usage inside your templates, and you can dereference the variables
normally (i.e. C<@$arrayref> and C<%$hashref>).
=cut
sub new {
my ($class, $self) = @_;
$self ||= {};
return bless $self, $class;
}
=head2 evaluate( $script, $template_name )
This method receives a compiled template and actually performes the evaluation
the renders it, then returning the rendered output. If Tenjin is configured
to C<use strict>, the script will be C<eval>ed under C<use strict>.
=cut
sub evaluate {
my ($self, $script, $name) = @_;
my $_context = $self;
$script = ($script =~ /\A.*\Z/s) && $& if $Tenjin::BYPASS_TAINT;
my $s = $name ? "# line 1 \"$name\"\n" : ''; # line directive
$s .= $script;
my $ret;
if ($Tenjin::USE_STRICT) {
$ret = eval($s);
} else {
no strict;
$ret = eval($s);
use strict;
}
croak "[Tenjin] Failed rendering $name: $@" if $@;
return $ret;
}
=head2 to_func( $script, [$filename] )
This method receives the script created when reading a template and wraps
it in a subroutine, C<eval>s it and returns the rendered output. This method
is called when compiling the template.
=cut
sub to_func {
my ($self, $script, $name) = @_;
$script = ($script =~ /\A.*\Z/s) && $& if $Tenjin::BYPASS_TAINT;
my $s = $name ? "# line 1 \"$name\"\n" : ''; # line directive
$s .= "sub { my (\$_context) = \@_; $script }";
my $ret;
if ($Tenjin::USE_STRICT) {
$ret = eval($s);
} else {
no strict;
$ret = eval($s);
use strict;
}
croak "[Tenjin] Failed compiling $name: $@" if $@;
return $ret;
}
=head2 _build_decl()
This method is in charge of making all the key-value pairs of the context
object available to templates directly by the key names. This is simply done
by traversing the key-value pairs of the context object and adding an
assignment line between a scalar variable named as the key and its appropriate
value.
=cut
sub _build_decl {
my $self = shift;
my $s = '';
foreach my $k (keys %$self) {
next if $k eq '_context';
$s .= "my \$$k = \$_context->{'$k'}; ";
}
return $s;
}
=head1 UTILITY METHODS
These methods are defined in L<Tenjin::Util> and used here so they are
made available natively inside templates. See L<Tenjin::Util> for more
information.
=head2 _p( $expr )
=head2 _P( $expr )
=head2 escape( $expr )
=head2 escape_xml( $expr )
=head2 unescape_xml( $expr )
=head2 encode_url( $url )
=head2 decode_url( $url )
=head2 checked( $expr )
=head2 selected( $expr )
=head2 disabled( $expr )
=head2 nl2br( $text )
=head2 text2html( $text )
=head2 tagattr( $name, $expr, [$value] )
=head2 tagattrs( %attrs )
=head2 new_cycle( @items )
=cut
# this makes the Tenjin utility methods available to templates 'natively'
*_p = *Tenjin::Util::_p;
*_P = *Tenjin::Util::_P;
*escape = *Tenjin::Util::escape_xml;
*escape_xml = *Tenjin::Util::escape_xml;
*unescape_xml = *Tenjin::Util::unescape_xml;
*encode_url = *Tenjin::Util::encode_url;
*decode_url = *Tenjin::Util::decode_url;
*checked = *Tenjin::Util::checked;
*selected = *Tenjin::Util::selected;
*disabled = *Tenjin::Util::disabled;
*nl2br = *Tenjin::Util::nl2br;
*text2html = *Tenjin::Util::text2html;
*tagattr = *Tenjin::Util::tagattr;
*tagattrs = *Tenjin::Util::tagattrs;
*new_cycle = *Tenjin::Util::new_cycle;
1;
=head1 SEE ALSO
L<Tenjin>, L<Tenjin::Util>, L<Tenjin::Template>.
=head1 AUTHOR
The CPAN version of Tenjin was forked by Ido Perlmuter E<lt>ido at ido50.netE<gt>
from version 0.0.2 of the original plTenjin, which is developed by Makoto Kuwata
at L<http://www.kuwata-lab.com/tenjin/>.
Development of Tenjin is done with github at L<http://github.com/ido50/Tenjin>.
=head1 LICENSE AND COPYRIGHT
Tenjin is licensed under the MIT license.
Copyright (c) 2007-2010 the aforementioned authors.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
=cut
|