IkiWiki/Plugin/postal.pm

   1 # A plugin for ikiwiki to implement adding a footer with a comment URL
   2 # based on a template file and a key representing the current page
   3
   4 # Copyright © 2007 Thomas Schwinge <tschwinge@gnu.org>
   5 # Copyright © 2008 David Bremner <bremner@unb.ca>
   6 #
   7 # This program is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by the
   9 # Free Software Foundation; either version 2, or (at your option) any later
  10 # version.
  11 #
  12 # This program is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  14 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 # for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along
  18 # with this program; if not, write to the Free Software Foundation, Inc.,
  19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20 \f
  21 package IkiWiki::Plugin::postal;
  22
  23 use warnings;
  24 use strict;
  25 use IkiWiki 2.00;
  26 use Convert::YText 'encode_ytext';
  27
  28 \f
  29 sub import
  30 {
  31     hook (type => "pagetemplate", id => "postal", call => \&pagetemplate);
  32 }
  33
  34 sub pagetemplate (@)
  35 {
  36     my %params = @_;
  37     my $page = IkiWiki::pagetitle($params{page});
  38     my $destpage = $params{destpage};
  39     my $template = $params{template};
  40
  41     my $key = encode_ytext($page);
  42
  43     my $pagespec=$config{postal_pagespec} || "!*/comments";
  44
  45     if (!pagespec_match($page,$pagespec)){
  46         return;
  47     }
  48
  49     my $subpage_name=$config{postal_pagename} || "comments";
  50
  51     my $comment_page=$destpage . "/" . $subpage_name;
  52     add_depends($params{page},$comment_page);
  53
  54
  55     my $about_link=undef;
  56     my $about_page=bestlink($page,"about_comments");
  57
  58     if ($about_page){
  59         $about_link=htmllink($page,$destpage,$about_page,
  60                                linktext=>gettext("About Comments"));
  61     }
  62
  63     my $comment_link=undef;
  64     if (exists $pagesources{$comment_page}){
  65         $comment_link=htmllink($page,$destpage,$comment_page,
  66                                linktext=>gettext("Read Comments"));
  67     }
  68
  69     $template->param(POSTAL_DIV=>1,
  70                      POSTAL_PREFIX=>$config{postal_prefix},
  71                      POSTAL_KEY=>$key,
  72                      POSTAL_HOST=>$config{postal_host},
  73                      defined($about_link) ? (POSTAL_ABOUT_LINK=>$about_link):(),
  74                      defined($comment_link) ? (POSTAL_COMMENT_LINK=>$comment_link) :());
  75 }
  76
  77
  78 1;