]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Render.pm
add news item for ikiwiki 1.26
[git.ikiwiki.info.git] / IkiWiki / Render.pm
index 262e0ec29585290577c058917d65fc393b551313..2c1ea3eb7c0b73f507fb51c70499f01c10c51ccc 100644 (file)
@@ -4,76 +4,43 @@ 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;
 } #}}}
 
-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 ($$) { #{{{
+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') {
-               $content=Markdown::Markdown($content);
+       if (exists $hooks{htmlize}{$type}) {
+               $content=$hooks{htmlize}{$type}{call}->(
+                       page => $page,
+                       content => $content,
+               );
        }
        else {
                error("htmlization of $type not supported");
        }
 
-       if ($config{sanitize}) {
-               $content=scrubber()->scrub($content);
-       }
+       run_hooks(sanitize => sub {
+               $content=shift->(
+                       page => $page,
+                       content => $content,
+               );
+       });
        
        return $content;
 } #}}}
@@ -85,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;
@@ -96,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) };
                }
        }
 
@@ -110,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;
@@ -123,8 +91,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 {
@@ -135,91 +105,124 @@ 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, '';
+                               }
                        }
-                       return $hooks{preprocess}{$command}{call}->(page => $page, %params);
+                       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}]]";
+                       }
+                       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 $content=shift;
        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}) {
                $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 ($actions) {
+               $template->param(have_actions => 1);
        }
-       $template->param(headercontent => $config{headercontent});
 
        $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),
        );
+
+       run_hooks(pagetemplate => sub {
+               shift->(page => $page, destpage => $page, template => $template);
+       });
        
-       return $template->output;
+       $content=$template->output;
+
+       run_hooks(format => sub {
+               $content=shift->(
+                       page => $page,
+                       content => $content,
+               );
+       });
+
+       return $content;
 } #}}}
 
 sub check_overwrite ($$) { #{{{
@@ -229,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;
        
@@ -243,46 +253,55 @@ 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);
-       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($content, $page)];
+               $links{$page}=[findlinks($page, $content)];
                
-               $content=linkify($content, $page);
-               $content=preprocess($page, $content);
-               $content=htmlize($type, $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);
        }
@@ -315,6 +334,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -334,6 +354,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -366,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;
@@ -388,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;
                }
@@ -418,7 +445,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
@@ -429,7 +456,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;
@@ -472,15 +499,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) });
        }
 } #}}}