X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/a223f4540fee2d0c49523343a422315377bc0025..157df8591f03ade7504ad732446f125ae8609b05:/IkiWiki/Render.pm diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index df24fd568..262e0ec29 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -1,20 +1,58 @@ +#!/usr/bin/perl + package IkiWiki; use warnings; use strict; use File::Spec; +use IkiWiki; sub linkify ($$) { #{{{ my $content=shift; my $page=shift; $content =~ s{(\\?)$config{wiki_link_regexp}}{ - $1 ? "[[$2]]" : htmllink($page, $2) + $2 ? ( $1 ? "[[$2|$3]]" : htmllink($page, titlepage($3), 0, 0, pagetitle($2))) + : ( $1 ? "[[$3]]" : htmllink($page, titlepage($3))) }eg; 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; @@ -27,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 ($) { #{{{ @@ -79,7 +123,67 @@ sub parentlinks ($) { #{{{ return @ret; } #}}} -sub finalize ($$$) { #{{{ +sub preprocess ($$) { #{{{ + my $page=shift; + my $content=shift; + + my $handle=sub { + my $escape=shift; + my $command=shift; + my $params=shift; + if (length $escape) { + return "[[$command $params]]"; + } + elsif (exists $hooks{preprocess}{$command}) { + my %params; + while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) { + $params{$1}=$2; + } + return $hooks{preprocess}{$command}{call}->(page => $page, %params); + } + else { + return "[[$command not processed]]"; + } + }; + + $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg; + return $content; +} #}}} + +sub add_depends ($$) { #{{{ + my $page=shift; + my $globlist=shift; + + if (! exists $depends{$page}) { + $depends{$page}=$globlist; + } + else { + $depends{$page}=globlist_merge($depends{$page}, $globlist); + } +} # }}} + +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 $content=shift; my $page=shift; my $mtime=shift; @@ -90,10 +194,10 @@ sub finalize ($$$) { #{{{ filename => "$config{templatedir}/page.tmpl"); if (length $config{cgiurl}) { - $template->param(editurl => "$config{cgiurl}?do=edit&page=$page"); - $template->param(prefsurl => "$config{cgiurl}?do=prefs"); + $template->param(editurl => cgiurl(do => "edit", page => $page)); + $template->param(prefsurl => cgiurl(do => "prefs")); if ($config{rcs}) { - $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges"); + $template->param(recentchangesurl => cgiurl(do => "recentchanges")); } } @@ -102,7 +206,8 @@ sub finalize ($$$) { #{{{ $u=~s/\[\[file\]\]/$pagesources{$page}/g; $template->param(historyurl => $u); } - + $template->param(headercontent => $config{headercontent}); + $template->param( title => $title, wikiname => $config{wikiname}, @@ -111,6 +216,7 @@ sub finalize ($$$) { #{{{ backlinks => [backlinks($page)], discussionlink => htmllink($page, "Discussion", 1, 1), mtime => scalar(gmtime($mtime)), + styleurl => styleurl($page), ); return $template->output; @@ -131,9 +237,9 @@ sub check_overwrite ($$) { #{{{ } #}}} sub mtime ($) { #{{{ - my $page=shift; + my $file=shift; - return (stat($page))[9]; + return (stat($file))[9]; } #}}} sub findlinks ($$) { #{{{ @@ -142,7 +248,7 @@ sub findlinks ($$) { #{{{ my @links; while ($content =~ /(?( + page => $page, + content => $content + ); + } + } $links{$page}=[findlinks($content, $page)]; $content=linkify($content, $page); + $content=preprocess($page, $content); $content=htmlize($type, $content); - $content=finalize($content, $page, - mtime("$config{srcdir}/$file")); check_overwrite("$config{destdir}/".htmlpage($page), $page); - writefile("$config{destdir}/".htmlpage($page), $content); + writefile(htmlpage($page), $config{destdir}, + genpage($content, $page, mtime($srcfile))); $oldpagemtime{$page}=time; $renderedfiles{$page}=htmlpage($page); } else { + my $content=readfile($srcfile, 1); $links{$file}=[]; + delete $depends{$file}; check_overwrite("$config{destdir}/$file", $file); - writefile("$config{destdir}/$file", $content); + writefile($file, $config{destdir}, $content, 1); $oldpagemtime{$file}=time; $renderedfiles{$file}=$file; } @@ -197,9 +316,7 @@ sub refresh () { #{{{ no_chdir => 1, wanted => sub { if (/$config{wiki_file_prune_regexp}/) { - no warnings 'once'; $File::Find::prune=1; - use warnings "all"; } elsif (! -d $_ && ! -l $_) { my ($f)=/$config{wiki_file_regexp}/; # untaint @@ -214,6 +331,30 @@ sub refresh () { #{{{ } }, }, $config{srcdir}); + find({ + no_chdir => 1, + wanted => sub { + if (/$config{wiki_file_prune_regexp}/) { + $File::Find::prune=1; + } + elsif (! -d $_ && ! -l $_) { + my ($f)=/$config{wiki_file_regexp}/; # untaint + if (! defined $f) { + warn("skipping bad filename $_\n"); + } + else { + # Don't add files that are in the + # srcdir. + $f=~s/^\Q$config{underlaydir}\E\/?//; + if (! -e "$config{srcdir}/$f" && + ! -l "$config{srcdir}/$f") { + push @files, $f; + $exists{pagename($f)}=1; + } + } + } + }, + }, $config{underlaydir}); my %rendered; @@ -222,10 +363,12 @@ sub refresh () { #{{{ foreach my $file (@files) { my $page=pagename($file); if (! $oldpagemtime{$page}) { - debug("new page $page"); + debug("new page $page") unless exists $pagectime{$page}; push @add, $file; $links{$page}=[]; $pagesources{$page}=$file; + $pagectime{$page}=mtime(srcfile($file)) + unless exists $pagectime{$page}; } } my @del; @@ -245,7 +388,7 @@ sub refresh () { #{{{ my $page=pagename($file); if (! exists $oldpagemtime{$page} || - mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) { + mtime(srcfile($file)) > $oldpagemtime{$page}) { debug("rendering changed file $file"); render($file); $rendered{$file}=1; @@ -253,7 +396,7 @@ sub refresh () { #{{{ } # if any files were added or removed, check to see if each page - # needs an update due to linking to them + # 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 @@ -274,20 +417,37 @@ FILE: foreach my $file (@files) { } } - # handle backlinks; if a page has added/removed links, update the - # pages it links to + # Handle backlinks; if a page has added/removed links, update the + # 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) { + if (%rendered || @del) { + foreach my $f (@files) { + my $p=pagename($f); + if (exists $depends{$p}) { + foreach my $file (keys %rendered, @del) { + next if $f eq $file; + my $page=pagename($file); + if (globlist_match($page, $depends{$p})) { + debug("rendering $f, which depends on $page"); + render($f); + $rendered{$f}=1; + last; + } + } + } + } + my %linkchanged; foreach my $file (keys %rendered, @del) { my $page=pagename($file); + 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; } } @@ -295,8 +455,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; } } @@ -307,9 +467,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