X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/be092a67c22e98885f79936c18529f9fac5c0fe0..8daaa11baa70e07f6405ccb4474e97cac9627961:/IkiWiki/CGI.pm diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm index f1f83cfc4..85fc1a386 100644 --- a/IkiWiki/CGI.pm +++ b/IkiWiki/CGI.pm @@ -9,6 +9,18 @@ use Encode; package IkiWiki; +sub printheader ($) { #{{{ + my $session=shift; + + if ($config{sslcookie}) { + print $session->header(-charset => 'utf-8', + -cookie => $session->cookie(-secure => 1)); + } else { + print $session->header(-charset => 'utf-8'); + } + +} #}}} + sub redirect ($$) { #{{{ my $q=shift; my $url=shift; @@ -33,8 +45,12 @@ sub page_locked ($$;$) { #{{{ my $locked_pages=userinfo_get($admin, "locked_pages"); if (pagespec_match($page, userinfo_get($admin, "locked_pages"))) { return 1 if $nonfatal; - error(htmllink("", "", $page, 1)." is locked by ". - htmllink("", "", $admin, 1)." and cannot be edited."); + + #translators: The first parameter is a page name, + #translators: second is the user who locked it. + error(sprintf(gettext("%s is locked by %s and cannot be edited"), + htmllink("", "", $page, 1), + userlink($admin))); } } @@ -55,25 +71,46 @@ sub decode_form_utf8 ($) { #{{{ sub cgi_recentchanges ($) { #{{{ my $q=shift; - unlockwiki(); - # 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}, 1); + $_; + } @{$change->{pages}} + ]; + push @{$change->{pages}}, { link => '...' } if $is_excess; + } + my $template=template("recentchanges.tmpl"); $template->param( title => "RecentChanges", indexlink => indexlink(), wikiname => $config{wikiname}, - changelog => [rcs_recentchanges(100)], - styleurl => styleurl(), - baseurl => "$config{url}/", + changelog => $changelog, + baseurl => baseurl(), ); - print $q->header(-charset=>'utf-8'), $template->output; + run_hooks(pagetemplate => sub { + shift->(page => "", destpage => "", template => $template); + }); + print $q->header(-charset => 'utf-8'), $template->output; } #}}} sub cgi_signin ($$) { #{{{ @@ -81,18 +118,12 @@ sub cgi_signin ($$) { #{{{ my $session=shift; eval q{use CGI::FormBuilder}; + error($@) if $@; my $form = CGI::FormBuilder->new( title => "signin", - fields => [qw(do title page subpage from name password confirm_password email)], header => 1, charset => "utf-8", method => 'POST', - validate => { - confirm_password => { - perl => q{eq $form->field("password")}, - }, - email => 'EMAIL', - }, required => 'NONE', javascript => 0, params => $q, @@ -100,146 +131,52 @@ sub cgi_signin ($$) { #{{{ header => 0, template => (-e "$config{templatedir}/signin.tmpl" ? {template_params("signin.tmpl")} : ""), - stylesheet => styleurl(), + stylesheet => baseurl()."style.css", ); - - decode_form_utf8($form); + my $buttons=["Login"]; - $form->field(name => "name", required => 0); $form->field(name => "do", type => "hidden"); - $form->field(name => "page", type => "hidden"); - $form->field(name => "title", type => "hidden"); - $form->field(name => "from", type => "hidden"); - $form->field(name => "subpage", type => "hidden"); - $form->field(name => "password", type => "password", required => 0); - $form->field(name => "confirm_password", type => "password", required => 0); - $form->field(name => "email", required => 0); + if ($q->param("do") ne "signin" && !$form->submitted) { - $form->text("You need to log in first."); + $form->text(gettext("You need to log in first.")); } - if ($form->submitted) { - # Set required fields based on how form was submitted. - my %required=( - "Login" => [qw(name password)], - "Register" => [qw(name password confirm_password email)], - "Mail Password" => [qw(name)], - ); - foreach my $opt (@{$required{$form->submitted}}) { - $form->field(name => $opt, required => 1); - } + run_hooks(formbuilder_setup => sub { + shift->(form => $form, cgi => $q, session => $session); + }); - # Validate password differently depending on how - # form was submitted. - if ($form->submitted eq 'Login') { - $form->field( - name => "password", - validate => sub { - length $form->field("name") && - shift eq userinfo_get($form->field("name"), 'password'); - }, - ); - $form->field(name => "name", validate => '/^\w+$/'); - } - else { - $form->field(name => "password", validate => 'VALUE'); - } - # And make sure the entered name exists when logging - # in or sending email, and does not when registering. - if ($form->submitted eq 'Register') { - $form->field( - name => "name", - validate => sub { - my $name=shift; - length $name && - $name=~/$config{wiki_file_regexp}/ && - ! userinfo_get($name, "regdate"); - }, - ); - } - else { - $form->field( - name => "name", - validate => sub { - my $name=shift; - length $name && - userinfo_get($name, "regdate"); - }, - ); - } + decode_form_utf8($form); + + if (exists $hooks{formbuilder}) { + run_hooks(formbuilder => sub { + shift->(form => $form, cgi => $q, session => $session, + buttons => $buttons); + }); } else { - # First time settings. - $form->field(name => "name", comment => "use FirstnameLastName"); - $form->field(name => "confirm_password", comment => "(only needed"); - $form->field(name => "email", comment => "for registration)"); - if ($session->param("name")) { - $form->field(name => "name", value => $session->param("name")); + if ($form->submitted) { + $form->validate; } + printheader($session); + print misctemplate($form->title, $form->render(submit => $buttons)); } +} #}}} - if ($form->submitted && $form->validate) { - if ($form->submitted eq 'Login') { - $session->param("name", $form->field("name")); - if (defined $form->field("do") && - $form->field("do") ne 'signin') { - redirect($q, cgiurl( - do => $form->field("do"), - page => $form->field("page"), - title => $form->field("title"), - subpage => $form->field("subpage"), - from => $form->field("from"), - )); - } - else { - redirect($q, $config{url}); - } - } - elsif ($form->submitted eq 'Register') { - my $user_name=$form->field('name'); - if (userinfo_setall($user_name, { - 'email' => $form->field('email'), - 'password' => $form->field('password'), - 'regdate' => time - })) { - $form->field(name => "confirm_password", type => "hidden"); - $form->field(name => "email", type => "hidden"); - $form->text("Registration successful. Now you can Login."); - print $session->header(-charset=>'utf-8'); - print misctemplate($form->title, $form->render(submit => ["Login"])); - } - else { - error("Error saving registration."); - } - } - elsif ($form->submitted eq 'Mail Password') { - my $user_name=$form->field("name"); - my $template=template("passwordmail.tmpl"); - $template->param( - user_name => $user_name, - user_password => userinfo_get($user_name, "password"), - wikiurl => $config{url}, - wikiname => $config{wikiname}, - REMOTE_ADDR => $ENV{REMOTE_ADDR}, - ); - - eval q{use Mail::Sendmail}; - sendmail( - To => userinfo_get($user_name, "email"), - From => "$config{wikiname} admin <$config{adminemail}>", - Subject => "$config{wikiname} information", - Message => $template->output, - ) or error("Failed to send mail"); - - $form->text("Your password has been emailed to you."); - $form->field(name => "name", required => 0); - print $session->header(-charset=>'utf-8'); - print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"])); - } +sub cgi_postsignin ($$) { #{{{ + my $q=shift; + my $session=shift; + + # Continue with whatever was being done before the signin process. + if (defined $q->param("do") && $q->param("do") ne "signin" && + defined $session->param("postsignin")) { + my $postsignin=CGI->new($session->param("postsignin")); + $session->clear("postsignin"); + cgi($postsignin, $session); + cgi_savesession($session); + exit; } else { - print $session->header(-charset=>'utf-8'); - print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"])); + redirect($q, $config{url}); } } #}}} @@ -248,17 +185,13 @@ sub cgi_prefs ($$) { #{{{ my $session=shift; eval q{use CGI::FormBuilder}; + error($@) if $@; my $form = CGI::FormBuilder->new( title => "preferences", - fields => [qw(do name password confirm_password email - subscriptions locked_pages)], header => 0, charset => "utf-8", method => 'POST', validate => { - confirm_password => { - perl => q{eq $form->field("password")}, - }, email => 'EMAIL', }, required => 'NONE', @@ -267,25 +200,28 @@ sub cgi_prefs ($$) { #{{{ action => $config{cgiurl}, template => (-e "$config{templatedir}/prefs.tmpl" ? {template_params("prefs.tmpl")} : ""), - stylesheet => styleurl(), + stylesheet => baseurl()."style.css", ); - my @buttons=("Save Preferences", "Logout", "Cancel"); + my $buttons=["Save Preferences", "Logout", "Cancel"]; + + run_hooks(formbuilder_setup => sub { + shift->(form => $form, cgi => $q, session => $session); + }); - my $user_name=$session->param("name"); $form->field(name => "do", type => "hidden"); - $form->field(name => "name", disabled => 1, - value => $user_name, force => 1); - $form->field(name => "password", type => "password"); - $form->field(name => "confirm_password", type => "password"); + $form->field(name => "email", size => 50); $form->field(name => "subscriptions", size => 50, comment => "(".htmllink("", "", "PageSpec", 1).")"); $form->field(name => "locked_pages", size => 50, comment => "(".htmllink("", "", "PageSpec", 1).")"); + $form->field(name => "banned_users", size => 50); + my $user_name=$session->param("name"); if (! is_admin($user_name)) { $form->field(name => "locked_pages", type => "hidden"); + $form->field(name => "banned_users", type => "hidden"); } - + if (! $form->submitted) { $form->field(name => "email", force => 1, value => userinfo_get($user_name, "email")); @@ -293,6 +229,10 @@ sub cgi_prefs ($$) { #{{{ value => userinfo_get($user_name, "subscriptions")); $form->field(name => "locked_pages", force => 1, value => userinfo_get($user_name, "locked_pages")); + if (is_admin($user_name)) { + $form->field(name => "banned_users", force => 1, + value => join(" ", get_banned_users())); + } } decode_form_utf8($form); @@ -306,26 +246,42 @@ sub cgi_prefs ($$) { #{{{ redirect($q, $config{url}); return; } - elsif ($form->submitted eq "Save Preferences" && $form->validate) { - foreach my $field (qw(password email subscriptions locked_pages)) { - if (length $form->field($field)) { + elsif ($form->submitted eq 'Save Preferences' && $form->validate) { + foreach my $field (qw(email subscriptions locked_pages)) { + if (defined $form->field($field) && length $form->field($field)) { userinfo_set($user_name, $field, $form->field($field)) || error("failed to set $field"); } } - $form->text("Preferences saved."); + if (is_admin($user_name)) { + set_banned_users(grep { ! is_admin($_) } + split(' ', $form->field("banned_users"))); + } + $form->text(gettext("Preferences saved.")); } - print $session->header(-charset=>'utf-8'); - print misctemplate($form->title, $form->render(submit => \@buttons)); + if (exists $hooks{formbuilder}) { + run_hooks(formbuilder => sub { + shift->(form => $form, cgi => $q, session => $session, + buttons => $buttons); + }); + } + else { + printheader($session); + print misctemplate($form->title, $form->render(submit => $buttons)); + } } #}}} sub cgi_editpage ($$) { #{{{ 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( - fields => [qw(do rcsinfo subpage from page type editcontent comments)], + fields => \@fields, header => 1, charset => "utf-8", method => 'POST', @@ -337,9 +293,13 @@ sub cgi_editpage ($$) { #{{{ params => $q, action => $config{cgiurl}, table => 0, - template => {template_params("editpage.tmpl")}, + template => (-e "$config{templatedir}/editpage.tmpl" ? + {template_params("editpage.tmpl")} : ""), ); - my @buttons=("Save Page", "Preview", "Cancel"); + + run_hooks(formbuilder_setup => sub { + shift->(form => $form, cgi => $q, session => $session); + }); decode_form_utf8($form); @@ -347,8 +307,7 @@ sub cgi_editpage ($$) { #{{{ # characters. my ($page)=$form->field('page'); $page=titlepage(possibly_foolish_untaint($page)); - if (! defined $page || ! length $page || - $page=~/$config{wiki_file_prune_regexp}/ || $page=~/^\//) { + if (! defined $page || ! length $page || file_pruned($page, $config{srcdir}) || $page=~/^\//) { error("bad page name"); } @@ -394,27 +353,37 @@ sub cgi_editpage ($$) { #{{{ $form->tmpl_param("indexlink", indexlink()); $form->tmpl_param("helponformattinglink", htmllink("", "", "HelpOnFormatting", 1)); - $form->tmpl_param("styleurl", styleurl()); - $form->tmpl_param("baseurl", "$config{url}/"); + $form->tmpl_param("baseurl", baseurl()); if (! $form->submitted) { $form->field(name => "rcsinfo", value => rcs_prepedit($file), force => 1); } if ($form->submitted eq "Cancel") { - redirect($q, "$config{url}/".htmlpage($page)); + if ($newfile && defined $from) { + redirect($q, "$config{url}/".htmlpage($from)); + } + elsif ($newfile) { + redirect($q, $config{url}); + } + else { + redirect($q, "$config{url}/".htmlpage($page)); + } return; } elsif ($form->submitted eq "Preview") { - require IkiWiki::Render; my $content=$form->field('editcontent'); my $comments=$form->field('comments'); $form->field(name => "editcontent", value => $content, force => 1); $form->field(name => "comments", value => $comments, force => 1); + $config{rss}=$config{atom}=0; # avoid preview writing a feed! $form->tmpl_param("page_preview", - htmlize($type, linkify($page, $page, filter($page, $content)))); + htmlize($page, $type, + linkify($page, "", + preprocess($page, $page, + filter($page, $content))))); } else { $form->tmpl_param("page_preview", ""); @@ -428,7 +397,7 @@ sub cgi_editpage ($$) { #{{{ my $best_loc; if (! defined $from || ! length $from || $from ne $form->field('from') || - $from=~/$config{wiki_file_prune_regexp}/ || + file_pruned($from, $config{srcdir}) || $from=~/^\// || $form->submitted eq "Preview") { @page_locs=$best_loc=$page; @@ -438,7 +407,7 @@ sub cgi_editpage ($$) { #{{{ $dir=~s![^/]+/+$!!; if ((defined $form->field('subpage') && length $form->field('subpage')) || - $page eq 'discussion') { + $page eq gettext('discussion')) { $best_loc="$from/$page"; } else { @@ -452,6 +421,8 @@ sub cgi_editpage ($$) { #{{{ push @page_locs, $dir.$page; } } + push @page_locs, "$config{userdir}/$page" + if length $config{userdir}; @page_locs = grep { ! exists $pagecase{lc $_} && @@ -475,7 +446,7 @@ sub cgi_editpage ($$) { #{{{ options => \@page_locs, value => $best_loc); $form->field(name => "type", type => 'select', options => \@page_types); - $form->title("creating ".pagetitle($page)); + $form->title(sprintf(gettext("creating %s"), pagetitle($page))); } elsif ($form->field("do") eq "edit") { page_locked($page, $session); @@ -492,7 +463,7 @@ sub cgi_editpage ($$) { #{{{ $form->tmpl_param("page_select", 0); $form->field(name => "page", type => 'hidden'); $form->field(name => "type", type => 'hidden'); - $form->title("editing ".pagetitle($page)); + $form->title(sprintf(gettext("editing %s"), pagetitle($page))); } print $form->render(submit => \@buttons); @@ -507,20 +478,13 @@ sub cgi_editpage ($$) { #{{{ $content=~s/\r/\n/g; writefile($file, $config{srcdir}, $content); - my $message="web commit "; - if (defined $session->param("name") && - length $session->param("name")) { - $message.="by ".$session->param("name"); - } - else { - $message.="from $ENV{REMOTE_ADDR}"; - } - if (defined $form->field('comments') && - length $form->field('comments')) { - $message.=": ".$form->field('comments'); - } - if ($config{rcs}) { + my $message=""; + if (defined $form->field('comments') && + length $form->field('comments')) { + $message=$form->field('comments'); + } + if ($newfile) { rcs_add($file); } @@ -529,7 +493,8 @@ sub cgi_editpage ($$) { #{{{ # presumably the commit will trigger an update # of the wiki my $conflict=rcs_commit($file, $message, - $form->field("rcsinfo")); + $form->field("rcsinfo"), + $session->param("name"), $ENV{REMOTE_ADDR}); if (defined $conflict) { $form->field(name => "rcsinfo", value => rcs_prepedit($file), @@ -541,7 +506,7 @@ sub cgi_editpage ($$) { #{{{ $form->tmpl_param("page_select", 0); $form->field(name => "page", type => 'hidden'); $form->field(name => "type", type => 'hidden'); - $form->title("editing $page"); + $form->title(sprintf(gettext("editing %s"), $page)); print $form->render(submit => \@buttons); return; } @@ -558,14 +523,42 @@ sub cgi_editpage ($$) { #{{{ } } #}}} -sub cgi () { #{{{ - eval q{use CGI}; +sub cgi_getsession ($) { #{{{ + my $q=shift; + eval q{use CGI::Session}; + CGI::Session->name("ikiwiki_session_".encode_utf8($config{wikiname})); - my $q=CGI->new; + my $oldmask=umask(077); + my $session = CGI::Session->new("driver:DB_File", $q, + { FileName => "$config{wikistatedir}/sessions.db" }); + umask($oldmask); + + return $session; +} #}}} + +sub cgi_savesession ($) { #{{{ + my $session=shift; + + # Force session flush with safe umask. + my $oldmask=umask(077); + $session->flush; + umask($oldmask); +} + +sub cgi (;$$) { #{{{ + my $q=shift; + my $session=shift; + + if (! $q) { + eval q{use CGI}; + error($@) if $@; - run_hooks(cgi => sub { shift->($q) }); + $q=CGI->new; + run_hooks(cgi => sub { shift->($q) }); + } + my $do=$q->param('do'); if (! defined $do || ! length $do) { my $error = $q->cgi_error; @@ -585,27 +578,55 @@ sub cgi () { #{{{ elsif ($do eq 'hyperestraier') { cgi_hyperestraier(); } + + # Need to lock the wiki before getting a session. + lockwiki(); - CGI::Session->name("ikiwiki_session_$config{wikiname}"); - - my $oldmask=umask(077); - my $session = CGI::Session->new("driver:DB_File", $q, - { FileName => "$config{wikistatedir}/sessions.db" }); - umask($oldmask); + if (! $session) { + $session=cgi_getsession($q); + } + # Auth hooks can sign a user in. + if ($do ne 'signin' && ! defined $session->param("name")) { + run_hooks(auth => sub { + shift->($q, $session) + }); + if (defined $session->param("name")) { + # Make sure whatever user was authed is in the + # userinfo db. + if (! userinfo_get($session->param("name"), "regdate")) { + userinfo_setall($session->param("name"), { + email => "", + password => "", + regdate => time, + }); + } + } + } + # Everything below this point needs the user to be signed in. - if ((! $config{anonok} && + if (((! $config{anonok} || $do eq 'prefs') && (! defined $session->param("name") || - ! userinfo_get($session->param("name"), "regdate"))) || $do eq 'signin') { + ! userinfo_get($session->param("name"), "regdate"))) + || $do eq 'signin') { + if ($do ne 'signin' && ! defined $session->param("postsignin")) { + $session->param(postsignin => $ENV{QUERY_STRING}); + } cgi_signin($q, $session); - - # Force session flush with safe umask. - my $oldmask=umask(077); - $session->flush; - umask($oldmask); - + cgi_savesession($session); return; } + elsif (defined $session->param("postsignin")) { + cgi_postsignin($q, $session); + } + + 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); + exit; + } if ($do eq 'create' || $do eq 'edit') { cgi_editpage($q, $session); @@ -614,7 +635,8 @@ sub cgi () { #{{{ cgi_prefs($q, $session); } elsif ($do eq 'blog') { - my $page=titlepage($q->param('title')); + my $page=titlepage(decode_utf8($q->param('title'))); + $page=~s/(\/)/"__".ord($1)."__"/eg; # escape slashes too # if the page already exists, munge it to be unique my $from=$q->param('from'); my $add=""; @@ -632,4 +654,32 @@ sub cgi () { #{{{ } } #}}} +sub userlink ($) { #{{{ + my $user=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 + ), 1); + } +} #}}} + 1