improved link

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

diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm
index 40472693084d905b00373f504a57a1069aff871b..7ca9a38208aef4d141f629943ce32d10f388ee20 100644 (file)
--- a/IkiWiki/Render.pm
+++ b/IkiWiki/Render.pm
@@ -4,63 +4,46 @@ package IkiWiki;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;

-use File::Spec;

 use IkiWiki;
 use Encode;
 
 use IkiWiki;
 use Encode;
 

-sub linkify ($$$) { #{{{
-       my $lpage=shift;
-       my $page=shift;
-       my $content=shift;
-
-       $content =~ s{(\\?)$config{wiki_link_regexp}}{
-               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
-                  : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
-       }eg;
-       
-       return $content;
-} #}}}
-
-sub htmlize ($$) { #{{{
-       my $type=shift;
-       my $content=shift;
-       
-       if (exists $hooks{htmlize}{$type}) {
-               $content=$hooks{htmlize}{$type}{call}->($content);
-       }
-       else {
-               error("htmlization of $type not supported");
-       }
-
-       if (exists $hooks{sanitize}) {
-               foreach my $id (keys %{$hooks{sanitize}}) {
-                       $content=$hooks{sanitize}{$id}{call}->($content);
+my %backlinks;
+my $backlinks_calculated=0;
+
+sub calculate_backlinks () { #{{{
+       return if $backlinks_calculated;
+       %backlinks=();
+       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;
+                       }

                }
        }
                }
        }

-       
-       return $content;
+       $backlinks_calculated=1;

 } #}}}
 
 sub backlinks ($) { #{{{
        my $page=shift;
 
 } #}}}
 
 sub backlinks ($) { #{{{
        my $page=shift;
 

+       calculate_backlinks();
+

        my @links;
        my @links;

-       foreach my $p (keys %links) {
-               next if bestlink($page, $p) eq $page;
-               if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
-                       my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
+       return unless $backlinks{$page};
+       foreach my $p (keys %{$backlinks{$page}}) {
+               my $href=abs2rel(htmlpage($p), dirname($page));

                        
                        

-                       # Trim common dir prefixes from both pages.
-                       my $p_trimmed=$p;
-                       my $page_trimmed=$page;
-                       my $dir;
-                       1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
-                               defined $dir &&
-                               $p_trimmed=~s/^\Q$dir\E// &&
-                               $page_trimmed=~s/^\Q$dir\E//;
-                                      
-                       push @links, { url => $href, page => $p_trimmed };
-               }
+               # Trim common dir prefixes from both pages.
+               my $p_trimmed=$p;
+               my $page_trimmed=$page;
+               my $dir;
+               1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
+                       defined $dir &&
+                       $p_trimmed=~s/^\Q$dir\E// &&
+                       $page_trimmed=~s/^\Q$dir\E//;
+                              
+               push @links, { url => $href, page => pagetitle($p_trimmed) };

        }
 
        return sort { $a->{page} cmp $b->{page} } @links;
        }
 
        return sort { $a->{page} cmp $b->{page} } @links;


@@ -73,10 +56,11 @@ sub parentlinks ($) { #{{{
        my $pagelink="";
        my $path="";
        my $skip=1;
        my $pagelink="";
        my $path="";
        my $skip=1;

+       return if $page eq 'index'; # toplevel

        foreach my $dir (reverse split("/", $page)) {
                if (! $skip) {
                        $path.="../";
        foreach my $dir (reverse split("/", $page)) {
                if (! $skip) {
                        $path.="../";

-                       unshift @ret, { url => "$path$dir.html", page => $dir };
+                       unshift @ret, { url => $path.htmlpage($dir), page => pagetitle($dir) };

                }
                else {
                        $skip=0;
                }
                else {
                        $skip=0;


@@ -86,79 +70,11 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
        return @ret;
 } #}}}
 

-sub preprocess ($$;$) { #{{{
-       my $page=shift;
-       my $content=shift;
-       my $onlystrip=shift || 0; # strip directives without processing
-
-       my $handle=sub {
-               my $escape=shift;
-               my $command=shift;
-               my $params=shift;
-               if (length $escape) {
-                       return "[[$command $params]]";
-               }
-               elsif ($onlystrip) {
-                       return "";
-               }
-               elsif (exists $hooks{preprocess}{$command}) {
-                       # Note: preserve order of params, some plugins may
-                       # consider it significant.
-                       my @params;
-                       while ($params =~ /(\w+)=\"?([^"]+)"?(\s+|$)/g) {
-                               push @params, $1, $2;
-                       }
-                       return $hooks{preprocess}{$command}{call}->(@params, page => $page);
-               }
-               else {
-                       return "[[$command not processed]]";
-               }
-       };
-       
-       $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg;
-       return $content;
-} #}}}
-
-sub add_depends ($$) { #{{{
-       my $page=shift;
-       my $globlist=shift;
-       
-       if (! exists $depends{$page}) {
-               $depends{$page}=$globlist;
-       }
-       else {
-               $depends{$page}=globlist_merge($depends{$page}, $globlist);
-       }
-} # }}}
-
-sub globlist_merge ($$) { #{{{
-       my $a=shift;
-       my $b=shift;
-
-       my $ret="";
-       # Only add negated globs if they are not matched by the other globlist.
-       foreach my $i ((map { [ $a, $_ ] } split(" ", $b)), 
-                      (map { [ $b, $_ ] } split(" ", $a))) {
-               if ($i->[1]=~/^!(.*)/) {
-                       if (! globlist_match($1, $i->[0])) {
-                               $ret.=" ".$i->[1];
-                       }
-               }
-               else {
-                       $ret.=" ".$i->[1];
-               }
-       }
-       
-       return $ret;
-} #}}}
-

 sub genpage ($$$) { #{{{
        my $page=shift;
        my $content=shift;
        my $mtime=shift;
 
 sub genpage ($$$) { #{{{
        my $page=shift;
        my $content=shift;
        my $mtime=shift;
 

-       my $title=pagetitle(basename($page));
-       

        my $template=template("page.tmpl", blind_cache => 1);
        my $actions=0;
 
        my $template=template("page.tmpl", blind_cache => 1);
        my $actions=0;
 


@@ -177,8 +93,9 @@ sub genpage ($$$) { #{{{
                $template->param(historyurl => $u);
                $actions++;
        }
                $template->param(historyurl => $u);
                $actions++;
        }

-       if ($config{discussion}) {
-               $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
+       if ($config{discussion} && $page !~ /.*\/discussion$/ &&
+           (length $config{cgiurl} || exists $links{$page."/".gettext("discussion")})) {
+               $template->param(discussionlink => htmllink($page, $page, gettext("Discussion"), 1, 1));

                $actions++;
        }
 
                $actions++;
        }
 


@@ -187,43 +104,31 @@ sub genpage ($$$) { #{{{
        }
 
        $template->param(
        }
 
        $template->param(

-               title => $title,
+               title => $page eq 'index' 
+                       ? $config{wikiname} 
+                       : pagetitle(basename($page)),

                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => [backlinks($page)],
                mtime => displaytime($mtime),
                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => [backlinks($page)],
                mtime => displaytime($mtime),

-               styleurl => styleurl($page),
+               baseurl => baseurl($page),

        );
 
        );
 

-       if (exists $hooks{pagetemplate}) {
-               foreach my $id (keys %{$hooks{pagetemplate}}) {
-                       $hooks{pagetemplate}{$id}{call}->($page, $template);
-               }
-       }
-       
-       return $template->output;
-} #}}}
-
-sub check_overwrite ($$) { #{{{
-       # Important security check. Make sure to call this before saving
-       # any files to the source directory.
-       my $dest=shift;
-       my $src=shift;
+       run_hooks(pagetemplate => sub {
+               shift->(page => $page, destpage => $page, template => $template);
+       });

        
        

-       if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
-               error("$dest already exists and was not rendered from $src before");
-       }
-} #}}}
+       $content=$template->output;

 
 

-sub displaytime ($) { #{{{
-       my $time=shift;
+       run_hooks(format => sub {
+               $content=shift->(
+                       page => $page,
+                       content => $content,
+               );
+       });

 
 

-       eval q{use POSIX};
-       # strftime doesn't know about encodings, so make sure
-       # its output is properly treated as utf8
-       return Encode::decode_utf8(POSIX::strftime(
-                       $config{timeformat}, localtime($time)));
+       return $content;

 } #}}}
 
 sub mtime ($) { #{{{
 } #}}}
 
 sub mtime ($) { #{{{


@@ -232,21 +137,36 @@ sub mtime ($) { #{{{
        return (stat($file))[9];
 } #}}}
 
        return (stat($file))[9];
 } #}}}
 

-sub findlinks ($$) { #{{{
-       my $page=shift;
-       my $content=shift;
+sub scan ($) { #{{{
+       my $file=shift;

 
 

-       my @links;
-       while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
-               push @links, titlepage($2);
-       }
-       if ($config{discussion}) {
-               # Discussion links are a special case since they're not in the
-               # text of the page, but on its template.
-               return @links, "$page/discussion";
+       my $type=pagetype($file);
+       if (defined $type) {
+               my $srcfile=srcfile($file);
+               my $content=readfile($srcfile);
+               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, $content);
+
+               my @links;
+               while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
+                       push @links, titlepage($2);
+               }
+               if ($config{discussion}) {
+                       # Discussion links are a special case since they're
+                       # not in the text of the page, but on its template.
+                       push @links, $page."/".gettext("discussion");
+               }
+               $links{$page}=\@links;
+               
+               # Preprocess in scan-only mode.
+               preprocess($page, $page, $content, 1);

        }
        else {
        }
        else {

-               return @links;
+               will_render($file, $file, 1);

        }
 } #}}}
 
        }
 } #}}}
 


@@ -259,36 +179,23 @@ sub render ($) { #{{{
                my $content=readfile($srcfile);
                my $page=pagename($file);
                delete $depends{$page};
                my $content=readfile($srcfile);
                my $page=pagename($file);
                delete $depends{$page};

+               will_render($page, htmlpage($page), 1);

                
                

-               if (exists $hooks{filter}) {
-                       foreach my $id (keys %{$hooks{filter}}) {
-                               $content=$hooks{filter}{$id}{call}->(
-                                       page => $page,
-                                       content => $content
-                               );
-                       }
-               }
-               
-               $links{$page}=[findlinks($page, $content)];
-               
+               $content=filter($page, $content);
+               $content=preprocess($page, $page, $content);

                $content=linkify($page, $page, $content);
                $content=linkify($page, $page, $content);

-               $content=preprocess($page, $content);
-               $content=htmlize($type, $content);
+               $content=htmlize($page, $type, $content);

                
                

-               check_overwrite("$config{destdir}/".htmlpage($page), $page);

                writefile(htmlpage($page), $config{destdir},
                        genpage($page, $content, mtime($srcfile)));
                $oldpagemtime{$page}=time;
                writefile(htmlpage($page), $config{destdir},
                        genpage($page, $content, mtime($srcfile)));
                $oldpagemtime{$page}=time;

-               $renderedfiles{$page}=htmlpage($page);

        }
        else {
                my $content=readfile($srcfile, 1);
        }
        else {
                my $content=readfile($srcfile, 1);

-               $links{$file}=[];

                delete $depends{$file};
                delete $depends{$file};

-               check_overwrite("$config{destdir}/$file", $file);
+               will_render($file, $file, 1);

                writefile($file, $config{destdir}, $content, 1);
                $oldpagemtime{$file}=time;
                writefile($file, $config{destdir}, $content, 1);
                $oldpagemtime{$file}=time;

-               $renderedfiles{$file}=$file;

        }
 } #}}}
 
        }
 } #}}}
 


@@ -307,17 +214,18 @@ sub refresh () { #{{{
        my %exists;
        my @files;
        eval q{use File::Find};
        my %exists;
        my @files;
        eval q{use File::Find};

+       error($@) if $@;

        find({
                no_chdir => 1,
                wanted => sub {
        find({
                no_chdir => 1,
                wanted => sub {

-                       $_ = Encode::decode_utf8($_);
-                       if (/$config{wiki_file_prune_regexp}/) {
+                       $_=decode_utf8($_);
+                       if (file_pruned($_, $config{srcdir})) {

                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {

-                                       warn("skipping bad filename $_\n");
+                                       warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");

                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;
                                }
                                else {
                                        $f=~s/^\Q$config{srcdir}\E\/?//;


@@ -330,23 +238,26 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
        find({
                no_chdir => 1,
                wanted => sub {

-                       $_ = Encode::decode_utf8($_);
-                       if (/$config{wiki_file_prune_regexp}/) {
+                       $_=decode_utf8($_);
+                       if (file_pruned($_, $config{underlaydir})) {

                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {
                                $File::Find::prune=1;
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                                if (! defined $f) {

-                                       warn("skipping bad filename $_\n");
+                                       warn(sprintf(gettext("skipping bad filename %s"), $_)."\n");

                                }
                                else {
                                }
                                else {

-                                       # Don't add files that are in the
+                                       # Don't add pages that are in the

                                        # srcdir.
                                        $f=~s/^\Q$config{underlaydir}\E\/?//;
                                        if (! -e "$config{srcdir}/$f" && 
                                            ! -l "$config{srcdir}/$f") {
                                        # srcdir.
                                        $f=~s/^\Q$config{underlaydir}\E\/?//;
                                        if (! -e "$config{srcdir}/$f" && 
                                            ! -l "$config{srcdir}/$f") {

-                                               push @files, $f;
-                                               $exists{pagename($f)}=1;
+                                               my $page=pagename($f);
+                                               if (! $exists{$page}) {
+                                                       push @files, $f;
+                                                       $exists{$page}=1;
+                                               }

                                        }
                                }
                        }
                                        }
                                }
                        }


@@ -359,11 +270,10 @@ sub refresh () { #{{{
        my @add;
        foreach my $file (@files) {
                my $page=pagename($file);
        my @add;
        foreach my $file (@files) {
                my $page=pagename($file);

+               $pagesources{$page}=$file;

                if (! $oldpagemtime{$page}) {
                if (! $oldpagemtime{$page}) {

-                       debug("new page $page") unless exists $pagectime{$page};

                        push @add, $file;
                        push @add, $file;

-                       $links{$page}=[];
-                       $pagesources{$page}=$file;
+                       $pagecase{lc $page}=$page;

                        if ($config{getctime} && -e "$config{srcdir}/$file") {
                                $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
                        }
                        if ($config{getctime} && -e "$config{srcdir}/$file") {
                                $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
                        }


@@ -375,63 +285,64 @@ sub refresh () { #{{{
        my @del;
        foreach my $page (keys %oldpagemtime) {
                if (! $exists{$page}) {
        my @del;
        foreach my $page (keys %oldpagemtime) {
                if (! $exists{$page}) {

-                       debug("removing old page $page");
+                       debug(sprintf(gettext("removing old page %s"), $page));

                        push @del, $pagesources{$page};
                        push @del, $pagesources{$page};

-                       prune($config{destdir}."/".$renderedfiles{$page});
-                       delete $renderedfiles{$page};
+                       $links{$page}=[];
+                       $renderedfiles{$page}=[];

                        $oldpagemtime{$page}=0;
                        $oldpagemtime{$page}=0;

+                       prune($config{destdir}."/".$_)
+                               foreach @{$oldrenderedfiles{$page}};

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

-       
-       # render any updated files
+
+       # scan changed and new files
+       my @changed;

        foreach my $file (@files) {
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
        foreach my $file (@files) {
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||

-                   mtime(srcfile($file)) > $oldpagemtime{$page}) {
-                       debug("rendering $file");
-                       render($file);
-                       $rendered{$file}=1;
+                   mtime(srcfile($file)) > $oldpagemtime{$page} ||
+                   $forcerebuild{$page}) {
+                       debug(sprintf(gettext("scanning %s"), $file));
+                       push @changed, $file;
+                       scan($file);

                }
        }
                }
        }

+       calculate_backlinks();
+
+       # render changed and new pages
+       foreach my $file (@changed) {
+               debug(sprintf(gettext("rendering %s"), $file));
+               render($file);
+               $rendered{$file}=1;
+       }

        
        

-       # if any files were added or removed, check to see if each page
-       # needs an update due to linking to them or inlining them.
-       # TODO: inefficient; pages may get rendered above and again here;
-       # problem is the bestlink may have changed and we won't know until
-       # now
+       # rebuild pages that link to added or removed pages

        if (@add || @del) {
        if (@add || @del) {

-FILE:          foreach my $file (@files) {
-                       my $page=pagename($file);
-                       foreach my $f (@add, @del) {
-                               my $p=pagename($f);
-                               foreach my $link (@{$links{$page}}) {
-                                       if (bestlink($page, $link) eq $p) {
-                                               debug("rendering $file, which links to $p");
-                                               render($file);
-                                               $rendered{$file}=1;
-                                               next FILE;
-                                       }
-                               }
+               foreach my $f (@add, @del) {
+                       my $p=pagename($f);
+                       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));
+                               render($file);
+                               $rendered{$file}=1;

                        }
                }
        }
 
                        }
                }
        }
 

-       # Handle backlinks; if a page has added/removed links, update the
-       # pages it links to. Also handles rebuilding dependant pages.
-       # TODO: inefficient; pages may get rendered above and again here;
-       # problem is the backlinks could be wrong in the first pass render
-       # above

        if (%rendered || @del) {
        if (%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}) {
                                foreach my $file (keys %rendered, @del) {
                                        next if $f eq $file;
                                        my $page=pagename($file);
                        my $p=pagename($f);
                        if (exists $depends{$p}) {
                                foreach my $file (keys %rendered, @del) {
                                        next if $f eq $file;
                                        my $page=pagename($file);

-                                       if (globlist_match($page, $depends{$p})) {
-                                               debug("rendering $f, which depends on $page");
+                                       if (pagespec_match($page, $depends{$p})) {
+                                               debug(sprintf(gettext("rendering %s, which depends on %s"), $f, $page));

                                                render($f);
                                                $rendered{$f}=1;
                                                last;
                                                render($f);
                                                $rendered{$f}=1;
                                                last;


@@ -440,6 +351,8 @@ FILE:               foreach my $file (@files) {
                        }
                }
                
                        }
                }
                

+               # handle backlinks; if a page has added/removed links,
+               # update the pages it links to

                my %linkchanged;
                foreach my $file (keys %rendered, @del) {
                        my $page=pagename($file);
                my %linkchanged;
                foreach my $file (keys %rendered, @del) {
                        my $page=pagename($file);


@@ -466,23 +379,56 @@ FILE:             foreach my $file (@files) {
                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {
                foreach my $link (keys %linkchanged) {
                        my $linkfile=$pagesources{$link};
                        if (defined $linkfile) {

-                               debug("rendering $linkfile, to update its backlinks");
+                               next if $rendered{$linkfile};
+                               debug(sprintf(gettext("rendering %s, to update its backlinks"), $linkfile));

                                render($linkfile);
                                $rendered{$linkfile}=1;
                        }
                }
        }
 
                                render($linkfile);
                                $rendered{$linkfile}=1;
                        }
                }
        }
 

-       if (@del && exists $hooks{delete}) {
-               foreach my $id (keys %{$hooks{delete}}) {
-                       $hooks{delete}{$id}{call}->(@del);
+       # remove no longer rendered files
+       foreach my $src (keys %rendered) {
+               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));
+                               prune($config{destdir}."/".$file);
+                       }

                }
        }
                }
        }

-       if (%rendered && exists $hooks{change}) {
-               foreach my $id (keys %{$hooks{change}}) {
-                       $hooks{change}{$id}{call}->(keys %rendered);
-               }
+
+       if (@del) {
+               run_hooks(delete => sub { shift->(@del) });
+       }
+       if (%rendered) {
+               run_hooks(change => sub { shift->(keys %rendered) });

        }
 } #}}}
 
        }
 } #}}}
 

+sub commandline_render () { #{{{
+       loadplugins();
+       checkconfig();
+       lockwiki();
+       loadindex();
+       unlockwiki();
+
+       my $srcfile=possibly_foolish_untaint($config{render});
+       my $file=$srcfile;
+       $file=~s/\Q$config{srcdir}\E\/?//;
+
+       my $type=pagetype($file);
+       die sprintf(gettext("ikiwiki: cannot render %s"), $srcfile)."\n" unless defined $type;
+       my $content=readfile($srcfile);
+       my $page=pagename($file);
+       $pagesources{$page}=$file;
+       $content=filter($page, $content);
+       $content=preprocess($page, $page, $content);
+       $content=linkify($page, $page, $content);
+       $content=htmlize($page, $type, $content);
+
+       print genpage($page, $content, mtime($srcfile));
+       exit 0;
+} #}}}
+

 1
 1