simplified plugin definitions

[git.ikiwiki.info.git] / IkiWiki / CGI.pm

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index d00de740a1c11554b890009c887fcbd3b7719cac..6c489df8dc7f724582b3aadd82ba34d6f7b2a947 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -33,24 +33,25 @@ sub redirect ($$) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

-sub page_locked ($$;$) { #{{{
+sub check_canedit ($$$;$) { #{{{

        my $page=shift;
        my $page=shift;

+       my $q=shift;

        my $session=shift;
        my $nonfatal=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 ($) { #{{{
 } #}}}
 
 sub decode_form_utf8 ($) { #{{{


@@ -88,7 +89,7 @@ sub cgi_recentchanges ($) { #{{{
                delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
                $change->{pages} = [
                        map {
                delete @{$change->{pages}}[10 .. @{$change->{pages}}] if $is_excess;
                $change->{pages} = [
                        map {

-                               $_->{link} = htmllink("", "", $_->{page}, 1);
+                               $_->{link} = htmllink("", "", $_->{page}, 1, 0, pagetitle($_->{page}));

                                $_;
                        } @{$change->{pages}}
                ];
                                $_;
                        } @{$change->{pages}}
                ];


@@ -109,6 +110,23 @@ sub cgi_recentchanges ($) { #{{{
        print $q->header(-charset => 'utf-8'), $template->output;
 } #}}}
 
        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;
 sub cgi_signin ($$) { #{{{
        my $q=shift;
        my $session=shift;


@@ -125,17 +143,16 @@ sub cgi_signin ($$) { #{{{
                params => $q,
                action => $config{cgiurl},
                header => 0,
                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"];
        
                stylesheet => baseurl()."style.css",
        );
        my $buttons=["Login"];
        

-       $form->field(name => "do", type => "hidden");
-       

        if ($q->param("do") ne "signin" && !$form->submitted) {
        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);
        
        run_hooks(formbuilder_setup => sub {
                shift->(form => $form, cgi => $q, session => $session);


@@ -163,23 +180,19 @@ sub cgi_postsignin ($$) { #{{{
        my $session=shift;
 
        # Continue with whatever was being done before the signin process.
        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 {
-               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;
 
 } #}}}
 
 sub cgi_prefs ($$) { #{{{
        my $q=shift;
        my $session=shift;
 

+       needsignin($q, $session);
+

        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(


@@ -194,8 +207,7 @@ sub cgi_prefs ($$) { #{{{
                javascript => 0,
                params => $q,
                action => $config{cgiurl},
                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"];
                stylesheet => baseurl()."style.css",
        );
        my $buttons=["Save Preferences", "Logout", "Cancel"];


@@ -208,13 +220,10 @@ sub cgi_prefs ($$) { #{{{
        $form->field(name => "email", size => 50);
        $form->field(name => "subscriptions", size => 50,
                comment => "(".htmllink("", "", "PageSpec", 1).")");
        $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 => "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");
        }
 
                $form->field(name => "banned_users", type => "hidden");
        }
 


@@ -223,8 +232,6 @@ sub cgi_prefs ($$) { #{{{
                        value => userinfo_get($user_name, "email"));
                $form->field(name => "subscriptions", force => 1,
                        value => userinfo_get($user_name, "subscriptions"));
                        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()));
                if (is_admin($user_name)) {
                        $form->field(name => "banned_users", force => 1,
                                value => join(" ", get_banned_users()));


@@ -242,8 +249,8 @@ sub cgi_prefs ($$) { #{{{
                redirect($q, $config{url});
                return;
        }
                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");
                        }
                        if (defined $form->field($field) && length $form->field($field)) {
                                userinfo_set($user_name, $field, $form->field($field)) || error("failed to set $field");
                        }


@@ -252,7 +259,7 @@ sub cgi_prefs ($$) { #{{{
                        set_banned_users(grep { ! is_admin($_) }
                                        split(' ', $form->field("banned_users")));
                }
                        set_banned_users(grep { ! is_admin($_) }
                                        split(' ', $form->field("banned_users")));
                }

-               $form->text("Preferences saved.");
+               $form->text(gettext("Preferences saved."));

        }
        
        if (exists $hooks{formbuilder}) {
        }
        
        if (exists $hooks{formbuilder}) {


@@ -289,8 +296,7 @@ sub cgi_editpage ($$) { #{{{
                params => $q,
                action => $config{cgiurl},
                table => 0,
                params => $q,
                action => $config{cgiurl},
                table => 0,

-               template => (-e "$config{templatedir}/editpage.tmpl" ?
-                               {template_params("editpage.tmpl")} : ""),
+               template => scalar template_params("editpage.tmpl"),

        );
        
        run_hooks(formbuilder_setup => sub {
        );
        
        run_hooks(formbuilder_setup => sub {


@@ -303,8 +309,7 @@ sub cgi_editpage ($$) { #{{{
        # characters.
        my ($page)=$form->field('page');
        $page=titlepage(possibly_foolish_untaint($page));
        # 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");
        }
        
                error("bad page name");
        }
        


@@ -318,6 +323,9 @@ sub cgi_editpage ($$) { #{{{
        if (exists $pagesources{$page}) {
                $file=$pagesources{$page};
                $type=pagetype($file);
        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');
        }
        else {
                $type=$form->param('type');


@@ -394,7 +402,7 @@ sub cgi_editpage ($$) { #{{{
                        my $best_loc;
                        if (! defined $from || ! length $from ||
                            $from ne $form->field('from') ||
                        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;
                            $from=~/^\// ||
                            $form->submitted eq "Preview") {
                                @page_locs=$best_loc=$page;


@@ -404,7 +412,7 @@ sub cgi_editpage ($$) { #{{{
                                $dir=~s![^/]+/+$!!;
                                
                                if ((defined $form->field('subpage') && length $form->field('subpage')) ||
                                $dir=~s![^/]+/+$!!;
                                
                                if ((defined $form->field('subpage') && length $form->field('subpage')) ||

-                                   $page eq 'discussion') {
+                                   $page eq gettext('discussion')) {

                                        $best_loc="$from/$page";
                                }
                                else {
                                        $best_loc="$from/$page";
                                }
                                else {


@@ -418,18 +426,26 @@ sub cgi_editpage ($$) { #{{{
                                        push @page_locs, $dir.$page;
                                }
                        }
                                        push @page_locs, $dir.$page;
                                }
                        }

+                       push @page_locs, "$config{userdir}/$page"
+                               if length $config{userdir};

 
                        @page_locs = grep {
 
                        @page_locs = grep {

-                               ! exists $pagecase{lc $_} &&
-                               ! page_locked($_, $session, 1)
+                               ! exists $pagecase{lc $_}

                        } @page_locs;
                        } @page_locs;

-                       

                        if (! @page_locs) {
                                # hmm, someone else made the page in the
                                # meantime?
                                redirect($q, "$config{url}/".htmlpage($page));
                                return;
                        }
                        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}) {
                        
                        my @page_types;
                        if (exists $hooks{htmlize}) {


@@ -438,13 +454,13 @@ sub cgi_editpage ($$) { #{{{
                        
                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',
                        
                        $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->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") {
                }
                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="";
                        if (! defined $form->field('editcontent') || 
                            ! length $form->field('editcontent')) {
                                my $content="";


@@ -458,14 +474,14 @@ sub cgi_editpage ($$) { #{{{
                        $form->tmpl_param("page_select", 0);
                        $form->field(name => "page", type => 'hidden');
                        $form->field(name => "type", type => 'hidden');
                        $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
                }
                
                print $form->render(submit => \@buttons);
        }
        else {
                # save page

-               page_locked($page, $session);
+               check_canedit($page, $q, $session);

                
                my $content=$form->field('editcontent');
 
                
                my $content=$form->field('editcontent');
 


@@ -501,10 +517,16 @@ sub cgi_editpage ($$) { #{{{
                                $form->tmpl_param("page_select", 0);
                                $form->field(name => "page", type => 'hidden');
                                $form->field(name => "type", type => 'hidden');
                                $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;
                        }
                                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;
                }
                else {
                        require IkiWiki::Render;


@@ -539,7 +561,7 @@ sub cgi_savesession ($) { #{{{
        my $oldmask=umask(077);
        $session->flush;
        umask($oldmask);
        my $oldmask=umask(077);
        $session->flush;
        umask($oldmask);

-}
+} #}}}

 
 sub cgi (;$$) { #{{{
        my $q=shift;
 
 sub cgi (;$$) { #{{{
        my $q=shift;


@@ -598,39 +620,30 @@ sub cgi (;$$) { #{{{
                        }
                }
        }
                        }
                }
        }

-
-       # 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});
-               }
+       
+       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);
+       }
+       elsif ($do eq 'signin') {

                cgi_signin($q, $session);
                cgi_savesession($session);
                cgi_signin($q, $session);
                cgi_savesession($session);

-               return;

        }
        elsif (defined $session->param("postsignin")) {
                cgi_postsignin($q, $session);
        }
        }
        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 "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 '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')));
        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="";
                # if the page already exists, munge it to be unique
                my $from=$q->param('from');
                my $add="";


@@ -643,6 +656,9 @@ sub cgi (;$$) { #{{{
                $q->param('do', 'create');
                cgi_editpage($q, $session);
        }
                $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");
        }
        else {
                error("unknown do parameter");
        }


@@ -662,11 +678,17 @@ sub userlink ($) { #{{{
                if ($display !~ /\[/) {
                        $display=~s/^(.*?)\.([^.]+\.[a-z]+)$/$1 [$2]/;
                }
                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 {
                $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
+               ), 1);

        }
 } #}}}
 
        }
 } #}}}