Re: [PATCH (bugfix)] gitweb: Add and use prep_attr helper
- From
Jakub Narebski <jnareb@gmail.com>
- Date
- Sep 15, 2010, 21:16 UTC
- Message-ID
- <201009152316.36225.jnareb@gmail.com>
- In-Reply-To
- <AANLkTi=o2PFB=JkO5wYHCLAHCO=Ebe63mAc6WB8GfktH@mail.gmail.com>
On Wed, 15 Sep 2010, Ævar Arnfjörð Bjarmason wrote:
Show 16 quoted lines
> 2010/9/15 Jakub Narebski <jnareb@gmail.com>: > > One of features of CGI.pm module is HTML generation. The HTML > > generation subroutines / methods automatically escape values of > > attributes of HTML elements... but in older versions didn't do it > > fully, not removing / replacing control characters. Control > > characters are forbidden in XML / XHTML, and some browsers > > (e.g. Firefox) do not skip over them but display error instead of page > > in strict XHTML mode (XHTML DTD + application/xml+html mimetype). > > > > This issue was noticed by Uwe Kleine-König and resolved to be a > > problem with control characters in XHTML output by Ævar Arnfjörð > > Bjarmason in format_search_author() subroutine. > > FWIW this looks good to me, but perhaps instead of using "?" for > everything in ASCII from \0 to " " it would be better to display the > human-readable escape sequence, like "\r" or "\b".
Well, the advantage of this version is that it can be changed in single place, i.e. in prep_attr(), see updated patch below.
Show 5 quoted lines
> Gitweb already does this (although I don't have a link handy) if you > check in a file with Windows newlines, it'll display "\r" in a little > box. > > Maybe that should be done everywhere? I don't know.
Note that we have three different situations: 1. Output is HTML fragment (esc_html, esc_path) 2. Output is attribute of HTML element, i.e. text (prep_attr) 3. Output is HTTP header (in snapshot_name) for proposed filename
But having the same result for 1 and 2 might be good idea.
-- >8 -- Subject: [PATCH] gitweb: Add and use prep_attr helper
One of features of CGI.pm module is HTML generation. The HTML generation subroutines / methods automatically escape values of attributes of HTML elements... but in older versions didn't do it fully, not removing / replacing control characters. Control characters are forbidden in XML / XHTML, and some browsers (e.g. Firefox) do not skip over them but display error instead of page in strict XHTML mode (XHTML DTD + application/xml+html mimetype).
This issue was noticed by Uwe Kleine-König and resolved to be a problem with control characters in XHTML output by Ævar Arnfjörð Bjarmason in format_search_author() subroutine.
Introduce prep_attr subroutine to deal with this problem, and use it in all places where we use data from outside gitweb in attributes of HTML elements, where those HTML elements are generated by CGI.pm subroutines / methods (this usually means 'title' attribute).
While at it simplify format_search_author() a bit, and use spaces for align.
Signed-off-by: Jakub Narebski <jnareb@gmail.com> --- Intediff (indented)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index da20209..92a634a 100755
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -1357,7 +1357,7 @@ sub prep_attr {
my ($attr_name, $value) = @_ > 1 ? @_ : (undef, @_);
$value = to_utf8($value);
- $value =~ s/[[:cntrl:]]/?/g;
+ $value =~ s/([[:cntrl:]])/quot_cec($1, '-nohtml' => 1)/eg;
return defined $attr_name ? ($attr_name => $value) : $value;
}gitweb/gitweb.perl | 62 +++++++++++++++++++++++++++++++--------------------- 1 files changed, 37 insertions(+), 25 deletions(-)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl index a85e2f6..92a634a 100755 --- a/gitweb/gitweb.perl +++ b/gitweb/gitweb.perl @@ -1346,6 +1346,22 @@ sub esc_param { return $str; } +# prepare 'attribute => value' pair for CGI.pm HTML generation, +# by escaping/quoting/replacing/removing values which are invalid in (X)HTML, +# and which older versions of CGI.pm do not quote correctly +# +# USAGE: +# $cgi->a({-href => ..., prep_attr(-title => $title)}, esc_html($contents)); +# $cgi->a({-href => ..., -title => prep_attr($title)}, esc_html($contents)); +sub prep_attr { + my ($attr_name, $value) = @_ > 1 ? @_ : (undef, @_); + + $value = to_utf8($value); + $value =~ s/([[:cntrl:]])/quot_cec($1, '-nohtml' => 1)/eg; + + return defined $attr_name ? ($attr_name => $value) : $value; +} + # quote unsafe chars in whole URL, so some characters cannot be quoted sub esc_url { my $str = shift; @@ -1555,8 +1571,7 @@ sub chop_and_escape_str { if ($chopped eq $str) { return esc_html($chopped); } else { - $str =~ s/[[:cntrl:]]/?/g; - return $cgi->span({-title=>$str}, esc_html($chopped)); + return $cgi->span({prep_attr(-title=>$str)}, esc_html($chopped)); } } @@ -1778,9 +1793,8 @@ sub format_subject_html { $extra = '' unless defined($extra); if (length($short) < length($long)) { - $long =~ s/[[:cntrl:]]/?/g; return $cgi->a({-href => $href, -class => "list subject", - -title => to_utf8($long)}, + prep_attr(-title => $long)}, esc_html($short)) . $extra; } else { return $cgi->a({-href => $href, -class => "list subject"}, @@ -1856,23 +1870,20 @@ sub format_search_author { my ($author, $searchtype, $displaytext) = @_; my $have_search = gitweb_check_feature('search'); - if ($have_search) { - my $performed = ""; - if ($searchtype eq 'author') { - $performed = "authored"; - } elsif ($searchtype eq 'committer') { - $performed = "committed"; - } - - return $cgi->a({-href => href(action=>"search", hash=>$hash, - searchtext=>$author, - searchtype=>$searchtype), class=>"list", - title=>"Search for commits $performed by $author"}, - $displaytext); + return $displaytext unless ($have_search); - } else { - return $displaytext; + my $performed = ""; + if ($searchtype eq 'author') { + $performed = "authored"; + } elsif ($searchtype eq 'committer') { + $performed = "committed"; } + + my $title = "Search for commits $performed by $author"; + return $cgi->a({-href => href(action=>"search", hash=>$hash, + searchtext=>$author, searchtype=>$searchtype), + -class=>"list", prep_attr(-title=>$title)}, + $displaytext); } # format the author name of the given commit with the given tag @@ -3559,7 +3570,7 @@ sub git_footer_html { foreach my $format qw(RSS Atom) { $href_params{'action'} = lc($format); print $cgi->a({-href => href(%href_params), - -title => "$href_params{'-title'} $format feed", + prep_attr(-title => "$href_params{'-title'} $format feed"), -class => $feed_class}, $format)."\n"; } @@ -3827,17 +3838,17 @@ sub git_print_page_path { $fullname .= ($fullname ? '/' : '') . $dir; print $cgi->a({-href => href(action=>"tree", file_name=>$fullname, hash_base=>$hb), - -title => $fullname}, esc_path($dir)); + prep_attr(-title => $fullname)}, esc_path($dir)); print " / "; } if (defined $type && $type eq 'blob') { print $cgi->a({-href => href(action=>"blob_plain", file_name=>$file_name, hash_base=>$hb), - -title => $name}, esc_path($basename)); + prep_attr(-title => $name)}, esc_path($basename)); } elsif (defined $type && $type eq 'tree') { print $cgi->a({-href => href(action=>"tree", file_name=>$file_name, hash_base=>$hb), - -title => $name}, esc_path($basename)); + prep_attr(-title => $name)}, esc_path($basename)); print " / "; } else { print esc_path($basename); @@ -3981,7 +3992,8 @@ sub git_print_tree_entry { print " -> " . $cgi->a({-href => href(action=>"object", hash_base=>$hash_base, file_name=>$norm_target), - -title => $norm_target}, esc_path($link_target)); + prep_attr(-title => $norm_target)}, + esc_path($link_target)); } else { print " -> " . esc_path($link_target); } @@ -4687,7 +4699,7 @@ sub git_project_list_body { print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"), -class => "list"}, esc_html($pr->{'path'})) . "</td>\n" . "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"), - -class => "list", -title => $pr->{'descr_long'}}, + -class => "list", prep_attr(-title => $pr->{'descr_long'})}, esc_html($pr->{'descr'})) . "</td>\n" . "<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n"; print "<td class=\"". age_class($pr->{'age'}) . "\">" .
-- 1.7.2.1