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 to /bin/sh.
156 # Returns command output (in list content) or success state
157 # (in scalar context), or runs the specified data handler.
159 my ($error_handler, $data_handler, @cmdline) = @_;
161 my $pid = open my $OUT, "-|";
163 error
("Cannot fork: $!") if !defined $pid;
167 # Git commands want to be in wc.
168 if (! defined $git_dir) {
169 chdir $config{srcdir
}
170 or error
("cannot chdir to $config{srcdir}: $!");
174 or error
("cannot chdir to $git_dir: $!");
176 exec @cmdline or error
("Cannot exec '@cmdline': $!");
180 # git output is probably utf-8 encoded, but may contain
181 # other encodings or invalidly encoded stuff. So do not rely
182 # on the normal utf-8 IO layer, decode it by hand.
187 $_=decode_utf8
($_, 0);
191 if (! defined $data_handler) {
195 last unless $data_handler->($_);
201 $error_handler->("'@cmdline' failed: $!") if $?
&& $error_handler;
203 return wantarray ?
@lines : ($?
== 0);
205 # Convenient wrappers.
206 sub run_or_die
($@
) { safe_git
(\
&error
, undef, @_) }
207 sub run_or_cry
($@
) { safe_git
(sub { warn @_ }, undef, @_) }
208 sub run_or_non
($@
) { safe_git
(undef, undef, @_) }
211 sub merge_past
($$$) {
212 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
213 # Git merge commands work with the committed changes, except in the
214 # implicit case of '-m' of git checkout(1). So we should invent a
215 # kludge here. In principle, we need to create a throw-away branch
216 # in preparing for the merge itself. Since branches are cheap (and
217 # branching is fast), this shouldn't cost high.
219 # The main problem is the presence of _uncommitted_ local changes. One
220 # possible approach to get rid of this situation could be that we first
221 # make a temporary commit in the master branch and later restore the
222 # initial state (this is possible since Git has the ability to undo a
223 # commit, i.e. 'git reset --soft HEAD^'). The method can be summarized
226 # - create a diff of HEAD:current-sha1
228 # - create a dummy branch and switch to it
229 # - rewind to past (reset --hard to the current-sha1)
230 # - apply the diff and commit
231 # - switch to master and do the merge with the dummy branch
232 # - make a soft reset (undo the last commit of master)
234 # The above method has some drawbacks: (1) it needs a redundant commit
235 # just to get rid of local changes, (2) somewhat slow because of the
236 # required system forks. Until someone points a more straight method
237 # (which I would be grateful) I have implemented an alternative method.
238 # In this approach, we hide all the modified files from Git by renaming
239 # them (using the 'rename' builtin) and later restore those files in
240 # the throw-away branch (that is, we put the files themselves instead
241 # of applying a patch).
243 my ($sha1, $file, $message) = @_;
245 my @undo; # undo stack for cleanup in case of an error
246 my $conflict; # file content with conflict markers
249 # Hide local changes from Git by renaming the modified file.
250 # Relative paths must be converted to absolute for renaming.
251 my ($target, $hidden) = (
252 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
254 rename($target, $hidden)
255 or error
("rename '$target' to '$hidden' failed: $!");
256 # Ensure to restore the renamed file on error.
258 return if ! -e
"$hidden"; # already renamed
259 rename($hidden, $target)
260 or warn "rename '$hidden' to '$target' failed: $!";
263 my $branch = "throw_away_${sha1}"; # supposed to be unique
265 # Create a throw-away branch and rewind backward.
266 push @undo, sub { run_or_cry
('git', 'branch', '-D', $branch) };
267 run_or_die
('git', 'branch', $branch, $sha1);
269 # Switch to throw-away branch for the merge operation.
271 if (!run_or_cry
('git', 'checkout', $config{gitmaster_branch
})) {
272 run_or_cry
('git', 'checkout','-f',$config{gitmaster_branch
});
275 run_or_die
('git', 'checkout', $branch);
277 # Put the modified file in _this_ branch.
278 rename($hidden, $target)
279 or error
("rename '$hidden' to '$target' failed: $!");
281 # _Silently_ commit all modifications in the current branch.
282 run_or_non
('git', 'commit', '-m', $message, '-a');
283 # ... and re-switch to master.
284 run_or_die
('git', 'checkout', $config{gitmaster_branch
});
286 # Attempt to merge without complaining.
287 if (!run_or_non
('git', 'pull', '--no-commit', '.', $branch)) {
288 $conflict = readfile
($target);
289 run_or_die
('git', 'reset', '--hard');
294 # Process undo stack (in reverse order). By policy cleanup
295 # actions should normally print a warning on failure.
296 while (my $handle = pop @undo) {
300 error
("Git merge failed!\n$failure\n") if $failure;
307 sub decode_git_file
($) {
310 # git does not output utf-8 filenames, but instead
311 # double-quotes them with the utf-8 characters
312 # escaped as \nnn\nnn.
313 if ($file =~ m/^"(.*)"$/) {
314 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
317 # strip prefix if in a subdir
318 if (! defined $prefix) {
319 ($prefix) = run_or_die
('git', 'rev-parse', '--show-prefix');
320 if (! defined $prefix) {
324 $file =~ s/^\Q$prefix\E//;
326 return decode
("utf8", $file);
330 sub parse_diff_tree
($) {
331 # Parse the raw diff tree chunk and return the info hash.
332 # See git-diff-tree(1) for the syntax.
336 return if !defined @
{ $dt_ref } ||
337 !defined @
{ $dt_ref }[0] || !length @
{ $dt_ref }[0];
341 while (my $line = shift @
{ $dt_ref }) {
342 return if $line !~ m/^(.+) ($sha1_pattern)/;
349 # Identification lines for the commit.
350 while (my $line = shift @
{ $dt_ref }) {
351 # Regexps are semi-stolen from gitweb.cgi.
352 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
355 elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
356 # XXX: collecting in reverse order
357 push @
{ $ci{'parents'} }, $1;
359 elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
360 my ($who, $name, $epoch, $tz) =
364 $ci{ "${who}_epoch" } = $epoch;
365 $ci{ "${who}_tz" } = $tz;
367 if ($name =~ m/^([^<]+)\s+<([^@>]+)/) {
368 $ci{"${who}_name"} = $1;
369 $ci{"${who}_username"} = $2;
371 elsif ($name =~ m/^([^<]+)\s+<>$/) {
372 $ci{"${who}_username"} = $1;
375 $ci{"${who}_username"} = $name;
378 elsif ($line =~ m/^$/) {
379 # Trailing empty line signals next section.
384 debug
("No 'tree' seen in diff-tree output") if !defined $ci{'tree'};
386 if (defined $ci{'parents'}) {
387 $ci{'parent'} = @
{ $ci{'parents'} }[0];
390 $ci{'parent'} = 0 x
40;
393 # Commit message (optional).
394 while ($dt_ref->[0] =~ /^ /) {
395 my $line = shift @
{ $dt_ref };
397 push @
{ $ci{'comment'} }, $line;
399 shift @
{ $dt_ref } if $dt_ref->[0] =~ /^$/;
402 while (my $line = shift @
{ $dt_ref }) {
404 (:+) # number of parents
405 ([^\t]+)\t # modes, sha1, status
408 my $num_parents = length $1;
409 my @tmp = split(" ", $2);
410 my ($file, $file_to) = split("\t", $3);
411 my @mode_from = splice(@tmp, 0, $num_parents);
412 my $mode_to = shift(@tmp);
413 my @sha1_from = splice(@tmp, 0, $num_parents);
414 my $sha1_to = shift(@tmp);
415 my $status = shift(@tmp);
418 push @
{ $ci{'details'} }, {
419 'file' => decode_git_file
($file),
420 'sha1_from' => $sha1_from[0],
421 'sha1_to' => $sha1_to,
422 'mode_from' => $mode_from[0],
423 'mode_to' => $mode_to,
435 sub git_commit_info
($;$) {
436 # Return an array of commit info hashes of num commits
437 # starting from the given sha1sum.
438 my ($sha1, $num) = @_;
441 push @opts, "--max-count=$num" if defined $num;
443 my @raw_lines = run_or_die
('git', 'log', @opts,
444 '--pretty=raw', '--raw', '--abbrev=40', '--always', '-c',
445 '-r', $sha1, '--', '.');
448 while (my $parsed = parse_diff_tree
(\
@raw_lines)) {
452 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
454 return wantarray ?
@ci : $ci[0];
458 # Return head sha1sum (of given file).
459 my $file = shift || q{--};
461 # Ignore error since a non-existing file might be given.
462 my ($sha1) = run_or_non
('git', 'rev-list', '--max-count=1', 'HEAD',
465 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
468 debug
("Empty sha1sum for '$file'.");
470 return defined $sha1 ?
$sha1 : q{};
474 # Update working directory.
476 if (length $config{gitorigin_branch
}) {
477 run_or_cry
('git', 'pull', '--prune', $config{gitorigin_branch
});
481 sub rcs_prepedit
($) {
482 # Return the commit sha1sum of the file when editing begins.
483 # This will be later used in rcs_commit if a merge is required.
486 return git_sha1
($file);
490 # Try to commit the page; returns undef on _success_ and
491 # a version of the page with the rcs's conflict markers on
495 # Check to see if the page has been changed by someone else since
496 # rcs_prepedit was called.
497 my $cur = git_sha1
($params{file
});
498 my ($prev) = $params{token
} =~ /^($sha1_pattern)$/; # untaint
500 if (defined $cur && defined $prev && $cur ne $prev) {
501 my $conflict = merge_past
($prev, $params{file
}, $dummy_commit_msg);
502 return $conflict if defined $conflict;
505 return rcs_commit_helper
(@_);
508 sub rcs_commit_staged
(@
) {
509 # Commits all staged changes. Changes can be staged using rcs_add,
510 # rcs_remove, and rcs_rename.
511 return rcs_commit_helper
(@_);
514 sub rcs_commit_helper
(@
) {
519 if (defined $params{session
}) {
520 # Set the commit author and email based on web session info.
522 if (defined $params{session
}->param("name")) {
523 $u=$params{session
}->param("name");
525 elsif (defined $params{session
}->remote_addr()) {
526 $u=$params{session
}->remote_addr();
530 $ENV{GIT_AUTHOR_NAME
}=$u;
532 if (defined $params{session
}->param("nickname")) {
533 $u=encode_utf8
($params{session
}->param("nickname"));
535 $u=~s/[^-_0-9[:alnum:]]+//g;
538 $ENV{GIT_AUTHOR_EMAIL
}="$u\@web";
542 $params{message
} = IkiWiki
::possibly_foolish_untaint
($params{message
});
544 if ($params{message
} !~ /\S/) {
545 # Force git to allow empty commit messages.
546 # (If this version of git supports it.)
547 my ($version)=`git --version` =~ /git version (.*)/;
548 if ($version ge "1.5.4") {
549 push @opts, '--cleanup=verbatim';
552 $params{message
}.=".";
555 if (exists $params{file
}) {
556 push @opts, '--', $params{file
};
558 # git commit returns non-zero if nothing really changed.
559 # So we should ignore its exit status (hence run_or_non).
560 if (run_or_non
('git', 'commit', '-m', $params{message
}, '-q', @opts)) {
561 if (length $config{gitorigin_branch
}) {
562 run_or_cry
('git', 'push', $config{gitorigin_branch
});
567 return undef; # success
571 # Add file to archive.
575 run_or_cry
('git', 'add', $file);
579 # Remove file from archive.
583 run_or_cry
('git', 'rm', '-f', $file);
586 sub rcs_rename
($$) {
587 my ($src, $dest) = @_;
589 run_or_cry
('git', 'mv', '-f', $src, $dest);
592 sub rcs_recentchanges
($) {
593 # List of recent changes.
597 eval q{use Date::Parse};
601 foreach my $ci (git_commit_info
('HEAD', $num || 1)) {
602 # Skip redundant commits.
603 next if ($ci->{'comment'} && @
{$ci->{'comment'}}[0] eq $dummy_commit_msg);
605 my ($sha1, $when) = (
607 $ci->{'author_epoch'}
611 foreach my $detail (@
{ $ci->{'details'} }) {
612 my $file = $detail->{'file'};
614 my $diffurl = defined $config{'diffurl'} ?
$config{'diffurl'} : "";
615 $diffurl =~ s/\[\[file\]\]/$file/go;
616 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
617 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
618 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
619 $diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;
622 page
=> pagename
($file),
629 foreach my $line (@
{$ci->{'comment'}}) {
630 $pastblank=1 if $line eq '';
631 next if $pastblank && $line=~m/^ *(signed[ \-]off[ \-]by[ :]|acked[ \-]by[ :]|cc[ :])/i;
632 push @messages, { line
=> $line };
635 my $user=$ci->{'author_username'};
636 my $web_commit = ($ci->{'author'} =~ /\@web>/);
639 # Set nickname only if a non-url author_username is available,
640 # and author_name is an url.
641 if ($user !~ /:\/\
// && defined $ci->{'author_name'} &&
642 $ci->{'author_name'} =~ /:\/\
//) {
644 $user=$ci->{'author_name'};
647 # compatability code for old web commit messages
649 defined $messages[0] &&
650 $messages[0]->{line
} =~ m/$config{web_commit_regexp}/) {
651 $user = defined $2 ?
"$2" : "$3";
652 $messages[0]->{line
} = $4;
659 nickname
=> $nickname,
660 committype
=> $web_commit ?
"web" : "git",
662 message
=> [@messages],
666 last if @rets >= $num;
675 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
679 return if defined $maxlines && @lines == $maxlines;
680 push @lines, $line."\n"
681 if (@lines || $line=~/^diff --git/);
684 safe_git
(undef, $addlines, "git", "show", $sha1);
689 return join("", @lines);
698 my $id=shift; # 0 = mtime ; 1 = ctime
700 if (! keys %time_cache) {
702 foreach my $line (run_or_die
('git', 'log',
703 '--pretty=format:%at',
704 '--name-only', '--relative')) {
705 if (! defined $date && $line =~ /^(\d+)$/) {
708 elsif (! length $line) {
712 my $f=decode_git_file
($line);
714 if (! $time_cache{$f}) {
715 $time_cache{$f}[0]=$date; # mtime
717 $time_cache{$f}[1]=$date; # ctime
722 return exists $time_cache{$file} ?
$time_cache{$file}[$id] : 0;
727 sub rcs_getctime
($) {
730 return findtimes
($file, 1);
733 sub rcs_getmtime
($) {
736 return findtimes
($file, 0);
742 # The wiki may not be the only thing in the git repo.
743 # Determine if it is in a subdirectory by examining the srcdir,
744 # and its parents, looking for the .git directory.
746 return @
$ret if defined $ret;
749 my $dir=$config{srcdir
};
750 while (! -d
"$dir/.git") {
751 $subdir=IkiWiki
::basename
($dir)."/".$subdir;
752 $dir=IkiWiki
::dirname
($dir);
754 error
("cannot determine root of git repo");
758 $ret=[$subdir, $dir];
764 sub git_parse_changes
{
767 my ($subdir, $rootdir) = git_find_root
();
769 foreach my $ci (@changes) {
770 foreach my $detail (@
{ $ci->{'details'} }) {
771 my $file = $detail->{'file'};
773 # check that all changed files are in the subdir
774 if (length $subdir &&
775 ! ($file =~ s/^\Q$subdir\E//)) {
776 error
sprintf(gettext
("you are not allowed to change %s"), $file);
779 my ($action, $mode, $path);
780 if ($detail->{'status'} =~ /^[M]+\d*$/) {
782 $mode=$detail->{'mode_to'};
784 elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
786 $mode=$detail->{'mode_to'};
788 elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
790 $mode=$detail->{'mode_from'};
793 error
"unknown status ".$detail->{'status'};
796 # test that the file mode is ok
797 if ($mode !~ /^100[64][64][64]$/) {
798 error
sprintf(gettext
("you cannot act on a file with mode %s"), $mode);
800 if ($action eq "change") {
801 if ($detail->{'mode_from'} ne $detail->{'mode_to'}) {
802 error gettext
("you are not allowed to change file modes");
806 # extract attachment to temp file
807 if (($action eq 'add' || $action eq 'change') &&
809 eval q{use File::Temp};
812 ($fh, $path)=File
::Temp
::tempfile
(undef, UNLINK
=> 1);
813 my $cmd = "cd $git_dir && ".
814 "git show $detail->{sha1_to} > '$path'";
815 if (system($cmd) != 0) {
816 error
("failed writing temp file '$path'.");
835 my ($oldrev, $newrev, $refname) = split(' ', $_, 3);
837 # only allow changes to gitmaster_branch
838 if ($refname !~ /^refs\/heads\
/\Q$config{gitmaster_branch}\E$/) {
839 error
sprintf(gettext
("you are not allowed to change %s"), $refname);
842 # Avoid chdir when running git here, because the changes
843 # are in the master git repo, not the srcdir repo.
844 # (Also, if a subdir is involved, we don't want to chdir to
845 # it and only see changes in it.)
846 # The pre-receive hook already puts us in the right place.
848 push @rets, git_parse_changes
(git_commit_info
($oldrev."..".$newrev));
852 return reverse @rets;
855 sub rcs_preprevert
($) {
857 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
859 # Examine changes from root of git repo, not from any subdir,
860 # in order to see all changes.
861 my ($subdir, $rootdir) = git_find_root
();
864 my @commits=git_commit_info
($sha1, 1);
866 error
"unknown commit"; # just in case
869 # git revert will fail on merge commits. Add a nice message.
870 if (exists $commits[0]->{parents
} &&
871 @
{$commits[0]->{parents
}} > 1) {
872 error gettext
("you are not allowed to revert a merge");
875 my @ret=git_parse_changes
(@commits);
882 # Try to revert the given rev; returns undef on _success_.
884 my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
886 if (run_or_non
('git', 'revert', '--no-commit', $sha1)) {
890 run_or_die
('git', 'reset', '--hard');
891 return sprintf(gettext
("Failed to revert commit %s"), $sha1);