summaryrefslogtreecommitdiff
path: root/IkiWiki.pm
blob: 2cad6a3ef4333c782e5ccfb83c3e828f8ed19e17 (plain)
  1. #!/usr/bin/perl
  2. package IkiWiki;
  3. use warnings;
  4. use strict;
  5. use Encode;
  6. use HTML::Entities;
  7. use URI::Escape q{uri_escape_utf8};
  8. use POSIX ();
  9. use Storable;
  10. use open qw{:utf8 :std};
  11. use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
  12. %pagestate %wikistate %renderedfiles %oldrenderedfiles
  13. %pagesources %destsources %depends %depends_simple %hooks
  14. %forcerebuild %loaded_plugins %typedlinks %oldtypedlinks};
  15. use Exporter q{import};
  16. our @EXPORT = qw(hook debug error template htmlpage deptype
  17. add_depends pagespec_match pagespec_match_list bestlink
  18. htmllink readfile writefile pagetype srcfile pagename
  19. displaytime will_render gettext ngettext urlto targetpage
  20. add_underlay pagetitle titlepage linkpage newpagefile
  21. inject add_link
  22. %config %links %pagestate %wikistate %renderedfiles
  23. %pagesources %destsources %typedlinks);
  24. our $VERSION = 3.00; # plugin interface version, next is ikiwiki version
  25. our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
  26. our $installdir='/usr'; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
  27. # Page dependency types.
  28. our $DEPEND_CONTENT=1;
  29. our $DEPEND_PRESENCE=2;
  30. our $DEPEND_LINKS=4;
  31. # Optimisation.
  32. use Memoize;
  33. memoize("abs2rel");
  34. memoize("sortspec_translate");
  35. memoize("pagespec_translate");
  36. memoize("template_file");
  37. sub getsetup () {
  38. wikiname => {
  39. type => "string",
  40. default => "wiki",
  41. description => "name of the wiki",
  42. safe => 1,
  43. rebuild => 1,
  44. },
  45. adminemail => {
  46. type => "string",
  47. default => undef,
  48. example => 'me@example.com',
  49. description => "contact email for wiki",
  50. safe => 1,
  51. rebuild => 0,
  52. },
  53. adminuser => {
  54. type => "string",
  55. default => [],
  56. description => "users who are wiki admins",
  57. safe => 1,
  58. rebuild => 0,
  59. },
  60. banned_users => {
  61. type => "string",
  62. default => [],
  63. description => "users who are banned from the wiki",
  64. safe => 1,
  65. rebuild => 0,
  66. },
  67. srcdir => {
  68. type => "string",
  69. default => undef,
  70. example => "$ENV{HOME}/wiki",
  71. description => "where the source of the wiki is located",
  72. safe => 0, # path
  73. rebuild => 1,
  74. },
  75. destdir => {
  76. type => "string",
  77. default => undef,
  78. example => "/var/www/wiki",
  79. description => "where to build the wiki",
  80. safe => 0, # path
  81. rebuild => 1,
  82. },
  83. url => {
  84. type => "string",
  85. default => '',
  86. example => "http://example.com/wiki",
  87. description => "base url to the wiki",
  88. safe => 1,
  89. rebuild => 1,
  90. },
  91. cgiurl => {
  92. type => "string",
  93. default => '',
  94. example => "http://example.com/wiki/ikiwiki.cgi",
  95. description => "url to the ikiwiki.cgi",
  96. safe => 1,
  97. rebuild => 1,
  98. },
  99. cgi_wrapper => {
  100. type => "string",
  101. default => '',
  102. example => "/var/www/wiki/ikiwiki.cgi",
  103. description => "filename of cgi wrapper to generate",
  104. safe => 0, # file
  105. rebuild => 0,
  106. },
  107. cgi_wrappermode => {
  108. type => "string",
  109. default => '06755',
  110. description => "mode for cgi_wrapper (can safely be made suid)",
  111. safe => 0,
  112. rebuild => 0,
  113. },
  114. rcs => {
  115. type => "string",
  116. default => '',
  117. description => "rcs backend to use",
  118. safe => 0, # don't allow overriding
  119. rebuild => 0,
  120. },
  121. default_plugins => {
  122. type => "internal",
  123. default => [qw{mdwn link inline meta htmlscrubber passwordauth
  124. openid signinedit lockedit conditional
  125. recentchanges parentlinks editpage}],
  126. description => "plugins to enable by default",
  127. safe => 0,
  128. rebuild => 1,
  129. },
  130. add_plugins => {
  131. type => "string",
  132. default => [],
  133. description => "plugins to add to the default configuration",
  134. safe => 1,
  135. rebuild => 1,
  136. },
  137. disable_plugins => {
  138. type => "string",
  139. default => [],
  140. description => "plugins to disable",
  141. safe => 1,
  142. rebuild => 1,
  143. },
  144. templatedir => {
  145. type => "string",
  146. default => "$installdir/share/ikiwiki/templates",
  147. description => "location of template files",
  148. advanced => 1,
  149. safe => 0, # path
  150. rebuild => 1,
  151. },
  152. templatedirs => {
  153. type => "internal",
  154. default => [],
  155. description => "additional directories containing template files",
  156. safe => 0,
  157. rebuild => 0,
  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. sslcookie => {
  238. type => "boolean",
  239. default => 0,
  240. description => "only send cookies over SSL connections?",
  241. advanced => 1,
  242. safe => 1,
  243. rebuild => 0,
  244. },
  245. default_pageext => {
  246. type => "string",
  247. default => "mdwn",
  248. description => "extension to use for new pages",
  249. safe => 0, # not sanitized
  250. rebuild => 0,
  251. },
  252. htmlext => {
  253. type => "string",
  254. default => "html",
  255. description => "extension to use for html files",
  256. safe => 0, # not sanitized
  257. rebuild => 1,
  258. },
  259. timeformat => {
  260. type => "string",
  261. default => '%c',
  262. description => "strftime format string to display date",
  263. advanced => 1,
  264. safe => 1,
  265. rebuild => 1,
  266. },
  267. locale => {
  268. type => "string",
  269. default => undef,
  270. example => "en_US.UTF-8",
  271. description => "UTF-8 locale to use",
  272. advanced => 1,
  273. safe => 0,
  274. rebuild => 1,
  275. },
  276. userdir => {
  277. type => "string",
  278. default => "",
  279. example => "users",
  280. description => "put user pages below specified page",
  281. safe => 1,
  282. rebuild => 1,
  283. },
  284. numbacklinks => {
  285. type => "integer",
  286. default => 10,
  287. description => "how many backlinks to show before hiding excess (0 to show all)",
  288. safe => 1,
  289. rebuild => 1,
  290. },
  291. hardlink => {
  292. type => "boolean",
  293. default => 0,
  294. description => "attempt to hardlink source files? (optimisation for large files)",
  295. advanced => 1,
  296. safe => 0, # paranoia
  297. rebuild => 0,
  298. },
  299. umask => {
  300. type => "integer",
  301. example => "022",
  302. description => "force ikiwiki to use a particular umask",
  303. advanced => 1,
  304. safe => 0, # paranoia
  305. rebuild => 0,
  306. },
  307. wrappergroup => {
  308. type => "string",
  309. example => "ikiwiki",
  310. description => "group for wrappers to run in",
  311. advanced => 1,
  312. safe => 0, # paranoia
  313. rebuild => 0,
  314. },
  315. libdir => {
  316. type => "string",
  317. default => "",
  318. example => "$ENV{HOME}/.ikiwiki/",
  319. description => "extra library and plugin directory",
  320. advanced => 1,
  321. safe => 0, # directory
  322. rebuild => 0,
  323. },
  324. ENV => {
  325. type => "string",
  326. default => {},
  327. description => "environment variables",
  328. safe => 0, # paranoia
  329. rebuild => 0,
  330. },
  331. include => {
  332. type => "string",
  333. default => undef,
  334. example => '^\.htaccess$',
  335. description => "regexp of normally excluded files to include",
  336. advanced => 1,
  337. safe => 0, # regexp
  338. rebuild => 1,
  339. },
  340. exclude => {
  341. type => "string",
  342. default => undef,
  343. example => '^(*\.private|Makefile)$',
  344. description => "regexp of files that should be skipped",
  345. advanced => 1,
  346. safe => 0, # regexp
  347. rebuild => 1,
  348. },
  349. wiki_file_prune_regexps => {
  350. type => "internal",
  351. default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
  352. qr/\.x?html?$/, qr/\.ikiwiki-new$/,
  353. qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
  354. qr/(^|\/)_MTN\//, qr/(^|\/)_darcs\//,
  355. qr/(^|\/)CVS\//, qr/\.dpkg-tmp$/],
  356. description => "regexps of source files to ignore",
  357. safe => 0,
  358. rebuild => 1,
  359. },
  360. wiki_file_chars => {
  361. type => "string",
  362. description => "specifies the characters that are allowed in source filenames",
  363. default => "-[:alnum:]+/.:_",
  364. safe => 0,
  365. rebuild => 1,
  366. },
  367. wiki_file_regexp => {
  368. type => "internal",
  369. description => "regexp of legal source files",
  370. safe => 0,
  371. rebuild => 1,
  372. },
  373. web_commit_regexp => {
  374. type => "internal",
  375. default => qr/^web commit (by (.*?(?=: |$))|from ([0-9a-fA-F:.]+[0-9a-fA-F])):?(.*)/,
  376. description => "regexp to parse web commits from logs",
  377. safe => 0,
  378. rebuild => 0,
  379. },
  380. cgi => {
  381. type => "internal",
  382. default => 0,
  383. description => "run as a cgi",
  384. safe => 0,
  385. rebuild => 0,
  386. },
  387. cgi_disable_uploads => {
  388. type => "internal",
  389. default => 1,
  390. description => "whether CGI should accept file uploads",
  391. safe => 0,
  392. rebuild => 0,
  393. },
  394. post_commit => {
  395. type => "internal",
  396. default => 0,
  397. description => "run as a post-commit hook",
  398. safe => 0,
  399. rebuild => 0,
  400. },
  401. rebuild => {
  402. type => "internal",
  403. default => 0,
  404. description => "running in rebuild mode",
  405. safe => 0,
  406. rebuild => 0,
  407. },
  408. setup => {
  409. type => "internal",
  410. default => undef,
  411. description => "running in setup mode",
  412. safe => 0,
  413. rebuild => 0,
  414. },
  415. clean => {
  416. type => "internal",
  417. default => 0,
  418. description => "running in clean mode",
  419. safe => 0,
  420. rebuild => 0,
  421. },
  422. refresh => {
  423. type => "internal",
  424. default => 0,
  425. description => "running in refresh mode",
  426. safe => 0,
  427. rebuild => 0,
  428. },
  429. test_receive => {
  430. type => "internal",
  431. default => 0,
  432. description => "running in receive test mode",
  433. safe => 0,
  434. rebuild => 0,
  435. },
  436. getctime => {
  437. type => "internal",
  438. default => 0,
  439. description => "running in getctime mode",
  440. safe => 0,
  441. rebuild => 0,
  442. },
  443. w3mmode => {
  444. type => "internal",
  445. default => 0,
  446. description => "running in w3mmode",
  447. safe => 0,
  448. rebuild => 0,
  449. },
  450. wikistatedir => {
  451. type => "internal",
  452. default => undef,
  453. description => "path to the .ikiwiki directory holding ikiwiki state",
  454. safe => 0,
  455. rebuild => 0,
  456. },
  457. setupfile => {
  458. type => "internal",
  459. default => undef,
  460. description => "path to setup file",
  461. safe => 0,
  462. rebuild => 0,
  463. },
  464. setuptype => {
  465. type => "internal",
  466. default => "Standard",
  467. description => "perl class to use to dump setup file",
  468. safe => 0,
  469. rebuild => 0,
  470. },
  471. allow_symlinks_before_srcdir => {
  472. type => "boolean",
  473. default => 0,
  474. description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
  475. safe => 0,
  476. rebuild => 0,
  477. },
  478. }
  479. sub defaultconfig () {
  480. my %s=getsetup();
  481. my @ret;
  482. foreach my $key (keys %s) {
  483. push @ret, $key, $s{$key}->{default};
  484. }
  485. use Data::Dumper;
  486. return @ret;
  487. }
  488. sub checkconfig () {
  489. # locale stuff; avoid LC_ALL since it overrides everything
  490. if (defined $ENV{LC_ALL}) {
  491. $ENV{LANG} = $ENV{LC_ALL};
  492. delete $ENV{LC_ALL};
  493. }
  494. if (defined $config{locale}) {
  495. if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
  496. $ENV{LANG}=$config{locale};
  497. define_gettext();
  498. }
  499. }
  500. if (! defined $config{wiki_file_regexp}) {
  501. $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
  502. }
  503. if (ref $config{ENV} eq 'HASH') {
  504. foreach my $val (keys %{$config{ENV}}) {
  505. $ENV{$val}=$config{ENV}{$val};
  506. }
  507. }
  508. if ($config{w3mmode}) {
  509. eval q{use Cwd q{abs_path}};
  510. error($@) if $@;
  511. $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
  512. $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
  513. $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
  514. unless $config{cgiurl} =~ m!file:///!;
  515. $config{url}="file://".$config{destdir};
  516. }
  517. if ($config{cgi} && ! length $config{url}) {
  518. error(gettext("Must specify url to wiki with --url when using --cgi"));
  519. }
  520. $config{wikistatedir}="$config{srcdir}/.ikiwiki"
  521. unless exists $config{wikistatedir} && defined $config{wikistatedir};
  522. if (defined $config{umask}) {
  523. umask(possibly_foolish_untaint($config{umask}));
  524. }
  525. run_hooks(checkconfig => sub { shift->() });
  526. return 1;
  527. }
  528. sub listplugins () {
  529. my %ret;
  530. foreach my $dir (@INC, $config{libdir}) {
  531. next unless defined $dir && length $dir;
  532. foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
  533. my ($plugin)=$file=~/.*\/(.*)\.pm$/;
  534. $ret{$plugin}=1;
  535. }
  536. }
  537. foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
  538. next unless defined $dir && length $dir;
  539. foreach my $file (glob("$dir/plugins/*")) {
  540. $ret{basename($file)}=1 if -x $file;
  541. }
  542. }
  543. return keys %ret;
  544. }
  545. sub loadplugins () {
  546. if (defined $config{libdir} && length $config{libdir}) {
  547. unshift @INC, possibly_foolish_untaint($config{libdir});
  548. }
  549. foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
  550. loadplugin($plugin);
  551. }
  552. if ($config{rcs}) {
  553. if (exists $hooks{rcs}) {
  554. error(gettext("cannot use multiple rcs plugins"));
  555. }
  556. loadplugin($config{rcs});
  557. }
  558. if (! exists $hooks{rcs}) {
  559. loadplugin("norcs");
  560. }
  561. run_hooks(getopt => sub { shift->() });
  562. if (grep /^-/, @ARGV) {
  563. print STDERR "Unknown option (or missing parameter): $_\n"
  564. foreach grep /^-/, @ARGV;
  565. usage();
  566. }
  567. return 1;
  568. }
  569. sub loadplugin ($) {
  570. my $plugin=shift;
  571. return if grep { $_ eq $plugin} @{$config{disable_plugins}};
  572. foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
  573. "$installdir/lib/ikiwiki") {
  574. if (defined $dir && -x "$dir/plugins/$plugin") {
  575. eval { require IkiWiki::Plugin::external };
  576. if ($@) {
  577. my $reason=$@;
  578. error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
  579. }
  580. import IkiWiki::Plugin::external "$dir/plugins/$plugin";
  581. $loaded_plugins{$plugin}=1;
  582. return 1;
  583. }
  584. }
  585. my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
  586. eval qq{use $mod};
  587. if ($@) {
  588. error("Failed to load plugin $mod: $@");
  589. }
  590. $loaded_plugins{$plugin}=1;
  591. return 1;
  592. }
  593. sub error ($;$) {
  594. my $message=shift;
  595. my $cleaner=shift;
  596. log_message('err' => $message) if $config{syslog};
  597. if (defined $cleaner) {
  598. $cleaner->();
  599. }
  600. die $message."\n";
  601. }
  602. sub debug ($) {
  603. return unless $config{verbose};
  604. return log_message(debug => @_);
  605. }
  606. my $log_open=0;
  607. sub log_message ($$) {
  608. my $type=shift;
  609. if ($config{syslog}) {
  610. require Sys::Syslog;
  611. if (! $log_open) {
  612. Sys::Syslog::setlogsock('unix');
  613. Sys::Syslog::openlog('ikiwiki', '', 'user');
  614. $log_open=1;
  615. }
  616. return eval {
  617. Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
  618. };
  619. }
  620. elsif (! $config{cgi}) {
  621. return print "@_\n";
  622. }
  623. else {
  624. return print STDERR "@_\n";
  625. }
  626. }
  627. sub possibly_foolish_untaint ($) {
  628. my $tainted=shift;
  629. my ($untainted)=$tainted=~/(.*)/s;
  630. return $untainted;
  631. }
  632. sub basename ($) {
  633. my $file=shift;
  634. $file=~s!.*/+!!;
  635. return $file;
  636. }
  637. sub dirname ($) {
  638. my $file=shift;
  639. $file=~s!/*[^/]+$!!;
  640. return $file;
  641. }
  642. sub isinternal ($) {
  643. my $page=shift;
  644. return exists $pagesources{$page} &&
  645. $pagesources{$page} =~ /\._([^.]+)$/;
  646. }
  647. sub pagetype ($) {
  648. my $file=shift;
  649. if ($file =~ /\.([^.]+)$/) {
  650. return $1 if exists $hooks{htmlize}{$1};
  651. }
  652. my $base=basename($file);
  653. if (exists $hooks{htmlize}{$base} &&
  654. $hooks{htmlize}{$base}{noextension}) {
  655. return $base;
  656. }
  657. return;
  658. }
  659. my %pagename_cache;
  660. sub pagename ($) {
  661. my $file=shift;
  662. if (exists $pagename_cache{$file}) {
  663. return $pagename_cache{$file};
  664. }
  665. my $type=pagetype($file);
  666. my $page=$file;
  667. $page=~s/\Q.$type\E*$//
  668. if defined $type && !$hooks{htmlize}{$type}{keepextension}
  669. && !$hooks{htmlize}{$type}{noextension};
  670. if ($config{indexpages} && $page=~/(.*)\/index$/) {
  671. $page=$1;
  672. }
  673. $pagename_cache{$file} = $page;
  674. return $page;
  675. }
  676. sub newpagefile ($$) {
  677. my $page=shift;
  678. my $type=shift;
  679. if (! $config{indexpages} || $page eq 'index') {
  680. return $page.".".$type;
  681. }
  682. else {
  683. return $page."/index.".$type;
  684. }
  685. }
  686. sub targetpage ($$;$) {
  687. my $page=shift;
  688. my $ext=shift;
  689. my $filename=shift;
  690. if (defined $filename) {
  691. return $page."/".$filename.".".$ext;
  692. }
  693. elsif (! $config{usedirs} || $page eq 'index') {
  694. return $page.".".$ext;
  695. }
  696. else {
  697. return $page."/index.".$ext;
  698. }
  699. }
  700. sub htmlpage ($) {
  701. my $page=shift;
  702. return targetpage($page, $config{htmlext});
  703. }
  704. sub srcfile_stat {
  705. my $file=shift;
  706. my $nothrow=shift;
  707. return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
  708. foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
  709. return "$dir/$file", stat(_) if -e "$dir/$file";
  710. }
  711. error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
  712. return;
  713. }
  714. sub srcfile ($;$) {
  715. return (srcfile_stat(@_))[0];
  716. }
  717. sub add_underlay ($) {
  718. my $dir=shift;
  719. if ($dir !~ /^\//) {
  720. $dir="$config{underlaydirbase}/$dir";
  721. }
  722. if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
  723. unshift @{$config{underlaydirs}}, $dir;
  724. }
  725. return 1;
  726. }
  727. sub readfile ($;$$) {
  728. my $file=shift;
  729. my $binary=shift;
  730. my $wantfd=shift;
  731. if (-l $file) {
  732. error("cannot read a symlink ($file)");
  733. }
  734. local $/=undef;
  735. open (my $in, "<", $file) || error("failed to read $file: $!");
  736. binmode($in) if ($binary);
  737. return \*$in if $wantfd;
  738. my $ret=<$in>;
  739. # check for invalid utf-8, and toss it back to avoid crashes
  740. if (! utf8::valid($ret)) {
  741. $ret=encode_utf8($ret);
  742. }
  743. close $in || error("failed to read $file: $!");
  744. return $ret;
  745. }
  746. sub prep_writefile ($$) {
  747. my $file=shift;
  748. my $destdir=shift;
  749. my $test=$file;
  750. while (length $test) {
  751. if (-l "$destdir/$test") {
  752. error("cannot write to a symlink ($test)");
  753. }
  754. $test=dirname($test);
  755. }
  756. my $dir=dirname("$destdir/$file");
  757. if (! -d $dir) {
  758. my $d="";
  759. foreach my $s (split(m!/+!, $dir)) {
  760. $d.="$s/";
  761. if (! -d $d) {
  762. mkdir($d) || error("failed to create directory $d: $!");
  763. }
  764. }
  765. }
  766. return 1;
  767. }
  768. sub writefile ($$$;$$) {
  769. my $file=shift; # can include subdirs
  770. my $destdir=shift; # directory to put file in
  771. my $content=shift;
  772. my $binary=shift;
  773. my $writer=shift;
  774. prep_writefile($file, $destdir);
  775. my $newfile="$destdir/$file.ikiwiki-new";
  776. if (-l $newfile) {
  777. error("cannot write to a symlink ($newfile)");
  778. }
  779. my $cleanup = sub { unlink($newfile) };
  780. open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
  781. binmode($out) if ($binary);
  782. if ($writer) {
  783. $writer->(\*$out, $cleanup);
  784. }
  785. else {
  786. print $out $content or error("failed writing to $newfile: $!", $cleanup);
  787. }
  788. close $out || error("failed saving $newfile: $!", $cleanup);
  789. rename($newfile, "$destdir/$file") ||
  790. error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
  791. return 1;
  792. }
  793. my %cleared;
  794. sub will_render ($$;$) {
  795. my $page=shift;
  796. my $dest=shift;
  797. my $clear=shift;
  798. # Important security check.
  799. if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
  800. ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
  801. error("$config{destdir}/$dest independently created, not overwriting with version from $page");
  802. }
  803. if (! $clear || $cleared{$page}) {
  804. $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
  805. }
  806. else {
  807. foreach my $old (@{$renderedfiles{$page}}) {
  808. delete $destsources{$old};
  809. }
  810. $renderedfiles{$page}=[$dest];
  811. $cleared{$page}=1;
  812. }
  813. $destsources{$dest}=$page;
  814. return 1;
  815. }
  816. sub bestlink ($$) {
  817. my $page=shift;
  818. my $link=shift;
  819. my $cwd=$page;
  820. if ($link=~s/^\/+//) {
  821. # absolute links
  822. $cwd="";
  823. }
  824. $link=~s/\/$//;
  825. do {
  826. my $l=$cwd;
  827. $l.="/" if length $l;
  828. $l.=$link;
  829. if (exists $pagesources{$l}) {
  830. return $l;
  831. }
  832. elsif (exists $pagecase{lc $l}) {
  833. return $pagecase{lc $l};
  834. }
  835. } while $cwd=~s{/?[^/]+$}{};
  836. if (length $config{userdir}) {
  837. my $l = "$config{userdir}/".lc($link);
  838. if (exists $pagesources{$l}) {
  839. return $l;
  840. }
  841. elsif (exists $pagecase{lc $l}) {
  842. return $pagecase{lc $l};
  843. }
  844. }
  845. #print STDERR "warning: page $page, broken link: $link\n";
  846. return "";
  847. }
  848. sub isinlinableimage ($) {
  849. my $file=shift;
  850. return $file =~ /\.(png|gif|jpg|jpeg)$/i;
  851. }
  852. sub pagetitle ($;$) {
  853. my $page=shift;
  854. my $unescaped=shift;
  855. if ($unescaped) {
  856. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
  857. }
  858. else {
  859. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
  860. }
  861. return $page;
  862. }
  863. sub titlepage ($) {
  864. my $title=shift;
  865. # support use w/o %config set
  866. my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
  867. $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  868. return $title;
  869. }
  870. sub linkpage ($) {
  871. my $link=shift;
  872. my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
  873. $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  874. return $link;
  875. }
  876. sub cgiurl (@) {
  877. my %params=@_;
  878. my $cgiurl=$config{cgiurl};
  879. if (exists $params{cgiurl}) {
  880. $cgiurl=$params{cgiurl};
  881. delete $params{cgiurl};
  882. }
  883. return $cgiurl."?".
  884. join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
  885. }
  886. sub baseurl (;$) {
  887. my $page=shift;
  888. return "$config{url}/" if ! defined $page;
  889. $page=htmlpage($page);
  890. $page=~s/[^\/]+$//;
  891. $page=~s/[^\/]+\//..\//g;
  892. return $page;
  893. }
  894. sub abs2rel ($$) {
  895. # Work around very innefficient behavior in File::Spec if abs2rel
  896. # is passed two relative paths. It's much faster if paths are
  897. # absolute! (Debian bug #376658; fixed in debian unstable now)
  898. my $path="/".shift;
  899. my $base="/".shift;
  900. require File::Spec;
  901. my $ret=File::Spec->abs2rel($path, $base);
  902. $ret=~s/^// if defined $ret;
  903. return $ret;
  904. }
  905. sub displaytime ($;$) {
  906. # Plugins can override this function to mark up the time to
  907. # display.
  908. return '<span class="date">'.formattime(@_).'</span>';
  909. }
  910. sub formattime ($;$) {
  911. # Plugins can override this function to format the time.
  912. my $time=shift;
  913. my $format=shift;
  914. if (! defined $format) {
  915. $format=$config{timeformat};
  916. }
  917. # strftime doesn't know about encodings, so make sure
  918. # its output is properly treated as utf8
  919. return decode_utf8(POSIX::strftime($format, localtime($time)));
  920. }
  921. sub beautify_urlpath ($) {
  922. my $url=shift;
  923. # Ensure url is not an empty link, and if necessary,
  924. # add ./ to avoid colon confusion.
  925. if ($url !~ /^\// && $url !~ /^\.\.?\//) {
  926. $url="./$url";
  927. }
  928. if ($config{usedirs}) {
  929. $url =~ s!/index.$config{htmlext}$!/!;
  930. }
  931. return $url;
  932. }
  933. sub urlto ($$;$) {
  934. my $to=shift;
  935. my $from=shift;
  936. my $absolute=shift;
  937. if (! length $to) {
  938. return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
  939. }
  940. if (! $destsources{$to}) {
  941. $to=htmlpage($to);
  942. }
  943. if ($absolute) {
  944. return $config{url}.beautify_urlpath("/".$to);
  945. }
  946. my $link = abs2rel($to, dirname(htmlpage($from)));
  947. return beautify_urlpath($link);
  948. }
  949. sub htmllink ($$$;@) {
  950. my $lpage=shift; # the page doing the linking
  951. my $page=shift; # the page that will contain the link (different for inline)
  952. my $link=shift;
  953. my %opts=@_;
  954. $link=~s/\/$//;
  955. my $bestlink;
  956. if (! $opts{forcesubpage}) {
  957. $bestlink=bestlink($lpage, $link);
  958. }
  959. else {
  960. $bestlink="$lpage/".lc($link);
  961. }
  962. my $linktext;
  963. if (defined $opts{linktext}) {
  964. $linktext=$opts{linktext};
  965. }
  966. else {
  967. $linktext=pagetitle(basename($link));
  968. }
  969. return "<span class=\"selflink\">$linktext</span>"
  970. if length $bestlink && $page eq $bestlink &&
  971. ! defined $opts{anchor};
  972. if (! $destsources{$bestlink}) {
  973. $bestlink=htmlpage($bestlink);
  974. if (! $destsources{$bestlink}) {
  975. return $linktext unless length $config{cgiurl};
  976. return "<span class=\"createlink\"><a href=\"".
  977. cgiurl(
  978. do => "create",
  979. page => lc($link),
  980. from => $lpage
  981. ).
  982. "\" rel=\"nofollow\">?</a>$linktext</span>"
  983. }
  984. }
  985. $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
  986. $bestlink=beautify_urlpath($bestlink);
  987. if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
  988. return "<img src=\"$bestlink\" alt=\"$linktext\" />";
  989. }
  990. if (defined $opts{anchor}) {
  991. $bestlink.="#".$opts{anchor};
  992. }
  993. my @attrs;
  994. foreach my $attr (qw{rel class title}) {
  995. if (defined $opts{$attr}) {
  996. push @attrs, " $attr=\"$opts{$attr}\"";
  997. }
  998. }
  999. return "<a href=\"$bestlink\"@attrs>$linktext</a>";
  1000. }
  1001. sub userpage ($) {
  1002. my $user=shift;
  1003. return length $config{userdir} ? "$config{userdir}/$user" : $user;
  1004. }
  1005. sub openiduser ($) {
  1006. my $user=shift;
  1007. if ($user =~ m!^https?://! &&
  1008. eval q{use Net::OpenID::VerifiedIdentity; 1} && !$@) {
  1009. my $display;
  1010. if (Net::OpenID::VerifiedIdentity->can("DisplayOfURL")) {
  1011. $display = Net::OpenID::VerifiedIdentity::DisplayOfURL($user);
  1012. }
  1013. else {
  1014. # backcompat with old version
  1015. my $oid=Net::OpenID::VerifiedIdentity->new(identity => $user);
  1016. $display=$oid->display;
  1017. }
  1018. # Convert "user.somehost.com" to "user [somehost.com]"
  1019. # (also "user.somehost.co.uk")
  1020. if ($display !~ /\[/) {
  1021. $display=~s/^([-a-zA-Z0-9]+?)\.([-.a-zA-Z0-9]+\.[a-z]+)$/$1 [$2]/;
  1022. }
  1023. # Convert "http://somehost.com/user" to "user [somehost.com]".
  1024. # (also "https://somehost.com/user/")
  1025. if ($display !~ /\[/) {
  1026. $display=~s/^https?:\/\/(.+)\/([^\/#?]+)\/?(?:[#?].*)?$/$2 [$1]/;
  1027. }
  1028. $display=~s!^https?://!!; # make sure this is removed
  1029. eval q{use CGI 'escapeHTML'};
  1030. error($@) if $@;
  1031. return escapeHTML($display);
  1032. }
  1033. return;
  1034. }
  1035. sub htmlize ($$$$) {
  1036. my $page=shift;
  1037. my $destpage=shift;
  1038. my $type=shift;
  1039. my $content=shift;
  1040. my $oneline = $content !~ /\n/;
  1041. if (exists $hooks{htmlize}{$type}) {
  1042. $content=$hooks{htmlize}{$type}{call}->(
  1043. page => $page,
  1044. content => $content,
  1045. );
  1046. }
  1047. else {
  1048. error("htmlization of $type not supported");
  1049. }
  1050. run_hooks(sanitize => sub {
  1051. $content=shift->(
  1052. page => $page,
  1053. destpage => $destpage,
  1054. content => $content,
  1055. );
  1056. });
  1057. if ($oneline) {
  1058. # hack to get rid of enclosing junk added by markdown
  1059. # and other htmlizers/sanitizers
  1060. $content=~s/^<p>//i;
  1061. $content=~s/<\/p>\n*$//i;
  1062. }
  1063. return $content;
  1064. }
  1065. sub linkify ($$$) {
  1066. my $page=shift;
  1067. my $destpage=shift;
  1068. my $content=shift;
  1069. run_hooks(linkify => sub {
  1070. $content=shift->(
  1071. page => $page,
  1072. destpage => $destpage,
  1073. content => $content,
  1074. );
  1075. });
  1076. return $content;
  1077. }
  1078. our %preprocessing;
  1079. our $preprocess_preview=0;
  1080. sub preprocess ($$$;$$) {
  1081. my $page=shift; # the page the data comes from
  1082. my $destpage=shift; # the page the data will appear in (different for inline)
  1083. my $content=shift;
  1084. my $scan=shift;
  1085. my $preview=shift;
  1086. # Using local because it needs to be set within any nested calls
  1087. # of this function.
  1088. local $preprocess_preview=$preview if defined $preview;
  1089. my $handle=sub {
  1090. my $escape=shift;
  1091. my $prefix=shift;
  1092. my $command=shift;
  1093. my $params=shift;
  1094. $params="" if ! defined $params;
  1095. if (length $escape) {
  1096. return "[[$prefix$command $params]]";
  1097. }
  1098. elsif (exists $hooks{preprocess}{$command}) {
  1099. return "" if $scan && ! $hooks{preprocess}{$command}{scan};
  1100. # Note: preserve order of params, some plugins may
  1101. # consider it significant.
  1102. my @params;
  1103. while ($params =~ m{
  1104. (?:([-\w]+)=)? # 1: named parameter key?
  1105. (?:
  1106. """(.*?)""" # 2: triple-quoted value
  1107. |
  1108. "([^"]*?)" # 3: single-quoted value
  1109. |
  1110. (\S+) # 4: unquoted value
  1111. )
  1112. (?:\s+|$) # delimiter to next param
  1113. }sgx) {
  1114. my $key=$1;
  1115. my $val;
  1116. if (defined $2) {
  1117. $val=$2;
  1118. $val=~s/\r\n/\n/mg;
  1119. $val=~s/^\n+//g;
  1120. $val=~s/\n+$//g;
  1121. }
  1122. elsif (defined $3) {
  1123. $val=$3;
  1124. }
  1125. elsif (defined $4) {
  1126. $val=$4;
  1127. }
  1128. if (defined $key) {
  1129. push @params, $key, $val;
  1130. }
  1131. else {
  1132. push @params, $val, '';
  1133. }
  1134. }
  1135. if ($preprocessing{$page}++ > 3) {
  1136. # Avoid loops of preprocessed pages preprocessing
  1137. # other pages that preprocess them, etc.
  1138. return "[[!$command <span class=\"error\">".
  1139. sprintf(gettext("preprocessing loop detected on %s at depth %i"),
  1140. $page, $preprocessing{$page}).
  1141. "</span>]]";
  1142. }
  1143. my $ret;
  1144. if (! $scan) {
  1145. $ret=eval {
  1146. $hooks{preprocess}{$command}{call}->(
  1147. @params,
  1148. page => $page,
  1149. destpage => $destpage,
  1150. preview => $preprocess_preview,
  1151. );
  1152. };
  1153. if ($@) {
  1154. my $error=$@;
  1155. chomp $error;
  1156. $ret="[[!$command <span class=\"error\">".
  1157. gettext("Error").": $error"."</span>]]";
  1158. }
  1159. }
  1160. else {
  1161. # use void context during scan pass
  1162. eval {
  1163. $hooks{preprocess}{$command}{call}->(
  1164. @params,
  1165. page => $page,
  1166. destpage => $destpage,
  1167. preview => $preprocess_preview,
  1168. );
  1169. };
  1170. $ret="";
  1171. }
  1172. $preprocessing{$page}--;
  1173. return $ret;
  1174. }
  1175. else {
  1176. return "[[$prefix$command $params]]";
  1177. }
  1178. };
  1179. my $regex;
  1180. if ($config{prefix_directives}) {
  1181. $regex = qr{
  1182. (\\?) # 1: escape?
  1183. \[\[(!) # directive open; 2: prefix
  1184. ([-\w]+) # 3: command
  1185. ( # 4: the parameters..
  1186. \s+ # Must have space if parameters present
  1187. (?:
  1188. (?:[-\w]+=)? # named parameter key?
  1189. (?:
  1190. """.*?""" # triple-quoted value
  1191. |
  1192. "[^"]*?" # single-quoted value
  1193. |
  1194. [^"\s\]]+ # unquoted value
  1195. )
  1196. \s* # whitespace or end
  1197. # of directive
  1198. )
  1199. *)? # 0 or more parameters
  1200. \]\] # directive closed
  1201. }sx;
  1202. }
  1203. else {
  1204. $regex = qr{
  1205. (\\?) # 1: escape?
  1206. \[\[(!?) # directive open; 2: optional prefix
  1207. ([-\w]+) # 3: command
  1208. \s+
  1209. ( # 4: the parameters..
  1210. (?:
  1211. (?:[-\w]+=)? # named parameter key?
  1212. (?:
  1213. """.*?""" # triple-quoted value
  1214. |
  1215. "[^"]*?" # single-quoted value
  1216. |
  1217. [^"\s\]]+ # unquoted value
  1218. )
  1219. \s* # whitespace or end
  1220. # of directive
  1221. )
  1222. *) # 0 or more parameters
  1223. \]\] # directive closed
  1224. }sx;
  1225. }
  1226. $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
  1227. return $content;
  1228. }
  1229. sub filter ($$$) {
  1230. my $page=shift;
  1231. my $destpage=shift;
  1232. my $content=shift;
  1233. run_hooks(filter => sub {
  1234. $content=shift->(page => $page, destpage => $destpage,
  1235. content => $content);
  1236. });
  1237. return $content;
  1238. }
  1239. sub indexlink () {
  1240. return "<a href=\"$config{url}\">$config{wikiname}</a>";
  1241. }
  1242. sub check_canedit ($$$;$) {
  1243. my $page=shift;
  1244. my $q=shift;
  1245. my $session=shift;
  1246. my $nonfatal=shift;
  1247. my $canedit;
  1248. run_hooks(canedit => sub {
  1249. return if defined $canedit;
  1250. my $ret=shift->($page, $q, $session);
  1251. if (defined $ret) {
  1252. if ($ret eq "") {
  1253. $canedit=1;
  1254. }
  1255. elsif (ref $ret eq 'CODE') {
  1256. $ret->() unless $nonfatal;
  1257. $canedit=0;
  1258. }
  1259. elsif (defined $ret) {
  1260. error($ret) unless $nonfatal;
  1261. $canedit=0;
  1262. }
  1263. }
  1264. });
  1265. return defined $canedit ? $canedit : 1;
  1266. }
  1267. sub check_content (@) {
  1268. my %params=@_;
  1269. return 1 if ! exists $hooks{checkcontent}; # optimisation
  1270. if (exists $pagesources{$params{page}}) {
  1271. my @diff;
  1272. my %old=map { $_ => 1 }
  1273. split("\n", readfile(srcfile($pagesources{$params{page}})));
  1274. foreach my $line (split("\n", $params{content})) {
  1275. push @diff, $line if ! exists $old{$line};
  1276. }
  1277. $params{diff}=join("\n", @diff);
  1278. }
  1279. my $ok;
  1280. run_hooks(checkcontent => sub {
  1281. return if defined $ok;
  1282. my $ret=shift->(%params);
  1283. if (defined $ret) {
  1284. if ($ret eq "") {
  1285. $ok=1;
  1286. }
  1287. elsif (ref $ret eq 'CODE') {
  1288. $ret->() unless $params{nonfatal};
  1289. $ok=0;
  1290. }
  1291. elsif (defined $ret) {
  1292. error($ret) unless $params{nonfatal};
  1293. $ok=0;
  1294. }
  1295. }
  1296. });
  1297. return defined $ok ? $ok : 1;
  1298. }
  1299. my $wikilock;
  1300. sub lockwiki () {
  1301. # Take an exclusive lock on the wiki to prevent multiple concurrent
  1302. # run issues. The lock will be dropped on program exit.
  1303. if (! -d $config{wikistatedir}) {
  1304. mkdir($config{wikistatedir});
  1305. }
  1306. open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
  1307. error ("cannot write to $config{wikistatedir}/lockfile: $!");
  1308. if (! flock($wikilock, 2)) { # LOCK_EX
  1309. error("failed to get lock");
  1310. }
  1311. return 1;
  1312. }
  1313. sub unlockwiki () {
  1314. POSIX::close($ENV{IKIWIKI_CGILOCK_FD}) if exists $ENV{IKIWIKI_CGILOCK_FD};
  1315. return close($wikilock) if $wikilock;
  1316. return;
  1317. }
  1318. my $commitlock;
  1319. sub commit_hook_enabled () {
  1320. open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
  1321. error("cannot write to $config{wikistatedir}/commitlock: $!");
  1322. if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
  1323. close($commitlock) || error("failed closing commitlock: $!");
  1324. return 0;
  1325. }
  1326. close($commitlock) || error("failed closing commitlock: $!");
  1327. return 1;
  1328. }
  1329. sub disable_commit_hook () {
  1330. open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
  1331. error("cannot write to $config{wikistatedir}/commitlock: $!");
  1332. if (! flock($commitlock, 2)) { # LOCK_EX
  1333. error("failed to get commit lock");
  1334. }
  1335. return 1;
  1336. }
  1337. sub enable_commit_hook () {
  1338. return close($commitlock) if $commitlock;
  1339. return;
  1340. }
  1341. sub loadindex () {
  1342. %oldrenderedfiles=%pagectime=();
  1343. if (! $config{rebuild}) {
  1344. %pagesources=%pagemtime=%oldlinks=%links=%depends=
  1345. %destsources=%renderedfiles=%pagecase=%pagestate=
  1346. %depends_simple=%typedlinks=%oldtypedlinks=();
  1347. }
  1348. my $in;
  1349. if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
  1350. if (-e "$config{wikistatedir}/index") {
  1351. system("ikiwiki-transition", "indexdb", $config{srcdir});
  1352. open ($in, "<", "$config{wikistatedir}/indexdb") || return;
  1353. }
  1354. else {
  1355. return;
  1356. }
  1357. }
  1358. my $index=Storable::fd_retrieve($in);
  1359. if (! defined $index) {
  1360. return 0;
  1361. }
  1362. my $pages;
  1363. if (exists $index->{version} && ! ref $index->{version}) {
  1364. $pages=$index->{page};
  1365. %wikistate=%{$index->{state}};
  1366. }
  1367. else {
  1368. $pages=$index;
  1369. %wikistate=();
  1370. }
  1371. foreach my $src (keys %$pages) {
  1372. my $d=$pages->{$src};
  1373. my $page=pagename($src);
  1374. $pagectime{$page}=$d->{ctime};
  1375. if (! $config{rebuild}) {
  1376. $pagesources{$page}=$src;
  1377. $pagemtime{$page}=$d->{mtime};
  1378. $renderedfiles{$page}=$d->{dest};
  1379. if (exists $d->{links} && ref $d->{links}) {
  1380. $links{$page}=$d->{links};
  1381. $oldlinks{$page}=[@{$d->{links}}];
  1382. }
  1383. if (ref $d->{depends_simple} eq 'ARRAY') {
  1384. # old format
  1385. $depends_simple{$page}={
  1386. map { $_ => 1 } @{$d->{depends_simple}}
  1387. };
  1388. }
  1389. elsif (exists $d->{depends_simple}) {
  1390. $depends_simple{$page}=$d->{depends_simple};
  1391. }
  1392. if (exists $d->{dependslist}) {
  1393. # old format
  1394. $depends{$page}={
  1395. map { $_ => $DEPEND_CONTENT }
  1396. @{$d->{dependslist}}
  1397. };
  1398. }
  1399. elsif (exists $d->{depends} && ! ref $d->{depends}) {
  1400. # old format
  1401. $depends{$page}={$d->{depends} => $DEPEND_CONTENT };
  1402. }
  1403. elsif (exists $d->{depends}) {
  1404. $depends{$page}=$d->{depends};
  1405. }
  1406. if (exists $d->{state}) {
  1407. $pagestate{$page}=$d->{state};
  1408. }
  1409. if (exists $d->{typedlinks}) {
  1410. $typedlinks{$page}=$d->{typedlinks};
  1411. while (my ($type, $links) = each %{$typedlinks{$page}}) {
  1412. next unless %$links;
  1413. $oldtypedlinks{$page}{$type} = {%$links};
  1414. }
  1415. }
  1416. }
  1417. $oldrenderedfiles{$page}=[@{$d->{dest}}];
  1418. }
  1419. foreach my $page (keys %pagesources) {
  1420. $pagecase{lc $page}=$page;
  1421. }
  1422. foreach my $page (keys %renderedfiles) {
  1423. $destsources{$_}=$page foreach @{$renderedfiles{$page}};
  1424. }
  1425. return close($in);
  1426. }
  1427. sub saveindex () {
  1428. run_hooks(savestate => sub { shift->() });
  1429. my %hookids;
  1430. foreach my $type (keys %hooks) {
  1431. $hookids{$_}=1 foreach keys %{$hooks{$type}};
  1432. }
  1433. my @hookids=keys %hookids;
  1434. if (! -d $config{wikistatedir}) {
  1435. mkdir($config{wikistatedir});
  1436. }
  1437. my $newfile="$config{wikistatedir}/indexdb.new";
  1438. my $cleanup = sub { unlink($newfile) };
  1439. open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
  1440. my %index;
  1441. foreach my $page (keys %pagemtime) {
  1442. next unless $pagemtime{$page};
  1443. my $src=$pagesources{$page};
  1444. $index{page}{$src}={
  1445. ctime => $pagectime{$page},
  1446. mtime => $pagemtime{$page},
  1447. dest => $renderedfiles{$page},
  1448. links => $links{$page},
  1449. };
  1450. if (exists $depends{$page}) {
  1451. $index{page}{$src}{depends} = $depends{$page};
  1452. }
  1453. if (exists $depends_simple{$page}) {
  1454. $index{page}{$src}{depends_simple} = $depends_simple{$page};
  1455. }
  1456. if (exists $typedlinks{$page} && %{$typedlinks{$page}}) {
  1457. $index{page}{$src}{typedlinks} = $typedlinks{$page};
  1458. }
  1459. if (exists $pagestate{$page}) {
  1460. foreach my $id (@hookids) {
  1461. foreach my $key (keys %{$pagestate{$page}{$id}}) {
  1462. $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
  1463. }
  1464. }
  1465. }
  1466. }
  1467. $index{state}={};
  1468. foreach my $id (@hookids) {
  1469. foreach my $key (keys %{$wikistate{$id}}) {
  1470. $index{state}{$id}{$key}=$wikistate{$id}{$key};
  1471. }
  1472. }
  1473. $index{version}="3";
  1474. my $ret=Storable::nstore_fd(\%index, $out);
  1475. return if ! defined $ret || ! $ret;
  1476. close $out || error("failed saving to $newfile: $!", $cleanup);
  1477. rename($newfile, "$config{wikistatedir}/indexdb") ||
  1478. error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
  1479. return 1;
  1480. }
  1481. sub template_file ($) {
  1482. my $template=shift;
  1483. foreach my $dir ($config{templatedir}, @{$config{templatedirs}},
  1484. "$installdir/share/ikiwiki/templates") {
  1485. return "$dir/$template" if -e "$dir/$template";
  1486. }
  1487. return;
  1488. }
  1489. sub template_params (@) {
  1490. my $filename=template_file(shift);
  1491. if (! defined $filename) {
  1492. return if wantarray;
  1493. return "";
  1494. }
  1495. my @ret=(
  1496. filter => sub {
  1497. my $text_ref = shift;
  1498. ${$text_ref} = decode_utf8(${$text_ref});
  1499. },
  1500. filename => $filename,
  1501. loop_context_vars => 1,
  1502. die_on_bad_params => 0,
  1503. @_
  1504. );
  1505. return wantarray ? @ret : {@ret};
  1506. }
  1507. sub template ($;@) {
  1508. require HTML::Template;
  1509. return HTML::Template->new(template_params(@_));
  1510. }
  1511. sub misctemplate ($$;@) {
  1512. my $title=shift;
  1513. my $pagebody=shift;
  1514. my $template=template("misc.tmpl");
  1515. $template->param(
  1516. title => $title,
  1517. indexlink => indexlink(),
  1518. wikiname => $config{wikiname},
  1519. pagebody => $pagebody,
  1520. baseurl => baseurl(),
  1521. @_,
  1522. );
  1523. run_hooks(pagetemplate => sub {
  1524. shift->(page => "", destpage => "", template => $template);
  1525. });
  1526. return $template->output;
  1527. }
  1528. sub hook (@) {
  1529. my %param=@_;
  1530. if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
  1531. error 'hook requires type, call, and id parameters';
  1532. }
  1533. return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
  1534. $hooks{$param{type}}{$param{id}}=\%param;
  1535. return 1;
  1536. }
  1537. sub run_hooks ($$) {
  1538. # Calls the given sub for each hook of the given type,
  1539. # passing it the hook function to call.
  1540. my $type=shift;
  1541. my $sub=shift;
  1542. if (exists $hooks{$type}) {
  1543. my (@first, @middle, @last);
  1544. foreach my $id (keys %{$hooks{$type}}) {
  1545. if ($hooks{$type}{$id}{first}) {
  1546. push @first, $id;
  1547. }
  1548. elsif ($hooks{$type}{$id}{last}) {
  1549. push @last, $id;
  1550. }
  1551. else {
  1552. push @middle, $id;
  1553. }
  1554. }
  1555. foreach my $id (@first, @middle, @last) {
  1556. $sub->($hooks{$type}{$id}{call});
  1557. }
  1558. }
  1559. return 1;
  1560. }
  1561. sub rcs_update () {
  1562. $hooks{rcs}{rcs_update}{call}->(@_);
  1563. }
  1564. sub rcs_prepedit ($) {
  1565. $hooks{rcs}{rcs_prepedit}{call}->(@_);
  1566. }
  1567. sub rcs_commit ($$$;$$) {
  1568. $hooks{rcs}{rcs_commit}{call}->(@_);
  1569. }
  1570. sub rcs_commit_staged ($$$) {
  1571. $hooks{rcs}{rcs_commit_staged}{call}->(@_);
  1572. }
  1573. sub rcs_add ($) {
  1574. $hooks{rcs}{rcs_add}{call}->(@_);
  1575. }
  1576. sub rcs_remove ($) {
  1577. $hooks{rcs}{rcs_remove}{call}->(@_);
  1578. }
  1579. sub rcs_rename ($$) {
  1580. $hooks{rcs}{rcs_rename}{call}->(@_);
  1581. }
  1582. sub rcs_recentchanges ($) {
  1583. $hooks{rcs}{rcs_recentchanges}{call}->(@_);
  1584. }
  1585. sub rcs_diff ($) {
  1586. $hooks{rcs}{rcs_diff}{call}->(@_);
  1587. }
  1588. sub rcs_getctime ($) {
  1589. $hooks{rcs}{rcs_getctime}{call}->(@_);
  1590. }
  1591. sub rcs_receive () {
  1592. $hooks{rcs}{rcs_receive}{call}->();
  1593. }
  1594. sub add_depends ($$;$) {
  1595. my $page=shift;
  1596. my $pagespec=shift;
  1597. my $deptype=shift || $DEPEND_CONTENT;
  1598. # Is the pagespec a simple page name?
  1599. if ($pagespec =~ /$config{wiki_file_regexp}/ &&
  1600. $pagespec !~ /[\s*?()!]/) {
  1601. $depends_simple{$page}{lc $pagespec} |= $deptype;
  1602. return 1;
  1603. }
  1604. # Add explicit dependencies for influences.
  1605. my $sub=pagespec_translate($pagespec);
  1606. return unless defined $sub;
  1607. foreach my $p (keys %pagesources) {
  1608. my $r=$sub->($p, location => $page);
  1609. my $i=$r->influences;
  1610. foreach my $k (keys %$i) {
  1611. $depends_simple{$page}{lc $k} |= $i->{$k};
  1612. }
  1613. last if $r->influences_static;
  1614. }
  1615. $depends{$page}{$pagespec} |= $deptype;
  1616. return 1;
  1617. }
  1618. sub deptype (@) {
  1619. my $deptype=0;
  1620. foreach my $type (@_) {
  1621. if ($type eq 'presence') {
  1622. $deptype |= $DEPEND_PRESENCE;
  1623. }
  1624. elsif ($type eq 'links') {
  1625. $deptype |= $DEPEND_LINKS;
  1626. }
  1627. elsif ($type eq 'content') {
  1628. $deptype |= $DEPEND_CONTENT;
  1629. }
  1630. }
  1631. return $deptype;
  1632. }
  1633. my $file_prune_regexp;
  1634. sub file_pruned ($;$) {
  1635. my $file=shift;
  1636. if (@_) {
  1637. require File::Spec;
  1638. $file=File::Spec->canonpath($file);
  1639. my $base=File::Spec->canonpath(shift);
  1640. return if $file eq $base;
  1641. $file =~ s#^\Q$base\E/+##;
  1642. }
  1643. if (defined $config{include} && length $config{include}) {
  1644. return 0 if $file =~ m/$config{include}/;
  1645. }
  1646. if (! defined $file_prune_regexp) {
  1647. $file_prune_regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
  1648. $file_prune_regexp=qr/$file_prune_regexp/;
  1649. }
  1650. return $file =~ m/$file_prune_regexp/;
  1651. }
  1652. sub define_gettext () {
  1653. # If translation is needed, redefine the gettext function to do it.
  1654. # Otherwise, it becomes a quick no-op.
  1655. my $gettext_obj;
  1656. my $getobj;
  1657. if ((exists $ENV{LANG} && length $ENV{LANG}) ||
  1658. (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
  1659. (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
  1660. $getobj=sub {
  1661. $gettext_obj=eval q{
  1662. use Locale::gettext q{textdomain};
  1663. Locale::gettext->domain('ikiwiki')
  1664. };
  1665. };
  1666. }
  1667. no warnings 'redefine';
  1668. *gettext=sub {
  1669. $getobj->() if $getobj;
  1670. if ($gettext_obj) {
  1671. $gettext_obj->get(shift);
  1672. }
  1673. else {
  1674. return shift;
  1675. }
  1676. };
  1677. *ngettext=sub {
  1678. $getobj->() if $getobj;
  1679. if ($gettext_obj) {
  1680. $gettext_obj->nget(@_);
  1681. }
  1682. else {
  1683. return ($_[2] == 1 ? $_[0] : $_[1])
  1684. }
  1685. };
  1686. }
  1687. sub gettext {
  1688. define_gettext();
  1689. gettext(@_);
  1690. }
  1691. sub ngettext {
  1692. define_gettext();
  1693. ngettext(@_);
  1694. }
  1695. sub yesno ($) {
  1696. my $val=shift;
  1697. return (defined $val && (lc($val) eq gettext("yes") || lc($val) eq "yes" || $val eq "1"));
  1698. }
  1699. sub inject {
  1700. # Injects a new function into the symbol table to replace an
  1701. # exported function.
  1702. my %params=@_;
  1703. # This is deep ugly perl foo, beware.
  1704. no strict;
  1705. no warnings;
  1706. if (! defined $params{parent}) {
  1707. $params{parent}='::';
  1708. $params{old}=\&{$params{name}};
  1709. $params{name}=~s/.*:://;
  1710. }
  1711. my $parent=$params{parent};
  1712. foreach my $ns (grep /^\w+::/, keys %{$parent}) {
  1713. $ns = $params{parent} . $ns;
  1714. inject(%params, parent => $ns) unless $ns eq '::main::';
  1715. *{$ns . $params{name}} = $params{call}
  1716. if exists ${$ns}{$params{name}} &&
  1717. \&{${$ns}{$params{name}}} == $params{old};
  1718. }
  1719. use strict;
  1720. use warnings;
  1721. }
  1722. sub add_link ($$;$) {
  1723. my $page=shift;
  1724. my $link=shift;
  1725. my $type=shift;
  1726. push @{$links{$page}}, $link
  1727. unless grep { $_ eq $link } @{$links{$page}};
  1728. if (defined $type) {
  1729. $typedlinks{$page}{$type}{$link} = 1;
  1730. }
  1731. }
  1732. sub sortspec_translate ($) {
  1733. my $spec = shift;
  1734. my $code = "";
  1735. my @data;
  1736. while ($spec =~ m{
  1737. \s*
  1738. (-?) # group 1: perhaps negated
  1739. \s*
  1740. ( # group 2: a word
  1741. \w+\([^\)]*\) # command(params)
  1742. |
  1743. [^\s]+ # or anything else
  1744. )
  1745. \s*
  1746. }gx) {
  1747. my $negated = $1;
  1748. my $word = $2;
  1749. my $params = undef;
  1750. if ($word =~ m/^(\w+)\((.*)\)$/) {
  1751. # command with parameters
  1752. $params = $2;
  1753. $word = $1;
  1754. }
  1755. elsif ($word !~ m/^\w+$/) {
  1756. error(sprintf(gettext("invalid sort type %s"), $word));
  1757. }
  1758. if (length $code) {
  1759. $code .= " || ";
  1760. }
  1761. if ($negated) {
  1762. $code .= "-";
  1763. }
  1764. if (exists $IkiWiki::SortSpec::{"cmp_$word"}) {
  1765. if (defined $params) {
  1766. push @data, $params;
  1767. $code .= "IkiWiki::SortSpec::cmp_$word(\$data[$#data])";
  1768. }
  1769. else {
  1770. $code .= "IkiWiki::SortSpec::cmp_$word(undef)";
  1771. }
  1772. }
  1773. else {
  1774. error(sprintf(gettext("unknown sort type %s"), $word));
  1775. }
  1776. }
  1777. if (! length $code) {
  1778. # undefined sorting method... sort arbitrarily
  1779. return sub { 0 };
  1780. }
  1781. no warnings;
  1782. return eval 'sub { '.$code.' }';
  1783. }
  1784. sub pagespec_translate ($) {
  1785. my $spec=shift;
  1786. # Convert spec to perl code.
  1787. my $code="";
  1788. my @data;
  1789. while ($spec=~m{
  1790. \s* # ignore whitespace
  1791. ( # 1: match a single word
  1792. \! # !
  1793. |
  1794. \( # (
  1795. |
  1796. \) # )
  1797. |
  1798. \w+\([^\)]*\) # command(params)
  1799. |
  1800. [^\s()]+ # any other text
  1801. )
  1802. \s* # ignore whitespace
  1803. }gx) {
  1804. my $word=$1;
  1805. if (lc $word eq 'and') {
  1806. $code.=' &';
  1807. }
  1808. elsif (lc $word eq 'or') {
  1809. $code.=' |';
  1810. }
  1811. elsif ($word eq "(" || $word eq ")" || $word eq "!") {
  1812. $code.=' '.$word;
  1813. }
  1814. elsif ($word =~ /^(\w+)\((.*)\)$/) {
  1815. if (exists $IkiWiki::PageSpec::{"match_$1"}) {
  1816. push @data, $2;
  1817. $code.="IkiWiki::PageSpec::match_$1(\$page, \$data[$#data], \@_)";
  1818. }
  1819. else {
  1820. push @data, qq{unknown function in pagespec "$word"};
  1821. $code.="IkiWiki::ErrorReason->new(\$data[$#data])";
  1822. }
  1823. }
  1824. else {
  1825. push @data, $word;
  1826. $code.=" IkiWiki::PageSpec::match_glob(\$page, \$data[$#data], \@_)";
  1827. }
  1828. }
  1829. if (! length $code) {
  1830. $code="IkiWiki::FailReason->new('empty pagespec')";
  1831. }
  1832. no warnings;
  1833. return eval 'sub { my $page=shift; '.$code.' }';
  1834. }
  1835. sub pagespec_match ($$;@) {
  1836. my $page=shift;
  1837. my $spec=shift;
  1838. my @params=@_;
  1839. # Backwards compatability with old calling convention.
  1840. if (@params == 1) {
  1841. unshift @params, 'location';
  1842. }
  1843. my $sub=pagespec_translate($spec);
  1844. return IkiWiki::ErrorReason->new("syntax error in pagespec \"$spec\"")
  1845. if ! defined $sub;
  1846. return $sub->($page, @params);
  1847. }
  1848. sub pagespec_match_list ($$;@) {
  1849. my $page=shift;
  1850. my $pagespec=shift;
  1851. my %params=@_;
  1852. # Backwards compatability with old calling convention.
  1853. if (ref $page) {
  1854. print STDERR "warning: a plugin (".caller().") is using pagespec_match_list in an obsolete way, and needs to be updated\n";
  1855. $params{list}=$page;
  1856. $page=$params{location}; # ugh!
  1857. }
  1858. my $sub=pagespec_translate($pagespec);
  1859. error "syntax error in pagespec \"$pagespec\""
  1860. if ! defined $sub;
  1861. my @candidates;
  1862. if (exists $params{list}) {
  1863. @candidates=exists $params{filter}
  1864. ? grep { ! $params{filter}->($_) } @{$params{list}}
  1865. : @{$params{list}};
  1866. }
  1867. else {
  1868. @candidates=exists $params{filter}
  1869. ? grep { ! $params{filter}->($_) } keys %pagesources
  1870. : keys %pagesources;
  1871. }
  1872. if (defined $params{sort}) {
  1873. @candidates = IkiWiki::SortSpec::sort_pages($params{sort},
  1874. @candidates);
  1875. }
  1876. @candidates=reverse(@candidates) if $params{reverse};
  1877. $depends{$page}{$pagespec} |= ($params{deptype} || $DEPEND_CONTENT);
  1878. # clear params, remainder is passed to pagespec
  1879. my $num=$params{num};
  1880. delete @params{qw{num deptype reverse sort filter list}};
  1881. my @matches;
  1882. my $firstfail;
  1883. my $count=0;
  1884. my $accum=IkiWiki::SuccessReason->new();
  1885. foreach my $p (@candidates) {
  1886. my $r=$sub->($p, %params, location => $page);
  1887. error(sprintf(gettext("cannot match pages: %s"), $r))
  1888. if $r->isa("IkiWiki::ErrorReason");
  1889. $accum |= $r;
  1890. if ($r) {
  1891. push @matches, $p;
  1892. last if defined $num && ++$count == $num;
  1893. }
  1894. }
  1895. # Add simple dependencies for accumulated influences.
  1896. my $i=$accum->influences;
  1897. foreach my $k (keys %$i) {
  1898. $depends_simple{$page}{lc $k} |= $i->{$k};
  1899. }
  1900. return @matches;
  1901. }
  1902. sub pagespec_valid ($) {
  1903. my $spec=shift;
  1904. return defined pagespec_translate($spec);
  1905. }
  1906. sub glob2re ($) {
  1907. my $re=quotemeta(shift);
  1908. $re=~s/\\\*/.*/g;
  1909. $re=~s/\\\?/./g;
  1910. return $re;
  1911. }
  1912. package IkiWiki::FailReason;
  1913. use overload (
  1914. '""' => sub { $_[0][0] },
  1915. '0+' => sub { 0 },
  1916. '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
  1917. '&' => sub { $_[0]->merge_influences($_[1], 1); $_[0] },
  1918. '|' => sub { $_[1]->merge_influences($_[0]); $_[1] },
  1919. fallback => 1,
  1920. );
  1921. our @ISA = 'IkiWiki::SuccessReason';
  1922. package IkiWiki::SuccessReason;
  1923. use overload (
  1924. '""' => sub { $_[0][0] },
  1925. '0+' => sub { 1 },
  1926. '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
  1927. '&' => sub { $_[1]->merge_influences($_[0], 1); $_[1] },
  1928. '|' => sub { $_[0]->merge_influences($_[1]); $_[0] },
  1929. fallback => 1,
  1930. );
  1931. sub new {
  1932. my $class = shift;
  1933. my $value = shift;
  1934. return bless [$value, {@_}], $class;
  1935. }
  1936. sub influences {
  1937. my $this=shift;
  1938. $this->[1]={@_} if @_;
  1939. my %i=%{$this->[1]};
  1940. delete $i{""};
  1941. return \%i;
  1942. }
  1943. sub influences_static {
  1944. return ! $_[0][1]->{""};
  1945. }
  1946. sub merge_influences {
  1947. my $this=shift;
  1948. my $other=shift;
  1949. my $anded=shift;
  1950. if (! $anded || (($this || %{$this->[1]}) &&
  1951. ($other || %{$other->[1]}))) {
  1952. foreach my $influence (keys %{$other->[1]}) {
  1953. $this->[1]{$influence} |= $other->[1]{$influence};
  1954. }
  1955. }
  1956. else {
  1957. # influence blocker
  1958. $this->[1]={};
  1959. }
  1960. }
  1961. package IkiWiki::ErrorReason;
  1962. our @ISA = 'IkiWiki::FailReason';
  1963. package IkiWiki::PageSpec;
  1964. sub derel ($$) {
  1965. my $path=shift;
  1966. my $from=shift;
  1967. if ($path =~ m!^\./!) {
  1968. $from=~s#/?[^/]+$## if defined $from;
  1969. $path=~s#^\./##;
  1970. $path="$from/$path" if length $from;
  1971. }
  1972. return $path;
  1973. }
  1974. sub match_glob ($$;@) {
  1975. my $page=shift;
  1976. my $glob=shift;
  1977. my %params=@_;
  1978. $glob=derel($glob, $params{location});
  1979. my $regexp=IkiWiki::glob2re($glob);
  1980. if ($page=~/^$regexp$/i) {
  1981. if (! IkiWiki::isinternal($page) || $params{internal}) {
  1982. return IkiWiki::SuccessReason->new("$glob matches $page");
  1983. }
  1984. else {
  1985. return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
  1986. }
  1987. }
  1988. else {
  1989. return IkiWiki::FailReason->new("$glob does not match $page");
  1990. }
  1991. }
  1992. sub match_internal ($$;@) {
  1993. return match_glob($_[0], $_[1], @_, internal => 1)
  1994. }
  1995. sub match_link ($$;@) {
  1996. my $page=shift;
  1997. my $link=lc(shift);
  1998. my %params=@_;
  1999. $link=derel($link, $params{location});
  2000. my $from=exists $params{location} ? $params{location} : '';
  2001. my $linktype=$params{linktype};
  2002. my $qualifier='';
  2003. if (defined $linktype) {
  2004. $qualifier=" with type $linktype";
  2005. }
  2006. my $links = $IkiWiki::links{$page};
  2007. return IkiWiki::FailReason->new("$page has no links", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
  2008. unless $links && @{$links};
  2009. my $bestlink = IkiWiki::bestlink($from, $link);
  2010. foreach my $p (@{$links}) {
  2011. if (length $bestlink) {
  2012. if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p}) && $bestlink eq IkiWiki::bestlink($page, $p)) {
  2013. return IkiWiki::SuccessReason->new("$page links to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
  2014. }
  2015. }
  2016. else {
  2017. if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p}) && match_glob($p, $link, %params)) {
  2018. return IkiWiki::SuccessReason->new("$page links to page $p$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
  2019. }
  2020. my ($p_rel)=$p=~/^\/?(.*)/;
  2021. $link=~s/^\///;
  2022. if ((!defined $linktype || exists $IkiWiki::typedlinks{$page}{$linktype}{$p_rel}) && match_glob($p_rel, $link, %params)) {
  2023. return IkiWiki::SuccessReason->new("$page links to page $p_rel$qualifier, matching $link", $page => $IkiWiki::DEPEND_LINKS, "" => 1)
  2024. }
  2025. }
  2026. }
  2027. return IkiWiki::FailReason->new("$page does not link to $link$qualifier", $page => $IkiWiki::DEPEND_LINKS, "" => 1);
  2028. }
  2029. sub match_backlink ($$;@) {
  2030. my $ret=match_link($_[1], $_[0], @_);
  2031. $ret->influences($_[1] => $IkiWiki::DEPEND_LINKS);
  2032. return $ret;
  2033. }
  2034. sub match_created_before ($$;@) {
  2035. my $page=shift;
  2036. my $testpage=shift;
  2037. my %params=@_;
  2038. $testpage=derel($testpage, $params{location});
  2039. if (exists $IkiWiki::pagectime{$testpage}) {
  2040. if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
  2041. return IkiWiki::SuccessReason->new("$page created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
  2042. }
  2043. else {
  2044. return IkiWiki::FailReason->new("$page not created before $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
  2045. }
  2046. }
  2047. else {
  2048. return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
  2049. }
  2050. }
  2051. sub match_created_after ($$;@) {
  2052. my $page=shift;
  2053. my $testpage=shift;
  2054. my %params=@_;
  2055. $testpage=derel($testpage, $params{location});
  2056. if (exists $IkiWiki::pagectime{$testpage}) {
  2057. if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
  2058. return IkiWiki::SuccessReason->new("$page created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
  2059. }
  2060. else {
  2061. return IkiWiki::FailReason->new("$page not created after $testpage", $testpage => $IkiWiki::DEPEND_PRESENCE);
  2062. }
  2063. }
  2064. else {
  2065. return IkiWiki::ErrorReason->new("$testpage does not exist", $testpage => $IkiWiki::DEPEND_PRESENCE);
  2066. }
  2067. }
  2068. sub match_creation_day ($$;@) {
  2069. if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
  2070. return IkiWiki::SuccessReason->new('creation_day matched');
  2071. }
  2072. else {
  2073. return IkiWiki::FailReason->new('creation_day did not match');
  2074. }
  2075. }
  2076. sub match_creation_month ($$;@) {
  2077. if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
  2078. return IkiWiki::SuccessReason->new('creation_month matched');
  2079. }
  2080. else {
  2081. return IkiWiki::FailReason->new('creation_month did not match');
  2082. }
  2083. }
  2084. sub match_creation_year ($$;@) {
  2085. if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
  2086. return IkiWiki::SuccessReason->new('creation_year matched');
  2087. }
  2088. else {
  2089. return IkiWiki::FailReason->new('creation_year did not match');
  2090. }
  2091. }
  2092. sub match_user ($$;@) {
  2093. shift;
  2094. my $user=shift;
  2095. my %params=@_;
  2096. my $regexp=IkiWiki::glob2re($user);
  2097. if (! exists $params{user}) {
  2098. return IkiWiki::ErrorReason->new("no user specified");
  2099. }
  2100. if (defined $params{user} && $params{user}=~/^$regexp$/i) {
  2101. return IkiWiki::SuccessReason->new("user is $user");
  2102. }
  2103. elsif (! defined $params{user}) {
  2104. return IkiWiki::FailReason->new("not logged in");
  2105. }
  2106. else {
  2107. return IkiWiki::FailReason->new("user is $params{user}, not $user");
  2108. }
  2109. }
  2110. sub match_admin ($$;@) {
  2111. shift;
  2112. shift;
  2113. my %params=@_;
  2114. if (! exists $params{user}) {
  2115. return IkiWiki::ErrorReason->new("no user specified");
  2116. }
  2117. if (defined $params{user} && IkiWiki::is_admin($params{user})) {
  2118. return IkiWiki::SuccessReason->new("user is an admin");
  2119. }
  2120. elsif (! defined $params{user}) {
  2121. return IkiWiki::FailReason->new("not logged in");
  2122. }
  2123. else {
  2124. return IkiWiki::FailReason->new("user is not an admin");
  2125. }
  2126. }
  2127. sub match_ip ($$;@) {
  2128. shift;
  2129. my $ip=shift;
  2130. my %params=@_;
  2131. if (! exists $params{ip}) {
  2132. return IkiWiki::ErrorReason->new("no IP specified");
  2133. }
  2134. if (defined $params{ip} && lc $params{ip} eq lc $ip) {
  2135. return IkiWiki::SuccessReason->new("IP is $ip");
  2136. }
  2137. else {
  2138. return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
  2139. }
  2140. }
  2141. package IkiWiki::SortSpec;
  2142. # This is in the SortSpec namespace so that the $a and $b that sort() uses
  2143. # are easily available in this namespace, for cmp functions to use them.
  2144. sub sort_pages {
  2145. my $f = IkiWiki::sortspec_translate(shift);
  2146. return sort $f @_;
  2147. }
  2148. sub cmp_title {
  2149. IkiWiki::pagetitle(IkiWiki::basename($a))
  2150. cmp
  2151. IkiWiki::pagetitle(IkiWiki::basename($b))
  2152. }
  2153. sub cmp_mtime { $IkiWiki::pagemtime{$b} <=> $IkiWiki::pagemtime{$a} }
  2154. sub cmp_age { $IkiWiki::pagectime{$b} <=> $IkiWiki::pagectime{$a} }
  2155. 1