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)) {
77 my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1);
80 if (length $config{cgiurl}) {
81 if (IkiWiki->can("cgi_editpage")) {
82 $template->param(editurl => cgiurl(do => "edit", page => $page));
85 if (exists $hooks{auth}) {
86 $template->param(prefsurl => cgiurl(do => "prefs"));
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);
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));
107 $template->param(have_actions => 1);
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;
117 $backlinks=[@backlinks[0..$config{numbacklinks}-1]];
118 $more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]];
122 title => $page eq 'index'
124 : pagetitle(basename($page)),
125 wikiname => $config{wikiname},
127 backlinks => $backlinks,
128 more_backlinks => $more_backlinks,
129 mtime => displaytime($pagemtime{$page}),
130 ctime => displaytime($pagectime{$page}),
131 baseurl => baseurl($page),
134 run_hooks(pagetemplate => sub {
135 shift->(page => $page, destpage => $page, template => $template);
138 $content=$template->output;
140 run_hooks(format => sub {
153 debug(sprintf(gettext("scanning %s"), $file));
155 my $type=pagetype($file);
157 my $srcfile=srcfile($file);
158 my $content=readfile($srcfile);
159 my $page=pagename($file);
160 will_render($page, htmlpage($page), 1);
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}) ];
170 delete $typedlinks{$page};
172 run_hooks(scan => sub {
179 # Preprocess in scan-only mode.
180 preprocess($page, $page, $content, 1);
183 will_render($file, $file, 1);
187 sub fast_file_copy (@) {
195 my ($len, $buf, $written);
196 while ($len = sysread $srcfd, $buf, $blksize) {
197 if (! defined $len) {
198 next if $! =~ /^Interrupted/;
199 error("failed to read $srcfile: $!", $cleanup);
203 defined($written = syswrite $destfd, $buf, $len, $offset)
204 or error("failed to write $destfile: $!", $cleanup);
213 return if $rendered{$file};
217 my $type=pagetype($file);
218 my $srcfile=srcfile($file);
220 my $page=pagename($file);
221 delete $depends{$page};
222 delete $depends_simple{$page};
223 will_render($page, htmlpage($page), 1);
224 return if $type=~/^_/;
226 my $content=htmlize($page, $page, $type,
227 linkify($page, $page,
228 preprocess($page, $page,
230 readfile($srcfile)))));
232 my $output=htmlpage($page);
233 writefile($output, $config{destdir}, genpage($page, $content));
236 delete $depends{$file};
237 delete $depends_simple{$file};
238 will_render($file, $file, 1);
240 if ($config{hardlink}) {
241 # only hardlink if owned by same user
242 my @stat=stat($srcfile);
243 if ($stat[4] == $>) {
244 prep_writefile($file, $config{destdir});
245 unlink($config{destdir}."/".$file);
246 if (link($srcfile, $config{destdir}."/".$file)) {
250 # if hardlink fails, fall back to copying
253 my $srcfd=readfile($srcfile, 1, 1);
254 writefile($file, $config{destdir}, undef, 1, sub {
255 fast_file_copy($srcfile, $file, $srcfd, @_);
264 my $dir=dirname($file);
265 while (rmdir($dir)) {
270 sub srcdir_check () {
271 # security check, avoid following symlinks in the srcdir path by default
272 my $test=$config{srcdir};
273 while (length $test) {
274 if (-l $test && ! $config{allow_symlinks_before_srcdir}) {
275 error(sprintf(gettext("symlink found in srcdir path (%s) -- set allow_symlinks_before_srcdir to allow this"), $test));
277 unless ($test=~s/\/+$//) {
278 $test=dirname($test);
284 sub find_src_files () {
287 eval q{use File::Find};
290 my ($page, $dir, $underlay);
292 my $file=decode_utf8($_);
294 return if -l $file || -d _;
295 $file=~s/^\Q$dir\E\/?//;
296 return if ! length $file;
297 $page = pagename($file);
298 if (! exists $pagesources{$page} &&
299 file_pruned($file)) {
300 $File::Find::prune=1;
304 my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
306 warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
310 # avoid underlaydir override attacks; see security.mdwn
311 if (! -l "$config{srcdir}/$f" && ! -e _) {
312 if (! $pages{$page}) {
321 debug(sprintf(gettext("%s has multiple possible source pages"), $page));
330 }, $dir=$config{srcdir});
332 foreach (@{$config{underlaydirs}}, $config{underlaydir}) {
338 return \@files, \%pages;
341 sub find_new_files ($) {
348 foreach my $file (@$files) {
349 my $page=pagename($file);
350 if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
351 # the page has changed its type
352 $forcerebuild{$page}=1;
354 $pagesources{$page}=$file;
355 if (! $pagemtime{$page}) {
356 if (isinternal($page)) {
357 push @internal_new, $file;
359 elsif ($config{rcs}) {
361 if ($config{gettime} && -e "$config{srcdir}/$file") {
362 if (! $times_noted) {
363 debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs}));
368 my $ctime=rcs_getctime("$config{srcdir}/$file");
370 $pagectime{$page}=$ctime;
378 $mtime=rcs_getmtime("$config{srcdir}/$file");
384 utime($mtime, $mtime, "$config{srcdir}/$file");
388 $pagecase{lc $page}=$page;
389 if (! exists $pagectime{$page}) {
390 $pagectime{$page}=(srcfile_stat($file))[10];
395 return \@new, \@internal_new;
398 sub find_del_files ($) {
403 foreach my $page (keys %pagemtime) {
404 if (! $pages->{$page}) {
405 if (isinternal($page)) {
406 push @internal_del, $pagesources{$page};
409 push @del, $pagesources{$page};
412 delete $typedlinks{$page};
413 $renderedfiles{$page}=[];
418 return \@del, \@internal_del;
422 foreach my $file (@_) {
423 my $page=pagename($file);
424 if (! isinternal($page)) {
425 debug(sprintf(gettext("removing obsolete %s"), $page));
428 foreach my $old (@{$oldrenderedfiles{$page}}) {
429 prune($config{destdir}."/".$old);
432 foreach my $source (keys %destsources) {
433 if ($destsources{$source} eq $page) {
434 delete $destsources{$source};
438 delete $pagecase{lc $page};
439 delete $pagesources{$page};
443 sub find_changed ($) {
446 my @internal_changed;
447 foreach my $file (@$files) {
448 my $page=pagename($file);
449 my ($srcfile, @stat)=srcfile_stat($file);
450 if (! exists $pagemtime{$page} ||
451 $stat[9] > $pagemtime{$page} ||
452 $forcerebuild{$page}) {
453 $pagemtime{$page}=$stat[9];
455 if (isinternal($page)) {
456 # Preprocess internal page in scan-only mode.
457 preprocess($page, $page, readfile($srcfile), 1);
458 push @internal_changed, $file;
461 push @changed, $file;
465 return \@changed, \@internal_changed;
468 sub calculate_old_links ($$) {
469 my ($changed, $del)=@_;
471 foreach my $file (@$changed, @$del) {
472 my $page=pagename($file);
473 if (exists $oldlinks{$page}) {
474 foreach my $l (@{$oldlinks{$page}}) {
475 $oldlink_targets{$page}{$l}=bestlink($page, $l);
479 return \%oldlink_targets;
482 sub derender_internal ($) {
484 my $page=pagename($file);
485 delete $depends{$page};
486 delete $depends_simple{$page};
487 foreach my $old (@{$renderedfiles{$page}}) {
488 delete $destsources{$old};
490 $renderedfiles{$page}=[];
493 sub render_linkers ($) {
496 foreach my $page (keys %{$backlinks{$p}}) {
497 my $file=$pagesources{$page};
498 render($file, sprintf(gettext("building %s, which links to %s"), $file, $p));
502 sub remove_unrendered () {
503 foreach my $src (keys %rendered) {
504 my $page=pagename($src);
505 foreach my $file (@{$oldrenderedfiles{$page}}) {
506 if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
507 debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page));
508 prune($config{destdir}."/".$file);
514 sub link_types_changed ($$) {
515 # each is of the form { type => { link => 1 } }
519 return 0 if !defined $new && !defined $old;
520 return 1 if (!defined $new && %$old) || (!defined $old && %$new);
522 while (my ($type, $links) = each %$new) {
523 foreach my $link (keys %$links) {
524 return 1 unless exists $old->{$type}{$link};
528 while (my ($type, $links) = each %$old) {
529 foreach my $link (keys %$links) {
530 return 1 unless exists $new->{$type}{$link};
537 sub calculate_changed_links ($$$) {
538 my ($changed, $del, $oldlink_targets)=@_;
540 my (%backlinkchanged, %linkchangers);
542 foreach my $file (@$changed, @$del) {
543 my $page=pagename($file);
545 if (exists $links{$page}) {
546 foreach my $l (@{$links{$page}}) {
547 my $target=bestlink($page, $l);
548 if (! exists $oldlink_targets->{$page}{$l} ||
549 $target ne $oldlink_targets->{$page}{$l}) {
550 $backlinkchanged{$target}=1;
551 $linkchangers{lc($page)}=1;
553 delete $oldlink_targets->{$page}{$l};
556 if (exists $oldlink_targets->{$page} &&
557 %{$oldlink_targets->{$page}}) {
558 foreach my $target (values %{$oldlink_targets->{$page}}) {
559 $backlinkchanged{$target}=1;
561 $linkchangers{lc($page)}=1;
564 # we currently assume that changing the type of a link doesn't
566 if (!exists $linkchangers{lc($page)}) {
567 if (link_types_changed($typedlinks{$page}, $oldtypedlinks{$page})) {
568 $linkchangers{lc($page)}=1;
573 return \%backlinkchanged, \%linkchangers;
576 sub render_dependent ($$$$$$$) {
577 my ($files, $new, $internal_new, $del, $internal_del,
578 $internal_changed, $linkchangers)=@_;
580 my @changed=(keys %rendered, @$del);
581 my @exists_changed=(@$new, @$del);
583 my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
584 my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;
586 foreach my $f (@$files) {
587 next if $rendered{$f};
591 if (exists $depends_simple{$p}) {
592 foreach my $d (keys %{$depends_simple{$p}}) {
593 if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
596 ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_PRESENCE &&
597 $lc_exists_changed{$d})
599 ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_LINKS &&
608 if (exists $depends{$p} && ! defined $reason) {
609 foreach my $dep (keys %{$depends{$p}}) {
610 my $sub=pagespec_translate($dep);
611 next unless defined $sub;
613 # only consider internal files
614 # if the page explicitly depends
616 my $internal_dep=$dep =~ /internal\(/;
621 foreach my $file (@$list) {
623 my $page=pagename($file);
624 if ($sub->($page, location => $p)) {
625 if ($type == $IkiWiki::DEPEND_LINKS) {
626 next unless $linkchangers->{lc($page)};
635 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_CONTENT) {
636 last if $in->(\@changed, $IkiWiki::DEPEND_CONTENT);
637 last if $internal_dep && (
638 $in->($internal_new, $IkiWiki::DEPEND_CONTENT) ||
639 $in->($internal_del, $IkiWiki::DEPEND_CONTENT) ||
640 $in->($internal_changed, $IkiWiki::DEPEND_CONTENT)
643 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_PRESENCE) {
644 last if $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE);
645 last if $internal_dep && (
646 $in->($internal_new, $IkiWiki::DEPEND_PRESENCE) ||
647 $in->($internal_del, $IkiWiki::DEPEND_PRESENCE)
650 if ($depends{$p}{$dep} & $IkiWiki::DEPEND_LINKS) {
651 last if $in->(\@changed, $IkiWiki::DEPEND_LINKS);
652 last if $internal_dep && (
653 $in->($internal_new, $IkiWiki::DEPEND_LINKS) ||
654 $in->($internal_del, $IkiWiki::DEPEND_LINKS) ||
655 $in->($internal_changed, $IkiWiki::DEPEND_LINKS)
661 if (defined $reason) {
662 render($f, sprintf(gettext("building %s, which depends on %s"), $f, $reason));
670 sub render_backlinks ($) {
671 my $backlinkchanged=shift;
672 foreach my $link (keys %$backlinkchanged) {
673 my $linkfile=$pagesources{$link};
674 if (defined $linkfile) {
675 render($linkfile, sprintf(gettext("building %s, to update its backlinks"), $linkfile));
680 sub gen_autofile ($$$) {
685 if (file_pruned($autofile)) {
689 my ($file)="$config{srcdir}/$autofile" =~ /$config{wiki_file_regexp}/; # untaint
690 if (! defined $file) {
694 # Remember autofiles that were tried, and never try them again later.
695 if (exists $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}) {
698 $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}=1;
700 if (srcfile($autofile, 1) || file_pruned($autofile)) {
704 if (-l $file || -d _ || -e _) {
708 my $page = pagename($file);
709 if ($pages->{$page}) {
713 if (grep { $_ eq $autofile } @$del) {
717 $autofiles{$autofile}{generator}->();
725 run_hooks(refresh => sub { shift->() });
726 my ($files, $pages)=find_src_files();
727 my ($new, $internal_new)=find_new_files($files);
728 my ($del, $internal_del)=find_del_files($pages);
729 my ($changed, $internal_changed)=find_changed($files);
730 run_hooks(needsbuild => sub { shift->($changed) });
731 my $oldlink_targets=calculate_old_links($changed, $del);
733 foreach my $file (@$changed) {
737 foreach my $autofile (keys %autofiles) {
738 if (gen_autofile($autofile, $pages, $del)) {
739 push @{$files}, $autofile;
740 push @{$new}, $autofile if find_new_files([$autofile]);
741 push @{$changed}, $autofile if find_changed([$autofile]);
749 remove_del(@$del, @$internal_del);
751 foreach my $file (@$changed) {
752 render($file, sprintf(gettext("building %s"), $file));
754 foreach my $file (@$internal_new, @$internal_del, @$internal_changed) {
755 derender_internal($file);
758 my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
759 $del, $oldlink_targets);
761 foreach my $file (@$new, @$del) {
762 render_linkers($file);
765 if (@$changed || @$internal_changed ||
766 @$del || @$internal_del || @$internal_new) {
767 1 while render_dependent($files, $new, $internal_new,
768 $del, $internal_del, $internal_changed,
772 render_backlinks($backlinkchanged);
776 run_hooks(delete => sub { shift->(@$del) });
779 run_hooks(change => sub { shift->(keys %rendered) });
787 foreach my $page (keys %oldrenderedfiles) {
788 foreach my $file (@{$oldrenderedfiles{$page}}) {
789 prune($config{destdir}."/".$file);
794 sub commandline_render () {
799 my $srcfile=possibly_foolish_untaint($config{render});
801 $file=~s/\Q$config{srcdir}\E\/?//;
803 my $type=pagetype($file);
804 die sprintf(gettext("ikiwiki: cannot build %s"), $srcfile)."\n" unless defined $type;
805 my $content=readfile($srcfile);
806 my $page=pagename($file);
807 $pagesources{$page}=$file;
808 $content=filter($page, $page, $content);
809 $content=preprocess($page, $page, $content);
810 $content=linkify($page, $page, $content);
811 $content=htmlize($page, $page, $type, $content);
812 $pagemtime{$page}=(stat($srcfile))[9];
813 $pagectime{$page}=$pagemtime{$page} if ! exists $pagectime{$page};
815 print genpage($page, $content);