]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Render.pm
fixes, and make dir optional
[ikiwiki.git] / IkiWiki / Render.pm
index 23f6b1c723d8f97b3bc6c3ac2f24ea4cca9067c5..1449b8931cc9ebf364d0daf7841f1d7577c358b6 100644 (file)
@@ -1,16 +1,20 @@
+#!/usr/bin/perl
+
 package IkiWiki;
 
 use warnings;
 use strict;
-use File::Spec;
+use IkiWiki;
+use Encode;
 
-sub linkify ($$) { #{{{
+sub linkify ($$$) { #{{{
+       my $lpage=shift; # the page containing the links
+       my $page=shift; # the page the link will end up on (different for inline)
        my $content=shift;
-       my $page=shift;
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
-               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($page, titlepage($3), 0, 0, pagetitle($2)))
-                  : ( $1 ? "[[$3]]" :    htmllink($page, titlepage($3)))
+               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
+                  : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
        }eg;
        
        return $content;
@@ -20,19 +24,18 @@ sub htmlize ($$) { #{{{
        my $type=shift;
        my $content=shift;
        
-       if (! $INC{"/usr/bin/markdown"}) {
-               no warnings 'once';
-               $blosxom::version="is a proper perl module too much to ask?";
-               use warnings 'all';
-               do "/usr/bin/markdown";
-       }
-       
-       if ($type eq '.mdwn') {
-               return Markdown::Markdown($content);
+       if (exists $hooks{htmlize}{$type}) {
+               $content=$hooks{htmlize}{$type}{call}->($content);
        }
        else {
                error("htmlization of $type not supported");
        }
+
+       run_hooks(sanitize => sub {
+               $content=shift->($content);
+       });
+       
+       return $content;
 } #}}}
 
 sub backlinks ($) { #{{{
@@ -42,7 +45,7 @@ sub backlinks ($) { #{{{
        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));
+                       my $href=abs2rel(htmlpage($p), dirname($page));
                        
                        # Trim common dir prefixes from both pages.
                        my $p_trimmed=$p;
@@ -53,7 +56,7 @@ sub backlinks ($) { #{{{
                                $p_trimmed=~s/^\Q$dir\E// &&
                                $page_trimmed=~s/^\Q$dir\E//;
                                       
-                       push @links, { url => $href, page => $p_trimmed };
+                       push @links, { url => $href, page => pagetitle($p_trimmed) };
                }
        }
 
@@ -67,10 +70,11 @@ sub parentlinks ($) { #{{{
        my $pagelink="";
        my $path="";
        my $skip=1;
+       return if $page eq 'index'; # toplevel
        foreach my $dir (reverse split("/", $page)) {
                if (! $skip) {
                        $path.="../";
-                       unshift @ret, { url => "$path$dir.html", page => $dir };
+                       unshift @ret, { url => "$path$dir.html", page => pagetitle($dir) };
                }
                else {
                        $skip=0;
@@ -80,35 +84,42 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
-sub rsspage ($) { #{{{
-       my $page=shift;
-
-       return $page.".rss";
-} #}}}
-
-sub postprocess { #{{{
-       # Takes content to postprocess followed by a list of postprocessor
-       # commands and subroutine references to run for the commands.
-       my $page=shift;
+sub preprocess ($$$;$) { #{{{
+       my $page=shift; # the page the data comes from
+       my $destpage=shift; # the page the data will appear in (different for inline)
        my $content=shift;
-       my %commands=@_;
-       
+       my $onlystrip=shift || 0; # strip directives without processing
+
        my $handle=sub {
                my $escape=shift;
                my $command=shift;
                my $params=shift;
                if (length $escape) {
-                       "[[$command $params]]";
+                       return "[[$command $params]]";
+               }
+               elsif ($onlystrip) {
+                       return "";
                }
-               elsif (exists $commands{$command}) {
-                       my %params;
-                       while ($params =~ /(\w+)=\"([^"]+)"(\s+|$)/g) {
-                               $params{$1}=$2;
+               elsif (exists $hooks{preprocess}{$command}) {
+                       # Note: preserve order of params, some plugins may
+                       # consider it significant.
+                       my @params;
+                       while ($params =~ /(?:(\w+)=)?(?:"([^"]+)"|(\S+))(?:\s+|$)/g) {
+                               if (defined $1) {
+                                       push @params, $1, (defined $2 ? $2 : $3);
+                               }
+                               else {
+                                       push @params, (defined $2 ? $2 : $3), '';
+                               }
                        }
-                       $commands{$command}->($page, %params);
+                       return $hooks{preprocess}{$command}{call}->(
+                               @params,
+                               page => $page,
+                               destpage => $destpage,
+                       );
                }
                else {
-                       "[[bad directive $command]]";
+                       return "[[$command not processed]]";
                }
        };
        
@@ -116,189 +127,86 @@ sub postprocess { #{{{
        return $content;
 } #}}}
 
-sub blog_list ($$) { #{{{
-       my $globlist=shift;
-       my $maxitems=shift;
-       
-       my @list;
-       foreach my $page (keys %pagesources) {
-               if (globlist_match($page, $globlist)) {
-                       push @list, $page;
-               }
-       }
-
-       @list=sort { $pagectime{$b} <=> $pagectime{$a} } @list;
-       return @list if ! $maxitems || @list <= $maxitems;
-       return @list[0..$maxitems - 1];
-} #}}}
-
-sub get_inline_content ($$) { #{{{
-       my $parentpage=shift;
+sub add_depends ($$) { #{{{
        my $page=shift;
+       my $globlist=shift;
        
-       my $file=$pagesources{$page};
-       my $type=pagetype($file);
-       if ($type ne 'unknown') {
-               return htmlize($type, linkify(readfile(srcfile($file)), $parentpage));
+       if (! exists $depends{$page}) {
+               $depends{$page}=$globlist;
        }
        else {
-               return "";
+               $depends{$page}=globlist_merge($depends{$page}, $globlist);
        }
-} #}}}
+} # }}}
+
+sub globlist_merge ($$) { #{{{
+       my $a=shift;
+       my $b=shift;
 
-sub postprocess_html_inline { #{{{
-       my $parentpage=shift;
-       my %params=@_;
-       
-       if (! exists $params{pages}) {
-               return "";
-       }
-       if (! exists $params{archive}) {
-               $params{archive}="no";
-       }
-       if (! exists $params{show} && $params{archive} eq "no") {
-               $params{show}=10;
-       }
-       $inlinepages{$parentpage}=$params{pages};
-       
        my $ret="";
-       
-       if (exists $params{rootpage}) {
-               my $formtemplate=HTML::Template->new(blind_cache => 1,
-                       filename => "$config{templatedir}/blogpost.tmpl");
-               $formtemplate->param(cgiurl => $config{cgiurl});
-               $formtemplate->param(rootpage => $params{rootpage});
-               my $form=$formtemplate->output;
-               $ret.=$form;
-       }
-       
-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => (($params{archive} eq "no") 
-                               ? "$config{templatedir}/inlinepage.tmpl"
-                               : "$config{templatedir}/inlinepagetitle.tmpl"));
-       
-       foreach my $page (blog_list($params{pages}, $params{show})) {
-               next if $page eq $parentpage;
-               $template->param(pagelink => htmllink($parentpage, $page));
-               $template->param(content => get_inline_content($parentpage, $page))
-                       if $params{archive} eq "no";
-               $template->param(ctime => scalar(gmtime($pagectime{$page})));
-               $ret.=$template->output;
+       # 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 "</p>$ret<p>";
+       return $ret;
 } #}}}
 
 sub genpage ($$$) { #{{{
-       my $content=shift;
        my $page=shift;
+       my $content=shift;
        my $mtime=shift;
 
-       $content = postprocess($page, $content, inline => \&postprocess_html_inline);
-       
-       my $title=pagetitle(basename($page));
-       
-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => "$config{templatedir}/page.tmpl");
-       
+       my $template=template("page.tmpl", blind_cache => 1);
+       my $actions=0;
+
        if (length $config{cgiurl}) {
                $template->param(editurl => cgiurl(do => "edit", page => $page));
                $template->param(prefsurl => cgiurl(do => "prefs"));
                if ($config{rcs}) {
                        $template->param(recentchangesurl => cgiurl(do => "recentchanges"));
                }
+               $actions++;
        }
 
        if (length $config{historyurl}) {
                my $u=$config{historyurl};
                $u=~s/\[\[file\]\]/$pagesources{$page}/g;
                $template->param(historyurl => $u);
+               $actions++;
        }
-       if ($config{hyperestraier}) {
-               $template->param(hyperestraierurl => cgiurl());
+       if ($config{discussion}) {
+               $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
+               $actions++;
        }
 
-       if ($config{rss} && $inlinepages{$page}) {
-               $template->param(rssurl => rsspage(basename($page)));
+       if ($actions) {
+               $template->param(have_actions => 1);
        }
-       
+
        $template->param(
-               title => $title,
+               title => $page eq 'index' 
+                       ? $config{wikiname} 
+                       : pagetitle(basename($page)),
                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => [backlinks($page)],
-               discussionlink => htmllink($page, "Discussion", 1, 1),
-               mtime => scalar(gmtime($mtime)),
+               mtime => displaytime($mtime),
                styleurl => styleurl($page),
        );
-       
-       return $template->output;
-} #}}}
-
-sub date_822 ($) { #{{{
-       my $time=shift;
-
-       eval q{use POSIX};
-       return POSIX::strftime("%a, %d %b %Y %H:%M:%S %z", localtime($time));
-} #}}}
-
-sub absolute_urls ($$) { #{{{
-       # sucky sub because rss sucks
-       my $content=shift;
-       my $url=shift;
-
-       $url=~s/[^\/]+$//;
-       
-       $content=~s/<a\s+href="(?!http:\/\/)([^"]+)"/<a href="$url$1"/ig;
-       $content=~s/<img\s+src="(?!http:\/\/)([^"]+)"/<img src="$url$1"/ig;
-       return $content;
-} #}}}
 
-sub genrss ($$$) { #{{{
-       my $content=shift;
-       my $page=shift;
-       my $mtime=shift;
-       
-       my $url="$config{url}/".htmlpage($page);
-       
-       my $template=HTML::Template->new(blind_cache => 1,
-               filename => "$config{templatedir}/rsspage.tmpl");
-       
-       my @items;
-       my $isblog=0;
-       my $gen_blog=sub {
-               my $parentpage=shift;
-               my %params=@_;
-               
-               if (! exists $params{show}) {
-                       $params{show}=10;
-               }
-               if (! exists $params{pages}) {
-                       return "";
-               }
-               
-               $isblog=1;
-               foreach my $page (blog_list($params{pages}, $params{show})) {
-                       next if $page eq $parentpage;
-                       push @items, {
-                               itemtitle => pagetitle(basename($page)),
-                               itemurl => "$config{url}/$renderedfiles{$page}",
-                               itempubdate => date_822($pagectime{$page}),
-                               itemcontent => absolute_urls(get_inline_content($parentpage, $page), $url),
-                       } if exists $renderedfiles{$page};
-               }
-               
-               return "";
-       };
-       
-       $content = postprocess($page, $content, inline => $gen_blog);
-
-       $template->param(
-               title => $config{wikiname},
-               pageurl => $url,
-               items => \@items,
-       );
+       run_hooks(pagetemplate => sub {
+               shift->(page => $page, destpage => $page, template => $template);
+       });
        
        return $template->output;
 } #}}}
@@ -310,13 +218,20 @@ sub check_overwrite ($$) { #{{{
        my $src=shift;
        
        if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
-               error("$dest already exists and was rendered from ".
-                       join(" ",(grep { $renderedfiles{$_} eq $dest } keys
-                               %renderedfiles)).
-                       ", before, so not rendering from $src");
+               error("$dest already exists and was not rendered from $src before");
        }
 } #}}}
 
+sub displaytime ($) { #{{{
+       my $time=shift;
+
+       eval q{use POSIX};
+       # strftime doesn't know about encodings, so make sure
+       # its output is properly treated as utf8
+       return decode_utf8(POSIX::strftime(
+                       $config{timeformat}, localtime($time)));
+} #}}}
+
 sub mtime ($) { #{{{
        my $file=shift;
        
@@ -324,51 +239,64 @@ sub mtime ($) { #{{{
 } #}}}
 
 sub findlinks ($$) { #{{{
-       my $content=shift;
        my $page=shift;
+       my $content=shift;
 
        my @links;
        while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
                push @links, titlepage($2);
        }
-       # Discussion links are a special case since they're not in the text
-       # of the page, but on its template.
-       return @links, "$page/discussion";
+       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";
+       }
+       else {
+               return @links;
+       }
 } #}}}
 
+sub filter ($$) {
+       my $page=shift;
+       my $content=shift;
+
+       run_hooks(filter => sub {
+               $content=shift->(page => $page, content => $content);
+       });
+
+       return $content;
+}
+
 sub render ($) { #{{{
        my $file=shift;
        
        my $type=pagetype($file);
        my $srcfile=srcfile($file);
-       my $content=readfile($srcfile);
-       if ($type ne 'unknown') {
+       if (defined $type) {
+               my $content=readfile($srcfile);
                my $page=pagename($file);
+               delete $depends{$page};
                
-               $links{$page}=[findlinks($content, $page)];
-               delete $inlinepages{$page};
+               $content=filter($page, $content);
                
-               $content=linkify($content, $page);
+               $links{$page}=[findlinks($page, $content)];
+               
+               $content=linkify($page, $page, $content);
+               $content=preprocess($page, $page, $content);
                $content=htmlize($type, $content);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);
                writefile(htmlpage($page), $config{destdir},
-                       genpage($content, $page, mtime($srcfile)));
+                       genpage($page, $content, mtime($srcfile)));
                $oldpagemtime{$page}=time;
                $renderedfiles{$page}=htmlpage($page);
-
-               # TODO: should really add this to renderedfiles and call
-               # check_overwrite, as above, but currently renderedfiles
-               # only supports listing one file per page.
-               if ($config{rss} && exists $inlinepages{$page}) {
-                       writefile(rsspage($page), $config{destdir},
-                               genrss($content, $page, mtime($srcfile)));
-               }
        }
        else {
+               my $content=readfile($srcfile, 1);
                $links{$file}=[];
+               delete $depends{$file};
                check_overwrite("$config{destdir}/$file", $file);
-               writefile($file, $config{destdir}, $content);
+               writefile($file, $config{destdir}, $content, 1);
                $oldpagemtime{$file}=time;
                $renderedfiles{$file}=$file;
        }
@@ -384,57 +312,6 @@ sub prune ($) { #{{{
        }
 } #}}}
 
-sub estcfg () { #{{{
-       my $estdir="$config{wikistatedir}/hyperestraier";
-       my $cgi=basename($config{cgiurl});
-       $cgi=~s/\..*$//;
-       open(TEMPLATE, ">$estdir/$cgi.tmpl") ||
-               error("write $estdir/$cgi.tmpl: $!");
-       print TEMPLATE misctemplate("search", 
-               "<!--ESTFORM-->\n\n<!--ESTRESULT-->\n\n<!--ESTINFO-->\n\n");
-       close TEMPLATE;
-       open(TEMPLATE, ">$estdir/$cgi.conf") ||
-               error("write $estdir/$cgi.conf: $!");
-       my $template=HTML::Template->new(
-               filename => "$config{templatedir}/estseek.conf"
-       );
-       eval q{use Cwd 'abs_path'};
-       $template->param(
-               index => $estdir,
-               tmplfile => "$estdir/$cgi.tmpl",
-               destdir => abs_path($config{destdir}),
-               url => $config{url},
-       );
-       print TEMPLATE $template->output;
-       close TEMPLATE;
-       $cgi="$estdir/".basename($config{cgiurl});
-       unlink($cgi);
-       symlink("/usr/lib/estraier/estseek.cgi", $cgi) ||
-               error("symlink $cgi: $!");
-} # }}}
-
-sub estcmd ($;@) { #{{{
-       my @params=split(' ', shift);
-       push @params, "-cl", "$config{wikistatedir}/hyperestraier";
-       if (@_) {
-               push @params, "-";
-       }
-       
-       my $pid=open(CHILD, "|-");
-       if ($pid) {
-               # parent
-               foreach (@_) {
-                       print CHILD "$_\n";
-               }
-               close(CHILD) || error("estcmd @params exited nonzero: $?");
-       }
-       else {
-               # child
-               open(STDOUT, "/dev/null"); # shut it up (closing won't work)
-               exec("estcmd", @params) || error("can't run estcmd");
-       }
-} #}}}
-
 sub refresh () { #{{{
        # find existing pages
        my %exists;
@@ -443,6 +320,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -462,6 +340,7 @@ sub refresh () { #{{{
        find({
                no_chdir => 1,
                wanted => sub {
+                       $_=decode_utf8($_);
                        if (/$config{wiki_file_prune_regexp}/) {
                                $File::Find::prune=1;
                        }
@@ -495,8 +374,12 @@ sub refresh () { #{{{
                        push @add, $file;
                        $links{$page}=[];
                        $pagesources{$page}=$file;
-                       $pagectime{$page}=mtime(srcfile($file))
-                               unless exists $pagectime{$page};
+                       if ($config{getctime} && -e "$config{srcdir}/$file") {
+                               $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
+                       }
+                       elsif (! exists $pagectime{$page}) {
+                               $pagectime{$page}=mtime(srcfile($file));
+                       }
                }
        }
        my @del;
@@ -516,8 +399,9 @@ sub refresh () { #{{{
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
-                   mtime(srcfile($file)) > $oldpagemtime{$page}) {
-                       debug("rendering changed file $file");
+                   mtime(srcfile($file)) > $oldpagemtime{$page} ||
+                   $forcerebuild{$page}) {
+                       debug("rendering $file");
                        render($file);
                        $rendered{$file}=1;
                }
@@ -546,18 +430,19 @@ FILE:             foreach my $file (@files) {
        }
 
        # Handle backlinks; if a page has added/removed links, update the
-       # pages it links to. Also handle inlining here.
+       # 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) {
                foreach my $f (@files) {
                        my $p=pagename($f);
-                       if (exists $inlinepages{$p}) {
+                       if (exists $depends{$p}) {
                                foreach my $file (keys %rendered, @del) {
+                                       next if $f eq $file;
                                        my $page=pagename($file);
-                                       if (globlist_match($page, $inlinepages{$p})) {
-                                               debug("rendering $f, which inlines $page");
+                                       if (globlist_match($page, $depends{$p})) {
+                                               debug("rendering $f, which depends on $page");
                                                render($f);
                                                $rendered{$f}=1;
                                                last;
@@ -573,8 +458,8 @@ FILE:               foreach my $file (@files) {
                        if (exists $links{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
                                        if (length $link &&
-                                           ! exists $oldlinks{$page} ||
-                                           ! grep { $_ eq $link } @{$oldlinks{$page}}) {
+                                           (! exists $oldlinks{$page} ||
+                                            ! grep { bestlink($page, $_) eq $link } @{$oldlinks{$page}})) {
                                                $linkchanged{$link}=1;
                                        }
                                }
@@ -582,8 +467,8 @@ FILE:               foreach my $file (@files) {
                        if (exists $oldlinks{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
                                        if (length $link &&
-                                           ! exists $links{$page} ||
-                                           ! grep { $_ eq $link } @{$links{$page}}) {
+                                           (! exists $links{$page} || 
+                                            ! grep { bestlink($page, $_) eq $link } @{$links{$page}})) {
                                                $linkchanged{$link}=1;
                                        }
                                }
@@ -599,19 +484,11 @@ FILE:             foreach my $file (@files) {
                }
        }
 
-       if ($config{hyperestraier} && (%rendered || @del)) {
-               debug("updating hyperestraier search index");
-               if (%rendered) {
-                       estcmd("gather -cm -bc -cl -sd", 
-                               map { $config{destdir}."/".$renderedfiles{pagename($_)} }
-                               keys %rendered);
-               }
-               if (@del) {
-                       estcmd("purge -cl");
-               }
-               
-               debug("generating hyperestraier cgi config");
-               estcfg();
+       if (@del) {
+               run_hooks(delete => sub { shift->(@del) });
+       }
+       if (%rendered) {
+               run_hooks(change => sub { shift->(keys %rendered) });
        }
 } #}}}