]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Render.pm
* Patch from Roland Mas to support an rss=no parameter to inline directives.
[ikiwiki.git] / IkiWiki / Render.pm
index f33d6e66eb7de041d43734b0a4ec4ef3aa7b9b7c..1449b8931cc9ebf364d0daf7841f1d7577c358b6 100644 (file)
@@ -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,25 +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";
-       }
-       
-       if ($type eq '.mdwn') {
-               $content=Markdown::Markdown($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;
 } #}}}
@@ -53,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;
@@ -64,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) };
                }
        }
 
@@ -78,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$dir.html", page => pagetitle($dir) };
                }
                else {
                        $skip=0;
@@ -91,9 +84,11 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
-sub preprocess ($$) { #{{{
-       my $page=shift;
+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 $onlystrip=shift || 0; # strip directives without processing
 
        my $handle=sub {
                my $escape=shift;
@@ -102,12 +97,26 @@ sub preprocess ($$) { #{{{
                if (length $escape) {
                        return "[[$command $params]]";
                }
+               elsif ($onlystrip) {
+                       return "";
+               }
                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+|$)/g) {
+                               if (defined $1) {
+                                       push @params, $1, (defined $2 ? $2 : $3);
+                               }
+                               else {
+                                       push @params, (defined $2 ? $2 : $3), '';
+                               }
                        }
-                       return $hooks{preprocess}{$command}{call}->(page => $page, %params);
+                       return $hooks{preprocess}{$command}{call}->(
+                               @params,
+                               page => $page,
+                               destpage => $destpage,
+                       );
                }
                else {
                        return "[[$command not processed]]";
@@ -156,10 +165,7 @@ sub genpage ($$$) { #{{{
        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}) {
@@ -178,7 +184,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++;
        }
 
@@ -186,21 +192,21 @@ 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)),
+               mtime => displaytime($mtime),
                styleurl => styleurl($page),
        );
+
+       run_hooks(pagetemplate => sub {
+               shift->(page => $page, destpage => $page, template => $template);
+       });
        
        return $template->output;
 } #}}}
@@ -212,13 +218,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,29 +256,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=linkify($page, $page, $content);
+               $content=preprocess($page, $page, $content);
                $content=htmlize($type, $content);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);
@@ -303,6 +320,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -322,6 +340,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -380,8 +399,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;
                }
@@ -410,7 +430,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
@@ -464,15 +484,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) });
        }
 } #}}}