split up refresh

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 8e4c8af71f8a2df4c0f59f0971309f76b040cd69..c07be98f84d0a255b5d304bef6d16a7d923e49ba 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -7,30 +7,43 @@ use strict;
 use IkiWiki;
 use Encode;
 
 use IkiWiki;
 use Encode;
 

-our %backlinks=();
-our $backlinks_calculated=0;
-
-sub calculate_backlinks () {
-       return if $backlinks_calculated;
-       %backlinks=();
+my (%backlinks, %rendered, @new, @del, @internal, @internal_change, @files,
+       %page_exists, %oldlink_targets, @needsbuild, %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);
        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;
 
        my $page=shift;
 

-       calculate_backlinks();
+       calculate_links();
+
+       return keys %{$backlinks{$page}};
+}
+
+sub backlinks ($) {
+       my $page=shift;

 
        my @links;
 
        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.
                my $href=urlto($p, $page);
                 
                # Trim common dir prefixes from both pages.


@@ -65,7 +78,8 @@ sub genpage ($$) {
        if (length $config{cgiurl}) {
                $template->param(editurl => cgiurl(do => "edit", page => $page))
                        if IkiWiki->can("cgi_editpage");
        if (length $config{cgiurl}) {
                $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 exists $hooks{auth};

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


@@ -76,11 +90,10 @@ sub genpage ($$) {
                $actions++;
        }
        if ($config{discussion}) {
                $actions++;
        }
        if ($config{discussion}) {

-               my $discussionlink=gettext("discussion");
-               if ($page !~ /.*\/\Q$discussionlink\E$/ &&
+               if ($page !~ /.*\/\Q$config{discussionpage}\E$/ &&

                   (length $config{cgiurl} ||
                   (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++;
                }
        }
                        $actions++;
                }
        }


@@ -136,6 +149,8 @@ sub genpage ($$) {
 sub scan ($) {
        my $file=shift;
 
 sub scan ($) {
        my $file=shift;
 

+       debug(sprintf(gettext("scanning %s"), $file));
+

        my $type=pagetype($file);
        if (defined $type) {
                my $srcfile=srcfile($file);
        my $type=pagetype($file);
        if (defined $type) {
                my $srcfile=srcfile($file);


@@ -146,7 +161,7 @@ sub scan ($) {
                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.

-                       $links{$page}=[ $page."/".gettext("discussion") ];
+                       $links{$page}=[ $page."/".lc($config{discussionpage}) ];

                }
                else {
                        $links{$page}=[];
                }
                else {
                        $links{$page}=[];


@@ -191,14 +206,18 @@ sub fast_file_copy (@) {
        }
 }
 
        }
 }
 

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

        my $file=shift;
        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};
        
        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=~/^_/;
                
                will_render($page, htmlpage($page), 1);
                return if $type=~/^_/;
                


@@ -213,6 +232,7 @@ sub render ($) {
        }
        else {
                delete $depends{$file};
        }
        else {
                delete $depends{$file};

+               delete $depends_simple{$file};

                will_render($file, $file, 1);
                
                if ($config{hardlink}) {
                will_render($file, $file, 1);
                
                if ($config{hardlink}) {


@@ -245,7 +265,7 @@ sub prune ($) {
        }
 }
 
        }
 }
 

-sub refresh () {
+sub srcdir_check () {

        # security check, avoid following symlinks in the srcdir path by default
        my $test=$config{srcdir};
        while (length $test) {
        # security check, avoid following symlinks in the srcdir path by default
        my $test=$config{srcdir};
        while (length $test) {


@@ -257,11 +277,10 @@ sub refresh () {
                }
        }
        
                }
        }
        

-       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({
        eval q{use File::Find};
        error($@) if $@;
        find({


@@ -278,12 +297,12 @@ sub refresh () {
                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;

-                                       push @files, $f;
-                                       my $pagename = pagename($f);
-                                       if ($exists{$pagename}) {
-                                               debug(sprintf(gettext("%s has multiple possible source pages"), $pagename));
+                                       push @ret, $f;
+                                       my $page = pagename($f);
+                                       if ($page_exists{$page}) {
+                                               debug(sprintf(gettext("%s has multiple possible source pages"), $page));

                                        }
                                        }

-                                       $exists{$pagename}=1;
+                                       $page_exists{$page}=1;

                                }
                        }
                },
                                }
                        }
                },


@@ -309,9 +328,9 @@ sub refresh () {
                                                if (! -l "$config{srcdir}/$f" && 
                                                    ! -e _) {
                                                        my $page=pagename($f);
                                                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;

                                                        }
                                                }
                                        }
                                                        }
                                                }
                                        }


@@ -319,9 +338,10 @@ sub refresh () {
                        },
                }, $dir);
        };
                        },
                }, $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) {
        foreach my $file (@files) {
                my $page=pagename($file);
                if (exists $pagesources{$page} && $pagesources{$page} ne $file) {


@@ -334,7 +354,7 @@ sub refresh () {
                                push @internal, $file;
                        }
                        else {
                                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");
                                if ($config{getctime} && -e "$config{srcdir}/$file") {
                                        eval {
                                                my $time=rcs_getctime("$config{srcdir}/$file");


@@ -351,8 +371,11 @@ sub refresh () {
                        }
                }
        }
                        }
                }
        }

+}
+
+sub process_del_files () {

        foreach my $page (keys %pagemtime) {
        foreach my $page (keys %pagemtime) {

-               if (! $exists{$page}) {
+               if (! $page_exists{$page}) {

                        if (isinternal($page)) {
                                push @internal, $pagesources{$page};
                        }
                        if (isinternal($page)) {
                                push @internal, $pagesources{$page};
                        }


@@ -363,19 +386,20 @@ sub refresh () {
                        $links{$page}=[];
                        $renderedfiles{$page}=[];
                        $pagemtime{$page}=0;
                        $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};
                        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
-       my @needsbuild;
+sub find_needsbuild () {

        foreach my $file (@files) {
                my $page=pagename($file);
                my ($srcfile, @stat)=srcfile_stat($file);
        foreach my $file (@files) {
                my $page=pagename($file);
                my ($srcfile, @stat)=srcfile_stat($file);


@@ -383,123 +407,204 @@ sub refresh () {
                    $stat[9] > $pagemtime{$page} ||
                    $forcerebuild{$page}) {
                        $pagemtime{$page}=$stat[9];
                    $stat[9] > $pagemtime{$page} ||
                    $forcerebuild{$page}) {
                        $pagemtime{$page}=$stat[9];

+

                        if (isinternal($page)) {
                        if (isinternal($page)) {

-                               push @internal, $file;

                                # Preprocess internal page in scan-only mode.
                                preprocess($page, $page, readfile($srcfile), 1);
                                # Preprocess internal page in scan-only mode.
                                preprocess($page, $page, readfile($srcfile), 1);

+                               push @internal_change, $file;

                        }
                        else {
                                push @needsbuild, $file;
                        }
                }
        }
                        }
                        else {
                                push @needsbuild, $file;
                        }
                }
        }

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

 
 

-       # scan and render files
-       foreach my $file (@needsbuild) {
-               debug(sprintf(gettext("scanning %s"), $file));
-               scan($file);
+sub calculate_old_links () {
+       foreach my $file (@needsbuild, @del) {
+               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}=[];
+}
+
+sub render_linkers () {
+       foreach my $f (@new, @del) {
+               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));

                }
                }

-               $renderedfiles{$page}=[];

        }
        }

-       
-       # 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);
-
-               # 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 calculate_changed_links () {
+       foreach my $file (@needsbuild, @del) {
+               my $page=pagename($file);
+               my %link_targets;
+               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};

                        }
                }
                        }
                }

-               
-               # 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 $oldlink_targets{$page} &&
+                   %{$oldlink_targets{$page}}) {
+                       foreach my $target (keys %{$oldlink_targets{$page}}) {
+                               $backlinkchanged{$target}=1;

                        }
                        }

-                       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;
-                                       }
+                       $linkchangers{lc($page)}=1;
+               }
+       }
+}
+
+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;

                                }
                        }
                }
                                }
                        }
                }

+       
+               if (exists $depends{$p} && ! defined $reason) {
+                       D: foreach my $d (keys %{$depends{$p}}) {
+                               my $sub=pagespec_translate($d);
+                               next if $@ || ! defined $sub;

 
 

-               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;
+                               # 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 (($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;
+                                       }
+                               }

                        }
                }
                        }
                }

+       
+               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();
+       find_needsbuild();
+       run_hooks(needsbuild => sub { shift->(\@needsbuild) });
+       calculate_old_links();
+
+       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);
+       }
+       
+       calculate_changed_links();
+       render_linkers();
+       
+       if (@needsbuild || @del || @internal || @internal_change) {
+               1 while render_dependent();
+       }
+
+       render_backlinks();
+       remove_unrendered();

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


@@ -519,7 +624,7 @@ sub commandline_render () {
        $file=~s/\Q$config{srcdir}\E\/?//;
 
        my $type=pagetype($file);
        $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;
        my $content=readfile($srcfile);
        my $page=pagename($file);
        $pagesources{$page}=$file;