sanitise them, like any other page type.

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 98c86bac8b5d4d87b76de9252e1955f8dff4fd80..40472693084d905b00373f504a57a1069aff871b 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -1,15 +1,21 @@
+#!/usr/bin/perl
+

 package IkiWiki;
 
 use warnings;
 use strict;
 use File::Spec;
 package IkiWiki;
 
 use warnings;
 use strict;
 use File::Spec;

+use IkiWiki;
+use Encode;

 
 

-sub linkify ($$) { #{{{
-       my $content=shift;
+sub linkify ($$$) { #{{{
+       my $lpage=shift;

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

+       my $content=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;


@@ -19,19 +25,20 @@ sub htmlize ($$) { #{{{
        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}->($content);

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

+
+       if (exists $hooks{sanitize}) {
+               foreach my $id (keys %{$hooks{sanitize}}) {
+                       $content=$hooks{sanitize}{$id}{call}->($content);
+               }
+       }
+       
+       return $content;

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


@@ -79,40 +86,121 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
        return @ret;
 } #}}}
 

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

        my $content=shift;
        my $content=shift;

+       my $onlystrip=shift || 0; # strip directives without processing
+
+       my $handle=sub {
+               my $escape=shift;
+               my $command=shift;
+               my $params=shift;
+               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;
+                       }
+                       return $hooks{preprocess}{$command}{call}->(@params, page => $page);
+               }
+               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 $page=shift;

-       my $mtime=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 $title=basename($page);
-       $title=~s/_/ /g;
+       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];
+               }
+       }

        
        

-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => "$config{templatedir}/page.tmpl");
+       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;
+

        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 ($actions) {
+               $template->param(have_actions => 1);
+       }
+

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

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

        );
        );

+
+       if (exists $hooks{pagetemplate}) {
+               foreach my $id (keys %{$hooks{pagetemplate}}) {
+                       $hooks{pagetemplate}{$id}{call}->($page, $template);
+               }
+       }

        
        return $template->output;
 } #}}}
        
        return $template->output;
 } #}}}


@@ -124,56 +212,81 @@ 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 Encode::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 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};
+               
+               if (exists $hooks{filter}) {
+                       foreach my $id (keys %{$hooks{filter}}) {
+                               $content=$hooks{filter}{$id}{call}->(
+                                       page => $page,
+                                       content => $content
+                               );
+                       }
+               }

                
                

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

                
                

-               $content=linkify($content, $page);
+               $content=linkify($page, $page, $content);
+               $content=preprocess($page, $content);

                $content=htmlize($type, $content);
                $content=htmlize($type, $content);

-               $content=finalize($content, $page,
-                       mtime("$config{srcdir}/$file"));

                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);

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

                $oldpagemtime{$page}=time;
                $renderedfiles{$page}=htmlpage($page);
        }
        else {
                $oldpagemtime{$page}=time;
                $renderedfiles{$page}=htmlpage($page);
        }
        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;
        }


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

+                       $_ = Encode::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


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

+       find({
+               no_chdir => 1,
+               wanted => sub {
+                       $_ = Encode::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;
 


@@ -223,10 +360,16 @@ 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}=[];
                        $pagesources{$page}=$file;
                        push @add, $file;
                        $links{$page}=[];
                        $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;


@@ -246,15 +389,15 @@ 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}) {
+                       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


@@ -275,20 +418,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 (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);
                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;
                                        }
                                }


@@ -296,8 +456,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;
                                        }
                                }


@@ -308,9 +468,21 @@ 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 && 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
 } #}}}
 
 1