X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/5959a32f9746aa600fd852f6b11f635ad2020253..a7d329c17312348d7511b48523fb54c18f8d4736:/IkiWiki/Plugin/meta.pm?ds=inline

diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 4aa545a93..8d444109f 100644
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -6,28 +6,37 @@ use warnings;
 use strict;
 use IkiWiki 2.00;
 
-my %meta;
-my %title;
-my %permalink;
-my %author;
-my %authorurl;
-my %license;
-my %copyright;
+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 => "filter", id => "meta", call => \&filter);
 	hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
 } # }}}
 
-sub filter (@) { #{{{
-	my %params=@_;
-	
-	$meta{$params{page}}='';
-	delete $pagestate{$params{page}}{meta}{redir};
+sub getsetup () { #{{{
+	return
+		plugin => {
+			safe => 1,
+			rebuild => undef,
+		},
+} #}}}
 
-	return $params{content};
-} # }}}
+sub needsbuild (@) { #{{{
+	my $needsbuild=shift;
+	foreach my $page (keys %pagestate) {
+		if (exists $pagestate{$page}{meta}) {
+			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
+				delete $pagestate{$page}{meta};
+			}
+		}
+	}
+}
 
 sub scrub ($) { #{{{
 	if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
@@ -38,10 +47,28 @@ sub scrub ($) { #{{{
 	}
 } #}}}
 
-sub preprocess (@) { #{{{
-	if (! @_) {
-		return "";
+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, $destpage, pagetype($pagesources{$page}),
+		IkiWiki::linkify($page, $destpage,
+		IkiWiki::preprocess($page, $destpage, shift)));
+}
+
+sub preprocess (@) { #{{{
+	return "" unless @_;
 	my %params=@_;
 	my $key=shift;
 	my $value=$params{$key};
@@ -53,34 +80,112 @@ sub preprocess (@) { #{{{
 	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);
 
-	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");
+	# 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" />';
+		$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 '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;
 		}
-		else {
-			# hidden WikiLink
-			push @{$links{$page}}, $value;
+	}
+	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;
+		# adding .css to the value prevents using any old web
+		# editable page as a stylesheet
+		my $stylesheet=bestlink($page, $value.".css");
+		if (! length $stylesheet) {
+			error gettext("stylesheet not found")
+		}
+		push @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
+			'" rel="'.encode_entities($rel).
+			'" title="'.encode_entities($title).
+			"\" type=\"text/css\" />";
+	}
+	elsif ($key eq 'openid') {
+		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"}).'" />';
 		}
 	}
 	elsif ($key eq 'redir') {
-		return "" if $destpage ne $page;
+		return "" if $page ne $destpage;
 		my $safe=0;
 		if ($value !~ /^\w+:\/\//) {
-			add_depends($page, $value);
-			my $link=bestlink($page, $value);
+			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")."]]";
+				error gettext("redir page not found")
 			}
 
 			$value=urlto($link, $page);
+			$value.='#'.$redir_anchor if defined $redir_anchor;
 			$safe=1;
 
 			# redir cycle detection
@@ -89,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};
@@ -99,65 +204,28 @@ 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);
 		}
-		$meta{$page}.=$redir;
+		push @{$metaheaders{$page}}, $redir;
 	}
-	elsif ($key eq 'title') {
-		$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 'date') {
-		eval q{use Date::Parse};
-		if (! $@) {
-			my $time = str2time($value);
-			$IkiWiki::pagectime{$page}=$time if defined $time;
-		}
-	}
-	elsif ($key eq 'stylesheet') {
-		my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
-		my $title=exists $params{title} ? $params{title} : $value;
-		# adding .css to the value prevents using any old web
-		# editable page as a stylesheet
-		my $stylesheet=bestlink($page, $value.".css");
-		if (! length $stylesheet) {
-			return "[[meta ".gettext("stylesheet not found")."]]";
-		}
-		$meta{$page}.='<link href="'.urlto($stylesheet, $page).
-			'" rel="'.encode_entities($rel).
-			'" title="'.encode_entities($title).
-			"\" type=\"text/css\" />\n";
-	}
-	elsif ($key eq 'openid') {
-		if (exists $params{server}) {
-			$meta{$page}.='<link href="'.encode_entities($params{server}).
-				"\" rel=\"openid.server\" />\n";
+	elsif ($key eq 'link') {
+		if (%params) {
+			push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
+				join(" ", map {
+					encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
+				} keys %params).
+				" />\n");
 		}
-		$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 'robots') {
+		push @{$metaheaders{$page}}, '<meta name="robots"'.
+			' content="'.encode_entities($value).'" />';
 	}
 	else {
-		$meta{$page}.=scrub("<meta name=\"".encode_entities($key).
-			"\" content=\"".encode_entities($value)."\" />\n");
-		if ($key eq 'author') {
-			$author{$page}=$value;
-		}
-		elsif ($key eq 'authorurl') {
-			$authorurl{$page}=$value;
-		}
+		push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
+			'" content="'.encode_entities($value).'" />');
 	}
 
 	return "";
@@ -169,38 +237,78 @@ sub pagetemplate (@) { #{{{
         my $destpage=$params{destpage};
         my $template=$params{template};
 
-	$template->param(meta => $meta{$page})
-		if exists $meta{$page} && $template->query(name => "meta");
-	if (exists $title{$page} && $template->query(name => "title")) {
-		$template->param(title => $title{$page});
+	if (exists $metaheaders{$page} && $template->query(name => "meta")) {
+		# avoid duplicate meta lines
+		my %seen;
+		$template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$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(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 => IkiWiki::linkify($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 => IkiWiki::linkify($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