4ee377b86c5b5f500eb6acd1323fa174cf4ba709
[ikiwiki.git] / IkiWiki / Plugin / rename.pm
1 #!/usr/bin/perl
2 package IkiWiki::Plugin::rename;
3
4 use warnings;
5 use strict;
6 use IkiWiki 2.00;
7
8 sub import { #{{{
9         hook(type => "getsetup", id => "rename", call => \&getsetup);
10         hook(type => "formbuilder_setup", id => "rename", call => \&formbuilder_setup);
11         hook(type => "formbuilder", id => "rename", call => \&formbuilder);
12         hook(type => "sessioncgi", id => "rename", call => \&sessioncgi);
13
14 } # }}}
15
16 sub getsetup () { #{{{
17         return 
18                 plugin => {
19                         safe => 1,
20                         rebuild => 0,
21                 },
22 } #}}}
23
24 sub check_canrename ($$$$$$) { #{{{
25         my $src=shift;
26         my $srcfile=shift;
27         my $dest=shift;
28         my $destfile=shift;
29         my $q=shift;
30         my $session=shift;
31
32         my $attachment=! defined IkiWiki::pagetype($pagesources{$src});
33
34         # Must be a known source file.
35         if (! exists $pagesources{$src}) {
36                 error(sprintf(gettext("%s does not exist"),
37                         htmllink("", "", $src, noimageinline => 1)));
38         }
39         
40         # Must exist on disk, and be a regular file.
41         if (! -e "$config{srcdir}/$srcfile") {
42                 error(sprintf(gettext("%s is not in the srcdir, so it cannot be renamed"), $srcfile));
43         }
44         elsif (-l "$config{srcdir}/$srcfile" && ! -f _) {
45                 error(sprintf(gettext("%s is not a file"), $srcfile));
46         }
47
48         # Must be editable.
49         IkiWiki::check_canedit($src, $q, $session);
50         if ($attachment) {
51                 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
52                         IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
53                 }
54                 else {
55                         error("renaming of attachments is not allowed");
56                 }
57         }
58         
59         # Dest checks can be omitted by passing undef.
60         if (defined $dest) {
61                 if ($srcfile eq $destfile) {
62                         error(gettext("no change to the file name was specified"));
63                 }
64
65                 # Must be a legal filename, and not absolute.
66                 if (IkiWiki::file_pruned($destfile, $config{srcdir}) || 
67                     $destfile=~/^\//) {
68                         error(sprintf(gettext("illegal name")));
69                 }
70
71                 # Must not be a known source file.
72                 if ($src ne $dest && exists $pagesources{$dest}) {
73                         error(sprintf(gettext("%s already exists"),
74                                 htmllink("", "", $dest, noimageinline => 1)));
75                 }
76         
77                 # Must not exist on disk already.
78                 if (-l "$config{srcdir}/$destfile" || -e _) {
79                         error(sprintf(gettext("%s already exists on disk"), $destfile));
80                 }
81         
82                 # Must be editable.
83                 IkiWiki::check_canedit($dest, $q, $session);
84                 if ($attachment) {
85                         # Note that $srcfile is used here, not $destfile,
86                         # because it wants the current file, to check it.
87                         IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
88                 }
89         }
90 } #}}}
91
92 sub rename_form ($$$) { #{{{ 
93         my $q=shift;
94         my $session=shift;
95         my $page=shift;
96
97         eval q{use CGI::FormBuilder};
98         error($@) if $@;
99         my $f = CGI::FormBuilder->new(
100                 name => "rename",
101                 title => sprintf(gettext("rename %s"), IkiWiki::pagetitle($page)),
102                 header => 0,
103                 charset => "utf-8",
104                 method => 'POST',
105                 javascript => 0,
106                 params => $q,
107                 action => $config{cgiurl},
108                 stylesheet => IkiWiki::baseurl()."style.css",
109                 fields => [qw{do page new_name attachment}],
110         );
111         
112         $f->field(name => "do", type => "hidden", value => "rename", force => 1);
113         $f->field(name => "page", type => "hidden", value => $page, force => 1);
114         $f->field(name => "new_name", value => IkiWiki::pagetitle($page), size => 60);
115         if (!$q->param("attachment")) {
116                 # insert the standard extensions
117                 my @page_types;
118                 if (exists $IkiWiki::hooks{htmlize}) {
119                         @page_types=grep { !/^_/ }
120                                 keys %{$IkiWiki::hooks{htmlize}};
121                 }
122         
123                 # make sure the current extension is in the list
124                 my ($ext) = $pagesources{$page}=~/\.([^.]+)$/;
125                 if (! $IkiWiki::hooks{htmlize}{$ext}) {
126                         unshift(@page_types, $ext);
127                 }
128         
129                 $f->field(name => "type", type => 'select',
130                         options => \@page_types,
131                         value => $ext, force => 1);
132                 
133                 foreach my $p (keys %pagesources) {
134                         if ($pagesources{$p}=~m/^\Q$page\E\//) {
135                                 $f->field(name => "subpages",
136                                         label => "",
137                                         type => "checkbox",
138                                         options => [ [ 1 => gettext("Also rename SubPages and attachments") ] ],
139                                         value => 1,
140                                         force => 1);
141                                 last;
142                         }
143                 }
144         }
145         $f->field(name => "attachment", type => "hidden");
146
147         return $f, ["Rename", "Cancel"];
148 } #}}}
149
150 sub rename_start ($$$$) { #{{{
151         my $q=shift;
152         my $session=shift;
153         my $attachment=shift;
154         my $page=shift;
155
156         check_canrename($page, $pagesources{$page}, undef, undef,
157                 $q, $session);
158
159         # Save current form state to allow returning to it later
160         # without losing any edits.
161         # (But don't save what button was submitted, to avoid
162         # looping back to here.)
163         # Note: "_submit" is CGI::FormBuilder internals.
164         $q->param(-name => "_submit", -value => "");
165         $session->param(postrename => scalar $q->Vars);
166         IkiWiki::cgi_savesession($session);
167         
168         if (defined $attachment) {
169                 $q->param(-name => "attachment", -value => $attachment);
170         }
171         my ($f, $buttons)=rename_form($q, $session, $page);
172         IkiWiki::showform($f, $buttons, $session, $q);
173         exit 0;
174 } #}}}
175
176 sub postrename ($;$$$) { #{{{
177         my $session=shift;
178         my $src=shift;
179         my $dest=shift;
180         my $attachment=shift;
181
182         # Load saved form state and return to edit page.
183         my $postrename=CGI->new($session->param("postrename"));
184         $session->clear("postrename");
185         IkiWiki::cgi_savesession($session);
186
187         if (defined $dest) {
188                 if (! $attachment) {
189                         # They renamed the page they were editing. This requires
190                         # fixups to the edit form state.
191                         # Tweak the edit form to be editing the new page.
192                         $postrename->param("page", $dest);
193                 }
194
195                 # Update edit form content to fix any links present
196                 # on it.
197                 $postrename->param("editcontent",
198                         renamepage_hook($dest, $src, $dest,
199                                  $postrename->param("editcontent")));
200
201                 # Get a new edit token; old was likely invalidated.
202                 $postrename->param("rcsinfo",
203                         IkiWiki::rcs_prepedit($pagesources{$dest}));
204         }
205
206         IkiWiki::cgi_editpage($postrename, $session);
207 } #}}}
208
209 sub formbuilder (@) { #{{{
210         my %params=@_;
211         my $form=$params{form};
212
213         if (defined $form->field("do") && $form->field("do") eq "edit") {
214                 my $q=$params{cgi};
215                 my $session=$params{session};
216
217                 if ($form->submitted eq "Rename") {
218                         rename_start($q, $session, 0, $form->field("page"));
219                 }
220                 elsif ($form->submitted eq "Rename Attachment") {
221                         my @selected=$q->param("attachment_select");
222                         if (@selected > 1) {
223                                 error(gettext("Only one attachment can be renamed at a time."));
224                         }
225                         elsif (! @selected) {
226                                 error(gettext("Please select the attachment to rename."))
227                         }
228                         rename_start($q, $session, 1, $selected[0]);
229                 }
230         }
231 } #}}}
232
233 my $renamesummary;
234
235 sub formbuilder_setup (@) { #{{{
236         my %params=@_;
237         my $form=$params{form};
238         my $q=$params{cgi};
239
240         if (defined $form->field("do") && $form->field("do") eq "edit") {
241                 # Rename button for the page, and also for attachments.
242                 push @{$params{buttons}}, "Rename";
243                 $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
244
245                 if (defined $renamesummary) {
246                         $form->tmpl_param(message => $renamesummary);
247                 }
248         }
249 } #}}}
250
251 sub sessioncgi ($$) { #{{{
252         my $q=shift;
253
254         if ($q->param("do") eq 'rename') {
255                 my $session=shift;
256                 my ($form, $buttons)=rename_form($q, $session, $q->param("page"));
257                 IkiWiki::decode_form_utf8($form);
258
259                 if ($form->submitted eq 'Cancel') {
260                         postrename($session);
261                 }
262                 elsif ($form->submitted eq 'Rename' && $form->validate) {
263                         # Queue of rename actions to perfom.
264                         my @torename;
265
266                         # These untaints are safe because of the checks
267                         # performed in check_canrename later.
268                         my $src=$q->param("page");
269                         my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
270                         my $dest=IkiWiki::possibly_foolish_untaint(IkiWiki::titlepage($q->param("new_name")));
271                         my $destfile=$dest;
272                         if (! $q->param("attachment")) {
273                                 my $type=$q->param('type');
274                                 if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
275                                         $type=IkiWiki::possibly_foolish_untaint($type);
276                                 }
277                                 else {
278                                         my ($ext)=$srcfile=~/\.([^.]+)$/;
279                                         $type=$ext;
280                                 }
281                                 
282                                 $destfile.=".".$type;
283                         }
284                         push @torename, {
285                                 src => $src,
286                                 srcfile => $srcfile,
287                                 dest => $dest,
288                                 destfile => $destfile,
289                                 required => 1,
290                         };
291
292                         # See if any subpages need to be renamed.
293                         if ($q->param("subpages") && $src ne $dest) {
294                                 foreach my $p (keys %pagesources) {
295                                         if ($pagesources{$p}=~m/^\Q$src\E\//) {
296                                                 my $d=$pagesources{$p};
297                                                 $d=~s/^\Q$src\E\//$dest\//;
298                                                 push @torename, {
299                                                         src => $p,
300                                                         srcfile => $pagesources{$p},
301                                                         dest => pagename($d),
302                                                         destfile => $d,
303                                                         required => 0,
304                                                 };
305                                         }
306                                 }
307                         }
308                         
309                         require IkiWiki::Render;
310                         IkiWiki::disable_commit_hook() if $config{rcs};
311                         my %origpagesources=%pagesources;
312
313                         # First file renaming.
314                         foreach my $rename (@torename) {
315                                 if ($rename->{required}) {
316                                         do_rename($rename, $q, $session);
317                                 }
318                                 else {
319                                         eval {do_rename($rename, $q, $session)};
320                                         if ($@) {
321                                                 $rename->{error}=$@;
322                                                 next;
323                                         }
324                                 }
325
326                                 # Temporarily tweak pagesources to point to
327                                 # the renamed file, in case fixlinks needs
328                                 # to edit it.
329                                 $pagesources{$rename->{src}}=$rename->{destfile};
330                         }
331                         IkiWiki::rcs_commit_staged(
332                                 sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
333                                 $session->param("name"), $ENV{REMOTE_ADDR}) if $config{rcs};
334
335                         # Then link fixups.
336                         foreach my $rename (@torename) {
337                                 next if $rename->{src} eq $rename->{dest};
338                                 next if $rename->{error};
339                                 foreach my $p (fixlinks($rename, $session)) {
340                                         # map old page names to new
341                                         foreach my $r (@torename) {
342                                                 next if $rename->{error};
343                                                 if ($r->{src} eq $p) {
344                                                         $p=$r->{dest};
345                                                         last;
346                                                 }
347                                         }
348                                         push @{$rename->{fixedlinks}}, $p;
349                                 }
350                         }
351
352                         # Then refresh.
353                         %pagesources=%origpagesources;
354                         if ($config{rcs}) {
355                                 IkiWiki::enable_commit_hook();
356                                 IkiWiki::rcs_update();
357                         }
358                         IkiWiki::refresh();
359                         IkiWiki::saveindex();
360
361                         # Find pages with remaining, broken links.
362                         foreach my $rename (@torename) {
363                                 next if $rename->{src} eq $rename->{dest};
364                                 
365                                 foreach my $page (keys %links) {
366                                         my $broken=0;
367                                         foreach my $link (@{$links{$page}}) {
368                                                 my $bestlink=bestlink($page, $link);
369                                                 if ($bestlink eq $rename->{src}) {
370                                                         push @{$rename->{brokenlinks}}, $page;
371                                                         last;
372                                                 }
373                                         }
374                                 }
375                         }
376
377                         # Generate a summary, that will be shown at the top
378                         # of the edit template.
379                         $renamesummary="";
380                         foreach my $rename (@torename) {
381                                 my $template=template("renamesummary.tmpl");
382                                 $template->param(src => $rename->{srcfile});
383                                 $template->param(dest => $rename->{destfile});
384                                 $template->param(error => $rename->{error});
385                                 if ($rename->{src} ne $rename->{dest}) {
386                                         $template->param(brokenlinks_checked => 1);
387                                         $template->param(brokenlinks => [
388                                                 map {
389                                                         {
390                                                                 page => htmllink($rename->{dest}, $rename->{dest}, $_,
391                                                                                 noimageinline => 1)
392                                                         }
393                                                 } @{$rename->{brokenlinks}}
394                                         ]);
395                                         $template->param(fixedlinks => [
396                                                 map {
397                                                         {
398                                                                 page => htmllink($rename->{dest}, $rename->{dest}, $_,
399                                                                                 noimageinline => 1)
400                                                         }
401                                                 } @{$rename->{fixedlinks}}
402                                         ]);
403                                 }
404                                 $renamesummary.=$template->output;
405                         }
406
407                         postrename($session, $src, $dest, $q->param("attachment"));
408                 }
409                 else {
410                         IkiWiki::showform($form, $buttons, $session, $q);
411                 }
412
413                 exit 0;
414         }
415 } #}}}
416
417 sub renamepage_hook ($$$$) { #{{{
418         my ($page, $src, $dest, $content)=@_;
419
420         IkiWiki::run_hooks(renamepage => sub {
421                 $content=shift->(
422                         page => $page,
423                         oldpage => $src,
424                         newpage => $dest,
425                         content => $content,
426                 );
427         });
428
429         return $content;
430 }# }}}
431                         
432 sub do_rename ($$$) { #{{{
433         my $rename=shift;
434         my $q=shift;
435         my $session=shift;
436
437         # First, check if this rename is allowed.
438         check_canrename($rename->{src},
439                 $rename->{srcfile},
440                 $rename->{dest},
441                 $rename->{destfile},
442                 $q, $session);
443
444         # Ensure that the dest directory exists and is ok.
445         IkiWiki::prep_writefile($rename->{destfile}, $config{srcdir});
446
447         if ($config{rcs}) {
448                 IkiWiki::rcs_rename($rename->{srcfile}, $rename->{destfile});
449         }
450         else {
451                 if (! rename($config{srcdir}."/".$rename->{srcfile},
452                              $config{srcdir}."/".$rename->{destfile})) {
453                         error("rename: $!");
454                 }
455         }
456
457 } # }}}
458
459 sub fixlinks ($$$) { #{{{
460         my $rename=shift;
461         my $session=shift;
462
463         my @fixedlinks;
464
465         foreach my $page (keys %links) {
466                 my $needfix=0;
467                 foreach my $link (@{$links{$page}}) {
468                         my $bestlink=bestlink($page, $link);
469                         if ($bestlink eq $rename->{src}) {
470                                 $needfix=1;
471                                 last;
472                         }
473                 }
474                 if ($needfix) {
475                         my $file=$pagesources{$page};
476                         my $oldcontent=readfile($config{srcdir}."/".$file);
477                         my $content=renamepage_hook($page, $rename->{src}, $rename->{dest}, $oldcontent);
478                         if ($oldcontent ne $content) {
479                                 my $token=IkiWiki::rcs_prepedit($file);
480                                 eval { writefile($file, $config{srcdir}, $content) };
481                                 next if $@;
482                                 my $conflict=IkiWiki::rcs_commit(
483                                         $file,
484                                         sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),
485                                         $token,
486                                         $session->param("name"), 
487                                         $ENV{REMOTE_ADDR}
488                                 );
489                                 push @fixedlinks, $page if ! defined $conflict;
490                         }
491                 }
492         }
493
494         return @fixedlinks;
495 } #}}}
496
497 1