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_receive", call => \&rcs_receive);
32 if (! defined $config{gitorigin_branch}) {
33 $config{gitorigin_branch}="origin";
35 if (! defined $config{gitmaster_branch}) {
36 $config{gitmaster_branch}="master";
38 if (defined $config{git_wrapper} &&
39 length $config{git_wrapper}) {
40 push @{$config{wrappers}}, {
41 wrapper => $config{git_wrapper},
42 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
46 if (defined $config{git_test_receive_wrapper} &&
47 length $config{git_test_receive_wrapper}) {
48 push @{$config{wrappers}}, {
50 wrapper => $config{git_test_receive_wrapper},
51 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
55 # Avoid notes, parser does not handle and they only slow things down.
56 $ENV{GIT_NOTES_REF}="";
58 # Run receive test only if being called by the wrapper, and not
59 # when generating same.
60 if ($config{test_receive} && ! exists $config{wrapper}) {
61 require IkiWiki::Receive;
62 IkiWiki::Receive::test();
69 safe => 0, # rcs plugin
74 example => "/git/wiki.git/hooks/post-update",
75 description => "git hook to generate",
82 description => "mode for git_wrapper (can safely be made suid)",
86 git_test_receive_wrapper => {
88 example => "/git/wiki.git/hooks/pre-receive",
89 description => "git pre-receive hook to generate",
93 untrusted_committers => {
96 description => "unix users whose commits should be checked by the pre-receive hook",
102 example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
103 description => "gitweb url to show file history ([[file]] substituted)",
109 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]]",
110 description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",
114 gitorigin_branch => {
117 description => "where to pull and push changes (set to empty string to disable)",
118 safe => 0, # paranoia
121 gitmaster_branch => {
124 description => "branch that the wiki is stored in",
125 safe => 0, # paranoia
131 if ($config{test_receive}) {
132 require IkiWiki::Receive;
133 return IkiWiki::Receive::genwrapper();
141 # Start a child process safely without resorting /bin/sh.
142 # Return command output or success state (in scalar context).
144 my ($error_handler, @cmdline) = @_;
146 my $pid = open my $OUT, "-|";
148 error("Cannot fork: $!") if !defined $pid;
152 # Git commands want to be in wc.
154 chdir $config{srcdir}
155 or error("Cannot chdir to $config{srcdir}: $!");
157 exec @cmdline or error("Cannot exec '@cmdline': $!");
161 # git output is probably utf-8 encoded, but may contain
162 # other encodings or invalidly encoded stuff. So do not rely
163 # on the normal utf-8 IO layer, decode it by hand.
168 $_=decode_utf8($_, 0);
177 $error_handler->("'@cmdline' failed: $!") if $? && $error_handler;
179 return wantarray ? @lines : ($? == 0);
181 # Convenient wrappers.
182 sub run_or_die ($@) { safe_git(\&error, @_) }
183 sub run_or_cry ($@) { safe_git(sub { warn @_ }, @_) }
184 sub run_or_non ($@) { safe_git(undef, @_) }
187 sub merge_past ($$$) {
188 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
189 # Git merge commands work with the committed changes, except in the
190 # implicit case of '-m' of git checkout(1). So we should invent a
191 # kludge here. In principle, we need to create a throw-away branch
192 # in preparing for the merge itself. Since branches are cheap (and
193 # branching is fast), this shouldn't cost high.
195 # The main problem is the presence of _uncommitted_ local changes. One
196 # possible approach to get rid of this situation could be that we first
197 # make a temporary commit in the master branch and later restore the
198 # initial state (this is possible since Git has the ability to undo a
199 # commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
202 # - create a diff of HEAD:current-sha1
204 # - create a dummy branch and switch to it
205 # - rewind to past (reset --hard to the current-sha1)
206 # - apply the diff and commit
207 # - switch to master and do the merge with the dummy branch
208 # - make a soft reset (undo the last commit of master)
210 # The above method has some drawbacks: (1) it needs a redundant commit
211 # just to get rid of local changes, (2) somewhat slow because of the
212 # required system forks. Until someone points a more straight method
213 # (which I would be grateful) I have implemented an alternative method.
214 # In this approach, we hide all the modified files from Git by renaming
215 # them (using the 'rename' builtin) and later restore those files in
216 # the throw-away branch (that is, we put the files themselves instead
217 # of applying a patch).
219 my ($sha1, $file, $message) = @_;
221 my @undo; # undo stack for cleanup in case of an error
222 my $conflict; # file content with conflict markers
225 # Hide local changes from Git by renaming the modified file.
226 # Relative paths must be converted to absolute for renaming.
227 my ($target, $hidden) = (
228 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
230 rename($target, $hidden)
231 or error("rename '$target' to '$hidden' failed: $!");
232 # Ensure to restore the renamed file on error.
234 return if ! -e "$hidden"; # already renamed
235 rename($hidden, $target)
236 or warn "rename '$hidden' to '$target' failed: $!";
239 my $branch = "throw_away_${sha1}"; # supposed to be unique
241 # Create a throw-away branch and rewind backward.
242 push @undo, sub { run_or_cry('git', 'branch', '-D', $branch) };
243 run_or_die('git', 'branch', $branch, $sha1);
245 # Switch to throw-away branch for the merge operation.
247 if (!run_or_cry('git', 'checkout', $config{gitmaster_branch})) {
248 run_or_cry('git', 'checkout','-f',$config{gitmaster_branch});
251 run_or_die('git', 'checkout', $branch);
253 # Put the modified file in _this_ branch.
254 rename($hidden, $target)
255 or error("rename '$hidden' to '$target' failed: $!");
257 # _Silently_ commit all modifications in the current branch.
258 run_or_non('git', 'commit', '-m', $message, '-a');
259 # ... and re-switch to master.
260 run_or_die('git', 'checkout', $config{gitmaster_branch});
262 # Attempt to merge without complaining.
263 if (!run_or_non('git', 'pull', '--no-commit', '.', $branch)) {
264 $conflict = readfile($target);
265 run_or_die('git', 'reset', '--hard');
270 # Process undo stack (in reverse order). By policy cleanup
271 # actions should normally print a warning on failure.
272 while (my $handle = pop @undo) {
276 error("Git merge failed!\n$failure\n") if $failure;
281 sub parse_diff_tree ($@) {
282 # Parse the raw diff tree chunk and return the info hash.
283 # See git-diff-tree(1) for the syntax.
285 my ($prefix, $dt_ref) = @_;
288 return if !defined @{ $dt_ref } ||
289 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];
293 while (my $line = shift @{ $dt_ref }) {
294 return if $line !~ m/^(.+) ($sha1_pattern)/;
301 # Identification lines for the commit.
302 while (my $line = shift @{ $dt_ref }) {
303 # Regexps are semi-stolen from gitweb.cgi.
304 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
307 elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
308 # XXX: collecting in reverse order
309 push @{ $ci{'parents'} }, $1;
311 elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
312 my ($who, $name, $epoch, $tz) =
316 $ci{ "${who}_epoch" } = $epoch;
317 $ci{ "${who}_tz" } = $tz;
319 if ($name =~ m/^[^<]+\s+<([^@>]+)/) {
320 $ci{"${who}_username"} = $1;
322 elsif ($name =~ m/^([^<]+)\s+<>$/) {
323 $ci{"${who}_username"} = $1;
326 $ci{"${who}_username"} = $name;
329 elsif ($line =~ m/^$/) {
330 # Trailing empty line signals next section.
335 debug("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
337 if (defined $ci{'parents'}) {
338 $ci{'parent'} = @{ $ci{'parents'} }[0];
341 $ci{'parent'} = 0 x 40;
344 # Commit message (optional).
345 while ($dt_ref->[0] =~ /^ /) {
346 my $line = shift @{ $dt_ref };
348 push @{ $ci{'comment'} }, $line;
350 shift @{ $dt_ref } if $dt_ref->[0] =~ /^$/;
353 while (my $line = shift @{ $dt_ref }) {
355 (:+) # number of parents
356 ([^\t]+)\t # modes, sha1, status
359 my $num_parents = length $1;
360 my @tmp = split(" ", $2);
361 my ($file, $file_to) = split("\t", $3);
362 my @mode_from = splice(@tmp, 0, $num_parents);
363 my $mode_to = shift(@tmp);
364 my @sha1_from = splice(@tmp, 0, $num_parents);
365 my $sha1_to = shift(@tmp);
366 my $status = shift(@tmp);
368 # git does not output utf-8 filenames, but instead
369 # double-quotes them with the utf-8 characters
370 # escaped as \nnn\nnn.
371 if ($file =~ m/^"(.*)"$/) {
372 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
374 $file =~ s/^\Q$prefix\E//;
376 push @{ $ci{'details'} }, {
377 'file' => decode("utf8", $file),
378 'sha1_from' => $sha1_from[0],
379 'sha1_to' => $sha1_to,
380 'mode_from' => $mode_from[0],
381 'mode_to' => $mode_to,
393 sub git_commit_info ($;$) {
394 # Return an array of commit info hashes of num commits
395 # starting from the given sha1sum.
396 my ($sha1, $num) = @_;
399 push @opts, "--max-count=$num" if defined $num;
401 my @raw_lines = run_or_die('git', 'log', @opts,
402 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
403 '-r', $sha1, '--', '.');
404 my ($prefix) = run_or_die('git', 'rev-parse', '--show-prefix');
407 while (my $parsed = parse_diff_tree(($prefix or ""), \@raw_lines)) {
411 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
413 return wantarray ? @ci : $ci[0];
417 # Return head sha1sum (of given file).
418 my $file = shift || q{--};
420 # Ignore error since a non-existing file might be given.
421 my ($sha1) = run_or_non('git', 'rev-list', '--max-count=1', 'HEAD',
424 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
427 debug("Empty sha1sum for '$file'.");
429 return defined $sha1 ? $sha1 : q{};
433 # Update working directory.
435 if (length $config{gitorigin_branch}) {
436 run_or_cry('git', 'pull', $config{gitorigin_branch});
440 sub rcs_prepedit ($) {
441 # Return the commit sha1sum of the file when editing begins.
442 # This will be later used in rcs_commit if a merge is required.
445 return git_sha1($file);
448 sub rcs_commit ($$$;$$) {
449 # Try to commit the page; returns undef on _success_ and
450 # a version of the page with the rcs's conflict markers on
453 my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
455 # Check to see if the page has been changed by someone else since
456 # rcs_prepedit was called.
457 my $cur = git_sha1($file);
458 my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
460 if (defined $cur && defined $prev && $cur ne $prev) {
461 my $conflict = merge_past($prev, $file, $dummy_commit_msg);
462 return $conflict if defined $conflict;
466 return rcs_commit_staged($message, $user, $ipaddr);
469 sub rcs_commit_staged ($$$) {
470 # Commits all staged changes. Changes can be staged using rcs_add,
471 # rcs_remove, and rcs_rename.
472 my ($message, $user, $ipaddr)=@_;
474 # Set the commit author and email to the web committer.
476 if (defined $user || defined $ipaddr) {
477 my $u=encode_utf8(defined $user ? $user : $ipaddr);
478 $ENV{GIT_AUTHOR_NAME}=$u;
479 $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
482 $message = IkiWiki::possibly_foolish_untaint($message);
484 if ($message !~ /\S/) {
485 # Force git to allow empty commit messages.
486 # (If this version of git supports it.)
487 my ($version)=`git --version` =~ /git version (.*)/;
488 if ($version ge "1.5.4") {
489 push @opts, '--cleanup=verbatim';
496 # git commit returns non-zero if file has not been really changed.
497 # so we should ignore its exit status (hence run_or_non).
498 if (run_or_non('git', 'commit', @opts, '-m', $message)) {
499 if (length $config{gitorigin_branch}) {
500 run_or_cry('git', 'push', $config{gitorigin_branch});
505 return undef; # success
509 # Add file to archive.
513 run_or_cry('git', 'add', $file);
517 # Remove file from archive.
521 run_or_cry('git', 'rm', '-f', $file);
524 sub rcs_rename ($$) {
525 my ($src, $dest) = @_;
527 run_or_cry('git', 'mv', '-f', $src, $dest);
530 sub rcs_recentchanges ($) {
531 # List of recent changes.
535 eval q{use Date::Parse};
539 foreach my $ci (git_commit_info('HEAD', $num || 1)) {
540 # Skip redundant commits.
541 next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
543 my ($sha1, $when) = (
545 $ci->{'author_epoch'}
549 foreach my $detail (@{ $ci->{'details'} }) {
550 my $file = $detail->{'file'};
552 my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
553 $diffurl =~ s/\[\[file\]\]/$file/go;
554 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
555 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
556 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
557 $diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
560 page => pagename($file),
567 foreach my $line (@{$ci->{'comment'}}) {
568 $pastblank=1 if $line eq '';
569 next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
570 push @messages, { line => $line };
573 my $user=$ci->{'author_username'};
574 my $web_commit = ($ci->{'author'} =~ /\@web>/);
576 # compatability code for old web commit messages
578 defined $messages[0] &&
579 $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
580 $user = defined $2 ? "$2" : "$3";
581 $messages[0]->{line} = $4;
588 committype => $web_commit ? "web" : "git",
590 message => [@messages],
594 last if @rets >= $num;
602 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
604 foreach my $line (run_or_non("git", "show", $sha1)) {
605 if (@lines || $line=~/^diff --git/) {
606 push @lines, $line."\n";
613 return join("", @lines);
617 sub rcs_getctime ($) {
619 # Remove srcdir prefix
620 $file =~ s/^\Q$config{srcdir}\E\/?//;
622 my @raw_lines = run_or_die('git', 'log',
623 '--follow', '--no-merges',
624 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
627 while (my $parsed = parse_diff_tree("", \@raw_lines)) {
630 my $ctime = $ci[$#ci]->{'author_epoch'};
631 debug("ctime for '$file': ". localtime($ctime));
637 # The wiki may not be the only thing in the git repo.
638 # Determine if it is in a subdirectory by examining the srcdir,
639 # and its parents, looking for the .git directory.
641 my $dir=$config{srcdir};
642 while (! -d "$dir/.git") {
643 $subdir=IkiWiki::basename($dir)."/".$subdir;
644 $dir=IkiWiki::dirname($dir);
646 error("cannot determine root of git repo");
653 my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
655 # only allow changes to gitmaster_branch
656 if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
657 error sprintf(gettext("you are not allowed to change %s"), $refname);
660 # Avoid chdir when running git here, because the changes
661 # are in the master git repo, not the srcdir repo.
662 # The pre-recieve hook already puts us in the right place.
664 my @changes=git_commit_info($oldrev."..".$newrev);
667 foreach my $ci (@changes) {
668 foreach my $detail (@{ $ci->{'details'} }) {
669 my $file = $detail->{'file'};
671 # check that all changed files are in the
673 if (length $subdir &&
674 ! ($file =~ s/^\Q$subdir\E//)) {
675 error sprintf(gettext("you are not allowed to change %s"), $file);
678 my ($action, $mode, $path);
679 if ($detail->{'status'} =~ /^[M]+\d*$/) {
681 $mode=$detail->{'mode_to'};
683 elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
685 $mode=$detail->{'mode_to'};
687 elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
689 $mode=$detail->{'mode_from'};
692 error "unknown status ".$detail->{'status'};
695 # test that the file mode is ok
696 if ($mode !~ /^100[64][64][64]$/) {
697 error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
699 if ($action eq "change") {
700 if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
701 error gettext("you are not allowed to change file modes");
705 # extract attachment to temp file
706 if (($action eq 'add' || $action eq 'change') &&
708 eval q{use File::Temp};
711 ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
712 if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
713 error("failed writing temp file");
726 return reverse @rets;