X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/2b9615194e0adefa0f61810405db1e9204ccc72b..8494104b395dc8b7bce045aec84460351c3efd1d:/IkiWiki/Plugin/rename.pm diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm index 9fa3f6a85..d6079e198 100644 --- a/IkiWiki/Plugin/rename.pm +++ b/IkiWiki/Plugin/rename.pm @@ -6,12 +6,21 @@ 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 getsetup () { #{{{ + return + plugin => { + safe => 1, + rebuild => 0, + }, +} #}}} + sub check_canrename ($$$$$$$) { #{{{ my $src=shift; my $srcfile=shift; @@ -43,7 +52,7 @@ sub check_canrename ($$$$$$$) { #{{{ # Dest checks can be omitted by passing undef. if (defined $dest) { - if ($src eq $dest || $srcfile eq $destfile) { + if ($srcfile eq $destfile) { error(gettext("no change to the file name was specified")); } @@ -54,7 +63,7 @@ sub check_canrename ($$$$$$$) { #{{{ } # Must not be a known source file. - if (exists $pagesources{$dest}) { + if ($src ne $dest && exists $pagesources{$dest}) { error(sprintf(gettext("%s already exists"), htmllink("", "", $dest, noimageinline => 1))); } @@ -74,18 +83,6 @@ sub check_canrename ($$$$$$$) { #{{{ } } #}}} -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" => ''); - } -} #}}} - sub rename_form ($$$) { #{{{ my $q=shift; my $session=shift; @@ -109,12 +106,30 @@ 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); + 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); + } $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; @@ -139,10 +154,11 @@ sub rename_start ($$$$) { IkiWiki::showform($f, $buttons, $session, $q); exit 0; -} +} #}}} -sub postrename ($;$$) { +sub postrename ($;$$$) { #{{{ my $session=shift; + my $src=shift; my $dest=shift; my $attachment=shift; @@ -151,18 +167,27 @@ sub postrename ($;$$) { $session->clear("postrename"); IkiWiki::cgi_savesession($session); - 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})); + 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=@_; @@ -188,6 +213,24 @@ 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") { + # Rename button for the page, and also for attachments. + push @{$params{buttons}}, "Rename"; + $form->tmpl_param("field-rename" => ''); + + if (defined $renamesummary) { + $form->tmpl_param(message => $renamesummary); + } + } +} #}}} + sub sessioncgi ($$) { #{{{ my $q=shift; @@ -206,13 +249,18 @@ sub sessioncgi ($$) { #{{{ my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src}); my $dest=IkiWiki::possibly_foolish_untaint(IkiWiki::titlepage($q->param("new_name"))); - # 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; + 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; + } + + $destfile.=".".$type; } check_canrename($src, $srcfile, $dest, $destfile, @@ -221,25 +269,101 @@ sub sessioncgi ($$) { #{{{ # Ensures that the dest directory exists and is ok. IkiWiki::prep_writefile($destfile, $config{srcdir}); - # Do rename, and update the wiki. + # Do rename, update other pages, and refresh site. + IkiWiki::disable_commit_hook() if $config{rcs}; require IkiWiki::Render; if ($config{rcs}) { - IkiWiki::disable_commit_hook(); IkiWiki::rcs_rename($srcfile, $destfile); - IkiWiki::rcs_commit_staged(sprintf(gettext("rename %s to %s", $src, $dest)), + IkiWiki::rcs_commit_staged( + sprintf(gettext("rename %s to %s"), $srcfile, $destfile), $session->param("name"), $ENV{REMOTE_ADDR}); - IkiWiki::enable_commit_hook(); - IkiWiki::rcs_update(); } else { if (! rename("$config{srcdir}/$srcfile", "$config{srcdir}/$destfile")) { error("rename: $!"); } } + 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; + 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; + } + } + } + } + if ($config{rcs}) { + IkiWiki::enable_commit_hook(); + IkiWiki::rcs_update(); + } IkiWiki::refresh(); IkiWiki::saveindex(); - postrename($session, $dest, $q->param("attachment")); + # Scan for any remaining broken links to $src. + my @brokenlinks; + if ($src ne $dest) { + foreach my $page (keys %links) { + my $broken=0; + foreach my $link (@{$links{$page}}) { + my $bestlink=bestlink($page, $link); + if ($bestlink eq $src) { + $broken=1; + last; + } + } + push @brokenlinks, $page if $broken; + } + } + + # Generate a rename summary, that will be shown at the top + # 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=$template->output; + + postrename($session, $src, $dest, $q->param("attachment")); } else { IkiWiki::showform($form, $buttons, $session, $q); @@ -247,6 +371,21 @@ 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; +}# }}} 1