update comment

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

diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index cfa4b84b1d9d92382a28e60ae54501683c5dff31..d2c6e7f8bfa404739498940050bda916b54d3209 100644 (file)
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -15,18 +15,24 @@ my %license;
 my %copyright;
 
 sub import { #{{{
 my %copyright;
 
 sub import { #{{{

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

        hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
        hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);

-       hook(type => "filter", id => "meta", call => \&filter);

        hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
 } # }}}
 
        hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
 } # }}}
 

-sub filter (@) { #{{{
-       my %params=@_;
-       
-       $meta{$params{page}}='';
-
-       return $params{content};
-} # }}}
+sub needsbuild (@) { #{{{
+       my $needsbuild=shift;
+       foreach my $page (keys %pagestate) {
+               if (exists $pagestate{$page}{meta}) {
+                       if (grep { $_ eq $pagesources{$page} } @$needsbuild) {
+                               # remove state, it will be re-added
+                               # if the preprocessor directive is still
+                               # there during the rebuild
+                               delete $pagestate{$page}{meta};
+                       }
+               }
+       }
+}

 
 sub scrub ($) { #{{{
        if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
 
 sub scrub ($) { #{{{
        if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {


@@ -37,10 +43,17 @@ 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 (@) { #{{{
 sub preprocess (@) { #{{{

-       if (! @_) {
-               return "";
-       }
+       return "" unless @_;

        my %params=@_;
        my $key=shift;
        my $value=$params{$key};
        my %params=@_;
        my $key=shift;
        my $value=$params{$key};


@@ -52,35 +65,55 @@ sub preprocess (@) { #{{{
        delete $params{preview};
 
        eval q{use HTML::Entities};
        delete $params{preview};
 
        eval q{use HTML::Entities};

-       # Always dencode, even if encoding later, since it might not be
+       # Always decode, even if encoding later, since it might not be

        # fully encoded.
        $value=decode_entities($value);
 
        # fully encoded.
        $value=decode_entities($value);
 

-       if ($key eq 'link') {
-               if (%params) {
-                       $meta{$page}.=scrub("<link href=\"".encode_entities($value)."\" ".
-                               join(" ", map { encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\"" } keys %params).
-                               " />\n");
-               }
-               else {
-                       # hidden WikiLink
-                       push @{$links{$page}}, $value;
-               }
-       }
-       elsif ($key eq 'title') {
+       # Metadata collection that needs to happen during the scan pass.
+       if ($key eq 'title') {

                $title{$page}=HTML::Entities::encode_numeric($value);
        }
                $title{$page}=HTML::Entities::encode_numeric($value);
        }

-       elsif ($key eq 'permalink') {
-               $permalink{$page}=$value;
-               $meta{$page}.=scrub("<link rel=\"bookmark\" href=\"".encode_entities($value)."\" />\n");
+       elsif ($key eq 'license') {
+               push @{$meta{$page}}, '<link rel="license" href="#page_license" />';
+               $license{$page}=$value;
+               return "";
+       }
+       elsif ($key eq 'copyright') {
+               push @{$meta{$page}}, '<link rel="copyright" href="#page_copyright" />';
+               $copyright{$page}=$value;
+               return "";
+       }
+       elsif ($key eq 'link' && ! %params) {
+               # hidden WikiLink
+               push @{$links{$page}}, $value;
+               return "";
+       }
+       elsif ($key eq 'author') {
+               $author{$page}=$value;
+               # fallthorough

        }
        }

-       elsif ($key eq 'date') {
+       elsif ($key eq 'authorurl') {
+               $authorurl{$page}=$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') {
+               $permalink{$page}=$value;
+               push @{$meta{$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;


@@ -90,56 +123,70 @@ sub preprocess (@) { #{{{
                if (! length $stylesheet) {
                        return "[[meta ".gettext("stylesheet not found")."]]";
                }
                if (! length $stylesheet) {
                        return "[[meta ".gettext("stylesheet not found")."]]";
                }

-               $meta{$page}.='<link href="'.urlto($stylesheet, $page).
+               push @{$meta{$page}}, '<link href="'.urlto($stylesheet, $page).

                        '" rel="'.encode_entities($rel).
                        '" title="'.encode_entities($title).
                        '" rel="'.encode_entities($rel).
                        '" title="'.encode_entities($title).

-                       "\" type=\"text/css\" />\n";
+                       "\" type=\"text/css\" />";

        }
        elsif ($key eq 'openid') {
                if (exists $params{server}) {
        }
        elsif ($key eq 'openid') {
                if (exists $params{server}) {

-                       $meta{$page}.='<link href="'.encode_entities($params{server}).
-                               "\" rel=\"openid.server\" />\n";
+                       push @{$meta{$page}}, '<link href="'.encode_entities($params{server}).
+                               '" rel="openid.server" />';

                }
                }

-               $meta{$page}.='<link href="'.encode_entities($value).
-                       "\" rel=\"openid.delegate\" />\n";
-       }
-       elsif ($key eq 'license') {
-               $meta{$page}.="<link rel=\"license\" href=\"#page_license\" />\n";
-               $license{$page}=$value;
-       }
-       elsif ($key eq 'copyright') {
-               $meta{$page}.="<link rel=\"copyright\" href=\"#page_copyright\" />\n";
-               $copyright{$page}=$value;
-       }
-       elsif ($key eq 'forward') {
-               my $delay=0;
-               my $dest_url;
-               my $text;
-               if (exists $params{delay}) {
-                       $delay=$params{delay};
+               push @{$meta{$page}}, '<link href="'.encode_entities($value).
+                       '" rel="openid.delegate" />';
+       }
+       elsif ($key eq 'redir') {
+               return "" if $page ne $destpage;
+               my $safe=0;
+               if ($value !~ /^\w+:\/\//) {
+                       my ($redir_page, $redir_anchor) = split /\#/, $value;
+
+                       add_depends($page, $redir_page);
+                       my $link=bestlink($page, $redir_page);
+                       if (! length $link) {
+                               return "[[meta ".gettext("redir page not found")."]]";
+                       }
+
+                       $value=urlto($link, $page);
+                       $value.='#'.$redir_anchor if defined $redir_anchor;
+                       $safe=1;
+
+                       # redir cycle detection
+                       $pagestate{$page}{meta}{redir}=$link;
+                       my $at=$page;
+                       my %seen;
+                       while (exists $pagestate{$at}{meta}{redir}) {
+                               if ($seen{$at}) {
+                                       return "[[meta ".gettext("redir cycle is not allowed")."]]";
+                               }
+                               $seen{$at}=1;
+                               $at=$pagestate{$at}{meta}{redir};
+                       }

                }
                }

-               # Is this a wikilink?
-               if ($value =~ /^\[\[(.*)\]\]$/) {
-                       $text=htmllink($page, $destpage, $1);
-                       $dest_url=urlto(bestlink($page, $1), $destpage);
-               } else {
-                       $text="<a href=\"$dest_url\">$dest_url</a>";
-                       $dest_url=$value;
+               else {
+                       $value=encode_entities($value);

                }
                }

-# TODO.                $meta{$page}.=scrub("<meta http-equiv=\"refresh\" content=\"$delay; URL=$dest_url\">");
-               $meta{$page}.="<meta http-equiv=\"refresh\" content=\"$delay; URL=$dest_url\">";
-               return "You are being forwarded to $text.";
-       }
-       else {
-               $meta{$page}.=scrub("<meta name=\"".encode_entities($key).
-                       "\" content=\"".encode_entities($value)."\" />\n");
-               if ($key eq 'author') {
-                       $author{$page}=$value;
+               my $delay=int(exists $params{delay} ? $params{delay} : 0);
+               my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\">";
+               if (! $safe) {
+                       $redir=scrub($redir);

                }
                }

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

 
        return "";
 } # }}}
 
        return "";
 } # }}}


@@ -150,8 +197,11 @@ sub pagetemplate (@) { #{{{
         my $destpage=$params{destpage};
         my $template=$params{template};
 
         my $destpage=$params{destpage};
         my $template=$params{template};
 

-       $template->param(meta => $meta{$page})
-               if exists $meta{$page} && $template->query(name => "meta");
+       if (exists $meta{$page} && $template->query(name => "meta")) {
+               # avoid duplicate meta lines
+               my %seen;
+               $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$meta{$page}}));
+       }

        if (exists $title{$page} && $template->query(name => "title")) {
                $template->param(title => $title{$page});
                $template->param(title_overridden => 1);
        if (exists $title{$page} && $template->query(name => "title")) {
                $template->param(title => $title{$page});
                $template->param(title_overridden => 1);


@@ -162,25 +212,16 @@ sub pagetemplate (@) { #{{{
                if exists $author{$page} && $template->query(name => "author");
        $template->param(authorurl => $authorurl{$page})
                if exists $authorurl{$page} && $template->query(name => "authorurl");
                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})) {
 
        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}));
+               $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})) {
        }
        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}));
+               $template->param(copyright => htmlize($page, $destpage, $copyright{$page}));

        }
 } # }}}
 
        }
 } # }}}