backlink is just the reverse of link, so..

[ikiwiki.git] / IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 76472302e12a9bce6c3989e90969399184a9cafd..cadbfd67f676114309845ef568783384fa057360 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -3,11 +3,16 @@
 package IkiWiki;
 use warnings;
 use strict;
 package IkiWiki;
 use warnings;
 use strict;

-use File::Spec;
-use HTML::Template;
+use Encode;
+use HTML::Entities;
+use open qw{:utf8 :std};
+
+# Optimisation.
+use Memoize;
+memoize("abs2rel");

 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime

-            %renderedfiles %pagesources %depends %hooks};
+            %renderedfiles %pagesources %depends %hooks %forcerebuild};

 
 sub defaultconfig () { #{{{
        wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
 
 sub defaultconfig () { #{{{
        wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},


@@ -16,7 +21,7 @@ sub defaultconfig () { #{{{
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
        verbose => 0,
        wikiname => "wiki",
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
        verbose => 0,
        wikiname => "wiki",

-       default_pageext => ".mdwn",
+       default_pageext => "mdwn",

        cgi => 0,
        rcs => 'svn',
        notify => 0,
        cgi => 0,
        rcs => 'svn',
        notify => 0,


@@ -30,22 +35,45 @@ sub defaultconfig () { #{{{
        rebuild => 0,
        refresh => 0,
        getctime => 0,
        rebuild => 0,
        refresh => 0,
        getctime => 0,

+       w3mmode => 0,

        wrapper => undef,
        wrappermode => undef,
        svnrepo => undef,
        svnpath => "trunk",
        srcdir => undef,
        destdir => undef,
        wrapper => undef,
        wrappermode => undef,
        svnrepo => undef,
        svnpath => "trunk",
        srcdir => undef,
        destdir => undef,

+       pingurl => [],

        templatedir => "/usr/share/ikiwiki/templates",
        underlaydir => "/usr/share/ikiwiki/basewiki",
        setup => undef,
        adminuser => undef,
        adminemail => undef,
        templatedir => "/usr/share/ikiwiki/templates",
        underlaydir => "/usr/share/ikiwiki/basewiki",
        setup => undef,
        adminuser => undef,
        adminemail => undef,

-       plugin => [qw{inline htmlscrubber}],
+       plugin => [qw{mdwn inline htmlscrubber}],

        timeformat => '%c',
        timeformat => '%c',

+       locale => undef,

 } #}}}
 } #}}}

-           
+   

 sub checkconfig () { #{{{
 sub checkconfig () { #{{{

+       # locale stuff; avoid LC_ALL since it overrides everything
+       if (defined $ENV{LC_ALL}) {
+               $ENV{LANG} = $ENV{LC_ALL};
+               delete $ENV{LC_ALL};
+       }
+       if (defined $config{locale}) {
+               eval q{use POSIX};
+               $ENV{LANG} = $config{locale}
+                       if POSIX::setlocale(&POSIX::LC_TIME, $config{locale});
+       }
+
+       if ($config{w3mmode}) {
+               eval q{use Cwd q{abs_path}};
+               $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}
+                       unless $config{cgiurl} =~ m!file:///!;
+               $config{url}="file://".$config{destdir};
+       }
+

        if ($config{cgi} && ! length $config{url}) {
                error("Must specify url to wiki with --url when using --cgi\n");
        }
        if ($config{cgi} && ! length $config{url}) {
                error("Must specify url to wiki with --url when using --cgi\n");
        }


@@ -66,6 +94,10 @@ sub checkconfig () { #{{{
                require IkiWiki::Rcs::Stub;
        }
 
                require IkiWiki::Rcs::Stub;
        }
 

+       run_hooks(checkconfig => sub { shift->() });
+} #}}}
+
+sub loadplugins () { #{{{

        foreach my $plugin (@{$config{plugin}}) {
                my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
                eval qq{use $mod};
        foreach my $plugin (@{$config{plugin}}) {
                my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
                eval qq{use $mod};


@@ -73,12 +105,12 @@ sub checkconfig () { #{{{
                        error("Failed to load plugin $mod: $@");
                }
        }
                        error("Failed to load plugin $mod: $@");
                }
        }

-
-       if (exists $hooks{checkconfig}) {
-                foreach my $id (keys %{$hooks{checkconfig}}) {
-                        $hooks{checkconfig}{$id}{call}->();
-                }
-        }
+       run_hooks(getopt => sub { shift->() });
+       if (grep /^-/, @ARGV) {
+               print STDERR "Unknown option: $_\n"
+                       foreach grep /^-/, @ARGV;
+               usage();
+       }

 } #}}}
 
 sub error ($) { #{{{
 } #}}}
 
 sub error ($) { #{{{


@@ -122,12 +154,10 @@ sub dirname ($) { #{{{
 sub pagetype ($) { #{{{
        my $page=shift;
        
 sub pagetype ($) { #{{{
        my $page=shift;
        

-       if ($page =~ /\.mdwn$/) {
-               return ".mdwn";
-       }
-       else {
-               return "unknown";
+       if ($page =~ /\.([^.]+)$/) {
+               return $1 if exists $hooks{htmlize}{$1};

        }
        }

+       return undef;

 } #}}}
 
 sub pagename ($) { #{{{
 } #}}}
 
 sub pagename ($) { #{{{


@@ -135,7 +165,7 @@ sub pagename ($) { #{{{
 
        my $type=pagetype($file);
        my $page=$file;
 
        my $type=pagetype($file);
        my $page=$file;

-       $page=~s/\Q$type\E*$// unless $type eq 'unknown';
+       $page=~s/\Q.$type\E*$// if defined $type;

        return $page;
 } #}}}
 
        return $page;
 } #}}}
 


@@ -163,12 +193,7 @@ sub readfile ($;$) { #{{{
        
        local $/=undef;
        open (IN, $file) || error("failed to read $file: $!");
        
        local $/=undef;
        open (IN, $file) || error("failed to read $file: $!");

-       if (! $binary) {
-               binmode(IN, ":utf8");
-       }
-       else {
-               binmode(IN);
-       }
+       binmode(IN) if ($binary);

        my $ret=<IN>;
        close IN;
        return $ret;
        my $ret=<IN>;
        close IN;
        return $ret;


@@ -200,12 +225,7 @@ sub writefile ($$$;$) { #{{{
        }
        
        open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
        }
        
        open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");

-       if (! $binary) {
-               binmode(OUT, ":utf8");
-       }
-       else {
-               binmode(OUT);
-       }
+       binmode(OUT) if ($binary);

        print OUT $content;
        close OUT;
 } #}}}
        print OUT $content;
        close OUT;
 } #}}}


@@ -271,6 +291,19 @@ sub styleurl (;$) { #{{{
        return $page."style.css";
 } #}}}
 
        return $page."style.css";
 } #}}}
 

+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!
+       my $path="/".shift;
+       my $base="/".shift;
+
+       require File::Spec;
+       my $ret=File::Spec->abs2rel($path, $base);
+       $ret=~s/^// if defined $ret;
+       return $ret;
+} #}}}
+

 sub htmllink ($$$;$$$) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)
 sub htmllink ($$$;$$$) { #{{{
        my $lpage=shift; # the page doing the linking
        my $page=shift; # the page that will contain the link (different for inline)


@@ -303,7 +336,7 @@ sub htmllink ($$$;$$$) { #{{{
                        "\">?</a>$linktext</span>"
        }
        
                        "\">?</a>$linktext</span>"
        }
        

-       $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
+       $bestlink=abs2rel($bestlink, dirname($page));

        
        if (! $noimageinline && isinlinableimage($bestlink)) {
                return "<img src=\"$bestlink\" alt=\"$linktext\" />";
        
        if (! $noimageinline && isinlinableimage($bestlink)) {
                return "<img src=\"$bestlink\" alt=\"$linktext\" />";


@@ -348,7 +381,7 @@ sub loadindex () { #{{{
                $items{link}=[];
                foreach my $i (split(/ /, $_)) {
                        my ($item, $val)=split(/=/, $i, 2);
                $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
                }
 
                next unless exists $items{src}; # skip bad lines for now


@@ -359,8 +392,7 @@ sub loadindex () { #{{{
                        $oldpagemtime{$page}=$items{mtime}[0];
                        $oldlinks{$page}=[@{$items{link}}];
                        $links{$page}=[@{$items{link}}];
                        $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];
                }
                $pagectime{$page}=$items{ctime}[0];
                        $renderedfiles{$page}=$items{dest}[0];
                }
                $pagectime{$page}=$items{ctime}[0];


@@ -369,6 +401,8 @@ sub loadindex () { #{{{
 } #}}}
 
 sub saveindex () { #{{{
 } #}}}
 
 sub saveindex () { #{{{

+       run_hooks(savestate => sub { shift->() });
+

        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }


@@ -382,20 +416,33 @@ sub saveindex () { #{{{
                        "dest=$renderedfiles{$page}";
                $line.=" link=$_" foreach @{$links{$page}};
                if (exists $depends{$page}) {
                        "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";
        }
        close OUT;
 } #}}}
 
                }
                print OUT $line."\n";
        }
        close OUT;
 } #}}}
 

+sub template_params (@) { #{{{
+       my $filename=shift;
+       
+       require HTML::Template;
+       return filter => sub {
+                       my $text_ref = shift;
+                       $$text_ref=&Encode::decode_utf8($$text_ref);
+               },
+               filename => "$config{templatedir}/$filename", @_;
+} #}}}
+
+sub template ($;@) { #{{{
+       HTML::Template->new(template_params(@_));
+} #}}}
+

 sub misctemplate ($$) { #{{{
        my $title=shift;
        my $pagebody=shift;
        
 sub misctemplate ($$) { #{{{
        my $title=shift;
        my $pagebody=shift;
        

-       my $template=HTML::Template->new(
-               filename => "$config{templatedir}/misc.tmpl"
-       );
+       my $template=template("misc.tmpl");

        $template->param(
                title => $title,
                indexlink => indexlink(),
        $template->param(
                title => $title,
                indexlink => indexlink(),


@@ -407,57 +454,152 @@ sub misctemplate ($$) { #{{{
        return $template->output;
 }#}}}
 
        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;
+} # }}}
+
+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});
+               }
+       }
+} #}}}
+
+sub globlist_to_pagespec ($) { #{{{
+       my @globlist=split(' ', shift);
+
+       my (@spec, @skip);
+       foreach my $glob (@globlist) {
+               if ($glob=~/^!(.*)/) {
+                       push @skip, $glob;
+               }
+               else {
+                       push @spec, $glob;
+               }
+       }

 
 

-       if ($glob =~ /^link\((.+)\)$/) {
-               my $rev = $links{$page} or return undef;
-               foreach my $p (@$rev) {
-                       return 1 if lc $p eq $1;
+       my $spec=join(" or ", @spec);
+       if (@skip) {
+               my $skip=join(" and ", @skip);
+               if (length $spec) {
+                       $spec="$skip and ($spec)";

                }
                }

-               return 0;
-       } elsif ($glob =~ /^backlink\((.+)\)$/) {
-               my $rev = $links{$1} or return undef;
-               foreach my $p (@$rev) {
-                       return 1 if lc $p eq $page;
+               else {
+                       $spec=$skip;

                }
                }

-               return 0;
-       } else {
-               # turn glob into safe regexp
-               $glob=quotemeta($glob);
-               $glob=~s/\\\*/.*/g;
-               $glob=~s/\\\?/./g;
-               $glob=~s!\\/!/!g;
-               
-               return $page=~/^$glob$/i;

        }
        }

+       return $spec;
+} #}}}
+
+sub is_globlist ($) { #{{{
+       my $s=shift;
+       $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";

 } #}}}
 
 } #}}}
 

-sub globlist_match ($$) { #{{{
+sub safequote ($) { #{{{
+       my $s=shift;
+       $s=~s/[{}]//g;
+       return "q{$s}";
+} #}}}
+
+sub pagespec_merge ($$) { #{{{
+       my $a=shift;
+       my $b=shift;
+
+        # 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_match ($$) { #{{{

        my $page=shift;
        my $page=shift;

-       my @globlist=split(" ", shift);
+       my $spec=shift;

 
 

-       # check any negated globs first
-       foreach my $glob (@globlist) {
-               return 0 if $glob=~/^!(.*)/ && glob_match($page, $1);
+       # Support for old-style GlobLists.
+       if (is_globlist($spec)) {
+               $spec=globlist_to_pagespec($spec);

        }
 
        }
 

-       foreach my $glob (@globlist) {
-               return 1 if glob_match($page, $glob);
+       # 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|creation_month|creation_year|creation_day)\((.+)\)$/) {
+                       $code.=" match_$1(\$page, ".safequote($2).")";
+               }
+               else {
+                       $code.=" match_glob(\$page, ".safequote($word).")";
+               }

        }
        }

-       
-       return 0;
+
+       return eval $code;

 } #}}}
 
 } #}}}
 

-sub hook (@) { # {{{
-       my %param=@_;
-       
-       if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
-               error "hook requires type, call, and id parameters";
+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=shift;
+
+       my $links = $links{$page} or return undef;
+       foreach my $p (@$links) {
+               return 1 if lc $p eq $link;

        }
        }

-       
-       $hooks{$param{type}}{$param{id}}=\%param;
-} # }}}
+       return 0;
+} #}}}
+
+sub match_backlink ($$) { #{{{
+       match_link(reverse @_);
+} #}}}
+
+sub match_creation_day ($$) { #{{{
+       return if (gmtime($pagectime{shift()}))[3] == shift;
+} #}}}
+
+sub match_creation_month ($$) { #{{{
+       return if (gmtime($pagectime{shift()}))[4] + 1 == shift;
+} #}}}
+
+sub match_creation_year ($$) { #{{{
+       return if (gmtime($pagectime{shift()}))[5] + 1900 == shift;
+} #}}}
+

 
 1
 
 1