X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Debbugs%2FText.pm;h=53ecf04c47fb60019ec09445355e07700eec46cc;hb=6532b246361b5d28b6ce3b44154a71edd3ca9a9e;hp=9a06510dc491843189575cfd032febfc76c048af;hpb=a87a6cb9e637e558042dde45f02915a3bfd3f9e8;p=debbugs.git diff --git a/Debbugs/Text.pm b/Debbugs/Text.pm index 9a06510..53ecf04 100644 --- a/Debbugs/Text.pm +++ b/Debbugs/Text.pm @@ -16,8 +16,8 @@ Debbugs::Text -- General routines for text templates =head1 SYNOPSIS -use Debbugs::Text qw(:templates); -print fill_in_template(template => 'cgi/foo'); + use Debbugs::Text qw(:templates); + print fill_in_template(template => 'cgi/foo'); =head1 DESCRIPTION @@ -33,7 +33,7 @@ None known. use vars qw($DEBUG $VERSION @EXPORT_OK %EXPORT_TAGS @EXPORT @ISA); -use base qw(Exporter); +use Exporter qw(import); BEGIN { $VERSION = 1.00; @@ -47,8 +47,7 @@ BEGIN { $EXPORT_TAGS{all} = [@EXPORT_OK]; } -use Safe; -use Text::Template; +use Text::Xslate qw(html_builder); use Storable qw(dclone); @@ -59,6 +58,86 @@ use Carp; use IO::File; use Data::Dumper; +### for %text_xslate_functions +use POSIX; +use Debbugs::CGI qw(html_escape); +use Scalar::Util; +use Debbugs::Common qw(make_list); +use Debbugs::Status; + +our %tt_templates; +our %filled_templates; +our $language; + + +sub __output_select_options { + my ($options,$value) = @_; + my @options = @{$options}; + my $output = ''; + while (@options) { + my ($o_value) = shift @options; + if (ref($o_value)) { + for (@{$o_value}) { + unshift @options, + ($_,$_); + } + next; + } + my $name = shift @options; + my $selected = ''; + if (defined $value and $o_value eq $value) { + $selected = ' selected'; + } + $output .= q(\n); + } + return $output; +} + +sub __text_xslate_functions { + return + {gm_strftime => sub {POSIX::strftime($_[0],gmtime)}, + package_links => html_builder(\&Debbugs::CGI::package_links), + bug_links => html_builder(\&Debbugs::CGI::bug_links), + looks_like_number => \&Scalar::Util::looks_like_number, + isstrongseverity => \&Debbugs::Status::isstrongseverity, + secs_to_english => \&Debbugs::Common::secs_to_english, + maybelink => \&Debbugs::CGI::maybelink, + # add in a few utility routines + duplicate_array => sub { + my @r = map {($_,$_)} make_list(@{$_[0]}); + return @r; + }, + output_select_options => html_builder(\&__output_select_options), + make_list => \&make_list, + }; +} +sub __text_xslate_functions_text { + return + {bugurl => + sub{ + return "$_[0]: ". + $config{cgi_domain}.'/'. + Debbugs::CGI::bug_links(bug=>$_[0], + links_only => 1, + ); + }, + }; +} + + + +### this function removes leading spaces from line-start code strings and spaces +### before <:- and spaces after -:> +sub __html_template_prefilter { + my $text = shift; + $text =~ s/^\s+:/:/mg; + $text =~ s/((?:^:[^\n]*\n)?)\s*(<:-)/$1$2/mg; + $text =~ s/(-:>)\s+(^:|)/$1.(length($2)?"\n$2":'')/emg; + return $text; +} + + =head2 fill_in_template print fill_in_template(template => 'template_name', @@ -66,18 +145,14 @@ use Data::Dumper; language => '..' ); -Reads a template from disk (if it hasn't already been read in) and -fills the template in. +Reads a template from disk (if it hasn't already been read in) andf +ills the template in. =cut -our %tt_templates; -our %filled_templates; -our $safe; -our $language; sub fill_in_template{ my %param = validate_with(params => \@_, - spec => {template => SCALAR|HANDLE|SCALARREF, + spec => {template => SCALAR, variables => {type => HASHREF, default => {}, }, @@ -87,174 +162,59 @@ sub fill_in_template{ output => {type => HANDLE, optional => 1, }, - safe => {type => OBJECT, + hole_var => {type => HASHREF, optional => 1, }, + output_type => {type => SCALAR, + default => 'html', + }, }, ); - return _fill_in_template(@param{qw(template variables language safe output)}); -} - - -sub include { - my $template = shift; - $filled_templates{$template}++; - print STDERR "include template $template language $language safe $safe\n" if $DEBUG; - # Die if we're in a template loop - die "Template loop with $template" if $filled_templates{$template} > 10; - my $filled_tmpl; - eval { - $filled_tmpl = Debbugs::Text::_fill_in_template($template, - {}, - $language, - $safe, - undef, - 1 - ); - }; - if ($@) { - print STDERR "failed to fill template $template: $@"; - } - print STDERR "failed to fill template $template\n" if $filled_tmpl eq '' and $DEBUG; - print STDERR "template $template '$filled_tmpl'\n" if $DEBUG; - $filled_templates{$template}--; - return $filled_tmpl; -}; - -sub _fill_in_template{ - my %param; - @param{qw(template variables language safe output nosafe)} = @_; - print STDERR "_fill template $param{template} language $param{language} safe $param{safe}\n" - if $DEBUG; - # Get the text - my $tt_type = ''; - my $tt_source; - if (ref($param{template}) eq 'GLOB' or - ref(\$param{template}) eq 'GLOB') { - $tt_type = 'FILE_HANDLE'; - $tt_source = $param{template}; - } - elsif (ref($param{template}) eq 'SCALAR') { - $tt_type = 'STRING'; - $tt_source = ${$param{template}}; - } - else { - $tt_type = 'FILE'; - $tt_source = _locate_text($param{template},$param{language}); - } - if (not defined $tt_source) { - die "Unable to find template $param{template} with language $param{language}"; - } - - if (defined $param{safe}) { - $safe = $param{safe}; - } - else { - print STDERR "Created new safe\n" if $DEBUG; - $safe = Safe->new() or die "Unable to create safe compartment"; - $safe->deny_only(); - my @modules = ('Text::Template' => undef, - # This doesn't work yet; have to figure it out - #'Debbugs::Config' => [qw(:globals :config)], - ); - while (my ($module,$param) = splice (@modules,0,2)) { - print STDERR "Eval $module\n" if $DEBUG; - my $code = ''; - if (not defined $param) { - $code = "use $module;"; - } - else { - $code = "use $module ".(join(',',map {"q($_)"} @{$param})).';'; - } - $safe->reval($code); - print STDERR "Error while attempting to eval '$code': $@" if $@; - } - $safe->permit_only(':base_core',':base_io',':base_mem',':base_loop', - qw(padsv padav padhv padany), - qw(rv2gv refgen srefgen ref), - ); - $safe->share('$language','%tt_templates','$safe','$variables','%filled_templates'); - $safe->share('*STDERR'); - $safe->share('&_fill_in_template'); - $safe->share('%config'); - $safe->share('&include'); - my $root = $safe->root(); - # load variables into the safe - for my $key (keys %{$param{variables}||{}}) { - print STDERR "Loading $key\n" if $DEBUG; - if (ref($param{variables}{$key})) { - no strict 'refs'; - print STDERR $safe->root().'::'.$key,qq(\n) if $DEBUG; - *{"${root}::$key"} = $param{variables}{$key}; - } - else { - no strict 'refs'; - ${"${root}::$key"} = $param{variables}{$key}; - } - } - } - #$safe->deny_only(); - # perldoc Opcode; for details - $language = $param{language}; + my $output_type = $param{output_type}; + my $language = $param{language}; + my $template = $param{template}; + $template .= '.tx' unless $template =~ /\.tx$/; my $tt; - if ($tt_type eq 'FILE' and - defined $tt_templates{$tt_source} and - (stat $tt_source)[9] > $tt_templates{$tt_source}{mtime} + if (not exists $tt_templates{$output_type}{$language} or + not defined $tt_templates{$output_type}{$language} ) { - $tt = $tt_templates{$tt_source}{template}; - } - else { - if ($tt_type eq 'FILE') { - $tt_templates{$tt_source}{mtime} = - (stat $tt_source)[9]; - } - $tt = Text::Template->new(TYPE => $tt_type, - SOURCE => $tt_source, - ); - if ($tt_type eq 'FILE') { - $tt_templates{$tt_source}{template} = $tt; - } - } - if (not defined $tt) { - die "Unable to create Text::Template for $tt_type:$tt_source"; + $tt_templates{$output_type}{$language} = + Text::Xslate->new(# cache in template_cache or temp directory + cache_dir => $config{template_cache} // + File::Temp::tempdir(CLEANUP => 1), + # default to the language, but fallback to en_US + path => [$config{template_dir}.'/'.$language.'/', + $config{template_dir}.'/en_US/', + ], + suffix => '.tx', + ## use html or text specific functions + function => + ($output_type eq 'html' ? __text_xslate_functions() : + __text_xslate_functions_text()), + syntax => 'Kolon', + module => ['Text::Xslate::Bridge::Star', + 'Debbugs::Text::XslateBridge', + ], + type => $output_type, + ## use the html-specific pre_process_handler + $output_type eq 'html'? + (pre_process_handler => \&__html_template_prefilter):(), + ) + or die "Unable to create Text::Xslate"; } - my $ret = $tt->fill_in(#(defined $param{nosafe} and $param{nosafe})?():(HASH=>$param{variables}), - (defined $param{nosafe} and $param{nosafe})?():(SAFE=>$safe), - #SAFE => $safe, - (defined $param{nosafe} and $param{nosafe})?(PACKAGE => 'main'):(), - defined $param{output}?(OUTPUT=>$param{output}):(), - ); - if (not defined $ret) { - print STDERR $Text::Template::ERROR; - return ''; + $tt = $tt_templates{$output_type}{$language}; + my $ret = + $tt->render($template, + {time => time, + %{$param{variables}//{}}, + config => \%config, + }); + if (exists $param{output}) { + print {$param{output}} $ret; + return ''; } - if ($DEBUG) { - no strict 'refs'; - no warnings 'uninitialized'; - my $temp = $param{nosafe}?'main':$safe->{Root}; - print STDERR "Variables for $param{template}\n"; - print STDERR "Safe $temp\n"; - print STDERR map {"$_:${$_}\n"} keys %{"${temp}::"}; - print STDERR ${"${temp}::search_value"},qq(\n); - } - return $ret; } -sub _locate_text{ - my ($template,$language) = @_; - $template =~ s/\.tmpl$//g; - # if a language doesn't exist, use the en_US template - if (not -e $config{template_dir}.'/'.$language.'/'.$template.'.tmpl') { - $language = 'en_US'; - } - my $loc = $config{template_dir}.'/'.$language.'/'.$template.'.tmpl'; - if (not -e $loc) { - print STDERR "Unable to locate template $loc\n"; - return undef; - } - return $loc; -} - 1;