IkiWiki.pm

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