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);
30 sub checkconfig () { #{{{
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 => "0755",
54 sub getsetup () { #{{{
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;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
98 description => "gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] 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
118 sub safe_git (&@) { #{{{
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': $!");
147 $error_handler->("'@cmdline' failed: $!") if $? && $error_handler;
149 return wantarray ? @lines : ($? == 0);
151 # Convenient wrappers.
152 sub run_or_die ($@) { safe_git(\&error, @_) }
153 sub run_or_cry ($@) { safe_git(sub { warn @_ }, @_) }
154 sub run_or_non ($@) { safe_git(undef, @_) }
157 sub merge_past ($$$) { #{{{
158 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
159 # Git merge commands work with the committed changes, except in the
160 # implicit case of '-m' of git checkout(1). So we should invent a
161 # kludge here. In principle, we need to create a throw-away branch
162 # in preparing for the merge itself. Since branches are cheap (and
163 # branching is fast), this shouldn't cost high.
165 # The main problem is the presence of _uncommitted_ local changes. One
166 # possible approach to get rid of this situation could be that we first
167 # make a temporary commit in the master branch and later restore the
168 # initial state (this is possible since Git has the ability to undo a
169 # commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
172 # - create a diff of HEAD:current-sha1
174 # - create a dummy branch and switch to it
175 # - rewind to past (reset --hard to the current-sha1)
176 # - apply the diff and commit
177 # - switch to master and do the merge with the dummy branch
178 # - make a soft reset (undo the last commit of master)
180 # The above method has some drawbacks: (1) it needs a redundant commit
181 # just to get rid of local changes, (2) somewhat slow because of the
182 # required system forks. Until someone points a more straight method
183 # (which I would be grateful) I have implemented an alternative method.
184 # In this approach, we hide all the modified files from Git by renaming
185 # them (using the 'rename' builtin) and later restore those files in
186 # the throw-away branch (that is, we put the files themselves instead
187 # of applying a patch).
189 my ($sha1, $file, $message) = @_;
191 my @undo; # undo stack for cleanup in case of an error
192 my $conflict; # file content with conflict markers
195 # Hide local changes from Git by renaming the modified file.
196 # Relative paths must be converted to absolute for renaming.
197 my ($target, $hidden) = (
198 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
200 rename($target, $hidden)
201 or error("rename '$target' to '$hidden' failed: $!");
202 # Ensure to restore the renamed file on error.
204 return if ! -e "$hidden"; # already renamed
205 rename($hidden, $target)
206 or warn "rename '$hidden' to '$target' failed: $!";
209 my $branch = "throw_away_${sha1}"; # supposed to be unique
211 # Create a throw-away branch and rewind backward.
212 push @undo, sub { run_or_cry('git', 'branch', '-D', $branch) };
213 run_or_die('git', 'branch', $branch, $sha1);
215 # Switch to throw-away branch for the merge operation.
217 if (!run_or_cry('git', 'checkout', $config{gitmaster_branch})) {
218 run_or_cry('git', 'checkout','-f',$config{gitmaster_branch});
221 run_or_die('git', 'checkout', $branch);
223 # Put the modified file in _this_ branch.
224 rename($hidden, $target)
225 or error("rename '$hidden' to '$target' failed: $!");
227 # _Silently_ commit all modifications in the current branch.
228 run_or_non('git', 'commit', '-m', $message, '-a');
229 # ... and re-switch to master.
230 run_or_die('git', 'checkout', $config{gitmaster_branch});
232 # Attempt to merge without complaining.
233 if (!run_or_non('git', 'pull', '--no-commit', '.', $branch)) {
234 $conflict = readfile($target);
235 run_or_die('git', 'reset', '--hard');
240 # Process undo stack (in reverse order). By policy cleanup
241 # actions should normally print a warning on failure.
242 while (my $handle = pop @undo) {
246 error("Git merge failed!\n$failure\n") if $failure;
251 sub parse_diff_tree ($@) { #{{{
252 # Parse the raw diff tree chunk and return the info hash.
253 # See git-diff-tree(1) for the syntax.
255 my ($prefix, $dt_ref) = @_;
258 return if !defined @{ $dt_ref } ||
259 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];
263 while (my $line = shift @{ $dt_ref }) {
264 return if $line !~ m/^(.+) ($sha1_pattern)/;
271 # Identification lines for the commit.
272 while (my $line = shift @{ $dt_ref }) {
273 # Regexps are semi-stolen from gitweb.cgi.
274 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
277 elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
278 # XXX: collecting in reverse order
279 push @{ $ci{'parents'} }, $1;
281 elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
282 my ($who, $name, $epoch, $tz) =
286 $ci{ "${who}_epoch" } = $epoch;
287 $ci{ "${who}_tz" } = $tz;
289 if ($name =~ m/^[^<]+\s+<([^@>]+)/) {
290 $ci{"${who}_username"} = $1;
292 elsif ($name =~ m/^([^<]+)\s+<>$/) {
293 $ci{"${who}_username"} = $1;
296 $ci{"${who}_username"} = $name;
299 elsif ($line =~ m/^$/) {
300 # Trailing empty line signals next section.
305 debug("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
307 if (defined $ci{'parents'}) {
308 $ci{'parent'} = @{ $ci{'parents'} }[0];
311 $ci{'parent'} = 0 x 40;
314 # Commit message (optional).
315 while ($dt_ref->[0] =~ /^ /) {
316 my $line = shift @{ $dt_ref };
318 push @{ $ci{'comment'} }, $line;
320 shift @{ $dt_ref } if $dt_ref->[0] =~ /^$/;
323 while (my $line = shift @{ $dt_ref }) {
325 (:+) # number of parents
326 ([^\t]+)\t # modes, sha1, status
329 my $num_parents = length $1;
330 my @tmp = split(" ", $2);
331 my ($file, $file_to) = split("\t", $3);
332 my @mode_from = splice(@tmp, 0, $num_parents);
333 my $mode_to = shift(@tmp);
334 my @sha1_from = splice(@tmp, 0, $num_parents);
335 my $sha1_to = shift(@tmp);
336 my $status = shift(@tmp);
338 # git does not output utf-8 filenames, but instead
339 # double-quotes them with the utf-8 characters
340 # escaped as \nnn\nnn.
341 if ($file =~ m/^"(.*)"$/) {
342 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
344 $file =~ s/^\Q$prefix\E//;
346 push @{ $ci{'details'} }, {
347 'file' => decode("utf8", $file),
348 'sha1_from' => $sha1_from[0],
349 'sha1_to' => $sha1_to,
350 'mode_from' => $mode_from[0],
351 'mode_to' => $mode_to,
363 sub git_commit_info ($;$) { #{{{
364 # Return an array of commit info hashes of num commits
365 # starting from the given sha1sum.
366 my ($sha1, $num) = @_;
368 my @raw_lines = run_or_die('git', 'log',
369 (defined $num ? "--max-count=$num" : ""),
370 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
371 '-r', $sha1, '--', '.');
372 my ($prefix) = run_or_die('git', 'rev-parse', '--show-prefix');
375 while (my $parsed = parse_diff_tree(($prefix or ""), \@raw_lines)) {
379 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
381 return wantarray ? @ci : $ci[0];
384 sub git_sha1 (;$) { #{{{
385 # Return head sha1sum (of given file).
386 my $file = shift || q{--};
388 # Ignore error since a non-existing file might be given.
389 my ($sha1) = run_or_non('git', 'rev-list', '--max-count=1', 'HEAD',
392 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
393 } else { debug("Empty sha1sum for '$file'.") }
394 return defined $sha1 ? $sha1 : q{};
397 sub rcs_update () { #{{{
398 # Update working directory.
400 if (length $config{gitorigin_branch}) {
401 run_or_cry('git', 'pull', $config{gitorigin_branch});
405 sub rcs_prepedit ($) { #{{{
406 # Return the commit sha1sum of the file when editing begins.
407 # This will be later used in rcs_commit if a merge is required.
410 return git_sha1($file);
413 sub rcs_commit ($$$;$$) { #{{{
414 # Try to commit the page; returns undef on _success_ and
415 # a version of the page with the rcs's conflict markers on
418 my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
420 # Check to see if the page has been changed by someone else since
421 # rcs_prepedit was called.
422 my $cur = git_sha1($file);
423 my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
425 if (defined $cur && defined $prev && $cur ne $prev) {
426 my $conflict = merge_past($prev, $file, $dummy_commit_msg);
427 return $conflict if defined $conflict;
431 return rcs_commit_staged($message, $user, $ipaddr);
434 sub rcs_commit_staged ($$$) {
435 # Commits all staged changes. Changes can be staged using rcs_add,
436 # rcs_remove, and rcs_rename.
437 my ($message, $user, $ipaddr)=@_;
439 # Set the commit author and email to the web committer.
441 if (defined $user || defined $ipaddr) {
442 my $u=defined $user ? $user : $ipaddr;
443 $ENV{GIT_AUTHOR_NAME}=$u;
444 $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
447 $message = IkiWiki::possibly_foolish_untaint($message);
449 if ($message !~ /\S/) {
450 # Force git to allow empty commit messages.
451 # (If this version of git supports it.)
452 my ($version)=`git --version` =~ /git version (.*)/;
453 if ($version ge "1.5.4") {
454 push @opts, '--cleanup=verbatim';
461 # git commit returns non-zero if file has not been really changed.
462 # so we should ignore its exit status (hence run_or_non).
463 if (run_or_non('git', 'commit', @opts, '-m', $message)) {
464 if (length $config{gitorigin_branch}) {
465 run_or_cry('git', 'push', $config{gitorigin_branch});
470 return undef; # success
473 sub rcs_add ($) { # {{{
474 # Add file to archive.
478 run_or_cry('git', 'add', $file);
481 sub rcs_remove ($) { # {{{
482 # Remove file from archive.
486 run_or_cry('git', 'rm', '-f', $file);
489 sub rcs_rename ($$) { # {{{
490 my ($src, $dest) = @_;
492 run_or_cry('git', 'mv', '-f', $src, $dest);
495 sub rcs_recentchanges ($) { #{{{
496 # List of recent changes.
500 eval q{use Date::Parse};
504 foreach my $ci (git_commit_info('HEAD', $num || 1)) {
505 # Skip redundant commits.
506 next if ($ci->{'comment'} && @{$ci->{'comment'}}[0] eq $dummy_commit_msg);
508 my ($sha1, $when) = (
510 $ci->{'author_epoch'}
514 foreach my $detail (@{ $ci->{'details'} }) {
515 my $file = $detail->{'file'};
517 my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
518 $diffurl =~ s/\[\[file\]\]/$file/go;
519 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
520 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
521 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
524 page => pagename($file),
531 foreach my $line (@{$ci->{'comment'}}) {
532 $pastblank=1 if $line eq '';
533 next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
534 push @messages, { line => $line };
537 my $user=$ci->{'author_username'};
538 my $web_commit = ($ci->{'author'} =~ /\@web>/);
540 # compatability code for old web commit messages
542 defined $messages[0] &&
543 $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
544 $user = defined $2 ? "$2" : "$3";
545 $messages[0]->{line} = $4;
552 committype => $web_commit ? "web" : "git",
554 message => [@messages],
558 last if @rets >= $num;
564 sub rcs_diff ($) { #{{{
566 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
568 foreach my $line (run_or_non("git", "show", $sha1)) {
569 if (@lines || $line=~/^diff --git/) {
570 push @lines, $line."\n";
577 return join("", @lines);
581 sub rcs_getctime ($) { #{{{
583 # Remove srcdir prefix
584 $file =~ s/^\Q$config{srcdir}\E\/?//;
586 my $sha1 = git_sha1($file);
587 my $ci = git_commit_info($sha1, 1);
588 my $ctime = $ci->{'author_epoch'};
589 debug("ctime for '$file': ". localtime($ctime));
594 sub rcs_receive () { #{{{
595 # The wiki may not be the only thing in the git repo.
596 # Determine if it is in a subdirectory by examining the srcdir,
597 # and its parents, looking for the .git directory.
599 my $dir=$config{srcdir};
600 while (! -d "$dir/.git") {
601 $subdir=IkiWiki::basename($dir)."/".$subdir;
602 $dir=IkiWiki::dirname($dir);
604 error("cannot determine root of git repo");
611 my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
613 # only allow changes to gitmaster_branch
614 if ($refname !~ /^refs\/heads\/\Q$config{gitmaster_branch}\E$/) {
615 error sprintf(gettext("you are not allowed to change %s"), $refname);
618 # Avoid chdir when running git here, because the changes
619 # are in the master git repo, not the srcdir repo.
620 # The pre-recieve hook already puts us in the right place.
622 my @changes=git_commit_info($oldrev."..".$newrev);
625 foreach my $ci (@changes) {
626 foreach my $detail (@{ $ci->{'details'} }) {
627 my $file = $detail->{'file'};
629 # check that all changed files are in the
631 if (length $subdir &&
632 ! ($file =~ s/^\Q$subdir\E//)) {
633 error sprintf(gettext("you are not allowed to change %s"), $file);
636 my ($action, $mode, $path);
637 if ($detail->{'status'} =~ /^[M]+\d*$/) {
639 $mode=$detail->{'mode_to'};
641 elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
643 $mode=$detail->{'mode_to'};
644 if (! pagetype($file)) {
645 eval q{use File::Temp};
648 ($fh, $path)=tempfile("XXXXXXXXXX", UNLINK => 1);
649 if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
650 error("failed writing temp file");
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");