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 %renderedfiles %pagesources %destsources);
our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
memoize("file_pruned");
sub defaultconfig () { #{{{
+ return
wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
qr/\.x?html?$/, qr/\.ikiwiki-new$/,
qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
+ qr/(^|\/)_MTN\//,
qr/\.dpkg-tmp$/],
wiki_link_regexp => qr{
- \[\[ # beginning of link
+ \[\[ # beginning of link
(?:
- ([^\]\|]+) # 1: link text
- \| # followed by '|'
- )? # optional
-
- ([^\s\]#]+) # 2: page to link to
+ ([^\]\|\n\s]+) # 1: link text
+ \| # followed by '|'
+ )? # optional
+
+ ([^\s\]#]+) # 2: page to link to
(?:
- \# # '#', beginning of anchor
- ([^\s\]]+) # 3: anchor text
- )? # optional
-
- \]\] # end of link
+ \# # '#', beginning of anchor
+ ([^\s\]]+) # 3: anchor text
+ )? # optional
+
+ \]\] # end of link
}x,
wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
pingurl => [],
templatedir => "$installdir/share/ikiwiki/templates",
underlaydir => "$installdir/share/ikiwiki/basewiki",
+ underlaydirs => [],
setup => undef,
adminuser => undef,
adminemail => undef,
}
run_hooks(checkconfig => sub { shift->() });
+
+ return 1;
} #}}}
sub loadplugins () { #{{{
if (defined $config{libdir}) {
- unshift @INC, $config{libdir};
+ unshift @INC, possibly_foolish_untaint($config{libdir});
}
loadplugin($_) foreach @{$config{plugin}};
foreach grep /^-/, @ARGV;
usage();
}
+
+ return 1;
} #}}}
sub loadplugin ($) { #{{{
return if grep { $_ eq $plugin} @{$config{disable_plugins}};
- foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
+ 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;
import IkiWiki::Plugin::external "$dir/plugins/$plugin";
sub debug ($) { #{{{
return unless $config{verbose};
- log_message(debug => @_);
+ return log_message(debug => @_);
} #}}}
my $log_open=0;
if ($config{syslog}) {
require Sys::Syslog;
- unless ($log_open) {
+ if (! $log_open) {
Sys::Syslog::setlogsock('unix');
Sys::Syslog::openlog('ikiwiki', '', 'user');
$log_open=1;
}
- eval {
+ return eval {
Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
};
}
elsif (! $config{cgi}) {
- print "@_\n";
+ return print "@_\n";
}
else {
- print STDERR "@_\n";
+ return print STDERR "@_\n";
}
} #}}}
if ($page =~ /\.([^.]+)$/) {
return $1 if exists $hooks{htmlize}{$1};
}
- return undef;
+ return;
} #}}}
sub pagename ($) { #{{{
my $file=shift;
return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
- return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
- error("internal error: $file cannot be found in $config{srcdir} or $config{underlaydir}");
+ foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
+ return "$dir/$file" if -e "$dir/$file";
+ }
+ error("internal error: $file cannot be found in $config{srcdir} or underlay");
+ return;
+} #}}}
+
+sub add_underlay ($) { #{{{
+ my $dir=shift;
+
+ if ($dir=~/^\//) {
+ unshift @{$config{underlaydirs}}, $dir;
+ }
+ else {
+ unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
+ }
+
+ return 1;
} #}}}
sub readfile ($;$$) { #{{{
}
local $/=undef;
- open (my $in, $file) || error("failed to read $file: $!");
+ open (my $in, "<", $file) || error("failed to read $file: $!");
binmode($in) if ($binary);
return \*$in if $wantfd;
my $ret=<$in>;
close $out || error("failed saving $newfile: $!", $cleanup);
rename($newfile, "$destdir/$file") ||
error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
+
+ return 1;
} #}}}
my %cleared;
$cleared{$page}=1;
}
$destsources{$dest}=$page;
+
+ return 1;
} #}}}
sub bestlink ($$) { #{{{
sub isinlinableimage ($) { #{{{
my $file=shift;
- $file=~/\.(png|gif|jpg|jpeg)$/i;
+ return $file =~ /\.(png|gif|jpg|jpeg)$/i;
} #}}}
sub pagetitle ($;$) { #{{{
if (! $destsources{$bestlink}) {
return $linktext unless length $config{cgiurl};
- return "<span><a href=\"".
+ return "<span
class=\"createlink\"><a href=\"".
cgiurl(
do => "create",
page => pagetitle(lc($link), 1),
if (defined $opts{rel}) {
push @attrs, ' rel="'.$opts{rel}.'"';
}
+ if (defined $opts{class}) {
+ push @attrs, ' class="'.$opts{class}.'"';
+ }
return "<a href=\"$bestlink\"@attrs>$linktext</a>";
} #}}}
return "<a href=\"$config{url}\">$config{wikiname}</a>";
} #}}}
+my $wikilock;
+
sub lockwiki (;$) { #{{{
my $wait=@_ ? shift : 1;
# Take an exclusive lock on the wiki to prevent multiple concurrent
if (! -d $config{wikistatedir}) {
mkdir($config{wikistatedir});
}
- open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
+ open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
error ("cannot write to $config{wikistatedir}/lockfile: $!");
- if (! flock(WIKILOCK, 2 | 4)) { # LOCK_EX | LOCK_NB
+ if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
if ($wait) {
debug("wiki seems to be locked, waiting for lock");
my $wait=600; # arbitrary, but don't hang forever to
# prevent process pileup
for (1..$wait) {
- return if flock(WIKILOCK, 2 | 4);
+ return if flock($wikilock, 2 | 4);
sleep 1;
}
error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
} #}}}
sub unlockwiki () { #{{{
- close WIKILOCK;
+ return close($wikilock) if $wikilock;
+ return;
} #}}}
+my $commitlock;
+
sub commit_hook_enabled () { #{{{
- open(COMMITLOCK, "+>$config{wikistatedir}/commitlock") ||
- error ("cannot write to $config{wikistatedir}/commitlock: $!");
- if (! flock(COMMITLOCK, 1 | 4)) { # LOCK_SH | LOCK_NB to test
- close COMMITLOCK;
+ open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
+ error("cannot write to $config{wikistatedir}/commitlock: $!");
+ if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
+ close($commitlock) || error("failed closing commitlock: $!");
return 0;
}
- close COMMITLOCK;
+ close($commitlock) || error("failed closing commitlock: $!");
return 1;
} #}}}
sub disable_commit_hook () { #{{{
- open(COMMITLOCK, ">$config{wikistatedir}/commitlock") ||
- error ("cannot write to $config{wikistatedir}/commitlock: $!");
- if (! flock(COMMITLOCK, 2)) { # LOCK_EX
+ open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
+ error("cannot write to $config{wikistatedir}/commitlock: $!");
+ if (! flock($commitlock, 2)) { # LOCK_EX
error("failed to get commit lock");
}
+ return 1;
} #}}}
sub enable_commit_hook () { #{{{
- close COMMITLOCK;
+ return close($commitlock) if $commitlock;
+ return;
} #}}}
sub loadindex () { #{{{
- open (my $in, "$config{wikistatedir}/index") || return;
+ %oldrenderedfiles=%pagectime=();
+ if (! $config{rebuild}) {
+ %pagesources=%pagemtime=%oldlinks=%links=%depends=
+ %destsources=%renderedfiles=%pagecase=();
+ }
+ open (my $in, "<", "$config{wikistatedir}/index") || return;
while (<$in>) {
$_=possibly_foolish_untaint($_);
chomp;
$oldrenderedfiles{$page}=[@{$items{dest}}];
$pagectime{$page}=$items{ctime}[0];
}
- close $in;
+ return close($in);
} #}}}
sub saveindex () { #{{{
close $out || error("failed saving to $newfile: $!", $cleanup);
rename($newfile, "$config{wikistatedir}/index") ||
error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
+
+ return 1;
} #}}}
sub template_file ($) { #{{{
foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
return "$dir/$template" if -e "$dir/$template";
}
- return undef;
+ return;
} #}}}
sub template_params (@) { #{{{
my @ret=(
filter => sub {
my $text_ref = shift;
- $$text_ref=&Encode::decode_utf8($$text_ref);
+ ${$text_ref} = decode_utf8(${$text_ref});
},
filename => $filename,
loop_context_vars => 1,
sub template ($;@) { #{{{
require HTML::Template;
- HTML::Template->new(template_params(@_));
+ return HTML::Template->new(template_params(@_));
} #}}}
sub misctemplate ($$;@) { #{{{
my %param=@_;
if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
- error "hook requires type, call, and id parameters";
+ 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;
+ return 1;
} # }}}
sub run_hooks ($$) { # {{{
$sub->($hooks{$type}{$id}{call});
}
}
+
+ return 1;
} #}}}
sub globlist_to_pagespec ($) { #{{{
}
}
- my $spec=join(" or ", @spec);
+ my $spec=join(' or ', @spec);
if (@skip) {
- my $skip=join(" and ", @skip);
+ my $skip=join(' and ', @skip);
if (length $spec) {
$spec="$skip and ($spec)";
}
sub is_globlist ($) { #{{{
my $s=shift;
- $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
+ return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
} #}}}
sub safequote ($) { #{{{
else {
$depends{$page}=pagespec_merge($depends{$page}, $pagespec);
}
+
+ return 1;
} # }}}
sub file_pruned ($$) { #{{{
require File::Spec;
my $file=File::Spec->canonpath(shift);
my $base=File::Spec->canonpath(shift);
- $file=~s#^\Q$base\E/*##;
+ $file =~ s#^\Q$base\E/*##;
my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
- $file =~ m/$regexp/;
+ return $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 ((exists $ENV{LANG} && length $ENV{LANG}) ||
+ (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
+ (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
if (! $gettext_obj) {
$gettext_obj=eval q{
use Locale::gettext q{textdomain};
\s* # ignore whitespace
}igx) {
my $word=$1;
- if (lc $word eq "and") {
- $code.=" &&";
+ if (lc $word eq 'and') {
+ $code.=' &&';
}
- elsif (lc $word eq "or") {
- $code.=" ||";
+ elsif (lc $word eq 'or') {
+ $code.=' ||';
}
elsif ($word eq "(" || $word eq ")" || $word eq "!") {
- $code.=" ".$word;
+ $code.=' '.$word;
}
elsif ($word =~ /^(\w+)\((.*)\)$/) {
if (exists $IkiWiki::PageSpec::{"match_$1"}) {
$code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";
}
else {
- $code.=" 0";
+ $code.=' 0';
}
}
else {
# Backwards compatability with old calling convention.
if (@params == 1) {
- unshift @params, "location";
+ unshift @params, 'location';
}
my $ret=eval pagespec_translate($spec);
- return IkiWiki::FailReason->new("syntax error") if $@;
+ return IkiWiki::FailReason->new('syntax error') if $@;
return $ret;
} #}}}
); #}}}
sub new { #{{{
- bless \$_[1], $_[0];
+ return bless \$_[1], $_[0];
} #}}}
package IkiWiki::SuccessReason;
); #}}}
sub new { #{{{
- bless \$_[1], $_[0];
+ return bless \$_[1], $_[0];
}; #}}}
package IkiWiki::PageSpec;
my $glob=shift;
my %params=@_;
- my $from=exists $params{location} ? $params{location} : "";
+ my $from=exists $params{location} ? $params{location} : '';
# relative matching
if ($glob =~ m!^\./!) {
my $link=lc(shift);
my %params=@_;
- my $from=exists $params{location} ? $params{location} : "";
+ my $from=exists $params{location} ? $params{location} : '';
# relative matching
if ($link =~ m!^\.! && defined $from) {
$link="$from/$link" if length $from;
}
- my $links = $IkiWiki::links{$page} or return undef;
- return IkiWiki::FailReason->new("$page has no links") unless @$links;
+ my $links = $IkiWiki::links{$page};
+ return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
my $bestlink = IkiWiki::bestlink($from, $link);
- foreach my $p (@$links) {
+ foreach my $p (@{$links}) {
if (length $bestlink) {
return IkiWiki::SuccessReason->new("$page links to $link")
if $bestlink eq IkiWiki::bestlink($page, $p);
}
else {
- return IkiWiki::SuccessReason->new("$page links to page matching $link")
+ return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
if match_glob($p, $link, %params);
}
}
} #}}}
sub match_backlink ($$;@) { #{{{
- match_link($_[1], $_[0], @_);
+ return match_link($_[1], $_[0], @_);
} #}}}
sub match_created_before ($$;@) { #{{{
if (exists $IkiWiki::pagectime{$testpage}) {
if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
- IkiWiki::SuccessReason->new("$page created before $testpage");
+ return IkiWiki::SuccessReason->new("$page created before $testpage");
}
else {
- IkiWiki::FailReason->new("$page not created before $testpage");
+ return IkiWiki::FailReason->new("$page not created before $testpage");
}
}
else {
if (exists $IkiWiki::pagectime{$testpage}) {
if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
- IkiWiki::SuccessReason->new("$page created after $testpage");
+ return IkiWiki::SuccessReason->new("$page created after $testpage");
}
else {
- IkiWiki::FailReason->new("$page not created after $testpage");
+ return IkiWiki::FailReason->new("$page not created after $testpage");
}
}
else {
sub match_creation_day ($$;@) { #{{{
if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
- return IkiWiki::SuccessReason->new("creation_day matched");
+ return IkiWiki::SuccessReason->new('creation_day matched');
}
else {
- return IkiWiki::FailReason->new("creation_day did not match");
+ return IkiWiki::FailReason->new('creation_day did not match');
}
} #}}}
sub match_creation_month ($$;@) { #{{{
if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
- return IkiWiki::SuccessReason->new("creation_month matched");
+ return IkiWiki::SuccessReason->new('creation_month matched');
}
else {
- return IkiWiki::FailReason->new("creation_month did not match");
+ return IkiWiki::FailReason->new('creation_month did not match');
}
} #}}}
sub match_creation_year ($$;@) { #{{{
if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
- return IkiWiki::SuccessReason->new("creation_year matched");
+ return IkiWiki::SuccessReason->new('creation_year matched');
}
else {
- return IkiWiki::FailReason->new("creation_year did not match");
+ return IkiWiki::FailReason->new('creation_year did not match');
}
} #}}}
my $user=shift;
my %params=@_;
- return IkiWiki::FailReason->new("cannot match user") unless exists $params{user};
+ return IkiWiki::FailReason->new('cannot match user')
+ unless exists $params{user};
if ($user eq $params{user}) {
return IkiWiki::SuccessReason->new("user is $user")
}
sipb-www / ikiwiki.git / blobdiff