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);
25 if (exists $wikistate{editpage} && exists $wikistate{editpage}{previews}) {
26 # Expire old preview files after one hour.
27 my $expire=time - (60 * 60);
30 foreach my $file (@{$wikistate{editpage}{previews}}) {
31 my $mtime=(stat("$config{destdir}/$file"))[9];
32 if (defined $mtime && $mtime <= $expire) {
33 # Avoid deleting a preview that was later saved.
35 foreach my $page (keys %renderedfiles) {
36 if (grep { $_ eq $file } @{$renderedfiles{$page}}) {
41 debug(sprintf(gettext("removing old preview %s"), $file));
42 IkiWiki::prune("$config{destdir}/$file");
45 elsif (defined $mtime) {
46 push @previews, $file;
49 $wikistate{editpage}{previews}=\@previews;
53 # Back to ikiwiki namespace for the rest, this code is very much
54 # internal to ikiwiki even though it's separated into a plugin,
55 # and other plugins use the function below.
58 sub cgi_editpage ($$) {
62 my $do=$q->param('do');
63 return unless $do eq 'create' || $do eq 'edit';
67 my @fields=qw(do rcsinfo subpage from page type editcontent editmessage);
68 my @buttons=("Save Page", "Preview", "Cancel");
69 eval q{use CGI::FormBuilder};
71 my $form = CGI::FormBuilder->new(
75 required => [qw{editcontent}],
78 action => IkiWiki::cgiurl(),
81 template => { template("editpage.tmpl") },
84 decode_form_utf8($form);
85 run_hooks(formbuilder_setup => sub {
86 shift->(form => $form, cgi => $q, session => $session,
87 buttons => \@buttons);
89 decode_form_utf8($form);
91 # This untaint is safe because we check file_pruned and
93 my ($page)=$form->field('page')=~/$config{wiki_file_regexp}/;
94 if (! defined $page) {
95 error(gettext("bad page name"));
97 $page=possibly_foolish_untaint($page);
98 my $absolute=($page =~ s#^/+##); # absolute name used to force location
99 if (! defined $page || ! length $page ||
100 file_pruned($page)) {
101 error(gettext("bad page name"));
104 my $baseurl = urlto($page);
107 if (defined $form->field('from')) {
108 ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
113 if (exists $pagesources{$page} && $form->field("do") ne "create") {
114 $file=$pagesources{$page};
115 $type=pagetype($file);
116 if (! defined $type || $type=~/^_/) {
117 error(sprintf(gettext("%s is not an editable page"), $page));
119 if (! $form->submitted) {
120 $form->field(name => "rcsinfo",
121 value => rcs_prepedit($file), force => 1);
123 $form->field(name => "editcontent", validate => '/.*/');
126 $type=$form->param('type');
127 if (defined $type && length $type && $hooks{htmlize}{$type}) {
128 $type=possibly_foolish_untaint($type);
130 elsif (defined $from && exists $pagesources{$from}) {
131 # favor the type of linking page
132 $type=pagetype($pagesources{$from});
134 $type=$config{default_pageext} unless defined $type;
135 $file=newpagefile($page, $type);
136 if (! $form->submitted) {
137 $form->field(name => "rcsinfo", value => "", force => 1);
139 $form->field(name => "editcontent", validate => '/.+/');
142 $form->field(name => "do", type => 'hidden');
143 $form->field(name => "sid", type => "hidden", value => $session->id,
145 $form->field(name => "from", type => 'hidden');
146 $form->field(name => "rcsinfo", type => 'hidden');
147 $form->field(name => "subpage", type => 'hidden');
148 $form->field(name => "page", value => $page, force => 1);
149 $form->field(name => "type", value => $type, force => 1);
150 $form->field(name => "editmessage", type => "text", size => 80);
151 $form->field(name => "editcontent", type => "textarea", rows => 20,
153 $form->tmpl_param("can_commit", $config{rcs});
154 $form->tmpl_param("helponformattinglink",
155 htmllink($page, $page, "ikiwiki/formatting",
157 linktext => "FormattingHelp"));
160 if ($form->submitted eq "Cancel") {
161 if ($form->field("do") eq "create" && defined $from) {
162 redirect($q, urlto($from));
164 elsif ($form->field("do") eq "create") {
165 redirect($q, baseurl(undef));
168 redirect($q, $baseurl);
172 elsif ($form->submitted eq "Preview") {
175 my $new=not exists $pagesources{$page};
176 # temporarily record its type
177 $pagesources{$page}=$page.".".$type if $new;
178 my %wasrendered=map { $_ => 1 } @{$renderedfiles{$page}};
180 my $content=$form->field('editcontent');
182 run_hooks(editcontent => sub {
190 my $preview=htmlize($page, $page, $type,
191 linkify($page, $page,
192 preprocess($page, $page,
193 filter($page, $page, $content), 0, 1)));
194 run_hooks(format => sub {
200 $form->tmpl_param("page_preview", $preview);
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};
209 # Throw out any other state changes made during previewing,
210 # and save the previews list.
212 @{$wikistate{editpage}{previews}} = keys %previews;
215 elsif ($form->submitted eq "Save Page") {
216 $form->tmpl_param("page_preview", "");
219 if ($form->submitted ne "Save Page" || ! $form->validate) {
220 if ($form->field("do") eq "create") {
223 if (! defined $from || ! length $from ||
224 $from ne $form->field('from') ||
225 file_pruned($from) ||
228 @page_locs=$best_loc=$page;
234 if ((defined $form->field('subpage') &&
235 length $form->field('subpage')) ||
236 $page eq lc($config{discussionpage})) {
237 $best_loc="$from/$page";
240 $best_loc=$dir.$page;
243 push @page_locs, $dir.$page;
244 push @page_locs, "$from/$page";
245 while (length $dir) {
247 push @page_locs, $dir.$page;
250 my $userpage=IkiWiki::userpage($page);
251 push @page_locs, $userpage
252 if ! grep { $_ eq $userpage } @page_locs;
256 ! exists $pagecase{lc $_}
259 # hmm, someone else made the page in the
262 # let them go ahead with the edit
263 # and resolve the conflict at save
268 redirect($q, $baseurl);
273 my @editable_locs = grep {
274 check_canedit($_, $q, $session, 1)
276 if (! @editable_locs) {
277 # now let it throw an error, or prompt for
279 map { check_canedit($_, $q, $session) }
280 ($best_loc, @page_locs);
284 if (exists $hooks{htmlize}) {
285 foreach my $key (grep { !/^_/ } keys %{$hooks{htmlize}}) {
286 push @page_types, [$key, $hooks{htmlize}{$key}{longname} || $key];
289 @page_types=sort @page_types;
291 $form->tmpl_param("page_select", 1);
292 $form->field(name => "page", type => 'select',
293 options => [ map { [ $_, pagetitle($_, 1) ] } @editable_locs ],
295 $form->field(name => "type", type => 'select',
296 options => \@page_types);
297 $form->title(sprintf(gettext("creating %s"), pagetitle(basename($page))));
300 elsif ($form->field("do") eq "edit") {
301 check_canedit($page, $q, $session);
302 if (! defined $form->field('editcontent') ||
303 ! length $form->field('editcontent')) {
305 if (exists $pagesources{$page}) {
306 $content=readfile(srcfile($pagesources{$page}));
307 $content=~s/\n/\r\n/g;
309 $form->field(name => "editcontent", value => $content,
312 $form->tmpl_param("page_select", 0);
313 $form->field(name => "page", type => 'hidden');
314 $form->field(name => "type", type => 'hidden');
315 $form->title(sprintf(gettext("editing %s"), pagetitle(basename($page))));
318 showform($form, \@buttons, $session, $q, page => $page);
322 check_canedit($page, $q, $session);
323 checksessionexpiry($q, $session, $q->param('sid'));
325 my $exists=-e "$config{srcdir}/$file";
327 if ($form->field("do") ne "create" && ! $exists &&
328 ! defined srcfile($file, 1)) {
329 $form->tmpl_param("message", template("editpagegone.tmpl")->output);
330 $form->field(name => "do", value => "create", force => 1);
331 $form->tmpl_param("page_select", 0);
332 $form->field(name => "page", type => 'hidden');
333 $form->field(name => "type", type => 'hidden');
334 $form->title(sprintf(gettext("editing %s"), $page));
335 showform($form, \@buttons, $session, $q,
339 elsif ($form->field("do") eq "create" && $exists) {
340 $form->tmpl_param("message", template("editcreationconflict.tmpl")->output);
341 $form->field(name => "do", value => "edit", force => 1);
342 $form->tmpl_param("page_select", 0);
343 $form->field(name => "page", type => 'hidden');
344 $form->field(name => "type", type => 'hidden');
345 $form->title(sprintf(gettext("editing %s"), $page));
346 $form->field("editcontent",
347 value => readfile("$config{srcdir}/$file").
348 "\n\n\n".$form->field("editcontent"),
350 showform($form, \@buttons, $session, $q,
356 if (defined $form->field('editmessage') &&
357 length $form->field('editmessage')) {
358 $message=$form->field('editmessage');
361 my $content=$form->field('editcontent');
362 check_content(content => $content, page => $page,
363 cgi => $q, session => $session,
364 subject => $message);
365 run_hooks(editcontent => sub {
373 $content=~s/\r\n/\n/g;
375 $content.="\n" if $content !~ /\n$/;
377 $config{cgi}=0; # avoid cgi error message
378 eval { writefile($file, $config{srcdir}, $content) };
381 $form->field(name => "rcsinfo", value => rcs_prepedit($file),
383 my $mtemplate=template("editfailedsave.tmpl");
384 $mtemplate->param(error_message => $@);
385 $form->tmpl_param("message", $mtemplate->output);
386 $form->field("editcontent", value => $content, force => 1);
387 $form->tmpl_param("page_select", 0);
388 $form->field(name => "page", type => 'hidden');
389 $form->field(name => "type", type => 'hidden');
390 $form->title(sprintf(gettext("editing %s"), $page));
391 showform($form, \@buttons, $session, $q,
402 # Prevent deadlock with post-commit hook by
403 # signaling to it that it should not try to
405 disable_commit_hook();
406 $conflict=rcs_commit(
409 token => $form->field("rcsinfo"),
412 enable_commit_hook();
416 # Refresh even if there was a conflict, since other changes
417 # may have been committed while the post-commit hook was
419 require IkiWiki::Render;
423 if (defined $conflict) {
424 $form->field(name => "rcsinfo", value => rcs_prepedit($file),
426 $form->tmpl_param("message", template("editconflict.tmpl")->output);
427 $form->field("editcontent", value => $conflict, force => 1);
428 $form->field("do", "edit", force => 1);
429 $form->tmpl_param("page_select", 0);
430 $form->field(name => "page", type => 'hidden');
431 $form->field(name => "type", type => 'hidden');
432 $form->title(sprintf(gettext("editing %s"), $page));
433 showform($form, \@buttons, $session, $q,
437 # The trailing question mark tries to avoid broken
438 # caches and get the most recent version of the page.
439 redirect($q, $baseurl."?updated");