asking for clarification

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

diff --git a/IkiWiki.pm b/IkiWiki.pm
index e7422cba571337f2db7f70d519fab896b0c9c3e0..063cef8e09220dc2beaea0eabf1afea759368a31 100644 (file)
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -1,6 +1,7 @@
 #!/usr/bin/perl
 
 package IkiWiki;
 #!/usr/bin/perl
 
 package IkiWiki;

+

 use warnings;
 use strict;
 use Encode;
 use warnings;
 use strict;
 use Encode;


@@ -76,7 +77,8 @@ sub defaultconfig () { #{{{
        adminuser => undef,
        adminemail => undef,
        plugin => [qw{mdwn link inline htmlscrubber passwordauth openid
        adminuser => undef,
        adminemail => undef,
        plugin => [qw{mdwn link inline htmlscrubber passwordauth openid

-                       signinedit lockedit conditional recentchanges}],
+                       signinedit lockedit conditional recentchanges
+                       parentlinks}],

        libdir => undef,
        timeformat => '%c',
        locale => undef,
        libdir => undef,
        timeformat => '%c',
        locale => undef,


@@ -87,6 +89,8 @@ sub defaultconfig () { #{{{
        numbacklinks => 10,
        account_creation_password => "",
        prefix_directives => 0,
        numbacklinks => 10,
        account_creation_password => "",
        prefix_directives => 0,

+       hardlink => 0,
+       cgi_disable_uploads => 1,

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


@@ -102,6 +106,12 @@ sub checkconfig () { #{{{
                }
        }
 
                }
        }
 

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

        if ($config{w3mmode}) {
                eval q{use Cwd q{abs_path}};
                error($@) if $@;
        if ($config{w3mmode}) {
                eval q{use Cwd q{abs_path}};
                error($@) if $@;


@@ -180,11 +190,6 @@ sub loadplugin ($) { #{{{
 sub error ($;$) { #{{{
        my $message=shift;
        my $cleaner=shift;
 sub error ($;$) { #{{{
        my $message=shift;
        my $cleaner=shift;

-       if ($config{cgi}) {
-               print "Content-type: text/html\n\n";
-               print misctemplate(gettext("Error"),
-                       "<p>".gettext("Error").": $message</p>");
-       }

        log_message('err' => $message) if $config{syslog};
        if (defined $cleaner) {
                $cleaner->();
        log_message('err' => $message) if $config{syslog};
        if (defined $cleaner) {
                $cleaner->();


@@ -281,17 +286,22 @@ sub htmlpage ($) { #{{{
        return targetpage($page, $config{htmlext});
 } #}}}
 
        return targetpage($page, $config{htmlext});
 } #}}}
 

-sub srcfile ($) { #{{{
+sub srcfile_stat { #{{{

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

+       my $nothrow=shift;

 
 

-       return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
+       return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";

        foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
        foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {

-               return "$dir/$file" if -e "$dir/$file";
+               return "$dir/$file", stat(_) if -e "$dir/$file";

        }
        }

-       error("internal error: $file cannot be found in $config{srcdir} or underlay");
+       error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;

        return;
 } #}}}
 
        return;
 } #}}}
 

+sub srcfile ($;$) { #{{{
+       return (srcfile_stat(@_))[0];
+} #}}}
+

 sub add_underlay ($) { #{{{
        my $dir=shift;
 
 sub add_underlay ($) { #{{{
        my $dir=shift;
 


@@ -323,12 +333,9 @@ sub readfile ($;$$) { #{{{
        return $ret;
 } #}}}
 
        return $ret;
 } #}}}
 

-sub writefile ($$$;$$) { #{{{
-       my $file=shift; # can include subdirs
-       my $destdir=shift; # directory to put file in
-       my $content=shift;
-       my $binary=shift;
-       my $writer=shift;
+sub prep_writefile ($$) { #{{{
+       my $file=shift;
+       my $destdir=shift;

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


@@ -337,12 +344,8 @@ sub writefile ($$$;$$) { #{{{
                }
                $test=dirname($test);
        }
                }
                $test=dirname($test);
        }

-       my $newfile="$destdir/$file.ikiwiki-new";
-       if (-l $newfile) {
-               error("cannot write to a symlink ($newfile)");
-       }

 
 

-       my $dir=dirname($newfile);
+       my $dir=dirname("$destdir/$file");

        if (! -d $dir) {
                my $d="";
                foreach my $s (split(m!/+!, $dir)) {
        if (! -d $dir) {
                my $d="";
                foreach my $s (split(m!/+!, $dir)) {


@@ -353,6 +356,23 @@ sub writefile ($$$;$$) { #{{{
                }
        }
 
                }
        }
 

+       return 1;
+} #}}}
+
+sub writefile ($$$;$$) { #{{{
+       my $file=shift; # can include subdirs
+       my $destdir=shift; # directory to put file in
+       my $content=shift;
+       my $binary=shift;
+       my $writer=shift;
+       
+       prep_writefile($file, $destdir);
+       
+       my $newfile="$destdir/$file.ikiwiki-new";
+       if (-l $newfile) {
+               error("cannot write to a symlink ($newfile)");
+       }
+       

        my $cleanup = sub { unlink($newfile) };
        open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
        binmode($out) if ($binary);
        my $cleanup = sub { unlink($newfile) };
        open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
        binmode($out) if ($binary);


@@ -509,13 +529,18 @@ sub displaytime ($;$) { #{{{
        return decode_utf8(POSIX::strftime($format, localtime($time)));
 } #}}}
 
        return decode_utf8(POSIX::strftime($format, localtime($time)));
 } #}}}
 

-sub beautify_url ($) { #{{{
+sub beautify_urlpath ($) { #{{{

        my $url=shift;
 
        if ($config{usedirs}) {
                $url =~ s!/index.$config{htmlext}$!/!;
        }
        my $url=shift;
 
        if ($config{usedirs}) {
                $url =~ s!/index.$config{htmlext}$!/!;
        }

-       $url =~ s!^$!./!; # Browsers don't like empty links...
+
+       # Ensure url is not an empty link, and
+       # if it's relative, make that explicit to avoid colon confusion.
+       if ($url !~ /\//) {
+               $url="./$url";
+       }

 
        return $url;
 } #}}}
 
        return $url;
 } #}}}


@@ -525,7 +550,7 @@ sub urlto ($$) { #{{{
        my $from=shift;
 
        if (! length $to) {
        my $from=shift;
 
        if (! length $to) {

-               return beautify_url(baseurl($from));
+               return beautify_urlpath(baseurl($from)."index.$config{htmlext}");

        }
 
        if (! $destsources{$to}) {
        }
 
        if (! $destsources{$to}) {


@@ -534,7 +559,7 @@ sub urlto ($$) { #{{{
 
        my $link = abs2rel($to, dirname(htmlpage($from)));
 
 
        my $link = abs2rel($to, dirname(htmlpage($from)));
 

-       return beautify_url($link);
+       return beautify_urlpath($link);

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


@@ -573,15 +598,15 @@ sub htmllink ($$$;@) { #{{{
                        return "<span class=\"createlink\"><a href=\"".
                                cgiurl(
                                        do => "create",
                        return "<span class=\"createlink\"><a href=\"".
                                cgiurl(
                                        do => "create",

-                                       page => pagetitle(lc($link), 1),
+                                       page => lc($link),

                                        from => $lpage
                                ).
                                        from => $lpage
                                ).

-                               "\">?</a>$linktext</span>"
+                               "\" rel=\"nofollow\">?</a>$linktext</span>"

                }
        }
        
        $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
                }
        }
        
        $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));

-       $bestlink=beautify_url($bestlink);
+       $bestlink=beautify_urlpath($bestlink);

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


@@ -610,14 +635,18 @@ sub userlink ($) { #{{{
                return "<a href=\"$user\">$oiduser</a>";
        }
        else {
                return "<a href=\"$user\">$oiduser</a>";
        }
        else {

+               eval q{use CGI 'escapeHTML'};
+               error($@) if $@;
+

                return htmllink("", "", escapeHTML(
                        length $config{userdir} ? $config{userdir}."/".$user : $user
                ), noimageinline => 1);
        }
 } #}}}
 
                return htmllink("", "", escapeHTML(
                        length $config{userdir} ? $config{userdir}."/".$user : $user
                ), noimageinline => 1);
        }
 } #}}}
 

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

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

+       my $destpage=shift;

        my $type=shift;
        my $content=shift;
        
        my $type=shift;
        my $content=shift;
        


@@ -636,6 +665,7 @@ sub htmlize ($$$) { #{{{
        run_hooks(sanitize => sub {
                $content=shift->(
                        page => $page,
        run_hooks(sanitize => sub {
                $content=shift->(
                        page => $page,

+                       destpage => $destpage,

                        content => $content,
                );
        });
                        content => $content,
                );
        });


@@ -667,7 +697,7 @@ sub linkify ($$$) { #{{{
        return $content;
 } #}}}
 
        return $content;
 } #}}}
 

-my %preprocessing;
+our %preprocessing;

 our $preprocess_preview=0;
 sub preprocess ($$$;$$) { #{{{
        my $page=shift; # the page the data comes from
 our $preprocess_preview=0;
 sub preprocess ($$$;$$) { #{{{
        my $page=shift; # the page the data comes from


@@ -739,21 +769,30 @@ sub preprocess ($$$;$$) { #{{{
                        }
                        my $ret;
                        if (! $scan) {
                        }
                        my $ret;
                        if (! $scan) {

-                               $ret=$hooks{preprocess}{$command}{call}->(
-                                       @params,
-                                       page => $page,
-                                       destpage => $destpage,
-                                       preview => $preprocess_preview,
-                               );
+                               $ret=eval {
+                                       $hooks{preprocess}{$command}{call}->(
+                                               @params,
+                                               page => $page,
+                                               destpage => $destpage,
+                                               preview => $preprocess_preview,
+                                       );
+                               };
+                               if ($@) {
+                                       chomp $@;
+                                       $ret="[[!$command <span class=\"error\">".
+                                               gettext("Error").": $@"."</span>]]";
+                               }

                        }
                        else {
                                # use void context during scan pass
                        }
                        else {
                                # use void context during scan pass

-                               $hooks{preprocess}{$command}{call}->(
-                                       @params,
-                                       page => $page,
-                                       destpage => $destpage,
-                                       preview => $preprocess_preview,
-                               );
+                               eval {
+                                       $hooks{preprocess}{$command}{call}->(
+                                               @params,
+                                               page => $page,
+                                               destpage => $destpage,
+                                               preview => $preprocess_preview,
+                                       );
+                               };

                                $ret="";
                        }
                        $preprocessing{$page}--;
                                $ret="";
                        }
                        $preprocessing{$page}--;


@@ -787,7 +826,8 @@ sub preprocess ($$$;$$) { #{{{
                        *)?             # 0 or more parameters
                        \]\]            # directive closed
                }sx;
                        *)?             # 0 or more parameters
                        \]\]            # directive closed
                }sx;

-       } else {
+       }
+       else {

                $regex = qr{
                        (\\?)           # 1: escape?
                        \[\[(!?)        # directive open; 2: optional prefix
                $regex = qr{
                        (\\?)           # 1: escape?
                        \[\[(!?)        # directive open; 2: optional prefix


@@ -899,18 +939,28 @@ sub loadindex () { #{{{
                %pagesources=%pagemtime=%oldlinks=%links=%depends=
                %destsources=%renderedfiles=%pagecase=%pagestate=();
        }
                %pagesources=%pagemtime=%oldlinks=%links=%depends=
                %destsources=%renderedfiles=%pagecase=%pagestate=();
        }

-       open (my $in, "<", "$config{wikistatedir}/index") || return;
+       my $in;
+       if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
+               if (-e "$config{wikistatedir}/index") {
+                       system("ikiwiki-transition", "indexdb", $config{srcdir});
+                       open ($in, "<", "$config{wikistatedir}/indexdb") || return;
+               }
+               else {
+                       return;
+               }
+       }

        my $ret=Storable::fd_retrieve($in);
        if (! defined $ret) {
                return 0;
        }
        my %index=%$ret;
        my $ret=Storable::fd_retrieve($in);
        if (! defined $ret) {
                return 0;
        }
        my %index=%$ret;

-       foreach my $page (keys %index) {
-               my %d=%{$index{$page}};
+       foreach my $src (keys %index) {
+               my %d=%{$index{$src}};
+               my $page=pagename($src);

                $pagectime{$page}=$d{ctime};
                if (! $config{rebuild}) {
                $pagectime{$page}=$d{ctime};
                if (! $config{rebuild}) {

+                       $pagesources{$page}=$src;

                        $pagemtime{$page}=$d{mtime};
                        $pagemtime{$page}=$d{mtime};

-                       $pagesources{$page}=$d{src};

                        $renderedfiles{$page}=$d{dest};
                        if (exists $d{links} && ref $d{links}) {
                                $links{$page}=$d{links};
                        $renderedfiles{$page}=$d{dest};
                        if (exists $d{links} && ref $d{links}) {
                                $links{$page}=$d{links};


@@ -946,29 +996,29 @@ sub saveindex () { #{{{
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }
        if (! -d $config{wikistatedir}) {
                mkdir($config{wikistatedir});
        }

-       my $newfile="$config{wikistatedir}/index.new";
+       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 $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};

 
 

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

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

-                       src => $pagesources{$page},

                        dest => $renderedfiles{$page},
                        links => $links{$page},
                };
 
                if (exists $depends{$page}) {
                        dest => $renderedfiles{$page},
                        links => $links{$page},
                };
 
                if (exists $depends{$page}) {

-                       $index{$page}{depends} = $depends{$page};
+                       $index{$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{$page}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
+                                       $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};

                                }
                        }
                }
                                }
                        }
                }


@@ -976,8 +1026,8 @@ sub saveindex () { #{{{
        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);

-       rename($newfile, "$config{wikistatedir}/index") ||
-               error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
+       rename($newfile, "$config{wikistatedir}/indexdb") ||
+               error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);

        
        return 1;
 } #}}}
        
        return 1;
 } #}}}


@@ -1158,6 +1208,12 @@ sub gettext { #{{{
        }
 } #}}}
 
        }
 } #}}}
 

+sub yesno ($) { #{{{
+       my $val=shift;
+
+       return (defined $val && lc($val) eq gettext("yes"));
+} #}}}
+

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


@@ -1223,6 +1279,11 @@ sub pagespec_translate ($) { #{{{
                }
        }
 
                }
        }
 

+       if (! length $code) {
+               $code=0;
+       }
+
+       no warnings;

        return eval 'sub { my $page=shift; '.$code.' }';
 } #}}}
 
        return eval 'sub { my $page=shift; '.$code.' }';
 } #}}}
 


@@ -1237,7 +1298,7 @@ sub pagespec_match ($$;@) { #{{{
        }
 
        my $sub=pagespec_translate($spec);
        }
 
        my $sub=pagespec_translate($spec);

-       return IkiWiki::FailReason->new('syntax error') if $@;
+       return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;

        return $sub->($page, @params);
 } #}}}
 
        return $sub->($page, @params);
 } #}}}
 


@@ -1247,6 +1308,13 @@ sub pagespec_valid ($) { #{{{
        my $sub=pagespec_translate($spec);
        return ! $@;
 } #}}}
        my $sub=pagespec_translate($spec);
        return ! $@;
 } #}}}

+       
+sub glob2re ($) { #{{{
+       my $re=quotemeta(shift);
+       $re=~s/\\\*/.*/g;
+       $re=~s/\\\?/./g;
+       return $re;
+} #}}}

 
 package IkiWiki::FailReason;
 
 
 package IkiWiki::FailReason;
 


@@ -1258,7 +1326,9 @@ use overload ( #{{{
 ); #}}}
 
 sub new { #{{{
 ); #}}}
 
 sub new { #{{{

-       return bless \$_[1], $_[0];
+       my $class = shift;
+       my $value = shift;
+       return bless \$value, $class;

 } #}}}
 
 package IkiWiki::SuccessReason;
 } #}}}
 
 package IkiWiki::SuccessReason;


@@ -1271,7 +1341,9 @@ use overload ( #{{{
 ); #}}}
 
 sub new { #{{{
 ); #}}}
 
 sub new { #{{{

-       return bless \$_[1], $_[0];
+       my $class = shift;
+       my $value = shift;
+       return bless \$value, $class;

 }; #}}}
 
 package IkiWiki::PageSpec;
 }; #}}}
 
 package IkiWiki::PageSpec;


@@ -1290,12 +1362,8 @@ sub match_glob ($$;@) { #{{{
                $glob="$from/$glob" if length $from;
        }
 
                $glob="$from/$glob" if length $from;
        }
 

-       # turn glob into safe regexp
-       $glob=quotemeta($glob);
-       $glob=~s/\\\*/.*/g;
-       $glob=~s/\\\?/./g;
-
-       if ($page=~/^$glob$/i) {
+       my $regexp=IkiWiki::glob2re($glob);
+       if ($page=~/^$regexp$/i) {

                if (! IkiWiki::isinternal($page) || $params{internal}) {
                        return IkiWiki::SuccessReason->new("$glob matches $page");
                }
                if (! IkiWiki::isinternal($page) || $params{internal}) {
                        return IkiWiki::SuccessReason->new("$glob matches $page");
                }