]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Plugin/rename.pm
f793495612c2d360dd2df480c33913f0ad801b7b
[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 3.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 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         my $canrename;
92         IkiWiki::run_hooks(canrename => sub {
93                 return if defined $canrename;
94                 my $ret=shift->($q, $session, src => $src, srcfile => $srcfile,
95                                 dest => $dest, destfile => $destfile);
96                 if (defined $ret) {
97                         if ($ret eq "") {
98                                 $canrename=1;
99                         }
100                         elsif (ref $ret eq 'CODE') {
101                                 $ret->();
102                                 $canrename=0;
103                         }
104                         elsif (defined $ret) {
105                                 error($ret);
106                                 $canrename=0;
107                         }
108                 }
109         });
110         return $canrename;
111 }
112
113 sub rename_form ($$$) {
114         my $q=shift;
115         my $session=shift;
116         my $page=shift;
117
118         eval q{use CGI::FormBuilder};
119         error($@) if $@;
120         my $f = CGI::FormBuilder->new(
121                 name => "rename",
122                 title => sprintf(gettext("rename %s"), pagetitle($page)),
123                 header => 0,
124                 charset => "utf-8",
125                 method => 'POST',
126                 javascript => 0,
127                 params => $q,
128                 action => $config{cgiurl},
129                 stylesheet => IkiWiki::baseurl()."style.css",
130                 fields => [qw{do page new_name attachment}],
131         );
132         
133         $f->field(name => "do", type => "hidden", value => "rename", force => 1);
134         $f->field(name => "page", type => "hidden", value => $page, force => 1);
135         $f->field(name => "new_name", value => pagetitle($page, 1), size => 60);
136         if (!$q->param("attachment")) {
137                 # insert the standard extensions
138                 my @page_types;
139                 if (exists $IkiWiki::hooks{htmlize}) {
140                         @page_types=grep { !/^_/ }
141                                 keys %{$IkiWiki::hooks{htmlize}};
142                 }
143         
144                 # make sure the current extension is in the list
145                 my ($ext) = $pagesources{$page}=~/\.([^.]+)$/;
146                 if (! $IkiWiki::hooks{htmlize}{$ext}) {
147                         unshift(@page_types, $ext);
148                 }
149         
150                 $f->field(name => "type", type => 'select',
151                         options => \@page_types,
152                         value => $ext, force => 1);
153                 
154                 foreach my $p (keys %pagesources) {
155                         if ($pagesources{$p}=~m/^\Q$page\E\//) {
156                                 $f->field(name => "subpages",
157                                         label => "",
158                                         type => "checkbox",
159                                         options => [ [ 1 => gettext("Also rename SubPages and attachments") ] ],
160                                         value => 1,
161                                         force => 1);
162                                 last;
163                         }
164                 }
165         }
166         $f->field(name => "attachment", type => "hidden");
167
168         return $f, ["Rename", "Cancel"];
169 }
170
171 sub rename_start ($$$$) {
172         my $q=shift;
173         my $session=shift;
174         my $attachment=shift;
175         my $page=shift;
176
177         check_canrename($page, $pagesources{$page}, undef, undef,
178                 $q, $session);
179
180         # Save current form state to allow returning to it later
181         # without losing any edits.
182         # (But don't save what button was submitted, to avoid
183         # looping back to here.)
184         # Note: "_submit" is CGI::FormBuilder internals.
185         $q->param(-name => "_submit", -value => "");
186         $session->param(postrename => scalar $q->Vars);
187         IkiWiki::cgi_savesession($session);
188         
189         if (defined $attachment) {
190                 $q->param(-name => "attachment", -value => $attachment);
191         }
192         my ($f, $buttons)=rename_form($q, $session, $page);
193         IkiWiki::showform($f, $buttons, $session, $q);
194         exit 0;
195 }
196
197 sub postrename ($;$$$) {
198         my $session=shift;
199         my $src=shift;
200         my $dest=shift;
201         my $attachment=shift;
202
203         # Load saved form state and return to edit page.
204         my $postrename=CGI->new($session->param("postrename"));
205         $session->clear("postrename");
206         IkiWiki::cgi_savesession($session);
207
208         if (defined $dest) {
209                 if (! $attachment) {
210                         # They renamed the page they were editing. This requires
211                         # fixups to the edit form state.
212                         # Tweak the edit form to be editing the new page.
213                         $postrename->param("page", $dest);
214                 }
215
216                 # Update edit form content to fix any links present
217                 # on it.
218                 $postrename->param("editcontent",
219                         renamelink_hook($dest, $src, $dest,
220                                  $postrename->param("editcontent")));
221
222                 # Get a new edit token; old was likely invalidated.
223                 $postrename->param("rcsinfo",
224                         IkiWiki::rcs_prepedit($pagesources{$dest}));
225         }
226
227         IkiWiki::cgi_editpage($postrename, $session);
228 }
229
230 sub formbuilder (@) {
231         my %params=@_;
232         my $form=$params{form};
233
234         if (defined $form->field("do") && ($form->field("do") eq "edit" ||
235             $form->field("do") eq "create")) {
236                 my $q=$params{cgi};
237                 my $session=$params{session};
238
239                 if ($form->submitted eq "Rename" && $form->field("do") eq "edit") {
240                         rename_start($q, $session, 0, $form->field("page"));
241                 }
242                 elsif ($form->submitted eq "Rename Attachment") {
243                         my @selected=$q->param("attachment_select");
244                         if (@selected > 1) {
245                                 error(gettext("Only one attachment can be renamed at a time."));
246                         }
247                         elsif (! @selected) {
248                                 error(gettext("Please select the attachment to rename."))
249                         }
250                         rename_start($q, $session, 1, $selected[0]);
251                 }
252         }
253 }
254
255 my $renamesummary;
256
257 sub formbuilder_setup (@) {
258         my %params=@_;
259         my $form=$params{form};
260         my $q=$params{cgi};
261
262         if (defined $form->field("do") && ($form->field("do") eq "edit" ||
263             $form->field("do") eq "create")) {
264                 # Rename button for the page, and also for attachments.
265                 push @{$params{buttons}}, "Rename" if $form->field("do") eq "edit";
266                 $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
267
268                 if (defined $renamesummary) {
269                         $form->tmpl_param(message => $renamesummary);
270                 }
271         }
272 }
273
274 sub sessioncgi ($$) {
275         my $q=shift;
276
277         if ($q->param("do") eq 'rename') {
278                 my $session=shift;
279                 my ($form, $buttons)=rename_form($q, $session, $q->param("page"));
280                 IkiWiki::decode_form_utf8($form);
281
282                 if ($form->submitted eq 'Cancel') {
283                         postrename($session);
284                 }
285                 elsif ($form->submitted eq 'Rename' && $form->validate) {
286                         # Queue of rename actions to perfom.
287                         my @torename;
288
289                         # These untaints are safe because of the checks
290                         # performed in check_canrename later.
291                         my $src=$q->param("page");
292                         my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
293                         my $dest=IkiWiki::possibly_foolish_untaint(titlepage($q->param("new_name")));
294                         my $destfile=$dest;
295                         if (! $q->param("attachment")) {
296                                 my $type=$q->param('type');
297                                 if (defined $type && length $type && $IkiWiki::hooks{htmlize}{$type}) {
298                                         $type=IkiWiki::possibly_foolish_untaint($type);
299                                 }
300                                 else {
301                                         my ($ext)=$srcfile=~/\.([^.]+)$/;
302                                         $type=$ext;
303                                 }
304                                 
305                                 $destfile=newpagefile($dest, $type);
306                         }
307                         push @torename, {
308                                 src => $src,
309                                 srcfile => $srcfile,
310                                 dest => $dest,
311                                 destfile => $destfile,
312                                 required => 1,
313                         };
314
315                         IkiWiki::run_hooks(rename => sub { shift->(\@torename, $q, $session); });
316
317                         # See if any subpages need to be renamed.
318                         if ($q->param("subpages") && $src ne $dest) {
319                                 foreach my $p (keys %pagesources) {
320                                         next unless $pagesources{$p}=~m/^\Q$src\E\//;
321                                         # If indexpages is enabled, the
322                                         # srcfile should not be confused
323                                         # with a subpage.
324                                         next if $pagesources{$p} eq $srcfile;
325
326                                         my $d=$pagesources{$p};
327                                         $d=~s/^\Q$src\E\//$dest\//;
328                                         push @torename, {
329                                                 src => $p,
330                                                 srcfile => $pagesources{$p},
331                                                 dest => pagename($d),
332                                                 destfile => $d,
333                                                 required => 0,
334                                         };
335                                 }
336                         }
337                         
338                         require IkiWiki::Render;
339                         IkiWiki::disable_commit_hook() if $config{rcs};
340                         my %origpagesources=%pagesources;
341
342                         # First file renaming.
343                         foreach my $rename (@torename) {
344                                 if ($rename->{required}) {
345                                         do_rename($rename, $q, $session);
346                                 }
347                                 else {
348                                         eval {do_rename($rename, $q, $session)};
349                                         if ($@) {
350                                                 $rename->{error}=$@;
351                                                 next;
352                                         }
353                                 }
354
355                                 # Temporarily tweak pagesources to point to
356                                 # the renamed file, in case fixlinks needs
357                                 # to edit it.
358                                 $pagesources{$rename->{src}}=$rename->{destfile};
359                         }
360                         IkiWiki::rcs_commit_staged(
361                                 sprintf(gettext("rename %s to %s"), $srcfile, $destfile),
362                                 $session->param("name"), $ENV{REMOTE_ADDR}) if $config{rcs};
363
364                         # Then link fixups.
365                         foreach my $rename (@torename) {
366                                 next if $rename->{src} eq $rename->{dest};
367                                 next if $rename->{error};
368                                 foreach my $p (fixlinks($rename, $session)) {
369                                         # map old page names to new
370                                         foreach my $r (@torename) {
371                                                 next if $rename->{error};
372                                                 if ($r->{src} eq $p) {
373                                                         $p=$r->{dest};
374                                                         last;
375                                                 }
376                                         }
377                                         push @{$rename->{fixedlinks}}, $p;
378                                 }
379                         }
380
381                         # Then refresh.
382                         %pagesources=%origpagesources;
383                         if ($config{rcs}) {
384                                 IkiWiki::enable_commit_hook();
385                                 IkiWiki::rcs_update();
386                         }
387                         IkiWiki::refresh();
388                         IkiWiki::saveindex();
389
390                         # Find pages with remaining, broken links.
391                         foreach my $rename (@torename) {
392                                 next if $rename->{src} eq $rename->{dest};
393                                 
394                                 foreach my $page (keys %links) {
395                                         my $broken=0;
396                                         foreach my $link (@{$links{$page}}) {
397                                                 my $bestlink=bestlink($page, $link);
398                                                 if ($bestlink eq $rename->{src}) {
399                                                         push @{$rename->{brokenlinks}}, $page;
400                                                         last;
401                                                 }
402                                         }
403                                 }
404                         }
405
406                         # Generate a summary, that will be shown at the top
407                         # of the edit template.
408                         $renamesummary="";
409                         foreach my $rename (@torename) {
410                                 my $template=template("renamesummary.tmpl");
411                                 $template->param(src => $rename->{srcfile});
412                                 $template->param(dest => $rename->{destfile});
413                                 $template->param(error => $rename->{error});
414                                 if ($rename->{src} ne $rename->{dest}) {
415                                         $template->param(brokenlinks_checked => 1);
416                                         $template->param(brokenlinks => linklist($rename->{dest}, $rename->{brokenlinks}));
417                                         $template->param(fixedlinks => linklist($rename->{dest}, $rename->{fixedlinks}));
418                                 }
419                                 $renamesummary.=$template->output;
420                         }
421
422                         postrename($session, $src, $dest, $q->param("attachment"));
423                 }
424                 else {
425                         IkiWiki::showform($form, $buttons, $session, $q);
426                 }
427
428                 exit 0;
429         }
430 }
431                                                 
432 sub linklist {
433         # generates a list of links in a form suitable for FormBuilder
434         my $dest=shift;
435         my $list=shift;
436         # converts a list of pages into a list of links
437         # in a form suitable for FormBuilder.
438
439         [map {
440                 {
441                         page => htmllink($dest, $dest, $_,
442                                         noimageinline => 1,
443                                         linktext => pagetitle($_),
444                                 )
445                 }
446         } @{$list}]
447 }
448
449 sub renamelink_hook ($$$$) {
450         my ($page, $src, $dest, $content)=@_;
451
452         IkiWiki::run_hooks(renamelink => sub {
453                 $content=shift->(
454                         page => $page,
455                         oldpage => $src,
456                         newpage => $dest,
457                         content => $content,
458                 );
459         });
460
461         return $content;
462 }
463                         
464 sub do_rename ($$$) {
465         my $rename=shift;
466         my $q=shift;
467         my $session=shift;
468
469         # First, check if this rename is allowed.
470         check_canrename($rename->{src},
471                 $rename->{srcfile},
472                 $rename->{dest},
473                 $rename->{destfile},
474                 $q, $session);
475
476         # Ensure that the dest directory exists and is ok.
477         IkiWiki::prep_writefile($rename->{destfile}, $config{srcdir});
478
479         if ($config{rcs}) {
480                 IkiWiki::rcs_rename($rename->{srcfile}, $rename->{destfile});
481         }
482         else {
483                 if (! rename($config{srcdir}."/".$rename->{srcfile},
484                              $config{srcdir}."/".$rename->{destfile})) {
485                         error("rename: $!");
486                 }
487         }
488
489 }
490
491 sub fixlinks ($$$) {
492         my $rename=shift;
493         my $session=shift;
494
495         my @fixedlinks;
496
497         foreach my $page (keys %links) {
498                 my $needfix=0;
499                 foreach my $link (@{$links{$page}}) {
500                         my $bestlink=bestlink($page, $link);
501                         if ($bestlink eq $rename->{src}) {
502                                 $needfix=1;
503                                 last;
504                         }
505                 }
506                 if ($needfix) {
507                         my $file=$pagesources{$page};
508                         my $oldcontent=readfile($config{srcdir}."/".$file);
509                         my $content=renamelink_hook($page, $rename->{src}, $rename->{dest}, $oldcontent);
510                         if ($oldcontent ne $content) {
511                                 my $token=IkiWiki::rcs_prepedit($file);
512                                 eval { writefile($file, $config{srcdir}, $content) };
513                                 next if $@;
514                                 my $conflict=IkiWiki::rcs_commit(
515                                         $file,
516                                         sprintf(gettext("update for rename of %s to %s"), $rename->{srcfile}, $rename->{destfile}),
517                                         $token,
518                                         $session->param("name"), 
519                                         $ENV{REMOTE_ADDR}
520                                 );
521                                 push @fixedlinks, $page if ! defined $conflict;
522                         }
523                 }
524         }
525
526         return @fixedlinks;
527 }
528
529 1