formatting

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 0e5336f22e83cdd998f95a1aa5038aad03e20528..a90d202eef0c10fd480b00459c1238f58052b094 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -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;


@@ -43,7 +42,7 @@ sub backlinks ($) {
        my @links;
        foreach my $p (backlink_pages($page)) {
                my $href=urlto($p, $page);
        my @links;
        foreach my $p (backlink_pages($page)) {
                my $href=urlto($p, $page);

-                
+

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


@@ -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;


@@ -74,23 +73,28 @@ sub genpage ($$) {
                        $templatefile=$file;
                }
        });
                        $templatefile=$file;
                }
        });

-       my $template=template(defined $templatefile ? $templatefile : 'page.tmpl', blind_cache => 1);
-       my $actions=0;
+       my $template;
+       if (defined $templatefile) {
+               $template=template_depends($templatefile, $page,
+                       blind_cache => 1);
+       }
+       else {
+               # no explicit depends as special case
+               $template=template('page.tmpl', 
+                       blind_cache => 1);
+       }

 
 

+       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++;
        }


@@ -102,10 +106,10 @@ sub genpage ($$) {
                        $actions++;
                }
        }
                        $actions++;
                }
        }

-

        if ($actions) {
                $template->param(have_actions => 1);
        }
        if ($actions) {
                $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);


@@ -127,8 +131,9 @@ sub genpage ($$) {
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
                mtime => displaytime($pagemtime{$page}),
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
                mtime => displaytime($pagemtime{$page}),

-               ctime => displaytime($pagectime{$page}),
+               ctime => displaytime($pagectime{$page}, undef, 1),

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

+               html5 => $config{html5},

        );
 
        run_hooks(pagetemplate => sub {
        );
 
        run_hooks(pagetemplate => sub {


@@ -169,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);


@@ -257,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);
        }
 }


@@ -286,64 +292,68 @@ sub find_src_files () {
        my %pages;
        eval q{use File::Find};
        error($@) if $@;
        my %pages;
        eval q{use File::Find};
        error($@) if $@;

-       find({
-               no_chdir => 1,
-               wanted => sub {
-                       my $file=decode_utf8($_);
-                       $file=~s/^\Q$config{srcdir}\E\/?//;
-                       return if -l $_ || -d _ || ! length $file;
-                       my $page = pagename($file);
-                       if (! exists $pagesources{$page} &&
-                           file_pruned($file)) {
-                               $File::Find::prune=1;
-                               return;
-                       }

 
 

-                       my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
-                       if (! defined $f) {
-                               warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
-                       }
-                       else {
-                               push @files, $f;
-                               if ($pages{$page}) {
-                                       debug(sprintf(gettext("%s has multiple possible source pages"), $page));
+       eval q{use Cwd};
+       die $@ if $@;
+       my $origdir=getcwd();
+       my $abssrcdir=Cwd::abs_path($config{srcdir});
+
+       my ($page, $underlay);
+       my $helper=sub {
+               my $file=decode_utf8($_);
+
+               return if -l $file || -d _;
+               $file=~s/^\.\///;
+               return if ! length $file;
+               $page = pagename($file);
+               if (! exists $pagesources{$page} &&
+                   file_pruned($file)) {
+                       $File::Find::prune=1;
+                       return;
+               }
+
+               my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
+               if (! defined $f) {
+                       warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
+                       return;
+               }
+       
+               if ($underlay) {
+                       # avoid underlaydir override attacks; see security.mdwn
+                       if (! -l "$abssrcdir/$f" && ! -e _) {
+                               if (! $pages{$page}) {
+                                       push @files, $f;
+                                       $pages{$page}=1;

                                }
                                }

-                               $pages{$page}=1;

                        }
                        }

-               },
-       }, $config{srcdir});
-       foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
-               find({
-                       no_chdir => 1,
-                       wanted => sub {
-                               my $file=decode_utf8($_);
-                               $file=~s/^\Q$dir\E\/?//;
-                               return if -l $_ || -d _ || ! length $file;
-                               my $page=pagename($file);
-                               if (! exists $pagesources{$page} &&
-                                   file_pruned($file)) {
-                                       $File::Find::prune=1;
-                                       return;
-                               }
+               }
+               else {
+                       push @files, $f;
+                       if ($pages{$page}) {
+                               debug(sprintf(gettext("%s has multiple possible source pages"), $page));
+                       }
+                       $pages{$page}=1;
+               }
+       };

 
 

-                               my ($f) = $file =~ /$config{wiki_file_regexp}/; # untaint
-                               if (! defined $f) {
-                                       warn(sprintf(gettext("skipping bad filename %s"), $file)."\n");
-                               }
-                               else {
-                                       # avoid underlaydir override
-                                       # attacks; see security.mdwn
-                                       if (! -l "$config{srcdir}/$f" && 
-                                           ! -e _) {
-                                               if (! $pages{$page}) {
-                                                       push @files, $f;
-                                                       $pages{$page}=1;
-                                               }
-                                       }
-                               }
-                       },
-               }, $dir);
+       chdir($config{srcdir}) || die "chdir $config{srcdir}: $!";
+       find({
+               no_chdir => 1,
+               wanted => $helper,
+       }, '.');
+       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;
 }
 


@@ -356,6 +366,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;


@@ -365,34 +404,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}) {


@@ -409,7 +422,7 @@ sub find_del_files ($) {
        my @del;
        my @internal_del;
 
        my @del;
        my @internal_del;
 

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

                if (! $pages->{$page}) {
                        if (isinternal($page)) {
                                push @internal_del, $pagesources{$page};
                if (! $pages->{$page}) {
                        if (isinternal($page)) {
                                push @internal_del, $pagesources{$page};


@@ -435,7 +448,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) {


@@ -445,6 +458,7 @@ sub remove_del (@) {
                }
        
                delete $pagecase{lc $page};
                }
        
                delete $pagecase{lc $page};

+               $delpagesources{$page}=$pagesources{$page};

                delete $pagesources{$page};
        }
 }
                delete $pagesources{$page};
        }
 }


@@ -462,8 +476,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 {


@@ -514,7 +538,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});

                        }
                }
        }
                        }
                }
        }


@@ -591,13 +615,23 @@ sub render_dependent ($$$$$$$) {
        
        my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
        my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;
        
        my %lc_changed = map { lc(pagename($_)) => 1 } @changed;
        my %lc_exists_changed = map { lc(pagename($_)) => 1 } @exists_changed;

+
+       foreach my $p ("templates/page.tmpl", keys %{$depends_simple{""}}) {
+               if ($rendered{$p} || grep { $_ eq $p } @$del) {
+                       foreach my $f (@$files) {
+                               next if $rendered{$f};
+                               render($f, sprintf(gettext("building %s, which depends on %s"), $f, $p));
+                       }
+                       return 0;
+               }
+       }

         
        foreach my $f (@$files) {
                next if $rendered{$f};
                my $p=pagename($f);
                my $reason = undef;
         
        foreach my $f (@$files) {
                next if $rendered{$f};
                my $p=pagename($f);
                my $reason = undef;

-       
-               if (exists $depends_simple{$p}) {
+
+               if (exists $depends_simple{$p} && ! defined $reason) {

                        foreach my $d (keys %{$depends_simple{$p}}) {
                                if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
                                     $lc_changed{$d})
                        foreach my $d (keys %{$depends_simple{$p}}) {
                                if (($depends_simple{$p}{$d} & $IkiWiki::DEPEND_CONTENT &&
                                     $lc_changed{$d})


@@ -622,7 +656,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;


@@ -686,6 +720,49 @@ sub render_backlinks ($) {
        }
 }
 
        }
 }
 

+sub gen_autofile ($$$) {
+       my $autofile=shift;
+       my $pages=shift;
+       my $del=shift;
+
+       if (file_pruned($autofile)) {
+               return;
+       }
+
+       my ($file)="$config{srcdir}/$autofile" =~ /$config{wiki_file_regexp}/; # untaint
+       if (! defined $file) {
+               return;
+       }
+
+       # Remember autofiles that were tried, and never try them again later.
+       if (exists $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}) {
+               return;
+       }
+       $wikistate{$autofiles{$autofile}{plugin}}{autofile}{$autofile}=1;
+
+       if (srcfile($autofile, 1) || file_pruned($autofile)) {
+               return;
+       }
+       
+       if (-l $file || -d _ || -e _) {
+               return;
+       }
+
+       my $page = pagename($file);
+       if ($pages->{$page}) {
+               return;
+       }
+
+       if (grep { $_ eq $autofile } @$del) {
+               return;
+       }
+
+       $autofiles{$autofile}{generator}->();
+       $pages->{$page}=1;
+       return 1;
+}
+
+

 sub refresh () {
        srcdir_check();
        run_hooks(refresh => sub { shift->() });
 sub refresh () {
        srcdir_check();
        run_hooks(refresh => sub { shift->() });


@@ -693,13 +770,26 @@ sub refresh () {
        my ($new, $internal_new)=find_new_files($files);
        my ($del, $internal_del)=find_del_files($pages);
        my ($changed, $internal_changed)=find_changed($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) });
+       run_hooks(needsbuild => sub {
+               my $ret=shift->($changed, [@$del, @$internal_del]);
+               $changed=$ret if ref $ret eq 'ARRAY';
+       });

        my $oldlink_targets=calculate_old_links($changed, $del);
 
        foreach my $file (@$changed) {
                scan($file);
        }
 
        my $oldlink_targets=calculate_old_links($changed, $del);
 
        foreach my $file (@$changed) {
                scan($file);
        }
 

+       foreach my $autofile (keys %autofiles) {
+               if (gen_autofile($autofile, $pages, $del)) {
+                       push @{$files}, $autofile;
+                       push @{$new}, $autofile if find_new_files([$autofile]);
+                       push @{$changed}, $autofile if find_changed([$autofile]);
+                       
+                       scan($autofile);
+               }
+       }
+

        calculate_links();
        
        remove_del(@$del, @$internal_del);
        calculate_links();
        
        remove_del(@$del, @$internal_del);


@@ -711,13 +801,21 @@ 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);
 
        foreach my $file (@$new, @$del) {
                render_linkers($file);
        }
        my ($backlinkchanged, $linkchangers)=calculate_changed_links($changed,
                $del, $oldlink_targets);
 
        foreach my $file (@$new, @$del) {
                render_linkers($file);
        }

-       
+

        if (@$changed || @$internal_changed ||
            @$del || @$internal_del || @$internal_new) {
                1 while render_dependent($files, $new, $internal_new,
        if (@$changed || @$internal_changed ||
            @$del || @$internal_del || @$internal_new) {
                1 while render_dependent($files, $new, $internal_new,


@@ -728,12 +826,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 {


@@ -742,7 +845,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});

                }
        }
 }
                }
        }
 }