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
24 %config %links %pagestate %wikistate %renderedfiles
25 %pagesources %destsources);
26 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
27 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
28 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
33 memoize("pagespec_translate");
34 memoize("file_pruned");
36 sub getsetup () { #{{{
40 description => "name of the wiki",
47 example => 'me@example.com',
48 description => "contact email for wiki",
55 description => "users who are wiki admins",
62 description => "users who are banned from the wiki",
69 example => "$ENV{HOME}/wiki",
70 description => "where the source of the wiki is located",
77 example => "/var/www/wiki",
78 description => "where to build the wiki",
85 example => "http://example.com/wiki",
86 description => "base url to the wiki",
93 example => "http://example.com/wiki/ikiwiki.cgi",
94 description => "url to the ikiwiki.cgi",
101 example => "/var/www/wiki/ikiwiki.cgi",
102 description => "cgi wrapper to generate",
109 description => "mode for cgi_wrapper (can safely be made suid)",
116 description => "rcs backend to use",
117 safe => 0, # don't allow overriding
122 default => [qw{mdwn link inline htmlscrubber passwordauth
123 openid signinedit lockedit conditional
124 recentchanges parentlinks editpage}],
125 description => "plugins to enable by default",
132 description => "plugins to add to the default configuration",
139 description => "plugins to disable",
145 default => "$installdir/share/ikiwiki/templates",
146 description => "location of template files",
153 default => "$installdir/share/ikiwiki/basewiki",
154 description => "base wiki source location",
162 description => "wrappers to generate",
169 description => "additional underlays to use",
176 description => "display verbose messages when building?",
183 description => "log to syslog?",
190 description => "create output files named page/index.html?",
191 safe => 0, # changing requires manual transition
194 prefix_directives => {
197 description => "use '!'-prefixed preprocessor directives?",
198 safe => 0, # changing requires manual transition
204 description => "use page/index.mdwn source files",
211 description => "enable Discussion pages?",
218 description => "only send cookies over SSL connections?",
226 description => "extension to use for new pages",
227 safe => 0, # not sanitized
233 description => "extension to use for html files",
234 safe => 0, # not sanitized
240 description => "strftime format string to display date",
248 example => "en_US.UTF-8",
249 description => "UTF-8 locale to use",
258 description => "put user pages below specified page",
265 description => "how many backlinks to show before hiding excess (0 to show all)",
272 description => "attempt to hardlink source files? (optimisation for large files)",
274 safe => 0, # paranoia
281 description => "force ikiwiki to use a particular umask",
283 safe => 0, # paranoia
289 example => "$ENV{HOME}/.ikiwiki/",
290 description => "extra library and plugin directory",
292 safe => 0, # directory
298 description => "environment variables",
299 safe => 0, # paranoia
306 description => "regexp of source files to ignore",
311 wiki_file_prune_regexps => {
313 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
314 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
315 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
318 description => "regexps of source files to ignore",
324 description => "specifies the characters that are allowed in source filenames",
325 default => "-[:alnum:]+/.:_",
329 wiki_file_regexp => {
331 description => "regexp of legal source files",
335 web_commit_regexp => {
337 default => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
338 description => "regexp to parse web commits from logs",
345 description => "run as a cgi",
349 cgi_disable_uploads => {
352 description => "whether CGI should accept file uploads",
359 description => "run as a post-commit hook",
366 description => "running in rebuild mode",
373 description => "running in setup mode",
380 description => "running in refresh mode",
387 description => "running in getctime mode",
394 description => "running in w3mmode",
401 description => "path to setup file",
405 allow_symlinks_before_srcdir => {
408 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
414 sub defaultconfig () { #{{{
417 foreach my $key (keys %s) {
418 push @ret, $key, $s{$key}->{default};
424 sub checkconfig () { #{{{
425 # locale stuff; avoid LC_ALL since it overrides everything
426 if (defined $ENV{LC_ALL}) {
427 $ENV{LANG} = $ENV{LC_ALL};
430 if (defined $config{locale}) {
431 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
432 $ENV{LANG}=$config{locale};
437 if (! defined $config{wiki_file_regexp}) {
438 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
441 if (ref $config{ENV} eq 'HASH') {
442 foreach my $val (keys %{$config{ENV}}) {
443 $ENV{$val}=$config{ENV}{$val};
447 if ($config{w3mmode}) {
448 eval q{use Cwd q{abs_path}};
450 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
451 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
452 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
453 unless $config{cgiurl} =~ m!file:///!;
454 $config{url}="file://".$config{destdir};
457 if ($config{cgi} && ! length $config{url}) {
458 error(gettext("Must specify url to wiki with --url when using --cgi"));
461 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
462 unless exists $config{wikistatedir};
464 if (defined $config{umask}) {
465 umask(possibly_foolish_untaint($config{umask}));
468 run_hooks(checkconfig => sub { shift->() });
473 sub listplugins () { #{{{
476 foreach my $dir (@INC, $config{libdir}) {
477 next unless defined $dir && length $dir;
478 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
479 my ($plugin)=$file=~/.*\/(.*)\.pm$/;
483 foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
484 next unless defined $dir && length $dir;
485 foreach my $file (glob("$dir/plugins/*")) {
486 $ret{basename($file)}=1 if -x $file;
493 sub loadplugins () { #{{{
494 if (defined $config{libdir} && length $config{libdir}) {
495 unshift @INC, possibly_foolish_untaint($config{libdir});
498 foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
503 if (exists $IkiWiki::hooks{rcs}) {
504 error(gettext("cannot use multiple rcs plugins"));
506 loadplugin($config{rcs});
508 if (! exists $IkiWiki::hooks{rcs}) {
512 run_hooks(getopt => sub { shift->() });
513 if (grep /^-/, @ARGV) {
514 print STDERR "Unknown option: $_\n"
515 foreach grep /^-/, @ARGV;
522 sub loadplugin ($) { #{{{
525 return if grep { $_ eq $plugin} @{$config{disable_plugins}};
527 foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
528 "$installdir/lib/ikiwiki") {
529 if (defined $dir && -x "$dir/plugins/$plugin") {
530 eval { require IkiWiki::Plugin::external };
533 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
535 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
536 $loaded_plugins{$plugin}=1;
541 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
544 error("Failed to load plugin $mod: $@");
546 $loaded_plugins{$plugin}=1;
550 sub error ($;$) { #{{{
553 log_message('err' => $message) if $config{syslog};
554 if (defined $cleaner) {
561 return unless $config{verbose};
562 return log_message(debug => @_);
566 sub log_message ($$) { #{{{
569 if ($config{syslog}) {
572 Sys::Syslog::setlogsock('unix');
573 Sys::Syslog::openlog('ikiwiki', '', 'user');
577 Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
580 elsif (! $config{cgi}) {
584 return print STDERR "@_\n";
588 sub possibly_foolish_untaint ($) { #{{{
590 my ($untainted)=$tainted=~/(.*)/s;
594 sub basename ($) { #{{{
601 sub dirname ($) { #{{{
608 sub pagetype ($) { #{{{
611 if ($page =~ /\.([^.]+)$/) {
612 return $1 if exists $hooks{htmlize}{$1};
617 sub isinternal ($) { #{{{
619 return exists $pagesources{$page} &&
620 $pagesources{$page} =~ /\._([^.]+)$/;
623 sub pagename ($) { #{{{
626 my $type=pagetype($file);
628 $page=~s/\Q.$type\E*$// if defined $type && !$hooks{htmlize}{$type}{keepextension};
629 if ($config{indexpages} && $page=~/(.*)\/index$/) {
635 sub newpagefile ($$) { #{{{
639 if (! $config{indexpages} || $page eq 'index') {
640 return $page.".".$type;
643 return $page."/index.".$type;
647 sub targetpage ($$) { #{{{
651 if (! $config{usedirs} || $page eq 'index') {
652 return $page.".".$ext;
655 return $page."/index.".$ext;
659 sub htmlpage ($) { #{{{
662 return targetpage($page, $config{htmlext});
665 sub srcfile_stat { #{{{
669 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
670 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
671 return "$dir/$file", stat(_) if -e "$dir/$file";
673 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
677 sub srcfile ($;$) { #{{{
678 return (srcfile_stat(@_))[0];
681 sub add_underlay ($) { #{{{
685 $dir="$config{underlaydir}/../$dir";
688 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
689 unshift @{$config{underlaydirs}}, $dir;
695 sub readfile ($;$$) { #{{{
701 error("cannot read a symlink ($file)");
705 open (my $in, "<", $file) || error("failed to read $file: $!");
706 binmode($in) if ($binary);
707 return \*$in if $wantfd;
709 close $in || error("failed to read $file: $!");
713 sub prep_writefile ($$) { #{{{
718 while (length $test) {
719 if (-l "$destdir/$test") {
720 error("cannot write to a symlink ($test)");
722 $test=dirname($test);
725 my $dir=dirname("$destdir/$file");
728 foreach my $s (split(m!/+!, $dir)) {
731 mkdir($d) || error("failed to create directory $d: $!");
739 sub writefile ($$$;$$) { #{{{
740 my $file=shift; # can include subdirs
741 my $destdir=shift; # directory to put file in
746 prep_writefile($file, $destdir);
748 my $newfile="$destdir/$file.ikiwiki-new";
750 error("cannot write to a symlink ($newfile)");
753 my $cleanup = sub { unlink($newfile) };
754 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
755 binmode($out) if ($binary);
757 $writer->(\*$out, $cleanup);
760 print $out $content or error("failed writing to $newfile: $!", $cleanup);
762 close $out || error("failed saving $newfile: $!", $cleanup);
763 rename($newfile, "$destdir/$file") ||
764 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
770 sub will_render ($$;$) { #{{{
775 # Important security check.
776 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
777 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
778 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
781 if (! $clear || $cleared{$page}) {
782 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
785 foreach my $old (@{$renderedfiles{$page}}) {
786 delete $destsources{$old};
788 $renderedfiles{$page}=[$dest];
791 $destsources{$dest}=$page;
796 sub bestlink ($$) { #{{{
801 if ($link=~s/^\/+//) {
809 $l.="/" if length $l;
812 if (exists $links{$l}) {
815 elsif (exists $pagecase{lc $l}) {
816 return $pagecase{lc $l};
818 } while $cwd=~s{/?[^/]+$}{};
820 if (length $config{userdir}) {
821 my $l = "$config{userdir}/".lc($link);
822 if (exists $links{$l}) {
825 elsif (exists $pagecase{lc $l}) {
826 return $pagecase{lc $l};
830 #print STDERR "warning: page $page, broken link: $link\n";
834 sub isinlinableimage ($) { #{{{
837 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
840 sub pagetitle ($;$) { #{{{
845 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
848 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
854 sub titlepage ($) { #{{{
856 # support use w/o %config set
857 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
858 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
862 sub linkpage ($) { #{{{
864 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
865 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
869 sub cgiurl (@) { #{{{
872 return $config{cgiurl}."?".
873 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
876 sub baseurl (;$) { #{{{
879 return "$config{url}/" if ! defined $page;
881 $page=htmlpage($page);
883 $page=~s/[^\/]+\//..\//g;
887 sub abs2rel ($$) { #{{{
888 # Work around very innefficient behavior in File::Spec if abs2rel
889 # is passed two relative paths. It's much faster if paths are
890 # absolute! (Debian bug #376658; fixed in debian unstable now)
895 my $ret=File::Spec->abs2rel($path, $base);
896 $ret=~s/^// if defined $ret;
900 sub displaytime ($;$) { #{{{
903 if (! defined $format) {
904 $format=$config{timeformat};
907 # strftime doesn't know about encodings, so make sure
908 # its output is properly treated as utf8
909 return decode_utf8(POSIX::strftime($format, localtime($time)));
912 sub beautify_urlpath ($) { #{{{
915 if ($config{usedirs}) {
916 $url =~ s!/index.$config{htmlext}$!/!;
919 # Ensure url is not an empty link, and
920 # if it's relative, make that explicit to avoid colon confusion.
928 sub urlto ($$;$) { #{{{
934 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
937 if (! $destsources{$to}) {
942 return $config{url}.beautify_urlpath("/".$to);
945 my $link = abs2rel($to, dirname(htmlpage($from)));
947 return beautify_urlpath($link);
950 sub htmllink ($$$;@) { #{{{
951 my $lpage=shift; # the page doing the linking
952 my $page=shift; # the page that will contain the link (different for inline)
959 if (! $opts{forcesubpage}) {
960 $bestlink=bestlink($lpage, $link);
963 $bestlink="$lpage/".lc($link);
967 if (defined $opts{linktext}) {
968 $linktext=$opts{linktext};
971 $linktext=pagetitle(basename($link));
974 return "<span class=\"selflink\">$linktext</span>"
975 if length $bestlink && $page eq $bestlink &&
976 ! defined $opts{anchor};
978 if (! $destsources{$bestlink}) {
979 $bestlink=htmlpage($bestlink);
981 if (! $destsources{$bestlink}) {
982 return $linktext unless length $config{cgiurl};
983 return "<span class=\"createlink\"><a href=\"".
989 "\" rel=\"nofollow\">?</a>$linktext</span>"
993 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
994 $bestlink=beautify_urlpath($bestlink);
996 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
997 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1000 if (defined $opts{anchor}) {
1001 $bestlink.="#".$opts{anchor};
1005 if (defined $opts{rel}) {
1006 push @attrs, ' rel="'.$opts{rel}.'"';
1008 if (defined $opts{class}) {
1009 push @attrs, ' class="'.$opts{class}.'"';
1012 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1015 sub userlink ($) { #{{{
1018 my $oiduser=eval { openiduser($user) };
1019 if (defined $oiduser) {
1020 return "<a href=\"$user\">$oiduser</a>";
1023 eval q{use CGI 'escapeHTML'};
1026 return htmllink("", "", escapeHTML(
1027 length $config{userdir} ? $config{userdir}."/".$user : $user
1028 ), noimageinline => 1);
1032 sub htmlize ($$$$) { #{{{
1038 my $oneline = $content !~ /\n/;
1040 if (exists $hooks{htmlize}{$type}) {
1041 $content=$hooks{htmlize}{$type}{call}->(
1043 content => $content,
1047 error("htmlization of $type not supported");
1050 run_hooks(sanitize => sub {
1053 destpage => $destpage,
1054 content => $content,
1059 # hack to get rid of enclosing junk added by markdown
1060 # and other htmlizers
1061 $content=~s/^<p>//i;
1062 $content=~s/<\/p>$//i;
1069 sub linkify ($$$) { #{{{
1074 run_hooks(linkify => sub {
1077 destpage => $destpage,
1078 content => $content,
1086 our $preprocess_preview=0;
1087 sub preprocess ($$$;$$) { #{{{
1088 my $page=shift; # the page the data comes from
1089 my $destpage=shift; # the page the data will appear in (different for inline)
1094 # Using local because it needs to be set within any nested calls
1096 local $preprocess_preview=$preview if defined $preview;
1103 $params="" if ! defined $params;
1105 if (length $escape) {
1106 return "[[$prefix$command $params]]";
1108 elsif (exists $hooks{preprocess}{$command}) {
1109 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1110 # Note: preserve order of params, some plugins may
1111 # consider it significant.
1113 while ($params =~ m{
1114 (?:([-\w]+)=)? # 1: named parameter key?
1116 """(.*?)""" # 2: triple-quoted value
1118 "([^"]+)" # 3: single-quoted value
1120 (\S+) # 4: unquoted value
1122 (?:\s+|$) # delimiter to next param
1132 elsif (defined $3) {
1135 elsif (defined $4) {
1140 push @params, $key, $val;
1143 push @params, $val, '';
1146 if ($preprocessing{$page}++ > 3) {
1147 # Avoid loops of preprocessed pages preprocessing
1148 # other pages that preprocess them, etc.
1149 return "[[!$command <span class=\"error\">".
1150 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1151 $page, $preprocessing{$page}).
1157 $hooks{preprocess}{$command}{call}->(
1160 destpage => $destpage,
1161 preview => $preprocess_preview,
1166 $ret="[[!$command <span class=\"error\">".
1167 gettext("Error").": $@"."</span>]]";
1171 # use void context during scan pass
1173 $hooks{preprocess}{$command}{call}->(
1176 destpage => $destpage,
1177 preview => $preprocess_preview,
1182 $preprocessing{$page}--;
1186 return "[[$prefix$command $params]]";
1191 if ($config{prefix_directives}) {
1194 \[\[(!) # directive open; 2: prefix
1195 ([-\w]+) # 3: command
1196 ( # 4: the parameters..
1197 \s+ # Must have space if parameters present
1199 (?:[-\w]+=)? # named parameter key?
1201 """.*?""" # triple-quoted value
1203 "[^"]+" # single-quoted value
1205 [^\s\]]+ # unquoted value
1207 \s* # whitespace or end
1210 *)? # 0 or more parameters
1211 \]\] # directive closed
1217 \[\[(!?) # directive open; 2: optional prefix
1218 ([-\w]+) # 3: command
1220 ( # 4: the parameters..
1222 (?:[-\w]+=)? # named parameter key?
1224 """.*?""" # triple-quoted value
1226 "[^"]+" # single-quoted value
1228 [^\s\]]+ # unquoted value
1230 \s* # whitespace or end
1233 *) # 0 or more parameters
1234 \]\] # directive closed
1238 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1242 sub filter ($$$) { #{{{
1247 run_hooks(filter => sub {
1248 $content=shift->(page => $page, destpage => $destpage,
1249 content => $content);
1255 sub indexlink () { #{{{
1256 return "<a href=\"$config{url}\">$config{wikiname}</a>";
1261 sub lockwiki (;$) { #{{{
1262 my $wait=@_ ? shift : 1;
1263 # Take an exclusive lock on the wiki to prevent multiple concurrent
1264 # run issues. The lock will be dropped on program exit.
1265 if (! -d $config{wikistatedir}) {
1266 mkdir($config{wikistatedir});
1268 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1269 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1270 if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
1272 debug("wiki seems to be locked, waiting for lock");
1273 my $wait=600; # arbitrary, but don't hang forever to
1274 # prevent process pileup
1276 return if flock($wikilock, 2 | 4);
1279 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
1288 sub unlockwiki () { #{{{
1289 return close($wikilock) if $wikilock;
1295 sub commit_hook_enabled () { #{{{
1296 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1297 error("cannot write to $config{wikistatedir}/commitlock: $!");
1298 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1299 close($commitlock) || error("failed closing commitlock: $!");
1302 close($commitlock) || error("failed closing commitlock: $!");
1306 sub disable_commit_hook () { #{{{
1307 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1308 error("cannot write to $config{wikistatedir}/commitlock: $!");
1309 if (! flock($commitlock, 2)) { # LOCK_EX
1310 error("failed to get commit lock");
1315 sub enable_commit_hook () { #{{{
1316 return close($commitlock) if $commitlock;
1320 sub loadindex () { #{{{
1321 %oldrenderedfiles=%pagectime=();
1322 if (! $config{rebuild}) {
1323 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1324 %destsources=%renderedfiles=%pagecase=%pagestate=();
1327 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1328 if (-e "$config{wikistatedir}/index") {
1329 system("ikiwiki-transition", "indexdb", $config{srcdir});
1330 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1337 my $index=Storable::fd_retrieve($in);
1338 if (! defined $index) {
1343 if (exists $index->{version} && ! ref $index->{version}) {
1344 $pages=$index->{page};
1345 %wikistate=%{$index->{state}};
1352 foreach my $src (keys %$pages) {
1353 my $d=$pages->{$src};
1354 my $page=pagename($src);
1355 $pagectime{$page}=$d->{ctime};
1356 if (! $config{rebuild}) {
1357 $pagesources{$page}=$src;
1358 $pagemtime{$page}=$d->{mtime};
1359 $renderedfiles{$page}=$d->{dest};
1360 if (exists $d->{links} && ref $d->{links}) {
1361 $links{$page}=$d->{links};
1362 $oldlinks{$page}=[@{$d->{links}}];
1364 if (exists $d->{depends}) {
1365 $depends{$page}=$d->{depends};
1367 if (exists $d->{state}) {
1368 $pagestate{$page}=$d->{state};
1371 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1373 foreach my $page (keys %pagesources) {
1374 $pagecase{lc $page}=$page;
1376 foreach my $page (keys %renderedfiles) {
1377 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1382 sub saveindex () { #{{{
1383 run_hooks(savestate => sub { shift->() });
1386 foreach my $type (keys %hooks) {
1387 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1389 my @hookids=keys %hookids;
1391 if (! -d $config{wikistatedir}) {
1392 mkdir($config{wikistatedir});
1394 my $newfile="$config{wikistatedir}/indexdb.new";
1395 my $cleanup = sub { unlink($newfile) };
1396 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1399 foreach my $page (keys %pagemtime) {
1400 next unless $pagemtime{$page};
1401 my $src=$pagesources{$page};
1403 $index{page}{$src}={
1404 ctime => $pagectime{$page},
1405 mtime => $pagemtime{$page},
1406 dest => $renderedfiles{$page},
1407 links => $links{$page},
1410 if (exists $depends{$page}) {
1411 $index{page}{$src}{depends} = $depends{$page};
1414 if (exists $pagestate{$page}) {
1415 foreach my $id (@hookids) {
1416 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1417 $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1424 foreach my $id (@hookids) {
1425 foreach my $key (keys %{$wikistate{$id}}) {
1426 $index{state}{$id}{$key}=$wikistate{$id}{$key};
1430 $index{version}="3";
1431 my $ret=Storable::nstore_fd(\%index, $out);
1432 return if ! defined $ret || ! $ret;
1433 close $out || error("failed saving to $newfile: $!", $cleanup);
1434 rename($newfile, "$config{wikistatedir}/indexdb") ||
1435 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1440 sub template_file ($) { #{{{
1443 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1444 return "$dir/$template" if -e "$dir/$template";
1449 sub template_params (@) { #{{{
1450 my $filename=template_file(shift);
1452 if (! defined $filename) {
1453 return if wantarray;
1459 my $text_ref = shift;
1460 ${$text_ref} = decode_utf8(${$text_ref});
1462 filename => $filename,
1463 loop_context_vars => 1,
1464 die_on_bad_params => 0,
1467 return wantarray ? @ret : {@ret};
1470 sub template ($;@) { #{{{
1471 require HTML::Template;
1472 return HTML::Template->new(template_params(@_));
1475 sub misctemplate ($$;@) { #{{{
1479 my $template=template("misc.tmpl");
1482 indexlink => indexlink(),
1483 wikiname => $config{wikiname},
1484 pagebody => $pagebody,
1485 baseurl => baseurl(),
1488 run_hooks(pagetemplate => sub {
1489 shift->(page => "", destpage => "", template => $template);
1491 return $template->output;
1494 sub hook (@) { # {{{
1497 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1498 error 'hook requires type, call, and id parameters';
1501 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1503 $hooks{$param{type}}{$param{id}}=\%param;
1507 sub run_hooks ($$) { # {{{
1508 # Calls the given sub for each hook of the given type,
1509 # passing it the hook function to call.
1513 if (exists $hooks{$type}) {
1515 foreach my $id (keys %{$hooks{$type}}) {
1516 if ($hooks{$type}{$id}{last}) {
1517 push @deferred, $id;
1520 $sub->($hooks{$type}{$id}{call});
1522 foreach my $id (@deferred) {
1523 $sub->($hooks{$type}{$id}{call});
1530 sub rcs_update () { #{{{
1531 $hooks{rcs}{rcs_update}{call}->(@_);
1534 sub rcs_prepedit ($) { #{{{
1535 $hooks{rcs}{rcs_prepedit}{call}->(@_);
1538 sub rcs_commit ($$$;$$) { #{{{
1539 $hooks{rcs}{rcs_commit}{call}->(@_);
1542 sub rcs_commit_staged ($$$) { #{{{
1543 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1546 sub rcs_add ($) { #{{{
1547 $hooks{rcs}{rcs_add}{call}->(@_);
1550 sub rcs_remove ($) { #{{{
1551 $hooks{rcs}{rcs_remove}{call}->(@_);
1554 sub rcs_rename ($$) { #{{{
1555 $hooks{rcs}{rcs_rename}{call}->(@_);
1558 sub rcs_recentchanges ($) { #{{{
1559 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1562 sub rcs_diff ($) { #{{{
1563 $hooks{rcs}{rcs_diff}{call}->(@_);
1566 sub rcs_getctime ($) { #{{{
1567 $hooks{rcs}{rcs_getctime}{call}->(@_);
1570 sub globlist_to_pagespec ($) { #{{{
1571 my @globlist=split(' ', shift);
1574 foreach my $glob (@globlist) {
1575 if ($glob=~/^!(.*)/) {
1583 my $spec=join(' or ', @spec);
1585 my $skip=join(' and ', @skip);
1587 $spec="$skip and ($spec)";
1596 sub is_globlist ($) { #{{{
1598 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1601 sub safequote ($) { #{{{
1607 sub add_depends ($$) { #{{{
1611 return unless pagespec_valid($pagespec);
1613 if (! exists $depends{$page}) {
1614 $depends{$page}=$pagespec;
1617 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1623 sub file_pruned ($$) { #{{{
1625 my $file=File::Spec->canonpath(shift);
1626 my $base=File::Spec->canonpath(shift);
1627 $file =~ s#^\Q$base\E/+##;
1629 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1630 return $file =~ m/$regexp/ && $file ne $base;
1634 # Only use gettext in the rare cases it's needed.
1635 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1636 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1637 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1638 if (! $gettext_obj) {
1639 $gettext_obj=eval q{
1640 use Locale::gettext q{textdomain};
1641 Locale::gettext->domain('ikiwiki')
1649 return $gettext_obj->get(shift);
1656 sub yesno ($) { #{{{
1659 return (defined $val && lc($val) eq gettext("yes"));
1662 sub pagespec_merge ($$) { #{{{
1666 return $a if $a eq $b;
1668 # Support for old-style GlobLists.
1669 if (is_globlist($a)) {
1670 $a=globlist_to_pagespec($a);
1672 if (is_globlist($b)) {
1673 $b=globlist_to_pagespec($b);
1676 return "($a) or ($b)";
1679 sub pagespec_translate ($) { #{{{
1682 # Support for old-style GlobLists.
1683 if (is_globlist($spec)) {
1684 $spec=globlist_to_pagespec($spec);
1687 # Convert spec to perl code.
1690 \s* # ignore whitespace
1691 ( # 1: match a single word
1698 \w+\([^\)]*\) # command(params)
1700 [^\s()]+ # any other text
1702 \s* # ignore whitespace
1705 if (lc $word eq 'and') {
1708 elsif (lc $word eq 'or') {
1711 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1714 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1715 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1716 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1723 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1727 if (! length $code) {
1732 return eval 'sub { my $page=shift; '.$code.' }';
1735 sub pagespec_match ($$;@) { #{{{
1740 # Backwards compatability with old calling convention.
1742 unshift @params, 'location';
1745 my $sub=pagespec_translate($spec);
1746 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1747 return $sub->($page, @params);
1750 sub pagespec_valid ($) { #{{{
1753 my $sub=pagespec_translate($spec);
1757 sub glob2re ($) { #{{{
1758 my $re=quotemeta(shift);
1764 package IkiWiki::FailReason;
1767 '""' => sub { ${$_[0]} },
1769 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1776 return bless \$value, $class;
1779 package IkiWiki::SuccessReason;
1782 '""' => sub { ${$_[0]} },
1784 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1791 return bless \$value, $class;
1794 package IkiWiki::PageSpec;
1796 sub match_glob ($$;@) { #{{{
1801 my $from=exists $params{location} ? $params{location} : '';
1804 if ($glob =~ m!^\./!) {
1805 $from=~s#/?[^/]+$##;
1807 $glob="$from/$glob" if length $from;
1810 my $regexp=IkiWiki::glob2re($glob);
1811 if ($page=~/^$regexp$/i) {
1812 if (! IkiWiki::isinternal($page) || $params{internal}) {
1813 return IkiWiki::SuccessReason->new("$glob matches $page");
1816 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1820 return IkiWiki::FailReason->new("$glob does not match $page");
1824 sub match_internal ($$;@) { #{{{
1825 return match_glob($_[0], $_[1], @_, internal => 1)
1828 sub match_link ($$;@) { #{{{
1833 my $from=exists $params{location} ? $params{location} : '';
1836 if ($link =~ m!^\.! && defined $from) {
1837 $from=~s#/?[^/]+$##;
1839 $link="$from/$link" if length $from;
1842 my $links = $IkiWiki::links{$page};
1843 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1844 my $bestlink = IkiWiki::bestlink($from, $link);
1845 foreach my $p (@{$links}) {
1846 if (length $bestlink) {
1847 return IkiWiki::SuccessReason->new("$page links to $link")
1848 if $bestlink eq IkiWiki::bestlink($page, $p);
1851 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1852 if match_glob($p, $link, %params);
1855 return IkiWiki::FailReason->new("$page does not link to $link");
1858 sub match_backlink ($$;@) { #{{{
1859 return match_link($_[1], $_[0], @_);
1862 sub match_created_before ($$;@) { #{{{
1866 if (exists $IkiWiki::pagectime{$testpage}) {
1867 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1868 return IkiWiki::SuccessReason->new("$page created before $testpage");
1871 return IkiWiki::FailReason->new("$page not created before $testpage");
1875 return IkiWiki::FailReason->new("$testpage has no ctime");
1879 sub match_created_after ($$;@) { #{{{
1883 if (exists $IkiWiki::pagectime{$testpage}) {
1884 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1885 return IkiWiki::SuccessReason->new("$page created after $testpage");
1888 return IkiWiki::FailReason->new("$page not created after $testpage");
1892 return IkiWiki::FailReason->new("$testpage has no ctime");
1896 sub match_creation_day ($$;@) { #{{{
1897 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1898 return IkiWiki::SuccessReason->new('creation_day matched');
1901 return IkiWiki::FailReason->new('creation_day did not match');
1905 sub match_creation_month ($$;@) { #{{{
1906 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1907 return IkiWiki::SuccessReason->new('creation_month matched');
1910 return IkiWiki::FailReason->new('creation_month did not match');
1914 sub match_creation_year ($$;@) { #{{{
1915 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1916 return IkiWiki::SuccessReason->new('creation_year matched');
1919 return IkiWiki::FailReason->new('creation_year did not match');
1923 sub match_user ($$;@) { #{{{
1928 if (! exists $params{user}) {
1929 return IkiWiki::FailReason->new("no user specified");
1932 if (defined $params{user} && lc $params{user} eq lc $user) {
1933 return IkiWiki::SuccessReason->new("user is $user");
1935 elsif (! defined $params{user}) {
1936 return IkiWiki::FailReason->new("not logged in");
1939 return IkiWiki::FailReason->new("user is $params{user}, not $user");
1943 sub match_admin ($$;@) { #{{{
1948 if (! exists $params{user}) {
1949 return IkiWiki::FailReason->new("no user specified");
1952 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
1953 return IkiWiki::SuccessReason->new("user is an admin");
1955 elsif (! defined $params{user}) {
1956 return IkiWiki::FailReason->new("not logged in");
1959 return IkiWiki::FailReason->new("user is not an admin");
1963 sub match_ip ($$;@) { #{{{
1968 if (! exists $params{ip}) {
1969 return IkiWiki::FailReason->new("no IP specified");
1972 if (defined $params{ip} && lc $params{ip} eq lc $ip) {
1973 return IkiWiki::SuccessReason->new("IP is $ip");
1976 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");