gitweb: Allow line number toggling with Javascript
[git/dscho.git] / gitweb / gitweb.perl
blob5596cfd637af7e5d9ae7852d3af3a87fcfb99626
1 #!/usr/bin/perl
3 # gitweb - simple web interface to track changes in git repositories
5 # (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
6 # (C) 2005, Christian Gierke
8 # This program is licensed under the GPLv2
10 use 5.008;
11 use strict;
12 use warnings;
13 use CGI qw(:standard :escapeHTML -nosticky);
14 use CGI::Util qw(unescape);
15 use CGI::Carp qw(fatalsToBrowser set_message);
16 use Encode;
17 use Fcntl ':mode';
18 use File::Find qw();
19 use File::Basename qw(basename);
20 use Time::HiRes qw(gettimeofday tv_interval);
21 binmode STDOUT, ':utf8';
23 our $t0 = [ gettimeofday() ];
24 our $number_of_git_cmds = 0;
26 BEGIN {
27 CGI->compile() if $ENV{'MOD_PERL'};
30 our $version = "++GIT_VERSION++";
32 our ($my_url, $my_uri, $base_url, $path_info, $home_link);
33 sub evaluate_uri {
34 our $cgi;
36 our $my_url = $cgi->url();
37 our $my_uri = $cgi->url(-absolute => 1);
39 # Base URL for relative URLs in gitweb ($logo, $favicon, ...),
40 # needed and used only for URLs with nonempty PATH_INFO
41 our $base_url = $my_url;
43 # When the script is used as DirectoryIndex, the URL does not contain the name
44 # of the script file itself, and $cgi->url() fails to strip PATH_INFO, so we
45 # have to do it ourselves. We make $path_info global because it's also used
46 # later on.
48 # Another issue with the script being the DirectoryIndex is that the resulting
49 # $my_url data is not the full script URL: this is good, because we want
50 # generated links to keep implying the script name if it wasn't explicitly
51 # indicated in the URL we're handling, but it means that $my_url cannot be used
52 # as base URL.
53 # Therefore, if we needed to strip PATH_INFO, then we know that we have
54 # to build the base URL ourselves:
55 our $path_info = $ENV{"PATH_INFO"};
56 if ($path_info) {
57 if ($my_url =~ s,\Q$path_info\E$,, &&
58 $my_uri =~ s,\Q$path_info\E$,, &&
59 defined $ENV{'SCRIPT_NAME'}) {
60 $base_url = $cgi->url(-base => 1) . $ENV{'SCRIPT_NAME'};
64 # target of the home link on top of all pages
65 our $home_link = $my_uri || "/";
68 # core git executable to use
69 # this can just be "git" if your webserver has a sensible PATH
70 our $GIT = "++GIT_BINDIR++/git";
72 # absolute fs-path which will be prepended to the project path
73 #our $projectroot = "/pub/scm";
74 our $projectroot = "++GITWEB_PROJECTROOT++";
76 # fs traversing limit for getting project list
77 # the number is relative to the projectroot
78 our $project_maxdepth = "++GITWEB_PROJECT_MAXDEPTH++";
80 # string of the home link on top of all pages
81 our $home_link_str = "++GITWEB_HOME_LINK_STR++";
83 # name of your site or organization to appear in page titles
84 # replace this with something more descriptive for clearer bookmarks
85 our $site_name = "++GITWEB_SITENAME++"
86 || ($ENV{'SERVER_NAME'} || "Untitled") . " Git";
88 # html snippet to include in the <head> section of each page
89 our $site_html_head_string = "++GITWEB_SITE_HTML_HEAD_STRING++";
90 # filename of html text to include at top of each page
91 our $site_header = "++GITWEB_SITE_HEADER++";
92 # html text to include at home page
93 our $home_text = "++GITWEB_HOMETEXT++";
94 # filename of html text to include at bottom of each page
95 our $site_footer = "++GITWEB_SITE_FOOTER++";
97 # URI of stylesheets
98 our @stylesheets = ("++GITWEB_CSS++");
99 # URI of a single stylesheet, which can be overridden in GITWEB_CONFIG.
100 our $stylesheet = undef;
101 # URI of GIT logo (72x27 size)
102 our $logo = "++GITWEB_LOGO++";
103 # URI of GIT favicon, assumed to be image/png type
104 our $favicon = "++GITWEB_FAVICON++";
105 # URI of gitweb.js (JavaScript code for gitweb)
106 our $javascript = "++GITWEB_JS++";
108 # URI and label (title) of GIT logo link
109 #our $logo_url = "http://www.kernel.org/pub/software/scm/git/docs/";
110 #our $logo_label = "git documentation";
111 our $logo_url = "http://git-scm.com/";
112 our $logo_label = "git homepage";
114 # source of projects list
115 our $projects_list = "++GITWEB_LIST++";
117 # the width (in characters) of the projects list "Description" column
118 our $projects_list_description_width = 25;
120 # group projects by category on the projects list
121 # (enabled if this variable evaluates to true)
122 our $projects_list_group_categories = 0;
124 # default category if none specified
125 # (leave the empty string for no category)
126 our $project_list_default_category = "";
128 # default order of projects list
129 # valid values are none, project, descr, owner, and age
130 our $default_projects_order = "project";
132 # show repository only if this file exists
133 # (only effective if this variable evaluates to true)
134 our $export_ok = "++GITWEB_EXPORT_OK++";
136 # show repository only if this subroutine returns true
137 # when given the path to the project, for example:
138 # sub { return -e "$_[0]/git-daemon-export-ok"; }
139 our $export_auth_hook = undef;
141 # only allow viewing of repositories also shown on the overview page
142 our $strict_export = "++GITWEB_STRICT_EXPORT++";
144 # list of git base URLs used for URL to where fetch project from,
145 # i.e. full URL is "$git_base_url/$project"
146 our @git_base_url_list = grep { $_ ne '' } ("++GITWEB_BASE_URL++");
148 # default blob_plain mimetype and default charset for text/plain blob
149 our $default_blob_plain_mimetype = 'text/plain';
150 our $default_text_plain_charset = undef;
152 # file to use for guessing MIME types before trying /etc/mime.types
153 # (relative to the current git repository)
154 our $mimetypes_file = undef;
156 # assume this charset if line contains non-UTF-8 characters;
157 # it should be valid encoding (see Encoding::Supported(3pm) for list),
158 # for which encoding all byte sequences are valid, for example
159 # 'iso-8859-1' aka 'latin1' (it is decoded without checking, so it
160 # could be even 'utf-8' for the old behavior)
161 our $fallback_encoding = 'latin1';
163 # rename detection options for git-diff and git-diff-tree
164 # - default is '-M', with the cost proportional to
165 # (number of removed files) * (number of new files).
166 # - more costly is '-C' (which implies '-M'), with the cost proportional to
167 # (number of changed files + number of removed files) * (number of new files)
168 # - even more costly is '-C', '--find-copies-harder' with cost
169 # (number of files in the original tree) * (number of new files)
170 # - one might want to include '-B' option, e.g. '-B', '-M'
171 our @diff_opts = ('-M'); # taken from git_commit
173 # Disables features that would allow repository owners to inject script into
174 # the gitweb domain.
175 our $prevent_xss = 0;
177 # Path to the highlight executable to use (must be the one from
178 # http://www.andre-simon.de due to assumptions about parameters and output).
179 # Useful if highlight is not installed on your webserver's PATH.
180 # [Default: highlight]
181 our $highlight_bin = "++HIGHLIGHT_BIN++";
183 # information about snapshot formats that gitweb is capable of serving
184 our %known_snapshot_formats = (
185 # name => {
186 # 'display' => display name,
187 # 'type' => mime type,
188 # 'suffix' => filename suffix,
189 # 'format' => --format for git-archive,
190 # 'compressor' => [compressor command and arguments]
191 # (array reference, optional)
192 # 'disabled' => boolean (optional)}
194 'tgz' => {
195 'display' => 'tar.gz',
196 'type' => 'application/x-gzip',
197 'suffix' => '.tar.gz',
198 'format' => 'tar',
199 'compressor' => ['gzip', '-n']},
201 'tbz2' => {
202 'display' => 'tar.bz2',
203 'type' => 'application/x-bzip2',
204 'suffix' => '.tar.bz2',
205 'format' => 'tar',
206 'compressor' => ['bzip2']},
208 'txz' => {
209 'display' => 'tar.xz',
210 'type' => 'application/x-xz',
211 'suffix' => '.tar.xz',
212 'format' => 'tar',
213 'compressor' => ['xz'],
214 'disabled' => 1},
216 'zip' => {
217 'display' => 'zip',
218 'type' => 'application/x-zip',
219 'suffix' => '.zip',
220 'format' => 'zip'},
223 # Aliases so we understand old gitweb.snapshot values in repository
224 # configuration.
225 our %known_snapshot_format_aliases = (
226 'gzip' => 'tgz',
227 'bzip2' => 'tbz2',
228 'xz' => 'txz',
230 # backward compatibility: legacy gitweb config support
231 'x-gzip' => undef, 'gz' => undef,
232 'x-bzip2' => undef, 'bz2' => undef,
233 'x-zip' => undef, '' => undef,
236 # Pixel sizes for icons and avatars. If the default font sizes or lineheights
237 # are changed, it may be appropriate to change these values too via
238 # $GITWEB_CONFIG.
239 our %avatar_size = (
240 'default' => 16,
241 'double' => 32
244 # Used to set the maximum load that we will still respond to gitweb queries.
245 # If server load exceed this value then return "503 server busy" error.
246 # If gitweb cannot determined server load, it is taken to be 0.
247 # Leave it undefined (or set to 'undef') to turn off load checking.
248 our $maxload = 300;
250 # configuration for 'highlight' (http://www.andre-simon.de/)
251 # match by basename
252 our %highlight_basename = (
253 #'Program' => 'py',
254 #'Library' => 'py',
255 'SConstruct' => 'py', # SCons equivalent of Makefile
256 'Makefile' => 'make',
258 # match by extension
259 our %highlight_ext = (
260 # main extensions, defining name of syntax;
261 # see files in /usr/share/highlight/langDefs/ directory
262 map { $_ => $_ }
263 qw(py c cpp rb java css php sh pl js tex bib xml awk bat ini spec tcl sql make),
264 # alternate extensions, see /etc/highlight/filetypes.conf
265 'h' => 'c',
266 map { $_ => 'sh' } qw(bash zsh ksh),
267 map { $_ => 'cpp' } qw(cxx c++ cc),
268 map { $_ => 'php' } qw(php3 php4 php5 phps),
269 map { $_ => 'pl' } qw(perl pm), # perhaps also 'cgi'
270 map { $_ => 'make'} qw(mak mk),
271 map { $_ => 'xml' } qw(xhtml html htm),
274 # You define site-wide feature defaults here; override them with
275 # $GITWEB_CONFIG as necessary.
276 our %feature = (
277 # feature => {
278 # 'sub' => feature-sub (subroutine),
279 # 'override' => allow-override (boolean),
280 # 'default' => [ default options...] (array reference)}
282 # if feature is overridable (it means that allow-override has true value),
283 # then feature-sub will be called with default options as parameters;
284 # return value of feature-sub indicates if to enable specified feature
286 # if there is no 'sub' key (no feature-sub), then feature cannot be
287 # overridden
289 # use gitweb_get_feature(<feature>) to retrieve the <feature> value
290 # (an array) or gitweb_check_feature(<feature>) to check if <feature>
291 # is enabled
293 # Enable the 'blame' blob view, showing the last commit that modified
294 # each line in the file. This can be very CPU-intensive.
296 # To enable system wide have in $GITWEB_CONFIG
297 # $feature{'blame'}{'default'} = [1];
298 # To have project specific config enable override in $GITWEB_CONFIG
299 # $feature{'blame'}{'override'} = 1;
300 # and in project config gitweb.blame = 0|1;
301 'blame' => {
302 'sub' => sub { feature_bool('blame', @_) },
303 'override' => 0,
304 'default' => [0]},
306 # Enable the 'snapshot' link, providing a compressed archive of any
307 # tree. This can potentially generate high traffic if you have large
308 # project.
310 # Value is a list of formats defined in %known_snapshot_formats that
311 # you wish to offer.
312 # To disable system wide have in $GITWEB_CONFIG
313 # $feature{'snapshot'}{'default'} = [];
314 # To have project specific config enable override in $GITWEB_CONFIG
315 # $feature{'snapshot'}{'override'} = 1;
316 # and in project config, a comma-separated list of formats or "none"
317 # to disable. Example: gitweb.snapshot = tbz2,zip;
318 'snapshot' => {
319 'sub' => \&feature_snapshot,
320 'override' => 0,
321 'default' => ['tgz']},
323 # Enable text search, which will list the commits which match author,
324 # committer or commit text to a given string. Enabled by default.
325 # Project specific override is not supported.
327 # Note that this controls all search features, which means that if
328 # it is disabled, then 'grep' and 'pickaxe' search would also be
329 # disabled.
330 'search' => {
331 'override' => 0,
332 'default' => [1]},
334 # Enable grep search, which will list the files in currently selected
335 # tree containing the given string. Enabled by default. This can be
336 # potentially CPU-intensive, of course.
337 # Note that you need to have 'search' feature enabled too.
339 # To enable system wide have in $GITWEB_CONFIG
340 # $feature{'grep'}{'default'} = [1];
341 # To have project specific config enable override in $GITWEB_CONFIG
342 # $feature{'grep'}{'override'} = 1;
343 # and in project config gitweb.grep = 0|1;
344 'grep' => {
345 'sub' => sub { feature_bool('grep', @_) },
346 'override' => 0,
347 'default' => [1]},
349 # Enable the pickaxe search, which will list the commits that modified
350 # a given string in a file. This can be practical and quite faster
351 # alternative to 'blame', but still potentially CPU-intensive.
352 # Note that you need to have 'search' feature enabled too.
354 # To enable system wide have in $GITWEB_CONFIG
355 # $feature{'pickaxe'}{'default'} = [1];
356 # To have project specific config enable override in $GITWEB_CONFIG
357 # $feature{'pickaxe'}{'override'} = 1;
358 # and in project config gitweb.pickaxe = 0|1;
359 'pickaxe' => {
360 'sub' => sub { feature_bool('pickaxe', @_) },
361 'override' => 0,
362 'default' => [1]},
364 # Enable showing size of blobs in a 'tree' view, in a separate
365 # column, similar to what 'ls -l' does. This cost a bit of IO.
367 # To disable system wide have in $GITWEB_CONFIG
368 # $feature{'show-sizes'}{'default'} = [0];
369 # To have project specific config enable override in $GITWEB_CONFIG
370 # $feature{'show-sizes'}{'override'} = 1;
371 # and in project config gitweb.showsizes = 0|1;
372 'show-sizes' => {
373 'sub' => sub { feature_bool('showsizes', @_) },
374 'override' => 0,
375 'default' => [1]},
377 # Make gitweb use an alternative format of the URLs which can be
378 # more readable and natural-looking: project name is embedded
379 # directly in the path and the query string contains other
380 # auxiliary information. All gitweb installations recognize
381 # URL in either format; this configures in which formats gitweb
382 # generates links.
384 # To enable system wide have in $GITWEB_CONFIG
385 # $feature{'pathinfo'}{'default'} = [1];
386 # Project specific override is not supported.
388 # Note that you will need to change the default location of CSS,
389 # favicon, logo and possibly other files to an absolute URL. Also,
390 # if gitweb.cgi serves as your indexfile, you will need to force
391 # $my_uri to contain the script name in your $GITWEB_CONFIG.
392 'pathinfo' => {
393 'override' => 0,
394 'default' => [0]},
396 # Make gitweb consider projects in project root subdirectories
397 # to be forks of existing projects. Given project $projname.git,
398 # projects matching $projname/*.git will not be shown in the main
399 # projects list, instead a '+' mark will be added to $projname
400 # there and a 'forks' view will be enabled for the project, listing
401 # all the forks. If project list is taken from a file, forks have
402 # to be listed after the main project.
404 # To enable system wide have in $GITWEB_CONFIG
405 # $feature{'forks'}{'default'} = [1];
406 # Project specific override is not supported.
407 'forks' => {
408 'override' => 0,
409 'default' => [0]},
411 # Insert custom links to the action bar of all project pages.
412 # This enables you mainly to link to third-party scripts integrating
413 # into gitweb; e.g. git-browser for graphical history representation
414 # or custom web-based repository administration interface.
416 # The 'default' value consists of a list of triplets in the form
417 # (label, link, position) where position is the label after which
418 # to insert the link and link is a format string where %n expands
419 # to the project name, %f to the project path within the filesystem,
420 # %h to the current hash (h gitweb parameter) and %b to the current
421 # hash base (hb gitweb parameter); %% expands to %.
423 # To enable system wide have in $GITWEB_CONFIG e.g.
424 # $feature{'actions'}{'default'} = [('graphiclog',
425 # '/git-browser/by-commit.html?r=%n', 'summary')];
426 # Project specific override is not supported.
427 'actions' => {
428 'override' => 0,
429 'default' => []},
431 # Allow gitweb scan project content tags of project repository,
432 # and display the popular Web 2.0-ish "tag cloud" near the projects
433 # list. Note that this is something COMPLETELY different from the
434 # normal Git tags.
436 # gitweb by itself can show existing tags, but it does not handle
437 # tagging itself; you need to do it externally, outside gitweb.
438 # The format is described in git_get_project_ctags() subroutine.
439 # You may want to install the HTML::TagCloud Perl module to get
440 # a pretty tag cloud instead of just a list of tags.
442 # To enable system wide have in $GITWEB_CONFIG
443 # $feature{'ctags'}{'default'} = [1];
444 # Project specific override is not supported.
446 # In the future whether ctags editing is enabled might depend
447 # on the value, but using 1 should always mean no editing of ctags.
448 'ctags' => {
449 'override' => 0,
450 'default' => [0]},
452 # The maximum number of patches in a patchset generated in patch
453 # view. Set this to 0 or undef to disable patch view, or to a
454 # negative number to remove any limit.
456 # To disable system wide have in $GITWEB_CONFIG
457 # $feature{'patches'}{'default'} = [0];
458 # To have project specific config enable override in $GITWEB_CONFIG
459 # $feature{'patches'}{'override'} = 1;
460 # and in project config gitweb.patches = 0|n;
461 # where n is the maximum number of patches allowed in a patchset.
462 'patches' => {
463 'sub' => \&feature_patches,
464 'override' => 0,
465 'default' => [16]},
467 # Avatar support. When this feature is enabled, views such as
468 # shortlog or commit will display an avatar associated with
469 # the email of the committer(s) and/or author(s).
471 # Currently available providers are gravatar and picon.
472 # If an unknown provider is specified, the feature is disabled.
474 # Gravatar depends on Digest::MD5.
475 # Picon currently relies on the indiana.edu database.
477 # To enable system wide have in $GITWEB_CONFIG
478 # $feature{'avatar'}{'default'} = ['<provider>'];
479 # where <provider> is either gravatar or picon.
480 # To have project specific config enable override in $GITWEB_CONFIG
481 # $feature{'avatar'}{'override'} = 1;
482 # and in project config gitweb.avatar = <provider>;
483 'avatar' => {
484 'sub' => \&feature_avatar,
485 'override' => 0,
486 'default' => ['']},
488 # Enable displaying how much time and how many git commands
489 # it took to generate and display page. Disabled by default.
490 # Project specific override is not supported.
491 'timed' => {
492 'override' => 0,
493 'default' => [0]},
495 # Enable turning some links into links to actions which require
496 # JavaScript to run (like 'blame_incremental'). Not enabled by
497 # default. Project specific override is currently not supported.
498 'javascript-actions' => {
499 'override' => 0,
500 'default' => [0]},
502 # Enable and configure ability to change common timezone for dates
503 # in gitweb output via JavaScript. Enabled by default.
504 # Project specific override is not supported.
505 'javascript-timezone' => {
506 'override' => 0,
507 'default' => [
508 'local', # default timezone: 'utc', 'local', or '(-|+)HHMM' format,
509 # or undef to turn off this feature
510 'gitweb_tz', # name of cookie where to store selected timezone
511 'datetime', # CSS class used to mark up dates for manipulation
514 # Syntax highlighting support. This is based on Daniel Svensson's
515 # and Sham Chukoury's work in gitweb-xmms2.git.
516 # It requires the 'highlight' program present in $PATH,
517 # and therefore is disabled by default.
519 # To enable system wide have in $GITWEB_CONFIG
520 # $feature{'highlight'}{'default'} = [1];
522 'highlight' => {
523 'sub' => sub { feature_bool('highlight', @_) },
524 'override' => 0,
525 'default' => [0]},
527 # Enable displaying of remote heads in the heads list
529 # To enable system wide have in $GITWEB_CONFIG
530 # $feature{'remote_heads'}{'default'} = [1];
531 # To have project specific config enable override in $GITWEB_CONFIG
532 # $feature{'remote_heads'}{'override'} = 1;
533 # and in project config gitweb.remote_heads = 0|1;
534 'remote_heads' => {
535 'sub' => sub { feature_bool('remote_heads', @_) },
536 'override' => 0,
537 'default' => [0]},
540 sub gitweb_get_feature {
541 my ($name) = @_;
542 return unless exists $feature{$name};
543 my ($sub, $override, @defaults) = (
544 $feature{$name}{'sub'},
545 $feature{$name}{'override'},
546 @{$feature{$name}{'default'}});
547 # project specific override is possible only if we have project
548 our $git_dir; # global variable, declared later
549 if (!$override || !defined $git_dir) {
550 return @defaults;
552 if (!defined $sub) {
553 warn "feature $name is not overridable";
554 return @defaults;
556 return $sub->(@defaults);
559 # A wrapper to check if a given feature is enabled.
560 # With this, you can say
562 # my $bool_feat = gitweb_check_feature('bool_feat');
563 # gitweb_check_feature('bool_feat') or somecode;
565 # instead of
567 # my ($bool_feat) = gitweb_get_feature('bool_feat');
568 # (gitweb_get_feature('bool_feat'))[0] or somecode;
570 sub gitweb_check_feature {
571 return (gitweb_get_feature(@_))[0];
575 sub feature_bool {
576 my $key = shift;
577 my ($val) = git_get_project_config($key, '--bool');
579 if (!defined $val) {
580 return ($_[0]);
581 } elsif ($val eq 'true') {
582 return (1);
583 } elsif ($val eq 'false') {
584 return (0);
588 sub feature_snapshot {
589 my (@fmts) = @_;
591 my ($val) = git_get_project_config('snapshot');
593 if ($val) {
594 @fmts = ($val eq 'none' ? () : split /\s*[,\s]\s*/, $val);
597 return @fmts;
600 sub feature_patches {
601 my @val = (git_get_project_config('patches', '--int'));
603 if (@val) {
604 return @val;
607 return ($_[0]);
610 sub feature_avatar {
611 my @val = (git_get_project_config('avatar'));
613 return @val ? @val : @_;
616 # checking HEAD file with -e is fragile if the repository was
617 # initialized long time ago (i.e. symlink HEAD) and was pack-ref'ed
618 # and then pruned.
619 sub check_head_link {
620 my ($dir) = @_;
621 my $headfile = "$dir/HEAD";
622 return ((-e $headfile) ||
623 (-l $headfile && readlink($headfile) =~ /^refs\/heads\//));
626 sub check_export_ok {
627 my ($dir) = @_;
628 return (check_head_link($dir) &&
629 (!$export_ok || -e "$dir/$export_ok") &&
630 (!$export_auth_hook || $export_auth_hook->($dir)));
633 # process alternate names for backward compatibility
634 # filter out unsupported (unknown) snapshot formats
635 sub filter_snapshot_fmts {
636 my @fmts = @_;
638 @fmts = map {
639 exists $known_snapshot_format_aliases{$_} ?
640 $known_snapshot_format_aliases{$_} : $_} @fmts;
641 @fmts = grep {
642 exists $known_snapshot_formats{$_} &&
643 !$known_snapshot_formats{$_}{'disabled'}} @fmts;
646 # If it is set to code reference, it is code that it is to be run once per
647 # request, allowing updating configurations that change with each request,
648 # while running other code in config file only once.
650 # Otherwise, if it is false then gitweb would process config file only once;
651 # if it is true then gitweb config would be run for each request.
652 our $per_request_config = 1;
654 # read and parse gitweb config file given by its parameter.
655 # returns true on success, false on recoverable error, allowing
656 # to chain this subroutine, using first file that exists.
657 # dies on errors during parsing config file, as it is unrecoverable.
658 sub read_config_file {
659 my $filename = shift;
660 return unless defined $filename;
661 # die if there are errors parsing config file
662 if (-e $filename) {
663 do $filename;
664 die $@ if $@;
665 return 1;
667 return;
670 our ($GITWEB_CONFIG, $GITWEB_CONFIG_SYSTEM, $GITWEB_CONFIG_COMMON);
671 sub evaluate_gitweb_config {
672 our $GITWEB_CONFIG = $ENV{'GITWEB_CONFIG'} || "++GITWEB_CONFIG++";
673 our $GITWEB_CONFIG_SYSTEM = $ENV{'GITWEB_CONFIG_SYSTEM'} || "++GITWEB_CONFIG_SYSTEM++";
674 our $GITWEB_CONFIG_COMMON = $ENV{'GITWEB_CONFIG_COMMON'} || "++GITWEB_CONFIG_COMMON++";
676 # Protect agains duplications of file names, to not read config twice.
677 # Only one of $GITWEB_CONFIG and $GITWEB_CONFIG_SYSTEM is used, so
678 # there possibility of duplication of filename there doesn't matter.
679 $GITWEB_CONFIG = "" if ($GITWEB_CONFIG eq $GITWEB_CONFIG_COMMON);
680 $GITWEB_CONFIG_SYSTEM = "" if ($GITWEB_CONFIG_SYSTEM eq $GITWEB_CONFIG_COMMON);
682 # Common system-wide settings for convenience.
683 # Those settings can be ovverriden by GITWEB_CONFIG or GITWEB_CONFIG_SYSTEM.
684 read_config_file($GITWEB_CONFIG_COMMON);
686 # Use first config file that exists. This means use the per-instance
687 # GITWEB_CONFIG if exists, otherwise use GITWEB_SYSTEM_CONFIG.
688 read_config_file($GITWEB_CONFIG) and return;
689 read_config_file($GITWEB_CONFIG_SYSTEM);
692 # Get loadavg of system, to compare against $maxload.
693 # Currently it requires '/proc/loadavg' present to get loadavg;
694 # if it is not present it returns 0, which means no load checking.
695 sub get_loadavg {
696 if( -e '/proc/loadavg' ){
697 open my $fd, '<', '/proc/loadavg'
698 or return 0;
699 my @load = split(/\s+/, scalar <$fd>);
700 close $fd;
702 # The first three columns measure CPU and IO utilization of the last one,
703 # five, and 10 minute periods. The fourth column shows the number of
704 # currently running processes and the total number of processes in the m/n
705 # format. The last column displays the last process ID used.
706 return $load[0] || 0;
708 # additional checks for load average should go here for things that don't export
709 # /proc/loadavg
711 return 0;
714 # version of the core git binary
715 our $git_version;
716 sub evaluate_git_version {
717 our $git_version = qx("$GIT" --version) =~ m/git version (.*)$/ ? $1 : "unknown";
718 $number_of_git_cmds++;
721 sub check_loadavg {
722 if (defined $maxload && get_loadavg() > $maxload) {
723 die_error(503, "The load average on the server is too high");
727 # ======================================================================
728 # input validation and dispatch
730 # input parameters can be collected from a variety of sources (presently, CGI
731 # and PATH_INFO), so we define an %input_params hash that collects them all
732 # together during validation: this allows subsequent uses (e.g. href()) to be
733 # agnostic of the parameter origin
735 our %input_params = ();
737 # input parameters are stored with the long parameter name as key. This will
738 # also be used in the href subroutine to convert parameters to their CGI
739 # equivalent, and since the href() usage is the most frequent one, we store
740 # the name -> CGI key mapping here, instead of the reverse.
742 # XXX: Warning: If you touch this, check the search form for updating,
743 # too.
745 our @cgi_param_mapping = (
746 project => "p",
747 action => "a",
748 file_name => "f",
749 file_parent => "fp",
750 hash => "h",
751 hash_parent => "hp",
752 hash_base => "hb",
753 hash_parent_base => "hpb",
754 page => "pg",
755 order => "o",
756 searchtext => "s",
757 searchtype => "st",
758 snapshot_format => "sf",
759 extra_options => "opt",
760 search_use_regexp => "sr",
761 ctag => "by_tag",
762 diff_style => "ds",
763 # this must be last entry (for manipulation from JavaScript)
764 javascript => "js"
766 our %cgi_param_mapping = @cgi_param_mapping;
768 # we will also need to know the possible actions, for validation
769 our %actions = (
770 "blame" => \&git_blame,
771 "blame_incremental" => \&git_blame_incremental,
772 "blame_data" => \&git_blame_data,
773 "blobdiff" => \&git_blobdiff,
774 "blobdiff_plain" => \&git_blobdiff_plain,
775 "blob" => \&git_blob,
776 "blob_plain" => \&git_blob_plain,
777 "commitdiff" => \&git_commitdiff,
778 "commitdiff_plain" => \&git_commitdiff_plain,
779 "commit" => \&git_commit,
780 "forks" => \&git_forks,
781 "heads" => \&git_heads,
782 "history" => \&git_history,
783 "log" => \&git_log,
784 "patch" => \&git_patch,
785 "patches" => \&git_patches,
786 "remotes" => \&git_remotes,
787 "rss" => \&git_rss,
788 "atom" => \&git_atom,
789 "search" => \&git_search,
790 "search_help" => \&git_search_help,
791 "shortlog" => \&git_shortlog,
792 "summary" => \&git_summary,
793 "tag" => \&git_tag,
794 "tags" => \&git_tags,
795 "tree" => \&git_tree,
796 "snapshot" => \&git_snapshot,
797 "object" => \&git_object,
798 # those below don't need $project
799 "opml" => \&git_opml,
800 "project_list" => \&git_project_list,
801 "project_index" => \&git_project_index,
804 # finally, we have the hash of allowed extra_options for the commands that
805 # allow them
806 our %allowed_options = (
807 "--no-merges" => [ qw(rss atom log shortlog history) ],
810 # fill %input_params with the CGI parameters. All values except for 'opt'
811 # should be single values, but opt can be an array. We should probably
812 # build an array of parameters that can be multi-valued, but since for the time
813 # being it's only this one, we just single it out
814 sub evaluate_query_params {
815 our $cgi;
817 while (my ($name, $symbol) = each %cgi_param_mapping) {
818 if ($symbol eq 'opt') {
819 $input_params{$name} = [ $cgi->param($symbol) ];
820 } else {
821 $input_params{$name} = $cgi->param($symbol);
826 # now read PATH_INFO and update the parameter list for missing parameters
827 sub evaluate_path_info {
828 return if defined $input_params{'project'};
829 return if !$path_info;
830 $path_info =~ s,^/+,,;
831 return if !$path_info;
833 # find which part of PATH_INFO is project
834 my $project = $path_info;
835 $project =~ s,/+$,,;
836 while ($project && !check_head_link("$projectroot/$project")) {
837 $project =~ s,/*[^/]*$,,;
839 return unless $project;
840 $input_params{'project'} = $project;
842 # do not change any parameters if an action is given using the query string
843 return if $input_params{'action'};
844 $path_info =~ s,^\Q$project\E/*,,;
846 # next, check if we have an action
847 my $action = $path_info;
848 $action =~ s,/.*$,,;
849 if (exists $actions{$action}) {
850 $path_info =~ s,^$action/*,,;
851 $input_params{'action'} = $action;
854 # list of actions that want hash_base instead of hash, but can have no
855 # pathname (f) parameter
856 my @wants_base = (
857 'tree',
858 'history',
861 # we want to catch, among others
862 # [$hash_parent_base[:$file_parent]..]$hash_parent[:$file_name]
863 my ($parentrefname, $parentpathname, $refname, $pathname) =
864 ($path_info =~ /^(?:(.+?)(?::(.+))?\.\.)?([^:]+?)?(?::(.+))?$/);
866 # first, analyze the 'current' part
867 if (defined $pathname) {
868 # we got "branch:filename" or "branch:dir/"
869 # we could use git_get_type(branch:pathname), but:
870 # - it needs $git_dir
871 # - it does a git() call
872 # - the convention of terminating directories with a slash
873 # makes it superfluous
874 # - embedding the action in the PATH_INFO would make it even
875 # more superfluous
876 $pathname =~ s,^/+,,;
877 if (!$pathname || substr($pathname, -1) eq "/") {
878 $input_params{'action'} ||= "tree";
879 $pathname =~ s,/$,,;
880 } else {
881 # the default action depends on whether we had parent info
882 # or not
883 if ($parentrefname) {
884 $input_params{'action'} ||= "blobdiff_plain";
885 } else {
886 $input_params{'action'} ||= "blob_plain";
889 $input_params{'hash_base'} ||= $refname;
890 $input_params{'file_name'} ||= $pathname;
891 } elsif (defined $refname) {
892 # we got "branch". In this case we have to choose if we have to
893 # set hash or hash_base.
895 # Most of the actions without a pathname only want hash to be
896 # set, except for the ones specified in @wants_base that want
897 # hash_base instead. It should also be noted that hand-crafted
898 # links having 'history' as an action and no pathname or hash
899 # set will fail, but that happens regardless of PATH_INFO.
900 if (defined $parentrefname) {
901 # if there is parent let the default be 'shortlog' action
902 # (for http://git.example.com/repo.git/A..B links); if there
903 # is no parent, dispatch will detect type of object and set
904 # action appropriately if required (if action is not set)
905 $input_params{'action'} ||= "shortlog";
907 if ($input_params{'action'} &&
908 grep { $_ eq $input_params{'action'} } @wants_base) {
909 $input_params{'hash_base'} ||= $refname;
910 } else {
911 $input_params{'hash'} ||= $refname;
915 # next, handle the 'parent' part, if present
916 if (defined $parentrefname) {
917 # a missing pathspec defaults to the 'current' filename, allowing e.g.
918 # someproject/blobdiff/oldrev..newrev:/filename
919 if ($parentpathname) {
920 $parentpathname =~ s,^/+,,;
921 $parentpathname =~ s,/$,,;
922 $input_params{'file_parent'} ||= $parentpathname;
923 } else {
924 $input_params{'file_parent'} ||= $input_params{'file_name'};
926 # we assume that hash_parent_base is wanted if a path was specified,
927 # or if the action wants hash_base instead of hash
928 if (defined $input_params{'file_parent'} ||
929 grep { $_ eq $input_params{'action'} } @wants_base) {
930 $input_params{'hash_parent_base'} ||= $parentrefname;
931 } else {
932 $input_params{'hash_parent'} ||= $parentrefname;
936 # for the snapshot action, we allow URLs in the form
937 # $project/snapshot/$hash.ext
938 # where .ext determines the snapshot and gets removed from the
939 # passed $refname to provide the $hash.
941 # To be able to tell that $refname includes the format extension, we
942 # require the following two conditions to be satisfied:
943 # - the hash input parameter MUST have been set from the $refname part
944 # of the URL (i.e. they must be equal)
945 # - the snapshot format MUST NOT have been defined already (e.g. from
946 # CGI parameter sf)
947 # It's also useless to try any matching unless $refname has a dot,
948 # so we check for that too
949 if (defined $input_params{'action'} &&
950 $input_params{'action'} eq 'snapshot' &&
951 defined $refname && index($refname, '.') != -1 &&
952 $refname eq $input_params{'hash'} &&
953 !defined $input_params{'snapshot_format'}) {
954 # We loop over the known snapshot formats, checking for
955 # extensions. Allowed extensions are both the defined suffix
956 # (which includes the initial dot already) and the snapshot
957 # format key itself, with a prepended dot
958 while (my ($fmt, $opt) = each %known_snapshot_formats) {
959 my $hash = $refname;
960 unless ($hash =~ s/(\Q$opt->{'suffix'}\E|\Q.$fmt\E)$//) {
961 next;
963 my $sfx = $1;
964 # a valid suffix was found, so set the snapshot format
965 # and reset the hash parameter
966 $input_params{'snapshot_format'} = $fmt;
967 $input_params{'hash'} = $hash;
968 # we also set the format suffix to the one requested
969 # in the URL: this way a request for e.g. .tgz returns
970 # a .tgz instead of a .tar.gz
971 $known_snapshot_formats{$fmt}{'suffix'} = $sfx;
972 last;
977 our ($action, $project, $file_name, $file_parent, $hash, $hash_parent, $hash_base,
978 $hash_parent_base, @extra_options, $page, $searchtype, $search_use_regexp,
979 $searchtext, $search_regexp);
980 sub evaluate_and_validate_params {
981 our $action = $input_params{'action'};
982 if (defined $action) {
983 if (!validate_action($action)) {
984 die_error(400, "Invalid action parameter");
988 # parameters which are pathnames
989 our $project = $input_params{'project'};
990 if (defined $project) {
991 if (!validate_project($project)) {
992 undef $project;
993 die_error(404, "No such project");
997 our $file_name = $input_params{'file_name'};
998 if (defined $file_name) {
999 if (!validate_pathname($file_name)) {
1000 die_error(400, "Invalid file parameter");
1004 our $file_parent = $input_params{'file_parent'};
1005 if (defined $file_parent) {
1006 if (!validate_pathname($file_parent)) {
1007 die_error(400, "Invalid file parent parameter");
1011 # parameters which are refnames
1012 our $hash = $input_params{'hash'};
1013 if (defined $hash) {
1014 if (!validate_refname($hash)) {
1015 die_error(400, "Invalid hash parameter");
1019 our $hash_parent = $input_params{'hash_parent'};
1020 if (defined $hash_parent) {
1021 if (!validate_refname($hash_parent)) {
1022 die_error(400, "Invalid hash parent parameter");
1026 our $hash_base = $input_params{'hash_base'};
1027 if (defined $hash_base) {
1028 if (!validate_refname($hash_base)) {
1029 die_error(400, "Invalid hash base parameter");
1033 our @extra_options = @{$input_params{'extra_options'}};
1034 # @extra_options is always defined, since it can only be (currently) set from
1035 # CGI, and $cgi->param() returns the empty array in array context if the param
1036 # is not set
1037 foreach my $opt (@extra_options) {
1038 if (not exists $allowed_options{$opt}) {
1039 die_error(400, "Invalid option parameter");
1041 if (not grep(/^$action$/, @{$allowed_options{$opt}})) {
1042 die_error(400, "Invalid option parameter for this action");
1046 our $hash_parent_base = $input_params{'hash_parent_base'};
1047 if (defined $hash_parent_base) {
1048 if (!validate_refname($hash_parent_base)) {
1049 die_error(400, "Invalid hash parent base parameter");
1053 # other parameters
1054 our $page = $input_params{'page'};
1055 if (defined $page) {
1056 if ($page =~ m/[^0-9]/) {
1057 die_error(400, "Invalid page parameter");
1061 our $searchtype = $input_params{'searchtype'};
1062 if (defined $searchtype) {
1063 if ($searchtype =~ m/[^a-z]/) {
1064 die_error(400, "Invalid searchtype parameter");
1068 our $search_use_regexp = $input_params{'search_use_regexp'};
1070 our $searchtext = $input_params{'searchtext'};
1071 our $search_regexp;
1072 if (defined $searchtext) {
1073 if (length($searchtext) < 2) {
1074 die_error(403, "At least two characters are required for search parameter");
1076 $search_regexp = $search_use_regexp ? $searchtext : quotemeta $searchtext;
1080 # path to the current git repository
1081 our $git_dir;
1082 sub evaluate_git_dir {
1083 our $git_dir = "$projectroot/$project" if $project;
1086 our (@snapshot_fmts, $git_avatar);
1087 sub configure_gitweb_features {
1088 # list of supported snapshot formats
1089 our @snapshot_fmts = gitweb_get_feature('snapshot');
1090 @snapshot_fmts = filter_snapshot_fmts(@snapshot_fmts);
1092 # check that the avatar feature is set to a known provider name,
1093 # and for each provider check if the dependencies are satisfied.
1094 # if the provider name is invalid or the dependencies are not met,
1095 # reset $git_avatar to the empty string.
1096 our ($git_avatar) = gitweb_get_feature('avatar');
1097 if ($git_avatar eq 'gravatar') {
1098 $git_avatar = '' unless (eval { require Digest::MD5; 1; });
1099 } elsif ($git_avatar eq 'picon') {
1100 # no dependencies
1101 } else {
1102 $git_avatar = '';
1106 # custom error handler: 'die <message>' is Internal Server Error
1107 sub handle_errors_html {
1108 my $msg = shift; # it is already HTML escaped
1110 # to avoid infinite loop where error occurs in die_error,
1111 # change handler to default handler, disabling handle_errors_html
1112 set_message("Error occured when inside die_error:\n$msg");
1114 # you cannot jump out of die_error when called as error handler;
1115 # the subroutine set via CGI::Carp::set_message is called _after_
1116 # HTTP headers are already written, so it cannot write them itself
1117 die_error(undef, undef, $msg, -error_handler => 1, -no_http_header => 1);
1119 set_message(\&handle_errors_html);
1121 # dispatch
1122 sub dispatch {
1123 if (!defined $action) {
1124 if (defined $hash) {
1125 $action = git_get_type($hash);
1126 } elsif (defined $hash_base && defined $file_name) {
1127 $action = git_get_type("$hash_base:$file_name");
1128 } elsif (defined $project) {
1129 $action = 'summary';
1130 } else {
1131 $action = 'project_list';
1134 if (!defined($actions{$action})) {
1135 die_error(400, "Unknown action");
1137 if ($action !~ m/^(?:opml|project_list|project_index)$/ &&
1138 !$project) {
1139 die_error(400, "Project needed");
1141 $actions{$action}->();
1144 sub reset_timer {
1145 our $t0 = [ gettimeofday() ]
1146 if defined $t0;
1147 our $number_of_git_cmds = 0;
1150 our $first_request = 1;
1151 sub run_request {
1152 reset_timer();
1154 evaluate_uri();
1155 if ($first_request) {
1156 evaluate_gitweb_config();
1157 evaluate_git_version();
1159 if ($per_request_config) {
1160 if (ref($per_request_config) eq 'CODE') {
1161 $per_request_config->();
1162 } elsif (!$first_request) {
1163 evaluate_gitweb_config();
1166 check_loadavg();
1168 # $projectroot and $projects_list might be set in gitweb config file
1169 $projects_list ||= $projectroot;
1171 evaluate_query_params();
1172 evaluate_path_info();
1173 evaluate_and_validate_params();
1174 evaluate_git_dir();
1176 configure_gitweb_features();
1178 dispatch();
1181 our $is_last_request = sub { 1 };
1182 our ($pre_dispatch_hook, $post_dispatch_hook, $pre_listen_hook);
1183 our $CGI = 'CGI';
1184 our $cgi;
1185 sub configure_as_fcgi {
1186 require CGI::Fast;
1187 our $CGI = 'CGI::Fast';
1189 my $request_number = 0;
1190 # let each child service 100 requests
1191 our $is_last_request = sub { ++$request_number > 100 };
1193 sub evaluate_argv {
1194 my $script_name = $ENV{'SCRIPT_NAME'} || $ENV{'SCRIPT_FILENAME'} || __FILE__;
1195 configure_as_fcgi()
1196 if $script_name =~ /\.fcgi$/;
1198 return unless (@ARGV);
1200 require Getopt::Long;
1201 Getopt::Long::GetOptions(
1202 'fastcgi|fcgi|f' => \&configure_as_fcgi,
1203 'nproc|n=i' => sub {
1204 my ($arg, $val) = @_;
1205 return unless eval { require FCGI::ProcManager; 1; };
1206 my $proc_manager = FCGI::ProcManager->new({
1207 n_processes => $val,
1209 our $pre_listen_hook = sub { $proc_manager->pm_manage() };
1210 our $pre_dispatch_hook = sub { $proc_manager->pm_pre_dispatch() };
1211 our $post_dispatch_hook = sub { $proc_manager->pm_post_dispatch() };
1216 sub run {
1217 evaluate_argv();
1219 $first_request = 1;
1220 $pre_listen_hook->()
1221 if $pre_listen_hook;
1223 REQUEST:
1224 while ($cgi = $CGI->new()) {
1225 $pre_dispatch_hook->()
1226 if $pre_dispatch_hook;
1228 run_request();
1230 $post_dispatch_hook->()
1231 if $post_dispatch_hook;
1232 $first_request = 0;
1234 last REQUEST if ($is_last_request->());
1237 DONE_GITWEB:
1241 run();
1243 if (defined caller) {
1244 # wrapped in a subroutine processing requests,
1245 # e.g. mod_perl with ModPerl::Registry, or PSGI with Plack::App::WrapCGI
1246 return;
1247 } else {
1248 # pure CGI script, serving single request
1249 exit;
1252 ## ======================================================================
1253 ## action links
1255 # possible values of extra options
1256 # -full => 0|1 - use absolute/full URL ($my_uri/$my_url as base)
1257 # -replay => 1 - start from a current view (replay with modifications)
1258 # -path_info => 0|1 - don't use/use path_info URL (if possible)
1259 # -anchor => ANCHOR - add #ANCHOR to end of URL, implies -replay if used alone
1260 sub href {
1261 my %params = @_;
1262 # default is to use -absolute url() i.e. $my_uri
1263 my $href = $params{-full} ? $my_url : $my_uri;
1265 # implicit -replay, must be first of implicit params
1266 $params{-replay} = 1 if (keys %params == 1 && $params{-anchor});
1268 $params{'project'} = $project unless exists $params{'project'};
1270 if ($params{-replay}) {
1271 while (my ($name, $symbol) = each %cgi_param_mapping) {
1272 if (!exists $params{$name}) {
1273 $params{$name} = $input_params{$name};
1278 my $use_pathinfo = gitweb_check_feature('pathinfo');
1279 if (defined $params{'project'} &&
1280 (exists $params{-path_info} ? $params{-path_info} : $use_pathinfo)) {
1281 # try to put as many parameters as possible in PATH_INFO:
1282 # - project name
1283 # - action
1284 # - hash_parent or hash_parent_base:/file_parent
1285 # - hash or hash_base:/filename
1286 # - the snapshot_format as an appropriate suffix
1288 # When the script is the root DirectoryIndex for the domain,
1289 # $href here would be something like http://gitweb.example.com/
1290 # Thus, we strip any trailing / from $href, to spare us double
1291 # slashes in the final URL
1292 $href =~ s,/$,,;
1294 # Then add the project name, if present
1295 $href .= "/".esc_path_info($params{'project'});
1296 delete $params{'project'};
1298 # since we destructively absorb parameters, we keep this
1299 # boolean that remembers if we're handling a snapshot
1300 my $is_snapshot = $params{'action'} eq 'snapshot';
1302 # Summary just uses the project path URL, any other action is
1303 # added to the URL
1304 if (defined $params{'action'}) {
1305 $href .= "/".esc_path_info($params{'action'})
1306 unless $params{'action'} eq 'summary';
1307 delete $params{'action'};
1310 # Next, we put hash_parent_base:/file_parent..hash_base:/file_name,
1311 # stripping nonexistent or useless pieces
1312 $href .= "/" if ($params{'hash_base'} || $params{'hash_parent_base'}
1313 || $params{'hash_parent'} || $params{'hash'});
1314 if (defined $params{'hash_base'}) {
1315 if (defined $params{'hash_parent_base'}) {
1316 $href .= esc_path_info($params{'hash_parent_base'});
1317 # skip the file_parent if it's the same as the file_name
1318 if (defined $params{'file_parent'}) {
1319 if (defined $params{'file_name'} && $params{'file_parent'} eq $params{'file_name'}) {
1320 delete $params{'file_parent'};
1321 } elsif ($params{'file_parent'} !~ /\.\./) {
1322 $href .= ":/".esc_path_info($params{'file_parent'});
1323 delete $params{'file_parent'};
1326 $href .= "..";
1327 delete $params{'hash_parent'};
1328 delete $params{'hash_parent_base'};
1329 } elsif (defined $params{'hash_parent'}) {
1330 $href .= esc_path_info($params{'hash_parent'}). "..";
1331 delete $params{'hash_parent'};
1334 $href .= esc_path_info($params{'hash_base'});
1335 if (defined $params{'file_name'} && $params{'file_name'} !~ /\.\./) {
1336 $href .= ":/".esc_path_info($params{'file_name'});
1337 delete $params{'file_name'};
1339 delete $params{'hash'};
1340 delete $params{'hash_base'};
1341 } elsif (defined $params{'hash'}) {
1342 $href .= esc_path_info($params{'hash'});
1343 delete $params{'hash'};
1346 # If the action was a snapshot, we can absorb the
1347 # snapshot_format parameter too
1348 if ($is_snapshot) {
1349 my $fmt = $params{'snapshot_format'};
1350 # snapshot_format should always be defined when href()
1351 # is called, but just in case some code forgets, we
1352 # fall back to the default
1353 $fmt ||= $snapshot_fmts[0];
1354 $href .= $known_snapshot_formats{$fmt}{'suffix'};
1355 delete $params{'snapshot_format'};
1359 # now encode the parameters explicitly
1360 my @result = ();
1361 for (my $i = 0; $i < @cgi_param_mapping; $i += 2) {
1362 my ($name, $symbol) = ($cgi_param_mapping[$i], $cgi_param_mapping[$i+1]);
1363 if (defined $params{$name}) {
1364 if (ref($params{$name}) eq "ARRAY") {
1365 foreach my $par (@{$params{$name}}) {
1366 push @result, $symbol . "=" . esc_param($par);
1368 } else {
1369 push @result, $symbol . "=" . esc_param($params{$name});
1373 $href .= "?" . join(';', @result) if scalar @result;
1375 # final transformation: trailing spaces must be escaped (URI-encoded)
1376 $href =~ s/(\s+)$/CGI::escape($1)/e;
1378 if ($params{-anchor}) {
1379 $href .= "#".esc_param($params{-anchor});
1382 return $href;
1386 ## ======================================================================
1387 ## validation, quoting/unquoting and escaping
1389 sub validate_action {
1390 my $input = shift || return undef;
1391 return undef unless exists $actions{$input};
1392 return $input;
1395 sub validate_project {
1396 my $input = shift || return undef;
1397 if (!validate_pathname($input) ||
1398 !(-d "$projectroot/$input") ||
1399 !check_export_ok("$projectroot/$input") ||
1400 ($strict_export && !project_in_list($input))) {
1401 return undef;
1402 } else {
1403 return $input;
1407 sub validate_pathname {
1408 my $input = shift || return undef;
1410 # no '.' or '..' as elements of path, i.e. no '.' nor '..'
1411 # at the beginning, at the end, and between slashes.
1412 # also this catches doubled slashes
1413 if ($input =~ m!(^|/)(|\.|\.\.)(/|$)!) {
1414 return undef;
1416 # no null characters
1417 if ($input =~ m!\0!) {
1418 return undef;
1420 return $input;
1423 sub validate_refname {
1424 my $input = shift || return undef;
1426 # textual hashes are O.K.
1427 if ($input =~ m/^[0-9a-fA-F]{40}$/) {
1428 return $input;
1430 # it must be correct pathname
1431 $input = validate_pathname($input)
1432 or return undef;
1433 # restrictions on ref name according to git-check-ref-format
1434 if ($input =~ m!(/\.|\.\.|[\000-\040\177 ~^:?*\[]|/$)!) {
1435 return undef;
1437 return $input;
1440 # decode sequences of octets in utf8 into Perl's internal form,
1441 # which is utf-8 with utf8 flag set if needed. gitweb writes out
1442 # in utf-8 thanks to "binmode STDOUT, ':utf8'" at beginning
1443 sub to_utf8 {
1444 my $str = shift;
1445 return undef unless defined $str;
1447 if (utf8::is_utf8($str) || utf8::decode($str)) {
1448 return $str;
1449 } else {
1450 return decode($fallback_encoding, $str, Encode::FB_DEFAULT);
1454 # quote unsafe chars, but keep the slash, even when it's not
1455 # correct, but quoted slashes look too horrible in bookmarks
1456 sub esc_param {
1457 my $str = shift;
1458 return undef unless defined $str;
1459 $str =~ s/([^A-Za-z0-9\-_.~()\/:@ ]+)/CGI::escape($1)/eg;
1460 $str =~ s/ /\+/g;
1461 return $str;
1464 # the quoting rules for path_info fragment are slightly different
1465 sub esc_path_info {
1466 my $str = shift;
1467 return undef unless defined $str;
1469 # path_info doesn't treat '+' as space (specially), but '?' must be escaped
1470 $str =~ s/([^A-Za-z0-9\-_.~();\/;:@&= +]+)/CGI::escape($1)/eg;
1472 return $str;
1475 # quote unsafe chars in whole URL, so some characters cannot be quoted
1476 sub esc_url {
1477 my $str = shift;
1478 return undef unless defined $str;
1479 $str =~ s/([^A-Za-z0-9\-_.~();\/;?:@&= ]+)/CGI::escape($1)/eg;
1480 $str =~ s/ /\+/g;
1481 return $str;
1484 # quote unsafe characters in HTML attributes
1485 sub esc_attr {
1487 # for XHTML conformance escaping '"' to '&quot;' is not enough
1488 return esc_html(@_);
1491 # replace invalid utf8 character with SUBSTITUTION sequence
1492 sub esc_html {
1493 my $str = shift;
1494 my %opts = @_;
1496 return undef unless defined $str;
1498 $str = to_utf8($str);
1499 $str = $cgi->escapeHTML($str);
1500 if ($opts{'-nbsp'}) {
1501 $str =~ s/ /&nbsp;/g;
1503 $str =~ s|([[:cntrl:]])|(($1 ne "\t") ? quot_cec($1) : $1)|eg;
1504 return $str;
1507 # quote control characters and escape filename to HTML
1508 sub esc_path {
1509 my $str = shift;
1510 my %opts = @_;
1512 return undef unless defined $str;
1514 $str = to_utf8($str);
1515 $str = $cgi->escapeHTML($str);
1516 if ($opts{'-nbsp'}) {
1517 $str =~ s/ /&nbsp;/g;
1519 $str =~ s|([[:cntrl:]])|quot_cec($1)|eg;
1520 return $str;
1523 # Sanitize for use in XHTML + application/xml+xhtm (valid XML 1.0)
1524 sub sanitize {
1525 my $str = shift;
1527 return undef unless defined $str;
1529 $str = to_utf8($str);
1530 $str =~ s|([[:cntrl:]])|($1 =~ /[\t\n\r]/ ? $1 : quot_cec($1))|eg;
1531 return $str;
1534 # Make control characters "printable", using character escape codes (CEC)
1535 sub quot_cec {
1536 my $cntrl = shift;
1537 my %opts = @_;
1538 my %es = ( # character escape codes, aka escape sequences
1539 "\t" => '\t', # tab (HT)
1540 "\n" => '\n', # line feed (LF)
1541 "\r" => '\r', # carrige return (CR)
1542 "\f" => '\f', # form feed (FF)
1543 "\b" => '\b', # backspace (BS)
1544 "\a" => '\a', # alarm (bell) (BEL)
1545 "\e" => '\e', # escape (ESC)
1546 "\013" => '\v', # vertical tab (VT)
1547 "\000" => '\0', # nul character (NUL)
1549 my $chr = ( (exists $es{$cntrl})
1550 ? $es{$cntrl}
1551 : sprintf('\%2x', ord($cntrl)) );
1552 if ($opts{-nohtml}) {
1553 return $chr;
1554 } else {
1555 return "<span class=\"cntrl\">$chr</span>";
1559 # Alternatively use unicode control pictures codepoints,
1560 # Unicode "printable representation" (PR)
1561 sub quot_upr {
1562 my $cntrl = shift;
1563 my %opts = @_;
1565 my $chr = sprintf('&#%04d;', 0x2400+ord($cntrl));
1566 if ($opts{-nohtml}) {
1567 return $chr;
1568 } else {
1569 return "<span class=\"cntrl\">$chr</span>";
1573 # git may return quoted and escaped filenames
1574 sub unquote {
1575 my $str = shift;
1577 sub unq {
1578 my $seq = shift;
1579 my %es = ( # character escape codes, aka escape sequences
1580 't' => "\t", # tab (HT, TAB)
1581 'n' => "\n", # newline (NL)
1582 'r' => "\r", # return (CR)
1583 'f' => "\f", # form feed (FF)
1584 'b' => "\b", # backspace (BS)
1585 'a' => "\a", # alarm (bell) (BEL)
1586 'e' => "\e", # escape (ESC)
1587 'v' => "\013", # vertical tab (VT)
1590 if ($seq =~ m/^[0-7]{1,3}$/) {
1591 # octal char sequence
1592 return chr(oct($seq));
1593 } elsif (exists $es{$seq}) {
1594 # C escape sequence, aka character escape code
1595 return $es{$seq};
1597 # quoted ordinary character
1598 return $seq;
1601 if ($str =~ m/^"(.*)"$/) {
1602 # needs unquoting
1603 $str = $1;
1604 $str =~ s/\\([^0-7]|[0-7]{1,3})/unq($1)/eg;
1606 return $str;
1609 # escape tabs (convert tabs to spaces)
1610 sub untabify {
1611 my $line = shift;
1613 while ((my $pos = index($line, "\t")) != -1) {
1614 if (my $count = (8 - ($pos % 8))) {
1615 my $spaces = ' ' x $count;
1616 $line =~ s/\t/$spaces/;
1620 return $line;
1623 sub project_in_list {
1624 my $project = shift;
1625 my @list = git_get_projects_list();
1626 return @list && scalar(grep { $_->{'path'} eq $project } @list);
1629 ## ----------------------------------------------------------------------
1630 ## HTML aware string manipulation
1632 # Try to chop given string on a word boundary between position
1633 # $len and $len+$add_len. If there is no word boundary there,
1634 # chop at $len+$add_len. Do not chop if chopped part plus ellipsis
1635 # (marking chopped part) would be longer than given string.
1636 sub chop_str {
1637 my $str = shift;
1638 my $len = shift;
1639 my $add_len = shift || 10;
1640 my $where = shift || 'right'; # 'left' | 'center' | 'right'
1642 # Make sure perl knows it is utf8 encoded so we don't
1643 # cut in the middle of a utf8 multibyte char.
1644 $str = to_utf8($str);
1646 # allow only $len chars, but don't cut a word if it would fit in $add_len
1647 # if it doesn't fit, cut it if it's still longer than the dots we would add
1648 # remove chopped character entities entirely
1650 # when chopping in the middle, distribute $len into left and right part
1651 # return early if chopping wouldn't make string shorter
1652 if ($where eq 'center') {
1653 return $str if ($len + 5 >= length($str)); # filler is length 5
1654 $len = int($len/2);
1655 } else {
1656 return $str if ($len + 4 >= length($str)); # filler is length 4
1659 # regexps: ending and beginning with word part up to $add_len
1660 my $endre = qr/.{$len}\w{0,$add_len}/;
1661 my $begre = qr/\w{0,$add_len}.{$len}/;
1663 if ($where eq 'left') {
1664 $str =~ m/^(.*?)($begre)$/;
1665 my ($lead, $body) = ($1, $2);
1666 if (length($lead) > 4) {
1667 $lead = " ...";
1669 return "$lead$body";
1671 } elsif ($where eq 'center') {
1672 $str =~ m/^($endre)(.*)$/;
1673 my ($left, $str) = ($1, $2);
1674 $str =~ m/^(.*?)($begre)$/;
1675 my ($mid, $right) = ($1, $2);
1676 if (length($mid) > 5) {
1677 $mid = " ... ";
1679 return "$left$mid$right";
1681 } else {
1682 $str =~ m/^($endre)(.*)$/;
1683 my $body = $1;
1684 my $tail = $2;
1685 if (length($tail) > 4) {
1686 $tail = "... ";
1688 return "$body$tail";
1692 # takes the same arguments as chop_str, but also wraps a <span> around the
1693 # result with a title attribute if it does get chopped. Additionally, the
1694 # string is HTML-escaped.
1695 sub chop_and_escape_str {
1696 my ($str) = @_;
1698 my $chopped = chop_str(@_);
1699 $str = to_utf8($str);
1700 if ($chopped eq $str) {
1701 return esc_html($chopped);
1702 } else {
1703 $str =~ s/[[:cntrl:]]/?/g;
1704 return $cgi->span({-title=>$str}, esc_html($chopped));
1708 ## ----------------------------------------------------------------------
1709 ## functions returning short strings
1711 # CSS class for given age value (in seconds)
1712 sub age_class {
1713 my $age = shift;
1715 if (!defined $age) {
1716 return "noage";
1717 } elsif ($age < 60*60*2) {
1718 return "age0";
1719 } elsif ($age < 60*60*24*2) {
1720 return "age1";
1721 } else {
1722 return "age2";
1726 # convert age in seconds to "nn units ago" string
1727 sub age_string {
1728 my $age = shift;
1729 my $age_str;
1731 if ($age > 60*60*24*365*2) {
1732 $age_str = (int $age/60/60/24/365);
1733 $age_str .= " years ago";
1734 } elsif ($age > 60*60*24*(365/12)*2) {
1735 $age_str = int $age/60/60/24/(365/12);
1736 $age_str .= " months ago";
1737 } elsif ($age > 60*60*24*7*2) {
1738 $age_str = int $age/60/60/24/7;
1739 $age_str .= " weeks ago";
1740 } elsif ($age > 60*60*24*2) {
1741 $age_str = int $age/60/60/24;
1742 $age_str .= " days ago";
1743 } elsif ($age > 60*60*2) {
1744 $age_str = int $age/60/60;
1745 $age_str .= " hours ago";
1746 } elsif ($age > 60*2) {
1747 $age_str = int $age/60;
1748 $age_str .= " min ago";
1749 } elsif ($age > 2) {
1750 $age_str = int $age;
1751 $age_str .= " sec ago";
1752 } else {
1753 $age_str .= " right now";
1755 return $age_str;
1758 use constant {
1759 S_IFINVALID => 0030000,
1760 S_IFGITLINK => 0160000,
1763 # submodule/subproject, a commit object reference
1764 sub S_ISGITLINK {
1765 my $mode = shift;
1767 return (($mode & S_IFMT) == S_IFGITLINK)
1770 # convert file mode in octal to symbolic file mode string
1771 sub mode_str {
1772 my $mode = oct shift;
1774 if (S_ISGITLINK($mode)) {
1775 return 'm---------';
1776 } elsif (S_ISDIR($mode & S_IFMT)) {
1777 return 'drwxr-xr-x';
1778 } elsif (S_ISLNK($mode)) {
1779 return 'lrwxrwxrwx';
1780 } elsif (S_ISREG($mode)) {
1781 # git cares only about the executable bit
1782 if ($mode & S_IXUSR) {
1783 return '-rwxr-xr-x';
1784 } else {
1785 return '-rw-r--r--';
1787 } else {
1788 return '----------';
1792 # convert file mode in octal to file type string
1793 sub file_type {
1794 my $mode = shift;
1796 if ($mode !~ m/^[0-7]+$/) {
1797 return $mode;
1798 } else {
1799 $mode = oct $mode;
1802 if (S_ISGITLINK($mode)) {
1803 return "submodule";
1804 } elsif (S_ISDIR($mode & S_IFMT)) {
1805 return "directory";
1806 } elsif (S_ISLNK($mode)) {
1807 return "symlink";
1808 } elsif (S_ISREG($mode)) {
1809 return "file";
1810 } else {
1811 return "unknown";
1815 # convert file mode in octal to file type description string
1816 sub file_type_long {
1817 my $mode = shift;
1819 if ($mode !~ m/^[0-7]+$/) {
1820 return $mode;
1821 } else {
1822 $mode = oct $mode;
1825 if (S_ISGITLINK($mode)) {
1826 return "submodule";
1827 } elsif (S_ISDIR($mode & S_IFMT)) {
1828 return "directory";
1829 } elsif (S_ISLNK($mode)) {
1830 return "symlink";
1831 } elsif (S_ISREG($mode)) {
1832 if ($mode & S_IXUSR) {
1833 return "executable";
1834 } else {
1835 return "file";
1837 } else {
1838 return "unknown";
1843 ## ----------------------------------------------------------------------
1844 ## functions returning short HTML fragments, or transforming HTML fragments
1845 ## which don't belong to other sections
1847 # format line of commit message.
1848 sub format_log_line_html {
1849 my $line = shift;
1851 $line = esc_html($line, -nbsp=>1);
1852 $line =~ s{\b([0-9a-fA-F]{8,40})\b}{
1853 $cgi->a({-href => href(action=>"object", hash=>$1),
1854 -class => "text"}, $1);
1855 }eg;
1857 return $line;
1860 # format marker of refs pointing to given object
1862 # the destination action is chosen based on object type and current context:
1863 # - for annotated tags, we choose the tag view unless it's the current view
1864 # already, in which case we go to shortlog view
1865 # - for other refs, we keep the current view if we're in history, shortlog or
1866 # log view, and select shortlog otherwise
1867 sub format_ref_marker {
1868 my ($refs, $id) = @_;
1869 my $markers = '';
1871 if (defined $refs->{$id}) {
1872 foreach my $ref (@{$refs->{$id}}) {
1873 # this code exploits the fact that non-lightweight tags are the
1874 # only indirect objects, and that they are the only objects for which
1875 # we want to use tag instead of shortlog as action
1876 my ($type, $name) = qw();
1877 my $indirect = ($ref =~ s/\^\{\}$//);
1878 # e.g. tags/v2.6.11 or heads/next
1879 if ($ref =~ m!^(.*?)s?/(.*)$!) {
1880 $type = $1;
1881 $name = $2;
1882 } else {
1883 $type = "ref";
1884 $name = $ref;
1887 my $class = $type;
1888 $class .= " indirect" if $indirect;
1890 my $dest_action = "shortlog";
1892 if ($indirect) {
1893 $dest_action = "tag" unless $action eq "tag";
1894 } elsif ($action =~ /^(history|(short)?log)$/) {
1895 $dest_action = $action;
1898 my $dest = "";
1899 $dest .= "refs/" unless $ref =~ m!^refs/!;
1900 $dest .= $ref;
1902 my $link = $cgi->a({
1903 -href => href(
1904 action=>$dest_action,
1905 hash=>$dest
1906 )}, $name);
1908 $markers .= " <span class=\"".esc_attr($class)."\" title=\"".esc_attr($ref)."\">" .
1909 $link . "</span>";
1913 if ($markers) {
1914 return ' <span class="refs">'. $markers . '</span>';
1915 } else {
1916 return "";
1920 # format, perhaps shortened and with markers, title line
1921 sub format_subject_html {
1922 my ($long, $short, $href, $extra) = @_;
1923 $extra = '' unless defined($extra);
1925 if (length($short) < length($long)) {
1926 $long =~ s/[[:cntrl:]]/?/g;
1927 return $cgi->a({-href => $href, -class => "list subject",
1928 -title => to_utf8($long)},
1929 esc_html($short)) . $extra;
1930 } else {
1931 return $cgi->a({-href => $href, -class => "list subject"},
1932 esc_html($long)) . $extra;
1936 # Rather than recomputing the url for an email multiple times, we cache it
1937 # after the first hit. This gives a visible benefit in views where the avatar
1938 # for the same email is used repeatedly (e.g. shortlog).
1939 # The cache is shared by all avatar engines (currently gravatar only), which
1940 # are free to use it as preferred. Since only one avatar engine is used for any
1941 # given page, there's no risk for cache conflicts.
1942 our %avatar_cache = ();
1944 # Compute the picon url for a given email, by using the picon search service over at
1945 # http://www.cs.indiana.edu/picons/search.html
1946 sub picon_url {
1947 my $email = lc shift;
1948 if (!$avatar_cache{$email}) {
1949 my ($user, $domain) = split('@', $email);
1950 $avatar_cache{$email} =
1951 "http://www.cs.indiana.edu/cgi-pub/kinzler/piconsearch.cgi/" .
1952 "$domain/$user/" .
1953 "users+domains+unknown/up/single";
1955 return $avatar_cache{$email};
1958 # Compute the gravatar url for a given email, if it's not in the cache already.
1959 # Gravatar stores only the part of the URL before the size, since that's the
1960 # one computationally more expensive. This also allows reuse of the cache for
1961 # different sizes (for this particular engine).
1962 sub gravatar_url {
1963 my $email = lc shift;
1964 my $size = shift;
1965 $avatar_cache{$email} ||=
1966 "http://www.gravatar.com/avatar/" .
1967 Digest::MD5::md5_hex($email) . "?s=";
1968 return $avatar_cache{$email} . $size;
1971 # Insert an avatar for the given $email at the given $size if the feature
1972 # is enabled.
1973 sub git_get_avatar {
1974 my ($email, %opts) = @_;
1975 my $pre_white = ($opts{-pad_before} ? "&nbsp;" : "");
1976 my $post_white = ($opts{-pad_after} ? "&nbsp;" : "");
1977 $opts{-size} ||= 'default';
1978 my $size = $avatar_size{$opts{-size}} || $avatar_size{'default'};
1979 my $url = "";
1980 if ($git_avatar eq 'gravatar') {
1981 $url = gravatar_url($email, $size);
1982 } elsif ($git_avatar eq 'picon') {
1983 $url = picon_url($email);
1985 # Other providers can be added by extending the if chain, defining $url
1986 # as needed. If no variant puts something in $url, we assume avatars
1987 # are completely disabled/unavailable.
1988 if ($url) {
1989 return $pre_white .
1990 "<img width=\"$size\" " .
1991 "class=\"avatar\" " .
1992 "src=\"".esc_url($url)."\" " .
1993 "alt=\"\" " .
1994 "/>" . $post_white;
1995 } else {
1996 return "";
2000 sub format_search_author {
2001 my ($author, $searchtype, $displaytext) = @_;
2002 my $have_search = gitweb_check_feature('search');
2004 if ($have_search) {
2005 my $performed = "";
2006 if ($searchtype eq 'author') {
2007 $performed = "authored";
2008 } elsif ($searchtype eq 'committer') {
2009 $performed = "committed";
2012 return $cgi->a({-href => href(action=>"search", hash=>$hash,
2013 searchtext=>$author,
2014 searchtype=>$searchtype), class=>"list",
2015 title=>"Search for commits $performed by $author"},
2016 $displaytext);
2018 } else {
2019 return $displaytext;
2023 # format the author name of the given commit with the given tag
2024 # the author name is chopped and escaped according to the other
2025 # optional parameters (see chop_str).
2026 sub format_author_html {
2027 my $tag = shift;
2028 my $co = shift;
2029 my $author = chop_and_escape_str($co->{'author_name'}, @_);
2030 return "<$tag class=\"author\">" .
2031 format_search_author($co->{'author_name'}, "author",
2032 git_get_avatar($co->{'author_email'}, -pad_after => 1) .
2033 $author) .
2034 "</$tag>";
2037 # format git diff header line, i.e. "diff --(git|combined|cc) ..."
2038 sub format_git_diff_header_line {
2039 my $line = shift;
2040 my $diffinfo = shift;
2041 my ($from, $to) = @_;
2043 if ($diffinfo->{'nparents'}) {
2044 # combined diff
2045 $line =~ s!^(diff (.*?) )"?.*$!$1!;
2046 if ($to->{'href'}) {
2047 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2048 esc_path($to->{'file'}));
2049 } else { # file was deleted (no href)
2050 $line .= esc_path($to->{'file'});
2052 } else {
2053 # "ordinary" diff
2054 $line =~ s!^(diff (.*?) )"?a/.*$!$1!;
2055 if ($from->{'href'}) {
2056 $line .= $cgi->a({-href => $from->{'href'}, -class => "path"},
2057 'a/' . esc_path($from->{'file'}));
2058 } else { # file was added (no href)
2059 $line .= 'a/' . esc_path($from->{'file'});
2061 $line .= ' ';
2062 if ($to->{'href'}) {
2063 $line .= $cgi->a({-href => $to->{'href'}, -class => "path"},
2064 'b/' . esc_path($to->{'file'}));
2065 } else { # file was deleted
2066 $line .= 'b/' . esc_path($to->{'file'});
2070 return "<div class=\"diff header\">$line</div>\n";
2073 # format extended diff header line, before patch itself
2074 sub format_extended_diff_header_line {
2075 my $line = shift;
2076 my $diffinfo = shift;
2077 my ($from, $to) = @_;
2079 # match <path>
2080 if ($line =~ s!^((copy|rename) from ).*$!$1! && $from->{'href'}) {
2081 $line .= $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2082 esc_path($from->{'file'}));
2084 if ($line =~ s!^((copy|rename) to ).*$!$1! && $to->{'href'}) {
2085 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2086 esc_path($to->{'file'}));
2088 # match single <mode>
2089 if ($line =~ m/\s(\d{6})$/) {
2090 $line .= '<span class="info"> (' .
2091 file_type_long($1) .
2092 ')</span>';
2094 # match <hash>
2095 if ($line =~ m/^index [0-9a-fA-F]{40},[0-9a-fA-F]{40}/) {
2096 # can match only for combined diff
2097 $line = 'index ';
2098 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2099 if ($from->{'href'}[$i]) {
2100 $line .= $cgi->a({-href=>$from->{'href'}[$i],
2101 -class=>"hash"},
2102 substr($diffinfo->{'from_id'}[$i],0,7));
2103 } else {
2104 $line .= '0' x 7;
2106 # separator
2107 $line .= ',' if ($i < $diffinfo->{'nparents'} - 1);
2109 $line .= '..';
2110 if ($to->{'href'}) {
2111 $line .= $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2112 substr($diffinfo->{'to_id'},0,7));
2113 } else {
2114 $line .= '0' x 7;
2117 } elsif ($line =~ m/^index [0-9a-fA-F]{40}..[0-9a-fA-F]{40}/) {
2118 # can match only for ordinary diff
2119 my ($from_link, $to_link);
2120 if ($from->{'href'}) {
2121 $from_link = $cgi->a({-href=>$from->{'href'}, -class=>"hash"},
2122 substr($diffinfo->{'from_id'},0,7));
2123 } else {
2124 $from_link = '0' x 7;
2126 if ($to->{'href'}) {
2127 $to_link = $cgi->a({-href=>$to->{'href'}, -class=>"hash"},
2128 substr($diffinfo->{'to_id'},0,7));
2129 } else {
2130 $to_link = '0' x 7;
2132 my ($from_id, $to_id) = ($diffinfo->{'from_id'}, $diffinfo->{'to_id'});
2133 $line =~ s!$from_id\.\.$to_id!$from_link..$to_link!;
2136 return $line . "<br/>\n";
2139 # format from-file/to-file diff header
2140 sub format_diff_from_to_header {
2141 my ($from_line, $to_line, $diffinfo, $from, $to, @parents) = @_;
2142 my $line;
2143 my $result = '';
2145 $line = $from_line;
2146 #assert($line =~ m/^---/) if DEBUG;
2147 # no extra formatting for "^--- /dev/null"
2148 if (! $diffinfo->{'nparents'}) {
2149 # ordinary (single parent) diff
2150 if ($line =~ m!^--- "?a/!) {
2151 if ($from->{'href'}) {
2152 $line = '--- a/' .
2153 $cgi->a({-href=>$from->{'href'}, -class=>"path"},
2154 esc_path($from->{'file'}));
2155 } else {
2156 $line = '--- a/' .
2157 esc_path($from->{'file'});
2160 $result .= qq!<div class="diff from_file">$line</div>\n!;
2162 } else {
2163 # combined diff (merge commit)
2164 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
2165 if ($from->{'href'}[$i]) {
2166 $line = '--- ' .
2167 $cgi->a({-href=>href(action=>"blobdiff",
2168 hash_parent=>$diffinfo->{'from_id'}[$i],
2169 hash_parent_base=>$parents[$i],
2170 file_parent=>$from->{'file'}[$i],
2171 hash=>$diffinfo->{'to_id'},
2172 hash_base=>$hash,
2173 file_name=>$to->{'file'}),
2174 -class=>"path",
2175 -title=>"diff" . ($i+1)},
2176 $i+1) .
2177 '/' .
2178 $cgi->a({-href=>$from->{'href'}[$i], -class=>"path"},
2179 esc_path($from->{'file'}[$i]));
2180 } else {
2181 $line = '--- /dev/null';
2183 $result .= qq!<div class="diff from_file">$line</div>\n!;
2187 $line = $to_line;
2188 #assert($line =~ m/^\+\+\+/) if DEBUG;
2189 # no extra formatting for "^+++ /dev/null"
2190 if ($line =~ m!^\+\+\+ "?b/!) {
2191 if ($to->{'href'}) {
2192 $line = '+++ b/' .
2193 $cgi->a({-href=>$to->{'href'}, -class=>"path"},
2194 esc_path($to->{'file'}));
2195 } else {
2196 $line = '+++ b/' .
2197 esc_path($to->{'file'});
2200 $result .= qq!<div class="diff to_file">$line</div>\n!;
2202 return $result;
2205 # create note for patch simplified by combined diff
2206 sub format_diff_cc_simplified {
2207 my ($diffinfo, @parents) = @_;
2208 my $result = '';
2210 $result .= "<div class=\"diff header\">" .
2211 "diff --cc ";
2212 if (!is_deleted($diffinfo)) {
2213 $result .= $cgi->a({-href => href(action=>"blob",
2214 hash_base=>$hash,
2215 hash=>$diffinfo->{'to_id'},
2216 file_name=>$diffinfo->{'to_file'}),
2217 -class => "path"},
2218 esc_path($diffinfo->{'to_file'}));
2219 } else {
2220 $result .= esc_path($diffinfo->{'to_file'});
2222 $result .= "</div>\n" . # class="diff header"
2223 "<div class=\"diff nodifferences\">" .
2224 "Simple merge" .
2225 "</div>\n"; # class="diff nodifferences"
2227 return $result;
2230 sub diff_line_class {
2231 my ($line, $from, $to) = @_;
2233 # ordinary diff
2234 my $num_sign = 1;
2235 # combined diff
2236 if ($from && $to && ref($from->{'href'}) eq "ARRAY") {
2237 $num_sign = scalar @{$from->{'href'}};
2240 my @diff_line_classifier = (
2241 { regexp => qr/^\@\@{$num_sign} /, class => "chunk_header"},
2242 { regexp => qr/^\\/, class => "incomplete" },
2243 { regexp => qr/^ {$num_sign}/, class => "ctx" },
2244 # classifier for context must come before classifier add/rem,
2245 # or we would have to use more complicated regexp, for example
2246 # qr/(?= {0,$m}\+)[+ ]{$num_sign}/, where $m = $num_sign - 1;
2247 { regexp => qr/^[+ ]{$num_sign}/, class => "add" },
2248 { regexp => qr/^[- ]{$num_sign}/, class => "rem" },
2250 for my $clsfy (@diff_line_classifier) {
2251 return $clsfy->{'class'}
2252 if ($line =~ $clsfy->{'regexp'});
2255 # fallback
2256 return "";
2259 # assumes that $from and $to are defined and correctly filled,
2260 # and that $line holds a line of chunk header for unified diff
2261 sub format_unidiff_chunk_header {
2262 my ($line, $from, $to) = @_;
2264 my ($from_text, $from_start, $from_lines, $to_text, $to_start, $to_lines, $section) =
2265 $line =~ m/^\@{2} (-(\d+)(?:,(\d+))?) (\+(\d+)(?:,(\d+))?) \@{2}(.*)$/;
2267 $from_lines = 0 unless defined $from_lines;
2268 $to_lines = 0 unless defined $to_lines;
2270 if ($from->{'href'}) {
2271 $from_text = $cgi->a({-href=>"$from->{'href'}#l$from_start",
2272 -class=>"list"}, $from_text);
2274 if ($to->{'href'}) {
2275 $to_text = $cgi->a({-href=>"$to->{'href'}#l$to_start",
2276 -class=>"list"}, $to_text);
2278 $line = "<span class=\"chunk_info\">@@ $from_text $to_text @@</span>" .
2279 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2280 return $line;
2283 # assumes that $from and $to are defined and correctly filled,
2284 # and that $line holds a line of chunk header for combined diff
2285 sub format_cc_diff_chunk_header {
2286 my ($line, $from, $to) = @_;
2288 my ($prefix, $ranges, $section) = $line =~ m/^(\@+) (.*?) \@+(.*)$/;
2289 my (@from_text, @from_start, @from_nlines, $to_text, $to_start, $to_nlines);
2291 @from_text = split(' ', $ranges);
2292 for (my $i = 0; $i < @from_text; ++$i) {
2293 ($from_start[$i], $from_nlines[$i]) =
2294 (split(',', substr($from_text[$i], 1)), 0);
2297 $to_text = pop @from_text;
2298 $to_start = pop @from_start;
2299 $to_nlines = pop @from_nlines;
2301 $line = "<span class=\"chunk_info\">$prefix ";
2302 for (my $i = 0; $i < @from_text; ++$i) {
2303 if ($from->{'href'}[$i]) {
2304 $line .= $cgi->a({-href=>"$from->{'href'}[$i]#l$from_start[$i]",
2305 -class=>"list"}, $from_text[$i]);
2306 } else {
2307 $line .= $from_text[$i];
2309 $line .= " ";
2311 if ($to->{'href'}) {
2312 $line .= $cgi->a({-href=>"$to->{'href'}#l$to_start",
2313 -class=>"list"}, $to_text);
2314 } else {
2315 $line .= $to_text;
2317 $line .= " $prefix</span>" .
2318 "<span class=\"section\">" . esc_html($section, -nbsp=>1) . "</span>";
2319 return $line;
2322 # process patch (diff) line (not to be used for diff headers),
2323 # returning class and HTML-formatted (but not wrapped) line
2324 sub process_diff_line {
2325 my $line = shift;
2326 my ($from, $to) = @_;
2328 my $diff_class = diff_line_class($line, $from, $to);
2330 chomp $line;
2331 $line = untabify($line);
2333 if ($from && $to && $line =~ m/^\@{2} /) {
2334 $line = format_unidiff_chunk_header($line, $from, $to);
2335 return $diff_class, $line;
2337 } elsif ($from && $to && $line =~ m/^\@{3}/) {
2338 $line = format_cc_diff_chunk_header($line, $from, $to);
2339 return $diff_class, $line;
2342 return $diff_class, esc_html($line, -nbsp=>1);
2345 # Generates undef or something like "_snapshot_" or "snapshot (_tbz2_ _zip_)",
2346 # linked. Pass the hash of the tree/commit to snapshot.
2347 sub format_snapshot_links {
2348 my ($hash) = @_;
2349 my $num_fmts = @snapshot_fmts;
2350 if ($num_fmts > 1) {
2351 # A parenthesized list of links bearing format names.
2352 # e.g. "snapshot (_tar.gz_ _zip_)"
2353 return "snapshot (" . join(' ', map
2354 $cgi->a({
2355 -href => href(
2356 action=>"snapshot",
2357 hash=>$hash,
2358 snapshot_format=>$_
2360 }, $known_snapshot_formats{$_}{'display'})
2361 , @snapshot_fmts) . ")";
2362 } elsif ($num_fmts == 1) {
2363 # A single "snapshot" link whose tooltip bears the format name.
2364 # i.e. "_snapshot_"
2365 my ($fmt) = @snapshot_fmts;
2366 return
2367 $cgi->a({
2368 -href => href(
2369 action=>"snapshot",
2370 hash=>$hash,
2371 snapshot_format=>$fmt
2373 -title => "in format: $known_snapshot_formats{$fmt}{'display'}"
2374 }, "snapshot");
2375 } else { # $num_fmts == 0
2376 return undef;
2380 ## ......................................................................
2381 ## functions returning values to be passed, perhaps after some
2382 ## transformation, to other functions; e.g. returning arguments to href()
2384 # returns hash to be passed to href to generate gitweb URL
2385 # in -title key it returns description of link
2386 sub get_feed_info {
2387 my $format = shift || 'Atom';
2388 my %res = (action => lc($format));
2390 # feed links are possible only for project views
2391 return unless (defined $project);
2392 # some views should link to OPML, or to generic project feed,
2393 # or don't have specific feed yet (so they should use generic)
2394 return if ($action =~ /^(?:tags|heads|forks|tag|search)$/x);
2396 my $branch;
2397 # branches refs uses 'refs/heads/' prefix (fullname) to differentiate
2398 # from tag links; this also makes possible to detect branch links
2399 if ((defined $hash_base && $hash_base =~ m!^refs/heads/(.*)$!) ||
2400 (defined $hash && $hash =~ m!^refs/heads/(.*)$!)) {
2401 $branch = $1;
2403 # find log type for feed description (title)
2404 my $type = 'log';
2405 if (defined $file_name) {
2406 $type = "history of $file_name";
2407 $type .= "/" if ($action eq 'tree');
2408 $type .= " on '$branch'" if (defined $branch);
2409 } else {
2410 $type = "log of $branch" if (defined $branch);
2413 $res{-title} = $type;
2414 $res{'hash'} = (defined $branch ? "refs/heads/$branch" : undef);
2415 $res{'file_name'} = $file_name;
2417 return %res;
2420 ## ----------------------------------------------------------------------
2421 ## git utility subroutines, invoking git commands
2423 # returns path to the core git executable and the --git-dir parameter as list
2424 sub git_cmd {
2425 $number_of_git_cmds++;
2426 return $GIT, '--git-dir='.$git_dir;
2429 # quote the given arguments for passing them to the shell
2430 # quote_command("command", "arg 1", "arg with ' and ! characters")
2431 # => "'command' 'arg 1' 'arg with '\'' and '\!' characters'"
2432 # Try to avoid using this function wherever possible.
2433 sub quote_command {
2434 return join(' ',
2435 map { my $a = $_; $a =~ s/(['!])/'\\$1'/g; "'$a'" } @_ );
2438 # get HEAD ref of given project as hash
2439 sub git_get_head_hash {
2440 return git_get_full_hash(shift, 'HEAD');
2443 sub git_get_full_hash {
2444 return git_get_hash(@_);
2447 sub git_get_short_hash {
2448 return git_get_hash(@_, '--short=7');
2451 sub git_get_hash {
2452 my ($project, $hash, @options) = @_;
2453 my $o_git_dir = $git_dir;
2454 my $retval = undef;
2455 $git_dir = "$projectroot/$project";
2456 if (open my $fd, '-|', git_cmd(), 'rev-parse',
2457 '--verify', '-q', @options, $hash) {
2458 $retval = <$fd>;
2459 chomp $retval if defined $retval;
2460 close $fd;
2462 if (defined $o_git_dir) {
2463 $git_dir = $o_git_dir;
2465 return $retval;
2468 # get type of given object
2469 sub git_get_type {
2470 my $hash = shift;
2472 open my $fd, "-|", git_cmd(), "cat-file", '-t', $hash or return;
2473 my $type = <$fd>;
2474 close $fd or return;
2475 chomp $type;
2476 return $type;
2479 # repository configuration
2480 our $config_file = '';
2481 our %config;
2483 # store multiple values for single key as anonymous array reference
2484 # single values stored directly in the hash, not as [ <value> ]
2485 sub hash_set_multi {
2486 my ($hash, $key, $value) = @_;
2488 if (!exists $hash->{$key}) {
2489 $hash->{$key} = $value;
2490 } elsif (!ref $hash->{$key}) {
2491 $hash->{$key} = [ $hash->{$key}, $value ];
2492 } else {
2493 push @{$hash->{$key}}, $value;
2497 # return hash of git project configuration
2498 # optionally limited to some section, e.g. 'gitweb'
2499 sub git_parse_project_config {
2500 my $section_regexp = shift;
2501 my %config;
2503 local $/ = "\0";
2505 open my $fh, "-|", git_cmd(), "config", '-z', '-l',
2506 or return;
2508 while (my $keyval = <$fh>) {
2509 chomp $keyval;
2510 my ($key, $value) = split(/\n/, $keyval, 2);
2512 hash_set_multi(\%config, $key, $value)
2513 if (!defined $section_regexp || $key =~ /^(?:$section_regexp)\./o);
2515 close $fh;
2517 return %config;
2520 # convert config value to boolean: 'true' or 'false'
2521 # no value, number > 0, 'true' and 'yes' values are true
2522 # rest of values are treated as false (never as error)
2523 sub config_to_bool {
2524 my $val = shift;
2526 return 1 if !defined $val; # section.key
2528 # strip leading and trailing whitespace
2529 $val =~ s/^\s+//;
2530 $val =~ s/\s+$//;
2532 return (($val =~ /^\d+$/ && $val) || # section.key = 1
2533 ($val =~ /^(?:true|yes)$/i)); # section.key = true
2536 # convert config value to simple decimal number
2537 # an optional value suffix of 'k', 'm', or 'g' will cause the value
2538 # to be multiplied by 1024, 1048576, or 1073741824
2539 sub config_to_int {
2540 my $val = shift;
2542 # strip leading and trailing whitespace
2543 $val =~ s/^\s+//;
2544 $val =~ s/\s+$//;
2546 if (my ($num, $unit) = ($val =~ /^([0-9]*)([kmg])$/i)) {
2547 $unit = lc($unit);
2548 # unknown unit is treated as 1
2549 return $num * ($unit eq 'g' ? 1073741824 :
2550 $unit eq 'm' ? 1048576 :
2551 $unit eq 'k' ? 1024 : 1);
2553 return $val;
2556 # convert config value to array reference, if needed
2557 sub config_to_multi {
2558 my $val = shift;
2560 return ref($val) ? $val : (defined($val) ? [ $val ] : []);
2563 sub git_get_project_config {
2564 my ($key, $type) = @_;
2566 return unless defined $git_dir;
2568 # key sanity check
2569 return unless ($key);
2570 # only subsection, if exists, is case sensitive,
2571 # and not lowercased by 'git config -z -l'
2572 if (my ($hi, $mi, $lo) = ($key =~ /^([^.]*)\.(.*)\.([^.]*)$/)) {
2573 $key = join(".", lc($hi), $mi, lc($lo));
2574 } else {
2575 $key = lc($key);
2577 $key =~ s/^gitweb\.//;
2578 return if ($key =~ m/\W/);
2580 # type sanity check
2581 if (defined $type) {
2582 $type =~ s/^--//;
2583 $type = undef
2584 unless ($type eq 'bool' || $type eq 'int');
2587 # get config
2588 if (!defined $config_file ||
2589 $config_file ne "$git_dir/config") {
2590 %config = git_parse_project_config('gitweb');
2591 $config_file = "$git_dir/config";
2594 # check if config variable (key) exists
2595 return unless exists $config{"gitweb.$key"};
2597 # ensure given type
2598 if (!defined $type) {
2599 return $config{"gitweb.$key"};
2600 } elsif ($type eq 'bool') {
2601 # backward compatibility: 'git config --bool' returns true/false
2602 return config_to_bool($config{"gitweb.$key"}) ? 'true' : 'false';
2603 } elsif ($type eq 'int') {
2604 return config_to_int($config{"gitweb.$key"});
2606 return $config{"gitweb.$key"};
2609 # get hash of given path at given ref
2610 sub git_get_hash_by_path {
2611 my $base = shift;
2612 my $path = shift || return undef;
2613 my $type = shift;
2615 $path =~ s,/+$,,;
2617 open my $fd, "-|", git_cmd(), "ls-tree", $base, "--", $path
2618 or die_error(500, "Open git-ls-tree failed");
2619 my $line = <$fd>;
2620 close $fd or return undef;
2622 if (!defined $line) {
2623 # there is no tree or hash given by $path at $base
2624 return undef;
2627 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
2628 $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t/;
2629 if (defined $type && $type ne $2) {
2630 # type doesn't match
2631 return undef;
2633 return $3;
2636 # get path of entry with given hash at given tree-ish (ref)
2637 # used to get 'from' filename for combined diff (merge commit) for renames
2638 sub git_get_path_by_hash {
2639 my $base = shift || return;
2640 my $hash = shift || return;
2642 local $/ = "\0";
2644 open my $fd, "-|", git_cmd(), "ls-tree", '-r', '-t', '-z', $base
2645 or return undef;
2646 while (my $line = <$fd>) {
2647 chomp $line;
2649 #'040000 tree 595596a6a9117ddba9fe379b6b012b558bac8423 gitweb'
2650 #'100644 blob e02e90f0429be0d2a69b76571101f20b8f75530f gitweb/README'
2651 if ($line =~ m/(?:[0-9]+) (?:.+) $hash\t(.+)$/) {
2652 close $fd;
2653 return $1;
2656 close $fd;
2657 return undef;
2660 ## ......................................................................
2661 ## git utility functions, directly accessing git repository
2663 # get the value of config variable either from file named as the variable
2664 # itself in the repository ($GIT_DIR/$name file), or from gitweb.$name
2665 # configuration variable in the repository config file.
2666 sub git_get_file_or_project_config {
2667 my ($path, $name) = @_;
2669 $git_dir = "$projectroot/$path";
2670 open my $fd, '<', "$git_dir/$name"
2671 or return git_get_project_config($name);
2672 my $conf = <$fd>;
2673 close $fd;
2674 if (defined $conf) {
2675 chomp $conf;
2677 return $conf;
2680 sub git_get_project_description {
2681 my $path = shift;
2682 return git_get_file_or_project_config($path, 'description');
2685 sub git_get_project_category {
2686 my $path = shift;
2687 return git_get_file_or_project_config($path, 'category');
2691 # supported formats:
2692 # * $GIT_DIR/ctags/<tagname> file (in 'ctags' subdirectory)
2693 # - if its contents is a number, use it as tag weight,
2694 # - otherwise add a tag with weight 1
2695 # * $GIT_DIR/ctags file, each line is a tag (with weight 1)
2696 # the same value multiple times increases tag weight
2697 # * `gitweb.ctag' multi-valued repo config variable
2698 sub git_get_project_ctags {
2699 my $project = shift;
2700 my $ctags = {};
2702 $git_dir = "$projectroot/$project";
2703 if (opendir my $dh, "$git_dir/ctags") {
2704 my @files = grep { -f $_ } map { "$git_dir/ctags/$_" } readdir($dh);
2705 foreach my $tagfile (@files) {
2706 open my $ct, '<', $tagfile
2707 or next;
2708 my $val = <$ct>;
2709 chomp $val if $val;
2710 close $ct;
2712 (my $ctag = $tagfile) =~ s#.*/##;
2713 if ($val =~ /^\d+$/) {
2714 $ctags->{$ctag} = $val;
2715 } else {
2716 $ctags->{$ctag} = 1;
2719 closedir $dh;
2721 } elsif (open my $fh, '<', "$git_dir/ctags") {
2722 while (my $line = <$fh>) {
2723 chomp $line;
2724 $ctags->{$line}++ if $line;
2726 close $fh;
2728 } else {
2729 my $taglist = config_to_multi(git_get_project_config('ctag'));
2730 foreach my $tag (@$taglist) {
2731 $ctags->{$tag}++;
2735 return $ctags;
2738 # return hash, where keys are content tags ('ctags'),
2739 # and values are sum of weights of given tag in every project
2740 sub git_gather_all_ctags {
2741 my $projects = shift;
2742 my $ctags = {};
2744 foreach my $p (@$projects) {
2745 foreach my $ct (keys %{$p->{'ctags'}}) {
2746 $ctags->{$ct} += $p->{'ctags'}->{$ct};
2750 return $ctags;
2753 sub git_populate_project_tagcloud {
2754 my $ctags = shift;
2756 # First, merge different-cased tags; tags vote on casing
2757 my %ctags_lc;
2758 foreach (keys %$ctags) {
2759 $ctags_lc{lc $_}->{count} += $ctags->{$_};
2760 if (not $ctags_lc{lc $_}->{topcount}
2761 or $ctags_lc{lc $_}->{topcount} < $ctags->{$_}) {
2762 $ctags_lc{lc $_}->{topcount} = $ctags->{$_};
2763 $ctags_lc{lc $_}->{topname} = $_;
2767 my $cloud;
2768 my $matched = $cgi->param('by_tag');
2769 if (eval { require HTML::TagCloud; 1; }) {
2770 $cloud = HTML::TagCloud->new;
2771 foreach my $ctag (sort keys %ctags_lc) {
2772 # Pad the title with spaces so that the cloud looks
2773 # less crammed.
2774 my $title = esc_html($ctags_lc{$ctag}->{topname});
2775 $title =~ s/ /&nbsp;/g;
2776 $title =~ s/^/&nbsp;/g;
2777 $title =~ s/$/&nbsp;/g;
2778 if (defined $matched && $matched eq $ctag) {
2779 $title = qq(<span class="match">$title</span>);
2781 $cloud->add($title, href(project=>undef, ctag=>$ctag),
2782 $ctags_lc{$ctag}->{count});
2784 } else {
2785 $cloud = {};
2786 foreach my $ctag (keys %ctags_lc) {
2787 my $title = esc_html($ctags_lc{$ctag}->{topname}, -nbsp=>1);
2788 if (defined $matched && $matched eq $ctag) {
2789 $title = qq(<span class="match">$title</span>);
2791 $cloud->{$ctag}{count} = $ctags_lc{$ctag}->{count};
2792 $cloud->{$ctag}{ctag} =
2793 $cgi->a({-href=>href(project=>undef, ctag=>$ctag)}, $title);
2796 return $cloud;
2799 sub git_show_project_tagcloud {
2800 my ($cloud, $count) = @_;
2801 if (ref $cloud eq 'HTML::TagCloud') {
2802 return $cloud->html_and_css($count);
2803 } else {
2804 my @tags = sort { $cloud->{$a}->{'count'} <=> $cloud->{$b}->{'count'} } keys %$cloud;
2805 return
2806 '<div id="htmltagcloud"'.($project ? '' : ' align="center"').'>' .
2807 join (', ', map {
2808 $cloud->{$_}->{'ctag'}
2809 } splice(@tags, 0, $count)) .
2810 '</div>';
2814 sub git_get_project_url_list {
2815 my $path = shift;
2817 $git_dir = "$projectroot/$path";
2818 open my $fd, '<', "$git_dir/cloneurl"
2819 or return wantarray ?
2820 @{ config_to_multi(git_get_project_config('url')) } :
2821 config_to_multi(git_get_project_config('url'));
2822 my @git_project_url_list = map { chomp; $_ } <$fd>;
2823 close $fd;
2825 return wantarray ? @git_project_url_list : \@git_project_url_list;
2828 sub git_get_projects_list {
2829 my $filter = shift || '';
2830 my @list;
2832 $filter =~ s/\.git$//;
2834 if (-d $projects_list) {
2835 # search in directory
2836 my $dir = $projects_list;
2837 # remove the trailing "/"
2838 $dir =~ s!/+$!!;
2839 my $pfxlen = length("$dir");
2840 my $pfxdepth = ($dir =~ tr!/!!);
2841 # when filtering, search only given subdirectory
2842 if ($filter) {
2843 $dir .= "/$filter";
2844 $dir =~ s!/+$!!;
2847 File::Find::find({
2848 follow_fast => 1, # follow symbolic links
2849 follow_skip => 2, # ignore duplicates
2850 dangling_symlinks => 0, # ignore dangling symlinks, silently
2851 wanted => sub {
2852 # global variables
2853 our $project_maxdepth;
2854 our $projectroot;
2855 # skip project-list toplevel, if we get it.
2856 return if (m!^[/.]$!);
2857 # only directories can be git repositories
2858 return unless (-d $_);
2859 # don't traverse too deep (Find is super slow on os x)
2860 # $project_maxdepth excludes depth of $projectroot
2861 if (($File::Find::name =~ tr!/!!) - $pfxdepth > $project_maxdepth) {
2862 $File::Find::prune = 1;
2863 return;
2866 my $path = substr($File::Find::name, $pfxlen + 1);
2867 # we check related file in $projectroot
2868 if (check_export_ok("$projectroot/$path")) {
2869 push @list, { path => $path };
2870 $File::Find::prune = 1;
2873 }, "$dir");
2875 } elsif (-f $projects_list) {
2876 # read from file(url-encoded):
2877 # 'git%2Fgit.git Linus+Torvalds'
2878 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
2879 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
2880 open my $fd, '<', $projects_list or return;
2881 PROJECT:
2882 while (my $line = <$fd>) {
2883 chomp $line;
2884 my ($path, $owner) = split ' ', $line;
2885 $path = unescape($path);
2886 $owner = unescape($owner);
2887 if (!defined $path) {
2888 next;
2890 # if $filter is rpovided, check if $path begins with $filter
2891 if ($filter && $path !~ m!^\Q$filter\E/!) {
2892 next;
2894 if (check_export_ok("$projectroot/$path")) {
2895 my $pr = {
2896 path => $path,
2897 owner => to_utf8($owner),
2899 push @list, $pr;
2902 close $fd;
2904 return @list;
2907 # written with help of Tree::Trie module (Perl Artistic License, GPL compatibile)
2908 # as side effects it sets 'forks' field to list of forks for forked projects
2909 sub filter_forks_from_projects_list {
2910 my $projects = shift;
2912 my %trie; # prefix tree of directories (path components)
2913 # generate trie out of those directories that might contain forks
2914 foreach my $pr (@$projects) {
2915 my $path = $pr->{'path'};
2916 $path =~ s/\.git$//; # forks of 'repo.git' are in 'repo/' directory
2917 next if ($path =~ m!/$!); # skip non-bare repositories, e.g. 'repo/.git'
2918 next unless ($path); # skip '.git' repository: tests, git-instaweb
2919 next unless (-d "$projectroot/$path"); # containing directory exists
2920 $pr->{'forks'} = []; # there can be 0 or more forks of project
2922 # add to trie
2923 my @dirs = split('/', $path);
2924 # walk the trie, until either runs out of components or out of trie
2925 my $ref = \%trie;
2926 while (scalar @dirs &&
2927 exists($ref->{$dirs[0]})) {
2928 $ref = $ref->{shift @dirs};
2930 # create rest of trie structure from rest of components
2931 foreach my $dir (@dirs) {
2932 $ref = $ref->{$dir} = {};
2934 # create end marker, store $pr as a data
2935 $ref->{''} = $pr if (!exists $ref->{''});
2938 # filter out forks, by finding shortest prefix match for paths
2939 my @filtered;
2940 PROJECT:
2941 foreach my $pr (@$projects) {
2942 # trie lookup
2943 my $ref = \%trie;
2944 DIR:
2945 foreach my $dir (split('/', $pr->{'path'})) {
2946 if (exists $ref->{''}) {
2947 # found [shortest] prefix, is a fork - skip it
2948 push @{$ref->{''}{'forks'}}, $pr;
2949 next PROJECT;
2951 if (!exists $ref->{$dir}) {
2952 # not in trie, cannot have prefix, not a fork
2953 push @filtered, $pr;
2954 next PROJECT;
2956 # If the dir is there, we just walk one step down the trie.
2957 $ref = $ref->{$dir};
2959 # we ran out of trie
2960 # (shouldn't happen: it's either no match, or end marker)
2961 push @filtered, $pr;
2964 return @filtered;
2967 # note: fill_project_list_info must be run first,
2968 # for 'descr_long' and 'ctags' to be filled
2969 sub search_projects_list {
2970 my ($projlist, %opts) = @_;
2971 my $tagfilter = $opts{'tagfilter'};
2972 my $searchtext = $opts{'searchtext'};
2974 return @$projlist
2975 unless ($tagfilter || $searchtext);
2977 my @projects;
2978 PROJECT:
2979 foreach my $pr (@$projlist) {
2981 if ($tagfilter) {
2982 next unless ref($pr->{'ctags'}) eq 'HASH';
2983 next unless
2984 grep { lc($_) eq lc($tagfilter) } keys %{$pr->{'ctags'}};
2987 if ($searchtext) {
2988 next unless
2989 $pr->{'path'} =~ /$searchtext/ ||
2990 $pr->{'descr_long'} =~ /$searchtext/;
2993 push @projects, $pr;
2996 return @projects;
2999 our $gitweb_project_owner = undef;
3000 sub git_get_project_list_from_file {
3002 return if (defined $gitweb_project_owner);
3004 $gitweb_project_owner = {};
3005 # read from file (url-encoded):
3006 # 'git%2Fgit.git Linus+Torvalds'
3007 # 'libs%2Fklibc%2Fklibc.git H.+Peter+Anvin'
3008 # 'linux%2Fhotplug%2Fudev.git Greg+Kroah-Hartman'
3009 if (-f $projects_list) {
3010 open(my $fd, '<', $projects_list);
3011 while (my $line = <$fd>) {
3012 chomp $line;
3013 my ($pr, $ow) = split ' ', $line;
3014 $pr = unescape($pr);
3015 $ow = unescape($ow);
3016 $gitweb_project_owner->{$pr} = to_utf8($ow);
3018 close $fd;
3022 sub git_get_project_owner {
3023 my $project = shift;
3024 my $owner;
3026 return undef unless $project;
3027 $git_dir = "$projectroot/$project";
3029 if (!defined $gitweb_project_owner) {
3030 git_get_project_list_from_file();
3033 if (exists $gitweb_project_owner->{$project}) {
3034 $owner = $gitweb_project_owner->{$project};
3036 if (!defined $owner){
3037 $owner = git_get_project_config('owner');
3039 if (!defined $owner) {
3040 $owner = get_file_owner("$git_dir");
3043 return $owner;
3046 sub git_get_last_activity {
3047 my ($path) = @_;
3048 my $fd;
3050 $git_dir = "$projectroot/$path";
3051 open($fd, "-|", git_cmd(), 'for-each-ref',
3052 '--format=%(committer)',
3053 '--sort=-committerdate',
3054 '--count=1',
3055 'refs/heads') or return;
3056 my $most_recent = <$fd>;
3057 close $fd or return;
3058 if (defined $most_recent &&
3059 $most_recent =~ / (\d+) [-+][01]\d\d\d$/) {
3060 my $timestamp = $1;
3061 my $age = time - $timestamp;
3062 return ($age, age_string($age));
3064 return (undef, undef);
3067 # Implementation note: when a single remote is wanted, we cannot use 'git
3068 # remote show -n' because that command always work (assuming it's a remote URL
3069 # if it's not defined), and we cannot use 'git remote show' because that would
3070 # try to make a network roundtrip. So the only way to find if that particular
3071 # remote is defined is to walk the list provided by 'git remote -v' and stop if
3072 # and when we find what we want.
3073 sub git_get_remotes_list {
3074 my $wanted = shift;
3075 my %remotes = ();
3077 open my $fd, '-|' , git_cmd(), 'remote', '-v';
3078 return unless $fd;
3079 while (my $remote = <$fd>) {
3080 chomp $remote;
3081 $remote =~ s!\t(.*?)\s+\((\w+)\)$!!;
3082 next if $wanted and not $remote eq $wanted;
3083 my ($url, $key) = ($1, $2);
3085 $remotes{$remote} ||= { 'heads' => () };
3086 $remotes{$remote}{$key} = $url;
3088 close $fd or return;
3089 return wantarray ? %remotes : \%remotes;
3092 # Takes a hash of remotes as first parameter and fills it by adding the
3093 # available remote heads for each of the indicated remotes.
3094 sub fill_remote_heads {
3095 my $remotes = shift;
3096 my @heads = map { "remotes/$_" } keys %$remotes;
3097 my @remoteheads = git_get_heads_list(undef, @heads);
3098 foreach my $remote (keys %$remotes) {
3099 $remotes->{$remote}{'heads'} = [ grep {
3100 $_->{'name'} =~ s!^$remote/!!
3101 } @remoteheads ];
3105 sub git_get_references {
3106 my $type = shift || "";
3107 my %refs;
3108 # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
3109 # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
3110 open my $fd, "-|", git_cmd(), "show-ref", "--dereference",
3111 ($type ? ("--", "refs/$type") : ()) # use -- <pattern> if $type
3112 or return;
3114 while (my $line = <$fd>) {
3115 chomp $line;
3116 if ($line =~ m!^([0-9a-fA-F]{40})\srefs/($type.*)$!) {
3117 if (defined $refs{$1}) {
3118 push @{$refs{$1}}, $2;
3119 } else {
3120 $refs{$1} = [ $2 ];
3124 close $fd or return;
3125 return \%refs;
3128 sub git_get_rev_name_tags {
3129 my $hash = shift || return undef;
3131 open my $fd, "-|", git_cmd(), "name-rev", "--tags", $hash
3132 or return;
3133 my $name_rev = <$fd>;
3134 close $fd;
3136 if ($name_rev =~ m|^$hash tags/(.*)$|) {
3137 return $1;
3138 } else {
3139 # catches also '$hash undefined' output
3140 return undef;
3144 ## ----------------------------------------------------------------------
3145 ## parse to hash functions
3147 sub parse_date {
3148 my $epoch = shift;
3149 my $tz = shift || "-0000";
3151 my %date;
3152 my @months = ("Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec");
3153 my @days = ("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat");
3154 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($epoch);
3155 $date{'hour'} = $hour;
3156 $date{'minute'} = $min;
3157 $date{'mday'} = $mday;
3158 $date{'day'} = $days[$wday];
3159 $date{'month'} = $months[$mon];
3160 $date{'rfc2822'} = sprintf "%s, %d %s %4d %02d:%02d:%02d +0000",
3161 $days[$wday], $mday, $months[$mon], 1900+$year, $hour ,$min, $sec;
3162 $date{'mday-time'} = sprintf "%d %s %02d:%02d",
3163 $mday, $months[$mon], $hour ,$min;
3164 $date{'iso-8601'} = sprintf "%04d-%02d-%02dT%02d:%02d:%02dZ",
3165 1900+$year, 1+$mon, $mday, $hour ,$min, $sec;
3167 my ($tz_sign, $tz_hour, $tz_min) =
3168 ($tz =~ m/^([-+])(\d\d)(\d\d)$/);
3169 $tz_sign = ($tz_sign eq '-' ? -1 : +1);
3170 my $local = $epoch + $tz_sign*((($tz_hour*60) + $tz_min)*60);
3171 ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($local);
3172 $date{'hour_local'} = $hour;
3173 $date{'minute_local'} = $min;
3174 $date{'tz_local'} = $tz;
3175 $date{'iso-tz'} = sprintf("%04d-%02d-%02d %02d:%02d:%02d %s",
3176 1900+$year, $mon+1, $mday,
3177 $hour, $min, $sec, $tz);
3178 return %date;
3181 sub parse_tag {
3182 my $tag_id = shift;
3183 my %tag;
3184 my @comment;
3186 open my $fd, "-|", git_cmd(), "cat-file", "tag", $tag_id or return;
3187 $tag{'id'} = $tag_id;
3188 while (my $line = <$fd>) {
3189 chomp $line;
3190 if ($line =~ m/^object ([0-9a-fA-F]{40})$/) {
3191 $tag{'object'} = $1;
3192 } elsif ($line =~ m/^type (.+)$/) {
3193 $tag{'type'} = $1;
3194 } elsif ($line =~ m/^tag (.+)$/) {
3195 $tag{'name'} = $1;
3196 } elsif ($line =~ m/^tagger (.*) ([0-9]+) (.*)$/) {
3197 $tag{'author'} = $1;
3198 $tag{'author_epoch'} = $2;
3199 $tag{'author_tz'} = $3;
3200 if ($tag{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3201 $tag{'author_name'} = $1;
3202 $tag{'author_email'} = $2;
3203 } else {
3204 $tag{'author_name'} = $tag{'author'};
3206 } elsif ($line =~ m/--BEGIN/) {
3207 push @comment, $line;
3208 last;
3209 } elsif ($line eq "") {
3210 last;
3213 push @comment, <$fd>;
3214 $tag{'comment'} = \@comment;
3215 close $fd or return;
3216 if (!defined $tag{'name'}) {
3217 return
3219 return %tag
3222 sub parse_commit_text {
3223 my ($commit_text, $withparents) = @_;
3224 my @commit_lines = split '\n', $commit_text;
3225 my %co;
3227 pop @commit_lines; # Remove '\0'
3229 if (! @commit_lines) {
3230 return;
3233 my $header = shift @commit_lines;
3234 if ($header !~ m/^[0-9a-fA-F]{40}/) {
3235 return;
3237 ($co{'id'}, my @parents) = split ' ', $header;
3238 while (my $line = shift @commit_lines) {
3239 last if $line eq "\n";
3240 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
3241 $co{'tree'} = $1;
3242 } elsif ((!defined $withparents) && ($line =~ m/^parent ([0-9a-fA-F]{40})$/)) {
3243 push @parents, $1;
3244 } elsif ($line =~ m/^author (.*) ([0-9]+) (.*)$/) {
3245 $co{'author'} = to_utf8($1);
3246 $co{'author_epoch'} = $2;
3247 $co{'author_tz'} = $3;
3248 if ($co{'author'} =~ m/^([^<]+) <([^>]*)>/) {
3249 $co{'author_name'} = $1;
3250 $co{'author_email'} = $2;
3251 } else {
3252 $co{'author_name'} = $co{'author'};
3254 } elsif ($line =~ m/^committer (.*) ([0-9]+) (.*)$/) {
3255 $co{'committer'} = to_utf8($1);
3256 $co{'committer_epoch'} = $2;
3257 $co{'committer_tz'} = $3;
3258 if ($co{'committer'} =~ m/^([^<]+) <([^>]*)>/) {
3259 $co{'committer_name'} = $1;
3260 $co{'committer_email'} = $2;
3261 } else {
3262 $co{'committer_name'} = $co{'committer'};
3266 if (!defined $co{'tree'}) {
3267 return;
3269 $co{'parents'} = \@parents;
3270 $co{'parent'} = $parents[0];
3272 foreach my $title (@commit_lines) {
3273 $title =~ s/^ //;
3274 if ($title ne "") {
3275 $co{'title'} = chop_str($title, 80, 5);
3276 # remove leading stuff of merges to make the interesting part visible
3277 if (length($title) > 50) {
3278 $title =~ s/^Automatic //;
3279 $title =~ s/^merge (of|with) /Merge ... /i;
3280 if (length($title) > 50) {
3281 $title =~ s/(http|rsync):\/\///;
3283 if (length($title) > 50) {
3284 $title =~ s/(master|www|rsync)\.//;
3286 if (length($title) > 50) {
3287 $title =~ s/kernel.org:?//;
3289 if (length($title) > 50) {
3290 $title =~ s/\/pub\/scm//;
3293 $co{'title_short'} = chop_str($title, 50, 5);
3294 last;
3297 if (! defined $co{'title'} || $co{'title'} eq "") {
3298 $co{'title'} = $co{'title_short'} = '(no commit message)';
3300 # remove added spaces
3301 foreach my $line (@commit_lines) {
3302 $line =~ s/^ //;
3304 $co{'comment'} = \@commit_lines;
3306 my $age = time - $co{'committer_epoch'};
3307 $co{'age'} = $age;
3308 $co{'age_string'} = age_string($age);
3309 my ($sec, $min, $hour, $mday, $mon, $year, $wday, $yday) = gmtime($co{'committer_epoch'});
3310 if ($age > 60*60*24*7*2) {
3311 $co{'age_string_date'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3312 $co{'age_string_age'} = $co{'age_string'};
3313 } else {
3314 $co{'age_string_date'} = $co{'age_string'};
3315 $co{'age_string_age'} = sprintf "%4i-%02u-%02i", 1900 + $year, $mon+1, $mday;
3317 return %co;
3320 sub parse_commit {
3321 my ($commit_id) = @_;
3322 my %co;
3324 local $/ = "\0";
3326 open my $fd, "-|", git_cmd(), "rev-list",
3327 "--parents",
3328 "--header",
3329 "--max-count=1",
3330 $commit_id,
3331 "--",
3332 or die_error(500, "Open git-rev-list failed");
3333 %co = parse_commit_text(<$fd>, 1);
3334 close $fd;
3336 return %co;
3339 sub parse_commits {
3340 my ($commit_id, $maxcount, $skip, $filename, @args) = @_;
3341 my @cos;
3343 $maxcount ||= 1;
3344 $skip ||= 0;
3346 local $/ = "\0";
3348 open my $fd, "-|", git_cmd(), "rev-list",
3349 "--header",
3350 @args,
3351 ("--max-count=" . $maxcount),
3352 ("--skip=" . $skip),
3353 @extra_options,
3354 $commit_id,
3355 "--",
3356 ($filename ? ($filename) : ())
3357 or die_error(500, "Open git-rev-list failed");
3358 while (my $line = <$fd>) {
3359 my %co = parse_commit_text($line);
3360 push @cos, \%co;
3362 close $fd;
3364 return wantarray ? @cos : \@cos;
3367 # parse line of git-diff-tree "raw" output
3368 sub parse_difftree_raw_line {
3369 my $line = shift;
3370 my %res;
3372 # ':100644 100644 03b218260e99b78c6df0ed378e59ed9205ccc96d 3b93d5e7cc7f7dd4ebed13a5cc1a4ad976fc94d8 M ls-files.c'
3373 # ':100644 100644 7f9281985086971d3877aca27704f2aaf9c448ce bc190ebc71bbd923f2b728e505408f5e54bd073a M rev-tree.c'
3374 if ($line =~ m/^:([0-7]{6}) ([0-7]{6}) ([0-9a-fA-F]{40}) ([0-9a-fA-F]{40}) (.)([0-9]{0,3})\t(.*)$/) {
3375 $res{'from_mode'} = $1;
3376 $res{'to_mode'} = $2;
3377 $res{'from_id'} = $3;
3378 $res{'to_id'} = $4;
3379 $res{'status'} = $5;
3380 $res{'similarity'} = $6;
3381 if ($res{'status'} eq 'R' || $res{'status'} eq 'C') { # renamed or copied
3382 ($res{'from_file'}, $res{'to_file'}) = map { unquote($_) } split("\t", $7);
3383 } else {
3384 $res{'from_file'} = $res{'to_file'} = $res{'file'} = unquote($7);
3387 # '::100755 100755 100755 60e79ca1b01bc8b057abe17ddab484699a7f5fdb 94067cc5f73388f33722d52ae02f44692bc07490 94067cc5f73388f33722d52ae02f44692bc07490 MR git-gui/git-gui.sh'
3388 # combined diff (for merge commit)
3389 elsif ($line =~ s/^(::+)((?:[0-7]{6} )+)((?:[0-9a-fA-F]{40} )+)([a-zA-Z]+)\t(.*)$//) {
3390 $res{'nparents'} = length($1);
3391 $res{'from_mode'} = [ split(' ', $2) ];
3392 $res{'to_mode'} = pop @{$res{'from_mode'}};
3393 $res{'from_id'} = [ split(' ', $3) ];
3394 $res{'to_id'} = pop @{$res{'from_id'}};
3395 $res{'status'} = [ split('', $4) ];
3396 $res{'to_file'} = unquote($5);
3398 # 'c512b523472485aef4fff9e57b229d9d243c967f'
3399 elsif ($line =~ m/^([0-9a-fA-F]{40})$/) {
3400 $res{'commit'} = $1;
3403 return wantarray ? %res : \%res;
3406 # wrapper: return parsed line of git-diff-tree "raw" output
3407 # (the argument might be raw line, or parsed info)
3408 sub parsed_difftree_line {
3409 my $line_or_ref = shift;
3411 if (ref($line_or_ref) eq "HASH") {
3412 # pre-parsed (or generated by hand)
3413 return $line_or_ref;
3414 } else {
3415 return parse_difftree_raw_line($line_or_ref);
3419 # parse line of git-ls-tree output
3420 sub parse_ls_tree_line {
3421 my $line = shift;
3422 my %opts = @_;
3423 my %res;
3425 if ($opts{'-l'}) {
3426 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa 16717 panic.c'
3427 $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40}) +(-|[0-9]+)\t(.+)$/s;
3429 $res{'mode'} = $1;
3430 $res{'type'} = $2;
3431 $res{'hash'} = $3;
3432 $res{'size'} = $4;
3433 if ($opts{'-z'}) {
3434 $res{'name'} = $5;
3435 } else {
3436 $res{'name'} = unquote($5);
3438 } else {
3439 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
3440 $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t(.+)$/s;
3442 $res{'mode'} = $1;
3443 $res{'type'} = $2;
3444 $res{'hash'} = $3;
3445 if ($opts{'-z'}) {
3446 $res{'name'} = $4;
3447 } else {
3448 $res{'name'} = unquote($4);
3452 return wantarray ? %res : \%res;
3455 # generates _two_ hashes, references to which are passed as 2 and 3 argument
3456 sub parse_from_to_diffinfo {
3457 my ($diffinfo, $from, $to, @parents) = @_;
3459 if ($diffinfo->{'nparents'}) {
3460 # combined diff
3461 $from->{'file'} = [];
3462 $from->{'href'} = [];
3463 fill_from_file_info($diffinfo, @parents)
3464 unless exists $diffinfo->{'from_file'};
3465 for (my $i = 0; $i < $diffinfo->{'nparents'}; $i++) {
3466 $from->{'file'}[$i] =
3467 defined $diffinfo->{'from_file'}[$i] ?
3468 $diffinfo->{'from_file'}[$i] :
3469 $diffinfo->{'to_file'};
3470 if ($diffinfo->{'status'}[$i] ne "A") { # not new (added) file
3471 $from->{'href'}[$i] = href(action=>"blob",
3472 hash_base=>$parents[$i],
3473 hash=>$diffinfo->{'from_id'}[$i],
3474 file_name=>$from->{'file'}[$i]);
3475 } else {
3476 $from->{'href'}[$i] = undef;
3479 } else {
3480 # ordinary (not combined) diff
3481 $from->{'file'} = $diffinfo->{'from_file'};
3482 if ($diffinfo->{'status'} ne "A") { # not new (added) file
3483 $from->{'href'} = href(action=>"blob", hash_base=>$hash_parent,
3484 hash=>$diffinfo->{'from_id'},
3485 file_name=>$from->{'file'});
3486 } else {
3487 delete $from->{'href'};
3491 $to->{'file'} = $diffinfo->{'to_file'};
3492 if (!is_deleted($diffinfo)) { # file exists in result
3493 $to->{'href'} = href(action=>"blob", hash_base=>$hash,
3494 hash=>$diffinfo->{'to_id'},
3495 file_name=>$to->{'file'});
3496 } else {
3497 delete $to->{'href'};
3501 ## ......................................................................
3502 ## parse to array of hashes functions
3504 sub git_get_heads_list {
3505 my ($limit, @classes) = @_;
3506 @classes = ('heads') unless @classes;
3507 my @patterns = map { "refs/$_" } @classes;
3508 my @headslist;
3510 open my $fd, '-|', git_cmd(), 'for-each-ref',
3511 ($limit ? '--count='.($limit+1) : ()), '--sort=-committerdate',
3512 '--format=%(objectname) %(refname) %(subject)%00%(committer)',
3513 @patterns
3514 or return;
3515 while (my $line = <$fd>) {
3516 my %ref_item;
3518 chomp $line;
3519 my ($refinfo, $committerinfo) = split(/\0/, $line);
3520 my ($hash, $name, $title) = split(' ', $refinfo, 3);
3521 my ($committer, $epoch, $tz) =
3522 ($committerinfo =~ /^(.*) ([0-9]+) (.*)$/);
3523 $ref_item{'fullname'} = $name;
3524 $name =~ s!^refs/(?:head|remote)s/!!;
3526 $ref_item{'name'} = $name;
3527 $ref_item{'id'} = $hash;
3528 $ref_item{'title'} = $title || '(no commit message)';
3529 $ref_item{'epoch'} = $epoch;
3530 if ($epoch) {
3531 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3532 } else {
3533 $ref_item{'age'} = "unknown";
3536 push @headslist, \%ref_item;
3538 close $fd;
3540 return wantarray ? @headslist : \@headslist;
3543 sub git_get_tags_list {
3544 my $limit = shift;
3545 my @tagslist;
3547 open my $fd, '-|', git_cmd(), 'for-each-ref',
3548 ($limit ? '--count='.($limit+1) : ()), '--sort=-creatordate',
3549 '--format=%(objectname) %(objecttype) %(refname) '.
3550 '%(*objectname) %(*objecttype) %(subject)%00%(creator)',
3551 'refs/tags'
3552 or return;
3553 while (my $line = <$fd>) {
3554 my %ref_item;
3556 chomp $line;
3557 my ($refinfo, $creatorinfo) = split(/\0/, $line);
3558 my ($id, $type, $name, $refid, $reftype, $title) = split(' ', $refinfo, 6);
3559 my ($creator, $epoch, $tz) =
3560 ($creatorinfo =~ /^(.*) ([0-9]+) (.*)$/);
3561 $ref_item{'fullname'} = $name;
3562 $name =~ s!^refs/tags/!!;
3564 $ref_item{'type'} = $type;
3565 $ref_item{'id'} = $id;
3566 $ref_item{'name'} = $name;
3567 if ($type eq "tag") {
3568 $ref_item{'subject'} = $title;
3569 $ref_item{'reftype'} = $reftype;
3570 $ref_item{'refid'} = $refid;
3571 } else {
3572 $ref_item{'reftype'} = $type;
3573 $ref_item{'refid'} = $id;
3576 if ($type eq "tag" || $type eq "commit") {
3577 $ref_item{'epoch'} = $epoch;
3578 if ($epoch) {
3579 $ref_item{'age'} = age_string(time - $ref_item{'epoch'});
3580 } else {
3581 $ref_item{'age'} = "unknown";
3585 push @tagslist, \%ref_item;
3587 close $fd;
3589 return wantarray ? @tagslist : \@tagslist;
3592 ## ----------------------------------------------------------------------
3593 ## filesystem-related functions
3595 sub get_file_owner {
3596 my $path = shift;
3598 my ($dev, $ino, $mode, $nlink, $st_uid, $st_gid, $rdev, $size) = stat($path);
3599 my ($name, $passwd, $uid, $gid, $quota, $comment, $gcos, $dir, $shell) = getpwuid($st_uid);
3600 if (!defined $gcos) {
3601 return undef;
3603 my $owner = $gcos;
3604 $owner =~ s/[,;].*$//;
3605 return to_utf8($owner);
3608 # assume that file exists
3609 sub insert_file {
3610 my $filename = shift;
3612 open my $fd, '<', $filename;
3613 print map { to_utf8($_) } <$fd>;
3614 close $fd;
3617 ## ......................................................................
3618 ## mimetype related functions
3620 sub mimetype_guess_file {
3621 my $filename = shift;
3622 my $mimemap = shift;
3623 -r $mimemap or return undef;
3625 my %mimemap;
3626 open(my $mh, '<', $mimemap) or return undef;
3627 while (<$mh>) {
3628 next if m/^#/; # skip comments
3629 my ($mimetype, @exts) = split(/\s+/);
3630 foreach my $ext (@exts) {
3631 $mimemap{$ext} = $mimetype;
3634 close($mh);
3636 $filename =~ /\.([^.]*)$/;
3637 return $mimemap{$1};
3640 sub mimetype_guess {
3641 my $filename = shift;
3642 my $mime;
3643 $filename =~ /\./ or return undef;
3645 if ($mimetypes_file) {
3646 my $file = $mimetypes_file;
3647 if ($file !~ m!^/!) { # if it is relative path
3648 # it is relative to project
3649 $file = "$projectroot/$project/$file";
3651 $mime = mimetype_guess_file($filename, $file);
3653 $mime ||= mimetype_guess_file($filename, '/etc/mime.types');
3654 return $mime;
3657 sub blob_mimetype {
3658 my $fd = shift;
3659 my $filename = shift;
3661 if ($filename) {
3662 my $mime = mimetype_guess($filename);
3663 $mime and return $mime;
3666 # just in case
3667 return $default_blob_plain_mimetype unless $fd;
3669 if (-T $fd) {
3670 return 'text/plain';
3671 } elsif (! $filename) {
3672 return 'application/octet-stream';
3673 } elsif ($filename =~ m/\.png$/i) {
3674 return 'image/png';
3675 } elsif ($filename =~ m/\.gif$/i) {
3676 return 'image/gif';
3677 } elsif ($filename =~ m/\.jpe?g$/i) {
3678 return 'image/jpeg';
3679 } else {
3680 return 'application/octet-stream';
3684 sub blob_contenttype {
3685 my ($fd, $file_name, $type) = @_;
3687 $type ||= blob_mimetype($fd, $file_name);
3688 if ($type eq 'text/plain' && defined $default_text_plain_charset) {
3689 $type .= "; charset=$default_text_plain_charset";
3692 return $type;
3695 # guess file syntax for syntax highlighting; return undef if no highlighting
3696 # the name of syntax can (in the future) depend on syntax highlighter used
3697 sub guess_file_syntax {
3698 my ($highlight, $mimetype, $file_name) = @_;
3699 return undef unless ($highlight && defined $file_name);
3700 my $basename = basename($file_name, '.in');
3701 return $highlight_basename{$basename}
3702 if exists $highlight_basename{$basename};
3704 $basename =~ /\.([^.]*)$/;
3705 my $ext = $1 or return undef;
3706 return $highlight_ext{$ext}
3707 if exists $highlight_ext{$ext};
3709 return undef;
3712 # run highlighter and return FD of its output,
3713 # or return original FD if no highlighting
3714 sub run_highlighter {
3715 my ($fd, $highlight, $syntax) = @_;
3716 return $fd unless ($highlight && defined $syntax);
3718 close $fd;
3719 open $fd, quote_command(git_cmd(), "cat-file", "blob", $hash)." | ".
3720 quote_command($highlight_bin).
3721 " --replace-tabs=8 --fragment --syntax $syntax |"
3722 or die_error(500, "Couldn't open file or run syntax highlighter");
3723 return $fd;
3726 ## ======================================================================
3727 ## functions printing HTML: header, footer, error page
3729 sub get_page_title {
3730 my $title = to_utf8($site_name);
3732 return $title unless (defined $project);
3733 $title .= " - " . to_utf8($project);
3735 return $title unless (defined $action);
3736 $title .= "/$action"; # $action is US-ASCII (7bit ASCII)
3738 return $title unless (defined $file_name);
3739 $title .= " - " . esc_path($file_name);
3740 if ($action eq "tree" && $file_name !~ m|/$|) {
3741 $title .= "/";
3744 return $title;
3747 sub get_content_type_html {
3748 # require explicit support from the UA if we are to send the page as
3749 # 'application/xhtml+xml', otherwise send it as plain old 'text/html'.
3750 # we have to do this because MSIE sometimes globs '*/*', pretending to
3751 # support xhtml+xml but choking when it gets what it asked for.
3752 if (defined $cgi->http('HTTP_ACCEPT') &&
3753 $cgi->http('HTTP_ACCEPT') =~ m/(,|;|\s|^)application\/xhtml\+xml(,|;|\s|$)/ &&
3754 $cgi->Accept('application/xhtml+xml') != 0) {
3755 return 'application/xhtml+xml';
3756 } else {
3757 return 'text/html';
3761 sub print_feed_meta {
3762 if (defined $project) {
3763 my %href_params = get_feed_info();
3764 if (!exists $href_params{'-title'}) {
3765 $href_params{'-title'} = 'log';
3768 foreach my $format (qw(RSS Atom)) {
3769 my $type = lc($format);
3770 my %link_attr = (
3771 '-rel' => 'alternate',
3772 '-title' => esc_attr("$project - $href_params{'-title'} - $format feed"),
3773 '-type' => "application/$type+xml"
3776 $href_params{'action'} = $type;
3777 $link_attr{'-href'} = href(%href_params);
3778 print "<link ".
3779 "rel=\"$link_attr{'-rel'}\" ".
3780 "title=\"$link_attr{'-title'}\" ".
3781 "href=\"$link_attr{'-href'}\" ".
3782 "type=\"$link_attr{'-type'}\" ".
3783 "/>\n";
3785 $href_params{'extra_options'} = '--no-merges';
3786 $link_attr{'-href'} = href(%href_params);
3787 $link_attr{'-title'} .= ' (no merges)';
3788 print "<link ".
3789 "rel=\"$link_attr{'-rel'}\" ".
3790 "title=\"$link_attr{'-title'}\" ".
3791 "href=\"$link_attr{'-href'}\" ".
3792 "type=\"$link_attr{'-type'}\" ".
3793 "/>\n";
3796 } else {
3797 printf('<link rel="alternate" title="%s projects list" '.
3798 'href="%s" type="text/plain; charset=utf-8" />'."\n",
3799 esc_attr($site_name), href(project=>undef, action=>"project_index"));
3800 printf('<link rel="alternate" title="%s projects feeds" '.
3801 'href="%s" type="text/x-opml" />'."\n",
3802 esc_attr($site_name), href(project=>undef, action=>"opml"));
3806 sub print_header_links {
3807 my $status = shift;
3809 # print out each stylesheet that exist, providing backwards capability
3810 # for those people who defined $stylesheet in a config file
3811 if (defined $stylesheet) {
3812 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
3813 } else {
3814 foreach my $stylesheet (@stylesheets) {
3815 next unless $stylesheet;
3816 print '<link rel="stylesheet" type="text/css" href="'.esc_url($stylesheet).'"/>'."\n";
3819 print_feed_meta()
3820 if ($status eq '200 OK');
3821 if (defined $favicon) {
3822 print qq(<link rel="shortcut icon" href=").esc_url($favicon).qq(" type="image/png" />\n);
3826 sub print_nav_breadcrumbs {
3827 my %opts = @_;
3829 print $cgi->a({-href => esc_url($home_link)}, $home_link_str) . " / ";
3830 if (defined $project) {
3831 print $cgi->a({-href => href(action=>"summary")}, esc_html($project));
3832 if (defined $action) {
3833 my $action_print = $action ;
3834 if (defined $opts{-action_extra}) {
3835 $action_print = $cgi->a({-href => href(action=>$action)},
3836 $action);
3838 print " / $action_print";
3840 if (defined $opts{-action_extra}) {
3841 print " / $opts{-action_extra}";
3843 print "\n";
3847 sub print_search_form {
3848 if (!defined $searchtext) {
3849 $searchtext = "";
3851 my $search_hash;
3852 if (defined $hash_base) {
3853 $search_hash = $hash_base;
3854 } elsif (defined $hash) {
3855 $search_hash = $hash;
3856 } else {
3857 $search_hash = "HEAD";
3859 my $action = $my_uri;
3860 my $use_pathinfo = gitweb_check_feature('pathinfo');
3861 if ($use_pathinfo) {
3862 $action .= "/".esc_url($project);
3864 print $cgi->startform(-method => "get", -action => $action) .
3865 "<div class=\"search\">\n" .
3866 (!$use_pathinfo &&
3867 $cgi->input({-name=>"p", -value=>$project, -type=>"hidden"}) . "\n") .
3868 $cgi->input({-name=>"a", -value=>"search", -type=>"hidden"}) . "\n" .
3869 $cgi->input({-name=>"h", -value=>$search_hash, -type=>"hidden"}) . "\n" .
3870 $cgi->popup_menu(-name => 'st', -default => 'commit',
3871 -values => ['commit', 'grep', 'author', 'committer', 'pickaxe']) .
3872 $cgi->sup($cgi->a({-href => href(action=>"search_help")}, "?")) .
3873 " search:\n",
3874 $cgi->textfield(-name => "s", -value => $searchtext) . "\n" .
3875 "<span title=\"Extended regular expression\">" .
3876 $cgi->checkbox(-name => 'sr', -value => 1, -label => 're',
3877 -checked => $search_use_regexp) .
3878 "</span>" .
3879 "</div>" .
3880 $cgi->end_form() . "\n";
3883 sub git_header_html {
3884 my $status = shift || "200 OK";
3885 my $expires = shift;
3886 my %opts = @_;
3888 my $title = get_page_title();
3889 my $content_type = get_content_type_html();
3890 print $cgi->header(-type=>$content_type, -charset => 'utf-8',
3891 -status=> $status, -expires => $expires)
3892 unless ($opts{'-no_http_header'});
3893 my $mod_perl_version = $ENV{'MOD_PERL'} ? " $ENV{'MOD_PERL'}" : '';
3894 print <<EOF;
3895 <?xml version="1.0" encoding="utf-8"?>
3896 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3897 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
3898 <!-- git web interface version $version, (C) 2005-2006, Kay Sievers <kay.sievers\@vrfy.org>, Christian Gierke -->
3899 <!-- git core binaries version $git_version -->
3900 <head>
3901 <meta http-equiv="content-type" content="$content_type; charset=utf-8"/>
3902 <meta name="generator" content="gitweb/$version git/$git_version$mod_perl_version"/>
3903 <meta name="robots" content="index, nofollow"/>
3904 <title>$title</title>
3906 # the stylesheet, favicon etc urls won't work correctly with path_info
3907 # unless we set the appropriate base URL
3908 if ($ENV{'PATH_INFO'}) {
3909 print "<base href=\"".esc_url($base_url)."\" />\n";
3911 print_header_links($status);
3913 if (defined $site_html_head_string) {
3914 print to_utf8($site_html_head_string);
3917 print "</head>\n" .
3918 "<body>\n";
3920 if (defined $site_header && -f $site_header) {
3921 insert_file($site_header);
3924 print "<div class=\"page_header\">\n";
3925 if (defined $logo) {
3926 print $cgi->a({-href => esc_url($logo_url),
3927 -title => $logo_label},
3928 $cgi->img({-src => esc_url($logo),
3929 -width => 72, -height => 27,
3930 -alt => "git",
3931 -class => "logo"}));
3933 print_nav_breadcrumbs(%opts);
3934 print "</div>\n";
3936 my $have_search = gitweb_check_feature('search');
3937 if (defined $project && $have_search) {
3938 print_search_form();
3942 sub git_footer_html {
3943 my $feed_class = 'rss_logo';
3945 print "<div class=\"page_footer\">\n";
3946 if (defined $project) {
3947 my $descr = git_get_project_description($project);
3948 if (defined $descr) {
3949 print "<div class=\"page_footer_text\">" . esc_html($descr) . "</div>\n";
3952 my %href_params = get_feed_info();
3953 if (!%href_params) {
3954 $feed_class .= ' generic';
3956 $href_params{'-title'} ||= 'log';
3958 foreach my $format (qw(RSS Atom)) {
3959 $href_params{'action'} = lc($format);
3960 print $cgi->a({-href => href(%href_params),
3961 -title => "$href_params{'-title'} $format feed",
3962 -class => $feed_class}, $format)."\n";
3965 } else {
3966 print $cgi->a({-href => href(project=>undef, action=>"opml"),
3967 -class => $feed_class}, "OPML") . " ";
3968 print $cgi->a({-href => href(project=>undef, action=>"project_index"),
3969 -class => $feed_class}, "TXT") . "\n";
3971 print "</div>\n"; # class="page_footer"
3973 if (defined $t0 && gitweb_check_feature('timed')) {
3974 print "<div id=\"generating_info\">\n";
3975 print 'This page took '.
3976 '<span id="generating_time" class="time_span">'.
3977 tv_interval($t0, [ gettimeofday() ]).
3978 ' seconds </span>'.
3979 ' and '.
3980 '<span id="generating_cmd">'.
3981 $number_of_git_cmds.
3982 '</span> git commands '.
3983 " to generate.\n";
3984 print "</div>\n"; # class="page_footer"
3987 if (defined $site_footer && -f $site_footer) {
3988 insert_file($site_footer);
3991 print qq!<script type="text/javascript" src="!.esc_url($javascript).qq!"></script>\n!;
3992 if (defined $action &&
3993 $action eq 'blame_incremental') {
3994 print qq!<script type="text/javascript">\n!.
3995 qq!startBlame("!. href(action=>"blame_data", -replay=>1) .qq!",\n!.
3996 qq! "!. href() .qq!");\n!.
3997 qq!</script>\n!;
3998 } else {
3999 my ($jstimezone, $tz_cookie, $datetime_class) =
4000 gitweb_get_feature('javascript-timezone');
4002 print qq!<script type="text/javascript">\n!.
4003 qq!window.onload = function () {\n!;
4004 if (gitweb_check_feature('javascript-actions')) {
4005 print qq! fixLinks();\n!;
4007 if ($jstimezone && $tz_cookie && $datetime_class) {
4008 print qq! var tz_cookie = { name: '$tz_cookie', expires: 14, path: '/' };\n!. # in days
4009 qq! onloadTZSetup('$jstimezone', tz_cookie, '$datetime_class');\n!;
4011 print qq!};\n!.
4012 qq!</script>\n!;
4015 print "</body>\n" .
4016 "</html>";
4019 # die_error(<http_status_code>, <error_message>[, <detailed_html_description>])
4020 # Example: die_error(404, 'Hash not found')
4021 # By convention, use the following status codes (as defined in RFC 2616):
4022 # 400: Invalid or missing CGI parameters, or
4023 # requested object exists but has wrong type.
4024 # 403: Requested feature (like "pickaxe" or "snapshot") not enabled on
4025 # this server or project.
4026 # 404: Requested object/revision/project doesn't exist.
4027 # 500: The server isn't configured properly, or
4028 # an internal error occurred (e.g. failed assertions caused by bugs), or
4029 # an unknown error occurred (e.g. the git binary died unexpectedly).
4030 # 503: The server is currently unavailable (because it is overloaded,
4031 # or down for maintenance). Generally, this is a temporary state.
4032 sub die_error {
4033 my $status = shift || 500;
4034 my $error = esc_html(shift) || "Internal Server Error";
4035 my $extra = shift;
4036 my %opts = @_;
4038 my %http_responses = (
4039 400 => '400 Bad Request',
4040 403 => '403 Forbidden',
4041 404 => '404 Not Found',
4042 500 => '500 Internal Server Error',
4043 503 => '503 Service Unavailable',
4045 git_header_html($http_responses{$status}, undef, %opts);
4046 print <<EOF;
4047 <div class="page_body">
4048 <br /><br />
4049 $status - $error
4050 <br />
4052 if (defined $extra) {
4053 print "<hr />\n" .
4054 "$extra\n";
4056 print "</div>\n";
4058 git_footer_html();
4059 goto DONE_GITWEB
4060 unless ($opts{'-error_handler'});
4063 ## ----------------------------------------------------------------------
4064 ## functions printing or outputting HTML: navigation
4066 sub git_print_page_nav {
4067 my ($current, $suppress, $head, $treehead, $treebase, $extra) = @_;
4068 $extra = '' if !defined $extra; # pager or formats
4070 my @navs = qw(summary shortlog log commit commitdiff tree);
4071 if ($suppress) {
4072 @navs = grep { $_ ne $suppress } @navs;
4075 my %arg = map { $_ => {action=>$_} } @navs;
4076 if (defined $head) {
4077 for (qw(commit commitdiff)) {
4078 $arg{$_}{'hash'} = $head;
4080 if ($current =~ m/^(tree | log | shortlog | commit | commitdiff | search)$/x) {
4081 for (qw(shortlog log)) {
4082 $arg{$_}{'hash'} = $head;
4087 $arg{'tree'}{'hash'} = $treehead if defined $treehead;
4088 $arg{'tree'}{'hash_base'} = $treebase if defined $treebase;
4090 my @actions = gitweb_get_feature('actions');
4091 my %repl = (
4092 '%' => '%',
4093 'n' => $project, # project name
4094 'f' => $git_dir, # project path within filesystem
4095 'h' => $treehead || '', # current hash ('h' parameter)
4096 'b' => $treebase || '', # hash base ('hb' parameter)
4098 while (@actions) {
4099 my ($label, $link, $pos) = splice(@actions,0,3);
4100 # insert
4101 @navs = map { $_ eq $pos ? ($_, $label) : $_ } @navs;
4102 # munch munch
4103 $link =~ s/%([%nfhb])/$repl{$1}/g;
4104 $arg{$label}{'_href'} = $link;
4107 print "<div class=\"page_nav\">\n" .
4108 (join " | ",
4109 map { $_ eq $current ?
4110 $_ : $cgi->a({-href => ($arg{$_}{_href} ? $arg{$_}{_href} : href(%{$arg{$_}}))}, "$_")
4111 } @navs);
4112 print "<br/>\n$extra<br/>\n" .
4113 "</div>\n";
4116 # returns a submenu for the nagivation of the refs views (tags, heads,
4117 # remotes) with the current view disabled and the remotes view only
4118 # available if the feature is enabled
4119 sub format_ref_views {
4120 my ($current) = @_;
4121 my @ref_views = qw{tags heads};
4122 push @ref_views, 'remotes' if gitweb_check_feature('remote_heads');
4123 return join " | ", map {
4124 $_ eq $current ? $_ :
4125 $cgi->a({-href => href(action=>$_)}, $_)
4126 } @ref_views
4129 sub format_paging_nav {
4130 my ($action, $page, $has_next_link) = @_;
4131 my $paging_nav;
4134 if ($page > 0) {
4135 $paging_nav .=
4136 $cgi->a({-href => href(-replay=>1, page=>undef)}, "first") .
4137 " &sdot; " .
4138 $cgi->a({-href => href(-replay=>1, page=>$page-1),
4139 -accesskey => "p", -title => "Alt-p"}, "prev");
4140 } else {
4141 $paging_nav .= "first &sdot; prev";
4144 if ($has_next_link) {
4145 $paging_nav .= " &sdot; " .
4146 $cgi->a({-href => href(-replay=>1, page=>$page+1),
4147 -accesskey => "n", -title => "Alt-n"}, "next");
4148 } else {
4149 $paging_nav .= " &sdot; next";
4152 return $paging_nav;
4155 ## ......................................................................
4156 ## functions printing or outputting HTML: div
4158 sub git_print_header_div {
4159 my ($action, $title, $hash, $hash_base) = @_;
4160 my %args = ();
4162 $args{'action'} = $action;
4163 $args{'hash'} = $hash if $hash;
4164 $args{'hash_base'} = $hash_base if $hash_base;
4166 print "<div class=\"header\">\n" .
4167 $cgi->a({-href => href(%args), -class => "title"},
4168 $title ? $title : $action) .
4169 "\n</div>\n";
4172 sub format_repo_url {
4173 my ($name, $url) = @_;
4174 return "<tr class=\"metadata_url\"><td>$name</td><td>$url</td></tr>\n";
4177 # Group output by placing it in a DIV element and adding a header.
4178 # Options for start_div() can be provided by passing a hash reference as the
4179 # first parameter to the function.
4180 # Options to git_print_header_div() can be provided by passing an array
4181 # reference. This must follow the options to start_div if they are present.
4182 # The content can be a scalar, which is output as-is, a scalar reference, which
4183 # is output after html escaping, an IO handle passed either as *handle or
4184 # *handle{IO}, or a function reference. In the latter case all following
4185 # parameters will be taken as argument to the content function call.
4186 sub git_print_section {
4187 my ($div_args, $header_args, $content);
4188 my $arg = shift;
4189 if (ref($arg) eq 'HASH') {
4190 $div_args = $arg;
4191 $arg = shift;
4193 if (ref($arg) eq 'ARRAY') {
4194 $header_args = $arg;
4195 $arg = shift;
4197 $content = $arg;
4199 print $cgi->start_div($div_args);
4200 git_print_header_div(@$header_args);
4202 if (ref($content) eq 'CODE') {
4203 $content->(@_);
4204 } elsif (ref($content) eq 'SCALAR') {
4205 print esc_html($$content);
4206 } elsif (ref($content) eq 'GLOB' or ref($content) eq 'IO::Handle') {
4207 print <$content>;
4208 } elsif (!ref($content) && defined($content)) {
4209 print $content;
4212 print $cgi->end_div;
4215 sub format_timestamp_html {
4216 my $date = shift;
4217 my $strtime = $date->{'rfc2822'};
4219 my (undef, undef, $datetime_class) =
4220 gitweb_get_feature('javascript-timezone');
4221 if ($datetime_class) {
4222 $strtime = qq!<span class="$datetime_class">$strtime</span>!;
4225 my $localtime_format = '(%02d:%02d %s)';
4226 if ($date->{'hour_local'} < 6) {
4227 $localtime_format = '(<span class="atnight">%02d:%02d</span> %s)';
4229 $strtime .= ' ' .
4230 sprintf($localtime_format,
4231 $date->{'hour_local'}, $date->{'minute_local'}, $date->{'tz_local'});
4233 return $strtime;
4236 # Outputs the author name and date in long form
4237 sub git_print_authorship {
4238 my $co = shift;
4239 my %opts = @_;
4240 my $tag = $opts{-tag} || 'div';
4241 my $author = $co->{'author_name'};
4243 my %ad = parse_date($co->{'author_epoch'}, $co->{'author_tz'});
4244 print "<$tag class=\"author_date\">" .
4245 format_search_author($author, "author", esc_html($author)) .
4246 " [".format_timestamp_html(\%ad)."]".
4247 git_get_avatar($co->{'author_email'}, -pad_before => 1) .
4248 "</$tag>\n";
4251 # Outputs table rows containing the full author or committer information,
4252 # in the format expected for 'commit' view (& similar).
4253 # Parameters are a commit hash reference, followed by the list of people
4254 # to output information for. If the list is empty it defaults to both
4255 # author and committer.
4256 sub git_print_authorship_rows {
4257 my $co = shift;
4258 # too bad we can't use @people = @_ || ('author', 'committer')
4259 my @people = @_;
4260 @people = ('author', 'committer') unless @people;
4261 foreach my $who (@people) {
4262 my %wd = parse_date($co->{"${who}_epoch"}, $co->{"${who}_tz"});
4263 print "<tr><td>$who</td><td>" .
4264 format_search_author($co->{"${who}_name"}, $who,
4265 esc_html($co->{"${who}_name"})) . " " .
4266 format_search_author($co->{"${who}_email"}, $who,
4267 esc_html("<" . $co->{"${who}_email"} . ">")) .
4268 "</td><td rowspan=\"2\">" .
4269 git_get_avatar($co->{"${who}_email"}, -size => 'double') .
4270 "</td></tr>\n" .
4271 "<tr>" .
4272 "<td></td><td>" .
4273 format_timestamp_html(\%wd) .
4274 "</td>" .
4275 "</tr>\n";
4279 sub git_print_page_path {
4280 my $name = shift;
4281 my $type = shift;
4282 my $hb = shift;
4285 print "<div class=\"page_path\">";
4286 print $cgi->a({-href => href(action=>"tree", hash_base=>$hb),
4287 -title => 'tree root'}, to_utf8("[$project]"));
4288 print " / ";
4289 if (defined $name) {
4290 my @dirname = split '/', $name;
4291 my $basename = pop @dirname;
4292 my $fullname = '';
4294 foreach my $dir (@dirname) {
4295 $fullname .= ($fullname ? '/' : '') . $dir;
4296 print $cgi->a({-href => href(action=>"tree", file_name=>$fullname,
4297 hash_base=>$hb),
4298 -title => $fullname}, esc_path($dir));
4299 print " / ";
4301 if (defined $type && $type eq 'blob') {
4302 print $cgi->a({-href => href(action=>"blob_plain", file_name=>$file_name,
4303 hash_base=>$hb),
4304 -title => $name}, esc_path($basename));
4305 print '&nbsp;&nbsp;&nbsp;&nbsp;
4306 <a id="lineNoToggle" href="#" onclick="toggleLineNumbers();"></a>
4307 <script>
4308 function toggleLineNumbers() {
4309 e = document.getElementById("lineNoStyle");
4310 e2 = document.getElementById("lineNoToggle");
4311 if (e2.innerHTML == "[Hide line numbers]") {
4312 e.innerHTML = ".linenr { display:none; }";
4313 e2.innerHTML = "[Show line numbers]";
4315 else {
4316 e.innerHTML = "";
4317 e2.innerHTML = "[Hide line numbers]";
4320 document.getElementsByTagName("head")[0].innerHTML += "<style id=\'lineNoStyle\'></style>";
4321 toggleLineNumbers();
4322 </script>
4324 } elsif (defined $type && $type eq 'tree') {
4325 print $cgi->a({-href => href(action=>"tree", file_name=>$file_name,
4326 hash_base=>$hb),
4327 -title => $name}, esc_path($basename));
4328 print " / ";
4329 } else {
4330 print esc_path($basename);
4333 print "<br/></div>\n";
4336 sub git_print_log {
4337 my $log = shift;
4338 my %opts = @_;
4340 if ($opts{'-remove_title'}) {
4341 # remove title, i.e. first line of log
4342 shift @$log;
4344 # remove leading empty lines
4345 while (defined $log->[0] && $log->[0] eq "") {
4346 shift @$log;
4349 # print log
4350 my $signoff = 0;
4351 my $empty = 0;
4352 foreach my $line (@$log) {
4353 if ($line =~ m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i) {
4354 $signoff = 1;
4355 $empty = 0;
4356 if (! $opts{'-remove_signoff'}) {
4357 print "<span class=\"signoff\">" . esc_html($line) . "</span><br/>\n";
4358 next;
4359 } else {
4360 # remove signoff lines
4361 next;
4363 } else {
4364 $signoff = 0;
4367 # print only one empty line
4368 # do not print empty line after signoff
4369 if ($line eq "") {
4370 next if ($empty || $signoff);
4371 $empty = 1;
4372 } else {
4373 $empty = 0;
4376 print format_log_line_html($line) . "<br/>\n";
4379 if ($opts{'-final_empty_line'}) {
4380 # end with single empty line
4381 print "<br/>\n" unless $empty;
4385 # return link target (what link points to)
4386 sub git_get_link_target {
4387 my $hash = shift;
4388 my $link_target;
4390 # read link
4391 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
4392 or return;
4394 local $/ = undef;
4395 $link_target = <$fd>;
4397 close $fd
4398 or return;
4400 return $link_target;
4403 # given link target, and the directory (basedir) the link is in,
4404 # return target of link relative to top directory (top tree);
4405 # return undef if it is not possible (including absolute links).
4406 sub normalize_link_target {
4407 my ($link_target, $basedir) = @_;
4409 # absolute symlinks (beginning with '/') cannot be normalized
4410 return if (substr($link_target, 0, 1) eq '/');
4412 # normalize link target to path from top (root) tree (dir)
4413 my $path;
4414 if ($basedir) {
4415 $path = $basedir . '/' . $link_target;
4416 } else {
4417 # we are in top (root) tree (dir)
4418 $path = $link_target;
4421 # remove //, /./, and /../
4422 my @path_parts;
4423 foreach my $part (split('/', $path)) {
4424 # discard '.' and ''
4425 next if (!$part || $part eq '.');
4426 # handle '..'
4427 if ($part eq '..') {
4428 if (@path_parts) {
4429 pop @path_parts;
4430 } else {
4431 # link leads outside repository (outside top dir)
4432 return;
4434 } else {
4435 push @path_parts, $part;
4438 $path = join('/', @path_parts);
4440 return $path;
4443 # print tree entry (row of git_tree), but without encompassing <tr> element
4444 sub git_print_tree_entry {
4445 my ($t, $basedir, $hash_base, $have_blame) = @_;
4447 my %base_key = ();
4448 $base_key{'hash_base'} = $hash_base if defined $hash_base;
4450 # The format of a table row is: mode list link. Where mode is
4451 # the mode of the entry, list is the name of the entry, an href,
4452 # and link is the action links of the entry.
4454 print "<td class=\"mode\">" . mode_str($t->{'mode'}) . "</td>\n";
4455 if (exists $t->{'size'}) {
4456 print "<td class=\"size\">$t->{'size'}</td>\n";
4458 if ($t->{'type'} eq "blob") {
4459 print "<td class=\"list\">" .
4460 $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4461 file_name=>"$basedir$t->{'name'}", %base_key),
4462 -class => "list"}, esc_path($t->{'name'}));
4463 if (S_ISLNK(oct $t->{'mode'})) {
4464 my $link_target = git_get_link_target($t->{'hash'});
4465 if ($link_target) {
4466 my $norm_target = normalize_link_target($link_target, $basedir);
4467 if (defined $norm_target) {
4468 print " -> " .
4469 $cgi->a({-href => href(action=>"object", hash_base=>$hash_base,
4470 file_name=>$norm_target),
4471 -title => $norm_target}, esc_path($link_target));
4472 } else {
4473 print " -> " . esc_path($link_target);
4477 print "</td>\n";
4478 print "<td class=\"link\">";
4479 print $cgi->a({-href => href(action=>"blob", hash=>$t->{'hash'},
4480 file_name=>"$basedir$t->{'name'}", %base_key)},
4481 "blob");
4482 if ($have_blame) {
4483 print " | " .
4484 $cgi->a({-href => href(action=>"blame", hash=>$t->{'hash'},
4485 file_name=>"$basedir$t->{'name'}", %base_key)},
4486 "blame");
4488 if (defined $hash_base) {
4489 print " | " .
4490 $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4491 hash=>$t->{'hash'}, file_name=>"$basedir$t->{'name'}")},
4492 "history");
4494 print " | " .
4495 $cgi->a({-href => href(action=>"blob_plain", hash_base=>$hash_base,
4496 file_name=>"$basedir$t->{'name'}")},
4497 "raw");
4498 print "</td>\n";
4500 } elsif ($t->{'type'} eq "tree") {
4501 print "<td class=\"list\">";
4502 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4503 file_name=>"$basedir$t->{'name'}",
4504 %base_key)},
4505 esc_path($t->{'name'}));
4506 print "</td>\n";
4507 print "<td class=\"link\">";
4508 print $cgi->a({-href => href(action=>"tree", hash=>$t->{'hash'},
4509 file_name=>"$basedir$t->{'name'}",
4510 %base_key)},
4511 "tree");
4512 if (defined $hash_base) {
4513 print " | " .
4514 $cgi->a({-href => href(action=>"history", hash_base=>$hash_base,
4515 file_name=>"$basedir$t->{'name'}")},
4516 "history");
4518 print "</td>\n";
4519 } else {
4520 # unknown object: we can only present history for it
4521 # (this includes 'commit' object, i.e. submodule support)
4522 print "<td class=\"list\">" .
4523 esc_path($t->{'name'}) .
4524 "</td>\n";
4525 print "<td class=\"link\">";
4526 if (defined $hash_base) {
4527 print $cgi->a({-href => href(action=>"history",
4528 hash_base=>$hash_base,
4529 file_name=>"$basedir$t->{'name'}")},
4530 "history");
4532 print "</td>\n";
4536 ## ......................................................................
4537 ## functions printing large fragments of HTML
4539 # get pre-image filenames for merge (combined) diff
4540 sub fill_from_file_info {
4541 my ($diff, @parents) = @_;
4543 $diff->{'from_file'} = [ ];
4544 $diff->{'from_file'}[$diff->{'nparents'} - 1] = undef;
4545 for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4546 if ($diff->{'status'}[$i] eq 'R' ||
4547 $diff->{'status'}[$i] eq 'C') {
4548 $diff->{'from_file'}[$i] =
4549 git_get_path_by_hash($parents[$i], $diff->{'from_id'}[$i]);
4553 return $diff;
4556 # is current raw difftree line of file deletion
4557 sub is_deleted {
4558 my $diffinfo = shift;
4560 return $diffinfo->{'to_id'} eq ('0' x 40);
4563 # does patch correspond to [previous] difftree raw line
4564 # $diffinfo - hashref of parsed raw diff format
4565 # $patchinfo - hashref of parsed patch diff format
4566 # (the same keys as in $diffinfo)
4567 sub is_patch_split {
4568 my ($diffinfo, $patchinfo) = @_;
4570 return defined $diffinfo && defined $patchinfo
4571 && $diffinfo->{'to_file'} eq $patchinfo->{'to_file'};
4575 sub git_difftree_body {
4576 my ($difftree, $hash, @parents) = @_;
4577 my ($parent) = $parents[0];
4578 my $have_blame = gitweb_check_feature('blame');
4579 print "<div class=\"list_head\">\n";
4580 if ($#{$difftree} > 10) {
4581 print(($#{$difftree} + 1) . " files changed:\n");
4583 print "</div>\n";
4585 print "<table class=\"" .
4586 (@parents > 1 ? "combined " : "") .
4587 "diff_tree\">\n";
4589 # header only for combined diff in 'commitdiff' view
4590 my $has_header = @$difftree && @parents > 1 && $action eq 'commitdiff';
4591 if ($has_header) {
4592 # table header
4593 print "<thead><tr>\n" .
4594 "<th></th><th></th>\n"; # filename, patchN link
4595 for (my $i = 0; $i < @parents; $i++) {
4596 my $par = $parents[$i];
4597 print "<th>" .
4598 $cgi->a({-href => href(action=>"commitdiff",
4599 hash=>$hash, hash_parent=>$par),
4600 -title => 'commitdiff to parent number ' .
4601 ($i+1) . ': ' . substr($par,0,7)},
4602 $i+1) .
4603 "&nbsp;</th>\n";
4605 print "</tr></thead>\n<tbody>\n";
4608 my $alternate = 1;
4609 my $patchno = 0;
4610 foreach my $line (@{$difftree}) {
4611 my $diff = parsed_difftree_line($line);
4613 if ($alternate) {
4614 print "<tr class=\"dark\">\n";
4615 } else {
4616 print "<tr class=\"light\">\n";
4618 $alternate ^= 1;
4620 if (exists $diff->{'nparents'}) { # combined diff
4622 fill_from_file_info($diff, @parents)
4623 unless exists $diff->{'from_file'};
4625 if (!is_deleted($diff)) {
4626 # file exists in the result (child) commit
4627 print "<td>" .
4628 $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4629 file_name=>$diff->{'to_file'},
4630 hash_base=>$hash),
4631 -class => "list"}, esc_path($diff->{'to_file'})) .
4632 "</td>\n";
4633 } else {
4634 print "<td>" .
4635 esc_path($diff->{'to_file'}) .
4636 "</td>\n";
4639 if ($action eq 'commitdiff') {
4640 # link to patch
4641 $patchno++;
4642 print "<td class=\"link\">" .
4643 $cgi->a({-href => href(-anchor=>"patch$patchno")},
4644 "patch") .
4645 " | " .
4646 "</td>\n";
4649 my $has_history = 0;
4650 my $not_deleted = 0;
4651 for (my $i = 0; $i < $diff->{'nparents'}; $i++) {
4652 my $hash_parent = $parents[$i];
4653 my $from_hash = $diff->{'from_id'}[$i];
4654 my $from_path = $diff->{'from_file'}[$i];
4655 my $status = $diff->{'status'}[$i];
4657 $has_history ||= ($status ne 'A');
4658 $not_deleted ||= ($status ne 'D');
4660 if ($status eq 'A') {
4661 print "<td class=\"link\" align=\"right\"> | </td>\n";
4662 } elsif ($status eq 'D') {
4663 print "<td class=\"link\">" .
4664 $cgi->a({-href => href(action=>"blob",
4665 hash_base=>$hash,
4666 hash=>$from_hash,
4667 file_name=>$from_path)},
4668 "blob" . ($i+1)) .
4669 " | </td>\n";
4670 } else {
4671 if ($diff->{'to_id'} eq $from_hash) {
4672 print "<td class=\"link nochange\">";
4673 } else {
4674 print "<td class=\"link\">";
4676 print $cgi->a({-href => href(action=>"blobdiff",
4677 hash=>$diff->{'to_id'},
4678 hash_parent=>$from_hash,
4679 hash_base=>$hash,
4680 hash_parent_base=>$hash_parent,
4681 file_name=>$diff->{'to_file'},
4682 file_parent=>$from_path)},
4683 "diff" . ($i+1)) .
4684 " | </td>\n";
4688 print "<td class=\"link\">";
4689 if ($not_deleted) {
4690 print $cgi->a({-href => href(action=>"blob",
4691 hash=>$diff->{'to_id'},
4692 file_name=>$diff->{'to_file'},
4693 hash_base=>$hash)},
4694 "blob");
4695 print " | " if ($has_history);
4697 if ($has_history) {
4698 print $cgi->a({-href => href(action=>"history",
4699 file_name=>$diff->{'to_file'},
4700 hash_base=>$hash)},
4701 "history");
4703 print "</td>\n";
4705 print "</tr>\n";
4706 next; # instead of 'else' clause, to avoid extra indent
4708 # else ordinary diff
4710 my ($to_mode_oct, $to_mode_str, $to_file_type);
4711 my ($from_mode_oct, $from_mode_str, $from_file_type);
4712 if ($diff->{'to_mode'} ne ('0' x 6)) {
4713 $to_mode_oct = oct $diff->{'to_mode'};
4714 if (S_ISREG($to_mode_oct)) { # only for regular file
4715 $to_mode_str = sprintf("%04o", $to_mode_oct & 0777); # permission bits
4717 $to_file_type = file_type($diff->{'to_mode'});
4719 if ($diff->{'from_mode'} ne ('0' x 6)) {
4720 $from_mode_oct = oct $diff->{'from_mode'};
4721 if (S_ISREG($from_mode_oct)) { # only for regular file
4722 $from_mode_str = sprintf("%04o", $from_mode_oct & 0777); # permission bits
4724 $from_file_type = file_type($diff->{'from_mode'});
4727 if ($diff->{'status'} eq "A") { # created
4728 my $mode_chng = "<span class=\"file_status new\">[new $to_file_type";
4729 $mode_chng .= " with mode: $to_mode_str" if $to_mode_str;
4730 $mode_chng .= "]</span>";
4731 print "<td>";
4732 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4733 hash_base=>$hash, file_name=>$diff->{'file'}),
4734 -class => "list"}, esc_path($diff->{'file'}));
4735 print "</td>\n";
4736 print "<td>$mode_chng</td>\n";
4737 print "<td class=\"link\">";
4738 if ($action eq 'commitdiff') {
4739 # link to patch
4740 $patchno++;
4741 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4742 "patch") .
4743 " | ";
4745 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4746 hash_base=>$hash, file_name=>$diff->{'file'})},
4747 "blob");
4748 print "</td>\n";
4750 } elsif ($diff->{'status'} eq "D") { # deleted
4751 my $mode_chng = "<span class=\"file_status deleted\">[deleted $from_file_type]</span>";
4752 print "<td>";
4753 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
4754 hash_base=>$parent, file_name=>$diff->{'file'}),
4755 -class => "list"}, esc_path($diff->{'file'}));
4756 print "</td>\n";
4757 print "<td>$mode_chng</td>\n";
4758 print "<td class=\"link\">";
4759 if ($action eq 'commitdiff') {
4760 # link to patch
4761 $patchno++;
4762 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4763 "patch") .
4764 " | ";
4766 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'from_id'},
4767 hash_base=>$parent, file_name=>$diff->{'file'})},
4768 "blob") . " | ";
4769 if ($have_blame) {
4770 print $cgi->a({-href => href(action=>"blame", hash_base=>$parent,
4771 file_name=>$diff->{'file'})},
4772 "blame") . " | ";
4774 print $cgi->a({-href => href(action=>"history", hash_base=>$parent,
4775 file_name=>$diff->{'file'})},
4776 "history");
4777 print "</td>\n";
4779 } elsif ($diff->{'status'} eq "M" || $diff->{'status'} eq "T") { # modified, or type changed
4780 my $mode_chnge = "";
4781 if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
4782 $mode_chnge = "<span class=\"file_status mode_chnge\">[changed";
4783 if ($from_file_type ne $to_file_type) {
4784 $mode_chnge .= " from $from_file_type to $to_file_type";
4786 if (($from_mode_oct & 0777) != ($to_mode_oct & 0777)) {
4787 if ($from_mode_str && $to_mode_str) {
4788 $mode_chnge .= " mode: $from_mode_str->$to_mode_str";
4789 } elsif ($to_mode_str) {
4790 $mode_chnge .= " mode: $to_mode_str";
4793 $mode_chnge .= "]</span>\n";
4795 print "<td>";
4796 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4797 hash_base=>$hash, file_name=>$diff->{'file'}),
4798 -class => "list"}, esc_path($diff->{'file'}));
4799 print "</td>\n";
4800 print "<td>$mode_chnge</td>\n";
4801 print "<td class=\"link\">";
4802 if ($action eq 'commitdiff') {
4803 # link to patch
4804 $patchno++;
4805 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4806 "patch") .
4807 " | ";
4808 } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
4809 # "commit" view and modified file (not onlu mode changed)
4810 print $cgi->a({-href => href(action=>"blobdiff",
4811 hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
4812 hash_base=>$hash, hash_parent_base=>$parent,
4813 file_name=>$diff->{'file'})},
4814 "diff") .
4815 " | ";
4817 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4818 hash_base=>$hash, file_name=>$diff->{'file'})},
4819 "blob") . " | ";
4820 if ($have_blame) {
4821 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
4822 file_name=>$diff->{'file'})},
4823 "blame") . " | ";
4825 print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
4826 file_name=>$diff->{'file'})},
4827 "history");
4828 print "</td>\n";
4830 } elsif ($diff->{'status'} eq "R" || $diff->{'status'} eq "C") { # renamed or copied
4831 my %status_name = ('R' => 'moved', 'C' => 'copied');
4832 my $nstatus = $status_name{$diff->{'status'}};
4833 my $mode_chng = "";
4834 if ($diff->{'from_mode'} != $diff->{'to_mode'}) {
4835 # mode also for directories, so we cannot use $to_mode_str
4836 $mode_chng = sprintf(", mode: %04o", $to_mode_oct & 0777);
4838 print "<td>" .
4839 $cgi->a({-href => href(action=>"blob", hash_base=>$hash,
4840 hash=>$diff->{'to_id'}, file_name=>$diff->{'to_file'}),
4841 -class => "list"}, esc_path($diff->{'to_file'})) . "</td>\n" .
4842 "<td><span class=\"file_status $nstatus\">[$nstatus from " .
4843 $cgi->a({-href => href(action=>"blob", hash_base=>$parent,
4844 hash=>$diff->{'from_id'}, file_name=>$diff->{'from_file'}),
4845 -class => "list"}, esc_path($diff->{'from_file'})) .
4846 " with " . (int $diff->{'similarity'}) . "% similarity$mode_chng]</span></td>\n" .
4847 "<td class=\"link\">";
4848 if ($action eq 'commitdiff') {
4849 # link to patch
4850 $patchno++;
4851 print $cgi->a({-href => href(-anchor=>"patch$patchno")},
4852 "patch") .
4853 " | ";
4854 } elsif ($diff->{'to_id'} ne $diff->{'from_id'}) {
4855 # "commit" view and modified file (not only pure rename or copy)
4856 print $cgi->a({-href => href(action=>"blobdiff",
4857 hash=>$diff->{'to_id'}, hash_parent=>$diff->{'from_id'},
4858 hash_base=>$hash, hash_parent_base=>$parent,
4859 file_name=>$diff->{'to_file'}, file_parent=>$diff->{'from_file'})},
4860 "diff") .
4861 " | ";
4863 print $cgi->a({-href => href(action=>"blob", hash=>$diff->{'to_id'},
4864 hash_base=>$parent, file_name=>$diff->{'to_file'})},
4865 "blob") . " | ";
4866 if ($have_blame) {
4867 print $cgi->a({-href => href(action=>"blame", hash_base=>$hash,
4868 file_name=>$diff->{'to_file'})},
4869 "blame") . " | ";
4871 print $cgi->a({-href => href(action=>"history", hash_base=>$hash,
4872 file_name=>$diff->{'to_file'})},
4873 "history");
4874 print "</td>\n";
4876 } # we should not encounter Unmerged (U) or Unknown (X) status
4877 print "</tr>\n";
4879 print "</tbody>" if $has_header;
4880 print "</table>\n";
4883 sub print_sidebyside_diff_chunk {
4884 my @chunk = @_;
4885 my (@ctx, @rem, @add);
4887 return unless @chunk;
4889 # incomplete last line might be among removed or added lines,
4890 # or both, or among context lines: find which
4891 for (my $i = 1; $i < @chunk; $i++) {
4892 if ($chunk[$i][0] eq 'incomplete') {
4893 $chunk[$i][0] = $chunk[$i-1][0];
4897 # guardian
4898 push @chunk, ["", ""];
4900 foreach my $line_info (@chunk) {
4901 my ($class, $line) = @$line_info;
4903 # print chunk headers
4904 if ($class && $class eq 'chunk_header') {
4905 print $line;
4906 next;
4909 ## print from accumulator when type of class of lines change
4910 # empty contents block on start rem/add block, or end of chunk
4911 if (@ctx && (!$class || $class eq 'rem' || $class eq 'add')) {
4912 print join '',
4913 '<div class="chunk_block ctx">',
4914 '<div class="old">',
4915 @ctx,
4916 '</div>',
4917 '<div class="new">',
4918 @ctx,
4919 '</div>',
4920 '</div>';
4921 @ctx = ();
4923 # empty add/rem block on start context block, or end of chunk
4924 if ((@rem || @add) && (!$class || $class eq 'ctx')) {
4925 if (!@add) {
4926 # pure removal
4927 print join '',
4928 '<div class="chunk_block rem">',
4929 '<div class="old">',
4930 @rem,
4931 '</div>',
4932 '</div>';
4933 } elsif (!@rem) {
4934 # pure addition
4935 print join '',
4936 '<div class="chunk_block add">',
4937 '<div class="new">',
4938 @add,
4939 '</div>',
4940 '</div>';
4941 } else {
4942 # assume that it is change
4943 print join '',
4944 '<div class="chunk_block chg">',
4945 '<div class="old">',
4946 @rem,
4947 '</div>',
4948 '<div class="new">',
4949 @add,
4950 '</div>',
4951 '</div>';
4953 @rem = @add = ();
4956 ## adding lines to accumulator
4957 # guardian value
4958 last unless $line;
4959 # rem, add or change
4960 if ($class eq 'rem') {
4961 push @rem, $line;
4962 } elsif ($class eq 'add') {
4963 push @add, $line;
4965 # context line
4966 if ($class eq 'ctx') {
4967 push @ctx, $line;
4972 sub git_patchset_body {
4973 my ($fd, $diff_style, $difftree, $hash, @hash_parents) = @_;
4974 my ($hash_parent) = $hash_parents[0];
4976 my $is_combined = (@hash_parents > 1);
4977 my $patch_idx = 0;
4978 my $patch_number = 0;
4979 my $patch_line;
4980 my $diffinfo;
4981 my $to_name;
4982 my (%from, %to);
4983 my @chunk; # for side-by-side diff
4985 print "<div class=\"patchset\">\n";
4987 # skip to first patch
4988 while ($patch_line = <$fd>) {
4989 chomp $patch_line;
4991 last if ($patch_line =~ m/^diff /);
4994 PATCH:
4995 while ($patch_line) {
4997 # parse "git diff" header line
4998 if ($patch_line =~ m/^diff --git (\"(?:[^\\\"]*(?:\\.[^\\\"]*)*)\"|[^ "]*) (.*)$/) {
4999 # $1 is from_name, which we do not use
5000 $to_name = unquote($2);
5001 $to_name =~ s!^b/!!;
5002 } elsif ($patch_line =~ m/^diff --(cc|combined) ("?.*"?)$/) {
5003 # $1 is 'cc' or 'combined', which we do not use
5004 $to_name = unquote($2);
5005 } else {
5006 $to_name = undef;
5009 # check if current patch belong to current raw line
5010 # and parse raw git-diff line if needed
5011 if (is_patch_split($diffinfo, { 'to_file' => $to_name })) {
5012 # this is continuation of a split patch
5013 print "<div class=\"patch cont\">\n";
5014 } else {
5015 # advance raw git-diff output if needed
5016 $patch_idx++ if defined $diffinfo;
5018 # read and prepare patch information
5019 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5021 # compact combined diff output can have some patches skipped
5022 # find which patch (using pathname of result) we are at now;
5023 if ($is_combined) {
5024 while ($to_name ne $diffinfo->{'to_file'}) {
5025 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5026 format_diff_cc_simplified($diffinfo, @hash_parents) .
5027 "</div>\n"; # class="patch"
5029 $patch_idx++;
5030 $patch_number++;
5032 last if $patch_idx > $#$difftree;
5033 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5037 # modifies %from, %to hashes
5038 parse_from_to_diffinfo($diffinfo, \%from, \%to, @hash_parents);
5040 # this is first patch for raw difftree line with $patch_idx index
5041 # we index @$difftree array from 0, but number patches from 1
5042 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n";
5045 # git diff header
5046 #assert($patch_line =~ m/^diff /) if DEBUG;
5047 #assert($patch_line !~ m!$/$!) if DEBUG; # is chomp-ed
5048 $patch_number++;
5049 # print "git diff" header
5050 print format_git_diff_header_line($patch_line, $diffinfo,
5051 \%from, \%to);
5053 # print extended diff header
5054 print "<div class=\"diff extended_header\">\n";
5055 EXTENDED_HEADER:
5056 while ($patch_line = <$fd>) {
5057 chomp $patch_line;
5059 last EXTENDED_HEADER if ($patch_line =~ m/^--- |^diff /);
5061 print format_extended_diff_header_line($patch_line, $diffinfo,
5062 \%from, \%to);
5064 print "</div>\n"; # class="diff extended_header"
5066 # from-file/to-file diff header
5067 if (! $patch_line) {
5068 print "</div>\n"; # class="patch"
5069 last PATCH;
5071 next PATCH if ($patch_line =~ m/^diff /);
5072 #assert($patch_line =~ m/^---/) if DEBUG;
5074 my $last_patch_line = $patch_line;
5075 $patch_line = <$fd>;
5076 chomp $patch_line;
5077 #assert($patch_line =~ m/^\+\+\+/) if DEBUG;
5079 print format_diff_from_to_header($last_patch_line, $patch_line,
5080 $diffinfo, \%from, \%to,
5081 @hash_parents);
5083 # the patch itself
5084 LINE:
5085 while ($patch_line = <$fd>) {
5086 chomp $patch_line;
5088 next PATCH if ($patch_line =~ m/^diff /);
5090 my ($class, $line) = process_diff_line($patch_line, \%from, \%to);
5091 my $diff_classes = "diff";
5092 $diff_classes .= " $class" if ($class);
5093 $line = "<div class=\"$diff_classes\">$line</div>\n";
5095 if ($diff_style eq 'sidebyside' && !$is_combined) {
5096 if ($class eq 'chunk_header') {
5097 print_sidebyside_diff_chunk(@chunk);
5098 @chunk = ( [ $class, $line ] );
5099 } else {
5100 push @chunk, [ $class, $line ];
5102 } else {
5103 # default 'inline' style and unknown styles
5104 print $line;
5108 } continue {
5109 if (@chunk) {
5110 print_sidebyside_diff_chunk(@chunk);
5111 @chunk = ();
5113 print "</div>\n"; # class="patch"
5116 # for compact combined (--cc) format, with chunk and patch simplification
5117 # the patchset might be empty, but there might be unprocessed raw lines
5118 for (++$patch_idx if $patch_number > 0;
5119 $patch_idx < @$difftree;
5120 ++$patch_idx) {
5121 # read and prepare patch information
5122 $diffinfo = parsed_difftree_line($difftree->[$patch_idx]);
5124 # generate anchor for "patch" links in difftree / whatchanged part
5125 print "<div class=\"patch\" id=\"patch". ($patch_idx+1) ."\">\n" .
5126 format_diff_cc_simplified($diffinfo, @hash_parents) .
5127 "</div>\n"; # class="patch"
5129 $patch_number++;
5132 if ($patch_number == 0) {
5133 if (@hash_parents > 1) {
5134 print "<div class=\"diff nodifferences\">Trivial merge</div>\n";
5135 } else {
5136 print "<div class=\"diff nodifferences\">No differences found</div>\n";
5140 print "</div>\n"; # class="patchset"
5143 # . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5145 # fills project list info (age, description, owner, category, forks)
5146 # for each project in the list, removing invalid projects from
5147 # returned list
5148 # NOTE: modifies $projlist, but does not remove entries from it
5149 sub fill_project_list_info {
5150 my $projlist = shift;
5151 my @projects;
5153 my $show_ctags = gitweb_check_feature('ctags');
5154 PROJECT:
5155 foreach my $pr (@$projlist) {
5156 my (@activity) = git_get_last_activity($pr->{'path'});
5157 unless (@activity) {
5158 next PROJECT;
5160 ($pr->{'age'}, $pr->{'age_string'}) = @activity;
5161 if (!defined $pr->{'descr'}) {
5162 my $descr = git_get_project_description($pr->{'path'}) || "";
5163 $descr = to_utf8($descr);
5164 $pr->{'descr_long'} = $descr;
5165 $pr->{'descr'} = chop_str($descr, $projects_list_description_width, 5);
5167 if (!defined $pr->{'owner'}) {
5168 $pr->{'owner'} = git_get_project_owner("$pr->{'path'}") || "";
5170 if ($show_ctags) {
5171 $pr->{'ctags'} = git_get_project_ctags($pr->{'path'});
5173 if ($projects_list_group_categories && !defined $pr->{'category'}) {
5174 my $cat = git_get_project_category($pr->{'path'}) ||
5175 $project_list_default_category;
5176 $pr->{'category'} = to_utf8($cat);
5179 push @projects, $pr;
5182 return @projects;
5185 sub sort_projects_list {
5186 my ($projlist, $order) = @_;
5187 my @projects;
5189 my %order_info = (
5190 project => { key => 'path', type => 'str' },
5191 descr => { key => 'descr_long', type => 'str' },
5192 owner => { key => 'owner', type => 'str' },
5193 age => { key => 'age', type => 'num' }
5195 my $oi = $order_info{$order};
5196 return @$projlist unless defined $oi;
5197 if ($oi->{'type'} eq 'str') {
5198 @projects = sort {$a->{$oi->{'key'}} cmp $b->{$oi->{'key'}}} @$projlist;
5199 } else {
5200 @projects = sort {$a->{$oi->{'key'}} <=> $b->{$oi->{'key'}}} @$projlist;
5203 return @projects;
5206 # returns a hash of categories, containing the list of project
5207 # belonging to each category
5208 sub build_projlist_by_category {
5209 my ($projlist, $from, $to) = @_;
5210 my %categories;
5212 $from = 0 unless defined $from;
5213 $to = $#$projlist if (!defined $to || $#$projlist < $to);
5215 for (my $i = $from; $i <= $to; $i++) {
5216 my $pr = $projlist->[$i];
5217 push @{$categories{ $pr->{'category'} }}, $pr;
5220 return wantarray ? %categories : \%categories;
5223 # print 'sort by' <th> element, generating 'sort by $name' replay link
5224 # if that order is not selected
5225 sub print_sort_th {
5226 print format_sort_th(@_);
5229 sub format_sort_th {
5230 my ($name, $order, $header) = @_;
5231 my $sort_th = "";
5232 $header ||= ucfirst($name);
5234 if ($order eq $name) {
5235 $sort_th .= "<th>$header</th>\n";
5236 } else {
5237 $sort_th .= "<th>" .
5238 $cgi->a({-href => href(-replay=>1, order=>$name),
5239 -class => "header"}, $header) .
5240 "</th>\n";
5243 return $sort_th;
5246 sub git_project_list_rows {
5247 my ($projlist, $from, $to, $check_forks) = @_;
5249 $from = 0 unless defined $from;
5250 $to = $#$projlist if (!defined $to || $#$projlist < $to);
5252 my $alternate = 1;
5253 for (my $i = $from; $i <= $to; $i++) {
5254 my $pr = $projlist->[$i];
5256 if ($alternate) {
5257 print "<tr class=\"dark\">\n";
5258 } else {
5259 print "<tr class=\"light\">\n";
5261 $alternate ^= 1;
5263 if ($check_forks) {
5264 print "<td>";
5265 if ($pr->{'forks'}) {
5266 my $nforks = scalar @{$pr->{'forks'}};
5267 if ($nforks > 0) {
5268 print $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks"),
5269 -title => "$nforks forks"}, "+");
5270 } else {
5271 print $cgi->span({-title => "$nforks forks"}, "+");
5274 print "</td>\n";
5276 print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5277 -class => "list"}, esc_html($pr->{'path'})) . "</td>\n" .
5278 "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
5279 -class => "list", -title => $pr->{'descr_long'}},
5280 esc_html($pr->{'descr'})) . "</td>\n" .
5281 "<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n";
5282 print "<td class=\"". age_class($pr->{'age'}) . "\">" .
5283 (defined $pr->{'age_string'} ? $pr->{'age_string'} : "No commits") . "</td>\n" .
5284 "<td class=\"link\">" .
5285 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary")}, "summary") . " | " .
5286 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"shortlog")}, "shortlog") . " | " .
5287 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"log")}, "log") . " | " .
5288 $cgi->a({-href => href(project=>$pr->{'path'}, action=>"tree")}, "tree") .
5289 ($pr->{'forks'} ? " | " . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks")}, "forks") : '') .
5290 "</td>\n" .
5291 "</tr>\n";
5295 sub git_project_list_body {
5296 # actually uses global variable $project
5297 my ($projlist, $order, $from, $to, $extra, $no_header) = @_;
5298 my @projects = @$projlist;
5300 my $check_forks = gitweb_check_feature('forks');
5301 my $show_ctags = gitweb_check_feature('ctags');
5302 my $tagfilter = $show_ctags ? $cgi->param('by_tag') : undef;
5303 $check_forks = undef
5304 if ($tagfilter || $searchtext);
5306 # filtering out forks before filling info allows to do less work
5307 @projects = filter_forks_from_projects_list(\@projects)
5308 if ($check_forks);
5309 @projects = fill_project_list_info(\@projects);
5310 # searching projects require filling to be run before it
5311 @projects = search_projects_list(\@projects,
5312 'searchtext' => $searchtext,
5313 'tagfilter' => $tagfilter)
5314 if ($tagfilter || $searchtext);
5316 $order ||= $default_projects_order;
5317 $from = 0 unless defined $from;
5318 $to = $#projects if (!defined $to || $#projects < $to);
5320 # short circuit
5321 if ($from > $to) {
5322 print "<center>\n".
5323 "<b>No such projects found</b><br />\n".
5324 "Click ".$cgi->a({-href=>href(project=>undef)},"here")." to view all projects<br />\n".
5325 "</center>\n<br />\n";
5326 return;
5329 @projects = sort_projects_list(\@projects, $order);
5331 if ($show_ctags) {
5332 my $ctags = git_gather_all_ctags(\@projects);
5333 my $cloud = git_populate_project_tagcloud($ctags);
5334 print git_show_project_tagcloud($cloud, 64);
5337 print "<table class=\"project_list\">\n";
5338 unless ($no_header) {
5339 print "<tr>\n";
5340 if ($check_forks) {
5341 print "<th></th>\n";
5343 print_sort_th('project', $order, 'Project');
5344 print_sort_th('descr', $order, 'Description');
5345 print_sort_th('owner', $order, 'Owner');
5346 print_sort_th('age', $order, 'Last Change');
5347 print "<th></th>\n" . # for links
5348 "</tr>\n";
5351 if ($projects_list_group_categories) {
5352 # only display categories with projects in the $from-$to window
5353 @projects = sort {$a->{'category'} cmp $b->{'category'}} @projects[$from..$to];
5354 my %categories = build_projlist_by_category(\@projects, $from, $to);
5355 foreach my $cat (sort keys %categories) {
5356 unless ($cat eq "") {
5357 print "<tr>\n";
5358 if ($check_forks) {
5359 print "<td></td>\n";
5361 print "<td class=\"category\" colspan=\"5\">".esc_html($cat)."</td>\n";
5362 print "</tr>\n";
5365 git_project_list_rows($categories{$cat}, undef, undef, $check_forks);
5367 } else {
5368 git_project_list_rows(\@projects, $from, $to, $check_forks);
5371 if (defined $extra) {
5372 print "<tr>\n";
5373 if ($check_forks) {
5374 print "<td></td>\n";
5376 print "<td colspan=\"5\">$extra</td>\n" .
5377 "</tr>\n";
5379 print "</table>\n";
5382 sub git_log_body {
5383 # uses global variable $project
5384 my ($commitlist, $from, $to, $refs, $extra) = @_;
5386 $from = 0 unless defined $from;
5387 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5389 for (my $i = 0; $i <= $to; $i++) {
5390 my %co = %{$commitlist->[$i]};
5391 next if !%co;
5392 my $commit = $co{'id'};
5393 my $ref = format_ref_marker($refs, $commit);
5394 git_print_header_div('commit',
5395 "<span class=\"age\">$co{'age_string'}</span>" .
5396 esc_html($co{'title'}) . $ref,
5397 $commit);
5398 print "<div class=\"title_text\">\n" .
5399 "<div class=\"log_link\">\n" .
5400 $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") .
5401 " | " .
5402 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") .
5403 " | " .
5404 $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree") .
5405 "<br/>\n" .
5406 "</div>\n";
5407 git_print_authorship(\%co, -tag => 'span');
5408 print "<br/>\n</div>\n";
5410 print "<div class=\"log_body\">\n";
5411 git_print_log($co{'comment'}, -final_empty_line=> 1);
5412 print "</div>\n";
5414 if ($extra) {
5415 print "<div class=\"page_nav\">\n";
5416 print "$extra\n";
5417 print "</div>\n";
5421 sub git_shortlog_body {
5422 # uses global variable $project
5423 my ($commitlist, $from, $to, $refs, $extra) = @_;
5425 $from = 0 unless defined $from;
5426 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5428 print "<table class=\"shortlog\">\n";
5429 my $alternate = 1;
5430 for (my $i = $from; $i <= $to; $i++) {
5431 my %co = %{$commitlist->[$i]};
5432 my $commit = $co{'id'};
5433 my $ref = format_ref_marker($refs, $commit);
5434 if ($alternate) {
5435 print "<tr class=\"dark\">\n";
5436 } else {
5437 print "<tr class=\"light\">\n";
5439 $alternate ^= 1;
5440 # git_summary() used print "<td><i>$co{'age_string'}</i></td>\n" .
5441 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5442 format_author_html('td', \%co, 10) . "<td>";
5443 print format_subject_html($co{'title'}, $co{'title_short'},
5444 href(action=>"commit", hash=>$commit), $ref);
5445 print "</td>\n" .
5446 "<td class=\"link\">" .
5447 $cgi->a({-href => href(action=>"commit", hash=>$commit)}, "commit") . " | " .
5448 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff") . " | " .
5449 $cgi->a({-href => href(action=>"tree", hash=>$commit, hash_base=>$commit)}, "tree");
5450 my $snapshot_links = format_snapshot_links($commit);
5451 if (defined $snapshot_links) {
5452 print " | " . $snapshot_links;
5454 print "</td>\n" .
5455 "</tr>\n";
5457 if (defined $extra) {
5458 print "<tr>\n" .
5459 "<td colspan=\"4\">$extra</td>\n" .
5460 "</tr>\n";
5462 print "</table>\n";
5465 sub git_history_body {
5466 # Warning: assumes constant type (blob or tree) during history
5467 my ($commitlist, $from, $to, $refs, $extra,
5468 $file_name, $file_hash, $ftype) = @_;
5470 $from = 0 unless defined $from;
5471 $to = $#{$commitlist} unless (defined $to && $to <= $#{$commitlist});
5473 print "<table class=\"history\">\n";
5474 my $alternate = 1;
5475 for (my $i = $from; $i <= $to; $i++) {
5476 my %co = %{$commitlist->[$i]};
5477 if (!%co) {
5478 next;
5480 my $commit = $co{'id'};
5482 my $ref = format_ref_marker($refs, $commit);
5484 if ($alternate) {
5485 print "<tr class=\"dark\">\n";
5486 } else {
5487 print "<tr class=\"light\">\n";
5489 $alternate ^= 1;
5490 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5491 # shortlog: format_author_html('td', \%co, 10)
5492 format_author_html('td', \%co, 15, 3) . "<td>";
5493 # originally git_history used chop_str($co{'title'}, 50)
5494 print format_subject_html($co{'title'}, $co{'title_short'},
5495 href(action=>"commit", hash=>$commit), $ref);
5496 print "</td>\n" .
5497 "<td class=\"link\">" .
5498 $cgi->a({-href => href(action=>$ftype, hash_base=>$commit, file_name=>$file_name)}, $ftype) . " | " .
5499 $cgi->a({-href => href(action=>"commitdiff", hash=>$commit)}, "commitdiff");
5501 if ($ftype eq 'blob') {
5502 my $blob_current = $file_hash;
5503 my $blob_parent = git_get_hash_by_path($commit, $file_name);
5504 if (defined $blob_current && defined $blob_parent &&
5505 $blob_current ne $blob_parent) {
5506 print " | " .
5507 $cgi->a({-href => href(action=>"blobdiff",
5508 hash=>$blob_current, hash_parent=>$blob_parent,
5509 hash_base=>$hash_base, hash_parent_base=>$commit,
5510 file_name=>$file_name)},
5511 "diff to current");
5514 print "</td>\n" .
5515 "</tr>\n";
5517 if (defined $extra) {
5518 print "<tr>\n" .
5519 "<td colspan=\"4\">$extra</td>\n" .
5520 "</tr>\n";
5522 print "</table>\n";
5525 sub git_tags_body {
5526 # uses global variable $project
5527 my ($taglist, $from, $to, $extra) = @_;
5528 $from = 0 unless defined $from;
5529 $to = $#{$taglist} if (!defined $to || $#{$taglist} < $to);
5531 print "<table class=\"tags\">\n";
5532 my $alternate = 1;
5533 for (my $i = $from; $i <= $to; $i++) {
5534 my $entry = $taglist->[$i];
5535 my %tag = %$entry;
5536 my $comment = $tag{'subject'};
5537 my $comment_short;
5538 if (defined $comment) {
5539 $comment_short = chop_str($comment, 30, 5);
5541 if ($alternate) {
5542 print "<tr class=\"dark\">\n";
5543 } else {
5544 print "<tr class=\"light\">\n";
5546 $alternate ^= 1;
5547 if (defined $tag{'age'}) {
5548 print "<td><i>$tag{'age'}</i></td>\n";
5549 } else {
5550 print "<td></td>\n";
5552 print "<td>" .
5553 $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'}),
5554 -class => "list name"}, esc_html($tag{'name'})) .
5555 "</td>\n" .
5556 "<td>";
5557 if (defined $comment) {
5558 print format_subject_html($comment, $comment_short,
5559 href(action=>"tag", hash=>$tag{'id'}));
5561 print "</td>\n" .
5562 "<td class=\"selflink\">";
5563 if ($tag{'type'} eq "tag") {
5564 print $cgi->a({-href => href(action=>"tag", hash=>$tag{'id'})}, "tag");
5565 } else {
5566 print "&nbsp;";
5568 print "</td>\n" .
5569 "<td class=\"link\">" . " | " .
5570 $cgi->a({-href => href(action=>$tag{'reftype'}, hash=>$tag{'refid'})}, $tag{'reftype'});
5571 if ($tag{'reftype'} eq "commit") {
5572 print " | " . $cgi->a({-href => href(action=>"shortlog", hash=>$tag{'fullname'})}, "shortlog") .
5573 " | " . $cgi->a({-href => href(action=>"log", hash=>$tag{'fullname'})}, "log");
5574 } elsif ($tag{'reftype'} eq "blob") {
5575 print " | " . $cgi->a({-href => href(action=>"blob_plain", hash=>$tag{'refid'})}, "raw");
5577 print "</td>\n" .
5578 "</tr>";
5580 if (defined $extra) {
5581 print "<tr>\n" .
5582 "<td colspan=\"5\">$extra</td>\n" .
5583 "</tr>\n";
5585 print "</table>\n";
5588 sub git_heads_body {
5589 # uses global variable $project
5590 my ($headlist, $head, $from, $to, $extra) = @_;
5591 $from = 0 unless defined $from;
5592 $to = $#{$headlist} if (!defined $to || $#{$headlist} < $to);
5594 print "<table class=\"heads\">\n";
5595 my $alternate = 1;
5596 for (my $i = $from; $i <= $to; $i++) {
5597 my $entry = $headlist->[$i];
5598 my %ref = %$entry;
5599 my $curr = $ref{'id'} eq $head;
5600 if ($alternate) {
5601 print "<tr class=\"dark\">\n";
5602 } else {
5603 print "<tr class=\"light\">\n";
5605 $alternate ^= 1;
5606 print "<td><i>$ref{'age'}</i></td>\n" .
5607 ($curr ? "<td class=\"current_head\">" : "<td>") .
5608 $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'}),
5609 -class => "list name"},esc_html($ref{'name'})) .
5610 "</td>\n" .
5611 "<td class=\"link\">" .
5612 $cgi->a({-href => href(action=>"shortlog", hash=>$ref{'fullname'})}, "shortlog") . " | " .
5613 $cgi->a({-href => href(action=>"log", hash=>$ref{'fullname'})}, "log") . " | " .
5614 $cgi->a({-href => href(action=>"tree", hash=>$ref{'fullname'}, hash_base=>$ref{'fullname'})}, "tree") .
5615 "</td>\n" .
5616 "</tr>";
5618 if (defined $extra) {
5619 print "<tr>\n" .
5620 "<td colspan=\"3\">$extra</td>\n" .
5621 "</tr>\n";
5623 print "</table>\n";
5626 # Display a single remote block
5627 sub git_remote_block {
5628 my ($remote, $rdata, $limit, $head) = @_;
5630 my $heads = $rdata->{'heads'};
5631 my $fetch = $rdata->{'fetch'};
5632 my $push = $rdata->{'push'};
5634 my $urls_table = "<table class=\"projects_list\">\n" ;
5636 if (defined $fetch) {
5637 if ($fetch eq $push) {
5638 $urls_table .= format_repo_url("URL", $fetch);
5639 } else {
5640 $urls_table .= format_repo_url("Fetch URL", $fetch);
5641 $urls_table .= format_repo_url("Push URL", $push) if defined $push;
5643 } elsif (defined $push) {
5644 $urls_table .= format_repo_url("Push URL", $push);
5645 } else {
5646 $urls_table .= format_repo_url("", "No remote URL");
5649 $urls_table .= "</table>\n";
5651 my $dots;
5652 if (defined $limit && $limit < @$heads) {
5653 $dots = $cgi->a({-href => href(action=>"remotes", hash=>$remote)}, "...");
5656 print $urls_table;
5657 git_heads_body($heads, $head, 0, $limit, $dots);
5660 # Display a list of remote names with the respective fetch and push URLs
5661 sub git_remotes_list {
5662 my ($remotedata, $limit) = @_;
5663 print "<table class=\"heads\">\n";
5664 my $alternate = 1;
5665 my @remotes = sort keys %$remotedata;
5667 my $limited = $limit && $limit < @remotes;
5669 $#remotes = $limit - 1 if $limited;
5671 while (my $remote = shift @remotes) {
5672 my $rdata = $remotedata->{$remote};
5673 my $fetch = $rdata->{'fetch'};
5674 my $push = $rdata->{'push'};
5675 if ($alternate) {
5676 print "<tr class=\"dark\">\n";
5677 } else {
5678 print "<tr class=\"light\">\n";
5680 $alternate ^= 1;
5681 print "<td>" .
5682 $cgi->a({-href=> href(action=>'remotes', hash=>$remote),
5683 -class=> "list name"},esc_html($remote)) .
5684 "</td>";
5685 print "<td class=\"link\">" .
5686 (defined $fetch ? $cgi->a({-href=> $fetch}, "fetch") : "fetch") .
5687 " | " .
5688 (defined $push ? $cgi->a({-href=> $push}, "push") : "push") .
5689 "</td>";
5691 print "</tr>\n";
5694 if ($limited) {
5695 print "<tr>\n" .
5696 "<td colspan=\"3\">" .
5697 $cgi->a({-href => href(action=>"remotes")}, "...") .
5698 "</td>\n" . "</tr>\n";
5701 print "</table>";
5704 # Display remote heads grouped by remote, unless there are too many
5705 # remotes, in which case we only display the remote names
5706 sub git_remotes_body {
5707 my ($remotedata, $limit, $head) = @_;
5708 if ($limit and $limit < keys %$remotedata) {
5709 git_remotes_list($remotedata, $limit);
5710 } else {
5711 fill_remote_heads($remotedata);
5712 while (my ($remote, $rdata) = each %$remotedata) {
5713 git_print_section({-class=>"remote", -id=>$remote},
5714 ["remotes", $remote, $remote], sub {
5715 git_remote_block($remote, $rdata, $limit, $head);
5721 sub git_search_message {
5722 my %co = @_;
5724 my $greptype;
5725 if ($searchtype eq 'commit') {
5726 $greptype = "--grep=";
5727 } elsif ($searchtype eq 'author') {
5728 $greptype = "--author=";
5729 } elsif ($searchtype eq 'committer') {
5730 $greptype = "--committer=";
5732 $greptype .= $searchtext;
5733 my @commitlist = parse_commits($hash, 101, (100 * $page), undef,
5734 $greptype, '--regexp-ignore-case',
5735 $search_use_regexp ? '--extended-regexp' : '--fixed-strings');
5737 my $paging_nav = '';
5738 if ($page > 0) {
5739 $paging_nav .=
5740 $cgi->a({-href => href(-replay=>1, page=>undef)},
5741 "first") .
5742 " &sdot; " .
5743 $cgi->a({-href => href(-replay=>1, page=>$page-1),
5744 -accesskey => "p", -title => "Alt-p"}, "prev");
5745 } else {
5746 $paging_nav .= "first &sdot; prev";
5748 my $next_link = '';
5749 if ($#commitlist >= 100) {
5750 $next_link =
5751 $cgi->a({-href => href(-replay=>1, page=>$page+1),
5752 -accesskey => "n", -title => "Alt-n"}, "next");
5753 $paging_nav .= " &sdot; $next_link";
5754 } else {
5755 $paging_nav .= " &sdot; next";
5758 git_header_html();
5760 git_print_page_nav('','', $hash,$co{'tree'},$hash, $paging_nav);
5761 git_print_header_div('commit', esc_html($co{'title'}), $hash);
5762 if ($page == 0 && !@commitlist) {
5763 print "<p>No match.</p>\n";
5764 } else {
5765 git_search_grep_body(\@commitlist, 0, 99, $next_link);
5768 git_footer_html();
5771 sub git_search_changes {
5772 my %co = @_;
5774 local $/ = "\n";
5775 open my $fd, '-|', git_cmd(), '--no-pager', 'log', @diff_opts,
5776 '--pretty=format:%H', '--no-abbrev', '--raw', "-S$searchtext",
5777 ($search_use_regexp ? '--pickaxe-regex' : ())
5778 or die_error(500, "Open git-log failed");
5780 git_header_html();
5782 git_print_page_nav('','', $hash,$co{'tree'},$hash);
5783 git_print_header_div('commit', esc_html($co{'title'}), $hash);
5785 print "<table class=\"pickaxe search\">\n";
5786 my $alternate = 1;
5787 undef %co;
5788 my @files;
5789 while (my $line = <$fd>) {
5790 chomp $line;
5791 next unless $line;
5793 my %set = parse_difftree_raw_line($line);
5794 if (defined $set{'commit'}) {
5795 # finish previous commit
5796 if (%co) {
5797 print "</td>\n" .
5798 "<td class=\"link\">" .
5799 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
5800 "commit") .
5801 " | " .
5802 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
5803 hash_base=>$co{'id'})},
5804 "tree") .
5805 "</td>\n" .
5806 "</tr>\n";
5809 if ($alternate) {
5810 print "<tr class=\"dark\">\n";
5811 } else {
5812 print "<tr class=\"light\">\n";
5814 $alternate ^= 1;
5815 %co = parse_commit($set{'commit'});
5816 my $author = chop_and_escape_str($co{'author_name'}, 15, 5);
5817 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5818 "<td><i>$author</i></td>\n" .
5819 "<td>" .
5820 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
5821 -class => "list subject"},
5822 chop_and_escape_str($co{'title'}, 50) . "<br/>");
5823 } elsif (defined $set{'to_id'}) {
5824 next if ($set{'to_id'} =~ m/^0{40}$/);
5826 print $cgi->a({-href => href(action=>"blob", hash_base=>$co{'id'},
5827 hash=>$set{'to_id'}, file_name=>$set{'to_file'}),
5828 -class => "list"},
5829 "<span class=\"match\">" . esc_path($set{'file'}) . "</span>") .
5830 "<br/>\n";
5833 close $fd;
5835 # finish last commit (warning: repetition!)
5836 if (%co) {
5837 print "</td>\n" .
5838 "<td class=\"link\">" .
5839 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})},
5840 "commit") .
5841 " | " .
5842 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'},
5843 hash_base=>$co{'id'})},
5844 "tree") .
5845 "</td>\n" .
5846 "</tr>\n";
5849 print "</table>\n";
5851 git_footer_html();
5854 sub git_search_files {
5855 my %co = @_;
5857 local $/ = "\n";
5858 open my $fd, "-|", git_cmd(), 'grep', '-n',
5859 $search_use_regexp ? ('-E', '-i') : '-F',
5860 $searchtext, $co{'tree'}
5861 or die_error(500, "Open git-grep failed");
5863 git_header_html();
5865 git_print_page_nav('','', $hash,$co{'tree'},$hash);
5866 git_print_header_div('commit', esc_html($co{'title'}), $hash);
5868 print "<table class=\"grep_search\">\n";
5869 my $alternate = 1;
5870 my $matches = 0;
5871 my $lastfile = '';
5872 while (my $line = <$fd>) {
5873 chomp $line;
5874 my ($file, $lno, $ltext, $binary);
5875 last if ($matches++ > 1000);
5876 if ($line =~ /^Binary file (.+) matches$/) {
5877 $file = $1;
5878 $binary = 1;
5879 } else {
5880 (undef, $file, $lno, $ltext) = split(/:/, $line, 4);
5882 if ($file ne $lastfile) {
5883 $lastfile and print "</td></tr>\n";
5884 if ($alternate++) {
5885 print "<tr class=\"dark\">\n";
5886 } else {
5887 print "<tr class=\"light\">\n";
5889 print "<td class=\"list\">".
5890 $cgi->a({-href => href(action=>"blob", hash=>$co{'hash'},
5891 file_name=>"$file"),
5892 -class => "list"}, esc_path($file));
5893 print "</td><td>\n";
5894 $lastfile = $file;
5896 if ($binary) {
5897 print "<div class=\"binary\">Binary file</div>\n";
5898 } else {
5899 $ltext = untabify($ltext);
5900 if ($ltext =~ m/^(.*)($search_regexp)(.*)$/i) {
5901 $ltext = esc_html($1, -nbsp=>1);
5902 $ltext .= '<span class="match">';
5903 $ltext .= esc_html($2, -nbsp=>1);
5904 $ltext .= '</span>';
5905 $ltext .= esc_html($3, -nbsp=>1);
5906 } else {
5907 $ltext = esc_html($ltext, -nbsp=>1);
5909 print "<div class=\"pre\">" .
5910 $cgi->a({-href => href(action=>"blob", hash=>$co{'hash'},
5911 file_name=>"$file").'#l'.$lno,
5912 -class => "linenr"}, sprintf('%4i', $lno))
5913 . ' ' . $ltext . "</div>\n";
5916 if ($lastfile) {
5917 print "</td></tr>\n";
5918 if ($matches > 1000) {
5919 print "<div class=\"diff nodifferences\">Too many matches, listing trimmed</div>\n";
5921 } else {
5922 print "<div class=\"diff nodifferences\">No matches found</div>\n";
5924 close $fd;
5926 print "</table>\n";
5928 git_footer_html();
5931 sub git_search_grep_body {
5932 my ($commitlist, $from, $to, $extra) = @_;
5933 $from = 0 unless defined $from;
5934 $to = $#{$commitlist} if (!defined $to || $#{$commitlist} < $to);
5936 print "<table class=\"commit_search\">\n";
5937 my $alternate = 1;
5938 for (my $i = $from; $i <= $to; $i++) {
5939 my %co = %{$commitlist->[$i]};
5940 if (!%co) {
5941 next;
5943 my $commit = $co{'id'};
5944 if ($alternate) {
5945 print "<tr class=\"dark\">\n";
5946 } else {
5947 print "<tr class=\"light\">\n";
5949 $alternate ^= 1;
5950 print "<td title=\"$co{'age_string_age'}\"><i>$co{'age_string_date'}</i></td>\n" .
5951 format_author_html('td', \%co, 15, 5) .
5952 "<td>" .
5953 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'}),
5954 -class => "list subject"},
5955 chop_and_escape_str($co{'title'}, 50) . "<br/>");
5956 my $comment = $co{'comment'};
5957 foreach my $line (@$comment) {
5958 if ($line =~ m/^(.*?)($search_regexp)(.*)$/i) {
5959 my ($lead, $match, $trail) = ($1, $2, $3);
5960 $match = chop_str($match, 70, 5, 'center');
5961 my $contextlen = int((80 - length($match))/2);
5962 $contextlen = 30 if ($contextlen > 30);
5963 $lead = chop_str($lead, $contextlen, 10, 'left');
5964 $trail = chop_str($trail, $contextlen, 10, 'right');
5966 $lead = esc_html($lead);
5967 $match = esc_html($match);
5968 $trail = esc_html($trail);
5970 print "$lead<span class=\"match\">$match</span>$trail<br />";
5973 print "</td>\n" .
5974 "<td class=\"link\">" .
5975 $cgi->a({-href => href(action=>"commit", hash=>$co{'id'})}, "commit") .
5976 " | " .
5977 $cgi->a({-href => href(action=>"commitdiff", hash=>$co{'id'})}, "commitdiff") .
5978 " | " .
5979 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$co{'id'})}, "tree");
5980 print "</td>\n" .
5981 "</tr>\n";
5983 if (defined $extra) {
5984 print "<tr>\n" .
5985 "<td colspan=\"3\">$extra</td>\n" .
5986 "</tr>\n";
5988 print "</table>\n";
5991 ## ======================================================================
5992 ## ======================================================================
5993 ## actions
5995 sub git_project_list {
5996 my $order = $input_params{'order'};
5997 if (defined $order && $order !~ m/none|project|descr|owner|age/) {
5998 die_error(400, "Unknown order parameter");
6001 my @list = git_get_projects_list();
6002 if (!@list) {
6003 die_error(404, "No projects found");
6006 git_header_html();
6007 if (defined $home_text && -f $home_text) {
6008 print "<div class=\"index_include\">\n";
6009 insert_file($home_text);
6010 print "</div>\n";
6012 print $cgi->startform(-method => "get") .
6013 "<p class=\"projsearch\">Search:\n" .
6014 $cgi->textfield(-name => "s", -value => $searchtext) . "\n" .
6015 "</p>" .
6016 $cgi->end_form() . "\n";
6017 git_project_list_body(\@list, $order);
6018 git_footer_html();
6021 sub git_forks {
6022 my $order = $input_params{'order'};
6023 if (defined $order && $order !~ m/none|project|descr|owner|age/) {
6024 die_error(400, "Unknown order parameter");
6027 my @list = git_get_projects_list($project);
6028 if (!@list) {
6029 die_error(404, "No forks found");
6032 git_header_html();
6033 git_print_page_nav('','');
6034 git_print_header_div('summary', "$project forks");
6035 git_project_list_body(\@list, $order);
6036 git_footer_html();
6039 sub git_project_index {
6040 my @projects = git_get_projects_list();
6041 if (!@projects) {
6042 die_error(404, "No projects found");
6045 print $cgi->header(
6046 -type => 'text/plain',
6047 -charset => 'utf-8',
6048 -content_disposition => 'inline; filename="index.aux"');
6050 foreach my $pr (@projects) {
6051 if (!exists $pr->{'owner'}) {
6052 $pr->{'owner'} = git_get_project_owner("$pr->{'path'}");
6055 my ($path, $owner) = ($pr->{'path'}, $pr->{'owner'});
6056 # quote as in CGI::Util::encode, but keep the slash, and use '+' for ' '
6057 $path =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6058 $owner =~ s/([^a-zA-Z0-9_.\-\/ ])/sprintf("%%%02X", ord($1))/eg;
6059 $path =~ s/ /\+/g;
6060 $owner =~ s/ /\+/g;
6062 print "$path $owner\n";
6066 sub git_summary {
6067 my $descr = git_get_project_description($project) || "none";
6068 my %co = parse_commit("HEAD");
6069 my %cd = %co ? parse_date($co{'committer_epoch'}, $co{'committer_tz'}) : ();
6070 my $head = $co{'id'};
6071 my $remote_heads = gitweb_check_feature('remote_heads');
6073 my $owner = git_get_project_owner($project);
6075 my $refs = git_get_references();
6076 # These get_*_list functions return one more to allow us to see if
6077 # there are more ...
6078 my @taglist = git_get_tags_list(16);
6079 my @headlist = git_get_heads_list(16);
6080 my %remotedata = $remote_heads ? git_get_remotes_list() : ();
6081 my @forklist;
6082 my $check_forks = gitweb_check_feature('forks');
6084 if ($check_forks) {
6085 # find forks of a project
6086 @forklist = git_get_projects_list($project);
6087 # filter out forks of forks
6088 @forklist = filter_forks_from_projects_list(\@forklist)
6089 if (@forklist);
6092 git_header_html();
6093 git_print_page_nav('summary','', $head);
6095 print "<div class=\"title\">&nbsp;</div>\n";
6096 print "<table class=\"projects_list\">\n" .
6097 "<tr id=\"metadata_desc\"><td>description</td><td>" . esc_html($descr) . "</td></tr>\n" .
6098 "<tr id=\"metadata_owner\"><td>owner</td><td>" . esc_html($owner) . "</td></tr>\n";
6099 if (defined $cd{'rfc2822'}) {
6100 print "<tr id=\"metadata_lchange\"><td>last change</td>" .
6101 "<td>".format_timestamp_html(\%cd)."</td></tr>\n";
6104 # use per project git URL list in $projectroot/$project/cloneurl
6105 # or make project git URL from git base URL and project name
6106 my $url_tag = "URL";
6107 my @url_list = git_get_project_url_list($project);
6108 @url_list = map { "$_/$project" } @git_base_url_list unless @url_list;
6109 foreach my $git_url (@url_list) {
6110 next unless $git_url;
6111 print format_repo_url($url_tag, $git_url);
6112 $url_tag = "";
6115 # Tag cloud
6116 my $show_ctags = gitweb_check_feature('ctags');
6117 if ($show_ctags) {
6118 my $ctags = git_get_project_ctags($project);
6119 if (%$ctags) {
6120 # without ability to add tags, don't show if there are none
6121 my $cloud = git_populate_project_tagcloud($ctags);
6122 print "<tr id=\"metadata_ctags\">" .
6123 "<td>content tags</td>" .
6124 "<td>".git_show_project_tagcloud($cloud, 48)."</td>" .
6125 "</tr>\n";
6129 print "</table>\n";
6131 # If XSS prevention is on, we don't include README.html.
6132 # TODO: Allow a readme in some safe format.
6133 if (!$prevent_xss && -s "$projectroot/$project/README.html") {
6134 print "<div class=\"title\">readme</div>\n" .
6135 "<div class=\"readme\">\n";
6136 insert_file("$projectroot/$project/README.html");
6137 print "\n</div>\n"; # class="readme"
6140 # we need to request one more than 16 (0..15) to check if
6141 # those 16 are all
6142 my @commitlist = $head ? parse_commits($head, 17) : ();
6143 if (@commitlist) {
6144 git_print_header_div('shortlog');
6145 git_shortlog_body(\@commitlist, 0, 15, $refs,
6146 $#commitlist <= 15 ? undef :
6147 $cgi->a({-href => href(action=>"shortlog")}, "..."));
6150 if (@taglist) {
6151 git_print_header_div('tags');
6152 git_tags_body(\@taglist, 0, 15,
6153 $#taglist <= 15 ? undef :
6154 $cgi->a({-href => href(action=>"tags")}, "..."));
6157 if (@headlist) {
6158 git_print_header_div('heads');
6159 git_heads_body(\@headlist, $head, 0, 15,
6160 $#headlist <= 15 ? undef :
6161 $cgi->a({-href => href(action=>"heads")}, "..."));
6164 if (%remotedata) {
6165 git_print_header_div('remotes');
6166 git_remotes_body(\%remotedata, 15, $head);
6169 if (@forklist) {
6170 git_print_header_div('forks');
6171 git_project_list_body(\@forklist, 'age', 0, 15,
6172 $#forklist <= 15 ? undef :
6173 $cgi->a({-href => href(action=>"forks")}, "..."),
6174 'no_header');
6177 git_footer_html();
6180 sub git_tag {
6181 my %tag = parse_tag($hash);
6183 if (! %tag) {
6184 die_error(404, "Unknown tag object");
6187 my $head = git_get_head_hash($project);
6188 git_header_html();
6189 git_print_page_nav('','', $head,undef,$head);
6190 git_print_header_div('commit', esc_html($tag{'name'}), $hash);
6191 print "<div class=\"title_text\">\n" .
6192 "<table class=\"object_header\">\n" .
6193 "<tr>\n" .
6194 "<td>object</td>\n" .
6195 "<td>" . $cgi->a({-class => "list", -href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6196 $tag{'object'}) . "</td>\n" .
6197 "<td class=\"link\">" . $cgi->a({-href => href(action=>$tag{'type'}, hash=>$tag{'object'})},
6198 $tag{'type'}) . "</td>\n" .
6199 "</tr>\n";
6200 if (defined($tag{'author'})) {
6201 git_print_authorship_rows(\%tag, 'author');
6203 print "</table>\n\n" .
6204 "</div>\n";
6205 print "<div class=\"page_body\">";
6206 my $comment = $tag{'comment'};
6207 foreach my $line (@$comment) {
6208 chomp $line;
6209 print esc_html($line, -nbsp=>1) . "<br/>\n";
6211 print "</div>\n";
6212 git_footer_html();
6215 sub git_blame_common {
6216 my $format = shift || 'porcelain';
6217 if ($format eq 'porcelain' && $cgi->param('js')) {
6218 $format = 'incremental';
6219 $action = 'blame_incremental'; # for page title etc
6222 # permissions
6223 gitweb_check_feature('blame')
6224 or die_error(403, "Blame view not allowed");
6226 # error checking
6227 die_error(400, "No file name given") unless $file_name;
6228 $hash_base ||= git_get_head_hash($project);
6229 die_error(404, "Couldn't find base commit") unless $hash_base;
6230 my %co = parse_commit($hash_base)
6231 or die_error(404, "Commit not found");
6232 my $ftype = "blob";
6233 if (!defined $hash) {
6234 $hash = git_get_hash_by_path($hash_base, $file_name, "blob")
6235 or die_error(404, "Error looking up file");
6236 } else {
6237 $ftype = git_get_type($hash);
6238 if ($ftype !~ "blob") {
6239 die_error(400, "Object is not a blob");
6243 my $fd;
6244 if ($format eq 'incremental') {
6245 # get file contents (as base)
6246 open $fd, "-|", git_cmd(), 'cat-file', 'blob', $hash
6247 or die_error(500, "Open git-cat-file failed");
6248 } elsif ($format eq 'data') {
6249 # run git-blame --incremental
6250 open $fd, "-|", git_cmd(), "blame", "--incremental",
6251 $hash_base, "--", $file_name
6252 or die_error(500, "Open git-blame --incremental failed");
6253 } else {
6254 # run git-blame --porcelain
6255 open $fd, "-|", git_cmd(), "blame", '-p',
6256 $hash_base, '--', $file_name
6257 or die_error(500, "Open git-blame --porcelain failed");
6260 # incremental blame data returns early
6261 if ($format eq 'data') {
6262 print $cgi->header(
6263 -type=>"text/plain", -charset => "utf-8",
6264 -status=> "200 OK");
6265 local $| = 1; # output autoflush
6266 while (my $line = <$fd>) {
6267 print to_utf8($line);
6269 close $fd
6270 or print "ERROR $!\n";
6272 print 'END';
6273 if (defined $t0 && gitweb_check_feature('timed')) {
6274 print ' '.
6275 tv_interval($t0, [ gettimeofday() ]).
6276 ' '.$number_of_git_cmds;
6278 print "\n";
6280 return;
6283 # page header
6284 git_header_html();
6285 my $formats_nav =
6286 $cgi->a({-href => href(action=>"blob", -replay=>1)},
6287 "blob") .
6288 " | ";
6289 if ($format eq 'incremental') {
6290 $formats_nav .=
6291 $cgi->a({-href => href(action=>"blame", javascript=>0, -replay=>1)},
6292 "blame") . " (non-incremental)";
6293 } else {
6294 $formats_nav .=
6295 $cgi->a({-href => href(action=>"blame_incremental", -replay=>1)},
6296 "blame") . " (incremental)";
6298 $formats_nav .=
6299 " | " .
6300 $cgi->a({-href => href(action=>"history", -replay=>1)},
6301 "history") .
6302 " | " .
6303 $cgi->a({-href => href(action=>$action, file_name=>$file_name)},
6304 "HEAD");
6305 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
6306 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
6307 git_print_page_path($file_name, $ftype, $hash_base);
6309 # page body
6310 if ($format eq 'incremental') {
6311 print "<noscript>\n<div class=\"error\"><center><b>\n".
6312 "This page requires JavaScript to run.\n Use ".
6313 $cgi->a({-href => href(action=>'blame',javascript=>0,-replay=>1)},
6314 'this page').
6315 " instead.\n".
6316 "</b></center></div>\n</noscript>\n";
6318 print qq!<div id="progress_bar" style="width: 100%; background-color: yellow"></div>\n!;
6321 print qq!<div class="page_body">\n!;
6322 print qq!<div id="progress_info">... / ...</div>\n!
6323 if ($format eq 'incremental');
6324 print qq!<table id="blame_table" class="blame" width="100%">\n!.
6325 #qq!<col width="5.5em" /><col width="2.5em" /><col width="*" />\n!.
6326 qq!<thead>\n!.
6327 qq!<tr><th>Commit</th><th>Line</th><th>Data</th></tr>\n!.
6328 qq!</thead>\n!.
6329 qq!<tbody>\n!;
6331 my @rev_color = qw(light dark);
6332 my $num_colors = scalar(@rev_color);
6333 my $current_color = 0;
6335 if ($format eq 'incremental') {
6336 my $color_class = $rev_color[$current_color];
6338 #contents of a file
6339 my $linenr = 0;
6340 LINE:
6341 while (my $line = <$fd>) {
6342 chomp $line;
6343 $linenr++;
6345 print qq!<tr id="l$linenr" class="$color_class">!.
6346 qq!<td class="sha1"><a href=""> </a></td>!.
6347 qq!<td class="linenr">!.
6348 qq!<a class="linenr" href="">$linenr</a></td>!;
6349 print qq!<td class="pre">! . esc_html($line) . "</td>\n";
6350 print qq!</tr>\n!;
6353 } else { # porcelain, i.e. ordinary blame
6354 my %metainfo = (); # saves information about commits
6356 # blame data
6357 LINE:
6358 while (my $line = <$fd>) {
6359 chomp $line;
6360 # the header: <SHA-1> <src lineno> <dst lineno> [<lines in group>]
6361 # no <lines in group> for subsequent lines in group of lines
6362 my ($full_rev, $orig_lineno, $lineno, $group_size) =
6363 ($line =~ /^([0-9a-f]{40}) (\d+) (\d+)(?: (\d+))?$/);
6364 if (!exists $metainfo{$full_rev}) {
6365 $metainfo{$full_rev} = { 'nprevious' => 0 };
6367 my $meta = $metainfo{$full_rev};
6368 my $data;
6369 while ($data = <$fd>) {
6370 chomp $data;
6371 last if ($data =~ s/^\t//); # contents of line
6372 if ($data =~ /^(\S+)(?: (.*))?$/) {
6373 $meta->{$1} = $2 unless exists $meta->{$1};
6375 if ($data =~ /^previous /) {
6376 $meta->{'nprevious'}++;
6379 my $short_rev = substr($full_rev, 0, 8);
6380 my $author = $meta->{'author'};
6381 my %date =
6382 parse_date($meta->{'author-time'}, $meta->{'author-tz'});
6383 my $date = $date{'iso-tz'};
6384 if ($group_size) {
6385 $current_color = ($current_color + 1) % $num_colors;
6387 my $tr_class = $rev_color[$current_color];
6388 $tr_class .= ' boundary' if (exists $meta->{'boundary'});
6389 $tr_class .= ' no-previous' if ($meta->{'nprevious'} == 0);
6390 $tr_class .= ' multiple-previous' if ($meta->{'nprevious'} > 1);
6391 print "<tr id=\"l$lineno\" class=\"$tr_class\">\n";
6392 if ($group_size) {
6393 print "<td class=\"sha1\"";
6394 print " title=\"". esc_html($author) . ", $date\"";
6395 print " rowspan=\"$group_size\"" if ($group_size > 1);
6396 print ">";
6397 print $cgi->a({-href => href(action=>"commit",
6398 hash=>$full_rev,
6399 file_name=>$file_name)},
6400 esc_html($short_rev));
6401 if ($group_size >= 2) {
6402 my @author_initials = ($author =~ /\b([[:upper:]])\B/g);
6403 if (@author_initials) {
6404 print "<br />" .
6405 esc_html(join('', @author_initials));
6406 # or join('.', ...)
6409 print "</td>\n";
6411 # 'previous' <sha1 of parent commit> <filename at commit>
6412 if (exists $meta->{'previous'} &&
6413 $meta->{'previous'} =~ /^([a-fA-F0-9]{40}) (.*)$/) {
6414 $meta->{'parent'} = $1;
6415 $meta->{'file_parent'} = unquote($2);
6417 my $linenr_commit =
6418 exists($meta->{'parent'}) ?
6419 $meta->{'parent'} : $full_rev;
6420 my $linenr_filename =
6421 exists($meta->{'file_parent'}) ?
6422 $meta->{'file_parent'} : unquote($meta->{'filename'});
6423 my $blamed = href(action => 'blame',
6424 file_name => $linenr_filename,
6425 hash_base => $linenr_commit);
6426 print "<td class=\"linenr\">";
6427 print $cgi->a({ -href => "$blamed#l$orig_lineno",
6428 -class => "linenr" },
6429 esc_html($lineno));
6430 print "</td>";
6431 print "<td class=\"pre\">" . esc_html($data) . "</td>\n";
6432 print "</tr>\n";
6433 } # end while
6437 # footer
6438 print "</tbody>\n".
6439 "</table>\n"; # class="blame"
6440 print "</div>\n"; # class="blame_body"
6441 close $fd
6442 or print "Reading blob failed\n";
6444 git_footer_html();
6447 sub git_blame {
6448 git_blame_common();
6451 sub git_blame_incremental {
6452 git_blame_common('incremental');
6455 sub git_blame_data {
6456 git_blame_common('data');
6459 sub git_tags {
6460 my $head = git_get_head_hash($project);
6461 git_header_html();
6462 git_print_page_nav('','', $head,undef,$head,format_ref_views('tags'));
6463 git_print_header_div('summary', $project);
6465 my @tagslist = git_get_tags_list();
6466 if (@tagslist) {
6467 git_tags_body(\@tagslist);
6469 git_footer_html();
6472 sub git_heads {
6473 my $head = git_get_head_hash($project);
6474 git_header_html();
6475 git_print_page_nav('','', $head,undef,$head,format_ref_views('heads'));
6476 git_print_header_div('summary', $project);
6478 my @headslist = git_get_heads_list();
6479 if (@headslist) {
6480 git_heads_body(\@headslist, $head);
6482 git_footer_html();
6485 # used both for single remote view and for list of all the remotes
6486 sub git_remotes {
6487 gitweb_check_feature('remote_heads')
6488 or die_error(403, "Remote heads view is disabled");
6490 my $head = git_get_head_hash($project);
6491 my $remote = $input_params{'hash'};
6493 my $remotedata = git_get_remotes_list($remote);
6494 die_error(500, "Unable to get remote information") unless defined $remotedata;
6496 unless (%$remotedata) {
6497 die_error(404, defined $remote ?
6498 "Remote $remote not found" :
6499 "No remotes found");
6502 git_header_html(undef, undef, -action_extra => $remote);
6503 git_print_page_nav('', '', $head, undef, $head,
6504 format_ref_views($remote ? '' : 'remotes'));
6506 fill_remote_heads($remotedata);
6507 if (defined $remote) {
6508 git_print_header_div('remotes', "$remote remote for $project");
6509 git_remote_block($remote, $remotedata->{$remote}, undef, $head);
6510 } else {
6511 git_print_header_div('summary', "$project remotes");
6512 git_remotes_body($remotedata, undef, $head);
6515 git_footer_html();
6518 sub git_blob_plain {
6519 my $type = shift;
6520 my $expires;
6522 if (!defined $hash) {
6523 if (defined $file_name) {
6524 my $base = $hash_base || git_get_head_hash($project);
6525 $hash = git_get_hash_by_path($base, $file_name, "blob")
6526 or die_error(404, "Cannot find file");
6527 } else {
6528 die_error(400, "No file name defined");
6530 } elsif ($hash =~ m/^[0-9a-fA-F]{40}$/) {
6531 # blobs defined by non-textual hash id's can be cached
6532 $expires = "+1d";
6535 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
6536 or die_error(500, "Open git-cat-file blob '$hash' failed");
6538 # content-type (can include charset)
6539 $type = blob_contenttype($fd, $file_name, $type);
6541 # "save as" filename, even when no $file_name is given
6542 my $save_as = "$hash";
6543 if (defined $file_name) {
6544 $save_as = $file_name;
6545 } elsif ($type =~ m/^text\//) {
6546 $save_as .= '.txt';
6549 # With XSS prevention on, blobs of all types except a few known safe
6550 # ones are served with "Content-Disposition: attachment" to make sure
6551 # they don't run in our security domain. For certain image types,
6552 # blob view writes an <img> tag referring to blob_plain view, and we
6553 # want to be sure not to break that by serving the image as an
6554 # attachment (though Firefox 3 doesn't seem to care).
6555 my $sandbox = $prevent_xss &&
6556 $type !~ m!^(?:text/[a-z]+|image/(?:gif|png|jpeg))(?:[ ;]|$)!;
6558 # serve text/* as text/plain
6559 if ($prevent_xss &&
6560 ($type =~ m!^text/[a-z]+\b(.*)$! ||
6561 ($type =~ m!^[a-z]+/[a-z]\+xml\b(.*)$! && -T $fd))) {
6562 my $rest = $1;
6563 $rest = defined $rest ? $rest : '';
6564 $type = "text/plain$rest";
6567 print $cgi->header(
6568 -type => $type,
6569 -expires => $expires,
6570 -content_disposition =>
6571 ($sandbox ? 'attachment' : 'inline')
6572 . '; filename="' . $save_as . '"');
6573 local $/ = undef;
6574 binmode STDOUT, ':raw';
6575 print <$fd>;
6576 binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
6577 close $fd;
6580 sub git_blob {
6581 my $expires;
6583 if (!defined $hash) {
6584 if (defined $file_name) {
6585 my $base = $hash_base || git_get_head_hash($project);
6586 $hash = git_get_hash_by_path($base, $file_name, "blob")
6587 or die_error(404, "Cannot find file");
6588 } else {
6589 die_error(400, "No file name defined");
6591 } elsif ($hash =~ m/^[0-9a-fA-F]{40}$/) {
6592 # blobs defined by non-textual hash id's can be cached
6593 $expires = "+1d";
6596 my $have_blame = gitweb_check_feature('blame');
6597 open my $fd, "-|", git_cmd(), "cat-file", "blob", $hash
6598 or die_error(500, "Couldn't cat $file_name, $hash");
6599 my $mimetype = blob_mimetype($fd, $file_name);
6600 # use 'blob_plain' (aka 'raw') view for files that cannot be displayed
6601 if ($mimetype !~ m!^(?:text/|image/(?:gif|png|jpeg)$)! && -B $fd) {
6602 close $fd;
6603 return git_blob_plain($mimetype);
6605 # we can have blame only for text/* mimetype
6606 $have_blame &&= ($mimetype =~ m!^text/!);
6608 my $highlight = gitweb_check_feature('highlight');
6609 my $syntax = guess_file_syntax($highlight, $mimetype, $file_name);
6610 $fd = run_highlighter($fd, $highlight, $syntax)
6611 if $syntax;
6613 git_header_html(undef, $expires);
6614 my $formats_nav = '';
6615 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
6616 if (defined $file_name) {
6617 if ($have_blame) {
6618 $formats_nav .=
6619 $cgi->a({-href => href(action=>"blame", -replay=>1)},
6620 "blame") .
6621 " | ";
6623 $formats_nav .=
6624 $cgi->a({-href => href(action=>"history", -replay=>1)},
6625 "history") .
6626 " | " .
6627 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
6628 "raw") .
6629 " | " .
6630 $cgi->a({-href => href(action=>"blob",
6631 hash_base=>"HEAD", file_name=>$file_name)},
6632 "HEAD");
6633 } else {
6634 $formats_nav .=
6635 $cgi->a({-href => href(action=>"blob_plain", -replay=>1)},
6636 "raw");
6638 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
6639 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
6640 } else {
6641 print "<div class=\"page_nav\">\n" .
6642 "<br/><br/></div>\n" .
6643 "<div class=\"title\">".esc_html($hash)."</div>\n";
6645 git_print_page_path($file_name, "blob", $hash_base);
6646 print "<div class=\"page_body\">\n";
6647 if ($mimetype =~ m!^image/!) {
6648 print qq!<img type="!.esc_attr($mimetype).qq!"!;
6649 if ($file_name) {
6650 print qq! alt="!.esc_attr($file_name).qq!" title="!.esc_attr($file_name).qq!"!;
6652 print qq! src="! .
6653 href(action=>"blob_plain", hash=>$hash,
6654 hash_base=>$hash_base, file_name=>$file_name) .
6655 qq!" />\n!;
6656 } else {
6657 my $nr;
6658 while (my $line = <$fd>) {
6659 chomp $line;
6660 $nr++;
6661 $line = untabify($line);
6662 printf qq!<div class="pre"><a id="l%i" href="%s#l%i" class="linenr">%4i</a> %s</div>\n!,
6663 $nr, esc_attr(href(-replay => 1)), $nr, $nr,
6664 $syntax ? sanitize($line) : esc_html($line, -nbsp=>1);
6667 close $fd
6668 or print "Reading blob failed.\n";
6669 print "</div>";
6670 git_footer_html();
6673 sub git_tree {
6674 if (!defined $hash_base) {
6675 $hash_base = "HEAD";
6677 if (!defined $hash) {
6678 if (defined $file_name) {
6679 $hash = git_get_hash_by_path($hash_base, $file_name, "tree");
6680 } else {
6681 $hash = $hash_base;
6684 die_error(404, "No such tree") unless defined($hash);
6686 my $show_sizes = gitweb_check_feature('show-sizes');
6687 my $have_blame = gitweb_check_feature('blame');
6689 my @entries = ();
6691 local $/ = "\0";
6692 open my $fd, "-|", git_cmd(), "ls-tree", '-z',
6693 ($show_sizes ? '-l' : ()), @extra_options, $hash
6694 or die_error(500, "Open git-ls-tree failed");
6695 @entries = map { chomp; $_ } <$fd>;
6696 close $fd
6697 or die_error(404, "Reading tree failed");
6700 my $refs = git_get_references();
6701 my $ref = format_ref_marker($refs, $hash_base);
6702 git_header_html();
6703 my $basedir = '';
6704 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
6705 my @views_nav = ();
6706 if (defined $file_name) {
6707 push @views_nav,
6708 $cgi->a({-href => href(action=>"history", -replay=>1)},
6709 "history"),
6710 $cgi->a({-href => href(action=>"tree",
6711 hash_base=>"HEAD", file_name=>$file_name)},
6712 "HEAD"),
6714 my $snapshot_links = format_snapshot_links($hash);
6715 if (defined $snapshot_links) {
6716 # FIXME: Should be available when we have no hash base as well.
6717 push @views_nav, $snapshot_links;
6719 git_print_page_nav('tree','', $hash_base, undef, undef,
6720 join(' | ', @views_nav));
6721 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash_base);
6722 } else {
6723 undef $hash_base;
6724 print "<div class=\"page_nav\">\n";
6725 print "<br/><br/></div>\n";
6726 print "<div class=\"title\">".esc_html($hash)."</div>\n";
6728 if (defined $file_name) {
6729 $basedir = $file_name;
6730 if ($basedir ne '' && substr($basedir, -1) ne '/') {
6731 $basedir .= '/';
6733 git_print_page_path($file_name, 'tree', $hash_base);
6735 print "<div class=\"page_body\">\n";
6736 print "<table class=\"tree\">\n";
6737 my $alternate = 1;
6738 # '..' (top directory) link if possible
6739 if (defined $hash_base &&
6740 defined $file_name && $file_name =~ m![^/]+$!) {
6741 if ($alternate) {
6742 print "<tr class=\"dark\">\n";
6743 } else {
6744 print "<tr class=\"light\">\n";
6746 $alternate ^= 1;
6748 my $up = $file_name;
6749 $up =~ s!/?[^/]+$!!;
6750 undef $up unless $up;
6751 # based on git_print_tree_entry
6752 print '<td class="mode">' . mode_str('040000') . "</td>\n";
6753 print '<td class="size">&nbsp;</td>'."\n" if $show_sizes;
6754 print '<td class="list">';
6755 print $cgi->a({-href => href(action=>"tree",
6756 hash_base=>$hash_base,
6757 file_name=>$up)},
6758 "..");
6759 print "</td>\n";
6760 print "<td class=\"link\"></td>\n";
6762 print "</tr>\n";
6764 foreach my $line (@entries) {
6765 my %t = parse_ls_tree_line($line, -z => 1, -l => $show_sizes);
6767 if ($alternate) {
6768 print "<tr class=\"dark\">\n";
6769 } else {
6770 print "<tr class=\"light\">\n";
6772 $alternate ^= 1;
6774 git_print_tree_entry(\%t, $basedir, $hash_base, $have_blame);
6776 print "</tr>\n";
6778 print "</table>\n" .
6779 "</div>";
6780 git_footer_html();
6783 sub snapshot_name {
6784 my ($project, $hash) = @_;
6786 # path/to/project.git -> project
6787 # path/to/project/.git -> project
6788 my $name = to_utf8($project);
6789 $name =~ s,([^/])/*\.git$,$1,;
6790 $name = basename($name);
6791 # sanitize name
6792 $name =~ s/[[:cntrl:]]/?/g;
6794 my $ver = $hash;
6795 if ($hash =~ /^[0-9a-fA-F]+$/) {
6796 # shorten SHA-1 hash
6797 my $full_hash = git_get_full_hash($project, $hash);
6798 if ($full_hash =~ /^$hash/ && length($hash) > 7) {
6799 $ver = git_get_short_hash($project, $hash);
6801 } elsif ($hash =~ m!^refs/tags/(.*)$!) {
6802 # tags don't need shortened SHA-1 hash
6803 $ver = $1;
6804 } else {
6805 # branches and other need shortened SHA-1 hash
6806 if ($hash =~ m!^refs/(?:heads|remotes)/(.*)$!) {
6807 $ver = $1;
6809 $ver .= '-' . git_get_short_hash($project, $hash);
6811 # in case of hierarchical branch names
6812 $ver =~ s!/!.!g;
6814 # name = project-version_string
6815 $name = "$name-$ver";
6817 return wantarray ? ($name, $name) : $name;
6820 sub git_snapshot {
6821 my $format = $input_params{'snapshot_format'};
6822 if (!@snapshot_fmts) {
6823 die_error(403, "Snapshots not allowed");
6825 # default to first supported snapshot format
6826 $format ||= $snapshot_fmts[0];
6827 if ($format !~ m/^[a-z0-9]+$/) {
6828 die_error(400, "Invalid snapshot format parameter");
6829 } elsif (!exists($known_snapshot_formats{$format})) {
6830 die_error(400, "Unknown snapshot format");
6831 } elsif ($known_snapshot_formats{$format}{'disabled'}) {
6832 die_error(403, "Snapshot format not allowed");
6833 } elsif (!grep($_ eq $format, @snapshot_fmts)) {
6834 die_error(403, "Unsupported snapshot format");
6837 my $type = git_get_type("$hash^{}");
6838 if (!$type) {
6839 die_error(404, 'Object does not exist');
6840 } elsif ($type eq 'blob') {
6841 die_error(400, 'Object is not a tree-ish');
6844 my ($name, $prefix) = snapshot_name($project, $hash);
6845 my $filename = "$name$known_snapshot_formats{$format}{'suffix'}";
6846 my $cmd = quote_command(
6847 git_cmd(), 'archive',
6848 "--format=$known_snapshot_formats{$format}{'format'}",
6849 "--prefix=$prefix/", $hash);
6850 if (exists $known_snapshot_formats{$format}{'compressor'}) {
6851 $cmd .= ' | ' . quote_command(@{$known_snapshot_formats{$format}{'compressor'}});
6854 $filename =~ s/(["\\])/\\$1/g;
6855 print $cgi->header(
6856 -type => $known_snapshot_formats{$format}{'type'},
6857 -content_disposition => 'inline; filename="' . $filename . '"',
6858 -status => '200 OK');
6860 open my $fd, "-|", $cmd
6861 or die_error(500, "Execute git-archive failed");
6862 binmode STDOUT, ':raw';
6863 print <$fd>;
6864 binmode STDOUT, ':utf8'; # as set at the beginning of gitweb.cgi
6865 close $fd;
6868 sub git_log_generic {
6869 my ($fmt_name, $body_subr, $base, $parent, $file_name, $file_hash) = @_;
6871 my $head = git_get_head_hash($project);
6872 if (!defined $base) {
6873 $base = $head;
6875 if (!defined $page) {
6876 $page = 0;
6878 my $refs = git_get_references();
6880 my $commit_hash = $base;
6881 if (defined $parent) {
6882 $commit_hash = "$parent..$base";
6884 my @commitlist =
6885 parse_commits($commit_hash, 101, (100 * $page),
6886 defined $file_name ? ($file_name, "--full-history") : ());
6888 my $ftype;
6889 if (!defined $file_hash && defined $file_name) {
6890 # some commits could have deleted file in question,
6891 # and not have it in tree, but one of them has to have it
6892 for (my $i = 0; $i < @commitlist; $i++) {
6893 $file_hash = git_get_hash_by_path($commitlist[$i]{'id'}, $file_name);
6894 last if defined $file_hash;
6897 if (defined $file_hash) {
6898 $ftype = git_get_type($file_hash);
6900 if (defined $file_name && !defined $ftype) {
6901 die_error(500, "Unknown type of object");
6903 my %co;
6904 if (defined $file_name) {
6905 %co = parse_commit($base)
6906 or die_error(404, "Unknown commit object");
6910 my $paging_nav = format_paging_nav($fmt_name, $page, $#commitlist >= 100);
6911 my $next_link = '';
6912 if ($#commitlist >= 100) {
6913 $next_link =
6914 $cgi->a({-href => href(-replay=>1, page=>$page+1),
6915 -accesskey => "n", -title => "Alt-n"}, "next");
6917 my $patch_max = gitweb_get_feature('patches');
6918 if ($patch_max && !defined $file_name) {
6919 if ($patch_max < 0 || @commitlist <= $patch_max) {
6920 $paging_nav .= " &sdot; " .
6921 $cgi->a({-href => href(action=>"patches", -replay=>1)},
6922 "patches");
6926 git_header_html();
6927 git_print_page_nav($fmt_name,'', $hash,$hash,$hash, $paging_nav);
6928 if (defined $file_name) {
6929 git_print_header_div('commit', esc_html($co{'title'}), $base);
6930 } else {
6931 git_print_header_div('summary', $project)
6933 git_print_page_path($file_name, $ftype, $hash_base)
6934 if (defined $file_name);
6936 $body_subr->(\@commitlist, 0, 99, $refs, $next_link,
6937 $file_name, $file_hash, $ftype);
6939 git_footer_html();
6942 sub git_log {
6943 git_log_generic('log', \&git_log_body,
6944 $hash, $hash_parent);
6947 sub git_commit {
6948 $hash ||= $hash_base || "HEAD";
6949 my %co = parse_commit($hash)
6950 or die_error(404, "Unknown commit object");
6952 my $parent = $co{'parent'};
6953 my $parents = $co{'parents'}; # listref
6955 # we need to prepare $formats_nav before any parameter munging
6956 my $formats_nav;
6957 if (!defined $parent) {
6958 # --root commitdiff
6959 $formats_nav .= '(initial)';
6960 } elsif (@$parents == 1) {
6961 # single parent commit
6962 $formats_nav .=
6963 '(parent: ' .
6964 $cgi->a({-href => href(action=>"commit",
6965 hash=>$parent)},
6966 esc_html(substr($parent, 0, 7))) .
6967 ')';
6968 } else {
6969 # merge commit
6970 $formats_nav .=
6971 '(merge: ' .
6972 join(' ', map {
6973 $cgi->a({-href => href(action=>"commit",
6974 hash=>$_)},
6975 esc_html(substr($_, 0, 7)));
6976 } @$parents ) .
6977 ')';
6979 if (gitweb_check_feature('patches') && @$parents <= 1) {
6980 $formats_nav .= " | " .
6981 $cgi->a({-href => href(action=>"patch", -replay=>1)},
6982 "patch");
6985 if (!defined $parent) {
6986 $parent = "--root";
6988 my @difftree;
6989 open my $fd, "-|", git_cmd(), "diff-tree", '-r', "--no-commit-id",
6990 @diff_opts,
6991 (@$parents <= 1 ? $parent : '-c'),
6992 $hash, "--"
6993 or die_error(500, "Open git-diff-tree failed");
6994 @difftree = map { chomp; $_ } <$fd>;
6995 close $fd or die_error(404, "Reading git-diff-tree failed");
6997 # non-textual hash id's can be cached
6998 my $expires;
6999 if ($hash =~ m/^[0-9a-fA-F]{40}$/) {
7000 $expires = "+1d";
7002 my $refs = git_get_references();
7003 my $ref = format_ref_marker($refs, $co{'id'});
7005 git_header_html(undef, $expires);
7006 git_print_page_nav('commit', '',
7007 $hash, $co{'tree'}, $hash,
7008 $formats_nav);
7010 if (defined $co{'parent'}) {
7011 git_print_header_div('commitdiff', esc_html($co{'title'}) . $ref, $hash);
7012 } else {
7013 git_print_header_div('tree', esc_html($co{'title'}) . $ref, $co{'tree'}, $hash);
7015 print "<div class=\"title_text\">\n" .
7016 "<table class=\"object_header\">\n";
7017 git_print_authorship_rows(\%co);
7018 print "<tr><td>commit</td><td class=\"sha1\">$co{'id'}</td></tr>\n";
7019 print "<tr>" .
7020 "<td>tree</td>" .
7021 "<td class=\"sha1\">" .
7022 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash),
7023 class => "list"}, $co{'tree'}) .
7024 "</td>" .
7025 "<td class=\"link\">" .
7026 $cgi->a({-href => href(action=>"tree", hash=>$co{'tree'}, hash_base=>$hash)},
7027 "tree");
7028 my $snapshot_links = format_snapshot_links($hash);
7029 if (defined $snapshot_links) {
7030 print " | " . $snapshot_links;
7032 print "</td>" .
7033 "</tr>\n";
7035 foreach my $par (@$parents) {
7036 print "<tr>" .
7037 "<td>parent</td>" .
7038 "<td class=\"sha1\">" .
7039 $cgi->a({-href => href(action=>"commit", hash=>$par),
7040 class => "list"}, $par) .
7041 "</td>" .
7042 "<td class=\"link\">" .
7043 $cgi->a({-href => href(action=>"commit", hash=>$par)}, "commit") .
7044 " | " .
7045 $cgi->a({-href => href(action=>"commitdiff", hash=>$hash, hash_parent=>$par)}, "diff") .
7046 "</td>" .
7047 "</tr>\n";
7049 print "</table>".
7050 "</div>\n";
7052 print "<div class=\"page_body\">\n";
7053 git_print_log($co{'comment'});
7054 print "</div>\n";
7056 git_difftree_body(\@difftree, $hash, @$parents);
7058 git_footer_html();
7061 sub git_object {
7062 # object is defined by:
7063 # - hash or hash_base alone
7064 # - hash_base and file_name
7065 my $type;
7067 # - hash or hash_base alone
7068 if ($hash || ($hash_base && !defined $file_name)) {
7069 my $object_id = $hash || $hash_base;
7071 open my $fd, "-|", quote_command(
7072 git_cmd(), 'cat-file', '-t', $object_id) . ' 2> /dev/null'
7073 or die_error(404, "Object does not exist");
7074 $type = <$fd>;
7075 chomp $type;
7076 close $fd
7077 or die_error(404, "Object does not exist");
7079 # - hash_base and file_name
7080 } elsif ($hash_base && defined $file_name) {
7081 $file_name =~ s,/+$,,;
7083 system(git_cmd(), "cat-file", '-e', $hash_base) == 0
7084 or die_error(404, "Base object does not exist");
7086 # here errors should not hapen
7087 open my $fd, "-|", git_cmd(), "ls-tree", $hash_base, "--", $file_name
7088 or die_error(500, "Open git-ls-tree failed");
7089 my $line = <$fd>;
7090 close $fd;
7092 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
7093 unless ($line && $line =~ m/^([0-9]+) (.+) ([0-9a-fA-F]{40})\t/) {
7094 die_error(404, "File or directory for given base does not exist");
7096 $type = $2;
7097 $hash = $3;
7098 } else {
7099 die_error(400, "Not enough information to find object");
7102 print $cgi->redirect(-uri => href(action=>$type, -full=>1,
7103 hash=>$hash, hash_base=>$hash_base,
7104 file_name=>$file_name),
7105 -status => '302 Found');
7108 sub git_blobdiff {
7109 my $format = shift || 'html';
7110 my $diff_style = $input_params{'diff_style'} || 'inline';
7112 my $fd;
7113 my @difftree;
7114 my %diffinfo;
7115 my $expires;
7117 # preparing $fd and %diffinfo for git_patchset_body
7118 # new style URI
7119 if (defined $hash_base && defined $hash_parent_base) {
7120 if (defined $file_name) {
7121 # read raw output
7122 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7123 $hash_parent_base, $hash_base,
7124 "--", (defined $file_parent ? $file_parent : ()), $file_name
7125 or die_error(500, "Open git-diff-tree failed");
7126 @difftree = map { chomp; $_ } <$fd>;
7127 close $fd
7128 or die_error(404, "Reading git-diff-tree failed");
7129 @difftree
7130 or die_error(404, "Blob diff not found");
7132 } elsif (defined $hash &&
7133 $hash =~ /[0-9a-fA-F]{40}/) {
7134 # try to find filename from $hash
7136 # read filtered raw output
7137 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7138 $hash_parent_base, $hash_base, "--"
7139 or die_error(500, "Open git-diff-tree failed");
7140 @difftree =
7141 # ':100644 100644 03b21826... 3b93d5e7... M ls-files.c'
7142 # $hash == to_id
7143 grep { /^:[0-7]{6} [0-7]{6} [0-9a-fA-F]{40} $hash/ }
7144 map { chomp; $_ } <$fd>;
7145 close $fd
7146 or die_error(404, "Reading git-diff-tree failed");
7147 @difftree
7148 or die_error(404, "Blob diff not found");
7150 } else {
7151 die_error(400, "Missing one of the blob diff parameters");
7154 if (@difftree > 1) {
7155 die_error(400, "Ambiguous blob diff specification");
7158 %diffinfo = parse_difftree_raw_line($difftree[0]);
7159 $file_parent ||= $diffinfo{'from_file'} || $file_name;
7160 $file_name ||= $diffinfo{'to_file'};
7162 $hash_parent ||= $diffinfo{'from_id'};
7163 $hash ||= $diffinfo{'to_id'};
7165 # non-textual hash id's can be cached
7166 if ($hash_base =~ m/^[0-9a-fA-F]{40}$/ &&
7167 $hash_parent_base =~ m/^[0-9a-fA-F]{40}$/) {
7168 $expires = '+1d';
7171 # open patch output
7172 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7173 '-p', ($format eq 'html' ? "--full-index" : ()),
7174 $hash_parent_base, $hash_base,
7175 "--", (defined $file_parent ? $file_parent : ()), $file_name
7176 or die_error(500, "Open git-diff-tree failed");
7179 # old/legacy style URI -- not generated anymore since 1.4.3.
7180 if (!%diffinfo) {
7181 die_error('404 Not Found', "Missing one of the blob diff parameters")
7184 # header
7185 if ($format eq 'html') {
7186 my $formats_nav =
7187 $cgi->a({-href => href(action=>"blobdiff_plain", -replay=>1)},
7188 "raw");
7189 $formats_nav .= diff_style_nav($diff_style);
7190 git_header_html(undef, $expires);
7191 if (defined $hash_base && (my %co = parse_commit($hash_base))) {
7192 git_print_page_nav('','', $hash_base,$co{'tree'},$hash_base, $formats_nav);
7193 git_print_header_div('commit', esc_html($co{'title'}), $hash_base);
7194 } else {
7195 print "<div class=\"page_nav\"><br/>$formats_nav<br/></div>\n";
7196 print "<div class=\"title\">".esc_html("$hash vs $hash_parent")."</div>\n";
7198 if (defined $file_name) {
7199 git_print_page_path($file_name, "blob", $hash_base);
7200 } else {
7201 print "<div class=\"page_path\"></div>\n";
7204 } elsif ($format eq 'plain') {
7205 print $cgi->header(
7206 -type => 'text/plain',
7207 -charset => 'utf-8',
7208 -expires => $expires,
7209 -content_disposition => 'inline; filename="' . "$file_name" . '.patch"');
7211 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
7213 } else {
7214 die_error(400, "Unknown blobdiff format");
7217 # patch
7218 if ($format eq 'html') {
7219 print "<div class=\"page_body\">\n";
7221 git_patchset_body($fd, $diff_style,
7222 [ \%diffinfo ], $hash_base, $hash_parent_base);
7223 close $fd;
7225 print "</div>\n"; # class="page_body"
7226 git_footer_html();
7228 } else {
7229 while (my $line = <$fd>) {
7230 $line =~ s!a/($hash|$hash_parent)!'a/'.esc_path($diffinfo{'from_file'})!eg;
7231 $line =~ s!b/($hash|$hash_parent)!'b/'.esc_path($diffinfo{'to_file'})!eg;
7233 print $line;
7235 last if $line =~ m!^\+\+\+!;
7237 local $/ = undef;
7238 print <$fd>;
7239 close $fd;
7243 sub git_blobdiff_plain {
7244 git_blobdiff('plain');
7247 # assumes that it is added as later part of already existing navigation,
7248 # so it returns "| foo | bar" rather than just "foo | bar"
7249 sub diff_style_nav {
7250 my ($diff_style, $is_combined) = @_;
7251 $diff_style ||= 'inline';
7253 return "" if ($is_combined);
7255 my @styles = (inline => 'inline', 'sidebyside' => 'side by side');
7256 my %styles = @styles;
7257 @styles =
7258 @styles[ map { $_ * 2 } 0..$#styles/2 ];
7260 return join '',
7261 map { " | ".$_ }
7262 map {
7263 $_ eq $diff_style ? $styles{$_} :
7264 $cgi->a({-href => href(-replay=>1, diff_style => $_)}, $styles{$_})
7265 } @styles;
7268 sub git_commitdiff {
7269 my %params = @_;
7270 my $format = $params{-format} || 'html';
7271 my $diff_style = $input_params{'diff_style'} || 'inline';
7273 my ($patch_max) = gitweb_get_feature('patches');
7274 if ($format eq 'patch') {
7275 die_error(403, "Patch view not allowed") unless $patch_max;
7278 $hash ||= $hash_base || "HEAD";
7279 my %co = parse_commit($hash)
7280 or die_error(404, "Unknown commit object");
7282 # choose format for commitdiff for merge
7283 if (! defined $hash_parent && @{$co{'parents'}} > 1) {
7284 $hash_parent = '--cc';
7286 # we need to prepare $formats_nav before almost any parameter munging
7287 my $formats_nav;
7288 if ($format eq 'html') {
7289 $formats_nav =
7290 $cgi->a({-href => href(action=>"commitdiff_plain", -replay=>1)},
7291 "raw");
7292 if ($patch_max && @{$co{'parents'}} <= 1) {
7293 $formats_nav .= " | " .
7294 $cgi->a({-href => href(action=>"patch", -replay=>1)},
7295 "patch");
7297 $formats_nav .= diff_style_nav($diff_style, @{$co{'parents'}} > 1);
7299 if (defined $hash_parent &&
7300 $hash_parent ne '-c' && $hash_parent ne '--cc') {
7301 # commitdiff with two commits given
7302 my $hash_parent_short = $hash_parent;
7303 if ($hash_parent =~ m/^[0-9a-fA-F]{40}$/) {
7304 $hash_parent_short = substr($hash_parent, 0, 7);
7306 $formats_nav .=
7307 ' (from';
7308 for (my $i = 0; $i < @{$co{'parents'}}; $i++) {
7309 if ($co{'parents'}[$i] eq $hash_parent) {
7310 $formats_nav .= ' parent ' . ($i+1);
7311 last;
7314 $formats_nav .= ': ' .
7315 $cgi->a({-href => href(-replay=>1,
7316 hash=>$hash_parent, hash_base=>undef)},
7317 esc_html($hash_parent_short)) .
7318 ')';
7319 } elsif (!$co{'parent'}) {
7320 # --root commitdiff
7321 $formats_nav .= ' (initial)';
7322 } elsif (scalar @{$co{'parents'}} == 1) {
7323 # single parent commit
7324 $formats_nav .=
7325 ' (parent: ' .
7326 $cgi->a({-href => href(-replay=>1,
7327 hash=>$co{'parent'}, hash_base=>undef)},
7328 esc_html(substr($co{'parent'}, 0, 7))) .
7329 ')';
7330 } else {
7331 # merge commit
7332 if ($hash_parent eq '--cc') {
7333 $formats_nav .= ' | ' .
7334 $cgi->a({-href => href(-replay=>1,
7335 hash=>$hash, hash_parent=>'-c')},
7336 'combined');
7337 } else { # $hash_parent eq '-c'
7338 $formats_nav .= ' | ' .
7339 $cgi->a({-href => href(-replay=>1,
7340 hash=>$hash, hash_parent=>'--cc')},
7341 'compact');
7343 $formats_nav .=
7344 ' (merge: ' .
7345 join(' ', map {
7346 $cgi->a({-href => href(-replay=>1,
7347 hash=>$_, hash_base=>undef)},
7348 esc_html(substr($_, 0, 7)));
7349 } @{$co{'parents'}} ) .
7350 ')';
7354 my $hash_parent_param = $hash_parent;
7355 if (!defined $hash_parent_param) {
7356 # --cc for multiple parents, --root for parentless
7357 $hash_parent_param =
7358 @{$co{'parents'}} > 1 ? '--cc' : $co{'parent'} || '--root';
7361 # read commitdiff
7362 my $fd;
7363 my @difftree;
7364 if ($format eq 'html') {
7365 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7366 "--no-commit-id", "--patch-with-raw", "--full-index",
7367 $hash_parent_param, $hash, "--"
7368 or die_error(500, "Open git-diff-tree failed");
7370 while (my $line = <$fd>) {
7371 chomp $line;
7372 # empty line ends raw part of diff-tree output
7373 last unless $line;
7374 push @difftree, scalar parse_difftree_raw_line($line);
7377 } elsif ($format eq 'plain') {
7378 open $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7379 '-p', $hash_parent_param, $hash, "--"
7380 or die_error(500, "Open git-diff-tree failed");
7381 } elsif ($format eq 'patch') {
7382 # For commit ranges, we limit the output to the number of
7383 # patches specified in the 'patches' feature.
7384 # For single commits, we limit the output to a single patch,
7385 # diverging from the git-format-patch default.
7386 my @commit_spec = ();
7387 if ($hash_parent) {
7388 if ($patch_max > 0) {
7389 push @commit_spec, "-$patch_max";
7391 push @commit_spec, '-n', "$hash_parent..$hash";
7392 } else {
7393 if ($params{-single}) {
7394 push @commit_spec, '-1';
7395 } else {
7396 if ($patch_max > 0) {
7397 push @commit_spec, "-$patch_max";
7399 push @commit_spec, "-n";
7401 push @commit_spec, '--root', $hash;
7403 open $fd, "-|", git_cmd(), "format-patch", @diff_opts,
7404 '--encoding=utf8', '--stdout', @commit_spec
7405 or die_error(500, "Open git-format-patch failed");
7406 } else {
7407 die_error(400, "Unknown commitdiff format");
7410 # non-textual hash id's can be cached
7411 my $expires;
7412 if ($hash =~ m/^[0-9a-fA-F]{40}$/) {
7413 $expires = "+1d";
7416 # write commit message
7417 if ($format eq 'html') {
7418 my $refs = git_get_references();
7419 my $ref = format_ref_marker($refs, $co{'id'});
7421 git_header_html(undef, $expires);
7422 git_print_page_nav('commitdiff','', $hash,$co{'tree'},$hash, $formats_nav);
7423 git_print_header_div('commit', esc_html($co{'title'}) . $ref, $hash);
7424 print "<div class=\"title_text\">\n" .
7425 "<table class=\"object_header\">\n";
7426 git_print_authorship_rows(\%co);
7427 print "</table>".
7428 "</div>\n";
7429 print "<div class=\"page_body\">\n";
7430 if (@{$co{'comment'}} > 1) {
7431 print "<div class=\"log\">\n";
7432 git_print_log($co{'comment'}, -final_empty_line=> 1, -remove_title => 1);
7433 print "</div>\n"; # class="log"
7436 } elsif ($format eq 'plain') {
7437 my $refs = git_get_references("tags");
7438 my $tagname = git_get_rev_name_tags($hash);
7439 my $filename = basename($project) . "-$hash.patch";
7441 print $cgi->header(
7442 -type => 'text/plain',
7443 -charset => 'utf-8',
7444 -expires => $expires,
7445 -content_disposition => 'inline; filename="' . "$filename" . '"');
7446 my %ad = parse_date($co{'author_epoch'}, $co{'author_tz'});
7447 print "From: " . to_utf8($co{'author'}) . "\n";
7448 print "Date: $ad{'rfc2822'} ($ad{'tz_local'})\n";
7449 print "Subject: " . to_utf8($co{'title'}) . "\n";
7451 print "X-Git-Tag: $tagname\n" if $tagname;
7452 print "X-Git-Url: " . $cgi->self_url() . "\n\n";
7454 foreach my $line (@{$co{'comment'}}) {
7455 print to_utf8($line) . "\n";
7457 print "---\n\n";
7458 } elsif ($format eq 'patch') {
7459 my $filename = basename($project) . "-$hash.patch";
7461 print $cgi->header(
7462 -type => 'text/plain',
7463 -charset => 'utf-8',
7464 -expires => $expires,
7465 -content_disposition => 'inline; filename="' . "$filename" . '"');
7468 # write patch
7469 if ($format eq 'html') {
7470 my $use_parents = !defined $hash_parent ||
7471 $hash_parent eq '-c' || $hash_parent eq '--cc';
7472 git_difftree_body(\@difftree, $hash,
7473 $use_parents ? @{$co{'parents'}} : $hash_parent);
7474 print "<br/>\n";
7476 git_patchset_body($fd, $diff_style,
7477 \@difftree, $hash,
7478 $use_parents ? @{$co{'parents'}} : $hash_parent);
7479 close $fd;
7480 print "</div>\n"; # class="page_body"
7481 git_footer_html();
7483 } elsif ($format eq 'plain') {
7484 local $/ = undef;
7485 print <$fd>;
7486 close $fd
7487 or print "Reading git-diff-tree failed\n";
7488 } elsif ($format eq 'patch') {
7489 local $/ = undef;
7490 print <$fd>;
7491 close $fd
7492 or print "Reading git-format-patch failed\n";
7496 sub git_commitdiff_plain {
7497 git_commitdiff(-format => 'plain');
7500 # format-patch-style patches
7501 sub git_patch {
7502 git_commitdiff(-format => 'patch', -single => 1);
7505 sub git_patches {
7506 git_commitdiff(-format => 'patch');
7509 sub git_history {
7510 git_log_generic('history', \&git_history_body,
7511 $hash_base, $hash_parent_base,
7512 $file_name, $hash);
7515 sub git_search {
7516 $searchtype ||= 'commit';
7518 # check if appropriate features are enabled
7519 gitweb_check_feature('search')
7520 or die_error(403, "Search is disabled");
7521 if ($searchtype eq 'pickaxe') {
7522 # pickaxe may take all resources of your box and run for several minutes
7523 # with every query - so decide by yourself how public you make this feature
7524 gitweb_check_feature('pickaxe')
7525 or die_error(403, "Pickaxe search is disabled");
7527 if ($searchtype eq 'grep') {
7528 # grep search might be potentially CPU-intensive, too
7529 gitweb_check_feature('grep')
7530 or die_error(403, "Grep search is disabled");
7533 if (!defined $searchtext) {
7534 die_error(400, "Text field is empty");
7536 if (!defined $hash) {
7537 $hash = git_get_head_hash($project);
7539 my %co = parse_commit($hash);
7540 if (!%co) {
7541 die_error(404, "Unknown commit object");
7543 if (!defined $page) {
7544 $page = 0;
7547 if ($searchtype eq 'commit' ||
7548 $searchtype eq 'author' ||
7549 $searchtype eq 'committer') {
7550 git_search_message(%co);
7551 } elsif ($searchtype eq 'pickaxe') {
7552 git_search_changes(%co);
7553 } elsif ($searchtype eq 'grep') {
7554 git_search_files(%co);
7555 } else {
7556 die_error(400, "Unknown search type");
7560 sub git_search_help {
7561 git_header_html();
7562 git_print_page_nav('','', $hash,$hash,$hash);
7563 print <<EOT;
7564 <p><strong>Pattern</strong> is by default a normal string that is matched precisely (but without
7565 regard to case, except in the case of pickaxe). However, when you check the <em>re</em> checkbox,
7566 the pattern entered is recognized as the POSIX extended
7567 <a href="http://en.wikipedia.org/wiki/Regular_expression">regular expression</a> (also case
7568 insensitive).</p>
7569 <dl>
7570 <dt><b>commit</b></dt>
7571 <dd>The commit messages and authorship information will be scanned for the given pattern.</dd>
7573 my $have_grep = gitweb_check_feature('grep');
7574 if ($have_grep) {
7575 print <<EOT;
7576 <dt><b>grep</b></dt>
7577 <dd>All files in the currently selected tree (HEAD unless you are explicitly browsing
7578 a different one) are searched for the given pattern. On large trees, this search can take
7579 a while and put some strain on the server, so please use it with some consideration. Note that
7580 due to git-grep peculiarity, currently if regexp mode is turned off, the matches are
7581 case-sensitive.</dd>
7584 print <<EOT;
7585 <dt><b>author</b></dt>
7586 <dd>Name and e-mail of the change author and date of birth of the patch will be scanned for the given pattern.</dd>
7587 <dt><b>committer</b></dt>
7588 <dd>Name and e-mail of the committer and date of commit will be scanned for the given pattern.</dd>
7590 my $have_pickaxe = gitweb_check_feature('pickaxe');
7591 if ($have_pickaxe) {
7592 print <<EOT;
7593 <dt><b>pickaxe</b></dt>
7594 <dd>All commits that caused the string to appear or disappear from any file (changes that
7595 added, removed or "modified" the string) will be listed. This search can take a while and
7596 takes a lot of strain on the server, so please use it wisely. Note that since you may be
7597 interested even in changes just changing the case as well, this search is case sensitive.</dd>
7600 print "</dl>\n";
7601 git_footer_html();
7604 sub git_shortlog {
7605 git_log_generic('shortlog', \&git_shortlog_body,
7606 $hash, $hash_parent);
7609 ## ......................................................................
7610 ## feeds (RSS, Atom; OPML)
7612 sub git_feed {
7613 my $format = shift || 'atom';
7614 my $have_blame = gitweb_check_feature('blame');
7616 # Atom: http://www.atomenabled.org/developers/syndication/
7617 # RSS: http://www.notestips.com/80256B3A007F2692/1/NAMO5P9UPQ
7618 if ($format ne 'rss' && $format ne 'atom') {
7619 die_error(400, "Unknown web feed format");
7622 # log/feed of current (HEAD) branch, log of given branch, history of file/directory
7623 my $head = $hash || 'HEAD';
7624 my @commitlist = parse_commits($head, 150, 0, $file_name);
7626 my %latest_commit;
7627 my %latest_date;
7628 my $content_type = "application/$format+xml";
7629 if (defined $cgi->http('HTTP_ACCEPT') &&
7630 $cgi->Accept('text/xml') > $cgi->Accept($content_type)) {
7631 # browser (feed reader) prefers text/xml
7632 $content_type = 'text/xml';
7634 if (defined($commitlist[0])) {
7635 %latest_commit = %{$commitlist[0]};
7636 my $latest_epoch = $latest_commit{'committer_epoch'};
7637 %latest_date = parse_date($latest_epoch, $latest_commit{'comitter_tz'});
7638 my $if_modified = $cgi->http('IF_MODIFIED_SINCE');
7639 if (defined $if_modified) {
7640 my $since;
7641 if (eval { require HTTP::Date; 1; }) {
7642 $since = HTTP::Date::str2time($if_modified);
7643 } elsif (eval { require Time::ParseDate; 1; }) {
7644 $since = Time::ParseDate::parsedate($if_modified, GMT => 1);
7646 if (defined $since && $latest_epoch <= $since) {
7647 print $cgi->header(
7648 -type => $content_type,
7649 -charset => 'utf-8',
7650 -last_modified => $latest_date{'rfc2822'},
7651 -status => '304 Not Modified');
7652 return;
7655 print $cgi->header(
7656 -type => $content_type,
7657 -charset => 'utf-8',
7658 -last_modified => $latest_date{'rfc2822'});
7659 } else {
7660 print $cgi->header(
7661 -type => $content_type,
7662 -charset => 'utf-8');
7665 # Optimization: skip generating the body if client asks only
7666 # for Last-Modified date.
7667 return if ($cgi->request_method() eq 'HEAD');
7669 # header variables
7670 my $title = "$site_name - $project/$action";
7671 my $feed_type = 'log';
7672 if (defined $hash) {
7673 $title .= " - '$hash'";
7674 $feed_type = 'branch log';
7675 if (defined $file_name) {
7676 $title .= " :: $file_name";
7677 $feed_type = 'history';
7679 } elsif (defined $file_name) {
7680 $title .= " - $file_name";
7681 $feed_type = 'history';
7683 $title .= " $feed_type";
7684 my $descr = git_get_project_description($project);
7685 if (defined $descr) {
7686 $descr = esc_html($descr);
7687 } else {
7688 $descr = "$project " .
7689 ($format eq 'rss' ? 'RSS' : 'Atom') .
7690 " feed";
7692 my $owner = git_get_project_owner($project);
7693 $owner = esc_html($owner);
7695 #header
7696 my $alt_url;
7697 if (defined $file_name) {
7698 $alt_url = href(-full=>1, action=>"history", hash=>$hash, file_name=>$file_name);
7699 } elsif (defined $hash) {
7700 $alt_url = href(-full=>1, action=>"log", hash=>$hash);
7701 } else {
7702 $alt_url = href(-full=>1, action=>"summary");
7704 print qq!<?xml version="1.0" encoding="utf-8"?>\n!;
7705 if ($format eq 'rss') {
7706 print <<XML;
7707 <rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
7708 <channel>
7710 print "<title>$title</title>\n" .
7711 "<link>$alt_url</link>\n" .
7712 "<description>$descr</description>\n" .
7713 "<language>en</language>\n" .
7714 # project owner is responsible for 'editorial' content
7715 "<managingEditor>$owner</managingEditor>\n";
7716 if (defined $logo || defined $favicon) {
7717 # prefer the logo to the favicon, since RSS
7718 # doesn't allow both
7719 my $img = esc_url($logo || $favicon);
7720 print "<image>\n" .
7721 "<url>$img</url>\n" .
7722 "<title>$title</title>\n" .
7723 "<link>$alt_url</link>\n" .
7724 "</image>\n";
7726 if (%latest_date) {
7727 print "<pubDate>$latest_date{'rfc2822'}</pubDate>\n";
7728 print "<lastBuildDate>$latest_date{'rfc2822'}</lastBuildDate>\n";
7730 print "<generator>gitweb v.$version/$git_version</generator>\n";
7731 } elsif ($format eq 'atom') {
7732 print <<XML;
7733 <feed xmlns="http://www.w3.org/2005/Atom">
7735 print "<title>$title</title>\n" .
7736 "<subtitle>$descr</subtitle>\n" .
7737 '<link rel="alternate" type="text/html" href="' .
7738 $alt_url . '" />' . "\n" .
7739 '<link rel="self" type="' . $content_type . '" href="' .
7740 $cgi->self_url() . '" />' . "\n" .
7741 "<id>" . href(-full=>1) . "</id>\n" .
7742 # use project owner for feed author
7743 "<author><name>$owner</name></author>\n";
7744 if (defined $favicon) {
7745 print "<icon>" . esc_url($favicon) . "</icon>\n";
7747 if (defined $logo) {
7748 # not twice as wide as tall: 72 x 27 pixels
7749 print "<logo>" . esc_url($logo) . "</logo>\n";
7751 if (! %latest_date) {
7752 # dummy date to keep the feed valid until commits trickle in:
7753 print "<updated>1970-01-01T00:00:00Z</updated>\n";
7754 } else {
7755 print "<updated>$latest_date{'iso-8601'}</updated>\n";
7757 print "<generator version='$version/$git_version'>gitweb</generator>\n";
7760 # contents
7761 for (my $i = 0; $i <= $#commitlist; $i++) {
7762 my %co = %{$commitlist[$i]};
7763 my $commit = $co{'id'};
7764 # we read 150, we always show 30 and the ones more recent than 48 hours
7765 if (($i >= 20) && ((time - $co{'author_epoch'}) > 48*60*60)) {
7766 last;
7768 my %cd = parse_date($co{'author_epoch'}, $co{'author_tz'});
7770 # get list of changed files
7771 open my $fd, "-|", git_cmd(), "diff-tree", '-r', @diff_opts,
7772 $co{'parent'} || "--root",
7773 $co{'id'}, "--", (defined $file_name ? $file_name : ())
7774 or next;
7775 my @difftree = map { chomp; $_ } <$fd>;
7776 close $fd
7777 or next;
7779 # print element (entry, item)
7780 my $co_url = href(-full=>1, action=>"commitdiff", hash=>$commit);
7781 if ($format eq 'rss') {
7782 print "<item>\n" .
7783 "<title>" . esc_html($co{'title'}) . "</title>\n" .
7784 "<author>" . esc_html($co{'author'}) . "</author>\n" .
7785 "<pubDate>$cd{'rfc2822'}</pubDate>\n" .
7786 "<guid isPermaLink=\"true\">$co_url</guid>\n" .
7787 "<link>$co_url</link>\n" .
7788 "<description>" . esc_html($co{'title'}) . "</description>\n" .
7789 "<content:encoded>" .
7790 "<![CDATA[\n";
7791 } elsif ($format eq 'atom') {
7792 print "<entry>\n" .
7793 "<title type=\"html\">" . esc_html($co{'title'}) . "</title>\n" .
7794 "<updated>$cd{'iso-8601'}</updated>\n" .
7795 "<author>\n" .
7796 " <name>" . esc_html($co{'author_name'}) . "</name>\n";
7797 if ($co{'author_email'}) {
7798 print " <email>" . esc_html($co{'author_email'}) . "</email>\n";
7800 print "</author>\n" .
7801 # use committer for contributor
7802 "<contributor>\n" .
7803 " <name>" . esc_html($co{'committer_name'}) . "</name>\n";
7804 if ($co{'committer_email'}) {
7805 print " <email>" . esc_html($co{'committer_email'}) . "</email>\n";
7807 print "</contributor>\n" .
7808 "<published>$cd{'iso-8601'}</published>\n" .
7809 "<link rel=\"alternate\" type=\"text/html\" href=\"$co_url\" />\n" .
7810 "<id>$co_url</id>\n" .
7811 "<content type=\"xhtml\" xml:base=\"" . esc_url($my_url) . "\">\n" .
7812 "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n";
7814 my $comment = $co{'comment'};
7815 print "<pre>\n";
7816 foreach my $line (@$comment) {
7817 $line = esc_html($line);
7818 print "$line\n";
7820 print "</pre><ul>\n";
7821 foreach my $difftree_line (@difftree) {
7822 my %difftree = parse_difftree_raw_line($difftree_line);
7823 next if !$difftree{'from_id'};
7825 my $file = $difftree{'file'} || $difftree{'to_file'};
7827 print "<li>" .
7828 "[" .
7829 $cgi->a({-href => href(-full=>1, action=>"blobdiff",
7830 hash=>$difftree{'to_id'}, hash_parent=>$difftree{'from_id'},
7831 hash_base=>$co{'id'}, hash_parent_base=>$co{'parent'},
7832 file_name=>$file, file_parent=>$difftree{'from_file'}),
7833 -title => "diff"}, 'D');
7834 if ($have_blame) {
7835 print $cgi->a({-href => href(-full=>1, action=>"blame",
7836 file_name=>$file, hash_base=>$commit),
7837 -title => "blame"}, 'B');
7839 # if this is not a feed of a file history
7840 if (!defined $file_name || $file_name ne $file) {
7841 print $cgi->a({-href => href(-full=>1, action=>"history",
7842 file_name=>$file, hash=>$commit),
7843 -title => "history"}, 'H');
7845 $file = esc_path($file);
7846 print "] ".
7847 "$file</li>\n";
7849 if ($format eq 'rss') {
7850 print "</ul>]]>\n" .
7851 "</content:encoded>\n" .
7852 "</item>\n";
7853 } elsif ($format eq 'atom') {
7854 print "</ul>\n</div>\n" .
7855 "</content>\n" .
7856 "</entry>\n";
7860 # end of feed
7861 if ($format eq 'rss') {
7862 print "</channel>\n</rss>\n";
7863 } elsif ($format eq 'atom') {
7864 print "</feed>\n";
7868 sub git_rss {
7869 git_feed('rss');
7872 sub git_atom {
7873 git_feed('atom');
7876 sub git_opml {
7877 my @list = git_get_projects_list();
7878 if (!@list) {
7879 die_error(404, "No projects found");
7882 print $cgi->header(
7883 -type => 'text/xml',
7884 -charset => 'utf-8',
7885 -content_disposition => 'inline; filename="opml.xml"');
7887 my $title = esc_html($site_name);
7888 print <<XML;
7889 <?xml version="1.0" encoding="utf-8"?>
7890 <opml version="1.0">
7891 <head>
7892 <title>$title OPML Export</title>
7893 </head>
7894 <body>
7895 <outline text="git RSS feeds">
7898 foreach my $pr (@list) {
7899 my %proj = %$pr;
7900 my $head = git_get_head_hash($proj{'path'});
7901 if (!defined $head) {
7902 next;
7904 $git_dir = "$projectroot/$proj{'path'}";
7905 my %co = parse_commit($head);
7906 if (!%co) {
7907 next;
7910 my $path = esc_html(chop_str($proj{'path'}, 25, 5));
7911 my $rss = href('project' => $proj{'path'}, 'action' => 'rss', -full => 1);
7912 my $html = href('project' => $proj{'path'}, 'action' => 'summary', -full => 1);
7913 print "<outline type=\"rss\" text=\"$path\" title=\"$path\" xmlUrl=\"$rss\" htmlUrl=\"$html\"/>\n";
7915 print <<XML;
7916 </outline>
7917 </body>
7918 </opml>