Merge branch 'ds/close-object-store' into maint
[git/git.git] / gitweb / gitweb.perl
1 #!/usr/bin/perl
2
3 # gitweb - simple web interface to track changes in git repositories
4 #
5 # (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
6 # (C) 2005, Christian Gierke
7 #
8 # This program is licensed under the GPLv2
9
10 use 5.008;
11 use strict;
12 use warnings;
13 # handle ACL in file access tests
14 use filetest 'access';
15 use CGI qw(:standard :escapeHTML -nosticky);
16 use CGI::Util qw(unescape);
17 use CGI::Carp qw(fatalsToBrowser set_message);
18 use Encode;
19 use Fcntl ':mode';
20 use File::Find qw();
21 use File::Basename qw(basename);
22 use Time::HiRes qw(gettimeofday tv_interval);
23 use Digest::MD5 qw(md5_hex);
24
25 binmode STDOUT, ':utf8';
26
27 if (!defined($CGI::VERSION) || $CGI::VERSION < 4.08) {
28 eval 'sub CGI::multi_param { CGI::param(@_) }'
29 }
30
31 our $t0 = [ gettimeofday() ];
32 our $number_of_git_cmds = 0;
33
34 BEGIN {
35 CGI->compile() if $ENV{'MOD_PERL'};
36 }
37
38 our $version = "++GIT_VERSION++";
39
40 our ($my_url, $my_uri, $base_url, $path_info, $home_link);
41 sub evaluate_uri {
42 our $cgi;
43
44 our $my_url = $cgi->url();
45 our $my_uri = $cgi->url(-absolute => 1);
46
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;
50
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.
55 #
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'};
74 }
75 }
76
77 # target of the home link on top of all pages
78 our $home_link = $my_uri || "/";
79 }
80
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";
84
85 # absolute fs-path which will be prepended to the project path
86 #our $projectroot = "/pub/scm";
87 our $projectroot = "++GITWEB_PROJECTROOT++";
88
89 # fs traversing limit for getting project list
90 # the number is relative to the projectroot
91 our $project_maxdepth = "++GITWEB_PROJECT_MAXDEPTH++";
92
93 # string of the home link on top of all pages
94 our $home_link_str = "++GITWEB_HOME_LINK_STR++";
95
96 # extra breadcrumbs preceding the home link
97 our @extra_breadcrumbs = ();
98
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";
103
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++";
112
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++";
123
124 # URI and label (title) of GIT logo link
125 #our $logo_url = "http://www.kernel.org/pub/software/scm/git/docs/";
126 #our $logo_label = "git documentation";
127 our $logo_url = "http://git-scm.com/";
128 our $logo_label = "git homepage";
129
130 # source of projects list
131 our $projects_list = "++GITWEB_LIST++";
132
133 # the width (in characters) of the projects list "Description" column
134 our $projects_list_description_width = 25;
135
136 # group projects by category on the projects list
137 # (enabled if this variable evaluates to true)
138 our $projects_list_group_categories = 0;
139
140 # default category if none specified
141 # (leave the empty string for no category)
142 our $project_list_default_category = "";
143
144 # default order of projects list
145 # valid values are none, project, descr, owner, and age
146 our $default_projects_order = "project";
147
148 # show repository only if this file exists
149 # (only effective if this variable evaluates to true)
150 our $export_ok = "++GITWEB_EXPORT_OK++";
151
152 # don't generate age column on the projects list page
153 our $omit_age_column = 0;
154
155 # don't generate information about owners of repositories
156 our $omit_owner=0;
157
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;
162
163 # only allow viewing of repositories also shown on the overview page
164 our $strict_export = "++GITWEB_STRICT_EXPORT++";
165
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++");
169
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;
173
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;
177
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';
184
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
194
195 # Disables features that would allow repository owners to inject script into
196 # the gitweb domain.
197 our $prevent_xss = 0;
198
199 # Path to the highlight executable to use (must be the one from
200 # http://www.andre-simon.de due to assumptions about parameters and output).
201 # Useful if highlight is not installed on your webserver's PATH.
202 # [Default: highlight]
203 our $highlight_bin = "++HIGHLIGHT_BIN++";
204
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)}
215 #
216 'tgz' => {
217 'display' => 'tar.gz',
218 'type' => 'application/x-gzip',
219 'suffix' => '.tar.gz',
220 'format' => 'tar',
221 'compressor' => ['gzip', '-n']},
222
223 'tbz2' => {
224 'display' => 'tar.bz2',
225 'type' => 'application/x-bzip2',
226 'suffix' => '.tar.bz2',
227 'format' => 'tar',
228 'compressor' => ['bzip2']},
229
230 'txz' => {
231 'display' => 'tar.xz',
232 'type' => 'application/x-xz',
233 'suffix' => '.tar.xz',
234 'format' => 'tar',
235 'compressor' => ['xz'],
236 'disabled' => 1},
237
238 'zip' => {
239 'display' => 'zip',
240 'type' => 'application/x-zip',
241 'suffix' => '.zip',
242 'format' => 'zip'},
243 );
244
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',
251
252 # backward compatibility: legacy gitweb config support
253 'x-gzip' => undef, 'gz' => undef,
254 'x-bzip2' => undef, 'bz2' => undef,
255 'x-zip' => undef, '' => undef,
256 );
257
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
264 );
265
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;
271
272 # configuration for 'highlight' (http://www.andre-simon.de/)
273 # match by basename
274 our %highlight_basename = (
275 #'Program' => 'py',
276 #'Library' => 'py',
277 'SConstruct' => 'py', # SCons equivalent of Makefile
278 'Makefile' => 'make',
279 );
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)),
293 );
294
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)}
302 #
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
306 #
307 # if there is no 'sub' key (no feature-sub), then feature cannot be
308 # overridden
309 #
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
313
314 # Enable the 'blame' blob view, showing the last commit that modified
315 # each line in the file. This can be very CPU-intensive.
316
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]},
326
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.
330
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']},
343
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.
347 #
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]},
354
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.
359
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]},
369
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.
374
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]},
384
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.
387
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]},
397
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.
404
405 # To enable system wide have in $GITWEB_CONFIG
406 # $feature{'pathinfo'}{'default'} = [1];
407 # Project specific override is not supported.
408
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]},
416
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.
424
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]},
431
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.
436
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 %.
443
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' => []},
451
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.
456
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.
462
463 # To enable system wide have in $GITWEB_CONFIG
464 # $feature{'ctags'}{'default'} = [1];
465 # Project specific override is not supported.
466
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]},
472
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.
476
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]},
487
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).
491
492 # Currently available providers are gravatar and picon.
493 # If an unknown provider is specified, the feature is disabled.
494
495 # Picon currently relies on the indiana.edu database.
496
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' => ['']},
507
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]},
514
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]},
521
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
532 ]},
533
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.
538
539 # To enable system wide have in $GITWEB_CONFIG
540 # $feature{'highlight'}{'default'} = [1];
541
542 'highlight' => {
543 'sub' => sub { feature_bool('highlight', @_) },
544 'override' => 0,
545 'default' => [0]},
546
547 # Enable displaying of remote heads in the heads list
548
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]},
558
559 # Enable showing branches under other refs in addition to heads
560
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.
567
568 'extra-branch-refs' => {
569 'sub' => \&feature_extra_branch_refs,
570 'override' => 0,
571 'default' => []},
572 );
573
574 sub gitweb_get_feature {
575 my ($name) = @_;
576 return unless exists $feature{$name};
577 my ($sub, $override, @defaults) = (
578 $feature{$name}{'sub'},
579 $feature{$name}{'override'},
580 @{$feature{$name}{'default'}});
581 # project specific override is possible only if we have project
582 our $git_dir; # global variable, declared later
583 if (!$override || !defined $git_dir) {
584 return @defaults;
585 }
586 if (!defined $sub) {
587 warn "feature $name is not overridable";
588 return @defaults;
589 }
590 return $sub->(@defaults);
591 }
592
593 # A wrapper to check if a given feature is enabled.
594 # With this, you can say
595 #
596 # my $bool_feat = gitweb_check_feature('bool_feat');
597 # gitweb_check_feature('bool_feat') or somecode;
598 #
599 # instead of
600 #
601 # my ($bool_feat) = gitweb_get_feature('bool_feat');
602 # (gitweb_get_feature('bool_feat'))[0] or somecode;
603 #
604 sub gitweb_check_feature {
605 return (gitweb_get_feature(@_))[0];
606 }
607
608
609 sub feature_bool {
610 my $key = shift;
611 my ($val) = git_get_project_config($key, '--bool');
612
613 if (!defined $val) {
614 return ($_[0]);
615 } elsif ($val eq 'true') {
616 return (1);
617 } elsif ($val eq 'false') {
618 return (0);
619 }
620 }
621
622 sub feature_snapshot {
623 my (@fmts) = @_;
624
625 my ($val) = git_get_project_config('snapshot');
626
627 if ($val) {
628 @fmts = ($val eq 'none' ? () : split /\s*[,\s]\s*/, $val);
629 }
630
631 return @fmts;
632 }
633
634 sub feature_patches {
635 my @val = (git_get_project_config('patches', '--int'));
636
637 if (@val) {
638 return @val;
639 }
640
641 return ($_[0]);
642 }
643
644 sub feature_avatar {
645 my @val = (git_get_project_config('avatar'));
646
647 return @val ? @val : @_;
648 }
649
650 sub feature_extra_branch_refs {
651 my (@branch_refs) = @_;
652 my $values = git_get_project_config('extrabranchrefs');
653
654 if ($values) {
655 $values = config_to_multi ($values);
656 @branch_refs = ();
657 foreach my $value (@{$values}) {
658 push @branch_refs, split /\s+/, $value;
659 }
660 }
661
662 return @branch_refs;
663 }
664
665 # checking HEAD file with -e is fragile if the repository was
666 # initialized long time ago (i.e. symlink HEAD) and was pack-ref'ed
667 # and then pruned.
668 sub check_head_link {
669 my ($dir) = @_;
670 my $headfile = "$dir/HEAD";
671 return ((-e $headfile) ||
672 (-l $headfile && readlink($headfile) =~ /^refs\/heads\//));
673 }
674
675 sub check_export_ok {
676 my ($dir) = @_;
677 return (check_head_link($dir) &&
678 (!$export_ok || -e "$dir/$export_ok") &&
679 (!$export_auth_hook || $export_auth_hook->($dir)));
680 }
681
682 # process alternate names for backward compatibility
683 # filter out unsupported (unknown) snapshot formats
684 sub filter_snapshot_fmts {
685 my @fmts = @_;
686
687 @fmts = map {
688 exists $known_snapshot_format_aliases{$_} ?
689 $known_snapshot_format_aliases{$_} : $_} @fmts;
690 @fmts = grep {
691 exists $known_snapshot_formats{$_} &&
692 !$known_snapshot_formats{$_}{'disabled'}} @fmts;
693 }
694
695 sub filter_and_validate_refs {
696 my @refs = @_;
697 my %unique_refs = ();
698
699 foreach my $ref (@refs) {
700 die_error(500, "Invalid ref '$ref' in 'extra-branch-refs' feature") unless (is_valid_ref_format($ref));
701 # 'heads' are added implicitly in get_branch_refs().
702 $unique_refs{$ref} = 1 if ($ref ne 'heads');
703 }
704 return sort keys %unique_refs;
705 }
706
707 # If it is set to code reference, it is code that it is to be run once per
708 # request, allowing updating configurations that change with each request,
709 # while running other code in config file only once.
710 #
711 # Otherwise, if it is false then gitweb would process config file only once;
712 # if it is true then gitweb config would be run for each request.
713 our $per_request_config = 1;
714
715 # read and parse gitweb config file given by its parameter.
716 # returns true on success, false on recoverable error, allowing
717 # to chain this subroutine, using first file that exists.
718 # dies on errors during parsing config file, as it is unrecoverable.
719 sub read_config_file {
720 my $filename = shift;
721 return unless defined $filename;
722 # die if there are errors parsing config file
723 if (-e $filename) {
724 do $filename;
725 die $@ if $@;
726 return 1;
727 }
728 return;
729 }
730
731 our ($GITWEB_CONFIG, $GITWEB_CONFIG_SYSTEM, $GITWEB_CONFIG_COMMON);
732 sub evaluate_gitweb_config {
733 our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";
734 our $GITWEB_CONFIG_SYSTEM = $ENV{'GITWEB_CONFIG_SYSTEM'} || "++GITWEB_CONFIG_SYSTEM++";
735 our $GITWEB_CONFIG_COMMON = $ENV{'GITWEB_CONFIG_COMMON'} || "++GITWEB_CONFIG_COMMON++";
736
737 # Protect against duplications of file names, to not read config twice.
738 # Only one of $GITWEB_CONFIG and $GITWEB_CONFIG_SYSTEM is used, so
739 # there possibility of duplication of filename there doesn't matter.
740 $GITWEB_CONFIG = "" if ($GITWEB_CONFIG eq $GITWEB_CONFIG_COMMON);
741 $GITWEB_CONFIG_SYSTEM = "" if ($GITWEB_CONFIG_SYSTEM eq $GITWEB_CONFIG_COMMON);
742
743 # Common system-wide settings for convenience.
744 # Those settings can be ovverriden by GITWEB_CONFIG or GITWEB_CONFIG_SYSTEM.
745 read_config_file($GITWEB_CONFIG_COMMON);
746
747 # Use first config file that exists. This means use the per-instance
748 # GITWEB_CONFIG if exists, otherwise use GITWEB_SYSTEM_CONFIG.
749 read_config_file($GITWEB_CONFIG) and return;
750 read_config_file($GITWEB_CONFIG_SYSTEM);
751 }
752
753 # Get loadavg of system, to compare against $maxload.
754 # Currently it requires '/proc/loadavg' present to get loadavg;
755 # if it is not present it returns 0, which means no load checking.
756 sub get_loadavg {
757 if( -e '/proc/loadavg' ){
758 open my $fd, '<', '/proc/loadavg'
759 or return 0;
760 my @load = split(/\s+/, scalar <$fd>);
761 close $fd;
762
763 # The first three columns measure CPU and IO utilization of the last one,
764 # five, and 10 minute periods. The fourth column shows the number of
765 # currently running processes and the total number of processes in the m/n
766 # format. The last column displays the last process ID used.
767 return $load[0] || 0;
768 }
769 # additional checks for load average should go here for things that don't export
770 # /proc/loadavg
771
772 return 0;
773 }
774
775 # version of the core git binary
776 our $git_version;
777 sub evaluate_git_version {
778 our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";
779 $number_of_git_cmds++;
780 }
781
782 sub check_loadavg {
783 if (defined $maxload && get_loadavg() > $maxload) {
784 die_error(503, "The load average on the server is too high");
785 }
786 }
787
788 # ======================================================================
789 # input validation and dispatch
790
791 # Various hash size-related values.
792 my $sha1_len = 40;
793 my $sha256_extra_len = 24;
794 my $sha256_len = $sha1_len + $sha256_extra_len;
795
796 # A regex matching $len hex characters. $len may be a range (e.g. 7,64).
797 sub oid_nlen_regex {
798 my $len = shift;
799 my $hchr = qr/[0-9a-fA-F]/;
800 return qr/(?:(?:$hchr){$len})/;
801 }
802
803 # A regex matching two sets of $nlen hex characters, prefixed by the literal
804 # string $prefix and with the literal string $infix between them.
805 sub oid_nlen_prefix_infix_regex {
806 my $nlen = shift;
807 my $prefix = shift;
808 my $infix = shift;
809
810 my $rx = oid_nlen_regex($nlen);
811
812 return qr/^\Q$prefix\E$rx\Q$infix\E$rx$/;
813 }
814
815 # A regex matching a valid object ID.
816 our $oid_regex;
817 {
818 my $x = oid_nlen_regex($sha1_len);
819 my $y = oid_nlen_regex($sha256_extra_len);
820 $oid_regex = qr/(?:$x(?:$y)?)/;
821 }
822
823 # input parameters can be collected from a variety of sources (presently, CGI
824 # and PATH_INFO), so we define an %input_params hash that collects them all
825 # together during validation: this allows subsequent uses (e.g. href()) to be
826 # agnostic of the parameter origin
827
828 our %input_params = ();
829
830 # input parameters are stored with the long parameter name as key. This will
831 # also be used in the href subroutine to convert parameters to their CGI
832 # equivalent, and since the href() usage is the most frequent one, we store
833 # the name -> CGI key mapping here, instead of the reverse.
834 #
835 # XXX: Warning: If you touch this, check the search form for updating,
836 # too.
837
838 our @cgi_param_mapping = (
839 project => "p",
840 action => "a",
841 file_name => "f",
842 file_parent => "fp",
843 hash => "h",
844 hash_parent => "hp",
845 hash_base => "hb",
846 hash_parent_base => "hpb",
847 page => "pg",
848 order => "o",
849 searchtext => "s",
850 searchtype => "st",
851 snapshot_format => "sf",
852 extra_options => "opt",
853 search_use_regexp => "sr",
854 ctag => "by_tag",
855 diff_style => "ds",
856 project_filter => "pf",
857 # this must be last entry (for manipulation from JavaScript)
858 javascript => "js"
859 );
860 our %cgi_param_mapping = @cgi_param_mapping;
861
862 # we will also need to know the possible actions, for validation
863 our %actions = (
864 "blame" => \&git_blame,
865 "blame_incremental" => \&git_blame_incremental,
866 "blame_data" => \&git_blame_data,
867 "blobdiff" => \&git_blobdiff,
868 "blobdiff_plain" => \&git_blobdiff_plain,
869 "blob" => \&git_blob,
870 "blob_plain" => \&git_blob_plain,
871 "commitdiff" => \&git_commitdiff,
872 "commitdiff_plain" => \&git_commitdiff_plain,
873 "commit" => \&git_commit,
874 "forks" => \&git_forks,
875 "heads" => \&git_heads,
876 "history" => \&git_history,
877 "log" => \&git_log,
878 "patch" => \&git_patch,
879 "patches" => \&git_patches,
880 "remotes" => \&git_remotes,
881 "rss" => \&git_rss,
882 "atom" => \&git_atom,
883 "search" => \&git_search,
884 "search_help" => \&git_search_help,
885 "shortlog" => \&git_shortlog,
886 "summary" => \&git_summary,
887 "tag" => \&git_tag,
888 "tags" => \&git_tags,
889 "tree" => \&git_tree,
890 "snapshot" => \&git_snapshot,
891 "object" => \&git_object,
892 # those below don't need $project
893 "opml" => \&git_opml,
894 "project_list" => \&git_project_list,
895 "project_index" => \&git_project_index,
896 );
897
898 # finally, we have the hash of allowed extra_options for the commands that
899 # allow them
900 our %allowed_options = (
901 "--no-merges" => [ qw(rss atom log shortlog history) ],
902 );
903
904 # fill %input_params with the CGI parameters. All values except for 'opt'
905 # should be single values, but opt can be an array. We should probably
906 # build an array of parameters that can be multi-valued, but since for the time
907 # being it's only this one, we just single it out
908 sub evaluate_query_params {
909 our $cgi;
910
911 while (my ($name, $symbol) = each %cgi_param_mapping) {
912 if ($symbol eq 'opt') {
913 $input_params{$name} = [ map { decode_utf8($_) } $cgi->multi_param($symbol) ];
914 } else {
915 $input_params{$name} = decode_utf8($cgi->param($symbol));
916 }
917 }
918 }
919
920 # now read PATH_INFO and update the parameter list for missing parameters
921 sub evaluate_path_info {
922 return if defined $input_params{'project'};
923 return if !$path_info;
924 $path_info =~ s,^/+,,;
925 return if !$path_info;
926
927 # find which part of PATH_INFO is project
928 my $project = $path_info;
929 $project =~ s,/+$,,;
930 while ($project && !check_head_link("$projectroot/$project")) {
931 $project =~ s,/*[^/]*$,,;
932 }
933 return unless $project;
934 $input_params{'project'} = $project;
935
936 # do not change any parameters if an action is given using the query string
937 return if $input_params{'action'};
938 $path_info =~ s,^\Q$project\E/*,,;
939
940 # next, check if we have an action
941 my $action = $path_info;
942 $action =~ s,/.*$,,;
943 if (exists $actions{$action}) {
944 $path_info =~ s,^$action/*,,;
945 $input_params{'action'} = $action;
946 }
947
948 # list of actions that want hash_base instead of hash, but can have no
949 # pathname (f) parameter
950 my @wants_base = (
951 'tree',
952 'history',
953 );
954
955 # we want to catch, among others
956 # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
957 my ($parentrefname, $parentpathname, $refname, $pathname) =
958 ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);
959
960 # first, analyze the 'current' part
961 if (defined $pathname) {
962 # we got "branch:filename" or "branch:dir/"
963 # we could use git_get_type(branch:pathname), but:
964 # - it needs $git_dir
965 # - it does a git() call
966 # - the convention of terminating directories with a slash
967 # makes it superfluous
968 # - embedding the action in the PATH_INFO would make it even
969 # more superfluous
970 $pathname =~ s,^/+,,;
971 if (!$pathname || substr($pathname, -1) eq "/") {
972 $input_params{'action'} ||= "tree";
973 $pathname =~ s,/$,,;
974 } else {
975 # the default action depends on whether we had parent info
976 # or not
977 if ($parentrefname) {
978 $input_params{'action'} ||= "blobdiff_plain";
979 } else {
980 $input_params{'action'} ||= "blob_plain";
981 }
982 }
983 $input_params{'hash_base'} ||= $refname;
984 $input_params{'file_name'} ||= $pathname;
985 } elsif (defined $refname) {
986 # we got "branch". In this case we have to choose if we have to
987 # set hash or hash_base.
988 #
989 # Most of the actions without a pathname only want hash to be
990 # set, except for the ones specified in @wants_base that want
991 # hash_base instead. It should also be noted that hand-crafted
992 # links having 'history' as an action and no pathname or hash
993 # set will fail, but that happens regardless of PATH_INFO.
994 if (defined $parentrefname) {
995 # if there is parent let the default be 'shortlog' action
996 # (for http://git.example.com/repo.git/A..B links); if there
997 # is no parent, dispatch will detect type of object and set
998 # action appropriately if required (if action is not set)
999 $input_params{'action'} ||= "shortlog";
1000 }
1001 if ($input_params{'action'} &&
1002 grep { $_ eq $input_params{'action'} } @wants_base) {
1003 $input_params{'hash_base'} ||= $refname;
1004 } else {
1005 $input_params{'hash'} ||= $refname;
1006 }
1007 }
1008
1009 # next, handle the 'parent' part, if present
1010 if (defined $parentrefname) {
1011 # a missing pathspec defaults to the 'current' filename, allowing e.g.
1012 # someproject/blobdiff/oldrev..newrev:/filename
1013 if ($parentpathname) {
1014 $parentpathname =~ s,^/+,,;
1015 $parentpathname =~ s,/$,,;
1016 $input_params{'file_parent'} ||= $parentpathname;
1017 } else {
1018 $input_params{'file_parent'} ||= $input_params{'file_name'};
1019 }
1020 # we assume that hash_parent_base is wanted if a path was specified,
1021 # or if the action wants hash_base instead of hash
1022 if (defined $input_params{'file_parent'} ||
1023 grep { $_ eq $input_params{'action'} } @wants_base) {
1024 $input_params{'hash_parent_base'} ||= $parentrefname;
1025 } else {
1026 $input_params{'hash_parent'} ||= $parentrefname;
1027 }
1028 }
1029
1030 # for the snapshot action, we allow URLs in the form
1031 # $project/snapshot/$hash.ext
1032 # where .ext determines the snapshot and gets removed from the
1033 # passed $refname to provide the $hash.
1034 #
1035 # To be able to tell that $refname includes the format extension, we
1036 # require the following two conditions to be satisfied:
1037 # - the hash input parameter MUST have been set from the $refname part
1038 # of the URL (i.e. they must be equal)
1039 # - the snapshot format MUST NOT have been defined already (e.g. from
1040 # CGI parameter sf)
1041 # It's also useless to try any matching unless $refname has a dot,
1042 # so we check for that too
1043 if (defined $input_params{'action'} &&
1044 $input_params{'action'} eq 'snapshot' &&
1045 defined $refname && index($refname, '.') != -1 &&
1046 $refname eq $input_params{'hash'} &&
1047 !defined $input_params{'snapshot_format'}) {
1048 # We loop over the known snapshot formats, checking for
1049 # extensions. Allowed extensions are both the defined suffix
1050 # (which includes the initial dot already) and the snapshot
1051 # format key itself, with a prepended dot
1052 while (my ($fmt, $opt) = each %known_snapshot_formats) {
1053 my $hash = $refname;
1054 unless ($hash =~ s/(\Q$opt->{'suffix'}\E|\Q.$fmt\E)$//) {
1055 next;
1056 }
1057 my $sfx = $1;
1058 # a valid suffix was found, so set the snapshot format
1059 # and reset the hash parameter
1060 $input_params{'snapshot_format'} = $fmt;
1061 $input_params{'hash'} = $hash;
1062 # we also set the format suffix to the one requested
1063 # in the URL: this way a request for e.g. .tgz returns
1064 # a .tgz instead of a .tar.gz
1065 $known_snapshot_formats{$fmt}{'suffix'} = $sfx;
1066 last;
1067 }
1068 }
1069 }
1070
1071 our ($action, $project, $file_name, $file_parent, $hash, $hash_parent, $hash_base,
1072 $hash_parent_base, @extra_options, $page, $searchtype, $search_use_regexp,
1073 $searchtext, $search_regexp, $project_filter);
1074 sub evaluate_and_validate_params {
1075 our $action = $input_params{'action'};
1076 if (defined $action) {
1077 if (!is_valid_action($action)) {
1078 die_error(400, "Invalid action parameter");
1079 }
1080 }
1081
1082 # parameters which are pathnames
1083 our $project = $input_params{'project'};
1084 if (defined $project) {
1085 if (!is_valid_project($project)) {
1086 undef $project;
1087 die_error(404, "No such project");
1088 }
1089 }
1090
1091 our $project_filter = $input_params{'project_filter'};
1092 if (defined $project_filter) {
1093 if (!is_valid_pathname($project_filter)) {
1094 die_error(404, "Invalid project_filter parameter");
1095 }
1096 }
1097
1098 our $file_name = $input_params{'file_name'};
1099 if (defined $file_name) {
1100 if (!is_valid_pathname($file_name)) {
1101 die_error(400, "Invalid file parameter");
1102 }
1103 }
1104
1105 our $file_parent = $input_params{'file_parent'};
1106 if (defined $file_parent) {
1107 if (!is_valid_pathname($file_parent)) {
1108 die_error(400, "Invalid file parent parameter");
1109 }
1110 }
1111
1112 # parameters which are refnames
1113 our $hash = $input_params{'hash'};
1114 if (defined $hash) {
1115 if (!is_valid_refname($hash)) {
1116 die_error(400, "Invalid hash parameter");
1117 }
1118 }
1119
1120 our $hash_parent = $input_params{'hash_parent'};
1121 if (defined $hash_parent) {
1122 if (!is_valid_refname($hash_parent)) {
1123 die_error(400, "Invalid hash parent parameter");
1124 }
1125 }
1126
1127 our $hash_base = $input_params{'hash_base'};
1128 if (defined $hash_base) {
1129 if (!is_valid_refname($hash_base)) {
1130 die_error(400, "Invalid hash base parameter");
1131 }
1132 }
1133
1134 our @extra_options = @{$input_params{'extra_options'}};
1135 # @extra_options is always defined, since it can only be (currently) set from
1136 # CGI, and $cgi->param() returns the empty array in array context if the param
1137 # is not set
1138 foreach my $opt (@extra_options) {
1139 if (not exists $allowed_options{$opt}) {
1140 die_error(400, "Invalid option parameter");
1141 }
1142 if (not grep(/^$action$/, @{$allowed_options{$opt}})) {
1143 die_error(400, "Invalid option parameter for this action");
1144 }
1145 }
1146
1147 our $hash_parent_base = $input_params{'hash_parent_base'};
1148 if (defined $hash_parent_base) {
1149 if (!is_valid_refname($hash_parent_base)) {
1150 die_error(400, "Invalid hash parent base parameter");
1151 }
1152 }
1153
1154 # other parameters
1155 our $page = $input_params{'page'};
1156 if (defined $page) {
1157 if ($page =~ m/[^0-9]/) {
1158 die_error(400, "Invalid page parameter");
1159 }
1160 }
1161
1162 our $searchtype = $input_params{'searchtype'};
1163 if (defined $searchtype) {
1164 if ($searchtype =~ m/[^a-z]/) {
1165 die_error(400, "Invalid searchtype parameter");
1166 }
1167 }
1168
1169 our $search_use_regexp = $input_params{'search_use_regexp'};
1170
1171 our $searchtext = $input_params{'searchtext'};
1172 our $search_regexp = undef;
1173 if (defined $searchtext) {
1174 if (length($searchtext) < 2) {
1175 die_error(403, "At least two characters are required for search parameter");
1176 }
1177 if ($search_use_regexp) {
1178 $search_regexp = $searchtext;
1179 if (!eval { qr/$search_regexp/; 1; }) {
1180 (my $error = $@) =~ s/ at \S+ line \d+.*\n?//;
1181 die_error(400, "Invalid search regexp '$search_regexp'",
1182 esc_html($error));
1183 }
1184 } else {
1185 $search_regexp = quotemeta $searchtext;
1186 }
1187 }
1188 }
1189
1190 # path to the current git repository
1191 our $git_dir;
1192 sub evaluate_git_dir {
1193 our $git_dir = "$projectroot/$project" if $project;
1194 }
1195
1196 our (@snapshot_fmts, $git_avatar, @extra_branch_refs);
1197 sub configure_gitweb_features {
1198 # list of supported snapshot formats
1199 our @snapshot_fmts = gitweb_get_feature('snapshot');
1200 @snapshot_fmts = filter_snapshot_fmts(@snapshot_fmts);
1201
1202 our ($git_avatar) = gitweb_get_feature('avatar');
1203 $git_avatar = '' unless $git_avatar =~ /^(?:gravatar|picon)$/s;
1204
1205 our @extra_branch_refs = gitweb_get_feature('extra-branch-refs');
1206 @extra_branch_refs = filter_and_validate_refs (@extra_branch_refs);
1207 }
1208
1209 sub get_branch_refs {
1210 return ('heads', @extra_branch_refs);
1211 }
1212
1213 # custom error handler: 'die <message>' is Internal Server Error
1214 sub handle_errors_html {
1215 my $msg = shift; # it is already HTML escaped
1216
1217 # to avoid infinite loop where error occurs in die_error,
1218 # change handler to default handler, disabling handle_errors_html
1219 set_message("Error occurred when inside die_error:\n$msg");
1220
1221 # you cannot jump out of die_error when called as error handler;
1222 # the subroutine set via CGI::Carp::set_message is called _after_
1223 # HTTP headers are already written, so it cannot write them itself
1224 die_error(undef, undef, $msg, -error_handler => 1, -no_http_header => 1);
1225 }
1226 set_message(\&handle_errors_html);
1227
1228 # dispatch
1229 sub dispatch {
1230 if (!defined $action) {
1231 if (defined $hash) {
1232 $action = git_get_type($hash);
1233 $action or die_error(404, "Object does not exist");
1234 } elsif (defined $hash_base && defined $file_name) {
1235 $action = git_get_type("$hash_base:$file_name");
1236 $action or die_error(404, "File or directory does not exist");
1237 } elsif (defined $project) {
1238 $action = 'summary';
1239 } else {
1240 $action = 'project_list';
1241 }
1242 }
1243 if (!defined($actions{$action})) {
1244 die_error(400, "Unknown action");
1245 }
1246 if ($action !~ m/^(?:opml|project_list|project_index)$/ &&
1247 !$project) {
1248 die_error(400, "Project needed");
1249 }
1250 $actions{$action}->();
1251 }
1252
1253 sub reset_timer {
1254 our $t0 = [ gettimeofday() ]
1255 if defined $t0;
1256 our $number_of_git_cmds = 0;
1257 }
1258
1259 our $first_request = 1;
1260 sub run_request {
1261 reset_timer();
1262
1263 evaluate_uri();
1264 if ($first_request) {
1265 evaluate_gitweb_config();
1266 evaluate_git_version();
1267 }
1268 if ($per_request_config) {
1269 if (ref($per_request_config) eq 'CODE') {
1270 $per_request_config->();
1271 } elsif (!$first_request) {
1272 evaluate_gitweb_config();
1273 }
1274 }
1275 check_loadavg();
1276
1277 # $projectroot and $projects_list might be set in gitweb config file
1278 $projects_list ||= $projectroot;
1279
1280 evaluate_query_params();
1281 evaluate_path_info();
1282 evaluate_and_validate_params();
1283 evaluate_git_dir();
1284
1285 configure_gitweb_features();
1286
1287 dispatch();
1288 }
1289
1290 our $is_last_request = sub { 1 };
1291 our ($pre_dispatch_hook, $post_dispatch_hook, $pre_listen_hook);
1292 our $CGI = 'CGI';
1293 our $cgi;
1294 sub configure_as_fcgi {
1295 require CGI::Fast;
1296 our $CGI = 'CGI::Fast';
1297
1298 my $request_number = 0;
1299 # let each child service 100 requests
1300 our $is_last_request = sub { ++$request_number > 100 };
1301 }
1302 sub evaluate_argv {
1303 my $script_name = $ENV{'SCRIPT_NAME'} || $ENV{'SCRIPT_FILENAME'} || __FILE__;
1304 configure_as_fcgi()
1305 if $script_name =~ /\.fcgi$/;
1306
1307 return unless (@ARGV);
1308
1309 require Getopt::Long;
1310 Getopt::Long::GetOptions(
1311 'fastcgi|fcgi|f' => \&configure_as_fcgi,
1312 'nproc|n=i' => sub {
1313 my ($arg, $val) = @_;
1314 return unless eval { require FCGI::ProcManager; 1; };
1315 my $proc_manager = FCGI::ProcManager->new({
1316 n_processes => $val,
1317 });
1318 our $pre_listen_hook = sub { $proc_manager->pm_manage() };
1319 our $pre_dispatch_hook = sub { $proc_manager->pm_pre_dispatch() };
1320 our $post_dispatch_hook = sub { $proc_manager->pm_post_dispatch() };
1321 },
1322 );
1323 }
1324
1325 sub run {
1326 evaluate_argv();
1327
1328 $first_request = 1;
1329 $pre_listen_hook->()
1330 if $pre_listen_hook;
1331
1332 REQUEST:
1333 while ($cgi = $CGI->new()) {
1334 $pre_dispatch_hook->()
1335 if $pre_dispatch_hook;
1336
1337 run_request();
1338
1339 $post_dispatch_hook->()
1340 if $post_dispatch_hook;
1341 $first_request = 0;
1342
1343 last REQUEST if ($is_last_request->());
1344 }
1345
1346 DONE_GITWEB:
1347 1;
1348 }
1349
1350 run();
1351
1352 if (defined caller) {
1353 # wrapped in a subroutine processing requests,
1354 # e.g. mod_perl with ModPerl::Registry, or PSGI with Plack::App::WrapCGI
1355 return;
1356 } else {
1357 # pure CGI script, serving single request
1358 exit;
1359 }
1360
1361 ## ======================================================================
1362 ## action links
1363
1364 # possible values of extra options
1365 # -full => 0|1 - use absolute/full URL ($my_uri/$my_url as base)
1366 # -replay => 1 - start from a current view (replay with modifications)
1367 # -path_info => 0|1 - don't use/use path_info URL (if possible)
1368 # -anchor => ANCHOR - add #ANCHOR to end of URL, implies -replay if used alone
1369 sub href {
1370 my %params = @_;
1371 # default is to use -absolute url() i.e. $my_uri
1372 my $href = $params{-full} ? $my_url : $my_uri;
1373
1374 # implicit -replay, must be first of implicit params
1375 $params{-replay} = 1 if (keys %params == 1 && $params{-anchor});
1376
1377 $params{'project'} = $project unless exists $params{'project'};
1378
1379 if ($params{-replay}) {
1380 while (my ($name, $symbol) = each %cgi_param_mapping) {
1381 if (!exists $params{$name}) {
1382 $params{$name} = $input_params{$name};
1383 }
1384 }
1385 }
1386
1387 my $use_pathinfo = gitweb_check_feature('pathinfo');
1388 if (defined $params{'project'} &&
1389 (exists $params{-path_info} ? $params{-path_info} : $use_pathinfo)) {
1390 # try to put as many parameters as possible in PATH_INFO:
1391 # - project name
1392 # - action
1393 # - hash_parent or hash_parent_base:/file_parent
1394 # - hash or hash_base:/filename
1395 # - the snapshot_format as an appropriate suffix
1396
1397 # When the script is the root DirectoryIndex for the domain,
1398 # $href here would be something like http://gitweb.example.com/
1399 # Thus, we strip any trailing / from $href, to spare us double
1400 # slashes in the final URL
1401 $href =~ s,/$,,;
1402
1403 # Then add the project name, if present
1404 $href .= "/".esc_path_info($params{'project'});
1405 delete $params{'project'};
1406
1407 # since we destructively absorb parameters, we keep this
1408 # boolean that remembers if we're handling a snapshot
1409 my $is_snapshot = $params{'action'} eq 'snapshot';
1410
1411 # Summary just uses the project path URL, any other action is
1412 # added to the URL
1413 if (defined $params{'action'}) {
1414 $href .= "/".esc_path_info($params{'action'})
1415 unless $params{'action'} eq 'summary';
1416 delete $params{'action'};
1417 }
1418
1419 # Next, we put hash_parent_base:/file_parent..hash_base:/file_name,
1420 # stripping nonexistent or useless pieces
1421 $href .= "/" if ($params{'hash_base'} || $params{'hash_parent_base'}
1422 || $params{'hash_parent'} || $params{'hash'});
1423 if (defined $params{'hash_base'}) {
1424 if (defined $params{'hash_parent_base'}) {
1425 $href .= esc_path_info($params{'hash_parent_base'});
1426 # skip the file_parent if it's the same as the file_name
1427 if (defined $params{'file_parent'}) {
1428 if (defined $params{'file_name'} && $params{'file_parent'} eq $params{'file_name'}) {
1429 delete $params{'file_parent'};
1430 } elsif ($params{'file_parent'} !~ /\.\./) {
1431 $href .= ":/".esc_path_info($params{'file_parent'});
1432 delete $params{'file_parent'};
1433 }
1434 }
1435 $href .= "..";
1436 delete $params{'hash_parent'};
1437 delete $params{'hash_parent_base'};
1438 } elsif (defined $params{'hash_parent'}) {
1439 $href .= esc_path_info($params{'hash_parent'}). "..";
1440 delete $params{'hash_parent'};
1441 }
1442
1443 $href .= esc_path_info($params{'hash_base'});
1444 if (defined $params{'file_name'} && $params{'file_name'} !~ /\.\./) {
1445 $href .= ":/".esc_path_info($params{'file_name'});
1446 delete $params{'file_name'};
1447 }
1448 delete $params{'hash'};
1449 delete $params{'hash_base'};
1450 } elsif (defined $params{'hash'}) {
1451 $href .= esc_path_info($params{'hash'});
1452 delete $params{'hash'};
1453 }
1454
1455 # If the action was a snapshot, we can absorb the
1456 # snapshot_format parameter too
1457 if ($is_snapshot) {
1458 my $fmt = $params{'snapshot_format'};
1459 # snapshot_format should always be defined when href()
1460 # is called, but just in case some code forgets, we
1461 # fall back to the default
1462 $fmt ||= $snapshot_fmts[0];
1463 $href .= $known_snapshot_formats{$fmt}{'suffix'};
1464 delete $params{'snapshot_format'};
1465 }
1466 }
1467
1468 # now encode the parameters explicitly
1469 my @result = ();
1470 for (my $i = 0; $i < @cgi_param_mapping; $i += 2) {
1471 my ($name, $symbol) = ($cgi_param_mapping[$i], $cgi_param_mapping[$i+1]);
1472 if (defined $params{$name}) {
1473 if (ref($params{$name}) eq "ARRAY") {
1474 foreach my $par (@{$params{$name}}) {
1475 push @result, $symbol . "=" . esc_param($par);
1476 }
1477 } else {
1478 push @result, $symbol . "=" . esc_param($params{$name});
1479 }
1480 }
1481 }
1482 $href .= "?" . join(';', @result) if scalar @result;
1483
1484 # final transformation: trailing spaces must be escaped (URI-encoded)
1485 $href =~ s/(\s+)$/CGI::escape($1)/e;
1486
1487 if ($params{-anchor}) {
1488 $href .= "#".esc_param($params{-anchor});
1489 }
1490
1491 return $href;
1492 }
1493
1494
1495 ## ======================================================================
1496 ## validation, quoting/unquoting and escaping
1497
1498 sub is_valid_action {
1499 my $input = shift;
1500 return undef unless exists $actions{$input};
1501 return 1;
1502 }
1503
1504 sub is_valid_project {
1505 my $input = shift;
1506
1507 return unless defined $input;
1508 if (!is_valid_pathname($input) ||
1509 !(-d "$projectroot/$input") ||
1510 !check_export_ok("$projectroot/$input") ||
1511 ($strict_export && !project_in_list($input))) {
1512 return undef;
1513 } else {
1514 return 1;
1515 }
1516 }
1517
1518 sub is_valid_pathname {
1519 my $input = shift;
1520
1521 return undef unless defined $input;
1522 # no '.' or '..' as elements of path, i.e. no '.' or '..'
1523 # at the beginning, at the end, and between slashes.
1524 # also this catches doubled slashes
1525 if ($input =~ m!(^|/)(|\.|\.\.)(/|$)!) {
1526 return undef;
1527 }
1528 # no null characters
1529 if ($input =~ m!\0!) {
1530 return undef;
1531 }
1532 return 1;
1533 }
1534
1535 sub is_valid_ref_format {
1536 my $input = shift;
1537
1538 return undef unless defined $input;
1539 # restrictions on ref name according to git-check-ref-format
1540 if ($input =~ m!(/\.|\.\.|[\000-\040\177 ~^:?*\[]|/$)!) {
1541 return undef;
1542 }
1543 return 1;
1544 }
1545
1546 sub is_valid_refname {
1547 my $input = shift;
1548
1549 return undef unless defined $input;
1550 # textual hashes are O.K.
1551 if ($input =~ m/^$oid_regex$/) {
1552 return 1;
1553 }
1554 # it must be correct pathname
1555 is_valid_pathname($input) or return undef;
1556 # check git-check-ref-format restrictions
1557 is_valid_ref_format($input) or return undef;
1558 return 1;
1559 }
1560
1561 # decode sequences of octets in utf8 into Perl's internal form,
1562 # which is utf-8 with utf8 flag set if needed. gitweb writes out
1563 # in utf-8 thanks to "binmode STDOUT, ':utf8'" at beginning
1564 sub to_utf8 {
1565 my $str = shift;
1566 return undef unless defined $str;
1567
1568 if (utf8::is_utf8($str) || utf8::decode($str)) {
1569 return $str;
1570 } else {
1571 return decode($fallback_encoding, $str, Encode::FB_DEFAULT);
1572 }
1573 }
1574
1575 # quote unsafe chars, but keep the slash, even when it's not
1576 # correct, but quoted slashes look too horrible in bookmarks
1577 sub esc_param {
1578 my $str = shift;
1579 return undef unless defined $str;
1580 $str =~ s/([^A-Za-z0-9\-_.~()\/:@ ]+)/CGI::escape($1)/eg;
1581 $str =~ s/ /\+/g;
1582 return $str;
1583 }
1584
1585 # the quoting rules for path_info fragment are slightly different
1586 sub esc_path_info {
1587 my $str = shift;
1588 return undef unless defined $str;
1589
1590 # path_info doesn't treat '+' as space (specially), but '?' must be escaped
1591 $str =~ s/([^A-Za-z0-9\-_.~();\/;:@&= +]+)/CGI::escape($1)/eg;
1592
1593 return $str;
1594 }
1595
1596 # quote unsafe chars in whole URL, so some characters cannot be quoted
1597 sub esc_url {
1598 my $str = shift;
1599 return undef unless defined $str;
1600 $str =~ s/([^A-Za-z0-9\-_.~();\/;?:@&= ]+)/CGI::escape($1)/eg;
1601 $str =~ s/ /\+/g;
1602 return $str;
1603 }
1604
1605 # quote unsafe characters in HTML attributes
1606 sub esc_attr {
1607
1608 # for XHTML conformance escaping '"' to '&quot;' is not enough
1609 return esc_html(@_);
1610 }
1611
1612 # replace invalid utf8 character with SUBSTITUTION sequence
1613 sub esc_html {
1614 my $str = shift;
1615 my %opts = @_;
1616
1617 return undef unless defined $str;
1618
1619 $str = to_utf8($str);
1620 $str = $cgi->escapeHTML($str);
1621 if ($opts{'-nbsp'}) {
1622 $str =~ s/ /&nbsp;/g;
1623 }
1624 $str =~ s|([[:cntrl:]])|(($1 ne "\t") ? quot_cec($1) : $1)|eg;
1625 return $str;
1626 }
1627
1628 # quote control characters and escape filename to HTML
1629 sub esc_path {
1630 my $str = shift;
1631 my %opts = @_;
1632
1633 return undef unless defined $str;
1634
1635 $str = to_utf8($str);
1636 $str = $cgi->escapeHTML($str);
1637 if ($opts{'-nbsp'}) {
1638 $str =~ s/ /&nbsp;/g;
1639 }
1640 $str =~ s|([[:cntrl:]])|quot_cec($1)|eg;
1641 return $str;
1642 }
1643
1644 # Sanitize for use in XHTML + application/xml+xhtml (valid XML 1.0)
1645 sub sanitize {
1646 my $str = shift;
1647
1648 return undef unless defined $str;
1649
1650 $str = to_utf8($str);
1651 $str =~ s|([[:cntrl:]])|(index("\t\n\r", $1) != -1 ? $1 : quot_cec($1))|eg;
1652 return $str;
1653 }
1654
1655 # Make control characters "printable", using character escape codes (CEC)
1656 sub quot_cec {
1657 my $cntrl = shift;
1658 my %opts = @_;
1659 my %es = ( # character escape codes, aka escape sequences
1660 "\t" => '\t', # tab (HT)
1661 "\n" => '\n', # line feed (LF)
1662 "\r" => '\r', # carrige return (CR)
1663 "\f" => '\f', # form feed (FF)
1664 "\b" => '\b', # backspace (BS)
1665 "\a" => '\a', # alarm (bell) (BEL)
1666 "\e" => '\e', # escape (ESC)
1667 "\013" => '\v', # vertical tab (VT)
1668 "\000" => '\0', # nul character (NUL)
1669 );
1670 my $chr = ( (exists $es{$cntrl})
1671 ? $es{$cntrl}
1672 : sprintf('\%2x', ord($cntrl)) );
1673 if ($opts{-nohtml}) {
1674 return $chr;
1675 } else {
1676 return "<span class=\"cntrl\">$chr</span>";
1677 }
1678 }
1679
1680 # Alternatively use unicode control pictures codepoints,
1681 # Unicode "printable representation" (PR)
1682 sub quot_upr {
1683 my $cntrl = shift;
1684 my %opts = @_;
1685
1686 my $chr = sprintf('&#%04d;', 0x2400+ord($cntrl));
1687 if ($opts{-nohtml}) {
1688 return $chr;
1689 } else {
1690 return "<span class=\"cntrl\">$chr</span>";
1691 }
1692 }
1693
1694 # git may return quoted and escaped filenames
1695 sub unquote {
1696 my $str = shift;
1697
1698 sub unq {
1699 my $seq = shift;
1700 my %es = ( # character escape codes, aka escape sequences
1701 't' => "\t", # tab (HT, TAB)
1702 'n' => "\n", # newline (NL)
1703 'r' => "\r", # return (CR)
1704 'f' => "\f", # form feed (FF)
1705 'b' => "\b", # backspace (BS)
1706 'a' => "\a", # alarm (bell) (BEL)
1707 'e' => "\e", # escape (ESC)
1708 'v' => "\013", # vertical tab (VT)
1709 );
1710
1711 if ($seq =~ m/^[0-7]{1,3}$/) {
1712 # octal char sequence
1713 return chr(oct($seq));
1714 } elsif (exists $es{$seq}) {
1715 # C escape sequence, aka character escape code
1716 return $es{$seq};
1717 }
1718 # quoted ordinary character
1719 return $seq;
1720 }
1721
1722 if ($str =~ m/^"(.*)"$/) {
1723 # needs unquoting
1724 $str = $1;
1725 $str =~ s/\\([^0-7]|[0-7]{1,3})/unq($1)/eg;
1726 }
1727 return $str;
1728 }
1729
1730 # escape tabs (convert tabs to spaces)
1731 sub untabify {
1732 my $line = shift;
1733
1734 while ((my $pos = index($line, "\t")) != -1) {
1735 if (my $count = (8 - ($pos % 8))) {
1736 my $spaces = ' ' x $count;
1737 $line =~ s/\t/$spaces/;
1738 }
1739 }
1740
1741 return $line;
1742 }
1743
1744 sub project_in_list {
1745 my $project = shift;
1746 my @list = git_get_projects_list();
1747 return @list && scalar(grep { $_->{'path'} eq $project } @list);
1748 }
1749
1750 ## ----------------------------------------------------------------------
1751 ## HTML aware string manipulation
1752
1753 # Try to chop given string on a word boundary between position
1754 # $len and $len+$add_len. If there is no word boundary there,
1755 # chop at $len+$add_len. Do not chop if chopped part plus ellipsis
1756 # (marking chopped part) would be longer than given string.
1757 sub chop_str {
1758 my $str = shift;
1759 my $len = shift;
1760 my $add_len = shift || 10;
1761 my $where = shift || 'right'; # 'left' | 'center' | 'right'
1762
1763 # Make sure perl knows it is utf8 encoded so we don't
1764 # cut in the middle of a utf8 multibyte char.
1765 $str = to_utf8($str);
1766
1767 # allow only $len chars, but don't cut a word if it would fit in $add_len
1768 # if it doesn't fit, cut it if it's still longer than the dots we would add
1769 # remove chopped character entities entirely
1770
1771 # when chopping in the middle, distribute $len into left and right part
1772 # return early if chopping wouldn't make string shorter
1773 if ($where eq 'center') {
1774 return $str if ($len + 5 >= length($str)); # filler is length 5
1775 $len = int($len/2);
1776 } else {
1777 return $str if ($len + 4 >= length($str)); # filler is length 4
1778 }
1779
1780 # regexps: ending and beginning with word part up to $add_len
1781 my $endre = qr/.{$len}\w{0,$add_len}/;
1782 my $begre = qr/\w{0,$add_len}.{$len}/;
1783
1784 if ($where eq 'left') {
1785 $str =~ m/^(.*?)($begre)$/;
1786 my ($lead, $body) = ($1, $2);
1787 if (length($lead) > 4) {
1788 $lead = " ...";
1789 }
1790 return "$lead$body";
1791
1792 } elsif ($where eq 'center') {
1793 $str =~ m/^($endre)(.*)$/;
1794 my ($left, $str) = ($1, $2);
1795 $str =~ m/^(.*?)($begre)$/;
1796 my ($mid, $right) = ($1, $2);
1797 if (length($mid) > 5) {
1798 $mid = " ... ";
1799 }
1800 return "$left$mid$right";
1801
1802 } else {
1803 $str =~ m/^($endre)(.*)$/;
1804 my $body = $1;
1805 my $tail = $2;
1806 if (length($tail) > 4) {
1807 $tail = "... ";
1808 }
1809 return "$body$tail";
1810 }
1811 }
1812
1813 # takes the same arguments as chop_str, but also wraps a <span> around the
1814 # result with a title attribute if it does get chopped. Additionally, the
1815 # string is HTML-escaped.
1816 sub chop_and_escape_str {
1817 my ($str) = @_;
1818
1819 my $chopped = chop_str(@_);
1820 $str = to_utf8($str);
1821 if ($chopped eq $str) {
1822 return esc_html($chopped);
1823 } else {
1824 $str =~ s/[[:cntrl:]]/?/g;
1825 return $cgi->span({-title=>$str}, esc_html($chopped));
1826 }
1827 }
1828
1829 # Highlight selected fragments of string, using given CSS class,
1830 # and escape HTML. It is assumed that fragments do not overlap.
1831 # Regions are passed as list of pairs (array references).
1832 #
1833 # Example: esc_html_hl_regions("foobar", "mark", [ 0, 3 ]) returns
1834 # '<span class="mark">foo</span>bar'
1835 sub esc_html_hl_regions {
1836 my ($str, $css_class, @sel) = @_;
1837 my %opts = grep { ref($_) ne 'ARRAY' } @sel;
1838 @sel = grep { ref($_) eq 'ARRAY' } @sel;
1839 return esc_html($str, %opts) unless @sel;
1840
1841 my $out = '';
1842 my $pos = 0;
1843
1844 for my $s (@sel) {
1845 my ($begin, $end) = @$s;
1846
1847 # Don't create empty <span> elements.
1848 next if $end <= $begin;
1849
1850 my $escaped = esc_html(substr($str, $begin, $end - $begin),
1851 %opts);
1852
1853 $out .= esc_html(substr($str, $pos, $begin - $pos), %opts)
1854 if ($begin - $pos > 0);
1855 $out .= $cgi->span({-class => $css_class}, $escaped);
1856
1857 $pos = $end;
1858 }
1859 $out .= esc_html(substr($str, $pos), %opts)
1860 if ($pos < length($str));
1861
1862 return $out;
1863 }
1864
1865 # return positions of beginning and end of each match
1866 sub matchpos_list {
1867 my ($str, $regexp) = @_;
1868 return unless (defined $str && defined $regexp);
1869
1870 my @matches;
1871 while ($str =~ /$regexp/g) {
1872 push @matches, [$-[0], $+[0]];
1873 }
1874 return @matches;
1875 }
1876
1877 # highlight match (if any), and escape HTML
1878 sub esc_html_match_hl {
1879 my ($str, $regexp) = @_;
1880 return esc_html($str) unless defined $regexp;
1881
1882 my @matches = matchpos_list($str, $regexp);
1883 return esc_html($str) unless @matches;
1884
1885 return esc_html_hl_regions($str, 'match', @matches);
1886 }
1887
1888
1889 # highlight match (if any) of shortened string, and escape HTML
1890 sub esc_html_match_hl_chopped {
1891 my ($str, $chopped, $regexp) = @_;
1892 return esc_html_match_hl($str, $regexp) unless defined $chopped;
1893
1894 my @matches = matchpos_list($str, $regexp);
1895 return esc_html($chopped) unless @matches;
1896
1897 # filter matches so that we mark chopped string
1898 my $tail = "... "; # see chop_str
1899 unless ($chopped =~ s/\Q$tail\E$//) {
1900 $tail = '';
1901 }
1902 my $chop_len = length($chopped);
1903 my $tail_len = length($tail);
1904 my @filtered;
1905
1906 for my $m (@matches) {
1907 if ($m->[0] > $chop_len) {
1908 push @filtered, [ $chop_len, $chop_len + $tail_len ] if ($tail_len > 0);
1909 last;
1910 } elsif ($m->[1] > $chop_len) {
1911 push @filtered, [ $m->[0], $chop_len + $tail_len ];
1912 last;
1913 }
1914 push @filtered, $m;
1915 }
1916
1917 return esc_html_hl_regions($chopped . $tail, 'match', @filtered);
1918 }
1919
1920 ## ----------------------------------------------------------------------
1921 ## functions returning short strings
1922
1923 # CSS class for given age value (in seconds)
1924 sub age_class {
1925 my $age = shift;
1926
1927 if (!defined $age) {
1928 return "noage";
1929 } elsif ($age < 60*60*2) {
1930 return "age0";
1931 } elsif ($age < 60*60*24*2) {
1932 return "age1";
1933 } else {
1934 return "age2";
1935 }
1936 }
1937
1938 # convert age in seconds to "nn units ago" string
1939 sub age_string {
1940 my $age = shift;
1941 my $age_str;
1942
1943 if ($age > 60*60*24*365*2) {
1944 $age_str = (int $age/60/60/24/365);
1945 $age_str .= " years ago";
1946 } elsif ($age > 60*60*24*(365/12)*2) {
1947 $age_str = int $age/60/60/24/(365/12);
1948 $age_str .= " months ago";
1949 } elsif ($age > 60*60*24*7*2) {
1950 $age_str = int $age/60/60/24/7;
1951 $age_str .= " weeks ago";
1952 } elsif ($age > 60*60*24*2) {
1953 $age_str = int $age/60/60/24;
1954 $age_str .= " days ago";
1955 } elsif ($age > 60*60*2) {
1956 $age_str = int $age/60/60;
1957 $age_str .= " hours ago";
1958 } elsif ($age > 60*2) {
1959 $age_str = int $age/60;
1960 $age_str .= " min ago";
1961 } elsif ($age > 2) {
1962 $age_str = int $age;
1963 $age_str .= " sec ago";
1964 } else {
1965 $age_str .= " right now";
1966 }
1967 return $age_str;
1968 }
1969
1970 use constant {
1971 S_IFINVALID => 0030000,
1972 S_IFGITLINK => 0160000,
1973 };
1974
1975 # submodule/subproject, a commit object reference
1976 sub S_ISGITLINK {
1977 my $mode = shift;
1978
1979 return (($mode & S_IFMT) == S_IFGITLINK)
1980 }
1981
1982 # convert file mode in octal to symbolic file mode string
1983 sub mode_str {
1984 my $mode = oct shift;
1985
1986 if (S_ISGITLINK($mode)) {
1987 return 'm---------';
1988 } elsif (S_ISDIR($mode & S_IFMT)) {
1989 return 'drwxr-xr-x';
1990 } elsif (S_ISLNK($mode)) {
1991 return 'lrwxrwxrwx';
1992 } elsif (S_ISREG($mode)) {
1993 # git cares only about the executable bit
1994 if ($mode & S_IXUSR) {
1995 return '-rwxr-xr-x';
1996 } else {
1997 return '-rw-r--r--';
1998 };
1999 } else {
2000 return '----------';
2001 }
2002 }
2003
2004 # convert file mode in octal to file type string
2005 sub file_type {
2006 my $mode = shift;
2007
2008 if ($mode !~ m/^[0-7]+$/) {
2009 return $mode;
2010 } else {
2011 $mode = oct $mode;
2012 }
2013
2014 if (S_ISGITLINK($mode)) {
2015 return "submodule";
2016 } elsif (S_ISDIR($mode & S_IFMT)) {
2017 return "directory";
2018 } elsif (S_ISLNK($mode)) {
2019 return "symlink";
2020 } elsif (S_ISREG($mode)) {
2021 return "file";
2022 } else {
2023 return "unknown";
2024 }
2025 }
2026
2027 # convert file mode in octal to file type description string
2028 sub file_type_long {
2029 my $mode = shift;
2030
2031 if ($mode !~ m/^[0-7]+$/) {
2032 return $mode;
2033 } else {
2034 $mode = oct $mode;
2035 }
2036
2037 if (S_ISGITLINK($mode)) {
2038 return "submodule";
2039 } elsif (S_ISDIR($mode & S_IFMT)) {
2040 return "directory";
2041 } elsif (S_ISLNK($mode)) {
2042 return "symlink";
2043 } elsif (S_ISREG($mode)) {
2044 if ($mode & S_IXUSR) {
2045 return "executable";
2046 } else {
2047 return "file";
2048 };
2049 } else {
2050 return "unknown";
2051 }
2052 }
2053
2054
2055 ## ----------------------------------------------------------------------
2056 ## functions returning short HTML fragments, or transforming HTML fragments
2057 ## which don't belong to other sections
2058
2059 # format line of commit message.
2060 sub format_log_line_html {
2061 my $line = shift;
2062
2063 # Potentially abbreviated OID.
2064 my $regex = oid_nlen_regex("7,64");
2065
2066 $line = esc_html($line, -nbsp=>1);
2067 $line =~ s{
2068 \b
2069 (
2070 # The output of "git describe", e.g. v2.10.0-297-gf6727b0
2071 # or hadoop-20160921-113441-20-g094fb7d
2072 (?<!-) # see strbuf_check_tag_ref(). Tags can't start with -
2073 [A-Za-z0-9.-]+
2074 (?!\.) # refs can't end with ".", see check_refname_format()
2075 -g$regex
2076 |
2077 # Just a normal looking Git SHA1
2078 $regex
2079 )
2080 \b
2081 }{
2082 $cgi->a({-href => href(action=>"object", hash=>$1),
2083 -class => "text"}, $1);
2084 }egx;
2085
2086 return $line;
2087 }
2088
2089 # format marker of refs pointing to given object
2090
2091 # the destination action is chosen based on object type and current context:
2092 # - for annotated tags, we choose the tag view unless it's the current view
2093 # already, in which case we go to shortlog view
2094 # - for other refs, we keep the current view if we're in history, shortlog or
2095 # log view, and select shortlog otherwise
2096 sub format_ref_marker {
2097 my ($refs, $id) = @_;
2098 my $markers = '';
2099
2100 if (defined $refs->{$id}) {
2101 foreach my $ref (@{$refs->{$id}}) {
2102 # this code exploits the fact that non-lightweight tags are the
2103 # only indirect objects, and that they are the only objects for which
2104 # we want to use tag instead of shortlog as action
2105 my ($type, $name) = qw();
2106 my $indirect = ($ref =~ s/\^\{\}$//);
2107 # e.g. tags/v2.6.11 or heads/next
2108 if ($ref =~ m!^(.*?)s?/(.*)$!) {
2109 $type = $1;
2110 $name = $2;
2111 } else {
2112 $type = "ref";
2113 $name = $ref;
2114 }
2115
2116 my $class = $type;
2117 $class .= " indirect" if $indirect;
2118
2119 my $dest_action = "shortlog";
2120
2121 if ($indirect) {
2122 $dest_action = "tag" unless $action eq "tag";
2123 } elsif ($action =~ /^(history|(short)?log)$/) {
2124 $dest_action = $action;
2125 }
2126
2127 my $dest = "";
2128 $dest .= "refs/" unless $ref =~ m!^refs/!;
2129 $dest .= $ref;
2130
2131 my $link = $cgi->a({
2132 -href => href(
2133 action=>$dest_action,
2134 hash=>$dest
2135 )}, esc_html($name));
2136
2137 $markers .= " <span class=\"".esc_attr($class)."\" title=\"".esc_attr($ref)."\">" .
2138 $link . "</span>";
2139 }
2140 }
2141
2142 if ($markers) {
2143 return ' <span class="refs">'. $markers . '</span>';
2144 } else {
2145 return "";
2146 }
2147 }
2148
2149 # format, perhaps shortened and with markers, title line
2150 sub format_subject_html {
2151 my ($long, $short, $href, $extra) = @_;
2152 $extra = '' unless defined($extra);
2153
2154 if (length($short) < length($long)) {
2155 $long =~ s/[[:cntrl:]]/?/g;
2156 return $cgi->a({-href => $href, -class => "list subject",
2157 -title => to_utf8($long)},
2158 esc_html($short)) . $extra;
2159 } else {
2160 return $cgi->a({-href => $href, -class => "list subject"},
2161 esc_html($long)) . $extra;
2162 }
2163 }
2164
2165 # Rather than recomputing the url for an email multiple times, we cache it
2166 # after the first hit. This gives a visible benefit in views where the avatar
2167 # for the same email is used repeatedly (e.g. shortlog).
2168 # The cache is shared by all avatar engines (currently gravatar only), which
2169 # are free to use it as preferred. Since only one avatar engine is used for any
2170 # given page, there's no risk for cache conflicts.
2171 our %avatar_cache = ();
2172
2173 # Compute the picon url for a given email, by using the picon search service over at
2174 # http://www.cs.indiana.edu/picons/search.html
2175 sub picon_url {
2176 my $email = lc shift;
2177 if (!$avatar_cache{$email}) {
2178 my ($user, $domain) = split('@', $email);
2179 $avatar_cache{$email} =
2180 "//www.cs.indiana.edu/cgi-pub/kinzler/piconsearch.cgi/" .
2181 "$domain/$user/" .
2182 "users+domains+unknown/up/single";
2183 }
2184 return $avatar_cache{$email};
2185 }
2186
2187 # Compute the gravatar url for a given email, if it's not in the cache already.
2188 # Gravatar stores only the part of the URL before the size, since that's the
2189 # one computationally more expensive. This also allows reuse of the cache for
2190 # different sizes (for this particular engine).
2191 sub gravatar_url {
2192 my $email = lc shift;
2193 my $size = shift;
2194 $avatar_cache{$email} ||=
2195 "//www.gravatar.com/avatar/" .
2196 md5_hex($email) . "?s=";
2197 return $avatar_cache{$email} . $size;
2198 }
2199
2200 # Insert an avatar for the given $email at the given $size if the feature
2201 # is enabled.
2202 sub git_get_avatar {
2203 my ($email, %opts) = @_;
2204 my $pre_white = ($opts{-pad_before} ? "&nbsp;" : "");
2205 my $post_white = ($opts{-pad_after} ? "&nbsp;" : "");
2206 $opts{-size} ||= 'default';
2207 my $size = $avatar_size{$opts{-size}} || $avatar_size{'default'};
2208 my $url = "";
2209 if ($git_avatar eq 'gravatar') {
2210 $url = gravatar_url($email, $size);
2211 } elsif ($git_avatar eq 'picon') {
2212 $url = picon_url($email);
2213 }
2214 # Other providers can be added by extending the if chain, defining $url
2215 # as needed. If no variant puts something in $url, we assume avatars
2216 # are completely disabled/unavailable.
2217 if ($url) {
2218 return $pre_white .
2219 "<img width=\"$size\" " .
2220 "class=\"avatar\" " .
2221 "src=\"".esc_url($url)."\" " .
2222 "alt=\"\" " .
2223 "/>" . $post_white;
2224 } else {
2225 return "";
2226 }
2227 }
2228
2229 sub format_search_author {
2230 my ($author, $searchtype, $displaytext) = @_;
2231 my $have_search = gitweb_check_feature('search');
2232
2233 if ($have_search) {
2234 my $performed = "";
2235 if ($searchtype eq 'author') {
2236 $performed = "authored";
2237 } elsif ($searchtype eq 'committer') {
2238 $performed = "committed";
2239 }
2240
2241 return $cgi->a({-href => href(action=>"search", hash=>$hash,
2242 searchtext=>$author,
2243 searchtype=>$searchtype), class=>"list",
2244 title=>"Search for commits $performed by $author"},
2245 $displaytext);
2246
2247 } else {
2248 return $displaytext;
2249 }
2250 }
2251
2252 # format the author name of the given commit with the given tag
2253 # the author name is chopped and escaped according to the other
2254 # optional parameters (see chop_str).
2255 sub format_author_html {
2256 my $tag = shift;
2257 my $co = shift;
2258 my $author = chop_and_escape_str($co->{'author_name'}, @_);
2259 return "<$tag class=\"author\">" .
2260 format_search_author($co->{'author_name'}, "author",
2261 git_get_avatar($co->{'author_email'}, -pad_after => 1) .
2262 $author) .
2263 "</$tag>";
2264 }
2265
2266 # format git diff header line, i.e. "diff --(git|combined|cc) ..."
2267 sub format_git_diff_header_line {
2268 my $line = shift;
2269 my $diffinfo = shift;
2270 my ($from, $to) = @_;
2271
2272 if ($diffinfo->{'nparents'}) {
2273 # combined diff
2274 $line =~ s!^(diff (.*?) )"?.*$!$1!;
2275 if ($to->{'href'}) {
2276 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2277 esc_path($to->{'file'}));
2278 } else { # file was deleted (no href)
2279 $line .= esc_path($to->{'file'});
2280 }
2281 } else {
2282 # "ordinary" diff
2283 $line =~ s!^(diff (.*?) )"?a/.*$!$1!;
2284 if ($from->{'href'}) {
2285 $line .= $cgi->a({-href => $from->{'href'}, -class => "path"},
2286 'a/' . esc_path($from->{'file'}));
2287 } else { # file was added (no href)
2288 $line .= 'a/' . esc_path($from->{'file'});
2289 }
2290 $line .= ' ';
2291 if ($to->{'href'}) {
2292 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2293 'b/' . esc_path($to->{'file'}));
2294 } else { # file was deleted
2295 $line .= 'b/' . esc_path($to->{'file'});
2296 }
2297 }
2298
2299 return "<div class=\"diff header\">$line</div>\n";
2300 }
2301
2302 # format extended diff header line, before patch itself
2303 sub format_extended_diff_header_line {
2304 my $line = shift;
2305 my $diffinfo = shift;
2306 my ($from, $to) = @_;
2307
2308 # match <path>
2309 if ($line =~ s!^((copy|rename) from ).*$!$1! && $from->{'href'}) {
2310 $line .= $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2311 esc_path($from->{'file'}));
2312 }
2313 if ($line =~ s!^((copy|rename) to ).*$!$1! && $to->{'href'}) {
2314 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2315 esc_path($to->{'file'}));
2316 }
2317 # match single <mode>
2318 if ($line =~ m/\s(\d{6})$/) {
2319 $line .= '<span class="info"> (' .
2320 file_type_long($1) .
2321 ')</span>';
2322 }
2323 # match <hash>
2324 if ($line =~ oid_nlen_prefix_infix_regex($sha1_len, "index ", ",") |
2325 $line =~ oid_nlen_prefix_infix_regex($sha256_len, "index ", ",")) {
2326 # can match only for combined diff
2327 $line = 'index ';
2328 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2329 if ($from->{'href'}[$i]) {
2330 $line .= $cgi->a({-href=>$from->{'href'}[$i],
2331 -class=>"hash"},
2332 substr($diffinfo->{'from_id'}[$i],0,7));
2333 } else {
2334 $line .= '0' x 7;
2335 }
2336 # separator
2337 $line .= ',' if ($i < $diffinfo->{'nparents'} - 1);
2338 }
2339 $line .= '..';
2340 if ($to->{'href'}) {
2341 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2342 substr($diffinfo->{'to_id'},0,7));
2343 } else {
2344 $line .= '0' x 7;
2345 }
2346
2347 } elsif ($line =~ oid_nlen_prefix_infix_regex($sha1_len, "index ", "..") |
2348 $line =~ oid_nlen_prefix_infix_regex($sha256_len, "index ", "..")) {
2349 # can match only for ordinary diff
2350 my ($from_link, $to_link);
2351 if ($from->{'href'}) {
2352 $from_link = $cgi->a({-href=>$from->{'href'}, -class=>"hash"},
2353 substr($diffinfo->{'from_id'},0,7));
2354 } else {
2355 $from_link = '0' x 7;
2356 }
2357 if ($to->{'href'}) {
2358 $to_link = $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2359 substr($diffinfo->{'to_id'},0,7));
2360 } else {
2361 $to_link = '0' x 7;
2362 }
2363 my ($from_id, $to_id) = ($diffinfo->{'from_id'}, $diffinfo->{'to_id'});
2364 $line =~ s!$from_id\.\.$to_id!$from_link..$to_link!;
2365 }
2366
2367 return $line . "<br/>\n";
2368 }
2369
2370 # format from-file/to-file diff header
2371 sub format_diff_from_to_header {
2372 my ($from_line, $to_line, $diffinfo, $from, $to, @parents) = @_;
2373 my $line;
2374 my $result = '';
2375
2376 $line = $from_line;
2377 #assert($line =~ m/^---/) if DEBUG;
2378 # no extra formatting for "^--- /dev/null"
2379 if (! $diffinfo->{'nparents'}) {
2380 # ordinary (single parent) diff
2381 if ($line =~ m!^--- "?a/!) {
2382 if ($from->{'href'}) {
2383 $line = '--- a/' .
2384 $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2385 esc_path($from->{'file'}));
2386 } else {
2387 $line = '--- a/' .
2388 esc_path($from->{'file'});
2389 }
2390 }
2391 $result .= qq!<div class="diff from_file">$line</div>\n!;
2392
2393 } else {
2394 # combined diff (merge commit)
2395 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2396 if ($from->{'href'}[$i]) {
2397 $line = '--- ' .
2398 $cgi->a({-href=>href(action=>"blobdiff",
2399 hash_parent=>$diffinfo->{'from_id'}[$i],
2400 hash_parent_base=>$parents[$i],
2401 file_parent=>$from->{'file'}[$i],
2402 hash=>$diffinfo->{'to_id'},
2403 hash_base=>$hash,
2404 file_name=>$to->{'file'}),
2405 -class=>"path",
2406 -title=>"diff" . ($i+1)},
2407 $i+1) .
2408 '/' .
2409 $cgi->a({-href=>$from->{'href'}[$i], -class=>"path"},
2410 esc_path($from->{'file'}[$i]));
2411 } else {
2412 $line = '--- /dev/null';
2413 }
2414 $result .= qq!<div class="diff from_file">$line</div>\n!;
2415 }
2416 }
2417
2418 $line = $to_line;
2419 #assert($line =~ m/^\+\+\+/) if DEBUG;
2420 # no extra formatting for "^+++ /dev/null"
2421 if ($line =~ m!^\+\+\+ "?b/!) {
2422 if ($to->{'href'}) {
2423 $line = '+++ b/' .
2424 $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2425 esc_path($to->{'file'}));
2426 } else {
2427 $line = '+++ b/' .
2428 esc_path($to->{'file'});
2429 }
2430 }
2431 $result .= qq!<div class="diff to_file">$line</div>\n!;
2432
2433 return $result;
2434 }
2435
2436 # create note for patch simplified by combined diff
2437 sub format_diff_cc_simplified {
2438 my ($diffinfo, @parents) = @_;
2439 my $result = '';
2440
2441 $result .= "<div class=\"diff header\">" .
2442 "diff --cc ";
2443 if (!is_deleted($diffinfo)) {
2444 $result .= $cgi->a({-href => href(action=>"blob",
2445 hash_base=>$hash,
2446 hash=>$diffinfo->{'to_id'},
2447 file_name=>$diffinfo->{'to_file'}),
2448 -class => "path"},
2449 esc_path($diffinfo->{'to_file'}));
2450 } else {
2451 $result .= esc_path($diffinfo->{'to_file'});
2452 }
2453 $result .= "</div>\n" . # class="diff header"
2454 "<div class=\"diff nodifferences\">" .
2455 "Simple merge" .
2456 "</div>\n"; # class="diff nodifferences"
2457
2458 return $result;
2459 }
2460
2461 sub diff_line_class {
2462 my ($line, $from, $to) = @_;
2463
2464 # ordinary diff
2465 my $num_sign = 1;
2466 # combined diff
2467 if ($from && $to && ref($from->{'href'}) eq "ARRAY") {
2468 $num_sign = scalar @{$from->{'href'}};
2469 }
2470
2471 my @diff_line_classifier = (
2472 { regexp => qr/^\@\@{$num_sign} /, class => "chunk_header"},
2473 { regexp => qr/^\\/, class => "incomplete" },
2474 { regexp => qr/^ {$num_sign}/, class => "ctx" },
2475 # classifier for context must come before classifier add/rem,
2476 # or we would have to use more complicated regexp, for example
2477 # qr/(?= {0,$m}\+)[+ ]{$num_sign}/, where $m = $num_sign - 1;
2478 { regexp => qr/^[+ ]{$num_sign}/, class => "add" },
2479 { regexp => qr/^[- ]{$num_sign}/, class => "rem" },
2480 );
2481 for my $clsfy (@diff_line_classifier) {
2482 return $clsfy->{'class'}
2483 if ($line =~ $clsfy->{'regexp'});
2484 }
2485
2486 # fallback
2487 return "";
2488 }
2489
2490 # assumes that $from and $to are defined and correctly filled,
2491 # and that $line holds a line of chunk header for unified diff
2492 sub format_unidiff_chunk_header {
2493 my ($line, $from, $to) = @_;
2494
2495 my ($from_text, $from_start, $from_lines, $to_text, $to_start, $to_lines, $section) =
2496 $line =~ m/^\@{2} (-(\d+)(?:,(\d+))?) (\+(\d+)(?:,(\d+))?) \@{2}(.*)$/;
2497
2498 $from_lines = 0 unless defined $from_lines;
2499 $to_lines = 0 unless defined $to_lines;
2500
2501 if ($from->{'href'}) {
2502 $from_text = $cgi->a({-href=>"$from->{'href'}#l$from_start",
2503 -class=>"list"}, $from_text);
2504 }
2505 if ($to->{'href'}) {
2506 $to_text = $cgi->a({-href=>"$to->{'href'}#l$to_start",
2507 -class=>"list"}, $to_text);
2508 }
2509 $line = "<span class=\"chunk_info\">@@ $from_text $to_text @@</span>" .
2510 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2511 return $line;
2512 }
2513
2514 # assumes that $from and $to are defined and correctly filled,
2515 # and that $line holds a line of chunk header for combined diff
2516 sub format_cc_diff_chunk_header {
2517 my ($line, $from, $to) = @_;
2518
2519 my ($prefix, $ranges, $section) = $line =~ m/^(\@+) (.*?) \@+(.*)$/;
2520 my (@from_text, @from_start, @from_nlines, $to_text, $to_start, $to_nlines);
2521
2522 @from_text = split(' ', $ranges);
2523 for (my $i = 0; $i < @from_text; ++$i) {
2524 ($from_start[$i], $from_nlines[$i]) =
2525 (split(',', substr($from_text[$i], 1)), 0);
2526 }
2527
2528 $to_text = pop @from_text;
2529 $to_start = pop @from_start;
2530 $to_nlines = pop @from_nlines;
2531
2532 $line = "<span class=\"chunk_info\">$prefix ";
2533 for (my $i = 0; $i < @from_text; ++$i) {
2534 if ($from->{'href'}[$i]) {
2535 $line .= $cgi->a({-href=>"$from->{'href'}[$i]#l$from_start[$i]",
2536 -class=>"list"}, $from_text[$i]);
2537 } else {
2538 $line .= $from_text[$i];
2539 }
2540 $line .= " ";
2541 }
2542 if ($to->{'href'}) {
2543 $line .= $cgi->a({-href=>"$to->{'href'}#l$to_start",
2544 -class=>"list"}, $to_text);
2545 } else {
2546 $line .= $to_text;
2547 }
2548 $line .= " $prefix</span>" .
2549 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2550 return $line;
2551 }
2552
2553 # process patch (diff) line (not to be used for diff headers),
2554 # returning HTML-formatted (but not wrapped) line.
2555 # If the line is passed as a reference, it is treated as HTML and not
2556 # esc_html()'ed.
2557 sub format_diff_line {
2558 my ($line, $diff_class, $from, $to) = @_;
2559
2560 if (ref($line)) {
2561 $line = $$line;
2562 } else {
2563 chomp $line;
2564 $line = untabify($line);
2565
2566 if ($from && $to && $line =~ m/^\@{2} /) {
2567 $line = format_unidiff_chunk_header($line, $from, $to);
2568 } elsif ($from && $to && $line =~ m/^\@{3}/) {
2569 $line = format_cc_diff_chunk_header($line, $from, $to);
2570 } else {
2571 $line = esc_html($line, -nbsp=>1);
2572 }
2573 }
2574
2575 my $diff_classes = "diff";
2576 $diff_classes .= " $diff_class" if ($diff_class);
2577 $line = "<div class=\"$diff_classes\">$line</div>\n";
2578
2579 return $line;
2580 }
2581
2582 # Generates undef or something like "_snapshot_" or "snapshot (_tbz2_ _zip_)",
2583 # linked. Pass the hash of the tree/commit to snapshot.
2584 sub format_snapshot_links {
2585 my ($hash) = @_;
2586 my $num_fmts = @snapshot_fmts;
2587 if ($num_fmts > 1) {
2588 # A parenthesized list of links bearing format names.
2589 # e.g. "snapshot (_tar.gz_ _zip_)"
2590 return "snapshot (" . join(' ', map
2591 $cgi->a({
2592 -href => href(
2593 action=>"snapshot",
2594 hash=>$hash,
2595 snapshot_format=>$_
2596 )
2597 }, $known_snapshot_formats{$_}{'display'})
2598 , @snapshot_fmts) . ")";
2599 } elsif ($num_fmts == 1) {
2600 # A single "snapshot" link whose tooltip bears the format name.
2601 # i.e. "_snapshot_"
2602 my ($fmt) = @snapshot_fmts;
2603 return
2604 $cgi->a({
2605 -href => href(
2606 action=>"snapshot",
2607 hash=>$hash,
2608 snapshot_format=>$fmt
2609 ),
2610 -title => "in format: $known_snapshot_formats{$fmt}{'display'}"
2611 }, "snapshot");
2612 } else { # $num_fmts == 0
2613 return undef;
2614 }
2615 }
2616
2617 ## ......................................................................
2618 ## functions returning values to be passed, perhaps after some
2619 ## transformation, to other functions; e.g. returning arguments to href()
2620
2621 # returns hash to be passed to href to generate gitweb URL
2622 # in -title key it returns description of link
2623 sub get_feed_info {
2624 my $format = shift || 'Atom';
2625 my %res = (action => lc($format));
2626 my $matched_ref = 0;
2627
2628 # feed links are possible only for project views
2629 return unless (defined $project);
2630 # some views should link to OPML, or to generic project feed,
2631 # or don't have specific feed yet (so they should use generic)
2632 return if (!$action || $action =~ /^(?:tags|heads|forks|tag|search)$/x);
2633
2634 my $branch = undef;
2635 # branches refs uses 'refs/' + $get_branch_refs()[x] + '/' prefix
2636 # (fullname) to differentiate from tag links; this also makes
2637 # possible to detect branch links
2638 for my $ref (get_branch_refs()) {
2639 if ((defined $hash_base && $hash_base =~ m!^refs/\Q$ref\E/(.*)$!) ||
2640 (defined $hash && $hash =~ m!^refs/\Q$ref\E/(.*)$!)) {
2641 $branch = $1;
2642 $matched_ref = $ref;
2643 last;
2644 }
2645 }
2646 # find log type for feed description (title)
2647 my $type = 'log';
2648 if (defined $file_name) {
2649 $type = "history of $file_name";
2650 $type .= "/" if ($action eq 'tree');
2651 $type .= " on '$branch'" if (defined $branch);
2652 } else {
2653 $type = "log of $branch" if (defined $branch);
2654 }
2655
2656 $res{-title} = $type;
2657 $res{'hash'} = (defined $branch ? "refs/$matched_ref/$branch" : undef);
2658 $res{'file_name'} = $file_name;
2659
2660 return %res;
2661 }
2662
2663 ## ----------------------------------------------------------------------
2664 ## git utility subroutines, invoking git commands
2665
2666 # returns path to the core git executable and the --git-dir parameter as list
2667 sub git_cmd {
2668 $number_of_git_cmds++;
2669 return $GIT, '--git-dir='.$git_dir;
2670 }
2671
2672 # quote the given arguments for passing them to the shell
2673 # quote_command("command", "arg 1", "arg with ' and ! characters")
2674 # => "'command' 'arg 1' 'arg with '\'' and '\!' characters'"
2675 # Try to avoid using this function wherever possible.
2676 sub quote_command {
2677 return join(' ',
2678 map { my $a = $_; $a =~ s/(['!])/'\\$1'/g; "'$a'" } @_ );
2679 }
2680
2681 # get HEAD ref of given project as hash
2682 sub git_get_head_hash {
2683 return git_get_full_hash(shift, 'HEAD');
2684 }
2685
2686 sub git_get_full_hash {
2687 return git_get_hash(@_);
2688 }
2689
2690 sub git_get_short_hash {
2691 return git_get_hash(@_, '--short=7');
2692 }
2693
2694 sub git_get_hash {
2695 my ($project, $hash, @options) = @_;
2696 my $o_git_dir = $git_dir;
2697 my $retval = undef;
2698 $git_dir = "$projectroot/$project";
2699 if (open my $fd, '-|', git_cmd(), 'rev-parse',
2700 '--verify', '-q', @options, $hash) {
2701 $retval = <$fd>;
2702 chomp $retval if defined $retval;
2703 close $fd;
2704 }
2705 if (defined $o_git_dir) {
2706 $git_dir = $o_git_dir;
2707 }
2708 return $retval;
2709 }
2710
2711 # get type of given object
2712 sub git_get_type {
2713 my $hash = shift;
2714
2715 open my $fd, "-|", git_cmd(), "cat-file", '-t', $hash or return;
2716 my $type = <$fd>;
2717 close $fd or return;
2718 chomp $type;
2719 return $type;
2720 }
2721
2722 # repository configuration
2723 our $config_file = '';
2724 our %config;
2725
2726 # store multiple values for single key as anonymous array reference
2727 # single values stored directly in the hash, not as [ <value> ]
2728 sub hash_set_multi {
2729 my ($hash, $key, $value) = @_;
2730
2731 if (!exists $hash->{$key}) {
2732 $hash->{$key} = $value;
2733 } elsif (!ref $hash->{$key}) {
2734 $hash->{$key} = [ $hash->{$key}, $value ];
2735 } else {
2736 push @{$hash->{$key}}, $value;
2737 }
2738 }
2739
2740 # return hash of git project configuration
2741 # optionally limited to some section, e.g. 'gitweb'
2742 sub git_parse_project_config {
2743 my $section_regexp = shift;
2744 my %config;
2745
2746 local $/ = "\0";
2747
2748 open my $fh, "-|", git_cmd(), "config", '-z', '-l',
2749 or return;
2750
2751 while (my $keyval = <$fh>) {
2752 chomp $keyval;
2753 my ($key, $value) = split(/\n/, $keyval, 2);
2754
2755 hash_set_multi(\%config, $key, $value)
2756 if (!defined $section_regexp || $key =~ /^(?:$section_regexp)\./o);
2757 }
2758 close $fh;
2759
2760 return %config;
2761 }
2762
2763 # convert config value to boolean: 'true' or 'false'
2764 # no value, number > 0, 'true' and 'yes' values are true
2765 # rest of values are treated as false (never as error)
2766 sub config_to_bool {
2767 my $val = shift;
2768
2769 return 1 if !defined $val; # section.key
2770
2771 # strip leading and trailing whitespace
2772 $val =~ s/^\s+//;
2773 $val =~ s/\s+$//;
2774
2775 return (($val =~ /^\d+$/ && $val) || # section.key = 1
2776 ($val =~ /^(?:true|yes)$/i)); # section.key = true
2777 }
2778
2779 # convert config value to simple decimal number
2780 # an optional value suffix of 'k', 'm', or 'g' will cause the value
2781 # to be multiplied by 1024, 1048576, or 1073741824
2782 sub config_to_int {
2783 my $val = shift;
2784
2785 # strip leading and trailing whitespace
2786 $val =~ s/^\s+//;
2787 $val =~ s/\s+$//;
2788
2789 if (my ($num, $unit) = ($val =~ /^([0-9]*)([kmg])$/i)) {
2790 $unit = lc($unit);
2791 # unknown unit is treated as 1
2792 return $num * ($unit eq 'g' ? 1073741824 :
2793 $unit eq 'm' ? 1048576 :
2794 $unit eq 'k' ? 1024 : 1);
2795 }
2796 return $val;
2797 }
2798
2799 # convert config value to array reference, if needed
2800 sub config_to_multi {
2801 my $val = shift;
2802
2803 return ref($val) ? $val : (defined($val) ? [ $val ] : []);
2804 }
2805
2806 sub git_get_project_config {
2807 my ($key, $type) = @_;
2808
2809 return unless defined $git_dir;
2810
2811 # key sanity check
2812 return unless ($key);
2813 # only subsection, if exists, is case sensitive,
2814 # and not lowercased by 'git config -z -l'
2815 if (my ($hi, $mi, $lo) = ($key =~ /^([^.]*)\.(.*)\.([^.]*)$/)) {
2816 $lo =~ s/_//g;
2817 $key = join(".", lc($hi), $mi, lc($lo));
2818 return if ($lo =~ /\W/ || $hi =~ /\W/);
2819 } else {
2820 $key = lc($key);
2821 $key =~ s/_//g;
2822 return if ($key =~ /\W/);
2823 }
2824 $key =~ s/^gitweb\.//;
2825
2826 # type sanity check
2827 if (defined $type) {
2828 $type =~ s/^--//;
2829 $type = undef
2830 unless ($type eq 'bool' || $type eq 'int');
2831 }
2832
2833 # get config
2834 if (!defined $config_file ||
2835 $config_file ne "$git_dir/config") {
2836 %config = git_parse_project_config('gitweb');
2837 $config_file = "$git_dir/config";
2838 }
2839
2840 # check if config variable (key) exists
2841 return unless exists $config{"gitweb.$key"};
2842
2843 # ensure given type
2844 if (!defined $type) {
2845 return $config{"gitweb.$key"};
2846 } elsif ($type eq 'bool') {
2847 # backward compatibility: 'git config --bool' returns true/false
2848 return config_to_bool($config{"gitweb.$key"}) ? 'true' : 'false';
2849 } elsif ($type eq 'int') {
2850 return config_to_int($config{"gitweb.$key"});
2851 }
2852 return $config{"gitweb.$key"};
2853 }
2854
2855 # get hash of given path at given ref
2856 sub git_get_hash_by_path {
2857 my $base = shift;
2858 my $path = shift || return undef;
2859 my $type = shift;
2860
2861 $path =~ s,/+$,,;
2862
2863 open my $fd, "-|", git_cmd(), "ls-tree", $base, "--", $path
2864 or die_error(500, "Open git-ls-tree failed");
2865 my $line = <$fd>;
2866 close $fd or return undef;
2867
2868 if (!defined $line) {
2869 # there is no tree or hash given by $path at $base
2870 return undef;
2871 }
2872
2873 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
2874 $line =~ m/^([0-9]+) (.+) ($oid_regex)\t/;
2875 if (defined $type && $type ne $2) {
2876 # type doesn't match
2877 return undef;
2878 }
2879 return $3;
2880 }
2881
2882 # get path of entry with given hash at given tree-ish (ref)
2883 # used to get 'from' filename for combined diff (merge commit) for renames
2884 sub git_get_path_by_hash {
2885 my $base = shift || return;
2886 my $hash = shift || return;
2887
2888 local $/ = "\0";
2889
2890 open my $fd, "-|", git_cmd(), "ls-tree", '-r', '-t', '-z', $base
2891 or return undef;
2892 while (my $line = <$fd>) {
2893 chomp $line;
2894
2895 #'040000 tree 595596a6a9117ddba9fe379b6b012b558bac8423 gitweb'
2896 #'100644 blob e02e90f0429be0d2a69b76571101f20b8f75530f gitweb/README'
2897 if ($line =~ m/(?:[0-9]+) (?:.+) $hash\t(.+)$/) {
2898 close $fd;
2899 return $1;
2900 }
2901 }
2902 close $fd;
2903 return undef;
2904 }
2905
2906 ## ......................................................................
2907 ## git utility functions, directly accessing git repository
2908
2909 # get the value of config variable either from file named as the variable
2910 # itself in the repository ($GIT_DIR/$name file), or from gitweb.$name
2911 # configuration variable in the repository config file.
2912 sub git_get_file_or_project_config {
2913 my ($path, $name) = @_;
2914
2915 $git_dir = "$projectroot/$path";
2916 open my $fd, '<', "$git_dir/$name"
2917 or return git_get_project_config($name);
2918 my $conf = <$fd>;
2919 close $fd;
2920 if (defined $conf) {
2921 chomp $conf;
2922 }
2923 return $conf;
2924 }
2925
2926 sub git_get_project_description {
2927 my $path = shift;
2928 return git_get_file_or_project_config($path, 'description');
2929 }
2930
2931 sub git_get_project_category {
2932 my $path = shift;
2933 return git_get_file_or_project_config($path, 'category');
2934 }
2935
2936
2937 # supported formats:
2938 # * $GIT_DIR/ctags/<tagname> file (in 'ctags' subdirectory)
2939 # - if its contents is a number, use it as tag weight,
2940 # - otherwise add a tag with weight 1
2941 # * $GIT_DIR/ctags file, each line is a tag (with weight 1)
2942 # the same value multiple times increases tag weight
2943 # * `gitweb.ctag' multi-valued repo config variable
2944 sub git_get_project_ctags {
2945 my $project = shift;
2946 my $ctags = {};
2947
2948 $git_dir = "$projectroot/$project";
2949 if (opendir my $dh, "$git_dir/ctags") {
2950 my @files = grep { -f $_ } map { "$git_dir/ctags/$_" } readdir($dh);
2951 foreach my $tagfile (@files) {
2952 open my $ct, '<', $tagfile
2953 or next;
2954 my $val = <$ct>;
2955 chomp $val if $val;
2956 close $ct;
2957
2958 (my $ctag = $tagfile) =~ s#.*/##;
2959 if ($val =~ /^\d+$/) {
2960 $ctags->{$ctag} = $val;
2961 } else {
2962 $ctags->{$ctag} = 1;
2963 }
2964 }
2965 closedir $dh;
2966
2967 } elsif (open my $fh, '<', "$git_dir/ctags") {
2968 while (my $line = <$fh>) {
2969 chomp $line;
2970 $ctags->{$line}++ if $line;
2971 }
2972 close $fh;
2973
2974 } else {
2975 my $taglist = config_to_multi(git_get_project_config('ctag'));
2976 foreach my $tag (@$taglist) {
2977 $ctags->{$tag}++;
2978 }
2979 }
2980
2981 return $ctags;
2982 }
2983
2984 # return hash, where keys are content tags ('ctags'),
2985 # and values are sum of weights of given tag in every project
2986 sub git_gather_all_ctags {
2987 my $projects = shift;
2988 my $ctags = {};
2989
2990 foreach my $p (@$projects) {
2991 foreach my $ct (keys %{$p->{'ctags'}}) {
2992 $ctags->{$ct} += $p->{'ctags'}->{$ct};
2993 }
2994 }
2995
2996 return $ctags;
2997 }
2998
2999 sub git_populate_project_tagcloud {
3000 my $ctags = shift;
3001
3002 # First, merge different-cased tags; tags vote on casing
3003 my %ctags_lc;
3004 foreach (keys %$ctags) {
3005 $ctags_lc{lc $_}->{count} += $ctags->{$_};
3006 if (not $ctags_lc{lc $_}->{topcount}
3007 or $ctags_lc{lc $_}->{topcount} < $ctags->{$_}) {
3008 $ctags_lc{lc $_}->{topcount} = $ctags->{$_};
3009 $ctags_lc{lc $_}->{topname} = $_;
3010 }
3011 }
3012
3013 my $cloud;
3014 my $matched = $input_params{'ctag'};
3015 if (eval { require HTML::TagCloud; 1; }) {
3016 $cloud = HTML::TagCloud->new;
3017 foreach my $ctag (sort keys %ctags_lc) {
3018 # Pad the title with spaces so that the cloud looks
3019 # less crammed.
3020 my $title = esc_html($ctags_lc{$ctag}->{topname});
3021 $title =~ s/ /&nbsp;/g;
3022 $title =~ s/^/&nbsp;/g;
3023 $title =~ s/$/&nbsp;/g;
3024 if (defined $matched && $matched eq $ctag) {
3025 $title = qq(<span class="match">$title</span>);
3026 }
3027 $cloud->add($title, href(project=>undef, ctag=>$ctag),
3028 $ctags_lc{$ctag}->{count});
3029 }
3030 } else {
3031 $cloud = {};
3032 foreach my $ctag (keys %ctags_lc) {
3033 my $title = esc_html($ctags_lc{$ctag}->{topname}, -nbsp=>1);
3034 if (defined $matched && $matched eq $ctag) {
3035 $title = qq(<span class="match">$title</span>);
3036 }
3037 $cloud->{$ctag}{count} = $ctags_lc{$ctag}->{count};
3038 $cloud->{$ctag}{ctag} =
3039 $cgi->a({-href=>href(project=>undef, ctag=>$ctag)}, $title);
3040 }
3041 }
3042 return $cloud;
3043 }
3044
3045 sub git_show_project_tagcloud {
3046 my ($cloud, $count) = @_;
3047 if (ref $cloud eq 'HTML::TagCloud') {
3048 return $cloud->html_and_css($count);
3049 } else {
3050 my @tags = sort { $cloud->{$a}->{'count'} <=> $cloud->{$b}->{'count'} } keys %$cloud;
3051 return
3052 '<div id="htmltagcloud"'.($project ? '' : ' align="center"').'>' .
3053 join (', ', map {
3054 $cloud->{$_}->{'ctag'}
3055 } splice(@tags, 0, $count)) .
3056 '</div>';
3057 }
3058 }
3059
3060 sub git_get_project_url_list {
3061 my $path = shift;
3062
3063 $git_dir = "$projectroot/$path";
3064 open my $fd, '<', "$git_dir/cloneurl"
3065 or return wantarray ?
3066 @{ config_to_multi(git_get_project_config('url')) } :
3067 config_to_multi(git_get_project_config('url'));
3068 my @git_project_url_list = map { chomp; $_ } <$fd>;
3069 close $fd;
3070
3071 return wantarray ? @git_project_url_list : \@git_project_url_list;
3072 }
3073
3074 sub git_get_projects_list {
3075 my $filter = shift || '';
3076 my $paranoid = shift;
3077 my @list;
3078
3079 if (-d $projects_list) {
3080 # search in directory
3081 my $dir = $projects_list;
3082 # remove the trailing "/"
3083 $dir =~ s!/+$!!;
3084 my $pfxlen = length("$dir");
3085 my $pfxdepth = ($dir =~ tr!/!!);
3086 # when filtering, search only given subdirectory
3087 if ($filter && !$paranoid) {
3088 $dir .= "/$filter";
3089 $dir =~ s!/+$!!;
3090 }
3091
3092 File::Find::find({
3093 follow_fast => 1, # follow symbolic links
3094 follow_skip => 2, # ignore duplicates
3095 dangling_symlinks => 0, # ignore dangling symlinks, silently
3096 wanted => sub {
3097 # global variables
3098 our $project_maxdepth;
3099 our $projectroot;
3100 # skip project-list toplevel, if we get it.
3101 return if (m!^[/.]$!);
3102 # only directories can be git repositories
3103 return unless (-d $_);
3104 # need search permission
3105 return unless (-x $_);
3106 # don't traverse too deep (Find is super slow on os x)
3107 # $project_maxdepth excludes depth of $projectroot
3108 if (($File::Find::name =~ tr!/!!) - $pfxdepth > $project_maxdepth) {
3109 $File::Find::prune = 1;
3110 return;
3111 }
3112
3113 my $path = substr($File::Find::name, $pfxlen + 1);
3114 # paranoidly only filter here
3115 if ($paranoid && $filter && $path !~ m!^\Q$filter\E/!) {
3116 next;
3117 }
3118 # we check related file in $projectroot
3119 if (check_export_ok("$projectroot/$path")) {
3120 push @list, { path => $path };
3121 $File::Find::prune = 1;
3122 }
3123 },
3124 }, "$dir");
3125
3126 } elsif (-f $projects_list) {
3127 # read from file(url-encoded):
3128 # 'git%2Fgit.git Linus+Torvalds'
3129 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3130 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3131 open my $fd, '<', $projects_list or return;
3132 PROJECT:
3133 while (my $line = <$fd>) {
3134 chomp $line;
3135 my ($path, $owner) = split ' ', $line;
3136 $path = unescape($path);
3137 $owner = unescape($owner);
3138 if (!defined $path) {
3139 next;
3140 }
3141 # if $filter is rpovided, check if $path begins with $filter
3142 if ($filter && $path !~ m!^\Q$filter\E/!) {
3143 next;
3144 }
3145 if (check_export_ok("$projectroot/$path")) {
3146 my $pr = {
3147 path => $path
3148 };
3149 if ($owner) {
3150 $pr->{'owner'} = to_utf8($owner);
3151 }
3152 push @list, $pr;
3153 }
3154 }
3155 close $fd;
3156 }
3157 return @list;
3158 }
3159
3160 # written with help of Tree::Trie module (Perl Artistic License, GPL compatible)
3161 # as side effects it sets 'forks' field to list of forks for forked projects
3162 sub filter_forks_from_projects_list {
3163 my $projects = shift;
3164
3165 my %trie; # prefix tree of directories (path components)
3166 # generate trie out of those directories that might contain forks
3167 foreach my $pr (@$projects) {
3168 my $path = $pr->{'path'};
3169 $path =~ s/\.git$//; # forks of 'repo.git' are in 'repo/' directory
3170 next if ($path =~ m!/$!); # skip non-bare repositories, e.g. 'repo/.git'
3171 next unless ($path); # skip '.git' repository: tests, git-instaweb
3172 next unless (-d "$projectroot/$path"); # containing directory exists
3173 $pr->{'forks'} = []; # there can be 0 or more forks of project
3174
3175 # add to trie
3176 my @dirs = split('/', $path);
3177 # walk the trie, until either runs out of components or out of trie
3178 my $ref = \%trie;
3179 while (scalar @dirs &&
3180 exists($ref->{$dirs[0]})) {
3181 $ref = $ref->{shift @dirs};
3182 }
3183 # create rest of trie structure from rest of components
3184 foreach my $dir (@dirs) {
3185 $ref = $ref->{$dir} = {};
3186 }
3187 # create end marker, store $pr as a data
3188 $ref->{''} = $pr if (!exists $ref->{''});
3189 }
3190
3191 # filter out forks, by finding shortest prefix match for paths
3192 my @filtered;
3193 PROJECT:
3194 foreach my $pr (@$projects) {
3195 # trie lookup
3196 my $ref = \%trie;
3197 DIR:
3198 foreach my $dir (split('/', $pr->{'path'})) {
3199 if (exists $ref->{''}) {
3200 # found [shortest] prefix, is a fork - skip it
3201 push @{$ref->{''}{'forks'}}, $pr;
3202 next PROJECT;
3203 }
3204 if (!exists $ref->{$dir}) {
3205 # not in trie, cannot have prefix, not a fork
3206 push @filtered, $pr;
3207 next PROJECT;
3208 }
3209 # If the dir is there, we just walk one step down the trie.
3210 $ref = $ref->{$dir};
3211 }
3212 # we ran out of trie
3213 # (shouldn't happen: it's either no match, or end marker)
3214 push @filtered, $pr;
3215 }
3216
3217 return @filtered;
3218 }
3219
3220 # note: fill_project_list_info must be run first,
3221 # for 'descr_long' and 'ctags' to be filled
3222 sub search_projects_list {
3223 my ($projlist, %opts) = @_;
3224 my $tagfilter = $opts{'tagfilter'};
3225 my $search_re = $opts{'search_regexp'};
3226
3227 return @$projlist
3228 unless ($tagfilter || $search_re);
3229
3230 # searching projects require filling to be run before it;
3231 fill_project_list_info($projlist,
3232 $tagfilter ? 'ctags' : (),
3233 $search_re ? ('path', 'descr') : ());
3234 my @projects;
3235 PROJECT:
3236 foreach my $pr (@$projlist) {
3237
3238 if ($tagfilter) {
3239 next unless ref($pr->{'ctags'}) eq 'HASH';
3240 next unless
3241 grep { lc($_) eq lc($tagfilter) } keys %{$pr->{'ctags'}};
3242 }
3243
3244 if ($search_re) {
3245 next unless
3246 $pr->{'path'} =~ /$search_re/ ||
3247 $pr->{'descr_long'} =~ /$search_re/;
3248 }
3249
3250 push @projects, $pr;
3251 }
3252
3253 return @projects;
3254 }
3255
3256 our $gitweb_project_owner = undef;
3257 sub git_get_project_list_from_file {
3258
3259 return if (defined $gitweb_project_owner);
3260
3261 $gitweb_project_owner = {};
3262 # read from file (url-encoded):
3263 # 'git%2Fgit.git Linus+Torvalds'
3264 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3265 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3266 if (-f $projects_list) {
3267 open(my $fd, '<', $projects_list);
3268 while (my $line = <$fd>) {
3269 chomp $line;
3270 my ($pr, $ow) = split ' ', $line;
3271 $pr = unescape($pr);
3272 $ow = unescape($ow);
3273 $gitweb_project_owner->{$pr} = to_utf8($ow);
3274 }
3275 close $fd;
3276 }
3277 }
3278
3279 sub git_get_project_owner {
3280 my $project = shift;
3281 my $owner;
3282
3283 return undef unless $project;
3284 $git_dir = "$projectroot/$project";
3285
3286 if (!defined $gitweb_project_owner) {
3287 git_get_project_list_from_file();
3288 }
3289
3290 if (exists $gitweb_project_owner->{$project}) {
3291 $owner = $gitweb_project_owner->{$project};
3292 }
3293 if (!defined $owner){
3294 $owner = git_get_project_config('owner');
3295 }
3296 if (!defined $owner) {
3297 $owner = get_file_owner("$git_dir");
3298 }
3299
3300 return $owner;
3301 }
3302
3303 sub git_get_last_activity {
3304 my ($path) = @_;
3305 my $fd;
3306
3307 $git_dir = "$projectroot/$path";
3308 open($fd, "-|", git_cmd(), 'for-each-ref',
3309 '--format=%(committer)',
3310 '--sort=-committerdate',
3311 '--count=1',
3312 map { "refs/$_" } get_branch_refs ()) or return;
3313 my $most_recent = <$fd>;
3314 close $fd or return;
3315 if (defined $most_recent &&
3316 $most_recent =~ / (\d+) [-+][01]\d\d\d$/) {
3317 my $timestamp = $1;
3318 my $age = time - $timestamp;
3319 return ($age, age_string($age));
3320 }
3321 return (undef, undef);
3322 }
3323
3324 # Implementation note: when a single remote is wanted, we cannot use 'git
3325 # remote show -n' because that command always work (assuming it's a remote URL
3326 # if it's not defined), and we cannot use 'git remote show' because that would
3327 # try to make a network roundtrip. So the only way to find if that particular
3328 # remote is defined is to walk the list provided by 'git remote -v' and stop if
3329 # and when we find what we want.
3330 sub git_get_remotes_list {
3331 my $wanted = shift;
3332 my %remotes = ();
3333
3334 open my $fd, '-|' , git_cmd(), 'remote', '-v';
3335 return unless $fd;
3336 while (my $remote = <$fd>) {
3337 chomp $remote;
3338 $remote =~ s!\t(.*?)\s+\((\w+)\)$!!;
3339 next if $wanted and not $remote eq $wanted;
3340 my ($url, $key) = ($1, $2);
3341
3342 $remotes{$remote} ||= { 'heads' => () };
3343 $remotes{$remote}{$key} = $url;
3344 }
3345 close $fd or return;
3346 return wantarray ? %remotes : \%remotes;
3347 }
3348
3349 # Takes a hash of remotes as first parameter and fills it by adding the
3350 # available remote heads for each of the indicated remotes.
3351 sub fill_remote_heads {
3352 my $remotes = shift;
3353 my @heads = map { "remotes/$_" } keys %$remotes;
3354 my @remoteheads = git_get_heads_list(undef, @heads);
3355 foreach my $remote (keys %$remotes) {
3356 $remotes->{$remote}{'heads'} = [ grep {
3357 $_->{'name'} =~ s!^$remote/!!
3358 } @remoteheads ];
3359 }
3360 }
3361
3362 sub git_get_references {
3363 my $type = shift || "";
3364 my %refs;
3365 # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
3366 # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
3367 open my $fd, "-|", git_cmd(), "show-ref", "--dereference",
3368 ($type ? ("--", "refs/$type") : ()) # use -- <pattern> if $type
3369 or return;
3370
3371 while (my $line = <$fd>) {
3372 chomp $line;
3373 if ($line =~ m!^($oid_regex)\srefs/($type.*)$!) {
3374 if (defined $refs{$1}) {
3375 push @{$refs{$1}}, $2;
3376 } else {
3377 $refs{$1} = [ $2 ];
3378 }
3379 }
3380 }
3381 close $fd or return;
3382 return \%refs;
3383 }
3384
3385 sub git_get_rev_name_tags {
3386 my $hash = shift || return undef;
3387
3388 open my $fd, "-|", git_cmd(), "name-rev", "--tags", $hash
3389 or return;
3390 my $name_rev = <$fd>;
3391 close $fd;
3392
3393 if ($name_rev =~ m|^$hash tags/(.*)$|) {
3394 return $1;
3395 } else {
3396 # catches also '$hash undefined' output
3397 return undef;
3398 }
3399 }
3400
3401 ## ----------------------------------------------------------------------
3402 ## parse to hash functions
3403
3404 sub parse_date {
3405 my $epoch = shift;
3406 my $tz = shift || "-0000";
3407
3408 my %date;
3409 my @months = ("Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
3410 my @days = ("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat");
3411 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($epoch);
3412 $date{'hour'} = $hour;
3413 $date{'minute'} = $min;
3414 $date{'mday'} = $mday;
3415 $date{'day'} = $days[$wday];
3416 $date{'month'} = $months[$mon];
3417 $date{'rfc2822'} = sprintf "%s, %d %s %4d %02d:%02d:%02d +0000",
3418 $days[$wday], $mday, $months[$mon], 1900+$year, $hour ,$min, $sec;
3419 $date{'mday-time'} = sprintf "%d %s %02d:%02d",
3420 $mday, $months[$mon], $hour ,$min;
3421 $date{'iso-8601'} = sprintf "%04d-%02d-%02dT%02d:%02d:%02dZ",
3422 1900+$year, 1+$mon, $mday, $hour ,$min, $sec;
3423
3424 my ($tz_sign, $tz_hour, $tz_min) =
3425 ($tz =~ m/^([-+])(\d\d)(\d\d)$/);
3426 $tz_sign = ($tz_sign eq '-' ? -1 : +1);
3427 my $local = $epoch + $tz_sign*((($tz_hour*60) + $tz_min)*60);
3428 ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($local);
3429 $date{'hour_local'} = $hour;
3430 $date{'minute_local'} = $min;
3431 $date{'tz_local'} = $tz;
3432 $date{'iso-tz'} = sprintf("%04d-%02d-%02d %02d:%02d:%02d %s",
3433 1900+$year, $mon+1, $mday,
3434 $hour, $min, $sec, $tz);
3435 return %date;
3436 }
3437
3438 sub parse_tag {
3439 my $tag_id = shift;
3440 my %tag;
3441 my @comment;
3442
3443 open my $fd, "-|", git_cmd(), "cat-file", "tag", $tag_id or return;
3444 $tag{'id'} = $tag_id;
3445 while (my $line = <$fd>) {
3446 chomp $line;
3447 if ($line =~ m/^object ($oid_regex)$/) {
3448 $tag{'object'} = $1;
3449 } elsif ($line =~ m/^type (.+)$/) {
3450 $tag{'type'} = $1;
3451 } elsif ($line =~ m/^tag (.+)$/) {
3452 $tag{'name'} = $1;
3453 } elsif ($line =~ m/^tagger (.*) ([0-9]+) (.*)$/) {
3454 $tag{'author'} = $1;
3455 $tag{'author_epoch'} = $2;
3456 $tag{'author_tz'} = $3;
3457 if ($tag{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3458 $tag{'author_name'} = $1;
3459 $tag{'author_email'} = $2;
3460 } else {
3461 $tag{'author_name'} = $tag{'author'};
3462 }
3463 } elsif ($line =~ m/--BEGIN/) {
3464 push @comment, $line;
3465 last;
3466 } elsif ($line eq "") {
3467 last;
3468 }
3469 }
3470 push @comment, <$fd>;
3471 $tag{'comment'} = \@comment;
3472 close $fd or return;
3473 if (!defined $tag{'name'}) {
3474 return
3475 };
3476 return %tag
3477 }
3478
3479 sub parse_commit_text {
3480 my ($commit_text, $withparents) = @_;
3481 my @commit_lines = split '\n', $commit_text;
3482 my %co;
3483
3484 pop @commit_lines; # Remove '\0'
3485
3486 if (! @commit_lines) {
3487 return;
3488 }
3489
3490 my $header = shift @commit_lines;
3491 if ($header !~ m/^$oid_regex/) {
3492 return;
3493 }
3494 ($co{'id'}, my @parents) = split ' ', $header;
3495 while (my $line = shift @commit_lines) {
3496 last if $line eq "\n";
3497 if ($line =~ m/^tree ($oid_regex)$/) {
3498 $co{'tree'} = $1;
3499 } elsif ((!defined $withparents) && ($line =~ m/^parent ($oid_regex)$/)) {
3500 push @parents, $1;
3501 } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {
3502 $co{'author'} = to_utf8($1);
3503 $co{'author_epoch'} = $2;
3504 $co{'author_tz'} = $3;
3505 if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3506 $co{'author_name'} = $1;
3507 $co{'author_email'} = $2;
3508 } else {
3509 $co{'author_name'} = $co{'author'};
3510 }
3511 } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {
3512 $co{'committer'} = to_utf8($1);
3513 $co{'committer_epoch'} = $2;
3514 $co{'committer_tz'} = $3;
3515 if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
3516 $co{'committer_name'} = $1;
3517 $co{'committer_email'} = $2;
3518 } else {
3519 $co{'committer_name'} = $co{'committer'};
3520 }
3521 }
3522 }
3523 if (!defined $co{'tree'}) {
3524 return;
3525 };
3526 $co{'parents'} = \@parents;
3527 $co{'parent'} = $parents[0];
3528
3529 foreach my $title (@commit_lines) {
3530 $title =~ s/^ //;
3531 if ($title ne "") {
3532 $co{'title'} = chop_str($title, 80, 5);
3533 # remove leading stuff of merges to make the interesting part visible
3534 if (length($title) > 50) {
3535 $title =~ s/^Automatic //;
3536 $title =~ s/^merge (of|with) /Merge ... /i;
3537 if (length($title) > 50) {
3538 $title =~ s/(http|rsync):\/\///;
3539 }
3540 if (length($title) > 50) {
3541 $title =~ s/(master|www|rsync)\.//;
3542 }
3543 if (length($title) > 50) {
3544 $title =~ s/kernel.org:?//;
3545 }
3546 if (length($title) > 50) {
3547 $title =~ s/\/pub\/scm//;
3548 }
3549 }
3550 $co{'title_short'} = chop_str($title, 50, 5);
3551 last;
3552 }
3553 }
3554 if (! defined $co{'title'} || $co{'title'} eq "") {
3555 $co{'title'} = $co{'title_short'} = '(no commit message)';
3556 }
3557 # remove added spaces
3558 foreach my $line (@commit_lines) {
3559 $line =~ s/^ //;
3560 }
3561 $co{'comment'} = \@commit_lines;
3562
3563 my $age = time - $co{'committer_epoch'};
3564 $co{'age'} = $age;
3565 $co{'age_string'} = age_string($age);
3566 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($co{'committer_epoch'});
3567 if ($age > 60*60*24*7*2) {
3568 $co{'age_string_date'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3569 $co{'age_string_age'} = $co{'age_string'};
3570 } else {
3571 $co{'age_string_date'} = $co{'age_string'};
3572 $co{'age_string_age'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3573 }