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

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