X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/a3e16cd29f65182c4119bcc9303432efe01bc5c1..8494104b395dc8b7bce045aec84460351c3efd1d:/IkiWiki/Plugin/rename.pm?ds=sidebyside

diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index d3fc7681d..d6079e198 100644
--- a/IkiWiki/Plugin/rename.pm
+++ b/IkiWiki/Plugin/rename.pm
@@ -6,21 +6,80 @@ 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" => '<input name="_submit" type="submit" value="Rename Attachment" />');
+sub check_canrename ($$$$$$$) { #{{{
+	my $src=shift;
+	my $srcfile=shift;
+	my $dest=shift;
+	my $destfile=shift;
+	my $q=shift;
+	my $session=shift;
+	my $attachment=shift;
+
+	# 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 ($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);
+		}
 	}
 } #}}}
 
@@ -47,17 +106,38 @@ 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;
 	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
@@ -74,25 +154,40 @@ sub rename_start ($$$$) {
 	
 	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=@_;
@@ -118,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" => '<input name="_submit" type="submit" value="Rename Attachment" />');
+
+		if (defined $renamesummary) {
+			$form->tmpl_param(message => $renamesummary);
+		}
+	}
+} #}}}
+
 sub sessioncgi ($$) { #{{{
         my $q=shift;
 
@@ -130,58 +243,127 @@ 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)));
-			}
+			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));
-			}
-			elsif (-l "$config{srcdir}/$file" && ! -f _) {
-				error(sprintf(gettext("%s is not a file"), $file));
+				$destfile.=".".$type;
 			}
 
-			# 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.
+			# 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();
-				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();
+				IkiWiki::rcs_rename($srcfile, $destfile);
+				IkiWiki::rcs_commit_staged(
+					sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
+					$session->param("name"), $ENV{REMOTE_ADDR});
 			}
 			else {
-				if (! rename("$config{srcdir}/$file", "$config{srcdir}/$dest")) {
+				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();
 
-			if ($q->param("attachment")) {
-				postrename($session);
+			# 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;
+				}
 			}
-			else {
-				postrename($session, $dest);
+
+			# 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);
@@ -189,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