X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a3e16cd29f65182c4119bcc9303432efe01bc5c1..646d7bf6a3c9d4f153f8129400a24ad147dcd67c:/IkiWiki/Plugin/rename.pm?ds=inline
diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index d3fc7681d..7e55e271c 100644
--- a/IkiWiki/Plugin/rename.pm
+++ b/IkiWiki/Plugin/rename.pm
@@ -6,21 +6,86 @@ use strict;
use IkiWiki 2.00;
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);
} # }}}
-sub formbuilder_setup (@) { #{{{
- my %params=@_;
- my $form=$params{form};
- my $q=$params{cgi};
+sub getsetup () { #{{{
+ return
+ plugin => {
+ safe => 1,
+ rebuild => 0,
+ },
+} #}}}
- 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" => '');
+sub check_canrename ($$$$$$) { #{{{
+ my $src=shift;
+ my $srcfile=shift;
+ my $dest=shift;
+ my $destfile=shift;
+ my $q=shift;
+ my $session=shift;
+
+ my $attachment=! defined pagetype($pagesources{$src});
+
+ # 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) {
+ 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.
+ if (defined $dest) {
+ if ($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 ($src ne $dest && 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);
+ }
}
} #}}}
@@ -33,7 +98,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',
@@ -46,18 +111,51 @@ 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), size => 60);
+ if (!$q->param("attachment")) {
+ # insert the standard extensions
+ my @page_types;
+ if (exists $IkiWiki::hooks{htmlize}) {
+ @page_types=grep { !/^_/ }
+ keys %{$IkiWiki::hooks{htmlize}};
+ }
+
+ # make sure the current extension is in the list
+ my ($ext) = $pagesources{$page}=~/\.([^.]+)$/;
+ if (! $IkiWiki::hooks{htmlize}{$ext}) {
+ unshift(@page_types, $ext);
+ }
+
+ $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"];
} #}}}
-sub rename_start ($$$$) {
+sub rename_start ($$$$) { #{{{
my $q=shift;
my $session=shift;
my $attachment=shift;
my $page=shift;
+ check_canrename($page, $pagesources{$page}, undef, undef,
+ $q, $session);
+
# Save current form state to allow returning to it later
# without losing any edits.
# (But don't save what button was submitted, to avoid
@@ -67,42 +165,57 @@ sub rename_start ($$$$) {
$session->param(postrename => scalar $q->Vars);
IkiWiki::cgi_savesession($session);
- my ($f, $buttons)=rename_form($q, $session, $page);
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;
-}
+} #}}}
-sub postrename ($;$) {
+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 $dest) {
+ if (! $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);
+ }
+
+ # Update edit form content to fix any links present
+ # on it.
+ $postrename->param("editcontent",
+ renamepage_hook($dest, $src, $dest,
+ $postrename->param("editcontent")));
+
+ # Get a new edit token; old was likely invalidated.
+ $postrename->param("rcsinfo",
+ IkiWiki::rcs_prepedit($pagesources{$dest}));
+ }
+
+ IkiWiki::cgi_editpage($postrename, $session);
+} #}}}
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") {
@@ -118,6 +231,25 @@ sub formbuilder (@) { #{{{
}
} #}}}
+my $renamesummary;
+
+sub formbuilder_setup (@) { #{{{
+ my %params=@_;
+ my $form=$params{form};
+ my $q=$params{cgi};
+
+ 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" if $form->field("do") eq "edit";
+ $form->tmpl_param("field-rename" => '');
+
+ if (defined $renamesummary) {
+ $form->tmpl_param(message => $renamesummary);
+ }
+ }
+} #}}}
+
sub sessioncgi ($$) { #{{{
my $q=shift;
@@ -130,58 +262,155 @@ sub sessioncgi ($$) { #{{{
postrename($session);
}
elsif ($form->submitted eq 'Rename' && $form->validate) {
- my $page=$q->param("page");
-
- # This untaint is safe because of the checks below.
- my $file=IkiWiki::possibly_foolish_untaint($pagesources{$page});
+ # Queue of rename actions to perfom.
+ my @torename;
- # Must be a known source file.
- if (! defined $file) {
- error(sprintf(gettext("%s does not exist"),
- htmllink("", "", $page, noimageinline => 1)));
- }
+ # These untaints are safe because of the checks
+ # performed in check_canrename later.
+ my $src=$q->param("page");
+ my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
+ my $dest=IkiWiki::possibly_foolish_untaint(titlepage($q->param("new_name")));
+ my $destfile=$dest;
+ if (! $q->param("attachment")) {
+ my $type=$q->param('type');
+ if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
+ $type=IkiWiki::possibly_foolish_untaint($type);
+ }
+ else {
+ my ($ext)=$srcfile=~/\.([^.]+)$/;
+ $type=$ext;
+ }
- # 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));
+ $destfile=newpagefile($dest, $type);
}
- elsif (-l "$config{srcdir}/$file" && ! -f _) {
- error(sprintf(gettext("%s is not a file"), $file));
+ 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) {
+ 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,
+ };
+ }
}
+
+ require IkiWiki::Render;
+ IkiWiki::disable_commit_hook() if $config{rcs};
+ my %origpagesources=%pagesources;
- # TODO: check attachment limits
+ # 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;
+ }
+ }
- my $dest=IkiWiki::titlepage($q->param("new_name"));
- # XXX TODO check $dest!
+ # Temporarily tweak pagesources to point to
+ # the renamed file, in case fixlinks needs
+ # to edit it.
+ $pagesources{$rename->{src}}=$rename->{destfile};
+ }
+ IkiWiki::rcs_commit_staged(
+ sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
+ $session->param("name"), $ENV{REMOTE_ADDR}) if $config{rcs};
- # Do rename, and update the wiki.
- require IkiWiki::Render;
+ # 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;
+ }
+ }
+
+ # Then refresh.
+ %pagesources=%origpagesources;
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::enable_commit_hook();
IkiWiki::rcs_update();
}
- else {
- if (! rename("$config{srcdir}/$file", "$config{srcdir}/$dest")) {
- error("rename: $!");
- }
- }
IkiWiki::refresh();
IkiWiki::saveindex();
- if ($q->param("attachment")) {
- postrename($session);
+ # 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);
+ if ($bestlink eq $rename->{src}) {
+ push @{$rename->{brokenlinks}}, $page;
+ last;
+ }
+ }
+ }
}
- else {
- postrename($session, $dest);
+
+ # Generate a summary, that will be shown at the top
+ # of the edit template.
+ $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;
}
+
+ postrename($session, $src, $dest, $q->param("attachment"));
}
else {
IkiWiki::showform($form, $buttons, $session, $q);
@@ -189,6 +418,86 @@ sub sessioncgi ($$) { #{{{
exit 0;
}
-}
+} #}}}
+
+sub renamepage_hook ($$$$) { #{{{
+ my ($page, $src, $dest, $content)=@_;
+
+ IkiWiki::run_hooks(renamepage => sub {
+ $content=shift->(
+ page => $page,
+ oldpage => $src,
+ newpage => $dest,
+ content => $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=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,
+ 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