git.oblomov.eu Git - ikiwiki/blob - IkiWiki.pm

   1 #!/usr/bin/perl
   2
   3 package IkiWiki;
   4
   5 use warnings;
   6 use strict;
   7 use Encode;
   8 use URI::Escape q{uri_escape_utf8};
   9 use POSIX ();
  10 use Storable;
  11 use open qw{:utf8 :std};
  12
  13 use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
  14         %pagestate %wikistate %renderedfiles %oldrenderedfiles
  15         %pagesources %delpagesources %destsources %depends %depends_simple
  16         @mass_depends %hooks %forcerebuild %loaded_plugins %typedlinks
  17         %oldtypedlinks %autofiles};
  18
  19 use Exporter q{import};
  20 our @EXPORT = qw(hook debug error htmlpage template template_depends
  21         deptype add_depends pagespec_match pagespec_match_list bestlink
  22         htmllink readfile writefile pagetype srcfile pagename
  23         displaytime strftime_utf8 will_render gettext ngettext urlto targetpage
  24         add_underlay pagetitle titlepage linkpage newpagefile
  25         inject add_link add_autofile useragent
  26         %config %links %pagestate %wikistate %renderedfiles
  27         %pagesources %destsources %typedlinks);
  28 our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
  29 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
  30 our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
  31
  32 # Page dependency types.
  33 our $DEPEND_CONTENT=1;
  34 our $DEPEND_PRESENCE=2;
  35 our $DEPEND_LINKS=4;
  36
  37 # Optimisation.
  38 use Memoize;
  39 memoize("abs2rel");
  40 memoize("sortspec_translate");
  41 memoize("pagespec_translate");
  42 memoize("template_file");
  43
  44 sub getsetup () {
  45         wikiname => {
  46                 type => "string",
  47                 default => "wiki",
  48                 description => "name of the wiki",
  49                 safe => 1,
  50                 rebuild => 1,
  51         },
  52         adminemail => {
  53                 type => "string",
  54                 default => undef,
  55                 example => 'me@example.com',
  56                 description => "contact email for wiki",
  57                 safe => 1,
  58                 rebuild => 0,
  59         },
  60         adminuser => {
  61                 type => "string",
  62                 default => [],
  63                 description => "users who are wiki admins",
  64                 safe => 1,
  65                 rebuild => 0,
  66         },
  67         banned_users => {
  68                 type => "string",
  69                 default => [],
  70                 description => "users who are banned from the wiki",
  71                 safe => 1,
  72                 rebuild => 0,
  73         },
  74         srcdir => {
  75                 type => "string",
  76                 default => undef,
  77                 example => "$ENV{HOME}/wiki",
  78                 description => "where the source of the wiki is located",
  79                 safe => 0, # path
  80                 rebuild => 1,
  81         },
  82         destdir => {
  83                 type => "string",
  84                 default => undef,
  85                 example => "/var/www/wiki",
  86                 description => "where to build the wiki",
  87                 safe => 0, # path
  88                 rebuild => 1,
  89         },
  90         url => {
  91                 type => "string",
  92                 default => '',
  93                 example => "http://example.com/wiki",
  94                 description => "base url to the wiki",
  95                 safe => 1,
  96                 rebuild => 1,
  97         },
  98         cgiurl => {
  99                 type => "string",
 100                 default => '',
 101                 example => "http://example.com/wiki/ikiwiki.cgi",
 102                 description => "url to the ikiwiki.cgi",
 103                 safe => 1,
 104                 rebuild => 1,
 105         },
 106         cgi_wrapper => {
 107                 type => "string",
 108                 default => '',
 109                 example => "/var/www/wiki/ikiwiki.cgi",
 110                 description => "filename of cgi wrapper to generate",
 111                 safe => 0, # file
 112                 rebuild => 0,
 113         },
 114         cgi_wrappermode => {
 115                 type => "string",
 116                 default => '06755',
 117                 description => "mode for cgi_wrapper (can safely be made suid)",
 118                 safe => 0,
 119                 rebuild => 0,
 120         },
 121         cgi_overload_delay => {
 122                 type => "string",
 123                 default => '',
 124                 example => "10",
 125                 description => "number of seconds to delay CGI requests when overloaded",
 126                 safe => 1,
 127                 rebuild => 0,
 128         },
 129         cgi_overload_message => {
 130                 type => "string",
 131                 default => '',
 132                 example => "Please wait",
 133                 description => "message to display when overloaded (may contain html)",
 134                 safe => 1,
 135                 rebuild => 0,
 136         },
 137         rcs => {
 138                 type => "string",
 139                 default => '',
 140                 description => "rcs backend to use",
 141                 safe => 0, # don't allow overriding
 142                 rebuild => 0,
 143         },
 144         default_plugins => {
 145                 type => "internal",
 146                 default => [qw{mdwn link inline meta htmlscrubber passwordauth
 147                                 openid signinedit lockedit conditional
 148                                 recentchanges parentlinks editpage}],
 149                 description => "plugins to enable by default",
 150                 safe => 0,
 151                 rebuild => 1,
 152         },
 153         add_plugins => {
 154                 type => "string",
 155                 default => [],
 156                 description => "plugins to add to the default configuration",
 157                 safe => 1,
 158                 rebuild => 1,
 159         },
 160         disable_plugins => {
 161                 type => "string",
 162                 default => [],
 163                 description => "plugins to disable",
 164                 safe => 1,
 165                 rebuild => 1,
 166         },
 167         templatedir => {
 168                 type => "string",
 169                 default => "$installdir/share/ikiwiki/templates",
 170                 description => "additional directory to search for template files",
 171                 advanced => 1,
 172                 safe => 0, # path
 173                 rebuild => 1,
 174         },
 175         underlaydir => {
 176                 type => "string",
 177                 default => "$installdir/share/ikiwiki/basewiki",
 178                 description => "base wiki source location",
 179                 advanced => 1,
 180                 safe => 0, # path
 181                 rebuild => 0,
 182         },
 183         underlaydirbase => {
 184                 type => "internal",
 185                 default => "$installdir/share/ikiwiki",
 186                 description => "parent directory containing additional underlays",
 187                 safe => 0,
 188                 rebuild => 0,
 189         },
 190         wrappers => {
 191                 type => "internal",
 192                 default => [],
 193                 description => "wrappers to generate",
 194                 safe => 0,
 195                 rebuild => 0,
 196         },
 197         underlaydirs => {
 198                 type => "internal",
 199                 default => [],
 200                 description => "additional underlays to use",
 201                 safe => 0,
 202                 rebuild => 0,
 203         },
 204         verbose => {
 205                 type => "boolean",
 206                 example => 1,
 207                 description => "display verbose messages?",
 208                 safe => 1,
 209                 rebuild => 0,
 210         },
 211         syslog => {
 212                 type => "boolean",
 213                 example => 1,
 214                 description => "log to syslog?",
 215                 safe => 1,
 216                 rebuild => 0,
 217         },
 218         usedirs => {
 219                 type => "boolean",
 220                 default => 1,
 221                 description => "create output files named page/index.html?",
 222                 safe => 0, # changing requires manual transition
 223                 rebuild => 1,
 224         },
 225         prefix_directives => {
 226                 type => "boolean",
 227                 default => 1,
 228                 description => "use '!'-prefixed preprocessor directives?",
 229                 safe => 0, # changing requires manual transition
 230                 rebuild => 1,
 231         },
 232         indexpages => {
 233                 type => "boolean",
 234                 default => 0,
 235                 description => "use page/index.mdwn source files",
 236                 safe => 1,
 237                 rebuild => 1,
 238         },
 239         discussion => {
 240                 type => "boolean",
 241                 default => 1,
 242                 description => "enable Discussion pages?",
 243                 safe => 1,
 244                 rebuild => 1,
 245         },
 246         discussionpage => {
 247                 type => "string",
 248                 default => gettext("Discussion"),
 249                 description => "name of Discussion pages",
 250                 safe => 1,
 251                 rebuild => 1,
 252         },
 253         html5 => {
 254                 type => "boolean",
 255                 default => 0,
 256                 description => "generate HTML5?",
 257                 advanced => 0,
 258                 safe => 1,
 259                 rebuild => 1,
 260         },
 261         sslcookie => {
 262                 type => "boolean",
 263                 default => 0,
 264                 description => "only send cookies over SSL connections?",
 265                 advanced => 1,
 266                 safe => 1,
 267                 rebuild => 0,
 268         },
 269         default_pageext => {
 270                 type => "string",
 271                 default => "mdwn",
 272                 description => "extension to use for new pages",
 273                 safe => 0, # not sanitized
 274                 rebuild => 0,
 275         },
 276         htmlext => {
 277                 type => "string",
 278                 default => "html",
 279                 description => "extension to use for html files",
 280                 safe => 0, # not sanitized
 281                 rebuild => 1,
 282         },
 283         timeformat => {
 284                 type => "string",
 285                 default => '%c',
 286                 description => "strftime format string to display date",
 287                 advanced => 1,
 288                 safe => 1,
 289                 rebuild => 1,
 290         },
 291         locale => {
 292                 type => "string",
 293                 default => undef,
 294                 example => "en_US.UTF-8",
 295                 description => "UTF-8 locale to use",
 296                 advanced => 1,
 297                 safe => 0,
 298                 rebuild => 1,
 299         },
 300         userdir => {
 301                 type => "string",
 302                 default => "",
 303                 example => "users",
 304                 description => "put user pages below specified page",
 305                 safe => 1,
 306                 rebuild => 1,
 307         },
 308         numbacklinks => {
 309                 type => "integer",
 310                 default => 10,
 311                 description => "how many backlinks to show before hiding excess (0 to show all)",
 312                 safe => 1,
 313                 rebuild => 1,
 314         },
 315         hardlink => {
 316                 type => "boolean",
 317                 default => 0,
 318                 description => "attempt to hardlink source files? (optimisation for large files)",
 319                 advanced => 1,
 320                 safe => 0, # paranoia
 321                 rebuild => 0,
 322         },
 323         umask => {
 324                 type => "string",
 325                 example => "public",
 326                 description => "force ikiwiki to use a particular umask (keywords public, group or private, or a number)",
 327                 advanced => 1,
 328                 safe => 0, # paranoia
 329                 rebuild => 0,
 330         },
 331         wrappergroup => {
 332                 type => "string",
 333                 example => "ikiwiki",
 334                 description => "group for wrappers to run in",
 335                 advanced => 1,
 336                 safe => 0, # paranoia
 337                 rebuild => 0,
 338         },
 339         libdir => {
 340                 type => "string",
 341                 default => "",
 342                 example => "$ENV{HOME}/.ikiwiki/",
 343                 description => "extra library and plugin directory",
 344                 advanced => 1,
 345                 safe => 0, # directory
 346                 rebuild => 0,
 347         },
 348         ENV => {
 349                 type => "string",
 350                 default => {},
 351                 description => "environment variables",
 352                 safe => 0, # paranoia
 353                 rebuild => 0,
 354         },
 355         timezone => {
 356                 type => "string",
 357                 default => "",
 358                 example => "US/Eastern",
 359                 description => "time zone name",
 360                 safe => 1,
 361                 rebuild => 1,
 362         },
 363         include => {
 364                 type => "string",
 365                 default => undef,
 366                 example => '^\.htaccess$',
 367                 description => "regexp of normally excluded files to include",
 368                 advanced => 1,
 369                 safe => 0, # regexp
 370                 rebuild => 1,
 371         },
 372         exclude => {
 373                 type => "string",
 374                 default => undef,
 375                 example => '^(*\.private|Makefile)$',
 376                 description => "regexp of files that should be skipped",
 377                 advanced => 1,
 378                 safe => 0, # regexp
 379                 rebuild => 1,
 380         },
 381         wiki_file_prune_regexps => {
 382                 type => "internal",
 383                 default => [qr/(^|\/)\.\.(\/|$)/, qr/^\//, qr/^\./, qr/\/\./,
 384                         qr/\.x?html?$/, qr/\.ikiwiki-new$/,
 385                         qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
 386                         qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
 387                         qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
 388                 description => "regexps of source files to ignore",
 389                 safe => 0,
 390                 rebuild => 1,
 391         },
 392         wiki_file_chars => {
 393                 type => "string",
 394                 description => "specifies the characters that are allowed in source filenames",
 395                 default => "-[:alnum:]+/.:_",
 396                 safe => 0,
 397                 rebuild => 1,
 398         },
 399         wiki_file_regexp => {
 400                 type => "internal",
 401                 description => "regexp of legal source files",
 402                 safe => 0,
 403                 rebuild => 1,
 404         },
 405         web_commit_regexp => {
 406                 type => "internal",
 407                 default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
 408                 description => "regexp to parse web commits from logs",
 409                 safe => 0,
 410                 rebuild => 0,
 411         },
 412         cgi => {
 413                 type => "internal",
 414                 default => 0,
 415                 description => "run as a cgi",
 416                 safe => 0,
 417                 rebuild => 0,
 418         },
 419         cgi_disable_uploads => {
 420                 type => "internal",
 421                 default => 1,
 422                 description => "whether CGI should accept file uploads",
 423                 safe => 0,
 424                 rebuild => 0,
 425         },
 426         post_commit => {
 427                 type => "internal",
 428                 default => 0,
 429                 description => "run as a post-commit hook",
 430                 safe => 0,
 431                 rebuild => 0,
 432         },
 433         rebuild => {
 434                 type => "internal",
 435                 default => 0,
 436                 description => "running in rebuild mode",
 437                 safe => 0,
 438                 rebuild => 0,
 439         },
 440         setup => {
 441                 type => "internal",
 442                 default => undef,
 443                 description => "running in setup mode",
 444                 safe => 0,
 445                 rebuild => 0,
 446         },
 447         clean => {
 448                 type => "internal",
 449                 default => 0,
 450                 description => "running in clean mode",
 451                 safe => 0,
 452                 rebuild => 0,
 453         },
 454         refresh => {
 455                 type => "internal",
 456                 default => 0,
 457                 description => "running in refresh mode",
 458                 safe => 0,
 459                 rebuild => 0,
 460         },
 461         test_receive => {
 462                 type => "internal",
 463                 default => 0,
 464                 description => "running in receive test mode",
 465                 safe => 0,
 466                 rebuild => 0,
 467         },
 468         wrapper_background_command => {
 469                 type => "internal",
 470                 default => '',
 471                 description => "background shell command to run",
 472                 safe => 0,
 473                 rebuild => 0,
 474         },
 475         gettime => {
 476                 type => "internal",
 477                 description => "running in gettime mode",
 478                 safe => 0,
 479                 rebuild => 0,
 480         },
 481         w3mmode => {
 482                 type => "internal",
 483                 default => 0,
 484                 description => "running in w3mmode",
 485                 safe => 0,
 486                 rebuild => 0,
 487         },
 488         wikistatedir => {
 489                 type => "internal",
 490                 default => undef,
 491                 description => "path to the .ikiwiki directory holding ikiwiki state",
 492                 safe => 0,
 493                 rebuild => 0,
 494         },
 495         setupfile => {
 496                 type => "internal",
 497                 default => undef,
 498                 description => "path to setup file",
 499                 safe => 0,
 500                 rebuild => 0,
 501         },
 502         setuptype => {
 503                 type => "internal",
 504                 default => "Yaml",
 505                 description => "perl class to use to dump setup file",
 506                 safe => 0,
 507                 rebuild => 0,
 508         },
 509         allow_symlinks_before_srcdir => {
 510                 type => "boolean",
 511                 default => 0,
 512                 description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
 513                 safe => 0,
 514                 rebuild => 0,
 515         },
 516         cookiejar => {
 517                 type => "string",
 518                 default => { file => "$ENV{HOME}/.ikiwiki/cookies" },
 519                 description => "cookie control",
 520                 safe => 0, # hooks into perl module internals
 521                 rebuild => 0,
 522         },
 523 }
 524
 525 sub defaultconfig () {
 526         my %s=getsetup();
 527         my @ret;
 528         foreach my $key (keys %s) {
 529                 push @ret, $key, $s{$key}->{default};
 530         }
 531         return @ret;
 532 }
 533
 534 # URL to top of wiki as a path starting with /, valid from any wiki page or
 535 # the CGI; if that's not possible, an absolute URL. Either way, it ends with /
 536 my $local_url;
 537 # URL to CGI script, similar to $local_url
 538 my $local_cgiurl;
 539
 540 sub checkconfig () {
 541         # locale stuff; avoid LC_ALL since it overrides everything
 542         if (defined $ENV{LC_ALL}) {
 543                 $ENV{LANG} = $ENV{LC_ALL};
 544                 delete $ENV{LC_ALL};
 545         }
 546         if (defined $config{locale}) {
 547                 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
 548                         $ENV{LANG}=$config{locale};
 549                         define_gettext();
 550                 }
 551         }
 552
 553         if (! defined $config{wiki_file_regexp}) {
 554                 $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
 555         }
 556
 557         if (ref $config{ENV} eq 'HASH') {
 558                 foreach my $val (keys %{$config{ENV}}) {
 559                         $ENV{$val}=$config{ENV}{$val};
 560                 }
 561         }
 562         if (defined $config{timezone} && length $config{timezone}) {
 563                 $ENV{TZ}=$config{timezone};
 564         }
 565         else {
 566                 $config{timezone}=$ENV{TZ};
 567         }
 568
 569         if ($config{w3mmode}) {
 570                 eval q{use Cwd q{abs_path}};
 571                 error($@) if $@;
 572                 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
 573                 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
 574                 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
 575                         unless $config{cgiurl} =~ m!file:///!;
 576                 $config{url}="file://".$config{destdir};
 577         }
 578
 579         if ($config{cgi} && ! length $config{url}) {
 580                 error(gettext("Must specify url to wiki with --url when using --cgi"));
 581         }
 582
 583         if (defined $config{url} && length $config{url}) {
 584                 eval q{use URI};
 585                 my $baseurl = URI->new($config{url});
 586
 587                 $local_url = $baseurl->path . "/";
 588                 $local_cgiurl = undef;
 589
 590                 if (length $config{cgiurl}) {
 591                         my $cgiurl = URI->new($config{cgiurl});
 592
 593                         $local_cgiurl = $cgiurl->path;
 594
 595                         if ($cgiurl->scheme ne $baseurl->scheme or
 596                                 $cgiurl->authority ne $baseurl->authority) {
 597                                 # too far apart, fall back to absolute URLs
 598                                 $local_url = "$config{url}/";
 599                                 $local_cgiurl = $config{cgiurl};
 600                         }
 601                 }
 602
 603                 $local_url =~ s{//$}{/};
 604         }
 605         else {
 606                 $local_cgiurl = $config{cgiurl};
 607         }
 608
 609         $config{wikistatedir}="$config{srcdir}/.ikiwiki"
 610                 unless exists $config{wikistatedir} && defined $config{wikistatedir};
 611
 612         if (defined $config{umask}) {
 613                 my $u = possibly_foolish_untaint($config{umask});
 614
 615                 if ($u =~ m/^\d+$/) {
 616                         umask($u);
 617                 }
 618                 elsif ($u eq 'private') {
 619                         umask(077);
 620                 }
 621                 elsif ($u eq 'group') {
 622                         umask(027);
 623                 }
 624                 elsif ($u eq 'public') {
 625                         umask(022);
 626                 }
 627                 else {
 628                         error(sprintf(gettext("unsupported umask setting %s"), $u));
 629                 }
 630         }
 631
 632         run_hooks(checkconfig => sub { shift->() });
 633
 634         return 1;
 635 }
 636
 637 sub listplugins () {
 638         my %ret;
 639
 640         foreach my $dir (@INC, $config{libdir}) {
 641                 next unless defined $dir && length $dir;
 642                 foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
 643                         my ($plugin)=$file=~/.*\/(.*)\.pm$/;
 644                         $ret{$plugin}=1;
 645                 }
 646         }
 647         foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
 648                 next unless defined $dir && length $dir;
 649                 foreach my $file (glob("$dir/plugins/*")) {
 650                         $ret{basename($file)}=1 if -x $file;
 651                 }
 652         }
 653
 654         return keys %ret;
 655 }
 656
 657 sub loadplugins () {
 658         if (defined $config{libdir} && length $config{libdir}) {
 659                 unshift @INC, possibly_foolish_untaint($config{libdir});
 660         }
 661
 662         foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
 663                 loadplugin($plugin);
 664         }
 665
 666         if ($config{rcs}) {
 667                 if (exists $hooks{rcs}) {
 668                         error(gettext("cannot use multiple rcs plugins"));
 669                 }
 670                 loadplugin($config{rcs});
 671         }
 672         if (! exists $hooks{rcs}) {
 673                 loadplugin("norcs");
 674         }
 675
 676         run_hooks(getopt => sub { shift->() });
 677         if (grep /^-/, @ARGV) {
 678                 print STDERR "Unknown option (or missing parameter): $_\n"
 679                         foreach grep /^-/, @ARGV;
 680                 usage();
 681         }
 682
 683         return 1;
 684 }
 685
 686 sub loadplugin ($;$) {
 687         my $plugin=shift;
 688         my $force=shift;
 689
 690         return if ! $force && grep { $_ eq $plugin} @{$config{disable_plugins}};
 691
 692         foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
 693                          "$installdir/lib/ikiwiki") {
 694                 if (defined $dir && -x "$dir/plugins/$plugin") {
 695                         eval { require IkiWiki::Plugin::external };
 696                         if ($@) {
 697                                 my $reason=$@;
 698                                 error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
 699                         }
 700                         import IkiWiki::Plugin::external "$dir/plugins/$plugin";
 701                         $loaded_plugins{$plugin}=1;
 702                         return 1;
 703                 }
 704         }
 705
 706         my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
 707         eval qq{use $mod};
 708         if ($@) {
 709                 error("Failed to load plugin $mod: $@");
 710         }
 711         $loaded_plugins{$plugin}=1;
 712         return 1;
 713 }
 714
 715 sub error ($;$) {
 716         my $message=shift;
 717         my $cleaner=shift;
 718         log_message('err' => $message) if $config{syslog};
 719         if (defined $cleaner) {
 720                 $cleaner->();
 721         }
 722         die $message."\n";
 723 }
 724
 725 sub debug ($) {
 726         return unless $config{verbose};
 727         return log_message(debug => @_);
 728 }
 729
 730 my $log_open=0;
 731 my $log_failed=0;
 732 sub log_message ($$) {
 733         my $type=shift;
 734
 735         if ($config{syslog}) {
 736                 require Sys::Syslog;
 737                 if (! $log_open) {
 738                         Sys::Syslog::setlogsock('unix');
 739                         Sys::Syslog::openlog('ikiwiki', '', 'user');
 740                         $log_open=1;
 741                 }
 742                 eval {
 743                         Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
 744                 };
 745                 if ($@) {
 746                     print STDERR "failed to syslog: $@" unless $log_failed;
 747                     $log_failed=1;
 748                     print STDERR "@_\n";
 749                 }
 750                 return $@;
 751         }
 752         elsif (! $config{cgi}) {
 753                 return print "@_\n";
 754         }
 755         else {
 756                 return print STDERR "@_\n";
 757         }
 758 }
 759
 760 sub possibly_foolish_untaint ($) {
 761         my $tainted=shift;
 762         my ($untainted)=$tainted=~/(.*)/s;
 763         return $untainted;
 764 }
 765
 766 sub basename ($) {
 767         my $file=shift;
 768
 769         $file=~s!.*/+!!;
 770         return $file;
 771 }
 772
 773 sub dirname ($) {
 774         my $file=shift;
 775
 776         $file=~s!/*[^/]+$!!;
 777         return $file;
 778 }
 779
 780 sub isinternal ($) {
 781         my $page=shift;
 782         return exists $pagesources{$page} &&
 783                 $pagesources{$page} =~ /\._([^.]+)$/;
 784 }
 785
 786 sub pagetype ($) {
 787         my $file=shift;
 788
 789         if ($file =~ /\.([^.]+)$/) {
 790                 return $1 if exists $hooks{htmlize}{$1};
 791         }
 792         my $base=basename($file);
 793         if (exists $hooks{htmlize}{$base} &&
 794             $hooks{htmlize}{$base}{noextension}) {
 795                 return $base;
 796         }
 797         return;
 798 }
 799
 800 my %pagename_cache;
 801
 802 sub pagename ($) {
 803         my $file=shift;
 804
 805         if (exists $pagename_cache{$file}) {
 806                 return $pagename_cache{$file};
 807         }
 808
 809         my $type=pagetype($file);
 810         my $page=$file;
 811         $page=~s/\Q.$type\E*$//
 812                 if defined $type && !$hooks{htmlize}{$type}{keepextension}
 813                         && !$hooks{htmlize}{$type}{noextension};
 814         if ($config{indexpages} && $page=~/(.*)\/index$/) {
 815                 $page=$1;
 816         }
 817
 818         $pagename_cache{$file} = $page;
 819         return $page;
 820 }
 821
 822 sub newpagefile ($$) {
 823         my $page=shift;
 824         my $type=shift;
 825
 826         if (! $config{indexpages} || $page eq 'index') {
 827                 return $page.".".$type;
 828         }
 829         else {
 830                 return $page."/index.".$type;
 831         }
 832 }
 833
 834 sub targetpage ($$;$) {
 835         my $page=shift;
 836         my $ext=shift;
 837         my $filename=shift;
 838
 839         if (defined $filename) {
 840                 return $page."/".$filename.".".$ext;
 841         }
 842         elsif (! $config{usedirs} || $page eq 'index') {
 843                 return $page.".".$ext;
 844         }
 845         else {
 846                 return $page."/index.".$ext;
 847         }
 848 }
 849
 850 sub htmlpage ($) {
 851         my $page=shift;
 852
 853         return targetpage($page, $config{htmlext});
 854 }
 855
 856 sub srcfile_stat {
 857         my $file=shift;
 858         my $nothrow=shift;
 859
 860         return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
 861         foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
 862                 return "$dir/$file", stat(_) if -e "$dir/$file";
 863         }
 864         error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
 865         return;
 866 }
 867
 868 sub srcfile ($;$) {
 869         return (srcfile_stat(@_))[0];
 870 }
 871
 872 sub add_literal_underlay ($) {
 873         my $dir=shift;
 874
 875         if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
 876                 unshift @{$config{underlaydirs}}, $dir;
 877         }
 878 }
 879
 880 sub add_underlay ($) {
 881         my $dir = shift;
 882
 883         if ($dir !~ /^\//) {
 884                 $dir="$config{underlaydirbase}/$dir";
 885         }
 886
 887         add_literal_underlay($dir);
 888         # why does it return 1? we just don't know
 889         return 1;
 890 }
 891
 892 sub readfile ($;$$) {
 893         my $file=shift;
 894         my $binary=shift;
 895         my $wantfd=shift;
 896
 897         if (-l $file) {
 898                 error("cannot read a symlink ($file)");
 899         }
 900
 901         local $/=undef;
 902         open (my $in, "<", $file) || error("failed to read $file: $!");
 903         binmode($in) if ($binary);
 904         return \*$in if $wantfd;
 905         my $ret=<$in>;
 906         # check for invalid utf-8, and toss it back to avoid crashes
 907         if (! utf8::valid($ret)) {
 908                 $ret=encode_utf8($ret);
 909         }
 910         close $in || error("failed to read $file: $!");
 911         return $ret;
 912 }
 913
 914 sub prep_writefile ($$) {
 915         my $file=shift;
 916         my $destdir=shift;
 917
 918         my $test=$file;
 919         while (length $test) {
 920                 if (-l "$destdir/$test") {
 921                         error("cannot write to a symlink ($test)");
 922                 }
 923                 if (-f _ && $test ne $file) {
 924                         # Remove conflicting file.
 925                         foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
 926                                 foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
 927                                         if ($f eq $test) {
 928                                                 unlink("$destdir/$test");
 929                                                 last;
 930                                         }
 931                                 }
 932                         }
 933                 }
 934                 $test=dirname($test);
 935         }
 936
 937         my $dir=dirname("$destdir/$file");
 938         if (! -d $dir) {
 939                 my $d="";
 940                 foreach my $s (split(m!/+!, $dir)) {
 941                         $d.="$s/";
 942                         if (! -d $d) {
 943                                 mkdir($d) || error("failed to create directory $d: $!");
 944                         }
 945                 }
 946         }
 947
 948         return 1;
 949 }
 950
 951 sub writefile ($$$;$$) {
 952         my $file=shift; # can include subdirs
 953         my $destdir=shift; # directory to put file in
 954         my $content=shift;
 955         my $binary=shift;
 956         my $writer=shift;
 957
 958         prep_writefile($file, $destdir);
 959
 960         my $newfile="$destdir/$file.ikiwiki-new";
 961         if (-l $newfile) {
 962                 error("cannot write to a symlink ($newfile)");
 963         }
 964
 965         my $cleanup = sub { unlink($newfile) };
 966         open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
 967         binmode($out) if ($binary);
 968         if ($writer) {
 969                 $writer->(\*$out, $cleanup);
 970         }
 971         else {
 972                 print $out $content or error("failed writing to $newfile: $!", $cleanup);
 973         }
 974         close $out || error("failed saving $newfile: $!", $cleanup);
 975         rename($newfile, "$destdir/$file") ||
 976                 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
 977
 978         return 1;
 979 }
 980
 981 my %cleared;
 982 sub will_render ($$;$) {
 983         my $page=shift;
 984         my $dest=shift;
 985         my $clear=shift;
 986
 987         # Important security check for independently created files.
 988         if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
 989             ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
 990                 my $from_other_page=0;
 991                 # Expensive, but rarely runs.
 992                 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
 993                         if (grep {
 994                                 $_ eq $dest ||
 995                                 dirname($_) eq $dest
 996                             } @{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
 997                                 $from_other_page=1;
 998                                 last;
 999                         }
1000                 }
1001
1002                 error("$config{destdir}/$dest independently created, not overwriting with version from $page")
1003                         unless $from_other_page;
1004         }
1005
1006         # If $dest exists as a directory, remove conflicting files in it
1007         # rendered from other pages.
1008         if (-d _) {
1009                 foreach my $p (keys %renderedfiles, keys %oldrenderedfiles) {
1010                         foreach my $f (@{$renderedfiles{$p}}, @{$oldrenderedfiles{$p}}) {
1011                                 if (dirname($f) eq $dest) {
1012                                         unlink("$config{destdir}/$f");
1013                                         rmdir(dirname("$config{destdir}/$f"));
1014                                 }
1015                         }
1016                 }
1017         }
1018
1019         if (! $clear || $cleared{$page}) {
1020                 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
1021         }
1022         else {
1023                 foreach my $old (@{$renderedfiles{$page}}) {
1024                         delete $destsources{$old};
1025                 }
1026                 $renderedfiles{$page}=[$dest];
1027                 $cleared{$page}=1;
1028         }
1029         $destsources{$dest}=$page;
1030
1031         return 1;
1032 }
1033
1034 sub bestlink ($$) {
1035         my $page=shift;
1036         my $link=shift;
1037
1038         my $cwd=$page;
1039         if ($link=~s/^\/+//) {
1040                 # absolute links
1041                 $cwd="";
1042         }
1043         $link=~s/\/$//;
1044
1045         do {
1046                 my $l=$cwd;
1047                 $l.="/" if length $l;
1048                 $l.=$link;
1049
1050                 if (exists $pagesources{$l}) {
1051                         return $l;
1052                 }
1053                 elsif (exists $pagecase{lc $l}) {
1054                         return $pagecase{lc $l};
1055                 }
1056         } while $cwd=~s{/?[^/]+$}{};
1057
1058         if (length $config{userdir}) {
1059                 my $l = "$config{userdir}/".lc($link);
1060                 if (exists $pagesources{$l}) {
1061                         return $l;
1062                 }
1063                 elsif (exists $pagecase{lc $l}) {
1064                         return $pagecase{lc $l};
1065                 }
1066         }
1067
1068         #print STDERR "warning: page $page, broken link: $link\n";
1069         return "";
1070 }
1071
1072 sub isinlinableimage ($) {
1073         my $file=shift;
1074
1075         return $file =~ /\.(png|gif|jpg|jpeg|svg)$/i;
1076 }
1077
1078 sub pagetitle ($;$) {
1079         my $page=shift;
1080         my $unescaped=shift;
1081
1082         if ($unescaped) {
1083                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
1084         }
1085         else {
1086                 $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
1087         }
1088
1089         return $page;
1090 }
1091
1092 sub titlepage ($) {
1093         my $title=shift;
1094         # support use w/o %config set
1095         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1096         $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1097         return $title;
1098 }
1099
1100 sub linkpage ($) {
1101         my $link=shift;
1102         my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
1103         $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
1104         return $link;
1105 }
1106
1107 sub cgiurl (@) {
1108         my %params=@_;
1109
1110         my $cgiurl=$local_cgiurl;
1111
1112         if (exists $params{cgiurl}) {
1113                 $cgiurl=$params{cgiurl};
1114                 delete $params{cgiurl};
1115         }
1116
1117         unless (%params) {
1118                 return $cgiurl;
1119         }
1120
1121         return $cgiurl."?".
1122                 join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
1123 }
1124
1125 sub cgiurl_abs (@) {
1126         eval q{use URI};
1127         URI->new_abs(cgiurl(@_), $config{cgiurl});
1128 }
1129
1130 sub baseurl (;$) {
1131         my $page=shift;
1132
1133         return $local_url if ! defined $page;
1134
1135         $page=htmlpage($page);
1136         $page=~s/[^\/]+$//;
1137         $page=~s/[^\/]+\//..\//g;
1138         return $page;
1139 }
1140
1141 sub urlabs ($$) {
1142         my $url=shift;
1143         my $urlbase=shift;
1144
1145         return $url unless defined $urlbase && length $urlbase;
1146
1147         eval q{use URI};
1148         URI->new_abs($url, $urlbase)->as_string;
1149 }
1150
1151 sub abs2rel ($$) {
1152         # Work around very innefficient behavior in File::Spec if abs2rel
1153         # is passed two relative paths. It's much faster if paths are
1154         # absolute! (Debian bug #376658; fixed in debian unstable now)
1155         my $path="/".shift;
1156         my $base="/".shift;
1157
1158         require File::Spec;
1159         my $ret=File::Spec->abs2rel($path, $base);
1160         $ret=~s/^// if defined $ret;
1161         return $ret;
1162 }
1163
1164 sub displaytime ($;$$) {
1165         # Plugins can override this function to mark up the time to
1166         # display.
1167         my $time=formattime($_[0], $_[1]);
1168         if ($config{html5}) {
1169                 return '<time datetime="'.date_3339($_[0]).'"'.
1170                         ($_[2] ? ' pubdate="pubdate"' : '').
1171                         '>'.$time.'</time>';
1172         }
1173         else {
1174                 return '<span class="date">'.$time.'</span>';
1175         }
1176 }
1177
1178 sub formattime ($;$) {
1179         # Plugins can override this function to format the time.
1180         my $time=shift;
1181         my $format=shift;
1182         if (! defined $format) {
1183                 $format=$config{timeformat};
1184         }
1185
1186         return strftime_utf8($format, localtime($time));
1187 }
1188
1189 my $strftime_encoding;
1190 sub strftime_utf8 {
1191         # strftime doesn't know about encodings, so make sure
1192         # its output is properly treated as utf8.
1193         # Note that this does not handle utf-8 in the format string.
1194         ($strftime_encoding) = POSIX::setlocale(&POSIX::LC_TIME) =~ m#\.([^@]+)#
1195                 unless defined $strftime_encoding;
1196         $strftime_encoding
1197                 ? Encode::decode($strftime_encoding, POSIX::strftime(@_))
1198                 : POSIX::strftime(@_);
1199 }
1200
1201 sub date_3339 ($) {
1202         my $time=shift;
1203
1204         my $lc_time=POSIX::setlocale(&POSIX::LC_TIME);
1205         POSIX::setlocale(&POSIX::LC_TIME, "C");
1206         my $ret=POSIX::strftime("%Y-%m-%dT%H:%M:%SZ", gmtime($time));
1207         POSIX::setlocale(&POSIX::LC_TIME, $lc_time);
1208         return $ret;
1209 }
1210
1211 sub beautify_urlpath ($) {
1212         my $url=shift;
1213
1214         # Ensure url is not an empty link, and if necessary,
1215         # add ./ to avoid colon confusion.
1216         if ($url !~ /^\// && $url !~ /^\.\.?\//) {
1217                 $url="./$url";
1218         }
1219
1220         if ($config{usedirs}) {
1221                 $url =~ s!/index.$config{htmlext}$!/!;
1222         }
1223
1224         return $url;
1225 }
1226
1227 sub urlto ($;$$) {
1228         my $to=shift;
1229         my $from=shift;
1230         my $absolute=shift;
1231
1232         if (! length $to) {
1233                 $to = 'index';
1234         }
1235
1236         if (! $destsources{$to}) {
1237                 $to=htmlpage($to);
1238         }
1239
1240         if ($absolute) {
1241                 return $config{url}.beautify_urlpath("/".$to);
1242         }
1243
1244         if (! defined $from) {
1245                 my $u = $local_url || '';
1246                 $u =~ s{/$}{};
1247                 return $u.beautify_urlpath("/".$to);
1248         }
1249
1250         my $link = abs2rel($to, dirname(htmlpage($from)));
1251
1252         return beautify_urlpath($link);
1253 }
1254
1255 sub isselflink ($$) {
1256         # Plugins can override this function to support special types
1257         # of selflinks.
1258         my $page=shift;
1259         my $link=shift;
1260
1261         return $page eq $link;
1262 }
1263
1264 sub htmllink ($$$;@) {
1265         my $lpage=shift; # the page doing the linking
1266         my $page=shift; # the page that will contain the link (different for inline)
1267         my $link=shift;
1268         my %opts=@_;
1269
1270         $link=~s/\/$//;
1271
1272         my $bestlink;
1273         if (! $opts{forcesubpage}) {
1274                 $bestlink=bestlink($lpage, $link);
1275         }
1276         else {
1277                 $bestlink="$lpage/".lc($link);
1278         }
1279
1280         my $linktext;
1281         if (defined $opts{linktext}) {
1282                 $linktext=$opts{linktext};
1283         }
1284         else {
1285                 $linktext=pagetitle(basename($link));
1286         }
1287
1288         return "<span class=\"selflink\">$linktext</span>"
1289                 if length $bestlink && isselflink($page, $bestlink) &&
1290                    ! defined $opts{anchor};
1291
1292         if (! $destsources{$bestlink}) {
1293                 $bestlink=htmlpage($bestlink);
1294
1295                 if (! $destsources{$bestlink}) {
1296                         my $cgilink = "";
1297                         if (length $config{cgiurl}) {
1298                                 $cgilink = "<a href=\"".
1299                                         cgiurl(
1300                                                 do => "create",
1301                                                 page => $link,
1302                                                 from => $lpage
1303                                         )."\" rel=\"nofollow\">?</a>";
1304                         }
1305                         return "<span class=\"createlink\">$cgilink$linktext</span>"
1306                 }
1307         }
1308
1309         $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
1310         $bestlink=beautify_urlpath($bestlink);
1311
1312         if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
1313                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
1314         }
1315
1316         if (defined $opts{anchor}) {
1317                 $bestlink.="#".$opts{anchor};
1318         }
1319
1320         my @attrs;
1321         foreach my $attr (qw{rel class title}) {
1322                 if (defined $opts{$attr}) {
1323                         push @attrs, " $attr=\"$opts{$attr}\"";
1324                 }
1325         }
1326
1327         return "<a href=\"$bestlink\"@attrs>$linktext</a>";
1328 }
1329
1330 sub userpage ($) {
1331         my $user=shift;
1332         return length $config{userdir} ? "$config{userdir}/$user" : $user;
1333 }
1334
1335 sub openiduser ($) {
1336         my $user=shift;
1337
1338         if (defined $user && $user =~ m!^https?://! &&
1339             eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
1340                 my $display;
1341
1342                 if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
1343                         $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
1344                 }
1345                 else {
1346                         # backcompat with old version
1347                         my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
1348                         $display=$oid->display;
1349                 }
1350
1351                 # Convert "user.somehost.com" to "user [somehost.com]"
1352                 # (also "user.somehost.co.uk")
1353                 if ($display !~ /\[/) {
1354                         $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
1355                 }
1356                 # Convert "http://somehost.com/user" to "user [somehost.com]".
1357                 # (also "https://somehost.com/user/")
1358                 if ($display !~ /\[/) {
1359                         $display=~s/^https?:\/\/(.+)\/([^\/#?]+)\/?(?:[#?].*)?$/$2 [$1]/;
1360                 }
1361                 $display=~s!^https?://!!; # make sure this is removed
1362                 eval q{use CGI 'escapeHTML'};
1363                 error($@) if $@;
1364                 return escapeHTML($display);
1365         }
1366         return;
1367 }
1368
1369 sub htmlize ($$$$) {
1370         my $page=shift;
1371         my $destpage=shift;
1372         my $type=shift;
1373         my $content=shift;
1374
1375         my $oneline = $content !~ /\n/;
1376
1377         if (exists $hooks{htmlize}{$type}) {
1378                 $content=$hooks{htmlize}{$type}{call}->(
1379                         page => $page,
1380                         content => $content,
1381                 );
1382         }
1383         else {
1384                 error("htmlization of $type not supported");
1385         }
1386
1387         run_hooks(sanitize => sub {
1388                 $content=shift->(
1389                         page => $page,
1390                         destpage => $destpage,
1391                         content => $content,
1392                 );
1393         });
1394
1395         if ($oneline) {
1396                 # hack to get rid of enclosing junk added by markdown
1397                 # and other htmlizers/sanitizers
1398                 $content=~s/^<p>//i;
1399                 $content=~s/<\/p>\n*$//i;
1400         }
1401
1402         return $content;
1403 }
1404
1405 sub linkify ($$$) {
1406         my $page=shift;
1407         my $destpage=shift;
1408         my $content=shift;
1409
1410         run_hooks(linkify => sub {
1411                 $content=shift->(
1412                         page => $page,
1413                         destpage => $destpage,
1414                         content => $content,
1415                 );
1416         });
1417
1418         return $content;
1419 }
1420
1421 our %preprocessing;
1422 our $preprocess_preview=0;
1423 sub preprocess ($$$;$$) {
1424         my $page=shift; # the page the data comes from
1425         my $destpage=shift; # the page the data will appear in (different for inline)
1426         my $content=shift;
1427         my $scan=shift;
1428         my $preview=shift;
1429
1430         # Using local because it needs to be set within any nested calls
1431         # of this function.
1432         local $preprocess_preview=$preview if defined $preview;
1433
1434         my $handle=sub {
1435                 my $escape=shift;
1436                 my $prefix=shift;
1437                 my $command=shift;
1438                 my $params=shift;
1439                 $params="" if ! defined $params;
1440
1441                 if (length $escape) {
1442                         return "[[$prefix$command $params]]";
1443                 }
1444                 elsif (exists $hooks{preprocess}{$command}) {
1445                         return "" if $scan && ! $hooks{preprocess}{$command}{scan};
1446                         # Note: preserve order of params, some plugins may
1447                         # consider it significant.
1448                         my @params;
1449                         while ($params =~ m{
1450                                 (?:([-.\w]+)=)?         # 1: named parameter key?
1451                                 (?:
1452                                         """(.*?)"""     # 2: triple-quoted value
1453                                 |
1454                                         "([^"]*?)"      # 3: single-quoted value
1455                                 |
1456                                         '''(.*?)'''     # 4: triple-single-quote
1457                                 |
1458                                         <<([a-zA-Z]+)\n # 5: heredoc start
1459                                         (.*?)\n\5       # 6: heredoc value
1460                                 |
1461                                         (\S+)           # 7: unquoted value
1462                                 )
1463                                 (?:\s+|$)               # delimiter to next param
1464                         }msgx) {
1465                                 my $key=$1;
1466                                 my $val;
1467                                 if (defined $2) {
1468                                         $val=$2;
1469                                         $val=~s/\r\n/\n/mg;
1470                                         $val=~s/^\n+//g;
1471                                         $val=~s/\n+$//g;
1472                                 }
1473                                 elsif (defined $3) {
1474                                         $val=$3;
1475                                 }
1476                                 elsif (defined $4) {
1477                                         $val=$4;
1478                                 }
1479                                 elsif (defined $7) {
1480                                         $val=$7;
1481                                 }
1482                                 elsif (defined $6) {
1483                                         $val=$6;
1484                                 }
1485
1486                                 if (defined $key) {
1487                                         push @params, $key, $val;
1488                                 }
1489                                 else {
1490                                         push @params, $val, '';
1491                                 }
1492                         }
1493                         if ($preprocessing{$page}++ > 3) {
1494                                 # Avoid loops of preprocessed pages preprocessing
1495                                 # other pages that preprocess them, etc.
1496                                 return "[[!$command <span class=\"error\">".
1497                                         sprintf(gettext("preprocessing loop detected on %s at depth %i"),
1498                                                 $page, $preprocessing{$page}).
1499                                         "</span>]]";
1500                         }
1501                         my $ret;
1502                         if (! $scan) {
1503                                 $ret=eval {
1504                                         $hooks{preprocess}{$command}{call}->(
1505                                                 @params,
1506                                                 page => $page,
1507                                                 destpage => $destpage,
1508                                                 preview => $preprocess_preview,
1509                                         );
1510                                 };
1511                                 if ($@) {
1512                                         my $error=$@;
1513                                         chomp $error;
1514                                         $ret="[[!$command <span class=\"error\">".
1515                                                 gettext("Error").": $error"."</span>]]";
1516                                 }
1517                         }
1518                         else {
1519                                 # use void context during scan pass
1520                                 eval {
1521                                         $hooks{preprocess}{$command}{call}->(
1522                                                 @params,
1523                                                 page => $page,
1524                                                 destpage => $destpage,
1525                                                 preview => $preprocess_preview,
1526                                         );
1527                                 };
1528                                 $ret="";
1529                         }
1530                         $preprocessing{$page}--;
1531                         return $ret;
1532                 }
1533                 else {
1534                         return "[[$prefix$command $params]]";
1535                 }
1536         };
1537
1538         my $regex;
1539         if ($config{prefix_directives}) {
1540                 $regex = qr{
1541                         (\\?)           # 1: escape?
1542                         \[\[(!)         # directive open; 2: prefix
1543                         ([-\w]+)        # 3: command
1544                         (               # 4: the parameters..
1545                                 \s+     # Must have space if parameters present
1546                                 (?:
1547                                         (?:[-.\w]+=)?           # named parameter key?
1548                                         (?:
1549                                                 """.*?"""       # triple-quoted value
1550                                                 |
1551                                                 "[^"]*?"        # single-quoted value
1552                                                 |
1553                                                 '''.*?'''       # triple-single-quote
1554                                                 |
1555                                                 <<([a-zA-Z]+)\n # 5: heredoc start
1556                                                 (?:.*?)\n\5     # heredoc value
1557                                                 |
1558                                                 [^"\s\]]+       # unquoted value
1559                                         )
1560                                         \s*                     # whitespace or end
1561                                                                 # of directive
1562                                 )
1563                         *)?             # 0 or more parameters
1564                         \]\]            # directive closed
1565                 }sx;
1566         }
1567         else {
1568                 $regex = qr{
1569                         (\\?)           # 1: escape?
1570                         \[\[(!?)        # directive open; 2: optional prefix
1571                         ([-\w]+)        # 3: command
1572                         \s+
1573                         (               # 4: the parameters..
1574                                 (?:
1575                                         (?:[-.\w]+=)?           # named parameter key?
1576                                         (?:
1577                                                 """.*?"""       # triple-quoted value
1578                                                 |
1579                                                 "[^"]*?"        # single-quoted value
1580                                                 |
1581                                                 '''.*?'''       # triple-single-quote
1582                                                 |
1583                                                 <<([a-zA-Z]+)\n # 5: heredoc start
1584                                                 (?:.*?)\n\5     # heredoc value
1585                                                 |
1586                                                 [^"\s\]]+       # unquoted value
1587                                         )
1588                                         \s*                     # whitespace or end
1589                                                                 # of directive
1590                                 )
1591                         *)              # 0 or more parameters
1592                         \]\]            # directive closed
1593                 }sx;
1594         }
1595
1596         $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
1597         return $content;
1598 }
1599
1600 sub filter ($$$) {
1601         my $page=shift;
1602         my $destpage=shift;
1603         my $content=shift;
1604
1605         run_hooks(filter => sub {
1606                 $content=shift->(page => $page, destpage => $destpage,
1607                         content => $content);
1608         });
1609
1610         return $content;
1611 }
1612
1613 sub check_canedit ($$$;$) {
1614         my $page=shift;
1615         my $q=shift;
1616         my $session=shift;
1617         my $nonfatal=shift;
1618
1619         my $canedit;
1620         run_hooks(canedit => sub {
1621                 return if defined $canedit;
1622                 my $ret=shift->($page, $q, $session);
1623                 if (defined $ret) {
1624                         if ($ret eq "") {
1625                                 $canedit=1;
1626                         }
1627                         elsif (ref $ret eq 'CODE') {
1628                                 $ret->() unless $nonfatal;
1629                                 $canedit=0;
1630                         }
1631                         elsif (defined $ret) {
1632                                 error($ret) unless $nonfatal;
1633                                 $canedit=0;
1634                         }
1635                 }
1636         });
1637         return defined $canedit ? $canedit : 1;
1638 }
1639
1640 sub check_content (@) {
1641         my %params=@_;
1642
1643         return 1 if ! exists $hooks{checkcontent}; # optimisation
1644
1645         if (exists $pagesources{$params{page}}) {
1646                 my @diff;
1647                 my %old=map { $_ => 1 }
1648                         split("\n", readfile(srcfile($pagesources{$params{page}})));
1649                 foreach my $line (split("\n", $params{content})) {
1650                         push @diff, $line if ! exists $old{$line};
1651                 }
1652                 $params{diff}=join("\n", @diff);
1653         }
1654
1655         my $ok;
1656         run_hooks(checkcontent => sub {
1657                 return if defined $ok;
1658                 my $ret=shift->(%params);
1659                 if (defined $ret) {
1660                         if ($ret eq "") {
1661                                 $ok=1;
1662                         }
1663                         elsif (ref $ret eq 'CODE') {
1664                                 $ret->() unless $params{nonfatal};
1665                                 $ok=0;
1666                         }
1667                         elsif (defined $ret) {
1668                                 error($ret) unless $params{nonfatal};
1669                                 $ok=0;
1670                         }
1671                 }
1672
1673         });
1674         return defined $ok ? $ok : 1;
1675 }
1676
1677 sub check_canchange (@) {
1678         my %params = @_;
1679         my $cgi = $params{cgi};
1680         my $session = $params{session};
1681         my @changes = @{$params{changes}};
1682
1683         my %newfiles;
1684         foreach my $change (@changes) {
1685                 # This untaint is safe because we check file_pruned and
1686                 # wiki_file_regexp.
1687                 my ($file)=$change->{file}=~/$config{wiki_file_regexp}/;
1688                 $file=possibly_foolish_untaint($file);
1689                 if (! defined $file || ! length $file ||
1690                     file_pruned($file)) {
1691                         error(gettext("bad file name %s"), $file);
1692                 }
1693
1694                 my $type=pagetype($file);
1695                 my $page=pagename($file) if defined $type;
1696
1697                 if ($change->{action} eq 'add') {
1698                         $newfiles{$file}=1;
1699                 }
1700
1701                 if ($change->{action} eq 'change' ||
1702                     $change->{action} eq 'add') {
1703                         if (defined $page) {
1704                                 check_canedit($page, $cgi, $session);
1705                                 next;
1706                         }
1707                         else {
1708                                 if (IkiWiki::Plugin::attachment->can("check_canattach")) {
1709                                         IkiWiki::Plugin::attachment::check_canattach($session, $file, $change->{path});
1710                                         check_canedit($file, $cgi, $session);
1711                                         next;
1712                                 }
1713                         }
1714                 }
1715                 elsif ($change->{action} eq 'remove') {
1716                         # check_canremove tests to see if the file is present
1717                         # on disk. This will fail when a single commit adds a
1718                         # file and then removes it again. Avoid the problem
1719                         # by not testing the removal in such pairs of changes.
1720                         # (The add is still tested, just to make sure that
1721                         # no data is added to the repo that a web edit
1722                         # could not add.)
1723                         next if $newfiles{$file};
1724
1725                         if (IkiWiki::Plugin::remove->can("check_canremove")) {
1726                                 IkiWiki::Plugin::remove::check_canremove(defined $page ? $page : $file, $cgi, $session);
1727                                 check_canedit(defined $page ? $page : $file, $cgi, $session);
1728                                 next;
1729                         }
1730                 }
1731                 else {
1732                         error "unknown action ".$change->{action};
1733                 }
1734
1735                 error sprintf(gettext("you are not allowed to change %s"), $file);
1736         }
1737 }
1738
1739
1740 my $wikilock;
1741
1742 sub lockwiki () {
1743         # Take an exclusive lock on the wiki to prevent multiple concurrent
1744         # run issues. The lock will be dropped on program exit.
1745         if (! -d $config{wikistatedir}) {
1746                 mkdir($config{wikistatedir});
1747         }
1748         open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
1749                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
1750         if (! flock($wikilock, 2)) { # LOCK_EX
1751                 error("failed to get lock");
1752         }
1753         return 1;
1754 }
1755
1756 sub unlockwiki () {
1757         POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
1758         return close($wikilock) if $wikilock;
1759         return;
1760 }
1761
1762 my $commitlock;
1763
1764 sub commit_hook_enabled () {
1765         open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
1766                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1767         if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
1768                 close($commitlock) || error("failed closing commitlock: $!");
1769                 return 0;
1770         }
1771         close($commitlock) || error("failed closing commitlock: $!");
1772         return 1;
1773 }
1774
1775 sub disable_commit_hook () {
1776         open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
1777                 error("cannot write to $config{wikistatedir}/commitlock: $!");
1778         if (! flock($commitlock, 2)) { # LOCK_EX
1779                 error("failed to get commit lock");
1780         }
1781         return 1;
1782 }
1783
1784 sub enable_commit_hook () {
1785         return close($commitlock) if $commitlock;
1786         return;
1787 }
1788
1789 sub loadindex () {
1790         %oldrenderedfiles=%pagectime=();
1791         if (! $config{rebuild}) {
1792                 %pagesources=%pagemtime=%oldlinks=%links=%depends=
1793                 %destsources=%renderedfiles=%pagecase=%pagestate=
1794                 %depends_simple=%typedlinks=%oldtypedlinks=();
1795         }
1796         my $in;
1797         if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
1798                 if (-e "$config{wikistatedir}/index") {
1799                         system("ikiwiki-transition", "indexdb", $config{srcdir});
1800                         open ($in, "<", "$config{wikistatedir}/indexdb") || return;
1801                 }
1802                 else {
1803                         $config{gettime}=1; # first build
1804                         return;
1805                 }
1806         }
1807
1808         my $index=Storable::fd_retrieve($in);
1809         if (! defined $index) {
1810                 return 0;
1811         }
1812
1813         my $pages;
1814         if (exists $index->{version} && ! ref $index->{version}) {
1815                 $pages=$index->{page};
1816                 %wikistate=%{$index->{state}};
1817                 # Handle plugins that got disabled by loading a new setup.
1818                 if (exists $config{setupfile}) {
1819                         require IkiWiki::Setup;
1820                         IkiWiki::Setup::disabled_plugins(
1821                                 grep { ! $loaded_plugins{$_} } keys %wikistate);
1822                 }
1823         }
1824         else {
1825                 $pages=$index;
1826                 %wikistate=();
1827         }
1828
1829         foreach my $src (keys %$pages) {
1830                 my $d=$pages->{$src};
1831                 my $page=pagename($src);
1832                 $pagectime{$page}=$d->{ctime};
1833                 $pagesources{$page}=$src;
1834                 if (! $config{rebuild}) {
1835                         $pagemtime{$page}=$d->{mtime};
1836                         $renderedfiles{$page}=$d->{dest};
1837                         if (exists $d->{links} && ref $d->{links}) {
1838                                 $links{$page}=$d->{links};
1839                                 $oldlinks{$page}=[@{$d->{links}}];
1840                         }
1841                         if (ref $d->{depends_simple} eq 'ARRAY') {
1842                                 # old format
1843                                 $depends_simple{$page}={
1844                                         map { $_ => 1 } @{$d->{depends_simple}}
1845                                 };
1846                         }
1847                         elsif (exists $d->{depends_simple}) {
1848                                 $depends_simple{$page}=$d->{depends_simple};
1849                         }
1850                         if (exists $d->{dependslist}) {
1851                                 # old format
1852                                 $depends{$page}={
1853                                         map { $_ => $DEPEND_CONTENT }
1854                                                 @{$d->{dependslist}}
1855                                 };
1856                         }
1857                         elsif (exists $d->{depends} && ! ref $d->{depends}) {
1858                                 # old format
1859                                 $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
1860                         }
1861                         elsif (exists $d->{depends}) {
1862                                 $depends{$page}=$d->{depends};
1863                         }
1864                         if (exists $d->{state}) {
1865                                 $pagestate{$page}=$d->{state};
1866                         }
1867                         if (exists $d->{typedlinks}) {
1868                                 $typedlinks{$page}=$d->{typedlinks};
1869
1870                                 while (my ($type, $links) = each %{$typedlinks{$page}}) {
1871                                         next unless %$links;
1872                                         $oldtypedlinks{$page}{$type} = {%$links};
1873                                 }
1874                         }
1875                 }
1876                 $oldrenderedfiles{$page}=[@{$d->{dest}}];
1877         }
1878         foreach my $page (keys %pagesources) {
1879                 $pagecase{lc $page}=$page;
1880         }
1881         foreach my $page (keys %renderedfiles) {
1882                 $destsources{$_}=$page foreach @{$renderedfiles{$page}};
1883         }
1884         return close($in);
1885 }
1886
1887 sub saveindex () {
1888         run_hooks(savestate => sub { shift->() });
1889
1890         my @plugins=keys %loaded_plugins;
1891
1892         if (! -d $config{wikistatedir}) {
1893                 mkdir($config{wikistatedir});
1894         }
1895         my $newfile="$config{wikistatedir}/indexdb.new";
1896         my $cleanup = sub { unlink($newfile) };
1897         open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
1898
1899         my %index;
1900         foreach my $page (keys %pagemtime) {
1901                 next unless $pagemtime{$page};
1902                 my $src=$pagesources{$page};
1903
1904                 $index{page}{$src}={
1905                         ctime => $pagectime{$page},
1906                         mtime => $pagemtime{$page},
1907                         dest => $renderedfiles{$page},
1908                         links => $links{$page},
1909                 };
1910
1911                 if (exists $depends{$page}) {
1912                         $index{page}{$src}{depends} = $depends{$page};
1913                 }
1914
1915                 if (exists $depends_simple{$page}) {
1916                         $index{page}{$src}{depends_simple} = $depends_simple{$page};
1917                 }
1918
1919                 if (exists $typedlinks{$page} && %{$typedlinks{$page}}) {
1920                         $index{page}{$src}{typedlinks} = $typedlinks{$page};
1921                 }
1922
1923                 if (exists $pagestate{$page}) {
1924                         foreach my $id (@plugins) {
1925                                 foreach my $key (keys %{$pagestate{$page}{$id}}) {
1926                                         $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
1927                                 }
1928                         }
1929                 }
1930         }
1931
1932         $index{state}={};
1933         foreach my $id (@plugins) {
1934                 $index{state}{$id}={}; # used to detect disabled plugins
1935                 foreach my $key (keys %{$wikistate{$id}}) {
1936                         $index{state}{$id}{$key}=$wikistate{$id}{$key};
1937                 }
1938         }
1939
1940         $index{version}="3";
1941         my $ret=Storable::nstore_fd(\%index, $out);
1942         return if ! defined $ret || ! $ret;
1943         close $out || error("failed saving to $newfile: $!", $cleanup);
1944         rename($newfile, "$config{wikistatedir}/indexdb") ||
1945                 error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
1946
1947         return 1;
1948 }
1949
1950 sub template_file ($) {
1951         my $name=shift;
1952
1953         my $tpage=($name =~ s/^\///) ? $name : "templates/$name";
1954         my $template;
1955         if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
1956                 $template=srcfile($pagesources{$tpage}, 1);
1957                 $name.=".tmpl";
1958         }
1959         else {
1960                 $template=srcfile($tpage, 1);
1961         }
1962
1963         if (defined $template) {
1964                 return $template, $tpage, 1 if wantarray;
1965                 return $template;
1966         }
1967         else {
1968                 $name=~s:/::; # avoid path traversal
1969                 foreach my $dir ($config{templatedir},
1970                                  "$installdir/share/ikiwiki/templates") {
1971                         if (-e "$dir/$name") {
1972                                 $template="$dir/$name";
1973                                 last;
1974                         }
1975                 }
1976                 if (defined $template) {
1977                         return $template, $tpage if wantarray;
1978                         return $template;
1979                 }
1980         }
1981
1982         return;
1983 }
1984
1985 sub template_depends ($$;@) {
1986         my $name=shift;
1987         my $page=shift;
1988
1989         my ($filename, $tpage, $untrusted)=template_file($name);
1990         if (! defined $filename) {
1991                 error(sprintf(gettext("template %s not found"), $name))
1992         }
1993
1994         if (defined $page && defined $tpage) {
1995                 add_depends($page, $tpage);
1996         }
1997
1998         my @opts=(
1999                 filter => sub {
2000                         my $text_ref = shift;
2001                         ${$text_ref} = decode_utf8(${$text_ref});
2002                 },
2003                 loop_context_vars => 1,
2004                 die_on_bad_params => 0,
2005                 parent_global_vars => 1,
2006                 filename => $filename,
2007                 @_,
2008                 ($untrusted ? (no_includes => 1) : ()),
2009         );
2010         return @opts if wantarray;
2011
2012         require HTML::Template;
2013         return HTML::Template->new(@opts);
2014 }
2015
2016 sub template ($;@) {
2017         template_depends(shift, undef, @_);
2018 }
2019
2020 sub templateactions ($$) {
2021         my $template=shift;
2022         my $page=shift;
2023
2024         my $have_actions=0;
2025         my @actions;
2026         run_hooks(pageactions => sub {
2027                 push @actions, map { { action => $_ } }
2028                         grep { defined } shift->(page => $page);
2029         });
2030         $template->param(actions => \@actions);
2031
2032         if ($config{cgiurl} && exists $hooks{auth}) {
2033                 $template->param(prefsurl => cgiurl(do => "prefs"));
2034                 $have_actions=1;
2035         }
2036
2037         if ($have_actions || @actions) {
2038                 $template->param(have_actions => 1);
2039         }
2040 }
2041
2042 sub hook (@) {
2043         my %param=@_;
2044
2045         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
2046                 error 'hook requires type, call, and id parameters';
2047         }
2048
2049         return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
2050
2051         $hooks{$param{type}}{$param{id}}=\%param;
2052         return 1;
2053 }
2054
2055 sub run_hooks ($$) {
2056         # Calls the given sub for each hook of the given type,
2057         # passing it the hook function to call.
2058         my $type=shift;
2059         my $sub=shift;
2060
2061         if (exists $hooks{$type}) {
2062                 my (@first, @middle, @last);
2063                 foreach my $id (keys %{$hooks{$type}}) {
2064                         if ($hooks{$type}{$id}{first}) {
2065                                 push @first, $id;
2066                         }
2067                         elsif ($hooks{$type}{$id}{last}) {
2068                                 push @last, $id;
2069                         }
2070                         else {
2071                                 push @middle, $id;
2072                         }
2073                 }
2074                 foreach my $id (@first, @middle, @last) {
2075                         $sub->($hooks{$type}{$id}{call});
2076                 }
2077         }
2078
2079         return 1;
2080 }
2081
2082 sub rcs_update () {
2083         $hooks{rcs}{rcs_update}{call}->(@_);
2084 }
2085
2086 sub rcs_prepedit ($) {
2087         $hooks{rcs}{rcs_prepedit}{call}->(@_);
2088 }
2089
2090 sub rcs_commit (@) {
2091         $hooks{rcs}{rcs_commit}{call}->(@_);
2092 }
2093
2094 sub rcs_commit_staged (@) {
2095         $hooks{rcs}{rcs_commit_staged}{call}->(@_);
2096 }
2097
2098 sub rcs_add ($) {
2099         $hooks{rcs}{rcs_add}{call}->(@_);
2100 }
2101
2102 sub rcs_remove ($) {
2103         $hooks{rcs}{rcs_remove}{call}->(@_);
2104 }
2105
2106 sub rcs_rename ($$) {
2107         $hooks{rcs}{rcs_rename}{call}->(@_);
2108 }
2109
2110 sub rcs_recentchanges ($) {
2111         $hooks{rcs}{rcs_recentchanges}{call}->(@_);
2112 }
2113
2114 sub rcs_diff ($;$) {
2115         $hooks{rcs}{rcs_diff}{call}->(@_);
2116 }
2117
2118 sub rcs_getctime ($) {
2119         $hooks{rcs}{rcs_getctime}{call}->(@_);
2120 }
2121
2122 sub rcs_getmtime ($) {
2123         $hooks{rcs}{rcs_getmtime}{call}->(@_);
2124 }
2125
2126 sub rcs_receive () {
2127         $hooks{rcs}{rcs_receive}{call}->();
2128 }
2129
2130 sub add_depends ($$;$) {
2131         my $page=shift;
2132         my $pagespec=shift;
2133         my $deptype=shift || $DEPEND_CONTENT;
2134
2135         # Is the pagespec a simple page name?
2136         if ($pagespec =~ /$config{wiki_file_regexp}/ &&
2137             $pagespec !~ /[\s*?()!]/) {
2138                 $depends_simple{$page}{lc $pagespec} |= $deptype;
2139                 return 1;
2140         }
2141
2142         # Add explicit dependencies for influences.
2143         my $sub=pagespec_translate($pagespec);
2144         return unless defined $sub;
2145         foreach my $p (keys %pagesources) {
2146                 my $r=$sub->($p, location => $page);
2147                 my $i=$r->influences;
2148                 my $static=$r->influences_static;
2149                 foreach my $k (keys %$i) {
2150                         next unless $r || $static || $k eq $page;
2151                         $depends_simple{$page}{lc $k} |= $i->{$k};
2152                 }
2153                 last if $static;
2154         }
2155
2156         $depends{$page}{$pagespec} |= $deptype;
2157         return 1;
2158 }
2159
2160 sub deptype (@) {
2161         my $deptype=0;
2162         foreach my $type (@_) {
2163                 if ($type eq 'presence') {
2164                         $deptype |= $DEPEND_PRESENCE;
2165                 }
2166                 elsif ($type eq 'links') {
2167                         $deptype |= $DEPEND_LINKS;
2168                 }
2169                 elsif ($type eq 'content') {
2170                         $deptype |= $DEPEND_CONTENT;
2171                 }
2172         }
2173         return $deptype;
2174 }
2175
2176 my $file_prune_regexp;
2177 sub file_pruned ($) {
2178         my $file=shift;
2179
2180         if (defined $config{include} && length $config{include}) {
2181                 return 0 if $file =~ m/$config{include}/;
2182         }
2183
2184         if (! defined $file_prune_regexp) {
2185                 $file_prune_regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
2186                 $file_prune_regexp=qr/$file_prune_regexp/;
2187         }
2188         return $file =~ m/$file_prune_regexp/;
2189 }
2190
2191 sub define_gettext () {
2192         # If translation is needed, redefine the gettext function to do it.
2193         # Otherwise, it becomes a quick no-op.
2194         my $gettext_obj;
2195         my $getobj;
2196         if ((exists $ENV{LANG} && length $ENV{LANG}) ||
2197             (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
2198             (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
2199                 $getobj=sub {
2200                         $gettext_obj=eval q{
2201                                 use Locale::gettext q{textdomain};
2202                                 Locale::gettext->domain('ikiwiki')
2203                         };
2204                 };
2205         }
2206
2207         no warnings 'redefine';
2208         *gettext=sub {
2209                 $getobj->() if $getobj;
2210                 if ($gettext_obj) {
2211                         $gettext_obj->get(shift);
2212                 }
2213                 else {
2214                         return shift;
2215                 }
2216         };
2217         *ngettext=sub {
2218                 $getobj->() if $getobj;
2219                 if ($gettext_obj) {
2220                         $gettext_obj->nget(@_);
2221                 }
2222                 else {
2223                         return ($_[2] == 1 ? $_[0] : $_[1])
2224                 }
2225         };
2226 }
2227
2228 sub gettext {
2229         define_gettext();
2230         gettext(@_);
2231 }
2232
2233 sub ngettext {
2234         define_gettext();
2235         ngettext(@_);
2236 }
2237
2238 sub yesno ($) {
2239         my $val=shift;
2240
2241         return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
2242 }
2243
2244 sub inject {
2245         # Injects a new function into the symbol table to replace an
2246         # exported function.
2247         my %params=@_;
2248
2249         # This is deep ugly perl foo, beware.
2250         no strict;
2251         no warnings;
2252         if (! defined $params{parent}) {
2253                 $params{parent}='::';
2254                 $params{old}=\&{$params{name}};
2255                 $params{name}=~s/.*:://;
2256         }
2257         my $parent=$params{parent};
2258         foreach my $ns (grep /^\w+::/, keys %{$parent}) {
2259                 $ns = $params{parent} . $ns;
2260                 inject(%params, parent => $ns) unless $ns eq '::main::';
2261                 *{$ns . $params{name}} = $params{call}
2262                         if exists ${$ns}{$params{name}} &&
2263                            \&{${$ns}{$params{name}}} == $params{old};
2264         }
2265         use strict;
2266         use warnings;
2267 }
2268
2269 sub add_link ($$;$) {
2270         my $page=shift;
2271         my $link=shift;
2272         my $type=shift;
2273
2274         push @{$links{$page}}, $link
2275                 unless grep { $_ eq $link } @{$links{$page}};
2276
2277         if (defined $type) {
2278                 $typedlinks{$page}{$type}{$link} = 1;
2279         }
2280 }
2281
2282 sub add_autofile ($$$) {
2283         my $file=shift;
2284         my $plugin=shift;
2285         my $generator=shift;
2286
2287         $autofiles{$file}{plugin}=$plugin;
2288         $autofiles{$file}{generator}=$generator;
2289 }
2290
2291 sub useragent () {
2292         return LWP::UserAgent->new(
2293                 cookie_jar => $config{cookiejar},
2294                 env_proxy => 1,         # respect proxy env vars
2295         );
2296 }
2297
2298 sub sortspec_translate ($$) {
2299         my $spec = shift;
2300         my $reverse = shift;
2301
2302         my $code = "";
2303         my @data;
2304         while ($spec =~ m{
2305                 \s*
2306                 (-?)            # group 1: perhaps negated
2307                 \s*
2308                 (               # group 2: a word
2309                         \w+\([^\)]*\)   # command(params)
2310                         |
2311                         [^\s]+          # or anything else
2312                 )
2313                 \s*
2314         }gx) {
2315                 my $negated = $1;
2316                 my $word = $2;
2317                 my $params = undef;
2318
2319                 if ($word =~ m/^(\w+)\((.*)\)$/) {
2320                         # command with parameters
2321                         $params = $2;
2322                         $word = $1;
2323                 }
2324                 elsif ($word !~ m/^\w+$/) {
2325                         error(sprintf(gettext("invalid sort type %s"), $word));
2326                 }
2327
2328                 if (length $code) {
2329                         $code .= " || ";
2330                 }
2331
2332                 if ($negated) {
2333                         $code .= "-";
2334                 }
2335
2336                 if (exists $IkiWiki::SortSpec::{"cmp_$word"}) {
2337                         if (defined $params) {
2338                                 push @data, $params;
2339                                 $code .= "IkiWiki::SortSpec::cmp_$word(\$data[$#data])";
2340                         }
2341                         else {
2342                                 $code .= "IkiWiki::SortSpec::cmp_$word(undef)";
2343                         }
2344                 }
2345                 else {
2346                         error(sprintf(gettext("unknown sort type %s"), $word));
2347                 }
2348         }
2349
2350         if (! length $code) {
2351                 # undefined sorting method... sort arbitrarily
2352                 return sub { 0 };
2353         }
2354
2355         if ($reverse) {
2356                 $code="-($code)";
2357         }
2358
2359         no warnings;
2360         return eval 'sub { '.$code.' }';
2361 }
2362
2363 sub pagespec_translate ($) {
2364         my $spec=shift;
2365
2366         # Convert spec to perl code.
2367         my $code="";
2368         my @data;
2369         while ($spec=~m{
2370                 \s*             # ignore whitespace
2371                 (               # 1: match a single word
2372                         \!              # !
2373                 |
2374                         \(              # (
2375                 |
2376                         \)              # )
2377                 |
2378                         \w+\([^\)]*\)   # command(params)
2379                 |
2380                         [^\s()]+        # any other text
2381                 )
2382                 \s*             # ignore whitespace
2383         }gx) {
2384                 my $word=$1;
2385                 if (lc $word eq 'and') {
2386                         $code.=' &';
2387                 }
2388                 elsif (lc $word eq 'or') {
2389                         $code.=' |';
2390                 }
2391                 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
2392                         $code.=' '.$word;
2393                 }
2394                 elsif ($word =~ /^(\w+)\((.*)\)$/) {
2395                         if (exists $IkiWiki::PageSpec::{"match_$1"}) {
2396                                 push @data, $2;
2397                                 $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
2398                         }
2399                         else {
2400                                 push @data, qq{unknown function in pagespec "$word"};
2401                                 $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
2402                         }
2403                 }
2404                 else {
2405                         push @data, $word;
2406                         $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
2407                 }
2408         }
2409
2410         if (! length $code) {
2411                 $code="IkiWiki::FailReason->new('empty pagespec')";
2412         }
2413
2414         no warnings;
2415         return eval 'sub { my $page=shift; '.$code.' }';
2416 }
2417
2418 sub pagespec_match ($$;@) {
2419         my $page=shift;
2420         my $spec=shift;
2421         my @params=@_;
2422
2423         # Backwards compatability with old calling convention.
2424         if (@params == 1) {
2425                 unshift @params, 'location';
2426         }
2427
2428         my $sub=pagespec_translate($spec);
2429         return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
2430                 if ! defined $sub;
2431         return $sub->($page, @params);
2432 }
2433
2434 sub pagespec_match_list ($$;@) {
2435         my $page=shift;
2436         my $pagespec=shift;
2437         my %params=@_;
2438
2439         # Backwards compatability with old calling convention.
2440         if (ref $page) {
2441                 print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
2442                 $params{list}=$page;
2443                 $page=$params{location}; # ugh!
2444         }
2445
2446         my $sub=pagespec_translate($pagespec);
2447         error "syntax error in pagespec \"$pagespec\""
2448                 if ! defined $sub;
2449         my $sort=sortspec_translate($params{sort}, $params{reverse})
2450                 if defined $params{sort};
2451
2452         my @candidates;
2453         if (exists $params{list}) {
2454                 @candidates=exists $params{filter}
2455                         ? grep { ! $params{filter}->($_) } @{$params{list}}
2456                         : @{$params{list}};
2457         }
2458         else {
2459                 @candidates=exists $params{filter}
2460                         ? grep { ! $params{filter}->($_) } keys %pagesources
2461                         : keys %pagesources;
2462         }
2463
2464         # clear params, remainder is passed to pagespec
2465         $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
2466         my $num=$params{num};
2467         delete @params{qw{num deptype reverse sort filter list}};
2468
2469         # when only the top matches will be returned, it's efficient to
2470         # sort before matching to pagespec,
2471         if (defined $num && defined $sort) {
2472                 @candidates=IkiWiki::SortSpec::sort_pages(
2473                         $sort, @candidates);
2474         }
2475
2476         my @matches;
2477         my $firstfail;
2478         my $count=0;
2479         my $accum=IkiWiki::SuccessReason->new();
2480         foreach my $p (@candidates) {
2481                 my $r=$sub->($p, %params, location => $page);
2482                 error(sprintf(gettext("cannot match pages: %s"), $r))
2483                         if $r->isa("IkiWiki::ErrorReason");
2484                 unless ($r || $r->influences_static) {
2485                         $r->remove_influence($p);
2486                 }
2487                 $accum |= $r;
2488                 if ($r) {
2489                         push @matches, $p;
2490                         last if defined $num && ++$count == $num;
2491                 }
2492         }
2493
2494         # Add simple dependencies for accumulated influences.
2495         my $i=$accum->influences;
2496         foreach my $k (keys %$i) {
2497                 $depends_simple{$page}{lc $k} |= $i->{$k};
2498         }
2499
2500         # when all matches will be returned, it's efficient to
2501         # sort after matching
2502         if (! defined $num && defined $sort) {
2503                 return IkiWiki::SortSpec::sort_pages(
2504                         $sort, @matches);
2505         }
2506         else {
2507                 return @matches;
2508         }
2509 }
2510
2511 sub pagespec_valid ($) {
2512         my $spec=shift;
2513
2514         return defined pagespec_translate($spec);
2515 }
2516
2517 sub glob2re ($) {
2518         my $re=quotemeta(shift);
2519         $re=~s/\\\*/.*/g;
2520         $re=~s/\\\?/./g;
2521         return qr/^$re$/i;
2522 }
2523
2524 package IkiWiki::FailReason;
2525
2526 use overload (
2527         '""'    => sub { $_[0][0] },
2528         '0+'    => sub { 0 },
2529         '!'     => sub { bless $_[0], 'IkiWiki::SuccessReason'},
2530         '&'     => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
2531         '|'     => sub { $_[1]->merge_influences($_[0]); $_[1] },
2532         fallback => 1,
2533 );
2534
2535 our @ISA = 'IkiWiki::SuccessReason';
2536
2537 package IkiWiki::SuccessReason;
2538
2539 use overload (
2540         '""'    => sub { $_[0][0] },
2541         '0+'    => sub { 1 },
2542         '!'     => sub { bless $_[0], 'IkiWiki::FailReason'},
2543         '&'     => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
2544         '|'     => sub { $_[0]->merge_influences($_[1]); $_[0] },
2545         fallback => 1,
2546 );
2547
2548 sub new {
2549         my $class = shift;
2550         my $value = shift;
2551         return bless [$value, {@_}], $class;
2552 }
2553
2554 sub influences {
2555         my $this=shift;
2556         $this->[1]={@_} if @_;
2557         my %i=%{$this->[1]};
2558         delete $i{""};
2559         return \%i;
2560 }
2561
2562 sub influences_static {
2563         return ! $_[0][1]->{""};
2564 }
2565
2566 sub merge_influences {
2567         my $this=shift;
2568         my $other=shift;
2569         my $anded=shift;
2570
2571         if (! $anded || (($this || %{$this->[1]}) &&
2572                          ($other || %{$other->[1]}))) {
2573                 foreach my $influence (keys %{$other->[1]}) {
2574                         $this->[1]{$influence} |= $other->[1]{$influence};
2575                 }
2576         }
2577         else {
2578                 # influence blocker
2579                 $this->[1]={};
2580         }
2581 }
2582
2583 sub remove_influence {
2584         my $this=shift;
2585         my $torm=shift;
2586
2587         delete $this->[1]{$torm};
2588 }
2589
2590 package IkiWiki::ErrorReason;
2591
2592 our @ISA = 'IkiWiki::FailReason';
2593
2594 package IkiWiki::PageSpec;
2595
2596 sub derel ($$) {
2597         my $path=shift;
2598         my $from=shift;
2599
2600         if ($path =~ m!^\.(/|$)!) {
2601                 if ($1) {
2602                         $from=~s#/?[^/]+$## if defined $from;
2603                         $path=~s#^\./##;
2604                         $path="$from/$path" if defined $from && length $from;
2605                 }
2606                 else {
2607                         $path = $from;
2608                         $path = "" unless defined $path;
2609                 }
2610         }
2611
2612         return $path;
2613 }
2614
2615 my %glob_cache;
2616
2617 sub match_glob ($$;@) {
2618         my $page=shift;
2619         my $glob=shift;
2620         my %params=@_;
2621
2622         $glob=derel($glob, $params{location});
2623
2624         # Instead of converting the glob to a regex every time,
2625         # cache the compiled regex to save time.
2626         my $re=$glob_cache{$glob};
2627         unless (defined $re) {
2628                 $glob_cache{$glob} = $re = IkiWiki::glob2re($glob);
2629         }
2630         if ($page =~ $re) {
2631                 if (! IkiWiki::isinternal($page) || $params{internal}) {
2632                         return IkiWiki::SuccessReason->new("$glob matches $page");
2633                 }
2634                 else {
2635                         return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
2636                 }
2637         }
2638         else {
2639                 return IkiWiki::FailReason->new("$glob does not match $page");
2640         }
2641 }
2642
2643 sub match_internal ($$;@) {
2644         return match_glob(shift, shift, @_, internal => 1)
2645 }
2646
2647 sub match_page ($$;@) {
2648         my $page=shift;
2649         my $match=match_glob($page, shift, @_);
2650         if ($match) {
2651                 my $source=exists $IkiWiki::pagesources{$page} ?
2652                         $IkiWiki::pagesources{$page} :
2653                         $IkiWiki::delpagesources{$page};
2654                 my $type=defined $source ? IkiWiki::pagetype($source) : undef;
2655                 if (! defined $type) {
2656                         return IkiWiki::FailReason->new("$page is not a page");
2657                 }
2658         }
2659         return $match;
2660 }
2661
2662 sub match_link ($$;@) {
2663         my $page=shift;
2664         my $link=lc(shift);
2665         my %params=@_;
2666
2667         $link=derel($link, $params{location});
2668         my $from=exists $params{location} ? $params{location} : '';
2669         my $linktype=$params{linktype};
2670         my $qualifier='';
2671         if (defined $linktype) {
2672                 $qualifier=" with type $linktype";
2673         }
2674
2675         my $links = $IkiWiki::links{$page};
2676         return IkiWiki::FailReason->new("$page has no links", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2677                 unless $links && @{$links};
2678         my $bestlink = IkiWiki::bestlink($from, $link);
2679         foreach my $p (@{$links}) {
2680                 next unless (! defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p});
2681
2682                 if (length $bestlink) {
2683                         if ($bestlink eq IkiWiki::bestlink($page, $p)) {
2684                                 return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2685                         }
2686                 }
2687                 else {
2688                         if (match_glob($p, $link, %params)) {
2689                                 return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2690                         }
2691                         my ($p_rel)=$p=~/^\/?(.*)/;
2692                         $link=~s/^\///;
2693                         if (match_glob($p_rel, $link, %params)) {
2694                                 return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
2695                         }
2696                 }
2697         }
2698         return IkiWiki::FailReason->new("$page does not link to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1);
2699 }
2700
2701 sub match_backlink ($$;@) {
2702         my $page=shift;
2703         my $testpage=shift;
2704         my %params=@_;
2705         if ($testpage eq '.') {
2706                 $testpage = $params{'location'}
2707         }
2708         my $ret=match_link($testpage, $page, @_);
2709         $ret->influences($testpage => $IkiWiki::DEPEND_LINKS);
2710         return $ret;
2711 }
2712
2713 sub match_created_before ($$;@) {
2714         my $page=shift;
2715         my $testpage=shift;
2716         my %params=@_;
2717
2718         $testpage=derel($testpage, $params{location});
2719
2720         if (exists $IkiWiki::pagectime{$testpage}) {
2721                 if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
2722                         return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2723                 }
2724                 else {
2725                         return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2726                 }
2727         }
2728         else {
2729                 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2730         }
2731 }
2732
2733 sub match_created_after ($$;@) {
2734         my $page=shift;
2735         my $testpage=shift;
2736         my %params=@_;
2737
2738         $testpage=derel($testpage, $params{location});
2739
2740         if (exists $IkiWiki::pagectime{$testpage}) {
2741                 if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
2742                         return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2743                 }
2744                 else {
2745                         return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
2746                 }
2747         }
2748         else {
2749                 return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
2750         }
2751 }
2752
2753 sub match_creation_day ($$;@) {
2754         my $page=shift;
2755         my $d=shift;
2756         if ($d !~ /^\d+$/) {
2757                 return IkiWiki::ErrorReason->new("invalid day $d");
2758         }
2759         if ((localtime($IkiWiki::pagectime{$page}))[3] == $d) {
2760                 return IkiWiki::SuccessReason->new('creation_day matched');
2761         }
2762         else {
2763                 return IkiWiki::FailReason->new('creation_day did not match');
2764         }
2765 }
2766
2767 sub match_creation_month ($$;@) {
2768         my $page=shift;
2769         my $m=shift;
2770         if ($m !~ /^\d+$/) {
2771                 return IkiWiki::ErrorReason->new("invalid month $m");
2772         }
2773         if ((localtime($IkiWiki::pagectime{$page}))[4] + 1 == $m) {
2774                 return IkiWiki::SuccessReason->new('creation_month matched');
2775         }
2776         else {
2777                 return IkiWiki::FailReason->new('creation_month did not match');
2778         }
2779 }
2780
2781 sub match_creation_year ($$;@) {
2782         my $page=shift;
2783         my $y=shift;
2784         if ($y !~ /^\d+$/) {
2785                 return IkiWiki::ErrorReason->new("invalid year $y");
2786         }
2787         if ((localtime($IkiWiki::pagectime{$page}))[5] + 1900 == $y) {
2788                 return IkiWiki::SuccessReason->new('creation_year matched');
2789         }
2790         else {
2791                 return IkiWiki::FailReason->new('creation_year did not match');
2792         }
2793 }
2794
2795 sub match_user ($$;@) {
2796         shift;
2797         my $user=shift;
2798         my %params=@_;
2799
2800         if (! exists $params{user}) {
2801                 return IkiWiki::ErrorReason->new("no user specified");
2802         }
2803
2804         my $regexp=IkiWiki::glob2re($user);
2805
2806         if (defined $params{user} && $params{user}=~$regexp) {
2807                 return IkiWiki::SuccessReason->new("user is $user");
2808         }
2809         elsif (! defined $params{user}) {
2810                 return IkiWiki::FailReason->new("not logged in");
2811         }
2812         else {
2813                 return IkiWiki::FailReason->new("user is $params{user}, not $user");
2814         }
2815 }
2816
2817 sub match_admin ($$;@) {
2818         shift;
2819         shift;
2820         my %params=@_;
2821
2822         if (! exists $params{user}) {
2823                 return IkiWiki::ErrorReason->new("no user specified");
2824         }
2825
2826         if (defined $params{user} && IkiWiki::is_admin($params{user})) {
2827                 return IkiWiki::SuccessReason->new("user is an admin");
2828         }
2829         elsif (! defined $params{user}) {
2830                 return IkiWiki::FailReason->new("not logged in");
2831         }
2832         else {
2833                 return IkiWiki::FailReason->new("user is not an admin");
2834         }
2835 }
2836
2837 sub match_ip ($$;@) {
2838         shift;
2839         my $ip=shift;
2840         my %params=@_;
2841
2842         if (! exists $params{ip}) {
2843                 return IkiWiki::ErrorReason->new("no IP specified");
2844         }
2845
2846         my $regexp=IkiWiki::glob2re(lc $ip);
2847
2848         if (defined $params{ip} && lc $params{ip}=~$regexp) {
2849                 return IkiWiki::SuccessReason->new("IP is $ip");
2850         }
2851         else {
2852                 return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
2853         }
2854 }
2855
2856 package IkiWiki::SortSpec;
2857
2858 # This is in the SortSpec namespace so that the $a and $b that sort() uses
2859 # are easily available in this namespace, for cmp functions to use them.
2860 sub sort_pages {
2861         my $f=shift;
2862         sort $f @_
2863 }
2864
2865 sub cmp_title {
2866         IkiWiki::pagetitle(IkiWiki::basename($a))
2867         cmp
2868         IkiWiki::pagetitle(IkiWiki::basename($b))
2869 }
2870
2871 sub cmp_path { IkiWiki::pagetitle($a) cmp IkiWiki::pagetitle($b) }
2872 sub cmp_mtime { $IkiWiki::pagemtime{$b} <=> $IkiWiki::pagemtime{$a} }
2873 sub cmp_age { $IkiWiki::pagectime{$b} <=> $IkiWiki::pagectime{$a} }
2874
2875 1