gitweb: support to globally disable a snapshot format
[gitweb.git] / gitweb / gitweb.perl
index 92695a3ae8f0e0a444485899dfaf1b5894b21b34..a0cdf316660ce3e8f3f84798fda0a80358ff11b1 100755 (executable)
@@ -94,7 +94,7 @@ BEGIN
 # 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
@@ -160,7 +160,8 @@ BEGIN
        #       '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',
@@ -378,15 +379,18 @@ BEGIN
        # 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
-       # $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;
-       # and in project config gitweb.avatar = gravatar;
+       # and in project config gitweb.avatar = <provider>;
        'avatar' => {
                'sub' => \&feature_avatar,
                'override' => 0,
@@ -491,7 +495,8 @@ sub filter_snapshot_fmts {
                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++";
@@ -853,6 +858,8 @@ sub evaluate_path_info {
 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 = '';
 }
@@ -935,10 +942,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
-                               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'};
@@ -1512,6 +1522,41 @@ sub format_subject_html {
        }
 }
 
+# Rather than recomputing the url for an email multiple times, we cache it
+# after the first hit. This gives a visible benefit in views where the avatar
+# for the same email is used repeatedly (e.g. shortlog).
+# The cache is shared by all avatar engines (currently gravatar only), which
+# are free to use it as preferred. Since only one avatar engine is used for any
+# 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
+# different sizes (for this particular engine).
+sub gravatar_url {
+       my $email = lc shift;
+       my $size = shift;
+       $avatar_cache{$email} ||=
+               "http://www.gravatar.com/avatar/" .
+                       Digest::MD5::md5_hex($email) . "?s=";
+       return $avatar_cache{$email} . $size;
+}
+
 # Insert an avatar for the given $email at the given $size if the feature
 # is enabled.
 sub git_get_avatar {
@@ -1522,11 +1567,11 @@ sub git_get_avatar {
        my $size = $avatar_size{$opts{-size}} || $avatar_size{'default'};
        my $url = "";
        if ($git_avatar eq 'gravatar') {
-               $url = "http://www.gravatar.com/avatar/" .
-                       Digest::MD5::md5_hex(lc $email) . "?s=$size";
+               $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) {
@@ -1534,6 +1579,7 @@ sub git_get_avatar {
                       "<img width=\"$size\" " .
                            "class=\"avatar\" " .
                            "src=\"$url\" " .
+                           "alt=\"\" " .
                       "/>" . $post_white;
        } else {
                return "";
@@ -5122,6 +5168,8 @@ sub git_snapshot {
                die_error(400, "Unknown snapshot format");
        } elsif (!grep($_ eq $format, @snapshot_fmts)) {
                die_error(403, "Unsupported snapshot format");
+       } elsif ($known_snapshot_formats{$format}{'disabled'}) {
+               die_error(403, "Snapshot format not allowed");
        }
 
        if (!defined $hash) {