X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/efe91335c65b96f3eb8b32d8c58c9cce68db47b4..267f98e2e116739872cafc6bb712280c31376705:/IkiWiki/Render.pm diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 9e340c26e..02dbd34bd 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -1,16 +1,20 @@ +#!/usr/bin/perl + package IkiWiki; use warnings; use strict; -use File::Spec; +use IkiWiki; +use Encode; -sub linkify ($$) { #{{{ +sub linkify ($$$) { #{{{ + my $lpage=shift; # the page containing the links + my $page=shift; # the page the link will end up on (different for inline) 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))) + $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2))) + : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3))) }eg; return $content; @@ -20,19 +24,20 @@ 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); + if (exists $hooks{htmlize}{$type}) { + $content=$hooks{htmlize}{$type}{call}->($content); } else { error("htmlization of $type not supported"); } + + if (exists $hooks{sanitize}) { + foreach my $id (keys %{$hooks{sanitize}}) { + $content=$hooks{sanitize}{$id}{call}->($content); + } + } + + return $content; } #}}} sub backlinks ($) { #{{{ @@ -42,7 +47,7 @@ sub backlinks ($) { #{{{ 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)); + my $href=abs2rel(htmlpage($p), dirname($page)); # Trim common dir prefixes from both pages. my $p_trimmed=$p; @@ -67,6 +72,7 @@ sub parentlinks ($) { #{{{ my $pagelink=""; my $path=""; my $skip=1; + return if $page eq 'index'; # toplevel foreach my $dir (reverse split("/", $page)) { if (! $skip) { $path.="../"; @@ -80,35 +86,42 @@ 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; +sub preprocess ($$$;$) { #{{{ + my $page=shift; # the page the data comes from + my $destpage=shift; # the page the data will appear in (different for inline) my $content=shift; - my %commands=@_; - + my $onlystrip=shift || 0; # strip directives without processing + my $handle=sub { my $escape=shift; my $command=shift; my $params=shift; if (length $escape) { - "[[$command $params]]"; + return "[[$command $params]]"; + } + elsif ($onlystrip) { + return ""; } - elsif (exists $commands{$command}) { - my %params; - while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) { - $params{$1}=$2; + elsif (exists $hooks{preprocess}{$command}) { + # Note: preserve order of params, some plugins may + # consider it significant. + my @params; + while ($params =~ /(?:(\w+)=)?(?:"([^"]+)"|(\S+))(?:\s+|$)/g) { + if (defined $1) { + push @params, $1, (defined $2 ? $2 : $3); + } + else { + push @params, (defined $2 ? $2 : $3), ''; + } } - $commands{$command}->($page, %params); + return $hooks{preprocess}{$command}{call}->( + @params, + page => $page, + destpage => $destpage, + ); } else { - "[[bad directive $command]]"; + return "[[$command not processed]]"; } }; @@ -116,186 +129,92 @@ sub postprocess { #{{{ return $content; } #}}} -sub blog_list ($$) { #{{{ +sub add_depends ($$) { #{{{ + my $page=shift; 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)); + if (! exists $depends{$page}) { + $depends{$page}=$globlist; } else { - return ""; + $depends{$page}=globlist_merge($depends{$page}, $globlist); } -} #}}} +} # }}} + +sub globlist_merge ($$) { #{{{ + my $a=shift; + my $b=shift; -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; + # 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]; + } + } + else { + $ret.=" ".$i->[1]; + } } - return "

$ret

"; + 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)), + mtime => displaytime($mtime), styleurl => styleurl($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}; + if (exists $hooks{pagetemplate}) { + foreach my $id (keys %{$hooks{pagetemplate}}) { + $hooks{pagetemplate}{$id}{call}->( + page => $page, + destpage => $page, + template => $template, + ); } - - return ""; - }; - - $content = postprocess($page, $content, inline => $gen_blog); - - $template->param( - title => $config{wikiname}, - pageurl => $url, - items => \@items, - ); + } return $template->output; } #}}} @@ -307,13 +226,20 @@ sub check_overwrite ($$) { #{{{ 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"); + error("$dest already exists and was not rendered from $src before"); } } #}}} +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 decode_utf8(POSIX::strftime( + $config{timeformat}, localtime($time))); +} #}}} + sub mtime ($) { #{{{ my $file=shift; @@ -321,51 +247,69 @@ sub mtime ($) { #{{{ } #}}} sub findlinks ($$) { #{{{ - my $content=shift; my $page=shift; + my $content=shift; my @links; while ($content =~ /(?( + page => $page, + content => $content + ); + } + } + + return $content; +} + sub render ($) { #{{{ my $file=shift; my $type=pagetype($file); my $srcfile=srcfile($file); - my $content=readfile($srcfile); - if ($type ne 'unknown') { + if (defined $type) { + my $content=readfile($srcfile); my $page=pagename($file); + delete $depends{$page}; - $links{$page}=[findlinks($content, $page)]; - delete $inlinepages{$page}; + $content=filter($page, $content); - $content=linkify($content, $page); + $links{$page}=[findlinks($page, $content)]; + + $content=linkify($page, $page, $content); + $content=preprocess($page, $page, $content); $content=htmlize($type, $content); check_overwrite("$config{destdir}/".htmlpage($page), $page); writefile(htmlpage($page), $config{destdir}, - genpage($content, $page, mtime($srcfile))); + genpage($page, $content, mtime($srcfile))); $oldpagemtime{$page}=time; $renderedfiles{$page}=htmlpage($page); - - # TODO: should really add this to renderedfiles and call - # check_overwrite, as above, but currently renderedfiles - # only supports listing one file per page. - if ($config{rss} && exists $inlinepages{$page}) { - writefile(rsspage($page), $config{destdir}, - genrss($content, $page, mtime($srcfile))); - } } else { + my $content=readfile($srcfile, 1); $links{$file}=[]; + delete $depends{$file}; check_overwrite("$config{destdir}/$file", $file); - writefile($file, $config{destdir}, $content); + writefile($file, $config{destdir}, $content, 1); $oldpagemtime{$file}=time; $renderedfiles{$file}=$file; } @@ -389,6 +333,7 @@ sub refresh () { #{{{ find({ no_chdir => 1, wanted => sub { + $_=decode_utf8($_); if (/$config{wiki_file_prune_regexp}/) { $File::Find::prune=1; } @@ -408,6 +353,7 @@ sub refresh () { #{{{ find({ no_chdir => 1, wanted => sub { + $_=decode_utf8($_); if (/$config{wiki_file_prune_regexp}/) { $File::Find::prune=1; } @@ -441,8 +387,12 @@ sub refresh () { #{{{ push @add, $file; $links{$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; @@ -463,7 +413,7 @@ sub refresh () { #{{{ if (! exists $oldpagemtime{$page} || mtime(srcfile($file)) > $oldpagemtime{$page}) { - debug("rendering changed file $file"); + debug("rendering $file"); render($file); $rendered{$file}=1; } @@ -492,19 +442,21 @@ FILE: foreach my $file (@files) { } # Handle backlinks; if a page has added/removed links, update the - # pages it links to. Also handle inlining here. + # 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) { foreach my $f (@files) { 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 (globlist_match($page, $depends{$p})) { + debug("rendering $f, which depends on $page"); render($f); + $rendered{$f}=1; last; } } @@ -518,8 +470,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 +479,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; } } @@ -539,9 +491,21 @@ FILE: foreach my $file (@files) { if (defined $linkfile) { debug("rendering $linkfile, to update its backlinks"); render($linkfile); + $rendered{$linkfile}=1; } } } + + if (@del && exists $hooks{delete}) { + foreach my $id (keys %{$hooks{delete}}) { + $hooks{delete}{$id}{call}->(@del); + } + } + if (%rendered && exists $hooks{change}) { + foreach my $id (keys %{$hooks{change}}) { + $hooks{change}{$id}{call}->(keys %rendered); + } + } } #}}} 1