10 my (%backlinks, %rendered);
12 my $links_calculated=0;
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;
25 push @{$brokenlinks{$link}}, $page;
32 sub backlink_pages ($) {
37 return keys %{$backlinks{$page}};
44 foreach my $p (backlink_pages($page)) {
45 my $href=urlto($p, $page);
47 # Trim common dir prefixes from both pages.
49 my $page_trimmed=$page;
51 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
53 $p_trimmed=~s/^\Q$dir\E// &&
54 $page_trimmed=~s/^\Q$dir\E//;
56 push @links, { url => $href, page => pagetitle($p_trimmed) };
65 run_hooks(postscan => sub {
66 shift->(page => $page, content => $content);
70 run_hooks(templatefile => sub {
71 return if defined $templatefile;
72 my $file=shift->(page => $page);
73 if (defined $file && defined template_file($file)) {
78 if (defined $templatefile) {
79 $template=template_depends($templatefile, $page,
83 # no explicit depends as special case
84 $template=template('page.tmpl',
89 if (length $config{cgiurl}) {
90 if (IkiWiki->can("cgi_editpage")) {
91 $template->param(editurl => cgiurl(do => "edit", page => $page));
94 if (exists $hooks{auth}) {
95 $template->param(prefsurl => cgiurl(do => "prefs"));
100 if (defined $config{historyurl} && length $config{historyurl}) {
101 my $u=$config{historyurl};
102 $u=~s/\[\[file\]\]/$pagesources{$page}/g;
103 $template->param(historyurl => $u);
106 if ($config{discussion}) {
107 if ($page !~ /.*\/\Q$config{discussionpage}\E$/i &&
108 (length $config{cgiurl} ||
109 exists $links{$page."/".$config{discussionpage}})) {
110 $template->param(discussionlink => htmllink($page, $page, $config{discussionpage}, noimageinline => 1, forcesubpage => 1));
116 run_hooks(pageactions => sub {
117 push @actions, map { { action => $_ } }
118 grep { defined } shift->(page => $page);
120 $template->param(actions => \@actions);
122 if ($actions || @actions) {
123 $template->param(have_actions => 1);
126 my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
127 my ($backlinks, $more_backlinks);
128 if (@backlinks <= $config{numbacklinks} || ! $config{numbacklinks}) {
129 $backlinks=\@backlinks;
133 $backlinks=[@backlinks[0..$config{numbacklinks}-1]];
134 $more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]];
138 title => $page eq 'index'
140 : pagetitle(basename($page)),
142 wikiname => $config{wikiname},
144 backlinks => $backlinks,
145 more_backlinks => $more_backlinks,
146 mtime => displaytime($pagemtime{$page}),
147 ctime => displaytime($pagectime{$page}, undef, 1),
148 baseurl => baseurl($page),
149 html5 => $config{html5},
152 run_hooks(pagetemplate => sub {
153 shift->(page => $page, destpage => $page, template => $template);
156 $content=$template->output;
158 run_hooks(format => sub {
171 debug(sprintf(gettext("scanning %s"), $file));
173 my $type=pagetype($file);
175 my $srcfile=srcfile($file);
176 my $content=readfile($srcfile);
177 my $page=pagename($file);
178 will_render($page, htmlpage($page), 1);
180 if ($config{discussion}) {
181 # Discussion links are a special case since they're
182 # not in the text of the page, but on its template.
183 $links{$page}=[ $page."/".lc($config{discussionpage}) ];
188 delete $typedlinks{$page};
190 run_hooks(scan => sub {
197 # Preprocess in scan-only mode.
198 preprocess($page, $page, $content, 1);
201 will_render($file, $file, 1);
205 sub fast_file_copy (@) {
213 my ($len, $buf, $written);
214 while ($len = sysread $srcfd, $buf, $blksize) {
215 if (! defined $len) {
216 next if $! =~ /^Interrupted/;
217 error("failed to read $srcfile: $!", $cleanup);
221 defined($written = syswrite $destfd, $buf, $len, $offset)
222 or error("failed to write $destfile: $!", $cleanup);
231 return if $rendered{$file};
235 my $type=pagetype($file);
236 my $srcfile=srcfile($file);
238 my $page=pagename($file);
239 delete $depends{$page};
240 delete $depends_simple{$page};
241 will_render($page, htmlpage($page), 1);
242 return if $type=~/^_/;
244 my $content=htmlize($page, $page, $type,
245 linkify($page, $page,
246 preprocess($page, $page,
248 readfile($srcfile)))));
250 my $output=htmlpage($page);
251 writefile($output, $config{destdir}, genpage($page, $content));
254 delete $depends{$file};
255 delete $depends_simple{$file};
256 will_render($file, $file, 1);
258 if ($config{hardlink}) {
259 # only hardlink if owned by same user
260 my @stat=stat($srcfile);
261 if ($stat[4] == $>) {
262 prep_writefile($file, $config{destdir});
263 unlink($config{destdir}."/".$file);
264 if (link($srcfile, $config{destdir}."/".$file)) {
268 # if hardlink fails, fall back to copying
271 my $srcfd=readfile($srcfile, 1, 1);
272 writefile($file, $config{destdir}, undef, 1, sub {
273 fast_file_copy($srcfile, $file, $srcfd, @_);
282 my $dir=dirname($file);
283 while (rmdir($dir)) {
288 sub srcdir_check () {
289 # security check, avoid following symlinks in the srcdir path by default
290 my $test=$config{srcdir};
291 while (length $test) {
292 if (-l $test && ! $config{allow_symlinks_before_srcdir}) {
293 error(sprintf(gettext("symlink found in srcdir path (%s) -- set allow_symlinks_before_srcdir to allow this"), $test));
295 unless ($test=~s/\/+$//) {
296 $test=dirname($test);
302 sub find_src_files () {
305 eval q{use File::Find};
308 my ($page, $dir, $underlay);
310 my $file=decode_utf8($_);
312 return if -l $file || -d _;
313 $file=~s/^\Q$dir\E\/?//;
314 return if ! length $file;
315 $page = pagename($file);
316 if (! exists $pagesources{$page} &&
317 file_pruned($file)) {
318 $File::Find::prune=1;
322 my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
324 warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
329 # avoid underlaydir override attacks; see security.mdwn
330 if (! -l "$config{srcdir}/$f" && ! -e _) {
331 if (! $pages{$page}) {
340 debug(sprintf(gettext("%s has multiple possible source pages"), $page));
349 }, $dir=$config{srcdir});
351 foreach (@{$config{underlaydirs}}, $config{underlaydir}) {
357 return \@files, \%pages;
360 sub find_new_files ($) {
367 foreach my $file (@$files) {
368 my $page=pagename($file);
369 if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
370 # the page has changed its type
371 $forcerebuild{$page}=1;
373 $pagesources{$page}=$file;
374 if (! $pagemtime{$page}) {
375 if (isinternal($page)) {
376 push @internal_new, $file;
378 elsif ($config{rcs}) {
380 if ($config{gettime} && -e "$config{srcdir}/$file") {
381 if (! $times_noted) {
382 debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs}));
387 my $ctime=rcs_getctime("$config{srcdir}/$file");
389 $pagectime{$page}=$ctime;
397 $mtime=rcs_getmtime("$config{srcdir}/$file");
403 utime($mtime, $mtime, "$config{srcdir}/$file");
407 $pagecase{lc $page}=$page;
408 if (! exists $pagectime{$page}) {
409 $pagectime{$page}=(srcfile_stat($file))[10];
414 return \@new, \@internal_new;
417 sub find_del_files ($) {
422 foreach my $page (keys %pagesources) {
423 if (! $pages->{$page}) {
424 if (isinternal($page)) {
425 push @internal_del, $pagesources{$page};
428 push @del, $pagesources{$page};
431 delete $typedlinks{$page};
432 $renderedfiles{$page}=[];
437 return \@del, \@internal_del;
441 foreach my $file (@_) {
442 my $page=pagename($file);
443 if (! isinternal($page)) {
444 debug(sprintf(gettext("removing obsolete %s"), $page));
447 foreach my $old (@{$oldrenderedfiles{$page}}) {
448 prune($config{destdir}."/".$old);
451 foreach my $source (keys %destsources) {
452 if ($destsources{$source} eq $page) {
453 delete $destsources{$source};
457 delete $pagecase{lc $page};
458 delete $pagesources{$page};
462 sub find_changed ($) {
465 my @internal_changed;
466 foreach my $file (@$files) {
467 my $page=pagename($file);
468 my ($srcfile, @stat)=srcfile_stat($file);
469 if (! exists $pagemtime{$page} ||
470 $stat[9] > $pagemtime{$page} ||
471 $forcerebuild{$page}) {
472 $pagemtime{$page}=$stat[9];
474 if (isinternal($page)) {
475 # Preprocess internal page in scan-only mode.
476 preprocess($page, $page, readfile($srcfile), 1);
477 push @internal_changed, $file;
480 push @changed, $file;
484 return \@changed, \@internal_changed;
487 sub calculate_old_links ($$) {
488 my ($changed, $del)=@_;
490 foreach my $file (@$changed, @$del) {
491 my $page=pagename($file);
492 if (exists $oldlinks{$page}) {
493 foreach my $l (@{$oldlinks{$page}}) {
494 $oldlink_targets{$page}{$l}=bestlink($page, $l);
498 return \%oldlink_targets;
501 sub derender_internal ($) {
503 my $page=pagename($file);
504 delete $depends{$page};
505 delete $depends_simple{$page};
506 foreach my $old (@{$renderedfiles{$page}}) {
507 delete $destsources{$old};
509 $renderedfiles{$page}=[];
512 sub render_linkers ($) {
515 foreach my $page (keys %{$backlinks{$p}}) {
516 my $file=$pagesources{$page};
517 render($file, sprintf(gettext("building %s, which links to %s"), $file, $p));
521 sub remove_unrendered () {
522 foreach my $src (keys %rendered) {
523 my $page=pagename($src);
524 foreach my $file (@{$oldrenderedfiles{$page}}) {
525 if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
526 debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page));
527 prune($config{destdir}."/".$file);
533 sub link_types_changed ($$) {
534 # each is of the form { type => { link => 1 } }
538 return 0 if !defined $new && !defined $old;
539 return 1 if (!defined $new && %$old) || (!defined $old && %$new);
541 while (my ($type, $links) = each %$new) {
542 foreach my $link (keys %$links) {
543 return 1 unless exists $old->{$type}{$link};
547 while (my ($type, $links) = each %$old) {
548 foreach my $link (keys %$links) {
549 return 1 unless exists $new->{$type}{$link};
556 sub calculate_changed_links ($$$) {
557 my ($changed, $del, $oldlink_targets)=@_;
559 my (%backlinkchanged, %linkchangers);
561 foreach my $file (@$changed, @$del) {
562 my $page=pagename($file);
564 if (exists $links{$page}) {
565 foreach my $l (@{$links{$page}}) {
566 my $target=bestlink($page, $l);
567 if (! exists $oldlink_targets->{$page}{$l} ||
568 $target ne $oldlink_targets->{$page}{$l}) {
569 $backlinkchanged{$target}=1;
570 $linkchangers{lc($page)}=1;
572 delete $oldlink_targets->{$page}{$l};
575 if (exists $oldlink_targets->{$page} &&
576 %{$oldlink_targets->{$page}}) {
577 foreach my $target (values %{$oldlink_targets->{$page}}) {
578 $backlinkchanged{$target}=1;
580 $linkchangers{lc($page)}=1;
583 # we currently assume that changing the type of a link doesn't
585 if (!exists $linkchangers{lc($page)}) {
586 if (link_types_changed($typedlinks{$page}, $oldtypedlinks{$page})) {
587 $linkchangers{lc($page)}=1;
592 return \%backlinkchanged, \%linkchangers;
595 sub render_dependent ($$$$$$$) {
596 my ($files, $new, $internal_new, $del, $internal_del,
597 $internal_changed, $linkchangers)=@_;
599 my @changed=(keys %rendered, @$del);
600 my @exists_changed=(@$new, @$del);
602 my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
603 my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;
605 foreach my $p ("templates/page.tmpl", keys %{$depends_simple{""}}) {
606 if ($rendered{$p} || grep { $_ eq $p } @$del) {
607 foreach my $f (@$files) {
608 next if $rendered{$f};
609 render($f, sprintf(gettext("building %s, which depends on %s"), $f, $p));
615 foreach my $f (@$files) {
616 next if $rendered{$f};
620 if (exists $depends_simple{$p} && ! defined $reason) {
621 foreach my $d (keys %{$depends_simple{$p}}) {
622 if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
625 ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_PRESENCE &&
626 $lc_exists_changed{$d})
628 ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_LINKS &&
637 if (exists $depends{$p} && ! defined $reason) {
638 foreach my $dep (keys %{$depends{$p}}) {
639 my $sub=pagespec_translate($dep);
640 next unless defined $sub;
642 # only consider internal files
643 # if the page explicitly depends
645 my $internal_dep=$dep =~ /internal\(/;
650 foreach my $file (@$list) {
652 my $page=pagename($file);
653 if ($sub->($page, location => $p)) {
654 if ($type == $IkiWiki::DEPEND_LINKS) {
655 next unless $linkchangers->{lc($page)};
664 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_CONTENT) {
665 last if $in->(\@changed, $IkiWiki::DEPEND_CONTENT);
666 last if $internal_dep && (
667 $in->($internal_new, $IkiWiki::DEPEND_CONTENT) ||
668 $in->($internal_del, $IkiWiki::DEPEND_CONTENT) ||
669 $in->($internal_changed, $IkiWiki::DEPEND_CONTENT)
672 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_PRESENCE) {
673 last if $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE);
674 last if $internal_dep && (
675 $in->($internal_new, $IkiWiki::DEPEND_PRESENCE) ||
676 $in->($internal_del, $IkiWiki::DEPEND_PRESENCE)
679 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_LINKS) {
680 last if $in->(\@changed, $IkiWiki::DEPEND_LINKS);
681 last if $internal_dep && (
682 $in->($internal_new, $IkiWiki::DEPEND_LINKS) ||
683 $in->($internal_del, $IkiWiki::DEPEND_LINKS) ||
684 $in->($internal_changed, $IkiWiki::DEPEND_LINKS)
690 if (defined $reason) {
691 render($f, sprintf(gettext("building %s, which depends on %s"), $f, $reason));
699 sub render_backlinks ($) {
700 my $backlinkchanged=shift;
701 foreach my $link (keys %$backlinkchanged) {
702 my $linkfile=$pagesources{$link};
703 if (defined $linkfile) {
704 render($linkfile, sprintf(gettext("building %s, to update its backlinks"), $linkfile));
709 sub gen_autofile ($$$) {
714 if (file_pruned($autofile)) {
718 my ($file)="$config{srcdir}/$autofile" =~ /$config{wiki_file_regexp}/; # untaint
719 if (! defined $file) {
723 # Remember autofiles that were tried, and never try them again later.
724 if (exists $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}) {
727 $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}=1;
729 if (srcfile($autofile, 1) || file_pruned($autofile)) {
733 if (-l $file || -d _ || -e _) {
737 my $page = pagename($file);
738 if ($pages->{$page}) {
742 if (grep { $_ eq $autofile } @$del) {
746 $autofiles{$autofile}{generator}->();
754 run_hooks(refresh => sub { shift->() });
755 my ($files, $pages)=find_src_files();
756 my ($new, $internal_new)=find_new_files($files);
757 my ($del, $internal_del)=find_del_files($pages);
758 my ($changed, $internal_changed)=find_changed($files);
759 run_hooks(needsbuild => sub { shift->($changed) });
760 my $oldlink_targets=calculate_old_links($changed, $del);
762 foreach my $file (@$changed) {
766 foreach my $autofile (keys %autofiles) {
767 if (gen_autofile($autofile, $pages, $del)) {
768 push @{$files}, $autofile;
769 push @{$new}, $autofile if find_new_files([$autofile]);
770 push @{$changed}, $autofile if find_changed([$autofile]);
778 remove_del(@$del, @$internal_del);
780 foreach my $file (@$changed) {
781 render($file, sprintf(gettext("building %s"), $file));
783 foreach my $file (@$internal_new, @$internal_del, @$internal_changed) {
784 derender_internal($file);
787 my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
788 $del, $oldlink_targets);
790 foreach my $file (@$new, @$del) {
791 render_linkers($file);
794 if (@$changed || @$internal_changed ||
795 @$del || @$internal_del || @$internal_new) {
796 1 while render_dependent($files, $new, $internal_new,
797 $del, $internal_del, $internal_changed,
801 render_backlinks($backlinkchanged);
805 run_hooks(delete => sub { shift->(@$del) });
808 run_hooks(change => sub { shift->(keys %rendered) });
816 foreach my $page (keys %oldrenderedfiles) {
817 foreach my $file (@{$oldrenderedfiles{$page}}) {
818 prune($config{destdir}."/".$file);
823 sub commandline_render () {
828 my $srcfile=possibly_foolish_untaint($config{render});
830 $file=~s/\Q$config{srcdir}\E\/?//;
832 my $type=pagetype($file);
833 die sprintf(gettext("ikiwiki: cannot build %s"), $srcfile)."\n" unless defined $type;
834 my $content=readfile($srcfile);
835 my $page=pagename($file);
836 $pagesources{$page}=$file;
837 $content=filter($page, $page, $content);
838 $content=preprocess($page, $page, $content);
839 $content=linkify($page, $page, $content);
840 $content=htmlize($page, $page, $type, $content);
841 $pagemtime{$page}=(stat($srcfile))[9];
842 $pagectime{$page}=$pagemtime{$page} if ! exists $pagectime{$page};
844 print genpage($page, $content);