po: register a (dummy) cansave hook

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

diff --git a/IkiWiki/Plugin/bzr.pm b/IkiWiki/Plugin/bzr.pm
index 5df522f6ee69b4cd6bdec394fbd495957a8424d2..16c959069e915c5ca746b609a1b753dbe1e42446 100644 (file)
--- a/IkiWiki/Plugin/bzr.pm
+++ b/IkiWiki/Plugin/bzr.pm
@@ -1,6 +1,5 @@
 #!/usr/bin/perl
-
-package IkiWiki;
+package IkiWiki::Plugin::bzr;
 
 use warnings;
 use strict;
@@ -8,24 +7,40 @@ use IkiWiki;
 use Encode;
 use open qw{:utf8 :std};
 
-hook(type => "checkconfig", id => "bzr", call => sub { #{{{
-       if (! defined $config{diffurl}) {
-               $config{diffurl}="";
-       }
-       if (length $config{bzr_wrapper}) {
+sub import {
+       hook(type => "checkconfig", id => "bzr", call => \&checkconfig);
+       hook(type => "getsetup", id => "bzr", 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{bzr_wrapper} && length $config{bzr_wrapper}) {
                push @{$config{wrappers}}, {
                        wrapper => $config{bzr_wrapper},
                        wrappermode => (defined $config{bzr_wrappermode} ? $config{bzr_wrappermode} : "06755"),
                };
        }
-}); #}}}
+}
 
-hook(type => "getsetup", id => "bzr", call => sub { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 0, # rcs plugin
+                       rebuild => undef,
+               },
                bzr_wrapper => {
                        type => "string",
                        #example => "", # FIXME add example
-                       description => "bzr post-commit executable to generate",
+                       description => "bzr post-commit hook to generate",
                        safe => 0, # file
                        rebuild => 0,
                },
@@ -50,9 +65,9 @@ hook(type => "getsetup", id => "bzr", call => sub { #{{{
                        safe => 1,
                        rebuild => 1,
                },
-}); #}}}
+}
 
-sub bzr_log ($) { #{{{
+sub bzr_log ($) {
        my $out = shift;
        my @infos = ();
        my $key = undef;
@@ -84,39 +99,39 @@ sub bzr_log ($) { #{{{
        close $out;
 
        return @infos;
-} #}}}
+}
 
-sub rcs_update () { #{{{
+sub rcs_update () {
        my @cmdline = ("bzr", "update", "--quiet", $config{srcdir});
        if (system(@cmdline) != 0) {
                warn "'@cmdline' failed: $!";
        }
-} #}}}
+}
 
-sub rcs_prepedit ($) { #{{{
+sub rcs_prepedit ($) {
        return "";
-} #}}}
+}
 
-sub bzr_author ($$) { #{{{
+sub bzr_author ($$) {
        my ($user, $ipaddr) = @_;
 
        if (defined $user) {
-               return possibly_foolish_untaint($user);
+               return IkiWiki::possibly_foolish_untaint($user);
        }
        elsif (defined $ipaddr) {
-               return "Anonymous from ".possibly_foolish_untaint($ipaddr);
+               return "Anonymous from ".IkiWiki::possibly_foolish_untaint($ipaddr);
        }
        else {
                return "Anonymous";
        }
-} #}}}
+}
 
-sub rcs_commit ($$$;$$) { #{{{
+sub rcs_commit ($$$;$$) {
        my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
 
        $user = bzr_author($user, $ipaddr);
 
-       $message = possibly_foolish_untaint($message);
+       $message = IkiWiki::possibly_foolish_untaint($message);
        if (! length $message) {
                $message = "no message given";
        }
@@ -128,7 +143,7 @@ sub rcs_commit ($$$;$$) { #{{{
        }
 
        return undef; # success
-} #}}}
+}
 
 sub rcs_commit_staged ($$$) {
        # Commits all staged changes. Changes can be staged using rcs_add,
@@ -137,7 +152,7 @@ sub rcs_commit_staged ($$$) {
 
        $user = bzr_author($user, $ipaddr);
 
-       $message = possibly_foolish_untaint($message);
+       $message = IkiWiki::possibly_foolish_untaint($message);
        if (! length $message) {
                $message = "no message given";
        }
@@ -149,30 +164,30 @@ sub rcs_commit_staged ($$$) {
        }
 
        return undef; # success
-} #}}}
+}
 
-sub rcs_add ($) { # {{{
+sub rcs_add ($) {
        my ($file) = @_;
 
        my @cmdline = ("bzr", "add", "--quiet", "$config{srcdir}/$file");
        if (system(@cmdline) != 0) {
                warn "'@cmdline' failed: $!";
        }
-} #}}}
+}
 
-sub rcs_remove ($) { # {{{
+sub rcs_remove ($) {
        my ($file) = @_;
 
        my @cmdline = ("bzr", "rm", "--force", "--quiet", "$config{srcdir}/$file");
        if (system(@cmdline) != 0) {
                warn "'@cmdline' failed: $!";
        }
-} #}}}
+}
 
-sub rcs_rename ($$) { # {{{
+sub rcs_rename ($$) {
        my ($src, $dest) = @_;
 
-       my $parent = dirname($dest);
+       my $parent = IkiWiki::dirname($dest);
        if (system("bzr", "add", "--quiet", "$config{srcdir}/$parent") != 0) {
                warn("bzr add $parent failed\n");
        }
@@ -181,9 +196,9 @@ sub rcs_rename ($$) { # {{{
        if (system(@cmdline) != 0) {
                warn "'@cmdline' failed: $!";
        }
-} #}}}
+}
 
-sub rcs_recentchanges ($) { #{{{
+sub rcs_recentchanges ($) {
        my ($num) = @_;
 
        my @cmdline = ("bzr", "log", "-v", "--show-ids", "--limit", $num, 
@@ -211,7 +226,7 @@ sub rcs_recentchanges ($) { #{{{
                        # Skip source name in renames
                        $filename =~ s/^.* => //;
 
-                       my $diffurl = $config{'diffurl'};
+                       my $diffurl = defined $config{'diffurl'} ? $config{'diffurl'} : "";
                        $diffurl =~ s/\[\[file\]\]/$filename/go;
                        $diffurl =~ s/\[\[file-id\]\]/$fileid/go;
                        $diffurl =~ s/\[\[r2\]\]/$info->{revno}/go;
@@ -231,16 +246,16 @@ sub rcs_recentchanges ($) { #{{{
                        rev        => $info->{"revno"},
                        user       => $user,
                        committype => "bzr",
-                       when       => time - str2time($info->{"timestamp"}),
+                       when       => str2time($info->{"timestamp"}),
                        message    => [@message],
                        pages      => [@pages],
                };
        }
 
        return @ret;
-} #}}}
+}
 
-sub rcs_getctime ($) { #{{{
+sub rcs_getctime ($) {
        my ($file) = @_;
 
        # XXX filename passes through the shell here, should try to avoid
@@ -259,6 +274,6 @@ sub rcs_getctime ($) { #{{{
        
        my $ctime = str2time($log[0]->{"timestamp"});
        return $ctime;
-} #}}}
+}
 
 1