1 package WebPAC::Output::TT;
6 use base qw/WebPAC::Common/;
9 use List::Util qw/first/;
11 use URI::Escape qw/uri_escape_utf8/;
15 WebPAC::Output::TT - use Template Toolkit to produce output
23 our $VERSION = '0.03';
27 Produce output using Template Toolkit.
35 my $tt = new WebPAC::Output::TT(
36 include_path => '/path/to/conf/output/tt',
38 filter_1 => sub { uc(shift) },
42 By default, Template Toolkit will C<EVAL_PERL> if included in templates.
51 my $log = $self->_get_logger;
53 # create Template toolkit instance
54 $self->{'tt'} = Template->new(
55 INCLUDE_PATH => $self->{'include_path'},
56 FILTERS => $self->{'filter'},
60 $log->logdie("can't create TT object: $Template::ERROR") unless ($self->{'tt'});
62 $log->debug("filters defined: ",Dumper($self->{'filter'}));
64 $self ? return $self : return undef;
70 Create output from in-memory data structure using Template Toolkit template.
72 my $text = $tt->apply(
73 template => 'text.tt',
75 record_uri => 'database/prefix/mfn',
78 It also has follwing template toolikit filter routies defined:
87 my $log = $self->_get_logger();
89 foreach my $a (qw/template data/) {
90 $log->logconfess("need $a") unless ($args->{$a});
95 filter to return values of specified from $ds, usage from TT template is in form
96 C<d('FieldName','delimiter')>, where C<delimiter> is optional, like this:
104 my ($data,$type) = @_;
106 die "no data?" unless ($data);
109 my $default_delimiter = {
110 'display' => '¶<br/>',
116 my ($name,$join) = @_;
118 die "no data hash" unless ($data->{'data'} && ref($data->{'data'}) eq 'HASH');
119 # Hm? Should we die here?
120 return unless ($name);
122 my $item = $data->{'data'}->{$name} || return;
124 my $v = $item->{$type} || return;
126 if (ref($v) eq 'ARRAY') {
130 $join = $default_delimiter->{$type} unless defined($join);
131 $v = join($join, @{$v});
134 warn("TT filter $type(): field $name values aren't ARRAY, ignoring");
141 $args->{'d'} = tt_filter_type($args, 'display');
142 $args->{'display'} = tt_filter_type($args, 'display');
144 =head3 tt_filter_search
146 filter to return links to search, usage in TT:
148 [% search('FieldToDisplay','FieldToSearch','optional delimiter') %]
152 sub tt_filter_search {
156 die "no data?" unless ($data);
160 my ($display,$search,$delimiter) = @_;
163 $delimiter ||= '¶<br/>',
165 die "no data hash" unless ($data->{'data'} && ref($data->{'data'}) eq 'HASH');
166 # Hm? Should we die here?
167 return unless ($display);
169 my $item = $data->{'data'}->{$display} || return;
171 return unless($item->{'display'});
172 die "error in TT template: field $display didn't insert anything into search, use d('$display') and not search('$display'...)" unless($item->{'search'});
175 foreach my $type (qw/display search/) {
176 push @warn, "field $display type $type values aren't ARRAY" unless (ref($item->{$type}) eq 'ARRAY');
180 warn("TT filter search(): " . join(",", @warn) . ", skipping");
185 my $d_el = $#{ $item->{'display'} };
186 my $s_el = $#{ $item->{'search'} };
188 # easy, both fields have same number of elements or there is just
189 # one search and multiple display
190 if ( $d_el == $s_el || $s_el == 0 ) {
192 foreach my $i ( 0 .. $d_el ) {
196 $s = $item->{'search'}->[$i] || die "can't find value $i for type search in field $search";
198 $s = $item->{'search'}->[0];
200 #$s =~ s/([^\w.-])/sprintf("%%%02X",ord($1))/eg;
201 $s = uri_escape_utf8( $s );
203 my $d = $item->{'display'}->[$i] || die "can't find value $i for type display in field $display";
205 push @html, <<__JS_LINK_SEARCH__
206 <a href="#" onclick="new Ajax.Updater( 'results', '/search/results?$search=$s', { asynchronous: 1,onLoading: function(request){show_searching();},onLoaded: function(request){hide_searching();} } ) ; return false">$d</a>
210 return join($delimiter, @html);
212 my $html = qq{<div class="notice">WARNING: we should really support if there is $d_el display elements and $s_el search elements, but currently there is no nice way to do so, so we will just display values</div>};
213 my $v = $item->{'display'};
218 $html .= join($delimiter, @{$v});
225 $args->{'search'} = tt_filter_search($args);
229 Used mostly for onClick events like this:
231 <a href="#" onClick="[% load_rec( record_uri, 'template_name.tt') %]>foo</a>
233 It will automatically do sanity checking and create correct JavaScript code.
237 $args->{'load_rec'} = sub {
240 my $record_uri = shift or push @errors, "record_uri missing";
241 my $template = shift or push @errors, "template missing";
243 if ($record_uri !~ m#^[^/]+/[^/]+/[^/]+$#) {
244 push @errors, "invalid format of record_uri: $record_uri";
248 return "Logger.error('errors in load_rec: " . join(", ", @errors) . "'); return false;";
250 return "load_rec('$record_uri','$template'); return false;";
256 Used to re-submit search request and load results in different template
258 <a href="#" onClick="[% load_template( 'template_name.tt' ) %]">bar</a>
262 $args->{'load_template'} = sub {
263 my $template = shift or return "Logger.error('load_template missing template name!'); return false;";
264 return "load_template($template); return false;";
269 $self->{'tt'}->process(
273 ) || $log->logconfess( "apply can't process template: ", $self->{'tt'}->error() );
280 Create output from in-memory data structure using Template Toolkit template
285 template => 'text.tt',
296 my $log = $self->_get_logger();
298 my $file = $args->{'file'} || $log->logconfess("need file name");
300 $log->debug("creating file ",$file);
302 open(my $fh, ">", $file) || $log->logdie("can't open output file '$file': $!");
303 print $fh $self->output(
304 template => $args->{'template'},
305 data => $args->{'data'},
306 ) || $log->logdie("print: $!");
307 close($fh) || $log->logdie("close: $!");
315 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
317 =head1 COPYRIGHT & LICENSE
319 Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.
321 This program is free software; you can redistribute it and/or modify it
322 under the same terms as Perl itself.
326 1; # End of WebPAC::Output::TT