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 05312a1ed42d2ae08189c5c665e53b7c91c7b80a..7d27ec8427b1b341c1dc7e9d3d3b92f2a4e838a1 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,12 +19,9 @@ 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);

-} #}}}
+}

 
 

-sub checkconfig () { #{{{
-       if (! defined $config{diffurl}) {
-               $config{diffurl}="";
-       }
+sub checkconfig () {

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


@@ -40,10 +37,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",


@@ -61,7 +63,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,
                },


@@ -86,7 +88,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() {


@@ -106,27 +108,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.


@@ -139,9 +141,9 @@ 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 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.


@@ -184,7 +186,7 @@ sub rcs_commit ($$$;$$) { #{{{
                }
        }
        return undef # success
                }
        }
        return undef # success

-} #}}}
+}

 
 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,


@@ -208,7 +210,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;
 


@@ -223,9 +225,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;
 


@@ -234,18 +236,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");


@@ -257,9 +259,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;
        


@@ -318,7 +320,7 @@ sub rcs_recentchanges ($) { #{{{
                                $file=$1;
                        }
 
                                $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;
                        $diffurl=~s/\[\[file\]\]/$file/g;
                        $diffurl=~s/\[\[r1\]\]/$rev - 1/eg;
                        $diffurl=~s/\[\[r2\]\]/$rev/g;


@@ -340,14 +342,14 @@ 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 ($) { #{{{
+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+).*/;
        my $file=shift;
 
        my $svn_log_infoline=qr/^r\d+\s+\|\s+[^\s]+\s+\|\s+(\d+-\d+-\d+\s+\d+:\d+:\d+\s+[-+]?\d+).*/;


@@ -375,6 +377,6 @@ sub rcs_getctime ($) { #{{{
        $date=str2time($date);
        debug("found ctime ".localtime($date)." for $file");
        return $date;
        $date=str2time($date);
        debug("found ctime ".localtime($date)." for $file");
        return $date;

-} #}}}
+}

 
 1
 
 1