Code

568b0775f2de72d7f4fe9b3d7f5f72cbc2108085
[git.git] / gitweb / gitweb.perl
1 #!/usr/bin/perl
3 # gitweb - simple web interface to track changes in git repositories
4 #
5 # (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
6 # (C) 2005, Christian Gierke
7 #
8 # This program is licensed under the GPLv2
10 use 5.008;
11 use strict;
12 use warnings;
13 use CGI qw(:standard :escapeHTML -nosticky);
14 use CGI::Util qw(unescape);
15 use CGI::Carp qw(fatalsToBrowser set_message);
16 use Encode;
17 use Fcntl ':mode';
18 use File::Find qw();
19 use File::Basename qw(basename);
20 use Time::HiRes qw(gettimeofday tv_interval);
21 binmode STDOUT, ':utf8';
23 our $t0 = [ gettimeofday() ];
24 our $number_of_git_cmds = 0;
26 BEGIN {
27         CGI->compile() if $ENV{'MOD_PERL'};
28 }
30 our $version = "++GIT_VERSION++";
32 our ($my_url, $my_uri, $base_url, $path_info, $home_link);
33 sub evaluate_uri {
34         our $cgi;
36         our $my_url = $cgi->url();
37         our $my_uri = $cgi->url(-absolute => 1);
39         # Base URL for relative URLs in gitweb ($logo, $favicon, ...),
40         # needed and used only for URLs with nonempty PATH_INFO
41         our $base_url = $my_url;
43         # When the script is used as DirectoryIndex, the URL does not contain the name
44         # of the script file itself, and $cgi->url() fails to strip PATH_INFO, so we
45         # have to do it ourselves. We make $path_info global because it's also used
46         # later on.
47         #
48         # Another issue with the script being the DirectoryIndex is that the resulting
49         # $my_url data is not the full script URL: this is good, because we want
50         # generated links to keep implying the script name if it wasn't explicitly
51         # indicated in the URL we're handling, but it means that $my_url cannot be used
52         # as base URL.
53         # Therefore, if we needed to strip PATH_INFO, then we know that we have
54         # to build the base URL ourselves:
55         our $path_info = decode_utf8($ENV{"PATH_INFO"});
56         if ($path_info) {
57                 if ($my_url =~ s,\Q$path_info\E$,, &&
58                     $my_uri =~ s,\Q$path_info\E$,, &&
59                     defined $ENV{'SCRIPT_NAME'}) {
60                         $base_url = $cgi->url(-base => 1) . $ENV{'SCRIPT_NAME'};
61                 }
62         }
64         # target of the home link on top of all pages
65         our $home_link = $my_uri || "/";
66 }
68 # core git executable to use
69 # this can just be "git" if your webserver has a sensible PATH
70 our $GIT = "++GIT_BINDIR++/git";
72 # absolute fs-path which will be prepended to the project path
73 #our $projectroot = "/pub/scm";
74 our $projectroot = "++GITWEB_PROJECTROOT++";
76 # fs traversing limit for getting project list
77 # the number is relative to the projectroot
78 our $project_maxdepth = "++GITWEB_PROJECT_MAXDEPTH++";
80 # string of the home link on top of all pages
81 our $home_link_str = "++GITWEB_HOME_LINK_STR++";
83 # name of your site or organization to appear in page titles
84 # replace this with something more descriptive for clearer bookmarks
85 our $site_name = "++GITWEB_SITENAME++"
86                  || ($ENV{'SERVER_NAME'} || "Untitled") . " Git";
88 # html snippet to include in the <head> section of each page
89 our $site_html_head_string = "++GITWEB_SITE_HTML_HEAD_STRING++";
90 # filename of html text to include at top of each page
91 our $site_header = "++GITWEB_SITE_HEADER++";
92 # html text to include at home page
93 our $home_text = "++GITWEB_HOMETEXT++";
94 # filename of html text to include at bottom of each page
95 our $site_footer = "++GITWEB_SITE_FOOTER++";
97 # URI of stylesheets
98 our @stylesheets = ("++GITWEB_CSS++");
99 # URI of a single stylesheet, which can be overridden in GITWEB_CONFIG.
100 our $stylesheet = undef;
101 # URI of GIT logo (72x27 size)
102 our $logo = "++GITWEB_LOGO++";
103 # URI of GIT favicon, assumed to be image/png type
104 our $favicon = "++GITWEB_FAVICON++";
105 # URI of gitweb.js (JavaScript code for gitweb)
106 our $javascript = "++GITWEB_JS++";
108 # URI and label (title) of GIT logo link
109 #our $logo_url = "http://www.kernel.org/pub/software/scm/git/docs/";
110 #our $logo_label = "git documentation";
111 our $logo_url = "http://git-scm.com/";
112 our $logo_label = "git homepage";
114 # source of projects list
115 our $projects_list = "++GITWEB_LIST++";
117 # the width (in characters) of the projects list "Description" column
118 our $projects_list_description_width = 25;
120 # group projects by category on the projects list
121 # (enabled if this variable evaluates to true)
122 our $projects_list_group_categories = 0;
124 # default category if none specified
125 # (leave the empty string for no category)
126 our $project_list_default_category = "";
128 # default order of projects list
129 # valid values are none, project, descr, owner, and age
130 our $default_projects_order = "project";
132 # show repository only if this file exists
133 # (only effective if this variable evaluates to true)
134 our $export_ok = "++GITWEB_EXPORT_OK++";
136 # show repository only if this subroutine returns true
137 # when given the path to the project, for example:
138 #    sub { return -e "$_[0]/git-daemon-export-ok"; }
139 our $export_auth_hook = undef;
141 # only allow viewing of repositories also shown on the overview page
142 our $strict_export = "++GITWEB_STRICT_EXPORT++";
144 # list of git base URLs used for URL to where fetch project from,
145 # i.e. full URL is "$git_base_url/$project"
146 our @git_base_url_list = grep { $_ ne '' } ("++GITWEB_BASE_URL++");
148 # default blob_plain mimetype and default charset for text/plain blob
149 our $default_blob_plain_mimetype = 'text/plain';
150 our $default_text_plain_charset  = undef;
152 # file to use for guessing MIME types before trying /etc/mime.types
153 # (relative to the current git repository)
154 our $mimetypes_file = undef;
156 # assume this charset if line contains non-UTF-8 characters;
157 # it should be valid encoding (see Encoding::Supported(3pm) for list),
158 # for which encoding all byte sequences are valid, for example
159 # 'iso-8859-1' aka 'latin1' (it is decoded without checking, so it
160 # could be even 'utf-8' for the old behavior)
161 our $fallback_encoding = 'latin1';
163 # rename detection options for git-diff and git-diff-tree
164 # - default is '-M', with the cost proportional to
165 #   (number of removed files) * (number of new files).
166 # - more costly is '-C' (which implies '-M'), with the cost proportional to
167 #   (number of changed files + number of removed files) * (number of new files)
168 # - even more costly is '-C', '--find-copies-harder' with cost
169 #   (number of files in the original tree) * (number of new files)
170 # - one might want to include '-B' option, e.g. '-B', '-M'
171 our @diff_opts = ('-M'); # taken from git_commit
173 # Disables features that would allow repository owners to inject script into
174 # the gitweb domain.
175 our $prevent_xss = 0;
177 # Path to the highlight executable to use (must be the one from
178 # http://www.andre-simon.de due to assumptions about parameters and output).
179 # Useful if highlight is not installed on your webserver's PATH.
180 # [Default: highlight]
181 our $highlight_bin = "++HIGHLIGHT_BIN++";
183 # information about snapshot formats that gitweb is capable of serving
184 our %known_snapshot_formats = (
185         # name => {
186         #       'display' => display name,
187         #       'type' => mime type,
188         #       'suffix' => filename suffix,
189         #       'format' => --format for git-archive,
190         #       'compressor' => [compressor command and arguments]
191         #                       (array reference, optional)
192         #       'disabled' => boolean (optional)}
193         #
194         'tgz' => {
195                 'display' => 'tar.gz',
196                 'type' => 'application/x-gzip',
197                 'suffix' => '.tar.gz',
198                 'format' => 'tar',
199                 'compressor' => ['gzip', '-n']},
201         'tbz2' => {
202                 'display' => 'tar.bz2',
203                 'type' => 'application/x-bzip2',
204                 'suffix' => '.tar.bz2',
205                 'format' => 'tar',
206                 'compressor' => ['bzip2']},
208         'txz' => {
209                 'display' => 'tar.xz',
210                 'type' => 'application/x-xz',
211                 'suffix' => '.tar.xz',
212                 'format' => 'tar',
213                 'compressor' => ['xz'],
214                 'disabled' => 1},
216         'zip' => {
217                 'display' => 'zip',
218                 'type' => 'application/x-zip',
219                 'suffix' => '.zip',
220                 'format' => 'zip'},
221 );
223 # Aliases so we understand old gitweb.snapshot values in repository
224 # configuration.
225 our %known_snapshot_format_aliases = (
226         'gzip'  => 'tgz',
227         'bzip2' => 'tbz2',
228         'xz'    => 'txz',
230         # backward compatibility: legacy gitweb config support
231         'x-gzip' => undef, 'gz' => undef,
232         'x-bzip2' => undef, 'bz2' => undef,
233         'x-zip' => undef, '' => undef,
234 );
236 # Pixel sizes for icons and avatars. If the default font sizes or lineheights
237 # are changed, it may be appropriate to change these values too via
238 # $GITWEB_CONFIG.
239 our %avatar_size = (
240         'default' => 16,
241         'double'  => 32
242 );
244 # Used to set the maximum load that we will still respond to gitweb queries.
245 # If server load exceed this value then return "503 server busy" error.
246 # If gitweb cannot determined server load, it is taken to be 0.
247 # Leave it undefined (or set to 'undef') to turn off load checking.
248 our $maxload = 300;
250 # configuration for 'highlight' (http://www.andre-simon.de/)
251 # match by basename
252 our %highlight_basename = (
253         #'Program' => 'py',
254         #'Library' => 'py',
255         'SConstruct' => 'py', # SCons equivalent of Makefile
256         'Makefile' => 'make',
257 );
258 # match by extension
259 our %highlight_ext = (
260         # main extensions, defining name of syntax;
261         # see files in /usr/share/highlight/langDefs/ directory
262         map { $_ => $_ }
263                 qw(py c cpp rb java css php sh pl js tex bib xml awk bat ini spec tcl sql make),
264         # alternate extensions, see /etc/highlight/filetypes.conf
265         'h' => 'c',
266         map { $_ => 'sh'  } qw(bash zsh ksh),
267         map { $_ => 'cpp' } qw(cxx c++ cc),
268         map { $_ => 'php' } qw(php3 php4 php5 phps),
269         map { $_ => 'pl'  } qw(perl pm), # perhaps also 'cgi'
270         map { $_ => 'make'} qw(mak mk),
271         map { $_ => 'xml' } qw(xhtml html htm),
272 );
274 # You define site-wide feature defaults here; override them with
275 # $GITWEB_CONFIG as necessary.
276 our %feature = (
277         # feature => {
278         #       'sub' => feature-sub (subroutine),
279         #       'override' => allow-override (boolean),
280         #       'default' => [ default options...] (array reference)}
281         #
282         # if feature is overridable (it means that allow-override has true value),
283         # then feature-sub will be called with default options as parameters;
284         # return value of feature-sub indicates if to enable specified feature
285         #
286         # if there is no 'sub' key (no feature-sub), then feature cannot be
287         # overridden
288         #
289         # use gitweb_get_feature(<feature>) to retrieve the <feature> value
290         # (an array) or gitweb_check_feature(<feature>) to check if <feature>
291         # is enabled
293         # Enable the 'blame' blob view, showing the last commit that modified
294         # each line in the file. This can be very CPU-intensive.
296         # To enable system wide have in $GITWEB_CONFIG
297         # $feature{'blame'}{'default'} = [1];
298         # To have project specific config enable override in $GITWEB_CONFIG
299         # $feature{'blame'}{'override'} = 1;
300         # and in project config gitweb.blame = 0|1;
301         'blame' => {
302                 'sub' => sub { feature_bool('blame', @_) },
303                 'override' => 0,
304                 'default' => [0]},
306         # Enable the 'snapshot' link, providing a compressed archive of any
307         # tree. This can potentially generate high traffic if you have large
308         # project.
310         # Value is a list of formats defined in %known_snapshot_formats that
311         # you wish to offer.
312         # To disable system wide have in $GITWEB_CONFIG
313         # $feature{'snapshot'}{'default'} = [];
314         # To have project specific config enable override in $GITWEB_CONFIG
315         # $feature{'snapshot'}{'override'} = 1;
316         # and in project config, a comma-separated list of formats or "none"
317         # to disable.  Example: gitweb.snapshot = tbz2,zip;
318         'snapshot' => {
319                 'sub' => \&feature_snapshot,
320                 'override' => 0,
321                 'default' => ['tgz']},
323         # Enable text search, which will list the commits which match author,
324         # committer or commit text to a given string.  Enabled by default.
325         # Project specific override is not supported.
326         #
327         # Note that this controls all search features, which means that if
328         # it is disabled, then 'grep' and 'pickaxe' search would also be
329         # disabled.
330         'search' => {
331                 'override' => 0,
332                 'default' => [1]},
334         # Enable grep search, which will list the files in currently selected
335         # tree containing the given string. Enabled by default. This can be
336         # potentially CPU-intensive, of course.
337         # Note that you need to have 'search' feature enabled too.
339         # To enable system wide have in $GITWEB_CONFIG
340         # $feature{'grep'}{'default'} = [1];
341         # To have project specific config enable override in $GITWEB_CONFIG
342         # $feature{'grep'}{'override'} = 1;
343         # and in project config gitweb.grep = 0|1;
344         'grep' => {
345                 'sub' => sub { feature_bool('grep', @_) },
346                 'override' => 0,
347                 'default' => [1]},
349         # Enable the pickaxe search, which will list the commits that modified
350         # a given string in a file. This can be practical and quite faster
351         # alternative to 'blame', but still potentially CPU-intensive.
352         # Note that you need to have 'search' feature enabled too.
354         # To enable system wide have in $GITWEB_CONFIG
355         # $feature{'pickaxe'}{'default'} = [1];
356         # To have project specific config enable override in $GITWEB_CONFIG
357         # $feature{'pickaxe'}{'override'} = 1;
358         # and in project config gitweb.pickaxe = 0|1;
359         'pickaxe' => {
360                 'sub' => sub { feature_bool('pickaxe', @_) },
361                 'override' => 0,
362                 'default' => [1]},
364         # Enable showing size of blobs in a 'tree' view, in a separate
365         # column, similar to what 'ls -l' does.  This cost a bit of IO.
367         # To disable system wide have in $GITWEB_CONFIG
368         # $feature{'show-sizes'}{'default'} = [0];
369         # To have project specific config enable override in $GITWEB_CONFIG
370         # $feature{'show-sizes'}{'override'} = 1;
371         # and in project config gitweb.showsizes = 0|1;
372         'show-sizes' => {
373                 'sub' => sub { feature_bool('showsizes', @_) },
374                 'override' => 0,
375                 'default' => [1]},
377         # Make gitweb use an alternative format of the URLs which can be
378         # more readable and natural-looking: project name is embedded
379         # directly in the path and the query string contains other
380         # auxiliary information. All gitweb installations recognize
381         # URL in either format; this configures in which formats gitweb
382         # generates links.
384         # To enable system wide have in $GITWEB_CONFIG
385         # $feature{'pathinfo'}{'default'} = [1];
386         # Project specific override is not supported.
388         # Note that you will need to change the default location of CSS,
389         # favicon, logo and possibly other files to an absolute URL. Also,
390         # if gitweb.cgi serves as your indexfile, you will need to force
391         # $my_uri to contain the script name in your $GITWEB_CONFIG.
392         'pathinfo' => {
393                 'override' => 0,
394                 'default' => [0]},
396         # Make gitweb consider projects in project root subdirectories
397         # to be forks of existing projects. Given project $projname.git,
398         # projects matching $projname/*.git will not be shown in the main
399         # projects list, instead a '+' mark will be added to $projname
400         # there and a 'forks' view will be enabled for the project, listing
401         # all the forks. If project list is taken from a file, forks have
402         # to be listed after the main project.
404         # To enable system wide have in $GITWEB_CONFIG
405         # $feature{'forks'}{'default'} = [1];
406         # Project specific override is not supported.
407         'forks' => {
408                 'override' => 0,
409                 'default' => [0]},
411         # Insert custom links to the action bar of all project pages.
412         # This enables you mainly to link to third-party scripts integrating
413         # into gitweb; e.g. git-browser for graphical history representation
414         # or custom web-based repository administration interface.
416         # The 'default' value consists of a list of triplets in the form
417         # (label, link, position) where position is the label after which
418         # to insert the link and link is a format string where %n expands
419         # to the project name, %f to the project path within the filesystem,
420         # %h to the current hash (h gitweb parameter) and %b to the current
421         # hash base (hb gitweb parameter); %% expands to %.
423         # To enable system wide have in $GITWEB_CONFIG e.g.
424         # $feature{'actions'}{'default'} = [('graphiclog',
425         #       '/git-browser/by-commit.html?r=%n', 'summary')];
426         # Project specific override is not supported.
427         'actions' => {
428                 'override' => 0,
429                 'default' => []},
431         # Allow gitweb scan project content tags of project repository,
432         # and display the popular Web 2.0-ish "tag cloud" near the projects
433         # list.  Note that this is something COMPLETELY different from the
434         # normal Git tags.
436         # gitweb by itself can show existing tags, but it does not handle
437         # tagging itself; you need to do it externally, outside gitweb.
438         # The format is described in git_get_project_ctags() subroutine.
439         # You may want to install the HTML::TagCloud Perl module to get
440         # a pretty tag cloud instead of just a list of tags.
442         # To enable system wide have in $GITWEB_CONFIG
443         # $feature{'ctags'}{'default'} = [1];
444         # Project specific override is not supported.
446         # In the future whether ctags editing is enabled might depend
447         # on the value, but using 1 should always mean no editing of ctags.
448         'ctags' => {
449                 'override' => 0,
450                 'default' => [0]},
452         # The maximum number of patches in a patchset generated in patch
453         # view. Set this to 0 or undef to disable patch view, or to a
454         # negative number to remove any limit.
456         # To disable system wide have in $GITWEB_CONFIG
457         # $feature{'patches'}{'default'} = [0];
458         # To have project specific config enable override in $GITWEB_CONFIG
459         # $feature{'patches'}{'override'} = 1;
460         # and in project config gitweb.patches = 0|n;
461         # where n is the maximum number of patches allowed in a patchset.
462         'patches' => {
463                 'sub' => \&feature_patches,
464                 'override' => 0,
465                 'default' => [16]},
467         # Avatar support. When this feature is enabled, views such as
468         # shortlog or commit will display an avatar associated with
469         # the email of the committer(s) and/or author(s).
471         # Currently available providers are gravatar and picon.
472         # If an unknown provider is specified, the feature is disabled.
474         # Gravatar depends on Digest::MD5.
475         # Picon currently relies on the indiana.edu database.
477         # To enable system wide have in $GITWEB_CONFIG
478         # $feature{'avatar'}{'default'} = ['<provider>'];
479         # where <provider> is either gravatar or picon.
480         # To have project specific config enable override in $GITWEB_CONFIG
481         # $feature{'avatar'}{'override'} = 1;
482         # and in project config gitweb.avatar = <provider>;
483         'avatar' => {
484                 'sub' => \&feature_avatar,
485                 'override' => 0,
486                 'default' => ['']},
488         # Enable displaying how much time and how many git commands
489         # it took to generate and display page.  Disabled by default.
490         # Project specific override is not supported.
491         'timed' => {
492                 'override' => 0,
493                 'default' => [0]},
495         # Enable turning some links into links to actions which require
496         # JavaScript to run (like 'blame_incremental').  Not enabled by
497         # default.  Project specific override is currently not supported.
498         'javascript-actions' => {
499                 'override' => 0,
500                 'default' => [0]},
502         # Enable and configure ability to change common timezone for dates
503         # in gitweb output via JavaScript.  Enabled by default.
504         # Project specific override is not supported.
505         'javascript-timezone' => {
506                 'override' => 0,
507                 'default' => [
508                         'local',     # default timezone: 'utc', 'local', or '(-|+)HHMM' format,
509                                      # or undef to turn off this feature
510                         'gitweb_tz', # name of cookie where to store selected timezone
511                         'datetime',  # CSS class used to mark up dates for manipulation
512                 ]},
514         # Syntax highlighting support. This is based on Daniel Svensson's
515         # and Sham Chukoury's work in gitweb-xmms2.git.
516         # It requires the 'highlight' program present in $PATH,
517         # and therefore is disabled by default.
519         # To enable system wide have in $GITWEB_CONFIG
520         # $feature{'highlight'}{'default'} = [1];
522         'highlight' => {
523                 'sub' => sub { feature_bool('highlight', @_) },
524                 'override' => 0,
525                 'default' => [0]},
527         # Enable displaying of remote heads in the heads list
529         # To enable system wide have in $GITWEB_CONFIG
530         # $feature{'remote_heads'}{'default'} = [1];
531         # To have project specific config enable override in $GITWEB_CONFIG
532         # $feature{'remote_heads'}{'override'} = 1;
533         # and in project config gitweb.remote_heads = 0|1;
534         'remote_heads' => {
535                 'sub' => sub { feature_bool('remote_heads', @_) },
536                 'override' => 0,
537                 'default' => [0]},
538 );
540 sub gitweb_get_feature {
541         my ($name) = @_;
542         return unless exists $feature{$name};
543         my ($sub, $override, @defaults) = (
544                 $feature{$name}{'sub'},
545                 $feature{$name}{'override'},
546                 @{$feature{$name}{'default'}});
547         # project specific override is possible only if we have project
548         our $git_dir; # global variable, declared later
549         if (!$override || !defined $git_dir) {
550                 return @defaults;
551         }
552         if (!defined $sub) {
553                 warn "feature $name is not overridable";
554                 return @defaults;
555         }
556         return $sub->(@defaults);
559 # A wrapper to check if a given feature is enabled.
560 # With this, you can say
562 #   my $bool_feat = gitweb_check_feature('bool_feat');
563 #   gitweb_check_feature('bool_feat') or somecode;
565 # instead of
567 #   my ($bool_feat) = gitweb_get_feature('bool_feat');
568 #   (gitweb_get_feature('bool_feat'))[0] or somecode;
570 sub gitweb_check_feature {
571         return (gitweb_get_feature(@_))[0];
575 sub feature_bool {
576         my $key = shift;
577         my ($val) = git_get_project_config($key, '--bool');
579         if (!defined $val) {
580                 return ($_[0]);
581         } elsif ($val eq 'true') {
582                 return (1);
583         } elsif ($val eq 'false') {
584                 return (0);
585         }
588 sub feature_snapshot {
589         my (@fmts) = @_;
591         my ($val) = git_get_project_config('snapshot');
593         if ($val) {
594                 @fmts = ($val eq 'none' ? () : split /\s*[,\s]\s*/, $val);
595         }
597         return @fmts;
600 sub feature_patches {
601         my @val = (git_get_project_config('patches', '--int'));
603         if (@val) {
604                 return @val;
605         }
607         return ($_[0]);
610 sub feature_avatar {
611         my @val = (git_get_project_config('avatar'));
613         return @val ? @val : @_;
616 # checking HEAD file with -e is fragile if the repository was
617 # initialized long time ago (i.e. symlink HEAD) and was pack-ref'ed
618 # and then pruned.
619 sub check_head_link {
620         my ($dir) = @_;
621         my $headfile = "$dir/HEAD";
622         return ((-e $headfile) ||
623                 (-l $headfile && readlink($headfile) =~ /^refs\/heads\//));
626 sub check_export_ok {
627         my ($dir) = @_;
628         return (check_head_link($dir) &&
629                 (!$export_ok || -e "$dir/$export_ok") &&
630                 (!$export_auth_hook || $export_auth_hook->($dir)));
633 # process alternate names for backward compatibility
634 # filter out unsupported (unknown) snapshot formats
635 sub filter_snapshot_fmts {
636         my @fmts = @_;
638         @fmts = map {
639                 exists $known_snapshot_format_aliases{$_} ?
640                        $known_snapshot_format_aliases{$_} : $_} @fmts;
641         @fmts = grep {
642                 exists $known_snapshot_formats{$_} &&
643                 !$known_snapshot_formats{$_}{'disabled'}} @fmts;
646 # If it is set to code reference, it is code that it is to be run once per
647 # request, allowing updating configurations that change with each request,
648 # while running other code in config file only once.
650 # Otherwise, if it is false then gitweb would process config file only once;
651 # if it is true then gitweb config would be run for each request.
652 our $per_request_config = 1;
654 # read and parse gitweb config file given by its parameter.
655 # returns true on success, false on recoverable error, allowing
656 # to chain this subroutine, using first file that exists.
657 # dies on errors during parsing config file, as it is unrecoverable.
658 sub read_config_file {
659         my $filename = shift;
660         return unless defined $filename;
661         # die if there are errors parsing config file
662         if (-e $filename) {
663                 do $filename;
664                 die $@ if $@;
665                 return 1;
666         }
667         return;
670 our ($GITWEB_CONFIG, $GITWEB_CONFIG_SYSTEM, $GITWEB_CONFIG_COMMON);
671 sub evaluate_gitweb_config {
672         our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";
673         our $GITWEB_CONFIG_SYSTEM = $ENV{'GITWEB_CONFIG_SYSTEM'} || "++GITWEB_CONFIG_SYSTEM++";
674         our $GITWEB_CONFIG_COMMON = $ENV{'GITWEB_CONFIG_COMMON'} || "++GITWEB_CONFIG_COMMON++";
676         # Protect agains duplications of file names, to not read config twice.
677         # Only one of $GITWEB_CONFIG and $GITWEB_CONFIG_SYSTEM is used, so
678         # there possibility of duplication of filename there doesn't matter.
679         $GITWEB_CONFIG = ""        if ($GITWEB_CONFIG eq $GITWEB_CONFIG_COMMON);
680         $GITWEB_CONFIG_SYSTEM = "" if ($GITWEB_CONFIG_SYSTEM eq $GITWEB_CONFIG_COMMON);
682         # Common system-wide settings for convenience.
683         # Those settings can be ovverriden by GITWEB_CONFIG or GITWEB_CONFIG_SYSTEM.
684         read_config_file($GITWEB_CONFIG_COMMON);
686         # Use first config file that exists.  This means use the per-instance
687         # GITWEB_CONFIG if exists, otherwise use GITWEB_SYSTEM_CONFIG.
688         read_config_file($GITWEB_CONFIG) and return;
689         read_config_file($GITWEB_CONFIG_SYSTEM);
692 # Get loadavg of system, to compare against $maxload.
693 # Currently it requires '/proc/loadavg' present to get loadavg;
694 # if it is not present it returns 0, which means no load checking.
695 sub get_loadavg {
696         if( -e '/proc/loadavg' ){
697                 open my $fd, '<', '/proc/loadavg'
698                         or return 0;
699                 my @load = split(/\s+/, scalar <$fd>);
700                 close $fd;
702                 # The first three columns measure CPU and IO utilization of the last one,
703                 # five, and 10 minute periods.  The fourth column shows the number of
704                 # currently running processes and the total number of processes in the m/n
705                 # format.  The last column displays the last process ID used.
706                 return $load[0] || 0;
707         }
708         # additional checks for load average should go here for things that don't export
709         # /proc/loadavg
711         return 0;
714 # version of the core git binary
715 our $git_version;
716 sub evaluate_git_version {
717         our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";
718         $number_of_git_cmds++;
721 sub check_loadavg {
722         if (defined $maxload && get_loadavg() > $maxload) {
723                 die_error(503, "The load average on the server is too high");
724         }
727 # ======================================================================
728 # input validation and dispatch
730 # input parameters can be collected from a variety of sources (presently, CGI
731 # and PATH_INFO), so we define an %input_params hash that collects them all
732 # together during validation: this allows subsequent uses (e.g. href()) to be
733 # agnostic of the parameter origin
735 our %input_params = ();
737 # input parameters are stored with the long parameter name as key. This will
738 # also be used in the href subroutine to convert parameters to their CGI
739 # equivalent, and since the href() usage is the most frequent one, we store
740 # the name -> CGI key mapping here, instead of the reverse.
742 # XXX: Warning: If you touch this, check the search form for updating,
743 # too.
745 our @cgi_param_mapping = (
746         project => "p",
747         action => "a",
748         file_name => "f",
749         file_parent => "fp",
750         hash => "h",
751         hash_parent => "hp",
752         hash_base => "hb",
753         hash_parent_base => "hpb",
754         page => "pg",
755         order => "o",
756         searchtext => "s",
757         searchtype => "st",
758         snapshot_format => "sf",
759         extra_options => "opt",
760         search_use_regexp => "sr",
761         ctag => "by_tag",
762         diff_style => "ds",
763         project_filter => "pf",
764         # this must be last entry (for manipulation from JavaScript)
765         javascript => "js"
766 );
767 our %cgi_param_mapping = @cgi_param_mapping;
769 # we will also need to know the possible actions, for validation
770 our %actions = (
771         "blame" => \&git_blame,
772         "blame_incremental" => \&git_blame_incremental,
773         "blame_data" => \&git_blame_data,
774         "blobdiff" => \&git_blobdiff,
775         "blobdiff_plain" => \&git_blobdiff_plain,
776         "blob" => \&git_blob,
777         "blob_plain" => \&git_blob_plain,
778         "commitdiff" => \&git_commitdiff,
779         "commitdiff_plain" => \&git_commitdiff_plain,
780         "commit" => \&git_commit,
781         "forks" => \&git_forks,
782         "heads" => \&git_heads,
783         "history" => \&git_history,
784         "log" => \&git_log,
785         "patch" => \&git_patch,
786         "patches" => \&git_patches,
787         "remotes" => \&git_remotes,
788         "rss" => \&git_rss,
789         "atom" => \&git_atom,
790         "search" => \&git_search,
791         "search_help" => \&git_search_help,
792         "shortlog" => \&git_shortlog,
793         "summary" => \&git_summary,
794         "tag" => \&git_tag,
795         "tags" => \&git_tags,
796         "tree" => \&git_tree,
797         "snapshot" => \&git_snapshot,
798         "object" => \&git_object,
799         # those below don't need $project
800         "opml" => \&git_opml,
801         "project_list" => \&git_project_list,
802         "project_index" => \&git_project_index,
803 );
805 # finally, we have the hash of allowed extra_options for the commands that
806 # allow them
807 our %allowed_options = (
808         "--no-merges" => [ qw(rss atom log shortlog history) ],
809 );
811 # fill %input_params with the CGI parameters. All values except for 'opt'
812 # should be single values, but opt can be an array. We should probably
813 # build an array of parameters that can be multi-valued, but since for the time
814 # being it's only this one, we just single it out
815 sub evaluate_query_params {
816         our $cgi;
818         while (my ($name, $symbol) = each %cgi_param_mapping) {
819                 if ($symbol eq 'opt') {
820                         $input_params{$name} = [ map { decode_utf8($_) } $cgi->param($symbol) ];
821                 } else {
822                         $input_params{$name} = decode_utf8($cgi->param($symbol));
823                 }
824         }
827 # now read PATH_INFO and update the parameter list for missing parameters
828 sub evaluate_path_info {
829         return if defined $input_params{'project'};
830         return if !$path_info;
831         $path_info =~ s,^/+,,;
832         return if !$path_info;
834         # find which part of PATH_INFO is project
835         my $project = $path_info;
836         $project =~ s,/+$,,;
837         while ($project && !check_head_link("$projectroot/$project")) {
838                 $project =~ s,/*[^/]*$,,;
839         }
840         return unless $project;
841         $input_params{'project'} = $project;
843         # do not change any parameters if an action is given using the query string
844         return if $input_params{'action'};
845         $path_info =~ s,^\Q$project\E/*,,;
847         # next, check if we have an action
848         my $action = $path_info;
849         $action =~ s,/.*$,,;
850         if (exists $actions{$action}) {
851                 $path_info =~ s,^$action/*,,;
852                 $input_params{'action'} = $action;
853         }
855         # list of actions that want hash_base instead of hash, but can have no
856         # pathname (f) parameter
857         my @wants_base = (
858                 'tree',
859                 'history',
860         );
862         # we want to catch, among others
863         # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
864         my ($parentrefname, $parentpathname, $refname, $pathname) =
865                 ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);
867         # first, analyze the 'current' part
868         if (defined $pathname) {
869                 # we got "branch:filename" or "branch:dir/"
870                 # we could use git_get_type(branch:pathname), but:
871                 # - it needs $git_dir
872                 # - it does a git() call
873                 # - the convention of terminating directories with a slash
874                 #   makes it superfluous
875                 # - embedding the action in the PATH_INFO would make it even
876                 #   more superfluous
877                 $pathname =~ s,^/+,,;
878                 if (!$pathname || substr($pathname, -1) eq "/") {
879                         $input_params{'action'} ||= "tree";
880                         $pathname =~ s,/$,,;
881                 } else {
882                         # the default action depends on whether we had parent info
883                         # or not
884                         if ($parentrefname) {
885                                 $input_params{'action'} ||= "blobdiff_plain";
886                         } else {
887                                 $input_params{'action'} ||= "blob_plain";
888                         }
889                 }
890                 $input_params{'hash_base'} ||= $refname;
891                 $input_params{'file_name'} ||= $pathname;
892         } elsif (defined $refname) {
893                 # we got "branch". In this case we have to choose if we have to
894                 # set hash or hash_base.
895                 #
896                 # Most of the actions without a pathname only want hash to be
897                 # set, except for the ones specified in @wants_base that want
898                 # hash_base instead. It should also be noted that hand-crafted
899                 # links having 'history' as an action and no pathname or hash
900                 # set will fail, but that happens regardless of PATH_INFO.
901                 if (defined $parentrefname) {
902                         # if there is parent let the default be 'shortlog' action
903                         # (for http://git.example.com/repo.git/A..B links); if there
904                         # is no parent, dispatch will detect type of object and set
905                         # action appropriately if required (if action is not set)
906                         $input_params{'action'} ||= "shortlog";
907                 }
908                 if ($input_params{'action'} &&
909                     grep { $_ eq $input_params{'action'} } @wants_base) {
910                         $input_params{'hash_base'} ||= $refname;
911                 } else {
912                         $input_params{'hash'} ||= $refname;
913                 }
914         }
916         # next, handle the 'parent' part, if present
917         if (defined $parentrefname) {
918                 # a missing pathspec defaults to the 'current' filename, allowing e.g.
919                 # someproject/blobdiff/oldrev..newrev:/filename
920                 if ($parentpathname) {
921                         $parentpathname =~ s,^/+,,;
922                         $parentpathname =~ s,/$,,;
923                         $input_params{'file_parent'} ||= $parentpathname;
924                 } else {
925                         $input_params{'file_parent'} ||= $input_params{'file_name'};
926                 }
927                 # we assume that hash_parent_base is wanted if a path was specified,
928                 # or if the action wants hash_base instead of hash
929                 if (defined $input_params{'file_parent'} ||
930                         grep { $_ eq $input_params{'action'} } @wants_base) {
931                         $input_params{'hash_parent_base'} ||= $parentrefname;
932                 } else {
933                         $input_params{'hash_parent'} ||= $parentrefname;
934                 }
935         }
937         # for the snapshot action, we allow URLs in the form
938         # $project/snapshot/$hash.ext
939         # where .ext determines the snapshot and gets removed from the
940         # passed $refname to provide the $hash.
941         #
942         # To be able to tell that $refname includes the format extension, we
943         # require the following two conditions to be satisfied:
944         # - the hash input parameter MUST have been set from the $refname part
945         #   of the URL (i.e. they must be equal)
946         # - the snapshot format MUST NOT have been defined already (e.g. from
947         #   CGI parameter sf)
948         # It's also useless to try any matching unless $refname has a dot,
949         # so we check for that too
950         if (defined $input_params{'action'} &&
951                 $input_params{'action'} eq 'snapshot' &&
952                 defined $refname && index($refname, '.') != -1 &&
953                 $refname eq $input_params{'hash'} &&
954                 !defined $input_params{'snapshot_format'}) {
955                 # We loop over the known snapshot formats, checking for
956                 # extensions. Allowed extensions are both the defined suffix
957                 # (which includes the initial dot already) and the snapshot
958                 # format key itself, with a prepended dot
959                 while (my ($fmt, $opt) = each %known_snapshot_formats) {
960                         my $hash = $refname;
961                         unless ($hash =~ s/(\Q$opt->{'suffix'}\E|\Q.$fmt\E)$//) {
962                                 next;
963                         }
964                         my $sfx = $1;
965                         # a valid suffix was found, so set the snapshot format
966                         # and reset the hash parameter
967                         $input_params{'snapshot_format'} = $fmt;
968                         $input_params{'hash'} = $hash;
969                         # we also set the format suffix to the one requested
970                         # in the URL: this way a request for e.g. .tgz returns
971                         # a .tgz instead of a .tar.gz
972                         $known_snapshot_formats{$fmt}{'suffix'} = $sfx;
973                         last;
974                 }
975         }
978 our ($action, $project, $file_name, $file_parent, $hash, $hash_parent, $hash_base,
979      $hash_parent_base, @extra_options, $page, $searchtype, $search_use_regexp,
980      $searchtext, $search_regexp, $project_filter);
981 sub evaluate_and_validate_params {
982         our $action = $input_params{'action'};
983         if (defined $action) {
984                 if (!validate_action($action)) {
985                         die_error(400, "Invalid action parameter");
986                 }
987         }
989         # parameters which are pathnames
990         our $project = $input_params{'project'};
991         if (defined $project) {
992                 if (!validate_project($project)) {
993                         undef $project;
994                         die_error(404, "No such project");
995                 }
996         }
998         our $project_filter = $input_params{'project_filter'};
999         if (defined $project_filter) {
1000                 if (!validate_pathname($project_filter)) {
1001                         die_error(404, "Invalid project_filter parameter");
1002                 }
1003         }
1005         our $file_name = $input_params{'file_name'};
1006         if (defined $file_name) {
1007                 if (!validate_pathname($file_name)) {
1008                         die_error(400, "Invalid file parameter");
1009                 }
1010         }
1012         our $file_parent = $input_params{'file_parent'};
1013         if (defined $file_parent) {
1014                 if (!validate_pathname($file_parent)) {
1015                         die_error(400, "Invalid file parent parameter");
1016                 }
1017         }
1019         # parameters which are refnames
1020         our $hash = $input_params{'hash'};
1021         if (defined $hash) {
1022                 if (!validate_refname($hash)) {
1023                         die_error(400, "Invalid hash parameter");
1024                 }
1025         }
1027         our $hash_parent = $input_params{'hash_parent'};
1028         if (defined $hash_parent) {
1029                 if (!validate_refname($hash_parent)) {
1030                         die_error(400, "Invalid hash parent parameter");
1031                 }
1032         }
1034         our $hash_base = $input_params{'hash_base'};
1035         if (defined $hash_base) {
1036                 if (!validate_refname($hash_base)) {
1037                         die_error(400, "Invalid hash base parameter");
1038                 }
1039         }
1041         our @extra_options = @{$input_params{'extra_options'}};
1042         # @extra_options is always defined, since it can only be (currently) set from
1043         # CGI, and $cgi->param() returns the empty array in array context if the param
1044         # is not set
1045         foreach my $opt (@extra_options) {
1046                 if (not exists $allowed_options{$opt}) {
1047                         die_error(400, "Invalid option parameter");
1048                 }
1049                 if (not grep(/^$action$/, @{$allowed_options{$opt}})) {
1050                         die_error(400, "Invalid option parameter for this action");
1051                 }
1052         }
1054         our $hash_parent_base = $input_params{'hash_parent_base'};
1055         if (defined $hash_parent_base) {
1056                 if (!validate_refname($hash_parent_base)) {
1057                         die_error(400, "Invalid hash parent base parameter");
1058                 }
1059         }
1061         # other parameters
1062         our $page = $input_params{'page'};
1063         if (defined $page) {
1064                 if ($page =~ m/[^0-9]/) {
1065                         die_error(400, "Invalid page parameter");
1066                 }
1067         }
1069         our $searchtype = $input_params{'searchtype'};
1070         if (defined $searchtype) {
1071                 if ($searchtype =~ m/[^a-z]/) {
1072                         die_error(400, "Invalid searchtype parameter");
1073                 }
1074         }
1076         our $search_use_regexp = $input_params{'search_use_regexp'};
1078         our $searchtext = $input_params{'searchtext'};
1079         our $search_regexp;
1080         if (defined $searchtext) {
1081                 if (length($searchtext) < 2) {
1082                         die_error(403, "At least two characters are required for search parameter");
1083                 }
1084                 $search_regexp = $search_use_regexp ? $searchtext : quotemeta $searchtext;
1085         }
1088 # path to the current git repository
1089 our $git_dir;
1090 sub evaluate_git_dir {
1091         our $git_dir = "$projectroot/$project" if $project;
1094 our (@snapshot_fmts, $git_avatar);
1095 sub configure_gitweb_features {
1096         # list of supported snapshot formats
1097         our @snapshot_fmts = gitweb_get_feature('snapshot');
1098         @snapshot_fmts = filter_snapshot_fmts(@snapshot_fmts);
1100         # check that the avatar feature is set to a known provider name,
1101         # and for each provider check if the dependencies are satisfied.
1102         # if the provider name is invalid or the dependencies are not met,
1103         # reset $git_avatar to the empty string.
1104         our ($git_avatar) = gitweb_get_feature('avatar');
1105         if ($git_avatar eq 'gravatar') {
1106                 $git_avatar = '' unless (eval { require Digest::MD5; 1; });
1107         } elsif ($git_avatar eq 'picon') {
1108                 # no dependencies
1109         } else {
1110                 $git_avatar = '';
1111         }
1114 # custom error handler: 'die <message>' is Internal Server Error
1115 sub handle_errors_html {
1116         my $msg = shift; # it is already HTML escaped
1118         # to avoid infinite loop where error occurs in die_error,
1119         # change handler to default handler, disabling handle_errors_html
1120         set_message("Error occured when inside die_error:\n$msg");
1122         # you cannot jump out of die_error when called as error handler;
1123         # the subroutine set via CGI::Carp::set_message is called _after_
1124         # HTTP headers are already written, so it cannot write them itself
1125         die_error(undef, undef, $msg, -error_handler => 1, -no_http_header => 1);
1127 set_message(\&handle_errors_html);
1129 # dispatch
1130 sub dispatch {
1131         if (!defined $action) {
1132                 if (defined $hash) {
1133                         $action = git_get_type($hash);
1134                         $action or die_error(404, "Object does not exist");
1135                 } elsif (defined $hash_base && defined $file_name) {
1136                         $action = git_get_type("$hash_base:$file_name");
1137                         $action or die_error(404, "File or directory does not exist");
1138                 } elsif (defined $project) {
1139                         $action = 'summary';
1140                 } else {
1141                         $action = 'project_list';
1142                 }
1143         }
1144         if (!defined($actions{$action})) {
1145                 die_error(400, "Unknown action");
1146         }
1147         if ($action !~ m/^(?:opml|project_list|project_index)$/ &&
1148             !$project) {
1149                 die_error(400, "Project needed");
1150         }
1151         $actions{$action}->();
1154 sub reset_timer {
1155         our $t0 = [ gettimeofday() ]
1156                 if defined $t0;
1157         our $number_of_git_cmds = 0;
1160 our $first_request = 1;
1161 sub run_request {
1162         reset_timer();
1164         evaluate_uri();
1165         if ($first_request) {
1166                 evaluate_gitweb_config();
1167                 evaluate_git_version();
1168         }
1169         if ($per_request_config) {
1170                 if (ref($per_request_config) eq 'CODE') {
1171                         $per_request_config->();
1172                 } elsif (!$first_request) {
1173                         evaluate_gitweb_config();
1174                 }
1175         }
1176         check_loadavg();
1178         # $projectroot and $projects_list might be set in gitweb config file
1179         $projects_list ||= $projectroot;
1181         evaluate_query_params();
1182         evaluate_path_info();
1183         evaluate_and_validate_params();
1184         evaluate_git_dir();
1186         configure_gitweb_features();
1188         dispatch();
1191 our $is_last_request = sub { 1 };
1192 our ($pre_dispatch_hook, $post_dispatch_hook, $pre_listen_hook);
1193 our $CGI = 'CGI';
1194 our $cgi;
1195 sub configure_as_fcgi {
1196         require CGI::Fast;
1197         our $CGI = 'CGI::Fast';
1199         my $request_number = 0;
1200         # let each child service 100 requests
1201         our $is_last_request = sub { ++$request_number > 100 };
1203 sub evaluate_argv {
1204         my $script_name = $ENV{'SCRIPT_NAME'} || $ENV{'SCRIPT_FILENAME'} || __FILE__;
1205         configure_as_fcgi()
1206                 if $script_name =~ /\.fcgi$/;
1208         return unless (@ARGV);
1210         require Getopt::Long;
1211         Getopt::Long::GetOptions(
1212                 'fastcgi|fcgi|f' => \&configure_as_fcgi,
1213                 'nproc|n=i' => sub {
1214                         my ($arg, $val) = @_;
1215                         return unless eval { require FCGI::ProcManager; 1; };
1216                         my $proc_manager = FCGI::ProcManager->new({
1217                                 n_processes => $val,
1218                         });
1219                         our $pre_listen_hook    = sub { $proc_manager->pm_manage()        };
1220                         our $pre_dispatch_hook  = sub { $proc_manager->pm_pre_dispatch()  };
1221                         our $post_dispatch_hook = sub { $proc_manager->pm_post_dispatch() };
1222                 },
1223         );
1226 sub run {
1227         evaluate_argv();
1229         $first_request = 1;
1230         $pre_listen_hook->()
1231                 if $pre_listen_hook;
1233  REQUEST:
1234         while ($cgi = $CGI->new()) {
1235                 $pre_dispatch_hook->()
1236                         if $pre_dispatch_hook;
1238                 run_request();
1240                 $post_dispatch_hook->()
1241                         if $post_dispatch_hook;
1242                 $first_request = 0;
1244                 last REQUEST if ($is_last_request->());
1245         }
1247  DONE_GITWEB:
1248         1;
1251 run();
1253 if (defined caller) {
1254         # wrapped in a subroutine processing requests,
1255         # e.g. mod_perl with ModPerl::Registry, or PSGI with Plack::App::WrapCGI
1256         return;
1257 } else {
1258         # pure CGI script, serving single request
1259         exit;
1262 ## ======================================================================
1263 ## action links
1265 # possible values of extra options
1266 # -full => 0|1      - use absolute/full URL ($my_uri/$my_url as base)
1267 # -replay => 1      - start from a current view (replay with modifications)
1268 # -path_info => 0|1 - don't use/use path_info URL (if possible)
1269 # -anchor => ANCHOR - add #ANCHOR to end of URL, implies -replay if used alone
1270 sub href {
1271         my %params = @_;
1272         # default is to use -absolute url() i.e. $my_uri
1273         my $href = $params{-full} ? $my_url : $my_uri;
1275         # implicit -replay, must be first of implicit params
1276         $params{-replay} = 1 if (keys %params == 1 && $params{-anchor});
1278         $params{'project'} = $project unless exists $params{'project'};
1280         if ($params{-replay}) {
1281                 while (my ($name, $symbol) = each %cgi_param_mapping) {
1282                         if (!exists $params{$name}) {
1283                                 $params{$name} = $input_params{$name};
1284                         }
1285                 }
1286         }
1288         my $use_pathinfo = gitweb_check_feature('pathinfo');
1289         if (defined $params{'project'} &&
1290             (exists $params{-path_info} ? $params{-path_info} : $use_pathinfo)) {
1291                 # try to put as many parameters as possible in PATH_INFO:
1292                 #   - project name
1293                 #   - action
1294                 #   - hash_parent or hash_parent_base:/file_parent
1295                 #   - hash or hash_base:/filename
1296                 #   - the snapshot_format as an appropriate suffix
1298                 # When the script is the root DirectoryIndex for the domain,
1299                 # $href here would be something like http://gitweb.example.com/
1300                 # Thus, we strip any trailing / from $href, to spare us double
1301                 # slashes in the final URL
1302                 $href =~ s,/$,,;
1304                 # Then add the project name, if present
1305                 $href .= "/".esc_path_info($params{'project'});
1306                 delete $params{'project'};
1308                 # since we destructively absorb parameters, we keep this
1309                 # boolean that remembers if we're handling a snapshot
1310                 my $is_snapshot = $params{'action'} eq 'snapshot';
1312                 # Summary just uses the project path URL, any other action is
1313                 # added to the URL
1314                 if (defined $params{'action'}) {
1315                         $href .= "/".esc_path_info($params{'action'})
1316                                 unless $params{'action'} eq 'summary';
1317                         delete $params{'action'};
1318                 }
1320                 # Next, we put hash_parent_base:/file_parent..hash_base:/file_name,
1321                 # stripping nonexistent or useless pieces
1322                 $href .= "/" if ($params{'hash_base'} || $params{'hash_parent_base'}
1323                         || $params{'hash_parent'} || $params{'hash'});
1324                 if (defined $params{'hash_base'}) {
1325                         if (defined $params{'hash_parent_base'}) {
1326                                 $href .= esc_path_info($params{'hash_parent_base'});
1327                                 # skip the file_parent if it's the same as the file_name
1328                                 if (defined $params{'file_parent'}) {
1329                                         if (defined $params{'file_name'} && $params{'file_parent'} eq $params{'file_name'}) {
1330                                                 delete $params{'file_parent'};
1331                                         } elsif ($params{'file_parent'} !~ /\.\./) {
1332                                                 $href .= ":/".esc_path_info($params{'file_parent'});
1333                                                 delete $params{'file_parent'};
1334                                         }
1335                                 }
1336                                 $href .= "..";
1337                                 delete $params{'hash_parent'};
1338                                 delete $params{'hash_parent_base'};
1339                         } elsif (defined $params{'hash_parent'}) {
1340                                 $href .= esc_path_info($params{'hash_parent'}). "..";
1341                                 delete $params{'hash_parent'};
1342                         }
1344                         $href .= esc_path_info($params{'hash_base'});
1345                         if (defined $params{'file_name'} && $params{'file_name'} !~ /\.\./) {
1346                                 $href .= ":/".esc_path_info($params{'file_name'});
1347                                 delete $params{'file_name'};
1348                         }
1349                         delete $params{'hash'};
1350                         delete $params{'hash_base'};
1351                 } elsif (defined $params{'hash'}) {
1352                         $href .= esc_path_info($params{'hash'});
1353                         delete $params{'hash'};
1354                 }
1356                 # If the action was a snapshot, we can absorb the
1357                 # snapshot_format parameter too
1358                 if ($is_snapshot) {
1359                         my $fmt = $params{'snapshot_format'};
1360                         # snapshot_format should always be defined when href()
1361                         # is called, but just in case some code forgets, we
1362                         # fall back to the default
1363                         $fmt ||= $snapshot_fmts[0];
1364                         $href .= $known_snapshot_formats{$fmt}{'suffix'};
1365                         delete $params{'snapshot_format'};
1366                 }
1367         }
1369         # now encode the parameters explicitly
1370         my @result = ();
1371         for (my $i = 0; $i < @cgi_param_mapping; $i += 2) {
1372                 my ($name, $symbol) = ($cgi_param_mapping[$i], $cgi_param_mapping[$i+1]);
1373                 if (defined $params{$name}) {
1374                         if (ref($params{$name}) eq "ARRAY") {
1375                                 foreach my $par (@{$params{$name}}) {
1376                                         push @result, $symbol . "=" . esc_param($par);
1377                                 }
1378                         } else {
1379                                 push @result, $symbol . "=" . esc_param($params{$name});
1380                         }
1381                 }
1382         }
1383         $href .= "?" . join(';', @result) if scalar @result;
1385         # final transformation: trailing spaces must be escaped (URI-encoded)
1386         $href =~ s/(\s+)$/CGI::escape($1)/e;
1388         if ($params{-anchor}) {
1389                 $href .= "#".esc_param($params{-anchor});
1390         }
1392         return $href;
1396 ## ======================================================================
1397 ## validation, quoting/unquoting and escaping
1399 sub validate_action {
1400         my $input = shift || return undef;
1401         return undef unless exists $actions{$input};
1402         return $input;
1405 sub validate_project {
1406         my $input = shift || return undef;
1407         if (!validate_pathname($input) ||
1408                 !(-d "$projectroot/$input") ||
1409                 !check_export_ok("$projectroot/$input") ||
1410                 ($strict_export && !project_in_list($input))) {
1411                 return undef;
1412         } else {
1413                 return $input;
1414         }
1417 sub validate_pathname {
1418         my $input = shift || return undef;
1420         # no '.' or '..' as elements of path, i.e. no '.' nor '..'
1421         # at the beginning, at the end, and between slashes.
1422         # also this catches doubled slashes
1423         if ($input =~ m!(^|/)(|\.|\.\.)(/|$)!) {
1424                 return undef;
1425         }
1426         # no null characters
1427         if ($input =~ m!\0!) {
1428                 return undef;
1429         }
1430         return $input;
1433 sub validate_refname {
1434         my $input = shift || return undef;
1436         # textual hashes are O.K.
1437         if ($input =~ m/^[0-9a-fA-F]{40}$/) {
1438                 return $input;
1439         }
1440         # it must be correct pathname
1441         $input = validate_pathname($input)
1442                 or return undef;
1443         # restrictions on ref name according to git-check-ref-format
1444         if ($input =~ m!(/\.|\.\.|[\000-\040\177 ~^:?*\[]|/$)!) {
1445                 return undef;
1446         }
1447         return $input;
1450 # decode sequences of octets in utf8 into Perl's internal form,
1451 # which is utf-8 with utf8 flag set if needed.  gitweb writes out
1452 # in utf-8 thanks to "binmode STDOUT, ':utf8'" at beginning
1453 sub to_utf8 {
1454         my $str = shift;
1455         return undef unless defined $str;
1457         if (utf8::is_utf8($str) || utf8::decode($str)) {
1458                 return $str;
1459         } else {
1460                 return decode($fallback_encoding, $str, Encode::FB_DEFAULT);
1461         }
1464 # quote unsafe chars, but keep the slash, even when it's not
1465 # correct, but quoted slashes look too horrible in bookmarks
1466 sub esc_param {
1467         my $str = shift;
1468         return undef unless defined $str;
1469         $str =~ s/([^A-Za-z0-9\-_.~()\/:@ ]+)/CGI::escape($1)/eg;
1470         $str =~ s/ /\+/g;
1471         return $str;
1474 # the quoting rules for path_info fragment are slightly different
1475 sub esc_path_info {
1476         my $str = shift;
1477         return undef unless defined $str;
1479         # path_info doesn't treat '+' as space (specially), but '?' must be escaped
1480         $str =~ s/([^A-Za-z0-9\-_.~();\/;:@&= +]+)/CGI::escape($1)/eg;
1482         return $str;
1485 # quote unsafe chars in whole URL, so some characters cannot be quoted
1486 sub esc_url {
1487         my $str = shift;
1488         return undef unless defined $str;
1489         $str =~ s/([^A-Za-z0-9\-_.~();\/;?:@&= ]+)/CGI::escape($1)/eg;
1490         $str =~ s/ /\+/g;
1491         return $str;
1494 # quote unsafe characters in HTML attributes
1495 sub esc_attr {
1497         # for XHTML conformance escaping '"' to '&quot;' is not enough
1498         return esc_html(@_);
1501 # replace invalid utf8 character with SUBSTITUTION sequence
1502 sub esc_html {
1503         my $str = shift;
1504         my %opts = @_;
1506         return undef unless defined $str;
1508         $str = to_utf8($str);
1509         $str = $cgi->escapeHTML($str);
1510         if ($opts{'-nbsp'}) {
1511                 $str =~ s/ /&nbsp;/g;
1512         }
1513         $str =~ s|([[:cntrl:]])|(($1 ne "\t") ? quot_cec($1) : $1)|eg;
1514         return $str;
1517 # quote control characters and escape filename to HTML
1518 sub esc_path {
1519         my $str = shift;
1520         my %opts = @_;
1522         return undef unless defined $str;
1524         $str = to_utf8($str);
1525         $str = $cgi->escapeHTML($str);
1526         if ($opts{'-nbsp'}) {
1527                 $str =~ s/ /&nbsp;/g;
1528         }
1529         $str =~ s|([[:cntrl:]])|quot_cec($1)|eg;
1530         return $str;
1533 # Sanitize for use in XHTML + application/xml+xhtm (valid XML 1.0)
1534 sub sanitize {
1535         my $str = shift;
1537         return undef unless defined $str;
1539         $str = to_utf8($str);
1540         $str =~ s|([[:cntrl:]])|($1 =~ /[\t\n\r]/ ? $1 : quot_cec($1))|eg;
1541         return $str;
1544 # Make control characters "printable", using character escape codes (CEC)
1545 sub quot_cec {
1546         my $cntrl = shift;
1547         my %opts = @_;
1548         my %es = ( # character escape codes, aka escape sequences
1549                 "\t" => '\t',   # tab            (HT)
1550                 "\n" => '\n',   # line feed      (LF)
1551                 "\r" => '\r',   # carrige return (CR)
1552                 "\f" => '\f',   # form feed      (FF)
1553                 "\b" => '\b',   # backspace      (BS)
1554                 "\a" => '\a',   # alarm (bell)   (BEL)
1555                 "\e" => '\e',   # escape         (ESC)
1556                 "\013" => '\v', # vertical tab   (VT)
1557                 "\000" => '\0', # nul character  (NUL)
1558         );
1559         my $chr = ( (exists $es{$cntrl})
1560                     ? $es{$cntrl}
1561                     : sprintf('\%2x', ord($cntrl)) );
1562         if ($opts{-nohtml}) {
1563                 return $chr;
1564         } else {
1565                 return "<span class=\"cntrl\">$chr</span>";
1566         }
1569 # Alternatively use unicode control pictures codepoints,
1570 # Unicode "printable representation" (PR)
1571 sub quot_upr {
1572         my $cntrl = shift;
1573         my %opts = @_;
1575         my $chr = sprintf('&#%04d;', 0x2400+ord($cntrl));
1576         if ($opts{-nohtml}) {
1577                 return $chr;
1578         } else {
1579                 return "<span class=\"cntrl\">$chr</span>";
1580         }
1583 # git may return quoted and escaped filenames
1584 sub unquote {
1585         my $str = shift;
1587         sub unq {
1588                 my $seq = shift;
1589                 my %es = ( # character escape codes, aka escape sequences
1590                         't' => "\t",   # tab            (HT, TAB)
1591                         'n' => "\n",   # newline        (NL)
1592                         'r' => "\r",   # return         (CR)
1593                         'f' => "\f",   # form feed      (FF)
1594                         'b' => "\b",   # backspace      (BS)
1595                         'a' => "\a",   # alarm (bell)   (BEL)
1596                         'e' => "\e",   # escape         (ESC)
1597                         'v' => "\013", # vertical tab   (VT)
1598                 );
1600                 if ($seq =~ m/^[0-7]{1,3}$/) {
1601                         # octal char sequence
1602                         return chr(oct($seq));
1603                 } elsif (exists $es{$seq}) {
1604                         # C escape sequence, aka character escape code
1605                         return $es{$seq};
1606                 }
1607                 # quoted ordinary character
1608                 return $seq;
1609         }
1611         if ($str =~ m/^"(.*)"$/) {
1612                 # needs unquoting
1613                 $str = $1;
1614                 $str =~ s/\\([^0-7]|[0-7]{1,3})/unq($1)/eg;
1615         }
1616         return $str;
1619 # escape tabs (convert tabs to spaces)
1620 sub untabify {
1621         my $line = shift;
1623         while ((my $pos = index($line, "\t")) != -1) {
1624                 if (my $count = (8 - ($pos % 8))) {
1625                         my $spaces = ' ' x $count;
1626                         $line =~ s/\t/$spaces/;
1627                 }
1628         }
1630         return $line;
1633 sub project_in_list {
1634         my $project = shift;
1635         my @list = git_get_projects_list();
1636         return @list && scalar(grep { $_->{'path'} eq $project } @list);
1639 ## ----------------------------------------------------------------------
1640 ## HTML aware string manipulation
1642 # Try to chop given string on a word boundary between position
1643 # $len and $len+$add_len. If there is no word boundary there,
1644 # chop at $len+$add_len. Do not chop if chopped part plus ellipsis
1645 # (marking chopped part) would be longer than given string.
1646 sub chop_str {
1647         my $str = shift;
1648         my $len = shift;
1649         my $add_len = shift || 10;
1650         my $where = shift || 'right'; # 'left' | 'center' | 'right'
1652         # Make sure perl knows it is utf8 encoded so we don't
1653         # cut in the middle of a utf8 multibyte char.
1654         $str = to_utf8($str);
1656         # allow only $len chars, but don't cut a word if it would fit in $add_len
1657         # if it doesn't fit, cut it if it's still longer than the dots we would add
1658         # remove chopped character entities entirely
1660         # when chopping in the middle, distribute $len into left and right part
1661         # return early if chopping wouldn't make string shorter
1662         if ($where eq 'center') {
1663                 return $str if ($len + 5 >= length($str)); # filler is length 5
1664                 $len = int($len/2);
1665         } else {
1666                 return $str if ($len + 4 >= length($str)); # filler is length 4
1667         }
1669         # regexps: ending and beginning with word part up to $add_len
1670         my $endre = qr/.{$len}\w{0,$add_len}/;
1671         my $begre = qr/\w{0,$add_len}.{$len}/;
1673         if ($where eq 'left') {
1674                 $str =~ m/^(.*?)($begre)$/;
1675                 my ($lead, $body) = ($1, $2);
1676                 if (length($lead) > 4) {
1677                         $lead = " ...";
1678                 }
1679                 return "$lead$body";
1681         } elsif ($where eq 'center') {
1682                 $str =~ m/^($endre)(.*)$/;
1683                 my ($left, $str)  = ($1, $2);
1684                 $str =~ m/^(.*?)($begre)$/;
1685                 my ($mid, $right) = ($1, $2);
1686                 if (length($mid) > 5) {
1687                         $mid = " ... ";
1688                 }
1689                 return "$left$mid$right";
1691         } else {
1692                 $str =~ m/^($endre)(.*)$/;
1693                 my $body = $1;
1694                 my $tail = $2;
1695                 if (length($tail) > 4) {
1696                         $tail = "... ";
1697                 }
1698                 return "$body$tail";
1699         }
1702 # takes the same arguments as chop_str, but also wraps a <span> around the
1703 # result with a title attribute if it does get chopped. Additionally, the
1704 # string is HTML-escaped.
1705 sub chop_and_escape_str {
1706         my ($str) = @_;
1708         my $chopped = chop_str(@_);
1709         $str = to_utf8($str);
1710         if ($chopped eq $str) {
1711                 return esc_html($chopped);
1712         } else {
1713                 $str =~ s/[[:cntrl:]]/?/g;
1714                 return $cgi->span({-title=>$str}, esc_html($chopped));
1715         }
1718 ## ----------------------------------------------------------------------
1719 ## functions returning short strings
1721 # CSS class for given age value (in seconds)
1722 sub age_class {
1723         my $age = shift;
1725         if (!defined $age) {
1726                 return "noage";
1727         } elsif ($age < 60*60*2) {
1728                 return "age0";
1729         } elsif ($age < 60*60*24*2) {
1730                 return "age1";
1731         } else {
1732                 return "age2";
1733         }
1736 # convert age in seconds to "nn units ago" string
1737 sub age_string {
1738         my $age = shift;
1739         my $age_str;
1741         if ($age > 60*60*24*365*2) {
1742                 $age_str = (int $age/60/60/24/365);
1743                 $age_str .= " years ago";
1744         } elsif ($age > 60*60*24*(365/12)*2) {
1745                 $age_str = int $age/60/60/24/(365/12);
1746                 $age_str .= " months ago";
1747         } elsif ($age > 60*60*24*7*2) {
1748                 $age_str = int $age/60/60/24/7;
1749                 $age_str .= " weeks ago";
1750         } elsif ($age > 60*60*24*2) {
1751                 $age_str = int $age/60/60/24;
1752                 $age_str .= " days ago";
1753         } elsif ($age > 60*60*2) {
1754                 $age_str = int $age/60/60;
1755                 $age_str .= " hours ago";
1756         } elsif ($age > 60*2) {
1757                 $age_str = int $age/60;
1758                 $age_str .= " min ago";
1759         } elsif ($age > 2) {
1760                 $age_str = int $age;
1761                 $age_str .= " sec ago";
1762         } else {
1763                 $age_str .= " right now";
1764         }
1765         return $age_str;
1768 use constant {
1769         S_IFINVALID => 0030000,
1770         S_IFGITLINK => 0160000,
1771 };
1773 # submodule/subproject, a commit object reference
1774 sub S_ISGITLINK {
1775         my $mode = shift;
1777         return (($mode & S_IFMT) == S_IFGITLINK)
1780 # convert file mode in octal to symbolic file mode string
1781 sub mode_str {
1782         my $mode = oct shift;
1784         if (S_ISGITLINK($mode)) {
1785                 return 'm---------';
1786         } elsif (S_ISDIR($mode & S_IFMT)) {
1787                 return 'drwxr-xr-x';
1788         } elsif (S_ISLNK($mode)) {
1789                 return 'lrwxrwxrwx';
1790         } elsif (S_ISREG($mode)) {
1791                 # git cares only about the executable bit
1792                 if ($mode & S_IXUSR) {
1793                         return '-rwxr-xr-x';
1794                 } else {
1795                         return '-rw-r--r--';
1796                 };
1797         } else {
1798                 return '----------';
1799         }
1802 # convert file mode in octal to file type string
1803 sub file_type {
1804         my $mode = shift;
1806         if ($mode !~ m/^[0-7]+$/) {
1807                 return $mode;
1808         } else {
1809                 $mode = oct $mode;
1810         }
1812         if (S_ISGITLINK($mode)) {
1813                 return "submodule";
1814         } elsif (S_ISDIR($mode & S_IFMT)) {
1815                 return "directory";
1816         } elsif (S_ISLNK($mode)) {
1817                 return "symlink";
1818         } elsif (S_ISREG($mode)) {
1819                 return "file";
1820         } else {
1821                 return "unknown";
1822         }
1825 # convert file mode in octal to file type description string
1826 sub file_type_long {
1827         my $mode = shift;
1829         if ($mode !~ m/^[0-7]+$/) {
1830                 return $mode;
1831         } else {
1832                 $mode = oct $mode;
1833         }
1835         if (S_ISGITLINK($mode)) {
1836                 return "submodule";
1837         } elsif (S_ISDIR($mode & S_IFMT)) {
1838                 return "directory";
1839         } elsif (S_ISLNK($mode)) {
1840                 return "symlink";
1841         } elsif (S_ISREG($mode)) {
1842                 if ($mode & S_IXUSR) {
1843                         return "executable";
1844                 } else {
1845                         return "file";
1846                 };
1847         } else {
1848                 return "unknown";
1849         }
1853 ## ----------------------------------------------------------------------
1854 ## functions returning short HTML fragments, or transforming HTML fragments
1855 ## which don't belong to other sections
1857 # format line of commit message.
1858 sub format_log_line_html {
1859         my $line = shift;
1861         $line = esc_html($line, -nbsp=>1);
1862         $line =~ s{\b([0-9a-fA-F]{8,40})\b}{
1863                 $cgi->a({-href => href(action=>"object", hash=>$1),
1864                                         -class => "text"}, $1);
1865         }eg;
1867         return $line;
1870 # format marker of refs pointing to given object
1872 # the destination action is chosen based on object type and current context:
1873 # - for annotated tags, we choose the tag view unless it's the current view
1874 #   already, in which case we go to shortlog view
1875 # - for other refs, we keep the current view if we're in history, shortlog or
1876 #   log view, and select shortlog otherwise
1877 sub format_ref_marker {
1878         my ($refs, $id) = @_;
1879         my $markers = '';
1881         if (defined $refs->{$id}) {
1882                 foreach my $ref (@{$refs->{$id}}) {
1883                         # this code exploits the fact that non-lightweight tags are the
1884                         # only indirect objects, and that they are the only objects for which
1885                         # we want to use tag instead of shortlog as action
1886                         my ($type, $name) = qw();
1887                         my $indirect = ($ref =~ s/\^\{\}$//);
1888                         # e.g. tags/v2.6.11 or heads/next
1889                         if ($ref =~ m!^(.*?)s?/(.*)$!) {
1890                                 $type = $1;
1891                                 $name = $2;
1892                         } else {
1893                                 $type = "ref";
1894                                 $name = $ref;
1895                         }
1897                         my $class = $type;
1898                         $class .= " indirect" if $indirect;
1900                         my $dest_action = "shortlog";
1902                         if ($indirect) {
1903                                 $dest_action = "tag" unless $action eq "tag";
1904                         } elsif ($action =~ /^(history|(short)?log)$/) {
1905                                 $dest_action = $action;
1906                         }
1908                         my $dest = "";
1909                         $dest .= "refs/" unless $ref =~ m!^refs/!;
1910                         $dest .= $ref;
1912                         my $link = $cgi->a({
1913                                 -href => href(
1914                                         action=>$dest_action,
1915                                         hash=>$dest
1916                                 )}, $name);
1918                         $markers .= " <span class=\"".esc_attr($class)."\" title=\"".esc_attr($ref)."\">" .
1919                                 $link . "</span>";
1920                 }
1921         }
1923         if ($markers) {
1924                 return ' <span class="refs">'. $markers . '</span>';
1925         } else {
1926                 return "";
1927         }
1930 # format, perhaps shortened and with markers, title line
1931 sub format_subject_html {
1932         my ($long, $short, $href, $extra) = @_;
1933         $extra = '' unless defined($extra);
1935         if (length($short) < length($long)) {
1936                 $long =~ s/[[:cntrl:]]/?/g;
1937                 return $cgi->a({-href => $href, -class => "list subject",
1938                                 -title => to_utf8($long)},
1939                        esc_html($short)) . $extra;
1940         } else {
1941                 return $cgi->a({-href => $href, -class => "list subject"},
1942                        esc_html($long)) . $extra;
1943         }
1946 # Rather than recomputing the url for an email multiple times, we cache it
1947 # after the first hit. This gives a visible benefit in views where the avatar
1948 # for the same email is used repeatedly (e.g. shortlog).
1949 # The cache is shared by all avatar engines (currently gravatar only), which
1950 # are free to use it as preferred. Since only one avatar engine is used for any
1951 # given page, there's no risk for cache conflicts.
1952 our %avatar_cache = ();
1954 # Compute the picon url for a given email, by using the picon search service over at
1955 # http://www.cs.indiana.edu/picons/search.html
1956 sub picon_url {
1957         my $email = lc shift;
1958         if (!$avatar_cache{$email}) {
1959                 my ($user, $domain) = split('@', $email);
1960                 $avatar_cache{$email} =
1961                         "http://www.cs.indiana.edu/cgi-pub/kinzler/piconsearch.cgi/" .
1962                         "$domain/$user/" .
1963                         "users+domains+unknown/up/single";
1964         }
1965         return $avatar_cache{$email};
1968 # Compute the gravatar url for a given email, if it's not in the cache already.
1969 # Gravatar stores only the part of the URL before the size, since that's the
1970 # one computationally more expensive. This also allows reuse of the cache for
1971 # different sizes (for this particular engine).
1972 sub gravatar_url {
1973         my $email = lc shift;
1974         my $size = shift;
1975         $avatar_cache{$email} ||=
1976                 "http://www.gravatar.com/avatar/" .
1977                         Digest::MD5::md5_hex($email) . "?s=";
1978         return $avatar_cache{$email} . $size;
1981 # Insert an avatar for the given $email at the given $size if the feature
1982 # is enabled.
1983 sub git_get_avatar {
1984         my ($email, %opts) = @_;
1985         my $pre_white  = ($opts{-pad_before} ? "&nbsp;" : "");
1986         my $post_white = ($opts{-pad_after}  ? "&nbsp;" : "");
1987         $opts{-size} ||= 'default';
1988         my $size = $avatar_size{$opts{-size}} || $avatar_size{'default'};
1989         my $url = "";
1990         if ($git_avatar eq 'gravatar') {
1991                 $url = gravatar_url($email, $size);
1992         } elsif ($git_avatar eq 'picon') {
1993                 $url = picon_url($email);
1994         }
1995         # Other providers can be added by extending the if chain, defining $url
1996         # as needed. If no variant puts something in $url, we assume avatars
1997         # are completely disabled/unavailable.
1998         if ($url) {
1999                 return $pre_white .
2000                        "<img width=\"$size\" " .
2001                             "class=\"avatar\" " .
2002                             "src=\"".esc_url($url)."\" " .
2003                             "alt=\"\" " .
2004                        "/>" . $post_white;
2005         } else {
2006                 return "";
2007         }
2010 sub format_search_author {
2011         my ($author, $searchtype, $displaytext) = @_;
2012         my $have_search = gitweb_check_feature('search');
2014         if ($have_search) {
2015                 my $performed = "";
2016                 if ($searchtype eq 'author') {
2017                         $performed = "authored";
2018                 } elsif ($searchtype eq 'committer') {
2019                         $performed = "committed";
2020                 }
2022                 return $cgi->a({-href => href(action=>"search", hash=>$hash,
2023                                 searchtext=>$author,
2024                                 searchtype=>$searchtype), class=>"list",
2025                                 title=>"Search for commits $performed by $author"},
2026                                 $displaytext);
2028         } else {
2029                 return $displaytext;
2030         }
2033 # format the author name of the given commit with the given tag
2034 # the author name is chopped and escaped according to the other
2035 # optional parameters (see chop_str).
2036 sub format_author_html {
2037         my $tag = shift;
2038         my $co = shift;
2039         my $author = chop_and_escape_str($co->{'author_name'}, @_);
2040         return "<$tag class=\"author\">" .
2041                format_search_author($co->{'author_name'}, "author",
2042                        git_get_avatar($co->{'author_email'}, -pad_after => 1) .
2043                        $author) .
2044                "</$tag>";
2047 # format git diff header line, i.e. "diff --(git|combined|cc) ..."
2048 sub format_git_diff_header_line {
2049         my $line = shift;
2050         my $diffinfo = shift;
2051         my ($from, $to) = @_;
2053         if ($diffinfo->{'nparents'}) {
2054                 # combined diff
2055                 $line =~ s!^(diff (.*?) )"?.*$!$1!;
2056                 if ($to->{'href'}) {
2057                         $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2058                                          esc_path($to->{'file'}));
2059                 } else { # file was deleted (no href)
2060                         $line .= esc_path($to->{'file'});
2061                 }
2062         } else {
2063                 # "ordinary" diff
2064                 $line =~ s!^(diff (.*?) )"?a/.*$!$1!;
2065                 if ($from->{'href'}) {
2066                         $line .= $cgi->a({-href => $from->{'href'}, -class => "path"},
2067                                          'a/' . esc_path($from->{'file'}));
2068                 } else { # file was added (no href)
2069                         $line .= 'a/' . esc_path($from->{'file'});
2070                 }
2071                 $line .= ' ';
2072                 if ($to->{'href'}) {
2073                         $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2074                                          'b/' . esc_path($to->{'file'}));
2075                 } else { # file was deleted
2076                         $line .= 'b/' . esc_path($to->{'file'});
2077                 }
2078         }
2080         return "<div class=\"diff header\">$line</div>\n";
2083 # format extended diff header line, before patch itself
2084 sub format_extended_diff_header_line {
2085         my $line = shift;
2086         my $diffinfo = shift;
2087         my ($from, $to) = @_;
2089         # match <path>
2090         if ($line =~ s!^((copy|rename) from ).*$!$1! && $from->{'href'}) {
2091                 $line .= $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2092                                        esc_path($from->{'file'}));
2093         }
2094         if ($line =~ s!^((copy|rename) to ).*$!$1! && $to->{'href'}) {
2095                 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2096                                  esc_path($to->{'file'}));
2097         }
2098         # match single <mode>
2099         if ($line =~ m/\s(\d{6})$/) {
2100                 $line .= '<span class="info"> (' .
2101                          file_type_long($1) .
2102                          ')</span>';
2103         }
2104         # match <hash>
2105         if ($line =~ m/^index [0-9a-fA-F]{40},[0-9a-fA-F]{40}/) {
2106                 # can match only for combined diff
2107                 $line = 'index ';
2108                 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2109                         if ($from->{'href'}[$i]) {
2110                                 $line .= $cgi->a({-href=>$from->{'href'}[$i],
2111                                                   -class=>"hash"},
2112                                                  substr($diffinfo->{'from_id'}[$i],0,7));
2113                         } else {
2114                                 $line .= '0' x 7;
2115                         }
2116                         # separator
2117                         $line .= ',' if ($i < $diffinfo->{'nparents'} - 1);
2118                 }
2119                 $line .= '..';
2120                 if ($to->{'href'}) {
2121                         $line .= $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2122                                          substr($diffinfo->{'to_id'},0,7));
2123                 } else {
2124                         $line .= '0' x 7;
2125                 }
2127         } elsif ($line =~ m/^index [0-9a-fA-F]{40}..[0-9a-fA-F]{40}/) {
2128                 # can match only for ordinary diff
2129                 my ($from_link, $to_link);
2130                 if ($from->{'href'}) {
2131                         $from_link = $cgi->a({-href=>$from->{'href'}, -class=>"hash"},
2132                                              substr($diffinfo->{'from_id'},0,7));
2133                 } else {
2134                         $from_link = '0' x 7;
2135                 }
2136                 if ($to->{'href'}) {
2137                         $to_link = $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2138                                            substr($diffinfo->{'to_id'},0,7));
2139                 } else {
2140                         $to_link = '0' x 7;
2141                 }
2142                 my ($from_id, $to_id) = ($diffinfo->{'from_id'}, $diffinfo->{'to_id'});
2143                 $line =~ s!$from_id\.\.$to_id!$from_link..$to_link!;
2144         }
2146         return $line . "<br/>\n";
2149 # format from-file/to-file diff header
2150 sub format_diff_from_to_header {
2151         my ($from_line, $to_line, $diffinfo, $from, $to, @parents) = @_;
2152         my $line;
2153         my $result = '';
2155         $line = $from_line;
2156         #assert($line =~ m/^---/) if DEBUG;
2157         # no extra formatting for "^--- /dev/null"
2158         if (! $diffinfo->{'nparents'}) {
2159                 # ordinary (single parent) diff
2160                 if ($line =~ m!^--- "?a/!) {
2161                         if ($from->{'href'}) {
2162                                 $line = '--- a/' .
2163                                         $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2164                                                 esc_path($from->{'file'}));
2165                         } else {
2166                                 $line = '--- a/' .
2167                                         esc_path($from->{'file'});
2168                         }
2169                 }
2170                 $result .= qq!<div class="diff from_file">$line</div>\n!;
2172         } else {
2173                 # combined diff (merge commit)
2174                 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2175                         if ($from->{'href'}[$i]) {
2176                                 $line = '--- ' .
2177                                         $cgi->a({-href=>href(action=>"blobdiff",
2178                                                              hash_parent=>$diffinfo->{'from_id'}[$i],
2179                                                              hash_parent_base=>$parents[$i],
2180                                                              file_parent=>$from->{'file'}[$i],
2181                                                              hash=>$diffinfo->{'to_id'},
2182                                                              hash_base=>$hash,
2183                                                              file_name=>$to->{'file'}),
2184                                                  -class=>"path",
2185                                                  -title=>"diff" . ($i+1)},
2186                                                 $i+1) .
2187                                         '/' .
2188                                         $cgi->a({-href=>$from->{'href'}[$i], -class=>"path"},
2189                                                 esc_path($from->{'file'}[$i]));
2190                         } else {
2191                                 $line = '--- /dev/null';
2192                         }
2193                         $result .= qq!<div class="diff from_file">$line</div>\n!;
2194                 }
2195         }
2197         $line = $to_line;
2198         #assert($line =~ m/^\+\+\+/) if DEBUG;
2199         # no extra formatting for "^+++ /dev/null"
2200         if ($line =~ m!^\+\+\+ "?b/!) {
2201                 if ($to->{'href'}) {
2202                         $line = '+++ b/' .
2203                                 $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2204                                         esc_path($to->{'file'}));
2205                 } else {
2206                         $line = '+++ b/' .
2207                                 esc_path($to->{'file'});
2208                 }
2209         }
2210         $result .= qq!<div class="diff to_file">$line</div>\n!;
2212         return $result;
2215 # create note for patch simplified by combined diff
2216 sub format_diff_cc_simplified {
2217         my ($diffinfo, @parents) = @_;
2218         my $result = '';
2220         $result .= "<div class=\"diff header\">" .
2221                    "diff --cc ";
2222         if (!is_deleted($diffinfo)) {
2223                 $result .= $cgi->a({-href => href(action=>"blob",
2224                                                   hash_base=>$hash,
2225                                                   hash=>$diffinfo->{'to_id'},
2226                                                   file_name=>$diffinfo->{'to_file'}),
2227                                     -class => "path"},
2228                                    esc_path($diffinfo->{'to_file'}));
2229         } else {
2230                 $result .= esc_path($diffinfo->{'to_file'});
2231         }
2232         $result .= "</div>\n" . # class="diff header"
2233                    "<div class=\"diff nodifferences\">" .
2234                    "Simple merge" .
2235                    "</div>\n"; # class="diff nodifferences"
2237         return $result;
2240 sub diff_line_class {
2241         my ($line, $from, $to) = @_;
2243         # ordinary diff
2244         my $num_sign = 1;
2245         # combined diff
2246         if ($from && $to && ref($from->{'href'}) eq "ARRAY") {
2247                 $num_sign = scalar @{$from->{'href'}};
2248         }
2250         my @diff_line_classifier = (
2251                 { regexp => qr/^\@\@{$num_sign} /, class => "chunk_header"},
2252                 { regexp => qr/^\\/,               class => "incomplete"  },
2253                 { regexp => qr/^ {$num_sign}/,     class => "ctx" },
2254                 # classifier for context must come before classifier add/rem,
2255                 # or we would have to use more complicated regexp, for example
2256                 # qr/(?= {0,$m}\+)[+ ]{$num_sign}/, where $m = $num_sign - 1;
2257                 { regexp => qr/^[+ ]{$num_sign}/,   class => "add" },
2258                 { regexp => qr/^[- ]{$num_sign}/,   class => "rem" },
2259         );
2260         for my $clsfy (@diff_line_classifier) {
2261                 return $clsfy->{'class'}
2262                         if ($line =~ $clsfy->{'regexp'});
2263         }
2265         # fallback
2266         return "";
2269 # assumes that $from and $to are defined and correctly filled,
2270 # and that $line holds a line of chunk header for unified diff
2271 sub format_unidiff_chunk_header {
2272         my ($line, $from, $to) = @_;
2274         my ($from_text, $from_start, $from_lines, $to_text, $to_start, $to_lines, $section) =
2275                 $line =~ m/^\@{2} (-(\d+)(?:,(\d+))?) (\+(\d+)(?:,(\d+))?) \@{2}(.*)$/;
2277         $from_lines = 0 unless defined $from_lines;
2278         $to_lines   = 0 unless defined $to_lines;
2280         if ($from->{'href'}) {
2281                 $from_text = $cgi->a({-href=>"$from->{'href'}#l$from_start",
2282                                      -class=>"list"}, $from_text);
2283         }
2284         if ($to->{'href'}) {
2285                 $to_text   = $cgi->a({-href=>"$to->{'href'}#l$to_start",
2286                                      -class=>"list"}, $to_text);
2287         }
2288         $line = "<span class=\"chunk_info\">@@ $from_text $to_text @@</span>" .
2289                 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2290         return $line;
2293 # assumes that $from and $to are defined and correctly filled,
2294 # and that $line holds a line of chunk header for combined diff
2295 sub format_cc_diff_chunk_header {
2296         my ($line, $from, $to) = @_;
2298         my ($prefix, $ranges, $section) = $line =~ m/^(\@+) (.*?) \@+(.*)$/;
2299         my (@from_text, @from_start, @from_nlines, $to_text, $to_start, $to_nlines);
2301         @from_text = split(' ', $ranges);
2302         for (my $i = 0; $i < @from_text; ++$i) {
2303                 ($from_start[$i], $from_nlines[$i]) =
2304                         (split(',', substr($from_text[$i], 1)), 0);
2305         }
2307         $to_text   = pop @from_text;
2308         $to_start  = pop @from_start;
2309         $to_nlines = pop @from_nlines;
2311         $line = "<span class=\"chunk_info\">$prefix ";
2312         for (my $i = 0; $i < @from_text; ++$i) {
2313                 if ($from->{'href'}[$i]) {
2314                         $line .= $cgi->a({-href=>"$from->{'href'}[$i]#l$from_start[$i]",
2315                                           -class=>"list"}, $from_text[$i]);
2316                 } else {
2317                         $line .= $from_text[$i];
2318                 }
2319                 $line .= " ";
2320         }
2321         if ($to->{'href'}) {
2322                 $line .= $cgi->a({-href=>"$to->{'href'}#l$to_start",
2323                                   -class=>"list"}, $to_text);
2324         } else {
2325                 $line .= $to_text;
2326         }
2327         $line .= " $prefix</span>" .
2328                  "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2329         return $line;
2332 # process patch (diff) line (not to be used for diff headers),
2333 # returning class and HTML-formatted (but not wrapped) line
2334 sub process_diff_line {
2335         my $line = shift;
2336         my ($from, $to) = @_;
2338         my $diff_class = diff_line_class($line, $from, $to);
2340         chomp $line;
2341         $line = untabify($line);
2343         if ($from && $to && $line =~ m/^\@{2} /) {
2344                 $line = format_unidiff_chunk_header($line, $from, $to);
2345                 return $diff_class, $line;
2347         } elsif ($from && $to && $line =~ m/^\@{3}/) {
2348                 $line = format_cc_diff_chunk_header($line, $from, $to);
2349                 return $diff_class, $line;
2351         }
2352         return $diff_class, esc_html($line, -nbsp=>1);
2355 # Generates undef or something like "_snapshot_" or "snapshot (_tbz2_ _zip_)",
2356 # linked.  Pass the hash of the tree/commit to snapshot.
2357 sub format_snapshot_links {
2358         my ($hash) = @_;
2359         my $num_fmts = @snapshot_fmts;
2360         if ($num_fmts > 1) {
2361                 # A parenthesized list of links bearing format names.
2362                 # e.g. "snapshot (_tar.gz_ _zip_)"
2363                 return "snapshot (" . join(' ', map
2364                         $cgi->a({
2365                                 -href => href(
2366                                         action=>"snapshot",
2367                                         hash=>$hash,
2368                                         snapshot_format=>$_
2369                                 )
2370                         }, $known_snapshot_formats{$_}{'display'})
2371                 , @snapshot_fmts) . ")";
2372         } elsif ($num_fmts == 1) {
2373                 # A single "snapshot" link whose tooltip bears the format name.
2374                 # i.e. "_snapshot_"
2375                 my ($fmt) = @snapshot_fmts;
2376                 return
2377                         $cgi->a({
2378                                 -href => href(
2379                                         action=>"snapshot",
2380                                         hash=>$hash,
2381                                         snapshot_format=>$fmt
2382                                 ),
2383                                 -title => "in format: $known_snapshot_formats{$fmt}{'display'}"
2384                         }, "snapshot");
2385         } else { # $num_fmts == 0
2386                 return undef;
2387         }
2390 ## ......................................................................
2391 ## functions returning values to be passed, perhaps after some
2392 ## transformation, to other functions; e.g. returning arguments to href()
2394 # returns hash to be passed to href to generate gitweb URL
2395 # in -title key it returns description of link
2396 sub get_feed_info {
2397         my $format = shift || 'Atom';
2398         my %res = (action => lc($format));
2400         # feed links are possible only for project views
2401         return unless (defined $project);
2402         # some views should link to OPML, or to generic project feed,
2403         # or don't have specific feed yet (so they should use generic)
2404         return if (!$action || $action =~ /^(?:tags|heads|forks|tag|search)$/x);
2406         my $branch;
2407         # branches refs uses 'refs/heads/' prefix (fullname) to differentiate
2408         # from tag links; this also makes possible to detect branch links
2409         if ((defined $hash_base && $hash_base =~ m!^refs/heads/(.*)$!) ||
2410             (defined $hash      && $hash      =~ m!^refs/heads/(.*)$!)) {
2411                 $branch = $1;
2412         }
2413         # find log type for feed description (title)
2414         my $type = 'log';
2415         if (defined $file_name) {
2416                 $type  = "history of $file_name";
2417                 $type .= "/" if ($action eq 'tree');
2418                 $type .= " on '$branch'" if (defined $branch);
2419         } else {
2420                 $type = "log of $branch" if (defined $branch);
2421         }
2423         $res{-title} = $type;
2424         $res{'hash'} = (defined $branch ? "refs/heads/$branch" : undef);
2425         $res{'file_name'} = $file_name;
2427         return %res;
2430 ## ----------------------------------------------------------------------
2431 ## git utility subroutines, invoking git commands
2433 # returns path to the core git executable and the --git-dir parameter as list
2434 sub git_cmd {
2435         $number_of_git_cmds++;
2436         return $GIT, '--git-dir='.$git_dir;
2439 # quote the given arguments for passing them to the shell
2440 # quote_command("command", "arg 1", "arg with ' and ! characters")
2441 # => "'command' 'arg 1' 'arg with '\'' and '\!' characters'"
2442 # Try to avoid using this function wherever possible.
2443 sub quote_command {
2444         return join(' ',
2445                 map { my $a = $_; $a =~ s/(['!])/'\\$1'/g; "'$a'" } @_ );
2448 # get HEAD ref of given project as hash
2449 sub git_get_head_hash {
2450         return git_get_full_hash(shift, 'HEAD');
2453 sub git_get_full_hash {
2454         return git_get_hash(@_);
2457 sub git_get_short_hash {
2458         return git_get_hash(@_, '--short=7');
2461 sub git_get_hash {
2462         my ($project, $hash, @options) = @_;
2463         my $o_git_dir = $git_dir;
2464         my $retval = undef;
2465         $git_dir = "$projectroot/$project";
2466         if (open my $fd, '-|', git_cmd(), 'rev-parse',
2467             '--verify', '-q', @options, $hash) {
2468                 $retval = <$fd>;
2469                 chomp $retval if defined $retval;
2470                 close $fd;
2471         }
2472         if (defined $o_git_dir) {
2473                 $git_dir = $o_git_dir;
2474         }
2475         return $retval;
2478 # get type of given object
2479 sub git_get_type {
2480         my $hash = shift;
2482         open my $fd, "-|", git_cmd(), "cat-file", '-t', $hash or return;
2483         my $type = <$fd>;
2484         close $fd or return;
2485         chomp $type;
2486         return $type;
2489 # repository configuration
2490 our $config_file = '';
2491 our %config;
2493 # store multiple values for single key as anonymous array reference
2494 # single values stored directly in the hash, not as [ <value> ]
2495 sub hash_set_multi {
2496         my ($hash, $key, $value) = @_;
2498         if (!exists $hash->{$key}) {
2499                 $hash->{$key} = $value;
2500         } elsif (!ref $hash->{$key}) {
2501                 $hash->{$key} = [ $hash->{$key}, $value ];
2502         } else {
2503                 push @{$hash->{$key}}, $value;
2504         }
2507 # return hash of git project configuration
2508 # optionally limited to some section, e.g. 'gitweb'
2509 sub git_parse_project_config {
2510         my $section_regexp = shift;
2511         my %config;
2513         local $/ = "\0";
2515         open my $fh, "-|", git_cmd(), "config", '-z', '-l',
2516                 or return;
2518         while (my $keyval = <$fh>) {
2519                 chomp $keyval;
2520                 my ($key, $value) = split(/\n/, $keyval, 2);
2522                 hash_set_multi(\%config, $key, $value)
2523                         if (!defined $section_regexp || $key =~ /^(?:$section_regexp)\./o);
2524         }
2525         close $fh;
2527         return %config;
2530 # convert config value to boolean: 'true' or 'false'
2531 # no value, number > 0, 'true' and 'yes' values are true
2532 # rest of values are treated as false (never as error)
2533 sub config_to_bool {
2534         my $val = shift;
2536         return 1 if !defined $val;             # section.key
2538         # strip leading and trailing whitespace
2539         $val =~ s/^\s+//;
2540         $val =~ s/\s+$//;
2542         return (($val =~ /^\d+$/ && $val) ||   # section.key = 1
2543                 ($val =~ /^(?:true|yes)$/i));  # section.key = true
2546 # convert config value to simple decimal number
2547 # an optional value suffix of 'k', 'm', or 'g' will cause the value
2548 # to be multiplied by 1024, 1048576, or 1073741824
2549 sub config_to_int {
2550         my $val = shift;
2552         # strip leading and trailing whitespace
2553         $val =~ s/^\s+//;
2554         $val =~ s/\s+$//;
2556         if (my ($num, $unit) = ($val =~ /^([0-9]*)([kmg])$/i)) {
2557                 $unit = lc($unit);
2558                 # unknown unit is treated as 1
2559                 return $num * ($unit eq 'g' ? 1073741824 :
2560                                $unit eq 'm' ?    1048576 :
2561                                $unit eq 'k' ?       1024 : 1);
2562         }
2563         return $val;
2566 # convert config value to array reference, if needed
2567 sub config_to_multi {
2568         my $val = shift;
2570         return ref($val) ? $val : (defined($val) ? [ $val ] : []);
2573 sub git_get_project_config {
2574         my ($key, $type) = @_;
2576         return unless defined $git_dir;
2578         # key sanity check
2579         return unless ($key);
2580         # only subsection, if exists, is case sensitive,
2581         # and not lowercased by 'git config -z -l'
2582         if (my ($hi, $mi, $lo) = ($key =~ /^([^.]*)\.(.*)\.([^.]*)$/)) {
2583                 $key = join(".", lc($hi), $mi, lc($lo));
2584         } else {
2585                 $key = lc($key);
2586         }
2587         $key =~ s/^gitweb\.//;
2588         return if ($key =~ m/\W/);
2590         # type sanity check
2591         if (defined $type) {
2592                 $type =~ s/^--//;
2593                 $type = undef
2594                         unless ($type eq 'bool' || $type eq 'int');
2595         }
2597         # get config
2598         if (!defined $config_file ||
2599             $config_file ne "$git_dir/config") {
2600                 %config = git_parse_project_config('gitweb');
2601                 $config_file = "$git_dir/config";
2602         }
2604         # check if config variable (key) exists
2605         return unless exists $config{"gitweb.$key"};
2607         # ensure given type
2608         if (!defined $type) {
2609                 return $config{"gitweb.$key"};
2610         } elsif ($type eq 'bool') {
2611                 # backward compatibility: 'git config --bool' returns true/false
2612                 return config_to_bool($config{"gitweb.$key"}) ? 'true' : 'false';
2613         } elsif ($type eq 'int') {
2614                 return config_to_int($config{"gitweb.$key"});
2615         }
2616         return $config{"gitweb.$key"};
2619 # get hash of given path at given ref
2620 sub git_get_hash_by_path {
2621         my $base = shift;
2622         my $path = shift || return undef;
2623         my $type = shift;
2625         $path =~ s,/+$,,;
2627         open my $fd, "-|", git_cmd(), "ls-tree", $base, "--", $path
2628                 or die_error(500, "Open git-ls-tree failed");
2629         my $line = <$fd>;
2630         close $fd or return undef;
2632         if (!defined $line) {
2633                 # there is no tree or hash given by $path at $base
2634                 return undef;
2635         }
2637         #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa  panic.c'
2638         $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t/;
2639         if (defined $type && $type ne $2) {
2640                 # type doesn't match
2641                 return undef;
2642         }
2643         return $3;
2646 # get path of entry with given hash at given tree-ish (ref)
2647 # used to get 'from' filename for combined diff (merge commit) for renames
2648 sub git_get_path_by_hash {
2649         my $base = shift || return;
2650         my $hash = shift || return;
2652         local $/ = "\0";
2654         open my $fd, "-|", git_cmd(), "ls-tree", '-r', '-t', '-z', $base
2655                 or return undef;
2656         while (my $line = <$fd>) {
2657                 chomp $line;
2659                 #'040000 tree 595596a6a9117ddba9fe379b6b012b558bac8423  gitweb'
2660                 #'100644 blob e02e90f0429be0d2a69b76571101f20b8f75530f  gitweb/README'
2661                 if ($line =~ m/(?:[0-9]+) (?:.+) $hash\t(.+)$/) {
2662                         close $fd;
2663                         return $1;
2664                 }
2665         }
2666         close $fd;
2667         return undef;
2670 ## ......................................................................
2671 ## git utility functions, directly accessing git repository
2673 # get the value of config variable either from file named as the variable
2674 # itself in the repository ($GIT_DIR/$name file), or from gitweb.$name
2675 # configuration variable in the repository config file.
2676 sub git_get_file_or_project_config {
2677         my ($path, $name) = @_;
2679         $git_dir = "$projectroot/$path";
2680         open my $fd, '<', "$git_dir/$name"
2681                 or return git_get_project_config($name);
2682         my $conf = <$fd>;
2683         close $fd;
2684         if (defined $conf) {
2685                 chomp $conf;
2686         }
2687         return $conf;
2690 sub git_get_project_description {
2691         my $path = shift;
2692         return git_get_file_or_project_config($path, 'description');
2695 sub git_get_project_category {
2696         my $path = shift;
2697         return git_get_file_or_project_config($path, 'category');
2701 # supported formats:
2702 # * $GIT_DIR/ctags/<tagname> file (in 'ctags' subdirectory)
2703 #   - if its contents is a number, use it as tag weight,
2704 #   - otherwise add a tag with weight 1
2705 # * $GIT_DIR/ctags file, each line is a tag (with weight 1)
2706 #   the same value multiple times increases tag weight
2707 # * `gitweb.ctag' multi-valued repo config variable
2708 sub git_get_project_ctags {
2709         my $project = shift;
2710         my $ctags = {};
2712         $git_dir = "$projectroot/$project";
2713         if (opendir my $dh, "$git_dir/ctags") {
2714                 my @files = grep { -f $_ } map { "$git_dir/ctags/$_" } readdir($dh);
2715                 foreach my $tagfile (@files) {
2716                         open my $ct, '<', $tagfile
2717                                 or next;
2718                         my $val = <$ct>;
2719                         chomp $val if $val;
2720                         close $ct;
2722                         (my $ctag = $tagfile) =~ s#.*/##;
2723                         if ($val =~ /^\d+$/) {
2724                                 $ctags->{$ctag} = $val;
2725                         } else {
2726                                 $ctags->{$ctag} = 1;
2727                         }
2728                 }
2729                 closedir $dh;
2731         } elsif (open my $fh, '<', "$git_dir/ctags") {
2732                 while (my $line = <$fh>) {
2733                         chomp $line;
2734                         $ctags->{$line}++ if $line;
2735                 }
2736                 close $fh;
2738         } else {
2739                 my $taglist = config_to_multi(git_get_project_config('ctag'));
2740                 foreach my $tag (@$taglist) {
2741                         $ctags->{$tag}++;
2742                 }
2743         }
2745         return $ctags;
2748 # return hash, where keys are content tags ('ctags'),
2749 # and values are sum of weights of given tag in every project
2750 sub git_gather_all_ctags {
2751         my $projects = shift;
2752         my $ctags = {};
2754         foreach my $p (@$projects) {
2755                 foreach my $ct (keys %{$p->{'ctags'}}) {
2756                         $ctags->{$ct} += $p->{'ctags'}->{$ct};
2757                 }
2758         }
2760         return $ctags;
2763 sub git_populate_project_tagcloud {
2764         my $ctags = shift;
2766         # First, merge different-cased tags; tags vote on casing
2767         my %ctags_lc;
2768         foreach (keys %$ctags) {
2769                 $ctags_lc{lc $_}->{count} += $ctags->{$_};
2770                 if (not $ctags_lc{lc $_}->{topcount}
2771                     or $ctags_lc{lc $_}->{topcount} < $ctags->{$_}) {
2772                         $ctags_lc{lc $_}->{topcount} = $ctags->{$_};
2773                         $ctags_lc{lc $_}->{topname} = $_;
2774                 }
2775         }
2777         my $cloud;
2778         my $matched = $input_params{'ctag'};
2779         if (eval { require HTML::TagCloud; 1; }) {
2780                 $cloud = HTML::TagCloud->new;
2781                 foreach my $ctag (sort keys %ctags_lc) {
2782                         # Pad the title with spaces so that the cloud looks
2783                         # less crammed.
2784                         my $title = esc_html($ctags_lc{$ctag}->{topname});
2785                         $title =~ s/ /&nbsp;/g;
2786                         $title =~ s/^/&nbsp;/g;
2787                         $title =~ s/$/&nbsp;/g;
2788                         if (defined $matched && $matched eq $ctag) {
2789                                 $title = qq(<span class="match">$title</span>);
2790                         }
2791                         $cloud->add($title, href(project=>undef, ctag=>$ctag),
2792                                     $ctags_lc{$ctag}->{count});
2793                 }
2794         } else {
2795                 $cloud = {};
2796                 foreach my $ctag (keys %ctags_lc) {
2797                         my $title = esc_html($ctags_lc{$ctag}->{topname}, -nbsp=>1);
2798                         if (defined $matched && $matched eq $ctag) {
2799                                 $title = qq(<span class="match">$title</span>);
2800                         }
2801                         $cloud->{$ctag}{count} = $ctags_lc{$ctag}->{count};
2802                         $cloud->{$ctag}{ctag} =
2803                                 $cgi->a({-href=>href(project=>undef, ctag=>$ctag)}, $title);
2804                 }
2805         }
2806         return $cloud;
2809 sub git_show_project_tagcloud {
2810         my ($cloud, $count) = @_;
2811         if (ref $cloud eq 'HTML::TagCloud') {
2812                 return $cloud->html_and_css($count);
2813         } else {
2814                 my @tags = sort { $cloud->{$a}->{'count'} <=> $cloud->{$b}->{'count'} } keys %$cloud;
2815                 return
2816                         '<div id="htmltagcloud"'.($project ? '' : ' align="center"').'>' .
2817                         join (', ', map {
2818                                 $cloud->{$_}->{'ctag'}
2819                         } splice(@tags, 0, $count)) .
2820                         '</div>';
2821         }
2824 sub git_get_project_url_list {
2825         my $path = shift;
2827         $git_dir = "$projectroot/$path";
2828         open my $fd, '<', "$git_dir/cloneurl"
2829                 or return wantarray ?
2830                 @{ config_to_multi(git_get_project_config('url')) } :
2831                    config_to_multi(git_get_project_config('url'));
2832         my @git_project_url_list = map { chomp; $_ } <$fd>;
2833         close $fd;
2835         return wantarray ? @git_project_url_list : \@git_project_url_list;
2838 sub git_get_projects_list {
2839         my $filter = shift || '';
2840         my $paranoid = shift;
2841         my @list;
2843         if (-d $projects_list) {
2844                 # search in directory
2845                 my $dir = $projects_list;
2846                 # remove the trailing "/"
2847                 $dir =~ s!/+$!!;
2848                 my $pfxlen = length("$dir");
2849                 my $pfxdepth = ($dir =~ tr!/!!);
2850                 # when filtering, search only given subdirectory
2851                 if ($filter && !$paranoid) {
2852                         $dir .= "/$filter";
2853                         $dir =~ s!/+$!!;
2854                 }
2856                 File::Find::find({
2857                         follow_fast => 1, # follow symbolic links
2858                         follow_skip => 2, # ignore duplicates
2859                         dangling_symlinks => 0, # ignore dangling symlinks, silently
2860                         wanted => sub {
2861                                 # global variables
2862                                 our $project_maxdepth;
2863                                 our $projectroot;
2864                                 # skip project-list toplevel, if we get it.
2865                                 return if (m!^[/.]$!);
2866                                 # only directories can be git repositories
2867                                 return unless (-d $_);
2868                                 # don't traverse too deep (Find is super slow on os x)
2869                                 # $project_maxdepth excludes depth of $projectroot
2870                                 if (($File::Find::name =~ tr!/!!) - $pfxdepth > $project_maxdepth) {
2871                                         $File::Find::prune = 1;
2872                                         return;
2873                                 }
2875                                 my $path = substr($File::Find::name, $pfxlen + 1);
2876                                 # paranoidly only filter here
2877                                 if ($paranoid && $filter && $path !~ m!^\Q$filter\E/!) {
2878                                         next;
2879                                 }
2880                                 # we check related file in $projectroot
2881                                 if (check_export_ok("$projectroot/$path")) {
2882                                         push @list, { path => $path };
2883                                         $File::Find::prune = 1;
2884                                 }
2885                         },
2886                 }, "$dir");
2888         } elsif (-f $projects_list) {
2889                 # read from file(url-encoded):
2890                 # 'git%2Fgit.git Linus+Torvalds'
2891                 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
2892                 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
2893                 open my $fd, '<', $projects_list or return;
2894         PROJECT:
2895                 while (my $line = <$fd>) {
2896                         chomp $line;
2897                         my ($path, $owner) = split ' ', $line;
2898                         $path = unescape($path);
2899                         $owner = unescape($owner);
2900                         if (!defined $path) {
2901                                 next;
2902                         }
2903                         # if $filter is rpovided, check if $path begins with $filter
2904                         if ($filter && $path !~ m!^\Q$filter\E/!) {
2905                                 next;
2906                         }
2907                         if (check_export_ok("$projectroot/$path")) {
2908                                 my $pr = {
2909                                         path => $path,
2910                                         owner => to_utf8($owner),
2911                                 };
2912                                 push @list, $pr;
2913                         }
2914                 }
2915                 close $fd;
2916         }
2917         return @list;
2920 # written with help of Tree::Trie module (Perl Artistic License, GPL compatibile)
2921 # as side effects it sets 'forks' field to list of forks for forked projects
2922 sub filter_forks_from_projects_list {
2923         my $projects = shift;
2925         my %trie; # prefix tree of directories (path components)
2926         # generate trie out of those directories that might contain forks
2927         foreach my $pr (@$projects) {
2928                 my $path = $pr->{'path'};
2929                 $path =~ s/\.git$//;      # forks of 'repo.git' are in 'repo/' directory
2930                 next if ($path =~ m!/$!); # skip non-bare repositories, e.g. 'repo/.git'
2931                 next unless ($path);      # skip '.git' repository: tests, git-instaweb
2932                 next unless (-d "$projectroot/$path"); # containing directory exists
2933                 $pr->{'forks'} = [];      # there can be 0 or more forks of project
2935                 # add to trie
2936                 my @dirs = split('/', $path);
2937                 # walk the trie, until either runs out of components or out of trie
2938                 my $ref = \%trie;
2939                 while (scalar @dirs &&
2940                        exists($ref->{$dirs[0]})) {
2941                         $ref = $ref->{shift @dirs};
2942                 }
2943                 # create rest of trie structure from rest of components
2944                 foreach my $dir (@dirs) {
2945                         $ref = $ref->{$dir} = {};
2946                 }
2947                 # create end marker, store $pr as a data
2948                 $ref->{''} = $pr if (!exists $ref->{''});
2949         }
2951         # filter out forks, by finding shortest prefix match for paths
2952         my @filtered;
2953  PROJECT:
2954         foreach my $pr (@$projects) {
2955                 # trie lookup
2956                 my $ref = \%trie;
2957         DIR:
2958                 foreach my $dir (split('/', $pr->{'path'})) {
2959                         if (exists $ref->{''}) {
2960                                 # found [shortest] prefix, is a fork - skip it
2961                                 push @{$ref->{''}{'forks'}}, $pr;
2962                                 next PROJECT;
2963                         }
2964                         if (!exists $ref->{$dir}) {
2965                                 # not in trie, cannot have prefix, not a fork
2966                                 push @filtered, $pr;
2967                                 next PROJECT;
2968                         }
2969                         # If the dir is there, we just walk one step down the trie.
2970                         $ref = $ref->{$dir};
2971                 }
2972                 # we ran out of trie
2973                 # (shouldn't happen: it's either no match, or end marker)
2974                 push @filtered, $pr;
2975         }
2977         return @filtered;
2980 # note: fill_project_list_info must be run first,
2981 # for 'descr_long' and 'ctags' to be filled
2982 sub search_projects_list {
2983         my ($projlist, %opts) = @_;
2984         my $tagfilter  = $opts{'tagfilter'};
2985         my $searchtext = $opts{'searchtext'};
2987         return @$projlist
2988                 unless ($tagfilter || $searchtext);
2990         # searching projects require filling to be run before it;
2991         fill_project_list_info($projlist,
2992                                $tagfilter  ? 'ctags' : (),
2993                                $searchtext ? ('path', 'descr') : ());
2994         my @projects;
2995  PROJECT:
2996         foreach my $pr (@$projlist) {
2998                 if ($tagfilter) {
2999                         next unless ref($pr->{'ctags'}) eq 'HASH';
3000                         next unless
3001                                 grep { lc($_) eq lc($tagfilter) } keys %{$pr->{'ctags'}};
3002                 }
3004                 if ($searchtext) {
3005                         next unless
3006                                 $pr->{'path'} =~ /$searchtext/ ||
3007                                 $pr->{'descr_long'} =~ /$searchtext/;
3008                 }
3010                 push @projects, $pr;
3011         }
3013         return @projects;
3016 our $gitweb_project_owner = undef;
3017 sub git_get_project_list_from_file {
3019         return if (defined $gitweb_project_owner);
3021         $gitweb_project_owner = {};
3022         # read from file (url-encoded):
3023         # 'git%2Fgit.git Linus+Torvalds'
3024         # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3025         # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3026         if (-f $projects_list) {
3027                 open(my $fd, '<', $projects_list);
3028                 while (my $line = <$fd>) {
3029                         chomp $line;
3030                         my ($pr, $ow) = split ' ', $line;
3031                         $pr = unescape($pr);
3032                         $ow = unescape($ow);
3033                         $gitweb_project_owner->{$pr} = to_utf8($ow);
3034                 }
3035                 close $fd;
3036         }
3039 sub git_get_project_owner {
3040         my $project = shift;
3041         my $owner;
3043         return undef unless $project;
3044         $git_dir = "$projectroot/$project";
3046         if (!defined $gitweb_project_owner) {
3047                 git_get_project_list_from_file();
3048         }
3050         if (exists $gitweb_project_owner->{$project}) {
3051                 $owner = $gitweb_project_owner->{$project};
3052         }
3053         if (!defined $owner){
3054                 $owner = git_get_project_config('owner');
3055         }
3056         if (!defined $owner) {
3057                 $owner = get_file_owner("$git_dir");
3058         }
3060         return $owner;
3063 sub git_get_last_activity {
3064         my ($path) = @_;
3065         my $fd;
3067         $git_dir = "$projectroot/$path";
3068         open($fd, "-|", git_cmd(), 'for-each-ref',
3069              '--format=%(committer)',
3070              '--sort=-committerdate',
3071              '--count=1',
3072              'refs/heads') or return;
3073         my $most_recent = <$fd>;
3074         close $fd or return;
3075         if (defined $most_recent &&
3076             $most_recent =~ / (\d+) [-+][01]\d\d\d$/) {
3077                 my $timestamp = $1;
3078                 my $age = time - $timestamp;
3079                 return ($age, age_string($age));
3080         }
3081         return (undef, undef);
3084 # Implementation note: when a single remote is wanted, we cannot use 'git
3085 # remote show -n' because that command always work (assuming it's a remote URL
3086 # if it's not defined), and we cannot use 'git remote show' because that would
3087 # try to make a network roundtrip. So the only way to find if that particular
3088 # remote is defined is to walk the list provided by 'git remote -v' and stop if
3089 # and when we find what we want.
3090 sub git_get_remotes_list {
3091         my $wanted = shift;
3092         my %remotes = ();
3094         open my $fd, '-|' , git_cmd(), 'remote', '-v';
3095         return unless $fd;
3096         while (my $remote = <$fd>) {
3097                 chomp $remote;
3098                 $remote =~ s!\t(.*?)\s+\((\w+)\)$!!;
3099                 next if $wanted and not $remote eq $wanted;
3100                 my ($url, $key) = ($1, $2);
3102                 $remotes{$remote} ||= { 'heads' => () };
3103                 $remotes{$remote}{$key} = $url;
3104         }
3105         close $fd or return;
3106         return wantarray ? %remotes : \%remotes;
3109 # Takes a hash of remotes as first parameter and fills it by adding the
3110 # available remote heads for each of the indicated remotes.
3111 sub fill_remote_heads {
3112         my $remotes = shift;
3113         my @heads = map { "remotes/$_" } keys %$remotes;
3114         my @remoteheads = git_get_heads_list(undef, @heads);
3115         foreach my $remote (keys %$remotes) {
3116                 $remotes->{$remote}{'heads'} = [ grep {
3117                         $_->{'name'} =~ s!^$remote/!!
3118                         } @remoteheads ];
3119         }
3122 sub git_get_references {
3123         my $type = shift || "";
3124         my %refs;
3125         # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
3126         # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
3127         open my $fd, "-|", git_cmd(), "show-ref", "--dereference",
3128                 ($type ? ("--", "refs/$type") : ()) # use -- <pattern> if $type
3129                 or return;
3131         while (my $line = <$fd>) {
3132                 chomp $line;
3133                 if ($line =~ m!^([0-9a-fA-F]{40})\srefs/($type.*)$!) {
3134                         if (defined $refs{$1}) {
3135                                 push @{$refs{$1}}, $2;
3136                         } else {
3137                                 $refs{$1} = [ $2 ];
3138                         }
3139                 }
3140         }
3141         close $fd or return;
3142         return \%refs;
3145 sub git_get_rev_name_tags {
3146         my $hash = shift || return undef;
3148         open my $fd, "-|", git_cmd(), "name-rev", "--tags", $hash
3149                 or return;
3150         my $name_rev = <$fd>;
3151         close $fd;
3153         if ($name_rev =~ m|^$hash tags/(.*)$|) {
3154                 return $1;
3155         } else {
3156                 # catches also '$hash undefined' output
3157                 return undef;
3158         }
3161 ## ----------------------------------------------------------------------
3162 ## parse to hash functions
3164 sub parse_date {
3165         my $epoch = shift;
3166         my $tz = shift || "-0000";
3168         my %date;
3169         my @months = ("Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
3170         my @days = ("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat");
3171         my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($epoch);
3172         $date{'hour'} = $hour;
3173         $date{'minute'} = $min;
3174         $date{'mday'} = $mday;
3175         $date{'day'} = $days[$wday];
3176         $date{'month'} = $months[$mon];
3177         $date{'rfc2822'}   = sprintf "%s, %d %s %4d %02d:%02d:%02d +0000",
3178                              $days[$wday], $mday, $months[$mon], 1900+$year, $hour ,$min, $sec;
3179         $date{'mday-time'} = sprintf "%d %s %02d:%02d",
3180                              $mday, $months[$mon], $hour ,$min;
3181         $date{'iso-8601'}  = sprintf "%04d-%02d-%02dT%02d:%02d:%02dZ",
3182                              1900+$year, 1+$mon, $mday, $hour ,$min, $sec;
3184         my ($tz_sign, $tz_hour, $tz_min) =
3185                 ($tz =~ m/^([-+])(\d\d)(\d\d)$/);
3186         $tz_sign = ($tz_sign eq '-' ? -1 : +1);
3187         my $local = $epoch + $tz_sign*((($tz_hour*60) + $tz_min)*60);
3188         ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($local);
3189         $date{'hour_local'} = $hour;
3190         $date{'minute_local'} = $min;
3191         $date{'tz_local'} = $tz;
3192         $date{'iso-tz'} = sprintf("%04d-%02d-%02d %02d:%02d:%02d %s",
3193                                   1900+$year, $mon+1, $mday,
3194                                   $hour, $min, $sec, $tz);
3195         return %date;
3198 sub parse_tag {
3199         my $tag_id = shift;
3200         my %tag;
3201         my @comment;
3203         open my $fd, "-|", git_cmd(), "cat-file", "tag", $tag_id or return;
3204         $tag{'id'} = $tag_id;
3205         while (my $line = <$fd>) {
3206                 chomp $line;
3207                 if ($line =~ m/^object ([0-9a-fA-F]{40})$/) {
3208                         $tag{'object'} = $1;
3209                 } elsif ($line =~ m/^type (.+)$/) {
3210                         $tag{'type'} = $1;
3211                 } elsif ($line =~ m/^tag (.+)$/) {
3212                         $tag{'name'} = $1;
3213                 } elsif ($line =~ m/^tagger (.*) ([0-9]+) (.*)$/) {
3214                         $tag{'author'} = $1;
3215                         $tag{'author_epoch'} = $2;
3216                         $tag{'author_tz'} = $3;
3217                         if ($tag{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3218                                 $tag{'author_name'}  = $1;
3219                                 $tag{'author_email'} = $2;
3220                         } else {
3221                                 $tag{'author_name'} = $tag{'author'};
3222                         }
3223                 } elsif ($line =~ m/--BEGIN/) {
3224                         push @comment, $line;
3225                         last;
3226                 } elsif ($line eq "") {
3227                         last;
3228                 }
3229         }
3230         push @comment, <$fd>;
3231         $tag{'comment'} = \@comment;
3232         close $fd or return;
3233         if (!defined $tag{'name'}) {
3234                 return
3235         };
3236         return %tag
3239 sub parse_commit_text {
3240         my ($commit_text, $withparents) = @_;
3241         my @commit_lines = split '\n', $commit_text;
3242         my %co;
3244         pop @commit_lines; # Remove '\0'
3246         if (! @commit_lines) {
3247                 return;
3248         }
3250         my $header = shift @commit_lines;
3251         if ($header !~ m/^[0-9a-fA-F]{40}/) {
3252                 return;
3253         }
3254         ($co{'id'}, my @parents) = split ' ', $header;
3255         while (my $line = shift @commit_lines) {
3256                 last if $line eq "\n";
3257                 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
3258                         $co{'tree'} = $1;
3259                 } elsif ((!defined $withparents) && ($line =~ m/^parent ([0-9a-fA-F]{40})$/)) {
3260                         push @parents, $1;
3261                 } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {
3262                         $co{'author'} = to_utf8($1);
3263                         $co{'author_epoch'} = $2;
3264                         $co{'author_tz'} = $3;
3265                         if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3266                                 $co{'author_name'}  = $1;
3267                                 $co{'author_email'} = $2;
3268                         } else {
3269                                 $co{'author_name'} = $co{'author'};
3270                         }
3271                 } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {
3272                         $co{'committer'} = to_utf8($1);
3273                         $co{'committer_epoch'} = $2;
3274                         $co{'committer_tz'} = $3;
3275                         if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
3276                                 $co{'committer_name'}  = $1;
3277                                 $co{'committer_email'} = $2;
3278                         } else {
3279                                 $co{'committer_name'} = $co{'committer'};
3280                         }
3281                 }
3282         }
3283         if (!defined $co{'tree'}) {
3284                 return;
3285         };
3286         $co{'parents'} = \@parents;
3287         $co{'parent'} = $parents[0];
3289         foreach my $title (@commit_lines) {
3290                 $title =~ s/^    //;
3291                 if ($title ne "") {
3292                         $co{'title'} = chop_str($title, 80, 5);
3293                         # remove leading stuff of merges to make the interesting part visible
3294                         if (length($title) > 50) {
3295                                 $title =~ s/^Automatic //;
3296                                 $title =~ s/^merge (of|with) /Merge ... /i;
3297                                 if (length($title) > 50) {
3298                                         $title =~ s/(http|rsync):\/\///;
3299                                 }
3300                                 if (length($title) > 50) {
3301                                         $title =~ s/(master|www|rsync)\.//;
3302                                 }
3303                                 if (length($title) > 50) {
3304                                         $title =~ s/kernel.org:?//;
3305                                 }
3306                                 if (length($title) > 50) {
3307                                         $title =~ s/\/pub\/scm//;
3308                                 }
3309                         }
3310                         $co{'title_short'} = chop_str($title, 50, 5);
3311                         last;
3312                 }
3313         }
3314         if (! defined $co{'title'} || $co{'title'} eq "") {
3315                 $co{'title'} = $co{'title_short'} = '(no commit message)';
3316         }
3317         # remove added spaces
3318         foreach my $line (@commit_lines) {
3319                 $line =~ s/^    //;
3320         }
3321         $co{'comment'} = \@commit_lines;
3323         my $age = time - $co{'committer_epoch'};
3324         $co{'age'} = $age;
3325         $co{'age_string'} = age_string($age);
3326         my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($co{'committer_epoch'});
3327         if ($age > 60*60*24*7*2) {
3328                 $co{'age_string_date'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3329                 $co{'age_string_age'} = $co{'age_string'};
3330         } else {
3331                 $co{'age_string_date'} = $co{'age_string'};
3332                 $co{'age_string_age'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3333         }
3334         return %co;
3337 sub parse_commit {
3338         my ($commit_id) = @_;
3339         my %co;
3341         local $/ = "\0";
3343         open my $fd, "-|", git_cmd(), "rev-list",
3344                 "--parents",
3345                 "--header",
3346                 "--max-count=1",
3347                 $commit_id,
3348                 "--",
3349                 or die_error(500, "Open git-rev-list failed");
3350         %co = parse_commit_text(<$fd>, 1);
3351         close $fd;
3353         return %co;
3356 sub parse_commits {
3357         my ($commit_id, $maxcount, $skip, $filename, @args) = @_;
3358         my @cos;
3360         $maxcount ||= 1;
3361         $skip ||= 0;
3363         local $/ = "\0";
3365         open my $fd, "-|", git_cmd(), "rev-list",
3366                 "--header",
3367                 @args,
3368                 ("--max-count=" . $maxcount),
3369                 ("--skip=" . $skip),
3370                 @extra_options,
3371                 $commit_id,
3372                 "--",
3373                 ($filename ? ($filename) : ())
3374                 or die_error(500, "Open git-rev-list failed");
3375         while (my $line = <$fd>) {
3376                 my %co = parse_commit_text($line);
3377                 push @cos, \%co;
3378         }
3379         close $fd;
3381         return wantarray ? @cos : \@cos;
3384 # parse line of git-diff-tree "raw" output
3385 sub parse_difftree_raw_line {
3386         my $line = shift;
3387         my %res;
3389         # ':100644 100644 03b218260e99b78c6df0ed378e59ed9205ccc96d 3b93d5e7cc7f7dd4ebed13a5cc1a4ad976fc94d8 M   ls-files.c'
3390         # ':100644 100644 7f9281985086971d3877aca27704f2aaf9c448ce bc190ebc71bbd923f2b728e505408f5e54bd073a M   rev-tree.c'
3391         if ($line =~ m/^:([0-7]{6}) ([0-7]{6}) ([0-9a-fA-F]{40}) ([0-9a-fA-F]{40}) (.)([0-9]{0,3})\t(.*)$/) {
3392                 $res{'from_mode'} = $1;
3393                 $res{'to_mode'} = $2;
3394                 $res{'from_id'} = $3;
3395                 $res{'to_id'} = $4;
3396                 $res{'status'} = $5;
3397                 $res{'similarity'} = $6;
3398                 if ($res{'status'} eq 'R' || $res{'status'} eq 'C') { # renamed or copied
3399                         ($res{'from_file'}, $res{'to_file'}) = map { unquote($_) } split("\t", $7);
3400                 } else {
3401                         $res{'from_file'} = $res{'to_file'} = $res{'file'} = unquote($7);
3402                 }
3403         }
3404         # '::100755 100755 100755 60e79ca1b01bc8b057abe17ddab484699a7f5fdb 94067cc5f73388f33722d52ae02f44692bc07490 94067cc5f73388f33722d52ae02f44692bc07490 MR git-gui/git-gui.sh'
3405         # combined diff (for merge commit)
3406         elsif ($line =~ s/^(::+)((?:[0-7]{6} )+)((?:[0-9a-fA-F]{40} )+)([a-zA-Z]+)\t(.*)$//) {
3407                 $res{'nparents'}  = length($1);
3408                 $res{'from_mode'} = [ split(' ', $2) ];
3409                 $res{'to_mode'} = pop @{$res{'from_mode'}};
3410                 $res{'from_id'} = [ split(' ', $3) ];
3411                 $res{'to_id'} = pop @{$res{'from_id'}};
3412                 $res{'status'} = [ split('', $4) ];
3413                 $res{'to_file'} = unquote($5);
3414         }
3415         # 'c512b523472485aef4fff9e57b229d9d243c967f'
3416         elsif ($line =~ m/^([0-9a-fA-F]{40})$/) {
3417                 $res{'commit'} = $1;
3418         }
3420         return wantarray ? %res : \%res;
3423 # wrapper: return parsed line of git-diff-tree "raw" output
3424 # (the argument might be raw line, or parsed info)
3425 sub parsed_difftree_line {
3426         my $line_or_ref = shift;
3428         if (ref($line_or_ref) eq "HASH") {
3429                 # pre-parsed (or generated by hand)
3430                 return $line_or_ref;
3431         } else {
3432                 return parse_difftree_raw_line($line_or_ref);
3433         }
3436 # parse line of git-ls-tree output
3437 sub parse_ls_tree_line {
3438         my $line = shift;
3439         my %opts = @_;
3440         my %res;
3442         if ($opts{'-l'}) {
3443                 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa   16717  panic.c'
3444                 $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40}) +(-|[0-9]+)\t(.+)$/s;
3446                 $res{'mode'} = $1;
3447                 $res{'type'} = $2;
3448                 $res{'hash'} = $3;
3449                 $res{'size'} = $4;
3450                 if ($opts{'-z'}) {
3451                         $res{'name'} = $5;
3452                 } else {
3453                         $res{'name'} = unquote($5);
3454                 }
3455         } else {
3456                 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa  panic.c'
3457                 $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t(.+)$/s;
3459                 $res{'mode'} = $1;
3460                 $res{'type'} = $2;
3461                 $res{'hash'} = $3;
3462                 if ($opts{'-z'}) {
3463                         $res{'name'} = $4;
3464                 } else {
3465                         $res{'name'} = unquote($4);
3466                 }
3467         }
3469         return wantarray ? %res : \%res;
3472 # generates _two_ hashes, references to which are passed as 2 and 3 argument
3473 sub parse_from_to_diffinfo {
3474         my ($diffinfo, $from, $to, @parents) = @_;
3476         if ($diffinfo->{'nparents'}) {
3477                 # combined diff
3478                 $from->{'file'} = [];
3479                 $from->{'href'} = [];
3480                 fill_from_file_info($diffinfo, @parents)
3481                         unless exists $diffinfo->{'from_file'};
3482                 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
3483                         $from->{'file'}[$i] =
3484                                 defined $diffinfo->{'from_file'}[$i] ?
3485                                         $diffinfo->{'from_file'}[$i] :
3486                                         $diffinfo->{'to_file'};
3487                         if ($diffinfo->{'status'}[$i] ne "A") { # not new (added) file
3488                                 $from->{'href'}[$i] = href(action=>"blob",
3489                                                            hash_base=>$parents[$i],
3490                                                            hash=>$diffinfo->{'from_id'}[$i],
3491                                                            file_name=>$from->{'file'}[$i]);
3492                         } else {
3493                                 $from->{'href'}[$i] = undef;
3494                         }
3495                 }
3496         } else {
3497                 # ordinary (not combined) diff
3498                 $from->{'file'} = $diffinfo->{'from_file'};
3499                 if ($diffinfo->{'status'} ne "A") { # not new (added) file
3500                         $from->{'href'} = href(action=>"blob", hash_base=>$hash_parent,
3501                                                hash=>$diffinfo->{'from_id'},
3502                                                file_name=>$from->{'file'});
3503                 } else {
3504                         delete $from->{'href'};
3505                 }
3506         }
3508         $to->{'file'} = $diffinfo->{'to_file'};
3509         if (!is_deleted($diffinfo)) { # file exists in result
3510                 $to->{'href'} = href(action=>"blob", hash_base=>$hash,
3511                                      hash=>$diffinfo->{'to_id'},
3512                                      file_name=>$to->{'file'});
3513         } else {
3514                 delete $to->{'href'};
3515         }
3518 ## ......................................................................
3519 ## parse to array of hashes functions
3521 sub git_get_heads_list {
3522         my ($limit, @classes) = @_;
3523         @classes = ('heads') unless @classes;
3524         my @patterns = map { "refs/$_" } @classes;
3525         my @headslist;
3527         open my $fd, '-|', git_cmd(), 'for-each-ref',
3528                 ($limit ? '--count='.($limit+1) : ()), '--sort=-committerdate',
3529                 '--format=%(objectname) %(refname) %(subject)%00%(committer)',
3530                 @patterns
3531                 or return;
3532         while (my $line = <$fd>) {
3533                 my %ref_item;
3535                 chomp $line;
3536                 my ($refinfo, $committerinfo) = split(/\0/, $line);
3537                 my ($hash, $name, $title) = split(' ', $refinfo, 3);
3538                 my ($committer, $epoch, $tz) =
3539                         ($committerinfo =~ /^(.*) ([0-9]+) (.*)$/);
3540                 $ref_item{'fullname'}  = $name;
3541                 $name =~ s!^refs/(?:head|remote)s/!!;
3543                 $ref_item{'name'}  = $name;
3544                 $ref_item{'id'}    = $hash;
3545                 $ref_item{'title'} = $title || '(no commit message)';
3546                 $ref_item{'epoch'} = $epoch;
3547                 if ($epoch) {
3548                         $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3549                 } else {
3550                         $ref_item{'age'} = "unknown";
3551                 }
3553                 push @headslist, \%ref_item;
3554         }
3555         close $fd;
3557         return wantarray ? @headslist : \@headslist;
3560 sub git_get_tags_list {
3561         my $limit = shift;
3562         my @tagslist;
3564         open my $fd, '-|', git_cmd(), 'for-each-ref',
3565                 ($limit ? '--count='.($limit+1) : ()), '--sort=-creatordate',
3566                 '--format=%(objectname) %(objecttype) %(refname) '.
3567                 '%(*objectname) %(*objecttype) %(subject)%00%(creator)',
3568                 'refs/tags'
3569                 or return;
3570         while (my $line = <$fd>) {
3571                 my %ref_item;
3573                 chomp $line;
3574                 my ($refinfo, $creatorinfo) = split(/\0/, $line);
3575                 my ($id, $type, $name, $refid, $reftype, $title) = split(' ', $refinfo, 6);
3576                 my ($creator, $epoch, $tz) =
3577                         ($creatorinfo =~ /^(.*) ([0-9]+) (.*)$/);
3578                 $ref_item{'fullname'} = $name;
3579                 $name =~ s!^refs/tags/!!;
3581                 $ref_item{'type'} = $type;
3582                 $ref_item{'id'} = $id;
3583                 $ref_item{'name'} = $name;
3584                 if ($type eq "tag") {
3585                         $ref_item{'subject'} = $title;
3586                         $ref_item{'reftype'} = $reftype;
3587                         $ref_item{'refid'}   = $refid;
3588                 } else {
3589                         $ref_item{'reftype'} = $type;
3590                         $ref_item{'refid'}   = $id;
3591                 }
3593                 if ($type eq "tag" || $type eq "commit") {
3594                         $ref_item{'epoch'} = $epoch;
3595                         if ($epoch) {
3596                                 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3597                         } else {
3598                                 $ref_item{'age'} = "unknown";
3599                         }
3600                 }
3602                 push @tagslist, \%ref_item;
3603         }
3604         close $fd;
3606         return wantarray ? @tagslist : \@tagslist;
3609 ## ----------------------------------------------------------------------
3610 ## filesystem-related functions
3612 sub get_file_owner {
3613         my $path = shift;
3615         my ($dev, $ino, $mode, $nlink, $st_uid, $st_gid, $rdev, $size) = stat($path);
3616         my ($name, $passwd, $uid, $gid, $quota, $comment, $gcos, $dir, $shell) = getpwuid($st_uid);
3617         if (!defined $gcos) {
3618                 return undef;
3619         }
3620         my $owner = $gcos;
3621         $owner =~ s/[,;].*$//;
3622         return to_utf8($owner);
3625 # assume that file exists
3626 sub insert_file {
3627         my $filename = shift;
3629         open my $fd, '<', $filename;
3630         print map { to_utf8($_) } <$fd>;
3631         close $fd;
3634 ## ......................................................................
3635 ## mimetype related functions
3637 sub mimetype_guess_file {
3638         my $filename = shift;
3639         my $mimemap = shift;
3640         -r $mimemap or return undef;
3642         my %mimemap;
3643         open(my $mh, '<', $mimemap) or return undef;
3644         while (<$mh>) {
3645                 next if m/^#/; # skip comments
3646                 my ($mimetype, @exts) = split(/\s+/);
3647                 foreach my $ext (@exts) {
3648                         $mimemap{$ext} = $mimetype;
3649                 }
3650         }
3651         close($mh);
3653         $filename =~ /\.([^.]*)$/;
3654         return $mimemap{$1};
3657 sub mimetype_guess {
3658         my $filename = shift;
3659         my $mime;
3660         $filename =~ /\./ or return undef;
3662         if ($mimetypes_file) {
3663                 my $file = $mimetypes_file;
3664                 if ($file !~ m!^/!) { # if it is relative path
3665                         # it is relative to project
3666                         $file = "$projectroot/$project/$file";
3667                 }
3668                 $mime = mimetype_guess_file($filename, $file);
3669         }
3670         $mime ||= mimetype_guess_file($filename, '/etc/mime.types');
3671         return $mime;
3674 sub blob_mimetype {
3675         my $fd = shift;
3676         my $filename = shift;
3678         if ($filename) {
3679                 my $mime = mimetype_guess($filename);
3680                 $mime and return $mime;
3681         }
3683         # just in case
3684         return $default_blob_plain_mimetype unless $fd;
3686         if (-T $fd) {
3687                 return 'text/plain';
3688         } elsif (! $filename) {
3689                 return 'application/octet-stream';
3690         } elsif ($filename =~ m/\.png$/i) {
3691                 return 'image/png';
3692         } elsif ($filename =~ m/\.gif$/i) {
3693                 return 'image/gif';
3694         } elsif ($filename =~ m/\.jpe?g$/i) {
3695                 return 'image/jpeg';
3696         } else {
3697                 return 'application/octet-stream';
3698         }
3701 sub blob_contenttype {
3702         my ($fd, $file_name, $type) = @_;
3704         $type ||= blob_mimetype($fd, $file_name);
3705         if ($type eq 'text/plain' && defined $default_text_plain_charset) {
3706                 $type .= "; charset=$default_text_plain_charset";
3707         }
3709         return $type;
3712 # guess file syntax for syntax highlighting; return undef if no highlighting
3713 # the name of syntax can (in the future) depend on syntax highlighter used
3714 sub guess_file_syntax {
3715         my ($highlight, $mimetype, $file_name) = @_;
3716         return undef unless ($highlight && defined $file_name);
3717         my $basename = basename($file_name, '.in');
3718         return $highlight_basename{$basename}
3719                 if exists $highlight_basename{$basename};
3721         $basename =~ /\.([^.]*)$/;
3722         my $ext = $1 or return undef;
3723         return $highlight_ext{$ext}
3724                 if exists $highlight_ext{$ext};
3726         return undef;
3729 # run highlighter and return FD of its output,
3730 # or return original FD if no highlighting
3731 sub run_highlighter {
3732         my ($fd, $highlight, $syntax) = @_;
3733         return $fd unless ($highlight && defined $syntax);
3735         close $fd;
3736         open $fd, quote_command(git_cmd(), "cat-file", "blob", $hash)." | ".
3737                   quote_command($highlight_bin).
3738                   " --replace-tabs=8 --fragment --syntax $syntax |"
3739                 or die_error(500, "Couldn't open file or run syntax highlighter");
3740         return $fd;
3743 ## ======================================================================
3744 ## functions printing HTML: header, footer, error page
3746 sub get_page_title {
3747         my $title = to_utf8($site_name);
3749         unless (defined $project) {
3750                 if (defined $project_filter) {
3751                         $title .= " - projects in '" . esc_path($project_filter) . "'";
3752                 }
3753                 return $title;
3754         }
3755         $title .= " - " . to_utf8($project);
3757         return $title unless (defined $action);
3758         $title .= "/$action"; # $action is US-ASCII (7bit ASCII)
3760         return $title unless (defined $file_name);
3761         $title .= " - " . esc_path($file_name);
3762         if ($action eq "tree" && $file_name !~ m|/$|) {
3763                 $title .= "/";
3764         }
3766         return $title;
3769 sub get_content_type_html {
3770         # require explicit support from the UA if we are to send the page as
3771         # 'application/xhtml+xml', otherwise send it as plain old 'text/html'.
3772         # we have to do this because MSIE sometimes globs '*/*', pretending to
3773         # support xhtml+xml but choking when it gets what it asked for.
3774         if (defined $cgi->http('HTTP_ACCEPT') &&
3775             $cgi->http('HTTP_ACCEPT') =~ m/(,|;|\s|^)application\/xhtml\+xml(,|;|\s|$)/ &&
3776             $cgi->Accept('application/xhtml+xml') != 0) {
3777                 return 'application/xhtml+xml';
3778         } else {
3779                 return 'text/html';
3780         }
3783 sub print_feed_meta {
3784         if (defined $project) {
3785                 my %href_params = get_feed_info();
3786                 if (!exists $href_params{'-title'}) {
3787                         $href_params{'-title'} = 'log';
3788                 }
3790                 foreach my $format (qw(RSS Atom)) {
3791                         my $type = lc($format);
3792                         my %link_attr = (
3793                                 '-rel' => 'alternate',
3794                                 '-title' => esc_attr("$project - $href_params{'-title'} - $format feed"),
3795                                 '-type' => "application/$type+xml"
3796                         );
3798                         $href_params{'action'} = $type;
3799                         $link_attr{'-href'} = href(%href_params);
3800                         print "<link ".
3801                               "rel=\"$link_attr{'-rel'}\" ".
3802                               "title=\"$link_attr{'-title'}\" ".
3803                               "href=\"$link_attr{'-href'}\" ".
3804                               "type=\"$link_attr{'-type'}\" ".
3805                               "/>\n";
3807                         $href_params{'extra_options'} = '--no-merges';
3808                         $link_attr{'-href'} = href(%href_params);
3809                         $link_attr{'-title'} .= ' (no merges)';
3810                         print "<link ".
3811                               "rel=\"$link_attr{'-rel'}\" ".
3812                               "title=\"$link_attr{'-title'}\" ".
3813                               "href=\"$link_attr{'-href'}\" ".
3814                               "type=\"$link_attr{'-type'}\" ".
3815                               "/>\n";
3816                 }
3818         } else {
3819                 printf('<link rel="alternate" title="%s projects list" '.
3820                        'href="%s" type="text/plain; charset=utf-8" />'."\n",
3821                        esc_attr($site_name), href(project=>undef, action=>"project_index"));
3822                 printf('<link rel="alternate" title="%s projects feeds" '.
3823                        'href="%s" type="text/x-opml" />'."\n",
3824                        esc_attr($site_name), href(project=>undef, action=>"opml"));
3825         }
3828 sub print_header_links {
3829         my $status = shift;
3831         # print out each stylesheet that exist, providing backwards capability
3832         # for those people who defined $stylesheet in a config file
3833         if (defined $stylesheet) {
3834                 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
3835         } else {
3836                 foreach my $stylesheet (@stylesheets) {
3837                         next unless $stylesheet;
3838                         print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
3839                 }
3840         }
3841         print_feed_meta()
3842                 if ($status eq '200 OK');
3843         if (defined $favicon) {
3844                 print qq(<link rel="shortcut icon" href=").esc_url($favicon).qq(" type="image/png" />\n);
3845         }
3848 sub print_nav_breadcrumbs_path {
3849         my $dirprefix = undef;
3850         while (my $part = shift) {
3851                 $dirprefix .= "/" if defined $dirprefix;
3852                 $dirprefix .= $part;
3853                 print $cgi->a({-href => href(project => undef,
3854                                              project_filter => $dirprefix,
3855                                              action => "project_list")},
3856                               esc_html($part)) . " / ";
3857         }
3860 sub print_nav_breadcrumbs {
3861         my %opts = @_;
3863         print $cgi->a({-href => esc_url($home_link)}, $home_link_str) . " / ";
3864         if (defined $project) {
3865                 my @dirname = split '/', $project;
3866                 my $projectbasename = pop @dirname;
3867                 print_nav_breadcrumbs_path(@dirname);
3868                 print $cgi->a({-href => href(action=>"summary")}, esc_html($projectbasename));
3869                 if (defined $action) {
3870                         my $action_print = $action ;
3871                         if (defined $opts{-action_extra}) {
3872                                 $action_print = $cgi->a({-href => href(action=>$action)},
3873                                         $action);
3874                         }
3875                         print " / $action_print";
3876                 }
3877                 if (defined $opts{-action_extra}) {
3878                         print " / $opts{-action_extra}";
3879                 }
3880                 print "\n";
3881         } elsif (defined $project_filter) {
3882                 print_nav_breadcrumbs_path(split '/', $project_filter);
3883         }
3886 sub print_search_form {
3887         if (!defined $searchtext) {
3888                 $searchtext = "";
3889         }
3890         my $search_hash;
3891         if (defined $hash_base) {
3892                 $search_hash = $hash_base;
3893         } elsif (defined $hash) {
3894                 $search_hash = $hash;
3895         } else {
3896                 $search_hash = "HEAD";
3897         }
3898         my $action = $my_uri;
3899         my $use_pathinfo = gitweb_check_feature('pathinfo');
3900         if ($use_pathinfo) {
3901                 $action .= "/".esc_url($project);
3902         }
3903         print $cgi->startform(-method => "get", -action => $action) .
3904               "<div class=\"search\">\n" .
3905               (!$use_pathinfo &&
3906               $cgi->input({-name=>"p", -value=>$project, -type=>"hidden"}) . "\n") .
3907               $cgi->input({-name=>"a", -value=>"search", -type=>"hidden"}) . "\n" .
3908               $cgi->input({-name=>"h", -value=>$search_hash, -type=>"hidden"}) . "\n" .
3909               $cgi->popup_menu(-name => 'st', -default => 'commit',
3910                                -values => ['commit', 'grep', 'author', 'committer', 'pickaxe']) .
3911               $cgi->sup($cgi->a({-href => href(action=>"search_help")}, "?")) .
3912               " search:\n",
3913               $cgi->textfield(-name => "s", -value => $searchtext, -override => 1) . "\n" .
3914               "<span title=\"Extended regular expression\">" .
3915               $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
3916                              -checked => $search_use_regexp) .
3917               "</span>" .
3918               "</div>" .
3919               $cgi->end_form() . "\n";
3922 sub git_header_html {
3923         my $status = shift || "200 OK";
3924         my $expires = shift;
3925         my %opts = @_;
3927         my $title = get_page_title();
3928         my $content_type = get_content_type_html();
3929         print $cgi->header(-type=>$content_type, -charset => 'utf-8',
3930                            -status=> $status, -expires => $expires)
3931                 unless ($opts{'-no_http_header'});
3932         my $mod_perl_version = $ENV{'MOD_PERL'} ? " $ENV{'MOD_PERL'}" : '';
3933         print <<EOF;
3934 <?xml version="1.0" encoding="utf-8"?>
3935 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3936 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
3937 <!-- git web interface version $version, (C) 2005-2006, Kay Sievers <kay.sievers\@vrfy.org>, Christian Gierke -->
3938 <!-- git core binaries version $git_version -->
3939 <head>
3940 <meta http-equiv="content-type" content="$content_type; charset=utf-8"/>
3941 <meta name="generator" content="gitweb/$version git/$git_version$mod_perl_version"/>
3942 <meta name="robots" content="index, nofollow"/>
3943 <title>$title</title>
3944 EOF
3945         # the stylesheet, favicon etc urls won't work correctly with path_info
3946         # unless we set the appropriate base URL
3947         if ($ENV{'PATH_INFO'}) {
3948                 print "<base href=\"".esc_url($base_url)."\" />\n";
3949         }
3950         print_header_links($status);
3952         if (defined $site_html_head_string) {
3953                 print to_utf8($site_html_head_string);
3954         }
3956         print "</head>\n" .
3957               "<body>\n";
3959         if (defined $site_header && -f $site_header) {
3960                 insert_file($site_header);
3961         }
3963         print "<div class=\"page_header\">\n";
3964         if (defined $logo) {
3965                 print $cgi->a({-href => esc_url($logo_url),
3966                                -title => $logo_label},
3967                               $cgi->img({-src => esc_url($logo),
3968                                          -width => 72, -height => 27,
3969                                          -alt => "git",
3970                                          -class => "logo"}));
3971         }
3972         print_nav_breadcrumbs(%opts);
3973         print "</div>\n";
3975         my $have_search = gitweb_check_feature('search');
3976         if (defined $project && $have_search) {
3977                 print_search_form();
3978         }
3981 sub git_footer_html {
3982         my $feed_class = 'rss_logo';
3984         print "<div class=\"page_footer\">\n";
3985         if (defined $project) {
3986                 my $descr = git_get_project_description($project);
3987                 if (defined $descr) {
3988                         print "<div class=\"page_footer_text\">" . esc_html($descr) . "</div>\n";
3989                 }
3991                 my %href_params = get_feed_info();
3992                 if (!%href_params) {
3993                         $feed_class .= ' generic';
3994                 }
3995                 $href_params{'-title'} ||= 'log';
3997                 foreach my $format (qw(RSS Atom)) {
3998                         $href_params{'action'} = lc($format);
3999                         print $cgi->a({-href => href(%href_params),
4000                                       -title => "$href_params{'-title'} $format feed",
4001                                       -class => $feed_class}, $format)."\n";
4002                 }
4004         } else {
4005                 print $cgi->a({-href => href(project=>undef, action=>"opml",
4006                                              project_filter => $project_filter),
4007                               -class => $feed_class}, "OPML") . " ";
4008                 print $cgi->a({-href => href(project=>undef, action=>"project_index",
4009                                              project_filter => $project_filter),
4010                               -class => $feed_class}, "TXT") . "\n";
4011         }
4012         print "</div>\n"; # class="page_footer"
4014         if (defined $t0 && gitweb_check_feature('timed')) {
4015                 print "<div id=\"generating_info\">\n";
4016                 print 'This page took '.
4017                       '<span id="generating_time" class="time_span">'.
4018                       tv_interval($t0, [ gettimeofday() ]).
4019                       ' seconds </span>'.
4020                       ' and '.
4021                       '<span id="generating_cmd">'.
4022                       $number_of_git_cmds.
4023                       '</span> git commands '.
4024                       " to generate.\n";
4025                 print "</div>\n"; # class="page_footer"
4026         }
4028         if (defined $site_footer && -f $site_footer) {
4029                 insert_file($site_footer);
4030         }
4032         print qq!<script type="text/javascript" src="!.esc_url($javascript).qq!"></script>\n!;
4033         if (defined $action &&
4034             $action eq 'blame_incremental') {
4035                 print qq!<script type="text/javascript">\n!.
4036                       qq!startBlame("!. href(action=>"blame_data", -replay=>1) .qq!",\n!.
4037                       qq!           "!. href() .qq!");\n!.
4038                       qq!</script>\n!;
4039         } else {
4040                 my ($jstimezone, $tz_cookie, $datetime_class) =
4041                         gitweb_get_feature('javascript-timezone');
4043                 print qq!<script type="text/javascript">\n!.
4044                       qq!window.onload = function () {\n!;
4045                 if (gitweb_check_feature('javascript-actions')) {
4046                         print qq!       fixLinks();\n!;
4047                 }
4048                 if ($jstimezone && $tz_cookie && $datetime_class) {
4049                         print qq!       var tz_cookie = { name: '$tz_cookie', expires: 14, path: '/' };\n!. # in days
4050                               qq!       onloadTZSetup('$jstimezone', tz_cookie, '$datetime_class');\n!;
4051                 }
4052                 print qq!};\n!.
4053                       qq!</script>\n!;
4054         }
4056         print "</body>\n" .
4057               "</html>";
4060 # die_error(<http_status_code>, <error_message>[, <detailed_html_description>])
4061 # Example: die_error(404, 'Hash not found')
4062 # By convention, use the following status codes (as defined in RFC 2616):
4063 # 400: Invalid or missing CGI parameters, or
4064 #      requested object exists but has wrong type.
4065 # 403: Requested feature (like "pickaxe" or "snapshot") not enabled on
4066 #      this server or project.
4067 # 404: Requested object/revision/project doesn't exist.
4068 # 500: The server isn't configured properly, or
4069 #      an internal error occurred (e.g. failed assertions caused by bugs), or
4070 #      an unknown error occurred (e.g. the git binary died unexpectedly).
4071 # 503: The server is currently unavailable (because it is overloaded,
4072 #      or down for maintenance).  Generally, this is a temporary state.
4073 sub die_error {
4074         my $status = shift || 500;
4075         my $error = esc_html(shift) || "Internal Server Error";
4076         my $extra = shift;
4077         my %opts = @_;
4079         my %http_responses = (
4080                 400 => '400 Bad Request',
4081                 403 => '403 Forbidden',
4082                 404 => '404 Not Found',
4083                 500 => '500 Internal Server Error',
4084                 503 => '503 Service Unavailable',
4085         );
4086         git_header_html($http_responses{$status}, undef, %opts);
4087         print <<EOF;
4088 <div class="page_body">
4089 <br /><br />
4090 $status - $error
4091 <br />
4092 EOF
4093         if (defined $extra) {
4094                 print "<hr />\n" .
4095                       "$extra\n";
4096         }
4097         print "</div>\n";
4099         git_footer_html();
4100         goto DONE_GITWEB
4101                 unless ($opts{'-error_handler'});
4104 ## ----------------------------------------------------------------------
4105 ## functions printing or outputting HTML: navigation
4107 sub git_print_page_nav {
4108         my ($current, $suppress, $head, $treehead, $treebase, $extra) = @_;
4109         $extra = '' if !defined $extra; # pager or formats
4111         my @navs = qw(summary shortlog log commit commitdiff tree);
4112         if ($suppress) {
4113                 @navs = grep { $_ ne $suppress } @navs;
4114         }
4116         my %arg = map { $_ => {action=>$_} } @navs;
4117         if (defined $head) {
4118                 for (qw(commit commitdiff)) {
4119                         $arg{$_}{'hash'} = $head;
4120                 }
4121                 if ($current =~ m/^(tree | log | shortlog | commit | commitdiff | search)$/x) {
4122                         for (qw(shortlog log)) {
4123                                 $arg{$_}{'hash'} = $head;
4124                         }
4125                 }
4126         }
4128         $arg{'tree'}{'hash'} = $treehead if defined $treehead;
4129         $arg{'tree'}{'hash_base'} = $treebase if defined $treebase;
4131         my @actions = gitweb_get_feature('actions');
4132         my %repl = (
4133                 '%' => '%',
4134                 'n' => $project,         # project name
4135                 'f' => $git_dir,         # project path within filesystem
4136                 'h' => $treehead || '',  # current hash ('h' parameter)
4137                 'b' => $treebase || '',  # hash base ('hb' parameter)
4138         );
4139         while (@actions) {
4140                 my ($label, $link, $pos) = splice(@actions,0,3);
4141                 # insert
4142                 @navs = map { $_ eq $pos ? ($_, $label) : $_ } @navs;
4143                 # munch munch
4144                 $link =~ s/%([%nfhb])/$repl{$1}/g;
4145                 $arg{$label}{'_href'} = $link;
4146         }
4148         print "<div class=\"page_nav\">\n" .
4149                 (join " | ",
4150                  map { $_ eq $current ?
4151                        $_ : $cgi->a({-href => ($arg{$_}{_href} ? $arg{$_}{_href} : href(%{$arg{$_}}))}, "$_")
4152                  } @navs);
4153         print "<br/>\n$extra<br/>\n" .
4154               "</div>\n";
4157 # returns a submenu for the nagivation of the refs views (tags, heads,
4158 # remotes) with the current view disabled and the remotes view only
4159 # available if the feature is enabled
4160 sub format_ref_views {
4161         my ($current) = @_;
4162         my @ref_views = qw{tags heads};
4163         push @ref_views, 'remotes' if gitweb_check_feature('remote_heads');
4164         return join " | ", map {
4165                 $_ eq $current ? $_ :
4166                 $cgi->a({-href => href(action=>$_)}, $_)
4167         } @ref_views
4170 sub format_paging_nav {
4171         my ($action, $page, $has_next_link) = @_;
4172         my $paging_nav;
4175         if ($page > 0) {
4176                 $paging_nav .=
4177                         $cgi->a({-href => href(-replay=>1, page=>undef)}, "first") .
4178                         " &sdot; " .
4179                         $cgi->a({-href => href(-replay=>1, page=>$page-1),
4180                                  -accesskey => "p", -title => "Alt-p"}, "prev");
4181         } else {
4182                 $paging_nav .= "first &sdot; prev";
4183         }
4185         if ($has_next_link) {
4186                 $paging_nav .= " &sdot; " .
4187                         $cgi->a({-href => href(-replay=>1, page=>$page+1),
4188                                  -accesskey => "n", -title => "Alt-n"}, "next");
4189         } else {
4190                 $paging_nav .= " &sdot; next";
4191         }
4193         return $paging_nav;
4196 ## ......................................................................
4197 ## functions printing or outputting HTML: div
4199 sub git_print_header_div {
4200         my ($action, $title, $hash, $hash_base) = @_;
4201         my %args = ();
4203         $args{'action'} = $action;
4204         $args{'hash'} = $hash if $hash;
4205         $args{'hash_base'} = $hash_base if $hash_base;
4207         print "<div class=\"header\">\n" .
4208               $cgi->a({-href => href(%args), -class => "title"},
4209               $title ? $title : $action) .
4210               "\n</div>\n";
4213 sub format_repo_url {
4214         my ($name, $url) = @_;
4215         return "<tr class=\"metadata_url\"><td>$name</td><td>$url</td></tr>\n";
4218 # Group output by placing it in a DIV element and adding a header.
4219 # Options for start_div() can be provided by passing a hash reference as the
4220 # first parameter to the function.
4221 # Options to git_print_header_div() can be provided by passing an array
4222 # reference. This must follow the options to start_div if they are present.
4223 # The content can be a scalar, which is output as-is, a scalar reference, which
4224 # is output after html escaping, an IO handle passed either as *handle or
4225 # *handle{IO}, or a function reference. In the latter case all following
4226 # parameters will be taken as argument to the content function call.
4227 sub git_print_section {
4228         my ($div_args, $header_args, $content);
4229         my $arg = shift;
4230         if (ref($arg) eq 'HASH') {
4231                 $div_args = $arg;
4232                 $arg = shift;
4233         }
4234         if (ref($arg) eq 'ARRAY') {
4235                 $header_args = $arg;
4236                 $arg = shift;
4237         }
4238         $content = $arg;
4240         print $cgi->start_div($div_args);
4241         git_print_header_div(@$header_args);
4243         if (ref($content) eq 'CODE') {
4244                 $content->(@_);
4245         } elsif (ref($content) eq 'SCALAR') {
4246                 print esc_html($$content);
4247         } elsif (ref($content) eq 'GLOB' or ref($content) eq 'IO::Handle') {
4248                 print <$content>;
4249         } elsif (!ref($content) && defined($content)) {
4250                 print $content;
4251         }
4253         print $cgi->end_div;
4256 sub format_timestamp_html {
4257         my $date = shift;
4258         my $strtime = $date->{'rfc2822'};
4260         my (undef, undef, $datetime_class) =
4261                 gitweb_get_feature('javascript-timezone');
4262         if ($datetime_class) {
4263                 $strtime = qq!<span class="$datetime_class">$strtime</span>!;
4264         }
4266         my $localtime_format = '(%02d:%02d %s)';
4267         if ($date->{'hour_local'} < 6) {
4268                 $localtime_format = '(<span class="atnight">%02d:%02d</span> %s)';
4269         }
4270         $strtime .= ' ' .
4271                     sprintf($localtime_format,
4272                             $date->{'hour_local'}, $date->{'minute_local'}, $date->{'tz_local'});
4274         return $strtime;
4277 # Outputs the author name and date in long form
4278 sub git_print_authorship {
4279         my $co = shift;
4280         my %opts = @_;
4281         my $tag = $opts{-tag} || 'div';
4282         my $author = $co->{'author_name'};
4284         my %ad = parse_date($co->{'author_epoch'}, $co->{'author_tz'});
4285         print "<$tag class=\"author_date\">" .
4286               format_search_author($author, "author", esc_html($author)) .
4287               " [".format_timestamp_html(\%ad)."]".
4288               git_get_avatar($co->{'author_email'}, -pad_before => 1) .
4289               "</$tag>\n";
4292 # Outputs table rows containing the full author or committer information,
4293 # in the format expected for 'commit' view (& similar).
4294 # Parameters are a commit hash reference, followed by the list of people
4295 # to output information for. If the list is empty it defaults to both
4296 # author and committer.
4297 sub git_print_authorship_rows {
4298         my $co = shift;
4299         # too bad we can't use @people = @_ || ('author', 'committer')
4300         my @people = @_;
4301         @people = ('author', 'committer') unless @people;
4302         foreach my $who (@people) {
4303                 my %wd = parse_date($co->{"${who}_epoch"}, $co->{"${who}_tz"});
4304                 print "<tr><td>$who</td><td>" .
4305                       format_search_author($co->{"${who}_name"}, $who,
4306                                            esc_html($co->{"${who}_name"})) . " " .
4307                       format_search_author($co->{"${who}_email"}, $who,
4308                                            esc_html("<" . $co->{"${who}_email"} . ">")) .
4309                       "</td><td rowspan=\"2\">" .
4310                       git_get_avatar($co->{"${who}_email"}, -size => 'double') .
4311                       "</td></tr>\n" .
4312                       "<tr>" .
4313                       "<td></td><td>" .
4314                       format_timestamp_html(\%wd) .
4315                       "</td>" .
4316                       "</tr>\n";
4317         }
4320 sub git_print_page_path {
4321         my $name = shift;
4322         my $type = shift;
4323         my $hb = shift;
4326         print "<div class=\"page_path\">";
4327         print $cgi->a({-href => href(action=>"tree", hash_base=>$hb),
4328                       -title => 'tree root'}, to_utf8("[$project]"));
4329         print " / ";
4330         if (defined $name) {
4331                 my @dirname = split '/', $name;
4332                 my $basename = pop @dirname;
4333                 my $fullname = '';
4335                 foreach my $dir (@dirname) {
4336                         $fullname .= ($fullname ? '/' : '') . $dir;
4337                         print $cgi->a({-href => href(action=>"tree", file_name=>$fullname,
4338                                                      hash_base=>$hb),
4339                                       -title => $fullname}, esc_path($dir));
4340                         print " / ";
4341                 }
4342                 if (defined $type && $type eq 'blob') {
4343                         print $cgi->a({-href => href(action=>"blob_plain", file_name=>$file_name,
4344                                                      hash_base=>$hb),
4345                                       -title => $name}, esc_path($basename));
4346                 } elsif (defined $type && $type eq 'tree') {
4347                         print $cgi->a({-href => href(action=>"tree", file_name=>$file_name,
4348                                                      hash_base=>$hb),
4349                                       -title => $name}, esc_path($basename));
4350                         print " / ";
4351                 } else {
4352                         print esc_path($basename);
4353                 }
4354         }
4355         print "<br/></div>\n";
4358 sub git_print_log {
4359         my $log = shift;
4360         my %opts = @_;
4362         if ($opts{'-remove_title'}) {
4363                 # remove title, i.e. first line of log
4364                 shift @$log;
4365         }
4366         # remove leading empty lines
4367         while (defined $log->[0] && $log->[0] eq "") {
4368                 shift @$log;
4369         }
4371         # print log
4372         my $signoff = 0;
4373         my $empty = 0;
4374         foreach my $line (@$log) {
4375                 if ($line =~ m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i) {
4376                         $signoff = 1;
4377                         $empty = 0;
4378                         if (! $opts{'-remove_signoff'}) {
4379                                 print "<span class=\"signoff\">" . esc_html($line) . "</span><br/>\n";
4380                                 next;
4381                         } else {
4382                                 # remove signoff lines
4383                                 next;
4384                         }
4385                 } else {
4386                         $signoff = 0;
4387                 }
4389                 # print only one empty line
4390                 # do not print empty line after signoff
4391                 if ($line eq "") {
4392                         next if ($empty || $signoff);
4393                         $empty = 1;
4394                 } else {
4395                         $empty = 0;
4396                 }
4398                 print format_log_line_html($line) . "<br/>\n";
4399         }
4401         if ($opts{'-final_empty_line'}) {
4402                 # end with single empty line
4403                 print "<br/>\n" unless $empty;
4404         }
4407 # return link target (what link points to)
4408 sub git_get_link_target {
4409         my $hash = shift;
4410         my $link_target;
4412         # read link
4413         open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
4414                 or return;
4415         {
4416                 local $/ = undef;
4417                 $link_target = <$fd>;
4418         }
4419         close $fd
4420                 or return;
4422         return $link_target;
4425 # given link target, and the directory (basedir) the link is in,
4426 # return target of link relative to top directory (top tree);
4427 # return undef if it is not possible (including absolute links).
4428 sub normalize_link_target {
4429         my ($link_target, $basedir) = @_;
4431         # absolute symlinks (beginning with '/') cannot be normalized
4432         return if (substr($link_target, 0, 1) eq '/');
4434         # normalize link target to path from top (root) tree (dir)
4435         my $path;
4436         if ($basedir) {
4437                 $path = $basedir . '/' . $link_target;
4438         } else {
4439                 # we are in top (root) tree (dir)
4440                 $path = $link_target;
4441         }
4443         # remove //, /./, and /../
4444         my @path_parts;
4445         foreach my $part (split('/', $path)) {
4446                 # discard '.' and ''
4447                 next if (!$part || $part eq '.');
4448                 # handle '..'
4449                 if ($part eq '..') {
4450                         if (@path_parts) {
4451                                 pop @path_parts;
4452                         } else {
4453                                 # link leads outside repository (outside top dir)
4454                                 return;
4455                         }
4456                 } else {
4457                         push @path_parts, $part;
4458                 }
4459         }
4460         $path = join('/', @path_parts);
4462         return $path;
4465 # print tree entry (row of git_tree), but without encompassing <tr> element
4466 sub git_print_tree_entry {
4467         my ($t, $basedir, $hash_base, $have_blame) = @_;
4469         my %base_key = ();
4470         $base_key{'hash_base'} = $hash_base if defined $hash_base;
4472         # The format of a table row is: mode list link.  Where mode is
4473         # the mode of the entry, list is the name of the entry, an href,
4474         # and link is the action links of the entry.
4476         print "<td class=\"mode\">" . mode_str($t->{'mode'}) . "</td>\n";
4477         if (exists $t->{'size'}) {
4478                 print "<td class=\"size\">$t->{'size'}</td>\n";
4479         }
4480         if ($t->{'type'} eq "blob") {
4481                 print "<td class=\"list\">" .
4482                         $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4483                                                file_name=>"$basedir$t->{'name'}", %base_key),
4484                                 -class => "list"}, esc_path($t->{'name'}));
4485                 if (S_ISLNK(oct $t->{'mode'})) {
4486                         my $link_target = git_get_link_target($t->{'hash'});
4487                         if ($link_target) {
4488                                 my $norm_target = normalize_link_target($link_target, $basedir);
4489                                 if (defined $norm_target) {
4490                                         print " -> " .
4491                                               $cgi->a({-href => href(action=>"object", hash_base=>$hash_base,
4492                                                                      file_name=>$norm_target),
4493                                                        -title => $norm_target}, esc_path($link_target));
4494                                 } else {
4495                                         print " -> " . esc_path($link_target);
4496                                 }
4497                         }
4498                 }
4499                 print "</td>\n";
4500                 print "<td class=\"link\">";
4501                 print $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4502                                              file_name=>"$basedir$t->{'name'}", %base_key)},
4503                               "blob");
4504                 if ($have_blame) {
4505                         print " | " .
4506                               $cgi->a({-href => href(action=>"blame", hash=>$t->{'hash'},
4507                                                      file_name=>"$basedir$t->{'name'}", %base_key)},
4508                                       "blame");
4509                 }
4510                 if (defined $hash_base) {
4511                         print " | " .
4512                               $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4513                                                      hash=>$t->{'hash'}, file_name=>"$basedir$t->{'name'}")},
4514                                       "history");
4515                 }
4516                 print " | " .
4517                         $cgi->a({-href => href(action=>"blob_plain", hash_base=>$hash_base,
4518                                                file_name=>"$basedir$t->{'name'}")},
4519                                 "raw");
4520                 print "</td>\n";
4522         } elsif ($t->{'type'} eq "tree") {
4523                 print "<td class=\"list\">";
4524                 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4525                                              file_name=>"$basedir$t->{'name'}",
4526                                              %base_key)},
4527                               esc_path($t->{'name'}));
4528                 print "</td>\n";
4529                 print "<td class=\"link\">";
4530                 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4531                                              file_name=>"$basedir$t->{'name'}",
4532                                              %base_key)},
4533                               "tree");
4534                 if (defined $hash_base) {
4535                         print " | " .
4536                               $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4537                                                      file_name=>"$basedir$t->{'name'}")},
4538                                       "history");
4539                 }
4540                 print "</td>\n";
4541         } else {
4542                 # unknown object: we can only present history for it
4543                 # (this includes 'commit' object, i.e. submodule support)
4544                 print "<td class=\"list\">" .
4545                       esc_path($t->{'name'}) .
4546                       "</td>\n";
4547                 print "<td class=\"link\">";
4548                 if (defined $hash_base) {
4549                         print $cgi->a({-href => href(action=>"history",
4550                                                      hash_base=>$hash_base,
4551                                                      file_name=>"$basedir$t->{'name'}")},
4552                                       "history");
4553                 }
4554                 print "</td>\n";
4555         }
4558 ## ......................................................................
4559 ## functions printing large fragments of HTML
4561 # get pre-image filenames for merge (combined) diff
4562 sub fill_from_file_info {
4563         my ($diff, @parents) = @_;
4565         $diff->{'from_file'} = [ ];
4566         $diff->{'from_file'}[$diff->{'nparents'} - 1] = undef;
4567         for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4568                 if ($diff->{'status'}[$i] eq 'R' ||
4569                     $diff->{'status'}[$i] eq 'C') {
4570                         $diff->{'from_file'}[$i] =
4571                                 git_get_path_by_hash($parents[$i], $diff->{'from_id'}[$i]);
4572                 }
4573         }
4575         return $diff;
4578 # is current raw difftree line of file deletion
4579 sub is_deleted {
4580         my $diffinfo = shift;
4582         return $diffinfo->{'to_id'} eq ('0' x 40);
4585 # does patch correspond to [previous] difftree raw line
4586 # $diffinfo  - hashref of parsed raw diff format
4587 # $patchinfo - hashref of parsed patch diff format
4588 #              (the same keys as in $diffinfo)
4589 sub is_patch_split {
4590         my ($diffinfo, $patchinfo) = @_;
4592         return defined $diffinfo && defined $patchinfo
4593                 && $diffinfo->{'to_file'} eq $patchinfo->{'to_file'};
4597 sub git_difftree_body {
4598         my ($difftree, $hash, @parents) = @_;
4599         my ($parent) = $parents[0];
4600         my $have_blame = gitweb_check_feature('blame');
4601         print "<div class=\"list_head\">\n";
4602         if ($#{$difftree} > 10) {
4603                 print(($#{$difftree} + 1) . " files changed:\n");
4604         }
4605         print "</div>\n";
4607         print "<table class=\"" .
4608               (@parents > 1 ? "combined " : "") .
4609               "diff_tree\">\n";
4611         # header only for combined diff in 'commitdiff' view
4612         my $has_header = @$difftree && @parents > 1 && $action eq 'commitdiff';
4613         if ($has_header) {
4614                 # table header
4615                 print "<thead><tr>\n" .
4616                        "<th></th><th></th>\n"; # filename, patchN link
4617                 for (my $i = 0; $i < @parents; $i++) {
4618                         my $par = $parents[$i];
4619                         print "<th>" .
4620                               $cgi->a({-href => href(action=>"commitdiff",
4621                                                      hash=>$hash, hash_parent=>$par),
4622                                        -title => 'commitdiff to parent number ' .
4623                                                   ($i+1) . ': ' . substr($par,0,7)},
4624                                       $i+1) .
4625                               "&nbsp;</th>\n";
4626                 }
4627                 print "</tr></thead>\n<tbody>\n";
4628         }
4630         my $alternate = 1;
4631         my $patchno = 0;
4632         foreach my $line (@{$difftree}) {
4633                 my $diff = parsed_difftree_line($line);
4635                 if ($alternate) {
4636                         print "<tr class=\"dark\">\n";
4637                 } else {
4638                         print "<tr class=\"light\">\n";
4639                 }
4640                 $alternate ^= 1;
4642                 if (exists $diff->{'nparents'}) { # combined diff
4644                         fill_from_file_info($diff, @parents)
4645                                 unless exists $diff->{'from_file'};
4647                         if (!is_deleted($diff)) {
4648                                 # file exists in the result (child) commit
4649                                 print "<td>" .
4650                                       $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4651                                                              file_name=>$diff->{'to_file'},
4652                                                              hash_base=>$hash),
4653                                               -class => "list"}, esc_path($diff->{'to_file'})) .
4654                                       "</td>\n";
4655                         } else {
4656                                 print "<td>" .
4657                                       esc_path($diff->{'to_file'}) .
4658                                       "</td>\n";
4659                         }
4661                         if ($action eq 'commitdiff') {
4662                                 # link to patch
4663                                 $patchno++;
4664                                 print "<td class=\"link\">" .
4665                                       $cgi->a({-href => href(-anchor=>"patch$patchno")},
4666                                               "patch") .
4667                                       " | " .
4668                                       "</td>\n";
4669                         }
4671                         my $has_history = 0;
4672                         my $not_deleted = 0;
4673                         for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4674                                 my $hash_parent = $parents[$i];
4675                                 my $from_hash = $diff->{'from_id'}[$i];
4676                                 my $from_path = $diff->{'from_file'}[$i];
4677                                 my $status = $diff->{'status'}[$i];
4679                                 $has_history ||= ($status ne 'A');
4680                                 $not_deleted ||= ($status ne 'D');
4682                                 if ($status eq 'A') {
4683                                         print "<td  class=\"link\" align=\"right\"> | </td>\n";
4684                                 } elsif ($status eq 'D') {
4685                                         print "<td class=\"link\">" .
4686                                               $cgi->a({-href => href(action=>"blob",
4687                                                                      hash_base=>$hash,
4688                                                                      hash=>$from_hash,
4689                                                                      file_name=>$from_path)},
4690                                                       "blob" . ($i+1)) .
4691                                               " | </td>\n";
4692                                 } else {
4693                                         if ($diff->{'to_id'} eq $from_hash) {
4694                                                 print "<td class=\"link nochange\">";
4695                                         } else {
4696                                                 print "<td class=\"link\">";
4697                                         }
4698                                         print $cgi->a({-href => href(action=>"blobdiff",
4699                                                                      hash=>$diff->{'to_id'},
4700                                                                      hash_parent=>$from_hash,
4701                                                                      hash_base=>$hash,
4702                                                                      hash_parent_base=>$hash_parent,
4703                                                                      file_name=>$diff->{'to_file'},
4704                                                                      file_parent=>$from_path)},
4705                                                       "diff" . ($i+1)) .
4706                                               " | </td>\n";
4707                                 }
4708                         }
4710                         print "<td class=\"link\">";
4711                         if ($not_deleted) {
4712                                 print $cgi->a({-href => href(action=>"blob",
4713                                                              hash=>$diff->{'to_id'},
4714                                                              file_name=>$diff->{'to_file'},
4715                                                              hash_base=>$hash)},
4716                                               "blob");
4717                                 print " | " if ($has_history);
4718                         }
4719                         if ($has_history) {
4720                                 print $cgi->a({-href => href(action=>"history",
4721                                                              file_name=>$diff->{'to_file'},
4722                                                              hash_base=>$hash)},
4723                                               "history");
4724                         }
4725                         print "</td>\n";
4727                         print "</tr>\n";
4728                         next; # instead of 'else' clause, to avoid extra indent
4729                 }
4730                 # else ordinary diff
4732                 my ($to_mode_oct, $to_mode_str, $to_file_type);
4733                 my ($from_mode_oct, $from_mode_str, $from_file_type);
4734                 if ($diff->{'to_mode'} ne ('0' x 6)) {
4735                         $to_mode_oct = oct $diff->{'to_mode'};
4736                         if (S_ISREG($to_mode_oct)) { # only for regular file
4737                                 $to_mode_str = sprintf("%04o", $to_mode_oct & 0777); # permission bits
4738                         }
4739                         $to_file_type = file_type($diff->{'to_mode'});
4740                 }
4741                 if ($diff->{'from_mode'} ne ('0' x 6)) {
4742                         $from_mode_oct = oct $diff->{'from_mode'};
4743                         if (S_ISREG($from_mode_oct)) { # only for regular file
4744                                 $from_mode_str = sprintf("%04o", $from_mode_oct & 0777); # permission bits
4745                         }
4746                         $from_file_type = file_type($diff->{'from_mode'});
4747                 }
4749                 if ($diff->{'status'} eq "A") { # created
4750                         my $mode_chng = "<span class=\"file_status new\">[new $to_file_type";
4751                         $mode_chng   .= " with mode: $to_mode_str" if $to_mode_str;
4752                         $mode_chng   .= "]</span>";
4753                         print "<td>";
4754                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4755                                                      hash_base=>$hash, file_name=>$diff->{'file'}),
4756                                       -class => "list"}, esc_path($diff->{'file'}));
4757                         print "</td>\n";
4758                         print "<td>$mode_chng</td>\n";
4759                         print "<td class=\"link\">";
4760                         if ($action eq 'commitdiff') {
4761                                 # link to patch
4762                                 $patchno++;
4763                                 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4764                                               "patch") .
4765                                       " | ";
4766                         }
4767                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4768                                                      hash_base=>$hash, file_name=>$diff->{'file'})},
4769                                       "blob");
4770                         print "</td>\n";
4772                 } elsif ($diff->{'status'} eq "D") { # deleted
4773                         my $mode_chng = "<span class=\"file_status deleted\">[deleted $from_file_type]</span>";
4774                         print "<td>";
4775                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
4776                                                      hash_base=>$parent, file_name=>$diff->{'file'}),
4777                                        -class => "list"}, esc_path($diff->{'file'}));
4778                         print "</td>\n";
4779                         print "<td>$mode_chng</td>\n";
4780                         print "<td class=\"link\">";
4781                         if ($action eq 'commitdiff') {
4782                                 # link to patch
4783                                 $patchno++;
4784                                 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4785                                               "patch") .
4786                                       " | ";
4787                         }
4788                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
4789                                                      hash_base=>$parent, file_name=>$diff->{'file'})},
4790                                       "blob") . " | ";
4791                         if ($have_blame) {
4792                                 print $cgi->a({-href => href(action=>"blame", hash_base=>$parent,
4793                                                              file_name=>$diff->{'file'})},
4794                                               "blame") . " | ";
4795                         }
4796                         print $cgi->a({-href => href(action=>"history", hash_base=>$parent,
4797                                                      file_name=>$diff->{'file'})},
4798                                       "history");
4799                         print "</td>\n";
4801                 } elsif ($diff->{'status'} eq "M" || $diff->{'status'} eq "T") { # modified, or type changed
4802                         my $mode_chnge = "";
4803                         if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
4804                                 $mode_chnge = "<span class=\"file_status mode_chnge\">[changed";
4805                                 if ($from_file_type ne $to_file_type) {
4806                                         $mode_chnge .= " from $from_file_type to $to_file_type";
4807                                 }
4808                                 if (($from_mode_oct & 0777) != ($to_mode_oct & 0777)) {
4809                                         if ($from_mode_str && $to_mode_str) {
4810                                                 $mode_chnge .= " mode: $from_mode_str->$to_mode_str";
4811                                         } elsif ($to_mode_str) {
4812                                                 $mode_chnge .= " mode: $to_mode_str";
4813                                         }
4814                                 }
4815                                 $mode_chnge .= "]</span>\n";
4816                         }
4817                         print "<td>";
4818                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4819                                                      hash_base=>$hash, file_name=>$diff->{'file'}),
4820                                       -class => "list"}, esc_path($diff->{'file'}));
4821                         print "</td>\n";
4822                         print "<td>$mode_chnge</td>\n";
4823                         print "<td class=\"link\">";
4824                         if ($action eq 'commitdiff') {
4825                                 # link to patch
4826                                 $patchno++;
4827                                 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4828                                               "patch") .
4829                                       " | ";
4830                         } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
4831                                 # "commit" view and modified file (not onlu mode changed)
4832                                 print $cgi->a({-href => href(action=>"blobdiff",
4833                                                              hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
4834                                                              hash_base=>$hash, hash_parent_base=>$parent,
4835                                                              file_name=>$diff->{'file'})},
4836                                               "diff") .
4837                                       " | ";
4838                         }
4839                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4840                                                      hash_base=>$hash, file_name=>$diff->{'file'})},
4841                                        "blob") . " | ";
4842                         if ($have_blame) {
4843                                 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
4844                                                              file_name=>$diff->{'file'})},
4845                                               "blame") . " | ";
4846                         }
4847                         print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
4848                                                      file_name=>$diff->{'file'})},
4849                                       "history");
4850                         print "</td>\n";
4852                 } elsif ($diff->{'status'} eq "R" || $diff->{'status'} eq "C") { # renamed or copied
4853                         my %status_name = ('R' => 'moved', 'C' => 'copied');
4854                         my $nstatus = $status_name{$diff->{'status'}};
4855                         my $mode_chng = "";
4856                         if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
4857                                 # mode also for directories, so we cannot use $to_mode_str
4858                                 $mode_chng = sprintf(", mode: %04o", $to_mode_oct & 0777);
4859                         }
4860                         print "<td>" .
4861                               $cgi->a({-href => href(action=>"blob", hash_base=>$hash,
4862                                                      hash=>$diff->{'to_id'}, file_name=>$diff->{'to_file'}),
4863                                       -class => "list"}, esc_path($diff->{'to_file'})) . "</td>\n" .
4864                               "<td><span class=\"file_status $nstatus\">[$nstatus from " .
4865                               $cgi->a({-href => href(action=>"blob", hash_base=>$parent,
4866                                                      hash=>$diff->{'from_id'}, file_name=>$diff->{'from_file'}),
4867                                       -class => "list"}, esc_path($diff->{'from_file'})) .
4868                               " with " . (int $diff->{'similarity'}) . "% similarity$mode_chng]</span></td>\n" .
4869                               "<td class=\"link\">";
4870                         if ($action eq 'commitdiff') {
4871                                 # link to patch
4872                                 $patchno++;
4873                                 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4874                                               "patch") .
4875                                       " | ";
4876                         } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
4877                                 # "commit" view and modified file (not only pure rename or copy)
4878                                 print $cgi->a({-href => href(action=>"blobdiff",
4879                                                              hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
4880                                                              hash_base=>$hash, hash_parent_base=>$parent,
4881                                                              file_name=>$diff->{'to_file'}, file_parent=>$diff->{'from_file'})},
4882                                               "diff") .
4883                                       " | ";
4884                         }
4885                         print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4886                                                      hash_base=>$parent, file_name=>$diff->{'to_file'})},
4887                                       "blob") . " | ";
4888                         if ($have_blame) {
4889                                 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
4890                                                              file_name=>$diff->{'to_file'})},
4891                                               "blame") . " | ";
4892                         }
4893                         print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
4894                                                     file_name=>$diff->{'to_file'})},
4895                                       "history");
4896                         print "</td>\n";
4898                 } # we should not encounter Unmerged (U) or Unknown (X) status
4899                 print "</tr>\n";
4900         }
4901         print "</tbody>" if $has_header;
4902         print "</table>\n";
4905 sub print_sidebyside_diff_chunk {
4906         my @chunk = @_;
4907         my (@ctx, @rem, @add);
4909         return unless @chunk;
4911         # incomplete last line might be among removed or added lines,
4912         # or both, or among context lines: find which
4913         for (my $i = 1; $i < @chunk; $i++) {
4914                 if ($chunk[$i][0] eq 'incomplete') {
4915                         $chunk[$i][0] = $chunk[$i-1][0];
4916                 }
4917         }
4919         # guardian
4920         push @chunk, ["", ""];
4922         foreach my $line_info (@chunk) {
4923                 my ($class, $line) = @$line_info;
4925                 # print chunk headers
4926                 if ($class && $class eq 'chunk_header') {
4927                         print $line;
4928                         next;
4929                 }
4931                 ## print from accumulator when type of class of lines change
4932                 # empty contents block on start rem/add block, or end of chunk
4933                 if (@ctx && (!$class || $class eq 'rem' || $class eq 'add')) {
4934                         print join '',
4935                                 '<div class="chunk_block ctx">',
4936                                         '<div class="old">',
4937                                         @ctx,
4938                                         '</div>',
4939                                         '<div class="new">',
4940                                         @ctx,
4941                                         '</div>',
4942                                 '</div>';
4943                         @ctx = ();
4944                 }
4945                 # empty add/rem block on start context block, or end of chunk
4946                 if ((@rem || @add) && (!$class || $class eq 'ctx')) {
4947                         if (!@add) {
4948                                 # pure removal
4949                                 print join '',
4950                                         '<div class="chunk_block rem">',
4951                                                 '<div class="old">',
4952                                                 @rem,
4953                                                 '</div>',
4954                                         '</div>';
4955                         } elsif (!@rem) {
4956                                 # pure addition
4957                                 print join '',
4958                                         '<div class="chunk_block add">',
4959                                                 '<div class="new">',
4960                                                 @add,
4961                                                 '</div>',
4962                                         '</div>';
4963                         } else {
4964                                 # assume that it is change
4965                                 print join '',
4966                                         '<div class="chunk_block chg">',
4967                                                 '<div class="old">',
4968                                                 @rem,
4969                                                 '</div>',
4970                                                 '<div class="new">',
4971                                                 @add,
4972                                                 '</div>',
4973                                         '</div>';
4974                         }
4975                         @rem = @add = ();
4976                 }
4978                 ## adding lines to accumulator
4979                 # guardian value
4980                 last unless $line;
4981                 # rem, add or change
4982                 if ($class eq 'rem') {
4983                         push @rem, $line;
4984                 } elsif ($class eq 'add') {
4985                         push @add, $line;
4986                 }
4987                 # context line
4988                 if ($class eq 'ctx') {
4989                         push @ctx, $line;
4990                 }
4991         }
4994 sub git_patchset_body {
4995         my ($fd, $diff_style, $difftree, $hash, @hash_parents) = @_;
4996         my ($hash_parent) = $hash_parents[0];
4998         my $is_combined = (@hash_parents > 1);
4999         my $patch_idx = 0;
5000         my $patch_number = 0;
5001         my $patch_line;
5002         my $diffinfo;
5003         my $to_name;
5004         my (%from, %to);
5005         my @chunk; # for side-by-side diff
5007         print "<div class=\"patchset\">\n";
5009         # skip to first patch
5010         while ($patch_line = <$fd>) {
5011                 chomp $patch_line;
5013                 last if ($patch_line =~ m/^diff /);
5014         }
5016  PATCH:
5017         while ($patch_line) {
5019                 # parse "git diff" header line
5020                 if ($patch_line =~ m/^diff --git (\"(?:[^\\\"]*(?:\\.[^\\\"]*)*)\"|[^ "]*) (.*)$/) {
5021                         # $1 is from_name, which we do not use
5022                         $to_name = unquote($2);
5023                         $to_name =~ s!^b/!!;
5024                 } elsif ($patch_line =~ m/^diff --(cc|combined) ("?.*"?)$/) {
5025                         # $1 is 'cc' or 'combined', which we do not use
5026                         $to_name = unquote($2);
5027                 } else {
5028                         $to_name = undef;
5029                 }
5031                 # check if current patch belong to current raw line
5032                 # and parse raw git-diff line if needed
5033                 if (is_patch_split($diffinfo, { 'to_file' => $to_name })) {
5034                         # this is continuation of a split patch
5035                         print "<div class=\"patch cont\">\n";
5036                 } else {
5037                         # advance raw git-diff output if needed
5038                         $patch_idx++ if defined $diffinfo;
5040                         # read and prepare patch information
5041                         $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5043                         # compact combined diff output can have some patches skipped
5044                         # find which patch (using pathname of result) we are at now;
5045                         if ($is_combined) {
5046                                 while ($to_name ne $diffinfo->{'to_file'}) {
5047                                         print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5048                                               format_diff_cc_simplified($diffinfo, @hash_parents) .
5049                                               "</div>\n";  # class="patch"
5051                                         $patch_idx++;
5052                                         $patch_number++;
5054                                         last if $patch_idx > $#$difftree;
5055                                         $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5056                                 }
5057                         }
5059                         # modifies %from, %to hashes
5060                         parse_from_to_diffinfo($diffinfo, \%from, \%to, @hash_parents);
5062                         # this is first patch for raw difftree line with $patch_idx index
5063                         # we index @$difftree array from 0, but number patches from 1
5064                         print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n";
5065                 }
5067                 # git diff header
5068                 #assert($patch_line =~ m/^diff /) if DEBUG;
5069                 #assert($patch_line !~ m!$/$!) if DEBUG; # is chomp-ed
5070                 $patch_number++;
5071                 # print "git diff" header
5072                 print format_git_diff_header_line($patch_line, $diffinfo,
5073                                                   \%from, \%to);
5075                 # print extended diff header
5076                 print "<div class=\"diff extended_header\">\n";
5077         EXTENDED_HEADER:
5078                 while ($patch_line = <$fd>) {
5079                         chomp $patch_line;
5081                         last EXTENDED_HEADER if ($patch_line =~ m/^--- |^diff /);
5083                         print format_extended_diff_header_line($patch_line, $diffinfo,
5084                                                                \%from, \%to);
5085                 }
5086                 print "</div>\n"; # class="diff extended_header"
5088                 # from-file/to-file diff header
5089                 if (! $patch_line) {
5090                         print "</div>\n"; # class="patch"
5091                         last PATCH;
5092                 }
5093                 next PATCH if ($patch_line =~ m/^diff /);
5094                 #assert($patch_line =~ m/^---/) if DEBUG;
5096                 my $last_patch_line = $patch_line;
5097                 $patch_line = <$fd>;
5098                 chomp $patch_line;
5099                 #assert($patch_line =~ m/^\+\+\+/) if DEBUG;
5101                 print format_diff_from_to_header($last_patch_line, $patch_line,
5102                                                  $diffinfo, \%from, \%to,
5103                                                  @hash_parents);
5105                 # the patch itself
5106         LINE:
5107                 while ($patch_line = <$fd>) {
5108                         chomp $patch_line;
5110                         next PATCH if ($patch_line =~ m/^diff /);
5112                         my ($class, $line) = process_diff_line($patch_line, \%from, \%to);
5113                         my $diff_classes = "diff";
5114                         $diff_classes .= " $class" if ($class);
5115                         $line = "<div class=\"$diff_classes\">$line</div>\n";
5117                         if ($diff_style eq 'sidebyside' && !$is_combined) {
5118                                 if ($class eq 'chunk_header') {
5119                                         print_sidebyside_diff_chunk(@chunk);
5120                                         @chunk = ( [ $class, $line ] );
5121                                 } else {
5122                                         push @chunk, [ $class, $line ];
5123                                 }
5124                         } else {
5125                                 # default 'inline' style and unknown styles
5126                                 print $line;
5127                         }
5128                 }
5130         } continue {
5131                 if (@chunk) {
5132                         print_sidebyside_diff_chunk(@chunk);
5133                         @chunk = ();
5134                 }
5135                 print "</div>\n"; # class="patch"
5136         }
5138         # for compact combined (--cc) format, with chunk and patch simplification
5139         # the patchset might be empty, but there might be unprocessed raw lines
5140         for (++$patch_idx if $patch_number > 0;
5141              $patch_idx < @$difftree;
5142              ++$patch_idx) {
5143                 # read and prepare patch information
5144                 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5146                 # generate anchor for "patch" links in difftree / whatchanged part
5147                 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5148                       format_diff_cc_simplified($diffinfo, @hash_parents) .
5149                       "</div>\n";  # class="patch"
5151                 $patch_number++;
5152         }
5154         if ($patch_number == 0) {
5155                 if (@hash_parents > 1) {
5156                         print "<div class=\"diff nodifferences\">Trivial merge</div>\n";
5157                 } else {
5158                         print "<div class=\"diff nodifferences\">No differences found</div>\n";
5159                 }
5160         }
5162         print "</div>\n"; # class="patchset"
5165 # . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5167 sub git_project_search_form {
5168         my ($searchtext, $search_use_regexp);
5170         my $limit = '';
5171         if ($project_filter) {
5172                 $limit = " in '$project_filter/'";
5173         }
5175         print "<div class=\"projsearch\">\n";
5176         print $cgi->startform(-method => 'get', -action => $my_uri) .
5177               $cgi->hidden(-name => 'a', -value => 'project_list')  . "\n";
5178         print $cgi->hidden(-name => 'pf', -value => $project_filter). "\n"
5179                 if (defined $project_filter);
5180         print $cgi->textfield(-name => 's', -value => $searchtext,
5181                               -title => "Search project by name and description$limit",
5182                               -size => 60) . "\n" .
5183               "<span title=\"Extended regular expression\">" .
5184               $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
5185                              -checked => $search_use_regexp) .
5186               "</span>\n" .
5187               $cgi->submit(-name => 'btnS', -value => 'Search') .
5188               $cgi->end_form() . "\n" .
5189               $cgi->a({-href => href(project => undef, searchtext => undef,
5190                                      project_filter => $project_filter)},
5191                       esc_html("List all projects$limit")) . "<br />\n";
5192         print "</div>\n";
5195 # entry for given @keys needs filling if at least one of keys in list
5196 # is not present in %$project_info
5197 sub project_info_needs_filling {
5198         my ($project_info, @keys) = @_;
5200         # return List::MoreUtils::any { !exists $project_info->{$_} } @keys;
5201         foreach my $key (@keys) {
5202                 if (!exists $project_info->{$key}) {
5203                         return 1;
5204                 }
5205         }
5206         return;
5209 # fills project list info (age, description, owner, category, forks, etc.)
5210 # for each project in the list, removing invalid projects from
5211 # returned list, or fill only specified info.
5213 # Invalid projects are removed from the returned list if and only if you
5214 # ask 'age' or 'age_string' to be filled, because they are the only fields
5215 # that run unconditionally git command that requires repository, and
5216 # therefore do always check if project repository is invalid.
5218 # USAGE:
5219 # * fill_project_list_info(\@project_list, 'descr_long', 'ctags')
5220 #   ensures that 'descr_long' and 'ctags' fields are filled
5221 # * @project_list = fill_project_list_info(\@project_list)
5222 #   ensures that all fields are filled (and invalid projects removed)
5224 # NOTE: modifies $projlist, but does not remove entries from it
5225 sub fill_project_list_info {
5226         my ($projlist, @wanted_keys) = @_;
5227         my @projects;
5228         my $filter_set = sub { return @_; };
5229         if (@wanted_keys) {
5230                 my %wanted_keys = map { $_ => 1 } @wanted_keys;
5231                 $filter_set = sub { return grep { $wanted_keys{$_} } @_; };
5232         }
5234         my $show_ctags = gitweb_check_feature('ctags');
5235  PROJECT:
5236         foreach my $pr (@$projlist) {
5237                 if (project_info_needs_filling($pr, $filter_set->('age', 'age_string'))) {
5238                         my (@activity) = git_get_last_activity($pr->{'path'});
5239                         unless (@activity) {
5240                                 next PROJECT;
5241                         }
5242                         ($pr->{'age'}, $pr->{'age_string'}) = @activity;
5243                 }
5244                 if (project_info_needs_filling($pr, $filter_set->('descr', 'descr_long'))) {
5245                         my $descr = git_get_project_description($pr->{'path'}) || "";
5246                         $descr = to_utf8($descr);
5247                         $pr->{'descr_long'} = $descr;
5248                         $pr->{'descr'} = chop_str($descr, $projects_list_description_width, 5);
5249                 }
5250                 if (project_info_needs_filling($pr, $filter_set->('owner'))) {
5251                         $pr->{'owner'} = git_get_project_owner("$pr->{'path'}") || "";
5252                 }
5253                 if ($show_ctags &&
5254                     project_info_needs_filling($pr, $filter_set->('ctags'))) {
5255                         $pr->{'ctags'} = git_get_project_ctags($pr->{'path'});
5256                 }
5257                 if ($projects_list_group_categories &&
5258                     project_info_needs_filling($pr, $filter_set->('category'))) {
5259                         my $cat = git_get_project_category($pr->{'path'}) ||
5260                                                            $project_list_default_category;
5261                         $pr->{'category'} = to_utf8($cat);
5262                 }
5264                 push @projects, $pr;
5265         }
5267         return @projects;
5270 sub sort_projects_list {
5271         my ($projlist, $order) = @_;
5272         my @projects;
5274         my %order_info = (
5275                 project => { key => 'path', type => 'str' },
5276                 descr => { key => 'descr_long', type => 'str' },
5277                 owner => { key => 'owner', type => 'str' },
5278                 age => { key => 'age', type => 'num' }
5279         );
5280         my $oi = $order_info{$order};
5281         return @$projlist unless defined $oi;
5282         if ($oi->{'type'} eq 'str') {
5283                 @projects = sort {$a->{$oi->{'key'}} cmp $b->{$oi->{'key'}}} @$projlist;
5284         } else {
5285                 @projects = sort {$a->{$oi->{'key'}} <=> $b->{$oi->{'key'}}} @$projlist;
5286         }
5288         return @projects;
5291 # returns a hash of categories, containing the list of project
5292 # belonging to each category
5293 sub build_projlist_by_category {
5294         my ($projlist, $from, $to) = @_;
5295         my %categories;
5297         $from = 0 unless defined $from;
5298         $to = $#$projlist if (!defined $to || $#$projlist < $to);
5300         for (my $i = $from; $i <= $to; $i++) {
5301                 my $pr = $projlist->[$i];
5302                 push @{$categories{ $pr->{'category'} }}, $pr;
5303         }
5305         return wantarray ? %categories : \%categories;
5308 # print 'sort by' <th> element, generating 'sort by $name' replay link
5309 # if that order is not selected
5310 sub print_sort_th {
5311         print format_sort_th(@_);
5314 sub format_sort_th {
5315         my ($name, $order, $header) = @_;
5316         my $sort_th = "";
5317         $header ||= ucfirst($name);
5319         if ($order eq $name) {
5320                 $sort_th .= "<th>$header</th>\n";
5321         } else {
5322                 $sort_th .= "<th>" .
5323                             $cgi->a({-href => href(-replay=>1, order=>$name),
5324                                      -class => "header"}, $header) .
5325                             "</th>\n";
5326         }
5328         return $sort_th;
5331 sub git_project_list_rows {
5332         my ($projlist, $from, $to, $check_forks) = @_;
5334         $from = 0 unless defined $from;
5335         $to = $#$projlist if (!defined $to || $#$projlist < $to);
5337         my $alternate = 1;
5338         for (my $i = $from; $i <= $to; $i++) {
5339                 my $pr = $projlist->[$i];
5341                 if ($alternate) {
5342                         print "<tr class=\"dark\">\n";
5343                 } else {
5344                         print "<tr class=\"light\">\n";
5345                 }
5346                 $alternate ^= 1;
5348                 if ($check_forks) {
5349                         print "<td>";
5350                         if ($pr->{'forks'}) {
5351                                 my $nforks = scalar @{$pr->{'forks'}};
5352                                 if ($nforks > 0) {
5353                                         print $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks"),
5354                                                        -title => "$nforks forks"}, "+");
5355                                 } else {
5356                                         print $cgi->span({-title => "$nforks forks"}, "+");
5357                                 }
5358                         }
5359                         print "</td>\n";
5360                 }
5361                 print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5362                                         -class => "list"}, esc_html($pr->{'path'})) . "</td>\n" .
5363                       "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5364                                         -class => "list", -title => $pr->{'descr_long'}},
5365                                         esc_html($pr->{'descr'})) . "</td>\n" .
5366                       "<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n";
5367                 print "<td class=\"". age_class($pr->{'age'}) . "\">" .
5368                       (defined $pr->{'age_string'} ? $pr->{'age_string'} : "No commits") . "</td>\n" .
5369                       "<td class=\"link\">" .
5370                       $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary")}, "summary")   . " | " .
5371                       $cgi->a({-href => href(project=>$pr->{'path'}, action=>"shortlog")}, "shortlog") . " | " .
5372                       $cgi->a({-href => href(project=>$pr->{'path'}, action=>"log")}, "log") . " | " .
5373                       $cgi->a({-href => href(project=>$pr->{'path'}, action=>"tree")}, "tree") .
5374                       ($pr->{'forks'} ? " | " . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks")}, "forks") : '') .
5375                       "</td>\n" .
5376                       "</tr>\n";
5377         }
5380 sub git_project_list_body {
5381         # actually uses global variable $project
5382         my ($projlist, $order, $from, $to, $extra, $no_header) = @_;
5383         my @projects = @$projlist;
5385         my $check_forks = gitweb_check_feature('forks');
5386         my $show_ctags  = gitweb_check_feature('ctags');
5387         my $tagfilter = $show_ctags ? $input_params{'ctag'} : undef;
5388         $check_forks = undef
5389                 if ($tagfilter || $searchtext);
5391         # filtering out forks before filling info allows to do less work
5392         @projects = filter_forks_from_projects_list(\@projects)
5393                 if ($check_forks);
5394         # search_projects_list pre-fills required info
5395         @projects = search_projects_list(\@projects,
5396                                          'searchtext' => $searchtext,
5397                                          'tagfilter'  => $tagfilter)
5398                 if ($tagfilter || $searchtext);
5399         # fill the rest
5400         @projects = fill_project_list_info(\@projects);
5402         $order ||= $default_projects_order;
5403         $from = 0 unless defined $from;
5404         $to = $#projects if (!defined $to || $#projects < $to);
5406         # short circuit
5407         if ($from > $to) {
5408                 print "<center>\n".
5409                       "<b>No such projects found</b><br />\n".
5410                       "Click ".$cgi->a({-href=>href(project=>undef)},"here")." to view all projects<br />\n".
5411                       "</center>\n<br />\n";
5412                 return;
5413         }
5415         @projects = sort_projects_list(\@projects, $order);
5417         if ($show_ctags) {
5418                 my $ctags = git_gather_all_ctags(\@projects);
5419                 my $cloud = git_populate_project_tagcloud($ctags);
5420                 print git_show_project_tagcloud($cloud, 64);
5421         }
5423         print "<table class=\"project_list\">\n";
5424         unless ($no_header) {
5425                 print "<tr>\n";
5426                 if ($check_forks) {
5427                         print "<th></th>\n";
5428                 }
5429                 print_sort_th('project', $order, 'Project');
5430                 print_sort_th('descr', $order, 'Description');
5431                 print_sort_th('owner', $order, 'Owner');
5432                 print_sort_th('age', $order, 'Last Change');
5433                 print "<th></th>\n" . # for links
5434                       "</tr>\n";
5435         }
5437         if ($projects_list_group_categories) {
5438                 # only display categories with projects in the $from-$to window
5439                 @projects = sort {$a->{'category'} cmp $b->{'category'}} @projects[$from..$to];
5440                 my %categories = build_projlist_by_category(\@projects, $from, $to);
5441                 foreach my $cat (sort keys %categories) {
5442                         unless ($cat eq "") {
5443                                 print "<tr>\n";
5444                                 if ($check_forks) {
5445                                         print "<td></td>\n";
5446                                 }
5447                                 print "<td class=\"category\" colspan=\"5\">".esc_html($cat)."</td>\n";
5448                                 print "</tr>\n";
5449                         }
5451                         git_project_list_rows($categories{$cat}, undef, undef, $check_forks);
5452                 }
5453         } else {
5454                 git_project_list_rows(\@projects, $from, $to, $check_forks);
5455         }
5457         if (defined $extra) {
5458                 print "<tr>\n";
5459                 if ($check_forks) {
5460                         print "<td></td>\n";
5461                 }
5462                 print "<td colspan=\"5\">$extra</td>\n" .
5463                       "</tr>\n";
5464         }
5465         print "</table>\n";
5468 sub git_log_body {
5469         # uses global variable $project
5470         my ($commitlist, $from, $to, $refs, $extra) = @_;
5472         $from = 0 unless defined $from;
5473         $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5475         for (my $i = 0; $i <= $to; $i++) {
5476                 my %co = %{$commitlist->[$i]};
5477                 next if !%co;
5478                 my $commit = $co{'id'};
5479                 my $ref = format_ref_marker($refs, $commit);
5480                 git_print_header_div('commit',
5481                                "<span class=\"age\">$co{'age_string'}</span>" .
5482                                esc_html($co{'title'}) . $ref,
5483                                $commit);
5484                 print "<div class=\"title_text\">\n" .
5485                       "<div class=\"log_link\">\n" .
5486                       $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") .
5487                       " | " .
5488                       $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") .
5489                       " | " .
5490                       $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree") .
5491                       "<br/>\n" .
5492                       "</div>\n";
5493                       git_print_authorship(\%co, -tag => 'span');
5494                       print "<br/>\n</div>\n";
5496                 print "<div class=\"log_body\">\n";
5497                 git_print_log($co{'comment'}, -final_empty_line=> 1);
5498                 print "</div>\n";
5499         }
5500         if ($extra) {
5501                 print "<div class=\"page_nav\">\n";
5502                 print "$extra\n";
5503                 print "</div>\n";
5504         }
5507 sub git_shortlog_body {
5508         # uses global variable $project
5509         my ($commitlist, $from, $to, $refs, $extra) = @_;
5511         $from = 0 unless defined $from;
5512         $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5514         print "<table class=\"shortlog\">\n";
5515         my $alternate = 1;
5516         for (my $i = $from; $i <= $to; $i++) {
5517                 my %co = %{$commitlist->[$i]};
5518                 my $commit = $co{'id'};
5519                 my $ref = format_ref_marker($refs, $commit);
5520                 if ($alternate) {
5521                         print "<tr class=\"dark\">\n";
5522                 } else {
5523                         print "<tr class=\"light\">\n";
5524                 }
5525                 $alternate ^= 1;
5526                 # git_summary() used print "<td><i>$co{'age_string'}</i></td>\n" .
5527                 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5528                       format_author_html('td', \%co, 10) . "<td>";
5529                 print format_subject_html($co{'title'}, $co{'title_short'},
5530                                           href(action=>"commit", hash=>$commit), $ref);
5531                 print "</td>\n" .
5532                       "<td class=\"link\">" .
5533                       $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") . " | " .
5534                       $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") . " | " .
5535                       $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree");
5536                 my $snapshot_links = format_snapshot_links($commit);
5537                 if (defined $snapshot_links) {
5538                         print " | " . $snapshot_links;
5539                 }
5540                 print "</td>\n" .
5541                       "</tr>\n";
5542         }
5543         if (defined $extra) {
5544                 print "<tr>\n" .
5545                       "<td colspan=\"4\">$extra</td>\n" .
5546                       "</tr>\n";
5547         }
5548         print "</table>\n";
5551 sub git_history_body {
5552         # Warning: assumes constant type (blob or tree) during history
5553         my ($commitlist, $from, $to, $refs, $extra,
5554             $file_name, $file_hash, $ftype) = @_;
5556         $from = 0 unless defined $from;
5557         $to = $#{$commitlist} unless (defined $to && $to <= $#{$commitlist});
5559         print "<table class=\"history\">\n";
5560         my $alternate = 1;
5561         for (my $i = $from; $i <= $to; $i++) {
5562                 my %co = %{$commitlist->[$i]};
5563                 if (!%co) {
5564                         next;
5565                 }
5566                 my $commit = $co{'id'};
5568                 my $ref = format_ref_marker($refs, $commit);
5570                 if ($alternate) {
5571                         print "<tr class=\"dark\">\n";
5572                 } else {
5573                         print "<tr class=\"light\">\n";
5574                 }
5575                 $alternate ^= 1;
5576                 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5577         # shortlog:   format_author_html('td', \%co, 10)
5578                       format_author_html('td', \%co, 15, 3) . "<td>";
5579                 # originally git_history used chop_str($co{'title'}, 50)
5580                 print format_subject_html($co{'title'}, $co{'title_short'},
5581                                           href(action=>"commit", hash=>$commit), $ref);
5582                 print "</td>\n" .
5583                       "<td class=\"link\">" .
5584                       $cgi->a({-href => href(action=>$ftype, hash_base=>$commit, file_name=>$file_name)}, $ftype) . " | " .
5585                       $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff");
5587                 if ($ftype eq 'blob') {
5588                         my $blob_current = $file_hash;
5589                         my $blob_parent  = git_get_hash_by_path($commit, $file_name);
5590                         if (defined $blob_current && defined $blob_parent &&
5591                                         $blob_current ne $blob_parent) {
5592                                 print " | " .
5593                                         $cgi->a({-href => href(action=>"blobdiff",
5594                                                                hash=>$blob_current, hash_parent=>$blob_parent,
5595                                                                hash_base=>$hash_base, hash_parent_base=>$commit,
5596                                                                file_name=>$file_name)},
5597                                                 "diff to current");
5598                         }
5599                 }
5600                 print "</td>\n" .
5601                       "</tr>\n";
5602         }
5603         if (defined $extra) {
5604                 print "<tr>\n" .
5605                       "<td colspan=\"4\">$extra</td>\n" .
5606                       "</tr>\n";
5607         }
5608         print "</table>\n";
5611 sub git_tags_body {
5612         # uses global variable $project
5613         my ($taglist, $from, $to, $extra) = @_;
5614         $from = 0 unless defined $from;
5615         $to = $#{$taglist} if (!defined $to || $#{$taglist} < $to);
5617         print "<table class=\"tags\">\n";
5618         my $alternate = 1;
5619         for (my $i = $from; $i <= $to; $i++) {
5620                 my $entry = $taglist->[$i];
5621                 my %tag = %$entry;
5622                 my $comment = $tag{'subject'};
5623                 my $comment_short;
5624                 if (defined $comment) {
5625                         $comment_short = chop_str($comment, 30, 5);
5626                 }
5627                 if ($alternate) {
5628                         print "<tr class=\"dark\">\n";
5629                 } else {
5630                         print "<tr class=\"light\">\n";
5631                 }
5632                 $alternate ^= 1;
5633                 if (defined $tag{'age'}) {
5634                         print "<td><i>$tag{'age'}</i></td>\n";
5635                 } else {
5636                         print "<td></td>\n";
5637                 }
5638                 print "<td>" .
5639                       $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'}),
5640                                -class => "list name"}, esc_html($tag{'name'})) .
5641                       "</td>\n" .
5642                       "<td>";
5643                 if (defined $comment) {
5644                         print format_subject_html($comment, $comment_short,
5645                                                   href(action=>"tag", hash=>$tag{'id'}));
5646                 }
5647                 print "</td>\n" .
5648                       "<td class=\"selflink\">";
5649                 if ($tag{'type'} eq "tag") {
5650                         print $cgi->a({-href => href(action=>"tag", hash=>$tag{'id'})}, "tag");
5651                 } else {
5652                         print "&nbsp;";
5653                 }
5654                 print "</td>\n" .
5655                       "<td class=\"link\">" . " | " .
5656                       $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'})}, $tag{'reftype'});
5657                 if ($tag{'reftype'} eq "commit") {
5658                         print " | " . $cgi->a({-href => href(action=>"shortlog", hash=>$tag{'fullname'})}, "shortlog") .
5659                               " | " . $cgi->a({-href => href(action=>"log", hash=>$tag{'fullname'})}, "log");
5660                 } elsif ($tag{'reftype'} eq "blob") {
5661                         print " | " . $cgi->a({-href => href(action=>"blob_plain", hash=>$tag{'refid'})}, "raw");
5662                 }
5663                 print "</td>\n" .
5664                       "</tr>";
5665         }
5666         if (defined $extra) {
5667                 print "<tr>\n" .
5668                       "<td colspan=\"5\">$extra</td>\n" .
5669                       "</tr>\n";
5670         }
5671         print "</table>\n";
5674 sub git_heads_body {
5675         # uses global variable $project
5676         my ($headlist, $head, $from, $to, $extra) = @_;
5677         $from = 0 unless defined $from;
5678         $to = $#{$headlist} if (!defined $to || $#{$headlist} < $to);
5680         print "<table class=\"heads\">\n";
5681         my $alternate = 1;
5682         for (my $i = $from; $i <= $to; $i++) {
5683                 my $entry = $headlist->[$i];
5684                 my %ref = %$entry;
5685                 my $curr = $ref{'id'} eq $head;
5686                 if ($alternate) {
5687                         print "<tr class=\"dark\">\n";
5688                 } else {
5689                         print "<tr class=\"light\">\n";
5690                 }
5691                 $alternate ^= 1;
5692                 print "<td><i>$ref{'age'}</i></td>\n" .
5693                       ($curr ? "<td class=\"current_head\">" : "<td>") .
5694                       $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'}),
5695                                -class => "list name"},esc_html($ref{'name'})) .
5696                       "</td>\n" .
5697                       "<td class=\"link\">" .
5698                       $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'})}, "shortlog") . " | " .
5699                       $cgi->a({-href => href(action=>"log", hash=>$ref{'fullname'})}, "log") . " | " .
5700                       $cgi->a({-href => href(action=>"tree", hash=>$ref{'fullname'}, hash_base=>$ref{'fullname'})}, "tree") .
5701                       "</td>\n" .
5702                       "</tr>";
5703         }
5704         if (defined $extra) {
5705                 print "<tr>\n" .
5706                       "<td colspan=\"3\">$extra</td>\n" .
5707                       "</tr>\n";
5708         }
5709         print "</table>\n";
5712 # Display a single remote block
5713 sub git_remote_block {
5714         my ($remote, $rdata, $limit, $head) = @_;
5716         my $heads = $rdata->{'heads'};
5717         my $fetch = $rdata->{'fetch'};
5718         my $push = $rdata->{'push'};
5720         my $urls_table = "<table class=\"projects_list\">\n" ;
5722         if (defined $fetch) {
5723                 if ($fetch eq $push) {
5724                         $urls_table .= format_repo_url("URL", $fetch);
5725                 } else {
5726                         $urls_table .= format_repo_url("Fetch URL", $fetch);
5727                         $urls_table .= format_repo_url("Push URL", $push) if defined $push;
5728                 }
5729         } elsif (defined $push) {
5730                 $urls_table .= format_repo_url("Push URL", $push);
5731         } else {
5732                 $urls_table .= format_repo_url("", "No remote URL");
5733         }
5735         $urls_table .= "</table>\n";
5737         my $dots;
5738         if (defined $limit && $limit < @$heads) {
5739                 $dots = $cgi->a({-href => href(action=>"remotes", hash=>$remote)}, "...");
5740         }
5742         print $urls_table;
5743         git_heads_body($heads, $head, 0, $limit, $dots);
5746 # Display a list of remote names with the respective fetch and push URLs
5747 sub git_remotes_list {
5748         my ($remotedata, $limit) = @_;
5749         print "<table class=\"heads\">\n";
5750         my $alternate = 1;
5751         my @remotes = sort keys %$remotedata;
5753         my $limited = $limit && $limit < @remotes;
5755         $#remotes = $limit - 1 if $limited;
5757         while (my $remote = shift @remotes) {
5758                 my $rdata = $remotedata->{$remote};
5759                 my $fetch = $rdata->{'fetch'};
5760                 my $push = $rdata->{'push'};
5761                 if ($alternate) {
5762                         print "<tr class=\"dark\">\n";
5763                 } else {
5764                         print "<tr class=\"light\">\n";
5765                 }
5766                 $alternate ^= 1;
5767                 print "<td>" .
5768                       $cgi->a({-href=> href(action=>'remotes', hash=>$remote),
5769                                -class=> "list name"},esc_html($remote)) .
5770                       "</td>";
5771                 print "<td class=\"link\">" .
5772                       (defined $fetch ? $cgi->a({-href=> $fetch}, "fetch") : "fetch") .
5773                       " | " .
5774                       (defined $push ? $cgi->a({-href=> $push}, "push") : "push") .
5775                       "</td>";
5777                 print "</tr>\n";
5778         }
5780         if ($limited) {
5781                 print "<tr>\n" .
5782                       "<td colspan=\"3\">" .
5783                       $cgi->a({-href => href(action=>"remotes")}, "...") .
5784                       "</td>\n" . "</tr>\n";
5785         }
5787         print "</table>";
5790 # Display remote heads grouped by remote, unless there are too many
5791 # remotes, in which case we only display the remote names
5792 sub git_remotes_body {
5793         my ($remotedata, $limit, $head) = @_;
5794         if ($limit and $limit < keys %$remotedata) {
5795                 git_remotes_list($remotedata, $limit);
5796         } else {
5797                 fill_remote_heads($remotedata);
5798                 while (my ($remote, $rdata) = each %$remotedata) {
5799                         git_print_section({-class=>"remote", -id=>$remote},
5800                                 ["remotes", $remote, $remote], sub {
5801                                         git_remote_block($remote, $rdata, $limit, $head);
5802                                 });
5803                 }
5804         }
5807 sub git_search_message {
5808         my %co = @_;
5810         my $greptype;
5811         if ($searchtype eq 'commit') {
5812                 $greptype = "--grep=";
5813         } elsif ($searchtype eq 'author') {
5814                 $greptype = "--author=";
5815         } elsif ($searchtype eq 'committer') {
5816                 $greptype = "--committer=";
5817         }
5818         $greptype .= $searchtext;
5819         my @commitlist = parse_commits($hash, 101, (100 * $page), undef,
5820                                        $greptype, '--regexp-ignore-case',
5821                                        $search_use_regexp ? '--extended-regexp' : '--fixed-strings');
5823         my $paging_nav = '';
5824         if ($page > 0) {
5825                 $paging_nav .=
5826                         $cgi->a({-href => href(-replay=>1, page=>undef)},
5827                                 "first") .
5828                         " &sdot; " .
5829                         $cgi->a({-href => href(-replay=>1, page=>$page-1),
5830                                  -accesskey => "p", -title => "Alt-p"}, "prev");
5831         } else {
5832                 $paging_nav .= "first &sdot; prev";
5833         }
5834         my $next_link = '';
5835         if ($#commitlist >= 100) {
5836                 $next_link =
5837                         $cgi->a({-href => href(-replay=>1, page=>$page+1),
5838                                  -accesskey => "n", -title => "Alt-n"}, "next");
5839                 $paging_nav .= " &sdot; $next_link";
5840         } else {
5841                 $paging_nav .= " &sdot; next";
5842         }
5844         git_header_html();
5846         git_print_page_nav('','', $hash,$co{'tree'},$hash, $paging_nav);
5847         git_print_header_div('commit', esc_html($co{'title'}), $hash);
5848         if ($page == 0 && !@commitlist) {
5849                 print "<p>No match.</p>\n";
5850         } else {
5851                 git_search_grep_body(\@commitlist, 0, 99, $next_link);
5852         }
5854         git_footer_html();
5857 sub git_search_changes {
5858         my %co = @_;
5860         local $/ = "\n";
5861         open my $fd, '-|', git_cmd(), '--no-pager', 'log', @diff_opts,
5862                 '--pretty=format:%H', '--no-abbrev', '--raw', "-S$searchtext",
5863                 ($search_use_regexp ? '--pickaxe-regex' : ())
5864                         or die_error(500, "Open git-log failed");
5866         git_header_html();
5868         git_print_page_nav('','', $hash,$co{'tree'},$hash);
5869         git_print_header_div('commit', esc_html($co{'title'}), $hash);
5871         print "<table class=\"pickaxe search\">\n";
5872         my $alternate = 1;
5873         undef %co;
5874         my @files;
5875         while (my $line = <$fd>) {
5876                 chomp $line;
5877                 next unless $line;
5879                 my %set = parse_difftree_raw_line($line);
5880                 if (defined $set{'commit'}) {
5881                         # finish previous commit
5882                         if (%co) {
5883                                 print "</td>\n" .
5884                                       "<td class=\"link\">" .
5885                                       $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
5886                                               "commit") .
5887                                       " | " .
5888                                       $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
5889                                                              hash_base=>$co{'id'})},
5890                                               "tree") .
5891                                       "</td>\n" .
5892                                       "</tr>\n";
5893                         }
5895                         if ($alternate) {
5896                                 print "<tr class=\"dark\">\n";
5897                         } else {
5898                                 print "<tr class=\"light\">\n";
5899                         }
5900                         $alternate ^= 1;
5901                         %co = parse_commit($set{'commit'});
5902                         my $author = chop_and_escape_str($co{'author_name'}, 15, 5);
5903                         print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5904                               "<td><i>$author</i></td>\n" .
5905                               "<td>" .
5906                               $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
5907                                       -class => "list subject"},
5908                                       chop_and_escape_str($co{'title'}, 50) . "<br/>");
5909                 } elsif (defined $set{'to_id'}) {
5910                         next if ($set{'to_id'} =~ m/^0{40}$/);
5912                         print $cgi->a({-href => href(action=>"blob", hash_base=>$co{'id'},
5913                                                      hash=>$set{'to_id'}, file_name=>$set{'to_file'}),
5914                                       -class => "list"},
5915                                       "<span class=\"match\">" . esc_path($set{'file'}) . "</span>") .
5916                               "<br/>\n";
5917                 }
5918         }
5919         close $fd;
5921         # finish last commit (warning: repetition!)
5922         if (%co) {
5923                 print "</td>\n" .
5924                       "<td class=\"link\">" .
5925                       $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
5926                               "commit") .
5927                       " | " .
5928                       $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
5929                                              hash_base=>$co{'id'})},
5930                               "tree") .
5931                       "</td>\n" .
5932                       "</tr>\n";
5933         }
5935         print "</table>\n";
5937         git_footer_html();
5940 sub git_search_files {
5941         my %co = @_;
5943         local $/ = "\n";
5944         open my $fd, "-|", git_cmd(), 'grep', '-n', '-z',
5945                 $search_use_regexp ? ('-E', '-i') : '-F',
5946                 $searchtext, $co{'tree'}
5947                         or die_error(500, "Open git-grep failed");
5949         git_header_html();
5951         git_print_page_nav('','', $hash,$co{'tree'},$hash);
5952         git_print_header_div('commit', esc_html($co{'title'}), $hash);
5954         print "<table class=\"grep_search\">\n";
5955         my $alternate = 1;
5956         my $matches = 0;
5957         my $lastfile = '';
5958         while (my $line = <$fd>) {
5959                 chomp $line;
5960                 my ($file, $file_href, $lno, $ltext, $binary);
5961                 last if ($matches++ > 1000);
5962                 if ($line =~ /^Binary file (.+) matches$/) {
5963                         $file = $1;
5964                         $binary = 1;
5965                 } else {
5966                         ($file, $lno, $ltext) = split(/\0/, $line, 3);
5967                         $file =~ s/^$co{'tree'}://;
5968                 }
5969                 if ($file ne $lastfile) {
5970                         $lastfile and print "</td></tr>\n";
5971                         if ($alternate++) {
5972                                 print "<tr class=\"dark\">\n";
5973                         } else {
5974                                 print "<tr class=\"light\">\n";
5975                         }
5976                         $file_href = href(action=>"blob", hash_base=>$co{'id'},
5977                                           file_name=>$file);
5978                         print "<td class=\"list\">".
5979                                 $cgi->a({-href => $file_href, -class => "list"}, esc_path($file));
5980                         print "</td><td>\n";
5981                         $lastfile = $file;
5982                 }
5983                 if ($binary) {
5984                         print "<div class=\"binary\">Binary file</div>\n";
5985                 } else {
5986                         $ltext = untabify($ltext);
5987                         if ($ltext =~ m/^(.*)($search_regexp)(.*)$/i) {
5988                                 $ltext = esc_html($1, -nbsp=>1);
5989                                 $ltext .= '<span class="match">';
5990                                 $ltext .= esc_html($2, -nbsp=>1);
5991                                 $ltext .= '</span>';
5992                                 $ltext .= esc_html($3, -nbsp=>1);
5993                         } else {
5994                                 $ltext = esc_html($ltext, -nbsp=>1);
5995                         }
5996                         print "<div class=\"pre\">" .
5997                                 $cgi->a({-href => $file_href.'#l'.$lno,
5998                                         -class => "linenr"}, sprintf('%4i', $lno)) .
5999                                 ' ' .  $ltext . "</div>\n";
6000                 }
6001         }
6002         if ($lastfile) {
6003                 print "</td></tr>\n";
6004                 if ($matches > 1000) {
6005                         print "<div class=\"diff nodifferences\">Too many matches, listing trimmed</div>\n";
6006                 }
6007         } else {
6008                 print "<div class=\"diff nodifferences\">No matches found</div>\n";
6009         }
6010         close $fd;
6012         print "</table>\n";
6014         git_footer_html();
6017 sub git_search_grep_body {
6018         my ($commitlist, $from, $to, $extra) = @_;
6019         $from = 0 unless defined $from;
6020         $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
6022         print "<table class=\"commit_search\">\n";
6023         my $alternate = 1;
6024         for (my $i = $from; $i <= $to; $i++) {
6025                 my %co = %{$commitlist->[$i]};
6026                 if (!%co) {
6027                         next;
6028                 }
6029                 my $commit = $co{'id'};
6030                 if ($alternate) {
6031                         print "<tr class=\"dark\">\n";
6032                 } else {
6033                         print "<tr class=\"light\">\n";
6034                 }
6035                 $alternate ^= 1;
6036                 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6037                       format_author_html('td', \%co, 15, 5) .
6038                       "<td>" .
6039                       $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
6040                                -class => "list subject"},
6041                               chop_and_escape_str($co{'title'}, 50) . "<br/>");
6042                 my $comment = $co{'comment'};
6043                 foreach my $line (@$comment) {
6044                         if ($line =~ m/^(.*?)($search_regexp)(.*)$/i) {
6045                                 my ($lead, $match, $trail) = ($1, $2, $3);
6046                                 $match = chop_str($match, 70, 5, 'center');
6047                                 my $contextlen = int((80 - length($match))/2);
6048                                 $contextlen = 30 if ($contextlen > 30);
6049                                 $lead  = chop_str($lead,  $contextlen, 10, 'left');
6050                                 $trail = chop_str($trail, $contextlen, 10, 'right');
6052                                 $lead  = esc_html($lead);
6053                                 $match = esc_html($match);
6054                                 $trail = esc_html($trail);
6056                                 print "$lead<span class=\"match\">$match</span>$trail<br />";
6057                         }
6058                 }
6059                 print "</td>\n" .
6060                       "<td class=\"link\">" .
6061                       $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})}, "commit") .
6062                       " | " .
6063                       $cgi->a({-href => href(action=>"commitdiff", hash=>$co{'id'})}, "commitdiff") .
6064                       " | " .
6065                       $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$co{'id'})}, "tree");
6066                 print "</td>\n" .
6067                       "</tr>\n";
6068         }
6069         if (defined $extra) {
6070                 print "<tr>\n" .
6071                       "<td colspan=\"3\">$extra</td>\n" .
6072                       "</tr>\n";
6073         }
6074         print "</table>\n";
6077 ## ======================================================================
6078 ## ======================================================================
6079 ## actions
6081 sub git_project_list {
6082         my $order = $input_params{'order'};
6083         if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6084                 die_error(400, "Unknown order parameter");
6085         }
6087         my @list = git_get_projects_list($project_filter, $strict_export);
6088         if (!@list) {
6089                 die_error(404, "No projects found");
6090         }
6092         git_header_html();
6093         if (defined $home_text && -f $home_text) {
6094                 print "<div class=\"index_include\">\n";
6095                 insert_file($home_text);
6096                 print "</div>\n";
6097         }
6099         git_project_search_form($searchtext, $search_use_regexp);
6100         git_project_list_body(\@list, $order);
6101         git_footer_html();
6104 sub git_forks {
6105         my $order = $input_params{'order'};
6106         if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6107                 die_error(400, "Unknown order parameter");
6108         }
6110         my $filter = $project;
6111         $filter =~ s/\.git$//;
6112         my @list = git_get_projects_list($filter);
6113         if (!@list) {
6114                 die_error(404, "No forks found");
6115         }
6117         git_header_html();
6118         git_print_page_nav('','');
6119         git_print_header_div('summary', "$project forks");
6120         git_project_list_body(\@list, $order);
6121         git_footer_html();
6124 sub git_project_index {
6125         my @projects = git_get_projects_list($project_filter, $strict_export);
6126         if (!@projects) {
6127                 die_error(404, "No projects found");
6128         }
6130         print $cgi->header(
6131                 -type => 'text/plain',
6132                 -charset => 'utf-8',
6133                 -content_disposition => 'inline; filename="index.aux"');
6135         foreach my $pr (@projects) {
6136                 if (!exists $pr->{'owner'}) {
6137                         $pr->{'owner'} = git_get_project_owner("$pr->{'path'}");
6138                 }
6140                 my ($path, $owner) = ($pr->{'path'}, $pr->{'owner'});
6141                 # quote as in CGI::Util::encode, but keep the slash, and use '+' for ' '
6142                 $path  =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6143                 $owner =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6144                 $path  =~ s/ /\+/g;
6145                 $owner =~ s/ /\+/g;
6147                 print "$path $owner\n";
6148         }
6151 sub git_summary {
6152         my $descr = git_get_project_description($project) || "none";
6153         my %co = parse_commit("HEAD");
6154         my %cd = %co ? parse_date($co{'committer_epoch'}, $co{'committer_tz'}) : ();
6155         my $head = $co{'id'};
6156         my $remote_heads = gitweb_check_feature('remote_heads');
6158         my $owner = git_get_project_owner($project);
6160         my $refs = git_get_references();
6161         # These get_*_list functions return one more to allow us to see if
6162         # there are more ...
6163         my @taglist  = git_get_tags_list(16);
6164         my @headlist = git_get_heads_list(16);
6165         my %remotedata = $remote_heads ? git_get_remotes_list() : ();
6166         my @forklist;
6167         my $check_forks = gitweb_check_feature('forks');
6169         if ($check_forks) {
6170                 # find forks of a project
6171                 my $filter = $project;
6172                 $filter =~ s/\.git$//;
6173                 @forklist = git_get_projects_list($filter);
6174                 # filter out forks of forks
6175                 @forklist = filter_forks_from_projects_list(\@forklist)
6176                         if (@forklist);
6177         }
6179         git_header_html();
6180         git_print_page_nav('summary','', $head);
6182         print "<div class=\"title\">&nbsp;</div>\n";
6183         print "<table class=\"projects_list\">\n" .
6184               "<tr id=\"metadata_desc\"><td>description</td><td>" . esc_html($descr) . "</td></tr>\n" .
6185               "<tr id=\"metadata_owner\"><td>owner</td><td>" . esc_html($owner) . "</td></tr>\n";
6186         if (defined $cd{'rfc2822'}) {
6187                 print "<tr id=\"metadata_lchange\"><td>last change</td>" .
6188                       "<td>".format_timestamp_html(\%cd)."</td></tr>\n";
6189         }
6191         # use per project git URL list in $projectroot/$project/cloneurl
6192         # or make project git URL from git base URL and project name
6193         my $url_tag = "URL";
6194         my @url_list = git_get_project_url_list($project);
6195         @url_list = map { "$_/$project" } @git_base_url_list unless @url_list;
6196         foreach my $git_url (@url_list) {
6197                 next unless $git_url;
6198                 print format_repo_url($url_tag, $git_url);
6199                 $url_tag = "";
6200         }
6202         # Tag cloud
6203         my $show_ctags = gitweb_check_feature('ctags');
6204         if ($show_ctags) {
6205                 my $ctags = git_get_project_ctags($project);
6206                 if (%$ctags) {
6207                         # without ability to add tags, don't show if there are none
6208                         my $cloud = git_populate_project_tagcloud($ctags);
6209                         print "<tr id=\"metadata_ctags\">" .
6210                               "<td>content tags</td>" .
6211                               "<td>".git_show_project_tagcloud($cloud, 48)."</td>" .
6212                               "</tr>\n";
6213                 }
6214         }
6216         print "</table>\n";
6218         # If XSS prevention is on, we don't include README.html.
6219         # TODO: Allow a readme in some safe format.
6220         if (!$prevent_xss && -s "$projectroot/$project/README.html") {
6221                 print "<div class=\"title\">readme</div>\n" .
6222                       "<div class=\"readme\">\n";
6223                 insert_file("$projectroot/$project/README.html");
6224                 print "\n</div>\n"; # class="readme"
6225         }
6227         # we need to request one more than 16 (0..15) to check if
6228         # those 16 are all
6229         my @commitlist = $head ? parse_commits($head, 17) : ();
6230         if (@commitlist) {
6231                 git_print_header_div('shortlog');
6232                 git_shortlog_body(\@commitlist, 0, 15, $refs,
6233                                   $#commitlist <=  15 ? undef :
6234                                   $cgi->a({-href => href(action=>"shortlog")}, "..."));
6235         }
6237         if (@taglist) {
6238                 git_print_header_div('tags');
6239                 git_tags_body(\@taglist, 0, 15,
6240                               $#taglist <=  15 ? undef :
6241                               $cgi->a({-href => href(action=>"tags")}, "..."));
6242         }
6244         if (@headlist) {
6245                 git_print_header_div('heads');
6246                 git_heads_body(\@headlist, $head, 0, 15,
6247                                $#headlist <= 15 ? undef :
6248                                $cgi->a({-href => href(action=>"heads")}, "..."));
6249         }
6251         if (%remotedata) {
6252                 git_print_header_div('remotes');
6253                 git_remotes_body(\%remotedata, 15, $head);
6254         }
6256         if (@forklist) {
6257                 git_print_header_div('forks');
6258                 git_project_list_body(\@forklist, 'age', 0, 15,
6259                                       $#forklist <= 15 ? undef :
6260                                       $cgi->a({-href => href(action=>"forks")}, "..."),
6261                                       'no_header');
6262         }
6264         git_footer_html();
6267 sub git_tag {
6268         my %tag = parse_tag($hash);
6270         if (! %tag) {
6271                 die_error(404, "Unknown tag object");
6272         }
6274         my $head = git_get_head_hash($project);
6275         git_header_html();
6276         git_print_page_nav('','', $head,undef,$head);
6277         git_print_header_div('commit', esc_html($tag{'name'}), $hash);
6278         print "<div class=\"title_text\">\n" .
6279               "<table class=\"object_header\">\n" .
6280               "<tr>\n" .
6281               "<td>object</td>\n" .
6282               "<td>" . $cgi->a({-class => "list", -href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6283                                $tag{'object'}) . "</td>\n" .
6284               "<td class=\"link\">" . $cgi->a({-href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6285                                               $tag{'type'}) . "</td>\n" .
6286               "</tr>\n";
6287         if (defined($tag{'author'})) {
6288                 git_print_authorship_rows(\%tag, 'author');
6289         }
6290         print "</table>\n\n" .
6291               "</div>\n";
6292         print "<div class=\"page_body\">";
6293         my $comment = $tag{'comment'};
6294         foreach my $line (@$comment) {
6295                 chomp $line;
6296                 print esc_html($line, -nbsp=>1) . "<br/>\n";
6297         }
6298         print "</div>\n";
6299         git_footer_html();
6302 sub git_blame_common {
6303         my $format = shift || 'porcelain';
6304         if ($format eq 'porcelain' && $input_params{'javascript'}) {
6305                 $format = 'incremental';
6306                 $action = 'blame_incremental'; # for page title etc
6307         }
6309         # permissions
6310         gitweb_check_feature('blame')
6311                 or die_error(403, "Blame view not allowed");
6313         # error checking
6314         die_error(400, "No file name given") unless $file_name;
6315         $hash_base ||= git_get_head_hash($project);
6316         die_error(404, "Couldn't find base commit") unless $hash_base;
6317         my %co = parse_commit($hash_base)
6318                 or die_error(404, "Commit not found");
6319         my $ftype = "blob";
6320         if (!defined $hash) {
6321                 $hash = git_get_hash_by_path($hash_base, $file_name, "blob")
6322                         or die_error(404, "Error looking up file");
6323         } else {
6324                 $ftype = git_get_type($hash);
6325                 if ($ftype !~ "blob") {
6326                         die_error(400, "Object is not a blob");
6327                 }
6328         }
6330         my $fd;
6331         if ($format eq 'incremental') {
6332                 # get file contents (as base)
6333                 open $fd, "-|", git_cmd(), 'cat-file', 'blob', $hash
6334                         or die_error(500, "Open git-cat-file failed");
6335         } elsif ($format eq 'data') {
6336                 # run git-blame --incremental
6337                 open $fd, "-|", git_cmd(), "blame", "--incremental",
6338                         $hash_base, "--", $file_name
6339                         or die_error(500, "Open git-blame --incremental failed");
6340         } else {
6341                 # run git-blame --porcelain
6342                 open $fd, "-|", git_cmd(), "blame", '-p',
6343                         $hash_base, '--', $file_name
6344                         or die_error(500, "Open git-blame --porcelain failed");
6345         }
6347         # incremental blame data returns early
6348         if ($format eq 'data') {
6349                 print $cgi->header(
6350                         -type=>"text/plain", -charset => "utf-8",
6351                         -status=> "200 OK");
6352                 local $| = 1; # output autoflush
6353                 while (my $line = <$fd>) {
6354                         print to_utf8($line);
6355                 }
6356                 close $fd
6357                         or print "ERROR $!\n";
6359                 print 'END';
6360                 if (defined $t0 && gitweb_check_feature('timed')) {
6361                         print ' '.
6362                               tv_interval($t0, [ gettimeofday() ]).
6363                               ' '.$number_of_git_cmds;
6364                 }
6365                 print "\n";
6367                 return;
6368         }
6370         # page header
6371         git_header_html();
6372         my $formats_nav =
6373                 $cgi->a({-href => href(action=>"blob", -replay=>1)},
6374                         "blob") .
6375                 " | ";
6376         if ($format eq 'incremental') {
6377                 $formats_nav .=
6378                         $cgi->a({-href => href(action=>"blame", javascript=>0, -replay=>1)},
6379                                 "blame") . " (non-incremental)";
6380         } else {
6381                 $formats_nav .=
6382                         $cgi->a({-href => href(action=>"blame_incremental", -replay=>1)},
6383                                 "blame") . " (incremental)";
6384         }
6385         $formats_nav .=
6386                 " | " .
6387                 $cgi->a({-href => href(action=>"history", -replay=>1)},
6388                         "history") .
6389                 " | " .
6390                 $cgi->a({-href => href(action=>$action, file_name=>$file_name)},
6391                         "HEAD");
6392         git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
6393         git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
6394         git_print_page_path($file_name, $ftype, $hash_base);
6396         # page body
6397         if ($format eq 'incremental') {
6398                 print "<noscript>\n<div class=\"error\"><center><b>\n".
6399                       "This page requires JavaScript to run.\n Use ".
6400                       $cgi->a({-href => href(action=>'blame',javascript=>0,-replay=>1)},
6401                               'this page').
6402                       " instead.\n".
6403                       "</b></center></div>\n</noscript>\n";
6405                 print qq!<div id="progress_bar" style="width: 100%; background-color: yellow"></div>\n!;
6406         }
6408         print qq!<div class="page_body">\n!;
6409         print qq!<div id="progress_info">... / ...</div>\n!
6410                 if ($format eq 'incremental');
6411         print qq!<table id="blame_table" class="blame" width="100%">\n!.
6412               #qq!<col width="5.5em" /><col width="2.5em" /><col width="*" />\n!.
6413               qq!<thead>\n!.
6414               qq!<tr><th>Commit</th><th>Line</th><th>Data</th></tr>\n!.
6415               qq!</thead>\n!.
6416               qq!<tbody>\n!;
6418         my @rev_color = qw(light dark);
6419         my $num_colors = scalar(@rev_color);
6420         my $current_color = 0;
6422         if ($format eq 'incremental') {
6423                 my $color_class = $rev_color[$current_color];
6425                 #contents of a file
6426                 my $linenr = 0;
6427         LINE:
6428                 while (my $line = <$fd>) {
6429                         chomp $line;
6430                         $linenr++;
6432                         print qq!<tr id="l$linenr" class="$color_class">!.
6433                               qq!<td class="sha1"><a href=""> </a></td>!.
6434                               qq!<td class="linenr">!.
6435                               qq!<a class="linenr" href="">$linenr</a></td>!;
6436                         print qq!<td class="pre">! . esc_html($line) . "</td>\n";
6437                         print qq!</tr>\n!;
6438                 }
6440         } else { # porcelain, i.e. ordinary blame
6441                 my %metainfo = (); # saves information about commits
6443                 # blame data
6444         LINE:
6445                 while (my $line = <$fd>) {
6446                         chomp $line;
6447                         # the header: <SHA-1> <src lineno> <dst lineno> [<lines in group>]
6448                         # no <lines in group> for subsequent lines in group of lines
6449                         my ($full_rev, $orig_lineno, $lineno, $group_size) =
6450                            ($line =~ /^([0-9a-f]{40}) (\d+) (\d+)(?: (\d+))?$/);
6451                         if (!exists $metainfo{$full_rev}) {
6452                                 $metainfo{$full_rev} = { 'nprevious' => 0 };
6453                         }
6454                         my $meta = $metainfo{$full_rev};
6455                         my $data;
6456                         while ($data = <$fd>) {
6457                                 chomp $data;
6458                                 last if ($data =~ s/^\t//); # contents of line
6459                                 if ($data =~ /^(\S+)(?: (.*))?$/) {
6460                                         $meta->{$1} = $2 unless exists $meta->{$1};
6461                                 }
6462                                 if ($data =~ /^previous /) {
6463                                         $meta->{'nprevious'}++;
6464                                 }
6465                         }
6466                         my $short_rev = substr($full_rev, 0, 8);
6467                         my $author = $meta->{'author'};
6468                         my %date =
6469                                 parse_date($meta->{'author-time'}, $meta->{'author-tz'});
6470                         my $date = $date{'iso-tz'};
6471                         if ($group_size) {
6472                                 $current_color = ($current_color + 1) % $num_colors;
6473                         }
6474                         my $tr_class = $rev_color[$current_color];
6475                         $tr_class .= ' boundary' if (exists $meta->{'boundary'});
6476                         $tr_class .= ' no-previous' if ($meta->{'nprevious'} == 0);
6477                         $tr_class .= ' multiple-previous' if ($meta->{'nprevious'} > 1);
6478                         print "<tr id=\"l$lineno\" class=\"$tr_class\">\n";
6479                         if ($group_size) {
6480                                 print "<td class=\"sha1\"";
6481                                 print " title=\"". esc_html($author) . ", $date\"";
6482                                 print " rowspan=\"$group_size\"" if ($group_size > 1);
6483                                 print ">";
6484                                 print $cgi->a({-href => href(action=>"commit",
6485                                                              hash=>$full_rev,
6486                                                              file_name=>$file_name)},
6487                                               esc_html($short_rev));
6488                                 if ($group_size >= 2) {
6489                                         my @author_initials = ($author =~ /\b([[:upper:]])\B/g);
6490                                         if (@author_initials) {
6491                                                 print "<br />" .
6492                                                       esc_html(join('', @author_initials));
6493                                                 #           or join('.', ...)
6494                                         }
6495                                 }
6496                                 print "</td>\n";
6497                         }
6498                         # 'previous' <sha1 of parent commit> <filename at commit>
6499                         if (exists $meta->{'previous'} &&
6500                             $meta->{'previous'} =~ /^([a-fA-F0-9]{40}) (.*)$/) {
6501                                 $meta->{'parent'} = $1;
6502                                 $meta->{'file_parent'} = unquote($2);
6503                         }
6504                         my $linenr_commit =
6505                                 exists($meta->{'parent'}) ?
6506                                 $meta->{'parent'} : $full_rev;
6507                         my $linenr_filename =
6508                                 exists($meta->{'file_parent'}) ?
6509                                 $meta->{'file_parent'} : unquote($meta->{'filename'});
6510                         my $blamed = href(action => 'blame',
6511                                           file_name => $linenr_filename,
6512                                           hash_base => $linenr_commit);
6513                         print "<td class=\"linenr\">";
6514                         print $cgi->a({ -href => "$blamed#l$orig_lineno",
6515                                         -class => "linenr" },
6516                                       esc_html($lineno));
6517                         print "</td>";
6518                         print "<td class=\"pre\">" . esc_html($data) . "</td>\n";
6519                         print "</tr>\n";
6520                 } # end while
6522         }
6524         # footer
6525         print "</tbody>\n".
6526               "</table>\n"; # class="blame"
6527         print "</div>\n";   # class="blame_body"
6528         close $fd
6529                 or print "Reading blob failed\n";
6531         git_footer_html();
6534 sub git_blame {
6535         git_blame_common();
6538 sub git_blame_incremental {
6539         git_blame_common('incremental');
6542 sub git_blame_data {
6543         git_blame_common('data');
6546 sub git_tags {
6547         my $head = git_get_head_hash($project);
6548         git_header_html();
6549         git_print_page_nav('','', $head,undef,$head,format_ref_views('tags'));
6550         git_print_header_div('summary', $project);
6552         my @tagslist = git_get_tags_list();
6553         if (@tagslist) {
6554                 git_tags_body(\@tagslist);
6555         }
6556         git_footer_html();
6559 sub git_heads {
6560         my $head = git_get_head_hash($project);
6561         git_header_html();
6562         git_print_page_nav('','', $head,undef,$head,format_ref_views('heads'));
6563         git_print_header_div('summary', $project);
6565         my @headslist = git_get_heads_list();
6566         if (@headslist) {
6567                 git_heads_body(\@headslist, $head);
6568         }
6569         git_footer_html();
6572 # used both for single remote view and for list of all the remotes
6573 sub git_remotes {
6574         gitweb_check_feature('remote_heads')
6575                 or die_error(403, "Remote heads view is disabled");
6577         my $head = git_get_head_hash($project);
6578         my $remote = $input_params{'hash'};
6580         my $remotedata = git_get_remotes_list($remote);
6581         die_error(500, "Unable to get remote information") unless defined $remotedata;
6583         unless (%$remotedata) {
6584                 die_error(404, defined $remote ?
6585                         "Remote $remote not found" :
6586                         "No remotes found");
6587         }
6589         git_header_html(undef, undef, -action_extra => $remote);
6590         git_print_page_nav('', '',  $head, undef, $head,
6591                 format_ref_views($remote ? '' : 'remotes'));
6593         fill_remote_heads($remotedata);
6594         if (defined $remote) {
6595                 git_print_header_div('remotes', "$remote remote for $project");
6596                 git_remote_block($remote, $remotedata->{$remote}, undef, $head);
6597         } else {
6598                 git_print_header_div('summary', "$project remotes");
6599                 git_remotes_body($remotedata, undef, $head);
6600         }
6602         git_footer_html();
6605 sub git_blob_plain {
6606         my $type = shift;
6607         my $expires;
6609         if (!defined $hash) {
6610                 if (defined $file_name) {
6611                         my $base = $hash_base || git_get_head_hash($project);
6612                         $hash = git_get_hash_by_path($base, $file_name, "blob")
6613                                 or die_error(404, "Cannot find file");
6614                 } else {
6615                         die_error(400, "No file name defined");
6616                 }
6617         } elsif ($hash =~ m/^[0-9a-fA-F]{40}$/) {
6618                 # blobs defined by non-textual hash id's can be cached
6619                 $expires = "+1d";
6620         }
6622         open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
6623                 or die_error(500, "Open git-cat-file blob '$hash' failed");
6625         # content-type (can include charset)
6626         $type = blob_contenttype($fd, $file_name, $type);
6628         # "save as" filename, even when no $file_name is given
6629         my $save_as = "$hash";
6630         if (defined $file_name) {
6631                 $save_as = $file_name;
6632         } elsif ($type =~ m/^text\//) {
6633                 $save_as .= '.txt';
6634         }
6636         # With XSS prevention on, blobs of all types except a few known safe
6637         # ones are served with "Content-Disposition: attachment" to make sure
6638         # they don't run in our security domain.  For certain image types,
6639         # blob view writes an <img> tag referring to blob_plain view, and we
6640         # want to be sure not to break that by serving the image as an
6641         # attachment (though Firefox 3 doesn't seem to care).
6642         my $sandbox = $prevent_xss &&
6643                 $type !~ m!^(?:text/[a-z]+|image/(?:gif|png|jpeg))(?:[ ;]|$)!;
6645         # serve text/* as text/plain
6646         if ($prevent_xss &&
6647             ($type =~ m!^text/[a-z]+\b(.*)$! ||
6648              ($type =~ m!^[a-z]+/[a-z]\+xml\b(.*)$! && -T $fd))) {
6649                 my $rest = $1;
6650                 $rest = defined $rest ? $rest : '';
6651                 $type = "text/plain$rest";
6652         }
6654         print $cgi->header(
6655                 -type => $type,
6656                 -expires => $expires,
6657                 -content_disposition =>
6658                         ($sandbox ? 'attachment' : 'inline')
6659                         . '; filename="' . $save_as . '"');
6660         local $/ = undef;
6661         binmode STDOUT, ':raw';
6662         print <$fd>;
6663         binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
6664         close $fd;
6667 sub git_blob {
6668         my $expires;
6670         if (!defined $hash) {
6671                 if (defined $file_name) {
6672                         my $base = $hash_base || git_get_head_hash($project);
6673                         $hash = git_get_hash_by_path($base, $file_name, "blob")
6674                                 or die_error(404, "Cannot find file");
6675                 } else {
6676                         die_error(400, "No file name defined");
6677                 }
6678         } elsif ($hash =~ m/^[0-9a-fA-F]{40}$/) {
6679                 # blobs defined by non-textual hash id's can be cached
6680                 $expires = "+1d";
6681         }
6683         my $have_blame = gitweb_check_feature('blame');
6684         open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
6685                 or die_error(500, "Couldn't cat $file_name, $hash");
6686         my $mimetype = blob_mimetype($fd, $file_name);
6687         # use 'blob_plain' (aka 'raw') view for files that cannot be displayed
6688         if ($mimetype !~ m!^(?:text/|image/(?:gif|png|jpeg)$)! && -B $fd) {
6689                 close $fd;
6690                 return git_blob_plain($mimetype);
6691         }
6692         # we can have blame only for text/* mimetype
6693         $have_blame &&= ($mimetype =~ m!^text/!);
6695         my $highlight = gitweb_check_feature('highlight');
6696         my $syntax = guess_file_syntax($highlight, $mimetype, $file_name);
6697         $fd = run_highlighter($fd, $highlight, $syntax)
6698                 if $syntax;
6700         git_header_html(undef, $expires);
6701         my $formats_nav = '';
6702         if (defined $hash_base && (my %co = parse_commit($hash_base))) {
6703                 if (defined $file_name) {
6704                         if ($have_blame) {
6705                                 $formats_nav .=
6706                                         $cgi->a({-href => href(action=>"blame", -replay=>1)},
6707                                                 "blame") .
6708                                         " | ";
6709                         }
6710                         $formats_nav .=
6711                                 $cgi->a({-href => href(action=>"history", -replay=>1)},
6712                                         "history") .
6713                                 " | " .
6714                                 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
6715                                         "raw") .
6716                                 " | " .
6717                                 $cgi->a({-href => href(action=>"blob",
6718                                                        hash_base=>"HEAD", file_name=>$file_name)},
6719                                         "HEAD");
6720                 } else {
6721                         $formats_nav .=
6722                                 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
6723                                         "raw");
6724                 }
6725                 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
6726                 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
6727         } else {
6728                 print "<div class=\"page_nav\">\n" .
6729                       "<br/><br/></div>\n" .
6730                       "<div class=\"title\">".esc_html($hash)."</div>\n";
6731         }
6732         git_print_page_path($file_name, "blob", $hash_base);
6733         print "<div class=\"page_body\">\n";
6734         if ($mimetype =~ m!^image/!) {
6735                 print qq!<img type="!.esc_attr($mimetype).qq!"!;
6736                 if ($file_name) {
6737                         print qq! alt="!.esc_attr($file_name).qq!" title="!.esc_attr($file_name).qq!"!;
6738                 }
6739                 print qq! src="! .
6740                       href(action=>"blob_plain", hash=>$hash,
6741                            hash_base=>$hash_base, file_name=>$file_name) .
6742                       qq!" />\n!;
6743         } else {
6744                 my $nr;
6745                 while (my $line = <$fd>) {
6746                         chomp $line;
6747                         $nr++;
6748                         $line = untabify($line);
6749                         printf qq!<div class="pre"><a id="l%i" href="%s#l%i" class="linenr">%4i</a> %s</div>\n!,
6750                                $nr, esc_attr(href(-replay => 1)), $nr, $nr,
6751                                $syntax ? sanitize($line) : esc_html($line, -nbsp=>1);
6752                 }
6753         }
6754         close $fd
6755                 or print "Reading blob failed.\n";
6756         print "</div>";
6757         git_footer_html();
6760 sub git_tree {
6761         if (!defined $hash_base) {
6762                 $hash_base = "HEAD";
6763         }
6764         if (!defined $hash) {
6765                 if (defined $file_name) {
6766                         $hash = git_get_hash_by_path($hash_base, $file_name, "tree");
6767                 } else {
6768                         $hash = $hash_base;
6769                 }
6770         }
6771         die_error(404, "No such tree") unless defined($hash);
6773         my $show_sizes = gitweb_check_feature('show-sizes');
6774         my $have_blame = gitweb_check_feature('blame');
6776         my @entries = ();
6777         {
6778                 local $/ = "\0";
6779                 open my $fd, "-|", git_cmd(), "ls-tree", '-z',
6780                         ($show_sizes ? '-l' : ()), @extra_options, $hash
6781                         or die_error(500, "Open git-ls-tree failed");
6782                 @entries = map { chomp; $_ } <$fd>;
6783                 close $fd
6784                         or die_error(404, "Reading tree failed");
6785         }
6787         my $refs = git_get_references();
6788         my $ref = format_ref_marker($refs, $hash_base);
6789         git_header_html();
6790         my $basedir = '';
6791         if (defined $hash_base && (my %co = parse_commit($hash_base))) {
6792                 my @views_nav = ();
6793                 if (defined $file_name) {
6794                         push @views_nav,
6795                                 $cgi->a({-href => href(action=>"history", -replay=>1)},
6796                                         "history"),
6797                                 $cgi->a({-href => href(action=>"tree",
6798                                                        hash_base=>"HEAD", file_name=>$file_name)},
6799                                         "HEAD"),
6800                 }
6801                 my $snapshot_links = format_snapshot_links($hash);
6802                 if (defined $snapshot_links) {
6803                         # FIXME: Should be available when we have no hash base as well.
6804                         push @views_nav, $snapshot_links;
6805                 }
6806                 git_print_page_nav('tree','', $hash_base, undef, undef,
6807                                    join(' | ', @views_nav));
6808                 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash_base);
6809         } else {
6810                 undef $hash_base;
6811                 print "<div class=\"page_nav\">\n";
6812                 print "<br/><br/></div>\n";
6813                 print "<div class=\"title\">".esc_html($hash)."</div>\n";
6814         }
6815         if (defined $file_name) {
6816                 $basedir = $file_name;
6817                 if ($basedir ne '' && substr($basedir, -1) ne '/') {
6818                         $basedir .= '/';
6819                 }
6820                 git_print_page_path($file_name, 'tree', $hash_base);
6821         }
6822         print "<div class=\"page_body\">\n";
6823         print "<table class=\"tree\">\n";
6824         my $alternate = 1;
6825         # '..' (top directory) link if possible
6826         if (defined $hash_base &&
6827             defined $file_name && $file_name =~ m![^/]+$!) {
6828                 if ($alternate) {
6829                         print "<tr class=\"dark\">\n";
6830                 } else {
6831                         print "<tr class=\"light\">\n";
6832                 }
6833                 $alternate ^= 1;
6835                 my $up = $file_name;
6836                 $up =~ s!/?[^/]+$!!;
6837                 undef $up unless $up;
6838                 # based on git_print_tree_entry
6839                 print '<td class="mode">' . mode_str('040000') . "</td>\n";
6840                 print '<td class="size">&nbsp;</td>'."\n" if $show_sizes;
6841                 print '<td class="list">';
6842                 print $cgi->a({-href => href(action=>"tree",
6843                                              hash_base=>$hash_base,
6844                                              file_name=>$up)},
6845                               "..");
6846                 print "</td>\n";
6847                 print "<td class=\"link\"></td>\n";
6849                 print "</tr>\n";
6850         }
6851         foreach my $line (@entries) {
6852                 my %t = parse_ls_tree_line($line, -z => 1, -l => $show_sizes);
6854                 if ($alternate) {
6855                         print "<tr class=\"dark\">\n";
6856                 } else {
6857                         print "<tr class=\"light\">\n";
6858                 }
6859                 $alternate ^= 1;
6861                 git_print_tree_entry(\%t, $basedir, $hash_base, $have_blame);
6863                 print "</tr>\n";
6864         }
6865         print "</table>\n" .
6866               "</div>";
6867         git_footer_html();
6870 sub snapshot_name {
6871         my ($project, $hash) = @_;
6873         # path/to/project.git  -> project
6874         # path/to/project/.git -> project
6875         my $name = to_utf8($project);
6876         $name =~ s,([^/])/*\.git$,$1,;
6877         $name = basename($name);
6878         # sanitize name
6879         $name =~ s/[[:cntrl:]]/?/g;
6881         my $ver = $hash;
6882         if ($hash =~ /^[0-9a-fA-F]+$/) {
6883                 # shorten SHA-1 hash
6884                 my $full_hash = git_get_full_hash($project, $hash);
6885                 if ($full_hash =~ /^$hash/ && length($hash) > 7) {
6886                         $ver = git_get_short_hash($project, $hash);
6887                 }
6888         } elsif ($hash =~ m!^refs/tags/(.*)$!) {
6889                 # tags don't need shortened SHA-1 hash
6890                 $ver = $1;
6891         } else {
6892                 # branches and other need shortened SHA-1 hash
6893                 if ($hash =~ m!^refs/(?:heads|remotes)/(.*)$!) {
6894                         $ver = $1;
6895                 }
6896                 $ver .= '-' . git_get_short_hash($project, $hash);
6897         }
6898         # in case of hierarchical branch names
6899         $ver =~ s!/!.!g;
6901         # name = project-version_string
6902         $name = "$name-$ver";
6904         return wantarray ? ($name, $name) : $name;
6907 sub git_snapshot {
6908         my $format = $input_params{'snapshot_format'};
6909         if (!@snapshot_fmts) {
6910                 die_error(403, "Snapshots not allowed");
6911         }
6912         # default to first supported snapshot format
6913         $format ||= $snapshot_fmts[0];
6914         if ($format !~ m/^[a-z0-9]+$/) {
6915                 die_error(400, "Invalid snapshot format parameter");
6916         } elsif (!exists($known_snapshot_formats{$format})) {
6917                 die_error(400, "Unknown snapshot format");
6918         } elsif ($known_snapshot_formats{$format}{'disabled'}) {
6919                 die_error(403, "Snapshot format not allowed");
6920         } elsif (!grep($_ eq $format, @snapshot_fmts)) {
6921                 die_error(403, "Unsupported snapshot format");
6922         }
6924         my $type = git_get_type("$hash^{}");
6925         if (!$type) {
6926                 die_error(404, 'Object does not exist');
6927         }  elsif ($type eq 'blob') {
6928                 die_error(400, 'Object is not a tree-ish');
6929         }
6931         my ($name, $prefix) = snapshot_name($project, $hash);
6932         my $filename = "$name$known_snapshot_formats{$format}{'suffix'}";
6933         my $cmd = quote_command(
6934                 git_cmd(), 'archive',
6935                 "--format=$known_snapshot_formats{$format}{'format'}",
6936                 "--prefix=$prefix/", $hash);
6937         if (exists $known_snapshot_formats{$format}{'compressor'}) {
6938                 $cmd .= ' | ' . quote_command(@{$known_snapshot_formats{$format}{'compressor'}});
6939         }
6941         $filename =~ s/(["\\])/\\$1/g;
6942         print $cgi->header(
6943                 -type => $known_snapshot_formats{$format}{'type'},
6944                 -content_disposition => 'inline; filename="' . $filename . '"',
6945                 -status => '200 OK');
6947         open my $fd, "-|", $cmd
6948                 or die_error(500, "Execute git-archive failed");
6949         binmode STDOUT, ':raw';
6950         print <$fd>;
6951         binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
6952         close $fd;
6955 sub git_log_generic {
6956         my ($fmt_name, $body_subr, $base, $parent, $file_name, $file_hash) = @_;
6958         my $head = git_get_head_hash($project);
6959         if (!defined $base) {
6960                 $base = $head;
6961         }
6962         if (!defined $page) {
6963                 $page = 0;
6964         }
6965         my $refs = git_get_references();
6967         my $commit_hash = $base;
6968         if (defined $parent) {
6969                 $commit_hash = "$parent..$base";
6970         }
6971         my @commitlist =
6972                 parse_commits($commit_hash, 101, (100 * $page),
6973                               defined $file_name ? ($file_name, "--full-history") : ());
6975         my $ftype;
6976         if (!defined $file_hash && defined $file_name) {
6977                 # some commits could have deleted file in question,
6978                 # and not have it in tree, but one of them has to have it
6979                 for (my $i = 0; $i < @commitlist; $i++) {
6980                         $file_hash = git_get_hash_by_path($commitlist[$i]{'id'}, $file_name);
6981                         last if defined $file_hash;
6982                 }
6983         }
6984         if (defined $file_hash) {
6985                 $ftype = git_get_type($file_hash);
6986         }
6987         if (defined $file_name && !defined $ftype) {
6988                 die_error(500, "Unknown type of object");
6989         }
6990         my %co;
6991         if (defined $file_name) {
6992                 %co = parse_commit($base)
6993                         or die_error(404, "Unknown commit object");
6994         }
6997         my $paging_nav = format_paging_nav($fmt_name, $page, $#commitlist >= 100);
6998         my $next_link = '';
6999         if ($#commitlist >= 100) {
7000                 $next_link =
7001                         $cgi->a({-href => href(-replay=>1, page=>$page+1),
7002                                  -accesskey => "n", -title => "Alt-n"}, "next");
7003         }
7004         my $patch_max = gitweb_get_feature('patches');
7005         if ($patch_max && !defined $file_name) {
7006                 if ($patch_max < 0 || @commitlist <= $patch_max) {
7007                         $paging_nav .= " &sdot; " .
7008                                 $cgi->a({-href => href(action=>"patches", -replay=>1)},
7009                                         "patches");
7010                 }
7011         }
7013         git_header_html();
7014         git_print_page_nav($fmt_name,'', $hash,$hash,$hash, $paging_nav);
7015         if (defined $file_name) {
7016                 git_print_header_div('commit', esc_html($co{'title'}), $base);
7017         } else {
7018                 git_print_header_div('summary', $project)
7019         }
7020         git_print_page_path($file_name, $ftype, $hash_base)
7021                 if (defined $file_name);
7023         $body_subr->(\@commitlist, 0, 99, $refs, $next_link,
7024                      $file_name, $file_hash, $ftype);
7026         git_footer_html();
7029 sub git_log {
7030         git_log_generic('log', \&git_log_body,
7031                         $hash, $hash_parent);
7034 sub git_commit {
7035         $hash ||= $hash_base || "HEAD";
7036         my %co = parse_commit($hash)
7037             or die_error(404, "Unknown commit object");
7039         my $parent  = $co{'parent'};
7040         my $parents = $co{'parents'}; # listref
7042         # we need to prepare $formats_nav before any parameter munging
7043         my $formats_nav;
7044         if (!defined $parent) {
7045                 # --root commitdiff
7046                 $formats_nav .= '(initial)';
7047         } elsif (@$parents == 1) {
7048                 # single parent commit
7049                 $formats_nav .=
7050                         '(parent: ' .
7051                         $cgi->a({-href => href(action=>"commit",
7052                                                hash=>$parent)},
7053                                 esc_html(substr($parent, 0, 7))) .
7054                         ')';
7055         } else {
7056                 # merge commit
7057                 $formats_nav .=
7058                         '(merge: ' .
7059                         join(' ', map {
7060                                 $cgi->a({-href => href(action=>"commit",
7061                                                        hash=>$_)},
7062                                         esc_html(substr($_, 0, 7)));
7063                         } @$parents ) .
7064                         ')';
7065         }
7066         if (gitweb_check_feature('patches') && @$parents <= 1) {
7067                 $formats_nav .= " | " .
7068                         $cgi->a({-href => href(action=>"patch", -replay=>1)},
7069                                 "patch");
7070         }
7072         if (!defined $parent) {
7073                 $parent = "--root";
7074         }
7075         my @difftree;
7076         open my $fd, "-|", git_cmd(), "diff-tree", '-r', "--no-commit-id",
7077                 @diff_opts,
7078                 (@$parents <= 1 ? $parent : '-c'),
7079                 $hash, "--"
7080                 or die_error(500, "Open git-diff-tree failed");
7081         @difftree = map { chomp; $_ } <$fd>;
7082         close $fd or die_error(404, "Reading git-diff-tree failed");
7084         # non-textual hash id's can be cached
7085         my $expires;
7086         if ($hash =~ m/^[0-9a-fA-F]{40}$/) {
7087                 $expires = "+1d";
7088         }
7089         my $refs = git_get_references();
7090         my $ref = format_ref_marker($refs, $co{'id'});
7092         git_header_html(undef, $expires);
7093         git_print_page_nav('commit', '',
7094                            $hash, $co{'tree'}, $hash,
7095                            $formats_nav);
7097         if (defined $co{'parent'}) {
7098                 git_print_header_div('commitdiff', esc_html($co{'title'}) . $ref, $hash);
7099         } else {
7100                 git_print_header_div('tree', esc_html($co{'title'}) . $ref, $co{'tree'}, $hash);
7101         }
7102         print "<div class=\"title_text\">\n" .
7103               "<table class=\"object_header\">\n";
7104         git_print_authorship_rows(\%co);
7105         print "<tr><td>commit</td><td class=\"sha1\">$co{'id'}</td></tr>\n";
7106         print "<tr>" .
7107               "<td>tree</td>" .
7108               "<td class=\"sha1\">" .
7109               $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash),
7110                        class => "list"}, $co{'tree'}) .
7111               "</td>" .
7112               "<td class=\"link\">" .
7113               $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash)},
7114                       "tree");
7115         my $snapshot_links = format_snapshot_links($hash);
7116         if (defined $snapshot_links) {
7117                 print " | " . $snapshot_links;
7118         }
7119         print "</td>" .
7120               "</tr>\n";
7122         foreach my $par (@$parents) {
7123                 print "<tr>" .
7124                       "<td>parent</td>" .
7125                       "<td class=\"sha1\">" .
7126                       $cgi->a({-href => href(action=>"commit", hash=>$par),
7127                                class => "list"}, $par) .
7128                       "</td>" .
7129                       "<td class=\"link\">" .
7130                       $cgi->a({-href => href(action=>"commit", hash=>$par)}, "commit") .
7131                       " | " .
7132                       $cgi->a({-href => href(action=>"commitdiff", hash=>$hash, hash_parent=>$par)}, "diff") .
7133                       "</td>" .
7134                       "</tr>\n";
7135         }
7136         print "</table>".
7137               "</div>\n";
7139         print "<div class=\"page_body\">\n";
7140         git_print_log($co{'comment'});
7141         print "</div>\n";
7143         git_difftree_body(\@difftree, $hash, @$parents);
7145         git_footer_html();
7148 sub git_object {
7149         # object is defined by:
7150         # - hash or hash_base alone
7151         # - hash_base and file_name
7152         my $type;
7154         # - hash or hash_base alone
7155         if ($hash || ($hash_base && !defined $file_name)) {
7156                 my $object_id = $hash || $hash_base;
7158                 open my $fd, "-|", quote_command(
7159                         git_cmd(), 'cat-file', '-t', $object_id) . ' 2> /dev/null'
7160                         or die_error(404, "Object does not exist");
7161                 $type = <$fd>;
7162                 chomp $type;
7163                 close $fd
7164                         or die_error(404, "Object does not exist");
7166         # - hash_base and file_name
7167         } elsif ($hash_base && defined $file_name) {
7168                 $file_name =~ s,/+$,,;
7170                 system(git_cmd(), "cat-file", '-e', $hash_base) == 0
7171                         or die_error(404, "Base object does not exist");
7173                 # here errors should not hapen
7174                 open my $fd, "-|", git_cmd(), "ls-tree", $hash_base, "--", $file_name
7175                         or die_error(500, "Open git-ls-tree failed");
7176                 my $line = <$fd>;
7177                 close $fd;
7179                 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa  panic.c'
7180                 unless ($line && $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t/) {
7181                         die_error(404, "File or directory for given base does not exist");
7182                 }
7183                 $type = $2;
7184                 $hash = $3;
7185         } else {
7186                 die_error(400, "Not enough information to find object");
7187         }
7189         print $cgi->redirect(-uri => href(action=>$type, -full=>1,
7190                                           hash=>$hash, hash_base=>$hash_base,
7191                                           file_name=>$file_name),
7192                              -status => '302 Found');
7195 sub git_blobdiff {
7196         my $format = shift || 'html';
7197         my $diff_style = $input_params{'diff_style'} || 'inline';
7199         my $fd;
7200         my @difftree;
7201         my %diffinfo;
7202         my $expires;
7204         # preparing $fd and %diffinfo for git_patchset_body
7205         # new style URI
7206         if (defined $hash_base && defined $hash_parent_base) {
7207                 if (defined $file_name) {
7208                         # read raw output
7209                         open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7210                                 $hash_parent_base, $hash_base,
7211                                 "--", (defined $file_parent ? $file_parent : ()), $file_name
7212                                 or die_error(500, "Open git-diff-tree failed");
7213                         @difftree = map { chomp; $_ } <$fd>;
7214                         close $fd
7215                                 or die_error(404, "Reading git-diff-tree failed");
7216                         @difftree
7217                                 or die_error(404, "Blob diff not found");
7219                 } elsif (defined $hash &&
7220                          $hash =~ /[0-9a-fA-F]{40}/) {
7221                         # try to find filename from $hash
7223                         # read filtered raw output
7224                         open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7225                                 $hash_parent_base, $hash_base, "--"
7226                                 or die_error(500, "Open git-diff-tree failed");
7227                         @difftree =
7228                                 # ':100644 100644 03b21826... 3b93d5e7... M     ls-files.c'
7229                                 # $hash == to_id
7230                                 grep { /^:[0-7]{6} [0-7]{6} [0-9a-fA-F]{40} $hash/ }
7231                                 map { chomp; $_ } <$fd>;
7232                         close $fd
7233                                 or die_error(404, "Reading git-diff-tree failed");
7234                         @difftree
7235                                 or die_error(404, "Blob diff not found");
7237                 } else {
7238                         die_error(400, "Missing one of the blob diff parameters");
7239                 }
7241                 if (@difftree > 1) {
7242                         die_error(400, "Ambiguous blob diff specification");
7243                 }
7245                 %diffinfo = parse_difftree_raw_line($difftree[0]);
7246                 $file_parent ||= $diffinfo{'from_file'} || $file_name;
7247                 $file_name   ||= $diffinfo{'to_file'};
7249                 $hash_parent ||= $diffinfo{'from_id'};
7250                 $hash        ||= $diffinfo{'to_id'};
7252                 # non-textual hash id's can be cached
7253                 if ($hash_base =~ m/^[0-9a-fA-F]{40}$/ &&
7254                     $hash_parent_base =~ m/^[0-9a-fA-F]{40}$/) {
7255                         $expires = '+1d';
7256                 }
7258                 # open patch output
7259                 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7260                         '-p', ($format eq 'html' ? "--full-index" : ()),
7261                         $hash_parent_base, $hash_base,
7262                         "--", (defined $file_parent ? $file_parent : ()), $file_name
7263                         or die_error(500, "Open git-diff-tree failed");
7264         }
7266         # old/legacy style URI -- not generated anymore since 1.4.3.
7267         if (!%diffinfo) {
7268                 die_error('404 Not Found', "Missing one of the blob diff parameters")
7269         }
7271         # header
7272         if ($format eq 'html') {
7273                 my $formats_nav =
7274                         $cgi->a({-href => href(action=>"blobdiff_plain", -replay=>1)},
7275                                 "raw");
7276                 $formats_nav .= diff_style_nav($diff_style);
7277                 git_header_html(undef, $expires);
7278                 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7279                         git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
7280                         git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
7281                 } else {
7282                         print "<div class=\"page_nav\"><br/>$formats_nav<br/></div>\n";
7283                         print "<div class=\"title\">".esc_html("$hash vs $hash_parent")."</div>\n";
7284                 }
7285                 if (defined $file_name) {
7286                         git_print_page_path($file_name, "blob", $hash_base);
7287                 } else {
7288                         print "<div class=\"page_path\"></div>\n";
7289                 }
7291         } elsif ($format eq 'plain') {
7292                 print $cgi->header(
7293                         -type => 'text/plain',
7294                         -charset => 'utf-8',
7295                         -expires => $expires,
7296                         -content_disposition => 'inline; filename="' . "$file_name" . '.patch"');
7298                 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
7300         } else {
7301                 die_error(400, "Unknown blobdiff format");
7302         }
7304         # patch
7305         if ($format eq 'html') {
7306                 print "<div class=\"page_body\">\n";
7308                 git_patchset_body($fd, $diff_style,
7309                                   [ \%diffinfo ], $hash_base, $hash_parent_base);
7310                 close $fd;
7312                 print "</div>\n"; # class="page_body"
7313                 git_footer_html();
7315         } else {
7316                 while (my $line = <$fd>) {
7317                         $line =~ s!a/($hash|$hash_parent)!'a/'.esc_path($diffinfo{'from_file'})!eg;
7318                         $line =~ s!b/($hash|$hash_parent)!'b/'.esc_path($diffinfo{'to_file'})!eg;
7320                         print $line;
7322                         last if $line =~ m!^\+\+\+!;
7323                 }
7324                 local $/ = undef;
7325                 print <$fd>;
7326                 close $fd;
7327         }
7330 sub git_blobdiff_plain {
7331         git_blobdiff('plain');
7334 # assumes that it is added as later part of already existing navigation,
7335 # so it returns "| foo | bar" rather than just "foo | bar"
7336 sub diff_style_nav {
7337         my ($diff_style, $is_combined) = @_;
7338         $diff_style ||= 'inline';
7340         return "" if ($is_combined);
7342         my @styles = (inline => 'inline', 'sidebyside' => 'side by side');
7343         my %styles = @styles;
7344         @styles =
7345                 @styles[ map { $_ * 2 } 0..$#styles/2 ];
7347         return join '',
7348                 map { " | ".$_ }
7349                 map {
7350                         $_ eq $diff_style ? $styles{$_} :
7351                         $cgi->a({-href => href(-replay=>1, diff_style => $_)}, $styles{$_})
7352                 } @styles;
7355 sub git_commitdiff {
7356         my %params = @_;
7357         my $format = $params{-format} || 'html';
7358         my $diff_style = $input_params{'diff_style'} || 'inline';
7360         my ($patch_max) = gitweb_get_feature('patches');
7361         if ($format eq 'patch') {
7362                 die_error(403, "Patch view not allowed") unless $patch_max;
7363         }
7365         $hash ||= $hash_base || "HEAD";
7366         my %co = parse_commit($hash)
7367             or die_error(404, "Unknown commit object");
7369         # choose format for commitdiff for merge
7370         if (! defined $hash_parent && @{$co{'parents'}} > 1) {
7371                 $hash_parent = '--cc';
7372         }
7373         # we need to prepare $formats_nav before almost any parameter munging
7374         my $formats_nav;
7375         if ($format eq 'html') {
7376                 $formats_nav =
7377                         $cgi->a({-href => href(action=>"commitdiff_plain", -replay=>1)},
7378                                 "raw");
7379                 if ($patch_max && @{$co{'parents'}} <= 1) {
7380                         $formats_nav .= " | " .
7381                                 $cgi->a({-href => href(action=>"patch", -replay=>1)},
7382                                         "patch");
7383                 }
7384                 $formats_nav .= diff_style_nav($diff_style, @{$co{'parents'}} > 1);
7386                 if (defined $hash_parent &&
7387                     $hash_parent ne '-c' && $hash_parent ne '--cc') {
7388                         # commitdiff with two commits given
7389                         my $hash_parent_short = $hash_parent;
7390                         if ($hash_parent =~ m/^[0-9a-fA-F]{40}$/) {
7391                                 $hash_parent_short = substr($hash_parent, 0, 7);
7392                         }
7393                         $formats_nav .=
7394                                 ' (from';
7395                         for (my $i = 0; $i < @{$co{'parents'}}; $i++) {
7396                                 if ($co{'parents'}[$i] eq $hash_parent) {
7397                                         $formats_nav .= ' parent ' . ($i+1);
7398                                         last;
7399                                 }
7400                         }
7401                         $formats_nav .= ': ' .
7402                                 $cgi->a({-href => href(-replay=>1,
7403                                                        hash=>$hash_parent, hash_base=>undef)},
7404                                         esc_html($hash_parent_short)) .
7405                                 ')';
7406                 } elsif (!$co{'parent'}) {
7407                         # --root commitdiff
7408                         $formats_nav .= ' (initial)';
7409                 } elsif (scalar @{$co{'parents'}} == 1) {
7410                         # single parent commit
7411                         $formats_nav .=
7412                                 ' (parent: ' .
7413                                 $cgi->a({-href => href(-replay=>1,
7414                                                        hash=>$co{'parent'}, hash_base=>undef)},
7415                                         esc_html(substr($co{'parent'}, 0, 7))) .
7416                                 ')';
7417                 } else {
7418                         # merge commit
7419                         if ($hash_parent eq '--cc') {
7420                                 $formats_nav .= ' | ' .
7421                                         $cgi->a({-href => href(-replay=>1,
7422                                                                hash=>$hash, hash_parent=>'-c')},
7423                                                 'combined');
7424                         } else { # $hash_parent eq '-c'
7425                                 $formats_nav .= ' | ' .
7426                                         $cgi->a({-href => href(-replay=>1,
7427                                                                hash=>$hash, hash_parent=>'--cc')},
7428                                                 'compact');
7429                         }
7430                         $formats_nav .=
7431                                 ' (merge: ' .
7432                                 join(' ', map {
7433                                         $cgi->a({-href => href(-replay=>1,
7434                                                                hash=>$_, hash_base=>undef)},
7435                                                 esc_html(substr($_, 0, 7)));
7436                                 } @{$co{'parents'}} ) .
7437                                 ')';
7438                 }
7439         }
7441         my $hash_parent_param = $hash_parent;
7442         if (!defined $hash_parent_param) {
7443                 # --cc for multiple parents, --root for parentless
7444                 $hash_parent_param =
7445                         @{$co{'parents'}} > 1 ? '--cc' : $co{'parent'} || '--root';
7446         }
7448         # read commitdiff
7449         my $fd;
7450         my @difftree;
7451         if ($format eq 'html') {
7452                 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7453                         "--no-commit-id", "--patch-with-raw", "--full-index",
7454                         $hash_parent_param, $hash, "--"
7455                         or die_error(500, "Open git-diff-tree failed");
7457                 while (my $line = <$fd>) {
7458                         chomp $line;
7459                         # empty line ends raw part of diff-tree output
7460                         last unless $line;
7461                         push @difftree, scalar parse_difftree_raw_line($line);
7462                 }
7464         } elsif ($format eq 'plain') {
7465                 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7466                         '-p', $hash_parent_param, $hash, "--"
7467                         or die_error(500, "Open git-diff-tree failed");
7468         } elsif ($format eq 'patch') {
7469                 # For commit ranges, we limit the output to the number of
7470                 # patches specified in the 'patches' feature.
7471                 # For single commits, we limit the output to a single patch,
7472                 # diverging from the git-format-patch default.
7473                 my @commit_spec = ();
7474                 if ($hash_parent) {
7475                         if ($patch_max > 0) {
7476                                 push @commit_spec, "-$patch_max";
7477                         }
7478                         push @commit_spec, '-n', "$hash_parent..$hash";
7479                 } else {
7480                         if ($params{-single}) {
7481                                 push @commit_spec, '-1';
7482                         } else {
7483                                 if ($patch_max > 0) {
7484                                         push @commit_spec, "-$patch_max";
7485                                 }
7486                                 push @commit_spec, "-n";
7487                         }
7488                         push @commit_spec, '--root', $hash;
7489                 }
7490                 open $fd, "-|", git_cmd(), "format-patch", @diff_opts,
7491                         '--encoding=utf8', '--stdout', @commit_spec
7492                         or die_error(500, "Open git-format-patch failed");
7493         } else {
7494                 die_error(400, "Unknown commitdiff format");
7495         }
7497         # non-textual hash id's can be cached
7498         my $expires;
7499         if ($hash =~ m/^[0-9a-fA-F]{40}$/) {
7500                 $expires = "+1d";
7501         }
7503         # write commit message
7504         if ($format eq 'html') {
7505                 my $refs = git_get_references();
7506                 my $ref = format_ref_marker($refs, $co{'id'});
7508                 git_header_html(undef, $expires);
7509                 git_print_page_nav('commitdiff','', $hash,$co{'tree'},$hash, $formats_nav);
7510                 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash);
7511                 print "<div class=\"title_text\">\n" .
7512                       "<table class=\"object_header\">\n";
7513                 git_print_authorship_rows(\%co);
7514                 print "</table>".
7515                       "</div>\n";
7516                 print "<div class=\"page_body\">\n";
7517                 if (@{$co{'comment'}} > 1) {
7518                         print "<div class=\"log\">\n";
7519                         git_print_log($co{'comment'}, -final_empty_line=> 1, -remove_title => 1);
7520                         print "</div>\n"; # class="log"
7521                 }
7523         } elsif ($format eq 'plain') {
7524                 my $refs = git_get_references("tags");
7525                 my $tagname = git_get_rev_name_tags($hash);
7526                 my $filename = basename($project) . "-$hash.patch";
7528                 print $cgi->header(
7529                         -type => 'text/plain',
7530                         -charset => 'utf-8',
7531                         -expires => $expires,
7532                         -content_disposition => 'inline; filename="' . "$filename" . '"');
7533                 my %ad = parse_date($co{'author_epoch'}, $co{'author_tz'});
7534                 print "From: " . to_utf8($co{'author'}) . "\n";
7535                 print "Date: $ad{'rfc2822'} ($ad{'tz_local'})\n";
7536                 print "Subject: " . to_utf8($co{'title'}) . "\n";
7538                 print "X-Git-Tag: $tagname\n" if $tagname;
7539                 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
7541                 foreach my $line (@{$co{'comment'}}) {
7542                         print to_utf8($line) . "\n";
7543                 }
7544                 print "---\n\n";
7545         } elsif ($format eq 'patch') {
7546                 my $filename = basename($project) . "-$hash.patch";
7548                 print $cgi->header(
7549                         -type => 'text/plain',
7550                         -charset => 'utf-8',
7551                         -expires => $expires,
7552                         -content_disposition => 'inline; filename="' . "$filename" . '"');
7553         }
7555         # write patch
7556         if ($format eq 'html') {
7557                 my $use_parents = !defined $hash_parent ||
7558                         $hash_parent eq '-c' || $hash_parent eq '--cc';
7559                 git_difftree_body(\@difftree, $hash,
7560                                   $use_parents ? @{$co{'parents'}} : $hash_parent);
7561                 print "<br/>\n";
7563                 git_patchset_body($fd, $diff_style,
7564                                   \@difftree, $hash,
7565                                   $use_parents ? @{$co{'parents'}} : $hash_parent);
7566                 close $fd;
7567                 print "</div>\n"; # class="page_body"
7568                 git_footer_html();
7570         } elsif ($format eq 'plain') {
7571                 local $/ = undef;
7572                 print <$fd>;
7573                 close $fd
7574                         or print "Reading git-diff-tree failed\n";
7575         } elsif ($format eq 'patch') {
7576                 local $/ = undef;
7577                 print <$fd>;
7578                 close $fd
7579                         or print "Reading git-format-patch failed\n";
7580         }
7583 sub git_commitdiff_plain {
7584         git_commitdiff(-format => 'plain');
7587 # format-patch-style patches
7588 sub git_patch {
7589         git_commitdiff(-format => 'patch', -single => 1);
7592 sub git_patches {
7593         git_commitdiff(-format => 'patch');
7596 sub git_history {
7597         git_log_generic('history', \&git_history_body,
7598                         $hash_base, $hash_parent_base,
7599                         $file_name, $hash);
7602 sub git_search {
7603         $searchtype ||= 'commit';
7605         # check if appropriate features are enabled
7606         gitweb_check_feature('search')
7607                 or die_error(403, "Search is disabled");
7608         if ($searchtype eq 'pickaxe') {
7609                 # pickaxe may take all resources of your box and run for several minutes
7610                 # with every query - so decide by yourself how public you make this feature
7611                 gitweb_check_feature('pickaxe')
7612                         or die_error(403, "Pickaxe search is disabled");
7613         }
7614         if ($searchtype eq 'grep') {
7615                 # grep search might be potentially CPU-intensive, too
7616                 gitweb_check_feature('grep')
7617                         or die_error(403, "Grep search is disabled");
7618         }
7620         if (!defined $searchtext) {
7621                 die_error(400, "Text field is empty");
7622         }
7623         if (!defined $hash) {
7624                 $hash = git_get_head_hash($project);
7625         }
7626         my %co = parse_commit($hash);
7627         if (!%co) {
7628                 die_error(404, "Unknown commit object");
7629         }
7630         if (!defined $page) {
7631                 $page = 0;
7632         }
7634         if ($searchtype eq 'commit' ||
7635             $searchtype eq 'author' ||
7636             $searchtype eq 'committer') {
7637                 git_search_message(%co);
7638         } elsif ($searchtype eq 'pickaxe') {
7639                 git_search_changes(%co);
7640         } elsif ($searchtype eq 'grep') {
7641                 git_search_files(%co);
7642         } else {
7643                 die_error(400, "Unknown search type");
7644         }
7647 sub git_search_help {
7648         git_header_html();
7649         git_print_page_nav('','', $hash,$hash,$hash);
7650         print <<EOT;
7651 <p><strong>Pattern</strong> is by default a normal string that is matched precisely (but without
7652 regard to case, except in the case of pickaxe). However, when you check the <em>re</em> checkbox,
7653 the pattern entered is recognized as the POSIX extended
7654 <a href="http://en.wikipedia.org/wiki/Regular_expression">regular expression</a> (also case
7655 insensitive).</p>
7656 <dl>
7657 <dt><b>commit</b></dt>
7658 <dd>The commit messages and authorship information will be scanned for the given pattern.</dd>
7659 EOT
7660         my $have_grep = gitweb_check_feature('grep');
7661         if ($have_grep) {
7662                 print <<EOT;
7663 <dt><b>grep</b></dt>
7664 <dd>All files in the currently selected tree (HEAD unless you are explicitly browsing
7665     a different one) are searched for the given pattern. On large trees, this search can take
7666 a while and put some strain on the server, so please use it with some consideration. Note that
7667 due to git-grep peculiarity, currently if regexp mode is turned off, the matches are
7668 case-sensitive.</dd>
7669 EOT
7670         }
7671         print <<EOT;
7672 <dt><b>author</b></dt>
7673 <dd>Name and e-mail of the change author and date of birth of the patch will be scanned for the given pattern.</dd>
7674 <dt><b>committer</b></dt>
7675 <dd>Name and e-mail of the committer and date of commit will be scanned for the given pattern.</dd>
7676 EOT
7677         my $have_pickaxe = gitweb_check_feature('pickaxe');
7678         if ($have_pickaxe) {
7679                 print <<EOT;
7680 <dt><b>pickaxe</b></dt>
7681 <dd>All commits that caused the string to appear or disappear from any file (changes that
7682 added, removed or "modified" the string) will be listed. This search can take a while and
7683 takes a lot of strain on the server, so please use it wisely. Note that since you may be
7684 interested even in changes just changing the case as well, this search is case sensitive.</dd>
7685 EOT
7686         }
7687         print "</dl>\n";
7688         git_footer_html();
7691 sub git_shortlog {
7692         git_log_generic('shortlog', \&git_shortlog_body,
7693                         $hash, $hash_parent);
7696 ## ......................................................................
7697 ## feeds (RSS, Atom; OPML)
7699 sub git_feed {
7700         my $format = shift || 'atom';
7701         my $have_blame = gitweb_check_feature('blame');
7703         # Atom: http://www.atomenabled.org/developers/syndication/
7704         # RSS:  http://www.notestips.com/80256B3A007F2692/1/NAMO5P9UPQ
7705         if ($format ne 'rss' && $format ne 'atom') {
7706                 die_error(400, "Unknown web feed format");
7707         }
7709         # log/feed of current (HEAD) branch, log of given branch, history of file/directory
7710         my $head = $hash || 'HEAD';
7711         my @commitlist = parse_commits($head, 150, 0, $file_name);
7713         my %latest_commit;
7714         my %latest_date;
7715         my $content_type = "application/$format+xml";
7716         if (defined $cgi->http('HTTP_ACCEPT') &&
7717                  $cgi->Accept('text/xml') > $cgi->Accept($content_type)) {
7718                 # browser (feed reader) prefers text/xml
7719                 $content_type = 'text/xml';
7720         }
7721         if (defined($commitlist[0])) {
7722                 %latest_commit = %{$commitlist[0]};
7723                 my $latest_epoch = $latest_commit{'committer_epoch'};
7724                 %latest_date   = parse_date($latest_epoch, $latest_commit{'comitter_tz'});
7725                 my $if_modified = $cgi->http('IF_MODIFIED_SINCE');
7726                 if (defined $if_modified) {
7727                         my $since;
7728                         if (eval { require HTTP::Date; 1; }) {
7729                                 $since = HTTP::Date::str2time($if_modified);
7730                         } elsif (eval { require Time::ParseDate; 1; }) {
7731                                 $since = Time::ParseDate::parsedate($if_modified, GMT => 1);
7732                         }
7733                         if (defined $since && $latest_epoch <= $since) {
7734                                 print $cgi->header(
7735                                         -type => $content_type,
7736                                         -charset => 'utf-8',
7737                                         -last_modified => $latest_date{'rfc2822'},
7738                                         -status => '304 Not Modified');
7739                                 return;
7740                         }
7741                 }
7742                 print $cgi->header(
7743                         -type => $content_type,
7744                         -charset => 'utf-8',
7745                         -last_modified => $latest_date{'rfc2822'});
7746         } else {
7747                 print $cgi->header(
7748                         -type => $content_type,
7749                         -charset => 'utf-8');
7750         }
7752         # Optimization: skip generating the body if client asks only
7753         # for Last-Modified date.
7754         return if ($cgi->request_method() eq 'HEAD');
7756         # header variables
7757         my $title = "$site_name - $project/$action";
7758         my $feed_type = 'log';
7759         if (defined $hash) {
7760                 $title .= " - '$hash'";
7761                 $feed_type = 'branch log';
7762                 if (defined $file_name) {
7763                         $title .= " :: $file_name";
7764                         $feed_type = 'history';
7765                 }
7766         } elsif (defined $file_name) {
7767                 $title .= " - $file_name";
7768                 $feed_type = 'history';
7769         }
7770         $title .= " $feed_type";
7771         my $descr = git_get_project_description($project);
7772         if (defined $descr) {
7773                 $descr = esc_html($descr);
7774         } else {
7775                 $descr = "$project " .
7776                          ($format eq 'rss' ? 'RSS' : 'Atom') .
7777                          " feed";
7778         }
7779         my $owner = git_get_project_owner($project);
7780         $owner = esc_html($owner);
7782         #header
7783         my $alt_url;
7784         if (defined $file_name) {
7785                 $alt_url = href(-full=>1, action=>"history", hash=>$hash, file_name=>$file_name);
7786         } elsif (defined $hash) {
7787                 $alt_url = href(-full=>1, action=>"log", hash=>$hash);
7788         } else {
7789                 $alt_url = href(-full=>1, action=>"summary");
7790         }
7791         print qq!<?xml version="1.0" encoding="utf-8"?>\n!;
7792         if ($format eq 'rss') {
7793                 print <<XML;
7794 <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
7795 <channel>
7796 XML
7797                 print "<title>$title</title>\n" .
7798                       "<link>$alt_url</link>\n" .
7799                       "<description>$descr</description>\n" .
7800                       "<language>en</language>\n" .
7801                       # project owner is responsible for 'editorial' content
7802                       "<managingEditor>$owner</managingEditor>\n";
7803                 if (defined $logo || defined $favicon) {
7804                         # prefer the logo to the favicon, since RSS
7805                         # doesn't allow both
7806                         my $img = esc_url($logo || $favicon);
7807                         print "<image>\n" .
7808                               "<url>$img</url>\n" .
7809                               "<title>$title</title>\n" .
7810                               "<link>$alt_url</link>\n" .
7811                               "</image>\n";
7812                 }
7813                 if (%latest_date) {
7814                         print "<pubDate>$latest_date{'rfc2822'}</pubDate>\n";
7815                         print "<lastBuildDate>$latest_date{'rfc2822'}</lastBuildDate>\n";
7816                 }
7817                 print "<generator>gitweb v.$version/$git_version</generator>\n";
7818         } elsif ($format eq 'atom') {
7819                 print <<XML;
7820 <feed xmlns="http://www.w3.org/2005/Atom">
7821 XML
7822                 print "<title>$title</title>\n" .
7823                       "<subtitle>$descr</subtitle>\n" .
7824                       '<link rel="alternate" type="text/html" href="' .
7825                       $alt_url . '" />' . "\n" .
7826                       '<link rel="self" type="' . $content_type . '" href="' .
7827                       $cgi->self_url() . '" />' . "\n" .
7828                       "<id>" . href(-full=>1) . "</id>\n" .
7829                       # use project owner for feed author
7830                       "<author><name>$owner</name></author>\n";
7831                 if (defined $favicon) {
7832                         print "<icon>" . esc_url($favicon) . "</icon>\n";
7833                 }
7834                 if (defined $logo) {
7835                         # not twice as wide as tall: 72 x 27 pixels
7836                         print "<logo>" . esc_url($logo) . "</logo>\n";
7837                 }
7838                 if (! %latest_date) {
7839                         # dummy date to keep the feed valid until commits trickle in:
7840                         print "<updated>1970-01-01T00:00:00Z</updated>\n";
7841                 } else {
7842                         print "<updated>$latest_date{'iso-8601'}</updated>\n";
7843                 }
7844                 print "<generator version='$version/$git_version'>gitweb</generator>\n";
7845         }
7847         # contents
7848         for (my $i = 0; $i <= $#commitlist; $i++) {
7849                 my %co = %{$commitlist[$i]};
7850                 my $commit = $co{'id'};
7851                 # we read 150, we always show 30 and the ones more recent than 48 hours
7852                 if (($i >= 20) && ((time - $co{'author_epoch'}) > 48*60*60)) {
7853                         last;
7854                 }
7855                 my %cd = parse_date($co{'author_epoch'}, $co{'author_tz'});
7857                 # get list of changed files
7858                 open my $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7859                         $co{'parent'} || "--root",
7860                         $co{'id'}, "--", (defined $file_name ? $file_name : ())
7861                         or next;
7862                 my @difftree = map { chomp; $_ } <$fd>;
7863                 close $fd
7864                         or next;
7866                 # print element (entry, item)
7867                 my $co_url = href(-full=>1, action=>"commitdiff", hash=>$commit);
7868                 if ($format eq 'rss') {
7869                         print "<item>\n" .
7870                               "<title>" . esc_html($co{'title'}) . "</title>\n" .
7871                               "<author>" . esc_html($co{'author'}) . "</author>\n" .
7872                               "<pubDate>$cd{'rfc2822'}</pubDate>\n" .
7873                               "<guid isPermaLink=\"true\">$co_url</guid>\n" .
7874                               "<link>$co_url</link>\n" .
7875                               "<description>" . esc_html($co{'title'}) . "</description>\n" .
7876                               "<content:encoded>" .
7877                               "<![CDATA[\n";
7878                 } elsif ($format eq 'atom') {
7879                         print "<entry>\n" .
7880                               "<title type=\"html\">" . esc_html($co{'title'}) . "</title>\n" .
7881                               "<updated>$cd{'iso-8601'}</updated>\n" .
7882                               "<author>\n" .
7883                               "  <name>" . esc_html($co{'author_name'}) . "</name>\n";
7884                         if ($co{'author_email'}) {
7885                                 print "  <email>" . esc_html($co{'author_email'}) . "</email>\n";
7886                         }
7887                         print "</author>\n" .
7888                               # use committer for contributor
7889                               "<contributor>\n" .
7890                               "  <name>" . esc_html($co{'committer_name'}) . "</name>\n";
7891                         if ($co{'committer_email'}) {
7892                                 print "  <email>" . esc_html($co{'committer_email'}) . "</email>\n";
7893                         }
7894                         print "</contributor>\n" .
7895                               "<published>$cd{'iso-8601'}</published>\n" .
7896                               "<link rel=\"alternate\" type=\"text/html\" href=\"$co_url\" />\n" .
7897                               "<id>$co_url</id>\n" .
7898                               "<content type=\"xhtml\" xml:base=\"" . esc_url($my_url) . "\">\n" .
7899                               "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n";
7900                 }
7901                 my $comment = $co{'comment'};
7902                 print "<pre>\n";
7903                 foreach my $line (@$comment) {
7904                         $line = esc_html($line);
7905                         print "$line\n";
7906                 }
7907                 print "</pre><ul>\n";
7908                 foreach my $difftree_line (@difftree) {
7909                         my %difftree = parse_difftree_raw_line($difftree_line);
7910                         next if !$difftree{'from_id'};
7912                         my $file = $difftree{'file'} || $difftree{'to_file'};
7914                         print "<li>" .
7915                               "[" .
7916                               $cgi->a({-href => href(-full=>1, action=>"blobdiff",
7917                                                      hash=>$difftree{'to_id'}, hash_parent=>$difftree{'from_id'},
7918                                                      hash_base=>$co{'id'}, hash_parent_base=>$co{'parent'},
7919                                                      file_name=>$file, file_parent=>$difftree{'from_file'}),
7920                                       -title => "diff"}, 'D');
7921                         if ($have_blame) {
7922                                 print $cgi->a({-href => href(-full=>1, action=>"blame",
7923                                                              file_name=>$file, hash_base=>$commit),
7924                                               -title => "blame"}, 'B');
7925                         }
7926                         # if this is not a feed of a file history
7927                         if (!defined $file_name || $file_name ne $file) {
7928                                 print $cgi->a({-href => href(-full=>1, action=>"history",
7929                                                              file_name=>$file, hash=>$commit),
7930                                               -title => "history"}, 'H');
7931                         }
7932                         $file = esc_path($file);
7933                         print "] ".
7934                               "$file</li>\n";
7935                 }
7936                 if ($format eq 'rss') {
7937                         print "</ul>]]>\n" .
7938                               "</content:encoded>\n" .
7939                               "</item>\n";
7940                 } elsif ($format eq 'atom') {
7941                         print "</ul>\n</div>\n" .
7942                               "</content>\n" .
7943                               "</entry>\n";
7944                 }
7945         }
7947         # end of feed
7948         if ($format eq 'rss') {
7949                 print "</channel>\n</rss>\n";
7950         } elsif ($format eq 'atom') {
7951                 print "</feed>\n";
7952         }
7955 sub git_rss {
7956         git_feed('rss');
7959 sub git_atom {
7960         git_feed('atom');
7963 sub git_opml {
7964         my @list = git_get_projects_list($project_filter, $strict_export);
7965         if (!@list) {
7966                 die_error(404, "No projects found");
7967         }
7969         print $cgi->header(
7970                 -type => 'text/xml',
7971                 -charset => 'utf-8',
7972                 -content_disposition => 'inline; filename="opml.xml"');
7974         my $title = esc_html($site_name);
7975         my $filter = " within subdirectory ";
7976         if (defined $project_filter) {
7977                 $filter .= esc_html($project_filter);
7978         } else {
7979                 $filter = "";
7980         }
7981         print <<XML;
7982 <?xml version="1.0" encoding="utf-8"?>
7983 <opml version="1.0">
7984 <head>
7985   <title>$title OPML Export$filter</title>
7986 </head>
7987 <body>
7988 <outline text="git RSS feeds">
7989 XML
7991         foreach my $pr (@list) {
7992                 my %proj = %$pr;
7993                 my $head = git_get_head_hash($proj{'path'});
7994                 if (!defined $head) {
7995                         next;
7996                 }
7997                 $git_dir = "$projectroot/$proj{'path'}";
7998                 my %co = parse_commit($head);
7999                 if (!%co) {
8000                         next;
8001                 }
8003                 my $path = esc_html(chop_str($proj{'path'}, 25, 5));
8004                 my $rss  = href('project' => $proj{'path'}, 'action' => 'rss', -full => 1);
8005                 my $html = href('project' => $proj{'path'}, 'action' => 'summary', -full => 1);
8006                 print "<outline type=\"rss\" text=\"$path\" title=\"$path\" xmlUrl=\"$rss\" htmlUrl=\"$html\"/>\n";
8007         }
8008         print <<XML;
8009 </outline>
8010 </body>
8011 </opml>
8012 XML