Skip to content

Commit

Permalink
gitweb: fix UTF-8 encoding when using CGI::Fast
Browse files Browse the repository at this point in the history
FCGI streams are implemented using the older stream API: TIEHANDLE,
therefore applying PerlIO layers using binmode() has no effect to them.
The solution in this patch is to redefine the FCGI::Stream::PRINT function
to use UTF-8 as output encoding, except within git_blob_plain() and git_snapshot()
which must still output in raw binary mode.

This problem and solution were previously reported back in 2012:
- http://git.661346.n2.nabble.com/Gitweb-running-as-FCGI-does-not-print-its-output-in-UTF-8-td7573415.html
- http://stackoverflow.com/questions/5005104

Signed-off-by: Julien Moutinho <julm+git@sourcephile.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Julien Moutinho authored and gitster committed Mar 29, 2020
1 parent 0822e66 commit 2ecfcde
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions gitweb/gitweb.perl
Original file line number Diff line number Diff line change
Expand Up @@ -1291,9 +1291,23 @@ sub run_request {
our ($pre_dispatch_hook, $post_dispatch_hook, $pre_listen_hook);
our $CGI = 'CGI';
our $cgi;
our $FCGI_Stream_PRINT_raw = \&FCGI::Stream::PRINT;
sub configure_as_fcgi {
require CGI::Fast;
our $CGI = 'CGI::Fast';
# FCGI is not Unicode aware hence the UTF-8 encoding must be done manually.
# However no encoding must be done within git_blob_plain() and git_snapshot()
# which must still output in raw binary mode.
no warnings 'redefine';
my $enc = Encode::find_encoding('UTF-8');
*FCGI::Stream::PRINT = sub {
my @OUTPUT = @_;
for (my $i = 1; $i < @_; $i++) {
$OUTPUT[$i] = $enc->encode($_[$i], Encode::FB_CROAK|Encode::LEAVE_SRC);
}
@_ = @OUTPUT;
goto $FCGI_Stream_PRINT_raw;
};

my $request_number = 0;
# let each child service 100 requests
Expand Down Expand Up @@ -7079,6 +7093,7 @@ sub git_blob_plain {
($sandbox ? 'attachment' : 'inline')
. '; filename="' . $save_as . '"');
local $/ = undef;
local *FCGI::Stream::PRINT = $FCGI_Stream_PRINT_raw;
binmode STDOUT, ':raw';
print <$fd>;
binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
Expand Down Expand Up @@ -7417,6 +7432,7 @@ sub git_snapshot {

open my $fd, "-|", $cmd
or die_error(500, "Execute git-archive failed");
local *FCGI::Stream::PRINT = $FCGI_Stream_PRINT_raw;
binmode STDOUT, ':raw';
print <$fd>;
binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
Expand Down

0 comments on commit 2ecfcde

Please sign in to comment.