Git 2.54-rc2
[git.git] / gitweb / gitweb.perl
blobfde804593b6ff388774754a24fe1e12d678dc9a4
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 require v5.26;
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 = "https://www.kernel.org/pub/software/scm/git/docs/";
126 #our $logo_label = "git documentation";
127 our $logo_url = "https://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://andre-simon.de/zip/download.php 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://andre-simon.de/doku/highlight/en/highlight.php)
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 if (-e $filename) {
732 do $filename;
733 # die if there is a problem accessing the file
734 die $! if $!;
735 # die if there are errors parsing config file
736 die $@ if $@;
737 return 1;
739 return;
742 our ($GITWEB_CONFIG, $GITWEB_CONFIG_SYSTEM, $GITWEB_CONFIG_COMMON);
743 sub evaluate_gitweb_config {
744 our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "@GITWEB_CONFIG@";
745 our $GITWEB_CONFIG_SYSTEM = $ENV{'GITWEB_CONFIG_SYSTEM'} || "@GITWEB_CONFIG_SYSTEM@";
746 our $GITWEB_CONFIG_COMMON = $ENV{'GITWEB_CONFIG_COMMON'} || "@GITWEB_CONFIG_COMMON@";
748 # Protect against duplications of file names, to not read config twice.
749 # Only one of $GITWEB_CONFIG and $GITWEB_CONFIG_SYSTEM is used, so
750 # there possibility of duplication of filename there doesn't matter.
751 $GITWEB_CONFIG = "" if ($GITWEB_CONFIG eq $GITWEB_CONFIG_COMMON);
752 $GITWEB_CONFIG_SYSTEM = "" if ($GITWEB_CONFIG_SYSTEM eq $GITWEB_CONFIG_COMMON);
754 # Common system-wide settings for convenience.
755 # Those settings can be overridden by GITWEB_CONFIG or GITWEB_CONFIG_SYSTEM.
756 read_config_file($GITWEB_CONFIG_COMMON);
758 # Use first config file that exists. This means use the per-instance
759 # GITWEB_CONFIG if exists, otherwise use GITWEB_SYSTEM_CONFIG.
760 read_config_file($GITWEB_CONFIG) and return;
761 read_config_file($GITWEB_CONFIG_SYSTEM);
764 # Get loadavg of system, to compare against $maxload.
765 # Currently it requires '/proc/loadavg' present to get loadavg;
766 # if it is not present it returns 0, which means no load checking.
767 sub get_loadavg {
768 if( -e '/proc/loadavg' ){
769 open my $fd, '<', '/proc/loadavg'
770 or return 0;
771 my @load = split(/\s+/, scalar <$fd>);
772 close $fd;
774 # The first three columns measure CPU and IO utilization of the last one,
775 # five, and 10 minute periods. The fourth column shows the number of
776 # currently running processes and the total number of processes in the m/n
777 # format. The last column displays the last process ID used.
778 return $load[0] || 0;
780 # additional checks for load average should go here for things that don't export
781 # /proc/loadavg
783 return 0;
786 # version of the core git binary
787 our $git_version;
788 sub evaluate_git_version {
789 our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";
790 $number_of_git_cmds++;
793 sub check_loadavg {
794 if (defined $maxload && get_loadavg() > $maxload) {
795 die_error(503, "The load average on the server is too high");
799 # ======================================================================
800 # input validation and dispatch
802 # Various hash size-related values.
803 my $sha1_len = 40;
804 my $sha256_extra_len = 24;
805 my $sha256_len = $sha1_len + $sha256_extra_len;
807 # A regex matching $len hex characters. $len may be a range (e.g. 7,64).
808 sub oid_nlen_regex {
809 my $len = shift;
810 my $hchr = qr/[0-9a-fA-F]/;
811 return qr/(?:(?:$hchr){$len})/;
814 # A regex matching two sets of $nlen hex characters, prefixed by the literal
815 # string $prefix and with the literal string $infix between them.
816 sub oid_nlen_prefix_infix_regex {
817 my $nlen = shift;
818 my $prefix = shift;
819 my $infix = shift;
821 my $rx = oid_nlen_regex($nlen);
823 return qr/^\Q$prefix\E$rx\Q$infix\E$rx$/;
826 # A regex matching a valid object ID.
827 our $oid_regex;
829 my $x = oid_nlen_regex($sha1_len);
830 my $y = oid_nlen_regex($sha256_extra_len);
831 $oid_regex = qr/(?:$x(?:$y)?)/;
834 # input parameters can be collected from a variety of sources (presently, CGI
835 # and PATH_INFO), so we define an %input_params hash that collects them all
836 # together during validation: this allows subsequent uses (e.g. href()) to be
837 # agnostic of the parameter origin
839 our %input_params = ();
841 # input parameters are stored with the long parameter name as key. This will
842 # also be used in the href subroutine to convert parameters to their CGI
843 # equivalent, and since the href() usage is the most frequent one, we store
844 # the name -> CGI key mapping here, instead of the reverse.
846 # XXX: Warning: If you touch this, check the search form for updating,
847 # too.
849 our @cgi_param_mapping = (
850 project => "p",
851 action => "a",
852 file_name => "f",
853 file_parent => "fp",
854 hash => "h",
855 hash_parent => "hp",
856 hash_base => "hb",
857 hash_parent_base => "hpb",
858 page => "pg",
859 order => "o",
860 searchtext => "s",
861 searchtype => "st",
862 snapshot_format => "sf",
863 extra_options => "opt",
864 search_use_regexp => "sr",
865 ctag => "by_tag",
866 diff_style => "ds",
867 project_filter => "pf",
868 # this must be last entry (for manipulation from JavaScript)
869 javascript => "js"
871 our %cgi_param_mapping = @cgi_param_mapping;
873 # we will also need to know the possible actions, for validation
874 our %actions = (
875 "blame" => \&git_blame,
876 "blame_incremental" => \&git_blame_incremental,
877 "blame_data" => \&git_blame_data,
878 "blobdiff" => \&git_blobdiff,
879 "blobdiff_plain" => \&git_blobdiff_plain,
880 "blob" => \&git_blob,
881 "blob_plain" => \&git_blob_plain,
882 "commitdiff" => \&git_commitdiff,
883 "commitdiff_plain" => \&git_commitdiff_plain,
884 "commit" => \&git_commit,
885 "forks" => \&git_forks,
886 "heads" => \&git_heads,
887 "history" => \&git_history,
888 "log" => \&git_log,
889 "patch" => \&git_patch,
890 "patches" => \&git_patches,
891 "remotes" => \&git_remotes,
892 "rss" => \&git_rss,
893 "atom" => \&git_atom,
894 "search" => \&git_search,
895 "search_help" => \&git_search_help,
896 "shortlog" => \&git_shortlog,
897 "summary" => \&git_summary,
898 "tag" => \&git_tag,
899 "tags" => \&git_tags,
900 "tree" => \&git_tree,
901 "snapshot" => \&git_snapshot,
902 "object" => \&git_object,
903 # those below don't need $project
904 "opml" => \&git_opml,
905 "project_list" => \&git_project_list,
906 "project_index" => \&git_project_index,
909 # finally, we have the hash of allowed extra_options for the commands that
910 # allow them
911 our %allowed_options = (
912 "--no-merges" => [ qw(rss atom log shortlog history) ],
915 # fill %input_params with the CGI parameters. All values except for 'opt'
916 # should be single values, but opt can be an array. We should probably
917 # build an array of parameters that can be multi-valued, but since for the time
918 # being it's only this one, we just single it out
919 sub evaluate_query_params {
920 our $cgi;
922 while (my ($name, $symbol) = each %cgi_param_mapping) {
923 if ($symbol eq 'opt') {
924 $input_params{$name} = [ map { decode_utf8($_) } $cgi->multi_param($symbol) ];
925 } else {
926 $input_params{$name} = decode_utf8($cgi->param($symbol));
931 # now read PATH_INFO and update the parameter list for missing parameters
932 sub evaluate_path_info {
933 return if defined $input_params{'project'};
934 return if !$path_info;
935 $path_info =~ s,^/+,,;
936 return if !$path_info;
938 # find which part of PATH_INFO is project
939 my $project = $path_info;
940 $project =~ s,/+$,,;
941 while ($project && !check_head_link("$projectroot/$project")) {
942 $project =~ s,/*[^/]*$,,;
944 return unless $project;
945 $input_params{'project'} = $project;
947 # do not change any parameters if an action is given using the query string
948 return if $input_params{'action'};
949 $path_info =~ s,^\Q$project\E/*,,;
951 # next, check if we have an action
952 my $action = $path_info;
953 $action =~ s,/.*$,,;
954 if (exists $actions{$action}) {
955 $path_info =~ s,^$action/*,,;
956 $input_params{'action'} = $action;
959 # list of actions that want hash_base instead of hash, but can have no
960 # pathname (f) parameter
961 my @wants_base = (
962 'tree',
963 'history',
966 # we want to catch, among others
967 # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
968 my ($parentrefname, $parentpathname, $refname, $pathname) =
969 ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);
971 # first, analyze the 'current' part
972 if (defined $pathname) {
973 # we got "branch:filename" or "branch:dir/"
974 # we could use git_get_type(branch:pathname), but:
975 # - it needs $git_dir
976 # - it does a git() call
977 # - the convention of terminating directories with a slash
978 # makes it superfluous
979 # - embedding the action in the PATH_INFO would make it even
980 # more superfluous
981 $pathname =~ s,^/+,,;
982 if (!$pathname || substr($pathname, -1) eq "/") {
983 $input_params{'action'} ||= "tree";
984 $pathname =~ s,/$,,;
985 } else {
986 # the default action depends on whether we had parent info
987 # or not
988 if ($parentrefname) {
989 $input_params{'action'} ||= "blobdiff_plain";
990 } else {
991 $input_params{'action'} ||= "blob_plain";
994 $input_params{'hash_base'} ||= $refname;
995 $input_params{'file_name'} ||= $pathname;
996 } elsif (defined $refname) {
997 # we got "branch". In this case we have to choose if we have to
998 # set hash or hash_base.
1000 # Most of the actions without a pathname only want hash to be
1001 # set, except for the ones specified in @wants_base that want
1002 # hash_base instead. It should also be noted that hand-crafted
1003 # links having 'history' as an action and no pathname or hash
1004 # set will fail, but that happens regardless of PATH_INFO.
1005 if (defined $parentrefname) {
1006 # if there is parent let the default be 'shortlog' action
1007 # (for http://git.example.com/repo.git/A..B links); if there
1008 # is no parent, dispatch will detect type of object and set
1009 # action appropriately if required (if action is not set)
1010 $input_params{'action'} ||= "shortlog";
1012 if ($input_params{'action'} &&
1013 grep { $_ eq $input_params{'action'} } @wants_base) {
1014 $input_params{'hash_base'} ||= $refname;
1015 } else {
1016 $input_params{'hash'} ||= $refname;
1020 # next, handle the 'parent' part, if present
1021 if (defined $parentrefname) {
1022 # a missing pathspec defaults to the 'current' filename, allowing e.g.
1023 # someproject/blobdiff/oldrev..newrev:/filename
1024 if ($parentpathname) {
1025 $parentpathname =~ s,^/+,,;
1026 $parentpathname =~ s,/$,,;
1027 $input_params{'file_parent'} ||= $parentpathname;
1028 } else {
1029 $input_params{'file_parent'} ||= $input_params{'file_name'};
1031 # we assume that hash_parent_base is wanted if a path was specified,
1032 # or if the action wants hash_base instead of hash
1033 if (defined $input_params{'file_parent'} ||
1034 grep { $_ eq $input_params{'action'} } @wants_base) {
1035 $input_params{'hash_parent_base'} ||= $parentrefname;
1036 } else {
1037 $input_params{'hash_parent'} ||= $parentrefname;
1041 # for the snapshot action, we allow URLs in the form
1042 # $project/snapshot/$hash.ext
1043 # where .ext determines the snapshot and gets removed from the
1044 # passed $refname to provide the $hash.
1046 # To be able to tell that $refname includes the format extension, we
1047 # require the following two conditions to be satisfied:
1048 # - the hash input parameter MUST have been set from the $refname part
1049 # of the URL (i.e. they must be equal)
1050 # - the snapshot format MUST NOT have been defined already (e.g. from
1051 # CGI parameter sf)
1052 # It's also useless to try any matching unless $refname has a dot,
1053 # so we check for that too
1054 if (defined $input_params{'action'} &&
1055 $input_params{'action'} eq 'snapshot' &&
1056 defined $refname && index($refname, '.') != -1 &&
1057 $refname eq $input_params{'hash'} &&
1058 !defined $input_params{'snapshot_format'}) {
1059 # We loop over the known snapshot formats, checking for
1060 # extensions. Allowed extensions are both the defined suffix
1061 # (which includes the initial dot already) and the snapshot
1062 # format key itself, with a prepended dot
1063 while (my ($fmt, $opt) = each %known_snapshot_formats) {
1064 my $hash = $refname;
1065 unless ($hash =~ s/(\Q$opt->{'suffix'}\E|\Q.$fmt\E)$//) {
1066 next;
1068 my $sfx = $1;
1069 # a valid suffix was found, so set the snapshot format
1070 # and reset the hash parameter
1071 $input_params{'snapshot_format'} = $fmt;
1072 $input_params{'hash'} = $hash;
1073 # we also set the format suffix to the one requested
1074 # in the URL: this way a request for e.g. .tgz returns
1075 # a .tgz instead of a .tar.gz
1076 $known_snapshot_formats{$fmt}{'suffix'} = $sfx;
1077 last;
1082 our ($action, $project, $file_name, $file_parent, $hash, $hash_parent, $hash_base,
1083 $hash_parent_base, @extra_options, $page, $searchtype, $search_use_regexp,
1084 $searchtext, $search_regexp, $project_filter);
1085 sub evaluate_and_validate_params {
1086 our $action = $input_params{'action'};
1087 if (defined $action) {
1088 if (!is_valid_action($action)) {
1089 die_error(400, "Invalid action parameter");
1093 # parameters which are pathnames
1094 our $project = $input_params{'project'};
1095 if (defined $project) {
1096 if (!is_valid_project($project)) {
1097 undef $project;
1098 die_error(404, "No such project");
1102 our $project_filter = $input_params{'project_filter'};
1103 if (defined $project_filter) {
1104 if (!is_valid_pathname($project_filter)) {
1105 die_error(404, "Invalid project_filter parameter");
1109 our $file_name = $input_params{'file_name'};
1110 if (defined $file_name) {
1111 if (!is_valid_pathname($file_name)) {
1112 die_error(400, "Invalid file parameter");
1116 our $file_parent = $input_params{'file_parent'};
1117 if (defined $file_parent) {
1118 if (!is_valid_pathname($file_parent)) {
1119 die_error(400, "Invalid file parent parameter");
1123 # parameters which are refnames
1124 our $hash = $input_params{'hash'};
1125 if (defined $hash) {
1126 if (!is_valid_refname($hash)) {
1127 die_error(400, "Invalid hash parameter");
1131 our $hash_parent = $input_params{'hash_parent'};
1132 if (defined $hash_parent) {
1133 if (!is_valid_refname($hash_parent)) {
1134 die_error(400, "Invalid hash parent parameter");
1138 our $hash_base = $input_params{'hash_base'};
1139 if (defined $hash_base) {
1140 if (!is_valid_refname($hash_base)) {
1141 die_error(400, "Invalid hash base parameter");
1145 our @extra_options = @{$input_params{'extra_options'}};
1146 # @extra_options is always defined, since it can only be (currently) set from
1147 # CGI, and $cgi->param() returns the empty array in array context if the param
1148 # is not set
1149 foreach my $opt (@extra_options) {
1150 if (not exists $allowed_options{$opt}) {
1151 die_error(400, "Invalid option parameter");
1153 if (not grep(/^$action$/, @{$allowed_options{$opt}})) {
1154 die_error(400, "Invalid option parameter for this action");
1158 our $hash_parent_base = $input_params{'hash_parent_base'};
1159 if (defined $hash_parent_base) {
1160 if (!is_valid_refname($hash_parent_base)) {
1161 die_error(400, "Invalid hash parent base parameter");
1165 # other parameters
1166 our $page = $input_params{'page'};
1167 if (defined $page) {
1168 if ($page =~ m/[^0-9]/) {
1169 die_error(400, "Invalid page parameter");
1173 our $searchtype = $input_params{'searchtype'};
1174 if (defined $searchtype) {
1175 if ($searchtype =~ m/[^a-z]/) {
1176 die_error(400, "Invalid searchtype parameter");
1180 our $search_use_regexp = $input_params{'search_use_regexp'};
1182 our $searchtext = $input_params{'searchtext'};
1183 our $search_regexp = undef;
1184 if (defined $searchtext) {
1185 if (length($searchtext) < 2) {
1186 die_error(403, "At least two characters are required for search parameter");
1188 if ($search_use_regexp) {
1189 $search_regexp = $searchtext;
1190 if (!eval { qr/$search_regexp/; 1; }) {
1191 my $error = $@ =~ s/ at \S+ line \d+.*\n?//r;
1192 die_error(400, "Invalid search regexp '$search_regexp'",
1193 esc_html($error));
1195 } else {
1196 $search_regexp = quotemeta $searchtext;
1201 # path to the current git repository
1202 our $git_dir;
1203 sub evaluate_git_dir {
1204 our $git_dir = "$projectroot/$project" if $project;
1207 our (@snapshot_fmts, $git_avatar, @extra_branch_refs);
1208 sub configure_gitweb_features {
1209 # list of supported snapshot formats
1210 our @snapshot_fmts = gitweb_get_feature('snapshot');
1211 @snapshot_fmts = filter_snapshot_fmts(@snapshot_fmts);
1213 our ($git_avatar) = gitweb_get_feature('avatar');
1214 $git_avatar = '' unless $git_avatar =~ /^(?:gravatar|picon)$/s;
1216 our @extra_branch_refs = gitweb_get_feature('extra-branch-refs');
1217 @extra_branch_refs = filter_and_validate_refs (@extra_branch_refs);
1220 sub get_branch_refs {
1221 return ('heads', @extra_branch_refs);
1224 # custom error handler: 'die <message>' is Internal Server Error
1225 sub handle_errors_html {
1226 my $msg = shift; # it is already HTML escaped
1228 # to avoid infinite loop where error occurs in die_error,
1229 # change handler to default handler, disabling handle_errors_html
1230 set_message("Error occurred when inside die_error:\n$msg");
1232 # you cannot jump out of die_error when called as error handler;
1233 # the subroutine set via CGI::Carp::set_message is called _after_
1234 # HTTP headers are already written, so it cannot write them itself
1235 die_error(undef, undef, $msg, -error_handler => 1, -no_http_header => 1);
1237 set_message(\&handle_errors_html);
1239 # dispatch
1240 sub dispatch {
1241 if (!defined $action) {
1242 if (defined $hash) {
1243 $action = git_get_type($hash);
1244 $action or die_error(404, "Object does not exist");
1245 } elsif (defined $hash_base && defined $file_name) {
1246 $action = git_get_type("$hash_base:$file_name");
1247 $action or die_error(404, "File or directory does not exist");
1248 } elsif (defined $project) {
1249 $action = 'summary';
1250 } else {
1251 $action = 'project_list';
1254 if (!defined($actions{$action})) {
1255 die_error(400, "Unknown action");
1257 if ($action !~ m/^(?:opml|project_list|project_index)$/ &&
1258 !$project) {
1259 die_error(400, "Project needed");
1261 $actions{$action}->();
1264 sub reset_timer {
1265 our $t0 = [ gettimeofday() ]
1266 if defined $t0;
1267 our $number_of_git_cmds = 0;
1270 our $first_request = 1;
1271 sub run_request {
1272 reset_timer();
1274 evaluate_uri();
1275 if ($first_request) {
1276 evaluate_gitweb_config();
1277 evaluate_git_version();
1279 if ($per_request_config) {
1280 if (ref($per_request_config) eq 'CODE') {
1281 $per_request_config->();
1282 } elsif (!$first_request) {
1283 evaluate_gitweb_config();
1286 check_loadavg();
1288 # $projectroot and $projects_list might be set in gitweb config file
1289 $projects_list ||= $projectroot;
1291 evaluate_query_params();
1292 evaluate_path_info();
1293 evaluate_and_validate_params();
1294 evaluate_git_dir();
1296 configure_gitweb_features();
1298 dispatch();
1301 our $is_last_request = sub { 1 };
1302 our ($pre_dispatch_hook, $post_dispatch_hook, $pre_listen_hook);
1303 our $CGI = 'CGI';
1304 our $cgi;
1305 our $FCGI_Stream_PRINT_raw = \&FCGI::Stream::PRINT;
1306 sub configure_as_fcgi {
1307 require CGI::Fast;
1308 our $CGI = 'CGI::Fast';
1309 # FCGI is not Unicode aware hence the UTF-8 encoding must be done manually.
1310 # However no encoding must be done within git_blob_plain() and git_snapshot()
1311 # which must still output in raw binary mode.
1312 no warnings 'redefine';
1313 my $enc = Encode::find_encoding('UTF-8');
1314 *FCGI::Stream::PRINT = sub {
1315 my @OUTPUT = @_;
1316 for (my $i = 1; $i < @_; $i++) {
1317 $OUTPUT[$i] = $enc->encode($_[$i], Encode::FB_CROAK|Encode::LEAVE_SRC);
1319 @_ = @OUTPUT;
1320 goto $FCGI_Stream_PRINT_raw;
1323 my $request_number = 0;
1324 # let each child service 100 requests
1325 our $is_last_request = sub { ++$request_number > 100 };
1327 sub evaluate_argv {
1328 my $script_name = $ENV{'SCRIPT_NAME'} || $ENV{'SCRIPT_FILENAME'} || __FILE__;
1329 configure_as_fcgi()
1330 if $script_name =~ /\.fcgi$/;
1332 return unless (@ARGV);
1334 require Getopt::Long;
1335 Getopt::Long::GetOptions(
1336 'fastcgi|fcgi|f' => \&configure_as_fcgi,
1337 'nproc|n=i' => sub {
1338 my ($arg, $val) = @_;
1339 return unless eval { require FCGI::ProcManager; 1; };
1340 my $proc_manager = FCGI::ProcManager->new({
1341 n_processes => $val,
1343 our $pre_listen_hook = sub { $proc_manager->pm_manage() };
1344 our $pre_dispatch_hook = sub { $proc_manager->pm_pre_dispatch() };
1345 our $post_dispatch_hook = sub { $proc_manager->pm_post_dispatch() };
1350 sub run {
1351 evaluate_argv();
1353 $first_request = 1;
1354 $pre_listen_hook->()
1355 if $pre_listen_hook;
1357 REQUEST:
1358 while ($cgi = $CGI->new()) {
1359 $pre_dispatch_hook->()
1360 if $pre_dispatch_hook;
1362 run_request();
1364 $post_dispatch_hook->()
1365 if $post_dispatch_hook;
1366 $first_request = 0;
1368 last REQUEST if ($is_last_request->());
1371 DONE_GITWEB:
1375 run();
1377 if (defined caller) {
1378 # wrapped in a subroutine processing requests,
1379 # e.g. mod_perl with ModPerl::Registry, or PSGI with Plack::App::WrapCGI
1380 return;
1381 } else {
1382 # pure CGI script, serving single request
1383 exit;
1386 ## ======================================================================
1387 ## action links
1389 # possible values of extra options
1390 # -full => 0|1 - use absolute/full URL ($my_uri/$my_url as base)
1391 # -replay => 1 - start from a current view (replay with modifications)
1392 # -path_info => 0|1 - don't use/use path_info URL (if possible)
1393 # -anchor => ANCHOR - add #ANCHOR to end of URL, implies -replay if used alone
1394 sub href {
1395 my %params = @_;
1396 # default is to use -absolute url() i.e. $my_uri
1397 my $href = $params{-full} ? $my_url : $my_uri;
1399 # implicit -replay, must be first of implicit params
1400 $params{-replay} = 1 if (keys %params == 1 && $params{-anchor});
1402 $params{'project'} = $project unless exists $params{'project'};
1404 if ($params{-replay}) {
1405 while (my ($name, $symbol) = each %cgi_param_mapping) {
1406 if (!exists $params{$name}) {
1407 $params{$name} = $input_params{$name};
1412 my $use_pathinfo = gitweb_check_feature('pathinfo');
1413 if (defined $params{'project'} &&
1414 (exists $params{-path_info} ? $params{-path_info} : $use_pathinfo)) {
1415 # try to put as many parameters as possible in PATH_INFO:
1416 # - project name
1417 # - action
1418 # - hash_parent or hash_parent_base:/file_parent
1419 # - hash or hash_base:/filename
1420 # - the snapshot_format as an appropriate suffix
1422 # When the script is the root DirectoryIndex for the domain,
1423 # $href here would be something like http://gitweb.example.com/
1424 # Thus, we strip any trailing / from $href, to spare us double
1425 # slashes in the final URL
1426 $href =~ s,/$,,;
1428 # Then add the project name, if present
1429 $href .= "/".esc_path_info($params{'project'});
1430 delete $params{'project'};
1432 # since we destructively absorb parameters, we keep this
1433 # boolean that remembers if we're handling a snapshot
1434 my $is_snapshot = $params{'action'} eq 'snapshot';
1436 # Summary just uses the project path URL, any other action is
1437 # added to the URL
1438 if (defined $params{'action'}) {
1439 $href .= "/".esc_path_info($params{'action'})
1440 unless $params{'action'} eq 'summary';
1441 delete $params{'action'};
1444 # Next, we put hash_parent_base:/file_parent..hash_base:/file_name,
1445 # stripping nonexistent or useless pieces
1446 $href .= "/" if ($params{'hash_base'} || $params{'hash_parent_base'}
1447 || $params{'hash_parent'} || $params{'hash'});
1448 if (defined $params{'hash_base'}) {
1449 if (defined $params{'hash_parent_base'}) {
1450 $href .= esc_path_info($params{'hash_parent_base'});
1451 # skip the file_parent if it's the same as the file_name
1452 if (defined $params{'file_parent'}) {
1453 if (defined $params{'file_name'} && $params{'file_parent'} eq $params{'file_name'}) {
1454 delete $params{'file_parent'};
1455 } elsif ($params{'file_parent'} !~ /\.\./) {
1456 $href .= ":/".esc_path_info($params{'file_parent'});
1457 delete $params{'file_parent'};
1460 $href .= "..";
1461 delete $params{'hash_parent'};
1462 delete $params{'hash_parent_base'};
1463 } elsif (defined $params{'hash_parent'}) {
1464 $href .= esc_path_info($params{'hash_parent'}). "..";
1465 delete $params{'hash_parent'};
1468 $href .= esc_path_info($params{'hash_base'});
1469 if (defined $params{'file_name'} && $params{'file_name'} !~ /\.\./) {
1470 $href .= ":/".esc_path_info($params{'file_name'});
1471 delete $params{'file_name'};
1473 delete $params{'hash'};
1474 delete $params{'hash_base'};
1475 } elsif (defined $params{'hash'}) {
1476 $href .= esc_path_info($params{'hash'});
1477 delete $params{'hash'};
1480 # If the action was a snapshot, we can absorb the
1481 # snapshot_format parameter too
1482 if ($is_snapshot) {
1483 my $fmt = $params{'snapshot_format'};
1484 # snapshot_format should always be defined when href()
1485 # is called, but just in case some code forgets, we
1486 # fall back to the default
1487 $fmt ||= $snapshot_fmts[0];
1488 $href .= $known_snapshot_formats{$fmt}{'suffix'};
1489 delete $params{'snapshot_format'};
1493 # now encode the parameters explicitly
1494 my @result = ();
1495 for (my $i = 0; $i < @cgi_param_mapping; $i += 2) {
1496 my ($name, $symbol) = ($cgi_param_mapping[$i], $cgi_param_mapping[$i+1]);
1497 if (defined $params{$name}) {
1498 if (ref($params{$name}) eq "ARRAY") {
1499 foreach my $par (@{$params{$name}}) {
1500 push @result, $symbol . "=" . esc_param($par);
1502 } else {
1503 push @result, $symbol . "=" . esc_param($params{$name});
1507 $href .= "?" . join(';', @result) if scalar @result;
1509 # final transformation: trailing spaces must be escaped (URI-encoded)
1510 $href =~ s/(\s+)$/CGI::escape($1)/e;
1512 if ($params{-anchor}) {
1513 $href .= "#".esc_param($params{-anchor});
1516 return $href;
1520 ## ======================================================================
1521 ## validation, quoting/unquoting and escaping
1523 sub is_valid_action {
1524 my $input = shift;
1525 return undef unless exists $actions{$input};
1526 return 1;
1529 sub is_valid_project {
1530 my $input = shift;
1532 return unless defined $input;
1533 if (!is_valid_pathname($input) ||
1534 !(-d "$projectroot/$input") ||
1535 !check_export_ok("$projectroot/$input") ||
1536 ($strict_export && !project_in_list($input))) {
1537 return undef;
1538 } else {
1539 return 1;
1543 sub is_valid_pathname {
1544 my $input = shift;
1546 return undef unless defined $input;
1547 # no '.' or '..' as elements of path, i.e. no '.' or '..'
1548 # at the beginning, at the end, and between slashes.
1549 # also this catches doubled slashes
1550 if ($input =~ m!(^|/)(|\.|\.\.)(/|$)!) {
1551 return undef;
1553 # no null characters
1554 if ($input =~ m!\0!) {
1555 return undef;
1557 return 1;
1560 sub is_valid_ref_format {
1561 my $input = shift;
1563 return undef unless defined $input;
1564 # restrictions on ref name according to git-check-ref-format
1565 if ($input =~ m!(/\.|\.\.|[\000-\040\177 ~^:?*\[]|/$)!) {
1566 return undef;
1568 return 1;
1571 sub is_valid_refname {
1572 my $input = shift;
1574 return undef unless defined $input;
1575 # textual hashes are O.K.
1576 if ($input =~ m/^$oid_regex$/) {
1577 return 1;
1579 # it must be correct pathname
1580 is_valid_pathname($input) or return undef;
1581 # check git-check-ref-format restrictions
1582 is_valid_ref_format($input) or return undef;
1583 return 1;
1586 # decode sequences of octets in utf8 into Perl's internal form,
1587 # which is utf-8 with utf8 flag set if needed. gitweb writes out
1588 # in utf-8 thanks to "binmode STDOUT, ':utf8'" at beginning
1589 sub to_utf8 {
1590 my $str = shift;
1591 return undef unless defined $str;
1593 if (utf8::is_utf8($str) || utf8::decode($str)) {
1594 return $str;
1595 } else {
1596 return decode($fallback_encoding, $str, Encode::FB_DEFAULT);
1600 # quote unsafe chars, but keep the slash, even when it's not
1601 # correct, but quoted slashes look too horrible in bookmarks
1602 sub esc_param {
1603 my $str = shift;
1604 return undef unless defined $str;
1605 $str =~ s/([^A-Za-z0-9\-_.~()\/:@ ]+)/CGI::escape($1)/eg;
1606 $str =~ s/ /\+/g;
1607 return $str;
1610 # the quoting rules for path_info fragment are slightly different
1611 sub esc_path_info {
1612 my $str = shift;
1613 return undef unless defined $str;
1615 # path_info doesn't treat '+' as space (specially), but '?' must be escaped
1616 $str =~ s/([^A-Za-z0-9\-_.~();\/;:@&= +]+)/CGI::escape($1)/eg;
1618 return $str;
1621 # quote unsafe chars in whole URL, so some characters cannot be quoted
1622 sub esc_url {
1623 my $str = shift;
1624 return undef unless defined $str;
1625 $str =~ s/([^A-Za-z0-9\-_.~();\/;?:@&= ]+)/CGI::escape($1)/eg;
1626 $str =~ s/ /\+/g;
1627 return $str;
1630 # quote unsafe characters in HTML attributes
1631 sub esc_attr {
1633 # for XHTML conformance escaping '"' to '&quot;' is not enough
1634 return esc_html(@_);
1637 # replace invalid utf8 character with SUBSTITUTION sequence
1638 sub esc_html {
1639 my $str = shift;
1640 my %opts = @_;
1642 return undef unless defined $str;
1644 $str = to_utf8($str);
1645 $str = $cgi->escapeHTML($str);
1646 if ($opts{'-nbsp'}) {
1647 $str =~ s/ /&nbsp;/g;
1649 $str =~ s|([[:cntrl:]])|(($1 ne "\t") ? quot_cec($1) : $1)|eg;
1650 return $str;
1653 # quote control characters and escape filename to HTML
1654 sub esc_path {
1655 my $str = shift;
1656 my %opts = @_;
1658 return undef unless defined $str;
1660 $str = to_utf8($str);
1661 $str = $cgi->escapeHTML($str);
1662 if ($opts{'-nbsp'}) {
1663 $str =~ s/ /&nbsp;/g;
1665 $str =~ s|([[:cntrl:]])|quot_cec($1)|eg;
1666 return $str;
1669 # Sanitize for use in XHTML + application/xml+xhtml (valid XML 1.0)
1670 sub sanitize {
1671 my $str = shift;
1673 return undef unless defined $str;
1675 $str = to_utf8($str);
1676 $str =~ s|([[:cntrl:]])|(index("\t\n\r", $1) != -1 ? $1 : quot_cec($1))|eg;
1677 return $str;
1680 # Make control characters "printable", using character escape codes (CEC)
1681 sub quot_cec {
1682 my $cntrl = shift;
1683 my %opts = @_;
1684 my %es = ( # character escape codes, aka escape sequences
1685 "\t" => '\t', # tab (HT)
1686 "\n" => '\n', # line feed (LF)
1687 "\r" => '\r', # carriage return (CR)
1688 "\f" => '\f', # form feed (FF)
1689 "\b" => '\b', # backspace (BS)
1690 "\a" => '\a', # alarm (bell) (BEL)
1691 "\e" => '\e', # escape (ESC)
1692 "\013" => '\v', # vertical tab (VT)
1693 "\000" => '\0', # nul character (NUL)
1695 my $chr = ( (exists $es{$cntrl})
1696 ? $es{$cntrl}
1697 : sprintf('\%2x', ord($cntrl)) );
1698 if ($opts{-nohtml}) {
1699 return $chr;
1700 } else {
1701 return "<span class=\"cntrl\">$chr</span>";
1705 # Alternatively use unicode control pictures codepoints,
1706 # Unicode "printable representation" (PR)
1707 sub quot_upr {
1708 my $cntrl = shift;
1709 my %opts = @_;
1711 my $chr = sprintf('&#%04d;', 0x2400+ord($cntrl));
1712 if ($opts{-nohtml}) {
1713 return $chr;
1714 } else {
1715 return "<span class=\"cntrl\">$chr</span>";
1719 # git may return quoted and escaped filenames
1720 sub unquote {
1721 my $str = shift;
1723 sub unq {
1724 my $seq = shift;
1725 my %es = ( # character escape codes, aka escape sequences
1726 't' => "\t", # tab (HT, TAB)
1727 'n' => "\n", # newline (NL)
1728 'r' => "\r", # return (CR)
1729 'f' => "\f", # form feed (FF)
1730 'b' => "\b", # backspace (BS)
1731 'a' => "\a", # alarm (bell) (BEL)
1732 'e' => "\e", # escape (ESC)
1733 'v' => "\013", # vertical tab (VT)
1736 if ($seq =~ m/^[0-7]{1,3}$/) {
1737 # octal char sequence
1738 return chr(oct($seq));
1739 } elsif (exists $es{$seq}) {
1740 # C escape sequence, aka character escape code
1741 return $es{$seq};
1743 # quoted ordinary character
1744 return $seq;
1747 if ($str =~ m/^"(.*)"$/) {
1748 # needs unquoting
1749 $str = $1;
1750 $str =~ s/\\([^0-7]|[0-7]{1,3})/unq($1)/eg;
1752 return $str;
1755 # escape tabs (convert tabs to spaces)
1756 sub untabify {
1757 my $line = shift;
1759 while ((my $pos = index($line, "\t")) != -1) {
1760 if (my $count = (8 - ($pos % 8))) {
1761 my $spaces = ' ' x $count;
1762 $line =~ s/\t/$spaces/;
1766 return $line;
1769 sub project_in_list {
1770 my $project = shift;
1771 my @list = git_get_projects_list();
1772 return @list && scalar(grep { $_->{'path'} eq $project } @list);
1775 ## ----------------------------------------------------------------------
1776 ## HTML aware string manipulation
1778 # Try to chop given string on a word boundary between position
1779 # $len and $len+$add_len. If there is no word boundary there,
1780 # chop at $len+$add_len. Do not chop if chopped part plus ellipsis
1781 # (marking chopped part) would be longer than given string.
1782 sub chop_str {
1783 my $str = shift;
1784 my $len = shift;
1785 my $add_len = shift || 10;
1786 my $where = shift || 'right'; # 'left' | 'center' | 'right'
1788 # Make sure perl knows it is utf8 encoded so we don't
1789 # cut in the middle of a utf8 multibyte char.
1790 $str = to_utf8($str);
1792 # allow only $len chars, but don't cut a word if it would fit in $add_len
1793 # if it doesn't fit, cut it if it's still longer than the dots we would add
1794 # remove chopped character entities entirely
1796 # when chopping in the middle, distribute $len into left and right part
1797 # return early if chopping wouldn't make string shorter
1798 if ($where eq 'center') {
1799 return $str if ($len + 5 >= length($str)); # filler is length 5
1800 $len = int($len/2);
1801 } else {
1802 return $str if ($len + 4 >= length($str)); # filler is length 4
1805 # regexps: ending and beginning with word part up to $add_len
1806 my $endre = qr/.{$len}\w{0,$add_len}/;
1807 my $begre = qr/\w{0,$add_len}.{$len}/;
1809 if ($where eq 'left') {
1810 $str =~ m/^(.*?)($begre)$/;
1811 my ($lead, $body) = ($1, $2);
1812 if (length($lead) > 4) {
1813 $lead = " ...";
1815 return "$lead$body";
1817 } elsif ($where eq 'center') {
1818 $str =~ m/^($endre)(.*)$/;
1819 my ($left, $str) = ($1, $2);
1820 $str =~ m/^(.*?)($begre)$/;
1821 my ($mid, $right) = ($1, $2);
1822 if (length($mid) > 5) {
1823 $mid = " ... ";
1825 return "$left$mid$right";
1827 } else {
1828 $str =~ m/^($endre)(.*)$/;
1829 my $body = $1;
1830 my $tail = $2;
1831 if (length($tail) > 4) {
1832 $tail = "... ";
1834 return "$body$tail";
1838 # takes the same arguments as chop_str, but also wraps a <span> around the
1839 # result with a title attribute if it does get chopped. Additionally, the
1840 # string is HTML-escaped.
1841 sub chop_and_escape_str {
1842 my ($str) = @_;
1844 my $chopped = chop_str(@_);
1845 $str = to_utf8($str);
1846 if ($chopped eq $str) {
1847 return esc_html($chopped);
1848 } else {
1849 $str =~ s/[[:cntrl:]]/?/g;
1850 return $cgi->span({-title=>$str}, esc_html($chopped));
1854 # Highlight selected fragments of string, using given CSS class,
1855 # and escape HTML. It is assumed that fragments do not overlap.
1856 # Regions are passed as list of pairs (array references).
1858 # Example: esc_html_hl_regions("foobar", "mark", [ 0, 3 ]) returns
1859 # '<span class="mark">foo</span>bar'
1860 sub esc_html_hl_regions {
1861 my ($str, $css_class, @sel) = @_;
1862 my %opts = grep { ref($_) ne 'ARRAY' } @sel;
1863 @sel = grep { ref($_) eq 'ARRAY' } @sel;
1864 return esc_html($str, %opts) unless @sel;
1866 my $out = '';
1867 my $pos = 0;
1869 for my $s (@sel) {
1870 my ($begin, $end) = @$s;
1872 # Don't create empty <span> elements.
1873 next if $end <= $begin;
1875 my $escaped = esc_html(substr($str, $begin, $end - $begin),
1876 %opts);
1878 $out .= esc_html(substr($str, $pos, $begin - $pos), %opts)
1879 if ($begin - $pos > 0);
1880 $out .= $cgi->span({-class => $css_class}, $escaped);
1882 $pos = $end;
1884 $out .= esc_html(substr($str, $pos), %opts)
1885 if ($pos < length($str));
1887 return $out;
1890 # return positions of beginning and end of each match
1891 sub matchpos_list {
1892 my ($str, $regexp) = @_;
1893 return unless (defined $str && defined $regexp);
1895 my @matches;
1896 while ($str =~ /$regexp/g) {
1897 push @matches, [$-[0], $+[0]];
1899 return @matches;
1902 # highlight match (if any), and escape HTML
1903 sub esc_html_match_hl {
1904 my ($str, $regexp) = @_;
1905 return esc_html($str) unless defined $regexp;
1907 my @matches = matchpos_list($str, $regexp);
1908 return esc_html($str) unless @matches;
1910 return esc_html_hl_regions($str, 'match', @matches);
1914 # highlight match (if any) of shortened string, and escape HTML
1915 sub esc_html_match_hl_chopped {
1916 my ($str, $chopped, $regexp) = @_;
1917 return esc_html_match_hl($str, $regexp) unless defined $chopped;
1919 my @matches = matchpos_list($str, $regexp);
1920 return esc_html($chopped) unless @matches;
1922 # filter matches so that we mark chopped string
1923 my $tail = "... "; # see chop_str
1924 unless ($chopped =~ s/\Q$tail\E$//) {
1925 $tail = '';
1927 my $chop_len = length($chopped);
1928 my $tail_len = length($tail);
1929 my @filtered;
1931 for my $m (@matches) {
1932 if ($m->[0] > $chop_len) {
1933 push @filtered, [ $chop_len, $chop_len + $tail_len ] if ($tail_len > 0);
1934 last;
1935 } elsif ($m->[1] > $chop_len) {
1936 push @filtered, [ $m->[0], $chop_len + $tail_len ];
1937 last;
1939 push @filtered, $m;
1942 return esc_html_hl_regions($chopped . $tail, 'match', @filtered);
1945 ## ----------------------------------------------------------------------
1946 ## functions returning short strings
1948 # CSS class for given age value (in seconds)
1949 sub age_class {
1950 my $age = shift;
1952 if (!defined $age) {
1953 return "noage";
1954 } elsif ($age < 60*60*2) {
1955 return "age0";
1956 } elsif ($age < 60*60*24*2) {
1957 return "age1";
1958 } else {
1959 return "age2";
1963 # convert age in seconds to "nn units ago" string
1964 sub age_string {
1965 my $age = shift;
1966 my $age_str;
1968 if ($age > 60*60*24*365*2) {
1969 $age_str = (int $age/60/60/24/365);
1970 $age_str .= " years ago";
1971 } elsif ($age > 60*60*24*(365/12)*2) {
1972 $age_str = int $age/60/60/24/(365/12);
1973 $age_str .= " months ago";
1974 } elsif ($age > 60*60*24*7*2) {
1975 $age_str = int $age/60/60/24/7;
1976 $age_str .= " weeks ago";
1977 } elsif ($age > 60*60*24*2) {
1978 $age_str = int $age/60/60/24;
1979 $age_str .= " days ago";
1980 } elsif ($age > 60*60*2) {
1981 $age_str = int $age/60/60;
1982 $age_str .= " hours ago";
1983 } elsif ($age > 60*2) {
1984 $age_str = int $age/60;
1985 $age_str .= " min ago";
1986 } elsif ($age > 2) {
1987 $age_str = int $age;
1988 $age_str .= " sec ago";
1989 } else {
1990 $age_str .= " right now";
1992 return $age_str;
1995 use constant {
1996 S_IFINVALID => 0030000,
1997 S_IFGITLINK => 0160000,
2000 # submodule/subproject, a commit object reference
2001 sub S_ISGITLINK {
2002 my $mode = shift;
2004 return (($mode & S_IFMT) == S_IFGITLINK)
2007 # convert file mode in octal to symbolic file mode string
2008 sub mode_str {
2009 my $mode = oct shift;
2011 if (S_ISGITLINK($mode)) {
2012 return 'm---------';
2013 } elsif (S_ISDIR($mode & S_IFMT)) {
2014 return 'drwxr-xr-x';
2015 } elsif (S_ISLNK($mode)) {
2016 return 'lrwxrwxrwx';
2017 } elsif (S_ISREG($mode)) {
2018 # git cares only about the executable bit
2019 if ($mode & S_IXUSR) {
2020 return '-rwxr-xr-x';
2021 } else {
2022 return '-rw-r--r--';
2024 } else {
2025 return '----------';
2029 # convert file mode in octal to file type string
2030 sub file_type {
2031 my $mode = shift;
2033 if ($mode !~ m/^[0-7]+$/) {
2034 return $mode;
2035 } else {
2036 $mode = oct $mode;
2039 if (S_ISGITLINK($mode)) {
2040 return "submodule";
2041 } elsif (S_ISDIR($mode & S_IFMT)) {
2042 return "directory";
2043 } elsif (S_ISLNK($mode)) {
2044 return "symlink";
2045 } elsif (S_ISREG($mode)) {
2046 return "file";
2047 } else {
2048 return "unknown";
2052 # convert file mode in octal to file type description string
2053 sub file_type_long {
2054 my $mode = shift;
2056 if ($mode !~ m/^[0-7]+$/) {
2057 return $mode;
2058 } else {
2059 $mode = oct $mode;
2062 if (S_ISGITLINK($mode)) {
2063 return "submodule";
2064 } elsif (S_ISDIR($mode & S_IFMT)) {
2065 return "directory";
2066 } elsif (S_ISLNK($mode)) {
2067 return "symlink";
2068 } elsif (S_ISREG($mode)) {
2069 if ($mode & S_IXUSR) {
2070 return "executable";
2071 } else {
2072 return "file";
2074 } else {
2075 return "unknown";
2080 ## ----------------------------------------------------------------------
2081 ## functions returning short HTML fragments, or transforming HTML fragments
2082 ## which don't belong to other sections
2084 # format line of commit message.
2085 sub format_log_line_html {
2086 my $line = shift;
2088 # Potentially abbreviated OID.
2089 my $regex = oid_nlen_regex("7,64");
2091 $line = esc_html($line, -nbsp=>1);
2092 $line =~ s{
2095 # The output of "git describe", e.g. v2.10.0-297-gf6727b0
2096 # or hadoop-20160921-113441-20-g094fb7d
2097 (?<!-) # see check_tag_ref(). Tags can't start with -
2098 [A-Za-z0-9.-]+
2099 (?!\.) # refs can't end with ".", see check_refname_format()
2100 -g$regex
2102 # Just a normal looking Git SHA1
2103 $regex
2107 $cgi->a({-href => href(action=>"object", hash=>$1),
2108 -class => "text"}, $1);
2109 }egx;
2111 return $line;
2114 # format marker of refs pointing to given object
2116 # the destination action is chosen based on object type and current context:
2117 # - for annotated tags, we choose the tag view unless it's the current view
2118 # already, in which case we go to shortlog view
2119 # - for other refs, we keep the current view if we're in history, shortlog or
2120 # log view, and select shortlog otherwise
2121 sub format_ref_marker {
2122 my ($refs, $id) = @_;
2123 my $markers = '';
2125 if (defined $refs->{$id}) {
2126 foreach my $ref (@{$refs->{$id}}) {
2127 # this code exploits the fact that non-lightweight tags are the
2128 # only indirect objects, and that they are the only objects for which
2129 # we want to use tag instead of shortlog as action
2130 my ($type, $name) = qw();
2131 my $indirect = ($ref =~ s/\^\{\}$//);
2132 # e.g. tags/v2.6.11 or heads/next
2133 if ($ref =~ m!^(.*?)s?/(.*)$!) {
2134 $type = $1;
2135 $name = $2;
2136 } else {
2137 $type = "ref";
2138 $name = $ref;
2141 my $class = $type;
2142 $class .= " indirect" if $indirect;
2144 my $dest_action = "shortlog";
2146 if ($indirect) {
2147 $dest_action = "tag" unless $action eq "tag";
2148 } elsif ($action =~ /^(history|(short)?log)$/) {
2149 $dest_action = $action;
2152 my $dest = "";
2153 $dest .= "refs/" unless $ref =~ m!^refs/!;
2154 $dest .= $ref;
2156 my $link = $cgi->a({
2157 -href => href(
2158 action=>$dest_action,
2159 hash=>$dest
2160 )}, esc_html($name));
2162 $markers .= " <span class=\"".esc_attr($class)."\" title=\"".esc_attr($ref)."\">" .
2163 $link . "</span>";
2167 if ($markers) {
2168 return ' <span class="refs">'. $markers . '</span>';
2169 } else {
2170 return "";
2174 # format, perhaps shortened and with markers, title line
2175 sub format_subject_html {
2176 my ($long, $short, $href, $extra) = @_;
2177 $extra = '' unless defined($extra);
2179 if (length($short) < length($long)) {
2180 $long =~ s/[[:cntrl:]]/?/g;
2181 return $cgi->a({-href => $href, -class => "list subject",
2182 -title => to_utf8($long)},
2183 esc_html($short)) . $extra;
2184 } else {
2185 return $cgi->a({-href => $href, -class => "list subject"},
2186 esc_html($long)) . $extra;
2190 # Rather than recomputing the url for an email multiple times, we cache it
2191 # after the first hit. This gives a visible benefit in views where the avatar
2192 # for the same email is used repeatedly (e.g. shortlog).
2193 # The cache is shared by all avatar engines (currently gravatar only), which
2194 # are free to use it as preferred. Since only one avatar engine is used for any
2195 # given page, there's no risk for cache conflicts.
2196 our %avatar_cache = ();
2198 # Compute the picon url for a given email, by using the picon search service over at
2199 # http://www.cs.indiana.edu/picons/search.html
2200 sub picon_url {
2201 my $email = lc shift;
2202 if (!$avatar_cache{$email}) {
2203 my ($user, $domain) = split('@', $email);
2204 $avatar_cache{$email} =
2205 "//www.cs.indiana.edu/cgi-pub/kinzler/piconsearch.cgi/" .
2206 "$domain/$user/" .
2207 "users+domains+unknown/up/single";
2209 return $avatar_cache{$email};
2212 # Compute the gravatar url for a given email, if it's not in the cache already.
2213 # Gravatar stores only the part of the URL before the size, since that's the
2214 # one computationally more expensive. This also allows reuse of the cache for
2215 # different sizes (for this particular engine).
2216 sub gravatar_url {
2217 my $email = lc shift;
2218 my $size = shift;
2219 $avatar_cache{$email} ||=
2220 "//www.gravatar.com/avatar/" .
2221 md5_hex($email) . "?s=";
2222 return $avatar_cache{$email} . $size;
2225 # Insert an avatar for the given $email at the given $size if the feature
2226 # is enabled.
2227 sub git_get_avatar {
2228 my ($email, %opts) = @_;
2229 my $pre_white = ($opts{-pad_before} ? "&nbsp;" : "");
2230 my $post_white = ($opts{-pad_after} ? "&nbsp;" : "");
2231 $opts{-size} ||= 'default';
2232 my $size = $avatar_size{$opts{-size}} || $avatar_size{'default'};
2233 my $url = "";
2234 if ($git_avatar eq 'gravatar') {
2235 $url = gravatar_url($email, $size);
2236 } elsif ($git_avatar eq 'picon') {
2237 $url = picon_url($email);
2239 # Other providers can be added by extending the if chain, defining $url
2240 # as needed. If no variant puts something in $url, we assume avatars
2241 # are completely disabled/unavailable.
2242 if ($url) {
2243 return $pre_white .
2244 "<img width=\"$size\" " .
2245 "class=\"avatar\" " .
2246 "src=\"".esc_url($url)."\" " .
2247 "alt=\"\" " .
2248 "/>" . $post_white;
2249 } else {
2250 return "";
2254 sub format_search_author {
2255 my ($author, $searchtype, $displaytext) = @_;
2256 my $have_search = gitweb_check_feature('search');
2258 if ($have_search) {
2259 my $performed = "";
2260 if ($searchtype eq 'author') {
2261 $performed = "authored";
2262 } elsif ($searchtype eq 'committer') {
2263 $performed = "committed";
2266 return $cgi->a({-href => href(action=>"search", hash=>$hash,
2267 searchtext=>$author,
2268 searchtype=>$searchtype), class=>"list",
2269 title=>"Search for commits $performed by $author"},
2270 $displaytext);
2272 } else {
2273 return $displaytext;
2277 # format the author name of the given commit with the given tag
2278 # the author name is chopped and escaped according to the other
2279 # optional parameters (see chop_str).
2280 sub format_author_html {
2281 my $tag = shift;
2282 my $co = shift;
2283 my $author = chop_and_escape_str($co->{'author_name'}, @_);
2284 return "<$tag class=\"author\">" .
2285 format_search_author($co->{'author_name'}, "author",
2286 git_get_avatar($co->{'author_email'}, -pad_after => 1) .
2287 $author) .
2288 "</$tag>";
2291 # format git diff header line, i.e. "diff --(git|combined|cc) ..."
2292 sub format_git_diff_header_line {
2293 my $line = shift;
2294 my $diffinfo = shift;
2295 my ($from, $to) = @_;
2297 if ($diffinfo->{'nparents'}) {
2298 # combined diff
2299 $line =~ s!^(diff (.*?) )"?.*$!$1!;
2300 if ($to->{'href'}) {
2301 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2302 esc_path($to->{'file'}));
2303 } else { # file was deleted (no href)
2304 $line .= esc_path($to->{'file'});
2306 } else {
2307 # "ordinary" diff
2308 $line =~ s!^(diff (.*?) )"?a/.*$!$1!;
2309 if ($from->{'href'}) {
2310 $line .= $cgi->a({-href => $from->{'href'}, -class => "path"},
2311 'a/' . esc_path($from->{'file'}));
2312 } else { # file was added (no href)
2313 $line .= 'a/' . esc_path($from->{'file'});
2315 $line .= ' ';
2316 if ($to->{'href'}) {
2317 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2318 'b/' . esc_path($to->{'file'}));
2319 } else { # file was deleted
2320 $line .= 'b/' . esc_path($to->{'file'});
2324 return "<div class=\"diff header\">$line</div>\n";
2327 # format extended diff header line, before patch itself
2328 sub format_extended_diff_header_line {
2329 my $line = shift;
2330 my $diffinfo = shift;
2331 my ($from, $to) = @_;
2333 # match <path>
2334 if ($line =~ s!^((copy|rename) from ).*$!$1! && $from->{'href'}) {
2335 $line .= $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2336 esc_path($from->{'file'}));
2338 if ($line =~ s!^((copy|rename) to ).*$!$1! && $to->{'href'}) {
2339 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2340 esc_path($to->{'file'}));
2342 # match single <mode>
2343 if ($line =~ m/\s(\d{6})$/) {
2344 $line .= '<span class="info"> (' .
2345 file_type_long($1) .
2346 ')</span>';
2348 # match <hash>
2349 if ($line =~ oid_nlen_prefix_infix_regex($sha1_len, "index ", ",") |
2350 $line =~ oid_nlen_prefix_infix_regex($sha256_len, "index ", ",")) {
2351 # can match only for combined diff
2352 $line = 'index ';
2353 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2354 if ($from->{'href'}[$i]) {
2355 $line .= $cgi->a({-href=>$from->{'href'}[$i],
2356 -class=>"hash"},
2357 substr($diffinfo->{'from_id'}[$i],0,7));
2358 } else {
2359 $line .= '0' x 7;
2361 # separator
2362 $line .= ',' if ($i < $diffinfo->{'nparents'} - 1);
2364 $line .= '..';
2365 if ($to->{'href'}) {
2366 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2367 substr($diffinfo->{'to_id'},0,7));
2368 } else {
2369 $line .= '0' x 7;
2372 } elsif ($line =~ oid_nlen_prefix_infix_regex($sha1_len, "index ", "..") |
2373 $line =~ oid_nlen_prefix_infix_regex($sha256_len, "index ", "..")) {
2374 # can match only for ordinary diff
2375 my ($from_link, $to_link);
2376 if ($from->{'href'}) {
2377 $from_link = $cgi->a({-href=>$from->{'href'}, -class=>"hash"},
2378 substr($diffinfo->{'from_id'},0,7));
2379 } else {
2380 $from_link = '0' x 7;
2382 if ($to->{'href'}) {
2383 $to_link = $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2384 substr($diffinfo->{'to_id'},0,7));
2385 } else {
2386 $to_link = '0' x 7;
2388 my ($from_id, $to_id) = ($diffinfo->{'from_id'}, $diffinfo->{'to_id'});
2389 $line =~ s!$from_id\.\.$to_id!$from_link..$to_link!;
2392 return $line . "<br/>\n";
2395 # format from-file/to-file diff header
2396 sub format_diff_from_to_header {
2397 my ($from_line, $to_line, $diffinfo, $from, $to, @parents) = @_;
2398 my $line;
2399 my $result = '';
2401 $line = $from_line;
2402 #assert($line =~ m/^---/) if DEBUG;
2403 # no extra formatting for "^--- /dev/null"
2404 if (! $diffinfo->{'nparents'}) {
2405 # ordinary (single parent) diff
2406 if ($line =~ m!^--- "?a/!) {
2407 if ($from->{'href'}) {
2408 $line = '--- a/' .
2409 $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2410 esc_path($from->{'file'}));
2411 } else {
2412 $line = '--- a/' .
2413 esc_path($from->{'file'});
2416 $result .= qq!<div class="diff from_file">$line</div>\n!;
2418 } else {
2419 # combined diff (merge commit)
2420 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2421 if ($from->{'href'}[$i]) {
2422 $line = '--- ' .
2423 $cgi->a({-href=>href(action=>"blobdiff",
2424 hash_parent=>$diffinfo->{'from_id'}[$i],
2425 hash_parent_base=>$parents[$i],
2426 file_parent=>$from->{'file'}[$i],
2427 hash=>$diffinfo->{'to_id'},
2428 hash_base=>$hash,
2429 file_name=>$to->{'file'}),
2430 -class=>"path",
2431 -title=>"diff" . ($i+1)},
2432 $i+1) .
2433 '/' .
2434 $cgi->a({-href=>$from->{'href'}[$i], -class=>"path"},
2435 esc_path($from->{'file'}[$i]));
2436 } else {
2437 $line = '--- /dev/null';
2439 $result .= qq!<div class="diff from_file">$line</div>\n!;
2443 $line = $to_line;
2444 #assert($line =~ m/^\+\+\+/) if DEBUG;
2445 # no extra formatting for "^+++ /dev/null"
2446 if ($line =~ m!^\+\+\+ "?b/!) {
2447 if ($to->{'href'}) {
2448 $line = '+++ b/' .
2449 $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2450 esc_path($to->{'file'}));
2451 } else {
2452 $line = '+++ b/' .
2453 esc_path($to->{'file'});
2456 $result .= qq!<div class="diff to_file">$line</div>\n!;
2458 return $result;
2461 # create note for patch simplified by combined diff
2462 sub format_diff_cc_simplified {
2463 my ($diffinfo, @parents) = @_;
2464 my $result = '';
2466 $result .= "<div class=\"diff header\">" .
2467 "diff --cc ";
2468 if (!is_deleted($diffinfo)) {
2469 $result .= $cgi->a({-href => href(action=>"blob",
2470 hash_base=>$hash,
2471 hash=>$diffinfo->{'to_id'},
2472 file_name=>$diffinfo->{'to_file'}),
2473 -class => "path"},
2474 esc_path($diffinfo->{'to_file'}));
2475 } else {
2476 $result .= esc_path($diffinfo->{'to_file'});
2478 $result .= "</div>\n" . # class="diff header"
2479 "<div class=\"diff nodifferences\">" .
2480 "Simple merge" .
2481 "</div>\n"; # class="diff nodifferences"
2483 return $result;
2486 sub diff_line_class {
2487 my ($line, $from, $to) = @_;
2489 # ordinary diff
2490 my $num_sign = 1;
2491 # combined diff
2492 if ($from && $to && ref($from->{'href'}) eq "ARRAY") {
2493 $num_sign = scalar @{$from->{'href'}};
2496 my @diff_line_classifier = (
2497 { regexp => qr/^\@\@{$num_sign} /, class => "chunk_header"},
2498 { regexp => qr/^\\/, class => "incomplete" },
2499 { regexp => qr/^ {$num_sign}/, class => "ctx" },
2500 # classifier for context must come before classifier add/rem,
2501 # or we would have to use more complicated regexp, for example
2502 # qr/(?= {0,$m}\+)[+ ]{$num_sign}/, where $m = $num_sign - 1;
2503 { regexp => qr/^[+ ]{$num_sign}/, class => "add" },
2504 { regexp => qr/^[- ]{$num_sign}/, class => "rem" },
2506 for my $clsfy (@diff_line_classifier) {
2507 return $clsfy->{'class'}
2508 if ($line =~ $clsfy->{'regexp'});
2511 # fallback
2512 return "";
2515 # assumes that $from and $to are defined and correctly filled,
2516 # and that $line holds a line of chunk header for unified diff
2517 sub format_unidiff_chunk_header {
2518 my ($line, $from, $to) = @_;
2520 my ($from_text, $from_start, $from_lines, $to_text, $to_start, $to_lines, $section) =
2521 $line =~ m/^\@{2} (-(\d+)(?:,(\d+))?) (\+(\d+)(?:,(\d+))?) \@{2}(.*)$/;
2523 $from_lines = 0 unless defined $from_lines;
2524 $to_lines = 0 unless defined $to_lines;
2526 if ($from->{'href'}) {
2527 $from_text = $cgi->a({-href=>"$from->{'href'}#l$from_start",
2528 -class=>"list"}, $from_text);
2530 if ($to->{'href'}) {
2531 $to_text = $cgi->a({-href=>"$to->{'href'}#l$to_start",
2532 -class=>"list"}, $to_text);
2534 $line = "<span class=\"chunk_info\">@@ $from_text $to_text @@</span>" .
2535 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2536 return $line;
2539 # assumes that $from and $to are defined and correctly filled,
2540 # and that $line holds a line of chunk header for combined diff
2541 sub format_cc_diff_chunk_header {
2542 my ($line, $from, $to) = @_;
2544 my ($prefix, $ranges, $section) = $line =~ m/^(\@+) (.*?) \@+(.*)$/;
2545 my (@from_text, @from_start, @from_nlines, $to_text, $to_start, $to_nlines);
2547 @from_text = split(' ', $ranges);
2548 for (my $i = 0; $i < @from_text; ++$i) {
2549 ($from_start[$i], $from_nlines[$i]) =
2550 (split(',', substr($from_text[$i], 1)), 0);
2553 $to_text = pop @from_text;
2554 $to_start = pop @from_start;
2555 $to_nlines = pop @from_nlines;
2557 $line = "<span class=\"chunk_info\">$prefix ";
2558 for (my $i = 0; $i < @from_text; ++$i) {
2559 if ($from->{'href'}[$i]) {
2560 $line .= $cgi->a({-href=>"$from->{'href'}[$i]#l$from_start[$i]",
2561 -class=>"list"}, $from_text[$i]);
2562 } else {
2563 $line .= $from_text[$i];
2565 $line .= " ";
2567 if ($to->{'href'}) {
2568 $line .= $cgi->a({-href=>"$to->{'href'}#l$to_start",
2569 -class=>"list"}, $to_text);
2570 } else {
2571 $line .= $to_text;
2573 $line .= " $prefix</span>" .
2574 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2575 return $line;
2578 # process patch (diff) line (not to be used for diff headers),
2579 # returning HTML-formatted (but not wrapped) line.
2580 # If the line is passed as a reference, it is treated as HTML and not
2581 # esc_html()'ed.
2582 sub format_diff_line {
2583 my ($line, $diff_class, $from, $to) = @_;
2585 if (ref($line)) {
2586 $line = $$line;
2587 } else {
2588 chomp $line;
2589 $line = untabify($line);
2591 if ($from && $to && $line =~ m/^\@{2} /) {
2592 $line = format_unidiff_chunk_header($line, $from, $to);
2593 } elsif ($from && $to && $line =~ m/^\@{3}/) {
2594 $line = format_cc_diff_chunk_header($line, $from, $to);
2595 } else {
2596 $line = esc_html($line, -nbsp=>1);
2600 my $diff_classes = "diff";
2601 $diff_classes .= " $diff_class" if ($diff_class);
2602 $line = "<div class=\"$diff_classes\">$line</div>\n";
2604 return $line;
2607 # Generates undef or something like "_snapshot_" or "snapshot (_tbz2_ _zip_)",
2608 # linked. Pass the hash of the tree/commit to snapshot.
2609 sub format_snapshot_links {
2610 my ($hash) = @_;
2611 my $num_fmts = @snapshot_fmts;
2612 if ($num_fmts > 1) {
2613 # A parenthesized list of links bearing format names.
2614 # e.g. "snapshot (_tar.gz_ _zip_)"
2615 return "snapshot (" . join(' ', map
2616 $cgi->a({
2617 -href => href(
2618 action=>"snapshot",
2619 hash=>$hash,
2620 snapshot_format=>$_
2622 }, $known_snapshot_formats{$_}{'display'})
2623 , @snapshot_fmts) . ")";
2624 } elsif ($num_fmts == 1) {
2625 # A single "snapshot" link whose tooltip bears the format name.
2626 # i.e. "_snapshot_"
2627 my ($fmt) = @snapshot_fmts;
2628 return
2629 $cgi->a({
2630 -href => href(
2631 action=>"snapshot",
2632 hash=>$hash,
2633 snapshot_format=>$fmt
2635 -title => "in format: $known_snapshot_formats{$fmt}{'display'}"
2636 }, "snapshot");
2637 } else { # $num_fmts == 0
2638 return undef;
2642 ## ......................................................................
2643 ## functions returning values to be passed, perhaps after some
2644 ## transformation, to other functions; e.g. returning arguments to href()
2646 # returns hash to be passed to href to generate gitweb URL
2647 # in -title key it returns description of link
2648 sub get_feed_info {
2649 my $format = shift || 'Atom';
2650 my %res = (action => lc($format));
2651 my $matched_ref = 0;
2653 # feed links are possible only for project views
2654 return unless (defined $project);
2655 # some views should link to OPML, or to generic project feed,
2656 # or don't have specific feed yet (so they should use generic)
2657 return if (!$action || $action =~ /^(?:tags|heads|forks|tag|search)$/x);
2659 my $branch = undef;
2660 # branches refs uses 'refs/' + $get_branch_refs()[x] + '/' prefix
2661 # (fullname) to differentiate from tag links; this also makes
2662 # possible to detect branch links
2663 for my $ref (get_branch_refs()) {
2664 if ((defined $hash_base && $hash_base =~ m!^refs/\Q$ref\E/(.*)$!) ||
2665 (defined $hash && $hash =~ m!^refs/\Q$ref\E/(.*)$!)) {
2666 $branch = $1;
2667 $matched_ref = $ref;
2668 last;
2671 # find log type for feed description (title)
2672 my $type = 'log';
2673 if (defined $file_name) {
2674 $type = "history of $file_name";
2675 $type .= "/" if ($action eq 'tree');
2676 $type .= " on '$branch'" if (defined $branch);
2677 } else {
2678 $type = "log of $branch" if (defined $branch);
2681 $res{-title} = $type;
2682 $res{'hash'} = (defined $branch ? "refs/$matched_ref/$branch" : undef);
2683 $res{'file_name'} = $file_name;
2685 return %res;
2688 ## ----------------------------------------------------------------------
2689 ## git utility subroutines, invoking git commands
2691 # returns path to the core git executable and the --git-dir parameter as list
2692 sub git_cmd {
2693 $number_of_git_cmds++;
2694 return $GIT, '--git-dir='.$git_dir;
2697 # quote the given arguments for passing them to the shell
2698 # quote_command("command", "arg 1", "arg with ' and ! characters")
2699 # => "'command' 'arg 1' 'arg with '\'' and '\!' characters'"
2700 # Try to avoid using this function wherever possible.
2701 sub quote_command {
2702 return join(' ',
2703 map { my $a = $_ =~ s/(['!])/'\\$1'/gr; "'$a'" } @_ );
2706 # get HEAD ref of given project as hash
2707 sub git_get_head_hash {
2708 return git_get_full_hash(shift, 'HEAD');
2711 sub git_get_full_hash {
2712 return git_get_hash(@_);
2715 sub git_get_short_hash {
2716 return git_get_hash(@_, '--short=7');
2719 sub git_get_hash {
2720 my ($project, $hash, @options) = @_;
2721 my $o_git_dir = $git_dir;
2722 my $retval = undef;
2723 $git_dir = "$projectroot/$project";
2724 if (open my $fd, '-|', git_cmd(), 'rev-parse',
2725 '--verify', '-q', @options, $hash) {
2726 $retval = <$fd>;
2727 chomp $retval if defined $retval;
2728 close $fd;
2730 if (defined $o_git_dir) {
2731 $git_dir = $o_git_dir;
2733 return $retval;
2736 # get type of given object
2737 sub git_get_type {
2738 my $hash = shift;
2740 open my $fd, "-|", git_cmd(), "cat-file", '-t', $hash or return;
2741 my $type = <$fd>;
2742 close $fd or return;
2743 chomp $type;
2744 return $type;
2747 # repository configuration
2748 our $config_file = '';
2749 our %config;
2751 # store multiple values for single key as anonymous array reference
2752 # single values stored directly in the hash, not as [ <value> ]
2753 sub hash_set_multi {
2754 my ($hash, $key, $value) = @_;
2756 if (!exists $hash->{$key}) {
2757 $hash->{$key} = $value;
2758 } elsif (!ref $hash->{$key}) {
2759 $hash->{$key} = [ $hash->{$key}, $value ];
2760 } else {
2761 push @{$hash->{$key}}, $value;
2765 # return hash of git project configuration
2766 # optionally limited to some section, e.g. 'gitweb'
2767 sub git_parse_project_config {
2768 my $section_regexp = shift;
2769 my %config;
2771 local $/ = "\0";
2773 open my $fh, "-|", git_cmd(), "config", '-z', '-l',
2774 or return;
2776 while (my $keyval = <$fh>) {
2777 chomp $keyval;
2778 my ($key, $value) = split(/\n/, $keyval, 2);
2780 hash_set_multi(\%config, $key, $value)
2781 if (!defined $section_regexp || $key =~ /^(?:$section_regexp)\./o);
2783 close $fh;
2785 return %config;
2788 # convert config value to boolean: 'true' or 'false'
2789 # no value, number > 0, 'true' and 'yes' values are true
2790 # rest of values are treated as false (never as error)
2791 sub config_to_bool {
2792 my $val = shift;
2794 return 1 if !defined $val; # section.key
2796 # strip leading and trailing whitespace
2797 $val =~ s/^\s+//;
2798 $val =~ s/\s+$//;
2800 return (($val =~ /^\d+$/ && $val) || # section.key = 1
2801 ($val =~ /^(?:true|yes)$/i)); # section.key = true
2804 # convert config value to simple decimal number
2805 # an optional value suffix of 'k', 'm', or 'g' will cause the value
2806 # to be multiplied by 1024, 1048576, or 1073741824
2807 sub config_to_int {
2808 my $val = shift;
2810 # strip leading and trailing whitespace
2811 $val =~ s/^\s+//;
2812 $val =~ s/\s+$//;
2814 if (my ($num, $unit) = ($val =~ /^([0-9]*)([kmg])$/i)) {
2815 $unit = lc($unit);
2816 # unknown unit is treated as 1
2817 return $num * ($unit eq 'g' ? 1073741824 :
2818 $unit eq 'm' ? 1048576 :
2819 $unit eq 'k' ? 1024 : 1);
2821 return $val;
2824 # convert config value to array reference, if needed
2825 sub config_to_multi {
2826 my $val = shift;
2828 return ref($val) ? $val : (defined($val) ? [ $val ] : []);
2831 sub git_get_project_config {
2832 my ($key, $type) = @_;
2834 return unless defined $git_dir;
2836 # key sanity check
2837 return unless ($key);
2838 # only subsection, if exists, is case sensitive,
2839 # and not lowercased by 'git config -z -l'
2840 if (my ($hi, $mi, $lo) = ($key =~ /^([^.]*)\.(.*)\.([^.]*)$/)) {
2841 $lo =~ s/_//g;
2842 $key = join(".", lc($hi), $mi, lc($lo));
2843 return if ($lo =~ /\W/ || $hi =~ /\W/);
2844 } else {
2845 $key = lc($key);
2846 $key =~ s/_//g;
2847 return if ($key =~ /\W/);
2849 $key =~ s/^gitweb\.//;
2851 # type sanity check
2852 if (defined $type) {
2853 $type =~ s/^--//;
2854 $type = undef
2855 unless ($type eq 'bool' || $type eq 'int');
2858 # get config
2859 if (!defined $config_file ||
2860 $config_file ne "$git_dir/config") {
2861 %config = git_parse_project_config('gitweb');
2862 $config_file = "$git_dir/config";
2865 # check if config variable (key) exists
2866 return unless exists $config{"gitweb.$key"};
2868 # ensure given type
2869 if (!defined $type) {
2870 return $config{"gitweb.$key"};
2871 } elsif ($type eq 'bool') {
2872 # backward compatibility: 'git config --bool' returns true/false
2873 return config_to_bool($config{"gitweb.$key"}) ? 'true' : 'false';
2874 } elsif ($type eq 'int') {
2875 return config_to_int($config{"gitweb.$key"});
2877 return $config{"gitweb.$key"};
2880 # get hash of given path at given ref
2881 sub git_get_hash_by_path {
2882 my $base = shift;
2883 my $path = shift || return undef;
2884 my $type = shift;
2886 $path =~ s,/+$,,;
2888 open my $fd, "-|", git_cmd(), "ls-tree", $base, "--", $path
2889 or die_error(500, "Open git-ls-tree failed");
2890 my $line = <$fd>;
2891 close $fd or return undef;
2893 if (!defined $line) {
2894 # there is no tree or hash given by $path at $base
2895 return undef;
2898 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
2899 $line =~ m/^([0-9]+) (.+) ($oid_regex)\t/;
2900 if (defined $type && $type ne $2) {
2901 # type doesn't match
2902 return undef;
2904 return $3;
2907 # get path of entry with given hash at given tree-ish (ref)
2908 # used to get 'from' filename for combined diff (merge commit) for renames
2909 sub git_get_path_by_hash {
2910 my $base = shift || return;
2911 my $hash = shift || return;
2913 local $/ = "\0";
2915 open my $fd, "-|", git_cmd(), "ls-tree", '-r', '-t', '-z', $base
2916 or return undef;
2917 while (my $line = <$fd>) {
2918 chomp $line;
2920 #'040000 tree 595596a6a9117ddba9fe379b6b012b558bac8423 gitweb'
2921 #'100644 blob e02e90f0429be0d2a69b76571101f20b8f75530f gitweb/README'
2922 if ($line =~ m/(?:[0-9]+) (?:.+) $hash\t(.+)$/) {
2923 close $fd;
2924 return $1;
2927 close $fd;
2928 return undef;
2931 ## ......................................................................
2932 ## git utility functions, directly accessing git repository
2934 # get the value of config variable either from file named as the variable
2935 # itself in the repository ($GIT_DIR/$name file), or from gitweb.$name
2936 # configuration variable in the repository config file.
2937 sub git_get_file_or_project_config {
2938 my ($path, $name) = @_;
2940 $git_dir = "$projectroot/$path";
2941 open my $fd, '<', "$git_dir/$name"
2942 or return git_get_project_config($name);
2943 my $conf = <$fd>;
2944 close $fd;
2945 if (defined $conf) {
2946 chomp $conf;
2948 return $conf;
2951 sub git_get_project_description {
2952 my $path = shift;
2953 return git_get_file_or_project_config($path, 'description');
2956 sub git_get_project_category {
2957 my $path = shift;
2958 return git_get_file_or_project_config($path, 'category');
2962 # supported formats:
2963 # * $GIT_DIR/ctags/<tagname> file (in 'ctags' subdirectory)
2964 # - if its contents is a number, use it as tag weight,
2965 # - otherwise add a tag with weight 1
2966 # * $GIT_DIR/ctags file, each line is a tag (with weight 1)
2967 # the same value multiple times increases tag weight
2968 # * `gitweb.ctag' multi-valued repo config variable
2969 sub git_get_project_ctags {
2970 my $project = shift;
2971 my $ctags = {};
2973 $git_dir = "$projectroot/$project";
2974 if (opendir my $dh, "$git_dir/ctags") {
2975 my @files = grep { -f $_ } map { "$git_dir/ctags/$_" } readdir($dh);
2976 foreach my $tagfile (@files) {
2977 open my $ct, '<', $tagfile
2978 or next;
2979 my $val = <$ct>;
2980 chomp $val if $val;
2981 close $ct;
2983 (my $ctag = $tagfile) =~ s#.*/##;
2984 if ($val =~ /^\d+$/) {
2985 $ctags->{$ctag} = $val;
2986 } else {
2987 $ctags->{$ctag} = 1;
2990 closedir $dh;
2992 } elsif (open my $fh, '<', "$git_dir/ctags") {
2993 while (my $line = <$fh>) {
2994 chomp $line;
2995 $ctags->{$line}++ if $line;
2997 close $fh;
2999 } else {
3000 my $taglist = config_to_multi(git_get_project_config('ctag'));
3001 foreach my $tag (@$taglist) {
3002 $ctags->{$tag}++;
3006 return $ctags;
3009 # return hash, where keys are content tags ('ctags'),
3010 # and values are sum of weights of given tag in every project
3011 sub git_gather_all_ctags {
3012 my $projects = shift;
3013 my $ctags = {};
3015 foreach my $p (@$projects) {
3016 foreach my $ct (keys %{$p->{'ctags'}}) {
3017 $ctags->{$ct} += $p->{'ctags'}->{$ct};
3021 return $ctags;
3024 sub git_populate_project_tagcloud {
3025 my $ctags = shift;
3027 # First, merge different-cased tags; tags vote on casing
3028 my %ctags_lc;
3029 foreach (keys %$ctags) {
3030 $ctags_lc{lc $_}->{count} += $ctags->{$_};
3031 if (not $ctags_lc{lc $_}->{topcount}
3032 or $ctags_lc{lc $_}->{topcount} < $ctags->{$_}) {
3033 $ctags_lc{lc $_}->{topcount} = $ctags->{$_};
3034 $ctags_lc{lc $_}->{topname} = $_;
3038 my $cloud;
3039 my $matched = $input_params{'ctag'};
3040 if (eval { require HTML::TagCloud; 1; }) {
3041 $cloud = HTML::TagCloud->new;
3042 foreach my $ctag (sort keys %ctags_lc) {
3043 # Pad the title with spaces so that the cloud looks
3044 # less crammed.
3045 my $title = esc_html($ctags_lc{$ctag}->{topname});
3046 $title =~ s/ /&nbsp;/g;
3047 $title =~ s/^/&nbsp;/g;
3048 $title =~ s/$/&nbsp;/g;
3049 if (defined $matched && $matched eq $ctag) {
3050 $title = qq(<span class="match">$title</span>);
3052 $cloud->add($title, href(project=>undef, ctag=>$ctag),
3053 $ctags_lc{$ctag}->{count});
3055 } else {
3056 $cloud = {};
3057 foreach my $ctag (keys %ctags_lc) {
3058 my $title = esc_html($ctags_lc{$ctag}->{topname}, -nbsp=>1);
3059 if (defined $matched && $matched eq $ctag) {
3060 $title = qq(<span class="match">$title</span>);
3062 $cloud->{$ctag}{count} = $ctags_lc{$ctag}->{count};
3063 $cloud->{$ctag}{ctag} =
3064 $cgi->a({-href=>href(project=>undef, ctag=>$ctag)}, $title);
3067 return $cloud;
3070 sub git_show_project_tagcloud {
3071 my ($cloud, $count) = @_;
3072 if (ref $cloud eq 'HTML::TagCloud') {
3073 return $cloud->html_and_css($count);
3074 } else {
3075 my @tags = sort { $cloud->{$a}->{'count'} <=> $cloud->{$b}->{'count'} } keys %$cloud;
3076 return
3077 '<div id="htmltagcloud"'.($project ? '' : ' align="center"').'>' .
3078 join (', ', map {
3079 $cloud->{$_}->{'ctag'}
3080 } splice(@tags, 0, $count)) .
3081 '</div>';
3085 sub git_get_project_url_list {
3086 my $path = shift;
3088 $git_dir = "$projectroot/$path";
3089 open my $fd, '<', "$git_dir/cloneurl"
3090 or return wantarray ?
3091 @{ config_to_multi(git_get_project_config('url')) } :
3092 config_to_multi(git_get_project_config('url'));
3093 my @git_project_url_list = map { chomp; $_ } <$fd>;
3094 close $fd;
3096 return wantarray ? @git_project_url_list : \@git_project_url_list;
3099 sub git_get_projects_list {
3100 my $filter = shift || '';
3101 my $paranoid = shift;
3102 my @list;
3104 if (-d $projects_list) {
3105 # search in directory
3106 my $dir = $projects_list;
3107 # remove the trailing "/"
3108 $dir =~ s!/+$!!;
3109 my $pfxlen = length("$dir");
3110 my $pfxdepth = ($dir =~ tr!/!!);
3111 # when filtering, search only given subdirectory
3112 if ($filter && !$paranoid) {
3113 $dir .= "/$filter";
3114 $dir =~ s!/+$!!;
3117 File::Find::find({
3118 follow_fast => 1, # follow symbolic links
3119 follow_skip => 2, # ignore duplicates
3120 dangling_symlinks => 0, # ignore dangling symlinks, silently
3121 wanted => sub {
3122 # global variables
3123 our $project_maxdepth;
3124 our $projectroot;
3125 # skip project-list toplevel, if we get it.
3126 return if (m!^[/.]$!);
3127 # only directories can be git repositories
3128 return unless (-d $_);
3129 # need search permission
3130 return unless (-x $_);
3131 # don't traverse too deep (Find is super slow on os x)
3132 # $project_maxdepth excludes depth of $projectroot
3133 if (($File::Find::name =~ tr!/!!) - $pfxdepth > $project_maxdepth) {
3134 $File::Find::prune = 1;
3135 return;
3138 my $path = substr($File::Find::name, $pfxlen + 1);
3139 # paranoidly only filter here
3140 if ($paranoid && $filter && $path !~ m!^\Q$filter\E/!) {
3141 next;
3143 # we check related file in $projectroot
3144 if (check_export_ok("$projectroot/$path")) {
3145 push @list, { path => $path };
3146 $File::Find::prune = 1;
3149 }, "$dir");
3151 } elsif (-f $projects_list) {
3152 # read from file(url-encoded):
3153 # 'git%2Fgit.git Linus+Torvalds'
3154 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3155 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3156 open my $fd, '<', $projects_list or return;
3157 PROJECT:
3158 while (my $line = <$fd>) {
3159 chomp $line;
3160 my ($path, $owner) = split ' ', $line;
3161 $path = unescape($path);
3162 $owner = unescape($owner);
3163 if (!defined $path) {
3164 next;
3166 # if $filter is rpovided, check if $path begins with $filter
3167 if ($filter && $path !~ m!^\Q$filter\E/!) {
3168 next;
3170 if (check_export_ok("$projectroot/$path")) {
3171 my $pr = {
3172 path => $path
3174 if ($owner) {
3175 $pr->{'owner'} = to_utf8($owner);
3177 push @list, $pr;
3180 close $fd;
3182 return @list;
3185 # written with help of Tree::Trie module (Perl Artistic License, GPL compatible)
3186 # as side effects it sets 'forks' field to list of forks for forked projects
3187 sub filter_forks_from_projects_list {
3188 my $projects = shift;
3190 my %trie; # prefix tree of directories (path components)
3191 # generate trie out of those directories that might contain forks
3192 foreach my $pr (@$projects) {
3193 my $path = $pr->{'path'};
3194 $path =~ s/\.git$//; # forks of 'repo.git' are in 'repo/' directory
3195 next if ($path =~ m!/$!); # skip non-bare repositories, e.g. 'repo/.git'
3196 next unless ($path); # skip '.git' repository: tests, git-instaweb
3197 next unless (-d "$projectroot/$path"); # containing directory exists
3198 $pr->{'forks'} = []; # there can be 0 or more forks of project
3200 # add to trie
3201 my @dirs = split('/', $path);
3202 # walk the trie, until either runs out of components or out of trie
3203 my $ref = \%trie;
3204 while (scalar @dirs &&
3205 exists($ref->{$dirs[0]})) {
3206 $ref = $ref->{shift @dirs};
3208 # create rest of trie structure from rest of components
3209 foreach my $dir (@dirs) {
3210 $ref = $ref->{$dir} = {};
3212 # create end marker, store $pr as a data
3213 $ref->{''} = $pr if (!exists $ref->{''});
3216 # filter out forks, by finding shortest prefix match for paths
3217 my @filtered;
3218 PROJECT:
3219 foreach my $pr (@$projects) {
3220 # trie lookup
3221 my $ref = \%trie;
3222 DIR:
3223 foreach my $dir (split('/', $pr->{'path'})) {
3224 if (exists $ref->{''}) {
3225 # found [shortest] prefix, is a fork - skip it
3226 push @{$ref->{''}{'forks'}}, $pr;
3227 next PROJECT;
3229 if (!exists $ref->{$dir}) {
3230 # not in trie, cannot have prefix, not a fork
3231 push @filtered, $pr;
3232 next PROJECT;
3234 # If the dir is there, we just walk one step down the trie.
3235 $ref = $ref->{$dir};
3237 # we ran out of trie
3238 # (shouldn't happen: it's either no match, or end marker)
3239 push @filtered, $pr;
3242 return @filtered;
3245 # note: fill_project_list_info must be run first,
3246 # for 'descr_long' and 'ctags' to be filled
3247 sub search_projects_list {
3248 my ($projlist, %opts) = @_;
3249 my $tagfilter = $opts{'tagfilter'};
3250 my $search_re = $opts{'search_regexp'};
3252 return @$projlist
3253 unless ($tagfilter || $search_re);
3255 # searching projects require filling to be run before it;
3256 fill_project_list_info($projlist,
3257 $tagfilter ? 'ctags' : (),
3258 $search_re ? ('path', 'descr') : ());
3259 my @projects;
3260 PROJECT:
3261 foreach my $pr (@$projlist) {
3263 if ($tagfilter) {
3264 next unless ref($pr->{'ctags'}) eq 'HASH';
3265 next unless
3266 grep { lc($_) eq lc($tagfilter) } keys %{$pr->{'ctags'}};
3269 if ($search_re) {
3270 next unless
3271 $pr->{'path'} =~ /$search_re/ ||
3272 $pr->{'descr_long'} =~ /$search_re/;
3275 push @projects, $pr;
3278 return @projects;
3281 our $gitweb_project_owner = undef;
3282 sub git_get_project_list_from_file {
3284 return if (defined $gitweb_project_owner);
3286 $gitweb_project_owner = {};
3287 # read from file (url-encoded):
3288 # 'git%2Fgit.git Linus+Torvalds'
3289 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3290 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3291 if (-f $projects_list) {
3292 open(my $fd, '<', $projects_list);
3293 while (my $line = <$fd>) {
3294 chomp $line;
3295 my ($pr, $ow) = split ' ', $line;
3296 $pr = unescape($pr);
3297 $ow = unescape($ow);
3298 $gitweb_project_owner->{$pr} = to_utf8($ow);
3300 close $fd;
3304 sub git_get_project_owner {
3305 my $project = shift;
3306 my $owner;
3308 return undef unless $project;
3309 $git_dir = "$projectroot/$project";
3311 if (!defined $gitweb_project_owner) {
3312 git_get_project_list_from_file();
3315 if (exists $gitweb_project_owner->{$project}) {
3316 $owner = $gitweb_project_owner->{$project};
3318 if (!defined $owner){
3319 $owner = git_get_project_config('owner');
3321 if (!defined $owner) {
3322 $owner = get_file_owner("$git_dir");
3325 return $owner;
3328 sub git_get_last_activity {
3329 my ($path) = @_;
3330 my $fd;
3332 $git_dir = "$projectroot/$path";
3333 open($fd, "-|", git_cmd(), 'for-each-ref',
3334 '--format=%(committer)',
3335 '--sort=-committerdate',
3336 '--count=1',
3337 map { "refs/$_" } get_branch_refs ()) or return;
3338 my $most_recent = <$fd>;
3339 close $fd or return;
3340 if (defined $most_recent &&
3341 $most_recent =~ / (\d+) [-+][01]\d\d\d$/) {
3342 my $timestamp = $1;
3343 my $age = time - $timestamp;
3344 return ($age, age_string($age));
3346 return (undef, undef);
3349 # Implementation note: when a single remote is wanted, we cannot use 'git
3350 # remote show -n' because that command always work (assuming it's a remote URL
3351 # if it's not defined), and we cannot use 'git remote show' because that would
3352 # try to make a network roundtrip. So the only way to find if that particular
3353 # remote is defined is to walk the list provided by 'git remote -v' and stop if
3354 # and when we find what we want.
3355 sub git_get_remotes_list {
3356 my $wanted = shift;
3357 my %remotes = ();
3359 open my $fd, '-|' , git_cmd(), 'remote', '-v';
3360 return unless $fd;
3361 while (my $remote = <$fd>) {
3362 chomp $remote;
3363 $remote =~ s!\t(.*?)\s+\((\w+)\)$!!;
3364 next if $wanted and not $remote eq $wanted;
3365 my ($url, $key) = ($1, $2);
3367 $remotes{$remote} ||= { 'heads' => () };
3368 $remotes{$remote}{$key} = $url;
3370 close $fd or return;
3371 return wantarray ? %remotes : \%remotes;
3374 # Takes a hash of remotes as first parameter and fills it by adding the
3375 # available remote heads for each of the indicated remotes.
3376 sub fill_remote_heads {
3377 my $remotes = shift;
3378 my @heads = map { "remotes/$_" } keys %$remotes;
3379 my @remoteheads = git_get_heads_list(undef, @heads);
3380 foreach my $remote (keys %$remotes) {
3381 $remotes->{$remote}{'heads'} = [ grep {
3382 $_->{'name'} =~ s!^$remote/!!
3383 } @remoteheads ];
3387 sub git_get_references {
3388 my $type = shift || "";
3389 my %refs;
3390 # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
3391 # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
3392 open my $fd, "-|", git_cmd(), "show-ref", "--dereference",
3393 ($type ? ("--", "refs/$type") : ()) # use -- <pattern> if $type
3394 or return;
3396 while (my $line = <$fd>) {
3397 chomp $line;
3398 if ($line =~ m!^($oid_regex)\srefs/($type.*)$!) {
3399 if (defined $refs{$1}) {
3400 push @{$refs{$1}}, $2;
3401 } else {
3402 $refs{$1} = [ $2 ];
3406 close $fd or return;
3407 return \%refs;
3410 sub git_get_rev_name_tags {
3411 my $hash = shift || return undef;
3413 open my $fd, "-|", git_cmd(), "name-rev", "--tags", $hash
3414 or return;
3415 my $name_rev = <$fd>;
3416 close $fd;
3418 if ($name_rev =~ m|^$hash tags/(.*)$|) {
3419 return $1;
3420 } else {
3421 # catches also '$hash undefined' output
3422 return undef;
3426 ## ----------------------------------------------------------------------
3427 ## parse to hash functions
3429 sub parse_date {
3430 my $epoch = shift;
3431 my $tz = shift || "-0000";
3433 my %date;
3434 my @months = ("Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
3435 my @days = ("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat");
3436 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($epoch);
3437 $date{'hour'} = $hour;
3438 $date{'minute'} = $min;
3439 $date{'mday'} = $mday;
3440 $date{'day'} = $days[$wday];
3441 $date{'month'} = $months[$mon];
3442 $date{'rfc2822'} = sprintf "%s, %d %s %4d %02d:%02d:%02d +0000",
3443 $days[$wday], $mday, $months[$mon], 1900+$year, $hour ,$min, $sec;
3444 $date{'mday-time'} = sprintf "%d %s %02d:%02d",
3445 $mday, $months[$mon], $hour ,$min;
3446 $date{'iso-8601'} = sprintf "%04d-%02d-%02dT%02d:%02d:%02dZ",
3447 1900+$year, 1+$mon, $mday, $hour ,$min, $sec;
3449 my ($tz_sign, $tz_hour, $tz_min) =
3450 ($tz =~ m/^([-+])(\d\d)(\d\d)$/);
3451 $tz_sign = ($tz_sign eq '-' ? -1 : +1);
3452 my $local = $epoch + $tz_sign*((($tz_hour*60) + $tz_min)*60);
3453 ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($local);
3454 $date{'hour_local'} = $hour;
3455 $date{'minute_local'} = $min;
3456 $date{'tz_local'} = $tz;
3457 $date{'iso-tz'} = sprintf("%04d-%02d-%02d %02d:%02d:%02d %s",
3458 1900+$year, $mon+1, $mday,
3459 $hour, $min, $sec, $tz);
3460 return %date;
3463 sub hide_mailaddrs_if_private {
3464 my $line = shift;
3465 return $line unless gitweb_check_feature('email-privacy');
3466 $line =~ s/<[^@>]+@[^>]+>/<redacted>/g;
3467 return $line;
3470 sub parse_tag {
3471 my $tag_id = shift;
3472 my %tag;
3473 my @comment;
3475 open my $fd, "-|", git_cmd(), "cat-file", "tag", $tag_id or return;
3476 $tag{'id'} = $tag_id;
3477 while (my $line = <$fd>) {
3478 chomp $line;
3479 if ($line =~ m/^object ($oid_regex)$/) {
3480 $tag{'object'} = $1;
3481 } elsif ($line =~ m/^type (.+)$/) {
3482 $tag{'type'} = $1;
3483 } elsif ($line =~ m/^tag (.+)$/) {
3484 $tag{'name'} = $1;
3485 } elsif ($line =~ m/^tagger (.*) ([0-9]+) (.*)$/) {
3486 $tag{'author'} = hide_mailaddrs_if_private($1);
3487 $tag{'author_epoch'} = $2;
3488 $tag{'author_tz'} = $3;
3489 if ($tag{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3490 $tag{'author_name'} = $1;
3491 $tag{'author_email'} = $2;
3492 } else {
3493 $tag{'author_name'} = $tag{'author'};
3495 } elsif ($line =~ m/--BEGIN/) {
3496 push @comment, $line;
3497 last;
3498 } elsif ($line eq "") {
3499 last;
3502 push @comment, <$fd>;
3503 $tag{'comment'} = \@comment;
3504 close $fd or return;
3505 if (!defined $tag{'name'}) {
3506 return
3508 return %tag
3511 sub parse_commit_text {
3512 my ($commit_text, $withparents) = @_;
3513 my @commit_lines = split '\n', $commit_text;
3514 my %co;
3516 pop @commit_lines; # Remove '\0'
3518 if (! @commit_lines) {
3519 return;
3522 my $header = shift @commit_lines;
3523 if ($header !~ m/^$oid_regex/) {
3524 return;
3526 ($co{'id'}, my @parents) = split ' ', $header;
3527 while (my $line = shift @commit_lines) {
3528 last if $line eq "\n";
3529 if ($line =~ m/^tree ($oid_regex)$/) {
3530 $co{'tree'} = $1;
3531 } elsif ((!defined $withparents) && ($line =~ m/^parent ($oid_regex)$/)) {
3532 push @parents, $1;
3533 } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {
3534 $co{'author'} = hide_mailaddrs_if_private(to_utf8($1));
3535 $co{'author_epoch'} = $2;
3536 $co{'author_tz'} = $3;
3537 if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3538 $co{'author_name'} = $1;
3539 $co{'author_email'} = $2;
3540 } else {
3541 $co{'author_name'} = $co{'author'};
3543 } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {
3544 $co{'committer'} = hide_mailaddrs_if_private(to_utf8($1));
3545 $co{'committer_epoch'} = $2;
3546 $co{'committer_tz'} = $3;
3547 if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
3548 $co{'committer_name'} = $1;
3549 $co{'committer_email'} = $2;
3550 } else {
3551 $co{'committer_name'} = $co{'committer'};
3555 if (!defined $co{'tree'}) {
3556 return;
3558 $co{'parents'} = \@parents;
3559 $co{'parent'} = $parents[0];
3561 foreach my $title (@commit_lines) {
3562 $title =~ s/^ //;
3563 if ($title ne "") {
3564 $co{'title'} = chop_str($title, 80, 5);
3565 $co{'title_short'} = chop_str($title, 50, 5);
3566 last;
3569 if (! defined $co{'title'} || $co{'title'} eq "") {
3570 $co{'title'} = $co{'title_short'} = '(no commit message)';
3572 # remove added spaces, redact e-mail addresses if applicable.
3573 foreach my $line (@commit_lines) {
3574 $line =~ s/^ //;
3575 $line = hide_mailaddrs_if_private($line);
3577 $co{'comment'} = \@commit_lines;
3579 my $age = time - $co{'committer_epoch'};
3580 $co{'age'} = $age;
3581 $co{'age_string'} = age_string($age);
3582 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($co{'committer_epoch'});
3583 if ($age > 60*60*24*7*2) {
3584 $co{'age_string_date'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3585 $co{'age_string_age'} = $co{'age_string'};
3586 } else {
3587 $co{'age_string_date'} = $co{'age_string'};
3588 $co{'age_string_age'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3590 return %co;
3593 sub parse_commit {
3594 my ($commit_id) = @_;
3595 my %co;
3597 local $/ = "\0";
3599 open my $fd, "-|", git_cmd(), "rev-list",
3600 "--parents",
3601 "--header",
3602 "--max-count=1",
3603 $commit_id,
3604 "--",
3605 or die_error(500, "Open git-rev-list failed");
3606 %co = parse_commit_text(<$fd>, 1);
3607 close $fd;
3609 return %co;
3612 sub parse_commits {
3613 my ($commit_id, $maxcount, $skip, $filename, @args) = @_;
3614 my @cos;
3616 $maxcount ||= 1;
3617 $skip ||= 0;
3619 local $/ = "\0";
3621 open my $fd, "-|", git_cmd(), "rev-list",
3622 "--header",
3623 @args,
3624 ("--max-count=" . $maxcount),
3625 ("--skip=" . $skip),
3626 @extra_options,
3627 $commit_id,
3628 "--",
3629 ($filename ? ($filename) : ())
3630 or die_error(500, "Open git-rev-list failed");
3631 while (my $line = <$fd>) {
3632 my %co = parse_commit_text($line);
3633 push @cos, \%co;
3635 close $fd;
3637 return wantarray ? @cos : \@cos;
3640 # parse line of git-diff-tree "raw" output
3641 sub parse_difftree_raw_line {
3642 my $line = shift;
3643 my %res;
3645 # ':100644 100644 03b218260e99b78c6df0ed378e59ed9205ccc96d 3b93d5e7cc7f7dd4ebed13a5cc1a4ad976fc94d8 M ls-files.c'
3646 # ':100644 100644 7f9281985086971d3877aca27704f2aaf9c448ce bc190ebc71bbd923f2b728e505408f5e54bd073a M rev-tree.c'
3647 if ($line =~ m/^:([0-7]{6}) ([0-7]{6}) ($oid_regex) ($oid_regex) (.)([0-9]{0,3})\t(.*)$/) {
3648 $res{'from_mode'} = $1;
3649 $res{'to_mode'} = $2;
3650 $res{'from_id'} = $3;
3651 $res{'to_id'} = $4;
3652 $res{'status'} = $5;
3653 $res{'similarity'} = $6;
3654 if ($res{'status'} eq 'R' || $res{'status'} eq 'C') { # renamed or copied
3655 ($res{'from_file'}, $res{'to_file'}) = map { unquote($_) } split("\t", $7);
3656 } else {
3657 $res{'from_file'} = $res{'to_file'} = $res{'file'} = unquote($7);
3660 # '::100755 100755 100755 60e79ca1b01bc8b057abe17ddab484699a7f5fdb 94067cc5f73388f33722d52ae02f44692bc07490 94067cc5f73388f33722d52ae02f44692bc07490 MR git-gui/git-gui.sh'
3661 # combined diff (for merge commit)
3662 elsif ($line =~ s/^(::+)((?:[0-7]{6} )+)((?:$oid_regex )+)([a-zA-Z]+)\t(.*)$//) {
3663 $res{'nparents'} = length($1);
3664 $res{'from_mode'} = [ split(' ', $2) ];
3665 $res{'to_mode'} = pop @{$res{'from_mode'}};
3666 $res{'from_id'} = [ split(' ', $3) ];
3667 $res{'to_id'} = pop @{$res{'from_id'}};
3668 $res{'status'} = [ split('', $4) ];
3669 $res{'to_file'} = unquote($5);
3671 # 'c512b523472485aef4fff9e57b229d9d243c967f'
3672 elsif ($line =~ m/^($oid_regex)$/) {
3673 $res{'commit'} = $1;
3676 return wantarray ? %res : \%res;
3679 # wrapper: return parsed line of git-diff-tree "raw" output
3680 # (the argument might be raw line, or parsed info)
3681 sub parsed_difftree_line {
3682 my $line_or_ref = shift;
3684 if (ref($line_or_ref) eq "HASH") {
3685 # pre-parsed (or generated by hand)
3686 return $line_or_ref;
3687 } else {
3688 return parse_difftree_raw_line($line_or_ref);
3692 # parse line of git-ls-tree output
3693 sub parse_ls_tree_line {
3694 my $line = shift;
3695 my %opts = @_;
3696 my %res;
3698 if ($opts{'-l'}) {
3699 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa 16717 panic.c'
3700 $line =~ m/^([0-9]+) (.+) ($oid_regex) +(-|[0-9]+)\t(.+)$/s;
3702 $res{'mode'} = $1;
3703 $res{'type'} = $2;
3704 $res{'hash'} = $3;
3705 $res{'size'} = $4;
3706 if ($opts{'-z'}) {
3707 $res{'name'} = $5;
3708 } else {
3709 $res{'name'} = unquote($5);
3711 } else {
3712 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
3713 $line =~ m/^([0-9]+) (.+) ($oid_regex)\t(.+)$/s;
3715 $res{'mode'} = $1;
3716 $res{'type'} = $2;
3717 $res{'hash'} = $3;
3718 if ($opts{'-z'}) {
3719 $res{'name'} = $4;
3720 } else {
3721 $res{'name'} = unquote($4);
3725 return wantarray ? %res : \%res;
3728 # generates _two_ hashes, references to which are passed as 2 and 3 argument
3729 sub parse_from_to_diffinfo {
3730 my ($diffinfo, $from, $to, @parents) = @_;
3732 if ($diffinfo->{'nparents'}) {
3733 # combined diff
3734 $from->{'file'} = [];
3735 $from->{'href'} = [];
3736 fill_from_file_info($diffinfo, @parents)
3737 unless exists $diffinfo->{'from_file'};
3738 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
3739 $from->{'file'}[$i] =
3740 defined $diffinfo->{'from_file'}[$i] ?
3741 $diffinfo->{'from_file'}[$i] :
3742 $diffinfo->{'to_file'};
3743 if ($diffinfo->{'status'}[$i] ne "A") { # not new (added) file
3744 $from->{'href'}[$i] = href(action=>"blob",
3745 hash_base=>$parents[$i],
3746 hash=>$diffinfo->{'from_id'}[$i],
3747 file_name=>$from->{'file'}[$i]);
3748 } else {
3749 $from->{'href'}[$i] = undef;
3752 } else {
3753 # ordinary (not combined) diff
3754 $from->{'file'} = $diffinfo->{'from_file'};
3755 if ($diffinfo->{'status'} ne "A") { # not new (added) file
3756 $from->{'href'} = href(action=>"blob", hash_base=>$hash_parent,
3757 hash=>$diffinfo->{'from_id'},
3758 file_name=>$from->{'file'});
3759 } else {
3760 delete $from->{'href'};
3764 $to->{'file'} = $diffinfo->{'to_file'};
3765 if (!is_deleted($diffinfo)) { # file exists in result
3766 $to->{'href'} = href(action=>"blob", hash_base=>$hash,
3767 hash=>$diffinfo->{'to_id'},
3768 file_name=>$to->{'file'});
3769 } else {
3770 delete $to->{'href'};
3774 ## ......................................................................
3775 ## parse to array of hashes functions
3777 sub git_get_heads_list {
3778 my ($limit, @classes) = @_;
3779 @classes = get_branch_refs() unless @classes;
3780 my @patterns = map { "refs/$_" } @classes;
3781 my @headslist;
3783 open my $fd, '-|', git_cmd(), 'for-each-ref',
3784 ($limit ? '--count='.($limit+1) : ()),
3785 '--sort=-HEAD', '--sort=-committerdate',
3786 '--format=%(objectname) %(refname) %(subject)%00%(committer)',
3787 @patterns
3788 or return;
3789 while (my $line = <$fd>) {
3790 my %ref_item;
3792 chomp $line;
3793 my ($refinfo, $committerinfo) = split(/\0/, $line);
3794 my ($hash, $name, $title) = split(' ', $refinfo, 3);
3795 my ($committer, $epoch, $tz) =
3796 ($committerinfo =~ /^(.*) ([0-9]+) (.*)$/);
3797 $ref_item{'fullname'} = $name;
3798 my $strip_refs = join '|', map { quotemeta } get_branch_refs();
3799 $name =~ s!^refs/($strip_refs|remotes)/!!;
3800 $ref_item{'name'} = $name;
3801 # for refs neither in 'heads' nor 'remotes' we want to
3802 # show their ref dir
3803 my $ref_dir = (defined $1) ? $1 : '';
3804 if ($ref_dir ne '' and $ref_dir ne 'heads' and $ref_dir ne 'remotes') {
3805 $ref_item{'name'} .= ' (' . $ref_dir . ')';
3808 $ref_item{'id'} = $hash;
3809 $ref_item{'title'} = $title || '(no commit message)';
3810 $ref_item{'epoch'} = $epoch;
3811 if ($epoch) {
3812 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3813 } else {
3814 $ref_item{'age'} = "unknown";
3817 push @headslist, \%ref_item;
3819 close $fd;
3821 return wantarray ? @headslist : \@headslist;
3824 sub git_get_tags_list {
3825 my $limit = shift;
3826 my @tagslist;
3828 open my $fd, '-|', git_cmd(), 'for-each-ref',
3829 ($limit ? '--count='.($limit+1) : ()), '--sort=-creatordate',
3830 '--format=%(objectname) %(objecttype) %(refname) '.
3831 '%(*objectname) %(*objecttype) %(subject)%00%(creator)',
3832 'refs/tags'
3833 or return;
3834 while (my $line = <$fd>) {
3835 my %ref_item;
3837 chomp $line;
3838 my ($refinfo, $creatorinfo) = split(/\0/, $line);
3839 my ($id, $type, $name, $refid, $reftype, $title) = split(' ', $refinfo, 6);
3840 my ($creator, $epoch, $tz) =
3841 ($creatorinfo =~ /^(.*) ([0-9]+) (.*)$/);
3842 $ref_item{'fullname'} = $name;
3843 $name =~ s!^refs/tags/!!;
3845 $ref_item{'type'} = $type;
3846 $ref_item{'id'} = $id;
3847 $ref_item{'name'} = $name;
3848 if ($type eq "tag") {
3849 $ref_item{'subject'} = $title;
3850 $ref_item{'reftype'} = $reftype;
3851 $ref_item{'refid'} = $refid;
3852 } else {
3853 $ref_item{'reftype'} = $type;
3854 $ref_item{'refid'} = $id;
3857 if ($type eq "tag" || $type eq "commit") {
3858 $ref_item{'epoch'} = $epoch;
3859 if ($epoch) {
3860 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3861 } else {
3862 $ref_item{'age'} = "unknown";
3866 push @tagslist, \%ref_item;
3868 close $fd;
3870 return wantarray ? @tagslist : \@tagslist;
3873 ## ----------------------------------------------------------------------
3874 ## filesystem-related functions
3876 sub get_file_owner {
3877 my $path = shift;
3879 my ($dev, $ino, $mode, $nlink, $st_uid, $st_gid, $rdev, $size) = stat($path);
3880 my ($name, $passwd, $uid, $gid, $quota, $comment, $gcos, $dir, $shell) = getpwuid($st_uid);
3881 if (!defined $gcos) {
3882 return undef;
3884 my $owner = $gcos;
3885 $owner =~ s/[,;].*$//;
3886 return to_utf8($owner);
3889 # assume that file exists
3890 sub insert_file {
3891 my $filename = shift;
3893 open my $fd, '<', $filename;
3894 print map { to_utf8($_) } <$fd>;
3895 close $fd;
3898 ## ......................................................................
3899 ## mimetype related functions
3901 sub mimetype_guess_file {
3902 my $filename = shift;
3903 my $mimemap = shift;
3904 -r $mimemap or return undef;
3906 my %mimemap;
3907 open(my $mh, '<', $mimemap) or return undef;
3908 while (<$mh>) {
3909 next if m/^#/; # skip comments
3910 my ($mimetype, @exts) = split(/\s+/);
3911 foreach my $ext (@exts) {
3912 $mimemap{$ext} = $mimetype;
3915 close($mh);
3917 $filename =~ /\.([^.]*)$/;
3918 return $mimemap{$1};
3921 sub mimetype_guess {
3922 my $filename = shift;
3923 my $mime;
3924 $filename =~ /\./ or return undef;
3926 if ($mimetypes_file) {
3927 my $file = $mimetypes_file;
3928 if ($file !~ m!^/!) { # if it is relative path
3929 # it is relative to project
3930 $file = "$projectroot/$project/$file";
3932 $mime = mimetype_guess_file($filename, $file);
3934 $mime ||= mimetype_guess_file($filename, '/etc/mime.types');
3935 return $mime;
3938 sub blob_mimetype {
3939 my $fd = shift;
3940 my $filename = shift;
3942 if ($filename) {
3943 my $mime = mimetype_guess($filename);
3944 $mime and return $mime;
3947 # just in case
3948 return $default_blob_plain_mimetype unless $fd;
3950 if (-T $fd) {
3951 return 'text/plain';
3952 } elsif (! $filename) {
3953 return 'application/octet-stream';
3954 } elsif ($filename =~ m/\.png$/i) {
3955 return 'image/png';
3956 } elsif ($filename =~ m/\.gif$/i) {
3957 return 'image/gif';
3958 } elsif ($filename =~ m/\.jpe?g$/i) {
3959 return 'image/jpeg';
3960 } else {
3961 return 'application/octet-stream';
3965 sub blob_contenttype {
3966 my ($fd, $file_name, $type) = @_;
3968 $type ||= blob_mimetype($fd, $file_name);
3969 if ($type eq 'text/plain' && defined $default_text_plain_charset) {
3970 $type .= "; charset=$default_text_plain_charset";
3973 return $type;
3976 # guess file syntax for syntax highlighting; return undef if no highlighting
3977 # the name of syntax can (in the future) depend on syntax highlighter used
3978 sub guess_file_syntax {
3979 my ($highlight, $file_name) = @_;
3980 return undef unless ($highlight && defined $file_name);
3981 my $basename = basename($file_name, '.in');
3982 return $highlight_basename{$basename}
3983 if exists $highlight_basename{$basename};
3985 $basename =~ /\.([^.]*)$/;
3986 my $ext = $1 or return undef;
3987 return $highlight_ext{$ext}
3988 if exists $highlight_ext{$ext};
3990 return undef;
3993 # run highlighter and return FD of its output,
3994 # or return original FD if no highlighting
3995 sub run_highlighter {
3996 my ($fd, $highlight, $syntax) = @_;
3997 return $fd unless ($highlight);
3999 close $fd;
4000 my $syntax_arg = (defined $syntax) ? "--syntax $syntax" : "--force";
4001 open $fd, quote_command(git_cmd(), "cat-file", "blob", $hash)." | ".
4002 quote_command($^X, '-CO', '-MEncode=decode,FB_DEFAULT', '-pse',
4003 '$_ = decode($fe, $_, FB_DEFAULT) if !utf8::decode($_);',
4004 '--', "-fe=$fallback_encoding")." | ".
4005 quote_command($highlight_bin).
4006 " --replace-tabs=8 --fragment $syntax_arg |"
4007 or die_error(500, "Couldn't open file or run syntax highlighter");
4008 return $fd;
4011 ## ======================================================================
4012 ## functions printing HTML: header, footer, error page
4014 sub get_page_title {
4015 my $title = to_utf8($site_name);
4017 unless (defined $project) {
4018 if (defined $project_filter) {
4019 $title .= " - projects in '" . esc_path($project_filter) . "'";
4021 return $title;
4023 $title .= " - " . to_utf8($project);
4025 return $title unless (defined $action);
4026 $title .= "/$action"; # $action is US-ASCII (7bit ASCII)
4028 return $title unless (defined $file_name);
4029 $title .= " - " . esc_path($file_name);
4030 if ($action eq "tree" && $file_name !~ m|/$|) {
4031 $title .= "/";
4034 return $title;
4037 sub get_content_type_html {
4038 # require explicit support from the UA if we are to send the page as
4039 # 'application/xhtml+xml', otherwise send it as plain old 'text/html'.
4040 # we have to do this because MSIE sometimes globs '*/*', pretending to
4041 # support xhtml+xml but choking when it gets what it asked for.
4042 if (defined $cgi->http('HTTP_ACCEPT') &&
4043 $cgi->http('HTTP_ACCEPT') =~ m/(,|;|\s|^)application\/xhtml\+xml(,|;|\s|$)/ &&
4044 $cgi->Accept('application/xhtml+xml') != 0) {
4045 return 'application/xhtml+xml';
4046 } else {
4047 return 'text/html';
4051 sub print_feed_meta {
4052 if (defined $project) {
4053 my %href_params = get_feed_info();
4054 if (!exists $href_params{'-title'}) {
4055 $href_params{'-title'} = 'log';
4058 foreach my $format (qw(RSS Atom)) {
4059 my $type = lc($format);
4060 my %link_attr = (
4061 '-rel' => 'alternate',
4062 '-title' => esc_attr("$project - $href_params{'-title'} - $format feed"),
4063 '-type' => "application/$type+xml"
4066 $href_params{'extra_options'} = undef;
4067 $href_params{'action'} = $type;
4068 $link_attr{'-href'} = esc_attr(href(%href_params));
4069 print "<link ".
4070 "rel=\"$link_attr{'-rel'}\" ".
4071 "title=\"$link_attr{'-title'}\" ".
4072 "href=\"$link_attr{'-href'}\" ".
4073 "type=\"$link_attr{'-type'}\" ".
4074 "/>\n";
4076 $href_params{'extra_options'} = '--no-merges';
4077 $link_attr{'-href'} = esc_attr(href(%href_params));
4078 $link_attr{'-title'} .= ' (no merges)';
4079 print "<link ".
4080 "rel=\"$link_attr{'-rel'}\" ".
4081 "title=\"$link_attr{'-title'}\" ".
4082 "href=\"$link_attr{'-href'}\" ".
4083 "type=\"$link_attr{'-type'}\" ".
4084 "/>\n";
4087 } else {
4088 printf('<link rel="alternate" title="%s projects list" '.
4089 'href="%s" type="text/plain; charset=utf-8" />'."\n",
4090 esc_attr($site_name),
4091 esc_attr(href(project=>undef, action=>"project_index")));
4092 printf('<link rel="alternate" title="%s projects feeds" '.
4093 'href="%s" type="text/x-opml" />'."\n",
4094 esc_attr($site_name),
4095 esc_attr(href(project=>undef, action=>"opml")));
4099 sub print_header_links {
4100 my $status = shift;
4102 # print out each stylesheet that exist, providing backwards capability
4103 # for those people who defined $stylesheet in a config file
4104 if (defined $stylesheet) {
4105 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
4106 } else {
4107 foreach my $stylesheet (@stylesheets) {
4108 next unless $stylesheet;
4109 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
4112 print_feed_meta()
4113 if ($status eq '200 OK');
4114 if (defined $favicon) {
4115 print qq(<link rel="shortcut icon" href=").esc_url($favicon).qq(" type="image/png" />\n);
4119 sub print_nav_breadcrumbs_path {
4120 my $dirprefix = undef;
4121 while (my $part = shift) {
4122 $dirprefix .= "/" if defined $dirprefix;
4123 $dirprefix .= $part;
4124 print $cgi->a({-href => href(project => undef,
4125 project_filter => $dirprefix,
4126 action => "project_list")},
4127 esc_html($part)) . " / ";
4131 sub print_nav_breadcrumbs {
4132 my %opts = @_;
4134 for my $crumb (@extra_breadcrumbs, [ $home_link_str => $home_link ]) {
4135 print $cgi->a({-href => esc_url($crumb->[1])}, $crumb->[0]) . " / ";
4137 if (defined $project) {
4138 my @dirname = split '/', $project;
4139 my $projectbasename = pop @dirname;
4140 print_nav_breadcrumbs_path(@dirname);
4141 print $cgi->a({-href => href(action=>"summary")}, esc_html($projectbasename));
4142 if (defined $action) {
4143 my $action_print = $action ;
4144 if (defined $opts{-action_extra}) {
4145 $action_print = $cgi->a({-href => href(action=>$action)},
4146 $action);
4148 print " / $action_print";
4150 if (defined $opts{-action_extra}) {
4151 print " / $opts{-action_extra}";
4153 print "\n";
4154 } elsif (defined $project_filter) {
4155 print_nav_breadcrumbs_path(split '/', $project_filter);
4159 sub print_search_form {
4160 if (!defined $searchtext) {
4161 $searchtext = "";
4163 my $search_hash;
4164 if (defined $hash_base) {
4165 $search_hash = $hash_base;
4166 } elsif (defined $hash) {
4167 $search_hash = $hash;
4168 } else {
4169 $search_hash = "HEAD";
4171 my $action = $my_uri;
4172 my $use_pathinfo = gitweb_check_feature('pathinfo');
4173 if ($use_pathinfo) {
4174 $action .= "/".esc_url($project);
4176 print $cgi->start_form(-method => "get", -action => $action) .
4177 "<div class=\"search\">\n" .
4178 (!$use_pathinfo &&
4179 $cgi->input({-name=>"p", -value=>$project, -type=>"hidden"}) . "\n") .
4180 $cgi->input({-name=>"a", -value=>"search", -type=>"hidden"}) . "\n" .
4181 $cgi->input({-name=>"h", -value=>$search_hash, -type=>"hidden"}) . "\n" .
4182 $cgi->popup_menu(-name => 'st', -default => 'commit',
4183 -values => ['commit', 'grep', 'author', 'committer', 'pickaxe']) .
4184 " " . $cgi->a({-href => href(action=>"search_help"),
4185 -title => "search help" }, "?") . " search:\n",
4186 $cgi->textfield(-name => "s", -value => $searchtext, -override => 1) . "\n" .
4187 "<span title=\"Extended regular expression\">" .
4188 $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
4189 -checked => $search_use_regexp) .
4190 "</span>" .
4191 "</div>" .
4192 $cgi->end_form() . "\n";
4195 sub git_header_html {
4196 my $status = shift || "200 OK";
4197 my $expires = shift;
4198 my %opts = @_;
4200 my $title = get_page_title();
4201 print $cgi->header(-type=>get_content_type_html(), -charset => 'utf-8',
4202 -status=> $status, -expires => $expires)
4203 unless ($opts{'-no_http_header'});
4204 my $mod_perl_version = $ENV{'MOD_PERL'} ? " $ENV{'MOD_PERL'}" : '';
4205 print <<EOF;
4206 <?xml version="1.0" encoding="utf-8"?>
4207 <!DOCTYPE html [
4208 <!ENTITY nbsp "&#xA0;">
4209 <!ENTITY sdot "&#x22C5;">
4211 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
4212 <!-- git web interface version $version, (C) 2005-2006, Kay Sievers <kay.sievers\@vrfy.org>, Christian Gierke -->
4213 <!-- git core binaries version $git_version -->
4214 <head>
4215 <meta name="generator" content="gitweb/$version git/$git_version$mod_perl_version"/>
4216 <meta name="robots" content="index, nofollow"/>
4217 <meta name="viewport" content="width=device-width, initial-scale=1"/>
4218 <title>$title</title>
4220 # the stylesheet, favicon etc urls won't work correctly with path_info
4221 # unless we set the appropriate base URL
4222 if ($ENV{'PATH_INFO'}) {
4223 print "<base href=\"".esc_url($base_url)."\" />\n";
4225 print_header_links($status);
4227 if (defined $site_html_head_string) {
4228 print to_utf8($site_html_head_string);
4231 print "</head>\n" .
4232 "<body>\n";
4234 if (defined $site_header && -f $site_header) {
4235 insert_file($site_header);
4238 print "<div class=\"page_header\">\n";
4239 if (defined $logo) {
4240 print $cgi->a({-href => esc_url($logo_url),
4241 -title => $logo_label},
4242 $cgi->img({-src => esc_url($logo),
4243 -width => 72, -height => 27,
4244 -alt => "git",
4245 -class => "logo"}));
4247 print_nav_breadcrumbs(%opts);
4248 print "</div>\n";
4250 my $have_search = gitweb_check_feature('search');
4251 if (defined $project && $have_search) {
4252 print_search_form();
4256 sub git_footer_html {
4257 my $feed_class = 'rss_logo';
4259 print "<div class=\"page_footer\">\n";
4260 if (defined $project) {
4261 my $descr = git_get_project_description($project);
4262 if (defined $descr) {
4263 print "<div class=\"page_footer_text\">" . esc_html($descr) . "</div>\n";
4266 my %href_params = get_feed_info();
4267 if (!%href_params) {
4268 $feed_class .= ' generic';
4270 $href_params{'-title'} ||= 'log';
4272 foreach my $format (qw(RSS Atom)) {
4273 $href_params{'action'} = lc($format);
4274 print $cgi->a({-href => href(%href_params),
4275 -title => "$href_params{'-title'} $format feed",
4276 -class => $feed_class}, $format)."\n";
4279 } else {
4280 print $cgi->a({-href => href(project=>undef, action=>"opml",
4281 project_filter => $project_filter),
4282 -class => $feed_class}, "OPML") . " ";
4283 print $cgi->a({-href => href(project=>undef, action=>"project_index",
4284 project_filter => $project_filter),
4285 -class => $feed_class}, "TXT") . "\n";
4287 print "</div>\n"; # class="page_footer"
4289 if (defined $t0 && gitweb_check_feature('timed')) {
4290 print "<div id=\"generating_info\">\n";
4291 print 'This page took '.
4292 '<span id="generating_time" class="time_span">'.
4293 tv_interval($t0, [ gettimeofday() ]).
4294 ' seconds </span>'.
4295 ' and '.
4296 '<span id="generating_cmd">'.
4297 $number_of_git_cmds.
4298 '</span> git commands '.
4299 " to generate.\n";
4300 print "</div>\n"; # class="page_footer"
4303 if (defined $site_footer && -f $site_footer) {
4304 insert_file($site_footer);
4307 print qq!<script type="text/javascript" src="!.esc_url($javascript).qq!"></script>\n!;
4308 if (defined $action &&
4309 $action eq 'blame_incremental') {
4310 print qq!<script type="text/javascript">\n!.
4311 qq!startBlame("!. esc_attr(href(action=>"blame_data", -replay=>1)) .qq!",\n!.
4312 qq! "!. esc_attr(href()) .qq!");\n!.
4313 qq!</script>\n!;
4314 } else {
4315 my ($jstimezone, $tz_cookie, $datetime_class) =
4316 gitweb_get_feature('javascript-timezone');
4318 print qq!<script type="text/javascript">\n!.
4319 qq!window.onload = function () {\n!;
4320 if (gitweb_check_feature('javascript-actions')) {
4321 print qq! fixLinks();\n!;
4323 if ($jstimezone && $tz_cookie && $datetime_class) {
4324 print qq! var tz_cookie = { name: '$tz_cookie', expires: 14, path: '/' };\n!. # in days
4325 qq! onloadTZSetup('$jstimezone', tz_cookie, '$datetime_class');\n!;
4327 print qq!};\n!.
4328 qq!</script>\n!;
4331 print "</body>\n" .
4332 "</html>";
4335 # die_error(<http_status_code>, <error_message>[, <detailed_html_description>])
4336 # Example: die_error(404, 'Hash not found')
4337 # By convention, use the following status codes (as defined in RFC 2616):
4338 # 400: Invalid or missing CGI parameters, or
4339 # requested object exists but has wrong type.
4340 # 403: Requested feature (like "pickaxe" or "snapshot") not enabled on
4341 # this server or project.
4342 # 404: Requested object/revision/project doesn't exist.
4343 # 500: The server isn't configured properly, or
4344 # an internal error occurred (e.g. failed assertions caused by bugs), or
4345 # an unknown error occurred (e.g. the git binary died unexpectedly).
4346 # 503: The server is currently unavailable (because it is overloaded,
4347 # or down for maintenance). Generally, this is a temporary state.
4348 sub die_error {
4349 my $status = shift || 500;
4350 my $error = esc_html(shift) || "Internal Server Error";
4351 my $extra = shift;
4352 my %opts = @_;
4354 my %http_responses = (
4355 400 => '400 Bad Request',
4356 403 => '403 Forbidden',
4357 404 => '404 Not Found',
4358 500 => '500 Internal Server Error',
4359 503 => '503 Service Unavailable',
4361 git_header_html($http_responses{$status}, undef, %opts);
4362 print <<EOF;
4363 <div class="page_body">
4364 <br /><br />
4365 $status - $error
4366 <br />
4368 if (defined $extra) {
4369 print "<hr />\n" .
4370 "$extra\n";
4372 print "</div>\n";
4374 git_footer_html();
4375 goto DONE_GITWEB
4376 unless ($opts{'-error_handler'});
4379 ## ----------------------------------------------------------------------
4380 ## functions printing or outputting HTML: navigation
4382 sub git_print_page_nav {
4383 my ($current, $suppress, $head, $treehead, $treebase, $extra) = @_;
4384 $extra = '' if !defined $extra; # pager or formats
4386 my @navs = qw(summary shortlog log commit commitdiff tree);
4387 if ($suppress) {
4388 @navs = grep { $_ ne $suppress } @navs;
4391 my %arg = map { $_ => {action=>$_} } @navs;
4392 if (defined $head) {
4393 for (qw(commit commitdiff)) {
4394 $arg{$_}{'hash'} = $head;
4396 if ($current =~ m/^(tree | log | shortlog | commit | commitdiff | search)$/x) {
4397 for (qw(shortlog log)) {
4398 $arg{$_}{'hash'} = $head;
4403 $arg{'tree'}{'hash'} = $treehead if defined $treehead;
4404 $arg{'tree'}{'hash_base'} = $treebase if defined $treebase;
4406 my @actions = gitweb_get_feature('actions');
4407 my %repl = (
4408 '%' => '%',
4409 'n' => $project, # project name
4410 'f' => $git_dir, # project path within filesystem
4411 'h' => $treehead || '', # current hash ('h' parameter)
4412 'b' => $treebase || '', # hash base ('hb' parameter)
4414 while (@actions) {
4415 my ($label, $link, $pos) = splice(@actions,0,3);
4416 # insert
4417 @navs = map { $_ eq $pos ? ($_, $label) : $_ } @navs;
4418 # munch munch
4419 $link =~ s/%([%nfhb])/$repl{$1}/g;
4420 $arg{$label}{'_href'} = $link;
4423 print "<div class=\"page_nav\">\n" .
4424 (join " | ",
4425 map { $_ eq $current ?
4426 $_ : $cgi->a({-href => ($arg{$_}{_href} ? $arg{$_}{_href} : href(%{$arg{$_}}))}, "$_")
4427 } @navs);
4428 print "<br/>\n$extra<br/>\n" .
4429 "</div>\n";
4432 # returns a submenu for the navigation of the refs views (tags, heads,
4433 # remotes) with the current view disabled and the remotes view only
4434 # available if the feature is enabled
4435 sub format_ref_views {
4436 my ($current) = @_;
4437 my @ref_views = qw{tags heads};
4438 push @ref_views, 'remotes' if gitweb_check_feature('remote_heads');
4439 return join " | ", map {
4440 $_ eq $current ? $_ :
4441 $cgi->a({-href => href(action=>$_)}, $_)
4442 } @ref_views
4445 sub format_paging_nav {
4446 my ($action, $page, $has_next_link) = @_;
4447 my $paging_nav;
4450 if ($page > 0) {
4451 $paging_nav .=
4452 $cgi->a({-href => href(-replay=>1, page=>undef)}, "first") .
4453 " &sdot; " .
4454 $cgi->a({-href => href(-replay=>1, page=>$page-1),
4455 -accesskey => "p", -title => "Alt-p"}, "prev");
4456 } else {
4457 $paging_nav .= "first &sdot; prev";
4460 if ($has_next_link) {
4461 $paging_nav .= " &sdot; " .
4462 $cgi->a({-href => href(-replay=>1, page=>$page+1),
4463 -accesskey => "n", -title => "Alt-n"}, "next");
4464 } else {
4465 $paging_nav .= " &sdot; next";
4468 return $paging_nav;
4471 ## ......................................................................
4472 ## functions printing or outputting HTML: div
4474 sub git_print_header_div {
4475 my ($action, $title, $hash, $hash_base) = @_;
4476 my %args = ();
4478 $args{'action'} = $action;
4479 $args{'hash'} = $hash if $hash;
4480 $args{'hash_base'} = $hash_base if $hash_base;
4482 print "<div class=\"header\">\n" .
4483 $cgi->a({-href => href(%args), -class => "title"},
4484 $title ? $title : $action) .
4485 "\n</div>\n";
4488 sub format_repo_url {
4489 my ($name, $url) = @_;
4490 return "<tr class=\"metadata_url\"><td>$name</td><td>$url</td></tr>\n";
4493 # Group output by placing it in a DIV element and adding a header.
4494 # Options for start_div() can be provided by passing a hash reference as the
4495 # first parameter to the function.
4496 # Options to git_print_header_div() can be provided by passing an array
4497 # reference. This must follow the options to start_div if they are present.
4498 # The content can be a scalar, which is output as-is, a scalar reference, which
4499 # is output after html escaping, an IO handle passed either as *handle or
4500 # *handle{IO}, or a function reference. In the latter case all following
4501 # parameters will be taken as argument to the content function call.
4502 sub git_print_section {
4503 my ($div_args, $header_args, $content);
4504 my $arg = shift;
4505 if (ref($arg) eq 'HASH') {
4506 $div_args = $arg;
4507 $arg = shift;
4509 if (ref($arg) eq 'ARRAY') {
4510 $header_args = $arg;
4511 $arg = shift;
4513 $content = $arg;
4515 print $cgi->start_div($div_args);
4516 git_print_header_div(@$header_args);
4518 if (ref($content) eq 'CODE') {
4519 $content->(@_);
4520 } elsif (ref($content) eq 'SCALAR') {
4521 print esc_html($$content);
4522 } elsif (ref($content) eq 'GLOB' or ref($content) eq 'IO::Handle') {
4523 print <$content>;
4524 } elsif (!ref($content) && defined($content)) {
4525 print $content;
4528 print $cgi->end_div;
4531 sub format_timestamp_html {
4532 my $date = shift;
4533 my $strtime = $date->{'rfc2822'};
4535 my (undef, undef, $datetime_class) =
4536 gitweb_get_feature('javascript-timezone');
4537 if ($datetime_class) {
4538 $strtime = qq!<span class="$datetime_class">$strtime</span>!;
4541 my $localtime_format = '(%02d:%02d %s)';
4542 if ($date->{'hour_local'} < 6) {
4543 $localtime_format = '(<span class="atnight">%02d:%02d</span> %s)';
4545 $strtime .= ' ' .
4546 sprintf($localtime_format,
4547 $date->{'hour_local'}, $date->{'minute_local'}, $date->{'tz_local'});
4549 return $strtime;
4552 # Outputs the author name and date in long form
4553 sub git_print_authorship {
4554 my $co = shift;
4555 my %opts = @_;
4556 my $tag = $opts{-tag} || 'div';
4557 my $author = $co->{'author_name'};
4559 my %ad = parse_date($co->{'author_epoch'}, $co->{'author_tz'});
4560 print "<$tag class=\"author_date\">" .
4561 format_search_author($author, "author", esc_html($author)) .
4562 " [".format_timestamp_html(\%ad)."]".
4563 git_get_avatar($co->{'author_email'}, -pad_before => 1) .
4564 "</$tag>\n";
4567 # Outputs table rows containing the full author or committer information,
4568 # in the format expected for 'commit' view (& similar).
4569 # Parameters are a commit hash reference, followed by the list of people
4570 # to output information for. If the list is empty it defaults to both
4571 # author and committer.
4572 sub git_print_authorship_rows {
4573 my $co = shift;
4574 # too bad we can't use @people = @_ || ('author', 'committer')
4575 my @people = @_;
4576 @people = ('author', 'committer') unless @people;
4577 foreach my $who (@people) {
4578 my %wd = parse_date($co->{"${who}_epoch"}, $co->{"${who}_tz"});
4579 print "<tr><td>$who</td><td>" .
4580 format_search_author($co->{"${who}_name"}, $who,
4581 esc_html($co->{"${who}_name"})) . " " .
4582 format_search_author($co->{"${who}_email"}, $who,
4583 esc_html("<" . $co->{"${who}_email"} . ">")) .
4584 "</td><td rowspan=\"2\">" .
4585 git_get_avatar($co->{"${who}_email"}, -size => 'double') .
4586 "</td></tr>\n" .
4587 "<tr>" .
4588 "<td></td><td>" .
4589 format_timestamp_html(\%wd) .
4590 "</td>" .
4591 "</tr>\n";
4595 sub git_print_page_path {
4596 my $name = shift;
4597 my $type = shift;
4598 my $hb = shift;
4601 print "<div class=\"page_path\">";
4602 print $cgi->a({-href => href(action=>"tree", hash_base=>$hb),
4603 -title => 'tree root'}, to_utf8("[$project]"));
4604 print " / ";
4605 if (defined $name) {
4606 my @dirname = split '/', $name;
4607 my $basename = pop @dirname;
4608 my $fullname = '';
4610 foreach my $dir (@dirname) {
4611 $fullname .= ($fullname ? '/' : '') . $dir;
4612 print $cgi->a({-href => href(action=>"tree", file_name=>$fullname,
4613 hash_base=>$hb),
4614 -title => $fullname}, esc_path($dir));
4615 print " / ";
4617 if (defined $type && $type eq 'blob') {
4618 print $cgi->a({-href => href(action=>"blob_plain", file_name=>$file_name,
4619 hash_base=>$hb),
4620 -title => $name}, esc_path($basename));
4621 } elsif (defined $type && $type eq 'tree') {
4622 print $cgi->a({-href => href(action=>"tree", file_name=>$file_name,
4623 hash_base=>$hb),
4624 -title => $name}, esc_path($basename));
4625 print " / ";
4626 } else {
4627 print esc_path($basename);
4630 print "<br/></div>\n";
4633 sub git_print_log {
4634 my $log = shift;
4635 my %opts = @_;
4637 if ($opts{'-remove_title'}) {
4638 # remove title, i.e. first line of log
4639 shift @$log;
4641 # remove leading empty lines
4642 while (defined $log->[0] && $log->[0] eq "") {
4643 shift @$log;
4646 # print log
4647 my $skip_blank_line = 0;
4648 foreach my $line (@$log) {
4649 if ($line =~ m/^\s*([A-Z][-A-Za-z]*-([Bb]y|[Tt]o)|C[Cc]|(Clos|Fix)es): /) {
4650 if (! $opts{'-remove_signoff'}) {
4651 print "<span class=\"signoff\">" . esc_html($line) . "</span><br/>\n";
4652 $skip_blank_line = 1;
4654 next;
4657 if ($line =~ m,\s*([a-z]*link): (https?://\S+),i) {
4658 if (! $opts{'-remove_signoff'}) {
4659 print "<span class=\"signoff\">" . esc_html($1) . ": " .
4660 "<a href=\"" . esc_html($2) . "\">" . esc_html($2) . "</a>" .
4661 "</span><br/>\n";
4662 $skip_blank_line = 1;
4664 next;
4667 # print only one empty line
4668 # do not print empty line after signoff
4669 if ($line eq "") {
4670 next if ($skip_blank_line);
4671 $skip_blank_line = 1;
4672 } else {
4673 $skip_blank_line = 0;
4676 print format_log_line_html($line) . "<br/>\n";
4679 if ($opts{'-final_empty_line'}) {
4680 # end with single empty line
4681 print "<br/>\n" unless $skip_blank_line;
4685 # return link target (what link points to)
4686 sub git_get_link_target {
4687 my $hash = shift;
4688 my $link_target;
4690 # read link
4691 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
4692 or return;
4694 local $/ = undef;
4695 $link_target = <$fd>;
4697 close $fd
4698 or return;
4700 return $link_target;
4703 # given link target, and the directory (basedir) the link is in,
4704 # return target of link relative to top directory (top tree);
4705 # return undef if it is not possible (including absolute links).
4706 sub normalize_link_target {
4707 my ($link_target, $basedir) = @_;
4709 # absolute symlinks (beginning with '/') cannot be normalized
4710 return if (substr($link_target, 0, 1) eq '/');
4712 # normalize link target to path from top (root) tree (dir)
4713 my $path;
4714 if ($basedir) {
4715 $path = $basedir . '/' . $link_target;
4716 } else {
4717 # we are in top (root) tree (dir)
4718 $path = $link_target;
4721 # remove //, /./, and /../
4722 my @path_parts;
4723 foreach my $part (split('/', $path)) {
4724 # discard '.' and ''
4725 next if (!$part || $part eq '.');
4726 # handle '..'
4727 if ($part eq '..') {
4728 if (@path_parts) {
4729 pop @path_parts;
4730 } else {
4731 # link leads outside repository (outside top dir)
4732 return;
4734 } else {
4735 push @path_parts, $part;
4738 $path = join('/', @path_parts);
4740 return $path;
4743 # print tree entry (row of git_tree), but without encompassing <tr> element
4744 sub git_print_tree_entry {
4745 my ($t, $basedir, $hash_base, $have_blame) = @_;
4747 my %base_key = ();
4748 $base_key{'hash_base'} = $hash_base if defined $hash_base;
4750 # The format of a table row is: mode list link. Where mode is
4751 # the mode of the entry, list is the name of the entry, an href,
4752 # and link is the action links of the entry.
4754 print "<td class=\"mode\">" . mode_str($t->{'mode'}) . "</td>\n";
4755 if (exists $t->{'size'}) {
4756 print "<td class=\"size\">$t->{'size'}</td>\n";
4758 if ($t->{'type'} eq "blob") {
4759 print "<td class=\"list\">" .
4760 $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4761 file_name=>"$basedir$t->{'name'}", %base_key),
4762 -class => "list"}, esc_path($t->{'name'}));
4763 if (S_ISLNK(oct $t->{'mode'})) {
4764 my $link_target = git_get_link_target($t->{'hash'});
4765 if ($link_target) {
4766 my $norm_target = normalize_link_target($link_target, $basedir);
4767 if (defined $norm_target) {
4768 print " -> " .
4769 $cgi->a({-href => href(action=>"object", hash_base=>$hash_base,
4770 file_name=>$norm_target),
4771 -title => $norm_target}, esc_path($link_target));
4772 } else {
4773 print " -> " . esc_path($link_target);
4777 print "</td>\n";
4778 print "<td class=\"link\">";
4779 print $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4780 file_name=>"$basedir$t->{'name'}", %base_key)},
4781 "blob");
4782 if ($have_blame) {
4783 print " | " .
4784 $cgi->a({-href => href(action=>"blame", hash=>$t->{'hash'},
4785 file_name=>"$basedir$t->{'name'}", %base_key)},
4786 "blame");
4788 if (defined $hash_base) {
4789 print " | " .
4790 $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4791 hash=>$t->{'hash'}, file_name=>"$basedir$t->{'name'}")},
4792 "history");
4794 print " | " .
4795 $cgi->a({-href => href(action=>"blob_plain", hash_base=>$hash_base,
4796 file_name=>"$basedir$t->{'name'}")},
4797 "raw");
4798 print "</td>\n";
4800 } elsif ($t->{'type'} eq "tree") {
4801 print "<td class=\"list\">";
4802 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4803 file_name=>"$basedir$t->{'name'}",
4804 %base_key)},
4805 esc_path($t->{'name'}));
4806 print "</td>\n";
4807 print "<td class=\"link\">";
4808 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4809 file_name=>"$basedir$t->{'name'}",
4810 %base_key)},
4811 "tree");
4812 if (defined $hash_base) {
4813 print " | " .
4814 $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4815 file_name=>"$basedir$t->{'name'}")},
4816 "history");
4818 print "</td>\n";
4819 } else {
4820 # unknown object: we can only present history for it
4821 # (this includes 'commit' object, i.e. submodule support)
4822 print "<td class=\"list\">" .
4823 esc_path($t->{'name'}) .
4824 "</td>\n";
4825 print "<td class=\"link\">";
4826 if (defined $hash_base) {
4827 print $cgi->a({-href => href(action=>"history",
4828 hash_base=>$hash_base,
4829 file_name=>"$basedir$t->{'name'}")},
4830 "history");
4832 print "</td>\n";
4836 ## ......................................................................
4837 ## functions printing large fragments of HTML
4839 # get pre-image filenames for merge (combined) diff
4840 sub fill_from_file_info {
4841 my ($diff, @parents) = @_;
4843 $diff->{'from_file'} = [ ];
4844 $diff->{'from_file'}[$diff->{'nparents'} - 1] = undef;
4845 for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4846 if ($diff->{'status'}[$i] eq 'R' ||
4847 $diff->{'status'}[$i] eq 'C') {
4848 $diff->{'from_file'}[$i] =
4849 git_get_path_by_hash($parents[$i], $diff->{'from_id'}[$i]);
4853 return $diff;
4856 # is current raw difftree line of file deletion
4857 sub is_deleted {
4858 my $diffinfo = shift;
4860 return $diffinfo->{'to_id'} eq ('0' x 40) || $diffinfo->{'to_id'} eq ('0' x 64);
4863 # does patch correspond to [previous] difftree raw line
4864 # $diffinfo - hashref of parsed raw diff format
4865 # $patchinfo - hashref of parsed patch diff format
4866 # (the same keys as in $diffinfo)
4867 sub is_patch_split {
4868 my ($diffinfo, $patchinfo) = @_;
4870 return defined $diffinfo && defined $patchinfo
4871 && $diffinfo->{'to_file'} eq $patchinfo->{'to_file'};
4875 sub git_difftree_body {
4876 my ($difftree, $hash, @parents) = @_;
4877 my ($parent) = $parents[0];
4878 my $have_blame = gitweb_check_feature('blame');
4879 print "<div class=\"list_head\">\n";
4880 if ($#{$difftree} > 10) {
4881 print(($#{$difftree} + 1) . " files changed:\n");
4883 print "</div>\n";
4885 print "<table class=\"" .
4886 (@parents > 1 ? "combined " : "") .
4887 "diff_tree\">\n";
4889 # header only for combined diff in 'commitdiff' view
4890 my $has_header = @$difftree && @parents > 1 && $action eq 'commitdiff';
4891 if ($has_header) {
4892 # table header
4893 print "<thead><tr>\n" .
4894 "<th></th><th></th>\n"; # filename, patchN link
4895 for (my $i = 0; $i < @parents; $i++) {
4896 my $par = $parents[$i];
4897 print "<th>" .
4898 $cgi->a({-href => href(action=>"commitdiff",
4899 hash=>$hash, hash_parent=>$par),
4900 -title => 'commitdiff to parent number ' .
4901 ($i+1) . ': ' . substr($par,0,7)},
4902 $i+1) .
4903 "&nbsp;</th>\n";
4905 print "</tr></thead>\n<tbody>\n";
4908 my $alternate = 1;
4909 my $patchno = 0;
4910 foreach my $line (@{$difftree}) {
4911 my $diff = parsed_difftree_line($line);
4913 if ($alternate) {
4914 print "<tr class=\"dark\">\n";
4915 } else {
4916 print "<tr class=\"light\">\n";
4918 $alternate ^= 1;
4920 if (exists $diff->{'nparents'}) { # combined diff
4922 fill_from_file_info($diff, @parents)
4923 unless exists $diff->{'from_file'};
4925 if (!is_deleted($diff)) {
4926 # file exists in the result (child) commit
4927 print "<td>" .
4928 $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4929 file_name=>$diff->{'to_file'},
4930 hash_base=>$hash),
4931 -class => "list"}, esc_path($diff->{'to_file'})) .
4932 "</td>\n";
4933 } else {
4934 print "<td>" .
4935 esc_path($diff->{'to_file'}) .
4936 "</td>\n";
4939 if ($action eq 'commitdiff') {
4940 # link to patch
4941 $patchno++;
4942 print "<td class=\"link\">" .
4943 $cgi->a({-href => href(-anchor=>"patch$patchno")},
4944 "patch") .
4945 " | " .
4946 "</td>\n";
4949 my $has_history = 0;
4950 my $not_deleted = 0;
4951 for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4952 my $hash_parent = $parents[$i];
4953 my $from_hash = $diff->{'from_id'}[$i];
4954 my $from_path = $diff->{'from_file'}[$i];
4955 my $status = $diff->{'status'}[$i];
4957 $has_history ||= ($status ne 'A');
4958 $not_deleted ||= ($status ne 'D');
4960 if ($status eq 'A') {
4961 print "<td class=\"link\" align=\"right\"> | </td>\n";
4962 } elsif ($status eq 'D') {
4963 print "<td class=\"link\">" .
4964 $cgi->a({-href => href(action=>"blob",
4965 hash_base=>$hash,
4966 hash=>$from_hash,
4967 file_name=>$from_path)},
4968 "blob" . ($i+1)) .
4969 " | </td>\n";
4970 } else {
4971 if ($diff->{'to_id'} eq $from_hash) {
4972 print "<td class=\"link nochange\">";
4973 } else {
4974 print "<td class=\"link\">";
4976 print $cgi->a({-href => href(action=>"blobdiff",
4977 hash=>$diff->{'to_id'},
4978 hash_parent=>$from_hash,
4979 hash_base=>$hash,
4980 hash_parent_base=>$hash_parent,
4981 file_name=>$diff->{'to_file'},
4982 file_parent=>$from_path)},
4983 "diff" . ($i+1)) .
4984 " | </td>\n";
4988 print "<td class=\"link\">";
4989 if ($not_deleted) {
4990 print $cgi->a({-href => href(action=>"blob",
4991 hash=>$diff->{'to_id'},
4992 file_name=>$diff->{'to_file'},
4993 hash_base=>$hash)},
4994 "blob");
4995 print " | " if ($has_history);
4997 if ($has_history) {
4998 print $cgi->a({-href => href(action=>"history",
4999 file_name=>$diff->{'to_file'},
5000 hash_base=>$hash)},
5001 "history");
5003 print "</td>\n";
5005 print "</tr>\n";
5006 next; # instead of 'else' clause, to avoid extra indent
5008 # else ordinary diff
5010 my ($to_mode_oct, $to_mode_str, $to_file_type);
5011 my ($from_mode_oct, $from_mode_str, $from_file_type);
5012 if ($diff->{'to_mode'} ne ('0' x 6)) {
5013 $to_mode_oct = oct $diff->{'to_mode'};
5014 if (S_ISREG($to_mode_oct)) { # only for regular file
5015 $to_mode_str = sprintf("%04o", $to_mode_oct & 0777); # permission bits
5017 $to_file_type = file_type($diff->{'to_mode'});
5019 if ($diff->{'from_mode'} ne ('0' x 6)) {
5020 $from_mode_oct = oct $diff->{'from_mode'};
5021 if (S_ISREG($from_mode_oct)) { # only for regular file
5022 $from_mode_str = sprintf("%04o", $from_mode_oct & 0777); # permission bits
5024 $from_file_type = file_type($diff->{'from_mode'});
5027 if ($diff->{'status'} eq "A") { # created
5028 my $mode_chng = "<span class=\"file_status new\">[new $to_file_type";
5029 $mode_chng .= " with mode: $to_mode_str" if $to_mode_str;
5030 $mode_chng .= "]</span>";
5031 print "<td>";
5032 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5033 hash_base=>$hash, file_name=>$diff->{'file'}),
5034 -class => "list"}, esc_path($diff->{'file'}));
5035 print "</td>\n";
5036 print "<td>$mode_chng</td>\n";
5037 print "<td class=\"link\">";
5038 if ($action eq 'commitdiff') {
5039 # link to patch
5040 $patchno++;
5041 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5042 "patch") .
5043 " | ";
5045 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5046 hash_base=>$hash, file_name=>$diff->{'file'})},
5047 "blob");
5048 print "</td>\n";
5050 } elsif ($diff->{'status'} eq "D") { # deleted
5051 my $mode_chng = "<span class=\"file_status deleted\">[deleted $from_file_type]</span>";
5052 print "<td>";
5053 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
5054 hash_base=>$parent, file_name=>$diff->{'file'}),
5055 -class => "list"}, esc_path($diff->{'file'}));
5056 print "</td>\n";
5057 print "<td>$mode_chng</td>\n";
5058 print "<td class=\"link\">";
5059 if ($action eq 'commitdiff') {
5060 # link to patch
5061 $patchno++;
5062 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5063 "patch") .
5064 " | ";
5066 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
5067 hash_base=>$parent, file_name=>$diff->{'file'})},
5068 "blob") . " | ";
5069 if ($have_blame) {
5070 print $cgi->a({-href => href(action=>"blame", hash_base=>$parent,
5071 file_name=>$diff->{'file'})},
5072 "blame") . " | ";
5074 print $cgi->a({-href => href(action=>"history", hash_base=>$parent,
5075 file_name=>$diff->{'file'})},
5076 "history");
5077 print "</td>\n";
5079 } elsif ($diff->{'status'} eq "M" || $diff->{'status'} eq "T") { # modified, or type changed
5080 my $mode_chnge = "";
5081 if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
5082 $mode_chnge = "<span class=\"file_status mode_chnge\">[changed";
5083 if ($from_file_type ne $to_file_type) {
5084 $mode_chnge .= " from $from_file_type to $to_file_type";
5086 if (($from_mode_oct & 0777) != ($to_mode_oct & 0777)) {
5087 if ($from_mode_str && $to_mode_str) {
5088 $mode_chnge .= " mode: $from_mode_str->$to_mode_str";
5089 } elsif ($to_mode_str) {
5090 $mode_chnge .= " mode: $to_mode_str";
5093 $mode_chnge .= "]</span>\n";
5095 print "<td>";
5096 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5097 hash_base=>$hash, file_name=>$diff->{'file'}),
5098 -class => "list"}, esc_path($diff->{'file'}));
5099 print "</td>\n";
5100 print "<td>$mode_chnge</td>\n";
5101 print "<td class=\"link\">";
5102 if ($action eq 'commitdiff') {
5103 # link to patch
5104 $patchno++;
5105 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5106 "patch") .
5107 " | ";
5108 } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
5109 # "commit" view and modified file (not onlu mode changed)
5110 print $cgi->a({-href => href(action=>"blobdiff",
5111 hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
5112 hash_base=>$hash, hash_parent_base=>$parent,
5113 file_name=>$diff->{'file'})},
5114 "diff") .
5115 " | ";
5117 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5118 hash_base=>$hash, file_name=>$diff->{'file'})},
5119 "blob") . " | ";
5120 if ($have_blame) {
5121 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
5122 file_name=>$diff->{'file'})},
5123 "blame") . " | ";
5125 print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
5126 file_name=>$diff->{'file'})},
5127 "history");
5128 print "</td>\n";
5130 } elsif ($diff->{'status'} eq "R" || $diff->{'status'} eq "C") { # renamed or copied
5131 my %status_name = ('R' => 'moved', 'C' => 'copied');
5132 my $nstatus = $status_name{$diff->{'status'}};
5133 my $mode_chng = "";
5134 if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
5135 # mode also for directories, so we cannot use $to_mode_str
5136 $mode_chng = sprintf(", mode: %04o", $to_mode_oct & 0777);
5138 print "<td>" .
5139 $cgi->a({-href => href(action=>"blob", hash_base=>$hash,
5140 hash=>$diff->{'to_id'}, file_name=>$diff->{'to_file'}),
5141 -class => "list"}, esc_path($diff->{'to_file'})) . "</td>\n" .
5142 "<td><span class=\"file_status $nstatus\">[$nstatus from " .
5143 $cgi->a({-href => href(action=>"blob", hash_base=>$parent,
5144 hash=>$diff->{'from_id'}, file_name=>$diff->{'from_file'}),
5145 -class => "list"}, esc_path($diff->{'from_file'})) .
5146 " with " . (int $diff->{'similarity'}) . "% similarity$mode_chng]</span></td>\n" .
5147 "<td class=\"link\">";
5148 if ($action eq 'commitdiff') {
5149 # link to patch
5150 $patchno++;
5151 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
5152 "patch") .
5153 " | ";
5154 } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
5155 # "commit" view and modified file (not only pure rename or copy)
5156 print $cgi->a({-href => href(action=>"blobdiff",
5157 hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
5158 hash_base=>$hash, hash_parent_base=>$parent,
5159 file_name=>$diff->{'to_file'}, file_parent=>$diff->{'from_file'})},
5160 "diff") .
5161 " | ";
5163 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
5164 hash_base=>$parent, file_name=>$diff->{'to_file'})},
5165 "blob") . " | ";
5166 if ($have_blame) {
5167 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
5168 file_name=>$diff->{'to_file'})},
5169 "blame") . " | ";
5171 print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
5172 file_name=>$diff->{'to_file'})},
5173 "history");
5174 print "</td>\n";
5176 } # we should not encounter Unmerged (U) or Unknown (X) status
5177 print "</tr>\n";
5179 print "</tbody>" if $has_header;
5180 print "</table>\n";
5183 # Print context lines and then rem/add lines in a side-by-side manner.
5184 sub print_sidebyside_diff_lines {
5185 my ($ctx, $rem, $add) = @_;
5187 # print context block before add/rem block
5188 if (@$ctx) {
5189 print join '',
5190 '<div class="chunk_block ctx">',
5191 '<div class="old">',
5192 @$ctx,
5193 '</div>',
5194 '<div class="new">',
5195 @$ctx,
5196 '</div>',
5197 '</div>';
5200 if (!@$add) {
5201 # pure removal
5202 print join '',
5203 '<div class="chunk_block rem">',
5204 '<div class="old">',
5205 @$rem,
5206 '</div>',
5207 '</div>';
5208 } elsif (!@$rem) {
5209 # pure addition
5210 print join '',
5211 '<div class="chunk_block add">',
5212 '<div class="new">',
5213 @$add,
5214 '</div>',
5215 '</div>';
5216 } else {
5217 print join '',
5218 '<div class="chunk_block chg">',
5219 '<div class="old">',
5220 @$rem,
5221 '</div>',
5222 '<div class="new">',
5223 @$add,
5224 '</div>',
5225 '</div>';
5229 # Print context lines and then rem/add lines in inline manner.
5230 sub print_inline_diff_lines {
5231 my ($ctx, $rem, $add) = @_;
5233 print @$ctx, @$rem, @$add;
5236 # Format removed and added line, mark changed part and HTML-format them.
5237 # Implementation is based on contrib/diff-highlight
5238 sub format_rem_add_lines_pair {
5239 my ($rem, $add, $num_parents) = @_;
5241 # We need to untabify lines before split()'ing them;
5242 # otherwise offsets would be invalid.
5243 chomp $rem;
5244 chomp $add;
5245 $rem = untabify($rem);
5246 $add = untabify($add);
5248 my @rem = split(//, $rem);
5249 my @add = split(//, $add);
5250 my ($esc_rem, $esc_add);
5251 # Ignore leading +/- characters for each parent.
5252 my ($prefix_len, $suffix_len) = ($num_parents, 0);
5253 my ($prefix_has_nonspace, $suffix_has_nonspace);
5255 my $shorter = (@rem < @add) ? @rem : @add;
5256 while ($prefix_len < $shorter) {
5257 last if ($rem[$prefix_len] ne $add[$prefix_len]);
5259 $prefix_has_nonspace = 1 if ($rem[$prefix_len] !~ /\s/);
5260 $prefix_len++;
5263 while ($prefix_len + $suffix_len < $shorter) {
5264 last if ($rem[-1 - $suffix_len] ne $add[-1 - $suffix_len]);
5266 $suffix_has_nonspace = 1 if ($rem[-1 - $suffix_len] !~ /\s/);
5267 $suffix_len++;
5270 # Mark lines that are different from each other, but have some common
5271 # part that isn't whitespace. If lines are completely different, don't
5272 # mark them because that would make output unreadable, especially if
5273 # diff consists of multiple lines.
5274 if ($prefix_has_nonspace || $suffix_has_nonspace) {
5275 $esc_rem = esc_html_hl_regions($rem, 'marked',
5276 [$prefix_len, @rem - $suffix_len], -nbsp=>1);
5277 $esc_add = esc_html_hl_regions($add, 'marked',
5278 [$prefix_len, @add - $suffix_len], -nbsp=>1);
5279 } else {
5280 $esc_rem = esc_html($rem, -nbsp=>1);
5281 $esc_add = esc_html($add, -nbsp=>1);
5284 return format_diff_line(\$esc_rem, 'rem'),
5285 format_diff_line(\$esc_add, 'add');
5288 # HTML-format diff context, removed and added lines.
5289 sub format_ctx_rem_add_lines {
5290 my ($ctx, $rem, $add, $num_parents) = @_;
5291 my (@new_ctx, @new_rem, @new_add);
5292 my $can_highlight = 0;
5293 my $is_combined = ($num_parents > 1);
5295 # Highlight if every removed line has a corresponding added line.
5296 if (@$add > 0 && @$add == @$rem) {
5297 $can_highlight = 1;
5299 # Highlight lines in combined diff only if the chunk contains
5300 # diff between the same version, e.g.
5302 # - a
5303 # - b
5304 # + c
5305 # + d
5307 # Otherwise the highlighting would be confusing.
5308 if ($is_combined) {
5309 for (my $i = 0; $i < @$add; $i++) {
5310 my $prefix_rem = substr($rem->[$i], 0, $num_parents);
5311 my $prefix_add = substr($add->[$i], 0, $num_parents);
5313 $prefix_rem =~ s/-/+/g;
5315 if ($prefix_rem ne $prefix_add) {
5316 $can_highlight = 0;
5317 last;
5323 if ($can_highlight) {
5324 for (my $i = 0; $i < @$add; $i++) {
5325 my ($line_rem, $line_add) = format_rem_add_lines_pair(
5326 $rem->[$i], $add->[$i], $num_parents);
5327 push @new_rem, $line_rem;
5328 push @new_add, $line_add;
5330 } else {
5331 @new_rem = map { format_diff_line($_, 'rem') } @$rem;
5332 @new_add = map { format_diff_line($_, 'add') } @$add;
5335 @new_ctx = map { format_diff_line($_, 'ctx') } @$ctx;
5337 return (\@new_ctx, \@new_rem, \@new_add);
5340 # Print context lines and then rem/add lines.
5341 sub print_diff_lines {
5342 my ($ctx, $rem, $add, $diff_style, $num_parents) = @_;
5343 my $is_combined = $num_parents > 1;
5345 ($ctx, $rem, $add) = format_ctx_rem_add_lines($ctx, $rem, $add,
5346 $num_parents);
5348 if ($diff_style eq 'sidebyside' && !$is_combined) {
5349 print_sidebyside_diff_lines($ctx, $rem, $add);
5350 } else {
5351 # default 'inline' style and unknown styles
5352 print_inline_diff_lines($ctx, $rem, $add);
5356 sub print_diff_chunk {
5357 my ($diff_style, $num_parents, $from, $to, @chunk) = @_;
5358 my (@ctx, @rem, @add);
5360 # The class of the previous line.
5361 my $prev_class = '';
5363 return unless @chunk;
5365 # incomplete last line might be among removed or added lines,
5366 # or both, or among context lines: find which
5367 for (my $i = 1; $i < @chunk; $i++) {
5368 if ($chunk[$i][0] eq 'incomplete') {
5369 $chunk[$i][0] = $chunk[$i-1][0];
5373 # guardian
5374 push @chunk, ["", ""];
5376 foreach my $line_info (@chunk) {
5377 my ($class, $line) = @$line_info;
5379 # print chunk headers
5380 if ($class && $class eq 'chunk_header') {
5381 print format_diff_line($line, $class, $from, $to);
5382 next;
5385 ## print from accumulator when have some add/rem lines or end
5386 # of chunk (flush context lines), or when have add and rem
5387 # lines and new block is reached (otherwise add/rem lines could
5388 # be reordered)
5389 if (!$class || ((@rem || @add) && $class eq 'ctx') ||
5390 (@rem && @add && $class ne $prev_class)) {
5391 print_diff_lines(\@ctx, \@rem, \@add,
5392 $diff_style, $num_parents);
5393 @ctx = @rem = @add = ();
5396 ## adding lines to accumulator
5397 # guardian value
5398 last unless $line;
5399 # rem, add or change
5400 if ($class eq 'rem') {
5401 push @rem, $line;
5402 } elsif ($class eq 'add') {
5403 push @add, $line;
5405 # context line
5406 if ($class eq 'ctx') {
5407 push @ctx, $line;
5410 $prev_class = $class;
5414 sub git_patchset_body {
5415 my ($fd, $diff_style, $difftree, $hash, @hash_parents) = @_;
5416 my ($hash_parent) = $hash_parents[0];
5418 my $is_combined = (@hash_parents > 1);
5419 my $patch_idx = 0;
5420 my $patch_number = 0;
5421 my $patch_line;
5422 my $diffinfo;
5423 my $to_name;
5424 my (%from, %to);
5425 my @chunk; # for side-by-side diff
5427 print "<div class=\"patchset\">\n";
5429 # skip to first patch
5430 while ($patch_line = <$fd>) {
5431 chomp $patch_line;
5433 last if ($patch_line =~ m/^diff /);
5436 PATCH:
5437 while ($patch_line) {
5439 # parse "git diff" header line
5440 if ($patch_line =~ m/^diff --git (\"(?:[^\\\"]*(?:\\.[^\\\"]*)*)\"|[^ "]*) (.*)$/) {
5441 # $1 is from_name, which we do not use
5442 $to_name = unquote($2);
5443 $to_name =~ s!^b/!!;
5444 } elsif ($patch_line =~ m/^diff --(cc|combined) ("?.*"?)$/) {
5445 # $1 is 'cc' or 'combined', which we do not use
5446 $to_name = unquote($2);
5447 } else {
5448 $to_name = undef;
5451 # check if current patch belong to current raw line
5452 # and parse raw git-diff line if needed
5453 if (is_patch_split($diffinfo, { 'to_file' => $to_name })) {
5454 # this is continuation of a split patch
5455 print "<div class=\"patch cont\">\n";
5456 } else {
5457 # advance raw git-diff output if needed
5458 $patch_idx++ if defined $diffinfo;
5460 # read and prepare patch information
5461 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5463 # compact combined diff output can have some patches skipped
5464 # find which patch (using pathname of result) we are at now;
5465 if ($is_combined) {
5466 while ($to_name ne $diffinfo->{'to_file'}) {
5467 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5468 format_diff_cc_simplified($diffinfo, @hash_parents) .
5469 "</div>\n"; # class="patch"
5471 $patch_idx++;
5472 $patch_number++;
5474 last if $patch_idx > $#$difftree;
5475 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5479 # modifies %from, %to hashes
5480 parse_from_to_diffinfo($diffinfo, \%from, \%to, @hash_parents);
5482 # this is first patch for raw difftree line with $patch_idx index
5483 # we index @$difftree array from 0, but number patches from 1
5484 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n";
5487 # git diff header
5488 #assert($patch_line =~ m/^diff /) if DEBUG;
5489 #assert($patch_line !~ m!$/$!) if DEBUG; # is chomp-ed
5490 $patch_number++;
5491 # print "git diff" header
5492 print format_git_diff_header_line($patch_line, $diffinfo,
5493 \%from, \%to);
5495 # print extended diff header
5496 print "<div class=\"diff extended_header\">\n";
5497 EXTENDED_HEADER:
5498 while ($patch_line = <$fd>) {
5499 chomp $patch_line;
5501 last EXTENDED_HEADER if ($patch_line =~ m/^--- |^diff /);
5503 print format_extended_diff_header_line($patch_line, $diffinfo,
5504 \%from, \%to);
5506 print "</div>\n"; # class="diff extended_header"
5508 # from-file/to-file diff header
5509 if (! $patch_line) {
5510 print "</div>\n"; # class="patch"
5511 last PATCH;
5513 next PATCH if ($patch_line =~ m/^diff /);
5514 #assert($patch_line =~ m/^---/) if DEBUG;
5516 my $last_patch_line = $patch_line;
5517 $patch_line = <$fd>;
5518 chomp $patch_line;
5519 #assert($patch_line =~ m/^\+\+\+/) if DEBUG;
5521 print format_diff_from_to_header($last_patch_line, $patch_line,
5522 $diffinfo, \%from, \%to,
5523 @hash_parents);
5525 # the patch itself
5526 LINE:
5527 while ($patch_line = <$fd>) {
5528 chomp $patch_line;
5530 next PATCH if ($patch_line =~ m/^diff /);
5532 my $class = diff_line_class($patch_line, \%from, \%to);
5534 if ($class eq 'chunk_header') {
5535 print_diff_chunk($diff_style, scalar @hash_parents, \%from, \%to, @chunk);
5536 @chunk = ();
5539 push @chunk, [ $class, $patch_line ];
5542 } continue {
5543 if (@chunk) {
5544 print_diff_chunk($diff_style, scalar @hash_parents, \%from, \%to, @chunk);
5545 @chunk = ();
5547 print "</div>\n"; # class="patch"
5550 # for compact combined (--cc) format, with chunk and patch simplification
5551 # the patchset might be empty, but there might be unprocessed raw lines
5552 for (++$patch_idx if $patch_number > 0;
5553 $patch_idx < @$difftree;
5554 ++$patch_idx) {
5555 # read and prepare patch information
5556 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5558 # generate anchor for "patch" links in difftree / whatchanged part
5559 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5560 format_diff_cc_simplified($diffinfo, @hash_parents) .
5561 "</div>\n"; # class="patch"
5563 $patch_number++;
5566 if ($patch_number == 0) {
5567 if (@hash_parents > 1) {
5568 print "<div class=\"diff nodifferences\">Trivial merge</div>\n";
5569 } else {
5570 print "<div class=\"diff nodifferences\">No differences found</div>\n";
5574 print "</div>\n"; # class="patchset"
5577 # . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5579 sub git_project_search_form {
5580 my ($searchtext, $search_use_regexp) = @_;
5582 my $limit = '';
5583 if ($project_filter) {
5584 $limit = " in '$project_filter/'";
5587 print "<div class=\"projsearch\">\n";
5588 print $cgi->start_form(-method => 'get', -action => $my_uri) .
5589 $cgi->hidden(-name => 'a', -value => 'project_list') . "\n";
5590 print $cgi->hidden(-name => 'pf', -value => $project_filter). "\n"
5591 if (defined $project_filter);
5592 print $cgi->textfield(-name => 's', -value => $searchtext,
5593 -title => "Search project by name and description$limit",
5594 -size => 60) . "\n" .
5595 "<span title=\"Extended regular expression\">" .
5596 $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
5597 -checked => $search_use_regexp) .
5598 "</span>\n" .
5599 $cgi->submit(-name => 'btnS', -value => 'Search') .
5600 $cgi->end_form() . "\n" .
5601 $cgi->a({-href => href(project => undef, searchtext => undef,
5602 project_filter => $project_filter)},
5603 esc_html("List all projects$limit")) . "<br />\n";
5604 print "</div>\n";
5607 # entry for given @keys needs filling if at least one of keys in list
5608 # is not present in %$project_info
5609 sub project_info_needs_filling {
5610 my ($project_info, @keys) = @_;
5612 # return List::MoreUtils::any { !exists $project_info->{$_} } @keys;
5613 foreach my $key (@keys) {
5614 if (!exists $project_info->{$key}) {
5615 return 1;
5618 return;
5621 # fills project list info (age, description, owner, category, forks, etc.)
5622 # for each project in the list, removing invalid projects from
5623 # returned list, or fill only specified info.
5625 # Invalid projects are removed from the returned list if and only if you
5626 # ask 'age' or 'age_string' to be filled, because they are the only fields
5627 # that run unconditionally git command that requires repository, and
5628 # therefore do always check if project repository is invalid.
5630 # USAGE:
5631 # * fill_project_list_info(\@project_list, 'descr_long', 'ctags')
5632 # ensures that 'descr_long' and 'ctags' fields are filled
5633 # * @project_list = fill_project_list_info(\@project_list)
5634 # ensures that all fields are filled (and invalid projects removed)
5636 # NOTE: modifies $projlist, but does not remove entries from it
5637 sub fill_project_list_info {
5638 my ($projlist, @wanted_keys) = @_;
5639 my @projects;
5640 my $filter_set = sub { return @_; };
5641 if (@wanted_keys) {
5642 my %wanted_keys = map { $_ => 1 } @wanted_keys;
5643 $filter_set = sub { return grep { $wanted_keys{$_} } @_; };
5646 my $show_ctags = gitweb_check_feature('ctags');
5647 PROJECT:
5648 foreach my $pr (@$projlist) {
5649 if (project_info_needs_filling($pr, $filter_set->('age', 'age_string'))) {
5650 my (@activity) = git_get_last_activity($pr->{'path'});
5651 unless (@activity) {
5652 next PROJECT;
5654 ($pr->{'age'}, $pr->{'age_string'}) = @activity;
5656 if (project_info_needs_filling($pr, $filter_set->('descr', 'descr_long'))) {
5657 my $descr = git_get_project_description($pr->{'path'}) || "";
5658 $descr = to_utf8($descr);
5659 $pr->{'descr_long'} = $descr;
5660 $pr->{'descr'} = chop_str($descr, $projects_list_description_width, 5);
5662 if (project_info_needs_filling($pr, $filter_set->('owner'))) {
5663 $pr->{'owner'} = git_get_project_owner("$pr->{'path'}") || "";
5665 if ($show_ctags &&
5666 project_info_needs_filling($pr, $filter_set->('ctags'))) {
5667 $pr->{'ctags'} = git_get_project_ctags($pr->{'path'});
5669 if ($projects_list_group_categories &&
5670 project_info_needs_filling($pr, $filter_set->('category'))) {
5671 my $cat = git_get_project_category($pr->{'path'}) ||
5672 $project_list_default_category;
5673 $pr->{'category'} = to_utf8($cat);
5676 push @projects, $pr;
5679 return @projects;
5682 sub sort_projects_list {
5683 my ($projlist, $order) = @_;
5685 sub order_str {
5686 my $key = shift;
5687 return sub { $a->{$key} cmp $b->{$key} };
5690 sub order_num_then_undef {
5691 my $key = shift;
5692 return sub {
5693 defined $a->{$key} ?
5694 (defined $b->{$key} ? $a->{$key} <=> $b->{$key} : -1) :
5695 (defined $b->{$key} ? 1 : 0)
5699 my %orderings = (
5700 project => order_str('path'),
5701 descr => order_str('descr_long'),
5702 owner => order_str('owner'),
5703 age => order_num_then_undef('age'),
5706 my $ordering = $orderings{$order};
5707 return defined $ordering ? sort $ordering @$projlist : @$projlist;
5710 # returns a hash of categories, containing the list of project
5711 # belonging to each category
5712 sub build_projlist_by_category {
5713 my ($projlist, $from, $to) = @_;
5714 my %categories;
5716 $from = 0 unless defined $from;
5717 $to = $#$projlist if (!defined $to || $#$projlist < $to);
5719 for (my $i = $from; $i <= $to; $i++) {
5720 my $pr = $projlist->[$i];
5721 push @{$categories{ $pr->{'category'} }}, $pr;
5724 return wantarray ? %categories : \%categories;
5727 # print 'sort by' <th> element, generating 'sort by $name' replay link
5728 # if that order is not selected
5729 sub print_sort_th {
5730 print format_sort_th(@_);
5733 sub format_sort_th {
5734 my ($name, $order, $header) = @_;
5735 my $sort_th = "";
5736 $header ||= ucfirst($name);
5738 if ($order eq $name) {
5739 $sort_th .= "<th>$header</th>\n";
5740 } else {
5741 $sort_th .= "<th>" .
5742 $cgi->a({-href => href(-replay=>1, order=>$name),
5743 -class => "header"}, $header) .
5744 "</th>\n";
5747 return $sort_th;
5750 sub git_project_list_rows {
5751 my ($projlist, $from, $to, $check_forks) = @_;
5753 $from = 0 unless defined $from;
5754 $to = $#$projlist if (!defined $to || $#$projlist < $to);
5756 my $alternate = 1;
5757 for (my $i = $from; $i <= $to; $i++) {
5758 my $pr = $projlist->[$i];
5760 if ($alternate) {
5761 print "<tr class=\"dark\">\n";
5762 } else {
5763 print "<tr class=\"light\">\n";
5765 $alternate ^= 1;
5767 if ($check_forks) {
5768 print "<td>";
5769 if ($pr->{'forks'}) {
5770 my $nforks = scalar @{$pr->{'forks'}};
5771 if ($nforks > 0) {
5772 print $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks"),
5773 -title => "$nforks forks"}, "+");
5774 } else {
5775 print $cgi->span({-title => "$nforks forks"}, "+");
5778 print "</td>\n";
5780 print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5781 -class => "list"},
5782 esc_html_match_hl($pr->{'path'}, $search_regexp)) .
5783 "</td>\n" .
5784 "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5785 -class => "list",
5786 -title => $pr->{'descr_long'}},
5787 $search_regexp
5788 ? esc_html_match_hl_chopped($pr->{'descr_long'},
5789 $pr->{'descr'}, $search_regexp)
5790 : esc_html($pr->{'descr'})) .
5791 "</td>\n";
5792 unless ($omit_owner) {
5793 print "<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n";
5795 unless ($omit_age_column) {
5796 print "<td class=\"". age_class($pr->{'age'}) . "\">" .
5797 (defined $pr->{'age_string'} ? $pr->{'age_string'} : "No commits") . "</td>\n";
5799 print"<td class=\"link\">" .
5800 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary")}, "summary") . " | " .
5801 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"shortlog")}, "shortlog") . " | " .
5802 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"log")}, "log") . " | " .
5803 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"tree")}, "tree") .
5804 ($pr->{'forks'} ? " | " . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks")}, "forks") : '') .
5805 "</td>\n" .
5806 "</tr>\n";
5810 sub git_project_list_body {
5811 # actually uses global variable $project
5812 my ($projlist, $order, $from, $to, $extra, $no_header) = @_;
5813 my @projects = @$projlist;
5815 my $check_forks = gitweb_check_feature('forks');
5816 my $show_ctags = gitweb_check_feature('ctags');
5817 my $tagfilter = $show_ctags ? $input_params{'ctag'} : undef;
5818 $check_forks = undef
5819 if ($tagfilter || $search_regexp);
5821 # filtering out forks before filling info allows to do less work
5822 @projects = filter_forks_from_projects_list(\@projects)
5823 if ($check_forks);
5824 # search_projects_list pre-fills required info
5825 @projects = search_projects_list(\@projects,
5826 'search_regexp' => $search_regexp,
5827 'tagfilter' => $tagfilter)
5828 if ($tagfilter || $search_regexp);
5829 # fill the rest
5830 my @all_fields = ('descr', 'descr_long', 'ctags', 'category');
5831 push @all_fields, ('age', 'age_string') unless($omit_age_column);
5832 push @all_fields, 'owner' unless($omit_owner);
5833 @projects = fill_project_list_info(\@projects, @all_fields);
5835 $order ||= $default_projects_order;
5836 $from = 0 unless defined $from;
5837 $to = $#projects if (!defined $to || $#projects < $to);
5839 # short circuit
5840 if ($from > $to) {
5841 print "<center>\n".
5842 "<b>No such projects found</b><br />\n".
5843 "Click ".$cgi->a({-href=>href(project=>undef)},"here")." to view all projects<br />\n".
5844 "</center>\n<br />\n";
5845 return;
5848 @projects = sort_projects_list(\@projects, $order);
5850 if ($show_ctags) {
5851 my $ctags = git_gather_all_ctags(\@projects);
5852 my $cloud = git_populate_project_tagcloud($ctags);
5853 print git_show_project_tagcloud($cloud, 64);
5856 print "<table class=\"project_list\">\n";
5857 unless ($no_header) {
5858 print "<tr>\n";
5859 if ($check_forks) {
5860 print "<th></th>\n";
5862 print_sort_th('project', $order, 'Project');
5863 print_sort_th('descr', $order, 'Description');
5864 print_sort_th('owner', $order, 'Owner') unless $omit_owner;
5865 print_sort_th('age', $order, 'Last Change') unless $omit_age_column;
5866 print "<th></th>\n" . # for links
5867 "</tr>\n";
5870 if ($projects_list_group_categories) {
5871 # only display categories with projects in the $from-$to window
5872 @projects = sort {$a->{'category'} cmp $b->{'category'}} @projects[$from..$to];
5873 my %categories = build_projlist_by_category(\@projects, $from, $to);
5874 foreach my $cat (sort keys %categories) {
5875 unless ($cat eq "") {
5876 print "<tr>\n";
5877 if ($check_forks) {
5878 print "<td></td>\n";
5880 print "<td class=\"category\" colspan=\"5\">".esc_html($cat)."</td>\n";
5881 print "</tr>\n";
5884 git_project_list_rows($categories{$cat}, undef, undef, $check_forks);
5886 } else {
5887 git_project_list_rows(\@projects, $from, $to, $check_forks);
5890 if (defined $extra) {
5891 print "<tr>\n";
5892 if ($check_forks) {
5893 print "<td></td>\n";
5895 print "<td colspan=\"5\">$extra</td>\n" .
5896 "</tr>\n";
5898 print "</table>\n";
5901 sub git_log_body {
5902 # uses global variable $project
5903 my ($commitlist, $from, $to, $refs, $extra) = @_;
5905 $from = 0 unless defined $from;
5906 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5908 for (my $i = 0; $i <= $to; $i++) {
5909 my %co = %{$commitlist->[$i]};
5910 next if !%co;
5911 my $commit = $co{'id'};
5912 my $ref = format_ref_marker($refs, $commit);
5913 git_print_header_div('commit',
5914 "<span class=\"age\">$co{'age_string'}</span>" .
5915 esc_html($co{'title'}) . $ref,
5916 $commit);
5917 print "<div class=\"title_text\">\n" .
5918 "<div class=\"log_link\">\n" .
5919 $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") .
5920 " | " .
5921 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") .
5922 " | " .
5923 $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree") .
5924 "<br/>\n" .
5925 "</div>\n";
5926 git_print_authorship(\%co, -tag => 'span');
5927 print "<br/>\n</div>\n";
5929 print "<div class=\"log_body\">\n";
5930 git_print_log($co{'comment'}, -final_empty_line=> 1);
5931 print "</div>\n";
5933 if ($extra) {
5934 print "<div class=\"page_nav\">\n";
5935 print "$extra\n";
5936 print "</div>\n";
5940 sub git_shortlog_body {
5941 # uses global variable $project
5942 my ($commitlist, $from, $to, $refs, $extra) = @_;
5944 $from = 0 unless defined $from;
5945 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5947 print "<table class=\"shortlog\">\n";
5948 my $alternate = 1;
5949 for (my $i = $from; $i <= $to; $i++) {
5950 my %co = %{$commitlist->[$i]};
5951 my $commit = $co{'id'};
5952 my $ref = format_ref_marker($refs, $commit);
5953 if ($alternate) {
5954 print "<tr class=\"dark\">\n";
5955 } else {
5956 print "<tr class=\"light\">\n";
5958 $alternate ^= 1;
5959 # git_summary() used print "<td><i>$co{'age_string'}</i></td>\n" .
5960 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5961 format_author_html('td', \%co, 10) . "<td>";
5962 print format_subject_html($co{'title'}, $co{'title_short'},
5963 href(action=>"commit", hash=>$commit), $ref);
5964 print "</td>\n" .
5965 "<td class=\"link\">" .
5966 $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") . " | " .
5967 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") . " | " .
5968 $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree");
5969 my $snapshot_links = format_snapshot_links($commit);
5970 if (defined $snapshot_links) {
5971 print " | " . $snapshot_links;
5973 print "</td>\n" .
5974 "</tr>\n";
5976 if (defined $extra) {
5977 print "<tr>\n" .
5978 "<td colspan=\"4\">$extra</td>\n" .
5979 "</tr>\n";
5981 print "</table>\n";
5984 sub git_history_body {
5985 # Warning: assumes constant type (blob or tree) during history
5986 my ($commitlist, $from, $to, $refs, $extra,
5987 $file_name, $file_hash, $ftype) = @_;
5989 $from = 0 unless defined $from;
5990 $to = $#{$commitlist} unless (defined $to && $to <= $#{$commitlist});
5992 print "<table class=\"history\">\n";
5993 my $alternate = 1;
5994 for (my $i = $from; $i <= $to; $i++) {
5995 my %co = %{$commitlist->[$i]};
5996 if (!%co) {
5997 next;
5999 my $commit = $co{'id'};
6001 my $ref = format_ref_marker($refs, $commit);
6003 if ($alternate) {
6004 print "<tr class=\"dark\">\n";
6005 } else {
6006 print "<tr class=\"light\">\n";
6008 $alternate ^= 1;
6009 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6010 # shortlog: format_author_html('td', \%co, 10)
6011 format_author_html('td', \%co, 15, 3) . "<td>";
6012 # originally git_history used chop_str($co{'title'}, 50)
6013 print format_subject_html($co{'title'}, $co{'title_short'},
6014 href(action=>"commit", hash=>$commit), $ref);
6015 print "</td>\n" .
6016 "<td class=\"link\">" .
6017 $cgi->a({-href => href(action=>$ftype, hash_base=>$commit, file_name=>$file_name)}, $ftype) . " | " .
6018 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff");
6020 if ($ftype eq 'blob') {
6021 print " | " .
6022 $cgi->a({-href => href(action=>"blob_plain", hash_base=>$commit, file_name=>$file_name)}, "raw");
6024 my $blob_current = $file_hash;
6025 my $blob_parent = git_get_hash_by_path($commit, $file_name);
6026 if (defined $blob_current && defined $blob_parent &&
6027 $blob_current ne $blob_parent) {
6028 print " | " .
6029 $cgi->a({-href => href(action=>"blobdiff",
6030 hash=>$blob_current, hash_parent=>$blob_parent,
6031 hash_base=>$hash_base, hash_parent_base=>$commit,
6032 file_name=>$file_name)},
6033 "diff to current");
6036 print "</td>\n" .
6037 "</tr>\n";
6039 if (defined $extra) {
6040 print "<tr>\n" .
6041 "<td colspan=\"4\">$extra</td>\n" .
6042 "</tr>\n";
6044 print "</table>\n";
6047 sub git_tags_body {
6048 # uses global variable $project
6049 my ($taglist, $from, $to, $extra) = @_;
6050 $from = 0 unless defined $from;
6051 $to = $#{$taglist} if (!defined $to || $#{$taglist} < $to);
6053 print "<table class=\"tags\">\n";
6054 my $alternate = 1;
6055 for (my $i = $from; $i <= $to; $i++) {
6056 my $entry = $taglist->[$i];
6057 my %tag = %$entry;
6058 my $comment = $tag{'subject'};
6059 my $comment_short;
6060 if (defined $comment) {
6061 $comment_short = chop_str($comment, 30, 5);
6063 if ($alternate) {
6064 print "<tr class=\"dark\">\n";
6065 } else {
6066 print "<tr class=\"light\">\n";
6068 $alternate ^= 1;
6069 if (defined $tag{'age'}) {
6070 print "<td><i>$tag{'age'}</i></td>\n";
6071 } else {
6072 print "<td></td>\n";
6074 print "<td>" .
6075 $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'}),
6076 -class => "list name"}, esc_html($tag{'name'})) .
6077 "</td>\n" .
6078 "<td>";
6079 if (defined $comment) {
6080 print format_subject_html($comment, $comment_short,
6081 href(action=>"tag", hash=>$tag{'id'}));
6083 print "</td>\n" .
6084 "<td class=\"selflink\">";
6085 if ($tag{'type'} eq "tag") {
6086 print $cgi->a({-href => href(action=>"tag", hash=>$tag{'id'})}, "tag");
6087 } else {
6088 print "&nbsp;";
6090 print "</td>\n" .
6091 "<td class=\"link\">" . " | " .
6092 $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'})}, $tag{'reftype'});
6093 if ($tag{'reftype'} eq "commit") {
6094 print " | " . $cgi->a({-href => href(action=>"shortlog", hash=>$tag{'fullname'})}, "shortlog") .
6095 " | " . $cgi->a({-href => href(action=>"log", hash=>$tag{'fullname'})}, "log");
6096 } elsif ($tag{'reftype'} eq "blob") {
6097 print " | " . $cgi->a({-href => href(action=>"blob_plain", hash=>$tag{'refid'})}, "raw");
6099 print "</td>\n" .
6100 "</tr>";
6102 if (defined $extra) {
6103 print "<tr>\n" .
6104 "<td colspan=\"5\">$extra</td>\n" .
6105 "</tr>\n";
6107 print "</table>\n";
6110 sub git_heads_body {
6111 # uses global variable $project
6112 my ($headlist, $head_at, $from, $to, $extra) = @_;
6113 $from = 0 unless defined $from;
6114 $to = $#{$headlist} if (!defined $to || $#{$headlist} < $to);
6116 print "<table class=\"heads\">\n";
6117 my $alternate = 1;
6118 for (my $i = $from; $i <= $to; $i++) {
6119 my $entry = $headlist->[$i];
6120 my %ref = %$entry;
6121 my $curr = defined $head_at && $ref{'id'} eq $head_at;
6122 if ($alternate) {
6123 print "<tr class=\"dark\">\n";
6124 } else {
6125 print "<tr class=\"light\">\n";
6127 $alternate ^= 1;
6128 print "<td><i>$ref{'age'}</i></td>\n" .
6129 ($curr ? "<td class=\"current_head\">" : "<td>") .
6130 $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'}),
6131 -class => "list name"},esc_html($ref{'name'})) .
6132 "</td>\n" .
6133 "<td class=\"link\">" .
6134 $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'})}, "shortlog") . " | " .
6135 $cgi->a({-href => href(action=>"log", hash=>$ref{'fullname'})}, "log") . " | " .
6136 $cgi->a({-href => href(action=>"tree", hash=>$ref{'fullname'}, hash_base=>$ref{'fullname'})}, "tree") .
6137 "</td>\n" .
6138 "</tr>";
6140 if (defined $extra) {
6141 print "<tr>\n" .
6142 "<td colspan=\"3\">$extra</td>\n" .
6143 "</tr>\n";
6145 print "</table>\n";
6148 # Display a single remote block
6149 sub git_remote_block {
6150 my ($remote, $rdata, $limit, $head) = @_;
6152 my $heads = $rdata->{'heads'};
6153 my $fetch = $rdata->{'fetch'};
6154 my $push = $rdata->{'push'};
6156 my $urls_table = "<table class=\"projects_list\">\n" ;
6158 if (defined $fetch) {
6159 if ($fetch eq $push) {
6160 $urls_table .= format_repo_url("URL", $fetch);
6161 } else {
6162 $urls_table .= format_repo_url("Fetch URL", $fetch);
6163 $urls_table .= format_repo_url("Push URL", $push) if defined $push;
6165 } elsif (defined $push) {
6166 $urls_table .= format_repo_url("Push URL", $push);
6167 } else {
6168 $urls_table .= format_repo_url("", "No remote URL");
6171 $urls_table .= "</table>\n";
6173 my $dots;
6174 if (defined $limit && $limit < @$heads) {
6175 $dots = $cgi->a({-href => href(action=>"remotes", hash=>$remote)}, "...");
6178 print $urls_table;
6179 git_heads_body($heads, $head, 0, $limit, $dots);
6182 # Display a list of remote names with the respective fetch and push URLs
6183 sub git_remotes_list {
6184 my ($remotedata, $limit) = @_;
6185 print "<table class=\"heads\">\n";
6186 my $alternate = 1;
6187 my @remotes = sort keys %$remotedata;
6189 my $limited = $limit && $limit < @remotes;
6191 $#remotes = $limit - 1 if $limited;
6193 while (my $remote = shift @remotes) {
6194 my $rdata = $remotedata->{$remote};
6195 my $fetch = $rdata->{'fetch'};
6196 my $push = $rdata->{'push'};
6197 if ($alternate) {
6198 print "<tr class=\"dark\">\n";
6199 } else {
6200 print "<tr class=\"light\">\n";
6202 $alternate ^= 1;
6203 print "<td>" .
6204 $cgi->a({-href=> href(action=>'remotes', hash=>$remote),
6205 -class=> "list name"},esc_html($remote)) .
6206 "</td>";
6207 print "<td class=\"link\">" .
6208 (defined $fetch ? $cgi->a({-href=> $fetch}, "fetch") : "fetch") .
6209 " | " .
6210 (defined $push ? $cgi->a({-href=> $push}, "push") : "push") .
6211 "</td>";
6213 print "</tr>\n";
6216 if ($limited) {
6217 print "<tr>\n" .
6218 "<td colspan=\"3\">" .
6219 $cgi->a({-href => href(action=>"remotes")}, "...") .
6220 "</td>\n" . "</tr>\n";
6223 print "</table>";
6226 # Display remote heads grouped by remote, unless there are too many
6227 # remotes, in which case we only display the remote names
6228 sub git_remotes_body {
6229 my ($remotedata, $limit, $head) = @_;
6230 if ($limit and $limit < keys %$remotedata) {
6231 git_remotes_list($remotedata, $limit);
6232 } else {
6233 fill_remote_heads($remotedata);
6234 while (my ($remote, $rdata) = each %$remotedata) {
6235 git_print_section({-class=>"remote", -id=>$remote},
6236 ["remotes", $remote, $remote], sub {
6237 git_remote_block($remote, $rdata, $limit, $head);
6243 sub git_search_message {
6244 my %co = @_;
6246 my $greptype;
6247 if ($searchtype eq 'commit') {
6248 $greptype = "--grep=";
6249 } elsif ($searchtype eq 'author') {
6250 $greptype = "--author=";
6251 } elsif ($searchtype eq 'committer') {
6252 $greptype = "--committer=";
6254 $greptype .= $searchtext;
6255 my @commitlist = parse_commits($hash, 101, (100 * $page), undef,
6256 $greptype, '--regexp-ignore-case',
6257 $search_use_regexp ? '--extended-regexp' : '--fixed-strings');
6259 my $paging_nav = '';
6260 if ($page > 0) {
6261 $paging_nav .=
6262 $cgi->a({-href => href(-replay=>1, page=>undef)},
6263 "first") .
6264 " &sdot; " .
6265 $cgi->a({-href => href(-replay=>1, page=>$page-1),
6266 -accesskey => "p", -title => "Alt-p"}, "prev");
6267 } else {
6268 $paging_nav .= "first &sdot; prev";
6270 my $next_link = '';
6271 if ($#commitlist >= 100) {
6272 $next_link =
6273 $cgi->a({-href => href(-replay=>1, page=>$page+1),
6274 -accesskey => "n", -title => "Alt-n"}, "next");
6275 $paging_nav .= " &sdot; $next_link";
6276 } else {
6277 $paging_nav .= " &sdot; next";
6280 git_header_html();
6282 git_print_page_nav('','', $hash,$co{'tree'},$hash, $paging_nav);
6283 git_print_header_div('commit', esc_html($co{'title'}), $hash);
6284 if ($page == 0 && !@commitlist) {
6285 print "<p>No match.</p>\n";
6286 } else {
6287 git_search_grep_body(\@commitlist, 0, 99, $next_link);
6290 git_footer_html();
6293 sub git_search_changes {
6294 my %co = @_;
6296 local $/ = "\n";
6297 open my $fd, '-|', git_cmd(), '--no-pager', 'log', @diff_opts,
6298 '--pretty=format:%H', '--no-abbrev', '--raw', "-S$searchtext",
6299 ($search_use_regexp ? '--pickaxe-regex' : ())
6300 or die_error(500, "Open git-log failed");
6302 git_header_html();
6304 git_print_page_nav('','', $hash,$co{'tree'},$hash);
6305 git_print_header_div('commit', esc_html($co{'title'}), $hash);
6307 print "<table class=\"pickaxe search\">\n";
6308 my $alternate = 1;
6309 undef %co;
6310 my @files;
6311 while (my $line = <$fd>) {
6312 chomp $line;
6313 next unless $line;
6315 my %set = parse_difftree_raw_line($line);
6316 if (defined $set{'commit'}) {
6317 # finish previous commit
6318 if (%co) {
6319 print "</td>\n" .
6320 "<td class=\"link\">" .
6321 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
6322 "commit") .
6323 " | " .
6324 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
6325 hash_base=>$co{'id'})},
6326 "tree") .
6327 "</td>\n" .
6328 "</tr>\n";
6331 if ($alternate) {
6332 print "<tr class=\"dark\">\n";
6333 } else {
6334 print "<tr class=\"light\">\n";
6336 $alternate ^= 1;
6337 %co = parse_commit($set{'commit'});
6338 my $author = chop_and_escape_str($co{'author_name'}, 15, 5);
6339 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6340 "<td><i>$author</i></td>\n" .
6341 "<td>" .
6342 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
6343 -class => "list subject"},
6344 chop_and_escape_str($co{'title'}, 50) . "<br/>");
6345 } elsif (defined $set{'to_id'}) {
6346 next if is_deleted(\%set);
6348 print $cgi->a({-href => href(action=>"blob", hash_base=>$co{'id'},
6349 hash=>$set{'to_id'}, file_name=>$set{'to_file'}),
6350 -class => "list"},
6351 "<span class=\"match\">" . esc_path($set{'file'}) . "</span>") .
6352 "<br/>\n";
6355 close $fd;
6357 # finish last commit (warning: repetition!)
6358 if (%co) {
6359 print "</td>\n" .
6360 "<td class=\"link\">" .
6361 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
6362 "commit") .
6363 " | " .
6364 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
6365 hash_base=>$co{'id'})},
6366 "tree") .
6367 "</td>\n" .
6368 "</tr>\n";
6371 print "</table>\n";
6373 git_footer_html();
6376 sub git_search_files {
6377 my %co = @_;
6379 local $/ = "\n";
6380 open my $fd, "-|", git_cmd(), 'grep', '-n', '-z',
6381 $search_use_regexp ? ('-E', '-i') : '-F',
6382 $searchtext, $co{'tree'}
6383 or die_error(500, "Open git-grep failed");
6385 git_header_html();
6387 git_print_page_nav('','', $hash,$co{'tree'},$hash);
6388 git_print_header_div('commit', esc_html($co{'title'}), $hash);
6390 print "<table class=\"grep_search\">\n";
6391 my $alternate = 1;
6392 my $matches = 0;
6393 my $lastfile = '';
6394 my $file_href;
6395 while (my $line = <$fd>) {
6396 chomp $line;
6397 my ($file, $lno, $ltext, $binary);
6398 last if ($matches++ > 1000);
6399 if ($line =~ /^Binary file (.+) matches$/) {
6400 $file = $1;
6401 $binary = 1;
6402 } else {
6403 ($file, $lno, $ltext) = split(/\0/, $line, 3);
6404 $file =~ s/^$co{'tree'}://;
6406 if ($file ne $lastfile) {
6407 $lastfile and print "</td></tr>\n";
6408 if ($alternate++) {
6409 print "<tr class=\"dark\">\n";
6410 } else {
6411 print "<tr class=\"light\">\n";
6413 $file_href = href(action=>"blob", hash_base=>$co{'id'},
6414 file_name=>$file);
6415 print "<td class=\"list\">".
6416 $cgi->a({-href => $file_href, -class => "list"}, esc_path($file));
6417 print "</td><td>\n";
6418 $lastfile = $file;
6420 if ($binary) {
6421 print "<div class=\"binary\">Binary file</div>\n";
6422 } else {
6423 $ltext = untabify($ltext);
6424 if ($ltext =~ m/^(.*)($search_regexp)(.*)$/i) {
6425 $ltext = esc_html($1, -nbsp=>1);
6426 $ltext .= '<span class="match">';
6427 $ltext .= esc_html($2, -nbsp=>1);
6428 $ltext .= '</span>';
6429 $ltext .= esc_html($3, -nbsp=>1);
6430 } else {
6431 $ltext = esc_html($ltext, -nbsp=>1);
6433 print "<div class=\"pre\">" .
6434 $cgi->a({-href => $file_href.'#l'.$lno,
6435 -class => "linenr"}, sprintf('%4i', $lno)) .
6436 ' ' . $ltext . "</div>\n";
6439 if ($lastfile) {
6440 print "</td></tr>\n";
6441 if ($matches > 1000) {
6442 print "<div class=\"diff nodifferences\">Too many matches, listing trimmed</div>\n";
6444 } else {
6445 print "<div class=\"diff nodifferences\">No matches found</div>\n";
6447 close $fd;
6449 print "</table>\n";
6451 git_footer_html();
6454 sub git_search_grep_body {
6455 my ($commitlist, $from, $to, $extra) = @_;
6456 $from = 0 unless defined $from;
6457 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
6459 print "<table class=\"commit_search\">\n";
6460 my $alternate = 1;
6461 for (my $i = $from; $i <= $to; $i++) {
6462 my %co = %{$commitlist->[$i]};
6463 if (!%co) {
6464 next;
6466 my $commit = $co{'id'};
6467 if ($alternate) {
6468 print "<tr class=\"dark\">\n";
6469 } else {
6470 print "<tr class=\"light\">\n";
6472 $alternate ^= 1;
6473 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
6474 format_author_html('td', \%co, 15, 5) .
6475 "<td>" .
6476 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
6477 -class => "list subject"},
6478 chop_and_escape_str($co{'title'}, 50) . "<br/>");
6479 my $comment = $co{'comment'};
6480 foreach my $line (@$comment) {
6481 if ($line =~ m/^(.*?)($search_regexp)(.*)$/i) {
6482 my ($lead, $match, $trail) = ($1, $2, $3);
6483 $match = chop_str($match, 70, 5, 'center');
6484 my $contextlen = int((80 - length($match))/2);
6485 $contextlen = 30 if ($contextlen > 30);
6486 $lead = chop_str($lead, $contextlen, 10, 'left');
6487 $trail = chop_str($trail, $contextlen, 10, 'right');
6489 $lead = esc_html($lead);
6490 $match = esc_html($match);
6491 $trail = esc_html($trail);
6493 print "$lead<span class=\"match\">$match</span>$trail<br />";
6496 print "</td>\n" .
6497 "<td class=\"link\">" .
6498 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})}, "commit") .
6499 " | " .
6500 $cgi->a({-href => href(action=>"commitdiff", hash=>$co{'id'})}, "commitdiff") .
6501 " | " .
6502 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$co{'id'})}, "tree");
6503 print "</td>\n" .
6504 "</tr>\n";
6506 if (defined $extra) {
6507 print "<tr>\n" .
6508 "<td colspan=\"3\">$extra</td>\n" .
6509 "</tr>\n";
6511 print "</table>\n";
6514 ## ======================================================================
6515 ## ======================================================================
6516 ## actions
6518 sub git_project_list {
6519 my $order = $input_params{'order'};
6520 if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6521 die_error(400, "Unknown order parameter");
6524 my @list = git_get_projects_list($project_filter, $strict_export);
6525 if (!@list) {
6526 die_error(404, "No projects found");
6529 git_header_html();
6530 if (defined $home_text && -f $home_text) {
6531 print "<div class=\"index_include\">\n";
6532 insert_file($home_text);
6533 print "</div>\n";
6536 git_project_search_form($searchtext, $search_use_regexp);
6537 git_project_list_body(\@list, $order);
6538 git_footer_html();
6541 sub git_forks {
6542 my $order = $input_params{'order'};
6543 if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6544 die_error(400, "Unknown order parameter");
6547 my $filter = $project;
6548 $filter =~ s/\.git$//;
6549 my @list = git_get_projects_list($filter);
6550 if (!@list) {
6551 die_error(404, "No forks found");
6554 git_header_html();
6555 git_print_page_nav('','');
6556 git_print_header_div('summary', "$project forks");
6557 git_project_list_body(\@list, $order);
6558 git_footer_html();
6561 sub git_project_index {
6562 my @projects = git_get_projects_list($project_filter, $strict_export);
6563 if (!@projects) {
6564 die_error(404, "No projects found");
6567 print $cgi->header(
6568 -type => 'text/plain',
6569 -charset => 'utf-8',
6570 -content_disposition => 'inline; filename="index.aux"');
6572 foreach my $pr (@projects) {
6573 if (!exists $pr->{'owner'}) {
6574 $pr->{'owner'} = git_get_project_owner("$pr->{'path'}");
6577 my ($path, $owner) = ($pr->{'path'}, $pr->{'owner'});
6578 # quote as in CGI::Util::encode, but keep the slash, and use '+' for ' '
6579 $path =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6580 $owner =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6581 $path =~ s/ /\+/g;
6582 $owner =~ s/ /\+/g;
6584 print "$path $owner\n";
6588 sub git_summary {
6589 my $descr = git_get_project_description($project) || "none";
6590 my %co = parse_commit("HEAD");
6591 my %cd = %co ? parse_date($co{'committer_epoch'}, $co{'committer_tz'}) : ();
6592 my $head = $co{'id'};
6593 my $remote_heads = gitweb_check_feature('remote_heads');
6595 my $owner = git_get_project_owner($project);
6597 my $refs = git_get_references();
6598 # These get_*_list functions return one more to allow us to see if
6599 # there are more ...
6600 my @taglist = git_get_tags_list(16);
6601 my @headlist = git_get_heads_list(16);
6602 my %remotedata = $remote_heads ? git_get_remotes_list() : ();
6603 my @forklist;
6604 my $check_forks = gitweb_check_feature('forks');
6606 if ($check_forks) {
6607 # find forks of a project
6608 my $filter = $project;
6609 $filter =~ s/\.git$//;
6610 @forklist = git_get_projects_list($filter);
6611 # filter out forks of forks
6612 @forklist = filter_forks_from_projects_list(\@forklist)
6613 if (@forklist);
6616 git_header_html();
6617 git_print_page_nav('summary','', $head);
6619 print "<div class=\"title\">&nbsp;</div>\n";
6620 print "<table class=\"projects_list\">\n" .
6621 "<tr id=\"metadata_desc\"><td>description</td><td>" . esc_html($descr) . "</td></tr>\n";
6622 if ($owner and not $omit_owner) {
6623 print "<tr id=\"metadata_owner\"><td>owner</td><td>" . esc_html($owner) . "</td></tr>\n";
6625 if (defined $cd{'rfc2822'}) {
6626 print "<tr id=\"metadata_lchange\"><td>last change</td>" .
6627 "<td>".format_timestamp_html(\%cd)."</td></tr>\n";
6630 # use per project git URL list in $projectroot/$project/cloneurl
6631 # or make project git URL from git base URL and project name
6632 my $url_tag = "URL";
6633 my @url_list = git_get_project_url_list($project);
6634 @url_list = map { "$_/$project" } @git_base_url_list unless @url_list;
6635 foreach my $git_url (@url_list) {
6636 next unless $git_url;
6637 print format_repo_url($url_tag, $git_url);
6638 $url_tag = "";
6641 # Tag cloud
6642 my $show_ctags = gitweb_check_feature('ctags');
6643 if ($show_ctags) {
6644 my $ctags = git_get_project_ctags($project);
6645 if (%$ctags) {
6646 # without ability to add tags, don't show if there are none
6647 my $cloud = git_populate_project_tagcloud($ctags);
6648 print "<tr id=\"metadata_ctags\">" .
6649 "<td>content tags</td>" .
6650 "<td>".git_show_project_tagcloud($cloud, 48)."</td>" .
6651 "</tr>\n";
6655 print "</table>\n";
6657 # If XSS prevention is on, we don't include README.html.
6658 # TODO: Allow a readme in some safe format.
6659 if (!$prevent_xss && -s "$projectroot/$project/README.html") {
6660 print "<div class=\"title\">readme</div>\n" .
6661 "<div class=\"readme\">\n";
6662 insert_file("$projectroot/$project/README.html");
6663 print "\n</div>\n"; # class="readme"
6666 # we need to request one more than 16 (0..15) to check if
6667 # those 16 are all
6668 my @commitlist = $head ? parse_commits($head, 17) : ();
6669 if (@commitlist) {
6670 git_print_header_div('shortlog');
6671 git_shortlog_body(\@commitlist, 0, 15, $refs,
6672 $#commitlist <= 15 ? undef :
6673 $cgi->a({-href => href(action=>"shortlog")}, "..."));
6676 if (@taglist) {
6677 git_print_header_div('tags');
6678 git_tags_body(\@taglist, 0, 15,
6679 $#taglist <= 15 ? undef :
6680 $cgi->a({-href => href(action=>"tags")}, "..."));
6683 if (@headlist) {
6684 git_print_header_div('heads');
6685 git_heads_body(\@headlist, $head, 0, 15,
6686 $#headlist <= 15 ? undef :
6687 $cgi->a({-href => href(action=>"heads")}, "..."));
6690 if (%remotedata) {
6691 git_print_header_div('remotes');
6692 git_remotes_body(\%remotedata, 15, $head);
6695 if (@forklist) {
6696 git_print_header_div('forks');
6697 git_project_list_body(\@forklist, 'age', 0, 15,
6698 $#forklist <= 15 ? undef :
6699 $cgi->a({-href => href(action=>"forks")}, "..."),
6700 'no_header');
6703 git_footer_html();
6706 sub git_tag {
6707 my %tag = parse_tag($hash);
6709 if (! %tag) {
6710 die_error(404, "Unknown tag object");
6713 my $head = git_get_head_hash($project);
6714 git_header_html();
6715 git_print_page_nav('','', $head,undef,$head);
6716 git_print_header_div('commit', esc_html($tag{'name'}), $hash);
6717 print "<div class=\"title_text\">\n" .
6718 "<table class=\"object_header\">\n" .
6719 "<tr>\n" .
6720 "<td>object</td>\n" .
6721 "<td>" . $cgi->a({-class => "list", -href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6722 $tag{'object'}) . "</td>\n" .
6723 "<td class=\"link\">" . $cgi->a({-href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6724 $tag{'type'}) . "</td>\n" .
6725 "</tr>\n";
6726 if (defined($tag{'author'})) {
6727 git_print_authorship_rows(\%tag, 'author');
6729 print "</table>\n\n" .
6730 "</div>\n";
6731 print "<div class=\"page_body\">";
6732 my $comment = $tag{'comment'};
6733 foreach my $line (@$comment) {
6734 chomp $line;
6735 print esc_html($line, -nbsp=>1) . "<br/>\n";
6737 print "</div>\n";
6738 git_footer_html();
6741 sub git_blame_common {
6742 my $format = shift || 'porcelain';
6743 if ($format eq 'porcelain' && $input_params{'javascript'}) {
6744 $format = 'incremental';
6745 $action = 'blame_incremental'; # for page title etc
6748 # permissions
6749 gitweb_check_feature('blame')
6750 or die_error(403, "Blame view not allowed");
6752 # error checking
6753 die_error(400, "No file name given") unless $file_name;
6754 $hash_base ||= git_get_head_hash($project);
6755 die_error(404, "Couldn't find base commit") unless $hash_base;
6756 my %co = parse_commit($hash_base)
6757 or die_error(404, "Commit not found");
6758 my $ftype = "blob";
6759 if (!defined $hash) {
6760 $hash = git_get_hash_by_path($hash_base, $file_name, "blob")
6761 or die_error(404, "Error looking up file");
6762 } else {
6763 $ftype = git_get_type($hash);
6764 if ($ftype !~ "blob") {
6765 die_error(400, "Object is not a blob");
6769 my $fd;
6770 if ($format eq 'incremental') {
6771 # get file contents (as base)
6772 open $fd, "-|", git_cmd(), 'cat-file', 'blob', $hash
6773 or die_error(500, "Open git-cat-file failed");
6774 } elsif ($format eq 'data') {
6775 # run git-blame --incremental
6776 open $fd, "-|", git_cmd(), "blame", "--incremental",
6777 $hash_base, "--", $file_name
6778 or die_error(500, "Open git-blame --incremental failed");
6779 } else {
6780 # run git-blame --porcelain
6781 open $fd, "-|", git_cmd(), "blame", '-p',
6782 $hash_base, '--', $file_name
6783 or die_error(500, "Open git-blame --porcelain failed");
6785 binmode $fd, ':utf8';
6787 # incremental blame data returns early
6788 if ($format eq 'data') {
6789 print $cgi->header(
6790 -type=>"text/plain", -charset => "utf-8",
6791 -status=> "200 OK");
6792 local $| = 1; # output autoflush
6793 while (my $line = <$fd>) {
6794 print to_utf8($line);
6796 close $fd
6797 or print "ERROR $!\n";
6799 print 'END';
6800 if (defined $t0 && gitweb_check_feature('timed')) {
6801 print ' '.
6802 tv_interval($t0, [ gettimeofday() ]).
6803 ' '.$number_of_git_cmds;
6805 print "\n";
6807 return;
6810 # page header
6811 git_header_html();
6812 my $formats_nav =
6813 $cgi->a({-href => href(action=>"blob", -replay=>1)},
6814 "blob") .
6815 " | ";
6816 if ($format eq 'incremental') {
6817 $formats_nav .=
6818 $cgi->a({-href => href(action=>"blame", javascript=>0, -replay=>1)},
6819 "blame") . " (non-incremental)";
6820 } else {
6821 $formats_nav .=
6822 $cgi->a({-href => href(action=>"blame_incremental", -replay=>1)},
6823 "blame") . " (incremental)";
6825 $formats_nav .=
6826 " | " .
6827 $cgi->a({-href => href(action=>"history", -replay=>1)},
6828 "history") .
6829 " | " .
6830 $cgi->a({-href => href(action=>$action, file_name=>$file_name)},
6831 "HEAD");
6832 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
6833 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
6834 git_print_page_path($file_name, $ftype, $hash_base);
6836 # page body
6837 if ($format eq 'incremental') {
6838 print "<noscript>\n<div class=\"error\"><center><b>\n".
6839 "This page requires JavaScript to run.\n Use ".
6840 $cgi->a({-href => href(action=>'blame',javascript=>0,-replay=>1)},
6841 'this page').
6842 " instead.\n".
6843 "</b></center></div>\n</noscript>\n";
6845 print qq!<div id="progress_bar" style="width: 100%; background-color: yellow"></div>\n!;
6848 print qq!<div class="page_body">\n!;
6849 print qq!<div id="progress_info">... / ...</div>\n!
6850 if ($format eq 'incremental');
6851 print qq!<table id="blame_table" class="blame" width="100%">\n!.
6852 #qq!<col width="5.5em" /><col width="2.5em" /><col width="*" />\n!.
6853 qq!<thead>\n!.
6854 qq!<tr><th>Commit</th><th>Line</th><th>Data</th></tr>\n!.
6855 qq!</thead>\n!.
6856 qq!<tbody>\n!;
6858 my @rev_color = qw(light dark);
6859 my $num_colors = scalar(@rev_color);
6860 my $current_color = 0;
6862 if ($format eq 'incremental') {
6863 my $color_class = $rev_color[$current_color];
6865 #contents of a file
6866 my $linenr = 0;
6867 LINE:
6868 while (my $line = <$fd>) {
6869 chomp $line;
6870 $linenr++;
6872 print qq!<tr id="l$linenr" class="$color_class">!.
6873 qq!<td class="sha1"><a href=""> </a></td>!.
6874 qq!<td class="linenr">!.
6875 qq!<a class="linenr" href="">$linenr</a></td>!;
6876 print qq!<td class="pre">! . esc_html($line) . "</td>\n";
6877 print qq!</tr>\n!;
6880 } else { # porcelain, i.e. ordinary blame
6881 my %metainfo = (); # saves information about commits
6883 # blame data
6884 LINE:
6885 while (my $line = <$fd>) {
6886 chomp $line;
6887 # the header: <SHA-1> <src lineno> <dst lineno> [<lines in group>]
6888 # no <lines in group> for subsequent lines in group of lines
6889 my ($full_rev, $orig_lineno, $lineno, $group_size) =
6890 ($line =~ /^($oid_regex) (\d+) (\d+)(?: (\d+))?$/);
6891 if (!exists $metainfo{$full_rev}) {
6892 $metainfo{$full_rev} = { 'nprevious' => 0 };
6894 my $meta = $metainfo{$full_rev};
6895 my $data;
6896 while ($data = <$fd>) {
6897 chomp $data;
6898 last if ($data =~ s/^\t//); # contents of line
6899 if ($data =~ /^(\S+)(?: (.*))?$/) {
6900 $meta->{$1} = $2 unless exists $meta->{$1};
6902 if ($data =~ /^previous /) {
6903 $meta->{'nprevious'}++;
6906 my $short_rev = substr($full_rev, 0, 8);
6907 my $author = $meta->{'author'};
6908 my %date =
6909 parse_date($meta->{'author-time'}, $meta->{'author-tz'});
6910 my $date = $date{'iso-tz'};
6911 if ($group_size) {
6912 $current_color = ($current_color + 1) % $num_colors;
6914 my $tr_class = $rev_color[$current_color];
6915 $tr_class .= ' boundary' if (exists $meta->{'boundary'});
6916 $tr_class .= ' no-previous' if ($meta->{'nprevious'} == 0);
6917 $tr_class .= ' multiple-previous' if ($meta->{'nprevious'} > 1);
6918 print "<tr id=\"l$lineno\" class=\"$tr_class\">\n";
6919 if ($group_size) {
6920 print "<td class=\"sha1\"";
6921 print " title=\"". esc_html($author) . ", $date\"";
6922 print " rowspan=\"$group_size\"" if ($group_size > 1);
6923 print ">";
6924 print $cgi->a({-href => href(action=>"commit",
6925 hash=>$full_rev,
6926 file_name=>$file_name)},
6927 esc_html($short_rev));
6928 if ($group_size >= 2) {
6929 my @author_initials = ($author =~ /\b([[:upper:]])\B/g);
6930 if (@author_initials) {
6931 print "<br />" .
6932 esc_html(join('', @author_initials));
6933 # or join('.', ...)
6936 print "</td>\n";
6938 # 'previous' <sha1 of parent commit> <filename at commit>
6939 if (exists $meta->{'previous'} &&
6940 $meta->{'previous'} =~ /^($oid_regex) (.*)$/) {
6941 $meta->{'parent'} = $1;
6942 $meta->{'file_parent'} = unquote($2);
6944 my $linenr_commit =
6945 exists($meta->{'parent'}) ?
6946 $meta->{'parent'} : $full_rev;
6947 my $linenr_filename =
6948 exists($meta->{'file_parent'}) ?
6949 $meta->{'file_parent'} : unquote($meta->{'filename'});
6950 my $blamed = href(action => 'blame',
6951 file_name => $linenr_filename,
6952 hash_base => $linenr_commit);
6953 print "<td class=\"linenr\">";
6954 print $cgi->a({ -href => "$blamed#l$orig_lineno",
6955 -class => "linenr" },
6956 esc_html($lineno));
6957 print "</td>";
6958 print "<td class=\"pre\">" . esc_html($data) . "</td>\n";
6959 print "</tr>\n";
6960 } # end while
6964 # footer
6965 print "</tbody>\n".
6966 "</table>\n"; # class="blame"
6967 print "</div>\n"; # class="blame_body"
6968 close $fd
6969 or print "Reading blob failed\n";
6971 git_footer_html();
6974 sub git_blame {
6975 git_blame_common();
6978 sub git_blame_incremental {
6979 git_blame_common('incremental');
6982 sub git_blame_data {
6983 git_blame_common('data');
6986 sub git_tags {
6987 my $head = git_get_head_hash($project);
6988 git_header_html();
6989 git_print_page_nav('','', $head,undef,$head,format_ref_views('tags'));
6990 git_print_header_div('summary', $project);
6992 my @tagslist = git_get_tags_list();
6993 if (@tagslist) {
6994 git_tags_body(\@tagslist);
6996 git_footer_html();
6999 sub git_heads {
7000 my $head = git_get_head_hash($project);
7001 git_header_html();
7002 git_print_page_nav('','', $head,undef,$head,format_ref_views('heads'));
7003 git_print_header_div('summary', $project);
7005 my @headslist = git_get_heads_list();
7006 if (@headslist) {
7007 git_heads_body(\@headslist, $head);
7009 git_footer_html();
7012 # used both for single remote view and for list of all the remotes
7013 sub git_remotes {
7014 gitweb_check_feature('remote_heads')
7015 or die_error(403, "Remote heads view is disabled");
7017 my $head = git_get_head_hash($project);
7018 my $remote = $input_params{'hash'};
7020 my $remotedata = git_get_remotes_list($remote);
7021 die_error(500, "Unable to get remote information") unless defined $remotedata;
7023 unless (%$remotedata) {
7024 die_error(404, defined $remote ?
7025 "Remote $remote not found" :
7026 "No remotes found");
7029 git_header_html(undef, undef, -action_extra => $remote);
7030 git_print_page_nav('', '', $head, undef, $head,
7031 format_ref_views($remote ? '' : 'remotes'));
7033 fill_remote_heads($remotedata);
7034 if (defined $remote) {
7035 git_print_header_div('remotes', "$remote remote for $project");
7036 git_remote_block($remote, $remotedata->{$remote}, undef, $head);
7037 } else {
7038 git_print_header_div('summary', "$project remotes");
7039 git_remotes_body($remotedata, undef, $head);
7042 git_footer_html();
7045 sub git_blob_plain {
7046 my $type = shift;
7047 my $expires;
7049 if (!defined $hash) {
7050 if (defined $file_name) {
7051 my $base = $hash_base || git_get_head_hash($project);
7052 $hash = git_get_hash_by_path($base, $file_name, "blob")
7053 or die_error(404, "Cannot find file");
7054 } else {
7055 die_error(400, "No file name defined");
7057 } elsif ($hash =~ m/^$oid_regex$/) {
7058 # blobs defined by non-textual hash id's can be cached
7059 $expires = "+1d";
7062 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
7063 or die_error(500, "Open git-cat-file blob '$hash' failed");
7065 # content-type (can include charset)
7066 $type = blob_contenttype($fd, $file_name, $type);
7068 # "save as" filename, even when no $file_name is given
7069 my $save_as = "$hash";
7070 if (defined $file_name) {
7071 $save_as = $file_name;
7072 } elsif ($type =~ m/^text\//) {
7073 $save_as .= '.txt';
7076 # With XSS prevention on, blobs of all types except a few known safe
7077 # ones are served with "Content-Disposition: attachment" to make sure
7078 # they don't run in our security domain. For certain image types,
7079 # blob view writes an <img> tag referring to blob_plain view, and we
7080 # want to be sure not to break that by serving the image as an
7081 # attachment (though Firefox 3 doesn't seem to care).
7082 my $sandbox = $prevent_xss &&
7083 $type !~ m!^(?:text/[a-z]+|image/(?:gif|png|jpeg))(?:[ ;]|$)!;
7085 # serve text/* as text/plain
7086 if ($prevent_xss &&
7087 ($type =~ m!^text/[a-z]+\b(.*)$! ||
7088 ($type =~ m!^[a-z]+/[a-z]\+xml\b(.*)$! && -T $fd))) {
7089 my $rest = $1;
7090 $rest = defined $rest ? $rest : '';
7091 $type = "text/plain$rest";
7094 print $cgi->header(
7095 -type => $type,
7096 -expires => $expires,
7097 -content_disposition =>
7098 ($sandbox ? 'attachment' : 'inline')
7099 . '; filename="' . $save_as . '"');
7100 local $/ = undef;
7101 local *FCGI::Stream::PRINT = $FCGI_Stream_PRINT_raw;
7102 binmode STDOUT, ':raw';
7103 print <$fd>;
7104 binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
7105 close $fd;
7108 sub git_blob {
7109 my $expires;
7111 if (!defined $hash) {
7112 if (defined $file_name) {
7113 my $base = $hash_base || git_get_head_hash($project);
7114 $hash = git_get_hash_by_path($base, $file_name, "blob")
7115 or die_error(404, "Cannot find file");
7116 } else {
7117 die_error(400, "No file name defined");
7119 } elsif ($hash =~ m/^$oid_regex$/) {
7120 # blobs defined by non-textual hash id's can be cached
7121 $expires = "+1d";
7124 my $have_blame = gitweb_check_feature('blame');
7125 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
7126 or die_error(500, "Couldn't cat $file_name, $hash");
7127 my $mimetype = blob_mimetype($fd, $file_name);
7128 # use 'blob_plain' (aka 'raw') view for files that cannot be displayed
7129 if ($mimetype !~ m!^(?:text/|image/(?:gif|png|jpeg)$)! && -B $fd) {
7130 close $fd;
7131 return git_blob_plain($mimetype);
7133 # we can have blame only for text/* mimetype
7134 $have_blame &&= ($mimetype =~ m!^text/!);
7136 my $highlight = gitweb_check_feature('highlight');
7137 my $syntax = guess_file_syntax($highlight, $file_name);
7138 $fd = run_highlighter($fd, $highlight, $syntax);
7140 git_header_html(undef, $expires);
7141 my $formats_nav = '';
7142 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7143 if (defined $file_name) {
7144 if ($have_blame) {
7145 $formats_nav .=
7146 $cgi->a({-href => href(action=>"blame", -replay=>1)},
7147 "blame") .
7148 " | ";
7150 $formats_nav .=
7151 $cgi->a({-href => href(action=>"history", -replay=>1)},
7152 "history") .
7153 " | " .
7154 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
7155 "raw") .
7156 " | " .
7157 $cgi->a({-href => href(action=>"blob",
7158 hash_base=>"HEAD", file_name=>$file_name)},
7159 "HEAD");
7160 } else {
7161 $formats_nav .=
7162 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
7163 "raw");
7165 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
7166 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
7167 } else {
7168 print "<div class=\"page_nav\">\n" .
7169 "<br/><br/></div>\n" .
7170 "<div class=\"title\">".esc_html($hash)."</div>\n";
7172 git_print_page_path($file_name, "blob", $hash_base);
7173 print "<div class=\"page_body\">\n";
7174 if ($mimetype =~ m!^image/!) {
7175 print qq!<img class="blob" type="!.esc_attr($mimetype).qq!"!;
7176 if ($file_name) {
7177 print qq! alt="!.esc_attr($file_name).qq!" title="!.esc_attr($file_name).qq!"!;
7179 print qq! src="! .
7180 esc_attr(href(action=>"blob_plain", hash=>$hash,
7181 hash_base=>$hash_base, file_name=>$file_name)) .
7182 qq!" />\n!;
7183 } else {
7184 my $nr;
7185 while (my $line = <$fd>) {
7186 chomp $line;
7187 $nr++;
7188 $line = untabify($line);
7189 printf qq!<div class="pre"><a id="l%i" href="%s#l%i" class="linenr">%4i</a> %s</div>\n!,
7190 $nr, esc_attr(href(-replay => 1)), $nr, $nr,
7191 $highlight ? sanitize($line) : esc_html($line, -nbsp=>1);
7194 close $fd
7195 or print "Reading blob failed.\n";
7196 print "</div>";
7197 git_footer_html();
7200 sub git_tree {
7201 if (!defined $hash_base) {
7202 $hash_base = "HEAD";
7204 if (!defined $hash) {
7205 if (defined $file_name) {
7206 $hash = git_get_hash_by_path($hash_base, $file_name, "tree");
7207 } else {
7208 $hash = $hash_base;
7211 die_error(404, "No such tree") unless defined($hash);
7213 my $show_sizes = gitweb_check_feature('show-sizes');
7214 my $have_blame = gitweb_check_feature('blame');
7216 my @entries = ();
7218 local $/ = "\0";
7219 open my $fd, "-|", git_cmd(), "ls-tree", '-z',
7220 ($show_sizes ? '-l' : ()), @extra_options, $hash
7221 or die_error(500, "Open git-ls-tree failed");
7222 @entries = map { chomp; $_ } <$fd>;
7223 close $fd
7224 or die_error(404, "Reading tree failed");
7227 my $refs = git_get_references();
7228 my $ref = format_ref_marker($refs, $hash_base);
7229 git_header_html();
7230 my $basedir = '';
7231 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7232 my @views_nav = ();
7233 if (defined $file_name) {
7234 push @views_nav,
7235 $cgi->a({-href => href(action=>"history", -replay=>1)},
7236 "history"),
7237 $cgi->a({-href => href(action=>"tree",
7238 hash_base=>"HEAD", file_name=>$file_name)},
7239 "HEAD"),
7241 my $snapshot_links = format_snapshot_links($hash);
7242 if (defined $snapshot_links) {
7243 # FIXME: Should be available when we have no hash base as well.
7244 push @views_nav, $snapshot_links;
7246 git_print_page_nav('tree','', $hash_base, undef, undef,
7247 join(' | ', @views_nav));
7248 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash_base);
7249 } else {
7250 undef $hash_base;
7251 print "<div class=\"page_nav\">\n";
7252 print "<br/><br/></div>\n";
7253 print "<div class=\"title\">".esc_html($hash)."</div>\n";
7255 if (defined $file_name) {
7256 $basedir = $file_name;
7257 if ($basedir ne '' && substr($basedir, -1) ne '/') {
7258 $basedir .= '/';
7260 git_print_page_path($file_name, 'tree', $hash_base);
7262 print "<div class=\"page_body\">\n";
7263 print "<table class=\"tree\">\n";
7264 my $alternate = 1;
7265 # '..' (top directory) link if possible
7266 if (defined $hash_base &&
7267 defined $file_name && $file_name =~ m![^/]+$!) {
7268 if ($alternate) {
7269 print "<tr class=\"dark\">\n";
7270 } else {
7271 print "<tr class=\"light\">\n";
7273 $alternate ^= 1;
7275 my $up = $file_name;
7276 $up =~ s!/?[^/]+$!!;
7277 undef $up unless $up;
7278 # based on git_print_tree_entry
7279 print '<td class="mode">' . mode_str('040000') . "</td>\n";
7280 print '<td class="size">&nbsp;</td>'."\n" if $show_sizes;
7281 print '<td class="list">';
7282 print $cgi->a({-href => href(action=>"tree",
7283 hash_base=>$hash_base,
7284 file_name=>$up)},
7285 "..");
7286 print "</td>\n";
7287 print "<td class=\"link\"></td>\n";
7289 print "</tr>\n";
7291 foreach my $line (@entries) {
7292 my %t = parse_ls_tree_line($line, -z => 1, -l => $show_sizes);
7294 if ($alternate) {
7295 print "<tr class=\"dark\">\n";
7296 } else {
7297 print "<tr class=\"light\">\n";
7299 $alternate ^= 1;
7301 git_print_tree_entry(\%t, $basedir, $hash_base, $have_blame);
7303 print "</tr>\n";
7305 print "</table>\n" .
7306 "</div>";
7307 git_footer_html();
7310 sub sanitize_for_filename {
7311 my $name = shift;
7313 $name =~ s!/!-!g;
7314 $name =~ s/[^[:alnum:]_.-]//g;
7316 return $name;
7319 sub snapshot_name {
7320 my ($project, $hash) = @_;
7322 # path/to/project.git -> project
7323 # path/to/project/.git -> project
7324 my $name = to_utf8($project);
7325 $name =~ s,([^/])/*\.git$,$1,;
7326 $name = sanitize_for_filename(basename($name));
7328 my $ver = $hash;
7329 if ($hash =~ /^[0-9a-fA-F]+$/) {
7330 # shorten SHA-1 hash
7331 my $full_hash = git_get_full_hash($project, $hash);
7332 if ($full_hash =~ /^$hash/ && length($hash) > 7) {
7333 $ver = git_get_short_hash($project, $hash);
7335 } elsif ($hash =~ m!^refs/tags/(.*)$!) {
7336 # tags don't need shortened SHA-1 hash
7337 $ver = $1;
7338 } else {
7339 # branches and other need shortened SHA-1 hash
7340 my $strip_refs = join '|', map { quotemeta } get_branch_refs();
7341 if ($hash =~ m!^refs/($strip_refs|remotes)/(.*)$!) {
7342 my $ref_dir = (defined $1) ? $1 : '';
7343 $ver = $2;
7345 $ref_dir = sanitize_for_filename($ref_dir);
7346 # for refs neither in heads nor remotes we want to
7347 # add a ref dir to archive name
7348 if ($ref_dir ne '' and $ref_dir ne 'heads' and $ref_dir ne 'remotes') {
7349 $ver = $ref_dir . '-' . $ver;
7352 $ver .= '-' . git_get_short_hash($project, $hash);
7354 # special case of sanitization for filename - we change
7355 # slashes to dots instead of dashes
7356 # in case of hierarchical branch names
7357 $ver =~ s!/!.!g;
7358 $ver =~ s/[^[:alnum:]_.-]//g;
7360 # name = project-version_string
7361 $name = "$name-$ver";
7363 return wantarray ? ($name, $name) : $name;
7366 sub exit_if_unmodified_since {
7367 my ($latest_epoch) = @_;
7368 our $cgi;
7370 my $if_modified = $cgi->http('IF_MODIFIED_SINCE');
7371 if (defined $if_modified) {
7372 my $since;
7373 if (eval { require HTTP::Date; 1; }) {
7374 $since = HTTP::Date::str2time($if_modified);
7375 } elsif (eval { require Time::ParseDate; 1; }) {
7376 $since = Time::ParseDate::parsedate($if_modified, GMT => 1);
7378 if (defined $since && $latest_epoch <= $since) {
7379 my %latest_date = parse_date($latest_epoch);
7380 print $cgi->header(
7381 -last_modified => $latest_date{'rfc2822'},
7382 -status => '304 Not Modified');
7383 goto DONE_GITWEB;
7388 sub git_snapshot {
7389 my $format = $input_params{'snapshot_format'};
7390 if (!@snapshot_fmts) {
7391 die_error(403, "Snapshots not allowed");
7393 # default to first supported snapshot format
7394 $format ||= $snapshot_fmts[0];
7395 if ($format !~ m/^[a-z0-9]+$/) {
7396 die_error(400, "Invalid snapshot format parameter");
7397 } elsif (!exists($known_snapshot_formats{$format})) {
7398 die_error(400, "Unknown snapshot format");
7399 } elsif ($known_snapshot_formats{$format}{'disabled'}) {
7400 die_error(403, "Snapshot format not allowed");
7401 } elsif (!grep($_ eq $format, @snapshot_fmts)) {
7402 die_error(403, "Unsupported snapshot format");
7405 my $type = git_get_type("$hash^{}");
7406 if (!$type) {
7407 die_error(404, 'Object does not exist');
7408 } elsif ($type eq 'blob') {
7409 die_error(400, 'Object is not a tree-ish');
7412 my ($name, $prefix) = snapshot_name($project, $hash);
7413 my $filename = "$name$known_snapshot_formats{$format}{'suffix'}";
7415 my %co = parse_commit($hash);
7416 exit_if_unmodified_since($co{'committer_epoch'}) if %co;
7418 my $cmd = quote_command(
7419 git_cmd(), 'archive',
7420 "--format=$known_snapshot_formats{$format}{'format'}",
7421 "--prefix=$prefix/", $hash);
7422 if (exists $known_snapshot_formats{$format}{'compressor'}) {
7423 $cmd .= ' | ' . quote_command(@{$known_snapshot_formats{$format}{'compressor'}});
7426 $filename =~ s/(["\\])/\\$1/g;
7427 my %latest_date;
7428 if (%co) {
7429 %latest_date = parse_date($co{'committer_epoch'}, $co{'committer_tz'});
7432 print $cgi->header(
7433 -type => $known_snapshot_formats{$format}{'type'},
7434 -content_disposition => 'inline; filename="' . $filename . '"',
7435 %co ? (-last_modified => $latest_date{'rfc2822'}) : (),
7436 -status => '200 OK');
7438 open my $fd, "-|", $cmd
7439 or die_error(500, "Execute git-archive failed");
7440 local *FCGI::Stream::PRINT = $FCGI_Stream_PRINT_raw;
7441 binmode STDOUT, ':raw';
7442 print <$fd>;
7443 binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
7444 close $fd;
7447 sub git_log_generic {
7448 my ($fmt_name, $body_subr, $base, $parent, $file_name, $file_hash) = @_;
7450 my $head = git_get_head_hash($project);
7451 if (!defined $base) {
7452 $base = $head;
7454 if (!defined $page) {
7455 $page = 0;
7457 my $refs = git_get_references();
7459 my $commit_hash = $base;
7460 if (defined $parent) {
7461 $commit_hash = "$parent..$base";
7463 my @commitlist =
7464 parse_commits($commit_hash, 101, (100 * $page),
7465 defined $file_name ? ($file_name, "--full-history") : ());
7467 my $ftype;
7468 if (!defined $file_hash && defined $file_name) {
7469 # some commits could have deleted file in question,
7470 # and not have it in tree, but one of them has to have it
7471 for (my $i = 0; $i < @commitlist; $i++) {
7472 $file_hash = git_get_hash_by_path($commitlist[$i]{'id'}, $file_name);
7473 last if defined $file_hash;
7476 if (defined $file_hash) {
7477 $ftype = git_get_type($file_hash);
7479 if (defined $file_name && !defined $ftype) {
7480 die_error(500, "Unknown type of object");
7482 my %co;
7483 if (defined $file_name) {
7484 %co = parse_commit($base)
7485 or die_error(404, "Unknown commit object");
7489 my $paging_nav = format_paging_nav($fmt_name, $page, $#commitlist >= 100);
7490 my $next_link = '';
7491 if ($#commitlist >= 100) {
7492 $next_link =
7493 $cgi->a({-href => href(-replay=>1, page=>$page+1),
7494 -accesskey => "n", -title => "Alt-n"}, "next");
7496 my $patch_max = gitweb_get_feature('patches');
7497 if ($patch_max && !defined $file_name &&
7498 !gitweb_check_feature('email-privacy')) {
7499 if ($patch_max < 0 || @commitlist <= $patch_max) {
7500 $paging_nav .= " &sdot; " .
7501 $cgi->a({-href => href(action=>"patches", -replay=>1)},
7502 "patches");
7506 git_header_html();
7507 git_print_page_nav($fmt_name,'', $hash,$hash,$hash, $paging_nav);
7508 if (defined $file_name) {
7509 git_print_header_div('commit', esc_html($co{'title'}), $base);
7510 } else {
7511 git_print_header_div('summary', $project)
7513 git_print_page_path($file_name, $ftype, $hash_base)
7514 if (defined $file_name);
7516 $body_subr->(\@commitlist, 0, 99, $refs, $next_link,
7517 $file_name, $file_hash, $ftype);
7519 git_footer_html();
7522 sub git_log {
7523 git_log_generic('log', \&git_log_body,
7524 $hash, $hash_parent);
7527 sub git_commit {
7528 $hash ||= $hash_base || "HEAD";
7529 my %co = parse_commit($hash)
7530 or die_error(404, "Unknown commit object");
7532 my $parent = $co{'parent'};
7533 my $parents = $co{'parents'}; # listref
7535 # we need to prepare $formats_nav before any parameter munging
7536 my $formats_nav;
7537 if (!defined $parent) {
7538 # --root commitdiff
7539 $formats_nav .= '(initial)';
7540 } elsif (@$parents == 1) {
7541 # single parent commit
7542 $formats_nav .=
7543 '(parent: ' .
7544 $cgi->a({-href => href(action=>"commit",
7545 hash=>$parent)},
7546 esc_html(substr($parent, 0, 7))) .
7547 ')';
7548 } else {
7549 # merge commit
7550 $formats_nav .=
7551 '(merge: ' .
7552 join(' ', map {
7553 $cgi->a({-href => href(action=>"commit",
7554 hash=>$_)},
7555 esc_html(substr($_, 0, 7)));
7556 } @$parents ) .
7557 ')';
7559 if (gitweb_check_feature('patches') && @$parents <= 1 &&
7560 !gitweb_check_feature('email-privacy')) {
7561 $formats_nav .= " | " .
7562 $cgi->a({-href => href(action=>"patch", -replay=>1)},
7563 "patch");
7566 if (!defined $parent) {
7567 $parent = "--root";
7569 my @difftree;
7570 open my $fd, "-|", git_cmd(), "diff-tree", '-r', "--no-commit-id",
7571 @diff_opts,
7572 (@$parents <= 1 ? $parent : '-c'),
7573 $hash, "--"
7574 or die_error(500, "Open git-diff-tree failed");
7575 @difftree = map { chomp; $_ } <$fd>;
7576 close $fd or die_error(404, "Reading git-diff-tree failed");
7578 # non-textual hash id's can be cached
7579 my $expires;
7580 if ($hash =~ m/^$oid_regex$/) {
7581 $expires = "+1d";
7583 my $refs = git_get_references();
7584 my $ref = format_ref_marker($refs, $co{'id'});
7586 git_header_html(undef, $expires);
7587 git_print_page_nav('commit', '',
7588 $hash, $co{'tree'}, $hash,
7589 $formats_nav);
7591 if (defined $co{'parent'}) {
7592 git_print_header_div('commitdiff', esc_html($co{'title'}) . $ref, $hash);
7593 } else {
7594 git_print_header_div('tree', esc_html($co{'title'}) . $ref, $co{'tree'}, $hash);
7596 print "<div class=\"title_text\">\n" .
7597 "<table class=\"object_header\">\n";
7598 git_print_authorship_rows(\%co);
7599 print "<tr><td>commit</td><td class=\"sha1\">$co{'id'}</td></tr>\n";
7600 print "<tr>" .
7601 "<td>tree</td>" .
7602 "<td class=\"sha1\">" .
7603 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash),
7604 class => "list"}, $co{'tree'}) .
7605 "</td>" .
7606 "<td class=\"link\">" .
7607 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash)},
7608 "tree");
7609 my $snapshot_links = format_snapshot_links($hash);
7610 if (defined $snapshot_links) {
7611 print " | " . $snapshot_links;
7613 print "</td>" .
7614 "</tr>\n";
7616 foreach my $par (@$parents) {
7617 print "<tr>" .
7618 "<td>parent</td>" .
7619 "<td class=\"sha1\">" .
7620 $cgi->a({-href => href(action=>"commit", hash=>$par),
7621 class => "list"}, $par) .
7622 "</td>" .
7623 "<td class=\"link\">" .
7624 $cgi->a({-href => href(action=>"commit", hash=>$par)}, "commit") .
7625 " | " .
7626 $cgi->a({-href => href(action=>"commitdiff", hash=>$hash, hash_parent=>$par)}, "diff") .
7627 "</td>" .
7628 "</tr>\n";
7630 print "</table>".
7631 "</div>\n";
7633 print "<div class=\"page_body\">\n";
7634 git_print_log($co{'comment'});
7635 print "</div>\n";
7637 git_difftree_body(\@difftree, $hash, @$parents);
7639 git_footer_html();
7642 sub git_object {
7643 # object is defined by:
7644 # - hash or hash_base alone
7645 # - hash_base and file_name
7646 my $type;
7648 # - hash or hash_base alone
7649 if ($hash || ($hash_base && !defined $file_name)) {
7650 my $object_id = $hash || $hash_base;
7652 open my $fd, "-|", quote_command(
7653 git_cmd(), 'cat-file', '-t', $object_id) . ' 2> /dev/null'
7654 or die_error(404, "Object does not exist");
7655 $type = <$fd>;
7656 defined $type && chomp $type;
7657 close $fd
7658 or die_error(404, "Object does not exist");
7660 # - hash_base and file_name
7661 } elsif ($hash_base && defined $file_name) {
7662 $file_name =~ s,/+$,,;
7664 system(git_cmd(), "cat-file", '-e', $hash_base) == 0
7665 or die_error(404, "Base object does not exist");
7667 # here errors should not happen
7668 open my $fd, "-|", git_cmd(), "ls-tree", $hash_base, "--", $file_name
7669 or die_error(500, "Open git-ls-tree failed");
7670 my $line = <$fd>;
7671 close $fd;
7673 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
7674 unless ($line && $line =~ m/^([0-9]+) (.+) ($oid_regex)\t/) {
7675 die_error(404, "File or directory for given base does not exist");
7677 $type = $2;
7678 $hash = $3;
7679 } else {
7680 die_error(400, "Not enough information to find object");
7683 print $cgi->redirect(-uri => href(action=>$type, -full=>1,
7684 hash=>$hash, hash_base=>$hash_base,
7685 file_name=>$file_name),
7686 -status => '302 Found');
7689 sub git_blobdiff {
7690 my $format = shift || 'html';
7691 my $diff_style = $input_params{'diff_style'} || 'inline';
7693 my $fd;
7694 my @difftree;
7695 my %diffinfo;
7696 my $expires;
7698 # preparing $fd and %diffinfo for git_patchset_body
7699 # new style URI
7700 if (defined $hash_base && defined $hash_parent_base) {
7701 if (defined $file_name) {
7702 # read raw output
7703 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7704 $hash_parent_base, $hash_base,
7705 "--", (defined $file_parent ? $file_parent : ()), $file_name
7706 or die_error(500, "Open git-diff-tree failed");
7707 @difftree = map { chomp; $_ } <$fd>;
7708 close $fd
7709 or die_error(404, "Reading git-diff-tree failed");
7710 @difftree
7711 or die_error(404, "Blob diff not found");
7713 } elsif (defined $hash &&
7714 $hash =~ $oid_regex) {
7715 # try to find filename from $hash
7717 # read filtered raw output
7718 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7719 $hash_parent_base, $hash_base, "--"
7720 or die_error(500, "Open git-diff-tree failed");
7721 @difftree =
7722 # ':100644 100644 03b21826... 3b93d5e7... M ls-files.c'
7723 # $hash == to_id
7724 grep { /^:[0-7]{6} [0-7]{6} $oid_regex $hash/ }
7725 map { chomp; $_ } <$fd>;
7726 close $fd
7727 or die_error(404, "Reading git-diff-tree failed");
7728 @difftree
7729 or die_error(404, "Blob diff not found");
7731 } else {
7732 die_error(400, "Missing one of the blob diff parameters");
7735 if (@difftree > 1) {
7736 die_error(400, "Ambiguous blob diff specification");
7739 %diffinfo = parse_difftree_raw_line($difftree[0]);
7740 $file_parent ||= $diffinfo{'from_file'} || $file_name;
7741 $file_name ||= $diffinfo{'to_file'};
7743 $hash_parent ||= $diffinfo{'from_id'};
7744 $hash ||= $diffinfo{'to_id'};
7746 # non-textual hash id's can be cached
7747 if ($hash_base =~ m/^$oid_regex$/ &&
7748 $hash_parent_base =~ m/^$oid_regex$/) {
7749 $expires = '+1d';
7752 # open patch output
7753 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7754 '-p', ($format eq 'html' ? "--full-index" : ()),
7755 $hash_parent_base, $hash_base,
7756 "--", (defined $file_parent ? $file_parent : ()), $file_name
7757 or die_error(500, "Open git-diff-tree failed");
7760 # old/legacy style URI -- not generated anymore since 1.4.3.
7761 if (!%diffinfo) {
7762 die_error('404 Not Found', "Missing one of the blob diff parameters")
7765 # header
7766 if ($format eq 'html') {
7767 my $formats_nav =
7768 $cgi->a({-href => href(action=>"blobdiff_plain", -replay=>1)},
7769 "raw");
7770 $formats_nav .= diff_style_nav($diff_style);
7771 git_header_html(undef, $expires);
7772 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7773 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
7774 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
7775 } else {
7776 print "<div class=\"page_nav\"><br/>$formats_nav<br/></div>\n";
7777 print "<div class=\"title\">".esc_html("$hash vs $hash_parent")."</div>\n";
7779 if (defined $file_name) {
7780 git_print_page_path($file_name, "blob", $hash_base);
7781 } else {
7782 print "<div class=\"page_path\"></div>\n";
7785 } elsif ($format eq 'plain') {
7786 print $cgi->header(
7787 -type => 'text/plain',
7788 -charset => 'utf-8',
7789 -expires => $expires,
7790 -content_disposition => 'inline; filename="' . "$file_name" . '.patch"');
7792 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
7794 } else {
7795 die_error(400, "Unknown blobdiff format");
7798 # patch
7799 if ($format eq 'html') {
7800 print "<div class=\"page_body\">\n";
7802 git_patchset_body($fd, $diff_style,
7803 [ \%diffinfo ], $hash_base, $hash_parent_base);
7804 close $fd;
7806 print "</div>\n"; # class="page_body"
7807 git_footer_html();
7809 } else {
7810 while (my $line = <$fd>) {
7811 $line =~ s!a/($hash|$hash_parent)!'a/'.esc_path($diffinfo{'from_file'})!eg;
7812 $line =~ s!b/($hash|$hash_parent)!'b/'.esc_path($diffinfo{'to_file'})!eg;
7814 print $line;
7816 last if $line =~ m!^\+\+\+!;
7818 local $/ = undef;
7819 print <$fd>;
7820 close $fd;
7824 sub git_blobdiff_plain {
7825 git_blobdiff('plain');
7828 # assumes that it is added as later part of already existing navigation,
7829 # so it returns "| foo | bar" rather than just "foo | bar"
7830 sub diff_style_nav {
7831 my ($diff_style, $is_combined) = @_;
7832 $diff_style ||= 'inline';
7834 return "" if ($is_combined);
7836 my @styles = (inline => 'inline', 'sidebyside' => 'side by side');
7837 my %styles = @styles;
7838 @styles =
7839 @styles[ map { $_ * 2 } 0..$#styles/2 ];
7841 return join '',
7842 map { " | ".$_ }
7843 map {
7844 $_ eq $diff_style ? $styles{$_} :
7845 $cgi->a({-href => href(-replay=>1, diff_style => $_)}, $styles{$_})
7846 } @styles;
7849 sub git_commitdiff {
7850 my %params = @_;
7851 my $format = $params{-format} || 'html';
7852 my $diff_style = $input_params{'diff_style'} || 'inline';
7854 my ($patch_max) = gitweb_get_feature('patches');
7855 if ($format eq 'patch') {
7856 die_error(403, "Patch view not allowed") unless $patch_max;
7859 $hash ||= $hash_base || "HEAD";
7860 my %co = parse_commit($hash)
7861 or die_error(404, "Unknown commit object");
7863 # choose format for commitdiff for merge
7864 if (! defined $hash_parent && @{$co{'parents'}} > 1) {
7865 $hash_parent = '--cc';
7867 # we need to prepare $formats_nav before almost any parameter munging
7868 my $formats_nav;
7869 if ($format eq 'html') {
7870 $formats_nav =
7871 $cgi->a({-href => href(action=>"commitdiff_plain", -replay=>1)},
7872 "raw");
7873 if ($patch_max && @{$co{'parents'}} <= 1 &&
7874 !gitweb_check_feature('email-privacy')) {
7875 $formats_nav .= " | " .
7876 $cgi->a({-href => href(action=>"patch", -replay=>1)},
7877 "patch");
7879 $formats_nav .= diff_style_nav($diff_style, @{$co{'parents'}} > 1);
7881 if (defined $hash_parent &&
7882 $hash_parent ne '-c' && $hash_parent ne '--cc') {
7883 # commitdiff with two commits given
7884 my $hash_parent_short = $hash_parent;
7885 if ($hash_parent =~ m/^$oid_regex$/) {
7886 $hash_parent_short = substr($hash_parent, 0, 7);
7888 $formats_nav .=
7889 ' (from';
7890 for (my $i = 0; $i < @{$co{'parents'}}; $i++) {
7891 if ($co{'parents'}[$i] eq $hash_parent) {
7892 $formats_nav .= ' parent ' . ($i+1);
7893 last;
7896 $formats_nav .= ': ' .
7897 $cgi->a({-href => href(-replay=>1,
7898 hash=>$hash_parent, hash_base=>undef)},
7899 esc_html($hash_parent_short)) .
7900 ')';
7901 } elsif (!$co{'parent'}) {
7902 # --root commitdiff
7903 $formats_nav .= ' (initial)';
7904 } elsif (scalar @{$co{'parents'}} == 1) {
7905 # single parent commit
7906 $formats_nav .=
7907 ' (parent: ' .
7908 $cgi->a({-href => href(-replay=>1,
7909 hash=>$co{'parent'}, hash_base=>undef)},
7910 esc_html(substr($co{'parent'}, 0, 7))) .
7911 ')';
7912 } else {
7913 # merge commit
7914 if ($hash_parent eq '--cc') {
7915 $formats_nav .= ' | ' .
7916 $cgi->a({-href => href(-replay=>1,
7917 hash=>$hash, hash_parent=>'-c')},
7918 'combined');
7919 } else { # $hash_parent eq '-c'
7920 $formats_nav .= ' | ' .
7921 $cgi->a({-href => href(-replay=>1,
7922 hash=>$hash, hash_parent=>'--cc')},
7923 'compact');
7925 $formats_nav .=
7926 ' (merge: ' .
7927 join(' ', map {
7928 $cgi->a({-href => href(-replay=>1,
7929 hash=>$_, hash_base=>undef)},
7930 esc_html(substr($_, 0, 7)));
7931 } @{$co{'parents'}} ) .
7932 ')';
7936 my $hash_parent_param = $hash_parent;
7937 if (!defined $hash_parent_param) {
7938 # --cc for multiple parents, --root for parentless
7939 $hash_parent_param =
7940 @{$co{'parents'}} > 1 ? '--cc' : $co{'parent'} || '--root';
7943 # read commitdiff
7944 my $fd;
7945 my @difftree;
7946 if ($format eq 'html') {
7947 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7948 "--no-commit-id", "--patch-with-raw", "--full-index",
7949 $hash_parent_param, $hash, "--"
7950 or die_error(500, "Open git-diff-tree failed");
7952 while (my $line = <$fd>) {
7953 chomp $line;
7954 # empty line ends raw part of diff-tree output
7955 last unless $line;
7956 push @difftree, scalar parse_difftree_raw_line($line);
7959 } elsif ($format eq 'plain') {
7960 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7961 '-p', $hash_parent_param, $hash, "--"
7962 or die_error(500, "Open git-diff-tree failed");
7963 } elsif ($format eq 'patch') {
7964 # For commit ranges, we limit the output to the number of
7965 # patches specified in the 'patches' feature.
7966 # For single commits, we limit the output to a single patch,
7967 # diverging from the git-format-patch default.
7968 my @commit_spec = ();
7969 if ($hash_parent) {
7970 if ($patch_max > 0) {
7971 push @commit_spec, "-$patch_max";
7973 push @commit_spec, '-n', "$hash_parent..$hash";
7974 } else {
7975 if ($params{-single}) {
7976 push @commit_spec, '-1';
7977 } else {
7978 if ($patch_max > 0) {
7979 push @commit_spec, "-$patch_max";
7981 push @commit_spec, "-n";
7983 push @commit_spec, '--root', $hash;
7985 open $fd, "-|", git_cmd(), "format-patch", @diff_opts,
7986 '--encoding=utf8', '--stdout', @commit_spec
7987 or die_error(500, "Open git-format-patch failed");
7988 } else {
7989 die_error(400, "Unknown commitdiff format");
7992 # non-textual hash id's can be cached
7993 my $expires;
7994 if ($hash =~ m/^$oid_regex$/) {
7995 $expires = "+1d";
7998 # write commit message
7999 if ($format eq 'html') {
8000 my $refs = git_get_references();
8001 my $ref = format_ref_marker($refs, $co{'id'});
8003 git_header_html(undef, $expires);
8004 git_print_page_nav('commitdiff','', $hash,$co{'tree'},$hash, $formats_nav);
8005 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash);
8006 print "<div class=\"title_text\">\n" .
8007 "<table class=\"object_header\">\n";
8008 git_print_authorship_rows(\%co);
8009 print "</table>".
8010 "</div>\n";
8011 print "<div class=\"page_body\">\n";
8012 if (@{$co{'comment'}} > 1) {
8013 print "<div class=\"log\">\n";
8014 git_print_log($co{'comment'}, -final_empty_line=> 1, -remove_title => 1);
8015 print "</div>\n"; # class="log"
8018 } elsif ($format eq 'plain') {
8019 my $refs = git_get_references("tags");
8020 my $tagname = git_get_rev_name_tags($hash);
8021 my $filename = basename($project) . "-$hash.patch";
8023 print $cgi->header(
8024 -type => 'text/plain',
8025 -charset => 'utf-8',
8026 -expires => $expires,
8027 -content_disposition => 'inline; filename="' . "$filename" . '"');
8028 my %ad = parse_date($co{'author_epoch'}, $co{'author_tz'});
8029 print "From: " . to_utf8($co{'author'}) . "\n";
8030 print "Date: $ad{'rfc2822'} ($ad{'tz_local'})\n";
8031 print "Subject: " . to_utf8($co{'title'}) . "\n";
8033 print "X-Git-Tag: $tagname\n" if $tagname;
8034 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
8036 foreach my $line (@{$co{'comment'}}) {
8037 print to_utf8($line) . "\n";
8039 print "---\n\n";
8040 } elsif ($format eq 'patch') {
8041 my $filename = basename($project) . "-$hash.patch";
8043 print $cgi->header(
8044 -type => 'text/plain',
8045 -charset => 'utf-8',
8046 -expires => $expires,
8047 -content_disposition => 'inline; filename="' . "$filename" . '"');
8050 # write patch
8051 if ($format eq 'html') {
8052 my $use_parents = !defined $hash_parent ||
8053 $hash_parent eq '-c' || $hash_parent eq '--cc';
8054 git_difftree_body(\@difftree, $hash,
8055 $use_parents ? @{$co{'parents'}} : $hash_parent);
8056 print "<br/>\n";
8058 git_patchset_body($fd, $diff_style,
8059 \@difftree, $hash,
8060 $use_parents ? @{$co{'parents'}} : $hash_parent);
8061 close $fd;
8062 print "</div>\n"; # class="page_body"
8063 git_footer_html();
8065 } elsif ($format eq 'plain') {
8066 local $/ = undef;
8067 print <$fd>;
8068 close $fd
8069 or print "Reading git-diff-tree failed\n";
8070 } elsif ($format eq 'patch') {
8071 local $/ = undef;
8072 print <$fd>;
8073 close $fd
8074 or print "Reading git-format-patch failed\n";
8078 sub git_commitdiff_plain {
8079 git_commitdiff(-format => 'plain');
8082 # format-patch-style patches
8083 sub git_patch {
8084 git_commitdiff(-format => 'patch', -single => 1);
8087 sub git_patches {
8088 git_commitdiff(-format => 'patch');
8091 sub git_history {
8092 git_log_generic('history', \&git_history_body,
8093 $hash_base, $hash_parent_base,
8094 $file_name, $hash);
8097 sub git_search {
8098 $searchtype ||= 'commit';
8100 # check if appropriate features are enabled
8101 gitweb_check_feature('search')
8102 or die_error(403, "Search is disabled");
8103 if ($searchtype eq 'pickaxe') {
8104 # pickaxe may take all resources of your box and run for several minutes
8105 # with every query - so decide by yourself how public you make this feature
8106 gitweb_check_feature('pickaxe')
8107 or die_error(403, "Pickaxe search is disabled");
8109 if ($searchtype eq 'grep') {
8110 # grep search might be potentially CPU-intensive, too
8111 gitweb_check_feature('grep')
8112 or die_error(403, "Grep search is disabled");
8115 if (!defined $searchtext) {
8116 die_error(400, "Text field is empty");
8118 if (!defined $hash) {
8119 $hash = git_get_head_hash($project);
8121 my %co = parse_commit($hash);
8122 if (!%co) {
8123 die_error(404, "Unknown commit object");
8125 if (!defined $page) {
8126 $page = 0;
8129 if ($searchtype eq 'commit' ||
8130 $searchtype eq 'author' ||
8131 $searchtype eq 'committer') {
8132 git_search_message(%co);
8133 } elsif ($searchtype eq 'pickaxe') {
8134 git_search_changes(%co);
8135 } elsif ($searchtype eq 'grep') {
8136 git_search_files(%co);
8137 } else {
8138 die_error(400, "Unknown search type");
8142 sub git_search_help {
8143 git_header_html();
8144 git_print_page_nav('','', $hash,$hash,$hash);
8145 print <<EOT;
8146 <p><strong>Pattern</strong> is by default a normal string that is matched precisely (but without
8147 regard to case, except in the case of pickaxe). However, when you check the <em>re</em> checkbox,
8148 the pattern entered is recognized as the POSIX extended
8149 <a href="https://en.wikipedia.org/wiki/Regular_expression">regular expression</a> (also case
8150 insensitive).</p>
8151 <dl>
8152 <dt><b>commit</b></dt>
8153 <dd>The commit messages and authorship information will be scanned for the given pattern.</dd>
8155 my $have_grep = gitweb_check_feature('grep');
8156 if ($have_grep) {
8157 print <<EOT;
8158 <dt><b>grep</b></dt>
8159 <dd>All files in the currently selected tree (HEAD unless you are explicitly browsing
8160 a different one) are searched for the given pattern. On large trees, this search can take
8161 a while and put some strain on the server, so please use it with some consideration. Note that
8162 due to git-grep peculiarity, currently if regexp mode is turned off, the matches are
8163 case-sensitive.</dd>
8166 print <<EOT;
8167 <dt><b>author</b></dt>
8168 <dd>Name and e-mail of the change author and date of birth of the patch will be scanned for the given pattern.</dd>
8169 <dt><b>committer</b></dt>
8170 <dd>Name and e-mail of the committer and date of commit will be scanned for the given pattern.</dd>
8172 my $have_pickaxe = gitweb_check_feature('pickaxe');
8173 if ($have_pickaxe) {
8174 print <<EOT;
8175 <dt><b>pickaxe</b></dt>
8176 <dd>All commits that caused the string to appear or disappear from any file (changes that
8177 added, removed or "modified" the string) will be listed. This search can take a while and
8178 takes a lot of strain on the server, so please use it wisely. Note that since you may be
8179 interested even in changes just changing the case as well, this search is case sensitive.</dd>
8182 print "</dl>\n";
8183 git_footer_html();
8186 sub git_shortlog {
8187 git_log_generic('shortlog', \&git_shortlog_body,
8188 $hash, $hash_parent);
8191 ## ......................................................................
8192 ## feeds (RSS, Atom; OPML)
8194 sub git_feed {
8195 my $format = shift || 'atom';
8196 my $have_blame = gitweb_check_feature('blame');
8198 # Atom: http://www.atomenabled.org/developers/syndication/
8199 # RSS: https://web.archive.org/web/20030729001534/http://www.notestips.com/80256B3A007F2692/1/NAMO5P9UPQ
8200 if ($format ne 'rss' && $format ne 'atom') {
8201 die_error(400, "Unknown web feed format");
8204 # log/feed of current (HEAD) branch, log of given branch, history of file/directory
8205 my $head = $hash || 'HEAD';
8206 my @commitlist = parse_commits($head, 150, 0, $file_name);
8208 my %latest_commit;
8209 my %latest_date;
8210 my $content_type = "application/$format+xml";
8211 if (defined $cgi->http('HTTP_ACCEPT') &&
8212 $cgi->Accept('text/xml') > $cgi->Accept($content_type)) {
8213 # browser (feed reader) prefers text/xml
8214 $content_type = 'text/xml';
8216 if (defined($commitlist[0])) {
8217 %latest_commit = %{$commitlist[0]};
8218 my $latest_epoch = $latest_commit{'committer_epoch'};
8219 exit_if_unmodified_since($latest_epoch);
8220 %latest_date = parse_date($latest_epoch, $latest_commit{'committer_tz'});
8222 print $cgi->header(
8223 -type => $content_type,
8224 -charset => 'utf-8',
8225 %latest_date ? (-last_modified => $latest_date{'rfc2822'}) : (),
8226 -status => '200 OK');
8228 # Optimization: skip generating the body if client asks only
8229 # for Last-Modified date.
8230 return if ($cgi->request_method() eq 'HEAD');
8232 # header variables
8233 my $title = "$site_name - $project/$action";
8234 my $feed_type = 'log';
8235 if (defined $hash) {
8236 $title .= " - '$hash'";
8237 $feed_type = 'branch log';
8238 if (defined $file_name) {
8239 $title .= " :: $file_name";
8240 $feed_type = 'history';
8242 } elsif (defined $file_name) {
8243 $title .= " - $file_name";
8244 $feed_type = 'history';
8246 $title .= " $feed_type";
8247 $title = esc_html($title);
8248 my $descr = git_get_project_description($project);
8249 if (defined $descr) {
8250 $descr = esc_html($descr);
8251 } else {
8252 $descr = "$project " .
8253 ($format eq 'rss' ? 'RSS' : 'Atom') .
8254 " feed";
8256 my $owner = git_get_project_owner($project);
8257 $owner = esc_html($owner);
8259 #header
8260 my $alt_url;
8261 if (defined $file_name) {
8262 $alt_url = href(-full=>1, action=>"history", hash=>$hash, file_name=>$file_name);
8263 } elsif (defined $hash) {
8264 $alt_url = href(-full=>1, action=>"log", hash=>$hash);
8265 } else {
8266 $alt_url = href(-full=>1, action=>"summary");
8268 $alt_url = esc_attr($alt_url);
8269 print qq!<?xml version="1.0" encoding="utf-8"?>\n!;
8270 if ($format eq 'rss') {
8271 print <<XML;
8272 <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
8273 <channel>
8275 print "<title>$title</title>\n" .
8276 "<link>$alt_url</link>\n" .
8277 "<description>$descr</description>\n" .
8278 "<language>en</language>\n" .
8279 # project owner is responsible for 'editorial' content
8280 "<managingEditor>$owner</managingEditor>\n";
8281 if (defined $logo || defined $favicon) {
8282 # prefer the logo to the favicon, since RSS
8283 # doesn't allow both
8284 my $img = esc_url($logo || $favicon);
8285 print "<image>\n" .
8286 "<url>$img</url>\n" .
8287 "<title>$title</title>\n" .
8288 "<link>$alt_url</link>\n" .
8289 "</image>\n";
8291 if (%latest_date) {
8292 print "<pubDate>$latest_date{'rfc2822'}</pubDate>\n";
8293 print "<lastBuildDate>$latest_date{'rfc2822'}</lastBuildDate>\n";
8295 print "<generator>gitweb v.$version/$git_version</generator>\n";
8296 } elsif ($format eq 'atom') {
8297 print <<XML;
8298 <feed xmlns="http://www.w3.org/2005/Atom">
8300 print "<title>$title</title>\n" .
8301 "<subtitle>$descr</subtitle>\n" .
8302 '<link rel="alternate" type="text/html" href="' .
8303 $alt_url . '" />' . "\n" .
8304 '<link rel="self" type="' . $content_type . '" href="' .
8305 $cgi->self_url() . '" />' . "\n" .
8306 "<id>" . esc_url(href(-full=>1)) . "</id>\n" .
8307 # use project owner for feed author
8308 "<author><name>$owner</name></author>\n";
8309 if (defined $favicon) {
8310 print "<icon>" . esc_url($favicon) . "</icon>\n";
8312 if (defined $logo) {
8313 # not twice as wide as tall: 72 x 27 pixels
8314 print "<logo>" . esc_url($logo) . "</logo>\n";
8316 if (! %latest_date) {
8317 # dummy date to keep the feed valid until commits trickle in:
8318 print "<updated>1970-01-01T00:00:00Z</updated>\n";
8319 } else {
8320 print "<updated>$latest_date{'iso-8601'}</updated>\n";
8322 print "<generator version='$version/$git_version'>gitweb</generator>\n";
8325 # contents
8326 for (my $i = 0; $i <= $#commitlist; $i++) {
8327 my %co = %{$commitlist[$i]};
8328 my $commit = $co{'id'};
8329 # we read 150, we always show 30 and the ones more recent than 48 hours
8330 if (($i >= 20) && ((time - $co{'committer_epoch'}) > 48*60*60)) {
8331 last;
8333 my %cd = parse_date($co{'committer_epoch'}, $co{'committer_tz'});
8335 # get list of changed files
8336 open my $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
8337 $co{'parent'} || "--root",
8338 $co{'id'}, "--", (defined $file_name ? $file_name : ())
8339 or next;
8340 my @difftree = map { chomp; $_ } <$fd>;
8341 close $fd
8342 or next;
8344 # print element (entry, item)
8345 my $co_url = href(-full=>1, action=>"commitdiff", hash=>$commit);
8346 if ($format eq 'rss') {
8347 print "<item>\n" .
8348 "<title>" . esc_html($co{'title'}) . "</title>\n" .
8349 "<author>" . esc_html($co{'author'}) . "</author>\n" .
8350 "<pubDate>$cd{'rfc2822'}</pubDate>\n" .
8351 "<guid isPermaLink=\"true\">$co_url</guid>\n" .
8352 "<link>" . esc_html($co_url) . "</link>\n" .
8353 "<description>" . esc_html($co{'title'}) . "</description>\n" .
8354 "<content:encoded>" .
8355 "<![CDATA[\n";
8356 } elsif ($format eq 'atom') {
8357 print "<entry>\n" .
8358 "<title type=\"html\">" . esc_html($co{'title'}) . "</title>\n" .
8359 "<updated>$cd{'iso-8601'}</updated>\n" .
8360 "<author>\n" .
8361 " <name>" . esc_html($co{'author_name'}) . "</name>\n";
8362 if ($co{'author_email'}) {
8363 print " <email>" . esc_html($co{'author_email'}) . "</email>\n";
8365 print "</author>\n" .
8366 # use committer for contributor
8367 "<contributor>\n" .
8368 " <name>" . esc_html($co{'committer_name'}) . "</name>\n";
8369 if ($co{'committer_email'}) {
8370 print " <email>" . esc_html($co{'committer_email'}) . "</email>\n";
8372 print "</contributor>\n" .
8373 "<published>$cd{'iso-8601'}</published>\n" .
8374 "<link rel=\"alternate\" type=\"text/html\" href=\"" . esc_attr($co_url) . "\" />\n" .
8375 "<id>" . esc_html($co_url) . "</id>\n" .
8376 "<content type=\"xhtml\" xml:base=\"" . esc_url($my_url) . "\">\n" .
8377 "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n";
8379 my $comment = $co{'comment'};
8380 print "<pre>\n";
8381 foreach my $line (@$comment) {
8382 $line = esc_html($line);
8383 print "$line\n";
8385 print "</pre><ul>\n";
8386 foreach my $difftree_line (@difftree) {
8387 my %difftree = parse_difftree_raw_line($difftree_line);
8388 next if !$difftree{'from_id'};
8390 my $file = $difftree{'file'} || $difftree{'to_file'};
8392 print "<li>" .
8393 "[" .
8394 $cgi->a({-href => href(-full=>1, action=>"blobdiff",
8395 hash=>$difftree{'to_id'}, hash_parent=>$difftree{'from_id'},
8396 hash_base=>$co{'id'}, hash_parent_base=>$co{'parent'},
8397 file_name=>$file, file_parent=>$difftree{'from_file'}),
8398 -title => "diff"}, 'D');
8399 if ($have_blame) {
8400 print $cgi->a({-href => href(-full=>1, action=>"blame",
8401 file_name=>$file, hash_base=>$commit),
8402 -title => "blame"}, 'B');
8404 # if this is not a feed of a file history
8405 if (!defined $file_name || $file_name ne $file) {
8406 print $cgi->a({-href => href(-full=>1, action=>"history",
8407 file_name=>$file, hash=>$commit),
8408 -title => "history"}, 'H');
8410 $file = esc_path($file);
8411 print "] ".
8412 "$file</li>\n";
8414 if ($format eq 'rss') {
8415 print "</ul>]]>\n" .
8416 "</content:encoded>\n" .
8417 "</item>\n";
8418 } elsif ($format eq 'atom') {
8419 print "</ul>\n</div>\n" .
8420 "</content>\n" .
8421 "</entry>\n";
8425 # end of feed
8426 if ($format eq 'rss') {
8427 print "</channel>\n</rss>\n";
8428 } elsif ($format eq 'atom') {
8429 print "</feed>\n";
8433 sub git_rss {
8434 git_feed('rss');
8437 sub git_atom {
8438 git_feed('atom');
8441 sub git_opml {
8442 my @list = git_get_projects_list($project_filter, $strict_export);
8443 if (!@list) {
8444 die_error(404, "No projects found");
8447 print $cgi->header(
8448 -type => 'text/xml',
8449 -charset => 'utf-8',
8450 -content_disposition => 'inline; filename="opml.xml"');
8452 my $title = esc_html($site_name);
8453 my $filter = " within subdirectory ";
8454 if (defined $project_filter) {
8455 $filter .= esc_html($project_filter);
8456 } else {
8457 $filter = "";
8459 print <<XML;
8460 <?xml version="1.0" encoding="utf-8"?>
8461 <opml version="1.0">
8462 <head>
8463 <title>$title OPML Export$filter</title>
8464 </head>
8465 <body>
8466 <outline text="git RSS feeds">
8469 foreach my $pr (@list) {
8470 my %proj = %$pr;
8471 my $head = git_get_head_hash($proj{'path'});
8472 if (!defined $head) {
8473 next;
8475 $git_dir = "$projectroot/$proj{'path'}";
8476 my %co = parse_commit($head);
8477 if (!%co) {
8478 next;
8481 my $path = esc_html(chop_str($proj{'path'}, 25, 5));
8482 my $rss = esc_attr(href('project' => $proj{'path'}, 'action' => 'rss', -full => 1));
8483 my $html = esc_attr(href('project' => $proj{'path'}, 'action' => 'summary', -full => 1));
8484 print "<outline type=\"rss\" text=\"$path\" title=\"$path\" xmlUrl=\"$rss\" htmlUrl=\"$html\"/>\n";
8486 print <<XML;
8487 </outline>
8488 </body>
8489 </opml>