gitweb: nagivation menu for tags, heads and remotes

[Gitweb] / gitweb.perl

diff --git a/gitweb.perl b/gitweb.perl
index b6f6236635f8ec54e4668969c0733860eb5a72dd3fb1095585114639c20c51e6..241b8f1bd266ed6c06fde890b98a02b0714849afaa3a707d781ab4dcc6ee1a07 100755 (executable)
--- a/gitweb.perl
+++ b/gitweb.perl
@@ -7,6 +7,7 @@
 #
 # This program is licensed under the GPLv2
 
 #
 # This program is licensed under the GPLv2
 

+use 5.008;

 use strict;
 use warnings;
 use CGI qw(:standard :escapeHTML -nosticky);
 use strict;
 use warnings;
 use CGI qw(:standard :escapeHTML -nosticky);


@@ -16,12 +17,10 @@ use Encode;
 use Fcntl ':mode';
 use File::Find qw();
 use File::Basename qw(basename);
 use Fcntl ':mode';
 use File::Find qw();
 use File::Basename qw(basename);

+use Time::HiRes qw(gettimeofday tv_interval);

 binmode STDOUT, ':utf8';
 
 binmode STDOUT, ':utf8';
 

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

 our $number_of_git_cmds = 0;
 
 BEGIN {
 our $number_of_git_cmds = 0;
 
 BEGIN {


@@ -166,6 +165,12 @@ our @diff_opts = ('-M'); # taken from git_commit
 # the gitweb domain.
 our $prevent_xss = 0;
 
 # the gitweb domain.
 our $prevent_xss = 0;
 

+# Path to the highlight executable to use (must be the one from
+# http://www.andre-simon.de due to assumptions about parameters and output).
+# Useful if highlight is not installed on your webserver's PATH.
+# [Default: highlight]
+our $highlight_bin = "++HIGHLIGHT_BIN++";
+

 # information about snapshot formats that gitweb is capable of serving
 our %known_snapshot_formats = (
        # name => {
 # information about snapshot formats that gitweb is capable of serving
 our %known_snapshot_formats = (
        # name => {


@@ -487,6 +492,18 @@ our %feature = (
                'sub' => sub { feature_bool('highlight', @_) },
                'override' => 0,
                'default' => [0]},
                'sub' => sub { feature_bool('highlight', @_) },
                'override' => 0,
                'default' => [0]},

+
+       # Enable displaying of remote heads in the heads list
+
+       # To enable system wide have in $GITWEB_CONFIG
+       # $feature{'remote_heads'}{'default'} = [1];
+       # To have project specific config enable override in $GITWEB_CONFIG
+       # $feature{'remote_heads'}{'override'} = 1;
+       # and in project config gitweb.remote_heads = 0|1;
+       'remote_heads' => {
+               'sub' => sub { feature_bool('remote_heads', @_) },
+               'override' => 0,
+               'default' => [0]},

 );
 
 sub gitweb_get_feature {
 );
 
 sub gitweb_get_feature {


@@ -701,6 +718,7 @@ our %actions = (
        "log" => \&git_log,
        "patch" => \&git_patch,
        "patches" => \&git_patches,
        "log" => \&git_log,
        "patch" => \&git_patch,
        "patches" => \&git_patches,

+       "remotes" => \&git_remotes,

        "rss" => \&git_rss,
        "atom" => \&git_atom,
        "search" => \&git_search,
        "rss" => \&git_rss,
        "atom" => \&git_atom,
        "search" => \&git_search,


@@ -775,10 +793,10 @@ sub evaluate_path_info {
                'history',
        );
 
                'history',
        );
 

-       # we want to catch
+       # we want to catch, among others

        # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
        my ($parentrefname, $parentpathname, $refname, $pathname) =
        # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
        my ($parentrefname, $parentpathname, $refname, $pathname) =

-               ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?(.+?)(?::(.+))?$/);
+               ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);

 
        # first, analyze the 'current' part
        if (defined $pathname) {
 
        # first, analyze the 'current' part
        if (defined $pathname) {


@@ -814,8 +832,15 @@ sub evaluate_path_info {
                # hash_base instead. It should also be noted that hand-crafted
                # links having 'history' as an action and no pathname or hash
                # set will fail, but that happens regardless of PATH_INFO.
                # hash_base instead. It should also be noted that hand-crafted
                # links having 'history' as an action and no pathname or hash
                # set will fail, but that happens regardless of PATH_INFO.

-               $input_params{'action'} ||= "shortlog";
-               if (grep { $_ eq $input_params{'action'} } @wants_base) {
+               if (defined $parentrefname) {
+                       # if there is parent let the default be 'shortlog' action
+                       # (for http://git.example.com/repo.git/A..B links); if there
+                       # is no parent, dispatch will detect type of object and set
+                       # action appropriately if required (if action is not set)
+                       $input_params{'action'} ||= "shortlog";
+               }
+               if ($input_params{'action'} &&
+                   grep { $_ eq $input_params{'action'} } @wants_base) {

                        $input_params{'hash_base'} ||= $refname;
                } else {
                        $input_params{'hash'} ||= $refname;
                        $input_params{'hash_base'} ||= $refname;
                } else {
                        $input_params{'hash'} ||= $refname;


@@ -1052,7 +1077,7 @@ sub dispatch {
 }
 
 sub reset_timer {
 }
 
 sub reset_timer {

-       our $t0 = [Time::HiRes::gettimeofday()]
+       our $t0 = [ gettimeofday() ]

                if defined $t0;
        our $number_of_git_cmds = 0;
 }
                if defined $t0;
        our $number_of_git_cmds = 0;
 }


@@ -1062,6 +1087,7 @@ sub run_request {
 
        evaluate_uri();
        evaluate_gitweb_config();
 
        evaluate_uri();
        evaluate_gitweb_config();

+       evaluate_git_version();

        check_loadavg();
 
        # $projectroot and $projects_list might be set in gitweb config file
        check_loadavg();
 
        # $projectroot and $projects_list might be set in gitweb config file


@@ -1114,7 +1140,6 @@ sub evaluate_argv {
 
 sub run {
        evaluate_argv();
 
 sub run {
        evaluate_argv();

-       evaluate_git_version();

 
        $pre_listen_hook->()
                if $pre_listen_hook;
 
        $pre_listen_hook->()
                if $pre_listen_hook;


@@ -3144,13 +3169,15 @@ sub parse_from_to_diffinfo {
 ## parse to array of hashes functions
 
 sub git_get_heads_list {
 ## parse to array of hashes functions
 
 sub git_get_heads_list {

-       my $limit = shift;
+       my ($limit, @classes) = @_;
+       @classes = ('heads') unless @classes;
+       my @patterns = map { "refs/$_" } @classes;

        my @headslist;
 
        open my $fd, '-|', git_cmd(), 'for-each-ref',
                ($limit ? '--count='.($limit+1) : ()), '--sort=-committerdate',
                '--format=%(objectname) %(refname) %(subject)%00%(committer)',
        my @headslist;
 
        open my $fd, '-|', git_cmd(), 'for-each-ref',
                ($limit ? '--count='.($limit+1) : ()), '--sort=-committerdate',
                '--format=%(objectname) %(refname) %(subject)%00%(committer)',

-               'refs/heads'
+               @patterns

                or return;
        while (my $line = <$fd>) {
                my %ref_item;
                or return;
        while (my $line = <$fd>) {
                my %ref_item;


@@ -3161,7 +3188,7 @@ sub git_get_heads_list {
                my ($committer, $epoch, $tz) =
                        ($committerinfo =~ /^(.*) ([0-9]+) (.*)$/);
                $ref_item{'fullname'}  = $name;
                my ($committer, $epoch, $tz) =
                        ($committerinfo =~ /^(.*) ([0-9]+) (.*)$/);
                $ref_item{'fullname'}  = $name;

-               $name =~ s!^refs/heads/!!;
+               $name =~ s!^refs/(?:head|remote)s/!!;

 
                $ref_item{'name'}  = $name;
                $ref_item{'id'}    = $hash;
 
                $ref_item{'name'}  = $name;
                $ref_item{'id'}    = $hash;


@@ -3361,7 +3388,8 @@ sub run_highlighter {
        close $fd
                or die_error(404, "Reading blob failed");
        open $fd, quote_command(git_cmd(), "cat-file", "blob", $hash)." | ".
        close $fd
                or die_error(404, "Reading blob failed");
        open $fd, quote_command(git_cmd(), "cat-file", "blob", $hash)." | ".

-                 "highlight --xhtml --fragment --syntax $syntax |"
+                 quote_command($highlight_bin).
+                 " --xhtml --fragment --syntax $syntax |"

                or die_error(500, "Couldn't open file or run syntax highlighter");
        return $fd;
 }
                or die_error(500, "Couldn't open file or run syntax highlighter");
        return $fd;
 }


@@ -3576,7 +3604,7 @@ sub git_footer_html {
                print "<div id=\"generating_info\">\n";
                print 'This page took '.
                      '<span id="generating_time" class="time_span">'.
                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()]).
+                     tv_interval($t0, [ gettimeofday() ]).

                      ' seconds </span>'.
                      ' and '.
                      '<span id="generating_cmd">'.
                      ' seconds </span>'.
                      ' and '.
                      '<span id="generating_cmd">'.


@@ -3704,6 +3732,19 @@ sub git_print_page_nav {
              "</div>\n";
 }
 
              "</div>\n";
 }
 

+# returns a submenu for the nagivation of the refs views (tags, heads,
+# remotes) with the current view disabled and the remotes view only
+# available if the feature is enabled
+sub format_ref_views {
+       my ($current) = @_;
+       my @ref_views = qw{tags heads};
+       push @ref_views, 'remotes' if gitweb_check_feature('remote_heads');
+       return join " | ", map {
+               $_ eq $current ? $_ :
+               $cgi->a({-href => href(action=>$_)}, $_)
+       } @ref_views
+}
+

 sub format_paging_nav {
        my ($action, $page, $has_next_link) = @_;
        my $paging_nav;
 sub format_paging_nav {
        my ($action, $page, $has_next_link) = @_;
        my $paging_nav;


@@ -4946,7 +4987,7 @@ sub git_heads_body {
                      "<td class=\"link\">" .
                      $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'})}, "shortlog") . " | " .
                      $cgi->a({-href => href(action=>"log", hash=>$ref{'fullname'})}, "log") . " | " .
                      "<td class=\"link\">" .
                      $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'})}, "shortlog") . " | " .
                      $cgi->a({-href => href(action=>"log", hash=>$ref{'fullname'})}, "log") . " | " .

-                     $cgi->a({-href => href(action=>"tree", hash=>$ref{'fullname'}, hash_base=>$ref{'name'})}, "tree") .
+                     $cgi->a({-href => href(action=>"tree", hash=>$ref{'fullname'}, hash_base=>$ref{'fullname'})}, "tree") .

                      "</td>\n" .
                      "</tr>";
        }
                      "</td>\n" .
                      "</tr>";
        }


@@ -5095,6 +5136,7 @@ sub git_summary {
        my %co = parse_commit("HEAD");
        my %cd = %co ? parse_date($co{'committer_epoch'}, $co{'committer_tz'}) : ();
        my $head = $co{'id'};
        my %co = parse_commit("HEAD");
        my %cd = %co ? parse_date($co{'committer_epoch'}, $co{'committer_tz'}) : ();
        my $head = $co{'id'};

+       my $remote_heads = gitweb_check_feature('remote_heads');

 
        my $owner = git_get_project_owner($project);
 
 
        my $owner = git_get_project_owner($project);
 


@@ -5103,6 +5145,7 @@ sub git_summary {
        # there are more ...
        my @taglist  = git_get_tags_list(16);
        my @headlist = git_get_heads_list(16);
        # there are more ...
        my @taglist  = git_get_tags_list(16);
        my @headlist = git_get_heads_list(16);

+       my @remotelist = $remote_heads ? git_get_heads_list(16, 'remotes') : ();

        my @forklist;
        my $check_forks = gitweb_check_feature('forks');
 
        my @forklist;
        my $check_forks = gitweb_check_feature('forks');
 


@@ -5180,6 +5223,13 @@ sub git_summary {
                               $cgi->a({-href => href(action=>"heads")}, "..."));
        }
 
                               $cgi->a({-href => href(action=>"heads")}, "..."));
        }
 

+       if (@remotelist) {
+               git_print_header_div('remotes');
+               git_heads_body(\@remotelist, $head, 0, 15,
+                              $#remotelist <= 15 ? undef :
+                              $cgi->a({-href => href(action=>"remotes")}, "..."));
+       }
+

        if (@forklist) {
                git_print_header_div('forks');
                git_project_list_body(\@forklist, 'age', 0, 15,
        if (@forklist) {
                git_print_header_div('forks');
                git_project_list_body(\@forklist, 'age', 0, 15,


@@ -5284,7 +5334,7 @@ sub git_blame_common {
                print 'END';
                if (defined $t0 && gitweb_check_feature('timed')) {
                        print ' '.
                print 'END';
                if (defined $t0 && gitweb_check_feature('timed')) {
                        print ' '.

-                             Time::HiRes::tv_interval($t0, [Time::HiRes::gettimeofday()]).
+                             tv_interval($t0, [ gettimeofday() ]).

                              ' '.$number_of_git_cmds;
                }
                print "\n";
                              ' '.$number_of_git_cmds;
                }
                print "\n";


@@ -5471,7 +5521,7 @@ sub git_blame_data {
 sub git_tags {
        my $head = git_get_head_hash($project);
        git_header_html();
 sub git_tags {
        my $head = git_get_head_hash($project);
        git_header_html();

-       git_print_page_nav('','', $head,undef,$head);
+       git_print_page_nav('','', $head,undef,$head,format_ref_views('tags'));

        git_print_header_div('summary', $project);
 
        my @tagslist = git_get_tags_list();
        git_print_header_div('summary', $project);
 
        my @tagslist = git_get_tags_list();


@@ -5484,7 +5534,7 @@ sub git_tags {
 sub git_heads {
        my $head = git_get_head_hash($project);
        git_header_html();
 sub git_heads {
        my $head = git_get_head_hash($project);
        git_header_html();

-       git_print_page_nav('','', $head,undef,$head);
+       git_print_page_nav('','', $head,undef,$head,format_ref_views('heads'));

        git_print_header_div('summary', $project);
 
        my @headslist = git_get_heads_list();
        git_print_header_div('summary', $project);
 
        my @headslist = git_get_heads_list();


@@ -5494,6 +5544,22 @@ sub git_heads {
        git_footer_html();
 }
 
        git_footer_html();
 }
 

+sub git_remotes {
+       gitweb_check_feature('remote_heads')
+               or die_error(403, "Remote heads view is disabled");
+
+       my $head = git_get_head_hash($project);
+       git_header_html();
+       git_print_page_nav('','', $head,undef,$head,format_ref_views('remotes'));
+       git_print_header_div('summary', $project);
+
+       my @remotelist = git_get_heads_list(undef, 'remotes');
+       if (@remotelist) {
+               git_heads_body(\@remotelist, $head);
+       }
+       git_footer_html();
+}
+

 sub git_blob_plain {
        my $type = shift;
        my $expires;
 sub git_blob_plain {
        my $type = shift;
        my $expires;