link changes

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

diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index e4201cc941ec81fe736fbe4ef54a610a66ec7031..8dad92be3e8794c2ef09ed4a518f814fb49be2a5 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 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);
        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);

+       hook(type => "rename", id => "rename", call => \&rename_subpages);
+}

 
 

-} # }}}
-
-sub getsetup () { #{{{
+sub getsetup () {

        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,
                },
        return 
                plugin => {
                        safe => 1,
                        rebuild => 0,
                },

-} #}}}
+}

 
 

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

        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;
        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;


@@ -87,9 +87,30 @@ sub check_canrename ($$$$$$) { #{{{
                        IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
                }
        }
                        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->(cgi => $q, session => $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;
+                       }
+               }
+       });
+}
+
+sub rename_form ($$$) {

        my $q=shift;
        my $session=shift;
        my $page=shift;
        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"];
        $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;
        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;
        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;
        my $session=shift;
        my $src=shift;
        my $dest=shift;


@@ -204,9 +225,9 @@ sub postrename ($;$$$) { #{{{
        }
 
        IkiWiki::cgi_editpage($postrename, $session);
        }
 
        IkiWiki::cgi_editpage($postrename, $session);

-} #}}}
+}

 
 

-sub formbuilder (@) { #{{{
+sub formbuilder (@) {

        my %params=@_;
        my $form=$params{form};
 
        my %params=@_;
        my $form=$params{form};
 


@@ -229,11 +250,11 @@ sub formbuilder (@) { #{{{
                        rename_start($q, $session, 1, $selected[0]);
                }
        }
                        rename_start($q, $session, 1, $selected[0]);
                }
        }

-} #}}}
+}

 
 my $renamesummary;
 
 
 my $renamesummary;
 

-sub formbuilder_setup (@) { #{{{
+sub formbuilder_setup (@) {

        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};
        my %params=@_;
        my $form=$params{form};
        my $q=$params{cgi};


@@ -248,9 +269,9 @@ sub formbuilder_setup (@) { #{{{
                        $form->tmpl_param(message => $renamesummary);
                }
        }
                        $form->tmpl_param(message => $renamesummary);
                }
        }

-} #}}}
+}

 
 

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

         my $q=shift;
 
        if ($q->param("do") eq 'rename') {
         my $q=shift;
 
        if ($q->param("do") eq 'rename') {


@@ -291,27 +312,13 @@ sub sessioncgi ($$) { #{{{
                                required => 1,
                        };
 
                                required => 1,
                        };
 

-                       # See if any subpages need to be renamed.
-                       if ($q->param("subpages") && $src ne $dest) {
-                               foreach my $p (keys %pagesources) {
-                                       next unless $pagesources{$p}=~m/^\Q$src\E\//;
-                                       # If indexpages is enabled, the
-                                       # srcfile should not be confused
-                                       # with a subpage.
-                                       next if $pagesources{$p} eq $srcfile;
-
-                                       my $d=$pagesources{$p};
-                                       $d=~s/^\Q$src\E\//$dest\//;
-                                       push @torename, {
-                                               src => $p,
-                                               srcfile => $pagesources{$p},
-                                               dest => pagename($d),
-                                               destfile => $d,
-                                               required => 0,
-                                       };
-                               }
-                       }
-                       
+                       @torename=rename_hook(
+                               torename => \@torename,
+                               done => {},
+                               cgi => $q,
+                               session => $session,
+                       );
+

                        require IkiWiki::Render;
                        IkiWiki::disable_commit_hook() if $config{rcs};
                        my %origpagesources=%pagesources;
                        require IkiWiki::Render;
                        IkiWiki::disable_commit_hook() if $config{rcs};
                        my %origpagesources=%pagesources;


@@ -390,22 +397,8 @@ sub sessioncgi ($$) { #{{{
                                $template->param(error => $rename->{error});
                                if ($rename->{src} ne $rename->{dest}) {
                                        $template->param(brokenlinks_checked => 1);
                                $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;
                        }
                                }
                                $renamesummary.=$template->output;
                        }


@@ -418,9 +411,59 @@ sub sessioncgi ($$) { #{{{
 
                exit 0;
        }
 
                exit 0;
        }

-} #}}}
+}
+
+# Add subpages to the list of pages to be renamed, if needed.
+sub rename_subpages (@) {
+       my %params = @_;
+
+       my %torename = %{$params{torename}};
+       my $q = $params{cgi};
+       my $src = $torename{src};
+       my $srcfile = $torename{src};
+       my $dest = $torename{dest};
+       my $destfile = $torename{dest};
+
+       return () unless ($q->param("subpages") && $src ne $dest);
+
+       my @ret;
+       foreach my $p (keys %pagesources) {
+               next unless $pagesources{$p}=~m/^\Q$src\E\//;
+               # If indexpages is enabled, the srcfile should not be confused
+               # with a subpage.
+               next if $pagesources{$p} eq $srcfile;
+
+               my $d=$pagesources{$p};
+               $d=~s/^\Q$src\E\//$dest\//;
+               push @ret, {
+                       src => $p,
+                       srcfile => $pagesources{$p},
+                       dest => pagename($d),
+                       destfile => $d,
+                       required => 0,
+               };
+       }
+       return @ret;
+}
+
+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 renamepage_hook ($$$$) {

        my ($page, $src, $dest, $content)=@_;
 
        IkiWiki::run_hooks(renamepage => sub {
        my ($page, $src, $dest, $content)=@_;
 
        IkiWiki::run_hooks(renamepage => sub {


@@ -433,9 +476,45 @@ sub renamepage_hook ($$$$) { #{{{
        });
 
        return $content;
        });
 
        return $content;

-}# }}}
-                       
-sub do_rename ($$$) { #{{{
+}
+
+sub rename_hook (@) {
+       my %params = @_;
+
+       my @torename=@{$params{torename}};
+       my %done=%{$params{done}};
+       my $q=$params{cgi};
+       my $session=$params{session};
+
+       return () unless @torename;
+
+       my @nextset;
+       foreach my $torename (@torename) {
+               unless (exists $done{$torename->{src}} && $done{$torename->{src}}) {
+                       IkiWiki::run_hooks(rename => sub {
+                               push @nextset, shift->(
+                                       torename => $torename,
+                                       cgi => $q,
+                                       session => $session,
+                               );
+                       });
+                       $done{$torename->{src}}=1;
+               }
+       }
+
+       push @torename, rename_hook(
+               torename => \@nextset,
+               done => \%done,
+               cgi => $q,
+               session => $session,
+       );
+
+       # dedup
+       my %seen;
+       return grep { ! $seen{$_->{src}}++ } @torename;
+}
+
+sub do_rename ($$$) {

        my $rename=shift;
        my $q=shift;
        my $session=shift;
        my $rename=shift;
        my $q=shift;
        my $session=shift;


@@ -460,9 +539,9 @@ sub do_rename ($$$) { #{{{
                }
        }
 
                }
        }
 

-} # }}}
+}

 
 

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

        my $rename=shift;
        my $session=shift;
 
        my $rename=shift;
        my $session=shift;
 


@@ -498,6 +577,6 @@ sub fixlinks ($$$) { #{{{
        }
 
        return @fixedlinks;
        }
 
        return @fixedlinks;

-} #}}}
+}

 
 1
 
 1