X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/96b1f9519270db39d4056878907dec2d6976fce4..b1c341777de7304287a02adc8b7b324cab44eb0b:/IkiWiki/Render.pm?ds=sidebyside diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 5336d4f54..a90d202ee 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -5,11 +5,8 @@ package IkiWiki; use warnings; use strict; use IkiWiki; -use Encode; -my (%backlinks, %rendered, @new, @del, @internal, @internal_change, @files, - %page_exists, %oldlink_targets, %backlinkchanged, - %linkchangers); +my (%backlinks, %rendered); our %brokenlinks; my $links_calculated=0; @@ -45,7 +42,7 @@ sub backlinks ($) { my @links; foreach my $p (backlink_pages($page)) { my $href=urlto($p, $page); - + # Trim common dir prefixes from both pages. my $p_trimmed=$p; my $page_trimmed=$page; @@ -63,6 +60,10 @@ sub backlinks ($) { sub genpage ($$) { my $page=shift; my $content=shift; + + run_hooks(indexhtml => sub { + shift->(page => $page, destpage => $page, content => $content); + }); my $templatefile; run_hooks(templatefile => sub { @@ -72,35 +73,43 @@ 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}) { - $template->param(editurl => cgiurl(do => "edit", page => $page)) - if IkiWiki->can("cgi_editpage"); - $template->param(prefsurl => cgiurl(do => "prefs")) - if exists $hooks{auth}; - $actions++; + if (IkiWiki->can("cgi_editpage")) { + $template->param(editurl => cgiurl(do => "edit", page => $page)); + $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++; } if ($config{discussion}) { - if ($page !~ /.*\/\Q$config{discussionpage}\E$/ && + if ($page !~ /.*\/\Q$config{discussionpage}\E$/i && (length $config{cgiurl} || exists $links{$page."/".$config{discussionpage}})) { $template->param(discussionlink => htmllink($page, $page, $config{discussionpage}, noimageinline => 1, forcesubpage => 1)); $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); @@ -122,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 { @@ -132,10 +142,6 @@ sub genpage ($$) { $content=$template->output; - run_hooks(postscan => sub { - shift->(page => $page, content => $content); - }); - run_hooks(format => sub { $content=shift->( page => $page, @@ -166,6 +172,10 @@ sub scan ($) { else { $links{$page}=[]; } + delete $typedlinks{$page}; + + # Preprocess in scan-only mode. + preprocess($page, $page, $content, 1); run_hooks(scan => sub { shift->( @@ -173,9 +183,6 @@ sub scan ($) { content => $content, ); }); - - # Preprocess in scan-only mode. - preprocess($page, $page, $content, 1); } else { will_render($file, $file, 1); @@ -255,12 +262,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); } } @@ -280,70 +288,113 @@ sub srcdir_check () { } sub find_src_files () { - my @ret; + my @files; + my %pages; eval q{use File::Find}; error($@) if $@; - find({ - no_chdir => 1, - wanted => sub { - $_=decode_utf8($_); - if (file_pruned($_, $config{srcdir})) { - $File::Find::prune=1; - } - elsif (! -l $_ && ! -d _) { - my ($f)=/$config{wiki_file_regexp}/; # untaint - if (! defined $f) { - warn(sprintf(gettext("skipping bad filename %s"), $_)."\n"); - } - else { - $f=~s/^\Q$config{srcdir}\E\/?//; - push @ret, $f; - my $page = pagename($f); - if ($page_exists{$page}) { - debug(sprintf(gettext("%s has multiple possible source pages"), $page)); - } - $page_exists{$page}=1; + + eval q{use Cwd}; + die $@ if $@; + my $origdir=getcwd(); + my $abssrcdir=Cwd::abs_path($config{srcdir}); + + 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; + $pages{$page}=1; } } - }, - }, $config{srcdir}); - foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) { - find({ - no_chdir => 1, - wanted => sub { - $_=decode_utf8($_); - if (file_pruned($_, $dir)) { - $File::Find::prune=1; - } - elsif (! -l $_ && ! -d _) { - my ($f)=/$config{wiki_file_regexp}/; # untaint - if (! defined $f) { - warn(sprintf(gettext("skipping bad filename %s"), $_)."\n"); - } - else { - $f=~s/^\Q$dir\E\/?//; - # avoid underlaydir - # override attacks; see - # security.mdwn - if (! -l "$config{srcdir}/$f" && - ! -e _) { - my $page=pagename($f); - if (! $page_exists{$page}) { - push @ret, $f; - $page_exists{$page}=1; - } - } - } - } - }, - }, $dir); + } + else { + push @files, $f; + if ($pages{$page}) { + debug(sprintf(gettext("%s has multiple possible source pages"), $page)); + } + $pages{$page}=1; + } + }; + + chdir($config{srcdir}) || die "chdir $config{srcdir}: $!"; + find({ + no_chdir => 1, + 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 \@ret; + + return \@files, \%pages; } -sub process_new_files () { - foreach my $file (@files) { +sub find_new_files ($) { + my $files=shift; + my @new; + my @internal_new; + + my $times_noted; + + 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; @@ -351,19 +402,10 @@ sub process_new_files () { $pagesources{$page}=$file; if (! $pagemtime{$page}) { if (isinternal($page)) { - push @internal, $file; + push @internal_new, $file; } else { push @new, $file; - if ($config{getctime} && -e "$config{srcdir}/$file") { - eval { - my $time=rcs_getctime("$config{srcdir}/$file"); - $pagectime{$page}=$time; - }; - if ($@) { - print STDERR $@; - } - } } $pagecase{lc $page}=$page; if (! exists $pagectime{$page}) { @@ -371,37 +413,61 @@ sub process_new_files () { } } } + + return \@new, \@internal_new; } -sub process_del_files () { - foreach my $page (keys %pagemtime) { - if (! $page_exists{$page}) { +sub find_del_files ($) { + my $pages=shift; + my @del; + my @internal_del; + + foreach my $page (keys %pagesources) { + if (! $pages->{$page}) { if (isinternal($page)) { - push @internal, $pagesources{$page}; + push @internal_del, $pagesources{$page}; } else { - debug(sprintf(gettext("removing old page %s"), $page)); push @del, $pagesources{$page}; } $links{$page}=[]; + delete $typedlinks{$page}; $renderedfiles{$page}=[]; $pagemtime{$page}=0; - foreach my $old (@{$oldrenderedfiles{$page}}) { - prune($config{destdir}."/".$old); - } - delete $pagesources{$page}; - foreach my $source (keys %destsources) { - if ($destsources{$source} eq $page) { - delete $destsources{$source}; - } + } + } + + return \@del, \@internal_del; +} + +sub remove_del (@) { + foreach my $file (@_) { + my $page=pagename($file); + if (! isinternal($page)) { + debug(sprintf(gettext("removing obsolete %s"), $page)); + } + + foreach my $old (@{$oldrenderedfiles{$page}}) { + prune($config{destdir}."/".$old, $config{destdir}); + } + + foreach my $source (keys %destsources) { + if ($destsources{$source} eq $page) { + delete $destsources{$source}; } } + + delete $pagecase{lc $page}; + $delpagesources{$page}=$pagesources{$page}; + delete $pagesources{$page}; } } -sub find_needsbuild () { - my @needsbuild; - foreach my $file (@files) { +sub find_changed ($) { + my $files=shift; + my @changed; + my @internal_changed; + foreach my $file (@$files) { my $page=pagename($file); my ($srcfile, @stat)=srcfile_stat($file); if (! exists $pagemtime{$page} || @@ -410,26 +476,40 @@ sub find_needsbuild () { $pagemtime{$page}=$stat[9]; if (isinternal($page)) { + my $content = readfile($srcfile); + # Preprocess internal page in scan-only mode. - preprocess($page, $page, readfile($srcfile), 1); - push @internal_change, $file; + preprocess($page, $page, $content, 1); + + run_hooks(scan => sub { + shift->( + page => $page, + content => $content, + ); + }); + + push @internal_changed, $file; } else { - push @needsbuild, $file; + push @changed, $file; } } } - return @needsbuild; + return \@changed, \@internal_changed; } -sub calculate_old_links ($) { - my $file=shift; - my $page=pagename($file); - if (exists $oldlinks{$page}) { - foreach my $l (@{$oldlinks{$page}}) { - $oldlink_targets{$page}{$l}=bestlink($page, $l); +sub calculate_old_links ($$) { + my ($changed, $del)=@_; + my %oldlink_targets; + foreach my $file (@$changed, @$del) { + my $page=pagename($file); + if (exists $oldlinks{$page}) { + foreach my $l (@{$oldlinks{$page}}) { + $oldlink_targets{$page}{$l}=bestlink($page, $l); + } } } + return \%oldlink_targets; } sub derender_internal ($) { @@ -458,48 +538,100 @@ 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}); } } } } -sub calculate_changed_links ($) { - my $file=shift; - my $page=pagename($file); - if (exists $links{$page}) { - foreach my $l (@{$links{$page}}) { - my $target=bestlink($page, $l); - if (! exists $oldlink_targets{$page}{$l} || - $target ne $oldlink_targets{$page}{$l}) { - $backlinkchanged{$l}=1; - $linkchangers{lc($page)}=1; - } - delete $oldlink_targets{$page}{$l}; +sub link_types_changed ($$) { + # each is of the form { type => { link => 1 } } + my $new = shift; + my $old = shift; + + return 0 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) { + return 1 unless exists $old->{$type}{$link}; + } + } + + while (my ($type, $links) = each %$old) { + foreach my $link (keys %$links) { + return 1 unless exists $new->{$type}{$link}; } } - if (exists $oldlink_targets{$page} && - %{$oldlink_targets{$page}}) { - foreach my $target (keys %{$oldlink_targets{$page}}) { - $backlinkchanged{$target}=1; + + return 0; +} + +sub calculate_changed_links ($$$) { + my ($changed, $del, $oldlink_targets)=@_; + + my (%backlinkchanged, %linkchangers); + + foreach my $file (@$changed, @$del) { + my $page=pagename($file); + + if (exists $links{$page}) { + foreach my $l (@{$links{$page}}) { + my $target=bestlink($page, $l); + if (! exists $oldlink_targets->{$page}{$l} || + $target ne $oldlink_targets->{$page}{$l}) { + $backlinkchanged{$target}=1; + $linkchangers{lc($page)}=1; + } + delete $oldlink_targets->{$page}{$l}; + } + } + if (exists $oldlink_targets->{$page} && + %{$oldlink_targets->{$page}}) { + foreach my $target (values %{$oldlink_targets->{$page}}) { + $backlinkchanged{$target}=1; + } + $linkchangers{lc($page)}=1; + } + + # we currently assume that changing the type of a link doesn't + # change backlinks + if (!exists $linkchangers{lc($page)}) { + if (link_types_changed($typedlinks{$page}, $oldtypedlinks{$page})) { + $linkchangers{lc($page)}=1; + } } - $linkchangers{lc($page)}=1; } + + return \%backlinkchanged, \%linkchangers; } -sub render_dependent () { - my @changed=(keys %rendered, @del); - my @exists_changed=(@new, @del); +sub render_dependent ($$$$$$$) { + my ($files, $new, $internal_new, $del, $internal_del, + $internal_changed, $linkchangers)=@_; + + my @changed=(keys %rendered, @$del); + my @exists_changed=(@$new, @$del); 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) { + 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}) @@ -508,7 +640,7 @@ sub render_dependent () { $lc_exists_changed{$d}) || ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_LINKS && - $linkchangers{$d}) + $linkchangers->{$d}) ) { $reason = $d; last; @@ -517,37 +649,54 @@ sub render_dependent () { } if (exists $depends{$p} && ! defined $reason) { - D: foreach my $d (keys %{$depends{$p}}) { - my $sub=pagespec_translate($d); - next if $@ || ! defined $sub; + foreach my $dep (keys %{$depends{$p}}) { + my $sub=pagespec_translate($dep); + next unless defined $sub; # only consider internal files # if the page explicitly depends # on such files - my $internal_dep=$d =~ /internal\(/; - - my @candidates; - if ($depends{$p}{$d} & $IkiWiki::DEPEND_PRESENCE) { - @candidates=@exists_changed; - push @candidates, @internal - if $internal_dep; - } - if (($depends{$p}{$d} & ($IkiWiki::DEPEND_CONTENT | $IkiWiki::DEPEND_LINKS))) { - @candidates=@changed; - push @candidates, @internal, @internal_change - if $internal_dep; - } - - foreach my $file (@candidates) { - next if $file eq $f; - my $page=pagename($file); - if ($sub->($page, location => $p)) { - if ($depends{$p}{$d} & $IkiWiki::DEPEND_LINKS) { - next unless $linkchangers{lc($page)}; + my $internal_dep=$dep =~ /(?:internal|comment|comment_pending)\(/; + + my $in=sub { + my $list=shift; + my $type=shift; + foreach my $file (@$list) { + next if $file eq $f; + my $page=pagename($file); + if ($sub->($page, location => $p)) { + if ($type == $IkiWiki::DEPEND_LINKS) { + next unless $linkchangers->{lc($page)}; + } + $reason=$page; + return 1; } - $reason = $page; - last D; } + return undef; + }; + + if ($depends{$p}{$dep} & $IkiWiki::DEPEND_CONTENT) { + 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) + ); + } + if ($depends{$p}{$dep} & $IkiWiki::DEPEND_PRESENCE) { + last if $in->(\@exists_changed, $IkiWiki::DEPEND_PRESENCE); + last if $internal_dep && ( + $in->($internal_new, $IkiWiki::DEPEND_PRESENCE) || + $in->($internal_del, $IkiWiki::DEPEND_PRESENCE) + ); + } + if ($depends{$p}{$dep} & $IkiWiki::DEPEND_LINKS) { + 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) + ); } } } @@ -561,8 +710,9 @@ sub render_dependent () { return 0; } -sub render_backlinks () { - foreach my $link (keys %backlinkchanged) { +sub render_backlinks ($) { + my $backlinkchanged=shift; + foreach my $link (keys %$backlinkchanged) { my $linkfile=$pagesources{$link}; if (defined $linkfile) { render($linkfile, sprintf(gettext("building %s, to update its backlinks"), $linkfile)); @@ -570,53 +720,133 @@ sub render_backlinks () { } } +sub gen_autofile ($$$) { + my $autofile=shift; + my $pages=shift; + my $del=shift; + + if (file_pruned($autofile)) { + return; + } + + 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; + } + + if (grep { $_ eq $autofile } @$del) { + return; + } + + $autofiles{$autofile}{generator}->(); + $pages->{$page}=1; + return 1; +} + + sub refresh () { srcdir_check(); run_hooks(refresh => sub { shift->() }); - @files=@{find_src_files()}; - process_new_files(); - process_del_files(); - - my @needsbuild=find_needsbuild(); - run_hooks(needsbuild => sub { shift->(\@needsbuild) }); + 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 { + my $ret=shift->($changed, [@$del, @$internal_del]); + $changed=$ret if ref $ret eq 'ARRAY'; + }); + my $oldlink_targets=calculate_old_links($changed, $del); - foreach my $file (@needsbuild, @del) { - calculate_old_links($file); + foreach my $file (@$changed) { + scan($file); } - foreach my $file (@needsbuild) { - scan($file); + foreach my $autofile (keys %autofiles) { + if (gen_autofile($autofile, $pages, $del)) { + push @{$files}, $autofile; + push @{$new}, $autofile if find_new_files([$autofile]); + push @{$changed}, $autofile if find_changed([$autofile]); + + scan($autofile); + } } calculate_links(); + + remove_del(@$del, @$internal_del); - foreach my $file (@needsbuild) { + foreach my $file (@$changed) { render($file, sprintf(gettext("building %s"), $file)); } - foreach my $file (@internal, @internal_change) { + foreach my $file (@$internal_new, @$internal_del, @$internal_changed) { derender_internal($file); } - foreach my $file (@needsbuild, @del) { - calculate_changed_links($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) { + foreach my $file (@$new, @$del) { render_linkers($file); } - - if (@needsbuild || @del || @internal || @internal_change) { - 1 while render_dependent(); + + if (@$changed || @$internal_changed || + @$del || @$internal_del || @$internal_new) { + 1 while render_dependent($files, $new, $internal_new, + $del, $internal_del, $internal_changed, + $linkchangers); } - render_backlinks(); + 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 { + lockwiki(); + loadindex(); + remove_unrendered(); + foreach my $page (keys %oldrenderedfiles) { + foreach my $file (@{$oldrenderedfiles{$page}}) { + prune($config{destdir}."/".$file, $config{destdir}); + } } }