tone back claims of what tidy can do, it's not perfect

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

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index d9c9fe82896c8f5a52490ccb7be3147684ace455..f69f02a15af2396d51c3e116ada1cb8be3652d22 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -4,10 +4,23 @@ use warnings;
 use strict;
 use IkiWiki;
 use IkiWiki::UserInfo;
 use strict;
 use IkiWiki;
 use IkiWiki::UserInfo;

-use encoding 'utf8'; # force use of utf8 for io layer
+use open qw{:utf8 :std};
+use Encode;

 
 package IkiWiki;
 
 
 package IkiWiki;
 

+sub redirect ($$) { #{{{
+       my $q=shift;
+       my $url=shift;
+       if (! $config{w3mmode}) {
+               print $q->redirect($url);
+       }
+       else {
+               print "Content-type: text/plain\n";
+               print "W3m-control: GOTO $url\n\n";
+       }
+} #}}}
+

 sub page_locked ($$;$) { #{{{
        my $page=shift;
        my $session=shift;
 sub page_locked ($$;$) { #{{{
        my $page=shift;
        my $session=shift;


@@ -18,7 +31,7 @@ sub page_locked ($$;$) { #{{{
 
        foreach my $admin (@{$config{adminuser}}) {
                my $locked_pages=userinfo_get($admin, "locked_pages");
 
        foreach my $admin (@{$config{adminuser}}) {
                my $locked_pages=userinfo_get($admin, "locked_pages");

-               if (globlist_match($page, 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 ".
                              htmllink("", "", $admin, 1)." and cannot be edited.");
                        return 1 if $nonfatal;
                        error(htmllink("", "", $page, 1)." is locked by ".
                              htmllink("", "", $admin, 1)." and cannot be edited.");


@@ -28,19 +41,30 @@ sub page_locked ($$;$) { #{{{
        return 0;
 } #}}}
 
        return 0;
 } #}}}
 

+sub decode_form_utf8 ($) { #{{{
+       my $form = shift;
+       foreach my $f ($form->field) {
+               next if Encode::is_utf8(scalar $form->field($f));
+               $form->field(name  => $f,
+                            value => decode_utf8($form->field($f)),
+                            force => 1,
+                           );
+       }
+} #}}}
+

 sub cgi_recentchanges ($) { #{{{
        my $q=shift;
        
        unlockwiki();
 
 sub cgi_recentchanges ($) { #{{{
        my $q=shift;
        
        unlockwiki();
 

-       # Force reading the template as utf-8, necessary if
-       # rcs_recentchanges returns true utf-8 strings.
-       open(TMPL, "<:utf8", "$config{templatedir}/recentchanges.tmpl");
-       my $template=HTML::Template->new(filehandle => *TMPL);
-       close(TMPL);
-       my $template=HTML::Template->new(
-               filename => "$config{templatedir}/recentchanges.tmpl"
-       );
+       # Optimisation: building recentchanges means calculating lots of
+       # links. Memoizing htmllink speeds it up a lot (can't be memoized
+       # during page builds as the return values may change, but they
+       # won't here.)
+       eval q{use Memoize};
+       memoize("htmllink");
+
+       my $template=template("recentchanges.tmpl"); 

        $template->param(
                title => "RecentChanges",
                indexlink => indexlink(),
        $template->param(
                title => "RecentChanges",
                indexlink => indexlink(),


@@ -75,9 +99,11 @@ sub cgi_signin ($$) { #{{{
                action => $config{cgiurl},
                header => 0,
                template => (-e "$config{templatedir}/signin.tmpl" ?
                action => $config{cgiurl},
                header => 0,
                template => (-e "$config{templatedir}/signin.tmpl" ?

-                             "$config{templatedir}/signin.tmpl" : ""),
+                            {template_params("signin.tmpl")} : ""),

                stylesheet => styleurl(),
        );
                stylesheet => styleurl(),
        );

+               
+       decode_form_utf8($form);

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


@@ -88,7 +114,7 @@ sub cgi_signin ($$) { #{{{
        $form->field(name => "password", type => "password", required => 0);
        $form->field(name => "confirm_password", type => "password", required => 0);
        $form->field(name => "email", required => 0);
        $form->field(name => "password", type => "password", required => 0);
        $form->field(name => "confirm_password", type => "password", required => 0);
        $form->field(name => "email", required => 0);

-       if ($q->param("do") ne "signin") {
+       if ($q->param("do") ne "signin" && !$form->submitted) {

                $form->text("You need to log in first.");
        }
        
                $form->text("You need to log in first.");
        }
        


@@ -157,7 +183,7 @@ sub cgi_signin ($$) { #{{{
                        $session->param("name", $form->field("name"));
                        if (defined $form->field("do") && 
                            $form->field("do") ne 'signin') {
                        $session->param("name", $form->field("name"));
                        if (defined $form->field("do") && 
                            $form->field("do") ne 'signin') {

-                               print $q->redirect(cgiurl(
+                               redirect($q, cgiurl(

                                        do => $form->field("do"),
                                        page => $form->field("page"),
                                        title => $form->field("title"),
                                        do => $form->field("do"),
                                        page => $form->field("page"),
                                        title => $form->field("title"),


@@ -166,7 +192,7 @@ sub cgi_signin ($$) { #{{{
                                ));
                        }
                        else {
                                ));
                        }
                        else {

-                               print $q->redirect($config{url});
+                               redirect($q, $config{url});

                        }
                }
                elsif ($form->submitted eq 'Register') {
                        }
                }
                elsif ($form->submitted eq 'Register') {


@@ -188,9 +214,7 @@ sub cgi_signin ($$) { #{{{
                }
                elsif ($form->submitted eq 'Mail Password') {
                        my $user_name=$form->field("name");
                }
                elsif ($form->submitted eq 'Mail Password') {
                        my $user_name=$form->field("name");

-                       my $template=HTML::Template->new(
-                               filename => "$config{templatedir}/passwordmail.tmpl"
-                       );
+                       my $template=template("passwordmail.tmpl");

                        $template->param(
                                user_name => $user_name,
                                user_password => userinfo_get($user_name, "password"),
                        $template->param(
                                user_name => $user_name,
                                user_password => userinfo_get($user_name, "password"),


@@ -242,7 +266,7 @@ sub cgi_prefs ($$) { #{{{
                params => $q,
                action => $config{cgiurl},
                template => (-e "$config{templatedir}/prefs.tmpl" ?
                params => $q,
                action => $config{cgiurl},
                template => (-e "$config{templatedir}/prefs.tmpl" ?

-                             "$config{templatedir}/prefs.tmpl" : ""),
+                            {template_params("prefs.tmpl")} : ""),

                stylesheet => styleurl(),
        );
        my @buttons=("Save Preferences", "Logout", "Cancel");
                stylesheet => styleurl(),
        );
        my @buttons=("Save Preferences", "Logout", "Cancel");


@@ -254,9 +278,9 @@ sub cgi_prefs ($$) { #{{{
        $form->field(name => "password", type => "password");
        $form->field(name => "confirm_password", type => "password");
        $form->field(name => "subscriptions", size => 50,
        $form->field(name => "password", type => "password");
        $form->field(name => "confirm_password", type => "password");
        $form->field(name => "subscriptions", size => 50,

-               comment => "(".htmllink("", "", "GlobList", 1).")");
+               comment => "(".htmllink("", "", "PageSpec", 1).")");

        $form->field(name => "locked_pages", size => 50,
        $form->field(name => "locked_pages", size => 50,

-               comment => "(".htmllink("", "", "GlobList", 1).")");
+               comment => "(".htmllink("", "", "PageSpec", 1).")");

        
        if (! is_admin($user_name)) {
                $form->field(name => "locked_pages", type => "hidden");
        
        if (! is_admin($user_name)) {
                $form->field(name => "locked_pages", type => "hidden");


@@ -271,13 +295,15 @@ sub cgi_prefs ($$) { #{{{
                        value => userinfo_get($user_name, "locked_pages"));
        }
        
                        value => userinfo_get($user_name, "locked_pages"));
        }
        

+       decode_form_utf8($form);
+       

        if ($form->submitted eq 'Logout') {
                $session->delete();
        if ($form->submitted eq 'Logout') {
                $session->delete();

-               print $q->redirect($config{url});
+               redirect($q, $config{url});

                return;
        }
        elsif ($form->submitted eq 'Cancel') {
                return;
        }
        elsif ($form->submitted eq 'Cancel') {

-               print $q->redirect($config{url});
+               redirect($q, $config{url});

                return;
        }
        elsif ($form->submitted eq "Save Preferences" && $form->validate) {
                return;
        }
        elsif ($form->submitted eq "Save Preferences" && $form->validate) {


@@ -299,7 +325,7 @@ sub cgi_editpage ($$) { #{{{
 
        eval q{use CGI::FormBuilder};
        my $form = CGI::FormBuilder->new(
 
        eval q{use CGI::FormBuilder};
        my $form = CGI::FormBuilder->new(

-               fields => [qw(do rcsinfo subpage from page editcontent comments)],
+               fields => [qw(do rcsinfo subpage from page type editcontent comments)],

                header => 1,
                charset => "utf-8",
                method => 'POST',
                header => 1,
                charset => "utf-8",
                method => 'POST',


@@ -311,23 +337,48 @@ sub cgi_editpage ($$) { #{{{
                params => $q,
                action => $config{cgiurl},
                table => 0,
                params => $q,
                action => $config{cgiurl},
                table => 0,

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

        );
        my @buttons=("Save Page", "Preview", "Cancel");
        
        );
        my @buttons=("Save Page", "Preview", "Cancel");
        

-       # This untaint is safe because titlepage removes any problimatic
+       decode_form_utf8($form);
+       
+       # This untaint is safe because titlepage removes any problematic

        # characters.
        # characters.

-       my ($page)=titlepage(possibly_foolish_untaint(lc($form->param('page'))));
+       my ($page)=$form->field('page');
+       $page=titlepage(possibly_foolish_untaint(lc($page)));

        if (! defined $page || ! length $page ||
            $page=~/$config{wiki_file_prune_regexp}/ || $page=~/^\//) {
                error("bad page name");
        }
        $page=lc($page);
        
        if (! defined $page || ! length $page ||
            $page=~/$config{wiki_file_prune_regexp}/ || $page=~/^\//) {
                error("bad page name");
        }
        $page=lc($page);
        

-       my $file=$page.$config{default_pageext};
-       if (exists $pagesources{lc($page)}) {
-               $file=$pagesources{lc($page)};
+       my $from;
+       if (defined $form->field('from')) {
+               ($from)=$form->field('from')=~/$config{wiki_file_regexp}/;
+       }
+       
+       my $file;
+       my $type;       
+       if (exists $pagesources{$page}) {
+               $file=$pagesources{$page};
+               $type=pagetype($file);

        }
        }

+       else {
+               $type=$form->param('type');
+               if (defined $type && length $type && $hooks{htmlize}{$type}) {
+                       $type=possibly_foolish_untaint($type);
+               }
+               elsif (defined $from) {
+                       # favor the type of linking page
+                       $type=pagetype($pagesources{$from});
+               }
+               else {
+                       $type=$config{default_pageext};
+               }
+               $file=$page.".".$type;
+       }
+

        my $newfile=0;
        if (! -e "$config{srcdir}/$file") {
                $newfile=1;
        my $newfile=0;
        if (! -e "$config{srcdir}/$file") {
                $newfile=1;


@@ -337,7 +388,8 @@ sub cgi_editpage ($$) { #{{{
        $form->field(name => "from", type => 'hidden');
        $form->field(name => "rcsinfo", type => 'hidden');
        $form->field(name => "subpage", type => 'hidden');
        $form->field(name => "from", type => 'hidden');
        $form->field(name => "rcsinfo", type => 'hidden');
        $form->field(name => "subpage", type => 'hidden');

-       $form->field(name => "page", value => "$page", 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,
                cols => 80);
        $form->field(name => "comments", type => "text", size => 80);
        $form->field(name => "editcontent", type => "textarea", rows => 20,
                cols => 80);


@@ -353,22 +405,19 @@ sub cgi_editpage ($$) { #{{{
        }
        
        if ($form->submitted eq "Cancel") {
        }
        
        if ($form->submitted eq "Cancel") {

-               print $q->redirect("$config{url}/".htmlpage($page));
+               redirect($q, "$config{url}/".htmlpage($page));

                return;
        }
        elsif ($form->submitted eq "Preview") {
                require IkiWiki::Render;
                return;
        }
        elsif ($form->submitted eq "Preview") {
                require IkiWiki::Render;

-               # Apparently FormBuilder doesn't not treat input as
-               # utf-8, so decode from it.
-               require Encode;
-               my $content = Encode::decode_utf8($form->field('editcontent'));
+               my $content=$form->field('editcontent');
+               my $comments=$form->field('comments');

                $form->field(name => "editcontent",
                                value => $content, force => 1);
                $form->field(name => "comments",
                $form->field(name => "editcontent",
                                value => $content, force => 1);
                $form->field(name => "comments",

-                               value => Encode::decode_utf8($form->field('comments')), force => 1);
+                               value => $comments, force => 1);

                $form->tmpl_param("page_preview",
                $form->tmpl_param("page_preview",

-                       htmlize($config{default_pageext},
-                               linkify($page, $page, $content)));
+                       htmlize($type, linkify($page, $page, filter($page, $content))));

        }
        else {
                $form->tmpl_param("page_preview", "");
        }
        else {
                $form->tmpl_param("page_preview", "");


@@ -380,9 +429,8 @@ sub cgi_editpage ($$) { #{{{
                if ($form->field("do") eq "create") {
                        my @page_locs;
                        my $best_loc;
                if ($form->field("do") eq "create") {
                        my @page_locs;
                        my $best_loc;

-                       my ($from)=$form->param('from')=~/$config{wiki_file_regexp}/;

                        if (! defined $from || ! length $from ||
                        if (! defined $from || ! length $from ||

-                           $from ne $form->param('from') ||
+                           $from ne $form->field('from') ||

                            $from=~/$config{wiki_file_prune_regexp}/ ||
                            $from=~/^\// ||
                            $form->submitted eq "Preview") {
                            $from=~/$config{wiki_file_prune_regexp}/ ||
                            $from=~/^\// ||
                            $form->submitted eq "Preview") {


@@ -392,7 +440,7 @@ sub cgi_editpage ($$) { #{{{
                                my $dir=$from."/";
                                $dir=~s![^/]+/+$!!;
                                
                                my $dir=$from."/";
                                $dir=~s![^/]+/+$!!;
                                

-                               if ((defined $form->param('subpage') && length $form->param('subpage')) ||
+                               if ((defined $form->field('subpage') && length $form->field('subpage')) ||

                                    $page eq 'discussion') {
                                        $best_loc="$from/$page";
                                }
                                    $page eq 'discussion') {
                                        $best_loc="$from/$page";
                                }


@@ -416,13 +464,20 @@ sub cgi_editpage ($$) { #{{{
                        if (! @page_locs) {
                                # hmm, someone else made the page in the
                                # meantime?
                        if (! @page_locs) {
                                # hmm, someone else made the page in the
                                # meantime?

-                               print $q->redirect("$config{url}/".htmlpage($page));
+                               redirect($q, "$config{url}/".htmlpage($page));

                                return;
                        }
                                return;
                        }

-                               
+                       
+                       my @page_types;
+                       if (exists $hooks{htmlize}) {
+                               @page_types=keys %{$hooks{htmlize}};
+                       }
+                       

                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',
                                options => \@page_locs, value => $best_loc);
                        $form->tmpl_param("page_select", 1);
                        $form->field(name => "page", type => 'select',
                                options => \@page_locs, value => $best_loc);

+                       $form->field(name => "type", type => 'select',
+                               options => \@page_types);

                        $form->title("creating ".pagetitle($page));
                }
                elsif ($form->field("do") eq "edit") {
                        $form->title("creating ".pagetitle($page));
                }
                elsif ($form->field("do") eq "edit") {


@@ -439,6 +494,7 @@ sub cgi_editpage ($$) { #{{{
                        }
                        $form->tmpl_param("page_select", 0);
                        $form->field(name => "page", 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("editing ".pagetitle($page));
                }
                


@@ -448,9 +504,7 @@ sub cgi_editpage ($$) { #{{{
                # save page
                page_locked($page, $session);
                
                # save page
                page_locked($page, $session);
                

-               # Decode utf-8 since FormBuilder does not
-               require Encode;
-               my $content=Encode::decode_utf8($form->field('editcontent'));
+               my $content=$form->field('editcontent');

 
                $content=~s/\r\n/\n/g;
                $content=~s/\r/\n/g;
 
                $content=~s/\r\n/\n/g;
                $content=~s/\r/\n/g;


@@ -466,7 +520,7 @@ sub cgi_editpage ($$) { #{{{
                }
                if (defined $form->field('comments') &&
                    length $form->field('comments')) {
                }
                if (defined $form->field('comments') &&
                    length $form->field('comments')) {

-                       $message.=Encode::decode_utf8(": ".$form->field('comments'));
+                       $message.=": ".$form->field('comments');

                }
                
                if ($config{rcs}) {
                }
                
                if ($config{rcs}) {


@@ -485,10 +539,11 @@ sub cgi_editpage ($$) { #{{{
                                        force => 1);
                                $form->tmpl_param("page_conflict", 1);
                                $form->field("editcontent", value => $conflict, force => 1);
                                        force => 1);
                                $form->tmpl_param("page_conflict", 1);
                                $form->field("editcontent", value => $conflict, force => 1);

-                               $form->field(name => "comments", value => Encode::decode_utf8($form->field('comments')), 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("do", "edit)");
                                $form->tmpl_param("page_select", 0);
                                $form->field(name => "page", type => 'hidden');

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

                                $form->title("editing $page");
                                print $form->render(submit => \@buttons);
                                return;
                                $form->title("editing $page");
                                print $form->render(submit => \@buttons);
                                return;


@@ -502,7 +557,7 @@ sub cgi_editpage ($$) { #{{{
                
                # The trailing question mark tries to avoid broken
                # caches and get the most recent version of the page.
                
                # The trailing question mark tries to avoid broken
                # caches and get the most recent version of the page.

-               print $q->redirect("$config{url}/".htmlpage($page)."?updated");
+               redirect($q, "$config{url}/".htmlpage($page)."?updated");

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


@@ -512,15 +567,17 @@ sub cgi () { #{{{
        
        my $q=CGI->new;
        
        
        my $q=CGI->new;
        

-       if (exists $hooks{cgi}) {
-               foreach my $id (keys %{$hooks{cgi}}) {
-                       $hooks{cgi}{$id}{call}->($q);
-               }
-       }
+       run_hooks(cgi => sub { shift->($q) });

        
        my $do=$q->param('do');
        if (! defined $do || ! length $do) {
        
        my $do=$q->param('do');
        if (! defined $do || ! length $do) {

-               error("\"do\" parameter missing");
+               my $error = $q->cgi_error;
+               if ($error) {
+                       error("Request not processed: $error");
+               }
+               else {
+                       error("\"do\" parameter missing");
+               }

        }
        
        # Things that do not need a session.
        }
        
        # Things that do not need a session.