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 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)",
572 description => "try harder to produce deterministic output",
581 if ($config{libdirs}) {
582 @libdirs = @{$config{libdirs}};
584 if (length $config{libdir}) {
585 push @libdirs, $config{libdir};
590 sub defaultconfig () {
593 foreach my $key (keys %s) {
594 push @ret, $key, $s{$key}->{default};
599 # URL to top of wiki as a path starting with /, valid from any wiki page or
600 # the CGI; if that's not possible, an absolute URL. Either way, it ends with /
602 # URL to CGI script, similar to $local_url
606 # locale stuff; avoid LC_ALL since it overrides everything
607 if (defined $ENV{LC_ALL}) {
608 $ENV{LANG} = $ENV{LC_ALL};
611 if (defined $config{locale}) {
612 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
613 $ENV{LANG}=$config{locale};
618 if (! defined $config{wiki_file_regexp}) {
619 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
622 if (ref $config{ENV} eq 'HASH') {
623 foreach my $val (keys %{$config{ENV}}) {
624 $ENV{$val}=$config{ENV}{$val};
627 if (defined $config{timezone} && length $config{timezone}) {
628 $ENV{TZ}=$config{timezone};
630 elsif (defined $ENV{TZ} && length $ENV{TZ}) {
631 $config{timezone}=$ENV{TZ};
634 eval q{use Config qw()};
637 if ($Config::Config{d_gnulibc} && -e '/etc/localtime') {
638 $config{timezone}=$ENV{TZ}=':/etc/localtime';
641 $config{timezone}=$ENV{TZ}='GMT';
645 if ($config{w3mmode}) {
646 eval q{use Cwd q{abs_path}};
648 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
649 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
650 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
651 unless $config{cgiurl} =~ m!file:///!;
652 $config{url}="file://".$config{destdir};
655 if ($config{cgi} && ! length $config{url}) {
656 error(gettext("Must specify url to wiki with --url when using --cgi"));
659 if (defined $config{url} && length $config{url}) {
661 my $baseurl = URI->new($config{url});
663 $local_url = $baseurl->path . "/";
664 $local_cgiurl = undef;
666 if (length $config{cgiurl}) {
667 my $cgiurl = URI->new($config{cgiurl});
669 $local_cgiurl = $cgiurl->path;
671 if ($cgiurl->scheme eq 'https' &&
672 $baseurl->scheme eq 'http') {
673 # We assume that the same content is available
674 # over both http and https, because if it
675 # wasn't, accessing the static content
676 # from the CGI would be mixed-content,
677 # which would be a security flaw.
679 if ($cgiurl->authority ne $baseurl->authority) {
680 # use protocol-relative URL for
682 $local_url = "$config{url}/";
683 $local_url =~ s{^http://}{//};
685 # else use host-relative URL for static content
687 # either way, CGI needs to be absolute
688 $local_cgiurl = $config{cgiurl};
690 elsif ($cgiurl->scheme ne $baseurl->scheme) {
691 # too far apart, fall back to absolute URLs
692 $local_url = "$config{url}/";
693 $local_cgiurl = $config{cgiurl};
695 elsif ($cgiurl->authority ne $baseurl->authority) {
696 # slightly too far apart, fall back to
697 # protocol-relative URLs
698 $local_url = "$config{url}/";
699 $local_url =~ s{^https?://}{//};
700 $local_cgiurl = $config{cgiurl};
701 $local_cgiurl =~ s{^https?://}{//};
703 # else keep host-relative URLs
706 $local_url =~ s{//$}{/};
709 $local_cgiurl = $config{cgiurl};
712 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
713 unless exists $config{wikistatedir} && defined $config{wikistatedir};
715 if (defined $config{umask}) {
716 my $u = possibly_foolish_untaint($config{umask});
718 if ($u =~ m/^\d+$/) {
721 elsif ($u eq 'private') {
724 elsif ($u eq 'group') {
727 elsif ($u eq 'public') {
731 error(sprintf(gettext("unsupported umask setting %s"), $u));
735 run_hooks(checkconfig => sub { shift->() });
743 foreach my $dir (@INC, getlibdirs()) {
744 next unless defined $dir && length $dir;
745 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
746 my ($plugin)=$file=~/.*\/(.*)\.pm$/;
750 foreach my $dir (getlibdirs(), "$installdir/lib/ikiwiki") {
751 next unless defined $dir && length $dir;
752 foreach my $file (glob("$dir/plugins/*")) {
753 $ret{basename($file)}=1 if -x $file;
761 foreach my $dir (getlibdirs()) {
762 unshift @INC, possibly_foolish_untaint($dir);
765 foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
770 if (exists $hooks{rcs}) {
771 error(gettext("cannot use multiple rcs plugins"));
773 loadplugin($config{rcs});
775 if (! exists $hooks{rcs}) {
779 run_hooks(getopt => sub { shift->() });
780 if (grep /^-/, @ARGV) {
781 print STDERR "Unknown option (or missing parameter): $_\n"
782 foreach grep /^-/, @ARGV;
789 sub loadplugin ($;$) {
793 return if ! $force && grep { $_ eq $plugin} @{$config{disable_plugins}};
795 foreach my $possiblytainteddir (getlibdirs(), "$installdir/lib/ikiwiki") {
796 my $dir = possibly_foolish_untaint($possiblytainteddir);
797 if (defined $dir && -x "$dir/plugins/$plugin") {
798 eval { require IkiWiki::Plugin::external };
801 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
803 import IkiWiki::Plugin::external "$dir/plugins/$plugin";
804 $loaded_plugins{$plugin}=1;
809 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
812 error("Failed to load plugin $mod: $@");
814 $loaded_plugins{$plugin}=1;
821 log_message('err' => $message) if $config{syslog};
822 if (defined $cleaner) {
829 return unless $config{verbose};
830 return log_message(debug => @_);
835 sub log_message ($$) {
838 if ($config{syslog}) {
841 Sys::Syslog::setlogsock('unix');
842 Sys::Syslog::openlog('ikiwiki', '', 'user');
846 my $message = "[$config{wikiname}] ".join(" ", @_);
847 utf8::encode($message);
848 Sys::Syslog::syslog($type, "%s", $message);
851 print STDERR "failed to syslog: $@" unless $log_failed;
857 elsif (! $config{cgi}) {
861 return print STDERR "@_\n";
865 sub possibly_foolish_untaint ($) {
867 my ($untainted)=$tainted=~/(.*)/s;
887 return exists $pagesources{$page} &&
888 $pagesources{$page} =~ /\._([^.]+)$/;
894 if ($file =~ /\.([^.]+)$/) {
895 return $1 if exists $hooks{htmlize}{$1};
897 my $base=basename($file);
898 if (exists $hooks{htmlize}{$base} &&
899 $hooks{htmlize}{$base}{noextension}) {
910 if (exists $pagename_cache{$file}) {
911 return $pagename_cache{$file};
914 my $type=pagetype($file);
916 $page=~s/\Q.$type\E*$//
917 if defined $type && !$hooks{htmlize}{$type}{keepextension}
918 && !$hooks{htmlize}{$type}{noextension};
919 if ($config{indexpages} && $page=~/(.*)\/index$/) {
923 $pagename_cache{$file} = $page;
927 sub newpagefile ($$) {
931 if (! $config{indexpages} || $page eq 'index') {
932 return $page.".".$type;
935 return $page."/index.".$type;
939 sub targetpage ($$;$) {
944 if (defined $filename) {
945 return $page."/".$filename.".".$ext;
947 elsif (! $config{usedirs} || $page eq 'index') {
948 return $page.".".$ext;
951 return $page."/index.".$ext;
958 return targetpage($page, $config{htmlext});
965 return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
966 foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
967 return "$dir/$file", stat(_) if -e "$dir/$file";
969 error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
974 return (srcfile_stat(@_))[0];
977 sub add_literal_underlay ($) {
980 if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
981 unshift @{$config{underlaydirs}}, $dir;
985 sub add_underlay ($) {
989 $dir="$config{underlaydirbase}/$dir";
992 add_literal_underlay($dir);
993 # why does it return 1? we just don't know
997 sub readfile ($;$$) {
1003 error("cannot read a symlink ($file)");
1007 open (my $in, "<", $file) || error("failed to read $file: $!");
1008 binmode($in) if ($binary);
1009 return \*$in if $wantfd;
1011 # check for invalid utf-8, and toss it back to avoid crashes
1012 if (! utf8::valid($ret)) {
1013 $ret=encode_utf8($ret);
1015 close $in || error("failed to read $file: $!");
1019 sub prep_writefile ($$) {
1024 while (length $test) {
1025 if (-l "$destdir/$test") {
1026 error("cannot write to a symlink ($test)");
1028 if (-f _ && $test ne $file) {
1029 # Remove conflicting file.
1030 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1031 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1033 unlink("$destdir/$test");
1039 $test=dirname($test);
1042 my $dir=dirname("$destdir/$file");
1045 foreach my $s (split(m!/+!, $dir)) {
1048 mkdir($d) || error("failed to create directory $d: $!");
1056 sub writefile ($$$;$$) {
1057 my $file=shift; # can include subdirs
1058 my $destdir=shift; # directory to put file in
1063 prep_writefile($file, $destdir);
1065 my $newfile="$destdir/$file.ikiwiki-new";
1067 error("cannot write to a symlink ($newfile)");
1070 my $cleanup = sub { unlink($newfile) };
1071 open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
1072 binmode($out) if ($binary);
1074 $writer->(\*$out, $cleanup);
1077 print $out $content or error("failed writing to $newfile: $!", $cleanup);
1079 close $out || error("failed saving $newfile: $!", $cleanup);
1080 rename($newfile, "$destdir/$file") ||
1081 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
1087 sub will_render ($$;$) {
1092 # Important security check for independently created files.
1093 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
1094 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
1095 my $from_other_page=0;
1096 # Expensive, but rarely runs.
1097 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1100 dirname($_) eq $dest
1101 } @{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1107 error("$config{destdir}/$dest independently created, not overwriting with version from $page")
1108 unless $from_other_page;
1111 # If $dest exists as a directory, remove conflicting files in it
1112 # rendered from other pages.
1114 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1115 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1116 if (dirname($f) eq $dest) {
1117 unlink("$config{destdir}/$f");
1118 rmdir(dirname("$config{destdir}/$f"));
1124 if (! $clear || $cleared{$page}) {
1125 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
1128 foreach my $old (@{$renderedfiles{$page}}) {
1129 delete $destsources{$old};
1131 $renderedfiles{$page}=[$dest];
1134 $destsources{$dest}=$page;
1144 if ($link=~s/^\/+//) {
1152 $l.="/" if length $l;
1155 if (exists $pagesources{$l}) {
1158 elsif (exists $pagecase{lc $l}) {
1159 return $pagecase{lc $l};
1161 } while $cwd=~s{/?[^/]+$}{};
1163 if (length $config{userdir}) {
1164 my $l = "$config{userdir}/".lc($link);
1165 if (exists $pagesources{$l}) {
1168 elsif (exists $pagecase{lc $l}) {
1169 return $pagecase{lc $l};
1173 #print STDERR "warning: page $page, broken link: $link\n";
1177 sub isinlinableimage ($) {
1180 return $file =~ /\.(png|gif|jpg|jpeg|svg)$/i;
1183 sub pagetitle ($;$) {
1185 my $unescaped=shift;
1188 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
1191 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
1199 # support use w/o %config set
1200 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1201 $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1207 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1208 $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1215 my $cgiurl=$local_cgiurl;
1217 if (exists $params{cgiurl}) {
1218 $cgiurl=$params{cgiurl};
1219 delete $params{cgiurl};
1227 join("&", map $_."=".uri_escape_utf8($params{$_}), sort(keys %params));
1230 sub cgiurl_abs (@) {
1232 URI->new_abs(cgiurl(@_), $config{cgiurl});
1238 return $local_url if ! defined $page;
1240 $page=htmlpage($page);
1242 $page=~s/[^\/]+\//..\//g;
1250 return $url unless defined $urlbase && length $urlbase;
1253 URI->new_abs($url, $urlbase)->as_string;
1257 # Work around very innefficient behavior in File::Spec if abs2rel
1258 # is passed two relative paths. It's much faster if paths are
1259 # absolute! (Debian bug #376658; fixed in debian unstable now)
1264 my $ret=File::Spec->abs2rel($path, $base);
1265 $ret=~s/^// if defined $ret;
1269 sub displaytime ($;$$) {
1270 # Plugins can override this function to mark up the time to
1272 my $time=formattime($_[0], $_[1]);
1273 if ($config{html5}) {
1274 return '<time datetime="'.date_3339($_[0]).'"'.
1275 ($_[2] ? ' pubdate="pubdate"' : '').
1276 '>'.$time.'</time>';
1279 return '<span class="date">'.$time.'</span>';
1283 sub formattime ($;$) {
1284 # Plugins can override this function to format the time.
1287 if (! defined $format) {
1288 $format=$config{timeformat};
1291 return strftime_utf8($format, localtime($time));
1294 my $strftime_encoding;
1296 # strftime didn't know about encodings in older Perl, so make sure
1297 # its output is properly treated as utf8.
1298 # Note that this does not handle utf-8 in the format string.
1299 my $result = POSIX::strftime(@_);
1301 if (Encode::is_utf8($result)) {
1305 ($strftime_encoding) = POSIX::setlocale(&POSIX::LC_TIME) =~ m#\.([^@]+)#
1306 unless defined $strftime_encoding;
1308 ? Encode::decode($strftime_encoding, $result)
1315 my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
1316 POSIX::setlocale(&POSIX::LC_TIME, "C");
1317 my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
1318 POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
1322 sub beautify_urlpath ($) {
1325 # Ensure url is not an empty link, and if necessary,
1326 # add ./ to avoid colon confusion.
1327 if ($url !~ /^\// && $url !~ /^\.\.?\//) {
1331 if ($config{usedirs}) {
1332 $url =~ s!/index.$config{htmlext}$!/!;
1347 if (! $destsources{$to}) {
1352 return $config{url}.beautify_urlpath("/".$to);
1355 if (! defined $from) {
1356 my $u = $local_url || '';
1358 return $u.beautify_urlpath("/".$to);
1361 my $link = abs2rel($to, dirname(htmlpage($from)));
1363 return beautify_urlpath($link);
1366 sub isselflink ($$) {
1367 # Plugins can override this function to support special types
1372 return $page eq $link;
1375 sub htmllink ($$$;@) {
1376 my $lpage=shift; # the page doing the linking
1377 my $page=shift; # the page that will contain the link (different for inline)
1384 if (! $opts{forcesubpage}) {
1385 $bestlink=bestlink($lpage, $link);
1388 $bestlink="$lpage/".lc($link);
1392 if (defined $opts{linktext}) {
1393 $linktext=$opts{linktext};
1396 $linktext=pagetitle(basename($link));
1399 return "<span class=\"selflink\">$linktext</span>"
1400 if length $bestlink && isselflink($page, $bestlink) &&
1401 ! defined $opts{anchor};
1403 if (! $destsources{$bestlink}) {
1404 $bestlink=htmlpage($bestlink);
1406 if (! $destsources{$bestlink}) {
1408 if (length $config{cgiurl}) {
1409 $cgilink = "<a href=\"".
1414 )."\" rel=\"nofollow\">?</a>";
1416 return "<span class=\"createlink\">$cgilink$linktext</span>"
1420 $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1421 $bestlink=beautify_urlpath($bestlink);
1423 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1424 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1427 if (defined $opts{anchor}) {
1428 $bestlink.="#".$opts{anchor};
1432 foreach my $attr (qw{rel class title}) {
1433 if (defined $opts{$attr}) {
1434 push @attrs, " $attr=\"$opts{$attr}\"";
1438 return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1443 return length $config{userdir} ? "$config{userdir}/$user" : $user;
1446 # Username to display for openid accounts.
1447 sub openiduser ($) {
1450 if (defined $user && $user =~ m!^https?://! &&
1451 eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1454 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1455 $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1458 # backcompat with old version
1459 my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1460 $display=$oid->display;
1463 # Convert "user.somehost.com" to "user [somehost.com]"
1464 # (also "user.somehost.co.uk")
1465 if ($display !~ /\[/) {
1466 $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1468 # Convert "http://somehost.com/user" to "user [somehost.com]".
1469 # (also "https://somehost.com/user/")
1470 if ($display !~ /\[/) {
1471 $display=~s/^https?:\/\/(.+)\/([^\/#?]+)\/?(?:[#?].*)?$/$2 [$1]/;
1473 $display=~s!^https?://!!; # make sure this is removed
1474 eval q{use CGI 'escapeHTML'};
1476 return escapeHTML($display);
1481 # Username to display for emailauth accounts.
1484 if (defined $user && $user =~ m/(.+)@/) {
1486 # remove any characters from not allowed in wiki files
1487 # support use w/o %config set
1488 my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1489 $nick=~s/[^$chars]/_/g;
1495 # Some user information should not be exposed in commit metadata, etc.
1496 # This generates a cloaked form of such information.
1499 # cloak email address using http://xmlns.com/foaf/spec/#term_mbox_sha1sum
1500 if ($user=~m/(.+)@/) {
1502 eval q{use Digest::SHA};
1504 return $nick.'@'.Digest::SHA::sha1_hex("mailto:$user");
1511 sub htmlize ($$$$) {
1517 my $oneline = $content !~ /\n/;
1519 if (exists $hooks{htmlize}{$type}) {
1520 $content=$hooks{htmlize}{$type}{call}->(
1522 content => $content,
1526 error("htmlization of $type not supported");
1529 run_hooks(sanitize => sub {
1532 destpage => $destpage,
1533 content => $content,
1538 # hack to get rid of enclosing junk added by markdown
1539 # and other htmlizers/sanitizers
1540 $content=~s/^<p>//i;
1541 $content=~s/<\/p>\n*$//i;
1552 run_hooks(linkify => sub {
1555 destpage => $destpage,
1556 content => $content,
1564 our $preprocess_preview=0;
1565 sub preprocess ($$$;$$) {
1566 my $page=shift; # the page the data comes from
1567 my $destpage=shift; # the page the data will appear in (different for inline)
1572 # Using local because it needs to be set within any nested calls
1574 local $preprocess_preview=$preview if defined $preview;
1581 $params="" if ! defined $params;
1583 if (length $escape) {
1584 return "[[$prefix$command $params]]";
1586 elsif (exists $hooks{preprocess}{$command}) {
1587 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1588 # Note: preserve order of params, some plugins may
1589 # consider it significant.
1591 while ($params =~ m{
1592 (?:([-.\w]+)=)? # 1: named parameter key?
1594 """(.*?)""" # 2: triple-quoted value
1596 "([^"]*?)" # 3: single-quoted value
1598 '''(.*?)''' # 4: triple-single-quote
1600 <<([a-zA-Z]+)\n # 5: heredoc start
1601 (.*?)\n\5 # 6: heredoc value
1603 (\S+) # 7: unquoted value
1605 (?:\s+|$) # delimiter to next param
1615 elsif (defined $3) {
1618 elsif (defined $4) {
1621 elsif (defined $7) {
1624 elsif (defined $6) {
1629 push @params, $key, $val;
1632 push @params, $val, '';
1635 if ($preprocessing{$page}++ > 8) {
1636 # Avoid loops of preprocessed pages preprocessing
1637 # other pages that preprocess them, etc.
1638 return "[[!$command <span class=\"error\">".
1639 sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1640 $page, $preprocessing{$page}).
1646 $hooks{preprocess}{$command}{call}->(
1649 destpage => $destpage,
1650 preview => $preprocess_preview,
1656 eval q{use HTML::Entities};
1657 $error = encode_entities($error);
1658 $ret="[[!$command <span class=\"error\">".
1659 gettext("Error").": $error"."</span>]]";
1663 # use void context during scan pass
1665 $hooks{preprocess}{$command}{call}->(
1668 destpage => $destpage,
1669 preview => $preprocess_preview,
1674 $preprocessing{$page}--;
1678 return "[[$prefix$command $params]]";
1683 if ($config{prefix_directives}) {
1686 \[\[(!) # directive open; 2: prefix
1687 ([-\w]+) # 3: command
1688 ( # 4: the parameters..
1689 \s+ # Must have space if parameters present
1691 (?:[-.\w]+=)? # named parameter key?
1693 """.*?""" # triple-quoted value
1695 "[^"]*?" # single-quoted value
1697 '''.*?''' # triple-single-quote
1699 <<([a-zA-Z]+)\n # 5: heredoc start
1700 (?:.*?)\n\5 # heredoc value
1702 [^"\s\]]+ # unquoted value
1704 \s* # whitespace or end
1707 *)? # 0 or more parameters
1708 \]\] # directive closed
1714 \[\[(!?) # directive open; 2: optional prefix
1715 ([-\w]+) # 3: command
1717 ( # 4: the parameters..
1719 (?:[-.\w]+=)? # named parameter key?
1721 """.*?""" # triple-quoted value
1723 "[^"]*?" # single-quoted value
1725 '''.*?''' # triple-single-quote
1727 <<([a-zA-Z]+)\n # 5: heredoc start
1728 (?:.*?)\n\5 # heredoc value
1730 [^"\s\]]+ # unquoted value
1732 \s* # whitespace or end
1735 *) # 0 or more parameters
1736 \]\] # directive closed
1740 $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1749 run_hooks(filter => sub {
1750 $content=shift->(page => $page, destpage => $destpage,
1751 content => $content);
1757 sub check_canedit ($$$;$) {
1764 run_hooks(canedit => sub {
1765 return if defined $canedit;
1766 my $ret=shift->($page, $q, $session);
1771 elsif (ref $ret eq 'CODE') {
1772 $ret->() unless $nonfatal;
1775 elsif (defined $ret) {
1776 error($ret) unless $nonfatal;
1781 return defined $canedit ? $canedit : 1;
1784 sub check_content (@) {
1787 return 1 if ! exists $hooks{checkcontent}; # optimisation
1789 if (exists $pagesources{$params{page}}) {
1791 my %old=map { $_ => 1 }
1792 split("\n", readfile(srcfile($pagesources{$params{page}})));
1793 foreach my $line (split("\n", $params{content})) {
1794 push @diff, $line if ! exists $old{$line};
1796 $params{diff}=join("\n", @diff);
1800 run_hooks(checkcontent => sub {
1801 return if defined $ok;
1802 my $ret=shift->(%params);
1807 elsif (ref $ret eq 'CODE') {
1808 $ret->() unless $params{nonfatal};
1811 elsif (defined $ret) {
1812 error($ret) unless $params{nonfatal};
1818 return defined $ok ? $ok : 1;
1821 sub check_canchange (@) {
1823 my $cgi = $params{cgi};
1824 my $session = $params{session};
1825 my @changes = @{$params{changes}};
1828 foreach my $change (@changes) {
1829 # This untaint is safe because we check file_pruned and
1831 my ($file)=$change->{file}=~/$config{wiki_file_regexp}/;
1832 $file=possibly_foolish_untaint($file);
1833 if (! defined $file || ! length $file ||
1834 file_pruned($file)) {
1835 error(sprintf(gettext("bad file name %s"), $file));
1838 my $type=pagetype($file);
1839 my $page=pagename($file) if defined $type;
1841 if ($change->{action} eq 'add') {
1845 if ($change->{action} eq 'change' ||
1846 $change->{action} eq 'add') {
1847 if (defined $page) {
1848 check_canedit($page, $cgi, $session);
1852 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
1853 IkiWiki::Plugin::attachment::check_canattach($session, $file, $change->{path});
1854 check_canedit($file, $cgi, $session);
1859 elsif ($change->{action} eq 'remove') {
1860 # check_canremove tests to see if the file is present
1861 # on disk. This will fail when a single commit adds a
1862 # file and then removes it again. Avoid the problem
1863 # by not testing the removal in such pairs of changes.
1864 # (The add is still tested, just to make sure that
1865 # no data is added to the repo that a web edit
1867 next if $newfiles{$file};
1869 if (IkiWiki::Plugin::remove->can("check_canremove")) {
1870 IkiWiki::Plugin::remove::check_canremove(defined $page ? $page : $file, $cgi, $session);
1871 check_canedit(defined $page ? $page : $file, $cgi, $session);
1876 error "unknown action ".$change->{action};
1879 error sprintf(gettext("you are not allowed to change %s"), $file);
1887 # Take an exclusive lock on the wiki to prevent multiple concurrent
1888 # run issues. The lock will be dropped on program exit.
1889 if (! -d $config{wikistatedir}) {
1890 mkdir($config{wikistatedir});
1892 open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1893 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1894 if (! flock($wikilock, LOCK_EX | LOCK_NB)) {
1895 debug("failed to get lock; waiting...");
1896 if (! flock($wikilock, LOCK_EX)) {
1897 error("failed to get lock");
1904 POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1905 return close($wikilock) if $wikilock;
1911 sub commit_hook_enabled () {
1912 open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1913 error("cannot write to $config{wikistatedir}/commitlock: $!");
1914 if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1915 close($commitlock) || error("failed closing commitlock: $!");
1918 close($commitlock) || error("failed closing commitlock: $!");
1922 sub disable_commit_hook () {
1923 open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1924 error("cannot write to $config{wikistatedir}/commitlock: $!");
1925 if (! flock($commitlock, 2)) { # LOCK_EX
1926 error("failed to get commit lock");
1931 sub enable_commit_hook () {
1932 return close($commitlock) if $commitlock;
1937 %oldrenderedfiles=%pagectime=();
1938 my $rebuild=$config{rebuild};
1940 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1941 %destsources=%renderedfiles=%pagecase=%pagestate=
1942 %depends_simple=%typedlinks=%oldtypedlinks=();
1945 if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1946 if (-e "$config{wikistatedir}/index") {
1947 system("ikiwiki-transition", "indexdb", $config{srcdir});
1948 open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1951 # gettime on first build
1952 $config{gettime}=1 unless defined $config{gettime};
1957 my $index=Storable::fd_retrieve($in);
1958 if (! defined $index) {
1963 if (exists $index->{version} && ! ref $index->{version}) {
1964 $pages=$index->{page};
1965 %wikistate=%{$index->{state}};
1966 # Handle plugins that got disabled by loading a new setup.
1967 if (exists $config{setupfile}) {
1968 require IkiWiki::Setup;
1969 IkiWiki::Setup::disabled_plugins(
1970 grep { ! $loaded_plugins{$_} } keys %wikistate);
1978 foreach my $src (keys %$pages) {
1979 my $d=$pages->{$src};
1981 if (exists $d->{page} && ! $rebuild) {
1985 $page=pagename($src);
1987 $pagectime{$page}=$d->{ctime};
1988 $pagesources{$page}=$src;
1990 $pagemtime{$page}=$d->{mtime};
1991 $renderedfiles{$page}=$d->{dest};
1992 if (exists $d->{links} && ref $d->{links}) {
1993 $links{$page}=$d->{links};
1994 $oldlinks{$page}=[@{$d->{links}}];
1996 if (ref $d->{depends_simple} eq 'ARRAY') {
1998 $depends_simple{$page}={
1999 map { $_ => 1 } @{$d->{depends_simple}}
2002 elsif (exists $d->{depends_simple}) {
2003 $depends_simple{$page}=$d->{depends_simple};
2005 if (exists $d->{dependslist}) {
2008 map { $_ => $DEPEND_CONTENT }
2009 @{$d->{dependslist}}
2012 elsif (exists $d->{depends} && ! ref $d->{depends}) {
2014 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
2016 elsif (exists $d->{depends}) {
2017 $depends{$page}=$d->{depends};
2019 if (exists $d->{state}) {
2020 $pagestate{$page}=$d->{state};
2022 if (exists $d->{typedlinks}) {
2023 $typedlinks{$page}=$d->{typedlinks};
2025 while (my ($type, $links) = each %{$typedlinks{$page}}) {
2026 next unless %$links;
2027 $oldtypedlinks{$page}{$type} = {%$links};
2031 $oldrenderedfiles{$page}=[@{$d->{dest}}];
2033 foreach my $page (keys %pagesources) {
2034 $pagecase{lc $page}=$page;
2036 foreach my $page (keys %renderedfiles) {
2037 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
2039 $lastrev=$index->{lastrev};
2040 @underlayfiles=@{$index->{underlayfiles}} if ref $index->{underlayfiles};
2045 run_hooks(savestate => sub { shift->() });
2047 my @plugins=keys %loaded_plugins;
2049 if (! -d $config{wikistatedir}) {
2050 mkdir($config{wikistatedir});
2052 my $newfile="$config{wikistatedir}/indexdb.new";
2053 my $cleanup = sub { unlink($newfile) };
2054 open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
2057 foreach my $page (keys %pagemtime) {
2058 next unless $pagemtime{$page};
2059 my $src=$pagesources{$page};
2061 $index{page}{$src}={
2063 ctime => $pagectime{$page},
2064 mtime => $pagemtime{$page},
2065 dest => $renderedfiles{$page},
2066 links => $links{$page},
2069 if (exists $depends{$page}) {
2070 $index{page}{$src}{depends} = $depends{$page};
2073 if (exists $depends_simple{$page}) {
2074 $index{page}{$src}{depends_simple} = $depends_simple{$page};
2077 if (exists $typedlinks{$page} && %{$typedlinks{$page}}) {
2078 $index{page}{$src}{typedlinks} = $typedlinks{$page};
2081 if (exists $pagestate{$page}) {
2082 $index{page}{$src}{state}=$pagestate{$page};
2087 foreach my $id (@plugins) {
2088 $index{state}{$id}={}; # used to detect disabled plugins
2089 foreach my $key (keys %{$wikistate{$id}}) {
2090 $index{state}{$id}{$key}=$wikistate{$id}{$key};
2094 $index{lastrev}=$lastrev;
2095 $index{underlayfiles}=\@underlayfiles;
2097 $index{version}="3";
2098 my $ret=Storable::nstore_fd(\%index, $out);
2099 return if ! defined $ret || ! $ret;
2100 close $out || error("failed saving to $newfile: $!", $cleanup);
2101 rename($newfile, "$config{wikistatedir}/indexdb") ||
2102 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
2107 sub template_file ($) {
2110 my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
2112 if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
2113 $template=srcfile($pagesources{$tpage}, 1);
2117 $template=srcfile($tpage, 1);
2120 if (defined $template) {
2121 return $template, $tpage, 1 if wantarray;
2125 $name=~s:/::; # avoid path traversal
2126 foreach my $dir ($config{templatedir},
2127 "$installdir/share/ikiwiki/templates") {
2128 if (-e "$dir/$name") {
2129 $template="$dir/$name";
2133 if (defined $template) {
2134 return $template, $tpage if wantarray;
2142 sub template_depends ($$;@) {
2146 my ($filename, $tpage, $untrusted)=template_file($name);
2147 if (! defined $filename) {
2148 error(sprintf(gettext("template %s not found"), $name))
2151 if (defined $page && defined $tpage) {
2152 add_depends($page, $tpage);
2157 my $text_ref = shift;
2158 ${$text_ref} = decode_utf8(${$text_ref});
2159 run_hooks(readtemplate => sub {
2160 ${$text_ref} = shift->(
2163 content => ${$text_ref},
2164 untrusted => $untrusted,
2168 loop_context_vars => 1,
2169 die_on_bad_params => 0,
2170 parent_global_vars => 1,
2171 filename => $filename,
2173 ($untrusted ? (no_includes => 1) : ()),
2175 return @opts if wantarray;
2177 require HTML::Template;
2178 return HTML::Template->new(@opts);
2181 sub template ($;@) {
2182 template_depends(shift, undef, @_);
2185 sub templateactions ($$) {
2191 run_hooks(pageactions => sub {
2192 push @actions, map { { action => $_ } }
2193 grep { defined } shift->(page => $page);
2195 $template->param(actions => \@actions);
2197 if ($config{cgiurl} && exists $hooks{auth}) {
2198 $template->param(prefsurl => cgiurl(do => "prefs"));
2202 if ($have_actions || @actions) {
2203 $template->param(have_actions => 1);
2210 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
2211 error 'hook requires type, call, and id parameters';
2214 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
2216 $hooks{$param{type}}{$param{id}}=\%param;
2220 sub run_hooks ($$) {
2221 # Calls the given sub for each hook of the given type,
2222 # passing it the hook function to call.
2226 if (exists $hooks{$type}) {
2227 my (@first, @middle, @last);
2228 foreach my $id (keys %{$hooks{$type}}) {
2229 if ($hooks{$type}{$id}{first}) {
2232 elsif ($hooks{$type}{$id}{last}) {
2239 foreach my $id (@first, @middle, @last) {
2240 $sub->($hooks{$type}{$id}{call});
2248 $hooks{rcs}{rcs_update}{call}->(@_);
2251 sub rcs_prepedit ($) {
2252 $hooks{rcs}{rcs_prepedit}{call}->(@_);
2255 sub rcs_commit (@) {
2256 $hooks{rcs}{rcs_commit}{call}->(@_);
2259 sub rcs_commit_staged (@) {
2260 $hooks{rcs}{rcs_commit_staged}{call}->(@_);
2264 $hooks{rcs}{rcs_add}{call}->(@_);
2267 sub rcs_remove ($) {
2268 $hooks{rcs}{rcs_remove}{call}->(@_);
2271 sub rcs_rename ($$) {
2272 $hooks{rcs}{rcs_rename}{call}->(@_);
2275 sub rcs_recentchanges ($) {
2276 $hooks{rcs}{rcs_recentchanges}{call}->(@_);
2279 sub rcs_diff ($;$) {
2280 $hooks{rcs}{rcs_diff}{call}->(@_);
2283 sub rcs_getctime ($) {
2284 $hooks{rcs}{rcs_getctime}{call}->(@_);
2287 sub rcs_getmtime ($) {
2288 $hooks{rcs}{rcs_getmtime}{call}->(@_);
2291 sub rcs_receive () {
2292 $hooks{rcs}{rcs_receive}{call}->();
2295 sub add_depends ($$;$) {
2298 my $deptype=shift || $DEPEND_CONTENT;
2300 # Is the pagespec a simple page name?
2301 if ($pagespec =~ /$config{wiki_file_regexp}/ &&
2302 $pagespec !~ /[\s*?()!]/) {
2303 $depends_simple{$page}{lc $pagespec} |= $deptype;
2307 # Add explicit dependencies for influences.
2308 my $sub=pagespec_translate($pagespec);
2309 return unless defined $sub;
2310 foreach my $p (keys %pagesources) {
2311 my $r=$sub->($p, location => $page);
2312 my $i=$r->influences;
2313 my $static=$r->influences_static;
2314 foreach my $k (keys %$i) {
2315 next unless $r || $static || $k eq $page;
2316 $depends_simple{$page}{lc $k} |= $i->{$k};
2321 $depends{$page}{$pagespec} |= $deptype;
2327 foreach my $type (@_) {
2328 if ($type eq 'presence') {
2329 $deptype |= $DEPEND_PRESENCE;
2331 elsif ($type eq 'links') {
2332 $deptype |= $DEPEND_LINKS;
2334 elsif ($type eq 'content') {
2335 $deptype |= $DEPEND_CONTENT;
2341 my $file_prune_regexp;
2342 sub file_pruned ($) {
2345 if (defined $config{include} && length $config{include}) {
2346 return 0 if $file =~ m/$config{include}/;
2349 if (! defined $file_prune_regexp) {
2350 $file_prune_regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
2351 $file_prune_regexp=qr/$file_prune_regexp/;
2353 return $file =~ m/$file_prune_regexp/;
2356 sub define_gettext () {
2357 # If translation is needed, redefine the gettext function to do it.
2358 # Otherwise, it becomes a quick no-op.
2361 if ((exists $ENV{LANG} && length $ENV{LANG}) ||
2362 (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
2363 (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
2365 $gettext_obj=eval q{
2366 use Locale::gettext q{textdomain};
2367 Locale::gettext->domain('ikiwiki')
2372 no warnings 'redefine';
2374 $getobj->() if $getobj;
2376 $gettext_obj->get(shift);
2383 $getobj->() if $getobj;
2385 $gettext_obj->nget(@_);
2388 return ($_[2] == 1 ? $_[0] : $_[1])
2406 return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
2410 # Injects a new function into the symbol table to replace an
2411 # exported function.
2414 # This is deep ugly perl foo, beware.
2417 if (! defined $params{parent}) {
2418 $params{parent}='::';
2419 $params{old}=\&{$params{name}};
2420 $params{name}=~s/.*:://;
2422 my $parent=$params{parent};
2423 foreach my $ns (grep /^\w+::/, keys %{$parent}) {
2424 $ns = $params{parent} . $ns;
2425 inject(%params, parent => $ns) unless $ns eq '::main::';
2426 *{$ns . $params{name}} = $params{call}
2427 if exists ${$ns}{$params{name}} &&
2428 \&{${$ns}{$params{name}}} == $params{old};
2434 sub add_link ($$;$) {
2439 push @{$links{$page}}, $link
2440 unless grep { $_ eq $link } @{$links{$page}};
2442 if (defined $type) {
2443 $typedlinks{$page}{$type}{$link} = 1;
2447 sub add_autofile ($$$) {
2450 my $generator=shift;
2452 $autofiles{$file}{plugin}=$plugin;
2453 $autofiles{$file}{generator}=$generator;
2457 return LWP::UserAgent->new(
2458 cookie_jar => $config{cookiejar},
2459 env_proxy => 1, # respect proxy env vars
2460 agent => $config{useragent},
2464 sub sortspec_translate ($$) {
2466 my $reverse = shift;
2472 (-?) # group 1: perhaps negated
2475 \w+\([^\)]*\) # command(params)
2477 [^\s]+ # or anything else
2485 if ($word =~ m/^(\w+)\((.*)\)$/) {
2486 # command with parameters
2490 elsif ($word !~ m/^\w+$/) {
2491 error(sprintf(gettext("invalid sort type %s"), $word));
2502 if (exists $IkiWiki::SortSpec::{"cmp_$word"}) {
2503 if (defined $params) {
2504 push @data, $params;
2505 $code .= "IkiWiki::SortSpec::cmp_$word(\$data[$#data])";
2508 $code .= "IkiWiki::SortSpec::cmp_$word(undef)";
2512 error(sprintf(gettext("unknown sort type %s"), $word));
2516 if (! length $code) {
2517 # undefined sorting method... sort arbitrarily
2526 return eval 'sub { '.$code.' }';
2529 sub pagespec_translate ($) {
2532 # Convert spec to perl code.
2536 \s* # ignore whitespace
2537 ( # 1: match a single word
2544 \w+\([^\)]*\) # command(params)
2546 [^\s()]+ # any other text
2548 \s* # ignore whitespace
2551 if (lc $word eq 'and') {
2554 elsif (lc $word eq 'or') {
2557 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
2560 elsif ($word =~ /^(\w+)\((.*)\)$/) {
2561 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
2563 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
2566 push @data, qq{unknown function in pagespec "$word"};
2567 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
2572 $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
2576 if (! length $code) {
2577 $code="IkiWiki::FailReason->new('empty pagespec')";
2581 return eval 'sub { my $page=shift; '.$code.' }';
2584 sub pagespec_match ($$;@) {
2589 # Backwards compatability with old calling convention.
2591 unshift @params, 'location';
2594 my $sub=pagespec_translate($spec);
2595 return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
2597 return $sub->($page, @params);
2600 # e.g. @pages = sort_pages("title", \@pages, reverse => "yes")
2602 # Not exported yet, but could be in future if it is generally useful.
2603 # Note that this signature is not the same as IkiWiki::SortSpec::sort_pages,
2604 # which is "more internal".
2605 sub sort_pages ($$;@) {
2609 $sort = sortspec_translate($sort, $params{reverse});
2610 return IkiWiki::SortSpec::sort_pages($sort, @$list);
2613 sub pagespec_match_list ($$;@) {
2618 # Backwards compatability with old calling convention.
2620 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
2621 $params{list}=$page;
2622 $page=$params{location}; # ugh!
2625 my $sub=pagespec_translate($pagespec);
2626 error "syntax error in pagespec \"$pagespec\""
2628 my $sort=sortspec_translate($params{sort}, $params{reverse})
2629 if defined $params{sort};
2632 if (exists $params{list}) {
2633 @candidates=exists $params{filter}
2634 ? grep { ! $params{filter}->($_) } @{$params{list}}
2638 @candidates=exists $params{filter}
2639 ? grep { ! $params{filter}->($_) } keys %pagesources
2640 : keys %pagesources;
2643 # clear params, remainder is passed to pagespec
2644 $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2645 my $num=$params{num};
2646 delete @params{qw{num deptype reverse sort filter list}};
2648 # when only the top matches will be returned, it's efficient to
2649 # sort before matching to pagespec,
2650 if (defined $num && defined $sort) {
2651 @candidates=IkiWiki::SortSpec::sort_pages(
2652 $sort, @candidates);
2658 my $accum=IkiWiki::SuccessReason->new();
2659 foreach my $p (@candidates) {
2660 my $r=$sub->($p, %params, location => $page);
2661 error(sprintf(gettext("cannot match pages: %s"), $r))
2662 if $r->isa("IkiWiki::ErrorReason");
2663 unless ($r || $r->influences_static) {
2664 $r->remove_influence($p);
2669 last if defined $num && ++$count == $num;
2673 # Add simple dependencies for accumulated influences.
2674 my $i=$accum->influences;
2675 foreach my $k (keys %$i) {
2676 $depends_simple{$page}{lc $k} |= $i->{$k};
2679 # when all matches will be returned, it's efficient to
2680 # sort after matching
2681 if (! defined $num && defined $sort) {
2682 return IkiWiki::SortSpec::sort_pages(
2690 sub pagespec_valid ($) {
2693 return defined pagespec_translate($spec);
2697 my $re=quotemeta(shift);
2703 package IkiWiki::FailReason;
2706 '""' => sub { $_[0][0] },
2708 '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2709 '&' => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2710 '|' => sub { $_[1]->merge_influences($_[0]); $_[1] },
2714 our @ISA = 'IkiWiki::SuccessReason';
2716 package IkiWiki::SuccessReason;
2718 # A blessed array-ref:
2720 # [0]: human-readable reason for success (or, in FailReason subclass, failure)
2722 # - if absent or false, the influences of this evaluation are "static",
2723 # see the influences_static method
2724 # - if true, they are dynamic (not static)
2725 # [1]{any other key}:
2726 # the dependency types of influences, as returned by the influences method
2729 # in string context, it's the human-readable reason
2730 '""' => sub { $_[0][0] },
2731 # in boolean context, SuccessReason is 1 and FailReason is 0
2733 # negating a result gives the opposite result with the same influences
2734 '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
2735 # A & B = (A ? B : A) with the influences of both
2736 '&' => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2737 # A | B = (A ? A : B) with the influences of both
2738 '|' => sub { $_[0]->merge_influences($_[1]); $_[0] },
2742 # SuccessReason->new("human-readable reason", page => deptype, ...)
2747 return bless [$value, {@_}], $class;
2750 # influences(): return a reference to a copy of the hash
2751 # { page => dependency type } describing the pages that indirectly influenced
2752 # this result, but would not cause a dependency through ikiwiki's core
2755 # See [[todo/dependency_types]] for extensive discussion of what this means.
2757 # influences(page => deptype, ...): remove all influences, replace them
2758 # with the arguments, and return a reference to a copy of the new influences.
2762 $this->[1]={@_} if @_;
2763 my %i=%{$this->[1]};
2768 # True if this result has the same influences whichever page it matches,
2769 # For instance, whether bar matches backlink(foo) is influenced only by
2770 # the set of links in foo, so its only influence is { foo => DEPEND_LINKS },
2771 # which does not mention bar anywhere.
2773 # False if this result would have different influences when matching
2774 # different pages. For instance, when testing whether link(foo) matches bar,
2775 # { bar => DEPEND_LINKS } is an influence on that result, because changing
2776 # bar's links could change the outcome; so its influences are not the same
2777 # as when testing whether link(foo) matches baz.
2779 # Static influences are one of the things that make pagespec_match_list
2780 # more efficient than repeated calls to pagespec_match.
2782 sub influences_static {
2783 return ! $_[0][1]->{""};
2786 # Change the influences of $this to be the influences of "$this & $other"
2787 # or "$this | $other".
2789 # If both $this and $other are either successful or have influences,
2790 # or this is an "or" operation, the result has all the influences from
2791 # either of the arguments. It has dynamic influences if either argument
2792 # has dynamic influences.
2794 # If this is an "and" operation, and at least one argument is a
2795 # FailReason with no influences, the result has no influences, and they
2796 # are not dynamic. For instance, link(foo) matching bar is influenced
2797 # by bar, but enabled(ddate) has no influences. Suppose ddate is disabled;
2798 # then (link(foo) and enabled(ddate)) not matching bar is not influenced by
2799 # bar, because it would be false however often you edit bar.
2801 sub merge_influences {
2806 # This "if" is odd because it needs to avoid negating $this
2807 # or $other, which would alter the objects in-place. Be careful.
2808 if (! $anded || (($this || %{$this->[1]}) &&
2809 ($other || %{$other->[1]}))) {
2810 foreach my $influence (keys %{$other->[1]}) {
2811 $this->[1]{$influence} |= $other->[1]{$influence};
2820 # Change $this so it is not considered to be influenced by $torm.
2822 sub remove_influence {
2826 delete $this->[1]{$torm};
2829 package IkiWiki::ErrorReason;
2831 our @ISA = 'IkiWiki::FailReason';
2833 package IkiWiki::PageSpec;
2839 if ($path =~ m!^\.(/|$)!) {
2841 $from=~s#/?[^/]+$## if defined $from;
2843 $path="$from/$path" if defined $from && length $from;
2847 $path = "" unless defined $path;
2856 sub match_glob ($$;@) {
2861 $glob=derel($glob, $params{location});
2863 # Instead of converting the glob to a regex every time,
2864 # cache the compiled regex to save time.
2865 my $re=$glob_cache{$glob};
2866 unless (defined $re) {
2867 $glob_cache{$glob} = $re = IkiWiki::glob2re($glob);
2870 if (! IkiWiki::isinternal($page) || $params{internal}) {
2871 return IkiWiki::SuccessReason->new("$glob matches $page");
2874 return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2878 return IkiWiki::FailReason->new("$glob does not match $page");
2882 sub match_internal ($$;@) {
2883 return match_glob(shift, shift, @_, internal => 1)
2886 sub match_page ($$;@) {
2888 my $match=match_glob($page, shift, @_);
2890 my $source=exists $IkiWiki::pagesources{$page} ?
2891 $IkiWiki::pagesources{$page} :
2892 $IkiWiki::delpagesources{$page};
2893 my $type=defined $source ? IkiWiki::pagetype($source) : undef;
2894 if (! defined $type) {
2895 return IkiWiki::FailReason->new("$page is not a page");
2901 sub match_link ($$;@) {
2906 $link=derel($link, $params{location});
2907 my $from=exists $params{location} ? $params{location} : '';
2908 my $linktype=$params{linktype};
2910 if (defined $linktype) {
2911 $qualifier=" with type $linktype";
2914 my $links = $IkiWiki::links{$page};
2915 return IkiWiki::FailReason->new("$page has no links", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2916 unless $links && @{$links};
2917 my $bestlink = IkiWiki::bestlink($from, $link);
2918 foreach my $p (@{$links}) {
2919 next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
2921 if (length $bestlink) {
2922 if ($bestlink eq IkiWiki::bestlink($page, $p)) {
2923 return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2927 if (match_glob($p, $link, %params)) {
2928 return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2930 my ($p_rel)=$p=~/^\/?(.*)/;
2932 if (match_glob($p_rel, $link, %params)) {
2933 return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2937 return IkiWiki::FailReason->new("$page does not link to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1);
2940 sub match_backlink ($$;@) {
2944 if ($testpage eq '.') {
2945 $testpage = $params{'location'}
2947 my $ret=match_link($testpage, $page, @_);
2948 $ret->influences($testpage => $IkiWiki::DEPEND_LINKS);
2952 sub match_created_before ($$;@) {
2957 $testpage=derel($testpage, $params{location});
2959 if (exists $IkiWiki::pagectime{$testpage}) {
2960 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2961 return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2964 return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2968 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2972 sub match_created_after ($$;@) {
2977 $testpage=derel($testpage, $params{location});
2979 if (exists $IkiWiki::pagectime{$testpage}) {
2980 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2981 return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2984 return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2988 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2992 sub match_creation_day ($$;@) {
2995 if ($d !~ /^\d+$/) {
2996 return IkiWiki::ErrorReason->new("invalid day $d");
2998 if ((localtime($IkiWiki::pagectime{$page}))[3] == $d) {
2999 return IkiWiki::SuccessReason->new('creation_day matched');
3002 return IkiWiki::FailReason->new('creation_day did not match');
3006 sub match_creation_month ($$;@) {
3009 if ($m !~ /^\d+$/) {
3010 return IkiWiki::ErrorReason->new("invalid month $m");
3012 if ((localtime($IkiWiki::pagectime{$page}))[4] + 1 == $m) {
3013 return IkiWiki::SuccessReason->new('creation_month matched');
3016 return IkiWiki::FailReason->new('creation_month did not match');
3020 sub match_creation_year ($$;@) {
3023 if ($y !~ /^\d+$/) {
3024 return IkiWiki::ErrorReason->new("invalid year $y");
3026 if ((localtime($IkiWiki::pagectime{$page}))[5] + 1900 == $y) {
3027 return IkiWiki::SuccessReason->new('creation_year matched');
3030 return IkiWiki::FailReason->new('creation_year did not match');
3034 sub match_user ($$;@) {
3039 if (! exists $params{user}) {
3040 return IkiWiki::ErrorReason->new("no user specified");
3043 my $regexp=IkiWiki::glob2re($user);
3045 if (defined $params{user} && $params{user}=~$regexp) {
3046 return IkiWiki::SuccessReason->new("user is $user");
3048 elsif (! defined $params{user}) {
3049 return IkiWiki::FailReason->new("not logged in");
3052 return IkiWiki::FailReason->new("user is $params{user}, not $user");
3056 sub match_admin ($$;@) {
3061 if (! exists $params{user}) {
3062 return IkiWiki::ErrorReason->new("no user specified");
3065 if (defined $params{user} && IkiWiki::is_admin($params{user})) {
3066 return IkiWiki::SuccessReason->new("user is an admin");
3068 elsif (! defined $params{user}) {
3069 return IkiWiki::FailReason->new("not logged in");
3072 return IkiWiki::FailReason->new("user is not an admin");
3076 sub match_ip ($$;@) {
3081 if (! exists $params{ip}) {
3082 return IkiWiki::ErrorReason->new("no IP specified");
3085 my $regexp=IkiWiki::glob2re(lc $ip);
3087 if (defined $params{ip} && lc $params{ip}=~$regexp) {
3088 return IkiWiki::SuccessReason->new("IP is $ip");
3091 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
3095 package IkiWiki::SortSpec;
3097 # This is in the SortSpec namespace so that the $a and $b that sort() uses
3098 # are easily available in this namespace, for cmp functions to use them.
3105 IkiWiki::pagetitle(IkiWiki::basename($a))
3107 IkiWiki::pagetitle(IkiWiki::basename($b))
3110 sub cmp_path { IkiWiki::pagetitle($a) cmp IkiWiki::pagetitle($b) }
3111 sub cmp_mtime { $IkiWiki::pagemtime{$b} <=> $IkiWiki::pagemtime{$a} }
3112 sub cmp_age { $IkiWiki::pagectime{$b} <=> $IkiWiki::pagectime{$a} }