IkiWiki.pm

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