/usr/share/perl5/Dancer2/Core/Role/Template.pm is in libdancer2-perl 0.166001+dfsg-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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | # ABSTRACT: Role for template engines
package Dancer2::Core::Role::Template;
$Dancer2::Core::Role::Template::VERSION = '0.166001';
use Dancer2::Core::Types;
use Dancer2::FileUtils qw'path';
use Carp 'croak';
use Moo::Role;
with 'Dancer2::Core::Role::Engine';
sub hook_aliases {
{
before_template_render => 'engine.template.before_render',
after_template_render => 'engine.template.after_render',
before_layout_render => 'engine.template.before_layout_render',
after_layout_render => 'engine.template.after_layout_render',
}
}
sub supported_hooks { values %{ shift->hook_aliases } }
sub _build_type {'Template'}
requires 'render';
has log_cb => (
is => 'ro',
isa => CodeRef,
default => sub { sub {1} },
);
has name => (
is => 'ro',
lazy => 1,
builder => 1,
);
sub _build_name {
( my $name = ref shift ) =~ s/^Dancer2::Template:://;
$name;
}
has charset => (
is => 'ro',
isa => Str,
default => sub {'UTF-8'},
);
has default_tmpl_ext => (
is => 'ro',
isa => Str,
default => sub { shift->config->{extension} || 'tt' },
);
has views => (
is => 'rw',
isa => Maybe [Str],
);
has layout => (
is => 'rw',
isa => Maybe [Str],
);
has engine => (
is => 'ro',
isa => Object,
lazy => 1,
builder => 1,
);
has settings => (
is => 'ro',
isa => HashRef,
lazy => 1,
default => sub { +{} },
writer => 'set_settings',
);
has layout_dir => (
is => 'ro',
isa => Str,
default => sub {'layouts'},
);
sub _template_name {
my ( $self, $view ) = @_;
my $def_tmpl_ext = $self->default_tmpl_ext();
$view .= ".$def_tmpl_ext" if $view !~ /\.\Q$def_tmpl_ext\E$/;
return $view;
}
sub view_pathname {
my ( $self, $view ) = @_;
$view = $self->_template_name($view);
return path( $self->views, $view );
}
sub layout_pathname {
my ( $self, $layout ) = @_;
return path(
$self->views,
$self->layout_dir,
$self->_template_name($layout),
);
}
sub pathname_exists {
my ( $self, $pathname ) = @_;
return -f $pathname;
}
sub render_layout {
my ( $self, $layout, $tokens, $content ) = @_;
$layout = $self->layout_pathname($layout);
# FIXME: not sure if I can "just call render"
$self->render( $layout, { %$tokens, content => $content } );
}
sub apply_renderer {
my ( $self, $view, $tokens ) = @_;
$view = $self->view_pathname($view) if !ref $view;
$tokens = $self->_prepare_tokens_options( $tokens );
$self->execute_hook( 'engine.template.before_render', $tokens );
my $content = $self->render( $view, $tokens );
$self->execute_hook( 'engine.template.after_render', \$content );
# make sure to avoid ( undef ) in list context return
defined $content and return $content;
return;
}
sub apply_layout {
my ( $self, $content, $tokens, $options ) = @_;
$tokens = $self->_prepare_tokens_options( $tokens );
# If 'layout' was given in the options hashref, use it if it's a true value,
# or don't use a layout if it was false (0, or undef); if layout wasn't
# given in the options hashref, go with whatever the current layout setting
# is.
my $layout =
exists $options->{layout}
? ( $options->{layout} ? $options->{layout} : undef )
: ( $self->layout || $self->config->{layout} );
# that should only be $self->config, but the layout ain't there ???
defined $content or return;
defined $layout or return $content;
$self->execute_hook(
'engine.template.before_layout_render',
$tokens, \$content
);
my $full_content = $self->render_layout( $layout, $tokens, $content );
$self->execute_hook( 'engine.template.after_layout_render',
\$full_content );
# make sure to avoid ( undef ) in list context return
defined $full_content and return $full_content;
return;
}
sub _prepare_tokens_options {
my ( $self, $tokens ) = @_;
# these are the default tokens provided for template processing
$tokens ||= {};
$tokens->{perl_version} = $^V;
$tokens->{dancer_version} = Dancer2->VERSION;
$tokens->{settings} = $self->settings;
$tokens->{request} = $self->request;
$tokens->{params} = $self->request->params;
$tokens->{vars} = $self->request->vars;
$tokens->{session} = $self->session->data
if $self->has_session;
return $tokens;
}
sub process {
my ( $self, $view, $tokens, $options ) = @_;
my ( $content, $full_content );
# it's important that $tokens is not undef, so that things added to it via
# a before_template in apply_renderer survive to the apply_layout. GH#354
$tokens ||= {};
$options ||= {};
## FIXME - Look into PR 654 so we fix the problem here as well!
$content =
$view
? $self->apply_renderer( $view, $tokens )
: delete $options->{content};
defined $content
and $full_content = $self->apply_layout( $content, $tokens, $options );
defined $full_content
and return $full_content;
croak "Template did not produce any content";
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Core::Role::Template - Role for template engines
=head1 VERSION
version 0.166001
=head1 DESCRIPTION
Any class that consumes this role will be able to be used as a template engine
under Dancer2.
In order to implement this role, the consumer B<must> implement the method C<render>. This method will receive three arguments:
=over 4
=item $self
=item $template
=item $tokens
=back
Any template receives the following tokens, by default:
=over 4
=item * C<perl_version>
Current version of perl, effectively C<$^V>.
=item * C<dancer_version>
Current version of Dancer2, effectively C<<Dancer2->VERSION>>.
=item * C<settings>
A hash of the application configuration.
=item * C<request>
The current request object.
=item * C<params>
A hash reference of all the parameters.
Currently the equivalent of C<< $request->params >>.
=item * C<vars>
The list of request variables, which is what you would get if you
called the C<vars> keyword.
=item * C<session>
The current session data, if a session exists.
=back
=head1 ATTRIBUTES
=head2 name
The name of the template engine (e.g.: Simple).
=head2 charset
The charset. The default value is B<UTF-8>.
=head2 default_tmpl_ext
The default file extension. If not provided, B<tt> is used.
=head2 views
Path to the directory containing the views.
=head2 layout
Path to the directory containing the layouts.
=head2 layout_dir
Relative path to the layout directory.
Default: B<layouts>.
=head2 engine
Contains the engine.
=head1 METHODS
=head2 view_pathname($view)
Returns the full path to the requested view.
=head2 layout_pathname($layout)
Returns the full path to the requested layout.
=head2 pathname_exists($pathname)
Returns true if the requested pathname exists. Can be used for either views
or layouts:
$self->pathname_exists( $self->view_pathname( 'some_view' ) );
$self->pathname_exists( $self->layout_pathname( 'some_layout' ) );
=head2 render_layout($layout, \%tokens, \$content)
Render the layout with the applied tokens
=head2 apply_renderer($view, \%tokens)
=head2 apply_layout($content, \%tokens, \%options)
=head2 process($view, \%tokens, \%options)
=head1 METHODS
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|