web commit by Justin
[ikiwiki.git] / IkiWiki / Plugin / meta.pm
1 #!/usr/bin/perl
2 # Ikiwiki metadata plugin.
3 package IkiWiki::Plugin::meta;
4
5 use warnings;
6 use strict;
7 use IkiWiki 2.00;
8
9 my %metaheaders;
10
11 sub import { #{{{
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);
15 } # }}}
16
17 sub needsbuild (@) { #{{{
18         my $needsbuild=shift;
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};
27                         }
28                 }
29         }
30 }
31
32 sub scrub ($) { #{{{
33         if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
34                 return IkiWiki::Plugin::htmlscrubber::sanitize(content => shift);
35         }
36         else {
37                 return shift;
38         }
39 } #}}}
40
41 sub safeurl ($) { #{{{
42         my $url=shift;
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/;
46         }
47         else {
48                 return 1;
49         }
50 } #}}}
51
52 sub htmlize ($$$) { #{{{
53         my $page = shift;
54         my $destpage = shift;
55
56         return IkiWiki::htmlize($page, pagetype($pagesources{$page}),
57                 IkiWiki::linkify($page, $destpage,
58                 IkiWiki::preprocess($page, $destpage, shift)));
59 }
60
61 sub preprocess (@) { #{{{
62         return "" unless @_;
63         my %params=@_;
64         my $key=shift;
65         my $value=$params{$key};
66         delete $params{$key};
67         my $page=$params{page};
68         delete $params{page};
69         my $destpage=$params{destpage};
70         delete $params{destpage};
71         delete $params{preview};
72
73         eval q{use HTML::Entities};
74         # Always decode, even if encoding later, since it might not be
75         # fully encoded.
76         $value=decode_entities($value);
77
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);
81         }
82         elsif ($key eq 'license') {
83                 push @{$metaheaders{$page}}, '<link rel="license" href="#page_license" />';
84                 $pagestate{$page}{meta}{license}=$value;
85                 return "";
86         }
87         elsif ($key eq 'copyright') {
88                 push @{$metaheaders{$page}}, '<link rel="copyright" href="#page_copyright" />';
89                 $pagestate{$page}{meta}{copyright}=$value;
90                 return "";
91         }
92         elsif ($key eq 'link' && ! %params) {
93                 # hidden WikiLink
94                 push @{$links{$page}}, $value;
95                 return "";
96         }
97         elsif ($key eq 'author') {
98                 $pagestate{$page}{meta}{author}=$value;
99                 # fallthorough
100         }
101         elsif ($key eq 'authorurl') {
102                 $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
103                 # fallthrough
104         }
105
106         if (! defined wantarray) {
107                 # avoid collecting duplicate data during scan pass
108                 return;
109         }
110
111         # Metadata collection that happens only during preprocessing pass.
112         if ($key eq 'date') {
113                 eval q{use Date::Parse};
114                 if (! $@) {
115                         my $time = str2time($value);
116                         $IkiWiki::pagectime{$page}=$time if defined $time;
117                 }
118         }
119         elsif ($key eq 'permalink') {
120                 if (safeurl($value)) {
121                         $pagestate{$page}{meta}{permalink}=$value;
122                         push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />');
123                 }
124         }
125         elsif ($key eq 'stylesheet') {
126                 my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
127                 my $title=exists $params{title} ? $params{title} : $value;
128                 # adding .css to the value prevents using any old web
129                 # editable page as a stylesheet
130                 my $stylesheet=bestlink($page, $value.".css");
131                 if (! length $stylesheet) {
132                         return "[[meta ".gettext("stylesheet not found")."]]";
133                 }
134                 push @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
135                         '" rel="'.encode_entities($rel).
136                         '" title="'.encode_entities($title).
137                         "\" type=\"text/css\" />";
138         }
139         elsif ($key eq 'openid') {
140                 if (exists $params{server} && safeurl($params{server})) {
141                         push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
142                                 '" rel="openid.server" />';
143                 }
144                 if (safeurl($value)) {
145                         push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
146                                 '" rel="openid.delegate" />';
147                 }
148         }
149         elsif ($key eq 'redir') {
150                 return "" if $page ne $destpage;
151                 my $safe=0;
152                 if ($value !~ /^\w+:\/\//) {
153                         my ($redir_page, $redir_anchor) = split /\#/, $value;
154
155                         add_depends($page, $redir_page);
156                         my $link=bestlink($page, $redir_page);
157                         if (! length $link) {
158                                 return "[[meta ".gettext("redir page not found")."]]";
159                         }
160
161                         $value=urlto($link, $page);
162                         $value.='#'.$redir_anchor if defined $redir_anchor;
163                         $safe=1;
164
165                         # redir cycle detection
166                         $pagestate{$page}{meta}{redir}=$link;
167                         my $at=$page;
168                         my %seen;
169                         while (exists $pagestate{$at}{meta}{redir}) {
170                                 if ($seen{$at}) {
171                                         return "[[meta ".gettext("redir cycle is not allowed")."]]";
172                                 }
173                                 $seen{$at}=1;
174                                 $at=$pagestate{$at}{meta}{redir};
175                         }
176                 }
177                 else {
178                         $value=encode_entities($value);
179                 }
180                 my $delay=int(exists $params{delay} ? $params{delay} : 0);
181                 my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\">";
182                 if (! $safe) {
183                         $redir=scrub($redir);
184                 }
185                 push @{$metaheaders{$page}}, $redir;
186         }
187         elsif ($key eq 'link') {
188                 if (%params) {
189                         push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
190                                 join(" ", map {
191                                         encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
192                                 } keys %params).
193                                 " />\n");
194                 }
195         }
196         else {
197                 push @{$metaheaders{$page}}, scrub('<meta name="'.encode_entities($key).
198                         '" content="'.encode_entities($value).'" />');
199         }
200
201         return "";
202 } # }}}
203
204 sub pagetemplate (@) { #{{{
205         my %params=@_;
206         my $page=$params{page};
207         my $destpage=$params{destpage};
208         my $template=$params{template};
209
210         if (exists $metaheaders{$page} && $template->query(name => "meta")) {
211                 # avoid duplicate meta lines
212                 my %seen;
213                 $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
214         }
215         if (exists $pagestate{$page}{meta}{title} && $template->query(name => "title")) {
216                 $template->param(title => $pagestate{$page}{meta}{title});
217                 $template->param(title_overridden => 1);
218         }
219
220         foreach my $field (qw{author authorurl permalink}) {
221                 $template->param($field => $pagestate{$page}{meta}{$field})
222                         if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
223         }
224
225         foreach my $field (qw{license copyright}) {
226                 if (exists $pagestate{$page}{meta}{$field} && $template->query(name => $field) &&
227                     ($page eq $destpage || ! exists $pagestate{$destpage}{meta}{$field} ||
228                      $pagestate{$page}{meta}{$field} ne $pagestate{$destpage}{meta}{$field})) {
229                         $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
230                 }
231         }
232 } # }}}
233
234 sub match { #{{{
235         my $field=shift;
236         my $page=shift;
237         
238         # turn glob into a safe regexp
239         my $re=quotemeta(shift);
240         $re=~s/\\\*/.*/g;
241         $re=~s/\\\?/./g;
242
243         my $val;
244         if (exists $pagestate{$page}{meta}{$field}) {
245                 $val=$pagestate{$page}{meta}{$field};
246         }
247         elsif ($field eq 'title') {
248                 $val=pagetitle($page);
249         }
250
251         if (defined $val) {
252                 if ($val=~/^$re$/i) {
253                         return IkiWiki::SuccessReason->new("$re matches $field of $page");
254                 }
255                 else {
256                         return IkiWiki::FailReason->new("$re does not match $field of $page");
257                 }
258         }
259         else {
260                 return IkiWiki::FailReason->new("$page does not have a $field");
261         }
262 } #}}}
263
264 package IkiWiki::PageSpec;
265
266 sub match_title ($$;@) { #{{{
267         IkiWiki::Plugin::meta::match("title", @_);      
268 } #}}}
269
270 sub match_author ($$;@) { #{{{
271         IkiWiki::Plugin::meta::match("author", @_);
272 } #}}}
273
274 sub match_authorurl ($$;@) { #{{{
275         IkiWiki::Plugin::meta::match("authorurl", @_);
276 } #}}}
277
278 sub match_license ($$;@) { #{{{
279         IkiWiki::Plugin::meta::match("license", @_);
280 } #}}}
281
282 sub match_copyright ($$;@) { #{{{
283         IkiWiki::Plugin::meta::match("copyright", @_);
284 } #}}}
285
286 1