X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d1d212203c72072d9a42f66c171dc6be83225894..a04c959af5a8ea38b3b00a4e698e4e36aae79795:/IkiWiki.pm
diff --git a/IkiWiki.pm b/IkiWiki.pm
index 7002b55be..990836f8e 100644
--- a/IkiWiki.pm
+++ b/IkiWiki.pm
@@ -3,18 +3,28 @@
package IkiWiki;
use warnings;
use strict;
+use Encode;
+use HTML::Entities;
+use open qw{:utf8 :std};
-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
- %renderedfiles %pagesources %depends %hooks};
+# Optimisation.
+use Memoize;
+memoize("abs2rel");
+memoize("pagespec_translate");
+
+use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
+ %renderedfiles %pagesources %depends %hooks %forcerebuild};
+
+my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
sub defaultconfig () { #{{{
- wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
+ wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?html?$|\.rss$)},
wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
- wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,
wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
verbose => 0,
+ syslog => 0,
wikiname => "wiki",
- default_pageext => ".mdwn",
+ default_pageext => "mdwn",
cgi => 0,
rcs => 'svn',
notify => 0,
@@ -28,6 +38,7 @@ sub defaultconfig () { #{{{
rebuild => 0,
refresh => 0,
getctime => 0,
+ w3mmode => 0,
wrapper => undef,
wrappermode => undef,
svnrepo => undef,
@@ -35,16 +46,38 @@ sub defaultconfig () { #{{{
srcdir => undef,
destdir => undef,
pingurl => [],
- templatedir => "/usr/share/ikiwiki/templates",
- underlaydir => "/usr/share/ikiwiki/basewiki",
+ templatedir => "$installdir/share/ikiwiki/templates",
+ underlaydir => "$installdir/share/ikiwiki/basewiki",
setup => undef,
adminuser => undef,
adminemail => undef,
- plugin => [qw{inline htmlscrubber}],
+ plugin => [qw{mdwn inline htmlscrubber}],
timeformat => '%c',
+ locale => undef,
+ sslcookie => 0,
} #}}}
-
+
sub checkconfig () { #{{{
+ # locale stuff; avoid LC_ALL since it overrides everything
+ if (defined $ENV{LC_ALL}) {
+ $ENV{LANG} = $ENV{LC_ALL};
+ delete $ENV{LC_ALL};
+ }
+ if (defined $config{locale}) {
+ eval q{use POSIX};
+ $ENV{LANG} = $config{locale}
+ if POSIX::setlocale(&POSIX::LC_TIME, $config{locale});
+ }
+
+ if ($config{w3mmode}) {
+ eval q{use Cwd q{abs_path}};
+ $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
+ $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
+ $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
+ unless $config{cgiurl} =~ m!file:///!;
+ $config{url}="file://".$config{destdir};
+ }
+
if ($config{cgi} && ! length $config{url}) {
error("Must specify url to wiki with --url when using --cgi\n");
}
@@ -65,6 +98,10 @@ sub checkconfig () { #{{{
require IkiWiki::Rcs::Stub;
}
+ run_hooks(checkconfig => sub { shift->() });
+} #}}}
+
+sub loadplugins () { #{{{
foreach my $plugin (@{$config{plugin}}) {
my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
eval qq{use $mod};
@@ -72,12 +109,12 @@ sub checkconfig () { #{{{
error("Failed to load plugin $mod: $@");
}
}
-
- if (exists $hooks{checkconfig}) {
- foreach my $id (keys %{$hooks{checkconfig}}) {
- $hooks{checkconfig}{$id}{call}->();
- }
- }
+ run_hooks(getopt => sub { shift->() });
+ if (grep /^-/, @ARGV) {
+ print STDERR "Unknown option: $_\n"
+ foreach grep /^-/, @ARGV;
+ usage();
+ }
} #}}}
sub error ($) { #{{{
@@ -85,12 +122,31 @@ sub error ($) { #{{{
print "Content-type: text/html\n\n";
print misctemplate("Error", "Error: @_
");
}
- die @_;
+ log_message(error => @_);
+ exit(1);
} #}}}
sub debug ($) { #{{{
return unless $config{verbose};
- if (! $config{cgi}) {
+ log_message(debug => @_);
+} #}}}
+
+my $log_open=0;
+sub log_message ($$) { #{{{
+ my $type=shift;
+
+ if ($config{syslog}) {
+ require Sys::Syslog;
+ unless ($log_open) {
+ Sys::Syslog::setlogsock('unix');
+ Sys::Syslog::openlog('ikiwiki', '', 'user');
+ $log_open=1;
+ }
+ eval {
+ Sys::Syslog::syslog($type, join(" ", @_));
+ }
+ }
+ elsif (! $config{cgi}) {
print "@_\n";
}
else {
@@ -121,12 +177,10 @@ sub dirname ($) { #{{{
sub pagetype ($) { #{{{
my $page=shift;
- if ($page =~ /\.mdwn$/) {
- return ".mdwn";
- }
- else {
- return "unknown";
+ if ($page =~ /\.([^.]+)$/) {
+ return $1 if exists $hooks{htmlize}{$1};
}
+ return undef;
} #}}}
sub pagename ($) { #{{{
@@ -134,7 +188,7 @@ sub pagename ($) { #{{{
my $type=pagetype($file);
my $page=$file;
- $page=~s/\Q$type\E*$// unless $type eq 'unknown';
+ $page=~s/\Q.$type\E*$// if defined $type;
return $page;
} #}}}
@@ -162,12 +216,7 @@ sub readfile ($;$) { #{{{
local $/=undef;
open (IN, $file) || error("failed to read $file: $!");
- if (! $binary) {
- binmode(IN, ":utf8");
- }
- else {
- binmode(IN);
- }
+ binmode(IN) if ($binary);
my $ret=;
close IN;
return $ret;
@@ -199,12 +248,7 @@ sub writefile ($$$;$) { #{{{
}
open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
- if (! $binary) {
- binmode(OUT, ":utf8");
- }
- else {
- binmode(OUT);
- }
+ binmode(OUT) if ($binary);
print OUT $content;
close OUT;
} #}}}
@@ -216,7 +260,7 @@ sub bestlink ($$) { #{{{
# goes down the directory tree to the base looking for matching
# pages.
my $page=shift;
- my $link=lc(shift);
+ my $link=shift;
my $cwd=$page;
do {
@@ -225,9 +269,11 @@ sub bestlink ($$) { #{{{
$l.=$link;
if (exists $links{$l}) {
- #debug("for $page, \"$link\", use $l");
return $l;
}
+ elsif (exists $pagecase{lc $l}) {
+ return $pagecase{lc $l};
+ }
} while $cwd=~s!/?[^/]+$!!;
#print STDERR "warning: page $page, broken link: $link\n";
@@ -260,14 +306,27 @@ sub cgiurl (@) { #{{{
return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
} #}}}
-sub styleurl (;$) { #{{{
+sub baseurl (;$) { #{{{
my $page=shift;
- return "$config{url}/style.css" if ! defined $page;
+ return "$config{url}/" if ! defined $page;
$page=~s/[^\/]+$//;
$page=~s/[^\/]+\//..\//g;
- return $page."style.css";
+ return $page;
+} #}}}
+
+sub abs2rel ($$) { #{{{
+ # Work around very innefficient behavior in File::Spec if abs2rel
+ # is passed two relative paths. It's much faster if paths are
+ # absolute!
+ my $path="/".shift;
+ my $base="/".shift;
+
+ require File::Spec;
+ my $ret=File::Spec->abs2rel($path, $base);
+ $ret=~s/^// if defined $ret;
+ return $ret;
} #}}}
sub htmllink ($$$;$$$) { #{{{
@@ -288,7 +347,8 @@ sub htmllink ($$$;$$$) { #{{{
$linktext=pagetitle(basename($link)) unless defined $linktext;
- return $linktext if length $bestlink && $page eq $bestlink;
+ return "$linktext"
+ if length $bestlink && $page eq $bestlink;
# TODO BUG: %renderedfiles may not have it, if the linked to page
# was also added and isn't yet rendered! Note that this bug is
@@ -298,12 +358,11 @@ sub htmllink ($$$;$$$) { #{{{
}
if (! grep { $_ eq $bestlink } values %renderedfiles) {
return " "create", page => $link, from => $page).
+ cgiurl(do => "create", page => lc($link), from => $page).
"\">?$linktext"
}
- require File::Spec;
- $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
+ $bestlink=abs2rel($bestlink, dirname($page));
if (! $noimageinline && isinlinableimage($bestlink)) {
return "![\"$linktext\"](\"$bestlink\")
";
@@ -348,7 +407,7 @@ sub loadindex () { #{{{
$items{link}=[];
foreach my $i (split(/ /, $_)) {
my ($item, $val)=split(/=/, $i, 2);
- push @{$items{$item}}, $val;
+ push @{$items{$item}}, decode_entities($val);
}
next unless exists $items{src}; # skip bad lines for now
@@ -359,9 +418,9 @@ sub loadindex () { #{{{
$oldpagemtime{$page}=$items{mtime}[0];
$oldlinks{$page}=[@{$items{link}}];
$links{$page}=[@{$items{link}}];
- $depends{$page}=join(" ", @{$items{depends}})
- if exists $items{depends};
+ $depends{$page}=$items{depends}[0] if exists $items{depends};
$renderedfiles{$page}=$items{dest}[0];
+ $pagecase{lc $page}=$page;
}
$pagectime{$page}=$items{ctime}[0];
}
@@ -369,6 +428,8 @@ sub loadindex () { #{{{
} #}}}
sub saveindex () { #{{{
+ run_hooks(savestate => sub { shift->() });
+
if (! -d $config{wikistatedir}) {
mkdir($config{wikistatedir});
}
@@ -382,7 +443,7 @@ sub saveindex () { #{{{
"dest=$renderedfiles{$page}";
$line.=" link=$_" foreach @{$links{$page}};
if (exists $depends{$page}) {
- $line.=" depends=$_" foreach split " ", $depends{$page};
+ $line.=" depends=".encode_entities($depends{$page}, " \t\n");
}
print OUT $line."\n";
}
@@ -392,10 +453,15 @@ sub saveindex () { #{{{
sub template_params (@) { #{{{
my $filename=shift;
- require Encode;
require HTML::Template;
- return filter => \&Encode::decode_utf8,
- filename => "$config{templatedir}/$filename", @_;
+ return filter => sub {
+ my $text_ref = shift;
+ $$text_ref=&Encode::decode_utf8($$text_ref);
+ },
+ filename => "$config{templatedir}/$filename",
+ loop_context_vars => 1,
+ die_on_bad_params => 0,
+ @_;
} #}}}
sub template ($;@) { #{{{
@@ -412,63 +478,190 @@ sub misctemplate ($$) { #{{{
indexlink => indexlink(),
wikiname => $config{wikiname},
pagebody => $pagebody,
- styleurl => styleurl(),
- baseurl => "$config{url}/",
+ baseurl => baseurl(),
);
return $template->output;
}#}}}
-sub glob_match ($$) { #{{{
- my $page=shift;
- my $glob=shift;
+sub hook (@) { # {{{
+ my %param=@_;
+
+ if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
+ error "hook requires type, call, and id parameters";
+ }
+
+ $hooks{$param{type}}{$param{id}}=\%param;
+} # }}}
- if ($glob =~ /^link\((.+)\)$/) {
- my $rev = $links{$page} or return undef;
- foreach my $p (@$rev) {
- return 1 if lc $p eq $1;
- }
- return 0;
- } elsif ($glob =~ /^backlink\((.+)\)$/) {
- my $rev = $links{$1} or return undef;
- foreach my $p (@$rev) {
- return 1 if lc $p eq $page;
+sub run_hooks ($$) { # {{{
+ # Calls the given sub for each hook of the given type,
+ # passing it the hook function to call.
+ my $type=shift;
+ my $sub=shift;
+
+ if (exists $hooks{$type}) {
+ foreach my $id (keys %{$hooks{$type}}) {
+ $sub->($hooks{$type}{$id}{call});
}
- return 0;
- } else {
- # turn glob into safe regexp
- $glob=quotemeta($glob);
- $glob=~s/\\\*/.*/g;
- $glob=~s/\\\?/./g;
- $glob=~s!\\/!/!g;
-
- return $page=~/^$glob$/i;
}
} #}}}
-sub globlist_match ($$) { #{{{
- my $page=shift;
- my @globlist=split(" ", shift);
+sub globlist_to_pagespec ($) { #{{{
+ my @globlist=split(' ', shift);
- # check any negated globs first
+ my (@spec, @skip);
foreach my $glob (@globlist) {
- return 0 if $glob=~/^!(.*)/ && glob_match($page, $1);
+ if ($glob=~/^!(.*)/) {
+ push @skip, $glob;
+ }
+ else {
+ push @spec, $glob;
+ }
}
- foreach my $glob (@globlist) {
- return 1 if glob_match($page, $glob);
+ my $spec=join(" or ", @spec);
+ if (@skip) {
+ my $skip=join(" and ", @skip);
+ if (length $spec) {
+ $spec="$skip and ($spec)";
+ }
+ else {
+ $spec=$skip;
+ }
+ }
+ return $spec;
+} #}}}
+
+sub is_globlist ($) { #{{{
+ my $s=shift;
+ $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
+} #}}}
+
+sub safequote ($) { #{{{
+ my $s=shift;
+ $s=~s/[{}]//g;
+ return "q{$s}";
+} #}}}
+
+sub pagespec_merge ($$) { #{{{
+ my $a=shift;
+ my $b=shift;
+
+ return $a if $a eq $b;
+
+ # Support for old-style GlobLists.
+ if (is_globlist($a)) {
+ $a=globlist_to_pagespec($a);
+ }
+ if (is_globlist($b)) {
+ $b=globlist_to_pagespec($b);
+ }
+
+ return "($a) or ($b)";
+} #}}}
+
+sub pagespec_translate ($) { #{{{
+ # This assumes that $page is in scope in the function
+ # that evalulates the translated pagespec code.
+ my $spec=shift;
+
+ # Support for old-style GlobLists.
+ if (is_globlist($spec)) {
+ $spec=globlist_to_pagespec($spec);
+ }
+
+ # Convert spec to perl code.
+ my $code="";
+ while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
+ my $word=$1;
+ if (lc $word eq "and") {
+ $code.=" &&";
+ }
+ elsif (lc $word eq "or") {
+ $code.=" ||";
+ }
+ 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).")";
+ }
+ else {
+ $code.=" match_glob(\$page, ".safequote($word).")";
+ }
+ }
+
+ return $code;
+} #}}}
+
+sub pagespec_match ($$) { #{{{
+ my $page=shift;
+ my $spec=shift;
+
+ return eval pagespec_translate($spec);
+} #}}}
+
+sub match_glob ($$) { #{{{
+ my $page=shift;
+ my $glob=shift;
+
+ # turn glob into safe regexp
+ $glob=quotemeta($glob);
+ $glob=~s/\\\*/.*/g;
+ $glob=~s/\\\?/./g;
+
+ return $page=~/^$glob$/i;
+} #}}}
+
+sub match_link ($$) { #{{{
+ my $page=shift;
+ my $link=lc(shift);
+
+ my $links = $links{$page} or return undef;
+ foreach my $p (@$links) {
+ return 1 if lc $p eq $link;
}
-
return 0;
} #}}}
-sub hook (@) { # {{{
- my %param=@_;
-
- if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
- error "hook requires type, call, and id parameters";
+sub match_backlink ($$) { #{{{
+ match_link(pop, pop);
+} #}}}
+
+sub match_created_before ($$) { #{{{
+ my $page=shift;
+ my $testpage=shift;
+
+ if (exists $pagectime{$testpage}) {
+ return $pagectime{$page} < $pagectime{$testpage};
}
-
- $hooks{$param{type}}{$param{id}}=\%param;
-} # }}}
+ else {
+ return 0;
+ }
+} #}}}
+
+sub match_created_after ($$) { #{{{
+ my $page=shift;
+ my $testpage=shift;
+
+ if (exists $pagectime{$testpage}) {
+ return $pagectime{$page} > $pagectime{$testpage};
+ }
+ else {
+ return 0;
+ }
+} #}}}
+
+sub match_creation_day ($$) { #{{{
+ return ((gmtime($pagectime{shift()}))[3] == shift);
+} #}}}
+
+sub match_creation_month ($$) { #{{{
+ return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
+} #}}}
+
+sub match_creation_year ($$) { #{{{
+ return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);
+} #}}}
1