Merge branch 'master' into debian-jessie-backports

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 4bf8ae4692acb85426f4e87fd4134824c5c708d9..b47f965e7b76359d391a5a63db8fbfc2c215a46a 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -35,6 +35,7 @@ sub import {
        # 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");

+       IkiWiki::loadplugin("transient");

 }
 
 sub getsetup () {
 }
 
 sub getsetup () {


@@ -90,17 +91,31 @@ sub getsetup () {
                        safe => 0,
                        rebuild => 0,
                },
                        safe => 0,
                        rebuild => 0,
                },

+               comments_allowformats => {
+                       type => 'string',
+                       default => '',
+                       example => 'mdwn txt',
+                       description => 'Restrict formats for comments to (no restriction if empty)',
+                       safe => 1,
+                       rebuild => 0,
+               },
+

 }
 
 sub checkconfig () {
        $config{comments_commit} = 1
                unless defined $config{comments_commit};
 }
 
 sub checkconfig () {
        $config{comments_commit} = 1
                unless defined $config{comments_commit};

+       if (! $config{comments_commit}) {
+               $config{only_committed_changes}=0;
+       }

        $config{comments_pagespec} = ''
                unless defined $config{comments_pagespec};
        $config{comments_closed_pagespec} = ''
                unless defined $config{comments_closed_pagespec};
        $config{comments_pagename} = 'comment_'
                unless defined $config{comments_pagename};
        $config{comments_pagespec} = ''
                unless defined $config{comments_pagespec};
        $config{comments_closed_pagespec} = ''
                unless defined $config{comments_closed_pagespec};
        $config{comments_pagename} = 'comment_'
                unless defined $config{comments_pagename};

+       $config{comments_allowformats} = ''
+               unless defined $config{comments_allowformats};

 }
 
 sub htmlize {
 }
 
 sub htmlize {


@@ -128,12 +143,18 @@ sub safeurl ($) {
        }
 }
 
        }
 }
 

+sub isallowed ($) {
+    my $format = shift;
+    return ! $config{comments_allowformats} || $config{comments_allowformats} =~ /\b$format\b/;
+}
+

 sub preprocess {
        my %params = @_;
        my $page = $params{page};
 
        my $format = $params{format};
 sub preprocess {
        my %params = @_;
        my $page = $params{page};
 
        my $format = $params{format};

-       if (defined $format && ! exists $IkiWiki::hooks{htmlize}{$format}) {
+       if (defined $format && (! exists $IkiWiki::hooks{htmlize}{$format} ||
+                               ! isallowed($format))) {

                error(sprintf(gettext("unsupported page format %s"), $format));
        }
 
                error(sprintf(gettext("unsupported page format %s"), $format));
        }
 


@@ -177,7 +198,6 @@ sub preprocess {
                $commentuser = $params{username};
 
                my $oiduser = eval { IkiWiki::openiduser($commentuser) };
                $commentuser = $params{username};
 
                my $oiduser = eval { IkiWiki::openiduser($commentuser) };

-

                if (defined $oiduser) {
                        # looks like an OpenID
                        $commentauthorurl = $commentuser;
                if (defined $oiduser) {
                        # looks like an OpenID
                        $commentauthorurl = $commentuser;


@@ -185,10 +205,17 @@ sub preprocess {
                        $commentopenid = $commentuser;
                }
                else {
                        $commentopenid = $commentuser;
                }
                else {

-                       $commentauthorurl = IkiWiki::cgiurl(
-                               do => 'goto',
-                               page => IkiWiki::userpage($commentuser)
-                       );
+                       my $emailuser = IkiWiki::emailuser($commentuser);
+                       if (defined $emailuser) {
+                               $commentuser=$emailuser;
+                       }
+
+                       if (length $config{cgiurl}) {
+                               $commentauthorurl = IkiWiki::cgiurl(
+                                       do => 'goto',
+                                       page => IkiWiki::userpage($commentuser)
+                               );
+                       }

 
                        $commentauthor = $commentuser;
                }
 
                        $commentauthor = $commentuser;
                }


@@ -200,22 +227,9 @@ sub preprocess {
                $commentauthor = gettext("Anonymous");
        }
 
                $commentauthor = gettext("Anonymous");
        }
 

-       $commentstate{$page}{commentuser} = $commentuser;
-       $commentstate{$page}{commentopenid} = $commentopenid;
-       $commentstate{$page}{commentip} = $commentip;
-       $commentstate{$page}{commentauthor} = $commentauthor;
-       $commentstate{$page}{commentauthorurl} = $commentauthorurl;
-       $commentstate{$page}{commentauthoravatar} = $params{avatar};
-       if (! defined $pagestate{$page}{meta}{author}) {
-               $pagestate{$page}{meta}{author} = $commentauthor;
-       }
-       if (! defined $pagestate{$page}{meta}{authorurl}) {
-               $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
-       }
-

        if ($config{comments_allowauthor}) {
                if (defined $params{claimedauthor}) {
        if ($config{comments_allowauthor}) {
                if (defined $params{claimedauthor}) {

-                       $pagestate{$page}{meta}{author} = $params{claimedauthor};
+                       $commentauthor = $params{claimedauthor};

                }
 
                if (defined $params{url}) {
                }
 
                if (defined $params{url}) {


@@ -227,12 +241,21 @@ sub preprocess {
                        }
 
                        if (safeurl($url)) {
                        }
 
                        if (safeurl($url)) {

-                               $pagestate{$page}{meta}{authorurl} = $url;
+                               $commentauthorurl = $url;

                        }
                }
        }
                        }
                }
        }

-       else {
+
+       $commentstate{$page}{commentuser} = $commentuser;
+       $commentstate{$page}{commentopenid} = $commentopenid;
+       $commentstate{$page}{commentip} = $commentip;
+       $commentstate{$page}{commentauthor} = $commentauthor;
+       $commentstate{$page}{commentauthorurl} = $commentauthorurl;
+       $commentstate{$page}{commentauthoravatar} = $params{avatar};
+       if (! defined $pagestate{$page}{meta}{author}) {

                $pagestate{$page}{meta}{author} = $commentauthor;
                $pagestate{$page}{meta}{author} = $commentauthor;

+       }
+       if (! defined $pagestate{$page}{meta}{authorurl}) {

                $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
        }
 
                $pagestate{$page}{meta}{authorurl} = $commentauthorurl;
        }
 


@@ -332,8 +355,9 @@ sub editcomment ($$) {
 
        my @page_types;
        if (exists $IkiWiki::hooks{htmlize}) {
 
        my @page_types;
        if (exists $IkiWiki::hooks{htmlize}) {

-               foreach my $key (grep { !/^_/ } keys %{$IkiWiki::hooks{htmlize}}) {
-                       push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key];
+               foreach my $key (grep { !/^_/ && isallowed($_) } keys %{$IkiWiki::hooks{htmlize}}) {
+                       push @page_types, [$key, $IkiWiki::hooks{htmlize}{$key}{longname} || $key]
+                               unless $IkiWiki::hooks{htmlize}{$key}{nocreate};

                }
        }
        @page_types=sort @page_types;
                }
        }
        @page_types=sort @page_types;


@@ -417,6 +441,16 @@ sub editcomment ($$) {
                        $page));
        }
 
                        $page));
        }
 

+       # There's no UI to get here, but someone might construct the URL,
+       # leading to a comment that exists in the repository but isn't
+       # shown
+       if (!pagespec_match($page, $config{comments_pagespec},
+               location => $page)) {
+               error(sprintf(gettext(
+                       "comments on page '%s' are not allowed"),
+                       $page));
+       }
+

        if (pagespec_match($page, $config{comments_closed_pagespec},
                location => $page)) {
                error(sprintf(gettext(
        if (pagespec_match($page, $config{comments_closed_pagespec},
                location => $page)) {
                error(sprintf(gettext(


@@ -433,20 +467,20 @@ sub editcomment ($$) {
        my $content = "[[!comment format=$type\n";
 
        if (defined $session->param('name')) {
        my $content = "[[!comment format=$type\n";
 
        if (defined $session->param('name')) {

-               my $username = $session->param('name');
+               my $username = IkiWiki::cloak($session->param('name'));

                $username =~ s/"/"/g;
                $content .= " username=\"$username\"\n";
        }
                $username =~ s/"/"/g;
                $content .= " username=\"$username\"\n";
        }

+

        if (defined $session->param('nickname')) {
                my $nickname = $session->param('nickname');
                $nickname =~ s/"/"/g;
                $content .= " nickname=\"$nickname\"\n";
        }
        if (defined $session->param('nickname')) {
                my $nickname = $session->param('nickname');
                $nickname =~ s/"/"/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 (!(defined $session->param('name') || defined $session->param('nickname')) &&
+               defined $session->remote_addr()) {
+               $content .= " ip=\"".IkiWiki::cloak($session->remote_addr())."\"\n";

        }
 
        if ($config{comments_allowauthor}) {
        }
 
        if ($config{comments_allowauthor}) {


@@ -476,8 +510,7 @@ sub editcomment ($$) {
                $subject = "comment ".(num_comments($page, $config{srcdir}) + 1);
        }
        $content .= " subject=\"$subject\"\n";
                $subject = "comment ".(num_comments($page, $config{srcdir}) + 1);
        }
        $content .= " subject=\"$subject\"\n";

-
-       $content .= " date=\"" . strftime_utf8('%Y-%m-%dT%H:%M:%SZ', gmtime) . "\"\n";
+       $content .= " date=\"" . commentdate() . "\"\n";

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


@@ -538,8 +571,8 @@ sub editcomment ($$) {
                $postcomment=0;
 
                if (! $ok) {
                $postcomment=0;
 
                if (! $ok) {

-                       $location=unique_comment_location($page, $content, $config{srcdir}, "._comment_pending");
-                       writefile("$location._comment_pending", $config{srcdir}, $content);
+                       $location=unique_comment_location($page, $content, $IkiWiki::Plugin::transient::transientdir, "._comment_pending");
+                       writefile("$location._comment_pending", $IkiWiki::Plugin::transient::transientdir, $content);

 
                        # Refresh so anything that deals with pending
                        # comments can be updated.
 
                        # Refresh so anything that deals with pending
                        # comments can be updated.


@@ -605,6 +638,10 @@ sub editcomment ($$) {
        exit;
 }
 
        exit;
 }
 

+sub commentdate () {
+       strftime_utf8('%Y-%m-%dT%H:%M:%SZ', gmtime);
+}
+

 sub getavatar ($) {
        my $user=shift;
        return undef unless defined $user;
 sub getavatar ($) {
        my $user=shift;
        return undef unless defined $user;


@@ -664,12 +701,17 @@ sub commentmoderation ($$) {
                                }
 
                                my $page=IkiWiki::dirname($f);
                                }
 
                                my $page=IkiWiki::dirname($f);

-                               my $file="$config{srcdir}/$f";
-                               my $filedir="$config{srcdir}";
+                               my $filedir=$IkiWiki::Plugin::transient::transientdir;
+                               my $file="$filedir/$f";

                                if (! -e $file) {
                                        # old location
                                if (! -e $file) {
                                        # old location

-                                       $file="$config{wikistatedir}/comments_pending/".$f;
-                                       $filedir="$config{wikistatedir}/comments_pending";
+                                       $file="$config{srcdir}/$f";
+                                       $filedir=$config{srcdir};
+                                       if (! -e $file) {
+                                               # older location
+                                               $file="$config{wikistatedir}/comments_pending/".$f;
+                                               $filedir="$config{wikistatedir}/comments_pending";
+                                       }

                                }
 
                                if ($action eq 'Accept') {
                                }
 
                                if ($action eq 'Accept') {


@@ -783,6 +825,8 @@ sub comments_pending () {
                chdir($origdir) || die "chdir $origdir: $!";
        };
        
                chdir($origdir) || die "chdir $origdir: $!";
        };
        

+       $find_comments->($IkiWiki::Plugin::transient::transientdir, "._comment_pending");
+       # old location

        $find_comments->($config{srcdir}, "._comment_pending");
        # old location
        $find_comments->("$config{wikistatedir}/comments_pending/",
        $find_comments->($config{srcdir}, "._comment_pending");
        # old location
        $find_comments->("$config{wikistatedir}/comments_pending/",


@@ -876,16 +920,18 @@ sub pagetemplate (@) {
        }
 
        if ($shown) {
        }
 
        if ($shown) {

+               my $absolute = $template->param('wants_absolute_urls');
+

                if ($template->query(name => 'commentsurl')) {
                        $template->param(commentsurl =>
                if ($template->query(name => 'commentsurl')) {
                        $template->param(commentsurl =>

-                               urlto($page).'#comments');
+                               urlto($page, undef, $absolute).'#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).'comments.atom');
+                               urlto($page, undef, $absolute).'comments.atom');

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


@@ -974,7 +1020,7 @@ sub num_comments ($$) {
        return int @comments;
 }
 
        return int @comments;
 }
 

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

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