IkiWiki/Plugin/meta.pm

   1 #!/usr/bin/perl
   2 # Ikiwiki metadata plugin.
   3 package IkiWiki::Plugin::meta;
   4
   5 use warnings;
   6 use strict;
   7 use IkiWiki 2.00;
   8
   9 my %meta;
  10 my %title;
  11 my %permalink;
  12 my %author;
  13 my %authorurl;
  14 my %license;
  15 my %copyright;
  16
  17 sub import { #{{{
  18         hook(type => "needsbuild", id => "meta", call => \&needsbuild);
  19         hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
  20         hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
  21 } # }}}
  22
  23 sub needsbuild (@) { #{{{
  24         my $needsbuild=shift;
  25         foreach my $page (keys %pagestate) {
  26                 if (exists $pagestate{$page}{meta}) {
  27                         if (grep { $_ eq $pagesources{$page} } @$needsbuild) {
  28                                 # remove state, it will be re-added
  29                                 # if the preprocessor directive is still
  30                                 # there during the rebuild
  31                                 delete $pagestate{$page}{meta};
  32                         }
  33                 }
  34         }
  35 }
  36
  37 sub scrub ($) { #{{{
  38         if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
  39                 return IkiWiki::Plugin::htmlscrubber::sanitize(content => shift);
  40         }
  41         else {
  42                 return shift;
  43         }
  44 } #}}}
  45
  46 sub htmlize ($$$) { #{{{
  47         my $page = shift;
  48         my $destpage = shift;
  49         my $text = shift;
  50
  51         $text=IkiWiki::htmlize($page, pagetype($pagesources{$page}),
  52                 IkiWiki::linkify($page, $destpage,
  53                 IkiWiki::preprocess($page, $destpage, $text)));
  54
  55         # hack to get rid of enclosing junk added by markdown
  56         $text=~s!^<p>!!;
  57         $text=~s!</p>$!!;
  58         chomp $text;
  59
  60         return $text;
  61 }
  62
  63 sub preprocess (@) { #{{{
  64         return "" unless @_;
  65         my %params=@_;
  66         my $key=shift;
  67         my $value=$params{$key};
  68         delete $params{$key};
  69         my $page=$params{page};
  70         delete $params{page};
  71         my $destpage=$params{destpage};
  72         delete $params{destpage};
  73         delete $params{preview};
  74
  75         eval q{use HTML::Entities};
  76         # Always decode, even if encoding later, since it might not be
  77         # fully encoded.
  78         $value=decode_entities($value);
  79
  80         # Metadata collection that needs to happen during the scan pass.
  81         if ($key eq 'title') {
  82                 $title{$page}=HTML::Entities::encode_numeric($value);
  83         }
  84         elsif ($key eq 'license') {
  85                 push @{$meta{$page}}, '<link rel="license" href="#page_license" />';
  86                 $license{$page}=$value;
  87                 return "";
  88         }
  89         elsif ($key eq 'copyright') {
  90                 push @{$meta{$page}}, '<link rel="copyright" href="#page_copyright" />';
  91                 $copyright{$page}=$value;
  92                 return "";
  93         }
  94         elsif ($key eq 'link' && ! %params) {
  95                 # hidden WikiLink
  96                 push @{$links{$page}}, $value;
  97                 return "";
  98         }
  99         elsif ($key eq 'author') {
 100                 $author{$page}=$value;
 101                 # fallthorough
 102         }
 103         elsif ($key eq 'authorurl') {
 104                 $authorurl{$page}=$value;
 105                 # fallthrough
 106         }
 107
 108         if (! defined wantarray) {
 109                 # avoid collecting duplicate data during scan pass
 110                 return;
 111         }
 112
 113         # Metadata collection that happens only during preprocessing pass.
 114         if ($key eq 'date') {
 115                 eval q{use Date::Parse};
 116                 if (! $@) {
 117                         my $time = str2time($value);
 118                         $IkiWiki::pagectime{$page}=$time if defined $time;
 119                 }
 120         }
 121         elsif ($key eq 'permalink') {
 122                 $permalink{$page}=$value;
 123                 push @{$meta{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
 124         }
 125         elsif ($key eq 'stylesheet') {
 126                 my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
 127                 my $title=exists $params{title} ? $params{title} : $value;
 128                 # adding .css to the value prevents using any old web
 129                 # editable page as a stylesheet
 130                 my $stylesheet=bestlink($page, $value.".css");
 131                 if (! length $stylesheet) {
 132                         return "[[meta ".gettext("stylesheet not found")."]]";
 133                 }
 134                 push @{$meta{$page}}, '<link href="'.urlto($stylesheet, $page).
 135                         '" rel="'.encode_entities($rel).
 136                         '" title="'.encode_entities($title).
 137                         "\" type=\"text/css\" />";
 138         }
 139         elsif ($key eq 'openid') {
 140                 if (exists $params{server}) {
 141                         push @{$meta{$page}}, '<link href="'.encode_entities($params{server}).
 142                                 '" rel="openid.server" />';
 143                 }
 144                 push @{$meta{$page}}, '<link href="'.encode_entities($value).
 145                         '" rel="openid.delegate" />';
 146         }
 147         elsif ($key eq 'redir') {
 148                 return "" if $page ne $destpage;
 149                 my $safe=0;
 150                 if ($value !~ /^\w+:\/\//) {
 151                         my ($redir_page, $redir_anchor) = split /\#/, $value;
 152
 153                         add_depends($page, $redir_page);
 154                         my $link=bestlink($page, $redir_page);
 155                         if (! length $link) {
 156                                 return "[[meta ".gettext("redir page not found")."]]";
 157                         }
 158
 159                         $value=urlto($link, $page);
 160                         $value.='#'.$redir_anchor if defined $redir_anchor;
 161                         $safe=1;
 162
 163                         # redir cycle detection
 164                         $pagestate{$page}{meta}{redir}=$link;
 165                         my $at=$page;
 166                         my %seen;
 167                         while (exists $pagestate{$at}{meta}{redir}) {
 168                                 if ($seen{$at}) {
 169                                         return "[[meta ".gettext("redir cycle is not allowed")."]]";
 170                                 }
 171                                 $seen{$at}=1;
 172                                 $at=$pagestate{$at}{meta}{redir};
 173                         }
 174                 }
 175                 else {
 176                         $value=encode_entities($value);
 177                 }
 178                 my $delay=int(exists $params{delay} ? $params{delay} : 0);
 179                 my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\">";
 180                 if (! $safe) {
 181                         $redir=scrub($redir);
 182                 }
 183                 push @{$meta{$page}}, $redir;
 184         }
 185         elsif ($key eq 'link') {
 186                 if (%params) {
 187                         $meta{$page}.=scrub("<link href=\"".encode_entities($value)."\" ".
 188                                 join(" ", map {
 189                                         encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
 190                                 } keys %params).
 191                                 " />\n");
 192                 }
 193         }
 194         else {
 195                 push @{$meta{$page}}, scrub('<meta name="'.encode_entities($key).
 196                         '" content="'.encode_entities($value).'" />');
 197         }
 198
 199         return "";
 200 } # }}}
 201
 202 sub pagetemplate (@) { #{{{
 203         my %params=@_;
 204         my $page=$params{page};
 205         my $destpage=$params{destpage};
 206         my $template=$params{template};
 207
 208         if (exists $meta{$page} && $template->query(name => "meta")) {
 209                 # avoid duplicate meta lines
 210                 my %seen;
 211                 $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$meta{$page}}));
 212         }
 213         if (exists $title{$page} && $template->query(name => "title")) {
 214                 $template->param(title => $title{$page});
 215                 $template->param(title_overridden => 1);
 216         }
 217         $template->param(permalink => $permalink{$page})
 218                 if exists $permalink{$page} && $template->query(name => "permalink");
 219         $template->param(author => $author{$page})
 220                 if exists $author{$page} && $template->query(name => "author");
 221         $template->param(authorurl => $authorurl{$page})
 222                 if exists $authorurl{$page} && $template->query(name => "authorurl");
 223
 224         if (exists $license{$page} && $template->query(name => "license") &&
 225             ($page eq $destpage || ! exists $license{$destpage} ||
 226              $license{$page} ne $license{$destpage})) {
 227                 $template->param(license => htmlize($page, $destpage, $license{$page}));
 228         }
 229         if (exists $copyright{$page} && $template->query(name => "copyright") &&
 230             ($page eq $destpage || ! exists $copyright{$destpage} ||
 231              $copyright{$page} ne $copyright{$destpage})) {
 232                 $template->param(copyright => htmlize($page, $destpage, $copyright{$page}));
 233         }
 234 } # }}}
 235
 236 1