X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a3e16cd29f65182c4119bcc9303432efe01bc5c1..414ccfb1e298a722d2afa8b8540ca84dc1ccc6f2:/IkiWiki/Plugin/rename.pm

diff --git a/IkiWiki/Plugin/rename.pm b/IkiWiki/Plugin/rename.pm
index d3fc7681d..8e32d41ae 100644
--- a/IkiWiki/Plugin/rename.pm
+++ b/IkiWiki/Plugin/rename.pm
@@ -3,28 +3,115 @@ package IkiWiki::Plugin::rename;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
+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);
+	hook(type => "rename", id => "rename", call => \&rename_subpages);
+}
 
-} # }}}
+sub getsetup () {
+	return 
+		plugin => {
+			safe => 1,
+			rebuild => 0,
+			section => "web",
+		},
+}
 
-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;
 
-	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" />');
+	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, "$config{srcdir}/$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.
+		if (IkiWiki::file_pruned($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, "$config{srcdir}/$srcfile");
+		}
 	}
-} #}}}
 
-sub rename_form ($$$) { #{{{ 
+	my $canrename;
+	IkiWiki::run_hooks(canrename => sub {
+		return if defined $canrename;
+		my $ret=shift->(cgi => $q, session => $session,
+			src => $src, srcfile => $srcfile,
+			dest => $dest, destfile => $destfile);
+		if (defined $ret) {
+			if ($ret eq "") {
+				$canrename=1;
+			}
+			elsif (ref $ret eq 'CODE') {
+				$ret->();
+				$canrename=0;
+			}
+			elsif (defined $ret) {
+				error($ret);
+				$canrename=0;
+			}
+		}
+	});
+	return defined $canrename ? $canrename : 1;
+}
+
+sub rename_form ($$$) {
 	my $q=shift;
 	my $session=shift;
 	my $page=shift;
@@ -33,24 +120,58 @@ 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',
 		javascript => 0,
 		params => $q,
-		action => $config{cgiurl},
-		stylesheet => IkiWiki::baseurl()."style.css",
+		action => IkiWiki::cgiurl(),
+		stylesheet => 1,
 		fields => [qw{do page new_name attachment}],
 	);
 	
 	$f->field(name => "do", type => "hidden", value => "rename", force => 1);
+	$f->field(name => "sid", type => "hidden", value => $session->id,
+		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, 1), size => 60);
+	if (!$q->param("attachment")) {
+		# insert the standard extensions
+		my @page_types;
+		if (exists $IkiWiki::hooks{htmlize}) {
+			foreach my $key (grep { !/^_/ } keys %{$IkiWiki::hooks{htmlize}}) {
+				push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key];
+			}
+		}
+		@page_types=sort @page_types;
+	
+		# make sure the current extension is in the list
+		my ($ext) = $pagesources{$page}=~/\.([^.]+)$/;
+		if (! $IkiWiki::hooks{htmlize}{$ext}) {
+			unshift(@page_types, [$ext, $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 ($$$$) {
 	my $q=shift;
@@ -58,6 +179,16 @@ sub rename_start ($$$$) {
 	my $attachment=shift;
 	my $page=shift;
 
+	# Special case for renaming held attachments; normal checks
+	# don't apply.
+	my $held=$attachment &&
+		IkiWiki::Plugin::attachment->can("is_held_attachment") &&
+		IkiWiki::Plugin::attachment::is_held_attachment($page);
+	if (! $held) {
+		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,46 +198,62 @@ 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 (@) { #{{{
+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")) {
+    		IkiWiki::decode_form_utf8($form);
 		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") {
-			my @selected=$q->param("attachment_select");
+			my @selected=map { Encode::decode_utf8($_) } $q->param("attachment_select");
 			if (@selected > 1) {
 				error(gettext("Only one attachment can be renamed at a time."));
 			}
@@ -116,72 +263,174 @@ sub formbuilder (@) { #{{{
 			rename_start($q, $session, 1, $selected[0]);
 		}
 	}
-} #}}}
+}
+
+my $renamesummary;
+
+sub formbuilder_setup (@) {
+	my %params=@_;
+	my $form=$params{form};
+	my $q=$params{cgi};
 
-sub sessioncgi ($$) { #{{{
+	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" => '<input name="_submit" type="submit" value="Rename Attachment" />');
+
+		if (defined $renamesummary) {
+			$form->tmpl_param(message => $renamesummary);
+		}
+	}
+}
+
+sub sessioncgi ($$) {
         my $q=shift;
 
 	if ($q->param("do") eq 'rename') {
         	my $session=shift;
-		my ($form, $buttons)=rename_form($q, $session, $q->param("page"));
+		my ($form, $buttons)=rename_form($q, $session, Encode::decode_utf8($q->param("page")));
 		IkiWiki::decode_form_utf8($form);
 
 		if ($form->submitted eq 'Cancel') {
 			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});
+			IkiWiki::checksessionexpiry($q, $session, $q->param('sid'));
 
-			# 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=$form->field("page");
+			my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src})
+				if exists $pagesources{$src};
+			my $dest=IkiWiki::possibly_foolish_untaint(titlepage($form->field("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));
+		
+			# Special case for renaming held attachments.
+			my $held=$q->param("attachment") &&
+				IkiWiki::Plugin::attachment->can("is_held_attachment") &&
+				IkiWiki::Plugin::attachment::is_held_attachment($src);
+			if ($held) {
+				rename($held, IkiWiki::Plugin::attachment::attachment_holding_location($dest));
+				postrename($session, $src, $dest, $q->param("attachment"))
+					unless defined $srcfile;
 			}
+			
+			# Queue of rename actions to perfom.
+			my @torename;
+			push @torename, {
+				src => $src,
+			       	srcfile => $srcfile,
+				dest => $dest,
+			       	destfile => $destfile,
+				required => 1,
+			};
 
-			# TODO: check attachment limits
-
-			my $dest=IkiWiki::titlepage($q->param("new_name"));
-			# XXX TODO check $dest!
+			@torename=rename_hook(
+				torename => \@torename,
+				done => {},
+				cgi => $q,
+				session => $session,
+			);
 
-			# Do rename, and update the wiki.
 			require IkiWiki::Render;
+			IkiWiki::disable_commit_hook() if $config{rcs};
+			my %origpagesources=%pagesources;
+
+			# 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;
+					}
+				}
+
+				# 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(
+				message => sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
+				session => $session,
+			) 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;
+				}
+			}
+
+			# 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 => linklist($rename->{dest}, $rename->{brokenlinks}));
+					$template->param(fixedlinks => linklist($rename->{dest}, $rename->{fixedlinks}));
+				}
+				$renamesummary.=$template->output;
 			}
+
+			postrename($session, $src, $dest, $q->param("attachment"));
 		}
 		else {
 			IkiWiki::showform($form, $buttons, $session, $q);
@@ -191,4 +440,170 @@ sub sessioncgi ($$) { #{{{
 	}
 }
 
+# Add subpages to the list of pages to be renamed, if needed.
+sub rename_subpages (@) {
+	my %params = @_;
+
+	my %torename = %{$params{torename}};
+	my $q = $params{cgi};
+	my $src = $torename{src};
+	my $srcfile = $torename{src};
+	my $dest = $torename{dest};
+	my $destfile = $torename{dest};
+
+	return () unless ($q->param("subpages") && $src ne $dest);
+
+	my @ret;
+	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 @ret, {
+			src => $p,
+			srcfile => $pagesources{$p},
+			dest => pagename($d),
+			destfile => $d,
+			required => 0,
+		};
+	}
+	return @ret;
+}
+
+sub linklist {
+	# generates a list of links in a form suitable for FormBuilder
+	my $dest=shift;
+	my $list=shift;
+	# converts a list of pages into a list of links
+	# in a form suitable for FormBuilder.
+
+	[map {
+		{
+			page => htmllink($dest, $dest, $_,
+					noimageinline => 1,
+					linktext => pagetitle($_),
+				)
+		}
+	} @{$list}]
+}
+
+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 rename_hook {
+	my %params = @_;
+
+	my @torename=@{$params{torename}};
+	my %done=%{$params{done}};
+	my $q=$params{cgi};
+	my $session=$params{session};
+
+	return () unless @torename;
+
+	my @nextset;
+	foreach my $torename (@torename) {
+		unless (exists $done{$torename->{src}} && $done{$torename->{src}}) {
+			IkiWiki::run_hooks(rename => sub {
+				push @nextset, shift->(
+					torename => $torename,
+					cgi => $q,
+					session => $session,
+				);
+			});
+			$done{$torename->{src}}=1;
+		}
+	}
+
+	push @torename, rename_hook(
+		torename => \@nextset,
+		done => \%done,
+		cgi => $q,
+		session => $session,
+	);
+
+	# dedup
+	my %seen;
+	return grep { ! $seen{$_->{src}}++ } @torename;
+}
+
+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};
+			next unless -e $config{srcdir}."/".$file;
+			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 => $file,
+					message => sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),
+					token => $token,
+					session => $session,
+				);
+				push @fixedlinks, $page if ! defined $conflict;
+			}
+		}
+	}
+
+	return @fixedlinks;
+}
+
 1