po plugin: todo update wrt. newly translatable pages

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

diff --git a/IkiWiki.pm b/IkiWiki.pm
index 207bf3079a2083ccf047837af6601168d938ada8..36e85d4135f146e321c5e07b4917444afcbc232e 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -12,16 +12,16 @@ use Storable;
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
 use open qw{:utf8 :std};
 
 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase

-           %pagestate %renderedfiles %oldrenderedfiles %pagesources
-           %destsources %depends %hooks %forcerebuild $gettext_obj
-           %loaded_plugins};
+           %pagestate %wikistate %renderedfiles %oldrenderedfiles
+           %pagesources %destsources %depends %hooks %forcerebuild
+           $gettext_obj %loaded_plugins};

 
 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 urlto targetpage
 
 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 urlto targetpage

-                add_underlay
-                 %config %links %pagestate %renderedfiles
+                add_underlay pagetitle titlepage linkpage newpagefile
+                 %config %links %pagestate %wikistate %renderedfiles

                  %pagesources %destsources);
 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
                  %pagesources %destsources);
 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE


@@ -121,7 +121,7 @@ sub getsetup () { #{{{
                type => "internal",
                default => [qw{mdwn link inline htmlscrubber passwordauth
                                openid signinedit lockedit conditional
                type => "internal",
                default => [qw{mdwn link inline htmlscrubber passwordauth
                                openid signinedit lockedit conditional

-                               recentchanges parentlinks}],
+                               recentchanges parentlinks editpage}],

                description => "plugins to enable by default",
                safe => 0,
                rebuild => 1,
                description => "plugins to enable by default",
                safe => 0,
                rebuild => 1,


@@ -172,14 +172,14 @@ sub getsetup () { #{{{
        },
        verbose => {
                type => "boolean",
        },
        verbose => {
                type => "boolean",

-               default => 0,
+               example => 1,

                description => "display verbose messages when building?",
                safe => 1,
                rebuild => 0,
        },
        syslog => {
                type => "boolean",
                description => "display verbose messages when building?",
                safe => 1,
                rebuild => 0,
        },
        syslog => {
                type => "boolean",

-               default => 0,
+               example => 1,

                description => "log to syslog?",
                safe => 1,
                rebuild => 0,
                description => "log to syslog?",
                safe => 1,
                rebuild => 0,


@@ -198,6 +198,13 @@ sub getsetup () { #{{{
                safe => 0, # changing requires manual transition
                rebuild => 1,
        },
                safe => 0, # changing requires manual transition
                rebuild => 1,
        },

+       indexpages => {
+               type => "boolean",
+               default => 0,
+               description => "use page/index.mdwn source files",
+               safe => 1,
+               rebuild => 1,
+       },

        discussion => {
                type => "boolean",
                default => 1,
        discussion => {
                type => "boolean",
                default => 1,


@@ -312,9 +319,15 @@ sub getsetup () { #{{{
                safe => 0,
                rebuild => 1,
        },
                safe => 0,
                rebuild => 1,
        },

+       wiki_file_chars => {
+               type => "string",
+               description => "specifies the characters that are allowed in source filenames",
+               default => "-[:alnum:]+/.:_",
+               safe => 0,
+               rebuild => 1,
+       },

        wiki_file_regexp => {
                type => "internal",
        wiki_file_regexp => {
                type => "internal",

-               default => qr/(^[-[:alnum:]_.:\/+]+$)/,

                description => "regexp of legal source files",
                safe => 0,
                rebuild => 1,
                description => "regexp of legal source files",
                safe => 0,
                rebuild => 1,


@@ -354,6 +367,13 @@ sub getsetup () { #{{{
                safe => 0,
                rebuild => 0,
        },
                safe => 0,
                rebuild => 0,
        },

+       setup => {
+               type => "internal",
+               default => undef,
+               description => "running in setup mode",
+               safe => 0,
+               rebuild => 0,
+       },

        refresh => {
                type => "internal",
                default => 0,
        refresh => {
                type => "internal",
                default => 0,


@@ -375,10 +395,17 @@ sub getsetup () { #{{{
                safe => 0,
                rebuild => 0,
        },
                safe => 0,
                rebuild => 0,
        },

-       setup => {
+       setupfile => {

                type => "internal",
                default => undef,
                type => "internal",
                default => undef,

-               description => "setup file to read",
+               description => "path to setup file",
+               safe => 0,
+               rebuild => 0,
+       },
+       allow_symlinks_before_srcdir => {
+               type => "string",
+               default => 0,
+               description => "allow symlinks in the path leading to the srcdir (potentially insecure)",

                safe => 0,
                rebuild => 0,
        },
                safe => 0,
                rebuild => 0,
        },


@@ -406,6 +433,10 @@ sub checkconfig () { #{{{
                        $gettext_obj=undef;
                }
        }
                        $gettext_obj=undef;
                }
        }

+               
+       if (! defined $config{wiki_file_regexp}) {
+               $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
+       }

 
        if (ref $config{ENV} eq 'HASH') {
                foreach my $val (keys %{$config{ENV}}) {
 
        if (ref $config{ENV} eq 'HASH') {
                foreach my $val (keys %{$config{ENV}}) {


@@ -464,7 +495,9 @@ sub loadplugins () { #{{{
                unshift @INC, possibly_foolish_untaint($config{libdir});
        }
 
                unshift @INC, possibly_foolish_untaint($config{libdir});
        }
 

-       loadplugin($_) foreach @{$config{default_plugins}}, @{$config{add_plugins}};
+       foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
+               loadplugin($plugin);
+       }

        
        if ($config{rcs}) {
                if (exists $IkiWiki::hooks{rcs}) {
        
        if ($config{rcs}) {
                if (exists $IkiWiki::hooks{rcs}) {


@@ -494,7 +527,11 @@ sub loadplugin ($) { #{{{
        foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
                         "$installdir/lib/ikiwiki") {
                if (defined $dir && -x "$dir/plugins/$plugin") {
        foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
                         "$installdir/lib/ikiwiki") {
                if (defined $dir && -x "$dir/plugins/$plugin") {

-                       require IkiWiki::Plugin::external;
+                       eval { require IkiWiki::Plugin::external };
+                       if ($@) {
+                               my $reason=$@;
+                               error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
+                       }

                        import IkiWiki::Plugin::external "$dir/plugins/$plugin";
                        $loaded_plugins{$plugin}=1;
                        return 1;
                        import IkiWiki::Plugin::external "$dir/plugins/$plugin";
                        $loaded_plugins{$plugin}=1;
                        return 1;


@@ -588,17 +625,44 @@ sub pagename ($) { #{{{
 
        my $type=pagetype($file);
        my $page=$file;
 
        my $type=pagetype($file);
        my $page=$file;

-       $page=~s/\Q.$type\E*$// if defined $type;
+       $page=~s/\Q.$type\E*$// if defined $type && !$hooks{htmlize}{$type}{keepextension};
+       if ($config{indexpages} && $page=~/(.*)\/index$/) {
+               $page=$1;
+       }

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

+sub newpagefile ($$) { #{{{
+       my $page=shift;
+       my $type=shift;
+
+       if (! $config{indexpages} || $page eq 'index') {
+               return $page.".".$type;
+       }
+       else {
+               return $page."/index.".$type;
+       }
+} #}}}
+

 sub targetpage ($$) { #{{{
        my $page=shift;
        my $ext=shift;
 sub targetpage ($$) { #{{{
        my $page=shift;
        my $ext=shift;

-       
-       if (! $config{usedirs} || $page =~ /^index$/ ) {
+
+       my $targetpage='';
+       run_hooks(targetpage => sub {
+               $targetpage=shift->(
+                       page => $page,
+                       ext => $ext,
+               );
+       });
+
+       if (defined $targetpage && (length($targetpage) > 0)) {
+               return $targetpage;
+       }
+       elsif (! $config{usedirs} || $page eq 'index') {

                return $page.".".$ext;
                return $page.".".$ext;

-       } else {
+       }
+       else {

                return $page."/index.".$ext;
        }
 } #}}}
                return $page."/index.".$ext;
        }
 } #}}}


@@ -628,11 +692,12 @@ sub srcfile ($;$) { #{{{
 sub add_underlay ($) { #{{{
        my $dir=shift;
 
 sub add_underlay ($) { #{{{
        my $dir=shift;
 

-       if ($dir=~/^\//) {
-               unshift @{$config{underlaydirs}}, $dir;
+       if ($dir !~ /^\//) {
+               $dir="$config{underlaydir}/../$dir";

        }
        }

-       else {
-               unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
+
+       if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
+               unshift @{$config{underlaydirs}}, $dir;

        }
 
        return 1;
        }
 
        return 1;


@@ -720,7 +785,7 @@ sub will_render ($$;$) { #{{{
 
        # Important security check.
        if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
 
        # Important security check.
        if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&

-           ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
+           ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {

                error("$config{destdir}/$dest independently created, not overwriting with version from $page");
        }
 
                error("$config{destdir}/$dest independently created, not overwriting with version from $page");
        }
 


@@ -742,6 +807,7 @@ sub will_render ($$;$) { #{{{
 sub bestlink ($$) { #{{{
        my $page=shift;
        my $link=shift;
 sub bestlink ($$) { #{{{
        my $page=shift;
        my $link=shift;

+       my $res=undef;

        
        my $cwd=$page;
        if ($link=~s/^\/+//) {
        
        my $cwd=$page;
        if ($link=~s/^\/+//) {


@@ -756,25 +822,35 @@ sub bestlink ($$) { #{{{
                $l.=$link;
 
                if (exists $links{$l}) {
                $l.=$link;
 
                if (exists $links{$l}) {

-                       return $l;
+                       $res=$l;

                }
                elsif (exists $pagecase{lc $l}) {
                }
                elsif (exists $pagecase{lc $l}) {

-                       return $pagecase{lc $l};
+                       $res=$pagecase{lc $l};

                }
                }

-       } while $cwd=~s!/?[^/]+$!!;
+       } while ($cwd=~s{/?[^/]+$}{} && ! defined $res);

 
 

-       if (length $config{userdir}) {
+       if (! defined $res && length $config{userdir}) {

                my $l = "$config{userdir}/".lc($link);
                if (exists $links{$l}) {
                my $l = "$config{userdir}/".lc($link);
                if (exists $links{$l}) {

-                       return $l;
+                       $res=$l;

                }
                elsif (exists $pagecase{lc $l}) {
                }
                elsif (exists $pagecase{lc $l}) {

-                       return $pagecase{lc $l};
+                       $res=$pagecase{lc $l};

                }
        }
 
                }
        }
 

-       #print STDERR "warning: page $page, broken link: $link\n";
-       return "";
+       if (defined $res) {
+               run_hooks(tweakbestlink => sub {
+                       $res=shift->(
+                               page => $page,
+                               link => $res);
+               });
+               return $res;
+       }
+       else {
+               #print STDERR "warning: page $page, broken link: $link\n";
+               return "";
+       }

 } #}}}
 
 sub isinlinableimage ($) { #{{{
 } #}}}
 
 sub isinlinableimage ($) { #{{{


@@ -799,13 +875,16 @@ sub pagetitle ($;$) { #{{{
 
 sub titlepage ($) { #{{{
        my $title=shift;
 
 sub titlepage ($) { #{{{
        my $title=shift;

-       $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
+       # support use w/o %config set
+       my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
+       $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;

        return $title;
 } #}}}
 
 sub linkpage ($) { #{{{
        my $link=shift;
        return $title;
 } #}}}
 
 sub linkpage ($) { #{{{
        my $link=shift;

-       $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
+       my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
+       $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;

        return $link;
 } #}}}
 
        return $link;
 } #}}}
 


@@ -859,6 +938,10 @@ sub beautify_urlpath ($) { #{{{
                $url =~ s!/index.$config{htmlext}$!/!;
        }
 
                $url =~ s!/index.$config{htmlext}$!/!;
        }
 

+       run_hooks(tweakurlpath => sub {
+               $url=shift->(url => $url);
+       });
+

        # Ensure url is not an empty link, and
        # if it's relative, make that explicit to avoid colon confusion.
        if ($url !~ /^\//) {
        # Ensure url is not an empty link, and
        # if it's relative, make that explicit to avoid colon confusion.
        if ($url !~ /^\//) {


@@ -1045,7 +1128,7 @@ sub preprocess ($$$;$$) { #{{{
                my $params=shift;
                $params="" if ! defined $params;
 
                my $params=shift;
                $params="" if ! defined $params;
 

-               f (length $escape) {
+               if (length $escape) {

                        return "[[$prefix$command $params]]";
                }
                elsif (exists $hooks{preprocess}{$command}) {
                        return "[[$prefix$command $params]]";
                }
                elsif (exists $hooks{preprocess}{$command}) {


@@ -1276,31 +1359,42 @@ sub loadindex () { #{{{
                        return;
                }
        }
                        return;
                }
        }

-       my $ret=Storable::fd_retrieve($in);
-       if (! defined $ret) {
+
+       my $index=Storable::fd_retrieve($in);
+       if (! defined $index) {

                return 0;
        }
                return 0;
        }

-       my %index=%$ret;
-       foreach my $src (keys %index) {
-               my %d=%{$index{$src}};
+
+       my $pages;
+       if (exists $index->{version} && ! ref $index->{version}) {
+               $pages=$index->{page};
+               %wikistate=%{$index->{state}};
+       }
+       else {
+               $pages=$index;
+               %wikistate=();
+       }
+
+       foreach my $src (keys %$pages) {
+               my $d=$pages->{$src};

                my $page=pagename($src);
                my $page=pagename($src);

-               $pagectime{$page}=$d{ctime};
+               $pagectime{$page}=$d->{ctime};

                if (! $config{rebuild}) {
                        $pagesources{$page}=$src;
                if (! $config{rebuild}) {
                        $pagesources{$page}=$src;

-                       $pagemtime{$page}=$d{mtime};
-                       $renderedfiles{$page}=$d{dest};
-                       if (exists $d{links} && ref $d{links}) {
-                               $links{$page}=$d{links};
-                               $oldlinks{$page}=[@{$d{links}}];
+                       $pagemtime{$page}=$d->{mtime};
+                       $renderedfiles{$page}=$d->{dest};
+                       if (exists $d->{links} && ref $d->{links}) {
+                               $links{$page}=$d->{links};
+                               $oldlinks{$page}=[@{$d->{links}}];

                        }
                        }

-                       if (exists $d{depends}) {
-                               $depends{$page}=$d{depends};
+                       if (exists $d->{depends}) {
+                               $depends{$page}=$d->{depends};

                        }
                        }

-                       if (exists $d{state}) {
-                               $pagestate{$page}=$d{state};
+                       if (exists $d->{state}) {
+                               $pagestate{$page}=$d->{state};

                        }
                }
                        }
                }

-               $oldrenderedfiles{$page}=[@{$d{dest}}];
+               $oldrenderedfiles{$page}=[@{$d->{dest}}];

        }
        foreach my $page (keys %pagesources) {
                $pagecase{lc $page}=$page;
        }
        foreach my $page (keys %pagesources) {
                $pagecase{lc $page}=$page;


@@ -1326,12 +1420,13 @@ sub saveindex () { #{{{
        my $newfile="$config{wikistatedir}/indexdb.new";
        my $cleanup = sub { unlink($newfile) };
        open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
        my $newfile="$config{wikistatedir}/indexdb.new";
        my $cleanup = sub { unlink($newfile) };
        open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);

+

        my %index;
        foreach my $page (keys %pagemtime) {
                next unless $pagemtime{$page};
                my $src=$pagesources{$page};
 
        my %index;
        foreach my $page (keys %pagemtime) {
                next unless $pagemtime{$page};
                my $src=$pagesources{$page};
 

-               $index{$src}={
+               $index{page}{$src}={

                        ctime => $pagectime{$page},
                        mtime => $pagemtime{$page},
                        dest => $renderedfiles{$page},
                        ctime => $pagectime{$page},
                        mtime => $pagemtime{$page},
                        dest => $renderedfiles{$page},


@@ -1339,17 +1434,26 @@ sub saveindex () { #{{{
                };
 
                if (exists $depends{$page}) {
                };
 
                if (exists $depends{$page}) {

-                       $index{$src}{depends} = $depends{$page};
+                       $index{page}{$src}{depends} = $depends{$page};

                }
 
                if (exists $pagestate{$page}) {
                        foreach my $id (@hookids) {
                                foreach my $key (keys %{$pagestate{$page}{$id}}) {
                }
 
                if (exists $pagestate{$page}) {
                        foreach my $id (@hookids) {
                                foreach my $key (keys %{$pagestate{$page}{$id}}) {

-                                       $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
+                                       $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};

                                }
                        }
                }
        }
                                }
                        }
                }
        }

+
+       $index{state}={};
+       foreach my $id (@hookids) {
+               foreach my $key (keys %{$wikistate{$id}}) {
+                       $index{state}{$id}{$key}=$wikistate{$id}{$key};
+               }
+       }
+       
+       $index{version}="3";

        my $ret=Storable::nstore_fd(\%index, $out);
        return if ! defined $ret || ! $ret;
        close $out || error("failed saving to $newfile: $!", $cleanup);
        my $ret=Storable::nstore_fd(\%index, $out);
        return if ! defined $ret || ! $ret;
        close $out || error("failed saving to $newfile: $!", $cleanup);


@@ -1842,4 +1946,61 @@ sub match_creation_year ($$;@) { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+sub match_user ($$;@) { #{{{
+       shift;
+       my $user=shift;
+       my %params=@_;
+       
+       if (! exists $params{user}) {
+               return IkiWiki::FailReason->new("no user specified");
+       }
+
+       if (defined $params{user} && lc $params{user} eq lc $user) {
+               return IkiWiki::SuccessReason->new("user is $user");
+       }
+       elsif (! defined $params{user}) {
+               return IkiWiki::FailReason->new("not logged in");
+       }
+       else {
+               return IkiWiki::FailReason->new("user is $params{user}, not $user");
+       }
+} #}}}
+
+sub match_admin ($$;@) { #{{{
+       shift;
+       shift;
+       my %params=@_;
+       
+       if (! exists $params{user}) {
+               return IkiWiki::FailReason->new("no user specified");
+       }
+
+       if (defined $params{user} && IkiWiki::is_admin($params{user})) {
+               return IkiWiki::SuccessReason->new("user is an admin");
+       }
+       elsif (! defined $params{user}) {
+               return IkiWiki::FailReason->new("not logged in");
+       }
+       else {
+               return IkiWiki::FailReason->new("user is not an admin");
+       }
+} #}}}
+
+sub match_ip ($$;@) { #{{{
+       shift;
+       my $ip=shift;
+       my %params=@_;
+       
+       if (! exists $params{ip}) {
+               return IkiWiki::FailReason->new("no IP specified");
+       }
+
+       if (defined $params{ip} && lc $params{ip} eq lc $ip) {
+               return IkiWiki::SuccessReason->new("IP is $ip");
+       }
+       else {
+               return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
+       }
+} #}}}
+

 1
 1