2 package IkiWiki::Plugin::editpage;
7 use open qw{:utf8 :std};
10 hook(type => "getsetup", id => "editpage", call => \&getsetup);
11 hook(type => "refresh", id => "editpage", call => \&refresh);
12 hook(type => "sessioncgi", id => "editpage", call => \&IkiWiki::cgi_editpage);
24 if (exists $wikistate{editpage} && exists $wikistate{editpage}{previews}) {
25 # Expire old preview files after one hour.
26 my $expire=time - (60 * 60);
29 foreach my $file (@{$wikistate{editpage}{previews}}) {
30 my $mtime=(stat("$config{destdir}/$file"))[9];
31 if (defined $mtime && $mtime <= $expire) {
32 # Avoid deleting a preview that was later saved.
34 foreach my $page (keys %renderedfiles) {
35 if (grep { $_ eq $file } @{$renderedfiles{$page}}) {
40 debug(sprintf(gettext("removing old preview %s"), $file));
41 IkiWiki::prune("$config{destdir}/$file");
44 elsif (defined $mtime) {
45 push @previews, $file;
48 $wikistate{editpage}{previews}=\@previews;
52 # Back to ikiwiki namespace for the rest, this code is very much
53 # internal to ikiwiki even though it's separated into a plugin,
54 # and other plugins use the function below.
57 sub cgi_editpage ($$) {
61 my $do=$q->param('do');
62 return unless $do eq 'create' || $do eq 'edit';
66 my @fields=qw(do rcsinfo subpage from page type editcontent comments);
67 my @buttons=("Save Page", "Preview", "Cancel");
68 eval q{use CGI::FormBuilder};
70 my $form = CGI::FormBuilder->new(
74 required => [qw{editcontent}],
77 action => $config{cgiurl},
80 template => scalar template_params("editpage.tmpl"),
83 decode_form_utf8($form);
84 run_hooks(formbuilder_setup => sub {
85 shift->(form => $form, cgi => $q, session => $session,
86 buttons => \@buttons);
88 decode_form_utf8($form);
90 # This untaint is safe because we check file_pruned and
92 my ($page)=$form->field('page')=~/$config{wiki_file_regexp}/;
93 $page=possibly_foolish_untaint($page);
94 my $absolute=($page =~ s#^/+##);
95 if (! defined $page || ! length $page ||
96 file_pruned($page, $config{srcdir})) {
97 error(gettext("bad page name"));
100 my $baseurl = urlto($page, undef, 1);
103 if (defined $form->field('from')) {
104 ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
109 if (exists $pagesources{$page} && $form->field("do") ne "create") {
110 $file=$pagesources{$page};
111 $type=pagetype($file);
112 if (! defined $type || $type=~/^_/) {
113 error(sprintf(gettext("%s is not an editable page"), $page));
115 if (! $form->submitted) {
116 $form->field(name => "rcsinfo",
117 value => rcs_prepedit($file), force => 1);
119 $form->field(name => "editcontent", validate => '/.*/');
122 $type=$form->param('type');
123 if (defined $type && length $type && $hooks{htmlize}{$type}) {
124 $type=possibly_foolish_untaint($type);
126 elsif (defined $from && exists $pagesources{$from}) {
127 # favor the type of linking page
128 $type=pagetype($pagesources{$from});
130 $type=$config{default_pageext} unless defined $type;
131 $file=newpagefile($page, $type);
132 if (! $form->submitted) {
133 $form->field(name => "rcsinfo", value => "", force => 1);
135 $form->field(name => "editcontent", validate => '/.+/');
138 $form->field(name => "do", type => 'hidden');
139 $form->field(name => "sid", type => "hidden", value => $session->id,
141 $form->field(name => "from", type => 'hidden');
142 $form->field(name => "rcsinfo", type => 'hidden');
143 $form->field(name => "subpage", type => 'hidden');
144 $form->field(name => "page", value => $page, force => 1);
145 $form->field(name => "type", value => $type, force => 1);
146 $form->field(name => "comments", type => "text", size => 80);
147 $form->field(name => "editcontent", type => "textarea", rows => 20,
149 $form->tmpl_param("can_commit", $config{rcs});
150 $form->tmpl_param("indexlink", indexlink());
151 $form->tmpl_param("helponformattinglink",
152 htmllink($page, $page, "ikiwiki/formatting",
154 linktext => "FormattingHelp"));
156 if ($form->submitted eq "Cancel") {
157 if ($form->field("do") eq "create" && defined $from) {
158 redirect($q, urlto($from, undef, 1));
160 elsif ($form->field("do") eq "create") {
161 redirect($q, $config{url});
164 redirect($q, urlto($page, undef, 1));
168 elsif ($form->submitted eq "Preview") {
169 my $new=not exists $pagesources{$page};
171 # temporarily record its type
172 $pagesources{$page}=$page.".".$type;
174 my %wasrendered=map { $_ => 1 } @{$renderedfiles{$page}};
176 my $content=$form->field('editcontent');
178 run_hooks(editcontent => sub {
186 my $preview=htmlize($page, $page, $type,
187 linkify($page, $page,
188 preprocess($page, $page,
189 filter($page, $page, $content), 0, 1)));
190 run_hooks(format => sub {
196 $form->tmpl_param("page_preview", $preview);
199 delete $pagesources{$page};
202 # Previewing may have created files on disk.
203 # Keep a list of these to be deleted later.
204 my %previews = map { $_ => 1 } @{$wikistate{editpage}{previews}};
205 foreach my $f (@{$renderedfiles{$page}}) {
206 $previews{$f}=1 unless $wasrendered{$f};
208 @{$wikistate{editpage}{previews}} = keys %previews;
209 $renderedfiles{$page}=[keys %wasrendered];
212 elsif ($form->submitted eq "Save Page") {
213 $form->tmpl_param("page_preview", "");
216 if ($form->submitted ne "Save Page" || ! $form->validate) {
217 if ($form->field("do") eq "create") {
220 if (! defined $from || ! length $from ||
221 $from ne $form->field('from') ||
222 file_pruned($from, $config{srcdir}) ||
226 @page_locs=$best_loc=$page;
232 if ((defined $form->field('subpage') && length $form->field('subpage')) ||
233 $page eq gettext('discussion')) {
234 $best_loc="$from/$page";
237 $best_loc=$dir.$page;
240 push @page_locs, $dir.$page;
241 push @page_locs, "$from/$page";
242 while (length $dir) {
244 push @page_locs, $dir.$page;
247 push @page_locs, "$config{userdir}/$page"
248 if length $config{userdir};
252 ! exists $pagecase{lc $_}
255 # hmm, someone else made the page in the
257 if ($form->submitted eq "Preview") {
258 # let them go ahead with the edit
259 # and resolve the conflict at save
264 redirect($q, urlto($page, undef, 1));
269 my @editable_locs = grep {
270 check_canedit($_, $q, $session, 1)
272 if (! @editable_locs) {
273 # let it throw an error this time
274 map { check_canedit($_, $q, $session) } @page_locs;
278 if (exists $hooks{htmlize}) {
279 foreach my $key (grep { !/^_/ } keys %{$hooks{htmlize}}) {
280 push @page_types, [$key, $hooks{htmlize}{$key}{longname} || $key];
283 @page_types=sort @page_types;
285 $form->tmpl_param("page_select", 1);
286 $form->field(name => "page", type => 'select',
287 options => [ map { [ $_, pagetitle($_, 1) ] } @editable_locs ],
289 $form->field(name => "type", type => 'select',
290 options => \@page_types);
291 $form->title(sprintf(gettext("creating %s"), pagetitle($page)));
294 elsif ($form->field("do") eq "edit") {
295 check_canedit($page, $q, $session);
296 if (! defined $form->field('editcontent') ||
297 ! length $form->field('editcontent')) {
299 if (exists $pagesources{$page}) {
300 $content=readfile(srcfile($pagesources{$page}));
301 $content=~s/\n/\r\n/g;
303 $form->field(name => "editcontent", value => $content,
306 $form->tmpl_param("page_select", 0);
307 $form->field(name => "page", type => 'hidden');
308 $form->field(name => "type", type => 'hidden');
309 $form->title(sprintf(gettext("editing %s"), pagetitle($page)));
312 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
316 check_canedit($page, $q, $session);
317 checksessionexpiry($q, $session, $q->param('sid'));
319 my $exists=-e "$config{srcdir}/$file";
321 if ($form->field("do") ne "create" && ! $exists &&
322 ! defined srcfile($file, 1)) {
323 $form->tmpl_param("message", template("editpagegone.tmpl")->output);
324 $form->field(name => "do", value => "create", force => 1);
325 $form->tmpl_param("page_select", 0);
326 $form->field(name => "page", type => 'hidden');
327 $form->field(name => "type", type => 'hidden');
328 $form->title(sprintf(gettext("editing %s"), $page));
329 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
332 elsif ($form->field("do") eq "create" && $exists) {
333 $form->tmpl_param("message", template("editcreationconflict.tmpl")->output);
334 $form->field(name => "do", value => "edit", force => 1);
335 $form->tmpl_param("page_select", 0);
336 $form->field(name => "page", type => 'hidden');
337 $form->field(name => "type", type => 'hidden');
338 $form->title(sprintf(gettext("editing %s"), $page));
339 $form->field("editcontent",
340 value => readfile("$config{srcdir}/$file").
341 "\n\n\n".$form->field("editcontent"),
343 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
348 if (defined $form->field('comments') &&
349 length $form->field('comments')) {
350 $message=$form->field('comments');
353 my $content=$form->field('editcontent');
354 check_content(content => $content, page => $page,
355 cgi => $q, session => $session,
356 subject => $message);
357 run_hooks(editcontent => sub {
365 $content=~s/\r\n/\n/g;
367 $content.="\n" if $content !~ /\n$/;
369 $config{cgi}=0; # avoid cgi error message
370 eval { writefile($file, $config{srcdir}, $content) };
373 $form->field(name => "rcsinfo", value => rcs_prepedit($file),
375 my $mtemplate=template("editfailedsave.tmpl");
376 $mtemplate->param(error_message => $@);
377 $form->tmpl_param("message", $mtemplate->output);
378 $form->field("editcontent", value => $content, force => 1);
379 $form->tmpl_param("page_select", 0);
380 $form->field(name => "page", type => 'hidden');
381 $form->field(name => "type", type => 'hidden');
382 $form->title(sprintf(gettext("editing %s"), $page));
383 showform($form, \@buttons, $session, $q,
384 forcebaseurl => $baseurl);
394 # Prevent deadlock with post-commit hook by
395 # signaling to it that it should not try to
397 disable_commit_hook();
398 $conflict=rcs_commit($file, $message,
399 $form->field("rcsinfo"),
400 $session->param("name"), $ENV{REMOTE_ADDR});
401 enable_commit_hook();
405 # Refresh even if there was a conflict, since other changes
406 # may have been committed while the post-commit hook was
408 require IkiWiki::Render;
412 if (defined $conflict) {
413 $form->field(name => "rcsinfo", value => rcs_prepedit($file),
415 $form->tmpl_param("message", template("editconflict.tmpl")->output);
416 $form->field("editcontent", value => $conflict, force => 1);
417 $form->field("do", "edit", force => 1);
418 $form->tmpl_param("page_select", 0);
419 $form->field(name => "page", type => 'hidden');
420 $form->field(name => "type", type => 'hidden');
421 $form->title(sprintf(gettext("editing %s"), $page));
422 showform($form, \@buttons, $session, $q,
423 forcebaseurl => $baseurl);
426 # The trailing question mark tries to avoid broken
427 # caches and get the most recent version of the page.
428 redirect($q, urlto($page, undef, 1)."?updated");