Making use of the transient plugin
[ikiwiki.git] / IkiWiki / Render.pm
index 7d66bf5ec79eb84ed1698433588149a7cf8b94d7..fa2940b01ce23e5f988f9c9176c4a775c2171e53 100644 (file)
@@ -5,7 +5,6 @@ package IkiWiki;
 use warnings;
 use strict;
 use IkiWiki;
 use warnings;
 use strict;
 use IkiWiki;
-use Encode;
 
 my (%backlinks, %rendered);
 our %brokenlinks;
 
 my (%backlinks, %rendered);
 our %brokenlinks;
@@ -62,8 +61,8 @@ sub genpage ($$) {
        my $page=shift;
        my $content=shift;
        
        my $page=shift;
        my $content=shift;
        
-       run_hooks(postscan => sub {
-               shift->(page => $page, content => $content);
+       run_hooks(indexhtml => sub {
+               shift->(page => $page, destpage => $page, content => $content);
        });
 
        my $templatefile;
        });
 
        my $templatefile;
@@ -84,22 +83,18 @@ sub genpage ($$) {
                $template=template('page.tmpl', 
                        blind_cache => 1);
        }
                $template=template('page.tmpl', 
                        blind_cache => 1);
        }
-       my $actions=0;
 
 
+       my $actions=0;
        if (length $config{cgiurl}) {
                if (IkiWiki->can("cgi_editpage")) {
                        $template->param(editurl => cgiurl(do => "edit", page => $page));
                        $actions++;
                }
        if (length $config{cgiurl}) {
                if (IkiWiki->can("cgi_editpage")) {
                        $template->param(editurl => cgiurl(do => "edit", page => $page));
                        $actions++;
                }
-               if (exists $hooks{auth}) {
-                       $template->param(prefsurl => cgiurl(do => "prefs"));
-                       $actions++;
-               }
        }
        }
-               
        if (defined $config{historyurl} && length $config{historyurl}) {
                my $u=$config{historyurl};
        if (defined $config{historyurl} && length $config{historyurl}) {
                my $u=$config{historyurl};
-               $u=~s/\[\[file\]\]/$pagesources{$page}/g;
+               my $p=uri_escape_utf8($pagesources{$page}, '^A-Za-z0-9\-\._~/');
+               $u=~s/\[\[file\]\]/$p/g;
                $template->param(historyurl => $u);
                $actions++;
        }
                $template->param(historyurl => $u);
                $actions++;
        }
@@ -111,17 +106,10 @@ sub genpage ($$) {
                        $actions++;
                }
        }
                        $actions++;
                }
        }
-
-       my @actions;
-       run_hooks(pageactions => sub {
-               push @actions, map { { action => $_ } } 
-                       grep { defined } shift->(page => $page);
-       });
-       $template->param(actions => \@actions);
-
-       if ($actions || @actions) {
+       if ($actions) {
                $template->param(have_actions => 1);
        }
                $template->param(have_actions => 1);
        }
+       templateactions($template, $page);
 
        my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
        my ($backlinks, $more_backlinks);
 
        my @backlinks=sort { $a->{page} cmp $b->{page} } backlinks($page);
        my ($backlinks, $more_backlinks);
@@ -138,7 +126,6 @@ sub genpage ($$) {
                title => $page eq 'index' 
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
                title => $page eq 'index' 
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
-               ispage => 1,
                wikiname => $config{wikiname},
                content => $content,
                backlinks => $backlinks,
                wikiname => $config{wikiname},
                content => $content,
                backlinks => $backlinks,
@@ -187,15 +174,15 @@ sub scan ($) {
                }
                delete $typedlinks{$page};
 
                }
                delete $typedlinks{$page};
 
+               # Preprocess in scan-only mode.
+               preprocess($page, $page, $content, 1);
+
                run_hooks(scan => sub {
                        shift->(
                                page => $page,
                                content => $content,
                        );
                });
                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);
        }
        else {
                will_render($file, $file, 1);
@@ -275,12 +262,13 @@ sub render ($$) {
        }
 }
 
        }
 }
 
-sub prune ($) {
+sub prune ($;$) {
        my $file=shift;
        my $file=shift;
+       my $up_to=shift;
 
        unlink($file);
        my $dir=dirname($file);
 
        unlink($file);
        my $dir=dirname($file);
-       while (rmdir($dir)) {
+       while ((! defined $up_to || $dir =~ m{^\Q$up_to\E\/}) && rmdir($dir)) {
                $dir=dirname($dir);
        }
 }
                $dir=dirname($dir);
        }
 }
@@ -299,18 +287,38 @@ sub srcdir_check () {
        
 }
 
        
 }
 
-sub find_src_files () {
+# Finds all files in the srcdir, and the underlaydirs.
+# Returns the files, and their corresponding pages.
+#
+# When run in only_underlay mode, adds only the underlay files to
+# the files and pages passed in.
+sub find_src_files (;$$$) {
+       my $only_underlay=shift;
        my @files;
        my @files;
+       if (defined $_[0]) {
+               @files=@{shift()};
+       }
        my %pages;
        my %pages;
+       if (defined $_[0]) {
+               %pages=%{shift()};
+       }
+
        eval q{use File::Find};
        error($@) if $@;
 
        eval q{use File::Find};
        error($@) if $@;
 
-       my ($page, $dir, $underlay);
+       eval q{use Cwd};
+       die $@ if $@;
+       my $origdir=getcwd();
+       my $abssrcdir=Cwd::abs_path($config{srcdir});
+       
+       @IkiWiki::underlayfiles=();
+
+       my ($page, $underlay);
        my $helper=sub {
                my $file=decode_utf8($_);
 
                return if -l $file || -d _;
        my $helper=sub {
                my $file=decode_utf8($_);
 
                return if -l $file || -d _;
-               $file=~s/^\Q$dir\E\/?//;
+               $file=~s/^\.\///;
                return if ! length $file;
                $page = pagename($file);
                if (! exists $pagesources{$page} &&
                return if ! length $file;
                $page = pagename($file);
                if (! exists $pagesources{$page} &&
@@ -327,9 +335,10 @@ sub find_src_files () {
        
                if ($underlay) {
                        # avoid underlaydir override attacks; see security.mdwn
        
                if ($underlay) {
                        # avoid underlaydir override attacks; see security.mdwn
-                       if (! -l "$config{srcdir}/$f" && ! -e _) {
+                       if (! -l "$abssrcdir/$f" && ! -e _) {
                                if (! $pages{$page}) {
                                        push @files, $f;
                                if (! $pages{$page}) {
                                        push @files, $f;
+                                       push @IkiWiki::underlayfiles, $f;
                                        $pages{$page}=1;
                                }
                        }
                                        $pages{$page}=1;
                                }
                        }
@@ -343,20 +352,73 @@ sub find_src_files () {
                }
        };
 
                }
        };
 
-       find({
-               no_chdir => 1,
-               wanted => $helper,
-       }, $dir=$config{srcdir});
-       $underlay=1;
-       foreach (@{$config{underlaydirs}}, $config{underlaydir}) {
+       unless ($only_underlay) {
+               chdir($config{srcdir}) || die "chdir $config{srcdir}: $!";
                find({
                        no_chdir => 1,
                        wanted => $helper,
                find({
                        no_chdir => 1,
                        wanted => $helper,
-               }, $dir=$_);
+               }, '.');
+               chdir($origdir) || die "chdir $origdir: $!";
+       }
+
+       $underlay=1;
+       foreach (@{$config{underlaydirs}}, $config{underlaydir}) {
+               if (chdir($_)) {
+                       find({
+                               no_chdir => 1,
+                               wanted => $helper,
+                       }, '.');
+                       chdir($origdir) || die "chdir: $!";
+               }
        };
        };
+
        return \@files, \%pages;
 }
 
        return \@files, \%pages;
 }
 
+# Given a hash of files that have changed, and a hash of files that were
+# deleted, should return the same results as find_src_files, with the same
+# sanity checks. But a lot faster!
+sub process_changed_files ($$) {
+       my $changed_raw=shift;
+       my $deleted_raw=shift;
+
+       my @files;
+       my %pages;
+
+       foreach my $file (keys %$changed_raw) {
+               my $page = pagename($file);
+               next if ! exists $pagesources{$page} && file_pruned($file);
+               my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
+               if (! defined $f) {
+                       warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
+                       next;
+               }
+               push @files, $f;
+               if ($pages{$page}) {
+                       debug(sprintf(gettext("%s has multiple possible source pages"), $page));
+               }
+               $pages{$page}=1;
+       }
+
+       # So far, we only have the changed files. Now add in all the old
+       # files that were not changed or deleted, excluding ones that came
+       # from the underlay.
+       my %old_underlay;
+       foreach my $f (@IkiWiki::underlayfiles) {
+               $old_underlay{$f}=1;
+       }
+       foreach my $page (keys %pagesources) {
+               my $f=$pagesources{$page};
+               unless ($old_underlay{$f} || exists $pages{$page} || exists $deleted_raw->{$f}) {
+                       $pages{$page}=1;
+                       push @files, $f;
+               }
+       }
+
+       # add in the underlay
+       find_src_files(1, \@files, \%pages);
+}
+
 sub find_new_files ($) {
        my $files=shift;
        my @new;
 sub find_new_files ($) {
        my $files=shift;
        my @new;
@@ -366,6 +428,35 @@ sub find_new_files ($) {
 
        foreach my $file (@$files) {
                my $page=pagename($file);
 
        foreach my $file (@$files) {
                my $page=pagename($file);
+
+               if ($config{rcs} && $config{gettime} &&
+                   -e "$config{srcdir}/$file") {
+                       if (! $times_noted) {
+                               debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs}));
+                               $times_noted=1;
+                       }
+
+                       eval {
+                               my $ctime=rcs_getctime($file);
+                               if ($ctime > 0) {
+                                       $pagectime{$page}=$ctime;
+                               }
+                       };
+                       if ($@) {
+                               print STDERR $@;
+                       }
+                       my $mtime;
+                       eval {
+                               $mtime=rcs_getmtime($file);
+                       };
+                       if ($@) {
+                               print STDERR $@;
+                       }
+                       elsif ($mtime > 0) {
+                               utime($mtime, $mtime, "$config{srcdir}/$file");
+                       }
+               }
+
                if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
                        # the page has changed its type
                        $forcerebuild{$page}=1;
                if (exists $pagesources{$page} && $pagesources{$page} ne $file) {
                        # the page has changed its type
                        $forcerebuild{$page}=1;
@@ -375,34 +466,8 @@ sub find_new_files ($) {
                        if (isinternal($page)) {
                                push @internal_new, $file;
                        }
                        if (isinternal($page)) {
                                push @internal_new, $file;
                        }
-                       elsif ($config{rcs}) {
+                       else {
                                push @new, $file;
                                push @new, $file;
-                               if ($config{gettime} && -e "$config{srcdir}/$file") {
-                                       if (! $times_noted) {
-                                               debug(sprintf(gettext("querying %s for file creation and modification times.."), $config{rcs}));
-                                               $times_noted=1;
-                                       }
-
-                                       eval {
-                                               my $ctime=rcs_getctime("$config{srcdir}/$file");
-                                               if ($ctime > 0) {
-                                                       $pagectime{$page}=$ctime;
-                                               }
-                                       };
-                                       if ($@) {
-                                               print STDERR $@;
-                                       }
-                                       my $mtime;
-                                       eval {
-                                               $mtime=rcs_getmtime("$config{srcdir}/$file");
-                                       };
-                                       if ($@) {
-                                               print STDERR $@;
-                                       }
-                                       elsif ($mtime > 0) {
-                                               utime($mtime, $mtime, "$config{srcdir}/$file");
-                                       }
-                               }
                        }
                        $pagecase{lc $page}=$page;
                        if (! exists $pagectime{$page}) {
                        }
                        $pagecase{lc $page}=$page;
                        if (! exists $pagectime{$page}) {
@@ -445,7 +510,7 @@ sub remove_del (@) {
                }
        
                foreach my $old (@{$oldrenderedfiles{$page}}) {
                }
        
                foreach my $old (@{$oldrenderedfiles{$page}}) {
-                       prune($config{destdir}."/".$old);
+                       prune($config{destdir}."/".$old, $config{destdir});
                }
 
                foreach my $source (keys %destsources) {
                }
 
                foreach my $source (keys %destsources) {
@@ -455,6 +520,7 @@ sub remove_del (@) {
                }
        
                delete $pagecase{lc $page};
                }
        
                delete $pagecase{lc $page};
+               $delpagesources{$page}=$pagesources{$page};
                delete $pagesources{$page};
        }
 }
                delete $pagesources{$page};
        }
 }
@@ -472,8 +538,18 @@ sub find_changed ($) {
                        $pagemtime{$page}=$stat[9];
 
                        if (isinternal($page)) {
                        $pagemtime{$page}=$stat[9];
 
                        if (isinternal($page)) {
+                               my $content = readfile($srcfile);
+
                                # Preprocess internal page in scan-only mode.
                                # Preprocess internal page in scan-only mode.
-                               preprocess($page, $page, readfile($srcfile), 1);
+                               preprocess($page, $page, $content, 1);
+
+                               run_hooks(scan => sub {
+                                       shift->(
+                                               page => $page,
+                                               content => $content,
+                                       );
+                               });
+
                                push @internal_changed, $file;
                        }
                        else {
                                push @internal_changed, $file;
                        }
                        else {
@@ -524,7 +600,7 @@ sub remove_unrendered () {
                foreach my $file (@{$oldrenderedfiles{$page}}) {
                        if (! grep { $_ eq $file } @{$renderedfiles{$page}}) {
                                debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page));
                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);
+                               prune($config{destdir}."/".$file, $config{destdir});
                        }
                }
        }
                        }
                }
        }
@@ -642,7 +718,7 @@ sub render_dependent ($$$$$$$) {
                                # only consider internal files
                                # if the page explicitly depends
                                # on such files
                                # only consider internal files
                                # if the page explicitly depends
                                # on such files
-                               my $internal_dep=$dep =~ /internal\(/;
+                               my $internal_dep=$dep =~ /(?:internal|comment|comment_pending)\(/;
 
                                my $in=sub {
                                        my $list=shift;
 
                                my $in=sub {
                                        my $list=shift;
@@ -748,15 +824,41 @@ sub gen_autofile ($$$) {
        return 1;
 }
 
        return 1;
 }
 
-
 sub refresh () {
        srcdir_check();
        run_hooks(refresh => sub { shift->() });
 sub refresh () {
        srcdir_check();
        run_hooks(refresh => sub { shift->() });
-       my ($files, $pages)=find_src_files();
-       my ($new, $internal_new)=find_new_files($files);
-       my ($del, $internal_del)=find_del_files($pages);
-       my ($changed, $internal_changed)=find_changed($files);
-       run_hooks(needsbuild => sub { shift->($changed) });
+       my ($files, $pages, $new, $internal_new, $del, $internal_del, $changed, $internal_changed);
+       my $want_find_changes=$config{only_committed_changes} &&
+               exists $IkiWiki::hooks{rcs}{rcs_find_changes} &&
+               exists $IkiWiki::hooks{rcs}{rcs_get_current_rev};
+       if (! $config{rebuild} && $want_find_changes && defined $IkiWiki::lastrev && length $IkiWiki::lastrev) {
+               my ($changed_raw, $del_raw);
+               ($changed_raw, $del_raw, $IkiWiki::lastrev) = $IkiWiki::hooks{rcs}{rcs_find_changes}{call}->($IkiWiki::lastrev);
+               ($files, $pages)=process_changed_files($changed_raw, $del_raw);
+       }
+       else {
+               ($files, $pages)=find_src_files();
+       }
+       if ($want_find_changes) {
+               if (! defined($IkiWiki::lastrev) || ! length $IkiWiki::lastrev) {
+                       $IkiWiki::lastrev=$IkiWiki::hooks{rcs}{rcs_get_current_rev}{call}->();
+               }
+       }
+       ($new, $internal_new)=find_new_files($files);
+       ($del, $internal_del)=find_del_files($pages);
+       ($changed, $internal_changed)=find_changed($files);
+       my %existingfiles;
+       run_hooks(needsbuild => sub {
+               my $ret=shift->($changed, [@$del, @$internal_del]);
+               if (ref $ret eq 'ARRAY' && $ret != $changed) {
+                       if (! %existingfiles) {
+                               foreach my $f (@$files) {
+                                       $existingfiles{$f}=1;
+                               }
+                       }
+                       @$changed=grep $existingfiles{$_}, @$ret;
+               }
+       });
        my $oldlink_targets=calculate_old_links($changed, $del);
 
        foreach my $file (@$changed) {
        my $oldlink_targets=calculate_old_links($changed, $del);
 
        foreach my $file (@$changed) {
@@ -784,6 +886,14 @@ sub refresh () {
                derender_internal($file);
        }
 
                derender_internal($file);
        }
 
+       run_hooks(build_affected => sub {
+               my %affected = shift->();
+               while (my ($page, $message) = each %affected) {
+                       next unless exists $pagesources{$page};
+                       render($pagesources{$page}, $message);
+               }
+       });
+
        my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
                $del, $oldlink_targets);
 
        my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
                $del, $oldlink_targets);
 
@@ -801,12 +911,17 @@ sub refresh () {
        render_backlinks($backlinkchanged);
        remove_unrendered();
 
        render_backlinks($backlinkchanged);
        remove_unrendered();
 
-       if (@$del) {
-               run_hooks(delete => sub { shift->(@$del) });
+       if (@$del || @$internal_del) {
+               run_hooks(delete => sub { shift->(@$del, @$internal_del) });
        }
        if (%rendered) {
        }
        if (%rendered) {
-               run_hooks(change => sub { shift->(keys %rendered) });
+               run_hooks(rendered => sub { shift->(keys %rendered) });
+               run_hooks(change => sub { shift->(keys %rendered) }); # back-compat
        }
        }
+       my %all_changed = map { $_ => 1 }
+               @$new, @$changed, @$del,
+               @$internal_new, @$internal_changed, @$internal_del;
+       run_hooks(changes => sub { shift->(keys %all_changed) });
 }
 
 sub clean_rendered {
 }
 
 sub clean_rendered {
@@ -815,7 +930,7 @@ sub clean_rendered {
        remove_unrendered();
        foreach my $page (keys %oldrenderedfiles) {
                foreach my $file (@{$oldrenderedfiles{$page}}) {
        remove_unrendered();
        foreach my $page (keys %oldrenderedfiles) {
                foreach my $file (@{$oldrenderedfiles{$page}}) {
-                       prune($config{destdir}."/".$file);
+                       prune($config{destdir}."/".$file, $config{destdir});
                }
        }
 }
                }
        }
 }