po: add comments

[git.ikiwiki.info.git] / IkiWiki / Plugin / poll.pm

diff --git a/IkiWiki/Plugin/poll.pm b/IkiWiki/Plugin/poll.pm
index 56034b60ad766654c599849c16c965e93f7162d8..fadc1773e66a61758d0012991e32da66d5ae0209 100644 (file)
--- a/IkiWiki/Plugin/poll.pm
+++ b/IkiWiki/Plugin/poll.pm
@@ -3,25 +3,30 @@ package IkiWiki::Plugin::poll;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use IkiWiki;
+use IkiWiki 2.00;
+use Encode;

 
 sub import { #{{{
 
 sub import { #{{{

+       hook(type => "getsetup", id => "poll", call => \&getsetup);

        hook(type => "preprocess", id => "poll", call => \&preprocess);
        hook(type => "preprocess", id => "poll", call => \&preprocess);

-       hook(type => "cgi", id => "poll", call => \&cgi);
+       hook(type => "sessioncgi", id => "poll", call => \&sessioncgi);

 } # }}}
 
 } # }}}
 

-sub yesno ($) { #{{{
-       my $val=shift;
-       return (defined $val && lc($val) eq "yes");
+sub getsetup () { #{{{
+       return 
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },

 } #}}}
 
 my %pagenum;
 sub preprocess (@) { #{{{
        my %params=(open => "yes", total => "yes", percent => "yes", @_);
 
 } #}}}
 
 my %pagenum;
 sub preprocess (@) { #{{{
        my %params=(open => "yes", total => "yes", percent => "yes", @_);
 

-       my $open=yesno($params{open});
-       my $showtotal=yesno($params{total});
-       my $showpercent=yesno($params{percent});
+       my $open=IkiWiki::yesno($params{open});
+       my $showtotal=IkiWiki::yesno($params{total});
+       my $showpercent=IkiWiki::yesno($params{percent});

        $pagenum{$params{page}}++;
 
        my %choices;
        $pagenum{$params{page}}++;
 
        my %choices;


@@ -45,7 +50,8 @@ sub preprocess (@) { #{{{
        my $ret="";
        foreach my $choice (@choices) {
                if ($open && exists $config{cgiurl}) {
        my $ret="";
        foreach my $choice (@choices) {
                if ($open && exists $config{cgiurl}) {

-                       $ret.="<form action=\"$config{cgiurl}\">\n";
+                       # use POST to avoid robots
+                       $ret.="<form method=\"POST\" action=\"$config{cgiurl}\">\n";

                }
                my $percent=$total > 0 ? int($choices{$choice} / $total * 100) : 0;
                $ret.="<p>\n";
                }
                my $percent=$total > 0 ? int($choices{$choice} / $total * 100) : 0;
                $ret.="<p>\n";


@@ -60,7 +66,7 @@ sub preprocess (@) { #{{{
                        $ret.="<input type=\"hidden\" name=\"num\" value=\"$pagenum{$params{page}}\" />\n";
                        $ret.="<input type=\"hidden\" name=\"page\" value=\"$params{page}\" />\n";
                        $ret.="<input type=\"hidden\" name=\"choice\" value=\"$choice\" />\n";
                        $ret.="<input type=\"hidden\" name=\"num\" value=\"$pagenum{$params{page}}\" />\n";
                        $ret.="<input type=\"hidden\" name=\"page\" value=\"$params{page}\" />\n";
                        $ret.="<input type=\"hidden\" name=\"choice\" value=\"$choice\" />\n";

-                       $ret.="<input type=\"submit\" value=\"vote\" />\n";
+                       $ret.="<input type=\"submit\" value=\"".gettext("vote")."\" />\n";

                }
                $ret.="</p>\n<hr class=poll align=left width=\"$percent%\"/>\n";
                if ($open && exists $config{cgiurl}) {
                }
                $ret.="</p>\n<hr class=poll align=left width=\"$percent%\"/>\n";
                if ($open && exists $config{cgiurl}) {


@@ -68,15 +74,16 @@ sub preprocess (@) { #{{{
                }
        }
        if ($showtotal) {
                }
        }
        if ($showtotal) {

-               $ret.="<span>Total votes: $total</span>\n";
+               $ret.="<span>".gettext("Total votes:")." $total</span>\n";

        }
        return "<div class=poll>$ret</div>";
 } # }}}
 
        }
        return "<div class=poll>$ret</div>";
 } # }}}
 

-sub cgi ($) { #{{{
+sub sessioncgi ($$) { #{{{

        my $cgi=shift;
        my $cgi=shift;

+       my $session=shift;

        if (defined $cgi->param('do') && $cgi->param('do') eq "poll") {
        if (defined $cgi->param('do') && $cgi->param('do') eq "poll") {

-               my $choice=$cgi->param('choice');
+               my $choice=decode_utf8($cgi->param('choice'));

                if (! defined $choice) {
                        error("no choice specified");
                }
                if (! defined $choice) {
                        error("no choice specified");
                }


@@ -91,15 +98,16 @@ sub cgi ($) { #{{{
 
                # Did they vote before? If so, let them change their vote,
                # and check for dups.
 
                # Did they vote before? If so, let them change their vote,
                # and check for dups.

-               my $session=IkiWiki::cgi_getsession();

                my $choice_param="poll_choice_${page}_$num";
                my $oldchoice=$session->param($choice_param);
                if (defined $oldchoice && $oldchoice eq $choice) {
                        # Same vote; no-op.
                my $choice_param="poll_choice_${page}_$num";
                my $oldchoice=$session->param($choice_param);
                if (defined $oldchoice && $oldchoice eq $choice) {
                        # Same vote; no-op.

-                       IkiWiki::redirect($cgi, "$config{url}/".htmlpage($page));
+                       IkiWiki::redirect($cgi, urlto($page, undef, 1));

                        exit;
                }
 
                        exit;
                }
 

+               my $prefix=$config{prefix_directives} ? "!poll" : "poll";
+

                my $content=readfile(srcfile($pagesources{$page}));
                # Now parse the content, find the right poll,
                # and find the choice within it, and increment its number.
                my $content=readfile(srcfile($pagesources{$page}));
                # Now parse the content, find the right poll,
                # and find the choice within it, and increment its number.


@@ -107,16 +115,16 @@ sub cgi ($) { #{{{
                my $edit=sub {
                        my $escape=shift;
                        my $params=shift;
                my $edit=sub {
                        my $escape=shift;
                        my $params=shift;

-                       return "\\[[poll $params]]" if $escape;
+                       return "\\[[$prefix $params]]" if $escape;

                        if (--$num == 0) {
                                $params=~s/(^|\s+)(\d+)\s+"?\Q$choice\E"?(\s+|$)/$1.($2+1)." \"$choice\"".$3/se;
                                if (defined $oldchoice) {
                                        $params=~s/(^|\s+)(\d+)\s+"?\Q$oldchoice\E"?(\s+|$)/$1.($2-1 >=0 ? $2-1 : 0)." \"$oldchoice\"".$3/se;
                                }
                        }
                        if (--$num == 0) {
                                $params=~s/(^|\s+)(\d+)\s+"?\Q$choice\E"?(\s+|$)/$1.($2+1)." \"$choice\"".$3/se;
                                if (defined $oldchoice) {
                                        $params=~s/(^|\s+)(\d+)\s+"?\Q$oldchoice\E"?(\s+|$)/$1.($2-1 >=0 ? $2-1 : 0)." \"$oldchoice\"".$3/se;
                                }
                        }

-                       return "[[poll $params]]";
+                       return "[[$prefix $params]]";

                };
                };

-               $content =~ s{(\\?)\[\[poll\s+([^]]+)\s*\]\]}{$edit->($1, $2)}seg;
+               $content =~ s{(\\?)\[\[\Q$prefix\E\s+([^]]+)\s*\]\]}{$edit->($1, $2)}seg;

 
                # Store their vote, update the page, and redirect to it.
                writefile($pagesources{$page}, $config{srcdir}, $content);
 
                # Store their vote, update the page, and redirect to it.
                writefile($pagesources{$page}, $config{srcdir}, $content);


@@ -124,24 +132,24 @@ sub cgi ($) { #{{{
                IkiWiki::cgi_savesession($session);
                $oldchoice=$session->param($choice_param);
                if ($config{rcs}) {
                IkiWiki::cgi_savesession($session);
                $oldchoice=$session->param($choice_param);
                if ($config{rcs}) {

-                       # prevent deadlock with post-commit hook
-                       IkiWiki::unlockwiki();
-                       IkiWiki::rcs_commit($pagesources{$page}, "poll vote",
+                       IkiWiki::disable_commit_hook();
+                       IkiWiki::rcs_commit($pagesources{$page}, "poll vote ($choice)",

                                IkiWiki::rcs_prepedit($pagesources{$page}),
                                $session->param("name"), $ENV{REMOTE_ADDR});
                                IkiWiki::rcs_prepedit($pagesources{$page}),
                                $session->param("name"), $ENV{REMOTE_ADDR});

+                       IkiWiki::enable_commit_hook();
+                       IkiWiki::rcs_update();

                }
                }

-               else {
-                       require IkiWiki::Render;
-                       IkiWiki::refresh();
-                       IkiWiki::saveindex();
-               }
+               require IkiWiki::Render;
+               IkiWiki::refresh();
+               IkiWiki::saveindex();
+

                # Need to set cookie in same http response that does the
                # redir.
                eval q{use CGI::Cookie};
                error($@) if $@;
                my $cookie = CGI::Cookie->new(-name=> $session->name, -value=> $session->id);
                print $cgi->redirect(-cookie => $cookie,
                # Need to set cookie in same http response that does the
                # redir.
                eval q{use CGI::Cookie};
                error($@) if $@;
                my $cookie = CGI::Cookie->new(-name=> $session->name, -value=> $session->id);
                print $cgi->redirect(-cookie => $cookie,

-                       -url => "$config{url}/".htmlpage($page));
+                       -url => urlto($page, undef, 1));

                exit;
        }
 } #}}}
                exit;
        }
 } #}}}