d2fa80fbb8fa5f1678627415548fa474ad11d0b0
[ikiwiki.git] / IkiWiki / Render.pm
1 #!/usr/bin/perl
2
3 package IkiWiki;
4
5 use warnings;
6 use strict;
7 use IkiWiki;
8 use Encode;
9
10 my (%backlinks, %rendered);
11 our %brokenlinks;
12 my $links_calculated=0;
13
14 sub calculate_links () {
15         return if $links_calculated;
16         %backlinks=%brokenlinks=();
17         foreach my $page (keys %links) {
18                 foreach my $link (@{$links{$page}}) {
19                         my $bestlink=bestlink($page, $link);
20                         if (length $bestlink) {
21                                 $backlinks{$bestlink}{$page}=1
22                                         if $bestlink ne $page;
23                         }
24                         else {
25                                 push @{$brokenlinks{$link}}, $page;
26                         }
27                 }
28         }
29         $links_calculated=1;
30 }
31
32 sub backlink_pages ($) {
33         my $page=shift;
34
35         calculate_links();
36
37         return keys %{$backlinks{$page}};
38 }
39
40 sub backlinks ($) {
41         my $page=shift;
42
43         my @links;
44         foreach my $p (backlink_pages($page)) {
45                 my $href=urlto($p, $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 => pagetitle($p_trimmed) };
57         }
58         return @links;
59 }
60
61 sub genpage ($$) {
62         my $page=shift;
63         my $content=shift;
64         
65         run_hooks(postscan => sub {
66                 shift->(page => $page, content => $content);
67         });
68
69         my $templatefile;
70         run_hooks(templatefile => sub {
71                 return if defined $templatefile;
72                 my $file=shift->(page => $page);
73                 if (defined $file && defined template_file($file)) {
74                         $templatefile=$file;
75                 }
76         });
77         my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1);
78         my $actions=0;
79
80         if (length $config{cgiurl}) {
81                 if (IkiWiki->can("cgi_editpage")) {
82                         $template->param(editurl => cgiurl(do => "edit", page => $page));
83                         $actions++;
84                 }
85                 if (exists $hooks{auth}) {
86                         $template->param(prefsurl => cgiurl(do => "prefs"));
87                         $actions++;
88                 }
89         }
90                 
91         if (defined $config{historyurl} && length $config{historyurl}) {
92                 my $u=$config{historyurl};
93                 $u=~s/\[\[file\]\]/$pagesources{$page}/g;
94                 $template->param(historyurl => $u);
95                 $actions++;
96         }
97         if ($config{discussion}) {
98                 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
99                    (length $config{cgiurl} ||
100                     exists $links{$page."/".$config{discussionpage}})) {
101                         $template->param(discussionlink => htmllink($page, $page, $config{discussionpage}, noimageinline => 1, forcesubpage => 1));
102                         $actions++;
103                 }
104         }
105
106         if ($actions) {
107                 $template->param(have_actions => 1);
108         }
109
110         my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
111         my ($backlinks, $more_backlinks);
112         if (@backlinks <= $config{numbacklinks} || ! $config{numbacklinks}) {
113                 $backlinks=\@backlinks;
114                 $more_backlinks=[];
115         }
116         else {
117                 $backlinks=[@backlinks[0..$config{numbacklinks}-1]];
118                 $more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]];
119         }
120
121         $template->param(
122                 title => $page eq 'index' 
123                         ? $config{wikiname} 
124                         : pagetitle(basename($page)),
125                 wikiname => $config{wikiname},
126                 content => $content,
127                 backlinks => $backlinks,
128                 more_backlinks => $more_backlinks,
129                 mtime => displaytime($pagemtime{$page}),
130                 ctime => displaytime($pagectime{$page}),
131                 baseurl => baseurl($page),
132         );
133
134         run_hooks(pagetemplate => sub {
135                 shift->(page => $page, destpage => $page, template => $template);
136         });
137         
138         $content=$template->output;
139         
140         run_hooks(format => sub {
141                 $content=shift->(
142                         page => $page,
143                         content => $content,
144                 );
145         });
146
147         return $content;
148 }
149
150 sub scan ($) {
151         my $file=shift;
152
153         debug(sprintf(gettext("scanning %s"), $file));
154
155         my $type=pagetype($file);
156         if (defined $type) {
157                 my $srcfile=srcfile($file);
158                 my $content=readfile($srcfile);
159                 my $page=pagename($file);
160                 will_render($page, htmlpage($page), 1);
161
162                 if ($config{discussion}) {
163                         # Discussion links are a special case since they're
164                         # not in the text of the page, but on its template.
165                         $links{$page}=[ $page."/".lc($config{discussionpage}) ];
166                 }
167                 else {
168                         $links{$page}=[];
169                 }
170
171                 run_hooks(scan => sub {
172                         shift->(
173                                 page => $page,
174                                 content => $content,
175                         );
176                 });
177
178                 # Preprocess in scan-only mode.
179                 preprocess($page, $page, $content, 1);
180         }
181         else {
182                 will_render($file, $file, 1);
183         }
184 }
185
186 sub fast_file_copy (@) {
187         my $srcfile=shift;
188         my $destfile=shift;
189         my $srcfd=shift;
190         my $destfd=shift;
191         my $cleanup=shift;
192
193         my $blksize = 16384;
194         my ($len, $buf, $written);
195         while ($len = sysread $srcfd, $buf, $blksize) {
196                 if (! defined $len) {
197                         next if $! =~ /^Interrupted/;
198                         error("failed to read $srcfile: $!", $cleanup);
199                 }
200                 my $offset = 0;
201                 while ($len) {
202                         defined($written = syswrite $destfd, $buf, $len, $offset)
203                                 or error("failed to write $destfile: $!", $cleanup);
204                         $len -= $written;
205                         $offset += $written;
206                 }
207         }
208 }
209
210 sub render ($$) {
211         my $file=shift;
212         return if $rendered{$file};
213         debug(shift);
214         $rendered{$file}=1;
215         
216         my $type=pagetype($file);
217         my $srcfile=srcfile($file);
218         if (defined $type) {
219                 my $page=pagename($file);
220                 delete $depends{$page};
221                 delete $depends_simple{$page};
222                 will_render($page, htmlpage($page), 1);
223                 return if $type=~/^_/;
224                 
225                 my $content=htmlize($page, $page, $type,
226                         linkify($page, $page,
227                         preprocess($page, $page,
228                         filter($page, $page,
229                         readfile($srcfile)))));
230                 
231                 my $output=htmlpage($page);
232                 writefile($output, $config{destdir}, genpage($page, $content));
233         }
234         else {
235                 delete $depends{$file};
236                 delete $depends_simple{$file};
237                 will_render($file, $file, 1);
238                 
239                 if ($config{hardlink}) {
240                         # only hardlink if owned by same user
241                         my @stat=stat($srcfile);
242                         if ($stat[4] == $>) {
243                                 prep_writefile($file, $config{destdir});
244                                 unlink($config{destdir}."/".$file);
245                                 if (link($srcfile, $config{destdir}."/".$file)) {
246                                         return;
247                                 }
248                         }
249                         # if hardlink fails, fall back to copying
250                 }
251                 
252                 my $srcfd=readfile($srcfile, 1, 1);
253                 writefile($file, $config{destdir}, undef, 1, sub {
254                         fast_file_copy($srcfile, $file, $srcfd, @_);
255                 });
256         }
257 }
258
259 sub prune ($) {
260         my $file=shift;
261
262         unlink($file);
263         my $dir=dirname($file);
264         while (rmdir($dir)) {
265                 $dir=dirname($dir);
266         }
267 }
268
269 sub srcdir_check () {
270         # security check, avoid following symlinks in the srcdir path by default
271         my $test=$config{srcdir};
272         while (length $test) {
273                 if (-l $test && ! $config{allow_symlinks_before_srcdir}) {
274                         error(sprintf(gettext("symlink found in srcdir path (%s) -- set allow_symlinks_before_srcdir to allow this"), $test));
275                 }
276                 unless ($test=~s/\/+$//) {
277                         $test=dirname($test);
278                 }
279         }
280         
281 }
282
283 sub verify_src_file ($$) {
284         my $file=decode_utf8(shift);
285         my $dir=shift;
286
287         return if -l $file || -d $file;
288         $file=~s/^\Q$dir\E\/?//;
289         return if ! length $file;
290         my $page = pagename($file);
291         if (! exists $pagesources{$page} &&
292                 file_pruned($file)) {
293                 $File::Find::prune=1;
294                 return;
295         }
296
297         my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
298         if (! defined $f) {
299                 warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
300         }
301         return ($file,$page,$f);
302 }
303
304 sub find_src_files () {
305         my @files;
306         my %pages;
307         eval q{use File::Find};
308         error($@) if $@;
309         find({
310                 no_chdir => 1,
311                 wanted => sub {
312                         my ($file,$page,$f) = verify_src_file($_,$config{srcdir});
313                         if ($file) {
314                                 push @files, $file;
315                                 if ($pages{$page}) {
316                                         debug(sprintf(gettext("%s has multiple possible source pages"), $page));
317                                 }
318                                 $pages{$page}=1;
319                         }
320                 },
321         }, $config{srcdir});
322         foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
323                 find({
324                         no_chdir => 1,
325                         wanted => sub {
326                                 my ($file,$page,$f) = verify_src_file($_,$dir);
327                                 if ($f) {
328                                         # avoid underlaydir override
329                                         # attacks; see security.mdwn
330                                         if (! -l "$config{srcdir}/$f" &&
331                                             ! -e _) {
332                                                 if (! $pages{$page}) {
333                                                         push @files, $f;
334                                                         $pages{$page}=1;
335                                                 }
336                                         }
337                                 }
338                         },
339                 }, $dir);
340         };
341         return \@files, \%pages;
342 }
343
344 sub find_new_files ($) {
345         my $files=shift;
346         my @new;
347         my @internal_new;
348
349         foreach my $file (@$files) {
350                 my $page=pagename($file);
351                 if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
352                         # the page has changed its type
353                         $forcerebuild{$page}=1;
354                 }
355                 $pagesources{$page}=$file;
356                 if (! $pagemtime{$page}) {
357                         if (isinternal($page)) {
358                                 push @internal_new, $file;
359                         }
360                         else {
361                                 push @new, $file;
362                                 if ($config{getctime} && -e "$config{srcdir}/$file") {
363                                         eval {
364                                                 my $time=rcs_getctime("$config{srcdir}/$file");
365                                                 $pagectime{$page}=$time;
366                                         };
367                                         if ($@) {
368                                                 print STDERR $@;
369                                         }
370                                 }
371                         }
372                         $pagecase{lc $page}=$page;
373                         if (! exists $pagectime{$page}) {
374                                 $pagectime{$page}=(srcfile_stat($file))[10];
375                         }
376                 }
377         }
378
379         return \@new, \@internal_new;
380 }
381
382 sub find_del_files ($) {
383         my $pages=shift;
384         my @del;
385         my @internal_del;
386
387         foreach my $page (keys %pagemtime) {
388                 if (! $pages->{$page}) {
389                         if (isinternal($page)) {
390                                 push @internal_del, $pagesources{$page};
391                         }
392                         else {
393                                 push @del, $pagesources{$page};
394                         }
395                         $dellinks{$page}= $links{$page};
396                         $links{$page}=[];
397                         $delrenderedfiles{$page}= $renderedfiles{$page};
398                         $renderedfiles{$page}=[];
399                         $pagemtime{$page}=0;
400                 }
401         }
402
403         return \@del, \@internal_del;
404 }
405
406 sub remove_del (@) {
407         foreach my $file (@_) {
408                 my $page=pagename($file);
409                 if (! isinternal($page)) {
410                         debug(sprintf(gettext("removing old page %s"), $page));
411                 }
412         
413                 foreach my $old (@{$oldrenderedfiles{$page}}) {
414                         prune($config{destdir}."/".$old);
415                 }
416
417                 foreach my $source (keys %destsources) {
418                         if ($destsources{$source} eq $page) {
419                                 delete $destsources{$source};
420                         }
421                 }
422         
423                 delete $pagecase{lc $page};
424                 delete $pagesources{$page};
425         }
426 }
427
428 sub find_changed ($) {
429         my $files=shift;
430         my @changed;
431         my @internal_changed;
432         foreach my $file (@$files) {
433                 my $page=pagename($file);
434                 my ($srcfile, @stat)=srcfile_stat($file);
435                 if (! exists $pagemtime{$page} ||
436                     $stat[9] > $pagemtime{$page} ||
437                     $forcerebuild{$page}) {
438                         $pagemtime{$page}=$stat[9];
439
440                         if (isinternal($page)) {
441                                 # Preprocess internal page in scan-only mode.
442                                 preprocess($page, $page, readfile($srcfile), 1);
443                                 push @internal_changed, $file;
444                         }
445                         else {
446                                 push @changed, $file;
447                         }
448                 }
449         }
450         return \@changed, \@internal_changed;
451 }
452
453 sub calculate_old_links ($$) {
454         my ($changed, $del)=@_;
455         my %oldlink_targets;
456         foreach my $file (@$changed, @$del) {
457                 my $page=pagename($file);
458                 if (exists $oldlinks{$page}) {
459                         foreach my $l (@{$oldlinks{$page}}) {
460                                 $oldlink_targets{$page}{$l}=bestlink($page, $l);
461                         }
462                 }
463         }
464         return \%oldlink_targets;
465 }
466
467 sub derender_internal ($) {
468         my $file=shift;
469         my $page=pagename($file);
470         delete $depends{$page};
471         delete $depends_simple{$page};
472         foreach my $old (@{$renderedfiles{$page}}) {
473                 delete $destsources{$old};
474         }
475         $renderedfiles{$page}=[];
476 }
477
478 sub render_linkers ($) {
479         my $f=shift;
480         my $p=pagename($f);
481         foreach my $page (keys %{$backlinks{$p}}) {
482                 my $file=$pagesources{$page};
483                 render($file, sprintf(gettext("building %s, which links to %s"), $file, $p));
484         }
485 }
486
487 sub remove_unrendered () {
488         foreach my $src (keys %rendered) {
489                 my $page=pagename($src);
490                 foreach my $file (@{$oldrenderedfiles{$page}}) {
491                         if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
492                                 debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page));
493                                 prune($config{destdir}."/".$file);
494                         }
495                 }
496         }
497 }
498
499 sub calculate_changed_links ($$$) {
500         my ($changed, $del, $oldlink_targets)=@_;
501
502         my (%backlinkchanged, %linkchangers);
503
504         foreach my $file (@$changed, @$del) {
505                 my $page=pagename($file);
506
507                 if (exists $links{$page}) {
508                         foreach my $l (@{$links{$page}}) {
509                                 my $target=bestlink($page, $l);
510                                 if (! exists $oldlink_targets->{$page}{$l} ||
511                                     $target ne $oldlink_targets->{$page}{$l}) {
512                                         $backlinkchanged{$target}=1;
513                                         $linkchangers{lc($page)}=1;
514                                 }
515                                 delete $oldlink_targets->{$page}{$l};
516                         }
517                 }
518                 if (exists $oldlink_targets->{$page} &&
519                     %{$oldlink_targets->{$page}}) {
520                         foreach my $target (values %{$oldlink_targets->{$page}}) {
521                                 $backlinkchanged{$target}=1;
522                         }
523                         $linkchangers{lc($page)}=1;
524                 }
525         }
526
527         return \%backlinkchanged, \%linkchangers;
528 }
529
530 sub render_dependent ($$$$$$$) {
531         my ($files, $new, $internal_new, $del, $internal_del,
532                 $internal_changed, $linkchangers)=@_;
533
534         my @changed=(keys %rendered, @$del);
535         my @exists_changed=(@$new, @$del);
536         
537         my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
538         my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;
539          
540         foreach my $f (@$files) {
541                 next if $rendered{$f};
542                 my $p=pagename($f);
543                 my $reason = undef;
544         
545                 if (exists $depends_simple{$p}) {
546                         foreach my $d (keys %{$depends_simple{$p}}) {
547                                 if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
548                                      $lc_changed{$d})
549                                     ||
550                                     ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_PRESENCE &&
551                                      $lc_exists_changed{$d})
552                                     ||
553                                     ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_LINKS &&
554                                      $linkchangers->{$d})
555                                 ) {
556                                         $reason = $d;
557                                         last;
558                                 }
559                         }
560                 }
561         
562                 if (exists $depends{$p} && ! defined $reason) {
563                         foreach my $dep (keys %{$depends{$p}}) {
564                                 my $sub=pagespec_translate($dep);
565                                 next if $@ || ! defined $sub;
566
567                                 # only consider internal files
568                                 # if the page explicitly depends
569                                 # on such files
570                                 my $internal_dep=$dep =~ /internal\(/;
571
572                                 my $in=sub {
573                                         my $list=shift;
574                                         my $type=shift;
575                                         foreach my $file (@$list) {
576                                                 next if $file eq $f;
577                                                 my $page=pagename($file);
578                                                 if ($sub->($page, location => $p)) {
579                                                         if ($type == $IkiWiki::DEPEND_LINKS) {
580                                                                 next unless $linkchangers->{lc($page)};
581                                                         }
582                                                         return $page;
583                                                 }
584                                         }
585                                         return undef;
586                                 };
587
588                                 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_CONTENT) {
589                                         last if $reason =
590                                                 $in->(\@changed, $IkiWiki::DEPEND_CONTENT);
591                                         last if $internal_dep && ($reason =
592                                                 $in->($internal_new, $IkiWiki::DEPEND_CONTENT) ||
593                                                 $in->($internal_del, $IkiWiki::DEPEND_CONTENT) ||
594                                                 $in->($internal_changed, $IkiWiki::DEPEND_CONTENT));
595                                 }
596                                 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_PRESENCE) {
597                                         last if $reason = 
598                                                 $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE);
599                                         last if $internal_dep && ($reason =
600                                                 $in->($internal_new, $IkiWiki::DEPEND_PRESENCE) ||
601                                                 $in->($internal_del, $IkiWiki::DEPEND_PRESENCE));
602                                 }
603                                 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_LINKS) {
604                                         last if $reason =
605                                                 $in->(\@changed, $IkiWiki::DEPEND_LINKS);
606                                         last if $internal_dep && ($reason =
607                                                 $in->($internal_new, $IkiWiki::DEPEND_LINKS) ||
608                                                 $in->($internal_del, $IkiWiki::DEPEND_LINKS) ||
609                                                 $in->($internal_changed, $IkiWiki::DEPEND_LINKS));
610                                 }
611                         }
612                 }
613         
614                 if (defined $reason) {
615                         render($f, sprintf(gettext("building %s, which depends on %s"), $f, $reason));
616                         return 1;
617                 }
618         }
619
620         return 0;
621 }
622
623 sub render_backlinks ($) {
624         my $backlinkchanged=shift;
625         foreach my $link (keys %$backlinkchanged) {
626                 my $linkfile=$pagesources{$link};
627                 if (defined $linkfile) {
628                         render($linkfile, sprintf(gettext("building %s, to update its backlinks"), $linkfile));
629                 }
630         }
631 }
632
633 sub refresh () {
634         srcdir_check();
635         run_hooks(refresh => sub { shift->() });
636         my ($files, $pages)=find_src_files();
637         my ($new, $internal_new)=find_new_files($files);
638         my ($del, $internal_del)=find_del_files($pages);
639         my ($changed, $internal_changed)=find_changed($files);
640         run_hooks(needsbuild => sub { shift->($changed) });
641         my $oldlink_targets=calculate_old_links($changed, $del);
642
643         foreach my $file (@$changed) {
644                 scan($file);
645         }
646
647         my %del_hash = map {$_, 1} @$del;
648         while (my $autofile = shift (@autofiles)) {
649                 my $page=pagename($autofile);
650     if (exists $del_hash{$page}) {
651                         $links{$page}= $dellinks{$page};
652                         $renderedfiles{$page}= $delrenderedfiles{$page};
653                         delete $del_hash{$page};
654                 }
655                 if ($pages->{$page}) {
656                         debug(sprintf(gettext("%s has multiple possible source pages"), $page));
657                 }
658                 $pages->{$page}=1;
659
660                 push @{$files}, $autofile;
661                 push @{$new}, $autofile if find_new_files([$autofile]);
662                 push @{$changed}, $autofile if find_changed([$autofile]);
663
664                 scan($autofile);
665         }
666         $del = [keys %del_hash];
667
668         calculate_links();
669         
670         remove_del(@$del, @$internal_del);
671
672         foreach my $file (@$changed) {
673                 render($file, sprintf(gettext("building %s"), $file));
674         }
675         foreach my $file (@$internal_new, @$internal_del, @$internal_changed) {
676                 derender_internal($file);
677         }
678
679         my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
680                 $del, $oldlink_targets);
681
682         foreach my $file (@$new, @$del) {
683                 render_linkers($file);
684         }
685         
686         if (@$changed || @$internal_changed ||
687             @$del || @$internal_del || @$internal_new) {
688                 1 while render_dependent($files, $new, $internal_new,
689                         $del, $internal_del, $internal_changed,
690                         $linkchangers);
691         }
692
693         render_backlinks($backlinkchanged);
694         remove_unrendered();
695
696         if (@$del) {
697                 run_hooks(delete => sub { shift->(@$del) });
698         }
699         if (%rendered) {
700                 run_hooks(change => sub { shift->(keys %rendered) });
701         }
702 }
703
704 sub commandline_render () {
705         lockwiki();
706         loadindex();
707         unlockwiki();
708
709         my $srcfile=possibly_foolish_untaint($config{render});
710         my $file=$srcfile;
711         $file=~s/\Q$config{srcdir}\E\/?//;
712
713         my $type=pagetype($file);
714         die sprintf(gettext("ikiwiki: cannot build %s"), $srcfile)."\n" unless defined $type;
715         my $content=readfile($srcfile);
716         my $page=pagename($file);
717         $pagesources{$page}=$file;
718         $content=filter($page, $page, $content);
719         $content=preprocess($page, $page, $content);
720         $content=linkify($page, $page, $content);
721         $content=htmlize($page, $page, $type, $content);
722         $pagemtime{$page}=(stat($srcfile))[9];
723         $pagectime{$page}=$pagemtime{$page} if ! exists $pagectime{$page};
724
725         print genpage($page, $content);
726         exit 0;
727 }
728
729 1