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 %wikistate %renderedfiles %oldrenderedfiles
15 %pagesources %delpagesources %destsources %depends %depends_simple
16 @mass_depends %hooks %forcerebuild %loaded_plugins %typedlinks
17 %oldtypedlinks %autofiles @underlayfiles $lastrev};
19 use Exporter q{import};
20 our @EXPORT = qw(hook debug error htmlpage template template_depends
21 deptype add_depends pagespec_match pagespec_match_list bestlink
22 htmllink readfile writefile pagetype srcfile pagename
23 displaytime strftime_utf8 will_render gettext ngettext urlto targetpage
24 add_underlay pagetitle titlepage linkpage newpagefile
25 inject add_link add_autofile useragent
26 %config %links %pagestate %wikistate %renderedfiles
27 %pagesources %destsources %typedlinks);
28 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
29 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
30 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
32 # Page dependency types.
33 our $DEPEND_CONTENT=1;
34 our $DEPEND_PRESENCE=2;
40 memoize("sortspec_translate");
41 memoize("pagespec_translate");
42 memoize("template_file");
48 description => "name of the wiki",
55 example => 'me@example.com',
56 description => "contact email for wiki",
63 description => "users who are wiki admins",
70 description => "users who are banned from the wiki",
77 example => "$ENV{HOME}/wiki",
78 description => "where the source of the wiki is located",
85 example => "/var/www/wiki",
86 description => "where to build the wiki",
93 example => "http://example.com/wiki",
94 description => "base url to the wiki",
101 example => "http://example.com/wiki/ikiwiki.cgi",
102 description => "url to the ikiwiki.cgi",
109 example => "/var/www/wiki/ikiwiki.cgi",
110 description => "filename of cgi wrapper to generate",
117 description => "mode for cgi_wrapper (can safely be made suid)",
121 cgi_overload_delay => {
125 description => "number of seconds to delay CGI requests when overloaded",
129 cgi_overload_message => {
132 example => "Please wait",
133 description => "message to display when overloaded (may contain html)",
137 only_committed_changes => {
140 description => "enable optimization of only refreshing committed changes?",
147 description => "rcs backend to use",
148 safe => 0, # don't allow overriding
153 default => [qw{mdwn link inline meta htmlscrubber passwordauth
154 openid signinedit lockedit conditional
155 recentchanges parentlinks editpage}],
156 description => "plugins to enable by default",
163 description => "plugins to add to the default configuration",
170 description => "plugins to disable",
176 default => "$installdir/share/ikiwiki/templates",
177 description => "additional directory to search for template files",
184 default => "$installdir/share/ikiwiki/basewiki",
185 description => "base wiki source location",
192 default => "$installdir/share/ikiwiki",
193 description => "parent directory containing additional underlays",
200 description => "wrappers to generate",
207 description => "additional underlays to use",
214 description => "display verbose messages?",
221 description => "log to syslog?",
228 description => "create output files named page/index.html?",
229 safe => 0, # changing requires manual transition
232 prefix_directives => {
235 description => "use '!'-prefixed preprocessor directives?",
236 safe => 0, # changing requires manual transition
242 description => "use page/index.mdwn source files",
249 description => "enable Discussion pages?",
255 default => gettext("Discussion"),
256 description => "name of Discussion pages",
263 description => "generate HTML5?",
271 description => "only send cookies over SSL connections?",
279 description => "extension to use for new pages",
280 safe => 0, # not sanitized
286 description => "extension to use for html files",
287 safe => 0, # not sanitized
293 description => "strftime format string to display date",
301 example => "en_US.UTF-8",
302 description => "UTF-8 locale to use",
311 description => "put user pages below specified page",
318 description => "how many backlinks to show before hiding excess (0 to show all)",
325 description => "attempt to hardlink source files? (optimisation for large files)",
327 safe => 0, # paranoia
333 description => "force ikiwiki to use a particular umask (keywords public, group or private, or a number)",
335 safe => 0, # paranoia
340 example => "ikiwiki",
341 description => "group for wrappers to run in",
343 safe => 0, # paranoia
349 example => "$ENV{HOME}/.ikiwiki/",
350 description => "extra library and plugin directory",
352 safe => 0, # directory
358 description => "environment variables",
359 safe => 0, # paranoia
365 example => "US/Eastern",
366 description => "time zone name",
373 example => '^\.htaccess$',
374 description => "regexp of normally excluded files to include",
382 example => '^(*\.private|Makefile)$',
383 description => "regexp of files that should be skipped",
388 wiki_file_prune_regexps => {
390 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\//, qr/^\./, qr/\/\./,
391 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
392 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
393 qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
394 qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
395 description => "regexps of source files to ignore",
401 description => "specifies the characters that are allowed in source filenames",
402 default => "-[:alnum:]+/.:_",
406 wiki_file_regexp => {
408 description => "regexp of legal source files",
412 web_commit_regexp => {
414 default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
415 description => "regexp to parse web commits from logs",
422 description => "run as a cgi",
426 cgi_disable_uploads => {
429 description => "whether CGI should accept file uploads",
436 description => "run as a post-commit hook",
443 description => "running in rebuild mode",
450 description => "running in setup mode",
457 description => "running in clean mode",
464 description => "running in refresh mode",
471 description => "running in receive test mode",
475 wrapper_background_command => {
478 description => "background shell command to run",
484 description => "running in gettime mode",
491 description => "running in w3mmode",
498 description => "path to the .ikiwiki directory holding ikiwiki state",
505 description => "path to setup file",
512 description => "perl class to use to dump setup file",
516 allow_symlinks_before_srcdir => {
519 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
525 default => { file => "$ENV{HOME}/.ikiwiki/cookies" },
526 description => "cookie control",
527 safe => 0, # hooks into perl module internals
533 example => "Wget/1.13.4 (linux-gnu)",
534 description => "set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds",
540 sub defaultconfig () {
543 foreach my $key (keys %s) {
544 push @ret, $key, $s{$key}->{default};
549 # URL to top of wiki as a path starting with /, valid from any wiki page or
550 # the CGI; if that's not possible, an absolute URL. Either way, it ends with /
552 # URL to CGI script, similar to $local_url
556 # locale stuff; avoid LC_ALL since it overrides everything
557 if (defined $ENV{LC_ALL}) {
558 $ENV{LANG} = $ENV{LC_ALL};
561 if (defined $config{locale}) {
562 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
563 $ENV{LANG}=$config{locale};
568 if (! defined $config{wiki_file_regexp}) {
569 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
572 if (ref $config{ENV} eq 'HASH') {
573 foreach my $val (keys %{$config{ENV}}) {
574 $ENV{$val}=$config{ENV}{$val};
577 if (defined $config{timezone} && length $config{timezone}) {
578 $ENV{TZ}=$config{timezone};
581 $config{timezone}=$ENV{TZ};
584 if ($config{w3mmode}) {
585 eval q{use Cwd q{abs_path}};
587 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
588 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
589 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
590 unless $config{cgiurl} =~ m!file:///!;
591 $config{url}="file://".$config{destdir};
594 if ($config{cgi} && ! length $config{url}) {
595 error(gettext("Must specify url to wiki with --url when using --cgi"));
598 if (defined $config{url} && length $config{url}) {
600 my $baseurl = URI->new($config{url});
602 $local_url = $baseurl->path . "/";
603 $local_cgiurl = undef;
605 if (length $config{cgiurl}) {
606 my $cgiurl = URI->new($config{cgiurl});
608 $local_cgiurl = $cgiurl->path;
610 if ($cgiurl->scheme ne $baseurl->scheme or
611 $cgiurl->authority ne $baseurl->authority) {
612 # too far apart, fall back to absolute URLs
613 $local_url = "$config{url}/";
614 $local_cgiurl = $config{cgiurl};
618 $local_url =~ s{//$}{/};
621 $local_cgiurl = $config{cgiurl};
624 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
625 unless exists $config{wikistatedir} && defined $config{wikistatedir};
627 if (defined $config{umask}) {
628 my $u = possibly_foolish_untaint($config{umask});
630 if ($u =~ m/^\d+$/) {
633 elsif ($u eq 'private') {
636 elsif ($u eq 'group') {
639 elsif ($u eq 'public') {
643 error(sprintf(gettext("unsupported umask setting %s"), $u));
647 run_hooks(checkconfig => sub { shift->() });
655 foreach my $dir (@INC, $config{libdir}) {
656 next unless defined $dir && length $dir;
657 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
658 my ($plugin)=$file=~/.*\/(.*)\.pm$/;
662 foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
663 next unless defined $dir && length $dir;
664 foreach my $file (glob("$dir/plugins/*")) {
665 $ret{basename($file)}=1 if -x $file;
673 if (defined $config{libdir} && length $config{libdir}) {
674 unshift @INC, possibly_foolish_untaint($config{libdir});
677 foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
682 if (exists $hooks{rcs}) {
683 error(gettext("cannot use multiple rcs plugins"));
685 loadplugin($config{rcs});
687 if (! exists $hooks{rcs}) {
691 run_hooks(getopt => sub { shift->() });
692 if (grep /^-/, @ARGV) {
693 print STDERR "Unknown option (or missing parameter): $_\n"
694 foreach grep /^-/, @ARGV;
701 sub loadplugin ($;$) {
705 return if ! $force && grep { $_ eq $plugin} @{$config{disable_plugins}};
707 foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
708 "$installdir/lib/ikiwiki") {
709 if (defined $dir && -x "$dir/plugins/$plugin") {
710 eval { require IkiWiki::Plugin::external };
713 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
715 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
716 $loaded_plugins{$plugin}=1;
721 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
724 error("Failed to load plugin $mod: $@");
726 $loaded_plugins{$plugin}=1;
733 log_message('err' => $message) if $config{syslog};
734 if (defined $cleaner) {
741 return unless $config{verbose};
742 return log_message(debug => @_);
746 sub log_message ($$) {
749 if ($config{syslog}) {
752 Sys::Syslog::setlogsock('unix');
753 Sys::Syslog::openlog('ikiwiki', '', 'user');
757 Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
760 elsif (! $config{cgi}) {
764 return print STDERR "@_\n";
768 sub possibly_foolish_untaint ($) {
770 my ($untainted)=$tainted=~/(.*)/s;
790 return exists $pagesources{$page} &&
791 $pagesources{$page} =~ /\._([^.]+)$/;
797 if ($file =~ /\.([^.]+)$/) {
798 return $1 if exists $hooks{htmlize}{$1};
800 my $base=basename($file);
801 if (exists $hooks{htmlize}{$base} &&
802 $hooks{htmlize}{$base}{noextension}) {
813 if (exists $pagename_cache{$file}) {
814 return $pagename_cache{$file};
817 my $type=pagetype($file);
819 $page=~s/\Q.$type\E*$//
820 if defined $type && !$hooks{htmlize}{$type}{keepextension}
821 && !$hooks{htmlize}{$type}{noextension};
822 if ($config{indexpages} && $page=~/(.*)\/index$/) {
826 $pagename_cache{$file} = $page;
830 sub newpagefile ($$) {
834 if (! $config{indexpages} || $page eq 'index') {
835 return $page.".".$type;
838 return $page."/index.".$type;
842 sub targetpage ($$;$) {
847 if (defined $filename) {
848 return $page."/".$filename.".".$ext;
850 elsif (! $config{usedirs} || $page eq 'index') {
851 return $page.".".$ext;
854 return $page."/index.".$ext;
861 return targetpage($page, $config{htmlext});
868 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
869 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
870 return "$dir/$file", stat(_) if -e "$dir/$file";
872 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
877 return (srcfile_stat(@_))[0];
880 sub add_literal_underlay ($) {
883 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
884 unshift @{$config{underlaydirs}}, $dir;
888 sub add_underlay ($) {
892 $dir="$config{underlaydirbase}/$dir";
895 add_literal_underlay($dir);
896 # why does it return 1? we just don't know
900 sub readfile ($;$$) {
906 error("cannot read a symlink ($file)");
910 open (my $in, "<", $file) || error("failed to read $file: $!");
911 binmode($in) if ($binary);
912 return \*$in if $wantfd;
914 # check for invalid utf-8, and toss it back to avoid crashes
915 if (! utf8::valid($ret)) {
916 $ret=encode_utf8($ret);
918 close $in || error("failed to read $file: $!");
922 sub prep_writefile ($$) {
927 while (length $test) {
928 if (-l "$destdir/$test") {
929 error("cannot write to a symlink ($test)");
931 if (-f _ && $test ne $file) {
932 # Remove conflicting file.
933 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
934 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
936 unlink("$destdir/$test");
942 $test=dirname($test);
945 my $dir=dirname("$destdir/$file");
948 foreach my $s (split(m!/+!, $dir)) {
951 mkdir($d) || error("failed to create directory $d: $!");
959 sub writefile ($$$;$$) {
960 my $file=shift; # can include subdirs
961 my $destdir=shift; # directory to put file in
966 prep_writefile($file, $destdir);
968 my $newfile="$destdir/$file.ikiwiki-new";
970 error("cannot write to a symlink ($newfile)");
973 my $cleanup = sub { unlink($newfile) };
974 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
975 binmode($out) if ($binary);
977 $writer->(\*$out, $cleanup);
980 print $out $content or error("failed writing to $newfile: $!", $cleanup);
982 close $out || error("failed saving $newfile: $!", $cleanup);
983 rename($newfile, "$destdir/$file") ||
984 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
990 sub will_render ($$;$) {
995 # Important security check for independently created files.
996 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
997 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
998 my $from_other_page=0;
999 # Expensive, but rarely runs.
1000 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1003 dirname($_) eq $dest
1004 } @{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1010 error("$config{destdir}/$dest independently created, not overwriting with version from $page")
1011 unless $from_other_page;
1014 # If $dest exists as a directory, remove conflicting files in it
1015 # rendered from other pages.
1017 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1018 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1019 if (dirname($f) eq $dest) {
1020 unlink("$config{destdir}/$f");
1021 rmdir(dirname("$config{destdir}/$f"));
1027 if (! $clear || $cleared{$page}) {
1028 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
1031 foreach my $old (@{$renderedfiles{$page}}) {
1032 delete $destsources{$old};
1034 $renderedfiles{$page}=[$dest];
1037 $destsources{$dest}=$page;
1047 if ($link=~s/^\/+//) {
1055 $l.="/" if length $l;
1058 if (exists $pagesources{$l}) {
1061 elsif (exists $pagecase{lc $l}) {
1062 return $pagecase{lc $l};
1064 } while $cwd=~s{/?[^/]+$}{};
1066 if (length $config{userdir}) {
1067 my $l = "$config{userdir}/".lc($link);
1068 if (exists $pagesources{$l}) {
1071 elsif (exists $pagecase{lc $l}) {
1072 return $pagecase{lc $l};
1076 #print STDERR "warning: page $page, broken link: $link\n";
1080 sub isinlinableimage ($) {
1083 return $file =~ /\.(png|gif|jpg|jpeg|svg)$/i;
1086 sub pagetitle ($;$) {
1088 my $unescaped=shift;
1091 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
1094 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
1102 # support use w/o %config set
1103 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1104 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1110 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1111 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1118 my $cgiurl=$local_cgiurl;
1120 if (exists $params{cgiurl}) {
1121 $cgiurl=$params{cgiurl};
1122 delete $params{cgiurl};
1130 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
1133 sub cgiurl_abs (@) {
1135 URI->new_abs(cgiurl(@_), $config{cgiurl});
1141 return $local_url if ! defined $page;
1143 $page=htmlpage($page);
1145 $page=~s/[^\/]+\//..\//g;
1153 return $url unless defined $urlbase && length $urlbase;
1156 URI->new_abs($url, $urlbase)->as_string;
1160 # Work around very innefficient behavior in File::Spec if abs2rel
1161 # is passed two relative paths. It's much faster if paths are
1162 # absolute! (Debian bug #376658; fixed in debian unstable now)
1167 my $ret=File::Spec->abs2rel($path, $base);
1168 $ret=~s/^// if defined $ret;
1172 sub displaytime ($;$$) {
1173 # Plugins can override this function to mark up the time to
1175 my $time=formattime($_[0], $_[1]);
1176 if ($config{html5}) {
1177 return '<time datetime="'.date_3339($_[0]).'"'.
1178 ($_[2] ? ' pubdate="pubdate"' : '').
1179 '>'.$time.'</time>';
1182 return '<span class="date">'.$time.'</span>';
1186 sub formattime ($;$) {
1187 # Plugins can override this function to format the time.
1190 if (! defined $format) {
1191 $format=$config{timeformat};
1194 return strftime_utf8($format, localtime($time));
1197 my $strftime_encoding;
1199 # strftime doesn't know about encodings, so make sure
1200 # its output is properly treated as utf8.
1201 # Note that this does not handle utf-8 in the format string.
1202 ($strftime_encoding) = POSIX::setlocale(&POSIX::LC_TIME) =~ m#\.([^@]+)#
1203 unless defined $strftime_encoding;
1205 ? Encode::decode($strftime_encoding, POSIX::strftime(@_))
1206 : POSIX::strftime(@_);
1212 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
1213 POSIX::setlocale(&POSIX::LC_TIME, "C");
1214 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
1215 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
1219 sub beautify_urlpath ($) {
1222 # Ensure url is not an empty link, and if necessary,
1223 # add ./ to avoid colon confusion.
1224 if ($url !~ /^\// && $url !~ /^\.\.?\//) {
1228 if ($config{usedirs}) {
1229 $url =~ s!/index.$config{htmlext}$!/!;
1244 if (! $destsources{$to}) {
1249 return $config{url}.beautify_urlpath("/".$to);
1252 if (! defined $from) {
1253 my $u = $local_url || '';
1255 return $u.beautify_urlpath("/".$to);
1258 my $link = abs2rel($to, dirname(htmlpage($from)));
1260 return beautify_urlpath($link);
1263 sub isselflink ($$) {
1264 # Plugins can override this function to support special types
1269 return $page eq $link;
1272 sub htmllink ($$$;@) {
1273 my $lpage=shift; # the page doing the linking
1274 my $page=shift; # the page that will contain the link (different for inline)
1281 if (! $opts{forcesubpage}) {
1282 $bestlink=bestlink($lpage, $link);
1285 $bestlink="$lpage/".lc($link);
1289 if (defined $opts{linktext}) {
1290 $linktext=$opts{linktext};
1293 $linktext=pagetitle(basename($link));
1296 return "<span class=\"selflink\">$linktext</span>"
1297 if length $bestlink && isselflink($page, $bestlink) &&
1298 ! defined $opts{anchor};
1300 if (! $destsources{$bestlink}) {
1301 $bestlink=htmlpage($bestlink);
1303 if (! $destsources{$bestlink}) {
1305 if (length $config{cgiurl}) {
1306 $cgilink = "<a href=\"".
1311 )."\" rel=\"nofollow\">?</a>";
1313 return "<span class=\"createlink\">$cgilink$linktext</span>"
1317 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1318 $bestlink=beautify_urlpath($bestlink);
1320 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1321 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1324 if (defined $opts{anchor}) {
1325 $bestlink.="#".$opts{anchor};
1329 foreach my $attr (qw{rel class title}) {
1330 if (defined $opts{$attr}) {
1331 push @attrs, " $attr=\"$opts{$attr}\"";
1335 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1340 return length $config{userdir} ? "$config{userdir}/$user" : $user;
1343 sub openiduser ($) {
1346 if (defined $user && $user =~ m!^https?://! &&
1347 eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1350 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1351 $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1354 # backcompat with old version
1355 my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1356 $display=$oid->display;
1359 # Convert "user.somehost.com" to "user [somehost.com]"
1360 # (also "user.somehost.co.uk")
1361 if ($display !~ /\[/) {
1362 $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1364 # Convert "http://somehost.com/user" to "user [somehost.com]".
1365 # (also "https://somehost.com/user/")
1366 if ($display !~ /\[/) {
1367 $display=~s/^https?:\/\/(.+)\/([^\/#?]+)\/?(?:[#?].*)?$/$2 [$1]/;
1369 $display=~s!^https?://!!; # make sure this is removed
1370 eval q{use CGI 'escapeHTML'};
1372 return escapeHTML($display);
1377 sub htmlize ($$$$) {
1383 my $oneline = $content !~ /\n/;
1385 if (exists $hooks{htmlize}{$type}) {
1386 $content=$hooks{htmlize}{$type}{call}->(
1388 content => $content,
1392 error("htmlization of $type not supported");
1395 run_hooks(sanitize => sub {
1398 destpage => $destpage,
1399 content => $content,
1404 # hack to get rid of enclosing junk added by markdown
1405 # and other htmlizers/sanitizers
1406 $content=~s/^<p>//i;
1407 $content=~s/<\/p>\n*$//i;
1418 run_hooks(linkify => sub {
1421 destpage => $destpage,
1422 content => $content,
1430 our $preprocess_preview=0;
1431 sub preprocess ($$$;$$) {
1432 my $page=shift; # the page the data comes from
1433 my $destpage=shift; # the page the data will appear in (different for inline)
1438 # Using local because it needs to be set within any nested calls
1440 local $preprocess_preview=$preview if defined $preview;
1447 $params="" if ! defined $params;
1449 if (length $escape) {
1450 return "[[$prefix$command $params]]";
1452 elsif (exists $hooks{preprocess}{$command}) {
1453 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1454 # Note: preserve order of params, some plugins may
1455 # consider it significant.
1457 while ($params =~ m{
1458 (?:([-.\w]+)=)? # 1: named parameter key?
1460 """(.*?)""" # 2: triple-quoted value
1462 "([^"]*?)" # 3: single-quoted value
1464 '''(.*?)''' # 4: triple-single-quote
1466 <<([a-zA-Z]+)\n # 5: heredoc start
1467 (.*?)\n\5 # 6: heredoc value
1469 (\S+) # 7: unquoted value
1471 (?:\s+|$) # delimiter to next param
1481 elsif (defined $3) {
1484 elsif (defined $4) {
1487 elsif (defined $7) {
1490 elsif (defined $6) {
1495 push @params, $key, $val;
1498 push @params, $val, '';
1501 if ($preprocessing{$page}++ > 3) {
1502 # Avoid loops of preprocessed pages preprocessing
1503 # other pages that preprocess them, etc.
1504 return "[[!$command <span class=\"error\">".
1505 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1506 $page, $preprocessing{$page}).
1512 $hooks{preprocess}{$command}{call}->(
1515 destpage => $destpage,
1516 preview => $preprocess_preview,
1522 $ret="[[!$command <span class=\"error\">".
1523 gettext("Error").": $error"."</span>]]";
1527 # use void context during scan pass
1529 $hooks{preprocess}{$command}{call}->(
1532 destpage => $destpage,
1533 preview => $preprocess_preview,
1538 $preprocessing{$page}--;
1542 return "[[$prefix$command $params]]";
1547 if ($config{prefix_directives}) {
1550 \[\[(!) # directive open; 2: prefix
1551 ([-\w]+) # 3: command
1552 ( # 4: the parameters..
1553 \s+ # Must have space if parameters present
1555 (?:[-.\w]+=)? # named parameter key?
1557 """.*?""" # triple-quoted value
1559 "[^"]*?" # single-quoted value
1561 '''.*?''' # triple-single-quote
1563 <<([a-zA-Z]+)\n # 5: heredoc start
1564 (?:.*?)\n\5 # heredoc value
1566 [^"\s\]]+ # unquoted value
1568 \s* # whitespace or end
1571 *)? # 0 or more parameters
1572 \]\] # directive closed
1578 \[\[(!?) # directive open; 2: optional prefix
1579 ([-\w]+) # 3: command
1581 ( # 4: the parameters..
1583 (?:[-.\w]+=)? # named parameter key?
1585 """.*?""" # triple-quoted value
1587 "[^"]*?" # single-quoted value
1589 '''.*?''' # triple-single-quote
1591 <<([a-zA-Z]+)\n # 5: heredoc start
1592 (?:.*?)\n\5 # heredoc value
1594 [^"\s\]]+ # unquoted value
1596 \s* # whitespace or end
1599 *) # 0 or more parameters
1600 \]\] # directive closed
1604 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1613 run_hooks(filter => sub {
1614 $content=shift->(page => $page, destpage => $destpage,
1615 content => $content);
1621 sub check_canedit ($$$;$) {
1628 run_hooks(canedit => sub {
1629 return if defined $canedit;
1630 my $ret=shift->($page, $q, $session);
1635 elsif (ref $ret eq 'CODE') {
1636 $ret->() unless $nonfatal;
1639 elsif (defined $ret) {
1640 error($ret) unless $nonfatal;
1645 return defined $canedit ? $canedit : 1;
1648 sub check_content (@) {
1651 return 1 if ! exists $hooks{checkcontent}; # optimisation
1653 if (exists $pagesources{$params{page}}) {
1655 my %old=map { $_ => 1 }
1656 split("\n", readfile(srcfile($pagesources{$params{page}})));
1657 foreach my $line (split("\n", $params{content})) {
1658 push @diff, $line if ! exists $old{$line};
1660 $params{diff}=join("\n", @diff);
1664 run_hooks(checkcontent => sub {
1665 return if defined $ok;
1666 my $ret=shift->(%params);
1671 elsif (ref $ret eq 'CODE') {
1672 $ret->() unless $params{nonfatal};
1675 elsif (defined $ret) {
1676 error($ret) unless $params{nonfatal};
1682 return defined $ok ? $ok : 1;
1685 sub check_canchange (@) {
1687 my $cgi = $params{cgi};
1688 my $session = $params{session};
1689 my @changes = @{$params{changes}};
1692 foreach my $change (@changes) {
1693 # This untaint is safe because we check file_pruned and
1695 my ($file)=$change->{file}=~/$config{wiki_file_regexp}/;
1696 $file=possibly_foolish_untaint($file);
1697 if (! defined $file || ! length $file ||
1698 file_pruned($file)) {
1699 error(gettext("bad file name %s"), $file);
1702 my $type=pagetype($file);
1703 my $page=pagename($file) if defined $type;
1705 if ($change->{action} eq 'add') {
1709 if ($change->{action} eq 'change' ||
1710 $change->{action} eq 'add') {
1711 if (defined $page) {
1712 check_canedit($page, $cgi, $session);
1716 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
1717 IkiWiki::Plugin::attachment::check_canattach($session, $file, $change->{path});
1718 check_canedit($file, $cgi, $session);
1723 elsif ($change->{action} eq 'remove') {
1724 # check_canremove tests to see if the file is present
1725 # on disk. This will fail when a single commit adds a
1726 # file and then removes it again. Avoid the problem
1727 # by not testing the removal in such pairs of changes.
1728 # (The add is still tested, just to make sure that
1729 # no data is added to the repo that a web edit
1731 next if $newfiles{$file};
1733 if (IkiWiki::Plugin::remove->can("check_canremove")) {
1734 IkiWiki::Plugin::remove::check_canremove(defined $page ? $page : $file, $cgi, $session);
1735 check_canedit(defined $page ? $page : $file, $cgi, $session);
1740 error "unknown action ".$change->{action};
1743 error sprintf(gettext("you are not allowed to change %s"), $file);
1751 # Take an exclusive lock on the wiki to prevent multiple concurrent
1752 # run issues. The lock will be dropped on program exit.
1753 if (! -d $config{wikistatedir}) {
1754 mkdir($config{wikistatedir});
1756 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1757 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1758 if (! flock($wikilock, 2)) { # LOCK_EX
1759 error("failed to get lock");
1765 POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1766 return close($wikilock) if $wikilock;
1772 sub commit_hook_enabled () {
1773 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1774 error("cannot write to $config{wikistatedir}/commitlock: $!");
1775 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1776 close($commitlock) || error("failed closing commitlock: $!");
1779 close($commitlock) || error("failed closing commitlock: $!");
1783 sub disable_commit_hook () {
1784 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1785 error("cannot write to $config{wikistatedir}/commitlock: $!");
1786 if (! flock($commitlock, 2)) { # LOCK_EX
1787 error("failed to get commit lock");
1792 sub enable_commit_hook () {
1793 return close($commitlock) if $commitlock;
1798 %oldrenderedfiles=%pagectime=();
1799 my $rebuild=$config{rebuild};
1801 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1802 %destsources=%renderedfiles=%pagecase=%pagestate=
1803 %depends_simple=%typedlinks=%oldtypedlinks=();
1806 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1807 if (-e "$config{wikistatedir}/index") {
1808 system("ikiwiki-transition", "indexdb", $config{srcdir});
1809 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1812 $config{gettime}=1; # first build
1817 my $index=Storable::fd_retrieve($in);
1818 if (! defined $index) {
1823 if (exists $index->{version} && ! ref $index->{version}) {
1824 $pages=$index->{page};
1825 %wikistate=%{$index->{state}};
1826 # Handle plugins that got disabled by loading a new setup.
1827 if (exists $config{setupfile}) {
1828 require IkiWiki::Setup;
1829 IkiWiki::Setup::disabled_plugins(
1830 grep { ! $loaded_plugins{$_} } keys %wikistate);
1838 foreach my $src (keys %$pages) {
1839 my $d=$pages->{$src};
1841 if (exists $d->{page} && ! $rebuild) {
1845 $page=pagename($src);
1847 $pagectime{$page}=$d->{ctime};
1848 $pagesources{$page}=$src;
1850 $pagemtime{$page}=$d->{mtime};
1851 $renderedfiles{$page}=$d->{dest};
1852 if (exists $d->{links} && ref $d->{links}) {
1853 $links{$page}=$d->{links};
1854 $oldlinks{$page}=[@{$d->{links}}];
1856 if (ref $d->{depends_simple} eq 'ARRAY') {
1858 $depends_simple{$page}={
1859 map { $_ => 1 } @{$d->{depends_simple}}
1862 elsif (exists $d->{depends_simple}) {
1863 $depends_simple{$page}=$d->{depends_simple};
1865 if (exists $d->{dependslist}) {
1868 map { $_ => $DEPEND_CONTENT }
1869 @{$d->{dependslist}}
1872 elsif (exists $d->{depends} && ! ref $d->{depends}) {
1874 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
1876 elsif (exists $d->{depends}) {
1877 $depends{$page}=$d->{depends};
1879 if (exists $d->{state}) {
1880 $pagestate{$page}=$d->{state};
1882 if (exists $d->{typedlinks}) {
1883 $typedlinks{$page}=$d->{typedlinks};
1885 while (my ($type, $links) = each %{$typedlinks{$page}}) {
1886 next unless %$links;
1887 $oldtypedlinks{$page}{$type} = {%$links};
1891 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1893 foreach my $page (keys %pagesources) {
1894 $pagecase{lc $page}=$page;
1896 foreach my $page (keys %renderedfiles) {
1897 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1899 $lastrev=$index->{lastrev};
1900 @underlayfiles=@{$index->{underlayfiles}} if ref $index->{underlayfiles};
1905 run_hooks(savestate => sub { shift->() });
1907 my @plugins=keys %loaded_plugins;
1909 if (! -d $config{wikistatedir}) {
1910 mkdir($config{wikistatedir});
1912 my $newfile="$config{wikistatedir}/indexdb.new";
1913 my $cleanup = sub { unlink($newfile) };
1914 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1917 foreach my $page (keys %pagemtime) {
1918 next unless $pagemtime{$page};
1919 my $src=$pagesources{$page};
1921 $index{page}{$src}={
1923 ctime => $pagectime{$page},
1924 mtime => $pagemtime{$page},
1925 dest => $renderedfiles{$page},
1926 links => $links{$page},
1929 if (exists $depends{$page}) {
1930 $index{page}{$src}{depends} = $depends{$page};
1933 if (exists $depends_simple{$page}) {
1934 $index{page}{$src}{depends_simple} = $depends_simple{$page};
1937 if (exists $typedlinks{$page} && %{$typedlinks{$page}}) {
1938 $index{page}{$src}{typedlinks} = $typedlinks{$page};
1941 if (exists $pagestate{$page}) {
1942 $index{page}{$src}{state}=$pagestate{$page};
1947 foreach my $id (@plugins) {
1948 $index{state}{$id}={}; # used to detect disabled plugins
1949 foreach my $key (keys %{$wikistate{$id}}) {
1950 $index{state}{$id}{$key}=$wikistate{$id}{$key};
1954 $index{lastrev}=$lastrev;
1955 $index{underlayfiles}=\@underlayfiles;
1957 $index{version}="3";
1958 my $ret=Storable::nstore_fd(\%index, $out);
1959 return if ! defined $ret || ! $ret;
1960 close $out || error("failed saving to $newfile: $!", $cleanup);
1961 rename($newfile, "$config{wikistatedir}/indexdb") ||
1962 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1967 sub template_file ($) {
1970 my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
1972 if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
1973 $template=srcfile($pagesources{$tpage}, 1);
1977 $template=srcfile($tpage, 1);
1980 if (defined $template) {
1981 return $template, $tpage, 1 if wantarray;
1985 $name=~s:/::; # avoid path traversal
1986 foreach my $dir ($config{templatedir},
1987 "$installdir/share/ikiwiki/templates") {
1988 if (-e "$dir/$name") {
1989 $template="$dir/$name";
1993 if (defined $template) {
1994 return $template, $tpage if wantarray;
2002 sub template_depends ($$;@) {
2006 my ($filename, $tpage, $untrusted)=template_file($name);
2007 if (! defined $filename) {
2008 error(sprintf(gettext("template %s not found"), $name))
2011 if (defined $page && defined $tpage) {
2012 add_depends($page, $tpage);
2017 my $text_ref = shift;
2018 ${$text_ref} = decode_utf8(${$text_ref});
2020 loop_context_vars => 1,
2021 die_on_bad_params => 0,
2022 parent_global_vars => 1,
2023 filename => $filename,
2025 ($untrusted ? (no_includes => 1) : ()),
2027 return @opts if wantarray;
2029 require HTML::Template;
2030 return HTML::Template->new(@opts);
2033 sub template ($;@) {
2034 template_depends(shift, undef, @_);
2037 sub templateactions ($$) {
2043 run_hooks(pageactions => sub {
2044 push @actions, map { { action => $_ } }
2045 grep { defined } shift->(page => $page);
2047 $template->param(actions => \@actions);
2049 if ($config{cgiurl} && exists $hooks{auth}) {
2050 $template->param(prefsurl => cgiurl(do => "prefs"));
2054 if ($have_actions || @actions) {
2055 $template->param(have_actions => 1);
2062 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
2063 error 'hook requires type, call, and id parameters';
2066 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
2068 $hooks{$param{type}}{$param{id}}=\%param;
2072 sub run_hooks ($$) {
2073 # Calls the given sub for each hook of the given type,
2074 # passing it the hook function to call.
2078 if (exists $hooks{$type}) {
2079 my (@first, @middle, @last);
2080 foreach my $id (keys %{$hooks{$type}}) {
2081 if ($hooks{$type}{$id}{first}) {
2084 elsif ($hooks{$type}{$id}{last}) {
2091 foreach my $id (@first, @middle, @last) {
2092 $sub->($hooks{$type}{$id}{call});
2100 $hooks{rcs}{rcs_update}{call}->(@_);
2103 sub rcs_prepedit ($) {
2104 $hooks{rcs}{rcs_prepedit}{call}->(@_);
2107 sub rcs_commit (@) {
2108 $hooks{rcs}{rcs_commit}{call}->(@_);
2111 sub rcs_commit_staged (@) {
2112 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
2116 $hooks{rcs}{rcs_add}{call}->(@_);
2119 sub rcs_remove ($) {
2120 $hooks{rcs}{rcs_remove}{call}->(@_);
2123 sub rcs_rename ($$) {
2124 $hooks{rcs}{rcs_rename}{call}->(@_);
2127 sub rcs_recentchanges ($) {
2128 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
2131 sub rcs_diff ($;$) {
2132 $hooks{rcs}{rcs_diff}{call}->(@_);
2135 sub rcs_getctime ($) {
2136 $hooks{rcs}{rcs_getctime}{call}->(@_);
2139 sub rcs_getmtime ($) {
2140 $hooks{rcs}{rcs_getmtime}{call}->(@_);
2143 sub rcs_receive () {
2144 $hooks{rcs}{rcs_receive}{call}->();
2147 sub add_depends ($$;$) {
2150 my $deptype=shift || $DEPEND_CONTENT;
2152 # Is the pagespec a simple page name?
2153 if ($pagespec =~ /$config{wiki_file_regexp}/ &&
2154 $pagespec !~ /[\s*?()!]/) {
2155 $depends_simple{$page}{lc $pagespec} |= $deptype;
2159 # Add explicit dependencies for influences.
2160 my $sub=pagespec_translate($pagespec);
2161 return unless defined $sub;
2162 foreach my $p (keys %pagesources) {
2163 my $r=$sub->($p, location => $page);
2164 my $i=$r->influences;
2165 my $static=$r->influences_static;
2166 foreach my $k (keys %$i) {
2167 next unless $r || $static || $k eq $page;
2168 $depends_simple{$page}{lc $k} |= $i->{$k};
2173 $depends{$page}{$pagespec} |= $deptype;
2179 foreach my $type (@_) {
2180 if ($type eq 'presence') {
2181 $deptype |= $DEPEND_PRESENCE;
2183 elsif ($type eq 'links') {
2184 $deptype |= $DEPEND_LINKS;
2186 elsif ($type eq 'content') {
2187 $deptype |= $DEPEND_CONTENT;
2193 my $file_prune_regexp;
2194 sub file_pruned ($) {
2197 if (defined $config{include} && length $config{include}) {
2198 return 0 if $file =~ m/$config{include}/;
2201 if (! defined $file_prune_regexp) {
2202 $file_prune_regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
2203 $file_prune_regexp=qr/$file_prune_regexp/;
2205 return $file =~ m/$file_prune_regexp/;
2208 sub define_gettext () {
2209 # If translation is needed, redefine the gettext function to do it.
2210 # Otherwise, it becomes a quick no-op.
2213 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
2214 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
2215 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
2217 $gettext_obj=eval q{
2218 use Locale::gettext q{textdomain};
2219 Locale::gettext->domain('ikiwiki')
2224 no warnings 'redefine';
2226 $getobj->() if $getobj;
2228 $gettext_obj->get(shift);
2235 $getobj->() if $getobj;
2237 $gettext_obj->nget(@_);
2240 return ($_[2] == 1 ? $_[0] : $_[1])
2258 return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
2262 # Injects a new function into the symbol table to replace an
2263 # exported function.
2266 # This is deep ugly perl foo, beware.
2269 if (! defined $params{parent}) {
2270 $params{parent}='::';
2271 $params{old}=\&{$params{name}};
2272 $params{name}=~s/.*:://;
2274 my $parent=$params{parent};
2275 foreach my $ns (grep /^\w+::/, keys %{$parent}) {
2276 $ns = $params{parent} . $ns;
2277 inject(%params, parent => $ns) unless $ns eq '::main::';
2278 *{$ns . $params{name}} = $params{call}
2279 if exists ${$ns}{$params{name}} &&
2280 \&{${$ns}{$params{name}}} == $params{old};
2286 sub add_link ($$;$) {
2291 push @{$links{$page}}, $link
2292 unless grep { $_ eq $link } @{$links{$page}};
2294 if (defined $type) {
2295 $typedlinks{$page}{$type}{$link} = 1;
2299 sub add_autofile ($$$) {
2302 my $generator=shift;
2304 $autofiles{$file}{plugin}=$plugin;
2305 $autofiles{$file}{generator}=$generator;
2309 return LWP::UserAgent->new(
2310 cookie_jar => $config{cookiejar},
2311 env_proxy => 1, # respect proxy env vars
2312 agent => $config{useragent},
2316 sub sortspec_translate ($$) {
2318 my $reverse = shift;
2324 (-?) # group 1: perhaps negated
2327 \w+\([^\)]*\) # command(params)
2329 [^\s]+ # or anything else
2337 if ($word =~ m/^(\w+)\((.*)\)$/) {
2338 # command with parameters
2342 elsif ($word !~ m/^\w+$/) {
2343 error(sprintf(gettext("invalid sort type %s"), $word));
2354 if (exists $IkiWiki::SortSpec::{"cmp_$word"}) {
2355 if (defined $params) {
2356 push @data, $params;
2357 $code .= "IkiWiki::SortSpec::cmp_$word(\$data[$#data])";
2360 $code .= "IkiWiki::SortSpec::cmp_$word(undef)";
2364 error(sprintf(gettext("unknown sort type %s"), $word));
2368 if (! length $code) {
2369 # undefined sorting method... sort arbitrarily
2378 return eval 'sub { '.$code.' }';
2381 sub pagespec_translate ($) {
2384 # Convert spec to perl code.
2388 \s* # ignore whitespace
2389 ( # 1: match a single word
2396 \w+\([^\)]*\) # command(params)
2398 [^\s()]+ # any other text
2400 \s* # ignore whitespace
2403 if (lc $word eq 'and') {
2406 elsif (lc $word eq 'or') {
2409 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
2412 elsif ($word =~ /^(\w+)\((.*)\)$/) {
2413 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
2415 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
2418 push @data, qq{unknown function in pagespec "$word"};
2419 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
2424 $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
2428 if (! length $code) {
2429 $code="IkiWiki::FailReason->new('empty pagespec')";
2433 return eval 'sub { my $page=shift; '.$code.' }';
2436 sub pagespec_match ($$;@) {
2441 # Backwards compatability with old calling convention.
2443 unshift @params, 'location';
2446 my $sub=pagespec_translate($spec);
2447 return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
2449 return $sub->($page, @params);
2452 sub pagespec_match_list ($$;@) {
2457 # Backwards compatability with old calling convention.
2459 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
2460 $params{list}=$page;
2461 $page=$params{location}; # ugh!
2464 my $sub=pagespec_translate($pagespec);
2465 error "syntax error in pagespec \"$pagespec\""
2467 my $sort=sortspec_translate($params{sort}, $params{reverse})
2468 if defined $params{sort};
2471 if (exists $params{list}) {
2472 @candidates=exists $params{filter}
2473 ? grep { ! $params{filter}->($_) } @{$params{list}}
2477 @candidates=exists $params{filter}
2478 ? grep { ! $params{filter}->($_) } keys %pagesources
2479 : keys %pagesources;
2482 # clear params, remainder is passed to pagespec
2483 $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2484 my $num=$params{num};
2485 delete @params{qw{num deptype reverse sort filter list}};
2487 # when only the top matches will be returned, it's efficient to
2488 # sort before matching to pagespec,
2489 if (defined $num && defined $sort) {
2490 @candidates=IkiWiki::SortSpec::sort_pages(
2491 $sort, @candidates);
2497 my $accum=IkiWiki::SuccessReason->new();
2498 foreach my $p (@candidates) {
2499 my $r=$sub->($p, %params, location => $page);
2500 error(sprintf(gettext("cannot match pages: %s"), $r))
2501 if $r->isa("IkiWiki::ErrorReason");
2502 unless ($r || $r->influences_static) {
2503 $r->remove_influence($p);
2508 last if defined $num && ++$count == $num;
2512 # Add simple dependencies for accumulated influences.
2513 my $i=$accum->influences;
2514 foreach my $k (keys %$i) {
2515 $depends_simple{$page}{lc $k} |= $i->{$k};
2518 # when all matches will be returned, it's efficient to
2519 # sort after matching
2520 if (! defined $num && defined $sort) {
2521 return IkiWiki::SortSpec::sort_pages(
2529 sub pagespec_valid ($) {
2532 return defined pagespec_translate($spec);
2536 my $re=quotemeta(shift);
2542 package IkiWiki::FailReason;
2545 '""' => sub { $_[0][0] },
2547 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2548 '&' => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2549 '|' => sub { $_[1]->merge_influences($_[0]); $_[1] },
2553 our @ISA = 'IkiWiki::SuccessReason';
2555 package IkiWiki::SuccessReason;
2558 '""' => sub { $_[0][0] },
2560 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
2561 '&' => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2562 '|' => sub { $_[0]->merge_influences($_[1]); $_[0] },
2569 return bless [$value, {@_}], $class;
2574 $this->[1]={@_} if @_;
2575 my %i=%{$this->[1]};
2580 sub influences_static {
2581 return ! $_[0][1]->{""};
2584 sub merge_influences {
2589 if (! $anded || (($this || %{$this->[1]}) &&
2590 ($other || %{$other->[1]}))) {
2591 foreach my $influence (keys %{$other->[1]}) {
2592 $this->[1]{$influence} |= $other->[1]{$influence};
2601 sub remove_influence {
2605 delete $this->[1]{$torm};
2608 package IkiWiki::ErrorReason;
2610 our @ISA = 'IkiWiki::FailReason';
2612 package IkiWiki::PageSpec;
2618 if ($path =~ m!^\.(/|$)!) {
2620 $from=~s#/?[^/]+$## if defined $from;
2622 $path="$from/$path" if defined $from && length $from;
2626 $path = "" unless defined $path;
2635 sub match_glob ($$;@) {
2640 $glob=derel($glob, $params{location});
2642 # Instead of converting the glob to a regex every time,
2643 # cache the compiled regex to save time.
2644 my $re=$glob_cache{$glob};
2645 unless (defined $re) {
2646 $glob_cache{$glob} = $re = IkiWiki::glob2re($glob);
2649 if (! IkiWiki::isinternal($page) || $params{internal}) {
2650 return IkiWiki::SuccessReason->new("$glob matches $page");
2653 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2657 return IkiWiki::FailReason->new("$glob does not match $page");
2661 sub match_internal ($$;@) {
2662 return match_glob(shift, shift, @_, internal => 1)
2665 sub match_page ($$;@) {
2667 my $match=match_glob($page, shift, @_);
2669 my $source=exists $IkiWiki::pagesources{$page} ?
2670 $IkiWiki::pagesources{$page} :
2671 $IkiWiki::delpagesources{$page};
2672 my $type=defined $source ? IkiWiki::pagetype($source) : undef;
2673 if (! defined $type) {
2674 return IkiWiki::FailReason->new("$page is not a page");
2680 sub match_link ($$;@) {
2685 $link=derel($link, $params{location});
2686 my $from=exists $params{location} ? $params{location} : '';
2687 my $linktype=$params{linktype};
2689 if (defined $linktype) {
2690 $qualifier=" with type $linktype";
2693 my $links = $IkiWiki::links{$page};
2694 return IkiWiki::FailReason->new("$page has no links", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2695 unless $links && @{$links};
2696 my $bestlink = IkiWiki::bestlink($from, $link);
2697 foreach my $p (@{$links}) {
2698 next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
2700 if (length $bestlink) {
2701 if ($bestlink eq IkiWiki::bestlink($page, $p)) {
2702 return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2706 if (match_glob($p, $link, %params)) {
2707 return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2709 my ($p_rel)=$p=~/^\/?(.*)/;
2711 if (match_glob($p_rel, $link, %params)) {
2712 return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2716 return IkiWiki::FailReason->new("$page does not link to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1);
2719 sub match_backlink ($$;@) {
2723 if ($testpage eq '.') {
2724 $testpage = $params{'location'}
2726 my $ret=match_link($testpage, $page, @_);
2727 $ret->influences($testpage => $IkiWiki::DEPEND_LINKS);
2731 sub match_created_before ($$;@) {
2736 $testpage=derel($testpage, $params{location});
2738 if (exists $IkiWiki::pagectime{$testpage}) {
2739 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2740 return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2743 return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2747 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2751 sub match_created_after ($$;@) {
2756 $testpage=derel($testpage, $params{location});
2758 if (exists $IkiWiki::pagectime{$testpage}) {
2759 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2760 return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2763 return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2767 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2771 sub match_creation_day ($$;@) {
2774 if ($d !~ /^\d+$/) {
2775 return IkiWiki::ErrorReason->new("invalid day $d");
2777 if ((localtime($IkiWiki::pagectime{$page}))[3] == $d) {
2778 return IkiWiki::SuccessReason->new('creation_day matched');
2781 return IkiWiki::FailReason->new('creation_day did not match');
2785 sub match_creation_month ($$;@) {
2788 if ($m !~ /^\d+$/) {
2789 return IkiWiki::ErrorReason->new("invalid month $m");
2791 if ((localtime($IkiWiki::pagectime{$page}))[4] + 1 == $m) {
2792 return IkiWiki::SuccessReason->new('creation_month matched');
2795 return IkiWiki::FailReason->new('creation_month did not match');
2799 sub match_creation_year ($$;@) {
2802 if ($y !~ /^\d+$/) {
2803 return IkiWiki::ErrorReason->new("invalid year $y");
2805 if ((localtime($IkiWiki::pagectime{$page}))[5] + 1900 == $y) {
2806 return IkiWiki::SuccessReason->new('creation_year matched');
2809 return IkiWiki::FailReason->new('creation_year did not match');
2813 sub match_user ($$;@) {
2818 if (! exists $params{user}) {
2819 return IkiWiki::ErrorReason->new("no user specified");
2822 my $regexp=IkiWiki::glob2re($user);
2824 if (defined $params{user} && $params{user}=~$regexp) {
2825 return IkiWiki::SuccessReason->new("user is $user");
2827 elsif (! defined $params{user}) {
2828 return IkiWiki::FailReason->new("not logged in");
2831 return IkiWiki::FailReason->new("user is $params{user}, not $user");
2835 sub match_admin ($$;@) {
2840 if (! exists $params{user}) {
2841 return IkiWiki::ErrorReason->new("no user specified");
2844 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
2845 return IkiWiki::SuccessReason->new("user is an admin");
2847 elsif (! defined $params{user}) {
2848 return IkiWiki::FailReason->new("not logged in");
2851 return IkiWiki::FailReason->new("user is not an admin");
2855 sub match_ip ($$;@) {
2860 if (! exists $params{ip}) {
2861 return IkiWiki::ErrorReason->new("no IP specified");
2864 my $regexp=IkiWiki::glob2re(lc $ip);
2866 if (defined $params{ip} && lc $params{ip}=~$regexp) {
2867 return IkiWiki::SuccessReason->new("IP is $ip");
2870 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
2874 package IkiWiki::SortSpec;
2876 # This is in the SortSpec namespace so that the $a and $b that sort() uses
2877 # are easily available in this namespace, for cmp functions to use them.
2884 IkiWiki::pagetitle(IkiWiki::basename($a))
2886 IkiWiki::pagetitle(IkiWiki::basename($b))
2889 sub cmp_path { IkiWiki::pagetitle($a) cmp IkiWiki::pagetitle($b) }
2890 sub cmp_mtime { $IkiWiki::pagemtime{$b} <=> $IkiWiki::pagemtime{$a} }
2891 sub cmp_age { $IkiWiki::pagectime{$b} <=> $IkiWiki::pagectime{$a} }