clarify that templates can contain wiki markup

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index c16877b3deb9117573962d7a061843ecf26e5067..d8bc5a9d90267d1357f5187ec9bc3420964030d5 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -7,26 +7,43 @@ use strict;
 use IkiWiki;
 use Encode;
 
 use IkiWiki;
 use Encode;
 

+my %backlinks;
+my $backlinks_calculated=0;
+
+sub calculate_backlinks () { #{{{
+       return if $backlinks_calculated;
+       %backlinks=();
+       foreach my $page (keys %links) {
+               foreach my $link (@{$links{$page}}) {
+                       my $bestlink=bestlink($page, $link);
+                       if (length $bestlink && $bestlink ne $page) {
+                               $backlinks{$bestlink}{$page}=1;
+                       }
+               }
+       }
+       $backlinks_calculated=1;
+} #}}}
+

 sub backlinks ($) { #{{{
        my $page=shift;
 
 sub backlinks ($) { #{{{
        my $page=shift;
 

+       calculate_backlinks();
+

        my @links;
        my @links;

-       foreach my $p (keys %links) {
-               next if bestlink($page, $p) eq $page;
-               if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
-                       my $href=abs2rel(htmlpage($p), dirname($page));
+       return unless $backlinks{$page};
+       foreach my $p (keys %{$backlinks{$page}}) {
+               my $href=abs2rel(htmlpage($p), dirname($page));

                        
                        

-                       # Trim common dir prefixes from both pages.
-                       my $p_trimmed=$p;
-                       my $page_trimmed=$page;
-                       my $dir;
-                       1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
-                               defined $dir &&
-                               $p_trimmed=~s/^\Q$dir\E// &&
-                               $page_trimmed=~s/^\Q$dir\E//;
-                                      
-                       push @links, { url => $href, page => pagetitle($p_trimmed) };
-               }
+               # Trim common dir prefixes from both pages.
+               my $p_trimmed=$p;
+               my $page_trimmed=$page;
+               my $dir;
+               1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
+                       defined $dir &&
+                       $p_trimmed=~s/^\Q$dir\E// &&
+                       $page_trimmed=~s/^\Q$dir\E//;
+                              
+               push @links, { url => $href, page => pagetitle($p_trimmed) };

        }
 
        return sort { $a->{page} cmp $b->{page} } @links;
        }
 
        return sort { $a->{page} cmp $b->{page} } @links;


@@ -77,8 +94,13 @@ sub genpage ($$$) { #{{{
                $actions++;
        }
        if ($config{discussion}) {
                $actions++;
        }
        if ($config{discussion}) {

-               $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
-               $actions++;
+               my $discussionlink=gettext("discussion");
+               if ($page !~ /.*\/\Q$discussionlink\E$/ &&
+                  (length $config{cgiurl} ||
+                   exists $links{$page."/".$discussionlink})) {
+                       $template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), 1, 1));
+                       $actions++;
+               }

        }
 
        if ($actions) {
        }
 
        if ($actions) {


@@ -113,38 +135,42 @@ sub genpage ($$$) { #{{{
        return $content;
 } #}}}
 
        return $content;
 } #}}}
 

-sub check_overwrite ($$) { #{{{
-       # Important security check. Make sure to call this before saving
-       # any files to the source directory.
-       my $dest=shift;
-       my $src=shift;
-       
-       if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
-               error("$dest already exists and was not rendered from $src before");
-       }
-} #}}}
-

 sub mtime ($) { #{{{
        my $file=shift;
        
        return (stat($file))[9];
 } #}}}
 
 sub mtime ($) { #{{{
        my $file=shift;
        
        return (stat($file))[9];
 } #}}}
 

-sub findlinks ($$) { #{{{
-       my $page=shift;
-       my $content=shift;
+sub scan ($) { #{{{
+       my $file=shift;

 
 

-       my @links;
-       while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
-               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";
+       my $type=pagetype($file);
+       if (defined $type) {
+               my $srcfile=srcfile($file);
+               my $content=readfile($srcfile);
+               my $page=pagename($file);
+               will_render($page, htmlpage($page), 1);
+
+               # Always needs to be done, since filters might add links
+               # to the content.
+               $content=filter($page, $content);
+
+               my @links;
+               while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
+                       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.
+                       push @links, $page."/".gettext("discussion");
+               }
+               $links{$page}=\@links;
+               
+               # Preprocess in scan-only mode.
+               preprocess($page, $page, $content, 1);

        }
        else {
        }
        else {

-               return @links;
+               will_render($file, $file, 1);

        }
 } #}}}
 
        }
 } #}}}
 


@@ -157,29 +183,38 @@ sub render ($) { #{{{
                my $content=readfile($srcfile);
                my $page=pagename($file);
                delete $depends{$page};
                my $content=readfile($srcfile);
                my $page=pagename($file);
                delete $depends{$page};

+               will_render($page, htmlpage($page), 1);

                
                $content=filter($page, $content);
                
                $content=filter($page, $content);

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

                $content=preprocess($page, $page, $content);
                $content=linkify($page, $page, $content);
                $content=htmlize($page, $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($page, $content, mtime($srcfile)));
                $oldpagemtime{$page}=time;
                writefile(htmlpage($page), $config{destdir},
                        genpage($page, $content, mtime($srcfile)));
                $oldpagemtime{$page}=time;

-               $renderedfiles{$page}=htmlpage($page);

        }
        else {
        }
        else {

-               my $content=readfile($srcfile, 1);
-               $links{$file}=[];
+               my $srcfd=readfile($srcfile, 1, 1);

                delete $depends{$file};
                delete $depends{$file};

-               check_overwrite("$config{destdir}/$file", $file);
-               writefile($file, $config{destdir}, $content, 1);
+               will_render($file, $file, 1);
+               my $destfd=writefile($file, $config{destdir}, undef, 1, 1);
+               my $blksize = 16384;
+               my ($len, $buf, $written);
+               while ($len = sysread $srcfd, $buf, $blksize) {
+                       if (! defined $len) {
+                               next if $! =~ /^Interrupted/;
+                               error("failed to read $srcfile: $!");
+                       }
+                       my $offset = 0;
+                       while ($len) {
+                               defined($written = syswrite OUT, $buf, $len, $offset)
+                                       or error("failed to write $file: $!");
+                               $len -= $written;
+                               $offset += $written;
+                       }
+               }

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

-               $renderedfiles{$file}=$file;

        }
 } #}}}
 
        }
 } #}}}
 


@@ -198,17 +233,18 @@ sub refresh () { #{{{
        my %exists;
        my @files;
        eval q{use File::Find};
        my %exists;
        my @files;
        eval q{use File::Find};

+       error($@) if $@;

        find({
                no_chdir => 1,
                wanted => sub {
                        $_=decode_utf8($_);
        find({
                no_chdir => 1,
                wanted => sub {
                        $_=decode_utf8($_);

-                       if (/$config{wiki_file_prune_regexp}/) {
+                       if (file_pruned($_, $config{srcdir})) {

                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {

-                                       warn("skipping bad filename $_\n");
+                                       warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");

                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;


@@ -222,22 +258,25 @@ sub refresh () { #{{{
                no_chdir => 1,
                wanted => sub {
                        $_=decode_utf8($_);
                no_chdir => 1,
                wanted => sub {
                        $_=decode_utf8($_);

-                       if (/$config{wiki_file_prune_regexp}/) {
+                       if (file_pruned($_, $config{underlaydir})) {

                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {

-                                       warn("skipping bad filename $_\n");
+                                       warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");

                                }
                                else {
                                }
                                else {

-                                       # Don't add files that are in the
+                                       # Don't add pages that are in the

                                        # srcdir.
                                        $f=~s/^\Q$config{underlaydir}\E\/?//;
                                        if (! -e "$config{srcdir}/$f" && 
                                            ! -l "$config{srcdir}/$f") {
                                        # srcdir.
                                        $f=~s/^\Q$config{underlaydir}\E\/?//;
                                        if (! -e "$config{srcdir}/$f" && 
                                            ! -l "$config{srcdir}/$f") {

-                                               push @files, $f;
-                                               $exists{pagename($f)}=1;
+                                               my $page=pagename($f);
+                                               if (! $exists{$page}) {
+                                                       push @files, $f;
+                                                       $exists{$page}=1;
+                                               }

                                        }
                                }
                        }
                                        }
                                }
                        }


@@ -250,12 +289,10 @@ sub refresh () { #{{{
        my @add;
        foreach my $file (@files) {
                my $page=pagename($file);
        my @add;
        foreach my $file (@files) {
                my $page=pagename($file);

+               $pagesources{$page}=$file;

                if (! $oldpagemtime{$page}) {
                if (! $oldpagemtime{$page}) {

-                       debug("new page $page") unless exists $pagectime{$page};

                        push @add, $file;
                        push @add, $file;

-                       $links{$page}=[];

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

-                       $pagesources{$page}=$file;

                        if ($config{getctime} && -e "$config{srcdir}/$file") {
                                $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
                        }
                        if ($config{getctime} && -e "$config{srcdir}/$file") {
                                $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
                        }


@@ -267,64 +304,64 @@ sub refresh () { #{{{
        my @del;
        foreach my $page (keys %oldpagemtime) {
                if (! $exists{$page}) {
        my @del;
        foreach my $page (keys %oldpagemtime) {
                if (! $exists{$page}) {

-                       debug("removing old page $page");
+                       debug(sprintf(gettext("removing old page %s"), $page));

                        push @del, $pagesources{$page};
                        push @del, $pagesources{$page};

-                       prune($config{destdir}."/".$renderedfiles{$page});
-                       delete $renderedfiles{$page};
+                       $links{$page}=[];
+                       $renderedfiles{$page}=[];

                        $oldpagemtime{$page}=0;
                        $oldpagemtime{$page}=0;

+                       prune($config{destdir}."/".$_)
+                               foreach @{$oldrenderedfiles{$page}};

                        delete $pagesources{$page};
                }
        }
                        delete $pagesources{$page};
                }
        }

-       
-       # render any updated files
+
+       # scan changed and new files
+       my @changed;

        foreach my $file (@files) {
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
                    mtime(srcfile($file)) > $oldpagemtime{$page} ||
                    $forcerebuild{$page}) {
        foreach my $file (@files) {
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
                    mtime(srcfile($file)) > $oldpagemtime{$page} ||
                    $forcerebuild{$page}) {

-                       debug("rendering $file");
-                       render($file);
-                       $rendered{$file}=1;
+                       debug(sprintf(gettext("scanning %s"), $file));
+                       push @changed, $file;
+                       scan($file);

                }
        }
                }
        }

+       calculate_backlinks();
+
+       # render changed and new pages
+       foreach my $file (@changed) {
+               debug(sprintf(gettext("rendering %s"), $file));
+               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 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
+       # rebuild pages that link to added or removed pages

        if (@add || @del) {
        if (@add || @del) {

-FILE:          foreach my $file (@files) {
-                       my $page=pagename($file);
-                       foreach my $f (@add, @del) {
-                               my $p=pagename($f);
-                               foreach my $link (@{$links{$page}}) {
-                                       if (bestlink($page, $link) eq $p) {
-                                               debug("rendering $file, which links to $p");
-                                               render($file);
-                                               $rendered{$file}=1;
-                                               next FILE;
-                                       }
-                               }
+               foreach my $f (@add, @del) {
+                       my $p=pagename($f);
+                       foreach my $page (keys %{$backlinks{$p}}) {
+                               my $file=$pagesources{$page};
+                               next if $rendered{$file};
+                               debug(sprintf(gettext("rendering %s, which links to %s"), $file, $p));
+                               render($file);
+                               $rendered{$file}=1;

                        }
                }
        }
 
                        }
                }
        }
 

-       # 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

        if (%rendered || @del) {
        if (%rendered || @del) {

+               # rebuild dependant pages

                foreach my $f (@files) {
                foreach my $f (@files) {

+                       next if $rendered{$f};

                        my $p=pagename($f);
                        if (exists $depends{$p}) {
                                foreach my $file (keys %rendered, @del) {
                                        next if $f eq $file;
                                        my $page=pagename($file);
                        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");
+                                       if (pagespec_match($page, $depends{$p}, $p)) {
+                                               debug(sprintf(gettext("rendering %s, which depends on %s"), $f, $page));

                                                render($f);
                                                $rendered{$f}=1;
                                                last;
                                                render($f);
                                                $rendered{$f}=1;
                                                last;


@@ -333,6 +370,8 @@ FILE:               foreach my $file (@files) {
                        }
                }
                
                        }
                }
                

+               # handle backlinks; if a page has added/removed links,
+               # update the pages it links to

                my %linkchanged;
                foreach my $file (keys %rendered, @del) {
                        my $page=pagename($file);
                my %linkchanged;
                foreach my $file (keys %rendered, @del) {
                        my $page=pagename($file);


@@ -359,13 +398,25 @@ FILE:             foreach my $file (@files) {
                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {

-                               debug("rendering $linkfile, to update its backlinks");
+                               next if $rendered{$linkfile};
+                               debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile));

                                render($linkfile);
                                $rendered{$linkfile}=1;
                        }
                }
        }
 
                                render($linkfile);
                                $rendered{$linkfile}=1;
                        }
                }
        }
 

+       # remove no longer rendered files
+       foreach my $src (keys %rendered) {
+               my $page=pagename($src);
+               foreach my $file (@{$oldrenderedfiles{$page}}) {
+                       if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
+                               debug(sprintf(gettext("removing %s, no longer rendered by %s"), $file, $page));
+                               prune($config{destdir}."/".$file);
+                       }
+               }
+       }
+

        if (@del) {
                run_hooks(delete => sub { shift->(@del) });
        }
        if (@del) {
                run_hooks(delete => sub { shift->(@del) });
        }


@@ -374,4 +425,29 @@ FILE:              foreach my $file (@files) {
        }
 } #}}}
 
        }
 } #}}}
 

+sub commandline_render () { #{{{
+       loadplugins();
+       checkconfig();
+       lockwiki();
+       loadindex();
+       unlockwiki();
+
+       my $srcfile=possibly_foolish_untaint($config{render});
+       my $file=$srcfile;
+       $file=~s/\Q$config{srcdir}\E\/?//;
+
+       my $type=pagetype($file);
+       die sprintf(gettext("ikiwiki: cannot render %s"), $srcfile)."\n" unless defined $type;
+       my $content=readfile($srcfile);
+       my $page=pagename($file);
+       $pagesources{$page}=$file;
+       $content=filter($page, $content);
+       $content=preprocess($page, $page, $content);
+       $content=linkify($page, $page, $content);
+       $content=htmlize($page, $type, $content);
+
+       print genpage($page, $content, mtime($srcfile));
+       exit 0;
+} #}}}
+

 1
 1