/usr/share/perl5/Template/Multilingual/Parser.pm is in libtemplate-multilingual-perl 1.00-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 | package Template::Multilingual::Parser;
use strict;
use base qw(Template::Parser);
our $VERSION = '1.00';
sub new
{
my ($class, $options) = @_;
my $self = $class->SUPER::new($options);
$self->{_sections} = [];
$self->{_langvar} = $options->{LANGUAGE_VAR} || 'language';
my $style = $self->{ STYLE }->[-1];
@$self{ qw(_start _end) } = @$style{ qw( START_TAG END_TAG ) };
for (qw( _start _end )) {
$self->{$_} =~ s/\\([^\\])/$1/g;
}
return $self;
}
sub parse
{
my ($self, $text) = @_;
# isolate multilingual sections
$self->_tokenize($text);
# replace multilingual sections with TT directives
my ($S, $E, $LANGVAR) = map $self->{$_}, qw(_start _end _langvar);
# if language is a variant (en_US), create a template variable holding the fallback value (en)
$text = "$S IF (tm_matches = $LANGVAR.match('^(\\w+)[-_].*\$')); tm_fb = tm_matches.0; END $E";
for my $section (@{$self->{_sections}}) {
if ($section->{nolang}) {
$text .= $section->{nolang};
}
elsif (my $t = $section->{lang}) {
my @languages = keys %$t;
# first loop through languages: look for exact match
$text .= "$S tm_f = 0; SWITCH $LANGVAR $E";
for my $lang (@languages) {
$text .= "$S CASE '$lang' $E" . $t->{$lang};
}
# add a default case to trigger fallback
$text .= "$S CASE; tm_f=1; END; $E";
# second loop: fallback to primary language (en_US matches en)
$text .= "$S IF tm_fb AND tm_f; tm_f=0; SWITCH tm_fb; $E";
for my $lang (@languages) {
$text .= "$S CASE '$lang' $E" . $t->{$lang};
}
# add a default case to trigger last resort fallback
# LANG is fr_XX or fr but template has neither
# we try to fallback to fr_YY is present
my %seen;
my @fallbacks = map { /^(\w+)[-_].*$/ && !$seen{$_}++ ? [ $1 => $_] : () } sort @languages;
if (@fallbacks) {
# third loop: fallback to first available variant
$text .= "$S CASE; tm_f=1; END; END; IF tm_f; SWITCH tm_fb || $LANGVAR; $E";
for my $ref (@fallbacks) {
my ($lang, $variant) = @$ref;
$text .= "$S CASE '$lang' $E" . $t->{$variant};
}
}
$text .= "$S END; END $E";
}
}
return $self->SUPER::parse ($text);
}
sub _tokenize
{
my ($self, $text) = @_;
# extract all sections from the text
$self->{_sections} = [];
my @tokens = split m!<t>(.*?)</t>!s, $text;
my $i = 0;
for my $t (@tokens) {
if ($i) { # <t>...</t> multilingual section
my %section;
while ($t =~ m!<([^<>]+)>(.*?)</\1>!gs) {
$section{$1} = $2;
}
push @{$self->{_sections}}, { lang => \%section }
if %section;
}
else { # bare text
push @{$self->{_sections}}, { nolang => $t } if $t;
}
$i = 1 - $i;
}
}
sub sections { $_[0]->{_sections} }
=head1 NAME
Template::Multilingual::Parser - Multilingual template parser
=head1 SYNOPSIS
use Template;
use Template::Multilingual::Parser;
my $parser = Template::Multilingual::Parser->new();
my $template = Template->new(PARSER => $parser);
$template->process('example.ttml', { language => 'en'});
=head1 DESCRIPTION
This subclass of Template Toolkit's C<Template::Parser> parses multilingual
templates: templates that contain text in several languages.
<t>
<en>Hello!</en>
<fr>Bonjour !</fr>
</t>
Use this module directly if you have subclassed C<Template>, otherwise you
may find it easier to use C<Template::Multilingual>.
Language codes can be any string that matches C<\w+>, but we suggest
sticking to ISO-639 which provides 2-letter codes for common languages
and 3-letter codes for many others.
=head1 METHODS
=head2 new(\%params)
The new() constructor creates and returns a reference to a new
parser object. A reference to a hash may be supplied as a
parameter to provide configuration values.
Parser objects are typically provided as the C<PARSER> option
to the C<Template> constructor.
Configuration values are all valid C<Template::Parser> superclass
options, and one specific to this class:
=over
=item LANGUAGE_VAR
The LANGUAGE_VAR option can be used to set the name of the template
variable which contains the current language. Defaults to
I<language>.
my $parser = Template::Multilingual::Parser->new({
LANGUAGE_VAR => 'global.language',
});
You will need to set this variable with the current language value
at request time, usually in your C<Template> subclass' C<process()>
method.
=back
=head2 parse($text)
parse() is called by the Template Toolkit. It parses multilingual
sections from the input text and translates them to Template Toolkit
directives. The result is then passed to the C<Template::Parser> superclass.
=head2 sections
Returns a reference to an array of tokenized sections. Each section is a
reference to hash with either a C<nolang> key or a C<lang> key.
A C<nolang> key denotes text outside of any multilingual sections. The value
is the text itself.
A C<lang> key denotes text inside a multilingual section. The value is a
reference to a hash, whose keys are language codes and values the corresponding
text. For example, the following multilingual template:
foo <t><fr>bonjour</fr><en>Hello</en></t> bar
will parse to the following sections:
[ { nolang => 'foo ' },
{ lang => { fr => 'bonjour', en => 'hello' } },
{ nolang => ' bar' },
]
=head1 LANGUAGE SUBTAG HANDLING
This module supports language subtags to express variants, e.g. "en_US" or "en-US".
Here are the rules used for language matching:
=over
=item *
Exact match: the current language is found in the template
language template output
fr <fr>foo</fr><fr_CA>bar</fr_CA> foo
fr_CA <fr>foo</fr><fr_CA>bar</fr_CA> bar
=item *
Fallback to the primary language
language template output
fr_CA <fr>foo</fr><fr_BE>bar</fr_BE> foo
=item *
Fallback to first (in alphabetical order) other variant of the primary language
language template output
fr <fr_FR>foo</fr_FR><fr_BE>bar</fr_BE> bar
fr_CA <fr_FR>foo</fr_FR><fr_BE>bar</fr_BE> bar
=back
=head1 AUTHOR
Eric Cholet, C<< <cholet@logilune.com> >>
=head1 BUGS
Multilingual text sections cannot be used inside TT directives.
The following is illegal and will trigger a TT syntax error:
[% title = "<t><fr>Bonjour</fr><en>Hello</en></t>" %]
Use this instead:
[% title = BLOCK %]<t><fr>Bonjour</fr><en>Hello</en></t>[% END %]
The TAG_STYLE, START_TAG and END_TAG directives are supported, but the
TAGS directive is not.
Please report any bugs or feature requests to
C<bug-template-multilingual@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Template-Multilingual>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
=head1 SEE ALSO
L<Template::Multilingual>
ISO 639-2 Codes for the Representation of Names of Languages:
http://www.loc.gov/standards/iso639-2/langcodes.html
=head1 COPYRIGHT & LICENSE
Copyright 2009 Eric Cholet, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1; # End of Template::Multilingual::Parser
|