po: move most of filter code to its own function

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

diff --git a/IkiWiki/Plugin/monotone.pm b/IkiWiki/Plugin/monotone.pm
index d7e8f296a69f6d80c205ebbcaa4e40f3dc49e8a3..38abb9a07f21a3cc53ef430a012fb0528ba841a0 100644 (file)
--- a/IkiWiki/Plugin/monotone.pm
+++ b/IkiWiki/Plugin/monotone.pm
@@ -1,6 +1,5 @@
 #!/usr/bin/perl
 #!/usr/bin/perl

-
-package IkiWiki;
+package IkiWiki::Plugin::monotone;

 
 use warnings;
 use strict;
 
 use warnings;
 use strict;


@@ -11,7 +10,22 @@ use Date::Format qw(time2str);
 
 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate sha1sums
 
 
 my $sha1_pattern = qr/[0-9a-fA-F]{40}/; # pattern to validate sha1sums
 

-hook(type => "checkconfig", id => "monotone", call => sub { #{{{
+sub import {
+       hook(type => "checkconfig", id => "monotone", call => \&checkconfig);
+       hook(type => "getsetup", id => "monotone", 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{mtnrootdir})) {
                $config{mtnrootdir} = $config{srcdir};
        }
        if (!defined($config{mtnrootdir})) {
                $config{mtnrootdir} = $config{srcdir};
        }


@@ -41,20 +55,24 @@ hook(type => "checkconfig", id => "monotone", call => sub { #{{{
                error("Monotone version too old, is $version but required 0.38");
        }
 
                error("Monotone version too old, is $version but required 0.38");
        }
 

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

                push @{$config{wrappers}}, {
                        wrapper => $config{mtn_wrapper},
                        wrappermode => (defined $config{mtn_wrappermode} ? $config{mtn_wrappermode} : "06755"),
                };
        }
                push @{$config{wrappers}}, {
                        wrapper => $config{mtn_wrapper},
                        wrappermode => (defined $config{mtn_wrappermode} ? $config{mtn_wrappermode} : "06755"),
                };
        }

-}); #}}}
+}

 
 

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

        return
        return

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

                mtn_wrapper => {
                        type => "string",
                        example => "/srv/mtn/wiki/_MTN/ikiwiki-netsync-hook",
                mtn_wrapper => {
                        type => "string",
                        example => "/srv/mtn/wiki/_MTN/ikiwiki-netsync-hook",

-                       description => "monotone netsync hook executable to generate",
+                       description => "monotone netsync hook to generate",

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


@@ -99,9 +117,9 @@ hook(type => "getsetup", id => "monotone", call => sub { #{{{
                        safe => 0, # path
                        rebuild => 0,
                },
                        safe => 0, # path
                        rebuild => 0,
                },

-}); #}}}
+}

 
 

-sub get_rev () { #{{{
+sub get_rev () {

        my $sha1 = `mtn --root=$config{mtnrootdir} automate get_base_revision_id`;
 
        ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now
        my $sha1 = `mtn --root=$config{mtnrootdir} automate get_base_revision_id`;
 
        ($sha1) = $sha1 =~ m/($sha1_pattern)/; # sha1 is untainted now


@@ -110,9 +128,9 @@ sub get_rev () { #{{{
        }
 
        return $sha1;
        }
 
        return $sha1;

-} #}}}
+}

 
 

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

        my $automator=shift;
 
        my @results = $automator->call("get_base_revision_id");
        my $automator=shift;
 
        my @results = $automator->call("get_base_revision_id");


@@ -124,9 +142,9 @@ sub get_rev_auto ($) { #{{{
        }
 
        return $sha1;
        }
 
        return $sha1;

-} #}}}
+}

 
 

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

        my $leftRev=shift;
        my $rightRev=shift;
        my $branch=shift;
        my $leftRev=shift;
        my $rightRev=shift;
        my $branch=shift;


@@ -154,9 +172,9 @@ sub mtn_merge ($$$$) { #{{{
        debug("merged $leftRev, $rightRev to make $mergeRev");
 
        return $mergeRev;
        debug("merged $leftRev, $rightRev to make $mergeRev");
 
        return $mergeRev;

-} #}}}
+}

 
 

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

        my $automator=shift;
        my $wsfilename=shift;
        my $oldFileID=shift;
        my $automator=shift;
        my $wsfilename=shift;
        my $oldFileID=shift;


@@ -201,9 +219,9 @@ sub commit_file_to_new_rev($$$$$$$$) { #{{{
        
        debug("Added certs for rev: $newRevID");
        return $newRevID;
        
        debug("Added certs for rev: $newRevID");
        return $newRevID;

-} #}}}
+}

 
 

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

        my $automator=shift;
        my $rev=shift;
        my @results = $automator->call("certs", $rev);
        my $automator=shift;
        my $rev=shift;
        my @results = $automator->call("certs", $rev);


@@ -221,9 +239,9 @@ sub read_certs ($$) { #{{{
        }
 
        return @ret;
        }
 
        return @ret;

-} #}}}
+}

 
 

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

        my $automator=shift;
        my $rev=shift;
        
        my $automator=shift;
        my $rev=shift;
        


@@ -243,9 +261,9 @@ sub get_changed_files ($$) { #{{{
        }
        
        return @ret;
        }
        
        return @ret;

-} #}}}
+}

 
 

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

        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 
        chdir $config{srcdir}
            or error("Cannot chdir to $config{srcdir}: $!");
 


@@ -260,9 +278,9 @@ sub rcs_update () { #{{{
        if (system("mtn", "--root=$config{mtnrootdir}", "update", "--quiet") != 0) {
                debug("monotone update failed");
        }
        if (system("mtn", "--root=$config{mtnrootdir}", "update", "--quiet") != 0) {
                debug("monotone update failed");
        }

-} #}}}
+}

 
 

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

        my $file=shift;
 
        chdir $config{srcdir}
        my $file=shift;
 
        chdir $config{srcdir}


@@ -271,9 +289,9 @@ sub rcs_prepedit ($) { #{{{
        # For monotone, return the revision of the file when
        # editing begins.
        return get_rev();
        # For monotone, return the revision of the file when
        # editing begins.
        return get_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.


@@ -398,7 +416,7 @@ sub rcs_commit ($$$;$$) { #{{{
 
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
                   "--author", $author, "--key", $config{mtnkey}, "-m",
 
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
                   "--author", $author, "--key", $config{mtnkey}, "-m",

-                  possibly_foolish_untaint($message), $file) != 0) {
+                  IkiWiki::possibly_foolish_untaint($message), $file) != 0) {

                debug("Traditional commit failed! Returning data as conflict.");
                my $conflict=readfile("$config{srcdir}/$file");
                if (system("mtn", "--root=$config{mtnrootdir}", "revert",
                debug("Traditional commit failed! Returning data as conflict.");
                my $conflict=readfile("$config{srcdir}/$file");
                if (system("mtn", "--root=$config{mtnrootdir}", "revert",


@@ -416,7 +434,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,


@@ -443,12 +461,12 @@ sub rcs_commit_staged ($$$) {
 
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
                   "--author", $author, "--key", $config{mtnkey}, "-m",
 
        if (system("mtn", "--root=$config{mtnrootdir}", "commit", "--quiet",
                   "--author", $author, "--key", $config{mtnkey}, "-m",

-                  possibly_foolish_untaint($message)) != 0) {
+                  IkiWiki::possibly_foolish_untaint($message)) != 0) {

                error("Monotone commit failed");
        }
 }
 
                error("Monotone commit failed");
        }
 }
 

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

        my $file=shift;
 
        chdir $config{srcdir}
        my $file=shift;
 
        chdir $config{srcdir}


@@ -458,9 +476,9 @@ sub rcs_add ($) { #{{{
                   $file) != 0) {
                error("Monotone add failed");
        }
                   $file) != 0) {
                error("Monotone add failed");
        }

-} #}}}
+}

 
 

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

        my $file = shift;
 
        chdir $config{srcdir}
        my $file = shift;
 
        chdir $config{srcdir}


@@ -477,9 +495,9 @@ sub rcs_remove ($) { # {{{
                   $file) != 0) {
                error("Monotone remove failed");
        }
                   $file) != 0) {
                error("Monotone remove failed");
        }

-} #}}}
+}

 
 

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

        my ($src, $dest) = @_;
 
        chdir $config{srcdir}
        my ($src, $dest) = @_;
 
        chdir $config{srcdir}


@@ -489,9 +507,9 @@ sub rcs_rename ($$) { # {{{
                   $src, $dest) != 0) {
                error("Monotone rename failed");
        }
                   $src, $dest) != 0) {
                error("Monotone rename failed");
        }

-} #}}}
+}

 
 

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

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


@@ -507,13 +525,12 @@ sub rcs_recentchanges ($) { #{{{
        my $child = open(MTNLOG, "-|");
        if (! $child) {
                exec("mtn", "log", "--root=$config{mtnrootdir}", "--no-graph",
        my $child = open(MTNLOG, "-|");
        if (! $child) {
                exec("mtn", "log", "--root=$config{mtnrootdir}", "--no-graph",

-                    "--brief") || error("mtn log failed to run");
+                    "--brief", "--last=$num") || error("mtn log failed to run");

        }
 
        }
 

-       while (($num >= 0) and (my $line = <MTNLOG>)) {
+       while (my $line = <MTNLOG>) {

                if ($line =~ m/^($sha1_pattern)/) {
                        push @revs, $1;
                if ($line =~ m/^($sha1_pattern)/) {
                        push @revs, $1;

-                       $num -= 1;

                }
        }
        close MTNLOG || debug("mtn log exited $?");
                }
        }
        close MTNLOG || debug("mtn log exited $?");


@@ -597,9 +614,9 @@ sub rcs_recentchanges ($) { #{{{
        $automator->close();
 
        return @ret;
        $automator->close();
 
        return @ret;

-} #}}}
+}

 
 

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

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


@@ -621,9 +638,9 @@ sub rcs_diff ($) { #{{{
        else {
                return join("", @lines);
        }
        else {
                return join("", @lines);
        }

-} #}}}
+}

 
 

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

        my $file=shift;
 
        chdir $config{srcdir}
        my $file=shift;
 
        chdir $config{srcdir}


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

-} #}}}
+}

 
 1
 
 1