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