IkiWiki.pm

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