X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/0d9539d577886549b51d2bf70167db05f3f2514c..281f8fd4973776b5270d9e87b77ce37aadbdb0b9:/IkiWiki/Render.pm
diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 8375cfe7a..2c1ea3eb7 100644
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -1,38 +1,48 @@
+#!/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;
} #}}}
-sub htmlize ($$) { #{{{
+sub htmlize ($$$) { #{{{
+ my $page=shift;
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}->(
+ page => $page,
+ content => $content,
+ );
}
else {
error("htmlization of $type not supported");
}
+
+ run_hooks(sanitize => sub {
+ $content=shift->(
+ page => $page,
+ content => $content,
+ );
+ });
+
+ return $content;
} #}}}
sub backlinks ($) { #{{{
@@ -42,7 +52,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;
@@ -53,7 +63,7 @@ sub backlinks ($) { #{{{
$p_trimmed=~s/^\Q$dir\E// &&
$page_trimmed=~s/^\Q$dir\E//;
- push @links, { url => $href, page => $p_trimmed };
+ push @links, { url => $href, page => pagetitle($p_trimmed) };
}
}
@@ -67,10 +77,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,227 +91,138 @@ 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 %preprocessing;
+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 $handle=sub {
my $escape=shift;
my $command=shift;
my $params=shift;
if (length $escape) {
- "[[$command $params]]";
+ return "[[$command $params]]";
}
- 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+|$)/sg) {
+ my $key=$1;
+ my $val;
+ if (defined $2) {
+ $val=$2;
+ $val=~s/\r\n/\n/mg;
+ $val=~s/^\n+//g;
+ $val=~s/\n+$//g;
+ }
+ elsif (defined $3) {
+ $val=$3;
+ }
+ elsif (defined $4) {
+ $val=$4;
+ }
+
+ if (defined $key) {
+ push @params, $key, $val;
+ }
+ else {
+ push @params, $val, '';
+ }
+ }
+ if ($preprocessing{$page}++ > 3) {
+ # Avoid loops of preprocessed pages preprocessing
+ # other pages that preprocess them, etc.
+ return "[[$command preprocessing loop detected on $page at depth $preprocessing{$page}]]";
}
- $commands{$command}->($page, %params);
+ my $ret=$hooks{preprocess}{$command}{call}->(
+ @params,
+ page => $page,
+ destpage => $destpage,
+ );
+ $preprocessing{$page}--;
+ return $ret;
}
else {
- "[[bad directive $command]]";
+ return "[[$command $params]]";
}
};
- $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg;
+ $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
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;
+sub add_depends ($$) { #{{{
my $page=shift;
+ my $pagespec=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}=$pagespec;
}
else {
- return "";
+ $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
}
-} #}}}
-
-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 "</p>$ret<p>";
-} #}}}
+} # }}}
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{hyperestraier}) {
- $template->param(hyperestraierurl => cgiurl());
+ 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/[^\/]+$//;
+ run_hooks(pagetemplate => sub {
+ shift->(page => $page, destpage => $page, template => $template);
+ });
- $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
- $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
- return $content;
-} #}}}
+ $content=$template->output;
-sub genrss ($$$) { #{{{
- my $content=shift;
- my $page=shift;
- my $mtime=shift;
-
- my $url="$config{url}/".htmlpage($page);
-
- my $template=HTML::Template->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 "";
- };
-
- $content = postprocess($page, $content, inline => $gen_blog);
+ run_hooks(format => sub {
+ $content=shift->(
+ page => $page,
+ content => $content,
+ );
+ });
- $template->param(
- title => $config{wikiname},
- pageurl => $url,
- items => \@items,
- );
-
- return $template->output;
+ return $content;
} #}}}
sub check_overwrite ($$) { #{{{
@@ -310,13 +232,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;
@@ -324,51 +253,64 @@ sub mtime ($) { #{{{
} #}}}
sub findlinks ($$) { #{{{
- my $content=shift;
my $page=shift;
+ my $content=shift;
my @links;
while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
push @links, titlepage($2);
}
- # Discussion links are a special case since they're not in the text
- # of the page, but on its template.
- return @links, "$page/discussion";
+ if ($config{discussion}) {
+ # Discussion links are a special case since they're not in the
+ # text of the page, but on its template.
+ return @links, "$page/discussion";
+ }
+ else {
+ return @links;
+ }
} #}}}
+sub filter ($$) {
+ my $page=shift;
+ my $content=shift;
+
+ run_hooks(filter => sub {
+ $content=shift->(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);
- $content=htmlize($type, $content);
+ $links{$page}=[findlinks($page, $content)];
+
+ $content=preprocess($page, $page, $content);
+ $content=linkify($page, $page, $content);
+ $content=htmlize($page, $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;
}
@@ -384,56 +326,6 @@ sub prune ($) { #{{{
}
} #}}}
-sub estcfg () { #{{{
- my $estdir="$config{wikistatedir}/hyperestraier";
- my $cgi=basename($config{cgiurl});
- $cgi=~s/\..*$//;
- open(TEMPLATE, ">$estdir/$cgi.tmpl") ||
- error("write $estdir/$cgi.tmpl: $!");
- print TEMPLATE misctemplate("search",
- "<!--ESTFORM-->\n\n<!--ESTRESULT-->\n\n<!--ESTINFO-->\n\n");
- close TEMPLATE;
- open(TEMPLATE, ">$estdir/$cgi.conf") ||
- error("write $estdir/$cgi.conf: $!");
- my $template=HTML::Template->new(
- filename => "$config{templatedir}/estseek.conf"
- );
- eval q{use Cwd 'abs_path'};
- $template->param(
- index => $estdir,
- tmplfile => "$estdir/$cgi.tmpl",
- destdir => abs_path($config{destdir}),
- url => $config{url},
- );
- print TEMPLATE $template->output;
- close TEMPLATE;
- symlink("/usr/lib/estraier/estseek.cgi",
- "$estdir/".basename($config{cgiurl})) ||
- error("symlink: $!");
-} # }}}
-
-sub estcmd ($;@) { #{{{
- my @params=split(' ', shift);
- push @params, "-cl", "$config{wikistatedir}/hyperestraier";
- if (@_) {
- push @params, "-";
- }
-
- my $pid=open(CHILD, "|-");
- if ($pid) {
- # parent
- foreach (@_) {
- print CHILD "$_\n";
- }
- close(CHILD) || error("estcmd @params exited nonzero: $?");
- }
- else {
- # child
- open(STDOUT, "/dev/null"); # shut it up (closing won't work)
- exec("estcmd", @params) || error("can't run estcmd");
- }
-} #}}}
-
sub refresh () { #{{{
# find existing pages
my %exists;
@@ -442,6 +334,7 @@ sub refresh () { #{{{
find({
no_chdir => 1,
wanted => sub {
+ $_=decode_utf8($_);
if (/$config{wiki_file_prune_regexp}/) {
$File::Find::prune=1;
}
@@ -461,6 +354,7 @@ sub refresh () { #{{{
find({
no_chdir => 1,
wanted => sub {
+ $_=decode_utf8($_);
if (/$config{wiki_file_prune_regexp}/) {
$File::Find::prune=1;
}
@@ -493,9 +387,14 @@ sub refresh () { #{{{
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;
@@ -515,8 +414,9 @@ sub refresh () { #{{{
my $page=pagename($file);
if (! exists $oldpagemtime{$page} ||
- mtime(srcfile($file)) > $oldpagemtime{$page}) {
- debug("rendering changed file $file");
+ mtime(srcfile($file)) > $oldpagemtime{$page} ||
+ $forcerebuild{$page}) {
+ debug("rendering $file");
render($file);
$rendered{$file}=1;
}
@@ -545,18 +445,19 @@ 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 (pagespec_match($page, $depends{$p})) {
+ debug("rendering $f, which depends on $page");
render($f);
$rendered{$f}=1;
last;
@@ -572,8 +473,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;
}
}
@@ -581,8 +482,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;
}
}
@@ -598,19 +499,11 @@ FILE: foreach my $file (@files) {
}
}
- if ($config{hyperestraier} && (%rendered || @del)) {
- debug("updating hyperestraier search index");
- if (%rendered) {
- estcmd("gather -cm -bc -cl -sd",
- map { $config{destdir}."/".$renderedfiles{pagename($_)} }
- keys %rendered);
- }
- if (@del) {
- estcmd("purge -cl");
- }
-
- debug("generating hyperestraier cgi config");
- estcfg();
+ if (@del) {
+ run_hooks(delete => sub { shift->(@del) });
+ }
+ if (%rendered) {
+ run_hooks(change => sub { shift->(keys %rendered) });
}
} #}}}