]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Plugin/meta.pm
rssurl and atomurl are only needed where $feeds is set
[ikiwiki.git] / IkiWiki / Plugin / meta.pm
index bac16346932d2a00e1bc034d500a1fe8a08abebb..8555e1109b76afaf585daa6ec95ee261edbd0036 100644 (file)
@@ -4,62 +4,153 @@ package IkiWiki::Plugin::meta;
 
 use warnings;
 use strict;
-use IkiWiki;
+use IkiWiki 2.00;
 
 my %meta;
 my %title;
+my %permalink;
+my %author;
+my %authorurl;
+my %license;
+my %copyright;
 
 sub import { #{{{
-       IkiWiki::hook(type => "preprocess", id => "meta", 
-               call => \&preprocess);
-       IkiWiki::hook(type => "filter", id => "meta", 
-               call => \&filter);
-       IkiWiki::hook(type => "pagetemplate", id => "meta", 
-               call => \&pagetemplate);
+       hook(type => "needsbuild", id => "meta", call => \&needsbuild);
+       hook(type => "preprocess", id => "meta", call => \&preprocess);
+       hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
 } # }}}
 
-sub filter (@) { #{{{
-       my %params=@_;
-       
-       $meta{$params{page}}='';
+sub needsbuild (@) { #{{{
+       my $needsbuild=shift;
+       foreach my $page (keys %pagestate) {
+               if (exists $pagestate{$page}{meta}) {
+                       if (grep { $_ eq $pagesources{$page} } @$needsbuild) {
+                               # remove state, it will be re-added
+                               # if the preprocessor directive is still
+                               # there during the rebuild
+                               delete $pagestate{$page}{meta};
+                       }
+               }
+       }
+}
 
-       return $params{content};
-} # }}}
+sub scrub ($) { #{{{
+       if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
+               return IkiWiki::Plugin::htmlscrubber::sanitize(content => shift);
+       }
+       else {
+               return shift;
+       }
+} #}}}
 
 sub preprocess (@) { #{{{
-       if (! @_) {
-               return "";
-       }
+       return "" unless @_;
        my %params=@_;
        my $key=shift;
        my $value=$params{$key};
        delete $params{$key};
        my $page=$params{page};
        delete $params{page};
+       my $destpage=$params{destpage};
        delete $params{destpage};
+       delete $params{preview};
 
        eval q{use HTML::Entities};
-       # Always dencode, even if encoding later, since it might not be
+       # Always decode, even if encoding later, since it might not be
        # fully encoded.
        $value=decode_entities($value);
 
-       if ($key eq 'link') {
-               if (%params) {
-                       $meta{$page}.="<link href=\"".encode_entities($value)."\" ".
-                               join(" ", map { encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\"" } keys %params).
-                               " />\n";
+       if ($key eq 'title') {
+               $title{$page}=HTML::Entities::encode_numeric($value);
+       }
+       elsif ($key eq 'permalink') {
+               $permalink{$page}=$value;
+               push @{$meta{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
+       }
+       elsif ($key eq 'date') {
+               eval q{use Date::Parse};
+               if (! $@) {
+                       my $time = str2time($value);
+                       $IkiWiki::pagectime{$page}=$time if defined $time;
+               }
+       }
+       elsif ($key eq 'stylesheet') {
+               my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
+               my $title=exists $params{title} ? $params{title} : $value;
+               # adding .css to the value prevents using any old web
+               # editable page as a stylesheet
+               my $stylesheet=bestlink($page, $value.".css");
+               if (! length $stylesheet) {
+                       return "[[meta ".gettext("stylesheet not found")."]]";
+               }
+               push @{$meta{$page}}, '<link href="'.urlto($stylesheet, $page).
+                       '" rel="'.encode_entities($rel).
+                       '" title="'.encode_entities($title).
+                       "\" type=\"text/css\" />";
+       }
+       elsif ($key eq 'openid') {
+               if (exists $params{server}) {
+                       push @{$meta{$page}}, '<link href="'.encode_entities($params{server}).
+                               '" rel="openid.server" />';
+               }
+               push @{$meta{$page}}, '<link href="'.encode_entities($value).
+                       '" rel="openid.delegate" />';
+       }
+       elsif ($key eq 'license') {
+               push @{$meta{$page}}, '<link rel="license" href="#page_license" />';
+               $license{$page}=$value;
+       }
+       elsif ($key eq 'copyright') {
+               push @{$meta{$page}}, '<link rel="copyright" href="#page_copyright" />';
+               $copyright{$page}=$value;
+       }
+       elsif ($key eq 'redir') {
+               return "" if $page ne $destpage;
+               my $safe=0;
+               if ($value !~ /^\w+:\/\//) {
+                       add_depends($page, $value);
+                       my $link=bestlink($page, $value);
+                       if (! length $link) {
+                               return "[[meta ".gettext("redir page not found")."]]";
+                       }
+
+                       $value=urlto($link, $page);
+                       $safe=1;
+
+                       # redir cycle detection
+                       $pagestate{$page}{meta}{redir}=$link;
+                       my $at=$page;
+                       my %seen;
+                       while (exists $pagestate{$at}{meta}{redir}) {
+                               if ($seen{$at}) {
+                                       return "[[meta ".gettext("redir cycle is not allowed")."]]";
+                               }
+                               $seen{$at}=1;
+                               $at=$pagestate{$at}{meta}{redir};
+                       }
                }
                else {
-                       # hidden WikiLink
-                       push @{$IkiWiki::links{$page}}, $value;
+                       $value=encode_entities($value);
+               }
+               my $delay=int(exists $params{delay} ? $params{delay} : 0);
+               my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\">";
+               if (! $safe) {
+                       $redir=scrub($redir);
                }
+               push @{$meta{$page}}, $redir;
        }
-       elsif ($key eq 'title') {
-               $title{$page}=$value;
+       elsif ($key eq 'link') {
+               return "[[meta ".gettext("link is no longer supported")."]]";
        }
        else {
-               $meta{$page}.="<meta name=\"".encode_entities($key).
-                       "\" content=\"".encode_entities($value)."\" />\n";
+               push @{$meta{$page}}, scrub('<meta name="'.encode_entities($key).
+                       '" content="'.encode_entities($value).'" />');
+               if ($key eq 'author') {
+                       $author{$page}=$value;
+               }
+               elsif ($key eq 'authorurl') {
+                       $authorurl{$page}=$value;
+               }
        }
 
        return "";
@@ -68,12 +159,44 @@ sub preprocess (@) { #{{{
 sub pagetemplate (@) { #{{{
        my %params=@_;
         my $page=$params{page};
+        my $destpage=$params{destpage};
         my $template=$params{template};
 
-       $template->param(meta => $meta{$page})
-               if exists $meta{$page} && $template->query(name => "meta");
-       $template->param(title => $title{$page})
-               if exists $title{$page} && $template->query(name => "title");
+       if (exists $meta{$page} && $template->query(name => "meta")) {
+               # avoid duplicate meta lines
+               my %seen;
+               $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$meta{$page}}));
+       }
+       if (exists $title{$page} && $template->query(name => "title")) {
+               $template->param(title => $title{$page});
+               $template->param(title_overridden => 1);
+       }
+       $template->param(permalink => $permalink{$page})
+               if exists $permalink{$page} && $template->query(name => "permalink");
+       $template->param(author => $author{$page})
+               if exists $author{$page} && $template->query(name => "author");
+       $template->param(authorurl => $authorurl{$page})
+               if exists $authorurl{$page} && $template->query(name => "authorurl");
+               
+       if ($page ne $destpage &&
+           ((exists $license{$page}   && ! exists $license{$destpage}) ||
+            (exists $copyright{$page} && ! exists $copyright{$destpage}))) {
+               # Force a scan of the destpage to get its copyright/license
+               # info. If the info is declared after an inline, it will
+               # otherwise not be available at this point.
+               IkiWiki::scan($pagesources{$destpage});
+       }
+
+       if (exists $license{$page} && $template->query(name => "license") &&
+           ($page eq $destpage || ! exists $license{$destpage} ||
+            $license{$page} ne $license{$destpage})) {
+               $template->param(license => IkiWiki::linkify($page, $destpage, $license{$page}));
+       }
+       if (exists $copyright{$page} && $template->query(name => "copyright") &&
+           ($page eq $destpage || ! exists $copyright{$destpage} ||
+            $copyright{$page} ne $copyright{$destpage})) {
+               $template->param(copyright => IkiWiki::linkify($page, $destpage, $copyright{$page}));
+       }
 } # }}}
 
 1