html validation fixes:
[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("$config{srcdir}/$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
218         if ($config{rss} && $inlinepages{$page}) {
219                 $template->param(rssurl => rsspage(basename($page)));
220         }
221         
222         $template->param(
223                 title => $title,
224                 wikiname => $config{wikiname},
225                 parentlinks => [parentlinks($page)],
226                 content => $content,
227                 backlinks => [backlinks($page)],
228                 discussionlink => htmllink($page, "Discussion", 1, 1),
229                 mtime => scalar(gmtime($mtime)),
230         );
231         
232         return $template->output;
233 } #}}}
234
235 sub date_822 ($) { #{{{
236         my $time=shift;
237
238         eval q{use POSIX};
239         return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
240 } #}}}
241
242 sub absolute_urls ($$) { #{{{
243         # sucky sub because rss sucks
244         my $content=shift;
245         my $url=shift;
246
247         $url=~s/[^\/]+$//;
248         
249         $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
250         $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
251         return $content;
252 } #}}}
253
254 sub genrss ($$$) { #{{{
255         my $content=shift;
256         my $page=shift;
257         my $mtime=shift;
258         
259         my $url="$config{url}/".htmlpage($page);
260         
261         my $template=HTML::Template->new(blind_cache => 1,
262                 filename => "$config{templatedir}/rsspage.tmpl");
263         
264         my @items;
265         my $isblog=0;
266         my $gen_blog=sub {
267                 my $parentpage=shift;
268                 my %params=@_;
269                 
270                 if (! exists $params{show}) {
271                         $params{show}=10;
272                 }
273                 if (! exists $params{pages}) {
274                         return "";
275                 }
276                 
277                 $isblog=1;
278                 foreach my $page (blog_list($params{pages}, $params{show})) {
279                         next if $page eq $parentpage;
280                         push @items, {
281                                 itemtitle => pagetitle(basename($page)),
282                                 itemurl => "$config{url}/$renderedfiles{$page}",
283                                 itempubdate => date_822($pagectime{$page}),
284                                 itemcontent => absolute_urls(get_inline_content($parentpage, $page), $url),
285                         } if exists $renderedfiles{$page};
286                 }
287                 
288                 return "";
289         };
290         
291         $content = postprocess($page, $content, inline => $gen_blog);
292
293         $template->param(
294                 title => $config{wikiname},
295                 pageurl => $url,
296                 items => \@items,
297         );
298         
299         return $template->output;
300 } #}}}
301
302 sub check_overwrite ($$) { #{{{
303         # Important security check. Make sure to call this before saving
304         # any files to the source directory.
305         my $dest=shift;
306         my $src=shift;
307         
308         if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
309                 error("$dest already exists and was rendered from ".
310                         join(" ",(grep { $renderedfiles{$_} eq $dest } keys
311                                 %renderedfiles)).
312                         ", before, so not rendering from $src");
313         }
314 } #}}}
315
316 sub mtime ($) { #{{{
317         my $file=shift;
318         
319         return (stat($file))[9];
320 } #}}}
321
322 sub findlinks ($$) { #{{{
323         my $content=shift;
324         my $page=shift;
325
326         my @links;
327         while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
328                 push @links, titlepage($2);
329         }
330         # Discussion links are a special case since they're not in the text
331         # of the page, but on its template.
332         return @links, "$page/discussion";
333 } #}}}
334
335 sub render ($) { #{{{
336         my $file=shift;
337         
338         my $type=pagetype($file);
339         my $content=readfile("$config{srcdir}/$file");
340         if ($type ne 'unknown') {
341                 my $page=pagename($file);
342                 
343                 $links{$page}=[findlinks($content, $page)];
344                 delete $inlinepages{$page};
345                 
346                 $content=linkify($content, $page);
347                 $content=htmlize($type, $content);
348                 
349                 check_overwrite("$config{destdir}/".htmlpage($page), $page);
350                 writefile("$config{destdir}/".htmlpage($page),
351                         genpage($content, $page, mtime("$config{srcdir}/$file")));
352                 $oldpagemtime{$page}=time;
353                 $renderedfiles{$page}=htmlpage($page);
354
355                 # TODO: should really add this to renderedfiles and call
356                 # check_overwrite, as above, but currently renderedfiles
357                 # only supports listing one file per page.
358                 if ($config{rss} && exists $inlinepages{$page}) {
359                         writefile("$config{destdir}/".rsspage($page),
360                                 genrss($content, $page, mtime("$config{srcdir}/$file")));
361                 }
362         }
363         else {
364                 $links{$file}=[];
365                 check_overwrite("$config{destdir}/$file", $file);
366                 writefile("$config{destdir}/$file", $content);
367                 $oldpagemtime{$file}=time;
368                 $renderedfiles{$file}=$file;
369         }
370 } #}}}
371
372 sub prune ($) { #{{{
373         my $file=shift;
374
375         unlink($file);
376         my $dir=dirname($file);
377         while (rmdir($dir)) {
378                 $dir=dirname($dir);
379         }
380 } #}}}
381
382 sub refresh () { #{{{
383         # find existing pages
384         my %exists;
385         my @files;
386         eval q{use File::Find};
387         find({
388                 no_chdir => 1,
389                 wanted => sub {
390                         if (/$config{wiki_file_prune_regexp}/) {
391                                 no warnings 'once';
392                                 $File::Find::prune=1;
393                                 use warnings "all";
394                         }
395                         elsif (! -d $_ && ! -l $_) {
396                                 my ($f)=/$config{wiki_file_regexp}/; # untaint
397                                 if (! defined $f) {
398                                         warn("skipping bad filename $_\n");
399                                 }
400                                 else {
401                                         $f=~s/^\Q$config{srcdir}\E\/?//;
402                                         push @files, $f;
403                                         $exists{pagename($f)}=1;
404                                 }
405                         }
406                 },
407         }, $config{srcdir});
408
409         my %rendered;
410
411         # check for added or removed pages
412         my @add;
413         foreach my $file (@files) {
414                 my $page=pagename($file);
415                 if (! $oldpagemtime{$page}) {
416                         debug("new page $page") unless exists $pagectime{$page};
417                         push @add, $file;
418                         $links{$page}=[];
419                         $pagesources{$page}=$file;
420                         $pagectime{$page}=mtime("$config{srcdir}/$file") 
421                                 unless exists $pagectime{$page};
422                 }
423         }
424         my @del;
425         foreach my $page (keys %oldpagemtime) {
426                 if (! $exists{$page}) {
427                         debug("removing old page $page");
428                         push @del, $pagesources{$page};
429                         prune($config{destdir}."/".$renderedfiles{$page});
430                         delete $renderedfiles{$page};
431                         $oldpagemtime{$page}=0;
432                         delete $pagesources{$page};
433                 }
434         }
435         
436         # render any updated files
437         foreach my $file (@files) {
438                 my $page=pagename($file);
439                 
440                 if (! exists $oldpagemtime{$page} ||
441                     mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
442                         debug("rendering changed file $file");
443                         render($file);
444                         $rendered{$file}=1;
445                 }
446         }
447         
448         # if any files were added or removed, check to see if each page
449         # needs an update due to linking to them or inlining them.
450         # TODO: inefficient; pages may get rendered above and again here;
451         # problem is the bestlink may have changed and we won't know until
452         # now
453         if (@add || @del) {
454 FILE:           foreach my $file (@files) {
455                         my $page=pagename($file);
456                         foreach my $f (@add, @del) {
457                                 my $p=pagename($f);
458                                 foreach my $link (@{$links{$page}}) {
459                                         if (bestlink($page, $link) eq $p) {
460                                                 debug("rendering $file, which links to $p");
461                                                 render($file);
462                                                 $rendered{$file}=1;
463                                                 next FILE;
464                                         }
465                                 }
466                         }
467                 }
468         }
469
470         # Handle backlinks; if a page has added/removed links, update the
471         # pages it links to. Also handle inlining here.
472         # TODO: inefficient; pages may get rendered above and again here;
473         # problem is the backlinks could be wrong in the first pass render
474         # above
475         if (%rendered || @del) {
476                 foreach my $f (@files) {
477                         my $p=pagename($f);
478                         if (exists $inlinepages{$p}) {
479                                 foreach my $file (keys %rendered, @del) {
480                                         my $page=pagename($file);
481                                         if (globlist_match($page, $inlinepages{$p})) {
482                                                 debug("rendering $f, which inlines $page");
483                                                 render($f);
484                                                 last;
485                                         }
486                                 }
487                         }
488                 }
489                 
490                 my %linkchanged;
491                 foreach my $file (keys %rendered, @del) {
492                         my $page=pagename($file);
493                         
494                         if (exists $links{$page}) {
495                                 foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
496                                         if (length $link &&
497                                             ! exists $oldlinks{$page} ||
498                                             ! grep { $_ eq $link } @{$oldlinks{$page}}) {
499                                                 $linkchanged{$link}=1;
500                                         }
501                                 }
502                         }
503                         if (exists $oldlinks{$page}) {
504                                 foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
505                                         if (length $link &&
506                                             ! exists $links{$page} ||
507                                             ! grep { $_ eq $link } @{$links{$page}}) {
508                                                 $linkchanged{$link}=1;
509                                         }
510                                 }
511                         }
512                 }
513                 foreach my $link (keys %linkchanged) {
514                         my $linkfile=$pagesources{$link};
515                         if (defined $linkfile) {
516                                 debug("rendering $linkfile, to update its backlinks");
517                                 render($linkfile);
518                         }
519                 }
520         }
521 } #}}}
522
523 1