er, this was implemented over 1 year ago..

[git.ikiwiki.info.git] / IkiWiki / Rcs / git.pm

diff --git a/IkiWiki/Rcs/git.pm b/IkiWiki/Rcs/git.pm
index 3fedd64f189fd6c4b20a617a14b41076744fcbe5..38581ba679040081aa4d7b6f430c5784e04e8aa4 100644 (file)
--- a/IkiWiki/Rcs/git.pm
+++ b/IkiWiki/Rcs/git.pm
@@ -1,20 +1,15 @@
 #!/usr/bin/perl
 #!/usr/bin/perl

-# Git backend for IkiWiki.
-# Copyright 2006  Recai Oktaş <roktas@debian.org>
-#
-# Licensed under the same terms as IkiWiki.

 
 use warnings;
 use strict;
 use IkiWiki;
 
 use warnings;
 use strict;
 use IkiWiki;

+use Encode;
+use open qw{:utf8 :std};

 
 package IkiWiki;
 
 
 package IkiWiki;
 

-my $origin_branch    = 'origin';            # Git ref for main repository
-my $master_branch    = 'master';            # working branch

 my $sha1_pattern     = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums
 my $dummy_commit_msg = 'dummy commit';      # message to skip in recent changes
 my $sha1_pattern     = qr/[0-9a-fA-F]{40}/; # pattern to validate Git sha1sums
 my $dummy_commit_msg = 'dummy commit';      # message to skip in recent changes

-my $web_commit_msg   = qr/^web commit by (\w+):?(.*)/; # pattern for web commits

 
 sub _safe_git (&@) { #{{{
        # Start a child process safely without resorting /bin/sh.
 
 sub _safe_git (&@) { #{{{
        # Start a child process safely without resorting /bin/sh.


@@ -28,8 +23,6 @@ sub _safe_git (&@) { #{{{
 
        if (!$pid) {
                # In child.
 
        if (!$pid) {
                # In child.

-               open STDERR, ">&STDOUT"
-                   or error("Cannot dup STDOUT: $!");

                # Git commands want to be in wc.
                chdir $config{srcdir}
                    or error("Cannot chdir to $config{srcdir}: $!");
                # Git commands want to be in wc.
                chdir $config{srcdir}
                    or error("Cannot chdir to $config{srcdir}: $!");


@@ -45,12 +38,12 @@ sub _safe_git (&@) { #{{{
 
        close $OUT;
 
 
        close $OUT;
 

-       ($error_handler || sub { })->("'@cmdline' failed: $!") if $?;
+       $error_handler->("'@cmdline' failed: $!") if $? && $error_handler;

 
        return wantarray ? @lines : ($? == 0);
 }
 # Convenient wrappers.
 
        return wantarray ? @lines : ($? == 0);
 }
 # Convenient wrappers.

-sub run_or_die ($@) { _safe_git(\&IkiWiki::error, @_) }
+sub run_or_die ($@) { _safe_git(\&error, @_) }

 sub run_or_cry ($@) { _safe_git(sub { warn @_ },  @_) }
 sub run_or_non ($@) { _safe_git(undef,            @_) }
 #}}}
 sub run_or_cry ($@) { _safe_git(sub { warn @_ },  @_) }
 sub run_or_non ($@) { _safe_git(undef,            @_) }
 #}}}


@@ -115,8 +108,8 @@ sub _merge_past ($$$) { #{{{
 
                # Switch to throw-away branch for the merge operation.
                push @undo, sub {
 
                # Switch to throw-away branch for the merge operation.
                push @undo, sub {

-                       if (!run_or_cry('git-checkout', $master_branch)) {
-                               run_or_cry('git-checkout','-f',$master_branch);
+                       if (!run_or_cry('git-checkout', $config{gitmaster_branch})) {
+                               run_or_cry('git-checkout','-f',$config{gitmaster_branch});

                        }
                };
                run_or_die('git-checkout', $branch);
                        }
                };
                run_or_die('git-checkout', $branch);


@@ -128,7 +121,7 @@ sub _merge_past ($$$) { #{{{
                # _Silently_ commit all modifications in the current branch.
                run_or_non('git-commit', '-m', $message, '-a');
                # ... and re-switch to master.
                # _Silently_ commit all modifications in the current branch.
                run_or_non('git-commit', '-m', $message, '-a');
                # ... and re-switch to master.

-               run_or_die('git-checkout', $master_branch);
+               run_or_die('git-checkout', $config{gitmaster_branch});

 
                # Attempt to merge without complaining.
                if (!run_or_non('git-pull', '--no-commit', '.', $branch)) {
 
                # Attempt to merge without complaining.
                if (!run_or_non('git-pull', '--no-commit', '.', $branch)) {


@@ -149,34 +142,37 @@ sub _merge_past ($$$) { #{{{
        return $conflict;
 } #}}}
 
        return $conflict;
 } #}}}
 

-sub _parse_diff_tree (@) { #{{{
+sub _parse_diff_tree ($@) { #{{{

        # Parse the raw diff tree chunk and return the info hash.
        # See git-diff-tree(1) for the syntax.
 
        # Parse the raw diff tree chunk and return the info hash.
        # See git-diff-tree(1) for the syntax.
 

-       my ($dt_ref) = @_;
+       my ($prefix, $dt_ref) = @_;

 
        # End of stream?
 
        # End of stream?

-       return if !defined @{ $dt_ref } || !length @{ $dt_ref }[0];
+       return if !defined @{ $dt_ref } ||
+                 !defined @{ $dt_ref }[0] || !length @{ $dt_ref }[0];

 
        my %ci;
        # Header line.
 
        my %ci;
        # Header line.

-       HEADER: while (my $line = shift @{ $dt_ref }) {
-               return if $line !~ m/^diff-tree ($sha1_pattern)/;
+       while (my $line = shift @{ $dt_ref }) {
+               return if $line !~ m/^(.+) ($sha1_pattern)/;

 
 

-               my $sha1 = $1;
+               my $sha1 = $2;

                $ci{'sha1'} = $sha1;
                $ci{'sha1'} = $sha1;

-               last HEADER;
+               last;

        }
 
        # Identification lines for the commit.
        }
 
        # Identification lines for the commit.

-       IDENT: while (my $line = shift @{ $dt_ref }) {
+       while (my $line = shift @{ $dt_ref }) {

                # Regexps are semi-stolen from gitweb.cgi.
                if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
                        $ci{'tree'} = $1;
                # Regexps are semi-stolen from gitweb.cgi.
                if ($line =~ m/^tree ([0-9a-fA-F]{40})$/) {
                        $ci{'tree'} = $1;

-               } elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {
+               }
+               elsif ($line =~ m/^parent ([0-9a-fA-F]{40})$/) {

                        # XXX: collecting in reverse order
                        push @{ $ci{'parents'} }, $1;
                        # XXX: collecting in reverse order
                        push @{ $ci{'parents'} }, $1;

-               } elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {
+               }
+               elsif ($line =~ m/^(author|committer) (.*) ([0-9]+) (.*)$/) {

                        my ($who, $name, $epoch, $tz) =
                           ($1,   $2,    $3,     $4 );
 
                        my ($who, $name, $epoch, $tz) =
                           ($1,   $2,    $3,     $4 );
 


@@ -188,33 +184,35 @@ sub _parse_diff_tree (@) { #{{{
                                my ($fullname, $username) = ($1, $2);
                                $ci{"${who}_fullname"}    = $fullname;
                                $ci{"${who}_username"}    = $username;
                                my ($fullname, $username) = ($1, $2);
                                $ci{"${who}_fullname"}    = $fullname;
                                $ci{"${who}_username"}    = $username;

-                       } else {
+                       }
+                       else {

                                $ci{"${who}_fullname"} =
                                        $ci{"${who}_username"} = $name;
                        }
                                $ci{"${who}_fullname"} =
                                        $ci{"${who}_username"} = $name;
                        }

-               } elsif ($line =~ m/^$/) {
+               }
+               elsif ($line =~ m/^$/) {

                        # Trailing empty line signals next section.
                        # Trailing empty line signals next section.

-                       last IDENT;
+                       last;

                }
        }
 
                }
        }
 

-       error("No 'tree' or 'parents' seen in diff-tree output")
+       debug("No 'tree' or 'parents' seen in diff-tree output")

            if !defined $ci{'tree'} || !defined $ci{'parents'};
 
            if !defined $ci{'tree'} || !defined $ci{'parents'};
 

-       $ci{'parent'} = @{ $ci{'parents'} }[0];
+       $ci{'parent'} = @{ $ci{'parents'} }[0] if defined $ci{'parents'};

 
        # Commit message.
 
        # Commit message.

-       COMMENT: while (my $line = shift @{ $dt_ref }) {
+       while (my $line = shift @{ $dt_ref }) {

                if ($line =~ m/^$/) {
                        # Trailing empty line signals next section.
                if ($line =~ m/^$/) {
                        # Trailing empty line signals next section.

-                       last COMMENT;
+                       last;

                };
                $line =~ s/^    //;
                push @{ $ci{'comment'} }, $line;
        }
 
        # Modified files.
                };
                $line =~ s/^    //;
                push @{ $ci{'comment'} }, $line;
        }
 
        # Modified files.

-       FILE: while (my $line = shift @{ $dt_ref }) {
+       while (my $line = shift @{ $dt_ref }) {

                if ($line =~ m{^:
                        ([0-7]{6})[ ]      # from mode
                        ([0-7]{6})[ ]      # to mode
                if ($line =~ m{^:
                        ([0-7]{6})[ ]      # from mode
                        ([0-7]{6})[ ]      # to mode


@@ -230,40 +228,43 @@ sub _parse_diff_tree (@) { #{{{
                        if ($file =~ m/^"(.*)"$/) {
                                ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
                        }
                        if ($file =~ m/^"(.*)"$/) {
                                ($file=$1) =~ s/\\([0-7]{1,3})/chr(oct($1))/eg;
                        }

+                       $file =~ s/^\Q$prefix\E//;

                        if (length $file) {
                                push @{ $ci{'details'} }, {
                        if (length $file) {
                                push @{ $ci{'details'} }, {

-                                       'file'      => $file,
+                                       'file'      => decode_utf8($file),

                                        'sha1_from' => $sha1_from,
                                        'sha1_to'   => $sha1_to,
                                };
                        }
                                        'sha1_from' => $sha1_from,
                                        'sha1_to'   => $sha1_to,
                                };
                        }

-                       next FILE;
+                       next;

                };
                };

-               last FILE;
+               last;

        }
 
        }
 

-       warn "No detail in diff-tree output" if !defined $ci{'details'};
+       debug("No detail in diff-tree output") if !defined $ci{'details'};

 
        return \%ci;
 } #}}}
 
 
        return \%ci;
 } #}}}
 

-sub git_commit_info (;$$) { #{{{
+sub git_commit_info ($;$) { #{{{

        # Return an array of commit info hashes of num commits (default: 1)
        # Return an array of commit info hashes of num commits (default: 1)

-       # starting from the given sha1sum (default: HEAD).
+       # starting from the given sha1sum.

 
        my ($sha1, $num) = @_;
 
        $num ||= 1;
 
        my @raw_lines =
 
        my ($sha1, $num) = @_;
 
        $num ||= 1;
 
        my @raw_lines =

-           run_or_die(qq{git-rev-list --max-count=$num $sha1 |
-                         git-diff-tree --stdin --pretty=raw -M -r});
+           run_or_die('git-log', "--max-count=$num", '--pretty=raw', '--raw', '--abbrev=40', '--always', '-m', '-r', $sha1, '--', '.');
+       my ($prefix) = run_or_die('git-rev-parse', '--show-prefix');

 
        my @ci;
 
        my @ci;

-       while (my $parsed = _parse_diff_tree(\@raw_lines)) {
+       while (my $parsed = _parse_diff_tree(($prefix or ""), \@raw_lines)) {

                push @ci, $parsed;
        }
 
                push @ci, $parsed;
        }
 

+       warn "Cannot parse commit info for '$sha1' commit" if !@ci;
+

        return wantarray ? @ci : $ci[0];
 } #}}}
 
        return wantarray ? @ci : $ci[0];
 } #}}}
 


@@ -283,7 +284,7 @@ sub git_sha1 (;$) { #{{{
 sub rcs_update () { #{{{
        # Update working directory.
 
 sub rcs_update () { #{{{
        # Update working directory.
 

-       run_or_cry('git-pull', $origin_branch);
+       run_or_cry('git-pull', $config{gitorigin_branch});

 } #}}}
 
 sub rcs_prepedit ($) { #{{{
 } #}}}
 
 sub rcs_prepedit ($) { #{{{


@@ -295,12 +296,21 @@ sub rcs_prepedit ($) { #{{{
        return git_sha1($file);
 } #}}}
 
        return git_sha1($file);
 } #}}}
 

-sub rcs_commit ($$$) { #{{{
+sub rcs_commit ($$$;$$) { #{{{

        # Try to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on
        # failure.
 
        # Try to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on
        # failure.
 

-       my ($file, $message, $rcstoken) = @_;
+       my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
+
+       if (defined $user) {
+               $message = "web commit by $user" .
+                   (length $message ? ": $message" : "");
+       }
+       elsif (defined $ipaddr) {
+               $message = "web commit from $ipaddr" .
+                   (length $message ? ": $message" : "");
+       }

 
        # XXX: Wiki directory is in the unlocked state when starting this
        # action.  But it takes time for a Git process to finish its job
 
        # XXX: Wiki directory is in the unlocked state when starting this
        # action.  But it takes time for a Git process to finish its job


@@ -324,7 +334,7 @@ sub rcs_commit ($$$) { #{{{
        $message = possibly_foolish_untaint($message);
        if (run_or_non('git-commit', '-m', $message, '-i', $file)) {
                unlockwiki();
        $message = possibly_foolish_untaint($message);
        if (run_or_non('git-commit', '-m', $message, '-i', $file)) {
                unlockwiki();

-               run_or_cry('git-push', $origin_branch);
+               run_or_cry('git-push', $config{gitorigin_branch});

        }
 
        return undef; # success
        }
 
        return undef; # success


@@ -343,58 +353,60 @@ sub rcs_recentchanges ($) { #{{{
 
        my ($num) = @_;
 
 
        my ($num) = @_;
 

-       eval q{use CGI 'escapeHTML'};

        eval q{use Date::Parse};
        eval q{use Date::Parse};

-       eval q{use Time::Duration};
+       error($@) if $@;

 
 

-       my ($sha1, $type, $when, $diffurl, $user, @pages, @message, @rets);
-       INFO: foreach my $ci (git_commit_info('HEAD', $num)) {
+       my @rets;
+       foreach my $ci (git_commit_info('HEAD', $num)) {

                my $title = @{ $ci->{'comment'} }[0];
 
                # Skip redundant commits.
                my $title = @{ $ci->{'comment'} }[0];
 
                # Skip redundant commits.

-               next INFO if ($title eq $dummy_commit_msg);
+               next if ($title eq $dummy_commit_msg);

 
 

-               $sha1 = $ci->{'sha1'};
-               $type = "web";
-               $when = concise(ago(time - $ci->{'author_epoch'}));
+               my ($sha1, $when) = (
+                       $ci->{'sha1'},
+                       time - $ci->{'author_epoch'}
+               );

 
 

-               foreach my $bit (@{ $ci->{'details'} }) {
+               my (@pages, @messages);
+               foreach my $detail (@{ $ci->{'details'} }) {

                        my $diffurl = $config{'diffurl'};
                        my $diffurl = $config{'diffurl'};

-                       my $file    = $bit->{'file'};
+                       my $file    = $detail->{'file'};

 
                        $diffurl =~ s/\[\[file\]\]/$file/go;
                        $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
 
                        $diffurl =~ s/\[\[file\]\]/$file/go;
                        $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;

-                       $diffurl =~ s/\[\[sha1_from\]\]/$bit->{'sha1_from'}/go;
-                       $diffurl =~ s/\[\[sha1_to\]\]/$bit->{'sha1_to'}/go;
+                       $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
+                       $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;

 
                        push @pages, {
 
                        push @pages, {

-                               link => htmllink("", "", pagename($file), 1),
+                               page => pagename($file),

                                diffurl => $diffurl,
                                diffurl => $diffurl,

-                       },
+                       };

                }
                }

+               push @messages, { line => $title };

 
 

-               push @message, { line => escapeHTML($title) };
+               my ($user, $type) = (q{}, "web");

 
 

-               if (defined $message[0] &&
-                   $message[0]->{line} =~ m/$web_commit_msg/) {
-                       $user = "$1";
-                       $message[0]->{line} = $2;
-               } else {
+               if (defined $messages[0] &&
+                   $messages[0]->{line} =~ m/$config{web_commit_regexp}/) {
+                       $user = defined $2 ? "$2" : "$3";
+                       $messages[0]->{line} = $4;
+               }
+               else {

                        $type ="git";
                        $user = $ci->{'author_username'};
                }
 
                push @rets, {
                        rev        => $sha1,
                        $type ="git";
                        $user = $ci->{'author_username'};
                }
 
                push @rets, {
                        rev        => $sha1,

-                       user       => htmllink("", "", $user, 1),
+                       user       => $user,

                        committype => $type,
                        when       => $when,
                        committype => $type,
                        when       => $when,

-                       message    => [@message],
+                       message    => [@messages],

                        pages      => [@pages],
                        pages      => [@pages],

-               } if @pages;
+               };

 
 

-               $sha1 = $type = $when = $diffurl = $user = undef;
-               @pages = @message = ();
+               last if @rets >= $num;

        }
 
        return @rets;
        }
 
        return @rets;


@@ -420,70 +432,40 @@ sub rcs_notify () { #{{{
        my $sha1 = 'HEAD'; # the commit which triggers this action
 
        my $ci = git_commit_info($sha1);
        my $sha1 = 'HEAD'; # the commit which triggers this action
 
        my $ci = git_commit_info($sha1);

-       if (!defined $ci) {
-               warn "Cannot parse info for '$sha1' commit";
-               return;
-       }
+       return if !defined $ci;

 
        my @changed_pages = map { $_->{'file'} } @{ $ci->{'details'} };
 
        my ($user, $message);
 
        my @changed_pages = map { $_->{'file'} } @{ $ci->{'details'} };
 
        my ($user, $message);

-       if (@{ $ci->{'comment'} }[0] =~ m/$web_commit_msg/) {
-               $user    = "$1";
-               $message = $2;
-       } else {
+       if (@{ $ci->{'comment'} }[0] =~ m/$config{web_commit_regexp}/) {
+               $user    = defined $2 ? "$2" : "$3";
+               $message = $4;
+       }
+       else {

                $user    = $ci->{'author_username'};
                $message = join "\n", @{ $ci->{'comment'} };
        }
 
        require IkiWiki::UserInfo;
                $user    = $ci->{'author_username'};
                $message = join "\n", @{ $ci->{'comment'} };
        }
 
        require IkiWiki::UserInfo;

-       my @email_recipients = commit_notify_list($user, @changed_pages);
-       return if !@email_recipients;
-
-       # TODO: if a commit spans multiple pages, this will send
-       # subscribers a diff that might contain pages they did not
-       # sign up for. Should separate the diff per page and
-       # reassemble into one mail with just the pages subscribed to.
-       my $diff = join "\n", run_or_die('git-diff', "${sha1}^", $sha1);
-
-       my $subject = "$config{wikiname} update of ";
-       if (@changed_pages > 2) {
-               $subject .= "$changed_pages[0] $changed_pages[1] etc";
-       } else {
-               $subject .= join " ", @changed_pages;
-       }
-       $subject .= " by $user";
-
-       my $template = HTML::Template->new(
-               filename => "$config{templatedir}/notifymail.tmpl"
+       send_commit_mails(
+               sub {
+                       $message;
+               },
+               sub {
+                       join "\n", run_or_die('git-diff', "${sha1}^", $sha1);
+               }, $user, @changed_pages

        );
        );

-       $template->param(
-               wikiname => $config{wikiname},
-               diff     => $diff,
-               user     => $user,
-               message  => $message,
-       );
-
-       eval q{use Mail::Sendmail};
-       foreach my $email (@email_recipients) {
-               sendmail(
-                       To      => $email,
-                       From    => "$config{wikiname} <$config{adminemail}>",
-                       Subject => $subject,
-                       Message => $template->output,
-               ) or error("Failed to send update notification mail: $!");
-       }

 } #}}}
 
 sub rcs_getctime ($) { #{{{
 } #}}}
 
 sub rcs_getctime ($) { #{{{

-       # Get the ctime of file.
-
-       my ($file) = @_;
+       my $file=shift;
+       # Remove srcdir prefix
+       $file =~ s/^\Q$config{srcdir}\E\/?//;

 
        my $sha1  = git_sha1($file);
        my $ci    = git_commit_info($sha1);
        my $ctime = $ci->{'author_epoch'};
 
        my $sha1  = git_sha1($file);
        my $ci    = git_commit_info($sha1);
        my $ctime = $ci->{'author_epoch'};

-       debug("ctime for '$file': ". localtime($ctime) . "\n");
+       debug("ctime for '$file': ". localtime($ctime));

 
        return $ctime;
 } #}}}
 
        return $ctime;
 } #}}}