merge to basewiki

[git.ikiwiki.info.git] / IkiWiki.pm

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 73bc747f9b443c6aee916b057b3f21c9d61c3c66..b605ac370ba6a84623887bf8e9087358ee40a0d5 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -9,12 +9,12 @@ use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
             %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
             %renderedfiles %oldrenderedfiles %pagesources %depends %hooks

-           %forcerebuild};
+           %forcerebuild $gettext_obj};

 
 use Exporter q{import};
 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
                  bestlink htmllink readfile writefile pagetype srcfile pagename
 
 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
+                 displaytime will_render gettext

                  %config %links %renderedfiles %pagesources);
 our $VERSION = 1.01; # plugin interface version
 
                  %config %links %renderedfiles %pagesources);
 our $VERSION = 1.01; # plugin interface version
 


@@ -22,26 +22,28 @@ our $VERSION = 1.01; # plugin interface version
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");

+memoize("file_pruned");

 
 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
 
 sub defaultconfig () { #{{{
 
 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/|\.\.|^\.|\/\.|\.x?html?$|\.rss$|\.atom$|.arch-ids/|{arch}/)},
+       wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/,
+               qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],

        wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
        wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
        wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\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,
        verbose => 0,
        syslog => 0,
        wikiname => "wiki",
        default_pageext => "mdwn",
        cgi => 0,

-       rcs => 'svn',
+       rcs => '',

        notify => 0,
        url => '',
        cgiurl => '',
        historyurl => '',
        diffurl => '',
        notify => 0,
        url => '',
        cgiurl => '',
        historyurl => '',
        diffurl => '',

-       anonok => 0,

        rss => 0,
        atom => 0,
        discussion => 1,
        rss => 0,
        atom => 0,
        discussion => 1,


@@ -53,6 +55,8 @@ sub defaultconfig () { #{{{
        wrappermode => undef,
        svnrepo => undef,
        svnpath => "trunk",
        wrappermode => undef,
        svnrepo => undef,
        svnpath => "trunk",

+       gitorigin_branch => "origin",
+       gitmaster_branch => "master",

        srcdir => undef,
        destdir => undef,
        pingurl => [],
        srcdir => undef,
        destdir => undef,
        pingurl => [],


@@ -61,11 +65,13 @@ sub defaultconfig () { #{{{
        setup => undef,
        adminuser => undef,
        adminemail => undef,
        setup => undef,
        adminuser => undef,
        adminemail => undef,

-       plugin => [qw{mdwn inline htmlscrubber}],
+       plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit
+                     lockedit conditional}],

        timeformat => '%c',
        locale => undef,
        sslcookie => 0,
        httpauth => 0,
        timeformat => '%c',
        locale => undef,
        sslcookie => 0,
        httpauth => 0,

+       userdir => "",

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


@@ -76,12 +82,16 @@ sub checkconfig () { #{{{
        }
        if (defined $config{locale}) {
                eval q{use POSIX};
        }
        if (defined $config{locale}) {
                eval q{use POSIX};

-               $ENV{LANG} = $config{locale}
-                       if POSIX::setlocale(&POSIX::LC_TIME, $config{locale});
+               error($@) if $@;
+               if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
+                       $ENV{LANG}=$config{locale};
+                       $gettext_obj=undef;
+               }

        }
 
        if ($config{w3mmode}) {
                eval q{use Cwd q{abs_path}};
        }
 
        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}
                $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}


@@ -90,10 +100,7 @@ sub checkconfig () { #{{{
        }
 
        if ($config{cgi} && ! length $config{url}) {
        }
 
        if ($config{cgi} && ! length $config{url}) {

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

        }
        
        $config{wikistatedir}="$config{srcdir}/.ikiwiki"
        }
        
        $config{wikistatedir}="$config{srcdir}/.ikiwiki"


@@ -113,13 +120,8 @@ sub checkconfig () { #{{{
 } #}}}
 
 sub loadplugins () { #{{{
 } #}}}
 
 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"
        run_hooks(getopt => sub { shift->() });
        if (grep /^-/, @ARGV) {
                print STDERR "Unknown option: $_\n"


@@ -128,10 +130,23 @@ sub loadplugins () { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+sub loadplugin ($) { #{{{
+       my $plugin=shift;
+
+       return if grep { $_ eq $plugin} @{$config{disable_plugins}};
+
+       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";
 sub error ($) { #{{{
        if ($config{cgi}) {
                print "Content-type: text/html\n\n";

-               print misctemplate("Error", "<p>Error: @_</p>");
+               print misctemplate(gettext("Error"),
+                       "<p>".gettext("Error").": @_</p>");

        }
        log_message(error => @_);
        exit(1);
        }
        log_message(error => @_);
        exit(1);


@@ -217,9 +232,10 @@ sub srcfile ($) { #{{{
        error("internal error: $file cannot be found");
 } #}}}
 
        error("internal error: $file cannot be found");
 } #}}}
 

-sub readfile ($;$) { #{{{
+sub readfile ($;$$) { #{{{

        my $file=shift;
        my $binary=shift;
        my $file=shift;
        my $binary=shift;

+       my $wantfd=shift;

 
        if (-l $file) {
                error("cannot read a symlink ($file)");
 
        if (-l $file) {
                error("cannot read a symlink ($file)");


@@ -228,16 +244,18 @@ sub readfile ($;$) { #{{{
        local $/=undef;
        open (IN, $file) || error("failed to read $file: $!");
        binmode(IN) if ($binary);
        local $/=undef;
        open (IN, $file) || error("failed to read $file: $!");
        binmode(IN) if ($binary);

+       return \*IN if $wantfd;

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

-sub writefile ($$$;$) { #{{{
+sub writefile ($$$;$$) { #{{{

        my $file=shift; # can include subdirs
        my $destdir=shift; # directory to put file in
        my $content=shift;
        my $binary=shift;
        my $file=shift; # can include subdirs
        my $destdir=shift; # directory to put file in
        my $content=shift;
        my $binary=shift;

+       my $wantfd=shift;

        
        my $test=$file;
        while (length $test) {
        
        my $test=$file;
        while (length $test) {


@@ -260,6 +278,7 @@ sub writefile ($$$;$) { #{{{
        
        open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
        binmode(OUT) if ($binary);
        
        open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
        binmode(OUT) if ($binary);

+       return \*OUT if $wantfd;

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


@@ -290,6 +309,11 @@ sub bestlink ($$) { #{{{
        my $link=shift;
        
        my $cwd=$page;
        my $link=shift;
        
        my $cwd=$page;

+       if ($link=~s/^\/+//) {
+               # absolute links
+               $cwd="";
+       }
+

        do {
                my $l=$cwd;
                $l.="/" if length $l;
        do {
                my $l=$cwd;
                $l.="/" if length $l;


@@ -303,6 +327,10 @@ sub bestlink ($$) { #{{{
                }
        } while $cwd=~s!/?[^/]+$!!;
 
                }
        } while $cwd=~s!/?[^/]+$!!;
 

+       if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
+               return "$config{userdir}/".lc($link);
+       }
+

        #print STDERR "warning: page $page, broken link: $link\n";
        return "";
 } #}}}
        #print STDERR "warning: page $page, broken link: $link\n";
        return "";
 } #}}}


@@ -313,10 +341,18 @@ sub isinlinableimage ($) { #{{{
        $file=~/\.(png|gif|jpg|jpeg)$/i;
 } #}}}
 
        $file=~/\.(png|gif|jpg|jpeg)$/i;
 } #}}}
 

-sub pagetitle ($) { #{{{
+sub pagetitle ($;$) { #{{{

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

-       $page=~s/__(\d+)__/&#$1;/g;
+       my $unescaped=shift;
+
+       if ($unescaped) {
+               $page=~s/__(\d+)__/chr($1)/eg;
+       }
+       else {
+               $page=~s/__(\d+)__/&#$1;/g;
+       }

        $page=~y/_/ /;
        $page=~y/_/ /;

+

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


@@ -346,7 +382,7 @@ sub baseurl (;$) { #{{{
 sub abs2rel ($$) { #{{{
        # Work around very innefficient behavior in File::Spec if abs2rel
        # is passed two relative paths. It's much faster if paths are
 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! (Debian bug #376658)
+       # absolute! (Debian bug #376658; fixed in debian unstable now)

        my $path="/".shift;
        my $base="/".shift;
 
        my $path="/".shift;
        my $base="/".shift;
 


@@ -360,6 +396,7 @@ sub displaytime ($) { #{{{
        my $time=shift;
 
        eval q{use POSIX};
        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(
        # strftime doesn't know about encodings, so make sure
        # its output is properly treated as utf8
        return decode_utf8(POSIX::strftime(


@@ -387,13 +424,11 @@ sub htmllink ($$$;$$$) { #{{{
        return "<span class=\"selflink\">$linktext</span>"
                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 } map { @{$_} } values %renderedfiles) {
                $bestlink=htmlpage($bestlink);
        }
        if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
        if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
                $bestlink=htmlpage($bestlink);
        }
        if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {

+               return $linktext unless length $config{cgiurl};

                return "<span><a href=\"".
                        cgiurl(do => "create", page => lc($link), from => $page).
                        "\">?</a>$linktext</span>"
                return "<span><a href=\"".
                        cgiurl(do => "create", page => lc($link), from => $page).
                        "\">?</a>$linktext</span>"


@@ -490,7 +525,13 @@ sub preprocess ($$$;$) { #{{{
                        if ($preprocessing{$page}++ > 3) {
                                # Avoid loops of preprocessed pages preprocessing
                                # other pages that preprocess them, etc.
                        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}]]";
+                               #translators: The first parameter is a
+                               #translators: preprocessor directive name,
+                               #translators: the second a page name, the
+                               #translators: third a number.
+                               return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
+                                       $command, $page, $preprocessing{$page}).
+                               "]]";

                        }
                        my $ret=$hooks{preprocess}{$command}{call}->(
                                @params,
                        }
                        my $ret=$hooks{preprocess}{$command}{call}->(
                                @params,


@@ -603,18 +644,35 @@ sub saveindex () { #{{{
        close OUT;
 } #}}}
 
        close OUT;
 } #}}}
 

+sub template_file ($) { #{{{
+       my $template=shift;
+
+       foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
+               return "$dir/$template" if -e "$dir/$template";
+       }
+       return undef;
+} #}}}
+

 sub template_params (@) { #{{{
 sub template_params (@) { #{{{

-       my $filename=shift;
-       
+       my $filename=template_file(shift);
+
+       if (! defined $filename) {
+               return if wantarray;
+               return "";
+       }
+

        require HTML::Template;
        require HTML::Template;

-       return filter => sub {
+       my @ret=(
+               filter => sub {

                        my $text_ref = shift;
                        $$text_ref=&Encode::decode_utf8($$text_ref);
                },
                        my $text_ref = shift;
                        $$text_ref=&Encode::decode_utf8($$text_ref);
                },

-               filename => "$config{templatedir}/$filename",
+               filename => $filename,

                loop_context_vars => 1,
                die_on_bad_params => 0,
                loop_context_vars => 1,
                die_on_bad_params => 0,

-               @_;
+               @_
+       );
+       return wantarray ? @ret : {@ret};

 } #}}}
 
 sub template ($;@) { #{{{
 } #}}}
 
 sub template ($;@) { #{{{


@@ -659,7 +717,15 @@ sub run_hooks ($$) { # {{{
        my $sub=shift;
 
        if (exists $hooks{$type}) {
        my $sub=shift;
 
        if (exists $hooks{$type}) {

+               my @deferred;

                foreach my $id (keys %{$hooks{$type}}) {
                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});
                }
        }
                        $sub->($hooks{$type}{$id}{call});
                }
        }


@@ -702,6 +768,49 @@ sub safequote ($) { #{{{
        return "q{$s}";
 } #}}}
 
        return "q{$s}";
 } #}}}
 

+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 gettext { #{{{
+       # Only use gettext in the rare cases it's needed.
+       if (exists $ENV{LANG} || exists $ENV{LC_ALL} || exists $ENV{LC_MESSAGES}) {
+               if (! $gettext_obj) {
+                       $gettext_obj=eval q{
+                               use Locale::gettext q{textdomain};
+                               Locale::gettext->domain('ikiwiki')
+                       };
+                       if ($@) {
+                               print STDERR "$@";
+                               $gettext_obj=undef;
+                               return shift;
+                       }
+               }
+               return $gettext_obj->get(shift);
+       }
+       else {
+               return shift;
+       }
+} #}}}
+

 sub pagespec_merge ($$) { #{{{
        my $a=shift;
        my $b=shift;
 sub pagespec_merge ($$) { #{{{
        my $a=shift;
        my $b=shift;


@@ -742,39 +851,46 @@ sub pagespec_translate ($) { #{{{
                elsif ($word eq "(" || $word eq ")" || $word eq "!") {
                        $code.=" ".$word;
                }
                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).")";
+               elsif ($word =~ /^(\w+)\((.*)\)$/) {
+                       if (exists $IkiWiki::PageSpec::{"match_$1"}) {
+                               $code.=" IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).")";
+                       }
+                       else {
+                               $code.=" 0";
+                       }

                }
                else {
                }
                else {

-                       $code.=" match_glob(\$page, ".safequote($word).")";
+                       $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)";

                }
        }
 
        return $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 pagespec_match ($$) { #{{{
+sub pagespec_match ($$;$) { #{{{

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

+       my $from=shift;

 
        return eval pagespec_translate($spec);
 } #}}}
 
 
        return eval pagespec_translate($spec);
 } #}}}
 

-sub match_glob ($$) { #{{{
+package IkiWiki::PageSpec;
+
+sub match_glob ($$$) { #{{{

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

+       my $from=shift;
+       if (! defined $from){
+               $from = "";
+       }
+
+       # relative matching
+       if ($glob =~ m!^\./!) {
+               $from=~s!/?[^/]+$!!;
+               $glob=~s!^\./!!;
+               $glob="$from/$glob" if length $from;
+       }

 
        # turn glob into safe regexp
        $glob=quotemeta($glob);
 
        # turn glob into safe regexp
        $glob=quotemeta($glob);


@@ -788,7 +904,7 @@ sub match_link ($$) { #{{{
        my $page=shift;
        my $link=lc(shift);
 
        my $page=shift;
        my $link=lc(shift);
 

-       my $links = $links{$page} or return undef;
+       my $links = $IkiWiki::links{$page} or return undef;

        foreach my $p (@$links) {
                return 1 if lc $p eq $link;
        }
        foreach my $p (@$links) {
                return 1 if lc $p eq $link;
        }


@@ -803,8 +919,8 @@ sub match_created_before ($$) { #{{{
        my $page=shift;
        my $testpage=shift;
 
        my $page=shift;
        my $testpage=shift;
 

-       if (exists $pagectime{$testpage}) {
-               return $pagectime{$page} < $pagectime{$testpage};
+       if (exists $IkiWiki::pagectime{$testpage}) {
+               return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage};

        }
        else {
                return 0;
        }
        else {
                return 0;


@@ -815,8 +931,8 @@ sub match_created_after ($$) { #{{{
        my $page=shift;
        my $testpage=shift;
 
        my $page=shift;
        my $testpage=shift;
 

-       if (exists $pagectime{$testpage}) {
-               return $pagectime{$page} > $pagectime{$testpage};
+       if (exists $IkiWiki::pagectime{$testpage}) {
+               return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage};

        }
        else {
                return 0;
        }
        else {
                return 0;


@@ -824,15 +940,15 @@ sub match_created_after ($$) { #{{{
 } #}}}
 
 sub match_creation_day ($$) { #{{{
 } #}}}
 
 sub match_creation_day ($$) { #{{{

-       return ((gmtime($pagectime{shift()}))[3] == shift);
+       return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);

 } #}}}
 
 sub match_creation_month ($$) { #{{{
 } #}}}
 
 sub match_creation_month ($$) { #{{{

-       return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
+       return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);

 } #}}}
 
 sub match_creation_year ($$) { #{{{
 } #}}}
 
 sub match_creation_year ($$) { #{{{

-       return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);
+       return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);

 } #}}}
 
 1
 } #}}}
 
 1