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
 555         if (! length $to) {
 556                 return beautify_url(baseurl($from)."index.$config{htmlext}");
 557         }
 558
 559         if (! $destsources{$to}) {
 560                 $to=htmlpage($to);
 561         }
 562
 563         my $link = abs2rel($to, dirname(htmlpage($from)));
 564
 565         return beautify_url($link);
 566 } #}}}
 567
 568 sub htmllink ($$$;@) { #{{{
 569         my $lpage=shift; # the page doing the linking
 570         my $page=shift; # the page that will contain the link (different for inline)
 571         my $link=shift;
 572         my %opts=@_;
 573
 574         $link=~s/\/$//;
 575
 576         my $bestlink;
 577         if (! $opts{forcesubpage}) {
 578                 $bestlink=bestlink($lpage, $link);
 579         }
 580         else {
 581                 $bestlink="$lpage/".lc($link);
 582         }
 583
 584         my $linktext;
 585         if (defined $opts{linktext}) {
 586                 $linktext=$opts{linktext};
 587         }
 588         else {
 589                 $linktext=pagetitle(basename($link));
 590         }
 591
 592         return "<span class=\"selflink\">$linktext</span>"
 593                 if length $bestlink && $page eq $bestlink &&
 594                    ! defined $opts{anchor};
 595
 596         if (! $destsources{$bestlink}) {
 597                 $bestlink=htmlpage($bestlink);
 598
 599                 if (! $destsources{$bestlink}) {
 600                         return $linktext unless length $config{cgiurl};
 601                         return "<span class=\"createlink\"><a href=\"".
 602                                 cgiurl(
 603                                         do => "create",
 604                                         page => lc($link),
 605                                         from => $lpage
 606                                 ).
 607                                 "\" rel=\"nofollow\">?</a>$linktext</span>"
 608                 }
 609         }
 610
 611         $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
 612         $bestlink=beautify_url($bestlink);
 613
 614         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
 615                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
 616         }
 617
 618         if (defined $opts{anchor}) {
 619                 $bestlink.="#".$opts{anchor};
 620         }
 621
 622         my @attrs;
 623         if (defined $opts{rel}) {
 624                 push @attrs, ' rel="'.$opts{rel}.'"';
 625         }
 626         if (defined $opts{class}) {
 627                 push @attrs, ' class="'.$opts{class}.'"';
 628         }
 629
 630         return "<a href=\"$bestlink\"@attrs>$linktext</a>";
 631 } #}}}
 632
 633 sub userlink ($) { #{{{
 634         my $user=shift;
 635
 636         my $oiduser=eval { openiduser($user) };
 637         if (defined $oiduser) {
 638                 return "<a href=\"$user\">$oiduser</a>";
 639         }
 640         else {
 641                 eval q{use CGI 'escapeHTML'};
 642                 error($@) if $@;
 643
 644                 return htmllink("", "", escapeHTML(
 645                         length $config{userdir} ? $config{userdir}."/".$user : $user
 646                 ), noimageinline => 1);
 647         }
 648 } #}}}
 649
 650 sub htmlize ($$$$) { #{{{
 651         my $page=shift;
 652         my $destpage=shift;
 653         my $type=shift;
 654         my $content=shift;
 655
 656         my $oneline = $content !~ /\n/;
 657
 658         if (exists $hooks{htmlize}{$type}) {
 659                 $content=$hooks{htmlize}{$type}{call}->(
 660                         page => $page,
 661                         content => $content,
 662                 );
 663         }
 664         else {
 665                 error("htmlization of $type not supported");
 666         }
 667
 668         run_hooks(sanitize => sub {
 669                 $content=shift->(
 670                         page => $page,
 671                         destpage => $destpage,
 672                         content => $content,
 673                 );
 674         });
 675
 676         if ($oneline) {
 677                 # hack to get rid of enclosing junk added by markdown
 678                 # and other htmlizers
 679                 $content=~s/^<p>//i;
 680                 $content=~s/<\/p>$//i;
 681                 chomp $content;
 682         }
 683
 684         return $content;
 685 } #}}}
 686
 687 sub linkify ($$$) { #{{{
 688         my $page=shift;
 689         my $destpage=shift;
 690         my $content=shift;
 691
 692         run_hooks(linkify => sub {
 693                 $content=shift->(
 694                         page => $page,
 695                         destpage => $destpage,
 696                         content => $content,
 697                 );
 698         });
 699
 700         return $content;
 701 } #}}}
 702
 703 our %preprocessing;
 704 our $preprocess_preview=0;
 705 sub preprocess ($$$;$$) { #{{{
 706         my $page=shift; # the page the data comes from
 707         my $destpage=shift; # the page the data will appear in (different for inline)
 708         my $content=shift;
 709         my $scan=shift;
 710         my $preview=shift;
 711
 712         # Using local because it needs to be set within any nested calls
 713         # of this function.
 714         local $preprocess_preview=$preview if defined $preview;
 715
 716         my $handle=sub {
 717                 my $escape=shift;
 718                 my $prefix=shift;
 719                 my $command=shift;
 720                 my $params=shift;
 721                 if (length $escape) {
 722                         return "[[$prefix$command $params]]";
 723                 }
 724                 elsif (exists $hooks{preprocess}{$command}) {
 725                         return "" if $scan && ! $hooks{preprocess}{$command}{scan};
 726                         # Note: preserve order of params, some plugins may
 727                         # consider it significant.
 728                         my @params;
 729                         while ($params =~ m{
 730                                 (?:([-\w]+)=)?          # 1: named parameter key?
 731                                 (?:
 732                                         """(.*?)"""     # 2: triple-quoted value
 733                                 |
 734                                         "([^"]+)"       # 3: single-quoted value
 735                                 |
 736                                         (\S+)           # 4: unquoted value
 737                                 )
 738                                 (?:\s+|$)               # delimiter to next param
 739                         }sgx) {
 740                                 my $key=$1;
 741                                 my $val;
 742                                 if (defined $2) {
 743                                         $val=$2;
 744                                         $val=~s/\r\n/\n/mg;
 745                                         $val=~s/^\n+//g;
 746                                         $val=~s/\n+$//g;
 747                                 }
 748                                 elsif (defined $3) {
 749                                         $val=$3;
 750                                 }
 751                                 elsif (defined $4) {
 752                                         $val=$4;
 753                                 }
 754
 755                                 if (defined $key) {
 756                                         push @params, $key, $val;
 757                                 }
 758                                 else {
 759                                         push @params, $val, '';
 760                                 }
 761                         }
 762                         if ($preprocessing{$page}++ > 3) {
 763                                 # Avoid loops of preprocessed pages preprocessing
 764                                 # other pages that preprocess them, etc.
 765                                 #translators: The first parameter is a
 766                                 #translators: preprocessor directive name,
 767                                 #translators: the second a page name, the
 768                                 #translators: third a number.
 769                                 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
 770                                         $command, $page, $preprocessing{$page}).
 771                                 "]]";
 772                         }
 773                         my $ret;
 774                         if (! $scan) {
 775                                 $ret=$hooks{preprocess}{$command}{call}->(
 776                                         @params,
 777                                         page => $page,
 778                                         destpage => $destpage,
 779                                         preview => $preprocess_preview,
 780                                 );
 781                         }
 782                         else {
 783                                 # use void context during scan pass
 784                                 $hooks{preprocess}{$command}{call}->(
 785                                         @params,
 786                                         page => $page,
 787                                         destpage => $destpage,
 788                                         preview => $preprocess_preview,
 789                                 );
 790                                 $ret="";
 791                         }
 792                         $preprocessing{$page}--;
 793                         return $ret;
 794                 }
 795                 else {
 796                         return "[[$prefix$command $params]]";
 797                 }
 798         };
 799
 800         my $regex;
 801         if ($config{prefix_directives}) {
 802                 $regex = qr{
 803                         (\\?)           # 1: escape?
 804                         \[\[(!)         # directive open; 2: prefix
 805                         ([-\w]+)        # 3: command
 806                         (               # 4: the parameters..
 807                                 \s+     # Must have space if parameters present
 808                                 (?:
 809                                         (?:[-\w]+=)?            # named parameter key?
 810                                         (?:
 811                                                 """.*?"""       # triple-quoted value
 812                                                 |
 813                                                 "[^"]+"         # single-quoted value
 814                                                 |
 815                                                 [^\s\]]+        # unquoted value
 816                                         )
 817                                         \s*                     # whitespace or end
 818                                                                 # of directive
 819                                 )
 820                         *)?             # 0 or more parameters
 821                         \]\]            # directive closed
 822                 }sx;
 823         } else {
 824                 $regex = qr{
 825                         (\\?)           # 1: escape?
 826                         \[\[(!?)        # directive open; 2: optional prefix
 827                         ([-\w]+)        # 3: command
 828                         \s+
 829                         (               # 4: the parameters..
 830                                 (?:
 831                                         (?:[-\w]+=)?            # named parameter key?
 832                                         (?:
 833                                                 """.*?"""       # triple-quoted value
 834                                                 |
 835                                                 "[^"]+"         # single-quoted value
 836                                                 |
 837                                                 [^\s\]]+        # unquoted value
 838                                         )
 839                                         \s*                     # whitespace or end
 840                                                                 # of directive
 841                                 )
 842                         *)              # 0 or more parameters
 843                         \]\]            # directive closed
 844                 }sx;
 845         }
 846
 847         $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
 848         return $content;
 849 } #}}}
 850
 851 sub filter ($$$) { #{{{
 852         my $page=shift;
 853         my $destpage=shift;
 854         my $content=shift;
 855
 856         run_hooks(filter => sub {
 857                 $content=shift->(page => $page, destpage => $destpage,
 858                         content => $content);
 859         });
 860
 861         return $content;
 862 } #}}}
 863
 864 sub indexlink () { #{{{
 865         return "<a href=\"$config{url}\">$config{wikiname}</a>";
 866 } #}}}
 867
 868 my $wikilock;
 869
 870 sub lockwiki (;$) { #{{{
 871         my $wait=@_ ? shift : 1;
 872         # Take an exclusive lock on the wiki to prevent multiple concurrent
 873         # run issues. The lock will be dropped on program exit.
 874         if (! -d $config{wikistatedir}) {
 875                 mkdir($config{wikistatedir});
 876         }
 877         open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
 878                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
 879         if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
 880                 if ($wait) {
 881                         debug("wiki seems to be locked, waiting for lock");
 882                         my $wait=600; # arbitrary, but don't hang forever to
 883                                       # prevent process pileup
 884                         for (1..$wait) {
 885                                 return if flock($wikilock, 2 | 4);
 886                                 sleep 1;
 887                         }
 888                         error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
 889                 }
 890                 else {
 891                         return 0;
 892                 }
 893         }
 894         return 1;
 895 } #}}}
 896
 897 sub unlockwiki () { #{{{
 898         return close($wikilock) if $wikilock;
 899         return;
 900 } #}}}
 901
 902 my $commitlock;
 903
 904 sub commit_hook_enabled () { #{{{
 905         open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
 906                 error("cannot write to $config{wikistatedir}/commitlock: $!");
 907         if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
 908                 close($commitlock) || error("failed closing commitlock: $!");
 909                 return 0;
 910         }
 911         close($commitlock) || error("failed closing commitlock: $!");
 912         return 1;
 913 } #}}}
 914
 915 sub disable_commit_hook () { #{{{
 916         open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
 917                 error("cannot write to $config{wikistatedir}/commitlock: $!");
 918         if (! flock($commitlock, 2)) { # LOCK_EX
 919                 error("failed to get commit lock");
 920         }
 921         return 1;
 922 } #}}}
 923
 924 sub enable_commit_hook () { #{{{
 925         return close($commitlock) if $commitlock;
 926         return;
 927 } #}}}
 928
 929 sub loadindex () { #{{{
 930         %oldrenderedfiles=%pagectime=();
 931         if (! $config{rebuild}) {
 932                 %pagesources=%pagemtime=%oldlinks=%links=%depends=
 933                 %destsources=%renderedfiles=%pagecase=%pagestate=();
 934         }
 935         my $in;
 936         if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
 937                 if (-e "$config{wikistatedir}/index") {
 938                         system("ikiwiki-transition", "indexdb", $config{srcdir});
 939                         open ($in, "<", "$config{wikistatedir}/indexdb") || return;
 940                 }
 941                 else {
 942                         return;
 943                 }
 944         }
 945         my $ret=Storable::fd_retrieve($in);
 946         if (! defined $ret) {
 947                 return 0;
 948         }
 949         my %index=%$ret;
 950         foreach my $src (keys %index) {
 951                 my %d=%{$index{$src}};
 952                 my $page=pagename($src);
 953                 $pagectime{$page}=$d{ctime};
 954                 if (! $config{rebuild}) {
 955                         $pagesources{$page}=$src;
 956                         $pagemtime{$page}=$d{mtime};
 957                         $renderedfiles{$page}=$d{dest};
 958                         if (exists $d{links} && ref $d{links}) {
 959                                 $links{$page}=$d{links};
 960                                 $oldlinks{$page}=[@{$d{links}}];
 961                         }
 962                         if (exists $d{depends}) {
 963                                 $depends{$page}=$d{depends};
 964                         }
 965                         if (exists $d{state}) {
 966                                 $pagestate{$page}=$d{state};
 967                         }
 968                 }
 969                 $oldrenderedfiles{$page}=[@{$d{dest}}];
 970         }
 971         foreach my $page (keys %pagesources) {
 972                 $pagecase{lc $page}=$page;
 973         }
 974         foreach my $page (keys %renderedfiles) {
 975                 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
 976         }
 977         return close($in);
 978 } #}}}
 979
 980 sub saveindex () { #{{{
 981         run_hooks(savestate => sub { shift->() });
 982
 983         my %hookids;
 984         foreach my $type (keys %hooks) {
 985                 $hookids{$_}=1 foreach keys %{$hooks{$type}};
 986         }
 987         my @hookids=keys %hookids;
 988
 989         if (! -d $config{wikistatedir}) {
 990                 mkdir($config{wikistatedir});
 991         }
 992         my $newfile="$config{wikistatedir}/indexdb.new";
 993         my $cleanup = sub { unlink($newfile) };
 994         open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
 995         my %index;
 996         foreach my $page (keys %pagemtime) {
 997                 next unless $pagemtime{$page};
 998                 my $src=$pagesources{$page};
 999
1000                 $index{$src}={
1001                         ctime => $pagectime{$page},
1002                         mtime => $pagemtime{$page},
1003                         dest => $renderedfiles{$page},
1004                         links => $links{$page},
1005                 };
1006
1007                 if (exists $depends{$page}) {
1008                         $index{$src}{depends} = $depends{$page};
1009                 }
1010
1011                 if (exists $pagestate{$page}) {
1012                         foreach my $id (@hookids) {
1013                                 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1014                                         $index{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1015                                 }
1016                         }
1017                 }
1018         }
1019         my $ret=Storable::nstore_fd(\%index, $out);
1020         return if ! defined $ret || ! $ret;
1021         close $out || error("failed saving to $newfile: $!", $cleanup);
1022         rename($newfile, "$config{wikistatedir}/indexdb") ||
1023                 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1024
1025         return 1;
1026 } #}}}
1027
1028 sub template_file ($) { #{{{
1029         my $template=shift;
1030
1031         foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1032                 return "$dir/$template" if -e "$dir/$template";
1033         }
1034         return;
1035 } #}}}
1036
1037 sub template_params (@) { #{{{
1038         my $filename=template_file(shift);
1039
1040         if (! defined $filename) {
1041                 return if wantarray;
1042                 return "";
1043         }
1044
1045         my @ret=(
1046                 filter => sub {
1047                         my $text_ref = shift;
1048                         ${$text_ref} = decode_utf8(${$text_ref});
1049                 },
1050                 filename => $filename,
1051                 loop_context_vars => 1,
1052                 die_on_bad_params => 0,
1053                 @_
1054         );
1055         return wantarray ? @ret : {@ret};
1056 } #}}}
1057
1058 sub template ($;@) { #{{{
1059         require HTML::Template;
1060         return HTML::Template->new(template_params(@_));
1061 } #}}}
1062
1063 sub misctemplate ($$;@) { #{{{
1064         my $title=shift;
1065         my $pagebody=shift;
1066
1067         my $template=template("misc.tmpl");
1068         $template->param(
1069                 title => $title,
1070                 indexlink => indexlink(),
1071                 wikiname => $config{wikiname},
1072                 pagebody => $pagebody,
1073                 baseurl => baseurl(),
1074                 @_,
1075         );
1076         run_hooks(pagetemplate => sub {
1077                 shift->(page => "", destpage => "", template => $template);
1078         });
1079         return $template->output;
1080 }#}}}
1081
1082 sub hook (@) { # {{{
1083         my %param=@_;
1084
1085         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1086                 error 'hook requires type, call, and id parameters';
1087         }
1088
1089         return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1090
1091         $hooks{$param{type}}{$param{id}}=\%param;
1092         return 1;
1093 } # }}}
1094
1095 sub run_hooks ($$) { # {{{
1096         # Calls the given sub for each hook of the given type,
1097         # passing it the hook function to call.
1098         my $type=shift;
1099         my $sub=shift;
1100
1101         if (exists $hooks{$type}) {
1102                 my @deferred;
1103                 foreach my $id (keys %{$hooks{$type}}) {
1104                         if ($hooks{$type}{$id}{last}) {
1105                                 push @deferred, $id;
1106                                 next;
1107                         }
1108                         $sub->($hooks{$type}{$id}{call});
1109                 }
1110                 foreach my $id (@deferred) {
1111                         $sub->($hooks{$type}{$id}{call});
1112                 }
1113         }
1114
1115         return 1;
1116 } #}}}
1117
1118 sub globlist_to_pagespec ($) { #{{{
1119         my @globlist=split(' ', shift);
1120
1121         my (@spec, @skip);
1122         foreach my $glob (@globlist) {
1123                 if ($glob=~/^!(.*)/) {
1124                         push @skip, $glob;
1125                 }
1126                 else {
1127                         push @spec, $glob;
1128                 }
1129         }
1130
1131         my $spec=join(' or ', @spec);
1132         if (@skip) {
1133                 my $skip=join(' and ', @skip);
1134                 if (length $spec) {
1135                         $spec="$skip and ($spec)";
1136                 }
1137                 else {
1138                         $spec=$skip;
1139                 }
1140         }
1141         return $spec;
1142 } #}}}
1143
1144 sub is_globlist ($) { #{{{
1145         my $s=shift;
1146         return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1147 } #}}}
1148
1149 sub safequote ($) { #{{{
1150         my $s=shift;
1151         $s=~s/[{}]//g;
1152         return "q{$s}";
1153 } #}}}
1154
1155 sub add_depends ($$) { #{{{
1156         my $page=shift;
1157         my $pagespec=shift;
1158
1159         return unless pagespec_valid($pagespec);
1160
1161         if (! exists $depends{$page}) {
1162                 $depends{$page}=$pagespec;
1163         }
1164         else {
1165                 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1166         }
1167
1168         return 1;
1169 } # }}}
1170
1171 sub file_pruned ($$) { #{{{
1172         require File::Spec;
1173         my $file=File::Spec->canonpath(shift);
1174         my $base=File::Spec->canonpath(shift);
1175         $file =~ s#^\Q$base\E/+##;
1176
1177         my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1178         return $file =~ m/$regexp/ && $file ne $base;
1179 } #}}}
1180
1181 sub gettext { #{{{
1182         # Only use gettext in the rare cases it's needed.
1183         if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1184             (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1185             (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1186                 if (! $gettext_obj) {
1187                         $gettext_obj=eval q{
1188                                 use Locale::gettext q{textdomain};
1189                                 Locale::gettext->domain('ikiwiki')
1190                         };
1191                         if ($@) {
1192                                 print STDERR "$@";
1193                                 $gettext_obj=undef;
1194                                 return shift;
1195                         }
1196                 }
1197                 return $gettext_obj->get(shift);
1198         }
1199         else {
1200                 return shift;
1201         }
1202 } #}}}
1203
1204 sub pagespec_merge ($$) { #{{{
1205         my $a=shift;
1206         my $b=shift;
1207
1208         return $a if $a eq $b;
1209
1210         # Support for old-style GlobLists.
1211         if (is_globlist($a)) {
1212                 $a=globlist_to_pagespec($a);
1213         }
1214         if (is_globlist($b)) {
1215                 $b=globlist_to_pagespec($b);
1216         }
1217
1218         return "($a) or ($b)";
1219 } #}}}
1220
1221 sub pagespec_translate ($) { #{{{
1222         my $spec=shift;
1223
1224         # Support for old-style GlobLists.
1225         if (is_globlist($spec)) {
1226                 $spec=globlist_to_pagespec($spec);
1227         }
1228
1229         # Convert spec to perl code.
1230         my $code="";
1231         while ($spec=~m{
1232                 \s*             # ignore whitespace
1233                 (               # 1: match a single word
1234                         \!              # !
1235                 |
1236                         \(              # (
1237                 |
1238                         \)              # )
1239                 |
1240                         \w+\([^\)]*\)   # command(params)
1241                 |
1242                         [^\s()]+        # any other text
1243                 )
1244                 \s*             # ignore whitespace
1245         }igx) {
1246                 my $word=$1;
1247                 if (lc $word eq 'and') {
1248                         $code.=' &&';
1249                 }
1250                 elsif (lc $word eq 'or') {
1251                         $code.=' ||';
1252                 }
1253                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1254                         $code.=' '.$word;
1255                 }
1256                 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1257                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1258                                 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1259                         }
1260                         else {
1261                                 $code.=' 0';
1262                         }
1263                 }
1264                 else {
1265                         $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1266                 }
1267         }
1268
1269         if (! length $code) {
1270                 $code=0;
1271         }
1272
1273         no warnings;
1274         return eval 'sub { my $page=shift; '.$code.' }';
1275 } #}}}
1276
1277 sub pagespec_match ($$;@) { #{{{
1278         my $page=shift;
1279         my $spec=shift;
1280         my @params=@_;
1281
1282         # Backwards compatability with old calling convention.
1283         if (@params == 1) {
1284                 unshift @params, 'location';
1285         }
1286
1287         my $sub=pagespec_translate($spec);
1288         return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1289         return $sub->($page, @params);
1290 } #}}}
1291
1292 sub pagespec_valid ($) { #{{{
1293         my $spec=shift;
1294
1295         my $sub=pagespec_translate($spec);
1296         return ! $@;
1297 } #}}}
1298
1299 sub glob2re ($) { #{{{
1300         my $re=quotemeta(shift);
1301         $re=~s/\\\*/.*/g;
1302         $re=~s/\\\?/./g;
1303         return $re;
1304 } #}}}
1305
1306 package IkiWiki::FailReason;
1307
1308 use overload ( #{{{
1309         '""'    => sub { ${$_[0]} },
1310         '0+'    => sub { 0 },
1311         '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1312         fallback => 1,
1313 ); #}}}
1314
1315 sub new { #{{{
1316         my $class = shift;
1317         my $value = shift;
1318         return bless \$value, $class;
1319 } #}}}
1320
1321 package IkiWiki::SuccessReason;
1322
1323 use overload ( #{{{
1324         '""'    => sub { ${$_[0]} },
1325         '0+'    => sub { 1 },
1326         '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
1327         fallback => 1,
1328 ); #}}}
1329
1330 sub new { #{{{
1331         my $class = shift;
1332         my $value = shift;
1333         return bless \$value, $class;
1334 }; #}}}
1335
1336 package IkiWiki::PageSpec;
1337
1338 sub match_glob ($$;@) { #{{{
1339         my $page=shift;
1340         my $glob=shift;
1341         my %params=@_;
1342
1343         my $from=exists $params{location} ? $params{location} : '';
1344
1345         # relative matching
1346         if ($glob =~ m!^\./!) {
1347                 $from=~s#/?[^/]+$##;
1348                 $glob=~s#^\./##;
1349                 $glob="$from/$glob" if length $from;
1350         }
1351
1352         my $regexp=IkiWiki::glob2re($glob);
1353         if ($page=~/^$regexp$/i) {
1354                 if (! IkiWiki::isinternal($page) || $params{internal}) {
1355                         return IkiWiki::SuccessReason->new("$glob matches $page");
1356                 }
1357                 else {
1358                         return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1359                 }
1360         }
1361         else {
1362                 return IkiWiki::FailReason->new("$glob does not match $page");
1363         }
1364 } #}}}
1365
1366 sub match_internal ($$;@) { #{{{
1367         return match_glob($_[0], $_[1], @_, internal => 1)
1368 } #}}}
1369
1370 sub match_link ($$;@) { #{{{
1371         my $page=shift;
1372         my $link=lc(shift);
1373         my %params=@_;
1374
1375         my $from=exists $params{location} ? $params{location} : '';
1376
1377         # relative matching
1378         if ($link =~ m!^\.! && defined $from) {
1379                 $from=~s#/?[^/]+$##;
1380                 $link=~s#^\./##;
1381                 $link="$from/$link" if length $from;
1382         }
1383
1384         my $links = $IkiWiki::links{$page};
1385         return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1386         my $bestlink = IkiWiki::bestlink($from, $link);
1387         foreach my $p (@{$links}) {
1388                 if (length $bestlink) {
1389                         return IkiWiki::SuccessReason->new("$page links to $link")
1390                                 if $bestlink eq IkiWiki::bestlink($page, $p);
1391                 }
1392                 else {
1393                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1394                                 if match_glob($p, $link, %params);
1395                 }
1396         }
1397         return IkiWiki::FailReason->new("$page does not link to $link");
1398 } #}}}
1399
1400 sub match_backlink ($$;@) { #{{{
1401         return match_link($_[1], $_[0], @_);
1402 } #}}}
1403
1404 sub match_created_before ($$;@) { #{{{
1405         my $page=shift;
1406         my $testpage=shift;
1407
1408         if (exists $IkiWiki::pagectime{$testpage}) {
1409                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1410                         return IkiWiki::SuccessReason->new("$page created before $testpage");
1411                 }
1412                 else {
1413                         return IkiWiki::FailReason->new("$page not created before $testpage");
1414                 }
1415         }
1416         else {
1417                 return IkiWiki::FailReason->new("$testpage has no ctime");
1418         }
1419 } #}}}
1420
1421 sub match_created_after ($$;@) { #{{{
1422         my $page=shift;
1423         my $testpage=shift;
1424
1425         if (exists $IkiWiki::pagectime{$testpage}) {
1426                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1427                         return IkiWiki::SuccessReason->new("$page created after $testpage");
1428                 }
1429                 else {
1430                         return IkiWiki::FailReason->new("$page not created after $testpage");
1431                 }
1432         }
1433         else {
1434                 return IkiWiki::FailReason->new("$testpage has no ctime");
1435         }
1436 } #}}}
1437
1438 sub match_creation_day ($$;@) { #{{{
1439         if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1440                 return IkiWiki::SuccessReason->new('creation_day matched');
1441         }
1442         else {
1443                 return IkiWiki::FailReason->new('creation_day did not match');
1444         }
1445 } #}}}
1446
1447 sub match_creation_month ($$;@) { #{{{
1448         if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1449                 return IkiWiki::SuccessReason->new('creation_month matched');
1450         }
1451         else {
1452                 return IkiWiki::FailReason->new('creation_month did not match');
1453         }
1454 } #}}}
1455
1456 sub match_creation_year ($$;@) { #{{{
1457         if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1458                 return IkiWiki::SuccessReason->new('creation_year matched');
1459         }
1460         else {
1461                 return IkiWiki::FailReason->new('creation_year did not match');
1462         }
1463 } #}}}
1464
1465 1