standardising and documenting getsetup

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

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index 781974c13d5c8dde65e772bc0c4c3f952fc0f958..4cb45895b964c8872be96104f88ceda78e5efb85 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -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;
        
@@ -78,9 +78,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 +142,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;
@@ -197,11 +214,13 @@ 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", value => "prefs",
                force => 1);
@@ -256,13 +275,12 @@ sub cgi_editpage ($$) { #{{{
        my $session=shift;
        
        decode_cgi_utf8($q);
-       
+
        my @fields=qw(do rcsinfo subpage from page type editcontent comments);
        my @buttons=("Save Page", "Preview", "Cancel");
        eval q{use CGI::FormBuilder};
        error($@) if $@;
        my $form = CGI::FormBuilder->new(
-               title => "editpage",
                fields => \@fields,
                charset => "utf-8",
                method => 'POST',
@@ -276,17 +294,19 @@ 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");
        }
 
@@ -334,7 +354,7 @@ sub cgi_editpage ($$) { #{{{
        $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,
@@ -366,6 +386,7 @@ sub cgi_editpage ($$) { #{{{
                }
 
                my $content=$form->field('editcontent');
+
                run_hooks(editcontent => sub {
                        $content=shift->(
                                content => $content,
@@ -374,12 +395,18 @@ sub cgi_editpage ($$) { #{{{
                                session => $session,
                        );
                });
-               $form->tmpl_param("page_preview",
-                       htmlize($page, $type,
+               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};
                }
@@ -389,7 +416,6 @@ sub cgi_editpage ($$) { #{{{
        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") {
@@ -398,7 +424,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;
                        }
@@ -459,8 +486,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)));
@@ -504,7 +531,7 @@ sub cgi_editpage ($$) { #{{{
 
                if ($form->field("do") ne "create" && ! $exists &&
                    ! defined srcfile($file, 1)) {
-                       $form->tmpl_param("page_gone", 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');
@@ -514,7 +541,7 @@ sub cgi_editpage ($$) { #{{{
                        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');
@@ -547,8 +574,9 @@ 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');
@@ -592,7 +620,7 @@ 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);
@@ -615,11 +643,18 @@ 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;
@@ -638,11 +673,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) });
        }
@@ -712,4 +750,14 @@ sub cgi (;$$) { #{{{
        }
 } #}}}
 
+# Does not need tobe 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