]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
* Add support for links of the form [../foo]], this links to the page
[git.ikiwiki.info.git] / IkiWiki.pm
index 7ead13cf66e054fc54b9efd30929a8155c69b010..499d3a71f773951e7700aea3ec668d8950b7c733 100644 (file)
@@ -7,19 +7,34 @@ use Encode;
 use HTML::Entities;
 use open qw{:utf8 :std};
 
+use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
+            %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
+           %forcerebuild};
+
+use Exporter q{import};
+our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
+                 bestlink htmllink readfile writefile pagetype srcfile pagename
+                 displaytime will_render
+                 %config %links %renderedfiles %pagesources);
+our $VERSION = 1.01; # plugin interface version
+
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
+memoize("pagespec_translate");
+memoize("file_pruned");
 
-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
-            %renderedfiles %pagesources %depends %hooks %forcerebuild};
+my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
+our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 
 sub defaultconfig () { #{{{
-       wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
+       wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/,
+               qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
        wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
-       wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
+       web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
        verbose => 0,
+       syslog => 0,
        wikiname => "wiki",
        default_pageext => "mdwn",
        cgi => 0,
@@ -31,6 +46,7 @@ sub defaultconfig () { #{{{
        diffurl => '',
        anonok => 0,
        rss => 0,
+       atom => 0,
        discussion => 1,
        rebuild => 0,
        refresh => 0,
@@ -43,14 +59,17 @@ sub defaultconfig () { #{{{
        srcdir => undef,
        destdir => undef,
        pingurl => [],
-       templatedir => "/usr/share/ikiwiki/templates",
-       underlaydir => "/usr/share/ikiwiki/basewiki",
+       templatedir => "$installdir/share/ikiwiki/templates",
+       underlaydir => "$installdir/share/ikiwiki/basewiki",
        setup => undef,
        adminuser => undef,
        adminemail => undef,
-       plugin => [qw{mdwn inline htmlscrubber}],
+       plugin => [qw{mdwn inline htmlscrubber passwordauth}],
        timeformat => '%c',
        locale => undef,
+       sslcookie => 0,
+       httpauth => 0,
+       userdir => "",
 } #}}}
    
 sub checkconfig () { #{{{
@@ -61,12 +80,14 @@ sub checkconfig () { #{{{
        }
        if (defined $config{locale}) {
                eval q{use POSIX};
+               error($@) if $@;
                $ENV{LANG} = $config{locale}
                        if POSIX::setlocale(&POSIX::LC_TIME, $config{locale});
        }
 
        if ($config{w3mmode}) {
                eval q{use Cwd q{abs_path}};
+               error($@) if $@;
                $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
                $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
                $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
@@ -77,9 +98,6 @@ sub checkconfig () { #{{{
        if ($config{cgi} && ! length $config{url}) {
                error("Must specify url to wiki with --url when using --cgi\n");
        }
-       if ($config{rss} && ! length $config{url}) {
-               error("Must specify url to wiki with --url when using --rss\n");
-       }
        
        $config{wikistatedir}="$config{srcdir}/.ikiwiki"
                unless exists $config{wikistatedir};
@@ -98,13 +116,8 @@ sub checkconfig () { #{{{
 } #}}}
 
 sub loadplugins () { #{{{
-       foreach my $plugin (@{$config{plugin}}) {
-               my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
-               eval qq{use $mod};
-               if ($@) {
-                       error("Failed to load plugin $mod: $@");
-               }
-       }
+       loadplugin($_) foreach @{$config{plugin}};
+       
        run_hooks(getopt => sub { shift->() });
        if (grep /^-/, @ARGV) {
                print STDERR "Unknown option: $_\n"
@@ -113,17 +126,46 @@ sub loadplugins () { #{{{
        }
 } #}}}
 
+sub loadplugin ($) { #{{{
+       my $plugin=shift;
+
+       my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
+       eval qq{use $mod};
+       if ($@) {
+               error("Failed to load plugin $mod: $@");
+       }
+} #}}}
+
 sub error ($) { #{{{
        if ($config{cgi}) {
                print "Content-type: text/html\n\n";
                print misctemplate("Error", "<p>Error: @_</p>");
        }
-       die @_;
+       log_message(error => @_);
+       exit(1);
 } #}}}
 
 sub debug ($) { #{{{
        return unless $config{verbose};
-       if (! $config{cgi}) {
+       log_message(debug => @_);
+} #}}}
+
+my $log_open=0;
+sub log_message ($$) { #{{{
+       my $type=shift;
+
+       if ($config{syslog}) {
+               require Sys::Syslog;
+               unless ($log_open) {
+                       Sys::Syslog::setlogsock('unix');
+                       Sys::Syslog::openlog('ikiwiki', '', 'user');
+                       $log_open=1;
+               }
+               eval {
+                       Sys::Syslog::syslog($type, join(" ", @_));
+               }
+       }
+       elsif (! $config{cgi}) {
                print "@_\n";
        }
        else {
@@ -230,25 +272,49 @@ sub writefile ($$$;$) { #{{{
        close OUT;
 } #}}}
 
+my %cleared;
+sub will_render ($$;$) { #{{{
+       my $page=shift;
+       my $dest=shift;
+       my $clear=shift;
+
+       # Important security check.
+       if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
+           ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
+               error("$config{destdir}/$dest independently created, not overwriting with version from $page");
+       }
+
+       if (! $clear || $cleared{$page}) {
+               $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
+       }
+       else {
+               $renderedfiles{$page}=[$dest];
+               $cleared{$page}=1;
+       }
+} #}}}
+
 sub bestlink ($$) { #{{{
-       # Given a page and the text of a link on the page, determine which
-       # existing page that link best points to. Prefers pages under a
-       # subdirectory with the same name as the source page, failing that
-       # goes down the directory tree to the base looking for matching
-       # pages.
        my $page=shift;
-       my $link=lc(shift);
+       my $link=shift;
        
        my $cwd=$page;
+
+       # relative links
+       while ($link=~s!(^|/)\.\./!!g) {
+               $cwd=~s!/?[^/]+$!!;
+       }
+
        do {
                my $l=$cwd;
                $l.="/" if length $l;
                $l.=$link;
 
                if (exists $links{$l}) {
-                       #debug("for $page, \"$link\", use $l");
                        return $l;
                }
+               elsif (exists $pagecase{lc $l}) {
+                       return $pagecase{lc $l};
+               }
        } while $cwd=~s!/?[^/]+$!!;
 
        #print STDERR "warning: page $page, broken link: $link\n";
@@ -281,20 +347,20 @@ sub cgiurl (@) { #{{{
        return $config{cgiurl}."?".join("&amp;", map "$_=$params{$_}", keys %params);
 } #}}}
 
-sub styleurl (;$) { #{{{
+sub baseurl (;$) { #{{{
        my $page=shift;
 
-       return "$config{url}/style.css" if ! defined $page;
+       return "$config{url}/" if ! defined $page;
        
        $page=~s/[^\/]+$//;
        $page=~s/[^\/]+\//..\//g;
-       return $page."style.css";
+       return $page;
 } #}}}
 
 sub abs2rel ($$) { #{{{
        # Work around very innefficient behavior in File::Spec if abs2rel
        # is passed two relative paths. It's much faster if paths are
-       # absolute!
+       # absolute! (Debian bug #376658; fixed in debian unstable now)
        my $path="/".shift;
        my $base="/".shift;
 
@@ -304,6 +370,17 @@ sub abs2rel ($$) { #{{{
        return $ret;
 } #}}}
 
+sub displaytime ($) { #{{{
+       my $time=shift;
+
+       eval q{use POSIX};
+       error($@) if $@;
+       # 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 htmllink ($$$;$$$) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)
@@ -322,17 +399,15 @@ sub htmllink ($$$;$$$) { #{{{
 
        $linktext=pagetitle(basename($link)) unless defined $linktext;
        
-       return $linktext if length $bestlink && $page eq $bestlink;
+       return "<span class=\"selflink\">$linktext</span>"
+               if length $bestlink && $page eq $bestlink;
        
-       # TODO BUG: %renderedfiles may not have it, if the linked to page
-       # was also added and isn't yet rendered! Note that this bug is
-       # masked by the bug that makes all new files be rendered twice.
-       if (! grep { $_ eq $bestlink } values %renderedfiles) {
+       if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
                $bestlink=htmlpage($bestlink);
        }
-       if (! grep { $_ eq $bestlink } values %renderedfiles) {
+       if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
                return "<span><a href=\"".
-                       cgiurl(do => "create", page => $link, from => $page).
+                       cgiurl(do => "create", page => lc($link), from => $page).
                        "\">?</a>$linktext</span>"
        }
        
@@ -344,6 +419,119 @@ sub htmllink ($$$;$$$) { #{{{
        return "<a href=\"$bestlink\">$linktext</a>";
 } #}}}
 
+sub htmlize ($$$) { #{{{
+       my $page=shift;
+       my $type=shift;
+       my $content=shift;
+
+       if (exists $hooks{htmlize}{$type}) {
+               $content=$hooks{htmlize}{$type}{call}->(
+                       page => $page,
+                       content => $content,
+               );
+       }
+       else {
+               error("htmlization of $type not supported");
+       }
+
+       run_hooks(sanitize => sub {
+               $content=shift->(
+                       page => $page,
+                       content => $content,
+               );
+       });
+
+       return $content;
+} #}}}
+
+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;
+
+       $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;
+} #}}}
+
+my %preprocessing;
+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 $scan=shift;
+
+       my $handle=sub {
+               my $escape=shift;
+               my $command=shift;
+               my $params=shift;
+               if (length $escape) {
+                       return "[[$command $params]]";
+               }
+               elsif (exists $hooks{preprocess}{$command}) {
+                       return "" if $scan && ! $hooks{preprocess}{$command}{scan};
+                       # Note: preserve order of params, some plugins may
+                       # consider it significant.
+                       my @params;
+                       while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
+                               my $key=$1;
+                               my $val;
+                               if (defined $2) {
+                                       $val=$2;
+                                       $val=~s/\r\n/\n/mg;
+                                       $val=~s/^\n+//g;
+                                       $val=~s/\n+$//g;
+                               }
+                               elsif (defined $3) {
+                                       $val=$3;
+                               }
+                               elsif (defined $4) {
+                                       $val=$4;
+                               }
+
+                               if (defined $key) {
+                                       push @params, $key, $val;
+                               }
+                               else {
+                                       push @params, $val, '';
+                               }
+                       }
+                       if ($preprocessing{$page}++ > 3) {
+                               # Avoid loops of preprocessed pages preprocessing
+                               # other pages that preprocess them, etc.
+                               return "[[$command preprocessing loop detected on $page at depth $preprocessing{$page}]]";
+                       }
+                       my $ret=$hooks{preprocess}{$command}{call}->(
+                               @params,
+                               page => $page,
+                               destpage => $destpage,
+                       );
+                       $preprocessing{$page}--;
+                       return $ret;
+               }
+               else {
+                       return "[[$command $params]]";
+               }
+       };
+       
+       $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
+       return $content;
+} #}}}
+
+sub filter ($$) { #{{{
+       my $page=shift;
+       my $content=shift;
+
+       run_hooks(filter => sub {
+               $content=shift->(page => $page, content => $content);
+       });
+
+       return $content;
+} #}}}
+
 sub indexlink () { #{{{
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
 } #}}}
@@ -379,6 +567,7 @@ sub loadindex () { #{{{
                chomp;
                my %items;
                $items{link}=[];
+               $items{dest}=[];
                foreach my $i (split(/ /, $_)) {
                        my ($item, $val)=split(/=/, $i, 2);
                        push @{$items{$item}}, decode_entities($val);
@@ -393,7 +582,9 @@ sub loadindex () { #{{{
                        $oldlinks{$page}=[@{$items{link}}];
                        $links{$page}=[@{$items{link}}];
                        $depends{$page}=$items{depends}[0] if exists $items{depends};
-                       $renderedfiles{$page}=$items{dest}[0];
+                       $renderedfiles{$page}=[@{$items{dest}}];
+                       $oldrenderedfiles{$page}=[@{$items{dest}}];
+                       $pagecase{lc $page}=$page;
                }
                $pagectime{$page}=$items{ctime}[0];
        }
@@ -412,9 +603,10 @@ sub saveindex () { #{{{
                next unless $oldpagemtime{$page};
                my $line="mtime=$oldpagemtime{$page} ".
                        "ctime=$pagectime{$page} ".
-                       "src=$pagesources{$page} ".
-                       "dest=$renderedfiles{$page}";
-               $line.=" link=$_" foreach @{$links{$page}};
+                       "src=$pagesources{$page}";
+               $line.=" dest=$_" foreach @{$renderedfiles{$page}};
+               my %count;
+               $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
                if (exists $depends{$page}) {
                        $line.=" depends=".encode_entities($depends{$page}, " \t\n");
                }
@@ -431,14 +623,17 @@ sub template_params (@) { #{{{
                        my $text_ref = shift;
                        $$text_ref=&Encode::decode_utf8($$text_ref);
                },
-               filename => "$config{templatedir}/$filename", @_;
+               filename => "$config{templatedir}/$filename",
+               loop_context_vars => 1,
+               die_on_bad_params => 0,
+               @_;
 } #}}}
 
 sub template ($;@) { #{{{
        HTML::Template->new(template_params(@_));
 } #}}}
 
-sub misctemplate ($$) { #{{{
+sub misctemplate ($$;@) { #{{{
        my $title=shift;
        my $pagebody=shift;
        
@@ -448,9 +643,12 @@ sub misctemplate ($$) { #{{{
                indexlink => indexlink(),
                wikiname => $config{wikiname},
                pagebody => $pagebody,
-               styleurl => styleurl(),
-               baseurl => "$config{url}/",
+               baseurl => baseurl(),
+               @_,
        );
+       run_hooks(pagetemplate => sub {
+               shift->(page => "", destpage => "", template => $template);
+       });
        return $template->output;
 }#}}}
 
@@ -460,6 +658,8 @@ sub hook (@) { # {{{
        if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
                error "hook requires type, call, and id parameters";
        }
+
+       return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
        
        $hooks{$param{type}}{$param{id}}=\%param;
 } # }}}
@@ -471,7 +671,15 @@ sub run_hooks ($$) { # {{{
        my $sub=shift;
 
        if (exists $hooks{$type}) {
+               my @deferred;
                foreach my $id (keys %{$hooks{$type}}) {
+                       if ($hooks{$type}{$id}{last}) {
+                               push @deferred, $id;
+                               next;
+                       }
+                       $sub->($hooks{$type}{$id}{call});
+               }
+               foreach my $id (@deferred) {
                        $sub->($hooks{$type}{$id}{call});
                }
        }
@@ -518,6 +726,8 @@ sub pagespec_merge ($$) { #{{{
        my $a=shift;
        my $b=shift;
 
+       return $a if $a eq $b;
+
         # Support for old-style GlobLists.
         if (is_globlist($a)) {
                 $a=globlist_to_pagespec($a);
@@ -529,8 +739,9 @@ sub pagespec_merge ($$) { #{{{
        return "($a) or ($b)";
 } #}}}
 
-sub pagespec_match ($$) { #{{{
-       my $page=shift;
+sub pagespec_translate ($) { #{{{
+       # This assumes that $page is in scope in the function
+       # that evalulates the translated pagespec code.
        my $spec=shift;
 
        # Support for old-style GlobLists.
@@ -551,7 +762,7 @@ sub pagespec_match ($$) { #{{{
                elsif ($word eq "(" || $word eq ")" || $word eq "!") {
                        $code.=" ".$word;
                }
-               elsif ($word =~ /^(link|backlink|creation_month|creation_year|creation_day)\((.+)\)$/) {
+               elsif ($word =~ /^(link|backlink|created_before|created_after|creation_month|creation_year|creation_day)\((.+)\)$/) {
                        $code.=" match_$1(\$page, ".safequote($2).")";
                }
                else {
@@ -559,7 +770,36 @@ sub pagespec_match ($$) { #{{{
                }
        }
 
-       return eval $code;
+       return $code;
+} #}}}
+
+sub add_depends ($$) { #{{{
+       my $page=shift;
+       my $pagespec=shift;
+       
+       if (! exists $depends{$page}) {
+               $depends{$page}=$pagespec;
+       }
+       else {
+               $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
+       }
+} # }}}
+
+sub file_pruned ($$) { #{{{
+       require File::Spec;
+       my $file=File::Spec->canonpath(shift);
+       my $base=File::Spec->canonpath(shift);
+       $file=~s#^\Q$base\E/*##;
+
+       my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
+       $file =~ m/$regexp/;
+} #}}}
+
+sub pagespec_match ($$) { #{{{
+       my $page=shift;
+       my $spec=shift;
+
+       return eval pagespec_translate($spec);
 } #}}}
 
 sub match_glob ($$) { #{{{
@@ -571,12 +811,12 @@ sub match_glob ($$) { #{{{
        $glob=~s/\\\*/.*/g;
        $glob=~s/\\\?/./g;
 
-       return $page=~/^$glob$/;
+       return $page=~/^$glob$/i;
 } #}}}
 
 sub match_link ($$) { #{{{
        my $page=shift;
-       my $link=shift;
+       my $link=lc(shift);
 
        my $links = $links{$page} or return undef;
        foreach my $p (@$links) {
@@ -586,27 +826,43 @@ sub match_link ($$) { #{{{
 } #}}}
 
 sub match_backlink ($$) { #{{{
+       match_link(pop, pop);
+} #}}}
+
+sub match_created_before ($$) { #{{{
        my $page=shift;
-       my $linkto=shift;
+       my $testpage=shift;
 
-       my $links = $links{$linkto} or return undef;
-       foreach my $p (@$links) {
-               return 1 if lc $p eq $page;
+       if (exists $pagectime{$testpage}) {
+               return $pagectime{$page} < $pagectime{$testpage};
+       }
+       else {
+               return 0;
+       }
+} #}}}
+
+sub match_created_after ($$) { #{{{
+       my $page=shift;
+       my $testpage=shift;
+
+       if (exists $pagectime{$testpage}) {
+               return $pagectime{$page} > $pagectime{$testpage};
+       }
+       else {
+               return 0;
        }
-       return 0;
 } #}}}
 
 sub match_creation_day ($$) { #{{{
-       return if (localtime($pagectime{shift()}))[3] == shift;
+       return ((gmtime($pagectime{shift()}))[3] == shift);
 } #}}}
 
 sub match_creation_month ($$) { #{{{
-       return if (localtime($pagectime{shift()}))[4] + 1 == shift;
+       return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
 } #}}}
 
 sub match_creation_year ($$) { #{{{
-       return if (localtime($pagectime{shift()}))[5] + 1900 == shift;
+       return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);
 } #}}}
 
-
 1