added new plugin: pedigree
[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 %renderedfiles %oldrenderedfiles %pagesources
16             %destsources %depends %hooks %forcerebuild $gettext_obj};
17
18 use Exporter q{import};
19 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
20                  bestlink htmllink readfile writefile pagetype srcfile pagename
21                  displaytime will_render gettext urlto targetpage
22                  add_underlay
23                  %config %links %pagestate %renderedfiles
24                  %pagesources %destsources);
25 our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
26 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
27 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
28
29 # Optimisation.
30 use Memoize;
31 memoize("abs2rel");
32 memoize("pagespec_translate");
33 memoize("file_pruned");
34
35 sub defaultconfig () { #{{{
36         return
37         wiki_file_prune_regexps => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
38                 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
39                 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
40                 qr/(^|\/)_MTN\//,
41                 qr/\.dpkg-tmp$/],
42         wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
43         web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
44         verbose => 0,
45         syslog => 0,
46         wikiname => "wiki",
47         default_pageext => "mdwn",
48         htmlext => "html",
49         cgi => 0,
50         post_commit => 0,
51         rcs => '',
52         url => '',
53         cgiurl => '',
54         historyurl => '',
55         diffurl => '',
56         rss => 0,
57         atom => 0,
58         allowrss => 0,
59         allowatom => 0,
60         discussion => 1,
61         rebuild => 0,
62         refresh => 0,
63         getctime => 0,
64         w3mmode => 0,
65         wrapper => undef,
66         wrappermode => undef,
67         svnpath => "trunk",
68         gitorigin_branch => "origin",
69         gitmaster_branch => "master",
70         srcdir => undef,
71         destdir => undef,
72         pingurl => [],
73         templatedir => "$installdir/share/ikiwiki/templates",
74         underlaydir => "$installdir/share/ikiwiki/basewiki",
75         underlaydirs => [],
76         setup => undef,
77         adminuser => undef,
78         adminemail => undef,
79         plugin => [qw{mdwn link inline htmlscrubber passwordauth openid
80                         signinedit lockedit conditional recentchanges}],
81         libdir => undef,
82         timeformat => '%c',
83         locale => undef,
84         sslcookie => 0,
85         httpauth => 0,
86         userdir => "",
87         usedirs => 1,
88         numbacklinks => 10,
89         account_creation_password => "",
90         prefix_directives => 0,
91         hardlink => 0,
92         cgi_disable_uploads => 1,
93 } #}}}
94
95 sub checkconfig () { #{{{
96         # locale stuff; avoid LC_ALL since it overrides everything
97         if (defined $ENV{LC_ALL}) {
98                 $ENV{LANG} = $ENV{LC_ALL};
99                 delete $ENV{LC_ALL};
100         }
101         if (defined $config{locale}) {
102                 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
103                         $ENV{LANG}=$config{locale};
104                         $gettext_obj=undef;
105                 }
106         }
107
108         if (ref $config{ENV} eq 'HASH') {
109                 foreach my $val (keys %{$config{ENV}}) {
110                         $ENV{$val}=$config{ENV}{$val};
111                 }
112         }
113
114         if ($config{w3mmode}) {
115                 eval q{use Cwd q{abs_path}};
116                 error($@) if $@;
117                 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
118                 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
119                 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
120                         unless $config{cgiurl} =~ m!file:///!;
121                 $config{url}="file://".$config{destdir};
122         }
123
124         if ($config{cgi} && ! length $config{url}) {
125                 error(gettext("Must specify url to wiki with --url when using --cgi"));
126         }
127         
128         $config{wikistatedir}="$config{srcdir}/.ikiwiki"
129                 unless exists $config{wikistatedir};
130         
131         if ($config{rcs}) {
132                 eval qq{use IkiWiki::Rcs::$config{rcs}};
133                 if ($@) {
134                         error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
135                 }
136         }
137         else {
138                 require IkiWiki::Rcs::Stub;
139         }
140
141         if (exists $config{umask}) {
142                 umask(possibly_foolish_untaint($config{umask}));
143         }
144
145         run_hooks(checkconfig => sub { shift->() });
146
147         return 1;
148 } #}}}
149
150 sub loadplugins () { #{{{
151         if (defined $config{libdir}) {
152                 unshift @INC, possibly_foolish_untaint($config{libdir});
153         }
154
155         loadplugin($_) foreach @{$config{plugin}};
156
157         run_hooks(getopt => sub { shift->() });
158         if (grep /^-/, @ARGV) {
159                 print STDERR "Unknown option: $_\n"
160                         foreach grep /^-/, @ARGV;
161                 usage();
162         }
163
164         return 1;
165 } #}}}
166
167 sub loadplugin ($) { #{{{
168         my $plugin=shift;
169
170         return if grep { $_ eq $plugin} @{$config{disable_plugins}};
171
172         foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
173                          "$installdir/lib/ikiwiki") {
174                 if (defined $dir && -x "$dir/plugins/$plugin") {
175                         require IkiWiki::Plugin::external;
176                         import IkiWiki::Plugin::external "$dir/plugins/$plugin";
177                         return 1;
178                 }
179         }
180
181         my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
182         eval qq{use $mod};
183         if ($@) {
184                 error("Failed to load plugin $mod: $@");
185         }
186         return 1;
187 } #}}}
188
189 sub error ($;$) { #{{{
190         my $message=shift;
191         my $cleaner=shift;
192         log_message('err' => $message) if $config{syslog};
193         if (defined $cleaner) {
194                 $cleaner->();
195         }
196         die $message."\n";
197 } #}}}
198
199 sub debug ($) { #{{{
200         return unless $config{verbose};
201         return log_message(debug => @_);
202 } #}}}
203
204 my $log_open=0;
205 sub log_message ($$) { #{{{
206         my $type=shift;
207
208         if ($config{syslog}) {
209                 require Sys::Syslog;
210                 if (! $log_open) {
211                         Sys::Syslog::setlogsock('unix');
212                         Sys::Syslog::openlog('ikiwiki', '', 'user');
213                         $log_open=1;
214                 }
215                 return eval {
216                         Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
217                 };
218         }
219         elsif (! $config{cgi}) {
220                 return print "@_\n";
221         }
222         else {
223                 return print STDERR "@_\n";
224         }
225 } #}}}
226
227 sub possibly_foolish_untaint ($) { #{{{
228         my $tainted=shift;
229         my ($untainted)=$tainted=~/(.*)/s;
230         return $untainted;
231 } #}}}
232
233 sub basename ($) { #{{{
234         my $file=shift;
235
236         $file=~s!.*/+!!;
237         return $file;
238 } #}}}
239
240 sub dirname ($) { #{{{
241         my $file=shift;
242
243         $file=~s!/*[^/]+$!!;
244         return $file;
245 } #}}}
246
247 sub pagetype ($) { #{{{
248         my $page=shift;
249         
250         if ($page =~ /\.([^.]+)$/) {
251                 return $1 if exists $hooks{htmlize}{$1};
252         }
253         return;
254 } #}}}
255
256 sub isinternal ($) { #{{{
257         my $page=shift;
258         return exists $pagesources{$page} &&
259                 $pagesources{$page} =~ /\._([^.]+)$/;
260 } #}}}
261
262 sub pagename ($) { #{{{
263         my $file=shift;
264
265         my $type=pagetype($file);
266         my $page=$file;
267         $page=~s/\Q.$type\E*$// if defined $type;
268         return $page;
269 } #}}}
270
271 sub targetpage ($$) { #{{{
272         my $page=shift;
273         my $ext=shift;
274         
275         if (! $config{usedirs} || $page =~ /^index$/ ) {
276                 return $page.".".$ext;
277         } else {
278                 return $page."/index.".$ext;
279         }
280 } #}}}
281
282 sub htmlpage ($) { #{{{
283         my $page=shift;
284         
285         return targetpage($page, $config{htmlext});
286 } #}}}
287
288 sub srcfile_stat { #{{{
289         my $file=shift;
290         my $nothrow=shift;
291
292         return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
293         foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
294                 return "$dir/$file", stat(_) if -e "$dir/$file";
295         }
296         error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
297         return;
298 } #}}}
299
300 sub srcfile ($;$) { #{{{
301         return (srcfile_stat(@_))[0];
302 } #}}}
303
304 sub add_underlay ($) { #{{{
305         my $dir=shift;
306
307         if ($dir=~/^\//) {
308                 unshift @{$config{underlaydirs}}, $dir;
309         }
310         else {
311                 unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
312         }
313
314         return 1;
315 } #}}}
316
317 sub readfile ($;$$) { #{{{
318         my $file=shift;
319         my $binary=shift;
320         my $wantfd=shift;
321
322         if (-l $file) {
323                 error("cannot read a symlink ($file)");
324         }
325         
326         local $/=undef;
327         open (my $in, "<", $file) || error("failed to read $file: $!");
328         binmode($in) if ($binary);
329         return \*$in if $wantfd;
330         my $ret=<$in>;
331         close $in || error("failed to read $file: $!");
332         return $ret;
333 } #}}}
334
335 sub prep_writefile ($$) { #{{{
336         my $file=shift;
337         my $destdir=shift;
338         
339         my $test=$file;
340         while (length $test) {
341                 if (-l "$destdir/$test") {
342                         error("cannot write to a symlink ($test)");
343                 }
344                 $test=dirname($test);
345         }
346
347         my $dir=dirname("$destdir/$file");
348         if (! -d $dir) {
349                 my $d="";
350                 foreach my $s (split(m!/+!, $dir)) {
351                         $d.="$s/";
352                         if (! -d $d) {
353                                 mkdir($d) || error("failed to create directory $d: $!");
354                         }
355                 }
356         }
357
358         return 1;
359 } #}}}
360
361 sub writefile ($$$;$$) { #{{{
362         my $file=shift; # can include subdirs
363         my $destdir=shift; # directory to put file in
364         my $content=shift;
365         my $binary=shift;
366         my $writer=shift;
367         
368         prep_writefile($file, $destdir);
369         
370         my $newfile="$destdir/$file.ikiwiki-new";
371         if (-l $newfile) {
372                 error("cannot write to a symlink ($newfile)");
373         }
374         
375         my $cleanup = sub { unlink($newfile) };
376         open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
377         binmode($out) if ($binary);
378         if ($writer) {
379                 $writer->(\*$out, $cleanup);
380         }
381         else {
382                 print $out $content or error("failed writing to $newfile: $!", $cleanup);
383         }
384         close $out || error("failed saving $newfile: $!", $cleanup);
385         rename($newfile, "$destdir/$file") || 
386                 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
387
388         return 1;
389 } #}}}
390
391 my %cleared;
392 sub will_render ($$;$) { #{{{
393         my $page=shift;
394         my $dest=shift;
395         my $clear=shift;
396
397         # Important security check.
398         if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
399             ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
400                 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
401         }
402
403         if (! $clear || $cleared{$page}) {
404                 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
405         }
406         else {
407                 foreach my $old (@{$renderedfiles{$page}}) {
408                         delete $destsources{$old};
409                 }
410                 $renderedfiles{$page}=[$dest];
411                 $cleared{$page}=1;
412         }
413         $destsources{$dest}=$page;
414
415         return 1;
416 } #}}}
417
418 sub bestlink ($$) { #{{{
419         my $page=shift;
420         my $link=shift;
421         
422         my $cwd=$page;
423         if ($link=~s/^\/+//) {
424                 # absolute links
425                 $cwd="";
426         }
427         $link=~s/\/$//;
428
429         do {
430                 my $l=$cwd;
431                 $l.="/" if length $l;
432                 $l.=$link;
433
434                 if (exists $links{$l}) {
435                         return $l;
436                 }
437                 elsif (exists $pagecase{lc $l}) {
438                         return $pagecase{lc $l};
439                 }
440         } while $cwd=~s!/?[^/]+$!!;
441
442         if (length $config{userdir}) {
443                 my $l = "$config{userdir}/".lc($link);
444                 if (exists $links{$l}) {
445                         return $l;
446                 }
447                 elsif (exists $pagecase{lc $l}) {
448                         return $pagecase{lc $l};
449                 }
450         }
451
452         #print STDERR "warning: page $page, broken link: $link\n";
453         return "";
454 } #}}}
455
456 sub isinlinableimage ($) { #{{{
457         my $file=shift;
458         
459         return $file =~ /\.(png|gif|jpg|jpeg)$/i;
460 } #}}}
461
462 sub pagetitle ($;$) { #{{{
463         my $page=shift;
464         my $unescaped=shift;
465
466         if ($unescaped) {
467                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
468         }
469         else {
470                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
471         }
472
473         return $page;
474 } #}}}
475
476 sub titlepage ($) { #{{{
477         my $title=shift;
478         $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
479         return $title;
480 } #}}}
481
482 sub linkpage ($) { #{{{
483         my $link=shift;
484         $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
485         return $link;
486 } #}}}
487
488 sub cgiurl (@) { #{{{
489         my %params=@_;
490
491         return $config{cgiurl}."?".
492                 join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
493 } #}}}
494
495 sub baseurl (;$) { #{{{
496         my $page=shift;
497
498         return "$config{url}/" if ! defined $page;
499         
500         $page=htmlpage($page);
501         $page=~s/[^\/]+$//;
502         $page=~s/[^\/]+\//..\//g;
503         return $page;
504 } #}}}
505
506 sub abs2rel ($$) { #{{{
507         # Work around very innefficient behavior in File::Spec if abs2rel
508         # is passed two relative paths. It's much faster if paths are
509         # absolute! (Debian bug #376658; fixed in debian unstable now)
510         my $path="/".shift;
511         my $base="/".shift;
512
513         require File::Spec;
514         my $ret=File::Spec->abs2rel($path, $base);
515         $ret=~s/^// if defined $ret;
516         return $ret;
517 } #}}}
518
519 sub displaytime ($;$) { #{{{
520         my $time=shift;
521         my $format=shift;
522         if (! defined $format) {
523                 $format=$config{timeformat};
524         }
525
526         # strftime doesn't know about encodings, so make sure
527         # its output is properly treated as utf8
528         return decode_utf8(POSIX::strftime($format, localtime($time)));
529 } #}}}
530
531 sub beautify_urlpath ($) { #{{{
532         my $url=shift;
533
534         if ($config{usedirs}) {
535                 $url =~ s!/index.$config{htmlext}$!/!;
536         }
537
538         # Ensure url is not an empty link, and
539         # if it's relative, make that explicit to avoid colon confusion.
540         if ($url !~ /\//) {
541                 $url="./$url";
542         }
543
544         return $url;
545 } #}}}
546
547 sub urlto ($$) { #{{{
548         my $to=shift;
549         my $from=shift;
550
551         if (! length $to) {
552                 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
553         }
554
555         if (! $destsources{$to}) {
556                 $to=htmlpage($to);
557         }
558
559         my $link = abs2rel($to, dirname(htmlpage($from)));
560
561         return beautify_urlpath($link);
562 } #}}}
563
564 sub htmllink ($$$;@) { #{{{
565         my $lpage=shift; # the page doing the linking
566         my $page=shift; # the page that will contain the link (different for inline)
567         my $link=shift;
568         my %opts=@_;
569
570         $link=~s/\/$//;
571
572         my $bestlink;
573         if (! $opts{forcesubpage}) {
574                 $bestlink=bestlink($lpage, $link);
575         }
576         else {
577                 $bestlink="$lpage/".lc($link);
578         }
579
580         my $linktext;
581         if (defined $opts{linktext}) {
582                 $linktext=$opts{linktext};
583         }
584         else {
585                 $linktext=pagetitle(basename($link));
586         }
587         
588         return "<span class=\"selflink\">$linktext</span>"
589                 if length $bestlink && $page eq $bestlink &&
590                    ! defined $opts{anchor};
591         
592         if (! $destsources{$bestlink}) {
593                 $bestlink=htmlpage($bestlink);
594
595                 if (! $destsources{$bestlink}) {
596                         return $linktext unless length $config{cgiurl};
597                         return "<span class=\"createlink\"><a href=\"".
598                                 cgiurl(
599                                         do => "create",
600                                         page => lc($link),
601                                         from => $lpage
602                                 ).
603                                 "\" rel=\"nofollow\">?</a>$linktext</span>"
604                 }
605         }
606         
607         $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
608         $bestlink=beautify_urlpath($bestlink);
609         
610         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
611                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
612         }
613
614         if (defined $opts{anchor}) {
615                 $bestlink.="#".$opts{anchor};
616         }
617
618         my @attrs;
619         if (defined $opts{rel}) {
620                 push @attrs, ' rel="'.$opts{rel}.'"';
621         }
622         if (defined $opts{class}) {
623                 push @attrs, ' class="'.$opts{class}.'"';
624         }
625
626         return "<a href=\"$bestlink\"@attrs>$linktext</a>";
627 } #}}}
628
629 sub userlink ($) { #{{{
630         my $user=shift;
631
632         my $oiduser=eval { openiduser($user) };
633         if (defined $oiduser) {
634                 return "<a href=\"$user\">$oiduser</a>";
635         }
636         else {
637                 eval q{use CGI 'escapeHTML'};
638                 error($@) if $@;
639
640                 return htmllink("", "", escapeHTML(
641                         length $config{userdir} ? $config{userdir}."/".$user : $user
642                 ), noimageinline => 1);
643         }
644 } #}}}
645
646 sub htmlize ($$$$) { #{{{
647         my $page=shift;
648         my $destpage=shift;
649         my $type=shift;
650         my $content=shift;
651         
652         my $oneline = $content !~ /\n/;
653
654         if (exists $hooks{htmlize}{$type}) {
655                 $content=$hooks{htmlize}{$type}{call}->(
656                         page => $page,
657                         content => $content,
658                 );
659         }
660         else {
661                 error("htmlization of $type not supported");
662         }
663
664         run_hooks(sanitize => sub {
665                 $content=shift->(
666                         page => $page,
667                         destpage => $destpage,
668                         content => $content,
669                 );
670         });
671         
672         if ($oneline) {
673                 # hack to get rid of enclosing junk added by markdown
674                 # and other htmlizers
675                 $content=~s/^<p>//i;
676                 $content=~s/<\/p>$//i;
677                 chomp $content;
678         }
679
680         return $content;
681 } #}}}
682
683 sub linkify ($$$) { #{{{
684         my $page=shift;
685         my $destpage=shift;
686         my $content=shift;
687
688         run_hooks(linkify => sub {
689                 $content=shift->(
690                         page => $page,
691                         destpage => $destpage,
692                         content => $content,
693                 );
694         });
695         
696         return $content;
697 } #}}}
698
699 our %preprocessing;
700 our $preprocess_preview=0;
701 sub preprocess ($$$;$$) { #{{{
702         my $page=shift; # the page the data comes from
703         my $destpage=shift; # the page the data will appear in (different for inline)
704         my $content=shift;
705         my $scan=shift;
706         my $preview=shift;
707
708         # Using local because it needs to be set within any nested calls
709         # of this function.
710         local $preprocess_preview=$preview if defined $preview;
711
712         my $handle=sub {
713                 my $escape=shift;
714                 my $prefix=shift;
715                 my $command=shift;
716                 my $params=shift;
717                 if (length $escape) {
718                         return "[[$prefix$command $params]]";
719                 }
720                 elsif (exists $hooks{preprocess}{$command}) {
721                         return "" if $scan && ! $hooks{preprocess}{$command}{scan};
722                         # Note: preserve order of params, some plugins may
723                         # consider it significant.
724                         my @params;
725                         while ($params =~ m{
726                                 (?:([-\w]+)=)?          # 1: named parameter key?
727                                 (?:
728                                         """(.*?)"""     # 2: triple-quoted value
729                                 |
730                                         "([^"]+)"       # 3: single-quoted value
731                                 |
732                                         (\S+)           # 4: unquoted value
733                                 )
734                                 (?:\s+|$)               # delimiter to next param
735                         }sgx) {
736                                 my $key=$1;
737                                 my $val;
738                                 if (defined $2) {
739                                         $val=$2;
740                                         $val=~s/\r\n/\n/mg;
741                                         $val=~s/^\n+//g;
742                                         $val=~s/\n+$//g;
743                                 }
744                                 elsif (defined $3) {
745                                         $val=$3;
746                                 }
747                                 elsif (defined $4) {
748                                         $val=$4;
749                                 }
750
751                                 if (defined $key) {
752                                         push @params, $key, $val;
753                                 }
754                                 else {
755                                         push @params, $val, '';
756                                 }
757                         }
758                         if ($preprocessing{$page}++ > 3) {
759                                 # Avoid loops of preprocessed pages preprocessing
760                                 # other pages that preprocess them, etc.
761                                 #translators: The first parameter is a
762                                 #translators: preprocessor directive name,
763                                 #translators: the second a page name, the
764                                 #translators: third a number.
765                                 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
766                                         $command, $page, $preprocessing{$page}).
767                                 "]]";
768                         }
769                         my $ret;
770                         if (! $scan) {
771                                 $ret=$hooks{preprocess}{$command}{call}->(
772                                         @params,
773                                         page => $page,
774                                         destpage => $destpage,
775                                         preview => $preprocess_preview,
776                                 );
777                         }
778                         else {
779                                 # use void context during scan pass
780                                 $hooks{preprocess}{$command}{call}->(
781                                         @params,
782                                         page => $page,
783                                         destpage => $destpage,
784                                         preview => $preprocess_preview,
785                                 );
786                                 $ret="";
787                         }
788                         $preprocessing{$page}--;
789                         return $ret;
790                 }
791                 else {
792                         return "[[$prefix$command $params]]";
793                 }
794         };
795         
796         my $regex;
797         if ($config{prefix_directives}) {
798                 $regex = qr{
799                         (\\?)           # 1: escape?
800                         \[\[(!)         # directive open; 2: prefix
801                         ([-\w]+)        # 3: command
802                         (               # 4: the parameters..
803                                 \s+     # Must have space if parameters present
804                                 (?:
805                                         (?:[-\w]+=)?            # named parameter key?
806                                         (?:
807                                                 """.*?"""       # triple-quoted value
808                                                 |
809                                                 "[^"]+"         # single-quoted value
810                                                 |
811                                                 [^\s\]]+        # unquoted value
812                                         )
813                                         \s*                     # whitespace or end
814                                                                 # of directive
815                                 )
816                         *)?             # 0 or more parameters
817                         \]\]            # directive closed
818                 }sx;
819         } else {
820                 $regex = qr{
821                         (\\?)           # 1: escape?
822                         \[\[(!?)        # directive open; 2: optional prefix
823                         ([-\w]+)        # 3: command
824                         \s+
825                         (               # 4: the parameters..
826                                 (?:
827                                         (?:[-\w]+=)?            # named parameter key?
828                                         (?:
829                                                 """.*?"""       # triple-quoted value
830                                                 |
831                                                 "[^"]+"         # single-quoted value
832                                                 |
833                                                 [^\s\]]+        # unquoted value
834                                         )
835                                         \s*                     # whitespace or end
836                                                                 # of directive
837                                 )
838                         *)              # 0 or more parameters
839                         \]\]            # directive closed
840                 }sx;
841         }
842
843         $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
844         return $content;
845 } #}}}
846
847 sub filter ($$$) { #{{{
848         my $page=shift;
849         my $destpage=shift;
850         my $content=shift;
851
852         run_hooks(filter => sub {
853                 $content=shift->(page => $page, destpage => $destpage, 
854                         content => $content);
855         });
856
857         return $content;
858 } #}}}
859
860 sub indexlink () { #{{{
861         return "<a href=\"$config{url}\">$config{wikiname}</a>";
862 } #}}}
863
864 my $wikilock;
865
866 sub lockwiki (;$) { #{{{
867         my $wait=@_ ? shift : 1;
868         # Take an exclusive lock on the wiki to prevent multiple concurrent
869         # run issues. The lock will be dropped on program exit.
870         if (! -d $config{wikistatedir}) {
871                 mkdir($config{wikistatedir});
872         }
873         open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
874                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
875         if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
876                 if ($wait) {
877                         debug("wiki seems to be locked, waiting for lock");
878                         my $wait=600; # arbitrary, but don't hang forever to 
879                                       # prevent process pileup
880                         for (1..$wait) {
881                                 return if flock($wikilock, 2 | 4);
882                                 sleep 1;
883                         }
884                         error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
885                 }
886                 else {
887                         return 0;
888                 }
889         }
890         return 1;
891 } #}}}
892
893 sub unlockwiki () { #{{{
894         return close($wikilock) if $wikilock;
895         return;
896 } #}}}
897
898 my $commitlock;
899
900 sub commit_hook_enabled () { #{{{
901         open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
902                 error("cannot write to $config{wikistatedir}/commitlock: $!");
903         if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
904                 close($commitlock) || error("failed closing commitlock: $!");
905                 return 0;
906         }
907         close($commitlock) || error("failed closing commitlock: $!");
908         return 1;
909 } #}}}
910
911 sub disable_commit_hook () { #{{{
912         open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
913                 error("cannot write to $config{wikistatedir}/commitlock: $!");
914         if (! flock($commitlock, 2)) { # LOCK_EX
915                 error("failed to get commit lock");
916         }
917         return 1;
918 } #}}}
919
920 sub enable_commit_hook () { #{{{
921         return close($commitlock) if $commitlock;
922         return;
923 } #}}}
924
925 sub loadindex () { #{{{
926         %oldrenderedfiles=%pagectime=();
927         if (! $config{rebuild}) {
928                 %pagesources=%pagemtime=%oldlinks=%links=%depends=
929                 %destsources=%renderedfiles=%pagecase=%pagestate=();
930         }
931         my $in;
932         if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
933                 if (-e "$config{wikistatedir}/index") {
934                         system("ikiwiki-transition", "indexdb", $config{srcdir});
935                         open ($in, "<", "$config{wikistatedir}/indexdb") || return;
936                 }
937                 else {
938                         return;
939                 }
940         }
941         my $ret=Storable::fd_retrieve($in);
942         if (! defined $ret) {
943                 return 0;
944         }
945         my %index=%$ret;
946         foreach my $src (keys %index) {
947                 my %d=%{$index{$src}};
948                 my $page=pagename($src);
949                 $pagectime{$page}=$d{ctime};
950                 if (! $config{rebuild}) {
951                         $pagesources{$page}=$src;
952                         $pagemtime{$page}=$d{mtime};
953                         $renderedfiles{$page}=$d{dest};
954                         if (exists $d{links} && ref $d{links}) {
955                                 $links{$page}=$d{links};
956                                 $oldlinks{$page}=[@{$d{links}}];
957                         }
958                         if (exists $d{depends}) {
959                                 $depends{$page}=$d{depends};
960                         }
961                         if (exists $d{state}) {
962                                 $pagestate{$page}=$d{state};
963                         }
964                 }
965                 $oldrenderedfiles{$page}=[@{$d{dest}}];
966         }
967         foreach my $page (keys %pagesources) {
968                 $pagecase{lc $page}=$page;
969         }
970         foreach my $page (keys %renderedfiles) {
971                 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
972         }
973         return close($in);
974 } #}}}
975
976 sub saveindex () { #{{{
977         run_hooks(savestate => sub { shift->() });
978
979         my %hookids;
980         foreach my $type (keys %hooks) {
981                 $hookids{$_}=1 foreach keys %{$hooks{$type}};
982         }
983         my @hookids=keys %hookids;
984
985         if (! -d $config{wikistatedir}) {
986                 mkdir($config{wikistatedir});
987         }
988         my $newfile="$config{wikistatedir}/indexdb.new";
989         my $cleanup = sub { unlink($newfile) };
990         open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
991         my %index;
992         foreach my $page (keys %pagemtime) {
993                 next unless $pagemtime{$page};
994                 my $src=$pagesources{$page};
995
996                 $index{$src}={
997                         ctime => $pagectime{$page},
998                         mtime => $pagemtime{$page},
999                         dest => $renderedfiles{$page},
1000                         links => $links{$page},
1001                 };
1002
1003                 if (exists $depends{$page}) {
1004                         $index{$src}{depends} = $depends{$page};
1005                 }
1006
1007                 if (exists $pagestate{$page}) {
1008                         foreach my $id (@hookids) {
1009                                 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1010                                         $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1011                                 }
1012                         }
1013                 }
1014         }
1015         my $ret=Storable::nstore_fd(\%index, $out);
1016         return if ! defined $ret || ! $ret;
1017         close $out || error("failed saving to $newfile: $!", $cleanup);
1018         rename($newfile, "$config{wikistatedir}/indexdb") ||
1019                 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1020         
1021         return 1;
1022 } #}}}
1023
1024 sub template_file ($) { #{{{
1025         my $template=shift;
1026
1027         foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1028                 return "$dir/$template" if -e "$dir/$template";
1029         }
1030         return;
1031 } #}}}
1032
1033 sub template_params (@) { #{{{
1034         my $filename=template_file(shift);
1035
1036         if (! defined $filename) {
1037                 return if wantarray;
1038                 return "";
1039         }
1040
1041         my @ret=(
1042                 filter => sub {
1043                         my $text_ref = shift;
1044                         ${$text_ref} = decode_utf8(${$text_ref});
1045                 },
1046                 filename => $filename,
1047                 loop_context_vars => 1,
1048                 die_on_bad_params => 0,
1049                 @_
1050         );
1051         return wantarray ? @ret : {@ret};
1052 } #}}}
1053
1054 sub template ($;@) { #{{{
1055         require HTML::Template;
1056         return HTML::Template->new(template_params(@_));
1057 } #}}}
1058
1059 sub misctemplate ($$;@) { #{{{
1060         my $title=shift;
1061         my $pagebody=shift;
1062         
1063         my $template=template("misc.tmpl");
1064         $template->param(
1065                 title => $title,
1066                 indexlink => indexlink(),
1067                 wikiname => $config{wikiname},
1068                 pagebody => $pagebody,
1069                 baseurl => baseurl(),
1070                 @_,
1071         );
1072         run_hooks(pagetemplate => sub {
1073                 shift->(page => "", destpage => "", template => $template);
1074         });
1075         return $template->output;
1076 }#}}}
1077
1078 sub hook (@) { # {{{
1079         my %param=@_;
1080         
1081         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1082                 error 'hook requires type, call, and id parameters';
1083         }
1084
1085         return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1086         
1087         $hooks{$param{type}}{$param{id}}=\%param;
1088         return 1;
1089 } # }}}
1090
1091 sub run_hooks ($$) { # {{{
1092         # Calls the given sub for each hook of the given type,
1093         # passing it the hook function to call.
1094         my $type=shift;
1095         my $sub=shift;
1096
1097         if (exists $hooks{$type}) {
1098                 my @deferred;
1099                 foreach my $id (keys %{$hooks{$type}}) {
1100                         if ($hooks{$type}{$id}{last}) {
1101                                 push @deferred, $id;
1102                                 next;
1103                         }
1104                         $sub->($hooks{$type}{$id}{call});
1105                 }
1106                 foreach my $id (@deferred) {
1107                         $sub->($hooks{$type}{$id}{call});
1108                 }
1109         }
1110
1111         return 1;
1112 } #}}}
1113
1114 sub globlist_to_pagespec ($) { #{{{
1115         my @globlist=split(' ', shift);
1116
1117         my (@spec, @skip);
1118         foreach my $glob (@globlist) {
1119                 if ($glob=~/^!(.*)/) {
1120                         push @skip, $glob;
1121                 }
1122                 else {
1123                         push @spec, $glob;
1124                 }
1125         }
1126
1127         my $spec=join(' or ', @spec);
1128         if (@skip) {
1129                 my $skip=join(' and ', @skip);
1130                 if (length $spec) {
1131                         $spec="$skip and ($spec)";
1132                 }
1133                 else {
1134                         $spec=$skip;
1135                 }
1136         }
1137         return $spec;
1138 } #}}}
1139
1140 sub is_globlist ($) { #{{{
1141         my $s=shift;
1142         return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1143 } #}}}
1144
1145 sub safequote ($) { #{{{
1146         my $s=shift;
1147         $s=~s/[{}]//g;
1148         return "q{$s}";
1149 } #}}}
1150
1151 sub add_depends ($$) { #{{{
1152         my $page=shift;
1153         my $pagespec=shift;
1154         
1155         return unless pagespec_valid($pagespec);
1156
1157         if (! exists $depends{$page}) {
1158                 $depends{$page}=$pagespec;
1159         }
1160         else {
1161                 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1162         }
1163
1164         return 1;
1165 } # }}}
1166
1167 sub file_pruned ($$) { #{{{
1168         require File::Spec;
1169         my $file=File::Spec->canonpath(shift);
1170         my $base=File::Spec->canonpath(shift);
1171         $file =~ s#^\Q$base\E/+##;
1172
1173         my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1174         return $file =~ m/$regexp/ && $file ne $base;
1175 } #}}}
1176
1177 sub gettext { #{{{
1178         # Only use gettext in the rare cases it's needed.
1179         if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1180             (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1181             (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1182                 if (! $gettext_obj) {
1183                         $gettext_obj=eval q{
1184                                 use Locale::gettext q{textdomain};
1185                                 Locale::gettext->domain('ikiwiki')
1186                         };
1187                         if ($@) {
1188                                 print STDERR "$@";
1189                                 $gettext_obj=undef;
1190                                 return shift;
1191                         }
1192                 }
1193                 return $gettext_obj->get(shift);
1194         }
1195         else {
1196                 return shift;
1197         }
1198 } #}}}
1199
1200 sub yesno ($) { #{{{
1201         my $val=shift;
1202
1203         return (defined $val && lc($val) eq gettext("yes"));
1204 } #}}}
1205
1206 sub pagespec_merge ($$) { #{{{
1207         my $a=shift;
1208         my $b=shift;
1209
1210         return $a if $a eq $b;
1211
1212         # Support for old-style GlobLists.
1213         if (is_globlist($a)) {
1214                 $a=globlist_to_pagespec($a);
1215         }
1216         if (is_globlist($b)) {
1217                 $b=globlist_to_pagespec($b);
1218         }
1219
1220         return "($a) or ($b)";
1221 } #}}}
1222
1223 sub pagespec_translate ($) { #{{{
1224         my $spec=shift;
1225
1226         # Support for old-style GlobLists.
1227         if (is_globlist($spec)) {
1228                 $spec=globlist_to_pagespec($spec);
1229         }
1230
1231         # Convert spec to perl code.
1232         my $code="";
1233         while ($spec=~m{
1234                 \s*             # ignore whitespace
1235                 (               # 1: match a single word
1236                         \!              # !
1237                 |
1238                         \(              # (
1239                 |
1240                         \)              # )
1241                 |
1242                         \w+\([^\)]*\)   # command(params)
1243                 |
1244                         [^\s()]+        # any other text
1245                 )
1246                 \s*             # ignore whitespace
1247         }igx) {
1248                 my $word=$1;
1249                 if (lc $word eq 'and') {
1250                         $code.=' &&';
1251                 }
1252                 elsif (lc $word eq 'or') {
1253                         $code.=' ||';
1254                 }
1255                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1256                         $code.=' '.$word;
1257                 }
1258                 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1259                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1260                                 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1261                         }
1262                         else {
1263                                 $code.=' 0';
1264                         }
1265                 }
1266                 else {
1267                         $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1268                 }
1269         }
1270
1271         if (! length $code) {
1272                 $code=0;
1273         }
1274
1275         no warnings;
1276         return eval 'sub { my $page=shift; '.$code.' }';
1277 } #}}}
1278
1279 sub pagespec_match ($$;@) { #{{{
1280         my $page=shift;
1281         my $spec=shift;
1282         my @params=@_;
1283
1284         # Backwards compatability with old calling convention.
1285         if (@params == 1) {
1286                 unshift @params, 'location';
1287         }
1288
1289         my $sub=pagespec_translate($spec);
1290         return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1291         return $sub->($page, @params);
1292 } #}}}
1293
1294 sub pagespec_valid ($) { #{{{
1295         my $spec=shift;
1296
1297         my $sub=pagespec_translate($spec);
1298         return ! $@;
1299 } #}}}
1300         
1301 sub glob2re ($) { #{{{
1302         my $re=quotemeta(shift);
1303         $re=~s/\\\*/.*/g;
1304         $re=~s/\\\?/./g;
1305         return $re;
1306 } #}}}
1307
1308 package IkiWiki::FailReason;
1309
1310 use overload ( #{{{
1311         '""'    => sub { ${$_[0]} },
1312         '0+'    => sub { 0 },
1313         '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1314         fallback => 1,
1315 ); #}}}
1316
1317 sub new { #{{{
1318         my $class = shift;
1319         my $value = shift;
1320         return bless \$value, $class;
1321 } #}}}
1322
1323 package IkiWiki::SuccessReason;
1324
1325 use overload ( #{{{
1326         '""'    => sub { ${$_[0]} },
1327         '0+'    => sub { 1 },
1328         '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
1329         fallback => 1,
1330 ); #}}}
1331
1332 sub new { #{{{
1333         my $class = shift;
1334         my $value = shift;
1335         return bless \$value, $class;
1336 }; #}}}
1337
1338 package IkiWiki::PageSpec;
1339
1340 sub match_glob ($$;@) { #{{{
1341         my $page=shift;
1342         my $glob=shift;
1343         my %params=@_;
1344         
1345         my $from=exists $params{location} ? $params{location} : '';
1346         
1347         # relative matching
1348         if ($glob =~ m!^\./!) {
1349                 $from=~s#/?[^/]+$##;
1350                 $glob=~s#^\./##;
1351                 $glob="$from/$glob" if length $from;
1352         }
1353
1354         my $regexp=IkiWiki::glob2re($glob);
1355         if ($page=~/^$regexp$/i) {
1356                 if (! IkiWiki::isinternal($page) || $params{internal}) {
1357                         return IkiWiki::SuccessReason->new("$glob matches $page");
1358                 }
1359                 else {
1360                         return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1361                 }
1362         }
1363         else {
1364                 return IkiWiki::FailReason->new("$glob does not match $page");
1365         }
1366 } #}}}
1367
1368 sub match_internal ($$;@) { #{{{
1369         return match_glob($_[0], $_[1], @_, internal => 1)
1370 } #}}}
1371
1372 sub match_link ($$;@) { #{{{
1373         my $page=shift;
1374         my $link=lc(shift);
1375         my %params=@_;
1376
1377         my $from=exists $params{location} ? $params{location} : '';
1378
1379         # relative matching
1380         if ($link =~ m!^\.! && defined $from) {
1381                 $from=~s#/?[^/]+$##;
1382                 $link=~s#^\./##;
1383                 $link="$from/$link" if length $from;
1384         }
1385
1386         my $links = $IkiWiki::links{$page};
1387         return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1388         my $bestlink = IkiWiki::bestlink($from, $link);
1389         foreach my $p (@{$links}) {
1390                 if (length $bestlink) {
1391                         return IkiWiki::SuccessReason->new("$page links to $link")
1392                                 if $bestlink eq IkiWiki::bestlink($page, $p);
1393                 }
1394                 else {
1395                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1396                                 if match_glob($p, $link, %params);
1397                 }
1398         }
1399         return IkiWiki::FailReason->new("$page does not link to $link");
1400 } #}}}
1401
1402 sub match_backlink ($$;@) { #{{{
1403         return match_link($_[1], $_[0], @_);
1404 } #}}}
1405
1406 sub match_created_before ($$;@) { #{{{
1407         my $page=shift;
1408         my $testpage=shift;
1409
1410         if (exists $IkiWiki::pagectime{$testpage}) {
1411                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1412                         return IkiWiki::SuccessReason->new("$page created before $testpage");
1413                 }
1414                 else {
1415                         return IkiWiki::FailReason->new("$page not created before $testpage");
1416                 }
1417         }
1418         else {
1419                 return IkiWiki::FailReason->new("$testpage has no ctime");
1420         }
1421 } #}}}
1422
1423 sub match_created_after ($$;@) { #{{{
1424         my $page=shift;
1425         my $testpage=shift;
1426
1427         if (exists $IkiWiki::pagectime{$testpage}) {
1428                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1429                         return IkiWiki::SuccessReason->new("$page created after $testpage");
1430                 }
1431                 else {
1432                         return IkiWiki::FailReason->new("$page not created after $testpage");
1433                 }
1434         }
1435         else {
1436                 return IkiWiki::FailReason->new("$testpage has no ctime");
1437         }
1438 } #}}}
1439
1440 sub match_creation_day ($$;@) { #{{{
1441         if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1442                 return IkiWiki::SuccessReason->new('creation_day matched');
1443         }
1444         else {
1445                 return IkiWiki::FailReason->new('creation_day did not match');
1446         }
1447 } #}}}
1448
1449 sub match_creation_month ($$;@) { #{{{
1450         if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1451                 return IkiWiki::SuccessReason->new('creation_month matched');
1452         }
1453         else {
1454                 return IkiWiki::FailReason->new('creation_month did not match');
1455         }
1456 } #}}}
1457
1458 sub match_creation_year ($$;@) { #{{{
1459         if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1460                 return IkiWiki::SuccessReason->new('creation_year matched');
1461         }
1462         else {
1463                 return IkiWiki::FailReason->new('creation_year did not match');
1464         }
1465 } #}}}
1466
1467 1