]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/meta.pm
releasing version 2.31.1
[git.ikiwiki.info.git] / IkiWiki / Plugin / meta.pm
index 987262a48c6961bed98b480e5466614b0588d5dc..621e876741b288466112360b96290bac01235e52 100644 (file)
@@ -6,17 +6,11 @@ use warnings;
 use strict;
 use IkiWiki 2.00;
 
-my %meta;
-my %title;
-my %permalink;
-my %author;
-my %authorurl;
-my %license;
-my %copyright;
+my %metaheaders;
 
 sub import { #{{{
        hook(type => "needsbuild", id => "meta", call => \&needsbuild);
-       hook(type => "preprocess", id => "meta", call => \&preprocess);
+       hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
        hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
 } # }}}
 
@@ -24,7 +18,8 @@ sub needsbuild (@) { #{{{
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{meta}) {
-                       if (grep { $_ eq $pagesources{$page} } @$needsbuild) {
+                       if (exists $pagesources{$page} &&
+                           grep { $_ eq $pagesources{$page} } @$needsbuild) {
                                # remove state, it will be re-added
                                # if the preprocessor directive is still
                                # there during the rebuild
@@ -43,6 +38,15 @@ sub scrub ($) { #{{{
        }
 } #}}}
 
+sub htmlize ($$$) { #{{{
+       my $page = shift;
+       my $destpage = shift;
+
+       return IkiWiki::htmlize($page, pagetype($pagesources{$page}),
+               IkiWiki::linkify($page, $destpage,
+               IkiWiki::preprocess($page, $destpage, shift)));
+}
+
 sub preprocess (@) { #{{{
        return "" unless @_;
        my %params=@_;
@@ -60,20 +64,51 @@ sub preprocess (@) { #{{{
        # fully encoded.
        $value=decode_entities($value);
 
+       # Metadata collection that needs to happen during the scan pass.
        if ($key eq 'title') {
-               $title{$page}=HTML::Entities::encode_numeric($value);
+               $pagestate{$page}{meta}{title}=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 'license') {
+               push @{$metaheaders{$page}}, '<link rel="license" href="#page_license" />';
+               $pagestate{$page}{meta}{license}=$value;
+               return "";
+       }
+       elsif ($key eq 'copyright') {
+               push @{$metaheaders{$page}}, '<link rel="copyright" href="#page_copyright" />';
+               $pagestate{$page}{meta}{copyright}=$value;
+               return "";
        }
-       elsif ($key eq 'date') {
+       elsif ($key eq 'link' && ! %params) {
+               # hidden WikiLink
+               push @{$links{$page}}, $value;
+               return "";
+       }
+       elsif ($key eq 'author') {
+               $pagestate{$page}{meta}{author}=$value;
+               # fallthorough
+       }
+       elsif ($key eq 'authorurl') {
+               $pagestate{$page}{meta}{authorurl}=$value;
+               # fallthrough
+       }
+
+       if (! defined wantarray) {
+               # avoid collecting duplicate data during scan pass
+               return;
+       }
+
+       # Metadata collection that happens only during preprocessing pass.
+       if ($key eq 'date') {
                eval q{use Date::Parse};
                if (! $@) {
                        my $time = str2time($value);
                        $IkiWiki::pagectime{$page}=$time if defined $time;
                }
        }
+       elsif ($key eq 'permalink') {
+               $pagestate{$page}{meta}{permalink}=$value;
+               push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
+       }
        elsif ($key eq 'stylesheet') {
                my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
                my $title=exists $params{title} ? $params{title} : $value;
@@ -83,27 +118,19 @@ sub preprocess (@) { #{{{
                if (! length $stylesheet) {
                        return "[[meta ".gettext("stylesheet not found")."]]";
                }
-               push @{$meta{$page}}, '<link href="'.urlto($stylesheet, $page).
+               push @{$metaheaders{$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}).
+                       push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
                                '" rel="openid.server" />';
                }
-               push @{$meta{$page}}, '<link href="'.encode_entities($value).
+               push @{$metaheaders{$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;
@@ -140,20 +167,20 @@ sub preprocess (@) { #{{{
                if (! $safe) {
                        $redir=scrub($redir);
                }
-               push @{$meta{$page}}, $redir;
+               push @{$metaheaders{$page}}, $redir;
        }
        elsif ($key eq 'link') {
-               return "[[meta ".gettext("link is no longer supported")."]]";
+               if (%params) {
+                       push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
+                               join(" ", map {
+                                       encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
+                               } keys %params).
+                               " />\n");
+               }
        }
        else {
-               push @{$meta{$page}}, scrub('<meta name="'.encode_entities($key).
+               push @{$metaheaders{$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 "";
@@ -165,41 +192,80 @@ sub pagetemplate (@) { #{{{
         my $destpage=$params{destpage};
         my $template=$params{template};
 
-       if (exists $meta{$page} && $template->query(name => "meta")) {
+       if (exists $metaheaders{$page} && $template->query(name => "meta")) {
                # avoid duplicate meta lines
                my %seen;
-               $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$meta{$page}}));
+               $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
        }
-       if (exists $title{$page} && $template->query(name => "title")) {
-               $template->param(title => $title{$page});
+       if (exists $pagestate{$page}{meta}{title} && $template->query(name => "title")) {
+               $template->param(title => $pagestate{$page}{meta}{title});
                $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}));
+
+       foreach my $field (qw{author authorurl permalink}) {
+               $template->param($field => $pagestate{$page}{meta}{$field})
+                       if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
+       }
+
+       foreach my $field (qw{license copyright}) {
+               if (exists $pagestate{$page}{meta}{$field} && $template->query(name => $field) &&
+                   ($page eq $destpage || ! exists $pagestate{$destpage}{meta}{$field} ||
+                    $pagestate{$page}{meta}{$field} ne $pagestate{$destpage}{meta}{$field})) {
+                       $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
+               }
        }
 } # }}}
 
+sub match { #{{{
+       my $field=shift;
+       my $page=shift;
+       
+       # turn glob into a safe regexp
+       my $re=quotemeta(shift);
+       $re=~s/\\\*/.*/g;
+       $re=~s/\\\?/./g;
+
+       my $val;
+       if (exists $pagestate{$page}{meta}{$field}) {
+               $val=$pagestate{$page}{meta}{$field};
+       }
+       elsif ($field eq 'title') {
+               $val=pagetitle($page);
+       }
+
+       if (defined $val) {
+               if ($val=~/^$re$/i) {
+                       return IkiWiki::SuccessReason->new("$re matches $field of $page");
+               }
+               else {
+                       return IkiWiki::FailReason->new("$re does not match $field of $page");
+               }
+       }
+       else {
+               return IkiWiki::FailReason->new("$page does not have a $field");
+       }
+} #}}}
+
+package IkiWiki::PageSpec;
+
+sub match_title ($$;@) { #{{{
+       IkiWiki::Plugin::meta::match("title", @_);      
+} #}}}
+
+sub match_author ($$;@) { #{{{
+       IkiWiki::Plugin::meta::match("author", @_);
+} #}}}
+
+sub match_authorurl ($$;@) { #{{{
+       IkiWiki::Plugin::meta::match("authorurl", @_);
+} #}}}
+
+sub match_license ($$;@) { #{{{
+       IkiWiki::Plugin::meta::match("license", @_);
+} #}}}
+
+sub match_copyright ($$;@) { #{{{
+       IkiWiki::Plugin::meta::match("copyright", @_);
+} #}}}
+
 1