]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Render.pm
web commit by LarsChristianHausmann
[ikiwiki.git] / IkiWiki / Render.pm
index b3dfc364d12805e5bc3e24005fff2d5c4197588d..0dfa03cd4229f040ef17ae66579f1d3c4ca5ec35 100644 (file)
@@ -1,15 +1,20 @@
+#!/usr/bin/perl
+
 package IkiWiki;
 
 use warnings;
 use strict;
 use File::Spec;
 package IkiWiki;
 
 use warnings;
 use strict;
 use File::Spec;
+use IkiWiki;
 
 
-sub linkify ($$) { #{{{
-       my $content=shift;
+sub linkify ($$$) { #{{{
+       my $lpage=shift;
        my $page=shift;
        my $page=shift;
+       my $content=shift;
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
 
        $content =~ s{(\\?)$config{wiki_link_regexp}}{
-               $1 ? "[[$2]]" : htmllink($page, $2)
+               $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
+                  : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
        }eg;
        
        return $content;
        }eg;
        
        return $content;
@@ -24,14 +29,25 @@ sub htmlize ($$) { #{{{
                $blosxom::version="is a proper perl module too much to ask?";
                use warnings 'all';
                do "/usr/bin/markdown";
                $blosxom::version="is a proper perl module too much to ask?";
                use warnings 'all';
                do "/usr/bin/markdown";
+               require Encode;
        }
        
        if ($type eq '.mdwn') {
        }
        
        if ($type eq '.mdwn') {
-               return Markdown::Markdown($content);
+               # Markdown does character based stuff that does not work
+               # well with utf-8 strings.
+               $content=Encode::decode_utf8(Markdown::Markdown(Encode::encode_utf8($content)));
        }
        else {
                error("htmlization of $type not supported");
        }
        }
        else {
                error("htmlization of $type not supported");
        }
+
+       if (exists $hooks{sanitize}) {
+               foreach my $id (keys %{$hooks{sanitize}}) {
+                       $content=$hooks{sanitize}{$id}{call}->($content);
+               }
+       }
+       
+       return $content;
 } #}}}
 
 sub backlinks ($) { #{{{
 } #}}}
 
 sub backlinks ($) { #{{{
@@ -79,98 +95,122 @@ sub parentlinks ($) { #{{{
        return @ret;
 } #}}}
 
        return @ret;
 } #}}}
 
-sub rsspage ($) { #{{{
+sub preprocess ($$;$) { #{{{
        my $page=shift;
        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;
+} #}}}
 
 
-       return $page.".rss";
+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 ($$$) { #{{{
 } #}}}
 
 sub genpage ($$$) { #{{{
-       my $content=shift;
        my $page=shift;
        my $page=shift;
+       my $content=shift;
        my $mtime=shift;
 
        my $title=pagetitle(basename($page));
        
        my $template=HTML::Template->new(blind_cache => 1,
                filename => "$config{templatedir}/page.tmpl");
        my $mtime=shift;
 
        my $title=pagetitle(basename($page));
        
        my $template=HTML::Template->new(blind_cache => 1,
                filename => "$config{templatedir}/page.tmpl");
-       
+       my $actions=0;
+
        if (length $config{cgiurl}) {
        if (length $config{cgiurl}) {
-               $template->param(editurl => "$config{cgiurl}?do=edit&page=$page");
-               $template->param(prefsurl => "$config{cgiurl}?do=prefs");
+               $template->param(editurl => cgiurl(do => "edit", page => $page));
+               $template->param(prefsurl => cgiurl(do => "prefs"));
                if ($config{rcs}) {
                if ($config{rcs}) {
-                       $template->param(recentchangesurl => "$config{cgiurl}?do=recentchanges");
+                       $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);
        }
 
        if (length $config{historyurl}) {
                my $u=$config{historyurl};
                $u=~s/\[\[file\]\]/$pagesources{$page}/g;
                $template->param(historyurl => $u);
+               $actions++;
+       }
+       if ($config{discussion}) {
+               $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
+               $actions++;
        }
 
        }
 
-       if ($config{rss}) {
-               $template->param(rssurl => rsspage($page));
+       if ($actions) {
+               $template->param(have_actions => 1);
        }
        }
-       
+
        $template->param(
                title => $title,
                wikiname => $config{wikiname},
                parentlinks => [parentlinks($page)],
                content => $content,
                backlinks => [backlinks($page)],
        $template->param(
                title => $title,
                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 ($$) { #{{{
-       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");
-       
-       # Regular page gets a feed that is updated every time the
-       # page is changed, so the mtime is encoded in the guid.
-       my @items=(
-               {
-                       itemtitle => pagetitle(basename($page)),
-                       itemguid => "$url?mtime=$mtime",
-                       itemurl => $url,
-                       itempubdate => date_822($mtime),
-                       itemcontent => absolute_urls($content, $url), # rss sucks
-               },
-       );
-       
-       $template->param(
-               title => $config{wikiname},
-               pageurl => $url,
-               items => \@items,
-       );
+       if (exists $hooks{pagetemplate}) {
+               foreach my $id (keys %{$hooks{pagetemplate}}) {
+                       $hooks{pagetemplate}{$id}{call}->($page, $template);
+               }
+       }
        
        return $template->output;
 } #}}}
        
        return $template->output;
 } #}}}
@@ -189,56 +229,79 @@ sub check_overwrite ($$) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 
+sub displaytime ($) { #{{{
+       my $time=shift;
+
+       if ($config{timeformat} eq '%c') {
+               return scalar(localtime($time)); # optimisation
+       }
+       else {
+               eval q{use POSIX};
+               return POSIX::strftime($config{timeformat}, localtime($time));
+       }
+} #}}}
+
 sub mtime ($) { #{{{
 sub mtime ($) { #{{{
-       my $page=shift;
+       my $file=shift;
        
        
-       return (stat($page))[9];
+       return (stat($file))[9];
 } #}}}
 
 sub findlinks ($$) { #{{{
 } #}}}
 
 sub findlinks ($$) { #{{{
-       my $content=shift;
        my $page=shift;
        my $page=shift;
+       my $content=shift;
 
        my @links;
        while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
 
        my @links;
        while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
-               push @links, lc($1);
+               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";
+       }
+       else {
+               return @links;
        }
        }
-       # Discussion links are a special case since they're not in the text
-       # of the page, but on its template.
-       return @links, "$page/discussion";
 } #}}}
 
 sub render ($) { #{{{
        my $file=shift;
        
        my $type=pagetype($file);
 } #}}}
 
 sub render ($) { #{{{
        my $file=shift;
        
        my $type=pagetype($file);
-       my $content=readfile("$config{srcdir}/$file");
+       my $srcfile=srcfile($file);
        if ($type ne 'unknown') {
        if ($type ne 'unknown') {
+               my $content=readfile($srcfile);
                my $page=pagename($file);
                my $page=pagename($file);
+               delete $depends{$page};
                
                
-               $links{$page}=[findlinks($content, $page)];
+               if (exists $hooks{filter}) {
+                       foreach my $id (keys %{$hooks{filter}}) {
+                               $content=$hooks{filter}{$id}{call}->(
+                                       page => $page,
+                                       content => $content
+                               );
+                       }
+               }
                
                
-               $content=linkify($content, $page);
+               $links{$page}=[findlinks($page, $content)];
+               
+               $content=linkify($page, $page, $content);
+               $content=preprocess($page, $content);
                $content=htmlize($type, $content);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);
                $content=htmlize($type, $content);
                
                check_overwrite("$config{destdir}/".htmlpage($page), $page);
-               writefile("$config{destdir}/".htmlpage($page),
-                       genpage($content, $page, mtime("$config{srcdir}/$file")));              
+               writefile(htmlpage($page), $config{destdir},
+                       genpage($page, $content, mtime($srcfile)));
                $oldpagemtime{$page}=time;
                $renderedfiles{$page}=htmlpage($page);
                $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}) {
-                       writefile("$config{destdir}/".rsspage($page),
-                               genrss($content, $page, mtime("$config{srcdir}/$file")));
-               }
        }
        else {
        }
        else {
+               my $content=readfile($srcfile, 1);
                $links{$file}=[];
                $links{$file}=[];
+               delete $depends{$file};
                check_overwrite("$config{destdir}/$file", $file);
                check_overwrite("$config{destdir}/$file", $file);
-               writefile("$config{destdir}/$file", $content);
+               writefile($file, $config{destdir}, $content, 1);
                $oldpagemtime{$file}=time;
                $renderedfiles{$file}=$file;
        }
                $oldpagemtime{$file}=time;
                $renderedfiles{$file}=$file;
        }
@@ -263,9 +326,7 @@ sub refresh () { #{{{
                no_chdir => 1,
                wanted => sub {
                        if (/$config{wiki_file_prune_regexp}/) {
                no_chdir => 1,
                wanted => sub {
                        if (/$config{wiki_file_prune_regexp}/) {
-                               no warnings 'once';
                                $File::Find::prune=1;
                                $File::Find::prune=1;
-                               use warnings "all";
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
                        }
                        elsif (! -d $_ && ! -l $_) {
                                my ($f)=/$config{wiki_file_regexp}/; # untaint
@@ -280,6 +341,30 @@ sub refresh () { #{{{
                        }
                },
        }, $config{srcdir});
                        }
                },
        }, $config{srcdir});
+       find({
+               no_chdir => 1,
+               wanted => sub {
+                       if (/$config{wiki_file_prune_regexp}/) {
+                               $File::Find::prune=1;
+                       }
+                       elsif (! -d $_ && ! -l $_) {
+                               my ($f)=/$config{wiki_file_regexp}/; # untaint
+                               if (! defined $f) {
+                                       warn("skipping bad filename $_\n");
+                               }
+                               else {
+                                       # Don't add files that are in the
+                                       # srcdir.
+                                       $f=~s/^\Q$config{underlaydir}\E\/?//;
+                                       if (! -e "$config{srcdir}/$f" && 
+                                           ! -l "$config{srcdir}/$f") {
+                                               push @files, $f;
+                                               $exists{pagename($f)}=1;
+                                       }
+                               }
+                       }
+               },
+       }, $config{underlaydir});
 
        my %rendered;
 
 
        my %rendered;
 
@@ -288,11 +373,16 @@ sub refresh () { #{{{
        foreach my $file (@files) {
                my $page=pagename($file);
                if (! $oldpagemtime{$page}) {
        foreach my $file (@files) {
                my $page=pagename($file);
                if (! $oldpagemtime{$page}) {
-                       debug("new page $page");
+                       debug("new page $page") unless exists $pagectime{$page};
                        push @add, $file;
                        $links{$page}=[];
                        $pagesources{$page}=$file;
                        push @add, $file;
                        $links{$page}=[];
                        $pagesources{$page}=$file;
-                       $pagectime{$page}=time;
+                       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;
                }
        }
        my @del;
@@ -312,7 +402,7 @@ sub refresh () { #{{{
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
                my $page=pagename($file);
                
                if (! exists $oldpagemtime{$page} ||
-                   mtime("$config{srcdir}/$file") > $oldpagemtime{$page}) {
+                   mtime(srcfile($file)) > $oldpagemtime{$page}) {
                        debug("rendering changed file $file");
                        render($file);
                        $rendered{$file}=1;
                        debug("rendering changed file $file");
                        render($file);
                        $rendered{$file}=1;
@@ -320,7 +410,7 @@ sub refresh () { #{{{
        }
        
        # if any files were added or removed, check to see if each page
        }
        
        # if any files were added or removed, check to see if each page
-       # needs an update due to linking to them
+       # 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
        # TODO: inefficient; pages may get rendered above and again here;
        # problem is the bestlink may have changed and we won't know until
        # now
@@ -341,20 +431,37 @@ FILE:             foreach my $file (@files) {
                }
        }
 
                }
        }
 
-       # handle backlinks; if a page has added/removed links, update the
-       # pages it links to
+       # 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
        # 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) {
+       if (%rendered || @del) {
+               foreach my $f (@files) {
+                       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");
+                                               render($f);
+                                               $rendered{$f}=1;
+                                               last;
+                                       }
+                               }
+                       }
+               }
+               
                my %linkchanged;
                foreach my $file (keys %rendered, @del) {
                        my $page=pagename($file);
                my %linkchanged;
                foreach my $file (keys %rendered, @del) {
                        my $page=pagename($file);
+                       
                        if (exists $links{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
                                        if (length $link &&
                        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;
                                        }
                                }
                                                $linkchanged{$link}=1;
                                        }
                                }
@@ -362,8 +469,8 @@ FILE:               foreach my $file (@files) {
                        if (exists $oldlinks{$page}) {
                                foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
                                        if (length $link &&
                        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;
                                        }
                                }
                                                $linkchanged{$link}=1;
                                        }
                                }
@@ -374,9 +481,21 @@ FILE:              foreach my $file (@files) {
                        if (defined $linkfile) {
                                debug("rendering $linkfile, to update its backlinks");
                                render($linkfile);
                        if (defined $linkfile) {
                                debug("rendering $linkfile, to update its backlinks");
                                render($linkfile);
+                               $rendered{$linkfile}=1;
                        }
                }
        }
                        }
                }
        }
+
+       if (@del && exists $hooks{delete}) {
+               foreach my $id (keys %{$hooks{delete}}) {
+                       $hooks{delete}{$id}{call}->(@del);
+               }
+       }
+       if (%rendered && exists $hooks{change}) {
+               foreach my $id (keys %{$hooks{change}}) {
+                       $hooks{change}{$id}{call}->(keys %rendered);
+               }
+       }
 } #}}}
 
 1
 } #}}}
 
 1