7 use open qw{:utf8 :std};
11 my $origin_branch = 'origin'; # Git ref for main repository
12 my $master_branch = 'master'; # working branch
13 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums
14 my $dummy_commit_msg = 'dummy commit'; # message to skip in recent changes
16 sub _safe_git (&@) { #{{{
17 # Start a child process safely without resorting /bin/sh.
18 # Return command output or success state (in scalar context).
20 my ($error_handler, @cmdline) = @_;
22 my $pid = open my $OUT, "-|";
24 error("Cannot fork: $!") if !defined $pid;
28 open STDERR, ">&STDOUT"
29 or error("Cannot dup STDOUT: $!");
30 # Git commands want to be in wc.
32 or error("Cannot chdir to $config{srcdir}: $!");
33 exec @cmdline or error("Cannot exec '@cmdline': $!");
45 ($error_handler || sub { })->("'@cmdline' failed: $!") if $?;
47 return wantarray ? @lines : ($? == 0);
49 # Convenient wrappers.
50 sub run_or_die ($@) { _safe_git(\&error, @_) }
51 sub run_or_cry ($@) { _safe_git(sub { warn @_ }, @_) }
52 sub run_or_non ($@) { _safe_git(undef, @_) }
55 sub _merge_past ($$$) { #{{{
56 # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
57 # Git merge commands work with the committed changes, except in the
58 # implicit case of '-m' of git-checkout(1). So we should invent a
59 # kludge here. In principle, we need to create a throw-away branch
60 # in preparing for the merge itself. Since branches are cheap (and
61 # branching is fast), this shouldn't cost high.
63 # The main problem is the presence of _uncommitted_ local changes. One
64 # possible approach to get rid of this situation could be that we first
65 # make a temporary commit in the master branch and later restore the
66 # initial state (this is possible since Git has the ability to undo a
67 # commit, i.e. 'git-reset --soft HEAD^'). The method can be summarized
70 # - create a diff of HEAD:current-sha1
72 # - create a dummy branch and switch to it
73 # - rewind to past (reset --hard to the current-sha1)
74 # - apply the diff and commit
75 # - switch to master and do the merge with the dummy branch
76 # - make a soft reset (undo the last commit of master)
78 # The above method has some drawbacks: (1) it needs a redundant commit
79 # just to get rid of local changes, (2) somewhat slow because of the
80 # required system forks. Until someone points a more straight method
81 # (which I would be grateful) I have implemented an alternative method.
82 # In this approach, we hide all the modified files from Git by renaming
83 # them (using the 'rename' builtin) and later restore those files in
84 # the throw-away branch (that is, we put the files themselves instead
85 # of applying a patch).
87 my ($sha1, $file, $message) = @_;
89 my @undo; # undo stack for cleanup in case of an error
90 my $conflict; # file content with conflict markers
93 # Hide local changes from Git by renaming the modified file.
94 # Relative paths must be converted to absolute for renaming.
95 my ($target, $hidden) = (
96 "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
98 rename($target, $hidden)
99 or error("rename '$target' to '$hidden' failed: $!");
100 # Ensure to restore the renamed file on error.
102 return if ! -e "$hidden"; # already renamed
103 rename($hidden, $target)
104 or warn "rename '$hidden' to '$target' failed: $!";
107 my $branch = "throw_away_${sha1}"; # supposed to be unique
109 # Create a throw-away branch and rewind backward.
110 push @undo, sub { run_or_cry('git-branch', '-D', $branch) };
111 run_or_die('git-branch', $branch, $sha1);
113 # Switch to throw-away branch for the merge operation.
115 if (!run_or_cry('git-checkout', $master_branch)) {
116 run_or_cry('git-checkout','-f',$master_branch);
119 run_or_die('git-checkout', $branch);
121 # Put the modified file in _this_ branch.
122 rename($hidden, $target)
123 or error("rename '$hidden' to '$target' failed: $!");
125 # _Silently_ commit all modifications in the current branch.
126 run_or_non('git-commit', '-m', $message, '-a');
127 # ... and re-switch to master.
128 run_or_die('git-checkout', $master_branch);
130 # Attempt to merge without complaining.
131 if (!run_or_non('git-pull', '--no-commit', '.', $branch)) {
132 $conflict = readfile($target);
133 run_or_die('git-reset', '--hard');
138 # Process undo stack (in reverse order). By policy cleanup
139 # actions should normally print a warning on failure.
140 while (my $handle = pop @undo) {
144 error("Git merge failed!\n$failure\n") if $failure;
149 sub _parse_diff_tree (@) { #{{{
150 # Parse the raw diff tree chunk and return the info hash.
151 # See git-diff-tree(1) for the syntax.
156 return if !defined @{ $dt_ref } ||
157 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];
161 HEADER: while (my $line = shift @{ $dt_ref }) {
162 return if $line !~ m/^(.+) ($sha1_pattern)/;
169 # Identification lines for the commit.
170 IDENT: while (my $line = shift @{ $dt_ref }) {
171 # Regexps are semi-stolen from gitweb.cgi.
172 if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
174 } elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
175 # XXX: collecting in reverse order
176 push @{ $ci{'parents'} }, $1;
177 } elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
178 my ($who, $name, $epoch, $tz) =
182 $ci{ "${who}_epoch" } = $epoch;
183 $ci{ "${who}_tz" } = $tz;
185 if ($name =~ m/^([^<]+) <([^@]+)/) {
186 my ($fullname, $username) = ($1, $2);
187 $ci{"${who}_fullname"} = $fullname;
188 $ci{"${who}_username"} = $username;
190 $ci{"${who}_fullname"} =
191 $ci{"${who}_username"} = $name;
193 } elsif ($line =~ m/^$/) {
194 # Trailing empty line signals next section.
199 debug("No 'tree' or 'parents' seen in diff-tree output")
200 if !defined $ci{'tree'} || !defined $ci{'parents'};
202 $ci{'parent'} = @{ $ci{'parents'} }[0] if defined $ci{'parents'};
205 COMMENT: while (my $line = shift @{ $dt_ref }) {
206 if ($line =~ m/^$/) {
207 # Trailing empty line signals next section.
211 push @{ $ci{'comment'} }, $line;
215 FILE: while (my $line = shift @{ $dt_ref }) {
217 ([0-7]{6})[ ] # from mode
218 ([0-7]{6})[ ] # to mode
219 ($sha1_pattern)[ ] # from sha1
220 ($sha1_pattern)[ ] # to sha1
222 ([0-9]{0,3})\t # similarity
225 my ($sha1_from, $sha1_to, $file) =
228 if ($file =~ m/^"(.*)"$/) {
229 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
232 push @{ $ci{'details'} }, {
233 'file' => decode_utf8($file),
234 'sha1_from' => $sha1_from,
235 'sha1_to' => $sha1_to,
243 debug("No detail in diff-tree output") if !defined $ci{'details'};
248 sub git_commit_info ($;$) { #{{{
249 # Return an array of commit info hashes of num commits (default: 1)
250 # starting from the given sha1sum.
252 my ($sha1, $num) = @_;
257 run_or_die(qq{git-rev-list --max-count=$num $sha1 |
258 git-diff-tree --stdin --pretty=raw --always -M -m -r});
261 while (my $parsed = _parse_diff_tree(\@raw_lines)) {
265 warn "Cannot parse commit info for '$sha1' commit" if !@ci;
267 return wantarray ? @ci : $ci[0];
270 sub git_sha1 (;$) { #{{{
271 # Return head sha1sum (of given file).
273 my $file = shift || q{--};
275 # Ignore error since a non-existing file might be given.
276 my ($sha1) = run_or_non('git-rev-list', '--max-count=1', 'HEAD', $file);
278 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
279 } else { debug("Empty sha1sum for '$file'.") }
280 return defined $sha1 ? $sha1 : q{};
283 sub rcs_update () { #{{{
284 # Update working directory.
286 run_or_cry('git-pull', $origin_branch);
289 sub rcs_prepedit ($) { #{{{
290 # Return the commit sha1sum of the file when editing begins.
291 # This will be later used in rcs_commit if a merge is required.
295 return git_sha1($file);
298 sub rcs_commit ($$$;$$) { #{{{
299 # Try to commit the page; returns undef on _success_ and
300 # a version of the page with the rcs's conflict markers on
303 my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
306 $message="web commit by $user".(length $message ? ": $message" : "");
308 elsif (defined $ipaddr) {
309 $message="web commit from $ipaddr".(length $message ? ": $message" : "");
312 # XXX: Wiki directory is in the unlocked state when starting this
313 # action. But it takes time for a Git process to finish its job
314 # (especially if a merge required), so we must re-lock to prevent
315 # race conditions. Only when the time of the real commit action
316 # (i.e. git-push(1)) comes, we'll unlock the directory.
319 # Check to see if the page has been changed by someone else since
320 # rcs_prepedit was called.
321 my $cur = git_sha1($file);
322 my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
324 if (defined $cur && defined $prev && $cur ne $prev) {
325 my $conflict = _merge_past($prev, $file, $dummy_commit_msg);
326 return $conflict if defined $conflict;
329 # git-commit(1) returns non-zero if file has not been really changed.
330 # so we should ignore its exit status (hence run_or_non).
331 $message = possibly_foolish_untaint($message);
332 if (run_or_non('git-commit', '-m', $message, '-i', $file)) {
334 run_or_cry('git-push', $origin_branch);
337 return undef; # success
340 sub rcs_add ($) { # {{{
341 # Add file to archive.
345 run_or_cry('git-add', $file);
348 sub rcs_recentchanges ($) { #{{{
349 # List of recent changes.
353 eval q{use Date::Parse};
357 INFO: foreach my $ci (git_commit_info('HEAD', $num)) {
358 my $title = @{ $ci->{'comment'} }[0];
360 # Skip redundant commits.
361 next INFO if ($title eq $dummy_commit_msg);
363 my ($sha1, $when) = (
365 time - $ci->{'author_epoch'}
368 my (@pages, @messages);
369 DETAIL: foreach my $detail (@{ $ci->{'details'} }) {
370 my $diffurl = $config{'diffurl'};
371 my $file = $detail->{'file'};
373 $diffurl =~ s/\[\[file\]\]/$file/go;
374 $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
375 $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
376 $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
379 page => pagename($file),
383 push @messages, { line => $title };
385 my ($user, $type) = (q{}, "web");
387 if (defined $messages[0] &&
388 $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
389 $user=defined $2 ? "$2" : "$3";
390 $messages[0]->{line}=$4;
393 $user = $ci->{'author_username'};
401 message => [@messages],
405 last INFO if @rets >= $num;
411 sub rcs_notify () { #{{{
412 # Send notification mail to subscribed users.
414 # In usual Git usage, hooks/update script is presumed to send
415 # notification mails (see git-receive-pack(1)). But we prefer
416 # hooks/post-update to support IkiWiki commits coming from a
417 # cloned repository (through command line) because post-update
418 # is called _after_ each ref in repository is updated (update
419 # hook is called _before_ the repository is updated). Since
420 # post-update hook does not accept command line arguments, we
421 # don't have an $ENV variable in this function.
423 # Here, we rely on a simple fact: we can extract all parts of the
424 # notification content by parsing the "HEAD" commit (which also
425 # triggers a refresh of IkiWiki pages) and we can obtain the diff
426 # by comparing HEAD and HEAD^ (the previous commit).
428 my $sha1 = 'HEAD'; # the commit which triggers this action
430 my $ci = git_commit_info($sha1);
431 return if !defined $ci;
433 my @changed_pages = map { $_->{'file'} } @{ $ci->{'details'} };
435 my ($user, $message);
436 if (@{ $ci->{'comment'} }[0] =~ m/$config{web_commit_regexp}/) {
437 $user = defined $2 ? "$2" : "$3";
440 $user = $ci->{'author_username'};
441 $message = join "\n", @{ $ci->{'comment'} };
444 require IkiWiki::UserInfo;
450 join "\n", run_or_die('git-diff', "${sha1}^", $sha1);
451 }, $user, @changed_pages);
454 sub rcs_getctime ($) { #{{{
455 # Get the ctime of file.
459 my $sha1 = git_sha1($file);
460 my $ci = git_commit_info($sha1);
461 my $ctime = $ci->{'author_epoch'};
462 debug("ctime for '$file': ". localtime($ctime) . "\n");