X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/4745391360cf0843e376676479fee306d0a8312d..05bb65fc687b357a5265f0c378a694b5b02d376d:/IkiWiki/CGI.pm?ds=inline diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm index 567fa85be..81cb42d13 100644 --- a/IkiWiki/CGI.pm +++ b/IkiWiki/CGI.pm @@ -1,5 +1,7 @@ #!/usr/bin/perl +package IkiWiki; + use warnings; use strict; use IkiWiki; @@ -7,21 +9,19 @@ use IkiWiki::UserInfo; use open qw{:utf8 :std}; use Encode; -package IkiWiki; - -sub printheader ($) { #{{{ +sub printheader ($) { my $session=shift; if ($config{sslcookie}) { print $session->header(-charset => 'utf-8', - -cookie => $session->cookie(-secure => 1)); + -cookie => $session->cookie(-httponly => 1, -secure => 1)); } else { - print $session->header(-charset => 'utf-8'); + print $session->header(-charset => 'utf-8', + -cookie => $session->cookie(-httponly => 1)); } +} -} #}}} - -sub showform ($$$$) { #{{{ +sub showform ($$$$;@) { my $form=shift; my $buttons=shift; my $session=shift; @@ -35,10 +35,10 @@ sub showform ($$$$) { #{{{ } printheader($session); - print misctemplate($form->title, $form->render(submit => $buttons)); + print misctemplate($form->title, $form->render(submit => $buttons), @_); } -sub redirect ($$) { #{{{ +sub redirect ($$) { my $q=shift; my $url=shift; if (! $config{w3mmode}) { @@ -48,108 +48,50 @@ sub redirect ($$) { #{{{ print "Content-type: text/plain\n"; print "W3m-control: GOTO $url\n\n"; } -} #}}} +} -sub check_canedit ($$$;$) { #{{{ - my $page=shift; - my $q=shift; - my $session=shift; - my $nonfatal=shift; - - my $canedit; - run_hooks(canedit => sub { - return if defined $canedit; - my $ret=shift->($page, $q, $session); - if (defined $ret && $ret eq "") { - $canedit=1; - } - elsif (defined $ret) { - $canedit=0; - error($ret) unless $nonfatal; +sub decode_cgi_utf8 ($) { + # decode_form_utf8 method is needed for 5.10 + if ($] < 5.01) { + my $cgi = shift; + foreach my $f ($cgi->param) { + $cgi->param($f, map { decode_utf8 $_ } $cgi->param($f)); } - }); - return $canedit; -} #}}} - -sub decode_form_utf8 ($) { #{{{ - my $form = shift; - foreach my $f ($form->field) { - next if Encode::is_utf8(scalar $form->field($f)); - $form->field(name => $f, - value => decode_utf8($form->field($f)), - force => 1, - ); } -} #}}} - -sub cgi_recentchanges ($) { #{{{ - my $q=shift; - - # Optimisation: building recentchanges means calculating lots of - # links. Memoizing htmllink speeds it up a lot (can't be memoized - # during page builds as the return values may change, but they - # won't here.) - eval q{use Memoize}; - error($@) if $@; - memoize("htmllink"); - - eval q{use Time::Duration}; - error($@) if $@; +} - my $changelog=[rcs_recentchanges(100)]; - foreach my $change (@$changelog) { - $change->{when} = concise(ago($change->{when})); - - $change->{user} = userlink($change->{user}); - - my $is_excess = exists $change->{pages}[10]; # limit pages to first 10 - delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess; - $change->{pages} = [ - map { - $_->{link} = htmllink("", "", $_->{page}, - noimageinline => 1, - linktext => pagetitle($_->{page})); - $_; - } @{$change->{pages}} - ]; - push @{$change->{pages}}, { link => '...' } if $is_excess; +sub decode_form_utf8 ($) { + if ($] >= 5.01) { + my $form = shift; + foreach my $f ($form->field) { + $form->field(name => $f, + value => decode_utf8($form->field($f)), + force => 1, + ); + } } - - my $template=template("recentchanges.tmpl"); - $template->param( - title => "RecentChanges", - indexlink => indexlink(), - wikiname => $config{wikiname}, - changelog => $changelog, - baseurl => baseurl(), - ); - run_hooks(pagetemplate => sub { - shift->(page => "", destpage => "", template => $template); - }); - print $q->header(-charset => 'utf-8'), $template->output; -} #}}} +} # Check if the user is signed in. If not, redirect to the signin form and # save their place to return to later. -sub needsignin ($$) { #{{{ +sub needsignin ($$) { my $q=shift; my $session=shift; if (! defined $session->param("name") || ! userinfo_get($session->param("name"), "regdate")) { - if (! defined $session->param("postsignin")) { - $session->param(postsignin => $ENV{QUERY_STRING}); - } + $session->param(postsignin => $ENV{QUERY_STRING}); cgi_signin($q, $session); cgi_savesession($session); exit; } -} #}}} +} -sub cgi_signin ($$) { #{{{ +sub cgi_signin ($$) { my $q=shift; my $session=shift; + decode_cgi_utf8($q); eval q{use CGI::FormBuilder}; error($@) if $@; my $form = CGI::FormBuilder->new( @@ -174,20 +116,20 @@ sub cgi_signin ($$) { #{{{ force => 1); decode_form_utf8($form); - run_hooks(formbuilder_setup => sub { shift->(form => $form, cgi => $q, session => $session, buttons => $buttons); }); + decode_form_utf8($form); if ($form->submitted) { $form->validate; } showform($form, $buttons, $session, $q); -} #}}} +} -sub cgi_postsignin ($$) { #{{{ +sub cgi_postsignin ($$) { my $q=shift; my $session=shift; @@ -200,17 +142,26 @@ sub cgi_postsignin ($$) { #{{{ exit; } else { - # This can occur, for example, if a user went to the signin - # url via a bookmark. - redirect($q, $config{url}); + error(gettext("login failed, perhaps you need to turn on cookies?")); } -} #}}} +} -sub cgi_prefs ($$) { #{{{ +sub cgi_prefs ($$) { my $q=shift; my $session=shift; needsignin($q, $session); + decode_cgi_utf8($q); + + # The session id is stored on the form and checked to + # guard against CSRF. + my $sid=$q->param('sid'); + if (! defined $sid) { + $q->delete_all; + } + elsif ($sid ne $session->id) { + error(gettext("Your login session has expired.")); + } eval q{use CGI::FormBuilder}; error($@) if $@; @@ -236,35 +187,40 @@ sub cgi_prefs ($$) { #{{{ ], ); my $buttons=["Save Preferences", "Logout", "Cancel"]; - + decode_form_utf8($form); - run_hooks(formbuilder_setup => sub { shift->(form => $form, cgi => $q, session => $session, buttons => $buttons); }); + decode_form_utf8($form); - $form->field(name => "do", type => "hidden"); + $form->field(name => "do", type => "hidden", value => "prefs", + force => 1); + $form->field(name => "sid", type => "hidden", value => $session->id, + force => 1); $form->field(name => "email", size => 50, fieldset => "preferences"); - $form->field(name => "subscriptions", size => 50, - fieldset => "preferences", - comment => "(".htmllink("", "", "ikiwiki/PageSpec", noimageinline => 1).")"); - $form->field(name => "banned_users", size => 50, - fieldset => "admin"); my $user_name=$session->param("name"); + + # XXX deprecated, should be removed eventually + $form->field(name => "banned_users", size => 50, fieldset => "admin"); if (! is_admin($user_name)) { $form->field(name => "banned_users", type => "hidden"); } - if (! $form->submitted) { $form->field(name => "email", force => 1, value => userinfo_get($user_name, "email")); - $form->field(name => "subscriptions", force => 1, - value => userinfo_get($user_name, "subscriptions")); if (is_admin($user_name)) { - $form->field(name => "banned_users", force => 1, - value => join(" ", get_banned_users())); + my $value=join(" ", get_banned_users()); + if (length $value) { + $form->field(name => "banned_users", force => 1, + value => join(" ", get_banned_users()), + comment => "deprecated; please move to banned_users in setup file"); + } + else { + $form->field(name => "banned_users", type => "hidden"); + } } } @@ -278,385 +234,105 @@ sub cgi_prefs ($$) { #{{{ return; } elsif ($form->submitted eq 'Save Preferences' && $form->validate) { - foreach my $field (qw(email subscriptions)) { - if (defined $form->field($field) && length $form->field($field)) { - userinfo_set($user_name, $field, $form->field($field)) || - error("failed to set $field"); - } + if (defined $form->field('email')) { + userinfo_set($user_name, 'email', $form->field('email')) || + error("failed to set email"); } + + # XXX deprecated, should be removed eventually if (is_admin($user_name)) { set_banned_users(grep { ! is_admin($_) } split(' ', $form->field("banned_users"))) || error("failed saving changes"); + if (! length $form->field("banned_users")) { + $form->field(name => "banned_users", type => "hidden"); + } } + $form->text(gettext("Preferences saved.")); } showform($form, $buttons, $session, $q); -} #}}} +} -sub cgi_editpage ($$) { #{{{ +sub check_banned ($$) { my $q=shift; my $session=shift; - my @fields=qw(do rcsinfo subpage from page type editcontent comments); - my @buttons=("Save Page", "Preview", "Cancel"); - - eval q{use CGI::FormBuilder}; - error($@) if $@; - my $form = CGI::FormBuilder->new( - title => "editpage", - fields => \@fields, - charset => "utf-8", - method => 'POST', - validate => { - editcontent => '/.+/', - }, - required => [qw{editcontent}], - javascript => 0, - params => $q, - action => $config{cgiurl}, - header => 0, - table => 0, - template => scalar template_params("editpage.tmpl"), - wikiname => $config{wikiname}, - ); - - decode_form_utf8($form); - - run_hooks(formbuilder_setup => sub { - shift->(form => $form, cgi => $q, session => $session, - buttons => \@buttons); - }); - - # This untaint is safe because titlepage removes any problematic - # characters. - my ($page)=$form->field('page'); - $page=titlepage(possibly_foolish_untaint($page)); - if (! defined $page || ! length $page || - file_pruned($page, $config{srcdir}) || $page=~/^\//) { - error("bad page name"); - } - - 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) { - error(sprintf(gettext("%s is not an editable page"), $page)); - } - if (! $form->submitted) { - $form->field(name => "rcsinfo", - value => rcs_prepedit($file), force => 1); + my $name=$session->param("name"); + if (defined $name) { + # XXX banned in userinfo is deprecated, should be removed + # eventually, and only banned_users be checked. + if (userinfo_get($session->param("name"), "banned") || + grep { $name eq $_ } @{$config{banned_users}}) { + print $q->header(-status => "403 Forbidden"); + $session->delete(); + print gettext("You are banned."); + cgi_savesession($session); + exit; } } - else { - $type=$form->param('type'); - if (defined $type && length $type && $hooks{htmlize}{$type}) { - $type=possibly_foolish_untaint($type); - } - elsif (defined $from) { - # favor the type of linking page - $type=pagetype($pagesources{$from}); - } - $type=$config{default_pageext} unless defined $type; - $file=$page.".".$type; - if (! $form->submitted) { - $form->field(name => "rcsinfo", value => "", force => 1); - } - } - - $form->field(name => "do", type => 'hidden'); - $form->field(name => "from", type => 'hidden'); - $form->field(name => "rcsinfo", type => 'hidden'); - $form->field(name => "subpage", type => 'hidden'); - $form->field(name => "page", value => pagetitle($page, 1), force => 1); - $form->field(name => "type", value => $type, force => 1); - $form->field(name => "comments", type => "text", size => 80); - $form->field(name => "editcontent", type => "textarea", rows => 20, - cols => 80); - $form->tmpl_param("can_commit", $config{rcs}); - $form->tmpl_param("indexlink", indexlink()); - $form->tmpl_param("helponformattinglink", - htmllink("", "", "ikiwiki/formatting", - noimageinline => 1, - linktext => "FormattingHelp")); - $form->tmpl_param("baseurl", baseurl()); - - if ($form->submitted eq "Cancel") { - if ($form->field("do") eq "create" && defined $from) { - redirect($q, "$config{url}/".htmlpage($from)); - } - elsif ($form->field("do") eq "create") { - redirect($q, $config{url}); - } - else { - redirect($q, "$config{url}/".htmlpage($page)); - } - return; - } - elsif ($form->submitted eq "Preview") { - my $content=$form->field('editcontent'); - run_hooks(editcontent => sub { - $content=shift->( - content => $content, - page => $page, - cgi => $q, - session => $session, - ); - }); - $form->tmpl_param("page_preview", - htmlize($page, $type, - linkify($page, "", - preprocess($page, $page, - filter($page, $page, $content), 0, 1)))); - } - elsif ($form->submitted eq "Save Page") { - $form->tmpl_param("page_preview", ""); - } - $form->tmpl_param("page_conflict", ""); - - 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, $config{srcdir}) || - $from=~/^\// || - $form->submitted eq "Preview") { - @page_locs=$best_loc=$page; - } - else { - my $dir=$from."/"; - $dir=~s![^/]+/+$!!; - - if ((defined $form->field('subpage') && length $form->field('subpage')) || - $page eq gettext('discussion')) { - $best_loc="$from/$page"; - } - else { - $best_loc=$dir.$page; - } - - push @page_locs, $dir.$page; - push @page_locs, "$from/$page"; - while (length $dir) { - $dir=~s![^/]+/+$!!; - push @page_locs, $dir.$page; - } - } - push @page_locs, "$config{userdir}/$page" - if length $config{userdir}; - - @page_locs = grep { - ! exists $pagecase{lc $_} - } @page_locs; - if (! @page_locs) { - # hmm, someone else made the page in the - # meantime? - redirect($q, "$config{url}/".htmlpage($page)); - return; - } - - my @editable_locs = grep { - check_canedit($_, $q, $session, 1) - } @page_locs; - if (! @editable_locs) { - # let it throw an error this time - map { check_canedit($_, $q, $session) } @page_locs; - } - - my @page_types; - if (exists $hooks{htmlize}) { - @page_types=keys %{$hooks{htmlize}}; - } - - $form->tmpl_param("page_select", 1); - $form->field(name => "page", type => 'select', - options => [ map { pagetitle($_, 1) } @editable_locs ], - value => pagetitle($best_loc, 1)); - $form->field(name => "type", type => 'select', - options => \@page_types); - $form->title(sprintf(gettext("creating %s"), pagetitle($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($page))); - } - - showform($form, \@buttons, $session, $q); - saveindex(); - } - else { - # save page - check_canedit($page, $q, $session); - - my $exists=-e "$config{srcdir}/$file"; - - if ($form->field("do") ne "create" && ! $exists && - ! eval { srcfile($file) }) { - $form->tmpl_param("page_gone", 1); - $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); - return; - } - elsif ($form->field("do") eq "create" && $exists) { - $form->tmpl_param("creation_conflict", 1); - $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); - return; - } - - my $content=$form->field('editcontent'); - 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; - - $config{cgi}=0; # avoid cgi error message - eval { writefile($file, $config{srcdir}, $content) }; - $config{cgi}=1; - if ($@) { - $form->field(name => "rcsinfo", value => rcs_prepedit($file), - force => 1); - $form->tmpl_param("failed_save", 1); - $form->tmpl_param("error_message", $@); - $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); - return; - } - - my $conflict; - if ($config{rcs}) { - my $message=""; - if (defined $form->field('comments') && - length $form->field('comments')) { - $message=$form->field('comments'); - } - - if (! $exists) { - rcs_add($file); - } - - # Prevent deadlock with post-commit hook by - # signaling to it that it should not try to - # do anything (except send commit mails). - disable_commit_hook(); - $conflict=rcs_commit($file, $message, - $form->field("rcsinfo"), - $session->param("name"), $ENV{REMOTE_ADDR}); - 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; - # Reload index, since the first time it's loaded is before - # the wiki is locked, and things may have changed in the - # meantime. - loadindex(); - refresh(); - saveindex(); - - if (defined $conflict) { - $form->field(name => "rcsinfo", value => rcs_prepedit($file), - force => 1); - $form->tmpl_param("page_conflict", 1); - $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); - return; - } - else { - # The trailing question mark tries to avoid broken - # caches and get the most recent version of the page. - redirect($q, "$config{url}/".htmlpage($page)."?updated"); - } - } -} #}}} +} -sub cgi_getsession ($) { #{{{ +sub cgi_getsession ($) { my $q=shift; - eval q{use CGI::Session}; - CGI::Session->name("ikiwiki_session_".encode_utf8($config{wikiname})); + eval q{use CGI::Session; use HTML::Entities}; + error($@) if $@; + CGI::Session->name("ikiwiki_session_".encode_entities($config{wikiname})); my $oldmask=umask(077); - my $session = CGI::Session->new("driver:DB_File", $q, - { FileName => "$config{wikistatedir}/sessions.db" }); + my $session = eval { + CGI::Session->new("driver:DB_File", $q, + { FileName => "$config{wikistatedir}/sessions.db" }) + }; + if (! $session || $@) { + error($@." ".CGI::Session->errstr()); + } + umask($oldmask); return $session; -} #}}} +} + +# To guard against CSRF, the user's session id (sid) +# can be stored on a form. This function will check +# (for logged in users) that the sid on the form matches +# the session id in the cookie. +sub checksessionexpiry ($$) { + my $q=shift; + my $session = shift; -sub cgi_savesession ($) { #{{{ + if (defined $session->param("name")) { + my $sid=$q->param('sid'); + if (! defined $sid || $sid ne $session->id) { + error(gettext("Your login session has expired.")); + } + } +} + +sub cgi_savesession ($) { my $session=shift; # Force session flush with safe umask. my $oldmask=umask(077); $session->flush; umask($oldmask); -} #}}} +} -sub cgi (;$$) { #{{{ +sub cgi (;$$) { my $q=shift; my $session=shift; + eval q{use CGI}; + error($@) if $@; + $CGI::DISABLE_UPLOADS=$config{cgi_disable_uploads}; + if (! $q) { - eval q{use CGI}; - error($@) if $@; - + binmode(STDIN); $q=CGI->new; + binmode(STDIN, ":utf8"); run_hooks(cgi => sub { shift->($q) }); } @@ -672,14 +348,9 @@ sub cgi (;$$) { #{{{ } } - # Things that do not need a session. - if ($do eq 'recentchanges') { - cgi_recentchanges($q); - return; - } - # Need to lock the wiki before getting a session. lockwiki(); + loadindex(); if (! $session) { $session=cgi_getsession($q); @@ -703,63 +374,33 @@ sub cgi (;$$) { #{{{ } } - if (defined $session->param("name") && - userinfo_get($session->param("name"), "banned")) { - print $q->header(-status => "403 Forbidden"); - $session->delete(); - print gettext("You are banned."); - cgi_savesession($session); - } - + check_banned($q, $session); + run_hooks(sessioncgi => sub { shift->($q, $session) }); if ($do eq 'signin') { cgi_signin($q, $session); cgi_savesession($session); } - elsif (defined $session->param("postsignin")) { - cgi_postsignin($q, $session); - } elsif ($do eq 'prefs') { cgi_prefs($q, $session); } - elsif ($do eq 'create' || $do eq 'edit') { - cgi_editpage($q, $session); - } - elsif ($do eq 'postsignin') { - error(gettext("login failed, perhaps you need to turn on cookies?")); + elsif (defined $session->param("postsignin") || $do eq 'postsignin') { + cgi_postsignin($q, $session); } else { error("unknown do parameter"); } -} #}}} +} -sub userlink ($) { #{{{ - my $user=shift; +# Does not need to be called directly; all errors will go through here. +sub cgierror ($) { + my $message=shift; - eval q{use CGI 'escapeHTML'}; - error($@) if $@; - if ($user =~ m!^https?://! && - eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) { - # Munge user-urls, as used by eg, OpenID. - my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user); - my $display=$oid->display; - # Convert "user.somehost.com" to "user [somehost.com]". - if ($display !~ /\[/) { - $display=~s/^(.*?)\.([^.]+\.[a-z]+)$/$1 [$2]/; - } - # Convert "http://somehost.com/user" to "user [somehost.com]". - if ($display !~ /\[/) { - $display=~s/^https?:\/\/(.+)\/([^\/]+)$/$2 [$1]/; - } - $display=~s!^https?://!!; # make sure this is removed - return "".escapeHTML($display).""; - } - else { - return htmllink("", "", escapeHTML( - length $config{userdir} ? $config{userdir}."/".$user : $user - ), noimageinline => 1); - } -} #}}} + print "Content-type: text/html\n\n"; + print misctemplate(gettext("Error"), + "

".gettext("Error").": $message

"); + die $@; +} 1