X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1e5cd11635ef45e8223f56b952c8636d993e5908..a0f55abe072d19b623c65e74f2ede905d4c3f997:/IkiWiki.pm diff --git a/IkiWiki.pm b/IkiWiki.pm index 88dcdcb5b..1c15e9299 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -11,12 +11,13 @@ use open qw{:utf8 :std}; use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase %renderedfiles %oldrenderedfiles %pagesources %destsources - %depends %hooks %forcerebuild $gettext_obj}; + %depends %hooks %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 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 @@ -29,24 +30,26 @@ memoize("pagespec_translate"); 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]+) # 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+)):?(.*)/, @@ -81,6 +84,7 @@ sub defaultconfig () { #{{{ pingurl => [], templatedir => "$installdir/share/ikiwiki/templates", underlaydir => "$installdir/share/ikiwiki/basewiki", + underlaydirs => [], setup => undef, adminuser => undef, adminemail => undef, @@ -96,7 +100,7 @@ sub defaultconfig () { #{{{ numbacklinks => 10, account_creation_password => "", } #}}} - + sub checkconfig () { #{{{ # locale stuff; avoid LC_ALL since it overrides everything if (defined $ENV{LC_ALL}) { @@ -138,11 +142,13 @@ sub checkconfig () { #{{{ } 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}}; @@ -153,6 +159,8 @@ sub loadplugins () { #{{{ foreach grep /^-/, @ARGV; usage(); } + + return 1; } #}}} sub loadplugin ($) { #{{{ @@ -160,11 +168,21 @@ sub loadplugin ($) { #{{{ return if grep { $_ eq $plugin} @{$config{disable_plugins}}; + 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"; + return 1; + } + } + my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin); eval qq{use $mod}; if ($@) { error("Failed to load plugin $mod: $@"); } + return 1; } #}}} sub error ($;$) { #{{{ @@ -184,7 +202,7 @@ sub error ($;$) { #{{{ sub debug ($) { #{{{ return unless $config{verbose}; - log_message(debug => @_); + return log_message(debug => @_); } #}}} my $log_open=0; @@ -193,20 +211,20 @@ sub log_message ($$) { #{{{ 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"; } } #}}} @@ -236,7 +254,7 @@ sub pagetype ($) { #{{{ if ($page =~ /\.([^.]+)$/) { return $1 if exists $hooks{htmlize}{$1}; } - return undef; + return; } #}}} sub pagename ($) { #{{{ @@ -269,8 +287,24 @@ sub srcfile ($) { #{{{ 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 ($;$$) { #{{{ @@ -283,11 +317,11 @@ sub readfile ($;$$) { #{{{ } local $/=undef; - open (IN, $file) || error("failed to read $file: $!"); - binmode(IN) if ($binary); - return \*IN if $wantfd; - my $ret=; - close IN || 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 $in || error("failed to read $file: $!"); return $ret; } #}}} @@ -322,17 +356,19 @@ sub writefile ($$$;$$) { #{{{ } my $cleanup = sub { unlink($newfile) }; - open (OUT, ">$newfile") || error("failed to write $newfile: $!", $cleanup); - binmode(OUT) if ($binary); + open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup); + binmode($out) if ($binary); if ($writer) { - $writer->(\*OUT, $cleanup); + $writer->(\*$out, $cleanup); } else { - print OUT $content or error("failed writing to $newfile: $!", $cleanup); + print $out $content or error("failed writing to $newfile: $!", $cleanup); } - close OUT || error("failed saving $newfile: $!", $cleanup); + close $out || error("failed saving $newfile: $!", $cleanup); rename($newfile, "$destdir/$file") || error("failed renaming $newfile to $destdir/$file: $!", $cleanup); + + return 1; } #}}} my %cleared; @@ -358,6 +394,8 @@ sub will_render ($$;$) { #{{{ $cleared{$page}=1; } $destsources{$dest}=$page; + + return 1; } #}}} sub bestlink ($$) { #{{{ @@ -400,7 +438,7 @@ sub bestlink ($$) { #{{{ sub isinlinableimage ($) { #{{{ my $file=shift; - $file=~/\.(png|gif|jpg|jpeg)$/i; + return $file =~ /\.(png|gif|jpg|jpeg)$/i; } #}}} sub pagetitle ($;$) { #{{{ @@ -546,7 +584,15 @@ sub htmllink ($$$;@) { #{{{ $bestlink.="#".$opts{anchor}; } - return "$linktext"; + my @attrs; + if (defined $opts{rel}) { + push @attrs, ' rel="'.$opts{rel}.'"'; + } + if (defined $opts{class}) { + push @attrs, ' class="'.$opts{class}.'"'; + } + + return "$linktext"; } #}}} sub htmlize ($$$) { #{{{ @@ -612,7 +658,7 @@ sub preprocess ($$$;$$) { #{{{ my $command=shift; my $params=shift; if (length $escape) { - return "\\[[$command $params]]"; + return "[[$command $params]]"; } elsif (exists $hooks{preprocess}{$command}) { return "" if $scan && ! $hooks{preprocess}{$command}{scan}; @@ -673,7 +719,7 @@ sub preprocess ($$$;$$) { #{{{ return $ret; } else { - return "\\[[$command $params]]"; + return "[[$command $params]]"; } }; @@ -718,6 +764,8 @@ sub indexlink () { #{{{ return "$config{wikiname}"; } #}}} +my $wikilock; + sub lockwiki (;$) { #{{{ my $wait=@_ ? shift : 1; # Take an exclusive lock on the wiki to prevent multiple concurrent @@ -725,15 +773,15 @@ sub lockwiki (;$) { #{{{ 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?)"); @@ -746,35 +794,40 @@ sub lockwiki (;$) { #{{{ } #}}} 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 (IN, "$config{wikistatedir}/index") || return; - while () { + open (my $in, "<", "$config{wikistatedir}/index") || return; + while (<$in>) { $_=possibly_foolish_untaint($_); chomp; my %items; @@ -801,7 +854,7 @@ sub loadindex () { #{{{ $oldrenderedfiles{$page}=[@{$items{dest}}]; $pagectime{$page}=$items{ctime}[0]; } - close IN; + return close($in); } #}}} sub saveindex () { #{{{ @@ -812,7 +865,7 @@ sub saveindex () { #{{{ } my $newfile="$config{wikistatedir}/index.new"; my $cleanup = sub { unlink($newfile) }; - open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup); + open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup); foreach my $page (keys %pagemtime) { next unless $pagemtime{$page}; my $line="mtime=$pagemtime{$page} ". @@ -824,11 +877,13 @@ sub saveindex () { #{{{ if (exists $depends{$page}) { $line.=" depends=".encode_entities($depends{$page}, " \t\n"); } - print OUT $line."\n" || error("failed writing to $newfile: $!", $cleanup); + print $out $line."\n" || error("failed writing to $newfile: $!", $cleanup); } - close OUT || error("failed saving to $newfile: $!", $cleanup); + 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 ($) { #{{{ @@ -837,7 +892,7 @@ 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 (@) { #{{{ @@ -851,7 +906,7 @@ 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, @@ -863,7 +918,7 @@ sub template_params (@) { #{{{ sub template ($;@) { #{{{ require HTML::Template; - HTML::Template->new(template_params(@_)); + return HTML::Template->new(template_params(@_)); } #}}} sub misctemplate ($$;@) { #{{{ @@ -889,12 +944,13 @@ sub hook (@) { # {{{ 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 ($$) { # {{{ @@ -916,6 +972,8 @@ sub run_hooks ($$) { # {{{ $sub->($hooks{$type}{$id}{call}); } } + + return 1; } #}}} sub globlist_to_pagespec ($) { #{{{ @@ -931,9 +989,9 @@ 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)"; } @@ -946,7 +1004,7 @@ sub globlist_to_pagespec ($) { #{{{ 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 ($) { #{{{ @@ -965,21 +1023,25 @@ sub add_depends ($$) { #{{{ 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}; @@ -1036,28 +1098,28 @@ sub pagespec_translate ($) { #{{{ | \) # ) | - \w+\([^\)]+\) # command(params) + \w+\([^\)]*\) # command(params) | [^\s()]+ # any other text ) \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 { @@ -1075,11 +1137,11 @@ sub pagespec_match ($$;@) { #{{{ # 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; } #}}} @@ -1093,7 +1155,7 @@ use overload ( #{{{ ); #}}} sub new { #{{{ - bless \$_[1], $_[0]; + return bless \$_[1], $_[0]; } #}}} package IkiWiki::SuccessReason; @@ -1106,7 +1168,7 @@ use overload ( #{{{ ); #}}} sub new { #{{{ - bless \$_[1], $_[0]; + return bless \$_[1], $_[0]; }; #}}} package IkiWiki::PageSpec; @@ -1116,7 +1178,7 @@ sub match_glob ($$;@) { #{{{ my $glob=shift; my %params=@_; - my $from=exists $params{location} ? $params{location} : ""; + my $from=exists $params{location} ? $params{location} : ''; # relative matching if ($glob =~ m!^\./!) { @@ -1143,7 +1205,7 @@ sub match_link ($$;@) { #{{{ 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) { @@ -1152,10 +1214,10 @@ sub match_link ($$;@) { #{{{ $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); @@ -1169,7 +1231,7 @@ sub match_link ($$;@) { #{{{ } #}}} sub match_backlink ($$;@) { #{{{ - match_link($_[1], $_[0], @_); + return match_link($_[1], $_[0], @_); } #}}} sub match_created_before ($$;@) { #{{{ @@ -1178,10 +1240,10 @@ 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 { @@ -1195,10 +1257,10 @@ sub match_created_after ($$;@) { #{{{ 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 { @@ -1208,28 +1270,28 @@ sub match_created_after ($$;@) { #{{{ 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'); } } #}}} @@ -1238,7 +1300,8 @@ sub match_user ($$;@) { #{{{ 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") }