Fix escaping of filenames in historyurl. (Thanks, aj)

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 8f8472f075f20c69e57578b75041c4ce145224f1..a39dab36cdb81e6c06049d9c0bc312a6e58b1dd2 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -22,12 +22,16 @@ sub import {
        hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
        hook(type => "getsetup", id => 'comments',  call => \&getsetup);
        hook(type => "preprocess", id => 'comment', call => \&preprocess);
        hook(type => "checkconfig", id => 'comments',  call => \&checkconfig);
        hook(type => "getsetup", id => 'comments',  call => \&getsetup);
        hook(type => "preprocess", id => 'comment', call => \&preprocess);

+       hook(type => "preprocess", id => 'commentmoderation', call => \&preprocess_moderation);

        # here for backwards compatability with old comments
        hook(type => "preprocess", id => '_comment', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);
        # here for backwards compatability with old comments
        hook(type => "preprocess", id => '_comment', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);

+       hook(type => "htmlize", id => "_comment_pending",
+               call => \&htmlize_pending);

        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);

-       hook(type => "formbuilder_setup", id => "comments", call => \&formbuilder_setup);
+       hook(type => "formbuilder_setup", id => "comments",
+               call => \&formbuilder_setup);

        # Load goto to fix up user page links for logged-in commenters
        IkiWiki::loadplugin("goto");
        IkiWiki::loadplugin("inline");
        # Load goto to fix up user page links for logged-in commenters
        IkiWiki::loadplugin("goto");
        IkiWiki::loadplugin("inline");


@@ -104,6 +108,14 @@ sub htmlize {
        return $params{content};
 }
 
        return $params{content};
 }
 

+sub htmlize_pending {
+       my %params = @_;
+       return sprintf(gettext("this comment needs %s"),
+               '<a href="'.
+               IkiWiki::cgiurl(do => "commentmoderation").'">'.
+               gettext("moderation").'</a>');
+}
+

 # FIXME: copied verbatim from meta
 sub safeurl ($) {
        my $url=shift;
 # FIXME: copied verbatim from meta
 sub safeurl ($) {
        my $url=shift;


@@ -131,8 +143,6 @@ sub preprocess {
        }
        $content =~ s/\\"/"/g;
 
        }
        $content =~ s/\\"/"/g;
 

-       $content = IkiWiki::filter($page, $params{destpage}, $content);
-

        if ($config{comments_allowdirectives}) {
                $content = IkiWiki::preprocess($page, $params{destpage},
                        $content);
        if ($config{comments_allowdirectives}) {
                $content = IkiWiki::preprocess($page, $params{destpage},
                        $content);


@@ -166,7 +176,7 @@ sub preprocess {
                if (defined $oiduser) {
                        # looks like an OpenID
                        $commentauthorurl = $commentuser;
                if (defined $oiduser) {
                        # looks like an OpenID
                        $commentauthorurl = $commentuser;

-                       $commentauthor = $oiduser;
+                       $commentauthor = (defined $params{nickname} && length $params{nickname}) ? $params{nickname} : $oiduser;

                        $commentopenid = $commentuser;
                }
                else {
                        $commentopenid = $commentuser;
                }
                else {


@@ -221,7 +231,9 @@ sub preprocess {
        }
 
        if (defined $params{subject}) {
        }
 
        if (defined $params{subject}) {

-               $pagestate{$page}{meta}{title} = $params{subject};
+               # decode title the same way meta does
+               eval q{use HTML::Entities};
+               $pagestate{$page}{meta}{title} = decode_entities($params{subject});

        }
 
        if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {
        }
 
        if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {


@@ -238,6 +250,22 @@ sub preprocess {
        return $content;
 }
 
        return $content;
 }
 

+sub preprocess_moderation {
+       my %params = @_;
+
+       $params{desc}=gettext("Comment Moderation")
+               unless defined $params{desc};
+
+       if (length $config{cgiurl}) {
+               return '<a href="'.
+                       IkiWiki::cgiurl(do => 'commentmoderation').
+                       '">'.$params{desc}.'</a>';
+       }
+       else {
+               return $params{desc};
+       }
+}
+

 sub sessioncgi ($$) {
        my $cgi=shift;
        my $session=shift;
 sub sessioncgi ($$) {
        my $cgi=shift;
        my $session=shift;


@@ -249,6 +277,10 @@ sub sessioncgi ($$) {
        elsif ($do eq 'commentmoderation') {
                commentmoderation($cgi, $session);
        }
        elsif ($do eq 'commentmoderation') {
                commentmoderation($cgi, $session);
        }

+       elsif ($do eq 'commentsignin') {
+               IkiWiki::cgi_signin($cgi, $session);
+               exit;
+       }

 }
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage
 }
 
 # Mostly cargo-culted from IkiWiki::plugin::editpage


@@ -272,7 +304,7 @@ sub editcomment ($$) {
                action => $config{cgiurl},
                header => 0,
                table => 0,
                action => $config{cgiurl},
                header => 0,
                table => 0,

-               template => scalar IkiWiki::template_params('editcomment.tmpl'),
+               template => { template('editcomment.tmpl') },

        );
 
        IkiWiki::decode_form_utf8($form);
        );
 
        IkiWiki::decode_form_utf8($form);


@@ -326,7 +358,7 @@ sub editcomment ($$) {
 
        if (! defined $session->param('name')) {
                # Make signinurl work and return here.
 
        if (! defined $session->param('name')) {
                # Make signinurl work and return here.

-               $form->tmpl_param(signinurl => IkiWiki::cgiurl(do => 'signin'));
+               $form->tmpl_param(signinurl => IkiWiki::cgiurl(do => 'commentsignin'));

                $session->param(postsignin => $ENV{QUERY_STRING});
                IkiWiki::cgi_savesession($session);
        }
                $session->param(postsignin => $ENV{QUERY_STRING});
                IkiWiki::cgi_savesession($session);
        }


@@ -336,7 +368,7 @@ sub editcomment ($$) {
        my $page = $form->field('page');
        $page = IkiWiki::possibly_foolish_untaint($page);
        if (! defined $page || ! length $page ||
        my $page = $form->field('page');
        $page = IkiWiki::possibly_foolish_untaint($page);
        if (! defined $page || ! length $page ||

-               IkiWiki::file_pruned($page, $config{srcdir})) {
+               IkiWiki::file_pruned($page)) {

                error(gettext("bad page name"));
        }
 
                error(gettext("bad page name"));
        }
 


@@ -379,14 +411,18 @@ sub editcomment ($$) {
 
        my $content = "[[!comment format=$type\n";
 
 
        my $content = "[[!comment format=$type\n";
 

-       # FIXME: handling of double quotes probably wrong?

        if (defined $session->param('name')) {
                my $username = $session->param('name');
                $username =~ s/"/&quot;/g;
                $content .= " username=\"$username\"\n";
        }
        if (defined $session->param('name')) {
                my $username = $session->param('name');
                $username =~ s/"/&quot;/g;
                $content .= " username=\"$username\"\n";
        }

-       elsif (defined $ENV{REMOTE_ADDR}) {
-               my $ip = $ENV{REMOTE_ADDR};
+       if (defined $session->param('nickname')) {
+               my $nickname = $session->param('nickname');
+               $nickname =~ s/"/&quot;/g;
+               $content .= " nickname=\"$nickname\"\n";
+       }
+       elsif (defined $session->remote_addr()) {
+               my $ip = $session->remote_addr();

                if ($ip =~ m/^([.0-9]+)$/) {
                        $content .= " ip=\"$1\"\n";
                }
                if ($ip =~ m/^([.0-9]+)$/) {
                        $content .= " ip=\"$1\"\n";
                }


@@ -416,7 +452,8 @@ sub editcomment ($$) {
 
        $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 
 
        $content .= " date=\"" . decode_utf8(strftime('%Y-%m-%dT%H:%M:%SZ', gmtime)) . "\"\n";
 

-       my $editcontent = $form->field('editcontent') || '';
+       my $editcontent = $form->field('editcontent');
+       $editcontent="" if ! defined $editcontent;

        $editcontent =~ s/\r\n/\n/g;
        $editcontent =~ s/\r/\n/g;
        $editcontent =~ s/"/\\"/g;
        $editcontent =~ s/\r\n/\n/g;
        $editcontent =~ s/\r/\n/g;
        $editcontent =~ s/"/\\"/g;


@@ -460,9 +497,15 @@ sub editcomment ($$) {
                $postcomment=0;
 
                if (! $ok) {
                $postcomment=0;
 
                if (! $ok) {

-                       my $penddir=$config{wikistatedir}."/comments_pending";
-                       $location=unique_comment_location($page, $content, $penddir);
-                       writefile("$location._comment", $penddir, $content);
+                       $location=unique_comment_location($page, $content, $config{srcdir}, "._comment_pending");
+                       writefile("$location._comment_pending", $config{srcdir}, $content);
+
+                       # Refresh so anything that deals with pending
+                       # comments can be updated.
+                       require IkiWiki::Render;
+                       IkiWiki::refresh();
+                       IkiWiki::saveindex();
+

                        IkiWiki::printheader($session);
                        print IkiWiki::misctemplate(gettext(gettext("comment stored for moderation")),
                                "<p>".
                        IkiWiki::printheader($session);
                        print IkiWiki::misctemplate(gettext(gettext("comment stored for moderation")),
                                "<p>".


@@ -489,8 +532,10 @@ sub editcomment ($$) {
 
                        IkiWiki::rcs_add($file);
                        IkiWiki::disable_commit_hook();
 
                        IkiWiki::rcs_add($file);
                        IkiWiki::disable_commit_hook();

-                       $conflict = IkiWiki::rcs_commit_staged($message,
-                               $session->param('name'), $ENV{REMOTE_ADDR});
+                       $conflict = IkiWiki::rcs_commit_staged(
+                               message => $message,
+                               session => $session,
+                       );

                        IkiWiki::enable_commit_hook();
                        IkiWiki::rcs_update();
                }
                        IkiWiki::enable_commit_hook();
                        IkiWiki::rcs_update();
                }


@@ -513,7 +558,7 @@ sub editcomment ($$) {
        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,
        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,

-                       forcebaseurl => $baseurl);
+                       forcebaseurl => $baseurl, page => $page);

        }
 
        exit;
        }
 
        exit;


@@ -538,21 +583,25 @@ sub commentmoderation ($$) {
                my %vars=$cgi->Vars;
                my $added=0;
                foreach my $id (keys %vars) {
                my %vars=$cgi->Vars;
                my $added=0;
                foreach my $id (keys %vars) {

-                       if ($id =~ /(.*)\Q._comment\E$/) {
+                       if ($id =~ /(.*)\._comment(?:_pending)?$/) {
+                               $id=decode_utf8($id);

                                my $action=$cgi->param($id);
                                next if $action eq 'Defer' && ! $rejectalldefer;
 
                                # Make sure that the id is of a legal
                                my $action=$cgi->param($id);
                                next if $action eq 'Defer' && ! $rejectalldefer;
 
                                # Make sure that the id is of a legal

-                               # pending comment before untainting.
-                               my ($f)= $id =~ /$config{wiki_file_regexp}/;
+                               # pending comment.
+                               my ($f) = $id =~ /$config{wiki_file_regexp}/;

                                if (! defined $f || ! length $f ||
                                if (! defined $f || ! length $f ||

-                                   IkiWiki::file_pruned($f, $config{srcdir})) {
+                                   IkiWiki::file_pruned($f)) {

                                        error("illegal file");
                                }
 
                                        error("illegal file");
                                }
 

-                               my $page=IkiWiki::possibly_foolish_untaint(IkiWiki::dirname($1));
-                               my $file="$config{wikistatedir}/comments_pending/".
-                                       IkiWiki::possibly_foolish_untaint($id);
+                               my $page=IkiWiki::dirname($f);
+                               my $file="$config{srcdir}/$f";
+                               if (! -e $file) {
+                                       # old location
+                                       $file="$config{wikistatedir}/comments_pending/".$f;
+                               }

 
                                if ($action eq 'Accept') {
                                        my $content=eval { readfile($file) };
 
                                if ($action eq 'Accept') {
                                        my $content=eval { readfile($file) };


@@ -565,9 +614,6 @@ sub commentmoderation ($$) {
                                        $added++;
                                }
 
                                        $added++;
                                }
 

-                               # This removes empty subdirs, so the
-                               # .ikiwiki/comments_pending dir will
-                               # go away when all are moderated.

                                require IkiWiki::Render;
                                IkiWiki::prune($file);
                        }
                                require IkiWiki::Render;
                                IkiWiki::prune($file);
                        }


@@ -578,8 +624,10 @@ sub commentmoderation ($$) {
                        if ($config{rcs} and $config{comments_commit}) {
                                my $message = gettext("Comment moderation");
                                IkiWiki::disable_commit_hook();
                        if ($config{rcs} and $config{comments_commit}) {
                                my $message = gettext("Comment moderation");
                                IkiWiki::disable_commit_hook();

-                               $conflict=IkiWiki::rcs_commit_staged($message,
-                                       $session->param('name'), $ENV{REMOTE_ADDR});
+                               $conflict=IkiWiki::rcs_commit_staged(
+                                       message => $message,
+                                       session => $session,
+                               );

                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }
                                IkiWiki::enable_commit_hook();
                                IkiWiki::rcs_update();
                        }


@@ -594,16 +642,15 @@ sub commentmoderation ($$) {
        }
 
        my @comments=map {
        }
 
        my @comments=map {

-               my ($id, $ctime)=@{$_};
-               my $file="$config{wikistatedir}/comments_pending/$id";
-               my $content=readfile($file);
+               my ($id, $dir, $ctime)=@{$_};
+               my $content=readfile("$dir/$id");

                my $preview=previewcomment($content, $id,
                my $preview=previewcomment($content, $id,

-                       IkiWiki::dirname($_), $ctime);
+                       $id, $ctime);

                {
                        id => $id,
                        view => $preview,
                {
                        id => $id,
                        view => $preview,

-               } 
-       } sort { $b->[1] <=> $a->[1] } comments_pending();
+               }
+       } sort { $b->[2] <=> $a->[2] } comments_pending();

 
        my $template=template("commentmoderation.tmpl");
        $template->param(
 
        my $template=template("commentmoderation.tmpl");
        $template->param(


@@ -633,30 +680,43 @@ sub formbuilder_setup (@) {
 }
 
 sub comments_pending () {
 }
 
 sub comments_pending () {

-       my $dir="$config{wikistatedir}/comments_pending/";
-       return unless -d $dir;
-

        my @ret;
        my @ret;

+

        eval q{use File::Find};
        error($@) if $@;
        eval q{use File::Find};
        error($@) if $@;

-       find({
-               no_chdir => 1,
-               wanted => sub {
-                       $_=decode_utf8($_);
-                       if (IkiWiki::file_pruned($_, $dir)) {
-                               $File::Find::prune=1;
-                       }
-                       elsif (! -l $_ && ! -d _) {
-                               $File::Find::prune=0;
-                               my ($f)=/$config{wiki_file_regexp}/; # untaint
-                               if (defined $f && $f =~ /\Q._comment\E$/) {
-                                       my $ctime=(stat($f))[10];
-                                       $f=~s/^\Q$dir\E\/?//;
-                                        push @ret, [$f, $ctime];
+       eval q{use Cwd};
+       error($@) if $@;
+       my $origdir=getcwd();
+
+       my $find_comments=sub {
+               my $dir=shift;
+               my $extension=shift;
+               return unless -d $dir;
+
+               chdir($dir) || die "chdir $dir: $!";
+
+               find({
+                       no_chdir => 1,
+                       wanted => sub {
+                               my $file=decode_utf8($_);
+                               $file=~s/^\.\///;
+                               return if ! length $file || IkiWiki::file_pruned($file)
+                                       || -l $_ || -d _ || $file !~ /\Q$extension\E$/;
+                               my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
+                               if (defined $f) {
+                                       my $ctime=(stat($_))[10];
+                                       push @ret, [$f, $dir, $ctime];

                                }
                        }
                                }
                        }

-               }
-       }, $dir);
+               }, ".");
+
+               chdir($origdir) || die "chdir $origdir: $!";
+       };
+       
+       $find_comments->($config{srcdir}, "._comment_pending");
+       # old location
+       $find_comments->("$config{wikistatedir}/comments_pending/",
+               "._comment");

 
        return @ret;
 }
 
        return @ret;
 }


@@ -667,6 +727,10 @@ sub previewcomment ($$$) {
        my $page=shift;
        my $time=shift;
 
        my $page=shift;
        my $time=shift;
 

+       # Previewing a comment should implicitly enable comment posting mode.
+       my $oldpostcomment=$postcomment;
+       $postcomment=1;
+

        my $preview = IkiWiki::htmlize($location, $page, '_comment',
                        IkiWiki::linkify($location, $page,
                        IkiWiki::preprocess($location, $page,
        my $preview = IkiWiki::htmlize($location, $page, '_comment',
                        IkiWiki::linkify($location, $page,
                        IkiWiki::preprocess($location, $page,


@@ -674,7 +738,8 @@ sub previewcomment ($$$) {
 
        my $template = template("comment.tmpl");
        $template->param(content => $preview);
 
        my $template = template("comment.tmpl");
        $template->param(content => $preview);

-       $template->param(ctime => displaytime($time));
+       $template->param(ctime => displaytime($time, undef, 1));
+       $template->param(html5 => $config{html5});

 
        IkiWiki::run_hooks(pagetemplate => sub {
                shift->(page => $location,
 
        IkiWiki::run_hooks(pagetemplate => sub {
                shift->(page => $location,


@@ -684,13 +749,15 @@ sub previewcomment ($$$) {
 
        $template->param(have_actions => 0);
 
 
        $template->param(have_actions => 0);
 

+       $postcomment=$oldpostcomment;
+

        return $template->output;
 }
 
 sub commentsshown ($) {
        my $page=shift;
 
        return $template->output;
 }
 
 sub commentsshown ($) {
        my $page=shift;
 

-       return ! pagespec_match($page, "internal(*/$config{comments_pagename}*)",
+       return ! pagespec_match($page, "comment(*)",

                                location => $page) &&
               pagespec_match($page, $config{comments_pagespec},
                              location => $page);
                                location => $page) &&
               pagespec_match($page, $config{comments_pagespec},
                              location => $page);


@@ -720,7 +787,7 @@ sub pagetemplate (@) {
                my $comments = undef;
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
                my $comments = undef;
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(

-                               pages => "internal($page/$config{comments_pagename}*)",
+                               pages => "comment($page)",

                                template => 'comment',
                                show => 0,
                                reverse => 'yes',
                                template => 'comment',
                                show => 0,
                                reverse => 'yes',


@@ -831,38 +898,37 @@ sub num_comments ($$) {
        my $dir=shift;
 
        my @comments=glob("$dir/$page/$config{comments_pagename}*._comment");
        my $dir=shift;
 
        my @comments=glob("$dir/$page/$config{comments_pagename}*._comment");

-       return @comments;
+       return int @comments;

 }
 
 }
 

-sub unique_comment_location ($$$) {
+sub unique_comment_location ($$$$) {

        my $page=shift;
        my $page=shift;

-

        eval q{use Digest::MD5 'md5_hex'};
        error($@) if $@;
        eval q{use Digest::MD5 'md5_hex'};
        error($@) if $@;

-       my $content_md5=md5_hex(shift);
-
+       my $content_md5=md5_hex(Encode::encode_utf8(shift));

        my $dir=shift;
        my $dir=shift;

+       my $ext=shift || "._comment";

 
        my $location;
        my $i = num_comments($page, $dir);
        do {
                $i++;
                $location = "$page/$config{comments_pagename}${i}_${content_md5}";
 
        my $location;
        my $i = num_comments($page, $dir);
        do {
                $i++;
                $location = "$page/$config{comments_pagename}${i}_${content_md5}";

-       } while (-e "$dir/$location._comment");
+       } while (-e "$dir/$location$ext");

 
        return $location;
 }
 
 sub page_to_id ($) {
        # Converts a comment page name into a unique, legal html id
 
        return $location;
 }
 
 sub page_to_id ($) {
        # Converts a comment page name into a unique, legal html id

-       # addtibute value, that can be used as an anchor to link to the
+       # attribute value, that can be used as an anchor to link to the

        # comment.
        my $page=shift;
 
        eval q{use Digest::MD5 'md5_hex'};
        error($@) if $@;
 
        # comment.
        my $page=shift;
 
        eval q{use Digest::MD5 'md5_hex'};
        error($@) if $@;
 

-       return "comment-".md5_hex($page);
+       return "comment-".md5_hex(Encode::encode_utf8(($page)));

 }
        
 package IkiWiki::PageSpec;
 }
        
 package IkiWiki::PageSpec;


@@ -874,7 +940,41 @@ sub match_postcomment ($$;@) {
        if (! $postcomment) {
                return IkiWiki::FailReason->new("not posting a comment");
        }
        if (! $postcomment) {
                return IkiWiki::FailReason->new("not posting a comment");
        }

-       return match_glob($page, $glob);
+       return match_glob($page, $glob, @_);
+}
+
+sub match_comment ($$;@) {
+       my $page = shift;
+       my $glob = shift;
+
+       if (! $postcomment) {
+               # To see if it's a comment, check the source file type.
+               # Deal with comments that were just deleted.
+               my $source=exists $IkiWiki::pagesources{$page} ?
+                       $IkiWiki::pagesources{$page} :
+                       $IkiWiki::delpagesources{$page};
+               my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+               if (! defined $type || $type ne "_comment") {
+                       return IkiWiki::FailReason->new("$page is not a comment");
+               }
+       }
+
+       return match_glob($page, "$glob/*", internal => 1, @_);
+}
+
+sub match_comment_pending ($$;@) {
+       my $page = shift;
+       my $glob = shift;
+       
+       my $source=exists $IkiWiki::pagesources{$page} ?
+               $IkiWiki::pagesources{$page} :
+               $IkiWiki::delpagesources{$page};
+       my $type=defined $source ? IkiWiki::pagetype($source) : undef;
+       if (! defined $type || $type ne "_comment_pending") {
+               return IkiWiki::FailReason->new("$page is not a pending comment");
+       }
+
+       return match_glob($page, "$glob/*", internal => 1, @_);

 }
 
 1
 }
 
 1