Merge commit 'upstream/master'

[git.ikiwiki.info.git] / IkiWiki / Plugin / meta.pm

diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 88c942fa4f85ba2664eb9756e60421ee22aacc44..8d444109f68dc304d6c055df1191b3efbc2b9b60 100644 (file)
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -6,25 +6,29 @@ use warnings;
 use strict;
 use IkiWiki 2.00;
 
 use strict;
 use IkiWiki 2.00;
 

-my %meta;
-my %title;
-my %permalink;
-my %author;
-my %authorurl;
-my %license;
-my %copyright;
+my %metaheaders;

 
 sub import { #{{{
 
 sub import { #{{{

+       hook(type => "getsetup", id => "meta", call => \&getsetup);

        hook(type => "needsbuild", id => "meta", call => \&needsbuild);
        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);
 } # }}}
 
        hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
 } # }}}
 

+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+} #}}}
+

 sub needsbuild (@) { #{{{
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{meta}) {
 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
                                # remove state, it will be re-added
                                # if the preprocessor directive is still
                                # there during the rebuild


@@ -43,21 +47,24 @@ sub scrub ($) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+sub safeurl ($) { #{{{
+       my $url=shift;
+       if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
+           defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
+               return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
+       }
+       else {
+               return 1;
+       }
+} #}}}
+

 sub htmlize ($$$) { #{{{
        my $page = shift;
        my $destpage = shift;
 sub htmlize ($$$) { #{{{
        my $page = shift;
        my $destpage = shift;

-       my $text = shift;

 
 

-       $text=IkiWiki::htmlize($page, pagetype($pagesources{$page}),
+       return IkiWiki::htmlize($page, $destpage, pagetype($pagesources{$page}),

                IkiWiki::linkify($page, $destpage,
                IkiWiki::linkify($page, $destpage,

-               IkiWiki::preprocess($page, $destpage, $text)));
-
-       # hack to get rid of enclosing junk added by markdown
-       $text=~s!^<p>!!;
-       $text=~s!</p>$!!;
-       chomp $text;
-
-       return $text;
+               IkiWiki::preprocess($page, $destpage, shift)));

 }
 
 sub preprocess (@) { #{{{
 }
 
 sub preprocess (@) { #{{{


@@ -77,20 +84,62 @@ sub preprocess (@) { #{{{
        # fully encoded.
        $value=decode_entities($value);
 
        # fully encoded.
        $value=decode_entities($value);
 

+       # Metadata collection that needs to happen during the scan pass.

        if ($key eq 'title') {
        if ($key eq 'title') {

-               $title{$page}=HTML::Entities::encode_numeric($value);
+               $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value);
+               # fallthrough

        }
        }

-       elsif ($key eq 'permalink') {
-               $permalink{$page}=$value;
-               push @{$meta{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
+       elsif ($key eq 'description') {
+               $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value);
+               # fallthrough
+       }
+       elsif ($key eq 'guid') {
+               $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($value);
+               # fallthrough
+       }
+       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 'link' && ! %params) {
+               # hidden WikiLink
+               push @{$links{$page}}, $value;
+               return "";

        }
        }

-       elsif ($key eq 'date') {
+       elsif ($key eq 'author') {
+               $pagestate{$page}{meta}{author}=$value;
+               # fallthorough
+       }
+       elsif ($key eq 'authorurl') {
+               $pagestate{$page}{meta}{authorurl}=$value if safeurl($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;
                }
        }
                eval q{use Date::Parse};
                if (! $@) {
                        my $time = str2time($value);
                        $IkiWiki::pagectime{$page}=$time if defined $time;
                }
        }

+       elsif ($key eq 'permalink') {
+               if (safeurl($value)) {
+                       $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;
        elsif ($key eq 'stylesheet') {
                my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
                my $title=exists $params{title} ? $params{title} : $value;


@@ -98,28 +147,30 @@ sub preprocess (@) { #{{{
                # editable page as a stylesheet
                my $stylesheet=bestlink($page, $value.".css");
                if (! length $stylesheet) {
                # editable page as a stylesheet
                my $stylesheet=bestlink($page, $value.".css");
                if (! length $stylesheet) {

-                       return "[[meta ".gettext("stylesheet not found")."]]";
+                       error 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') {
                        '" 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}).
+               if (exists $params{server} && safeurl($params{server})) {
+                       push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).

                                '" rel="openid.server" />';
                                '" rel="openid.server" />';

+                       push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
+                               '" rel="openid2.provider" />';
+               }
+               if (safeurl($value)) {
+                       push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
+                               '" rel="openid.delegate" />';
+                       push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
+                               '" rel="openid2.local_id" />';
+               }
+               if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
+                       push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location"'.
+                               'content="'.encode_entities($params{"xrds-location"}).'" />';

                }
                }

-               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;
        }
        elsif ($key eq 'redir') {
                return "" if $page ne $destpage;


@@ -130,7 +181,7 @@ sub preprocess (@) { #{{{
                        add_depends($page, $redir_page);
                        my $link=bestlink($page, $redir_page);
                        if (! length $link) {
                        add_depends($page, $redir_page);
                        my $link=bestlink($page, $redir_page);
                        if (! length $link) {

-                               return "[[meta ".gettext("redir page not found")."]]";
+                               error gettext("redir page not found")

                        }
 
                        $value=urlto($link, $page);
                        }
 
                        $value=urlto($link, $page);


@@ -143,7 +194,7 @@ sub preprocess (@) { #{{{
                        my %seen;
                        while (exists $pagestate{$at}{meta}{redir}) {
                                if ($seen{$at}) {
                        my %seen;
                        while (exists $pagestate{$at}{meta}{redir}) {
                                if ($seen{$at}) {

-                                       return "[[meta ".gettext("redir cycle is not allowed")."]]";
+                                       error gettext("redir cycle is not allowed")

                                }
                                $seen{$at}=1;
                                $at=$pagestate{$at}{meta}{redir};
                                }
                                $seen{$at}=1;
                                $at=$pagestate{$at}{meta}{redir};


@@ -153,24 +204,28 @@ sub preprocess (@) { #{{{
                        $value=encode_entities($value);
                }
                my $delay=int(exists $params{delay} ? $params{delay} : 0);
                        $value=encode_entities($value);
                }
                my $delay=int(exists $params{delay} ? $params{delay} : 0);

-               my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\">";
+               my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";

                if (! $safe) {
                        $redir=scrub($redir);
                }
                if (! $safe) {
                        $redir=scrub($redir);
                }

-               push @{$meta{$page}}, $redir;
+               push @{$metaheaders{$page}}, $redir;

        }
        elsif ($key eq 'link') {
        }
        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");
+               }
+       }
+       elsif ($key eq 'robots') {
+               push @{$metaheaders{$page}}, '<meta name="robots"'.
+                       ' content="'.encode_entities($value).'" />';

        }
        else {
        }
        else {

-               push @{$meta{$page}}, scrub('<meta name="'.encode_entities($key).
+               push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).

                        '" content="'.encode_entities($value).'" />');
                        '" content="'.encode_entities($value).'" />');

-               if ($key eq 'author') {
-                       $author{$page}=$value;
-               }
-               elsif ($key eq 'authorurl') {
-                       $authorurl{$page}=$value;
-               }

        }
 
        return "";
        }
 
        return "";


@@ -182,41 +237,78 @@ sub pagetemplate (@) { #{{{
         my $destpage=$params{destpage};
         my $template=$params{template};
 
         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;
                # 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(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 => htmlize($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 => htmlize($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=IkiWiki::glob2re(shift);
+
+       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
 1