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);
30 hook(type => "rcs", id => "rcs_preprevert", call => \&rcs_preprevert);
31 hook(type => "rcs", id => "rcs_revert", call => \&rcs_revert);
35 if (! defined $config{gitorigin_branch}) {
36 $config{gitorigin_branch}="origin";
38 if (! defined $config{gitmaster_branch}) {
39 $config{gitmaster_branch}="master";
41 if (defined $config{git_wrapper} &&
42 length $config{git_wrapper}) {
43 push @{$config{wrappers}}, {
44 wrapper => $config{git_wrapper},
45 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
46 wrapper_background_command => $config{git_wrapper_background_command},
50 if (defined $config{git_test_receive_wrapper} &&
51 length $config{git_test_receive_wrapper} &&
52 defined $config{untrusted_committers} &&
53 @{$config{untrusted_committers}}) {
54 push @{$config{wrappers}}, {
56 wrapper => $config{git_test_receive_wrapper},
57 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
61 # Avoid notes, parser does not handle and they only slow things down.
62 $ENV{GIT_NOTES_REF}="";
64 # Run receive test only if being called by the wrapper, and not
65 # when generating same.
66 if ($config{test_receive} && ! exists $config{wrapper}) {
67 require IkiWiki::Receive;
68 IkiWiki::Receive::test();
75 safe => 0, # rcs plugin
81 example => "/git/wiki.git/hooks/post-update",
82 description => "git hook to generate",
86 git_wrapper_background_command => {
88 example => "git push github",
89 description => "shell command for git_wrapper to run, in the background",
96 description => "mode for git_wrapper (can safely be made suid)",
100 git_test_receive_wrapper => {
102 example => "/git/wiki.git/hooks/pre-receive",
103 description => "git pre-receive hook to generate",
107 untrusted_committers => {
110 description => "unix users whose commits should be checked by the pre-receive hook",
116 example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]];hb=HEAD",
117 description => "gitweb url to show file history ([[file]] substituted)",
123 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]]",
124 description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",
128 gitorigin_branch => {
131 description => "where to pull and push changes (set to empty string to disable)",
132 safe => 0, # paranoia
135 gitmaster_branch => {
138 description => "branch that the wiki is stored in",
139 safe => 0, # paranoia
145 if ($config{test_receive}) {
146 require IkiWiki::Receive;
147 return IkiWiki::Receive::genwrapper();
155 # Start a child process safely without resorting /bin/sh.
156 # Return command output or success state (in scalar context).
158 my ($error_handler, @cmdline) = @_;
160 my $pid = open my $OUT, "-|";
162 error("Cannot fork: $!") if !defined $pid;
166 # Git commands want to be in wc.
168 chdir $config{srcdir}
169 or error("Cannot chdir to $config{srcdir}: $!");
171 exec @cmdline or error("Cannot exec '@cmdline': $!");
175 # git output is probably utf-8 encoded, but may contain
176 # other encodings or invalidly encoded stuff. So do not rely
177 # on the normal utf-8 IO layer, decode it by hand.
182 $_=decode_utf8($_, 0);
191 $error_handler->("'@cmdline' failed: $!") if $? && $error_handler;
193 return wantarray ? @lines : ($? == 0);
195 # Convenient wrappers.
196 sub run_or_die ($@) { safe_git(\&error, @_) }
197 sub run_or_cry ($@) { safe_git(sub { warn @_ }, @_) }
198 sub run_or_non ($@) { safe_git(undef, @_) }
201 sub merge_past ($$$) {
202 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
203 # Git merge commands work with the committed changes, except in the
204 # implicit case of '-m' of git checkout(1). So we should invent a
205 # kludge here. In principle, we need to create a throw-away branch
206 # in preparing for the merge itself. Since branches are cheap (and
207 # branching is fast), this shouldn't cost high.
209 # The main problem is the presence of _uncommitted_ local changes. One
210 # possible approach to get rid of this situation could be that we first
211 # make a temporary commit in the master branch and later restore the
212 # initial state (this is possible since Git has the ability to undo a
213 # commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
216 # - create a diff of HEAD:current-sha1
218 # - create a dummy branch and switch to it
219 # - rewind to past (reset --hard to the current-sha1)
220 # - apply the diff and commit
221 # - switch to master and do the merge with the dummy branch
222 # - make a soft reset (undo the last commit of master)
224 # The above method has some drawbacks: (1) it needs a redundant commit
225 # just to get rid of local changes, (2) somewhat slow because of the
226 # required system forks. Until someone points a more straight method
227 # (which I would be grateful) I have implemented an alternative method.
228 # In this approach, we hide all the modified files from Git by renaming
229 # them (using the 'rename' builtin) and later restore those files in
230 # the throw-away branch (that is, we put the files themselves instead
231 # of applying a patch).
233 my ($sha1, $file, $message) = @_;
235 my @undo; # undo stack for cleanup in case of an error
236 my $conflict; # file content with conflict markers
239 # Hide local changes from Git by renaming the modified file.
240 # Relative paths must be converted to absolute for renaming.
241 my ($target, $hidden) = (
242 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
244 rename($target, $hidden)
245 or error("rename '$target' to '$hidden' failed: $!");
246 # Ensure to restore the renamed file on error.
248 return if ! -e "$hidden"; # already renamed
249 rename($hidden, $target)
250 or warn "rename '$hidden' to '$target' failed: $!";
253 my $branch = "throw_away_${sha1}"; # supposed to be unique
255 # Create a throw-away branch and rewind backward.
256 push @undo, sub { run_or_cry('git', 'branch', '-D', $branch) };
257 run_or_die('git', 'branch', $branch, $sha1);
259 # Switch to throw-away branch for the merge operation.
261 if (!run_or_cry('git', 'checkout', $config{gitmaster_branch})) {
262 run_or_cry('git', 'checkout','-f',$config{gitmaster_branch});
265 run_or_die('git', 'checkout', $branch);
267 # Put the modified file in _this_ branch.
268 rename($hidden, $target)
269 or error("rename '$hidden' to '$target' failed: $!");
271 # _Silently_ commit all modifications in the current branch.
272 run_or_non('git', 'commit', '-m', $message, '-a');
273 # ... and re-switch to master.
274 run_or_die('git', 'checkout', $config{gitmaster_branch});
276 # Attempt to merge without complaining.
277 if (!run_or_non('git', 'pull', '--no-commit', '.', $branch)) {
278 $conflict = readfile($target);
279 run_or_die('git', 'reset', '--hard');
284 # Process undo stack (in reverse order). By policy cleanup
285 # actions should normally print a warning on failure.
286 while (my $handle = pop @undo) {
290 error("Git merge failed!\n$failure\n") if $failure;
297 sub decode_git_file ($) {
300 # git does not output utf-8 filenames, but instead
301 # double-quotes them with the utf-8 characters
302 # escaped as \nnn\nnn.
303 if ($file =~ m/^"(.*)"$/) {
304 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
307 # strip prefix if in a subdir
308 if (! defined $prefix) {
309 ($prefix) = run_or_die('git', 'rev-parse', '--show-prefix');
310 if (! defined $prefix) {
314 $file =~ s/^\Q$prefix\E//;
316 return decode("utf8", $file);
320 sub parse_diff_tree ($) {
321 # Parse the raw diff tree chunk and return the info hash.
322 # See git-diff-tree(1) for the syntax.
326 return if !defined @{ $dt_ref } ||
327 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];
331 while (my $line = shift @{ $dt_ref }) {
332 return if $line !~ m/^(.+) ($sha1_pattern)/;
339 # Identification lines for the commit.
340 while (my $line = shift @{ $dt_ref }) {
341 # Regexps are semi-stolen from gitweb.cgi.
342 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
345 elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
346 # XXX: collecting in reverse order
347 push @{ $ci{'parents'} }, $1;
349 elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
350 my ($who, $name, $epoch, $tz) =
354 $ci{ "${who}_epoch" } = $epoch;
355 $ci{ "${who}_tz" } = $tz;
357 if ($name =~ m/^([^<]+)\s+<([^@>]+)/) {
358 $ci{"${who}_name"} = $1;
359 $ci{"${who}_username"} = $2;
361 elsif ($name =~ m/^([^<]+)\s+<>$/) {
362 $ci{"${who}_username"} = $1;
365 $ci{"${who}_username"} = $name;
368 elsif ($line =~ m/^$/) {
369 # Trailing empty line signals next section.
374 debug("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
376 if (defined $ci{'parents'}) {
377 $ci{'parent'} = @{ $ci{'parents'} }[0];
380 $ci{'parent'} = 0 x 40;
383 # Commit message (optional).
384 while ($dt_ref->[0] =~ /^ /) {
385 my $line = shift @{ $dt_ref };
387 push @{ $ci{'comment'} }, $line;
389 shift @{ $dt_ref } if $dt_ref->[0] =~ /^$/;
392 while (my $line = shift @{ $dt_ref }) {
394 (:+) # number of parents
395 ([^\t]+)\t # modes, sha1, status
398 my $num_parents = length $1;
399 my @tmp = split(" ", $2);
400 my ($file, $file_to) = split("\t", $3);
401 my @mode_from = splice(@tmp, 0, $num_parents);
402 my $mode_to = shift(@tmp);
403 my @sha1_from = splice(@tmp, 0, $num_parents);
404 my $sha1_to = shift(@tmp);
405 my $status = shift(@tmp);
408 push @{ $ci{'details'} }, {
409 'file' => decode_git_file($file),
410 'sha1_from' => $sha1_from[0],
411 'sha1_to' => $sha1_to,
412 'mode_from' => $mode_from[0],
413 'mode_to' => $mode_to,
425 sub git_commit_info ($;$) {
426 # Return an array of commit info hashes of num commits
427 # starting from the given sha1sum.
428 my ($sha1, $num) = @_;
431 push @opts, "--max-count=$num" if defined $num;
433 my @raw_lines = run_or_die('git', 'log', @opts,
434 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
435 '-r', $sha1, '--', '.');
438 while (my $parsed = parse_diff_tree(\@raw_lines)) {
442 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
444 return wantarray ? @ci : $ci[0];
448 # Return head sha1sum (of given file).
449 my $file = shift || q{--};
451 # Ignore error since a non-existing file might be given.
452 my ($sha1) = run_or_non('git', 'rev-list', '--max-count=1', 'HEAD',
455 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
458 debug("Empty sha1sum for '$file'.");
460 return defined $sha1 ? $sha1 : q{};
464 # Update working directory.
466 if (length $config{gitorigin_branch}) {
467 run_or_cry('git', 'pull', '--prune', $config{gitorigin_branch});
471 sub rcs_prepedit ($) {
472 # Return the commit sha1sum of the file when editing begins.
473 # This will be later used in rcs_commit if a merge is required.
476 return git_sha1($file);
480 # Try to commit the page; returns undef on _success_ and
481 # a version of the page with the rcs's conflict markers on
485 # Check to see if the page has been changed by someone else since
486 # rcs_prepedit was called.
487 my $cur = git_sha1($params{file});
488 my ($prev) = $params{token} =~ /^($sha1_pattern)$/; # untaint
490 if (defined $cur && defined $prev && $cur ne $prev) {
491 my $conflict = merge_past($prev, $params{file}, $dummy_commit_msg);
492 return $conflict if defined $conflict;
495 rcs_add($params{file});
496 return rcs_commit_staged(
497 message => $params{message},
498 session => $params{session},
502 sub rcs_commit_staged (@) {
503 # Commits all staged changes. Changes can be staged using rcs_add,
504 # rcs_remove, and rcs_rename.
509 if (defined $params{session}) {
510 # Set the commit author and email based on web session info.
512 if (defined $params{session}->param("name")) {
513 $u=$params{session}->param("name");
515 elsif (defined $params{session}->remote_addr()) {
516 $u=$params{session}->remote_addr();
520 $ENV{GIT_AUTHOR_NAME}=$u;
522 if (defined $params{session}->param("nickname")) {
523 $u=encode_utf8($params{session}->param("nickname"));
525 $u=~s/[^-_0-9[:alnum:]]+//g;
528 $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
532 $params{message} = IkiWiki::possibly_foolish_untaint($params{message});
534 if ($params{message} !~ /\S/) {
535 # Force git to allow empty commit messages.
536 # (If this version of git supports it.)
537 my ($version)=`git --version` =~ /git version (.*)/;
538 if ($version ge "1.5.4") {
539 push @opts, '--cleanup=verbatim';
542 $params{message}.=".";
546 # git commit returns non-zero if file has not been really changed.
547 # so we should ignore its exit status (hence run_or_non).
548 if (run_or_non('git', 'commit', @opts, '-m', $params{message})) {
549 if (length $config{gitorigin_branch}) {
550 run_or_cry('git', 'push', $config{gitorigin_branch});
555 return undef; # success
559 # Add file to archive.
563 run_or_cry('git', 'add', $file);
567 # Remove file from archive.
571 run_or_cry('git', 'rm', '-f', $file);
574 sub rcs_rename ($$) {
575 my ($src, $dest) = @_;
577 run_or_cry('git', 'mv', '-f', $src, $dest);
580 sub rcs_recentchanges ($) {
581 # List of recent changes.
585 eval q{use Date::Parse};
589 foreach my $ci (git_commit_info('HEAD', $num || 1)) {
590 # Skip redundant commits.
591 next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
593 my ($sha1, $when) = (
595 $ci->{'author_epoch'}
599 foreach my $detail (@{ $ci->{'details'} }) {
600 my $file = $detail->{'file'};
602 my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
603 $diffurl =~ s/\[\[file\]\]/$file/go;
604 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
605 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
606 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
607 $diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
610 page => pagename($file),
617 foreach my $line (@{$ci->{'comment'}}) {
618 $pastblank=1 if $line eq '';
619 next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
620 push @messages, { line => $line };
623 my $user=$ci->{'author_username'};
624 my $web_commit = ($ci->{'author'} =~ /\@web>/);
627 # Set nickname only if a non-url author_username is available,
628 # and author_name is an url.
629 if ($user !~ /:\/\// && defined $ci->{'author_name'} &&
630 $ci->{'author_name'} =~ /:\/\//) {
632 $user=$ci->{'author_name'};
635 # compatability code for old web commit messages
637 defined $messages[0] &&
638 $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
639 $user = defined $2 ? "$2" : "$3";
640 $messages[0]->{line} = $4;
647 nickname => $nickname,
648 committype => $web_commit ? "web" : "git",
650 message => [@messages],
654 last if @rets >= $num;
662 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
664 foreach my $line (run_or_non("git", "show", $sha1)) {
665 if (@lines || $line=~/^diff --git/) {
666 push @lines, $line."\n";
673 return join("", @lines);
682 my $id=shift; # 0 = mtime ; 1 = ctime
684 if (! keys %time_cache) {
686 foreach my $line (run_or_die('git', 'log',
687 '--pretty=format:%ct',
688 '--name-only', '--relative')) {
689 if (! defined $date && $line =~ /^(\d+)$/) {
692 elsif (! length $line) {
696 my $f=decode_git_file($line);
698 if (! $time_cache{$f}) {
699 $time_cache{$f}[0]=$date; # mtime
701 $time_cache{$f}[1]=$date; # ctime
706 return exists $time_cache{$file} ? $time_cache{$file}[$id] : 0;
711 sub rcs_getctime ($) {
714 return findtimes($file, 1);
717 sub rcs_getmtime ($) {
720 return findtimes($file, 0);
727 # The wiki may not be the only thing in the git repo.
728 # Determine if it is in a subdirectory by examining the srcdir,
729 # and its parents, looking for the .git directory.
731 return $git_root if defined $git_root;
734 my $dir=$config{srcdir};
735 while (! -d "$dir/.git") {
736 $subdir=IkiWiki::basename($dir)."/".$subdir;
737 $dir=IkiWiki::dirname($dir);
739 error("cannot determine root of git repo");
743 return $git_root=$subdir;
748 sub git_parse_changes {
751 my $subdir = git_find_root();
753 foreach my $ci (@changes) {
754 foreach my $detail (@{ $ci->{'details'} }) {
755 my $file = $detail->{'file'};
757 # check that all changed files are in the subdir
758 if (length $subdir &&
759 ! ($file =~ s/^\Q$subdir\E//)) {
760 error sprintf(gettext("you are not allowed to change %s"), $file);
763 my ($action, $mode, $path);
764 if ($detail->{'status'} =~ /^[M]+\d*$/) {
766 $mode=$detail->{'mode_to'};
768 elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
770 $mode=$detail->{'mode_to'};
772 elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
774 $mode=$detail->{'mode_from'};
777 error "unknown status ".$detail->{'status'};
780 # test that the file mode is ok
781 if ($mode !~ /^100[64][64][64]$/) {
782 error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
784 if ($action eq "change") {
785 if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
786 error gettext("you are not allowed to change file modes");
790 # extract attachment to temp file
791 if (($action eq 'add' || $action eq 'change') &&
793 eval q{use File::Temp};
796 ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
797 # Ensure we run this in the right place,
798 # see comments in rcs_receive.
799 my $cmd = ($no_chdir ? '' : "cd $config{srcdir} && ")
800 . "git show $detail->{sha1_to} > '$path'";
801 if (system($cmd) != 0) {
802 error("failed writing temp file '$path'.");
821 my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
823 # only allow changes to gitmaster_branch
824 if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
825 error sprintf(gettext("you are not allowed to change %s"), $refname);
828 # Avoid chdir when running git here, because the changes
829 # are in the master git repo, not the srcdir repo.
830 # The pre-receive hook already puts us in the right place.
832 push @rets, git_parse_changes(git_commit_info($oldrev."..".$newrev));
836 return reverse @rets;
839 sub rcs_preprevert (@) {
841 my $rev = $params{rev};
843 # Note test_changes expects 'cgi' and 'session' parameters.
844 require IkiWiki::Receive;
845 IkiWiki::Receive::test_changes(%params, changes =>
846 [git_parse_changes(git_commit_info($rev, 1))]);
850 # Try to revert the given rev; returns undef on _success_.
853 if (run_or_non('git', 'revert', '--no-commit', $rev)) {
857 run_or_die('git', 'reset', '--hard');
858 return sprintf(gettext("Failed to revert commit %s"), $rev);