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 ($$) { #{{{
812 if ($link=~s/^\/+//) {
820 $l.="/" if length $l;
823 if (exists $links{$l}) {
826 elsif (exists $pagecase{lc $l}) {
827 return $pagecase{lc $l};
829 } while $cwd=~s{/?[^/]+$}{};
831 if (length $config{userdir}) {
832 my $l = "$config{userdir}/".lc($link);
833 if (exists $links{$l}) {
836 elsif (exists $pagecase{lc $l}) {
837 return $pagecase{lc $l};
841 #print STDERR "warning: page $page, broken link: $link\n";
845 sub isinlinableimage ($) { #{{{
848 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
851 sub pagetitle ($;$) { #{{{
856 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
859 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
865 sub titlepage ($) { #{{{
867 # support use w/o %config set
868 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
869 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
873 sub linkpage ($) { #{{{
875 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
876 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
880 sub cgiurl (@) { #{{{
883 return $config{cgiurl}."?".
884 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
887 sub baseurl (;$) { #{{{
890 return "$config{url}/" if ! defined $page;
892 $page=htmlpage($page);
894 $page=~s/[^\/]+\//..\//g;
898 sub abs2rel ($$) { #{{{
899 # Work around very innefficient behavior in File::Spec if abs2rel
900 # is passed two relative paths. It's much faster if paths are
901 # absolute! (Debian bug #376658; fixed in debian unstable now)
906 my $ret=File::Spec->abs2rel($path, $base);
907 $ret=~s/^// if defined $ret;
911 sub displaytime ($;$) { #{{{
914 if (! defined $format) {
915 $format=$config{timeformat};
918 # strftime doesn't know about encodings, so make sure
919 # its output is properly treated as utf8
920 return decode_utf8(POSIX::strftime($format, localtime($time)));
923 sub beautify_urlpath ($) { #{{{
926 if ($config{usedirs}) {
927 $url =~ s!/index.$config{htmlext}$!/!;
930 run_hooks(urlpath => sub {
931 $url=shift->(url => $url);
934 # Ensure url is not an empty link, and
935 # if it's relative, make that explicit to avoid colon confusion.
943 sub urlto ($$;$) { #{{{
949 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
952 if (! $destsources{$to}) {
957 return $config{url}.beautify_urlpath("/".$to);
960 my $link = abs2rel($to, dirname(htmlpage($from)));
962 return beautify_urlpath($link);
965 sub htmllink ($$$;@) { #{{{
966 my $lpage=shift; # the page doing the linking
967 my $page=shift; # the page that will contain the link (different for inline)
974 if (! $opts{forcesubpage}) {
975 $bestlink=bestlink($lpage, $link);
978 $bestlink="$lpage/".lc($link);
982 if (defined $opts{linktext}) {
983 $linktext=$opts{linktext};
986 $linktext=pagetitle(basename($link));
989 return "<span class=\"selflink\">$linktext</span>"
990 if length $bestlink && $page eq $bestlink &&
991 ! defined $opts{anchor};
993 if (! $destsources{$bestlink}) {
994 $bestlink=htmlpage($bestlink);
996 if (! $destsources{$bestlink}) {
997 return $linktext unless length $config{cgiurl};
998 return "<span class=\"createlink\"><a href=\"".
1004 "\" rel=\"nofollow\">?</a>$linktext</span>"
1008 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1009 $bestlink=beautify_urlpath($bestlink);
1011 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1012 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1015 if (defined $opts{anchor}) {
1016 $bestlink.="#".$opts{anchor};
1020 if (defined $opts{rel}) {
1021 push @attrs, ' rel="'.$opts{rel}.'"';
1023 if (defined $opts{class}) {
1024 push @attrs, ' class="'.$opts{class}.'"';
1027 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1030 sub userlink ($) { #{{{
1033 my $oiduser=eval { openiduser($user) };
1034 if (defined $oiduser) {
1035 return "<a href=\"$user\">$oiduser</a>";
1038 eval q{use CGI 'escapeHTML'};
1041 return htmllink("", "", escapeHTML(
1042 length $config{userdir} ? $config{userdir}."/".$user : $user
1043 ), noimageinline => 1);
1047 sub htmlize ($$$$) { #{{{
1053 my $oneline = $content !~ /\n/;
1055 if (exists $hooks{htmlize}{$type}) {
1056 $content=$hooks{htmlize}{$type}{call}->(
1058 content => $content,
1062 error("htmlization of $type not supported");
1065 run_hooks(sanitize => sub {
1068 destpage => $destpage,
1069 content => $content,
1074 # hack to get rid of enclosing junk added by markdown
1075 # and other htmlizers
1076 $content=~s/^<p>//i;
1077 $content=~s/<\/p>$//i;
1084 sub linkify ($$$) { #{{{
1089 run_hooks(linkify => sub {
1092 destpage => $destpage,
1093 content => $content,
1101 our $preprocess_preview=0;
1102 sub preprocess ($$$;$$) { #{{{
1103 my $page=shift; # the page the data comes from
1104 my $destpage=shift; # the page the data will appear in (different for inline)
1109 # Using local because it needs to be set within any nested calls
1111 local $preprocess_preview=$preview if defined $preview;
1118 $params="" if ! defined $params;
1120 if (length $escape) {
1121 return "[[$prefix$command $params]]";
1123 elsif (exists $hooks{preprocess}{$command}) {
1124 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1125 # Note: preserve order of params, some plugins may
1126 # consider it significant.
1128 while ($params =~ m{
1129 (?:([-\w]+)=)? # 1: named parameter key?
1131 """(.*?)""" # 2: triple-quoted value
1133 "([^"]+)" # 3: single-quoted value
1135 (\S+) # 4: unquoted value
1137 (?:\s+|$) # delimiter to next param
1147 elsif (defined $3) {
1150 elsif (defined $4) {
1155 push @params, $key, $val;
1158 push @params, $val, '';
1161 if ($preprocessing{$page}++ > 3) {
1162 # Avoid loops of preprocessed pages preprocessing
1163 # other pages that preprocess them, etc.
1164 return "[[!$command <span class=\"error\">".
1165 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1166 $page, $preprocessing{$page}).
1172 $hooks{preprocess}{$command}{call}->(
1175 destpage => $destpage,
1176 preview => $preprocess_preview,
1181 $ret="[[!$command <span class=\"error\">".
1182 gettext("Error").": $@"."</span>]]";
1186 # use void context during scan pass
1188 $hooks{preprocess}{$command}{call}->(
1191 destpage => $destpage,
1192 preview => $preprocess_preview,
1197 $preprocessing{$page}--;
1201 return "[[$prefix$command $params]]";
1206 if ($config{prefix_directives}) {
1209 \[\[(!) # directive open; 2: prefix
1210 ([-\w]+) # 3: command
1211 ( # 4: the parameters..
1212 \s+ # Must have space if parameters present
1214 (?:[-\w]+=)? # named parameter key?
1216 """.*?""" # triple-quoted value
1218 "[^"]+" # single-quoted value
1220 [^\s\]]+ # unquoted value
1222 \s* # whitespace or end
1225 *)? # 0 or more parameters
1226 \]\] # directive closed
1232 \[\[(!?) # directive open; 2: optional prefix
1233 ([-\w]+) # 3: command
1235 ( # 4: the parameters..
1237 (?:[-\w]+=)? # named parameter key?
1239 """.*?""" # triple-quoted value
1241 "[^"]+" # single-quoted value
1243 [^\s\]]+ # unquoted value
1245 \s* # whitespace or end
1248 *) # 0 or more parameters
1249 \]\] # directive closed
1253 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1257 sub filter ($$$) { #{{{
1262 run_hooks(filter => sub {
1263 $content=shift->(page => $page, destpage => $destpage,
1264 content => $content);
1270 sub indexlink () { #{{{
1271 return "<a href=\"$config{url}\">$config{wikiname}</a>";
1276 sub lockwiki (;$) { #{{{
1277 my $wait=@_ ? shift : 1;
1278 # Take an exclusive lock on the wiki to prevent multiple concurrent
1279 # run issues. The lock will be dropped on program exit.
1280 if (! -d $config{wikistatedir}) {
1281 mkdir($config{wikistatedir});
1283 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1284 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1285 if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
1287 debug("wiki seems to be locked, waiting for lock");
1288 my $wait=600; # arbitrary, but don't hang forever to
1289 # prevent process pileup
1291 return if flock($wikilock, 2 | 4);
1294 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
1303 sub unlockwiki () { #{{{
1304 return close($wikilock) if $wikilock;
1310 sub commit_hook_enabled () { #{{{
1311 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1312 error("cannot write to $config{wikistatedir}/commitlock: $!");
1313 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1314 close($commitlock) || error("failed closing commitlock: $!");
1317 close($commitlock) || error("failed closing commitlock: $!");
1321 sub disable_commit_hook () { #{{{
1322 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1323 error("cannot write to $config{wikistatedir}/commitlock: $!");
1324 if (! flock($commitlock, 2)) { # LOCK_EX
1325 error("failed to get commit lock");
1330 sub enable_commit_hook () { #{{{
1331 return close($commitlock) if $commitlock;
1335 sub loadindex () { #{{{
1336 %oldrenderedfiles=%pagectime=();
1337 if (! $config{rebuild}) {
1338 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1339 %destsources=%renderedfiles=%pagecase=%pagestate=();
1342 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1343 if (-e "$config{wikistatedir}/index") {
1344 system("ikiwiki-transition", "indexdb", $config{srcdir});
1345 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1352 my $index=Storable::fd_retrieve($in);
1353 if (! defined $index) {
1358 if (exists $index->{version} && ! ref $index->{version}) {
1359 $pages=$index->{page};
1360 %wikistate=%{$index->{state}};
1367 foreach my $src (keys %$pages) {
1368 my $d=$pages->{$src};
1369 my $page=pagename($src);
1370 $pagectime{$page}=$d->{ctime};
1371 if (! $config{rebuild}) {
1372 $pagesources{$page}=$src;
1373 $pagemtime{$page}=$d->{mtime};
1374 $renderedfiles{$page}=$d->{dest};
1375 if (exists $d->{links} && ref $d->{links}) {
1376 $links{$page}=$d->{links};
1377 $oldlinks{$page}=[@{$d->{links}}];
1379 if (exists $d->{depends}) {
1380 $depends{$page}=$d->{depends};
1382 if (exists $d->{state}) {
1383 $pagestate{$page}=$d->{state};
1386 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1388 foreach my $page (keys %pagesources) {
1389 $pagecase{lc $page}=$page;
1391 foreach my $page (keys %renderedfiles) {
1392 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1397 sub saveindex () { #{{{
1398 run_hooks(savestate => sub { shift->() });
1401 foreach my $type (keys %hooks) {
1402 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1404 my @hookids=keys %hookids;
1406 if (! -d $config{wikistatedir}) {
1407 mkdir($config{wikistatedir});
1409 my $newfile="$config{wikistatedir}/indexdb.new";
1410 my $cleanup = sub { unlink($newfile) };
1411 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1414 foreach my $page (keys %pagemtime) {
1415 next unless $pagemtime{$page};
1416 my $src=$pagesources{$page};
1418 $index{page}{$src}={
1419 ctime => $pagectime{$page},
1420 mtime => $pagemtime{$page},
1421 dest => $renderedfiles{$page},
1422 links => $links{$page},
1425 if (exists $depends{$page}) {
1426 $index{page}{$src}{depends} = $depends{$page};
1429 if (exists $pagestate{$page}) {
1430 foreach my $id (@hookids) {
1431 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1432 $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1439 foreach my $id (@hookids) {
1440 foreach my $key (keys %{$wikistate{$id}}) {
1441 $index{state}{$id}{$key}=$wikistate{$id}{$key};
1445 $index{version}="3";
1446 my $ret=Storable::nstore_fd(\%index, $out);
1447 return if ! defined $ret || ! $ret;
1448 close $out || error("failed saving to $newfile: $!", $cleanup);
1449 rename($newfile, "$config{wikistatedir}/indexdb") ||
1450 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1455 sub template_file ($) { #{{{
1458 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1459 return "$dir/$template" if -e "$dir/$template";
1464 sub template_params (@) { #{{{
1465 my $filename=template_file(shift);
1467 if (! defined $filename) {
1468 return if wantarray;
1474 my $text_ref = shift;
1475 ${$text_ref} = decode_utf8(${$text_ref});
1477 filename => $filename,
1478 loop_context_vars => 1,
1479 die_on_bad_params => 0,
1482 return wantarray ? @ret : {@ret};
1485 sub template ($;@) { #{{{
1486 require HTML::Template;
1487 return HTML::Template->new(template_params(@_));
1490 sub misctemplate ($$;@) { #{{{
1494 my $template=template("misc.tmpl");
1497 indexlink => indexlink(),
1498 wikiname => $config{wikiname},
1499 pagebody => $pagebody,
1500 baseurl => baseurl(),
1503 run_hooks(pagetemplate => sub {
1504 shift->(page => "", destpage => "", template => $template);
1506 return $template->output;
1509 sub hook (@) { # {{{
1512 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1513 error 'hook requires type, call, and id parameters';
1516 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1518 $hooks{$param{type}}{$param{id}}=\%param;
1522 sub run_hooks ($$) { # {{{
1523 # Calls the given sub for each hook of the given type,
1524 # passing it the hook function to call.
1528 if (exists $hooks{$type}) {
1530 foreach my $id (keys %{$hooks{$type}}) {
1531 if ($hooks{$type}{$id}{last}) {
1532 push @deferred, $id;
1535 $sub->($hooks{$type}{$id}{call});
1537 foreach my $id (@deferred) {
1538 $sub->($hooks{$type}{$id}{call});
1545 sub rcs_update () { #{{{
1546 $hooks{rcs}{rcs_update}{call}->(@_);
1549 sub rcs_prepedit ($) { #{{{
1550 $hooks{rcs}{rcs_prepedit}{call}->(@_);
1553 sub rcs_commit ($$$;$$) { #{{{
1554 $hooks{rcs}{rcs_commit}{call}->(@_);
1557 sub rcs_commit_staged ($$$) { #{{{
1558 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1561 sub rcs_add ($) { #{{{
1562 $hooks{rcs}{rcs_add}{call}->(@_);
1565 sub rcs_remove ($) { #{{{
1566 $hooks{rcs}{rcs_remove}{call}->(@_);
1569 sub rcs_rename ($$) { #{{{
1570 $hooks{rcs}{rcs_rename}{call}->(@_);
1573 sub rcs_recentchanges ($) { #{{{
1574 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1577 sub rcs_diff ($) { #{{{
1578 $hooks{rcs}{rcs_diff}{call}->(@_);
1581 sub rcs_getctime ($) { #{{{
1582 $hooks{rcs}{rcs_getctime}{call}->(@_);
1585 sub globlist_to_pagespec ($) { #{{{
1586 my @globlist=split(' ', shift);
1589 foreach my $glob (@globlist) {
1590 if ($glob=~/^!(.*)/) {
1598 my $spec=join(' or ', @spec);
1600 my $skip=join(' and ', @skip);
1602 $spec="$skip and ($spec)";
1611 sub is_globlist ($) { #{{{
1613 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1616 sub safequote ($) { #{{{
1622 sub add_depends ($$) { #{{{
1626 return unless pagespec_valid($pagespec);
1628 if (! exists $depends{$page}) {
1629 $depends{$page}=$pagespec;
1632 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1638 sub file_pruned ($$) { #{{{
1640 my $file=File::Spec->canonpath(shift);
1641 my $base=File::Spec->canonpath(shift);
1642 $file =~ s#^\Q$base\E/+##;
1644 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1645 return $file =~ m/$regexp/ && $file ne $base;
1649 # Only use gettext in the rare cases it's needed.
1650 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1651 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1652 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1653 if (! $gettext_obj) {
1654 $gettext_obj=eval q{
1655 use Locale::gettext q{textdomain};
1656 Locale::gettext->domain('ikiwiki')
1664 return $gettext_obj->get(shift);
1671 sub yesno ($) { #{{{
1674 return (defined $val && lc($val) eq gettext("yes"));
1677 sub pagespec_merge ($$) { #{{{
1681 return $a if $a eq $b;
1683 # Support for old-style GlobLists.
1684 if (is_globlist($a)) {
1685 $a=globlist_to_pagespec($a);
1687 if (is_globlist($b)) {
1688 $b=globlist_to_pagespec($b);
1691 return "($a) or ($b)";
1694 sub pagespec_translate ($) { #{{{
1697 # Support for old-style GlobLists.
1698 if (is_globlist($spec)) {
1699 $spec=globlist_to_pagespec($spec);
1702 # Convert spec to perl code.
1705 \s* # ignore whitespace
1706 ( # 1: match a single word
1713 \w+\([^\)]*\) # command(params)
1715 [^\s()]+ # any other text
1717 \s* # ignore whitespace
1720 if (lc $word eq 'and') {
1723 elsif (lc $word eq 'or') {
1726 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1729 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1730 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1731 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1738 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1742 if (! length $code) {
1747 return eval 'sub { my $page=shift; '.$code.' }';
1750 sub pagespec_match ($$;@) { #{{{
1755 # Backwards compatability with old calling convention.
1757 unshift @params, 'location';
1760 my $sub=pagespec_translate($spec);
1761 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1762 return $sub->($page, @params);
1765 sub pagespec_valid ($) { #{{{
1768 my $sub=pagespec_translate($spec);
1772 sub glob2re ($) { #{{{
1773 my $re=quotemeta(shift);
1779 package IkiWiki::FailReason;
1782 '""' => sub { ${$_[0]} },
1784 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1791 return bless \$value, $class;
1794 package IkiWiki::SuccessReason;
1797 '""' => sub { ${$_[0]} },
1799 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1806 return bless \$value, $class;
1809 package IkiWiki::PageSpec;
1811 sub match_glob ($$;@) { #{{{
1816 my $from=exists $params{location} ? $params{location} : '';
1819 if ($glob =~ m!^\./!) {
1820 $from=~s#/?[^/]+$##;
1822 $glob="$from/$glob" if length $from;
1825 my $regexp=IkiWiki::glob2re($glob);
1826 if ($page=~/^$regexp$/i) {
1827 if (! IkiWiki::isinternal($page) || $params{internal}) {
1828 return IkiWiki::SuccessReason->new("$glob matches $page");
1831 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1835 return IkiWiki::FailReason->new("$glob does not match $page");
1839 sub match_internal ($$;@) { #{{{
1840 return match_glob($_[0], $_[1], @_, internal => 1)
1843 sub match_link ($$;@) { #{{{
1848 my $from=exists $params{location} ? $params{location} : '';
1851 if ($link =~ m!^\.! && defined $from) {
1852 $from=~s#/?[^/]+$##;
1854 $link="$from/$link" if length $from;
1857 my $links = $IkiWiki::links{$page};
1858 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1859 my $bestlink = IkiWiki::bestlink($from, $link);
1860 foreach my $p (@{$links}) {
1861 if (length $bestlink) {
1862 return IkiWiki::SuccessReason->new("$page links to $link")
1863 if $bestlink eq IkiWiki::bestlink($page, $p);
1866 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1867 if match_glob($p, $link, %params);
1870 return IkiWiki::FailReason->new("$page does not link to $link");
1873 sub match_backlink ($$;@) { #{{{
1874 return match_link($_[1], $_[0], @_);
1877 sub match_created_before ($$;@) { #{{{
1881 if (exists $IkiWiki::pagectime{$testpage}) {
1882 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1883 return IkiWiki::SuccessReason->new("$page created before $testpage");
1886 return IkiWiki::FailReason->new("$page not created before $testpage");
1890 return IkiWiki::FailReason->new("$testpage has no ctime");
1894 sub match_created_after ($$;@) { #{{{
1898 if (exists $IkiWiki::pagectime{$testpage}) {
1899 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1900 return IkiWiki::SuccessReason->new("$page created after $testpage");
1903 return IkiWiki::FailReason->new("$page not created after $testpage");
1907 return IkiWiki::FailReason->new("$testpage has no ctime");
1911 sub match_creation_day ($$;@) { #{{{
1912 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1913 return IkiWiki::SuccessReason->new('creation_day matched');
1916 return IkiWiki::FailReason->new('creation_day did not match');
1920 sub match_creation_month ($$;@) { #{{{
1921 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1922 return IkiWiki::SuccessReason->new('creation_month matched');
1925 return IkiWiki::FailReason->new('creation_month did not match');
1929 sub match_creation_year ($$;@) { #{{{
1930 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1931 return IkiWiki::SuccessReason->new('creation_year matched');
1934 return IkiWiki::FailReason->new('creation_year did not match');
1938 sub match_user ($$;@) { #{{{
1943 if (! exists $params{user}) {
1944 return IkiWiki::FailReason->new("no user specified");
1947 if (defined $params{user} && lc $params{user} eq lc $user) {
1948 return IkiWiki::SuccessReason->new("user is $user");
1950 elsif (! defined $params{user}) {
1951 return IkiWiki::FailReason->new("not logged in");
1954 return IkiWiki::FailReason->new("user is $params{user}, not $user");
1958 sub match_admin ($$;@) { #{{{
1963 if (! exists $params{user}) {
1964 return IkiWiki::FailReason->new("no user specified");
1967 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
1968 return IkiWiki::SuccessReason->new("user is an admin");
1970 elsif (! defined $params{user}) {
1971 return IkiWiki::FailReason->new("not logged in");
1974 return IkiWiki::FailReason->new("user is not an admin");
1978 sub match_ip ($$;@) { #{{{
1983 if (! exists $params{ip}) {
1984 return IkiWiki::FailReason->new("no IP specified");
1987 if (defined $params{ip} && lc $params{ip} eq lc $ip) {
1988 return IkiWiki::SuccessReason->new("IP is $ip");
1991 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");