comments: Fix anchor ids to be legal xhtml. Closes: #521339

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

diff --git a/IkiWiki/Plugin/comments.pm b/IkiWiki/Plugin/comments.pm
index b2243ce4c85e3938483e4656746cf93d0b2f6821..2ad422f5f678028c83bfe3a9fbc68e7528135414 100644 (file)
--- a/IkiWiki/Plugin/comments.pm
+++ b/IkiWiki/Plugin/comments.pm
@@ -25,8 +25,9 @@ sub import {
        hook(type => "sessioncgi", id => 'comment', call => \&sessioncgi);
        hook(type => "htmlize", id => "_comment", call => \&htmlize);
        hook(type => "pagetemplate", id => "comments", call => \&pagetemplate);
-       hook(type => "cgi", id => "comments", call => \&linkcgi);
        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");
 }
 
@@ -167,7 +168,7 @@ sub preprocess {
                }
                else {
                        $commentauthorurl = IkiWiki::cgiurl(
-                               do => 'commenter',
+                               do => 'goto',
                                page => (length $config{userdir}
                                        ? "$config{userdir}/$commentuser"
                                        : "$commentuser"));
@@ -223,7 +224,7 @@ sub preprocess {
 
        if ($params{page} =~ m/\/(\Q$config{comments_pagename}\E\d+)$/) {
                $pagestate{$page}{meta}{permalink} = urlto(IkiWiki::dirname($params{page}), undef, 1).
-                       "#".$params{page};
+                       "#".page_to_id($params{page});
        }
 
        eval q{use Date::Parse};
@@ -235,35 +236,6 @@ sub preprocess {
        return $content;
 }
 
-# This is exactly the same as recentchanges_link :-(
-sub linkcgi ($) {
-       my $cgi=shift;
-       if (defined $cgi->param('do') && $cgi->param('do') eq "commenter") {
-
-               my $page=decode_utf8($cgi->param("page"));
-               if (! defined $page) {
-                       error("missing page parameter");
-               }
-
-               IkiWiki::loadindex();
-
-               my $link=bestlink("", $page);
-               if (! length $link) {
-                       print "Content-type: text/html\n\n";
-                       print IkiWiki::misctemplate(gettext(gettext("missing page")),
-                               "<p>".
-                               sprintf(gettext("The page %s does not exist."),
-                                       htmllink("", "", $page)).
-                               "</p>");
-               }
-               else {
-                       IkiWiki::redirect($cgi, urlto($link, undef, 1));
-               }
-
-               exit;
-       }
-}
-
 sub sessioncgi ($$) {
        my $cgi=shift;
        my $session=shift;
@@ -477,7 +449,7 @@ sub editcomment ($$) {
                        IkiWiki::printheader($session);
                        print IkiWiki::misctemplate(gettext(gettext("comment stored for moderation")),
                                "<p>".
-                               gettext("Your comment will be posted after moderator review"),
+                               gettext("Your comment will be posted after moderator review").
                                "</p>");
                        exit;
                }
@@ -518,7 +490,8 @@ 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.
-               IkiWiki::redirect($cgi, urlto($page, undef, 1)."?updated#$location");
+               IkiWiki::redirect($cgi, urlto($page, undef, 1).
+                       "?updated#".page_to_id($location));
 
        }
        else {
@@ -633,7 +606,8 @@ sub formbuilder_setup (@) {
        my %params=@_;
 
        my $form=$params{form};
-       if ($form->title eq "preferences") {
+       if ($form->title eq "preferences" &&
+           IkiWiki::is_admin($params{session}->param("name"))) {
                push @{$params{buttons}}, "Comment Moderation";
                if ($form->submitted && $form->submitted eq "Comment Moderation") {
                        commentmoderation($params{cgi}, $params{session});
@@ -699,7 +673,7 @@ sub previewcomment ($$$) {
 sub commentsshown ($) {
        my $page=shift;
 
-       return ! pagespec_match($page, "*/$config{comments_pagename}*",
+       return ! pagespec_match($page, "internal(*/$config{comments_pagename}*)",
                                location => $page) &&
               pagespec_match($page, $config{comments_pagespec},
                              location => $page);
@@ -786,6 +760,10 @@ sub pagetemplate (@) {
        if (!exists $commentstate{$page}) {
                return;
        }
+       
+       if ($template->query(name => 'commentid')) {
+               $template->param(commentid => page_to_id($page));
+       }
 
        if ($template->query(name => 'commentuser')) {
                $template->param(commentuser =>
@@ -835,6 +813,21 @@ sub unique_comment_location ($) {
        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
+       # comment.
+       my $page=shift;
+
+       # It needs to start with a letter.
+       $page="comment_".$page;
+
+       # Encode any illegal characters.
+       $page=~s/([^A-Za-z0-9-_:.])/"__".ord($1)."__"/eg;
+
+       return $page;
+}
+       
 package IkiWiki::PageSpec;
 
 sub match_postcomment ($$;@) {