X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f78e6798aa5482e534d7254b87a7b58e9fcc0145..b531e56eef5eff5aea79c343d6d15295768f5b32:/IkiWiki/Render.pm diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index fff9dcce6..9d6f636a2 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -5,9 +5,8 @@ package IkiWiki; use warnings; use strict; use IkiWiki; -use Encode; -my (%backlinks, %rendered); +my (%backlinks, %rendered, %scanned); our %brokenlinks; my $links_calculated=0; @@ -62,8 +61,8 @@ sub genpage ($$) { my $page=shift; my $content=shift; - run_hooks(postscan => sub { - shift->(page => $page, content => $content); + run_hooks(indexhtml => sub { + shift->(page => $page, destpage => $page, content => $content); }); my $templatefile; @@ -74,23 +73,28 @@ sub genpage ($$) { $templatefile=$file; } }); - my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1); - my $actions=0; + my $template; + if (defined $templatefile) { + $template=template_depends($templatefile, $page, + blind_cache => 1); + } + else { + # no explicit depends as special case + $template=template('page.tmpl', + blind_cache => 1); + } + my $actions=0; if (length $config{cgiurl}) { if (IkiWiki->can("cgi_editpage")) { $template->param(editurl => cgiurl(do => "edit", page => $page)); $actions++; } - if (exists $hooks{auth}) { - $template->param(prefsurl => cgiurl(do => "prefs")); - $actions++; - } } - if (defined $config{historyurl} && length $config{historyurl}) { my $u=$config{historyurl}; - $u=~s/\[\[file\]\]/$pagesources{$page}/g; + my $p=uri_escape_utf8($pagesources{$page}, '^A-Za-z0-9\-\._~/'); + $u=~s/\[\[file\]\]/$p/g; $template->param(historyurl => $u); $actions++; } @@ -102,10 +106,10 @@ sub genpage ($$) { $actions++; } } - if ($actions) { $template->param(have_actions => 1); } + templateactions($template, $page); my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page); my ($backlinks, $more_backlinks); @@ -127,8 +131,9 @@ sub genpage ($$) { backlinks => $backlinks, more_backlinks => $more_backlinks, mtime => displaytime($pagemtime{$page}), - ctime => displaytime($pagectime{$page}), + ctime => displaytime($pagectime{$page}, undef, 1), baseurl => baseurl($page), + html5 => $config{html5}, ); run_hooks(pagetemplate => sub { @@ -149,6 +154,8 @@ sub genpage ($$) { sub scan ($) { my $file=shift; + return if $phase > PHASE_SCAN || $scanned{$file}; + $scanned{$file}=1; debug(sprintf(gettext("scanning %s"), $file)); @@ -169,15 +176,15 @@ sub scan ($) { } delete $typedlinks{$page}; + # Preprocess in scan-only mode. + preprocess($page, $page, $content, 1); + run_hooks(scan => sub { shift->( page => $page, content => $content, ); }); - - # Preprocess in scan-only mode. - preprocess($page, $page, $content, 1); } else { will_render($file, $file, 1); @@ -257,12 +264,13 @@ sub render ($$) { } } -sub prune ($) { +sub prune ($;$) { my $file=shift; + my $up_to=shift; unlink($file); my $dir=dirname($file); - while (rmdir($dir)) { + while ((! defined $up_to || $dir =~ m{^\Q$up_to\E\/}) && rmdir($dir)) { $dir=dirname($dir); } } @@ -281,67 +289,138 @@ sub srcdir_check () { } -sub verify_src_file ($$) { - my $file=shift; - my $dir=shift; - - return if -l $file || -d _; - $file=~s/^\Q$dir\E\/?//; - return if ! length $file; - my $page = pagename($file); - if (! exists $pagesources{$page} && - file_pruned($file)) { - $File::Find::prune=1; - return; +# Finds all files in the srcdir, and the underlaydirs. +# Returns the files, and their corresponding pages. +# +# When run in only_underlay mode, adds only the underlay files to +# the files and pages passed in. +sub find_src_files (;$$$) { + my $only_underlay=shift; + my @files; + if (defined $_[0]) { + @files=@{shift()}; } - - my ($file_untainted) = $file =~ /$config{wiki_file_regexp}/; # untaint - if (! defined $file_untainted) { - warn(sprintf(gettext("skipping bad filename %s"), $file)."\n"); + my %pages; + if (defined $_[0]) { + %pages=%{shift()}; } - return ($file_untainted, $page); -} -sub find_src_files () { - my @files; - my %pages; eval q{use File::Find}; error($@) if $@; - find({ - no_chdir => 1, - wanted => sub { - my ($file, $page) = verify_src_file(decode_utf8($_), $config{srcdir}); - if (defined $file) { - push @files, $file; - if ($pages{$page}) { - debug(sprintf(gettext("%s has multiple possible source pages"), $page)); + + eval q{use Cwd}; + die $@ if $@; + my $origdir=getcwd(); + my $abssrcdir=Cwd::abs_path($config{srcdir}); + + @IkiWiki::underlayfiles=(); + + my ($page, $underlay); + my $helper=sub { + my $file=decode_utf8($_); + + return if -l $file || -d _; + $file=~s/^\.\///; + return if ! length $file; + $page = pagename($file); + if (! exists $pagesources{$page} && + file_pruned($file)) { + $File::Find::prune=1; + return; + } + + my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint + if (! defined $f) { + warn(sprintf(gettext("skipping bad filename %s"), $file)."\n"); + return; + } + + if ($underlay) { + # avoid underlaydir override attacks; see security.mdwn + if (! -l "$abssrcdir/$f" && ! -e _) { + if (! $pages{$page}) { + push @files, $f; + push @IkiWiki::underlayfiles, $f; + $pages{$page}=1; } - $pages{$page}=1; } - }, - }, $config{srcdir}); - foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) { + } + else { + push @files, $f; + if ($pages{$page}) { + debug(sprintf(gettext("%s has multiple possible source pages"), $page)); + } + $pages{$page}=1; + } + }; + + unless ($only_underlay) { + chdir($config{srcdir}) || die "chdir $config{srcdir}: $!"; find({ no_chdir => 1, - wanted => sub { - my ($file, $page) = verify_src_file(decode_utf8($_), $dir); - if (defined $file) { - # avoid underlaydir override - # attacks; see security.mdwn - if (! -l "$config{srcdir}/$file" && - ! -e _) { - if (! $pages{$page}) { - push @files, $file; - $pages{$page}=1; - } - } - } - }, - }, $dir); + wanted => $helper, + }, '.'); + chdir($origdir) || die "chdir $origdir: $!"; + } + + $underlay=1; + foreach (@{$config{underlaydirs}}, $config{underlaydir}) { + if (chdir($_)) { + find({ + no_chdir => 1, + wanted => $helper, + }, '.'); + chdir($origdir) || die "chdir: $!"; + } }; + return \@files, \%pages; } +# Given a hash of files that have changed, and a hash of files that were +# deleted, should return the same results as find_src_files, with the same +# sanity checks. But a lot faster! +sub process_changed_files ($$) { + my $changed_raw=shift; + my $deleted_raw=shift; + + my @files; + my %pages; + + foreach my $file (keys %$changed_raw) { + my $page = pagename($file); + next if ! exists $pagesources{$page} && file_pruned($file); + my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint + if (! defined $f) { + warn(sprintf(gettext("skipping bad filename %s"), $file)."\n"); + next; + } + push @files, $f; + if ($pages{$page}) { + debug(sprintf(gettext("%s has multiple possible source pages"), $page)); + } + $pages{$page}=1; + } + + # So far, we only have the changed files. Now add in all the old + # files that were not changed or deleted, excluding ones that came + # from the underlay. + my %old_underlay; + foreach my $f (@IkiWiki::underlayfiles) { + $old_underlay{$f}=1; + } + foreach my $page (keys %pagesources) { + my $f=$pagesources{$page}; + unless ($old_underlay{$f} || exists $pages{$page} || exists $deleted_raw->{$f}) { + $pages{$page}=1; + push @files, $f; + } + } + + # add in the underlay + find_src_files(1, \@files, \%pages); +} + sub find_new_files ($) { my $files=shift; my @new; @@ -351,6 +430,35 @@ sub find_new_files ($) { foreach my $file (@$files) { my $page=pagename($file); + + if ($config{rcs} && $config{gettime} && + -e "$config{srcdir}/$file") { + if (! $times_noted) { + debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs})); + $times_noted=1; + } + + eval { + my $ctime=rcs_getctime($file); + if ($ctime > 0) { + $pagectime{$page}=$ctime; + } + }; + if ($@) { + print STDERR $@; + } + my $mtime; + eval { + $mtime=rcs_getmtime($file); + }; + if ($@) { + print STDERR $@; + } + elsif ($mtime > 0) { + utime($mtime, $mtime, "$config{srcdir}/$file"); + } + } + if (exists $pagesources{$page} && $pagesources{$page} ne $file) { # the page has changed its type $forcerebuild{$page}=1; @@ -360,38 +468,13 @@ sub find_new_files ($) { if (isinternal($page)) { push @internal_new, $file; } - elsif ($config{rcs}) { - if (! $times_noted) { - debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs})); - $times_noted=1; - } - + else { push @new, $file; - if ($config{gettime} && -e "$config{srcdir}/$file") { - eval { - my $ctime=rcs_getctime("$config{srcdir}/$file"); - if ($ctime > 0) { - $pagectime{$page}=$ctime; - } - }; - if ($@) { - print STDERR $@; - } - my $mtime; - eval { - $mtime=rcs_getmtime("$config{srcdir}/$file"); - }; - if ($@) { - print STDERR $@; - } - elsif ($mtime > 0) { - utime($mtime, $mtime, "$config{srcdir}/$file"); - } - } } $pagecase{lc $page}=$page; if (! exists $pagectime{$page}) { - $pagectime{$page}=(srcfile_stat($file))[10]; + my $ctime=(srcfile_stat($file, 1))[10]; + $pagectime{$page}=$ctime if defined $ctime; } } } @@ -404,7 +487,7 @@ sub find_del_files ($) { my @del; my @internal_del; - foreach my $page (keys %pagemtime) { + foreach my $page (keys %pagesources) { if (! $pages->{$page}) { if (isinternal($page)) { push @internal_del, $pagesources{$page}; @@ -426,11 +509,11 @@ sub remove_del (@) { foreach my $file (@_) { my $page=pagename($file); if (! isinternal($page)) { - debug(sprintf(gettext("removing old page %s"), $page)); + debug(sprintf(gettext("removing obsolete %s"), $page)); } foreach my $old (@{$oldrenderedfiles{$page}}) { - prune($config{destdir}."/".$old); + prune($config{destdir}."/".$old, $config{destdir}); } foreach my $source (keys %destsources) { @@ -440,6 +523,7 @@ sub remove_del (@) { } delete $pagecase{lc $page}; + $delpagesources{$page}=$pagesources{$page}; delete $pagesources{$page}; } } @@ -450,15 +534,26 @@ sub find_changed ($) { my @internal_changed; foreach my $file (@$files) { my $page=pagename($file); - my ($srcfile, @stat)=srcfile_stat($file); - if (! exists $pagemtime{$page} || - $stat[9] > $pagemtime{$page} || - $forcerebuild{$page}) { + my ($srcfile, @stat)=srcfile_stat($file, 1); + if (defined $srcfile && + (! exists $pagemtime{$page} || + $stat[9] > $pagemtime{$page} || + $forcerebuild{$page})) { $pagemtime{$page}=$stat[9]; if (isinternal($page)) { + my $content = readfile($srcfile); + # Preprocess internal page in scan-only mode. - preprocess($page, $page, readfile($srcfile), 1); + preprocess($page, $page, $content, 1); + + run_hooks(scan => sub { + shift->( + page => $page, + content => $content, + ); + }); + push @internal_changed, $file; } else { @@ -509,7 +604,7 @@ sub remove_unrendered () { foreach my $file (@{$oldrenderedfiles{$page}}) { if (! grep { $_ eq $file } @{$renderedfiles{$page}}) { debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page)); - prune($config{destdir}."/".$file); + prune($config{destdir}."/".$file, $config{destdir}); } } } @@ -521,7 +616,7 @@ sub link_types_changed ($$) { my $old = shift; return 0 if !defined $new && !defined $old; - return 1 if !defined $new || !defined $old; + return 1 if (!defined $new && %$old) || (!defined $old && %$new); while (my ($type, $links) = each %$new) { foreach my $link (keys %$links) { @@ -586,13 +681,23 @@ sub render_dependent ($$$$$$$) { my %lc_changed = map { lc(pagename($_)) => 1 } @changed; my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed; + + foreach my $p ("templates/page.tmpl", keys %{$depends_simple{""}}) { + if ($rendered{$p} || grep { $_ eq $p } @$del) { + foreach my $f (@$files) { + next if $rendered{$f}; + render($f, sprintf(gettext("building %s, which depends on %s"), $f, $p)); + } + return 0; + } + } foreach my $f (@$files) { next if $rendered{$f}; my $p=pagename($f); my $reason = undef; - - if (exists $depends_simple{$p}) { + + if (exists $depends_simple{$p} && ! defined $reason) { foreach my $d (keys %{$depends_simple{$p}}) { if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT && $lc_changed{$d}) @@ -617,7 +722,7 @@ sub render_dependent ($$$$$$$) { # only consider internal files # if the page explicitly depends # on such files - my $internal_dep=$dep =~ /internal\(/; + my $internal_dep=$dep =~ /(?:internal|comment|comment_pending)\(/; my $in=sub { my $list=shift; @@ -629,34 +734,35 @@ sub render_dependent ($$$$$$$) { if ($type == $IkiWiki::DEPEND_LINKS) { next unless $linkchangers->{lc($page)}; } - return $page; + $reason=$page; + return 1; } } return undef; }; if ($depends{$p}{$dep} & $IkiWiki::DEPEND_CONTENT) { - last if $reason = - $in->(\@changed, $IkiWiki::DEPEND_CONTENT); - last if $internal_dep && ($reason = + last if $in->(\@changed, $IkiWiki::DEPEND_CONTENT); + last if $internal_dep && ( $in->($internal_new, $IkiWiki::DEPEND_CONTENT) || $in->($internal_del, $IkiWiki::DEPEND_CONTENT) || - $in->($internal_changed, $IkiWiki::DEPEND_CONTENT)); + $in->($internal_changed, $IkiWiki::DEPEND_CONTENT) + ); } if ($depends{$p}{$dep} & $IkiWiki::DEPEND_PRESENCE) { - last if $reason = - $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE); - last if $internal_dep && ($reason = + last if $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE); + last if $internal_dep && ( $in->($internal_new, $IkiWiki::DEPEND_PRESENCE) || - $in->($internal_del, $IkiWiki::DEPEND_PRESENCE)); + $in->($internal_del, $IkiWiki::DEPEND_PRESENCE) + ); } if ($depends{$p}{$dep} & $IkiWiki::DEPEND_LINKS) { - last if $reason = - $in->(\@changed, $IkiWiki::DEPEND_LINKS); - last if $internal_dep && ($reason = + last if $in->(\@changed, $IkiWiki::DEPEND_LINKS); + last if $internal_dep && ( $in->($internal_new, $IkiWiki::DEPEND_LINKS) || $in->($internal_del, $IkiWiki::DEPEND_LINKS) || - $in->($internal_changed, $IkiWiki::DEPEND_LINKS)); + $in->($internal_changed, $IkiWiki::DEPEND_LINKS) + ); } } } @@ -684,25 +790,37 @@ sub gen_autofile ($$$) { my $autofile=shift; my $pages=shift; my $del=shift; - - if (srcfile($autofile, 1)) { - return 0; + + if (file_pruned($autofile)) { + return; } - my ($file, $page) = verify_src_file("$config{srcdir}/$autofile", $config{srcdir}); - - if ((!defined $file) || - (exists $wikistate{$autofiles{$autofile}{plugin}}{autofile_deleted})) { - return 0; + my ($file)="$config{srcdir}/$autofile" =~ /$config{wiki_file_regexp}/; # untaint + if (! defined $file) { + return; + } + + # Remember autofiles that were tried, and never try them again later. + if (exists $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}) { + return; + } + $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}=1; + + if (srcfile($autofile, 1) || file_pruned($autofile)) { + return; } + if (-l $file || -d _ || -e _) { + return; + } + + my $page = pagename($file); if ($pages->{$page}) { - return 0; + return; } - if (grep { $_ eq $file } @$del) { - $wikistate{$autofiles{$autofile}{generator}}{autofile_deleted}=1; - return 0; + if (grep { $_ eq $autofile } @$del) { + return; } $autofiles{$autofile}{generator}->(); @@ -710,15 +828,43 @@ sub gen_autofile ($$$) { return 1; } - sub refresh () { + $phase = PHASE_SCAN; + srcdir_check(); run_hooks(refresh => sub { shift->() }); - my ($files, $pages)=find_src_files(); - my ($new, $internal_new)=find_new_files($files); - my ($del, $internal_del)=find_del_files($pages); - my ($changed, $internal_changed)=find_changed($files); - run_hooks(needsbuild => sub { shift->($changed) }); + my ($files, $pages, $new, $internal_new, $del, $internal_del, $changed, $internal_changed); + my $want_find_changes=$config{only_committed_changes} && + exists $IkiWiki::hooks{rcs}{rcs_find_changes} && + exists $IkiWiki::hooks{rcs}{rcs_get_current_rev}; + if (! $config{rebuild} && $want_find_changes && defined $IkiWiki::lastrev && length $IkiWiki::lastrev) { + my ($changed_raw, $del_raw); + ($changed_raw, $del_raw, $IkiWiki::lastrev) = $IkiWiki::hooks{rcs}{rcs_find_changes}{call}->($IkiWiki::lastrev); + ($files, $pages)=process_changed_files($changed_raw, $del_raw); + } + else { + ($files, $pages)=find_src_files(); + } + if ($want_find_changes) { + if (! defined($IkiWiki::lastrev) || ! length $IkiWiki::lastrev) { + $IkiWiki::lastrev=$IkiWiki::hooks{rcs}{rcs_get_current_rev}{call}->(); + } + } + ($new, $internal_new)=find_new_files($files); + ($del, $internal_del)=find_del_files($pages); + ($changed, $internal_changed)=find_changed($files); + my %existingfiles; + run_hooks(needsbuild => sub { + my $ret=shift->($changed, [@$del, @$internal_del]); + if (ref $ret eq 'ARRAY' && $ret != $changed) { + if (! %existingfiles) { + foreach my $f (@$files) { + $existingfiles{$f}=1; + } + } + @$changed=grep $existingfiles{$_}, @$ret; + } + }); my $oldlink_targets=calculate_old_links($changed, $del); foreach my $file (@$changed) { @@ -736,7 +882,13 @@ sub refresh () { } calculate_links(); - + + # At this point it becomes OK to start matching pagespecs. + $phase = PHASE_RENDER; + # Save some memory: we no longer need to keep track of which pages + # we've scanned + %scanned = (); + remove_del(@$del, @$internal_del); foreach my $file (@$changed) { @@ -746,13 +898,21 @@ sub refresh () { derender_internal($file); } + run_hooks(build_affected => sub { + my %affected = shift->(); + while (my ($page, $message) = each %affected) { + next unless exists $pagesources{$page}; + render($pagesources{$page}, $message); + } + }); + my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed, $del, $oldlink_targets); foreach my $file (@$new, @$del) { render_linkers($file); } - + if (@$changed || @$internal_changed || @$del || @$internal_del || @$internal_new) { 1 while render_dependent($files, $new, $internal_new, @@ -763,12 +923,17 @@ sub refresh () { render_backlinks($backlinkchanged); remove_unrendered(); - if (@$del) { - run_hooks(delete => sub { shift->(@$del) }); + if (@$del || @$internal_del) { + run_hooks(delete => sub { shift->(@$del, @$internal_del) }); } if (%rendered) { - run_hooks(change => sub { shift->(keys %rendered) }); + run_hooks(rendered => sub { shift->(keys %rendered) }); + run_hooks(change => sub { shift->(keys %rendered) }); # back-compat } + my %all_changed = map { $_ => 1 } + @$new, @$changed, @$del, + @$internal_new, @$internal_changed, @$internal_del; + run_hooks(changes => sub { shift->(keys %all_changed) }); } sub clean_rendered { @@ -777,7 +942,7 @@ sub clean_rendered { remove_unrendered(); foreach my $page (keys %oldrenderedfiles) { foreach my $file (@{$oldrenderedfiles{$page}}) { - prune($config{destdir}."/".$file); + prune($config{destdir}."/".$file, $config{destdir}); } } } @@ -787,6 +952,10 @@ sub commandline_render () { loadindex(); unlockwiki(); + # This function behaves as though it's in the render phase; + # all other files are assumed to have been scanned last time. + $phase = PHASE_RENDER; + my $srcfile=possibly_foolish_untaint($config{render}); my $file=$srcfile; $file=~s/\Q$config{srcdir}\E\/?//;