fix misleading comment

[ikiwiki.git] / IkiWiki / Render.pm

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 2cdec421f1da745e6f6aa2060be1ce46b566a822..5cb67ea07ec34a4f1eb7b6a3176179fa2d5f182a 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -10,7 +10,7 @@ use Encode;
 my %backlinks;
 my $backlinks_calculated=0;
 
-sub calculate_backlinks () { #{{{
+sub calculate_backlinks () {
        return if $backlinks_calculated;
        %backlinks=();
        foreach my $page (keys %links) {
@@ -22,15 +22,21 @@ sub calculate_backlinks () { #{{{
                }
        }
        $backlinks_calculated=1;
-} #}}}
+}
 
-sub backlinks ($) { #{{{
+sub backlink_pages ($) {
        my $page=shift;
 
        calculate_backlinks();
 
+       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 +51,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,19 +69,21 @@ sub genpage ($$) { #{{{
        my $actions=0;
 
        if (length $config{cgiurl}) {
-               $template->param(editurl => cgiurl(do => "edit", page => pagetitle($page, 1)));
-               $template->param(prefsurl => cgiurl(do => "prefs"));
+               $template->param(editurl => cgiurl(do => "edit", page => $page))
+                       if IkiWiki->can("cgi_editpage");
+               $template->param(prefsurl => cgiurl(do => "prefs"))
+                       if exists $hooks{auth};
                $actions++;
        }
                
-       if (length $config{historyurl}) {
+       if (defined $config{historyurl} && length $config{historyurl}) {
                my $u=$config{historyurl};
                $u=~s/\[\[file\]\]/$pagesources{$page}/g;
                $template->param(historyurl => $u);
                $actions++;
        }
        if ($config{discussion}) {
-               my $discussionlink=gettext("discussion");
+               my $discussionlink=lc(gettext("Discussion"));
                if ($page !~ /.*\/\Q$discussionlink\E$/ &&
                   (length $config{cgiurl} ||
                    exists $links{$page."/".$discussionlink})) {
@@ -121,7 +112,6 @@ sub genpage ($$) { #{{{
                        ? $config{wikiname} 
                        : pagetitle(basename($page)),
                wikiname => $config{wikiname},
-               parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => $backlinks,
                more_backlinks => $more_backlinks,
@@ -135,6 +125,10 @@ sub genpage ($$) { #{{{
        });
        
        $content=$template->output;
+       
+       run_hooks(postscan => sub {
+               shift->(page => $page, content => $content);
+       });
 
        run_hooks(format => sub {
                $content=shift->(
@@ -144,9 +138,9 @@ sub genpage ($$) { #{{{
        });
 
        return $content;
-} #}}}
+}
 
-sub scan ($) { #{{{
+sub scan ($) {
        my $file=shift;
 
        my $type=pagetype($file);
@@ -159,7 +153,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(gettext("Discussion")) ];
                }
                else {
                        $links{$page}=[];
@@ -178,9 +172,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 +198,7 @@ sub fast_file_copy ($$$$$) { #{{{
        }
 }
 
-sub render ($) { #{{{
+sub render ($) {
        my $file=shift;
        
        my $type=pagetype($file);
@@ -229,10 +223,14 @@ sub render ($) { #{{{
                will_render($file, $file, 1);
                
                if ($config{hardlink}) {
-                       prep_writefile($file, $config{destdir});
-                       unlink($config{destdir}."/".$file);
-                       if (link($srcfile, $config{destdir}."/".$file)) {
-                               return;
+                       # only hardlink if owned by same user
+                       my @stat=stat($srcfile);
+                       if ($stat[4] == $>) {
+                               prep_writefile($file, $config{destdir});
+                               unlink($config{destdir}."/".$file);
+                               if (link($srcfile, $config{destdir}."/".$file)) {
+                                       return;
+                               }
                        }
                        # if hardlink fails, fall back to copying
                }
@@ -242,9 +240,9 @@ sub render ($) { #{{{
                        fast_file_copy($srcfile, $file, $srcfd, @_);
                });
        }
-} #}}}
+}
 
-sub prune ($) { #{{{
+sub prune ($) {
        my $file=shift;
 
        unlink($file);
@@ -252,25 +250,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({
@@ -288,7 +285,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;
                                }
                        }
                },
@@ -314,9 +315,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;
                                                        }
                                                }
                                        }
@@ -325,10 +326,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)) {
@@ -353,7 +368,7 @@ sub refresh () { #{{{
                }
        }
        foreach my $page (keys %pagemtime) {
-               if (! $exists{$page}) {
+               if (! $exists->{$page}) {
                        if (isinternal($page)) {
                                push @internal, $pagesources{$page};
                        }
@@ -377,7 +392,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} ||
@@ -403,7 +418,7 @@ sub refresh () { #{{{
        }
        calculate_backlinks();
        foreach my $file (@needsbuild) {
-               debug(sprintf(gettext("rendering %s"), $file));
+               debug(sprintf(gettext("building %s"), $file));
                render($file);
                $rendered{$file}=1;
        }
@@ -424,7 +439,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;
                        }
@@ -435,7 +450,7 @@ sub refresh () { #{{{
                my @changed=(keys %rendered, @del);
 
                # rebuild dependant pages
-               foreach my $f (@files) {
+               foreach my $f (@$files) {
                        next if $rendered{$f};
                        my $p=pagename($f);
                        if (exists $depends{$p}) {
@@ -445,7 +460,7 @@ sub refresh () { #{{{
                                        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));
+                                               debug(sprintf(gettext("building %s, which depends on %s"), $f, $page));
                                                render($f);
                                                $rendered{$f}=1;
                                                last;
@@ -484,7 +499,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;
                        }
@@ -496,7 +511,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);
                        }
                }
@@ -508,9 +523,9 @@ sub refresh () { #{{{
        if (%rendered) {
                run_hooks(change => sub { shift->(keys %rendered) });
        }
-} #}}}
+}
 
-sub commandline_render () { #{{{
+sub commandline_render () {
        lockwiki();
        loadindex();
        unlockwiki();
@@ -520,7 +535,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;
@@ -529,9 +544,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