make checkcontent compatible with hooks that need the full content

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

diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index e4201cc941ec81fe736fbe4ef54a610a66ec7031..f793495612c2d360dd2df480c33913f0ad801b7b 100644 (file)
--- a/IkiWiki/Plugin/rename.pm
+++ b/IkiWiki/Plugin/rename.pm
@@ -3,25 +3,25 @@ package IkiWiki::Plugin::rename;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
        hook(type => "getsetup", id => "rename", call => \&getsetup);
        hook(type => "formbuilder_setup", id => "rename", call => \&formbuilder_setup);
        hook(type => "formbuilder", id => "rename", call => \&formbuilder);
        hook(type => "sessioncgi", id => "rename", call => \&sessioncgi);
 
-} # }}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,
                },
-} #}}}
+}
 
-sub check_canrename ($$$$$$) { #{{{
+sub check_canrename ($$$$$$) {
        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;
@@ -87,9 +87,30 @@ sub check_canrename ($$$$$$) { #{{{
                        IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
                }
        }
-} #}}}
 
-sub rename_form ($$$) { #{{{ 
+       my $canrename;
+       IkiWiki::run_hooks(canrename => sub {
+               return if defined $canrename;
+               my $ret=shift->($q, $session, src => $src, srcfile => $srcfile,
+                               dest => $dest, destfile => $destfile);
+               if (defined $ret) {
+                       if ($ret eq "") {
+                               $canrename=1;
+                       }
+                       elsif (ref $ret eq 'CODE') {
+                               $ret->();
+                               $canrename=0;
+                       }
+                       elsif (defined $ret) {
+                               error($ret);
+                               $canrename=0;
+                       }
+               }
+       });
+       return $canrename;
+}
+
+sub rename_form ($$$) {
        my $q=shift;
        my $session=shift;
        my $page=shift;
@@ -145,9 +166,9 @@ sub rename_form ($$$) { #{{{
        $f->field(name => "attachment", type => "hidden");
 
        return $f, ["Rename", "Cancel"];
-} #}}}
+}
 
-sub rename_start ($$$$) { #{{{
+sub rename_start ($$$$) {
        my $q=shift;
        my $session=shift;
        my $attachment=shift;
@@ -171,9 +192,9 @@ sub rename_start ($$$$) { #{{{
        my ($f, $buttons)=rename_form($q, $session, $page);
        IkiWiki::showform($f, $buttons, $session, $q);
        exit 0;
-} #}}}
+}
 
-sub postrename ($;$$$) { #{{{
+sub postrename ($;$$$) {
        my $session=shift;
        my $src=shift;
        my $dest=shift;
@@ -195,7 +216,7 @@ sub postrename ($;$$$) { #{{{
                # Update edit form content to fix any links present
                # on it.
                $postrename->param("editcontent",
-                       renamepage_hook($dest, $src, $dest,
+                       renamelink_hook($dest, $src, $dest,
                                 $postrename->param("editcontent")));
 
                # Get a new edit token; old was likely invalidated.
@@ -204,9 +225,9 @@ sub postrename ($;$$$) { #{{{
        }
 
        IkiWiki::cgi_editpage($postrename, $session);
-} #}}}
+}
 
-sub formbuilder (@) { #{{{
+sub formbuilder (@) {
        my %params=@_;
        my $form=$params{form};
 
@@ -229,11 +250,11 @@ sub formbuilder (@) { #{{{
                        rename_start($q, $session, 1, $selected[0]);
                }
        }
-} #}}}
+}
 
 my $renamesummary;
 
-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
@@ -248,9 +269,9 @@ sub formbuilder_setup (@) { #{{{
                        $form->tmpl_param(message => $renamesummary);
                }
        }
-} #}}}
+}
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
         my $q=shift;
 
        if ($q->param("do") eq 'rename') {
@@ -291,6 +312,8 @@ sub sessioncgi ($$) { #{{{
                                required => 1,
                        };
 
+                       IkiWiki::run_hooks(rename => sub { shift->(\@torename, $q, $session); });
+
                        # See if any subpages need to be renamed.
                        if ($q->param("subpages") && $src ne $dest) {
                                foreach my $p (keys %pagesources) {
@@ -390,22 +413,8 @@ sub sessioncgi ($$) { #{{{
                                $template->param(error => $rename->{error});
                                if ($rename->{src} ne $rename->{dest}) {
                                        $template->param(brokenlinks_checked => 1);
-                                       $template->param(brokenlinks => [
-                                               map {
-                                                       {
-                                                               page => htmllink($rename->{dest}, $rename->{dest}, $_,
-                                                                               noimageinline => 1)
-                                                       }
-                                               } @{$rename->{brokenlinks}}
-                                       ]);
-                                       $template->param(fixedlinks => [
-                                               map {
-                                                       {
-                                                               page => htmllink($rename->{dest}, $rename->{dest}, $_,
-                                                                               noimageinline => 1)
-                                                       }
-                                               } @{$rename->{fixedlinks}}
-                                       ]);
+                                       $template->param(brokenlinks => linklist($rename->{dest}, $rename->{brokenlinks}));
+                                       $template->param(fixedlinks => linklist($rename->{dest}, $rename->{fixedlinks}));
                                }
                                $renamesummary.=$template->output;
                        }
@@ -418,12 +427,29 @@ sub sessioncgi ($$) { #{{{
 
                exit 0;
        }
-} #}}}
+}
+                                               
+sub linklist {
+       # generates a list of links in a form suitable for FormBuilder
+       my $dest=shift;
+       my $list=shift;
+       # converts a list of pages into a list of links
+       # in a form suitable for FormBuilder.
+
+       [map {
+               {
+                       page => htmllink($dest, $dest, $_,
+                                       noimageinline => 1,
+                                       linktext => pagetitle($_),
+                               )
+               }
+       } @{$list}]
+}
 
-sub renamepage_hook ($$$$) { #{{{
+sub renamelink_hook ($$$$) {
        my ($page, $src, $dest, $content)=@_;
 
-       IkiWiki::run_hooks(renamepage => sub {
+       IkiWiki::run_hooks(renamelink => sub {
                $content=shift->(
                        page => $page,
                        oldpage => $src,
@@ -433,9 +459,9 @@ sub renamepage_hook ($$$$) { #{{{
        });
 
        return $content;
-}# }}}
+}
                        
-sub do_rename ($$$) { #{{{
+sub do_rename ($$$) {
        my $rename=shift;
        my $q=shift;
        my $session=shift;
@@ -460,9 +486,9 @@ sub do_rename ($$$) { #{{{
                }
        }
 
-} # }}}
+}
 
-sub fixlinks ($$$) { #{{{
+sub fixlinks ($$$) {
        my $rename=shift;
        my $session=shift;
 
@@ -480,7 +506,7 @@ sub fixlinks ($$$) { #{{{
                if ($needfix) {
                        my $file=$pagesources{$page};
                        my $oldcontent=readfile($config{srcdir}."/".$file);
-                       my $content=renamepage_hook($page, $rename->{src}, $rename->{dest}, $oldcontent);
+                       my $content=renamelink_hook($page, $rename->{src}, $rename->{dest}, $oldcontent);
                        if ($oldcontent ne $content) {
                                my $token=IkiWiki::rcs_prepedit($file);
                                eval { writefile($file, $config{srcdir}, $content) };
@@ -498,6 +524,6 @@ sub fixlinks ($$$) { #{{{
        }
 
        return @fixedlinks;
-} #}}}
+}
 
 1