]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/comments.pm
_comment directive: if the user looks like an OpenID, store that
[ikiwiki.git] / IkiWiki / Plugin / comments.pm
index 6184c6031281f5c0bd719b2b9dab95ae8337a100..336ed1a823c6937b2c79b063fd8fc2aaf3209533 100644 (file)
@@ -34,29 +34,24 @@ sub getsetup () {
                        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',
-                       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,
                },
-               comments_open_pagespec => {
+               comments_closed_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',
-                       example => 'comment_',
                        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',
-                       default => 0,
                        example => 0,
                        description => 'Interpret directives in comments?',
                        safe => 1,
@@ -72,7 +66,6 @@ sub getsetup () {
                },
                comments_allowauthor => {
                        type => 'boolean',
-                       default => 0,
                        example => 0,
                        description => 'Allow anonymous commenters to set an author name?',
                        safe => 1,
@@ -81,7 +74,6 @@ sub getsetup () {
                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
@@ -90,6 +82,17 @@ sub getsetup () {
                },
 }
 
+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 {
        my %params = @_;
        return $params{content};
@@ -148,11 +151,28 @@ sub preprocess {
        my $commentip;
        my $commentauthor;
        my $commentauthorurl;
+       my $commentopenid;
 
        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}) {
@@ -162,6 +182,7 @@ sub preprocess {
        }
 
        $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;
@@ -190,12 +211,10 @@ sub preprocess {
                $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+)$/) {
-               $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 (! $@) {
@@ -203,17 +222,9 @@ sub preprocess {
                $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;
 }
 
-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 :-(
 sub linkcgi ($) {
        my $cgi=shift;
@@ -288,9 +299,7 @@ sub sessioncgi ($$) {
                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);
@@ -372,7 +381,7 @@ sub sessioncgi ($$) {
                        $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"),
@@ -454,7 +463,7 @@ sub sessioncgi ($$) {
                                        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));
@@ -502,9 +511,8 @@ sub sessioncgi ($$) {
                # 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,
@@ -514,36 +522,39 @@ sub sessioncgi ($$) {
        exit;
 }
 
+sub commentsshown ($) {
+       my $page=shift;
+
+       return ! pagespec_match($page, "*/$config{comments_pagename}*",
+                               location => $page) &&
+              pagespec_match($page, $config{comments_pagespec},
+                             location => $page);
+}
+
+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 $shown = ($template->query(name => 'commentslink') ||
+                    $template->query(name => 'comments')) &&
+                   commentsshown($page);
 
        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}*)",
-                               template => 'comments_display',
+                               template => 'comment',
                                show => 0,
                                reverse => 'yes',
                                page => $page,
@@ -557,13 +568,27 @@ sub pagetemplate (@) {
                        $template->param(comments => $comments);
                }
 
-               if ($open) {
+               if ($shown && commentsopen($page)) {
                        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});