add an id field to the rcs_recentchanges return structure

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index f59e54f2934a2c459660eada83b11dff925cd573..4fefadf09d5994c982735da22f6da194a563be50 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -11,6 +11,7 @@ my %backlinks;
 my $backlinks_calculated=0;
 
 sub calculate_backlinks () { #{{{
 my $backlinks_calculated=0;
 
 sub calculate_backlinks () { #{{{

+       return if $backlinks_calculated;

        %backlinks=();
        foreach my $page (keys %links) {
                foreach my $link (@{$links{$page}}) {
        %backlinks=();
        foreach my $page (keys %links) {
                foreach my $link (@{$links{$page}}) {


@@ -26,13 +27,12 @@ sub calculate_backlinks () { #{{{
 sub backlinks ($) { #{{{
        my $page=shift;
 
 sub backlinks ($) { #{{{
        my $page=shift;
 

-       calculate_backlinks() unless $backlinks_calculated;
+       calculate_backlinks();

 
        my @links;
 
        my @links;

-       return unless $backlinks{$page};

        foreach my $p (keys %{$backlinks{$page}}) {
        foreach my $p (keys %{$backlinks{$page}}) {

-               my $href=abs2rel(htmlpage($p), dirname($page));
-                       
+               my $href=urlto($p, $page);
+                

                # Trim common dir prefixes from both pages.
                my $p_trimmed=$p;
                my $page_trimmed=$page;
                # Trim common dir prefixes from both pages.
                my $p_trimmed=$p;
                my $page_trimmed=$page;


@@ -44,8 +44,7 @@ sub backlinks ($) { #{{{
                               
                push @links, { url => $href, page => pagetitle($p_trimmed) };
        }
                               
                push @links, { url => $href, page => pagetitle($p_trimmed) };
        }

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

 } #}}}
 
 sub parentlinks ($) { #{{{
 } #}}}
 
 sub parentlinks ($) { #{{{


@@ -54,31 +53,34 @@ sub parentlinks ($) { #{{{
        my @ret;
        my $pagelink="";
        my $path="";
        my @ret;
        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.htmlpage($dir), page => pagetitle($dir) };
-               }
-               else {
-                       $skip=0;
-               }
+       my $title=$config{wikiname};
+       
+       foreach my $dir (split("/", $page)) {
+               next if $dir eq 'index';
+               push @ret, { url => urlto($path, $page), page => $title };
+               $path.="/".$dir;
+               $title=pagetitle($dir);

        }
        }

-       unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };

        return @ret;
 } #}}}
 
        return @ret;
 } #}}}
 

-sub genpage ($$$) { #{{{
+sub genpage ($$) { #{{{

        my $page=shift;
        my $content=shift;
        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}) {
        my $actions=0;
 
        if (length $config{cgiurl}) {

-               $template->param(editurl => cgiurl(do => "edit", page => $page));
+               $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"));
                $template->param(prefsurl => cgiurl(do => "prefs"));
                if ($config{rcs}) {
                        $template->param(recentchangesurl => cgiurl(do => "recentchanges"));


@@ -93,14 +95,30 @@ 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"), noimageinline => 1, forcesubpage => 1));
+                       $actions++;
+               }

        }
 
        if ($actions) {
                $template->param(have_actions => 1);
        }
 
        }
 
        if ($actions) {
                $template->param(have_actions => 1);
        }
 

+       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' 
                        ? $config{wikiname} 
        $template->param(
                title => $page eq 'index' 
                        ? $config{wikiname} 


@@ -108,8 +126,9 @@ sub genpage ($$$) { #{{{
                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,

-               backlinks => [backlinks($page)],
-               mtime => displaytime($mtime),
+               backlinks => $backlinks,
+               more_backlinks => $more_backlinks,
+               mtime => displaytime($pagemtime{$page}),

                baseurl => baseurl($page),
        );
 
                baseurl => baseurl($page),
        );
 


@@ -147,16 +166,16 @@ sub scan ($) { #{{{
 
                # Always needs to be done, since filters might add links
                # to the content.
 
                # 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) {
 
                my @links;
                while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {

-                       push @links, titlepage($2);
+                       push @links, linkpage($2);

                }
                if ($config{discussion}) {
                }
                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/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;
                
                }
                $links{$page}=\@links;
                


@@ -174,26 +193,45 @@ sub render ($) { #{{{
        my $type=pagetype($file);
        my $srcfile=srcfile($file);
        if (defined $type) {
        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);
                
                my $page=pagename($file);
                delete $depends{$page};
                will_render($page, htmlpage($page), 1);
                

-               $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)));
-               $oldpagemtime{$page}=time;
+               my $output=htmlpage($page);
+               writefile($output, $config{destdir}, genpage($page, $content));
+               utime($pagemtime{$page}, $pagemtime{$page}, $config{destdir}."/".$output);

        }
        else {
        }
        else {

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

                delete $depends{$file};
                will_render($file, $file, 1);
                delete $depends{$file};
                will_render($file, $file, 1);

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

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


@@ -208,21 +246,33 @@ sub prune ($) { #{{{
 } #}}}
 
 sub refresh () { #{{{
 } #}}}
 
 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);
+               }
+       }
+

        # find existing pages
        my %exists;
        my @files;
        eval q{use File::Find};
        # find existing pages
        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\/?//;


@@ -232,31 +282,37 @@ 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");
+       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 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;
+                               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;
 


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

-               if (! $oldpagemtime{$page}) {
+               $pagesources{$page}=$file;
+               if (! $pagemtime{$page}) {

                        push @add, $file;
                        $pagecase{lc $page}=$page;
                        push @add, $file;
                        $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");
                        }


@@ -277,56 +333,61 @@ sub refresh () { #{{{
                }
        }
        my @del;
                }
        }
        my @del;

-       foreach my $page (keys %oldpagemtime) {
+       foreach my $page (keys %pagemtime) {

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

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

                        push @del, $pagesources{$page};
                        $links{$page}=[];
                        $renderedfiles{$page}=[];
                        push @del, $pagesources{$page};
                        $links{$page}=[];
                        $renderedfiles{$page}=[];

-                       $oldpagemtime{$page}=0;
+                       $pagemtime{$page}=0;

                        prune($config{destdir}."/".$_)
                                foreach @{$oldrenderedfiles{$page}};
                        delete $pagesources{$page};
                        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);
                
        foreach my $file (@files) {
                my $page=pagename($file);
                

-               if (! exists $oldpagemtime{$page} ||
-                   mtime(srcfile($file)) > $oldpagemtime{$page} ||
+               my $mtime=mtime(srcfile($file));
+               if (! exists $pagemtime{$page} ||
+                   $mtime > $pagemtime{$page} ||

                    $forcerebuild{$page}) {
                    $forcerebuild{$page}) {

-                       debug("scanning $file");
-                       push @changed, $file;
-                       scan($file);
+                       $pagemtime{$page}=$mtime;
+                       push @needsbuild, $file;

                }
        }
                }
        }

+       run_hooks(needsbuild => sub { shift->(\@needsbuild) });

 
 

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

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

-FILE:          foreach my $file (@files) {
-                       next if $rendered{$file};
-                       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;

                        }
                }
        }
                        }
                }
        }


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

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


@@ -379,7 +440,7 @@ FILE:               foreach my $file (@files) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
                                next if $rendered{$linkfile};
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
                                next if $rendered{$linkfile};

-                               debug("rendering $linkfile, to update its backlinks");
+                               debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile));

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


@@ -391,7 +452,7 @@ FILE:               foreach my $file (@files) {
                my $page=pagename($src);
                foreach my $file (@{$oldrenderedfiles{$page}}) {
                        if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
                my $page=pagename($src);
                foreach my $file (@{$oldrenderedfiles{$page}}) {
                        if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {

-                               debug("removing $file, no longer rendered by $page");
+                               debug(sprintf(gettext("removing %s, no longer rendered by %s"), $file, $page));

                                prune($config{destdir}."/".$file);
                        }
                }
                                prune($config{destdir}."/".$file);
                        }
                }


@@ -417,16 +478,17 @@ sub commandline_render () { #{{{
        $file=~s/\Q$config{srcdir}\E\/?//;
 
        my $type=pagetype($file);
        $file=~s/\Q$config{srcdir}\E\/?//;
 
        my $type=pagetype($file);

-       die "ikiwiki: cannot render $srcfile\n" unless defined $type;
+       die sprintf(gettext("ikiwiki: cannot render %s"), $srcfile)."\n" unless defined $type;

        my $content=readfile($srcfile);
        my $page=pagename($file);
        $pagesources{$page}=$file;
        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);
        $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;
 } #}}}
 
        exit 0;
 } #}}}