9 use URI::Escape q{uri_escape_utf8};
12 use open qw{:utf8 :std};
14 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
15 %pagestate %wikistate %renderedfiles %oldrenderedfiles
16 %pagesources %delpagesources %destsources %depends %depends_simple
17 @mass_depends %hooks %forcerebuild %loaded_plugins %typedlinks
18 %oldtypedlinks %autofiles @underlayfiles $lastrev $phase};
20 use Exporter q{import};
21 our @EXPORT = qw(hook debug error htmlpage template template_depends
22 deptype add_depends pagespec_match pagespec_match_list bestlink
23 htmllink readfile writefile pagetype srcfile pagename
24 displaytime strftime_utf8 will_render gettext ngettext urlto targetpage
25 add_underlay pagetitle titlepage linkpage newpagefile
26 inject add_link add_autofile useragent
27 %config %links %pagestate %wikistate %renderedfiles
28 %pagesources %destsources %typedlinks);
29 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
30 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
31 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
33 # Page dependency types.
34 our $DEPEND_CONTENT=1;
35 our $DEPEND_PRESENCE=2;
38 # Phases of processing.
39 sub PHASE_SCAN () { 0 }
40 sub PHASE_RENDER () { 1 }
46 memoize("sortspec_translate");
47 memoize("pagespec_translate");
48 memoize("template_file");
54 description => "name of the wiki",
61 example => 'me@example.com',
62 description => "contact email for wiki",
69 description => "users who are wiki admins",
76 description => "users who are banned from the wiki",
83 example => "$ENV{HOME}/wiki",
84 description => "where the source of the wiki is located",
91 example => "/var/www/wiki",
92 description => "where to build the wiki",
99 example => "http://example.com/wiki",
100 description => "base url to the wiki",
107 example => "http://example.com/wiki/ikiwiki.cgi",
108 description => "url to the ikiwiki.cgi",
115 description => "do not adjust cgiurl if CGI is accessed via different URL",
118 rebuild => 0, # only affects CGI requests
123 example => "/var/www/wiki/ikiwiki.cgi",
124 description => "filename of cgi wrapper to generate",
131 description => "mode for cgi_wrapper (can safely be made suid)",
135 cgi_overload_delay => {
139 description => "number of seconds to delay CGI requests when overloaded",
143 cgi_overload_message => {
146 example => "Please wait",
147 description => "message to display when overloaded (may contain html)",
151 only_committed_changes => {
154 description => "enable optimization of only refreshing committed changes?",
161 description => "rcs backend to use",
162 safe => 0, # don't allow overriding
167 default => [qw{mdwn link inline meta htmlscrubber passwordauth
168 openid emailauth signinedit lockedit conditional
169 recentchanges parentlinks editpage
171 description => "plugins to enable by default",
178 description => "plugins to add to the default configuration",
185 description => "plugins to disable",
191 default => "$installdir/share/ikiwiki/templates",
192 description => "additional directory to search for template files",
199 default => "$installdir/share/ikiwiki/basewiki",
200 description => "base wiki source location",
207 default => "$installdir/share/ikiwiki",
208 description => "parent directory containing additional underlays",
215 description => "wrappers to generate",
222 description => "additional underlays to use",
229 description => "display verbose messages?",
236 description => "log to syslog?",
243 description => "create output files named page/index.html?",
244 safe => 0, # changing requires manual transition
247 prefix_directives => {
250 description => "use '!'-prefixed preprocessor directives?",
251 safe => 0, # changing requires manual transition
257 description => "use page/index.mdwn source files",
264 description => "enable Discussion pages?",
270 default => gettext("Discussion"),
271 description => "name of Discussion pages",
278 description => "use elements new in HTML5 like <section>?",
286 description => "only send cookies over SSL connections?",
294 description => "extension to use for new pages",
295 safe => 0, # not sanitized
301 description => "extension to use for html files",
302 safe => 0, # not sanitized
308 description => "strftime format string to display date",
316 example => "en_US.UTF-8",
317 description => "UTF-8 locale to use",
326 description => "put user pages below specified page",
333 description => "how many backlinks to show before hiding excess (0 to show all)",
340 description => "attempt to hardlink source files? (optimisation for large files)",
342 safe => 0, # paranoia
348 description => "force ikiwiki to use a particular umask (keywords public, group or private, or a number)",
350 safe => 0, # paranoia
355 example => "ikiwiki",
356 description => "group for wrappers to run in",
358 safe => 0, # paranoia
364 example => ["$ENV{HOME}/.local/share/ikiwiki"],
365 description => "extra library and plugin directories",
367 safe => 0, # directory
373 example => "$ENV{HOME}/.ikiwiki/",
374 description => "extra library and plugin directory (searched after libdirs)",
376 safe => 0, # directory
382 description => "environment variables",
383 safe => 0, # paranoia
389 example => "US/Eastern",
390 description => "time zone name",
397 example => '^\.htaccess$',
398 description => "regexp of normally excluded files to include",
406 example => '^(*\.private|Makefile)$',
407 description => "regexp of files that should be skipped",
412 wiki_file_prune_regexps => {
414 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\//, qr/^\./, qr/\/\./,
415 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
416 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
417 qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
418 qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
419 description => "regexps of source files to ignore",
425 description => "specifies the characters that are allowed in source filenames",
426 default => "-[:alnum:]+/.:_",
430 wiki_file_regexp => {
432 description => "regexp of legal source files",
436 web_commit_regexp => {
438 default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
439 description => "regexp to parse web commits from logs",
446 description => "run as a cgi",
450 cgi_disable_uploads => {
453 description => "whether CGI should accept file uploads",
460 description => "run as a post-commit hook",
467 description => "running in rebuild mode",
474 description => "running in setup mode",
481 description => "running in clean mode",
488 description => "running in refresh mode",
495 description => "running in receive test mode",
499 wrapper_background_command => {
502 description => "background shell command to run",
508 description => "running in gettime mode",
515 description => "running in w3mmode",
522 description => "path to the .ikiwiki directory holding ikiwiki state",
529 description => "path to setup file",
536 description => "perl class to use to dump setup file",
540 allow_symlinks_before_srcdir => {
543 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
549 default => { file => "$ENV{HOME}/.ikiwiki/cookies" },
550 description => "cookie control",
551 safe => 0, # hooks into perl module internals
556 default => "ikiwiki/$version",
557 example => "Wget/1.13.4 (linux-gnu)",
558 description => "set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds",
562 responsive_layout => {
565 description => "theme has a responsive layout? (mobile-optimized)",
573 if ($config{libdirs}) {
574 @libdirs = @{$config{libdirs}};
576 if (length $config{libdir}) {
577 push @libdirs, $config{libdir};
582 sub defaultconfig () {
585 foreach my $key (keys %s) {
586 push @ret, $key, $s{$key}->{default};
591 # URL to top of wiki as a path starting with /, valid from any wiki page or
592 # the CGI; if that's not possible, an absolute URL. Either way, it ends with /
594 # URL to CGI script, similar to $local_url
598 # locale stuff; avoid LC_ALL since it overrides everything
599 if (defined $ENV{LC_ALL}) {
600 $ENV{LANG} = $ENV{LC_ALL};
603 if (defined $config{locale}) {
604 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
605 $ENV{LANG}=$config{locale};
610 if (! defined $config{wiki_file_regexp}) {
611 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
614 if (ref $config{ENV} eq 'HASH') {
615 foreach my $val (keys %{$config{ENV}}) {
616 $ENV{$val}=$config{ENV}{$val};
619 if (defined $config{timezone} && length $config{timezone}) {
620 $ENV{TZ}=$config{timezone};
622 elsif (defined $ENV{TZ} && length $ENV{TZ}) {
623 $config{timezone}=$ENV{TZ};
626 eval q{use Config qw()};
629 if ($Config::Config{d_gnulibc} && -e '/etc/localtime') {
630 $config{timezone}=$ENV{TZ}=':/etc/localtime';
633 $config{timezone}=$ENV{TZ}='GMT';
637 if ($config{w3mmode}) {
638 eval q{use Cwd q{abs_path}};
640 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
641 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
642 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
643 unless $config{cgiurl} =~ m!file:///!;
644 $config{url}="file://".$config{destdir};
647 if ($config{cgi} && ! length $config{url}) {
648 error(gettext("Must specify url to wiki with --url when using --cgi"));
651 if (defined $config{url} && length $config{url}) {
653 my $baseurl = URI->new($config{url});
655 $local_url = $baseurl->path . "/";
656 $local_cgiurl = undef;
658 if (length $config{cgiurl}) {
659 my $cgiurl = URI->new($config{cgiurl});
661 $local_cgiurl = $cgiurl->path;
663 if ($cgiurl->scheme eq 'https' &&
664 $baseurl->scheme eq 'http') {
665 # We assume that the same content is available
666 # over both http and https, because if it
667 # wasn't, accessing the static content
668 # from the CGI would be mixed-content,
669 # which would be a security flaw.
671 if ($cgiurl->authority ne $baseurl->authority) {
672 # use protocol-relative URL for
674 $local_url = "$config{url}/";
675 $local_url =~ s{^http://}{//};
677 # else use host-relative URL for static content
679 # either way, CGI needs to be absolute
680 $local_cgiurl = $config{cgiurl};
682 elsif ($cgiurl->scheme ne $baseurl->scheme) {
683 # too far apart, fall back to absolute URLs
684 $local_url = "$config{url}/";
685 $local_cgiurl = $config{cgiurl};
687 elsif ($cgiurl->authority ne $baseurl->authority) {
688 # slightly too far apart, fall back to
689 # protocol-relative URLs
690 $local_url = "$config{url}/";
691 $local_url =~ s{^https?://}{//};
692 $local_cgiurl = $config{cgiurl};
693 $local_cgiurl =~ s{^https?://}{//};
695 # else keep host-relative URLs
698 $local_url =~ s{//$}{/};
701 $local_cgiurl = $config{cgiurl};
704 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
705 unless exists $config{wikistatedir} && defined $config{wikistatedir};
707 if (defined $config{umask}) {
708 my $u = possibly_foolish_untaint($config{umask});
710 if ($u =~ m/^\d+$/) {
713 elsif ($u eq 'private') {
716 elsif ($u eq 'group') {
719 elsif ($u eq 'public') {
723 error(sprintf(gettext("unsupported umask setting %s"), $u));
727 run_hooks(checkconfig => sub { shift->() });
735 foreach my $dir (@INC, getlibdirs()) {
736 next unless defined $dir && length $dir;
737 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
738 my ($plugin)=$file=~/.*\/(.*)\.pm$/;
742 foreach my $dir (getlibdirs(), "$installdir/lib/ikiwiki") {
743 next unless defined $dir && length $dir;
744 foreach my $file (glob("$dir/plugins/*")) {
745 $ret{basename($file)}=1 if -x $file;
753 foreach my $dir (getlibdirs()) {
754 unshift @INC, possibly_foolish_untaint($dir);
757 foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
762 if (exists $hooks{rcs}) {
763 error(gettext("cannot use multiple rcs plugins"));
765 loadplugin($config{rcs});
767 if (! exists $hooks{rcs}) {
771 run_hooks(getopt => sub { shift->() });
772 if (grep /^-/, @ARGV) {
773 print STDERR "Unknown option (or missing parameter): $_\n"
774 foreach grep /^-/, @ARGV;
781 sub loadplugin ($;$) {
785 return if ! $force && grep { $_ eq $plugin} @{$config{disable_plugins}};
787 foreach my $possiblytainteddir (getlibdirs(), "$installdir/lib/ikiwiki") {
788 my $dir = possibly_foolish_untaint($possiblytainteddir);
789 if (defined $dir && -x "$dir/plugins/$plugin") {
790 eval { require IkiWiki::Plugin::external };
793 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
795 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
796 $loaded_plugins{$plugin}=1;
801 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
804 error("Failed to load plugin $mod: $@");
806 $loaded_plugins{$plugin}=1;
813 log_message('err' => $message) if $config{syslog};
814 if (defined $cleaner) {
821 return unless $config{verbose};
822 return log_message(debug => @_);
827 sub log_message ($$) {
830 if ($config{syslog}) {
833 Sys::Syslog::setlogsock('unix');
834 Sys::Syslog::openlog('ikiwiki', '', 'user');
838 # keep a copy to avoid editing the original config repeatedly
839 my $wikiname = $config{wikiname};
840 utf8::encode($wikiname);
841 Sys::Syslog::syslog($type, "[$wikiname] %s", join(" ", @_));
844 print STDERR "failed to syslog: $@" unless $log_failed;
850 elsif (! $config{cgi}) {
854 return print STDERR "@_\n";
858 sub possibly_foolish_untaint ($) {
860 my ($untainted)=$tainted=~/(.*)/s;
880 return exists $pagesources{$page} &&
881 $pagesources{$page} =~ /\._([^.]+)$/;
887 if ($file =~ /\.([^.]+)$/) {
888 return $1 if exists $hooks{htmlize}{$1};
890 my $base=basename($file);
891 if (exists $hooks{htmlize}{$base} &&
892 $hooks{htmlize}{$base}{noextension}) {
903 if (exists $pagename_cache{$file}) {
904 return $pagename_cache{$file};
907 my $type=pagetype($file);
909 $page=~s/\Q.$type\E*$//
910 if defined $type && !$hooks{htmlize}{$type}{keepextension}
911 && !$hooks{htmlize}{$type}{noextension};
912 if ($config{indexpages} && $page=~/(.*)\/index$/) {
916 $pagename_cache{$file} = $page;
920 sub newpagefile ($$) {
924 if (! $config{indexpages} || $page eq 'index') {
925 return $page.".".$type;
928 return $page."/index.".$type;
932 sub targetpage ($$;$) {
937 if (defined $filename) {
938 return $page."/".$filename.".".$ext;
940 elsif (! $config{usedirs} || $page eq 'index') {
941 return $page.".".$ext;
944 return $page."/index.".$ext;
951 return targetpage($page, $config{htmlext});
958 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
959 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
960 return "$dir/$file", stat(_) if -e "$dir/$file";
962 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
967 return (srcfile_stat(@_))[0];
970 sub add_literal_underlay ($) {
973 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
974 unshift @{$config{underlaydirs}}, $dir;
978 sub add_underlay ($) {
982 $dir="$config{underlaydirbase}/$dir";
985 add_literal_underlay($dir);
986 # why does it return 1? we just don't know
990 sub readfile ($;$$) {
996 error("cannot read a symlink ($file)");
1000 open (my $in, "<", $file) || error("failed to read $file: $!");
1001 binmode($in) if ($binary);
1002 return \*$in if $wantfd;
1004 # check for invalid utf-8, and toss it back to avoid crashes
1005 if (! utf8::valid($ret)) {
1006 $ret=encode_utf8($ret);
1008 close $in || error("failed to read $file: $!");
1012 sub prep_writefile ($$) {
1017 while (length $test) {
1018 if (-l "$destdir/$test") {
1019 error("cannot write to a symlink ($test)");
1021 if (-f _ && $test ne $file) {
1022 # Remove conflicting file.
1023 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1024 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1026 unlink("$destdir/$test");
1032 $test=dirname($test);
1035 my $dir=dirname("$destdir/$file");
1038 foreach my $s (split(m!/+!, $dir)) {
1041 mkdir($d) || error("failed to create directory $d: $!");
1049 sub writefile ($$$;$$) {
1050 my $file=shift; # can include subdirs
1051 my $destdir=shift; # directory to put file in
1056 prep_writefile($file, $destdir);
1058 my $newfile="$destdir/$file.ikiwiki-new";
1060 error("cannot write to a symlink ($newfile)");
1063 my $cleanup = sub { unlink($newfile) };
1064 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
1065 binmode($out) if ($binary);
1067 $writer->(\*$out, $cleanup);
1070 print $out $content or error("failed writing to $newfile: $!", $cleanup);
1072 close $out || error("failed saving $newfile: $!", $cleanup);
1073 rename($newfile, "$destdir/$file") ||
1074 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
1080 sub will_render ($$;$) {
1085 # Important security check for independently created files.
1086 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
1087 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
1088 my $from_other_page=0;
1089 # Expensive, but rarely runs.
1090 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1093 dirname($_) eq $dest
1094 } @{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1100 error("$config{destdir}/$dest independently created, not overwriting with version from $page")
1101 unless $from_other_page;
1104 # If $dest exists as a directory, remove conflicting files in it
1105 # rendered from other pages.
1107 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1108 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1109 if (dirname($f) eq $dest) {
1110 unlink("$config{destdir}/$f");
1111 rmdir(dirname("$config{destdir}/$f"));
1117 if (! $clear || $cleared{$page}) {
1118 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
1121 foreach my $old (@{$renderedfiles{$page}}) {
1122 delete $destsources{$old};
1124 $renderedfiles{$page}=[$dest];
1127 $destsources{$dest}=$page;
1137 if ($link=~s/^\/+//) {
1145 $l.="/" if length $l;
1148 if (exists $pagesources{$l}) {
1151 elsif (exists $pagecase{lc $l}) {
1152 return $pagecase{lc $l};
1154 } while $cwd=~s{/?[^/]+$}{};
1156 if (length $config{userdir}) {
1157 my $l = "$config{userdir}/".lc($link);
1158 if (exists $pagesources{$l}) {
1161 elsif (exists $pagecase{lc $l}) {
1162 return $pagecase{lc $l};
1166 #print STDERR "warning: page $page, broken link: $link\n";
1170 sub isinlinableimage ($) {
1173 return $file =~ /\.(png|gif|jpg|jpeg|svg)$/i;
1176 sub pagetitle ($;$) {
1178 my $unescaped=shift;
1181 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
1184 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
1192 # support use w/o %config set
1193 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1194 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1200 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1201 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1208 my $cgiurl=$local_cgiurl;
1210 if (exists $params{cgiurl}) {
1211 $cgiurl=$params{cgiurl};
1212 delete $params{cgiurl};
1220 join("&", map $_."=".uri_escape_utf8($params{$_}), keys %params);
1223 sub cgiurl_abs (@) {
1225 URI->new_abs(cgiurl(@_), $config{cgiurl});
1231 return $local_url if ! defined $page;
1233 $page=htmlpage($page);
1235 $page=~s/[^\/]+\//..\//g;
1243 return $url unless defined $urlbase && length $urlbase;
1246 URI->new_abs($url, $urlbase)->as_string;
1250 # Work around very innefficient behavior in File::Spec if abs2rel
1251 # is passed two relative paths. It's much faster if paths are
1252 # absolute! (Debian bug #376658; fixed in debian unstable now)
1257 my $ret=File::Spec->abs2rel($path, $base);
1258 $ret=~s/^// if defined $ret;
1262 sub displaytime ($;$$) {
1263 # Plugins can override this function to mark up the time to
1265 my $time=formattime($_[0], $_[1]);
1266 if ($config{html5}) {
1267 return '<time datetime="'.date_3339($_[0]).'"'.
1268 ($_[2] ? ' pubdate="pubdate"' : '').
1269 '>'.$time.'</time>';
1272 return '<span class="date">'.$time.'</span>';
1276 sub formattime ($;$) {
1277 # Plugins can override this function to format the time.
1280 if (! defined $format) {
1281 $format=$config{timeformat};
1284 return strftime_utf8($format, localtime($time));
1287 my $strftime_encoding;
1289 # strftime doesn't know about encodings, so make sure
1290 # its output is properly treated as utf8.
1291 # Note that this does not handle utf-8 in the format string.
1292 ($strftime_encoding) = POSIX::setlocale(&POSIX::LC_TIME) =~ m#\.([^@]+)#
1293 unless defined $strftime_encoding;
1295 ? Encode::decode($strftime_encoding, POSIX::strftime(@_))
1296 : POSIX::strftime(@_);
1302 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
1303 POSIX::setlocale(&POSIX::LC_TIME, "C");
1304 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
1305 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
1309 sub beautify_urlpath ($) {
1312 # Ensure url is not an empty link, and if necessary,
1313 # add ./ to avoid colon confusion.
1314 if ($url !~ /^\// && $url !~ /^\.\.?\//) {
1318 if ($config{usedirs}) {
1319 $url =~ s!/index.$config{htmlext}$!/!;
1334 if (! $destsources{$to}) {
1339 return $config{url}.beautify_urlpath("/".$to);
1342 if (! defined $from) {
1343 my $u = $local_url || '';
1345 return $u.beautify_urlpath("/".$to);
1348 my $link = abs2rel($to, dirname(htmlpage($from)));
1350 return beautify_urlpath($link);
1353 sub isselflink ($$) {
1354 # Plugins can override this function to support special types
1359 return $page eq $link;
1362 sub htmllink ($$$;@) {
1363 my $lpage=shift; # the page doing the linking
1364 my $page=shift; # the page that will contain the link (different for inline)
1371 if (! $opts{forcesubpage}) {
1372 $bestlink=bestlink($lpage, $link);
1375 $bestlink="$lpage/".lc($link);
1379 if (defined $opts{linktext}) {
1380 $linktext=$opts{linktext};
1383 $linktext=pagetitle(basename($link));
1386 return "<span class=\"selflink\">$linktext</span>"
1387 if length $bestlink && isselflink($page, $bestlink) &&
1388 ! defined $opts{anchor};
1390 if (! $destsources{$bestlink}) {
1391 $bestlink=htmlpage($bestlink);
1393 if (! $destsources{$bestlink}) {
1395 if (length $config{cgiurl}) {
1396 $cgilink = "<a href=\"".
1401 )."\" rel=\"nofollow\">?</a>";
1403 return "<span class=\"createlink\">$cgilink$linktext</span>"
1407 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1408 $bestlink=beautify_urlpath($bestlink);
1410 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1411 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1414 if (defined $opts{anchor}) {
1415 $bestlink.="#".$opts{anchor};
1419 foreach my $attr (qw{rel class title}) {
1420 if (defined $opts{$attr}) {
1421 push @attrs, " $attr=\"$opts{$attr}\"";
1425 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1430 return length $config{userdir} ? "$config{userdir}/$user" : $user;
1433 # Username to display for openid accounts.
1434 sub openiduser ($) {
1437 if (defined $user && $user =~ m!^https?://! &&
1438 eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1441 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1442 $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1445 # backcompat with old version
1446 my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1447 $display=$oid->display;
1450 # Convert "user.somehost.com" to "user [somehost.com]"
1451 # (also "user.somehost.co.uk")
1452 if ($display !~ /\[/) {
1453 $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1455 # Convert "http://somehost.com/user" to "user [somehost.com]".
1456 # (also "https://somehost.com/user/")
1457 if ($display !~ /\[/) {
1458 $display=~s/^https?:\/\/(.+)\/([^\/#?]+)\/?(?:[#?].*)?$/$2 [$1]/;
1460 $display=~s!^https?://!!; # make sure this is removed
1461 eval q{use CGI 'escapeHTML'};
1463 return escapeHTML($display);
1468 # Username to display for emailauth accounts.
1471 if (defined $user && $user =~ m/(.+)@/) {
1473 # remove any characters from not allowed in wiki files
1474 $nick=~s/[^$config{wiki_file_chars}]/_/g;
1480 # Some user information should not be exposed in commit metadata, etc.
1481 # This generates a cloaked form of such information.
1484 # cloak email address using http://xmlns.com/foaf/spec/#term_mbox_sha1sum
1485 if ($user=~m/(.+)@/) {
1487 eval q{use Digest::SHA};
1489 return $nick.'@'.Digest::SHA::sha1_hex("mailto:$user");
1496 sub htmlize ($$$$) {
1502 my $oneline = $content !~ /\n/;
1504 if (exists $hooks{htmlize}{$type}) {
1505 $content=$hooks{htmlize}{$type}{call}->(
1507 content => $content,
1511 error("htmlization of $type not supported");
1514 run_hooks(sanitize => sub {
1517 destpage => $destpage,
1518 content => $content,
1523 # hack to get rid of enclosing junk added by markdown
1524 # and other htmlizers/sanitizers
1525 $content=~s/^<p>//i;
1526 $content=~s/<\/p>\n*$//i;
1537 run_hooks(linkify => sub {
1540 destpage => $destpage,
1541 content => $content,
1549 our $preprocess_preview=0;
1550 sub preprocess ($$$;$$) {
1551 my $page=shift; # the page the data comes from
1552 my $destpage=shift; # the page the data will appear in (different for inline)
1557 # Using local because it needs to be set within any nested calls
1559 local $preprocess_preview=$preview if defined $preview;
1566 $params="" if ! defined $params;
1568 if (length $escape) {
1569 return "[[$prefix$command $params]]";
1571 elsif (exists $hooks{preprocess}{$command}) {
1572 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1573 # Note: preserve order of params, some plugins may
1574 # consider it significant.
1576 while ($params =~ m{
1577 (?:([-.\w]+)=)? # 1: named parameter key?
1579 """(.*?)""" # 2: triple-quoted value
1581 "([^"]*?)" # 3: single-quoted value
1583 '''(.*?)''' # 4: triple-single-quote
1585 <<([a-zA-Z]+)\n # 5: heredoc start
1586 (.*?)\n\5 # 6: heredoc value
1588 (\S+) # 7: unquoted value
1590 (?:\s+|$) # delimiter to next param
1600 elsif (defined $3) {
1603 elsif (defined $4) {
1606 elsif (defined $7) {
1609 elsif (defined $6) {
1614 push @params, $key, $val;
1617 push @params, $val, '';
1620 if ($preprocessing{$page}++ > 8) {
1621 # Avoid loops of preprocessed pages preprocessing
1622 # other pages that preprocess them, etc.
1623 return "[[!$command <span class=\"error\">".
1624 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1625 $page, $preprocessing{$page}).
1631 $hooks{preprocess}{$command}{call}->(
1634 destpage => $destpage,
1635 preview => $preprocess_preview,
1641 $ret="[[!$command <span class=\"error\">".
1642 gettext("Error").": $error"."</span>]]";
1646 # use void context during scan pass
1648 $hooks{preprocess}{$command}{call}->(
1651 destpage => $destpage,
1652 preview => $preprocess_preview,
1657 $preprocessing{$page}--;
1661 return "[[$prefix$command $params]]";
1666 if ($config{prefix_directives}) {
1669 \[\[(!) # directive open; 2: prefix
1670 ([-\w]+) # 3: command
1671 ( # 4: the parameters..
1672 \s+ # Must have space if parameters present
1674 (?:[-.\w]+=)? # named parameter key?
1676 """.*?""" # triple-quoted value
1678 "[^"]*?" # single-quoted value
1680 '''.*?''' # triple-single-quote
1682 <<([a-zA-Z]+)\n # 5: heredoc start
1683 (?:.*?)\n\5 # heredoc value
1685 [^"\s\]]+ # unquoted value
1687 \s* # whitespace or end
1690 *)? # 0 or more parameters
1691 \]\] # directive closed
1697 \[\[(!?) # directive open; 2: optional prefix
1698 ([-\w]+) # 3: command
1700 ( # 4: the parameters..
1702 (?:[-.\w]+=)? # named parameter key?
1704 """.*?""" # triple-quoted value
1706 "[^"]*?" # single-quoted value
1708 '''.*?''' # triple-single-quote
1710 <<([a-zA-Z]+)\n # 5: heredoc start
1711 (?:.*?)\n\5 # heredoc value
1713 [^"\s\]]+ # unquoted value
1715 \s* # whitespace or end
1718 *) # 0 or more parameters
1719 \]\] # directive closed
1723 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1732 run_hooks(filter => sub {
1733 $content=shift->(page => $page, destpage => $destpage,
1734 content => $content);
1740 sub check_canedit ($$$;$) {
1747 run_hooks(canedit => sub {
1748 return if defined $canedit;
1749 my $ret=shift->($page, $q, $session);
1754 elsif (ref $ret eq 'CODE') {
1755 $ret->() unless $nonfatal;
1758 elsif (defined $ret) {
1759 error($ret) unless $nonfatal;
1764 return defined $canedit ? $canedit : 1;
1767 sub check_content (@) {
1770 return 1 if ! exists $hooks{checkcontent}; # optimisation
1772 if (exists $pagesources{$params{page}}) {
1774 my %old=map { $_ => 1 }
1775 split("\n", readfile(srcfile($pagesources{$params{page}})));
1776 foreach my $line (split("\n", $params{content})) {
1777 push @diff, $line if ! exists $old{$line};
1779 $params{diff}=join("\n", @diff);
1783 run_hooks(checkcontent => sub {
1784 return if defined $ok;
1785 my $ret=shift->(%params);
1790 elsif (ref $ret eq 'CODE') {
1791 $ret->() unless $params{nonfatal};
1794 elsif (defined $ret) {
1795 error($ret) unless $params{nonfatal};
1801 return defined $ok ? $ok : 1;
1804 sub check_canchange (@) {
1806 my $cgi = $params{cgi};
1807 my $session = $params{session};
1808 my @changes = @{$params{changes}};
1811 foreach my $change (@changes) {
1812 # This untaint is safe because we check file_pruned and
1814 my ($file)=$change->{file}=~/$config{wiki_file_regexp}/;
1815 $file=possibly_foolish_untaint($file);
1816 if (! defined $file || ! length $file ||
1817 file_pruned($file)) {
1818 error(gettext("bad file name %s"), $file);
1821 my $type=pagetype($file);
1822 my $page=pagename($file) if defined $type;
1824 if ($change->{action} eq 'add') {
1828 if ($change->{action} eq 'change' ||
1829 $change->{action} eq 'add') {
1830 if (defined $page) {
1831 check_canedit($page, $cgi, $session);
1835 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
1836 IkiWiki::Plugin::attachment::check_canattach($session, $file, $change->{path});
1837 check_canedit($file, $cgi, $session);
1842 elsif ($change->{action} eq 'remove') {
1843 # check_canremove tests to see if the file is present
1844 # on disk. This will fail when a single commit adds a
1845 # file and then removes it again. Avoid the problem
1846 # by not testing the removal in such pairs of changes.
1847 # (The add is still tested, just to make sure that
1848 # no data is added to the repo that a web edit
1850 next if $newfiles{$file};
1852 if (IkiWiki::Plugin::remove->can("check_canremove")) {
1853 IkiWiki::Plugin::remove::check_canremove(defined $page ? $page : $file, $cgi, $session);
1854 check_canedit(defined $page ? $page : $file, $cgi, $session);
1859 error "unknown action ".$change->{action};
1862 error sprintf(gettext("you are not allowed to change %s"), $file);
1870 # Take an exclusive lock on the wiki to prevent multiple concurrent
1871 # run issues. The lock will be dropped on program exit.
1872 if (! -d $config{wikistatedir}) {
1873 mkdir($config{wikistatedir});
1875 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1876 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1877 if (! flock($wikilock, LOCK_EX | LOCK_NB)) {
1878 debug("failed to get lock; waiting...");
1879 if (! flock($wikilock, LOCK_EX)) {
1880 error("failed to get lock");
1887 POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1888 return close($wikilock) if $wikilock;
1894 sub commit_hook_enabled () {
1895 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1896 error("cannot write to $config{wikistatedir}/commitlock: $!");
1897 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1898 close($commitlock) || error("failed closing commitlock: $!");
1901 close($commitlock) || error("failed closing commitlock: $!");
1905 sub disable_commit_hook () {
1906 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1907 error("cannot write to $config{wikistatedir}/commitlock: $!");
1908 if (! flock($commitlock, 2)) { # LOCK_EX
1909 error("failed to get commit lock");
1914 sub enable_commit_hook () {
1915 return close($commitlock) if $commitlock;
1920 %oldrenderedfiles=%pagectime=();
1921 my $rebuild=$config{rebuild};
1923 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1924 %destsources=%renderedfiles=%pagecase=%pagestate=
1925 %depends_simple=%typedlinks=%oldtypedlinks=();
1928 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1929 if (-e "$config{wikistatedir}/index") {
1930 system("ikiwiki-transition", "indexdb", $config{srcdir});
1931 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1934 # gettime on first build
1935 $config{gettime}=1 unless defined $config{gettime};
1940 my $index=Storable::fd_retrieve($in);
1941 if (! defined $index) {
1946 if (exists $index->{version} && ! ref $index->{version}) {
1947 $pages=$index->{page};
1948 %wikistate=%{$index->{state}};
1949 # Handle plugins that got disabled by loading a new setup.
1950 if (exists $config{setupfile}) {
1951 require IkiWiki::Setup;
1952 IkiWiki::Setup::disabled_plugins(
1953 grep { ! $loaded_plugins{$_} } keys %wikistate);
1961 foreach my $src (keys %$pages) {
1962 my $d=$pages->{$src};
1964 if (exists $d->{page} && ! $rebuild) {
1968 $page=pagename($src);
1970 $pagectime{$page}=$d->{ctime};
1971 $pagesources{$page}=$src;
1973 $pagemtime{$page}=$d->{mtime};
1974 $renderedfiles{$page}=$d->{dest};
1975 if (exists $d->{links} && ref $d->{links}) {
1976 $links{$page}=$d->{links};
1977 $oldlinks{$page}=[@{$d->{links}}];
1979 if (ref $d->{depends_simple} eq 'ARRAY') {
1981 $depends_simple{$page}={
1982 map { $_ => 1 } @{$d->{depends_simple}}
1985 elsif (exists $d->{depends_simple}) {
1986 $depends_simple{$page}=$d->{depends_simple};
1988 if (exists $d->{dependslist}) {
1991 map { $_ => $DEPEND_CONTENT }
1992 @{$d->{dependslist}}
1995 elsif (exists $d->{depends} && ! ref $d->{depends}) {
1997 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
1999 elsif (exists $d->{depends}) {
2000 $depends{$page}=$d->{depends};
2002 if (exists $d->{state}) {
2003 $pagestate{$page}=$d->{state};
2005 if (exists $d->{typedlinks}) {
2006 $typedlinks{$page}=$d->{typedlinks};
2008 while (my ($type, $links) = each %{$typedlinks{$page}}) {
2009 next unless %$links;
2010 $oldtypedlinks{$page}{$type} = {%$links};
2014 $oldrenderedfiles{$page}=[@{$d->{dest}}];
2016 foreach my $page (keys %pagesources) {
2017 $pagecase{lc $page}=$page;
2019 foreach my $page (keys %renderedfiles) {
2020 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
2022 $lastrev=$index->{lastrev};
2023 @underlayfiles=@{$index->{underlayfiles}} if ref $index->{underlayfiles};
2028 run_hooks(savestate => sub { shift->() });
2030 my @plugins=keys %loaded_plugins;
2032 if (! -d $config{wikistatedir}) {
2033 mkdir($config{wikistatedir});
2035 my $newfile="$config{wikistatedir}/indexdb.new";
2036 my $cleanup = sub { unlink($newfile) };
2037 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
2040 foreach my $page (keys %pagemtime) {
2041 next unless $pagemtime{$page};
2042 my $src=$pagesources{$page};
2044 $index{page}{$src}={
2046 ctime => $pagectime{$page},
2047 mtime => $pagemtime{$page},
2048 dest => $renderedfiles{$page},
2049 links => $links{$page},
2052 if (exists $depends{$page}) {
2053 $index{page}{$src}{depends} = $depends{$page};
2056 if (exists $depends_simple{$page}) {
2057 $index{page}{$src}{depends_simple} = $depends_simple{$page};
2060 if (exists $typedlinks{$page} && %{$typedlinks{$page}}) {
2061 $index{page}{$src}{typedlinks} = $typedlinks{$page};
2064 if (exists $pagestate{$page}) {
2065 $index{page}{$src}{state}=$pagestate{$page};
2070 foreach my $id (@plugins) {
2071 $index{state}{$id}={}; # used to detect disabled plugins
2072 foreach my $key (keys %{$wikistate{$id}}) {
2073 $index{state}{$id}{$key}=$wikistate{$id}{$key};
2077 $index{lastrev}=$lastrev;
2078 $index{underlayfiles}=\@underlayfiles;
2080 $index{version}="3";
2081 my $ret=Storable::nstore_fd(\%index, $out);
2082 return if ! defined $ret || ! $ret;
2083 close $out || error("failed saving to $newfile: $!", $cleanup);
2084 rename($newfile, "$config{wikistatedir}/indexdb") ||
2085 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
2090 sub template_file ($) {
2093 my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
2095 if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
2096 $template=srcfile($pagesources{$tpage}, 1);
2100 $template=srcfile($tpage, 1);
2103 if (defined $template) {
2104 return $template, $tpage, 1 if wantarray;
2108 $name=~s:/::; # avoid path traversal
2109 foreach my $dir ($config{templatedir},
2110 "$installdir/share/ikiwiki/templates") {
2111 if (-e "$dir/$name") {
2112 $template="$dir/$name";
2116 if (defined $template) {
2117 return $template, $tpage if wantarray;
2125 sub template_depends ($$;@) {
2129 my ($filename, $tpage, $untrusted)=template_file($name);
2130 if (! defined $filename) {
2131 error(sprintf(gettext("template %s not found"), $name))
2134 if (defined $page && defined $tpage) {
2135 add_depends($page, $tpage);
2140 my $text_ref = shift;
2141 ${$text_ref} = decode_utf8(${$text_ref});
2142 run_hooks(readtemplate => sub {
2143 ${$text_ref} = shift->(
2146 content => ${$text_ref},
2147 untrusted => $untrusted,
2151 loop_context_vars => 1,
2152 die_on_bad_params => 0,
2153 parent_global_vars => 1,
2154 filename => $filename,
2156 ($untrusted ? (no_includes => 1) : ()),
2158 return @opts if wantarray;
2160 require HTML::Template;
2161 return HTML::Template->new(@opts);
2164 sub template ($;@) {
2165 template_depends(shift, undef, @_);
2168 sub templateactions ($$) {
2174 run_hooks(pageactions => sub {
2175 push @actions, map { { action => $_ } }
2176 grep { defined } shift->(page => $page);
2178 $template->param(actions => \@actions);
2180 if ($config{cgiurl} && exists $hooks{auth}) {
2181 $template->param(prefsurl => cgiurl(do => "prefs"));
2185 if ($have_actions || @actions) {
2186 $template->param(have_actions => 1);
2193 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
2194 error 'hook requires type, call, and id parameters';
2197 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
2199 $hooks{$param{type}}{$param{id}}=\%param;
2203 sub run_hooks ($$) {
2204 # Calls the given sub for each hook of the given type,
2205 # passing it the hook function to call.
2209 if (exists $hooks{$type}) {
2210 my (@first, @middle, @last);
2211 foreach my $id (keys %{$hooks{$type}}) {
2212 if ($hooks{$type}{$id}{first}) {
2215 elsif ($hooks{$type}{$id}{last}) {
2222 foreach my $id (@first, @middle, @last) {
2223 $sub->($hooks{$type}{$id}{call});
2231 $hooks{rcs}{rcs_update}{call}->(@_);
2234 sub rcs_prepedit ($) {
2235 $hooks{rcs}{rcs_prepedit}{call}->(@_);
2238 sub rcs_commit (@) {
2239 $hooks{rcs}{rcs_commit}{call}->(@_);
2242 sub rcs_commit_staged (@) {
2243 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
2247 $hooks{rcs}{rcs_add}{call}->(@_);
2250 sub rcs_remove ($) {
2251 $hooks{rcs}{rcs_remove}{call}->(@_);
2254 sub rcs_rename ($$) {
2255 $hooks{rcs}{rcs_rename}{call}->(@_);
2258 sub rcs_recentchanges ($) {
2259 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
2262 sub rcs_diff ($;$) {
2263 $hooks{rcs}{rcs_diff}{call}->(@_);
2266 sub rcs_getctime ($) {
2267 $hooks{rcs}{rcs_getctime}{call}->(@_);
2270 sub rcs_getmtime ($) {
2271 $hooks{rcs}{rcs_getmtime}{call}->(@_);
2274 sub rcs_receive () {
2275 $hooks{rcs}{rcs_receive}{call}->();
2278 sub add_depends ($$;$) {
2281 my $deptype=shift || $DEPEND_CONTENT;
2283 # Is the pagespec a simple page name?
2284 if ($pagespec =~ /$config{wiki_file_regexp}/ &&
2285 $pagespec !~ /[\s*?()!]/) {
2286 $depends_simple{$page}{lc $pagespec} |= $deptype;
2290 # Add explicit dependencies for influences.
2291 my $sub=pagespec_translate($pagespec);
2292 return unless defined $sub;
2293 foreach my $p (keys %pagesources) {
2294 my $r=$sub->($p, location => $page);
2295 my $i=$r->influences;
2296 my $static=$r->influences_static;
2297 foreach my $k (keys %$i) {
2298 next unless $r || $static || $k eq $page;
2299 $depends_simple{$page}{lc $k} |= $i->{$k};
2304 $depends{$page}{$pagespec} |= $deptype;
2310 foreach my $type (@_) {
2311 if ($type eq 'presence') {
2312 $deptype |= $DEPEND_PRESENCE;
2314 elsif ($type eq 'links') {
2315 $deptype |= $DEPEND_LINKS;
2317 elsif ($type eq 'content') {
2318 $deptype |= $DEPEND_CONTENT;
2324 my $file_prune_regexp;
2325 sub file_pruned ($) {
2328 if (defined $config{include} && length $config{include}) {
2329 return 0 if $file =~ m/$config{include}/;
2332 if (! defined $file_prune_regexp) {
2333 $file_prune_regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
2334 $file_prune_regexp=qr/$file_prune_regexp/;
2336 return $file =~ m/$file_prune_regexp/;
2339 sub define_gettext () {
2340 # If translation is needed, redefine the gettext function to do it.
2341 # Otherwise, it becomes a quick no-op.
2344 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
2345 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
2346 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
2348 $gettext_obj=eval q{
2349 use Locale::gettext q{textdomain};
2350 Locale::gettext->domain('ikiwiki')
2355 no warnings 'redefine';
2357 $getobj->() if $getobj;
2359 $gettext_obj->get(shift);
2366 $getobj->() if $getobj;
2368 $gettext_obj->nget(@_);
2371 return ($_[2] == 1 ? $_[0] : $_[1])
2389 return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
2393 # Injects a new function into the symbol table to replace an
2394 # exported function.
2397 # This is deep ugly perl foo, beware.
2400 if (! defined $params{parent}) {
2401 $params{parent}='::';
2402 $params{old}=\&{$params{name}};
2403 $params{name}=~s/.*:://;
2405 my $parent=$params{parent};
2406 foreach my $ns (grep /^\w+::/, keys %{$parent}) {
2407 $ns = $params{parent} . $ns;
2408 inject(%params, parent => $ns) unless $ns eq '::main::';
2409 *{$ns . $params{name}} = $params{call}
2410 if exists ${$ns}{$params{name}} &&
2411 \&{${$ns}{$params{name}}} == $params{old};
2417 sub add_link ($$;$) {
2422 push @{$links{$page}}, $link
2423 unless grep { $_ eq $link } @{$links{$page}};
2425 if (defined $type) {
2426 $typedlinks{$page}{$type}{$link} = 1;
2430 sub add_autofile ($$$) {
2433 my $generator=shift;
2435 $autofiles{$file}{plugin}=$plugin;
2436 $autofiles{$file}{generator}=$generator;
2440 return LWP::UserAgent->new(
2441 cookie_jar => $config{cookiejar},
2442 env_proxy => 1, # respect proxy env vars
2443 agent => $config{useragent},
2447 sub sortspec_translate ($$) {
2449 my $reverse = shift;
2455 (-?) # group 1: perhaps negated
2458 \w+\([^\)]*\) # command(params)
2460 [^\s]+ # or anything else
2468 if ($word =~ m/^(\w+)\((.*)\)$/) {
2469 # command with parameters
2473 elsif ($word !~ m/^\w+$/) {
2474 error(sprintf(gettext("invalid sort type %s"), $word));
2485 if (exists $IkiWiki::SortSpec::{"cmp_$word"}) {
2486 if (defined $params) {
2487 push @data, $params;
2488 $code .= "IkiWiki::SortSpec::cmp_$word(\$data[$#data])";
2491 $code .= "IkiWiki::SortSpec::cmp_$word(undef)";
2495 error(sprintf(gettext("unknown sort type %s"), $word));
2499 if (! length $code) {
2500 # undefined sorting method... sort arbitrarily
2509 return eval 'sub { '.$code.' }';
2512 sub pagespec_translate ($) {
2515 # Convert spec to perl code.
2519 \s* # ignore whitespace
2520 ( # 1: match a single word
2527 \w+\([^\)]*\) # command(params)
2529 [^\s()]+ # any other text
2531 \s* # ignore whitespace
2534 if (lc $word eq 'and') {
2537 elsif (lc $word eq 'or') {
2540 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
2543 elsif ($word =~ /^(\w+)\((.*)\)$/) {
2544 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
2546 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
2549 push @data, qq{unknown function in pagespec "$word"};
2550 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
2555 $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
2559 if (! length $code) {
2560 $code="IkiWiki::FailReason->new('empty pagespec')";
2564 return eval 'sub { my $page=shift; '.$code.' }';
2567 sub pagespec_match ($$;@) {
2572 # Backwards compatability with old calling convention.
2574 unshift @params, 'location';
2577 my $sub=pagespec_translate($spec);
2578 return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
2580 return $sub->($page, @params);
2583 # e.g. @pages = sort_pages("title", \@pages, reverse => "yes")
2585 # Not exported yet, but could be in future if it is generally useful.
2586 # Note that this signature is not the same as IkiWiki::SortSpec::sort_pages,
2587 # which is "more internal".
2588 sub sort_pages ($$;@) {
2592 $sort = sortspec_translate($sort, $params{reverse});
2593 return IkiWiki::SortSpec::sort_pages($sort, @$list);
2596 sub pagespec_match_list ($$;@) {
2601 # Backwards compatability with old calling convention.
2603 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
2604 $params{list}=$page;
2605 $page=$params{location}; # ugh!
2608 my $sub=pagespec_translate($pagespec);
2609 error "syntax error in pagespec \"$pagespec\""
2611 my $sort=sortspec_translate($params{sort}, $params{reverse})
2612 if defined $params{sort};
2615 if (exists $params{list}) {
2616 @candidates=exists $params{filter}
2617 ? grep { ! $params{filter}->($_) } @{$params{list}}
2621 @candidates=exists $params{filter}
2622 ? grep { ! $params{filter}->($_) } keys %pagesources
2623 : keys %pagesources;
2626 # clear params, remainder is passed to pagespec
2627 $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2628 my $num=$params{num};
2629 delete @params{qw{num deptype reverse sort filter list}};
2631 # when only the top matches will be returned, it's efficient to
2632 # sort before matching to pagespec,
2633 if (defined $num && defined $sort) {
2634 @candidates=IkiWiki::SortSpec::sort_pages(
2635 $sort, @candidates);
2641 my $accum=IkiWiki::SuccessReason->new();
2642 foreach my $p (@candidates) {
2643 my $r=$sub->($p, %params, location => $page);
2644 error(sprintf(gettext("cannot match pages: %s"), $r))
2645 if $r->isa("IkiWiki::ErrorReason");
2646 unless ($r || $r->influences_static) {
2647 $r->remove_influence($p);
2652 last if defined $num && ++$count == $num;
2656 # Add simple dependencies for accumulated influences.
2657 my $i=$accum->influences;
2658 foreach my $k (keys %$i) {
2659 $depends_simple{$page}{lc $k} |= $i->{$k};
2662 # when all matches will be returned, it's efficient to
2663 # sort after matching
2664 if (! defined $num && defined $sort) {
2665 return IkiWiki::SortSpec::sort_pages(
2673 sub pagespec_valid ($) {
2676 return defined pagespec_translate($spec);
2680 my $re=quotemeta(shift);
2686 package IkiWiki::FailReason;
2689 '""' => sub { $_[0][0] },
2691 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2692 '&' => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2693 '|' => sub { $_[1]->merge_influences($_[0]); $_[1] },
2697 our @ISA = 'IkiWiki::SuccessReason';
2699 package IkiWiki::SuccessReason;
2701 # A blessed array-ref:
2703 # [0]: human-readable reason for success (or, in FailReason subclass, failure)
2705 # - if absent or false, the influences of this evaluation are "static",
2706 # see the influences_static method
2707 # - if true, they are dynamic (not static)
2708 # [1]{any other key}:
2709 # the dependency types of influences, as returned by the influences method
2712 # in string context, it's the human-readable reason
2713 '""' => sub { $_[0][0] },
2714 # in boolean context, SuccessReason is 1 and FailReason is 0
2716 # negating a result gives the opposite result with the same influences
2717 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
2718 # A & B = (A ? B : A) with the influences of both
2719 '&' => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2720 # A | B = (A ? A : B) with the influences of both
2721 '|' => sub { $_[0]->merge_influences($_[1]); $_[0] },
2725 # SuccessReason->new("human-readable reason", page => deptype, ...)
2730 return bless [$value, {@_}], $class;
2733 # influences(): return a reference to a copy of the hash
2734 # { page => dependency type } describing the pages that indirectly influenced
2735 # this result, but would not cause a dependency through ikiwiki's core
2738 # See [[todo/dependency_types]] for extensive discussion of what this means.
2740 # influences(page => deptype, ...): remove all influences, replace them
2741 # with the arguments, and return a reference to a copy of the new influences.
2745 $this->[1]={@_} if @_;
2746 my %i=%{$this->[1]};
2751 # True if this result has the same influences whichever page it matches,
2752 # For instance, whether bar matches backlink(foo) is influenced only by
2753 # the set of links in foo, so its only influence is { foo => DEPEND_LINKS },
2754 # which does not mention bar anywhere.
2756 # False if this result would have different influences when matching
2757 # different pages. For instance, when testing whether link(foo) matches bar,
2758 # { bar => DEPEND_LINKS } is an influence on that result, because changing
2759 # bar's links could change the outcome; so its influences are not the same
2760 # as when testing whether link(foo) matches baz.
2762 # Static influences are one of the things that make pagespec_match_list
2763 # more efficient than repeated calls to pagespec_match.
2765 sub influences_static {
2766 return ! $_[0][1]->{""};
2769 # Change the influences of $this to be the influences of "$this & $other"
2770 # or "$this | $other".
2772 # If both $this and $other are either successful or have influences,
2773 # or this is an "or" operation, the result has all the influences from
2774 # either of the arguments. It has dynamic influences if either argument
2775 # has dynamic influences.
2777 # If this is an "and" operation, and at least one argument is a
2778 # FailReason with no influences, the result has no influences, and they
2779 # are not dynamic. For instance, link(foo) matching bar is influenced
2780 # by bar, but enabled(ddate) has no influences. Suppose ddate is disabled;
2781 # then (link(foo) and enabled(ddate)) not matching bar is not influenced by
2782 # bar, because it would be false however often you edit bar.
2784 sub merge_influences {
2789 # This "if" is odd because it needs to avoid negating $this
2790 # or $other, which would alter the objects in-place. Be careful.
2791 if (! $anded || (($this || %{$this->[1]}) &&
2792 ($other || %{$other->[1]}))) {
2793 foreach my $influence (keys %{$other->[1]}) {
2794 $this->[1]{$influence} |= $other->[1]{$influence};
2803 # Change $this so it is not considered to be influenced by $torm.
2805 sub remove_influence {
2809 delete $this->[1]{$torm};
2812 package IkiWiki::ErrorReason;
2814 our @ISA = 'IkiWiki::FailReason';
2816 package IkiWiki::PageSpec;
2822 if ($path =~ m!^\.(/|$)!) {
2824 $from=~s#/?[^/]+$## if defined $from;
2826 $path="$from/$path" if defined $from && length $from;
2830 $path = "" unless defined $path;
2839 sub match_glob ($$;@) {
2844 $glob=derel($glob, $params{location});
2846 # Instead of converting the glob to a regex every time,
2847 # cache the compiled regex to save time.
2848 my $re=$glob_cache{$glob};
2849 unless (defined $re) {
2850 $glob_cache{$glob} = $re = IkiWiki::glob2re($glob);
2853 if (! IkiWiki::isinternal($page) || $params{internal}) {
2854 return IkiWiki::SuccessReason->new("$glob matches $page");
2857 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2861 return IkiWiki::FailReason->new("$glob does not match $page");
2865 sub match_internal ($$;@) {
2866 return match_glob(shift, shift, @_, internal => 1)
2869 sub match_page ($$;@) {
2871 my $match=match_glob($page, shift, @_);
2873 my $source=exists $IkiWiki::pagesources{$page} ?
2874 $IkiWiki::pagesources{$page} :
2875 $IkiWiki::delpagesources{$page};
2876 my $type=defined $source ? IkiWiki::pagetype($source) : undef;
2877 if (! defined $type) {
2878 return IkiWiki::FailReason->new("$page is not a page");
2884 sub match_link ($$;@) {
2889 $link=derel($link, $params{location});
2890 my $from=exists $params{location} ? $params{location} : '';
2891 my $linktype=$params{linktype};
2893 if (defined $linktype) {
2894 $qualifier=" with type $linktype";
2897 my $links = $IkiWiki::links{$page};
2898 return IkiWiki::FailReason->new("$page has no links", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2899 unless $links && @{$links};
2900 my $bestlink = IkiWiki::bestlink($from, $link);
2901 foreach my $p (@{$links}) {
2902 next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
2904 if (length $bestlink) {
2905 if ($bestlink eq IkiWiki::bestlink($page, $p)) {
2906 return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2910 if (match_glob($p, $link, %params)) {
2911 return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2913 my ($p_rel)=$p=~/^\/?(.*)/;
2915 if (match_glob($p_rel, $link, %params)) {
2916 return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2920 return IkiWiki::FailReason->new("$page does not link to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1);
2923 sub match_backlink ($$;@) {
2927 if ($testpage eq '.') {
2928 $testpage = $params{'location'}
2930 my $ret=match_link($testpage, $page, @_);
2931 $ret->influences($testpage => $IkiWiki::DEPEND_LINKS);
2935 sub match_created_before ($$;@) {
2940 $testpage=derel($testpage, $params{location});
2942 if (exists $IkiWiki::pagectime{$testpage}) {
2943 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2944 return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2947 return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2951 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2955 sub match_created_after ($$;@) {
2960 $testpage=derel($testpage, $params{location});
2962 if (exists $IkiWiki::pagectime{$testpage}) {
2963 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2964 return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2967 return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2971 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2975 sub match_creation_day ($$;@) {
2978 if ($d !~ /^\d+$/) {
2979 return IkiWiki::ErrorReason->new("invalid day $d");
2981 if ((localtime($IkiWiki::pagectime{$page}))[3] == $d) {
2982 return IkiWiki::SuccessReason->new('creation_day matched');
2985 return IkiWiki::FailReason->new('creation_day did not match');
2989 sub match_creation_month ($$;@) {
2992 if ($m !~ /^\d+$/) {
2993 return IkiWiki::ErrorReason->new("invalid month $m");
2995 if ((localtime($IkiWiki::pagectime{$page}))[4] + 1 == $m) {
2996 return IkiWiki::SuccessReason->new('creation_month matched');
2999 return IkiWiki::FailReason->new('creation_month did not match');
3003 sub match_creation_year ($$;@) {
3006 if ($y !~ /^\d+$/) {
3007 return IkiWiki::ErrorReason->new("invalid year $y");
3009 if ((localtime($IkiWiki::pagectime{$page}))[5] + 1900 == $y) {
3010 return IkiWiki::SuccessReason->new('creation_year matched');
3013 return IkiWiki::FailReason->new('creation_year did not match');
3017 sub match_user ($$;@) {
3022 if (! exists $params{user}) {
3023 return IkiWiki::ErrorReason->new("no user specified");
3026 my $regexp=IkiWiki::glob2re($user);
3028 if (defined $params{user} && $params{user}=~$regexp) {
3029 return IkiWiki::SuccessReason->new("user is $user");
3031 elsif (! defined $params{user}) {
3032 return IkiWiki::FailReason->new("not logged in");
3035 return IkiWiki::FailReason->new("user is $params{user}, not $user");
3039 sub match_admin ($$;@) {
3044 if (! exists $params{user}) {
3045 return IkiWiki::ErrorReason->new("no user specified");
3048 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
3049 return IkiWiki::SuccessReason->new("user is an admin");
3051 elsif (! defined $params{user}) {
3052 return IkiWiki::FailReason->new("not logged in");
3055 return IkiWiki::FailReason->new("user is not an admin");
3059 sub match_ip ($$;@) {
3064 if (! exists $params{ip}) {
3065 return IkiWiki::ErrorReason->new("no IP specified");
3068 my $regexp=IkiWiki::glob2re(lc $ip);
3070 if (defined $params{ip} && lc $params{ip}=~$regexp) {
3071 return IkiWiki::SuccessReason->new("IP is $ip");
3074 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
3078 package IkiWiki::SortSpec;
3080 # This is in the SortSpec namespace so that the $a and $b that sort() uses
3081 # are easily available in this namespace, for cmp functions to use them.
3088 IkiWiki::pagetitle(IkiWiki::basename($a))
3090 IkiWiki::pagetitle(IkiWiki::basename($b))
3093 sub cmp_path { IkiWiki::pagetitle($a) cmp IkiWiki::pagetitle($b) }
3094 sub cmp_mtime { $IkiWiki::pagemtime{$b} <=> $IkiWiki::pagemtime{$a} }
3095 sub cmp_age { $IkiWiki::pagectime{$b} <=> $IkiWiki::pagectime{$a} }