1 package t
::lib
::QA
::TemplateFilters
;
35 return _process_tt_content
( @_ )->{new_content
};
39 return @
{_process_tt_content
( @_ )->{errors
}};
43 sub _process_tt_content
{
45 my ( $use_raw, $has_use_raw );
49 for my $line ( split "\n", $content ) {
52 if ( $line =~ m{\[%[^%]+%\]} ) {
54 # handle exceptions first
55 if ( $line =~ m{\|\s*\$raw} ) { # Is the file use the raw filter?
59 # Do we have Asset without the raw filter?
60 if ( $line =~ m{^\s*\[% Asset} && $line !~ m{\|\s*\$raw} ) {
63 error
=> 'asset_must_be_raw',
65 line_number
=> $line_number
67 $new_line =~ s/\)\s*%]/) | \$raw %]/;
69 push @new_lines, $new_line;
74 if $line =~ m{\[%(\s|-|~)*USE raw(\s|-|~)*%\]}; # Does [% Use raw %] exist?
77 if ( $line =~ qr{<a href="([^"]+)} ) {
78 my $to_uri_escape = $1;
82 (?
<pre_chomp
>(\s
|\
-|~)*)
84 (?
<post_chomp
>(\s
|\
-|~)*)
88 ( $new_line, $e ) = process_tt_block
($new_line, { %+, filter
=> 'uri' });
89 push @errors, { line
=> $line, line_number
=> $line_number, error
=> $e } if $e;
97 (?
<pre_chomp
>(\s
|\
-|~)*)
99 (?
<post_chomp
>(\s
|\
-|~)*)
103 ( $new_line, $e ) = process_tt_block
($new_line, \
%+);
104 push @errors, { line
=> $line, line_number
=> $line_number, error
=> $e } if $e;
107 push @new_lines, $new_line;
110 push @new_lines, $new_line;
115 # Adding [% USE raw %] on top if the filter is used
116 @new_lines = ( '[% USE raw %]', @new_lines )
117 if $use_raw and not $has_use_raw;
119 my $new_content = join "\n", @new_lines;
120 return { errors
=> \
@errors, new_content
=> $new_content };
123 sub process_tt_block
{
124 my ( $line, $params ) = @_;
125 my $tt_block = $params->{tt_block
};
126 my $pre_chomp = $params->{pre_chomp
};
127 my $post_chomp = $params->{post_chomp
};
128 my $filter = $params->{filter
} || 'html';
131 return ( $line, $error ) if
132 # It's a TT directive, no filters needed
133 grep { $tt_block =~ $_ } @tt_directives
136 or grep { $tt_block =~ $_ } @tt_methods
139 or $tt_block =~ m{^\#}
141 # Already escaped with a special filter
142 # We could escape it but should be safe
143 or $tt_block =~ m{\s?\|\s?\$KohaDates[^\|]*$}
144 or $tt_block =~ m{\s?\|\s?\$Price[^\|]*$}
145 or $tt_block =~ m{\s?\|\s?\$HtmlTags[^\|]*$}
147 # Already escaped correctly with raw
148 or $tt_block =~ m{\|\s?\$raw}
150 # Assignment, maybe we should require to use SET (?)
151 or ( $tt_block =~ m{=} and not $tt_block =~ m{\s\|\s} )
153 # Already has url or uri filter
154 or $tt_block =~ m{\|\s?ur(l|i)}
156 # Specific for [% foo UNLESS bar %]
157 or $tt_block =~ m{^(?<before>\S+)\s+UNLESS\s+(?<after>\S+)}
170 ?
$post_chomp =~ m
|-|
172 : $post_chomp =~ m
|~|
177 if ( $tt_block =~ m{\s?\|\s?\$KohaDates[^\|]*\|.*$}
178 or $tt_block =~ m{\s?\|\s?\$Price[^\|]*\|.*$}
179 or $tt_block =~ m{\s?\|\s?\$HtmlTags[^\|]*\|.*$}
182 s/\s*\|\s*(uri|url|html)\s*$//; # Could be another filter...
186 \Q
$tt_block\E\s
*\
|\s
*(uri
|url
|html
)
189 }{[%$pre_chomp$tt_block$post_chomp%]}xms
;
191 return ( $line, 'extra_filter_not_needed' );
195 # Use the uri filter is needed
196 # If html filtered or not filtered
200 or ($tt_block =~ m{\|\s?html} and not $tt_block =~ m{\|\s?html_entity})
201 or $tt_block !~ m{\s*|\s*(uri|url)}
204 $tt_block =~ s/^\s*|\s*$//g; # trim
205 $tt_block =~ s/\s*\|\s*html\s*//;
209 \Q
$tt_block\E
(\s
*\
|\s
*html
)?
212 }{[%$pre_chomp$tt_block | uri
$post_chomp%]}xms
;
214 $error = 'wrong_html_filter';
217 $tt_block !~ m{\|\s?html} # already has html filter
220 $tt_block =~ s/^\s*|\s*$//g; # trim
227 }{[%$pre_chomp$tt_block | html
$post_chomp%]}xms
;
229 $error = 'missing_filter';
231 return ( $line, $error );
238 t::lib::QA::TemplateFilters - Module used by tests and QA script to catch missing filters in template files
242 my $content = read_file($filename);
243 my $new_content = t::lib::QA::TemplateFilters::fix_filters($content);
244 my $errors = t::lib::QA::TemplateFilters::missing_filters($content);
248 The goal of this module is to make the subroutine reusable from the QA scripts
249 and to not duplicate the code.
255 Take a template content file in parameter and return the same content with
256 the correct (guessed) filters.
257 It will also add the [% USE raw %] statement if it is needed.
259 =head2 missing_filters
261 Take a template content file in parameter and return an arrayref of errors.
263 An error is a hashref with 3 keys, error and line, line_number.
265 asset_must_be_raw - When Asset is called without using raw
266 missing_filter - When a TT variable is displayed without filter
267 wrong_html_filter - When a TT variable is using the html filter when uri (or url)
268 should be used instead.
270 * line is the line where the error has been found.
271 * line_number is the line number where the error has been found.
276 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
280 Copyright 2017 - Koha Development Team
284 This file is part of Koha.
286 Koha is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
287 the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
289 Koha is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
291 You should have received a copy of the GNU General Public License along with Koha; if not, see <http://www.gnu.org/licenses>.