X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7ceb5b1f75efa68aac88c179dd6d14e743e4a2ae..37c6116d6aab664b5d6d4cb1f90f4c6bf8ed2558:/IkiWiki/CGI.pm diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm index 71a3299a4..155010a97 100644 --- a/IkiWiki/CGI.pm +++ b/IkiWiki/CGI.pm @@ -20,6 +20,24 @@ sub printheader ($) { #{{{ } } #}}} + +sub showform ($$$$) { #{{{ + my $form=shift; + my $buttons=shift; + my $session=shift; + my $cgi=shift; + + if (exists $hooks{formbuilder}) { + run_hooks(formbuilder => sub { + shift->(form => $form, cgi => $cgi, session => $session, + buttons => $buttons); + }); + } + else { + printheader($session); + print misctemplate($form->title, $form->render(submit => $buttons)); + } +} sub redirect ($$) { #{{{ my $q=shift; @@ -33,28 +51,25 @@ sub redirect ($$) { #{{{ } } #}}} -sub page_locked ($$;$) { #{{{ +sub check_canedit ($$$;$) { #{{{ my $page=shift; + my $q=shift; my $session=shift; my $nonfatal=shift; - my $user=$session->param("name"); - return if defined $user && is_admin($user); - - foreach my $admin (@{$config{adminuser}}) { - my $locked_pages=userinfo_get($admin, "locked_pages"); - if (pagespec_match($page, userinfo_get($admin, "locked_pages"))) { - return 1 if $nonfatal; - - #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))); + my $canedit; + run_hooks(canedit => sub { + return if defined $canedit; + my $ret=shift->($page, $q, $session); + if (defined $ret && $ret eq "") { + $canedit=1; } - } - - return 0; + elsif (defined $ret) { + $canedit=0; + error($ret) unless $nonfatal; + } + }); + return $canedit; } #}}} sub decode_form_utf8 ($) { #{{{ @@ -92,7 +107,9 @@ sub cgi_recentchanges ($) { #{{{ delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess; $change->{pages} = [ map { - $_->{link} = htmllink("", "", $_->{page}, 1); + $_->{link} = htmllink("", "", $_->{page}, + noimageinline => 1, + linktext => pagetitle($_->{page})); $_; } @{$change->{pages}} ]; @@ -113,6 +130,23 @@ sub cgi_recentchanges ($) { #{{{ 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 ($$) { #{{{ + 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}); + } + cgi_signin($q, $session); + cgi_savesession($session); + exit; + } +} #}}} + sub cgi_signin ($$) { #{{{ my $q=shift; my $session=shift; @@ -121,7 +155,7 @@ sub cgi_signin ($$) { #{{{ error($@) if $@; my $form = CGI::FormBuilder->new( title => "signin", - header => 1, + name => "signin", charset => "utf-8", method => 'POST', required => 'NONE', @@ -129,45 +163,37 @@ sub cgi_signin ($$) { #{{{ params => $q, action => $config{cgiurl}, header => 0, - template => scalar template_params("signin.tmpl"), + template => {type => 'div'}, stylesheet => baseurl()."style.css", ); my $buttons=["Login"]; - $form->field(name => "do", type => "hidden"); - if ($q->param("do") ne "signin" && !$form->submitted) { $form->text(gettext("You need to log in first.")); } + $form->field(name => "do", type => "hidden", value => "signin", + force => 1); + + decode_form_utf8($form); run_hooks(formbuilder_setup => sub { - shift->(form => $form, cgi => $q, session => $session); + shift->(form => $form, cgi => $q, session => $session, + buttons => $buttons); }); - - decode_form_utf8($form); - if (exists $hooks{formbuilder}) { - run_hooks(formbuilder => sub { - shift->(form => $form, cgi => $q, session => $session, - buttons => $buttons); - }); - } - else { - if ($form->submitted) { - $form->validate; - } - printheader($session); - print misctemplate($form->title, $form->render(submit => $buttons)); + if ($form->submitted) { + $form->validate; } + + showform($form, $buttons, $session, $q); } #}}} 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")) { + if (defined $session->param("postsignin")) { my $postsignin=CGI->new($session->param("postsignin")); $session->clear("postsignin"); cgi($postsignin, $session); @@ -175,6 +201,8 @@ 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}); } } #}}} @@ -183,10 +211,13 @@ sub cgi_prefs ($$) { #{{{ my $q=shift; my $session=shift; + needsignin($q, $session); + eval q{use CGI::FormBuilder}; error($@) if $@; my $form = CGI::FormBuilder->new( title => "preferences", + name => "preferences", header => 0, charset => "utf-8", method => 'POST', @@ -197,26 +228,33 @@ sub cgi_prefs ($$) { #{{{ javascript => 0, params => $q, action => $config{cgiurl}, - template => scalar template_params("prefs.tmpl"), + template => {type => 'div'}, stylesheet => baseurl()."style.css", + fieldsets => [ + [login => gettext("Login")], + [preferences => gettext("Preferences")], + [admin => gettext("Admin")] + ], ); my $buttons=["Save Preferences", "Logout", "Cancel"]; + decode_form_utf8($form); + run_hooks(formbuilder_setup => sub { - shift->(form => $form, cgi => $q, session => $session); + shift->(form => $form, cgi => $q, session => $session, + buttons => $buttons); }); $form->field(name => "do", type => "hidden"); - $form->field(name => "email", size => 50); + $form->field(name => "email", size => 50, fieldset => "preferences"); $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); + fieldset => "preferences", + comment => "(".htmllink("", "", "PageSpec", noimageinline => 1).")"); + $form->field(name => "banned_users", size => 50, + fieldset => "admin"); 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"); } @@ -225,16 +263,12 @@ sub cgi_prefs ($$) { #{{{ value => userinfo_get($user_name, "email")); $form->field(name => "subscriptions", force => 1, 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); - if ($form->submitted eq 'Logout') { $session->delete(); redirect($q, $config{url}); @@ -245,28 +279,22 @@ sub cgi_prefs ($$) { #{{{ return; } elsif ($form->submitted eq 'Save Preferences' && $form->validate) { - foreach my $field (qw(email subscriptions locked_pages)) { + 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"); + userinfo_set($user_name, $field, $form->field($field)) || + error("failed to set $field"); } } if (is_admin($user_name)) { set_banned_users(grep { ! is_admin($_) } - split(' ', $form->field("banned_users"))); + split(' ', + $form->field("banned_users"))) || + error("failed saving changes"); } $form->text(gettext("Preferences saved.")); } - 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)); - } + showform($form, $buttons, $session, $q); } #}}} sub cgi_editpage ($$) { #{{{ @@ -279,8 +307,8 @@ sub cgi_editpage ($$) { #{{{ eval q{use CGI::FormBuilder}; error($@) if $@; my $form = CGI::FormBuilder->new( + title => "editpage", fields => \@fields, - header => 1, charset => "utf-8", method => 'POST', validate => { @@ -290,21 +318,25 @@ sub cgi_editpage ($$) { #{{{ 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); + shift->(form => $form, cgi => $q, session => $session, + buttons => \@buttons); }); - decode_form_utf8($form); - # 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=~/^\//) { + if (! defined $page || ! length $page || + file_pruned($page, $config{srcdir}) || $page=~/^\//) { error("bad page name"); } @@ -315,9 +347,16 @@ sub cgi_editpage ($$) { #{{{ my $file; my $type; - if (exists $pagesources{$page}) { + 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); + } } else { $type=$form->param('type'); @@ -330,18 +369,16 @@ sub cgi_editpage ($$) { #{{{ } $type=$config{default_pageext} unless defined $type; $file=$page.".".$type; - } - - my $newfile=0; - if (! -e "$config{srcdir}/$file") { - $newfile=1; + 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 => $page, force => 1); + $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, @@ -349,18 +386,14 @@ sub cgi_editpage ($$) { #{{{ $form->tmpl_param("can_commit", $config{rcs}); $form->tmpl_param("indexlink", indexlink()); $form->tmpl_param("helponformattinglink", - htmllink("", "", "HelpOnFormatting", 1)); + htmllink("", "", "HelpOnFormatting", noimageinline => 1)); $form->tmpl_param("baseurl", baseurl()); - if (! $form->submitted) { - $form->field(name => "rcsinfo", value => rcs_prepedit($file), - force => 1); - } if ($form->submitted eq "Cancel") { - if ($newfile && defined $from) { + if ($form->field("do") eq "create" && defined $from) { redirect($q, "$config{url}/".htmlpage($from)); } - elsif ($newfile) { + elsif ($form->field("do") eq "create") { redirect($q, $config{url}); } else { @@ -370,25 +403,26 @@ sub cgi_editpage ($$) { #{{{ } elsif ($form->submitted eq "Preview") { 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! + 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, $content))))); + filter($page, $page, $content), 0, 1)))); } - else { + elsif ($form->submitted eq "Save Page") { $form->tmpl_param("page_preview", ""); } $form->tmpl_param("page_conflict", ""); - if (! $form->submitted || $form->submitted eq "Preview" || - ! $form->validate) { + if ($form->submitted ne "Save Page" || ! $form->validate) { if ($form->field("do") eq "create") { my @page_locs; my $best_loc; @@ -422,16 +456,22 @@ sub cgi_editpage ($$) { #{{{ if length $config{userdir}; @page_locs = grep { - ! exists $pagecase{lc $_} && - ! page_locked($_, $session, 1) + ! 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}) { @@ -440,13 +480,15 @@ sub cgi_editpage ($$) { #{{{ $form->tmpl_param("page_select", 1); $form->field(name => "page", type => 'select', - options => \@page_locs, value => $best_loc); + 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") { - page_locked($page, $session); + check_canedit($page, $q, $session); if (! defined $form->field('editcontent') || ! length $form->field('editcontent')) { my $content=""; @@ -463,18 +505,71 @@ sub cgi_editpage ($$) { #{{{ $form->title(sprintf(gettext("editing %s"), pagetitle($page))); } - print $form->render(submit => \@buttons); + showform($form, \@buttons, $session, $q); + saveindex(); } else { # save page - page_locked($page, $session); + 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; - writefile($file, $config{srcdir}, $content); + + $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') && @@ -482,41 +577,46 @@ sub cgi_editpage ($$) { #{{{ $message=$form->field('comments'); } - if ($newfile) { + if (! $exists) { rcs_add($file); } - # prevent deadlock with post-commit hook - unlockwiki(); - # presumably the commit will trigger an update - # of the wiki - my $conflict=rcs_commit($file, $message, + + # 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(); + } - 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(name => "comments", value => $form->field('comments'), force => 1); - $form->field("do", "edit)"); - $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)); - print $form->render(submit => \@buttons); - return; - } + # 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("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 { - require IkiWiki::Render; - refresh(); - saveindex(); + # 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"); } - - # 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"); } } #}}} @@ -541,7 +641,7 @@ sub cgi_savesession ($) { #{{{ my $oldmask=umask(077); $session->flush; umask($oldmask); -} +} #}}} sub cgi (;$$) { #{{{ my $q=shift; @@ -572,9 +672,6 @@ sub cgi (;$$) { #{{{ cgi_recentchanges($q); return; } - elsif ($do eq 'hyperestraier') { - cgi_hyperestraier(); - } # Need to lock the wiki before getting a session. lockwiki(); @@ -596,54 +693,32 @@ sub cgi (;$$) { #{{{ email => "", password => "", regdate => time, - }); + }) || error("failed adding user"); } } } + + 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); + } - # Everything below this point needs the user to be signed in. - if (((! $config{anonok} || $do eq 'prefs') && - (! defined $session->param("name") || - ! userinfo_get($session->param("name"), "regdate"))) - || $do eq 'signin') { - if ($do ne 'signin' && ! defined $session->param("postsignin")) { - $session->param(postsignin => $ENV{QUERY_STRING}); - } + run_hooks(sessioncgi => sub { shift->($q, $session) }); + + if ($do eq 'signin') { cgi_signin($q, $session); 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); - } elsif ($do eq 'prefs') { cgi_prefs($q, $session); } - elsif ($do eq 'blog') { - 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=""; - while (exists $pagecase{lc "$from/$page$add"}) { - $add=1 unless length $add; - $add++; - } - $q->param('page', $page.$add); - # now run same as create - $q->param('do', 'create'); + elsif ($do eq 'create' || $do eq 'edit') { cgi_editpage($q, $session); } elsif ($do eq 'postsignin') { @@ -678,7 +753,7 @@ sub userlink ($) { #{{{ else { return htmllink("", "", escapeHTML( length $config{userdir} ? $config{userdir}."/".$user : $user - ), 1); + ), noimageinline => 1); } } #}}}