]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki.pm
factor out a userpage function
[ikiwiki.git] / IkiWiki.pm
1 #!/usr/bin/perl
2
3 package IkiWiki;
4
5 use warnings;
6 use strict;
7 use Encode;
8 use HTML::Entities;
9 use URI::Escape q{uri_escape_utf8};
10 use POSIX;
11 use Storable;
12 use open qw{:utf8 :std};
13
14 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
15             %pagestate %wikistate %renderedfiles %oldrenderedfiles
16             %pagesources %destsources %depends %depends_simple %hooks
17             %forcerebuild %loaded_plugins};
18
19 use Exporter q{import};
20 our @EXPORT = qw(hook debug error template htmlpage deptype
21                  add_depends pagespec_match pagespec_match_list bestlink
22                  htmllink readfile writefile pagetype srcfile pagename
23                  displaytime will_render gettext urlto targetpage
24                  add_underlay pagetitle titlepage linkpage newpagefile
25                  inject add_link
26                  %config %links %pagestate %wikistate %renderedfiles
27                  %pagesources %destsources);
28 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
29 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
30 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
31
32 # Page dependency types.
33 our $DEPEND_CONTENT=1;
34 our $DEPEND_PRESENCE=2;
35 our $DEPEND_LINKS=4;
36
37 # Optimisation.
38 use Memoize;
39 memoize("abs2rel");
40 memoize("pagespec_translate");
41 memoize("template_file");
42
43 sub getsetup () {
44         wikiname => {
45                 type => "string",
46                 default => "wiki",
47                 description => "name of the wiki",
48                 safe => 1,
49                 rebuild => 1,
50         },
51         adminemail => {
52                 type => "string",
53                 default => undef,
54                 example => 'me@example.com',
55                 description => "contact email for wiki",
56                 safe => 1,
57                 rebuild => 0,
58         },
59         adminuser => {
60                 type => "string",
61                 default => [],
62                 description => "users who are wiki admins",
63                 safe => 1,
64                 rebuild => 0,
65         },
66         banned_users => {
67                 type => "string",
68                 default => [],
69                 description => "users who are banned from the wiki",
70                 safe => 1,
71                 rebuild => 0,
72         },
73         srcdir => {
74                 type => "string",
75                 default => undef,
76                 example => "$ENV{HOME}/wiki",
77                 description => "where the source of the wiki is located",
78                 safe => 0, # path
79                 rebuild => 1,
80         },
81         destdir => {
82                 type => "string",
83                 default => undef,
84                 example => "/var/www/wiki",
85                 description => "where to build the wiki",
86                 safe => 0, # path
87                 rebuild => 1,
88         },
89         url => {
90                 type => "string",
91                 default => '',
92                 example => "http://example.com/wiki",
93                 description => "base url to the wiki",
94                 safe => 1,
95                 rebuild => 1,
96         },
97         cgiurl => {
98                 type => "string",
99                 default => '',
100                 example => "http://example.com/wiki/ikiwiki.cgi",
101                 description => "url to the ikiwiki.cgi",
102                 safe => 1,
103                 rebuild => 1,
104         },
105         cgi_wrapper => {
106                 type => "string",
107                 default => '',
108                 example => "/var/www/wiki/ikiwiki.cgi",
109                 description => "filename of cgi wrapper to generate",
110                 safe => 0, # file
111                 rebuild => 0,
112         },
113         cgi_wrappermode => {
114                 type => "string",
115                 default => '06755',
116                 description => "mode for cgi_wrapper (can safely be made suid)",
117                 safe => 0,
118                 rebuild => 0,
119         },
120         rcs => {
121                 type => "string",
122                 default => '',
123                 description => "rcs backend to use",
124                 safe => 0, # don't allow overriding
125                 rebuild => 0,
126         },
127         default_plugins => {
128                 type => "internal",
129                 default => [qw{mdwn link inline meta htmlscrubber passwordauth
130                                 openid signinedit lockedit conditional
131                                 recentchanges parentlinks editpage}],
132                 description => "plugins to enable by default",
133                 safe => 0,
134                 rebuild => 1,
135         },
136         add_plugins => {
137                 type => "string",
138                 default => [],
139                 description => "plugins to add to the default configuration",
140                 safe => 1,
141                 rebuild => 1,
142         },
143         disable_plugins => {
144                 type => "string",
145                 default => [],
146                 description => "plugins to disable",
147                 safe => 1,
148                 rebuild => 1,
149         },
150         templatedir => {
151                 type => "string",
152                 default => "$installdir/share/ikiwiki/templates",
153                 description => "location of template files",
154                 advanced => 1,
155                 safe => 0, # path
156                 rebuild => 1,
157         },
158         templatedirs => {
159                 type => "internal",
160                 default => [],
161                 description => "additional directories containing template files",
162                 safe => 0,
163                 rebuild => 0,
164         },
165         underlaydir => {
166                 type => "string",
167                 default => "$installdir/share/ikiwiki/basewiki",
168                 description => "base wiki source location",
169                 advanced => 1,
170                 safe => 0, # path
171                 rebuild => 0,
172         },
173         underlaydirbase => {
174                 type => "internal",
175                 default => "$installdir/share/ikiwiki",
176                 description => "parent directory containing additional underlays",
177                 safe => 0,
178                 rebuild => 0,
179         },
180         wrappers => {
181                 type => "internal",
182                 default => [],
183                 description => "wrappers to generate",
184                 safe => 0,
185                 rebuild => 0,
186         },
187         underlaydirs => {
188                 type => "internal",
189                 default => [],
190                 description => "additional underlays to use",
191                 safe => 0,
192                 rebuild => 0,
193         },
194         verbose => {
195                 type => "boolean",
196                 example => 1,
197                 description => "display verbose messages?",
198                 safe => 1,
199                 rebuild => 0,
200         },
201         syslog => {
202                 type => "boolean",
203                 example => 1,
204                 description => "log to syslog?",
205                 safe => 1,
206                 rebuild => 0,
207         },
208         usedirs => {
209                 type => "boolean",
210                 default => 1,
211                 description => "create output files named page/index.html?",
212                 safe => 0, # changing requires manual transition
213                 rebuild => 1,
214         },
215         prefix_directives => {
216                 type => "boolean",
217                 default => 1,
218                 description => "use '!'-prefixed preprocessor directives?",
219                 safe => 0, # changing requires manual transition
220                 rebuild => 1,
221         },
222         indexpages => {
223                 type => "boolean",
224                 default => 0,
225                 description => "use page/index.mdwn source files",
226                 safe => 1,
227                 rebuild => 1,
228         },
229         discussion => {
230                 type => "boolean",
231                 default => 1,
232                 description => "enable Discussion pages?",
233                 safe => 1,
234                 rebuild => 1,
235         },
236         discussionpage => {
237                 type => "string",
238                 default => gettext("Discussion"),
239                 description => "name of Discussion pages",
240                 safe => 1,
241                 rebuild => 1,
242         },
243         sslcookie => {
244                 type => "boolean",
245                 default => 0,
246                 description => "only send cookies over SSL connections?",
247                 advanced => 1,
248                 safe => 1,
249                 rebuild => 0,
250         },
251         default_pageext => {
252                 type => "string",
253                 default => "mdwn",
254                 description => "extension to use for new pages",
255                 safe => 0, # not sanitized
256                 rebuild => 0,
257         },
258         htmlext => {
259                 type => "string",
260                 default => "html",
261                 description => "extension to use for html files",
262                 safe => 0, # not sanitized
263                 rebuild => 1,
264         },
265         timeformat => {
266                 type => "string",
267                 default => '%c',
268                 description => "strftime format string to display date",
269                 advanced => 1,
270                 safe => 1,
271                 rebuild => 1,
272         },
273         locale => {
274                 type => "string",
275                 default => undef,
276                 example => "en_US.UTF-8",
277                 description => "UTF-8 locale to use",
278                 advanced => 1,
279                 safe => 0,
280                 rebuild => 1,
281         },
282         userdir => {
283                 type => "string",
284                 default => "",
285                 example => "users",
286                 description => "put user pages below specified page",
287                 safe => 1,
288                 rebuild => 1,
289         },
290         numbacklinks => {
291                 type => "integer",
292                 default => 10,
293                 description => "how many backlinks to show before hiding excess (0 to show all)",
294                 safe => 1,
295                 rebuild => 1,
296         },
297         hardlink => {
298                 type => "boolean",
299                 default => 0,
300                 description => "attempt to hardlink source files? (optimisation for large files)",
301                 advanced => 1,
302                 safe => 0, # paranoia
303                 rebuild => 0,
304         },
305         umask => {
306                 type => "integer",
307                 example => "022",
308                 description => "force ikiwiki to use a particular umask",
309                 advanced => 1,
310                 safe => 0, # paranoia
311                 rebuild => 0,
312         },
313         wrappergroup => {
314                 type => "string",
315                 example => "ikiwiki",
316                 description => "group for wrappers to run in",
317                 advanced => 1,
318                 safe => 0, # paranoia
319                 rebuild => 0,
320         },
321         libdir => {
322                 type => "string",
323                 default => "",
324                 example => "$ENV{HOME}/.ikiwiki/",
325                 description => "extra library and plugin directory",
326                 advanced => 1,
327                 safe => 0, # directory
328                 rebuild => 0,
329         },
330         ENV => {
331                 type => "string", 
332                 default => {},
333                 description => "environment variables",
334                 safe => 0, # paranoia
335                 rebuild => 0,
336         },
337         exclude => {
338                 type => "string",
339                 default => undef,
340                 example => '\.wav$',
341                 description => "regexp of source files to ignore",
342                 advanced => 1,
343                 safe => 0, # regexp
344                 rebuild => 1,
345         },
346         wiki_file_prune_regexps => {
347                 type => "internal",
348                 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
349                         qr/\.x?html?$/, qr/\.ikiwiki-new$/,
350                         qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
351                         qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
352                         qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
353                 description => "regexps of source files to ignore",
354                 safe => 0,
355                 rebuild => 1,
356         },
357         wiki_file_chars => {
358                 type => "string",
359                 description => "specifies the characters that are allowed in source filenames",
360                 default => "-[:alnum:]+/.:_",
361                 safe => 0,
362                 rebuild => 1,
363         },
364         wiki_file_regexp => {
365                 type => "internal",
366                 description => "regexp of legal source files",
367                 safe => 0,
368                 rebuild => 1,
369         },
370         web_commit_regexp => {
371                 type => "internal",
372                 default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
373                 description => "regexp to parse web commits from logs",
374                 safe => 0,
375                 rebuild => 0,
376         },
377         cgi => {
378                 type => "internal",
379                 default => 0,
380                 description => "run as a cgi",
381                 safe => 0,
382                 rebuild => 0,
383         },
384         cgi_disable_uploads => {
385                 type => "internal",
386                 default => 1,
387                 description => "whether CGI should accept file uploads",
388                 safe => 0,
389                 rebuild => 0,
390         },
391         post_commit => {
392                 type => "internal",
393                 default => 0,
394                 description => "run as a post-commit hook",
395                 safe => 0,
396                 rebuild => 0,
397         },
398         rebuild => {
399                 type => "internal",
400                 default => 0,
401                 description => "running in rebuild mode",
402                 safe => 0,
403                 rebuild => 0,
404         },
405         setup => {
406                 type => "internal",
407                 default => undef,
408                 description => "running in setup mode",
409                 safe => 0,
410                 rebuild => 0,
411         },
412         refresh => {
413                 type => "internal",
414                 default => 0,
415                 description => "running in refresh mode",
416                 safe => 0,
417                 rebuild => 0,
418         },
419         test_receive => {
420                 type => "internal",
421                 default => 0,
422                 description => "running in receive test mode",
423                 safe => 0,
424                 rebuild => 0,
425         },
426         getctime => {
427                 type => "internal",
428                 default => 0,
429                 description => "running in getctime mode",
430                 safe => 0,
431                 rebuild => 0,
432         },
433         w3mmode => {
434                 type => "internal",
435                 default => 0,
436                 description => "running in w3mmode",
437                 safe => 0,
438                 rebuild => 0,
439         },
440         wikistatedir => {
441                 type => "internal",
442                 default => undef,
443                 description => "path to the .ikiwiki directory holding ikiwiki state",
444                 safe => 0,
445                 rebuild => 0,
446         },
447         setupfile => {
448                 type => "internal",
449                 default => undef,
450                 description => "path to setup file",
451                 safe => 0,
452                 rebuild => 0,
453         },
454         allow_symlinks_before_srcdir => {
455                 type => "boolean",
456                 default => 0,
457                 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
458                 safe => 0,
459                 rebuild => 0,
460         },
461 }
462
463 sub defaultconfig () {
464         my %s=getsetup();
465         my @ret;
466         foreach my $key (keys %s) {
467                 push @ret, $key, $s{$key}->{default};
468         }
469         use Data::Dumper;
470         return @ret;
471 }
472
473 sub checkconfig () {
474         # locale stuff; avoid LC_ALL since it overrides everything
475         if (defined $ENV{LC_ALL}) {
476                 $ENV{LANG} = $ENV{LC_ALL};
477                 delete $ENV{LC_ALL};
478         }
479         if (defined $config{locale}) {
480                 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
481                         $ENV{LANG}=$config{locale};
482                         define_gettext();
483                 }
484         }
485                 
486         if (! defined $config{wiki_file_regexp}) {
487                 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
488         }
489
490         if (ref $config{ENV} eq 'HASH') {
491                 foreach my $val (keys %{$config{ENV}}) {
492                         $ENV{$val}=$config{ENV}{$val};
493                 }
494         }
495
496         if ($config{w3mmode}) {
497                 eval q{use Cwd q{abs_path}};
498                 error($@) if $@;
499                 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
500                 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
501                 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
502                         unless $config{cgiurl} =~ m!file:///!;
503                 $config{url}="file://".$config{destdir};
504         }
505
506         if ($config{cgi} && ! length $config{url}) {
507                 error(gettext("Must specify url to wiki with --url when using --cgi"));
508         }
509         
510         $config{wikistatedir}="$config{srcdir}/.ikiwiki"
511                 unless exists $config{wikistatedir} && defined $config{wikistatedir};
512
513         if (defined $config{umask}) {
514                 umask(possibly_foolish_untaint($config{umask}));
515         }
516
517         run_hooks(checkconfig => sub { shift->() });
518
519         return 1;
520 }
521
522 sub listplugins () {
523         my %ret;
524
525         foreach my $dir (@INC, $config{libdir}) {
526                 next unless defined $dir && length $dir;
527                 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
528                         my ($plugin)=$file=~/.*\/(.*)\.pm$/;
529                         $ret{$plugin}=1;
530                 }
531         }
532         foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
533                 next unless defined $dir && length $dir;
534                 foreach my $file (glob("$dir/plugins/*")) {
535                         $ret{basename($file)}=1 if -x $file;
536                 }
537         }
538
539         return keys %ret;
540 }
541
542 sub loadplugins () {
543         if (defined $config{libdir} && length $config{libdir}) {
544                 unshift @INC, possibly_foolish_untaint($config{libdir});
545         }
546
547         foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
548                 loadplugin($plugin);
549         }
550         
551         if ($config{rcs}) {
552                 if (exists $hooks{rcs}) {
553                         error(gettext("cannot use multiple rcs plugins"));
554                 }
555                 loadplugin($config{rcs});
556         }
557         if (! exists $hooks{rcs}) {
558                 loadplugin("norcs");
559         }
560
561         run_hooks(getopt => sub { shift->() });
562         if (grep /^-/, @ARGV) {
563                 print STDERR "Unknown option (or missing parameter): $_\n"
564                         foreach grep /^-/, @ARGV;
565                 usage();
566         }
567
568         return 1;
569 }
570
571 sub loadplugin ($) {
572         my $plugin=shift;
573
574         return if grep { $_ eq $plugin} @{$config{disable_plugins}};
575
576         foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
577                          "$installdir/lib/ikiwiki") {
578                 if (defined $dir && -x "$dir/plugins/$plugin") {
579                         eval { require IkiWiki::Plugin::external };
580                         if ($@) {
581                                 my $reason=$@;
582                                 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
583                         }
584                         import IkiWiki::Plugin::external "$dir/plugins/$plugin";
585                         $loaded_plugins{$plugin}=1;
586                         return 1;
587                 }
588         }
589
590         my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
591         eval qq{use $mod};
592         if ($@) {
593                 error("Failed to load plugin $mod: $@");
594         }
595         $loaded_plugins{$plugin}=1;
596         return 1;
597 }
598
599 sub error ($;$) {
600         my $message=shift;
601         my $cleaner=shift;
602         log_message('err' => $message) if $config{syslog};
603         if (defined $cleaner) {
604                 $cleaner->();
605         }
606         die $message."\n";
607 }
608
609 sub debug ($) {
610         return unless $config{verbose};
611         return log_message(debug => @_);
612 }
613
614 my $log_open=0;
615 sub log_message ($$) {
616         my $type=shift;
617
618         if ($config{syslog}) {
619                 require Sys::Syslog;
620                 if (! $log_open) {
621                         Sys::Syslog::setlogsock('unix');
622                         Sys::Syslog::openlog('ikiwiki', '', 'user');
623                         $log_open=1;
624                 }
625                 return eval {
626                         Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
627                 };
628         }
629         elsif (! $config{cgi}) {
630                 return print "@_\n";
631         }
632         else {
633                 return print STDERR "@_\n";
634         }
635 }
636
637 sub possibly_foolish_untaint ($) {
638         my $tainted=shift;
639         my ($untainted)=$tainted=~/(.*)/s;
640         return $untainted;
641 }
642
643 sub basename ($) {
644         my $file=shift;
645
646         $file=~s!.*/+!!;
647         return $file;
648 }
649
650 sub dirname ($) {
651         my $file=shift;
652
653         $file=~s!/*[^/]+$!!;
654         return $file;
655 }
656
657 sub isinternal ($) {
658         my $page=shift;
659         return exists $pagesources{$page} &&
660                 $pagesources{$page} =~ /\._([^.]+)$/;
661 }
662
663 sub pagetype ($) {
664         my $file=shift;
665         
666         if ($file =~ /\.([^.]+)$/) {
667                 return $1 if exists $hooks{htmlize}{$1};
668         }
669         my $base=basename($file);
670         if (exists $hooks{htmlize}{$base} &&
671             $hooks{htmlize}{$base}{noextension}) {
672                 return $base;
673         }
674         return;
675 }
676
677 my %pagename_cache;
678
679 sub pagename ($) {
680         my $file=shift;
681
682         if (exists $pagename_cache{$file}) {
683                 return $pagename_cache{$file};
684         }
685
686         my $type=pagetype($file);
687         my $page=$file;
688         $page=~s/\Q.$type\E*$//
689                 if defined $type && !$hooks{htmlize}{$type}{keepextension}
690                         && !$hooks{htmlize}{$type}{noextension};
691         if ($config{indexpages} && $page=~/(.*)\/index$/) {
692                 $page=$1;
693         }
694
695         $pagename_cache{$file} = $page;
696         return $page;
697 }
698
699 sub newpagefile ($$) {
700         my $page=shift;
701         my $type=shift;
702
703         if (! $config{indexpages} || $page eq 'index') {
704                 return $page.".".$type;
705         }
706         else {
707                 return $page."/index.".$type;
708         }
709 }
710
711 sub targetpage ($$;$) {
712         my $page=shift;
713         my $ext=shift;
714         my $filename=shift;
715         
716         if (defined $filename) {
717                 return $page."/".$filename.".".$ext;
718         }
719         elsif (! $config{usedirs} || $page eq 'index') {
720                 return $page.".".$ext;
721         }
722         else {
723                 return $page."/index.".$ext;
724         }
725 }
726
727 sub htmlpage ($) {
728         my $page=shift;
729         
730         return targetpage($page, $config{htmlext});
731 }
732
733 sub srcfile_stat {
734         my $file=shift;
735         my $nothrow=shift;
736
737         return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
738         foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
739                 return "$dir/$file", stat(_) if -e "$dir/$file";
740         }
741         error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
742         return;
743 }
744
745 sub srcfile ($;$) {
746         return (srcfile_stat(@_))[0];
747 }
748
749 sub add_underlay ($) {
750         my $dir=shift;
751
752         if ($dir !~ /^\//) {
753                 $dir="$config{underlaydirbase}/$dir";
754         }
755
756         if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
757                 unshift @{$config{underlaydirs}}, $dir;
758         }
759
760         return 1;
761 }
762
763 sub readfile ($;$$) {
764         my $file=shift;
765         my $binary=shift;
766         my $wantfd=shift;
767
768         if (-l $file) {
769                 error("cannot read a symlink ($file)");
770         }
771         
772         local $/=undef;
773         open (my $in, "<", $file) || error("failed to read $file: $!");
774         binmode($in) if ($binary);
775         return \*$in if $wantfd;
776         my $ret=<$in>;
777         # check for invalid utf-8, and toss it back to avoid crashes
778         if (! utf8::valid($ret)) {
779                 $ret=encode_utf8($ret);
780         }
781         close $in || error("failed to read $file: $!");
782         return $ret;
783 }
784
785 sub prep_writefile ($$) {
786         my $file=shift;
787         my $destdir=shift;
788         
789         my $test=$file;
790         while (length $test) {
791                 if (-l "$destdir/$test") {
792                         error("cannot write to a symlink ($test)");
793                 }
794                 $test=dirname($test);
795         }
796
797         my $dir=dirname("$destdir/$file");
798         if (! -d $dir) {
799                 my $d="";
800                 foreach my $s (split(m!/+!, $dir)) {
801                         $d.="$s/";
802                         if (! -d $d) {
803                                 mkdir($d) || error("failed to create directory $d: $!");
804                         }
805                 }
806         }
807
808         return 1;
809 }
810
811 sub writefile ($$$;$$) {
812         my $file=shift; # can include subdirs
813         my $destdir=shift; # directory to put file in
814         my $content=shift;
815         my $binary=shift;
816         my $writer=shift;
817         
818         prep_writefile($file, $destdir);
819         
820         my $newfile="$destdir/$file.ikiwiki-new";
821         if (-l $newfile) {
822                 error("cannot write to a symlink ($newfile)");
823         }
824         
825         my $cleanup = sub { unlink($newfile) };
826         open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
827         binmode($out) if ($binary);
828         if ($writer) {
829                 $writer->(\*$out, $cleanup);
830         }
831         else {
832                 print $out $content or error("failed writing to $newfile: $!", $cleanup);
833         }
834         close $out || error("failed saving $newfile: $!", $cleanup);
835         rename($newfile, "$destdir/$file") || 
836                 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
837
838         return 1;
839 }
840
841 my %cleared;
842 sub will_render ($$;$) {
843         my $page=shift;
844         my $dest=shift;
845         my $clear=shift;
846
847         # Important security check.
848         if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
849             ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
850                 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
851         }
852
853         if (! $clear || $cleared{$page}) {
854                 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
855         }
856         else {
857                 foreach my $old (@{$renderedfiles{$page}}) {
858                         delete $destsources{$old};
859                 }
860                 $renderedfiles{$page}=[$dest];
861                 $cleared{$page}=1;
862         }
863         $destsources{$dest}=$page;
864
865         return 1;
866 }
867
868 sub bestlink ($$) {
869         my $page=shift;
870         my $link=shift;
871         
872         my $cwd=$page;
873         if ($link=~s/^\/+//) {
874                 # absolute links
875                 $cwd="";
876         }
877         $link=~s/\/$//;
878
879         do {
880                 my $l=$cwd;
881                 $l.="/" if length $l;
882                 $l.=$link;
883
884                 if (exists $pagesources{$l}) {
885                         return $l;
886                 }
887                 elsif (exists $pagecase{lc $l}) {
888                         return $pagecase{lc $l};
889                 }
890         } while $cwd=~s{/?[^/]+$}{};
891
892         if (length $config{userdir}) {
893                 my $l = "$config{userdir}/".lc($link);
894                 if (exists $pagesources{$l}) {
895                         return $l;
896                 }
897                 elsif (exists $pagecase{lc $l}) {
898                         return $pagecase{lc $l};
899                 }
900         }
901
902         #print STDERR "warning: page $page, broken link: $link\n";
903         return "";
904 }
905
906 sub isinlinableimage ($) {
907         my $file=shift;
908         
909         return $file =~ /\.(png|gif|jpg|jpeg)$/i;
910 }
911
912 sub pagetitle ($;$) {
913         my $page=shift;
914         my $unescaped=shift;
915
916         if ($unescaped) {
917                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
918         }
919         else {
920                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
921         }
922
923         return $page;
924 }
925
926 sub titlepage ($) {
927         my $title=shift;
928         # support use w/o %config set
929         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
930         $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
931         return $title;
932 }
933
934 sub linkpage ($) {
935         my $link=shift;
936         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
937         $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
938         return $link;
939 }
940
941 sub cgiurl (@) {
942         my %params=@_;
943
944         return $config{cgiurl}."?".
945                 join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
946 }
947
948 sub baseurl (;$) {
949         my $page=shift;
950
951         return "$config{url}/" if ! defined $page;
952         
953         $page=htmlpage($page);
954         $page=~s/[^\/]+$//;
955         $page=~s/[^\/]+\//..\//g;
956         return $page;
957 }
958
959 sub abs2rel ($$) {
960         # Work around very innefficient behavior in File::Spec if abs2rel
961         # is passed two relative paths. It's much faster if paths are
962         # absolute! (Debian bug #376658; fixed in debian unstable now)
963         my $path="/".shift;
964         my $base="/".shift;
965
966         require File::Spec;
967         my $ret=File::Spec->abs2rel($path, $base);
968         $ret=~s/^// if defined $ret;
969         return $ret;
970 }
971
972 sub displaytime ($;$) {
973         # Plugins can override this function to mark up the time to
974         # display.
975         return '<span class="date">'.formattime(@_).'</span>';
976 }
977
978 sub formattime ($;$) {
979         # Plugins can override this function to format the time.
980         my $time=shift;
981         my $format=shift;
982         if (! defined $format) {
983                 $format=$config{timeformat};
984         }
985
986         # strftime doesn't know about encodings, so make sure
987         # its output is properly treated as utf8
988         return decode_utf8(POSIX::strftime($format, localtime($time)));
989 }
990
991 sub beautify_urlpath ($) {
992         my $url=shift;
993
994         # Ensure url is not an empty link, and if necessary,
995         # add ./ to avoid colon confusion.
996         if ($url !~ /^\// && $url !~ /^\.\.?\//) {
997                 $url="./$url";
998         }
999
1000         if ($config{usedirs}) {
1001                 $url =~ s!/index.$config{htmlext}$!/!;
1002         }
1003
1004         return $url;
1005 }
1006
1007 sub urlto ($$;$) {
1008         my $to=shift;
1009         my $from=shift;
1010         my $absolute=shift;
1011         
1012         if (! length $to) {
1013                 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
1014         }
1015
1016         if (! $destsources{$to}) {
1017                 $to=htmlpage($to);
1018         }
1019
1020         if ($absolute) {
1021                 return $config{url}.beautify_urlpath("/".$to);
1022         }
1023
1024         my $link = abs2rel($to, dirname(htmlpage($from)));
1025
1026         return beautify_urlpath($link);
1027 }
1028
1029 sub htmllink ($$$;@) {
1030         my $lpage=shift; # the page doing the linking
1031         my $page=shift; # the page that will contain the link (different for inline)
1032         my $link=shift;
1033         my %opts=@_;
1034
1035         $link=~s/\/$//;
1036
1037         my $bestlink;
1038         if (! $opts{forcesubpage}) {
1039                 $bestlink=bestlink($lpage, $link);
1040         }
1041         else {
1042                 $bestlink="$lpage/".lc($link);
1043         }
1044
1045         my $linktext;
1046         if (defined $opts{linktext}) {
1047                 $linktext=$opts{linktext};
1048         }
1049         else {
1050                 $linktext=pagetitle(basename($link));
1051         }
1052         
1053         return "<span class=\"selflink\">$linktext</span>"
1054                 if length $bestlink && $page eq $bestlink &&
1055                    ! defined $opts{anchor};
1056         
1057         if (! $destsources{$bestlink}) {
1058                 $bestlink=htmlpage($bestlink);
1059
1060                 if (! $destsources{$bestlink}) {
1061                         return $linktext unless length $config{cgiurl};
1062                         return "<span class=\"createlink\"><a href=\"".
1063                                 cgiurl(
1064                                         do => "create",
1065                                         page => lc($link),
1066                                         from => $lpage
1067                                 ).
1068                                 "\" rel=\"nofollow\">?</a>$linktext</span>"
1069                 }
1070         }
1071         
1072         $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1073         $bestlink=beautify_urlpath($bestlink);
1074         
1075         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1076                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1077         }
1078
1079         if (defined $opts{anchor}) {
1080                 $bestlink.="#".$opts{anchor};
1081         }
1082
1083         my @attrs;
1084         foreach my $attr (qw{rel class title}) {
1085                 if (defined $opts{$attr}) {
1086                         push @attrs, " $attr=\"$opts{$attr}\"";
1087                 }
1088         }
1089
1090         return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1091 }
1092
1093 sub userpage ($) {
1094         my $user=shift;
1095         return length $config{userdir} ? "$config{userdir}/$user" : $user;
1096 }
1097
1098 sub openiduser ($) {
1099         my $user=shift;
1100
1101         if ($user =~ m!^https?://! &&
1102             eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1103                 my $display;
1104
1105                 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1106                         # this works in at least 2.x
1107                         $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1108                 }
1109                 else {
1110                         # this only works in 1.x
1111                         my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1112                         $display=$oid->display;
1113                 }
1114
1115                 # Convert "user.somehost.com" to "user [somehost.com]"
1116                 # (also "user.somehost.co.uk")
1117                 if ($display !~ /\[/) {
1118                         $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1119                 }
1120                 # Convert "http://somehost.com/user" to "user [somehost.com]".
1121                 # (also "https://somehost.com/user/")
1122                 if ($display !~ /\[/) {
1123                         $display=~s/^https?:\/\/(.+)\/([^\/]+)\/?$/$2 [$1]/;
1124                 }
1125                 $display=~s!^https?://!!; # make sure this is removed
1126                 eval q{use CGI 'escapeHTML'};
1127                 error($@) if $@;
1128                 return escapeHTML($display);
1129         }
1130         return;
1131 }
1132
1133 sub htmlize ($$$$) {
1134         my $page=shift;
1135         my $destpage=shift;
1136         my $type=shift;
1137         my $content=shift;
1138         
1139         my $oneline = $content !~ /\n/;
1140
1141         if (exists $hooks{htmlize}{$type}) {
1142                 $content=$hooks{htmlize}{$type}{call}->(
1143                         page => $page,
1144                         content => $content,
1145                 );
1146         }
1147         else {
1148                 error("htmlization of $type not supported");
1149         }
1150
1151         run_hooks(sanitize => sub {
1152                 $content=shift->(
1153                         page => $page,
1154                         destpage => $destpage,
1155                         content => $content,
1156                 );
1157         });
1158         
1159         if ($oneline) {
1160                 # hack to get rid of enclosing junk added by markdown
1161                 # and other htmlizers
1162                 $content=~s/^<p>//i;
1163                 $content=~s/<\/p>$//i;
1164                 chomp $content;
1165         }
1166
1167         return $content;
1168 }
1169
1170 sub linkify ($$$) {
1171         my $page=shift;
1172         my $destpage=shift;
1173         my $content=shift;
1174
1175         run_hooks(linkify => sub {
1176                 $content=shift->(
1177                         page => $page,
1178                         destpage => $destpage,
1179                         content => $content,
1180                 );
1181         });
1182         
1183         return $content;
1184 }
1185
1186 our %preprocessing;
1187 our $preprocess_preview=0;
1188 sub preprocess ($$$;$$) {
1189         my $page=shift; # the page the data comes from
1190         my $destpage=shift; # the page the data will appear in (different for inline)
1191         my $content=shift;
1192         my $scan=shift;
1193         my $preview=shift;
1194
1195         # Using local because it needs to be set within any nested calls
1196         # of this function.
1197         local $preprocess_preview=$preview if defined $preview;
1198
1199         my $handle=sub {
1200                 my $escape=shift;
1201                 my $prefix=shift;
1202                 my $command=shift;
1203                 my $params=shift;
1204                 $params="" if ! defined $params;
1205
1206                 if (length $escape) {
1207                         return "[[$prefix$command $params]]";
1208                 }
1209                 elsif (exists $hooks{preprocess}{$command}) {
1210                         return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1211                         # Note: preserve order of params, some plugins may
1212                         # consider it significant.
1213                         my @params;
1214                         while ($params =~ m{
1215                                 (?:([-\w]+)=)?          # 1: named parameter key?
1216                                 (?:
1217                                         """(.*?)"""     # 2: triple-quoted value
1218                                 |
1219                                         "([^"]+)"       # 3: single-quoted value
1220                                 |
1221                                         (\S+)           # 4: unquoted value
1222                                 )
1223                                 (?:\s+|$)               # delimiter to next param
1224                         }sgx) {
1225                                 my $key=$1;
1226                                 my $val;
1227                                 if (defined $2) {
1228                                         $val=$2;
1229                                         $val=~s/\r\n/\n/mg;
1230                                         $val=~s/^\n+//g;
1231                                         $val=~s/\n+$//g;
1232                                 }
1233                                 elsif (defined $3) {
1234                                         $val=$3;
1235                                 }
1236                                 elsif (defined $4) {
1237                                         $val=$4;
1238                                 }
1239
1240                                 if (defined $key) {
1241                                         push @params, $key, $val;
1242                                 }
1243                                 else {
1244                                         push @params, $val, '';
1245                                 }
1246                         }
1247                         if ($preprocessing{$page}++ > 3) {
1248                                 # Avoid loops of preprocessed pages preprocessing
1249                                 # other pages that preprocess them, etc.
1250                                 return "[[!$command <span class=\"error\">".
1251                                         sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1252                                                 $page, $preprocessing{$page}).
1253                                         "</span>]]";
1254                         }
1255                         my $ret;
1256                         if (! $scan) {
1257                                 $ret=eval {
1258                                         $hooks{preprocess}{$command}{call}->(
1259                                                 @params,
1260                                                 page => $page,
1261                                                 destpage => $destpage,
1262                                                 preview => $preprocess_preview,
1263                                         );
1264                                 };
1265                                 if ($@) {
1266                                         my $error=$@;
1267                                         chomp $error;
1268                                         $ret="[[!$command <span class=\"error\">".
1269                                                 gettext("Error").": $error"."</span>]]";
1270                                 }
1271                         }
1272                         else {
1273                                 # use void context during scan pass
1274                                 eval {
1275                                         $hooks{preprocess}{$command}{call}->(
1276                                                 @params,
1277                                                 page => $page,
1278                                                 destpage => $destpage,
1279                                                 preview => $preprocess_preview,
1280                                         );
1281                                 };
1282                                 $ret="";
1283                         }
1284                         $preprocessing{$page}--;
1285                         return $ret;
1286                 }
1287                 else {
1288                         return "[[$prefix$command $params]]";
1289                 }
1290         };
1291         
1292         my $regex;
1293         if ($config{prefix_directives}) {
1294                 $regex = qr{
1295                         (\\?)           # 1: escape?
1296                         \[\[(!)         # directive open; 2: prefix
1297                         ([-\w]+)        # 3: command
1298                         (               # 4: the parameters..
1299                                 \s+     # Must have space if parameters present
1300                                 (?:
1301                                         (?:[-\w]+=)?            # named parameter key?
1302                                         (?:
1303                                                 """.*?"""       # triple-quoted value
1304                                                 |
1305                                                 "[^"]+"         # single-quoted value
1306                                                 |
1307                                                 [^"\s\]]+       # unquoted value
1308                                         )
1309                                         \s*                     # whitespace or end
1310                                                                 # of directive
1311                                 )
1312                         *)?             # 0 or more parameters
1313                         \]\]            # directive closed
1314                 }sx;
1315         }
1316         else {
1317                 $regex = qr{
1318                         (\\?)           # 1: escape?
1319                         \[\[(!?)        # directive open; 2: optional prefix
1320                         ([-\w]+)        # 3: command
1321                         \s+
1322                         (               # 4: the parameters..
1323                                 (?:
1324                                         (?:[-\w]+=)?            # named parameter key?
1325                                         (?:
1326                                                 """.*?"""       # triple-quoted value
1327                                                 |
1328                                                 "[^"]+"         # single-quoted value
1329                                                 |
1330                                                 [^"\s\]]+       # unquoted value
1331                                         )
1332                                         \s*                     # whitespace or end
1333                                                                 # of directive
1334                                 )
1335                         *)              # 0 or more parameters
1336                         \]\]            # directive closed
1337                 }sx;
1338         }
1339
1340         $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1341         return $content;
1342 }
1343
1344 sub filter ($$$) {
1345         my $page=shift;
1346         my $destpage=shift;
1347         my $content=shift;
1348
1349         run_hooks(filter => sub {
1350                 $content=shift->(page => $page, destpage => $destpage, 
1351                         content => $content);
1352         });
1353
1354         return $content;
1355 }
1356
1357 sub indexlink () {
1358         return "<a href=\"$config{url}\">$config{wikiname}</a>";
1359 }
1360
1361 sub check_canedit ($$$;$) {
1362         my $page=shift;
1363         my $q=shift;
1364         my $session=shift;
1365         my $nonfatal=shift;
1366         
1367         my $canedit;
1368         run_hooks(canedit => sub {
1369                 return if defined $canedit;
1370                 my $ret=shift->($page, $q, $session);
1371                 if (defined $ret) {
1372                         if ($ret eq "") {
1373                                 $canedit=1;
1374                         }
1375                         elsif (ref $ret eq 'CODE') {
1376                                 $ret->() unless $nonfatal;
1377                                 $canedit=0;
1378                         }
1379                         elsif (defined $ret) {
1380                                 error($ret) unless $nonfatal;
1381                                 $canedit=0;
1382                         }
1383                 }
1384         });
1385         return defined $canedit ? $canedit : 1;
1386 }
1387
1388 sub check_content (@) {
1389         my %params=@_;
1390         
1391         return 1 if ! exists $hooks{checkcontent}; # optimisation
1392
1393         if (exists $pagesources{$params{page}}) {
1394                 my @diff;
1395                 my %old=map { $_ => 1 }
1396                         split("\n", readfile(srcfile($pagesources{$params{page}})));
1397                 foreach my $line (split("\n", $params{content})) {
1398                         push @diff, $line if ! exists $old{$line};
1399                 }
1400                 $params{diff}=join("\n", @diff);
1401         }
1402
1403         my $ok;
1404         run_hooks(checkcontent => sub {
1405                 return if defined $ok;
1406                 my $ret=shift->(%params);
1407                 if (defined $ret) {
1408                         if ($ret eq "") {
1409                                 $ok=1;
1410                         }
1411                         elsif (ref $ret eq 'CODE') {
1412                                 $ret->() unless $params{nonfatal};
1413                                 $ok=0;
1414                         }
1415                         elsif (defined $ret) {
1416                                 error($ret) unless $params{nonfatal};
1417                                 $ok=0;
1418                         }
1419                 }
1420
1421         });
1422         return defined $ok ? $ok : 1;
1423 }
1424
1425 my $wikilock;
1426
1427 sub lockwiki () {
1428         # Take an exclusive lock on the wiki to prevent multiple concurrent
1429         # run issues. The lock will be dropped on program exit.
1430         if (! -d $config{wikistatedir}) {
1431                 mkdir($config{wikistatedir});
1432         }
1433         open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1434                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1435         if (! flock($wikilock, 2)) { # LOCK_EX
1436                 error("failed to get lock");
1437         }
1438         return 1;
1439 }
1440
1441 sub unlockwiki () {
1442         POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1443         return close($wikilock) if $wikilock;
1444         return;
1445 }
1446
1447 my $commitlock;
1448
1449 sub commit_hook_enabled () {
1450         open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1451                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1452         if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1453                 close($commitlock) || error("failed closing commitlock: $!");
1454                 return 0;
1455         }
1456         close($commitlock) || error("failed closing commitlock: $!");
1457         return 1;
1458 }
1459
1460 sub disable_commit_hook () {
1461         open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1462                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1463         if (! flock($commitlock, 2)) { # LOCK_EX
1464                 error("failed to get commit lock");
1465         }
1466         return 1;
1467 }
1468
1469 sub enable_commit_hook () {
1470         return close($commitlock) if $commitlock;
1471         return;
1472 }
1473
1474 sub loadindex () {
1475         %oldrenderedfiles=%pagectime=();
1476         if (! $config{rebuild}) {
1477                 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1478                 %destsources=%renderedfiles=%pagecase=%pagestate=
1479                 %depends_simple=();
1480         }
1481         my $in;
1482         if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1483                 if (-e "$config{wikistatedir}/index") {
1484                         system("ikiwiki-transition", "indexdb", $config{srcdir});
1485                         open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1486                 }
1487                 else {
1488                         return;
1489                 }
1490         }
1491
1492         my $index=Storable::fd_retrieve($in);
1493         if (! defined $index) {
1494                 return 0;
1495         }
1496
1497         my $pages;
1498         if (exists $index->{version} && ! ref $index->{version}) {
1499                 $pages=$index->{page};
1500                 %wikistate=%{$index->{state}};
1501         }
1502         else {
1503                 $pages=$index;
1504                 %wikistate=();
1505         }
1506
1507         foreach my $src (keys %$pages) {
1508                 my $d=$pages->{$src};
1509                 my $page=pagename($src);
1510                 $pagectime{$page}=$d->{ctime};
1511                 if (! $config{rebuild}) {
1512                         $pagesources{$page}=$src;
1513                         $pagemtime{$page}=$d->{mtime};
1514                         $renderedfiles{$page}=$d->{dest};
1515                         if (exists $d->{links} && ref $d->{links}) {
1516                                 $links{$page}=$d->{links};
1517                                 $oldlinks{$page}=[@{$d->{links}}];
1518                         }
1519                         if (ref $d->{depends_simple} eq 'ARRAY') {
1520                                 # old format
1521                                 $depends_simple{$page}={
1522                                         map { $_ => 1 } @{$d->{depends_simple}}
1523                                 };
1524                         }
1525                         elsif (exists $d->{depends_simple}) {
1526                                 $depends_simple{$page}=$d->{depends_simple};
1527                         }
1528                         if (exists $d->{dependslist}) {
1529                                 # old format
1530                                 $depends{$page}={
1531                                         map { $_ => $DEPEND_CONTENT }
1532                                                 @{$d->{dependslist}}
1533                                 };
1534                         }
1535                         elsif (exists $d->{depends} && ! ref $d->{depends}) {
1536                                 # old format
1537                                 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
1538                         }
1539                         elsif (exists $d->{depends}) {
1540                                 $depends{$page}=$d->{depends};
1541                         }
1542                         if (exists $d->{state}) {
1543                                 $pagestate{$page}=$d->{state};
1544                         }
1545                 }
1546                 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1547         }
1548         foreach my $page (keys %pagesources) {
1549                 $pagecase{lc $page}=$page;
1550         }
1551         foreach my $page (keys %renderedfiles) {
1552                 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1553         }
1554         return close($in);
1555 }
1556
1557 sub saveindex () {
1558         run_hooks(savestate => sub { shift->() });
1559
1560         my %hookids;
1561         foreach my $type (keys %hooks) {
1562                 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1563         }
1564         my @hookids=keys %hookids;
1565
1566         if (! -d $config{wikistatedir}) {
1567                 mkdir($config{wikistatedir});
1568         }
1569         my $newfile="$config{wikistatedir}/indexdb.new";
1570         my $cleanup = sub { unlink($newfile) };
1571         open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1572
1573         my %index;
1574         foreach my $page (keys %pagemtime) {
1575                 next unless $pagemtime{$page};
1576                 my $src=$pagesources{$page};
1577
1578                 $index{page}{$src}={
1579                         ctime => $pagectime{$page},
1580                         mtime => $pagemtime{$page},
1581                         dest => $renderedfiles{$page},
1582                         links => $links{$page},
1583                 };
1584
1585                 if (exists $depends{$page}) {
1586                         $index{page}{$src}{depends} = $depends{$page};
1587                 }
1588
1589                 if (exists $depends_simple{$page}) {
1590                         $index{page}{$src}{depends_simple} = $depends_simple{$page};
1591                 }
1592
1593                 if (exists $pagestate{$page}) {
1594                         foreach my $id (@hookids) {
1595                                 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1596                                         $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1597                                 }
1598                         }
1599                 }
1600         }
1601
1602         $index{state}={};
1603         foreach my $id (@hookids) {
1604                 foreach my $key (keys %{$wikistate{$id}}) {
1605                         $index{state}{$id}{$key}=$wikistate{$id}{$key};
1606                 }
1607         }
1608         
1609         $index{version}="3";
1610         my $ret=Storable::nstore_fd(\%index, $out);
1611         return if ! defined $ret || ! $ret;
1612         close $out || error("failed saving to $newfile: $!", $cleanup);
1613         rename($newfile, "$config{wikistatedir}/indexdb") ||
1614                 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1615         
1616         return 1;
1617 }
1618
1619 sub template_file ($) {
1620         my $template=shift;
1621
1622         foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
1623                          "$installdir/share/ikiwiki/templates") {
1624                 return "$dir/$template" if -e "$dir/$template";
1625         }
1626         return;
1627 }
1628
1629 sub template_params (@) {
1630         my $filename=template_file(shift);
1631
1632         if (! defined $filename) {
1633                 return if wantarray;
1634                 return "";
1635         }
1636
1637         my @ret=(
1638                 filter => sub {
1639                         my $text_ref = shift;
1640                         ${$text_ref} = decode_utf8(${$text_ref});
1641                 },
1642                 filename => $filename,
1643                 loop_context_vars => 1,
1644                 die_on_bad_params => 0,
1645                 @_
1646         );
1647         return wantarray ? @ret : {@ret};
1648 }
1649
1650 sub template ($;@) {
1651         require HTML::Template;
1652         return HTML::Template->new(template_params(@_));
1653 }
1654
1655 sub misctemplate ($$;@) {
1656         my $title=shift;
1657         my $pagebody=shift;
1658         
1659         my $template=template("misc.tmpl");
1660         $template->param(
1661                 title => $title,
1662                 indexlink => indexlink(),
1663                 wikiname => $config{wikiname},
1664                 pagebody => $pagebody,
1665                 baseurl => baseurl(),
1666                 @_,
1667         );
1668         run_hooks(pagetemplate => sub {
1669                 shift->(page => "", destpage => "", template => $template);
1670         });
1671         return $template->output;
1672 }
1673
1674 sub hook (@) {
1675         my %param=@_;
1676         
1677         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1678                 error 'hook requires type, call, and id parameters';
1679         }
1680
1681         return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1682         
1683         $hooks{$param{type}}{$param{id}}=\%param;
1684         return 1;
1685 }
1686
1687 sub run_hooks ($$) {
1688         # Calls the given sub for each hook of the given type,
1689         # passing it the hook function to call.
1690         my $type=shift;
1691         my $sub=shift;
1692
1693         if (exists $hooks{$type}) {
1694                 my (@first, @middle, @last);
1695                 foreach my $id (keys %{$hooks{$type}}) {
1696                         if ($hooks{$type}{$id}{first}) {
1697                                 push @first, $id;
1698                         }
1699                         elsif ($hooks{$type}{$id}{last}) {
1700                                 push @last, $id;
1701                         }
1702                         else {
1703                                 push @middle, $id;
1704                         }
1705                 }
1706                 foreach my $id (@first, @middle, @last) {
1707                         $sub->($hooks{$type}{$id}{call});
1708                 }
1709         }
1710
1711         return 1;
1712 }
1713
1714 sub rcs_update () {
1715         $hooks{rcs}{rcs_update}{call}->(@_);
1716 }
1717
1718 sub rcs_prepedit ($) {
1719         $hooks{rcs}{rcs_prepedit}{call}->(@_);
1720 }
1721
1722 sub rcs_commit ($$$;$$) {
1723         $hooks{rcs}{rcs_commit}{call}->(@_);
1724 }
1725
1726 sub rcs_commit_staged ($$$) {
1727         $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1728 }
1729
1730 sub rcs_add ($) {
1731         $hooks{rcs}{rcs_add}{call}->(@_);
1732 }
1733
1734 sub rcs_remove ($) {
1735         $hooks{rcs}{rcs_remove}{call}->(@_);
1736 }
1737
1738 sub rcs_rename ($$) {
1739         $hooks{rcs}{rcs_rename}{call}->(@_);
1740 }
1741
1742 sub rcs_recentchanges ($) {
1743         $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1744 }
1745
1746 sub rcs_diff ($) {
1747         $hooks{rcs}{rcs_diff}{call}->(@_);
1748 }
1749
1750 sub rcs_getctime ($) {
1751         $hooks{rcs}{rcs_getctime}{call}->(@_);
1752 }
1753
1754 sub rcs_receive () {
1755         $hooks{rcs}{rcs_receive}{call}->();
1756 }
1757
1758 sub add_depends ($$;$) {
1759         my $page=shift;
1760         my $pagespec=shift;
1761         my $deptype=shift || $DEPEND_CONTENT;
1762
1763         # Is the pagespec a simple page name?
1764         if ($pagespec =~ /$config{wiki_file_regexp}/ &&
1765             $pagespec !~ /[\s*?()!]/) {
1766                 $depends_simple{$page}{lc $pagespec} |= $deptype;
1767                 return 1;
1768         }
1769
1770         # Add explicit dependencies for influences.
1771         my $sub=pagespec_translate($pagespec);
1772         return if $@;
1773         foreach my $p (keys %pagesources) {
1774                 my $r=$sub->($p, location => $page);
1775                 my $i=$r->influences;
1776                 foreach my $k (keys %$i) {
1777                         $depends_simple{$page}{lc $k} |= $i->{$k};
1778                 }
1779                 last if $r->influences_static;
1780         }
1781
1782         $depends{$page}{$pagespec} |= $deptype;
1783         return 1;
1784 }
1785
1786 sub deptype (@) {
1787         my $deptype=0;
1788         foreach my $type (@_) {
1789                 if ($type eq 'presence') {
1790                         $deptype |= $DEPEND_PRESENCE;
1791                 }
1792                 elsif ($type eq 'links') { 
1793                         $deptype |= $DEPEND_LINKS;
1794                 }
1795                 elsif ($type eq 'content') {
1796                         $deptype |= $DEPEND_CONTENT;
1797                 }
1798         }
1799         return $deptype;
1800 }
1801
1802 sub file_pruned ($;$) {
1803         my $file=shift;
1804         if (@_) {
1805                 require File::Spec;
1806                 $file=File::Spec->canonpath($file);
1807                 my $base=File::Spec->canonpath(shift);
1808                 return if $file eq $base;
1809                 $file =~ s#^\Q$base\E/+##;
1810         }
1811
1812         my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1813         return $file =~ m/$regexp/;
1814 }
1815
1816 sub define_gettext () {
1817         # If translation is needed, redefine the gettext function to do it.
1818         # Otherwise, it becomes a quick no-op.
1819         no warnings 'redefine';
1820         if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1821             (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1822             (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1823                 *gettext=sub {
1824                         my $gettext_obj=eval q{
1825                                 use Locale::gettext q{textdomain};
1826                                 Locale::gettext->domain('ikiwiki')
1827                         };
1828
1829                         if ($gettext_obj) {
1830                                 $gettext_obj->get(shift);
1831                         }
1832                         else {
1833                                 return shift;
1834                         }
1835                 };
1836         }
1837         else {
1838                 *gettext=sub { return shift };
1839         }
1840 }
1841
1842 sub gettext {
1843         define_gettext();
1844         gettext(@_);
1845 }
1846
1847 sub yesno ($) {
1848         my $val=shift;
1849
1850         return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
1851 }
1852
1853 sub inject {
1854         # Injects a new function into the symbol table to replace an
1855         # exported function.
1856         my %params=@_;
1857
1858         # This is deep ugly perl foo, beware.
1859         no strict;
1860         no warnings;
1861         if (! defined $params{parent}) {
1862                 $params{parent}='::';
1863                 $params{old}=\&{$params{name}};
1864                 $params{name}=~s/.*:://;
1865         }
1866         my $parent=$params{parent};
1867         foreach my $ns (grep /^\w+::/, keys %{$parent}) {
1868                 $ns = $params{parent} . $ns;
1869                 inject(%params, parent => $ns) unless $ns eq '::main::';
1870                 *{$ns . $params{name}} = $params{call}
1871                         if exists ${$ns}{$params{name}} &&
1872                            \&{${$ns}{$params{name}}} == $params{old};
1873         }
1874         use strict;
1875         use warnings;
1876 }
1877
1878 sub add_link ($$) {
1879         my $page=shift;
1880         my $link=shift;
1881
1882         push @{$links{$page}}, $link
1883                 unless grep { $_ eq $link } @{$links{$page}};
1884 }
1885
1886 sub pagespec_translate ($) {
1887         my $spec=shift;
1888
1889         # Convert spec to perl code.
1890         my $code="";
1891         my @data;
1892         while ($spec=~m{
1893                 \s*             # ignore whitespace
1894                 (               # 1: match a single word
1895                         \!              # !
1896                 |
1897                         \(              # (
1898                 |
1899                         \)              # )
1900                 |
1901                         \w+\([^\)]*\)   # command(params)
1902                 |
1903                         [^\s()]+        # any other text
1904                 )
1905                 \s*             # ignore whitespace
1906         }gx) {
1907                 my $word=$1;
1908                 if (lc $word eq 'and') {
1909                         $code.=' &';
1910                 }
1911                 elsif (lc $word eq 'or') {
1912                         $code.=' |';
1913                 }
1914                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1915                         $code.=' '.$word;
1916                 }
1917                 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1918                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1919                                 push @data, $2;
1920                                 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
1921                         }
1922                         else {
1923                                 push @data, qq{unknown function in pagespec "$word"};
1924                                 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
1925                         }
1926                 }
1927                 else {
1928                         push @data, $word;
1929                         $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
1930                 }
1931         }
1932
1933         if (! length $code) {
1934                 $code="IkiWiki::FailReason->new('empty pagespec')";
1935         }
1936
1937         no warnings;
1938         return eval 'sub { my $page=shift; '.$code.' }';
1939 }
1940
1941 sub pagespec_match ($$;@) {
1942         my $page=shift;
1943         my $spec=shift;
1944         my @params=@_;
1945
1946         # Backwards compatability with old calling convention.
1947         if (@params == 1) {
1948                 unshift @params, 'location';
1949         }
1950
1951         my $sub=pagespec_translate($spec);
1952         return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
1953                 if $@ || ! defined $sub;
1954         return $sub->($page, @params);
1955 }
1956
1957 sub pagespec_match_list ($$;@) {
1958         my $page=shift;
1959         my $pagespec=shift;
1960         my %params=@_;
1961
1962         # Backwards compatability with old calling convention.
1963         if (ref $page) {
1964                 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
1965                 $params{list}=$page;
1966                 $page=$params{location}; # ugh!
1967         }
1968
1969         my $sub=pagespec_translate($pagespec);
1970         error "syntax error in pagespec \"$pagespec\""
1971                 if $@ || ! defined $sub;
1972
1973         my @candidates;
1974         if (exists $params{list}) {
1975                 @candidates=exists $params{filter}
1976                         ? grep { ! $params{filter}->($_) } @{$params{list}}
1977                         : @{$params{list}};
1978         }
1979         else {
1980                 @candidates=exists $params{filter}
1981                         ? grep { ! $params{filter}->($_) } keys %pagesources
1982                         : keys %pagesources;
1983         }
1984
1985         if (defined $params{sort}) {
1986                 my $f;
1987                 if ($params{sort} eq 'title') {
1988                         $f=sub { pagetitle(basename($a)) cmp pagetitle(basename($b)) };
1989                 }
1990                 elsif ($params{sort} eq 'title_natural') {
1991                         eval q{use Sort::Naturally};
1992                         if ($@) {
1993                                 error(gettext("Sort::Naturally needed for title_natural sort"));
1994                         }
1995                         $f=sub { Sort::Naturally::ncmp(pagetitle(basename($a)), pagetitle(basename($b))) };
1996                 }
1997                 elsif ($params{sort} eq 'mtime') {
1998                         $f=sub { $pagemtime{$b} <=> $pagemtime{$a} };
1999                 }
2000                 elsif ($params{sort} eq 'age') {
2001                         $f=sub { $pagectime{$b} <=> $pagectime{$a} };
2002                 }
2003                 else {
2004                         error sprintf(gettext("unknown sort type %s"), $params{sort});
2005                 }
2006                 @candidates = sort { &$f } @candidates;
2007         }
2008
2009         @candidates=reverse(@candidates) if $params{reverse};
2010         
2011         $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2012         
2013         # clear params, remainder is passed to pagespec
2014         my $num=$params{num};
2015         delete @params{qw{num deptype reverse sort filter list}};
2016         
2017         my @matches;
2018         my $firstfail;
2019         my $count=0;
2020         my $accum=IkiWiki::SuccessReason->new();
2021         foreach my $p (@candidates) {
2022                 my $r=$sub->($p, %params, location => $page);
2023                 error(sprintf(gettext("cannot match pages: %s"), $r))
2024                         if $r->isa("IkiWiki::ErrorReason");
2025                 $accum |= $r;
2026                 if ($r) {
2027                         push @matches, $p;
2028                         last if defined $num && ++$count == $num;
2029                 }
2030         }
2031
2032         # Add simple dependencies for accumulated influences.
2033         my $i=$accum->influences;
2034         foreach my $k (keys %$i) {
2035                 $depends_simple{$page}{lc $k} |= $i->{$k};
2036         }
2037
2038         return @matches;
2039 }
2040
2041 sub pagespec_valid ($) {
2042         my $spec=shift;
2043
2044         my $sub=pagespec_translate($spec);
2045         return ! $@;
2046 }
2047
2048 sub glob2re ($) {
2049         my $re=quotemeta(shift);
2050         $re=~s/\\\*/.*/g;
2051         $re=~s/\\\?/./g;
2052         return $re;
2053 }
2054
2055 package IkiWiki::FailReason;
2056
2057 use overload (
2058         '""'    => sub { $_[0][0] },
2059         '0+'    => sub { 0 },
2060         '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2061         '&'     => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2062         '|'     => sub { $_[1]->merge_influences($_[0]); $_[1] },
2063         fallback => 1,
2064 );
2065
2066 our @ISA = 'IkiWiki::SuccessReason';
2067
2068 package IkiWiki::SuccessReason;
2069
2070 use overload (
2071         '""'    => sub { $_[0][0] },
2072         '0+'    => sub { 1 },
2073         '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
2074         '&'     => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2075         '|'     => sub { $_[0]->merge_influences($_[1]); $_[0] },
2076         fallback => 1,
2077 );
2078
2079 sub new {
2080         my $class = shift;
2081         my $value = shift;
2082         return bless [$value, {@_}], $class;
2083 }
2084
2085 sub influences {
2086         my $this=shift;
2087         $this->[1]={@_} if @_;
2088         my %i=%{$this->[1]};
2089         delete $i{""};
2090         return \%i;
2091 }
2092
2093 sub influences_static {
2094         return ! $_[0][1]->{""};
2095 }
2096
2097 sub merge_influences {
2098         my $this=shift;
2099         my $other=shift;
2100         my $anded=shift;
2101
2102         if (! $anded || (($this || %{$this->[1]}) &&
2103                         ($other || %{$other->[1]}))) {
2104                 foreach my $influence (keys %{$other->[1]}) {
2105                         $this->[1]{$influence} |= $other->[1]{$influence};
2106                 }
2107         }
2108         else {
2109                 # influence blocker
2110                 $this->[1]={};
2111         }
2112 }
2113
2114 package IkiWiki::ErrorReason;
2115
2116 our @ISA = 'IkiWiki::FailReason';
2117
2118 package IkiWiki::PageSpec;
2119
2120 sub derel ($$) {
2121         my $path=shift;
2122         my $from=shift;
2123
2124         if ($path =~ m!^\./!) {
2125                 $from=~s#/?[^/]+$## if defined $from;
2126                 $path=~s#^\./##;
2127                 $path="$from/$path" if length $from;
2128         }
2129
2130         return $path;
2131 }
2132
2133 sub match_glob ($$;@) {
2134         my $page=shift;
2135         my $glob=shift;
2136         my %params=@_;
2137         
2138         $glob=derel($glob, $params{location});
2139
2140         my $regexp=IkiWiki::glob2re($glob);
2141         if ($page=~/^$regexp$/i) {
2142                 if (! IkiWiki::isinternal($page) || $params{internal}) {
2143                         return IkiWiki::SuccessReason->new("$glob matches $page");
2144                 }
2145                 else {
2146                         return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2147                 }
2148         }
2149         else {
2150                 return IkiWiki::FailReason->new("$glob does not match $page");
2151         }
2152 }
2153
2154 sub match_internal ($$;@) {
2155         return match_glob($_[0], $_[1], @_, internal => 1)
2156 }
2157
2158 sub match_link ($$;@) {
2159         my $page=shift;
2160         my $link=lc(shift);
2161         my %params=@_;
2162
2163         $link=derel($link, $params{location});
2164         my $from=exists $params{location} ? $params{location} : '';
2165
2166         my $links = $IkiWiki::links{$page};
2167         return IkiWiki::FailReason->new("$page has no links", "" => 1)
2168                 unless $links && @{$links};
2169         my $bestlink = IkiWiki::bestlink($from, $link);
2170         foreach my $p (@{$links}) {
2171                 if (length $bestlink) {
2172                         return IkiWiki::SuccessReason->new("$page links to $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2173                                 if $bestlink eq IkiWiki::bestlink($page, $p);
2174                 }
2175                 else {
2176                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2177                                 if match_glob($p, $link, %params);
2178                         my ($p_rel)=$p=~/^\/?(.*)/;
2179                         $link=~s/^\///;
2180                         return IkiWiki::SuccessReason->new("$page links to page $p_rel matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2181                                 if match_glob($p_rel, $link, %params);
2182                 }
2183         }
2184         return IkiWiki::FailReason->new("$page does not link to $link", "" => 1);
2185 }
2186
2187 sub match_backlink ($$;@) {
2188         my $ret=match_link($_[1], $_[0], @_);
2189         $ret->influences($_[1] => $IkiWiki::DEPEND_LINKS);
2190         return $ret;
2191 }
2192
2193 sub match_created_before ($$;@) {
2194         my $page=shift;
2195         my $testpage=shift;
2196         my %params=@_;
2197         
2198         $testpage=derel($testpage, $params{location});
2199
2200         if (exists $IkiWiki::pagectime{$testpage}) {
2201                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2202                         return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2203                 }
2204                 else {
2205                         return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2206                 }
2207         }
2208         else {
2209                 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2210         }
2211 }
2212
2213 sub match_created_after ($$;@) {
2214         my $page=shift;
2215         my $testpage=shift;
2216         my %params=@_;
2217         
2218         $testpage=derel($testpage, $params{location});
2219
2220         if (exists $IkiWiki::pagectime{$testpage}) {
2221                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2222                         return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2223                 }
2224                 else {
2225                         return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2226                 }
2227         }
2228         else {
2229                 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2230         }
2231 }
2232
2233 sub match_creation_day ($$;@) {
2234         if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
2235                 return IkiWiki::SuccessReason->new('creation_day matched');
2236         }
2237         else {
2238                 return IkiWiki::FailReason->new('creation_day did not match');
2239         }
2240 }
2241
2242 sub match_creation_month ($$;@) {
2243         if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
2244                 return IkiWiki::SuccessReason->new('creation_month matched');
2245         }
2246         else {
2247                 return IkiWiki::FailReason->new('creation_month did not match');
2248         }
2249 }
2250
2251 sub match_creation_year ($$;@) {
2252         if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
2253                 return IkiWiki::SuccessReason->new('creation_year matched');
2254         }
2255         else {
2256                 return IkiWiki::FailReason->new('creation_year did not match');
2257         }
2258 }
2259
2260 sub match_user ($$;@) {
2261         shift;
2262         my $user=shift;
2263         my %params=@_;
2264         
2265         if (! exists $params{user}) {
2266                 return IkiWiki::ErrorReason->new("no user specified");
2267         }
2268
2269         if (defined $params{user} && lc $params{user} eq lc $user) {
2270                 return IkiWiki::SuccessReason->new("user is $user");
2271         }
2272         elsif (! defined $params{user}) {
2273                 return IkiWiki::FailReason->new("not logged in");
2274         }
2275         else {
2276                 return IkiWiki::FailReason->new("user is $params{user}, not $user");
2277         }
2278 }
2279
2280 sub match_admin ($$;@) {
2281         shift;
2282         shift;
2283         my %params=@_;
2284         
2285         if (! exists $params{user}) {
2286                 return IkiWiki::ErrorReason->new("no user specified");
2287         }
2288
2289         if (defined $params{user} && IkiWiki::is_admin($params{user})) {
2290                 return IkiWiki::SuccessReason->new("user is an admin");
2291         }
2292         elsif (! defined $params{user}) {
2293                 return IkiWiki::FailReason->new("not logged in");
2294         }
2295         else {
2296                 return IkiWiki::FailReason->new("user is not an admin");
2297         }
2298 }
2299
2300 sub match_ip ($$;@) {
2301         shift;
2302         my $ip=shift;
2303         my %params=@_;
2304         
2305         if (! exists $params{ip}) {
2306                 return IkiWiki::ErrorReason->new("no IP specified");
2307         }
2308
2309         if (defined $params{ip} && lc $params{ip} eq lc $ip) {
2310                 return IkiWiki::SuccessReason->new("IP is $ip");
2311         }
2312         else {
2313                 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
2314         }
2315 }
2316
2317 1