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