summaryrefslogtreecommitdiff
path: root/IkiWiki.pm
blob: 28ee882cf20d99b30059cf195ca8f70881de932d (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 %hooks %forcerebuild
  14. $gettext_obj %loaded_plugins};
  15. use Exporter q{import};
  16. our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
  17. bestlink htmllink readfile writefile pagetype srcfile pagename
  18. displaytime will_render gettext urlto targetpage
  19. add_underlay pagetitle titlepage linkpage newpagefile
  20. %config %links %pagestate %wikistate %renderedfiles
  21. %pagesources %destsources);
  22. our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
  23. our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
  24. my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
  25. # Optimisation.
  26. use Memoize;
  27. memoize("abs2rel");
  28. memoize("pagespec_translate");
  29. memoize("file_pruned");
  30. sub getsetup () { #{{{
  31. wikiname => {
  32. type => "string",
  33. default => "wiki",
  34. description => "name of the wiki",
  35. safe => 1,
  36. rebuild => 1,
  37. },
  38. adminemail => {
  39. type => "string",
  40. default => undef,
  41. example => 'me@example.com',
  42. description => "contact email for wiki",
  43. safe => 1,
  44. rebuild => 0,
  45. },
  46. adminuser => {
  47. type => "string",
  48. default => [],
  49. description => "users who are wiki admins",
  50. safe => 1,
  51. rebuild => 0,
  52. },
  53. banned_users => {
  54. type => "string",
  55. default => [],
  56. description => "users who are banned from the wiki",
  57. safe => 1,
  58. rebuild => 0,
  59. },
  60. srcdir => {
  61. type => "string",
  62. default => undef,
  63. example => "$ENV{HOME}/wiki",
  64. description => "where the source of the wiki is located",
  65. safe => 0, # path
  66. rebuild => 1,
  67. },
  68. destdir => {
  69. type => "string",
  70. default => undef,
  71. example => "/var/www/wiki",
  72. description => "where to build the wiki",
  73. safe => 0, # path
  74. rebuild => 1,
  75. },
  76. url => {
  77. type => "string",
  78. default => '',
  79. example => "http://example.com/wiki",
  80. description => "base url to the wiki",
  81. safe => 1,
  82. rebuild => 1,
  83. },
  84. cgiurl => {
  85. type => "string",
  86. default => '',
  87. example => "http://example.com/wiki/ikiwiki.cgi",
  88. description => "url to the ikiwiki.cgi",
  89. safe => 1,
  90. rebuild => 1,
  91. },
  92. cgi_wrapper => {
  93. type => "string",
  94. default => '',
  95. example => "/var/www/wiki/ikiwiki.cgi",
  96. description => "cgi wrapper to generate",
  97. safe => 0, # file
  98. rebuild => 0,
  99. },
  100. cgi_wrappermode => {
  101. type => "string",
  102. default => '06755',
  103. description => "mode for cgi_wrapper (can safely be made suid)",
  104. safe => 0,
  105. rebuild => 0,
  106. },
  107. rcs => {
  108. type => "string",
  109. default => '',
  110. description => "rcs backend to use",
  111. safe => 0, # don't allow overriding
  112. rebuild => 0,
  113. },
  114. default_plugins => {
  115. type => "internal",
  116. default => [qw{mdwn link inline htmlscrubber passwordauth
  117. openid signinedit lockedit conditional
  118. recentchanges parentlinks editpage}],
  119. description => "plugins to enable by default",
  120. safe => 0,
  121. rebuild => 1,
  122. },
  123. add_plugins => {
  124. type => "string",
  125. default => [],
  126. description => "plugins to add to the default configuration",
  127. safe => 1,
  128. rebuild => 1,
  129. },
  130. disable_plugins => {
  131. type => "string",
  132. default => [],
  133. description => "plugins to disable",
  134. safe => 1,
  135. rebuild => 1,
  136. },
  137. templatedir => {
  138. type => "string",
  139. default => "$installdir/share/ikiwiki/templates",
  140. description => "location of template files",
  141. advanced => 1,
  142. safe => 0, # path
  143. rebuild => 1,
  144. },
  145. underlaydir => {
  146. type => "string",
  147. default => "$installdir/share/ikiwiki/basewiki",
  148. description => "base wiki source location",
  149. advanced => 1,
  150. safe => 0, # path
  151. rebuild => 0,
  152. },
  153. wrappers => {
  154. type => "internal",
  155. default => [],
  156. description => "wrappers to generate",
  157. safe => 0,
  158. rebuild => 0,
  159. },
  160. underlaydirs => {
  161. type => "internal",
  162. default => [],
  163. description => "additional underlays to use",
  164. safe => 0,
  165. rebuild => 0,
  166. },
  167. verbose => {
  168. type => "boolean",
  169. example => 1,
  170. description => "display verbose messages when building?",
  171. safe => 1,
  172. rebuild => 0,
  173. },
  174. syslog => {
  175. type => "boolean",
  176. example => 1,
  177. description => "log to syslog?",
  178. safe => 1,
  179. rebuild => 0,
  180. },
  181. usedirs => {
  182. type => "boolean",
  183. default => 1,
  184. description => "create output files named page/index.html?",
  185. safe => 0, # changing requires manual transition
  186. rebuild => 1,
  187. },
  188. prefix_directives => {
  189. type => "boolean",
  190. default => 0,
  191. description => "use '!'-prefixed preprocessor directives?",
  192. safe => 0, # changing requires manual transition
  193. rebuild => 1,
  194. },
  195. indexpages => {
  196. type => "boolean",
  197. default => 0,
  198. description => "use page/index.mdwn source files",
  199. safe => 1,
  200. rebuild => 1,
  201. },
  202. discussion => {
  203. type => "boolean",
  204. default => 1,
  205. description => "enable Discussion pages?",
  206. safe => 1,
  207. rebuild => 1,
  208. },
  209. sslcookie => {
  210. type => "boolean",
  211. default => 0,
  212. description => "only send cookies over SSL connections?",
  213. advanced => 1,
  214. safe => 1,
  215. rebuild => 0,
  216. },
  217. default_pageext => {
  218. type => "string",
  219. default => "mdwn",
  220. description => "extension to use for new pages",
  221. safe => 0, # not sanitized
  222. rebuild => 0,
  223. },
  224. htmlext => {
  225. type => "string",
  226. default => "html",
  227. description => "extension to use for html files",
  228. safe => 0, # not sanitized
  229. rebuild => 1,
  230. },
  231. timeformat => {
  232. type => "string",
  233. default => '%c',
  234. description => "strftime format string to display date",
  235. advanced => 1,
  236. safe => 1,
  237. rebuild => 1,
  238. },
  239. locale => {
  240. type => "string",
  241. default => undef,
  242. example => "en_US.UTF-8",
  243. description => "UTF-8 locale to use",
  244. advanced => 1,
  245. safe => 0,
  246. rebuild => 1,
  247. },
  248. userdir => {
  249. type => "string",
  250. default => "",
  251. example => "users",
  252. description => "put user pages below specified page",
  253. safe => 1,
  254. rebuild => 1,
  255. },
  256. numbacklinks => {
  257. type => "integer",
  258. default => 10,
  259. description => "how many backlinks to show before hiding excess (0 to show all)",
  260. safe => 1,
  261. rebuild => 1,
  262. },
  263. hardlink => {
  264. type => "boolean",
  265. default => 0,
  266. description => "attempt to hardlink source files? (optimisation for large files)",
  267. advanced => 1,
  268. safe => 0, # paranoia
  269. rebuild => 0,
  270. },
  271. umask => {
  272. type => "integer",
  273. description => "",
  274. example => "022",
  275. description => "force ikiwiki to use a particular umask",
  276. advanced => 1,
  277. safe => 0, # paranoia
  278. rebuild => 0,
  279. },
  280. libdir => {
  281. type => "string",
  282. default => "",
  283. example => "$ENV{HOME}/.ikiwiki/",
  284. description => "extra library and plugin directory",
  285. advanced => 1,
  286. safe => 0, # directory
  287. rebuild => 0,
  288. },
  289. ENV => {
  290. type => "string",
  291. default => {},
  292. description => "environment variables",
  293. safe => 0, # paranoia
  294. rebuild => 0,
  295. },
  296. exclude => {
  297. type => "string",
  298. default => undef,
  299. example => '\.wav$',
  300. description => "regexp of source files to ignore",
  301. advanced => 1,
  302. safe => 0, # regexp
  303. rebuild => 1,
  304. },
  305. wiki_file_prune_regexps => {
  306. type => "internal",
  307. default => [qr/(^|\/)\.\.(\/|$)/, qr/^\./, qr/\/\./,
  308. qr/\.x?html?$/, qr/\.ikiwiki-new$/,
  309. qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
  310. qr/(^|\/)_MTN\//,
  311. qr/\.dpkg-tmp$/],
  312. description => "regexps of source files to ignore",
  313. safe => 0,
  314. rebuild => 1,
  315. },
  316. wiki_file_chars => {
  317. type => "string",
  318. description => "specifies the characters that are allowed in source filenames",
  319. default => "-[:alnum:]+/.:_",
  320. safe => 0,
  321. rebuild => 1,
  322. },
  323. wiki_file_regexp => {
  324. type => "internal",
  325. description => "regexp of legal source files",
  326. safe => 0,
  327. rebuild => 1,
  328. },
  329. web_commit_regexp => {
  330. type => "internal",
  331. default => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
  332. description => "regexp to parse web commits from logs",
  333. safe => 0,
  334. rebuild => 0,
  335. },
  336. cgi => {
  337. type => "internal",
  338. default => 0,
  339. description => "run as a cgi",
  340. safe => 0,
  341. rebuild => 0,
  342. },
  343. cgi_disable_uploads => {
  344. type => "internal",
  345. default => 1,
  346. description => "whether CGI should accept file uploads",
  347. safe => 0,
  348. rebuild => 0,
  349. },
  350. post_commit => {
  351. type => "internal",
  352. default => 0,
  353. description => "run as a post-commit hook",
  354. safe => 0,
  355. rebuild => 0,
  356. },
  357. rebuild => {
  358. type => "internal",
  359. default => 0,
  360. description => "running in rebuild mode",
  361. safe => 0,
  362. rebuild => 0,
  363. },
  364. setup => {
  365. type => "internal",
  366. default => undef,
  367. description => "running in setup mode",
  368. safe => 0,
  369. rebuild => 0,
  370. },
  371. refresh => {
  372. type => "internal",
  373. default => 0,
  374. description => "running in refresh mode",
  375. safe => 0,
  376. rebuild => 0,
  377. },
  378. getctime => {
  379. type => "internal",
  380. default => 0,
  381. description => "running in getctime mode",
  382. safe => 0,
  383. rebuild => 0,
  384. },
  385. w3mmode => {
  386. type => "internal",
  387. default => 0,
  388. description => "running in w3mmode",
  389. safe => 0,
  390. rebuild => 0,
  391. },
  392. setupfile => {
  393. type => "internal",
  394. default => undef,
  395. description => "path to setup file",
  396. safe => 0,
  397. rebuild => 0,
  398. },
  399. allow_symlinks_before_srcdir => {
  400. type => "string",
  401. default => 0,
  402. description => "allow symlinks in the path leading to the srcdir (potentially insecure)",
  403. safe => 0,
  404. rebuild => 0,
  405. },
  406. } #}}}
  407. sub defaultconfig () { #{{{
  408. my %s=getsetup();
  409. my @ret;
  410. foreach my $key (keys %s) {
  411. push @ret, $key, $s{$key}->{default};
  412. }
  413. use Data::Dumper;
  414. return @ret;
  415. } #}}}
  416. sub checkconfig () { #{{{
  417. # locale stuff; avoid LC_ALL since it overrides everything
  418. if (defined $ENV{LC_ALL}) {
  419. $ENV{LANG} = $ENV{LC_ALL};
  420. delete $ENV{LC_ALL};
  421. }
  422. if (defined $config{locale}) {
  423. if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
  424. $ENV{LANG}=$config{locale};
  425. $gettext_obj=undef;
  426. }
  427. }
  428. if (! defined $config{wiki_file_regexp}) {
  429. $config{wiki_file_regexp}=qr/(^[$config{wiki_file_chars}]+$)/;
  430. }
  431. if (ref $config{ENV} eq 'HASH') {
  432. foreach my $val (keys %{$config{ENV}}) {
  433. $ENV{$val}=$config{ENV}{$val};
  434. }
  435. }
  436. if ($config{w3mmode}) {
  437. eval q{use Cwd q{abs_path}};
  438. error($@) if $@;
  439. $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
  440. $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
  441. $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
  442. unless $config{cgiurl} =~ m!file:///!;
  443. $config{url}="file://".$config{destdir};
  444. }
  445. if ($config{cgi} && ! length $config{url}) {
  446. error(gettext("Must specify url to wiki with --url when using --cgi"));
  447. }
  448. $config{wikistatedir}="$config{srcdir}/.ikiwiki"
  449. unless exists $config{wikistatedir};
  450. if (defined $config{umask}) {
  451. umask(possibly_foolish_untaint($config{umask}));
  452. }
  453. run_hooks(checkconfig => sub { shift->() });
  454. return 1;
  455. } #}}}
  456. sub listplugins () { #{{{
  457. my %ret;
  458. foreach my $dir (@INC, $config{libdir}) {
  459. next unless defined $dir && length $dir;
  460. foreach my $file (glob("$dir/IkiWiki/Plugin/*.pm")) {
  461. my ($plugin)=$file=~/.*\/(.*)\.pm$/;
  462. $ret{$plugin}=1;
  463. }
  464. }
  465. foreach my $dir ($config{libdir}, "$installdir/lib/ikiwiki") {
  466. next unless defined $dir && length $dir;
  467. foreach my $file (glob("$dir/plugins/*")) {
  468. $ret{basename($file)}=1 if -x $file;
  469. }
  470. }
  471. return keys %ret;
  472. } #}}}
  473. sub loadplugins () { #{{{
  474. if (defined $config{libdir} && length $config{libdir}) {
  475. unshift @INC, possibly_foolish_untaint($config{libdir});
  476. }
  477. foreach my $plugin (@{$config{default_plugins}}, @{$config{add_plugins}}) {
  478. loadplugin($plugin);
  479. }
  480. if ($config{rcs}) {
  481. if (exists $IkiWiki::hooks{rcs}) {
  482. error(gettext("cannot use multiple rcs plugins"));
  483. }
  484. loadplugin($config{rcs});
  485. }
  486. if (! exists $IkiWiki::hooks{rcs}) {
  487. loadplugin("norcs");
  488. }
  489. run_hooks(getopt => sub { shift->() });
  490. if (grep /^-/, @ARGV) {
  491. print STDERR "Unknown option: $_\n"
  492. foreach grep /^-/, @ARGV;
  493. usage();
  494. }
  495. return 1;
  496. } #}}}
  497. sub loadplugin ($) { #{{{
  498. my $plugin=shift;
  499. return if grep { $_ eq $plugin} @{$config{disable_plugins}};
  500. foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
  501. "$installdir/lib/ikiwiki") {
  502. if (defined $dir && -x "$dir/plugins/$plugin") {
  503. eval { require IkiWiki::Plugin::external };
  504. if ($@) {
  505. my $reason=$@;
  506. error(sprintf(gettext("failed to load external plugin needed for %s plugin: %s"), $plugin, $reason));
  507. }
  508. import IkiWiki::Plugin::external "$dir/plugins/$plugin";
  509. $loaded_plugins{$plugin}=1;
  510. return 1;
  511. }
  512. }
  513. my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
  514. eval qq{use $mod};
  515. if ($@) {
  516. error("Failed to load plugin $mod: $@");
  517. }
  518. $loaded_plugins{$plugin}=1;
  519. return 1;
  520. } #}}}
  521. sub error ($;$) { #{{{
  522. my $message=shift;
  523. my $cleaner=shift;
  524. log_message('err' => $message) if $config{syslog};
  525. if (defined $cleaner) {
  526. $cleaner->();
  527. }
  528. die $message."\n";
  529. } #}}}
  530. sub debug ($) { #{{{
  531. return unless $config{verbose};
  532. return log_message(debug => @_);
  533. } #}}}
  534. my $log_open=0;
  535. sub log_message ($$) { #{{{
  536. my $type=shift;
  537. if ($config{syslog}) {
  538. require Sys::Syslog;
  539. if (! $log_open) {
  540. Sys::Syslog::setlogsock('unix');
  541. Sys::Syslog::openlog('ikiwiki', '', 'user');
  542. $log_open=1;
  543. }
  544. return eval {
  545. Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
  546. };
  547. }
  548. elsif (! $config{cgi}) {
  549. return print "@_\n";
  550. }
  551. else {
  552. return print STDERR "@_\n";
  553. }
  554. } #}}}
  555. sub possibly_foolish_untaint ($) { #{{{
  556. my $tainted=shift;
  557. my ($untainted)=$tainted=~/(.*)/s;
  558. return $untainted;
  559. } #}}}
  560. sub basename ($) { #{{{
  561. my $file=shift;
  562. $file=~s!.*/+!!;
  563. return $file;
  564. } #}}}
  565. sub dirname ($) { #{{{
  566. my $file=shift;
  567. $file=~s!/*[^/]+$!!;
  568. return $file;
  569. } #}}}
  570. sub pagetype ($) { #{{{
  571. my $page=shift;
  572. if ($page =~ /\.([^.]+)$/) {
  573. return $1 if exists $hooks{htmlize}{$1};
  574. }
  575. return;
  576. } #}}}
  577. sub isinternal ($) { #{{{
  578. my $page=shift;
  579. return exists $pagesources{$page} &&
  580. $pagesources{$page} =~ /\._([^.]+)$/;
  581. } #}}}
  582. sub pagename ($) { #{{{
  583. my $file=shift;
  584. my $type=pagetype($file);
  585. my $page=$file;
  586. $page=~s/\Q.$type\E*$// if defined $type && !$hooks{htmlize}{$type}{keepextension};
  587. if ($config{indexpages} && $page=~/(.*)\/index$/) {
  588. $page=$1;
  589. }
  590. return $page;
  591. } #}}}
  592. sub newpagefile ($$) { #{{{
  593. my $page=shift;
  594. my $type=shift;
  595. if (! $config{indexpages} || $page eq 'index') {
  596. return $page.".".$type;
  597. }
  598. else {
  599. return $page."/index.".$type;
  600. }
  601. } #}}}
  602. sub targetpage ($$) { #{{{
  603. my $page=shift;
  604. my $ext=shift;
  605. my $targetpage='';
  606. run_hooks(targetpage => sub {
  607. $targetpage=shift->(
  608. page => $page,
  609. ext => $ext,
  610. );
  611. });
  612. if (defined $targetpage && (length($targetpage) > 0)) {
  613. return $targetpage;
  614. }
  615. elsif (! $config{usedirs} || $page eq 'index') {
  616. return $page.".".$ext;
  617. }
  618. else {
  619. return $page."/index.".$ext;
  620. }
  621. } #}}}
  622. sub htmlpage ($) { #{{{
  623. my $page=shift;
  624. return targetpage($page, $config{htmlext});
  625. } #}}}
  626. sub srcfile_stat { #{{{
  627. my $file=shift;
  628. my $nothrow=shift;
  629. return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
  630. foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
  631. return "$dir/$file", stat(_) if -e "$dir/$file";
  632. }
  633. error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
  634. return;
  635. } #}}}
  636. sub srcfile ($;$) { #{{{
  637. return (srcfile_stat(@_))[0];
  638. } #}}}
  639. sub add_underlay ($) { #{{{
  640. my $dir=shift;
  641. if ($dir !~ /^\//) {
  642. $dir="$config{underlaydir}/../$dir";
  643. }
  644. if (! grep { $_ eq $dir } @{$config{underlaydirs}}) {
  645. unshift @{$config{underlaydirs}}, $dir;
  646. }
  647. return 1;
  648. } #}}}
  649. sub readfile ($;$$) { #{{{
  650. my $file=shift;
  651. my $binary=shift;
  652. my $wantfd=shift;
  653. if (-l $file) {
  654. error("cannot read a symlink ($file)");
  655. }
  656. local $/=undef;
  657. open (my $in, "<", $file) || error("failed to read $file: $!");
  658. binmode($in) if ($binary);
  659. return \*$in if $wantfd;
  660. my $ret=<$in>;
  661. close $in || error("failed to read $file: $!");
  662. return $ret;
  663. } #}}}
  664. sub prep_writefile ($$) { #{{{
  665. my $file=shift;
  666. my $destdir=shift;
  667. my $test=$file;
  668. while (length $test) {
  669. if (-l "$destdir/$test") {
  670. error("cannot write to a symlink ($test)");
  671. }
  672. $test=dirname($test);
  673. }
  674. my $dir=dirname("$destdir/$file");
  675. if (! -d $dir) {
  676. my $d="";
  677. foreach my $s (split(m!/+!, $dir)) {
  678. $d.="$s/";
  679. if (! -d $d) {
  680. mkdir($d) || error("failed to create directory $d: $!");
  681. }
  682. }
  683. }
  684. return 1;
  685. } #}}}
  686. sub writefile ($$$;$$) { #{{{
  687. my $file=shift; # can include subdirs
  688. my $destdir=shift; # directory to put file in
  689. my $content=shift;
  690. my $binary=shift;
  691. my $writer=shift;
  692. prep_writefile($file, $destdir);
  693. my $newfile="$destdir/$file.ikiwiki-new";
  694. if (-l $newfile) {
  695. error("cannot write to a symlink ($newfile)");
  696. }
  697. my $cleanup = sub { unlink($newfile) };
  698. open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
  699. binmode($out) if ($binary);
  700. if ($writer) {
  701. $writer->(\*$out, $cleanup);
  702. }
  703. else {
  704. print $out $content or error("failed writing to $newfile: $!", $cleanup);
  705. }
  706. close $out || error("failed saving $newfile: $!", $cleanup);
  707. rename($newfile, "$destdir/$file") ||
  708. error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
  709. return 1;
  710. } #}}}
  711. my %cleared;
  712. sub will_render ($$;$) { #{{{
  713. my $page=shift;
  714. my $dest=shift;
  715. my $clear=shift;
  716. # Important security check.
  717. if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
  718. ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
  719. error("$config{destdir}/$dest independently created, not overwriting with version from $page");
  720. }
  721. if (! $clear || $cleared{$page}) {
  722. $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
  723. }
  724. else {
  725. foreach my $old (@{$renderedfiles{$page}}) {
  726. delete $destsources{$old};
  727. }
  728. $renderedfiles{$page}=[$dest];
  729. $cleared{$page}=1;
  730. }
  731. $destsources{$dest}=$page;
  732. return 1;
  733. } #}}}
  734. sub bestlink ($$) { #{{{
  735. my $page=shift;
  736. my $link=shift;
  737. my $cwd=$page;
  738. if ($link=~s/^\/+//) {
  739. # absolute links
  740. $cwd="";
  741. }
  742. $link=~s/\/$//;
  743. do {
  744. my $l=$cwd;
  745. $l.="/" if length $l;
  746. $l.=$link;
  747. if (exists $links{$l}) {
  748. return $l;
  749. }
  750. elsif (exists $pagecase{lc $l}) {
  751. return $pagecase{lc $l};
  752. }
  753. } while $cwd=~s{/?[^/]+$}{};
  754. if (length $config{userdir}) {
  755. my $l = "$config{userdir}/".lc($link);
  756. if (exists $links{$l}) {
  757. return $l;
  758. }
  759. elsif (exists $pagecase{lc $l}) {
  760. return $pagecase{lc $l};
  761. }
  762. }
  763. #print STDERR "warning: page $page, broken link: $link\n";
  764. return "";
  765. } #}}}
  766. sub isinlinableimage ($) { #{{{
  767. my $file=shift;
  768. return $file =~ /\.(png|gif|jpg|jpeg)$/i;
  769. } #}}}
  770. sub pagetitle ($;$) { #{{{
  771. my $page=shift;
  772. my $unescaped=shift;
  773. if ($unescaped) {
  774. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
  775. }
  776. else {
  777. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
  778. }
  779. return $page;
  780. } #}}}
  781. sub titlepage ($) { #{{{
  782. my $title=shift;
  783. # support use w/o %config set
  784. my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
  785. $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  786. return $title;
  787. } #}}}
  788. sub linkpage ($) { #{{{
  789. my $link=shift;
  790. my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
  791. $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  792. return $link;
  793. } #}}}
  794. sub cgiurl (@) { #{{{
  795. my %params=@_;
  796. return $config{cgiurl}."?".
  797. join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
  798. } #}}}
  799. sub baseurl (;$) { #{{{
  800. my $page=shift;
  801. return "$config{url}/" if ! defined $page;
  802. $page=htmlpage($page);
  803. $page=~s/[^\/]+$//;
  804. $page=~s/[^\/]+\//..\//g;
  805. return $page;
  806. } #}}}
  807. sub abs2rel ($$) { #{{{
  808. # Work around very innefficient behavior in File::Spec if abs2rel
  809. # is passed two relative paths. It's much faster if paths are
  810. # absolute! (Debian bug #376658; fixed in debian unstable now)
  811. my $path="/".shift;
  812. my $base="/".shift;
  813. require File::Spec;
  814. my $ret=File::Spec->abs2rel($path, $base);
  815. $ret=~s/^// if defined $ret;
  816. return $ret;
  817. } #}}}
  818. sub displaytime ($;$) { #{{{
  819. my $time=shift;
  820. my $format=shift;
  821. if (! defined $format) {
  822. $format=$config{timeformat};
  823. }
  824. # strftime doesn't know about encodings, so make sure
  825. # its output is properly treated as utf8
  826. return decode_utf8(POSIX::strftime($format, localtime($time)));
  827. } #}}}
  828. sub beautify_urlpath ($) { #{{{
  829. my $url=shift;
  830. if ($config{usedirs}) {
  831. $url =~ s!/index.$config{htmlext}$!/!;
  832. }
  833. # Ensure url is not an empty link, and
  834. # if it's relative, make that explicit to avoid colon confusion.
  835. if ($url !~ /^\//) {
  836. $url="./$url";
  837. }
  838. return $url;
  839. } #}}}
  840. sub urlto ($$;$) { #{{{
  841. my $to=shift;
  842. my $from=shift;
  843. my $absolute=shift;
  844. if (! length $to) {
  845. return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
  846. }
  847. if (! $destsources{$to}) {
  848. $to=htmlpage($to);
  849. }
  850. if ($absolute) {
  851. return $config{url}.beautify_urlpath("/".$to);
  852. }
  853. my $link = abs2rel($to, dirname(htmlpage($from)));
  854. return beautify_urlpath($link);
  855. } #}}}
  856. sub htmllink ($$$;@) { #{{{
  857. my $lpage=shift; # the page doing the linking
  858. my $page=shift; # the page that will contain the link (different for inline)
  859. my $link=shift;
  860. my %opts=@_;
  861. $link=~s/\/$//;
  862. my $bestlink;
  863. if (! $opts{forcesubpage}) {
  864. $bestlink=bestlink($lpage, $link);
  865. }
  866. else {
  867. $bestlink="$lpage/".lc($link);
  868. }
  869. my $linktext;
  870. if (defined $opts{linktext}) {
  871. $linktext=$opts{linktext};
  872. }
  873. else {
  874. $linktext=pagetitle(basename($link));
  875. }
  876. return "<span class=\"selflink\">$linktext</span>"
  877. if length $bestlink && $page eq $bestlink &&
  878. ! defined $opts{anchor};
  879. if (! $destsources{$bestlink}) {
  880. $bestlink=htmlpage($bestlink);
  881. if (! $destsources{$bestlink}) {
  882. return $linktext unless length $config{cgiurl};
  883. return "<span class=\"createlink\"><a href=\"".
  884. cgiurl(
  885. do => "create",
  886. page => lc($link),
  887. from => $lpage
  888. ).
  889. "\" rel=\"nofollow\">?</a>$linktext</span>"
  890. }
  891. }
  892. $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
  893. $bestlink=beautify_urlpath($bestlink);
  894. if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
  895. return "<img src=\"$bestlink\" alt=\"$linktext\" />";
  896. }
  897. if (defined $opts{anchor}) {
  898. $bestlink.="#".$opts{anchor};
  899. }
  900. my @attrs;
  901. if (defined $opts{rel}) {
  902. push @attrs, ' rel="'.$opts{rel}.'"';
  903. }
  904. if (defined $opts{class}) {
  905. push @attrs, ' class="'.$opts{class}.'"';
  906. }
  907. return "<a href=\"$bestlink\"@attrs>$linktext</a>";
  908. } #}}}
  909. sub userlink ($) { #{{{
  910. my $user=shift;
  911. my $oiduser=eval { openiduser($user) };
  912. if (defined $oiduser) {
  913. return "<a href=\"$user\">$oiduser</a>";
  914. }
  915. else {
  916. eval q{use CGI 'escapeHTML'};
  917. error($@) if $@;
  918. return htmllink("", "", escapeHTML(
  919. length $config{userdir} ? $config{userdir}."/".$user : $user
  920. ), noimageinline => 1);
  921. }
  922. } #}}}
  923. sub htmlize ($$$$) { #{{{
  924. my $page=shift;
  925. my $destpage=shift;
  926. my $type=shift;
  927. my $content=shift;
  928. my $oneline = $content !~ /\n/;
  929. if (exists $hooks{htmlize}{$type}) {
  930. $content=$hooks{htmlize}{$type}{call}->(
  931. page => $page,
  932. content => $content,
  933. );
  934. }
  935. else {
  936. error("htmlization of $type not supported");
  937. }
  938. run_hooks(sanitize => sub {
  939. $content=shift->(
  940. page => $page,
  941. destpage => $destpage,
  942. content => $content,
  943. );
  944. });
  945. if ($oneline) {
  946. # hack to get rid of enclosing junk added by markdown
  947. # and other htmlizers
  948. $content=~s/^<p>//i;
  949. $content=~s/<\/p>$//i;
  950. chomp $content;
  951. }
  952. return $content;
  953. } #}}}
  954. sub linkify ($$$) { #{{{
  955. my $page=shift;
  956. my $destpage=shift;
  957. my $content=shift;
  958. run_hooks(linkify => sub {
  959. $content=shift->(
  960. page => $page,
  961. destpage => $destpage,
  962. content => $content,
  963. );
  964. });
  965. return $content;
  966. } #}}}
  967. our %preprocessing;
  968. our $preprocess_preview=0;
  969. sub preprocess ($$$;$$) { #{{{
  970. my $page=shift; # the page the data comes from
  971. my $destpage=shift; # the page the data will appear in (different for inline)
  972. my $content=shift;
  973. my $scan=shift;
  974. my $preview=shift;
  975. # Using local because it needs to be set within any nested calls
  976. # of this function.
  977. local $preprocess_preview=$preview if defined $preview;
  978. my $handle=sub {
  979. my $escape=shift;
  980. my $prefix=shift;
  981. my $command=shift;
  982. my $params=shift;
  983. $params="" if ! defined $params;
  984. if (length $escape) {
  985. return "[[$prefix$command $params]]";
  986. }
  987. elsif (exists $hooks{preprocess}{$command}) {
  988. return "" if $scan && ! $hooks{preprocess}{$command}{scan};
  989. # Note: preserve order of params, some plugins may
  990. # consider it significant.
  991. my @params;
  992. while ($params =~ m{
  993. (?:([-\w]+)=)? # 1: named parameter key?
  994. (?:
  995. """(.*?)""" # 2: triple-quoted value
  996. |
  997. "([^"]+)" # 3: single-quoted value
  998. |
  999. (\S+) # 4: unquoted value
  1000. )
  1001. (?:\s+|$) # delimiter to next param
  1002. }sgx) {
  1003. my $key=$1;
  1004. my $val;
  1005. if (defined $2) {
  1006. $val=$2;
  1007. $val=~s/\r\n/\n/mg;
  1008. $val=~s/^\n+//g;
  1009. $val=~s/\n+$//g;
  1010. }
  1011. elsif (defined $3) {
  1012. $val=$3;
  1013. }
  1014. elsif (defined $4) {
  1015. $val=$4;
  1016. }
  1017. if (defined $key) {
  1018. push @params, $key, $val;
  1019. }
  1020. else {
  1021. push @params, $val, '';
  1022. }
  1023. }
  1024. if ($preprocessing{$page}++ > 3) {
  1025. # Avoid loops of preprocessed pages preprocessing
  1026. # other pages that preprocess them, etc.
  1027. return "[[!$command <span class=\"error\">".
  1028. sprintf(gettext("preprocessing loop detected on %s at depth %i"),
  1029. $page, $preprocessing{$page}).
  1030. "</span>]]";
  1031. }
  1032. my $ret;
  1033. if (! $scan) {
  1034. $ret=eval {
  1035. $hooks{preprocess}{$command}{call}->(
  1036. @params,
  1037. page => $page,
  1038. destpage => $destpage,
  1039. preview => $preprocess_preview,
  1040. );
  1041. };
  1042. if ($@) {
  1043. chomp $@;
  1044. $ret="[[!$command <span class=\"error\">".
  1045. gettext("Error").": $@"."</span>]]";
  1046. }
  1047. }
  1048. else {
  1049. # use void context during scan pass
  1050. eval {
  1051. $hooks{preprocess}{$command}{call}->(
  1052. @params,
  1053. page => $page,
  1054. destpage => $destpage,
  1055. preview => $preprocess_preview,
  1056. );
  1057. };
  1058. $ret="";
  1059. }
  1060. $preprocessing{$page}--;
  1061. return $ret;
  1062. }
  1063. else {
  1064. return "[[$prefix$command $params]]";
  1065. }
  1066. };
  1067. my $regex;
  1068. if ($config{prefix_directives}) {
  1069. $regex = qr{
  1070. (\\?) # 1: escape?
  1071. \[\[(!) # directive open; 2: prefix
  1072. ([-\w]+) # 3: command
  1073. ( # 4: the parameters..
  1074. \s+ # Must have space if parameters present
  1075. (?:
  1076. (?:[-\w]+=)? # named parameter key?
  1077. (?:
  1078. """.*?""" # triple-quoted value
  1079. |
  1080. "[^"]+" # single-quoted value
  1081. |
  1082. [^\s\]]+ # unquoted value
  1083. )
  1084. \s* # whitespace or end
  1085. # of directive
  1086. )
  1087. *)? # 0 or more parameters
  1088. \]\] # directive closed
  1089. }sx;
  1090. }
  1091. else {
  1092. $regex = qr{
  1093. (\\?) # 1: escape?
  1094. \[\[(!?) # directive open; 2: optional prefix
  1095. ([-\w]+) # 3: command
  1096. \s+
  1097. ( # 4: the parameters..
  1098. (?:
  1099. (?:[-\w]+=)? # named parameter key?
  1100. (?:
  1101. """.*?""" # triple-quoted value
  1102. |
  1103. "[^"]+" # single-quoted value
  1104. |
  1105. [^\s\]]+ # unquoted value
  1106. )
  1107. \s* # whitespace or end
  1108. # of directive
  1109. )
  1110. *) # 0 or more parameters
  1111. \]\] # directive closed
  1112. }sx;
  1113. }
  1114. $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
  1115. return $content;
  1116. } #}}}
  1117. sub filter ($$$) { #{{{
  1118. my $page=shift;
  1119. my $destpage=shift;
  1120. my $content=shift;
  1121. run_hooks(filter => sub {
  1122. $content=shift->(page => $page, destpage => $destpage,
  1123. content => $content);
  1124. });
  1125. return $content;
  1126. } #}}}
  1127. sub indexlink () { #{{{
  1128. return "<a href=\"$config{url}\">$config{wikiname}</a>";
  1129. } #}}}
  1130. my $wikilock;
  1131. sub lockwiki (;$) { #{{{
  1132. my $wait=@_ ? shift : 1;
  1133. # Take an exclusive lock on the wiki to prevent multiple concurrent
  1134. # run issues. The lock will be dropped on program exit.
  1135. if (! -d $config{wikistatedir}) {
  1136. mkdir($config{wikistatedir});
  1137. }
  1138. open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
  1139. error ("cannot write to $config{wikistatedir}/lockfile: $!");
  1140. if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
  1141. if ($wait) {
  1142. debug("wiki seems to be locked, waiting for lock");
  1143. my $wait=600; # arbitrary, but don't hang forever to
  1144. # prevent process pileup
  1145. for (1..$wait) {
  1146. return if flock($wikilock, 2 | 4);
  1147. sleep 1;
  1148. }
  1149. error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
  1150. }
  1151. else {
  1152. return 0;
  1153. }
  1154. }
  1155. return 1;
  1156. } #}}}
  1157. sub unlockwiki () { #{{{
  1158. return close($wikilock) if $wikilock;
  1159. return;
  1160. } #}}}
  1161. my $commitlock;
  1162. sub commit_hook_enabled () { #{{{
  1163. open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
  1164. error("cannot write to $config{wikistatedir}/commitlock: $!");
  1165. if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
  1166. close($commitlock) || error("failed closing commitlock: $!");
  1167. return 0;
  1168. }
  1169. close($commitlock) || error("failed closing commitlock: $!");
  1170. return 1;
  1171. } #}}}
  1172. sub disable_commit_hook () { #{{{
  1173. open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
  1174. error("cannot write to $config{wikistatedir}/commitlock: $!");
  1175. if (! flock($commitlock, 2)) { # LOCK_EX
  1176. error("failed to get commit lock");
  1177. }
  1178. return 1;
  1179. } #}}}
  1180. sub enable_commit_hook () { #{{{
  1181. return close($commitlock) if $commitlock;
  1182. return;
  1183. } #}}}
  1184. sub loadindex () { #{{{
  1185. %oldrenderedfiles=%pagectime=();
  1186. if (! $config{rebuild}) {
  1187. %pagesources=%pagemtime=%oldlinks=%links=%depends=
  1188. %destsources=%renderedfiles=%pagecase=%pagestate=();
  1189. }
  1190. my $in;
  1191. if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
  1192. if (-e "$config{wikistatedir}/index") {
  1193. system("ikiwiki-transition", "indexdb", $config{srcdir});
  1194. open ($in, "<", "$config{wikistatedir}/indexdb") || return;
  1195. }
  1196. else {
  1197. return;
  1198. }
  1199. }
  1200. my $index=Storable::fd_retrieve($in);
  1201. if (! defined $index) {
  1202. return 0;
  1203. }
  1204. my $pages;
  1205. if (exists $index->{version} && ! ref $index->{version}) {
  1206. $pages=$index->{page};
  1207. %wikistate=%{$index->{state}};
  1208. }
  1209. else {
  1210. $pages=$index;
  1211. %wikistate=();
  1212. }
  1213. foreach my $src (keys %$pages) {
  1214. my $d=$pages->{$src};
  1215. my $page=pagename($src);
  1216. $pagectime{$page}=$d->{ctime};
  1217. if (! $config{rebuild}) {
  1218. $pagesources{$page}=$src;
  1219. $pagemtime{$page}=$d->{mtime};
  1220. $renderedfiles{$page}=$d->{dest};
  1221. if (exists $d->{links} && ref $d->{links}) {
  1222. $links{$page}=$d->{links};
  1223. $oldlinks{$page}=[@{$d->{links}}];
  1224. }
  1225. if (exists $d->{depends}) {
  1226. $depends{$page}=$d->{depends};
  1227. }
  1228. if (exists $d->{state}) {
  1229. $pagestate{$page}=$d->{state};
  1230. }
  1231. }
  1232. $oldrenderedfiles{$page}=[@{$d->{dest}}];
  1233. }
  1234. foreach my $page (keys %pagesources) {
  1235. $pagecase{lc $page}=$page;
  1236. }
  1237. foreach my $page (keys %renderedfiles) {
  1238. $destsources{$_}=$page foreach @{$renderedfiles{$page}};
  1239. }
  1240. return close($in);
  1241. } #}}}
  1242. sub saveindex () { #{{{
  1243. run_hooks(savestate => sub { shift->() });
  1244. my %hookids;
  1245. foreach my $type (keys %hooks) {
  1246. $hookids{$_}=1 foreach keys %{$hooks{$type}};
  1247. }
  1248. my @hookids=keys %hookids;
  1249. if (! -d $config{wikistatedir}) {
  1250. mkdir($config{wikistatedir});
  1251. }
  1252. my $newfile="$config{wikistatedir}/indexdb.new";
  1253. my $cleanup = sub { unlink($newfile) };
  1254. open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
  1255. my %index;
  1256. foreach my $page (keys %pagemtime) {
  1257. next unless $pagemtime{$page};
  1258. my $src=$pagesources{$page};
  1259. $index{page}{$src}={
  1260. ctime => $pagectime{$page},
  1261. mtime => $pagemtime{$page},
  1262. dest => $renderedfiles{$page},
  1263. links => $links{$page},
  1264. };
  1265. if (exists $depends{$page}) {
  1266. $index{page}{$src}{depends} = $depends{$page};
  1267. }
  1268. if (exists $pagestate{$page}) {
  1269. foreach my $id (@hookids) {
  1270. foreach my $key (keys %{$pagestate{$page}{$id}}) {
  1271. $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
  1272. }
  1273. }
  1274. }
  1275. }
  1276. $index{state}={};
  1277. foreach my $id (@hookids) {
  1278. foreach my $key (keys %{$wikistate{$id}}) {
  1279. $index{state}{$id}{$key}=$wikistate{$id}{$key};
  1280. }
  1281. }
  1282. $index{version}="3";
  1283. my $ret=Storable::nstore_fd(\%index, $out);
  1284. return if ! defined $ret || ! $ret;
  1285. close $out || error("failed saving to $newfile: $!", $cleanup);
  1286. rename($newfile, "$config{wikistatedir}/indexdb") ||
  1287. error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
  1288. return 1;
  1289. } #}}}
  1290. sub template_file ($) { #{{{
  1291. my $template=shift;
  1292. foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
  1293. return "$dir/$template" if -e "$dir/$template";
  1294. }
  1295. return;
  1296. } #}}}
  1297. sub template_params (@) { #{{{
  1298. my $filename=template_file(shift);
  1299. if (! defined $filename) {
  1300. return if wantarray;
  1301. return "";
  1302. }
  1303. my @ret=(
  1304. filter => sub {
  1305. my $text_ref = shift;
  1306. ${$text_ref} = decode_utf8(${$text_ref});
  1307. },
  1308. filename => $filename,
  1309. loop_context_vars => 1,
  1310. die_on_bad_params => 0,
  1311. @_
  1312. );
  1313. return wantarray ? @ret : {@ret};
  1314. } #}}}
  1315. sub template ($;@) { #{{{
  1316. require HTML::Template;
  1317. return HTML::Template->new(template_params(@_));
  1318. } #}}}
  1319. sub misctemplate ($$;@) { #{{{
  1320. my $title=shift;
  1321. my $pagebody=shift;
  1322. my $template=template("misc.tmpl");
  1323. $template->param(
  1324. title => $title,
  1325. indexlink => indexlink(),
  1326. wikiname => $config{wikiname},
  1327. pagebody => $pagebody,
  1328. baseurl => baseurl(),
  1329. @_,
  1330. );
  1331. run_hooks(pagetemplate => sub {
  1332. shift->(page => "", destpage => "", template => $template);
  1333. });
  1334. return $template->output;
  1335. }#}}}
  1336. sub hook (@) { # {{{
  1337. my %param=@_;
  1338. if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
  1339. error 'hook requires type, call, and id parameters';
  1340. }
  1341. return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
  1342. $hooks{$param{type}}{$param{id}}=\%param;
  1343. return 1;
  1344. } # }}}
  1345. sub run_hooks ($$) { # {{{
  1346. # Calls the given sub for each hook of the given type,
  1347. # passing it the hook function to call.
  1348. my $type=shift;
  1349. my $sub=shift;
  1350. if (exists $hooks{$type}) {
  1351. my @deferred;
  1352. foreach my $id (keys %{$hooks{$type}}) {
  1353. if ($hooks{$type}{$id}{last}) {
  1354. push @deferred, $id;
  1355. next;
  1356. }
  1357. $sub->($hooks{$type}{$id}{call});
  1358. }
  1359. foreach my $id (@deferred) {
  1360. $sub->($hooks{$type}{$id}{call});
  1361. }
  1362. }
  1363. return 1;
  1364. } #}}}
  1365. sub rcs_update () { #{{{
  1366. $hooks{rcs}{rcs_update}{call}->(@_);
  1367. } #}}}
  1368. sub rcs_prepedit ($) { #{{{
  1369. $hooks{rcs}{rcs_prepedit}{call}->(@_);
  1370. } #}}}
  1371. sub rcs_commit ($$$;$$) { #{{{
  1372. $hooks{rcs}{rcs_commit}{call}->(@_);
  1373. } #}}}
  1374. sub rcs_commit_staged ($$$) { #{{{
  1375. $hooks{rcs}{rcs_commit_staged}{call}->(@_);
  1376. } #}}}
  1377. sub rcs_add ($) { #{{{
  1378. $hooks{rcs}{rcs_add}{call}->(@_);
  1379. } #}}}
  1380. sub rcs_remove ($) { #{{{
  1381. $hooks{rcs}{rcs_remove}{call}->(@_);
  1382. } #}}}
  1383. sub rcs_rename ($$) { #{{{
  1384. $hooks{rcs}{rcs_rename}{call}->(@_);
  1385. } #}}}
  1386. sub rcs_recentchanges ($) { #{{{
  1387. $hooks{rcs}{rcs_recentchanges}{call}->(@_);
  1388. } #}}}
  1389. sub rcs_diff ($) { #{{{
  1390. $hooks{rcs}{rcs_diff}{call}->(@_);
  1391. } #}}}
  1392. sub rcs_getctime ($) { #{{{
  1393. $hooks{rcs}{rcs_getctime}{call}->(@_);
  1394. } #}}}
  1395. sub globlist_to_pagespec ($) { #{{{
  1396. my @globlist=split(' ', shift);
  1397. my (@spec, @skip);
  1398. foreach my $glob (@globlist) {
  1399. if ($glob=~/^!(.*)/) {
  1400. push @skip, $glob;
  1401. }
  1402. else {
  1403. push @spec, $glob;
  1404. }
  1405. }
  1406. my $spec=join(' or ', @spec);
  1407. if (@skip) {
  1408. my $skip=join(' and ', @skip);
  1409. if (length $spec) {
  1410. $spec="$skip and ($spec)";
  1411. }
  1412. else {
  1413. $spec=$skip;
  1414. }
  1415. }
  1416. return $spec;
  1417. } #}}}
  1418. sub is_globlist ($) { #{{{
  1419. my $s=shift;
  1420. return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
  1421. } #}}}
  1422. sub safequote ($) { #{{{
  1423. my $s=shift;
  1424. $s=~s/[{}]//g;
  1425. return "q{$s}";
  1426. } #}}}
  1427. sub add_depends ($$) { #{{{
  1428. my $page=shift;
  1429. my $pagespec=shift;
  1430. return unless pagespec_valid($pagespec);
  1431. if (! exists $depends{$page}) {
  1432. $depends{$page}=$pagespec;
  1433. }
  1434. else {
  1435. $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
  1436. }
  1437. return 1;
  1438. } # }}}
  1439. sub file_pruned ($$) { #{{{
  1440. require File::Spec;
  1441. my $file=File::Spec->canonpath(shift);
  1442. my $base=File::Spec->canonpath(shift);
  1443. $file =~ s#^\Q$base\E/+##;
  1444. my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
  1445. return $file =~ m/$regexp/ && $file ne $base;
  1446. } #}}}
  1447. sub gettext { #{{{
  1448. # Only use gettext in the rare cases it's needed.
  1449. if ((exists $ENV{LANG} && length $ENV{LANG}) ||
  1450. (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
  1451. (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
  1452. if (! $gettext_obj) {
  1453. $gettext_obj=eval q{
  1454. use Locale::gettext q{textdomain};
  1455. Locale::gettext->domain('ikiwiki')
  1456. };
  1457. if ($@) {
  1458. print STDERR "$@";
  1459. $gettext_obj=undef;
  1460. return shift;
  1461. }
  1462. }
  1463. return $gettext_obj->get(shift);
  1464. }
  1465. else {
  1466. return shift;
  1467. }
  1468. } #}}}
  1469. sub yesno ($) { #{{{
  1470. my $val=shift;
  1471. return (defined $val && lc($val) eq gettext("yes"));
  1472. } #}}}
  1473. sub pagespec_merge ($$) { #{{{
  1474. my $a=shift;
  1475. my $b=shift;
  1476. return $a if $a eq $b;
  1477. # Support for old-style GlobLists.
  1478. if (is_globlist($a)) {
  1479. $a=globlist_to_pagespec($a);
  1480. }
  1481. if (is_globlist($b)) {
  1482. $b=globlist_to_pagespec($b);
  1483. }
  1484. return "($a) or ($b)";
  1485. } #}}}
  1486. sub pagespec_translate ($) { #{{{
  1487. my $spec=shift;
  1488. # Support for old-style GlobLists.
  1489. if (is_globlist($spec)) {
  1490. $spec=globlist_to_pagespec($spec);
  1491. }
  1492. # Convert spec to perl code.
  1493. my $code="";
  1494. while ($spec=~m{
  1495. \s* # ignore whitespace
  1496. ( # 1: match a single word
  1497. \! # !
  1498. |
  1499. \( # (
  1500. |
  1501. \) # )
  1502. |
  1503. \w+\([^\)]*\) # command(params)
  1504. |
  1505. [^\s()]+ # any other text
  1506. )
  1507. \s* # ignore whitespace
  1508. }igx) {
  1509. my $word=$1;
  1510. if (lc $word eq 'and') {
  1511. $code.=' &&';
  1512. }
  1513. elsif (lc $word eq 'or') {
  1514. $code.=' ||';
  1515. }
  1516. elsif ($word eq "(" || $word eq ")" || $word eq "!") {
  1517. $code.=' '.$word;
  1518. }
  1519. elsif ($word =~ /^(\w+)\((.*)\)$/) {
  1520. if (exists $IkiWiki::PageSpec::{"match_$1"}) {
  1521. $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
  1522. }
  1523. else {
  1524. $code.=' 0';
  1525. }
  1526. }
  1527. else {
  1528. $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
  1529. }
  1530. }
  1531. if (! length $code) {
  1532. $code=0;
  1533. }
  1534. no warnings;
  1535. return eval 'sub { my $page=shift; '.$code.' }';
  1536. } #}}}
  1537. sub pagespec_match ($$;@) { #{{{
  1538. my $page=shift;
  1539. my $spec=shift;
  1540. my @params=@_;
  1541. # Backwards compatability with old calling convention.
  1542. if (@params == 1) {
  1543. unshift @params, 'location';
  1544. }
  1545. my $sub=pagespec_translate($spec);
  1546. return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
  1547. return $sub->($page, @params);
  1548. } #}}}
  1549. sub pagespec_valid ($) { #{{{
  1550. my $spec=shift;
  1551. my $sub=pagespec_translate($spec);
  1552. return ! $@;
  1553. } #}}}
  1554. sub glob2re ($) { #{{{
  1555. my $re=quotemeta(shift);
  1556. $re=~s/\\\*/.*/g;
  1557. $re=~s/\\\?/./g;
  1558. return $re;
  1559. } #}}}
  1560. package IkiWiki::FailReason;
  1561. use overload ( #{{{
  1562. '""' => sub { ${$_[0]} },
  1563. '0+' => sub { 0 },
  1564. '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
  1565. fallback => 1,
  1566. ); #}}}
  1567. sub new { #{{{
  1568. my $class = shift;
  1569. my $value = shift;
  1570. return bless \$value, $class;
  1571. } #}}}
  1572. package IkiWiki::SuccessReason;
  1573. use overload ( #{{{
  1574. '""' => sub { ${$_[0]} },
  1575. '0+' => sub { 1 },
  1576. '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
  1577. fallback => 1,
  1578. ); #}}}
  1579. sub new { #{{{
  1580. my $class = shift;
  1581. my $value = shift;
  1582. return bless \$value, $class;
  1583. }; #}}}
  1584. package IkiWiki::PageSpec;
  1585. sub match_glob ($$;@) { #{{{
  1586. my $page=shift;
  1587. my $glob=shift;
  1588. my %params=@_;
  1589. my $from=exists $params{location} ? $params{location} : '';
  1590. # relative matching
  1591. if ($glob =~ m!^\./!) {
  1592. $from=~s#/?[^/]+$##;
  1593. $glob=~s#^\./##;
  1594. $glob="$from/$glob" if length $from;
  1595. }
  1596. my $regexp=IkiWiki::glob2re($glob);
  1597. if ($page=~/^$regexp$/i) {
  1598. if (! IkiWiki::isinternal($page) || $params{internal}) {
  1599. return IkiWiki::SuccessReason->new("$glob matches $page");
  1600. }
  1601. else {
  1602. return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
  1603. }
  1604. }
  1605. else {
  1606. return IkiWiki::FailReason->new("$glob does not match $page");
  1607. }
  1608. } #}}}
  1609. sub match_internal ($$;@) { #{{{
  1610. return match_glob($_[0], $_[1], @_, internal => 1)
  1611. } #}}}
  1612. sub match_link ($$;@) { #{{{
  1613. my $page=shift;
  1614. my $link=lc(shift);
  1615. my %params=@_;
  1616. my $from=exists $params{location} ? $params{location} : '';
  1617. # relative matching
  1618. if ($link =~ m!^\.! && defined $from) {
  1619. $from=~s#/?[^/]+$##;
  1620. $link=~s#^\./##;
  1621. $link="$from/$link" if length $from;
  1622. }
  1623. my $links = $IkiWiki::links{$page};
  1624. return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
  1625. my $bestlink = IkiWiki::bestlink($from, $link);
  1626. foreach my $p (@{$links}) {
  1627. if (length $bestlink) {
  1628. return IkiWiki::SuccessReason->new("$page links to $link")
  1629. if $bestlink eq IkiWiki::bestlink($page, $p);
  1630. }
  1631. else {
  1632. return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
  1633. if match_glob($p, $link, %params);
  1634. }
  1635. }
  1636. return IkiWiki::FailReason->new("$page does not link to $link");
  1637. } #}}}
  1638. sub match_backlink ($$;@) { #{{{
  1639. return match_link($_[1], $_[0], @_);
  1640. } #}}}
  1641. sub match_created_before ($$;@) { #{{{
  1642. my $page=shift;
  1643. my $testpage=shift;
  1644. if (exists $IkiWiki::pagectime{$testpage}) {
  1645. if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
  1646. return IkiWiki::SuccessReason->new("$page created before $testpage");
  1647. }
  1648. else {
  1649. return IkiWiki::FailReason->new("$page not created before $testpage");
  1650. }
  1651. }
  1652. else {
  1653. return IkiWiki::FailReason->new("$testpage has no ctime");
  1654. }
  1655. } #}}}
  1656. sub match_created_after ($$;@) { #{{{
  1657. my $page=shift;
  1658. my $testpage=shift;
  1659. if (exists $IkiWiki::pagectime{$testpage}) {
  1660. if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
  1661. return IkiWiki::SuccessReason->new("$page created after $testpage");
  1662. }
  1663. else {
  1664. return IkiWiki::FailReason->new("$page not created after $testpage");
  1665. }
  1666. }
  1667. else {
  1668. return IkiWiki::FailReason->new("$testpage has no ctime");
  1669. }
  1670. } #}}}
  1671. sub match_creation_day ($$;@) { #{{{
  1672. if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
  1673. return IkiWiki::SuccessReason->new('creation_day matched');
  1674. }
  1675. else {
  1676. return IkiWiki::FailReason->new('creation_day did not match');
  1677. }
  1678. } #}}}
  1679. sub match_creation_month ($$;@) { #{{{
  1680. if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
  1681. return IkiWiki::SuccessReason->new('creation_month matched');
  1682. }
  1683. else {
  1684. return IkiWiki::FailReason->new('creation_month did not match');
  1685. }
  1686. } #}}}
  1687. sub match_creation_year ($$;@) { #{{{
  1688. if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
  1689. return IkiWiki::SuccessReason->new('creation_year matched');
  1690. }
  1691. else {
  1692. return IkiWiki::FailReason->new('creation_year did not match');
  1693. }
  1694. } #}}}
  1695. sub match_user ($$;@) { #{{{
  1696. shift;
  1697. my $user=shift;
  1698. my %params=@_;
  1699. if (! exists $params{user}) {
  1700. return IkiWiki::FailReason->new("no user specified");
  1701. }
  1702. if (defined $params{user} && lc $params{user} eq lc $user) {
  1703. return IkiWiki::SuccessReason->new("user is $user");
  1704. }
  1705. elsif (! defined $params{user}) {
  1706. return IkiWiki::FailReason->new("not logged in");
  1707. }
  1708. else {
  1709. return IkiWiki::FailReason->new("user is $params{user}, not $user");
  1710. }
  1711. } #}}}
  1712. sub match_admin ($$;@) { #{{{
  1713. shift;
  1714. shift;
  1715. my %params=@_;
  1716. if (! exists $params{user}) {
  1717. return IkiWiki::FailReason->new("no user specified");
  1718. }
  1719. if (defined $params{user} && IkiWiki::is_admin($params{user})) {
  1720. return IkiWiki::SuccessReason->new("user is an admin");
  1721. }
  1722. elsif (! defined $params{user}) {
  1723. return IkiWiki::FailReason->new("not logged in");
  1724. }
  1725. else {
  1726. return IkiWiki::FailReason->new("user is not an admin");
  1727. }
  1728. } #}}}
  1729. sub match_ip ($$;@) { #{{{
  1730. shift;
  1731. my $ip=shift;
  1732. my %params=@_;
  1733. if (! exists $params{ip}) {
  1734. return IkiWiki::FailReason->new("no IP specified");
  1735. }
  1736. if (defined $params{ip} && lc $params{ip} eq lc $ip) {
  1737. return IkiWiki::SuccessReason->new("IP is $ip");
  1738. }
  1739. else {
  1740. return IkiWiki::FailReason->new("IP is $params{ip}, not $ip");
  1741. }
  1742. } #}}}
  1743. 1