HTML::Entities::encode_numeric is not exported
[ikiwiki.git] / IkiWiki / Render.pm
blob5288abc6dc40549c8debe95c6259172deb51b7b1
1 #!/usr/bin/perl
3 package IkiWiki;
5 use warnings;
6 use strict;
7 use IkiWiki;
9 my (%backlinks, %rendered);
10 our %brokenlinks;
11 my $links_calculated=0;
13 sub calculate_links () {
14 return if $links_calculated;
15 %backlinks=%brokenlinks=();
16 foreach my $page (keys %links) {
17 foreach my $link (@{$links{$page}}) {
18 my $bestlink=bestlink($page, $link);
19 if (length $bestlink) {
20 $backlinks{$bestlink}{$page}=1
21 if $bestlink ne $page;
23 else {
24 push @{$brokenlinks{$link}}, $page;
28 $links_calculated=1;
31 sub backlink_pages ($) {
32 my $page=shift;
34 calculate_links();
36 return keys %{$backlinks{$page}};
39 sub backlinks ($) {
40 my $page=shift;
42 my @links;
43 foreach my $p (backlink_pages($page)) {
44 my $href=urlto($p, $page);
46 # Trim common dir prefixes from both pages.
47 my $p_trimmed=$p;
48 my $page_trimmed=$page;
49 my $dir;
50 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
51 defined $dir &&
52 $p_trimmed=~s/^\Q$dir\E// &&
53 $page_trimmed=~s/^\Q$dir\E//;
55 push @links, { url => $href, page => pagetitle($p_trimmed) };
57 return @links;
60 sub genpage ($$) {
61 my $page=shift;
62 my $content=shift;
64 run_hooks(indexhtml => sub {
65 shift->(page => $page, destpage => $page, content => $content);
66 });
68 my $templatefile;
69 run_hooks(templatefile => sub {
70 return if defined $templatefile;
71 my $file=shift->(page => $page);
72 if (defined $file && defined template_file($file)) {
73 $templatefile=$file;
75 });
76 my $template;
77 if (defined $templatefile) {
78 $template=template_depends($templatefile, $page,
79 blind_cache => 1);
81 else {
82 # no explicit depends as special case
83 $template=template('page.tmpl',
84 blind_cache => 1);
87 my $actions=0;
88 if (length $config{cgiurl}) {
89 if (IkiWiki->can("cgi_editpage")) {
90 $template->param(editurl => cgiurl(do => "edit", page => $page));
91 $actions++;
94 if (defined $config{historyurl} && length $config{historyurl}) {
95 my $u=$config{historyurl};
96 my $p=uri_escape_utf8($pagesources{$page}, '^A-Za-z0-9\-\._~/');
97 $u=~s/\[\[file\]\]/$p/g;
98 $template->param(historyurl => $u);
99 $actions++;
101 if ($config{discussion}) {
102 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
103 (length $config{cgiurl} ||
104 exists $links{$page."/".$config{discussionpage}})) {
105 $template->param(discussionlink => htmllink($page, $page, $config{discussionpage}, noimageinline => 1, forcesubpage => 1));
106 $actions++;
109 if ($actions) {
110 $template->param(have_actions => 1);
112 templateactions($template, $page);
114 my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
115 my ($backlinks, $more_backlinks);
116 if (@backlinks <= $config{numbacklinks} || ! $config{numbacklinks}) {
117 $backlinks=\@backlinks;
118 $more_backlinks=[];
120 else {
121 $backlinks=[@backlinks[0..$config{numbacklinks}-1]];
122 $more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]];
125 $template->param(
126 title => $page eq 'index'
127 ? $config{wikiname}
128 : pagetitle(basename($page)),
129 wikiname => $config{wikiname},
130 content => $content,
131 backlinks => $backlinks,
132 more_backlinks => $more_backlinks,
133 mtime => displaytime($pagemtime{$page}),
134 ctime => displaytime($pagectime{$page}, undef, 1),
135 baseurl => baseurl($page),
136 html5 => $config{html5},
139 run_hooks(pagetemplate => sub {
140 shift->(page => $page, destpage => $page, template => $template);
143 $content=$template->output;
145 run_hooks(format => sub {
146 $content=shift->(
147 page => $page,
148 content => $content,
152 return $content;
155 sub scan ($) {
156 my $file=shift;
158 debug(sprintf(gettext("scanning %s"), $file));
160 my $type=pagetype($file);
161 if (defined $type) {
162 my $srcfile=srcfile($file);
163 my $content=readfile($srcfile);
164 my $page=pagename($file);
165 will_render($page, htmlpage($page), 1);
167 if ($config{discussion}) {
168 # Discussion links are a special case since they're
169 # not in the text of the page, but on its template.
170 $links{$page}=[ $page."/".lc($config{discussionpage}) ];
172 else {
173 $links{$page}=[];
175 delete $typedlinks{$page};
177 # Preprocess in scan-only mode.
178 preprocess($page, $page, $content, 1);
180 run_hooks(scan => sub {
181 shift->(
182 page => $page,
183 content => $content,
187 else {
188 will_render($file, $file, 1);
192 sub fast_file_copy (@) {
193 my $srcfile=shift;
194 my $destfile=shift;
195 my $srcfd=shift;
196 my $destfd=shift;
197 my $cleanup=shift;
199 my $blksize = 16384;
200 my ($len, $buf, $written);
201 while ($len = sysread $srcfd, $buf, $blksize) {
202 if (! defined $len) {
203 next if $! =~ /^Interrupted/;
204 error("failed to read $srcfile: $!", $cleanup);
206 my $offset = 0;
207 while ($len) {
208 defined($written = syswrite $destfd, $buf, $len, $offset)
209 or error("failed to write $destfile: $!", $cleanup);
210 $len -= $written;
211 $offset += $written;
216 sub render ($$) {
217 my $file=shift;
218 return if $rendered{$file};
219 debug(shift);
220 $rendered{$file}=1;
222 my $type=pagetype($file);
223 my $srcfile=srcfile($file);
224 if (defined $type) {
225 my $page=pagename($file);
226 delete $depends{$page};
227 delete $depends_simple{$page};
228 will_render($page, htmlpage($page), 1);
229 return if $type=~/^_/;
231 my $content=htmlize($page, $page, $type,
232 linkify($page, $page,
233 preprocess($page, $page,
234 filter($page, $page,
235 readfile($srcfile)))));
237 my $output=htmlpage($page);
238 writefile($output, $config{destdir}, genpage($page, $content));
240 else {
241 delete $depends{$file};
242 delete $depends_simple{$file};
243 will_render($file, $file, 1);
245 if ($config{hardlink}) {
246 # only hardlink if owned by same user
247 my @stat=stat($srcfile);
248 if ($stat[4] == $>) {
249 prep_writefile($file, $config{destdir});
250 unlink($config{destdir}."/".$file);
251 if (link($srcfile, $config{destdir}."/".$file)) {
252 return;
255 # if hardlink fails, fall back to copying
258 my $srcfd=readfile($srcfile, 1, 1);
259 writefile($file, $config{destdir}, undef, 1, sub {
260 fast_file_copy($srcfile, $file, $srcfd, @_);
265 sub prune ($) {
266 my $file=shift;
268 unlink($file);
269 my $dir=dirname($file);
270 while (rmdir($dir)) {
271 $dir=dirname($dir);
275 sub srcdir_check () {
276 # security check, avoid following symlinks in the srcdir path by default
277 my $test=$config{srcdir};
278 while (length $test) {
279 if (-l $test && ! $config{allow_symlinks_before_srcdir}) {
280 error(sprintf(gettext("symlink found in srcdir path (%s) -- set allow_symlinks_before_srcdir to allow this"), $test));
282 unless ($test=~s/\/+$//) {
283 $test=dirname($test);
289 sub find_src_files () {
290 my @files;
291 my %pages;
292 eval q{use File::Find};
293 error($@) if $@;
295 eval q{use Cwd};
296 die $@ if $@;
297 my $origdir=getcwd();
298 my $abssrcdir=Cwd::abs_path($config{srcdir});
300 my ($page, $underlay);
301 my $helper=sub {
302 my $file=decode_utf8($_);
304 return if -l $file || -d _;
305 $file=~s/^\.\///;
306 return if ! length $file;
307 $page = pagename($file);
308 if (! exists $pagesources{$page} &&
309 file_pruned($file)) {
310 $File::Find::prune=1;
311 return;
314 my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
315 if (! defined $f) {
316 warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
317 return;
320 if ($underlay) {
321 # avoid underlaydir override attacks; see security.mdwn
322 if (! -l "$abssrcdir/$f" && ! -e _) {
323 if (! $pages{$page}) {
324 push @files, $f;
325 $pages{$page}=1;
329 else {
330 push @files, $f;
331 if ($pages{$page}) {
332 debug(sprintf(gettext("%s has multiple possible source pages"), $page));
334 $pages{$page}=1;
338 chdir($config{srcdir}) || die "chdir $config{srcdir}: $!";
339 find({
340 no_chdir => 1,
341 wanted => $helper,
342 }, '.');
343 chdir($origdir) || die "chdir $origdir: $!";
345 $underlay=1;
346 foreach (@{$config{underlaydirs}}, $config{underlaydir}) {
347 if (chdir($_)) {
348 find({
349 no_chdir => 1,
350 wanted => $helper,
351 }, '.');
352 chdir($origdir) || die "chdir: $!";
356 return \@files, \%pages;
359 sub find_new_files ($) {
360 my $files=shift;
361 my @new;
362 my @internal_new;
364 my $times_noted;
366 foreach my $file (@$files) {
367 my $page=pagename($file);
369 if ($config{rcs} && $config{gettime} &&
370 -e "$config{srcdir}/$file") {
371 if (! $times_noted) {
372 debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs}));
373 $times_noted=1;
376 eval {
377 my $ctime=rcs_getctime($file);
378 if ($ctime > 0) {
379 $pagectime{$page}=$ctime;
382 if ($@) {
383 print STDERR $@;
385 my $mtime;
386 eval {
387 $mtime=rcs_getmtime($file);
389 if ($@) {
390 print STDERR $@;
392 elsif ($mtime > 0) {
393 utime($mtime, $mtime, "$config{srcdir}/$file");
397 if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
398 # the page has changed its type
399 $forcerebuild{$page}=1;
401 $pagesources{$page}=$file;
402 if (! $pagemtime{$page}) {
403 if (isinternal($page)) {
404 push @internal_new, $file;
406 else {
407 push @new, $file;
409 $pagecase{lc $page}=$page;
410 if (! exists $pagectime{$page}) {
411 $pagectime{$page}=(srcfile_stat($file))[10];
416 return \@new, \@internal_new;
419 sub find_del_files ($) {
420 my $pages=shift;
421 my @del;
422 my @internal_del;
424 foreach my $page (keys %pagesources) {
425 if (! $pages->{$page}) {
426 if (isinternal($page)) {
427 push @internal_del, $pagesources{$page};
429 else {
430 push @del, $pagesources{$page};
432 $links{$page}=[];
433 delete $typedlinks{$page};
434 $renderedfiles{$page}=[];
435 $pagemtime{$page}=0;
439 return \@del, \@internal_del;
442 sub remove_del (@) {
443 foreach my $file (@_) {
444 my $page=pagename($file);
445 if (! isinternal($page)) {
446 debug(sprintf(gettext("removing obsolete %s"), $page));
449 foreach my $old (@{$oldrenderedfiles{$page}}) {
450 prune($config{destdir}."/".$old);
453 foreach my $source (keys %destsources) {
454 if ($destsources{$source} eq $page) {
455 delete $destsources{$source};
459 delete $pagecase{lc $page};
460 $delpagesources{$page}=$pagesources{$page};
461 delete $pagesources{$page};
465 sub find_changed ($) {
466 my $files=shift;
467 my @changed;
468 my @internal_changed;
469 foreach my $file (@$files) {
470 my $page=pagename($file);
471 my ($srcfile, @stat)=srcfile_stat($file);
472 if (! exists $pagemtime{$page} ||
473 $stat[9] > $pagemtime{$page} ||
474 $forcerebuild{$page}) {
475 $pagemtime{$page}=$stat[9];
477 if (isinternal($page)) {
478 # Preprocess internal page in scan-only mode.
479 preprocess($page, $page, readfile($srcfile), 1);
480 push @internal_changed, $file;
482 else {
483 push @changed, $file;
487 return \@changed, \@internal_changed;
490 sub calculate_old_links ($$) {
491 my ($changed, $del)=@_;
492 my %oldlink_targets;
493 foreach my $file (@$changed, @$del) {
494 my $page=pagename($file);
495 if (exists $oldlinks{$page}) {
496 foreach my $l (@{$oldlinks{$page}}) {
497 $oldlink_targets{$page}{$l}=bestlink($page, $l);
501 return \%oldlink_targets;
504 sub derender_internal ($) {
505 my $file=shift;
506 my $page=pagename($file);
507 delete $depends{$page};
508 delete $depends_simple{$page};
509 foreach my $old (@{$renderedfiles{$page}}) {
510 delete $destsources{$old};
512 $renderedfiles{$page}=[];
515 sub render_linkers ($) {
516 my $f=shift;
517 my $p=pagename($f);
518 foreach my $page (keys %{$backlinks{$p}}) {
519 my $file=$pagesources{$page};
520 render($file, sprintf(gettext("building %s, which links to %s"), $file, $p));
524 sub remove_unrendered () {
525 foreach my $src (keys %rendered) {
526 my $page=pagename($src);
527 foreach my $file (@{$oldrenderedfiles{$page}}) {
528 if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
529 debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page));
530 prune($config{destdir}."/".$file);
536 sub link_types_changed ($$) {
537 # each is of the form { type => { link => 1 } }
538 my $new = shift;
539 my $old = shift;
541 return 0 if !defined $new && !defined $old;
542 return 1 if (!defined $new && %$old) || (!defined $old && %$new);
544 while (my ($type, $links) = each %$new) {
545 foreach my $link (keys %$links) {
546 return 1 unless exists $old->{$type}{$link};
550 while (my ($type, $links) = each %$old) {
551 foreach my $link (keys %$links) {
552 return 1 unless exists $new->{$type}{$link};
556 return 0;
559 sub calculate_changed_links ($$$) {
560 my ($changed, $del, $oldlink_targets)=@_;
562 my (%backlinkchanged, %linkchangers);
564 foreach my $file (@$changed, @$del) {
565 my $page=pagename($file);
567 if (exists $links{$page}) {
568 foreach my $l (@{$links{$page}}) {
569 my $target=bestlink($page, $l);
570 if (! exists $oldlink_targets->{$page}{$l} ||
571 $target ne $oldlink_targets->{$page}{$l}) {
572 $backlinkchanged{$target}=1;
573 $linkchangers{lc($page)}=1;
575 delete $oldlink_targets->{$page}{$l};
578 if (exists $oldlink_targets->{$page} &&
579 %{$oldlink_targets->{$page}}) {
580 foreach my $target (values %{$oldlink_targets->{$page}}) {
581 $backlinkchanged{$target}=1;
583 $linkchangers{lc($page)}=1;
586 # we currently assume that changing the type of a link doesn't
587 # change backlinks
588 if (!exists $linkchangers{lc($page)}) {
589 if (link_types_changed($typedlinks{$page}, $oldtypedlinks{$page})) {
590 $linkchangers{lc($page)}=1;
595 return \%backlinkchanged, \%linkchangers;
598 sub render_dependent ($$$$$$$) {
599 my ($files, $new, $internal_new, $del, $internal_del,
600 $internal_changed, $linkchangers)=@_;
602 my @changed=(keys %rendered, @$del);
603 my @exists_changed=(@$new, @$del);
605 my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
606 my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;
608 foreach my $p ("templates/page.tmpl", keys %{$depends_simple{""}}) {
609 if ($rendered{$p} || grep { $_ eq $p } @$del) {
610 foreach my $f (@$files) {
611 next if $rendered{$f};
612 render($f, sprintf(gettext("building %s, which depends on %s"), $f, $p));
614 return 0;
618 foreach my $f (@$files) {
619 next if $rendered{$f};
620 my $p=pagename($f);
621 my $reason = undef;
623 if (exists $depends_simple{$p} && ! defined $reason) {
624 foreach my $d (keys %{$depends_simple{$p}}) {
625 if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
626 $lc_changed{$d})
628 ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_PRESENCE &&
629 $lc_exists_changed{$d})
631 ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_LINKS &&
632 $linkchangers->{$d})
634 $reason = $d;
635 last;
640 if (exists $depends{$p} && ! defined $reason) {
641 foreach my $dep (keys %{$depends{$p}}) {
642 my $sub=pagespec_translate($dep);
643 next unless defined $sub;
645 # only consider internal files
646 # if the page explicitly depends
647 # on such files
648 my $internal_dep=$dep =~ /(?:internal|comment|comment_pending)\(/;
650 my $in=sub {
651 my $list=shift;
652 my $type=shift;
653 foreach my $file (@$list) {
654 next if $file eq $f;
655 my $page=pagename($file);
656 if ($sub->($page, location => $p)) {
657 if ($type == $IkiWiki::DEPEND_LINKS) {
658 next unless $linkchangers->{lc($page)};
660 $reason=$page;
661 return 1;
664 return undef;
667 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_CONTENT) {
668 last if $in->(\@changed, $IkiWiki::DEPEND_CONTENT);
669 last if $internal_dep && (
670 $in->($internal_new, $IkiWiki::DEPEND_CONTENT) ||
671 $in->($internal_del, $IkiWiki::DEPEND_CONTENT) ||
672 $in->($internal_changed, $IkiWiki::DEPEND_CONTENT)
675 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_PRESENCE) {
676 last if $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE);
677 last if $internal_dep && (
678 $in->($internal_new, $IkiWiki::DEPEND_PRESENCE) ||
679 $in->($internal_del, $IkiWiki::DEPEND_PRESENCE)
682 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_LINKS) {
683 last if $in->(\@changed, $IkiWiki::DEPEND_LINKS);
684 last if $internal_dep && (
685 $in->($internal_new, $IkiWiki::DEPEND_LINKS) ||
686 $in->($internal_del, $IkiWiki::DEPEND_LINKS) ||
687 $in->($internal_changed, $IkiWiki::DEPEND_LINKS)
693 if (defined $reason) {
694 render($f, sprintf(gettext("building %s, which depends on %s"), $f, $reason));
695 return 1;
699 return 0;
702 sub render_backlinks ($) {
703 my $backlinkchanged=shift;
704 foreach my $link (keys %$backlinkchanged) {
705 my $linkfile=$pagesources{$link};
706 if (defined $linkfile) {
707 render($linkfile, sprintf(gettext("building %s, to update its backlinks"), $linkfile));
712 sub gen_autofile ($$$) {
713 my $autofile=shift;
714 my $pages=shift;
715 my $del=shift;
717 if (file_pruned($autofile)) {
718 return;
721 my ($file)="$config{srcdir}/$autofile" =~ /$config{wiki_file_regexp}/; # untaint
722 if (! defined $file) {
723 return;
726 # Remember autofiles that were tried, and never try them again later.
727 if (exists $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}) {
728 return;
730 $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}=1;
732 if (srcfile($autofile, 1) || file_pruned($autofile)) {
733 return;
736 if (-l $file || -d _ || -e _) {
737 return;
740 my $page = pagename($file);
741 if ($pages->{$page}) {
742 return;
745 if (grep { $_ eq $autofile } @$del) {
746 return;
749 $autofiles{$autofile}{generator}->();
750 $pages->{$page}=1;
751 return 1;
755 sub refresh () {
756 srcdir_check();
757 run_hooks(refresh => sub { shift->() });
758 my ($files, $pages)=find_src_files();
759 my ($new, $internal_new)=find_new_files($files);
760 my ($del, $internal_del)=find_del_files($pages);
761 my ($changed, $internal_changed)=find_changed($files);
762 run_hooks(needsbuild => sub {
763 my $ret=shift->($changed, [@$del, @$internal_del]);
764 $changed=$ret if ref $ret eq 'ARRAY';
766 my $oldlink_targets=calculate_old_links($changed, $del);
768 foreach my $file (@$changed) {
769 scan($file);
772 foreach my $autofile (keys %autofiles) {
773 if (gen_autofile($autofile, $pages, $del)) {
774 push @{$files}, $autofile;
775 push @{$new}, $autofile if find_new_files([$autofile]);
776 push @{$changed}, $autofile if find_changed([$autofile]);
778 scan($autofile);
782 calculate_links();
784 remove_del(@$del, @$internal_del);
786 foreach my $file (@$changed) {
787 render($file, sprintf(gettext("building %s"), $file));
789 foreach my $file (@$internal_new, @$internal_del, @$internal_changed) {
790 derender_internal($file);
793 my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
794 $del, $oldlink_targets);
796 foreach my $file (@$new, @$del) {
797 render_linkers($file);
800 if (@$changed || @$internal_changed ||
801 @$del || @$internal_del || @$internal_new) {
802 1 while render_dependent($files, $new, $internal_new,
803 $del, $internal_del, $internal_changed,
804 $linkchangers);
807 render_backlinks($backlinkchanged);
808 remove_unrendered();
810 if (@$del || @$internal_del) {
811 run_hooks(delete => sub { shift->(@$del, @$internal_del) });
813 if (%rendered) {
814 run_hooks(change => sub { shift->(keys %rendered) });
818 sub clean_rendered {
819 lockwiki();
820 loadindex();
821 remove_unrendered();
822 foreach my $page (keys %oldrenderedfiles) {
823 foreach my $file (@{$oldrenderedfiles{$page}}) {
824 prune($config{destdir}."/".$file);
829 sub commandline_render () {
830 lockwiki();
831 loadindex();
832 unlockwiki();
834 my $srcfile=possibly_foolish_untaint($config{render});
835 my $file=$srcfile;
836 $file=~s/\Q$config{srcdir}\E\/?//;
838 my $type=pagetype($file);
839 die sprintf(gettext("ikiwiki: cannot build %s"), $srcfile)."\n" unless defined $type;
840 my $content=readfile($srcfile);
841 my $page=pagename($file);
842 $pagesources{$page}=$file;
843 $content=filter($page, $page, $content);
844 $content=preprocess($page, $page, $content);
845 $content=linkify($page, $page, $content);
846 $content=htmlize($page, $page, $type, $content);
847 $pagemtime{$page}=(stat($srcfile))[9];
848 $pagectime{$page}=$pagemtime{$page} if ! exists $pagectime{$page};
850 print genpage($page, $content);
851 exit 0;