link to other todo item, personal opinions

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 0b7e00d9d0af606f3bd5e0483fd29bb749969f4f..adae9f0d5898dee39190a29328fa7e221c82dcdc 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -10,7 +10,7 @@ use Encode;
 my %backlinks;
 my $backlinks_calculated=0;
 
 my %backlinks;
 my $backlinks_calculated=0;
 

-sub calculate_backlinks () { #{{{
+sub calculate_backlinks () {

        return if $backlinks_calculated;
        %backlinks=();
        foreach my $page (keys %links) {
        return if $backlinks_calculated;
        %backlinks=();
        foreach my $page (keys %links) {


@@ -22,9 +22,9 @@ sub calculate_backlinks () { #{{{
                }
        }
        $backlinks_calculated=1;
                }
        }
        $backlinks_calculated=1;

-} #}}}
+}

 
 

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

        my $page=shift;
 
        calculate_backlinks();
        my $page=shift;
 
        calculate_backlinks();


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

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

 
 

-       return \@links, [] if @links <= $config{numbacklinks} || ! $config{numbacklinks};
-       return [@links[0..$config{numbacklinks}-1]],
-              [@links[$config{numbacklinks}..$#links]];
-} #}}}
-
-sub parentlinks ($) { #{{{
-       my $page=shift;
-       
-       my @ret;
-       my $pagelink="";
-       my $path="";
-       my $title=$config{wikiname};
-       
-       return if $page eq 'index'; # toplevel
-       foreach my $dir (split("/", $page)) {
-               push @ret, { url => urlto($path, $page), page => $title };
-               $path.="/".$dir;
-               $title=pagetitle($dir);
-       }
-       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 => pagetitle($page, 1)));
+               $template->param(editurl => cgiurl(do => "edit", page => $page))
+                       if IkiWiki->can("cgi_editpage");

                $template->param(prefsurl => cgiurl(do => "prefs"));
                $template->param(prefsurl => cgiurl(do => "prefs"));

-               if ($config{rcs}) {
-                       $template->param(recentchangesurl => cgiurl(do => "recentchanges"));
-               }

                $actions++;
        }
                $actions++;
        }

-
-       if (length $config{historyurl}) {
+               
+       if (defined $config{historyurl} && length $config{historyurl}) {

                my $u=$config{historyurl};
                $u=~s/\[\[file\]\]/$pagesources{$page}/g;
                $template->param(historyurl => $u);
                my $u=$config{historyurl};
                $u=~s/\[\[file\]\]/$pagesources{$page}/g;
                $template->param(historyurl => $u);


@@ -105,18 +89,27 @@ sub genpage ($$$) { #{{{
                $template->param(have_actions => 1);
        }
 
                $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' 
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
                wikiname => $config{wikiname},
 
        $template->param(
                title => $page eq 'index' 
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
                wikiname => $config{wikiname},

-               parentlinks => [parentlinks($page)],

                content => $content,
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
                content => $content,
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,

-               mtime => displaytime($mtime),
+               mtime => displaytime($pagemtime{$page}),
+               ctime => displaytime($pagectime{$page}),

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


@@ -125,6 +118,10 @@ sub genpage ($$$) { #{{{
        });
        
        $content=$template->output;
        });
        
        $content=$template->output;

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

 
        run_hooks(format => sub {
                $content=shift->(
 
        run_hooks(format => sub {
                $content=shift->(


@@ -134,15 +131,9 @@ sub genpage ($$$) { #{{{
        });
 
        return $content;
        });
 
        return $content;

-} #}}}
+}

 
 

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

        my $file=shift;
 
        my $type=pagetype($file);
        my $file=shift;
 
        my $type=pagetype($file);


@@ -152,76 +143,99 @@ sub scan ($) { #{{{
                my $page=pagename($file);
                will_render($page, htmlpage($page), 1);
 
                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, linkpage($2);
-               }

                if ($config{discussion}) {
                        # Discussion links are a special case since they're
                        # not in the text of the page, but on its template.
                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}=[ $page."/".gettext("discussion") ];

                }
                }

-               $links{$page}=\@links;
-               
+               else {
+                       $links{$page}=[];
+               }
+
+               run_hooks(scan => sub {
+                       shift->(
+                               page => $page,
+                               content => $content,
+                       );
+               });
+

                # Preprocess in scan-only mode.
                preprocess($page, $page, $content, 1);
        }
        else {
                will_render($file, $file, 1);
        }
                # Preprocess in scan-only mode.
                preprocess($page, $page, $content, 1);
        }
        else {
                will_render($file, $file, 1);
        }

-} #}}}
+}
+
+sub fast_file_copy (@) {
+       my $srcfile=shift;
+       my $destfile=shift;
+       my $srcfd=shift;
+       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 $destfile: $!", $cleanup);
+                       $len -= $written;
+                       $offset += $written;
+               }
+       }
+}

 
 

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

        my $file=shift;
        
        my $type=pagetype($file);
        my $srcfile=srcfile($file);
        if (defined $type) {
        my $file=shift;
        
        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);

+               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, $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 {
        }
        else {

-               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}, 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;
+               
+               if ($config{hardlink}) {
+                       # only hardlink if owned by same user
+                       my @stat=stat($srcfile);
+                       if ($stat[4] == $>) {
+                               prep_writefile($file, $config{destdir});
+                               unlink($config{destdir}."/".$file);
+                               if (link($srcfile, $config{destdir}."/".$file)) {
+                                       return;

                                }
                        }
                                }
                        }

+                       # if hardlink fails, fall back to copying
+               }
+               
+               my $srcfd=readfile($srcfile, 1, 1);
+               writefile($file, $config{destdir}, undef, 1, sub {
+                       fast_file_copy($srcfile, $file, $srcfd, @_);

                });
        }
                });
        }

-} #}}}
+}

 
 

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

        my $file=shift;
 
        unlink($file);
        my $file=shift;
 
        unlink($file);


@@ -229,9 +243,22 @@ sub prune ($) { #{{{
        while (rmdir($dir)) {
                $dir=dirname($dir);
        }
        while (rmdir($dir)) {
                $dir=dirname($dir);
        }

-} #}}}
+}
+
+sub refresh () {
+       # security check, avoid following symlinks in the srcdir path by default
+       my $test=$config{srcdir};
+       while (length $test) {
+               if (-l $test && ! $config{allow_symlinks_before_srcdir}) {
+                       error(sprintf(gettext("symlink found in srcdir path (%s) -- set allow_symlinks_before_srcdir to allow this"), $test));
+               }
+               unless ($test=~s/\/+$//) {
+                       $test=dirname($test);
+               }
+       }
+       
+       run_hooks(refresh => sub { shift->() });

 
 

-sub refresh () { #{{{

        # find existing pages
        my %exists;
        my @files;
        # find existing pages
        my %exists;
        my @files;


@@ -244,7 +271,7 @@ sub refresh () { #{{{
                        if (file_pruned($_, $config{srcdir})) {
                                $File::Find::prune=1;
                        }
                        if (file_pruned($_, $config{srcdir})) {
                                $File::Find::prune=1;
                        }

-                       elsif (! -d $_ && ! -l $_) {
+                       elsif (! -l $_ && ! -d _) {

                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                        warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                        warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");


@@ -252,95 +279,142 @@ sub refresh () { #{{{
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
                                        push @files, $f;
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
                                        push @files, $f;

-                                       $exists{pagename($f)}=1;
+                                       my $pagename = pagename($f);
+                                       if ($exists{$pagename}) {
+                                               debug(sprintf(gettext("%s has multiple possible source pages"), $pagename));
+                                       }
+                                       $exists{$pagename}=1;

                                }
                        }
                },
        }, $config{srcdir});
                                }
                        }
                },
        }, $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 (! -l $_ && ! -d _) {
+                                       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 (! -l "$config{srcdir}/$f" && 
+                                                   ! -e _) {
+                                                       my $page=pagename($f);
+                                                       if (! $exists{$page}) {
+                                                               push @files, $f;
+                                                               $exists{$page}=1;
+                                                       }

                                                }
                                        }
                                }
                                                }
                                        }
                                }

-                       }
-               },
-       }, $config{underlaydir});
-
-       my %rendered;
+                       },
+               }, $dir);
+       };

 
 

+       my (%rendered, @add, @del, @internal);

        # check for added or removed pages
        # check for added or removed pages

-       my @add;

        foreach my $file (@files) {
                my $page=pagename($file);
        foreach my $file (@files) {
                my $page=pagename($file);

+               if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
+                       # the page has changed its type
+                       $forcerebuild{$page}=1;
+               }

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

-                       push @add, $file;
-                       $pagecase{lc $page}=$page;
-                       if ($config{getctime} && -e "$config{srcdir}/$file") {
-                               $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
+                       if (isinternal($page)) {
+                               push @internal, $file;

                        }
                        }

-                       elsif (! exists $pagectime{$page}) {
-                               $pagectime{$page}=mtime(srcfile($file));
+                       else {
+                               push @add, $file;
+                               if ($config{getctime} && -e "$config{srcdir}/$file") {
+                                       eval {
+                                               my $time=rcs_getctime("$config{srcdir}/$file");
+                                               $pagectime{$page}=$time;
+                                       };
+                                       if ($@) {
+                                               print STDERR $@;
+                                       }
+                               }
+                       }
+                       $pagecase{lc $page}=$page;
+                       if (! exists $pagectime{$page}) {
+                               $pagectime{$page}=(srcfile_stat($file))[10];

                        }
                }
        }
                        }
                }
        }

-       my @del;

        foreach my $page (keys %pagemtime) {
                if (! $exists{$page}) {
        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};
                        $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);
        foreach my $file (@files) {
                my $page=pagename($file);

-               
-               my $mtime=mtime(srcfile($file));
+               my ($srcfile, @stat)=srcfile_stat($file);

                if (! exists $pagemtime{$page} ||
                if (! exists $pagemtime{$page} ||

-                   $mtime > $pagemtime{$page} ||
+                   $stat[9] > $pagemtime{$page} ||

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

-                       debug(sprintf(gettext("scanning %s"), $file));
-                       $pagemtime{$page}=$mtime;
-                       push @changed, $file;
-                       scan($file);
+                       $pagemtime{$page}=$stat[9];
+                       if (isinternal($page)) {
+                               push @internal, $file;
+                               # Preprocess internal page in scan-only mode.
+                               preprocess($page, $page, readfile($srcfile), 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;
        }
                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) {
        
        # rebuild pages that link to added or removed pages
        if (@add || @del) {


@@ -356,13 +430,17 @@ 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}) {
                # 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}, location => $p)) {
                                        next if $f eq $file;
                                        my $page=pagename($file);
                                        if (pagespec_match($page, $depends{$p}, location => $p)) {


@@ -378,7 +456,7 @@ sub refresh () { #{{{
                # handle backlinks; if a page has added/removed links,
                # update the pages it links to
                my %linkchanged;
                # 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}) {
                        my $page=pagename($file);
                        
                        if (exists $links{$page}) {


@@ -400,6 +478,7 @@ sub refresh () { #{{{
                                }
                        }
                }
                                }
                        }
                }

+

                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {


@@ -428,11 +507,9 @@ sub refresh () { #{{{
        if (%rendered) {
                run_hooks(change => sub { shift->(keys %rendered) });
        }
        if (%rendered) {
                run_hooks(change => sub { shift->(keys %rendered) });
        }

-} #}}}
+}

 
 

-sub commandline_render () { #{{{
-       loadplugins();
-       checkconfig();
+sub commandline_render () {

        lockwiki();
        loadindex();
        unlockwiki();
        lockwiki();
        loadindex();
        unlockwiki();


@@ -446,13 +523,15 @@ sub commandline_render () { #{{{
        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=preprocess($page, $page, $content);
        $content=linkify($page, $page, $content);

-       $content=htmlize($page, $type, $content);
+       $content=htmlize($page, $page, $type, $content);
+       $pagemtime{$page}=(stat($srcfile))[9];
+       $pagectime{$page}=$pagemtime{$page} if ! exists $pagectime{$page};

 
 

-       print genpage($page, $content, mtime($srcfile));
+       print genpage($page, $content);

        exit 0;
        exit 0;

-} #}}}
+}

 
 1
 
 1