X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/0d9539d577886549b51d2bf70167db05f3f2514c..bcc6cd8f73f27d8327b6646ff0e03b674b66e7a6:/IkiWiki/Render.pm?ds=inline diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 8375cfe7a..a4efa0b74 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -1,8 +1,11 @@ +#!/usr/bin/perl + package IkiWiki; use warnings; use strict; use File::Spec; +use IkiWiki; sub linkify ($$) { #{{{ my $content=shift; @@ -16,6 +19,40 @@ sub linkify ($$) { #{{{ return $content; } #}}} +my $_scrubber; +sub scrubber { #{{{ + return $_scrubber if defined $_scrubber; + + eval q{use HTML::Scrubber}; + # Lists based on http://feedparser.org/docs/html-sanitization.html + $_scrubber = HTML::Scrubber->new( + allow => [qw{ + a abbr acronym address area b big blockquote br + button caption center cite code col colgroup dd del + dfn dir div dl dt em fieldset font form h1 h2 h3 h4 + h5 h6 hr i img input ins kbd label legend li map + menu ol optgroup option p pre q s samp select small + span strike strong sub sup table tbody td textarea + tfoot th thead tr tt u ul var + }], + default => [undef, { map { $_ => 1 } qw{ + abbr accept accept-charset accesskey action + align alt axis border cellpadding cellspacing + char charoff charset checked cite class + clear cols colspan color compact coords + datetime dir disabled enctype for frame + headers height href hreflang hspace id ismap + label lang longdesc maxlength media method + multiple name nohref noshade nowrap prompt + readonly rel rev rows rowspan rules scope + selected shape size span src start summary + tabindex target title type usemap valign + value vspace width + }}], + ); + return $_scrubber; +} # }}} + sub htmlize ($$) { #{{{ my $type=shift; my $content=shift; @@ -28,11 +65,17 @@ sub htmlize ($$) { #{{{ } if ($type eq '.mdwn') { - return Markdown::Markdown($content); + $content=Markdown::Markdown($content); } else { error("htmlization of $type not supported"); } + + if ($config{sanitize}) { + $content=scrubber()->scrub($content); + } + + return $content; } #}}} sub backlinks ($) { #{{{ @@ -80,35 +123,26 @@ 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. +sub preprocess ($$) { #{{{ 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]]"; + return "[[$command $params]]"; } - elsif (exists $commands{$command}) { + elsif (exists $hooks{preprocess}{$command}) { my %params; while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) { $params{$1}=$2; } - $commands{$command}->($page, %params); + return $hooks{preprocess}{$command}{call}->(page => $page, %params); } else { - "[[bad directive $command]]"; + return "[[$command not processed]]"; } }; @@ -116,77 +150,37 @@ 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 ($$$) { #{{{ @@ -194,8 +188,6 @@ sub genpage ($$$) { #{{{ my $page=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, @@ -214,14 +206,8 @@ sub genpage ($$$) { #{{{ $u=~s/\[\[file\]\]/$pagesources{$page}/g; $template->param(historyurl => $u); } - if ($config{hyperestraier}) { - $template->param(hyperestraierurl => cgiurl()); - } + $template->param(headercontent => $config{headercontent}); - if ($config{rss} && $inlinepages{$page}) { - $template->param(rssurl => rsspage(basename($page))); - } - $template->param( title => $title, wikiname => $config{wikiname}, @@ -236,73 +222,6 @@ sub genpage ($$$) { #{{{ 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 ""; - }; - - $content = postprocess($page, $content, inline => $gen_blog); - - $template->param( - title => $config{wikiname}, - pageurl => $url, - items => \@items, - ); - - return $template->output; -} #}}} - sub check_overwrite ($$) { #{{{ # Important security check. Make sure to call this before saving # any files to the source directory. @@ -341,14 +260,15 @@ sub render ($) { #{{{ my $type=pagetype($file); my $srcfile=srcfile($file); - my $content=readfile($srcfile); if ($type ne 'unknown') { + my $content=readfile($srcfile); my $page=pagename($file); $links{$page}=[findlinks($content, $page)]; - delete $inlinepages{$page}; + delete $depends{$page}; $content=linkify($content, $page); + $content=preprocess($page, $content); $content=htmlize($type, $content); check_overwrite("$config{destdir}/".htmlpage($page), $page); @@ -356,19 +276,13 @@ sub render ($) { #{{{ genpage($content, $page, 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 +298,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", - "\n\n\n\n\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; @@ -545,18 +409,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 dependat 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; @@ -572,8 +437,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 +446,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 +463,15 @@ 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 && exists $hooks{delete}) { + foreach my $id (keys %{$hooks{delete}}) { + $hooks{delete}{$id}{call}->(@del); } - if (@del) { - estcmd("purge -cl"); + } + if (%rendered && exists $hooks{render}) { + foreach my $id (keys %{$hooks{render}}) { + $hooks{render}{$id}{call}->(keys %rendered); } - - debug("generating hyperestraier cgi config"); - estcfg(); } } #}}}