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 if ($config{usedirs}) {
518 $url =~ s!/index.$config{htmlext}$!/!;
520 $url =~ s!^$!./!; # Browsers don't like empty links...
525 sub urlto ($$) { #{{{
530 return beautify_url(baseurl($from));
533 if (! $destsources{$to}) {
537 my $link = abs2rel($to, dirname(htmlpage($from)));
539 return beautify_url($link);
542 sub htmllink ($$$;@) { #{{{
543 my $lpage=shift; # the page doing the linking
544 my $page=shift; # the page that will contain the link (different for inline)
551 if (! $opts{forcesubpage}) {
552 $bestlink=bestlink($lpage, $link);
555 $bestlink="$lpage/".lc($link);
559 if (defined $opts{linktext}) {
560 $linktext=$opts{linktext};
563 $linktext=pagetitle(basename($link));
566 return "<span class=\"selflink\">$linktext</span>"
567 if length $bestlink && $page eq $bestlink &&
568 ! defined $opts{anchor};
570 if (! $destsources{$bestlink}) {
571 $bestlink=htmlpage($bestlink);
573 if (! $destsources{$bestlink}) {
574 return $linktext unless length $config{cgiurl};
575 return "<span class=\"createlink\"><a href=\"".
578 page => pagetitle(lc($link), 1),
581 "\">?</a>$linktext</span>"
585 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
586 $bestlink=beautify_url($bestlink);
588 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
589 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
592 if (defined $opts{anchor}) {
593 $bestlink.="#".$opts{anchor};
597 if (defined $opts{rel}) {
598 push @attrs, ' rel="'.$opts{rel}.'"';
600 if (defined $opts{class}) {
601 push @attrs, ' class="'.$opts{class}.'"';
604 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
607 sub htmlize ($$$) { #{{{
612 if (exists $hooks{htmlize}{$type}) {
613 $content=$hooks{htmlize}{$type}{call}->(
619 error("htmlization of $type not supported");
622 run_hooks(sanitize => sub {
632 sub linkify ($$$) { #{{{
633 my $lpage=shift; # the page containing the links
634 my $page=shift; # the page the link will end up on (different for inline)
637 $content =~ s{(\\?)$config{wiki_link_regexp}}{
640 ? "[[$2|$3".($4 ? "#$4" : "")."]]"
641 : htmllink($lpage, $page, linkpage($3),
642 anchor => $4, linktext => pagetitle($2)))
644 ? "[[$3".($4 ? "#$4" : "")."]]"
645 : htmllink($lpage, $page, linkpage($3),
653 our $preprocess_preview=0;
654 sub preprocess ($$$;$$) { #{{{
655 my $page=shift; # the page the data comes from
656 my $destpage=shift; # the page the data will appear in (different for inline)
661 # Using local because it needs to be set within any nested calls
663 local $preprocess_preview=$preview if defined $preview;
669 if (length $escape) {
670 return "[[$command $params]]";
672 elsif (exists $hooks{preprocess}{$command}) {
673 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
674 # Note: preserve order of params, some plugins may
675 # consider it significant.
678 (?:(\w+)=)? # 1: named parameter key?
680 """(.*?)""" # 2: triple-quoted value
682 "([^"]+)" # 3: single-quoted value
684 (\S+) # 4: unquoted value
686 (?:\s+|$) # delimiter to next param
704 push @params, $key, $val;
707 push @params, $val, '';
710 if ($preprocessing{$page}++ > 3) {
711 # Avoid loops of preprocessed pages preprocessing
712 # other pages that preprocess them, etc.
713 #translators: The first parameter is a
714 #translators: preprocessor directive name,
715 #translators: the second a page name, the
716 #translators: third a number.
717 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
718 $command, $page, $preprocessing{$page}).
721 my $ret=$hooks{preprocess}{$command}{call}->(
724 destpage => $destpage,
725 preview => $preprocess_preview,
727 $preprocessing{$page}--;
731 return "[[$command $params]]";
737 \[\[ # directive open
740 ( # 3: the parameters..
742 (?:\w+=)? # named parameter key?
744 """.*?""" # triple-quoted value
746 "[^"]+" # single-quoted value
748 [^\s\]]+ # unquoted value
750 \s* # whitespace or end
753 *) # 0 or more parameters
754 \]\] # directive closed
755 }{$handle->($1, $2, $3)}sexg;
759 sub filter ($$$) { #{{{
764 run_hooks(filter => sub {
765 $content=shift->(page => $page, destpage => $destpage,
766 content => $content);
772 sub indexlink () { #{{{
773 return "<a href=\"$config{url}\">$config{wikiname}</a>";
778 sub lockwiki (;$) { #{{{
779 my $wait=@_ ? shift : 1;
780 # Take an exclusive lock on the wiki to prevent multiple concurrent
781 # run issues. The lock will be dropped on program exit.
782 if (! -d $config{wikistatedir}) {
783 mkdir($config{wikistatedir});
785 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
786 error ("cannot write to $config{wikistatedir}/lockfile: $!");
787 if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
789 debug("wiki seems to be locked, waiting for lock");
790 my $wait=600; # arbitrary, but don't hang forever to
791 # prevent process pileup
793 return if flock($wikilock, 2 | 4);
796 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
805 sub unlockwiki () { #{{{
806 return close($wikilock) if $wikilock;
812 sub commit_hook_enabled () { #{{{
813 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
814 error("cannot write to $config{wikistatedir}/commitlock: $!");
815 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
816 close($commitlock) || error("failed closing commitlock: $!");
819 close($commitlock) || error("failed closing commitlock: $!");
823 sub disable_commit_hook () { #{{{
824 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
825 error("cannot write to $config{wikistatedir}/commitlock: $!");
826 if (! flock($commitlock, 2)) { # LOCK_EX
827 error("failed to get commit lock");
832 sub enable_commit_hook () { #{{{
833 return close($commitlock) if $commitlock;
837 sub loadindex () { #{{{
838 %oldrenderedfiles=%pagectime=();
839 if (! $config{rebuild}) {
840 %pagesources=%pagemtime=%oldlinks=%links=%depends=
841 %destsources=%renderedfiles=%pagecase=();
843 open (my $in, "<", "$config{wikistatedir}/index") || return;
845 $_=possibly_foolish_untaint($_);
850 foreach my $i (split(/ /, $_)) {
851 my ($item, $val)=split(/=/, $i, 2);
852 push @{$items{$item}}, decode_entities($val);
855 next unless exists $items{src}; # skip bad lines for now
857 my $page=pagename($items{src}[0]);
858 if (! $config{rebuild}) {
859 $pagesources{$page}=$items{src}[0];
860 $pagemtime{$page}=$items{mtime}[0];
861 $oldlinks{$page}=[@{$items{link}}];
862 $links{$page}=[@{$items{link}}];
863 $depends{$page}=$items{depends}[0] if exists $items{depends};
864 $destsources{$_}=$page foreach @{$items{dest}};
865 $renderedfiles{$page}=[@{$items{dest}}];
866 $pagecase{lc $page}=$page;
868 $oldrenderedfiles{$page}=[@{$items{dest}}];
869 $pagectime{$page}=$items{ctime}[0];
874 sub saveindex () { #{{{
875 run_hooks(savestate => sub { shift->() });
877 if (! -d $config{wikistatedir}) {
878 mkdir($config{wikistatedir});
880 my $newfile="$config{wikistatedir}/index.new";
881 my $cleanup = sub { unlink($newfile) };
882 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
883 foreach my $page (keys %pagemtime) {
884 next unless $pagemtime{$page};
885 my $line="mtime=$pagemtime{$page} ".
886 "ctime=$pagectime{$page} ".
887 "src=$pagesources{$page}";
888 $line.=" dest=$_" foreach @{$renderedfiles{$page}};
890 $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
891 if (exists $depends{$page}) {
892 $line.=" depends=".encode_entities($depends{$page}, " \t\n");
894 print $out $line."\n" || error("failed writing to $newfile: $!", $cleanup);
896 close $out || error("failed saving to $newfile: $!", $cleanup);
897 rename($newfile, "$config{wikistatedir}/index") ||
898 error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
903 sub template_file ($) { #{{{
906 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
907 return "$dir/$template" if -e "$dir/$template";
912 sub template_params (@) { #{{{
913 my $filename=template_file(shift);
915 if (! defined $filename) {
922 my $text_ref = shift;
923 ${$text_ref} = decode_utf8(${$text_ref});
925 filename => $filename,
926 loop_context_vars => 1,
927 die_on_bad_params => 0,
930 return wantarray ? @ret : {@ret};
933 sub template ($;@) { #{{{
934 require HTML::Template;
935 return HTML::Template->new(template_params(@_));
938 sub misctemplate ($$;@) { #{{{
942 my $template=template("misc.tmpl");
945 indexlink => indexlink(),
946 wikiname => $config{wikiname},
947 pagebody => $pagebody,
948 baseurl => baseurl(),
951 run_hooks(pagetemplate => sub {
952 shift->(page => "", destpage => "", template => $template);
954 return $template->output;
960 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
961 error 'hook requires type, call, and id parameters';
964 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
966 $hooks{$param{type}}{$param{id}}=\%param;
970 sub run_hooks ($$) { # {{{
971 # Calls the given sub for each hook of the given type,
972 # passing it the hook function to call.
976 if (exists $hooks{$type}) {
978 foreach my $id (keys %{$hooks{$type}}) {
979 if ($hooks{$type}{$id}{last}) {
983 $sub->($hooks{$type}{$id}{call});
985 foreach my $id (@deferred) {
986 $sub->($hooks{$type}{$id}{call});
993 sub globlist_to_pagespec ($) { #{{{
994 my @globlist=split(' ', shift);
997 foreach my $glob (@globlist) {
998 if ($glob=~/^!(.*)/) {
1006 my $spec=join(' or ', @spec);
1008 my $skip=join(' and ', @skip);
1010 $spec="$skip and ($spec)";
1019 sub is_globlist ($) { #{{{
1021 return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1024 sub safequote ($) { #{{{
1030 sub add_depends ($$) { #{{{
1034 if (! exists $depends{$page}) {
1035 $depends{$page}=$pagespec;
1038 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1044 sub file_pruned ($$) { #{{{
1046 my $file=File::Spec->canonpath(shift);
1047 my $base=File::Spec->canonpath(shift);
1048 $file =~ s#^\Q$base\E/*##;
1050 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1051 return $file =~ m/$regexp/;
1055 # Only use gettext in the rare cases it's needed.
1056 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1057 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1058 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1059 if (! $gettext_obj) {
1060 $gettext_obj=eval q{
1061 use Locale::gettext q{textdomain};
1062 Locale::gettext->domain('ikiwiki')
1070 return $gettext_obj->get(shift);
1077 sub pagespec_merge ($$) { #{{{
1081 return $a if $a eq $b;
1083 # Support for old-style GlobLists.
1084 if (is_globlist($a)) {
1085 $a=globlist_to_pagespec($a);
1087 if (is_globlist($b)) {
1088 $b=globlist_to_pagespec($b);
1091 return "($a) or ($b)";
1094 sub pagespec_translate ($) { #{{{
1095 # This assumes that $page is in scope in the function
1096 # that evalulates the translated pagespec code.
1099 # Support for old-style GlobLists.
1100 if (is_globlist($spec)) {
1101 $spec=globlist_to_pagespec($spec);
1104 # Convert spec to perl code.
1107 \s* # ignore whitespace
1108 ( # 1: match a single word
1115 \w+\([^\)]*\) # command(params)
1117 [^\s()]+ # any other text
1119 \s* # ignore whitespace
1122 if (lc $word eq 'and') {
1125 elsif (lc $word eq 'or') {
1128 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1131 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1132 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1133 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";
1140 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)";
1147 sub pagespec_match ($$;@) { #{{{
1152 # Backwards compatability with old calling convention.
1154 unshift @params, 'location';
1157 my $ret=eval pagespec_translate($spec);
1158 return IkiWiki::FailReason->new('syntax error') if $@;
1162 package IkiWiki::FailReason;
1165 '""' => sub { ${$_[0]} },
1167 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1172 return bless \$_[1], $_[0];
1175 package IkiWiki::SuccessReason;
1178 '""' => sub { ${$_[0]} },
1180 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
1185 return bless \$_[1], $_[0];
1188 package IkiWiki::PageSpec;
1190 sub match_glob ($$;@) { #{{{
1195 my $from=exists $params{location} ? $params{location} : '';
1198 if ($glob =~ m!^\./!) {
1199 $from=~s#/?[^/]+$##;
1201 $glob="$from/$glob" if length $from;
1204 # turn glob into safe regexp
1205 $glob=quotemeta($glob);
1209 if ($page=~/^$glob$/i) {
1210 return IkiWiki::SuccessReason->new("$glob matches $page");
1213 return IkiWiki::FailReason->new("$glob does not match $page");
1217 sub match_link ($$;@) { #{{{
1222 my $from=exists $params{location} ? $params{location} : '';
1225 if ($link =~ m!^\.! && defined $from) {
1226 $from=~s#/?[^/]+$##;
1228 $link="$from/$link" if length $from;
1231 my $links = $IkiWiki::links{$page};
1232 return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1233 my $bestlink = IkiWiki::bestlink($from, $link);
1234 foreach my $p (@{$links}) {
1235 if (length $bestlink) {
1236 return IkiWiki::SuccessReason->new("$page links to $link")
1237 if $bestlink eq IkiWiki::bestlink($page, $p);
1240 return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1241 if match_glob($p, $link, %params);
1244 return IkiWiki::FailReason->new("$page does not link to $link");
1247 sub match_backlink ($$;@) { #{{{
1248 return match_link($_[1], $_[0], @_);
1251 sub match_created_before ($$;@) { #{{{
1255 if (exists $IkiWiki::pagectime{$testpage}) {
1256 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1257 return IkiWiki::SuccessReason->new("$page created before $testpage");
1260 return IkiWiki::FailReason->new("$page not created before $testpage");
1264 return IkiWiki::FailReason->new("$testpage has no ctime");
1268 sub match_created_after ($$;@) { #{{{
1272 if (exists $IkiWiki::pagectime{$testpage}) {
1273 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1274 return IkiWiki::SuccessReason->new("$page created after $testpage");
1277 return IkiWiki::FailReason->new("$page not created after $testpage");
1281 return IkiWiki::FailReason->new("$testpage has no ctime");
1285 sub match_creation_day ($$;@) { #{{{
1286 if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1287 return IkiWiki::SuccessReason->new('creation_day matched');
1290 return IkiWiki::FailReason->new('creation_day did not match');
1294 sub match_creation_month ($$;@) { #{{{
1295 if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1296 return IkiWiki::SuccessReason->new('creation_month matched');
1299 return IkiWiki::FailReason->new('creation_month did not match');
1303 sub match_creation_year ($$;@) { #{{{
1304 if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1305 return IkiWiki::SuccessReason->new('creation_year matched');
1308 return IkiWiki::FailReason->new('creation_year did not match');
1312 sub match_user ($$;@) { #{{{
1317 return IkiWiki::FailReason->new('cannot match user')
1318 unless exists $params{user};
1319 if ($user eq $params{user}) {
1320 return IkiWiki::SuccessReason->new("user is $user")
1323 return IkiWiki::FailReason->new("user is not $user");