8 use URI::Escape q{uri_escape_utf8};
10 use open qw{:utf8 :std};
12 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
13 %renderedfiles %oldrenderedfiles %pagesources %destsources
14 %depends %hooks %forcerebuild $gettext_obj};
16 use Exporter q{import};
17 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
18 bestlink htmllink readfile writefile pagetype srcfile pagename
19 displaytime will_render gettext urlto targetpage
21 %config %links %renderedfiles %pagesources %destsources);
22 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
23 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
24 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
29 memoize("pagespec_translate");
30 memoize("file_pruned");
32 sub defaultconfig () { #{{{
34 wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
35 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
36 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
39 wiki_link_regexp => qr{
40 \[\[ # beginning of link
42 ([^\]\|\n\s]+) # 1: link text
46 ([^\s\]#]+) # 2: page to link to
48 \# # '#', beginning of anchor
49 ([^\s\]]+) # 3: anchor text
54 wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
55 web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
59 default_pageext => "mdwn",
80 gitorigin_branch => "origin",
81 gitmaster_branch => "master",
85 templatedir => "$installdir/share/ikiwiki/templates",
86 underlaydir => "$installdir/share/ikiwiki/basewiki",
91 plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit
92 lockedit conditional}],
101 account_creation_password => "",
104 sub checkconfig () { #{{{
105 # locale stuff; avoid LC_ALL since it overrides everything
106 if (defined $ENV{LC_ALL}) {
107 $ENV{LANG} = $ENV{LC_ALL};
110 if (defined $config{locale}) {
111 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
112 $ENV{LANG}=$config{locale};
117 if ($config{w3mmode}) {
118 eval q{use Cwd q{abs_path}};
120 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
121 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
122 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
123 unless $config{cgiurl} =~ m!file:///!;
124 $config{url}="file://".$config{destdir};
127 if ($config{cgi} && ! length $config{url}) {
128 error(gettext("Must specify url to wiki with --url when using --cgi"));
131 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
132 unless exists $config{wikistatedir};
135 eval qq{use IkiWiki::Rcs::$config{rcs}};
137 error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
141 require IkiWiki::Rcs::Stub;
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 pagename ($) { #{{{
263 my $type=pagetype($file);
265 $page=~s/\Q.$type\E*$// if defined $type;
269 sub targetpage ($$) { #{{{
273 if (! $config{usedirs} || $page =~ /^index$/ ) {
274 return $page.".".$ext;
276 return $page."/index.".$ext;
280 sub htmlpage ($) { #{{{
283 return targetpage($page, $config{htmlext});
286 sub srcfile ($) { #{{{
289 return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
290 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
291 return "$dir/$file" if -e "$dir/$file";
293 error("internal error: $file cannot be found in $config{srcdir} or underlay");
297 sub add_underlay ($) { #{{{
301 unshift @{$config{underlaydirs}}, $dir;
304 unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
310 sub readfile ($;$$) { #{{{
316 error("cannot read a symlink ($file)");
320 open (my $in, "<", $file) || error("failed to read $file: $!");
321 binmode($in) if ($binary);
322 return \*$in if $wantfd;
324 close $in || error("failed to read $file: $!");
328 sub writefile ($$$;$$) { #{{{
329 my $file=shift; # can include subdirs
330 my $destdir=shift; # directory to put file in
336 while (length $test) {
337 if (-l "$destdir/$test") {
338 error("cannot write to a symlink ($test)");
340 $test=dirname($test);
342 my $newfile="$destdir/$file.ikiwiki-new";
344 error("cannot write to a symlink ($newfile)");
347 my $dir=dirname($newfile);
350 foreach my $s (split(m!/+!, $dir)) {
353 mkdir($d) || error("failed to create directory $d: $!");
358 my $cleanup = sub { unlink($newfile) };
359 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
360 binmode($out) if ($binary);
362 $writer->(\*$out, $cleanup);
365 print $out $content or error("failed writing to $newfile: $!", $cleanup);
367 close $out || error("failed saving $newfile: $!", $cleanup);
368 rename($newfile, "$destdir/$file") ||
369 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
375 sub will_render ($$;$) { #{{{
380 # Important security check.
381 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
382 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
383 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
386 if (! $clear || $cleared{$page}) {
387 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
390 foreach my $old (@{$renderedfiles{$page}}) {
391 delete $destsources{$old};
393 $renderedfiles{$page}=[$dest];
396 $destsources{$dest}=$page;
401 sub bestlink ($$) { #{{{
406 if ($link=~s/^\/+//) {
414 $l.="/" if length $l;
417 if (exists $links{$l}) {
420 elsif (exists $pagecase{lc $l}) {
421 return $pagecase{lc $l};
423 } while $cwd=~s!/?[^/]+$!!;
425 if (length $config{userdir}) {
426 my $l = "$config{userdir}/".lc($link);
427 if (exists $links{$l}) {
430 elsif (exists $pagecase{lc $l}) {
431 return $pagecase{lc $l};
435 #print STDERR "warning: page $page, broken link: $link\n";
439 sub isinlinableimage ($) { #{{{
442 return $file =~ /\.(png|gif|jpg|jpeg)$/i;
445 sub pagetitle ($;$) { #{{{
450 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
453 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
459 sub titlepage ($) { #{{{
461 $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
465 sub linkpage ($) { #{{{
467 $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
471 sub cgiurl (@) { #{{{
474 return $config{cgiurl}."?".
475 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
478 sub baseurl (;$) { #{{{
481 return "$config{url}/" if ! defined $page;
483 $page=htmlpage($page);
485 $page=~s/[^\/]+\//..\//g;
489 sub abs2rel ($$) { #{{{
490 # Work around very innefficient behavior in File::Spec if abs2rel
491 # is passed two relative paths. It's much faster if paths are
492 # absolute! (Debian bug #376658; fixed in debian unstable now)
497 my $ret=File::Spec->abs2rel($path, $base);
498 $ret=~s/^// if defined $ret;
502 sub displaytime ($;$) { #{{{
505 if (! defined $format) {
506 $format=$config{timeformat};
509 # strftime doesn't know about encodings, so make sure
510 # its output is properly treated as utf8
511 return decode_utf8(POSIX::strftime($format, localtime($time)));
514 sub beautify_url ($) { #{{{
517 $url =~ s!/index.$config{htmlext}$!/!;
518 $url =~ s!^$!./!; # Browsers don't like empty links...
523 sub urlto ($$) { #{{{
528 return beautify_url(baseurl($from));
531 if (! $destsources{$to}) {
535 my $link = abs2rel($to, dirname(htmlpage($from)));
537 return beautify_url($link);
540 sub htmllink ($$$;@) { #{{{
541 my $lpage=shift; # the page doing the linking
542 my $page=shift; # the page that will contain the link (different for inline)
549 if (! $opts{forcesubpage}) {
550 $bestlink=bestlink($lpage, $link);
553 $bestlink="$lpage/".lc($link);
557 if (defined $opts{linktext}) {
558 $linktext=$opts{linktext};
561 $linktext=pagetitle(basename($link));
564 return "<span class=\"selflink\">$linktext</span>"
565 if length $bestlink && $page eq $bestlink;
567 if (! $destsources{$bestlink}) {
568 $bestlink=htmlpage($bestlink);
570 if (! $destsources{$bestlink}) {
571 return $linktext unless length $config{cgiurl};
572 return "<span class=\"createlink\"><a href=\"".
575 page => pagetitle(lc($link), 1),
578 "\">?</a>$linktext</span>"
582 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
583 $bestlink=beautify_url($bestlink);
585 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
586 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
589 if (defined $opts{anchor}) {
590 $bestlink.="#".$opts{anchor};
594 if (defined $opts{rel}) {
595 push @attrs, ' rel="'.$opts{rel}.'"';
597 if (defined $opts{class}) {
598 push @attrs, ' class="'.$opts{class}.'"';
601 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
604 sub htmlize ($$$) { #{{{
609 if (exists $hooks{htmlize}{$type}) {
610 $content=$hooks{htmlize}{$type}{call}->(
616 error("htmlization of $type not supported");
619 run_hooks(sanitize => sub {
629 sub linkify ($$$) { #{{{
630 my $lpage=shift; # the page containing the links
631 my $page=shift; # the page the link will end up on (different for inline)
634 $content =~ s{(\\?)$config{wiki_link_regexp}}{
637 ? "[[$2|$3".($4 ? "#$4" : "")."]]"
638 : htmllink($lpage, $page, linkpage($3),
639 anchor => $4, linktext => pagetitle($2)))
641 ? "[[$3".($4 ? "#$4" : "")."]]"
642 : htmllink($lpage, $page, linkpage($3),
650 our $preprocess_preview=0;
651 sub preprocess ($$$;$$) { #{{{
652 my $page=shift; # the page the data comes from
653 my $destpage=shift; # the page the data will appear in (different for inline)
658 # Using local because it needs to be set within any nested calls
660 local $preprocess_preview=$preview if defined $preview;
666 if (length $escape) {
667 return "[[$command $params]]";
669 elsif (exists $hooks{preprocess}{$command}) {
670 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
671 # Note: preserve order of params, some plugins may
672 # consider it significant.
675 (?:(\w+)=)? # 1: named parameter key?
677 """(.*?)""" # 2: triple-quoted value
679 "([^"]+)" # 3: single-quoted value
681 (\S+) # 4: unquoted value
683 (?:\s+|$) # delimiter to next param
701 push @params, $key, $val;
704 push @params, $val, '';
707 if ($preprocessing{$page}++ > 3) {
708 # Avoid loops of preprocessed pages preprocessing
709 # other pages that preprocess them, etc.
710 #translators: The first parameter is a
711 #translators: preprocessor directive name,
712 #translators: the second a page name, the
713 #translators: third a number.
714 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
715 $command, $page, $preprocessing{$page}).
718 my $ret=$hooks{preprocess}{$command}{call}->(
721 destpage => $destpage,
722 preview => $preprocess_preview,
724 $preprocessing{$page}--;
728 return "[[$command $params]]";
734 \[\[ # directive open
737 ( # 3: the parameters..
739 (?:\w+=)? # named parameter key?
741 """.*?""" # triple-quoted value
743 "[^"]+" # single-quoted value
745 [^\s\]]+ # unquoted value
747 \s* # whitespace or end
750 *) # 0 or more parameters
751 \]\] # directive closed
752 }{$handle->($1, $2, $3)}sexg;
756 sub filter ($$$) { #{{{
761 run_hooks(filter => sub {
762 $content=shift->(page => $page, destpage => $destpage,
763 content => $content);
769 sub indexlink () { #{{{
770 return "<a href=\"$config{url}\">$config{wikiname}</a>";
775 sub lockwiki (;$) { #{{{
776 my $wait=@_ ? shift : 1;
777 # Take an exclusive lock on the wiki to prevent multiple concurrent
778 # run issues. The lock will be dropped on program exit.
779 if (! -d $config{wikistatedir}) {
780 mkdir($config{wikistatedir});
782 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
783 error ("cannot write to $config{wikistatedir}/lockfile: $!");
784 if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
786 debug("wiki seems to be locked, waiting for lock");
787 my $wait=600; # arbitrary, but don't hang forever to
788 # prevent process pileup
790 return if flock($wikilock, 2 | 4);
793 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
802 sub unlockwiki () { #{{{
803 return close($wikilock) if $wikilock;
809 sub commit_hook_enabled () { #{{{
810 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
811 error("cannot write to $config{wikistatedir}/commitlock: $!");
812 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
813 close($commitlock) || error("failed closing commitlock: $!");
816 close($commitlock) || error("failed closing commitlock: $!");
820 sub disable_commit_hook () { #{{{
821 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
822 error("cannot write to $config{wikistatedir}/commitlock: $!");
823 if (! flock($commitlock, 2)) { # LOCK_EX
824 error("failed to get commit lock");
829 sub enable_commit_hook () { #{{{
830 return close($commitlock) if $commitlock;
834 sub loadindex () { #{{{
835 %oldrenderedfiles=%pagectime=();
836 if (! $config{rebuild}) {
837 %pagesources=%pagemtime=%oldlinks=%links=%depends=
838 %destsources=%renderedfiles=%pagecase=();
840 open (my $in, "<", "$config{wikistatedir}/index") || return;
842 $_=possibly_foolish_untaint($_);
847 foreach my $i (split(/ /, $_)) {
848 my ($item, $val)=split(/=/, $i, 2);
849 push @{$items{$item}}, decode_entities($val);
852 next unless exists $items{src}; # skip bad lines for now
854 my $page=pagename($items{src}[0]);
855 if (! $config{rebuild}) {
856 $pagesources{$page}=$items{src}[0];
857 $pagemtime{$page}=$items{mtime}[0];
858 $oldlinks{$page}=[@{$items{link}}];
859 $links{$page}=[@{$items{link}}];
860 $depends{$page}=$items{depends}[0] if exists $items{depends};
861 $destsources{$_}=$page foreach @{$items{dest}};
862 $renderedfiles{$page}=[@{$items{dest}}];
863 $pagecase{lc $page}=$page;
865 $oldrenderedfiles{$page}=[@{$items{dest}}];
866 $pagectime{$page}=$items{ctime}[0];
871 sub saveindex () { #{{{
872 run_hooks(savestate => sub { shift->() });
874 if (! -d $config{wikistatedir}) {
875 mkdir($config{wikistatedir});
877 my $newfile="$config{wikistatedir}/index.new";
878 my $cleanup = sub { unlink($newfile) };
879 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
880 foreach my $page (keys %pagemtime) {
881 next unless $pagemtime{$page};
882 my $line="mtime=$pagemtime{$page} ".
883 "ctime=$pagectime{$page} ".
884 "src=$pagesources{$page}";
885 $line.=" dest=$_" foreach @{$renderedfiles{$page}};
887 $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
888 if (exists $depends{$page}) {
889 $line.=" depends=".encode_entities($depends{$page}, " \t\n");
891 print $out $line."\n" || error("failed writing to $newfile: $!", $cleanup);
893 close $out || error("failed saving to $newfile: $!", $cleanup);
894 rename($newfile, "$config{wikistatedir}/index") ||
895 error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
900 sub template_file ($) { #{{{
903 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
904 return "$dir/$template" if -e "$dir/$template";
909 sub template_params (@) { #{{{
910 my $filename=template_file(shift);
912 if (! defined $filename) {
919 my $text_ref = shift;
920 ${$text_ref} = decode_utf8(${$text_ref});
922 filename => $filename,
923 loop_context_vars => 1,
924 die_on_bad_params => 0,
927 return wantarray ? @ret : {@ret};
930 sub template ($;@) { #{{{
931 require HTML::Template;
932 return HTML::Template->new(template_params(@_));
935 sub misctemplate ($$;@) { #{{{
939 my $template=template("misc.tmpl");
942 indexlink => indexlink(),
943 wikiname => $config{wikiname},
944 pagebody => $pagebody,
945 baseurl => baseurl(),
948 run_hooks(pagetemplate => sub {
949 shift->(page => "", destpage => "", template => $template);
951 return $template->output;
957 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
958 error 'hook requires type, call, and id parameters';
961 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
963 $hooks{$param{type}}{$param{id}}=\%param;
967 sub run_hooks ($$) { # {{{
968 # Calls the given sub for each hook of the given type,
969 # passing it the hook function to call.
973 if (exists $hooks{$type}) {
975 foreach my $id (keys %{$hooks{$type}}) {
976 if ($hooks{$type}{$id}{last}) {
980 $sub->($hooks{$type}{$id}{call});
982 foreach my $id (@deferred) {
983 $sub->($hooks{$type}{$id}{call});
990 sub globlist_to_pagespec ($) { #{{{
991 my @globlist=split(' ', shift);
994 foreach my $glob (@globlist) {
995 if ($glob=~/^!(.*)/) {
1003 my $spec=join(' or ', @spec);
1005 my $skip=join(' and ', @skip);
1007 $spec="$skip and ($spec)";
1016 sub is_globlist ($) { #{{{
1018 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1021 sub safequote ($) { #{{{
1027 sub add_depends ($$) { #{{{
1031 if (! exists $depends{$page}) {
1032 $depends{$page}=$pagespec;
1035 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1041 sub file_pruned ($$) { #{{{
1043 my $file=File::Spec->canonpath(shift);
1044 my $base=File::Spec->canonpath(shift);
1045 $file =~ s#^\Q$base\E/*##;
1047 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1048 return $file =~ m/$regexp/;
1052 # Only use gettext in the rare cases it's needed.
1053 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1054 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1055 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1056 if (! $gettext_obj) {
1057 $gettext_obj=eval q{
1058 use Locale::gettext q{textdomain};
1059 Locale::gettext->domain('ikiwiki')
1067 return $gettext_obj->get(shift);
1074 sub pagespec_merge ($$) { #{{{
1078 return $a if $a eq $b;
1080 # Support for old-style GlobLists.
1081 if (is_globlist($a)) {
1082 $a=globlist_to_pagespec($a);
1084 if (is_globlist($b)) {
1085 $b=globlist_to_pagespec($b);
1088 return "($a) or ($b)";
1091 sub pagespec_translate ($) { #{{{
1092 # This assumes that $page is in scope in the function
1093 # that evalulates the translated pagespec code.
1096 # Support for old-style GlobLists.
1097 if (is_globlist($spec)) {
1098 $spec=globlist_to_pagespec($spec);
1101 # Convert spec to perl code.
1104 \s* # ignore whitespace
1105 ( # 1: match a single word
1112 \w+\([^\)]*\) # command(params)
1114 [^\s()]+ # any other text
1116 \s* # ignore whitespace
1119 if (lc $word eq 'and') {
1122 elsif (lc $word eq 'or') {
1125 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1128 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1129 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1130 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";
1137 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)";
1144 sub pagespec_match ($$;@) { #{{{
1149 # Backwards compatability with old calling convention.
1151 unshift @params, 'location';
1154 my $ret=eval pagespec_translate($spec);
1155 return IkiWiki::FailReason->new('syntax error') if $@;
1159 package IkiWiki::FailReason;
1162 '""' => sub { ${$_[0]} },
1164 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1169 return bless \$_[1], $_[0];
1172 package IkiWiki::SuccessReason;
1175 '""' => sub { ${$_[0]} },
1177 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1182 return bless \$_[1], $_[0];
1185 package IkiWiki::PageSpec;
1187 sub match_glob ($$;@) { #{{{
1192 my $from=exists $params{location} ? $params{location} : '';
1195 if ($glob =~ m!^\./!) {
1196 $from=~s#/?[^/]+$##;
1198 $glob="$from/$glob" if length $from;
1201 # turn glob into safe regexp
1202 $glob=quotemeta($glob);
1206 if ($page=~/^$glob$/i) {
1207 return IkiWiki::SuccessReason->new("$glob matches $page");
1210 return IkiWiki::FailReason->new("$glob does not match $page");
1214 sub match_link ($$;@) { #{{{
1219 my $from=exists $params{location} ? $params{location} : '';
1222 if ($link =~ m!^\.! && defined $from) {
1223 $from=~s#/?[^/]+$##;
1225 $link="$from/$link" if length $from;
1228 my $links = $IkiWiki::links{$page};
1229 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1230 my $bestlink = IkiWiki::bestlink($from, $link);
1231 foreach my $p (@{$links}) {
1232 if (length $bestlink) {
1233 return IkiWiki::SuccessReason->new("$page links to $link")
1234 if $bestlink eq IkiWiki::bestlink($page, $p);
1237 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1238 if match_glob($p, $link, %params);
1241 return IkiWiki::FailReason->new("$page does not link to $link");
1244 sub match_backlink ($$;@) { #{{{
1245 return match_link($_[1], $_[0], @_);
1248 sub match_created_before ($$;@) { #{{{
1252 if (exists $IkiWiki::pagectime{$testpage}) {
1253 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1254 return IkiWiki::SuccessReason->new("$page created before $testpage");
1257 return IkiWiki::FailReason->new("$page not created before $testpage");
1261 return IkiWiki::FailReason->new("$testpage has no ctime");
1265 sub match_created_after ($$;@) { #{{{
1269 if (exists $IkiWiki::pagectime{$testpage}) {
1270 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1271 return IkiWiki::SuccessReason->new("$page created after $testpage");
1274 return IkiWiki::FailReason->new("$page not created after $testpage");
1278 return IkiWiki::FailReason->new("$testpage has no ctime");
1282 sub match_creation_day ($$;@) { #{{{
1283 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1284 return IkiWiki::SuccessReason->new('creation_day matched');
1287 return IkiWiki::FailReason->new('creation_day did not match');
1291 sub match_creation_month ($$;@) { #{{{
1292 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1293 return IkiWiki::SuccessReason->new('creation_month matched');
1296 return IkiWiki::FailReason->new('creation_month did not match');
1300 sub match_creation_year ($$;@) { #{{{
1301 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1302 return IkiWiki::SuccessReason->new('creation_year matched');
1305 return IkiWiki::FailReason->new('creation_year did not match');
1309 sub match_user ($$;@) { #{{{
1314 return IkiWiki::FailReason->new('cannot match user')
1315 unless exists $params{user};
1316 if ($user eq $params{user}) {
1317 return IkiWiki::SuccessReason->new("user is $user")
1320 return IkiWiki::FailReason->new("user is not $user");