git.oblomov.eu Git - ikiwiki/blob - 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                 $test=dirname($test);
 827         }
 828
 829         my $dir=dirname("$destdir/$file");
 830         if (! -d $dir) {
 831                 my $d="";
 832                 foreach my $s (split(m!/+!, $dir)) {
 833                         $d.="$s/";
 834                         if (! -d $d) {
 835                                 mkdir($d) || error("failed to create directory $d: $!");
 836                         }
 837                 }
 838         }
 839
 840         return 1;
 841 }
 842
 843 sub writefile ($$$;$$) {
 844         my $file=shift; # can include subdirs
 845         my $destdir=shift; # directory to put file in
 846         my $content=shift;
 847         my $binary=shift;
 848         my $writer=shift;
 849
 850         prep_writefile($file, $destdir);
 851
 852         my $newfile="$destdir/$file.ikiwiki-new";
 853         if (-l $newfile) {
 854                 error("cannot write to a symlink ($newfile)");
 855         }
 856
 857         my $cleanup = sub { unlink($newfile) };
 858         open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
 859         binmode($out) if ($binary);
 860         if ($writer) {
 861                 $writer->(\*$out, $cleanup);
 862         }
 863         else {
 864                 print $out $content or error("failed writing to $newfile: $!", $cleanup);
 865         }
 866         close $out || error("failed saving $newfile: $!", $cleanup);
 867         rename($newfile, "$destdir/$file") ||
 868                 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
 869
 870         return 1;
 871 }
 872
 873 my %cleared;
 874 sub will_render ($$;$) {
 875         my $page=shift;
 876         my $dest=shift;
 877         my $clear=shift;
 878
 879         # Important security check.
 880         if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
 881             ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
 882                 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
 883         }
 884
 885         if (! $clear || $cleared{$page}) {
 886                 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
 887         }
 888         else {
 889                 foreach my $old (@{$renderedfiles{$page}}) {
 890                         delete $destsources{$old};
 891                 }
 892                 $renderedfiles{$page}=[$dest];
 893                 $cleared{$page}=1;
 894         }
 895         $destsources{$dest}=$page;
 896
 897         return 1;
 898 }
 899
 900 sub bestlink ($$) {
 901         my $page=shift;
 902         my $link=shift;
 903
 904         my $cwd=$page;
 905         if ($link=~s/^\/+//) {
 906                 # absolute links
 907                 $cwd="";
 908         }
 909         $link=~s/\/$//;
 910
 911         do {
 912                 my $l=$cwd;
 913                 $l.="/" if length $l;
 914                 $l.=$link;
 915
 916                 if (exists $pagesources{$l}) {
 917                         return $l;
 918                 }
 919                 elsif (exists $pagecase{lc $l}) {
 920                         return $pagecase{lc $l};
 921                 }
 922         } while $cwd=~s{/?[^/]+$}{};
 923
 924         if (length $config{userdir}) {
 925                 my $l = "$config{userdir}/".lc($link);
 926                 if (exists $pagesources{$l}) {
 927                         return $l;
 928                 }
 929                 elsif (exists $pagecase{lc $l}) {
 930                         return $pagecase{lc $l};
 931                 }
 932         }
 933
 934         #print STDERR "warning: page $page, broken link: $link\n";
 935         return "";
 936 }
 937
 938 sub isinlinableimage ($) {
 939         my $file=shift;
 940
 941         return $file =~ /\.(png|gif|jpg|jpeg)$/i;
 942 }
 943
 944 sub pagetitle ($;$) {
 945         my $page=shift;
 946         my $unescaped=shift;
 947
 948         if ($unescaped) {
 949                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
 950         }
 951         else {
 952                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
 953         }
 954
 955         return $page;
 956 }
 957
 958 sub titlepage ($) {
 959         my $title=shift;
 960         # support use w/o %config set
 961         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
 962         $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
 963         return $title;
 964 }
 965
 966 sub linkpage ($) {
 967         my $link=shift;
 968         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
 969         $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
 970         return $link;
 971 }
 972
 973 sub cgiurl (@) {
 974         my %params=@_;
 975
 976         my $cgiurl=$config{cgiurl};
 977         if (exists $params{cgiurl}) {
 978                 $cgiurl=$params{cgiurl};
 979                 delete $params{cgiurl};
 980         }
 981         return $cgiurl."?".
 982                 join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
 983 }
 984
 985 sub baseurl (;$) {
 986         my $page=shift;
 987
 988         return "$config{url}/" if ! defined $page;
 989
 990         $page=htmlpage($page);
 991         $page=~s/[^\/]+$//;
 992         $page=~s/[^\/]+\//..\//g;
 993         return $page;
 994 }
 995
 996 sub abs2rel ($$) {
 997         # Work around very innefficient behavior in File::Spec if abs2rel
 998         # is passed two relative paths. It's much faster if paths are
 999         # absolute! (Debian bug #376658; fixed in debian unstable now)
1000         my $path="/".shift;
1001         my $base="/".shift;
1002
1003         require File::Spec;
1004         my $ret=File::Spec->abs2rel($path, $base);
1005         $ret=~s/^// if defined $ret;
1006         return $ret;
1007 }
1008
1009 sub displaytime ($;$$) {
1010         # Plugins can override this function to mark up the time to
1011         # display.
1012         my $time=formattime($_[0], $_[1]);
1013         if ($config{html5}) {
1014                 return '<time datetime="'.date_3339($_[0]).'"'.
1015                         ($_[2] ? ' pubdate="pubdate"' : '').
1016                         '>'.$time.'</time>';
1017         }
1018         else {
1019                 return '<span class="date">'.$time.'</span>';
1020         }
1021 }
1022
1023 sub formattime ($;$) {
1024         # Plugins can override this function to format the time.
1025         my $time=shift;
1026         my $format=shift;
1027         if (! defined $format) {
1028                 $format=$config{timeformat};
1029         }
1030
1031         # strftime doesn't know about encodings, so make sure
1032         # its output is properly treated as utf8
1033         return decode_utf8(POSIX::strftime($format, localtime($time)));
1034 }
1035
1036 sub date_3339 ($) {
1037         my $time=shift;
1038
1039         my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
1040         POSIX::setlocale(&POSIX::LC_TIME, "C");
1041         my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
1042         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
1043         return $ret;
1044 }
1045
1046 sub beautify_urlpath ($) {
1047         my $url=shift;
1048
1049         # Ensure url is not an empty link, and if necessary,
1050         # add ./ to avoid colon confusion.
1051         if ($url !~ /^\// && $url !~ /^\.\.?\//) {
1052                 $url="./$url";
1053         }
1054
1055         if ($config{usedirs}) {
1056                 $url =~ s!/index.$config{htmlext}$!/!;
1057         }
1058
1059         return $url;
1060 }
1061
1062 sub urlto ($$;$) {
1063         my $to=shift;
1064         my $from=shift;
1065         my $absolute=shift;
1066
1067         if (! length $to) {
1068                 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
1069         }
1070
1071         if (! $destsources{$to}) {
1072                 $to=htmlpage($to);
1073         }
1074
1075         if ($absolute) {
1076                 return $config{url}.beautify_urlpath("/".$to);
1077         }
1078
1079         my $link = abs2rel($to, dirname(htmlpage($from)));
1080
1081         return beautify_urlpath($link);
1082 }
1083
1084 sub htmllink ($$$;@) {
1085         my $lpage=shift; # the page doing the linking
1086         my $page=shift; # the page that will contain the link (different for inline)
1087         my $link=shift;
1088         my %opts=@_;
1089
1090         $link=~s/\/$//;
1091
1092         my $bestlink;
1093         if (! $opts{forcesubpage}) {
1094                 $bestlink=bestlink($lpage, $link);
1095         }
1096         else {
1097                 $bestlink="$lpage/".lc($link);
1098         }
1099
1100         my $linktext;
1101         if (defined $opts{linktext}) {
1102                 $linktext=$opts{linktext};
1103         }
1104         else {
1105                 $linktext=pagetitle(basename($link));
1106         }
1107
1108         return "<span class=\"selflink\">$linktext</span>"
1109                 if length $bestlink && $page eq $bestlink &&
1110                    ! defined $opts{anchor};
1111
1112         if (! $destsources{$bestlink}) {
1113                 $bestlink=htmlpage($bestlink);
1114
1115                 if (! $destsources{$bestlink}) {
1116                         my $cgilink = "";
1117                         if (length $config{cgiurl}) {
1118                                 $cgilink = "<a href=\"".
1119                                         cgiurl(
1120                                                 do => "create",
1121                                                 page => lc($link),
1122                                                 from => $lpage
1123                                         )."\" rel=\"nofollow\">?</a>";
1124                         }
1125                         return "<span class=\"createlink\">$cgilink$linktext</span>"
1126                 }
1127         }
1128
1129         $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1130         $bestlink=beautify_urlpath($bestlink);
1131
1132         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1133                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1134         }
1135
1136         if (defined $opts{anchor}) {
1137                 $bestlink.="#".$opts{anchor};
1138         }
1139
1140         my @attrs;
1141         foreach my $attr (qw{rel class title}) {
1142                 if (defined $opts{$attr}) {
1143                         push @attrs, " $attr=\"$opts{$attr}\"";
1144                 }
1145         }
1146
1147         return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1148 }
1149
1150 sub userpage ($) {
1151         my $user=shift;
1152         return length $config{userdir} ? "$config{userdir}/$user" : $user;
1153 }
1154
1155 sub openiduser ($) {
1156         my $user=shift;
1157
1158         if ($user =~ m!^https?://! &&
1159             eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1160                 my $display;
1161
1162                 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1163                         $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1164                 }
1165                 else {
1166                         # backcompat with old version
1167                         my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1168                         $display=$oid->display;
1169                 }
1170
1171                 # Convert "user.somehost.com" to "user [somehost.com]"
1172                 # (also "user.somehost.co.uk")
1173                 if ($display !~ /\[/) {
1174                         $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1175                 }
1176                 # Convert "http://somehost.com/user" to "user [somehost.com]".
1177                 # (also "https://somehost.com/user/")
1178                 if ($display !~ /\[/) {
1179                         $display=~s/^https?:\/\/(.+)\/([^\/#?]+)\/?(?:[#?].*)?$/$2 [$1]/;
1180                 }
1181                 $display=~s!^https?://!!; # make sure this is removed
1182                 eval q{use CGI 'escapeHTML'};
1183                 error($@) if $@;
1184                 return escapeHTML($display);
1185         }
1186         return;
1187 }
1188
1189 sub htmlize ($$$$) {
1190         my $page=shift;
1191         my $destpage=shift;
1192         my $type=shift;
1193         my $content=shift;
1194
1195         my $oneline = $content !~ /\n/;
1196
1197         if (exists $hooks{htmlize}{$type}) {
1198                 $content=$hooks{htmlize}{$type}{call}->(
1199                         page => $page,
1200                         content => $content,
1201                 );
1202         }
1203         else {
1204                 error("htmlization of $type not supported");
1205         }
1206
1207         run_hooks(sanitize => sub {
1208                 $content=shift->(
1209                         page => $page,
1210                         destpage => $destpage,
1211                         content => $content,
1212                 );
1213         });
1214
1215         if ($oneline) {
1216                 # hack to get rid of enclosing junk added by markdown
1217                 # and other htmlizers/sanitizers
1218                 $content=~s/^<p>//i;
1219                 $content=~s/<\/p>\n*$//i;
1220         }
1221
1222         return $content;
1223 }
1224
1225 sub linkify ($$$) {
1226         my $page=shift;
1227         my $destpage=shift;
1228         my $content=shift;
1229
1230         run_hooks(linkify => sub {
1231                 $content=shift->(
1232                         page => $page,
1233                         destpage => $destpage,
1234                         content => $content,
1235                 );
1236         });
1237
1238         return $content;
1239 }
1240
1241 our %preprocessing;
1242 our $preprocess_preview=0;
1243 sub preprocess ($$$;$$) {
1244         my $page=shift; # the page the data comes from
1245         my $destpage=shift; # the page the data will appear in (different for inline)
1246         my $content=shift;
1247         my $scan=shift;
1248         my $preview=shift;
1249
1250         # Using local because it needs to be set within any nested calls
1251         # of this function.
1252         local $preprocess_preview=$preview if defined $preview;
1253
1254         my $handle=sub {
1255                 my $escape=shift;
1256                 my $prefix=shift;
1257                 my $command=shift;
1258                 my $params=shift;
1259                 $params="" if ! defined $params;
1260
1261                 if (length $escape) {
1262                         return "[[$prefix$command $params]]";
1263                 }
1264                 elsif (exists $hooks{preprocess}{$command}) {
1265                         return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1266                         # Note: preserve order of params, some plugins may
1267                         # consider it significant.
1268                         my @params;
1269                         while ($params =~ m{
1270                                 (?:([-\w]+)=)?          # 1: named parameter key?
1271                                 (?:
1272                                         """(.*?)"""     # 2: triple-quoted value
1273                                 |
1274                                         "([^"]*?)"      # 3: single-quoted value
1275                                 |
1276                                         (\S+)           # 4: unquoted value
1277                                 )
1278                                 (?:\s+|$)               # delimiter to next param
1279                         }sgx) {
1280                                 my $key=$1;
1281                                 my $val;
1282                                 if (defined $2) {
1283                                         $val=$2;
1284                                         $val=~s/\r\n/\n/mg;
1285                                         $val=~s/^\n+//g;
1286                                         $val=~s/\n+$//g;
1287                                 }
1288                                 elsif (defined $3) {
1289                                         $val=$3;
1290                                 }
1291                                 elsif (defined $4) {
1292                                         $val=$4;
1293                                 }
1294
1295                                 if (defined $key) {
1296                                         push @params, $key, $val;
1297                                 }
1298                                 else {
1299                                         push @params, $val, '';
1300                                 }
1301                         }
1302                         if ($preprocessing{$page}++ > 3) {
1303                                 # Avoid loops of preprocessed pages preprocessing
1304                                 # other pages that preprocess them, etc.
1305                                 return "[[!$command <span class=\"error\">".
1306                                         sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1307                                                 $page, $preprocessing{$page}).
1308                                         "</span>]]";
1309                         }
1310                         my $ret;
1311                         if (! $scan) {
1312                                 $ret=eval {
1313                                         $hooks{preprocess}{$command}{call}->(
1314                                                 @params,
1315                                                 page => $page,
1316                                                 destpage => $destpage,
1317                                                 preview => $preprocess_preview,
1318                                         );
1319                                 };
1320                                 if ($@) {
1321                                         my $error=$@;
1322                                         chomp $error;
1323                                         $ret="[[!$command <span class=\"error\">".
1324                                                 gettext("Error").": $error"."</span>]]";
1325                                 }
1326                         }
1327                         else {
1328                                 # use void context during scan pass
1329                                 eval {
1330                                         $hooks{preprocess}{$command}{call}->(
1331                                                 @params,
1332                                                 page => $page,
1333                                                 destpage => $destpage,
1334                                                 preview => $preprocess_preview,
1335                                         );
1336                                 };
1337                                 $ret="";
1338                         }
1339                         $preprocessing{$page}--;
1340                         return $ret;
1341                 }
1342                 else {
1343                         return "[[$prefix$command $params]]";
1344                 }
1345         };
1346
1347         my $regex;
1348         if ($config{prefix_directives}) {
1349                 $regex = qr{
1350                         (\\?)           # 1: escape?
1351                         \[\[(!)         # directive open; 2: prefix
1352                         ([-\w]+)        # 3: command
1353                         (               # 4: the parameters..
1354                                 \s+     # Must have space if parameters present
1355                                 (?:
1356                                         (?:[-\w]+=)?            # named parameter key?
1357                                         (?:
1358                                                 """.*?"""       # triple-quoted value
1359                                                 |
1360                                                 "[^"]*?"        # single-quoted value
1361                                                 |
1362                                                 [^"\s\]]+       # unquoted value
1363                                         )
1364                                         \s*                     # whitespace or end
1365                                                                 # of directive
1366                                 )
1367                         *)?             # 0 or more parameters
1368                         \]\]            # directive closed
1369                 }sx;
1370         }
1371         else {
1372                 $regex = qr{
1373                         (\\?)           # 1: escape?
1374                         \[\[(!?)        # directive open; 2: optional prefix
1375                         ([-\w]+)        # 3: command
1376                         \s+
1377                         (               # 4: the parameters..
1378                                 (?:
1379                                         (?:[-\w]+=)?            # named parameter key?
1380                                         (?:
1381                                                 """.*?"""       # triple-quoted value
1382                                                 |
1383                                                 "[^"]*?"        # single-quoted value
1384                                                 |
1385                                                 [^"\s\]]+       # unquoted value
1386                                         )
1387                                         \s*                     # whitespace or end
1388                                                                 # of directive
1389                                 )
1390                         *)              # 0 or more parameters
1391                         \]\]            # directive closed
1392                 }sx;
1393         }
1394
1395         $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1396         return $content;
1397 }
1398
1399 sub filter ($$$) {
1400         my $page=shift;
1401         my $destpage=shift;
1402         my $content=shift;
1403
1404         run_hooks(filter => sub {
1405                 $content=shift->(page => $page, destpage => $destpage,
1406                         content => $content);
1407         });
1408
1409         return $content;
1410 }
1411
1412 sub check_canedit ($$$;$) {
1413         my $page=shift;
1414         my $q=shift;
1415         my $session=shift;
1416         my $nonfatal=shift;
1417
1418         my $canedit;
1419         run_hooks(canedit => sub {
1420                 return if defined $canedit;
1421                 my $ret=shift->($page, $q, $session);
1422                 if (defined $ret) {
1423                         if ($ret eq "") {
1424                                 $canedit=1;
1425                         }
1426                         elsif (ref $ret eq 'CODE') {
1427                                 $ret->() unless $nonfatal;
1428                                 $canedit=0;
1429                         }
1430                         elsif (defined $ret) {
1431                                 error($ret) unless $nonfatal;
1432                                 $canedit=0;
1433                         }
1434                 }
1435         });
1436         return defined $canedit ? $canedit : 1;
1437 }
1438
1439 sub check_content (@) {
1440         my %params=@_;
1441
1442         return 1 if ! exists $hooks{checkcontent}; # optimisation
1443
1444         if (exists $pagesources{$params{page}}) {
1445                 my @diff;
1446                 my %old=map { $_ => 1 }
1447                         split("\n", readfile(srcfile($pagesources{$params{page}})));
1448                 foreach my $line (split("\n", $params{content})) {
1449                         push @diff, $line if ! exists $old{$line};
1450                 }
1451                 $params{diff}=join("\n", @diff);
1452         }
1453
1454         my $ok;
1455         run_hooks(checkcontent => sub {
1456                 return if defined $ok;
1457                 my $ret=shift->(%params);
1458                 if (defined $ret) {
1459                         if ($ret eq "") {
1460                                 $ok=1;
1461                         }
1462                         elsif (ref $ret eq 'CODE') {
1463                                 $ret->() unless $params{nonfatal};
1464                                 $ok=0;
1465                         }
1466                         elsif (defined $ret) {
1467                                 error($ret) unless $params{nonfatal};
1468                                 $ok=0;
1469                         }
1470                 }
1471
1472         });
1473         return defined $ok ? $ok : 1;
1474 }
1475
1476 my $wikilock;
1477
1478 sub lockwiki () {
1479         # Take an exclusive lock on the wiki to prevent multiple concurrent
1480         # run issues. The lock will be dropped on program exit.
1481         if (! -d $config{wikistatedir}) {
1482                 mkdir($config{wikistatedir});
1483         }
1484         open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1485                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1486         if (! flock($wikilock, 2)) { # LOCK_EX
1487                 error("failed to get lock");
1488         }
1489         return 1;
1490 }
1491
1492 sub unlockwiki () {
1493         POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1494         return close($wikilock) if $wikilock;
1495         return;
1496 }
1497
1498 my $commitlock;
1499
1500 sub commit_hook_enabled () {
1501         open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1502                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1503         if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1504                 close($commitlock) || error("failed closing commitlock: $!");
1505                 return 0;
1506         }
1507         close($commitlock) || error("failed closing commitlock: $!");
1508         return 1;
1509 }
1510
1511 sub disable_commit_hook () {
1512         open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1513                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1514         if (! flock($commitlock, 2)) { # LOCK_EX
1515                 error("failed to get commit lock");
1516         }
1517         return 1;
1518 }
1519
1520 sub enable_commit_hook () {
1521         return close($commitlock) if $commitlock;
1522         return;
1523 }
1524
1525 sub loadindex () {
1526         %oldrenderedfiles=%pagectime=();
1527         if (! $config{rebuild}) {
1528                 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1529                 %destsources=%renderedfiles=%pagecase=%pagestate=
1530                 %depends_simple=%typedlinks=%oldtypedlinks=();
1531         }
1532         my $in;
1533         if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1534                 if (-e "$config{wikistatedir}/index") {
1535                         system("ikiwiki-transition", "indexdb", $config{srcdir});
1536                         open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1537                 }
1538                 else {
1539                         $config{gettime}=1; # first build
1540                         return;
1541                 }
1542         }
1543
1544         my $index=Storable::fd_retrieve($in);
1545         if (! defined $index) {
1546                 return 0;
1547         }
1548
1549         my $pages;
1550         if (exists $index->{version} && ! ref $index->{version}) {
1551                 $pages=$index->{page};
1552                 %wikistate=%{$index->{state}};
1553         }
1554         else {
1555                 $pages=$index;
1556                 %wikistate=();
1557         }
1558
1559         foreach my $src (keys %$pages) {
1560                 my $d=$pages->{$src};
1561                 my $page=pagename($src);
1562                 $pagectime{$page}=$d->{ctime};
1563                 $pagesources{$page}=$src;
1564                 if (! $config{rebuild}) {
1565                         $pagemtime{$page}=$d->{mtime};
1566                         $renderedfiles{$page}=$d->{dest};
1567                         if (exists $d->{links} && ref $d->{links}) {
1568                                 $links{$page}=$d->{links};
1569                                 $oldlinks{$page}=[@{$d->{links}}];
1570                         }
1571                         if (ref $d->{depends_simple} eq 'ARRAY') {
1572                                 # old format
1573                                 $depends_simple{$page}={
1574                                         map { $_ => 1 } @{$d->{depends_simple}}
1575                                 };
1576                         }
1577                         elsif (exists $d->{depends_simple}) {
1578                                 $depends_simple{$page}=$d->{depends_simple};
1579                         }
1580                         if (exists $d->{dependslist}) {
1581                                 # old format
1582                                 $depends{$page}={
1583                                         map { $_ => $DEPEND_CONTENT }
1584                                                 @{$d->{dependslist}}
1585                                 };
1586                         }
1587                         elsif (exists $d->{depends} && ! ref $d->{depends}) {
1588                                 # old format
1589                                 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
1590                         }
1591                         elsif (exists $d->{depends}) {
1592                                 $depends{$page}=$d->{depends};
1593                         }
1594                         if (exists $d->{state}) {
1595                                 $pagestate{$page}=$d->{state};
1596                         }
1597                         if (exists $d->{typedlinks}) {
1598                                 $typedlinks{$page}=$d->{typedlinks};
1599
1600                                 while (my ($type, $links) = each %{$typedlinks{$page}}) {
1601                                         next unless %$links;
1602                                         $oldtypedlinks{$page}{$type} = {%$links};
1603                                 }
1604                         }
1605                 }
1606                 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1607         }
1608         foreach my $page (keys %pagesources) {
1609                 $pagecase{lc $page}=$page;
1610         }
1611         foreach my $page (keys %renderedfiles) {
1612                 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1613         }
1614         return close($in);
1615 }
1616
1617 sub saveindex () {
1618         run_hooks(savestate => sub { shift->() });
1619
1620         my %hookids;
1621         foreach my $type (keys %hooks) {
1622                 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1623         }
1624         my @hookids=keys %hookids;
1625
1626         if (! -d $config{wikistatedir}) {
1627                 mkdir($config{wikistatedir});
1628         }
1629         my $newfile="$config{wikistatedir}/indexdb.new";
1630         my $cleanup = sub { unlink($newfile) };
1631         open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1632
1633         my %index;
1634         foreach my $page (keys %pagemtime) {
1635                 next unless $pagemtime{$page};
1636                 my $src=$pagesources{$page};
1637
1638                 $index{page}{$src}={
1639                         ctime => $pagectime{$page},
1640                         mtime => $pagemtime{$page},
1641                         dest => $renderedfiles{$page},
1642                         links => $links{$page},
1643                 };
1644
1645                 if (exists $depends{$page}) {
1646                         $index{page}{$src}{depends} = $depends{$page};
1647                 }
1648
1649                 if (exists $depends_simple{$page}) {
1650                         $index{page}{$src}{depends_simple} = $depends_simple{$page};
1651                 }
1652
1653                 if (exists $typedlinks{$page} && %{$typedlinks{$page}}) {
1654                         $index{page}{$src}{typedlinks} = $typedlinks{$page};
1655                 }
1656
1657                 if (exists $pagestate{$page}) {
1658                         foreach my $id (@hookids) {
1659                                 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1660                                         $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1661                                 }
1662                         }
1663                 }
1664         }
1665
1666         $index{state}={};
1667         foreach my $id (@hookids) {
1668                 foreach my $key (keys %{$wikistate{$id}}) {
1669                         $index{state}{$id}{$key}=$wikistate{$id}{$key};
1670                 }
1671         }
1672
1673         $index{version}="3";
1674         my $ret=Storable::nstore_fd(\%index, $out);
1675         return if ! defined $ret || ! $ret;
1676         close $out || error("failed saving to $newfile: $!", $cleanup);
1677         rename($newfile, "$config{wikistatedir}/indexdb") ||
1678                 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1679
1680         return 1;
1681 }
1682
1683 sub template_file ($) {
1684         my $name=shift;
1685
1686         my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
1687         if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
1688                 $tpage=$pagesources{$tpage};
1689                 $name.=".tmpl";
1690         }
1691
1692         my $template=srcfile($tpage, 1);
1693         if (defined $template) {
1694                 return $template, $tpage, 1 if wantarray;
1695                 return $template;
1696         }
1697         else {
1698                 $name=~s:/::; # avoid path traversal
1699                 foreach my $dir ($config{templatedir},
1700                                  "$installdir/share/ikiwiki/templates") {
1701                         if (-e "$dir/$name") {
1702                                 $template="$dir/$name";
1703                                 last;
1704                         }
1705                 }
1706                 if (defined $template) {
1707                         return $template, $tpage if wantarray;
1708                         return $template;
1709                 }
1710         }
1711
1712         return;
1713 }
1714
1715 sub template_depends ($$;@) {
1716         my $name=shift;
1717         my $page=shift;
1718
1719         my ($filename, $tpage, $untrusted)=template_file($name);
1720         if (defined $page && defined $tpage) {
1721                 add_depends($page, $tpage);
1722         }
1723
1724         return unless defined $filename;
1725
1726         my @opts=(
1727                 filter => sub {
1728                         my $text_ref = shift;
1729                         ${$text_ref} = decode_utf8(${$text_ref});
1730                 },
1731                 loop_context_vars => 1,
1732                 die_on_bad_params => 0,
1733                 filename => $filename,
1734                 @_,
1735                 ($untrusted ? (no_includes => 1) : ()),
1736         );
1737         return @opts if wantarray;
1738
1739         require HTML::Template;
1740         return HTML::Template->new(@opts);
1741 }
1742
1743 sub template ($;@) {
1744         template_depends(shift, undef, @_);
1745 }
1746
1747 sub misctemplate ($$;@) {
1748         my $title=shift;
1749         my $content=shift;
1750         my %params=@_;
1751
1752         my $template=template("page.tmpl");
1753
1754         my $page="";
1755         if (exists $params{page}) {
1756                 $page=delete $params{page};
1757         }
1758         run_hooks(pagetemplate => sub {
1759                 shift->(
1760                         page => $page,
1761                         destpage => $page,
1762                         template => $template,
1763                 );
1764         });
1765         templateactions($template, "");
1766
1767         $template->param(
1768                 dynamic => 1,
1769                 title => $title,
1770                 wikiname => $config{wikiname},
1771                 content => $content,
1772                 baseurl => baseurl(),
1773                 html5 => $config{html5},
1774                 %params,
1775         );
1776
1777         return $template->output;
1778 }
1779
1780 sub templateactions ($$) {
1781         my $template=shift;
1782         my $page=shift;
1783
1784         my $have_actions=0;
1785         my @actions;
1786         run_hooks(pageactions => sub {
1787                 push @actions, map { { action => $_ } }
1788                         grep { defined } shift->(page => $page);
1789         });
1790         $template->param(actions => \@actions);
1791
1792         if ($config{cgiurl} && exists $hooks{auth}) {
1793                 $template->param(prefsurl => cgiurl(do => "prefs"));
1794                 $have_actions=1;
1795         }
1796
1797         if ($have_actions || @actions) {
1798                 $template->param(have_actions => 1);
1799         }
1800 }
1801
1802 sub hook (@) {
1803         my %param=@_;
1804
1805         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1806                 error 'hook requires type, call, and id parameters';
1807         }
1808
1809         return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1810
1811         $hooks{$param{type}}{$param{id}}=\%param;
1812         return 1;
1813 }
1814
1815 sub run_hooks ($$) {
1816         # Calls the given sub for each hook of the given type,
1817         # passing it the hook function to call.
1818         my $type=shift;
1819         my $sub=shift;
1820
1821         if (exists $hooks{$type}) {
1822                 my (@first, @middle, @last);
1823                 foreach my $id (keys %{$hooks{$type}}) {
1824                         if ($hooks{$type}{$id}{first}) {
1825                                 push @first, $id;
1826                         }
1827                         elsif ($hooks{$type}{$id}{last}) {
1828                                 push @last, $id;
1829                         }
1830                         else {
1831                                 push @middle, $id;
1832                         }
1833                 }
1834                 foreach my $id (@first, @middle, @last) {
1835                         $sub->($hooks{$type}{$id}{call});
1836                 }
1837         }
1838
1839         return 1;
1840 }
1841
1842 sub rcs_update () {
1843         $hooks{rcs}{rcs_update}{call}->(@_);
1844 }
1845
1846 sub rcs_prepedit ($) {
1847         $hooks{rcs}{rcs_prepedit}{call}->(@_);
1848 }
1849
1850 sub rcs_commit (@) {
1851         $hooks{rcs}{rcs_commit}{call}->(@_);
1852 }
1853
1854 sub rcs_commit_staged (@) {
1855         $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1856 }
1857
1858 sub rcs_add ($) {
1859         $hooks{rcs}{rcs_add}{call}->(@_);
1860 }
1861
1862 sub rcs_remove ($) {
1863         $hooks{rcs}{rcs_remove}{call}->(@_);
1864 }
1865
1866 sub rcs_rename ($$) {
1867         $hooks{rcs}{rcs_rename}{call}->(@_);
1868 }
1869
1870 sub rcs_recentchanges ($) {
1871         $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1872 }
1873
1874 sub rcs_diff ($) {
1875         $hooks{rcs}{rcs_diff}{call}->(@_);
1876 }
1877
1878 sub rcs_getctime ($) {
1879         $hooks{rcs}{rcs_getctime}{call}->(@_);
1880 }
1881
1882 sub rcs_getmtime ($) {
1883         $hooks{rcs}{rcs_getmtime}{call}->(@_);
1884 }
1885
1886 sub rcs_receive () {
1887         $hooks{rcs}{rcs_receive}{call}->();
1888 }
1889
1890 sub add_depends ($$;$) {
1891         my $page=shift;
1892         my $pagespec=shift;
1893         my $deptype=shift || $DEPEND_CONTENT;
1894
1895         # Is the pagespec a simple page name?
1896         if ($pagespec =~ /$config{wiki_file_regexp}/ &&
1897             $pagespec !~ /[\s*?()!]/) {
1898                 $depends_simple{$page}{lc $pagespec} |= $deptype;
1899                 return 1;
1900         }
1901
1902         # Add explicit dependencies for influences.
1903         my $sub=pagespec_translate($pagespec);
1904         return unless defined $sub;
1905         foreach my $p (keys %pagesources) {
1906                 my $r=$sub->($p, location => $page);
1907                 my $i=$r->influences;
1908                 my $static=$r->influences_static;
1909                 foreach my $k (keys %$i) {
1910                         next unless $r || $static || $k eq $page;
1911                         $depends_simple{$page}{lc $k} |= $i->{$k};
1912                 }
1913                 last if $static;
1914         }
1915
1916         $depends{$page}{$pagespec} |= $deptype;
1917         return 1;
1918 }
1919
1920 sub deptype (@) {
1921         my $deptype=0;
1922         foreach my $type (@_) {
1923                 if ($type eq 'presence') {
1924                         $deptype |= $DEPEND_PRESENCE;
1925                 }
1926                 elsif ($type eq 'links') {
1927                         $deptype |= $DEPEND_LINKS;
1928                 }
1929                 elsif ($type eq 'content') {
1930                         $deptype |= $DEPEND_CONTENT;
1931                 }
1932         }
1933         return $deptype;
1934 }
1935
1936 my $file_prune_regexp;
1937 sub file_pruned ($) {
1938         my $file=shift;
1939
1940         if (defined $config{include} && length $config{include}) {
1941                 return 0 if $file =~ m/$config{include}/;
1942         }
1943
1944         if (! defined $file_prune_regexp) {
1945                 $file_prune_regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1946                 $file_prune_regexp=qr/$file_prune_regexp/;
1947         }
1948         return $file =~ m/$file_prune_regexp/;
1949 }
1950
1951 sub define_gettext () {
1952         # If translation is needed, redefine the gettext function to do it.
1953         # Otherwise, it becomes a quick no-op.
1954         my $gettext_obj;
1955         my $getobj;
1956         if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1957             (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1958             (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1959                 $getobj=sub {
1960                         $gettext_obj=eval q{
1961                                 use Locale::gettext q{textdomain};
1962                                 Locale::gettext->domain('ikiwiki')
1963                         };
1964                 };
1965         }
1966
1967         no warnings 'redefine';
1968         *gettext=sub {
1969                 $getobj->() if $getobj;
1970                 if ($gettext_obj) {
1971                         $gettext_obj->get(shift);
1972                 }
1973                 else {
1974                         return shift;
1975                 }
1976         };
1977         *ngettext=sub {
1978                 $getobj->() if $getobj;
1979                 if ($gettext_obj) {
1980                         $gettext_obj->nget(@_);
1981                 }
1982                 else {
1983                         return ($_[2] == 1 ? $_[0] : $_[1])
1984                 }
1985         };
1986 }
1987
1988 sub gettext {
1989         define_gettext();
1990         gettext(@_);
1991 }
1992
1993 sub ngettext {
1994         define_gettext();
1995         ngettext(@_);
1996 }
1997
1998 sub yesno ($) {
1999         my $val=shift;
2000
2001         return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
2002 }
2003
2004 sub inject {
2005         # Injects a new function into the symbol table to replace an
2006         # exported function.
2007         my %params=@_;
2008
2009         # This is deep ugly perl foo, beware.
2010         no strict;
2011         no warnings;
2012         if (! defined $params{parent}) {
2013                 $params{parent}='::';
2014                 $params{old}=\&{$params{name}};
2015                 $params{name}=~s/.*:://;
2016         }
2017         my $parent=$params{parent};
2018         foreach my $ns (grep /^\w+::/, keys %{$parent}) {
2019                 $ns = $params{parent} . $ns;
2020                 inject(%params, parent => $ns) unless $ns eq '::main::';
2021                 *{$ns . $params{name}} = $params{call}
2022                         if exists ${$ns}{$params{name}} &&
2023                            \&{${$ns}{$params{name}}} == $params{old};
2024         }
2025         use strict;
2026         use warnings;
2027 }
2028
2029 sub add_link ($$;$) {
2030         my $page=shift;
2031         my $link=shift;
2032         my $type=shift;
2033
2034         push @{$links{$page}}, $link
2035                 unless grep { $_ eq $link } @{$links{$page}};
2036
2037         if (defined $type) {
2038                 $typedlinks{$page}{$type}{$link} = 1;
2039         }
2040 }
2041
2042 sub add_autofile ($$$) {
2043         my $file=shift;
2044         my $plugin=shift;
2045         my $generator=shift;
2046
2047         $autofiles{$file}{plugin}=$plugin;
2048         $autofiles{$file}{generator}=$generator;
2049 }
2050
2051 sub sortspec_translate ($$) {
2052         my $spec = shift;
2053         my $reverse = shift;
2054
2055         my $code = "";
2056         my @data;
2057         while ($spec =~ m{
2058                 \s*
2059                 (-?)            # group 1: perhaps negated
2060                 \s*
2061                 (               # group 2: a word
2062                         \w+\([^\)]*\)   # command(params)
2063                         |
2064                         [^\s]+          # or anything else
2065                 )
2066                 \s*
2067         }gx) {
2068                 my $negated = $1;
2069                 my $word = $2;
2070                 my $params = undef;
2071
2072                 if ($word =~ m/^(\w+)\((.*)\)$/) {
2073                         # command with parameters
2074                         $params = $2;
2075                         $word = $1;
2076                 }
2077                 elsif ($word !~ m/^\w+$/) {
2078                         error(sprintf(gettext("invalid sort type %s"), $word));
2079                 }
2080
2081                 if (length $code) {
2082                         $code .= " || ";
2083                 }
2084
2085                 if ($negated) {
2086                         $code .= "-";
2087                 }
2088
2089                 if (exists $IkiWiki::SortSpec::{"cmp_$word"}) {
2090                         if (defined $params) {
2091                                 push @data, $params;
2092                                 $code .= "IkiWiki::SortSpec::cmp_$word(\$data[$#data])";
2093                         }
2094                         else {
2095                                 $code .= "IkiWiki::SortSpec::cmp_$word(undef)";
2096                         }
2097                 }
2098                 else {
2099                         error(sprintf(gettext("unknown sort type %s"), $word));
2100                 }
2101         }
2102
2103         if (! length $code) {
2104                 # undefined sorting method... sort arbitrarily
2105                 return sub { 0 };
2106         }
2107
2108         if ($reverse) {
2109                 $code="-($code)";
2110         }
2111
2112         no warnings;
2113         return eval 'sub { '.$code.' }';
2114 }
2115
2116 sub pagespec_translate ($) {
2117         my $spec=shift;
2118
2119         # Convert spec to perl code.
2120         my $code="";
2121         my @data;
2122         while ($spec=~m{
2123                 \s*             # ignore whitespace
2124                 (               # 1: match a single word
2125                         \!              # !
2126                 |
2127                         \(              # (
2128                 |
2129                         \)              # )
2130                 |
2131                         \w+\([^\)]*\)   # command(params)
2132                 |
2133                         [^\s()]+        # any other text
2134                 )
2135                 \s*             # ignore whitespace
2136         }gx) {
2137                 my $word=$1;
2138                 if (lc $word eq 'and') {
2139                         $code.=' &';
2140                 }
2141                 elsif (lc $word eq 'or') {
2142                         $code.=' |';
2143                 }
2144                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
2145                         $code.=' '.$word;
2146                 }
2147                 elsif ($word =~ /^(\w+)\((.*)\)$/) {
2148                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
2149                                 push @data, $2;
2150                                 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
2151                         }
2152                         else {
2153                                 push @data, qq{unknown function in pagespec "$word"};
2154                                 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
2155                         }
2156                 }
2157                 else {
2158                         push @data, $word;
2159                         $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
2160                 }
2161         }
2162
2163         if (! length $code) {
2164                 $code="IkiWiki::FailReason->new('empty pagespec')";
2165         }
2166
2167         no warnings;
2168         return eval 'sub { my $page=shift; '.$code.' }';
2169 }
2170
2171 sub pagespec_match ($$;@) {
2172         my $page=shift;
2173         my $spec=shift;
2174         my @params=@_;
2175
2176         # Backwards compatability with old calling convention.
2177         if (@params == 1) {
2178                 unshift @params, 'location';
2179         }
2180
2181         my $sub=pagespec_translate($spec);
2182         return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
2183                 if ! defined $sub;
2184         return $sub->($page, @params);
2185 }
2186
2187 sub pagespec_match_list ($$;@) {
2188         my $page=shift;
2189         my $pagespec=shift;
2190         my %params=@_;
2191
2192         # Backwards compatability with old calling convention.
2193         if (ref $page) {
2194                 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
2195                 $params{list}=$page;
2196                 $page=$params{location}; # ugh!
2197         }
2198
2199         my $sub=pagespec_translate($pagespec);
2200         error "syntax error in pagespec \"$pagespec\""
2201                 if ! defined $sub;
2202         my $sort=sortspec_translate($params{sort}, $params{reverse})
2203                 if defined $params{sort};
2204
2205         my @candidates;
2206         if (exists $params{list}) {
2207                 @candidates=exists $params{filter}
2208                         ? grep { ! $params{filter}->($_) } @{$params{list}}
2209                         : @{$params{list}};
2210         }
2211         else {
2212                 @candidates=exists $params{filter}
2213                         ? grep { ! $params{filter}->($_) } keys %pagesources
2214                         : keys %pagesources;
2215         }
2216
2217         # clear params, remainder is passed to pagespec
2218         $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2219         my $num=$params{num};
2220         delete @params{qw{num deptype reverse sort filter list}};
2221
2222         # when only the top matches will be returned, it's efficient to
2223         # sort before matching to pagespec,
2224         if (defined $num && defined $sort) {
2225                 @candidates=IkiWiki::SortSpec::sort_pages(
2226                         $sort, @candidates);
2227         }
2228
2229         my @matches;
2230         my $firstfail;
2231         my $count=0;
2232         my $accum=IkiWiki::SuccessReason->new();
2233         foreach my $p (@candidates) {
2234                 my $r=$sub->($p, %params, location => $page);
2235                 error(sprintf(gettext("cannot match pages: %s"), $r))
2236                         if $r->isa("IkiWiki::ErrorReason");
2237                 unless ($r || $r->influences_static) {
2238                         $r->remove_influence($p);
2239                 }
2240                 $accum |= $r;
2241                 if ($r) {
2242                         push @matches, $p;
2243                         last if defined $num && ++$count == $num;
2244                 }
2245         }
2246
2247         # Add simple dependencies for accumulated influences.
2248         my $i=$accum->influences;
2249         foreach my $k (keys %$i) {
2250                 $depends_simple{$page}{lc $k} |= $i->{$k};
2251         }
2252
2253         # when all matches will be returned, it's efficient to
2254         # sort after matching
2255         if (! defined $num && defined $sort) {
2256                 return IkiWiki::SortSpec::sort_pages(
2257                         $sort, @matches);
2258         }
2259         else {
2260                 return @matches;
2261         }
2262 }
2263
2264 sub pagespec_valid ($) {
2265         my $spec=shift;
2266
2267         return defined pagespec_translate($spec);
2268 }
2269
2270 sub glob2re ($) {
2271         my $re=quotemeta(shift);
2272         $re=~s/\\\*/.*/g;
2273         $re=~s/\\\?/./g;
2274         return $re;
2275 }
2276
2277 package IkiWiki::FailReason;
2278
2279 use overload (
2280         '""'    => sub { $_[0][0] },
2281         '0+'    => sub { 0 },
2282         '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2283         '&'     => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2284         '|'     => sub { $_[1]->merge_influences($_[0]); $_[1] },
2285         fallback => 1,
2286 );
2287
2288 our @ISA = 'IkiWiki::SuccessReason';
2289
2290 package IkiWiki::SuccessReason;
2291
2292 use overload (
2293         '""'    => sub { $_[0][0] },
2294         '0+'    => sub { 1 },
2295         '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
2296         '&'     => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2297         '|'     => sub { $_[0]->merge_influences($_[1]); $_[0] },
2298         fallback => 1,
2299 );
2300
2301 sub new {
2302         my $class = shift;
2303         my $value = shift;
2304         return bless [$value, {@_}], $class;
2305 }
2306
2307 sub influences {
2308         my $this=shift;
2309         $this->[1]={@_} if @_;
2310         my %i=%{$this->[1]};
2311         delete $i{""};
2312         return \%i;
2313 }
2314
2315 sub influences_static {
2316         return ! $_[0][1]->{""};
2317 }
2318
2319 sub merge_influences {
2320         my $this=shift;
2321         my $other=shift;
2322         my $anded=shift;
2323
2324         if (! $anded || (($this || %{$this->[1]}) &&
2325                          ($other || %{$other->[1]}))) {
2326                 foreach my $influence (keys %{$other->[1]}) {
2327                         $this->[1]{$influence} |= $other->[1]{$influence};
2328                 }
2329         }
2330         else {
2331                 # influence blocker
2332                 $this->[1]={};
2333         }
2334 }
2335
2336 sub remove_influence {
2337         my $this=shift;
2338         my $torm=shift;
2339
2340         delete $this->[1]{$torm};
2341 }
2342
2343 package IkiWiki::ErrorReason;
2344
2345 our @ISA = 'IkiWiki::FailReason';
2346
2347 package IkiWiki::PageSpec;
2348
2349 sub derel ($$) {
2350         my $path=shift;
2351         my $from=shift;
2352
2353         if ($path =~ m!^\./!) {
2354                 $from=~s#/?[^/]+$## if defined $from;
2355                 $path=~s#^\./##;
2356                 $path="$from/$path" if defined $from && length $from;
2357         }
2358
2359         return $path;
2360 }
2361
2362 sub match_glob ($$;@) {
2363         my $page=shift;
2364         my $glob=shift;
2365         my %params=@_;
2366
2367         $glob=derel($glob, $params{location});
2368
2369         my $regexp=IkiWiki::glob2re($glob);
2370         if ($page=~/^$regexp$/i) {
2371                 if (! IkiWiki::isinternal($page) || $params{internal}) {
2372                         return IkiWiki::SuccessReason->new("$glob matches $page");
2373                 }
2374                 else {
2375                         return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2376                 }
2377         }
2378         else {
2379                 return IkiWiki::FailReason->new("$glob does not match $page");
2380         }
2381 }
2382
2383 sub match_internal ($$;@) {
2384         return match_glob(shift, shift, @_, internal => 1)
2385 }
2386
2387 sub match_page ($$;@) {
2388         my $page=shift;
2389         my $match=match_glob($page, shift, @_);
2390         if ($match && ! (exists $IkiWiki::pagesources{$page}
2391             && defined IkiWiki::pagetype($IkiWiki::pagesources{$page}))) {
2392                 return IkiWiki::FailReason->new("$page is not a page");
2393         }
2394         else {
2395                 return $match;
2396         }
2397 }
2398
2399 sub match_link ($$;@) {
2400         my $page=shift;
2401         my $link=lc(shift);
2402         my %params=@_;
2403
2404         $link=derel($link, $params{location});
2405         my $from=exists $params{location} ? $params{location} : '';
2406         my $linktype=$params{linktype};
2407         my $qualifier='';
2408         if (defined $linktype) {
2409                 $qualifier=" with type $linktype";
2410         }
2411
2412         my $links = $IkiWiki::links{$page};
2413         return IkiWiki::FailReason->new("$page has no links", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2414                 unless $links && @{$links};
2415         my $bestlink = IkiWiki::bestlink($from, $link);
2416         foreach my $p (@{$links}) {
2417                 next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
2418
2419                 if (length $bestlink) {
2420                         if ($bestlink eq IkiWiki::bestlink($page, $p)) {
2421                                 return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2422                         }
2423                 }
2424                 else {
2425                         if (match_glob($p, $link, %params)) {
2426                                 return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2427                         }
2428                         my ($p_rel)=$p=~/^\/?(.*)/;
2429                         $link=~s/^\///;
2430                         if (match_glob($p_rel, $link, %params)) {
2431                                 return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2432                         }
2433                 }
2434         }
2435         return IkiWiki::FailReason->new("$page does not link to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1);
2436 }
2437
2438 sub match_backlink ($$;@) {
2439         my $ret=match_link($_[1], $_[0], @_);
2440         $ret->influences($_[1] => $IkiWiki::DEPEND_LINKS);
2441         return $ret;
2442 }
2443
2444 sub match_created_before ($$;@) {
2445         my $page=shift;
2446         my $testpage=shift;
2447         my %params=@_;
2448
2449         $testpage=derel($testpage, $params{location});
2450
2451         if (exists $IkiWiki::pagectime{$testpage}) {
2452                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2453                         return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2454                 }
2455                 else {
2456                         return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2457                 }
2458         }
2459         else {
2460                 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2461         }
2462 }
2463
2464 sub match_created_after ($$;@) {
2465         my $page=shift;
2466         my $testpage=shift;
2467         my %params=@_;
2468
2469         $testpage=derel($testpage, $params{location});
2470
2471         if (exists $IkiWiki::pagectime{$testpage}) {
2472                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2473                         return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2474                 }
2475                 else {
2476                         return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2477                 }
2478         }
2479         else {
2480                 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2481         }
2482 }
2483
2484 sub match_creation_day ($$;@) {
2485         if ((localtime($IkiWiki::pagectime{shift()}))[3] == shift) {
2486                 return IkiWiki::SuccessReason->new('creation_day matched');
2487         }
2488         else {
2489                 return IkiWiki::FailReason->new('creation_day did not match');
2490         }
2491 }
2492
2493 sub match_creation_month ($$;@) {
2494         if ((localtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
2495                 return IkiWiki::SuccessReason->new('creation_month matched');
2496         }
2497         else {
2498                 return IkiWiki::FailReason->new('creation_month did not match');
2499         }
2500 }
2501
2502 sub match_creation_year ($$;@) {
2503         if ((localtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
2504                 return IkiWiki::SuccessReason->new('creation_year matched');
2505         }
2506         else {
2507                 return IkiWiki::FailReason->new('creation_year did not match');
2508         }
2509 }
2510
2511 sub match_user ($$;@) {
2512         shift;
2513         my $user=shift;
2514         my %params=@_;
2515
2516         my $regexp=IkiWiki::glob2re($user);
2517
2518         if (! exists $params{user}) {
2519                 return IkiWiki::ErrorReason->new("no user specified");
2520         }
2521
2522         if (defined $params{user} && $params{user}=~/^$regexp$/i) {
2523                 return IkiWiki::SuccessReason->new("user is $user");
2524         }
2525         elsif (! defined $params{user}) {
2526                 return IkiWiki::FailReason->new("not logged in");
2527         }
2528         else {
2529                 return IkiWiki::FailReason->new("user is $params{user}, not $user");
2530         }
2531 }
2532
2533 sub match_admin ($$;@) {
2534         shift;
2535         shift;
2536         my %params=@_;
2537
2538         if (! exists $params{user}) {
2539                 return IkiWiki::ErrorReason->new("no user specified");
2540         }
2541
2542         if (defined $params{user} && IkiWiki::is_admin($params{user})) {
2543                 return IkiWiki::SuccessReason->new("user is an admin");
2544         }
2545         elsif (! defined $params{user}) {
2546                 return IkiWiki::FailReason->new("not logged in");
2547         }
2548         else {
2549                 return IkiWiki::FailReason->new("user is not an admin");
2550         }
2551 }
2552
2553 sub match_ip ($$;@) {
2554         shift;
2555         my $ip=shift;
2556         my %params=@_;
2557
2558         if (! exists $params{ip}) {
2559                 return IkiWiki::ErrorReason->new("no IP specified");
2560         }
2561
2562         if (defined $params{ip} && lc $params{ip} eq lc $ip) {
2563                 return IkiWiki::SuccessReason->new("IP is $ip");
2564         }
2565         else {
2566                 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
2567         }
2568 }
2569
2570 package IkiWiki::SortSpec;
2571
2572 # This is in the SortSpec namespace so that the $a and $b that sort() uses
2573 # are easily available in this namespace, for cmp functions to use them.
2574 sub sort_pages {
2575         my $f=shift;
2576         sort $f @_
2577 }
2578
2579 sub cmp_title {
2580         IkiWiki::pagetitle(IkiWiki::basename($a))
2581         cmp
2582         IkiWiki::pagetitle(IkiWiki::basename($b))
2583 }
2584
2585 sub cmp_mtime { $IkiWiki::pagemtime{$b} <=> $IkiWiki::pagemtime{$a} }
2586 sub cmp_age { $IkiWiki::pagectime{$b} <=> $IkiWiki::pagectime{$a} }
2587
2588 1