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 => "rcs", id => "rcs_update", call => \&rcs_update);
18 hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
19 hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
20 hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
21 hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
22 hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
23 hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
24 hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
25 hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
26 hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
27 hook(type => "rcs", id => "rcs_receive", call => \&rcs_receive);
31 if (! defined $config{gitorigin_branch}) {
32 $config{gitorigin_branch}="origin";
34 if (! defined $config{gitmaster_branch}) {
35 $config{gitmaster_branch}="master";
37 if (defined $config{git_wrapper} &&
38 length $config{git_wrapper}) {
39 push @{$config{wrappers}}, {
40 wrapper => $config{git_wrapper},
41 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
44 if (defined $config{git_test_receive_wrapper} &&
45 length $config{git_test_receive_wrapper}) {
46 push @{$config{wrappers}}, {
48 wrapper => $config{git_test_receive_wrapper},
49 wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
57 safe => 0, # rcs plugin
62 example => "/git/wiki.git/hooks/post-update",
63 description => "git hook to generate",
70 description => "mode for git_wrapper (can safely be made suid)",
74 git_test_receive_wrapper => {
76 example => "/git/wiki.git/hooks/pre-receive",
77 description => "git pre-receive hook to generate",
81 untrusted_committers => {
84 description => "unix users whose commits should be checked by the pre-receive hook",
90 example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
91 description => "gitweb url to show file history ([[file]] substituted)",
97 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]]",
98 description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",
102 gitorigin_branch => {
105 description => "where to pull and push changes (set to empty string to disable)",
106 safe => 0, # paranoia
109 gitmaster_branch => {
112 description => "branch that the wiki is stored in",
113 safe => 0, # paranoia
119 # Start a child process safely without resorting /bin/sh.
120 # Return command output or success state (in scalar context).
122 my ($error_handler, @cmdline) = @_;
124 my $pid = open my $OUT, "-|";
126 error("Cannot fork: $!") if !defined $pid;
130 # Git commands want to be in wc.
132 chdir $config{srcdir}
133 or error("Cannot chdir to $config{srcdir}: $!");
135 exec @cmdline or error("Cannot exec '@cmdline': $!");
143 # check for invalid utf-8, and toss it back to avoid crashes
144 if (! utf8::valid($_)) {
153 $error_handler->("'@cmdline' failed: $!") if $? && $error_handler;
155 return wantarray ? @lines : ($? == 0);
157 # Convenient wrappers.
158 sub run_or_die ($@) { safe_git(\&error, @_) }
159 sub run_or_cry ($@) { safe_git(sub { warn @_ }, @_) }
160 sub run_or_non ($@) { safe_git(undef, @_) }
163 sub merge_past ($$$) {
164 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
165 # Git merge commands work with the committed changes, except in the
166 # implicit case of '-m' of git checkout(1). So we should invent a
167 # kludge here. In principle, we need to create a throw-away branch
168 # in preparing for the merge itself. Since branches are cheap (and
169 # branching is fast), this shouldn't cost high.
171 # The main problem is the presence of _uncommitted_ local changes. One
172 # possible approach to get rid of this situation could be that we first
173 # make a temporary commit in the master branch and later restore the
174 # initial state (this is possible since Git has the ability to undo a
175 # commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
178 # - create a diff of HEAD:current-sha1
180 # - create a dummy branch and switch to it
181 # - rewind to past (reset --hard to the current-sha1)
182 # - apply the diff and commit
183 # - switch to master and do the merge with the dummy branch
184 # - make a soft reset (undo the last commit of master)
186 # The above method has some drawbacks: (1) it needs a redundant commit
187 # just to get rid of local changes, (2) somewhat slow because of the
188 # required system forks. Until someone points a more straight method
189 # (which I would be grateful) I have implemented an alternative method.
190 # In this approach, we hide all the modified files from Git by renaming
191 # them (using the 'rename' builtin) and later restore those files in
192 # the throw-away branch (that is, we put the files themselves instead
193 # of applying a patch).
195 my ($sha1, $file, $message) = @_;
197 my @undo; # undo stack for cleanup in case of an error
198 my $conflict; # file content with conflict markers
201 # Hide local changes from Git by renaming the modified file.
202 # Relative paths must be converted to absolute for renaming.
203 my ($target, $hidden) = (
204 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
206 rename($target, $hidden)
207 or error("rename '$target' to '$hidden' failed: $!");
208 # Ensure to restore the renamed file on error.
210 return if ! -e "$hidden"; # already renamed
211 rename($hidden, $target)
212 or warn "rename '$hidden' to '$target' failed: $!";
215 my $branch = "throw_away_${sha1}"; # supposed to be unique
217 # Create a throw-away branch and rewind backward.
218 push @undo, sub { run_or_cry('git', 'branch', '-D', $branch) };
219 run_or_die('git', 'branch', $branch, $sha1);
221 # Switch to throw-away branch for the merge operation.
223 if (!run_or_cry('git', 'checkout', $config{gitmaster_branch})) {
224 run_or_cry('git', 'checkout','-f',$config{gitmaster_branch});
227 run_or_die('git', 'checkout', $branch);
229 # Put the modified file in _this_ branch.
230 rename($hidden, $target)
231 or error("rename '$hidden' to '$target' failed: $!");
233 # _Silently_ commit all modifications in the current branch.
234 run_or_non('git', 'commit', '-m', $message, '-a');
235 # ... and re-switch to master.
236 run_or_die('git', 'checkout', $config{gitmaster_branch});
238 # Attempt to merge without complaining.
239 if (!run_or_non('git', 'pull', '--no-commit', '.', $branch)) {
240 $conflict = readfile($target);
241 run_or_die('git', 'reset', '--hard');
246 # Process undo stack (in reverse order). By policy cleanup
247 # actions should normally print a warning on failure.
248 while (my $handle = pop @undo) {
252 error("Git merge failed!\n$failure\n") if $failure;
257 sub parse_diff_tree ($@) {
258 # Parse the raw diff tree chunk and return the info hash.
259 # See git-diff-tree(1) for the syntax.
261 my ($prefix, $dt_ref) = @_;
264 return if !defined @{ $dt_ref } ||
265 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];
269 while (my $line = shift @{ $dt_ref }) {
270 return if $line !~ m/^(.+) ($sha1_pattern)/;
277 # Identification lines for the commit.
278 while (my $line = shift @{ $dt_ref }) {
279 # Regexps are semi-stolen from gitweb.cgi.
280 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
283 elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
284 # XXX: collecting in reverse order
285 push @{ $ci{'parents'} }, $1;
287 elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
288 my ($who, $name, $epoch, $tz) =
292 $ci{ "${who}_epoch" } = $epoch;
293 $ci{ "${who}_tz" } = $tz;
295 if ($name =~ m/^[^<]+\s+<([^@>]+)/) {
296 $ci{"${who}_username"} = $1;
298 elsif ($name =~ m/^([^<]+)\s+<>$/) {
299 $ci{"${who}_username"} = $1;
302 $ci{"${who}_username"} = $name;
305 elsif ($line =~ m/^$/) {
306 # Trailing empty line signals next section.
311 debug("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
313 if (defined $ci{'parents'}) {
314 $ci{'parent'} = @{ $ci{'parents'} }[0];
317 $ci{'parent'} = 0 x 40;
320 # Commit message (optional).
321 while ($dt_ref->[0] =~ /^ /) {
322 my $line = shift @{ $dt_ref };
324 push @{ $ci{'comment'} }, $line;
326 shift @{ $dt_ref } if $dt_ref->[0] =~ /^$/;
329 while (my $line = shift @{ $dt_ref }) {
331 (:+) # number of parents
332 ([^\t]+)\t # modes, sha1, status
335 my $num_parents = length $1;
336 my @tmp = split(" ", $2);
337 my ($file, $file_to) = split("\t", $3);
338 my @mode_from = splice(@tmp, 0, $num_parents);
339 my $mode_to = shift(@tmp);
340 my @sha1_from = splice(@tmp, 0, $num_parents);
341 my $sha1_to = shift(@tmp);
342 my $status = shift(@tmp);
344 # git does not output utf-8 filenames, but instead
345 # double-quotes them with the utf-8 characters
346 # escaped as \nnn\nnn.
347 if ($file =~ m/^"(.*)"$/) {
348 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
350 $file =~ s/^\Q$prefix\E//;
352 push @{ $ci{'details'} }, {
353 'file' => decode("utf8", $file),
354 'sha1_from' => $sha1_from[0],
355 'sha1_to' => $sha1_to,
356 'mode_from' => $mode_from[0],
357 'mode_to' => $mode_to,
369 sub git_commit_info ($;$) {
370 # Return an array of commit info hashes of num commits
371 # starting from the given sha1sum.
372 my ($sha1, $num) = @_;
375 push @opts, "--max-count=$num" if defined $num;
377 my @raw_lines = run_or_die('git', 'log', @opts,
378 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
379 '-r', $sha1, '--', '.');
380 my ($prefix) = run_or_die('git', 'rev-parse', '--show-prefix');
383 while (my $parsed = parse_diff_tree(($prefix or ""), \@raw_lines)) {
387 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
389 return wantarray ? @ci : $ci[0];
393 # Return head sha1sum (of given file).
394 my $file = shift || q{--};
396 # Ignore error since a non-existing file might be given.
397 my ($sha1) = run_or_non('git', 'rev-list', '--max-count=1', 'HEAD',
400 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
401 } else { debug("Empty sha1sum for '$file'.") }
402 return defined $sha1 ? $sha1 : q{};
406 # Update working directory.
408 if (length $config{gitorigin_branch}) {
409 run_or_cry('git', 'pull', $config{gitorigin_branch});
413 sub rcs_prepedit ($) {
414 # Return the commit sha1sum of the file when editing begins.
415 # This will be later used in rcs_commit if a merge is required.
418 return git_sha1($file);
421 sub rcs_commit ($$$;$$) {
422 # Try to commit the page; returns undef on _success_ and
423 # a version of the page with the rcs's conflict markers on
426 my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
428 # Check to see if the page has been changed by someone else since
429 # rcs_prepedit was called.
430 my $cur = git_sha1($file);
431 my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
433 if (defined $cur && defined $prev && $cur ne $prev) {
434 my $conflict = merge_past($prev, $file, $dummy_commit_msg);
435 return $conflict if defined $conflict;
439 return rcs_commit_staged($message, $user, $ipaddr);
442 sub rcs_commit_staged ($$$) {
443 # Commits all staged changes. Changes can be staged using rcs_add,
444 # rcs_remove, and rcs_rename.
445 my ($message, $user, $ipaddr)=@_;
447 # Set the commit author and email to the web committer.
449 if (defined $user || defined $ipaddr) {
450 my $u=defined $user ? $user : $ipaddr;
451 $ENV{GIT_AUTHOR_NAME}=$u;
452 $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
455 $message = IkiWiki::possibly_foolish_untaint($message);
457 if ($message !~ /\S/) {
458 # Force git to allow empty commit messages.
459 # (If this version of git supports it.)
460 my ($version)=`git --version` =~ /git version (.*)/;
461 if ($version ge "1.5.4") {
462 push @opts, '--cleanup=verbatim';
469 # git commit returns non-zero if file has not been really changed.
470 # so we should ignore its exit status (hence run_or_non).
471 if (run_or_non('git', 'commit', @opts, '-m', $message)) {
472 if (length $config{gitorigin_branch}) {
473 run_or_cry('git', 'push', $config{gitorigin_branch});
478 return undef; # success
482 # Add file to archive.
486 run_or_cry('git', 'add', $file);
490 # Remove file from archive.
494 run_or_cry('git', 'rm', '-f', $file);
497 sub rcs_rename ($$) {
498 my ($src, $dest) = @_;
500 run_or_cry('git', 'mv', '-f', $src, $dest);
503 sub rcs_recentchanges ($) {
504 # List of recent changes.
508 eval q{use Date::Parse};
512 foreach my $ci (git_commit_info('HEAD', $num || 1)) {
513 # Skip redundant commits.
514 next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
516 my ($sha1, $when) = (
518 $ci->{'author_epoch'}
522 foreach my $detail (@{ $ci->{'details'} }) {
523 my $file = $detail->{'file'};
525 my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
526 $diffurl =~ s/\[\[file\]\]/$file/go;
527 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
528 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
529 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
530 $diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
533 page => pagename($file),
540 foreach my $line (@{$ci->{'comment'}}) {
541 $pastblank=1 if $line eq '';
542 next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
543 push @messages, { line => $line };
546 my $user=$ci->{'author_username'};
547 my $web_commit = ($ci->{'author'} =~ /\@web>/);
549 # compatability code for old web commit messages
551 defined $messages[0] &&
552 $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
553 $user = defined $2 ? "$2" : "$3";
554 $messages[0]->{line} = $4;
561 committype => $web_commit ? "web" : "git",
563 message => [@messages],
567 last if @rets >= $num;
575 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
577 foreach my $line (run_or_non("git", "show", $sha1)) {
578 if (@lines || $line=~/^diff --git/) {
579 push @lines, $line."\n";
586 return join("", @lines);
590 sub rcs_getctime ($) {
592 # Remove srcdir prefix
593 $file =~ s/^\Q$config{srcdir}\E\/?//;
595 my $sha1 = git_sha1($file);
596 my $ci = git_commit_info($sha1, 1);
597 my $ctime = $ci->{'author_epoch'};
598 debug("ctime for '$file': ". localtime($ctime));
604 # The wiki may not be the only thing in the git repo.
605 # Determine if it is in a subdirectory by examining the srcdir,
606 # and its parents, looking for the .git directory.
608 my $dir=$config{srcdir};
609 while (! -d "$dir/.git") {
610 $subdir=IkiWiki::basename($dir)."/".$subdir;
611 $dir=IkiWiki::dirname($dir);
613 error("cannot determine root of git repo");
620 my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
622 # only allow changes to gitmaster_branch
623 if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
624 error sprintf(gettext("you are not allowed to change %s"), $refname);
627 # Avoid chdir when running git here, because the changes
628 # are in the master git repo, not the srcdir repo.
629 # The pre-recieve hook already puts us in the right place.
631 my @changes=git_commit_info($oldrev."..".$newrev);
634 foreach my $ci (@changes) {
635 foreach my $detail (@{ $ci->{'details'} }) {
636 my $file = $detail->{'file'};
638 # check that all changed files are in the
640 if (length $subdir &&
641 ! ($file =~ s/^\Q$subdir\E//)) {
642 error sprintf(gettext("you are not allowed to change %s"), $file);
645 my ($action, $mode, $path);
646 if ($detail->{'status'} =~ /^[M]+\d*$/) {
648 $mode=$detail->{'mode_to'};
650 elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
652 $mode=$detail->{'mode_to'};
654 elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
656 $mode=$detail->{'mode_from'};
659 error "unknown status ".$detail->{'status'};
662 # test that the file mode is ok
663 if ($mode !~ /^100[64][64][64]$/) {
664 error sprintf(gettext("you cannot act on a file with mode %s"), $mode);
666 if ($action eq "change") {
667 if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
668 error gettext("you are not allowed to change file modes");
672 # extract attachment to temp file
673 if (($action eq 'add' || $action eq 'change') &&
675 eval q{use File::Temp};
678 ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
679 if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
680 error("failed writing temp file");
693 return reverse @rets;