2 package IkiWiki::Plugin::rename;
9 hook(type => "formbuilder_setup", id => "rename", call => \&formbuilder_setup);
10 hook(type => "formbuilder", id => "rename", call => \&formbuilder);
11 hook(type => "sessioncgi", id => "rename", call => \&sessioncgi);
15 sub check_canrename ($$$$$$$) { #{{{
24 # Must be a known source file.
25 if (! exists $pagesources{$src}) {
26 error(sprintf(gettext("%s does not exist"),
27 htmllink("", "", $src, noimageinline => 1)));
30 # Must exist on disk, and be a regular file.
31 if (! -e "$config{srcdir}/$srcfile") {
32 error(sprintf(gettext("%s is not in the srcdir, so it cannot be renamed"), $srcfile));
34 elsif (-l "$config{srcdir}/$srcfile" && ! -f _) {
35 error(sprintf(gettext("%s is not a file"), $srcfile));
39 IkiWiki::check_canedit($src, $q, $session);
41 IkiWiki::Plugin::attachment::check_canattach($session, $src, $srcfile);
44 # Dest checks can be omitted by passing undef.
46 if ($src eq $dest || $srcfile eq $destfile) {
47 error(gettext("no change to the file name was specified"));
50 # Must be a legal filename, and not absolute.
51 if (IkiWiki::file_pruned($destfile, $config{srcdir}) ||
53 error(sprintf(gettext("illegal name")));
56 # Must not be a known source file.
57 if (exists $pagesources{$dest}) {
58 error(sprintf(gettext("%s already exists"),
59 htmllink("", "", $dest, noimageinline => 1)));
62 # Must not exist on disk already.
63 if (-l "$config{srcdir}/$destfile" || -e _) {
64 error(sprintf(gettext("%s already exists on disk"), $destfile));
68 IkiWiki::check_canedit($dest, $q, $session);
70 # Note that $srcfile is used here, not $destfile,
71 # because it wants the current file, to check it.
72 IkiWiki::Plugin::attachment::check_canattach($session, $dest, $srcfile);
77 sub formbuilder_setup (@) { #{{{
79 my $form=$params{form};
82 if (defined $form->field("do") && $form->field("do") eq "edit") {
83 # Rename button for the page, and also for attachments.
84 push @{$params{buttons}}, "Rename";
85 $form->tmpl_param("field-rename" => '<input name="_submit" type="submit" value="Rename Attachment" />');
89 sub rename_form ($$$) { #{{{
94 eval q{use CGI::FormBuilder};
96 my $f = CGI::FormBuilder->new(
98 title => sprintf(gettext("rename %s"), IkiWiki::pagetitle($page)),
104 action => $config{cgiurl},
105 stylesheet => IkiWiki::baseurl()."style.css",
106 fields => [qw{do page new_name attachment}],
109 $f->field(name => "do", type => "hidden", value => "rename", force => 1);
110 $f->field(name => "page", type => "hidden", value => $page, force => 1);
111 $f->field(name => "new_name", value => IkiWiki::pagetitle($page), size => 60);
112 $f->field(name => "attachment", type => "hidden");
114 return $f, ["Rename", "Cancel"];
117 sub rename_start ($$$$) {
120 my $attachment=shift;
123 check_canrename($page, $pagesources{$page}, undef, undef,
124 $q, $session, $attachment);
126 # Save current form state to allow returning to it later
127 # without losing any edits.
128 # (But don't save what button was submitted, to avoid
129 # looping back to here.)
130 # Note: "_submit" is CGI::FormBuilder internals.
131 $q->param(-name => "_submit", -value => "");
132 $session->param(postrename => scalar $q->Vars);
133 IkiWiki::cgi_savesession($session);
135 my ($f, $buttons)=rename_form($q, $session, $page);
136 if (defined $attachment) {
137 $f->field(name => "attachment", value => $attachment, force => 1);
140 IkiWiki::showform($f, $buttons, $session, $q);
144 sub postrename ($;$) {
148 # Load saved form state and return to edit form.
149 my $postrename=CGI->new($session->param("postrename"));
150 if (defined $newname) {
151 # They renamed the page they were editing.
152 # Tweak the edit form to be editing the new
153 # page name, and redirect back to it.
155 error("don't know how to redir back!"); ## FIXME
157 $session->clear("postrename");
158 IkiWiki::cgi_savesession($session);
159 IkiWiki::cgi($postrename, $session);
162 sub formbuilder (@) { #{{{
164 my $form=$params{form};
166 if (defined $form->field("do") && $form->field("do") eq "edit") {
168 my $session=$params{session};
170 if ($form->submitted eq "Rename") {
171 rename_start($q, $session, 0, $form->field("page"));
173 elsif ($form->submitted eq "Rename Attachment") {
174 my @selected=$q->param("attachment_select");
176 error(gettext("Only one attachment can be renamed at a time."));
178 elsif (! @selected) {
179 error(gettext("Please select the attachment to rename."))
181 rename_start($q, $session, 1, $selected[0]);
186 sub sessioncgi ($$) { #{{{
189 if ($q->param("do") eq 'rename') {
191 my ($form, $buttons)=rename_form($q, $session, $q->param("page"));
192 IkiWiki::decode_form_utf8($form);
194 if ($form->submitted eq 'Cancel') {
195 postrename($session);
197 elsif ($form->submitted eq 'Rename' && $form->validate) {
198 # These untaints are safe because of the checks
199 # performed in check_canrename below.
200 my $src=$q->param("page");
201 my $srcfile=IkiWiki::possibly_foolish_untaint($pagesources{$src});
202 my $dest=IkiWiki::possibly_foolish_untaint(IkiWiki::titlepage($q->param("new_name")));
204 # The extension of dest is the same as src if it's
205 # a page. If it's an extension, the extension is
208 if (! $q->param("attachment")) {
209 my ($ext)=$srcfile=~/(\.[^.]+)$/;
213 check_canrename($src, $srcfile, $dest, $destfile,
214 $q, $session, $q->param("attachment"));
216 # Ensures that the dest directory exists and is ok.
217 IkiWiki::prep_writefile($destfile, $config{srcdir});
219 # Do rename, and update the wiki.
220 require IkiWiki::Render;
222 IkiWiki::disable_commit_hook();
223 IkiWiki::rcs_rename($srcfile, $destfile);
224 IkiWiki::rcs_commit_staged(gettext("rename $srcfile to $destfile"),
225 $session->param("name"), $ENV{REMOTE_ADDR});
226 IkiWiki::enable_commit_hook();
227 IkiWiki::rcs_update();
230 if (! rename("$config{srcdir}/$srcfile", "$config{srcdir}/$destfile")) {
235 IkiWiki::saveindex();
237 if ($q->param("attachment")) {
238 postrename($session);
241 postrename($session, $dest);
245 IkiWiki::showform($form, $buttons, $session, $q);