(no commit message)

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

diff --git a/IkiWiki/Plugin/svn.pm b/IkiWiki/Plugin/svn.pm
index 51683704c5928d6e5577a3e1f92b62adbb41849f..9cf82b5db3c4ce663a552cee9acd7cd22e665c3c 100644 (file)
--- a/IkiWiki/Plugin/svn.pm
+++ b/IkiWiki/Plugin/svn.pm
@@ -6,7 +6,7 @@ use strict;
 use IkiWiki;
 use POSIX qw(setlocale LC_CTYPE);
 
 use IkiWiki;
 use POSIX qw(setlocale LC_CTYPE);
 

-sub import { #{{{
+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 => "checkconfig", id => "svn", call => \&checkconfig);
        hook(type => "getsetup", id => "svn", call => \&getsetup);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);


@@ -19,9 +19,10 @@ 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);
+}

 
 

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

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


@@ -37,10 +38,15 @@ sub checkconfig () { #{{{
                        wrappermode => (defined $config{svn_wrappermode} ? $config{svn_wrappermode} : "04755"),
                };
        }
                        wrappermode => (defined $config{svn_wrappermode} ? $config{svn_wrappermode} : "04755"),
                };
        }

-} #}}}
+}

 
 

-sub getsetup () { #{{{
+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",


@@ -58,7 +64,7 @@ sub getsetup () { #{{{
                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,
                },


@@ -83,7 +89,7 @@ sub getsetup () { #{{{
                        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() {


@@ -103,27 +109,27 @@ 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 () { #{{{
+sub rcs_update () {

        if (-d "$config{srcdir}/.svn") {
                if (system("svn", "update", "--quiet", $config{srcdir}) != 0) {
                        warn("svn update failed\n");
                }
        }
        if (-d "$config{srcdir}/.svn") {
                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.
        # 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.


@@ -136,68 +142,68 @@ sub rcs_prepedit ($) { #{{{
                my $rev=svn_info("Revision", "$config{srcdir}/$file");
                return defined $rev ? $rev : "";
        }
                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" : "");
-       }
+       my %params=@_;

 
        if (-d "$config{srcdir}/.svn") {
                # Check to see if the page has been changed by someone
                # else since rcs_prepedit was called.
 
        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");
+               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",
                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) {
+                                  "$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",
                                warn("svn merge -r$oldrev:$rev failed\n");
                        }
                }
 
                if (system("svn", "commit", "--quiet", 
                           "--encoding", "UTF-8", "-m",

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

                           $config{srcdir}) != 0) {
                           $config{srcdir}) != 0) {

-                       my $conflict=readfile("$config{srcdir}/$file");
-                       if (system("svn", "revert", "--quiet", "$config{srcdir}/$file") != 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
                                warn("svn revert failed\n");
                        }
                        return $conflict;
                }
        }
        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",

-                  IkiWiki::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     


@@ -205,7 +211,7 @@ 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;
 


@@ -220,9 +226,9 @@ sub rcs_add ($) { #{{{
                        warn("svn add failed\n");
                }
        }
                        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;
 


@@ -231,18 +237,18 @@ sub rcs_remove ($) { #{{{
                        warn("svn rm failed\n");
                }
        }
                        warn("svn rm failed\n");
                }
        }

-} #}}}
+}

 
 

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

        # filenames relative to the root of the srcdir
        my ($src, $dest)=@_;
        
        if (-d "$config{srcdir}/.svn") {
                # Add parent directory for $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);
+               my $parent=IkiWiki::dirname($dest);

                if (! -d "$config{srcdir}/$parent/.svn") {
                        while (! -d "$config{srcdir}/$parent/.svn") {
                if (! -d "$config{srcdir}/$parent/.svn") {
                        while (! -d "$config{srcdir}/$parent/.svn") {

-                               $parent=dirname($dest);
+                               $parent=IkiWiki::dirname($dest);

                        }
                        if (system("svn", "add", "--quiet", "$config{srcdir}/$parent") != 0) {
                                warn("svn add $parent failed\n");
                        }
                        if (system("svn", "add", "--quiet", "$config{srcdir}/$parent") != 0) {
                                warn("svn add $parent failed\n");


@@ -254,9 +260,9 @@ sub rcs_rename ($$) { #{{{
                        warn("svn rename failed\n");
                }
        }
                        warn("svn rename failed\n");
                }
        }

-} #}}}
+}

 
 

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

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


@@ -337,41 +343,65 @@ sub rcs_recentchanges ($) { #{{{
        }
 
        return @ret;
        }
 
        return @ret;

-} #}}}
+}

 
 

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

        my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
        return `svnlook diff $config{svnrepo} -r$rev --no-diff-deleted`;
        my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
        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