update

[git.ikiwiki.info.git] / IkiWiki / Render.pm

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 646e254a59cba73e84db87b291d53546e7631741..2c1ea3eb7c0b73f507fb51c70499f01c10c51ccc 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -1,37 +1,48 @@
+#!/usr/bin/perl
+

 package IkiWiki;
 
 use warnings;
 use strict;
 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 $content=shift;

-       my $page=shift;

 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{

-               $1 ? "[[$2]]" : htmllink($page, $2)
+               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
+                  : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))

        }eg;
        
        return $content;
 } #}}}
 
        }eg;
        
        return $content;
 } #}}}
 

-sub htmlize ($$) { #{{{
+sub htmlize ($$$) { #{{{
+       my $page=shift;

        my $type=shift;
        my $content=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') {
-               return Markdown::Markdown($content);
+       if (exists $hooks{htmlize}{$type}) {
+               $content=$hooks{htmlize}{$type}{call}->(
+                       page => $page,
+                       content => $content,
+               );

        }
        else {
                error("htmlization of $type not supported");
        }
        }
        else {
                error("htmlization of $type not supported");
        }

+
+       run_hooks(sanitize => sub {
+               $content=shift->(
+                       page => $page,
+                       content => $content,
+               );
+       });
+       
+       return $content;

 } #}}}
 
 sub backlinks ($) { #{{{
 } #}}}
 
 sub backlinks ($) { #{{{


@@ -41,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}}) {
        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;
                        
                        # Trim common dir prefixes from both pages.
                        my $p_trimmed=$p;


@@ -52,7 +63,7 @@ sub backlinks ($) { #{{{
                                $p_trimmed=~s/^\Q$dir\E// &&
                                $page_trimmed=~s/^\Q$dir\E//;
                                       
                                $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) };

                }
        }
 
                }
        }
 


@@ -66,10 +77,11 @@ sub parentlinks ($) { #{{{
        my $pagelink="";
        my $path="";
        my $skip=1;
        my $pagelink="";
        my $path="";
        my $skip=1;

+       return if $page eq 'index'; # toplevel

        foreach my $dir (reverse split("/", $page)) {
                if (! $skip) {
                        $path.="../";
        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;
                }
                else {
                        $skip=0;


@@ -79,104 +91,138 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
        return @ret;
 } #}}}
 

-sub rsspage ($) { #{{{
-       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 {
+               my $escape=shift;
+               my $command=shift;
+               my $params=shift;
+               if (length $escape) {
+                       return "[[$command $params]]";
+               }
+               elsif (exists $hooks{preprocess}{$command}) {
+                       # 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;
+                               }

 
 

-       return $page.".rss";
+                               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}]]";
+                       }
+                       my $ret=$hooks{preprocess}{$command}{call}->(
+                               @params,
+                               page => $page,
+                               destpage => $destpage,
+                       );
+                       $preprocessing{$page}--;
+                       return $ret;
+               }
+               else {
+                       return "[[$command $params]]";
+               }
+       };
+       
+       $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
+       return $content;

 } #}}}
 
 } #}}}
 

+sub add_depends ($$) { #{{{
+       my $page=shift;
+       my $pagespec=shift;
+       
+       if (! exists $depends{$page}) {
+               $depends{$page}=$pagespec;
+       }
+       else {
+               $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
+       }
+} # }}}
+

 sub genpage ($$$) { #{{{
 sub genpage ($$$) { #{{{

-       my $content=shift;

        my $page=shift;
        my $page=shift;

+       my $content=shift;

        my $mtime=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}) {
        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}) {
                if ($config{rcs}) {

-                       $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges");
+                       $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);
        }
 
        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 ($config{rss}) {
-               $template->param(rssurl => rsspage($page));
+       if ($actions) {
+               $template->param(have_actions => 1);

        }
        }

-       
+

        $template->param(
        $template->param(

-               title => $title,
+               title => $page eq 'index' 
+                       ? $config{wikiname} 
+                       : pagetitle(basename($page)),

                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => [backlinks($page)],
                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => [backlinks($page)],

-               discussionlink => htmllink($page, "Discussion", 1, 1),
-               mtime => scalar(gmtime($mtime)),
+               mtime => displaytime($mtime),
+               baseurl => baseurl($page),

        );
        );

-       
-       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 ($$) { #{{{
-       my $content=shift;
-       my $url=shift;
-
-       $url=~s/[^\/]+$//;
+       run_hooks(pagetemplate => sub {
+               shift->(page => $page, destpage => $page, template => $template);
+       });

        
        

-       $content=~s{<a\s+href="([^"]+)"}{
-               "<a href=\"$url$1\""
-       }ieg;
-       $content=~s{<img\s+src="([^"]+)"}{
-               "<img src=\"$url$1\""
-       }ieg;
-       return $content;
-} #}}}
+       $content=$template->output;

 
 

-sub genrss ($$$) { #{{{
-       my $content=shift;
-       my $page=shift;
-       my $mtime=shift;
+       run_hooks(format => sub {
+               $content=shift->(
+                       page => $page,
+                       content => $content,
+               );
+       });

 
 

-       my $url="$config{url}/".htmlpage($page);
-       
-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => "$config{templatedir}/rsspage.tmpl");
-       
-       # Regular page gets a feed that is updated every time the
-       # page is changed, so the mtime is encoded in the guid.
-       my @items=(
-               {
-                       itemtitle => pagetitle(basename($page)),
-                       itemguid => "$url?mtime=$mtime",
-                       itemurl => $url,
-                       itempubdate => date_822($mtime),
-                       itemcontent => absolute_urls($content, $url), # rss sucks
-               },
-       );
-       
-       $template->param(
-               title => pagetitle(basename($page)),
-               pageurl => $url,
-               items => \@items,
-       );
-       
-       return $template->output;
+       return $content;

 } #}}}
 
 sub check_overwrite ($$) { #{{{
 } #}}}
 
 sub check_overwrite ($$) { #{{{


@@ -186,63 +232,85 @@ sub check_overwrite ($$) { #{{{
        my $src=shift;
        
        if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
        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 ($) { #{{{
 sub mtime ($) { #{{{

-       my $page=shift;
+       my $file=shift;

        
        

-       return (stat($page))[9];
+       return (stat($file))[9];

 } #}}}
 
 sub findlinks ($$) { #{{{
 } #}}}
 
 sub findlinks ($$) { #{{{

-       my $content=shift;

        my $page=shift;
        my $page=shift;

+       my $content=shift;

 
        my @links;
        while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
 
        my @links;
        while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {

-               push @links, lc($1);
+               push @links, titlepage($2);
+       }
+       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;

        }
        }

-       # Discussion links are a special case since they're not in the text
-       # of the page, but on its template.
-       return @links, "$page/discussion";

 } #}}}
 
 } #}}}
 

+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);
 sub render ($) { #{{{
        my $file=shift;
        
        my $type=pagetype($file);

-       my $content=readfile("$config{srcdir}/$file");
-       if ($type ne 'unknown') {
+       my $srcfile=srcfile($file);
+       if (defined $type) {
+               my $content=readfile($srcfile);

                my $page=pagename($file);
                my $page=pagename($file);

+               delete $depends{$page};
+               
+               $content=filter($page, $content);

                
                

-               $links{$page}=[findlinks($content, $page)];
+               $links{$page}=[findlinks($page, $content)];

                
                

-               $content=linkify($content, $page);
-               $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);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);

-               writefile("$config{destdir}/".htmlpage($page),
-                       genpage($content, $page, mtime("$config{srcdir}/$file")));              
+               writefile(htmlpage($page), $config{destdir},
+                       genpage($page, $content, mtime($srcfile)));

                $oldpagemtime{$page}=time;
                $renderedfiles{$page}=htmlpage($page);
                $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}) {
-                       writefile("$config{destdir}/".rsspage($page),
-                               genrss($content, $page, mtime("$config{srcdir}/$file")));
-               }

        }
        else {
        }
        else {

+               my $content=readfile($srcfile, 1);

                $links{$file}=[];
                $links{$file}=[];

+               delete $depends{$file};

                check_overwrite("$config{destdir}/$file", $file);
                check_overwrite("$config{destdir}/$file", $file);

-               writefile("$config{destdir}/$file", $content);
+               writefile($file, $config{destdir}, $content, 1);

                $oldpagemtime{$file}=time;
                $renderedfiles{$file}=$file;
        }
                $oldpagemtime{$file}=time;
                $renderedfiles{$file}=$file;
        }


@@ -266,10 +334,9 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
        find({
                no_chdir => 1,
                wanted => sub {

+                       $_=decode_utf8($_);

                        if (/$config{wiki_file_prune_regexp}/) {
                        if (/$config{wiki_file_prune_regexp}/) {

-                               no warnings 'once';

                                $File::Find::prune=1;
                                $File::Find::prune=1;

-                               use warnings "all";

                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint


@@ -284,6 +351,31 @@ sub refresh () { #{{{
                        }
                },
        }, $config{srcdir});
                        }
                },
        }, $config{srcdir});

+       find({
+               no_chdir => 1,
+               wanted => sub {
+                       $_=decode_utf8($_);
+                       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;
 
 
        my %rendered;
 


@@ -292,10 +384,17 @@ sub refresh () { #{{{
        foreach my $file (@files) {
                my $page=pagename($file);
                if (! $oldpagemtime{$page}) {
        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}=[];
                        push @add, $file;
                        $links{$page}=[];

+                       $pagecase{lc $page}=$page;

                        $pagesources{$page}=$file;
                        $pagesources{$page}=$file;

+                       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;
                }
        }
        my @del;


@@ -315,15 +414,16 @@ sub refresh () { #{{{
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||

-                   mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
-                       debug("rendering changed file $file");
+                   mtime(srcfile($file)) > $oldpagemtime{$page} ||
+                   $forcerebuild{$page}) {
+                       debug("rendering $file");

                        render($file);
                        $rendered{$file}=1;
                }
        }
        
        # if any files were added or removed, check to see if each page
                        render($file);
                        $rendered{$file}=1;
                }
        }
        
        # 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
        # TODO: inefficient; pages may get rendered above and again here;
        # problem is the bestlink may have changed and we won't know until
        # now


@@ -344,20 +444,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 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
        # 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 (pagespec_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);
                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 &&
                        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;
                                        }
                                }
                                                $linkchanged{$link}=1;
                                        }
                                }


@@ -365,8 +482,8 @@ FILE:               foreach my $file (@files) {
                        if (exists $oldlinks{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
                                        if (length $link &&
                        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;
                                        }
                                }
                                                $linkchanged{$link}=1;
                                        }
                                }


@@ -377,9 +494,17 @@ FILE:              foreach my $file (@files) {
                        if (defined $linkfile) {
                                debug("rendering $linkfile, to update its backlinks");
                                render($linkfile);
                        if (defined $linkfile) {
                                debug("rendering $linkfile, to update its backlinks");
                                render($linkfile);

+                               $rendered{$linkfile}=1;

                        }
                }
        }
                        }
                }
        }

+
+       if (@del) {
+               run_hooks(delete => sub { shift->(@del) });
+       }
+       if (%rendered) {
+               run_hooks(change => sub { shift->(keys %rendered) });
+       }

 } #}}}
 
 1
 } #}}}
 
 1