Merge commit 'upstream/master'

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

diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index 3936a4a60c0471e24d5a994b6a4a43e10abd6e6a..7e55e271cbe6a403115fb38eff1f5655fbc626d6 100644 (file)
--- a/IkiWiki/Plugin/rename.pm
+++ b/IkiWiki/Plugin/rename.pm
@@ -21,14 +21,15 @@ sub getsetup () { #{{{
                },
 } #}}}
 
                },
 } #}}}
 

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

        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;
        my $destfile=shift;
        my $q=shift;
        my $session=shift;
        my $src=shift;
        my $srcfile=shift;
        my $dest=shift;
        my $destfile=shift;
        my $q=shift;
        my $session=shift;

-       my $attachment=shift;
+
+       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}) {


@@ -47,7 +48,12 @@ sub check_canrename ($$$$$$$) { #{{{
        # Must be editable.
        IkiWiki::check_canedit($src, $q, $session);
        if ($attachment) {
        # Must be editable.
        IkiWiki::check_canedit($src, $q, $session);
        if ($attachment) {

-               IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
+               if (IkiWiki::Plugin::attachment->can("check_canattach")) {
+                       IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
+               }
+               else {
+                       error("renaming of attachments is not allowed");
+               }

        }
        
        # Dest checks can be omitted by passing undef.
        }
        
        # Dest checks can be omitted by passing undef.


@@ -92,7 +98,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',


@@ -105,7 +111,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), size => 60);

        if (!$q->param("attachment")) {
                # insert the standard extensions
                my @page_types;
        if (!$q->param("attachment")) {
                # insert the standard extensions
                my @page_types;


@@ -124,12 +130,17 @@ sub rename_form ($$$) { #{{{
                        options => \@page_types,
                        value => $ext, force => 1);
                
                        options => \@page_types,
                        value => $ext, force => 1);
                

-               $f->field(name => "subpages",
-                       label => "",
-                       type => "checkbox",
-                       options => [ [ 1 => gettext("Also rename SubPages and attachments") ] ],
-                       value => 1,
-                       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");
 
        }
        $f->field(name => "attachment", type => "hidden");
 


@@ -143,7 +154,7 @@ sub rename_start ($$$$) { #{{{
        my $page=shift;
 
        check_canrename($page, $pagesources{$page}, undef, undef,
        my $page=shift;
 
        check_canrename($page, $pagesources{$page}, undef, undef,

-               $q, $session, $attachment);
+               $q, $session);

 
        # Save current form state to allow returning to it later
        # without losing any edits.
 
        # Save current form state to allow returning to it later
        # without losing any edits.


@@ -154,11 +165,10 @@ 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;
 } #}}}


@@ -200,11 +210,12 @@ 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") {


@@ -227,9 +238,10 @@ sub formbuilder_setup (@) { #{{{
        my $form=$params{form};
        my $q=$params{cgi};
 
        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("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
 
                if (defined $renamesummary) {


@@ -250,12 +262,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');


@@ -267,44 +281,82 @@ sub sessioncgi ($$) { #{{{
                                        $type=$ext;
                                }
                                
                                        $type=$ext;
                                }
                                

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

                        }
                        }

-
-                       check_canrename($src, $srcfile, $dest, $destfile,
-                               $q, $session, $q->param("attachment"));
-
-                       # See if subpages need to be renamed.
-                       my @subpages;
+                       push @torename, {
+                               src => $src,
+                               srcfile => $srcfile,
+                               dest => $dest,
+                               destfile => $destfile,
+                               required => 1,
+                       };
+
+                       # See if any subpages need to be renamed.

                        if ($q->param("subpages") && $src ne $dest) {
                        if ($q->param("subpages") && $src ne $dest) {

-                               foreach my $p (keys %pagesources) {
-                                       if ($pagesources{$p}=~m/^\Q$src\E\/$/) {
-                                               push @subpages, $p;
-                                       }
+                               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,
+                                       };

                                }
                        }
                                }
                        }

-
-                       # Begin renaming process, which will end with a
-                       # wiki refresh.
+                       

                        require IkiWiki::Render;
                        IkiWiki::disable_commit_hook() if $config{rcs};
                        require IkiWiki::Render;
                        IkiWiki::disable_commit_hook() if $config{rcs};

+                       my %origpagesources=%pagesources;

 
 

-                       do_rename($srcfile, $destfile, $session);
+                       # 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;
+                                       }
+                               }

 
 

-                       foreach my $subpage (@subpages) {
-                               my $subsrc=$pagesources{$subpage};
-                               my $subdest=$subsrc;
-                               $subdest=~s/^\Q$src\E\//$dest/;
-                               eval {
-                                       do_rename($subsrc, $subdest, $session)
-                               };
+                               # 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) {
-                               push @fixedlinks, fixlinks($src, $dest, $session);
+                       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;
+                                               }
+                                       }
+                                       push @{$rename->{fixedlinks}}, $p;
+                               }

                        }
 
                        }
 

-                       # End renaming process and refresh wiki.
+                       # Then refresh.
+                       %pagesources=%origpagesources;

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


@@ -312,47 +364,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"));
                }


@@ -380,29 +436,34 @@ sub renamepage_hook ($$$$) { #{{{
 }# }}}
                        
 sub do_rename ($$$) { #{{{
 }# }}}
                        
 sub do_rename ($$$) { #{{{

-       my $srcfile=shift;
-       my $destfile=shift;
+       my $rename=shift;
+       my $q=shift;

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

-                       
-       # Actual file rename happens here.
-       # First, ensure that the dest directory exists and is ok.
-       IkiWiki::prep_writefile($destfile, $config{srcdir});
+
+       # 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}) {
        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});
+               IkiWiki::rcs_rename($rename->{srcfile}, $rename->{destfile});

        }
        else {
        }
        else {

-               if (! rename("$config{srcdir}/$srcfile", "$config{srcdir}/$destfile")) {
+               if (! rename($config{srcdir}."/".$rename->{srcfile},
+                            $config{srcdir}."/".$rename->{destfile})) {

                        error("rename: $!");
                }
        }
                        error("rename: $!");
                }
        }

+

 } # }}}
 
 sub fixlinks ($$$) { #{{{
 } # }}}
 
 sub fixlinks ($$$) { #{{{

-       my $src=shift;
-       my $dest=shift;
+       my $rename=shift;

        my $session=shift;
 
        my @fixedlinks;
        my $session=shift;
 
        my @fixedlinks;


@@ -411,7 +472,7 @@ sub fixlinks ($$$) { #{{{
                my $needfix=0;
                foreach my $link (@{$links{$page}}) {
                        my $bestlink=bestlink($page, $link);
                my $needfix=0;
                foreach my $link (@{$links{$page}}) {
                        my $bestlink=bestlink($page, $link);

-                       if ($bestlink eq $src) {
+                       if ($bestlink eq $rename->{src}) {

                                $needfix=1;
                                last;
                        }
                                $needfix=1;
                                last;
                        }


@@ -419,14 +480,14 @@ sub fixlinks ($$$) { #{{{
                if ($needfix) {
                        my $file=$pagesources{$page};
                        my $oldcontent=readfile($config{srcdir}."/".$file);
                if ($needfix) {
                        my $file=$pagesources{$page};
                        my $oldcontent=readfile($config{srcdir}."/".$file);

-                       my $content=renamepage_hook($page, $src, $dest, $oldcontent);
+                       my $content=renamepage_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,
                        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"), $src, $dest),
+                                       sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),

                                        $token,
                                        $session->param("name"), 
                                        $ENV{REMOTE_ADDR}
                                        $token,
                                        $session->param("name"), 
                                        $ENV{REMOTE_ADDR}