summaryrefslogtreecommitdiff
path: root/IkiWiki/Plugin/meta.pm
blob: 5941e3f3f589fa5fee34f5e871949ed891aa685a (plain)
  1. #!/usr/bin/perl
  2. # Ikiwiki metadata plugin.
  3. package IkiWiki::Plugin::meta;
  4. use warnings;
  5. use strict;
  6. use IkiWiki 3.00;
  7. my %metaheaders;
  8. sub import {
  9. hook(type => "getsetup", id => "meta", call => \&getsetup);
  10. hook(type => "needsbuild", id => "meta", call => \&needsbuild);
  11. hook(type => "preprocess", id => "meta", call => \&preprocess, scan => 1);
  12. hook(type => "pagetemplate", id => "meta", call => \&pagetemplate);
  13. }
  14. sub getsetup () {
  15. return
  16. plugin => {
  17. safe => 1,
  18. rebuild => undef,
  19. section => "core",
  20. },
  21. }
  22. sub needsbuild (@) {
  23. my $needsbuild=shift;
  24. foreach my $page (keys %pagestate) {
  25. if (exists $pagestate{$page}{meta}) {
  26. if (exists $pagesources{$page} &&
  27. grep { $_ eq $pagesources{$page} } @$needsbuild) {
  28. # remove state, it will be re-added
  29. # if the preprocessor directive is still
  30. # there during the rebuild
  31. delete $pagestate{$page}{meta};
  32. }
  33. }
  34. }
  35. return $needsbuild;
  36. }
  37. sub scrub ($$) {
  38. if (IkiWiki::Plugin::htmlscrubber->can("sanitize")) {
  39. return IkiWiki::Plugin::htmlscrubber::sanitize(
  40. content => shift, destpage => shift);
  41. }
  42. else {
  43. return shift;
  44. }
  45. }
  46. sub safeurl ($) {
  47. my $url=shift;
  48. if (exists $IkiWiki::Plugin::htmlscrubber::{safe_url_regexp} &&
  49. defined $IkiWiki::Plugin::htmlscrubber::safe_url_regexp) {
  50. return $url=~/$IkiWiki::Plugin::htmlscrubber::safe_url_regexp/;
  51. }
  52. else {
  53. return 1;
  54. }
  55. }
  56. sub htmlize ($$$) {
  57. my $page = shift;
  58. my $destpage = shift;
  59. return IkiWiki::htmlize($page, $destpage, pagetype($pagesources{$page}),
  60. IkiWiki::linkify($page, $destpage,
  61. IkiWiki::preprocess($page, $destpage, shift)));
  62. }
  63. sub preprocess (@) {
  64. return "" unless @_;
  65. my %params=@_;
  66. my $key=shift;
  67. my $value=$params{$key};
  68. delete $params{$key};
  69. my $page=$params{page};
  70. delete $params{page};
  71. my $destpage=$params{destpage};
  72. delete $params{destpage};
  73. delete $params{preview};
  74. eval q{use HTML::Entities};
  75. # Always decode, even if encoding later, since it might not be
  76. # fully encoded.
  77. $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}=$value;
  81. if (exists $params{sortas}) {
  82. $pagestate{$page}{meta}{titlesort}=$params{sortas};
  83. }
  84. else {
  85. delete $pagestate{$page}{meta}{titlesort};
  86. }
  87. return "";
  88. }
  89. elsif ($key eq 'description') {
  90. $pagestate{$page}{meta}{description}=$value;
  91. # fallthrough
  92. }
  93. elsif ($key eq 'guid') {
  94. $pagestate{$page}{meta}{guid}=$value;
  95. # fallthrough
  96. }
  97. elsif ($key eq 'license') {
  98. push @{$metaheaders{$page}}, '<link rel="license" href="#page_license" />';
  99. $pagestate{$page}{meta}{license}=$value;
  100. return "";
  101. }
  102. elsif ($key eq 'copyright') {
  103. push @{$metaheaders{$page}}, '<link rel="copyright" href="#page_copyright" />';
  104. $pagestate{$page}{meta}{copyright}=$value;
  105. return "";
  106. }
  107. elsif ($key eq 'link' && ! %params) {
  108. # hidden WikiLink
  109. add_link($page, $value);
  110. return "";
  111. }
  112. elsif ($key eq 'author') {
  113. $pagestate{$page}{meta}{author}=$value;
  114. if (exists $params{sortas}) {
  115. $pagestate{$page}{meta}{authorsort}=$params{sortas};
  116. }
  117. else {
  118. delete $pagestate{$page}{meta}{authorsort};
  119. }
  120. # fallthorough
  121. }
  122. elsif ($key eq 'authorurl') {
  123. $pagestate{$page}{meta}{authorurl}=$value if safeurl($value);
  124. # fallthrough
  125. }
  126. elsif ($key eq 'permalink') {
  127. $pagestate{$page}{meta}{permalink}=$value if safeurl($value);
  128. # fallthrough
  129. }
  130. elsif ($key eq 'date') {
  131. eval q{use Date::Parse};
  132. if (! $@) {
  133. my $time = str2time($value);
  134. $IkiWiki::pagectime{$page}=$time if defined $time;
  135. }
  136. }
  137. elsif ($key eq 'updated') {
  138. eval q{use Date::Parse};
  139. if (! $@) {
  140. my $time = str2time($value);
  141. $pagestate{$page}{meta}{updated}=$time if defined $time;
  142. }
  143. }
  144. if (! defined wantarray) {
  145. # avoid collecting duplicate data during scan pass
  146. return;
  147. }
  148. # Metadata handling that happens only during preprocessing pass.
  149. if ($key eq 'permalink') {
  150. if (safeurl($value)) {
  151. push @{$metaheaders{$page}}, scrub('<link rel="bookmark" href="'.encode_entities($value).'" />', $destpage);
  152. }
  153. }
  154. elsif ($key eq 'stylesheet') {
  155. my $rel=exists $params{rel} ? $params{rel} : "alternate stylesheet";
  156. my $title=exists $params{title} ? $params{title} : $value;
  157. # adding .css to the value prevents using any old web
  158. # editable page as a stylesheet
  159. my $stylesheet=bestlink($page, $value.".css");
  160. if (! length $stylesheet) {
  161. error gettext("stylesheet not found")
  162. }
  163. push @{$metaheaders{$page}}, '<link href="'.urlto($stylesheet, $page).
  164. '" rel="'.encode_entities($rel).
  165. '" title="'.encode_entities($title).
  166. "\" type=\"text/css\" />";
  167. }
  168. elsif ($key eq 'openid') {
  169. my $delegate=0; # both by default
  170. if (exists $params{delegate}) {
  171. $delegate = 1 if lc $params{delegate} eq 'openid';
  172. $delegate = 2 if lc $params{delegate} eq 'openid2';
  173. }
  174. if (exists $params{server} && safeurl($params{server})) {
  175. push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
  176. '" rel="openid.server" />' if $delegate ne 2;
  177. push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
  178. '" rel="openid2.provider" />' if $delegate ne 1;
  179. }
  180. if (safeurl($value)) {
  181. push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
  182. '" rel="openid.delegate" />' if $delegate ne 2;
  183. push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
  184. '" rel="openid2.local_id" />' if $delegate ne 1;
  185. }
  186. if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
  187. push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location"'.
  188. 'content="'.encode_entities($params{"xrds-location"}).'" />';
  189. }
  190. }
  191. elsif ($key eq 'redir') {
  192. return "" if $page ne $destpage;
  193. my $safe=0;
  194. if ($value !~ /^\w+:\/\//) {
  195. my ($redir_page, $redir_anchor) = split /\#/, $value;
  196. my $link=bestlink($page, $redir_page);
  197. if (! length $link) {
  198. error gettext("redir page not found")
  199. }
  200. add_depends($page, $link, deptype("presence"));
  201. $value=urlto($link, $page);
  202. $value.='#'.$redir_anchor if defined $redir_anchor;
  203. $safe=1;
  204. # redir cycle detection
  205. $pagestate{$page}{meta}{redir}=$link;
  206. my $at=$page;
  207. my %seen;
  208. while (exists $pagestate{$at}{meta}{redir}) {
  209. if ($seen{$at}) {
  210. error gettext("redir cycle is not allowed")
  211. }
  212. $seen{$at}=1;
  213. $at=$pagestate{$at}{meta}{redir};
  214. }
  215. }
  216. else {
  217. $value=encode_entities($value);
  218. }
  219. my $delay=int(exists $params{delay} ? $params{delay} : 0);
  220. my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";
  221. if (! $safe) {
  222. $redir=scrub($redir, $destpage);
  223. }
  224. push @{$metaheaders{$page}}, $redir;
  225. }
  226. elsif ($key eq 'link') {
  227. if (%params) {
  228. push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
  229. join(" ", map {
  230. encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
  231. } keys %params).
  232. " />\n", $destpage);
  233. }
  234. }
  235. elsif ($key eq 'robots') {
  236. push @{$metaheaders{$page}}, '<meta name="robots"'.
  237. ' content="'.encode_entities($value).'" />';
  238. }
  239. elsif ($key eq 'description') {
  240. push @{$metaheaders{$page}}, '<meta name="'.
  241. encode_entities($key).
  242. '" content="'.encode_entities($value).'" />';
  243. }
  244. elsif ($key eq 'name') {
  245. push @{$metaheaders{$page}}, scrub('<meta '.$key.'="'.
  246. encode_entities($value).
  247. join(' ', map { "$_=\"$params{$_}\"" } keys %params).
  248. ' />', $destpage);
  249. }
  250. else {
  251. push @{$metaheaders{$page}}, scrub('<meta name="'.
  252. encode_entities($key).'" content="'.
  253. encode_entities($value).'" />', $destpage);
  254. }
  255. return "";
  256. }
  257. sub pagetemplate (@) {
  258. my %params=@_;
  259. my $page=$params{page};
  260. my $destpage=$params{destpage};
  261. my $template=$params{template};
  262. if (exists $metaheaders{$page} && $template->query(name => "meta")) {
  263. # avoid duplicate meta lines
  264. my %seen;
  265. $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
  266. }
  267. if (exists $pagestate{$page}{meta}{title} && $template->query(name => "title")) {
  268. $template->param(title => HTML::Entities::encode_numeric($pagestate{$page}{meta}{title}));
  269. $template->param(title_overridden => 1);
  270. }
  271. foreach my $field (qw{author authorurl permalink}) {
  272. $template->param($field => $pagestate{$page}{meta}{$field})
  273. if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
  274. }
  275. foreach my $field (qw{description}) {
  276. $template->param($field => HTML::Entities::encode_numeric($pagestate{$page}{meta}{$field}))
  277. if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
  278. }
  279. foreach my $field (qw{license copyright}) {
  280. if (exists $pagestate{$page}{meta}{$field} && $template->query(name => $field) &&
  281. ($page eq $destpage || ! exists $pagestate{$destpage}{meta}{$field} ||
  282. $pagestate{$page}{meta}{$field} ne $pagestate{$destpage}{meta}{$field})) {
  283. $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
  284. }
  285. }
  286. }
  287. sub get_sort_key {
  288. my $page = shift;
  289. my $meta = shift;
  290. # e.g. titlesort (also makes sense for author)
  291. my $key = $pagestate{$page}{meta}{$meta . "sort"};
  292. return $key if defined $key;
  293. # e.g. title
  294. $key = $pagestate{$page}{meta}{$meta};
  295. return $key if defined $key;
  296. # fall back to closer-to-core things
  297. if ($meta eq 'title') {
  298. return pagetitle(IkiWiki::basename($page));
  299. }
  300. elsif ($meta eq 'date') {
  301. return $IkiWiki::pagectime{$page};
  302. }
  303. elsif ($meta eq 'updated') {
  304. return $IkiWiki::pagemtime{$page};
  305. }
  306. else {
  307. return '';
  308. }
  309. }
  310. sub match {
  311. my $field=shift;
  312. my $page=shift;
  313. # turn glob into a safe regexp
  314. my $re=IkiWiki::glob2re(shift);
  315. my $val;
  316. if (exists $pagestate{$page}{meta}{$field}) {
  317. $val=$pagestate{$page}{meta}{$field};
  318. }
  319. elsif ($field eq 'title') {
  320. $val = pagetitle($page);
  321. }
  322. if (defined $val) {
  323. if ($val=~/^$re$/i) {
  324. return IkiWiki::SuccessReason->new("$re matches $field of $page", $page => $IkiWiki::DEPEND_CONTENT, "" => 1);
  325. }
  326. else {
  327. return IkiWiki::FailReason->new("$re does not match $field of $page", $page => $IkiWiki::DEPEND_CONTENT, "" => 1);
  328. }
  329. }
  330. else {
  331. return IkiWiki::FailReason->new("$page does not have a $field", $page => $IkiWiki::DEPEND_CONTENT);
  332. }
  333. }
  334. package IkiWiki::PageSpec;
  335. sub match_title ($$;@) {
  336. IkiWiki::Plugin::meta::match("title", @_);
  337. }
  338. sub match_author ($$;@) {
  339. IkiWiki::Plugin::meta::match("author", @_);
  340. }
  341. sub match_authorurl ($$;@) {
  342. IkiWiki::Plugin::meta::match("authorurl", @_);
  343. }
  344. sub match_license ($$;@) {
  345. IkiWiki::Plugin::meta::match("license", @_);
  346. }
  347. sub match_copyright ($$;@) {
  348. IkiWiki::Plugin::meta::match("copyright", @_);
  349. }
  350. sub match_guid ($$;@) {
  351. IkiWiki::Plugin::meta::match("guid", @_);
  352. }
  353. package IkiWiki::SortSpec;
  354. sub cmp_meta {
  355. my $meta = shift;
  356. error(gettext("sort=meta requires a parameter")) unless defined $meta;
  357. if ($meta eq 'updated' || $meta eq 'date') {
  358. return IkiWiki::Plugin::meta::get_sort_key($a, $meta)
  359. <=>
  360. IkiWiki::Plugin::meta::get_sort_key($b, $meta);
  361. }
  362. return IkiWiki::Plugin::meta::get_sort_key($a, $meta)
  363. cmp
  364. IkiWiki::Plugin::meta::get_sort_key($b, $meta);
  365. }
  366. # A prototype of how sort=title could behave in 4.0 or something
  367. sub cmp_meta_title {
  368. $_[0] = 'title';
  369. return cmp_meta(@_);
  370. }
  371. 1