X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/975ae0944cdd18a510d803da7a499c2247ac855e..ff6941cef9a88ea2a0d3af2e5ae1edd09048916b:/IkiWiki/Render.pm diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 3d827d341..4033468b2 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -1,60 +1,49 @@ +#!/usr/bin/perl + package IkiWiki; use warnings; use strict; -use File::Spec; - -sub linkify ($$) { #{{{ - my $content=shift; - my $page=shift; - - $content =~ s{(\\?)$config{wiki_link_regexp}}{ - $2 ? ( $1 ? "[[$2|$3]]" : htmllink($page, titlepage($3), 0, 0, pagetitle($2))) - : ( $1 ? "[[$3]]" : htmllink($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"; - } - - if ($type eq '.mdwn') { - return Markdown::Markdown($content); - } - else { - error("htmlization of $type not supported"); +use IkiWiki; +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; + } + } } + $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)); + return unless $backlinks{$page}; + foreach my $p (keys %{$backlinks{$page}}) { + my $href=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 }; - } + # 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; @@ -67,10 +56,11 @@ sub parentlinks ($) { #{{{ 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$dir.html", page => $dir }; + unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) }; } else { $skip=0; @@ -80,238 +70,64 @@ sub parentlinks ($) { #{{{ return @ret; } #}}} -sub rsspage ($) { #{{{ - my $page=shift; - - return $page.".rss"; -} #}}} - -sub postprocess { #{{{ - # Takes content to postprocess followed by a list of postprocessor - # commands and subroutine references to run for the commands. - my $page=shift; - my $content=shift; - my %commands=@_; - - my $handle=sub { - my $escape=shift; - my $command=shift; - my $params=shift; - if (length $escape) { - "[[$command $params]]"; - } - elsif (exists $commands{$command}) { - my %params; - while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) { - $params{$1}=$2; - } - $commands{$command}->($page, %params); - } - else { - "[[bad directive $command]]"; - } - }; - - $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg; - return $content; -} #}}} - -sub blog_list ($$) { #{{{ - my $globlist=shift; - my $maxitems=shift; - - my @list; - foreach my $page (keys %pagesources) { - if (globlist_match($page, $globlist)) { - push @list, $page; - } - } - - @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list; - return @list if ! $maxitems || @list <= $maxitems; - return @list[0..$maxitems - 1]; -} #}}} - -sub get_inline_content ($$) { #{{{ - my $parentpage=shift; - my $page=shift; - - my $file=$pagesources{$page}; - my $type=pagetype($file); - if ($type ne 'unknown') { - return htmlize($type, linkify(readfile(srcfile($file)), $parentpage)); - } - else { - return ""; - } -} #}}} - -sub postprocess_html_inline { #{{{ - my $parentpage=shift; - my %params=@_; - - if (! exists $params{pages}) { - return ""; - } - if (! exists $params{archive}) { - $params{archive}="no"; - } - if (! exists $params{show} && $params{archive} eq "no") { - $params{show}=10; - } - $inlinepages{$parentpage}=$params{pages}; - - my $ret=""; - - if (exists $params{rootpage}) { - my $formtemplate=HTML::Template->new(blind_cache => 1, - filename => "$config{templatedir}/blogpost.tmpl"); - $formtemplate->param(cgiurl => $config{cgiurl}); - $formtemplate->param(rootpage => $params{rootpage}); - my $form=$formtemplate->output; - $ret.=$form; - } - - my $template=HTML::Template->new(blind_cache => 1, - filename => (($params{archive} eq "no") - ? "$config{templatedir}/inlinepage.tmpl" - : "$config{templatedir}/inlinepagetitle.tmpl")); - - foreach my $page (blog_list($params{pages}, $params{show})) { - next if $page eq $parentpage; - $template->param(pagelink => htmllink($parentpage, $page)); - $template->param(content => get_inline_content($parentpage, $page)) - if $params{archive} eq "no"; - $template->param(ctime => scalar(gmtime($pagectime{$page}))); - $ret.=$template->output; - } - - return "

$ret

"; -} #}}} - sub genpage ($$$) { #{{{ - my $content=shift; my $page=shift; + my $content=shift; my $mtime=shift; - $content = postprocess($page, $content, inline => \&postprocess_html_inline); - - my $title=pagetitle(basename($page)); - - my $template=HTML::Template->new(blind_cache => 1, - filename => "$config{templatedir}/page.tmpl"); - + my $template=template("page.tmpl", blind_cache => 1); + my $actions=0; + if (length $config{cgiurl}) { $template->param(editurl => cgiurl(do => "edit", page => $page)); $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; $template->param(historyurl => $u); + $actions++; + } + if ($config{discussion}) { + $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1)); + $actions++; } - if ($config{rss} && $inlinepages{$page}) { - $template->param(rssurl => rsspage(basename($page))); + if ($actions) { + $template->param(have_actions => 1); } - + $template->param( - title => $title, + title => $page eq 'index' + ? $config{wikiname} + : pagetitle(basename($page)), wikiname => $config{wikiname}, parentlinks => [parentlinks($page)], content => $content, backlinks => [backlinks($page)], - discussionlink => htmllink($page, "Discussion", 1, 1), - mtime => scalar(gmtime($mtime)), - styleurl => styleurl($page), + mtime => displaytime($mtime), + baseurl => baseurl($page), ); - - return $template->output; -} #}}} - -sub date_822 ($) { #{{{ - my $time=shift; - - eval q{use POSIX}; - return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time)); -} #}}} - -sub absolute_urls ($$) { #{{{ - # sucky sub because rss sucks - my $content=shift; - my $url=shift; - - $url=~s/[^\/]+$//; - - $content=~s/new(blind_cache => 1, - filename => "$config{templatedir}/rsspage.tmpl"); - - my @items; - my $isblog=0; - my $gen_blog=sub { - my $parentpage=shift; - my %params=@_; - - if (! exists $params{show}) { - $params{show}=10; - } - if (! exists $params{pages}) { - return ""; - } - - $isblog=1; - foreach my $page (blog_list($params{pages}, $params{show})) { - next if $page eq $parentpage; - push @items, { - itemtitle => pagetitle(basename($page)), - itemurl => "$config{url}/$renderedfiles{$page}", - itempubdate => date_822($pagectime{$page}), - itemcontent => absolute_urls(get_inline_content($parentpage, $page), $url), - } if exists $renderedfiles{$page}; - } - - return ""; - }; + run_hooks(pagetemplate => sub { + shift->(page => $page, destpage => $page, template => $template); + }); - $content = postprocess($page, $content, inline => $gen_blog); + $content=$template->output; - $template->param( - title => $config{wikiname}, - pageurl => $url, - items => \@items, - ); - - return $template->output; -} #}}} + run_hooks(format => sub { + $content=shift->( + page => $page, + content => $content, + ); + }); -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"); - } + return $content; } #}}} sub mtime ($) { #{{{ @@ -320,17 +136,37 @@ sub mtime ($) { #{{{ return (stat($file))[9]; } #}}} -sub findlinks ($$) { #{{{ - my $content=shift; - my $page=shift; +sub scan ($) { #{{{ + my $file=shift; - my @links; - while ($content =~ /(? 1, wanted => sub { - if (/$config{wiki_file_prune_regexp}/) { + $_=decode_utf8($_); + if (file_pruned($_, $config{srcdir})) { $File::Find::prune=1; } elsif (! -d $_ && ! -l $_) { @@ -408,7 +237,8 @@ sub refresh () { #{{{ find({ no_chdir => 1, wanted => sub { - if (/$config{wiki_file_prune_regexp}/) { + $_=decode_utf8($_); + if (file_pruned($_, $config{underlaydir})) { $File::Find::prune=1; } elsif (! -d $_ && ! -l $_) { @@ -437,12 +267,15 @@ sub refresh () { #{{{ foreach my $file (@files) { my $page=pagename($file); if (! $oldpagemtime{$page}) { - debug("new page $page") unless exists $pagectime{$page}; push @add, $file; - $links{$page}=[]; + $pagecase{lc $page}=$page; $pagesources{$page}=$file; - $pagectime{$page}=mtime(srcfile($file)) - unless exists $pagectime{$page}; + if ($config{getctime} && -e "$config{srcdir}/$file") { + $pagectime{$page}=rcs_getctime("$config{srcdir}/$file"); + } + elsif (! exists $pagectime{$page}) { + $pagectime{$page}=mtime(srcfile($file)); + } } } my @del; @@ -450,67 +283,72 @@ sub refresh () { #{{{ if (! $exists{$page}) { debug("removing old page $page"); push @del, $pagesources{$page}; - prune($config{destdir}."/".$renderedfiles{$page}); - delete $renderedfiles{$page}; + $links{$page}=[]; + $renderedfiles{$page}=[]; $oldpagemtime{$page}=0; + prune($config{destdir}."/".$_) + foreach @{$oldrenderedfiles{$page}}; delete $pagesources{$page}; } } - - # render any updated files + + # scan changed and new files + my @changed; 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; + mtime(srcfile($file)) > $oldpagemtime{$page} || + $forcerebuild{$page}) { + debug("scanning $file"); + push @changed, $file; + scan($file); } } + calculate_backlinks(); + + # render changed and new pages + foreach my $file (@changed) { + debug("rendering $file"); + render($file); + $rendered{$file}=1; + } - # 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("rendering $file, which links to $p"); + render($file); + $rendered{$file}=1; } } } - # Handle backlinks; if a page has added/removed links, update the - # pages it links to. Also handle inlining here. - # 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) { + # rebuild dependant pages foreach my $f (@files) { + next if $rendered{$f}; my $p=pagename($f); - if (exists $inlinepages{$p}) { + if (exists $depends{$p}) { foreach my $file (keys %rendered, @del) { + next if $f eq $file; my $page=pagename($file); - if (globlist_match($page, $inlinepages{$p})) { - debug("rendering $f, which inlines $page"); + if (pagespec_match($page, $depends{$p})) { + debug("rendering $f, which depends on $page"); render($f); + $rendered{$f}=1; last; } } } } + # handle backlinks; if a page has added/removed links, + # update the pages it links to my %linkchanged; foreach my $file (keys %rendered, @del) { my $page=pagename($file); @@ -518,8 +356,8 @@ FILE: foreach my $file (@files) { if (exists $links{$page}) { foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) { if (length $link && - ! exists $oldlinks{$page} || - ! grep { $_ eq $link } @{$oldlinks{$page}}) { + (! exists $oldlinks{$page} || + ! grep { bestlink($page, $_) eq $link } @{$oldlinks{$page}})) { $linkchanged{$link}=1; } } @@ -527,8 +365,8 @@ FILE: foreach my $file (@files) { if (exists $oldlinks{$page}) { foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) { if (length $link && - ! exists $links{$page} || - ! grep { $_ eq $link } @{$links{$page}}) { + (! exists $links{$page} || + ! grep { bestlink($page, $_) eq $link } @{$links{$page}})) { $linkchanged{$link}=1; } } @@ -537,11 +375,56 @@ FILE: foreach my $file (@files) { foreach my $link (keys %linkchanged) { my $linkfile=$pagesources{$link}; if (defined $linkfile) { + next if $rendered{$linkfile}; debug("rendering $linkfile, to update its backlinks"); render($linkfile); + $rendered{$linkfile}=1; } } } + + # 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("removing $file, no longer rendered by $page"); + prune($config{destdir}."/".$file); + } + } + } + + 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 "ikiwiki: cannot render $srcfile\n" unless defined $type; + my $content=readfile($srcfile); + my $page=pagename($file); + $pagesources{$page}=$file; + $content=filter($page, $content); + $content=preprocess($page, $page, $content); + $content=linkify($page, $page, $content); + $content=htmlize($page, $type, $content); + + print genpage($page, $content, mtime($srcfile)); + exit 0; } #}}} 1