]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/rename.pm
add a rename summary
[ikiwiki.git] / IkiWiki / Plugin / rename.pm
index d3fc7681d5b8ba51e574f5b40470e6fb404c7714..fdd9dc71c83dba820e4f5249918f3391f189ddd7 100644 (file)
@@ -12,15 +12,65 @@ sub import { #{{{
 
 } # }}}
 
-sub formbuilder_setup (@) { #{{{
-       my %params=@_;
-       my $form=$params{form};
-       my $q=$params{cgi};
+sub check_canrename ($$$$$$$) { #{{{
+       my $src=shift;
+       my $srcfile=shift;
+       my $dest=shift;
+       my $destfile=shift;
+       my $q=shift;
+       my $session=shift;
+       my $attachment=shift;
 
-       if (defined $form->field("do") && $form->field("do") eq "edit") {
-               # Rename button for the page, and also for attachments.
-               push @{$params{buttons}}, "Rename";
-               $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
+       # Must be a known source file.
+       if (! exists $pagesources{$src}) {
+               error(sprintf(gettext("%s does not exist"),
+                       htmllink("", "", $src, noimageinline => 1)));
+       }
+       
+       # Must exist on disk, and be a regular file.
+       if (! -e "$config{srcdir}/$srcfile") {
+               error(sprintf(gettext("%s is not in the srcdir, so it cannot be renamed"), $srcfile));
+       }
+       elsif (-l "$config{srcdir}/$srcfile" && ! -f _) {
+               error(sprintf(gettext("%s is not a file"), $srcfile));
+       }
+
+       # Must be editable.
+       IkiWiki::check_canedit($src, $q, $session);
+       if ($attachment) {
+               IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
+       }
+       
+       # Dest checks can be omitted by passing undef.
+       if (defined $dest) {
+               if ($src eq $dest || $srcfile eq $destfile) {
+                       error(gettext("no change to the file name was specified"));
+               }
+
+               # Must be a legal filename, and not absolute.
+               if (IkiWiki::file_pruned($destfile, $config{srcdir}) || 
+                   $destfile=~/^\//) {
+                       error(sprintf(gettext("illegal name")));
+               }
+
+               # Must not be a known source file.
+               if (exists $pagesources{$dest}) {
+                       error(sprintf(gettext("%s already exists"),
+                               htmllink("", "", $dest, noimageinline => 1)));
+               }
+       
+               # Must not exist on disk already.
+               if (-l "$config{srcdir}/$destfile" || -e _) {
+                       error(sprintf(gettext("%s already exists on disk"), $destfile));
+               }
+       
+               # Must be editable.
+               IkiWiki::check_canedit($dest, $q, $session);
+               if ($attachment) {
+                       # Note that $srcfile is used here, not $destfile,
+                       # because it wants the current file, to check it.
+                       IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
+               }
        }
 } #}}}
 
@@ -58,6 +108,9 @@ sub rename_start ($$$$) {
        my $attachment=shift;
        my $page=shift;
 
+       check_canrename($page, $pagesources{$page}, undef, undef,
+               $q, $session, $attachment);
+
        # Save current form state to allow returning to it later
        # without losing any edits.
        # (But don't save what button was submitted, to avoid
@@ -76,24 +129,56 @@ sub rename_start ($$$$) {
        exit 0;
 }
 
-sub postrename ($;$) {
+my $renamesummary;
+sub postrename ($;$$$) {
        my $session=shift;
-       my $newname=shift;
+       my $src=shift;
+       my $dest=shift;
+       my $attachment=shift;
 
-       # Load saved form state and return to edit form.
+       # Load saved form state and return to edit page.
        my $postrename=CGI->new($session->param("postrename"));
-       if (defined $newname) {
-               # They renamed the page they were editing.
-               # Tweak the edit form to be editing the new
-               # page name, and redirect back to it.
-               # (Deep evil here.)
-               error("don't know how to redir back!"); ## FIXME
-       }
        $session->clear("postrename");
        IkiWiki::cgi_savesession($session);
-       IkiWiki::cgi($postrename, $session);
+
+       if (defined $src) {
+               # Generate a rename summary, that will be shown at the top
+               # of the edit template.
+               my $template=template("renamesummary.tmpl");
+               $template->param(src => $src);
+               $template->param(dest => $dest);
+               $renamesummary=$template->output;
+       }
+
+       if (defined $dest && ! $attachment) {
+               # They renamed the page they were editing. This requires
+               # fixups to the edit form state.
+               # Tweak the edit form to be editing the new page.
+               $postrename->param("page", $dest);
+               # Get a new edit token; old one might not be valid for the
+               # renamed file.
+               $postrename->param("rcsinfo", IkiWiki::rcs_prepedit($pagesources{$dest}));
+       }
+
+       IkiWiki::cgi_editpage($postrename, $session);
 }
 
+sub formbuilder_setup (@) { #{{{
+       my %params=@_;
+       my $form=$params{form};
+       my $q=$params{cgi};
+
+       if (defined $form->field("do") && $form->field("do") eq "edit") {
+               # Rename button for the page, and also for attachments.
+               push @{$params{buttons}}, "Rename";
+               $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
+
+               if (defined $renamesummary) {
+                       $form->tmpl_param(message => $renamesummary);
+               }
+       }
+} #}}}
+
 sub formbuilder (@) { #{{{
        my %params=@_;
        my $form=$params{form};
@@ -130,58 +215,47 @@ sub sessioncgi ($$) { #{{{
                        postrename($session);
                }
                elsif ($form->submitted eq 'Rename' && $form->validate) {
-                       my $page=$q->param("page");
+                       # These untaints are safe because of the checks
+                       # performed in check_canrename below.
+                       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")));
 
-                       # This untaint is safe because of the checks below.
-                       my $file=IkiWiki::possibly_foolish_untaint($pagesources{$page});
-
-                       # Must be a known source file.
-                       if (! defined $file) {
-                               error(sprintf(gettext("%s does not exist"),
-                               htmllink("", "", $page, noimageinline => 1)));
-                       }
-                               
-                       # Must be editiable.
-                       IkiWiki::check_canedit($page, $q, $session);
-
-                       # Must exist on disk, and be a regular file.
-                       if (! -e "$config{srcdir}/$file") {
-                               error(sprintf(gettext("%s is not in the srcdir, so it cannot be deleted"), $file));
-                       }
-                       elsif (-l "$config{srcdir}/$file" && ! -f _) {
-                               error(sprintf(gettext("%s is not a file"), $file));
+                       # The extension of dest is the same as src if it's
+                       # a page. If it's an extension, the extension is
+                       # already included.
+                       my $destfile=$dest;
+                       if (! $q->param("attachment")) {
+                               my ($ext)=$srcfile=~/(\.[^.]+)$/;
+                               $destfile.=$ext;
                        }
 
-                       # TODO: check attachment limits
+                       check_canrename($src, $srcfile, $dest, $destfile,
+                               $q, $session, $q->param("attachment"));
 
-                       my $dest=IkiWiki::titlepage($q->param("new_name"));
-                       # XXX TODO check $dest!
+                       # Ensures that the dest directory exists and is ok.
+                       IkiWiki::prep_writefile($destfile, $config{srcdir});
 
                        # Do rename, and update the wiki.
                        require IkiWiki::Render;
                        if ($config{rcs}) {
                                IkiWiki::disable_commit_hook();
-                               my $token=IkiWiki::rcs_prepedit($file);
-                               IkiWiki::rcs_rename($file, $dest);
-                               IkiWiki::rcs_commit($file, gettext("rename $file to $dest"),
-                                       $token, $session->param("name"), $ENV{REMOTE_ADDR});
+                               IkiWiki::rcs_rename($srcfile, $destfile);
+                               IkiWiki::rcs_commit_staged(
+                                       sprintf(gettext("rename %s to %s"), $src, $dest),
+                                       $session->param("name"), $ENV{REMOTE_ADDR});
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }
                        else {
-                               if (! rename("$config{srcdir}/$file", "$config{srcdir}/$dest")) {
+                               if (! rename("$config{srcdir}/$srcfile", "$config{srcdir}/$destfile")) {
                                        error("rename: $!");
                                }
                        }
                        IkiWiki::refresh();
                        IkiWiki::saveindex();
 
-                       if ($q->param("attachment")) {
-                               postrename($session);
-                       }
-                       else {
-                               postrename($session, $dest);
-                       }
+                       postrename($session, $src, $dest, $q->param("attachment"));
                }
                else {
                        IkiWiki::showform($form, $buttons, $session, $q);