X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ac7b1c32b1356dab71fd13d303d58d4bdb212941..376944cb026945ab597db01eb1e3aea4fa320007:/IkiWiki/Render.pm diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index d23dfdc25..2682e13ae 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -4,78 +4,47 @@ package IkiWiki; use warnings; use strict; -use File::Spec; use IkiWiki; - -sub linkify ($$$) { #{{{ - my $lpage=shift; - my $page=shift; - my $content=shift; - - $content =~ s{(\\?)$config{wiki_link_regexp}}{ - $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2))) - : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3))) - }eg; - - return $content; -} #}}} - -sub htmlize ($$) { #{{{ - my $type=shift; - my $content=shift; - - if (! $INC{"/usr/bin/markdown"}) { - no warnings 'once'; - $blosxom::version="is a proper perl module too much to ask?"; - use warnings 'all'; - do "/usr/bin/markdown"; - use Encode; - } - - if ($type eq '.mdwn') { - # XXX explanation of this insanity wating on perl bug number - $content=Encode::encode_utf8($content); - $content=Encode::encode_utf8($content); - $content=Markdown::Markdown($content); - $content=Encode::decode_utf8($content); - $content=Encode::decode_utf8($content); - } - else { - error("htmlization of $type not supported"); - } - - if (exists $hooks{sanitize}) { - foreach my $id (keys %{$hooks{sanitize}}) { - $content=$hooks{sanitize}{$id}{call}->($content); +use Encode; + +my %backlinks; +my $backlinks_calculated=0; + +sub calculate_backlinks () { #{{{ + return if $backlinks_calculated; + %backlinks=(); + foreach my $page (keys %links) { + foreach my $link (@{$links{$page}}) { + my $bestlink=bestlink($page, $link); + if (length $bestlink && $bestlink ne $page) { + $backlinks{$bestlink}{$page}=1; + } } } - - return $content; + $backlinks_calculated=1; } #}}} sub backlinks ($) { #{{{ my $page=shift; + calculate_backlinks(); + my @links; - foreach my $p (keys %links) { - next if bestlink($page, $p) eq $page; - if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) { - my $href=File::Spec->abs2rel(htmlpage($p), dirname($page)); - - # Trim common dir prefixes from both pages. - my $p_trimmed=$p; - my $page_trimmed=$page; - my $dir; - 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) && - defined $dir && - $p_trimmed=~s/^\Q$dir\E// && - $page_trimmed=~s/^\Q$dir\E//; - - push @links, { url => $href, page => $p_trimmed }; - } + foreach my $p (keys %{$backlinks{$page}}) { + my $href=urlto($p, $page); + + # Trim common dir prefixes from both pages. + my $p_trimmed=$p; + my $page_trimmed=$page; + my $dir; + 1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) && + defined $dir && + $p_trimmed=~s/^\Q$dir\E// && + $page_trimmed=~s/^\Q$dir\E//; + + push @links, { url => $href, page => pagetitle($p_trimmed) }; } - - return sort { $a->{page} cmp $b->{page} } @links; + return @links; } #}}} sub parentlinks ($) { #{{{ @@ -84,106 +53,38 @@ sub parentlinks ($) { #{{{ my @ret; my $pagelink=""; my $path=""; - my $skip=1; - foreach my $dir (reverse split("/", $page)) { - if (! $skip) { - $path.="../"; - unshift @ret, { url => "$path$dir.html", page => $dir }; - } - else { - $skip=0; - } + my $title=$config{wikiname}; + + foreach my $dir (split("/", $page)) { + next if $dir eq 'index'; + push @ret, { url => urlto($path, $page), page => $title }; + $path.="/".$dir; + $title=pagetitle($dir); } - unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} }; return @ret; } #}}} -sub preprocess ($$;$) { #{{{ +sub genpage ($$) { #{{{ my $page=shift; my $content=shift; - my $onlystrip=shift || 0; # strip directives without processing - - my $handle=sub { - my $escape=shift; - my $command=shift; - my $params=shift; - if (length $escape) { - return "[[$command $params]]"; - } - elsif ($onlystrip) { - return ""; - } - elsif (exists $hooks{preprocess}{$command}) { - # Note: preserve order of params, some plugins may - # consider it significant. - my @params; - while ($params =~ /(\w+)=\"?([^"]+)"?(\s+|$)/g) { - push @params, $1, $2; - } - return $hooks{preprocess}{$command}{call}->(@params, page => $page); - } - else { - return "[[$command not processed]]"; - } - }; - - $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg; - return $content; -} #}}} -sub add_depends ($$) { #{{{ - my $page=shift; - my $globlist=shift; - - if (! exists $depends{$page}) { - $depends{$page}=$globlist; - } - else { - $depends{$page}=globlist_merge($depends{$page}, $globlist); - } -} # }}} - -sub globlist_merge ($$) { #{{{ - my $a=shift; - my $b=shift; - - my $ret=""; - # Only add negated globs if they are not matched by the other globlist. - foreach my $i ((map { [ $a, $_ ] } split(" ", $b)), - (map { [ $b, $_ ] } split(" ", $a))) { - if ($i->[1]=~/^!(.*)/) { - if (! globlist_match($1, $i->[0])) { - $ret.=" ".$i->[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; } - else { - $ret.=" ".$i->[1]; - } - } - - return $ret; -} #}}} - -sub genpage ($$$) { #{{{ - my $page=shift; - my $content=shift; - my $mtime=shift; - - my $title=pagetitle(basename($page)); - - my $template=HTML::Template->new(blind_cache => 1, - filename => "$config{templatedir}/page.tmpl"); + }); + 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 => pagetitle($page, 1))); $template->param(prefsurl => cgiurl(do => "prefs")); - if ($config{rcs}) { - $template->param(recentchangesurl => cgiurl(do => "recentchanges")); - } $actions++; } - + if (length $config{historyurl}) { my $u=$config{historyurl}; $u=~s/\[\[file\]\]/$pagesources{$page}/g; @@ -191,55 +92,58 @@ sub genpage ($$$) { #{{{ $actions++; } if ($config{discussion}) { - $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1)); - $actions++; + 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 => $title, + title => $page eq 'index' + ? $config{wikiname} + : pagetitle(basename($page)), wikiname => $config{wikiname}, parentlinks => [parentlinks($page)], content => $content, - backlinks => [backlinks($page)], - mtime => displaytime($mtime), - styleurl => styleurl($page), + backlinks => $backlinks, + more_backlinks => $more_backlinks, + mtime => displaytime($pagemtime{$page}), + ctime => displaytime($pagectime{$page}), + baseurl => baseurl($page), ); - if (exists $hooks{pagetemplate}) { - foreach my $id (keys %{$hooks{pagetemplate}}) { - $hooks{pagetemplate}{$id}{call}->($page, $template); - } - } + run_hooks(pagetemplate => sub { + shift->(page => $page, destpage => $page, template => $template); + }); - return $template->output; -} #}}} + $content=$template->output; -sub check_overwrite ($$) { #{{{ - # Important security check. Make sure to call this before saving - # any files to the source directory. - my $dest=shift; - my $src=shift; - - if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) { - error("$dest already exists and was rendered from ". - join(" ",(grep { $renderedfiles{$_} eq $dest } keys - %renderedfiles)). - ", before, so not rendering from $src"); - } -} #}}} + run_hooks(format => sub { + $content=shift->( + page => $page, + content => $content, + ); + }); -sub displaytime ($) { #{{{ - my $time=shift; - - eval q{use POSIX}; - # strftime doesn't know about encodings, so make sure - # its output is properly treated as utf8 - return Encode::decode_utf8(POSIX::strftime( - $config{timeformat}, localtime($time))); + return $content; } #}}} sub mtime ($) { #{{{ @@ -248,21 +152,36 @@ sub mtime ($) { #{{{ return (stat($file))[9]; } #}}} -sub findlinks ($$) { #{{{ - my $page=shift; - my $content=shift; +sub scan ($) { #{{{ + my $file=shift; - my @links; - while ($content =~ /(?( - page => $page, - content => $content - ); - } - } - - $links{$page}=[findlinks($page, $content)]; + my $content=htmlize($page, $type, + linkify($page, $page, + preprocess($page, $page, + filter($page, $page, + readfile($srcfile))))); - $content=linkify($page, $page, $content); - $content=preprocess($page, $content); - $content=htmlize($type, $content); - - check_overwrite("$config{destdir}/".htmlpage($page), $page); - writefile(htmlpage($page), $config{destdir}, - genpage($page, $content, mtime($srcfile))); - $oldpagemtime{$page}=time; - $renderedfiles{$page}=htmlpage($page); + my $output=htmlpage($page); + writefile($output, $config{destdir}, genpage($page, $content)); } else { - my $content=readfile($srcfile, 1); - $links{$file}=[]; + my $srcfd=readfile($srcfile, 1, 1); delete $depends{$file}; - check_overwrite("$config{destdir}/$file", $file); - writefile($file, $config{destdir}, $content, 1); - $oldpagemtime{$file}=time; - $renderedfiles{$file}=$file; + will_render($file, $file, 1); + writefile($file, $config{destdir}, undef, 1, sub { + 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 $file: $!", $cleanup); + $len -= $written; + $offset += $written; + } + } + }); } } #}}} @@ -319,20 +243,35 @@ sub prune ($) { #{{{ } #}}} sub refresh () { #{{{ + # security check, avoid following symlinks in the srcdir path + my $test=$config{srcdir}; + while (length $test) { + if (-l $test) { + error("symlink found in srcdir path ($test)"); + } + unless ($test=~s/\/+$//) { + $test=dirname($test); + } + } + + run_hooks(refresh => sub { shift->() }); + # find existing pages my %exists; my @files; eval q{use File::Find}; + error($@) if $@; find({ no_chdir => 1, wanted => sub { - if (/$config{wiki_file_prune_regexp}/) { + $_=decode_utf8($_); + if (file_pruned($_, $config{srcdir})) { $File::Find::prune=1; } elsif (! -d $_ && ! -l $_) { 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\/?//; @@ -342,110 +281,161 @@ sub refresh () { #{{{ } }, }, $config{srcdir}); - find({ - no_chdir => 1, - wanted => sub { - if (/$config{wiki_file_prune_regexp}/) { - $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 (! -d $_ && ! -l $_) { + 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 (! -e "$config{srcdir}/$f" && + ! -l "$config{srcdir}/$f") { + my $page=pagename($f); + if (! $exists{$page}) { + push @files, $f; + $exists{$page}=1; + } + } } } - } - }, - }, $config{underlaydir}); + }, + }, $dir); + }; - my %rendered; + my (%rendered, @add, @del, @internal); # check for added or removed pages - my @add; foreach my $file (@files) { my $page=pagename($file); - if (! $oldpagemtime{$page}) { - debug("new page $page") unless exists $pagectime{$page}; - push @add, $file; - $links{$page}=[]; - $pagesources{$page}=$file; + $pagesources{$page}=$file; + if (! $pagemtime{$page}) { + if (isinternal($page)) { + push @internal, $file; + } + else { + push @add, $file; + } + $pagecase{lc $page}=$page; if ($config{getctime} && -e "$config{srcdir}/$file") { - $pagectime{$page}=rcs_getctime("$config{srcdir}/$file"); + eval { + my $time=rcs_getctime("$config{srcdir}/$file"); + $pagectime{$page}=$time; + }; + if ($@) { + print STDERR $@; + } } - elsif (! exists $pagectime{$page}) { + if (! exists $pagectime{$page}) { $pagectime{$page}=mtime(srcfile($file)); } } } - my @del; - foreach my $page (keys %oldpagemtime) { + foreach my $page (keys %pagemtime) { if (! $exists{$page}) { - debug("removing old page $page"); - push @del, $pagesources{$page}; - prune($config{destdir}."/".$renderedfiles{$page}); - delete $renderedfiles{$page}; - $oldpagemtime{$page}=0; + if (isinternal($page)) { + push @internal, $pagesources{$page}; + } + else { + debug(sprintf(gettext("removing old page %s"), $page)); + push @del, $pagesources{$page}; + } + $links{$page}=[]; + $renderedfiles{$page}=[]; + $pagemtime{$page}=0; + prune($config{destdir}."/".$_) + foreach @{$oldrenderedfiles{$page}}; delete $pagesources{$page}; + foreach (keys %destsources) { + if ($destsources{$_} eq $page) { + delete $destsources{$_}; + } + } } } - - # render any updated files + + # find changed and new files + my @needsbuild; foreach my $file (@files) { my $page=pagename($file); - if (! exists $oldpagemtime{$page} || - mtime(srcfile($file)) > $oldpagemtime{$page}) { - debug("rendering changed file $file"); - render($file); - $rendered{$file}=1; + my $mtime=mtime(srcfile($file)); + if (! exists $pagemtime{$page} || + $mtime > $pagemtime{$page} || + $forcerebuild{$page}) { + $pagemtime{$page}=$mtime; + if (isinternal($page)) { + push @internal, $file; + # Preprocess internal page in scan-only mode. + preprocess($page, $page, readfile(srcfile($file)), 1); + } + else { + push @needsbuild, $file; + } } } + run_hooks(needsbuild => sub { shift->(\@needsbuild) }); + + # 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}=[]; + } - # if any files were added or removed, check to see if each page - # needs an update due to linking to them or inlining them. - # TODO: inefficient; pages may get rendered above and again here; - # problem is the bestlink may have changed and we won't know until - # now + # rebuild pages that link to added or removed pages if (@add || @del) { -FILE: foreach my $file (@files) { - my $page=pagename($file); - foreach my $f (@add, @del) { - my $p=pagename($f); - foreach my $link (@{$links{$page}}) { - if (bestlink($page, $link) eq $p) { - debug("rendering $file, which links to $p"); - render($file); - $rendered{$file}=1; - next FILE; - } - } + foreach my $f (@add, @del) { + my $p=pagename($f); + foreach my $page (keys %{$backlinks{$p}}) { + my $file=$pagesources{$page}; + next if $rendered{$file}; + debug(sprintf(gettext("rendering %s, which links to %s"), $file, $p)); + render($file); + $rendered{$file}=1; } } } - # Handle backlinks; if a page has added/removed links, update the - # pages it links to. Also handles rebuilding dependant pages. - # TODO: inefficient; pages may get rendered above and again here; - # problem is the backlinks could be wrong in the first pass render - # above - 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 (globlist_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; @@ -454,8 +444,10 @@ FILE: foreach my $file (@files) { } } + # 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}) { @@ -477,26 +469,61 @@ FILE: foreach my $file (@files) { } } } + foreach my $link (keys %linkchanged) { my $linkfile=$pagesources{$link}; if (defined $linkfile) { - debug("rendering $linkfile, to update its backlinks"); + next if $rendered{$linkfile}; + debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile)); render($linkfile); $rendered{$linkfile}=1; } } } - if (@del && exists $hooks{delete}) { - foreach my $id (keys %{$hooks{delete}}) { - $hooks{delete}{$id}{call}->(@del); + # remove no longer rendered files + foreach my $src (keys %rendered) { + my $page=pagename($src); + foreach my $file (@{$oldrenderedfiles{$page}}) { + if (! grep { $_ eq $file } @{$renderedfiles{$page}}) { + debug(sprintf(gettext("removing %s, no longer rendered by %s"), $file, $page)); + prune($config{destdir}."/".$file); + } } } - if (%rendered && exists $hooks{change}) { - foreach my $id (keys %{$hooks{change}}) { - $hooks{change}{$id}{call}->(keys %rendered); - } + + if (@del) { + run_hooks(delete => sub { shift->(@del) }); } + if (%rendered) { + run_hooks(change => sub { shift->(keys %rendered) }); + } +} #}}} + +sub commandline_render () { #{{{ + loadplugins(); + checkconfig(); + lockwiki(); + loadindex(); + unlockwiki(); + + my $srcfile=possibly_foolish_untaint($config{render}); + my $file=$srcfile; + $file=~s/\Q$config{srcdir}\E\/?//; + + my $type=pagetype($file); + 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, $page, $content); + $content=preprocess($page, $page, $content); + $content=linkify($page, $page, $content); + $content=htmlize($page, $type, $content); + $pagemtime{$page}=mtime($srcfile); + + print genpage($page, $content); + exit 0; } #}}} 1