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 %hooks %forcerebuild
17 $gettext_obj %loaded_plugins};
19 use Exporter q{import};
20 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
21 bestlink htmllink readfile writefile pagetype srcfile pagename
22 displaytime will_render gettext urlto targetpage
23 add_underlay pagetitle titlepage linkpage newpagefile
25 %config %links %pagestate %wikistate %renderedfiles
26 %pagesources %destsources);
27 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
28 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
29 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
34 memoize("pagespec_translate");
35 memoize("file_pruned");
37 sub getsetup () { #{{{
41 description => "name of the wiki",
48 example => 'me@example.com',
49 description => "contact email for wiki",
56 description => "users who are wiki admins",
63 description => "users who are banned from the wiki",
70 example => "$ENV{HOME}/wiki",
71 description => "where the source of the wiki is located",
78 example => "/var/www/wiki",
79 description => "where to build the wiki",
86 example => "http://example.com/wiki",
87 description => "base url to the wiki",
94 example => "http://example.com/wiki/ikiwiki.cgi",
95 description => "url to the ikiwiki.cgi",
102 example => "/var/www/wiki/ikiwiki.cgi",
103 description => "cgi wrapper to generate",
110 description => "mode for cgi_wrapper (can safely be made suid)",
117 description => "rcs backend to use",
118 safe => 0, # don't allow overriding
123 default => [qw{mdwn link inline meta htmlscrubber passwordauth
124 openid signinedit lockedit conditional
125 recentchanges parentlinks editpage}],
126 description => "plugins to enable by default",
133 description => "plugins to add to the default configuration",
140 description => "plugins to disable",
146 default => "$installdir/share/ikiwiki/templates",
147 description => "location of template files",
154 default => "$installdir/share/ikiwiki/basewiki",
155 description => "base wiki source location",
163 description => "wrappers to generate",
170 description => "additional underlays to use",
177 description => "display verbose messages when building?",
184 description => "log to syslog?",
191 description => "create output files named page/index.html?",
192 safe => 0, # changing requires manual transition
195 prefix_directives => {
198 description => "use '!'-prefixed preprocessor directives?",
199 safe => 0, # changing requires manual transition
205 description => "use page/index.mdwn source files",
212 description => "enable Discussion pages?",
219 description => "only send cookies over SSL connections?",
227 description => "extension to use for new pages",
228 safe => 0, # not sanitized
234 description => "extension to use for html files",
235 safe => 0, # not sanitized
241 description => "strftime format string to display date",
249 example => "en_US.UTF-8",
250 description => "UTF-8 locale to use",
259 description => "put user pages below specified page",
266 description => "how many backlinks to show before hiding excess (0 to show all)",
273 description => "attempt to hardlink source files? (optimisation for large files)",
275 safe => 0, # paranoia
282 description => "force ikiwiki to use a particular umask",
284 safe => 0, # paranoia
290 example => "$ENV{HOME}/.ikiwiki/",
291 description => "extra library and plugin directory",
293 safe => 0, # directory
299 description => "environment variables",
300 safe => 0, # paranoia
307 description => "regexp of source files to ignore",
312 wiki_file_prune_regexps => {
314 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
315 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
316 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
319 description => "regexps of source files to ignore",
325 description => "specifies the characters that are allowed in source filenames",
326 default => "-[:alnum:]+/.:_",
330 wiki_file_regexp => {
332 description => "regexp of legal source files",
336 web_commit_regexp => {
338 default => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
339 description => "regexp to parse web commits from logs",
346 description => "run as a cgi",
350 cgi_disable_uploads => {
353 description => "whether CGI should accept file uploads",
360 description => "run as a post-commit hook",
367 description => "running in rebuild mode",
374 description => "running in setup mode",
381 description => "running in refresh mode",
388 description => "running in receive test mode",
395 description => "running in getctime mode",
402 description => "running in w3mmode",
409 description => "path to the .ikiwiki directory holding ikiwiki state",
416 description => "path to setup file",
420 allow_symlinks_before_srcdir => {
423 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
429 sub defaultconfig () { #{{{
432 foreach my $key (keys %s) {
433 push @ret, $key, $s{$key}->{default};
439 sub checkconfig () { #{{{
440 # locale stuff; avoid LC_ALL since it overrides everything
441 if (defined $ENV{LC_ALL}) {
442 $ENV{LANG} = $ENV{LC_ALL};
445 if (defined $config{locale}) {
446 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
447 $ENV{LANG}=$config{locale};
452 if (! defined $config{wiki_file_regexp}) {
453 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
456 if (ref $config{ENV} eq 'HASH') {
457 foreach my $val (keys %{$config{ENV}}) {
458 $ENV{$val}=$config{ENV}{$val};
462 if ($config{w3mmode}) {
463 eval q{use Cwd q{abs_path}};
465 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
466 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
467 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
468 unless $config{cgiurl} =~ m!file:///!;
469 $config{url}="file://".$config{destdir};
472 if ($config{cgi} && ! length $config{url}) {
473 error(gettext("Must specify url to wiki with --url when using --cgi"));
476 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
477 unless exists $config{wikistatedir} && defined $config{wikistatedir};
479 if (defined $config{umask}) {
480 umask(possibly_foolish_untaint($config{umask}));
483 run_hooks(checkconfig => sub { shift->() });
488 sub listplugins () { #{{{
491 foreach my $dir (@INC, $config{libdir}) {
492 next unless defined $dir && length $dir;
493 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
494 my ($plugin)=$file=~/.*\/(.*)\.pm$/;
498 foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
499 next unless defined $dir && length $dir;
500 foreach my $file (glob("$dir/plugins/*")) {
501 $ret{basename($file)}=1 if -x $file;
508 sub loadplugins () { #{{{
509 if (defined $config{libdir} && length $config{libdir}) {
510 unshift @INC, possibly_foolish_untaint($config{libdir});
513 foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
518 if (exists $IkiWiki::hooks{rcs}) {
519 error(gettext("cannot use multiple rcs plugins"));
521 loadplugin($config{rcs});
523 if (! exists $IkiWiki::hooks{rcs}) {
527 run_hooks(getopt => sub { shift->() });
528 if (grep /^-/, @ARGV) {
529 print STDERR "Unknown option: $_\n"
530 foreach grep /^-/, @ARGV;
537 sub loadplugin ($) { #{{{
540 return if grep { $_ eq $plugin} @{$config{disable_plugins}};
542 foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
543 "$installdir/lib/ikiwiki") {
544 if (defined $dir && -x "$dir/plugins/$plugin") {
545 eval { require IkiWiki::Plugin::external };
548 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
550 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
551 $loaded_plugins{$plugin}=1;
556 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
559 error("Failed to load plugin $mod: $@");
561 $loaded_plugins{$plugin}=1;
565 sub error ($;$) { #{{{
568 log_message('err' => $message) if $config{syslog};
569 if (defined $cleaner) {
576 return unless $config{verbose};
577 return log_message(debug => @_);
581 sub log_message ($$) { #{{{
584 if ($config{syslog}) {
587 Sys::Syslog::setlogsock('unix');
588 Sys::Syslog::openlog('ikiwiki', '', 'user');
592 Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
595 elsif (! $config{cgi}) {
599 return print STDERR "@_\n";
603 sub possibly_foolish_untaint ($) { #{{{
605 my ($untainted)=$tainted=~/(.*)/s;
609 sub basename ($) { #{{{
616 sub dirname ($) { #{{{
623 sub pagetype ($) { #{{{
626 if ($page =~ /\.([^.]+)$/) {
627 return $1 if exists $hooks{htmlize}{$1};
632 sub isinternal ($) { #{{{
634 return exists $pagesources{$page} &&
635 $pagesources{$page} =~ /\._([^.]+)$/;
638 sub pagename ($) { #{{{
641 my $type=pagetype($file);
643 $page=~s/\Q.$type\E*$// if defined $type && !$hooks{htmlize}{$type}{keepextension};
644 if ($config{indexpages} && $page=~/(.*)\/index$/) {
650 sub newpagefile ($$) { #{{{
654 if (! $config{indexpages} || $page eq 'index') {
655 return $page.".".$type;
658 return $page."/index.".$type;
662 sub targetpage ($$) { #{{{
666 if (! $config{usedirs} || $page eq 'index') {
667 return $page.".".$ext;
670 return $page."/index.".$ext;
674 sub htmlpage ($) { #{{{
677 return targetpage($page, $config{htmlext});
680 sub srcfile_stat { #{{{
684 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
685 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
686 return "$dir/$file", stat(_) if -e "$dir/$file";
688 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
692 sub srcfile ($;$) { #{{{
693 return (srcfile_stat(@_))[0];
696 sub add_underlay ($) { #{{{
700 $dir="$config{underlaydir}/../$dir";
703 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
704 unshift @{$config{underlaydirs}}, $dir;
710 sub readfile ($;$$) { #{{{
716 error("cannot read a symlink ($file)");
720 open (my $in, "<", $file) || error("failed to read $file: $!");
721 binmode($in) if ($binary);
722 return \*$in if $wantfd;
724 close $in || error("failed to read $file: $!");
728 sub prep_writefile ($$) { #{{{
733 while (length $test) {
734 if (-l "$destdir/$test") {
735 error("cannot write to a symlink ($test)");
737 $test=dirname($test);
740 my $dir=dirname("$destdir/$file");
743 foreach my $s (split(m!/+!, $dir)) {
746 mkdir($d) || error("failed to create directory $d: $!");
754 sub writefile ($$$;$$) { #{{{
755 my $file=shift; # can include subdirs
756 my $destdir=shift; # directory to put file in
761 prep_writefile($file, $destdir);
763 my $newfile="$destdir/$file.ikiwiki-new";
765 error("cannot write to a symlink ($newfile)");
768 my $cleanup = sub { unlink($newfile) };
769 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
770 binmode($out) if ($binary);
772 $writer->(\*$out, $cleanup);
775 print $out $content or error("failed writing to $newfile: $!", $cleanup);
777 close $out || error("failed saving $newfile: $!", $cleanup);
778 rename($newfile, "$destdir/$file") ||
779 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
785 sub will_render ($$;$) { #{{{
790 # Important security check.
791 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
792 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
793 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
796 if (! $clear || $cleared{$page}) {
797 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
800 foreach my $old (@{$renderedfiles{$page}}) {
801 delete $destsources{$old};
803 $renderedfiles{$page}=[$dest];
806 $destsources{$dest}=$page;
811 sub bestlink ($$) { #{{{
816 if ($link=~s/^\/+//) {
824 $l.="/" if length $l;
827 if (exists $links{$l}) {
830 elsif (exists $pagecase{lc $l}) {
831 return $pagecase{lc $l};
833 } while $cwd=~s{/?[^/]+$}{};
835 if (length $config{userdir}) {
836 my $l = "$config{userdir}/".lc($link);
837 if (exists $links{$l}) {
840 elsif (exists $pagecase{lc $l}) {
841 return $pagecase{lc $l};
845 #print STDERR "warning: page $page, broken link: $link\n";
849 sub isinlinableimage ($) { #{{{
852 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
855 sub pagetitle ($;$) { #{{{
860 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
863 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
869 sub titlepage ($) { #{{{
871 # support use w/o %config set
872 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
873 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
877 sub linkpage ($) { #{{{
879 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
880 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
884 sub cgiurl (@) { #{{{
887 return $config{cgiurl}."?".
888 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
891 sub baseurl (;$) { #{{{
894 return "$config{url}/" if ! defined $page;
896 $page=htmlpage($page);
898 $page=~s/[^\/]+\//..\//g;
902 sub abs2rel ($$) { #{{{
903 # Work around very innefficient behavior in File::Spec if abs2rel
904 # is passed two relative paths. It's much faster if paths are
905 # absolute! (Debian bug #376658; fixed in debian unstable now)
910 my $ret=File::Spec->abs2rel($path, $base);
911 $ret=~s/^// if defined $ret;
915 sub displaytime ($;$) { #{{{
916 # Plugins can override this function to mark up the time to
918 return '<span class="date">'.formattime(@_).'</span>';
921 sub formattime ($;$) { #{{{
922 # Plugins can override this function to format the time.
925 if (! defined $format) {
926 $format=$config{timeformat};
929 # strftime doesn't know about encodings, so make sure
930 # its output is properly treated as utf8
931 return decode_utf8(POSIX::strftime($format, localtime($time)));
934 sub beautify_urlpath ($) { #{{{
937 if ($config{usedirs}) {
938 $url =~ s!/index.$config{htmlext}$!/!;
941 # Ensure url is not an empty link, and
942 # if it's relative, make that explicit to avoid colon confusion.
950 sub urlto ($$;$) { #{{{
956 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
959 if (! $destsources{$to}) {
964 return $config{url}.beautify_urlpath("/".$to);
967 my $link = abs2rel($to, dirname(htmlpage($from)));
969 return beautify_urlpath($link);
972 sub htmllink ($$$;@) { #{{{
973 my $lpage=shift; # the page doing the linking
974 my $page=shift; # the page that will contain the link (different for inline)
981 if (! $opts{forcesubpage}) {
982 $bestlink=bestlink($lpage, $link);
985 $bestlink="$lpage/".lc($link);
989 if (defined $opts{linktext}) {
990 $linktext=$opts{linktext};
993 $linktext=pagetitle(basename($link));
996 return "<span class=\"selflink\">$linktext</span>"
997 if length $bestlink && $page eq $bestlink &&
998 ! defined $opts{anchor};
1000 if (! $destsources{$bestlink}) {
1001 $bestlink=htmlpage($bestlink);
1003 if (! $destsources{$bestlink}) {
1004 return $linktext unless length $config{cgiurl};
1005 return "<span class=\"createlink\"><a href=\"".
1011 "\" rel=\"nofollow\">?</a>$linktext</span>"
1015 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1016 $bestlink=beautify_urlpath($bestlink);
1018 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1019 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1022 if (defined $opts{anchor}) {
1023 $bestlink.="#".$opts{anchor};
1027 if (defined $opts{rel}) {
1028 push @attrs, ' rel="'.$opts{rel}.'"';
1030 if (defined $opts{class}) {
1031 push @attrs, ' class="'.$opts{class}.'"';
1034 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1037 sub userlink ($) { #{{{
1040 my $oiduser=eval { openiduser($user) };
1041 if (defined $oiduser) {
1042 return "<a href=\"$user\">$oiduser</a>";
1045 eval q{use CGI 'escapeHTML'};
1048 return htmllink("", "", escapeHTML(
1049 length $config{userdir} ? $config{userdir}."/".$user : $user
1050 ), noimageinline => 1);
1054 sub htmlize ($$$$) { #{{{
1060 my $oneline = $content !~ /\n/;
1062 if (exists $hooks{htmlize}{$type}) {
1063 $content=$hooks{htmlize}{$type}{call}->(
1065 content => $content,
1069 error("htmlization of $type not supported");
1072 run_hooks(sanitize => sub {
1075 destpage => $destpage,
1076 content => $content,
1081 # hack to get rid of enclosing junk added by markdown
1082 # and other htmlizers
1083 $content=~s/^<p>//i;
1084 $content=~s/<\/p>$//i;
1091 sub linkify ($$$) { #{{{
1096 run_hooks(linkify => sub {
1099 destpage => $destpage,
1100 content => $content,
1108 our $preprocess_preview=0;
1109 sub preprocess ($$$;$$) { #{{{
1110 my $page=shift; # the page the data comes from
1111 my $destpage=shift; # the page the data will appear in (different for inline)
1116 # Using local because it needs to be set within any nested calls
1118 local $preprocess_preview=$preview if defined $preview;
1125 $params="" if ! defined $params;
1127 if (length $escape) {
1128 return "[[$prefix$command $params]]";
1130 elsif (exists $hooks{preprocess}{$command}) {
1131 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1132 # Note: preserve order of params, some plugins may
1133 # consider it significant.
1135 while ($params =~ m{
1136 (?:([-\w]+)=)? # 1: named parameter key?
1138 """(.*?)""" # 2: triple-quoted value
1140 "([^"]+)" # 3: single-quoted value
1142 (\S+) # 4: unquoted value
1144 (?:\s+|$) # delimiter to next param
1154 elsif (defined $3) {
1157 elsif (defined $4) {
1162 push @params, $key, $val;
1165 push @params, $val, '';
1168 if ($preprocessing{$page}++ > 3) {
1169 # Avoid loops of preprocessed pages preprocessing
1170 # other pages that preprocess them, etc.
1171 return "[[!$command <span class=\"error\">".
1172 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1173 $page, $preprocessing{$page}).
1179 $hooks{preprocess}{$command}{call}->(
1182 destpage => $destpage,
1183 preview => $preprocess_preview,
1188 $ret="[[!$command <span class=\"error\">".
1189 gettext("Error").": $@"."</span>]]";
1193 # use void context during scan pass
1195 $hooks{preprocess}{$command}{call}->(
1198 destpage => $destpage,
1199 preview => $preprocess_preview,
1204 $preprocessing{$page}--;
1208 return "[[$prefix$command $params]]";
1213 if ($config{prefix_directives}) {
1216 \[\[(!) # directive open; 2: prefix
1217 ([-\w]+) # 3: command
1218 ( # 4: the parameters..
1219 \s+ # Must have space if parameters present
1221 (?:[-\w]+=)? # named parameter key?
1223 """.*?""" # triple-quoted value
1225 "[^"]+" # single-quoted value
1227 [^\s\]]+ # unquoted value
1229 \s* # whitespace or end
1232 *)? # 0 or more parameters
1233 \]\] # directive closed
1239 \[\[(!?) # directive open; 2: optional prefix
1240 ([-\w]+) # 3: command
1242 ( # 4: the parameters..
1244 (?:[-\w]+=)? # named parameter key?
1246 """.*?""" # triple-quoted value
1248 "[^"]+" # single-quoted value
1250 [^\s\]]+ # unquoted value
1252 \s* # whitespace or end
1255 *) # 0 or more parameters
1256 \]\] # directive closed
1260 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1264 sub filter ($$$) { #{{{
1269 run_hooks(filter => sub {
1270 $content=shift->(page => $page, destpage => $destpage,
1271 content => $content);
1277 sub indexlink () { #{{{
1278 return "<a href=\"$config{url}\">$config{wikiname}</a>";
1283 sub lockwiki () { #{{{
1284 # Take an exclusive lock on the wiki to prevent multiple concurrent
1285 # run issues. The lock will be dropped on program exit.
1286 if (! -d $config{wikistatedir}) {
1287 mkdir($config{wikistatedir});
1289 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1290 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1291 if (! flock($wikilock, 2)) { # LOCK_EX
1292 error("failed to get lock");
1297 sub unlockwiki () { #{{{
1298 return close($wikilock) if $wikilock;
1304 sub commit_hook_enabled () { #{{{
1305 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1306 error("cannot write to $config{wikistatedir}/commitlock: $!");
1307 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1308 close($commitlock) || error("failed closing commitlock: $!");
1311 close($commitlock) || error("failed closing commitlock: $!");
1315 sub disable_commit_hook () { #{{{
1316 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1317 error("cannot write to $config{wikistatedir}/commitlock: $!");
1318 if (! flock($commitlock, 2)) { # LOCK_EX
1319 error("failed to get commit lock");
1324 sub enable_commit_hook () { #{{{
1325 return close($commitlock) if $commitlock;
1329 sub loadindex () { #{{{
1330 %oldrenderedfiles=%pagectime=();
1331 if (! $config{rebuild}) {
1332 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1333 %destsources=%renderedfiles=%pagecase=%pagestate=();
1336 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1337 if (-e "$config{wikistatedir}/index") {
1338 system("ikiwiki-transition", "indexdb", $config{srcdir});
1339 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1346 my $index=Storable::fd_retrieve($in);
1347 if (! defined $index) {
1352 if (exists $index->{version} && ! ref $index->{version}) {
1353 $pages=$index->{page};
1354 %wikistate=%{$index->{state}};
1361 foreach my $src (keys %$pages) {
1362 my $d=$pages->{$src};
1363 my $page=pagename($src);
1364 $pagectime{$page}=$d->{ctime};
1365 if (! $config{rebuild}) {
1366 $pagesources{$page}=$src;
1367 $pagemtime{$page}=$d->{mtime};
1368 $renderedfiles{$page}=$d->{dest};
1369 if (exists $d->{links} && ref $d->{links}) {
1370 $links{$page}=$d->{links};
1371 $oldlinks{$page}=[@{$d->{links}}];
1373 if (exists $d->{depends}) {
1374 $depends{$page}=$d->{depends};
1376 if (exists $d->{state}) {
1377 $pagestate{$page}=$d->{state};
1380 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1382 foreach my $page (keys %pagesources) {
1383 $pagecase{lc $page}=$page;
1385 foreach my $page (keys %renderedfiles) {
1386 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1391 sub saveindex () { #{{{
1392 run_hooks(savestate => sub { shift->() });
1395 foreach my $type (keys %hooks) {
1396 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1398 my @hookids=keys %hookids;
1400 if (! -d $config{wikistatedir}) {
1401 mkdir($config{wikistatedir});
1403 my $newfile="$config{wikistatedir}/indexdb.new";
1404 my $cleanup = sub { unlink($newfile) };
1405 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1408 foreach my $page (keys %pagemtime) {
1409 next unless $pagemtime{$page};
1410 my $src=$pagesources{$page};
1412 $index{page}{$src}={
1413 ctime => $pagectime{$page},
1414 mtime => $pagemtime{$page},
1415 dest => $renderedfiles{$page},
1416 links => $links{$page},
1419 if (exists $depends{$page}) {
1420 $index{page}{$src}{depends} = $depends{$page};
1423 if (exists $pagestate{$page}) {
1424 foreach my $id (@hookids) {
1425 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1426 $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1433 foreach my $id (@hookids) {
1434 foreach my $key (keys %{$wikistate{$id}}) {
1435 $index{state}{$id}{$key}=$wikistate{$id}{$key};
1439 $index{version}="3";
1440 my $ret=Storable::nstore_fd(\%index, $out);
1441 return if ! defined $ret || ! $ret;
1442 close $out || error("failed saving to $newfile: $!", $cleanup);
1443 rename($newfile, "$config{wikistatedir}/indexdb") ||
1444 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1449 sub template_file ($) { #{{{
1452 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1453 return "$dir/$template" if -e "$dir/$template";
1458 sub template_params (@) { #{{{
1459 my $filename=template_file(shift);
1461 if (! defined $filename) {
1462 return if wantarray;
1468 my $text_ref = shift;
1469 ${$text_ref} = decode_utf8(${$text_ref});
1471 filename => $filename,
1472 loop_context_vars => 1,
1473 die_on_bad_params => 0,
1476 return wantarray ? @ret : {@ret};
1479 sub template ($;@) { #{{{
1480 require HTML::Template;
1481 return HTML::Template->new(template_params(@_));
1484 sub misctemplate ($$;@) { #{{{
1488 my $template=template("misc.tmpl");
1491 indexlink => indexlink(),
1492 wikiname => $config{wikiname},
1493 pagebody => $pagebody,
1494 baseurl => baseurl(),
1497 run_hooks(pagetemplate => sub {
1498 shift->(page => "", destpage => "", template => $template);
1500 return $template->output;
1503 sub hook (@) { # {{{
1506 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1507 error 'hook requires type, call, and id parameters';
1510 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1512 $hooks{$param{type}}{$param{id}}=\%param;
1516 sub run_hooks ($$) { # {{{
1517 # Calls the given sub for each hook of the given type,
1518 # passing it the hook function to call.
1522 if (exists $hooks{$type}) {
1524 foreach my $id (keys %{$hooks{$type}}) {
1525 if ($hooks{$type}{$id}{last}) {
1526 push @deferred, $id;
1529 $sub->($hooks{$type}{$id}{call});
1531 foreach my $id (@deferred) {
1532 $sub->($hooks{$type}{$id}{call});
1539 sub rcs_update () { #{{{
1540 $hooks{rcs}{rcs_update}{call}->(@_);
1543 sub rcs_prepedit ($) { #{{{
1544 $hooks{rcs}{rcs_prepedit}{call}->(@_);
1547 sub rcs_commit ($$$;$$) { #{{{
1548 $hooks{rcs}{rcs_commit}{call}->(@_);
1551 sub rcs_commit_staged ($$$) { #{{{
1552 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1555 sub rcs_add ($) { #{{{
1556 $hooks{rcs}{rcs_add}{call}->(@_);
1559 sub rcs_remove ($) { #{{{
1560 $hooks{rcs}{rcs_remove}{call}->(@_);
1563 sub rcs_rename ($$) { #{{{
1564 $hooks{rcs}{rcs_rename}{call}->(@_);
1567 sub rcs_recentchanges ($) { #{{{
1568 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1571 sub rcs_diff ($) { #{{{
1572 $hooks{rcs}{rcs_diff}{call}->(@_);
1575 sub rcs_getctime ($) { #{{{
1576 $hooks{rcs}{rcs_getctime}{call}->(@_);
1579 sub rcs_receive () { #{{{
1580 $hooks{rcs}{rcs_receive}{call}->();
1583 sub globlist_to_pagespec ($) { #{{{
1584 my @globlist=split(' ', shift);
1587 foreach my $glob (@globlist) {
1588 if ($glob=~/^!(.*)/) {
1596 my $spec=join(' or ', @spec);
1598 my $skip=join(' and ', @skip);
1600 $spec="$skip and ($spec)";
1609 sub is_globlist ($) { #{{{
1611 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1614 sub safequote ($) { #{{{
1620 sub add_depends ($$) { #{{{
1624 return unless pagespec_valid($pagespec);
1626 if (! exists $depends{$page}) {
1627 $depends{$page}=$pagespec;
1630 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1636 sub file_pruned ($$) { #{{{
1638 my $file=File::Spec->canonpath(shift);
1639 my $base=File::Spec->canonpath(shift);
1640 $file =~ s#^\Q$base\E/+##;
1642 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1643 return $file =~ m/$regexp/ && $file ne $base;
1647 # Only use gettext in the rare cases it's needed.
1648 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1649 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1650 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1651 if (! $gettext_obj) {
1652 $gettext_obj=eval q{
1653 use Locale::gettext q{textdomain};
1654 Locale::gettext->domain('ikiwiki')
1662 return $gettext_obj->get(shift);
1669 sub yesno ($) { #{{{
1672 return (defined $val && lc($val) eq gettext("yes"));
1676 # Injects a new function into the symbol table to replace an
1677 # exported function.
1680 # This is deep ugly perl foo, beware.
1683 if (! defined $params{parent}) {
1684 $params{parent}='::';
1685 $params{old}=\&{$params{name}};
1686 $params{name}=~s/.*:://;
1688 my $parent=$params{parent};
1689 foreach my $ns (grep /^\w+::/, keys %{$parent}) {
1690 $ns = $params{parent} . $ns;
1691 inject(%params, parent => $ns) unless $ns eq '::main::';
1692 *{$ns . $params{name}} = $params{call}
1693 if exists ${$ns}{$params{name}} &&
1694 \&{${$ns}{$params{name}}} == $params{old};
1700 sub pagespec_merge ($$) { #{{{
1704 return $a if $a eq $b;
1706 # Support for old-style GlobLists.
1707 if (is_globlist($a)) {
1708 $a=globlist_to_pagespec($a);
1710 if (is_globlist($b)) {
1711 $b=globlist_to_pagespec($b);
1714 return "($a) or ($b)";
1717 sub pagespec_translate ($) { #{{{
1720 # Support for old-style GlobLists.
1721 if (is_globlist($spec)) {
1722 $spec=globlist_to_pagespec($spec);
1725 # Convert spec to perl code.
1728 \s* # ignore whitespace
1729 ( # 1: match a single word
1736 \w+\([^\)]*\) # command(params)
1738 [^\s()]+ # any other text
1740 \s* # ignore whitespace
1743 if (lc $word eq 'and') {
1746 elsif (lc $word eq 'or') {
1749 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1752 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1753 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1754 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1761 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1765 if (! length $code) {
1770 return eval 'sub { my $page=shift; '.$code.' }';
1773 sub pagespec_match ($$;@) { #{{{
1778 # Backwards compatability with old calling convention.
1780 unshift @params, 'location';
1783 my $sub=pagespec_translate($spec);
1784 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1785 return $sub->($page, @params);
1788 sub pagespec_valid ($) { #{{{
1791 my $sub=pagespec_translate($spec);
1795 sub glob2re ($) { #{{{
1796 my $re=quotemeta(shift);
1802 package IkiWiki::FailReason;
1805 '""' => sub { ${$_[0]} },
1807 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1814 return bless \$value, $class;
1817 package IkiWiki::SuccessReason;
1820 '""' => sub { ${$_[0]} },
1822 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1829 return bless \$value, $class;
1832 package IkiWiki::PageSpec;
1834 sub match_glob ($$;@) { #{{{
1839 my $from=exists $params{location} ? $params{location} : '';
1842 if ($glob =~ m!^\./!) {
1843 $from=~s#/?[^/]+$##;
1845 $glob="$from/$glob" if length $from;
1848 my $regexp=IkiWiki::glob2re($glob);
1849 if ($page=~/^$regexp$/i) {
1850 if (! IkiWiki::isinternal($page) || $params{internal}) {
1851 return IkiWiki::SuccessReason->new("$glob matches $page");
1854 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1858 return IkiWiki::FailReason->new("$glob does not match $page");
1862 sub match_internal ($$;@) { #{{{
1863 return match_glob($_[0], $_[1], @_, internal => 1)
1866 sub match_link ($$;@) { #{{{
1871 my $from=exists $params{location} ? $params{location} : '';
1874 if ($link =~ m!^\.! && defined $from) {
1875 $from=~s#/?[^/]+$##;
1877 $link="$from/$link" if length $from;
1880 my $links = $IkiWiki::links{$page};
1881 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1882 my $bestlink = IkiWiki::bestlink($from, $link);
1883 foreach my $p (@{$links}) {
1884 if (length $bestlink) {
1885 return IkiWiki::SuccessReason->new("$page links to $link")
1886 if $bestlink eq IkiWiki::bestlink($page, $p);
1889 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1890 if match_glob($p, $link, %params);
1893 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1894 if match_glob($p, $link, %params);
1897 return IkiWiki::FailReason->new("$page does not link to $link");
1900 sub match_backlink ($$;@) { #{{{
1901 return match_link($_[1], $_[0], @_);
1904 sub match_created_before ($$;@) { #{{{
1908 if (exists $IkiWiki::pagectime{$testpage}) {
1909 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1910 return IkiWiki::SuccessReason->new("$page created before $testpage");
1913 return IkiWiki::FailReason->new("$page not created before $testpage");
1917 return IkiWiki::FailReason->new("$testpage has no ctime");
1921 sub match_created_after ($$;@) { #{{{
1925 if (exists $IkiWiki::pagectime{$testpage}) {
1926 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1927 return IkiWiki::SuccessReason->new("$page created after $testpage");
1930 return IkiWiki::FailReason->new("$page not created after $testpage");
1934 return IkiWiki::FailReason->new("$testpage has no ctime");
1938 sub match_creation_day ($$;@) { #{{{
1939 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1940 return IkiWiki::SuccessReason->new('creation_day matched');
1943 return IkiWiki::FailReason->new('creation_day did not match');
1947 sub match_creation_month ($$;@) { #{{{
1948 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1949 return IkiWiki::SuccessReason->new('creation_month matched');
1952 return IkiWiki::FailReason->new('creation_month did not match');
1956 sub match_creation_year ($$;@) { #{{{
1957 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1958 return IkiWiki::SuccessReason->new('creation_year matched');
1961 return IkiWiki::FailReason->new('creation_year did not match');
1965 sub match_user ($$;@) { #{{{
1970 if (! exists $params{user}) {
1971 return IkiWiki::FailReason->new("no user specified");
1974 if (defined $params{user} && lc $params{user} eq lc $user) {
1975 return IkiWiki::SuccessReason->new("user is $user");
1977 elsif (! defined $params{user}) {
1978 return IkiWiki::FailReason->new("not logged in");
1981 return IkiWiki::FailReason->new("user is $params{user}, not $user");
1985 sub match_admin ($$;@) { #{{{
1990 if (! exists $params{user}) {
1991 return IkiWiki::FailReason->new("no user specified");
1994 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
1995 return IkiWiki::SuccessReason->new("user is an admin");
1997 elsif (! defined $params{user}) {
1998 return IkiWiki::FailReason->new("not logged in");
2001 return IkiWiki::FailReason->new("user is not an admin");
2005 sub match_ip ($$;@) { #{{{
2010 if (! exists $params{ip}) {
2011 return IkiWiki::FailReason->new("no IP specified");
2014 if (defined $params{ip} && lc $params{ip} eq lc $ip) {
2015 return IkiWiki::SuccessReason->new("IP is $ip");
2018 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");