summaryrefslogtreecommitdiff
path: root/IkiWiki.pm
blob: 82370f430ddd257544d47509ed4ffc0f14c5250f (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. if (! $config{usedirs} || $page eq 'index') {
  606. return $page.".".$ext;
  607. }
  608. else {
  609. return $page."/index.".$ext;
  610. }
  611. } #}}}
  612. sub htmlpage ($) { #{{{
  613. my $page=shift;
  614. return targetpage($page, $config{htmlext});
  615. } #}}}
  616. sub srcfile_stat { #{{{
  617. my $file=shift;
  618. my $nothrow=shift;
  619. return "$config{srcdir}/$file", stat(_) if -e "$config{srcdir}/$file";
  620. foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
  621. return "$dir/$file", stat(_) if -e "$dir/$file";
  622. }
  623. error("internal error: $file cannot be found in $config{srcdir} or underlay") unless $nothrow;
  624. return;
  625. } #}}}
  626. sub srcfile ($;$) { #{{{
  627. return (srcfile_stat(@_))[0];
  628. } #}}}
  629. sub add_underlay ($) { #{{{
  630. my $dir=shift;
  631. if ($dir=~/^\//) {
  632. unshift @{$config{underlaydirs}}, $dir;
  633. }
  634. else {
  635. unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
  636. }
  637. return 1;
  638. } #}}}
  639. sub readfile ($;$$) { #{{{
  640. my $file=shift;
  641. my $binary=shift;
  642. my $wantfd=shift;
  643. if (-l $file) {
  644. error("cannot read a symlink ($file)");
  645. }
  646. local $/=undef;
  647. open (my $in, "<", $file) || error("failed to read $file: $!");
  648. binmode($in) if ($binary);
  649. return \*$in if $wantfd;
  650. my $ret=<$in>;
  651. close $in || error("failed to read $file: $!");
  652. return $ret;
  653. } #}}}
  654. sub prep_writefile ($$) { #{{{
  655. my $file=shift;
  656. my $destdir=shift;
  657. my $test=$file;
  658. while (length $test) {
  659. if (-l "$destdir/$test") {
  660. error("cannot write to a symlink ($test)");
  661. }
  662. $test=dirname($test);
  663. }
  664. my $dir=dirname("$destdir/$file");
  665. if (! -d $dir) {
  666. my $d="";
  667. foreach my $s (split(m!/+!, $dir)) {
  668. $d.="$s/";
  669. if (! -d $d) {
  670. mkdir($d) || error("failed to create directory $d: $!");
  671. }
  672. }
  673. }
  674. return 1;
  675. } #}}}
  676. sub writefile ($$$;$$) { #{{{
  677. my $file=shift; # can include subdirs
  678. my $destdir=shift; # directory to put file in
  679. my $content=shift;
  680. my $binary=shift;
  681. my $writer=shift;
  682. prep_writefile($file, $destdir);
  683. my $newfile="$destdir/$file.ikiwiki-new";
  684. if (-l $newfile) {
  685. error("cannot write to a symlink ($newfile)");
  686. }
  687. my $cleanup = sub { unlink($newfile) };
  688. open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
  689. binmode($out) if ($binary);
  690. if ($writer) {
  691. $writer->(\*$out, $cleanup);
  692. }
  693. else {
  694. print $out $content or error("failed writing to $newfile: $!", $cleanup);
  695. }
  696. close $out || error("failed saving $newfile: $!", $cleanup);
  697. rename($newfile, "$destdir/$file") ||
  698. error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
  699. return 1;
  700. } #}}}
  701. my %cleared;
  702. sub will_render ($$;$) { #{{{
  703. my $page=shift;
  704. my $dest=shift;
  705. my $clear=shift;
  706. # Important security check.
  707. if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
  708. ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}}, @{$wikistate{editpage}{previews}})) {
  709. error("$config{destdir}/$dest independently created, not overwriting with version from $page");
  710. }
  711. if (! $clear || $cleared{$page}) {
  712. $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
  713. }
  714. else {
  715. foreach my $old (@{$renderedfiles{$page}}) {
  716. delete $destsources{$old};
  717. }
  718. $renderedfiles{$page}=[$dest];
  719. $cleared{$page}=1;
  720. }
  721. $destsources{$dest}=$page;
  722. return 1;
  723. } #}}}
  724. sub bestlink ($$) { #{{{
  725. my $page=shift;
  726. my $link=shift;
  727. my $cwd=$page;
  728. if ($link=~s/^\/+//) {
  729. # absolute links
  730. $cwd="";
  731. }
  732. $link=~s/\/$//;
  733. do {
  734. my $l=$cwd;
  735. $l.="/" if length $l;
  736. $l.=$link;
  737. if (exists $links{$l}) {
  738. return $l;
  739. }
  740. elsif (exists $pagecase{lc $l}) {
  741. return $pagecase{lc $l};
  742. }
  743. } while $cwd=~s{/?[^/]+$}{};
  744. if (length $config{userdir}) {
  745. my $l = "$config{userdir}/".lc($link);
  746. if (exists $links{$l}) {
  747. return $l;
  748. }
  749. elsif (exists $pagecase{lc $l}) {
  750. return $pagecase{lc $l};
  751. }
  752. }
  753. #print STDERR "warning: page $page, broken link: $link\n";
  754. return "";
  755. } #}}}
  756. sub isinlinableimage ($) { #{{{
  757. my $file=shift;
  758. return $file =~ /\.(png|gif|jpg|jpeg)$/i;
  759. } #}}}
  760. sub pagetitle ($;$) { #{{{
  761. my $page=shift;
  762. my $unescaped=shift;
  763. if ($unescaped) {
  764. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
  765. }
  766. else {
  767. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
  768. }
  769. return $page;
  770. } #}}}
  771. sub titlepage ($) { #{{{
  772. my $title=shift;
  773. # support use w/o %config set
  774. my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
  775. $title=~s/([^$chars]|_)/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  776. return $title;
  777. } #}}}
  778. sub linkpage ($) { #{{{
  779. my $link=shift;
  780. my $chars = defined $config{wiki_file_chars} ? $config{wiki_file_chars} : "-[:alnum:]+/.:_";
  781. $link=~s/([^$chars])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  782. return $link;
  783. } #}}}
  784. sub cgiurl (@) { #{{{
  785. my %params=@_;
  786. return $config{cgiurl}."?".
  787. join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
  788. } #}}}
  789. sub baseurl (;$) { #{{{
  790. my $page=shift;
  791. return "$config{url}/" if ! defined $page;
  792. $page=htmlpage($page);
  793. $page=~s/[^\/]+$//;
  794. $page=~s/[^\/]+\//..\//g;
  795. return $page;
  796. } #}}}
  797. sub abs2rel ($$) { #{{{
  798. # Work around very innefficient behavior in File::Spec if abs2rel
  799. # is passed two relative paths. It's much faster if paths are
  800. # absolute! (Debian bug #376658; fixed in debian unstable now)
  801. my $path="/".shift;
  802. my $base="/".shift;
  803. require File::Spec;
  804. my $ret=File::Spec->abs2rel($path, $base);
  805. $ret=~s/^// if defined $ret;
  806. return $ret;
  807. } #}}}
  808. sub displaytime ($;$) { #{{{
  809. my $time=shift;
  810. my $format=shift;
  811. if (! defined $format) {
  812. $format=$config{timeformat};
  813. }
  814. # strftime doesn't know about encodings, so make sure
  815. # its output is properly treated as utf8
  816. return decode_utf8(POSIX::strftime($format, localtime($time)));
  817. } #}}}
  818. sub beautify_urlpath ($) { #{{{
  819. my $url=shift;
  820. if ($config{usedirs}) {
  821. $url =~ s!/index.$config{htmlext}$!/!;
  822. }
  823. # Ensure url is not an empty link, and
  824. # if it's relative, make that explicit to avoid colon confusion.
  825. if ($url !~ /^\//) {
  826. $url="./$url";
  827. }
  828. return $url;
  829. } #}}}
  830. sub urlto ($$;$) { #{{{
  831. my $to=shift;
  832. my $from=shift;
  833. my $absolute=shift;
  834. if (! length $to) {
  835. return beautify_urlpath(baseurl($from)."index.$config{htmlext}");
  836. }
  837. if (! $destsources{$to}) {
  838. $to=htmlpage($to);
  839. }
  840. if ($absolute) {
  841. return $config{url}.beautify_urlpath("/".$to);
  842. }
  843. my $link = abs2rel($to, dirname(htmlpage($from)));
  844. return beautify_urlpath($link);
  845. } #}}}
  846. sub htmllink ($$$;@) { #{{{
  847. my $lpage=shift; # the page doing the linking
  848. my $page=shift; # the page that will contain the link (different for inline)
  849. my $link=shift;
  850. my %opts=@_;
  851. $link=~s/\/$//;
  852. my $bestlink;
  853. if (! $opts{forcesubpage}) {
  854. $bestlink=bestlink($lpage, $link);
  855. }
  856. else {
  857. $bestlink="$lpage/".lc($link);
  858. }
  859. my $linktext;
  860. if (defined $opts{linktext}) {
  861. $linktext=$opts{linktext};
  862. }
  863. else {
  864. $linktext=pagetitle(basename($link));
  865. }
  866. return "<span class=\"selflink\">$linktext</span>"
  867. if length $bestlink && $page eq $bestlink &&
  868. ! defined $opts{anchor};
  869. if (! $destsources{$bestlink}) {
  870. $bestlink=htmlpage($bestlink);
  871. if (! $destsources{$bestlink}) {
  872. return $linktext unless length $config{cgiurl};
  873. return "<span class=\"createlink\"><a href=\"".
  874. cgiurl(
  875. do => "create",
  876. page => lc($link),
  877. from => $lpage
  878. ).
  879. "\" rel=\"nofollow\">?</a>$linktext</span>"
  880. }
  881. }
  882. $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
  883. $bestlink=beautify_urlpath($bestlink);
  884. if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
  885. return "<img src=\"$bestlink\" alt=\"$linktext\" />";
  886. }
  887. if (defined $opts{anchor}) {
  888. $bestlink.="#".$opts{anchor};
  889. }
  890. my @attrs;
  891. if (defined $opts{rel}) {
  892. push @attrs, ' rel="'.$opts{rel}.'"';
  893. }
  894. if (defined $opts{class}) {
  895. push @attrs, ' class="'.$opts{class}.'"';
  896. }
  897. return "<a href=\"$bestlink\"@attrs>$linktext</a>";
  898. } #}}}
  899. sub userlink ($) { #{{{
  900. my $user=shift;
  901. my $oiduser=eval { openiduser($user) };
  902. if (defined $oiduser) {
  903. return "<a href=\"$user\">$oiduser</a>";
  904. }
  905. else {
  906. eval q{use CGI 'escapeHTML'};
  907. error($@) if $@;
  908. return htmllink("", "", escapeHTML(
  909. length $config{userdir} ? $config{userdir}."/".$user : $user
  910. ), noimageinline => 1);
  911. }
  912. } #}}}
  913. sub htmlize ($$$$) { #{{{
  914. my $page=shift;
  915. my $destpage=shift;
  916. my $type=shift;
  917. my $content=shift;
  918. my $oneline = $content !~ /\n/;
  919. if (exists $hooks{htmlize}{$type}) {
  920. $content=$hooks{htmlize}{$type}{call}->(
  921. page => $page,
  922. content => $content,
  923. );
  924. }
  925. else {
  926. error("htmlization of $type not supported");
  927. }
  928. run_hooks(sanitize => sub {
  929. $content=shift->(
  930. page => $page,
  931. destpage => $destpage,
  932. content => $content,
  933. );
  934. });
  935. if ($oneline) {
  936. # hack to get rid of enclosing junk added by markdown
  937. # and other htmlizers
  938. $content=~s/^<p>//i;
  939. $content=~s/<\/p>$//i;
  940. chomp $content;
  941. }
  942. return $content;
  943. } #}}}
  944. sub linkify ($$$) { #{{{
  945. my $page=shift;
  946. my $destpage=shift;
  947. my $content=shift;
  948. run_hooks(linkify => sub {
  949. $content=shift->(
  950. page => $page,
  951. destpage => $destpage,
  952. content => $content,
  953. );
  954. });
  955. return $content;
  956. } #}}}
  957. our %preprocessing;
  958. our $preprocess_preview=0;
  959. sub preprocess ($$$;$$) { #{{{
  960. my $page=shift; # the page the data comes from
  961. my $destpage=shift; # the page the data will appear in (different for inline)
  962. my $content=shift;
  963. my $scan=shift;
  964. my $preview=shift;
  965. # Using local because it needs to be set within any nested calls
  966. # of this function.
  967. local $preprocess_preview=$preview if defined $preview;
  968. my $handle=sub {
  969. my $escape=shift;
  970. my $prefix=shift;
  971. my $command=shift;
  972. my $params=shift;
  973. $params="" if ! defined $params;
  974. if (length $escape) {
  975. return "[[$prefix$command $params]]";
  976. }
  977. elsif (exists $hooks{preprocess}{$command}) {
  978. return "" if $scan && ! $hooks{preprocess}{$command}{scan};
  979. # Note: preserve order of params, some plugins may
  980. # consider it significant.
  981. my @params;
  982. while ($params =~ m{
  983. (?:([-\w]+)=)? # 1: named parameter key?
  984. (?:
  985. """(.*?)""" # 2: triple-quoted value
  986. |
  987. "([^"]+)" # 3: single-quoted value
  988. |
  989. (\S+) # 4: unquoted value
  990. )
  991. (?:\s+|$) # delimiter to next param
  992. }sgx) {
  993. my $key=$1;
  994. my $val;
  995. if (defined $2) {
  996. $val=$2;
  997. $val=~s/\r\n/\n/mg;
  998. $val=~s/^\n+//g;
  999. $val=~s/\n+$//g;
  1000. }
  1001. elsif (defined $3) {
  1002. $val=$3;
  1003. }
  1004. elsif (defined $4) {
  1005. $val=$4;
  1006. }
  1007. if (defined $key) {
  1008. push @params, $key, $val;
  1009. }
  1010. else {
  1011. push @params, $val, '';
  1012. }
  1013. }
  1014. if ($preprocessing{$page}++ > 3) {
  1015. # Avoid loops of preprocessed pages preprocessing
  1016. # other pages that preprocess them, etc.
  1017. return "[[!$command <span class=\"error\">".
  1018. sprintf(gettext("preprocessing loop detected on %s at depth %i"),
  1019. $page, $preprocessing{$page}).
  1020. "</span>]]";
  1021. }
  1022. my $ret;
  1023. if (! $scan) {
  1024. $ret=eval {
  1025. $hooks{preprocess}{$command}{call}->(
  1026. @params,
  1027. page => $page,
  1028. destpage => $destpage,
  1029. preview => $preprocess_preview,
  1030. );
  1031. };
  1032. if ($@) {
  1033. chomp $@;
  1034. $ret="[[!$command <span class=\"error\">".
  1035. gettext("Error").": $@"."</span>]]";
  1036. }
  1037. }
  1038. else {
  1039. # use void context during scan pass
  1040. eval {
  1041. $hooks{preprocess}{$command}{call}->(
  1042. @params,
  1043. page => $page,
  1044. destpage => $destpage,
  1045. preview => $preprocess_preview,
  1046. );
  1047. };
  1048. $ret="";
  1049. }
  1050. $preprocessing{$page}--;
  1051. return $ret;
  1052. }
  1053. else {
  1054. return "[[$prefix$command $params]]";
  1055. }
  1056. };
  1057. my $regex;
  1058. if ($config{prefix_directives}) {
  1059. $regex = qr{
  1060. (\\?) # 1: escape?
  1061. \[\[(!) # directive open; 2: prefix
  1062. ([-\w]+) # 3: command
  1063. ( # 4: the parameters..
  1064. \s+ # Must have space if parameters present
  1065. (?:
  1066. (?:[-\w]+=)? # named parameter key?
  1067. (?:
  1068. """.*?""" # triple-quoted value
  1069. |
  1070. "[^"]+" # single-quoted value
  1071. |
  1072. [^\s\]]+ # unquoted value
  1073. )
  1074. \s* # whitespace or end
  1075. # of directive
  1076. )
  1077. *)? # 0 or more parameters
  1078. \]\] # directive closed
  1079. }sx;
  1080. }
  1081. else {
  1082. $regex = qr{
  1083. (\\?) # 1: escape?
  1084. \[\[(!?) # directive open; 2: optional prefix
  1085. ([-\w]+) # 3: command
  1086. \s+
  1087. ( # 4: the parameters..
  1088. (?:
  1089. (?:[-\w]+=)? # named parameter key?
  1090. (?:
  1091. """.*?""" # triple-quoted value
  1092. |
  1093. "[^"]+" # single-quoted value
  1094. |
  1095. [^\s\]]+ # unquoted value
  1096. )
  1097. \s* # whitespace or end
  1098. # of directive
  1099. )
  1100. *) # 0 or more parameters
  1101. \]\] # directive closed
  1102. }sx;
  1103. }
  1104. $content =~ s{$regex}{$handle->($1, $2, $3, $4)}eg;
  1105. return $content;
  1106. } #}}}
  1107. sub filter ($$$) { #{{{
  1108. my $page=shift;
  1109. my $destpage=shift;
  1110. my $content=shift;
  1111. run_hooks(filter => sub {
  1112. $content=shift->(page => $page, destpage => $destpage,
  1113. content => $content);
  1114. });
  1115. return $content;
  1116. } #}}}
  1117. sub indexlink () { #{{{
  1118. return "<a href=\"$config{url}\">$config{wikiname}</a>";
  1119. } #}}}
  1120. my $wikilock;
  1121. sub lockwiki (;$) { #{{{
  1122. my $wait=@_ ? shift : 1;
  1123. # Take an exclusive lock on the wiki to prevent multiple concurrent
  1124. # run issues. The lock will be dropped on program exit.
  1125. if (! -d $config{wikistatedir}) {
  1126. mkdir($config{wikistatedir});
  1127. }
  1128. open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
  1129. error ("cannot write to $config{wikistatedir}/lockfile: $!");
  1130. if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
  1131. if ($wait) {
  1132. debug("wiki seems to be locked, waiting for lock");
  1133. my $wait=600; # arbitrary, but don't hang forever to
  1134. # prevent process pileup
  1135. for (1..$wait) {
  1136. return if flock($wikilock, 2 | 4);
  1137. sleep 1;
  1138. }
  1139. error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
  1140. }
  1141. else {
  1142. return 0;
  1143. }
  1144. }
  1145. return 1;
  1146. } #}}}
  1147. sub unlockwiki () { #{{{
  1148. return close($wikilock) if $wikilock;
  1149. return;
  1150. } #}}}
  1151. my $commitlock;
  1152. sub commit_hook_enabled () { #{{{
  1153. open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
  1154. error("cannot write to $config{wikistatedir}/commitlock: $!");
  1155. if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
  1156. close($commitlock) || error("failed closing commitlock: $!");
  1157. return 0;
  1158. }
  1159. close($commitlock) || error("failed closing commitlock: $!");
  1160. return 1;
  1161. } #}}}
  1162. sub disable_commit_hook () { #{{{
  1163. open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
  1164. error("cannot write to $config{wikistatedir}/commitlock: $!");
  1165. if (! flock($commitlock, 2)) { # LOCK_EX
  1166. error("failed to get commit lock");
  1167. }
  1168. return 1;
  1169. } #}}}
  1170. sub enable_commit_hook () { #{{{
  1171. return close($commitlock) if $commitlock;
  1172. return;
  1173. } #}}}
  1174. sub loadindex () { #{{{
  1175. %oldrenderedfiles=%pagectime=();
  1176. if (! $config{rebuild}) {
  1177. %pagesources=%pagemtime=%oldlinks=%links=%depends=
  1178. %destsources=%renderedfiles=%pagecase=%pagestate=();
  1179. }
  1180. my $in;
  1181. if (! open ($in, "<", "$config{wikistatedir}/indexdb")) {
  1182. if (-e "$config{wikistatedir}/index") {
  1183. system("ikiwiki-transition", "indexdb", $config{srcdir});
  1184. open ($in, "<", "$config{wikistatedir}/indexdb") || return;
  1185. }
  1186. else {
  1187. return;
  1188. }
  1189. }
  1190. my $index=Storable::fd_retrieve($in);
  1191. if (! defined $index) {
  1192. return 0;
  1193. }
  1194. my $pages;
  1195. if (exists $index->{version} && ! ref $index->{version}) {
  1196. $pages=$index->{page};
  1197. %wikistate=%{$index->{state}};
  1198. }
  1199. else {
  1200. $pages=$index;
  1201. %wikistate=();
  1202. }
  1203. foreach my $src (keys %$pages) {
  1204. my $d=$pages->{$src};
  1205. my $page=pagename($src);
  1206. $pagectime{$page}=$d->{ctime};
  1207. if (! $config{rebuild}) {
  1208. $pagesources{$page}=$src;
  1209. $pagemtime{$page}=$d->{mtime};
  1210. $renderedfiles{$page}=$d->{dest};
  1211. if (exists $d->{links} && ref $d->{links}) {
  1212. $links{$page}=$d->{links};
  1213. $oldlinks{$page}=[@{$d->{links}}];
  1214. }
  1215. if (exists $d->{depends}) {
  1216. $depends{$page}=$d->{depends};
  1217. }
  1218. if (exists $d->{state}) {
  1219. $pagestate{$page}=$d->{state};
  1220. }
  1221. }
  1222. $oldrenderedfiles{$page}=[@{$d->{dest}}];
  1223. }
  1224. foreach my $page (keys %pagesources) {
  1225. $pagecase{lc $page}=$page;
  1226. }
  1227. foreach my $page (keys %renderedfiles) {
  1228. $destsources{$_}=$page foreach @{$renderedfiles{$page}};
  1229. }
  1230. return close($in);
  1231. } #}}}
  1232. sub saveindex () { #{{{
  1233. run_hooks(savestate => sub { shift->() });
  1234. my %hookids;
  1235. foreach my $type (keys %hooks) {
  1236. $hookids{$_}=1 foreach keys %{$hooks{$type}};
  1237. }
  1238. my @hookids=keys %hookids;
  1239. if (! -d $config{wikistatedir}) {
  1240. mkdir($config{wikistatedir});
  1241. }
  1242. my $newfile="$config{wikistatedir}/indexdb.new";
  1243. my $cleanup = sub { unlink($newfile) };
  1244. open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
  1245. my %index;
  1246. foreach my $page (keys %pagemtime) {
  1247. next unless $pagemtime{$page};
  1248. my $src=$pagesources{$page};
  1249. $index{page}{$src}={
  1250. ctime => $pagectime{$page},
  1251. mtime => $pagemtime{$page},
  1252. dest => $renderedfiles{$page},
  1253. links => $links{$page},
  1254. };
  1255. if (exists $depends{$page}) {
  1256. $index{page}{$src}{depends} = $depends{$page};
  1257. }
  1258. if (exists $pagestate{$page}) {
  1259. foreach my $id (@hookids) {
  1260. foreach my $key (keys %{$pagestate{$page}{$id}}) {
  1261. $index{page}{$src}{state}{$id}{$key}=$pagestate{$page}{$id}{$key};
  1262. }
  1263. }
  1264. }
  1265. }
  1266. $index{state}={};
  1267. foreach my $id (@hookids) {
  1268. foreach my $key (keys %{$wikistate{$id}}) {
  1269. $index{state}{$id}{$key}=$wikistate{$id}{$key};
  1270. }
  1271. }
  1272. $index{version}="3";
  1273. my $ret=Storable::nstore_fd(\%index, $out);
  1274. return if ! defined $ret || ! $ret;
  1275. close $out || error("failed saving to $newfile: $!", $cleanup);
  1276. rename($newfile, "$config{wikistatedir}/indexdb") ||
  1277. error("failed renaming $newfile to $config{wikistatedir}/indexdb", $cleanup);
  1278. return 1;
  1279. } #}}}
  1280. sub template_file ($) { #{{{
  1281. my $template=shift;
  1282. foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
  1283. return "$dir/$template" if -e "$dir/$template";
  1284. }
  1285. return;
  1286. } #}}}
  1287. sub template_params (@) { #{{{
  1288. my $filename=template_file(shift);
  1289. if (! defined $filename) {
  1290. return if wantarray;
  1291. return "";
  1292. }
  1293. my @ret=(
  1294. filter => sub {
  1295. my $text_ref = shift;
  1296. ${$text_ref} = decode_utf8(${$text_ref});
  1297. },
  1298. filename => $filename,
  1299. loop_context_vars => 1,
  1300. die_on_bad_params => 0,
  1301. @_
  1302. );
  1303. return wantarray ? @ret : {@ret};
  1304. } #}}}
  1305. sub template ($;@) { #{{{
  1306. require HTML::Template;
  1307. return HTML::Template->new(template_params(@_));
  1308. } #}}}
  1309. sub misctemplate ($$;@) { #{{{
  1310. my $title=shift;
  1311. my $pagebody=shift;
  1312. my $template=template("misc.tmpl");
  1313. $template->param(
  1314. title => $title,
  1315. indexlink => indexlink(),
  1316. wikiname => $config{wikiname},
  1317. pagebody => $pagebody,
  1318. baseurl => baseurl(),
  1319. @_,
  1320. );
  1321. run_hooks(pagetemplate => sub {
  1322. shift->(page => "", destpage => "", template => $template);
  1323. });
  1324. return $template->output;
  1325. }#}}}
  1326. sub hook (@) { # {{{
  1327. my %param=@_;
  1328. if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
  1329. error 'hook requires type, call, and id parameters';
  1330. }
  1331. return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
  1332. $hooks{$param{type}}{$param{id}}=\%param;
  1333. return 1;
  1334. } # }}}
  1335. sub run_hooks ($$) { # {{{
  1336. # Calls the given sub for each hook of the given type,
  1337. # passing it the hook function to call.
  1338. my $type=shift;
  1339. my $sub=shift;
  1340. if (exists $hooks{$type}) {
  1341. my @deferred;
  1342. foreach my $id (keys %{$hooks{$type}}) {
  1343. if ($hooks{$type}{$id}{last}) {
  1344. push @deferred, $id;
  1345. next;
  1346. }
  1347. $sub->($hooks{$type}{$id}{call});
  1348. }
  1349. foreach my $id (@deferred) {
  1350. $sub->($hooks{$type}{$id}{call});
  1351. }
  1352. }
  1353. return 1;
  1354. } #}}}
  1355. sub rcs_update () { #{{{
  1356. $hooks{rcs}{rcs_update}{call}->(@_);
  1357. } #}}}
  1358. sub rcs_prepedit ($) { #{{{
  1359. $hooks{rcs}{rcs_prepedit}{call}->(@_);
  1360. } #}}}
  1361. sub rcs_commit ($$$;$$) { #{{{
  1362. $hooks{rcs}{rcs_commit}{call}->(@_);
  1363. } #}}}
  1364. sub rcs_commit_staged ($$$) { #{{{
  1365. $hooks{rcs}{rcs_commit_staged}{call}->(@_);
  1366. } #}}}
  1367. sub rcs_add ($) { #{{{
  1368. $hooks{rcs}{rcs_add}{call}->(@_);
  1369. } #}}}
  1370. sub rcs_remove ($) { #{{{
  1371. $hooks{rcs}{rcs_remove}{call}->(@_);
  1372. } #}}}
  1373. sub rcs_rename ($$) { #{{{
  1374. $hooks{rcs}{rcs_rename}{call}->(@_);
  1375. } #}}}
  1376. sub rcs_recentchanges ($) { #{{{
  1377. $hooks{rcs}{rcs_recentchanges}{call}->(@_);
  1378. } #}}}
  1379. sub rcs_diff ($) { #{{{
  1380. $hooks{rcs}{rcs_diff}{call}->(@_);
  1381. } #}}}
  1382. sub rcs_getctime ($) { #{{{
  1383. $hooks{rcs}{rcs_getctime}{call}->(@_);
  1384. } #}}}
  1385. sub globlist_to_pagespec ($) { #{{{
  1386. my @globlist=split(' ', shift);
  1387. my (@spec, @skip);
  1388. foreach my $glob (@globlist) {
  1389. if ($glob=~/^!(.*)/) {
  1390. push @skip, $glob;
  1391. }
  1392. else {
  1393. push @spec, $glob;
  1394. }
  1395. }
  1396. my $spec=join(' or ', @spec);
  1397. if (@skip) {
  1398. my $skip=join(' and ', @skip);
  1399. if (length $spec) {
  1400. $spec="$skip and ($spec)";
  1401. }
  1402. else {
  1403. $spec=$skip;
  1404. }
  1405. }
  1406. return $spec;
  1407. } #}}}
  1408. sub is_globlist ($) { #{{{
  1409. my $s=shift;
  1410. return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
  1411. } #}}}
  1412. sub safequote ($) { #{{{
  1413. my $s=shift;
  1414. $s=~s/[{}]//g;
  1415. return "q{$s}";
  1416. } #}}}
  1417. sub add_depends ($$) { #{{{
  1418. my $page=shift;
  1419. my $pagespec=shift;
  1420. return unless pagespec_valid($pagespec);
  1421. if (! exists $depends{$page}) {
  1422. $depends{$page}=$pagespec;
  1423. }
  1424. else {
  1425. $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
  1426. }
  1427. return 1;
  1428. } # }}}
  1429. sub file_pruned ($$) { #{{{
  1430. require File::Spec;
  1431. my $file=File::Spec->canonpath(shift);
  1432. my $base=File::Spec->canonpath(shift);
  1433. $file =~ s#^\Q$base\E/+##;
  1434. my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
  1435. return $file =~ m/$regexp/ && $file ne $base;
  1436. } #}}}
  1437. sub gettext { #{{{
  1438. # Only use gettext in the rare cases it's needed.
  1439. if ((exists $ENV{LANG} && length $ENV{LANG}) ||
  1440. (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
  1441. (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
  1442. if (! $gettext_obj) {
  1443. $gettext_obj=eval q{
  1444. use Locale::gettext q{textdomain};
  1445. Locale::gettext->domain('ikiwiki')
  1446. };
  1447. if ($@) {
  1448. print STDERR "$@";
  1449. $gettext_obj=undef;
  1450. return shift;
  1451. }
  1452. }
  1453. return $gettext_obj->get(shift);
  1454. }
  1455. else {
  1456. return shift;
  1457. }
  1458. } #}}}
  1459. sub yesno ($) { #{{{
  1460. my $val=shift;
  1461. return (defined $val && lc($val) eq gettext("yes"));
  1462. } #}}}
  1463. sub pagespec_merge ($$) { #{{{
  1464. my $a=shift;
  1465. my $b=shift;
  1466. return $a if $a eq $b;
  1467. # Support for old-style GlobLists.
  1468. if (is_globlist($a)) {
  1469. $a=globlist_to_pagespec($a);
  1470. }
  1471. if (is_globlist($b)) {
  1472. $b=globlist_to_pagespec($b);
  1473. }
  1474. return "($a) or ($b)";
  1475. } #}}}
  1476. sub pagespec_translate ($) { #{{{
  1477. my $spec=shift;
  1478. # Support for old-style GlobLists.
  1479. if (is_globlist($spec)) {
  1480. $spec=globlist_to_pagespec($spec);
  1481. }
  1482. # Convert spec to perl code.
  1483. my $code="";
  1484. while ($spec=~m{
  1485. \s* # ignore whitespace
  1486. ( # 1: match a single word
  1487. \! # !
  1488. |
  1489. \( # (
  1490. |
  1491. \) # )
  1492. |
  1493. \w+\([^\)]*\) # command(params)
  1494. |
  1495. [^\s()]+ # any other text
  1496. )
  1497. \s* # ignore whitespace
  1498. }igx) {
  1499. my $word=$1;
  1500. if (lc $word eq 'and') {
  1501. $code.=' &&';
  1502. }
  1503. elsif (lc $word eq 'or') {
  1504. $code.=' ||';
  1505. }
  1506. elsif ($word eq "(" || $word eq ")" || $word eq "!") {
  1507. $code.=' '.$word;
  1508. }
  1509. elsif ($word =~ /^(\w+)\((.*)\)$/) {
  1510. if (exists $IkiWiki::PageSpec::{"match_$1"}) {
  1511. $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@_)";
  1512. }
  1513. else {
  1514. $code.=' 0';
  1515. }
  1516. }
  1517. else {
  1518. $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@_)";
  1519. }
  1520. }
  1521. if (! length $code) {
  1522. $code=0;
  1523. }
  1524. no warnings;
  1525. return eval 'sub { my $page=shift; '.$code.' }';
  1526. } #}}}
  1527. sub pagespec_match ($$;@) { #{{{
  1528. my $page=shift;
  1529. my $spec=shift;
  1530. my @params=@_;
  1531. # Backwards compatability with old calling convention.
  1532. if (@params == 1) {
  1533. unshift @params, 'location';
  1534. }
  1535. my $sub=pagespec_translate($spec);
  1536. return IkiWiki::FailReason->new("syntax error in pagespec \"$spec\"") if $@;
  1537. return $sub->($page, @params);
  1538. } #}}}
  1539. sub pagespec_valid ($) { #{{{
  1540. my $spec=shift;
  1541. my $sub=pagespec_translate($spec);
  1542. return ! $@;
  1543. } #}}}
  1544. sub glob2re ($) { #{{{
  1545. my $re=quotemeta(shift);
  1546. $re=~s/\\\*/.*/g;
  1547. $re=~s/\\\?/./g;
  1548. return $re;
  1549. } #}}}
  1550. package IkiWiki::FailReason;
  1551. use overload ( #{{{
  1552. '""' => sub { ${$_[0]} },
  1553. '0+' => sub { 0 },
  1554. '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
  1555. fallback => 1,
  1556. ); #}}}
  1557. sub new { #{{{
  1558. my $class = shift;
  1559. my $value = shift;
  1560. return bless \$value, $class;
  1561. } #}}}
  1562. package IkiWiki::SuccessReason;
  1563. use overload ( #{{{
  1564. '""' => sub { ${$_[0]} },
  1565. '0+' => sub { 1 },
  1566. '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
  1567. fallback => 1,
  1568. ); #}}}
  1569. sub new { #{{{
  1570. my $class = shift;
  1571. my $value = shift;
  1572. return bless \$value, $class;
  1573. }; #}}}
  1574. package IkiWiki::PageSpec;
  1575. sub match_glob ($$;@) { #{{{
  1576. my $page=shift;
  1577. my $glob=shift;
  1578. my %params=@_;
  1579. my $from=exists $params{location} ? $params{location} : '';
  1580. # relative matching
  1581. if ($glob =~ m!^\./!) {
  1582. $from=~s#/?[^/]+$##;
  1583. $glob=~s#^\./##;
  1584. $glob="$from/$glob" if length $from;
  1585. }
  1586. my $regexp=IkiWiki::glob2re($glob);
  1587. if ($page=~/^$regexp$/i) {
  1588. if (! IkiWiki::isinternal($page) || $params{internal}) {
  1589. return IkiWiki::SuccessReason->new("$glob matches $page");
  1590. }
  1591. else {
  1592. return IkiWiki::FailReason->new("$glob matches $page, but the page is an internal page");
  1593. }
  1594. }
  1595. else {
  1596. return IkiWiki::FailReason->new("$glob does not match $page");
  1597. }
  1598. } #}}}
  1599. sub match_internal ($$;@) { #{{{
  1600. return match_glob($_[0], $_[1], @_, internal => 1)
  1601. } #}}}
  1602. sub match_link ($$;@) { #{{{
  1603. my $page=shift;
  1604. my $link=lc(shift);
  1605. my %params=@_;
  1606. my $from=exists $params{location} ? $params{location} : '';
  1607. # relative matching
  1608. if ($link =~ m!^\.! && defined $from) {
  1609. $from=~s#/?[^/]+$##;
  1610. $link=~s#^\./##;
  1611. $link="$from/$link" if length $from;
  1612. }
  1613. my $links = $IkiWiki::links{$page};
  1614. return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
  1615. my $bestlink = IkiWiki::bestlink($from, $link);
  1616. foreach my $p (@{$links}) {
  1617. if (length $bestlink) {
  1618. return IkiWiki::SuccessReason->new("$page links to $link")
  1619. if $bestlink eq IkiWiki::bestlink($page, $p);
  1620. }
  1621. else {
  1622. return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
  1623. if match_glob($p, $link, %params);
  1624. }
  1625. }
  1626. return IkiWiki::FailReason->new("$page does not link to $link");
  1627. } #}}}
  1628. sub match_backlink ($$;@) { #{{{
  1629. return match_link($_[1], $_[0], @_);
  1630. } #}}}
  1631. sub match_created_before ($$;@) { #{{{
  1632. my $page=shift;
  1633. my $testpage=shift;
  1634. if (exists $IkiWiki::pagectime{$testpage}) {
  1635. if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
  1636. return IkiWiki::SuccessReason->new("$page created before $testpage");
  1637. }
  1638. else {
  1639. return IkiWiki::FailReason->new("$page not created before $testpage");
  1640. }
  1641. }
  1642. else {
  1643. return IkiWiki::FailReason->new("$testpage has no ctime");
  1644. }
  1645. } #}}}
  1646. sub match_created_after ($$;@) { #{{{
  1647. my $page=shift;
  1648. my $testpage=shift;
  1649. if (exists $IkiWiki::pagectime{$testpage}) {
  1650. if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
  1651. return IkiWiki::SuccessReason->new("$page created after $testpage");
  1652. }
  1653. else {
  1654. return IkiWiki::FailReason->new("$page not created after $testpage");
  1655. }
  1656. }
  1657. else {
  1658. return IkiWiki::FailReason->new("$testpage has no ctime");
  1659. }
  1660. } #}}}
  1661. sub match_creation_day ($$;@) { #{{{
  1662. if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
  1663. return IkiWiki::SuccessReason->new('creation_day matched');
  1664. }
  1665. else {
  1666. return IkiWiki::FailReason->new('creation_day did not match');
  1667. }
  1668. } #}}}
  1669. sub match_creation_month ($$;@) { #{{{
  1670. if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
  1671. return IkiWiki::SuccessReason->new('creation_month matched');
  1672. }
  1673. else {
  1674. return IkiWiki::FailReason->new('creation_month did not match');
  1675. }
  1676. } #}}}
  1677. sub match_creation_year ($$;@) { #{{{
  1678. if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
  1679. return IkiWiki::SuccessReason->new('creation_year matched');
  1680. }
  1681. else {
  1682. return IkiWiki::FailReason->new('creation_year did not match');
  1683. }
  1684. } #}}}
  1685. 1