]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Render.pm
* recentchanges: Exipre all *._change pages, even if the directory
[git.ikiwiki.info.git] / IkiWiki / Render.pm
index b65d200a01ea9fcab3d1d474c57d988adcaf82c6..17b60ee941dc7b789f81871650c54c7279670d7c 100644 (file)
@@ -44,11 +44,7 @@ sub backlinks ($) { #{{{
                               
                push @links, { url => $href, page => pagetitle($p_trimmed) };
        }
-       @links = sort { $a->{page} cmp $b->{page} } @links;
-
-       return \@links, [] if @links <= $config{numbacklinks};
-       return [@links[0..$config{numbacklinks}-1]],
-              [@links[$config{numbacklinks}..$#links]];
+       return @links;
 } #}}}
 
 sub parentlinks ($) { #{{{
@@ -59,8 +55,8 @@ sub parentlinks ($) { #{{{
        my $path="";
        my $title=$config{wikiname};
        
-       return if $page eq 'index'; # toplevel
        foreach my $dir (split("/", $page)) {
+               next if $dir eq 'index';
                push @ret, { url => urlto($path, $page), page => $title };
                $path.="/".$dir;
                $title=pagetitle($dir);
@@ -68,23 +64,27 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
-sub genpage ($$$) { #{{{
+sub genpage ($$) { #{{{
        my $page=shift;
        my $content=shift;
-       my $mtime=shift;
 
-       my $template=template("page.tmpl", blind_cache => 1);
+       my $templatefile;
+       run_hooks(templatefile => sub {
+               return if defined $templatefile;
+               my $file=shift->(page => $page);
+               if (defined $file && defined template_file($file)) {
+                       $templatefile=$file;
+               }
+       });
+       my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1);
        my $actions=0;
 
        if (length $config{cgiurl}) {
                $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
                $template->param(prefsurl => cgiurl(do => "prefs"));
-               if ($config{rcs}) {
-                       $template->param(recentchangesurl => cgiurl(do => "recentchanges"));
-               }
                $actions++;
        }
-
+               
        if (length $config{historyurl}) {
                my $u=$config{historyurl};
                $u=~s/\[\[file\]\]/$pagesources{$page}/g;
@@ -105,7 +105,16 @@ sub genpage ($$$) { #{{{
                $template->param(have_actions => 1);
        }
 
-       my ($backlinks, $more_backlinks)=backlinks($page);
+       my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
+       my ($backlinks, $more_backlinks);
+       if (@backlinks <= $config{numbacklinks} || ! $config{numbacklinks}) {
+               $backlinks=\@backlinks;
+               $more_backlinks=[];
+       }
+       else {
+               $backlinks=[@backlinks[0..$config{numbacklinks}-1]];
+               $more_backlinks=[@backlinks[$config{numbacklinks}..$#backlinks]];
+       }
 
        $template->param(
                title => $page eq 'index' 
@@ -116,7 +125,7 @@ sub genpage ($$$) { #{{{
                content => $content,
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
-               mtime => displaytime($mtime),
+               mtime => displaytime($pagemtime{$page}),
                baseurl => baseurl($page),
        );
 
@@ -154,7 +163,7 @@ sub scan ($) { #{{{
 
                # Always needs to be done, since filters might add links
                # to the content.
-               $content=filter($page, $content);
+               $content=filter($page, $page, $content);
 
                my @links;
                while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
@@ -181,18 +190,19 @@ sub render ($) { #{{{
        my $type=pagetype($file);
        my $srcfile=srcfile($file);
        if (defined $type) {
-               my $content=readfile($srcfile);
                my $page=pagename($file);
                delete $depends{$page};
                will_render($page, htmlpage($page), 1);
+               return if $type=~/^_/;
                
-               $content=filter($page, $content);
-               $content=preprocess($page, $page, $content);
-               $content=linkify($page, $page, $content);
-               $content=htmlize($page, $type, $content);
+               my $content=htmlize($page, $type,
+                       linkify($page, $page,
+                       preprocess($page, $page,
+                       filter($page, $page,
+                       readfile($srcfile)))));
                
-               writefile(htmlpage($page), $config{destdir},
-                       genpage($page, $content, mtime($srcfile)));
+               my $output=htmlpage($page);
+               writefile($output, $config{destdir}, genpage($page, $content));
        }
        else {
                my $srcfd=readfile($srcfile, 1, 1);
@@ -232,6 +242,19 @@ sub prune ($) { #{{{
 } #}}}
 
 sub refresh () { #{{{
+       # security check, avoid following symlinks in the srcdir path
+       my $test=$config{srcdir};
+       while (length $test) {
+               if (-l $test) {
+                       error("symlink found in srcdir path ($test)");
+               }
+               unless ($test=~s/\/+$//) {
+                       $test=dirname($test);
+               }
+       }
+       
+       run_hooks(refresh => sub { shift->() });
+
        # find existing pages
        my %exists;
        my @files;
@@ -257,44 +280,51 @@ sub refresh () { #{{{
                        }
                },
        }, $config{srcdir});
-       find({
-               no_chdir => 1,
-               wanted => sub {
-                       $_=decode_utf8($_);
-                       if (file_pruned($_, $config{underlaydir})) {
-                               $File::Find::prune=1;
-                       }
-                       elsif (! -d $_ && ! -l $_) {
-                               my ($f)=/$config{wiki_file_regexp}/; # untaint
-                               if (! defined $f) {
-                                       warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
+       foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
+               find({
+                       no_chdir => 1,
+                       wanted => sub {
+                               $_=decode_utf8($_);
+                               if (file_pruned($_, $dir)) {
+                                       $File::Find::prune=1;
                                }
-                               else {
-                                       # Don't add pages that are in the
-                                       # srcdir.
-                                       $f=~s/^\Q$config{underlaydir}\E\/?//;
-                                       if (! -e "$config{srcdir}/$f" && 
-                                           ! -l "$config{srcdir}/$f") {
-                                               my $page=pagename($f);
-                                               if (! $exists{$page}) {
-                                                       push @files, $f;
-                                                       $exists{$page}=1;
+                               elsif (! -d $_ && ! -l $_) {
+                                       my ($f)=/$config{wiki_file_regexp}/; # untaint
+                                       if (! defined $f) {
+                                               warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
+                                       }
+                                       else {
+                                               $f=~s/^\Q$dir\E\/?//;
+                                               # avoid underlaydir
+                                               # override attacks; see
+                                               # security.mdwn
+                                               if (! -e "$config{srcdir}/$f" && 
+                                                   ! -l "$config{srcdir}/$f") {
+                                                       my $page=pagename($f);
+                                                       if (! $exists{$page}) {
+                                                               push @files, $f;
+                                                               $exists{$page}=1;
+                                                       }
                                                }
                                        }
                                }
-                       }
-               },
-       }, $config{underlaydir});
+                       },
+               }, $dir);
+       };
 
-       my %rendered;
+       my (%rendered, @add, @del, @internal);
 
        # check for added or removed pages
-       my @add;
        foreach my $file (@files) {
                my $page=pagename($file);
                $pagesources{$page}=$file;
                if (! $pagemtime{$page}) {
-                       push @add, $file;
+                       if (isinternal($page)) {
+                               push @internal, $file;
+                       }
+                       else {
+                               push @add, $file;
+                       }
                        $pagecase{lc $page}=$page;
                        if ($config{getctime} && -e "$config{srcdir}/$file") {
                                $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
@@ -304,22 +334,31 @@ sub refresh () { #{{{
                        }
                }
        }
-       my @del;
        foreach my $page (keys %pagemtime) {
                if (! $exists{$page}) {
-                       debug(sprintf(gettext("removing old page %s"), $page));
-                       push @del, $pagesources{$page};
+                       if (isinternal($page)) {
+                               push @internal, $pagesources{$page};
+                       }
+                       else {
+                               debug(sprintf(gettext("removing old page %s"), $page));
+                               push @del, $pagesources{$page};
+                       }
                        $links{$page}=[];
                        $renderedfiles{$page}=[];
                        $pagemtime{$page}=0;
                        prune($config{destdir}."/".$_)
                                foreach @{$oldrenderedfiles{$page}};
                        delete $pagesources{$page};
+                       foreach (keys %destsources) {
+                               if ($destsources{$_} eq $page) {
+                                       delete $destsources{$_};
+                               }
+                       }
                }
        }
 
-       # scan changed and new files
-       my @changed;
+       # find changed and new files
+       my @needsbuild;
        foreach my $file (@files) {
                my $page=pagename($file);
                
@@ -327,20 +366,39 @@ sub refresh () { #{{{
                if (! exists $pagemtime{$page} ||
                    $mtime > $pagemtime{$page} ||
                    $forcerebuild{$page}) {
-                       debug(sprintf(gettext("scanning %s"), $file));
-                       $pagemtime{$page}=$mtime;
-                       push @changed, $file;
-                       scan($file);
+                       $pagemtime{$page}=$mtime;
+                       if (isinternal($page)) {
+                               push @internal, $file;
+                               # Preprocess internal page in scan-only mode.
+                               preprocess($page, $page, readfile(srcfile($file)), 1);
+                       }
+                       else {
+                               push @needsbuild, $file;
+                       }
                }
        }
-       calculate_backlinks();
+       run_hooks(needsbuild => sub { shift->(\@needsbuild) });
 
-       # render changed and new pages
-       foreach my $file (@changed) {
+       # scan and render files
+       foreach my $file (@needsbuild) {
+               debug(sprintf(gettext("scanning %s"), $file));
+               scan($file);
+       }
+       calculate_backlinks();
+       foreach my $file (@needsbuild) {
                debug(sprintf(gettext("rendering %s"), $file));
                render($file);
                $rendered{$file}=1;
        }
+       foreach my $file (@internal) {
+               # internal pages are not rendered
+               my $page=pagename($file);
+               delete $depends{$page};
+               foreach my $old (@{$renderedfiles{$page}}) {
+                       delete $destsources{$old};
+               }
+               $renderedfiles{$page}=[];
+       }
        
        # rebuild pages that link to added or removed pages
        if (@add || @del) {
@@ -356,16 +414,20 @@ sub refresh () { #{{{
                }
        }
 
-       if (%rendered || @del) {
+       if (%rendered || @del || @internal) {
+               my @changed=(keys %rendered, @del);
+
                # rebuild dependant pages
                foreach my $f (@files) {
                        next if $rendered{$f};
                        my $p=pagename($f);
                        if (exists $depends{$p}) {
-                               foreach my $file (keys %rendered, @del) {
+                               # only consider internal files
+                               # if the page explicitly depends on such files
+                               foreach my $file (@changed, $depends{$p}=~/internal\(/ ? @internal : ()) {
                                        next if $f eq $file;
                                        my $page=pagename($file);
-                                       if (pagespec_match($page, $depends{$p}, $p)) {
+                                       if (pagespec_match($page, $depends{$p}, location => $p)) {
                                                debug(sprintf(gettext("rendering %s, which depends on %s"), $f, $page));
                                                render($f);
                                                $rendered{$f}=1;
@@ -378,7 +440,7 @@ sub refresh () { #{{{
                # handle backlinks; if a page has added/removed links,
                # update the pages it links to
                my %linkchanged;
-               foreach my $file (keys %rendered, @del) {
+               foreach my $file (@changed) {
                        my $page=pagename($file);
                        
                        if (exists $links{$page}) {
@@ -400,6 +462,7 @@ sub refresh () { #{{{
                                }
                        }
                }
+
                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
@@ -446,12 +509,13 @@ sub commandline_render () { #{{{
        my $content=readfile($srcfile);
        my $page=pagename($file);
        $pagesources{$page}=$file;
-       $content=filter($page, $content);
+       $content=filter($page, $page, $content);
        $content=preprocess($page, $page, $content);
        $content=linkify($page, $page, $content);
        $content=htmlize($page, $type, $content);
+       $pagemtime{$page}=mtime($srcfile);
 
-       print genpage($page, $content, mtime($srcfile));
+       print genpage($page, $content);
        exit 0;
 } #}}}