add plugin safe/rebuild info (part 1 of 2)

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

diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 849a13e37bfb2c437ba4bc7c998710548b943f49..b2c85c892146f21f76639fc1f498a35b61007f1f 100644 (file)
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -9,16 +9,26 @@ use IkiWiki 2.00;
 my %metaheaders;
 
 sub import { #{{{
+       hook(type => "getsetup", id => "meta", call => \&getsetup);
        hook(type => "needsbuild", id => "meta", call => \&needsbuild);
        hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
        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}) {
-                       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
@@ -37,11 +47,22 @@ 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;
 
-       return IkiWiki::htmlize($page, pagetype($pagesources{$page}),
+       return IkiWiki::htmlize($page, $destpage, pagetype($pagesources{$page}),
                IkiWiki::linkify($page, $destpage,
                IkiWiki::preprocess($page, $destpage, shift)));
 }
@@ -66,6 +87,15 @@ sub preprocess (@) { #{{{
        # Metadata collection that needs to happen during the scan pass.
        if ($key eq 'title') {
                $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value);
+               # fallthrough
+       }
+       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" />';
@@ -87,7 +117,7 @@ sub preprocess (@) { #{{{
                # fallthorough
        }
        elsif ($key eq 'authorurl') {
-               $pagestate{$page}{meta}{authorurl}=$value;
+               $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
                # fallthrough
        }
 
@@ -105,8 +135,10 @@ sub preprocess (@) { #{{{
                }
        }
        elsif ($key eq 'permalink') {
-               $pagestate{$page}{meta}{permalink}=$value;
-               push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
+               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";
@@ -115,7 +147,7 @@ sub preprocess (@) { #{{{
                # 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 @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
                        '" rel="'.encode_entities($rel).
@@ -123,12 +155,22 @@ sub preprocess (@) { #{{{
                        "\" type=\"text/css\" />";
        }
        elsif ($key eq 'openid') {
-               if (exists $params{server}) {
+               if (exists $params{server} && safeurl($params{server})) {
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{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 @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
-                       '" rel="openid.delegate" />';
        }
        elsif ($key eq 'redir') {
                return "" if $page ne $destpage;
@@ -139,7 +181,7 @@ sub preprocess (@) { #{{{
                        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);
@@ -152,7 +194,7 @@ sub preprocess (@) { #{{{
                        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};
@@ -162,7 +204,7 @@ sub preprocess (@) { #{{{
                        $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);
                }
@@ -177,6 +219,10 @@ sub preprocess (@) { #{{{
                                " />\n");
                }
        }
+       elsif ($key eq 'robots') {
+               push @{$metaheaders{$page}}, '<meta name="robots"'.
+                       ' content="'.encode_entities($value).'" />';
+       }
        else {
                push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
                        '" content="'.encode_entities($value).'" />');
@@ -220,16 +266,14 @@ sub match { #{{{
        my $page=shift;
        
        # turn glob into a safe regexp
-       my $re=quotemeta(shift);
-       $re=~s/\\\*/.*/g;
-       $re=~s/\\\?/./g;
+       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);
+               $val = IkiWiki::pagetitle($page);
        }
 
        if (defined $val) {