]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Render.pm
web commit by joey
[git.ikiwiki.info.git] / IkiWiki / Render.pm
index ac8f0393743a4c1889d55a9557896a2baa8b7d74..2c1ea3eb7c0b73f507fb51c70499f01c10c51ccc 100644 (file)
@@ -4,13 +4,12 @@ package IkiWiki;
 
 use warnings;
 use strict;
-use File::Spec;
 use IkiWiki;
 use Encode;
 
 sub linkify ($$$) { #{{{
-       my $lpage=shift;
-       my $page=shift;
+       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}}{
@@ -21,36 +20,27 @@ sub linkify ($$$) { #{{{
        return $content;
 } #}}}
 
-sub htmlize ($$) { #{{{
+sub htmlize ($$$) { #{{{
+       my $page=shift;
        my $type=shift;
        my $content=shift;
        
-       if (! $INC{"/usr/bin/markdown"}) {
-               # Note: a proper perl module is available in Debian
-               # for markdown, but not upstream yet.
-               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') {
-               # Workaround for perl bug (#376329)
-               $content=Encode::encode_utf8($content);
-               $content=Encode::encode_utf8($content);
-               $content=Markdown::Markdown($content);
-               $content=Encode::decode_utf8($content);
-               $content=Encode::decode_utf8($content);
+       if (exists $hooks{htmlize}{$type}) {
+               $content=$hooks{htmlize}{$type}{call}->(
+                       page => $page,
+                       content => $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->(
+                       page => $page,
+                       content => $content,
+               );
+       });
        
        return $content;
 } #}}}
@@ -62,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;
@@ -73,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) };
                }
        }
 
@@ -87,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;
@@ -100,10 +91,11 @@ 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 $onlystrip=shift || 0; # strip directives without processing
 
        my $handle=sub {
                my $escape=shift;
@@ -112,67 +104,72 @@ sub preprocess ($$;$) { #{{{
                if (length $escape) {
                        return "[[$command $params]]";
                }
-               elsif ($onlystrip) {
-                       return "";
-               }
                elsif (exists $hooks{preprocess}{$command}) {
                        # Note: preserve order of params, some plugins may
                        # consider it significant.
                        my @params;
-                       while ($params =~ /(\w+)=\"?([^"]+)"?(\s+|$)/g) {
-                               push @params, $1, $2;
+                       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}++ > 3) {
+                               # 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}->(@params, page => $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 $page=shift;
        my $content=shift;
        my $mtime=shift;
 
-       my $title=pagetitle(basename($page));
-       
        my $template=template("page.tmpl", blind_cache => 1);
        my $actions=0;
 
@@ -201,22 +198,31 @@ sub genpage ($$$) { #{{{
        }
 
        $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 => displaytime($mtime),
-               styleurl => styleurl($page),
+               baseurl => baseurl($page),
        );
 
-       if (exists $hooks{pagetemplate}) {
-               foreach my $id (keys %{$hooks{pagetemplate}}) {
-                       $hooks{pagetemplate}{$id}{call}->($page, $template);
-               }
-       }
+       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 ($$) { #{{{
@@ -236,7 +242,7 @@ sub displaytime ($) { #{{{
        eval q{use POSIX};
        # strftime doesn't know about encodings, so make sure
        # its output is properly treated as utf8
-       return Encode::decode_utf8(POSIX::strftime(
+       return decode_utf8(POSIX::strftime(
                        $config{timeformat}, localtime($time)));
 } #}}}
 
@@ -264,30 +270,34 @@ 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=preprocess($page, $page, $content);
                $content=linkify($page, $page, $content);
-               $content=preprocess($page, $content);
-               $content=htmlize($type, $content);
+               $content=htmlize($page, $type, $content);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);
                writefile(htmlpage($page), $config{destdir},
@@ -324,7 +334,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
-                       $_ = Encode::decode_utf8($_);
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -344,7 +354,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
-                       $_ = Encode::decode_utf8($_);
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -377,6 +387,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");
@@ -403,7 +414,8 @@ sub refresh () { #{{{
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
-                   mtime(srcfile($file)) > $oldpagemtime{$page}) {
+                   mtime(srcfile($file)) > $oldpagemtime{$page} ||
+                   $forcerebuild{$page}) {
                        debug("rendering $file");
                        render($file);
                        $rendered{$file}=1;
@@ -444,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;
@@ -487,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) });
        }
 } #}}}