#!/usr/bin/perl
package IkiWiki;
+
use warnings;
use strict;
use Encode;
use HTML::Entities;
+use URI::Escape q{uri_escape_utf8};
+use POSIX;
+use Storable;
use open qw{:utf8 :std};
-use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
- %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
- %forcerebuild $gettext_obj};
+use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
+ %pagestate %renderedfiles %oldrenderedfiles %pagesources
+ %destsources %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
- %config %links %renderedfiles %pagesources);
-our $VERSION = 1.01; # plugin interface version
+ displaytime will_render gettext urlto targetpage
+ add_underlay
+ %config %links %pagestate %renderedfiles
+ %pagesources %destsources);
+our $VERSION = 2.00; # 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;
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?$/,
- qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
- wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
+ 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_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
verbose => 0,
syslog => 0,
wikiname => "wiki",
default_pageext => "mdwn",
+ htmlext => "html",
cgi => 0,
+ post_commit => 0,
rcs => '',
- notify => 0,
url => '',
cgiurl => '',
historyurl => '',
diffurl => '',
rss => 0,
atom => 0,
+ allowrss => 0,
+ allowatom => 0,
discussion => 1,
rebuild => 0,
refresh => 0,
w3mmode => 0,
wrapper => undef,
wrappermode => undef,
- svnrepo => undef,
svnpath => "trunk",
gitorigin_branch => "origin",
gitmaster_branch => "master",
pingurl => [],
templatedir => "$installdir/share/ikiwiki/templates",
underlaydir => "$installdir/share/ikiwiki/basewiki",
+ underlaydirs => [],
setup => undef,
adminuser => undef,
adminemail => undef,
- plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit lockedit}],
+ plugin => [qw{mdwn link inline htmlscrubber passwordauth openid
+ signinedit lockedit conditional recentchanges}],
+ libdir => undef,
timeformat => '%c',
locale => undef,
sslcookie => 0,
httpauth => 0,
userdir => "",
+ usedirs => 1,
+ numbacklinks => 10,
+ account_creation_password => "",
+ prefix_directives => 0,
+ hardlink => 0,
+ cgi_disable_uploads => 1,
} #}}}
-
+
sub checkconfig () { #{{{
# locale stuff; avoid LC_ALL since it overrides everything
if (defined $ENV{LC_ALL}) {
delete $ENV{LC_ALL};
}
if (defined $config{locale}) {
- eval q{use POSIX};
- error($@) if $@;
if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
$ENV{LANG}=$config{locale};
$gettext_obj=undef;
}
}
+ 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 $@;
unless exists $config{wikistatedir};
if ($config{rcs}) {
- eval qq{require IkiWiki::Rcs::$config{rcs}};
+ eval qq{use IkiWiki::Rcs::$config{rcs}};
if ($@) {
error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
}
require IkiWiki::Rcs::Stub;
}
+ if (exists $config{umask}) {
+ umask(possibly_foolish_untaint($config{umask}));
+ }
+
run_hooks(checkconfig => sub { shift->() });
+
+ return 1;
} #}}}
sub loadplugins () { #{{{
+ if (defined $config{libdir}) {
+ unshift @INC, possibly_foolish_untaint($config{libdir});
+ }
+
loadplugin($_) foreach @{$config{plugin}};
-
+
run_hooks(getopt => sub { shift->() });
if (grep /^-/, @ARGV) {
print STDERR "Unknown option: $_\n"
foreach grep /^-/, @ARGV;
usage();
}
+
+ return 1;
} #}}}
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 ($) { #{{{
+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").": @_</p>");
+ "<p>".gettext("Error").": $message</p>");
}
- log_message(error => @_);
- exit(1);
+ log_message('err' => $message) if $config{syslog};
+ if (defined $cleaner) {
+ $cleaner->();
+ }
+ die $message."\n";
} #}}}
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 {
- Sys::Syslog::syslog($type, join(" ", @_));
- }
+ 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";
}
} #}}}
sub possibly_foolish_untaint ($) { #{{{
my $tainted=shift;
- my ($untainted)=$tainted=~/(.*)/;
+ my ($untainted)=$tainted=~/(.*)/s;
return $untainted;
} #}}}
if ($page =~ /\.([^.]+)$/) {
return $1 if exists $hooks{htmlize}{$1};
}
- return undef;
+ return;
+} #}}}
+
+sub isinternal ($) { #{{{
+ my $page=shift;
+ return exists $pagesources{$page} &&
+ $pagesources{$page} =~ /\._([^.]+)$/;
} #}}}
sub pagename ($) { #{{{
return $page;
} #}}}
-sub htmlpage ($) { #{{{
+sub targetpage ($$) { #{{{
my $page=shift;
+ my $ext=shift;
+
+ if (! $config{usedirs} || $page =~ /^index$/ ) {
+ return $page.".".$ext;
+ } else {
+ return $page."/index.".$ext;
+ }
+} #}}}
- return $page.".html";
+sub htmlpage ($) { #{{{
+ my $page=shift;
+
+ return targetpage($page, $config{htmlext});
} #}}}
-sub srcfile ($) { #{{{
+sub srcfile_stat { #{{{
my $file=shift;
+ my $nothrow=shift;
+
+ return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
+ foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
+ return "$dir/$file", stat(_) if -e "$dir/$file";
+ }
+ error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
+ return;
+} #}}}
+
+sub srcfile ($;$) { #{{{
+ return (srcfile_stat(@_))[0];
+} #}}}
+
+sub add_underlay ($) { #{{{
+ my $dir=shift;
+
+ if ($dir=~/^\//) {
+ unshift @{$config{underlaydirs}}, $dir;
+ }
+ else {
+ unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
+ }
- 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");
+ return 1;
} #}}}
sub readfile ($;$$) { #{{{
}
local $/=undef;
- open (IN, $file) || error("failed to read $file: $!");
- binmode(IN) if ($binary);
- return \*IN if $wantfd;
- my $ret=<IN>;
- close IN;
+ 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;
} #}}}
-sub writefile ($$$;$$) { #{{{
- my $file=shift; # can include subdirs
- my $destdir=shift; # directory to put file in
- my $content=shift;
- my $binary=shift;
- my $wantfd=shift;
+sub prep_writefile ($$) {
+ my $file=shift;
+ my $destdir=shift;
my $test=$file;
while (length $test) {
}
}
}
+
+ 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)");
+ }
- open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
- binmode(OUT) if ($binary);
- return \*OUT if $wantfd;
- print OUT $content;
- close OUT;
+ my $cleanup = sub { unlink($newfile) };
+ open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
+ binmode($out) if ($binary);
+ if ($writer) {
+ $writer->(\*$out, $cleanup);
+ }
+ else {
+ print $out $content or 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);
+
+ return 1;
} #}}}
my %cleared;
$renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
}
else {
+ foreach my $old (@{$renderedfiles{$page}}) {
+ delete $destsources{$old};
+ }
$renderedfiles{$page}=[$dest];
$cleared{$page}=1;
}
+ $destsources{$dest}=$page;
+
+ return 1;
} #}}}
sub bestlink ($$) { #{{{
# absolute links
$cwd="";
}
+ $link=~s/\/$//;
do {
my $l=$cwd;
}
} while $cwd=~s!/?[^/]+$!!;
- if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
- return "$config{userdir}/".lc($link);
+ if (length $config{userdir}) {
+ my $l = "$config{userdir}/".lc($link);
+ if (exists $links{$l}) {
+ return $l;
+ }
+ elsif (exists $pagecase{lc $l}) {
+ return $pagecase{lc $l};
+ }
}
#print STDERR "warning: page $page, broken link: $link\n";
sub isinlinableimage ($) { #{{{
my $file=shift;
- $file=~/\.(png|gif|jpg|jpeg)$/i;
+ return $file =~ /\.(png|gif|jpg|jpeg)$/i;
} #}}}
sub pagetitle ($;$) { #{{{
my $unescaped=shift;
if ($unescaped) {
- $page=~s/__(\d+)__/chr($1)/eg;
+ $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
}
else {
- $page=~s/__(\d+)__/&#$1;/g;
+ $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
}
- $page=~y/_/ /;
return $page;
} #}}}
sub titlepage ($) { #{{{
my $title=shift;
- $title=~y/ /_/;
- $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
+ $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
return $title;
} #}}}
+sub linkpage ($) { #{{{
+ my $link=shift;
+ $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
+ return $link;
+} #}}}
+
sub cgiurl (@) { #{{{
my %params=@_;
- return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
+ return $config{cgiurl}."?".
+ join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
} #}}}
sub baseurl (;$) { #{{{
return "$config{url}/" if ! defined $page;
+ $page=htmlpage($page);
$page=~s/[^\/]+$//;
$page=~s/[^\/]+\//..\//g;
return $page;
return $ret;
} #}}}
-sub displaytime ($) { #{{{
+sub displaytime ($;$) { #{{{
my $time=shift;
+ my $format=shift;
+ if (! defined $format) {
+ $format=$config{timeformat};
+ }
- eval q{use POSIX};
- error($@) if $@;
# strftime doesn't know about encodings, so make sure
# its output is properly treated as utf8
- return decode_utf8(POSIX::strftime(
- $config{timeformat}, localtime($time)));
+ return decode_utf8(POSIX::strftime($format, localtime($time)));
+} #}}}
+
+sub beautify_urlpath ($) { #{{{
+ my $url=shift;
+
+ if ($config{usedirs}) {
+ $url =~ s!/index.$config{htmlext}$!/!;
+ }
+
+ # 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;
+} #}}}
+
+sub urlto ($$) { #{{{
+ my $to=shift;
+ my $from=shift;
+
+ if (! length $to) {
+ return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
+ }
+
+ if (! $destsources{$to}) {
+ $to=htmlpage($to);
+ }
+
+ my $link = abs2rel($to, dirname(htmlpage($from)));
+
+ return beautify_urlpath($link);
} #}}}
-sub htmllink ($$$;$$$) { #{{{
+sub htmllink ($$$;@) { #{{{
my $lpage=shift; # the page doing the linking
my $page=shift; # the page that will contain the link (different for inline)
my $link=shift;
- my $noimageinline=shift; # don't turn links into inline html images
- my $forcesubpage=shift; # force a link to a subpage
- my $linktext=shift; # set to force the link text to something
+ my %opts=@_;
+
+ $link=~s/\/$//;
my $bestlink;
- if (! $forcesubpage) {
+ if (! $opts{forcesubpage}) {
$bestlink=bestlink($lpage, $link);
}
else {
$bestlink="$lpage/".lc($link);
}
- $linktext=pagetitle(basename($link)) unless defined $linktext;
+ my $linktext;
+ if (defined $opts{linktext}) {
+ $linktext=$opts{linktext};
+ }
+ else {
+ $linktext=pagetitle(basename($link));
+ }
return "<span class=\"selflink\">$linktext</span>"
- if length $bestlink && $page eq $bestlink;
+ if length $bestlink && $page eq $bestlink &&
+ ! defined $opts{anchor};
- if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
+ if (! $destsources{$bestlink}) {
$bestlink=htmlpage($bestlink);
- }
- if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
- return $linktext unless length $config{cgiurl};
- return "<span><a href=\"".
- cgiurl(do => "create", page => lc($link), from => $page).
- "\">?</a>$linktext</span>"
+
+ if (! $destsources{$bestlink}) {
+ return $linktext unless length $config{cgiurl};
+ return "<span class=\"createlink\"><a href=\"".
+ cgiurl(
+ do => "create",
+ page => lc($link),
+ from => $lpage
+ ).
+ "\" rel=\"nofollow\">?</a>$linktext</span>"
+ }
}
- $bestlink=abs2rel($bestlink, dirname($page));
+ $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
+ $bestlink=beautify_urlpath($bestlink);
- if (! $noimageinline && isinlinableimage($bestlink)) {
+ if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
return "<img src=\"$bestlink\" alt=\"$linktext\" />";
}
- return "<a href=\"$bestlink\">$linktext</a>";
+
+ if (defined $opts{anchor}) {
+ $bestlink.="#".$opts{anchor};
+ }
+
+ my @attrs;
+ 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>";
} #}}}
-sub htmlize ($$$) { #{{{
+sub userlink ($) { #{{{
+ my $user=shift;
+
+ my $oiduser=eval { openiduser($user) };
+ if (defined $oiduser) {
+ 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);
+ }
+} #}}}
+
+sub htmlize ($$$$) { #{{{
my $page=shift;
+ my $destpage=shift;
my $type=shift;
my $content=shift;
+
+ my $oneline = $content !~ /\n/;
if (exists $hooks{htmlize}{$type}) {
$content=$hooks{htmlize}{$type}{call}->(
run_hooks(sanitize => sub {
$content=shift->(
page => $page,
+ destpage => $destpage,
content => $content,
);
});
+
+ if ($oneline) {
+ # hack to get rid of enclosing junk added by markdown
+ # and other htmlizers
+ $content=~s/^<p>//i;
+ $content=~s/<\/p>$//i;
+ chomp $content;
+ }
return $content;
} #}}}
sub linkify ($$$) { #{{{
- my $lpage=shift; # the page containing the links
- my $page=shift; # the page the link will end up on (different for inline)
+ my $page=shift;
+ my $destpage=shift;
my $content=shift;
- $content =~ s{(\\?)$config{wiki_link_regexp}}{
- $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
- : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3)))
- }eg;
+ run_hooks(linkify => sub {
+ $content=shift->(
+ page => $page,
+ destpage => $destpage,
+ content => $content,
+ );
+ });
return $content;
} #}}}
-my %preprocessing;
-sub preprocess ($$$;$) { #{{{
+our %preprocessing;
+our $preprocess_preview=0;
+sub preprocess ($$$;$$) { #{{{
my $page=shift; # the page the data comes from
my $destpage=shift; # the page the data will appear in (different for inline)
my $content=shift;
my $scan=shift;
+ my $preview=shift;
+
+ # Using local because it needs to be set within any nested calls
+ # of this function.
+ local $preprocess_preview=$preview if defined $preview;
my $handle=sub {
my $escape=shift;
+ my $prefix=shift;
my $command=shift;
my $params=shift;
if (length $escape) {
- return "[[$command $params]]";
+ return "[[$prefix$command $params]]";
}
elsif (exists $hooks{preprocess}{$command}) {
return "" if $scan && ! $hooks{preprocess}{$command}{scan};
# Note: preserve order of params, some plugins may
# consider it significant.
my @params;
- while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
+ while ($params =~ m{
+ (?:([-\w]+)=)? # 1: named parameter key?
+ (?:
+ """(.*?)""" # 2: triple-quoted value
+ |
+ "([^"]+)" # 3: single-quoted value
+ |
+ (\S+) # 4: unquoted value
+ )
+ (?:\s+|$) # delimiter to next param
+ }sgx) {
my $key=$1;
my $val;
if (defined $2) {
$command, $page, $preprocessing{$page}).
"]]";
}
- my $ret=$hooks{preprocess}{$command}{call}->(
- @params,
- page => $page,
- destpage => $destpage,
- );
+ my $ret;
+ if (! $scan) {
+ $ret=$hooks{preprocess}{$command}{call}->(
+ @params,
+ page => $page,
+ destpage => $destpage,
+ preview => $preprocess_preview,
+ );
+ }
+ else {
+ # use void context during scan pass
+ $hooks{preprocess}{$command}{call}->(
+ @params,
+ page => $page,
+ destpage => $destpage,
+ preview => $preprocess_preview,
+ );
+ $ret="";
+ }
$preprocessing{$page}--;
return $ret;
}
else {
- return "[[$command $params]]";
+ return "[[$prefix$command $params]]";
}
};
- $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
+ my $regex;
+ if ($config{prefix_directives}) {
+ $regex = qr{
+ (\\?) # 1: escape?
+ \[\[(!) # directive open; 2: prefix
+ ([-\w]+) # 3: command
+ ( # 4: the parameters..
+ \s+ # Must have space if parameters present
+ (?:
+ (?:[-\w]+=)? # named parameter key?
+ (?:
+ """.*?""" # triple-quoted value
+ |
+ "[^"]+" # single-quoted value
+ |
+ [^\s\]]+ # unquoted value
+ )
+ \s* # whitespace or end
+ # of directive
+ )
+ *)? # 0 or more parameters
+ \]\] # directive closed
+ }sx;
+ } else {
+ $regex = qr{
+ (\\?) # 1: escape?
+ \[\[(!?) # directive open; 2: optional prefix
+ ([-\w]+) # 3: command
+ \s+
+ ( # 4: the parameters..
+ (?:
+ (?:[-\w]+=)? # named parameter key?
+ (?:
+ """.*?""" # triple-quoted value
+ |
+ "[^"]+" # single-quoted value
+ |
+ [^\s\]]+ # unquoted value
+ )
+ \s* # whitespace or end
+ # of directive
+ )
+ *) # 0 or more parameters
+ \]\] # directive closed
+ }sx;
+ }
+
+ $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
return $content;
} #}}}
-sub filter ($$) { #{{{
+sub filter ($$$) { #{{{
my $page=shift;
+ my $destpage=shift;
my $content=shift;
run_hooks(filter => sub {
- $content=shift->(page => $page, content => $content);
+ $content=shift->(page => $page, destpage => $destpage,
+ content => $content);
});
return $content;
return "<a href=\"$config{url}\">$config{wikiname}</a>";
} #}}}
-sub lockwiki () { #{{{
+my $wikilock;
+
+sub lockwiki (;$) { #{{{
+ my $wait=@_ ? shift : 1;
# Take an exclusive lock on the wiki to prevent multiple concurrent
# run issues. The lock will be dropped on program exit.
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)) {
- 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) {
- return if flock(WIKILOCK, 2 | 4);
- sleep 1;
+ 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);
+ sleep 1;
+ }
+ error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
+ }
+ else {
+ return 0;
}
- error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
}
+ return 1;
} #}}}
sub unlockwiki () { #{{{
- close WIKILOCK;
+ return close($wikilock) if $wikilock;
+ return;
} #}}}
-sub loadindex () { #{{{
- open (IN, "$config{wikistatedir}/index") || return;
- while (<IN>) {
- $_=possibly_foolish_untaint($_);
- chomp;
- my %items;
- $items{link}=[];
- $items{dest}=[];
- foreach my $i (split(/ /, $_)) {
- my ($item, $val)=split(/=/, $i, 2);
- push @{$items{$item}}, decode_entities($val);
- }
+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) || error("failed closing commitlock: $!");
+ return 0;
+ }
+ 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
+ error("failed to get commit lock");
+ }
+ return 1;
+} #}}}
- next unless exists $items{src}; # skip bad lines for now
+sub enable_commit_hook () { #{{{
+ return close($commitlock) if $commitlock;
+ return;
+} #}}}
- my $page=pagename($items{src}[0]);
+sub loadindex () { #{{{
+ %oldrenderedfiles=%pagectime=();
+ if (! $config{rebuild}) {
+ %pagesources=%pagemtime=%oldlinks=%links=%depends=
+ %destsources=%renderedfiles=%pagecase=%pagestate=();
+ }
+ 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;
+ foreach my $src (keys %index) {
+ my %d=%{$index{$src}};
+ my $page=pagename($src);
+ $pagectime{$page}=$d{ctime};
if (! $config{rebuild}) {
- $pagesources{$page}=$items{src}[0];
- $oldpagemtime{$page}=$items{mtime}[0];
- $oldlinks{$page}=[@{$items{link}}];
- $links{$page}=[@{$items{link}}];
- $depends{$page}=$items{depends}[0] if exists $items{depends};
- $renderedfiles{$page}=[@{$items{dest}}];
- $oldrenderedfiles{$page}=[@{$items{dest}}];
- $pagecase{lc $page}=$page;
+ $pagesources{$page}=$src;
+ $pagemtime{$page}=$d{mtime};
+ $renderedfiles{$page}=$d{dest};
+ if (exists $d{links} && ref $d{links}) {
+ $links{$page}=$d{links};
+ $oldlinks{$page}=[@{$d{links}}];
+ }
+ if (exists $d{depends}) {
+ $depends{$page}=$d{depends};
+ }
+ if (exists $d{state}) {
+ $pagestate{$page}=$d{state};
+ }
}
- $pagectime{$page}=$items{ctime}[0];
+ $oldrenderedfiles{$page}=[@{$d{dest}}];
+ }
+ foreach my $page (keys %pagesources) {
+ $pagecase{lc $page}=$page;
+ }
+ foreach my $page (keys %renderedfiles) {
+ $destsources{$_}=$page foreach @{$renderedfiles{$page}};
}
- close IN;
+ return close($in);
} #}}}
sub saveindex () { #{{{
run_hooks(savestate => sub { shift->() });
+ my %hookids;
+ foreach my $type (keys %hooks) {
+ $hookids{$_}=1 foreach keys %{$hooks{$type}};
+ }
+ my @hookids=keys %hookids;
+
if (! -d $config{wikistatedir}) {
mkdir($config{wikistatedir});
}
- open (OUT, ">$config{wikistatedir}/index") ||
- error("cannot write to $config{wikistatedir}/index: $!");
- foreach my $page (keys %oldpagemtime) {
- next unless $oldpagemtime{$page};
- my $line="mtime=$oldpagemtime{$page} ".
- "ctime=$pagectime{$page} ".
- "src=$pagesources{$page}";
- $line.=" dest=$_" foreach @{$renderedfiles{$page}};
- my %count;
- $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
+ 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 $src=$pagesources{$page};
+
+ $index{$src}={
+ ctime => $pagectime{$page},
+ mtime => $pagemtime{$page},
+ dest => $renderedfiles{$page},
+ links => $links{$page},
+ };
+
if (exists $depends{$page}) {
- $line.=" depends=".encode_entities($depends{$page}, " \t\n");
+ $index{$src}{depends} = $depends{$page};
+ }
+
+ if (exists $pagestate{$page}) {
+ foreach my $id (@hookids) {
+ foreach my $key (keys %{$pagestate{$page}{$id}}) {
+ $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
+ }
+ }
}
- print OUT $line."\n";
}
- close OUT;
+ my $ret=Storable::nstore_fd(\%index, $out);
+ return if ! defined $ret || ! $ret;
+ close $out || error("failed saving to $newfile: $!", $cleanup);
+ rename($newfile, "$config{wikistatedir}/indexdb") ||
+ error("failed renaming $newfile to $config{wikistatedir}/indexdb", $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 (@) { #{{{
return "";
}
- require HTML::Template;
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 ($;@) { #{{{
- HTML::Template->new(template_params(@_));
+ require HTML::Template;
+ 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 ($) { #{{{
my $page=shift;
my $pagespec=shift;
+ return unless pagespec_valid($pagespec);
+
if (! exists $depends{$page}) {
$depends{$page}=$pagespec;
}
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/ && $file ne $base;
} #}}}
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};
} #}}}
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.
# Convert spec to perl code.
my $code="";
- while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
+ while ($spec=~m{
+ \s* # ignore whitespace
+ ( # 1: match a single word
+ \! # !
+ |
+ \( # (
+ |
+ \) # )
+ |
+ \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 =~ /^(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).", \$from)";
+ $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
}
}
- return $code;
+ if (! length $code) {
+ $code=0;
+ }
+
+ no warnings;
+ return eval 'sub { my $page=shift; '.$code.' }';
} #}}}
-sub pagespec_match ($$;$) { #{{{
+sub pagespec_match ($$;@) { #{{{
my $page=shift;
my $spec=shift;
- my $from=shift;
- if (! defined $from){
- $from = "";
+ my @params=@_;
+
+ # Backwards compatability with old calling convention.
+ if (@params == 1) {
+ unshift @params, 'location';
}
- return eval pagespec_translate($spec);
+ my $sub=pagespec_translate($spec);
+ return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
+ return $sub->($page, @params);
+} #}}}
+
+sub pagespec_valid ($) { #{{{
+ my $spec=shift;
+
+ my $sub=pagespec_translate($spec);
+ return ! $@;
+} #}}}
+
+sub glob2re ($) { #{{{
+ my $re=quotemeta(shift);
+ $re=~s/\\\*/.*/g;
+ $re=~s/\\\?/./g;
+ return $re;
+} #}}}
+
+package IkiWiki::FailReason;
+
+use overload ( #{{{
+ '""' => sub { ${$_[0]} },
+ '0+' => sub { 0 },
+ '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
+ fallback => 1,
+); #}}}
+
+sub new { #{{{
+ my $class = shift;
+ my $value = shift;
+ return bless \$value, $class;
} #}}}
-sub match_glob ($$$) { #{{{
+package IkiWiki::SuccessReason;
+
+use overload ( #{{{
+ '""' => sub { ${$_[0]} },
+ '0+' => sub { 1 },
+ '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
+ fallback => 1,
+); #}}}
+
+sub new { #{{{
+ my $class = shift;
+ my $value = shift;
+ return bless \$value, $class;
+}; #}}}
+
+package IkiWiki::PageSpec;
+
+sub match_glob ($$;@) { #{{{
my $page=shift;
my $glob=shift;
- my $from=shift;
-
+ my %params=@_;
+
+ my $from=exists $params{location} ? $params{location} : '';
+
# relative matching
if ($glob =~ m!^\./!) {
- $from=~s!/?[^/]+$!!;
- $glob=~s!^\./!!;
- $glob="$from/$glob";
+ $from=~s#/?[^/]+$##;
+ $glob=~s#^\./##;
+ $glob="$from/$glob" if length $from;
}
- # turn glob into safe regexp
- $glob=quotemeta($glob);
- $glob=~s/\\\*/.*/g;
- $glob=~s/\\\?/./g;
+ my $regexp=IkiWiki::glob2re($glob);
+ if ($page=~/^$regexp$/i) {
+ if (! IkiWiki::isinternal($page) || $params{internal}) {
+ return IkiWiki::SuccessReason->new("$glob matches $page");
+ }
+ else {
+ return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
+ }
+ }
+ else {
+ return IkiWiki::FailReason->new("$glob does not match $page");
+ }
+} #}}}
- return $page=~/^$glob$/i;
+sub match_internal ($$;@) { #{{{
+ return match_glob($_[0], $_[1], @_, internal => 1)
} #}}}
-sub match_link ($$) { #{{{
+sub match_link ($$;@) { #{{{
my $page=shift;
my $link=lc(shift);
+ my %params=@_;
+
+ my $from=exists $params{location} ? $params{location} : '';
+
+ # relative matching
+ if ($link =~ m!^\.! && defined $from) {
+ $from=~s#/?[^/]+$##;
+ $link=~s#^\./##;
+ $link="$from/$link" if length $from;
+ }
- my $links = $links{$page} or return undef;
- foreach my $p (@$links) {
- return 1 if lc $p eq $link;
+ 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}) {
+ 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 $p matching $link")
+ if match_glob($p, $link, %params);
+ }
}
- return 0;
+ return IkiWiki::FailReason->new("$page does not link to $link");
} #}}}
-sub match_backlink ($$) { #{{{
- match_link(pop, pop);
+sub match_backlink ($$;@) { #{{{
+ return match_link($_[1], $_[0], @_);
} #}}}
-sub match_created_before ($$) { #{{{
+sub match_created_before ($$;@) { #{{{
my $page=shift;
my $testpage=shift;
- if (exists $pagectime{$testpage}) {
- return $pagectime{$page} < $pagectime{$testpage};
+ if (exists $IkiWiki::pagectime{$testpage}) {
+ if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
+ return IkiWiki::SuccessReason->new("$page created before $testpage");
+ }
+ else {
+ return IkiWiki::FailReason->new("$page not created before $testpage");
+ }
}
else {
- return 0;
+ return IkiWiki::FailReason->new("$testpage has no ctime");
}
} #}}}
-sub match_created_after ($$) { #{{{
+sub match_created_after ($$;@) { #{{{
my $page=shift;
my $testpage=shift;
- if (exists $pagectime{$testpage}) {
- return $pagectime{$page} > $pagectime{$testpage};
+ if (exists $IkiWiki::pagectime{$testpage}) {
+ if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
+ return IkiWiki::SuccessReason->new("$page created after $testpage");
+ }
+ else {
+ return IkiWiki::FailReason->new("$page not created after $testpage");
+ }
}
else {
- return 0;
+ return IkiWiki::FailReason->new("$testpage has no ctime");
}
} #}}}
-sub match_creation_day ($$) { #{{{
- return ((gmtime($pagectime{shift()}))[3] == shift);
+sub match_creation_day ($$;@) { #{{{
+ if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
+ return IkiWiki::SuccessReason->new('creation_day matched');
+ }
+ else {
+ return IkiWiki::FailReason->new('creation_day did not match');
+ }
} #}}}
-sub match_creation_month ($$) { #{{{
- return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
+sub match_creation_month ($$;@) { #{{{
+ if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
+ return IkiWiki::SuccessReason->new('creation_month matched');
+ }
+ else {
+ return IkiWiki::FailReason->new('creation_month did not match');
+ }
} #}}}
-sub match_creation_year ($$) { #{{{
- return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);
+sub match_creation_year ($$;@) { #{{{
+ if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
+ return IkiWiki::SuccessReason->new('creation_year matched');
+ }
+ else {
+ return IkiWiki::FailReason->new('creation_year did not match');
+ }
} #}}}
1