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

Add "This page took XXX seconds and Y git commands to generate"
to page footer, if global feature 'timed' is enabled (disabled
by default).  Requires Time::HiRes installed for high precision
'wallclock' time.

Note that Time::HiRes is being required unconditionally; this is
because setting $t0 variable needs to be done fairly early to have
running time of the whole script.  If Time::HiRes module were required
only if 'timed' feature is enabled, the earliest place where starting
time ($t0) could be calculated would be after reading gitweb config,
making "time to generate page" info inaccurate.

This code is based on example code by Petr 'Pasky' Baudis.

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/gitweb/gitweb.css b/gitweb/gitweb.css
index 8f68fe30914b2cf4f5337a303202b39eec3cdbd7..9893443edcd5b22c1659563852948e79f97d908b 100644 (file)
--- a/gitweb/gitweb.css
+++ b/gitweb/gitweb.css
@@ -75,6 +75,13 @@ div.page_footer_text {
        font-style: italic;
 }
 
        font-style: italic;
 }
 

+div#generating_info {
+       margin: 4px;
+       font-size: smaller;
+       text-align: center;
+       color: #505050;
+}
+

 div.page_body {
        padding: 8px;
        font-family: monospace;
 div.page_body {
        padding: 8px;
        font-family: monospace;

diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index 2cb60bedc65be8cdf43b9c0691a8a81e0a8f8cb4..18cbf35391d8cedc0b6c8303b350eb14878fd4ed 100755 (executable)
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -18,6 +18,12 @@
 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'};
 }


@@ -394,6 +400,13 @@ BEGIN
                '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 {


@@ -507,6 +520,7 @@ sub filter_snapshot_fmts {
 
 # 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;
 


@@ -1955,6 +1969,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;
 }
 


@@ -3205,6 +3220,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);
        }