# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
-use Test::More tests => 1;
+use Test::More tests => 6;
use t::lib::QA::TemplateFilters;
-my $input = <<INPUT;
-[% USE Asset %]
-[% INCLUDE 'doc-head-open.inc' %]
+subtest 'Asset must use raw' => sub {
+ plan tests => 2;
+ my $input = <<INPUT;
+[% Asset.css("css/one.css") %]
+[% Asset.css("js/two.js") %]
+INPUT
+ my $expected = <<EXPECTED;
+[% USE raw %]
+[% Asset.css("css/one.css") | \$raw %]
+[% Asset.css("js/two.js") | \$raw %]
+EXPECTED
+
+ my $new_content = t::lib::QA::TemplateFilters::fix_filters($input);
+ is( $new_content . "\n", $expected, );
+ my @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply(
+ \@missing_filters,
+ [
+ {
+ error => "asset_must_be_raw",
+ line => '[% Asset.css("css/one.css") %]',
+ line_number => 1,
+ },
+ {
+ error => "asset_must_be_raw",
+ line => '[% Asset.css("js/two.js") %]',
+ line_number => 2,
+ }
+
+ ],
+ );
+};
+
+subtest 'Variables must be html escaped' => sub {
+ plan tests => 2;
+
+ my $input = <<INPUT;
<title>Koha › Patrons ›
[% UNLESS blocking_error %]
- Patron details for [% INCLUDE 'patron-title.inc' no_html = 1 %]
+ [% just_a_var %]
[% just_a_var %] A N D [% another_one_on_same_line %]
- [% just_a_var_filtered|html %]
- [% just_a_var_filtered |html %]
- [% just_a_var_filtered| html %]
- [% just_a_var_filtered | html %]
[% END %]
- [% IF ( patron.othernames | html ) %]“[% patron.othernames %]”[% END %]
- [% Asset.css("css/datatables.css").raw %]
- [% Asset.css("css/datatables.css") | \$raw %]
+ [% IF ( patron.othernames ) %]“[% patron.othernames %]”[% END %]
</title>
-<a href="tel:[% patron.phone %]">[% patron.phone %]</a>
-<a title="[% patron.emailpro %]" href="mailto:[% patron.emailpro | uri %]">[% patron.emailpro %]</a>
[% patron_message.get_column('manager_surname') %]
+INPUT
+
+ my $expected = <<EXPECTED;
+<title>Koha › Patrons ›
+ [% UNLESS blocking_error %]
+ [% just_a_var | html %]
+ [% just_a_var | html %] A N D [% another_one_on_same_line | html %]
+ [% END %]
+ [% IF ( patron.othernames ) %]“[% patron.othernames | html %]”[% END %]
+</title>
+[% patron_message.get_column('manager_surname') | html %]
+EXPECTED
+
+ my $new_content = t::lib::QA::TemplateFilters::fix_filters($input);
+ is( $new_content . "\n", $expected, );
+ my @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply(
+ \@missing_filters,
+ [{
+ error => "missing_filter",
+ line => " [% just_a_var %]",
+ line_number => 3,
+ },
+ {
+ error => "missing_filter",
+ line => " [% just_a_var %] A N D [% another_one_on_same_line %]",
+ line_number => 4,
+ },
+ {
+ error => "missing_filter",
+ line => " [% just_a_var %] A N D [% another_one_on_same_line %]",
+ line_number => 4,
+ },
+ {
+ error => "missing_filter",
+ line => " [% IF ( patron.othernames ) %]“[% patron.othernames %]”[% END %]",
+ line_number => 6,
+ },
+ {
+ error => "missing_filter",
+ line => "[% patron_message.get_column('manager_surname') %]",
+ line_number => 8
+ }
+ ],
+
+ );
+};
+
+subtest 'TT directives, assignments and already filtered variables must not be escaped' => sub {
+ plan tests => 2;
+ my $input = <<INPUT;
+#[% USE Asset %]
+[% INCLUDE 'doc-head-open.inc' %]
[%# do_nothing %]
[% # do_nothing %]
[% SWITCH var %]
[%- CASE 'foo' -%]foo
[%- CASE -%]
[%- END -%]
-[%- var -%]
-[% - var - %]
-[%~ var ~%]
-[% ~ var ~ %]
-[% var | \$raw %]
[% foo UNLESS bar %]
[% SET var = val %]
[% var = val %]
[% var | \$Price %]
+[% just_a_var_filtered|html %]
+[% just_a_var_filtered |html %]
+[% just_a_var_filtered| html %]
+[% just_a_var_filtered | html %]
[%END%]
INPUT
+ my $expected = <<EXPECTED;
+#[% USE Asset %]
+[% INCLUDE 'doc-head-open.inc' %]
+[%# do_nothing %]
+[% # do_nothing %]
+[% SWITCH var %]
+[% CASE 'foo' %]foo
+[% CASE %]
+[% END %]
+[%- SWITCH var -%]
+[%- CASE 'foo' -%]foo
+[%- CASE -%]
+[%- END -%]
+[% foo UNLESS bar %]
+[% SET var = val %]
+[% var = val %]
+[% var | \$Price %]
+[% just_a_var_filtered|html %]
+[% just_a_var_filtered |html %]
+[% just_a_var_filtered| html %]
+[% just_a_var_filtered | html %]
+[%END%]
+EXPECTED
+
+ my $new_content = t::lib::QA::TemplateFilters::fix_filters($input);
+ is( $new_content . "\n", $expected, );
+ my @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply(
+ \@missing_filters,[],);
+};
+
+subtest 'Preserve pre/post chomps' => sub {
+ plan tests => 1;
+ my $input = <<INPUT;
+[%- USE raw -%]
+[%- var -%]
+[% - var - %]
+[%~ var ~%]
+[% ~ var ~ %]
+[%- var | html -%]
+[%~ var | html ~%]
+[%- var | uri -%]
+[%~ var | uri ~%]
+INPUT
+ my $expected = <<EXPECTED;
+[%- USE raw -%]
+[%- var | html -%]
+[%- var | html -%]
+[%~ var | html ~%]
+[%~ var | html ~%]
+[%- var | html -%]
+[%~ var | html ~%]
+[%- var | uri -%]
+[%~ var | uri ~%]
+EXPECTED
+
+ my $new_content = t::lib::QA::TemplateFilters::fix_filters($input);
+ is( $new_content . "\n", $expected, );
+};
+
+subtest 'Use uri filter if needed' => sub {
+ plan tests => 4;
+ my $input = <<INPUT;
+<a href="tel:[% patron.phone %]">[% patron.phone %]</a>
+<a href="mailto:[% patron.emailpro %]" title="[% patron.emailpro %]">[% patron.emailpro %]</a>
+<a href="mailto:[% patron.emailpro | html %]" title="[% patron.emailpro %]">[% patron.emailpro %]</a>
+<a href="mailto:[% patron.emailpro | uri %]" title="[% patron.emailpro %]">[% patron.emailpro %]</a>
+<a href="[% myuri %]" title="[% myuri %]">[% myuri %]</a>
+<a href="[% myuri | uri %]" title="[% myuri %]">[% myuri %]</a>
+<a href="[% myurl | html %]" title="[% myurl %]">[% myurl %]</a>
+<a href="[% myurl | url %]" title="[% myurl %]">[% myurl %]</a>
+<a href="[% myurl | html_entity %]" title="[% myurl %]">[% myurl %]</a>
+<a href="/cgi-bin/koha/acqui/newordersuggestion.pl?booksellerid=[% booksellerid %]&basketno=[% basketno %]">[% another_var %]</a>
+<a href="/cgi-bin/koha/acqui/newordersuggestion.pl?booksellerid=[% booksellerid %]&basketno=[% basketno | html %]" title="[% a_title %]>[% another_var %]</a>
+INPUT
+
+ # Note: [% myurl %] will be uri escaped, we cannot know url should be used
+ my $expected = <<EXPECTED;
+<a href="tel:[% patron.phone | uri %]">[% patron.phone | html %]</a>
+<a href="mailto:[% patron.emailpro | uri %]" title="[% patron.emailpro | html %]">[% patron.emailpro | html %]</a>
+<a href="mailto:[% patron.emailpro | uri %]" title="[% patron.emailpro | html %]">[% patron.emailpro | html %]</a>
+<a href="mailto:[% patron.emailpro | uri %]" title="[% patron.emailpro | html %]">[% patron.emailpro | html %]</a>
+<a href="[% myuri | uri %]" title="[% myuri | html %]">[% myuri | html %]</a>
+<a href="[% myuri | uri %]" title="[% myuri | html %]">[% myuri | html %]</a>
+<a href="[% myurl | uri %]" title="[% myurl | html %]">[% myurl | html %]</a>
+<a href="[% myurl | url %]" title="[% myurl | html %]">[% myurl | html %]</a>
+<a href="[% myurl | html_entity %]" title="[% myurl | html %]">[% myurl | html %]</a>
+<a href="/cgi-bin/koha/acqui/newordersuggestion.pl?booksellerid=[% booksellerid | uri %]&basketno=[% basketno | uri %]">[% another_var | html %]</a>
+<a href="/cgi-bin/koha/acqui/newordersuggestion.pl?booksellerid=[% booksellerid | uri %]&basketno=[% basketno | uri %]" title="[% a_title | html %]>[% another_var | html %]</a>
+EXPECTED
+
+ my $new_content = t::lib::QA::TemplateFilters::fix_filters($input);
+ is( $new_content . "\n", $expected, );
+
+ $input = <<INPUT;
+<a href="[% wrong_filter | html %]">[% var | html %]</a>
+INPUT
+ my @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply(
+ \@missing_filters,
+ [
+ {
+ error => "wrong_html_filter",
+ line =>
+ '<a href="[% wrong_filter | html %]">[% var | html %]</a>',
+ line_number => 1
+ }
+
+ ],
+ );
+
+ $input = <<INPUT;
+<a href="[% good_raw_filter | \$raw %]">[% var | html %]</a>
+INPUT
+ @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply( \@missing_filters, [], );
+
+ $input = <<INPUT;
+<a href="[% good_filter | html_entity %]">[% var | html %]</a>
+INPUT
+ @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply( \@missing_filters, [], 'html_entity is a valid filter for href' );
+};
+
+subtest 'Do not escape KohaDates|Prices|HtmlTags output' => sub {
+ plan tests => 2;
+ my $input = <<INPUT;
+[% var | \$KohaDates %]
+[% var | \$KohaDates with_hours => 1 %]
+[% var | \$KohaDates | html %]
+[% var | \$KohaDates with_hours => 1 | html %]
+[% var | \$Price %]
+[% var | \$HtmlTags %]
+INPUT
+
+ my $expected = <<EXPECTED;
+[% var | \$KohaDates %]
+[% var | \$KohaDates with_hours => 1 %]
+[% var | \$KohaDates %]
+[% var | \$KohaDates with_hours => 1 %]
+[% var | \$Price %]
+[% var | \$HtmlTags %]
+EXPECTED
+
+ my $new_content = t::lib::QA::TemplateFilters::fix_filters($input);
+ is( $new_content . "\n", $expected, );
+
+
+ my @missing_filters = t::lib::QA::TemplateFilters::missing_filters($input);
+ is_deeply(
+ \@missing_filters,
+ [
+ {
+ error => "extra_filter_not_needed",
+ line => "[% var | \$KohaDates | html %]",
+ line_number => 3,
+ },
+ {
+ error => "extra_filter_not_needed",
+ line => "[% var | \$KohaDates with_hours => 1 | html %]",
+ line_number => 4,
+ }
+ ]
+ );
-my @expected_errors = (
- {
- error => q{missing_filter},
- line =>
-q{ [% just_a_var %] A N D [% another_one_on_same_line %]},
- line_number => 6,
- },
- {
- error => q{missing_filter},
- line =>
-q{ [% just_a_var %] A N D [% another_one_on_same_line %]},
- line_number => 6,
- },
- {
- error => q{missing_filter},
- line =>
-q{ [% IF ( patron.othernames | html ) %]“[% patron.othernames %]”[% END %]},
- line_number => 12,
- },
- {
- error => q{asset_must_be_raw},
- line => q{ [% Asset.css("css/datatables.css").raw %]},
- line_number => 13,
- },
- {
- error => q{missing_filter},
- line => q{<a href="tel:[% patron.phone %]">[% patron.phone %]</a>},
- line_number => 16,
- },
- {
- error => q{missing_filter},
- line => q{<a href="tel:[% patron.phone %]">[% patron.phone %]</a>},
- line_number => 16,
- },
- {
- error => q{missing_filter},
- line =>
-q{<a title="[% patron.emailpro %]" href="mailto:[% patron.emailpro | uri %]">[% patron.emailpro %]</a>},
- line_number => 17,
- },
- {
- error => q{missing_filter},
- line =>
-q{<a title="[% patron.emailpro %]" href="mailto:[% patron.emailpro | uri %]">[% patron.emailpro %]</a>},
- line_number => 17,
- },
- {
- error => q{missing_filter},
- line => q{[% patron_message.get_column('manager_surname') %]},
- line_number => 18,
- },
- {
- error => q{missing_filter},
- line => q{[%- var -%]},
- line_number => 29,
- },
- {
- error => q{missing_filter},
- line => q{[% - var - %]},
- line_number => 30,
- },
- {
- error => q{missing_filter},
- line => q{[%~ var ~%]},
- line_number => 31,
- },
- {
- error => q{missing_filter},
- line => q{[% ~ var ~ %]},
- line_number => 32,
- }
-);
-
-my @get = t::lib::QA::TemplateFilters::missing_filters($input);
-is_deeply( \@get, \@expected_errors);
+};
projects / koha.git / blobdiff