summaryrefslogtreecommitdiff
path: root/IkiWiki/Plugin/meta.pm
blob: eebe3460f07a42ab2841aadcb08190fe02ae566f (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, page => 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).'" />', $page, $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}}, scrub('<link href="'.urlto($stylesheet, $page).
  164. '" rel="'.encode_entities($rel).
  165. '" title="'.encode_entities($title).
  166. "\" type=\"text/css\" />", $page, $destpage);
  167. }
  168. elsif ($key eq 'script') {
  169. my $defer=exists $params{defer} ? ' defer="defer"' : '';
  170. my $async=exists $params{async} ? ' async="async"' : '';
  171. my $js=bestlink($page, $value.".js");
  172. if (! length $js) {
  173. error gettext("script not found");
  174. }
  175. push @{$metaheaders{$page}}, scrub('<script src="'.urlto($js, $page).
  176. '"' . $defer . $async . ' type="text/javascript" />',
  177. $page, $destpage);
  178. }
  179. elsif ($key eq 'openid') {
  180. my $delegate=0; # both by default
  181. if (exists $params{delegate}) {
  182. $delegate = 1 if lc $params{delegate} eq 'openid';
  183. $delegate = 2 if lc $params{delegate} eq 'openid2';
  184. }
  185. if (exists $params{server} && safeurl($params{server})) {
  186. push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
  187. '" rel="openid.server" />' if $delegate ne 2;
  188. push @{$metaheaders{$page}}, '<link href="'.encode_entities($params{server}).
  189. '" rel="openid2.provider" />' if $delegate ne 1;
  190. }
  191. if (safeurl($value)) {
  192. push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
  193. '" rel="openid.delegate" />' if $delegate ne 2;
  194. push @{$metaheaders{$page}}, '<link href="'.encode_entities($value).
  195. '" rel="openid2.local_id" />' if $delegate ne 1;
  196. }
  197. if (exists $params{"xrds-location"} && safeurl($params{"xrds-location"})) {
  198. # force url absolute
  199. eval q{use URI};
  200. error($@) if $@;
  201. my $url=URI->new_abs($params{"xrds-location"}, $config{url});
  202. push @{$metaheaders{$page}}, '<meta http-equiv="X-XRDS-Location" '.
  203. 'content="'.encode_entities($url).'" />';
  204. }
  205. }
  206. elsif ($key eq 'redir') {
  207. return "" if $page ne $destpage;
  208. my $safe=0;
  209. if ($value !~ /^\w+:\/\//) {
  210. my ($redir_page, $redir_anchor) = split /\#/, $value;
  211. my $link=bestlink($page, $redir_page);
  212. if (! length $link) {
  213. error gettext("redir page not found")
  214. }
  215. add_depends($page, $link, deptype("presence"));
  216. $value=urlto($link, $page);
  217. $value.='#'.$redir_anchor if defined $redir_anchor;
  218. $safe=1;
  219. # redir cycle detection
  220. $pagestate{$page}{meta}{redir}=$link;
  221. my $at=$page;
  222. my %seen;
  223. while (exists $pagestate{$at}{meta}{redir}) {
  224. if ($seen{$at}) {
  225. error gettext("redir cycle is not allowed")
  226. }
  227. $seen{$at}=1;
  228. $at=$pagestate{$at}{meta}{redir};
  229. }
  230. }
  231. else {
  232. $value=encode_entities($value);
  233. }
  234. my $delay=int(exists $params{delay} ? $params{delay} : 0);
  235. my $redir="<meta http-equiv=\"refresh\" content=\"$delay; URL=$value\" />";
  236. if (! $safe) {
  237. $redir=scrub($redir, $page, $destpage);
  238. }
  239. push @{$metaheaders{$page}}, $redir;
  240. }
  241. elsif ($key eq 'link') {
  242. if (%params) {
  243. push @{$metaheaders{$page}}, scrub("<link href=\"".encode_entities($value)."\" ".
  244. join(" ", map {
  245. encode_entities($_)."=\"".encode_entities(decode_entities($params{$_}))."\""
  246. } keys %params).
  247. " />\n", $page, $destpage);
  248. }
  249. }
  250. elsif ($key eq 'robots') {
  251. push @{$metaheaders{$page}}, '<meta name="robots"'.
  252. ' content="'.encode_entities($value).'" />';
  253. }
  254. elsif ($key eq 'description') {
  255. push @{$metaheaders{$page}}, '<meta name="'.
  256. encode_entities($key).
  257. '" content="'.encode_entities($value).'" />';
  258. }
  259. elsif ($key eq 'name') {
  260. push @{$metaheaders{$page}}, scrub('<meta '.$key.'="'.
  261. encode_entities($value).
  262. join(' ', map { "$_=\"$params{$_}\"" } keys %params).
  263. ' />', $page, $destpage);
  264. }
  265. else {
  266. push @{$metaheaders{$page}}, scrub('<meta name="'.
  267. encode_entities($key).'" content="'.
  268. encode_entities($value).'" />', $page, $destpage);
  269. }
  270. return "";
  271. }
  272. sub pagetemplate (@) {
  273. my %params=@_;
  274. my $page=$params{page};
  275. my $destpage=$params{destpage};
  276. my $template=$params{template};
  277. if (exists $metaheaders{$page} && $template->query(name => "meta")) {
  278. # avoid duplicate meta lines
  279. my %seen;
  280. $template->param(meta => join("\n", grep { (! $seen{$_}) && ($seen{$_}=1) } @{$metaheaders{$page}}));
  281. }
  282. if (exists $pagestate{$page}{meta}{title} && $template->query(name => "title")) {
  283. $template->param(title => HTML::Entities::encode_numeric($pagestate{$page}{meta}{title}));
  284. $template->param(title_overridden => 1);
  285. }
  286. foreach my $field (qw{author authorurl permalink}) {
  287. $template->param($field => $pagestate{$page}{meta}{$field})
  288. if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
  289. }
  290. foreach my $field (qw{permalink}) {
  291. $template->param($field => IkiWiki::urlabs($pagestate{$page}{meta}{$field}, $config{url}))
  292. if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
  293. }
  294. foreach my $field (qw{description}) {
  295. $template->param($field => HTML::Entities::encode_numeric($pagestate{$page}{meta}{$field}))
  296. if exists $pagestate{$page}{meta}{$field} && $template->query(name => $field);
  297. }
  298. foreach my $field (qw{license copyright}) {
  299. if (exists $pagestate{$page}{meta}{$field} && $template->query(name => $field) &&
  300. ($page eq $destpage || ! exists $pagestate{$destpage}{meta}{$field} ||
  301. $pagestate{$page}{meta}{$field} ne $pagestate{$destpage}{meta}{$field})) {
  302. $template->param($field => htmlize($page, $destpage, $pagestate{$page}{meta}{$field}));
  303. }
  304. }
  305. }
  306. sub get_sort_key {
  307. my $page = shift;
  308. my $meta = shift;
  309. # e.g. titlesort (also makes sense for author)
  310. my $key = $pagestate{$page}{meta}{$meta . "sort"};
  311. return $key if defined $key;
  312. # e.g. title
  313. $key = $pagestate{$page}{meta}{$meta};
  314. return $key if defined $key;
  315. # fall back to closer-to-core things
  316. if ($meta eq 'title') {
  317. return pagetitle(IkiWiki::basename($page));
  318. }
  319. elsif ($meta eq 'date') {
  320. return $IkiWiki::pagectime{$page};
  321. }
  322. elsif ($meta eq 'updated') {
  323. return $IkiWiki::pagemtime{$page};
  324. }
  325. else {
  326. return '';
  327. }
  328. }
  329. sub match {
  330. my $field=shift;
  331. my $page=shift;
  332. # turn glob into a safe regexp
  333. my $re=IkiWiki::glob2re(shift);
  334. my $val;
  335. if (exists $pagestate{$page}{meta}{$field}) {
  336. $val=$pagestate{$page}{meta}{$field};
  337. }
  338. elsif ($field eq 'title') {
  339. $val = pagetitle($page);
  340. }
  341. if (defined $val) {
  342. if ($val=~$re) {
  343. return IkiWiki::SuccessReason->new("$re matches $field of $page", $page => $IkiWiki::DEPEND_CONTENT, "" => 1);
  344. }
  345. else {
  346. return IkiWiki::FailReason->new("$re does not match $field of $page", $page => $IkiWiki::DEPEND_CONTENT, "" => 1);
  347. }
  348. }
  349. else {
  350. return IkiWiki::FailReason->new("$page does not have a $field", $page => $IkiWiki::DEPEND_CONTENT);
  351. }
  352. }
  353. package IkiWiki::PageSpec;
  354. sub match_title ($$;@) {
  355. IkiWiki::Plugin::meta::match("title", @_);
  356. }
  357. sub match_author ($$;@) {
  358. IkiWiki::Plugin::meta::match("author", @_);
  359. }
  360. sub match_authorurl ($$;@) {
  361. IkiWiki::Plugin::meta::match("authorurl", @_);
  362. }
  363. sub match_license ($$;@) {
  364. IkiWiki::Plugin::meta::match("license", @_);
  365. }
  366. sub match_copyright ($$;@) {
  367. IkiWiki::Plugin::meta::match("copyright", @_);
  368. }
  369. sub match_guid ($$;@) {
  370. IkiWiki::Plugin::meta::match("guid", @_);
  371. }
  372. package IkiWiki::SortSpec;
  373. sub cmp_meta {
  374. my $meta = shift;
  375. error(gettext("sort=meta requires a parameter")) unless defined $meta;
  376. if ($meta eq 'updated' || $meta eq 'date') {
  377. return IkiWiki::Plugin::meta::get_sort_key($a, $meta)
  378. <=>
  379. IkiWiki::Plugin::meta::get_sort_key($b, $meta);
  380. }
  381. return IkiWiki::Plugin::meta::get_sort_key($a, $meta)
  382. cmp
  383. IkiWiki::Plugin::meta::get_sort_key($b, $meta);
  384. }
  385. # A prototype of how sort=title could behave in 4.0 or something
  386. sub cmp_meta_title {
  387. $_[0] = 'title';
  388. return cmp_meta(@_);
  389. }
  390. 1