IkiWiki.pm

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