gitweb: Add optional "time to generate page" info in footer

[Gitweb] / gitweb.perl

diff --git a/gitweb.perl b/gitweb.perl
index 5b78db5709e4eda8d794ffcc937216a2745476167013545774c23a88ed785a31..08a28db04ee8912d40b855c67b320d9d2c4fa3ca0062ab18e5f74141e30859f4 100755 (executable)
--- a/gitweb.perl
+++ b/gitweb.perl
@@ -18,6 +18,12 @@ use File::Find qw();
 use File::Basename qw(basename);
 binmode STDOUT, ':utf8';
 
 use File::Basename qw(basename);
 binmode STDOUT, ':utf8';
 

+our $t0;
+if (eval { require Time::HiRes; 1; }) {
+       $t0 = [Time::HiRes::gettimeofday()];
+}
+our $number_of_git_cmds = 0;
+

 BEGIN {
        CGI->compile() if $ENV{'MOD_PERL'};
 }
 BEGIN {
        CGI->compile() if $ENV{'MOD_PERL'};
 }


@@ -161,7 +167,8 @@ our %known_snapshot_formats = (
        #       'suffix' => filename suffix,
        #       'format' => --format for git-archive,
        #       'compressor' => [compressor command and arguments]
        #       'suffix' => filename suffix,
        #       'format' => --format for git-archive,
        #       'compressor' => [compressor command and arguments]

-       #                       (array reference, optional)}
+       #                       (array reference, optional)
+       #       'disabled' => boolean (optional)}

        #
        'tgz' => {
                'display' => 'tar.gz',
        #
        'tgz' => {
                'display' => 'tar.gz',


@@ -177,6 +184,14 @@ our %known_snapshot_formats = (
                'format' => 'tar',
                'compressor' => ['bzip2']},
 
                'format' => 'tar',
                'compressor' => ['bzip2']},
 

+       'txz' => {
+               'display' => 'tar.xz',
+               'type' => 'application/x-xz',
+               'suffix' => '.tar.xz',
+               'format' => 'tar',
+               'compressor' => ['xz'],
+               'disabled' => 1},
+

        'zip' => {
                'display' => 'zip',
                'type' => 'application/x-zip',
        'zip' => {
                'display' => 'zip',
                'type' => 'application/x-zip',


@@ -189,6 +204,7 @@ our %known_snapshot_formats = (
 our %known_snapshot_format_aliases = (
        'gzip'  => 'tgz',
        'bzip2' => 'tbz2',
 our %known_snapshot_format_aliases = (
        'gzip'  => 'tgz',
        'bzip2' => 'tbz2',

+       'xz'    => 'txz',

 
        # backward compatibility: legacy gitweb config support
        'x-gzip' => undef, 'gz' => undef,
 
        # backward compatibility: legacy gitweb config support
        'x-gzip' => undef, 'gz' => undef,


@@ -395,6 +411,13 @@ our %feature = (
                'sub' => \&feature_avatar,
                'override' => 0,
                'default' => ['']},
                'sub' => \&feature_avatar,
                'override' => 0,
                'default' => ['']},

+
+       # Enable displaying how much time and how many git commands
+       # it took to generate and display page.  Disabled by default.
+       # Project specific override is not supported.
+       'timed' => {
+               'override' => 0,
+               'default' => [0]},

 );
 
 sub gitweb_get_feature {
 );
 
 sub gitweb_get_feature {


@@ -406,7 +429,7 @@ sub gitweb_get_feature {
                @{$feature{$name}{'default'}});
        if (!$override) { return @defaults; }
        if (!defined $sub) {
                @{$feature{$name}{'default'}});
        if (!$override) { return @defaults; }
        if (!defined $sub) {

-               warn "feature $name is not overrideable";
+               warn "feature $name is not overridable";

                return @defaults;
        }
        return $sub->(@defaults);
                return @defaults;
        }
        return $sub->(@defaults);


@@ -495,7 +518,8 @@ sub filter_snapshot_fmts {
                exists $known_snapshot_format_aliases{$_} ?
                       $known_snapshot_format_aliases{$_} : $_} @fmts;
        @fmts = grep {
                exists $known_snapshot_format_aliases{$_} ?
                       $known_snapshot_format_aliases{$_} : $_} @fmts;
        @fmts = grep {

-               exists $known_snapshot_formats{$_} } @fmts;
+               exists $known_snapshot_formats{$_} &&
+               !$known_snapshot_formats{$_}{'disabled'}} @fmts;

 }
 
 our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";
 }
 
 our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";


@@ -508,6 +532,7 @@ if (-e $GITWEB_CONFIG) {
 
 # version of the core git binary
 our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";
 
 # version of the core git binary
 our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";

+$number_of_git_cmds++;

 
 $projects_list ||= $projectroot;
 
 
 $projects_list ||= $projectroot;
 


@@ -941,10 +966,13 @@ sub href {
                        if (defined $params{'hash_parent_base'}) {
                                $href .= esc_url($params{'hash_parent_base'});
                                # skip the file_parent if it's the same as the file_name
                        if (defined $params{'hash_parent_base'}) {
                                $href .= esc_url($params{'hash_parent_base'});
                                # skip the file_parent if it's the same as the file_name

-                               delete $params{'file_parent'} if $params{'file_parent'} eq $params{'file_name'};
-                               if (defined $params{'file_parent'} && $params{'file_parent'} !~ /\.\./) {
-                                       $href .= ":/".esc_url($params{'file_parent'});
-                                       delete $params{'file_parent'};
+                               if (defined $params{'file_parent'}) {
+                                       if (defined $params{'file_name'} && $params{'file_parent'} eq $params{'file_name'}) {
+                                               delete $params{'file_parent'};
+                                       } elsif ($params{'file_parent'} !~ /\.\./) {
+                                               $href .= ":/".esc_url($params{'file_parent'});
+                                               delete $params{'file_parent'};
+                                       }

                                }
                                $href .= "..";
                                delete $params{'hash_parent'};
                                }
                                $href .= "..";
                                delete $params{'hash_parent'};


@@ -1511,10 +1539,10 @@ sub format_subject_html {
                $long =~ s/[[:cntrl:]]/?/g;
                return $cgi->a({-href => $href, -class => "list subject",
                                -title => to_utf8($long)},
                $long =~ s/[[:cntrl:]]/?/g;
                return $cgi->a({-href => $href, -class => "list subject",
                                -title => to_utf8($long)},

-                      esc_html($short) . $extra);
+                      esc_html($short)) . $extra;

        } else {
                return $cgi->a({-href => $href, -class => "list subject"},
        } else {
                return $cgi->a({-href => $href, -class => "list subject"},

-                      esc_html($long)  . $extra);
+                      esc_html($long)) . $extra;

        }
 }
 
        }
 }
 


@@ -1956,6 +1984,7 @@ sub get_feed_info {
 
 # returns path to the core git executable and the --git-dir parameter as list
 sub git_cmd {
 
 # returns path to the core git executable and the --git-dir parameter as list
 sub git_cmd {

+       $number_of_git_cmds++;

        return $GIT, '--git-dir='.$git_dir;
 }
 
        return $GIT, '--git-dir='.$git_dir;
 }
 


@@ -2571,7 +2600,7 @@ sub parse_commit_text {
                } elsif ((!defined $withparents) && ($line =~ m/^parent ([0-9a-fA-F]{40})$/)) {
                        push @parents, $1;
                } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {
                } elsif ((!defined $withparents) && ($line =~ m/^parent ([0-9a-fA-F]{40})$/)) {
                        push @parents, $1;
                } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {

-                       $co{'author'} = $1;
+                       $co{'author'} = to_utf8($1);

                        $co{'author_epoch'} = $2;
                        $co{'author_tz'} = $3;
                        if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {
                        $co{'author_epoch'} = $2;
                        $co{'author_tz'} = $3;
                        if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {


@@ -2581,10 +2610,9 @@ sub parse_commit_text {
                                $co{'author_name'} = $co{'author'};
                        }
                } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {
                                $co{'author_name'} = $co{'author'};
                        }
                } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {

-                       $co{'committer'} = $1;
+                       $co{'committer'} = to_utf8($1);

                        $co{'committer_epoch'} = $2;
                        $co{'committer_tz'} = $3;
                        $co{'committer_epoch'} = $2;
                        $co{'committer_tz'} = $3;

-                       $co{'committer_name'} = $co{'committer'};

                        if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
                                $co{'committer_name'}  = $1;
                                $co{'committer_email'} = $2;
                        if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
                                $co{'committer_name'}  = $1;
                                $co{'committer_email'} = $2;


@@ -3206,6 +3234,20 @@ sub git_footer_html {
        }
        print "</div>\n"; # class="page_footer"
 
        }
        print "</div>\n"; # class="page_footer"
 

+       if (defined $t0 && gitweb_check_feature('timed')) {
+               print "<div id=\"generating_info\">\n";
+               print 'This page took '.
+                     '<span id="generating_time" class="time_span">'.
+                     Time::HiRes::tv_interval($t0, [Time::HiRes::gettimeofday()]).
+                     ' seconds </span>'.
+                     ' and '.
+                     '<span id="generating_cmd">'.
+                     $number_of_git_cmds.
+                     '</span> git commands '.
+                     " to generate.\n";
+               print "</div>\n"; # class="page_footer"
+       }
+

        if (-f $site_footer) {
                insert_file($site_footer);
        }
        if (-f $site_footer) {
                insert_file($site_footer);
        }


@@ -5178,6 +5220,8 @@ sub git_snapshot {
                die_error(400, "Invalid snapshot format parameter");
        } elsif (!exists($known_snapshot_formats{$format})) {
                die_error(400, "Unknown snapshot format");
                die_error(400, "Invalid snapshot format parameter");
        } elsif (!exists($known_snapshot_formats{$format})) {
                die_error(400, "Unknown snapshot format");

+       } elsif ($known_snapshot_formats{$format}{'disabled'}) {
+               die_error(403, "Snapshot format not allowed");

        } elsif (!grep($_ eq $format, @snapshot_fmts)) {
                die_error(403, "Unsupported snapshot format");
        }
        } elsif (!grep($_ eq $format, @snapshot_fmts)) {
                die_error(403, "Unsupported snapshot format");
        }