* Support a w3mmode, which lets w3m run ikiwiki using its local CGI

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

diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm
index e5cee9cb95fb0acd5a9ded69287b3f652ab6732f..671f0b9248c463db5cbc9e4c5713217735760f8e 100644 (file)
--- a/IkiWiki/CGI.pm
+++ b/IkiWiki/CGI.pm
@@ -2,24 +2,39 @@
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

+use IkiWiki;

 use IkiWiki::UserInfo;
 use IkiWiki::UserInfo;

+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;
        my $nonfatal=shift;
        
        my $user=$session->param("name");
 sub page_locked ($$;$) { #{{{
        my $page=shift;
        my $session=shift;
        my $nonfatal=shift;
        
        my $user=$session->param("name");

-       return if length $user && is_admin($user);
+       return if defined $user && is_admin($user);

 
        foreach my $admin (@{$config{adminuser}}) {
                my $locked_pages=userinfo_get($admin, "locked_pages");
                if (globlist_match($page, userinfo_get($admin, "locked_pages"))) {
                        return 1 if $nonfatal;
 
        foreach my $admin (@{$config{adminuser}}) {
                my $locked_pages=userinfo_get($admin, "locked_pages");
                if (globlist_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.");
+                       error(htmllink("", "", $page, 1)." is locked by ".
+                             htmllink("", "", $admin, 1)." and cannot be edited.");

                }
        }
 
                }
        }
 


@@ -31,9 +46,14 @@ sub cgi_recentchanges ($) { #{{{
        
        unlockwiki();
 
        
        unlockwiki();
 

-       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(),


@@ -42,7 +62,7 @@ sub cgi_recentchanges ($) { #{{{
                styleurl => styleurl(),
                baseurl => "$config{url}/",
        );
                styleurl => styleurl(),
                baseurl => "$config{url}/",
        );

-       print $q->header, $template->output;
+       print $q->header(-charset=>'utf-8'), $template->output;

 } #}}}
 
 sub cgi_signin ($$) { #{{{
 } #}}}
 
 sub cgi_signin ($$) { #{{{


@@ -54,6 +74,7 @@ sub cgi_signin ($$) { #{{{
                title => "signin",
                fields => [qw(do title page subpage from name password confirm_password email)],
                header => 1,
                title => "signin",
                fields => [qw(do title page subpage from name password confirm_password email)],
                header => 1,

+               charset => "utf-8",

                method => 'POST',
                validate => {
                        confirm_password => {
                method => 'POST',
                validate => {
                        confirm_password => {


@@ -67,7 +88,7 @@ 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(),
        );
        


@@ -149,7 +170,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"),


@@ -158,7 +179,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') {


@@ -171,7 +192,7 @@ sub cgi_signin ($$) { #{{{
                                $form->field(name => "confirm_password", type => "hidden");
                                $form->field(name => "email", type => "hidden");
                                $form->text("Registration successful. Now you can Login.");
                                $form->field(name => "confirm_password", type => "hidden");
                                $form->field(name => "email", type => "hidden");
                                $form->text("Registration successful. Now you can Login.");

-                               print $session->header();
+                               print $session->header(-charset=>'utf-8');

                                print misctemplate($form->title, $form->render(submit => ["Login"]));
                        }
                        else {
                                print misctemplate($form->title, $form->render(submit => ["Login"]));
                        }
                        else {


@@ -180,9 +201,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"),


@@ -201,12 +220,12 @@ sub cgi_signin ($$) { #{{{
                        
                        $form->text("Your password has been emailed to you.");
                        $form->field(name => "name", required => 0);
                        
                        $form->text("Your password has been emailed to you.");
                        $form->field(name => "name", required => 0);

-                       print $session->header();
+                       print $session->header(-charset=>'utf-8');

                        print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
                }
        }
        else {
                        print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
                }
        }
        else {

-               print $session->header();
+               print $session->header(-charset=>'utf-8');

                print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
        }
 } #}}}
                print misctemplate($form->title, $form->render(submit => ["Login", "Register", "Mail Password"]));
        }
 } #}}}


@@ -221,6 +240,7 @@ sub cgi_prefs ($$) { #{{{
                fields => [qw(do name password confirm_password email 
                              subscriptions locked_pages)],
                header => 0,
                fields => [qw(do name password confirm_password email 
                              subscriptions locked_pages)],
                header => 0,

+               charset => "utf-8",

                method => 'POST',
                validate => {
                        confirm_password => {
                method => 'POST',
                validate => {
                        confirm_password => {


@@ -233,7 +253,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");


@@ -245,9 +265,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("", "", "GlobList", 1).")");

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

-               comment => "(".htmllink("", "GlobList", 1).")");
+               comment => "(".htmllink("", "", "GlobList", 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");


@@ -264,11 +284,11 @@ sub cgi_prefs ($$) { #{{{
        
        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) {


@@ -280,7 +300,7 @@ sub cgi_prefs ($$) { #{{{
                $form->text("Preferences saved.");
        }
        
                $form->text("Preferences saved.");
        }
        

-       print $session->header();
+       print $session->header(-charset=>'utf-8');

        print misctemplate($form->title, $form->render(submit => \@buttons));
 } #}}}
 
        print misctemplate($form->title, $form->render(submit => \@buttons));
 } #}}}
 


@@ -290,34 +310,39 @@ 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 content comments)],
+               fields => [qw(do rcsinfo subpage from page editcontent comments)],

                header => 1,
                header => 1,

+               charset => "utf-8",

                method => 'POST',
                validate => {
                method => 'POST',
                validate => {

-                       content => '/.+/',
+                       editcontent => '/.+/',

                },
                },

-               required => [qw{content}],
+               required => [qw{editcontent}],

                javascript => 0,
                params => $q,
                action => $config{cgiurl},
                table => 0,
                javascript => 0,
                params => $q,
                action => $config{cgiurl},
                table => 0,

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

        );
        my @buttons=("Save Page", "Preview", "Cancel");
        
        # This untaint is safe because titlepage removes any problimatic
        # characters.
        );
        my @buttons=("Save Page", "Preview", "Cancel");
        
        # This untaint is safe because titlepage removes any problimatic
        # characters.

-       my ($page)=titlepage(possibly_foolish_untaint(lc($form->param('page'))));
+       my ($page)=decode_utf8($form->param('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};
+       my $file;

        if (exists $pagesources{lc($page)}) {
                $file=$pagesources{lc($page)};
        }
        if (exists $pagesources{lc($page)}) {
                $file=$pagesources{lc($page)};
        }

+       else {
+               $file=$page.".".$config{default_pageext};
+       }

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


@@ -329,12 +354,12 @@ sub cgi_editpage ($$) { #{{{
        $form->field(name => "subpage", type => 'hidden');
        $form->field(name => "page", value => "$page", force => 1);
        $form->field(name => "comments", type => "text", size => 80);
        $form->field(name => "subpage", type => 'hidden');
        $form->field(name => "page", value => "$page", force => 1);
        $form->field(name => "comments", type => "text", size => 80);

-       $form->field(name => "content", type => "textarea", rows => 20,
+       $form->field(name => "editcontent", type => "textarea", rows => 20,

                cols => 80);
        $form->tmpl_param("can_commit", $config{rcs});
        $form->tmpl_param("indexlink", indexlink());
        $form->tmpl_param("helponformattinglink",
                cols => 80);
        $form->tmpl_param("can_commit", $config{rcs});
        $form->tmpl_param("indexlink", indexlink());
        $form->tmpl_param("helponformattinglink",

-               htmllink("", "HelpOnFormatting", 1));
+               htmllink("", "", "HelpOnFormatting", 1));

        $form->tmpl_param("styleurl", styleurl());
        $form->tmpl_param("baseurl", "$config{url}/");
        if (! $form->submitted) {
        $form->tmpl_param("styleurl", styleurl());
        $form->tmpl_param("baseurl", "$config{url}/");
        if (! $form->submitted) {


@@ -343,14 +368,22 @@ 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.
+               my $content=decode_utf8($form->field('editcontent'));
+               my $comments=decode_utf8($form->field('comments'));
+               $form->field(name => "editcontent",
+                               value => $content, force => 1);
+               $form->field(name => "comments",
+                               value => $comments, force => 1);

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

-                       htmlize($config{default_pageext},
-                               linkify($form->field('content'), $page)));
+                       htmlize(pagetype($file),
+                               linkify($page, $page, $content)));

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


@@ -360,13 +393,6 @@ sub cgi_editpage ($$) { #{{{
        if (! $form->submitted || $form->submitted eq "Preview" || 
            ! $form->validate) {
                if ($form->field("do") eq "create") {
        if (! $form->submitted || $form->submitted eq "Preview" || 
            ! $form->validate) {
                if ($form->field("do") eq "create") {

-                       if (exists $pagesources{lc($page)}) {
-                               # hmm, someone else made the page in the
-                               # meantime?
-                               print $q->redirect("$config{url}/".htmlpage($page));
-                               return;
-                       }
-                       

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


@@ -395,13 +421,20 @@ sub cgi_editpage ($$) { #{{{
                                        $dir=~s![^/]+/+$!!;
                                        push @page_locs, $dir.$page;
                                }
                                        $dir=~s![^/]+/+$!!;
                                        push @page_locs, $dir.$page;
                                }

-
-                               @page_locs = grep {
-                                       ! exists $pagesources{lc($_)} &&
-                                       ! page_locked($_, $session, 1)
-                               } @page_locs;

                        }
 
                        }
 

+                       @page_locs = grep {
+                               ! exists $pagesources{lc($_)} &&
+                               ! page_locked($_, $session, 1)
+                       } @page_locs;
+                       
+                       if (! @page_locs) {
+                               # hmm, someone else made the page in the
+                               # meantime?
+                               redirect($q, "$config{url}/".htmlpage($page));
+                               return;
+                       }
+                               

                        $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);


@@ -409,14 +442,14 @@ sub cgi_editpage ($$) { #{{{
                }
                elsif ($form->field("do") eq "edit") {
                        page_locked($page, $session);
                }
                elsif ($form->field("do") eq "edit") {
                        page_locked($page, $session);

-                       if (! defined $form->field('content') || 
-                           ! length $form->field('content')) {
+                       if (! defined $form->field('editcontent') || 
+                           ! length $form->field('editcontent')) {

                                my $content="";
                                if (exists $pagesources{lc($page)}) {
                                        $content=readfile(srcfile($pagesources{lc($page)}));
                                        $content=~s/\n/\r\n/g;
                                }
                                my $content="";
                                if (exists $pagesources{lc($page)}) {
                                        $content=readfile(srcfile($pagesources{lc($page)}));
                                        $content=~s/\n/\r\n/g;
                                }

-                               $form->field(name => "content", value => $content,
+                               $form->field(name => "editcontent", value => $content,

                                        force => 1);
                        }
                        $form->tmpl_param("page_select", 0);
                                        force => 1);
                        }
                        $form->tmpl_param("page_select", 0);


@@ -430,13 +463,16 @@ sub cgi_editpage ($$) { #{{{
                # save page
                page_locked($page, $session);
                
                # save page
                page_locked($page, $session);
                

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

                $content=~s/\r\n/\n/g;
                $content=~s/\r/\n/g;
                writefile($file, $config{srcdir}, $content);
                
                my $message="web commit ";
                $content=~s/\r\n/\n/g;
                $content=~s/\r/\n/g;
                writefile($file, $config{srcdir}, $content);
                
                my $message="web commit ";

-               if (length $session->param("name")) {
+               if (defined $session->param("name") && 
+                   length $session->param("name")) {

                        $message.="by ".$session->param("name");
                }
                else {
                        $message.="by ".$session->param("name");
                }
                else {


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

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

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


@@ -462,7 +498,8 @@ sub cgi_editpage ($$) { #{{{
                                $form->field(name => "rcsinfo", value => rcs_prepedit($file),
                                        force => 1);
                                $form->tmpl_param("page_conflict", 1);
                                $form->field(name => "rcsinfo", value => rcs_prepedit($file),
                                        force => 1);
                                $form->tmpl_param("page_conflict", 1);

-                               $form->field("content", value => $conflict, force => 1);
+                               $form->field("editcontent", value => $conflict, force => 1);
+                               $form->field(name => "comments", value => decode_utf8($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');


@@ -479,30 +516,25 @@ 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");

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

-sub cgi_hyperestraier () { #{{{
-       # only works for GET requests
-       chdir("$config{wikistatedir}/hyperestraier") || error("chdir: $!");
-       exec("./".basename($config{cgiurl})) || error("estseek.cgi failed");
-} #}}}
-

 sub cgi () { #{{{
        eval q{use CGI};
        eval q{use CGI::Session};
        
        my $q=CGI->new;
        
 sub cgi () { #{{{
        eval q{use CGI};
        eval q{use CGI::Session};
        
        my $q=CGI->new;
        

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

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

-               if (defined $q->param('phrase')) {
-                       cgi_hyperestraier();
-               }
-               else {
-                       error("\"do\" parameter missing");
-               }
+               error("\"do\" parameter missing");

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