t7701: make annotated tag unreachable
[git/gitster.git] / gitweb / gitweb.perl
blobe66eb3d9bad7cf627d5ed35e13e32dafb556d5cd
1 #!/usr/bin/perl
3 # gitweb - simple web interface to track changes in git repositories
5 # (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
6 # (C) 2005, Christian Gierke
8 # This program is licensed under the GPLv2
10 use 5.008;
11 use strict;
12 use warnings;
13 # handle ACL in file access tests
14 use filetest 'access';
15 use CGI qw(:standard :escapeHTML -nosticky);
16 use CGI::Util qw(unescape);
17 use CGI::Carp qw(fatalsToBrowser set_message);
18 use Encode;
19 use Fcntl ':mode';
20 use File::Find qw();
21 use File::Basename qw(basename);
22 use Time::HiRes qw(gettimeofday tv_interval);
23 use Digest::MD5 qw(md5_hex);
25 binmode STDOUT, ':utf8';
27 if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
28 eval 'sub CGI::multi_param { CGI::param(@_) }'
31 our $t0 = [ gettimeofday() ];
32 our $number_of_git_cmds = 0;
34 BEGIN {
35 CGI->compile() if $ENV{'MOD_PERL'};
38 our $version = "++GIT_VERSION++";
40 our ($my_url, $my_uri, $base_url, $path_info, $home_link);
41 sub evaluate_uri {
42 our $cgi;
44 our $my_url = $cgi->url();
45 our $my_uri = $cgi->url(-absolute => 1);
47 # Base URL for relative URLs in gitweb ($logo, $favicon, ...),
48 # needed and used only for URLs with nonempty PATH_INFO
49 our $base_url = $my_url;
51 # When the script is used as DirectoryIndex, the URL does not contain the name
52 # of the script file itself, and $cgi->url() fails to strip PATH_INFO, so we
53 # have to do it ourselves. We make $path_info global because it's also used
54 # later on.
56 # Another issue with the script being the DirectoryIndex is that the resulting
57 # $my_url data is not the full script URL: this is good, because we want
58 # generated links to keep implying the script name if it wasn't explicitly
59 # indicated in the URL we're handling, but it means that $my_url cannot be used
60 # as base URL.
61 # Therefore, if we needed to strip PATH_INFO, then we know that we have
62 # to build the base URL ourselves:
63 our $path_info = decode_utf8($ENV{"PATH_INFO"});
64 if ($path_info) {
65 # $path_info has already been URL-decoded by the web server, but
66 # $my_url and $my_uri have not. URL-decode them so we can properly
67 # strip $path_info.
68 $my_url = unescape($my_url);
69 $my_uri = unescape($my_uri);
70 if ($my_url =~ s,\Q$path_info\E$,, &&
71 $my_uri =~ s,\Q$path_info\E$,, &&
72 defined $ENV{'SCRIPT_NAME'}) {
73 $base_url = $cgi->url(-base => 1) . $ENV{'SCRIPT_NAME'};
77 # target of the home link on top of all pages
78 our $home_link = $my_uri || "/";
81 # core git executable to use
82 # this can just be "git" if your webserver has a sensible PATH
83 our $GIT = "++GIT_BINDIR++/git";
85 # absolute fs-path which will be prepended to the project path
86 #our $projectroot = "/pub/scm";
87 our $projectroot = "++GITWEB_PROJECTROOT++";
89 # fs traversing limit for getting project list
90 # the number is relative to the projectroot
91 our $project_maxdepth = "++GITWEB_PROJECT_MAXDEPTH++";
93 # string of the home link on top of all pages
94 our $home_link_str = "++GITWEB_HOME_LINK_STR++";
96 # extra breadcrumbs preceding the home link
97 our @extra_breadcrumbs = ();
99 # name of your site or organization to appear in page titles
100 # replace this with something more descriptive for clearer bookmarks
101 our $site_name = "++GITWEB_SITENAME++"
102 || ($ENV{'SERVER_NAME'} || "Untitled") . " Git";
104 # html snippet to include in the <head> section of each page
105 our $site_html_head_string = "++GITWEB_SITE_HTML_HEAD_STRING++";
106 # filename of html text to include at top of each page
107 our $site_header = "++GITWEB_SITE_HEADER++";
108 # html text to include at home page
109 our $home_text = "++GITWEB_HOMETEXT++";
110 # filename of html text to include at bottom of each page
111 our $site_footer = "++GITWEB_SITE_FOOTER++";
113 # URI of stylesheets
114 our @stylesheets = ("++GITWEB_CSS++");
115 # URI of a single stylesheet, which can be overridden in GITWEB_CONFIG.
116 our $stylesheet = undef;
117 # URI of GIT logo (72x27 size)
118 our $logo = "++GITWEB_LOGO++";
119 # URI of GIT favicon, assumed to be image/png type
120 our $favicon = "++GITWEB_FAVICON++";
121 # URI of gitweb.js (JavaScript code for gitweb)
122 our $javascript = "++GITWEB_JS++";
124 # URI and label (title) of GIT logo link
125 #our $logo_url = "http://www.kernel.org/pub/software/scm/git/docs/";
126 #our $logo_label = "git documentation";
127 our $logo_url = "http://git-scm.com/";
128 our $logo_label = "git homepage";
130 # source of projects list
131 our $projects_list = "++GITWEB_LIST++";
133 # the width (in characters) of the projects list "Description" column
134 our $projects_list_description_width = 25;
136 # group projects by category on the projects list
137 # (enabled if this variable evaluates to true)
138 our $projects_list_group_categories = 0;
140 # default category if none specified
141 # (leave the empty string for no category)
142 our $project_list_default_category = "";
144 # default order of projects list
145 # valid values are none, project, descr, owner, and age
146 our $default_projects_order = "project";
148 # show repository only if this file exists
149 # (only effective if this variable evaluates to true)
150 our $export_ok = "++GITWEB_EXPORT_OK++";
152 # don't generate age column on the projects list page
153 our $omit_age_column = 0;
155 # don't generate information about owners of repositories
156 our $omit_owner=0;
158 # show repository only if this subroutine returns true
159 # when given the path to the project, for example:
160 # sub { return -e "$_[0]/git-daemon-export-ok"; }
161 our $export_auth_hook = undef;
163 # only allow viewing of repositories also shown on the overview page
164 our $strict_export = "++GITWEB_STRICT_EXPORT++";
166 # list of git base URLs used for URL to where fetch project from,
167 # i.e. full URL is "$git_base_url/$project"
168 our @git_base_url_list = grep { $_ ne '' } ("++GITWEB_BASE_URL++");
170 # default blob_plain mimetype and default charset for text/plain blob
171 our $default_blob_plain_mimetype = 'text/plain';
172 our $default_text_plain_charset = undef;
174 # file to use for guessing MIME types before trying /etc/mime.types
175 # (relative to the current git repository)
176 our $mimetypes_file = undef;
178 # assume this charset if line contains non-UTF-8 characters;
179 # it should be valid encoding (see Encoding::Supported(3pm) for list),
180 # for which encoding all byte sequences are valid, for example
181 # 'iso-8859-1' aka 'latin1' (it is decoded without checking, so it
182 # could be even 'utf-8' for the old behavior)
183 our $fallback_encoding = 'latin1';
185 # rename detection options for git-diff and git-diff-tree
186 # - default is '-M', with the cost proportional to
187 # (number of removed files) * (number of new files).
188 # - more costly is '-C' (which implies '-M'), with the cost proportional to
189 # (number of changed files + number of removed files) * (number of new files)
190 # - even more costly is '-C', '--find-copies-harder' with cost
191 # (number of files in the original tree) * (number of new files)
192 # - one might want to include '-B' option, e.g. '-B', '-M'
193 our @diff_opts = ('-M'); # taken from git_commit
195 # Disables features that would allow repository owners to inject script into
196 # the gitweb domain.
197 our $prevent_xss = 0;
199 # Path to the highlight executable to use (must be the one from
200 # http://www.andre-simon.de due to assumptions about parameters and output).
201 # Useful if highlight is not installed on your webserver's PATH.
202 # [Default: highlight]
203 our $highlight_bin = "++HIGHLIGHT_BIN++";
205 # information about snapshot formats that gitweb is capable of serving
206 our %known_snapshot_formats = (
207 # name => {
208 # 'display' => display name,
209 # 'type' => mime type,
210 # 'suffix' => filename suffix,
211 # 'format' => --format for git-archive,
212 # 'compressor' => [compressor command and arguments]
213 # (array reference, optional)
214 # 'disabled' => boolean (optional)}
216 'tgz' => {
217 'display' => 'tar.gz',
218 'type' => 'application/x-gzip',
219 'suffix' => '.tar.gz',
220 'format' => 'tar',
221 'compressor' => ['gzip', '-n']},
223 'tbz2' => {
224 'display' => 'tar.bz2',
225 'type' => 'application/x-bzip2',
226 'suffix' => '.tar.bz2',
227 'format' => 'tar',
228 'compressor' => ['bzip2']},
230 'txz' => {
231 'display' => 'tar.xz',
232 'type' => 'application/x-xz',
233 'suffix' => '.tar.xz',
234 'format' => 'tar',
235 'compressor' => ['xz'],
236 'disabled' => 1},
238 'zip' => {
239 'display' => 'zip',
240 'type' => 'application/x-zip',
241 'suffix' => '.zip',
242 'format' => 'zip'},
245 # Aliases so we understand old gitweb.snapshot values in repository
246 # configuration.
247 our %known_snapshot_format_aliases = (
248 'gzip' => 'tgz',
249 'bzip2' => 'tbz2',
250 'xz' => 'txz',
252 # backward compatibility: legacy gitweb config support
253 'x-gzip' => undef, 'gz' => undef,
254 'x-bzip2' => undef, 'bz2' => undef,
255 'x-zip' => undef, '' => undef,
258 # Pixel sizes for icons and avatars. If the default font sizes or lineheights
259 # are changed, it may be appropriate to change these values too via
260 # $GITWEB_CONFIG.
261 our %avatar_size = (
262 'default' => 16,
263 'double' => 32
266 # Used to set the maximum load that we will still respond to gitweb queries.
267 # If server load exceed this value then return "503 server busy" error.
268 # If gitweb cannot determined server load, it is taken to be 0.
269 # Leave it undefined (or set to 'undef') to turn off load checking.
270 our $maxload = 300;
272 # configuration for 'highlight' (http://www.andre-simon.de/)
273 # match by basename
274 our %highlight_basename = (
275 #'Program' => 'py',
276 #'Library' => 'py',
277 'SConstruct' => 'py', # SCons equivalent of Makefile
278 'Makefile' => 'make',
280 # match by extension
281 our %highlight_ext = (
282 # main extensions, defining name of syntax;
283 # see files in /usr/share/highlight/langDefs/ directory
284 (map { $_ => $_ } qw(py rb java css js tex bib xml awk bat ini spec tcl sql)),
285 # alternate extensions, see /etc/highlight/filetypes.conf
286 (map { $_ => 'c' } qw(c h)),
287 (map { $_ => 'sh' } qw(sh bash zsh ksh)),
288 (map { $_ => 'cpp' } qw(cpp cxx c++ cc)),
289 (map { $_ => 'php' } qw(php php3 php4 php5 phps)),
290 (map { $_ => 'pl' } qw(pl perl pm)), # perhaps also 'cgi'
291 (map { $_ => 'make'} qw(make mak mk)),
292 (map { $_ => 'xml' } qw(xml xhtml html htm)),
295 # You define site-wide feature defaults here; override them with
296 # $GITWEB_CONFIG as necessary.
297 our %feature = (
298 # feature => {
299 # 'sub' => feature-sub (subroutine),
300 # 'override' => allow-override (boolean),
301 # 'default' => [ default options...] (array reference)}
303 # if feature is overridable (it means that allow-override has true value),
304 # then feature-sub will be called with default options as parameters;
305 # return value of feature-sub indicates if to enable specified feature
307 # if there is no 'sub' key (no feature-sub), then feature cannot be
308 # overridden
310 # use gitweb_get_feature(<feature>) to retrieve the <feature> value
311 # (an array) or gitweb_check_feature(<feature>) to check if <feature>
312 # is enabled
314 # Enable the 'blame' blob view, showing the last commit that modified
315 # each line in the file. This can be very CPU-intensive.
317 # To enable system wide have in $GITWEB_CONFIG
318 # $feature{'blame'}{'default'} = [1];
319 # To have project specific config enable override in $GITWEB_CONFIG
320 # $feature{'blame'}{'override'} = 1;
321 # and in project config gitweb.blame = 0|1;
322 'blame' => {
323 'sub' => sub { feature_bool('blame', @_) },
324 'override' => 0,
325 'default' => [0]},
327 # Enable the 'snapshot' link, providing a compressed archive of any
328 # tree. This can potentially generate high traffic if you have large
329 # project.
331 # Value is a list of formats defined in %known_snapshot_formats that
332 # you wish to offer.
333 # To disable system wide have in $GITWEB_CONFIG
334 # $feature{'snapshot'}{'default'} = [];
335 # To have project specific config enable override in $GITWEB_CONFIG
336 # $feature{'snapshot'}{'override'} = 1;
337 # and in project config, a comma-separated list of formats or "none"
338 # to disable. Example: gitweb.snapshot = tbz2,zip;
339 'snapshot' => {
340 'sub' => \&feature_snapshot,
341 'override' => 0,
342 'default' => ['tgz']},
344 # Enable text search, which will list the commits which match author,
345 # committer or commit text to a given string. Enabled by default.
346 # Project specific override is not supported.
348 # Note that this controls all search features, which means that if
349 # it is disabled, then 'grep' and 'pickaxe' search would also be
350 # disabled.
351 'search' => {
352 'override' => 0,
353 'default' => [1]},
355 # Enable grep search, which will list the files in currently selected
356 # tree containing the given string. Enabled by default. This can be
357 # potentially CPU-intensive, of course.
358 # Note that you need to have 'search' feature enabled too.
360 # To enable system wide have in $GITWEB_CONFIG
361 # $feature{'grep'}{'default'} = [1];
362 # To have project specific config enable override in $GITWEB_CONFIG
363 # $feature{'grep'}{'override'} = 1;
364 # and in project config gitweb.grep = 0|1;
365 'grep' => {
366 'sub' => sub { feature_bool('grep', @_) },
367 'override' => 0,
368 'default' => [1]},
370 # Enable the pickaxe search, which will list the commits that modified
371 # a given string in a file. This can be practical and quite faster
372 # alternative to 'blame', but still potentially CPU-intensive.
373 # Note that you need to have 'search' feature enabled too.
375 # To enable system wide have in $GITWEB_CONFIG
376 # $feature{'pickaxe'}{'default'} = [1];
377 # To have project specific config enable override in $GITWEB_CONFIG
378 # $feature{'pickaxe'}{'override'} = 1;
379 # and in project config gitweb.pickaxe = 0|1;
380 'pickaxe' => {
381 'sub' => sub { feature_bool('pickaxe', @_) },
382 'override' => 0,
383 'default' => [1]},
385 # Enable showing size of blobs in a 'tree' view, in a separate
386 # column, similar to what 'ls -l' does. This cost a bit of IO.
388 # To disable system wide have in $GITWEB_CONFIG
389 # $feature{'show-sizes'}{'default'} = [0];
390 # To have project specific config enable override in $GITWEB_CONFIG
391 # $feature{'show-sizes'}{'override'} = 1;
392 # and in project config gitweb.showsizes = 0|1;
393 'show-sizes' => {
394 'sub' => sub { feature_bool('showsizes', @_) },
395 'override' => 0,
396 'default' => [1]},
398 # Make gitweb use an alternative format of the URLs which can be
399 # more readable and natural-looking: project name is embedded
400 # directly in the path and the query string contains other
401 # auxiliary information. All gitweb installations recognize
402 # URL in either format; this configures in which formats gitweb
403 # generates links.
405 # To enable system wide have in $GITWEB_CONFIG
406 # $feature{'pathinfo'}{'default'} = [1];
407 # Project specific override is not supported.
409 # Note that you will need to change the default location of CSS,
410 # favicon, logo and possibly other files to an absolute URL. Also,
411 # if gitweb.cgi serves as your indexfile, you will need to force
412 # $my_uri to contain the script name in your $GITWEB_CONFIG.
413 'pathinfo' => {
414 'override' => 0,
415 'default' => [0]},
417 # Make gitweb consider projects in project root subdirectories
418 # to be forks of existing projects. Given project $projname.git,
419 # projects matching $projname/*.git will not be shown in the main
420 # projects list, instead a '+' mark will be added to $projname
421 # there and a 'forks' view will be enabled for the project, listing
422 # all the forks. If project list is taken from a file, forks have
423 # to be listed after the main project.
425 # To enable system wide have in $GITWEB_CONFIG
426 # $feature{'forks'}{'default'} = [1];
427 # Project specific override is not supported.
428 'forks' => {
429 'override' => 0,
430 'default' => [0]},
432 # Insert custom links to the action bar of all project pages.
433 # This enables you mainly to link to third-party scripts integrating
434 # into gitweb; e.g. git-browser for graphical history representation
435 # or custom web-based repository administration interface.
437 # The 'default' value consists of a list of triplets in the form
438 # (label, link, position) where position is the label after which
439 # to insert the link and link is a format string where %n expands
440 # to the project name, %f to the project path within the filesystem,
441 # %h to the current hash (h gitweb parameter) and %b to the current
442 # hash base (hb gitweb parameter); %% expands to %.
444 # To enable system wide have in $GITWEB_CONFIG e.g.
445 # $feature{'actions'}{'default'} = [('graphiclog',
446 # '/git-browser/by-commit.html?r=%n', 'summary')];
447 # Project specific override is not supported.
448 'actions' => {
449 'override' => 0,
450 'default' => []},
452 # Allow gitweb scan project content tags of project repository,
453 # and display the popular Web 2.0-ish "tag cloud" near the projects
454 # list. Note that this is something COMPLETELY different from the
455 # normal Git tags.
457 # gitweb by itself can show existing tags, but it does not handle
458 # tagging itself; you need to do it externally, outside gitweb.
459 # The format is described in git_get_project_ctags() subroutine.
460 # You may want to install the HTML::TagCloud Perl module to get
461 # a pretty tag cloud instead of just a list of tags.
463 # To enable system wide have in $GITWEB_CONFIG
464 # $feature{'ctags'}{'default'} = [1];
465 # Project specific override is not supported.
467 # In the future whether ctags editing is enabled might depend
468 # on the value, but using 1 should always mean no editing of ctags.
469 'ctags' => {
470 'override' => 0,
471 'default' => [0]},
473 # The maximum number of patches in a patchset generated in patch
474 # view. Set this to 0 or undef to disable patch view, or to a
475 # negative number to remove any limit.
477 # To disable system wide have in $GITWEB_CONFIG
478 # $feature{'patches'}{'default'} = [0];
479 # To have project specific config enable override in $GITWEB_CONFIG
480 # $feature{'patches'}{'override'} = 1;
481 # and in project config gitweb.patches = 0|n;
482 # where n is the maximum number of patches allowed in a patchset.
483 'patches' => {
484 'sub' => \&feature_patches,
485 'override' => 0,
486 'default' => [16]},
488 # Avatar support. When this feature is enabled, views such as
489 # shortlog or commit will display an avatar associated with
490 # the email of the committer(s) and/or author(s).
492 # Currently available providers are gravatar and picon.
493 # If an unknown provider is specified, the feature is disabled.
495 # Picon currently relies on the indiana.edu database.
497 # To enable system wide have in $GITWEB_CONFIG
498 # $feature{'avatar'}{'default'} = ['<provider>'];
499 # where <provider> is either gravatar or picon.
500 # To have project specific config enable override in $GITWEB_CONFIG
501 # $feature{'avatar'}{'override'} = 1;
502 # and in project config gitweb.avatar = <provider>;
503 'avatar' => {
504 'sub' => \&feature_avatar,
505 'override' => 0,
506 'default' => ['']},
508 # Enable displaying how much time and how many git commands
509 # it took to generate and display page. Disabled by default.
510 # Project specific override is not supported.
511 'timed' => {
512 'override' => 0,
513 'default' => [0]},
515 # Enable turning some links into links to actions which require
516 # JavaScript to run (like 'blame_incremental'). Not enabled by
517 # default. Project specific override is currently not supported.
518 'javascript-actions' => {
519 'override' => 0,
520 'default' => [0]},
522 # Enable and configure ability to change common timezone for dates
523 # in gitweb output via JavaScript. Enabled by default.
524 # Project specific override is not supported.
525 'javascript-timezone' => {
526 'override' => 0,
527 'default' => [
528 'local', # default timezone: 'utc', 'local', or '(-|+)HHMM' format,
529 # or undef to turn off this feature
530 'gitweb_tz', # name of cookie where to store selected timezone
531 'datetime', # CSS class used to mark up dates for manipulation
534 # Syntax highlighting support. This is based on Daniel Svensson's
535 # and Sham Chukoury's work in gitweb-xmms2.git.
536 # It requires the 'highlight' program present in $PATH,
537 # and therefore is disabled by default.
539 # To enable system wide have in $GITWEB_CONFIG
540 # $feature{'highlight'}{'default'} = [1];
542 'highlight' => {
543 'sub' => sub { feature_bool('highlight', @_) },
544 'override' => 0,
545 'default' => [0]},
547 # Enable displaying of remote heads in the heads list
549 # To enable system wide have in $GITWEB_CONFIG
550 # $feature{'remote_heads'}{'default'} = [1];
551 # To have project specific config enable override in $GITWEB_CONFIG
552 # $feature{'remote_heads'}{'override'} = 1;
553 # and in project config gitweb.remoteheads = 0|1;
554 'remote_heads' => {
555 'sub' => sub { feature_bool('remote_heads', @_) },
556 'override' => 0,
557 'default' => [0]},
559 # Enable showing branches under other refs in addition to heads
561 # To set system wide extra branch refs have in $GITWEB_CONFIG
562 # $feature{'extra-branch-refs'}{'default'} = ['dirs', 'of', 'choice'];
563 # To have project specific config enable override in $GITWEB_CONFIG
564 # $feature{'extra-branch-refs'}{'override'} = 1;
565 # and in project config gitweb.extrabranchrefs = dirs of choice
566 # Every directory is separated with whitespace.
568 'extra-branch-refs' => {
569 'sub' => \&feature_extra_branch_refs,
570 'override' => 0,
571 'default' => []},
573 # Redact e-mail addresses.
575 # To enable system wide have in $GITWEB_CONFIG
576 # $feature{'email-privacy'}{'default'} = [1];
577 'email-privacy' => {
578 'sub' => sub { feature_bool('email-privacy', @_) },
579 'override' => 1,
580 'default' => [0]},
583 sub gitweb_get_feature {
584 my ($name) = @_;
585 return unless exists $feature{$name};
586 my ($sub, $override, @defaults) = (
587 $feature{$name}{'sub'},
588 $feature{$name}{'override'},
589 @{$feature{$name}{'default'}});
590 # project specific override is possible only if we have project
591 our $git_dir; # global variable, declared later
592 if (!$override || !defined $git_dir) {
593 return @defaults;
595 if (!defined $sub) {
596 warn "feature $name is not overridable";
597 return @defaults;
599 return $sub->(@defaults);
602 # A wrapper to check if a given feature is enabled.
603 # With this, you can say
605 # my $bool_feat = gitweb_check_feature('bool_feat');
606 # gitweb_check_feature('bool_feat') or somecode;
608 # instead of
610 # my ($bool_feat) = gitweb_get_feature('bool_feat');
611 # (gitweb_get_feature('bool_feat'))[0] or somecode;
613 sub gitweb_check_feature {
614 return (gitweb_get_feature(@_))[0];
618 sub feature_bool {
619 my $key = shift;
620 my ($val) = git_get_project_config($key, '--bool');
622 if (!defined $val) {
623 return ($_[0]);
624 } elsif ($val eq 'true') {
625 return (1);
626 } elsif ($val eq 'false') {
627 return (0);
631 sub feature_snapshot {
632 my (@fmts) = @_;
634 my ($val) = git_get_project_config('snapshot');
636 if ($val) {
637 @fmts = ($val eq 'none' ? () : split /\s*[,\s]\s*/, $val);
640 return @fmts;
643 sub feature_patches {
644 my @val = (git_get_project_config('patches', '--int'));
646 if (@val) {
647 return @val;
650 return ($_[0]);
653 sub feature_avatar {
654 my @val = (git_get_project_config('avatar'));
656 return @val ? @val : @_;
659 sub feature_extra_branch_refs {
660 my (@branch_refs) = @_;
661 my $values = git_get_project_config('extrabranchrefs');
663 if ($values) {
664 $values = config_to_multi ($values);
665 @branch_refs = ();
666 foreach my $value (@{$values}) {
667 push @branch_refs, split /\s+/, $value;
671 return @branch_refs;
674 # checking HEAD file with -e is fragile if the repository was
675 # initialized long time ago (i.e. symlink HEAD) and was pack-ref'ed
676 # and then pruned.
677 sub check_head_link {
678 my ($dir) = @_;
679 my $headfile = "$dir/HEAD";
680 return ((-e $headfile) ||
681 (-l $headfile && readlink($headfile) =~ /^refs\/heads\//));
684 sub check_export_ok {
685 my ($dir) = @_;
686 return (check_head_link($dir) &&
687 (!$export_ok || -e "$dir/$export_ok") &&
688 (!$export_auth_hook || $export_auth_hook->($dir)));
691 # process alternate names for backward compatibility
692 # filter out unsupported (unknown) snapshot formats
693 sub filter_snapshot_fmts {
694 my @fmts = @_;
696 @fmts = map {
697 exists $known_snapshot_format_aliases{$_} ?
698 $known_snapshot_format_aliases{$_} : $_} @fmts;
699 @fmts = grep {
700 exists $known_snapshot_formats{$_} &&
701 !$known_snapshot_formats{$_}{'disabled'}} @fmts;
704 sub filter_and_validate_refs {
705 my @refs = @_;
706 my %unique_refs = ();
708 foreach my $ref (@refs) {
709 die_error(500, "Invalid ref '$ref' in 'extra-branch-refs' feature") unless (is_valid_ref_format($ref));
710 # 'heads' are added implicitly in get_branch_refs().
711 $unique_refs{$ref} = 1 if ($ref ne 'heads');
713 return sort keys %unique_refs;
716 # If it is set to code reference, it is code that it is to be run once per
717 # request, allowing updating configurations that change with each request,
718 # while running other code in config file only once.
720 # Otherwise, if it is false then gitweb would process config file only once;
721 # if it is true then gitweb config would be run for each request.
722 our $per_request_config = 1;
724 # read and parse gitweb config file given by its parameter.
725 # returns true on success, false on recoverable error, allowing
726 # to chain this subroutine, using first file that exists.
727 # dies on errors during parsing config file, as it is unrecoverable.
728 sub read_config_file {
729 my $filename = shift;
730 return unless defined $filename;
731 # die if there are errors parsing config file
732 if (-e $filename) {
733 do $filename;
734 die $@ if $@;
735 return 1;
737 return;
740 our ($GITWEB_CONFIG, $GITWEB_CONFIG_SYSTEM, $GITWEB_CONFIG_COMMON);
741 sub evaluate_gitweb_config {
742 our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";
743 our $GITWEB_CONFIG_SYSTEM = $ENV{'GITWEB_CONFIG_SYSTEM'} || "++GITWEB_CONFIG_SYSTEM++";
744 our $GITWEB_CONFIG_COMMON = $ENV{'GITWEB_CONFIG_COMMON'} || "++GITWEB_CONFIG_COMMON++";
746 # Protect against duplications of file names, to not read config twice.
747 # Only one of $GITWEB_CONFIG and $GITWEB_CONFIG_SYSTEM is used, so
748 # there possibility of duplication of filename there doesn't matter.
749 $GITWEB_CONFIG = "" if ($GITWEB_CONFIG eq $GITWEB_CONFIG_COMMON);
750 $GITWEB_CONFIG_SYSTEM = "" if ($GITWEB_CONFIG_SYSTEM eq $GITWEB_CONFIG_COMMON);
752 # Common system-wide settings for convenience.
753 # Those settings can be overridden by GITWEB_CONFIG or GITWEB_CONFIG_SYSTEM.
754 read_config_file($GITWEB_CONFIG_COMMON);
756 # Use first config file that exists. This means use the per-instance
757 # GITWEB_CONFIG if exists, otherwise use GITWEB_SYSTEM_CONFIG.
758 read_config_file($GITWEB_CONFIG) and return;
759 read_config_file($GITWEB_CONFIG_SYSTEM);
762 # Get loadavg of system, to compare against $maxload.
763 # Currently it requires '/proc/loadavg' present to get loadavg;
764 # if it is not present it returns 0, which means no load checking.
765 sub get_loadavg {
766 if( -e '/proc/loadavg' ){
767 open my $fd, '<', '/proc/loadavg'
768 or return 0;
769 my @load = split(/\s+/, scalar <$fd>);
770 close $fd;
772 # The first three columns measure CPU and IO utilization of the last one,
773 # five, and 10 minute periods. The fourth column shows the number of
774 # currently running processes and the total number of processes in the m/n
775 # format. The last column displays the last process ID used.
776 return $load[0] || 0;
778 # additional checks for load average should go here for things that don't export
779 # /proc/loadavg
781 return 0;
784 # version of the core git binary
785 our $git_version;
786 sub evaluate_git_version {
787 our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";
788 $number_of_git_cmds++;
791 sub check_loadavg {
792 if (defined $maxload && get_loadavg() > $maxload) {
793 die_error(503, "The load average on the server is too high");
797 # ======================================================================
798 # input validation and dispatch
800 # Various hash size-related values.
801 my $sha1_len = 40;
802 my $sha256_extra_len = 24;
803 my $sha256_len = $sha1_len + $sha256_extra_len;
805 # A regex matching $len hex characters. $len may be a range (e.g. 7,64).
806 sub oid_nlen_regex {
807 my $len = shift;
808 my $hchr = qr/[0-9a-fA-F]/;
809 return qr/(?:(?:$hchr){$len})/;
812 # A regex matching two sets of $nlen hex characters, prefixed by the literal
813 # string $prefix and with the literal string $infix between them.
814 sub oid_nlen_prefix_infix_regex {
815 my $nlen = shift;
816 my $prefix = shift;
817 my $infix = shift;
819 my $rx = oid_nlen_regex($nlen);
821 return qr/^\Q$prefix\E$rx\Q$infix\E$rx$/;
824 # A regex matching a valid object ID.
825 our $oid_regex;
827 my $x = oid_nlen_regex($sha1_len);
828 my $y = oid_nlen_regex($sha256_extra_len);
829 $oid_regex = qr/(?:$x(?:$y)?)/;
832 # input parameters can be collected from a variety of sources (presently, CGI
833 # and PATH_INFO), so we define an %input_params hash that collects them all
834 # together during validation: this allows subsequent uses (e.g. href()) to be
835 # agnostic of the parameter origin
837 our %input_params = ();
839 # input parameters are stored with the long parameter name as key. This will
840 # also be used in the href subroutine to convert parameters to their CGI
841 # equivalent, and since the href() usage is the most frequent one, we store
842 # the name -> CGI key mapping here, instead of the reverse.
844 # XXX: Warning: If you touch this, check the search form for updating,
845 # too.
847 our @cgi_param_mapping = (
848 project => "p",
849 action => "a",
850 file_name => "f",
851 file_parent => "fp",
852 hash => "h",
853 hash_parent => "hp",
854 hash_base => "hb",
855 hash_parent_base => "hpb",
856 page => "pg",
857 order => "o",
858 searchtext => "s",
859 searchtype => "st",
860 snapshot_format => "sf",
861 extra_options => "opt",
862 search_use_regexp => "sr",
863 ctag => "by_tag",
864 diff_style => "ds",
865 project_filter => "pf",
866 # this must be last entry (for manipulation from JavaScript)
867 javascript => "js"
869 our %cgi_param_mapping = @cgi_param_mapping;
871 # we will also need to know the possible actions, for validation
872 our %actions = (
873 "blame" => \&git_blame,
874 "blame_incremental" => \&git_blame_incremental,
875 "blame_data" => \&git_blame_data,
876 "blobdiff" => \&git_blobdiff,
877 "blobdiff_plain" => \&git_blobdiff_plain,
878 "blob" => \&git_blob,
879 "blob_plain" => \&git_blob_plain,
880 "commitdiff" => \&git_commitdiff,
881 "commitdiff_plain" => \&git_commitdiff_plain,
882 "commit" => \&git_commit,
883 "forks" => \&git_forks,
884 "heads" => \&git_heads,
885 "history" => \&git_history,
886 "log" => \&git_log,
887 "patch" => \&git_patch,
888 "patches" => \&git_patches,
889 "remotes" => \&git_remotes,
890 "rss" => \&git_rss,
891 "atom" => \&git_atom,
892 "search" => \&git_search,
893 "search_help" => \&git_search_help,
894 "shortlog" => \&git_shortlog,
895 "summary" => \&git_summary,
896 "tag" => \&git_tag,
897 "tags" => \&git_tags,
898 "tree" => \&git_tree,
899 "snapshot" => \&git_snapshot,
900 "object" => \&git_object,
901 # those below don't need $project
902 "opml" => \&git_opml,
903 "project_list" => \&git_project_list,
904 "project_index" => \&git_project_index,
907 # finally, we have the hash of allowed extra_options for the commands that
908 # allow them
909 our %allowed_options = (
910 "--no-merges" => [ qw(rss atom log shortlog history) ],
913 # fill %input_params with the CGI parameters. All values except for 'opt'
914 # should be single values, but opt can be an array. We should probably
915 # build an array of parameters that can be multi-valued, but since for the time
916 # being it's only this one, we just single it out
917 sub evaluate_query_params {
918 our $cgi;
920 while (my ($name, $symbol) = each %cgi_param_mapping) {
921 if ($symbol eq 'opt') {
922 $input_params{$name} = [ map { decode_utf8($_) } $cgi->multi_param($symbol) ];
923 } else {
924 $input_params{$name} = decode_utf8($cgi->param($symbol));
929 # now read PATH_INFO and update the parameter list for missing parameters
930 sub evaluate_path_info {
931 return if defined $input_params{'project'};
932 return if !$path_info;
933 $path_info =~ s,^/+,,;
934 return if !$path_info;
936 # find which part of PATH_INFO is project
937 my $project = $path_info;
938 $project =~ s,/+$,,;
939 while ($project && !check_head_link("$projectroot/$project")) {
940 $project =~ s,/*[^/]*$,,;
942 return unless $project;
943 $input_params{'project'} = $project;
945 # do not change any parameters if an action is given using the query string
946 return if $input_params{'action'};
947 $path_info =~ s,^\Q$project\E/*,,;
949 # next, check if we have an action
950 my $action = $path_info;
951 $action =~ s,/.*$,,;
952 if (exists $actions{$action}) {
953 $path_info =~ s,^$action/*,,;
954 $input_params{'action'} = $action;
957 # list of actions that want hash_base instead of hash, but can have no
958 # pathname (f) parameter
959 my @wants_base = (
960 'tree',
961 'history',
964 # we want to catch, among others
965 # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
966 my ($parentrefname, $parentpathname, $refname, $pathname) =
967 ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);
969 # first, analyze the 'current' part
970 if (defined $pathname) {
971 # we got "branch:filename" or "branch:dir/"
972 # we could use git_get_type(branch:pathname), but:
973 # - it needs $git_dir
974 # - it does a git() call
975 # - the convention of terminating directories with a slash
976 # makes it superfluous
977 # - embedding the action in the PATH_INFO would make it even
978 # more superfluous
979 $pathname =~ s,^/+,,;
980 if (!$pathname || substr($pathname, -1) eq "/") {
981 $input_params{'action'} ||= "tree";
982 $pathname =~ s,/$,,;
983 } else {
984 # the default action depends on whether we had parent info
985 # or not
986 if ($parentrefname) {
987 $input_params{'action'} ||= "blobdiff_plain";
988 } else {
989 $input_params{'action'} ||= "blob_plain";
992 $input_params{'hash_base'} ||= $refname;
993 $input_params{'file_name'} ||= $pathname;
994 } elsif (defined $refname) {
995 # we got "branch". In this case we have to choose if we have to
996 # set hash or hash_base.
998 # Most of the actions without a pathname only want hash to be
999 # set, except for the ones specified in @wants_base that want
1000 # hash_base instead. It should also be noted that hand-crafted
1001 # links having 'history' as an action and no pathname or hash
1002 # set will fail, but that happens regardless of PATH_INFO.
1003 if (defined $parentrefname) {
1004 # if there is parent let the default be 'shortlog' action
1005 # (for http://git.example.com/repo.git/A..B links); if there
1006 # is no parent, dispatch will detect type of object and set
1007 # action appropriately if required (if action is not set)
1008 $input_params{'action'} ||= "shortlog";
1010 if ($input_params{'action'} &&
1011 grep { $_ eq $input_params{'action'} } @wants_base) {
1012 $input_params{'hash_base'} ||= $refname;
1013 } else {
1014 $input_params{'hash'} ||= $refname;
1018 # next, handle the 'parent' part, if present
1019 if (defined $parentrefname) {
1020 # a missing pathspec defaults to the 'current' filename, allowing e.g.
1021 # someproject/blobdiff/oldrev..newrev:/filename
1022 if ($parentpathname) {
1023 $parentpathname =~ s,^/+,,;
1024 $parentpathname =~ s,/$,,;
1025 $input_params{'file_parent'} ||= $parentpathname;
1026 } else {
1027 $input_params{'file_parent'} ||= $input_params{'file_name'};
1029 # we assume that hash_parent_base is wanted if a path was specified,
1030 # or if the action wants hash_base instead of hash
1031 if (defined $input_params{'file_parent'} ||
1032 grep { $_ eq $input_params{'action'} } @wants_base) {
1033 $input_params{'hash_parent_base'} ||= $parentrefname;
1034 } else {
1035 $input_params{'hash_parent'} ||= $parentrefname;
1039 # for the snapshot action, we allow URLs in the form
1040 # $project/snapshot/$hash.ext
1041 # where .ext determines the snapshot and gets removed from the
1042 # passed $refname to provide the $hash.
1044 # To be able to tell that $refname includes the format extension, we
1045 # require the following two conditions to be satisfied:
1046 # - the hash input parameter MUST have been set from the $refname part
1047 # of the URL (i.e. they must be equal)
1048 # - the snapshot format MUST NOT have been defined already (e.g. from
1049 # CGI parameter sf)
1050 # It's also useless to try any matching unless $refname has a dot,
1051 # so we check for that too
1052 if (defined $input_params{'action'} &&
1053 $input_params{'action'} eq 'snapshot' &&
1054 defined $refname && index($refname, '.') != -1 &&
1055 $refname eq $input_params{'hash'} &&
1056 !defined $input_params{'snapshot_format'}) {
1057 # We loop over the known snapshot formats, checking for
1058 # extensions. Allowed extensions are both the defined suffix
1059 # (which includes the initial dot already) and the snapshot
1060 # format key itself, with a prepended dot
1061 while (my ($fmt, $opt) = each %known_snapshot_formats) {
1062 my $hash = $refname;
1063 unless ($hash =~ s/(\Q$opt->{'suffix'}\E|\Q.$fmt\E)$//) {
1064 next;
1066 my $sfx = $1;
1067 # a valid suffix was found, so set the snapshot format
1068 # and reset the hash parameter
1069 $input_params{'snapshot_format'} = $fmt;
1070 $input_params{'hash'} = $hash;
1071 # we also set the format suffix to the one requested
1072 # in the URL: this way a request for e.g. .tgz returns
1073 # a .tgz instead of a .tar.gz
1074 $known_snapshot_formats{$fmt}{'suffix'} = $sfx;
1075 last;
1080 our ($action, $project, $file_name, $file_parent, $hash, $hash_parent, $hash_base,
1081 $hash_parent_base, @extra_options, $page, $searchtype, $search_use_regexp,
1082 $searchtext, $search_regexp, $project_filter);
1083 sub evaluate_and_validate_params {
1084 our $action = $input_params{'action'};
1085 if (defined $action) {
1086 if (!is_valid_action($action)) {
1087 die_error(400, "Invalid action parameter");
1091 # parameters which are pathnames
1092 our $project = $input_params{'project'};
1093 if (defined $project) {
1094 if (!is_valid_project($project)) {
1095 undef $project;
1096 die_error(404, "No such project");
1100 our $project_filter = $input_params{'project_filter'};
1101 if (defined $project_filter) {
1102 if (!is_valid_pathname($project_filter)) {
1103 die_error(404, "Invalid project_filter parameter");
1107 our $file_name = $input_params{'file_name'};
1108 if (defined $file_name) {
1109 if (!is_valid_pathname($file_name)) {
1110 die_error(400, "Invalid file parameter");
1114 our $file_parent = $input_params{'file_parent'};
1115 if (defined $file_parent) {
1116 if (!is_valid_pathname($file_parent)) {
1117 die_error(400, "Invalid file parent parameter");
1121 # parameters which are refnames
1122 our $hash = $input_params{'hash'};
1123 if (defined $hash) {
1124 if (!is_valid_refname($hash)) {
1125 die_error(400, "Invalid hash parameter");
1129 our $hash_parent = $input_params{'hash_parent'};
1130 if (defined $hash_parent) {
1131 if (!is_valid_refname($hash_parent)) {
1132 die_error(400, "Invalid hash parent parameter");
1136 our $hash_base = $input_params{'hash_base'};
1137 if (defined $hash_base) {
1138 if (!is_valid_refname($hash_base)) {
1139 die_error(400, "Invalid hash base parameter");
1143 our @extra_options = @{$input_params{'extra_options'}};
1144 # @extra_options is always defined, since it can only be (currently) set from
1145 # CGI, and $cgi->param() returns the empty array in array context if the param
1146 # is not set
1147 foreach my $opt (@extra_options) {
1148 if (not exists $allowed_options{$opt}) {
1149 die_error(400, "Invalid option parameter");
1151 if (not grep(/^$action$/, @{$allowed_options{$opt}})) {
1152 die_error(400, "Invalid option parameter for this action");
1156 our $hash_parent_base = $input_params{'hash_parent_base'};
1157 if (defined $hash_parent_base) {
1158 if (!is_valid_refname($hash_parent_base)) {
1159 die_error(400, "Invalid hash parent base parameter");
1163 # other parameters
1164 our $page = $input_params{'page'};
1165 if (defined $page) {
1166 if ($page =~ m/[^0-9]/) {
1167 die_error(400, "Invalid page parameter");
1171 our $searchtype = $input_params{'searchtype'};
1172 if (defined $searchtype) {
1173 if ($searchtype =~ m/[^a-z]/) {
1174 die_error(400, "Invalid searchtype parameter");
1178 our $search_use_regexp = $input_params{'search_use_regexp'};
1180 our $searchtext = $input_params{'searchtext'};
1181 our $search_regexp = undef;
1182 if (defined $searchtext) {
1183 if (length($searchtext) < 2) {
1184 die_error(403, "At least two characters are required for search parameter");
1186 if ($search_use_regexp) {
1187 $search_regexp = $searchtext;
1188 if (!eval { qr/$search_regexp/; 1; }) {
1189 (my $error = $@) =~ s/ at \S+ line \d+.*\n?//;
1190 die_error(400, "Invalid search regexp '$search_regexp'",
1191 esc_html($error));
1193 } else {
1194 $search_regexp = quotemeta $searchtext;
1199 # path to the current git repository
1200 our $git_dir;
1201 sub evaluate_git_dir {
1202 our $git_dir = "$projectroot/$project" if $project;
1205 our (@snapshot_fmts, $git_avatar, @extra_branch_refs);
1206 sub configure_gitweb_features {
1207 # list of supported snapshot formats
1208 our @snapshot_fmts = gitweb_get_feature('snapshot');
1209 @snapshot_fmts = filter_snapshot_fmts(@snapshot_fmts);
1211 our ($git_avatar) = gitweb_get_feature('avatar');
1212 $git_avatar = '' unless $git_avatar =~ /^(?:gravatar|picon)$/s;
1214 our @extra_branch_refs = gitweb_get_feature('extra-branch-refs');
1215 @extra_branch_refs = filter_and_validate_refs (@extra_branch_refs);
1218 sub get_branch_refs {
1219 return ('heads', @extra_branch_refs);
1222 # custom error handler: 'die <message>' is Internal Server Error
1223 sub handle_errors_html {
1224 my $msg = shift; # it is already HTML escaped
1226 # to avoid infinite loop where error occurs in die_error,
1227 # change handler to default handler, disabling handle_errors_html
1228 set_message("Error occurred when inside die_error:\n$msg");
1230 # you cannot jump out of die_error when called as error handler;
1231 # the subroutine set via CGI::Carp::set_message is called _after_
1232 # HTTP headers are already written, so it cannot write them itself
1233 die_error(undef, undef, $msg, -error_handler => 1, -no_http_header => 1);
1235 set_message(\&handle_errors_html);
1237 # dispatch
1238 sub dispatch {
1239 if (!defined $action) {
1240 if (defined $hash) {
1241 $action = git_get_type($hash);
1242 $action or die_error(404, "Object does not exist");
1243 } elsif (defined $hash_base && defined $file_name) {
1244 $action = git_get_type("$hash_base:$file_name");
1245 $action or die_error(404, "File or directory does not exist");
1246 } elsif (defined $project) {
1247 $action = 'summary';
1248 } else {
1249 $action = 'project_list';
1252 if (!defined($actions{$action})) {
1253 die_error(400, "Unknown action");
1255 if ($action !~ m/^(?:opml|project_list|project_index)$/ &&
1256 !$project) {
1257 die_error(400, "Project needed");
1259 $actions{$action}->();
1262 sub reset_timer {
1263 our $t0 = [ gettimeofday() ]
1264 if defined $t0;
1265 our $number_of_git_cmds = 0;
1268 our $first_request = 1;
1269 sub run_request {
1270 reset_timer();
1272 evaluate_uri();
1273 if ($first_request) {
1274 evaluate_gitweb_config();
1275 evaluate_git_version();
1277 if ($per_request_config) {
1278 if (ref($per_request_config) eq 'CODE') {
1279 $per_request_config->();
1280 } elsif (!$first_request) {
1281 evaluate_gitweb_config();
1284 check_loadavg();
1286 # $projectroot and $projects_list might be set in gitweb config file
1287 $projects_list ||= $projectroot;
1289 evaluate_query_params();
1290 evaluate_path_info();
1291 evaluate_and_validate_params();
1292 evaluate_git_dir();
1294 configure_gitweb_features();
1296 dispatch();
1299 our $is_last_request = sub { 1 };
1300 our ($pre_dispatch_hook, $post_dispatch_hook, $pre_listen_hook);
1301 our $CGI = 'CGI';
1302 our $cgi;
1303 our $FCGI_Stream_PRINT_raw = \&FCGI::Stream::PRINT;
1304 sub configure_as_fcgi {
1305 require CGI::Fast;
1306 our $CGI = 'CGI::Fast';
1307 # FCGI is not Unicode aware hence the UTF-8 encoding must be done manually.
1308 # However no encoding must be done within git_blob_plain() and git_snapshot()
1309 # which must still output in raw binary mode.
1310 no warnings 'redefine';
1311 my $enc = Encode::find_encoding('UTF-8');
1312 *FCGI::Stream::PRINT = sub {
1313 my @OUTPUT = @_;
1314 for (my $i = 1; $i < @_; $i++) {
1315 $OUTPUT[$i] = $enc->encode($_[$i], Encode::FB_CROAK|Encode::LEAVE_SRC);
1317 @_ = @OUTPUT;
1318 goto $FCGI_Stream_PRINT_raw;
1321 my $request_number = 0;
1322 # let each child service 100 requests
1323 our $is_last_request = sub { ++$request_number > 100 };
1325 sub evaluate_argv {
1326 my $script_name = $ENV{'SCRIPT_NAME'} || $ENV{'SCRIPT_FILENAME'} || __FILE__;
1327 configure_as_fcgi()
1328 if $script_name =~ /\.fcgi$/;
1330 return unless (@ARGV);
1332 require Getopt::Long;
1333 Getopt::Long::GetOptions(
1334 'fastcgi|fcgi|f' => \&configure_as_fcgi,
1335 'nproc|n=i' => sub {
1336 my ($arg, $val) = @_;
1337 return unless eval { require FCGI::ProcManager; 1; };
1338 my $proc_manager = FCGI::ProcManager->new({
1339 n_processes => $val,
1341 our $pre_listen_hook = sub { $proc_manager->pm_manage() };
1342 our $pre_dispatch_hook = sub { $proc_manager->pm_pre_dispatch() };
1343 our $post_dispatch_hook = sub { $proc_manager->pm_post_dispatch() };
1348 sub run {
1349 evaluate_argv();
1351 $first_request = 1;
1352 $pre_listen_hook->()
1353 if $pre_listen_hook;
1355 REQUEST:
1356 while ($cgi = $CGI->new()) {
1357 $pre_dispatch_hook->()
1358 if $pre_dispatch_hook;
1360 run_request();
1362 $post_dispatch_hook->()
1363 if $post_dispatch_hook;
1364 $first_request = 0;
1366 last REQUEST if ($is_last_request->());
1369 DONE_GITWEB:
1373 run();
1375 if (defined caller) {
1376 # wrapped in a subroutine processing requests,
1377 # e.g. mod_perl with ModPerl::Registry, or PSGI with Plack::App::WrapCGI
1378 return;
1379 } else {
1380 # pure CGI script, serving single request
1381 exit;
1384 ## ======================================================================
1385 ## action links
1387 # possible values of extra options
1388 # -full => 0|1 - use absolute/full URL ($my_uri/$my_url as base)
1389 # -replay => 1 - start from a current view (replay with modifications)
1390 # -path_info => 0|1 - don't use/use path_info URL (if possible)
1391 # -anchor => ANCHOR - add #ANCHOR to end of URL, implies -replay if used alone
1392 sub href {
1393 my %params = @_;
1394 # default is to use -absolute url() i.e. $my_uri
1395 my $href = $params{-full} ? $my_url : $my_uri;
1397 # implicit -replay, must be first of implicit params
1398 $params{-replay} = 1 if (keys %params == 1 && $params{-anchor});
1400 $params{'project'} = $project unless exists $params{'project'};
1402 if ($params{-replay}) {
1403 while (my ($name, $symbol) = each %cgi_param_mapping) {
1404 if (!exists $params{$name}) {
1405 $params{$name} = $input_params{$name};
1410 my $use_pathinfo = gitweb_check_feature('pathinfo');
1411 if (defined $params{'project'} &&
1412 (exists $params{-path_info} ? $params{-path_info} : $use_pathinfo)) {
1413 # try to put as many parameters as possible in PATH_INFO:
1414 # - project name
1415 # - action
1416 # - hash_parent or hash_parent_base:/file_parent
1417 # - hash or hash_base:/filename
1418 # - the snapshot_format as an appropriate suffix
1420 # When the script is the root DirectoryIndex for the domain,
1421 # $href here would be something like http://gitweb.example.com/
1422 # Thus, we strip any trailing / from $href, to spare us double
1423 # slashes in the final URL
1424 $href =~ s,/$,,;
1426 # Then add the project name, if present
1427 $href .= "/".esc_path_info($params{'project'});
1428 delete $params{'project'};
1430 # since we destructively absorb parameters, we keep this
1431 # boolean that remembers if we're handling a snapshot
1432 my $is_snapshot = $params{'action'} eq 'snapshot';
1434 # Summary just uses the project path URL, any other action is
1435 # added to the URL
1436 if (defined $params{'action'}) {
1437 $href .= "/".esc_path_info($params{'action'})
1438 unless $params{'action'} eq 'summary';
1439 delete $params{'action'};
1442 # Next, we put hash_parent_base:/file_parent..hash_base:/file_name,
1443 # stripping nonexistent or useless pieces
1444 $href .= "/" if ($params{'hash_base'} || $params{'hash_parent_base'}
1445 || $params{'hash_parent'} || $params{'hash'});
1446 if (defined $params{'hash_base'}) {
1447 if (defined $params{'hash_parent_base'}) {
1448 $href .= esc_path_info($params{'hash_parent_base'});
1449 # skip the file_parent if it's the same as the file_name
1450 if (defined $params{'file_parent'}) {
1451 if (defined $params{'file_name'} && $params{'file_parent'} eq $params{'file_name'}) {
1452 delete $params{'file_parent'};
1453 } elsif ($params{'file_parent'} !~ /\.\./) {
1454 $href .= ":/".esc_path_info($params{'file_parent'});
1455 delete $params{'file_parent'};
1458 $href .= "..";
1459 delete $params{'hash_parent'};
1460 delete $params{'hash_parent_base'};
1461 } elsif (defined $params{'hash_parent'}) {
1462 $href .= esc_path_info($params{'hash_parent'}). "..";
1463 delete $params{'hash_parent'};
1466 $href .= esc_path_info($params{'hash_base'});
1467 if (defined $params{'file_name'} && $params{'file_name'} !~ /\.\./) {
1468 $href .= ":/".esc_path_info($params{'file_name'});
1469 delete $params{'file_name'};
1471 delete $params{'hash'};
1472 delete $params{'hash_base'};
1473 } elsif (defined $params{'hash'}) {
1474 $href .= esc_path_info($params{'hash'});
1475 delete $params{'hash'};
1478 # If the action was a snapshot, we can absorb the
1479 # snapshot_format parameter too
1480 if ($is_snapshot) {
1481 my $fmt = $params{'snapshot_format'};
1482 # snapshot_format should always be defined when href()
1483 # is called, but just in case some code forgets, we
1484 # fall back to the default
1485 $fmt ||= $snapshot_fmts[0];
1486 $href .= $known_snapshot_formats{$fmt}{'suffix'};
1487 delete $params{'snapshot_format'};
1491 # now encode the parameters explicitly
1492 my @result = ();
1493 for (my $i = 0; $i < @cgi_param_mapping; $i += 2) {
1494 my ($name, $symbol) = ($cgi_param_mapping[$i], $cgi_param_mapping[$i+1]);
1495 if (defined $params{$name}) {
1496 if (ref($params{$name}) eq "ARRAY") {
1497 foreach my $par (@{$params{$name}}) {
1498 push @result, $symbol . "=" . esc_param($par);
1500 } else {
1501 push @result, $symbol . "=" . esc_param($params{$name});
1505 $href .= "?" . join(';', @result) if scalar @result;
1507 # final transformation: trailing spaces must be escaped (URI-encoded)
1508 $href =~ s/(\s+)$/CGI::escape($1)/e;
1510 if ($params{-anchor}) {
1511 $href .= "#".esc_param($params{-anchor});
1514 return $href;
1518 ## ======================================================================
1519 ## validation, quoting/unquoting and escaping
1521 sub is_valid_action {
1522 my $input = shift;
1523 return undef unless exists $actions{$input};
1524 return 1;
1527 sub is_valid_project {
1528 my $input = shift;
1530 return unless defined $input;
1531 if (!is_valid_pathname($input) ||
1532 !(-d "$projectroot/$input") ||
1533 !check_export_ok("$projectroot/$input") ||
1534 ($strict_export && !project_in_list($input))) {
1535 return undef;
1536 } else {
1537 return 1;
1541 sub is_valid_pathname {
1542 my $input = shift;
1544 return undef unless defined $input;
1545 # no '.' or '..' as elements of path, i.e. no '.' or '..'
1546 # at the beginning, at the end, and between slashes.
1547 # also this catches doubled slashes
1548 if ($input =~ m!(^|/)(|\.|\.\.)(/|$)!) {
1549 return undef;
1551 # no null characters
1552 if ($input =~ m!\0!) {
1553 return undef;
1555 return 1;
1558 sub is_valid_ref_format {
1559 my $input = shift;
1561 return undef unless defined $input;
1562 # restrictions on ref name according to git-check-ref-format
1563 if ($input =~ m!(/\.|\.\.|[\000-\040\177 ~^:?*\[]|/$)!) {
1564 return undef;
1566 return 1;
1569 sub is_valid_refname {
1570 my $input = shift;
1572 return undef unless defined $input;
1573 # textual hashes are O.K.
1574 if ($input =~ m/^$oid_regex$/) {
1575 return 1;
1577 # it must be correct pathname
1578 is_valid_pathname($input) or return undef;
1579 # check git-check-ref-format restrictions
1580 is_valid_ref_format($input) or return undef;
1581 return 1;
1584 # decode sequences of octets in utf8 into Perl's internal form,
1585 # which is utf-8 with utf8 flag set if needed. gitweb writes out
1586 # in utf-8 thanks to "binmode STDOUT, ':utf8'" at beginning
1587 sub to_utf8 {
1588 my $str = shift;
1589 return undef unless defined $str;
1591 if (utf8::is_utf8($str) || utf8::decode($str)) {
1592 return $str;
1593 } else {
1594 return decode($fallback_encoding, $str, Encode::FB_DEFAULT);
1598 # quote unsafe chars, but keep the slash, even when it's not
1599 # correct, but quoted slashes look too horrible in bookmarks
1600 sub esc_param {
1601 my $str = shift;
1602 return undef unless defined $str;
1603 $str =~ s/([^A-Za-z0-9\-_.~()\/:@ ]+)/CGI::escape($1)/eg;
1604 $str =~ s/ /\+/g;
1605 return $str;
1608 # the quoting rules for path_info fragment are slightly different
1609 sub esc_path_info {
1610 my $str = shift;
1611 return undef unless defined $str;
1613 # path_info doesn't treat '+' as space (specially), but '?' must be escaped
1614 $str =~ s/([^A-Za-z0-9\-_.~();\/;:@&= +]+)/CGI::escape($1)/eg;
1616 return $str;
1619 # quote unsafe chars in whole URL, so some characters cannot be quoted
1620 sub esc_url {
1621 my $str = shift;
1622 return undef unless defined $str;
1623 $str =~ s/([^A-Za-z0-9\-_.~();\/;?:@&= ]+)/CGI::escape($1)/eg;
1624 $str =~ s/ /\+/g;
1625 return $str;
1628 # quote unsafe characters in HTML attributes
1629 sub esc_attr {
1631 # for XHTML conformance escaping '"' to '&quot;' is not enough
1632 return esc_html(@_);
1635 # replace invalid utf8 character with SUBSTITUTION sequence
1636 sub esc_html {
1637 my $str = shift;
1638 my %opts = @_;
1640 return undef unless defined $str;
1642 $str = to_utf8($str);
1643 $str = $cgi->escapeHTML($str);
1644 if ($opts{'-nbsp'}) {
1645 $str =~ s/ /&nbsp;/g;
1647 $str =~ s|([[:cntrl:]])|(($1 ne "\t") ? quot_cec($1) : $1)|eg;
1648 return $str;
1651 # quote control characters and escape filename to HTML
1652 sub esc_path {
1653 my $str = shift;
1654 my %opts = @_;
1656 return undef unless defined $str;
1658 $str = to_utf8($str);
1659 $str = $cgi->escapeHTML($str);
1660 if ($opts{'-nbsp'}) {
1661 $str =~ s/ /&nbsp;/g;
1663 $str =~ s|([[:cntrl:]])|quot_cec($1)|eg;
1664 return $str;
1667 # Sanitize for use in XHTML + application/xml+xhtml (valid XML 1.0)
1668 sub sanitize {
1669 my $str = shift;
1671 return undef unless defined $str;
1673 $str = to_utf8($str);
1674 $str =~ s|([[:cntrl:]])|(index("\t\n\r", $1) != -1 ? $1 : quot_cec($1))|eg;
1675 return $str;
1678 # Make control characters "printable", using character escape codes (CEC)
1679 sub quot_cec {
1680 my $cntrl = shift;
1681 my %opts = @_;
1682 my %es = ( # character escape codes, aka escape sequences
1683 "\t" => '\t', # tab (HT)
1684 "\n" => '\n', # line feed (LF)
1685 "\r" => '\r', # carriage return (CR)
1686 "\f" => '\f', # form feed (FF)
1687 "\b" => '\b', # backspace (BS)
1688 "\a" => '\a', # alarm (bell) (BEL)
1689 "\e" => '\e', # escape (ESC)
1690 "\013" => '\v', # vertical tab (VT)
1691 "\000" => '\0', # nul character (NUL)
1693 my $chr = ( (exists $es{$cntrl})
1694 ? $es{$cntrl}
1695 : sprintf('\%2x', ord($cntrl)) );
1696 if ($opts{-nohtml}) {
1697 return $chr;
1698 } else {
1699 return "<span class=\"cntrl\">$chr</span>";
1703 # Alternatively use unicode control pictures codepoints,
1704 # Unicode "printable representation" (PR)
1705 sub quot_upr {
1706 my $cntrl = shift;
1707 my %opts = @_;
1709 my $chr = sprintf('&#%04d;', 0x2400+ord($cntrl));
1710 if ($opts{-nohtml}) {
1711 return $chr;
1712 } else {
1713 return "<span class=\"cntrl\">$chr</span>";
1717 # git may return quoted and escaped filenames
1718 sub unquote {
1719 my $str = shift;
1721 sub unq {
1722 my $seq = shift;
1723 my %es = ( # character escape codes, aka escape sequences
1724 't' => "\t", # tab (HT, TAB)
1725 'n' => "\n", # newline (NL)
1726 'r' => "\r", # return (CR)
1727 'f' => "\f", # form feed (FF)
1728 'b' => "\b", # backspace (BS)
1729 'a' => "\a", # alarm (bell) (BEL)
1730 'e' => "\e", # escape (ESC)
1731 'v' => "\013", # vertical tab (VT)
1734 if ($seq =~ m/^[0-7]{1,3}$/) {
1735 # octal char sequence
1736 return chr(oct($seq));
1737 } elsif (exists $es{$seq}) {
1738 # C escape sequence, aka character escape code
1739 return $es{$seq};
1741 # quoted ordinary character
1742 return $seq;
1745 if ($str =~ m/^"(.*)"$/) {
1746 # needs unquoting
1747 $str = $1;
1748 $str =~ s/\\([^0-7]|[0-7]{1,3})/unq($1)/eg;
1750 return $str;
1753 # escape tabs (convert tabs to spaces)
1754 sub untabify {
1755 my $line = shift;
1757 while ((my $pos = index($line, "\t")) != -1) {
1758 if (my $count = (8 - ($pos % 8))) {
1759 my $spaces = ' ' x $count;
1760 $line =~ s/\t/$spaces/;
1764 return $line;
1767 sub project_in_list {
1768 my $project = shift;
1769 my @list = git_get_projects_list();
1770 return @list && scalar(grep { $_->{'path'} eq $project } @list);
1773 ## ----------------------------------------------------------------------
1774 ## HTML aware string manipulation
1776 # Try to chop given string on a word boundary between position
1777 # $len and $len+$add_len. If there is no word boundary there,
1778 # chop at $len+$add_len. Do not chop if chopped part plus ellipsis
1779 # (marking chopped part) would be longer than given string.
1780 sub chop_str {
1781 my $str = shift;
1782 my $len = shift;
1783 my $add_len = shift || 10;
1784 my $where = shift || 'right'; # 'left' | 'center' | 'right'
1786 # Make sure perl knows it is utf8 encoded so we don't
1787 # cut in the middle of a utf8 multibyte char.
1788 $str = to_utf8($str);
1790 # allow only $len chars, but don't cut a word if it would fit in $add_len
1791 # if it doesn't fit, cut it if it's still longer than the dots we would add
1792 # remove chopped character entities entirely
1794 # when chopping in the middle, distribute $len into left and right part
1795 # return early if chopping wouldn't make string shorter
1796 if ($where eq 'center') {
1797 return $str if ($len + 5 >= length($str)); # filler is length 5
1798 $len = int($len/2);
1799 } else {
1800 return $str if ($len + 4 >= length($str)); # filler is length 4
1803 # regexps: ending and beginning with word part up to $add_len
1804 my $endre = qr/.{$len}\w{0,$add_len}/;
1805 my $begre = qr/\w{0,$add_len}.{$len}/;
1807 if ($where eq 'left') {
1808 $str =~ m/^(.*?)($begre)$/;
1809 my ($lead, $body) = ($1, $2);
1810 if (length($lead) > 4) {
1811 $lead = " ...";
1813 return "$lead$body";
1815 } elsif ($where eq 'center') {
1816 $str =~ m/^($endre)(.*)$/;
1817 my ($left, $str) = ($1, $2);
1818 $str =~ m/^(.*?)($begre)$/;
1819 my ($mid, $right) = ($1, $2);
1820 if (length($mid) > 5) {
1821 $mid = " ... ";
1823 return "$left$mid$right";
1825 } else {
1826 $str =~ m/^($endre)(.*)$/;
1827 my $body = $1;
1828 my $tail = $2;
1829 if (length($tail) > 4) {
1830 $tail = "... ";
1832 return "$body$tail";
1836 # takes the same arguments as chop_str, but also wraps a <span> around the
1837 # result with a title attribute if it does get chopped. Additionally, the
1838 # string is HTML-escaped.
1839 sub chop_and_escape_str {
1840 my ($str) = @_;
1842 my $chopped = chop_str(@_);
1843 $str = to_utf8($str);
1844 if ($chopped eq $str) {
1845 return esc_html($chopped);
1846 } else {
1847 $str =~ s/[[:cntrl:]]/?/g;
1848 return $cgi->span({-title=>$str}, esc_html($chopped));
1852 # Highlight selected fragments of string, using given CSS class,
1853 # and escape HTML. It is assumed that fragments do not overlap.
1854 # Regions are passed as list of pairs (array references).
1856 # Example: esc_html_hl_regions("foobar", "mark", [ 0, 3 ]) returns
1857 # '<span class="mark">foo</span>bar'
1858 sub esc_html_hl_regions {
1859 my ($str, $css_class, @sel) = @_;
1860 my %opts = grep { ref($_) ne 'ARRAY' } @sel;
1861 @sel = grep { ref($_) eq 'ARRAY' } @sel;
1862 return esc_html($str, %opts) unless @sel;
1864 my $out = '';
1865 my $pos = 0;
1867 for my $s (@sel) {
1868 my ($begin, $end) = @$s;
1870 # Don't create empty <span> elements.
1871 next if $end <= $begin;
1873 my $escaped = esc_html(substr($str, $begin, $end - $begin),
1874 %opts);
1876 $out .= esc_html(substr($str, $pos, $begin - $pos), %opts)
1877 if ($begin - $pos > 0);
1878 $out .= $cgi->span({-class => $css_class}, $escaped);
1880 $pos = $end;
1882 $out .= esc_html(substr($str, $pos), %opts)
1883 if ($pos < length($str));
1885 return $out;
1888 # return positions of beginning and end of each match
1889 sub matchpos_list {
1890 my ($str, $regexp) = @_;
1891 return unless (defined $str && defined $regexp);
1893 my @matches;
1894 while ($str =~ /$regexp/g) {
1895 push @matches, [$-[0], $+[0]];
1897 return @matches;
1900 # highlight match (if any), and escape HTML
1901 sub esc_html_match_hl {
1902 my ($str, $regexp) = @_;
1903 return esc_html($str) unless defined $regexp;
1905 my @matches = matchpos_list($str, $regexp);
1906 return esc_html($str) unless @matches;
1908 return esc_html_hl_regions($str, 'match', @matches);
1912 # highlight match (if any) of shortened string, and escape HTML
1913 sub esc_html_match_hl_chopped {
1914 my ($str, $chopped, $regexp) = @_;
1915 return esc_html_match_hl($str, $regexp) unless defined $chopped;
1917 my @matches = matchpos_list($str, $regexp);
1918 return esc_html($chopped) unless @matches;
1920 # filter matches so that we mark chopped string
1921 my $tail = "... "; # see chop_str
1922 unless ($chopped =~ s/\Q$tail\E$//) {
1923 $tail = '';
1925 my $chop_len = length($chopped);
1926 my $tail_len = length($tail);
1927 my @filtered;
1929 for my $m (@matches) {
1930 if ($m->[0] > $chop_len) {
1931 push @filtered, [ $chop_len, $chop_len + $tail_len ] if ($tail_len > 0);
1932 last;
1933 } elsif ($m->[1] > $chop_len) {
1934 push @filtered, [ $m->[0], $chop_len + $tail_len ];
1935 last;
1937 push @filtered, $m;
1940 return esc_html_hl_regions($chopped . $tail, 'match', @filtered);
1943 ## ----------------------------------------------------------------------
1944 ## functions returning short strings
1946 # CSS class for given age value (in seconds)
1947 sub age_class {
1948 my $age = shift;
1950 if (!defined $age) {
1951 return "noage";
1952 } elsif ($age < 60*60*2) {
1953 return "age0";
1954 } elsif ($age < 60*60*24*2) {
1955 return "age1";
1956 } else {
1957 return "age2";
1961 # convert age in seconds to "nn units ago" string
1962 sub age_string {
1963 my $age = shift;
1964 my $age_str;
1966 if ($age > 60*60*24*365*2) {
1967 $age_str = (int $age/60/60/24/365);
1968 $age_str .= " years ago";
1969 } elsif ($age > 60*60*24*(365/12)*2) {
1970 $age_str = int $age/60/60/24/(365/12);
1971 $age_str .= " months ago";
1972 } elsif ($age > 60*60*24*7*2) {
1973 $age_str = int $age/60/60/24/7;
1974 $age_str .= " weeks ago";
1975 } elsif ($age > 60*60*24*2) {
1976 $age_str = int $age/60/60/24;
1977 $age_str .= " days ago";
1978 } elsif ($age > 60*60*2) {
1979 $age_str = int $age/60/60;
1980 $age_str .= " hours ago";
1981 } elsif ($age > 60*2) {
1982 $age_str = int $age/60;
1983 $age_str .= " min ago";
1984 } elsif ($age > 2) {
1985 $age_str = int $age;
1986 $age_str .= " sec ago";
1987 } else {
1988 $age_str .= " right now";
1990 return $age_str;
1993 use constant {
1994 S_IFINVALID => 0030000,
1995 S_IFGITLINK => 0160000,
1998 # submodule/subproject, a commit object reference
1999 sub S_ISGITLINK {
2000 my $mode = shift;
2002 return (($mode & S_IFMT) == S_IFGITLINK)
2005 # convert file mode in octal to symbolic file mode string
2006 sub mode_str {
2007 my $mode = oct shift;
2009 if (S_ISGITLINK($mode)) {
2010 return 'm---------';
2011 } elsif (S_ISDIR($mode & S_IFMT)) {
2012 return 'drwxr-xr-x';
2013 } elsif (S_ISLNK($mode)) {
2014 return 'lrwxrwxrwx';
2015 } elsif (S_ISREG($mode)) {
2016 # git cares only about the executable bit
2017 if ($mode & S_IXUSR) {
2018 return '-rwxr-xr-x';
2019 } else {
2020 return '-rw-r--r--';
2022 } else {
2023 return '----------';
2027 # convert file mode in octal to file type string
2028 sub file_type {
2029 my $mode = shift;
2031 if ($mode !~ m/^[0-7]+$/) {
2032 return $mode;
2033 } else {
2034 $mode = oct $mode;
2037 if (S_ISGITLINK($mode)) {
2038 return "submodule";
2039 } elsif (S_ISDIR($mode & S_IFMT)) {
2040 return "directory";
2041 } elsif (S_ISLNK($mode)) {
2042 return "symlink";
2043 } elsif (S_ISREG($mode)) {
2044 return "file";
2045 } else {
2046 return "unknown";
2050 # convert file mode in octal to file type description string
2051 sub file_type_long {
2052 my $mode = shift;
2054 if ($mode !~ m/^[0-7]+$/) {
2055 return $mode;
2056 } else {
2057 $mode = oct $mode;
2060 if (S_ISGITLINK($mode)) {
2061 return "submodule";
2062 } elsif (S_ISDIR($mode & S_IFMT)) {
2063 return "directory";
2064 } elsif (S_ISLNK($mode)) {
2065 return "symlink";
2066 } elsif (S_ISREG($mode)) {
2067 if ($mode & S_IXUSR) {
2068 return "executable";
2069 } else {
2070 return "file";
2072 } else {
2073 return "unknown";
2078 ## ----------------------------------------------------------------------
2079 ## functions returning short HTML fragments, or transforming HTML fragments
2080 ## which don't belong to other sections
2082 # format line of commit message.
2083 sub format_log_line_html {
2084 my $line = shift;
2086 # Potentially abbreviated OID.
2087 my $regex = oid_nlen_regex("7,64");
2089 $line = esc_html($line, -nbsp=>1);
2090 $line =~ s{
2093 # The output of "git describe", e.g. v2.10.0-297-gf6727b0
2094 # or hadoop-20160921-113441-20-g094fb7d
2095 (?<!-) # see strbuf_check_tag_ref(). Tags can't start with -
2096 [A-Za-z0-9.-]+
2097 (?!\.) # refs can't end with ".", see check_refname_format()
2098 -g$regex
2100 # Just a normal looking Git SHA1
2101 $regex
2105 $cgi->a({-href => href(action=>"object", hash=>$1),
2106 -class => "text"}, $1);
2107 }egx;
2109 return $line;
2112 # format marker of refs pointing to given object
2114 # the destination action is chosen based on object type and current context:
2115 # - for annotated tags, we choose the tag view unless it's the current view
2116 # already, in which case we go to shortlog view
2117 # - for other refs, we keep the current view if we're in history, shortlog or
2118 # log view, and select shortlog otherwise
2119 sub format_ref_marker {
2120 my ($refs, $id) = @_;
2121 my $markers = '';
2123 if (defined $refs->{$id}) {
2124 foreach my $ref (@{$refs->{$id}}) {
2125 # this code exploits the fact that non-lightweight tags are the
2126 # only indirect objects, and that they are the only objects for which
2127 # we want to use tag instead of shortlog as action
2128 my ($type, $name) = qw();
2129 my $indirect = ($ref =~ s/\^\{\}$//);
2130 # e.g. tags/v2.6.11 or heads/next
2131 if ($ref =~ m!^(.*?)s?/(.*)$!) {
2132 $type = $1;
2133 $name = $2;
2134 } else {
2135 $type = "ref";
2136 $name = $ref;
2139 my $class = $type;
2140 $class .= " indirect" if $indirect;
2142 my $dest_action = "shortlog";
2144 if ($indirect) {
2145 $dest_action = "tag" unless $action eq "tag";
2146 } elsif ($action =~ /^(history|(short)?log)$/) {
2147 $dest_action = $action;
2150 my $dest = "";
2151 $dest .= "refs/" unless $ref =~ m!^refs/!;
2152 $dest .= $ref;
2154 my $link = $cgi->a({
2155 -href => href(
2156 action=>$dest_action,
2157 hash=>$dest
2158 )}, esc_html($name));
2160 $markers .= " <span class=\"".esc_attr($class)."\" title=\"".esc_attr($ref)."\">" .
2161 $link . "</span>";
2165 if ($markers) {
2166 return ' <span class="refs">'. $markers . '</span>';
2167 } else {
2168 return "";
2172 # format, perhaps shortened and with markers, title line
2173 sub format_subject_html {
2174 my ($long, $short, $href, $extra) = @_;
2175 $extra = '' unless defined($extra);
2177 if (length($short) < length($long)) {
2178 $long =~ s/[[:cntrl:]]/?/g;
2179 return $cgi->a({-href => $href, -class => "list subject",
2180 -title => to_utf8($long)},
2181 esc_html($short)) . $extra;
2182 } else {
2183 return $cgi->a({-href => $href, -class => "list subject"},
2184 esc_html($long)) . $extra;
2188 # Rather than recomputing the url for an email multiple times, we cache it
2189 # after the first hit. This gives a visible benefit in views where the avatar
2190 # for the same email is used repeatedly (e.g. shortlog).
2191 # The cache is shared by all avatar engines (currently gravatar only), which
2192 # are free to use it as preferred. Since only one avatar engine is used for any
2193 # given page, there's no risk for cache conflicts.
2194 our %avatar_cache = ();
2196 # Compute the picon url for a given email, by using the picon search service over at
2197 # http://www.cs.indiana.edu/picons/search.html
2198 sub picon_url {
2199 my $email = lc shift;
2200 if (!$avatar_cache{$email}) {
2201 my ($user, $domain) = split('@', $email);
2202 $avatar_cache{$email} =
2203 "//www.cs.indiana.edu/cgi-pub/kinzler/piconsearch.cgi/" .
2204 "$domain/$user/" .
2205 "users+domains+unknown/up/single";
2207 return $avatar_cache{$email};
2210 # Compute the gravatar url for a given email, if it's not in the cache already.
2211 # Gravatar stores only the part of the URL before the size, since that's the
2212 # one computationally more expensive. This also allows reuse of the cache for
2213 # different sizes (for this particular engine).
2214 sub gravatar_url {
2215 my $email = lc shift;
2216 my $size = shift;
2217 $avatar_cache{$email} ||=
2218 "//www.gravatar.com/avatar/" .
2219 md5_hex($email) . "?s=";
2220 return $avatar_cache{$email} . $size;
2223 # Insert an avatar for the given $email at the given $size if the feature
2224 # is enabled.
2225 sub git_get_avatar {
2226 my ($email, %opts) = @_;
2227 my $pre_white = ($opts{-pad_before} ? "&nbsp;" : "");
2228 my $post_white = ($opts{-pad_after} ? "&nbsp;" : "");
2229 $opts{-size} ||= 'default';
2230 my $size = $avatar_size{$opts{-size}} || $avatar_size{'default'};
2231 my $url = "";
2232 if ($git_avatar eq 'gravatar') {
2233 $url = gravatar_url($email, $size);
2234 } elsif ($git_avatar eq 'picon') {
2235 $url = picon_url($email);
2237 # Other providers can be added by extending the if chain, defining $url
2238 # as needed. If no variant puts something in $url, we assume avatars
2239 # are completely disabled/unavailable.
2240 if ($url) {
2241 return $pre_white .
2242 "<img width=\"$size\" " .
2243 "class=\"avatar\" " .
2244 "src=\"".esc_url($url)."\" " .
2245 "alt=\"\" " .
2246 "/>" . $post_white;
2247 } else {
2248 return "";
2252 sub format_search_author {
2253 my ($author, $searchtype, $displaytext) = @_;
2254 my $have_search = gitweb_check_feature('search');
2256 if ($have_search) {
2257 my $performed = "";
2258 if ($searchtype eq 'author') {
2259 $performed = "authored";
2260 } elsif ($searchtype eq 'committer') {
2261 $performed = "committed";
2264 return $cgi->a({-href => href(action=>"search", hash=>$hash,
2265 searchtext=>$author,
2266 searchtype=>$searchtype), class=>"list",
2267 title=>"Search for commits $performed by $author"},
2268 $displaytext);
2270 } else {
2271 return $displaytext;
2275 # format the author name of the given commit with the given tag
2276 # the author name is chopped and escaped according to the other
2277 # optional parameters (see chop_str).
2278 sub format_author_html {
2279 my $tag = shift;
2280 my $co = shift;
2281 my $author = chop_and_escape_str($co->{'author_name'}, @_);
2282 return "<$tag class=\"author\">" .
2283 format_search_author($co->{'author_name'}, "author",
2284 git_get_avatar($co->{'author_email'}, -pad_after => 1) .
2285 $author) .
2286 "</$tag>";
2289 # format git diff header line, i.e. "diff --(git|combined|cc) ..."
2290 sub format_git_diff_header_line {
2291 my $line = shift;
2292 my $diffinfo = shift;
2293 my ($from, $to) = @_;
2295 if ($diffinfo->{'nparents'}) {
2296 # combined diff
2297 $line =~ s!^(diff (.*?) )"?.*$!$1!;
2298 if ($to->{'href'}) {
2299 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2300 esc_path($to->{'file'}));
2301 } else { # file was deleted (no href)
2302 $line .= esc_path($to->{'file'});
2304 } else {
2305 # "ordinary" diff
2306 $line =~ s!^(diff (.*?) )"?a/.*$!$1!;
2307 if ($from->{'href'}) {
2308 $line .= $cgi->a({-href => $from->{'href'}, -class => "path"},
2309 'a/' . esc_path($from->{'file'}));
2310 } else { # file was added (no href)
2311 $line .= 'a/' . esc_path($from->{'file'});
2313 $line .= ' ';
2314 if ($to->{'href'}) {
2315 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2316 'b/' . esc_path($to->{'file'}));
2317 } else { # file was deleted
2318 $line .= 'b/' . esc_path($to->{'file'});
2322 return "<div class=\"diff header\">$line</div>\n";
2325 # format extended diff header line, before patch itself
2326 sub format_extended_diff_header_line {
2327 my $line = shift;
2328 my $diffinfo = shift;
2329 my ($from, $to) = @_;
2331 # match <path>
2332 if ($line =~ s!^((copy|rename) from ).*$!$1! && $from->{'href'}) {
2333 $line .= $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2334 esc_path($from->{'file'}));
2336 if ($line =~ s!^((copy|rename) to ).*$!$1! && $to->{'href'}) {
2337 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2338 esc_path($to->{'file'}));
2340 # match single <mode>
2341 if ($line =~ m/\s(\d{6})$/) {
2342 $line .= '<span class="info"> (' .
2343 file_type_long($1) .
2344 ')</span>';
2346 # match <hash>
2347 if ($line =~ oid_nlen_prefix_infix_regex($sha1_len, "index ", ",") |
2348 $line =~ oid_nlen_prefix_infix_regex($sha256_len, "index ", ",")) {
2349 # can match only for combined diff
2350 $line = 'index ';
2351 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2352 if ($from->{'href'}[$i]) {
2353 $line .= $cgi->a({-href=>$from->{'href'}[$i],
2354 -class=>"hash"},
2355 substr($diffinfo->{'from_id'}[$i],0,7));
2356 } else {
2357 $line .= '0' x 7;
2359 # separator
2360 $line .= ',' if ($i < $diffinfo->{'nparents'} - 1);
2362 $line .= '..';
2363 if ($to->{'href'}) {
2364 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2365 substr($diffinfo->{'to_id'},0,7));
2366 } else {
2367 $line .= '0' x 7;
2370 } elsif ($line =~ oid_nlen_prefix_infix_regex($sha1_len, "index ", "..") |
2371 $line =~ oid_nlen_prefix_infix_regex($sha256_len, "index ", "..")) {
2372 # can match only for ordinary diff
2373 my ($from_link, $to_link);
2374 if ($from->{'href'}) {
2375 $from_link = $cgi->a({-href=>$from->{'href'}, -class=>"hash"},
2376 substr($diffinfo->{'from_id'},0,7));
2377 } else {
2378 $from_link = '0' x 7;
2380 if ($to->{'href'}) {
2381 $to_link = $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2382 substr($diffinfo->{'to_id'},0,7));
2383 } else {
2384 $to_link = '0' x 7;
2386 my ($from_id, $to_id) = ($diffinfo->{'from_id'}, $diffinfo->{'to_id'});
2387 $line =~ s!$from_id\.\.$to_id!$from_link..$to_link!;
2390 return $line . "<br/>\n";
2393 # format from-file/to-file diff header
2394 sub format_diff_from_to_header {
2395 my ($from_line, $to_line, $diffinfo, $from, $to, @parents) = @_;
2396 my $line;
2397 my $result = '';
2399 $line = $from_line;
2400 #assert($line =~ m/^---/) if DEBUG;
2401 # no extra formatting for "^--- /dev/null"
2402 if (! $diffinfo->{'nparents'}) {
2403 # ordinary (single parent) diff
2404 if ($line =~ m!^--- "?a/!) {
2405 if ($from->{'href'}) {
2406 $line = '--- a/' .
2407 $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2408 esc_path($from->{'file'}));
2409 } else {
2410 $line = '--- a/' .
2411 esc_path($from->{'file'});
2414 $result .= qq!<div class="diff from_file">$line</div>\n!;
2416 } else {
2417 # combined diff (merge commit)
2418 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2419 if ($from->{'href'}[$i]) {
2420 $line = '--- ' .
2421 $cgi->a({-href=>href(action=>"blobdiff",
2422 hash_parent=>$diffinfo->{'from_id'}[$i],
2423 hash_parent_base=>$parents[$i],
2424 file_parent=>$from->{'file'}[$i],
2425 hash=>$diffinfo->{'to_id'},
2426 hash_base=>$hash,
2427 file_name=>$to->{'file'}),
2428 -class=>"path",
2429 -title=>"diff" . ($i+1)},
2430 $i+1) .
2431 '/' .
2432 $cgi->a({-href=>$from->{'href'}[$i], -class=>"path"},
2433 esc_path($from->{'file'}[$i]));
2434 } else {
2435 $line = '--- /dev/null';
2437 $result .= qq!<div class="diff from_file">$line</div>\n!;
2441 $line = $to_line;
2442 #assert($line =~ m/^\+\+\+/) if DEBUG;
2443 # no extra formatting for "^+++ /dev/null"
2444 if ($line =~ m!^\+\+\+ "?b/!) {
2445 if ($to->{'href'}) {
2446 $line = '+++ b/' .
2447 $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2448 esc_path($to->{'file'}));
2449 } else {
2450 $line = '+++ b/' .
2451 esc_path($to->{'file'});
2454 $result .= qq!<div class="diff to_file">$line</div>\n!;
2456 return $result;
2459 # create note for patch simplified by combined diff
2460 sub format_diff_cc_simplified {
2461 my ($diffinfo, @parents) = @_;
2462 my $result = '';
2464 $result .= "<div class=\"diff header\">" .
2465 "diff --cc ";
2466 if (!is_deleted($diffinfo)) {
2467 $result .= $cgi->a({-href => href(action=>"blob",
2468 hash_base=>$hash,
2469 hash=>$diffinfo->{'to_id'},
2470 file_name=>$diffinfo->{'to_file'}),
2471 -class => "path"},
2472 esc_path($diffinfo->{'to_file'}));
2473 } else {
2474 $result .= esc_path($diffinfo->{'to_file'});
2476 $result .= "</div>\n" . # class="diff header"
2477 "<div class=\"diff nodifferences\">" .
2478 "Simple merge" .
2479 "</div>\n"; # class="diff nodifferences"
2481 return $result;
2484 sub diff_line_class {
2485 my ($line, $from, $to) = @_;
2487 # ordinary diff
2488 my $num_sign = 1;
2489 # combined diff
2490 if ($from && $to && ref($from->{'href'}) eq "ARRAY") {
2491 $num_sign = scalar @{$from->{'href'}};
2494 my @diff_line_classifier = (
2495 { regexp => qr/^\@\@{$num_sign} /, class => "chunk_header"},
2496 { regexp => qr/^\\/, class => "incomplete" },
2497 { regexp => qr/^ {$num_sign}/, class => "ctx" },
2498 # classifier for context must come before classifier add/rem,
2499 # or we would have to use more complicated regexp, for example
2500 # qr/(?= {0,$m}\+)[+ ]{$num_sign}/, where $m = $num_sign - 1;
2501 { regexp => qr/^[+ ]{$num_sign}/, class => "add" },
2502 { regexp => qr/^[- ]{$num_sign}/, class => "rem" },
2504 for my $clsfy (@diff_line_classifier) {
2505 return $clsfy->{'class'}
2506 if ($line =~ $clsfy->{'regexp'});
2509 # fallback
2510 return "";
2513 # assumes that $from and $to are defined and correctly filled,
2514 # and that $line holds a line of chunk header for unified diff
2515 sub format_unidiff_chunk_header {
2516 my ($line, $from, $to) = @_;
2518 my ($from_text, $from_start, $from_lines, $to_text, $to_start, $to_lines, $section) =
2519 $line =~ m/^\@{2} (-(\d+)(?:,(\d+))?) (\+(\d+)(?:,(\d+))?) \@{2}(.*)$/;
2521 $from_lines = 0 unless defined $from_lines;
2522 $to_lines = 0 unless defined $to_lines;
2524 if ($from->{'href'}) {
2525 $from_text = $cgi->a({-href=>"$from->{'href'}#l$from_start",
2526 -class=>"list"}, $from_text);
2528 if ($to->{'href'}) {
2529 $to_text = $cgi->a({-href=>"$to->{'href'}#l$to_start",
2530 -class=>"list"}, $to_text);
2532 $line = "<span class=\"chunk_info\">@@ $from_text $to_text @@</span>" .
2533 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2534 return $line;
2537 # assumes that $from and $to are defined and correctly filled,
2538 # and that $line holds a line of chunk header for combined diff
2539 sub format_cc_diff_chunk_header {
2540 my ($line, $from, $to) = @_;
2542 my ($prefix, $ranges, $section) = $line =~ m/^(\@+) (.*?) \@+(.*)$/;
2543 my (@from_text, @from_start, @from_nlines, $to_text, $to_start, $to_nlines);
2545 @from_text = split(' ', $ranges);
2546 for (my $i = 0; $i < @from_text; ++$i) {
2547 ($from_start[$i], $from_nlines[$i]) =
2548 (split(',', substr($from_text[$i], 1)), 0);
2551 $to_text = pop @from_text;
2552 $to_start = pop @from_start;
2553 $to_nlines = pop @from_nlines;
2555 $line = "<span class=\"chunk_info\">$prefix ";
2556 for (my $i = 0; $i < @from_text; ++$i) {
2557 if ($from->{'href'}[$i]) {
2558 $line .= $cgi->a({-href=>"$from->{'href'}[$i]#l$from_start[$i]",
2559 -class=>"list"}, $from_text[$i]);
2560 } else {
2561 $line .= $from_text[$i];
2563 $line .= " ";
2565 if ($to->{'href'}) {
2566 $line .= $cgi->a({-href=>"$to->{'href'}#l$to_start",
2567 -class=>"list"}, $to_text);
2568 } else {
2569 $line .= $to_text;
2571 $line .= " $prefix</span>" .
2572 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2573 return $line;
2576 # process patch (diff) line (not to be used for diff headers),
2577 # returning HTML-formatted (but not wrapped) line.
2578 # If the line is passed as a reference, it is treated as HTML and not
2579 # esc_html()'ed.
2580 sub format_diff_line {
2581 my ($line, $diff_class, $from, $to) = @_;
2583 if (ref($line)) {
2584 $line = $$line;
2585 } else {
2586 chomp $line;
2587 $line = untabify($line);
2589 if ($from && $to && $line =~ m/^\@{2} /) {
2590 $line = format_unidiff_chunk_header($line, $from, $to);
2591 } elsif ($from && $to && $line =~ m/^\@{3}/) {
2592 $line = format_cc_diff_chunk_header($line, $from, $to);
2593 } else {
2594 $line = esc_html($line, -nbsp=>1);
2598 my $diff_classes = "diff";
2599 $diff_classes .= " $diff_class" if ($diff_class);
2600 $line = "<div class=\"$diff_classes\">$line</div>\n";
2602 return $line;
2605 # Generates undef or something like "_snapshot_" or "snapshot (_tbz2_ _zip_)",
2606 # linked. Pass the hash of the tree/commit to snapshot.
2607 sub format_snapshot_links {
2608 my ($hash) = @_;
2609 my $num_fmts = @snapshot_fmts;
2610 if ($num_fmts > 1) {
2611 # A parenthesized list of links bearing format names.
2612 # e.g. "snapshot (_tar.gz_ _zip_)"
2613 return "snapshot (" . join(' ', map
2614 $cgi->a({
2615 -href => href(
2616 action=>"snapshot",
2617 hash=>$hash,
2618 snapshot_format=>$_
2620 }, $known_snapshot_formats{$_}{'display'})
2621 , @snapshot_fmts) . ")";
2622 } elsif ($num_fmts == 1) {
2623 # A single "snapshot" link whose tooltip bears the format name.
2624 # i.e. "_snapshot_"
2625 my ($fmt) = @snapshot_fmts;
2626 return
2627 $cgi->a({
2628 -href => href(
2629 action=>"snapshot",
2630 hash=>$hash,
2631 snapshot_format=>$fmt
2633 -title => "in format: $known_snapshot_formats{$fmt}{'display'}"
2634 }, "snapshot");
2635 } else { # $num_fmts == 0
2636 return undef;
2640 ## ......................................................................
2641 ## functions returning values to be passed, perhaps after some
2642 ## transformation, to other functions; e.g. returning arguments to href()
2644 # returns hash to be passed to href to generate gitweb URL
2645 # in -title key it returns description of link
2646 sub get_feed_info {
2647 my $format = shift || 'Atom';
2648 my %res = (action => lc($format));
2649 my $matched_ref = 0;
2651 # feed links are possible only for project views
2652 return unless (defined $project);
2653 # some views should link to OPML, or to generic project feed,
2654 # or don't have specific feed yet (so they should use generic)
2655 return if (!$action || $action =~ /^(?:tags|heads|forks|tag|search)$/x);
2657 my $branch = undef;
2658 # branches refs uses 'refs/' + $get_branch_refs()[x] + '/' prefix
2659 # (fullname) to differentiate from tag links; this also makes
2660 # possible to detect branch links
2661 for my $ref (get_branch_refs()) {
2662 if ((defined $hash_base && $hash_base =~ m!^refs/\Q$ref\E/(.*)$!) ||
2663 (defined $hash && $hash =~ m!^refs/\Q$ref\E/(.*)$!)) {
2664 $branch = $1;
2665 $matched_ref = $ref;
2666 last;
2669 # find log type for feed description (title)
2670 my $type = 'log';
2671 if (defined $file_name) {
2672 $type = "history of $file_name";
2673 $type .= "/" if ($action eq 'tree');
2674 $type .= " on '$branch'" if (defined $branch);
2675 } else {
2676 $type = "log of $branch" if (defined $branch);
2679 $res{-title} = $type;
2680 $res{'hash'} = (defined $branch ? "refs/$matched_ref/$branch" : undef);
2681 $res{'file_name'} = $file_name;
2683 return %res;
2686 ## ----------------------------------------------------------------------
2687 ## git utility subroutines, invoking git commands
2689 # returns path to the core git executable and the --git-dir parameter as list
2690 sub git_cmd {
2691 $number_of_git_cmds++;
2692 return $GIT, '--git-dir='.$git_dir;
2695 # quote the given arguments for passing them to the shell
2696 # quote_command("command", "arg 1", "arg with ' and ! characters")
2697 # => "'command' 'arg 1' 'arg with '\'' and '\!' characters'"
2698 # Try to avoid using this function wherever possible.
2699 sub quote_command {
2700 return join(' ',
2701 map { my $a = $_; $a =~ s/(['!])/'\\$1'/g; "'$a'" } @_ );
2704 # get HEAD ref of given project as hash
2705 sub git_get_head_hash {
2706 return git_get_full_hash(shift, 'HEAD');
2709 sub git_get_full_hash {
2710 return git_get_hash(@_);
2713 sub git_get_short_hash {
2714 return git_get_hash(@_, '--short=7');
2717 sub git_get_hash {
2718 my ($project, $hash, @options) = @_;
2719 my $o_git_dir = $git_dir;
2720 my $retval = undef;
2721 $git_dir = "$projectroot/$project";
2722 if (open my $fd, '-|', git_cmd(), 'rev-parse',
2723 '--verify', '-q', @options, $hash) {
2724 $retval = <$fd>;
2725 chomp $retval if defined $retval;
2726 close $fd;
2728 if (defined $o_git_dir) {
2729 $git_dir = $o_git_dir;
2731 return $retval;
2734 # get type of given object
2735 sub git_get_type {
2736 my $hash = shift;
2738 open my $fd, "-|", git_cmd(), "cat-file", '-t', $hash or return;
2739 my $type = <$fd>;
2740 close $fd or return;
2741 chomp $type;
2742 return $type;
2745 # repository configuration
2746 our $config_file = '';
2747 our %config;
2749 # store multiple values for single key as anonymous array reference
2750 # single values stored directly in the hash, not as [ <value> ]
2751 sub hash_set_multi {
2752 my ($hash, $key, $value) = @_;
2754 if (!exists $hash->{$key}) {
2755 $hash->{$key} = $value;
2756 } elsif (!ref $hash->{$key}) {
2757 $hash->{$key} = [ $hash->{$key}, $value ];
2758 } else {
2759 push @{$hash->{$key}}, $value;
2763 # return hash of git project configuration
2764 # optionally limited to some section, e.g. 'gitweb'
2765 sub git_parse_project_config {
2766 my $section_regexp = shift;
2767 my %config;
2769 local $/ = "\0";
2771 open my $fh, "-|", git_cmd(), "config", '-z', '-l',
2772 or return;
2774 while (my $keyval = <$fh>) {
2775 chomp $keyval;
2776 my ($key, $value) = split(/\n/, $keyval, 2);
2778 hash_set_multi(\%config, $key, $value)
2779 if (!defined $section_regexp || $key =~ /^(?:$section_regexp)\./o);
2781 close $fh;
2783 return %config;
2786 # convert config value to boolean: 'true' or 'false'
2787 # no value, number > 0, 'true' and 'yes' values are true
2788 # rest of values are treated as false (never as error)
2789 sub config_to_bool {
2790 my $val = shift;
2792 return 1 if !defined $val; # section.key
2794 # strip leading and trailing whitespace
2795 $val =~ s/^\s+//;
2796 $val =~ s/\s+$//;
2798 return (($val =~ /^\d+$/ && $val) || # section.key = 1
2799 ($val =~ /^(?:true|yes)$/i)); # section.key = true
2802 # convert config value to simple decimal number
2803 # an optional value suffix of 'k', 'm', or 'g' will cause the value
2804 # to be multiplied by 1024, 1048576, or 1073741824
2805 sub config_to_int {
2806 my $val = shift;
2808 # strip leading and trailing whitespace
2809 $val =~ s/^\s+//;
2810 $val =~ s/\s+$//;
2812 if (my ($num, $unit) = ($val =~ /^([0-9]*)([kmg])$/i)) {
2813 $unit = lc($unit);
2814 # unknown unit is treated as 1
2815 return $num * ($unit eq 'g' ? 1073741824 :
2816 $unit eq 'm' ? 1048576 :
2817 $unit eq 'k' ? 1024 : 1);
2819 return $val;
2822 # convert config value to array reference, if needed
2823 sub config_to_multi {
2824 my $val = shift;
2826 return ref($val) ? $val : (defined($val) ? [ $val ] : []);
2829 sub git_get_project_config {
2830 my ($key, $type) = @_;
2832 return unless defined $git_dir;
2834 # key sanity check
2835 return unless ($key);
2836 # only subsection, if exists, is case sensitive,
2837 # and not lowercased by 'git config -z -l'
2838 if (my ($hi, $mi, $lo) = ($key =~ /^([^.]*)\.(.*)\.([^.]*)$/)) {
2839 $lo =~ s/_//g;
2840 $key = join(".", lc($hi), $mi, lc($lo));
2841 return if ($lo =~ /\W/ || $hi =~ /\W/);
2842 } else {
2843 $key = lc($key);
2844 $key =~ s/_//g;
2845 return if ($key =~ /\W/);
2847 $key =~ s/^gitweb\.//;
2849 # type sanity check
2850 if (defined $type) {
2851 $type =~ s/^--//;
2852 $type = undef
2853 unless ($type eq 'bool' || $type eq 'int');
2856 # get config
2857 if (!defined $config_file ||
2858 $config_file ne "$git_dir/config") {
2859 %config = git_parse_project_config('gitweb');
2860 $config_file = "$git_dir/config";
2863 # check if config variable (key) exists
2864 return unless exists $config{"gitweb.$key"};
2866 # ensure given type
2867 if (!defined $type) {
2868 return $config{"gitweb.$key"};
2869 } elsif ($type eq 'bool') {
2870 # backward compatibility: 'git config --bool' returns true/false
2871 return config_to_bool($config{"gitweb.$key"}) ? 'true' : 'false';
2872 } elsif ($type eq 'int') {
2873 return config_to_int($config{"gitweb.$key"});
2875 return $config{"gitweb.$key"};
2878 # get hash of given path at given ref
2879 sub git_get_hash_by_path {
2880 my $base = shift;
2881 my $path = shift || return undef;
2882 my $type = shift;
2884 $path =~ s,/+$,,;
2886 open my $fd, "-|", git_cmd(), "ls-tree", $base, "--", $path
2887 or die_error(500, "Open git-ls-tree failed");
2888 my $line = <$fd>;
2889 close $fd or return undef;
2891 if (!defined $line) {
2892 # there is no tree or hash given by $path at $base
2893 return undef;
2896 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
2897 $line =~ m/^([0-9]+) (.+) ($oid_regex)\t/;
2898 if (defined $type && $type ne $2) {
2899 # type doesn't match
2900 return undef;
2902 return $3;
2905 # get path of entry with given hash at given tree-ish (ref)
2906 # used to get 'from' filename for combined diff (merge commit) for renames
2907 sub git_get_path_by_hash {
2908 my $base = shift || return;
2909 my $hash = shift || return;
2911 local $/ = "\0";
2913 open my $fd, "-|", git_cmd(), "ls-tree", '-r', '-t', '-z', $base
2914 or return undef;
2915 while (my $line = <$fd>) {
2916 chomp $line;
2918 #'040000 tree 595596a6a9117ddba9fe379b6b012b558bac8423 gitweb'
2919 #'100644 blob e02e90f0429be0d2a69b76571101f20b8f75530f gitweb/README'
2920 if ($line =~ m/(?:[0-9]+) (?:.+) $hash\t(.+)$/) {
2921 close $fd;
2922 return $1;
2925 close $fd;
2926 return undef;
2929 ## ......................................................................
2930 ## git utility functions, directly accessing git repository
2932 # get the value of config variable either from file named as the variable
2933 # itself in the repository ($GIT_DIR/$name file), or from gitweb.$name
2934 # configuration variable in the repository config file.
2935 sub git_get_file_or_project_config {
2936 my ($path, $name) = @_;
2938 $git_dir = "$projectroot/$path";
2939 open my $fd, '<', "$git_dir/$name"
2940 or return git_get_project_config($name);
2941 my $conf = <$fd>;
2942 close $fd;
2943 if (defined $conf) {
2944 chomp $conf;
2946 return $conf;
2949 sub git_get_project_description {
2950 my $path = shift;
2951 return git_get_file_or_project_config($path, 'description');
2954 sub git_get_project_category {
2955 my $path = shift;
2956 return git_get_file_or_project_config($path, 'category');
2960 # supported formats:
2961 # * $GIT_DIR/ctags/<tagname> file (in 'ctags' subdirectory)
2962 # - if its contents is a number, use it as tag weight,
2963 # - otherwise add a tag with weight 1
2964 # * $GIT_DIR/ctags file, each line is a tag (with weight 1)
2965 # the same value multiple times increases tag weight
2966 # * `gitweb.ctag' multi-valued repo config variable
2967 sub git_get_project_ctags {
2968 my $project = shift;
2969 my $ctags = {};
2971 $git_dir = "$projectroot/$project";
2972 if (opendir my $dh, "$git_dir/ctags") {
2973 my @files = grep { -f $_ } map { "$git_dir/ctags/$_" } readdir($dh);
2974 foreach my $tagfile (@files) {
2975 open my $ct, '<', $tagfile
2976 or next;
2977 my $val = <$ct>;
2978 chomp $val if $val;
2979 close $ct;
2981 (my $ctag = $tagfile) =~ s#.*/##;
2982 if ($val =~ /^\d+$/) {
2983 $ctags->{$ctag} = $val;
2984 } else {
2985 $ctags->{$ctag} = 1;
2988 closedir $dh;
2990 } elsif (open my $fh, '<', "$git_dir/ctags") {
2991 while (my $line = <$fh>) {
2992 chomp $line;
2993 $ctags->{$line}++ if $line;
2995 close $fh;
2997 } else {
2998 my $taglist = config_to_multi(git_get_project_config('ctag'));
2999 foreach my $tag (@$taglist) {
3000 $ctags->{$tag}++;
3004 return $ctags;
3007 # return hash, where keys are content tags ('ctags'),
3008 # and values are sum of weights of given tag in every project
3009 sub git_gather_all_ctags {
3010 my $projects = shift;
3011 my $ctags = {};
3013 foreach my $p (@$projects) {
3014 foreach my $ct (keys %{$p->{'ctags'}}) {
3015 $ctags->{$ct} += $p->{'ctags'}->{$ct};
3019 return $ctags;
3022 sub git_populate_project_tagcloud {
3023 my $ctags = shift;
3025 # First, merge different-cased tags; tags vote on casing
3026 my %ctags_lc;
3027 foreach (keys %$ctags) {
3028 $ctags_lc{lc $_}->{count} += $ctags->{$_};
3029 if (not $ctags_lc{lc $_}->{topcount}
3030 or $ctags_lc{lc $_}->{topcount} < $ctags->{$_}) {
3031 $ctags_lc{lc $_}->{topcount} = $ctags->{$_};
3032 $ctags_lc{lc $_}->{topname} = $_;
3036 my $cloud;
3037 my $matched = $input_params{'ctag'};
3038 if (eval { require HTML::TagCloud; 1; }) {
3039 $cloud = HTML::TagCloud->new;
3040 foreach my $ctag (sort keys %ctags_lc) {
3041 # Pad the title with spaces so that the cloud looks
3042 # less crammed.
3043 my $title = esc_html($ctags_lc{$ctag}->{topname});
3044 $title =~ s/ /&nbsp;/g;
3045 $title =~ s/^/&nbsp;/g;
3046 $title =~ s/$/&nbsp;/g;
3047 if (defined $matched && $matched eq $ctag) {
3048 $title = qq(<span class="match">$title</span>);
3050 $cloud->add($title, href(project=>undef, ctag=>$ctag),
3051 $ctags_lc{$ctag}->{count});
3053 } else {
3054 $cloud = {};
3055 foreach my $ctag (keys %ctags_lc) {
3056 my $title = esc_html($ctags_lc{$ctag}->{topname}, -nbsp=>1);
3057 if (defined $matched && $matched eq $ctag) {
3058 $title = qq(<span class="match">$title</span>);
3060 $cloud->{$ctag}{count} = $ctags_lc{$ctag}->{count};
3061 $cloud->{$ctag}{ctag} =
3062 $cgi->a({-href=>href(project=>undef, ctag=>$ctag)}, $title);
3065 return $cloud;
3068 sub git_show_project_tagcloud {
3069 my ($cloud, $count) = @_;
3070 if (ref $cloud eq 'HTML::TagCloud') {
3071 return $cloud->html_and_css($count);
3072 } else {
3073 my @tags = sort { $cloud->{$a}->{'count'} <=> $cloud->{$b}->{'count'} } keys %$cloud;
3074 return
3075 '<div id="htmltagcloud"'.($project ? '' : ' align="center"').'>' .
3076 join (', ', map {
3077 $cloud->{$_}->{'ctag'}
3078 } splice(@tags, 0, $count)) .
3079 '</div>';
3083 sub git_get_project_url_list {
3084 my $path = shift;
3086 $git_dir = "$projectroot/$path";
3087 open my $fd, '<', "$git_dir/cloneurl"
3088 or return wantarray ?
3089 @{ config_to_multi(git_get_project_config('url')) } :
3090 config_to_multi(git_get_project_config('url'));
3091 my @git_project_url_list = map { chomp; $_ } <$fd>;
3092 close $fd;
3094 return wantarray ? @git_project_url_list : \@git_project_url_list;
3097 sub git_get_projects_list {
3098 my $filter = shift || '';
3099 my $paranoid = shift;
3100 my @list;
3102 if (-d $projects_list) {
3103 # search in directory
3104 my $dir = $projects_list;
3105 # remove the trailing "/"
3106 $dir =~ s!/+$!!;
3107 my $pfxlen = length("$dir");
3108 my $pfxdepth = ($dir =~ tr!/!!);
3109 # when filtering, search only given subdirectory
3110 if ($filter && !$paranoid) {
3111 $dir .= "/$filter";
3112 $dir =~ s!/+$!!;
3115 File::Find::find({
3116 follow_fast => 1, # follow symbolic links
3117 follow_skip => 2, # ignore duplicates
3118 dangling_symlinks => 0, # ignore dangling symlinks, silently
3119 wanted => sub {
3120 # global variables
3121 our $project_maxdepth;
3122 our $projectroot;
3123 # skip project-list toplevel, if we get it.
3124 return if (m!^[/.]$!);
3125 # only directories can be git repositories
3126 return unless (-d $_);
3127 # need search permission
3128 return unless (-x $_);
3129 # don't traverse too deep (Find is super slow on os x)
3130 # $project_maxdepth excludes depth of $projectroot
3131 if (($File::Find::name =~ tr!/!!) - $pfxdepth > $project_maxdepth) {
3132 $File::Find::prune = 1;
3133 return;
3136 my $path = substr($File::Find::name, $pfxlen + 1);
3137 # paranoidly only filter here
3138 if ($paranoid && $filter && $path !~ m!^\Q$filter\E/!) {
3139 next;
3141 # we check related file in $projectroot
3142 if (check_export_ok("$projectroot/$path")) {
3143 push @list, { path => $path };
3144 $File::Find::prune = 1;
3147 }, "$dir");
3149 } elsif (-f $projects_list) {
3150 # read from file(url-encoded):
3151 # 'git%2Fgit.git Linus+Torvalds'
3152 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3153 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3154 open my $fd, '<', $projects_list or return;
3155 PROJECT:
3156 while (my $line = <$fd>) {
3157 chomp $line;
3158 my ($path, $owner) = split ' ', $line;
3159 $path = unescape($path);
3160 $owner = unescape($owner);
3161 if (!defined $path) {
3162 next;
3164 # if $filter is rpovided, check if $path begins with $filter
3165 if ($filter && $path !~ m!^\Q$filter\E/!) {
3166 next;
3168 if (check_export_ok("$projectroot/$path")) {
3169 my $pr = {
3170 path => $path
3172 if ($owner) {
3173 $pr->{'owner'} = to_utf8($owner);
3175 push @list, $pr;
3178 close $fd;
3180 return @list;
3183 # written with help of Tree::Trie module (Perl Artistic License, GPL compatible)
3184 # as side effects it sets 'forks' field to list of forks for forked projects
3185 sub filter_forks_from_projects_list {
3186 my $projects = shift;
3188 my %trie; # prefix tree of directories (path components)
3189 # generate trie out of those directories that might contain forks
3190 foreach my $pr (@$projects) {
3191 my $path = $pr->{'path'};
3192 $path =~ s/\.git$//; # forks of 'repo.git' are in 'repo/' directory
3193 next if ($path =~ m!/$!); # skip non-bare repositories, e.g. 'repo/.git'
3194 next unless ($path); # skip '.git' repository: tests, git-instaweb
3195 next unless (-d "$projectroot/$path"); # containing directory exists
3196 $pr->{'forks'} = []; # there can be 0 or more forks of project
3198 # add to trie
3199 my @dirs = split('/', $path);
3200 # walk the trie, until either runs out of components or out of trie
3201 my $ref = \%trie;
3202 while (scalar @dirs &&
3203 exists($ref->{$dirs[0]})) {
3204 $ref = $ref->{shift @dirs};
3206 # create rest of trie structure from rest of components
3207 foreach my $dir (@dirs) {
3208 $ref = $ref->{$dir} = {};
3210 # create end marker, store $pr as a data
3211 $ref->{''} = $pr if (!exists $ref->{''});
3214 # filter out forks, by finding shortest prefix match for paths
3215 my @filtered;
3216 PROJECT:
3217 foreach my $pr (@$projects) {
3218 # trie lookup
3219 my $ref = \%trie;
3220 DIR:
3221 foreach my $dir (split('/', $pr->{'path'})) {
3222 if (exists $ref->{''}) {
3223 # found [shortest] prefix, is a fork - skip it
3224 push @{$ref->{''}{'forks'}}, $pr;
3225 next PROJECT;
3227 if (!exists $ref->{$dir}) {
3228 # not in trie, cannot have prefix, not a fork
3229 push @filtered, $pr;
3230 next PROJECT;
3232 # If the dir is there, we just walk one step down the trie.
3233 $ref = $ref->{$dir};
3235 # we ran out of trie
3236 # (shouldn't happen: it's either no match, or end marker)
3237 push @filtered, $pr;
3240 return @filtered;
3243 # note: fill_project_list_info must be run first,
3244 # for 'descr_long' and 'ctags' to be filled
3245 sub search_projects_list {
3246 my ($projlist, %opts) = @_;
3247 my $tagfilter = $opts{'tagfilter'};
3248 my $search_re = $opts{'search_regexp'};
3250 return @$projlist
3251 unless ($tagfilter || $search_re);
3253 # searching projects require filling to be run before it;
3254 fill_project_list_info($projlist,
3255 $tagfilter ? 'ctags' : (),
3256 $search_re ? ('path', 'descr') : ());
3257 my @projects;
3258 PROJECT:
3259 foreach my $pr (@$projlist) {
3261 if ($tagfilter) {
3262 next unless ref($pr->{'ctags'}) eq 'HASH';
3263 next unless
3264 grep { lc($_) eq lc($tagfilter) } keys %{$pr->{'ctags'}};
3267 if ($search_re) {
3268 next unless
3269 $pr->{'path'} =~ /$search_re/ ||
3270 $pr->{'descr_long'} =~ /$search_re/;
3273 push @projects, $pr;
3276 return @projects;
3279 our $gitweb_project_owner = undef;
3280 sub git_get_project_list_from_file {
3282 return if (defined $gitweb_project_owner);
3284 $gitweb_project_owner = {};
3285 # read from file (url-encoded):
3286 # 'git%2Fgit.git Linus+Torvalds'
3287 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3288 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3289 if (-f $projects_list) {
3290 open(my $fd, '<', $projects_list);
3291 while (my $line = <$fd>) {
3292 chomp $line;
3293 my ($pr, $ow) = split ' ', $line;
3294 $pr = unescape($pr);
3295 $ow = unescape($ow);
3296 $gitweb_project_owner->{$pr} = to_utf8($ow);
3298 close $fd;
3302 sub git_get_project_owner {
3303 my $project = shift;
3304 my $owner;
3306 return undef unless $project;
3307 $git_dir = "$projectroot/$project";
3309 if (!defined $gitweb_project_owner) {
3310 git_get_project_list_from_file();
3313 if (exists $gitweb_project_owner->{$project}) {
3314 $owner = $gitweb_project_owner->{$project};
3316 if (!defined $owner){
3317 $owner = git_get_project_config('owner');
3319 if (!defined $owner) {
3320 $owner = get_file_owner("$git_dir");
3323 return $owner;
3326 sub git_get_last_activity {
3327 my ($path) = @_;
3328 my $fd;
3330 $git_dir = "$projectroot/$path";
3331 open($fd, "-|", git_cmd(), 'for-each-ref',
3332 '--format=%(committer)',
3333 '--sort=-committerdate',
3334 '--count=1',
3335 map { "refs/$_" } get_branch_refs ()) or return;
3336 my $most_recent = <$fd>;
3337 close $fd or return;
3338 if (defined $most_recent &&
3339 $most_recent =~ / (\d+) [-+][01]\d\d\d$/) {
3340 my $timestamp = $1;
3341 my $age = time - $timestamp;
3342 return ($age, age_string($age));
3344 return (undef, undef);
3347 # Implementation note: when a single remote is wanted, we cannot use 'git
3348 # remote show -n' because that command always work (assuming it's a remote URL
3349 # if it's not defined), and we cannot use 'git remote show' because that would
3350 # try to make a network roundtrip. So the only way to find if that particular
3351 # remote is defined is to walk the list provided by 'git remote -v' and stop if
3352 # and when we find what we want.
3353 sub git_get_remotes_list {
3354 my $wanted = shift;
3355 my %remotes = ();
3357 open my $fd, '-|' , git_cmd(), 'remote', '-v';
3358 return unless $fd;
3359 while (my $remote = <$fd>) {
3360 chomp $remote;
3361 $remote =~ s!\t(.*?)\s+\((\w+)\)$!!;
3362 next if $wanted and not $remote eq $wanted;
3363 my ($url, $key) = ($1, $2);
3365 $remotes{$remote} ||= { 'heads' => () };
3366 $remotes{$remote}{$key} = $url;
3368 close $fd or return;
3369 return wantarray ? %remotes : \%remotes;
3372 # Takes a hash of remotes as first parameter and fills it by adding the
3373 # available remote heads for each of the indicated remotes.
3374 sub fill_remote_heads {
3375 my $remotes = shift;
3376 my @heads = map { "remotes/$_" } keys %$remotes;
3377 my @remoteheads = git_get_heads_list(undef, @heads);
3378 foreach my $remote (keys %$remotes) {
3379 $remotes->{$remote}{'heads'} = [ grep {
3380 $_->{'name'} =~ s!^$remote/!!
3381 } @remoteheads ];
3385 sub git_get_references {
3386 my $type = shift || "";
3387 my %refs;
3388 # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
3389 # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
3390 open my $fd, "-|", git_cmd(), "show-ref", "--dereference",
3391 ($type ? ("--", "refs/$type") : ()) # use -- <pattern> if $type
3392 or return;
3394 while (my $line = <$fd>) {
3395 chomp $line;
3396 if ($line =~ m!^($oid_regex)\srefs/($type.*)$!) {
3397 if (defined $refs{$1}) {
3398 push @{$refs{$1}}, $2;
3399 } else {
3400 $refs{$1} = [ $2 ];
3404 close $fd or return;
3405 return \%refs;
3408 sub git_get_rev_name_tags {
3409 my $hash = shift || return undef;
3411 open my $fd, "-|", git_cmd(), "name-rev", "--tags", $hash
3412 or return;
3413 my $name_rev = <$fd>;
3414 close $fd;
3416 if ($name_rev =~ m|^$hash tags/(.*)$|) {
3417 return $1;
3418 } else {
3419 # catches also '$hash undefined' output
3420 return undef;
3424 ## ----------------------------------------------------------------------
3425 ## parse to hash functions
3427 sub parse_date {
3428 my $epoch = shift;
3429 my $tz = shift || "-0000";
3431 my %date;
3432 my @months = ("Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
3433 my @days = ("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat");
3434 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($epoch);
3435 $date{'hour'} = $hour;
3436 $date{'minute'} = $min;
3437 $date{'mday'} = $mday;
3438 $date{'day'} = $days[$wday];
3439 $date{'month'} = $months[$mon];
3440 $date{'rfc2822'} = sprintf "%s, %d %s %4d %02d:%02d:%02d +0000",
3441 $days[$wday], $mday, $months[$mon], 1900+$year, $hour ,$min, $sec;
3442 $date{'mday-time'} = sprintf "%d %s %02d:%02d",
3443 $mday, $months[$mon], $hour ,$min;
3444 $date{'iso-8601'} = sprintf "%04d-%02d-%02dT%02d:%02d:%02dZ",
3445 1900+$year, 1+$mon, $mday, $hour ,$min, $sec;
3447 my ($tz_sign, $tz_hour, $tz_min) =
3448 ($tz =~ m/^([-+])(\d\d)(\d\d)$/);
3449 $tz_sign = ($tz_sign eq '-' ? -1 : +1);
3450 my $local = $epoch + $tz_sign*((($tz_hour*60) + $tz_min)*60);
3451 ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($local);
3452 $date{'hour_local'} = $hour;
3453 $date{'minute_local'} = $min;
3454 $date{'tz_local'} = $tz;
3455 $date{'iso-tz'} = sprintf("%04d-%02d-%02d %02d:%02d:%02d %s",
3456 1900+$year, $mon+1, $mday,
3457 $hour, $min, $sec, $tz);
3458 return %date;
3461 sub hide_mailaddrs_if_private {
3462 my $line = shift;
3463 return $line unless gitweb_check_feature('email-privacy');
3464 $line =~ s/<[^@>]+@[^>]+>/<redacted>/g;
3465 return $line;
3468 sub parse_tag {
3469 my $tag_id = shift;
3470 my %tag;
3471 my @comment;
3473 open my $fd, "-|", git_cmd(), "cat-file", "tag", $tag_id or return;
3474 $tag{'id'} = $tag_id;
3475 while (my $line = <$fd>) {
3476 chomp $line;
3477 if ($line =~ m/^object ($oid_regex)$/) {
3478 $tag{'object'} = $1;
3479 } elsif ($line =~ m/^type (.+)$/) {
3480 $tag{'type'} = $1;
3481 } elsif ($line =~ m/^tag (.+)$/) {
3482 $tag{'name'} = $1;
3483 } elsif ($line =~ m/^tagger (.*) ([0-9]+) (.*)$/) {
3484 $tag{'author'} = hide_mailaddrs_if_private($1);
3485 $tag{'author_epoch'} = $2;
3486 $tag{'author_tz'} = $3;
3487 if ($tag{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3488 $tag{'author_name'} = $1;
3489 $tag{'author_email'} = $2;
3490 } else {
3491 $tag{'author_name'} = $tag{'author'};
3493 } elsif ($line =~ m/--BEGIN/) {
3494 push @comment, $line;
3495 last;
3496 } elsif ($line eq "") {
3497 last;
3500 push @comment, <$fd>;
3501 $tag{'comment'} = \@comment;
3502 close $fd or return;
3503 if (!defined $tag{'name'}) {
3504 return
3506 return %tag
3509 sub parse_commit_text {
3510 my ($commit_text, $withparents) = @_;
3511 my @commit_lines = split '\n', $commit_text;
3512 my %co;
3514 pop @commit_lines; # Remove '\0'
3516 if (! @commit_lines) {
3517 return;
3520 my $header = shift @commit_lines;
3521 if ($header !~ m/^$oid_regex/) {
3522 return;
3524 ($co{'id'}, my @parents) = split ' ', $header;
3525 while (my $line = shift @commit_lines) {
3526 last if $line eq "\n";
3527 if ($line =~ m/^tree ($oid_regex)$/) {
3528 $co{'tree'} = $1;
3529 } elsif ((!defined $withparents) && ($line =~ m/^parent ($oid_regex)$/)) {
3530 push @parents, $1;
3531 } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {
3532 $co{'author'} = hide_mailaddrs_if_private(to_utf8($1));
3533 $co{'author_epoch'} = $2;
3534 $co{'author_tz'} = $3;
3535 if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3536 $co{'author_name'} = $1;
3537 $co{'author_email'} = $2;
3538 } else {
3539 $co{'author_name'} = $co{'author'};
3541 } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {
3542 $co{'committer'} = hide_mailaddrs_if_private(to_utf8($1));
3543 $co{'committer_epoch'} = $2;
3544 $co{'committer_tz'} = $3;
3545 if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
3546 $co{'committer_name'} = $1;
3547 $co{'committer_email'} = $2;
3548 } else {
3549 $co{'committer_name'} = $co{'committer'};
3553 if (!defined $co{'tree'}) {
3554 return;
3556 $co{'parents'} = \@parents;
3557 $co{'parent'} = $parents[0];
3559 foreach my $title (@commit_lines) {
3560 $title =~ s/^ //;
3561 if ($title ne "") {
3562 $co{'title'} = chop_str($title, 80, 5);
3563 $co{'title_short'} = chop_str($title, 50, 5);
3564 last;
3567 if (! defined $co{'title'} || $co{'title'} eq "") {
3568 $co{'title'} = $co{'title_short'} = '(no commit message)';
3570 # remove added spaces, redact e-mail addresses if applicable.
3571 foreach my $line (@commit_lines) {
3572 $line =~ s/^ //;
3573 $line = hide_mailaddrs_if_private($line);
3575 $co{'comment'} = \@commit_lines;
3577 my $age = time - $co{'committer_epoch'};
3578 $co{'age'} = $age;
3579 $co{'age_string'} = age_string($age);
3580 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($co{'committer_epoch'});
3581 if ($age > 60*60*24*7*2) {
3582 $co{'age_string_date'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3583 $co{'age_string_age'} = $co{'age_string'};
3584 } else {
3585 $co{'age_string_date'} = $co{'age_string'};
3586 $co{'age_string_age'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3588 return %co;
3591 sub parse_commit {
3592 my ($commit_id) = @_;
3593 my %co;
3595 local $/ = "\0";
3597 open my $fd, "-|", git_cmd(), "rev-list",
3598 "--parents",
3599 "--header",
3600 "--max-count=1",
3601 $commit_id,
3602 "--",
3603 or die_error(500, "Open git-rev-list failed");
3604 %co = parse_commit_text(<$fd>, 1);
3605 close $fd;
3607 return %co;
3610 sub parse_commits {
3611 my ($commit_id, $maxcount, $skip, $filename, @args) = @_;
3612 my @cos;
3614 $maxcount ||= 1;
3615 $skip ||= 0;
3617 local $/ = "\0";
3619 open my $fd, "-|", git_cmd(), "rev-list",
3620 "--header",
3621 @args,
3622 ("--max-count=" . $maxcount),
3623 ("--skip=" . $skip),
3624 @extra_options,
3625 $commit_id,
3626 "--",
3627 ($filename ? ($filename) : ())
3628 or die_error(500, "Open git-rev-list failed");
3629 while (my $line = <$fd>) {
3630 my %co = parse_commit_text($line);
3631 push @cos, \%co;
3633 close $fd;
3635 return wantarray ? @cos : \@cos;
3638 # parse line of git-diff-tree "raw" output
3639 sub parse_difftree_raw_line {
3640 my $line = shift;
3641 my %res;
3643 # ':100644 100644 03b218260e99b78c6df0ed378e59ed9205ccc96d 3b93d5e7cc7f7dd4ebed13a5cc1a4ad976fc94d8 M ls-files.c'
3644 # ':100644 100644 7f9281985086971d3877aca27704f2aaf9c448ce bc190ebc71bbd923f2b728e505408f5e54bd073a M rev-tree.c'
3645 if ($line =~ m/^:([0-7]{6}) ([0-7]{6}) ($oid_regex) ($oid_regex) (.)([0-9]{0,3})\t(.*)$/) {
3646 $res{'from_mode'} = $1;
3647 $res{'to_mode'} = $2;
3648 $res{'from_id'} = $3;
3649 $res{'to_id'} = $4;
3650 $res{'status'} = $5;
3651 $res{'similarity'} = $6;
3652 if ($res{'status'} eq 'R' || $res{'status'} eq 'C') { # renamed or copied
3653 ($res{'from_file'}, $res{'to_file'}) = map { unquote($_) } split("\t", $7);
3654 } else {
3655 $res{'from_file'} = $res{'to_file'} = $res{'file'} = unquote($7);
3658 # '::100755 100755 100755 60e79ca1b01bc8b057abe17ddab484699a7f5fdb 94067cc5f73388f33722d52ae02f44692bc07490 94067cc5f73388f33722d52ae02f44692bc07490 MR git-gui/git-gui.sh'
3659 # combined diff (for merge commit)
3660 elsif ($line =~ s/^(::+)((?:[0-7]{6} )+)((?:$oid_regex )+)([a-zA-Z]+)\t(.*)$//) {
3661 $res{'nparents'} = length($1);
3662 $res{'from_mode'} = [ split(' ', $2) ];
3663 $res{'to_mode'} = pop @{$res{'from_mode'}};
3664 $res{'from_id'} = [ split(' ', $3) ];
3665 $res{'to_id'} = pop @{$res{'from_id'}};
3666 $res{'status'} = [ split('', $4) ];
3667 $res{'to_file'} = unquote($5);
3669 # 'c512b523472485aef4fff9e57b229d9d243c967f'
3670 elsif ($line =~ m/^($oid_regex)$/) {
3671 $res{'commit'} = $1;
3674 return wantarray ? %res : \%res;
3677 # wrapper: return parsed line of git-diff-tree "raw" output
3678 # (the argument might be raw line, or parsed info)
3679 sub parsed_difftree_line {
3680 my $line_or_ref = shift;
3682 if (ref($line_or_ref) eq "HASH") {
3683 # pre-parsed (or generated by hand)
3684 return $line_or_ref;
3685 } else {
3686 return parse_difftree_raw_line($line_or_ref);
3690 # parse line of git-ls-tree output
3691 sub parse_ls_tree_line {
3692 my $line = shift;
3693 my %opts = @_;
3694 my %res;
3696 if ($opts{'-l'}) {
3697 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa 16717 panic.c'
3698 $line =~ m/^([0-9]+) (.+) ($oid_regex) +(-|[0-9]+)\t(.+)$/s;
3700 $res{'mode'} = $1;
3701 $res{'type'} = $2;
3702 $res{'hash'} = $3;
3703 $res{'size'} = $4;
3704 if ($opts{'-z'}) {
3705 $res{'name'} = $5;
3706 } else {
3707 $res{'name'} = unquote($5);
3709 } else {
3710 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
3711 $line =~ m/^([0-9]+) (.+) ($oid_regex)\t(.+)$/s;
3713 $res{'mode'} = $1;
3714 $res{'type'} = $2;
3715 $res{'hash'} = $3;
3716 if ($opts{'-z'}) {
3717 $res{'name'} = $4;
3718 } else {
3719 $res{'name'} = unquote($4);
3723 return wantarray ? %res : \%res;
3726 # generates _two_ hashes, references to which are passed as 2 and 3 argument
3727 sub parse_from_to_diffinfo {
3728 my ($diffinfo, $from, $to, @parents) = @_;
3730 if ($diffinfo->{'nparents'}) {
3731 # combined diff
3732 $from->{'file'} = [];
3733 $from->{'href'} = [];
3734 fill_from_file_info($diffinfo, @parents)
3735 unless exists $diffinfo->{'from_file'};
3736 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
3737 $from->{'file'}[$i] =
3738 defined $diffinfo->{'from_file'}[$i] ?
3739 $diffinfo->{'from_file'}[$i] :
3740 $diffinfo->{'to_file'};
3741 if ($diffinfo->{'status'}[$i] ne "A") { # not new (added) file
3742 $from->{'href'}[$i] = href(action=>"blob",
3743 hash_base=>$parents[$i],
3744 hash=>$diffinfo->{'from_id'}[$i],
3745 file_name=>$from->{'file'}[$i]);
3746 } else {
3747 $from->{'href'}[$i] = undef;
3750 } else {
3751 # ordinary (not combined) diff
3752 $from->{'file'} = $diffinfo->{'from_file'};
3753 if ($diffinfo->{'status'} ne "A") { # not new (added) file
3754 $from->{'href'} = href(action=>"blob", hash_base=>$hash_parent,
3755 hash=>$diffinfo->{'from_id'},
3756 file_name=>$from->{'file'});
3757 } else {
3758 delete $from->{'href'};
3762 $to->{'file'} = $diffinfo->{'to_file'};
3763 if (!is_deleted($diffinfo)) { # file exists in result
3764 $to->{'href'} = href(action=>"blob", hash_base=>$hash,
3765 hash=>$diffinfo->{'to_id'},
3766 file_name=>$to->{'file'});
3767 } else {
3768 delete $to->{'href'};
3772 ## ......................................................................
3773 ## parse to array of hashes functions
3775 sub git_get_heads_list {
3776 my ($limit, @classes) = @_;
3777 @classes = get_branch_refs() unless @classes;
3778 my @patterns = map { "refs/$_" } @classes;
3779 my @headslist;
3781 open my $fd, '-|', git_cmd(), 'for-each-ref',
3782 ($limit ? '--count='.($limit+1) : ()),
3783 '--sort=-HEAD', '--sort=-committerdate',
3784 '--format=%(objectname) %(refname) %(subject)%00%(committer)',
3785 @patterns
3786 or return;
3787 while (my $line = <$fd>) {
3788 my %ref_item;
3790 chomp $line;
3791 my ($refinfo, $committerinfo) = split(/\0/, $line);
3792 my ($hash, $name, $title) = split(' ', $refinfo, 3);
3793 my ($committer, $epoch, $tz) =
3794 ($committerinfo =~ /^(.*) ([0-9]+) (.*)$/);
3795 $ref_item{'fullname'} = $name;
3796 my $strip_refs = join '|', map { quotemeta } get_branch_refs();
3797 $name =~ s!^refs/($strip_refs|remotes)/!!;
3798 $ref_item{'name'} = $name;
3799 # for refs neither in 'heads' nor 'remotes' we want to
3800 # show their ref dir
3801 my $ref_dir = (defined $1) ? $1 : '';
3802 if ($ref_dir ne '' and $ref_dir ne 'heads' and $ref_dir ne 'remotes') {
3803 $ref_item{'name'} .= ' (' . $ref_dir . ')';
3806 $ref_item{'id'} = $hash;
3807 $ref_item{'title'} = $title || '(no commit message)';
3808 $ref_item{'epoch'} = $epoch;
3809 if ($epoch) {
3810 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3811 } else {
3812 $ref_item{'age'} = "unknown";
3815 push @headslist, \%ref_item;
3817 close $fd;
3819 return wantarray ? @headslist : \@headslist;
3822 sub git_get_tags_list {
3823 my $limit = shift;
3824 my @tagslist;
3826 open my $fd, '-|', git_cmd(), 'for-each-ref',
3827 ($limit ? '--count='.($limit+1) : ()), '--sort=-creatordate',
3828 '--format=%(objectname) %(objecttype) %(refname) '.
3829 '%(*objectname) %(*objecttype) %(subject)%00%(creator)',
3830 'refs/tags'
3831 or return;
3832 while (my $line = <$fd>) {
3833 my %ref_item;
3835 chomp $line;
3836 my ($refinfo, $creatorinfo) = split(/\0/, $line);
3837 my ($id, $type, $name, $refid, $reftype, $title) = split(' ', $refinfo, 6);
3838 my ($creator, $epoch, $tz) =
3839 ($creatorinfo =~ /^(.*) ([0-9]+) (.*)$/);
3840 $ref_item{'fullname'} = $name;
3841 $name =~ s!^refs/tags/!!;
3843 $ref_item{'type'} = $type;
3844 $ref_item{'id'} = $id;
3845 $ref_item{'name'} = $name;
3846 if ($type eq "tag") {
3847 $ref_item{'subject'} = $title;
3848 $ref_item{'reftype'} = $reftype;
3849 $ref_item{'refid'} = $refid;
3850 } else {
3851 $ref_item{'reftype'} = $type;
3852 $ref_item{'refid'} = $id;
3855 if ($type eq "tag" || $type eq "commit") {
3856 $ref_item{'epoch'} = $epoch;
3857 if ($epoch) {
3858 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3859 } else {
3860 $ref_item{'age'} = "unknown";
3864 push @tagslist, \%ref_item;
3866 close $fd;
3868 return wantarray ? @tagslist : \@tagslist;
3871 ## ----------------------------------------------------------------------
3872 ## filesystem-related functions
3874 sub get_file_owner {
3875 my $path = shift;
3877 my ($dev, $ino, $mode, $nlink, $st_uid, $st_gid, $rdev, $size) = stat($path);
3878 my ($name, $passwd, $uid, $gid, $quota, $comment, $gcos, $dir, $shell) = getpwuid($st_uid);
3879 if (!defined $gcos) {
3880 return undef;
3882 my $owner = $gcos;
3883 $owner =~ s/[,;].*$//;
3884 return to_utf8($owner);
3887 # assume that file exists
3888 sub insert_file {
3889 my $filename = shift;
3891 open my $fd, '<', $filename;
3892 print map { to_utf8($_) } <$fd>;
3893 close $fd;
3896 ## ......................................................................
3897 ## mimetype related functions
3899 sub mimetype_guess_file {
3900 my $filename = shift;
3901 my $mimemap = shift;
3902 -r $mimemap or return undef;
3904 my %mimemap;
3905 open(my $mh, '<', $mimemap) or return undef;
3906 while (<$mh>) {
3907 next if m/^#/; # skip comments
3908 my ($mimetype, @exts) = split(/\s+/);
3909 foreach my $ext (@exts) {
3910 $mimemap{$ext} = $mimetype;
3913 close($mh);
3915 $filename =~ /\.([^.]*)$/;
3916 return $mimemap{$1};
3919 sub mimetype_guess {
3920 my $filename = shift;
3921 my $mime;
3922 $filename =~ /\./ or return undef;
3924 if ($mimetypes_file) {
3925 my $file = $mimetypes_file;
3926 if ($file !~ m!^/!) { # if it is relative path
3927 # it is relative to project
3928 $file = "$projectroot/$project/$file";
3930 $mime = mimetype_guess_file($filename, $file);
3932 $mime ||= mimetype_guess_file($filename, '/etc/mime.types');
3933 return $mime;
3936 sub blob_mimetype {
3937 my $fd = shift;
3938 my $filename = shift;
3940 if ($filename) {
3941 my $mime = mimetype_guess($filename);
3942 $mime and return $mime;
3945 # just in case
3946 return $default_blob_plain_mimetype unless $fd;
3948 if (-T $fd) {
3949 return 'text/plain';
3950 } elsif (! $filename) {
3951 return 'application/octet-stream';
3952 } elsif ($filename =~ m/\.png$/i) {
3953 return 'image/png';
3954 } elsif ($filename =~ m/\.gif$/i) {
3955 return 'image/gif';
3956 } elsif ($filename =~ m/\.jpe?g$/i) {
3957 return 'image/jpeg';
3958 } else {
3959 return 'application/octet-stream';
3963 sub blob_contenttype {
3964 my ($fd, $file_name, $type) = @_;
3966 $type ||= blob_mimetype($fd, $file_name);
3967 if ($type eq 'text/plain' && defined $default_text_plain_charset) {
3968 $type .= "; charset=$default_text_plain_charset";
3971 return $type;
3974 # guess file syntax for syntax highlighting; return undef if no highlighting
3975 # the name of syntax can (in the future) depend on syntax highlighter used
3976 sub guess_file_syntax {
3977 my ($highlight, $file_name) = @_;
3978 return undef unless ($highlight && defined $file_name);
3979 my $basename = basename($file_name, '.in');
3980 return $highlight_basename{$basename}
3981 if exists $highlight_basename{$basename};
3983 $basename =~ /\.([^.]*)$/;
3984 my $ext = $1 or return undef;
3985 return $highlight_ext{$ext}
3986 if exists $highlight_ext{$ext};
3988 return undef;
3991 # run highlighter and return FD of its output,
3992 # or return original FD if no highlighting
3993 sub run_highlighter {
3994 my ($fd, $highlight, $syntax) = @_;
3995 return $fd unless ($highlight);
3997 close $fd;
3998 my $syntax_arg = (defined $syntax) ? "--syntax $syntax" : "--force";
3999 open $fd, quote_command(git_cmd(), "cat-file", "blob", $hash)." | ".
4000 quote_command($^X, '-CO', '-MEncode=decode,FB_DEFAULT', '-pse',
4001 '$_ = decode($fe, $_, FB_DEFAULT) if !utf8::decode($_);',
4002 '--', "-fe=$fallback_encoding")." | ".
4003 quote_command($highlight_bin).
4004 " --replace-tabs=8 --fragment $syntax_arg |"
4005 or die_error(500, "Couldn't open file or run syntax highlighter");
4006 return $fd;
4009 ## ======================================================================
4010 ## functions printing HTML: header, footer, error page
4012 sub get_page_title {
4013 my $title = to_utf8($site_name);
4015 unless (defined $project) {
4016 if (defined $project_filter) {
4017 $title .= " - projects in '" . esc_path($project_filter) . "'";
4019 return $title;
4021 $title .= " - " . to_utf8($project);
4023 return $title unless (defined $action);
4024 $title .= "/$action"; # $action is US-ASCII (7bit ASCII)
4026 return $title unless (defined $file_name);
4027 $title .= " - " . esc_path($file_name);
4028 if ($action eq "tree" && $file_name !~ m|/$|) {
4029 $title .= "/";
4032 return $title;
4035 sub get_content_type_html {
4036 # require explicit support from the UA if we are to send the page as
4037 # 'application/xhtml+xml', otherwise send it as plain old 'text/html'.
4038 # we have to do this because MSIE sometimes globs '*/*', pretending to
4039 # support xhtml+xml but choking when it gets what it asked for.
4040 if (defined $cgi->http('HTTP_ACCEPT') &&
4041 $cgi->http('HTTP_ACCEPT') =~ m/(,|;|\s|^)application\/xhtml\+xml(,|;|\s|$)/ &&
4042 $cgi->Accept('application/xhtml+xml') != 0) {
4043 return 'application/xhtml+xml';
4044 } else {
4045 return 'text/html';
4049 sub print_feed_meta {
4050 if (defined $project) {
4051 my %href_params = get_feed_info();
4052 if (!exists $href_params{'-title'}) {
4053 $href_params{'-title'} = 'log';
4056 foreach my $format (qw(RSS Atom)) {
4057 my $type = lc($format);
4058 my %link_attr = (
4059 '-rel' => 'alternate',
4060 '-title' => esc_attr("$project - $href_params{'-title'} - $format feed"),
4061 '-type' => "application/$type+xml"
4064 $href_params{'extra_options'} = undef;
4065 $href_params{'action'} = $type;
4066 $link_attr{'-href'} = esc_attr(href(%href_params));
4067 print "<link ".
4068 "rel=\"$link_attr{'-rel'}\" ".
4069 "title=\"$link_attr{'-title'}\" ".
4070 "href=\"$link_attr{'-href'}\" ".
4071 "type=\"$link_attr{'-type'}\" ".
4072 "/>\n";
4074 $href_params{'extra_options'} = '--no-merges';
4075 $link_attr{'-href'} = esc_attr(href(%href_params));
4076 $link_attr{'-title'} .= ' (no merges)';
4077 print "<link ".
4078 "rel=\"$link_attr{'-rel'}\" ".
4079 "title=\"$link_attr{'-title'}\" ".
4080 "href=\"$link_attr{'-href'}\" ".
4081 "type=\"$link_attr{'-type'}\" ".
4082 "/>\n";
4085 } else {
4086 printf('<link rel="alternate" title="%s projects list" '.
4087 'href="%s" type="text/plain; charset=utf-8" />'."\n",
4088 esc_attr($site_name),
4089 esc_attr(href(project=>undef, action=>"project_index")));
4090 printf('<link rel="alternate" title="%s projects feeds" '.
4091 'href="%s" type="text/x-opml" />'."\n",
4092 esc_attr($site_name),
4093 esc_attr(href(project=>undef, action=>"opml")));
4097 sub print_header_links {
4098 my $status = shift;
4100 # print out each stylesheet that exist, providing backwards capability
4101 # for those people who defined $stylesheet in a config file
4102 if (defined $stylesheet) {
4103 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
4104 } else {
4105 foreach my $stylesheet (@stylesheets) {
4106 next unless $stylesheet;
4107 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
4110 print_feed_meta()
4111 if ($status eq '200 OK');
4112 if (defined $favicon) {
4113 print qq(<link rel="shortcut icon" href=").esc_url($favicon).qq(" type="image/png" />\n);
4117 sub print_nav_breadcrumbs_path {
4118 my $dirprefix = undef;
4119 while (my $part = shift) {
4120 $dirprefix .= "/" if defined $dirprefix;
4121 $dirprefix .= $part;
4122 print $cgi->a({-href => href(project => undef,
4123 project_filter => $dirprefix,
4124 action => "project_list")},
4125 esc_html($part)) . " / ";
4129 sub print_nav_breadcrumbs {
4130 my %opts = @_;
4132 for my $crumb (@extra_breadcrumbs, [ $home_link_str => $home_link ]) {
4133 print $cgi->a({-href => esc_url($crumb->[1])}, $crumb->[0]) . " / ";
4135 if (defined $project) {
4136 my @dirname = split '/', $project;
4137 my $projectbasename = pop @dirname;
4138 print_nav_breadcrumbs_path(@dirname);
4139 print $cgi->a({-href => href(action=>"summary")}, esc_html($projectbasename));
4140 if (defined $action) {
4141 my $action_print = $action ;
4142 if (defined $opts{-action_extra}) {
4143 $action_print = $cgi->a({-href => href(action=>$action)},
4144 $action);
4146 print " / $action_print";
4148 if (defined $opts{-action_extra}) {
4149 print " / $opts{-action_extra}";
4151 print "\n";
4152 } elsif (defined $project_filter) {
4153 print_nav_breadcrumbs_path(split '/', $project_filter);
4157 sub print_search_form {
4158 if (!defined $searchtext) {
4159 $searchtext = "";
4161 my $search_hash;
4162 if (defined $hash_base) {
4163 $search_hash = $hash_base;
4164 } elsif (defined $hash) {
4165 $search_hash = $hash;
4166 } else {
4167 $search_hash = "HEAD";
4169 my $action = $my_uri;
4170 my $use_pathinfo = gitweb_check_feature('pathinfo');
4171 if ($use_pathinfo) {
4172 $action .= "/".esc_url($project);
4174 print $cgi->start_form(-method => "get", -action => $action) .
4175 "<div class=\"search\">\n" .
4176 (!$use_pathinfo &&
4177 $cgi->input({-name=>"p", -value=>$project, -type=>"hidden"}) . "\n") .
4178 $cgi->input({-name=>"a", -value=>"search", -type=>"hidden"}) . "\n" .
4179 $cgi->input({-name=>"h", -value=>$search_hash, -type=>"hidden"}) . "\n" .
4180 $cgi->popup_menu(-name => 'st', -default => 'commit',
4181 -values => ['commit', 'grep', 'author', 'committer', 'pickaxe']) .
4182 " " . $cgi->a({-href => href(action=>"search_help"),
4183 -title => "search help" }, "?") . " search:\n",
4184 $cgi->textfield(-name => "s", -value => $searchtext, -override => 1) . "\n" .
4185 "<span title=\"Extended regular expression\">" .
4186 $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
4187 -checked => $search_use_regexp) .
4188 "</span>" .
4189 "</div>" .
4190 $cgi->end_form() . "\n";
4193 sub git_header_html {
4194 my $status = shift || "200 OK";
4195 my $expires = shift;
4196 my %opts = @_;
4198 my $title = get_page_title();
4199 print $cgi->header(-type=>get_content_type_html(), -charset => 'utf-8',
4200 -status=> $status, -expires => $expires)
4201 unless ($opts{'-no_http_header'});
4202 my $mod_perl_version = $ENV{'MOD_PERL'} ? " $ENV{'MOD_PERL'}" : '';
4203 print <<EOF;
4204 <?xml version="1.0" encoding="utf-8"?>
4205 <!DOCTYPE html [
4206 <!ENTITY nbsp "&#xA0;">
4207 <!ENTITY sdot "&#x22C5;">
4209 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
4210 <!-- git web interface version $version, (C) 2005-2006, Kay Sievers <kay.sievers\@vrfy.org>, Christian Gierke -->
4211 <!-- git core binaries version $git_version -->
4212 <head>
4213 <meta name="generator" content="gitweb/$version git/$git_version$mod_perl_version"/>
4214 <meta name="robots" content="index, nofollow"/>
4215 <title>$title</title>
4217 # the stylesheet, favicon etc urls won't work correctly with path_info
4218 # unless we set the appropriate base URL
4219 if ($ENV{'PATH_INFO'}) {
4220 print "<base href=\"".esc_url($base_url)."\" />\n";
4222 print_header_links($status);
4224 if (defined $site_html_head_string) {
4225 print to_utf8($site_html_head_string);
4228 print "</head>\n" .
4229 "<body>\n";
4231 if (defined $site_header && -f $site_header) {
4232 insert_file($site_header);
4235 print "<div class=\"page_header\">\n";
4236 if (defined $logo) {
4237 print $cgi->a({-href => esc_url($logo_url),
4238 -title => $logo_label},
4239 $cgi->img({-src => esc_url($logo),
4240 -width => 72, -height => 27,
4241 -alt => "git",
4242 -class => "logo"}));
4244 print_nav_breadcrumbs(%opts);
4245 print "</div>\n";
4247 my $have_search = gitweb_check_feature('search');
4248 if (defined $project && $have_search) {
4249 print_search_form();
4253 sub git_footer_html {
4254 my $feed_class = 'rss_logo';
4256 print "<div class=\"page_footer\">\n";
4257 if (defined $project) {
4258 my $descr = git_get_project_description($project);
4259 if (defined $descr) {
4260 print "<div class=\"page_footer_text\">" . esc_html($descr) . "</div>\n";
4263 my %href_params = get_feed_info();
4264 if (!%href_params) {
4265 $feed_class .= ' generic';
4267 $href_params{'-title'} ||= 'log';
4269 foreach my $format (qw(RSS Atom)) {
4270 $href_params{'action'} = lc($format);
4271 print $cgi->a({-href => href(%href_params),
4272 -title => "$href_params{'-title'} $format feed",
4273 -class => $feed_class}, $format)."\n";
4276 } else {
4277 print $cgi->a({-href => href(project=>undef, action=>"opml",
4278 project_filter => $project_filter),
4279 -class => $feed_class}, "OPML") . " ";
4280 print $cgi->a({-href => href(project=>undef, action=>"project_index",
4281 project_filter => $project_filter),
4282 -class => $feed_class}, "TXT") . "\n";
4284 print "</div>\n"; # class="page_footer"
4286 if (defined $t0 && gitweb_check_feature('timed')) {
4287 print "<div id=\"generating_info\">\n";
4288 print 'This page took '.
4289 '<span id="generating_time" class="time_span">'.
4290 tv_interval($t0, [ gettimeofday() ]).
4291 ' seconds </span>'.
4292 ' and '.
4293 '<span id="generating_cmd">'.
4294 $number_of_git_cmds.
4295 '</span> git commands '.
4296 " to generate.\n";
4297 print "</div>\n"; # class="page_footer"
4300 if (defined $site_footer && -f $site_footer) {
4301 insert_file($site_footer);
4304 print qq!<script type="text/javascript" src="!.esc_url($javascript).qq!"></script>\n!;
4305 if (defined $action &&
4306 $action eq 'blame_incremental') {
4307 print qq!<script type="text/javascript">\n!.
4308 qq!startBlame("!. esc_attr(href(action=>"blame_data", -replay=>1)) .qq!",\n!.
4309 qq! "!. esc_attr(href()) .qq!");\n!.
4310 qq!</script>\n!;
4311 } else {
4312 my ($jstimezone, $tz_cookie, $datetime_class) =
4313 gitweb_get_feature('javascript-timezone');
4315 print qq!<script type="text/javascript">\n!.
4316 qq!window.onload = function () {\n!;
4317 if (gitweb_check_feature('javascript-actions')) {
4318 print qq! fixLinks();\n!;
4320 if ($jstimezone && $tz_cookie && $datetime_class) {
4321 print qq! var tz_cookie = { name: '$tz_cookie', expires: 14, path: '/' };\n!. # in days
4322 qq! onloadTZSetup('$jstimezone', tz_cookie, '$datetime_class');\n!;
4324 print qq!};\n!.
4325 qq!</script>\n!;
4328 print "</body>\n" .
4329 "</html>";
4332 # die_error(<http_status_code>, <error_message>[, <detailed_html_description>])
4333 # Example: die_error(404, 'Hash not found')
4334 # By convention, use the following status codes (as defined in RFC 2616):
4335 # 400: Invalid or missing CGI parameters, or
4336 # requested object exists but has wrong type.
4337 # 403: Requested feature (like "pickaxe" or "snapshot") not enabled on
4338 # this server or project.
4339 # 404: Requested object/revision/project doesn't exist.
4340 # 500: The server isn't configured properly, or
4341 # an internal error occurred (e.g. failed assertions caused by bugs), or
4342 # an unknown error occurred (e.g. the git binary died unexpectedly).
4343 # 503: The server is currently unavailable (because it is overloaded,
4344 # or down for maintenance). Generally, this is a temporary state.
4345 sub die_error {
4346 my $status = shift || 500;
4347 my $error = esc_html(shift) || "Internal Server Error";
4348 my $extra = shift;
4349 my %opts = @_;
4351 my %http_responses = (
4352 400 => '400 Bad Request',
4353 403 => '403 Forbidden',
4354 404 => '404 Not Found',
4355 500 => '500 Internal Server Error',
4356 503 => '503 Service Unavailable',
4358 git_header_html($http_responses{$status}, undef, %opts);
4359 print <<EOF;
4360 <div class="page_body">
4361 <br /><br />
4362 $status - $error
4363 <br />
4365 if (defined $extra) {
4366 print "<hr />\n" .
4367 "$extra\n";
4369 print "</div>\n";
4371 git_footer_html();
4372 goto DONE_GITWEB
4373 unless ($opts{'-error_handler'});
4376 ## ----------------------------------------------------------------------
4377 ## functions printing or outputting HTML: navigation
4379 sub git_print_page_nav {
4380 my ($current, $suppress, $head, $treehead, $treebase, $extra) = @_;
4381 $extra = '' if !defined $extra; # pager or formats
4383 my @navs = qw(summary shortlog log commit commitdiff tree);
4384 if ($suppress) {
4385 @navs = grep { $_ ne $suppress } @navs;
4388 my %arg = map { $_ => {action=>$_} } @navs;
4389 if (defined $head) {
4390 for (qw(commit commitdiff)) {
4391 $arg{$_}{'hash'} = $head;
4393 if ($current =~ m/^(tree | log | shortlog | commit | commitdiff | search)$/x) {
4394 for (qw(shortlog log)) {
4395 $arg{$_}{'hash'} = $head;
4400 $arg{'tree'}{'hash'} = $treehead if defined $treehead;
4401 $arg{'tree'}{'hash_base'} = $treebase if defined $treebase;
4403 my @actions = gitweb_get_feature('actions');
4404 my %repl = (
4405 '%' => '%',
4406 'n' => $project, # project name
4407 'f' => $git_dir, # project path within filesystem
4408 'h' => $treehead || '', # current hash ('h' parameter)
4409 'b' => $treebase || '', # hash base ('hb' parameter)
4411 while (@actions) {
4412 my ($label, $link, $pos) = splice(@actions,0,3);
4413 # insert
4414 @navs = map { $_ eq $pos ? ($_, $label) : $_ } @navs;
4415 # munch munch
4416 $link =~ s/%([%nfhb])/$repl{$1}/g;
4417 $arg{$label}{'_href'} = $link;
4420 print "<div class=\"page_nav\">\n" .
4421 (join " | ",
4422 map { $_ eq $current ?
4423 $_ : $cgi->a({-href => ($arg{$_}{_href} ? $arg{$_}{_href} : href(%{$arg{$_}}))}, "$_")
4424 } @navs);
4425 print "<br/>\n$extra<br/>\n" .
4426 "</div>\n";
4429 # returns a submenu for the navigation of the refs views (tags, heads,
4430 # remotes) with the current view disabled and the remotes view only
4431 # available if the feature is enabled
4432 sub format_ref_views {
4433 my ($current) = @_;
4434 my @ref_views = qw{tags heads};
4435 push @ref_views, 'remotes' if gitweb_check_feature('remote_heads');
4436 return join " | ", map {
4437 $_ eq $current ? $_ :
4438 $cgi->a({-href => href(action=>$_)}, $_)
4439 } @ref_views
4442 sub format_paging_nav {
4443 my ($action, $page, $has_next_link) = @_;
4444 my $paging_nav;
4447 if ($page > 0) {
4448 $paging_nav .=
4449 $cgi->a({-href => href(-replay=>1, page=>undef)}, "first") .
4450 " &sdot; " .
4451 $cgi->a({-href => href(-replay=>1, page=>$page-1),
4452 -accesskey => "p", -title => "Alt-p"}, "prev");
4453 } else {
4454 $paging_nav .= "first &sdot; prev";
4457 if ($has_next_link) {
4458 $paging_nav .= " &sdot; " .
4459 $cgi->a({-href => href(-replay=>1, page=>$page+1),
4460 -accesskey => "n", -title => "Alt-n"}, "next");
4461 } else {
4462 $paging_nav .= " &sdot; next";
4465 return $paging_nav;
4468 ## ......................................................................
4469 ## functions printing or outputting HTML: div
4471 sub git_print_header_div {
4472 my ($action, $title, $hash, $hash_base) = @_;
4473 my %args = ();
4475 $args{'action'} = $action;
4476 $args{'hash'} = $hash if $hash;
4477 $args{'hash_base'} = $hash_base if $hash_base;
4479 print "<div class=\"header\">\n" .
4480 $cgi->a({-href => href(%args), -class => "title"},
4481 $title ? $title : $action) .
4482 "\n</div>\n";
4485 sub format_repo_url {
4486 my ($name, $url) = @_;
4487 return "<tr class=\"metadata_url\"><td>$name</td><td>$url</td></tr>\n";
4490 # Group output by placing it in a DIV element and adding a header.
4491 # Options for start_div() can be provided by passing a hash reference as the
4492 # first parameter to the function.
4493 # Options to git_print_header_div() can be provided by passing an array
4494 # reference. This must follow the options to start_div if they are present.
4495 # The content can be a scalar, which is output as-is, a scalar reference, which
4496 # is output after html escaping, an IO handle passed either as *handle or
4497 # *handle{IO}, or a function reference. In the latter case all following
4498 # parameters will be taken as argument to the content function call.
4499 sub git_print_section {
4500 my ($div_args, $header_args, $content);
4501 my $arg = shift;
4502 if (ref($arg) eq 'HASH') {
4503 $div_args = $arg;
4504 $arg = shift;
4506 if (ref($arg) eq 'ARRAY') {
4507 $header_args = $arg;
4508 $arg = shift;
4510 $content = $arg;
4512 print $cgi->start_div($div_args);
4513 git_print_header_div(@$header_args);
4515 if (ref($content) eq 'CODE') {
4516 $content->(@_);
4517 } elsif (ref($content) eq 'SCALAR') {
4518 print esc_html($$content);
4519 } elsif (ref($content) eq 'GLOB' or ref($content) eq 'IO::Handle') {
4520 print <$content>;
4521 } elsif (!ref($content) && defined($content)) {
4522 print $content;
4525 print $cgi->end_div;
4528 sub format_timestamp_html {
4529 my $date = shift;
4530 my $strtime = $date->{'rfc2822'};
4532 my (undef, undef, $datetime_class) =
4533 gitweb_get_feature('javascript-timezone');
4534 if ($datetime_class) {
4535 $strtime = qq!<span class="$datetime_class">$strtime</span>!;
4538 my $localtime_format = '(%02d:%02d %s)';
4539 if ($date->{'hour_local'} < 6) {
4540 $localtime_format = '(<span class="atnight">%02d:%02d</span> %s)';
4542 $strtime .= ' ' .
4543 sprintf($localtime_format,
4544 $date->{'hour_local'}, $date->{'minute_local'}, $date->{'tz_local'});
4546 return $strtime;
4549 # Outputs the author name and date in long form
4550 sub git_print_authorship {
4551 my $co = shift;
4552 my %opts = @_;
4553 my $tag = $opts{-tag} || 'div';
4554 my $author = $co->{'author_name'};
4556 my %ad = parse_date($co->{'author_epoch'}, $co->{'author_tz'});
4557 print "<$tag class=\"author_date\">" .
4558 format_search_author($author, "author", esc_html($author)) .
4559 " [".format_timestamp_html(\%ad)."]".
4560 git_get_avatar($co->{'author_email'}, -pad_before => 1) .
4561 "</$tag>\n";
4564 # Outputs table rows containing the full author or committer information,
4565 # in the format expected for 'commit' view (& similar).
4566 # Parameters are a commit hash reference, followed by the list of people
4567 # to output information for. If the list is empty it defaults to both
4568 # author and committer.
4569 sub git_print_authorship_rows {
4570 my $co = shift;
4571 # too bad we can't use @people = @_ || ('author', 'committer')
4572 my @people = @_;
4573 @people = ('author', 'committer') unless @people;
4574 foreach my $who (@people) {
4575 my %wd = parse_date($co->{"${who}_epoch"}, $co->{"${who}_tz"});
4576 print "<tr><td>$who</td><td>" .
4577 format_search_author($co->{"${who}_name"}, $who,
4578 esc_html($co->{"${who}_name"})) . " " .
4579 format_search_author($co->{"${who}_email"}, $who,
4580 esc_html("<" . $co->{"${who}_email"} . ">")) .
4581 "</td><td rowspan=\"2\">" .
4582 git_get_avatar($co->{"${who}_email"}, -size => 'double') .
4583 "</td></tr>\n" .
4584 "<tr>" .
4585 "<td></td><td>" .
4586 format_timestamp_html(\%wd) .
4587 "</td>" .
4588 "</tr>\n";
4592 sub git_print_page_path {
4593 my $name = shift;
4594 my $type = shift;
4595 my $hb = shift;
4598 print "<div class=\"page_path\">";
4599 print $cgi->a({-href => href(action=>"tree", hash_base=>$hb),
4600 -title => 'tree root'}, to_utf8("[$project]"));
4601 print " / ";
4602 if (defined $name) {
4603 my @dirname = split '/', $name;
4604 my $basename = pop @dirname;
4605 my $fullname = '';
4607 foreach my $dir (@dirname) {
4608 $fullname .= ($fullname ? '/' : '') . $dir;
4609 print $cgi->a({-href => href(action=>"tree", file_name=>$fullname,
4610 hash_base=>$hb),
4611 -title => $fullname}, esc_path($dir));
4612 print " / ";
4614 if (defined $type && $type eq 'blob') {
4615 print $cgi->a({-href => href(action=>"blob_plain", file_name=>$file_name,
4616 hash_base=>$hb),
4617 -title => $name}, esc_path($basename));
4618 } elsif (defined $type && $type eq 'tree') {
4619 print $cgi->a({-href => href(action=>"tree", file_name=>$file_name,
4620 hash_base=>$hb),
4621 -title => $name}, esc_path($basename));
4622 print " / ";
4623 } else {
4624 print esc_path($basename);
4627 print "<br/></div>\n";
4630 sub git_print_log {
4631 my $log = shift;
4632 my %opts = @_;
4634 if ($opts{'-remove_title'}) {
4635 # remove title, i.e. first line of log
4636 shift @$log;
4638 # remove leading empty lines
4639 while (defined $log->[0] && $log->[0] eq "") {
4640 shift @$log;
4643 # print log
4644 my $skip_blank_line = 0;
4645 foreach my $line (@$log) {
4646 if ($line =~ m/^\s*([A-Z][-A-Za-z]*-([Bb]y|[Tt]o)|C[Cc]|(Clos|Fix)es): /) {
4647 if (! $opts{'-remove_signoff'}) {
4648 print "<span class=\"signoff\">" . esc_html($line) . "</span><br/>\n";
4649 $skip_blank_line = 1;
4651 next;
4654 if ($line =~ m,\s*([a-z]*link): (https?://\S+),i) {
4655 if (! $opts{'-remove_signoff'}) {
4656 print "<span class=\"signoff\">" . esc_html($1) . ": " .
4657 "<a href=\"" . esc_html($2) . "\">" . esc_html($2) . "</a>" .
4658 "</span><br/>\n";
4659 $skip_blank_line = 1;
4661 next;
4664 # print only one empty line
4665 # do not print empty line after signoff
4666 if ($line eq "") {
4667 next if ($skip_blank_line);
4668 $skip_blank_line = 1;
4669 } else {
4670 $skip_blank_line = 0;
4673 print format_log_line_html($line) . "<br/>\n";
4676 if ($opts{'-final_empty_line'}) {
4677 # end with single empty line
4678 print "<br/>\n" unless $skip_blank_line;
4682 # return link target (what link points to)
4683 sub git_get_link_target {
4684 my $hash = shift;
4685 my $link_target;
4687 # read link
4688 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
4689 or return;
4691 local $/ = undef;
4692 $link_target = <$fd>;
4694 close $fd
4695 or return;
4697 return $link_target;
4700 # given link target, and the directory (basedir) the link is in,
4701 # return target of link relative to top directory (top tree);
4702 # return undef if it is not possible (including absolute links).
4703 sub normalize_link_target {
4704 my ($link_target, $basedir) = @_;
4706 # absolute symlinks (beginning with '/') cannot be normalized
4707 return if (substr($link_target, 0, 1) eq '/');
4709 # normalize link target to path from top (root) tree (dir)
4710 my $path;
4711 if ($basedir) {
4712 $path = $basedir . '/' . $link_target;
4713 } else {
4714 # we are in top (root) tree (dir)
4715 $path = $link_target;
4718 # remove //, /./, and /../
4719 my @path_parts;
4720 foreach my $part (split('/', $path)) {
4721 # discard '.' and ''
4722 next if (!$part || $part eq '.');
4723 # handle '..'
4724 if ($part eq '..') {
4725 if (@path_parts) {
4726 pop @path_parts;
4727 } else {
4728 # link leads outside repository (outside top dir)
4729 return;
4731 } else {
4732 push @path_parts, $part;
4735 $path = join('/', @path_parts);
4737 return $path;
4740 # print tree entry (row of git_tree), but without encompassing <tr> element
4741 sub git_print_tree_entry {
4742 my ($t, $basedir, $hash_base, $have_blame) = @_;
4744 my %base_key = ();
4745 $base_key{'hash_base'} = $hash_base if defined $hash_base;
4747 # The format of a table row is: mode list link. Where mode is
4748 # the mode of the entry, list is the name of the entry, an href,
4749 # and link is the action links of the entry.
4751 print "<td class=\"mode\">" . mode_str($t->{'mode'}) . "</td>\n";
4752 if (exists $t->{'size'}) {
4753 print "<td class=\"size\">$t->{'size'}</td>\n";
4755 if ($t->{'type'} eq "blob") {
4756 print "<td class=\"list\">" .
4757 $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4758 file_name=>"$basedir$t->{'name'}", %base_key),
4759 -class => "list"}, esc_path($t->{'name'}));
4760 if (S_ISLNK(oct $t->{'mode'})) {
4761 my $link_target = git_get_link_target($t->{'hash'});
4762 if ($link_target) {
4763 my $norm_target = normalize_link_target($link_target, $basedir);
4764 if (defined $norm_target) {
4765 print " -> " .
4766 $cgi->a({-href => href(action=>"object", hash_base=>$hash_base,
4767 file_name=>$norm_target),
4768 -title => $norm_target}, esc_path($link_target));
4769 } else {
4770 print " -> " . esc_path($link_target);
4774 print "</td>\n";
4775 print "<td class=\"link\">";
4776 print $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4777 file_name=>"$basedir$t->{'name'}", %base_key)},
4778 "blob");
4779 if ($have_blame) {
4780 print " | " .
4781 $cgi->a({-href => href(action=>"blame", hash=>$t->{'hash'},
4782 file_name=>"$basedir$t->{'name'}", %base_key)},
4783 "blame");
4785 if (defined $hash_base) {
4786 print " | " .
4787 $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4788 hash=>$t->{'hash'}, file_name=>"$basedir$t->{'name'}")},
4789 "history");
4791 print " | " .
4792 $cgi->a({-href => href(action=>"blob_plain", hash_base=>$hash_base,
4793 file_name=>"$basedir$t->{'name'}")},
4794 "raw");
4795 print "</td>\n";
4797 } elsif ($t->{'type'} eq "tree") {
4798 print "<td class=\"list\">";
4799 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4800 file_name=>"$basedir$t->{'name'}",
4801 %base_key)},
4802 esc_path($t->{'name'}));
4803 print "</td>\n";
4804 print "<td class=\"link\">";
4805 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4806 file_name=>"$basedir$t->{'name'}",
4807 %base_key)},
4808 "tree");
4809 if (defined $hash_base) {
4810 print " | " .
4811 $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4812 file_name=>"$basedir$t->{'name'}")},
4813 "history");
4815 print "</td>\n";
4816 } else {
4817 # unknown object: we can only present history for it
4818 # (this includes 'commit' object, i.e. submodule support)
4819 print "<td class=\"list\">" .
4820 esc_path($t->{'name'}) .
4821 "</td>\n";
4822 print "<td class=\"link\">";
4823 if (defined $hash_base) {
4824 print $cgi->a({-href => href(action=>"history",
4825 hash_base=>$hash_base,
4826 file_name=>"$basedir$t->{'name'}")},
4827 "history");
4829 print "</td>\n";
4833 ## ......................................................................
4834 ## functions printing large fragments of HTML
4836 # get pre-image filenames for merge (combined) diff
4837 sub fill_from_file_info {
4838 my ($diff, @parents) = @_;
4840 $diff->{'from_file'} = [ ];
4841 $diff->{'from_file'}[$diff->{'nparents'} - 1] = undef;
4842 for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4843 if ($diff->{'status'}[$i] eq 'R' ||
4844 $diff->{'status'}[$i] eq 'C') {
4845 $diff->{'from_file'}[$i] =
4846 git_get_path_by_hash($parents[$i], $diff->{'from_id'}[$i]);
4850 return $diff;
4853 # is current raw difftree line of file deletion
4854 sub is_deleted {
4855 my $diffinfo = shift;
4857 return $diffinfo->{'to_id'} eq ('0' x 40) || $diffinfo->{'to_id'} eq ('0' x 64);
4860 # does patch correspond to [previous] difftree raw line
4861 # $diffinfo - hashref of parsed raw diff format
4862 # $patchinfo - hashref of parsed patch diff format
4863 # (the same keys as in $diffinfo)
4864 sub is_patch_split {
4865 my ($diffinfo, $patchinfo) = @_;
4867 return defined $diffinfo && defined $patchinfo
4868 && $diffinfo->{'to_file'} eq $patchinfo->{'to_file'};
4872 sub git_difftree_body {
4873 my ($difftree, $hash, @parents) = @_;
4874 my ($parent) = $parents[0];
4875 my $have_blame = gitweb_check_feature('blame');
4876 print "<div class=\"list_head\">\n";
4877 if ($#{$difftree} > 10) {
4878 print(($#{$difftree} + 1) . " files changed:\n");
4880 print "</div>\n";
4882 print "<table class=\"" .
4883 (@parents > 1 ? "combined " : "") .
4884 "diff_tree\">\n";
4886 # header only for combined diff in 'commitdiff' view
4887 my $has_header = @$difftree && @parents > 1 && $action eq 'commitdiff';
4888 if ($has_header) {
4889 # table header
4890 print "<thead><tr>\n" .
4891 "<th></th><th></th>\n"; # filename, patchN link
4892 for (my $i = 0; $i < @parents; $i++) {
4893 my $par = $parents[$i];
4894 print "<th>" .
4895 $cgi->a({-href => href(action=>"commitdiff",
4896 hash=>$hash, hash_parent=>$par),
4897 -title => 'commitdiff to parent number ' .
4898 ($i+1) . ': ' . substr($par,0,7)},
4899 $i+1) .
4900 "&nbsp;</th>\n";
4902 print "</tr></thead>\n<tbody>\n";
4905 my $alternate = 1;
4906 my $patchno = 0;
4907 foreach my $line (@{$difftree}) {
4908 my $diff = parsed_difftree_line($line);
4910 if ($alternate) {
4911 print "<tr class=\"dark\">\n";
4912 } else {
4913 print "<tr class=\"light\">\n";
4915 $alternate ^= 1;
4917 if (exists $diff->{'nparents'}) { # combined diff
4919 fill_from_file_info($diff, @parents)
4920 unless exists $diff->{'from_file'};
4922 if (!is_deleted($diff)) {
4923 # file exists in the result (child) commit
4924 print "<td>" .
4925 $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4926 file_name=>$diff->{'to_file'},
4927 hash_base=>$hash),
4928 -class => "list"}, esc_path($diff->{'to_file'})) .
4929 "</td>\n";
4930 } else {
4931 print "<td>" .
4932 esc_path($diff->{'to_file'}) .
4933 "</td>\n";
4936 if ($action eq 'commitdiff') {
4937 # link to patch
4938 $patchno++;
4939 print "<td class=\"link\">" .
4940 $cgi->a({-href => href(-anchor=>"patch$patchno")},
4941 "patch") .
4942 " | " .
4943 "</td>\n";
4946 my $has_history = 0;
4947 my $not_deleted = 0;
4948 for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4949 my $hash_parent = $parents[$i];
4950 my $from_hash = $diff->{'from_id'}[$i];
4951 my $from_path = $diff->{'from_file'}[$i];
4952 my $status = $diff->{'status'}[$i];
4954 $has_history ||= ($status ne 'A');
4955 $not_deleted ||= ($status ne 'D');
4957 if ($status eq 'A') {
4958 print "<td class=\"link\" align=\"right\"> | </td>\n";
4959 } elsif ($status eq 'D') {
4960 print "<td class=\"link\">" .
4961 $cgi->a({-href => href(action=>"blob",
4962 hash_base=>$hash,
4963 hash=>$from_hash,
4964 file_name=>$from_path)},
4965 "blob" . ($i+1)) .
4966 " | </td>\n";
4967 } else {
4968 if ($diff->{'to_id'} eq $from_hash) {
4969 print "<td class=\"link nochange\">";
4970 } else {
4971 print "<td class=\"link\">";
4973 print $cgi->a({-href => href(action=>"blobdiff",
4974 hash=>$diff->{'to_id'},
4975 hash_parent=>$from_hash,
4976 hash_base=>$hash,
4977 hash_parent_base=>$hash_parent,
4978 file_name=>$diff->{'to_file'},
4979 file_parent=>$from_path)},
4980 "diff" . ($i+1)) .
4981 " | </td>\n";
4985 print "<td class=\"link\">";
4986 if ($not_deleted) {
4987 print $cgi->a({-href => href(action=>"blob",
4988 hash=>$diff->{'to_id'},
4989 file_name=>$diff->{'to_file'},
4990 hash_base=>$hash)},
4991 "blob");
4992 print " | " if ($has_history);
4994 if ($has_history) {
4995 print $cgi->a({-href => href(action=>"history",
4996 file_name=>$diff->{'to_file'},
4997 hash_base=>$hash)},
4998 "history");
5000 print "</td>\n";
5002 print "</tr>\n";
5003 next; # instead of 'else' clause, to avoid extra indent
5005 # else ordinary diff
5007 my ($to_mode_oct, $to_mode_str, $to_file_type);
5008 my ($from_mode_oct, $from_mode_str, $from_file_type);
5009 if ($diff->{'to_mode'} ne ('0' x 6)) {
5010 $to_mode_oct = oct $diff->{'to_mode'};
5011 if (S_ISREG($to_mode_oct)) { # only for regular file
5012 $to_mode_str = sprintf("%04o", $to_mode_oct & 0777); # permission bits
5014 $to_file_type = file_type($diff->{'to_mode'});
5016 if ($diff->{'from_mode'} ne ('0' x 6)) {
5017 $from_mode_oct = oct $diff->{'from_mode'};
5018 if (S_ISREG($from_mode_oct)) { # only for regular file
5019 $from_mode_str = sprintf("%04o", $from_mode_oct & 0777); # permission bits
5021 $from_file_type = file_type($diff->{'from_mode'});
5024 if ($diff->{'status'} eq "A") { # created
5025 my $mode_chng = "<span class=\"file_status new\">[new $to_file_type";
5026 $mode_chng .= " with mode: $to_mode_str" if $to_mode_str;
5027 $mode_chng .= "]</span>";
5028 print "<td>";
5029 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5030 hash_base=>$hash, file_name=>$diff->{'file'}),
5031 -class => "list"}, esc_path($diff->{'file'}));
5032 print "</td>\n";
5033 print "<td>$mode_chng</td>\n";
5034 print "<td class=\"link\">";
5035 if ($action eq 'commitdiff') {
5036 # link to patch
5037 $patchno++;
5038 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5039 "patch") .
5040 " | ";
5042 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5043 hash_base=>$hash, file_name=>$diff->{'file'})},
5044 "blob");
5045 print "</td>\n";
5047 } elsif ($diff->{'status'} eq "D") { # deleted
5048 my $mode_chng = "<span class=\"file_status deleted\">[deleted $from_file_type]</span>";
5049 print "<td>";
5050 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
5051 hash_base=>$parent, file_name=>$diff->{'file'}),
5052 -class => "list"}, esc_path($diff->{'file'}));
5053 print "</td>\n";
5054 print "<td>$mode_chng</td>\n";
5055 print "<td class=\"link\">";
5056 if ($action eq 'commitdiff') {
5057 # link to patch
5058 $patchno++;
5059 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5060 "patch") .
5061 " | ";
5063 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
5064 hash_base=>$parent, file_name=>$diff->{'file'})},
5065 "blob") . " | ";
5066 if ($have_blame) {
5067 print $cgi->a({-href => href(action=>"blame", hash_base=>$parent,
5068 file_name=>$diff->{'file'})},
5069 "blame") . " | ";
5071 print $cgi->a({-href => href(action=>"history", hash_base=>$parent,
5072 file_name=>$diff->{'file'})},
5073 "history");
5074 print "</td>\n";
5076 } elsif ($diff->{'status'} eq "M" || $diff->{'status'} eq "T") { # modified, or type changed
5077 my $mode_chnge = "";
5078 if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
5079 $mode_chnge = "<span class=\"file_status mode_chnge\">[changed";
5080 if ($from_file_type ne $to_file_type) {
5081 $mode_chnge .= " from $from_file_type to $to_file_type";
5083 if (($from_mode_oct & 0777) != ($to_mode_oct & 0777)) {
5084 if ($from_mode_str && $to_mode_str) {
5085 $mode_chnge .= " mode: $from_mode_str->$to_mode_str";
5086 } elsif ($to_mode_str) {
5087 $mode_chnge .= " mode: $to_mode_str";
5090 $mode_chnge .= "]</span>\n";
5092 print "<td>";
5093 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5094 hash_base=>$hash, file_name=>$diff->{'file'}),
5095 -class => "list"}, esc_path($diff->{'file'}));
5096 print "</td>\n";
5097 print "<td>$mode_chnge</td>\n";
5098 print "<td class=\"link\">";
5099 if ($action eq 'commitdiff') {
5100 # link to patch
5101 $patchno++;
5102 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5103 "patch") .
5104 " | ";
5105 } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
5106 # "commit" view and modified file (not onlu mode changed)
5107 print $cgi->a({-href => href(action=>"blobdiff",
5108 hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
5109 hash_base=>$hash, hash_parent_base=>$parent,
5110 file_name=>$diff->{'file'})},
5111 "diff") .
5112 " | ";
5114 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5115 hash_base=>$hash, file_name=>$diff->{'file'})},
5116 "blob") . " | ";
5117 if ($have_blame) {
5118 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
5119 file_name=>$diff->{'file'})},
5120 "blame") . " | ";
5122 print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
5123 file_name=>$diff->{'file'})},
5124 "history");
5125 print "</td>\n";
5127 } elsif ($diff->{'status'} eq "R" || $diff->{'status'} eq "C") { # renamed or copied
5128 my %status_name = ('R' => 'moved', 'C' => 'copied');
5129 my $nstatus = $status_name{$diff->{'status'}};
5130 my $mode_chng = "";
5131 if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
5132 # mode also for directories, so we cannot use $to_mode_str
5133 $mode_chng = sprintf(", mode: %04o", $to_mode_oct & 0777);
5135 print "<td>" .
5136 $cgi->a({-href => href(action=>"blob", hash_base=>$hash,
5137 hash=>$diff->{'to_id'}, file_name=>$diff->{'to_file'}),
5138 -class => "list"}, esc_path($diff->{'to_file'})) . "</td>\n" .
5139 "<td><span class=\"file_status $nstatus\">[$nstatus from " .
5140 $cgi->a({-href => href(action=>"blob", hash_base=>$parent,
5141 hash=>$diff->{'from_id'}, file_name=>$diff->{'from_file'}),
5142 -class => "list"}, esc_path($diff->{'from_file'})) .
5143 " with " . (int $diff->{'similarity'}) . "% similarity$mode_chng]</span></td>\n" .
5144 "<td class=\"link\">";
5145 if ($action eq 'commitdiff') {
5146 # link to patch
5147 $patchno++;
5148 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5149 "patch") .
5150 " | ";
5151 } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
5152 # "commit" view and modified file (not only pure rename or copy)
5153 print $cgi->a({-href => href(action=>"blobdiff",
5154 hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
5155 hash_base=>$hash, hash_parent_base=>$parent,
5156 file_name=>$diff->{'to_file'}, file_parent=>$diff->{'from_file'})},
5157 "diff") .
5158 " | ";
5160 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5161 hash_base=>$parent, file_name=>$diff->{'to_file'})},
5162 "blob") . " | ";
5163 if ($have_blame) {
5164 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
5165 file_name=>$diff->{'to_file'})},
5166 "blame") . " | ";
5168 print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
5169 file_name=>$diff->{'to_file'})},
5170 "history");
5171 print "</td>\n";
5173 } # we should not encounter Unmerged (U) or Unknown (X) status
5174 print "</tr>\n";
5176 print "</tbody>" if $has_header;
5177 print "</table>\n";
5180 # Print context lines and then rem/add lines in a side-by-side manner.
5181 sub print_sidebyside_diff_lines {
5182 my ($ctx, $rem, $add) = @_;
5184 # print context block before add/rem block
5185 if (@$ctx) {
5186 print join '',
5187 '<div class="chunk_block ctx">',
5188 '<div class="old">',
5189 @$ctx,
5190 '</div>',
5191 '<div class="new">',
5192 @$ctx,
5193 '</div>',
5194 '</div>';
5197 if (!@$add) {
5198 # pure removal
5199 print join '',
5200 '<div class="chunk_block rem">',
5201 '<div class="old">',
5202 @$rem,
5203 '</div>',
5204 '</div>';
5205 } elsif (!@$rem) {
5206 # pure addition
5207 print join '',
5208 '<div class="chunk_block add">',
5209 '<div class="new">',
5210 @$add,
5211 '</div>',
5212 '</div>';
5213 } else {
5214 print join '',
5215 '<div class="chunk_block chg">',
5216 '<div class="old">',
5217 @$rem,
5218 '</div>',
5219 '<div class="new">',
5220 @$add,
5221 '</div>',
5222 '</div>';
5226 # Print context lines and then rem/add lines in inline manner.
5227 sub print_inline_diff_lines {
5228 my ($ctx, $rem, $add) = @_;
5230 print @$ctx, @$rem, @$add;
5233 # Format removed and added line, mark changed part and HTML-format them.
5234 # Implementation is based on contrib/diff-highlight
5235 sub format_rem_add_lines_pair {
5236 my ($rem, $add, $num_parents) = @_;
5238 # We need to untabify lines before split()'ing them;
5239 # otherwise offsets would be invalid.
5240 chomp $rem;
5241 chomp $add;
5242 $rem = untabify($rem);
5243 $add = untabify($add);
5245 my @rem = split(//, $rem);
5246 my @add = split(//, $add);
5247 my ($esc_rem, $esc_add);
5248 # Ignore leading +/- characters for each parent.
5249 my ($prefix_len, $suffix_len) = ($num_parents, 0);
5250 my ($prefix_has_nonspace, $suffix_has_nonspace);
5252 my $shorter = (@rem < @add) ? @rem : @add;
5253 while ($prefix_len < $shorter) {
5254 last if ($rem[$prefix_len] ne $add[$prefix_len]);
5256 $prefix_has_nonspace = 1 if ($rem[$prefix_len] !~ /\s/);
5257 $prefix_len++;
5260 while ($prefix_len + $suffix_len < $shorter) {
5261 last if ($rem[-1 - $suffix_len] ne $add[-1 - $suffix_len]);
5263 $suffix_has_nonspace = 1 if ($rem[-1 - $suffix_len] !~ /\s/);
5264 $suffix_len++;
5267 # Mark lines that are different from each other, but have some common
5268 # part that isn't whitespace. If lines are completely different, don't
5269 # mark them because that would make output unreadable, especially if
5270 # diff consists of multiple lines.
5271 if ($prefix_has_nonspace || $suffix_has_nonspace) {
5272 $esc_rem = esc_html_hl_regions($rem, 'marked',
5273 [$prefix_len, @rem - $suffix_len], -nbsp=>1);
5274 $esc_add = esc_html_hl_regions($add, 'marked',
5275 [$prefix_len, @add - $suffix_len], -nbsp=>1);
5276 } else {
5277 $esc_rem = esc_html($rem, -nbsp=>1);
5278 $esc_add = esc_html($add, -nbsp=>1);
5281 return format_diff_line(\$esc_rem, 'rem'),
5282 format_diff_line(\$esc_add, 'add');
5285 # HTML-format diff context, removed and added lines.
5286 sub format_ctx_rem_add_lines {
5287 my ($ctx, $rem, $add, $num_parents) = @_;
5288 my (@new_ctx, @new_rem, @new_add);
5289 my $can_highlight = 0;
5290 my $is_combined = ($num_parents > 1);
5292 # Highlight if every removed line has a corresponding added line.
5293 if (@$add > 0 && @$add == @$rem) {
5294 $can_highlight = 1;
5296 # Highlight lines in combined diff only if the chunk contains
5297 # diff between the same version, e.g.
5299 # - a
5300 # - b
5301 # + c
5302 # + d
5304 # Otherwise the highlighting would be confusing.
5305 if ($is_combined) {
5306 for (my $i = 0; $i < @$add; $i++) {
5307 my $prefix_rem = substr($rem->[$i], 0, $num_parents);
5308 my $prefix_add = substr($add->[$i], 0, $num_parents);
5310 $prefix_rem =~ s/-/+/g;
5312 if ($prefix_rem ne $prefix_add) {
5313 $can_highlight = 0;
5314 last;
5320 if ($can_highlight) {
5321 for (my $i = 0; $i < @$add; $i++) {
5322 my ($line_rem, $line_add) = format_rem_add_lines_pair(
5323 $rem->[$i], $add->[$i], $num_parents);
5324 push @new_rem, $line_rem;
5325 push @new_add, $line_add;
5327 } else {
5328 @new_rem = map { format_diff_line($_, 'rem') } @$rem;
5329 @new_add = map { format_diff_line($_, 'add') } @$add;
5332 @new_ctx = map { format_diff_line($_, 'ctx') } @$ctx;
5334 return (\@new_ctx, \@new_rem, \@new_add);
5337 # Print context lines and then rem/add lines.
5338 sub print_diff_lines {
5339 my ($ctx, $rem, $add, $diff_style, $num_parents) = @_;
5340 my $is_combined = $num_parents > 1;
5342 ($ctx, $rem, $add) = format_ctx_rem_add_lines($ctx, $rem, $add,
5343 $num_parents);
5345 if ($diff_style eq 'sidebyside' && !$is_combined) {
5346 print_sidebyside_diff_lines($ctx, $rem, $add);
5347 } else {
5348 # default 'inline' style and unknown styles
5349 print_inline_diff_lines($ctx, $rem, $add);
5353 sub print_diff_chunk {
5354 my ($diff_style, $num_parents, $from, $to, @chunk) = @_;
5355 my (@ctx, @rem, @add);
5357 # The class of the previous line.
5358 my $prev_class = '';
5360 return unless @chunk;
5362 # incomplete last line might be among removed or added lines,
5363 # or both, or among context lines: find which
5364 for (my $i = 1; $i < @chunk; $i++) {
5365 if ($chunk[$i][0] eq 'incomplete') {
5366 $chunk[$i][0] = $chunk[$i-1][0];
5370 # guardian
5371 push @chunk, ["", ""];
5373 foreach my $line_info (@chunk) {
5374 my ($class, $line) = @$line_info;
5376 # print chunk headers
5377 if ($class && $class eq 'chunk_header') {
5378 print format_diff_line($line, $class, $from, $to);
5379 next;
5382 ## print from accumulator when have some add/rem lines or end
5383 # of chunk (flush context lines), or when have add and rem
5384 # lines and new block is reached (otherwise add/rem lines could
5385 # be reordered)
5386 if (!$class || ((@rem || @add) && $class eq 'ctx') ||
5387 (@rem && @add && $class ne $prev_class)) {
5388 print_diff_lines(\@ctx, \@rem, \@add,
5389 $diff_style, $num_parents);
5390 @ctx = @rem = @add = ();
5393 ## adding lines to accumulator
5394 # guardian value
5395 last unless $line;
5396 # rem, add or change
5397 if ($class eq 'rem') {
5398 push @rem, $line;
5399 } elsif ($class eq 'add') {
5400 push @add, $line;
5402 # context line
5403 if ($class eq 'ctx') {
5404 push @ctx, $line;
5407 $prev_class = $class;
5411 sub git_patchset_body {
5412 my ($fd, $diff_style, $difftree, $hash, @hash_parents) = @_;
5413 my ($hash_parent) = $hash_parents[0];
5415 my $is_combined = (@hash_parents > 1);
5416 my $patch_idx = 0;
5417 my $patch_number = 0;
5418 my $patch_line;
5419 my $diffinfo;
5420 my $to_name;
5421 my (%from, %to);
5422 my @chunk; # for side-by-side diff
5424 print "<div class=\"patchset\">\n";
5426 # skip to first patch
5427 while ($patch_line = <$fd>) {
5428 chomp $patch_line;
5430 last if ($patch_line =~ m/^diff /);
5433 PATCH:
5434 while ($patch_line) {
5436 # parse "git diff" header line
5437 if ($patch_line =~ m/^diff --git (\"(?:[^\\\"]*(?:\\.[^\\\"]*)*)\"|[^ "]*) (.*)$/) {
5438 # $1 is from_name, which we do not use
5439 $to_name = unquote($2);
5440 $to_name =~ s!^b/!!;
5441 } elsif ($patch_line =~ m/^diff --(cc|combined) ("?.*"?)$/) {
5442 # $1 is 'cc' or 'combined', which we do not use
5443 $to_name = unquote($2);
5444 } else {
5445 $to_name = undef;
5448 # check if current patch belong to current raw line
5449 # and parse raw git-diff line if needed
5450 if (is_patch_split($diffinfo, { 'to_file' => $to_name })) {
5451 # this is continuation of a split patch
5452 print "<div class=\"patch cont\">\n";
5453 } else {
5454 # advance raw git-diff output if needed
5455 $patch_idx++ if defined $diffinfo;
5457 # read and prepare patch information
5458 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5460 # compact combined diff output can have some patches skipped
5461 # find which patch (using pathname of result) we are at now;
5462 if ($is_combined) {
5463 while ($to_name ne $diffinfo->{'to_file'}) {
5464 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5465 format_diff_cc_simplified($diffinfo, @hash_parents) .
5466 "</div>\n"; # class="patch"
5468 $patch_idx++;
5469 $patch_number++;
5471 last if $patch_idx > $#$difftree;
5472 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5476 # modifies %from, %to hashes
5477 parse_from_to_diffinfo($diffinfo, \%from, \%to, @hash_parents);
5479 # this is first patch for raw difftree line with $patch_idx index
5480 # we index @$difftree array from 0, but number patches from 1
5481 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n";
5484 # git diff header
5485 #assert($patch_line =~ m/^diff /) if DEBUG;
5486 #assert($patch_line !~ m!$/$!) if DEBUG; # is chomp-ed
5487 $patch_number++;
5488 # print "git diff" header
5489 print format_git_diff_header_line($patch_line, $diffinfo,
5490 \%from, \%to);
5492 # print extended diff header
5493 print "<div class=\"diff extended_header\">\n";
5494 EXTENDED_HEADER:
5495 while ($patch_line = <$fd>) {
5496 chomp $patch_line;
5498 last EXTENDED_HEADER if ($patch_line =~ m/^--- |^diff /);
5500 print format_extended_diff_header_line($patch_line, $diffinfo,
5501 \%from, \%to);
5503 print "</div>\n"; # class="diff extended_header"
5505 # from-file/to-file diff header
5506 if (! $patch_line) {
5507 print "</div>\n"; # class="patch"
5508 last PATCH;
5510 next PATCH if ($patch_line =~ m/^diff /);
5511 #assert($patch_line =~ m/^---/) if DEBUG;
5513 my $last_patch_line = $patch_line;
5514 $patch_line = <$fd>;
5515 chomp $patch_line;
5516 #assert($patch_line =~ m/^\+\+\+/) if DEBUG;
5518 print format_diff_from_to_header($last_patch_line, $patch_line,
5519 $diffinfo, \%from, \%to,
5520 @hash_parents);
5522 # the patch itself
5523 LINE:
5524 while ($patch_line = <$fd>) {
5525 chomp $patch_line;
5527 next PATCH if ($patch_line =~ m/^diff /);
5529 my $class = diff_line_class($patch_line, \%from, \%to);
5531 if ($class eq 'chunk_header') {
5532 print_diff_chunk($diff_style, scalar @hash_parents, \%from, \%to, @chunk);
5533 @chunk = ();
5536 push @chunk, [ $class, $patch_line ];
5539 } continue {
5540 if (@chunk) {
5541 print_diff_chunk($diff_style, scalar @hash_parents, \%from, \%to, @chunk);
5542 @chunk = ();
5544 print "</div>\n"; # class="patch"
5547 # for compact combined (--cc) format, with chunk and patch simplification
5548 # the patchset might be empty, but there might be unprocessed raw lines
5549 for (++$patch_idx if $patch_number > 0;
5550 $patch_idx < @$difftree;
5551 ++$patch_idx) {
5552 # read and prepare patch information
5553 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5555 # generate anchor for "patch" links in difftree / whatchanged part
5556 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5557 format_diff_cc_simplified($diffinfo, @hash_parents) .
5558 "</div>\n"; # class="patch"
5560 $patch_number++;
5563 if ($patch_number == 0) {
5564 if (@hash_parents > 1) {
5565 print "<div class=\"diff nodifferences\">Trivial merge</div>\n";
5566 } else {
5567 print "<div class=\"diff nodifferences\">No differences found</div>\n";
5571 print "</div>\n"; # class="patchset"
5574 # . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5576 sub git_project_search_form {
5577 my ($searchtext, $search_use_regexp) = @_;
5579 my $limit = '';
5580 if ($project_filter) {
5581 $limit = " in '$project_filter/'";
5584 print "<div class=\"projsearch\">\n";
5585 print $cgi->start_form(-method => 'get', -action => $my_uri) .
5586 $cgi->hidden(-name => 'a', -value => 'project_list') . "\n";
5587 print $cgi->hidden(-name => 'pf', -value => $project_filter). "\n"
5588 if (defined $project_filter);
5589 print $cgi->textfield(-name => 's', -value => $searchtext,
5590 -title => "Search project by name and description$limit",
5591 -size => 60) . "\n" .
5592 "<span title=\"Extended regular expression\">" .
5593 $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
5594 -checked => $search_use_regexp) .
5595 "</span>\n" .
5596 $cgi->submit(-name => 'btnS', -value => 'Search') .
5597 $cgi->end_form() . "\n" .
5598 $cgi->a({-href => href(project => undef, searchtext => undef,
5599 project_filter => $project_filter)},
5600 esc_html("List all projects$limit")) . "<br />\n";
5601 print "</div>\n";
5604 # entry for given @keys needs filling if at least one of keys in list
5605 # is not present in %$project_info
5606 sub project_info_needs_filling {
5607 my ($project_info, @keys) = @_;
5609 # return List::MoreUtils::any { !exists $project_info->{$_} } @keys;
5610 foreach my $key (@keys) {
5611 if (!exists $project_info->{$key}) {
5612 return 1;
5615 return;
5618 # fills project list info (age, description, owner, category, forks, etc.)
5619 # for each project in the list, removing invalid projects from
5620 # returned list, or fill only specified info.
5622 # Invalid projects are removed from the returned list if and only if you
5623 # ask 'age' or 'age_string' to be filled, because they are the only fields
5624 # that run unconditionally git command that requires repository, and
5625 # therefore do always check if project repository is invalid.
5627 # USAGE:
5628 # * fill_project_list_info(\@project_list, 'descr_long', 'ctags')
5629 # ensures that 'descr_long' and 'ctags' fields are filled
5630 # * @project_list = fill_project_list_info(\@project_list)
5631 # ensures that all fields are filled (and invalid projects removed)
5633 # NOTE: modifies $projlist, but does not remove entries from it
5634 sub fill_project_list_info {
5635 my ($projlist, @wanted_keys) = @_;
5636 my @projects;
5637 my $filter_set = sub { return @_; };
5638 if (@wanted_keys) {
5639 my %wanted_keys = map { $_ => 1 } @wanted_keys;
5640 $filter_set = sub { return grep { $wanted_keys{$_} } @_; };
5643 my $show_ctags = gitweb_check_feature('ctags');
5644 PROJECT:
5645 foreach my $pr (@$projlist) {
5646 if (project_info_needs_filling($pr, $filter_set->('age', 'age_string'))) {
5647 my (@activity) = git_get_last_activity($pr->{'path'});
5648 unless (@activity) {
5649 next PROJECT;
5651 ($pr->{'age'}, $pr->{'age_string'}) = @activity;
5653 if (project_info_needs_filling($pr, $filter_set->('descr', 'descr_long'))) {
5654 my $descr = git_get_project_description($pr->{'path'}) || "";
5655 $descr = to_utf8($descr);
5656 $pr->{'descr_long'} = $descr;
5657 $pr->{'descr'} = chop_str($descr, $projects_list_description_width, 5);
5659 if (project_info_needs_filling($pr, $filter_set->('owner'))) {
5660 $pr->{'owner'} = git_get_project_owner("$pr->{'path'}") || "";
5662 if ($show_ctags &&
5663 project_info_needs_filling($pr, $filter_set->('ctags'))) {
5664 $pr->{'ctags'} = git_get_project_ctags($pr->{'path'});
5666 if ($projects_list_group_categories &&
5667 project_info_needs_filling($pr, $filter_set->('category'))) {
5668 my $cat = git_get_project_category($pr->{'path'}) ||
5669 $project_list_default_category;
5670 $pr->{'category'} = to_utf8($cat);
5673 push @projects, $pr;
5676 return @projects;
5679 sub sort_projects_list {
5680 my ($projlist, $order) = @_;
5682 sub order_str {
5683 my $key = shift;
5684 return sub { $a->{$key} cmp $b->{$key} };
5687 sub order_num_then_undef {
5688 my $key = shift;
5689 return sub {
5690 defined $a->{$key} ?
5691 (defined $b->{$key} ? $a->{$key} <=> $b->{$key} : -1) :
5692 (defined $b->{$key} ? 1 : 0)
5696 my %orderings = (
5697 project => order_str('path'),
5698 descr => order_str('descr_long'),
5699 owner => order_str('owner'),
5700 age => order_num_then_undef('age'),
5703 my $ordering = $orderings{$order};
5704 return defined $ordering ? sort $ordering @$projlist : @$projlist;
5707 # returns a hash of categories, containing the list of project
5708 # belonging to each category
5709 sub build_projlist_by_category {
5710 my ($projlist, $from, $to) = @_;
5711 my %categories;
5713 $from = 0 unless defined $from;
5714 $to = $#$projlist if (!defined $to || $#$projlist < $to);
5716 for (my $i = $from; $i <= $to; $i++) {
5717 my $pr = $projlist->[$i];
5718 push @{$categories{ $pr->{'category'} }}, $pr;
5721 return wantarray ? %categories : \%categories;
5724 # print 'sort by' <th> element, generating 'sort by $name' replay link
5725 # if that order is not selected
5726 sub print_sort_th {
5727 print format_sort_th(@_);
5730 sub format_sort_th {
5731 my ($name, $order, $header) = @_;
5732 my $sort_th = "";
5733 $header ||= ucfirst($name);
5735 if ($order eq $name) {
5736 $sort_th .= "<th>$header</th>\n";
5737 } else {
5738 $sort_th .= "<th>" .
5739 $cgi->a({-href => href(-replay=>1, order=>$name),
5740 -class => "header"}, $header) .
5741 "</th>\n";
5744 return $sort_th;
5747 sub git_project_list_rows {
5748 my ($projlist, $from, $to, $check_forks) = @_;
5750 $from = 0 unless defined $from;
5751 $to = $#$projlist if (!defined $to || $#$projlist < $to);
5753 my $alternate = 1;
5754 for (my $i = $from; $i <= $to; $i++) {
5755 my $pr = $projlist->[$i];
5757 if ($alternate) {
5758 print "<tr class=\"dark\">\n";
5759 } else {
5760 print "<tr class=\"light\">\n";
5762 $alternate ^= 1;
5764 if ($check_forks) {
5765 print "<td>";
5766 if ($pr->{'forks'}) {
5767 my $nforks = scalar @{$pr->{'forks'}};
5768 if ($nforks > 0) {
5769 print $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks"),
5770 -title => "$nforks forks"}, "+");
5771 } else {
5772 print $cgi->span({-title => "$nforks forks"}, "+");
5775 print "</td>\n";
5777 print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5778 -class => "list"},
5779 esc_html_match_hl($pr->{'path'}, $search_regexp)) .
5780 "</td>\n" .
5781 "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5782 -class => "list",
5783 -title => $pr->{'descr_long'}},
5784 $search_regexp
5785 ? esc_html_match_hl_chopped($pr->{'descr_long'},
5786 $pr->{'descr'}, $search_regexp)
5787 : esc_html($pr->{'descr'})) .
5788 "</td>\n";
5789 unless ($omit_owner) {
5790 print "<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n";
5792 unless ($omit_age_column) {
5793 print "<td class=\"". age_class($pr->{'age'}) . "\">" .
5794 (defined $pr->{'age_string'} ? $pr->{'age_string'} : "No commits") . "</td>\n";
5796 print"<td class=\"link\">" .
5797 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary")}, "summary") . " | " .
5798 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"shortlog")}, "shortlog") . " | " .
5799 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"log")}, "log") . " | " .
5800 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"tree")}, "tree") .
5801 ($pr->{'forks'} ? " | " . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks")}, "forks") : '') .
5802 "</td>\n" .
5803 "</tr>\n";
5807 sub git_project_list_body {
5808 # actually uses global variable $project
5809 my ($projlist, $order, $from, $to, $extra, $no_header) = @_;
5810 my @projects = @$projlist;
5812 my $check_forks = gitweb_check_feature('forks');
5813 my $show_ctags = gitweb_check_feature('ctags');
5814 my $tagfilter = $show_ctags ? $input_params{'ctag'} : undef;
5815 $check_forks = undef
5816 if ($tagfilter || $search_regexp);
5818 # filtering out forks before filling info allows to do less work
5819 @projects = filter_forks_from_projects_list(\@projects)
5820 if ($check_forks);
5821 # search_projects_list pre-fills required info
5822 @projects = search_projects_list(\@projects,
5823 'search_regexp' => $search_regexp,
5824 'tagfilter' => $tagfilter)
5825 if ($tagfilter || $search_regexp);
5826 # fill the rest
5827 my @all_fields = ('descr', 'descr_long', 'ctags', 'category');
5828 push @all_fields, ('age', 'age_string') unless($omit_age_column);
5829 push @all_fields, 'owner' unless($omit_owner);
5830 @projects = fill_project_list_info(\@projects, @all_fields);
5832 $order ||= $default_projects_order;
5833 $from = 0 unless defined $from;
5834 $to = $#projects if (!defined $to || $#projects < $to);
5836 # short circuit
5837 if ($from > $to) {
5838 print "<center>\n".
5839 "<b>No such projects found</b><br />\n".
5840 "Click ".$cgi->a({-href=>href(project=>undef)},"here")." to view all projects<br />\n".
5841 "</center>\n<br />\n";
5842 return;
5845 @projects = sort_projects_list(\@projects, $order);
5847 if ($show_ctags) {
5848 my $ctags = git_gather_all_ctags(\@projects);
5849 my $cloud = git_populate_project_tagcloud($ctags);
5850 print git_show_project_tagcloud($cloud, 64);
5853 print "<table class=\"project_list\">\n";
5854 unless ($no_header) {
5855 print "<tr>\n";
5856 if ($check_forks) {
5857 print "<th></th>\n";
5859 print_sort_th('project', $order, 'Project');
5860 print_sort_th('descr', $order, 'Description');
5861 print_sort_th('owner', $order, 'Owner') unless $omit_owner;
5862 print_sort_th('age', $order, 'Last Change') unless $omit_age_column;
5863 print "<th></th>\n" . # for links
5864 "</tr>\n";
5867 if ($projects_list_group_categories) {
5868 # only display categories with projects in the $from-$to window
5869 @projects = sort {$a->{'category'} cmp $b->{'category'}} @projects[$from..$to];
5870 my %categories = build_projlist_by_category(\@projects, $from, $to);
5871 foreach my $cat (sort keys %categories) {
5872 unless ($cat eq "") {
5873 print "<tr>\n";
5874 if ($check_forks) {
5875 print "<td></td>\n";
5877 print "<td class=\"category\" colspan=\"5\">".esc_html($cat)."</td>\n";
5878 print "</tr>\n";
5881 git_project_list_rows($categories{$cat}, undef, undef, $check_forks);
5883 } else {
5884 git_project_list_rows(\@projects, $from, $to, $check_forks);
5887 if (defined $extra) {
5888 print "<tr>\n";
5889 if ($check_forks) {
5890 print "<td></td>\n";
5892 print "<td colspan=\"5\">$extra</td>\n" .
5893 "</tr>\n";
5895 print "</table>\n";
5898 sub git_log_body {
5899 # uses global variable $project
5900 my ($commitlist, $from, $to, $refs, $extra) = @_;
5902 $from = 0 unless defined $from;
5903 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5905 for (my $i = 0; $i <= $to; $i++) {
5906 my %co = %{$commitlist->[$i]};
5907 next if !%co;
5908 my $commit = $co{'id'};
5909 my $ref = format_ref_marker($refs, $commit);
5910 git_print_header_div('commit',
5911 "<span class=\"age\">$co{'age_string'}</span>" .
5912 esc_html($co{'title'}) . $ref,
5913 $commit);
5914 print "<div class=\"title_text\">\n" .
5915 "<div class=\"log_link\">\n" .
5916 $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") .
5917 " | " .
5918 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") .
5919 " | " .
5920 $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree") .
5921 "<br/>\n" .
5922 "</div>\n";
5923 git_print_authorship(\%co, -tag => 'span');
5924 print "<br/>\n</div>\n";
5926 print "<div class=\"log_body\">\n";
5927 git_print_log($co{'comment'}, -final_empty_line=> 1);
5928 print "</div>\n";
5930 if ($extra) {
5931 print "<div class=\"page_nav\">\n";
5932 print "$extra\n";
5933 print "</div>\n";
5937 sub git_shortlog_body {
5938 # uses global variable $project
5939 my ($commitlist, $from, $to, $refs, $extra) = @_;
5941 $from = 0 unless defined $from;
5942 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5944 print "<table class=\"shortlog\">\n";
5945 my $alternate = 1;
5946 for (my $i = $from; $i <= $to; $i++) {
5947 my %co = %{$commitlist->[$i]};
5948 my $commit = $co{'id'};
5949 my $ref = format_ref_marker($refs, $commit);
5950 if ($alternate) {
5951 print "<tr class=\"dark\">\n";
5952 } else {
5953 print "<tr class=\"light\">\n";
5955 $alternate ^= 1;
5956 # git_summary() used print "<td><i>$co{'age_string'}</i></td>\n" .
5957 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5958 format_author_html('td', \%co, 10) . "<td>";
5959 print format_subject_html($co{'title'}, $co{'title_short'},
5960 href(action=>"commit", hash=>$commit), $ref);
5961 print "</td>\n" .
5962 "<td class=\"link\">" .
5963 $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") . " | " .
5964 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") . " | " .
5965 $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree");
5966 my $snapshot_links = format_snapshot_links($commit);
5967 if (defined $snapshot_links) {
5968 print " | " . $snapshot_links;
5970 print "</td>\n" .
5971 "</tr>\n";
5973 if (defined $extra) {
5974 print "<tr>\n" .
5975 "<td colspan=\"4\">$extra</td>\n" .
5976 "</tr>\n";
5978 print "</table>\n";
5981 sub git_history_body {
5982 # Warning: assumes constant type (blob or tree) during history
5983 my ($commitlist, $from, $to, $refs, $extra,
5984 $file_name, $file_hash, $ftype) = @_;
5986 $from = 0 unless defined $from;
5987 $to = $#{$commitlist} unless (defined $to && $to <= $#{$commitlist});
5989 print "<table class=\"history\">\n";
5990 my $alternate = 1;
5991 for (my $i = $from; $i <= $to; $i++) {
5992 my %co = %{$commitlist->[$i]};
5993 if (!%co) {
5994 next;
5996 my $commit = $co{'id'};
5998 my $ref = format_ref_marker($refs, $commit);
6000 if ($alternate) {
6001 print "<tr class=\"dark\">\n";
6002 } else {
6003 print "<tr class=\"light\">\n";
6005 $alternate ^= 1;
6006 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6007 # shortlog: format_author_html('td', \%co, 10)
6008 format_author_html('td', \%co, 15, 3) . "<td>";
6009 # originally git_history used chop_str($co{'title'}, 50)
6010 print format_subject_html($co{'title'}, $co{'title_short'},
6011 href(action=>"commit", hash=>$commit), $ref);
6012 print "</td>\n" .
6013 "<td class=\"link\">" .
6014 $cgi->a({-href => href(action=>$ftype, hash_base=>$commit, file_name=>$file_name)}, $ftype) . " | " .
6015 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff");
6017 if ($ftype eq 'blob') {
6018 print " | " .
6019 $cgi->a({-href => href(action=>"blob_plain", hash_base=>$commit, file_name=>$file_name)}, "raw");
6021 my $blob_current = $file_hash;
6022 my $blob_parent = git_get_hash_by_path($commit, $file_name);
6023 if (defined $blob_current && defined $blob_parent &&
6024 $blob_current ne $blob_parent) {
6025 print " | " .
6026 $cgi->a({-href => href(action=>"blobdiff",
6027 hash=>$blob_current, hash_parent=>$blob_parent,
6028 hash_base=>$hash_base, hash_parent_base=>$commit,
6029 file_name=>$file_name)},
6030 "diff to current");
6033 print "</td>\n" .
6034 "</tr>\n";
6036 if (defined $extra) {
6037 print "<tr>\n" .
6038 "<td colspan=\"4\">$extra</td>\n" .
6039 "</tr>\n";
6041 print "</table>\n";
6044 sub git_tags_body {
6045 # uses global variable $project
6046 my ($taglist, $from, $to, $extra) = @_;
6047 $from = 0 unless defined $from;
6048 $to = $#{$taglist} if (!defined $to || $#{$taglist} < $to);
6050 print "<table class=\"tags\">\n";
6051 my $alternate = 1;
6052 for (my $i = $from; $i <= $to; $i++) {
6053 my $entry = $taglist->[$i];
6054 my %tag = %$entry;
6055 my $comment = $tag{'subject'};
6056 my $comment_short;
6057 if (defined $comment) {
6058 $comment_short = chop_str($comment, 30, 5);
6060 if ($alternate) {
6061 print "<tr class=\"dark\">\n";
6062 } else {
6063 print "<tr class=\"light\">\n";
6065 $alternate ^= 1;
6066 if (defined $tag{'age'}) {
6067 print "<td><i>$tag{'age'}</i></td>\n";
6068 } else {
6069 print "<td></td>\n";
6071 print "<td>" .
6072 $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'}),
6073 -class => "list name"}, esc_html($tag{'name'})) .
6074 "</td>\n" .
6075 "<td>";
6076 if (defined $comment) {
6077 print format_subject_html($comment, $comment_short,
6078 href(action=>"tag", hash=>$tag{'id'}));
6080 print "</td>\n" .
6081 "<td class=\"selflink\">";
6082 if ($tag{'type'} eq "tag") {
6083 print $cgi->a({-href => href(action=>"tag", hash=>$tag{'id'})}, "tag");
6084 } else {
6085 print "&nbsp;";
6087 print "</td>\n" .
6088 "<td class=\"link\">" . " | " .
6089 $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'})}, $tag{'reftype'});
6090 if ($tag{'reftype'} eq "commit") {
6091 print " | " . $cgi->a({-href => href(action=>"shortlog", hash=>$tag{'fullname'})}, "shortlog") .
6092 " | " . $cgi->a({-href => href(action=>"log", hash=>$tag{'fullname'})}, "log");
6093 } elsif ($tag{'reftype'} eq "blob") {
6094 print " | " . $cgi->a({-href => href(action=>"blob_plain", hash=>$tag{'refid'})}, "raw");
6096 print "</td>\n" .
6097 "</tr>";
6099 if (defined $extra) {
6100 print "<tr>\n" .
6101 "<td colspan=\"5\">$extra</td>\n" .
6102 "</tr>\n";
6104 print "</table>\n";
6107 sub git_heads_body {
6108 # uses global variable $project
6109 my ($headlist, $head_at, $from, $to, $extra) = @_;
6110 $from = 0 unless defined $from;
6111 $to = $#{$headlist} if (!defined $to || $#{$headlist} < $to);
6113 print "<table class=\"heads\">\n";
6114 my $alternate = 1;
6115 for (my $i = $from; $i <= $to; $i++) {
6116 my $entry = $headlist->[$i];
6117 my %ref = %$entry;
6118 my $curr = defined $head_at && $ref{'id'} eq $head_at;
6119 if ($alternate) {
6120 print "<tr class=\"dark\">\n";
6121 } else {
6122 print "<tr class=\"light\">\n";
6124 $alternate ^= 1;
6125 print "<td><i>$ref{'age'}</i></td>\n" .
6126 ($curr ? "<td class=\"current_head\">" : "<td>") .
6127 $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'}),
6128 -class => "list name"},esc_html($ref{'name'})) .
6129 "</td>\n" .
6130 "<td class=\"link\">" .
6131 $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'})}, "shortlog") . " | " .
6132 $cgi->a({-href => href(action=>"log", hash=>$ref{'fullname'})}, "log") . " | " .
6133 $cgi->a({-href => href(action=>"tree", hash=>$ref{'fullname'}, hash_base=>$ref{'fullname'})}, "tree") .
6134 "</td>\n" .
6135 "</tr>";
6137 if (defined $extra) {
6138 print "<tr>\n" .
6139 "<td colspan=\"3\">$extra</td>\n" .
6140 "</tr>\n";
6142 print "</table>\n";
6145 # Display a single remote block
6146 sub git_remote_block {
6147 my ($remote, $rdata, $limit, $head) = @_;
6149 my $heads = $rdata->{'heads'};
6150 my $fetch = $rdata->{'fetch'};
6151 my $push = $rdata->{'push'};
6153 my $urls_table = "<table class=\"projects_list\">\n" ;
6155 if (defined $fetch) {
6156 if ($fetch eq $push) {
6157 $urls_table .= format_repo_url("URL", $fetch);
6158 } else {
6159 $urls_table .= format_repo_url("Fetch URL", $fetch);
6160 $urls_table .= format_repo_url("Push URL", $push) if defined $push;
6162 } elsif (defined $push) {
6163 $urls_table .= format_repo_url("Push URL", $push);
6164 } else {
6165 $urls_table .= format_repo_url("", "No remote URL");
6168 $urls_table .= "</table>\n";
6170 my $dots;
6171 if (defined $limit && $limit < @$heads) {
6172 $dots = $cgi->a({-href => href(action=>"remotes", hash=>$remote)}, "...");
6175 print $urls_table;
6176 git_heads_body($heads, $head, 0, $limit, $dots);
6179 # Display a list of remote names with the respective fetch and push URLs
6180 sub git_remotes_list {
6181 my ($remotedata, $limit) = @_;
6182 print "<table class=\"heads\">\n";
6183 my $alternate = 1;
6184 my @remotes = sort keys %$remotedata;
6186 my $limited = $limit && $limit < @remotes;
6188 $#remotes = $limit - 1 if $limited;
6190 while (my $remote = shift @remotes) {
6191 my $rdata = $remotedata->{$remote};
6192 my $fetch = $rdata->{'fetch'};
6193 my $push = $rdata->{'push'};
6194 if ($alternate) {
6195 print "<tr class=\"dark\">\n";
6196 } else {
6197 print "<tr class=\"light\">\n";
6199 $alternate ^= 1;
6200 print "<td>" .
6201 $cgi->a({-href=> href(action=>'remotes', hash=>$remote),
6202 -class=> "list name"},esc_html($remote)) .
6203 "</td>";
6204 print "<td class=\"link\">" .
6205 (defined $fetch ? $cgi->a({-href=> $fetch}, "fetch") : "fetch") .
6206 " | " .
6207 (defined $push ? $cgi->a({-href=> $push}, "push") : "push") .
6208 "</td>";
6210 print "</tr>\n";
6213 if ($limited) {
6214 print "<tr>\n" .
6215 "<td colspan=\"3\">" .
6216 $cgi->a({-href => href(action=>"remotes")}, "...") .
6217 "</td>\n" . "</tr>\n";
6220 print "</table>";
6223 # Display remote heads grouped by remote, unless there are too many
6224 # remotes, in which case we only display the remote names
6225 sub git_remotes_body {
6226 my ($remotedata, $limit, $head) = @_;
6227 if ($limit and $limit < keys %$remotedata) {
6228 git_remotes_list($remotedata, $limit);
6229 } else {
6230 fill_remote_heads($remotedata);
6231 while (my ($remote, $rdata) = each %$remotedata) {
6232 git_print_section({-class=>"remote", -id=>$remote},
6233 ["remotes", $remote, $remote], sub {
6234 git_remote_block($remote, $rdata, $limit, $head);
6240 sub git_search_message {
6241 my %co = @_;
6243 my $greptype;
6244 if ($searchtype eq 'commit') {
6245 $greptype = "--grep=";
6246 } elsif ($searchtype eq 'author') {
6247 $greptype = "--author=";
6248 } elsif ($searchtype eq 'committer') {
6249 $greptype = "--committer=";
6251 $greptype .= $searchtext;
6252 my @commitlist = parse_commits($hash, 101, (100 * $page), undef,
6253 $greptype, '--regexp-ignore-case',
6254 $search_use_regexp ? '--extended-regexp' : '--fixed-strings');
6256 my $paging_nav = '';
6257 if ($page > 0) {
6258 $paging_nav .=
6259 $cgi->a({-href => href(-replay=>1, page=>undef)},
6260 "first") .
6261 " &sdot; " .
6262 $cgi->a({-href => href(-replay=>1, page=>$page-1),
6263 -accesskey => "p", -title => "Alt-p"}, "prev");
6264 } else {
6265 $paging_nav .= "first &sdot; prev";
6267 my $next_link = '';
6268 if ($#commitlist >= 100) {
6269 $next_link =
6270 $cgi->a({-href => href(-replay=>1, page=>$page+1),
6271 -accesskey => "n", -title => "Alt-n"}, "next");
6272 $paging_nav .= " &sdot; $next_link";
6273 } else {
6274 $paging_nav .= " &sdot; next";
6277 git_header_html();
6279 git_print_page_nav('','', $hash,$co{'tree'},$hash, $paging_nav);
6280 git_print_header_div('commit', esc_html($co{'title'}), $hash);
6281 if ($page == 0 && !@commitlist) {
6282 print "<p>No match.</p>\n";
6283 } else {
6284 git_search_grep_body(\@commitlist, 0, 99, $next_link);
6287 git_footer_html();
6290 sub git_search_changes {
6291 my %co = @_;
6293 local $/ = "\n";
6294 open my $fd, '-|', git_cmd(), '--no-pager', 'log', @diff_opts,
6295 '--pretty=format:%H', '--no-abbrev', '--raw', "-S$searchtext",
6296 ($search_use_regexp ? '--pickaxe-regex' : ())
6297 or die_error(500, "Open git-log failed");
6299 git_header_html();
6301 git_print_page_nav('','', $hash,$co{'tree'},$hash);
6302 git_print_header_div('commit', esc_html($co{'title'}), $hash);
6304 print "<table class=\"pickaxe search\">\n";
6305 my $alternate = 1;
6306 undef %co;
6307 my @files;
6308 while (my $line = <$fd>) {
6309 chomp $line;
6310 next unless $line;
6312 my %set = parse_difftree_raw_line($line);
6313 if (defined $set{'commit'}) {
6314 # finish previous commit
6315 if (%co) {
6316 print "</td>\n" .
6317 "<td class=\"link\">" .
6318 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
6319 "commit") .
6320 " | " .
6321 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
6322 hash_base=>$co{'id'})},
6323 "tree") .
6324 "</td>\n" .
6325 "</tr>\n";
6328 if ($alternate) {
6329 print "<tr class=\"dark\">\n";
6330 } else {
6331 print "<tr class=\"light\">\n";
6333 $alternate ^= 1;
6334 %co = parse_commit($set{'commit'});
6335 my $author = chop_and_escape_str($co{'author_name'}, 15, 5);
6336 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6337 "<td><i>$author</i></td>\n" .
6338 "<td>" .
6339 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
6340 -class => "list subject"},
6341 chop_and_escape_str($co{'title'}, 50) . "<br/>");
6342 } elsif (defined $set{'to_id'}) {
6343 next if is_deleted(\%set);
6345 print $cgi->a({-href => href(action=>"blob", hash_base=>$co{'id'},
6346 hash=>$set{'to_id'}, file_name=>$set{'to_file'}),
6347 -class => "list"},
6348 "<span class=\"match\">" . esc_path($set{'file'}) . "</span>") .
6349 "<br/>\n";
6352 close $fd;
6354 # finish last commit (warning: repetition!)
6355 if (%co) {
6356 print "</td>\n" .
6357 "<td class=\"link\">" .
6358 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
6359 "commit") .
6360 " | " .
6361 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
6362 hash_base=>$co{'id'})},
6363 "tree") .
6364 "</td>\n" .
6365 "</tr>\n";
6368 print "</table>\n";
6370 git_footer_html();
6373 sub git_search_files {
6374 my %co = @_;
6376 local $/ = "\n";
6377 open my $fd, "-|", git_cmd(), 'grep', '-n', '-z',
6378 $search_use_regexp ? ('-E', '-i') : '-F',
6379 $searchtext, $co{'tree'}
6380 or die_error(500, "Open git-grep failed");
6382 git_header_html();
6384 git_print_page_nav('','', $hash,$co{'tree'},$hash);
6385 git_print_header_div('commit', esc_html($co{'title'}), $hash);
6387 print "<table class=\"grep_search\">\n";
6388 my $alternate = 1;
6389 my $matches = 0;
6390 my $lastfile = '';
6391 my $file_href;
6392 while (my $line = <$fd>) {
6393 chomp $line;
6394 my ($file, $lno, $ltext, $binary);
6395 last if ($matches++ > 1000);
6396 if ($line =~ /^Binary file (.+) matches$/) {
6397 $file = $1;
6398 $binary = 1;
6399 } else {
6400 ($file, $lno, $ltext) = split(/\0/, $line, 3);
6401 $file =~ s/^$co{'tree'}://;
6403 if ($file ne $lastfile) {
6404 $lastfile and print "</td></tr>\n";
6405 if ($alternate++) {
6406 print "<tr class=\"dark\">\n";
6407 } else {
6408 print "<tr class=\"light\">\n";
6410 $file_href = href(action=>"blob", hash_base=>$co{'id'},
6411 file_name=>$file);
6412 print "<td class=\"list\">".
6413 $cgi->a({-href => $file_href, -class => "list"}, esc_path($file));
6414 print "</td><td>\n";
6415 $lastfile = $file;
6417 if ($binary) {
6418 print "<div class=\"binary\">Binary file</div>\n";
6419 } else {
6420 $ltext = untabify($ltext);
6421 if ($ltext =~ m/^(.*)($search_regexp)(.*)$/i) {
6422 $ltext = esc_html($1, -nbsp=>1);
6423 $ltext .= '<span class="match">';
6424 $ltext .= esc_html($2, -nbsp=>1);
6425 $ltext .= '</span>';
6426 $ltext .= esc_html($3, -nbsp=>1);
6427 } else {
6428 $ltext = esc_html($ltext, -nbsp=>1);
6430 print "<div class=\"pre\">" .
6431 $cgi->a({-href => $file_href.'#l'.$lno,
6432 -class => "linenr"}, sprintf('%4i', $lno)) .
6433 ' ' . $ltext . "</div>\n";
6436 if ($lastfile) {
6437 print "</td></tr>\n";
6438 if ($matches > 1000) {
6439 print "<div class=\"diff nodifferences\">Too many matches, listing trimmed</div>\n";
6441 } else {
6442 print "<div class=\"diff nodifferences\">No matches found</div>\n";
6444 close $fd;
6446 print "</table>\n";
6448 git_footer_html();
6451 sub git_search_grep_body {
6452 my ($commitlist, $from, $to, $extra) = @_;
6453 $from = 0 unless defined $from;
6454 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
6456 print "<table class=\"commit_search\">\n";
6457 my $alternate = 1;
6458 for (my $i = $from; $i <= $to; $i++) {
6459 my %co = %{$commitlist->[$i]};
6460 if (!%co) {
6461 next;
6463 my $commit = $co{'id'};
6464 if ($alternate) {
6465 print "<tr class=\"dark\">\n";
6466 } else {
6467 print "<tr class=\"light\">\n";
6469 $alternate ^= 1;
6470 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6471 format_author_html('td', \%co, 15, 5) .
6472 "<td>" .
6473 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
6474 -class => "list subject"},
6475 chop_and_escape_str($co{'title'}, 50) . "<br/>");
6476 my $comment = $co{'comment'};
6477 foreach my $line (@$comment) {
6478 if ($line =~ m/^(.*?)($search_regexp)(.*)$/i) {
6479 my ($lead, $match, $trail) = ($1, $2, $3);
6480 $match = chop_str($match, 70, 5, 'center');
6481 my $contextlen = int((80 - length($match))/2);
6482 $contextlen = 30 if ($contextlen > 30);
6483 $lead = chop_str($lead, $contextlen, 10, 'left');
6484 $trail = chop_str($trail, $contextlen, 10, 'right');
6486 $lead = esc_html($lead);
6487 $match = esc_html($match);
6488 $trail = esc_html($trail);
6490 print "$lead<span class=\"match\">$match</span>$trail<br />";
6493 print "</td>\n" .
6494 "<td class=\"link\">" .
6495 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})}, "commit") .
6496 " | " .
6497 $cgi->a({-href => href(action=>"commitdiff", hash=>$co{'id'})}, "commitdiff") .
6498 " | " .
6499 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$co{'id'})}, "tree");
6500 print "</td>\n" .
6501 "</tr>\n";
6503 if (defined $extra) {
6504 print "<tr>\n" .
6505 "<td colspan=\"3\">$extra</td>\n" .
6506 "</tr>\n";
6508 print "</table>\n";
6511 ## ======================================================================
6512 ## ======================================================================
6513 ## actions
6515 sub git_project_list {
6516 my $order = $input_params{'order'};
6517 if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6518 die_error(400, "Unknown order parameter");
6521 my @list = git_get_projects_list($project_filter, $strict_export);
6522 if (!@list) {
6523 die_error(404, "No projects found");
6526 git_header_html();
6527 if (defined $home_text && -f $home_text) {
6528 print "<div class=\"index_include\">\n";
6529 insert_file($home_text);
6530 print "</div>\n";
6533 git_project_search_form($searchtext, $search_use_regexp);
6534 git_project_list_body(\@list, $order);
6535 git_footer_html();
6538 sub git_forks {
6539 my $order = $input_params{'order'};
6540 if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6541 die_error(400, "Unknown order parameter");
6544 my $filter = $project;
6545 $filter =~ s/\.git$//;
6546 my @list = git_get_projects_list($filter);
6547 if (!@list) {
6548 die_error(404, "No forks found");
6551 git_header_html();
6552 git_print_page_nav('','');
6553 git_print_header_div('summary', "$project forks");
6554 git_project_list_body(\@list, $order);
6555 git_footer_html();
6558 sub git_project_index {
6559 my @projects = git_get_projects_list($project_filter, $strict_export);
6560 if (!@projects) {
6561 die_error(404, "No projects found");
6564 print $cgi->header(
6565 -type => 'text/plain',
6566 -charset => 'utf-8',
6567 -content_disposition => 'inline; filename="index.aux"');
6569 foreach my $pr (@projects) {
6570 if (!exists $pr->{'owner'}) {
6571 $pr->{'owner'} = git_get_project_owner("$pr->{'path'}");
6574 my ($path, $owner) = ($pr->{'path'}, $pr->{'owner'});
6575 # quote as in CGI::Util::encode, but keep the slash, and use '+' for ' '
6576 $path =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6577 $owner =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6578 $path =~ s/ /\+/g;
6579 $owner =~ s/ /\+/g;
6581 print "$path $owner\n";
6585 sub git_summary {
6586 my $descr = git_get_project_description($project) || "none";
6587 my %co = parse_commit("HEAD");
6588 my %cd = %co ? parse_date($co{'committer_epoch'}, $co{'committer_tz'}) : ();
6589 my $head = $co{'id'};
6590 my $remote_heads = gitweb_check_feature('remote_heads');
6592 my $owner = git_get_project_owner($project);
6594 my $refs = git_get_references();
6595 # These get_*_list functions return one more to allow us to see if
6596 # there are more ...
6597 my @taglist = git_get_tags_list(16);
6598 my @headlist = git_get_heads_list(16);
6599 my %remotedata = $remote_heads ? git_get_remotes_list() : ();
6600 my @forklist;
6601 my $check_forks = gitweb_check_feature('forks');
6603 if ($check_forks) {
6604 # find forks of a project
6605 my $filter = $project;
6606 $filter =~ s/\.git$//;
6607 @forklist = git_get_projects_list($filter);
6608 # filter out forks of forks
6609 @forklist = filter_forks_from_projects_list(\@forklist)
6610 if (@forklist);
6613 git_header_html();
6614 git_print_page_nav('summary','', $head);
6616 print "<div class=\"title\">&nbsp;</div>\n";
6617 print "<table class=\"projects_list\">\n" .
6618 "<tr id=\"metadata_desc\"><td>description</td><td>" . esc_html($descr) . "</td></tr>\n";
6619 if ($owner and not $omit_owner) {
6620 print "<tr id=\"metadata_owner\"><td>owner</td><td>" . esc_html($owner) . "</td></tr>\n";
6622 if (defined $cd{'rfc2822'}) {
6623 print "<tr id=\"metadata_lchange\"><td>last change</td>" .
6624 "<td>".format_timestamp_html(\%cd)."</td></tr>\n";
6627 # use per project git URL list in $projectroot/$project/cloneurl
6628 # or make project git URL from git base URL and project name
6629 my $url_tag = "URL";
6630 my @url_list = git_get_project_url_list($project);
6631 @url_list = map { "$_/$project" } @git_base_url_list unless @url_list;
6632 foreach my $git_url (@url_list) {
6633 next unless $git_url;
6634 print format_repo_url($url_tag, $git_url);
6635 $url_tag = "";
6638 # Tag cloud
6639 my $show_ctags = gitweb_check_feature('ctags');
6640 if ($show_ctags) {
6641 my $ctags = git_get_project_ctags($project);
6642 if (%$ctags) {
6643 # without ability to add tags, don't show if there are none
6644 my $cloud = git_populate_project_tagcloud($ctags);
6645 print "<tr id=\"metadata_ctags\">" .
6646 "<td>content tags</td>" .
6647 "<td>".git_show_project_tagcloud($cloud, 48)."</td>" .
6648 "</tr>\n";
6652 print "</table>\n";
6654 # If XSS prevention is on, we don't include README.html.
6655 # TODO: Allow a readme in some safe format.
6656 if (!$prevent_xss && -s "$projectroot/$project/README.html") {
6657 print "<div class=\"title\">readme</div>\n" .
6658 "<div class=\"readme\">\n";
6659 insert_file("$projectroot/$project/README.html");
6660 print "\n</div>\n"; # class="readme"
6663 # we need to request one more than 16 (0..15) to check if
6664 # those 16 are all
6665 my @commitlist = $head ? parse_commits($head, 17) : ();
6666 if (@commitlist) {
6667 git_print_header_div('shortlog');
6668 git_shortlog_body(\@commitlist, 0, 15, $refs,
6669 $#commitlist <= 15 ? undef :
6670 $cgi->a({-href => href(action=>"shortlog")}, "..."));
6673 if (@taglist) {
6674 git_print_header_div('tags');
6675 git_tags_body(\@taglist, 0, 15,
6676 $#taglist <= 15 ? undef :
6677 $cgi->a({-href => href(action=>"tags")}, "..."));
6680 if (@headlist) {
6681 git_print_header_div('heads');
6682 git_heads_body(\@headlist, $head, 0, 15,
6683 $#headlist <= 15 ? undef :
6684 $cgi->a({-href => href(action=>"heads")}, "..."));
6687 if (%remotedata) {
6688 git_print_header_div('remotes');
6689 git_remotes_body(\%remotedata, 15, $head);
6692 if (@forklist) {
6693 git_print_header_div('forks');
6694 git_project_list_body(\@forklist, 'age', 0, 15,
6695 $#forklist <= 15 ? undef :
6696 $cgi->a({-href => href(action=>"forks")}, "..."),
6697 'no_header');
6700 git_footer_html();
6703 sub git_tag {
6704 my %tag = parse_tag($hash);
6706 if (! %tag) {
6707 die_error(404, "Unknown tag object");
6710 my $head = git_get_head_hash($project);
6711 git_header_html();
6712 git_print_page_nav('','', $head,undef,$head);
6713 git_print_header_div('commit', esc_html($tag{'name'}), $hash);
6714 print "<div class=\"title_text\">\n" .
6715 "<table class=\"object_header\">\n" .
6716 "<tr>\n" .
6717 "<td>object</td>\n" .
6718 "<td>" . $cgi->a({-class => "list", -href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6719 $tag{'object'}) . "</td>\n" .
6720 "<td class=\"link\">" . $cgi->a({-href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6721 $tag{'type'}) . "</td>\n" .
6722 "</tr>\n";
6723 if (defined($tag{'author'})) {
6724 git_print_authorship_rows(\%tag, 'author');
6726 print "</table>\n\n" .
6727 "</div>\n";
6728 print "<div class=\"page_body\">";
6729 my $comment = $tag{'comment'};
6730 foreach my $line (@$comment) {
6731 chomp $line;
6732 print esc_html($line, -nbsp=>1) . "<br/>\n";
6734 print "</div>\n";
6735 git_footer_html();
6738 sub git_blame_common {
6739 my $format = shift || 'porcelain';
6740 if ($format eq 'porcelain' && $input_params{'javascript'}) {
6741 $format = 'incremental';
6742 $action = 'blame_incremental'; # for page title etc
6745 # permissions
6746 gitweb_check_feature('blame')
6747 or die_error(403, "Blame view not allowed");
6749 # error checking
6750 die_error(400, "No file name given") unless $file_name;
6751 $hash_base ||= git_get_head_hash($project);
6752 die_error(404, "Couldn't find base commit") unless $hash_base;
6753 my %co = parse_commit($hash_base)
6754 or die_error(404, "Commit not found");
6755 my $ftype = "blob";
6756 if (!defined $hash) {
6757 $hash = git_get_hash_by_path($hash_base, $file_name, "blob")
6758 or die_error(404, "Error looking up file");
6759 } else {
6760 $ftype = git_get_type($hash);
6761 if ($ftype !~ "blob") {
6762 die_error(400, "Object is not a blob");
6766 my $fd;
6767 if ($format eq 'incremental') {
6768 # get file contents (as base)
6769 open $fd, "-|", git_cmd(), 'cat-file', 'blob', $hash
6770 or die_error(500, "Open git-cat-file failed");
6771 } elsif ($format eq 'data') {
6772 # run git-blame --incremental
6773 open $fd, "-|", git_cmd(), "blame", "--incremental",
6774 $hash_base, "--", $file_name
6775 or die_error(500, "Open git-blame --incremental failed");
6776 } else {
6777 # run git-blame --porcelain
6778 open $fd, "-|", git_cmd(), "blame", '-p',
6779 $hash_base, '--', $file_name
6780 or die_error(500, "Open git-blame --porcelain failed");
6782 binmode $fd, ':utf8';
6784 # incremental blame data returns early
6785 if ($format eq 'data') {
6786 print $cgi->header(
6787 -type=>"text/plain", -charset => "utf-8",
6788 -status=> "200 OK");
6789 local $| = 1; # output autoflush
6790 while (my $line = <$fd>) {
6791 print to_utf8($line);
6793 close $fd
6794 or print "ERROR $!\n";
6796 print 'END';
6797 if (defined $t0 && gitweb_check_feature('timed')) {
6798 print ' '.
6799 tv_interval($t0, [ gettimeofday() ]).
6800 ' '.$number_of_git_cmds;
6802 print "\n";
6804 return;
6807 # page header
6808 git_header_html();
6809 my $formats_nav =
6810 $cgi->a({-href => href(action=>"blob", -replay=>1)},
6811 "blob") .
6812 " | ";
6813 if ($format eq 'incremental') {
6814 $formats_nav .=
6815 $cgi->a({-href => href(action=>"blame", javascript=>0, -replay=>1)},
6816 "blame") . " (non-incremental)";
6817 } else {
6818 $formats_nav .=
6819 $cgi->a({-href => href(action=>"blame_incremental", -replay=>1)},
6820 "blame") . " (incremental)";
6822 $formats_nav .=
6823 " | " .
6824 $cgi->a({-href => href(action=>"history", -replay=>1)},
6825 "history") .
6826 " | " .
6827 $cgi->a({-href => href(action=>$action, file_name=>$file_name)},
6828 "HEAD");
6829 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
6830 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
6831 git_print_page_path($file_name, $ftype, $hash_base);
6833 # page body
6834 if ($format eq 'incremental') {
6835 print "<noscript>\n<div class=\"error\"><center><b>\n".
6836 "This page requires JavaScript to run.\n Use ".
6837 $cgi->a({-href => href(action=>'blame',javascript=>0,-replay=>1)},
6838 'this page').
6839 " instead.\n".
6840 "</b></center></div>\n</noscript>\n";
6842 print qq!<div id="progress_bar" style="width: 100%; background-color: yellow"></div>\n!;
6845 print qq!<div class="page_body">\n!;
6846 print qq!<div id="progress_info">... / ...</div>\n!
6847 if ($format eq 'incremental');
6848 print qq!<table id="blame_table" class="blame" width="100%">\n!.
6849 #qq!<col width="5.5em" /><col width="2.5em" /><col width="*" />\n!.
6850 qq!<thead>\n!.
6851 qq!<tr><th>Commit</th><th>Line</th><th>Data</th></tr>\n!.
6852 qq!</thead>\n!.
6853 qq!<tbody>\n!;
6855 my @rev_color = qw(light dark);
6856 my $num_colors = scalar(@rev_color);
6857 my $current_color = 0;
6859 if ($format eq 'incremental') {
6860 my $color_class = $rev_color[$current_color];
6862 #contents of a file
6863 my $linenr = 0;
6864 LINE:
6865 while (my $line = <$fd>) {
6866 chomp $line;
6867 $linenr++;
6869 print qq!<tr id="l$linenr" class="$color_class">!.
6870 qq!<td class="sha1"><a href=""> </a></td>!.
6871 qq!<td class="linenr">!.
6872 qq!<a class="linenr" href="">$linenr</a></td>!;
6873 print qq!<td class="pre">! . esc_html($line) . "</td>\n";
6874 print qq!</tr>\n!;
6877 } else { # porcelain, i.e. ordinary blame
6878 my %metainfo = (); # saves information about commits
6880 # blame data
6881 LINE:
6882 while (my $line = <$fd>) {
6883 chomp $line;
6884 # the header: <SHA-1> <src lineno> <dst lineno> [<lines in group>]
6885 # no <lines in group> for subsequent lines in group of lines
6886 my ($full_rev, $orig_lineno, $lineno, $group_size) =
6887 ($line =~ /^($oid_regex) (\d+) (\d+)(?: (\d+))?$/);
6888 if (!exists $metainfo{$full_rev}) {
6889 $metainfo{$full_rev} = { 'nprevious' => 0 };
6891 my $meta = $metainfo{$full_rev};
6892 my $data;
6893 while ($data = <$fd>) {
6894 chomp $data;
6895 last if ($data =~ s/^\t//); # contents of line
6896 if ($data =~ /^(\S+)(?: (.*))?$/) {
6897 $meta->{$1} = $2 unless exists $meta->{$1};
6899 if ($data =~ /^previous /) {
6900 $meta->{'nprevious'}++;
6903 my $short_rev = substr($full_rev, 0, 8);
6904 my $author = $meta->{'author'};
6905 my %date =
6906 parse_date($meta->{'author-time'}, $meta->{'author-tz'});
6907 my $date = $date{'iso-tz'};
6908 if ($group_size) {
6909 $current_color = ($current_color + 1) % $num_colors;
6911 my $tr_class = $rev_color[$current_color];
6912 $tr_class .= ' boundary' if (exists $meta->{'boundary'});
6913 $tr_class .= ' no-previous' if ($meta->{'nprevious'} == 0);
6914 $tr_class .= ' multiple-previous' if ($meta->{'nprevious'} > 1);
6915 print "<tr id=\"l$lineno\" class=\"$tr_class\">\n";
6916 if ($group_size) {
6917 print "<td class=\"sha1\"";
6918 print " title=\"". esc_html($author) . ", $date\"";
6919 print " rowspan=\"$group_size\"" if ($group_size > 1);
6920 print ">";
6921 print $cgi->a({-href => href(action=>"commit",
6922 hash=>$full_rev,
6923 file_name=>$file_name)},
6924 esc_html($short_rev));
6925 if ($group_size >= 2) {
6926 my @author_initials = ($author =~ /\b([[:upper:]])\B/g);
6927 if (@author_initials) {
6928 print "<br />" .
6929 esc_html(join('', @author_initials));
6930 # or join('.', ...)
6933 print "</td>\n";
6935 # 'previous' <sha1 of parent commit> <filename at commit>
6936 if (exists $meta->{'previous'} &&
6937 $meta->{'previous'} =~ /^($oid_regex) (.*)$/) {
6938 $meta->{'parent'} = $1;
6939 $meta->{'file_parent'} = unquote($2);
6941 my $linenr_commit =
6942 exists($meta->{'parent'}) ?
6943 $meta->{'parent'} : $full_rev;
6944 my $linenr_filename =
6945 exists($meta->{'file_parent'}) ?
6946 $meta->{'file_parent'} : unquote($meta->{'filename'});
6947 my $blamed = href(action => 'blame',
6948 file_name => $linenr_filename,
6949 hash_base => $linenr_commit);
6950 print "<td class=\"linenr\">";
6951 print $cgi->a({ -href => "$blamed#l$orig_lineno",
6952 -class => "linenr" },
6953 esc_html($lineno));
6954 print "</td>";
6955 print "<td class=\"pre\">" . esc_html($data) . "</td>\n";
6956 print "</tr>\n";
6957 } # end while
6961 # footer
6962 print "</tbody>\n".
6963 "</table>\n"; # class="blame"
6964 print "</div>\n"; # class="blame_body"
6965 close $fd
6966 or print "Reading blob failed\n";
6968 git_footer_html();
6971 sub git_blame {
6972 git_blame_common();
6975 sub git_blame_incremental {
6976 git_blame_common('incremental');
6979 sub git_blame_data {
6980 git_blame_common('data');
6983 sub git_tags {
6984 my $head = git_get_head_hash($project);
6985 git_header_html();
6986 git_print_page_nav('','', $head,undef,$head,format_ref_views('tags'));
6987 git_print_header_div('summary', $project);
6989 my @tagslist = git_get_tags_list();
6990 if (@tagslist) {
6991 git_tags_body(\@tagslist);
6993 git_footer_html();
6996 sub git_heads {
6997 my $head = git_get_head_hash($project);
6998 git_header_html();
6999 git_print_page_nav('','', $head,undef,$head,format_ref_views('heads'));
7000 git_print_header_div('summary', $project);
7002 my @headslist = git_get_heads_list();
7003 if (@headslist) {
7004 git_heads_body(\@headslist, $head);
7006 git_footer_html();
7009 # used both for single remote view and for list of all the remotes
7010 sub git_remotes {
7011 gitweb_check_feature('remote_heads')
7012 or die_error(403, "Remote heads view is disabled");
7014 my $head = git_get_head_hash($project);
7015 my $remote = $input_params{'hash'};
7017 my $remotedata = git_get_remotes_list($remote);
7018 die_error(500, "Unable to get remote information") unless defined $remotedata;
7020 unless (%$remotedata) {
7021 die_error(404, defined $remote ?
7022 "Remote $remote not found" :
7023 "No remotes found");
7026 git_header_html(undef, undef, -action_extra => $remote);
7027 git_print_page_nav('', '', $head, undef, $head,
7028 format_ref_views($remote ? '' : 'remotes'));
7030 fill_remote_heads($remotedata);
7031 if (defined $remote) {
7032 git_print_header_div('remotes', "$remote remote for $project");
7033 git_remote_block($remote, $remotedata->{$remote}, undef, $head);
7034 } else {
7035 git_print_header_div('summary', "$project remotes");
7036 git_remotes_body($remotedata, undef, $head);
7039 git_footer_html();
7042 sub git_blob_plain {
7043 my $type = shift;
7044 my $expires;
7046 if (!defined $hash) {
7047 if (defined $file_name) {
7048 my $base = $hash_base || git_get_head_hash($project);
7049 $hash = git_get_hash_by_path($base, $file_name, "blob")
7050 or die_error(404, "Cannot find file");
7051 } else {
7052 die_error(400, "No file name defined");
7054 } elsif ($hash =~ m/^$oid_regex$/) {
7055 # blobs defined by non-textual hash id's can be cached
7056 $expires = "+1d";
7059 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
7060 or die_error(500, "Open git-cat-file blob '$hash' failed");
7062 # content-type (can include charset)
7063 $type = blob_contenttype($fd, $file_name, $type);
7065 # "save as" filename, even when no $file_name is given
7066 my $save_as = "$hash";
7067 if (defined $file_name) {
7068 $save_as = $file_name;
7069 } elsif ($type =~ m/^text\//) {
7070 $save_as .= '.txt';
7073 # With XSS prevention on, blobs of all types except a few known safe
7074 # ones are served with "Content-Disposition: attachment" to make sure
7075 # they don't run in our security domain. For certain image types,
7076 # blob view writes an <img> tag referring to blob_plain view, and we
7077 # want to be sure not to break that by serving the image as an
7078 # attachment (though Firefox 3 doesn't seem to care).
7079 my $sandbox = $prevent_xss &&
7080 $type !~ m!^(?:text/[a-z]+|image/(?:gif|png|jpeg))(?:[ ;]|$)!;
7082 # serve text/* as text/plain
7083 if ($prevent_xss &&
7084 ($type =~ m!^text/[a-z]+\b(.*)$! ||
7085 ($type =~ m!^[a-z]+/[a-z]\+xml\b(.*)$! && -T $fd))) {
7086 my $rest = $1;
7087 $rest = defined $rest ? $rest : '';
7088 $type = "text/plain$rest";
7091 print $cgi->header(
7092 -type => $type,
7093 -expires => $expires,
7094 -content_disposition =>
7095 ($sandbox ? 'attachment' : 'inline')
7096 . '; filename="' . $save_as . '"');
7097 local $/ = undef;
7098 local *FCGI::Stream::PRINT = $FCGI_Stream_PRINT_raw;
7099 binmode STDOUT, ':raw';
7100 print <$fd>;
7101 binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
7102 close $fd;
7105 sub git_blob {
7106 my $expires;
7108 if (!defined $hash) {
7109 if (defined $file_name) {
7110 my $base = $hash_base || git_get_head_hash($project);
7111 $hash = git_get_hash_by_path($base, $file_name, "blob")
7112 or die_error(404, "Cannot find file");
7113 } else {
7114 die_error(400, "No file name defined");
7116 } elsif ($hash =~ m/^$oid_regex$/) {
7117 # blobs defined by non-textual hash id's can be cached
7118 $expires = "+1d";
7121 my $have_blame = gitweb_check_feature('blame');
7122 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
7123 or die_error(500, "Couldn't cat $file_name, $hash");
7124 my $mimetype = blob_mimetype($fd, $file_name);
7125 # use 'blob_plain' (aka 'raw') view for files that cannot be displayed
7126 if ($mimetype !~ m!^(?:text/|image/(?:gif|png|jpeg)$)! && -B $fd) {
7127 close $fd;
7128 return git_blob_plain($mimetype);
7130 # we can have blame only for text/* mimetype
7131 $have_blame &&= ($mimetype =~ m!^text/!);
7133 my $highlight = gitweb_check_feature('highlight');
7134 my $syntax = guess_file_syntax($highlight, $file_name);
7135 $fd = run_highlighter($fd, $highlight, $syntax);
7137 git_header_html(undef, $expires);
7138 my $formats_nav = '';
7139 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7140 if (defined $file_name) {
7141 if ($have_blame) {
7142 $formats_nav .=
7143 $cgi->a({-href => href(action=>"blame", -replay=>1)},
7144 "blame") .
7145 " | ";
7147 $formats_nav .=
7148 $cgi->a({-href => href(action=>"history", -replay=>1)},
7149 "history") .
7150 " | " .
7151 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
7152 "raw") .
7153 " | " .
7154 $cgi->a({-href => href(action=>"blob",
7155 hash_base=>"HEAD", file_name=>$file_name)},
7156 "HEAD");
7157 } else {
7158 $formats_nav .=
7159 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
7160 "raw");
7162 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
7163 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
7164 } else {
7165 print "<div class=\"page_nav\">\n" .
7166 "<br/><br/></div>\n" .
7167 "<div class=\"title\">".esc_html($hash)."</div>\n";
7169 git_print_page_path($file_name, "blob", $hash_base);
7170 print "<div class=\"page_body\">\n";
7171 if ($mimetype =~ m!^image/!) {
7172 print qq!<img class="blob" type="!.esc_attr($mimetype).qq!"!;
7173 if ($file_name) {
7174 print qq! alt="!.esc_attr($file_name).qq!" title="!.esc_attr($file_name).qq!"!;
7176 print qq! src="! .
7177 esc_attr(href(action=>"blob_plain", hash=>$hash,
7178 hash_base=>$hash_base, file_name=>$file_name)) .
7179 qq!" />\n!;
7180 } else {
7181 my $nr;
7182 while (my $line = <$fd>) {
7183 chomp $line;
7184 $nr++;
7185 $line = untabify($line);
7186 printf qq!<div class="pre"><a id="l%i" href="%s#l%i" class="linenr">%4i</a> %s</div>\n!,
7187 $nr, esc_attr(href(-replay => 1)), $nr, $nr,
7188 $highlight ? sanitize($line) : esc_html($line, -nbsp=>1);
7191 close $fd
7192 or print "Reading blob failed.\n";
7193 print "</div>";
7194 git_footer_html();
7197 sub git_tree {
7198 if (!defined $hash_base) {
7199 $hash_base = "HEAD";
7201 if (!defined $hash) {
7202 if (defined $file_name) {
7203 $hash = git_get_hash_by_path($hash_base, $file_name, "tree");
7204 } else {
7205 $hash = $hash_base;
7208 die_error(404, "No such tree") unless defined($hash);
7210 my $show_sizes = gitweb_check_feature('show-sizes');
7211 my $have_blame = gitweb_check_feature('blame');
7213 my @entries = ();
7215 local $/ = "\0";
7216 open my $fd, "-|", git_cmd(), "ls-tree", '-z',
7217 ($show_sizes ? '-l' : ()), @extra_options, $hash
7218 or die_error(500, "Open git-ls-tree failed");
7219 @entries = map { chomp; $_ } <$fd>;
7220 close $fd
7221 or die_error(404, "Reading tree failed");
7224 my $refs = git_get_references();
7225 my $ref = format_ref_marker($refs, $hash_base);
7226 git_header_html();
7227 my $basedir = '';
7228 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7229 my @views_nav = ();
7230 if (defined $file_name) {
7231 push @views_nav,
7232 $cgi->a({-href => href(action=>"history", -replay=>1)},
7233 "history"),
7234 $cgi->a({-href => href(action=>"tree",
7235 hash_base=>"HEAD", file_name=>$file_name)},
7236 "HEAD"),
7238 my $snapshot_links = format_snapshot_links($hash);
7239 if (defined $snapshot_links) {
7240 # FIXME: Should be available when we have no hash base as well.
7241 push @views_nav, $snapshot_links;
7243 git_print_page_nav('tree','', $hash_base, undef, undef,
7244 join(' | ', @views_nav));
7245 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash_base);
7246 } else {
7247 undef $hash_base;
7248 print "<div class=\"page_nav\">\n";
7249 print "<br/><br/></div>\n";
7250 print "<div class=\"title\">".esc_html($hash)."</div>\n";
7252 if (defined $file_name) {
7253 $basedir = $file_name;
7254 if ($basedir ne '' && substr($basedir, -1) ne '/') {
7255 $basedir .= '/';
7257 git_print_page_path($file_name, 'tree', $hash_base);
7259 print "<div class=\"page_body\">\n";
7260 print "<table class=\"tree\">\n";
7261 my $alternate = 1;
7262 # '..' (top directory) link if possible
7263 if (defined $hash_base &&
7264 defined $file_name && $file_name =~ m![^/]+$!) {
7265 if ($alternate) {
7266 print "<tr class=\"dark\">\n";
7267 } else {
7268 print "<tr class=\"light\">\n";
7270 $alternate ^= 1;
7272 my $up = $file_name;
7273 $up =~ s!/?[^/]+$!!;
7274 undef $up unless $up;
7275 # based on git_print_tree_entry
7276 print '<td class="mode">' . mode_str('040000') . "</td>\n";
7277 print '<td class="size">&nbsp;</td>'."\n" if $show_sizes;
7278 print '<td class="list">';
7279 print $cgi->a({-href => href(action=>"tree",
7280 hash_base=>$hash_base,
7281 file_name=>$up)},
7282 "..");
7283 print "</td>\n";
7284 print "<td class=\"link\"></td>\n";
7286 print "</tr>\n";
7288 foreach my $line (@entries) {
7289 my %t = parse_ls_tree_line($line, -z => 1, -l => $show_sizes);
7291 if ($alternate) {
7292 print "<tr class=\"dark\">\n";
7293 } else {
7294 print "<tr class=\"light\">\n";
7296 $alternate ^= 1;
7298 git_print_tree_entry(\%t, $basedir, $hash_base, $have_blame);
7300 print "</tr>\n";
7302 print "</table>\n" .
7303 "</div>";
7304 git_footer_html();
7307 sub sanitize_for_filename {
7308 my $name = shift;
7310 $name =~ s!/!-!g;
7311 $name =~ s/[^[:alnum:]_.-]//g;
7313 return $name;
7316 sub snapshot_name {
7317 my ($project, $hash) = @_;
7319 # path/to/project.git -> project
7320 # path/to/project/.git -> project
7321 my $name = to_utf8($project);
7322 $name =~ s,([^/])/*\.git$,$1,;
7323 $name = sanitize_for_filename(basename($name));
7325 my $ver = $hash;
7326 if ($hash =~ /^[0-9a-fA-F]+$/) {
7327 # shorten SHA-1 hash
7328 my $full_hash = git_get_full_hash($project, $hash);
7329 if ($full_hash =~ /^$hash/ && length($hash) > 7) {
7330 $ver = git_get_short_hash($project, $hash);
7332 } elsif ($hash =~ m!^refs/tags/(.*)$!) {
7333 # tags don't need shortened SHA-1 hash
7334 $ver = $1;
7335 } else {
7336 # branches and other need shortened SHA-1 hash
7337 my $strip_refs = join '|', map { quotemeta } get_branch_refs();
7338 if ($hash =~ m!^refs/($strip_refs|remotes)/(.*)$!) {
7339 my $ref_dir = (defined $1) ? $1 : '';
7340 $ver = $2;
7342 $ref_dir = sanitize_for_filename($ref_dir);
7343 # for refs neither in heads nor remotes we want to
7344 # add a ref dir to archive name
7345 if ($ref_dir ne '' and $ref_dir ne 'heads' and $ref_dir ne 'remotes') {
7346 $ver = $ref_dir . '-' . $ver;
7349 $ver .= '-' . git_get_short_hash($project, $hash);
7351 # special case of sanitization for filename - we change
7352 # slashes to dots instead of dashes
7353 # in case of hierarchical branch names
7354 $ver =~ s!/!.!g;
7355 $ver =~ s/[^[:alnum:]_.-]//g;
7357 # name = project-version_string
7358 $name = "$name-$ver";
7360 return wantarray ? ($name, $name) : $name;
7363 sub exit_if_unmodified_since {
7364 my ($latest_epoch) = @_;
7365 our $cgi;
7367 my $if_modified = $cgi->http('IF_MODIFIED_SINCE');
7368 if (defined $if_modified) {
7369 my $since;
7370 if (eval { require HTTP::Date; 1; }) {
7371 $since = HTTP::Date::str2time($if_modified);
7372 } elsif (eval { require Time::ParseDate; 1; }) {
7373 $since = Time::ParseDate::parsedate($if_modified, GMT => 1);
7375 if (defined $since && $latest_epoch <= $since) {
7376 my %latest_date = parse_date($latest_epoch);
7377 print $cgi->header(
7378 -last_modified => $latest_date{'rfc2822'},
7379 -status => '304 Not Modified');
7380 goto DONE_GITWEB;
7385 sub git_snapshot {
7386 my $format = $input_params{'snapshot_format'};
7387 if (!@snapshot_fmts) {
7388 die_error(403, "Snapshots not allowed");
7390 # default to first supported snapshot format
7391 $format ||= $snapshot_fmts[0];
7392 if ($format !~ m/^[a-z0-9]+$/) {
7393 die_error(400, "Invalid snapshot format parameter");
7394 } elsif (!exists($known_snapshot_formats{$format})) {
7395 die_error(400, "Unknown snapshot format");
7396 } elsif ($known_snapshot_formats{$format}{'disabled'}) {
7397 die_error(403, "Snapshot format not allowed");
7398 } elsif (!grep($_ eq $format, @snapshot_fmts)) {
7399 die_error(403, "Unsupported snapshot format");
7402 my $type = git_get_type("$hash^{}");
7403 if (!$type) {
7404 die_error(404, 'Object does not exist');
7405 } elsif ($type eq 'blob') {
7406 die_error(400, 'Object is not a tree-ish');
7409 my ($name, $prefix) = snapshot_name($project, $hash);
7410 my $filename = "$name$known_snapshot_formats{$format}{'suffix'}";
7412 my %co = parse_commit($hash);
7413 exit_if_unmodified_since($co{'committer_epoch'}) if %co;
7415 my $cmd = quote_command(
7416 git_cmd(), 'archive',
7417 "--format=$known_snapshot_formats{$format}{'format'}",
7418 "--prefix=$prefix/", $hash);
7419 if (exists $known_snapshot_formats{$format}{'compressor'}) {
7420 $cmd .= ' | ' . quote_command(@{$known_snapshot_formats{$format}{'compressor'}});
7423 $filename =~ s/(["\\])/\\$1/g;
7424 my %latest_date;
7425 if (%co) {
7426 %latest_date = parse_date($co{'committer_epoch'}, $co{'committer_tz'});
7429 print $cgi->header(
7430 -type => $known_snapshot_formats{$format}{'type'},
7431 -content_disposition => 'inline; filename="' . $filename . '"',
7432 %co ? (-last_modified => $latest_date{'rfc2822'}) : (),
7433 -status => '200 OK');
7435 open my $fd, "-|", $cmd
7436 or die_error(500, "Execute git-archive failed");
7437 local *FCGI::Stream::PRINT = $FCGI_Stream_PRINT_raw;
7438 binmode STDOUT, ':raw';
7439 print <$fd>;
7440 binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
7441 close $fd;
7444 sub git_log_generic {
7445 my ($fmt_name, $body_subr, $base, $parent, $file_name, $file_hash) = @_;
7447 my $head = git_get_head_hash($project);
7448 if (!defined $base) {
7449 $base = $head;
7451 if (!defined $page) {
7452 $page = 0;
7454 my $refs = git_get_references();
7456 my $commit_hash = $base;
7457 if (defined $parent) {
7458 $commit_hash = "$parent..$base";
7460 my @commitlist =
7461 parse_commits($commit_hash, 101, (100 * $page),
7462 defined $file_name ? ($file_name, "--full-history") : ());
7464 my $ftype;
7465 if (!defined $file_hash && defined $file_name) {
7466 # some commits could have deleted file in question,
7467 # and not have it in tree, but one of them has to have it
7468 for (my $i = 0; $i < @commitlist; $i++) {
7469 $file_hash = git_get_hash_by_path($commitlist[$i]{'id'}, $file_name);
7470 last if defined $file_hash;
7473 if (defined $file_hash) {
7474 $ftype = git_get_type($file_hash);
7476 if (defined $file_name && !defined $ftype) {
7477 die_error(500, "Unknown type of object");
7479 my %co;
7480 if (defined $file_name) {
7481 %co = parse_commit($base)
7482 or die_error(404, "Unknown commit object");
7486 my $paging_nav = format_paging_nav($fmt_name, $page, $#commitlist >= 100);
7487 my $next_link = '';
7488 if ($#commitlist >= 100) {
7489 $next_link =
7490 $cgi->a({-href => href(-replay=>1, page=>$page+1),
7491 -accesskey => "n", -title => "Alt-n"}, "next");
7493 my $patch_max = gitweb_get_feature('patches');
7494 if ($patch_max && !defined $file_name &&
7495 !gitweb_check_feature('email-privacy')) {
7496 if ($patch_max < 0 || @commitlist <= $patch_max) {
7497 $paging_nav .= " &sdot; " .
7498 $cgi->a({-href => href(action=>"patches", -replay=>1)},
7499 "patches");
7503 git_header_html();
7504 git_print_page_nav($fmt_name,'', $hash,$hash,$hash, $paging_nav);
7505 if (defined $file_name) {
7506 git_print_header_div('commit', esc_html($co{'title'}), $base);
7507 } else {
7508 git_print_header_div('summary', $project)
7510 git_print_page_path($file_name, $ftype, $hash_base)
7511 if (defined $file_name);
7513 $body_subr->(\@commitlist, 0, 99, $refs, $next_link,
7514 $file_name, $file_hash, $ftype);
7516 git_footer_html();
7519 sub git_log {
7520 git_log_generic('log', \&git_log_body,
7521 $hash, $hash_parent);
7524 sub git_commit {
7525 $hash ||= $hash_base || "HEAD";
7526 my %co = parse_commit($hash)
7527 or die_error(404, "Unknown commit object");
7529 my $parent = $co{'parent'};
7530 my $parents = $co{'parents'}; # listref
7532 # we need to prepare $formats_nav before any parameter munging
7533 my $formats_nav;
7534 if (!defined $parent) {
7535 # --root commitdiff
7536 $formats_nav .= '(initial)';
7537 } elsif (@$parents == 1) {
7538 # single parent commit
7539 $formats_nav .=
7540 '(parent: ' .
7541 $cgi->a({-href => href(action=>"commit",
7542 hash=>$parent)},
7543 esc_html(substr($parent, 0, 7))) .
7544 ')';
7545 } else {
7546 # merge commit
7547 $formats_nav .=
7548 '(merge: ' .
7549 join(' ', map {
7550 $cgi->a({-href => href(action=>"commit",
7551 hash=>$_)},
7552 esc_html(substr($_, 0, 7)));
7553 } @$parents ) .
7554 ')';
7556 if (gitweb_check_feature('patches') && @$parents <= 1 &&
7557 !gitweb_check_feature('email-privacy')) {
7558 $formats_nav .= " | " .
7559 $cgi->a({-href => href(action=>"patch", -replay=>1)},
7560 "patch");
7563 if (!defined $parent) {
7564 $parent = "--root";
7566 my @difftree;
7567 open my $fd, "-|", git_cmd(), "diff-tree", '-r', "--no-commit-id",
7568 @diff_opts,
7569 (@$parents <= 1 ? $parent : '-c'),
7570 $hash, "--"
7571 or die_error(500, "Open git-diff-tree failed");
7572 @difftree = map { chomp; $_ } <$fd>;
7573 close $fd or die_error(404, "Reading git-diff-tree failed");
7575 # non-textual hash id's can be cached
7576 my $expires;
7577 if ($hash =~ m/^$oid_regex$/) {
7578 $expires = "+1d";
7580 my $refs = git_get_references();
7581 my $ref = format_ref_marker($refs, $co{'id'});
7583 git_header_html(undef, $expires);
7584 git_print_page_nav('commit', '',
7585 $hash, $co{'tree'}, $hash,
7586 $formats_nav);
7588 if (defined $co{'parent'}) {
7589 git_print_header_div('commitdiff', esc_html($co{'title'}) . $ref, $hash);
7590 } else {
7591 git_print_header_div('tree', esc_html($co{'title'}) . $ref, $co{'tree'}, $hash);
7593 print "<div class=\"title_text\">\n" .
7594 "<table class=\"object_header\">\n";
7595 git_print_authorship_rows(\%co);
7596 print "<tr><td>commit</td><td class=\"sha1\">$co{'id'}</td></tr>\n";
7597 print "<tr>" .
7598 "<td>tree</td>" .
7599 "<td class=\"sha1\">" .
7600 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash),
7601 class => "list"}, $co{'tree'}) .
7602 "</td>" .
7603 "<td class=\"link\">" .
7604 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash)},
7605 "tree");
7606 my $snapshot_links = format_snapshot_links($hash);
7607 if (defined $snapshot_links) {
7608 print " | " . $snapshot_links;
7610 print "</td>" .
7611 "</tr>\n";
7613 foreach my $par (@$parents) {
7614 print "<tr>" .
7615 "<td>parent</td>" .
7616 "<td class=\"sha1\">" .
7617 $cgi->a({-href => href(action=>"commit", hash=>$par),
7618 class => "list"}, $par) .
7619 "</td>" .
7620 "<td class=\"link\">" .
7621 $cgi->a({-href => href(action=>"commit", hash=>$par)}, "commit") .
7622 " | " .
7623 $cgi->a({-href => href(action=>"commitdiff", hash=>$hash, hash_parent=>$par)}, "diff") .
7624 "</td>" .
7625 "</tr>\n";
7627 print "</table>".
7628 "</div>\n";
7630 print "<div class=\"page_body\">\n";
7631 git_print_log($co{'comment'});
7632 print "</div>\n";
7634 git_difftree_body(\@difftree, $hash, @$parents);
7636 git_footer_html();
7639 sub git_object {
7640 # object is defined by:
7641 # - hash or hash_base alone
7642 # - hash_base and file_name
7643 my $type;
7645 # - hash or hash_base alone
7646 if ($hash || ($hash_base && !defined $file_name)) {
7647 my $object_id = $hash || $hash_base;
7649 open my $fd, "-|", quote_command(
7650 git_cmd(), 'cat-file', '-t', $object_id) . ' 2> /dev/null'
7651 or die_error(404, "Object does not exist");
7652 $type = <$fd>;
7653 defined $type && chomp $type;
7654 close $fd
7655 or die_error(404, "Object does not exist");
7657 # - hash_base and file_name
7658 } elsif ($hash_base && defined $file_name) {
7659 $file_name =~ s,/+$,,;
7661 system(git_cmd(), "cat-file", '-e', $hash_base) == 0
7662 or die_error(404, "Base object does not exist");
7664 # here errors should not happen
7665 open my $fd, "-|", git_cmd(), "ls-tree", $hash_base, "--", $file_name
7666 or die_error(500, "Open git-ls-tree failed");
7667 my $line = <$fd>;
7668 close $fd;
7670 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
7671 unless ($line && $line =~ m/^([0-9]+) (.+) ($oid_regex)\t/) {
7672 die_error(404, "File or directory for given base does not exist");
7674 $type = $2;
7675 $hash = $3;
7676 } else {
7677 die_error(400, "Not enough information to find object");
7680 print $cgi->redirect(-uri => href(action=>$type, -full=>1,
7681 hash=>$hash, hash_base=>$hash_base,
7682 file_name=>$file_name),
7683 -status => '302 Found');
7686 sub git_blobdiff {
7687 my $format = shift || 'html';
7688 my $diff_style = $input_params{'diff_style'} || 'inline';
7690 my $fd;
7691 my @difftree;
7692 my %diffinfo;
7693 my $expires;
7695 # preparing $fd and %diffinfo for git_patchset_body
7696 # new style URI
7697 if (defined $hash_base && defined $hash_parent_base) {
7698 if (defined $file_name) {
7699 # read raw output
7700 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7701 $hash_parent_base, $hash_base,
7702 "--", (defined $file_parent ? $file_parent : ()), $file_name
7703 or die_error(500, "Open git-diff-tree failed");
7704 @difftree = map { chomp; $_ } <$fd>;
7705 close $fd
7706 or die_error(404, "Reading git-diff-tree failed");
7707 @difftree
7708 or die_error(404, "Blob diff not found");
7710 } elsif (defined $hash &&
7711 $hash =~ $oid_regex) {
7712 # try to find filename from $hash
7714 # read filtered raw output
7715 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7716 $hash_parent_base, $hash_base, "--"
7717 or die_error(500, "Open git-diff-tree failed");
7718 @difftree =
7719 # ':100644 100644 03b21826... 3b93d5e7... M ls-files.c'
7720 # $hash == to_id
7721 grep { /^:[0-7]{6} [0-7]{6} $oid_regex $hash/ }
7722 map { chomp; $_ } <$fd>;
7723 close $fd
7724 or die_error(404, "Reading git-diff-tree failed");
7725 @difftree
7726 or die_error(404, "Blob diff not found");
7728 } else {
7729 die_error(400, "Missing one of the blob diff parameters");
7732 if (@difftree > 1) {
7733 die_error(400, "Ambiguous blob diff specification");
7736 %diffinfo = parse_difftree_raw_line($difftree[0]);
7737 $file_parent ||= $diffinfo{'from_file'} || $file_name;
7738 $file_name ||= $diffinfo{'to_file'};
7740 $hash_parent ||= $diffinfo{'from_id'};
7741 $hash ||= $diffinfo{'to_id'};
7743 # non-textual hash id's can be cached
7744 if ($hash_base =~ m/^$oid_regex$/ &&
7745 $hash_parent_base =~ m/^$oid_regex$/) {
7746 $expires = '+1d';
7749 # open patch output
7750 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7751 '-p', ($format eq 'html' ? "--full-index" : ()),
7752 $hash_parent_base, $hash_base,
7753 "--", (defined $file_parent ? $file_parent : ()), $file_name
7754 or die_error(500, "Open git-diff-tree failed");
7757 # old/legacy style URI -- not generated anymore since 1.4.3.
7758 if (!%diffinfo) {
7759 die_error('404 Not Found', "Missing one of the blob diff parameters")
7762 # header
7763 if ($format eq 'html') {
7764 my $formats_nav =
7765 $cgi->a({-href => href(action=>"blobdiff_plain", -replay=>1)},
7766 "raw");
7767 $formats_nav .= diff_style_nav($diff_style);
7768 git_header_html(undef, $expires);
7769 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7770 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
7771 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
7772 } else {
7773 print "<div class=\"page_nav\"><br/>$formats_nav<br/></div>\n";
7774 print "<div class=\"title\">".esc_html("$hash vs $hash_parent")."</div>\n";
7776 if (defined $file_name) {
7777 git_print_page_path($file_name, "blob", $hash_base);
7778 } else {
7779 print "<div class=\"page_path\"></div>\n";
7782 } elsif ($format eq 'plain') {
7783 print $cgi->header(
7784 -type => 'text/plain',
7785 -charset => 'utf-8',
7786 -expires => $expires,
7787 -content_disposition => 'inline; filename="' . "$file_name" . '.patch"');
7789 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
7791 } else {
7792 die_error(400, "Unknown blobdiff format");
7795 # patch
7796 if ($format eq 'html') {
7797 print "<div class=\"page_body\">\n";
7799 git_patchset_body($fd, $diff_style,
7800 [ \%diffinfo ], $hash_base, $hash_parent_base);
7801 close $fd;
7803 print "</div>\n"; # class="page_body"
7804 git_footer_html();
7806 } else {
7807 while (my $line = <$fd>) {
7808 $line =~ s!a/($hash|$hash_parent)!'a/'.esc_path($diffinfo{'from_file'})!eg;
7809 $line =~ s!b/($hash|$hash_parent)!'b/'.esc_path($diffinfo{'to_file'})!eg;
7811 print $line;
7813 last if $line =~ m!^\+\+\+!;
7815 local $/ = undef;
7816 print <$fd>;
7817 close $fd;
7821 sub git_blobdiff_plain {
7822 git_blobdiff('plain');
7825 # assumes that it is added as later part of already existing navigation,
7826 # so it returns "| foo | bar" rather than just "foo | bar"
7827 sub diff_style_nav {
7828 my ($diff_style, $is_combined) = @_;
7829 $diff_style ||= 'inline';
7831 return "" if ($is_combined);
7833 my @styles = (inline => 'inline', 'sidebyside' => 'side by side');
7834 my %styles = @styles;
7835 @styles =
7836 @styles[ map { $_ * 2 } 0..$#styles/2 ];
7838 return join '',
7839 map { " | ".$_ }
7840 map {
7841 $_ eq $diff_style ? $styles{$_} :
7842 $cgi->a({-href => href(-replay=>1, diff_style => $_)}, $styles{$_})
7843 } @styles;
7846 sub git_commitdiff {
7847 my %params = @_;
7848 my $format = $params{-format} || 'html';
7849 my $diff_style = $input_params{'diff_style'} || 'inline';
7851 my ($patch_max) = gitweb_get_feature('patches');
7852 if ($format eq 'patch') {
7853 die_error(403, "Patch view not allowed") unless $patch_max;
7856 $hash ||= $hash_base || "HEAD";
7857 my %co = parse_commit($hash)
7858 or die_error(404, "Unknown commit object");
7860 # choose format for commitdiff for merge
7861 if (! defined $hash_parent && @{$co{'parents'}} > 1) {
7862 $hash_parent = '--cc';
7864 # we need to prepare $formats_nav before almost any parameter munging
7865 my $formats_nav;
7866 if ($format eq 'html') {
7867 $formats_nav =
7868 $cgi->a({-href => href(action=>"commitdiff_plain", -replay=>1)},
7869 "raw");
7870 if ($patch_max && @{$co{'parents'}} <= 1 &&
7871 !gitweb_check_feature('email-privacy')) {
7872 $formats_nav .= " | " .
7873 $cgi->a({-href => href(action=>"patch", -replay=>1)},
7874 "patch");
7876 $formats_nav .= diff_style_nav($diff_style, @{$co{'parents'}} > 1);
7878 if (defined $hash_parent &&
7879 $hash_parent ne '-c' && $hash_parent ne '--cc') {
7880 # commitdiff with two commits given
7881 my $hash_parent_short = $hash_parent;
7882 if ($hash_parent =~ m/^$oid_regex$/) {
7883 $hash_parent_short = substr($hash_parent, 0, 7);
7885 $formats_nav .=
7886 ' (from';
7887 for (my $i = 0; $i < @{$co{'parents'}}; $i++) {
7888 if ($co{'parents'}[$i] eq $hash_parent) {
7889 $formats_nav .= ' parent ' . ($i+1);
7890 last;
7893 $formats_nav .= ': ' .
7894 $cgi->a({-href => href(-replay=>1,
7895 hash=>$hash_parent, hash_base=>undef)},
7896 esc_html($hash_parent_short)) .
7897 ')';
7898 } elsif (!$co{'parent'}) {
7899 # --root commitdiff
7900 $formats_nav .= ' (initial)';
7901 } elsif (scalar @{$co{'parents'}} == 1) {
7902 # single parent commit
7903 $formats_nav .=
7904 ' (parent: ' .
7905 $cgi->a({-href => href(-replay=>1,
7906 hash=>$co{'parent'}, hash_base=>undef)},
7907 esc_html(substr($co{'parent'}, 0, 7))) .
7908 ')';
7909 } else {
7910 # merge commit
7911 if ($hash_parent eq '--cc') {
7912 $formats_nav .= ' | ' .
7913 $cgi->a({-href => href(-replay=>1,
7914 hash=>$hash, hash_parent=>'-c')},
7915 'combined');
7916 } else { # $hash_parent eq '-c'
7917 $formats_nav .= ' | ' .
7918 $cgi->a({-href => href(-replay=>1,
7919 hash=>$hash, hash_parent=>'--cc')},
7920 'compact');
7922 $formats_nav .=
7923 ' (merge: ' .
7924 join(' ', map {
7925 $cgi->a({-href => href(-replay=>1,
7926 hash=>$_, hash_base=>undef)},
7927 esc_html(substr($_, 0, 7)));
7928 } @{$co{'parents'}} ) .
7929 ')';
7933 my $hash_parent_param = $hash_parent;
7934 if (!defined $hash_parent_param) {
7935 # --cc for multiple parents, --root for parentless
7936 $hash_parent_param =
7937 @{$co{'parents'}} > 1 ? '--cc' : $co{'parent'} || '--root';
7940 # read commitdiff
7941 my $fd;
7942 my @difftree;
7943 if ($format eq 'html') {
7944 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7945 "--no-commit-id", "--patch-with-raw", "--full-index",
7946 $hash_parent_param, $hash, "--"
7947 or die_error(500, "Open git-diff-tree failed");
7949 while (my $line = <$fd>) {
7950 chomp $line;
7951 # empty line ends raw part of diff-tree output
7952 last unless $line;
7953 push @difftree, scalar parse_difftree_raw_line($line);
7956 } elsif ($format eq 'plain') {
7957 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7958 '-p', $hash_parent_param, $hash, "--"
7959 or die_error(500, "Open git-diff-tree failed");
7960 } elsif ($format eq 'patch') {
7961 # For commit ranges, we limit the output to the number of
7962 # patches specified in the 'patches' feature.
7963 # For single commits, we limit the output to a single patch,
7964 # diverging from the git-format-patch default.
7965 my @commit_spec = ();
7966 if ($hash_parent) {
7967 if ($patch_max > 0) {
7968 push @commit_spec, "-$patch_max";
7970 push @commit_spec, '-n', "$hash_parent..$hash";
7971 } else {
7972 if ($params{-single}) {
7973 push @commit_spec, '-1';
7974 } else {
7975 if ($patch_max > 0) {
7976 push @commit_spec, "-$patch_max";
7978 push @commit_spec, "-n";
7980 push @commit_spec, '--root', $hash;
7982 open $fd, "-|", git_cmd(), "format-patch", @diff_opts,
7983 '--encoding=utf8', '--stdout', @commit_spec
7984 or die_error(500, "Open git-format-patch failed");
7985 } else {
7986 die_error(400, "Unknown commitdiff format");
7989 # non-textual hash id's can be cached
7990 my $expires;
7991 if ($hash =~ m/^$oid_regex$/) {
7992 $expires = "+1d";
7995 # write commit message
7996 if ($format eq 'html') {
7997 my $refs = git_get_references();
7998 my $ref = format_ref_marker($refs, $co{'id'});
8000 git_header_html(undef, $expires);
8001 git_print_page_nav('commitdiff','', $hash,$co{'tree'},$hash, $formats_nav);
8002 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash);
8003 print "<div class=\"title_text\">\n" .
8004 "<table class=\"object_header\">\n";
8005 git_print_authorship_rows(\%co);
8006 print "</table>".
8007 "</div>\n";
8008 print "<div class=\"page_body\">\n";
8009 if (@{$co{'comment'}} > 1) {
8010 print "<div class=\"log\">\n";
8011 git_print_log($co{'comment'}, -final_empty_line=> 1, -remove_title => 1);
8012 print "</div>\n"; # class="log"
8015 } elsif ($format eq 'plain') {
8016 my $refs = git_get_references("tags");
8017 my $tagname = git_get_rev_name_tags($hash);
8018 my $filename = basename($project) . "-$hash.patch";
8020 print $cgi->header(
8021 -type => 'text/plain',
8022 -charset => 'utf-8',
8023 -expires => $expires,
8024 -content_disposition => 'inline; filename="' . "$filename" . '"');
8025 my %ad = parse_date($co{'author_epoch'}, $co{'author_tz'});
8026 print "From: " . to_utf8($co{'author'}) . "\n";
8027 print "Date: $ad{'rfc2822'} ($ad{'tz_local'})\n";
8028 print "Subject: " . to_utf8($co{'title'}) . "\n";
8030 print "X-Git-Tag: $tagname\n" if $tagname;
8031 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
8033 foreach my $line (@{$co{'comment'}}) {
8034 print to_utf8($line) . "\n";
8036 print "---\n\n";
8037 } elsif ($format eq 'patch') {
8038 my $filename = basename($project) . "-$hash.patch";
8040 print $cgi->header(
8041 -type => 'text/plain',
8042 -charset => 'utf-8',
8043 -expires => $expires,
8044 -content_disposition => 'inline; filename="' . "$filename" . '"');
8047 # write patch
8048 if ($format eq 'html') {
8049 my $use_parents = !defined $hash_parent ||
8050 $hash_parent eq '-c' || $hash_parent eq '--cc';
8051 git_difftree_body(\@difftree, $hash,
8052 $use_parents ? @{$co{'parents'}} : $hash_parent);
8053 print "<br/>\n";
8055 git_patchset_body($fd, $diff_style,
8056 \@difftree, $hash,
8057 $use_parents ? @{$co{'parents'}} : $hash_parent);
8058 close $fd;
8059 print "</div>\n"; # class="page_body"
8060 git_footer_html();
8062 } elsif ($format eq 'plain') {
8063 local $/ = undef;
8064 print <$fd>;
8065 close $fd
8066 or print "Reading git-diff-tree failed\n";
8067 } elsif ($format eq 'patch') {
8068 local $/ = undef;
8069 print <$fd>;
8070 close $fd
8071 or print "Reading git-format-patch failed\n";
8075 sub git_commitdiff_plain {
8076 git_commitdiff(-format => 'plain');
8079 # format-patch-style patches
8080 sub git_patch {
8081 git_commitdiff(-format => 'patch', -single => 1);
8084 sub git_patches {
8085 git_commitdiff(-format => 'patch');
8088 sub git_history {
8089 git_log_generic('history', \&git_history_body,
8090 $hash_base, $hash_parent_base,
8091 $file_name, $hash);
8094 sub git_search {
8095 $searchtype ||= 'commit';
8097 # check if appropriate features are enabled
8098 gitweb_check_feature('search')
8099 or die_error(403, "Search is disabled");
8100 if ($searchtype eq 'pickaxe') {
8101 # pickaxe may take all resources of your box and run for several minutes
8102 # with every query - so decide by yourself how public you make this feature
8103 gitweb_check_feature('pickaxe')
8104 or die_error(403, "Pickaxe search is disabled");
8106 if ($searchtype eq 'grep') {
8107 # grep search might be potentially CPU-intensive, too
8108 gitweb_check_feature('grep')
8109 or die_error(403, "Grep search is disabled");
8112 if (!defined $searchtext) {
8113 die_error(400, "Text field is empty");
8115 if (!defined $hash) {
8116 $hash = git_get_head_hash($project);
8118 my %co = parse_commit($hash);
8119 if (!%co) {
8120 die_error(404, "Unknown commit object");
8122 if (!defined $page) {
8123 $page = 0;
8126 if ($searchtype eq 'commit' ||
8127 $searchtype eq 'author' ||
8128 $searchtype eq 'committer') {
8129 git_search_message(%co);
8130 } elsif ($searchtype eq 'pickaxe') {
8131 git_search_changes(%co);
8132 } elsif ($searchtype eq 'grep') {
8133 git_search_files(%co);
8134 } else {
8135 die_error(400, "Unknown search type");
8139 sub git_search_help {
8140 git_header_html();
8141 git_print_page_nav('','', $hash,$hash,$hash);
8142 print <<EOT;
8143 <p><strong>Pattern</strong> is by default a normal string that is matched precisely (but without
8144 regard to case, except in the case of pickaxe). However, when you check the <em>re</em> checkbox,
8145 the pattern entered is recognized as the POSIX extended
8146 <a href="https://en.wikipedia.org/wiki/Regular_expression">regular expression</a> (also case
8147 insensitive).</p>
8148 <dl>
8149 <dt><b>commit</b></dt>
8150 <dd>The commit messages and authorship information will be scanned for the given pattern.</dd>
8152 my $have_grep = gitweb_check_feature('grep');
8153 if ($have_grep) {
8154 print <<EOT;
8155 <dt><b>grep</b></dt>
8156 <dd>All files in the currently selected tree (HEAD unless you are explicitly browsing
8157 a different one) are searched for the given pattern. On large trees, this search can take
8158 a while and put some strain on the server, so please use it with some consideration. Note that
8159 due to git-grep peculiarity, currently if regexp mode is turned off, the matches are
8160 case-sensitive.</dd>
8163 print <<EOT;
8164 <dt><b>author</b></dt>
8165 <dd>Name and e-mail of the change author and date of birth of the patch will be scanned for the given pattern.</dd>
8166 <dt><b>committer</b></dt>
8167 <dd>Name and e-mail of the committer and date of commit will be scanned for the given pattern.</dd>
8169 my $have_pickaxe = gitweb_check_feature('pickaxe');
8170 if ($have_pickaxe) {
8171 print <<EOT;
8172 <dt><b>pickaxe</b></dt>
8173 <dd>All commits that caused the string to appear or disappear from any file (changes that
8174 added, removed or "modified" the string) will be listed. This search can take a while and
8175 takes a lot of strain on the server, so please use it wisely. Note that since you may be
8176 interested even in changes just changing the case as well, this search is case sensitive.</dd>
8179 print "</dl>\n";
8180 git_footer_html();
8183 sub git_shortlog {
8184 git_log_generic('shortlog', \&git_shortlog_body,
8185 $hash, $hash_parent);
8188 ## ......................................................................
8189 ## feeds (RSS, Atom; OPML)
8191 sub git_feed {
8192 my $format = shift || 'atom';
8193 my $have_blame = gitweb_check_feature('blame');
8195 # Atom: http://www.atomenabled.org/developers/syndication/
8196 # RSS: http://www.notestips.com/80256B3A007F2692/1/NAMO5P9UPQ
8197 if ($format ne 'rss' && $format ne 'atom') {
8198 die_error(400, "Unknown web feed format");
8201 # log/feed of current (HEAD) branch, log of given branch, history of file/directory
8202 my $head = $hash || 'HEAD';
8203 my @commitlist = parse_commits($head, 150, 0, $file_name);
8205 my %latest_commit;
8206 my %latest_date;
8207 my $content_type = "application/$format+xml";
8208 if (defined $cgi->http('HTTP_ACCEPT') &&
8209 $cgi->Accept('text/xml') > $cgi->Accept($content_type)) {
8210 # browser (feed reader) prefers text/xml
8211 $content_type = 'text/xml';
8213 if (defined($commitlist[0])) {
8214 %latest_commit = %{$commitlist[0]};
8215 my $latest_epoch = $latest_commit{'committer_epoch'};
8216 exit_if_unmodified_since($latest_epoch);
8217 %latest_date = parse_date($latest_epoch, $latest_commit{'committer_tz'});
8219 print $cgi->header(
8220 -type => $content_type,
8221 -charset => 'utf-8',
8222 %latest_date ? (-last_modified => $latest_date{'rfc2822'}) : (),
8223 -status => '200 OK');
8225 # Optimization: skip generating the body if client asks only
8226 # for Last-Modified date.
8227 return if ($cgi->request_method() eq 'HEAD');
8229 # header variables
8230 my $title = "$site_name - $project/$action";
8231 my $feed_type = 'log';
8232 if (defined $hash) {
8233 $title .= " - '$hash'";
8234 $feed_type = 'branch log';
8235 if (defined $file_name) {
8236 $title .= " :: $file_name";
8237 $feed_type = 'history';
8239 } elsif (defined $file_name) {
8240 $title .= " - $file_name";
8241 $feed_type = 'history';
8243 $title .= " $feed_type";
8244 $title = esc_html($title);
8245 my $descr = git_get_project_description($project);
8246 if (defined $descr) {
8247 $descr = esc_html($descr);
8248 } else {
8249 $descr = "$project " .
8250 ($format eq 'rss' ? 'RSS' : 'Atom') .
8251 " feed";
8253 my $owner = git_get_project_owner($project);
8254 $owner = esc_html($owner);
8256 #header
8257 my $alt_url;
8258 if (defined $file_name) {
8259 $alt_url = href(-full=>1, action=>"history", hash=>$hash, file_name=>$file_name);
8260 } elsif (defined $hash) {
8261 $alt_url = href(-full=>1, action=>"log", hash=>$hash);
8262 } else {
8263 $alt_url = href(-full=>1, action=>"summary");
8265 $alt_url = esc_attr($alt_url);
8266 print qq!<?xml version="1.0" encoding="utf-8"?>\n!;
8267 if ($format eq 'rss') {
8268 print <<XML;
8269 <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
8270 <channel>
8272 print "<title>$title</title>\n" .
8273 "<link>$alt_url</link>\n" .
8274 "<description>$descr</description>\n" .
8275 "<language>en</language>\n" .
8276 # project owner is responsible for 'editorial' content
8277 "<managingEditor>$owner</managingEditor>\n";
8278 if (defined $logo || defined $favicon) {
8279 # prefer the logo to the favicon, since RSS
8280 # doesn't allow both
8281 my $img = esc_url($logo || $favicon);
8282 print "<image>\n" .
8283 "<url>$img</url>\n" .
8284 "<title>$title</title>\n" .
8285 "<link>$alt_url</link>\n" .
8286 "</image>\n";
8288 if (%latest_date) {
8289 print "<pubDate>$latest_date{'rfc2822'}</pubDate>\n";
8290 print "<lastBuildDate>$latest_date{'rfc2822'}</lastBuildDate>\n";
8292 print "<generator>gitweb v.$version/$git_version</generator>\n";
8293 } elsif ($format eq 'atom') {
8294 print <<XML;
8295 <feed xmlns="http://www.w3.org/2005/Atom">
8297 print "<title>$title</title>\n" .
8298 "<subtitle>$descr</subtitle>\n" .
8299 '<link rel="alternate" type="text/html" href="' .
8300 $alt_url . '" />' . "\n" .
8301 '<link rel="self" type="' . $content_type . '" href="' .
8302 $cgi->self_url() . '" />' . "\n" .
8303 "<id>" . esc_url(href(-full=>1)) . "</id>\n" .
8304 # use project owner for feed author
8305 "<author><name>$owner</name></author>\n";
8306 if (defined $favicon) {
8307 print "<icon>" . esc_url($favicon) . "</icon>\n";
8309 if (defined $logo) {
8310 # not twice as wide as tall: 72 x 27 pixels
8311 print "<logo>" . esc_url($logo) . "</logo>\n";
8313 if (! %latest_date) {
8314 # dummy date to keep the feed valid until commits trickle in:
8315 print "<updated>1970-01-01T00:00:00Z</updated>\n";
8316 } else {
8317 print "<updated>$latest_date{'iso-8601'}</updated>\n";
8319 print "<generator version='$version/$git_version'>gitweb</generator>\n";
8322 # contents
8323 for (my $i = 0; $i <= $#commitlist; $i++) {
8324 my %co = %{$commitlist[$i]};
8325 my $commit = $co{'id'};
8326 # we read 150, we always show 30 and the ones more recent than 48 hours
8327 if (($i >= 20) && ((time - $co{'author_epoch'}) > 48*60*60)) {
8328 last;
8330 my %cd = parse_date($co{'author_epoch'}, $co{'author_tz'});
8332 # get list of changed files
8333 open my $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
8334 $co{'parent'} || "--root",
8335 $co{'id'}, "--", (defined $file_name ? $file_name : ())
8336 or next;
8337 my @difftree = map { chomp; $_ } <$fd>;
8338 close $fd
8339 or next;
8341 # print element (entry, item)
8342 my $co_url = href(-full=>1, action=>"commitdiff", hash=>$commit);
8343 if ($format eq 'rss') {
8344 print "<item>\n" .
8345 "<title>" . esc_html($co{'title'}) . "</title>\n" .
8346 "<author>" . esc_html($co{'author'}) . "</author>\n" .
8347 "<pubDate>$cd{'rfc2822'}</pubDate>\n" .
8348 "<guid isPermaLink=\"true\">$co_url</guid>\n" .
8349 "<link>" . esc_html($co_url) . "</link>\n" .
8350 "<description>" . esc_html($co{'title'}) . "</description>\n" .
8351 "<content:encoded>" .
8352 "<![CDATA[\n";
8353 } elsif ($format eq 'atom') {
8354 print "<entry>\n" .
8355 "<title type=\"html\">" . esc_html($co{'title'}) . "</title>\n" .
8356 "<updated>$cd{'iso-8601'}</updated>\n" .
8357 "<author>\n" .
8358 " <name>" . esc_html($co{'author_name'}) . "</name>\n";
8359 if ($co{'author_email'}) {
8360 print " <email>" . esc_html($co{'author_email'}) . "</email>\n";
8362 print "</author>\n" .
8363 # use committer for contributor
8364 "<contributor>\n" .
8365 " <name>" . esc_html($co{'committer_name'}) . "</name>\n";
8366 if ($co{'committer_email'}) {
8367 print " <email>" . esc_html($co{'committer_email'}) . "</email>\n";
8369 print "</contributor>\n" .
8370 "<published>$cd{'iso-8601'}</published>\n" .
8371 "<link rel=\"alternate\" type=\"text/html\" href=\"" . esc_attr($co_url) . "\" />\n" .
8372 "<id>" . esc_html($co_url) . "</id>\n" .
8373 "<content type=\"xhtml\" xml:base=\"" . esc_url($my_url) . "\">\n" .
8374 "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n";
8376 my $comment = $co{'comment'};
8377 print "<pre>\n";
8378 foreach my $line (@$comment) {
8379 $line = esc_html($line);
8380 print "$line\n";
8382 print "</pre><ul>\n";
8383 foreach my $difftree_line (@difftree) {
8384 my %difftree = parse_difftree_raw_line($difftree_line);
8385 next if !$difftree{'from_id'};
8387 my $file = $difftree{'file'} || $difftree{'to_file'};
8389 print "<li>" .
8390 "[" .
8391 $cgi->a({-href => href(-full=>1, action=>"blobdiff",
8392 hash=>$difftree{'to_id'}, hash_parent=>$difftree{'from_id'},
8393 hash_base=>$co{'id'}, hash_parent_base=>$co{'parent'},
8394 file_name=>$file, file_parent=>$difftree{'from_file'}),
8395 -title => "diff"}, 'D');
8396 if ($have_blame) {
8397 print $cgi->a({-href => href(-full=>1, action=>"blame",
8398 file_name=>$file, hash_base=>$commit),
8399 -title => "blame"}, 'B');
8401 # if this is not a feed of a file history
8402 if (!defined $file_name || $file_name ne $file) {
8403 print $cgi->a({-href => href(-full=>1, action=>"history",
8404 file_name=>$file, hash=>$commit),
8405 -title => "history"}, 'H');
8407 $file = esc_path($file);
8408 print "] ".
8409 "$file</li>\n";
8411 if ($format eq 'rss') {
8412 print "</ul>]]>\n" .
8413 "</content:encoded>\n" .
8414 "</item>\n";
8415 } elsif ($format eq 'atom') {
8416 print "</ul>\n</div>\n" .
8417 "</content>\n" .
8418 "</entry>\n";
8422 # end of feed
8423 if ($format eq 'rss') {
8424 print "</channel>\n</rss>\n";
8425 } elsif ($format eq 'atom') {
8426 print "</feed>\n";
8430 sub git_rss {
8431 git_feed('rss');
8434 sub git_atom {
8435 git_feed('atom');
8438 sub git_opml {
8439 my @list = git_get_projects_list($project_filter, $strict_export);
8440 if (!@list) {
8441 die_error(404, "No projects found");
8444 print $cgi->header(
8445 -type => 'text/xml',
8446 -charset => 'utf-8',
8447 -content_disposition => 'inline; filename="opml.xml"');
8449 my $title = esc_html($site_name);
8450 my $filter = " within subdirectory ";
8451 if (defined $project_filter) {
8452 $filter .= esc_html($project_filter);
8453 } else {
8454 $filter = "";
8456 print <<XML;
8457 <?xml version="1.0" encoding="utf-8"?>
8458 <opml version="1.0">
8459 <head>
8460 <title>$title OPML Export$filter</title>
8461 </head>
8462 <body>
8463 <outline text="git RSS feeds">
8466 foreach my $pr (@list) {
8467 my %proj = %$pr;
8468 my $head = git_get_head_hash($proj{'path'});
8469 if (!defined $head) {
8470 next;
8472 $git_dir = "$projectroot/$proj{'path'}";
8473 my %co = parse_commit($head);
8474 if (!%co) {
8475 next;
8478 my $path = esc_html(chop_str($proj{'path'}, 25, 5));
8479 my $rss = esc_attr(href('project' => $proj{'path'}, 'action' => 'rss', -full => 1));
8480 my $html = esc_attr(href('project' => $proj{'path'}, 'action' => 'summary', -full => 1));
8481 print "<outline type=\"rss\" text=\"$path\" title=\"$path\" xmlUrl=\"$rss\" htmlUrl=\"$html\"/>\n";
8483 print <<XML;
8484 </outline>
8485 </body>
8486 </opml>