]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki.pm
force charset
[git.ikiwiki.info.git] / IkiWiki.pm
index d369d7da839589f3d440a47e083a241e3cf45389..990836f8e461226442933064d2d62defb457e27d 100644 (file)
@@ -4,21 +4,25 @@ package IkiWiki;
 use warnings;
 use strict;
 use Encode;
+use HTML::Entities;
 use open qw{:utf8 :std};
 
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
+memoize("pagespec_translate");
 
-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
-            %renderedfiles %pagesources %depends %hooks};
+use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
+            %renderedfiles %pagesources %depends %hooks %forcerebuild};
+
+my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 
 sub defaultconfig () { #{{{
-       wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
+       wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?html?$|\.rss$)},
        wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
-       wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
        verbose => 0,
+       syslog => 0,
        wikiname => "wiki",
        default_pageext => "mdwn",
        cgi => 0,
@@ -42,14 +46,15 @@ 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}],
        timeformat => '%c',
        locale => undef,
+       sslcookie => 0,
 } #}}}
    
 sub checkconfig () { #{{{
@@ -93,11 +98,7 @@ sub checkconfig () { #{{{
                require IkiWiki::Rcs::Stub;
        }
 
-       if (exists $hooks{checkconfig}) {
-                foreach my $id (keys %{$hooks{checkconfig}}) {
-                        $hooks{checkconfig}{$id}{call}->();
-                }
-        }
+       run_hooks(checkconfig => sub { shift->() });
 } #}}}
 
 sub loadplugins () { #{{{
@@ -108,6 +109,12 @@ sub loadplugins () { #{{{
                        error("Failed to load plugin $mod: $@");
                }
        }
+       run_hooks(getopt => sub { shift->() });
+       if (grep /^-/, @ARGV) {
+               print STDERR "Unknown option: $_\n"
+                       foreach grep /^-/, @ARGV;
+               usage();
+       }
 } #}}}
 
 sub error ($) { #{{{
@@ -115,12 +122,31 @@ sub error ($) { #{{{
                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 {
@@ -234,7 +260,7 @@ sub bestlink ($$) { #{{{
        # 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;
        do {
@@ -243,9 +269,11 @@ sub bestlink ($$) { #{{{
                $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";
@@ -278,17 +306,17 @@ 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 ($$) {
+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!
@@ -299,7 +327,7 @@ sub abs2rel ($$) {
        my $ret=File::Spec->abs2rel($path, $base);
        $ret=~s/^// if defined $ret;
        return $ret;
-}
+} #}}}
 
 sub htmllink ($$$;$$$) { #{{{
        my $lpage=shift; # the page doing the linking
@@ -319,7 +347,8 @@ 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
@@ -329,7 +358,7 @@ sub htmllink ($$$;$$$) { #{{{
        }
        if (! grep { $_ eq $bestlink } values %renderedfiles) {
                return "<span><a href=\"".
-                       cgiurl(do => "create", page => $link, from => $page).
+                       cgiurl(do => "create", page => lc($link), from => $page).
                        "\">?</a>$linktext</span>"
        }
        
@@ -378,7 +407,7 @@ sub loadindex () { #{{{
                $items{link}=[];
                foreach my $i (split(/ /, $_)) {
                        my ($item, $val)=split(/=/, $i, 2);
-                       push @{$items{$item}}, $val;
+                       push @{$items{$item}}, decode_entities($val);
                }
 
                next unless exists $items{src}; # skip bad lines for now
@@ -389,9 +418,9 @@ sub loadindex () { #{{{
                        $oldpagemtime{$page}=$items{mtime}[0];
                        $oldlinks{$page}=[@{$items{link}}];
                        $links{$page}=[@{$items{link}}];
-                       $depends{$page}=join(" ", @{$items{depends}})
-                               if exists $items{depends};
+                       $depends{$page}=$items{depends}[0] if exists $items{depends};
                        $renderedfiles{$page}=$items{dest}[0];
+                       $pagecase{lc $page}=$page;
                }
                $pagectime{$page}=$items{ctime}[0];
        }
@@ -399,6 +428,8 @@ sub loadindex () { #{{{
 } #}}}
 
 sub saveindex () { #{{{
+       run_hooks(savestate => sub { shift->() });
+
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }
@@ -412,7 +443,7 @@ sub saveindex () { #{{{
                        "dest=$renderedfiles{$page}";
                $line.=" link=$_" foreach @{$links{$page}};
                if (exists $depends{$page}) {
-                       $line.=" depends=$_" foreach split " ", $depends{$page};
+                       $line.=" depends=".encode_entities($depends{$page}, " \t\n");
                }
                print OUT $line."\n";
        }
@@ -427,7 +458,10 @@ 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 ($;@) { #{{{
@@ -444,63 +478,190 @@ sub misctemplate ($$) { #{{{
                indexlink => indexlink(),
                wikiname => $config{wikiname},
                pagebody => $pagebody,
-               styleurl => styleurl(),
-               baseurl => "$config{url}/",
+               baseurl => baseurl(),
        );
        return $template->output;
 }#}}}
 
-sub glob_match ($$) { #{{{
-       my $page=shift;
-       my $glob=shift;
+sub hook (@) { # {{{
+       my %param=@_;
+       
+       if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
+               error "hook requires type, call, and id parameters";
+       }
+       
+       $hooks{$param{type}}{$param{id}}=\%param;
+} # }}}
 
-       if ($glob =~ /^link\((.+)\)$/) {
-               my $rev = $links{$page} or return undef;
-               foreach my $p (@$rev) {
-                       return 1 if lc $p eq $1;
-               }
-               return 0;
-       } elsif ($glob =~ /^backlink\((.+)\)$/) {
-               my $rev = $links{$1} or return undef;
-               foreach my $p (@$rev) {
-                       return 1 if lc $p eq $page;
+sub run_hooks ($$) { # {{{
+       # Calls the given sub for each hook of the given type,
+       # passing it the hook function to call.
+       my $type=shift;
+       my $sub=shift;
+
+       if (exists $hooks{$type}) {
+               foreach my $id (keys %{$hooks{$type}}) {
+                       $sub->($hooks{$type}{$id}{call});
                }
-               return 0;
-       } else {
-               # turn glob into safe regexp
-               $glob=quotemeta($glob);
-               $glob=~s/\\\*/.*/g;
-               $glob=~s/\\\?/./g;
-               $glob=~s!\\/!/!g;
-               
-               return $page=~/^$glob$/i;
        }
 } #}}}
 
-sub globlist_match ($$) { #{{{
-       my $page=shift;
-       my @globlist=split(" ", shift);
+sub globlist_to_pagespec ($) { #{{{
+       my @globlist=split(' ', shift);
 
-       # check any negated globs first
+       my (@spec, @skip);
        foreach my $glob (@globlist) {
-               return 0 if $glob=~/^!(.*)/ && glob_match($page, $1);
+               if ($glob=~/^!(.*)/) {
+                       push @skip, $glob;
+               }
+               else {
+                       push @spec, $glob;
+               }
        }
 
-       foreach my $glob (@globlist) {
-               return 1 if glob_match($page, $glob);
+       my $spec=join(" or ", @spec);
+       if (@skip) {
+               my $skip=join(" and ", @skip);
+               if (length $spec) {
+                       $spec="$skip and ($spec)";
+               }
+               else {
+                       $spec=$skip;
+               }
+       }
+       return $spec;
+} #}}}
+
+sub is_globlist ($) { #{{{
+       my $s=shift;
+       $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
+} #}}}
+
+sub safequote ($) { #{{{
+       my $s=shift;
+       $s=~s/[{}]//g;
+       return "q{$s}";
+} #}}}
+
+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);
+        }
+        if (is_globlist($b)) {
+                $b=globlist_to_pagespec($b);
+        }
+
+       return "($a) or ($b)";
+} #}}}
+
+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.
+       if (is_globlist($spec)) {
+               $spec=globlist_to_pagespec($spec);
+       }
+
+       # Convert spec to perl code.
+       my $code="";
+       while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
+               my $word=$1;
+               if (lc $word eq "and") {
+                       $code.=" &&";
+               }
+               elsif (lc $word eq "or") {
+                       $code.=" ||";
+               }
+               elsif ($word eq "(" || $word eq ")" || $word eq "!") {
+                       $code.=" ".$word;
+               }
+               elsif ($word =~ /^(link|backlink|created_before|created_after|creation_month|creation_year|creation_day)\((.+)\)$/) {
+                       $code.=" match_$1(\$page, ".safequote($2).")";
+               }
+               else {
+                       $code.=" match_glob(\$page, ".safequote($word).")";
+               }
+       }
+
+       return $code;
+} #}}}
+
+sub pagespec_match ($$) { #{{{
+       my $page=shift;
+       my $spec=shift;
+
+       return eval pagespec_translate($spec);
+} #}}}
+
+sub match_glob ($$) { #{{{
+       my $page=shift;
+       my $glob=shift;
+
+       # turn glob into safe regexp
+       $glob=quotemeta($glob);
+       $glob=~s/\\\*/.*/g;
+       $glob=~s/\\\?/./g;
+
+       return $page=~/^$glob$/i;
+} #}}}
+
+sub match_link ($$) { #{{{
+       my $page=shift;
+       my $link=lc(shift);
+
+       my $links = $links{$page} or return undef;
+       foreach my $p (@$links) {
+               return 1 if lc $p eq $link;
        }
-       
        return 0;
 } #}}}
 
-sub hook (@) { # {{{
-       my %param=@_;
-       
-       if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
-               error "hook requires type, call, and id parameters";
+sub match_backlink ($$) { #{{{
+       match_link(pop, pop);
+} #}}}
+
+sub match_created_before ($$) { #{{{
+       my $page=shift;
+       my $testpage=shift;
+
+       if (exists $pagectime{$testpage}) {
+               return $pagectime{$page} < $pagectime{$testpage};
        }
-       
-       $hooks{$param{type}}{$param{id}}=\%param;
-} # }}}
+       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;
+       }
+} #}}}
+
+sub match_creation_day ($$) { #{{{
+       return ((gmtime($pagectime{shift()}))[3] == shift);
+} #}}}
+
+sub match_creation_month ($$) { #{{{
+       return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
+} #}}}
+
+sub match_creation_year ($$) { #{{{
+       return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);
+} #}}}
 
 1