ikiwiki/IkiWiki/Plugin/editpage.pm

478 lines
13 KiB
Perl

#!/usr/bin/perl
package IkiWiki::Plugin::editpage;
use warnings;
use strict;
use IkiWiki;
use open qw{:utf8 :std};
sub import {
hook(type => "getsetup", id => "editpage", call => \&getsetup);
hook(type => "refresh", id => "editpage", call => \&refresh);
hook(type => "sessioncgi", id => "editpage", call => \&IkiWiki::cgi_editpage);
}
sub getsetup () {
return
plugin => {
safe => 1,
rebuild => 1,
section => "core",
},
}
sub refresh () {
if (exists $wikistate{editpage} && exists $wikistate{editpage}{previews}) {
# Expire old preview files after one hour.
my $expire=time - (60 * 60);
my @previews;
foreach my $file (@{$wikistate{editpage}{previews}}) {
my $mtime=(stat("$config{destdir}/$file"))[9];
if (defined $mtime && $mtime <= $expire) {
# Avoid deleting a preview that was later saved.
my $delete=1;
foreach my $page (keys %renderedfiles) {
if (grep { $_ eq $file } @{$renderedfiles{$page}}) {
$delete=0;
}
}
if ($delete) {
debug(sprintf(gettext("removing old preview %s"), $file));
IkiWiki::prune("$config{destdir}/$file", $config{destdir});
}
}
elsif (defined $mtime) {
push @previews, $file;
}
}
$wikistate{editpage}{previews}=\@previews;
}
}
# Back to ikiwiki namespace for the rest, this code is very much
# internal to ikiwiki even though it's separated into a plugin,
# and other plugins use the function below.
package IkiWiki;
sub cgi_editpage ($$) {
my $q=shift;
my $session=shift;
my $do=$q->param('do');
return unless $do eq 'create' || $do eq 'edit';
decode_cgi_utf8($q);
my @fields=qw(do rcsinfo subpage from page type editcontent
editmessage subscribe);
my @buttons=("Save Page", "Preview", "Cancel");
eval q{use CGI::FormBuilder};
error($@) if $@;
my $form = CGI::FormBuilder->new(
fields => \@fields,
charset => "utf-8",
method => 'POST',
required => [qw{editcontent}],
javascript => 0,
params => $q,
action => IkiWiki::cgiurl(),
header => 0,
table => 0,
template => { template("editpage.tmpl") },
);
decode_form_utf8($form);
run_hooks(formbuilder_setup => sub {
shift->(form => $form, cgi => $q, session => $session,
buttons => \@buttons);
});
decode_form_utf8($form);
# This untaint is safe because we check file_pruned and
# wiki_file_regexp.
my ($page)=$form->field('page')=~/$config{wiki_file_regexp}/;
if (! defined $page) {
error(gettext("bad page name"));
}
$page=possibly_foolish_untaint($page);
my $absolute=($page =~ s#^/+##); # absolute name used to force location
if (! defined $page || ! length $page ||
file_pruned($page)) {
error(gettext("bad page name"));
}
my $baseurl = urlto($page);
my $from;
if (defined $form->field('from')) {
($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
}
my $file;
my $type;
if (exists $pagesources{$page} && $form->field("do") ne "create") {
$file=$pagesources{$page};
$type=pagetype($file);
if (! defined $type || $type=~/^_/) {
error(sprintf(gettext("%s is not an editable page"), $page));
}
if (! $form->submitted) {
$form->field(name => "rcsinfo",
value => rcs_prepedit($file), force => 1);
}
$form->field(name => "editcontent", validate => '/.*/');
}
else {
$type=$form->param('type');
if (defined $type && length $type && $hooks{htmlize}{$type}) {
$type=possibly_foolish_untaint($type);
}
elsif (defined $from && exists $pagesources{$from}) {
# favor the type of linking page
$type=pagetype($pagesources{$from});
}
$type=$config{default_pageext}
if ! defined $type || $type=~/^_/; # not internal type
$file=newpagefile($page, $type);
if (! $form->submitted) {
$form->field(name => "rcsinfo", value => "", force => 1);
}
$form->field(name => "editcontent", validate => '/.+/');
}
$form->field(name => "do", type => 'hidden');
$form->field(name => "sid", type => "hidden", value => $session->id,
force => 1);
$form->field(name => "from", type => 'hidden');
$form->field(name => "rcsinfo", type => 'hidden');
$form->field(name => "subpage", type => 'hidden');
$form->field(name => "page", value => $page, force => 1);
$form->field(name => "type", value => $type, force => 1);
$form->field(name => "editmessage", type => "text", size => 80);
$form->field(name => "editcontent", type => "textarea", rows => 20,
cols => 80);
$form->tmpl_param("can_commit", $config{rcs});
$form->tmpl_param("helponformattinglink",
htmllink($page, $page, "ikiwiki/formatting",
noimageinline => 1,
linktext => "FormattingHelp"));
my $cansubscribe=IkiWiki::Plugin::notifyemail->can("subscribe")
&& IkiWiki::Plugin::comments->can("import")
&& defined $session->param('name');
if ($cansubscribe) {
$form->field(name => "subscribe", type => "checkbox",
options => [gettext("email comments to me")]);
}
else {
$form->field(name => "subscribe", type => 'hidden');
}
my $previewing=0;
if ($form->submitted eq "Cancel") {
if ($form->field("do") eq "create" && defined $from) {
redirect($q, urlto($from));
}
elsif ($form->field("do") eq "create") {
redirect($q, baseurl(undef));
}
else {
redirect($q, $baseurl);
}
exit;
}
elsif ($form->submitted eq "Preview") {
$previewing=1;
my $new=not exists $pagesources{$page};
# temporarily record its type
$pagesources{$page}=$page.".".$type if $new;
my %wasrendered=map { $_ => 1 } @{$renderedfiles{$page}};
my $content=$form->field('editcontent');
run_hooks(editcontent => sub {
$content=shift->(
content => $content,
page => $page,
cgi => $q,
session => $session,
);
});
my $preview=htmlize($page, $page, $type,
linkify($page, $page,
preprocess($page, $page,
filter($page, $page, $content), 0, 1)));
run_hooks(format => sub {
$preview=shift->(
page => $page,
content => $preview,
);
});
$form->tmpl_param("page_preview", $preview);
# Previewing may have created files on disk.
# Keep a list of these to be deleted later.
my %previews = map { $_ => 1 } @{$wikistate{editpage}{previews}};
foreach my $f (@{$renderedfiles{$page}}) {
$previews{$f}=1 unless $wasrendered{$f};
}
# Throw out any other state changes made during previewing,
# and save the previews list.
loadindex();
@{$wikistate{editpage}{previews}} = keys %previews;
saveindex();
}
elsif ($form->submitted eq "Save Page") {
$form->tmpl_param("page_preview", "");
}
if ($form->submitted ne "Save Page" || ! $form->validate) {
if ($form->field("do") eq "create") {
my @page_locs;
my $best_loc;
if (! defined $from || ! length $from ||
$from ne $form->field('from') ||
file_pruned($from) ||
$absolute ||
$form->submitted) {
@page_locs=$best_loc=$page;
unshift @page_locs, lc($page)
if ! $form->submitted && lc($page) ne $page;
}
elsif (lc $page eq lc $config{discussionpage}) {
@page_locs=$best_loc="$from/".lc($page);
}
else {
my $dir=$from."/";
$dir=~s![^/]+/+$!!;
if ((defined $form->field('subpage') &&
length $form->field('subpage'))) {
$best_loc="$from/$page";
}
else {
$best_loc=$dir.$page;
}
my $mixedcase=lc($page) ne $page;
push @page_locs, $dir.lc($page) if $mixedcase;
push @page_locs, $dir.$page;
push @page_locs, $from."/".lc($page) if $mixedcase;
push @page_locs, $from."/".$page;
while (length $dir) {
$dir=~s![^/]+/+$!!;
push @page_locs, $dir.lc($page) if $mixedcase;
push @page_locs, $dir.$page;
}
my $userpage=IkiWiki::userpage($page);
push @page_locs, $userpage
if ! grep { $_ eq $userpage } @page_locs;
}
@page_locs = grep {
! exists $pagecase{lc $_}
} @page_locs;
if (! @page_locs) {
# hmm, someone else made the page in the
# meantime?
if ($previewing) {
# let them go ahead with the edit
# and resolve the conflict at save
# time
@page_locs=$page;
}
else {
redirect($q, $baseurl);
exit;
}
}
my @editable_locs = grep {
check_canedit($_, $q, $session, 1)
} @page_locs;
if (! @editable_locs) {
# now let it throw an error, or prompt for
# login
map { check_canedit($_, $q, $session) }
($best_loc, @page_locs);
}
my @page_types;
if (exists $hooks{htmlize}) {
foreach my $key (grep { !/^_/ } keys %{$hooks{htmlize}}) {
push @page_types, [$key, $hooks{htmlize}{$key}{longname} || $key]
unless $hooks{htmlize}{$key}{nocreate};
}
}
@page_types=sort @page_types;
$form->tmpl_param("page_select", 1);
$form->field(name => "page", type => 'select',
options => [ map { [ $_, pagetitle($_, 1) ] } @editable_locs ],
value => $best_loc);
$form->field(name => "type", type => 'select',
options => \@page_types);
$form->title(sprintf(gettext("creating %s"), pagetitle(basename($page))));
}
elsif ($form->field("do") eq "edit") {
check_canedit($page, $q, $session);
if (! defined $form->field('editcontent') ||
! length $form->field('editcontent')) {
my $content="";
if (exists $pagesources{$page}) {
$content=readfile(srcfile($pagesources{$page}));
$content=~s/\n/\r\n/g;
}
$form->field(name => "editcontent", value => $content,
force => 1);
}
$form->tmpl_param("page_select", 0);
$form->field(name => "page", type => 'hidden');
$form->field(name => "type", type => 'hidden');
$form->title(sprintf(gettext("editing %s"), pagetitle(basename($page))));
}
showform($form, \@buttons, $session, $q, page => $page);
}
else {
# save page
check_canedit($page, $q, $session);
checksessionexpiry($q, $session);
my $exists=-e "$config{srcdir}/$file";
if ($form->field("do") ne "create" && ! $exists &&
! defined srcfile($file, 1)) {
$form->tmpl_param("message", template("editpagegone.tmpl")->output);
$form->field(name => "do", value => "create", force => 1);
$form->tmpl_param("page_select", 0);
$form->field(name => "page", type => 'hidden');
$form->field(name => "type", type => 'hidden');
$form->title(sprintf(gettext("editing %s"), $page));
showform($form, \@buttons, $session, $q,
page => $page);
exit;
}
elsif ($form->field("do") eq "create" && $exists) {
$form->tmpl_param("message", template("editcreationconflict.tmpl")->output);
$form->field(name => "do", value => "edit", force => 1);
$form->tmpl_param("page_select", 0);
$form->field(name => "page", type => 'hidden');
$form->field(name => "type", type => 'hidden');
$form->title(sprintf(gettext("editing %s"), $page));
$form->field("editcontent",
value => readfile("$config{srcdir}/$file").
"\n\n\n".$form->field("editcontent"),
force => 1);
showform($form, \@buttons, $session, $q,
page => $page);
exit;
}
my $message="";
if (defined $form->field('editmessage') &&
length $form->field('editmessage')) {
$message=$form->field('editmessage');
}
my $content=$form->field('editcontent');
check_content(content => $content, page => $page,
cgi => $q, session => $session,
subject => $message);
run_hooks(editcontent => sub {
$content=shift->(
content => $content,
page => $page,
cgi => $q,
session => $session,
);
});
$content=~s/\r\n/\n/g;
$content=~s/\r/\n/g;
$content.="\n" if $content !~ /\n$/;
$config{cgi}=0; # avoid cgi error message
eval { writefile($file, $config{srcdir}, $content) };
$config{cgi}=1;
if ($@) {
# save $@ in case a called function clobbers it
my $error = $@;
$form->field(name => "rcsinfo", value => rcs_prepedit($file),
force => 1);
my $mtemplate=template("editfailedsave.tmpl");
$mtemplate->param(error_message => $error);
$form->tmpl_param("message", $mtemplate->output);
$form->field("editcontent", value => $content, force => 1);
$form->tmpl_param("page_select", 0);
$form->field(name => "page", type => 'hidden');
$form->field(name => "type", type => 'hidden');
$form->title(sprintf(gettext("editing %s"), $page));
showform($form, \@buttons, $session, $q,
page => $page);
exit;
}
my $conflict;
if ($config{rcs}) {
if (! $exists) {
rcs_add($file);
}
# Prevent deadlock with post-commit hook by
# signaling to it that it should not try to
# do anything.
disable_commit_hook();
$conflict=rcs_commit(
file => $file,
message => $message,
token => scalar $form->field("rcsinfo"),
session => $session,
);
enable_commit_hook();
rcs_update();
}
# Refresh even if there was a conflict, since other changes
# may have been committed while the post-commit hook was
# disabled.
require IkiWiki::Render;
refresh();
saveindex();
if (defined $conflict) {
$form->field(name => "rcsinfo", value => rcs_prepedit($file),
force => 1);
$form->tmpl_param("message", template("editconflict.tmpl")->output);
$form->field("editcontent", value => $conflict, force => 1);
$form->field("do", "edit", force => 1);
$form->tmpl_param("page_select", 0);
$form->field(name => "page", type => 'hidden');
$form->field(name => "type", type => 'hidden');
$form->title(sprintf(gettext("editing %s"), $page));
showform($form, \@buttons, $session, $q,
page => $page);
}
else {
# The trailing question mark tries to avoid broken
# caches and get the most recent version of the page.
redirect($q, $baseurl."?updated");
}
if ($cansubscribe && length $form->field("subscribe")) {
my $subspec="comment($page)";
IkiWiki::Plugin::notifyemail::subscribe(
$session->param('name'), $subspec);
}
}
exit;
}
1