gitweb/README: Document $base_url

[Gitweb] / gitweb.perl

diff --git a/gitweb.perl b/gitweb.perl
index e706a2e10247b9c5f12b0c3c1e139879a9205c813a450c6d6f2abdb419c7ed78..e5ca381b20c3231c967f757157a9c9dcd8facdb4d1baa2e93d968ba6bb4d1da3 100755 (executable)
--- a/gitweb.perl
+++ b/gitweb.perl
@@ -95,7 +95,7 @@ our $favicon = "++GITWEB_FAVICON++";
 # URI and label (title) of GIT logo link
 #our $logo_url = "http://www.kernel.org/pub/software/scm/git/docs/";
 #our $logo_label = "git documentation";
 # URI and label (title) of GIT logo link
 #our $logo_url = "http://www.kernel.org/pub/software/scm/git/docs/";
 #our $logo_label = "git documentation";

-our $logo_url = "http://git.or.cz/";
+our $logo_url = "http://git-scm.com/";

 our $logo_label = "git homepage";
 
 # source of projects list
 our $logo_label = "git homepage";
 
 # source of projects list


@@ -379,15 +379,18 @@ our %feature = (
        # shortlog or commit will display an avatar associated with
        # the email of the committer(s) and/or author(s).
 
        # shortlog or commit will display an avatar associated with
        # the email of the committer(s) and/or author(s).
 

-       # Currently only the gravatar provider is available, and it
-       # depends on Digest::MD5. If an unknown provider is specified,
-       # the feature is disabled.
+       # Currently available providers are gravatar and picon.
+       # If an unknown provider is specified, the feature is disabled.
+
+       # Gravatar depends on Digest::MD5.
+       # Picon currently relies on the indiana.edu database.

 
        # To enable system wide have in $GITWEB_CONFIG
 
        # To enable system wide have in $GITWEB_CONFIG

-       # $feature{'avatar'}{'default'} = ['gravatar'];
+       # $feature{'avatar'}{'default'} = ['<provider>'];
+       # where <provider> is either gravatar or picon.

        # To have project specific config enable override in $GITWEB_CONFIG
        # $feature{'avatar'}{'override'} = 1;
        # To have project specific config enable override in $GITWEB_CONFIG
        # $feature{'avatar'}{'override'} = 1;

-       # and in project config gitweb.avatar = gravatar;
+       # and in project config gitweb.avatar = <provider>;

        'avatar' => {
                'sub' => \&feature_avatar,
                'override' => 0,
        'avatar' => {
                'sub' => \&feature_avatar,
                'override' => 0,


@@ -854,6 +857,8 @@ our @snapshot_fmts = gitweb_get_feature('snapshot');
 our ($git_avatar) = gitweb_get_feature('avatar');
 if ($git_avatar eq 'gravatar') {
        $git_avatar = '' unless (eval { require Digest::MD5; 1; });
 our ($git_avatar) = gitweb_get_feature('avatar');
 if ($git_avatar eq 'gravatar') {
        $git_avatar = '' unless (eval { require Digest::MD5; 1; });

+} elsif ($git_avatar eq 'picon') {
+       # no dependencies

 } else {
        $git_avatar = '';
 }
 } else {
        $git_avatar = '';
 }


@@ -936,10 +941,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'};


@@ -1521,6 +1529,20 @@ sub format_subject_html {
 # given page, there's no risk for cache conflicts.
 our %avatar_cache = ();
 
 # given page, there's no risk for cache conflicts.
 our %avatar_cache = ();
 

+# Compute the picon url for a given email, by using the picon search service over at
+# http://www.cs.indiana.edu/picons/search.html
+sub picon_url {
+       my $email = lc shift;
+       if (!$avatar_cache{$email}) {
+               my ($user, $domain) = split('@', $email);
+               $avatar_cache{$email} =
+                       "http://www.cs.indiana.edu/cgi-pub/kinzler/piconsearch.cgi/" .
+                       "$domain/$user/" .
+                       "users+domains+unknown/up/single";
+       }
+       return $avatar_cache{$email};
+}
+

 # Compute the gravatar url for a given email, if it's not in the cache already.
 # Gravatar stores only the part of the URL before the size, since that's the
 # one computationally more expensive. This also allows reuse of the cache for
 # Compute the gravatar url for a given email, if it's not in the cache already.
 # Gravatar stores only the part of the URL before the size, since that's the
 # one computationally more expensive. This also allows reuse of the cache for


@@ -1545,9 +1567,10 @@ sub git_get_avatar {
        my $url = "";
        if ($git_avatar eq 'gravatar') {
                $url = gravatar_url($email, $size);
        my $url = "";
        if ($git_avatar eq 'gravatar') {
                $url = gravatar_url($email, $size);

+       } elsif ($git_avatar eq 'picon') {
+               $url = picon_url($email);

        }
        }

-       # Currently only gravatars are supported, but other forms such as
-       # picons can be added by putting an else up here and defining $url
+       # Other providers can be added by extending the if chain, defining $url

        # as needed. If no variant puts something in $url, we assume avatars
        # are completely disabled/unavailable.
        if ($url) {
        # as needed. If no variant puts something in $url, we assume avatars
        # are completely disabled/unavailable.
        if ($url) {


@@ -1555,6 +1578,7 @@ sub git_get_avatar {
                       "<img width=\"$size\" " .
                            "class=\"avatar\" " .
                            "src=\"$url\" " .
                       "<img width=\"$size\" " .
                            "class=\"avatar\" " .
                            "src=\"$url\" " .

+                           "alt=\"\" " .

                       "/>" . $post_white;
        } else {
                return "";
                       "/>" . $post_white;
        } else {
                return "";


@@ -4781,7 +4805,7 @@ sub git_blame {
        git_print_page_path($file_name, $ftype, $hash_base);
 
        # page body
        git_print_page_path($file_name, $ftype, $hash_base);
 
        # page body

-       my @rev_color = qw(light2 dark2);
+       my @rev_color = qw(light dark);

        my $num_colors = scalar(@rev_color);
        my $current_color = 0;
        my %metainfo = ();
        my $num_colors = scalar(@rev_color);
        my $current_color = 0;
        my %metainfo = ();


@@ -4799,15 +4823,18 @@ HTML
                my ($full_rev, $orig_lineno, $lineno, $group_size) =
                   ($line =~ /^([0-9a-f]{40}) (\d+) (\d+)(?: (\d+))?$/);
                if (!exists $metainfo{$full_rev}) {
                my ($full_rev, $orig_lineno, $lineno, $group_size) =
                   ($line =~ /^([0-9a-f]{40}) (\d+) (\d+)(?: (\d+))?$/);
                if (!exists $metainfo{$full_rev}) {

-                       $metainfo{$full_rev} = {};
+                       $metainfo{$full_rev} = { 'nprevious' => 0 };

                }
                my $meta = $metainfo{$full_rev};
                my $data;
                while ($data = <$fd>) {
                        chomp $data;
                        last if ($data =~ s/^\t//); # contents of line
                }
                my $meta = $metainfo{$full_rev};
                my $data;
                while ($data = <$fd>) {
                        chomp $data;
                        last if ($data =~ s/^\t//); # contents of line

-                       if ($data =~ /^(\S+) (.*)$/) {
-                               $meta->{$1} = $2;
+                       if ($data =~ /^(\S+)(?: (.*))?$/) {
+                               $meta->{$1} = $2 unless exists $meta->{$1};
+                       }
+                       if ($data =~ /^previous /) {
+                               $meta->{'nprevious'}++;

                        }
                }
                my $short_rev = substr($full_rev, 0, 8);
                        }
                }
                my $short_rev = substr($full_rev, 0, 8);


@@ -4818,7 +4845,11 @@ HTML
                if ($group_size) {
                        $current_color = ($current_color + 1) % $num_colors;
                }
                if ($group_size) {
                        $current_color = ($current_color + 1) % $num_colors;
                }

-               print "<tr id=\"l$lineno\" class=\"$rev_color[$current_color]\">\n";
+               my $tr_class = $rev_color[$current_color];
+               $tr_class .= ' boundary' if (exists $meta->{'boundary'});
+               $tr_class .= ' no-previous' if ($meta->{'nprevious'} == 0);
+               $tr_class .= ' multiple-previous' if ($meta->{'nprevious'} > 1);
+               print "<tr id=\"l$lineno\" class=\"$tr_class\">\n";

                if ($group_size) {
                        print "<td class=\"sha1\"";
                        print " title=\"". esc_html($author) . ", $date\"";
                if ($group_size) {
                        print "<td class=\"sha1\"";
                        print " title=\"". esc_html($author) . ", $date\"";


@@ -4828,22 +4859,31 @@ HTML
                                                     hash=>$full_rev,
                                                     file_name=>$file_name)},
                                      esc_html($short_rev));
                                                     hash=>$full_rev,
                                                     file_name=>$file_name)},
                                      esc_html($short_rev));

+                       if ($group_size >= 2) {
+                               my @author_initials = ($author =~ /\b([[:upper:]])\B/g);
+                               if (@author_initials) {
+                                       print "<br />" .
+                                             esc_html(join('', @author_initials));
+                                       #           or join('.', ...)
+                               }
+                       }

                        print "</td>\n";
                }
                        print "</td>\n";
                }

-               my $parent_commit;
-               if (!exists $meta->{'parent'}) {
-                       open (my $dd, "-|", git_cmd(), "rev-parse", "$full_rev^")
-                               or die_error(500, "Open git-rev-parse failed");
-                       $parent_commit = <$dd>;
-                       close $dd;
-                       chomp($parent_commit);
-                       $meta->{'parent'} = $parent_commit;
-               } else {
-                       $parent_commit = $meta->{'parent'};
-               }
+               # 'previous' <sha1 of parent commit> <filename at commit>
+               if (exists $meta->{'previous'} &&
+                   $meta->{'previous'} =~ /^([a-fA-F0-9]{40}) (.*)$/) {
+                       $meta->{'parent'} = $1;
+                       $meta->{'file_parent'} = unquote($2);
+               }
+               my $linenr_commit =
+                       exists($meta->{'parent'}) ?
+                       $meta->{'parent'} : $full_rev;
+               my $linenr_filename =
+                       exists($meta->{'file_parent'}) ?
+                       $meta->{'file_parent'} : unquote($meta->{'filename'});

                my $blamed = href(action => 'blame',
                my $blamed = href(action => 'blame',

-                                 file_name => $meta->{'filename'},
-                                 hash_base => $parent_commit);
+                                 file_name => $linenr_filename,
+                                 hash_base => $linenr_commit);

                print "<td class=\"linenr\">";
                print $cgi->a({ -href => "$blamed#l$orig_lineno",
                                -class => "linenr" },
                print "<td class=\"linenr\">";
                print $cgi->a({ -href => "$blamed#l$orig_lineno",
                                -class => "linenr" },