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