pagestats: add disp parameter

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

diff --git a/IkiWiki/Plugin/svn.pm b/IkiWiki/Plugin/svn.pm
index 0e7df36595b10de27319efdd7a2ffd0c6e93ca62..fd11f2c637597d98915f6a5bc29fc03ff6d0c572 100644 (file)
--- a/IkiWiki/Plugin/svn.pm
+++ b/IkiWiki/Plugin/svn.pm
@@ -1,16 +1,29 @@
 #!/usr/bin/perl
 #!/usr/bin/perl

-
-package IkiWiki;
+package IkiWiki::Plugin::svn;

 
 use warnings;
 use strict;
 use IkiWiki;
 use POSIX qw(setlocale LC_CTYPE);
 
 use warnings;
 use strict;
 use IkiWiki;
 use POSIX qw(setlocale LC_CTYPE);

+use URI::Escape q{uri_escape_utf8};
+
+sub import {
+       hook(type => "checkconfig", id => "svn", call => \&checkconfig);
+       hook(type => "getsetup", id => "svn", call => \&getsetup);
+       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_commit_staged", call => \&rcs_commit_staged);
+       hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
+       hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
+       hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
+       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 => "checkconfig", id => "svn", call => sub { #{{{
-       if (! defined $config{diffurl}) {
-               $config{diffurl}="";
-       }
+sub checkconfig () {

        if (! defined $config{svnpath}) {
                $config{svnpath}="trunk";
        }
        if (! defined $config{svnpath}) {
                $config{svnpath}="trunk";
        }


@@ -20,16 +33,21 @@ hook(type => "checkconfig", id => "svn", call => sub { #{{{
                $config{svnpath}=~s/\/$//;
                $config{svnpath}=~s/^\///;
        }
                $config{svnpath}=~s/\/$//;
                $config{svnpath}=~s/^\///;
        }

-       if (length $config{svn_wrapper}) {
+       if (defined $config{svn_wrapper} && length $config{svn_wrapper}) {

                push @{$config{wrappers}}, {
                        wrapper => $config{svn_wrapper},
                        wrappermode => (defined $config{svn_wrappermode} ? $config{svn_wrappermode} : "04755"),
                };
        }
                push @{$config{wrappers}}, {
                        wrapper => $config{svn_wrapper},
                        wrappermode => (defined $config{svn_wrappermode} ? $config{svn_wrappermode} : "04755"),
                };
        }

-}); #}}}
+}

 
 

-hook(type => "getsetup", id => "svn", call => sub { #{{{
+sub getsetup () {

        return
        return

+               plugin => {
+                       safe => 0, # rcs plugin
+                       rebuild => undef,
+                       section => "rcs",
+               },

                svnrepo => {
                        type => "string",
                        example => "/svn/wiki",
                svnrepo => {
                        type => "string",
                        example => "/svn/wiki",


@@ -47,7 +65,7 @@ hook(type => "getsetup", id => "svn", call => sub { #{{{
                svn_wrapper => {
                        type => "string",
                        example => "/svn/wikirepo/hooks/post-commit",
                svn_wrapper => {
                        type => "string",
                        example => "/svn/wikirepo/hooks/post-commit",

-                       description => "svn post-commit executable to generate",
+                       description => "svn post-commit hook to generate",

                        safe => 0, # file
                        rebuild => 0,
                },
                        safe => 0, # file
                        rebuild => 0,
                },


@@ -72,7 +90,7 @@ hook(type => "getsetup", id => "svn", call => sub { #{{{
                        safe => 1,
                        rebuild => 1,
                },
                        safe => 1,
                        rebuild => 1,
                },

-}); #}}}
+}

 
 # svn needs LC_CTYPE set to a UTF-8 locale, so try to find one. Any will do.
 sub find_lc_ctype() {
 
 # svn needs LC_CTYPE set to a UTF-8 locale, so try to find one. Any will do.
 sub find_lc_ctype() {


@@ -92,101 +110,96 @@ sub find_lc_ctype() {
 
        # fallback to the current locale
        return $current;
 
        # fallback to the current locale
        return $current;

-} # }}}
+}

 $ENV{LC_CTYPE} = $ENV{LC_CTYPE} || find_lc_ctype();
 
 $ENV{LC_CTYPE} = $ENV{LC_CTYPE} || find_lc_ctype();
 

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

        my $field=shift;
        my $file=shift;
 
        my $info=`LANG=C svn info $file`;
        my ($ret)=$info=~/^$field: (.*)$/m;
        return $ret;
        my $field=shift;
        my $file=shift;
 
        my $info=`LANG=C svn info $file`;
        my ($ret)=$info=~/^$field: (.*)$/m;
        return $ret;

-} #}}}
+}

 
 

-sub rcs_update () { #{{{
-       if (-d "$config{srcdir}/.svn") {
-               if (system("svn", "update", "--quiet", $config{srcdir}) != 0) {
-                       warn("svn update failed\n");
-               }
+sub rcs_update () {
+       if (system("svn", "update", "--quiet", $config{srcdir}) != 0) {
+               warn("svn update failed\n");

        }
        }

-} #}}}
+}

 
 

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

        # Prepares to edit a file under revision control. Returns a token
        # that must be passed into rcs_commit when the file is ready
        # for committing.
        # The file is relative to the srcdir.
        my $file=shift;
        
        # Prepares to edit a file under revision control. Returns a token
        # that must be passed into rcs_commit when the file is ready
        # for committing.
        # The file is relative to the srcdir.
        my $file=shift;
        

-       if (-d "$config{srcdir}/.svn") {
-               # For subversion, return the revision of the file when
-               # editing begins.
-               my $rev=svn_info("Revision", "$config{srcdir}/$file");
-               return defined $rev ? $rev : "";
+       # For subversion, return the revision of the file when
+       # editing begins.
+       my $rev=svn_info("Revision", "$config{srcdir}/$file");
+       return defined $rev ? $rev : "";
+}
+
+sub commitmessage (@) {
+       my %params=@_;
+
+       if (defined $params{session}) {
+               if (defined $params{session}->param("name")) {
+                       return "web commit by ".
+                               $params{session}->param("name").
+                               (length $params{message} ? ": $params{message}" : "");
+               }
+               elsif (defined $params{session}->remote_addr()) {
+                       return "web commit from ".
+                               $params{session}->remote_addr().
+                               (length $params{message} ? ": $params{message}" : "");
+               }

        }
        }

-} #}}}
+       return $params{message};
+}

 
 

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

        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
        # The file is relative to the srcdir.
        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
        # The file is relative to the srcdir.

-       my $file=shift;
-       my $message=shift;
-       my $rcstoken=shift;
-       my $user=shift;
-       my $ipaddr=shift;
-
-       if (defined $user) {
-               $message="web commit by $user".(length $message ? ": $message" : "");
-       }
-       elsif (defined $ipaddr) {
-               $message="web commit from $ipaddr".(length $message ? ": $message" : "");
-       }
-
-       if (-d "$config{srcdir}/.svn") {
-               # Check to see if the page has been changed by someone
-               # else since rcs_prepedit was called.
-               my ($oldrev)=$rcstoken=~/^([0-9]+)$/; # untaint
-               my $rev=svn_info("Revision", "$config{srcdir}/$file");
-               if (defined $rev && defined $oldrev && $rev != $oldrev) {
-                       # Merge their changes into the file that we've
-                       # changed.
-                       if (system("svn", "merge", "--quiet", "-r$oldrev:$rev",
-                                  "$config{srcdir}/$file", "$config{srcdir}/$file") != 0) {
-                               warn("svn merge -r$oldrev:$rev failed\n");
-                       }
+       my %params=@_;
+
+       # Check to see if the page has been changed by someone
+       # else since rcs_prepedit was called.
+       my ($oldrev)=$params{token}=~/^([0-9]+)$/; # untaint
+       my $rev=svn_info("Revision", "$config{srcdir}/$params{file}");
+       if (defined $rev && defined $oldrev && $rev != $oldrev) {
+               # Merge their changes into the file that we've
+               # changed.
+               if (system("svn", "merge", "--quiet", "-r$oldrev:$rev",
+                          "$config{srcdir}/$params{file}", "$config{srcdir}/$params{file}") != 0) {
+                       warn("svn merge -r$oldrev:$rev failed\n");

                }
                }

+       }

 
 

-               if (system("svn", "commit", "--quiet", 
-                          "--encoding", "UTF-8", "-m",
-                          possibly_foolish_untaint($message),
-                          $config{srcdir}) != 0) {
-                       my $conflict=readfile("$config{srcdir}/$file");
-                       if (system("svn", "revert", "--quiet", "$config{srcdir}/$file") != 0) {
-                               warn("svn revert failed\n");
-                       }
-                       return $conflict;
+       if (system("svn", "commit", "--quiet", 
+                  "--encoding", "UTF-8", "-m",
+                  IkiWiki::possibly_foolish_untaint(commitmessage(%params)),
+                  $config{srcdir}) != 0) {
+               my $conflict=readfile("$config{srcdir}/$params{file}");
+               if (system("svn", "revert", "--quiet", "$config{srcdir}/$params{file}") != 0) {
+                       warn("svn revert failed\n");

                }
                }

+               return $conflict;

        }
        }

+

        return undef # success
        return undef # success

-} #}}}
+}

 
 

-sub rcs_commit_staged ($$$) {
+sub rcs_commit_staged (@) {

        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.
        # Commits all staged changes. Changes can be staged using rcs_add,
        # rcs_remove, and rcs_rename.

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

        
        if (system("svn", "commit", "--quiet",
                   "--encoding", "UTF-8", "-m",
        
        if (system("svn", "commit", "--quiet",
                   "--encoding", "UTF-8", "-m",

-                  possibly_foolish_untaint($message),
+                  IkiWiki::possibly_foolish_untaint(commitmessage(%params)),

                   $config{srcdir}) != 0) {
                warn("svn commit failed\n");
                return 1; # failure     
                   $config{srcdir}) != 0) {
                warn("svn commit failed\n");
                return 1; # failure     


@@ -194,63 +207,38 @@ sub rcs_commit_staged ($$$) {
        return undef # success
 }
 
        return undef # success
 }
 

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

        # filename is relative to the root of the srcdir
        my $file=shift;
 
        # filename is relative to the root of the srcdir
        my $file=shift;
 

-       if (-d "$config{srcdir}/.svn") {
-               my $parent=dirname($file);
-               while (! -d "$config{srcdir}/$parent/.svn") {
-                       $file=$parent;
-                       $parent=dirname($file);
-               }
-               
-               if (system("svn", "add", "--quiet", "$config{srcdir}/$file") != 0) {
-                       warn("svn add failed\n");
-               }
+       if (system("svn", "add", "--parents", "--quiet", "$config{srcdir}/$file") != 0) {
+               warn("svn add failed\n");

        }
        }

-} #}}}
+}

 
 

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

        # filename is relative to the root of the srcdir
        my $file=shift;
 
        # filename is relative to the root of the srcdir
        my $file=shift;
 

-       if (-d "$config{srcdir}/.svn") {
-               if (system("svn", "rm", "--force", "--quiet", "$config{srcdir}/$file") != 0) {
-                       warn("svn rm failed\n");
-               }
+       if (system("svn", "rm", "--force", "--quiet", "$config{srcdir}/$file") != 0) {
+               warn("svn rm failed\n");

        }
        }

-} #}}}
+}

 
 

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

        # filenames relative to the root of the srcdir
        my ($src, $dest)=@_;
        
        # filenames relative to the root of the srcdir
        my ($src, $dest)=@_;
        

-       if (-d "$config{srcdir}/.svn") {
-               # Add parent directory for $dest
-               my $parent=dirname($dest);
-               if (! -d "$config{srcdir}/$parent/.svn") {
-                       while (! -d "$config{srcdir}/$parent/.svn") {
-                               $parent=dirname($dest);
-                       }
-                       if (system("svn", "add", "--quiet", "$config{srcdir}/$parent") != 0) {
-                               warn("svn add $parent failed\n");
-                       }
-               }
-
-               if (system("svn", "mv", "--force", "--quiet", 
-                   "$config{srcdir}/$src", "$config{srcdir}/$dest") != 0) {
-                       warn("svn rename failed\n");
-               }
+       if (system("svn", "mv", "--parents", "--force", "--quiet", 
+           "$config{srcdir}/$src", "$config{srcdir}/$dest") != 0) {
+               warn("svn rename failed\n");

        }
        }

-} #}}}
+}

 
 

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

        my $num=shift;
        my @ret;
        
        my $num=shift;
        my @ret;
        

-       return unless -d "$config{srcdir}/.svn";
-

        eval q{
                use Date::Parse;
                use XML::SAX;
        eval q{
                use Date::Parse;
                use XML::SAX;


@@ -304,8 +292,9 @@ sub rcs_recentchanges ($) { #{{{
                                $file=$1;
                        }
 
                                $file=$1;
                        }
 

-                       my $diffurl=$config{diffurl};
-                       $diffurl=~s/\[\[file\]\]/$file/g;
+                       my $diffurl=defined $config{diffurl} ? $config{diffurl} : "";
+                       my $efile = uri_escape_utf8($file);
+                       $diffurl=~s/\[\[file\]\]/$efile/g;

                        $diffurl=~s/\[\[r1\]\]/$rev - 1/eg;
                        $diffurl=~s/\[\[r2\]\]/$rev/g;
 
                        $diffurl=~s/\[\[r1\]\]/$rev - 1/eg;
                        $diffurl=~s/\[\[r2\]\]/$rev/g;
 


@@ -326,41 +315,66 @@ sub rcs_recentchanges ($) { #{{{
        }
 
        return @ret;
        }
 
        return @ret;

-} #}}}
+}

 
 

-sub rcs_diff ($) { #{{{
-       my $rev=possibly_foolish_untaint(int(shift));
+sub rcs_diff ($;$) {
+       my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
+       my $maxlines=shift;

        return `svnlook diff $config{svnrepo} -r$rev --no-diff-deleted`;
        return `svnlook diff $config{svnrepo} -r$rev --no-diff-deleted`;

-} #}}}
+}
+
+{

 
 

-sub rcs_getctime ($) { #{{{
+my ($lastfile, $lastmtime, $lastctime);
+
+sub findtimes ($) {

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

+       if (defined $lastfile && $lastfile eq $file) {
+               return $lastmtime, $lastctime;
+       }
+       $lastfile=$file;
+

        my $svn_log_infoline=qr/^r\d+\s+\|\s+[^\s]+\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
                
        my $child = open(SVNLOG, "-|");
        if (! $child) {
        my $svn_log_infoline=qr/^r\d+\s+\|\s+[^\s]+\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
                
        my $child = open(SVNLOG, "-|");
        if (! $child) {

-               exec("svn", "log", $file) || error("svn log $file failed to run");
+               exec("svn", "log", "$config{srcdir}/$file") || error("svn log failed to run");

        }
 
        }
 

-       my $date;
+       my ($cdate, $mdate);

        while (<SVNLOG>) {
                if (/$svn_log_infoline/) {
        while (<SVNLOG>) {
                if (/$svn_log_infoline/) {

-                       $date=$1;
+                       $cdate=$1;
+                       $mdate=$1 unless defined $mdate;

                }
        }
                }
        }

-       close SVNLOG || warn "svn log $file exited $?";
+       close SVNLOG || error "svn log exited $?";

 
 

-       if (! defined $date) {
-               warn "failed to parse svn log for $file\n";
-               return 0;
+       if (! defined $cdate) {
+               error "failed to parse svn log for $file";

        }
                
        eval q{use Date::Parse};
        error($@) if $@;
        }
                
        eval q{use Date::Parse};
        error($@) if $@;

-       $date=str2time($date);
-       debug("found ctime ".localtime($date)." for $file");
-       return $date;
-} #}}}
+       
+       $lastctime=str2time($cdate);
+       $lastmtime=str2time($mdate);
+       return $lastmtime, $lastctime;
+}
+
+}
+
+sub rcs_getctime ($) {
+       my $file=shift;
+
+       return (findtimes($file))[1];
+}
+
+sub rcs_getmtime ($) {
+       my $file=shift;
+
+       return (findtimes($file))[0];
+}

 
 1
 
 1