meta plugin: script support

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 93c8c4061b111cae5a2ece8bd94c5a77c7957f7f..8d46ed57983e6a0d0e7cac3c568a6cb368ec34a6 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -22,6 +22,7 @@ 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);
        # here for backwards compatability with old comments
        hook(type => "preprocess", id => '_comment', call => \&preprocess);
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);


@@ -109,7 +110,7 @@ sub htmlize {
 
 sub htmlize_pending {
        my %params = @_;
 
 sub htmlize_pending {
        my %params = @_;

-       return sprintf(gettext("comment pending %s"),
+       return sprintf(gettext("this comment needs %s"),

                '<a href="'.
                IkiWiki::cgiurl(do => "commentmoderation").'">'.
                gettext("moderation").'</a>');
                '<a href="'.
                IkiWiki::cgiurl(do => "commentmoderation").'">'.
                gettext("moderation").'</a>');


@@ -142,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);


@@ -177,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 {


@@ -238,7 +237,7 @@ sub preprocess {
        }
 
        if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {
        }
 
        if ($params{page} =~ m/\/\Q$config{comments_pagename}\E\d+_/) {

-               $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
+               $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page})).

                        "#".page_to_id($params{page});
        }
 
                        "#".page_to_id($params{page});
        }
 


@@ -251,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;


@@ -262,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


@@ -282,7 +301,7 @@ sub editcomment ($$) {
                required => [qw{editcontent}],
                javascript => 0,
                params => $cgi,
                required => [qw{editcontent}],
                javascript => 0,
                params => $cgi,

-               action => $config{cgiurl},
+               action => IkiWiki::cgiurl(),

                header => 0,
                table => 0,
                template => { template('editcomment.tmpl') },
                header => 0,
                table => 0,
                template => { template('editcomment.tmpl') },


@@ -339,24 +358,22 @@ 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);
        }
 
        # The untaint is OK (as in editpage) because we're about to pass
                $session->param(postsignin => $ENV{QUERY_STRING});
                IkiWiki::cgi_savesession($session);
        }
 
        # The untaint is OK (as in editpage) because we're about to pass

-       # it to file_pruned anyway
-       my $page = $form->field('page');
+       # it to file_pruned and wiki_file_regexp anyway.
+       my ($page) = $form->field('page')=~/$config{wiki_file_regexp}/;

        $page = IkiWiki::possibly_foolish_untaint($page);
        if (! defined $page || ! length $page ||
                IkiWiki::file_pruned($page)) {
                error(gettext("bad page name"));
        }
 
        $page = IkiWiki::possibly_foolish_untaint($page);
        if (! defined $page || ! length $page ||
                IkiWiki::file_pruned($page)) {
                error(gettext("bad page name"));
        }
 

-       my $baseurl = urlto($page, undef, 1);
-

        $form->title(sprintf(gettext("commenting on %s"),
        $form->title(sprintf(gettext("commenting on %s"),

-                       IkiWiki::pagetitle($page)));
+                       IkiWiki::pagetitle(IkiWiki::basename($page))));

 
        $form->tmpl_param('helponformattinglink',
                htmllink($page, $page, 'ikiwiki/formatting',
 
        $form->tmpl_param('helponformattinglink',
                htmllink($page, $page, 'ikiwiki/formatting',


@@ -366,8 +383,7 @@ sub editcomment ($$) {
 
        if ($form->submitted eq CANCEL) {
                # bounce back to the page they wanted to comment on, and exit.
 
        if ($form->submitted eq CANCEL) {
                # bounce back to the page they wanted to comment on, and exit.

-               # CANCEL need not be considered in future
-               IkiWiki::redirect($cgi, urlto($page, undef, 1));
+               IkiWiki::redirect($cgi, urlto($page));

                exit;
        }
 
                exit;
        }
 


@@ -392,14 +408,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";
                }


@@ -429,7 +449,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;


@@ -473,7 +494,7 @@ sub editcomment ($$) {
                $postcomment=0;
 
                if (! $ok) {
                $postcomment=0;
 
                if (! $ok) {

-                       $location=unique_comment_location($page, $content, $config{srcdir});
+                       $location=unique_comment_location($page, $content, $config{srcdir}, "._comment_pending");

                        writefile("$location._comment_pending", $config{srcdir}, $content);
 
                        # Refresh so anything that deals with pending
                        writefile("$location._comment_pending", $config{srcdir}, $content);
 
                        # Refresh so anything that deals with pending


@@ -483,7 +504,7 @@ sub editcomment ($$) {
                        IkiWiki::saveindex();
 
                        IkiWiki::printheader($session);
                        IkiWiki::saveindex();
 
                        IkiWiki::printheader($session);

-                       print IkiWiki::misctemplate(gettext(gettext("comment stored for moderation")),
+                       print IkiWiki::cgitemplate($cgi, gettext(gettext("comment stored for moderation")),

                                "<p>".
                                gettext("Your comment will be posted after moderator review").
                                "</p>");
                                "<p>".
                                gettext("Your comment will be posted after moderator review").
                                "</p>");


@@ -508,8 +529,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();
                }


@@ -526,13 +549,13 @@ sub editcomment ($$) {
                # Jump to the new comment on the page.
                # The trailing question mark tries to avoid broken
                # caches and get the most recent version of the page.
                # Jump to the new comment on the page.
                # The trailing question mark tries to avoid broken
                # caches and get the most recent version of the page.

-               IkiWiki::redirect($cgi, urlto($page, undef, 1).
+               IkiWiki::redirect($cgi, urlto($page).

                        "?updated#".page_to_id($location));
 
        }
        else {
                        "?updated#".page_to_id($location));
 
        }
        else {

-               IkiWiki::showform ($form, \@buttons, $session, $cgi,
-                       forcebaseurl => $baseurl);
+               IkiWiki::showform($form, \@buttons, $session, $cgi,
+                       page => $page);

        }
 
        exit;
        }
 
        exit;


@@ -558,6 +581,7 @@ sub commentmoderation ($$) {
                my $added=0;
                foreach my $id (keys %vars) {
                        if ($id =~ /(.*)\._comment(?:_pending)?$/) {
                my $added=0;
                foreach my $id (keys %vars) {
                        if ($id =~ /(.*)\._comment(?:_pending)?$/) {

+                               $id=decode_utf8($id);

                                my $action=$cgi->param($id);
                                next if $action eq 'Defer' && ! $rejectalldefer;
 
                                my $action=$cgi->param($id);
                                next if $action eq 'Defer' && ! $rejectalldefer;
 


@@ -597,8 +621,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();
                        }


@@ -627,13 +653,14 @@ sub commentmoderation ($$) {
        $template->param(
                sid => $session->id,
                comments => \@comments,
        $template->param(
                sid => $session->id,
                comments => \@comments,

+               cgiurl => IkiWiki::cgiurl(),

        );
        IkiWiki::printheader($session);
        my $out=$template->output;
        IkiWiki::run_hooks(format => sub {
                $out = shift->(page => "", content => $out);
        });
        );
        IkiWiki::printheader($session);
        my $out=$template->output;
        IkiWiki::run_hooks(format => sub {
                $out = shift->(page => "", content => $out);
        });

-       print IkiWiki::misctemplate(gettext("comment moderation"), $out);
+       print IkiWiki::cgitemplate($cgi, gettext("comment moderation"), $out);

        exit;
 }
 
        exit;
 }
 


@@ -655,16 +682,22 @@ sub comments_pending () {
 
        eval q{use File::Find};
        error($@) if $@;
 
        eval q{use File::Find};
        error($@) if $@;

+       eval q{use Cwd};
+       error($@) if $@;
+       my $origdir=getcwd();

 
        my $find_comments=sub {
                my $dir=shift;
                my $extension=shift;
                return unless -d $dir;
 
        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($_);
                find({
                        no_chdir => 1,
                        wanted => sub {
                                my $file=decode_utf8($_);

-                               $file=~s/^\Q$dir\E\/?//;
+                               $file=~s/^\.\///;

                                return if ! length $file || IkiWiki::file_pruned($file)
                                        || -l $_ || -d _ || $file !~ /\Q$extension\E$/;
                                my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
                                return if ! length $file || IkiWiki::file_pruned($file)
                                        || -l $_ || -d _ || $file !~ /\Q$extension\E$/;
                                my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint


@@ -673,7 +706,9 @@ sub comments_pending () {
                                        push @ret, [$f, $dir, $ctime];
                                }
                        }
                                        push @ret, [$f, $dir, $ctime];
                                }
                        }

-               }, $dir);
+               }, ".");
+
+               chdir($origdir) || die "chdir $origdir: $!";

        };
        
        $find_comments->($config{srcdir}, "._comment_pending");
        };
        
        $find_comments->($config{srcdir}, "._comment_pending");


@@ -690,6 +725,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,


@@ -708,16 +747,16 @@ 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, "comment(*)",
-                               location => $page) &&
-              pagespec_match($page, $config{comments_pagespec},
-                             location => $page);
+       return pagespec_match($page, $config{comments_pagespec},
+               location => $page);

 }
 
 sub commentsopen ($) {
 }
 
 sub commentsopen ($) {


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

-                               pages => "comment($page)",
+                               pages => "comment($page) and !comment($page/*)",

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


@@ -767,14 +806,14 @@ sub pagetemplate (@) {
        if ($shown) {
                if ($template->query(name => 'commentsurl')) {
                        $template->param(commentsurl =>
        if ($shown) {
                if ($template->query(name => 'commentsurl')) {
                        $template->param(commentsurl =>

-                               urlto($page, undef, 1).'#comments');
+                               urlto($page).'#comments');

                }
 
                if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
                        # This will 404 until there are some comments, but I
                        # think that's probably OK...
                        $template->param(atomcommentsurl =>
                }
 
                if ($template->query(name => 'atomcommentsurl') && $config{usedirs}) {
                        # This will 404 until there are some comments, but I
                        # think that's probably OK...
                        $template->param(atomcommentsurl =>

-                               urlto($page, undef, 1).'comments.atom');
+                               urlto($page).'comments.atom');

                }
 
                if ($template->query(name => 'commentslink')) {
                }
 
                if ($template->query(name => 'commentslink')) {


@@ -855,25 +894,23 @@ 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 $@;
        my $content_md5=md5_hex(Encode::encode_utf8(shift));
        eval q{use Digest::MD5 'md5_hex'};
        error($@) if $@;
        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" ||
-                -e "$dir/$location._comment_pending");
+       } while (-e "$dir/$location$ext");

 
        return $location;
 }
 
        return $location;
 }


@@ -906,28 +943,34 @@ sub match_comment ($$;@) {
        my $page = shift;
        my $glob = shift;
 
        my $page = shift;
        my $glob = shift;
 

-       my $match=match_glob($page, "$glob/*", internal => 1, @_);
-       if ($match && exists $IkiWiki::pagesources{$page}) {
-               my $type=IkiWiki::pagetype($IkiWiki::pagesources{$page});
-               if (defined $type && $type ne "_comment") {
+       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 IkiWiki::FailReason->new("$page is not a comment");
                }
        }

-       return $match;
+
+       return match_glob($page, "$glob/*", internal => 1, @_);

 }
 
 sub match_comment_pending ($$;@) {
        my $page = shift;
        my $glob = shift;
 }
 
 sub match_comment_pending ($$;@) {
        my $page = shift;
        my $glob = shift;

-
-       my $match=match_glob($page, "$glob/*", internal => 1, @_);
-       if ($match && $IkiWiki::pagesources{$page}) {
-               my $type=IkiWiki::pagetype($IkiWiki::pagesources{$page});
-               if (defined $type && $type ne "_comment_pending") {
-                       return IkiWiki::FailReason->new("$page is not a pending comment");
-               }
+       
+       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;
+
+       return match_glob($page, "$glob/*", internal => 1, @_);

 }
 
 1
 }
 
 1