X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/201d11da0aad98ee497aa9866782547795d3369f..b24f236dfa2903805bc233a7fc97101d912ae3ee:/IkiWiki/Render.pm diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 863964207..8e4c8af71 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -7,10 +7,10 @@ use strict; use IkiWiki; use Encode; -my %backlinks; -my $backlinks_calculated=0; +our %backlinks=(); +our $backlinks_calculated=0; -sub calculate_backlinks () { #{{{ +sub calculate_backlinks () { return if $backlinks_calculated; %backlinks=(); foreach my $page (keys %links) { @@ -22,18 +22,17 @@ sub calculate_backlinks () { #{{{ } } $backlinks_calculated=1; -} #}}} +} -sub backlinks ($) { #{{{ +sub backlinks ($) { my $page=shift; calculate_backlinks(); my @links; - return unless $backlinks{$page}; foreach my $p (keys %{$backlinks{$page}}) { - my $href=abs2rel(htmlpage($p), dirname($page)); - + my $href=urlto($p, $page); + # Trim common dir prefixes from both pages. my $p_trimmed=$p; my $page_trimmed=$page; @@ -45,72 +44,72 @@ sub backlinks ($) { #{{{ push @links, { url => $href, page => pagetitle($p_trimmed) }; } + return @links; +} - return sort { $a->{page} cmp $b->{page} } @links; -} #}}} - -sub parentlinks ($) { #{{{ - my $page=shift; - - my @ret; - my $pagelink=""; - my $path=""; - my $skip=1; - return if $page eq 'index'; # toplevel - foreach my $dir (reverse split("/", $page)) { - if (! $skip) { - $path.="../"; - unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) }; - } - else { - $skip=0; - } - } - unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} }; - return @ret; -} #}}} - -sub genpage ($$$) { #{{{ +sub genpage ($$) { my $page=shift; my $content=shift; - my $mtime=shift; - my $template=template("page.tmpl", blind_cache => 1); + my $templatefile; + run_hooks(templatefile => sub { + return if defined $templatefile; + my $file=shift->(page => $page); + if (defined $file && defined template_file($file)) { + $templatefile=$file; + } + }); + my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1); my $actions=0; if (length $config{cgiurl}) { - $template->param(editurl => cgiurl(do => "edit", page => $page)); + $template->param(editurl => cgiurl(do => "edit", page => $page)) + if IkiWiki->can("cgi_editpage"); $template->param(prefsurl => cgiurl(do => "prefs")); - if ($config{rcs}) { - $template->param(recentchangesurl => cgiurl(do => "recentchanges")); - } $actions++; } - - if (length $config{historyurl}) { + + if (defined $config{historyurl} && length $config{historyurl}) { my $u=$config{historyurl}; $u=~s/\[\[file\]\]/$pagesources{$page}/g; $template->param(historyurl => $u); $actions++; } - if ($config{discussion} && (length $config{cgiurl} || exists $links{"$page/discussion"})) { - $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1)); - $actions++; + if ($config{discussion}) { + my $discussionlink=gettext("discussion"); + if ($page !~ /.*\/\Q$discussionlink\E$/ && + (length $config{cgiurl} || + exists $links{$page."/".$discussionlink})) { + $template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), noimageinline => 1, forcesubpage => 1)); + $actions++; + } } if ($actions) { $template->param(have_actions => 1); } + my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page); + my ($backlinks, $more_backlinks); + if (@backlinks <= $config{numbacklinks} || ! $config{numbacklinks}) { + $backlinks=\@backlinks; + $more_backlinks=[]; + } + else { + $backlinks=[@backlinks[0..$config{numbacklinks}-1]]; + $more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]]; + } + $template->param( title => $page eq 'index' ? $config{wikiname} : pagetitle(basename($page)), wikiname => $config{wikiname}, - parentlinks => [parentlinks($page)], content => $content, - backlinks => [backlinks($page)], - mtime => displaytime($mtime), + backlinks => $backlinks, + more_backlinks => $more_backlinks, + mtime => displaytime($pagemtime{$page}), + ctime => displaytime($pagectime{$page}), baseurl => baseurl($page), ); @@ -119,6 +118,10 @@ sub genpage ($$$) { #{{{ }); $content=$template->output; + + run_hooks(postscan => sub { + shift->(page => $page, content => $content); + }); run_hooks(format => sub { $content=shift->( @@ -128,15 +131,9 @@ sub genpage ($$$) { #{{{ }); return $content; -} #}}} +} -sub mtime ($) { #{{{ - my $file=shift; - - return (stat($file))[9]; -} #}}} - -sub scan ($) { #{{{ +sub scan ($) { my $file=shift; my $type=pagetype($file); @@ -146,59 +143,99 @@ sub scan ($) { #{{{ my $page=pagename($file); will_render($page, htmlpage($page), 1); - # Always needs to be done, since filters might add links - # to the content. - $content=filter($page, $content); - - my @links; - while ($content =~ /(? sub { + shift->( + page => $page, + content => $content, + ); + }); + # Preprocess in scan-only mode. preprocess($page, $page, $content, 1); } else { will_render($file, $file, 1); } -} #}}} +} + +sub fast_file_copy (@) { + my $srcfile=shift; + my $destfile=shift; + my $srcfd=shift; + my $destfd=shift; + my $cleanup=shift; + + my $blksize = 16384; + my ($len, $buf, $written); + while ($len = sysread $srcfd, $buf, $blksize) { + if (! defined $len) { + next if $! =~ /^Interrupted/; + error("failed to read $srcfile: $!", $cleanup); + } + my $offset = 0; + while ($len) { + defined($written = syswrite $destfd, $buf, $len, $offset) + or error("failed to write $destfile: $!", $cleanup); + $len -= $written; + $offset += $written; + } + } +} -sub render ($) { #{{{ +sub render ($) { my $file=shift; my $type=pagetype($file); my $srcfile=srcfile($file); if (defined $type) { - my $content=readfile($srcfile); my $page=pagename($file); delete $depends{$page}; will_render($page, htmlpage($page), 1); + return if $type=~/^_/; - $content=filter($page, $content); - $content=preprocess($page, $page, $content); - $content=linkify($page, $page, $content); - $content=htmlize($page, $type, $content); + my $content=htmlize($page, $page, $type, + linkify($page, $page, + preprocess($page, $page, + filter($page, $page, + readfile($srcfile))))); - writefile(htmlpage($page), $config{destdir}, - genpage($page, $content, mtime($srcfile))); - $oldpagemtime{$page}=time; + my $output=htmlpage($page); + writefile($output, $config{destdir}, genpage($page, $content)); } else { - my $content=readfile($srcfile, 1); delete $depends{$file}; will_render($file, $file, 1); - writefile($file, $config{destdir}, $content, 1); - $oldpagemtime{$file}=time; + + if ($config{hardlink}) { + # only hardlink if owned by same user + my @stat=stat($srcfile); + if ($stat[4] == $>) { + prep_writefile($file, $config{destdir}); + unlink($config{destdir}."/".$file); + if (link($srcfile, $config{destdir}."/".$file)) { + return; + } + } + # if hardlink fails, fall back to copying + } + + my $srcfd=readfile($srcfile, 1, 1); + writefile($file, $config{destdir}, undef, 1, sub { + fast_file_copy($srcfile, $file, $srcfd, @_); + }); } -} #}}} +} -sub prune ($) { #{{{ +sub prune ($) { my $file=shift; unlink($file); @@ -206,9 +243,22 @@ sub prune ($) { #{{{ while (rmdir($dir)) { $dir=dirname($dir); } -} #}}} +} + +sub refresh () { + # security check, avoid following symlinks in the srcdir path by default + my $test=$config{srcdir}; + while (length $test) { + if (-l $test && ! $config{allow_symlinks_before_srcdir}) { + error(sprintf(gettext("symlink found in srcdir path (%s) -- set allow_symlinks_before_srcdir to allow this"), $test)); + } + unless ($test=~s/\/+$//) { + $test=dirname($test); + } + } + + run_hooks(refresh => sub { shift->() }); -sub refresh () { #{{{ # find existing pages my %exists; my @files; @@ -221,98 +271,150 @@ sub refresh () { #{{{ if (file_pruned($_, $config{srcdir})) { $File::Find::prune=1; } - elsif (! -d $_ && ! -l $_) { + elsif (! -l $_ && ! -d _) { my ($f)=/$config{wiki_file_regexp}/; # untaint if (! defined $f) { - warn("skipping bad filename $_\n"); + warn(sprintf(gettext("skipping bad filename %s"), $_)."\n"); } else { $f=~s/^\Q$config{srcdir}\E\/?//; push @files, $f; - $exists{pagename($f)}=1; + my $pagename = pagename($f); + if ($exists{$pagename}) { + debug(sprintf(gettext("%s has multiple possible source pages"), $pagename)); + } + $exists{$pagename}=1; } } }, }, $config{srcdir}); - find({ - no_chdir => 1, - wanted => sub { - $_=decode_utf8($_); - if (file_pruned($_, $config{underlaydir})) { - $File::Find::prune=1; - } - elsif (! -d $_ && ! -l $_) { - my ($f)=/$config{wiki_file_regexp}/; # untaint - if (! defined $f) { - warn("skipping bad filename $_\n"); + foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) { + find({ + no_chdir => 1, + wanted => sub { + $_=decode_utf8($_); + if (file_pruned($_, $dir)) { + $File::Find::prune=1; } - else { - # Don't add files that are in the - # srcdir. - $f=~s/^\Q$config{underlaydir}\E\/?//; - if (! -e "$config{srcdir}/$f" && - ! -l "$config{srcdir}/$f") { - push @files, $f; - $exists{pagename($f)}=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 (! $exists{$page}) { + push @files, $f; + $exists{$page}=1; + } + } } } - } - }, - }, $config{underlaydir}); - - my %rendered; + }, + }, $dir); + }; + my (%rendered, @add, @del, @internal); # check for added or removed pages - my @add; foreach my $file (@files) { my $page=pagename($file); - if (! $oldpagemtime{$page}) { - push @add, $file; - $pagecase{lc $page}=$page; - $pagesources{$page}=$file; - if ($config{getctime} && -e "$config{srcdir}/$file") { - $pagectime{$page}=rcs_getctime("$config{srcdir}/$file"); + if (exists $pagesources{$page} && $pagesources{$page} ne $file) { + # the page has changed its type + $forcerebuild{$page}=1; + } + $pagesources{$page}=$file; + if (! $pagemtime{$page}) { + if (isinternal($page)) { + push @internal, $file; } - elsif (! exists $pagectime{$page}) { - $pagectime{$page}=mtime(srcfile($file)); + else { + push @add, $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}) { + $pagectime{$page}=(srcfile_stat($file))[10]; } } } - my @del; - foreach my $page (keys %oldpagemtime) { + foreach my $page (keys %pagemtime) { if (! $exists{$page}) { - debug("removing old page $page"); - push @del, $pagesources{$page}; + if (isinternal($page)) { + push @internal, $pagesources{$page}; + } + else { + debug(sprintf(gettext("removing old page %s"), $page)); + push @del, $pagesources{$page}; + } $links{$page}=[]; $renderedfiles{$page}=[]; - $oldpagemtime{$page}=0; + $pagemtime{$page}=0; prune($config{destdir}."/".$_) foreach @{$oldrenderedfiles{$page}}; delete $pagesources{$page}; + foreach (keys %destsources) { + if ($destsources{$_} eq $page) { + delete $destsources{$_}; + } + } } } - # scan changed and new files - my @changed; + # find changed and new files + my @needsbuild; foreach my $file (@files) { my $page=pagename($file); - - if (! exists $oldpagemtime{$page} || - mtime(srcfile($file)) > $oldpagemtime{$page} || + my ($srcfile, @stat)=srcfile_stat($file); + if (! exists $pagemtime{$page} || + $stat[9] > $pagemtime{$page} || $forcerebuild{$page}) { - debug("scanning $file"); - push @changed, $file; - scan($file); + $pagemtime{$page}=$stat[9]; + if (isinternal($page)) { + push @internal, $file; + # Preprocess internal page in scan-only mode. + preprocess($page, $page, readfile($srcfile), 1); + } + else { + push @needsbuild, $file; + } } } - calculate_backlinks(); + run_hooks(needsbuild => sub { shift->(\@needsbuild) }); - # render changed and new pages - foreach my $file (@changed) { - debug("rendering $file"); + # scan and render files + foreach my $file (@needsbuild) { + debug(sprintf(gettext("scanning %s"), $file)); + scan($file); + } + calculate_backlinks(); + foreach my $file (@needsbuild) { + debug(sprintf(gettext("rendering %s"), $file)); render($file); $rendered{$file}=1; } + foreach my $file (@internal) { + # internal pages are not rendered + my $page=pagename($file); + delete $depends{$page}; + foreach my $old (@{$renderedfiles{$page}}) { + delete $destsources{$old}; + } + $renderedfiles{$page}=[]; + } # rebuild pages that link to added or removed pages if (@add || @del) { @@ -321,24 +423,28 @@ sub refresh () { #{{{ foreach my $page (keys %{$backlinks{$p}}) { my $file=$pagesources{$page}; next if $rendered{$file}; - debug("rendering $file, which links to $p"); + debug(sprintf(gettext("rendering %s, which links to %s"), $file, $p)); render($file); $rendered{$file}=1; } } } - if (%rendered || @del) { + if (%rendered || @del || @internal) { + my @changed=(keys %rendered, @del); + # rebuild dependant pages foreach my $f (@files) { next if $rendered{$f}; my $p=pagename($f); if (exists $depends{$p}) { - foreach my $file (keys %rendered, @del) { + # only consider internal files + # if the page explicitly depends on such files + foreach my $file (@changed, $depends{$p}=~/internal\(/ ? @internal : ()) { next if $f eq $file; my $page=pagename($file); - if (pagespec_match($page, $depends{$p})) { - debug("rendering $f, which depends on $page"); + if (pagespec_match($page, $depends{$p}, location => $p)) { + debug(sprintf(gettext("rendering %s, which depends on %s"), $f, $page)); render($f); $rendered{$f}=1; last; @@ -350,7 +456,7 @@ sub refresh () { #{{{ # handle backlinks; if a page has added/removed links, # update the pages it links to my %linkchanged; - foreach my $file (keys %rendered, @del) { + foreach my $file (@changed) { my $page=pagename($file); if (exists $links{$page}) { @@ -372,11 +478,12 @@ sub refresh () { #{{{ } } } + foreach my $link (keys %linkchanged) { my $linkfile=$pagesources{$link}; if (defined $linkfile) { next if $rendered{$linkfile}; - debug("rendering $linkfile, to update its backlinks"); + debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile)); render($linkfile); $rendered{$linkfile}=1; } @@ -388,7 +495,7 @@ sub refresh () { #{{{ my $page=pagename($src); foreach my $file (@{$oldrenderedfiles{$page}}) { if (! grep { $_ eq $file } @{$renderedfiles{$page}}) { - debug("removing $file, no longer rendered by $page"); + debug(sprintf(gettext("removing %s, no longer rendered by %s"), $file, $page)); prune($config{destdir}."/".$file); } } @@ -400,11 +507,9 @@ sub refresh () { #{{{ if (%rendered) { run_hooks(change => sub { shift->(keys %rendered) }); } -} #}}} +} -sub commandline_render () { #{{{ - loadplugins(); - checkconfig(); +sub commandline_render () { lockwiki(); loadindex(); unlockwiki(); @@ -414,17 +519,19 @@ sub commandline_render () { #{{{ $file=~s/\Q$config{srcdir}\E\/?//; my $type=pagetype($file); - die "ikiwiki: cannot render $srcfile\n" unless defined $type; + die sprintf(gettext("ikiwiki: cannot render %s"), $srcfile)."\n" unless defined $type; my $content=readfile($srcfile); my $page=pagename($file); $pagesources{$page}=$file; - $content=filter($page, $content); + $content=filter($page, $page, $content); $content=preprocess($page, $page, $content); $content=linkify($page, $page, $content); - $content=htmlize($page, $type, $content); + $content=htmlize($page, $page, $type, $content); + $pagemtime{$page}=(stat($srcfile))[9]; + $pagectime{$page}=$pagemtime{$page} if ! exists $pagectime{$page}; - print genpage($page, $content, mtime($srcfile)); + print genpage($page, $content); exit 0; -} #}}} +} 1