Merge branch 'master' of git://github.com/joeyh/ikiwiki

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 990fcaaa111d3d48985eff126fbdd30bd0d17003..5953b3feef93c9af06b8a491141635f3552fae82 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -8,29 +8,40 @@ use IkiWiki;
 use Encode;
 
 my %backlinks;
-my $backlinks_calculated=0;
+our %brokenlinks;
+my $links_calculated=0;
 
-sub calculate_backlinks () { #{{{
-       return if $backlinks_calculated;
-       %backlinks=();
+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 +56,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 +74,24 @@ sub genpage ($$) { #{{{
        my $actions=0;
 
        if (length $config{cgiurl}) {
-               $template->param(editurl => cgiurl(do => "edit", page => $page));
-               $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 +116,6 @@ sub genpage ($$) { #{{{
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
                wikiname => $config{wikiname},
-               parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
@@ -135,6 +129,10 @@ sub genpage ($$) { #{{{
        });
        
        $content=$template->output;
+       
+       run_hooks(postscan => sub {
+               shift->(page => $page, content => $content);
+       });
 
        run_hooks(format => sub {
                $content=shift->(
@@ -144,9 +142,9 @@ sub genpage ($$) { #{{{
        });
 
        return $content;
-} #}}}
+}
 
-sub scan ($) { #{{{
+sub scan ($) {
        my $file=shift;
 
        my $type=pagetype($file);
@@ -159,7 +157,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.
-                       $links{$page}=[ $page."/".gettext("discussion") ];
+                       $links{$page}=[ $page."/".lc($config{discussionpage}) ];
                }
                else {
                        $links{$page}=[];
@@ -178,9 +176,9 @@ sub scan ($) { #{{{
        else {
                will_render($file, $file, 1);
        }
-} #}}}
+}
 
-sub fast_file_copy (@) { #{{{
+sub fast_file_copy (@) {
        my $srcfile=shift;
        my $destfile=shift;
        my $srcfd=shift;
@@ -204,7 +202,7 @@ sub fast_file_copy (@) { #{{{
        }
 }
 
-sub render ($) { #{{{
+sub render ($) {
        my $file=shift;
        
        my $type=pagetype($file);
@@ -212,6 +210,7 @@ sub render ($) { #{{{
        if (defined $type) {
                my $page=pagename($file);
                delete $depends{$page};
+               delete $depends_simple{$page};
                will_render($page, htmlpage($page), 1);
                return if $type=~/^_/;
                
@@ -226,6 +225,7 @@ sub render ($) { #{{{
        }
        else {
                delete $depends{$file};
+               delete $depends_simple{$file};
                will_render($file, $file, 1);
                
                if ($config{hardlink}) {
@@ -246,9 +246,9 @@ sub render ($) { #{{{
                        fast_file_copy($srcfile, $file, $srcfd, @_);
                });
        }
-} #}}}
+}
 
-sub prune ($) { #{{{
+sub prune ($) {
        my $file=shift;
 
        unlink($file);
@@ -256,25 +256,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 (@files, %pages);
        eval q{use File::Find};
        error($@) if $@;
        find({
@@ -292,7 +291,11 @@ sub refresh () { #{{{
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
                                        push @files, $f;
-                                       $exists{pagename($f)}=1;
+                                       my $pagename = pagename($f);
+                                       if ($pages{$pagename}) {
+                                               debug(sprintf(gettext("%s has multiple possible source pages"), $pagename));
+                                       }
+                                       $pages{$pagename}=1;
                                }
                        }
                },
@@ -318,9 +321,9 @@ sub refresh () { #{{{
                                                if (! -l "$config{srcdir}/$f" && 
                                                    ! -e _) {
                                                        my $page=pagename($f);
-                                                       if (! $exists{$page}) {
+                                                       if (! $pages{$page}) {
                                                                push @files, $f;
-                                                               $exists{$page}=1;
+                                                               $pages{$page}=1;
                                                        }
                                                }
                                        }
@@ -329,10 +332,24 @@ sub refresh () { #{{{
                }, $dir);
        };
 
+       # Returns a list of all source files found, and a hash of 
+       # the corresponding page names.
+       return \@files, \%pages;
+}
+
+sub refresh () {
+       srcdir_check();
+       run_hooks(refresh => sub { shift->() });
+       my ($files, $exists)=find_src_files();
+
        my (%rendered, @add, @del, @internal);
        # check for added or removed pages
-       foreach my $file (@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)) {
@@ -357,7 +374,7 @@ sub refresh () { #{{{
                }
        }
        foreach my $page (keys %pagemtime) {
-               if (! $exists{$page}) {
+               if (! $exists->{$page}) {
                        if (isinternal($page)) {
                                push @internal, $pagesources{$page};
                        }
@@ -368,12 +385,13 @@ 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};
                                }
                        }
                }
@@ -381,7 +399,7 @@ sub refresh () { #{{{
 
        # find changed and new files
        my @needsbuild;
-       foreach my $file (@files) {
+       foreach my $file (@$files) {
                my $page=pagename($file);
                my ($srcfile, @stat)=srcfile_stat($file);
                if (! exists $pagemtime{$page} ||
@@ -405,9 +423,9 @@ sub refresh () { #{{{
                debug(sprintf(gettext("scanning %s"), $file));
                scan($file);
        }
-       calculate_backlinks();
+       calculate_links();
        foreach my $file (@needsbuild) {
-               debug(sprintf(gettext("rendering %s"), $file));
+               debug(sprintf(gettext("building %s"), $file));
                render($file);
                $rendered{$file}=1;
        }
@@ -415,6 +433,7 @@ sub refresh () { #{{{
                # internal pages are not rendered
                my $page=pagename($file);
                delete $depends{$page};
+               delete $depends_simple{$page};
                foreach my $old (@{$renderedfiles{$page}}) {
                        delete $destsources{$old};
                }
@@ -428,7 +447,7 @@ sub refresh () { #{{{
                        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));
+                               debug(sprintf(gettext("building %s, which links to %s"), $file, $p));
                                render($file);
                                $rendered{$file}=1;
                        }
@@ -438,24 +457,47 @@ sub refresh () { #{{{
        if (%rendered || @del || @internal) {
                my @changed=(keys %rendered, @del);
 
+               my %lcchanged = map { lc(pagename($_)) => 1 } @changed;
+ 
                # rebuild dependant pages
-               foreach my $f (@files) {
+               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;
+                       my $reason = undef;
+
+                       if (exists $depends_simple{$p}) {
+                               foreach my $d (keys %{$depends_simple{$p}}) {
+                                       if (exists $lcchanged{$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;
+
+                                       # only consider internal files
+                                       # if the page explicitly depends
+                                       # on such files
+                                       foreach my $file (@changed, $d =~ /internal\(/ ? @internal : ()) {
+                                               next if $file eq $f;
+                                               my $page=pagename($file);
+                                               if ($sub->($page, location => $p)) {
+                                                       $reason = $page;
+                                                       last D;
+                                               }
+                                       }
+                               }
+                       }
+
+                       if (defined $reason) {
+                               debug(sprintf(gettext("building %s, which depends on %s"), $f, $reason));
+                               render($f);
+                               $rendered{$f}=1;
+                       }
                }
                
                # handle backlinks; if a page has added/removed links,
@@ -488,7 +530,7 @@ sub refresh () { #{{{
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
                                next if $rendered{$linkfile};
-                               debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile));
+                               debug(sprintf(gettext("building %s, to update its backlinks"), $linkfile));
                                render($linkfile);
                                $rendered{$linkfile}=1;
                        }
@@ -500,7 +542,7 @@ sub refresh () { #{{{
                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));
+                               debug(sprintf(gettext("removing %s, no longer built by %s"), $file, $page));
                                prune($config{destdir}."/".$file);
                        }
                }
@@ -512,9 +554,10 @@ sub refresh () { #{{{
        if (%rendered) {
                run_hooks(change => sub { shift->(keys %rendered) });
        }
-} #}}}
+       run_hooks(postrefresh => sub { shift->() });
+}
 
-sub commandline_render () { #{{{
+sub commandline_render () {
        lockwiki();
        loadindex();
        unlockwiki();
@@ -524,7 +567,7 @@ 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;
@@ -533,9 +576,10 @@ sub commandline_render () { #{{{
        $content=linkify($page, $page, $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