dc8b6b9fecea22bd182f47031c4c6bd05690a00b
[ikiwiki.git] / IkiWiki / Rcs / git.pm
1 #!/usr/bin/perl
2
3 use warnings;
4 use strict;
5 use IkiWiki;
6 use Encode;
7 use open qw{:utf8 :std};
8
9 package IkiWiki;
10
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
15 my $web_commit_msg   = qr/^web commit (by (\w+)|from (\d+\.\d+\.\d+\.\d+)):?(.*)/;
16
17 sub _safe_git (&@) { #{{{
18         # Start a child process safely without resorting /bin/sh.
19         # Return command output or success state (in scalar context).
20
21         my ($error_handler, @cmdline) = @_;
22
23         my $pid = open my $OUT, "-|";
24
25         error("Cannot fork: $!") if !defined $pid;
26
27         if (!$pid) {
28                 # In child.
29                 open STDERR, ">&STDOUT"
30                     or error("Cannot dup STDOUT: $!");
31                 # Git commands want to be in wc.
32                 chdir $config{srcdir}
33                     or error("Cannot chdir to $config{srcdir}: $!");
34                 exec @cmdline or error("Cannot exec '@cmdline': $!");
35         }
36         # In parent.
37
38         my @lines;
39         while (<$OUT>) {
40                 chomp;
41                 push @lines, $_;
42         }
43
44         close $OUT;
45
46         ($error_handler || sub { })->("'@cmdline' failed: $!") if $?;
47
48         return wantarray ? @lines : ($? == 0);
49 }
50 # Convenient wrappers.
51 sub run_or_die ($@) { _safe_git(\&IkiWiki::error, @_) }
52 sub run_or_cry ($@) { _safe_git(sub { warn @_ },  @_) }
53 sub run_or_non ($@) { _safe_git(undef,            @_) }
54 #}}}
55
56 sub _merge_past ($$$) { #{{{
57         # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
58         # Git merge commands work with the committed changes, except in the
59         # implicit case of '-m' of git-checkout(1).  So we should invent a
60         # kludge here.  In principle, we need to create a throw-away branch
61         # in preparing for the merge itself.  Since branches are cheap (and
62         # branching is fast), this shouldn't cost high.
63         #
64         # The main problem is the presence of _uncommitted_ local changes.  One
65         # possible approach to get rid of this situation could be that we first
66         # make a temporary commit in the master branch and later restore the
67         # initial state (this is possible since Git has the ability to undo a
68         # commit, i.e. 'git-reset --soft HEAD^').  The method can be summarized
69         # as follows:
70         #
71         #       - create a diff of HEAD:current-sha1
72         #       - dummy commit
73         #       - create a dummy branch and switch to it
74         #       - rewind to past (reset --hard to the current-sha1)
75         #       - apply the diff and commit
76         #       - switch to master and do the merge with the dummy branch
77         #       - make a soft reset (undo the last commit of master)
78         #
79         # The above method has some drawbacks: (1) it needs a redundant commit
80         # just to get rid of local changes, (2) somewhat slow because of the
81         # required system forks.  Until someone points a more straight method
82         # (which I would be grateful) I have implemented an alternative method.
83         # In this approach, we hide all the modified files from Git by renaming
84         # them (using the 'rename' builtin) and later restore those files in
85         # the throw-away branch (that is, we put the files themselves instead
86         # of applying a patch).
87
88         my ($sha1, $file, $message) = @_;
89
90         my @undo;      # undo stack for cleanup in case of an error
91         my $conflict;  # file content with conflict markers
92
93         eval {
94                 # Hide local changes from Git by renaming the modified file.
95                 # Relative paths must be converted to absolute for renaming.
96                 my ($target, $hidden) = (
97                     "$config{srcdir}/${file}", "$config{srcdir}/${file}.${sha1}"
98                 );
99                 rename($target, $hidden)
100                     or error("rename '$target' to '$hidden' failed: $!");
101                 # Ensure to restore the renamed file on error.
102                 push @undo, sub {
103                         return if ! -e "$hidden"; # already renamed
104                         rename($hidden, $target)
105                             or warn "rename '$hidden' to '$target' failed: $!";
106                 };
107
108                 my $branch = "throw_away_${sha1}"; # supposed to be unique
109
110                 # Create a throw-away branch and rewind backward.
111                 push @undo, sub { run_or_cry('git-branch', '-D', $branch) };
112                 run_or_die('git-branch', $branch, $sha1);
113
114                 # Switch to throw-away branch for the merge operation.
115                 push @undo, sub {
116                         if (!run_or_cry('git-checkout', $master_branch)) {
117                                 run_or_cry('git-checkout','-f',$master_branch);
118                         }
119                 };
120                 run_or_die('git-checkout', $branch);
121
122                 # Put the modified file in _this_ branch.
123                 rename($hidden, $target)
124                     or error("rename '$hidden' to '$target' failed: $!");
125
126                 # _Silently_ commit all modifications in the current branch.
127                 run_or_non('git-commit', '-m', $message, '-a');
128                 # ... and re-switch to master.
129                 run_or_die('git-checkout', $master_branch);
130
131                 # Attempt to merge without complaining.
132                 if (!run_or_non('git-pull', '--no-commit', '.', $branch)) {
133                         $conflict = readfile($target);
134                         run_or_die('git-reset', '--hard');
135                 }
136         };
137         my $failure = $@;
138
139         # Process undo stack (in reverse order).  By policy cleanup
140         # actions should normally print a warning on failure.
141         while (my $handle = pop @undo) {
142                 $handle->();
143         }
144
145         error("Git merge failed!\n$failure\n") if $failure;
146
147         return $conflict;
148 } #}}}
149
150 sub _parse_diff_tree (@) { #{{{
151         # Parse the raw diff tree chunk and return the info hash.
152         # See git-diff-tree(1) for the syntax.
153
154         my ($dt_ref) = @_;
155
156         # End of stream?
157         return if !defined @{ $dt_ref } || !length @{ $dt_ref }[0];
158
159         my %ci;
160         # Header line.
161         HEADER: while (my $line = shift @{ $dt_ref }) {
162                 return if $line !~ m/^(.+) ($sha1_pattern)/;
163
164                 my $sha1 = $1;
165                 $ci{'sha1'} = $sha1;
166                 last HEADER;
167         }
168
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})$/) {
173                         $ci{'tree'} = $1;
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) =
179                            ($1,   $2,    $3,     $4 );
180
181                         $ci{  $who          } = $name;
182                         $ci{ "${who}_epoch" } = $epoch;
183                         $ci{ "${who}_tz"    } = $tz;
184
185                         if ($name =~ m/^([^<]+) <([^@]+)/) {
186                                 my ($fullname, $username) = ($1, $2);
187                                 $ci{"${who}_fullname"}    = $fullname;
188                                 $ci{"${who}_username"}    = $username;
189                         } else {
190                                 $ci{"${who}_fullname"} =
191                                         $ci{"${who}_username"} = $name;
192                         }
193                 } elsif ($line =~ m/^$/) {
194                         # Trailing empty line signals next section.
195                         last IDENT;
196                 }
197         }
198
199         error("No 'tree' or 'parents' seen in diff-tree output")
200             if !defined $ci{'tree'} || !defined $ci{'parents'};
201
202         $ci{'parent'} = @{ $ci{'parents'} }[0];
203
204         # Commit message.
205         COMMENT: while (my $line = shift @{ $dt_ref }) {
206                 if ($line =~ m/^$/) {
207                         # Trailing empty line signals next section.
208                         last COMMENT;
209                 };
210                 $line =~ s/^    //;
211                 push @{ $ci{'comment'} }, $line;
212         }
213
214         # Modified files.
215         FILE: while (my $line = shift @{ $dt_ref }) {
216                 if ($line =~ m{^:
217                         ([0-7]{6})[ ]      # from mode
218                         ([0-7]{6})[ ]      # to mode
219                         ($sha1_pattern)[ ] # from sha1
220                         ($sha1_pattern)[ ] # to sha1
221                         (.)                # status
222                         ([0-9]{0,3})\t     # similarity
223                         (.*)               # file
224                 $}xo) {
225                         my ($sha1_from, $sha1_to, $file) =
226                            ($3,         $4,       $7   );
227
228                         if ($file =~ m/^"(.*)"$/) {
229                                 ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
230                         }
231                         if (length $file) {
232                                 push @{ $ci{'details'} }, {
233                                         'file'      => decode_utf8($file),
234                                         'sha1_from' => $sha1_from,
235                                         'sha1_to'   => $sha1_to,
236                                 };
237                         }
238                         next FILE;
239                 };
240                 last FILE;
241         }
242
243         warn "No detail in diff-tree output" if !defined $ci{'details'};
244
245         return \%ci;
246 } #}}}
247
248 sub git_commit_info (;$$) { #{{{
249         # Return an array of commit info hashes of num commits (default: 1)
250         # starting from the given sha1sum (default: HEAD).
251
252         my ($sha1, $num) = @_;
253
254         $num ||= 1;
255
256         my @raw_lines =
257             run_or_die(qq{git-rev-list --max-count=$num $sha1 |
258                           git-diff-tree --stdin --pretty=raw -M -r});
259
260         my @ci;
261         while (my $parsed = _parse_diff_tree(\@raw_lines)) {
262                 push @ci, $parsed;
263         }
264
265         warn "Cannot parse commit info for '$sha1' commit" if !@ci;
266
267         return wantarray ? @ci : $ci[0];
268 } #}}}
269
270 sub git_sha1 (;$) { #{{{
271         # Return head sha1sum (of given file).
272
273         my $file = shift || q{--};
274
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);
277         if ($sha1) {
278                 ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
279         } else { debug("Empty sha1sum for '$file'.") }
280         return defined $sha1 ? $sha1 : q{};
281 } #}}}
282
283 sub rcs_update () { #{{{
284         # Update working directory.
285
286         run_or_cry('git-pull', $origin_branch);
287 } #}}}
288
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.
292
293         my ($file) = @_;
294
295         return git_sha1($file);
296 } #}}}
297
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
301         # failure.
302
303         my ($file, $message, $rcstoken) = @_;
304
305         # XXX: Wiki directory is in the unlocked state when starting this
306         # action.  But it takes time for a Git process to finish its job
307         # (especially if a merge required), so we must re-lock to prevent
308         # race conditions.  Only when the time of the real commit action
309         # (i.e. git-push(1)) comes, we'll unlock the directory.
310         lockwiki();
311
312         # Check to see if the page has been changed by someone else since
313         # rcs_prepedit was called.
314         my $cur    = git_sha1($file);
315         my ($prev) = $rcstoken =~ /^($sha1_pattern)$/; # untaint
316
317         if (defined $cur && defined $prev && $cur ne $prev) {
318                 my $conflict = _merge_past($prev, $file, $dummy_commit_msg);
319                 return $conflict if defined $conflict;
320         }
321
322         # git-commit(1) returns non-zero if file has not been really changed.
323         # so we should ignore its exit status (hence run_or_non).
324         $message = possibly_foolish_untaint($message);
325         if (run_or_non('git-commit', '-m', $message, '-i', $file)) {
326                 unlockwiki();
327                 run_or_cry('git-push', $origin_branch);
328         }
329
330         return undef; # success
331 } #}}}
332
333 sub rcs_add ($) { # {{{
334         # Add file to archive.
335
336         my ($file) = @_;
337
338         run_or_cry('git-add', $file);
339 } #}}}
340
341 sub rcs_recentchanges ($) { #{{{
342         # List of recent changes.
343
344         my ($num) = @_;
345
346         eval q{use Date::Parse};
347
348         my ($sha1, $type, $when, $diffurl, $user, @pages, @message, @rets);
349         INFO: foreach my $ci (git_commit_info('HEAD', $num)) {
350                 my $title = @{ $ci->{'comment'} }[0];
351
352                 # Skip redundant commits.
353                 next INFO if ($title eq $dummy_commit_msg);
354
355                 $sha1 = $ci->{'sha1'};
356                 $type = "web";
357                 $when = time - $ci->{'author_epoch'};
358
359                 foreach my $bit (@{ $ci->{'details'} }) {
360                         my $diffurl = $config{'diffurl'};
361                         my $file    = $bit->{'file'};
362
363                         $diffurl =~ s/\[\[file\]\]/$file/go;
364                         $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
365                         $diffurl =~ s/\[\[sha1_from\]\]/$bit->{'sha1_from'}/go;
366                         $diffurl =~ s/\[\[sha1_to\]\]/$bit->{'sha1_to'}/go;
367
368                         push @pages, {
369                                 page => pagename($file),
370                                 diffurl => $diffurl,
371                         },
372                 }
373
374                 push @message, { line => $title };
375
376                 if (defined $message[0] &&
377                     $message[0]->{line} =~ m/$web_commit_msg/) {
378                         $user=defined $2 ? "$2" : "$3";
379                         $message[0]->{line}=$4;
380                 } else {
381                         $type ="git";
382                         $user = $ci->{'author_username'};
383                 }
384
385                 push @rets, {
386                         rev        => $sha1,
387                         user       => $user,
388                         committype => $type,
389                         when       => $when,
390                         message    => [@message],
391                         pages      => [@pages],
392                 } if @pages;
393
394                 $sha1 = $type = $when = $diffurl = $user = undef;
395                 @pages = @message = ();
396         }
397
398         return @rets;
399 } #}}}
400
401 sub rcs_notify () { #{{{
402         # Send notification mail to subscribed users.
403         #
404         # In usual Git usage, hooks/update script is presumed to send
405         # notification mails (see git-receive-pack(1)).  But we prefer
406         # hooks/post-update to support IkiWiki commits coming from a
407         # cloned repository (through command line) because post-update
408         # is called _after_ each ref in repository is updated (update
409         # hook is called _before_ the repository is updated).  Since
410         # post-update hook does not accept command line arguments, we
411         # don't have an $ENV variable in this function.
412         #
413         # Here, we rely on a simple fact: we can extract all parts of the
414         # notification content by parsing the "HEAD" commit (which also
415         # triggers a refresh of IkiWiki pages) and we can obtain the diff
416         # by comparing HEAD and HEAD^ (the previous commit).
417
418         my $sha1 = 'HEAD'; # the commit which triggers this action
419
420         my $ci = git_commit_info($sha1);
421         return if !defined $ci;
422
423         my @changed_pages = map { $_->{'file'} } @{ $ci->{'details'} };
424
425         my ($user, $message);
426         if (@{ $ci->{'comment'} }[0] =~ m/$web_commit_msg/) {
427                 $user    = defined $2 ? "$2" : "$3";
428                 $message = $4;
429         } else {
430                 $user    = $ci->{'author_username'};
431                 $message = join "\n", @{ $ci->{'comment'} };
432         }
433
434         require IkiWiki::UserInfo;
435         my @email_recipients = commit_notify_list($user, @changed_pages);
436         return if !@email_recipients;
437
438         # TODO: if a commit spans multiple pages, this will send
439         # subscribers a diff that might contain pages they did not
440         # sign up for. Should separate the diff per page and
441         # reassemble into one mail with just the pages subscribed to.
442         my $diff = join "\n", run_or_die('git-diff', "${sha1}^", $sha1);
443
444         my $subject = "$config{wikiname} update of ";
445         if (@changed_pages > 2) {
446                 $subject .= "$changed_pages[0] $changed_pages[1] etc";
447         } else {
448                 $subject .= join " ", @changed_pages;
449         }
450         $subject .= " by $user";
451
452         my $template = template("notifymail.tmpl");
453         $template->param(
454                 wikiname => $config{wikiname},
455                 diff     => $diff,
456                 user     => $user,
457                 message  => $message,
458         );
459
460         eval q{use Mail::Sendmail};
461         foreach my $email (@email_recipients) {
462                 sendmail(
463                         To      => $email,
464                         From    => "$config{wikiname} <$config{adminemail}>",
465                         Subject => $subject,
466                         Message => $template->output,
467                 ) or error("Failed to send update notification mail: $!");
468         }
469 } #}}}
470
471 sub rcs_getctime ($) { #{{{
472         # Get the ctime of file.
473
474         my ($file) = @_;
475
476         my $sha1  = git_sha1($file);
477         my $ci    = git_commit_info($sha1);
478         my $ctime = $ci->{'author_epoch'};
479         debug("ctime for '$file': ". localtime($ctime) . "\n");
480
481         return $ctime;
482 } #}}}
483
484 1