8375cfe7a9d3e984253f417415e12a8927baa51f
[ikiwiki.git] / IkiWiki / Render.pm
1 package IkiWiki;
2
3 use warnings;
4 use strict;
5 use File::Spec;
6
7 sub linkify ($$) { #{{{
8         my $content=shift;
9         my $page=shift;
10
11         $content =~ s{(\\?)$config{wiki_link_regexp}}{
12                 $2 ? ( $1 ? "[[$2|$3]]" : htmllink($page, titlepage($3), 0, 0, pagetitle($2)))
13                    : ( $1 ? "[[$3]]" :    htmllink($page, titlepage($3)))
14         }eg;
15         
16         return $content;
17 } #}}}
18
19 sub htmlize ($$) { #{{{
20         my $type=shift;
21         my $content=shift;
22         
23         if (! $INC{"/usr/bin/markdown"}) {
24                 no warnings 'once';
25                 $blosxom::version="is a proper perl module too much to ask?";
26                 use warnings 'all';
27                 do "/usr/bin/markdown";
28         }
29         
30         if ($type eq '.mdwn') {
31                 return Markdown::Markdown($content);
32         }
33         else {
34                 error("htmlization of $type not supported");
35         }
36 } #}}}
37
38 sub backlinks ($) { #{{{
39         my $page=shift;
40
41         my @links;
42         foreach my $p (keys %links) {
43                 next if bestlink($page, $p) eq $page;
44                 if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
45                         my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
46                         
47                         # Trim common dir prefixes from both pages.
48                         my $p_trimmed=$p;
49                         my $page_trimmed=$page;
50                         my $dir;
51                         1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
52                                 defined $dir &&
53                                 $p_trimmed=~s/^\Q$dir\E// &&
54                                 $page_trimmed=~s/^\Q$dir\E//;
55                                        
56                         push @links, { url => $href, page => $p_trimmed };
57                 }
58         }
59
60         return sort { $a->{page} cmp $b->{page} } @links;
61 } #}}}
62
63 sub parentlinks ($) { #{{{
64         my $page=shift;
65         
66         my @ret;
67         my $pagelink="";
68         my $path="";
69         my $skip=1;
70         foreach my $dir (reverse split("/", $page)) {
71                 if (! $skip) {
72                         $path.="../";
73                         unshift @ret, { url => "$path$dir.html", page => $dir };
74                 }
75                 else {
76                         $skip=0;
77                 }
78         }
79         unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
80         return @ret;
81 } #}}}
82
83 sub rsspage ($) { #{{{
84         my $page=shift;
85
86         return $page.".rss";
87 } #}}}
88
89 sub postprocess { #{{{
90         # Takes content to postprocess followed by a list of postprocessor
91         # commands and subroutine references to run for the commands.
92         my $page=shift;
93         my $content=shift;
94         my %commands=@_;
95         
96         my $handle=sub {
97                 my $escape=shift;
98                 my $command=shift;
99                 my $params=shift;
100                 if (length $escape) {
101                         "[[$command $params]]";
102                 }
103                 elsif (exists $commands{$command}) {
104                         my %params;
105                         while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) {
106                                 $params{$1}=$2;
107                         }
108                         $commands{$command}->($page, %params);
109                 }
110                 else {
111                         "[[bad directive $command]]";
112                 }
113         };
114         
115         $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg;
116         return $content;
117 } #}}}
118
119 sub blog_list ($$) { #{{{
120         my $globlist=shift;
121         my $maxitems=shift;
122         
123         my @list;
124         foreach my $page (keys %pagesources) {
125                 if (globlist_match($page, $globlist)) {
126                         push @list, $page;
127                 }
128         }
129
130         @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
131         return @list if ! $maxitems || @list <= $maxitems;
132         return @list[0..$maxitems - 1];
133 } #}}}
134
135 sub get_inline_content ($$) { #{{{
136         my $parentpage=shift;
137         my $page=shift;
138         
139         my $file=$pagesources{$page};
140         my $type=pagetype($file);
141         if ($type ne 'unknown') {
142                 return htmlize($type, linkify(readfile(srcfile($file)), $parentpage));
143         }
144         else {
145                 return "";
146         }
147 } #}}}
148
149 sub postprocess_html_inline { #{{{
150         my $parentpage=shift;
151         my %params=@_;
152         
153         if (! exists $params{pages}) {
154                 return "";
155         }
156         if (! exists $params{archive}) {
157                 $params{archive}="no";
158         }
159         if (! exists $params{show} && $params{archive} eq "no") {
160                 $params{show}=10;
161         }
162         $inlinepages{$parentpage}=$params{pages};
163         
164         my $ret="";
165         
166         if (exists $params{rootpage}) {
167                 my $formtemplate=HTML::Template->new(blind_cache => 1,
168                         filename => "$config{templatedir}/blogpost.tmpl");
169                 $formtemplate->param(cgiurl => $config{cgiurl});
170                 $formtemplate->param(rootpage => $params{rootpage});
171                 my $form=$formtemplate->output;
172                 $ret.=$form;
173         }
174         
175         my $template=HTML::Template->new(blind_cache => 1,
176                 filename => (($params{archive} eq "no") 
177                                 ? "$config{templatedir}/inlinepage.tmpl"
178                                 : "$config{templatedir}/inlinepagetitle.tmpl"));
179         
180         foreach my $page (blog_list($params{pages}, $params{show})) {
181                 next if $page eq $parentpage;
182                 $template->param(pagelink => htmllink($parentpage, $page));
183                 $template->param(content => get_inline_content($parentpage, $page))
184                         if $params{archive} eq "no";
185                 $template->param(ctime => scalar(gmtime($pagectime{$page})));
186                 $ret.=$template->output;
187         }
188         
189         return "</p>$ret<p>";
190 } #}}}
191
192 sub genpage ($$$) { #{{{
193         my $content=shift;
194         my $page=shift;
195         my $mtime=shift;
196
197         $content = postprocess($page, $content, inline => \&postprocess_html_inline);
198         
199         my $title=pagetitle(basename($page));
200         
201         my $template=HTML::Template->new(blind_cache => 1,
202                 filename => "$config{templatedir}/page.tmpl");
203         
204         if (length $config{cgiurl}) {
205                 $template->param(editurl => cgiurl(do => "edit", page => $page));
206                 $template->param(prefsurl => cgiurl(do => "prefs"));
207                 if ($config{rcs}) {
208                         $template->param(recentchangesurl => cgiurl(do => "recentchanges"));
209                 }
210         }
211
212         if (length $config{historyurl}) {
213                 my $u=$config{historyurl};
214                 $u=~s/\[\[file\]\]/$pagesources{$page}/g;
215                 $template->param(historyurl => $u);
216         }
217         if ($config{hyperestraier}) {
218                 $template->param(hyperestraierurl => cgiurl());
219         }
220
221         if ($config{rss} && $inlinepages{$page}) {
222                 $template->param(rssurl => rsspage(basename($page)));
223         }
224         
225         $template->param(
226                 title => $title,
227                 wikiname => $config{wikiname},
228                 parentlinks => [parentlinks($page)],
229                 content => $content,
230                 backlinks => [backlinks($page)],
231                 discussionlink => htmllink($page, "Discussion", 1, 1),
232                 mtime => scalar(gmtime($mtime)),
233                 styleurl => styleurl($page),
234         );
235         
236         return $template->output;
237 } #}}}
238
239 sub date_822 ($) { #{{{
240         my $time=shift;
241
242         eval q{use POSIX};
243         return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
244 } #}}}
245
246 sub absolute_urls ($$) { #{{{
247         # sucky sub because rss sucks
248         my $content=shift;
249         my $url=shift;
250
251         $url=~s/[^\/]+$//;
252         
253         $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
254         $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
255         return $content;
256 } #}}}
257
258 sub genrss ($$$) { #{{{
259         my $content=shift;
260         my $page=shift;
261         my $mtime=shift;
262         
263         my $url="$config{url}/".htmlpage($page);
264         
265         my $template=HTML::Template->new(blind_cache => 1,
266                 filename => "$config{templatedir}/rsspage.tmpl");
267         
268         my @items;
269         my $isblog=0;
270         my $gen_blog=sub {
271                 my $parentpage=shift;
272                 my %params=@_;
273                 
274                 if (! exists $params{show}) {
275                         $params{show}=10;
276                 }
277                 if (! exists $params{pages}) {
278                         return "";
279                 }
280                 
281                 $isblog=1;
282                 foreach my $page (blog_list($params{pages}, $params{show})) {
283                         next if $page eq $parentpage;
284                         push @items, {
285                                 itemtitle => pagetitle(basename($page)),
286                                 itemurl => "$config{url}/$renderedfiles{$page}",
287                                 itempubdate => date_822($pagectime{$page}),
288                                 itemcontent => absolute_urls(get_inline_content($parentpage, $page), $url),
289                         } if exists $renderedfiles{$page};
290                 }
291                 
292                 return "";
293         };
294         
295         $content = postprocess($page, $content, inline => $gen_blog);
296
297         $template->param(
298                 title => $config{wikiname},
299                 pageurl => $url,
300                 items => \@items,
301         );
302         
303         return $template->output;
304 } #}}}
305
306 sub check_overwrite ($$) { #{{{
307         # Important security check. Make sure to call this before saving
308         # any files to the source directory.
309         my $dest=shift;
310         my $src=shift;
311         
312         if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
313                 error("$dest already exists and was rendered from ".
314                         join(" ",(grep { $renderedfiles{$_} eq $dest } keys
315                                 %renderedfiles)).
316                         ", before, so not rendering from $src");
317         }
318 } #}}}
319
320 sub mtime ($) { #{{{
321         my $file=shift;
322         
323         return (stat($file))[9];
324 } #}}}
325
326 sub findlinks ($$) { #{{{
327         my $content=shift;
328         my $page=shift;
329
330         my @links;
331         while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
332                 push @links, titlepage($2);
333         }
334         # Discussion links are a special case since they're not in the text
335         # of the page, but on its template.
336         return @links, "$page/discussion";
337 } #}}}
338
339 sub render ($) { #{{{
340         my $file=shift;
341         
342         my $type=pagetype($file);
343         my $srcfile=srcfile($file);
344         my $content=readfile($srcfile);
345         if ($type ne 'unknown') {
346                 my $page=pagename($file);
347                 
348                 $links{$page}=[findlinks($content, $page)];
349                 delete $inlinepages{$page};
350                 
351                 $content=linkify($content, $page);
352                 $content=htmlize($type, $content);
353                 
354                 check_overwrite("$config{destdir}/".htmlpage($page), $page);
355                 writefile(htmlpage($page), $config{destdir},
356                         genpage($content, $page, mtime($srcfile)));
357                 $oldpagemtime{$page}=time;
358                 $renderedfiles{$page}=htmlpage($page);
359
360                 # TODO: should really add this to renderedfiles and call
361                 # check_overwrite, as above, but currently renderedfiles
362                 # only supports listing one file per page.
363                 if ($config{rss} && exists $inlinepages{$page}) {
364                         writefile(rsspage($page), $config{destdir},
365                                 genrss($content, $page, mtime($srcfile)));
366                 }
367         }
368         else {
369                 $links{$file}=[];
370                 check_overwrite("$config{destdir}/$file", $file);
371                 writefile($file, $config{destdir}, $content);
372                 $oldpagemtime{$file}=time;
373                 $renderedfiles{$file}=$file;
374         }
375 } #}}}
376
377 sub prune ($) { #{{{
378         my $file=shift;
379
380         unlink($file);
381         my $dir=dirname($file);
382         while (rmdir($dir)) {
383                 $dir=dirname($dir);
384         }
385 } #}}}
386
387 sub estcfg () { #{{{
388         my $estdir="$config{wikistatedir}/hyperestraier";
389         my $cgi=basename($config{cgiurl});
390         $cgi=~s/\..*$//;
391         open(TEMPLATE, ">$estdir/$cgi.tmpl") ||
392                 error("write $estdir/$cgi.tmpl: $!");
393         print TEMPLATE misctemplate("search", 
394                 "<!--ESTFORM-->\n\n<!--ESTRESULT-->\n\n<!--ESTINFO-->\n\n");
395         close TEMPLATE;
396         open(TEMPLATE, ">$estdir/$cgi.conf") ||
397                 error("write $estdir/$cgi.conf: $!");
398         my $template=HTML::Template->new(
399                 filename => "$config{templatedir}/estseek.conf"
400         );
401         eval q{use Cwd 'abs_path'};
402         $template->param(
403                 index => $estdir,
404                 tmplfile => "$estdir/$cgi.tmpl",
405                 destdir => abs_path($config{destdir}),
406                 url => $config{url},
407         );
408         print TEMPLATE $template->output;
409         close TEMPLATE;
410         symlink("/usr/lib/estraier/estseek.cgi",
411                 "$estdir/".basename($config{cgiurl})) ||
412                         error("symlink: $!");
413 } # }}}
414
415 sub estcmd ($;@) { #{{{
416         my @params=split(' ', shift);
417         push @params, "-cl", "$config{wikistatedir}/hyperestraier";
418         if (@_) {
419                 push @params, "-";
420         }
421         
422         my $pid=open(CHILD, "|-");
423         if ($pid) {
424                 # parent
425                 foreach (@_) {
426                         print CHILD "$_\n";
427                 }
428                 close(CHILD) || error("estcmd @params exited nonzero: $?");
429         }
430         else {
431                 # child
432                 open(STDOUT, "/dev/null"); # shut it up (closing won't work)
433                 exec("estcmd", @params) || error("can't run estcmd");
434         }
435 } #}}}
436
437 sub refresh () { #{{{
438         # find existing pages
439         my %exists;
440         my @files;
441         eval q{use File::Find};
442         find({
443                 no_chdir => 1,
444                 wanted => sub {
445                         if (/$config{wiki_file_prune_regexp}/) {
446                                 $File::Find::prune=1;
447                         }
448                         elsif (! -d $_ && ! -l $_) {
449                                 my ($f)=/$config{wiki_file_regexp}/; # untaint
450                                 if (! defined $f) {
451                                         warn("skipping bad filename $_\n");
452                                 }
453                                 else {
454                                         $f=~s/^\Q$config{srcdir}\E\/?//;
455                                         push @files, $f;
456                                         $exists{pagename($f)}=1;
457                                 }
458                         }
459                 },
460         }, $config{srcdir});
461         find({
462                 no_chdir => 1,
463                 wanted => sub {
464                         if (/$config{wiki_file_prune_regexp}/) {
465                                 $File::Find::prune=1;
466                         }
467                         elsif (! -d $_ && ! -l $_) {
468                                 my ($f)=/$config{wiki_file_regexp}/; # untaint
469                                 if (! defined $f) {
470                                         warn("skipping bad filename $_\n");
471                                 }
472                                 else {
473                                         # Don't add files that are in the
474                                         # srcdir.
475                                         $f=~s/^\Q$config{underlaydir}\E\/?//;
476                                         if (! -e "$config{srcdir}/$f" && 
477                                             ! -l "$config{srcdir}/$f") {
478                                                 push @files, $f;
479                                                 $exists{pagename($f)}=1;
480                                         }
481                                 }
482                         }
483                 },
484         }, $config{underlaydir});
485
486         my %rendered;
487
488         # check for added or removed pages
489         my @add;
490         foreach my $file (@files) {
491                 my $page=pagename($file);
492                 if (! $oldpagemtime{$page}) {
493                         debug("new page $page") unless exists $pagectime{$page};
494                         push @add, $file;
495                         $links{$page}=[];
496                         $pagesources{$page}=$file;
497                         $pagectime{$page}=mtime(srcfile($file))
498                                 unless exists $pagectime{$page};
499                 }
500         }
501         my @del;
502         foreach my $page (keys %oldpagemtime) {
503                 if (! $exists{$page}) {
504                         debug("removing old page $page");
505                         push @del, $pagesources{$page};
506                         prune($config{destdir}."/".$renderedfiles{$page});
507                         delete $renderedfiles{$page};
508                         $oldpagemtime{$page}=0;
509                         delete $pagesources{$page};
510                 }
511         }
512         
513         # render any updated files
514         foreach my $file (@files) {
515                 my $page=pagename($file);
516                 
517                 if (! exists $oldpagemtime{$page} ||
518                     mtime(srcfile($file)) > $oldpagemtime{$page}) {
519                         debug("rendering changed file $file");
520                         render($file);
521                         $rendered{$file}=1;
522                 }
523         }
524         
525         # if any files were added or removed, check to see if each page
526         # needs an update due to linking to them or inlining them.
527         # TODO: inefficient; pages may get rendered above and again here;
528         # problem is the bestlink may have changed and we won't know until
529         # now
530         if (@add || @del) {
531 FILE:           foreach my $file (@files) {
532                         my $page=pagename($file);
533                         foreach my $f (@add, @del) {
534                                 my $p=pagename($f);
535                                 foreach my $link (@{$links{$page}}) {
536                                         if (bestlink($page, $link) eq $p) {
537                                                 debug("rendering $file, which links to $p");
538                                                 render($file);
539                                                 $rendered{$file}=1;
540                                                 next FILE;
541                                         }
542                                 }
543                         }
544                 }
545         }
546
547         # Handle backlinks; if a page has added/removed links, update the
548         # pages it links to. Also handle inlining here.
549         # TODO: inefficient; pages may get rendered above and again here;
550         # problem is the backlinks could be wrong in the first pass render
551         # above
552         if (%rendered || @del) {
553                 foreach my $f (@files) {
554                         my $p=pagename($f);
555                         if (exists $inlinepages{$p}) {
556                                 foreach my $file (keys %rendered, @del) {
557                                         my $page=pagename($file);
558                                         if (globlist_match($page, $inlinepages{$p})) {
559                                                 debug("rendering $f, which inlines $page");
560                                                 render($f);
561                                                 $rendered{$f}=1;
562                                                 last;
563                                         }
564                                 }
565                         }
566                 }
567                 
568                 my %linkchanged;
569                 foreach my $file (keys %rendered, @del) {
570                         my $page=pagename($file);
571                         
572                         if (exists $links{$page}) {
573                                 foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
574                                         if (length $link &&
575                                             ! exists $oldlinks{$page} ||
576                                             ! grep { $_ eq $link } @{$oldlinks{$page}}) {
577                                                 $linkchanged{$link}=1;
578                                         }
579                                 }
580                         }
581                         if (exists $oldlinks{$page}) {
582                                 foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
583                                         if (length $link &&
584                                             ! exists $links{$page} ||
585                                             ! grep { $_ eq $link } @{$links{$page}}) {
586                                                 $linkchanged{$link}=1;
587                                         }
588                                 }
589                         }
590                 }
591                 foreach my $link (keys %linkchanged) {
592                         my $linkfile=$pagesources{$link};
593                         if (defined $linkfile) {
594                                 debug("rendering $linkfile, to update its backlinks");
595                                 render($linkfile);
596                                 $rendered{$linkfile}=1;
597                         }
598                 }
599         }
600
601         if ($config{hyperestraier} && (%rendered || @del)) {
602                 debug("updating hyperestraier search index");
603                 if (%rendered) {
604                         estcmd("gather -cm -bc -cl -sd", 
605                                 map { $config{destdir}."/".$renderedfiles{pagename($_)} }
606                                 keys %rendered);
607                 }
608                 if (@del) {
609                         estcmd("purge -cl");
610                 }
611                 
612                 debug("generating hyperestraier cgi config");
613                 estcfg();
614         }
615 } #}}}
616
617 1