add influence info for failed metadata matches

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

diff --git a/IkiWiki/Plugin/git.pm b/IkiWiki/Plugin/git.pm
index e565f63691cfd09935338f33e6734a41b313f660..aa402c04f4e461b9450a0192313de1dda8726f49 100644 (file)
--- a/IkiWiki/Plugin/git.pm
+++ b/IkiWiki/Plugin/git.pm
@@ -11,9 +11,10 @@ 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 $dummy_commit_msg = 'dummy commit';      # message to skip in recent changes
 my $no_chdir=0;
 

-sub import { #{{{
+sub import {

        hook(type => "checkconfig", id => "git", call => \&checkconfig);
        hook(type => "getsetup", id => "git", call => \&getsetup);
        hook(type => "checkconfig", id => "git", call => \&checkconfig);
        hook(type => "getsetup", id => "git", call => \&getsetup);

+       hook(type => "genwrapper", id => "git", call => \&genwrapper);

        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
        hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
        hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);


@@ -24,10 +25,11 @@ sub import { #{{{
        hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
        hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
        hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
        hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
        hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);

+       hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);

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

-} #}}}
+}

 
 

-sub checkconfig () { #{{{
+sub checkconfig () {

        if (! defined $config{gitorigin_branch}) {
                $config{gitorigin_branch}="origin";
        }
        if (! defined $config{gitorigin_branch}) {
                $config{gitorigin_branch}="origin";
        }


@@ -41,21 +43,33 @@ sub checkconfig () { #{{{
                        wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
                };
        }
                        wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),
                };
        }

+

        if (defined $config{git_test_receive_wrapper} &&
            length $config{git_test_receive_wrapper}) {
                push @{$config{wrappers}}, {
                        test_receive => 1,
                        wrapper => $config{git_test_receive_wrapper},
        if (defined $config{git_test_receive_wrapper} &&
            length $config{git_test_receive_wrapper}) {
                push @{$config{wrappers}}, {
                        test_receive => 1,
                        wrapper => $config{git_test_receive_wrapper},

-                       wrappermode => "0755",
+                       wrappermode => (defined $config{git_wrappermode} ? $config{git_wrappermode} : "06755"),

                };
        }
                };
        }

-} #}}}

 
 

-sub getsetup () { #{{{
+       # Avoid notes, parser does not handle and they only slow things down.
+       $ENV{GIT_NOTES_REF}="";
+       
+       # Run receive test only if being called by the wrapper, and not
+       # when generating same.
+       if ($config{test_receive} && ! exists $config{wrapper}) {
+               require IkiWiki::Receive;
+               IkiWiki::Receive::test();
+       }
+}
+
+sub getsetup () {

        return
                plugin => {
                        safe => 0, # rcs plugin
                        rebuild => undef,
        return
                plugin => {
                        safe => 0, # rcs plugin
                        rebuild => undef,

+                       section => "rcs",

                },
                git_wrapper => {
                        type => "string",
                },
                git_wrapper => {
                        type => "string",


@@ -94,8 +108,8 @@ sub getsetup () { #{{{
                },
                diffurl => {
                        type => "string",
                },
                diffurl => {
                        type => "string",

-                       example => "http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
-                       description => "gitweb url to show a diff ([[sha1_to]], [[sha1_from]], [[sha1_parent]], and [[file]] substituted)",
+                       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]]",
+                       description => "gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)",

                        safe => 1,
                        rebuild => 1,
                },
                        safe => 1,
                        rebuild => 1,
                },


@@ -113,9 +127,19 @@ sub getsetup () { #{{{
                        safe => 0, # paranoia
                        rebuild => 0,
                },
                        safe => 0, # paranoia
                        rebuild => 0,
                },

-} #}}}
+}

 
 

-sub safe_git (&@) { #{{{
+sub genwrapper {
+       if ($config{test_receive}) {
+               require IkiWiki::Receive;
+               return IkiWiki::Receive::genwrapper();
+       }
+       else {
+               return "";
+       }
+}
+
+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 /bin/sh.
        # Return command output or success state (in scalar context).
 


@@ -136,9 +160,17 @@ sub safe_git (&@) { #{{{
        }
        # In parent.
 
        }
        # In parent.
 

+       # git output is probably utf-8 encoded, but may contain
+       # other encodings or invalidly encoded stuff. So do not rely
+       # on the normal utf-8 IO layer, decode it by hand.
+       binmode($OUT);
+

        my @lines;
        while (<$OUT>) {
        my @lines;
        while (<$OUT>) {

+               $_=decode_utf8($_, 0);
+

                chomp;
                chomp;

+

                push @lines, $_;
        }
 
                push @lines, $_;
        }
 


@@ -152,9 +184,9 @@ sub safe_git (&@) { #{{{
 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, @_) }
 sub run_or_cry ($@) { safe_git(sub { warn @_ },  @_) }
 sub run_or_non ($@) { safe_git(undef,            @_) }

-#}}}

 
 

-sub merge_past ($$$) { #{{{
+
+sub merge_past ($$$) {

        # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
        # Git merge commands work with the committed changes, except in the
        # implicit case of '-m' of git checkout(1).  So we should invent a
        # Unlike with Subversion, Git cannot make a 'svn merge -rN:M file'.
        # Git merge commands work with the committed changes, except in the
        # implicit case of '-m' of git checkout(1).  So we should invent a


@@ -246,9 +278,9 @@ sub merge_past ($$$) { #{{{
        error("Git merge failed!\n$failure\n") if $failure;
 
        return $conflict;
        error("Git merge failed!\n$failure\n") if $failure;
 
        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.
 


@@ -358,9 +390,9 @@ sub parse_diff_tree ($@) { #{{{
        }
 
        return \%ci;
        }
 
        return \%ci;

-} #}}}
+}

 
 

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

        # Return an array of commit info hashes of num commits
        # starting from the given sha1sum.
        my ($sha1, $num) = @_;
        # Return an array of commit info hashes of num commits
        # starting from the given sha1sum.
        my ($sha1, $num) = @_;


@@ -381,9 +413,9 @@ sub git_commit_info ($;$) { #{{{
        warn "Cannot parse commit info for '$sha1' commit" if !@ci;
 
        return wantarray ? @ci : $ci[0];
        warn "Cannot parse commit info for '$sha1' commit" if !@ci;
 
        return wantarray ? @ci : $ci[0];

-} #}}}
+}

 
 

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

        # Return head sha1sum (of given file).
        my $file = shift || q{--};
 
        # Return head sha1sum (of given file).
        my $file = shift || q{--};
 


@@ -392,27 +424,30 @@ sub git_sha1 (;$) { #{{{
                '--', $file);
        if ($sha1) {
                ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
                '--', $file);
        if ($sha1) {
                ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now

-       } else { debug("Empty sha1sum for '$file'.") }
+       }
+       else {
+               debug("Empty sha1sum for '$file'.");
+       }

        return defined $sha1 ? $sha1 : q{};
        return defined $sha1 ? $sha1 : q{};

-} #}}}
+}

 
 

-sub rcs_update () { #{{{
+sub rcs_update () {

        # Update working directory.
 
        if (length $config{gitorigin_branch}) {
                run_or_cry('git', 'pull', $config{gitorigin_branch});
        }
        # Update working directory.
 
        if (length $config{gitorigin_branch}) {
                run_or_cry('git', 'pull', $config{gitorigin_branch});
        }

-} #}}}
+}

 
 

-sub rcs_prepedit ($) { #{{{
+sub rcs_prepedit ($) {

        # Return the commit sha1sum of the file when editing begins.
        # This will be later used in rcs_commit if a merge is required.
        my ($file) = @_;
 
        return git_sha1($file);
        # Return the commit sha1sum of the file when editing begins.
        # This will be later used in rcs_commit if a merge is required.
        my ($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.


@@ -431,7 +466,7 @@ sub rcs_commit ($$$;$$) { #{{{
 
        rcs_add($file); 
        return rcs_commit_staged($message, $user, $ipaddr);
 
        rcs_add($file); 
        return rcs_commit_staged($message, $user, $ipaddr);

-} #}}}
+}

 
 sub rcs_commit_staged ($$$) {
        # Commits all staged changes. Changes can be staged using rcs_add,
 
 sub rcs_commit_staged ($$$) {
        # Commits all staged changes. Changes can be staged using rcs_add,


@@ -441,7 +476,7 @@ sub rcs_commit_staged ($$$) {
        # Set the commit author and email to the web committer.
        my %env=%ENV;
        if (defined $user || defined $ipaddr) {
        # Set the commit author and email to the web committer.
        my %env=%ENV;
        if (defined $user || defined $ipaddr) {

-               my $u=defined $user ? $user : $ipaddr;
+               my $u=encode_utf8(defined $user ? $user : $ipaddr);

                $ENV{GIT_AUTHOR_NAME}=$u;
                $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
        }
                $ENV{GIT_AUTHOR_NAME}=$u;
                $ENV{GIT_AUTHOR_EMAIL}="$u\@web";
        }


@@ -472,29 +507,29 @@ sub rcs_commit_staged ($$$) {
        return undef; # success
 }
 
        return undef; # success
 }
 

-sub rcs_add ($) { # {{{
+sub rcs_add ($) {

        # Add file to archive.
 
        my ($file) = @_;
 
        run_or_cry('git', 'add', $file);
        # Add file to archive.
 
        my ($file) = @_;
 
        run_or_cry('git', 'add', $file);

-} #}}}
+}

 
 

-sub rcs_remove ($) { # {{{
+sub rcs_remove ($) {

        # Remove file from archive.
 
        my ($file) = @_;
 
        run_or_cry('git', 'rm', '-f', $file);
        # Remove file from archive.
 
        my ($file) = @_;
 
        run_or_cry('git', 'rm', '-f', $file);

-} #}}}
+}

 
 

-sub rcs_rename ($$) { # {{{
+sub rcs_rename ($$) {

        my ($src, $dest) = @_;
 
        run_or_cry('git', 'mv', '-f', $src, $dest);
        my ($src, $dest) = @_;
 
        run_or_cry('git', 'mv', '-f', $src, $dest);

-} #}}}
+}

 
 

-sub rcs_recentchanges ($) { #{{{
+sub rcs_recentchanges ($) {

        # List of recent changes.
 
        my ($num) = @_;
        # List of recent changes.
 
        my ($num) = @_;


@@ -521,6 +556,7 @@ sub rcs_recentchanges ($) { #{{{
                        $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
                        $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
                        $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;
                        $diffurl =~ s/\[\[sha1_parent\]\]/$ci->{'parent'}/go;
                        $diffurl =~ s/\[\[sha1_from\]\]/$detail->{'sha1_from'}/go;
                        $diffurl =~ s/\[\[sha1_to\]\]/$detail->{'sha1_to'}/go;

+                       $diffurl =~ s/\[\[sha1_commit\]\]/$sha1/go;

 
                        push @pages, {
                                page => pagename($file),
 
                        push @pages, {
                                page => pagename($file),


@@ -561,9 +597,9 @@ sub rcs_recentchanges ($) { #{{{
        }
 
        return @rets;
        }
 
        return @rets;

-} #}}}
+}

 
 

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

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


@@ -578,22 +614,56 @@ sub rcs_diff ($) { #{{{
        else {
                return join("", @lines);
        }
        else {
                return join("", @lines);
        }

-} #}}}
+}
+
+{
+my %time_cache;

 
 

-sub rcs_getctime ($) { #{{{
+sub findtimes ($$) {

        my $file=shift;
        my $file=shift;

+       my $id=shift; # 0 = mtime ; 1 = ctime
+

        # Remove srcdir prefix
        $file =~ s/^\Q$config{srcdir}\E\/?//;
 
        # Remove srcdir prefix
        $file =~ s/^\Q$config{srcdir}\E\/?//;
 

-       my $sha1  = git_sha1($file);
-       my $ci    = git_commit_info($sha1, 1);
-       my $ctime = $ci->{'author_epoch'};
-       debug("ctime for '$file': ". localtime($ctime));
+       if (! keys %time_cache) {
+               my $date;
+               foreach my $line (run_or_die('git', 'log',
+                               '--pretty=format:%ct',
+                               '--name-only', '--relative')) {
+                       if (! defined $date && $line =~ /^(\d+)$/) {
+                               $date=$line;
+                       }
+                       elsif (! length $line) {
+                               $date=undef;
+                       }
+                       else {
+                               if (! $time_cache{$line}) {
+                                       $time_cache{$line}[0]=$date; # mtime
+                               }
+                               $time_cache{$line}[1]=$date; # ctime
+                       }
+               }
+       }
+
+       return exists $time_cache{$file} ? $time_cache{$file}[$id] : 0;
+}
+
+}
+
+sub rcs_getctime ($) {
+       my $file=shift;
+
+       return findtimes($file, 1);
+}
+
+sub rcs_getmtime ($) {
+       my $file=shift;

 
 

-       return $ctime;
-} #}}}
+       return findtimes($file, 0);
+}

 
 

-sub rcs_receive () { #{{{
+sub rcs_receive () {

        # 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.
        # 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.


@@ -643,15 +713,6 @@ sub rcs_receive () { #{{{
                                elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
                                        $action="add";
                                        $mode=$detail->{'mode_to'};
                                elsif ($detail->{'status'} =~ /^[AM]+\d*$/) {
                                        $action="add";
                                        $mode=$detail->{'mode_to'};

-                                       if (! pagetype($file)) {
-                                               eval q{use File::Temp};
-                                               die $@ if $@;
-                                               my $fh;
-                                               ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
-                                               if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
-                                                       error("failed writing temp file");
-                                               }
-                                       }

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


@@ -670,6 +731,18 @@ sub rcs_receive () { #{{{
                                                error gettext("you are not allowed to change file modes");
                                        }
                                }
                                                error gettext("you are not allowed to change file modes");
                                        }
                                }

+                               
+                               # extract attachment to temp file
+                               if (($action eq 'add' || $action eq 'change') &&
+                                    ! pagetype($file)) {
+                                       eval q{use File::Temp};
+                                       die $@ if $@;
+                                       my $fh;
+                                       ($fh, $path)=File::Temp::tempfile("XXXXXXXXXX", UNLINK => 1);
+                                       if (system("git show ".$detail->{sha1_to}." > '$path'") != 0) {
+                                               error("failed writing temp file");
+                                       }
+                               }

 
                                push @rets, {
                                        file => $file,
 
                                push @rets, {
                                        file => $file,


@@ -681,6 +754,6 @@ sub rcs_receive () { #{{{
        }
 
        return reverse @rets;
        }
 
        return reverse @rets;

-} #}}}
+}

 
 1
 
 1