_comment directive: if the user looks like an OpenID, store that

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index 1eb256da9bc5ec3e198025fa81c3ffe3b3c65dfb..336ed1a823c6937b2c79b063fd8fc2aaf3209533 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -17,7 +17,7 @@ use constant CANCEL => "Cancel";
 
 my $postcomment;
 
 
 my $postcomment;
 

-sub import { #{{{
+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);


@@ -26,37 +26,32 @@ sub import { #{{{
        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
        hook(type => "cgi", id => "comments", call => \&linkcgi);
        IkiWiki::loadplugin("inline");
        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
        hook(type => "cgi", id => "comments", call => \&linkcgi);
        IkiWiki::loadplugin("inline");

-} # }}}
+}

 
 

-sub getsetup () { #{{{
+sub getsetup () {

        return
                plugin => {
                        safe => 1,
                        rebuild => 1,
                },
        return
                plugin => {
                        safe => 1,
                        rebuild => 1,
                },

-               # Pages where comments are shown, but new comments are not
-               # allowed, will show "Comments are closed".
-               comments_shown_pagespec => {
+               comments_pagespec => {

                        type => 'pagespec',
                        type => 'pagespec',

-                       example => 'blog/*',
-                       default => '',
-                       description => 'PageSpec for pages where comments will be shown inline',
+                       example => 'blog/* and !*/Discussion',
+                       description => 'PageSpec of pages where comments are allowed',

                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        rebuild => 1,
                },
                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        rebuild => 1,
                },

-               comments_open_pagespec => {
+               comments_closed_pagespec => {

                        type => 'pagespec',
                        type => 'pagespec',

-                       example => 'blog/* and created_after(close_old_comments)',
-                       default => '',
-                       description => 'PageSpec for pages where new comments can be posted',
+                       example => 'blog/controversial or blog/flamewar',
+                       description => 'PageSpec of pages where posting new comments is not allowed',

                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        rebuild => 1,
                },
                comments_pagename => {
                        type => 'string',
                        link => 'ikiwiki/PageSpec',
                        safe => 1,
                        rebuild => 1,
                },
                comments_pagename => {
                        type => 'string',

-                       example => 'comment_',

                        default => 'comment_',
                        description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
                        safe => 0, # manual page moving required
                        default => 'comment_',
                        description => 'Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"',
                        safe => 0, # manual page moving required


@@ -64,7 +59,6 @@ sub getsetup () { #{{{
                },
                comments_allowdirectives => {
                        type => 'boolean',
                },
                comments_allowdirectives => {
                        type => 'boolean',

-                       default => 0,

                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,
                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,


@@ -72,7 +66,6 @@ sub getsetup () { #{{{
                },
                comments_allowauthor => {
                        type => 'boolean',
                },
                comments_allowauthor => {
                        type => 'boolean',

-                       default => 0,

                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,
                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,


@@ -81,22 +74,32 @@ sub getsetup () { #{{{
                comments_commit => {
                        type => 'boolean',
                        example => 1,
                comments_commit => {
                        type => 'boolean',
                        example => 1,

-                       default => 1,

                        description => 'commit comments to the VCS',
                        # old uncommitted comments are likely to cause
                        # confusion if this is changed
                        safe => 0,
                        rebuild => 0,
                },
                        description => 'commit comments to the VCS',
                        # old uncommitted comments are likely to cause
                        # confusion if this is changed
                        safe => 0,
                        rebuild => 0,
                },

-} #}}}
+}
+
+sub checkconfig () {
+       $config{comments_commit} = 1
+               unless defined $config{comments_commit};
+       $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};
+}

 
 

-sub htmlize { # {{{
+sub htmlize {

        my %params = @_;
        return $params{content};
        my %params = @_;
        return $params{content};

-} # }}}
+}

 
 # FIXME: copied verbatim from meta
 
 # FIXME: copied verbatim from meta

-sub safeurl ($) { #{{{
+sub safeurl ($) {

        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {


@@ -105,9 +108,9 @@ sub safeurl ($) { #{{{
        else {
                return 1;
        }
        else {
                return 1;
        }

-} #}}}
+}

 
 

-sub preprocess { # {{{
+sub preprocess {

        my %params = @_;
        my $page = $params{page};
 
        my %params = @_;
        my $page = $params{page};
 


@@ -148,11 +151,28 @@ sub preprocess { # {{{
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;

+       my $commentopenid;

 
        if (defined $params{username}) {
                $commentuser = $params{username};
 
        if (defined $params{username}) {
                $commentuser = $params{username};

-               ($commentauthorurl, $commentauthor) =
-                       linkuser($params{username});
+
+               my $oiduser = eval { IkiWiki::openiduser($commentuser) };
+
+               if (defined $oiduser) {
+                       # looks like an OpenID
+                       $commentauthorurl = $commentuser;
+                       $commentauthor = $oiduser;
+                       $commentopenid = $commentuser;
+               }
+               else {
+                       $commentauthorurl = IkiWiki::cgiurl(
+                               do => 'commenter',
+                               page => (length $config{userdir}
+                                       ? "$config{userdir}/$commentuser"
+                                       : "$commentuser"));
+
+                       $commentauthor = $commentuser;
+               }

        }
        else {
                if (defined $params{ip}) {
        }
        else {
                if (defined $params{ip}) {


@@ -162,6 +182,7 @@ sub preprocess { # {{{
        }
 
        $pagestate{$page}{comments}{commentuser} = $commentuser;
        }
 
        $pagestate{$page}{comments}{commentuser} = $commentuser;

+       $pagestate{$page}{comments}{commentopenid} = $commentopenid;

        $pagestate{$page}{comments}{commentip} = $commentip;
        $pagestate{$page}{comments}{commentauthor} = $commentauthor;
        $pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;
        $pagestate{$page}{comments}{commentip} = $commentip;
        $pagestate{$page}{comments}{commentauthor} = $commentauthor;
        $pagestate{$page}{comments}{commentauthorurl} = $commentauthorurl;


@@ -190,12 +211,10 @@ sub preprocess { # {{{
                $pagestate{$page}{meta}{title} = $params{subject};
        }
 
                $pagestate{$page}{meta}{title} = $params{subject};
        }
 

-       my $baseurl = urlto($params{destpage}, undef, 1);
-       my $anchor = "";

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

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

        }
        }

-       $pagestate{$page}{meta}{permalink} = "${baseurl}#${anchor}";

 
        eval q{use Date::Parse};
        if (! $@) {
 
        eval q{use Date::Parse};
        if (! $@) {


@@ -203,19 +222,11 @@ sub preprocess { # {{{
                $IkiWiki::pagectime{$page} = $time if defined $time;
        }
 
                $IkiWiki::pagectime{$page} = $time if defined $time;
        }
 

-       # FIXME: hard-coded HTML (although it's just to set an ID)
-       return "<div id=\"$anchor\">$content</div>" if $anchor;

        return $content;
        return $content;

-} # }}}
-
-sub checkconfig () { #{{{
-       $config{comments_commit} = 1 unless defined $config{comments_commit};
-       $config{comments_pagename} = 'comment_'
-               unless defined $config{comments_pagename};
-} #}}}
+}

 
 # This is exactly the same as recentchanges_link :-(
 
 # This is exactly the same as recentchanges_link :-(

-sub linkcgi ($) { #{{{
+sub linkcgi ($) {

        my $cgi=shift;
        if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
 
        my $cgi=shift;
        if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
 


@@ -245,7 +256,7 @@ sub linkcgi ($) { #{{{
 
 # FIXME: basically the same logic as recentchanges
 # returns (author URL, pretty-printed version)
 
 # FIXME: basically the same logic as recentchanges
 # returns (author URL, pretty-printed version)

-sub linkuser ($) { # {{{
+sub linkuser ($) {

        my $user = shift;
        my $oiduser = eval { IkiWiki::openiduser($user) };
 
        my $user = shift;
        my $oiduser = eval { IkiWiki::openiduser($user) };
 


@@ -262,10 +273,10 @@ sub linkuser ($) { # {{{
                                        : "$user")
                        ), $user);
        }
                                        : "$user")
                        ), $user);
        }

-} # }}}
+}

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

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

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


@@ -288,9 +299,7 @@ sub sessioncgi ($$) { #{{{
                action => $config{cgiurl},
                header => 0,
                table => 0,
                action => $config{cgiurl},
                header => 0,
                table => 0,

-               template => scalar IkiWiki::template_params('comments_form.tmpl'),
-               # wtf does this do in editpage?
-               wikiname => $config{wikiname},
+               template => scalar IkiWiki::template_params('editcomment.tmpl'),

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


@@ -372,7 +381,7 @@ sub sessioncgi ($$) { #{{{
                        $page));
        }
 
                        $page));
        }
 

-       if (not pagespec_match($page, $config{comments_open_pagespec},
+       if (pagespec_match($page, $config{comments_closed_pagespec},

                location => $page)) {
                error(sprintf(gettext(
                        "comments on page '%s' are closed"),
                location => $page)) {
                error(sprintf(gettext(
                        "comments on page '%s' are closed"),


@@ -454,7 +463,7 @@ sub sessioncgi ($$) { #{{{
                                        content => $preview);
                        });
 
                                        content => $preview);
                        });
 

-               my $template = template("comments_display.tmpl");
+               my $template = template("comment.tmpl");

                $template->param(content => $preview);
                $template->param(title => $form->field('subject'));
                $template->param(ctime => displaytime(time));
                $template->param(content => $preview);
                $template->param(title => $form->field('subject'));
                $template->param(ctime => displaytime(time));


@@ -468,7 +477,7 @@ sub sessioncgi ($$) { #{{{
        if ($form->submitted eq POST_COMMENT && $form->validate) {
                my $file = "$location._comment";
 
        if ($form->submitted eq POST_COMMENT && $form->validate) {
                my $file = "$location._comment";
 

-               IkiWiki::checksessionexpiry($session, $cgi->param('sid'));
+               IkiWiki::checksessionexpiry($cgi, $session);

 
                # FIXME: could probably do some sort of graceful retry
                # on error? Would require significant unwinding though
 
                # FIXME: could probably do some sort of graceful retry
                # on error? Would require significant unwinding though


@@ -502,9 +511,8 @@ sub sessioncgi ($$) { #{{{
                # breaks it or something
                error($conflict) if defined $conflict;
 
                # breaks it or something
                error($conflict) if defined $conflict;
 

-               # Bounce back to where we were, but defeat broken caches
-               my $anticache = "?updated=$page/$config{comments_pagename}$i";
-               IkiWiki::redirect($cgi, urlto($page, undef, 1).$anticache);
+               # Jump to the new comment on the page.
+               IkiWiki::redirect($cgi, urlto($page, undef, 1)."#$location");

        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,
        }
        else {
                IkiWiki::showform ($form, \@buttons, $session, $cgi,


@@ -512,38 +520,41 @@ sub sessioncgi ($$) { #{{{
        }
 
        exit;
        }
 
        exit;

-} #}}}
+}
+
+sub commentsshown ($) {
+       my $page=shift;
+
+       return ! pagespec_match($page, "*/$config{comments_pagename}*",
+                               location => $page) &&
+              pagespec_match($page, $config{comments_pagespec},
+                             location => $page);
+}

 
 

-sub pagetemplate (@) { #{{{
+sub commentsopen ($) {
+       my $page = shift;
+
+       return length $config{cgiurl} > 0 &&
+              (! length $config{comments_closed_pagespec} ||
+               ! pagespec_match($page, $config{comments_closed_pagespec},
+                                location => $page));
+}
+
+sub pagetemplate (@) {

        my %params = @_;
 
        my $page = $params{page};
        my $template = $params{template};
        my %params = @_;
 
        my $page = $params{page};
        my $template = $params{template};

+       my $shown = ($template->query(name => 'commentslink') ||
+                    $template->query(name => 'comments')) &&
+                   commentsshown($page);

 
        if ($template->query(name => 'comments')) {
                my $comments = undef;
 
        if ($template->query(name => 'comments')) {
                my $comments = undef;

-
-               my $open = 0;
-               my $shown = pagespec_match($page,
-                       $config{comments_shown_pagespec},
-                       location => $page);
-
-               if (pagespec_match($page, "*/$config{comments_pagename}*",
-                               location => $page)) {
-                       $shown = 0;
-                       $open = 0;
-               }
-
-               if (length $config{cgiurl}) {
-                       $open = pagespec_match($page,
-                               $config{comments_open_pagespec},
-                               location => $page);
-               }
-

                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
                                pages => "internal($page/$config{comments_pagename}*)",
                if ($shown) {
                        $comments = IkiWiki::preprocess_inline(
                                pages => "internal($page/$config{comments_pagename}*)",

-                               template => 'comments_display',
+                               template => 'comment',

                                show => 0,
                                reverse => 'yes',
                                page => $page,
                                show => 0,
                                reverse => 'yes',
                                page => $page,


@@ -557,13 +568,27 @@ sub pagetemplate (@) { #{{{
                        $template->param(comments => $comments);
                }
 
                        $template->param(comments => $comments);
                }
 

-               if ($open) {
+               if ($shown && commentsopen($page)) {

                        my $commenturl = IkiWiki::cgiurl(do => 'comment',
                                page => $page);
                        $template->param(commenturl => $commenturl);
                }
        }
 
                        my $commenturl = IkiWiki::cgiurl(do => 'comment',
                                page => $page);
                        $template->param(commenturl => $commenturl);
                }
        }
 

+       if ($template->query(name => 'commentslink')) {
+               # XXX Would be nice to say how many comments there are in
+               # the link. But, to update the number, blog pages
+               # would have to update whenever comments of any inlines
+               # page are added, which is not currently done.
+               if ($shown) {
+                       $template->param(commentslink =>
+                               htmllink($page, $params{destpage}, $page,
+                                       linktext => gettext("Comments"),
+                                       anchor => "comments",
+                                       noimageinline => 1));
+               }
+       }
+

        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>
                        $pagestate{$page}{comments}{commentuser});
        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>
                        $pagestate{$page}{comments}{commentuser});


@@ -583,7 +608,7 @@ sub pagetemplate (@) { #{{{
                $template->param(commentauthorurl =>
                        $pagestate{$page}{comments}{commentauthorurl});
        }
                $template->param(commentauthorurl =>
                        $pagestate{$page}{comments}{commentauthorurl});
        }

-} # }}}
+}

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