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 3.00;
   8
   9 my %metaheaders;
  10
  11 sub import {
  12         hook(type => "getsetup", id => "meta", call => \&getsetup);
  13         hook(type => "needsbuild", id => "meta", call => \&needsbuild);
  14         hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
  15         hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
  16         hook(type => "sort", id => "meta_title", call => \&sort_meta_title);
  17 }
  18
  19 sub getsetup () {
  20         return
  21                 plugin => {
  22                         safe => 1,
  23                         rebuild => undef,
  24                         section => "core",
  25                 },
  26 }
  27
  28 sub needsbuild (@) {
  29         my $needsbuild=shift;
  30         foreach my $page (keys %pagestate) {
  31                 if (exists $pagestate{$page}{meta}) {
  32                         if (exists $pagesources{$page} &&
  33                             grep { $_ eq $pagesources{$page} } @$needsbuild) {
  34                                 # remove state, it will be re-added
  35                                 # if the preprocessor directive is still
  36                                 # there during the rebuild
  37                                 delete $pagestate{$page}{meta};
  38                         }
  39                 }
  40         }
  41 }
  42
  43 sub scrub ($$) {
  44         if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
  45                 return IkiWiki::Plugin::htmlscrubber::sanitize(
  46                         content => shift, destpage => shift);
  47         }
  48         else {
  49                 return shift;
  50         }
  51 }
  52
  53 sub safeurl ($) {
  54         my $url=shift;
  55         if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
  56             defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
  57                 return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
  58         }
  59         else {
  60                 return 1;
  61         }
  62 }
  63
  64 sub htmlize ($$$) {
  65         my $page = shift;
  66         my $destpage = shift;
  67
  68         return IkiWiki::htmlize($page, $destpage, pagetype($pagesources{$page}),
  69                 IkiWiki::linkify($page, $destpage,
  70                 IkiWiki::preprocess($page, $destpage, shift)));
  71 }
  72
  73 sub preprocess (@) {
  74         return "" unless @_;
  75         my %params=@_;
  76         my $key=shift;
  77         my $value=$params{$key};
  78         delete $params{$key};
  79         my $page=$params{page};
  80         delete $params{page};
  81         my $destpage=$params{destpage};
  82         delete $params{destpage};
  83         delete $params{preview};
  84
  85         eval q{use HTML::Entities};
  86         # Always decode, even if encoding later, since it might not be
  87         # fully encoded.
  88         $value=decode_entities($value);
  89
  90         # Metadata collection that needs to happen during the scan pass.
  91         if ($key eq 'title') {
  92                 $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value);
  93                 if (exists $params{sort}) {
  94                         $pagestate{$page}{meta}{titlesort}=$params{sort};
  95                 }
  96                 else {
  97                         $pagestate{$page}{meta}{titlesort}=$value;
  98                 }
  99                 return "";
 100         }
 101         elsif ($key eq 'description') {
 102                 $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value);
 103                 # fallthrough
 104         }
 105         elsif ($key eq 'guid') {
 106                 $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($value);
 107                 # fallthrough
 108         }
 109         elsif ($key eq 'license') {
 110                 push @{$metaheaders{$page}}, '<link rel="license" href="#page_license" />';
 111                 $pagestate{$page}{meta}{license}=$value;
 112                 return "";
 113         }
 114         elsif ($key eq 'copyright') {
 115                 push @{$metaheaders{$page}}, '<link rel="copyright" href="#page_copyright" />';
 116                 $pagestate{$page}{meta}{copyright}=$value;
 117                 return "";
 118         }
 119         elsif ($key eq 'link' && ! %params) {
 120                 # hidden WikiLink
 121                 add_link($page, $value);
 122                 return "";
 123         }
 124         elsif ($key eq 'author') {
 125                 $pagestate{$page}{meta}{author}=$value;
 126                 # fallthorough
 127         }
 128         elsif ($key eq 'authorurl') {
 129                 $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
 130                 # fallthrough
 131         }
 132         elsif ($key eq 'permalink') {
 133                 $pagestate{$page}{meta}{permalink}=$value if safeurl($value);
 134                 # fallthrough
 135         }
 136         elsif ($key eq 'date') {
 137                 eval q{use Date::Parse};
 138                 if (! $@) {
 139                         my $time = str2time($value);
 140                         $IkiWiki::pagectime{$page}=$time if defined $time;
 141                 }
 142         }
 143         elsif ($key eq 'updated') {
 144                 eval q{use Date::Parse};
 145                 if (! $@) {
 146                         my $time = str2time($value);
 147                         $pagestate{$page}{meta}{updated}=$time if defined $time;
 148                 }
 149         }
 150
 151         if (! defined wantarray) {
 152                 # avoid collecting duplicate data during scan pass
 153                 return;
 154         }
 155
 156         # Metadata handling that happens only during preprocessing pass.
 157         if ($key eq 'permalink') {
 158                 if (safeurl($value)) {
 159                         push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />', $destpage);
 160                 }
 161         }
 162         elsif ($key eq 'stylesheet') {
 163                 my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
 164                 my $title=exists $params{title} ? $params{title} : $value;
 165                 # adding .css to the value prevents using any old web
 166                 # editable page as a stylesheet
 167                 my $stylesheet=bestlink($page, $value.".css");
 168                 if (! length $stylesheet) {
 169                         error gettext("stylesheet not found")
 170                 }
 171                 push @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
 172                         '" rel="'.encode_entities($rel).
 173                         '" title="'.encode_entities($title).
 174                         "\" type=\"text/css\" />";
 175         }
 176         elsif ($key eq 'openid') {
 177                 my $delegate=0; # both by default
 178                 if (exists $params{delegate}) {
 179                         $delegate = 1 if lc $params{delegate} eq 'openid';
 180                         $delegate = 2 if lc $params{delegate} eq 'openid2';
 181                 }
 182                 if (exists $params{server} && safeurl($params{server})) {
 183                         push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
 184                                 '" rel="openid.server" />' if $delegate ne 2;
 185                         push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
 186                                 '" rel="openid2.provider" />' if $delegate ne 1;
 187                 }
 188                 if (safeurl($value)) {
 189                         push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
 190                                 '" rel="openid.delegate" />' if $delegate ne 2;
 191                         push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
 192                                 '" rel="openid2.local_id" />' if $delegate ne 1;
 193                 }
 194                 if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
 195                         push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location"'.
 196                                 'content="'.encode_entities($params{"xrds-location"}).'" />';
 197                 }
 198         }
 199         elsif ($key eq 'redir') {
 200                 return "" if $page ne $destpage;
 201                 my $safe=0;
 202                 if ($value !~ /^\w+:\/\//) {
 203                         my ($redir_page, $redir_anchor) = split /\#/, $value;
 204
 205                         my $link=bestlink($page, $redir_page);
 206                         if (! length $link) {
 207                                 error gettext("redir page not found")
 208                         }
 209                         add_depends($page, $link, deptype("presence"));
 210
 211                         $value=urlto($link, $page);
 212                         $value.='#'.$redir_anchor if defined $redir_anchor;
 213                         $safe=1;
 214
 215                         # redir cycle detection
 216                         $pagestate{$page}{meta}{redir}=$link;
 217                         my $at=$page;
 218                         my %seen;
 219                         while (exists $pagestate{$at}{meta}{redir}) {
 220                                 if ($seen{$at}) {
 221                                         error gettext("redir cycle is not allowed")
 222                                 }
 223                                 $seen{$at}=1;
 224                                 $at=$pagestate{$at}{meta}{redir};
 225                         }
 226                 }
 227                 else {
 228                         $value=encode_entities($value);
 229                 }
 230                 my $delay=int(exists $params{delay} ? $params{delay} : 0);
 231                 my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";
 232                 if (! $safe) {
 233                         $redir=scrub($redir, $destpage);
 234                 }
 235                 push @{$metaheaders{$page}}, $redir;
 236         }
 237         elsif ($key eq 'link') {
 238                 if (%params) {
 239                         push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
 240                                 join(" ", map {
 241                                         encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
 242                                 } keys %params).
 243                                 " />\n", $destpage);
 244                 }
 245         }
 246         elsif ($key eq 'robots') {
 247                 push @{$metaheaders{$page}}, '<meta name="robots"'.
 248                         ' content="'.encode_entities($value).'" />';
 249         }
 250         elsif ($key eq 'description') {
 251                 push @{$metaheaders{$page}}, '<meta name="'.encode_entities($key).
 252                         '" content="'.encode_entities($value).'" />';
 253         }
 254         else {
 255                 push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
 256                         '" content="'.encode_entities($value).'" />', $destpage);
 257         }
 258
 259         return "";
 260 }
 261
 262 sub pagetemplate (@) {
 263         my %params=@_;
 264         my $page=$params{page};
 265         my $destpage=$params{destpage};
 266         my $template=$params{template};
 267
 268         if (exists $metaheaders{$page} && $template->query(name => "meta")) {
 269                 # avoid duplicate meta lines
 270                 my %seen;
 271                 $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
 272         }
 273         if (exists $pagestate{$page}{meta}{title} && $template->query(name => "title")) {
 274                 $template->param(title => $pagestate{$page}{meta}{title});
 275                 $template->param(title_overridden => 1);
 276         }
 277
 278         foreach my $field (qw{author authorurl description permalink}) {
 279                 $template->param($field => $pagestate{$page}{meta}{$field})
 280                         if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
 281         }
 282
 283         foreach my $field (qw{license copyright}) {
 284                 if (exists $pagestate{$page}{meta}{$field} && $template->query(name => $field) &&
 285                     ($page eq $destpage || ! exists $pagestate{$destpage}{meta}{$field} ||
 286                      $pagestate{$page}{meta}{$field} ne $pagestate{$destpage}{meta}{$field})) {
 287                         $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
 288                 }
 289         }
 290 }
 291
 292 sub titlesort {
 293         my $key = $pagestate{$_[0]}{meta}{titlesort};
 294
 295         if (defined $key) {
 296                 return $key;
 297         }
 298
 299         return pagetitle(IkiWiki::basename($_[0]));
 300 }
 301
 302 sub sort_meta_title {
 303         return titlesort($_[0]) cmp titlesort($_[1]);
 304 }
 305
 306 sub match {
 307         my $field=shift;
 308         my $page=shift;
 309
 310         # turn glob into a safe regexp
 311         my $re=IkiWiki::glob2re(shift);
 312
 313         my $val;
 314         if (exists $pagestate{$page}{meta}{$field}) {
 315                 $val=$pagestate{$page}{meta}{$field};
 316         }
 317         elsif ($field eq 'title') {
 318                 $val = pagetitle($page);
 319         }
 320
 321         if (defined $val) {
 322                 if ($val=~/^$re$/i) {
 323                         return IkiWiki::SuccessReason->new("$re matches $field of $page", $page => $IkiWiki::DEPEND_CONTENT, "" => 1);
 324                 }
 325                 else {
 326                         return IkiWiki::FailReason->new("$re does not match $field of $page", "" => 1);
 327                 }
 328         }
 329         else {
 330                 return IkiWiki::FailReason->new("$page does not have a $field", "" => 1);
 331         }
 332 }
 333
 334 package IkiWiki::PageSpec;
 335
 336 sub match_title ($$;@) {
 337         IkiWiki::Plugin::meta::match("title", @_);
 338 }
 339
 340 sub match_author ($$;@) {
 341         IkiWiki::Plugin::meta::match("author", @_);
 342 }
 343
 344 sub match_authorurl ($$;@) {
 345         IkiWiki::Plugin::meta::match("authorurl", @_);
 346 }
 347
 348 sub match_license ($$;@) {
 349         IkiWiki::Plugin::meta::match("license", @_);
 350 }
 351
 352 sub match_copyright ($$;@) {
 353         IkiWiki::Plugin::meta::match("copyright", @_);
 354 }
 355
 356 1