2 # Ikiwiki metadata plugin.
3 package IkiWiki::Plugin::meta;
12 hook(type => "needsbuild", id => "meta", call => \&needsbuild);
13 hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
14 hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
17 sub needsbuild (@) { #{{{
19 foreach my $page (keys %pagestate) {
20 if (exists $pagestate{$page}{meta}) {
21 if (exists $pagesources{$page} &&
22 grep { $_ eq $pagesources{$page} } @$needsbuild) {
23 # remove state, it will be re-added
24 # if the preprocessor directive is still
25 # there during the rebuild
26 delete $pagestate{$page}{meta};
33 if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
34 return IkiWiki::Plugin::htmlscrubber::sanitize(content => shift);
41 sub safeurl ($) { #{{{
43 if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
44 defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
45 return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
52 sub htmlize ($$$) { #{{{
56 return IkiWiki::htmlize($page, $destpage, pagetype($pagesources{$page}),
57 IkiWiki::linkify($page, $destpage,
58 IkiWiki::preprocess($page, $destpage, shift)));
61 sub preprocess (@) { #{{{
65 my $value=$params{$key};
67 my $page=$params{page};
69 my $destpage=$params{destpage};
70 delete $params{destpage};
71 delete $params{preview};
73 eval q{use HTML::Entities};
74 # Always decode, even if encoding later, since it might not be
76 $value=decode_entities($value);
78 # Metadata collection that needs to happen during the scan pass.
79 if ($key eq 'title') {
80 $pagestate{$page}{meta}{title}=HTML::Entities::encode_numeric($value);
83 elsif ($key eq 'description') {
84 $pagestate{$page}{meta}{description}=HTML::Entities::encode_numeric($value);
87 elsif ($key eq 'guid') {
90 if ($abs =~ m/^[[:xdigit:]]{8}-[[:xdigit:]]{4}-[[:xdigit]]{4}-[[:xdigit:]]{4}-[[:xdigit:]]{12}$/) {
91 $abs = lc "urn:uuid:$abs";
94 $pagestate{$page}{meta}{guid}=HTML::Entities::encode_numeric($abs);
97 elsif ($key eq 'license') {
98 push @{$metaheaders{$page}}, '<link rel="license" href="#page_license" />';
99 $pagestate{$page}{meta}{license}=$value;
102 elsif ($key eq 'copyright') {
103 push @{$metaheaders{$page}}, '<link rel="copyright" href="#page_copyright" />';
104 $pagestate{$page}{meta}{copyright}=$value;
107 elsif ($key eq 'link' && ! %params) {
109 push @{$links{$page}}, $value;
112 elsif ($key eq 'author') {
113 $pagestate{$page}{meta}{author}=$value;
116 elsif ($key eq 'authorurl') {
117 $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
121 if (! defined wantarray) {
122 # avoid collecting duplicate data during scan pass
126 # Metadata collection that happens only during preprocessing pass.
127 if ($key eq 'date') {
128 eval q{use Date::Parse};
130 my $time = str2time($value);
131 $IkiWiki::pagectime{$page}=$time if defined $time;
134 elsif ($key eq 'permalink') {
135 if (safeurl($value)) {
136 $pagestate{$page}{meta}{permalink}=$value;
137 push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
140 elsif ($key eq 'stylesheet') {
141 my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
142 my $title=exists $params{title} ? $params{title} : $value;
143 # adding .css to the value prevents using any old web
144 # editable page as a stylesheet
145 my $stylesheet=bestlink($page, $value.".css");
146 if (! length $stylesheet) {
147 return "[[meta ".gettext("stylesheet not found")."]]";
149 push @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
150 '" rel="'.encode_entities($rel).
151 '" title="'.encode_entities($title).
152 "\" type=\"text/css\" />";
154 elsif ($key eq 'openid') {
155 if (exists $params{server} && safeurl($params{server})) {
156 push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
157 '" rel="openid.server" />';
158 push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
159 '" rel="openid2.provider" />';
161 if (safeurl($value)) {
162 push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
163 '" rel="openid.delegate" />';
164 push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
165 '" rel="openid2.local_id" />';
167 if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
168 push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location"'.
169 'content="'.encode_entities($params{"xrds-location"}).'" />';
172 elsif ($key eq 'redir') {
173 return "" if $page ne $destpage;
175 if ($value !~ /^\w+:\/\//) {
176 my ($redir_page, $redir_anchor) = split /\#/, $value;
178 add_depends($page, $redir_page);
179 my $link=bestlink($page, $redir_page);
180 if (! length $link) {
181 return "[[meta ".gettext("redir page not found")."]]";
184 $value=urlto($link, $page);
185 $value.='#'.$redir_anchor if defined $redir_anchor;
188 # redir cycle detection
189 $pagestate{$page}{meta}{redir}=$link;
192 while (exists $pagestate{$at}{meta}{redir}) {
194 return "[[meta ".gettext("redir cycle is not allowed")."]]";
197 $at=$pagestate{$at}{meta}{redir};
201 $value=encode_entities($value);
203 my $delay=int(exists $params{delay} ? $params{delay} : 0);
204 my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";
206 $redir=scrub($redir);
208 push @{$metaheaders{$page}}, $redir;
210 elsif ($key eq 'link') {
212 push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
214 encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
219 elsif ($key eq 'robots') {
220 push @{$metaheaders{$page}}, '<meta name="robots"'.
221 ' content="'.encode_entities($value).'" />';
224 push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
225 '" content="'.encode_entities($value).'" />');
231 sub pagetemplate (@) { #{{{
233 my $page=$params{page};
234 my $destpage=$params{destpage};
235 my $template=$params{template};
237 if (exists $metaheaders{$page} && $template->query(name => "meta")) {
238 # avoid duplicate meta lines
240 $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
242 if (exists $pagestate{$page}{meta}{title} && $template->query(name => "title")) {
243 $template->param(title => $pagestate{$page}{meta}{title});
244 $template->param(title_overridden => 1);
247 foreach my $field (qw{author authorurl permalink}) {
248 $template->param($field => $pagestate{$page}{meta}{$field})
249 if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
252 foreach my $field (qw{license copyright}) {
253 if (exists $pagestate{$page}{meta}{$field} && $template->query(name => $field) &&
254 ($page eq $destpage || ! exists $pagestate{$destpage}{meta}{$field} ||
255 $pagestate{$page}{meta}{$field} ne $pagestate{$destpage}{meta}{$field})) {
256 $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
265 # turn glob into a safe regexp
266 my $re=IkiWiki::glob2re(shift);
269 if (exists $pagestate{$page}{meta}{$field}) {
270 $val=$pagestate{$page}{meta}{$field};
272 elsif ($field eq 'title') {
273 $val=pagetitle($page);
277 if ($val=~/^$re$/i) {
278 return IkiWiki::SuccessReason->new("$re matches $field of $page");
281 return IkiWiki::FailReason->new("$re does not match $field of $page");
285 return IkiWiki::FailReason->new("$page does not have a $field");
289 package IkiWiki::PageSpec;
291 sub match_title ($$;@) { #{{{
292 IkiWiki::Plugin::meta::match("title", @_);
295 sub match_author ($$;@) { #{{{
296 IkiWiki::Plugin::meta::match("author", @_);
299 sub match_authorurl ($$;@) { #{{{
300 IkiWiki::Plugin::meta::match("authorurl", @_);
303 sub match_license ($$;@) { #{{{
304 IkiWiki::Plugin::meta::match("license", @_);
307 sub match_copyright ($$;@) { #{{{
308 IkiWiki::Plugin::meta::match("copyright", @_);