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