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 functions below.
57 sub check_canedit ($$$;$) {
64 run_hooks(canedit => sub {
65 return if defined $canedit;
66 my $ret=shift->($page, $q, $session);
71 elsif (ref $ret eq 'CODE') {
72 $ret->() unless $nonfatal;
75 elsif (defined $ret) {
76 error($ret) unless $nonfatal;
81 return defined $canedit ? $canedit : 1;
84 sub check_content (@) {
87 return 1 if ! exists $hooks{checkcontent}; # optimisation
89 if (exists $pagesources{$params{page}}) {
91 my %old=map { $_ => 1 }
92 split("\n", readfile(srcfile($pagesources{$params{page}})));
93 foreach my $line (split("\n", $params{content})) {
94 push @diff, $line if ! exists $old{$_};
96 $params{content}=join("\n", @diff);
100 run_hooks(checkcontent => sub {
101 return if defined $ok;
102 my $ret=shift->(%params);
107 elsif (ref $ret eq 'CODE') {
111 elsif (defined $ret) {
117 return defined $ok ? $ok : 1;
120 sub check_cansave ($$$$) {
127 run_hooks(cansave => sub {
128 return if defined $cansave;
129 my $ret=shift->($page, $content, $q, $session);
134 elsif (ref $ret eq 'CODE') {
147 sub cgi_editpage ($$) {
151 my $do=$q->param('do');
152 return unless $do eq 'create' || $do eq 'edit';
156 my @fields=qw(do rcsinfo subpage from page type editcontent comments);
157 my @buttons=("Save Page", "Preview", "Cancel");
158 eval q{use CGI::FormBuilder};
160 my $form = CGI::FormBuilder->new(
164 required => [qw{editcontent}],
167 action => $config{cgiurl},
170 template => scalar template_params("editpage.tmpl"),
173 decode_form_utf8($form);
174 run_hooks(formbuilder_setup => sub {
175 shift->(form => $form, cgi => $q, session => $session,
176 buttons => \@buttons);
178 decode_form_utf8($form);
180 # This untaint is safe because we check file_pruned and
182 my ($page)=$form->field('page')=~/$config{wiki_file_regexp}/;
183 $page=possibly_foolish_untaint($page);
184 my $absolute=($page =~ s#^/+##);
185 if (! defined $page || ! length $page ||
186 file_pruned($page, $config{srcdir})) {
187 error(gettext("bad page name"));
190 my $baseurl = urlto($page, undef, 1);
193 if (defined $form->field('from')) {
194 ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
199 if (exists $pagesources{$page} && $form->field("do") ne "create") {
200 $file=$pagesources{$page};
201 $type=pagetype($file);
202 if (! defined $type || $type=~/^_/) {
203 error(sprintf(gettext("%s is not an editable page"), $page));
205 if (! $form->submitted) {
206 $form->field(name => "rcsinfo",
207 value => rcs_prepedit($file), force => 1);
209 $form->field(name => "editcontent", validate => '/.*/');
212 $type=$form->param('type');
213 if (defined $type && length $type && $hooks{htmlize}{$type}) {
214 $type=possibly_foolish_untaint($type);
216 elsif (defined $from && exists $pagesources{$from}) {
217 # favor the type of linking page
218 $type=pagetype($pagesources{$from});
220 $type=$config{default_pageext} unless defined $type;
221 $file=newpagefile($page, $type);
222 if (! $form->submitted) {
223 $form->field(name => "rcsinfo", value => "", force => 1);
225 $form->field(name => "editcontent", validate => '/.+/');
228 $form->field(name => "do", type => 'hidden');
229 $form->field(name => "sid", type => "hidden", value => $session->id,
231 $form->field(name => "from", type => 'hidden');
232 $form->field(name => "rcsinfo", type => 'hidden');
233 $form->field(name => "subpage", type => 'hidden');
234 $form->field(name => "page", value => $page, force => 1);
235 $form->field(name => "type", value => $type, force => 1);
236 $form->field(name => "comments", type => "text", size => 80);
237 $form->field(name => "editcontent", type => "textarea", rows => 20,
239 $form->tmpl_param("can_commit", $config{rcs});
240 $form->tmpl_param("indexlink", indexlink());
241 $form->tmpl_param("helponformattinglink",
242 htmllink($page, $page, "ikiwiki/formatting",
244 linktext => "FormattingHelp"));
246 if ($form->submitted eq "Cancel") {
247 if ($form->field("do") eq "create" && defined $from) {
248 redirect($q, urlto($from, undef, 1));
250 elsif ($form->field("do") eq "create") {
251 redirect($q, $config{url});
254 redirect($q, urlto($page, undef, 1));
258 elsif ($form->submitted eq "Preview") {
259 my $new=not exists $pagesources{$page};
261 # temporarily record its type
262 $pagesources{$page}=$page.".".$type;
264 my %wasrendered=map { $_ => 1 } @{$renderedfiles{$page}};
266 my $content=$form->field('editcontent');
268 run_hooks(editcontent => sub {
276 my $preview=htmlize($page, $page, $type,
277 linkify($page, $page,
278 preprocess($page, $page,
279 filter($page, $page, $content), 0, 1)));
280 run_hooks(format => sub {
286 $form->tmpl_param("page_preview", $preview);
289 delete $pagesources{$page};
292 # Previewing may have created files on disk.
293 # Keep a list of these to be deleted later.
294 my %previews = map { $_ => 1 } @{$wikistate{editpage}{previews}};
295 foreach my $f (@{$renderedfiles{$page}}) {
296 $previews{$f}=1 unless $wasrendered{$f};
298 @{$wikistate{editpage}{previews}} = keys %previews;
299 $renderedfiles{$page}=[keys %wasrendered];
302 elsif ($form->submitted eq "Save Page") {
303 $form->tmpl_param("page_preview", "");
306 if ($form->submitted ne "Save Page" || ! $form->validate) {
307 if ($form->field("do") eq "create") {
310 if (! defined $from || ! length $from ||
311 $from ne $form->field('from') ||
312 file_pruned($from, $config{srcdir}) ||
316 @page_locs=$best_loc=$page;
322 if ((defined $form->field('subpage') && length $form->field('subpage')) ||
323 $page eq gettext('discussion')) {
324 $best_loc="$from/$page";
327 $best_loc=$dir.$page;
330 push @page_locs, $dir.$page;
331 push @page_locs, "$from/$page";
332 while (length $dir) {
334 push @page_locs, $dir.$page;
337 push @page_locs, "$config{userdir}/$page"
338 if length $config{userdir};
342 ! exists $pagecase{lc $_}
345 # hmm, someone else made the page in the
347 if ($form->submitted eq "Preview") {
348 # let them go ahead with the edit
349 # and resolve the conflict at save
354 redirect($q, urlto($page, undef, 1));
359 my @editable_locs = grep {
360 check_canedit($_, $q, $session, 1)
362 if (! @editable_locs) {
363 # let it throw an error this time
364 map { check_canedit($_, $q, $session) } @page_locs;
368 if (exists $hooks{htmlize}) {
369 @page_types=grep { !/^_/ }
370 keys %{$hooks{htmlize}};
373 $form->tmpl_param("page_select", 1);
374 $form->field(name => "page", type => 'select',
375 options => [ map { [ $_, pagetitle($_, 1) ] } @editable_locs ],
377 $form->field(name => "type", type => 'select',
378 options => \@page_types);
379 $form->title(sprintf(gettext("creating %s"), pagetitle($page)));
382 elsif ($form->field("do") eq "edit") {
383 check_canedit($page, $q, $session);
384 if (! defined $form->field('editcontent') ||
385 ! length $form->field('editcontent')) {
387 if (exists $pagesources{$page}) {
388 $content=readfile(srcfile($pagesources{$page}));
389 $content=~s/\n/\r\n/g;
391 $form->field(name => "editcontent", value => $content,
394 $form->tmpl_param("page_select", 0);
395 $form->field(name => "page", type => 'hidden');
396 $form->field(name => "type", type => 'hidden');
397 $form->title(sprintf(gettext("editing %s"), pagetitle($page)));
400 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
404 check_canedit($page, $q, $session);
405 checksessionexpiry($q, $session, $q->param('sid'));
407 my $exists=-e "$config{srcdir}/$file";
409 if ($form->field("do") ne "create" && ! $exists &&
410 ! defined srcfile($file, 1)) {
411 $form->tmpl_param("message", template("editpagegone.tmpl")->output);
412 $form->field(name => "do", value => "create", force => 1);
413 $form->tmpl_param("page_select", 0);
414 $form->field(name => "page", type => 'hidden');
415 $form->field(name => "type", type => 'hidden');
416 $form->title(sprintf(gettext("editing %s"), $page));
417 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
420 elsif ($form->field("do") eq "create" && $exists) {
421 $form->tmpl_param("message", template("editcreationconflict.tmpl")->output);
422 $form->field(name => "do", value => "edit", force => 1);
423 $form->tmpl_param("page_select", 0);
424 $form->field(name => "page", type => 'hidden');
425 $form->field(name => "type", type => 'hidden');
426 $form->title(sprintf(gettext("editing %s"), $page));
427 $form->field("editcontent",
428 value => readfile("$config{srcdir}/$file").
429 "\n\n\n".$form->field("editcontent"),
431 showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
436 if (defined $form->field('comments') &&
437 length $form->field('comments')) {
438 $message=$form->field('comments');
441 my $content=$form->field('editcontent');
442 check_cansave($page, $content, $q, $session);
443 check_content(content => $content, page => $page,
444 cgi => $q, session => $session,
445 subject => $message);
446 run_hooks(editcontent => sub {
454 $content=~s/\r\n/\n/g;
456 $content.="\n" if $content !~ /\n$/;
458 $config{cgi}=0; # avoid cgi error message
459 eval { writefile($file, $config{srcdir}, $content) };
462 $form->field(name => "rcsinfo", value => rcs_prepedit($file),
464 my $mtemplate=template("editfailedsave.tmpl");
465 $mtemplate->param(error_message => $@);
466 $form->tmpl_param("message", $mtemplate->output);
467 $form->field("editcontent", value => $content, force => 1);
468 $form->tmpl_param("page_select", 0);
469 $form->field(name => "page", type => 'hidden');
470 $form->field(name => "type", type => 'hidden');
471 $form->title(sprintf(gettext("editing %s"), $page));
472 showform($form, \@buttons, $session, $q,
473 forcebaseurl => $baseurl);
483 # Prevent deadlock with post-commit hook by
484 # signaling to it that it should not try to
486 disable_commit_hook();
487 $conflict=rcs_commit($file, $message,
488 $form->field("rcsinfo"),
489 $session->param("name"), $ENV{REMOTE_ADDR});
490 enable_commit_hook();
494 # Refresh even if there was a conflict, since other changes
495 # may have been committed while the post-commit hook was
497 require IkiWiki::Render;
501 if (defined $conflict) {
502 $form->field(name => "rcsinfo", value => rcs_prepedit($file),
504 $form->tmpl_param("message", template("editconflict.tmpl")->output);
505 $form->field("editcontent", value => $conflict, force => 1);
506 $form->field("do", "edit", force => 1);
507 $form->tmpl_param("page_select", 0);
508 $form->field(name => "page", type => 'hidden');
509 $form->field(name => "type", type => 'hidden');
510 $form->title(sprintf(gettext("editing %s"), $page));
511 showform($form, \@buttons, $session, $q,
512 forcebaseurl => $baseurl);
515 # The trailing question mark tries to avoid broken
516 # caches and get the most recent version of the page.
517 redirect($q, urlto($page, undef, 1)."?updated");