]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/CGI.pm
remove incorrect comment
[git.ikiwiki.info.git] / IkiWiki / CGI.pm
index cfb2c0b1d8e39447581d0fb16606c8ff3fac7243..a050434782c6445d8cb9d05738305bee3ea5833e 100644 (file)
@@ -1,5 +1,7 @@
 #!/usr/bin/perl
 
+package IkiWiki;
+
 use warnings;
 use strict;
 use IkiWiki;
@@ -7,8 +9,6 @@ use IkiWiki::UserInfo;
 use open qw{:utf8 :std};
 use Encode;
 
-package IkiWiki;
-
 sub printheader ($) { #{{{
        my $session=shift;
        
@@ -18,10 +18,9 @@ sub printheader ($) { #{{{
        } else {
                print $session->header(-charset => 'utf-8');
        }
-
 } #}}}
 
-sub showform ($$$$) { #{{{
+sub showform ($$$$;@) { #{{{
        my $form=shift;
        my $buttons=shift;
        my $session=shift;
@@ -35,7 +34,7 @@ sub showform ($$$$) { #{{{
        }
 
        printheader($session);
-       print misctemplate($form->title, $form->render(submit => $buttons));
+       print misctemplate($form->title, $form->render(submit => $buttons), @_);
 }
 
 sub redirect ($$) { #{{{
@@ -78,9 +77,24 @@ sub check_canedit ($$$;$) { #{{{
 } #}}}
 
 sub decode_cgi_utf8 ($) { #{{{
-       my $cgi = shift;
-       foreach my $f ($cgi->param) {
-               $cgi->param($f, map { decode_utf8 $_ } $cgi->param($f));
+       # decode_form_utf8 method is needed for 5.10
+       if ($] < 5.01) {
+               my $cgi = shift;
+               foreach my $f ($cgi->param) {
+                       $cgi->param($f, map { decode_utf8 $_ } $cgi->param($f));
+               }
+       }
+} #}}}
+
+sub decode_form_utf8 ($) { #{{{
+       if ($] >= 5.01) {
+               my $form = shift;
+               foreach my $f ($form->field) {
+                       $form->field(name  => $f,
+                                    value => decode_utf8($form->field($f)),
+                                    force => 1,
+                       );
+               }
        }
 } #}}}
 
@@ -127,10 +141,12 @@ sub cgi_signin ($$) { #{{{
        $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,
                        buttons => $buttons);
        });
+       decode_form_utf8($form);
 
        if ($form->submitted) {
                $form->validate;
@@ -161,8 +177,18 @@ sub cgi_prefs ($$) { #{{{
        my $session=shift;
 
        needsignin($q, $session);
-
        decode_cgi_utf8($q);
+       
+       # The session id is stored on the form and checked to
+       # guard against CSRF.
+       my $sid=$q->param('sid');
+       if (! defined $sid) {
+               $q->delete_all;
+       }
+       elsif ($sid ne $session->id) {
+               error(gettext("Your login session has expired."));
+       }
+
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(
@@ -187,28 +213,40 @@ sub cgi_prefs ($$) { #{{{
                ],
        );
        my $buttons=["Save Preferences", "Logout", "Cancel"];
-
+       
+       decode_form_utf8($form);
        run_hooks(formbuilder_setup => sub {
                shift->(form => $form, cgi => $q, session => $session,
                        buttons => $buttons);
        });
+       decode_form_utf8($form);
        
-       $form->field(name => "do", type => "hidden");
+       $form->field(name => "do", type => "hidden", value => "prefs",
+               force => 1);
+       $form->field(name => "sid", type => "hidden", value => $session->id,
+               force => 1);
        $form->field(name => "email", size => 50, fieldset => "preferences");
-       $form->field(name => "banned_users", size => 50,
-               fieldset => "admin");
        
        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 (is_admin($user_name)) {
-                       $form->field(name => "banned_users", force => 1,
-                               value => join(" ", get_banned_users()));
+                       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");
+                       }
                }
        }
        
@@ -226,12 +264,18 @@ sub cgi_prefs ($$) { #{{{
                        userinfo_set($user_name, 'email', $form->field('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."));
        }
        
@@ -241,15 +285,14 @@ sub cgi_prefs ($$) { #{{{
 sub cgi_editpage ($$) { #{{{
        my $q=shift;
        my $session=shift;
+       
+       decode_cgi_utf8($q);
 
        my @fields=qw(do rcsinfo subpage from page type editcontent comments);
        my @buttons=("Save Page", "Preview", "Cancel");
-       
-       decode_cgi_utf8($q);
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(
-               title => "editpage",
                fields => \@fields,
                charset => "utf-8",
                method => 'POST',
@@ -263,19 +306,23 @@ sub cgi_editpage ($$) { #{{{
                wikiname => $config{wikiname},
        );
        
+       decode_form_utf8($form);
        run_hooks(formbuilder_setup => sub {
                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));
+       # This untaint is safe because we check file_pruned.
+       my $page=$form->field('page');
+       $page=possibly_foolish_untaint($page);
+       my $absolute=($page =~ s#^/+##);
        if (! defined $page || ! length $page ||
-           file_pruned($page, $config{srcdir}) || $page=~/^\//) {
+           file_pruned($page, $config{srcdir})) {
                error("bad page name");
        }
+
+       my $baseurl=$config{url}."/".htmlpage($page);
        
        my $from;
        if (defined $form->field('from')) {
@@ -314,10 +361,12 @@ sub cgi_editpage ($$) { #{{{
        }
 
        $form->field(name => "do", type => 'hidden');
+       $form->field(name => "sid", type => "hidden", value => $session->id,
+               force => 1);
        $form->field(name => "from", type => 'hidden');
        $form->field(name => "rcsinfo", type => 'hidden');
        $form->field(name => "subpage", type => 'hidden');
-       $form->field(name => "page", value => pagetitle($page, 1), force => 1);
+       $form->field(name => "page", value => $page, 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,
@@ -325,10 +374,9 @@ sub cgi_editpage ($$) { #{{{
        $form->tmpl_param("can_commit", $config{rcs});
        $form->tmpl_param("indexlink", indexlink());
        $form->tmpl_param("helponformattinglink",
-               htmllink("", "", "ikiwiki/formatting",
+               htmllink($page, $page, "ikiwiki/formatting",
                        noimageinline => 1,
                        linktext => "FormattingHelp"));
-       $form->tmpl_param("baseurl", baseurl());
        
        if ($form->submitted eq "Cancel") {
                if ($form->field("do") eq "create" && defined $from) {
@@ -343,7 +391,14 @@ sub cgi_editpage ($$) { #{{{
                return;
        }
        elsif ($form->submitted eq "Preview") {
+               my $new=not exists $pagesources{$page};
+               if ($new) {
+                       # temporarily record its type
+                       $pagesources{$page}=$page.".".$type;
+               }
+
                my $content=$form->field('editcontent');
+
                run_hooks(editcontent => sub {
                        $content=shift->(
                                content => $content,
@@ -352,18 +407,27 @@ sub cgi_editpage ($$) { #{{{
                                session => $session,
                        );
                });
-               $form->tmpl_param("page_preview",
-                       htmlize($page, $type,
-                       linkify($page, "",
+               my $preview=htmlize($page, $page, $type,
+                       linkify($page, $page,
                        preprocess($page, $page,
-                       filter($page, $page, $content), 0, 1))));
+                       filter($page, $page, $content), 0, 1)));
+               run_hooks(format => sub {
+                       $preview=shift->(
+                               page => $page,
+                               content => $preview,
+                       );
+               });
+               $form->tmpl_param("page_preview", $preview);
+       
+               if ($new) {
+                       delete $pagesources{$page};
+               }
                # previewing may have created files on disk
                saveindex();
        }
        elsif ($form->submitted eq "Save Page") {
                $form->tmpl_param("page_preview", "");
        }
-       $form->tmpl_param("page_conflict", "");
        
        if ($form->submitted ne "Save Page" || ! $form->validate) {
                if ($form->field("do") eq "create") {
@@ -372,7 +436,8 @@ sub cgi_editpage ($$) { #{{{
                        if (! defined $from || ! length $from ||
                            $from ne $form->field('from') ||
                            file_pruned($from, $config{srcdir}) ||
-                           $from=~/^\// ||
+                           $from=~/^\// || 
+                           $absolute ||
                            $form->submitted eq "Preview") {
                                @page_locs=$best_loc=$page;
                        }
@@ -433,8 +498,8 @@ sub cgi_editpage ($$) { #{{{
                        
                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',
-                               options => [ map { pagetitle($_, 1) } @editable_locs ],
-                               value => pagetitle($best_loc, 1));
+                               options => [ map { [ $_, pagetitle($_, 1) ] } @editable_locs ],
+                               value => $best_loc);
                        $form->field(name => "type", type => 'select',
                                options => \@page_types);
                        $form->title(sprintf(gettext("creating %s"), pagetitle($page)));
@@ -458,27 +523,37 @@ sub cgi_editpage ($$) { #{{{
                        $form->title(sprintf(gettext("editing %s"), pagetitle($page)));
                }
                
-               showform($form, \@buttons, $session, $q);
+               showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
        }
        else {
                # save page
                check_canedit($page, $q, $session);
+       
+               # The session id is stored on the form and checked to
+               # guard against CSRF. But only if the user is logged in,
+               # as anonok can allow anonymous edits.
+               if (defined $session->param("name")) {
+                       my $sid=$q->param('sid');
+                       if (! defined $sid || $sid ne $session->id) {
+                               error(gettext("Your login session has expired."));
+                       }
+               }
 
                my $exists=-e "$config{srcdir}/$file";
 
                if ($form->field("do") ne "create" && ! $exists &&
-                   ! eval { srcfile($file) }) {
-                       $form->tmpl_param("page_gone", 1);
+                   ! defined srcfile($file, 1)) {
+                       $form->tmpl_param("message", template("editpagegone.tmpl")->output);
                        $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);
+                       showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
                        return;
                }
                elsif ($form->field("do") eq "create" && $exists) {
-                       $form->tmpl_param("creation_conflict", 1);
+                       $form->tmpl_param("message", template("editcreationconflict.tmpl")->output);
                        $form->field(name => "do", value => "edit", force => 1);
                        $form->tmpl_param("page_select", 0);
                        $form->field(name => "page", type => 'hidden');
@@ -488,7 +563,7 @@ sub cgi_editpage ($$) { #{{{
                                value => readfile("$config{srcdir}/$file").
                                         "\n\n\n".$form->field("editcontent"),
                                force => 1);
-                       showform($form, \@buttons, $session, $q);
+                       showform($form, \@buttons, $session, $q, forcebaseurl => $baseurl);
                        return;
                }
                
@@ -511,14 +586,16 @@ sub cgi_editpage ($$) { #{{{
                if ($@) {
                        $form->field(name => "rcsinfo", value => rcs_prepedit($file),
                                force => 1);
-                       $form->tmpl_param("failed_save", 1);
-                       $form->tmpl_param("error_message", $@);
+                       my $mtemplate=template("editfailedsave.tmpl");
+                       $mtemplate->param(error_message => $@);
+                       $form->tmpl_param("message", $mtemplate->output);
                        $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);
+                       showform($form, \@buttons, $session, $q,
+                               forcebaseurl => $baseurl);
                        return;
                }
                
@@ -555,14 +632,15 @@ sub cgi_editpage ($$) { #{{{
                if (defined $conflict) {
                        $form->field(name => "rcsinfo", value => rcs_prepedit($file),
                                force => 1);
-                       $form->tmpl_param("page_conflict", 1);
+                       $form->tmpl_param("message", template("editconflict.tmpl")->output);
                        $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);
+                       showform($form, \@buttons, $session, $q,
+                               forcebaseurl => $baseurl);
                        return;
                }
                else {
@@ -572,16 +650,42 @@ sub cgi_editpage ($$) { #{{{
                }
        }
 } #}}}
+       
+sub check_banned ($$) { #{{{
+       my $q=shift;
+       my $session=shift;
+
+       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;
+               }
+       }
+}
 
 sub cgi_getsession ($) { #{{{
        my $q=shift;
 
        eval q{use CGI::Session};
+       error($@) if $@;
        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" });
+       my $session = eval {
+               CGI::Session->new("driver:DB_File", $q,
+                       { FileName => "$config{wikistatedir}/sessions.db" })
+       };
+       if (! $session || $@) {
+               error($@." ".CGI::Session->errstr());
+       }
+       
        umask($oldmask);
 
        return $session;
@@ -600,11 +704,14 @@ sub cgi (;$$) { #{{{
        my $q=shift;
        my $session=shift;
 
+       eval q{use CGI};
+       error($@) if $@;
+       $CGI::DISABLE_UPLOADS=$config{cgi_disable_uploads};
+
        if (! $q) {
-               eval q{use CGI};
-               error($@) if $@;
-       
+               binmode(STDIN);
                $q=CGI->new;
+               binmode(STDIN, ":utf8");
        
                run_hooks(cgi => sub { shift->($q) });
        }
@@ -646,14 +753,8 @@ sub cgi (;$$) { #{{{
                }
        }
        
-       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);
-       }
-
+       check_banned($q, $session);
+       
        run_hooks(sessioncgi => sub { shift->($q, $session) });
 
        if ($do eq 'signin') {
@@ -674,4 +775,14 @@ sub cgi (;$$) { #{{{
        }
 } #}}}
 
+# Does not need to be called directly; all errors will go through here.
+sub cgierror ($) { #{{{
+       my $message=shift;
+
+       print "Content-type: text/html\n\n";
+       print misctemplate(gettext("Error"),
+               "<p class=\"error\">".gettext("Error").": $message</p>");
+       die $@;
+} #}}}
+
 1