Group related plugins into sections in the setup file, and drop unused rcs plugins...

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

diff --git a/IkiWiki/Plugin/svn.pm b/IkiWiki/Plugin/svn.pm
index 0e7df36595b10de27319efdd7a2ffd0c6e93ca62..7d27ec8427b1b341c1dc7e9d3d3b92f2a4e838a1 100644 (file)
--- a/IkiWiki/Plugin/svn.pm
+++ b/IkiWiki/Plugin/svn.pm
@@ -1,16 +1,27 @@
 #!/usr/bin/perl
-
-package IkiWiki;
+package IkiWiki::Plugin::svn;
 
 use warnings;
 use strict;
 use IkiWiki;
 use POSIX qw(setlocale LC_CTYPE);
 
-hook(type => "checkconfig", id => "svn", call => sub { #{{{
-       if (! defined $config{diffurl}) {
-               $config{diffurl}="";
-       }
+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);
+}
+
+sub checkconfig () {
        if (! defined $config{svnpath}) {
                $config{svnpath}="trunk";
        }
@@ -20,16 +31,21 @@ hook(type => "checkconfig", id => "svn", call => sub { #{{{
                $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"),
                };
        }
-}); #}}}
+}
 
-hook(type => "getsetup", id => "svn", call => sub { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 0, # rcs plugin
+                       rebuild => undef,
+                       section => "rcs",
+               },
                svnrepo => {
                        type => "string",
                        example => "/svn/wiki",
@@ -47,7 +63,7 @@ hook(type => "getsetup", id => "svn", call => sub { #{{{
                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,
                },
@@ -72,7 +88,7 @@ hook(type => "getsetup", id => "svn", call => sub { #{{{
                        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() {
@@ -92,27 +108,27 @@ sub find_lc_ctype() {
 
        # fallback to the current locale
        return $current;
-} # }}}
+}
 $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;
-} #}}}
+}
 
-sub rcs_update () { #{{{
+sub rcs_update () {
        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.
@@ -125,9 +141,9 @@ sub rcs_prepedit ($) { #{{{
                my $rev=svn_info("Revision", "$config{srcdir}/$file");
                return defined $rev ? $rev : "";
        }
-} #}}}
+}
 
-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.
@@ -160,7 +176,7 @@ sub rcs_commit ($$$;$$) { #{{{
 
                if (system("svn", "commit", "--quiet", 
                           "--encoding", "UTF-8", "-m",
-                          possibly_foolish_untaint($message),
+                          IkiWiki::possibly_foolish_untaint($message),
                           $config{srcdir}) != 0) {
                        my $conflict=readfile("$config{srcdir}/$file");
                        if (system("svn", "revert", "--quiet", "$config{srcdir}/$file") != 0) {
@@ -170,7 +186,7 @@ sub rcs_commit ($$$;$$) { #{{{
                }
        }
        return undef # success
-} #}}}
+}
 
 sub rcs_commit_staged ($$$) {
        # Commits all staged changes. Changes can be staged using rcs_add,
@@ -186,7 +202,7 @@ sub rcs_commit_staged ($$$) {
        
        if (system("svn", "commit", "--quiet",
                   "--encoding", "UTF-8", "-m",
-                  possibly_foolish_untaint($message),
+                  IkiWiki::possibly_foolish_untaint($message),
                   $config{srcdir}) != 0) {
                warn("svn commit failed\n");
                return 1; # failure     
@@ -194,24 +210,24 @@ sub rcs_commit_staged ($$$) {
        return undef # success
 }
 
-sub rcs_add ($) { #{{{
+sub rcs_add ($) {
        # filename is relative to the root of the srcdir
        my $file=shift;
 
        if (-d "$config{srcdir}/.svn") {
-               my $parent=dirname($file);
+               my $parent=IkiWiki::dirname($file);
                while (! -d "$config{srcdir}/$parent/.svn") {
                        $file=$parent;
-                       $parent=dirname($file);
+                       $parent=IkiWiki::dirname($file);
                }
                
                if (system("svn", "add", "--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;
 
@@ -220,18 +236,18 @@ sub rcs_remove ($) { #{{{
                        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
-               my $parent=dirname($dest);
+               my $parent=IkiWiki::dirname($dest);
                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");
@@ -243,9 +259,9 @@ sub rcs_rename ($$) { #{{{
                        warn("svn rename failed\n");
                }
        }
-} #}}}
+}
 
-sub rcs_recentchanges ($) { #{{{
+sub rcs_recentchanges ($) {
        my $num=shift;
        my @ret;
        
@@ -304,7 +320,7 @@ sub rcs_recentchanges ($) { #{{{
                                $file=$1;
                        }
 
-                       my $diffurl=$config{diffurl};
+                       my $diffurl=defined $config{diffurl} ? $config{diffurl} : "";
                        $diffurl=~s/\[\[file\]\]/$file/g;
                        $diffurl=~s/\[\[r1\]\]/$rev - 1/eg;
                        $diffurl=~s/\[\[r2\]\]/$rev/g;
@@ -326,14 +342,14 @@ sub rcs_recentchanges ($) { #{{{
        }
 
        return @ret;
-} #}}}
+}
 
-sub rcs_diff ($) { #{{{
-       my $rev=possibly_foolish_untaint(int(shift));
+sub rcs_diff ($) {
+       my $rev=IkiWiki::possibly_foolish_untaint(int(shift));
        return `svnlook diff $config{svnrepo} -r$rev --no-diff-deleted`;
-} #}}}
+}
 
-sub rcs_getctime ($) { #{{{
+sub rcs_getctime ($) {
        my $file=shift;
 
        my $svn_log_infoline=qr/^r\d+\s+\|\s+[^\s]+\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;
@@ -361,6 +377,6 @@ sub rcs_getctime ($) { #{{{
        $date=str2time($date);
        debug("found ctime ".localtime($date)." for $file");
        return $date;
-} #}}}
+}
 
 1