9 use URI::Escape q{uri_escape_utf8};
12 use open qw{:utf8 :std};
14 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
15 %pagestate %wikistate %renderedfiles %oldrenderedfiles
16 %pagesources %destsources %depends %depends_simple %hooks
17 %forcerebuild %loaded_plugins};
19 use Exporter q{import};
20 our @EXPORT = qw(hook debug error template htmlpage deptype
21 add_depends pagespec_match pagespec_match_list bestlink
22 htmllink readfile writefile pagetype srcfile pagename
23 displaytime will_render gettext urlto targetpage
24 add_underlay pagetitle titlepage linkpage newpagefile
26 %config %links %pagestate %wikistate %renderedfiles
27 %pagesources %destsources);
28 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
29 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
30 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
32 # Page dependency types.
33 our $DEPEND_CONTENT=1;
34 our $DEPEND_PRESENCE=2;
40 memoize("pagespec_translate");
41 memoize("template_file");
47 description => "name of the wiki",
54 example => 'me@example.com',
55 description => "contact email for wiki",
62 description => "users who are wiki admins",
69 description => "users who are banned from the wiki",
76 example => "$ENV{HOME}/wiki",
77 description => "where the source of the wiki is located",
84 example => "/var/www/wiki",
85 description => "where to build the wiki",
92 example => "http://example.com/wiki",
93 description => "base url to the wiki",
100 example => "http://example.com/wiki/ikiwiki.cgi",
101 description => "url to the ikiwiki.cgi",
108 example => "/var/www/wiki/ikiwiki.cgi",
109 description => "filename of cgi wrapper to generate",
116 description => "mode for cgi_wrapper (can safely be made suid)",
123 description => "rcs backend to use",
124 safe => 0, # don't allow overriding
129 default => [qw{mdwn link inline meta htmlscrubber passwordauth
130 openid signinedit lockedit conditional
131 recentchanges parentlinks editpage}],
132 description => "plugins to enable by default",
139 description => "plugins to add to the default configuration",
146 description => "plugins to disable",
152 default => "$installdir/share/ikiwiki/templates",
153 description => "location of template files",
161 description => "additional directories containing template files",
167 default => "$installdir/share/ikiwiki/basewiki",
168 description => "base wiki source location",
175 default => "$installdir/share/ikiwiki",
176 description => "parent directory containing additional underlays",
183 description => "wrappers to generate",
190 description => "additional underlays to use",
197 description => "display verbose messages?",
204 description => "log to syslog?",
211 description => "create output files named page/index.html?",
212 safe => 0, # changing requires manual transition
215 prefix_directives => {
218 description => "use '!'-prefixed preprocessor directives?",
219 safe => 0, # changing requires manual transition
225 description => "use page/index.mdwn source files",
232 description => "enable Discussion pages?",
238 default => gettext("Discussion"),
239 description => "name of Discussion pages",
246 description => "only send cookies over SSL connections?",
254 description => "extension to use for new pages",
255 safe => 0, # not sanitized
261 description => "extension to use for html files",
262 safe => 0, # not sanitized
268 description => "strftime format string to display date",
276 example => "en_US.UTF-8",
277 description => "UTF-8 locale to use",
286 description => "put user pages below specified page",
293 description => "how many backlinks to show before hiding excess (0 to show all)",
300 description => "attempt to hardlink source files? (optimisation for large files)",
302 safe => 0, # paranoia
308 description => "force ikiwiki to use a particular umask",
310 safe => 0, # paranoia
315 example => "ikiwiki",
316 description => "group for wrappers to run in",
318 safe => 0, # paranoia
324 example => "$ENV{HOME}/.ikiwiki/",
325 description => "extra library and plugin directory",
327 safe => 0, # directory
333 description => "environment variables",
334 safe => 0, # paranoia
341 description => "regexp of source files to ignore",
346 wiki_file_prune_regexps => {
348 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
349 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
350 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
351 qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
352 qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
353 description => "regexps of source files to ignore",
359 description => "specifies the characters that are allowed in source filenames",
360 default => "-[:alnum:]+/.:_",
364 wiki_file_regexp => {
366 description => "regexp of legal source files",
370 web_commit_regexp => {
372 default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
373 description => "regexp to parse web commits from logs",
380 description => "run as a cgi",
384 cgi_disable_uploads => {
387 description => "whether CGI should accept file uploads",
394 description => "run as a post-commit hook",
401 description => "running in rebuild mode",
408 description => "running in setup mode",
415 description => "running in refresh mode",
422 description => "running in receive test mode",
429 description => "running in getctime mode",
436 description => "running in w3mmode",
443 description => "path to the .ikiwiki directory holding ikiwiki state",
450 description => "path to setup file",
454 allow_symlinks_before_srcdir => {
457 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
463 sub defaultconfig () {
466 foreach my $key (keys %s) {
467 push @ret, $key, $s{$key}->{default};
474 # locale stuff; avoid LC_ALL since it overrides everything
475 if (defined $ENV{LC_ALL}) {
476 $ENV{LANG} = $ENV{LC_ALL};
479 if (defined $config{locale}) {
480 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
481 $ENV{LANG}=$config{locale};
486 if (! defined $config{wiki_file_regexp}) {
487 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
490 if (ref $config{ENV} eq 'HASH') {
491 foreach my $val (keys %{$config{ENV}}) {
492 $ENV{$val}=$config{ENV}{$val};
496 if ($config{w3mmode}) {
497 eval q{use Cwd q{abs_path}};
499 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
500 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
501 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
502 unless $config{cgiurl} =~ m!file:///!;
503 $config{url}="file://".$config{destdir};
506 if ($config{cgi} && ! length $config{url}) {
507 error(gettext("Must specify url to wiki with --url when using --cgi"));
510 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
511 unless exists $config{wikistatedir} && defined $config{wikistatedir};
513 if (defined $config{umask}) {
514 umask(possibly_foolish_untaint($config{umask}));
517 run_hooks(checkconfig => sub { shift->() });
525 foreach my $dir (@INC, $config{libdir}) {
526 next unless defined $dir && length $dir;
527 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
528 my ($plugin)=$file=~/.*\/(.*)\.pm$/;
532 foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
533 next unless defined $dir && length $dir;
534 foreach my $file (glob("$dir/plugins/*")) {
535 $ret{basename($file)}=1 if -x $file;
543 if (defined $config{libdir} && length $config{libdir}) {
544 unshift @INC, possibly_foolish_untaint($config{libdir});
547 foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
552 if (exists $hooks{rcs}) {
553 error(gettext("cannot use multiple rcs plugins"));
555 loadplugin($config{rcs});
557 if (! exists $hooks{rcs}) {
561 run_hooks(getopt => sub { shift->() });
562 if (grep /^-/, @ARGV) {
563 print STDERR "Unknown option (or missing parameter): $_\n"
564 foreach grep /^-/, @ARGV;
574 return if grep { $_ eq $plugin} @{$config{disable_plugins}};
576 foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
577 "$installdir/lib/ikiwiki") {
578 if (defined $dir && -x "$dir/plugins/$plugin") {
579 eval { require IkiWiki::Plugin::external };
582 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
584 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
585 $loaded_plugins{$plugin}=1;
590 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
593 error("Failed to load plugin $mod: $@");
595 $loaded_plugins{$plugin}=1;
602 log_message('err' => $message) if $config{syslog};
603 if (defined $cleaner) {
610 return unless $config{verbose};
611 return log_message(debug => @_);
615 sub log_message ($$) {
618 if ($config{syslog}) {
621 Sys::Syslog::setlogsock('unix');
622 Sys::Syslog::openlog('ikiwiki', '', 'user');
626 Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
629 elsif (! $config{cgi}) {
633 return print STDERR "@_\n";
637 sub possibly_foolish_untaint ($) {
639 my ($untainted)=$tainted=~/(.*)/s;
659 return exists $pagesources{$page} &&
660 $pagesources{$page} =~ /\._([^.]+)$/;
666 if ($file =~ /\.([^.]+)$/) {
667 return $1 if exists $hooks{htmlize}{$1};
669 my $base=basename($file);
670 if (exists $hooks{htmlize}{$base} &&
671 $hooks{htmlize}{$base}{noextension}) {
682 if (exists $pagename_cache{$file}) {
683 return $pagename_cache{$file};
686 my $type=pagetype($file);
688 $page=~s/\Q.$type\E*$//
689 if defined $type && !$hooks{htmlize}{$type}{keepextension}
690 && !$hooks{htmlize}{$type}{noextension};
691 if ($config{indexpages} && $page=~/(.*)\/index$/) {
695 $pagename_cache{$file} = $page;
699 sub newpagefile ($$) {
703 if (! $config{indexpages} || $page eq 'index') {
704 return $page.".".$type;
707 return $page."/index.".$type;
711 sub targetpage ($$;$) {
716 if (defined $filename) {
717 return $page."/".$filename.".".$ext;
719 elsif (! $config{usedirs} || $page eq 'index') {
720 return $page.".".$ext;
723 return $page."/index.".$ext;
730 return targetpage($page, $config{htmlext});
737 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
738 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
739 return "$dir/$file", stat(_) if -e "$dir/$file";
741 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
746 return (srcfile_stat(@_))[0];
749 sub add_underlay ($) {
753 $dir="$config{underlaydirbase}/$dir";
756 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
757 unshift @{$config{underlaydirs}}, $dir;
763 sub readfile ($;$$) {
769 error("cannot read a symlink ($file)");
773 open (my $in, "<", $file) || error("failed to read $file: $!");
774 binmode($in) if ($binary);
775 return \*$in if $wantfd;
777 # check for invalid utf-8, and toss it back to avoid crashes
778 if (! utf8::valid($ret)) {
779 $ret=encode_utf8($ret);
781 close $in || error("failed to read $file: $!");
785 sub prep_writefile ($$) {
790 while (length $test) {
791 if (-l "$destdir/$test") {
792 error("cannot write to a symlink ($test)");
794 $test=dirname($test);
797 my $dir=dirname("$destdir/$file");
800 foreach my $s (split(m!/+!, $dir)) {
803 mkdir($d) || error("failed to create directory $d: $!");
811 sub writefile ($$$;$$) {
812 my $file=shift; # can include subdirs
813 my $destdir=shift; # directory to put file in
818 prep_writefile($file, $destdir);
820 my $newfile="$destdir/$file.ikiwiki-new";
822 error("cannot write to a symlink ($newfile)");
825 my $cleanup = sub { unlink($newfile) };
826 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
827 binmode($out) if ($binary);
829 $writer->(\*$out, $cleanup);
832 print $out $content or error("failed writing to $newfile: $!", $cleanup);
834 close $out || error("failed saving $newfile: $!", $cleanup);
835 rename($newfile, "$destdir/$file") ||
836 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
842 sub will_render ($$;$) {
847 # Important security check.
848 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
849 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
850 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
853 if (! $clear || $cleared{$page}) {
854 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
857 foreach my $old (@{$renderedfiles{$page}}) {
858 delete $destsources{$old};
860 $renderedfiles{$page}=[$dest];
863 $destsources{$dest}=$page;
873 if ($link=~s/^\/+//) {
881 $l.="/" if length $l;
884 if (exists $pagesources{$l}) {
887 elsif (exists $pagecase{lc $l}) {
888 return $pagecase{lc $l};
890 } while $cwd=~s{/?[^/]+$}{};
892 if (length $config{userdir}) {
893 my $l = "$config{userdir}/".lc($link);
894 if (exists $pagesources{$l}) {
897 elsif (exists $pagecase{lc $l}) {
898 return $pagecase{lc $l};
902 #print STDERR "warning: page $page, broken link: $link\n";
906 sub isinlinableimage ($) {
909 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
912 sub pagetitle ($;$) {
917 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
920 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
928 # support use w/o %config set
929 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
930 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
936 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
937 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
944 return $config{cgiurl}."?".
945 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
951 return "$config{url}/" if ! defined $page;
953 $page=htmlpage($page);
955 $page=~s/[^\/]+\//..\//g;
960 # Work around very innefficient behavior in File::Spec if abs2rel
961 # is passed two relative paths. It's much faster if paths are
962 # absolute! (Debian bug #376658; fixed in debian unstable now)
967 my $ret=File::Spec->abs2rel($path, $base);
968 $ret=~s/^// if defined $ret;
972 sub displaytime ($;$) {
973 # Plugins can override this function to mark up the time to
975 return '<span class="date">'.formattime(@_).'</span>';
978 sub formattime ($;$) {
979 # Plugins can override this function to format the time.
982 if (! defined $format) {
983 $format=$config{timeformat};
986 # strftime doesn't know about encodings, so make sure
987 # its output is properly treated as utf8
988 return decode_utf8(POSIX::strftime($format, localtime($time)));
991 sub beautify_urlpath ($) {
994 # Ensure url is not an empty link, and if necessary,
995 # add ./ to avoid colon confusion.
996 if ($url !~ /^\// && $url !~ /^\.\.?\//) {
1000 if ($config{usedirs}) {
1001 $url =~ s!/index.$config{htmlext}$!/!;
1013 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
1016 if (! $destsources{$to}) {
1021 return $config{url}.beautify_urlpath("/".$to);
1024 my $link = abs2rel($to, dirname(htmlpage($from)));
1026 return beautify_urlpath($link);
1029 sub htmllink ($$$;@) {
1030 my $lpage=shift; # the page doing the linking
1031 my $page=shift; # the page that will contain the link (different for inline)
1038 if (! $opts{forcesubpage}) {
1039 $bestlink=bestlink($lpage, $link);
1042 $bestlink="$lpage/".lc($link);
1046 if (defined $opts{linktext}) {
1047 $linktext=$opts{linktext};
1050 $linktext=pagetitle(basename($link));
1053 return "<span class=\"selflink\">$linktext</span>"
1054 if length $bestlink && $page eq $bestlink &&
1055 ! defined $opts{anchor};
1057 if (! $destsources{$bestlink}) {
1058 $bestlink=htmlpage($bestlink);
1060 if (! $destsources{$bestlink}) {
1061 return $linktext unless length $config{cgiurl};
1062 return "<span class=\"createlink\"><a href=\"".
1068 "\" rel=\"nofollow\">?</a>$linktext</span>"
1072 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1073 $bestlink=beautify_urlpath($bestlink);
1075 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1076 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1079 if (defined $opts{anchor}) {
1080 $bestlink.="#".$opts{anchor};
1084 foreach my $attr (qw{rel class title}) {
1085 if (defined $opts{$attr}) {
1086 push @attrs, " $attr=\"$opts{$attr}\"";
1090 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1093 sub openiduser ($) {
1096 if ($user =~ m!^https?://! &&
1097 eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1100 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1101 # this works in at least 2.x
1102 $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1105 # this only works in 1.x
1106 my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1107 $display=$oid->display;
1110 # Convert "user.somehost.com" to "user [somehost.com]"
1111 # (also "user.somehost.co.uk")
1112 if ($display !~ /\[/) {
1113 $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1115 # Convert "http://somehost.com/user" to "user [somehost.com]".
1116 # (also "https://somehost.com/user/")
1117 if ($display !~ /\[/) {
1118 $display=~s/^https?:\/\/(.+)\/([^\/]+)\/?$/$2 [$1]/;
1120 $display=~s!^https?://!!; # make sure this is removed
1121 eval q{use CGI 'escapeHTML'};
1123 return escapeHTML($display);
1131 my $oiduser=eval { openiduser($user) };
1132 if (defined $oiduser) {
1133 return "<a href=\"$user\">$oiduser</a>";
1136 eval q{use CGI 'escapeHTML'};
1139 return htmllink("", "", escapeHTML(
1140 length $config{userdir} ? $config{userdir}."/".$user : $user
1141 ), noimageinline => 1);
1145 sub htmlize ($$$$) {
1151 my $oneline = $content !~ /\n/;
1153 if (exists $hooks{htmlize}{$type}) {
1154 $content=$hooks{htmlize}{$type}{call}->(
1156 content => $content,
1160 error("htmlization of $type not supported");
1163 run_hooks(sanitize => sub {
1166 destpage => $destpage,
1167 content => $content,
1172 # hack to get rid of enclosing junk added by markdown
1173 # and other htmlizers
1174 $content=~s/^<p>//i;
1175 $content=~s/<\/p>$//i;
1187 run_hooks(linkify => sub {
1190 destpage => $destpage,
1191 content => $content,
1199 our $preprocess_preview=0;
1200 sub preprocess ($$$;$$) {
1201 my $page=shift; # the page the data comes from
1202 my $destpage=shift; # the page the data will appear in (different for inline)
1207 # Using local because it needs to be set within any nested calls
1209 local $preprocess_preview=$preview if defined $preview;
1216 $params="" if ! defined $params;
1218 if (length $escape) {
1219 return "[[$prefix$command $params]]";
1221 elsif (exists $hooks{preprocess}{$command}) {
1222 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1223 # Note: preserve order of params, some plugins may
1224 # consider it significant.
1226 while ($params =~ m{
1227 (?:([-\w]+)=)? # 1: named parameter key?
1229 """(.*?)""" # 2: triple-quoted value
1231 "([^"]+)" # 3: single-quoted value
1233 (\S+) # 4: unquoted value
1235 (?:\s+|$) # delimiter to next param
1245 elsif (defined $3) {
1248 elsif (defined $4) {
1253 push @params, $key, $val;
1256 push @params, $val, '';
1259 if ($preprocessing{$page}++ > 3) {
1260 # Avoid loops of preprocessed pages preprocessing
1261 # other pages that preprocess them, etc.
1262 return "[[!$command <span class=\"error\">".
1263 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1264 $page, $preprocessing{$page}).
1270 $hooks{preprocess}{$command}{call}->(
1273 destpage => $destpage,
1274 preview => $preprocess_preview,
1280 $ret="[[!$command <span class=\"error\">".
1281 gettext("Error").": $error"."</span>]]";
1285 # use void context during scan pass
1287 $hooks{preprocess}{$command}{call}->(
1290 destpage => $destpage,
1291 preview => $preprocess_preview,
1296 $preprocessing{$page}--;
1300 return "[[$prefix$command $params]]";
1305 if ($config{prefix_directives}) {
1308 \[\[(!) # directive open; 2: prefix
1309 ([-\w]+) # 3: command
1310 ( # 4: the parameters..
1311 \s+ # Must have space if parameters present
1313 (?:[-\w]+=)? # named parameter key?
1315 """.*?""" # triple-quoted value
1317 "[^"]+" # single-quoted value
1319 [^"\s\]]+ # unquoted value
1321 \s* # whitespace or end
1324 *)? # 0 or more parameters
1325 \]\] # directive closed
1331 \[\[(!?) # directive open; 2: optional prefix
1332 ([-\w]+) # 3: command
1334 ( # 4: the parameters..
1336 (?:[-\w]+=)? # named parameter key?
1338 """.*?""" # triple-quoted value
1340 "[^"]+" # single-quoted value
1342 [^"\s\]]+ # unquoted value
1344 \s* # whitespace or end
1347 *) # 0 or more parameters
1348 \]\] # directive closed
1352 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1361 run_hooks(filter => sub {
1362 $content=shift->(page => $page, destpage => $destpage,
1363 content => $content);
1370 return "<a href=\"$config{url}\">$config{wikiname}</a>";
1373 sub check_canedit ($$$;$) {
1380 run_hooks(canedit => sub {
1381 return if defined $canedit;
1382 my $ret=shift->($page, $q, $session);
1387 elsif (ref $ret eq 'CODE') {
1388 $ret->() unless $nonfatal;
1391 elsif (defined $ret) {
1392 error($ret) unless $nonfatal;
1397 return defined $canedit ? $canedit : 1;
1400 sub check_content (@) {
1403 return 1 if ! exists $hooks{checkcontent}; # optimisation
1405 if (exists $pagesources{$params{page}}) {
1407 my %old=map { $_ => 1 }
1408 split("\n", readfile(srcfile($pagesources{$params{page}})));
1409 foreach my $line (split("\n", $params{content})) {
1410 push @diff, $line if ! exists $old{$line};
1412 $params{diff}=join("\n", @diff);
1416 run_hooks(checkcontent => sub {
1417 return if defined $ok;
1418 my $ret=shift->(%params);
1423 elsif (ref $ret eq 'CODE') {
1424 $ret->() unless $params{nonfatal};
1427 elsif (defined $ret) {
1428 error($ret) unless $params{nonfatal};
1434 return defined $ok ? $ok : 1;
1440 # Take an exclusive lock on the wiki to prevent multiple concurrent
1441 # run issues. The lock will be dropped on program exit.
1442 if (! -d $config{wikistatedir}) {
1443 mkdir($config{wikistatedir});
1445 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1446 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1447 if (! flock($wikilock, 2)) { # LOCK_EX
1448 error("failed to get lock");
1454 POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1455 return close($wikilock) if $wikilock;
1461 sub commit_hook_enabled () {
1462 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1463 error("cannot write to $config{wikistatedir}/commitlock: $!");
1464 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1465 close($commitlock) || error("failed closing commitlock: $!");
1468 close($commitlock) || error("failed closing commitlock: $!");
1472 sub disable_commit_hook () {
1473 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1474 error("cannot write to $config{wikistatedir}/commitlock: $!");
1475 if (! flock($commitlock, 2)) { # LOCK_EX
1476 error("failed to get commit lock");
1481 sub enable_commit_hook () {
1482 return close($commitlock) if $commitlock;
1487 %oldrenderedfiles=%pagectime=();
1488 if (! $config{rebuild}) {
1489 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1490 %destsources=%renderedfiles=%pagecase=%pagestate=
1494 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1495 if (-e "$config{wikistatedir}/index") {
1496 system("ikiwiki-transition", "indexdb", $config{srcdir});
1497 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1504 my $index=Storable::fd_retrieve($in);
1505 if (! defined $index) {
1510 if (exists $index->{version} && ! ref $index->{version}) {
1511 $pages=$index->{page};
1512 %wikistate=%{$index->{state}};
1519 foreach my $src (keys %$pages) {
1520 my $d=$pages->{$src};
1521 my $page=pagename($src);
1522 $pagectime{$page}=$d->{ctime};
1523 if (! $config{rebuild}) {
1524 $pagesources{$page}=$src;
1525 $pagemtime{$page}=$d->{mtime};
1526 $renderedfiles{$page}=$d->{dest};
1527 if (exists $d->{links} && ref $d->{links}) {
1528 $links{$page}=$d->{links};
1529 $oldlinks{$page}=[@{$d->{links}}];
1531 if (ref $d->{depends_simple} eq 'ARRAY') {
1533 $depends_simple{$page}={
1534 map { $_ => 1 } @{$d->{depends_simple}}
1537 elsif (exists $d->{depends_simple}) {
1538 $depends_simple{$page}=$d->{depends_simple};
1540 if (exists $d->{dependslist}) {
1543 map { $_ => $DEPEND_CONTENT }
1544 @{$d->{dependslist}}
1547 elsif (exists $d->{depends} && ! ref $d->{depends}) {
1549 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
1551 elsif (exists $d->{depends}) {
1552 $depends{$page}=$d->{depends};
1554 if (exists $d->{state}) {
1555 $pagestate{$page}=$d->{state};
1558 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1560 foreach my $page (keys %pagesources) {
1561 $pagecase{lc $page}=$page;
1563 foreach my $page (keys %renderedfiles) {
1564 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1570 run_hooks(savestate => sub { shift->() });
1573 foreach my $type (keys %hooks) {
1574 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1576 my @hookids=keys %hookids;
1578 if (! -d $config{wikistatedir}) {
1579 mkdir($config{wikistatedir});
1581 my $newfile="$config{wikistatedir}/indexdb.new";
1582 my $cleanup = sub { unlink($newfile) };
1583 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1586 foreach my $page (keys %pagemtime) {
1587 next unless $pagemtime{$page};
1588 my $src=$pagesources{$page};
1590 $index{page}{$src}={
1591 ctime => $pagectime{$page},
1592 mtime => $pagemtime{$page},
1593 dest => $renderedfiles{$page},
1594 links => $links{$page},
1597 if (exists $depends{$page}) {
1598 $index{page}{$src}{depends} = $depends{$page};
1601 if (exists $depends_simple{$page}) {
1602 $index{page}{$src}{depends_simple} = $depends_simple{$page};
1605 if (exists $pagestate{$page}) {
1606 foreach my $id (@hookids) {
1607 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1608 $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1615 foreach my $id (@hookids) {
1616 foreach my $key (keys %{$wikistate{$id}}) {
1617 $index{state}{$id}{$key}=$wikistate{$id}{$key};
1621 $index{version}="3";
1622 my $ret=Storable::nstore_fd(\%index, $out);
1623 return if ! defined $ret || ! $ret;
1624 close $out || error("failed saving to $newfile: $!", $cleanup);
1625 rename($newfile, "$config{wikistatedir}/indexdb") ||
1626 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1631 sub template_file ($) {
1634 foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
1635 "$installdir/share/ikiwiki/templates") {
1636 return "$dir/$template" if -e "$dir/$template";
1641 sub template_params (@) {
1642 my $filename=template_file(shift);
1644 if (! defined $filename) {
1645 return if wantarray;
1651 my $text_ref = shift;
1652 ${$text_ref} = decode_utf8(${$text_ref});
1654 filename => $filename,
1655 loop_context_vars => 1,
1656 die_on_bad_params => 0,
1659 return wantarray ? @ret : {@ret};
1662 sub template ($;@) {
1663 require HTML::Template;
1664 return HTML::Template->new(template_params(@_));
1667 sub misctemplate ($$;@) {
1671 my $template=template("misc.tmpl");
1674 indexlink => indexlink(),
1675 wikiname => $config{wikiname},
1676 pagebody => $pagebody,
1677 baseurl => baseurl(),
1680 run_hooks(pagetemplate => sub {
1681 shift->(page => "", destpage => "", template => $template);
1683 return $template->output;
1689 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1690 error 'hook requires type, call, and id parameters';
1693 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1695 $hooks{$param{type}}{$param{id}}=\%param;
1699 sub run_hooks ($$) {
1700 # Calls the given sub for each hook of the given type,
1701 # passing it the hook function to call.
1705 if (exists $hooks{$type}) {
1706 my (@first, @middle, @last);
1707 foreach my $id (keys %{$hooks{$type}}) {
1708 if ($hooks{$type}{$id}{first}) {
1711 elsif ($hooks{$type}{$id}{last}) {
1718 foreach my $id (@first, @middle, @last) {
1719 $sub->($hooks{$type}{$id}{call});
1727 $hooks{rcs}{rcs_update}{call}->(@_);
1730 sub rcs_prepedit ($) {
1731 $hooks{rcs}{rcs_prepedit}{call}->(@_);
1734 sub rcs_commit ($$$;$$) {
1735 $hooks{rcs}{rcs_commit}{call}->(@_);
1738 sub rcs_commit_staged ($$$) {
1739 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1743 $hooks{rcs}{rcs_add}{call}->(@_);
1746 sub rcs_remove ($) {
1747 $hooks{rcs}{rcs_remove}{call}->(@_);
1750 sub rcs_rename ($$) {
1751 $hooks{rcs}{rcs_rename}{call}->(@_);
1754 sub rcs_recentchanges ($) {
1755 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1759 $hooks{rcs}{rcs_diff}{call}->(@_);
1762 sub rcs_getctime ($) {
1763 $hooks{rcs}{rcs_getctime}{call}->(@_);
1766 sub rcs_receive () {
1767 $hooks{rcs}{rcs_receive}{call}->();
1770 sub add_depends ($$;$) {
1773 my $deptype=shift || $DEPEND_CONTENT;
1775 # Is the pagespec a simple page name?
1776 if ($pagespec =~ /$config{wiki_file_regexp}/ &&
1777 $pagespec !~ /[\s*?()!]/) {
1778 $depends_simple{$page}{lc $pagespec} |= $deptype;
1782 # Add explicit dependencies for influences.
1783 my $sub=pagespec_translate($pagespec);
1785 foreach my $p (keys %pagesources) {
1786 my $r=$sub->($p, location => $page);
1787 my $i=$r->influences;
1788 foreach my $k (keys %$i) {
1789 $depends_simple{$page}{lc $k} |= $i->{$k};
1791 last if $r->influences_static;
1794 $depends{$page}{$pagespec} |= $deptype;
1800 foreach my $type (@_) {
1801 if ($type eq 'presence') {
1802 $deptype |= $DEPEND_PRESENCE;
1804 elsif ($type eq 'links') {
1805 $deptype |= $DEPEND_LINKS;
1807 elsif ($type eq 'content') {
1808 $deptype |= $DEPEND_CONTENT;
1814 sub file_pruned ($;$) {
1818 $file=File::Spec->canonpath($file);
1819 my $base=File::Spec->canonpath(shift);
1820 return if $file eq $base;
1821 $file =~ s#^\Q$base\E/+##;
1824 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1825 return $file =~ m/$regexp/;
1828 sub define_gettext () {
1829 # If translation is needed, redefine the gettext function to do it.
1830 # Otherwise, it becomes a quick no-op.
1831 no warnings 'redefine';
1832 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1833 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1834 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1836 my $gettext_obj=eval q{
1837 use Locale::gettext q{textdomain};
1838 Locale::gettext->domain('ikiwiki')
1842 $gettext_obj->get(shift);
1850 *gettext=sub { return shift };
1862 return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
1866 # Injects a new function into the symbol table to replace an
1867 # exported function.
1870 # This is deep ugly perl foo, beware.
1873 if (! defined $params{parent}) {
1874 $params{parent}='::';
1875 $params{old}=\&{$params{name}};
1876 $params{name}=~s/.*:://;
1878 my $parent=$params{parent};
1879 foreach my $ns (grep /^\w+::/, keys %{$parent}) {
1880 $ns = $params{parent} . $ns;
1881 inject(%params, parent => $ns) unless $ns eq '::main::';
1882 *{$ns . $params{name}} = $params{call}
1883 if exists ${$ns}{$params{name}} &&
1884 \&{${$ns}{$params{name}}} == $params{old};
1894 push @{$links{$page}}, $link
1895 unless grep { $_ eq $link } @{$links{$page}};
1898 sub pagespec_translate ($) {
1901 # Convert spec to perl code.
1905 \s* # ignore whitespace
1906 ( # 1: match a single word
1913 \w+\([^\)]*\) # command(params)
1915 [^\s()]+ # any other text
1917 \s* # ignore whitespace
1920 if (lc $word eq 'and') {
1923 elsif (lc $word eq 'or') {
1926 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1929 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1930 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1932 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
1935 push @data, qq{unknown function in pagespec "$word"};
1936 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
1941 $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
1945 if (! length $code) {
1946 $code="IkiWiki::FailReason->new('empty pagespec')";
1950 return eval 'sub { my $page=shift; '.$code.' }';
1953 sub pagespec_match ($$;@) {
1958 # Backwards compatability with old calling convention.
1960 unshift @params, 'location';
1963 my $sub=pagespec_translate($spec);
1964 return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
1965 if $@ || ! defined $sub;
1966 return $sub->($page, @params);
1969 sub pagespec_match_list ($$;@) {
1974 # Backwards compatability with old calling convention.
1976 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
1977 $params{list}=$page;
1978 $page=$params{location}; # ugh!
1981 my $sub=pagespec_translate($pagespec);
1982 error "syntax error in pagespec \"$pagespec\""
1983 if $@ || ! defined $sub;
1986 if (exists $params{list}) {
1987 @candidates=exists $params{filter}
1988 ? grep { ! $params{filter}->($_) } @{$params{list}}
1992 @candidates=exists $params{filter}
1993 ? grep { ! $params{filter}->($_) } keys %pagesources
1994 : keys %pagesources;
1997 if (defined $params{sort}) {
1999 if ($params{sort} eq 'title') {
2000 $f=sub { pagetitle(basename($a)) cmp pagetitle(basename($b)) };
2002 elsif ($params{sort} eq 'title_natural') {
2003 eval q{use Sort::Naturally};
2005 error(gettext("Sort::Naturally needed for title_natural sort"));
2007 $f=sub { Sort::Naturally::ncmp(pagetitle(basename($a)), pagetitle(basename($b))) };
2009 elsif ($params{sort} eq 'mtime') {
2010 $f=sub { $pagemtime{$b} <=> $pagemtime{$a} };
2012 elsif ($params{sort} eq 'age') {
2013 $f=sub { $pagectime{$b} <=> $pagectime{$a} };
2016 error sprintf(gettext("unknown sort type %s"), $params{sort});
2018 @candidates = sort { &$f } @candidates;
2021 @candidates=reverse(@candidates) if $params{reverse};
2023 $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2025 # clear params, remainder is passed to pagespec
2026 my $num=$params{num};
2027 delete @params{qw{num deptype reverse sort filter list}};
2032 my $accum=IkiWiki::SuccessReason->new();
2033 foreach my $p (@candidates) {
2034 my $r=$sub->($p, %params, location => $page);
2035 error(sprintf(gettext("cannot match pages: %s"), $r))
2036 if $r->isa("IkiWiki::ErrorReason");
2040 last if defined $num && ++$count == $num;
2044 # Add simple dependencies for accumulated influences.
2045 my $i=$accum->influences;
2046 foreach my $k (keys %$i) {
2047 $depends_simple{$page}{lc $k} |= $i->{$k};
2053 sub pagespec_valid ($) {
2056 my $sub=pagespec_translate($spec);
2061 my $re=quotemeta(shift);
2067 package IkiWiki::FailReason;
2070 '""' => sub { $_[0][0] },
2072 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2073 '&' => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2074 '|' => sub { $_[1]->merge_influences($_[0]); $_[1] },
2078 our @ISA = 'IkiWiki::SuccessReason';
2080 package IkiWiki::SuccessReason;
2083 '""' => sub { $_[0][0] },
2085 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
2086 '&' => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2087 '|' => sub { $_[0]->merge_influences($_[1]); $_[0] },
2094 return bless [$value, {@_}], $class;
2099 $this->[1]={@_} if @_;
2100 my %i=%{$this->[1]};
2105 sub influences_static {
2106 return ! $_[0][1]->{""};
2109 sub merge_influences {
2114 if (! $anded || (($this || %{$this->[1]}) &&
2115 ($other || %{$other->[1]}))) {
2116 foreach my $influence (keys %{$other->[1]}) {
2117 $this->[1]{$influence} |= $other->[1]{$influence};
2126 package IkiWiki::ErrorReason;
2128 our @ISA = 'IkiWiki::FailReason';
2130 package IkiWiki::PageSpec;
2136 if ($path =~ m!^\./!) {
2137 $from=~s#/?[^/]+$## if defined $from;
2139 $path="$from/$path" if length $from;
2145 sub match_glob ($$;@) {
2150 $glob=derel($glob, $params{location});
2152 my $regexp=IkiWiki::glob2re($glob);
2153 if ($page=~/^$regexp$/i) {
2154 if (! IkiWiki::isinternal($page) || $params{internal}) {
2155 return IkiWiki::SuccessReason->new("$glob matches $page");
2158 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2162 return IkiWiki::FailReason->new("$glob does not match $page");
2166 sub match_internal ($$;@) {
2167 return match_glob($_[0], $_[1], @_, internal => 1)
2170 sub match_link ($$;@) {
2175 $link=derel($link, $params{location});
2176 my $from=exists $params{location} ? $params{location} : '';
2178 my $links = $IkiWiki::links{$page};
2179 return IkiWiki::FailReason->new("$page has no links", "" => 1)
2180 unless $links && @{$links};
2181 my $bestlink = IkiWiki::bestlink($from, $link);
2182 foreach my $p (@{$links}) {
2183 if (length $bestlink) {
2184 return IkiWiki::SuccessReason->new("$page links to $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2185 if $bestlink eq IkiWiki::bestlink($page, $p);
2188 return IkiWiki::SuccessReason->new("$page links to page $p matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2189 if match_glob($p, $link, %params);
2190 my ($p_rel)=$p=~/^\/?(.*)/;
2192 return IkiWiki::SuccessReason->new("$page links to page $p_rel matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2193 if match_glob($p_rel, $link, %params);
2196 return IkiWiki::FailReason->new("$page does not link to $link", "" => 1);
2199 sub match_backlink ($$;@) {
2200 my $ret=match_link($_[1], $_[0], @_);
2201 $ret->influences($_[1] => $IkiWiki::DEPEND_LINKS);
2205 sub match_created_before ($$;@) {
2210 $testpage=derel($testpage, $params{location});
2212 if (exists $IkiWiki::pagectime{$testpage}) {
2213 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2214 return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2217 return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2221 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2225 sub match_created_after ($$;@) {
2230 $testpage=derel($testpage, $params{location});
2232 if (exists $IkiWiki::pagectime{$testpage}) {
2233 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2234 return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2237 return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2241 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2245 sub match_creation_day ($$;@) {
2246 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
2247 return IkiWiki::SuccessReason->new('creation_day matched');
2250 return IkiWiki::FailReason->new('creation_day did not match');
2254 sub match_creation_month ($$;@) {
2255 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
2256 return IkiWiki::SuccessReason->new('creation_month matched');
2259 return IkiWiki::FailReason->new('creation_month did not match');
2263 sub match_creation_year ($$;@) {
2264 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
2265 return IkiWiki::SuccessReason->new('creation_year matched');
2268 return IkiWiki::FailReason->new('creation_year did not match');
2272 sub match_user ($$;@) {
2277 if (! exists $params{user}) {
2278 return IkiWiki::ErrorReason->new("no user specified");
2281 if (defined $params{user} && lc $params{user} eq lc $user) {
2282 return IkiWiki::SuccessReason->new("user is $user");
2284 elsif (! defined $params{user}) {
2285 return IkiWiki::FailReason->new("not logged in");
2288 return IkiWiki::FailReason->new("user is $params{user}, not $user");
2292 sub match_admin ($$;@) {
2297 if (! exists $params{user}) {
2298 return IkiWiki::ErrorReason->new("no user specified");
2301 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
2302 return IkiWiki::SuccessReason->new("user is an admin");
2304 elsif (! defined $params{user}) {
2305 return IkiWiki::FailReason->new("not logged in");
2308 return IkiWiki::FailReason->new("user is not an admin");
2312 sub match_ip ($$;@) {
2317 if (! exists $params{ip}) {
2318 return IkiWiki::ErrorReason->new("no IP specified");
2321 if (defined $params{ip} && lc $params{ip} eq lc $ip) {
2322 return IkiWiki::SuccessReason->new("IP is $ip");
2325 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");