IkiWiki.pm

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