summaryrefslogtreecommitdiff
path: root/IkiWiki/Render.pm
blob: 504edc843cc8d7e6693822659ac2477c39798d13 (plain)
  1. package IkiWiki;
  2. use warnings;
  3. use strict;
  4. use File::Spec;
  5. sub linkify ($$) { #{{{
  6. my $content=shift;
  7. my $page=shift;
  8. $content =~ s{(\\?)$config{wiki_link_regexp}}{
  9. $2 ? ( $1 ? "[[$2|$3]]" : htmllink($page, $3, 0, 0, pagetitle($2)))
  10. : ( $1 ? "[[$3]]" : htmllink($page, $3))
  11. }eg;
  12. return $content;
  13. } #}}}
  14. sub htmlize ($$) { #{{{
  15. my $type=shift;
  16. my $content=shift;
  17. if (! $INC{"/usr/bin/markdown"}) {
  18. no warnings 'once';
  19. $blosxom::version="is a proper perl module too much to ask?";
  20. use warnings 'all';
  21. do "/usr/bin/markdown";
  22. }
  23. if ($type eq '.mdwn') {
  24. return Markdown::Markdown($content);
  25. }
  26. else {
  27. error("htmlization of $type not supported");
  28. }
  29. } #}}}
  30. sub backlinks ($) { #{{{
  31. my $page=shift;
  32. my @links;
  33. foreach my $p (keys %links) {
  34. next if bestlink($page, $p) eq $page;
  35. if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
  36. my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
  37. # Trim common dir prefixes from both pages.
  38. my $p_trimmed=$p;
  39. my $page_trimmed=$page;
  40. my $dir;
  41. 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
  42. defined $dir &&
  43. $p_trimmed=~s/^\Q$dir\E// &&
  44. $page_trimmed=~s/^\Q$dir\E//;
  45. push @links, { url => $href, page => $p_trimmed };
  46. }
  47. }
  48. return sort { $a->{page} cmp $b->{page} } @links;
  49. } #}}}
  50. sub parentlinks ($) { #{{{
  51. my $page=shift;
  52. my @ret;
  53. my $pagelink="";
  54. my $path="";
  55. my $skip=1;
  56. foreach my $dir (reverse split("/", $page)) {
  57. if (! $skip) {
  58. $path.="../";
  59. unshift @ret, { url => "$path$dir.html", page => $dir };
  60. }
  61. else {
  62. $skip=0;
  63. }
  64. }
  65. unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
  66. return @ret;
  67. } #}}}
  68. sub rsspage ($) { #{{{
  69. my $page=shift;
  70. return $page.".rss";
  71. } #}}}
  72. sub postprocess { #{{{
  73. # Takes content to postprocess followed by a list of postprocessor
  74. # commands and subroutine references to run for the commands.
  75. my $page=shift;
  76. my $content=shift;
  77. my %commands=@_;
  78. my $handle=sub {
  79. my $escape=shift;
  80. my $command=shift;
  81. my $params=shift;
  82. if (length $escape) {
  83. "[[$command $params]]";
  84. }
  85. elsif (exists $commands{$command}) {
  86. my %params;
  87. while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) {
  88. $params{$1}=$2;
  89. }
  90. $commands{$command}->($page, %params);
  91. }
  92. else {
  93. "[[bad directive $command]]";
  94. }
  95. };
  96. $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg;
  97. return $content;
  98. } #}}}
  99. sub blog_list ($$) { #{{{
  100. my $globlist=shift;
  101. my $maxitems=shift;
  102. my @list;
  103. foreach my $page (keys %pagesources) {
  104. if (globlist_match($page, $globlist)) {
  105. push @list, $page;
  106. }
  107. }
  108. @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
  109. return @list if ! $maxitems || @list <= $maxitems;
  110. return @list[0..$maxitems - 1];
  111. } #}}}
  112. sub get_inline_content ($$) { #{{{
  113. my $parentpage=shift;
  114. my $page=shift;
  115. my $file=$pagesources{$page};
  116. my $type=pagetype($file);
  117. if ($type ne 'unknown') {
  118. return htmlize($type, linkify(readfile("$config{srcdir}/$file"), $parentpage));
  119. }
  120. else {
  121. return "";
  122. }
  123. } #}}}
  124. sub postprocess_html_inline { #{{{
  125. my $parentpage=shift;
  126. my %params=@_;
  127. if (! exists $params{pages}) {
  128. return "";
  129. }
  130. if (! exists $params{archive}) {
  131. $params{archive}="no";
  132. }
  133. if (! exists $params{show} && $params{archive} eq "no") {
  134. $params{show}=10;
  135. }
  136. $inlinepages{$parentpage}=$params{pages};
  137. my $ret="";
  138. if (exists $params{rootpage}) {
  139. my $formtemplate=HTML::Template->new(blind_cache => 1,
  140. filename => "$config{templatedir}/blogpost.tmpl");
  141. $formtemplate->param(cgiurl => $config{cgiurl});
  142. $formtemplate->param(rootpage => $params{rootpage});
  143. my $form=$formtemplate->output;
  144. $ret.=$form;
  145. }
  146. my $template=HTML::Template->new(blind_cache => 1,
  147. filename => (($params{archive} eq "no")
  148. ? "$config{templatedir}/inlinepage.tmpl"
  149. : "$config{templatedir}/inlinepagetitle.tmpl"));
  150. foreach my $page (blog_list($params{pages}, $params{show})) {
  151. next if $page eq $parentpage;
  152. $template->param(pagelink => htmllink($parentpage, $page));
  153. $template->param(content => get_inline_content($parentpage, $page))
  154. if $params{archive} eq "no";
  155. $template->param(ctime => scalar(gmtime($pagectime{$page})));
  156. $ret.=$template->output;
  157. }
  158. return $ret;
  159. } #}}}
  160. sub genpage ($$$) { #{{{
  161. my $content=shift;
  162. my $page=shift;
  163. my $mtime=shift;
  164. $content = postprocess($page, $content, inline => \&postprocess_html_inline);
  165. my $title=pagetitle(basename($page));
  166. my $template=HTML::Template->new(blind_cache => 1,
  167. filename => "$config{templatedir}/page.tmpl");
  168. if (length $config{cgiurl}) {
  169. $template->param(editurl => "$config{cgiurl}?do=edit&page=$page");
  170. $template->param(prefsurl => "$config{cgiurl}?do=prefs");
  171. if ($config{rcs}) {
  172. $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges");
  173. }
  174. }
  175. if (length $config{historyurl}) {
  176. my $u=$config{historyurl};
  177. $u=~s/\[\[file\]\]/$pagesources{$page}/g;
  178. $template->param(historyurl => $u);
  179. }
  180. if ($config{rss} && $inlinepages{$page}) {
  181. $template->param(rssurl => rsspage(basename($page)));
  182. }
  183. $template->param(
  184. title => $title,
  185. wikiname => $config{wikiname},
  186. parentlinks => [parentlinks($page)],
  187. content => $content,
  188. backlinks => [backlinks($page)],
  189. discussionlink => htmllink($page, "Discussion", 1, 1),
  190. mtime => scalar(gmtime($mtime)),
  191. );
  192. return $template->output;
  193. } #}}}
  194. sub date_822 ($) { #{{{
  195. my $time=shift;
  196. eval q{use POSIX};
  197. return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
  198. } #}}}
  199. sub absolute_urls ($$) { #{{{
  200. # sucky sub because rss sucks
  201. my $content=shift;
  202. my $url=shift;
  203. $url=~s/[^\/]+$//;
  204. $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
  205. $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
  206. return $content;
  207. } #}}}
  208. sub genrss ($$$) { #{{{
  209. my $content=shift;
  210. my $page=shift;
  211. my $mtime=shift;
  212. my $url="$config{url}/".htmlpage($page);
  213. my $template=HTML::Template->new(blind_cache => 1,
  214. filename => "$config{templatedir}/rsspage.tmpl");
  215. my @items;
  216. my $isblog=0;
  217. my $gen_blog=sub {
  218. my $parentpage=shift;
  219. my %params=@_;
  220. if (! exists $params{show}) {
  221. $params{show}=10;
  222. }
  223. if (! exists $params{pages}) {
  224. return "";
  225. }
  226. $isblog=1;
  227. foreach my $page (blog_list($params{pages}, $params{show})) {
  228. next if $page eq $parentpage;
  229. push @items, {
  230. itemtitle => pagetitle(basename($page)),
  231. itemurl => "$config{url}/$renderedfiles{$page}",
  232. itempubdate => date_822($pagectime{$page}),
  233. itemcontent => absolute_urls(get_inline_content($parentpage, $page), $url),
  234. } if exists $renderedfiles{$page};
  235. }
  236. return "";
  237. };
  238. $content = postprocess($page, $content, inline => $gen_blog);
  239. $template->param(
  240. title => $config{wikiname},
  241. pageurl => $url,
  242. items => \@items,
  243. );
  244. return $template->output;
  245. } #}}}
  246. sub check_overwrite ($$) { #{{{
  247. # Important security check. Make sure to call this before saving
  248. # any files to the source directory.
  249. my $dest=shift;
  250. my $src=shift;
  251. if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
  252. error("$dest already exists and was rendered from ".
  253. join(" ",(grep { $renderedfiles{$_} eq $dest } keys
  254. %renderedfiles)).
  255. ", before, so not rendering from $src");
  256. }
  257. } #}}}
  258. sub mtime ($) { #{{{
  259. my $file=shift;
  260. return (stat($file))[9];
  261. } #}}}
  262. sub findlinks ($$) { #{{{
  263. my $content=shift;
  264. my $page=shift;
  265. my @links;
  266. while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
  267. push @links, lc($2);
  268. }
  269. # Discussion links are a special case since they're not in the text
  270. # of the page, but on its template.
  271. return @links, "$page/discussion";
  272. } #}}}
  273. sub render ($) { #{{{
  274. my $file=shift;
  275. my $type=pagetype($file);
  276. my $content=readfile("$config{srcdir}/$file");
  277. if ($type ne 'unknown') {
  278. my $page=pagename($file);
  279. $links{$page}=[findlinks($content, $page)];
  280. delete $inlinepages{$page};
  281. $content=linkify($content, $page);
  282. $content=htmlize($type, $content);
  283. check_overwrite("$config{destdir}/".htmlpage($page), $page);
  284. writefile("$config{destdir}/".htmlpage($page),
  285. genpage($content, $page, mtime("$config{srcdir}/$file")));
  286. $oldpagemtime{$page}=time;
  287. $renderedfiles{$page}=htmlpage($page);
  288. # TODO: should really add this to renderedfiles and call
  289. # check_overwrite, as above, but currently renderedfiles
  290. # only supports listing one file per page.
  291. if ($config{rss} && exists $inlinepages{$page}) {
  292. writefile("$config{destdir}/".rsspage($page),
  293. genrss($content, $page, mtime("$config{srcdir}/$file")));
  294. }
  295. }
  296. else {
  297. $links{$file}=[];
  298. check_overwrite("$config{destdir}/$file", $file);
  299. writefile("$config{destdir}/$file", $content);
  300. $oldpagemtime{$file}=time;
  301. $renderedfiles{$file}=$file;
  302. }
  303. } #}}}
  304. sub prune ($) { #{{{
  305. my $file=shift;
  306. unlink($file);
  307. my $dir=dirname($file);
  308. while (rmdir($dir)) {
  309. $dir=dirname($dir);
  310. }
  311. } #}}}
  312. sub refresh () { #{{{
  313. # find existing pages
  314. my %exists;
  315. my @files;
  316. eval q{use File::Find};
  317. find({
  318. no_chdir => 1,
  319. wanted => sub {
  320. if (/$config{wiki_file_prune_regexp}/) {
  321. no warnings 'once';
  322. $File::Find::prune=1;
  323. use warnings "all";
  324. }
  325. elsif (! -d $_ && ! -l $_) {
  326. my ($f)=/$config{wiki_file_regexp}/; # untaint
  327. if (! defined $f) {
  328. warn("skipping bad filename $_\n");
  329. }
  330. else {
  331. $f=~s/^\Q$config{srcdir}\E\/?//;
  332. push @files, $f;
  333. $exists{pagename($f)}=1;
  334. }
  335. }
  336. },
  337. }, $config{srcdir});
  338. my %rendered;
  339. # check for added or removed pages
  340. my @add;
  341. foreach my $file (@files) {
  342. my $page=pagename($file);
  343. if (! $oldpagemtime{$page}) {
  344. debug("new page $page") unless exists $pagectime{$page};
  345. push @add, $file;
  346. $links{$page}=[];
  347. $pagesources{$page}=$file;
  348. $pagectime{$page}=mtime("$config{srcdir}/$file")
  349. unless exists $pagectime{$page};
  350. }
  351. }
  352. my @del;
  353. foreach my $page (keys %oldpagemtime) {
  354. if (! $exists{$page}) {
  355. debug("removing old page $page");
  356. push @del, $pagesources{$page};
  357. prune($config{destdir}."/".$renderedfiles{$page});
  358. delete $renderedfiles{$page};
  359. $oldpagemtime{$page}=0;
  360. delete $pagesources{$page};
  361. }
  362. }
  363. # render any updated files
  364. foreach my $file (@files) {
  365. my $page=pagename($file);
  366. if (! exists $oldpagemtime{$page} ||
  367. mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
  368. debug("rendering changed file $file");
  369. render($file);
  370. $rendered{$file}=1;
  371. }
  372. }
  373. # if any files were added or removed, check to see if each page
  374. # needs an update due to linking to them or inlining them.
  375. # TODO: inefficient; pages may get rendered above and again here;
  376. # problem is the bestlink may have changed and we won't know until
  377. # now
  378. if (@add || @del) {
  379. FILE: foreach my $file (@files) {
  380. my $page=pagename($file);
  381. foreach my $f (@add, @del) {
  382. my $p=pagename($f);
  383. foreach my $link (@{$links{$page}}) {
  384. if (bestlink($page, $link) eq $p) {
  385. debug("rendering $file, which links to $p");
  386. render($file);
  387. $rendered{$file}=1;
  388. next FILE;
  389. }
  390. }
  391. }
  392. }
  393. }
  394. # Handle backlinks; if a page has added/removed links, update the
  395. # pages it links to. Also handle inlining here.
  396. # TODO: inefficient; pages may get rendered above and again here;
  397. # problem is the backlinks could be wrong in the first pass render
  398. # above
  399. if (%rendered || @del) {
  400. foreach my $f (@files) {
  401. my $p=pagename($f);
  402. if (exists $inlinepages{$p}) {
  403. foreach my $file (keys %rendered, @del) {
  404. my $page=pagename($file);
  405. if (globlist_match($page, $inlinepages{$p})) {
  406. debug("rendering $f, which inlines $page");
  407. render($f);
  408. last;
  409. }
  410. }
  411. }
  412. }
  413. my %linkchanged;
  414. foreach my $file (keys %rendered, @del) {
  415. my $page=pagename($file);
  416. if (exists $links{$page}) {
  417. foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
  418. if (length $link &&
  419. ! exists $oldlinks{$page} ||
  420. ! grep { $_ eq $link } @{$oldlinks{$page}}) {
  421. $linkchanged{$link}=1;
  422. }
  423. }
  424. }
  425. if (exists $oldlinks{$page}) {
  426. foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
  427. if (length $link &&
  428. ! exists $links{$page} ||
  429. ! grep { $_ eq $link } @{$links{$page}}) {
  430. $linkchanged{$link}=1;
  431. }
  432. }
  433. }
  434. }
  435. foreach my $link (keys %linkchanged) {
  436. my $linkfile=$pagesources{$link};
  437. if (defined $linkfile) {
  438. debug("rendering $linkfile, to update its backlinks");
  439. render($linkfile);
  440. }
  441. }
  442. }
  443. } #}}}
  444. 1