]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/CGI.pm
wiki engine
[ikiwiki.git] / IkiWiki / CGI.pm
index b031aef56d4b744242c10f690f8cd3684c4b121a..af3bb8a4aca307f84bc63914978f312c6dddc301 100644 (file)
@@ -33,24 +33,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;
-                       error(htmllink("", "", $page, 1)." is locked by ".
-                             userlink($admin)." and cannot be edited.");
+       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 ($) { #{{{
@@ -88,7 +89,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}}
                ];
@@ -109,6 +112,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;
@@ -125,17 +145,16 @@ sub cgi_signin ($$) { #{{{
                params => $q,
                action => $config{cgiurl},
                header => 0,
-               template => (-e "$config{templatedir}/signin.tmpl" ?
-                            {template_params("signin.tmpl")} : ""),
+               template => scalar template_params("signin.tmpl"),
                stylesheet => baseurl()."style.css",
        );
        my $buttons=["Login"];
        
-       $form->field(name => "do", type => "hidden");
-       
        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."));
        }
+       $form->field(name => "do", type => "hidden", value => "signin",
+               force => 1);
        
        run_hooks(formbuilder_setup => sub {
                shift->(form => $form, cgi => $q, session => $session);
@@ -163,22 +182,19 @@ sub cgi_postsignin ($$) { #{{{
        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);
-               exit;
-       }
-       else {
-               redirect($q, $config{url});
-       }
+       my $postsignin=CGI->new($session->param("postsignin"));
+       $session->clear("postsignin");
+       cgi($postsignin, $session);
+       cgi_savesession($session);
+       exit;
 } #}}}
 
 sub cgi_prefs ($$) { #{{{
        my $q=shift;
        my $session=shift;
 
+       needsignin($q, $session);
+
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(
@@ -193,8 +209,7 @@ sub cgi_prefs ($$) { #{{{
                javascript => 0,
                params => $q,
                action => $config{cgiurl},
-               template => (-e "$config{templatedir}/prefs.tmpl" ?
-                            {template_params("prefs.tmpl")} : ""),
+               template => scalar template_params("prefs.tmpl"),
                stylesheet => baseurl()."style.css",
        );
        my $buttons=["Save Preferences", "Logout", "Cancel"];
@@ -206,14 +221,11 @@ sub cgi_prefs ($$) { #{{{
        $form->field(name => "do", type => "hidden");
        $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).")");
+               comment => "(".htmllink("", "", "PageSpec", noimageinline => 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");
        }
 
@@ -222,8 +234,6 @@ 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()));
@@ -241,17 +251,20 @@ sub cgi_prefs ($$) { #{{{
                redirect($q, $config{url});
                return;
        }
-       elsif ($form->submitted eq "Save Preferences" && $form->validate) {
-               foreach my $field (qw(email subscriptions locked_pages)) {
+       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");
+                               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("Preferences saved.");
+               $form->text(gettext("Preferences saved."));
        }
        
        if (exists $hooks{formbuilder}) {
@@ -273,15 +286,8 @@ sub cgi_editpage ($$) { #{{{
        my @fields=qw(do rcsinfo subpage from page type editcontent comments);
        my @buttons=("Save Page", "Preview", "Cancel");
        
-       eval q{use CGI::FormBuilder; use CGI::FormBuilder::Template::HTML};
+       eval q{use CGI::FormBuilder};
        error($@) if $@;
-       my $renderer=CGI::FormBuilder::Template::HTML->new(
-               fields => \@fields,
-               template_params("editpage.tmpl"),
-       );
-       run_hooks(pagetemplate => sub {
-               shift->(page => "", destpage => "", template => $renderer->engine);
-       });
        my $form = CGI::FormBuilder->new(
                fields => \@fields,
                header => 1,
@@ -295,7 +301,7 @@ sub cgi_editpage ($$) { #{{{
                params => $q,
                action => $config{cgiurl},
                table => 0,
-               template => $renderer,
+               template => scalar template_params("editpage.tmpl"),
        );
        
        run_hooks(formbuilder_setup => sub {
@@ -308,8 +314,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");
        }
        
@@ -323,6 +328,9 @@ sub cgi_editpage ($$) { #{{{
        if (exists $pagesources{$page}) {
                $file=$pagesources{$page};
                $type=pagetype($file);
+               if (! defined $type) {
+                       error(sprintf(gettext("%s is not an editable page"), $page));
+               }
        }
        else {
                $type=$form->param('type');
@@ -354,7 +362,7 @@ 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),
@@ -399,7 +407,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;
@@ -409,7 +417,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 {
@@ -423,18 +431,26 @@ sub cgi_editpage ($$) { #{{{
                                        push @page_locs, $dir.$page;
                                }
                        }
+                       push @page_locs, "$config{userdir}/$page"
+                               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}) {
@@ -443,13 +459,13 @@ sub cgi_editpage ($$) { #{{{
                        
                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',
-                               options => \@page_locs, value => $best_loc);
+                               options => \@editable_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);
+                       check_canedit($page, $q, $session);
                        if (! defined $form->field('editcontent') || 
                            ! length $form->field('editcontent')) {
                                my $content="";
@@ -463,35 +479,46 @@ 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);
        }
        else {
                # save page
-               page_locked($page, $session);
+               check_canedit($page, $q, $session);
                
                my $content=$form->field('editcontent');
 
                $content=~s/\r\n/\n/g;
                $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');
+
+               $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->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;
                }
                
                if ($config{rcs}) {
+                       my $message="";
+                       if (defined $form->field('comments') &&
+                           length $form->field('comments')) {
+                               $message=$form->field('comments');
+                       }
+                       
                        if ($newfile) {
                                rcs_add($file);
                        }
@@ -500,7 +527,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),
@@ -512,10 +540,16 @@ 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;
                        }
+                       else {
+                               # Make sure that the repo is up-to-date;
+                               # locking prevents the post-commit hook
+                               # from updating it.
+                               rcs_update();
+                       }
                }
                else {
                        require IkiWiki::Render;
@@ -529,12 +563,35 @@ sub cgi_editpage ($$) { #{{{
        }
 } #}}}
 
+sub cgi_getsession ($) { #{{{
+       my $q=shift;
+
+       eval q{use CGI::Session};
+       CGI::Session->name("ikiwiki_session_".encode_utf8($config{wikiname}));
+       
+       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; use CGI::Session};
+               eval q{use CGI};
                error($@) if $@;
        
                $q=CGI->new;
@@ -566,12 +623,7 @@ sub cgi (;$$) { #{{{
        lockwiki();
        
        if (! $session) {
-               CGI::Session->name("ikiwiki_session_".encode_utf8($config{wikiname}));
-       
-               my $oldmask=umask(077);
-               $session = CGI::Session->new("driver:DB_File", $q,
-                       { FileName => "$config{wikistatedir}/sessions.db" });
-               umask($oldmask);
+               $session=cgi_getsession($q);
        }
        
        # Auth hooks can sign a user in.
@@ -587,47 +639,34 @@ sub cgi (;$$) { #{{{
                                        email => "",
                                        password => "",
                                        regdate => time,
-                               });
+                               }) || error("failed adding user");
                        }
                }
        }
-
-       # 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});
-               }
-               cgi_signin($q, $session);
        
-               # Force session flush with safe umask.
-               my $oldmask=umask(077);
-               $session->flush;
-               umask($oldmask);
-               
-               return;
-       }
-       elsif (defined $session->param("postsignin")) {
-               cgi_postsignin($q, $session);
-       }
-
-       if (defined $session->param("name") && userinfo_get($session->param("name"), "banned")) {
+       if (defined $session->param("name") &&
+           userinfo_get($session->param("name"), "banned")) {
                print $q->header(-status => "403 Forbidden");
                $session->delete();
-               print "You are banned.";
-               exit;
+               print gettext("You are banned.");
+               cgi_savesession($session);
        }
-       
-       if ($do eq 'create' || $do eq 'edit') {
-               cgi_editpage($q, $session);
+       elsif ($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 '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="";
@@ -640,6 +679,9 @@ sub cgi (;$$) { #{{{
                $q->param('do', 'create');
                cgi_editpage($q, $session);
        }
+       elsif ($do eq 'postsignin') {
+               error(gettext("login failed, perhaps you need to turn on cookies?"));
+       }
        else {
                error("unknown do parameter");
        }
@@ -654,10 +696,22 @@ sub userlink ($) { #{{{
            eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
                # Munge user-urls, as used by eg, OpenID.
                my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
-               return "<a href=\"$user\">".escapeHTML($oid->display)."</a>";
+               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 "<a href=\"$user\">".escapeHTML($display)."</a>";
        }
        else {
-               return htmllink("", "", escapeHTML($user), 1);
+               return htmllink("", "", escapeHTML(
+                       length $config{userdir} ? $config{userdir}."/".$user : $user
+               ), noimageinline => 1);
        }
 } #}}}