move template documentation to the template directive

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

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index a45e12e3168c54540b22f72e95c28d35eef003e5..07369ac1076e748f8cd95e1aab5c2354a33877c8 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -9,19 +9,20 @@ use IkiWiki::UserInfo;
 use open qw{:utf8 :std};
 use Encode;
 
 use open qw{:utf8 :std};
 use Encode;
 

-sub printheader ($) { #{{{
+sub printheader ($) {

        my $session=shift;
        
        if ($config{sslcookie}) {
                print $session->header(-charset => 'utf-8',
                        -cookie => $session->cookie(-httponly => 1, -secure => 1));
        my $session=shift;
        
        if ($config{sslcookie}) {
                print $session->header(-charset => 'utf-8',
                        -cookie => $session->cookie(-httponly => 1, -secure => 1));

-       } else {
+       }
+       else {

                print $session->header(-charset => 'utf-8',
                        -cookie => $session->cookie(-httponly => 1));
        }
                print $session->header(-charset => 'utf-8',
                        -cookie => $session->cookie(-httponly => 1));
        }

-} #}}}
+}

 
 

-sub showform ($$$$;@) { #{{{
+sub showform ($$$$;@) {

        my $form=shift;
        my $buttons=shift;
        my $session=shift;
        my $form=shift;
        my $buttons=shift;
        my $session=shift;


@@ -36,11 +37,12 @@ sub showform ($$$$;@) { #{{{
 
        printheader($session);
        print misctemplate($form->title, $form->render(submit => $buttons), @_);
 
        printheader($session);
        print misctemplate($form->title, $form->render(submit => $buttons), @_);

-} #}}}
+}

 
 

-sub redirect ($$) { #{{{
+sub redirect ($$) {

        my $q=shift;
        my $q=shift;

-       my $url=shift;
+       eval q{use URI};
+       my $url=URI->new(shift);

        if (! $config{w3mmode}) {
                print $q->redirect($url);
        }
        if (! $config{w3mmode}) {
                print $q->redirect($url);
        }


@@ -48,33 +50,34 @@ sub redirect ($$) { #{{{
                print "Content-type: text/plain\n";
                print "W3m-control: GOTO $url\n\n";
        }
                print "Content-type: text/plain\n";
                print "W3m-control: GOTO $url\n\n";
        }

-} #}}}
+}

 
 

-sub decode_cgi_utf8 ($) { #{{{
-       # decode_form_utf8 method is needed for 5.10
+sub decode_cgi_utf8 ($) {
+       # decode_form_utf8 method is needed for 5.01

        if ($] < 5.01) {
                my $cgi = shift;
                foreach my $f ($cgi->param) {
                        $cgi->param($f, map { decode_utf8 $_ } $cgi->param($f));
                }
        }
        if ($] < 5.01) {
                my $cgi = shift;
                foreach my $f ($cgi->param) {
                        $cgi->param($f, map { decode_utf8 $_ } $cgi->param($f));
                }
        }

-} #}}}
+}

 
 

-sub decode_form_utf8 ($) { #{{{
+sub decode_form_utf8 ($) {

        if ($] >= 5.01) {
                my $form = shift;
                foreach my $f ($form->field) {
        if ($] >= 5.01) {
                my $form = shift;
                foreach my $f ($form->field) {

+                       my @value=map { decode_utf8($_) } $form->field($f);

                        $form->field(name  => $f,
                        $form->field(name  => $f,

-                                    value => decode_utf8($form->field($f)),
+                                    value => \@value,

                                     force => 1,
                        );
                }
        }
                                     force => 1,
                        );
                }
        }

-} #}}}
+}

 
 # Check if the user is signed in. If not, redirect to the signin form and
 # save their place to return to later.
 
 # 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;
 
        my $q=shift;
        my $session=shift;
 


@@ -85,9 +88,9 @@ sub needsignin ($$) { #{{{
                cgi_savesession($session);
                exit;
        }
                cgi_savesession($session);
                exit;
        }

-} #}}} 
+}

 
 

-sub cgi_signin ($$) { #{{{
+sub cgi_signin ($$) {

        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 


@@ -127,9 +130,9 @@ sub cgi_signin ($$) { #{{{
        }
 
        showform($form, $buttons, $session, $q);
        }
 
        showform($form, $buttons, $session, $q);

-} #}}}
+}

 
 

-sub cgi_postsignin ($$) { #{{{
+sub cgi_postsignin ($$) {

        my $q=shift;
        my $session=shift;
        
        my $q=shift;
        my $session=shift;
        


@@ -142,11 +145,16 @@ sub cgi_postsignin ($$) { #{{{
                exit;
        }
        else {
                exit;
        }
        else {

-               error(gettext("login failed, perhaps you need to turn on cookies?"));
+               if ($config{sslcookie} && ! $q->https()) {
+                       error(gettext("probable misconfiguration: sslcookie is set, but you are attempting to login via http, not https"));
+               }
+               else {
+                       error(gettext("login failed, perhaps you need to turn on cookies?"));
+               }

        }
        }

-} #}}}
+}

 
 

-sub cgi_prefs ($$) { #{{{
+sub cgi_prefs ($$) {

        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 


@@ -203,25 +211,9 @@ sub cgi_prefs ($$) { #{{{
        
        my $user_name=$session->param("name");
 
        
        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"));
        if (! $form->submitted) {
                $form->field(name => "email", force => 1,
                        value => userinfo_get($user_name, "email"));

-               if (is_admin($user_name)) {
-                       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");
-                       }
-               }

        }
        
        if ($form->submitted eq 'Logout') {
        }
        
        if ($form->submitted eq 'Logout') {


@@ -239,43 +231,61 @@ sub cgi_prefs ($$) { #{{{
                                error("failed to set 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);
                $form->text(gettext("Preferences saved."));
        }
        
        showform($form, $buttons, $session, $q);

-} #}}}
+}

 
 

-sub check_banned ($$) { #{{{
+sub cgi_custom_failure ($$$) {
+       my $q=shift;
+       my $httpstatus=shift;
+       my $message=shift;
+
+       print $q->header(
+               -status => $httpstatus,
+               -charset => 'utf-8',
+       );
+       print $message;
+
+       # Internet Explod^Hrer won't show custom 404 responses
+       # unless they're >= 512 bytes
+       print ' ' x 512;
+
+       exit;
+}
+
+sub check_banned ($$) {

        my $q=shift;
        my $session=shift;
 
        my $q=shift;
        my $session=shift;
 

+       my $banned=0;

        my $name=$session->param("name");
        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;
+       if (defined $name && 
+           grep { $name eq $_ } @{$config{banned_users}}) {
+               $banned=1;
+       }
+
+       foreach my $b (@{$config{banned_users}}) {
+               if (pagespec_match("", $b,
+                       ip => $ENV{REMOTE_ADDR},
+                       name => defined $name ? $name : "",
+               )) {
+                       $banned=1;
+                       last;

                }
        }
                }
        }

-} #}}}

 
 

-sub cgi_getsession ($) { #{{{
+       if ($banned) {
+               $session->delete();
+               cgi_savesession($session);
+               cgi_custom_failure(
+                       $q, "403 Forbidden",
+                       gettext("You are banned."));
+       }
+}
+
+sub cgi_getsession ($) {

        my $q=shift;
 
        eval q{use CGI::Session; use HTML::Entities};
        my $q=shift;
 
        eval q{use CGI::Session; use HTML::Entities};


@@ -294,13 +304,13 @@ sub cgi_getsession ($) { #{{{
        umask($oldmask);
 
        return $session;
        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.
 
 # 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 ($$) { # {{{
+sub checksessionexpiry ($$) {

        my $q=shift;
        my $session = shift;
 
        my $q=shift;
        my $session = shift;
 


@@ -310,18 +320,18 @@ sub checksessionexpiry ($$) { # {{{
                        error(gettext("Your login session has expired."));
                }
        }
                        error(gettext("Your login session has expired."));
                }
        }

-} # }}}
+}

 
 

-sub cgi_savesession ($) { #{{{
+sub cgi_savesession ($) {

        my $session=shift;
 
        # Force session flush with safe umask.
        my $oldmask=umask(077);
        $session->flush;
        umask($oldmask);
        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;
 
        my $q=shift;
        my $session=shift;
 


@@ -347,7 +357,7 @@ sub cgi (;$$) { #{{{
                        error("\"do\" parameter missing");
                }
        }
                        error("\"do\" parameter missing");
                }
        }

-       
+

        # Need to lock the wiki before getting a session.
        lockwiki();
        loadindex();
        # Need to lock the wiki before getting a session.
        lockwiki();
        loadindex();


@@ -391,16 +401,16 @@ sub cgi (;$$) { #{{{
        else {
                error("unknown do parameter");
        }
        else {
                error("unknown do parameter");
        }

-} #}}}
+}

 
 # Does not need to be called directly; all errors will go through here.
 
 # Does not need to be called directly; all errors will go through here.

-sub cgierror ($) { #{{{
+sub cgierror ($) {

        my $message=shift;
 
        print "Content-type: text/html\n\n";
        print misctemplate(gettext("Error"),
                "<p class=\"error\">".gettext("Error").": $message</p>");
        die $@;
        my $message=shift;
 
        print "Content-type: text/html\n\n";
        print misctemplate(gettext("Error"),
                "<p class=\"error\">".gettext("Error").": $message</p>");
        die $@;

-} #}}}
+}

 
 1
 
 1