IkiWiki.pm

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