]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Render.pm
Use a hash to de-duplicate dependencies
[git.ikiwiki.info.git] / IkiWiki / Render.pm
index 302b1839519de4d23ad5d64432e9f3088e458060..b9f1d7754171004b32cc196230a530e12236b36e 100644 (file)
@@ -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 => 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");
-               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,15 +142,9 @@ sub genpage ($$) { #{{{
        });
 
        return $content;
-} #}}}
-
-sub mtime ($) { #{{{
-       my $file=shift;
-       
-       return (stat($file))[9];
-} #}}}
+}
 
-sub scan ($) { #{{{
+sub scan ($) {
        my $file=shift;
 
        my $type=pagetype($file);
@@ -162,14 +154,10 @@ sub scan ($) { #{{{
                my $page=pagename($file);
                will_render($page, htmlpage($page), 1);
 
-               # Always needs to be done, since filters might add links
-               # to the content.
-               $content=filter($page, $page, $content);
-       
                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}=[];
@@ -188,9 +176,33 @@ sub scan ($) { #{{{
        else {
                will_render($file, $file, 1);
        }
-} #}}}
+}
+
+sub fast_file_copy (@) {
+       my $srcfile=shift;
+       my $destfile=shift;
+       my $srcfd=shift;
+       my $destfd=shift;
+       my $cleanup=shift;
+
+       my $blksize = 16384;
+       my ($len, $buf, $written);
+       while ($len = sysread $srcfd, $buf, $blksize) {
+               if (! defined $len) {
+                       next if $! =~ /^Interrupted/;
+                       error("failed to read $srcfile: $!", $cleanup);
+               }
+               my $offset = 0;
+               while ($len) {
+                       defined($written = syswrite $destfd, $buf, $len, $offset)
+                               or error("failed to write $destfile: $!", $cleanup);
+                       $len -= $written;
+                       $offset += $written;
+               }
+       }
+}
 
-sub render ($) { #{{{
+sub render ($) {
        my $file=shift;
        
        my $type=pagetype($file);
@@ -201,7 +213,7 @@ sub render ($) { #{{{
                will_render($page, htmlpage($page), 1);
                return if $type=~/^_/;
                
-               my $content=htmlize($page, $type,
+               my $content=htmlize($page, $page, $type,
                        linkify($page, $page,
                        preprocess($page, $page,
                        filter($page, $page,
@@ -211,33 +223,30 @@ sub render ($) { #{{{
                writefile($output, $config{destdir}, genpage($page, $content));
        }
        else {
-               my $srcfd=readfile($srcfile, 1, 1);
                delete $depends{$file};
                will_render($file, $file, 1);
-               writefile($file, $config{destdir}, undef, 1, sub {
-                       my $destfd=shift;
-                       my $cleanup=shift;
-
-                       my $blksize = 16384;
-                       my ($len, $buf, $written);
-                       while ($len = sysread $srcfd, $buf, $blksize) {
-                               if (! defined $len) {
-                                       next if $! =~ /^Interrupted/;
-                                       error("failed to read $srcfile: $!", $cleanup);
-                               }
-                               my $offset = 0;
-                               while ($len) {
-                                       defined($written = syswrite $destfd, $buf, $len, $offset)
-                                               or error("failed to write $file: $!", $cleanup);
-                                       $len -= $written;
-                                       $offset += $written;
+               
+               if ($config{hardlink}) {
+                       # 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
+               }
+               
+               my $srcfd=readfile($srcfile, 1, 1);
+               writefile($file, $config{destdir}, undef, 1, sub {
+                       fast_file_copy($srcfile, $file, $srcfd, @_);
                });
        }
-} #}}}
+}
 
-sub prune ($) { #{{{
+sub prune ($) {
        my $file=shift;
 
        unlink($file);
@@ -245,25 +254,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({
@@ -273,7 +281,7 @@ sub refresh () { #{{{
                        if (file_pruned($_, $config{srcdir})) {
                                $File::Find::prune=1;
                        }
-                       elsif (! -d $_ && ! -l $_) {
+                       elsif (! -l $_ && ! -d _) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                        warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
@@ -281,7 +289,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;
                                }
                        }
                },
@@ -294,7 +306,7 @@ sub refresh () { #{{{
                                if (file_pruned($_, $dir)) {
                                        $File::Find::prune=1;
                                }
-                               elsif (! -d $_ && ! -l $_) {
+                               elsif (! -l $_ && ! -d _) {
                                        my ($f)=/$config{wiki_file_regexp}/; # untaint
                                        if (! defined $f) {
                                                warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");
@@ -304,12 +316,12 @@ sub refresh () { #{{{
                                                # avoid underlaydir
                                                # override attacks; see
                                                # security.mdwn
-                                               if (! -e "$config{srcdir}/$f" && 
-                                                   ! -l "$config{srcdir}/$f") {
+                                               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;
                                                        }
                                                }
                                        }
@@ -318,11 +330,24 @@ sub refresh () { #{{{
                }, $dir);
        };
 
-       my (%rendered, @add, @del, @internal);
+       # 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)) {
@@ -342,12 +367,12 @@ sub refresh () { #{{{
                        }
                        $pagecase{lc $page}=$page;
                        if (! exists $pagectime{$page}) {
-                               $pagectime{$page}=mtime(srcfile($file));
+                               $pagectime{$page}=(srcfile_stat($file))[10];
                        }
                }
        }
        foreach my $page (keys %pagemtime) {
-               if (! $exists{$page}) {
+               if (! $exists->{$page}) {
                        if (isinternal($page)) {
                                push @internal, $pagesources{$page};
                        }
@@ -358,12 +383,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};
                                }
                        }
                }
@@ -371,18 +397,17 @@ sub refresh () { #{{{
 
        # find changed and new files
        my @needsbuild;
-       foreach my $file (@files) {
+       foreach my $file (@$files) {
                my $page=pagename($file);
-               
-               my $mtime=mtime(srcfile($file));
+               my ($srcfile, @stat)=srcfile_stat($file);
                if (! exists $pagemtime{$page} ||
-                   $mtime > $pagemtime{$page} ||
+                   $stat[9] > $pagemtime{$page} ||
                    $forcerebuild{$page}) {
-                       $pagemtime{$page}=$mtime;
+                       $pagemtime{$page}=$stat[9];
                        if (isinternal($page)) {
                                push @internal, $file;
                                # Preprocess internal page in scan-only mode.
-                               preprocess($page, $page, readfile(srcfile($file)), 1);
+                               preprocess($page, $page, readfile($srcfile), 1);
                        }
                        else {
                                push @needsbuild, $file;
@@ -396,9 +421,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;
        }
@@ -419,7 +444,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;
                        }
@@ -430,20 +455,22 @@ sub refresh () { #{{{
                my @changed=(keys %rendered, @del);
 
                # rebuild dependant pages
-               foreach my $f (@files) {
+               F: 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;
+                               foreach my $d (keys %{$depends{$p}}) {
+                                       # only consider internal files
+                                       # if the page explicitly depends on such files
+                                       foreach my $file (@changed, $d=~/internal\(/ ? @internal : ()) {
+                                               next if $f eq $file;
+                                               my $page=pagename($file);
+                                               if (pagespec_match($page, $d, location => $p)) {
+                                                       debug(sprintf(gettext("building %s, which depends on %s"), $f, $page));
+                                                       render($f);
+                                                       $rendered{$f}=1;
+                                                       next F;
+                                               }
                                        }
                                }
                        }
@@ -479,7 +506,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;
                        }
@@ -491,7 +518,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);
                        }
                }
@@ -503,11 +530,9 @@ sub refresh () { #{{{
        if (%rendered) {
                run_hooks(change => sub { shift->(keys %rendered) });
        }
-} #}}}
+}
 
-sub commandline_render () { #{{{
-       loadplugins();
-       checkconfig();
+sub commandline_render () {
        lockwiki();
        loadindex();
        unlockwiki();
@@ -517,18 +542,19 @@ 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;
        $content=filter($page, $page, $content);
        $content=preprocess($page, $page, $content);
        $content=linkify($page, $page, $content);
-       $content=htmlize($page, $type, $content);
-       $pagemtime{$page}=mtime($srcfile);
+       $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