Add repository resource to all the MI Makefile.PLs
[catagits/Catalyst-View-TT.git] / lib / Catalyst / View / TT.pm
CommitLineData
8077080c 1package Catalyst::View::TT;
2
3use strict;
6229ce0d 4use warnings;
5
7d8aa5ec 6use base qw/Catalyst::View/;
9e739e1e 7use Data::Dump 'dump';
8077080c 8use Template;
9use Template::Timer;
e8693f1b 10use MRO::Compat;
8077080c 11
6229ce0d 12our $VERSION = '0.30';
8077080c 13
14__PACKAGE__->mk_accessors('template');
e2bbd784 15__PACKAGE__->mk_accessors('include_path');
8077080c 16
9d574573 17*paths = \&include_path;
18
8077080c 19=head1 NAME
20
21Catalyst::View::TT - Template View Class
22
23=head1 SYNOPSIS
24
bd4ee63a 25# use the helper to create your View
722fede4 26 myapp_create.pl view TT TT
8077080c 27
6175bba7 28# configure in lib/MyApp.pm (Could be set from configfile instead)
8cd017a8 29
ae035767 30 MyApp->config(
8cd017a8 31 name => 'MyApp',
e1c15a53 32 root => MyApp->path_to('root'),
ae035767 33 'View::TT' => {
8cd017a8 34 # any TT configurations items go here
35 INCLUDE_PATH => [
93f25382 36 MyApp->path_to( 'root', 'src' ),
37 MyApp->path_to( 'root', 'lib' ),
8cd017a8 38 ],
6175bba7 39 TEMPLATE_EXTENSION => '.tt',
40 CATALYST_VAR => 'c',
41 TIMER => 0,
42 # Not set by default
07571b2f 43 PRE_PROCESS => 'config/main',
44 WRAPPER => 'site/wrapper',
8cd017a8 45 },
ae035767 46 );
8cd017a8 47
6229ce0d 48# render view from lib/MyApp.pm or lib/MyApp::Controller::SomeController.pm
8cd017a8 49
50 sub message : Global {
94b3529a 51 my ( $self, $c ) = @_;
52 $c->stash->{template} = 'message.tt2';
53 $c->stash->{message} = 'Hello World!';
c18eae32 54 $c->forward( $c->view('TT') );
8cd017a8 55 }
8077080c 56
8cd017a8 57# access variables from template
58
59 The message is: [% message %].
60
61 # example when CATALYST_VAR is set to 'Catalyst'
62 Context is [% Catalyst %]
63 The base is [% Catalyst.req.base %]
64 The name is [% Catalyst.config.name %]
65
66 # example when CATALYST_VAR isn't set
67 Context is [% c %]
68 The base is [% base %]
69 The name is [% name %]
70
bd4ee63a 71=cut
72
73sub _coerce_paths {
74 my ( $paths, $dlim ) = shift;
75 return () if ( !$paths );
76 return @{$paths} if ( ref $paths eq 'ARRAY' );
77
78 # tweak delim to ignore C:/
79 unless ( defined $dlim ) {
80 $dlim = ( $^O eq 'MSWin32' ) ? ':(?!\\/)' : ':';
81 }
82 return split( /$dlim/, $paths );
83}
84
85sub new {
86 my ( $class, $c, $arguments ) = @_;
87 my $config = {
88 EVAL_PERL => 0,
89 TEMPLATE_EXTENSION => '',
90 %{ $class->config },
91 %{$arguments},
92 };
93 if ( ! (ref $config->{INCLUDE_PATH} eq 'ARRAY') ) {
94 my $delim = $config->{DELIMITER};
95 my @include_path
96 = _coerce_paths( $config->{INCLUDE_PATH}, $delim );
97 if ( !@include_path ) {
98 my $root = $c->config->{root};
99 my $base = Path::Class::dir( $root, 'base' );
100 @include_path = ( "$root", "$base" );
101 }
102 $config->{INCLUDE_PATH} = \@include_path;
103 }
104
105 # if we're debugging and/or the TIMER option is set, then we install
106 # Template::Timer as a custom CONTEXT object, but only if we haven't
107 # already got a custom CONTEXT defined
108
109 if ( $config->{TIMER} ) {
110 if ( $config->{CONTEXT} ) {
111 $c->log->error(
112 'Cannot use Template::Timer - a TT CONTEXT is already defined'
113 );
114 }
115 else {
116 $config->{CONTEXT} = Template::Timer->new(%$config);
117 }
118 }
119
120 if ( $c->debug && $config->{DUMP_CONFIG} ) {
9e739e1e 121 $c->log->debug( "TT Config: ", dump($config) );
bd4ee63a 122 }
6175bba7 123
e8693f1b 124 my $self = $class->next::method(
6175bba7 125 $c, { %$config },
126 );
127
128 # Set base include paths. Local'd in render if needed
129 $self->include_path($config->{INCLUDE_PATH});
130
131 $self->config($config);
132
133 # Creation of template outside of call to new so that we can pass [ $self ]
134 # as INCLUDE_PATH config item, which then gets ->paths() called to get list
135 # of include paths to search for templates.
136
137 # Use a weakend copy of self so we dont have loops preventing GC from working
138 my $copy = $self;
139 Scalar::Util::weaken($copy);
140 $config->{INCLUDE_PATH} = [ sub { $copy->paths } ];
141
bd4ee63a 142 if ( $config->{PROVIDERS} ) {
143 my @providers = ();
144 if ( ref($config->{PROVIDERS}) eq 'ARRAY') {
145 foreach my $p (@{$config->{PROVIDERS}}) {
146 my $pname = $p->{name};
147 my $prov = 'Template::Provider';
148 if($pname eq '_file_')
149 {
150 $p->{args} = { %$config };
151 }
152 else
153 {
51199593 154 if($pname =~ s/^\+//) {
155 $prov = $pname;
156 }
157 else
158 {
159 $prov .= "::$pname";
160 }
6175bba7 161 # We copy the args people want from the config
162 # to the args
163 $p->{args} ||= {};
164 if ($p->{copy_config}) {
165 map { $p->{args}->{$_} = $config->{$_} }
166 grep { exists $config->{$_} }
167 @{ $p->{copy_config} };
168 }
bd4ee63a 169 }
170 eval "require $prov";
171 if(!$@) {
172 push @providers, "$prov"->new($p->{args});
173 }
174 else
175 {
176 $c->log->warn("Can't load $prov, ($@)");
177 }
178 }
179 }
180 delete $config->{PROVIDERS};
181 if(@providers) {
182 $config->{LOAD_TEMPLATES} = \@providers;
183 }
184 }
bd4ee63a 185
186 $self->{template} =
187 Template->new($config) || do {
188 my $error = Template->error();
189 $c->log->error($error);
190 $c->error($error);
191 return undef;
192 };
193
194
195 return $self;
196}
197
198sub process {
199 my ( $self, $c ) = @_;
200
201 my $template = $c->stash->{template}
202 || $c->action . $self->config->{TEMPLATE_EXTENSION};
203
204 unless (defined $template) {
205 $c->log->debug('No template specified for rendering') if $c->debug;
206 return 0;
207 }
208
209 my $output = $self->render($c, $template);
210
211 if (UNIVERSAL::isa($output, 'Template::Exception')) {
82b741a3 212 my $error = qq/Couldn't render template "$output"/;
bd4ee63a 213 $c->log->error($error);
214 $c->error($error);
215 return 0;
216 }
217
218 unless ( $c->response->content_type ) {
219 $c->response->content_type('text/html; charset=utf-8');
220 }
221
222 $c->response->body($output);
223
224 return 1;
225}
226
227sub render {
228 my ($self, $c, $template, $args) = @_;
229
230 $c->log->debug(qq/Rendering template "$template"/) if $c->debug;
231
232 my $output;
233 my $vars = {
234 (ref $args eq 'HASH' ? %$args : %{ $c->stash() }),
235 $self->template_vars($c)
236 };
237
238 local $self->{include_path} =
239 [ @{ $vars->{additional_template_paths} }, @{ $self->{include_path} } ]
240 if ref $vars->{additional_template_paths};
241
242 unless ($self->template->process( $template, $vars, \$output ) ) {
243 return $self->template->error;
244 } else {
245 return $output;
246 }
247}
248
249sub template_vars {
250 my ( $self, $c ) = @_;
251
252 my $cvar = $self->config->{CATALYST_VAR};
253
254 defined $cvar
255 ? ( $cvar => $c )
256 : (
257 c => $c,
258 base => $c->req->base,
259 name => $c->config->{name}
260 )
261}
262
263
2641;
265
266__END__
267
8cd017a8 268=head1 DESCRIPTION
269
270This is the Catalyst view class for the L<Template Toolkit|Template>.
271Your application should defined a view class which is a subclass of
272this module. The easiest way to achieve this is using the
273F<myapp_create.pl> script (where F<myapp> should be replaced with
274whatever your application is called). This script is created as part
275of the Catalyst setup.
276
277 $ script/myapp_create.pl view TT TT
278
6229ce0d 279This creates a MyApp::View::TT.pm module in the F<lib> directory (again,
8cd017a8 280replacing C<MyApp> with the name of your application) which looks
281something like this:
282
6229ce0d 283 package FooBar::View::TT;
8cd017a8 284
285 use strict;
c18eae32 286 use warnings;
287
288 use base 'Catalyst::View::TT';
8077080c 289
290 __PACKAGE__->config->{DEBUG} = 'all';
291
8cd017a8 292Now you can modify your action handlers in the main application and/or
293controllers to forward to your view class. You might choose to do this
294in the end() method, for example, to automatically forward all actions
295to the TT view class.
722fede4 296
8cd017a8 297 # In MyApp or MyApp::Controller::SomeController
8077080c 298
8cd017a8 299 sub end : Private {
94b3529a 300 my( $self, $c ) = @_;
c18eae32 301 $c->forward( $c->view('TT') );
8cd017a8 302 }
8077080c 303
8cd017a8 304=head2 CONFIGURATION
4687ac0d 305
8cd017a8 306There are a three different ways to configure your view class. The
307first way is to call the C<config()> method in the view subclass. This
308happens when the module is first loaded.
8077080c 309
6229ce0d 310 package MyApp::View::TT;
8cd017a8 311
312 use strict;
313 use base 'Catalyst::View::TT';
722fede4 314
6229ce0d 315 MyApp::View::TT->config({
7d8aa5ec 316 INCLUDE_PATH => [
317 MyApp->path_to( 'root', 'templates', 'lib' ),
318 MyApp->path_to( 'root', 'templates', 'src' ),
319 ],
8cd017a8 320 PRE_PROCESS => 'config/main',
321 WRAPPER => 'site/wrapper',
322 });
323
324The second way is to define a C<new()> method in your view subclass.
325This performs the configuration when the view object is created,
326shortly after being loaded. Remember to delegate to the base class
e8693f1b 327C<new()> method (via C<$self-E<gt>next::method()> in the example below) after
8cd017a8 328performing any configuration.
329
330 sub new {
331 my $self = shift;
332 $self->config({
7d8aa5ec 333 INCLUDE_PATH => [
334 MyApp->path_to( 'root', 'templates', 'lib' ),
335 MyApp->path_to( 'root', 'templates', 'src' ),
336 ],
8cd017a8 337 PRE_PROCESS => 'config/main',
338 WRAPPER => 'site/wrapper',
339 });
e8693f1b 340 return $self->next::method(@_);
8cd017a8 341 }
342
94b3529a 343The final, and perhaps most direct way, is to define a class
8cd017a8 344item in your main application configuration, again by calling the
94b3529a 345uniquitous C<config()> method. The items in the class hash are
8cd017a8 346added to those already defined by the above two methods. This happens
347in the base class new() method (which is one reason why you must
e8693f1b 348remember to call it via C<MRO::Compat> if you redefine the C<new()>
349method in a subclass).
8cd017a8 350
351 package MyApp;
352
353 use strict;
354 use Catalyst;
355
8cd017a8 356 MyApp->config({
357 name => 'MyApp',
7d8aa5ec 358 root => MyApp->path_to('root'),
6229ce0d 359 'View::TT' => {
7d8aa5ec 360 INCLUDE_PATH => [
361 MyApp->path_to( 'root', 'templates', 'lib' ),
362 MyApp->path_to( 'root', 'templates', 'src' ),
363 ],
8cd017a8 364 PRE_PROCESS => 'config/main',
365 WRAPPER => 'site/wrapper',
366 },
367 });
368
369Note that any configuration items defined by one of the earlier
370methods will be overwritten by items of the same name provided by the
371latter methods.
372
e2bbd784 373=head2 DYNAMIC INCLUDE_PATH
374
f7dfca06 375Sometimes it is desirable to modify INCLUDE_PATH for your templates at run time.
376
377Additional paths can be added to the start of INCLUDE_PATH via the stash as
378follows:
379
380 $c->stash->{additional_template_paths} =
381 [$c->config->{root} . '/test_include_path'];
382
383If you need to add paths to the end of INCLUDE_PATH, there is also an
384include_path() accessor available:
385
386 push( @{ $c->view('TT')->include_path }, qw/path/ );
387
388Note that if you use include_path() to add extra paths to INCLUDE_PATH, you
389MUST check for duplicate paths. Without such checking, the above code will add
390"path" to INCLUDE_PATH at every request, causing a memory leak.
391
392A safer approach is to use include_path() to overwrite the array of paths
393rather than adding to it. This eliminates both the need to perform duplicate
394checking and the chance of a memory leak:
e2bbd784 395
f7dfca06 396 @{ $c->view('TT')->include_path } = qw/path another_path/;
e2bbd784 397
1bc9fc55 398If you are calling C<render> directly then you can specify dynamic paths by
9d574573 399having a C<additional_template_paths> key with a value of additonal directories
1bc9fc55 400to search. See L<CAPTURING TEMPLATE OUTPUT> for an example showing this.
401
8cd017a8 402=head2 RENDERING VIEWS
403
404The view plugin renders the template specified in the C<template>
405item in the stash.
406
407 sub message : Global {
94b3529a 408 my ( $self, $c ) = @_;
409 $c->stash->{template} = 'message.tt2';
6229ce0d 410 $c->forward( $c->view('TT') );
8cd017a8 411 }
722fede4 412
c969f23a 413If a stash item isn't defined, then it instead uses the
414stringification of the action dispatched to (as defined by $c->action)
415in the above example, this would be C<message>, but because the default
416is to append '.tt', it would load C<root/message.tt>.
8cd017a8 417
418The items defined in the stash are passed to the Template Toolkit for
419use as template variables.
420
8cd017a8 421 sub default : Private {
94b3529a 422 my ( $self, $c ) = @_;
423 $c->stash->{template} = 'message.tt2';
424 $c->stash->{message} = 'Hello World!';
6229ce0d 425 $c->forward( $c->view('TT') );
8cd017a8 426 }
7b592fc7 427
8cd017a8 428A number of other template variables are also added:
8077080c 429
8cd017a8 430 c A reference to the context object, $c
431 base The URL base, from $c->req->base()
432 name The application name, from $c->config->{ name }
433
434These can be accessed from the template in the usual way:
435
436<message.tt2>:
437
438 The message is: [% message %]
439 The base is [% base %]
440 The name is [% name %]
441
8cd017a8 442
1bc9fc55 443The output generated by the template is stored in C<< $c->response->body >>.
444
445=head2 CAPTURING TEMPLATE OUTPUT
446
447If you wish to use the output of a template for some other purpose than
448displaying in the response, e.g. for sending an email, this is possible using
449L<Catalyst::Plugin::Email> and the L<render> method:
450
451 sub send_email : Local {
452 my ($self, $c) = @_;
453
454 $c->email(
455 header => [
456 To => 'me@localhost',
457 Subject => 'A TT Email',
458 ],
459 body => $c->view('TT')->render($c, 'email.tt', {
9d574573 460 additional_template_paths => [ $c->config->{root} . '/email_templates'],
1bc9fc55 461 email_tmpl_param1 => 'foo'
462 }
463 ),
464 );
465 # Redirect or display a message
466 }
8cd017a8 467
468=head2 TEMPLATE PROFILING
469
1bc9fc55 470See L<C<TIMER>> property of the L<config> method.
471
caa61517 472=head2 METHODS
8077080c 473
b63ddd04 474=head2 new
2774dc77 475
476The constructor for the TT view. Sets up the template provider,
477and reads the application config.
478
b63ddd04 479=head2 process
8077080c 480
1bc9fc55 481Renders the template specified in C<< $c->stash->{template} >> or
482C<< $c->action >> (the private name of the matched action. Calls L<render> to
483perform actual rendering. Output is stored in C<< $c->response->body >>.
8077080c 484
b63ddd04 485=head2 render($c, $template, \%args)
1bc9fc55 486
487Renders the given template and returns output, or a L<Template::Exception>
488object upon error.
489
490The template variables are set to C<%$args> if $args is a hashref, or
491$C<< $c->stash >> otherwise. In either case the variables are augmented with
492C<base> set to C< << $c->req->base >>, C<c> to C<$c> and C<name> to
493C<< $c->config->{name} >>. Alternately, the C<CATALYST_VAR> configuration item
494can be defined to specify the name of a template variable through which the
495context reference (C<$c>) can be accessed. In this case, the C<c>, C<base> and
496C<name> variables are omitted.
497
498C<$template> can be anything that Template::process understands how to
499process, including the name of a template file or a reference to a test string.
500See L<Template::process|Template/process> for a full list of supported formats.
501
b63ddd04 502=head2 template_vars
850ee226 503
1bc9fc55 504Returns a list of keys/values to be used as the catalyst variables in the
850ee226 505template.
506
b63ddd04 507=head2 config
8077080c 508
8cd017a8 509This method allows your view subclass to pass additional settings to
4729c102 510the TT configuration hash, or to set the options as below:
511
b63ddd04 512=head2 paths
513
514The list of paths TT will look for templates in.
4729c102 515
b63ddd04 516=head2 C<CATALYST_VAR>
4729c102 517
518Allows you to change the name of the Catalyst context object. If set, it will also
519remove the base and name aliases, so you will have access them through <context>.
520
521For example:
522
523 MyApp->config({
524 name => 'MyApp',
7d8aa5ec 525 root => MyApp->path_to('root'),
6229ce0d 526 'View::TT' => {
4729c102 527 CATALYST_VAR => 'Catalyst',
528 },
529 });
530
531F<message.tt2>:
532
533 The base is [% Catalyst.req.base %]
534 The name is [% Catalyst.config.name %]
535
b63ddd04 536=head2 C<TIMER>
4729c102 537
538If you have configured Catalyst for debug output, and turned on the TIMER setting,
539C<Catalyst::View::TT> will enable profiling of template processing
540(using L<Template::Timer>). This will embed HTML comments in the
541output from your templates, such as:
542
543 <!-- TIMER START: process mainmenu/mainmenu.ttml -->
544 <!-- TIMER START: include mainmenu/cssindex.tt -->
545 <!-- TIMER START: process mainmenu/cssindex.tt -->
546 <!-- TIMER END: process mainmenu/cssindex.tt (0.017279 seconds) -->
547 <!-- TIMER END: include mainmenu/cssindex.tt (0.017401 seconds) -->
548
549 ....
550
551 <!-- TIMER END: process mainmenu/footer.tt (0.003016 seconds) -->
552
553
b63ddd04 554=head2 C<TEMPLATE_EXTENSION>
4729c102 555
747f2b6d 556a sufix to add when looking for templates bases on the C<match> method in L<Catalyst::Request>.
4729c102 557
558For example:
559
6229ce0d 560 package MyApp::Controller::Test;
4729c102 561 sub test : Local { .. }
562
563Would by default look for a template in <root>/test/test. If you set TEMPLATE_EXTENSION to '.tt', it will look for
564<root>/test/test.tt.
565
51199593 566=head2 C<PROVIDERS>
567
568Allows you to specify the template providers that TT will use.
569
570 MyApp->config({
571 name => 'MyApp',
572 root => MyApp->path_to('root'),
6229ce0d 573 'View::TT' => {
51199593 574 PROVIDERS => [
575 {
576 name => 'DBI',
577 args => {
578 DBI_DSN => 'dbi:DB2:books',
579 DBI_USER=> 'foo'
580 }
581 }, {
582 name => '_file_',
583 args => {}
584 }
585 ]
586 },
587 });
588
589The 'name' key should correspond to the class name of the provider you
590want to use. The _file_ name is a special case that represents the default
591TT file-based provider. By default the name is will be prefixed with
592'Template::Provider::'. You can fully qualify the name by using a unary
593plus:
594
595 name => '+MyApp::Provider::Foo'
596
6175bba7 597You can also specify the 'copy_config' key as an arrayref, to copy those keys
598from the general config, into the config for the provider:
599
600 DEFAULT_ENCODING => 'utf-8',
601 PROVIDERS => [
602 {
603 name => 'Encoding',
604 copy_config => [qw(DEFAULT_ENCODING INCLUDE_PATH)]
605 }
606 ]
607
608This can prove useful when you want to use the additional_template_paths hack
609in your own provider, or if you need to use Template::Provider::Encoding
610
8cd017a8 611=head2 HELPERS
612
613The L<Catalyst::Helper::View::TT> and
614L<Catalyst::Helper::View::TTSite> helper modules are provided to create
615your view module. There are invoked by the F<myapp_create.pl> script:
616
617 $ script/myapp_create.pl view TT TT
618
619 $ script/myapp_create.pl view TT TTSite
620
621The L<Catalyst::Helper::View::TT> module creates a basic TT view
622module. The L<Catalyst::Helper::View::TTSite> module goes a little
623further. It also creates a default set of templates to get you
624started. It also configures the view module to locate the templates
625automatically.
626
8077080c 627=head1 SEE ALSO
628
8cd017a8 629L<Catalyst>, L<Catalyst::Helper::View::TT>,
630L<Catalyst::Helper::View::TTSite>, L<Template::Manual>
8077080c 631
c0eb0527 632=head1 AUTHORS
8077080c 633
634Sebastian Riedel, C<sri@cpan.org>
c0eb0527 635
d938377b 636Marcus Ramberg, C<mramberg@cpan.org>
c0eb0527 637
722fede4 638Jesse Sheidlower, C<jester@panix.com>
c0eb0527 639
8cd017a8 640Andy Wardley, C<abw@cpan.org>
8077080c 641
642=head1 COPYRIGHT
643
2774dc77 644This program is free software, you can redistribute it and/or modify it
645under the same terms as Perl itself.
8077080c 646
647=cut