Corrected a fuzzy. Changed some error message translation to use ": %s"

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

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 1cbe975c058cc7a455dc4127067d1bf943776651..8f7d8d20b4f22381e18cb556249a64ccb3887b8b 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -8,30 +8,37 @@ use HTML::Entities;
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase

-            %renderedfiles %pagesources %depends %hooks %forcerebuild};
+            %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
 
 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 gettext

                  %config %links %renderedfiles %pagesources);
                  %config %links %renderedfiles %pagesources);

+our $VERSION = 1.01; # plugin interface version

 
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");
 
 # Optimisation.
 use Memoize;
 memoize("abs2rel");
 memoize("pagespec_translate");

+memoize("file_pruned");

 
 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
 
 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE

+our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE

 
 sub defaultconfig () { #{{{
 
 sub defaultconfig () { #{{{

-       wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?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_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 => '',
        notify => 0,
        url => '',
        cgiurl => '',


@@ -39,6 +46,7 @@ sub defaultconfig () { #{{{
        diffurl => '',
        anonok => 0,
        rss => 0,
        diffurl => '',
        anonok => 0,
        rss => 0,

+       atom => 0,

        discussion => 1,
        rebuild => 0,
        refresh => 0,
        discussion => 1,
        rebuild => 0,
        refresh => 0,


@@ -56,10 +64,12 @@ 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}],

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

+       httpauth => 0,
+       userdir => "",

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


@@ -70,12 +80,14 @@ sub checkconfig () { #{{{
        }
        if (defined $config{locale}) {
                eval q{use POSIX};
        }
        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}};
                $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}
                $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}


@@ -84,10 +96,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} && ! length $config{url}) {
-               error("Must specify url to wiki with --url when using --rss\n");
+               error(gettext("Must specify url to wiki with --url when using --cgi"));

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


@@ -107,13 +116,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"


@@ -122,10 +126,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);


@@ -258,11 +275,37 @@ sub writefile ($$$;$) { #{{{
        close OUT;
 } #}}}
 
        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 ($$) { #{{{
        my $page=shift;
        my $link=shift;
        
        my $cwd=$page;
 sub bestlink ($$) { #{{{
        my $page=shift;
        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;


@@ -276,6 +319,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 "";
 } #}}}


@@ -286,10 +333,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;
 } #}}}
 


@@ -319,7 +374,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!
+       # absolute! (Debian bug #376658; fixed in debian unstable now)

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


@@ -333,6 +388,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(


@@ -360,13 +416,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 } values %renderedfiles) {
+       if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {

                $bestlink=htmlpage($bestlink);
        }
                $bestlink=htmlpage($bestlink);
        }

-       if (! grep { $_ eq $bestlink } values %renderedfiles) {
+       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>"


@@ -419,10 +473,11 @@ sub linkify ($$$) { #{{{
 } #}}}
 
 my %preprocessing;
 } #}}}
 
 my %preprocessing;

-sub preprocess ($$$) { #{{{
+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 $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 $handle=sub {
                my $escape=shift;


@@ -432,6 +487,7 @@ sub preprocess ($$$) { #{{{
                        return "[[$command $params]]";
                }
                elsif (exists $hooks{preprocess}{$command}) {
                        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;
                        # Note: preserve order of params, some plugins may
                        # consider it significant.
                        my @params;


@@ -461,7 +517,9 @@ 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}]]";
+                               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,


@@ -480,7 +538,7 @@ sub preprocess ($$$) { #{{{
        return $content;
 } #}}}
 
        return $content;
 } #}}}
 

-sub filter ($$) {
+sub filter ($$) { #{{{

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


@@ -489,7 +547,7 @@ sub filter ($$) {
        });
 
        return $content;
        });
 
        return $content;

-}
+} #}}}

 
 sub indexlink () { #{{{
        return "<a href=\"$config{url}\">$config{wikiname}</a>";
 
 sub indexlink () { #{{{
        return "<a href=\"$config{url}\">$config{wikiname}</a>";


@@ -526,6 +584,7 @@ sub loadindex () { #{{{
                chomp;
                my %items;
                $items{link}=[];
                chomp;
                my %items;
                $items{link}=[];

+               $items{dest}=[];

                foreach my $i (split(/ /, $_)) {
                        my ($item, $val)=split(/=/, $i, 2);
                        push @{$items{$item}}, decode_entities($val);
                foreach my $i (split(/ /, $_)) {
                        my ($item, $val)=split(/=/, $i, 2);
                        push @{$items{$item}}, decode_entities($val);


@@ -540,7 +599,8 @@ sub loadindex () { #{{{
                        $oldlinks{$page}=[@{$items{link}}];
                        $links{$page}=[@{$items{link}}];
                        $depends{$page}=$items{depends}[0] if exists $items{depends};
                        $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];
                        $pagecase{lc $page}=$page;
                }
                $pagectime{$page}=$items{ctime}[0];


@@ -560,9 +620,10 @@ sub saveindex () { #{{{
                next unless $oldpagemtime{$page};
                my $line="mtime=$oldpagemtime{$page} ".
                        "ctime=$pagectime{$page} ".
                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");
                }
                if (exists $depends{$page}) {
                        $line.=" depends=".encode_entities($depends{$page}, " \t\n");
                }


@@ -589,7 +650,7 @@ sub template ($;@) { #{{{
        HTML::Template->new(template_params(@_));
 } #}}}
 
        HTML::Template->new(template_params(@_));
 } #}}}
 

-sub misctemplate ($$) { #{{{
+sub misctemplate ($$;@) { #{{{

        my $title=shift;
        my $pagebody=shift;
        
        my $title=shift;
        my $pagebody=shift;
        


@@ -599,8 +660,12 @@ sub misctemplate ($$) { #{{{
                indexlink => indexlink(),
                wikiname => $config{wikiname},
                pagebody => $pagebody,
                indexlink => indexlink(),
                wikiname => $config{wikiname},
                pagebody => $pagebody,

-       baseurl => baseurl(),
+               baseurl => baseurl(),
+               @_,

        );
        );

+       run_hooks(pagetemplate => sub {
+               shift->(page => "", destpage => "", template => $template);
+       });

        return $template->output;
 }#}}}
 
        return $template->output;
 }#}}}
 


@@ -610,6 +675,8 @@ sub hook (@) { # {{{
        if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
                error "hook requires type, call, and id parameters";
        }
        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;
 } # }}}
        
        $hooks{$param{type}}{$param{id}}=\%param;
 } # }}}


@@ -621,7 +688,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});
                }
        }


@@ -727,6 +802,29 @@ sub add_depends ($$) { #{{{
        }
 } # }}}
 
        }
 } # }}}
 

+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.
+       # This overrides future calls of this function.
+       if (exists $ENV{LANG} || exists $ENV{LC_ALL} || exists $ENV{LC_MESSAGES}) {
+               eval q{use Locale::gettext};
+               textdomain('ikiwiki');
+               return Locale::gettext::gettext(shift);
+       }
+       else {
+               return shift;
+       }
+} #}}}
+

 sub pagespec_match ($$) { #{{{
        my $page=shift;
        my $spec=shift;
 sub pagespec_match ($$) { #{{{
        my $page=shift;
        my $spec=shift;