po: first attempt to replace cansave hook with form validate tweaks

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

diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index f441ac025f12e5b1c06282295c821366674cdfc0..82639a073349f8f2ef1d5943df11b653a2f88a9a 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);
 

-} # }}}
+}

 
 

-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;


@@ -29,7 +29,7 @@ sub check_canrename ($$$$$$) { #{{{
        my $q=shift;
        my $session=shift;
 
        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}) {
 
        # 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);
                }
        }
                        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;
        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",
        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',
                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 => "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;
        if (!$q->param("attachment")) {
                # insert the standard extensions
                my @page_types;


@@ -129,13 +150,25 @@ sub rename_form ($$$) { #{{{
                $f->field(name => "type", type => 'select',
                        options => \@page_types,
                        value => $ext, force => 1);
                $f->field(name => "type", type => 'select',
                        options => \@page_types,
                        value => $ext, force => 1);

+               
+               foreach my $p (keys %pagesources) {
+                       if ($pagesources{$p}=~m/^\Q$page\E\//) {
+                               $f->field(name => "subpages",
+                                       label => "",
+                                       type => "checkbox",
+                                       options => [ [ 1 => gettext("Also rename SubPages and attachments") ] ],
+                                       value => 1,
+                                       force => 1);
+                               last;
+                       }
+               }

        }
        $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;


@@ -153,16 +186,15 @@ sub rename_start ($$$$) { #{{{
        $session->param(postrename => scalar $q->Vars);
        IkiWiki::cgi_savesession($session);
        
        $session->param(postrename => scalar $q->Vars);
        IkiWiki::cgi_savesession($session);
        

-       my ($f, $buttons)=rename_form($q, $session, $page);

        if (defined $attachment) {
        if (defined $attachment) {

-               $f->field(name => "attachment", value => $attachment, force => 1);
+               $q->param(-name => "attachment", -value => $attachment);

        }
        }

-       
+       my ($f, $buttons)=rename_form($q, $session, $page);

        IkiWiki::showform($f, $buttons, $session, $q);
        exit 0;
        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;


@@ -184,7 +216,7 @@ sub postrename ($;$$$) { #{{{
                # Update edit form content to fix any links present
                # on it.
                $postrename->param("editcontent",
                # 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.
                                 $postrename->param("editcontent")));
 
                # Get a new edit token; old was likely invalidated.


@@ -193,17 +225,18 @@ 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};
 

-       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};
 
                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") {
                        rename_start($q, $session, 0, $form->field("page"));
                }
                elsif ($form->submitted eq "Rename Attachment") {


@@ -217,27 +250,28 @@ 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};
 

-       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.
                # 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);
                }
        }
                $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') {
         my $q=shift;
 
        if ($q->param("do") eq 'rename') {


@@ -249,12 +283,14 @@ sub sessioncgi ($$) { #{{{
                        postrename($session);
                }
                elsif ($form->submitted eq 'Rename' && $form->validate) {
                        postrename($session);
                }
                elsif ($form->submitted eq 'Rename' && $form->validate) {

+                       # Queue of rename actions to perfom.
+                       my @torename;
+

                        # These untaints are safe because of the checks
                        # These untaints are safe because of the checks

-                       # performed in check_canrename below.
+                       # performed in check_canrename later.

                        my $src=$q->param("page");
                        my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
                        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');
                        my $destfile=$dest;
                        if (! $q->param("attachment")) {
                                my $type=$q->param('type');


@@ -266,60 +302,84 @@ sub sessioncgi ($$) { #{{{
                                        $type=$ext;
                                }
                                
                                        $type=$ext;
                                }
                                

-                               $destfile.=".".$type;
+                               $destfile=newpagefile($dest, $type);

                        }
                        }

-
-                       check_canrename($src, $srcfile, $dest, $destfile,
-                               $q, $session);
-
-                       # Ensures that the dest directory exists and is ok.
-                       IkiWiki::prep_writefile($destfile, $config{srcdir});
-
-                       # Do rename, update other pages, and refresh site.
-                       IkiWiki::disable_commit_hook() if $config{rcs};
-                       require IkiWiki::Render;
-                       if ($config{rcs}) {
-                               IkiWiki::rcs_rename($srcfile, $destfile);
-                               IkiWiki::rcs_commit_staged(
-                                       sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
-                                       $session->param("name"), $ENV{REMOTE_ADDR});
+                       push @torename, {
+                               src => $src,
+                               srcfile => $srcfile,
+                               dest => $dest,
+                               destfile => $destfile,
+                               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) {
+                                       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,
+                                       };
+                               }

                        }
                        }

-                       else {
-                               if (! rename("$config{srcdir}/$srcfile", "$config{srcdir}/$destfile")) {
-                                       error("rename: $!");
+                       
+                       require IkiWiki::Render;
+                       IkiWiki::disable_commit_hook() if $config{rcs};
+                       my %origpagesources=%pagesources;
+
+                       # First file renaming.
+                       foreach my $rename (@torename) {
+                               if ($rename->{required}) {
+                                       do_rename($rename, $q, $session);
+                               }
+                               else {
+                                       eval {do_rename($rename, $q, $session)};
+                                       if ($@) {
+                                               $rename->{error}=$@;
+                                               next;
+                                       }

                                }
                                }

+
+                               # Temporarily tweak pagesources to point to
+                               # the renamed file, in case fixlinks needs
+                               # to edit it.
+                               $pagesources{$rename->{src}}=$rename->{destfile};

                        }
                        }

-                       my @fixedlinks;
-                       if ($src ne $dest) {
-                               foreach my $page (keys %links) {
-                                       my $needfix=0;
-                                       foreach my $link (@{$links{$page}}) {
-                                               my $bestlink=bestlink($page, $link);
-                                               if ($bestlink eq $src) {
-                                                       $needfix=1;
+                       IkiWiki::rcs_commit_staged(
+                               sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
+                               $session->param("name"), $ENV{REMOTE_ADDR}) if $config{rcs};
+
+                       # Then link fixups.
+                       foreach my $rename (@torename) {
+                               next if $rename->{src} eq $rename->{dest};
+                               next if $rename->{error};
+                               foreach my $p (fixlinks($rename, $session)) {
+                                       # map old page names to new
+                                       foreach my $r (@torename) {
+                                               next if $rename->{error};
+                                               if ($r->{src} eq $p) {
+                                                       $p=$r->{dest};

                                                        last;
                                                }
                                        }
                                                        last;
                                                }
                                        }

-                                       if ($needfix) {
-                                               my $file=$pagesources{$page};
-                                               my $oldcontent=readfile($config{srcdir}."/".$file);
-                                               my $content=renamepage_hook($page, $src, $dest, $oldcontent);
-                                               if ($oldcontent ne $content) {
-                                                       my $token=IkiWiki::rcs_prepedit($file);
-                                                       eval { writefile($file, $config{srcdir}, $content) };
-                                                       next if $@;
-                                                       my $conflict=IkiWiki::rcs_commit(
-                                                               $file,
-                                                               sprintf(gettext("update for rename of %s to %s"), $srcfile, $destfile),
-                                                               $token,
-                                                               $session->param("name"), 
-                                                               $ENV{REMOTE_ADDR}
-                                                       );
-                                                       push @fixedlinks, $page if ! defined $conflict;
-                                               }
-                                       }
+                                       push @{$rename->{fixedlinks}}, $p;

                                }
                        }
                                }
                        }

+
+                       # Then refresh.
+                       %pagesources=%origpagesources;

                        if ($config{rcs}) {
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        if ($config{rcs}) {
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();


@@ -327,47 +387,51 @@ sub sessioncgi ($$) { #{{{
                        IkiWiki::refresh();
                        IkiWiki::saveindex();
 
                        IkiWiki::refresh();
                        IkiWiki::saveindex();
 

-                       # Scan for any remaining broken links to $src.
-                       my @brokenlinks;
-                       if ($src ne $dest) {
+                       # Find pages with remaining, broken links.
+                       foreach my $rename (@torename) {
+                               next if $rename->{src} eq $rename->{dest};
+                               

                                foreach my $page (keys %links) {
                                        my $broken=0;
                                        foreach my $link (@{$links{$page}}) {
                                                my $bestlink=bestlink($page, $link);
                                foreach my $page (keys %links) {
                                        my $broken=0;
                                        foreach my $link (@{$links{$page}}) {
                                                my $bestlink=bestlink($page, $link);

-                                               if ($bestlink eq $src) {
-                                                       $broken=1;
+                                               if ($bestlink eq $rename->{src}) {
+                                                       push @{$rename->{brokenlinks}}, $page;

                                                        last;
                                                }
                                        }
                                                        last;
                                                }
                                        }

-                                       push @brokenlinks, $page if $broken;

                                }
                        }
 
                                }
                        }
 

-                       # Generate a rename summary, that will be shown at the top
+                       # Generate a summary, that will be shown at the top

                        # of the edit template.
                        # of the edit template.

-                       my $template=template("renamesummary.tmpl");
-                       $template->param(src => $srcfile);
-                       $template->param(dest => $destfile);
-                       if ($src ne $dest) {
-                               $template->param(brokenlinks_checked => 1);
-                               $template->param(brokenlinks => [
-                                       map {
-                                               {
-                                                       page => htmllink($dest, $dest, $_,
-                                                                       noimageinline => 1)
-                                               }
-                                       } @brokenlinks
-                               ]);
-                               $template->param(fixedlinks => [
-                                       map {
-                                               {
-                                                       page => htmllink($dest, $dest, $_,
-                                                                       noimageinline => 1)
-                                               }
-                                       } @fixedlinks
-                               ]);
+                       $renamesummary="";
+                       foreach my $rename (@torename) {
+                               my $template=template("renamesummary.tmpl");
+                               $template->param(src => $rename->{srcfile});
+                               $template->param(dest => $rename->{destfile});
+                               $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}}
+                                       ]);
+                               }
+                               $renamesummary.=$template->output;

                        }
                        }

-                       $renamesummary=$template->output;

 
                        postrename($session, $src, $dest, $q->param("attachment"));
                }
 
                        postrename($session, $src, $dest, $q->param("attachment"));
                }


@@ -377,12 +441,12 @@ sub sessioncgi ($$) { #{{{
 
                exit 0;
        }
 
                exit 0;
        }

-} #}}}
+}

 
 

-sub renamepage_hook ($$$$) { #{{{
+sub renamelink_hook ($$$$) {

        my ($page, $src, $dest, $content)=@_;
 
        my ($page, $src, $dest, $content)=@_;
 

-       IkiWiki::run_hooks(renamepage => sub {
+       IkiWiki::run_hooks(renamelink => sub {

                $content=shift->(
                        page => $page,
                        oldpage => $src,
                $content=shift->(
                        page => $page,
                        oldpage => $src,


@@ -392,6 +456,71 @@ sub renamepage_hook ($$$$) { #{{{
        });
 
        return $content;
        });
 
        return $content;

-}# }}}
+}
+                       
+sub do_rename ($$$) {
+       my $rename=shift;
+       my $q=shift;
+       my $session=shift;
+
+       # First, check if this rename is allowed.
+       check_canrename($rename->{src},
+               $rename->{srcfile},
+               $rename->{dest},
+               $rename->{destfile},
+               $q, $session);
+
+       # Ensure that the dest directory exists and is ok.
+       IkiWiki::prep_writefile($rename->{destfile}, $config{srcdir});
+
+       if ($config{rcs}) {
+               IkiWiki::rcs_rename($rename->{srcfile}, $rename->{destfile});
+       }
+       else {
+               if (! rename($config{srcdir}."/".$rename->{srcfile},
+                            $config{srcdir}."/".$rename->{destfile})) {
+                       error("rename: $!");
+               }
+       }
+
+}
+
+sub fixlinks ($$$) {
+       my $rename=shift;
+       my $session=shift;
+
+       my @fixedlinks;
+
+       foreach my $page (keys %links) {
+               my $needfix=0;
+               foreach my $link (@{$links{$page}}) {
+                       my $bestlink=bestlink($page, $link);
+                       if ($bestlink eq $rename->{src}) {
+                               $needfix=1;
+                               last;
+                       }
+               }
+               if ($needfix) {
+                       my $file=$pagesources{$page};
+                       my $oldcontent=readfile($config{srcdir}."/".$file);
+                       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) };
+                               next if $@;
+                               my $conflict=IkiWiki::rcs_commit(
+                                       $file,
+                                       sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),
+                                       $token,
+                                       $session->param("name"), 
+                                       $ENV{REMOTE_ADDR}
+                               );
+                               push @fixedlinks, $page if ! defined $conflict;
+                       }
+               }
+       }
+
+       return @fixedlinks;
+}

 
 1
 
 1