]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/meta.pm
Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[git.ikiwiki.info.git] / IkiWiki / Plugin / meta.pm
index 55c214f67830e889fd51e8890fc97091a11d3f8b..5f046cb2a06e90fdc53939ae2d2b3490d2d4d30e 100644 (file)
@@ -4,17 +4,27 @@ package IkiWiki::Plugin::meta;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 my %metaheaders;
 
 
 my %metaheaders;
 
-sub import { #{{{
+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);
        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,
+                       section => "core",
+               },
+}
 
 
-sub needsbuild (@) { #{{{
+sub needsbuild (@) {
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{meta}) {
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{meta}) {
@@ -29,16 +39,17 @@ sub needsbuild (@) { #{{{
        }
 }
 
        }
 }
 
-sub scrub ($) { #{{{
+sub scrub ($$) {
        if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
        if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
-               return IkiWiki::Plugin::htmlscrubber::sanitize(content => shift);
+               return IkiWiki::Plugin::htmlscrubber::sanitize(
+                       content => shift, destpage => shift);
        }
        else {
                return shift;
        }
        }
        else {
                return shift;
        }
-} #}}}
+}
 
 
-sub safeurl ($) { #{{{
+sub safeurl ($) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
@@ -47,9 +58,9 @@ sub safeurl ($) { #{{{
        else {
                return 1;
        }
        else {
                return 1;
        }
-} #}}}
+}
 
 
-sub htmlize ($$$) { #{{{
+sub htmlize ($$$) {
        my $page = shift;
        my $destpage = shift;
 
        my $page = shift;
        my $destpage = shift;
 
@@ -58,7 +69,7 @@ sub htmlize ($$$) { #{{{
                IkiWiki::preprocess($page, $destpage, shift)));
 }
 
                IkiWiki::preprocess($page, $destpage, shift)));
 }
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        return "" unless @_;
        my %params=@_;
        my $key=shift;
        return "" unless @_;
        my %params=@_;
        my $key=shift;
@@ -78,20 +89,14 @@ 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);
        # Metadata collection that needs to happen during the scan pass.
        if ($key eq 'title') {
                $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value);
-               # fallthrough
+               return "";
        }
        elsif ($key eq 'description') {
                $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value);
                # fallthrough
        }
        elsif ($key eq 'guid') {
        }
        elsif ($key eq 'description') {
                $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value);
                # fallthrough
        }
        elsif ($key eq 'guid') {
-               my $abs = $value;
-
-               if ($abs =~ m/^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{12}$/) {
-                       $abs = lc "urn:uuid:$abs";
-               }
-
-               $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($abs);
+               $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($value);
                # fallthrough
        }
        elsif ($key eq 'license') {
                # fallthrough
        }
        elsif ($key eq 'license') {
@@ -106,7 +111,7 @@ sub preprocess (@) { #{{{
        }
        elsif ($key eq 'link' && ! %params) {
                # hidden WikiLink
        }
        elsif ($key eq 'link' && ! %params) {
                # hidden WikiLink
-               push @{$links{$page}}, $value;
+               add_link($page, $value);
                return "";
        }
        elsif ($key eq 'author') {
                return "";
        }
        elsif ($key eq 'author') {
@@ -117,24 +122,34 @@ sub preprocess (@) { #{{{
                $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
                # fallthrough
        }
                $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
                # fallthrough
        }
-
-       if (! defined wantarray) {
-               # avoid collecting duplicate data during scan pass
-               return;
+       elsif ($key eq 'permalink') {
+               $pagestate{$page}{meta}{permalink}=$value if safeurl($value);
+               # fallthrough
        }
        }
-
-       # Metadata collection that happens only during preprocessing pass.
-       if ($key eq 'date') {
+       elsif ($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') {
+       elsif ($key eq 'updated') {
+               eval q{use Date::Parse};
+               if (! $@) {
+                       my $time = str2time($value);
+                       $pagestate{$page}{meta}{updated}=$time if defined $time;
+               }
+       }
+
+       if (! defined wantarray) {
+               # avoid collecting duplicate data during scan pass
+               return;
+       }
+
+       # Metadata handling that happens only during preprocessing pass.
+       if ($key eq 'permalink') {
                if (safeurl($value)) {
                if (safeurl($value)) {
-                       $pagestate{$page}{meta}{permalink}=$value;
-                       push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
+                       push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />', $destpage);
                }
        }
        elsif ($key eq 'stylesheet') {
                }
        }
        elsif ($key eq 'stylesheet') {
@@ -144,7 +159,7 @@ 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 @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
                        '" rel="'.encode_entities($rel).
                }
                push @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
                        '" rel="'.encode_entities($rel).
@@ -152,17 +167,22 @@ sub preprocess (@) { #{{{
                        "\" type=\"text/css\" />";
        }
        elsif ($key eq 'openid') {
                        "\" type=\"text/css\" />";
        }
        elsif ($key eq 'openid') {
+               my $delegate=0; # both by default
+               if (exists $params{delegate}) {
+                       $delegate = 1 if lc $params{delegate} eq 'openid';
+                       $delegate = 2 if lc $params{delegate} eq 'openid2';
+               }
                if (exists $params{server} && safeurl($params{server})) {
                        push @{$metaheaders{$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" />' if $delegate ne 2;
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
-                               '" rel="openid2.provider" />';
+                               '" rel="openid2.provider" />' if $delegate ne 1;
                }
                if (safeurl($value)) {
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
                }
                if (safeurl($value)) {
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
-                               '" rel="openid.delegate" />';
+                               '" rel="openid.delegate" />' if $delegate ne 2;
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
                        push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
-                               '" rel="openid2.local_id" />';
+                               '" rel="openid2.local_id" />' if $delegate ne 1;
                }
                if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
                        push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location"'.
                }
                if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
                        push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location"'.
@@ -175,11 +195,11 @@ sub preprocess (@) { #{{{
                if ($value !~ /^\w+:\/\//) {
                        my ($redir_page, $redir_anchor) = split /\#/, $value;
 
                if ($value !~ /^\w+:\/\//) {
                        my ($redir_page, $redir_anchor) = split /\#/, $value;
 
-                       add_depends($page, $redir_page);
                        my $link=bestlink($page, $redir_page);
                        if (! length $link) {
                        my $link=bestlink($page, $redir_page);
                        if (! length $link) {
-                               return "[[meta ".gettext("redir page not found")."]]";
+                               error gettext("redir page not found")
                        }
                        }
+                       add_depends($page, $link, deptype("presence"));
 
                        $value=urlto($link, $page);
                        $value.='#'.$redir_anchor if defined $redir_anchor;
 
                        $value=urlto($link, $page);
                        $value.='#'.$redir_anchor if defined $redir_anchor;
@@ -191,7 +211,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};
@@ -203,7 +223,7 @@ sub preprocess (@) { #{{{
                my $delay=int(exists $params{delay} ? $params{delay} : 0);
                my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";
                if (! $safe) {
                my $delay=int(exists $params{delay} ? $params{delay} : 0);
                my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";
                if (! $safe) {
-                       $redir=scrub($redir);
+                       $redir=scrub($redir, $destpage);
                }
                push @{$metaheaders{$page}}, $redir;
        }
                }
                push @{$metaheaders{$page}}, $redir;
        }
@@ -213,22 +233,26 @@ sub preprocess (@) { #{{{
                                join(" ", map {
                                        encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
                                } keys %params).
                                join(" ", map {
                                        encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
                                } keys %params).
-                               " />\n");
+                               " />\n", $destpage);
                }
        }
        elsif ($key eq 'robots') {
                push @{$metaheaders{$page}}, '<meta name="robots"'.
                        ' content="'.encode_entities($value).'" />';
        }
                }
        }
        elsif ($key eq 'robots') {
                push @{$metaheaders{$page}}, '<meta name="robots"'.
                        ' content="'.encode_entities($value).'" />';
        }
+       elsif ($key eq 'description') {
+               push @{$metaheaders{$page}}, '<meta name="'.encode_entities($key).
+                       '" content="'.encode_entities($value).'" />';
+       }
        else {
                push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
        else {
                push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
-                       '" content="'.encode_entities($value).'" />');
+                       '" content="'.encode_entities($value).'" />', $destpage);
        }
 
        return "";
        }
 
        return "";
-} # }}}
+}
 
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params=@_;
         my $page=$params{page};
         my $destpage=$params{destpage};
        my %params=@_;
         my $page=$params{page};
         my $destpage=$params{destpage};
@@ -244,7 +268,7 @@ sub pagetemplate (@) { #{{{
                $template->param(title_overridden => 1);
        }
 
                $template->param(title_overridden => 1);
        }
 
-       foreach my $field (qw{author authorurl permalink}) {
+       foreach my $field (qw{author authorurl description permalink}) {
                $template->param($field => $pagestate{$page}{meta}{$field})
                        if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
        }
                $template->param($field => $pagestate{$page}{meta}{$field})
                        if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
        }
@@ -256,9 +280,9 @@ sub pagetemplate (@) { #{{{
                        $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
                }
        }
                        $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
                }
        }
-} # }}}
+}
 
 
-sub match { #{{{
+sub match {
        my $field=shift;
        my $page=shift;
        
        my $field=shift;
        my $page=shift;
        
@@ -270,42 +294,42 @@ sub match { #{{{
                $val=$pagestate{$page}{meta}{$field};
        }
        elsif ($field eq 'title') {
                $val=$pagestate{$page}{meta}{$field};
        }
        elsif ($field eq 'title') {
-               $val = IkiWiki::pagetitle($page);
+               $val = pagetitle($page);
        }
 
        if (defined $val) {
                if ($val=~/^$re$/i) {
        }
 
        if (defined $val) {
                if ($val=~/^$re$/i) {
-                       return IkiWiki::SuccessReason->new("$re matches $field of $page");
+                       return IkiWiki::SuccessReason->new("$re matches $field of $page", $page => $IkiWiki::DEPEND_CONTENT, "" => 1);
                }
                else {
                }
                else {
-                       return IkiWiki::FailReason->new("$re does not match $field of $page");
+                       return IkiWiki::FailReason->new("$re does not match $field of $page", "" => 1);
                }
        }
        else {
                }
        }
        else {
-               return IkiWiki::FailReason->new("$page does not have a $field");
+               return IkiWiki::FailReason->new("$page does not have a $field", "" => 1);
        }
        }
-} #}}}
+}
 
 package IkiWiki::PageSpec;
 
 
 package IkiWiki::PageSpec;
 
-sub match_title ($$;@) { #{{{
-       IkiWiki::Plugin::meta::match("title", @_);      
-} #}}}
+sub match_title ($$;@) {
+       IkiWiki::Plugin::meta::match("title", @_);
+}
 
 
-sub match_author ($$;@) { #{{{
+sub match_author ($$;@) {
        IkiWiki::Plugin::meta::match("author", @_);
        IkiWiki::Plugin::meta::match("author", @_);
-} #}}}
+}
 
 
-sub match_authorurl ($$;@) { #{{{
+sub match_authorurl ($$;@) {
        IkiWiki::Plugin::meta::match("authorurl", @_);
        IkiWiki::Plugin::meta::match("authorurl", @_);
-} #}}}
+}
 
 
-sub match_license ($$;@) { #{{{
+sub match_license ($$;@) {
        IkiWiki::Plugin::meta::match("license", @_);
        IkiWiki::Plugin::meta::match("license", @_);
-} #}}}
+}
 
 
-sub match_copyright ($$;@) { #{{{
+sub match_copyright ($$;@) {
        IkiWiki::Plugin::meta::match("copyright", @_);
        IkiWiki::Plugin::meta::match("copyright", @_);
-} #}}}
+}
 
 1
 
 1