2 package IkiWiki::Plugin::git;
8 use open qw{:utf8 :std};
10 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums
11 my $dummy_commit_msg = 'dummy commit'; # message to skip in recent changes
15 hook(type => "checkconfig", id => "git", call => \&checkconfig);
16 hook(type => "getsetup", id => "git", call => \&getsetup);
17 hook(type => "genwrapper", id => "git", call => \&genwrapper);
18 hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
19 hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
20 hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
21 hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
22 hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
23 hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
24 hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
25 hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
26 hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
27 hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
28 hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
29 hook(type => "rcs", id => "rcs_receive", call => \&rcs_receive);
33 if (! defined $config{gitorigin_branch}) {
34 $config{gitorigin_branch}="origin";
36 if (! defined $config{gitmaster_branch}) {
37 $config{gitmaster_branch}="master";
39 if (defined $config{git_wrapper} &&
40 length $config{git_wrapper}) {
41 push @{$config{wrappers}}, {
42 wrapper => $config{git_wrapper},
43 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
47 if (defined $config{git_test_receive_wrapper} &&
48 length $config{git_test_receive_wrapper}) {
49 push @{$config{wrappers}}, {
51 wrapper => $config{git_test_receive_wrapper},
52 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
56 # Avoid notes, parser does not handle and they only slow things down.
57 $ENV{GIT_NOTES_REF}="";
59 # Run receive test only if being called by the wrapper, and not
60 # when generating same.
61 if ($config{test_receive} && ! exists $config{wrapper}) {
62 require IkiWiki::Receive;
63 IkiWiki::Receive::test();
70 safe => 0, # rcs plugin
76 example => "/git/wiki.git/hooks/post-update",
77 description => "git hook to generate",
84 description => "mode for git_wrapper (can safely be made suid)",
88 git_test_receive_wrapper => {
90 example => "/git/wiki.git/hooks/pre-receive",
91 description => "git pre-receive hook to generate",
95 untrusted_committers => {
98 description => "unix users whose commits should be checked by the pre-receive hook",
104 example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
105 description => "gitweb url to show file history ([[file]] substituted)",
111 example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]",
112 description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",
116 gitorigin_branch => {
119 description => "where to pull and push changes (set to empty string to disable)",
120 safe => 0, # paranoia
123 gitmaster_branch => {
126 description => "branch that the wiki is stored in",
127 safe => 0, # paranoia
133 if ($config{test_receive}) {
134 require IkiWiki::Receive;
135 return IkiWiki::Receive::genwrapper();
143 # Start a child process safely without resorting /bin/sh.
144 # Return command output or success state (in scalar context).
146 my ($error_handler, @cmdline) = @_;
148 my $pid = open my $OUT, "-|";
150 error("Cannot fork: $!") if !defined $pid;
154 # Git commands want to be in wc.
156 chdir $config{srcdir}
157 or error("Cannot chdir to $config{srcdir}: $!");
159 exec @cmdline or error("Cannot exec '@cmdline': $!");
163 # git output is probably utf-8 encoded, but may contain
164 # other encodings or invalidly encoded stuff. So do not rely
165 # on the normal utf-8 IO layer, decode it by hand.
170 $_=decode_utf8($_, 0);
179 $error_handler->("'@cmdline' failed: $!") if $? && $error_handler;
181 return wantarray ? @lines : ($? == 0);
183 # Convenient wrappers.
184 sub run_or_die ($@) { safe_git(\&error, @_) }
185 sub run_or_cry ($@) { safe_git(sub { warn @_ }, @_) }
186 sub run_or_non ($@) { safe_git(undef, @_) }
189 sub merge_past ($$$) {
190 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
191 # Git merge commands work with the committed changes, except in the
192 # implicit case of '-m' of git checkout(1). So we should invent a
193 # kludge here. In principle, we need to create a throw-away branch
194 # in preparing for the merge itself. Since branches are cheap (and
195 # branching is fast), this shouldn't cost high.
197 # The main problem is the presence of _uncommitted_ local changes. One
198 # possible approach to get rid of this situation could be that we first
199 # make a temporary commit in the master branch and later restore the
200 # initial state (this is possible since Git has the ability to undo a
201 # commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
204 # - create a diff of HEAD:current-sha1
206 # - create a dummy branch and switch to it
207 # - rewind to past (reset --hard to the current-sha1)
208 # - apply the diff and commit
209 # - switch to master and do the merge with the dummy branch
210 # - make a soft reset (undo the last commit of master)
212 # The above method has some drawbacks: (1) it needs a redundant commit
213 # just to get rid of local changes, (2) somewhat slow because of the
214 # required system forks. Until someone points a more straight method
215 # (which I would be grateful) I have implemented an alternative method.
216 # In this approach, we hide all the modified files from Git by renaming
217 # them (using the 'rename' builtin) and later restore those files in
218 # the throw-away branch (that is, we put the files themselves instead
219 # of applying a patch).
221 my ($sha1, $file, $message) = @_;
223 my @undo; # undo stack for cleanup in case of an error
224 my $conflict; # file content with conflict markers
227 # Hide local changes from Git by renaming the modified file.
228 # Relative paths must be converted to absolute for renaming.
229 my ($target, $hidden) = (
230 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
232 rename($target, $hidden)
233 or error("rename '$target' to '$hidden' failed: $!");
234 # Ensure to restore the renamed file on error.
236 return if ! -e "$hidden"; # already renamed
237 rename($hidden, $target)
238 or warn "rename '$hidden' to '$target' failed: $!";
241 my $branch = "throw_away_${sha1}"; # supposed to be unique
243 # Create a throw-away branch and rewind backward.
244 push @undo, sub { run_or_cry('git', 'branch', '-D', $branch) };
245 run_or_die('git', 'branch', $branch, $sha1);
247 # Switch to throw-away branch for the merge operation.
249 if (!run_or_cry('git', 'checkout', $config{gitmaster_branch})) {
250 run_or_cry('git', 'checkout','-f',$config{gitmaster_branch});
253 run_or_die('git', 'checkout', $branch);
255 # Put the modified file in _this_ branch.
256 rename($hidden, $target)
257 or error("rename '$hidden' to '$target' failed: $!");
259 # _Silently_ commit all modifications in the current branch.
260 run_or_non('git', 'commit', '-m', $message, '-a');
261 # ... and re-switch to master.
262 run_or_die('git', 'checkout', $config{gitmaster_branch});
264 # Attempt to merge without complaining.
265 if (!run_or_non('git', 'pull', '--no-commit', '.', $branch)) {
266 $conflict = readfile($target);
267 run_or_die('git', 'reset', '--hard');
272 # Process undo stack (in reverse order). By policy cleanup
273 # actions should normally print a warning on failure.
274 while (my $handle = pop @undo) {
278 error("Git merge failed!\n$failure\n") if $failure;
283 sub parse_diff_tree ($@) {
284 # Parse the raw diff tree chunk and return the info hash.
285 # See git-diff-tree(1) for the syntax.
287 my ($prefix, $dt_ref) = @_;
290 return if !defined @{ $dt_ref } ||
291 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];
295 while (my $line = shift @{ $dt_ref }) {
296 return if $line !~ m/^(.+) ($sha1_pattern)/;
303 # Identification lines for the commit.
304 while (my $line = shift @{ $dt_ref }) {
305 # Regexps are semi-stolen from gitweb.cgi.
306 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
309 elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
310 # XXX: collecting in reverse order
311 push @{ $ci{'parents'} }, $1;
313 elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
314 my ($who, $name, $epoch, $tz) =
318 $ci{ "${who}_epoch" } = $epoch;
319 $ci{ "${who}_tz" } = $tz;
321 if ($name =~ m/^[^<]+\s+<([^@>]+)/) {
322 $ci{"${who}_username"} = $1;
324 elsif ($name =~ m/^([^<]+)\s+<>$/) {
325 $ci{"${who}_username"} = $1;
328 $ci{"${who}_username"} = $name;
331 elsif ($line =~ m/^$/) {
332 # Trailing empty line signals next section.
337 debug("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
339 if (defined $ci{'parents'}) {
340 $ci{'parent'} = @{ $ci{'parents'} }[0];
343 $ci{'parent'} = 0 x 40;
346 # Commit message (optional).
347 while ($dt_ref->[0] =~ /^ /) {
348 my $line = shift @{ $dt_ref };
350 push @{ $ci{'comment'} }, $line;
352 shift @{ $dt_ref } if $dt_ref->[0] =~ /^$/;
355 while (my $line = shift @{ $dt_ref }) {
357 (:+) # number of parents
358 ([^\t]+)\t # modes, sha1, status
361 my $num_parents = length $1;
362 my @tmp = split(" ", $2);
363 my ($file, $file_to) = split("\t", $3);
364 my @mode_from = splice(@tmp, 0, $num_parents);
365 my $mode_to = shift(@tmp);
366 my @sha1_from = splice(@tmp, 0, $num_parents);
367 my $sha1_to = shift(@tmp);
368 my $status = shift(@tmp);
370 # git does not output utf-8 filenames, but instead
371 # double-quotes them with the utf-8 characters
372 # escaped as \nnn\nnn.
373 if ($file =~ m/^"(.*)"$/) {
374 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
376 $file =~ s/^\Q$prefix\E//;
378 push @{ $ci{'details'} }, {
379 'file' => decode("utf8", $file),
380 'sha1_from' => $sha1_from[0],
381 'sha1_to' => $sha1_to,
382 'mode_from' => $mode_from[0],
383 'mode_to' => $mode_to,
395 sub git_commit_info ($;$) {
396 # Return an array of commit info hashes of num commits
397 # starting from the given sha1sum.
398 my ($sha1, $num) = @_;
401 push @opts, "--max-count=$num" if defined $num;
403 my @raw_lines = run_or_die('git', 'log', @opts,
404 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
405 '-r', $sha1, '--', '.');
406 my ($prefix) = run_or_die('git', 'rev-parse', '--show-prefix');
409 while (my $parsed = parse_diff_tree(($prefix or ""), \@raw_lines)) {
413 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
415 return wantarray ? @ci : $ci[0];
419 # Return head sha1sum (of given file).
420 my $file = shift || q{--};
422 # Ignore error since a non-existing file might be given.
423 my ($sha1) = run_or_non('git', 'rev-list', '--max-count=1', 'HEAD',
426 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
429 debug("Empty sha1sum for '$file'.");
431 return defined $sha1 ? $sha1 : q{};
435 # Update working directory.
437 if (length $config{gitorigin_branch}) {
438 run_or_cry('git', 'pull', $config{gitorigin_branch});
442 sub rcs_prepedit ($) {
443 # Return the commit sha1sum of the file when editing begins.
444 # This will be later used in rcs_commit if a merge is required.
447 return git_sha1($file);
450 sub rcs_commit ($$$;$$) {
451 # Try to commit the page; returns undef on _success_ and
452 # a version of the page with the rcs's conflict markers on
455 my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
457 # Check to see if the page has been changed by someone else since
458 # rcs_prepedit was called.
459 my $cur = git_sha1($file);
460 my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
462 if (defined $cur && defined $prev && $cur ne $prev) {
463 my $conflict = merge_past($prev, $file, $dummy_commit_msg);
464 return $conflict if defined $conflict;
468 return rcs_commit_staged($message, $user, $ipaddr);
471 sub rcs_commit_staged ($$$) {
472 # Commits all staged changes. Changes can be staged using rcs_add,
473 # rcs_remove, and rcs_rename.
474 my ($message, $user, $ipaddr)=@_;
476 # Set the commit author and email to the web committer.
478 if (defined $user || defined $ipaddr) {
479 my $u=encode_utf8(defined $user ? $user : $ipaddr);
480 $ENV{GIT_AUTHOR_NAME}=$u;
481 $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
484 $message = IkiWiki::possibly_foolish_untaint($message);
486 if ($message !~ /\S/) {
487 # Force git to allow empty commit messages.
488 # (If this version of git supports it.)
489 my ($version)=`git --version` =~ /git version (.*)/;
490 if ($version ge "1.5.4") {
491 push @opts, '--cleanup=verbatim';
498 # git commit returns non-zero if file has not been really changed.
499 # so we should ignore its exit status (hence run_or_non).
500 if (run_or_non('git', 'commit', @opts, '-m', $message)) {
501 if (length $config{gitorigin_branch}) {
502 run_or_cry('git', 'push', $config{gitorigin_branch});
507 return undef; # success
511 # Add file to archive.
515 run_or_cry('git', 'add', $file);
519 # Remove file from archive.
523 run_or_cry('git', 'rm', '-f', $file);
526 sub rcs_rename ($$) {
527 my ($src, $dest) = @_;
529 run_or_cry('git', 'mv', '-f', $src, $dest);
532 sub rcs_recentchanges ($) {
533 # List of recent changes.
537 eval q{use Date::Parse};
541 foreach my $ci (git_commit_info('HEAD', $num || 1)) {
542 # Skip redundant commits.
543 next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
545 my ($sha1, $when) = (
547 $ci->{'author_epoch'}
551 foreach my $detail (@{ $ci->{'details'} }) {
552 my $file = $detail->{'file'};
554 my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
555 $diffurl =~ s/\[\[file\]\]/$file/go;
556 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
557 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
558 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
559 $diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
562 page => pagename($file),
569 foreach my $line (@{$ci->{'comment'}}) {
570 $pastblank=1 if $line eq '';
571 next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
572 push @messages, { line => $line };
575 my $user=$ci->{'author_username'};
576 my $web_commit = ($ci->{'author'} =~ /\@web>/);
578 # compatability code for old web commit messages
580 defined $messages[0] &&
581 $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
582 $user = defined $2 ? "$2" : "$3";
583 $messages[0]->{line} = $4;
590 committype => $web_commit ? "web" : "git",
592 message => [@messages],
596 last if @rets >= $num;
604 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
606 foreach my $line (run_or_non("git", "show", $sha1)) {
607 if (@lines || $line=~/^diff --git/) {
608 push @lines, $line."\n";
615 return join("", @lines);
624 my $id=shift; # 0 = mtime ; 1 = ctime
626 # Remove srcdir prefix
627 $file =~ s/^\Q$config{srcdir}\E\/?//;
629 if (! keys %time_cache) {
631 foreach my $line (run_or_die('git', 'log',
632 '--pretty=format:%ct',
633 '--name-only', '--relative')) {
634 if (! defined $date && $line =~ /^(\d+)$/) {
637 elsif (! length $line) {
641 if (! $time_cache{$line}) {
642 $time_cache{$line}[0]=$date; # mtime
644 $time_cache{$line}[1]=$date; # ctime
649 return exists $time_cache{$file} ? $time_cache{$file}[$id] : 0;
654 sub rcs_getctime ($) {
657 return findtimes($file, 1);
660 sub rcs_getmtime ($) {
663 return findtimes($file, 0);
667 # The wiki may not be the only thing in the git repo.
668 # Determine if it is in a subdirectory by examining the srcdir,
669 # and its parents, looking for the .git directory.
671 my $dir=$config{srcdir};
672 while (! -d "$dir/.git") {
673 $subdir=IkiWiki::basename($dir)."/".$subdir;
674 $dir=IkiWiki::dirname($dir);
676 error("cannot determine root of git repo");
683 my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
685 # only allow changes to gitmaster_branch
686 if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
687 error sprintf(gettext("you are not allowed to change %s"), $refname);
690 # Avoid chdir when running git here, because the changes
691 # are in the master git repo, not the srcdir repo.
692 # The pre-recieve hook already puts us in the right place.
694 my @changes=git_commit_info($oldrev."..".$newrev);
697 foreach my $ci (@changes) {
698 foreach my $detail (@{ $ci->{'details'} }) {
699 my $file = $detail->{'file'};
701 # check that all changed files are in the
703 if (length $subdir &&
704 ! ($file =~ s/^\Q$subdir\E//)) {
705 error sprintf(gettext("you are not allowed to change %s"), $file);
708 my ($action, $mode, $path);
709 if ($detail->{'status'} =~ /^[M]+\d*$/) {
711 $mode=$detail->{'mode_to'};
713 elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
715 $mode=$detail->{'mode_to'};
717 elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
719 $mode=$detail->{'mode_from'};
722 error "unknown status ".$detail->{'status'};
725 # test that the file mode is ok
726 if ($mode !~ /^100[64][64][64]$/) {
727 error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
729 if ($action eq "change") {
730 if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
731 error gettext("you are not allowed to change file modes");
735 # extract attachment to temp file
736 if (($action eq 'add' || $action eq 'change') &&
738 eval q{use File::Temp};
741 ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
742 if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
743 error("failed writing temp file");
756 return reverse @rets;