]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Render.pm
refresh refactor 2
[ikiwiki.git] / IkiWiki / Render.pm
index 959279fc8a906508db1d1b8561cd390e5cc62326..5336d4f545e3bc7cff7cc606fc91432e2e3721bd 100644 (file)
@@ -7,30 +7,43 @@ use strict;
 use IkiWiki;
 use Encode;
 
-my %backlinks;
-my $backlinks_calculated=0;
-
-sub calculate_backlinks () { #{{{
-       return if $backlinks_calculated;
-       %backlinks=();
+my (%backlinks, %rendered, @new, @del, @internal, @internal_change, @files,
+       %page_exists, %oldlink_targets, %backlinkchanged,
+       %linkchangers);
+our %brokenlinks;
+my $links_calculated=0;
+
+sub calculate_links () {
+       return if $links_calculated;
+       %backlinks=%brokenlinks=();
        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;
+                       if (length $bestlink) {
+                               $backlinks{$bestlink}{$page}=1
+                                       if $bestlink ne $page;
+                       }
+                       else {
+                               push @{$brokenlinks{$link}}, $page;
                        }
                }
        }
-       $backlinks_calculated=1;
-} #}}}
+       $links_calculated=1;
+}
 
-sub backlinks ($) { #{{{
+sub backlink_pages ($) {
        my $page=shift;
 
-       calculate_backlinks();
+       calculate_links();
+
+       return keys %{$backlinks{$page}};
+}
+
+sub backlinks ($) {
+       my $page=shift;
 
        my @links;
-       foreach my $p (keys %{$backlinks{$page}}) {
+       foreach my $p (backlink_pages($page)) {
                my $href=urlto($p, $page);
                 
                # Trim common dir prefixes from both pages.
@@ -45,26 +58,9 @@ sub backlinks ($) { #{{{
                push @links, { url => $href, page => pagetitle($p_trimmed) };
        }
        return @links;
-} #}}}
-
-sub parentlinks ($) { #{{{
-       my $page=shift;
-       
-       my @ret;
-       my $pagelink="";
-       my $path="";
-       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);
-       }
-       return @ret;
-} #}}}
+}
 
-sub genpage ($$) { #{{{
+sub genpage ($$) {
        my $page=shift;
        my $content=shift;
 
@@ -80,23 +76,24 @@ sub genpage ($$) { #{{{
        my $actions=0;
 
        if (length $config{cgiurl}) {
-               $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
-               $template->param(prefsurl => cgiurl(do => "prefs"));
+               $template->param(editurl => cgiurl(do => "edit", page => $page))
+                       if IkiWiki->can("cgi_editpage");
+               $template->param(prefsurl => cgiurl(do => "prefs"))
+                       if exists $hooks{auth};
                $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);
                $actions++;
        }
        if ($config{discussion}) {
-               my $discussionlink=gettext("discussion");
-               if ($page !~ /.*\/\Q$discussionlink\E$/ &&
+               if ($page !~ /.*\/\Q$config{discussionpage}\E$/ &&
                   (length $config{cgiurl} ||
-                   exists $links{$page."/".$discussionlink})) {
-                       $template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), noimageinline => 1, forcesubpage => 1));
+                   exists $links{$page."/".$config{discussionpage}})) {
+                       $template->param(discussionlink => htmllink($page, $page, $config{discussionpage}, noimageinline => 1, forcesubpage => 1));
                        $actions++;
                }
        }
@@ -121,7 +118,6 @@ sub genpage ($$) { #{{{
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
                wikiname => $config{wikiname},
-               parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
@@ -135,6 +131,10 @@ sub genpage ($$) { #{{{
        });
        
        $content=$template->output;
+       
+       run_hooks(postscan => sub {
+               shift->(page => $page, content => $content);
+       });
 
        run_hooks(format => sub {
                $content=shift->(
@@ -144,11 +144,13 @@ sub genpage ($$) { #{{{
        });
 
        return $content;
-} #}}}
+}
 
-sub scan ($) { #{{{
+sub scan ($) {
        my $file=shift;
 
+       debug(sprintf(gettext("scanning %s"), $file));
+
        my $type=pagetype($file);
        if (defined $type) {
                my $srcfile=srcfile($file);
@@ -156,14 +158,10 @@ sub scan ($) { #{{{
                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, $page, $content);
-       
                if ($config{discussion}) {
                        # Discussion links are a special case since they're
                        # not in the text of the page, but on its template.
-                       $links{$page}=[ $page."/".gettext("discussion") ];
+                       $links{$page}=[ $page."/".lc($config{discussionpage}) ];
                }
                else {
                        $links{$page}=[];
@@ -182,20 +180,48 @@ sub scan ($) { #{{{
        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;
+       return if $rendered{$file};
+       debug(shift);
+       $rendered{$file}=1;
        
        my $type=pagetype($file);
        my $srcfile=srcfile($file);
        if (defined $type) {
                my $page=pagename($file);
                delete $depends{$page};
+               delete $depends_simple{$page};
                will_render($page, htmlpage($page), 1);
                return if $type=~/^_/;
                
-               my $content=htmlize($page, $type,
+               my $content=htmlize($page, $page, $type,
                        linkify($page, $page,
                        preprocess($page, $page,
                        filter($page, $page,
@@ -206,42 +232,30 @@ sub render ($) { #{{{
        }
        else {
                delete $depends{$file};
+               delete $depends_simple{$file};
                will_render($file, $file, 1);
                
                if ($config{hardlink}) {
-                       prep_writefile($file, $config{destdir});
-                       unlink($config{destdir}."/".$file);
-                       if (link($srcfile, $config{destdir}."/".$file)) {
-                               return;
+                       # 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 top copying
+                       # if hardlink fails, fall back to copying
                }
                
                my $srcfd=readfile($srcfile, 1, 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;
-                               }
-                       }
+                       fast_file_copy($srcfile, $file, $srcfd, @_);
                });
        }
-} #}}}
+}
 
-sub prune ($) { #{{{
+sub prune ($) {
        my $file=shift;
 
        unlink($file);
@@ -249,25 +263,24 @@ sub prune ($) { #{{{
        while (rmdir($dir)) {
                $dir=dirname($dir);
        }
-} #}}}
+}
 
-sub refresh () { #{{{
-       # security check, avoid following symlinks in the srcdir path
+sub srcdir_check () {
+       # security check, avoid following symlinks in the srcdir path by default
        my $test=$config{srcdir};
        while (length $test) {
-               if (-l $test) {
-                       error("symlink found in srcdir path ($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->() });
+}
 
-       # find existing pages
-       my %exists;
-       my @files;
+sub find_src_files () {
+       my @ret;
        eval q{use File::Find};
        error($@) if $@;
        find({
@@ -284,8 +297,12 @@ sub refresh () { #{{{
                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
-                                       push @files, $f;
-                                       $exists{pagename($f)}=1;
+                                       push @ret, $f;
+                                       my $page = pagename($f);
+                                       if ($page_exists{$page}) {
+                                               debug(sprintf(gettext("%s has multiple possible source pages"), $page));
+                                       }
+                                       $page_exists{$page}=1;
                                }
                        }
                },
@@ -311,9 +328,9 @@ sub refresh () { #{{{
                                                if (! -l "$config{srcdir}/$f" && 
                                                    ! -e _) {
                                                        my $page=pagename($f);
-                                                       if (! $exists{$page}) {
-                                                               push @files, $f;
-                                                               $exists{$page}=1;
+                                                       if (! $page_exists{$page}) {
+                                                               push @ret, $f;
+                                                               $page_exists{$page}=1;
                                                        }
                                                }
                                        }
@@ -321,18 +338,23 @@ sub refresh () { #{{{
                        },
                }, $dir);
        };
+       return \@ret;
+}
 
-       my (%rendered, @add, @del, @internal);
-       # check for added or removed pages
+sub process_new_files () {
        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}) {
                        if (isinternal($page)) {
                                push @internal, $file;
                        }
                        else {
-                               push @add, $file;
+                               push @new, $file;
                                if ($config{getctime} && -e "$config{srcdir}/$file") {
                                        eval {
                                                my $time=rcs_getctime("$config{srcdir}/$file");
@@ -349,8 +371,11 @@ sub refresh () { #{{{
                        }
                }
        }
+}
+
+sub process_del_files () {
        foreach my $page (keys %pagemtime) {
-               if (! $exists{$page}) {
+               if (! $page_exists{$page}) {
                        if (isinternal($page)) {
                                push @internal, $pagesources{$page};
                        }
@@ -361,18 +386,20 @@ sub refresh () { #{{{
                        $links{$page}=[];
                        $renderedfiles{$page}=[];
                        $pagemtime{$page}=0;
-                       prune($config{destdir}."/".$_)
-                               foreach @{$oldrenderedfiles{$page}};
+                       foreach my $old (@{$oldrenderedfiles{$page}}) {
+                               prune($config{destdir}."/".$old);
+                       }
                        delete $pagesources{$page};
-                       foreach (keys %destsources) {
-                               if ($destsources{$_} eq $page) {
-                                       delete $destsources{$_};
+                       foreach my $source (keys %destsources) {
+                               if ($destsources{$source} eq $page) {
+                                       delete $destsources{$source};
                                }
                        }
                }
        }
+}
 
-       # find changed and new files
+sub find_needsbuild () {
        my @needsbuild;
        foreach my $file (@files) {
                my $page=pagename($file);
@@ -381,123 +408,209 @@ sub refresh () { #{{{
                    $stat[9] > $pagemtime{$page} ||
                    $forcerebuild{$page}) {
                        $pagemtime{$page}=$stat[9];
+
                        if (isinternal($page)) {
-                               push @internal, $file;
                                # Preprocess internal page in scan-only mode.
                                preprocess($page, $page, readfile($srcfile), 1);
+                               push @internal_change, $file;
                        }
                        else {
                                push @needsbuild, $file;
                        }
                }
        }
-       run_hooks(needsbuild => sub { shift->(\@needsbuild) });
+       return @needsbuild;
+}
 
-       # scan and render files
-       foreach my $file (@needsbuild) {
-               debug(sprintf(gettext("scanning %s"), $file));
-               scan($file);
+sub calculate_old_links ($) {
+       my $file=shift;
+       my $page=pagename($file);
+       if (exists $oldlinks{$page}) {
+               foreach my $l (@{$oldlinks{$page}}) {
+                       $oldlink_targets{$page}{$l}=bestlink($page, $l);
+               }
        }
-       calculate_backlinks();
-       foreach my $file (@needsbuild) {
-               debug(sprintf(gettext("rendering %s"), $file));
-               render($file);
-               $rendered{$file}=1;
+}
+
+sub derender_internal ($) {
+       my $file=shift;
+       my $page=pagename($file);
+       delete $depends{$page};
+       delete $depends_simple{$page};
+       foreach my $old (@{$renderedfiles{$page}}) {
+               delete $destsources{$old};
        }
-       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}=[];
+       $renderedfiles{$page}=[];
+}
+
+sub render_linkers ($) {
+       my $f=shift;
+       my $p=pagename($f);
+       foreach my $page (keys %{$backlinks{$p}}) {
+               my $file=$pagesources{$page};
+               render($file, sprintf(gettext("building %s, which links to %s"), $file, $p));
        }
-       
-       # rebuild pages that link to added or removed pages
-       if (@add || @del) {
-               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;
+}
+
+sub remove_unrendered () {
+       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 built by %s"), $file, $page));
+                               prune($config{destdir}."/".$file);
                        }
                }
        }
+}
 
-       if (%rendered || @del || @internal) {
-               my @changed=(keys %rendered, @del);
+sub calculate_changed_links ($) {
+       my $file=shift;
+       my $page=pagename($file);
+       if (exists $links{$page}) {
+               foreach my $l (@{$links{$page}}) {
+                       my $target=bestlink($page, $l);
+                       if (! exists $oldlink_targets{$page}{$l} ||
+                           $target ne $oldlink_targets{$page}{$l}) {
+                               $backlinkchanged{$l}=1;
+                               $linkchangers{lc($page)}=1;
+                       }
+                       delete $oldlink_targets{$page}{$l};
+               }
+       }
+       if (exists $oldlink_targets{$page} &&
+           %{$oldlink_targets{$page}}) {
+               foreach my $target (keys %{$oldlink_targets{$page}}) {
+                       $backlinkchanged{$target}=1;
+               }
+               $linkchangers{lc($page)}=1;
+       }
+}
 
-               # rebuild dependant pages
-               foreach my $f (@files) {
-                       next if $rendered{$f};
-                       my $p=pagename($f);
-                       if (exists $depends{$p}) {
-                               # 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)) {
-                                               debug(sprintf(gettext("rendering %s, which depends on %s"), $f, $page));
-                                               render($f);
-                                               $rendered{$f}=1;
-                                               last;
-                                       }
+sub render_dependent () {
+       my @changed=(keys %rendered, @del);
+       my @exists_changed=(@new, @del);
+       
+       my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
+       my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;
+        
+       foreach my $f (@files) {
+               next if $rendered{$f};
+               my $p=pagename($f);
+               my $reason = undef;
+       
+               if (exists $depends_simple{$p}) {
+                       foreach my $d (keys %{$depends_simple{$p}}) {
+                               if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
+                                    $lc_changed{$d})
+                                   ||
+                                   ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_PRESENCE &&
+                                    $lc_exists_changed{$d})
+                                   ||
+                                   ($depends_simple{$p}{$d} & $IkiWiki::DEPEND_LINKS &&
+                                    $linkchangers{$d})
+                               ) {
+                                       $reason = $d;
+                                       last;
                                }
                        }
                }
-               
-               # handle backlinks; if a page has added/removed links,
-               # update the pages it links to
-               my %linkchanged;
-               foreach my $file (@changed) {
-                       my $page=pagename($file);
-                       
-                       if (exists $links{$page}) {
-                               foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
-                                       if (length $link &&
-                                           (! exists $oldlinks{$page} ||
-                                            ! grep { bestlink($page, $_) eq $link } @{$oldlinks{$page}})) {
-                                               $linkchanged{$link}=1;
-                                       }
+       
+               if (exists $depends{$p} && ! defined $reason) {
+                       D: foreach my $d (keys %{$depends{$p}}) {
+                               my $sub=pagespec_translate($d);
+                               next if $@ || ! defined $sub;
+
+                               # only consider internal files
+                               # if the page explicitly depends
+                               # on such files
+                               my $internal_dep=$d =~ /internal\(/;
+
+                               my @candidates;
+                               if ($depends{$p}{$d} & $IkiWiki::DEPEND_PRESENCE) {
+                                       @candidates=@exists_changed;
+                                       push @candidates, @internal
+                                               if $internal_dep;
                                }
-                       }
-                       if (exists $oldlinks{$page}) {
-                               foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
-                                       if (length $link &&
-                                           (! exists $links{$page} || 
-                                            ! grep { bestlink($page, $_) eq $link } @{$links{$page}})) {
-                                               $linkchanged{$link}=1;
+                               if (($depends{$p}{$d} & ($IkiWiki::DEPEND_CONTENT | $IkiWiki::DEPEND_LINKS))) {
+                                       @candidates=@changed;
+                                       push @candidates, @internal, @internal_change
+                                               if $internal_dep;
+                               }
+
+                               foreach my $file (@candidates) {
+                                       next if $file eq $f;
+                                       my $page=pagename($file);
+                                       if ($sub->($page, location => $p)) {
+                                               if ($depends{$p}{$d} & $IkiWiki::DEPEND_LINKS) {
+                                                       next unless $linkchangers{lc($page)};
+                                               }
+                                               $reason = $page;
+                                               last D;
                                        }
                                }
                        }
                }
-
-               foreach my $link (keys %linkchanged) {
-                       my $linkfile=$pagesources{$link};
-                       if (defined $linkfile) {
-                               next if $rendered{$linkfile};
-                               debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile));
-                               render($linkfile);
-                               $rendered{$linkfile}=1;
-                       }
+       
+               if (defined $reason) {
+                       render($f, sprintf(gettext("building %s, which depends on %s"), $f, $reason));
+                       return 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);
-                       }
+       return 0;
+}
+
+sub render_backlinks () {
+       foreach my $link (keys %backlinkchanged) {
+               my $linkfile=$pagesources{$link};
+               if (defined $linkfile) {
+                       render($linkfile, sprintf(gettext("building %s, to update its backlinks"), $linkfile));
                }
        }
+}
+
+sub refresh () {
+       srcdir_check();
+       run_hooks(refresh => sub { shift->() });
+       @files=@{find_src_files()};
+       process_new_files();
+       process_del_files();
+
+       my @needsbuild=find_needsbuild();
+       run_hooks(needsbuild => sub { shift->(\@needsbuild) });
+
+       foreach my $file (@needsbuild, @del) {
+               calculate_old_links($file);
+       }
+
+       foreach my $file (@needsbuild) {
+               scan($file);
+       }
+
+       calculate_links();
+
+       foreach my $file (@needsbuild) {
+               render($file, sprintf(gettext("building %s"), $file));
+       }
+       foreach my $file (@internal, @internal_change) {
+               derender_internal($file);
+       }
+
+       foreach my $file (@needsbuild, @del) {
+               calculate_changed_links($file);
+       }
+
+       foreach my $file (@new, @del) {
+               render_linkers($file);
+       }
+       
+       if (@needsbuild || @del || @internal || @internal_change) {
+               1 while render_dependent();
+       }
+
+       render_backlinks();
+       remove_unrendered();
 
        if (@del) {
                run_hooks(delete => sub { shift->(@del) });
@@ -505,11 +618,9 @@ sub refresh () { #{{{
        if (%rendered) {
                run_hooks(change => sub { shift->(keys %rendered) });
        }
-} #}}}
+}
 
-sub commandline_render () { #{{{
-       loadplugins();
-       checkconfig();
+sub commandline_render () {
        lockwiki();
        loadindex();
        unlockwiki();
@@ -519,18 +630,19 @@ sub commandline_render () { #{{{
        $file=~s/\Q$config{srcdir}\E\/?//;
 
        my $type=pagetype($file);
-       die sprintf(gettext("ikiwiki: cannot render %s"), $srcfile)."\n" unless defined $type;
+       die sprintf(gettext("ikiwiki: cannot build %s"), $srcfile)."\n" unless defined $type;
        my $content=readfile($srcfile);
        my $page=pagename($file);
        $pagesources{$page}=$file;
        $content=filter($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);
        exit 0;
-} #}}}
+}
 
 1