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 ($$) { #{{{
652 run_hooks(targetpage => sub {
659 if (defined $targetpage && (length($targetpage) > 0)) {
662 elsif (! $config{usedirs} || $page eq 'index') {
663 return $page.".".$ext;
666 return $page."/index.".$ext;
670 sub htmlpage ($) { #{{{
673 return targetpage($page, $config{htmlext});
676 sub srcfile_stat { #{{{
680 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
681 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
682 return "$dir/$file", stat(_) if -e "$dir/$file";
684 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
688 sub srcfile ($;$) { #{{{
689 return (srcfile_stat(@_))[0];
692 sub add_underlay ($) { #{{{
696 $dir="$config{underlaydir}/../$dir";
699 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
700 unshift @{$config{underlaydirs}}, $dir;
706 sub readfile ($;$$) { #{{{
712 error("cannot read a symlink ($file)");
716 open (my $in, "<", $file) || error("failed to read $file: $!");
717 binmode($in) if ($binary);
718 return \*$in if $wantfd;
720 close $in || error("failed to read $file: $!");
724 sub prep_writefile ($$) { #{{{
729 while (length $test) {
730 if (-l "$destdir/$test") {
731 error("cannot write to a symlink ($test)");
733 $test=dirname($test);
736 my $dir=dirname("$destdir/$file");
739 foreach my $s (split(m!/+!, $dir)) {
742 mkdir($d) || error("failed to create directory $d: $!");
750 sub writefile ($$$;$$) { #{{{
751 my $file=shift; # can include subdirs
752 my $destdir=shift; # directory to put file in
757 prep_writefile($file, $destdir);
759 my $newfile="$destdir/$file.ikiwiki-new";
761 error("cannot write to a symlink ($newfile)");
764 my $cleanup = sub { unlink($newfile) };
765 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
766 binmode($out) if ($binary);
768 $writer->(\*$out, $cleanup);
771 print $out $content or error("failed writing to $newfile: $!", $cleanup);
773 close $out || error("failed saving $newfile: $!", $cleanup);
774 rename($newfile, "$destdir/$file") ||
775 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
781 sub will_render ($$;$) { #{{{
786 # Important security check.
787 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
788 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
789 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
792 if (! $clear || $cleared{$page}) {
793 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
796 foreach my $old (@{$renderedfiles{$page}}) {
797 delete $destsources{$old};
799 $renderedfiles{$page}=[$dest];
802 $destsources{$dest}=$page;
807 sub bestlink ($$) { #{{{
813 if ($link=~s/^\/+//) {
821 $l.="/" if length $l;
824 if (exists $links{$l}) {
827 elsif (exists $pagecase{lc $l}) {
828 $res=$pagecase{lc $l};
830 } while ($cwd=~s{/?[^/]+$}{} && ! defined $res);
832 if (! defined $res && length $config{userdir}) {
833 my $l = "$config{userdir}/".lc($link);
834 if (exists $links{$l}) {
837 elsif (exists $pagecase{lc $l}) {
838 $res=$pagecase{lc $l};
843 run_hooks(tweakbestlink => sub {
851 #print STDERR "warning: page $page, broken link: $link\n";
856 sub isinlinableimage ($) { #{{{
859 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
862 sub pagetitle ($;$) { #{{{
867 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
870 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
876 sub titlepage ($) { #{{{
878 # support use w/o %config set
879 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
880 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
884 sub linkpage ($) { #{{{
886 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
887 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
891 sub cgiurl (@) { #{{{
894 return $config{cgiurl}."?".
895 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
898 sub baseurl (;$) { #{{{
901 return "$config{url}/" if ! defined $page;
903 $page=htmlpage($page);
905 $page=~s/[^\/]+\//..\//g;
909 sub abs2rel ($$) { #{{{
910 # Work around very innefficient behavior in File::Spec if abs2rel
911 # is passed two relative paths. It's much faster if paths are
912 # absolute! (Debian bug #376658; fixed in debian unstable now)
917 my $ret=File::Spec->abs2rel($path, $base);
918 $ret=~s/^// if defined $ret;
922 sub displaytime ($;$) { #{{{
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 run_hooks(tweakurlpath => sub {
942 $url=shift->(url => $url);
945 # Ensure url is not an empty link, and
946 # if it's relative, make that explicit to avoid colon confusion.
954 sub urlto ($$;$) { #{{{
960 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
963 if (! $destsources{$to}) {
968 return $config{url}.beautify_urlpath("/".$to);
971 my $link = abs2rel($to, dirname(htmlpage($from)));
973 return beautify_urlpath($link);
976 sub htmllink ($$$;@) { #{{{
977 my $lpage=shift; # the page doing the linking
978 my $page=shift; # the page that will contain the link (different for inline)
985 if (! $opts{forcesubpage}) {
986 $bestlink=bestlink($lpage, $link);
989 $bestlink="$lpage/".lc($link);
993 if (defined $opts{linktext}) {
994 $linktext=$opts{linktext};
997 $linktext=pagetitle(basename($link));
1000 return "<span class=\"selflink\">$linktext</span>"
1001 if length $bestlink && $page eq $bestlink &&
1002 ! defined $opts{anchor};
1004 if (! $destsources{$bestlink}) {
1005 $bestlink=htmlpage($bestlink);
1007 if (! $destsources{$bestlink}) {
1008 return $linktext unless length $config{cgiurl};
1009 return "<span class=\"createlink\"><a href=\"".
1015 "\" rel=\"nofollow\">?</a>$linktext</span>"
1019 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1020 $bestlink=beautify_urlpath($bestlink);
1022 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1023 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1026 if (defined $opts{anchor}) {
1027 $bestlink.="#".$opts{anchor};
1031 if (defined $opts{rel}) {
1032 push @attrs, ' rel="'.$opts{rel}.'"';
1034 if (defined $opts{class}) {
1035 push @attrs, ' class="'.$opts{class}.'"';
1038 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1041 sub userlink ($) { #{{{
1044 my $oiduser=eval { openiduser($user) };
1045 if (defined $oiduser) {
1046 return "<a href=\"$user\">$oiduser</a>";
1049 eval q{use CGI 'escapeHTML'};
1052 return htmllink("", "", escapeHTML(
1053 length $config{userdir} ? $config{userdir}."/".$user : $user
1054 ), noimageinline => 1);
1058 sub htmlize ($$$$) { #{{{
1064 my $oneline = $content !~ /\n/;
1066 if (exists $hooks{htmlize}{$type}) {
1067 $content=$hooks{htmlize}{$type}{call}->(
1069 content => $content,
1073 error("htmlization of $type not supported");
1076 run_hooks(sanitize => sub {
1079 destpage => $destpage,
1080 content => $content,
1085 # hack to get rid of enclosing junk added by markdown
1086 # and other htmlizers
1087 $content=~s/^<p>//i;
1088 $content=~s/<\/p>$//i;
1095 sub linkify ($$$) { #{{{
1100 run_hooks(linkify => sub {
1103 destpage => $destpage,
1104 content => $content,
1112 our $preprocess_preview=0;
1113 sub preprocess ($$$;$$) { #{{{
1114 my $page=shift; # the page the data comes from
1115 my $destpage=shift; # the page the data will appear in (different for inline)
1120 # Using local because it needs to be set within any nested calls
1122 local $preprocess_preview=$preview if defined $preview;
1129 $params="" if ! defined $params;
1131 if (length $escape) {
1132 return "[[$prefix$command $params]]";
1134 elsif (exists $hooks{preprocess}{$command}) {
1135 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1136 # Note: preserve order of params, some plugins may
1137 # consider it significant.
1139 while ($params =~ m{
1140 (?:([-\w]+)=)? # 1: named parameter key?
1142 """(.*?)""" # 2: triple-quoted value
1144 "([^"]+)" # 3: single-quoted value
1146 (\S+) # 4: unquoted value
1148 (?:\s+|$) # delimiter to next param
1158 elsif (defined $3) {
1161 elsif (defined $4) {
1166 push @params, $key, $val;
1169 push @params, $val, '';
1172 if ($preprocessing{$page}++ > 3) {
1173 # Avoid loops of preprocessed pages preprocessing
1174 # other pages that preprocess them, etc.
1175 return "[[!$command <span class=\"error\">".
1176 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1177 $page, $preprocessing{$page}).
1183 $hooks{preprocess}{$command}{call}->(
1186 destpage => $destpage,
1187 preview => $preprocess_preview,
1192 $ret="[[!$command <span class=\"error\">".
1193 gettext("Error").": $@"."</span>]]";
1197 # use void context during scan pass
1199 $hooks{preprocess}{$command}{call}->(
1202 destpage => $destpage,
1203 preview => $preprocess_preview,
1208 $preprocessing{$page}--;
1212 return "[[$prefix$command $params]]";
1217 if ($config{prefix_directives}) {
1220 \[\[(!) # directive open; 2: prefix
1221 ([-\w]+) # 3: command
1222 ( # 4: the parameters..
1223 \s+ # Must have space if parameters present
1225 (?:[-\w]+=)? # named parameter key?
1227 """.*?""" # triple-quoted value
1229 "[^"]+" # single-quoted value
1231 [^\s\]]+ # unquoted value
1233 \s* # whitespace or end
1236 *)? # 0 or more parameters
1237 \]\] # directive closed
1243 \[\[(!?) # directive open; 2: optional prefix
1244 ([-\w]+) # 3: command
1246 ( # 4: the parameters..
1248 (?:[-\w]+=)? # named parameter key?
1250 """.*?""" # triple-quoted value
1252 "[^"]+" # single-quoted value
1254 [^\s\]]+ # unquoted value
1256 \s* # whitespace or end
1259 *) # 0 or more parameters
1260 \]\] # directive closed
1264 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1268 sub filter ($$$) { #{{{
1273 run_hooks(filter => sub {
1274 $content=shift->(page => $page, destpage => $destpage,
1275 content => $content);
1281 sub indexlink () { #{{{
1282 return "<a href=\"$config{url}\">$config{wikiname}</a>";
1287 sub lockwiki (;$) { #{{{
1288 my $wait=@_ ? shift : 1;
1289 # Take an exclusive lock on the wiki to prevent multiple concurrent
1290 # run issues. The lock will be dropped on program exit.
1291 if (! -d $config{wikistatedir}) {
1292 mkdir($config{wikistatedir});
1294 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1295 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1296 if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
1298 debug("wiki seems to be locked, waiting for lock");
1299 my $wait=600; # arbitrary, but don't hang forever to
1300 # prevent process pileup
1302 return if flock($wikilock, 2 | 4);
1305 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
1314 sub unlockwiki () { #{{{
1315 return close($wikilock) if $wikilock;
1321 sub commit_hook_enabled () { #{{{
1322 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1323 error("cannot write to $config{wikistatedir}/commitlock: $!");
1324 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1325 close($commitlock) || error("failed closing commitlock: $!");
1328 close($commitlock) || error("failed closing commitlock: $!");
1332 sub disable_commit_hook () { #{{{
1333 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1334 error("cannot write to $config{wikistatedir}/commitlock: $!");
1335 if (! flock($commitlock, 2)) { # LOCK_EX
1336 error("failed to get commit lock");
1341 sub enable_commit_hook () { #{{{
1342 return close($commitlock) if $commitlock;
1346 sub loadindex () { #{{{
1347 %oldrenderedfiles=%pagectime=();
1348 if (! $config{rebuild}) {
1349 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1350 %destsources=%renderedfiles=%pagecase=%pagestate=();
1353 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1354 if (-e "$config{wikistatedir}/index") {
1355 system("ikiwiki-transition", "indexdb", $config{srcdir});
1356 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1363 my $index=Storable::fd_retrieve($in);
1364 if (! defined $index) {
1369 if (exists $index->{version} && ! ref $index->{version}) {
1370 $pages=$index->{page};
1371 %wikistate=%{$index->{state}};
1378 foreach my $src (keys %$pages) {
1379 my $d=$pages->{$src};
1380 my $page=pagename($src);
1381 $pagectime{$page}=$d->{ctime};
1382 if (! $config{rebuild}) {
1383 $pagesources{$page}=$src;
1384 $pagemtime{$page}=$d->{mtime};
1385 $renderedfiles{$page}=$d->{dest};
1386 if (exists $d->{links} && ref $d->{links}) {
1387 $links{$page}=$d->{links};
1388 $oldlinks{$page}=[@{$d->{links}}];
1390 if (exists $d->{depends}) {
1391 $depends{$page}=$d->{depends};
1393 if (exists $d->{state}) {
1394 $pagestate{$page}=$d->{state};
1397 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1399 foreach my $page (keys %pagesources) {
1400 $pagecase{lc $page}=$page;
1402 foreach my $page (keys %renderedfiles) {
1403 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1408 sub saveindex () { #{{{
1409 run_hooks(savestate => sub { shift->() });
1412 foreach my $type (keys %hooks) {
1413 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1415 my @hookids=keys %hookids;
1417 if (! -d $config{wikistatedir}) {
1418 mkdir($config{wikistatedir});
1420 my $newfile="$config{wikistatedir}/indexdb.new";
1421 my $cleanup = sub { unlink($newfile) };
1422 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1425 foreach my $page (keys %pagemtime) {
1426 next unless $pagemtime{$page};
1427 my $src=$pagesources{$page};
1429 $index{page}{$src}={
1430 ctime => $pagectime{$page},
1431 mtime => $pagemtime{$page},
1432 dest => $renderedfiles{$page},
1433 links => $links{$page},
1436 if (exists $depends{$page}) {
1437 $index{page}{$src}{depends} = $depends{$page};
1440 if (exists $pagestate{$page}) {
1441 foreach my $id (@hookids) {
1442 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1443 $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1450 foreach my $id (@hookids) {
1451 foreach my $key (keys %{$wikistate{$id}}) {
1452 $index{state}{$id}{$key}=$wikistate{$id}{$key};
1456 $index{version}="3";
1457 my $ret=Storable::nstore_fd(\%index, $out);
1458 return if ! defined $ret || ! $ret;
1459 close $out || error("failed saving to $newfile: $!", $cleanup);
1460 rename($newfile, "$config{wikistatedir}/indexdb") ||
1461 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1466 sub template_file ($) { #{{{
1469 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1470 return "$dir/$template" if -e "$dir/$template";
1475 sub template_params (@) { #{{{
1476 my $filename=template_file(shift);
1478 if (! defined $filename) {
1479 return if wantarray;
1485 my $text_ref = shift;
1486 ${$text_ref} = decode_utf8(${$text_ref});
1488 filename => $filename,
1489 loop_context_vars => 1,
1490 die_on_bad_params => 0,
1493 return wantarray ? @ret : {@ret};
1496 sub template ($;@) { #{{{
1497 require HTML::Template;
1498 return HTML::Template->new(template_params(@_));
1501 sub misctemplate ($$;@) { #{{{
1505 my $template=template("misc.tmpl");
1508 indexlink => indexlink(),
1509 wikiname => $config{wikiname},
1510 pagebody => $pagebody,
1511 baseurl => baseurl(),
1514 run_hooks(pagetemplate => sub {
1515 shift->(page => "", destpage => "", template => $template);
1517 return $template->output;
1520 sub hook (@) { # {{{
1523 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1524 error 'hook requires type, call, and id parameters';
1527 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1529 $hooks{$param{type}}{$param{id}}=\%param;
1533 sub run_hooks ($$) { # {{{
1534 # Calls the given sub for each hook of the given type,
1535 # passing it the hook function to call.
1539 if (exists $hooks{$type}) {
1541 foreach my $id (keys %{$hooks{$type}}) {
1542 if ($hooks{$type}{$id}{last}) {
1543 push @deferred, $id;
1546 $sub->($hooks{$type}{$id}{call});
1548 foreach my $id (@deferred) {
1549 $sub->($hooks{$type}{$id}{call});
1556 sub rcs_update () { #{{{
1557 $hooks{rcs}{rcs_update}{call}->(@_);
1560 sub rcs_prepedit ($) { #{{{
1561 $hooks{rcs}{rcs_prepedit}{call}->(@_);
1564 sub rcs_commit ($$$;$$) { #{{{
1565 $hooks{rcs}{rcs_commit}{call}->(@_);
1568 sub rcs_commit_staged ($$$) { #{{{
1569 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1572 sub rcs_add ($) { #{{{
1573 $hooks{rcs}{rcs_add}{call}->(@_);
1576 sub rcs_remove ($) { #{{{
1577 $hooks{rcs}{rcs_remove}{call}->(@_);
1580 sub rcs_rename ($$) { #{{{
1581 $hooks{rcs}{rcs_rename}{call}->(@_);
1584 sub rcs_recentchanges ($) { #{{{
1585 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1588 sub rcs_diff ($) { #{{{
1589 $hooks{rcs}{rcs_diff}{call}->(@_);
1592 sub rcs_getctime ($) { #{{{
1593 $hooks{rcs}{rcs_getctime}{call}->(@_);
1596 sub globlist_to_pagespec ($) { #{{{
1597 my @globlist=split(' ', shift);
1600 foreach my $glob (@globlist) {
1601 if ($glob=~/^!(.*)/) {
1609 my $spec=join(' or ', @spec);
1611 my $skip=join(' and ', @skip);
1613 $spec="$skip and ($spec)";
1622 sub is_globlist ($) { #{{{
1624 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1627 sub safequote ($) { #{{{
1633 sub add_depends ($$) { #{{{
1637 return unless pagespec_valid($pagespec);
1639 if (! exists $depends{$page}) {
1640 $depends{$page}=$pagespec;
1643 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1649 sub file_pruned ($$) { #{{{
1651 my $file=File::Spec->canonpath(shift);
1652 my $base=File::Spec->canonpath(shift);
1653 $file =~ s#^\Q$base\E/+##;
1655 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1656 return $file =~ m/$regexp/ && $file ne $base;
1660 # Only use gettext in the rare cases it's needed.
1661 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1662 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1663 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1664 if (! $gettext_obj) {
1665 $gettext_obj=eval q{
1666 use Locale::gettext q{textdomain};
1667 Locale::gettext->domain('ikiwiki')
1675 return $gettext_obj->get(shift);
1682 sub yesno ($) { #{{{
1685 return (defined $val && lc($val) eq gettext("yes"));
1688 sub pagespec_merge ($$) { #{{{
1692 return $a if $a eq $b;
1694 # Support for old-style GlobLists.
1695 if (is_globlist($a)) {
1696 $a=globlist_to_pagespec($a);
1698 if (is_globlist($b)) {
1699 $b=globlist_to_pagespec($b);
1702 return "($a) or ($b)";
1705 sub pagespec_translate ($) { #{{{
1708 # Support for old-style GlobLists.
1709 if (is_globlist($spec)) {
1710 $spec=globlist_to_pagespec($spec);
1713 # Convert spec to perl code.
1716 \s* # ignore whitespace
1717 ( # 1: match a single word
1724 \w+\([^\)]*\) # command(params)
1726 [^\s()]+ # any other text
1728 \s* # ignore whitespace
1731 if (lc $word eq 'and') {
1734 elsif (lc $word eq 'or') {
1737 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1740 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1741 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1742 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1749 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1753 if (! length $code) {
1758 return eval 'sub { my $page=shift; '.$code.' }';
1761 sub pagespec_match ($$;@) { #{{{
1766 # Backwards compatability with old calling convention.
1768 unshift @params, 'location';
1771 my $sub=pagespec_translate($spec);
1772 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1773 return $sub->($page, @params);
1776 sub pagespec_valid ($) { #{{{
1779 my $sub=pagespec_translate($spec);
1783 sub glob2re ($) { #{{{
1784 my $re=quotemeta(shift);
1790 package IkiWiki::FailReason;
1793 '""' => sub { ${$_[0]} },
1795 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1802 return bless \$value, $class;
1805 package IkiWiki::SuccessReason;
1808 '""' => sub { ${$_[0]} },
1810 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1817 return bless \$value, $class;
1820 package IkiWiki::PageSpec;
1822 sub match_glob ($$;@) { #{{{
1827 my $from=exists $params{location} ? $params{location} : '';
1830 if ($glob =~ m!^\./!) {
1831 $from=~s#/?[^/]+$##;
1833 $glob="$from/$glob" if length $from;
1836 my $regexp=IkiWiki::glob2re($glob);
1837 if ($page=~/^$regexp$/i) {
1838 if (! IkiWiki::isinternal($page) || $params{internal}) {
1839 return IkiWiki::SuccessReason->new("$glob matches $page");
1842 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1846 return IkiWiki::FailReason->new("$glob does not match $page");
1850 sub match_internal ($$;@) { #{{{
1851 return match_glob($_[0], $_[1], @_, internal => 1)
1854 sub match_link ($$;@) { #{{{
1859 my $from=exists $params{location} ? $params{location} : '';
1862 if ($link =~ m!^\.! && defined $from) {
1863 $from=~s#/?[^/]+$##;
1865 $link="$from/$link" if length $from;
1868 my $links = $IkiWiki::links{$page};
1869 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1870 my $bestlink = IkiWiki::bestlink($from, $link);
1871 foreach my $p (@{$links}) {
1872 if (length $bestlink) {
1873 return IkiWiki::SuccessReason->new("$page links to $link")
1874 if $bestlink eq IkiWiki::bestlink($page, $p);
1877 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1878 if match_glob($p, $link, %params);
1881 return IkiWiki::FailReason->new("$page does not link to $link");
1884 sub match_backlink ($$;@) { #{{{
1885 return match_link($_[1], $_[0], @_);
1888 sub match_created_before ($$;@) { #{{{
1892 if (exists $IkiWiki::pagectime{$testpage}) {
1893 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1894 return IkiWiki::SuccessReason->new("$page created before $testpage");
1897 return IkiWiki::FailReason->new("$page not created before $testpage");
1901 return IkiWiki::FailReason->new("$testpage has no ctime");
1905 sub match_created_after ($$;@) { #{{{
1909 if (exists $IkiWiki::pagectime{$testpage}) {
1910 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1911 return IkiWiki::SuccessReason->new("$page created after $testpage");
1914 return IkiWiki::FailReason->new("$page not created after $testpage");
1918 return IkiWiki::FailReason->new("$testpage has no ctime");
1922 sub match_creation_day ($$;@) { #{{{
1923 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1924 return IkiWiki::SuccessReason->new('creation_day matched');
1927 return IkiWiki::FailReason->new('creation_day did not match');
1931 sub match_creation_month ($$;@) { #{{{
1932 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1933 return IkiWiki::SuccessReason->new('creation_month matched');
1936 return IkiWiki::FailReason->new('creation_month did not match');
1940 sub match_creation_year ($$;@) { #{{{
1941 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1942 return IkiWiki::SuccessReason->new('creation_year matched');
1945 return IkiWiki::FailReason->new('creation_year did not match');
1949 sub match_user ($$;@) { #{{{
1954 if (! exists $params{user}) {
1955 return IkiWiki::FailReason->new("no user specified");
1958 if (defined $params{user} && lc $params{user} eq lc $user) {
1959 return IkiWiki::SuccessReason->new("user is $user");
1961 elsif (! defined $params{user}) {
1962 return IkiWiki::FailReason->new("not logged in");
1965 return IkiWiki::FailReason->new("user is $params{user}, not $user");
1969 sub match_admin ($$;@) { #{{{
1974 if (! exists $params{user}) {
1975 return IkiWiki::FailReason->new("no user specified");
1978 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
1979 return IkiWiki::SuccessReason->new("user is an admin");
1981 elsif (! defined $params{user}) {
1982 return IkiWiki::FailReason->new("not logged in");
1985 return IkiWiki::FailReason->new("user is not an admin");
1989 sub match_ip ($$;@) { #{{{
1994 if (! exists $params{ip}) {
1995 return IkiWiki::FailReason->new("no IP specified");
1998 if (defined $params{ip} && lc $params{ip} eq lc $ip) {
1999 return IkiWiki::SuccessReason->new("IP is $ip");
2002 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");