8 use URI::Escape q{uri_escape_utf8};
11 use open qw{:utf8 :std};
13 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
14 %pagestate %renderedfiles %oldrenderedfiles %pagesources
15 %destsources %depends %hooks %forcerebuild $gettext_obj};
17 use Exporter q{import};
18 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
19 bestlink htmllink readfile writefile pagetype srcfile pagename
20 displaytime will_render gettext urlto targetpage
22 %config %links %pagestate %renderedfiles
23 %pagesources %destsources);
24 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
25 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
26 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
31 memoize("pagespec_translate");
32 memoize("file_pruned");
34 sub defaultconfig () { #{{{
36 wiki_file_prune_regexps => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
37 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
38 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
41 wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
42 web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
46 default_pageext => "mdwn",
67 gitorigin_branch => "origin",
68 gitmaster_branch => "master",
72 templatedir => "$installdir/share/ikiwiki/templates",
73 underlaydir => "$installdir/share/ikiwiki/basewiki",
78 plugin => [qw{mdwn link inline htmlscrubber passwordauth openid
79 signinedit lockedit conditional recentchanges}],
88 account_creation_password => "",
89 prefix_directives => 0,
91 cgi_disable_uploads => 1,
94 sub checkconfig () { #{{{
95 # locale stuff; avoid LC_ALL since it overrides everything
96 if (defined $ENV{LC_ALL}) {
97 $ENV{LANG} = $ENV{LC_ALL};
100 if (defined $config{locale}) {
101 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
102 $ENV{LANG}=$config{locale};
107 if (ref $config{ENV} eq 'HASH') {
108 foreach my $val (keys %{$config{ENV}}) {
109 $ENV{$val}=$config{ENV}{$val};
113 if ($config{w3mmode}) {
114 eval q{use Cwd q{abs_path}};
116 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
117 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
118 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
119 unless $config{cgiurl} =~ m!file:///!;
120 $config{url}="file://".$config{destdir};
123 if ($config{cgi} && ! length $config{url}) {
124 error(gettext("Must specify url to wiki with --url when using --cgi"));
127 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
128 unless exists $config{wikistatedir};
131 eval qq{use IkiWiki::Rcs::$config{rcs}};
133 error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
137 require IkiWiki::Rcs::Stub;
140 if (exists $config{umask}) {
141 umask(possibly_foolish_untaint($config{umask}));
144 run_hooks(checkconfig => sub { shift->() });
149 sub loadplugins () { #{{{
150 if (defined $config{libdir}) {
151 unshift @INC, possibly_foolish_untaint($config{libdir});
154 loadplugin($_) foreach @{$config{plugin}};
156 run_hooks(getopt => sub { shift->() });
157 if (grep /^-/, @ARGV) {
158 print STDERR "Unknown option: $_\n"
159 foreach grep /^-/, @ARGV;
166 sub loadplugin ($) { #{{{
169 return if grep { $_ eq $plugin} @{$config{disable_plugins}};
171 foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
172 "$installdir/lib/ikiwiki") {
173 if (defined $dir && -x "$dir/plugins/$plugin") {
174 require IkiWiki::Plugin::external;
175 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
180 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
183 error("Failed to load plugin $mod: $@");
188 sub error ($;$) { #{{{
192 print "Content-type: text/html\n\n";
193 print misctemplate(gettext("Error"),
194 "<p>".gettext("Error").": $message</p>");
196 log_message('err' => $message) if $config{syslog};
197 if (defined $cleaner) {
204 return unless $config{verbose};
205 return log_message(debug => @_);
209 sub log_message ($$) { #{{{
212 if ($config{syslog}) {
215 Sys::Syslog::setlogsock('unix');
216 Sys::Syslog::openlog('ikiwiki', '', 'user');
220 Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
223 elsif (! $config{cgi}) {
227 return print STDERR "@_\n";
231 sub possibly_foolish_untaint ($) { #{{{
233 my ($untainted)=$tainted=~/(.*)/s;
237 sub basename ($) { #{{{
244 sub dirname ($) { #{{{
251 sub pagetype ($) { #{{{
254 if ($page =~ /\.([^.]+)$/) {
255 return $1 if exists $hooks{htmlize}{$1};
260 sub isinternal ($) { #{{{
262 return exists $pagesources{$page} &&
263 $pagesources{$page} =~ /\._([^.]+)$/;
266 sub pagename ($) { #{{{
269 my $type=pagetype($file);
271 $page=~s/\Q.$type\E*$// if defined $type;
275 sub targetpage ($$) { #{{{
279 if (! $config{usedirs} || $page =~ /^index$/ ) {
280 return $page.".".$ext;
282 return $page."/index.".$ext;
286 sub htmlpage ($) { #{{{
289 return targetpage($page, $config{htmlext});
292 sub srcfile_stat { #{{{
296 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
297 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
298 return "$dir/$file", stat(_) if -e "$dir/$file";
300 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
304 sub srcfile ($;$) { #{{{
305 return (srcfile_stat(@_))[0];
308 sub add_underlay ($) { #{{{
312 unshift @{$config{underlaydirs}}, $dir;
315 unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
321 sub readfile ($;$$) { #{{{
327 error("cannot read a symlink ($file)");
331 open (my $in, "<", $file) || error("failed to read $file: $!");
332 binmode($in) if ($binary);
333 return \*$in if $wantfd;
335 close $in || error("failed to read $file: $!");
339 sub prep_writefile ($$) {
344 while (length $test) {
345 if (-l "$destdir/$test") {
346 error("cannot write to a symlink ($test)");
348 $test=dirname($test);
351 my $dir=dirname("$destdir/$file");
354 foreach my $s (split(m!/+!, $dir)) {
357 mkdir($d) || error("failed to create directory $d: $!");
365 sub writefile ($$$;$$) { #{{{
366 my $file=shift; # can include subdirs
367 my $destdir=shift; # directory to put file in
372 prep_writefile($file, $destdir);
374 my $newfile="$destdir/$file.ikiwiki-new";
376 error("cannot write to a symlink ($newfile)");
379 my $cleanup = sub { unlink($newfile) };
380 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
381 binmode($out) if ($binary);
383 $writer->(\*$out, $cleanup);
386 print $out $content or error("failed writing to $newfile: $!", $cleanup);
388 close $out || error("failed saving $newfile: $!", $cleanup);
389 rename($newfile, "$destdir/$file") ||
390 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
396 sub will_render ($$;$) { #{{{
401 # Important security check.
402 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
403 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
404 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
407 if (! $clear || $cleared{$page}) {
408 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
411 foreach my $old (@{$renderedfiles{$page}}) {
412 delete $destsources{$old};
414 $renderedfiles{$page}=[$dest];
417 $destsources{$dest}=$page;
422 sub bestlink ($$) { #{{{
427 if ($link=~s/^\/+//) {
435 $l.="/" if length $l;
438 if (exists $links{$l}) {
441 elsif (exists $pagecase{lc $l}) {
442 return $pagecase{lc $l};
444 } while $cwd=~s!/?[^/]+$!!;
446 if (length $config{userdir}) {
447 my $l = "$config{userdir}/".lc($link);
448 if (exists $links{$l}) {
451 elsif (exists $pagecase{lc $l}) {
452 return $pagecase{lc $l};
456 #print STDERR "warning: page $page, broken link: $link\n";
460 sub isinlinableimage ($) { #{{{
463 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
466 sub pagetitle ($;$) { #{{{
471 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
474 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
480 sub titlepage ($) { #{{{
482 $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
486 sub linkpage ($) { #{{{
488 $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
492 sub cgiurl (@) { #{{{
495 return $config{cgiurl}."?".
496 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
499 sub baseurl (;$) { #{{{
502 return "$config{url}/" if ! defined $page;
504 $page=htmlpage($page);
506 $page=~s/[^\/]+\//..\//g;
510 sub abs2rel ($$) { #{{{
511 # Work around very innefficient behavior in File::Spec if abs2rel
512 # is passed two relative paths. It's much faster if paths are
513 # absolute! (Debian bug #376658; fixed in debian unstable now)
518 my $ret=File::Spec->abs2rel($path, $base);
519 $ret=~s/^// if defined $ret;
523 sub displaytime ($;$) { #{{{
526 if (! defined $format) {
527 $format=$config{timeformat};
530 # strftime doesn't know about encodings, so make sure
531 # its output is properly treated as utf8
532 return decode_utf8(POSIX::strftime($format, localtime($time)));
535 sub beautify_url ($) { #{{{
538 if ($config{usedirs}) {
539 $url =~ s!/index.$config{htmlext}$!/!;
541 $url =~ s!^$!./!; # Browsers don't like empty links...
546 sub urlto ($$) { #{{{
551 return beautify_url(baseurl($from)."index.$config{htmlext}");
554 if (! $destsources{$to}) {
558 my $link = abs2rel($to, dirname(htmlpage($from)));
560 return beautify_url($link);
563 sub htmllink ($$$;@) { #{{{
564 my $lpage=shift; # the page doing the linking
565 my $page=shift; # the page that will contain the link (different for inline)
572 if (! $opts{forcesubpage}) {
573 $bestlink=bestlink($lpage, $link);
576 $bestlink="$lpage/".lc($link);
580 if (defined $opts{linktext}) {
581 $linktext=$opts{linktext};
584 $linktext=pagetitle(basename($link));
587 return "<span class=\"selflink\">$linktext</span>"
588 if length $bestlink && $page eq $bestlink &&
589 ! defined $opts{anchor};
591 if (! $destsources{$bestlink}) {
592 $bestlink=htmlpage($bestlink);
594 if (! $destsources{$bestlink}) {
595 return $linktext unless length $config{cgiurl};
596 return "<span class=\"createlink\"><a href=\"".
599 page => pagetitle(lc($link), 1),
602 "\" rel=\"nofollow\">?</a>$linktext</span>"
606 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
607 $bestlink=beautify_url($bestlink);
609 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
610 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
613 if (defined $opts{anchor}) {
614 $bestlink.="#".$opts{anchor};
618 if (defined $opts{rel}) {
619 push @attrs, ' rel="'.$opts{rel}.'"';
621 if (defined $opts{class}) {
622 push @attrs, ' class="'.$opts{class}.'"';
625 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
628 sub userlink ($) { #{{{
631 my $oiduser=eval { openiduser($user) };
632 if (defined $oiduser) {
633 return "<a href=\"$user\">$oiduser</a>";
636 eval q{use CGI 'escapeHTML'};
639 return htmllink("", "", escapeHTML(
640 length $config{userdir} ? $config{userdir}."/".$user : $user
641 ), noimageinline => 1);
645 sub htmlize ($$$$) { #{{{
651 my $oneline = $content !~ /\n/;
653 if (exists $hooks{htmlize}{$type}) {
654 $content=$hooks{htmlize}{$type}{call}->(
660 error("htmlization of $type not supported");
663 run_hooks(sanitize => sub {
666 destpage => $destpage,
672 # hack to get rid of enclosing junk added by markdown
673 # and other htmlizers
675 $content=~s/<\/p>$//i;
682 sub linkify ($$$) { #{{{
687 run_hooks(linkify => sub {
690 destpage => $destpage,
699 our $preprocess_preview=0;
700 sub preprocess ($$$;$$) { #{{{
701 my $page=shift; # the page the data comes from
702 my $destpage=shift; # the page the data will appear in (different for inline)
707 # Using local because it needs to be set within any nested calls
709 local $preprocess_preview=$preview if defined $preview;
716 if (length $escape) {
717 return "[[$prefix$command $params]]";
719 elsif (exists $hooks{preprocess}{$command}) {
720 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
721 # Note: preserve order of params, some plugins may
722 # consider it significant.
725 (?:([-\w]+)=)? # 1: named parameter key?
727 """(.*?)""" # 2: triple-quoted value
729 "([^"]+)" # 3: single-quoted value
731 (\S+) # 4: unquoted value
733 (?:\s+|$) # delimiter to next param
751 push @params, $key, $val;
754 push @params, $val, '';
757 if ($preprocessing{$page}++ > 3) {
758 # Avoid loops of preprocessed pages preprocessing
759 # other pages that preprocess them, etc.
760 #translators: The first parameter is a
761 #translators: preprocessor directive name,
762 #translators: the second a page name, the
763 #translators: third a number.
764 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
765 $command, $page, $preprocessing{$page}).
770 $ret=$hooks{preprocess}{$command}{call}->(
773 destpage => $destpage,
774 preview => $preprocess_preview,
778 # use void context during scan pass
779 $hooks{preprocess}{$command}{call}->(
782 destpage => $destpage,
783 preview => $preprocess_preview,
787 $preprocessing{$page}--;
791 return "[[$prefix$command $params]]";
796 if ($config{prefix_directives}) {
799 \[\[(!) # directive open; 2: prefix
800 ([-\w]+) # 3: command
801 ( # 4: the parameters..
802 \s+ # Must have space if parameters present
804 (?:[-\w]+=)? # named parameter key?
806 """.*?""" # triple-quoted value
808 "[^"]+" # single-quoted value
810 [^\s\]]+ # unquoted value
812 \s* # whitespace or end
815 *)? # 0 or more parameters
816 \]\] # directive closed
821 \[\[(!?) # directive open; 2: optional prefix
822 ([-\w]+) # 3: command
824 ( # 4: the parameters..
826 (?:[-\w]+=)? # named parameter key?
828 """.*?""" # triple-quoted value
830 "[^"]+" # single-quoted value
832 [^\s\]]+ # unquoted value
834 \s* # whitespace or end
837 *) # 0 or more parameters
838 \]\] # directive closed
842 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
846 sub filter ($$$) { #{{{
851 run_hooks(filter => sub {
852 $content=shift->(page => $page, destpage => $destpage,
853 content => $content);
859 sub indexlink () { #{{{
860 return "<a href=\"$config{url}\">$config{wikiname}</a>";
865 sub lockwiki (;$) { #{{{
866 my $wait=@_ ? shift : 1;
867 # Take an exclusive lock on the wiki to prevent multiple concurrent
868 # run issues. The lock will be dropped on program exit.
869 if (! -d $config{wikistatedir}) {
870 mkdir($config{wikistatedir});
872 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
873 error ("cannot write to $config{wikistatedir}/lockfile: $!");
874 if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
876 debug("wiki seems to be locked, waiting for lock");
877 my $wait=600; # arbitrary, but don't hang forever to
878 # prevent process pileup
880 return if flock($wikilock, 2 | 4);
883 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
892 sub unlockwiki () { #{{{
893 return close($wikilock) if $wikilock;
899 sub commit_hook_enabled () { #{{{
900 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
901 error("cannot write to $config{wikistatedir}/commitlock: $!");
902 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
903 close($commitlock) || error("failed closing commitlock: $!");
906 close($commitlock) || error("failed closing commitlock: $!");
910 sub disable_commit_hook () { #{{{
911 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
912 error("cannot write to $config{wikistatedir}/commitlock: $!");
913 if (! flock($commitlock, 2)) { # LOCK_EX
914 error("failed to get commit lock");
919 sub enable_commit_hook () { #{{{
920 return close($commitlock) if $commitlock;
924 sub loadindex () { #{{{
925 %oldrenderedfiles=%pagectime=();
926 if (! $config{rebuild}) {
927 %pagesources=%pagemtime=%oldlinks=%links=%depends=
928 %destsources=%renderedfiles=%pagecase=%pagestate=();
931 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
932 if (-e "$config{wikistatedir}/index") {
933 system("ikiwiki-transition", "indexdb", $config{srcdir});
934 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
940 my $ret=Storable::fd_retrieve($in);
941 if (! defined $ret) {
945 foreach my $src (keys %index) {
946 my %d=%{$index{$src}};
947 my $page=pagename($src);
948 $pagectime{$page}=$d{ctime};
949 if (! $config{rebuild}) {
950 $pagesources{$page}=$src;
951 $pagemtime{$page}=$d{mtime};
952 $renderedfiles{$page}=$d{dest};
953 if (exists $d{links} && ref $d{links}) {
954 $links{$page}=$d{links};
955 $oldlinks{$page}=[@{$d{links}}];
957 if (exists $d{depends}) {
958 $depends{$page}=$d{depends};
960 if (exists $d{state}) {
961 $pagestate{$page}=$d{state};
964 $oldrenderedfiles{$page}=[@{$d{dest}}];
966 foreach my $page (keys %pagesources) {
967 $pagecase{lc $page}=$page;
969 foreach my $page (keys %renderedfiles) {
970 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
975 sub saveindex () { #{{{
976 run_hooks(savestate => sub { shift->() });
979 foreach my $type (keys %hooks) {
980 $hookids{$_}=1 foreach keys %{$hooks{$type}};
982 my @hookids=keys %hookids;
984 if (! -d $config{wikistatedir}) {
985 mkdir($config{wikistatedir});
987 my $newfile="$config{wikistatedir}/indexdb.new";
988 my $cleanup = sub { unlink($newfile) };
989 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
991 foreach my $page (keys %pagemtime) {
992 next unless $pagemtime{$page};
993 my $src=$pagesources{$page};
996 ctime => $pagectime{$page},
997 mtime => $pagemtime{$page},
998 dest => $renderedfiles{$page},
999 links => $links{$page},
1002 if (exists $depends{$page}) {
1003 $index{$src}{depends} = $depends{$page};
1006 if (exists $pagestate{$page}) {
1007 foreach my $id (@hookids) {
1008 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1009 $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1014 my $ret=Storable::nstore_fd(\%index, $out);
1015 return if ! defined $ret || ! $ret;
1016 close $out || error("failed saving to $newfile: $!", $cleanup);
1017 rename($newfile, "$config{wikistatedir}/indexdb") ||
1018 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1023 sub template_file ($) { #{{{
1026 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1027 return "$dir/$template" if -e "$dir/$template";
1032 sub template_params (@) { #{{{
1033 my $filename=template_file(shift);
1035 if (! defined $filename) {
1036 return if wantarray;
1042 my $text_ref = shift;
1043 ${$text_ref} = decode_utf8(${$text_ref});
1045 filename => $filename,
1046 loop_context_vars => 1,
1047 die_on_bad_params => 0,
1050 return wantarray ? @ret : {@ret};
1053 sub template ($;@) { #{{{
1054 require HTML::Template;
1055 return HTML::Template->new(template_params(@_));
1058 sub misctemplate ($$;@) { #{{{
1062 my $template=template("misc.tmpl");
1065 indexlink => indexlink(),
1066 wikiname => $config{wikiname},
1067 pagebody => $pagebody,
1068 baseurl => baseurl(),
1071 run_hooks(pagetemplate => sub {
1072 shift->(page => "", destpage => "", template => $template);
1074 return $template->output;
1077 sub hook (@) { # {{{
1080 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1081 error 'hook requires type, call, and id parameters';
1084 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1086 $hooks{$param{type}}{$param{id}}=\%param;
1090 sub run_hooks ($$) { # {{{
1091 # Calls the given sub for each hook of the given type,
1092 # passing it the hook function to call.
1096 if (exists $hooks{$type}) {
1098 foreach my $id (keys %{$hooks{$type}}) {
1099 if ($hooks{$type}{$id}{last}) {
1100 push @deferred, $id;
1103 $sub->($hooks{$type}{$id}{call});
1105 foreach my $id (@deferred) {
1106 $sub->($hooks{$type}{$id}{call});
1113 sub globlist_to_pagespec ($) { #{{{
1114 my @globlist=split(' ', shift);
1117 foreach my $glob (@globlist) {
1118 if ($glob=~/^!(.*)/) {
1126 my $spec=join(' or ', @spec);
1128 my $skip=join(' and ', @skip);
1130 $spec="$skip and ($spec)";
1139 sub is_globlist ($) { #{{{
1141 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1144 sub safequote ($) { #{{{
1150 sub add_depends ($$) { #{{{
1154 return unless pagespec_valid($pagespec);
1156 if (! exists $depends{$page}) {
1157 $depends{$page}=$pagespec;
1160 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1166 sub file_pruned ($$) { #{{{
1168 my $file=File::Spec->canonpath(shift);
1169 my $base=File::Spec->canonpath(shift);
1170 $file =~ s#^\Q$base\E/+##;
1172 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1173 return $file =~ m/$regexp/ && $file ne $base;
1177 # Only use gettext in the rare cases it's needed.
1178 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1179 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1180 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1181 if (! $gettext_obj) {
1182 $gettext_obj=eval q{
1183 use Locale::gettext q{textdomain};
1184 Locale::gettext->domain('ikiwiki')
1192 return $gettext_obj->get(shift);
1199 sub pagespec_merge ($$) { #{{{
1203 return $a if $a eq $b;
1205 # Support for old-style GlobLists.
1206 if (is_globlist($a)) {
1207 $a=globlist_to_pagespec($a);
1209 if (is_globlist($b)) {
1210 $b=globlist_to_pagespec($b);
1213 return "($a) or ($b)";
1216 sub pagespec_translate ($) { #{{{
1219 # Support for old-style GlobLists.
1220 if (is_globlist($spec)) {
1221 $spec=globlist_to_pagespec($spec);
1224 # Convert spec to perl code.
1227 \s* # ignore whitespace
1228 ( # 1: match a single word
1235 \w+\([^\)]*\) # command(params)
1237 [^\s()]+ # any other text
1239 \s* # ignore whitespace
1242 if (lc $word eq 'and') {
1245 elsif (lc $word eq 'or') {
1248 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1251 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1252 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1253 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1260 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1264 if (! length $code) {
1269 return eval 'sub { my $page=shift; '.$code.' }';
1272 sub pagespec_match ($$;@) { #{{{
1277 # Backwards compatability with old calling convention.
1279 unshift @params, 'location';
1282 my $sub=pagespec_translate($spec);
1283 return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1284 return $sub->($page, @params);
1287 sub pagespec_valid ($) { #{{{
1290 my $sub=pagespec_translate($spec);
1294 package IkiWiki::FailReason;
1297 '""' => sub { ${$_[0]} },
1299 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1306 return bless \$value, $class;
1309 package IkiWiki::SuccessReason;
1312 '""' => sub { ${$_[0]} },
1314 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1321 return bless \$value, $class;
1324 package IkiWiki::PageSpec;
1326 sub match_glob ($$;@) { #{{{
1331 my $from=exists $params{location} ? $params{location} : '';
1334 if ($glob =~ m!^\./!) {
1335 $from=~s#/?[^/]+$##;
1337 $glob="$from/$glob" if length $from;
1340 # turn glob into safe regexp
1341 $glob=quotemeta($glob);
1345 if ($page=~/^$glob$/i) {
1346 if (! IkiWiki::isinternal($page) || $params{internal}) {
1347 return IkiWiki::SuccessReason->new("$glob matches $page");
1350 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1354 return IkiWiki::FailReason->new("$glob does not match $page");
1358 sub match_internal ($$;@) { #{{{
1359 return match_glob($_[0], $_[1], @_, internal => 1)
1362 sub match_link ($$;@) { #{{{
1367 my $from=exists $params{location} ? $params{location} : '';
1370 if ($link =~ m!^\.! && defined $from) {
1371 $from=~s#/?[^/]+$##;
1373 $link="$from/$link" if length $from;
1376 my $links = $IkiWiki::links{$page};
1377 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1378 my $bestlink = IkiWiki::bestlink($from, $link);
1379 foreach my $p (@{$links}) {
1380 if (length $bestlink) {
1381 return IkiWiki::SuccessReason->new("$page links to $link")
1382 if $bestlink eq IkiWiki::bestlink($page, $p);
1385 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1386 if match_glob($p, $link, %params);
1389 return IkiWiki::FailReason->new("$page does not link to $link");
1392 sub match_backlink ($$;@) { #{{{
1393 return match_link($_[1], $_[0], @_);
1396 sub match_created_before ($$;@) { #{{{
1400 if (exists $IkiWiki::pagectime{$testpage}) {
1401 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1402 return IkiWiki::SuccessReason->new("$page created before $testpage");
1405 return IkiWiki::FailReason->new("$page not created before $testpage");
1409 return IkiWiki::FailReason->new("$testpage has no ctime");
1413 sub match_created_after ($$;@) { #{{{
1417 if (exists $IkiWiki::pagectime{$testpage}) {
1418 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1419 return IkiWiki::SuccessReason->new("$page created after $testpage");
1422 return IkiWiki::FailReason->new("$page not created after $testpage");
1426 return IkiWiki::FailReason->new("$testpage has no ctime");
1430 sub match_creation_day ($$;@) { #{{{
1431 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1432 return IkiWiki::SuccessReason->new('creation_day matched');
1435 return IkiWiki::FailReason->new('creation_day did not match');
1439 sub match_creation_month ($$;@) { #{{{
1440 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1441 return IkiWiki::SuccessReason->new('creation_month matched');
1444 return IkiWiki::FailReason->new('creation_month did not match');
1448 sub match_creation_year ($$;@) { #{{{
1449 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1450 return IkiWiki::SuccessReason->new('creation_year matched');
1453 return IkiWiki::FailReason->new('creation_year did not match');