X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/29507e94a46d0f2006671d31ac6812ebd0715cee..bfe0d3f5c6671ccc26c510f5a07cc0deb926258d:/IkiWiki/Render.pm?ds=sidebyside diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 08f5e7e95..58556148f 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -4,16 +4,17 @@ package IkiWiki; use warnings; use strict; -use File::Spec; use IkiWiki; +use Encode; -sub linkify ($$) { #{{{ - my $page=shift; +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; $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; @@ -23,28 +24,16 @@ 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"; - require Encode; - } - - if ($type eq '.mdwn') { - # Markdown does character based stuff that does not work - # well with utf-8 strings. - $content=Encode::decode_utf8(Markdown::Markdown(Encode::encode_utf8($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); - } - } + run_hooks(sanitize => sub { + $content=shift->($content); + }); return $content; } #}}} @@ -56,7 +45,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,7 +56,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) }; } } @@ -81,10 +70,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; @@ -94,8 +84,10 @@ sub parentlinks ($) { #{{{ return @ret; } #}}} -sub preprocess ($$) { #{{{ - 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 $handle=sub { @@ -106,63 +98,72 @@ sub preprocess ($$) { #{{{ return "[[$command $params]]"; } elsif (exists $hooks{preprocess}{$command}) { - my %params; - while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) { - $params{$1}=$2; + # 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}++ > 10) { + # Avoid loops of preprocessed pages preprocessing + # other pages that preprocess them, etc. + return "[[$command preprocessing loop detected on $page at depth $preprocessing{$page}]]"; } - return $hooks{preprocess}{$command}{call}->(page => $page, %params); + my $ret=$hooks{preprocess}{$command}{call}->( + @params, + page => $page, + destpage => $destpage, + ); + $preprocessing{$page}--; + return $ret; } else { - return "[[$command not processed]]"; + 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 add_depends ($$) { #{{{ my $page=shift; - my $globlist=shift; + my $pagespec=shift; if (! exists $depends{$page}) { - $depends{$page}=$globlist; + $depends{$page}=$pagespec; } else { - $depends{$page}=globlist_merge($depends{$page}, $globlist); + $depends{$page}=pagespec_merge($depends{$page}, $pagespec); } } # }}} -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]; - } - } - 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("page.tmpl", blind_cache => 1); my $actions=0; if (length $config{cgiurl}) { @@ -181,7 +182,7 @@ sub genpage ($$$) { #{{{ $actions++; } if ($config{discussion}) { - $template->param(discussionlink => htmllink($page, "Discussion", 1, 1)); + $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1)); $actions++; } @@ -189,23 +190,29 @@ sub genpage ($$$) { #{{{ $template->param(have_actions => 1); } - if (exists $hooks{pagetemplate}) { - foreach my $id (keys %{$hooks{pagetemplate}}) { - $hooks{pagetemplate}{$id}{call}->($page, $template); - } - } - $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 => scalar(gmtime($mtime)), - styleurl => styleurl($page), + mtime => displaytime($mtime), + baseurl => baseurl($page), ); + + run_hooks(pagetemplate => sub { + shift->(page => $page, destpage => $page, template => $template); + }); - return $template->output; + $content=$template->output; + + run_hooks(format => sub { + $content=shift->($content); + }); + + return $content; } #}}} sub check_overwrite ($$) { #{{{ @@ -215,13 +222,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; @@ -246,29 +260,33 @@ sub findlinks ($$) { #{{{ } } #}}} +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); - if ($type ne 'unknown') { + if (defined $type) { my $content=readfile($srcfile); my $page=pagename($file); delete $depends{$page}; - if (exists $hooks{filter}) { - foreach my $id (keys %{$hooks{filter}}) { - $content=$hooks{filter}{$id}{call}->( - page => $page, - content => $content - ); - } - } + $content=filter($page, $content); $links{$page}=[findlinks($page, $content)]; - $content=linkify($page, $content); - $content=preprocess($page, $content); + $content=preprocess($page, $page, $content); + $content=linkify($page, $page, $content); $content=htmlize($type, $content); check_overwrite("$config{destdir}/".htmlpage($page), $page); @@ -306,6 +324,7 @@ sub refresh () { #{{{ find({ no_chdir => 1, wanted => sub { + $_=decode_utf8($_); if (/$config{wiki_file_prune_regexp}/) { $File::Find::prune=1; } @@ -325,6 +344,7 @@ sub refresh () { #{{{ find({ no_chdir => 1, wanted => sub { + $_=decode_utf8($_); if (/$config{wiki_file_prune_regexp}/) { $File::Find::prune=1; } @@ -357,6 +377,7 @@ sub refresh () { #{{{ debug("new page $page") unless exists $pagectime{$page}; push @add, $file; $links{$page}=[]; + $pagecase{lc $page}=$page; $pagesources{$page}=$file; if ($config{getctime} && -e "$config{srcdir}/$file") { $pagectime{$page}=rcs_getctime("$config{srcdir}/$file"); @@ -383,8 +404,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; } @@ -413,7 +435,7 @@ FILE: foreach my $file (@files) { } # Handle backlinks; if a page has added/removed links, update the - # pages it links to. Also handles rebuilding dependat pages. + # 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 @@ -424,7 +446,7 @@ FILE: foreach my $file (@files) { foreach my $file (keys %rendered, @del) { next if $f eq $file; my $page=pagename($file); - if (globlist_match($page, $depends{$p})) { + if (pagespec_match($page, $depends{$p})) { debug("rendering $f, which depends on $page"); render($f); $rendered{$f}=1; @@ -467,15 +489,11 @@ FILE: foreach my $file (@files) { } } - if (@del && exists $hooks{delete}) { - foreach my $id (keys %{$hooks{delete}}) { - $hooks{delete}{$id}{call}->(@del); - } + if (@del) { + run_hooks(delete => sub { shift->(@del) }); } - if (%rendered && exists $hooks{change}) { - foreach my $id (keys %{$hooks{change}}) { - $hooks{change}{$id}{call}->(keys %rendered); - } + if (%rendered) { + run_hooks(change => sub { shift->(keys %rendered) }); } } #}}}