X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ff6941cef9a88ea2a0d3af2e5ae1edd09048916b..dcafcd015ddb992fc40194cac4977213c31fa108:/IkiWiki.pm diff --git a/IkiWiki.pm b/IkiWiki.pm index 499d3a71f..5f0dca385 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -9,14 +9,16 @@ use open qw{:utf8 :std}; 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 - displaytime will_render + displaytime will_render gettext %config %links %renderedfiles %pagesources); -our $VERSION = 1.01; # plugin interface version +our $VERSION = 1.01; # plugin interface version, next is ikiwiki version +our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE +my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE # Optimisation. use Memoize; @@ -24,11 +26,9 @@ 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 () { #{{{ - wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/, + wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, + qr/\.x?html?$/, qr/\.ikiwiki-new$/, qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//], wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/, wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/, @@ -38,13 +38,12 @@ sub defaultconfig () { #{{{ wikiname => "wiki", default_pageext => "mdwn", cgi => 0, - rcs => 'svn', + rcs => '', notify => 0, url => '', cgiurl => '', historyurl => '', diffurl => '', - anonok => 0, rss => 0, atom => 0, discussion => 1, @@ -56,6 +55,8 @@ sub defaultconfig () { #{{{ wrappermode => undef, svnrepo => undef, svnpath => "trunk", + gitorigin_branch => "origin", + gitmaster_branch => "master", srcdir => undef, destdir => undef, pingurl => [], @@ -64,7 +65,8 @@ sub defaultconfig () { #{{{ setup => undef, adminuser => undef, adminemail => undef, - plugin => [qw{mdwn inline htmlscrubber passwordauth}], + plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit + lockedit conditional}], timeformat => '%c', locale => undef, sslcookie => 0, @@ -81,8 +83,10 @@ sub checkconfig () { #{{{ if (defined $config{locale}) { eval q{use POSIX}; error($@) if $@; - $ENV{LANG} = $config{locale} - if POSIX::setlocale(&POSIX::LC_TIME, $config{locale}); + if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) { + $ENV{LANG}=$config{locale}; + $gettext_obj=undef; + } } if ($config{w3mmode}) { @@ -96,7 +100,7 @@ sub checkconfig () { #{{{ } if ($config{cgi} && ! length $config{url}) { - error("Must specify url to wiki with --url when using --cgi\n"); + error(gettext("Must specify url to wiki with --url when using --cgi")); } $config{wikistatedir}="$config{srcdir}/.ikiwiki" @@ -129,6 +133,8 @@ 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 ($@) { @@ -136,13 +142,19 @@ sub loadplugin ($) { #{{{ } } #}}} -sub error ($) { #{{{ +sub error ($;$) { #{{{ + my $message=shift; + my $cleaner=shift; if ($config{cgi}) { print "Content-type: text/html\n\n"; - print misctemplate("Error", "

Error: @_

"); + print misctemplate(gettext("Error"), + "

".gettext("Error").": $message

"); + } + log_message(debug => $message) if $config{syslog}; + if (defined $cleaner) { + $cleaner->(); } - log_message(error => @_); - exit(1); + die $message."\n"; } #}}} sub debug ($) { #{{{ @@ -225,9 +237,10 @@ sub srcfile ($) { #{{{ error("internal error: $file cannot be found"); } #}}} -sub readfile ($;$) { #{{{ +sub readfile ($;$$) { #{{{ my $file=shift; my $binary=shift; + my $wantfd=shift; if (-l $file) { error("cannot read a symlink ($file)"); @@ -236,16 +249,18 @@ sub readfile ($;$) { #{{{ local $/=undef; open (IN, $file) || error("failed to read $file: $!"); binmode(IN) if ($binary); + return \*IN if $wantfd; my $ret=; - close IN; + close IN || error("failed to read $file: $!"); 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 $writer=shift; my $test=$file; while (length $test) { @@ -254,8 +269,12 @@ sub writefile ($$$;$) { #{{{ } $test=dirname($test); } + my $newfile="$destdir/$file.ikiwiki-new"; + if (-l $newfile) { + error("cannot write to a symlink ($newfile)"); + } - my $dir=dirname("$destdir/$file"); + my $dir=dirname($newfile); if (! -d $dir) { my $d=""; foreach my $s (split(m!/+!, $dir)) { @@ -265,11 +284,19 @@ sub writefile ($$$;$) { #{{{ } } } - - open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!"); + + my $cleanup = sub { unlink($newfile) }; + open (OUT, ">$newfile") || error("failed to write $newfile: $!", $cleanup); binmode(OUT) if ($binary); - print OUT $content; - close OUT; + if ($writer) { + $writer->(\*OUT, $cleanup); + } + else { + print OUT $content || error("failed writing to $newfile: $!", $cleanup); + } + close OUT || error("failed saving $newfile: $!", $cleanup); + rename($newfile, "$destdir/$file") || + error("failed renaming $newfile to $destdir/$file: $!", $cleanup); } #}}} my %cleared; @@ -298,10 +325,9 @@ sub bestlink ($$) { #{{{ my $link=shift; my $cwd=$page; - - # relative links - while ($link=~s!(^|/)\.\./!!g) { - $cwd=~s!/?[^/]+$!!; + if ($link=~s/^\/+//) { + # absolute links + $cwd=""; } do { @@ -317,6 +343,10 @@ sub bestlink ($$) { #{{{ } } 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 ""; } #}}} @@ -327,10 +357,18 @@ sub isinlinableimage ($) { #{{{ $file=~/\.(png|gif|jpg|jpeg)$/i; } #}}} -sub pagetitle ($) { #{{{ +sub pagetitle ($;$) { #{{{ 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/_/ /; + return $page; } #}}} @@ -406,6 +444,7 @@ sub htmllink ($$$;$$$) { #{{{ $bestlink=htmlpage($bestlink); } if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) { + return $linktext unless length $config{cgiurl}; return " "create", page => lc($link), from => $page). "\">?$linktext" @@ -502,7 +541,13 @@ sub preprocess ($$$;$) { #{{{ 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, @@ -548,7 +593,7 @@ sub lockwiki () { #{{{ debug("wiki seems to be locked, waiting for lock"); my $wait=600; # arbitrary, but don't hang forever to # prevent process pileup - for (1..600) { + for (1..$wait) { return if flock(WIKILOCK, 2 | 4); sleep 1; } @@ -597,8 +642,9 @@ sub saveindex () { #{{{ if (! -d $config{wikistatedir}) { mkdir($config{wikistatedir}); } - open (OUT, ">$config{wikistatedir}/index") || - error("cannot write to $config{wikistatedir}/index: $!"); + my $newfile="$config{wikistatedir}/index.new"; + my $cleanup = sub { unlink($newfile) }; + open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup); foreach my $page (keys %oldpagemtime) { next unless $oldpagemtime{$page}; my $line="mtime=$oldpagemtime{$page} ". @@ -610,23 +656,42 @@ sub saveindex () { #{{{ if (exists $depends{$page}) { $line.=" depends=".encode_entities($depends{$page}, " \t\n"); } - print OUT $line."\n"; + print OUT $line."\n" || error("failed writing to $newfile: $!", $cleanup); } - close OUT; + close OUT || error("failed saving to $newfile: $!", $cleanup); + rename($newfile, "$config{wikistatedir}/index") || + error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup); +} #}}} + +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 (@) { #{{{ - my $filename=shift; - + my $filename=template_file(shift); + + if (! defined $filename) { + return if wantarray; + return ""; + } + require HTML::Template; - return filter => sub { + my @ret=( + filter => sub { 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, - @_; + @_ + ); + return wantarray ? @ret : {@ret}; } #}}} sub template ($;@) { #{{{ @@ -722,6 +787,49 @@ sub safequote ($) { #{{{ 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; @@ -762,49 +870,46 @@ sub pagespec_translate ($) { #{{{ 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 { - $code.=" match_glob(\$page, ".safequote($word).")"; + $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)"; } } 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 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 pagespec_match ($$) { #{{{ +sub pagespec_match ($$;$) { #{{{ my $page=shift; my $spec=shift; + my $from=shift; return eval pagespec_translate($spec); } #}}} -sub match_glob ($$) { #{{{ +package IkiWiki::PageSpec; + +sub match_glob ($$$) { #{{{ 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); @@ -818,7 +923,7 @@ sub match_link ($$) { #{{{ 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; } @@ -833,8 +938,8 @@ sub match_created_before ($$) { #{{{ 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; @@ -845,8 +950,8 @@ sub match_created_after ($$) { #{{{ 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; @@ -854,15 +959,15 @@ sub match_created_after ($$) { #{{{ } #}}} sub match_creation_day ($$) { #{{{ - return ((gmtime($pagectime{shift()}))[3] == shift); + return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift); } #}}} sub match_creation_month ($$) { #{{{ - return ((gmtime($pagectime{shift()}))[4] + 1 == shift); + return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift); } #}}} sub match_creation_year ($$) { #{{{ - return ((gmtime($pagectime{shift()}))[5] + 1900 == shift); + return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift); } #}}} 1