2 package IkiWiki::Plugin::rename;
9 hook(type => "formbuilder_setup", id => "rename", call => \&formbuilder_setup);
10 hook(type => "formbuilder", id => "rename", call => \&formbuilder);
11 hook(type => "sessioncgi", id => "rename", call => \&sessioncgi);
15 sub check_canrename ($$$$$$$) { #{{{
24 # Must be a known source file.
25 if (! exists $pagesources{$src}) {
26 error(sprintf(gettext("%s does not exist"),
27 htmllink("", "", $src, noimageinline => 1)));
30 # Must exist on disk, and be a regular file.
31 if (! -e "$config{srcdir}/$srcfile") {
32 error(sprintf(gettext("%s is not in the srcdir, so it cannot be renamed"), $srcfile));
34 elsif (-l "$config{srcdir}/$srcfile" && ! -f _) {
35 error(sprintf(gettext("%s is not a file"), $srcfile));
39 IkiWiki::check_canedit($src, $q, $session);
41 IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
44 # Dest checks can be omitted by passing undef.
46 if ($src eq $dest || $srcfile eq $destfile) {
47 error(gettext("no change to the file name was specified"));
50 # Must be a legal filename, and not absolute.
51 if (IkiWiki::file_pruned($destfile, $config{srcdir}) ||
53 error(sprintf(gettext("illegal name")));
56 # Must not be a known source file.
57 if (exists $pagesources{$dest}) {
58 error(sprintf(gettext("%s already exists"),
59 htmllink("", "", $dest, noimageinline => 1)));
62 # Must not exist on disk already.
63 if (-l "$config{srcdir}/$destfile" || -e _) {
64 error(sprintf(gettext("%s already exists on disk"), $destfile));
68 IkiWiki::check_canedit($dest, $q, $session);
70 # Note that $srcfile is used here, not $destfile,
71 # because it wants the current file, to check it.
72 IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
77 sub rename_form ($$$) { #{{{
82 eval q{use CGI::FormBuilder};
84 my $f = CGI::FormBuilder->new(
86 title => sprintf(gettext("rename %s"), IkiWiki::pagetitle($page)),
92 action => $config{cgiurl},
93 stylesheet => IkiWiki::baseurl()."style.css",
94 fields => [qw{do page new_name attachment}],
97 $f->field(name => "do", type => "hidden", value => "rename", force => 1);
98 $f->field(name => "page", type => "hidden", value => $page, force => 1);
99 $f->field(name => "new_name", value => IkiWiki::pagetitle($page), size => 60);
100 $f->field(name => "attachment", type => "hidden");
102 return $f, ["Rename", "Cancel"];
105 sub rename_start ($$$$) {
108 my $attachment=shift;
111 check_canrename($page, $pagesources{$page}, undef, undef,
112 $q, $session, $attachment);
114 # Save current form state to allow returning to it later
115 # without losing any edits.
116 # (But don't save what button was submitted, to avoid
117 # looping back to here.)
118 # Note: "_submit" is CGI::FormBuilder internals.
119 $q->param(-name => "_submit", -value => "");
120 $session->param(postrename => scalar $q->Vars);
121 IkiWiki::cgi_savesession($session);
123 my ($f, $buttons)=rename_form($q, $session, $page);
124 if (defined $attachment) {
125 $f->field(name => "attachment", value => $attachment, force => 1);
128 IkiWiki::showform($f, $buttons, $session, $q);
133 sub postrename ($;$$$) {
137 my $attachment=shift;
139 # Load saved form state and return to edit page.
140 my $postrename=CGI->new($session->param("postrename"));
141 $session->clear("postrename");
142 IkiWiki::cgi_savesession($session);
145 # Generate a rename summary, that will be shown at the top
146 # of the edit template.
147 my $template=template("renamesummary.tmpl");
148 $template->param(src => $src);
149 $template->param(dest => $dest);
150 $renamesummary=$template->output;
153 if (defined $dest && ! $attachment) {
154 # They renamed the page they were editing. This requires
155 # fixups to the edit form state.
156 # Tweak the edit form to be editing the new page.
157 $postrename->param("page", $dest);
158 # Get a new edit token; old one might not be valid for the
160 $postrename->param("rcsinfo", IkiWiki::rcs_prepedit($pagesources{$dest}));
163 IkiWiki::cgi_editpage($postrename, $session);
166 sub formbuilder_setup (@) { #{{{
168 my $form=$params{form};
171 if (defined $form->field("do") && $form->field("do") eq "edit") {
172 # Rename button for the page, and also for attachments.
173 push @{$params{buttons}}, "Rename";
174 $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
176 if (defined $renamesummary) {
177 $form->tmpl_param(message => $renamesummary);
182 sub formbuilder (@) { #{{{
184 my $form=$params{form};
186 if (defined $form->field("do") && $form->field("do") eq "edit") {
188 my $session=$params{session};
190 if ($form->submitted eq "Rename") {
191 rename_start($q, $session, 0, $form->field("page"));
193 elsif ($form->submitted eq "Rename Attachment") {
194 my @selected=$q->param("attachment_select");
196 error(gettext("Only one attachment can be renamed at a time."));
198 elsif (! @selected) {
199 error(gettext("Please select the attachment to rename."))
201 rename_start($q, $session, 1, $selected[0]);
206 sub sessioncgi ($$) { #{{{
209 if ($q->param("do") eq 'rename') {
211 my ($form, $buttons)=rename_form($q, $session, $q->param("page"));
212 IkiWiki::decode_form_utf8($form);
214 if ($form->submitted eq 'Cancel') {
215 postrename($session);
217 elsif ($form->submitted eq 'Rename' && $form->validate) {
218 # These untaints are safe because of the checks
219 # performed in check_canrename below.
220 my $src=$q->param("page");
221 my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
222 my $dest=IkiWiki::possibly_foolish_untaint(IkiWiki::titlepage($q->param("new_name")));
224 # The extension of dest is the same as src if it's
225 # a page. If it's an extension, the extension is
228 if (! $q->param("attachment")) {
229 my ($ext)=$srcfile=~/(\.[^.]+)$/;
233 check_canrename($src, $srcfile, $dest, $destfile,
234 $q, $session, $q->param("attachment"));
236 # Ensures that the dest directory exists and is ok.
237 IkiWiki::prep_writefile($destfile, $config{srcdir});
239 # Do rename, and update the wiki.
240 require IkiWiki::Render;
242 IkiWiki::disable_commit_hook();
243 IkiWiki::rcs_rename($srcfile, $destfile);
244 IkiWiki::rcs_commit_staged(
245 sprintf(gettext("rename %s to %s"), $src, $dest),
246 $session->param("name"), $ENV{REMOTE_ADDR});
247 IkiWiki::enable_commit_hook();
248 IkiWiki::rcs_update();
251 if (! rename("$config{srcdir}/$srcfile", "$config{srcdir}/$destfile")) {
256 IkiWiki::saveindex();
258 postrename($session, $src, $dest, $q->param("attachment"));
261 IkiWiki::showform($form, $buttons, $session, $q);