Remember to run all the tests before committing!

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

diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm
index 794afb74065ab919f942a88799a61db24eb1476d..3117e42914d5f8b8f4f5d49ec3e3f0b5865d1891 100644 (file)
--- a/IkiWiki/Plugin/git.pm
+++ b/IkiWiki/Plugin/git.pm
@@ -9,7 +9,7 @@ use open qw{:utf8 :std};
 
 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 $no_chdir=0;
+my $git_dir=undef;

 
 sub import {
        hook(type => "checkconfig", id => "git", call => \&checkconfig);
 
 sub import {
        hook(type => "checkconfig", id => "git", call => \&checkconfig);


@@ -29,7 +29,6 @@ sub import {
        hook(type => "rcs", id => "rcs_receive", call => \&rcs_receive);
        hook(type => "rcs", id => "rcs_preprevert", call => \&rcs_preprevert);
        hook(type => "rcs", id => "rcs_revert", call => \&rcs_revert);
        hook(type => "rcs", id => "rcs_receive", call => \&rcs_receive);
        hook(type => "rcs", id => "rcs_preprevert", call => \&rcs_preprevert);
        hook(type => "rcs", id => "rcs_revert", call => \&rcs_revert);

-       hook(type => "rcs", id => "rcs_showpatch", call => \&rcs_showpatch);

 }
 
 sub checkconfig () {
 }
 
 sub checkconfig () {


@@ -153,10 +152,11 @@ sub genwrapper {
 }
 
 sub safe_git (&@) {
 }
 
 sub safe_git (&@) {

-       # Start a child process safely without resorting /bin/sh.
-       # Return command output or success state (in scalar context).
+       # Start a child process safely without resorting to /bin/sh.
+       # Returns command output (in list content) or success state
+       # (in scalar context), or runs the specified data handler.

 
 

-       my ($error_handler, @cmdline) = @_;
+       my ($error_handler, $data_handler, @cmdline) = @_;

 
        my $pid = open my $OUT, "-|";
 
 
        my $pid = open my $OUT, "-|";
 


@@ -165,9 +165,13 @@ sub safe_git (&@) {
        if (!$pid) {
                # In child.
                # Git commands want to be in wc.
        if (!$pid) {
                # In child.
                # Git commands want to be in wc.

-               if (! $no_chdir) {
+               if (! defined $git_dir) {

                        chdir $config{srcdir}
                        chdir $config{srcdir}

-                           or error("Cannot chdir to $config{srcdir}: $!");
+                           or error("cannot chdir to $config{srcdir}: $!");
+               }
+               else {
+                       chdir $git_dir
+                           or error("cannot chdir to $git_dir: $!");

                }
                exec @cmdline or error("Cannot exec '@cmdline': $!");
        }
                }
                exec @cmdline or error("Cannot exec '@cmdline': $!");
        }


@@ -184,7 +188,12 @@ sub safe_git (&@) {
 
                chomp;
 
 
                chomp;
 

-               push @lines, $_;
+               if (! defined $data_handler) {
+                       push @lines, $_;
+               }
+               else {
+                       last unless $data_handler->($_);
+               }

        }
 
        close $OUT;
        }
 
        close $OUT;


@@ -194,9 +203,9 @@ sub safe_git (&@) {
        return wantarray ? @lines : ($? == 0);
 }
 # Convenient wrappers.
        return wantarray ? @lines : ($? == 0);
 }
 # Convenient wrappers.

-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_die ($@) { safe_git(\&error, undef, @_) }
+sub run_or_cry ($@) { safe_git(sub { warn @_ }, undef, @_) }
+sub run_or_non ($@) { safe_git(undef, undef, @_) }

 
 
 sub merge_past ($$$) {
 
 
 sub merge_past ($$$) {


@@ -493,16 +502,16 @@ sub rcs_commit (@) {
                return $conflict if defined $conflict;
        }
 
                return $conflict if defined $conflict;
        }
 

-       rcs_add($params{file});
-       return rcs_commit_staged(
-               message => $params{message},
-               session => $params{session},
-       );
+       return rcs_commit_helper(@_);

 }
 
 sub rcs_commit_staged (@) {
        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.
 }
 
 sub rcs_commit_staged (@) {
        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.

+       return rcs_commit_helper(@_);
+}
+
+sub rcs_commit_helper (@) {

        my %params=@_;
        
        my %env=%ENV;
        my %params=@_;
        
        my %env=%ENV;


@@ -543,10 +552,12 @@ sub rcs_commit_staged (@) {
                        $params{message}.=".";
                }
        }
                        $params{message}.=".";
                }
        }

-       push @opts, '-q';
-       # git commit returns non-zero if file has not been really changed.
-       # so we should ignore its exit status (hence run_or_non).
-       if (run_or_non('git', 'commit', @opts, '-m', $params{message})) {
+       if (exists $params{file}) {
+               push @opts, '--', $params{file};
+       }
+       # git commit returns non-zero if nothing really changed.
+       # So we should ignore its exit status (hence run_or_non).
+       if (run_or_non('git', 'commit', '-m', $params{message}, '-q', @opts)) {

                if (length $config{gitorigin_branch}) {
                        run_or_cry('git', 'push', $config{gitorigin_branch});
                }
                if (length $config{gitorigin_branch}) {
                        run_or_cry('git', 'push', $config{gitorigin_branch});
                }


@@ -658,15 +669,19 @@ sub rcs_recentchanges ($) {
        return @rets;
 }
 
        return @rets;
 }
 

-sub rcs_diff ($) {
+sub rcs_diff ($;$) {

        my $rev=shift;
        my $rev=shift;

+       my $maxlines=shift;

        my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
        my @lines;
        my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
        my @lines;

-       foreach my $line (run_or_non("git", "show", $sha1)) {
-               if (@lines || $line=~/^diff --git/) {
-                       push @lines, $line."\n";
-               }
-       }
+       my $addlines=sub {
+               my $line=shift;
+               return if defined $maxlines && @lines == $maxlines;
+               push @lines, $line."\n"
+                       if (@lines || $line=~/^diff --git/);
+               return 1;
+       };
+       safe_git(undef, $addlines, "git", "show", $sha1);

        if (wantarray) {
                return @lines;
        }
        if (wantarray) {
                return @lines;
        }


@@ -685,7 +700,7 @@ sub findtimes ($$) {
        if (! keys %time_cache) {
                my $date;
                foreach my $line (run_or_die('git', 'log',
        if (! keys %time_cache) {
                my $date;
                foreach my $line (run_or_die('git', 'log',

-                               '--pretty=format:%ct',
+                               '--pretty=format:%at',

                                '--name-only', '--relative')) {
                        if (! defined $date && $line =~ /^(\d+)$/) {
                                $date=$line;
                                '--name-only', '--relative')) {
                        if (! defined $date && $line =~ /^(\d+)$/) {
                                $date=$line;


@@ -722,14 +737,13 @@ sub rcs_getmtime ($) {
 }
 
 {
 }
 
 {

-my $git_root;
-
+my $ret;

 sub git_find_root {
        # The wiki may not be the only thing in the git repo.
        # Determine if it is in a subdirectory by examining the srcdir,
        # and its parents, looking for the .git directory.
 
 sub git_find_root {
        # The wiki may not be the only thing in the git repo.
        # Determine if it is in a subdirectory by examining the srcdir,
        # and its parents, looking for the .git directory.
 

-       return $git_root if defined $git_root;
+       return @$ret if defined $ret;

        
        my $subdir="";
        my $dir=$config{srcdir};
        
        my $subdir="";
        my $dir=$config{srcdir};


@@ -741,15 +755,17 @@ sub git_find_root {
                }
        }
 
                }
        }
 

-       return $subdir;
+       $ret=[$subdir, $dir];
+       return @$ret;

 }
 
 }
 
 sub git_parse_changes {
 }
 
 }
 
 sub git_parse_changes {

+       my $reverted = shift;

        my @changes = @_;
 
        my @changes = @_;
 

-       my $subdir = git_find_root();
+       my ($subdir, $rootdir) = git_find_root();

        my @rets;
        foreach my $ci (@changes) {
                foreach my $detail (@{ $ci->{'details'} }) {
        my @rets;
        foreach my $ci (@changes) {
                foreach my $detail (@{ $ci->{'details'} }) {


@@ -767,11 +783,11 @@ sub git_parse_changes {
                                $mode=$detail->{'mode_to'};
                        }
                        elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
                                $mode=$detail->{'mode_to'};
                        }
                        elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {

-                               $action="add";
+                               $action= $reverted ? "remove" : "add";

                                $mode=$detail->{'mode_to'};
                        }
                        elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {
                                $mode=$detail->{'mode_to'};
                        }
                        elsif ($detail->{'status'} =~ /^[DAM]+\d*/) {

-                               $action="remove";
+                               $action= $reverted ? "add" : "remove";

                                $mode=$detail->{'mode_from'};
                        }
                        else {
                                $mode=$detail->{'mode_from'};
                        }
                        else {


@@ -794,11 +810,9 @@ sub git_parse_changes {
                                eval q{use File::Temp};
                                die $@ if $@;
                                my $fh;
                                eval q{use File::Temp};
                                die $@ if $@;
                                my $fh;

-                               ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
-                               # Ensure we run this in the right place,
-                               # see comments in rcs_receive.
-                               my $cmd = ($no_chdir ? '' : "cd $config{srcdir} && ")
-                                       . "git show $detail->{sha1_to} > '$path'";
+                               ($fh, $path)=File::Temp::tempfile(undef, UNLINK => 1);
+                               my $cmd = "cd $git_dir && ".
+                                         "git show $detail->{sha1_to} > '$path'";

                                if (system($cmd) != 0) {
                                        error("failed writing temp file '$path'.");
                                }
                                if (system($cmd) != 0) {
                                        error("failed writing temp file '$path'.");
                                }


@@ -828,49 +842,55 @@ sub rcs_receive () {
 
                # Avoid chdir when running git here, because the changes
                # are in the master git repo, not the srcdir repo.
 
                # Avoid chdir when running git here, because the changes
                # are in the master git repo, not the srcdir repo.

+               # (Also, if a subdir is involved, we don't want to chdir to
+               # it and only see changes in it.)

                # The pre-receive hook already puts us in the right place.
                # The pre-receive hook already puts us in the right place.

-               $no_chdir=1;
-               push @rets, git_parse_changes(git_commit_info($oldrev."..".$newrev));
-               $no_chdir=0;
+               $git_dir=".";
+               push @rets, git_parse_changes(0, git_commit_info($oldrev."..".$newrev));
+               $git_dir=undef;

        }
 
        return reverse @rets;
 }
 
        }
 
        return reverse @rets;
 }
 

-sub rcs_preprevert (@) {
-       my %params = @_;
-       my $rev = $params{rev};
+sub rcs_preprevert ($) {
+       my $rev=shift;
+       my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint
+
+       # Examine changes from root of git repo, not from any subdir,
+       # in order to see all changes.
+       my ($subdir, $rootdir) = git_find_root();
+       $git_dir=$rootdir;
+
+       my @commits=git_commit_info($sha1, 1);
+       if (! @commits) {
+               error "unknown commit"; # just in case
+       }
+
+       # git revert will fail on merge commits. Add a nice message.
+       if (exists $commits[0]->{parents} &&
+           @{$commits[0]->{parents}} > 1) {
+               error gettext("you are not allowed to revert a merge");
+       }
+
+       my @ret=git_parse_changes(1, @commits);

 
 

-       # Note test_changes expects 'cgi' and 'session' parameters.
-       require IkiWiki::Receive;
-       IkiWiki::Receive::test_changes(%params, changes =>
-               [git_parse_changes(git_commit_info($rev, 1))]);
+       $git_dir=undef;
+       return @ret;

 }
 
 }
 

-sub rcs_revert (@) {
-       # Try to revert the given patch; returns undef on _success_.
-       my %params = @_;
-       my $rev = $params{rev};
+sub rcs_revert ($) {
+       # Try to revert the given rev; returns undef on _success_.
+       my $rev = shift;
+       my ($sha1) = $rev =~ /^($sha1_pattern)$/; # untaint

 
 

-       if (run_or_non('git', 'revert', '--no-commit', $rev)) {
-               debug "Committing revert for patch '$rev'.";
-               rcs_commit_staged(message => 
-                       sprintf(gettext("This reverts commit %s"), $rev), @_);
+       if (run_or_non('git', 'revert', '--no-commit', $sha1)) {
+               return undef;

        }
        else {
        }
        else {

-               # No idea what is actually getting reverted, so all we can
-               # do is say we failed.

                run_or_die('git', 'reset', '--hard');
                run_or_die('git', 'reset', '--hard');

-               return sprintf(gettext("Failed to revert commit %s"), $rev);
+               return sprintf(gettext("Failed to revert commit %s"), $sha1);

        }
 }
 
        }
 }
 

-sub rcs_showpatch (@) {
-       # Show the patch with the given revision id.
-       my %params = @_;
-       my $rev = $params{rev};
-
-       return join "\n", run_or_die('git', 'show', $rev);
-}
-

 1
 1