]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/rename.pm
no need to use CORE::rename since I renamed the rename function
[ikiwiki.git] / IkiWiki / Plugin / rename.pm
index 4ee377b86c5b5f500eb6acd1323fa174cf4ba709..8dad92be3e8794c2ef09ed4a518f814fb49be2a5 100644 (file)
@@ -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);
+       hook(type => "rename", id => "rename", call => \&rename_subpages);
+}
 
-} # }}}
-
-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;
@@ -29,7 +29,7 @@ sub check_canrename ($$$$$$) { #{{{
        my $q=shift;
        my $session=shift;
 
-       my $attachment=! defined IkiWiki::pagetype($pagesources{$src});
+       my $attachment=! defined pagetype($pagesources{$src});
 
        # Must be a known source file.
        if (! exists $pagesources{$src}) {
@@ -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->(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;
@@ -98,7 +119,7 @@ sub rename_form ($$$) { #{{{
        error($@) if $@;
        my $f = CGI::FormBuilder->new(
                name => "rename",
-               title => sprintf(gettext("rename %s"), IkiWiki::pagetitle($page)),
+               title => sprintf(gettext("rename %s"), pagetitle($page)),
                header => 0,
                charset => "utf-8",
                method => 'POST',
@@ -111,7 +132,7 @@ sub rename_form ($$$) { #{{{
        
        $f->field(name => "do", type => "hidden", value => "rename", force => 1);
        $f->field(name => "page", type => "hidden", value => $page, force => 1);
-       $f->field(name => "new_name", value => IkiWiki::pagetitle($page), size => 60);
+       $f->field(name => "new_name", value => pagetitle($page, 1), size => 60);
        if (!$q->param("attachment")) {
                # insert the standard extensions
                my @page_types;
@@ -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;
@@ -204,17 +225,18 @@ sub postrename ($;$$$) { #{{{
        }
 
        IkiWiki::cgi_editpage($postrename, $session);
-} #}}}
+}
 
-sub formbuilder (@) { #{{{
+sub formbuilder (@) {
        my %params=@_;
        my $form=$params{form};
 
-       if (defined $form->field("do") && $form->field("do") eq "edit") {
+       if (defined $form->field("do") && ($form->field("do") eq "edit" ||
+           $form->field("do") eq "create")) {
                my $q=$params{cgi};
                my $session=$params{session};
 
-               if ($form->submitted eq "Rename") {
+               if ($form->submitted eq "Rename" && $form->field("do") eq "edit") {
                        rename_start($q, $session, 0, $form->field("page"));
                }
                elsif ($form->submitted eq "Rename Attachment") {
@@ -228,27 +250,28 @@ 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};
 
-       if (defined $form->field("do") && $form->field("do") eq "edit") {
+       if (defined $form->field("do") && ($form->field("do") eq "edit" ||
+           $form->field("do") eq "create")) {
                # Rename button for the page, and also for attachments.
-               push @{$params{buttons}}, "Rename";
+               push @{$params{buttons}}, "Rename" if $form->field("do") eq "edit";
                $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
 
                if (defined $renamesummary) {
                        $form->tmpl_param(message => $renamesummary);
                }
        }
-} #}}}
+}
 
-sub sessioncgi ($$) { #{{{
+sub sessioncgi ($$) {
         my $q=shift;
 
        if ($q->param("do") eq 'rename') {
@@ -267,7 +290,7 @@ sub sessioncgi ($$) { #{{{
                        # performed in check_canrename later.
                        my $src=$q->param("page");
                        my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
-                       my $dest=IkiWiki::possibly_foolish_untaint(IkiWiki::titlepage($q->param("new_name")));
+                       my $dest=IkiWiki::possibly_foolish_untaint(titlepage($q->param("new_name")));
                        my $destfile=$dest;
                        if (! $q->param("attachment")) {
                                my $type=$q->param('type');
@@ -279,7 +302,7 @@ sub sessioncgi ($$) { #{{{
                                        $type=$ext;
                                }
                                
-                               $destfile.=".".$type;
+                               $destfile=newpagefile($dest, $type);
                        }
                        push @torename, {
                                src => $src,
@@ -289,23 +312,13 @@ sub sessioncgi ($$) { #{{{
                                required => 1,
                        };
 
-                       # See if any subpages need to be renamed.
-                       if ($q->param("subpages") && $src ne $dest) {
-                               foreach my $p (keys %pagesources) {
-                                       if ($pagesources{$p}=~m/^\Q$src\E\//) {
-                                               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;
@@ -384,22 +397,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;
                        }
@@ -412,9 +411,59 @@ sub sessioncgi ($$) { #{{{
 
                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 renamepage_hook ($$$$) { #{{{
+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 ($$$$) {
        my ($page, $src, $dest, $content)=@_;
 
        IkiWiki::run_hooks(renamepage => sub {
@@ -427,9 +476,45 @@ sub renamepage_hook ($$$$) { #{{{
        });
 
        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;
@@ -454,9 +539,9 @@ sub do_rename ($$$) { #{{{
                }
        }
 
-} # }}}
+}
 
-sub fixlinks ($$$) { #{{{
+sub fixlinks ($$$) {
        my $rename=shift;
        my $session=shift;
 
@@ -492,6 +577,6 @@ sub fixlinks ($$$) { #{{{
        }
 
        return @fixedlinks;
-} #}}}
+}
 
 1