rename hook: run once per file to be renamed

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

diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 81355ef6d7a73d657be87eae768e0bfa206a77ba..4a22fed3057015156c27d9f8159e9f4b47e3a633 100644 (file)
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -4,17 +4,26 @@ package IkiWiki::Plugin::meta;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 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);
-} # }}}
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+               },
+}
 
-sub needsbuild (@) { #{{{
+sub needsbuild (@) {
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{meta}) {
@@ -29,16 +38,17 @@ sub needsbuild (@) { #{{{
        }
 }
 
-sub scrub ($) { #{{{
+sub scrub ($$) {
        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;
        }
-} #}}}
+}
 
-sub safeurl ($) { #{{{
+sub safeurl ($) {
        my $url=shift;
        if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
            defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
@@ -47,9 +57,9 @@ sub safeurl ($) { #{{{
        else {
                return 1;
        }
-} #}}}
+}
 
-sub htmlize ($$$) { #{{{
+sub htmlize ($$$) {
        my $page = shift;
        my $destpage = shift;
 
@@ -58,7 +68,7 @@ sub htmlize ($$$) { #{{{
                IkiWiki::preprocess($page, $destpage, shift)));
 }
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        return "" unless @_;
        my %params=@_;
        my $key=shift;
@@ -84,8 +94,8 @@ sub preprocess (@) { #{{{
                $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value);
                # fallthrough
        }
-       elsif ($key eq 'uuid') {
-               $pagestate{$page}{meta}{uuid}=HTML::Entities::encode_numeric($value);
+       elsif ($key eq 'guid') {
+               $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($value);
                # fallthrough
        }
        elsif ($key eq 'license') {
@@ -111,6 +121,20 @@ sub preprocess (@) { #{{{
                $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
                # fallthrough
        }
+       elsif ($key eq 'date') {
+               eval q{use Date::Parse};
+               if (! $@) {
+                       my $time = str2time($value);
+                       $IkiWiki::pagectime{$page}=$time if defined $time;
+               }
+       }
+       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
@@ -118,17 +142,10 @@ sub preprocess (@) { #{{{
        }
 
        # 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') {
+       if ($key eq 'permalink') {
                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') {
@@ -138,7 +155,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).
@@ -172,7 +189,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);
@@ -185,7 +202,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};
@@ -197,7 +214,7 @@ sub preprocess (@) { #{{{
                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;
        }
@@ -207,7 +224,7 @@ sub preprocess (@) { #{{{
                                join(" ", map {
                                        encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
                                } keys %params).
-                               " />\n");
+                               " />\n", $destpage);
                }
        }
        elsif ($key eq 'robots') {
@@ -216,13 +233,13 @@ sub preprocess (@) { #{{{
        }
        else {
                push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
-                       '" content="'.encode_entities($value).'" />');
+                       '" content="'.encode_entities($value).'" />', $destpage);
        }
 
        return "";
-} # }}}
+}
 
-sub pagetemplate (@) { #{{{
+sub pagetemplate (@) {
        my %params=@_;
         my $page=$params{page};
         my $destpage=$params{destpage};
@@ -250,9 +267,9 @@ sub pagetemplate (@) { #{{{
                        $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
                }
        }
-} # }}}
+}
 
-sub match { #{{{
+sub match {
        my $field=shift;
        my $page=shift;
        
@@ -264,7 +281,7 @@ sub match { #{{{
                $val=$pagestate{$page}{meta}{$field};
        }
        elsif ($field eq 'title') {
-               $val=pagetitle($page);
+               $val = pagetitle($page);
        }
 
        if (defined $val) {
@@ -278,28 +295,28 @@ sub match { #{{{
        else {
                return IkiWiki::FailReason->new("$page does not have a $field");
        }
-} #}}}
+}
 
 package IkiWiki::PageSpec;
 
-sub match_title ($$;@) { #{{{
+sub match_title ($$;@) {
        IkiWiki::Plugin::meta::match("title", @_);      
-} #}}}
+}
 
-sub match_author ($$;@) { #{{{
+sub match_author ($$;@) {
        IkiWiki::Plugin::meta::match("author", @_);
-} #}}}
+}
 
-sub match_authorurl ($$;@) { #{{{
+sub match_authorurl ($$;@) {
        IkiWiki::Plugin::meta::match("authorurl", @_);
-} #}}}
+}
 
-sub match_license ($$;@) { #{{{
+sub match_license ($$;@) {
        IkiWiki::Plugin::meta::match("license", @_);
-} #}}}
+}
 
-sub match_copyright ($$;@) { #{{{
+sub match_copyright ($$;@) {
        IkiWiki::Plugin::meta::match("copyright", @_);
-} #}}}
+}
 
 1