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         my $targetpage='';
 652         run_hooks(targetpage => sub {
 653                 $targetpage=shift->(
 654                         page => $page,
 655                         ext => $ext,
 656                 );
 657         });
 658
 659         if (defined $targetpage && (length($targetpage) > 0)) {
 660                 return $targetpage;
 661         }
 662         elsif (! $config{usedirs} || $page eq 'index') {
 663                 return $page.".".$ext;
 664         }
 665         else {
 666                 return $page."/index.".$ext;
 667         }
 668 } #}}}
 669
 670 sub htmlpage ($) { #{{{
 671         my $page=shift;
 672
 673         return targetpage($page, $config{htmlext});
 674 } #}}}
 675
 676 sub srcfile_stat { #{{{
 677         my $file=shift;
 678         my $nothrow=shift;
 679
 680         return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
 681         foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
 682                 return "$dir/$file", stat(_) if -e "$dir/$file";
 683         }
 684         error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
 685         return;
 686 } #}}}
 687
 688 sub srcfile ($;$) { #{{{
 689         return (srcfile_stat(@_))[0];
 690 } #}}}
 691
 692 sub add_underlay ($) { #{{{
 693         my $dir=shift;
 694
 695         if ($dir !~ /^\//) {
 696                 $dir="$config{underlaydir}/../$dir";
 697         }
 698
 699         if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
 700                 unshift @{$config{underlaydirs}}, $dir;
 701         }
 702
 703         return 1;
 704 } #}}}
 705
 706 sub readfile ($;$$) { #{{{
 707         my $file=shift;
 708         my $binary=shift;
 709         my $wantfd=shift;
 710
 711         if (-l $file) {
 712                 error("cannot read a symlink ($file)");
 713         }
 714
 715         local $/=undef;
 716         open (my $in, "<", $file) || error("failed to read $file: $!");
 717         binmode($in) if ($binary);
 718         return \*$in if $wantfd;
 719         my $ret=<$in>;
 720         close $in || error("failed to read $file: $!");
 721         return $ret;
 722 } #}}}
 723
 724 sub prep_writefile ($$) { #{{{
 725         my $file=shift;
 726         my $destdir=shift;
 727
 728         my $test=$file;
 729         while (length $test) {
 730                 if (-l "$destdir/$test") {
 731                         error("cannot write to a symlink ($test)");
 732                 }
 733                 $test=dirname($test);
 734         }
 735
 736         my $dir=dirname("$destdir/$file");
 737         if (! -d $dir) {
 738                 my $d="";
 739                 foreach my $s (split(m!/+!, $dir)) {
 740                         $d.="$s/";
 741                         if (! -d $d) {
 742                                 mkdir($d) || error("failed to create directory $d: $!");
 743                         }
 744                 }
 745         }
 746
 747         return 1;
 748 } #}}}
 749
 750 sub writefile ($$$;$$) { #{{{
 751         my $file=shift; # can include subdirs
 752         my $destdir=shift; # directory to put file in
 753         my $content=shift;
 754         my $binary=shift;
 755         my $writer=shift;
 756
 757         prep_writefile($file, $destdir);
 758
 759         my $newfile="$destdir/$file.ikiwiki-new";
 760         if (-l $newfile) {
 761                 error("cannot write to a symlink ($newfile)");
 762         }
 763
 764         my $cleanup = sub { unlink($newfile) };
 765         open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
 766         binmode($out) if ($binary);
 767         if ($writer) {
 768                 $writer->(\*$out, $cleanup);
 769         }
 770         else {
 771                 print $out $content or error("failed writing to $newfile: $!", $cleanup);
 772         }
 773         close $out || error("failed saving $newfile: $!", $cleanup);
 774         rename($newfile, "$destdir/$file") ||
 775                 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
 776
 777         return 1;
 778 } #}}}
 779
 780 my %cleared;
 781 sub will_render ($$;$) { #{{{
 782         my $page=shift;
 783         my $dest=shift;
 784         my $clear=shift;
 785
 786         # Important security check.
 787         if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
 788             ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
 789                 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
 790         }
 791
 792         if (! $clear || $cleared{$page}) {
 793                 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
 794         }
 795         else {
 796                 foreach my $old (@{$renderedfiles{$page}}) {
 797                         delete $destsources{$old};
 798                 }
 799                 $renderedfiles{$page}=[$dest];
 800                 $cleared{$page}=1;
 801         }
 802         $destsources{$dest}=$page;
 803
 804         return 1;
 805 } #}}}
 806
 807 sub bestlink ($$) { #{{{
 808         my $page=shift;
 809         my $link=shift;
 810
 811         my $cwd=$page;
 812         if ($link=~s/^\/+//) {
 813                 # absolute links
 814                 $cwd="";
 815         }
 816         $link=~s/\/$//;
 817
 818         do {
 819                 my $l=$cwd;
 820                 $l.="/" if length $l;
 821                 $l.=$link;
 822
 823                 if (exists $links{$l}) {
 824                         return $l;
 825                 }
 826                 elsif (exists $pagecase{lc $l}) {
 827                         return $pagecase{lc $l};
 828                 }
 829         } while $cwd=~s{/?[^/]+$}{};
 830
 831         if (length $config{userdir}) {
 832                 my $l = "$config{userdir}/".lc($link);
 833                 if (exists $links{$l}) {
 834                         return $l;
 835                 }
 836                 elsif (exists $pagecase{lc $l}) {
 837                         return $pagecase{lc $l};
 838                 }
 839         }
 840
 841         #print STDERR "warning: page $page, broken link: $link\n";
 842         return "";
 843 } #}}}
 844
 845 sub isinlinableimage ($) { #{{{
 846         my $file=shift;
 847
 848         return $file =~ /\.(png|gif|jpg|jpeg)$/i;
 849 } #}}}
 850
 851 sub pagetitle ($;$) { #{{{
 852         my $page=shift;
 853         my $unescaped=shift;
 854
 855         if ($unescaped) {
 856                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
 857         }
 858         else {
 859                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
 860         }
 861
 862         return $page;
 863 } #}}}
 864
 865 sub titlepage ($) { #{{{
 866         my $title=shift;
 867         # support use w/o %config set
 868         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
 869         $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
 870         return $title;
 871 } #}}}
 872
 873 sub linkpage ($) { #{{{
 874         my $link=shift;
 875         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
 876         $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
 877         return $link;
 878 } #}}}
 879
 880 sub cgiurl (@) { #{{{
 881         my %params=@_;
 882
 883         return $config{cgiurl}."?".
 884                 join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
 885 } #}}}
 886
 887 sub baseurl (;$) { #{{{
 888         my $page=shift;
 889
 890         return "$config{url}/" if ! defined $page;
 891
 892         $page=htmlpage($page);
 893         $page=~s/[^\/]+$//;
 894         $page=~s/[^\/]+\//..\//g;
 895         return $page;
 896 } #}}}
 897
 898 sub abs2rel ($$) { #{{{
 899         # Work around very innefficient behavior in File::Spec if abs2rel
 900         # is passed two relative paths. It's much faster if paths are
 901         # absolute! (Debian bug #376658; fixed in debian unstable now)
 902         my $path="/".shift;
 903         my $base="/".shift;
 904
 905         require File::Spec;
 906         my $ret=File::Spec->abs2rel($path, $base);
 907         $ret=~s/^// if defined $ret;
 908         return $ret;
 909 } #}}}
 910
 911 sub displaytime ($;$) { #{{{
 912         my $time=shift;
 913         my $format=shift;
 914         if (! defined $format) {
 915                 $format=$config{timeformat};
 916         }
 917
 918         # strftime doesn't know about encodings, so make sure
 919         # its output is properly treated as utf8
 920         return decode_utf8(POSIX::strftime($format, localtime($time)));
 921 } #}}}
 922
 923 sub beautify_urlpath ($) { #{{{
 924         my $url=shift;
 925
 926         if ($config{usedirs}) {
 927                 $url =~ s!/index.$config{htmlext}$!/!;
 928         }
 929
 930         # Ensure url is not an empty link, and
 931         # if it's relative, make that explicit to avoid colon confusion.
 932         if ($url !~ /^\//) {
 933                 $url="./$url";
 934         }
 935
 936         return $url;
 937 } #}}}
 938
 939 sub urlto ($$;$) { #{{{
 940         my $to=shift;
 941         my $from=shift;
 942         my $absolute=shift;
 943
 944         if (! length $to) {
 945                 return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
 946         }
 947
 948         if (! $destsources{$to}) {
 949                 $to=htmlpage($to);
 950         }
 951
 952         if ($absolute) {
 953                 return $config{url}.beautify_urlpath("/".$to);
 954         }
 955
 956         my $link = abs2rel($to, dirname(htmlpage($from)));
 957
 958         return beautify_urlpath($link);
 959 } #}}}
 960
 961 sub htmllink ($$$;@) { #{{{
 962         my $lpage=shift; # the page doing the linking
 963         my $page=shift; # the page that will contain the link (different for inline)
 964         my $link=shift;
 965         my %opts=@_;
 966
 967         $link=~s/\/$//;
 968
 969         my $bestlink;
 970         if (! $opts{forcesubpage}) {
 971                 $bestlink=bestlink($lpage, $link);
 972         }
 973         else {
 974                 $bestlink="$lpage/".lc($link);
 975         }
 976
 977         my $linktext;
 978         if (defined $opts{linktext}) {
 979                 $linktext=$opts{linktext};
 980         }
 981         else {
 982                 $linktext=pagetitle(basename($link));
 983         }
 984
 985         return "<span class=\"selflink\">$linktext</span>"
 986                 if length $bestlink && $page eq $bestlink &&
 987                    ! defined $opts{anchor};
 988
 989         if (! $destsources{$bestlink}) {
 990                 $bestlink=htmlpage($bestlink);
 991
 992                 if (! $destsources{$bestlink}) {
 993                         return $linktext unless length $config{cgiurl};
 994                         return "<span class=\"createlink\"><a href=\"".
 995                                 cgiurl(
 996                                         do => "create",
 997                                         page => lc($link),
 998                                         from => $lpage
 999                                 ).
1000                                 "\" rel=\"nofollow\">?</a>$linktext</span>"
1001                 }
1002         }
1003
1004         $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1005         $bestlink=beautify_urlpath($bestlink);
1006
1007         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1008                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1009         }
1010
1011         if (defined $opts{anchor}) {
1012                 $bestlink.="#".$opts{anchor};
1013         }
1014
1015         my @attrs;
1016         if (defined $opts{rel}) {
1017                 push @attrs, ' rel="'.$opts{rel}.'"';
1018         }
1019         if (defined $opts{class}) {
1020                 push @attrs, ' class="'.$opts{class}.'"';
1021         }
1022
1023         return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1024 } #}}}
1025
1026 sub userlink ($) { #{{{
1027         my $user=shift;
1028
1029         my $oiduser=eval { openiduser($user) };
1030         if (defined $oiduser) {
1031                 return "<a href=\"$user\">$oiduser</a>";
1032         }
1033         else {
1034                 eval q{use CGI 'escapeHTML'};
1035                 error($@) if $@;
1036
1037                 return htmllink("", "", escapeHTML(
1038                         length $config{userdir} ? $config{userdir}."/".$user : $user
1039                 ), noimageinline => 1);
1040         }
1041 } #}}}
1042
1043 sub htmlize ($$$$) { #{{{
1044         my $page=shift;
1045         my $destpage=shift;
1046         my $type=shift;
1047         my $content=shift;
1048
1049         my $oneline = $content !~ /\n/;
1050
1051         if (exists $hooks{htmlize}{$type}) {
1052                 $content=$hooks{htmlize}{$type}{call}->(
1053                         page => $page,
1054                         content => $content,
1055                 );
1056         }
1057         else {
1058                 error("htmlization of $type not supported");
1059         }
1060
1061         run_hooks(sanitize => sub {
1062                 $content=shift->(
1063                         page => $page,
1064                         destpage => $destpage,
1065                         content => $content,
1066                 );
1067         });
1068
1069         if ($oneline) {
1070                 # hack to get rid of enclosing junk added by markdown
1071                 # and other htmlizers
1072                 $content=~s/^<p>//i;
1073                 $content=~s/<\/p>$//i;
1074                 chomp $content;
1075         }
1076
1077         return $content;
1078 } #}}}
1079
1080 sub linkify ($$$) { #{{{
1081         my $page=shift;
1082         my $destpage=shift;
1083         my $content=shift;
1084
1085         run_hooks(linkify => sub {
1086                 $content=shift->(
1087                         page => $page,
1088                         destpage => $destpage,
1089                         content => $content,
1090                 );
1091         });
1092
1093         return $content;
1094 } #}}}
1095
1096 our %preprocessing;
1097 our $preprocess_preview=0;
1098 sub preprocess ($$$;$$) { #{{{
1099         my $page=shift; # the page the data comes from
1100         my $destpage=shift; # the page the data will appear in (different for inline)
1101         my $content=shift;
1102         my $scan=shift;
1103         my $preview=shift;
1104
1105         # Using local because it needs to be set within any nested calls
1106         # of this function.
1107         local $preprocess_preview=$preview if defined $preview;
1108
1109         my $handle=sub {
1110                 my $escape=shift;
1111                 my $prefix=shift;
1112                 my $command=shift;
1113                 my $params=shift;
1114                 $params="" if ! defined $params;
1115
1116                 if (length $escape) {
1117                         return "[[$prefix$command $params]]";
1118                 }
1119                 elsif (exists $hooks{preprocess}{$command}) {
1120                         return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1121                         # Note: preserve order of params, some plugins may
1122                         # consider it significant.
1123                         my @params;
1124                         while ($params =~ m{
1125                                 (?:([-\w]+)=)?          # 1: named parameter key?
1126                                 (?:
1127                                         """(.*?)"""     # 2: triple-quoted value
1128                                 |
1129                                         "([^"]+)"       # 3: single-quoted value
1130                                 |
1131                                         (\S+)           # 4: unquoted value
1132                                 )
1133                                 (?:\s+|$)               # delimiter to next param
1134                         }sgx) {
1135                                 my $key=$1;
1136                                 my $val;
1137                                 if (defined $2) {
1138                                         $val=$2;
1139                                         $val=~s/\r\n/\n/mg;
1140                                         $val=~s/^\n+//g;
1141                                         $val=~s/\n+$//g;
1142                                 }
1143                                 elsif (defined $3) {
1144                                         $val=$3;
1145                                 }
1146                                 elsif (defined $4) {
1147                                         $val=$4;
1148                                 }
1149
1150                                 if (defined $key) {
1151                                         push @params, $key, $val;
1152                                 }
1153                                 else {
1154                                         push @params, $val, '';
1155                                 }
1156                         }
1157                         if ($preprocessing{$page}++ > 3) {
1158                                 # Avoid loops of preprocessed pages preprocessing
1159                                 # other pages that preprocess them, etc.
1160                                 return "[[!$command <span class=\"error\">".
1161                                         sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1162                                                 $page, $preprocessing{$page}).
1163                                         "</span>]]";
1164                         }
1165                         my $ret;
1166                         if (! $scan) {
1167                                 $ret=eval {
1168                                         $hooks{preprocess}{$command}{call}->(
1169                                                 @params,
1170                                                 page => $page,
1171                                                 destpage => $destpage,
1172                                                 preview => $preprocess_preview,
1173                                         );
1174                                 };
1175                                 if ($@) {
1176                                         chomp $@;
1177                                         $ret="[[!$command <span class=\"error\">".
1178                                                 gettext("Error").": $@"."</span>]]";
1179                                 }
1180                         }
1181                         else {
1182                                 # use void context during scan pass
1183                                 eval {
1184                                         $hooks{preprocess}{$command}{call}->(
1185                                                 @params,
1186                                                 page => $page,
1187                                                 destpage => $destpage,
1188                                                 preview => $preprocess_preview,
1189                                         );
1190                                 };
1191                                 $ret="";
1192                         }
1193                         $preprocessing{$page}--;
1194                         return $ret;
1195                 }
1196                 else {
1197                         return "[[$prefix$command $params]]";
1198                 }
1199         };
1200
1201         my $regex;
1202         if ($config{prefix_directives}) {
1203                 $regex = qr{
1204                         (\\?)           # 1: escape?
1205                         \[\[(!)         # directive open; 2: prefix
1206                         ([-\w]+)        # 3: command
1207                         (               # 4: the parameters..
1208                                 \s+     # Must have space if parameters present
1209                                 (?:
1210                                         (?:[-\w]+=)?            # named parameter key?
1211                                         (?:
1212                                                 """.*?"""       # triple-quoted value
1213                                                 |
1214                                                 "[^"]+"         # single-quoted value
1215                                                 |
1216                                                 [^\s\]]+        # unquoted value
1217                                         )
1218                                         \s*                     # whitespace or end
1219                                                                 # of directive
1220                                 )
1221                         *)?             # 0 or more parameters
1222                         \]\]            # directive closed
1223                 }sx;
1224         }
1225         else {
1226                 $regex = qr{
1227                         (\\?)           # 1: escape?
1228                         \[\[(!?)        # directive open; 2: optional prefix
1229                         ([-\w]+)        # 3: command
1230                         \s+
1231                         (               # 4: the parameters..
1232                                 (?:
1233                                         (?:[-\w]+=)?            # named parameter key?
1234                                         (?:
1235                                                 """.*?"""       # triple-quoted value
1236                                                 |
1237                                                 "[^"]+"         # single-quoted value
1238                                                 |
1239                                                 [^\s\]]+        # unquoted value
1240                                         )
1241                                         \s*                     # whitespace or end
1242                                                                 # of directive
1243                                 )
1244                         *)              # 0 or more parameters
1245                         \]\]            # directive closed
1246                 }sx;
1247         }
1248
1249         $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1250         return $content;
1251 } #}}}
1252
1253 sub filter ($$$) { #{{{
1254         my $page=shift;
1255         my $destpage=shift;
1256         my $content=shift;
1257
1258         run_hooks(filter => sub {
1259                 $content=shift->(page => $page, destpage => $destpage,
1260                         content => $content);
1261         });
1262
1263         return $content;
1264 } #}}}
1265
1266 sub indexlink () { #{{{
1267         return "<a href=\"$config{url}\">$config{wikiname}</a>";
1268 } #}}}
1269
1270 my $wikilock;
1271
1272 sub lockwiki (;$) { #{{{
1273         my $wait=@_ ? shift : 1;
1274         # Take an exclusive lock on the wiki to prevent multiple concurrent
1275         # run issues. The lock will be dropped on program exit.
1276         if (! -d $config{wikistatedir}) {
1277                 mkdir($config{wikistatedir});
1278         }
1279         open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1280                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1281         if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
1282                 if ($wait) {
1283                         debug("wiki seems to be locked, waiting for lock");
1284                         my $wait=600; # arbitrary, but don't hang forever to
1285                                       # prevent process pileup
1286                         for (1..$wait) {
1287                                 return if flock($wikilock, 2 | 4);
1288                                 sleep 1;
1289                         }
1290                         error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
1291                 }
1292                 else {
1293                         return 0;
1294                 }
1295         }
1296         return 1;
1297 } #}}}
1298
1299 sub unlockwiki () { #{{{
1300         return close($wikilock) if $wikilock;
1301         return;
1302 } #}}}
1303
1304 my $commitlock;
1305
1306 sub commit_hook_enabled () { #{{{
1307         open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1308                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1309         if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1310                 close($commitlock) || error("failed closing commitlock: $!");
1311                 return 0;
1312         }
1313         close($commitlock) || error("failed closing commitlock: $!");
1314         return 1;
1315 } #}}}
1316
1317 sub disable_commit_hook () { #{{{
1318         open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1319                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1320         if (! flock($commitlock, 2)) { # LOCK_EX
1321                 error("failed to get commit lock");
1322         }
1323         return 1;
1324 } #}}}
1325
1326 sub enable_commit_hook () { #{{{
1327         return close($commitlock) if $commitlock;
1328         return;
1329 } #}}}
1330
1331 sub loadindex () { #{{{
1332         %oldrenderedfiles=%pagectime=();
1333         if (! $config{rebuild}) {
1334                 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1335                 %destsources=%renderedfiles=%pagecase=%pagestate=();
1336         }
1337         my $in;
1338         if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1339                 if (-e "$config{wikistatedir}/index") {
1340                         system("ikiwiki-transition", "indexdb", $config{srcdir});
1341                         open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1342                 }
1343                 else {
1344                         return;
1345                 }
1346         }
1347
1348         my $index=Storable::fd_retrieve($in);
1349         if (! defined $index) {
1350                 return 0;
1351         }
1352
1353         my $pages;
1354         if (exists $index->{version} && ! ref $index->{version}) {
1355                 $pages=$index->{page};
1356                 %wikistate=%{$index->{state}};
1357         }
1358         else {
1359                 $pages=$index;
1360                 %wikistate=();
1361         }
1362
1363         foreach my $src (keys %$pages) {
1364                 my $d=$pages->{$src};
1365                 my $page=pagename($src);
1366                 $pagectime{$page}=$d->{ctime};
1367                 if (! $config{rebuild}) {
1368                         $pagesources{$page}=$src;
1369                         $pagemtime{$page}=$d->{mtime};
1370                         $renderedfiles{$page}=$d->{dest};
1371                         if (exists $d->{links} && ref $d->{links}) {
1372                                 $links{$page}=$d->{links};
1373                                 $oldlinks{$page}=[@{$d->{links}}];
1374                         }
1375                         if (exists $d->{depends}) {
1376                                 $depends{$page}=$d->{depends};
1377                         }
1378                         if (exists $d->{state}) {
1379                                 $pagestate{$page}=$d->{state};
1380                         }
1381                 }
1382                 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1383         }
1384         foreach my $page (keys %pagesources) {
1385                 $pagecase{lc $page}=$page;
1386         }
1387         foreach my $page (keys %renderedfiles) {
1388                 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1389         }
1390         return close($in);
1391 } #}}}
1392
1393 sub saveindex () { #{{{
1394         run_hooks(savestate => sub { shift->() });
1395
1396         my %hookids;
1397         foreach my $type (keys %hooks) {
1398                 $hookids{$_}=1 foreach keys %{$hooks{$type}};
1399         }
1400         my @hookids=keys %hookids;
1401
1402         if (! -d $config{wikistatedir}) {
1403                 mkdir($config{wikistatedir});
1404         }
1405         my $newfile="$config{wikistatedir}/indexdb.new";
1406         my $cleanup = sub { unlink($newfile) };
1407         open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1408
1409         my %index;
1410         foreach my $page (keys %pagemtime) {
1411                 next unless $pagemtime{$page};
1412                 my $src=$pagesources{$page};
1413
1414                 $index{page}{$src}={
1415                         ctime => $pagectime{$page},
1416                         mtime => $pagemtime{$page},
1417                         dest => $renderedfiles{$page},
1418                         links => $links{$page},
1419                 };
1420
1421                 if (exists $depends{$page}) {
1422                         $index{page}{$src}{depends} = $depends{$page};
1423                 }
1424
1425                 if (exists $pagestate{$page}) {
1426                         foreach my $id (@hookids) {
1427                                 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1428                                         $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1429                                 }
1430                         }
1431                 }
1432         }
1433
1434         $index{state}={};
1435         foreach my $id (@hookids) {
1436                 foreach my $key (keys %{$wikistate{$id}}) {
1437                         $index{state}{$id}{$key}=$wikistate{$id}{$key};
1438                 }
1439         }
1440
1441         $index{version}="3";
1442         my $ret=Storable::nstore_fd(\%index, $out);
1443         return if ! defined $ret || ! $ret;
1444         close $out || error("failed saving to $newfile: $!", $cleanup);
1445         rename($newfile, "$config{wikistatedir}/indexdb") ||
1446                 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1447
1448         return 1;
1449 } #}}}
1450
1451 sub template_file ($) { #{{{
1452         my $template=shift;
1453
1454         foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
1455                 return "$dir/$template" if -e "$dir/$template";
1456         }
1457         return;
1458 } #}}}
1459
1460 sub template_params (@) { #{{{
1461         my $filename=template_file(shift);
1462
1463         if (! defined $filename) {
1464                 return if wantarray;
1465                 return "";
1466         }
1467
1468         my @ret=(
1469                 filter => sub {
1470                         my $text_ref = shift;
1471                         ${$text_ref} = decode_utf8(${$text_ref});
1472                 },
1473                 filename => $filename,
1474                 loop_context_vars => 1,
1475                 die_on_bad_params => 0,
1476                 @_
1477         );
1478         return wantarray ? @ret : {@ret};
1479 } #}}}
1480
1481 sub template ($;@) { #{{{
1482         require HTML::Template;
1483         return HTML::Template->new(template_params(@_));
1484 } #}}}
1485
1486 sub misctemplate ($$;@) { #{{{
1487         my $title=shift;
1488         my $pagebody=shift;
1489
1490         my $template=template("misc.tmpl");
1491         $template->param(
1492                 title => $title,
1493                 indexlink => indexlink(),
1494                 wikiname => $config{wikiname},
1495                 pagebody => $pagebody,
1496                 baseurl => baseurl(),
1497                 @_,
1498         );
1499         run_hooks(pagetemplate => sub {
1500                 shift->(page => "", destpage => "", template => $template);
1501         });
1502         return $template->output;
1503 }#}}}
1504
1505 sub hook (@) { # {{{
1506         my %param=@_;
1507
1508         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
1509                 error 'hook requires type, call, and id parameters';
1510         }
1511
1512         return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
1513
1514         $hooks{$param{type}}{$param{id}}=\%param;
1515         return 1;
1516 } # }}}
1517
1518 sub run_hooks ($$) { # {{{
1519         # Calls the given sub for each hook of the given type,
1520         # passing it the hook function to call.
1521         my $type=shift;
1522         my $sub=shift;
1523
1524         if (exists $hooks{$type}) {
1525                 my @deferred;
1526                 foreach my $id (keys %{$hooks{$type}}) {
1527                         if ($hooks{$type}{$id}{last}) {
1528                                 push @deferred, $id;
1529                                 next;
1530                         }
1531                         $sub->($hooks{$type}{$id}{call});
1532                 }
1533                 foreach my $id (@deferred) {
1534                         $sub->($hooks{$type}{$id}{call});
1535                 }
1536         }
1537
1538         return 1;
1539 } #}}}
1540
1541 sub rcs_update () { #{{{
1542         $hooks{rcs}{rcs_update}{call}->(@_);
1543 } #}}}
1544
1545 sub rcs_prepedit ($) { #{{{
1546         $hooks{rcs}{rcs_prepedit}{call}->(@_);
1547 } #}}}
1548
1549 sub rcs_commit ($$$;$$) { #{{{
1550         $hooks{rcs}{rcs_commit}{call}->(@_);
1551 } #}}}
1552
1553 sub rcs_commit_staged ($$$) { #{{{
1554         $hooks{rcs}{rcs_commit_staged}{call}->(@_);
1555 } #}}}
1556
1557 sub rcs_add ($) { #{{{
1558         $hooks{rcs}{rcs_add}{call}->(@_);
1559 } #}}}
1560
1561 sub rcs_remove ($) { #{{{
1562         $hooks{rcs}{rcs_remove}{call}->(@_);
1563 } #}}}
1564
1565 sub rcs_rename ($$) { #{{{
1566         $hooks{rcs}{rcs_rename}{call}->(@_);
1567 } #}}}
1568
1569 sub rcs_recentchanges ($) { #{{{
1570         $hooks{rcs}{rcs_recentchanges}{call}->(@_);
1571 } #}}}
1572
1573 sub rcs_diff ($) { #{{{
1574         $hooks{rcs}{rcs_diff}{call}->(@_);
1575 } #}}}
1576
1577 sub rcs_getctime ($) { #{{{
1578         $hooks{rcs}{rcs_getctime}{call}->(@_);
1579 } #}}}
1580
1581 sub globlist_to_pagespec ($) { #{{{
1582         my @globlist=split(' ', shift);
1583
1584         my (@spec, @skip);
1585         foreach my $glob (@globlist) {
1586                 if ($glob=~/^!(.*)/) {
1587                         push @skip, $glob;
1588                 }
1589                 else {
1590                         push @spec, $glob;
1591                 }
1592         }
1593
1594         my $spec=join(' or ', @spec);
1595         if (@skip) {
1596                 my $skip=join(' and ', @skip);
1597                 if (length $spec) {
1598                         $spec="$skip and ($spec)";
1599                 }
1600                 else {
1601                         $spec=$skip;
1602                 }
1603         }
1604         return $spec;
1605 } #}}}
1606
1607 sub is_globlist ($) { #{{{
1608         my $s=shift;
1609         return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
1610 } #}}}
1611
1612 sub safequote ($) { #{{{
1613         my $s=shift;
1614         $s=~s/[{}]//g;
1615         return "q{$s}";
1616 } #}}}
1617
1618 sub add_depends ($$) { #{{{
1619         my $page=shift;
1620         my $pagespec=shift;
1621
1622         return unless pagespec_valid($pagespec);
1623
1624         if (! exists $depends{$page}) {
1625                 $depends{$page}=$pagespec;
1626         }
1627         else {
1628                 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
1629         }
1630
1631         return 1;
1632 } # }}}
1633
1634 sub file_pruned ($$) { #{{{
1635         require File::Spec;
1636         my $file=File::Spec->canonpath(shift);
1637         my $base=File::Spec->canonpath(shift);
1638         $file =~ s#^\Q$base\E/+##;
1639
1640         my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
1641         return $file =~ m/$regexp/ && $file ne $base;
1642 } #}}}
1643
1644 sub gettext { #{{{
1645         # Only use gettext in the rare cases it's needed.
1646         if ((exists $ENV{LANG} && length $ENV{LANG}) ||
1647             (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
1648             (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
1649                 if (! $gettext_obj) {
1650                         $gettext_obj=eval q{
1651                                 use Locale::gettext q{textdomain};
1652                                 Locale::gettext->domain('ikiwiki')
1653                         };
1654                         if ($@) {
1655                                 print STDERR "$@";
1656                                 $gettext_obj=undef;
1657                                 return shift;
1658                         }
1659                 }
1660                 return $gettext_obj->get(shift);
1661         }
1662         else {
1663                 return shift;
1664         }
1665 } #}}}
1666
1667 sub yesno ($) { #{{{
1668         my $val=shift;
1669
1670         return (defined $val && lc($val) eq gettext("yes"));
1671 } #}}}
1672
1673 sub pagespec_merge ($$) { #{{{
1674         my $a=shift;
1675         my $b=shift;
1676
1677         return $a if $a eq $b;
1678
1679         # Support for old-style GlobLists.
1680         if (is_globlist($a)) {
1681                 $a=globlist_to_pagespec($a);
1682         }
1683         if (is_globlist($b)) {
1684                 $b=globlist_to_pagespec($b);
1685         }
1686
1687         return "($a) or ($b)";
1688 } #}}}
1689
1690 sub pagespec_translate ($) { #{{{
1691         my $spec=shift;
1692
1693         # Support for old-style GlobLists.
1694         if (is_globlist($spec)) {
1695                 $spec=globlist_to_pagespec($spec);
1696         }
1697
1698         # Convert spec to perl code.
1699         my $code="";
1700         while ($spec=~m{
1701                 \s*             # ignore whitespace
1702                 (               # 1: match a single word
1703                         \!              # !
1704                 |
1705                         \(              # (
1706                 |
1707                         \)              # )
1708                 |
1709                         \w+\([^\)]*\)   # command(params)
1710                 |
1711                         [^\s()]+        # any other text
1712                 )
1713                 \s*             # ignore whitespace
1714         }igx) {
1715                 my $word=$1;
1716                 if (lc $word eq 'and') {
1717                         $code.=' &&';
1718                 }
1719                 elsif (lc $word eq 'or') {
1720                         $code.=' ||';
1721                 }
1722                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
1723                         $code.=' '.$word;
1724                 }
1725                 elsif ($word =~ /^(\w+)\((.*)\)$/) {
1726                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
1727                                 $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
1728                         }
1729                         else {
1730                                 $code.=' 0';
1731                         }
1732                 }
1733                 else {
1734                         $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
1735                 }
1736         }
1737
1738         if (! length $code) {
1739                 $code=0;
1740         }
1741
1742         no warnings;
1743         return eval 'sub { my $page=shift; '.$code.' }';
1744 } #}}}
1745
1746 sub pagespec_match ($$;@) { #{{{
1747         my $page=shift;
1748         my $spec=shift;
1749         my @params=@_;
1750
1751         # Backwards compatability with old calling convention.
1752         if (@params == 1) {
1753                 unshift @params, 'location';
1754         }
1755
1756         my $sub=pagespec_translate($spec);
1757         return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
1758         return $sub->($page, @params);
1759 } #}}}
1760
1761 sub pagespec_valid ($) { #{{{
1762         my $spec=shift;
1763
1764         my $sub=pagespec_translate($spec);
1765         return ! $@;
1766 } #}}}
1767
1768 sub glob2re ($) { #{{{
1769         my $re=quotemeta(shift);
1770         $re=~s/\\\*/.*/g;
1771         $re=~s/\\\?/./g;
1772         return $re;
1773 } #}}}
1774
1775 package IkiWiki::FailReason;
1776
1777 use overload ( #{{{
1778         '""'    => sub { ${$_[0]} },
1779         '0+'    => sub { 0 },
1780         '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
1781         fallback => 1,
1782 ); #}}}
1783
1784 sub new { #{{{
1785         my $class = shift;
1786         my $value = shift;
1787         return bless \$value, $class;
1788 } #}}}
1789
1790 package IkiWiki::SuccessReason;
1791
1792 use overload ( #{{{
1793         '""'    => sub { ${$_[0]} },
1794         '0+'    => sub { 1 },
1795         '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
1796         fallback => 1,
1797 ); #}}}
1798
1799 sub new { #{{{
1800         my $class = shift;
1801         my $value = shift;
1802         return bless \$value, $class;
1803 }; #}}}
1804
1805 package IkiWiki::PageSpec;
1806
1807 sub match_glob ($$;@) { #{{{
1808         my $page=shift;
1809         my $glob=shift;
1810         my %params=@_;
1811
1812         my $from=exists $params{location} ? $params{location} : '';
1813
1814         # relative matching
1815         if ($glob =~ m!^\./!) {
1816                 $from=~s#/?[^/]+$##;
1817                 $glob=~s#^\./##;
1818                 $glob="$from/$glob" if length $from;
1819         }
1820
1821         my $regexp=IkiWiki::glob2re($glob);
1822         if ($page=~/^$regexp$/i) {
1823                 if (! IkiWiki::isinternal($page) || $params{internal}) {
1824                         return IkiWiki::SuccessReason->new("$glob matches $page");
1825                 }
1826                 else {
1827                         return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
1828                 }
1829         }
1830         else {
1831                 return IkiWiki::FailReason->new("$glob does not match $page");
1832         }
1833 } #}}}
1834
1835 sub match_internal ($$;@) { #{{{
1836         return match_glob($_[0], $_[1], @_, internal => 1)
1837 } #}}}
1838
1839 sub match_link ($$;@) { #{{{
1840         my $page=shift;
1841         my $link=lc(shift);
1842         my %params=@_;
1843
1844         my $from=exists $params{location} ? $params{location} : '';
1845
1846         # relative matching
1847         if ($link =~ m!^\.! && defined $from) {
1848                 $from=~s#/?[^/]+$##;
1849                 $link=~s#^\./##;
1850                 $link="$from/$link" if length $from;
1851         }
1852
1853         my $links = $IkiWiki::links{$page};
1854         return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
1855         my $bestlink = IkiWiki::bestlink($from, $link);
1856         foreach my $p (@{$links}) {
1857                 if (length $bestlink) {
1858                         return IkiWiki::SuccessReason->new("$page links to $link")
1859                                 if $bestlink eq IkiWiki::bestlink($page, $p);
1860                 }
1861                 else {
1862                         return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
1863                                 if match_glob($p, $link, %params);
1864                 }
1865         }
1866         return IkiWiki::FailReason->new("$page does not link to $link");
1867 } #}}}
1868
1869 sub match_backlink ($$;@) { #{{{
1870         return match_link($_[1], $_[0], @_);
1871 } #}}}
1872
1873 sub match_created_before ($$;@) { #{{{
1874         my $page=shift;
1875         my $testpage=shift;
1876
1877         if (exists $IkiWiki::pagectime{$testpage}) {
1878                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
1879                         return IkiWiki::SuccessReason->new("$page created before $testpage");
1880                 }
1881                 else {
1882                         return IkiWiki::FailReason->new("$page not created before $testpage");
1883                 }
1884         }
1885         else {
1886                 return IkiWiki::FailReason->new("$testpage has no ctime");
1887         }
1888 } #}}}
1889
1890 sub match_created_after ($$;@) { #{{{
1891         my $page=shift;
1892         my $testpage=shift;
1893
1894         if (exists $IkiWiki::pagectime{$testpage}) {
1895                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
1896                         return IkiWiki::SuccessReason->new("$page created after $testpage");
1897                 }
1898                 else {
1899                         return IkiWiki::FailReason->new("$page not created after $testpage");
1900                 }
1901         }
1902         else {
1903                 return IkiWiki::FailReason->new("$testpage has no ctime");
1904         }
1905 } #}}}
1906
1907 sub match_creation_day ($$;@) { #{{{
1908         if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
1909                 return IkiWiki::SuccessReason->new('creation_day matched');
1910         }
1911         else {
1912                 return IkiWiki::FailReason->new('creation_day did not match');
1913         }
1914 } #}}}
1915
1916 sub match_creation_month ($$;@) { #{{{
1917         if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
1918                 return IkiWiki::SuccessReason->new('creation_month matched');
1919         }
1920         else {
1921                 return IkiWiki::FailReason->new('creation_month did not match');
1922         }
1923 } #}}}
1924
1925 sub match_creation_year ($$;@) { #{{{
1926         if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
1927                 return IkiWiki::SuccessReason->new('creation_year matched');
1928         }
1929         else {
1930                 return IkiWiki::FailReason->new('creation_year did not match');
1931         }
1932 } #}}}
1933
1934 sub match_user ($$;@) { #{{{
1935         shift;
1936         my $user=shift;
1937         my %params=@_;
1938
1939         if (! exists $params{user}) {
1940                 return IkiWiki::FailReason->new("no user specified");
1941         }
1942
1943         if (defined $params{user} && lc $params{user} eq lc $user) {
1944                 return IkiWiki::SuccessReason->new("user is $user");
1945         }
1946         elsif (! defined $params{user}) {
1947                 return IkiWiki::FailReason->new("not logged in");
1948         }
1949         else {
1950                 return IkiWiki::FailReason->new("user is $params{user}, not $user");
1951         }
1952 } #}}}
1953
1954 sub match_admin ($$;@) { #{{{
1955         shift;
1956         shift;
1957         my %params=@_;
1958
1959         if (! exists $params{user}) {
1960                 return IkiWiki::FailReason->new("no user specified");
1961         }
1962
1963         if (defined $params{user} && IkiWiki::is_admin($params{user})) {
1964                 return IkiWiki::SuccessReason->new("user is an admin");
1965         }
1966         elsif (! defined $params{user}) {
1967                 return IkiWiki::FailReason->new("not logged in");
1968         }
1969         else {
1970                 return IkiWiki::FailReason->new("user is not an admin");
1971         }
1972 } #}}}
1973
1974 sub match_ip ($$;@) { #{{{
1975         shift;
1976         my $ip=shift;
1977         my %params=@_;
1978
1979         if (! exists $params{ip}) {
1980                 return IkiWiki::FailReason->new("no IP specified");
1981         }
1982
1983         if (defined $params{ip} && lc $params{ip} eq lc $ip) {
1984                 return IkiWiki::SuccessReason->new("IP is $ip");
1985         }
1986         else {
1987                 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
1988         }
1989 } #}}}
1990
1991 1