summaryrefslogtreecommitdiff
path: root/IkiWiki.pm
blob: 7a189cc8b282ac889ed8dd37ae71394e0fdafec3 (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 open qw{:utf8 :std};
  10. use vars qw{%config %links %oldlinks %pagemtime %pagectime %pagecase
  11. %renderedfiles %oldrenderedfiles %pagesources %destsources
  12. %depends %hooks %forcerebuild $gettext_obj};
  13. use Exporter q{import};
  14. our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
  15. bestlink htmllink readfile writefile pagetype srcfile pagename
  16. displaytime will_render gettext urlto targetpage
  17. add_underlay
  18. %config %links %renderedfiles %pagesources %destsources);
  19. our $VERSION = 2.00; # plugin interface version, next is ikiwiki version
  20. our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
  21. my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
  22. # Optimisation.
  23. use Memoize;
  24. memoize("abs2rel");
  25. memoize("pagespec_translate");
  26. memoize("file_pruned");
  27. sub defaultconfig () { #{{{
  28. return
  29. wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
  30. qr/\.x?html?$/, qr/\.ikiwiki-new$/,
  31. qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//,
  32. qr/(^|\/)_MTN\//,
  33. qr/\.dpkg-tmp$/],
  34. wiki_link_regexp => qr{
  35. \[\[ # beginning of link
  36. (?:
  37. ([^\]\|\n\s]+) # 1: link text
  38. \| # followed by '|'
  39. )? # optional
  40. ([^\s\]#]+) # 2: page to link to
  41. (?:
  42. \# # '#', beginning of anchor
  43. ([^\s\]]+) # 3: anchor text
  44. )? # optional
  45. \]\] # end of link
  46. }x,
  47. wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
  48. web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
  49. verbose => 0,
  50. syslog => 0,
  51. wikiname => "wiki",
  52. default_pageext => "mdwn",
  53. htmlext => "html",
  54. cgi => 0,
  55. post_commit => 0,
  56. rcs => '',
  57. notify => 0,
  58. url => '',
  59. cgiurl => '',
  60. historyurl => '',
  61. diffurl => '',
  62. rss => 0,
  63. atom => 0,
  64. discussion => 1,
  65. rebuild => 0,
  66. refresh => 0,
  67. getctime => 0,
  68. w3mmode => 0,
  69. wrapper => undef,
  70. wrappermode => undef,
  71. svnrepo => undef,
  72. svnpath => "trunk",
  73. gitorigin_branch => "origin",
  74. gitmaster_branch => "master",
  75. srcdir => undef,
  76. destdir => undef,
  77. pingurl => [],
  78. templatedir => "$installdir/share/ikiwiki/templates",
  79. underlaydir => "$installdir/share/ikiwiki/basewiki",
  80. underlaydirs => [],
  81. setup => undef,
  82. adminuser => undef,
  83. adminemail => undef,
  84. plugin => [qw{mdwn inline htmlscrubber passwordauth openid signinedit
  85. lockedit conditional}],
  86. libdir => undef,
  87. timeformat => '%c',
  88. locale => undef,
  89. sslcookie => 0,
  90. httpauth => 0,
  91. userdir => "",
  92. usedirs => 1,
  93. numbacklinks => 10,
  94. account_creation_password => "",
  95. } #}}}
  96. sub checkconfig () { #{{{
  97. # locale stuff; avoid LC_ALL since it overrides everything
  98. if (defined $ENV{LC_ALL}) {
  99. $ENV{LANG} = $ENV{LC_ALL};
  100. delete $ENV{LC_ALL};
  101. }
  102. if (defined $config{locale}) {
  103. if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
  104. $ENV{LANG}=$config{locale};
  105. $gettext_obj=undef;
  106. }
  107. }
  108. if ($config{w3mmode}) {
  109. eval q{use Cwd q{abs_path}};
  110. error($@) if $@;
  111. $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
  112. $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
  113. $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
  114. unless $config{cgiurl} =~ m!file:///!;
  115. $config{url}="file://".$config{destdir};
  116. }
  117. if ($config{cgi} && ! length $config{url}) {
  118. error(gettext("Must specify url to wiki with --url when using --cgi"));
  119. }
  120. $config{wikistatedir}="$config{srcdir}/.ikiwiki"
  121. unless exists $config{wikistatedir};
  122. if ($config{rcs}) {
  123. eval qq{use IkiWiki::Rcs::$config{rcs}};
  124. if ($@) {
  125. error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
  126. }
  127. }
  128. else {
  129. require IkiWiki::Rcs::Stub;
  130. }
  131. run_hooks(checkconfig => sub { shift->() });
  132. return 1;
  133. } #}}}
  134. sub loadplugins () { #{{{
  135. if (defined $config{libdir}) {
  136. unshift @INC, possibly_foolish_untaint($config{libdir});
  137. }
  138. loadplugin($_) foreach @{$config{plugin}};
  139. run_hooks(getopt => sub { shift->() });
  140. if (grep /^-/, @ARGV) {
  141. print STDERR "Unknown option: $_\n"
  142. foreach grep /^-/, @ARGV;
  143. usage();
  144. }
  145. return 1;
  146. } #}}}
  147. sub loadplugin ($) { #{{{
  148. my $plugin=shift;
  149. return if grep { $_ eq $plugin} @{$config{disable_plugins}};
  150. foreach my $dir (defined $config{libdir} ? possibly_foolish_untaint($config{libdir}) : undef,
  151. "$installdir/lib/ikiwiki") {
  152. if (defined $dir && -x "$dir/plugins/$plugin") {
  153. require IkiWiki::Plugin::external;
  154. import IkiWiki::Plugin::external "$dir/plugins/$plugin";
  155. return 1;
  156. }
  157. }
  158. my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
  159. eval qq{use $mod};
  160. if ($@) {
  161. error("Failed to load plugin $mod: $@");
  162. }
  163. return 1;
  164. } #}}}
  165. sub error ($;$) { #{{{
  166. my $message=shift;
  167. my $cleaner=shift;
  168. if ($config{cgi}) {
  169. print "Content-type: text/html\n\n";
  170. print misctemplate(gettext("Error"),
  171. "<p>".gettext("Error").": $message</p>");
  172. }
  173. log_message('err' => $message) if $config{syslog};
  174. if (defined $cleaner) {
  175. $cleaner->();
  176. }
  177. die $message."\n";
  178. } #}}}
  179. sub debug ($) { #{{{
  180. return unless $config{verbose};
  181. return log_message(debug => @_);
  182. } #}}}
  183. my $log_open=0;
  184. sub log_message ($$) { #{{{
  185. my $type=shift;
  186. if ($config{syslog}) {
  187. require Sys::Syslog;
  188. if (! $log_open) {
  189. Sys::Syslog::setlogsock('unix');
  190. Sys::Syslog::openlog('ikiwiki', '', 'user');
  191. $log_open=1;
  192. }
  193. return eval {
  194. Sys::Syslog::syslog($type, "[$config{wikiname}] %s", join(" ", @_));
  195. };
  196. }
  197. elsif (! $config{cgi}) {
  198. return print "@_\n";
  199. }
  200. else {
  201. return print STDERR "@_\n";
  202. }
  203. } #}}}
  204. sub possibly_foolish_untaint ($) { #{{{
  205. my $tainted=shift;
  206. my ($untainted)=$tainted=~/(.*)/s;
  207. return $untainted;
  208. } #}}}
  209. sub basename ($) { #{{{
  210. my $file=shift;
  211. $file=~s!.*/+!!;
  212. return $file;
  213. } #}}}
  214. sub dirname ($) { #{{{
  215. my $file=shift;
  216. $file=~s!/*[^/]+$!!;
  217. return $file;
  218. } #}}}
  219. sub pagetype ($) { #{{{
  220. my $page=shift;
  221. if ($page =~ /\.([^.]+)$/) {
  222. return $1 if exists $hooks{htmlize}{$1};
  223. }
  224. return;
  225. } #}}}
  226. sub pagename ($) { #{{{
  227. my $file=shift;
  228. my $type=pagetype($file);
  229. my $page=$file;
  230. $page=~s/\Q.$type\E*$// if defined $type;
  231. return $page;
  232. } #}}}
  233. sub targetpage ($$) { #{{{
  234. my $page=shift;
  235. my $ext=shift;
  236. if (! $config{usedirs} || $page =~ /^index$/ ) {
  237. return $page.".".$ext;
  238. } else {
  239. return $page."/index.".$ext;
  240. }
  241. } #}}}
  242. sub htmlpage ($) { #{{{
  243. my $page=shift;
  244. return targetpage($page, $config{htmlext});
  245. } #}}}
  246. sub srcfile ($) { #{{{
  247. my $file=shift;
  248. return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
  249. foreach my $dir (@{$config{underlaydirs}}, $config{underlaydir}) {
  250. return "$dir/$file" if -e "$dir/$file";
  251. }
  252. error("internal error: $file cannot be found in $config{srcdir} or underlay");
  253. return;
  254. } #}}}
  255. sub add_underlay ($) { #{{{
  256. my $dir=shift;
  257. if ($dir=~/^\//) {
  258. unshift @{$config{underlaydirs}}, $dir;
  259. }
  260. else {
  261. unshift @{$config{underlaydirs}}, "$config{underlaydir}/../$dir";
  262. }
  263. return 1;
  264. } #}}}
  265. sub readfile ($;$$) { #{{{
  266. my $file=shift;
  267. my $binary=shift;
  268. my $wantfd=shift;
  269. if (-l $file) {
  270. error("cannot read a symlink ($file)");
  271. }
  272. local $/=undef;
  273. open (my $in, "<", $file) || error("failed to read $file: $!");
  274. binmode($in) if ($binary);
  275. return \*$in if $wantfd;
  276. my $ret=<$in>;
  277. close $in || error("failed to read $file: $!");
  278. return $ret;
  279. } #}}}
  280. sub writefile ($$$;$$) { #{{{
  281. my $file=shift; # can include subdirs
  282. my $destdir=shift; # directory to put file in
  283. my $content=shift;
  284. my $binary=shift;
  285. my $writer=shift;
  286. my $test=$file;
  287. while (length $test) {
  288. if (-l "$destdir/$test") {
  289. error("cannot write to a symlink ($test)");
  290. }
  291. $test=dirname($test);
  292. }
  293. my $newfile="$destdir/$file.ikiwiki-new";
  294. if (-l $newfile) {
  295. error("cannot write to a symlink ($newfile)");
  296. }
  297. my $dir=dirname($newfile);
  298. if (! -d $dir) {
  299. my $d="";
  300. foreach my $s (split(m!/+!, $dir)) {
  301. $d.="$s/";
  302. if (! -d $d) {
  303. mkdir($d) || error("failed to create directory $d: $!");
  304. }
  305. }
  306. }
  307. my $cleanup = sub { unlink($newfile) };
  308. open (my $out, '>', $newfile) || error("failed to write $newfile: $!", $cleanup);
  309. binmode($out) if ($binary);
  310. if ($writer) {
  311. $writer->(\*$out, $cleanup);
  312. }
  313. else {
  314. print $out $content or error("failed writing to $newfile: $!", $cleanup);
  315. }
  316. close $out || error("failed saving $newfile: $!", $cleanup);
  317. rename($newfile, "$destdir/$file") ||
  318. error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
  319. return 1;
  320. } #}}}
  321. my %cleared;
  322. sub will_render ($$;$) { #{{{
  323. my $page=shift;
  324. my $dest=shift;
  325. my $clear=shift;
  326. # Important security check.
  327. if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
  328. ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
  329. error("$config{destdir}/$dest independently created, not overwriting with version from $page");
  330. }
  331. if (! $clear || $cleared{$page}) {
  332. $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
  333. }
  334. else {
  335. foreach my $old (@{$renderedfiles{$page}}) {
  336. delete $destsources{$old};
  337. }
  338. $renderedfiles{$page}=[$dest];
  339. $cleared{$page}=1;
  340. }
  341. $destsources{$dest}=$page;
  342. return 1;
  343. } #}}}
  344. sub bestlink ($$) { #{{{
  345. my $page=shift;
  346. my $link=shift;
  347. my $cwd=$page;
  348. if ($link=~s/^\/+//) {
  349. # absolute links
  350. $cwd="";
  351. }
  352. do {
  353. my $l=$cwd;
  354. $l.="/" if length $l;
  355. $l.=$link;
  356. if (exists $links{$l}) {
  357. return $l;
  358. }
  359. elsif (exists $pagecase{lc $l}) {
  360. return $pagecase{lc $l};
  361. }
  362. } while $cwd=~s!/?[^/]+$!!;
  363. if (length $config{userdir}) {
  364. my $l = "$config{userdir}/".lc($link);
  365. if (exists $links{$l}) {
  366. return $l;
  367. }
  368. elsif (exists $pagecase{lc $l}) {
  369. return $pagecase{lc $l};
  370. }
  371. }
  372. #print STDERR "warning: page $page, broken link: $link\n";
  373. return "";
  374. } #}}}
  375. sub isinlinableimage ($) { #{{{
  376. my $file=shift;
  377. return $file =~ /\.(png|gif|jpg|jpeg)$/i;
  378. } #}}}
  379. sub pagetitle ($;$) { #{{{
  380. my $page=shift;
  381. my $unescaped=shift;
  382. if ($unescaped) {
  383. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : chr($2)/eg;
  384. }
  385. else {
  386. $page=~s/(__(\d+)__|_)/$1 eq '_' ? ' ' : "&#$2;"/eg;
  387. }
  388. return $page;
  389. } #}}}
  390. sub titlepage ($) { #{{{
  391. my $title=shift;
  392. $title=~s/([^-[:alnum:]:+\/.])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  393. return $title;
  394. } #}}}
  395. sub linkpage ($) { #{{{
  396. my $link=shift;
  397. $link=~s/([^-[:alnum:]:+\/._])/$1 eq ' ' ? '_' : "__".ord($1)."__"/eg;
  398. return $link;
  399. } #}}}
  400. sub cgiurl (@) { #{{{
  401. my %params=@_;
  402. return $config{cgiurl}."?".
  403. join("&amp;", map $_."=".uri_escape_utf8($params{$_}), keys %params);
  404. } #}}}
  405. sub baseurl (;$) { #{{{
  406. my $page=shift;
  407. return "$config{url}/" if ! defined $page;
  408. $page=htmlpage($page);
  409. $page=~s/[^\/]+$//;
  410. $page=~s/[^\/]+\//..\//g;
  411. return $page;
  412. } #}}}
  413. sub abs2rel ($$) { #{{{
  414. # Work around very innefficient behavior in File::Spec if abs2rel
  415. # is passed two relative paths. It's much faster if paths are
  416. # absolute! (Debian bug #376658; fixed in debian unstable now)
  417. my $path="/".shift;
  418. my $base="/".shift;
  419. require File::Spec;
  420. my $ret=File::Spec->abs2rel($path, $base);
  421. $ret=~s/^// if defined $ret;
  422. return $ret;
  423. } #}}}
  424. sub displaytime ($) { #{{{
  425. my $time=shift;
  426. # strftime doesn't know about encodings, so make sure
  427. # its output is properly treated as utf8
  428. return decode_utf8(POSIX::strftime(
  429. $config{timeformat}, localtime($time)));
  430. } #}}}
  431. sub beautify_url ($) { #{{{
  432. my $url=shift;
  433. $url =~ s!/index.$config{htmlext}$!/!;
  434. $url =~ s!^$!./!; # Browsers don't like empty links...
  435. return $url;
  436. } #}}}
  437. sub urlto ($$) { #{{{
  438. my $to=shift;
  439. my $from=shift;
  440. if (! length $to) {
  441. return beautify_url(baseurl($from));
  442. }
  443. if (! $destsources{$to}) {
  444. $to=htmlpage($to);
  445. }
  446. my $link = abs2rel($to, dirname(htmlpage($from)));
  447. return beautify_url($link);
  448. } #}}}
  449. sub htmllink ($$$;@) { #{{{
  450. my $lpage=shift; # the page doing the linking
  451. my $page=shift; # the page that will contain the link (different for inline)
  452. my $link=shift;
  453. my %opts=@_;
  454. my $bestlink;
  455. if (! $opts{forcesubpage}) {
  456. $bestlink=bestlink($lpage, $link);
  457. }
  458. else {
  459. $bestlink="$lpage/".lc($link);
  460. }
  461. my $linktext;
  462. if (defined $opts{linktext}) {
  463. $linktext=$opts{linktext};
  464. }
  465. else {
  466. $linktext=pagetitle(basename($link));
  467. }
  468. return "<span class=\"selflink\">$linktext</span>"
  469. if length $bestlink && $page eq $bestlink;
  470. if (! $destsources{$bestlink}) {
  471. $bestlink=htmlpage($bestlink);
  472. if (! $destsources{$bestlink}) {
  473. return $linktext unless length $config{cgiurl};
  474. return "<span><a href=\"".
  475. cgiurl(
  476. do => "create",
  477. page => pagetitle(lc($link), 1),
  478. from => $lpage
  479. ).
  480. "\">?</a>$linktext</span>"
  481. }
  482. }
  483. $bestlink=abs2rel($bestlink, dirname(htmlpage($page)));
  484. $bestlink=beautify_url($bestlink);
  485. if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
  486. return "<img src=\"$bestlink\" alt=\"$linktext\" />";
  487. }
  488. if (defined $opts{anchor}) {
  489. $bestlink.="#".$opts{anchor};
  490. }
  491. my @attrs;
  492. if (defined $opts{rel}) {
  493. push @attrs, ' rel="'.$opts{rel}.'"';
  494. }
  495. if (defined $opts{class}) {
  496. push @attrs, ' class="'.$opts{class}.'"';
  497. }
  498. return "<a href=\"$bestlink\"@attrs>$linktext</a>";
  499. } #}}}
  500. sub htmlize ($$$) { #{{{
  501. my $page=shift;
  502. my $type=shift;
  503. my $content=shift;
  504. if (exists $hooks{htmlize}{$type}) {
  505. $content=$hooks{htmlize}{$type}{call}->(
  506. page => $page,
  507. content => $content,
  508. );
  509. }
  510. else {
  511. error("htmlization of $type not supported");
  512. }
  513. run_hooks(sanitize => sub {
  514. $content=shift->(
  515. page => $page,
  516. content => $content,
  517. );
  518. });
  519. return $content;
  520. } #}}}
  521. sub linkify ($$$) { #{{{
  522. my $lpage=shift; # the page containing the links
  523. my $page=shift; # the page the link will end up on (different for inline)
  524. my $content=shift;
  525. $content =~ s{(\\?)$config{wiki_link_regexp}}{
  526. defined $2
  527. ? ( $1
  528. ? "[[$2|$3".($4 ? "#$4" : "")."]]"
  529. : htmllink($lpage, $page, linkpage($3),
  530. anchor => $4, linktext => pagetitle($2)))
  531. : ( $1
  532. ? "[[$3".($4 ? "#$4" : "")."]]"
  533. : htmllink($lpage, $page, linkpage($3),
  534. anchor => $4))
  535. }eg;
  536. return $content;
  537. } #}}}
  538. my %preprocessing;
  539. our $preprocess_preview=0;
  540. sub preprocess ($$$;$$) { #{{{
  541. my $page=shift; # the page the data comes from
  542. my $destpage=shift; # the page the data will appear in (different for inline)
  543. my $content=shift;
  544. my $scan=shift;
  545. my $preview=shift;
  546. # Using local because it needs to be set within any nested calls
  547. # of this function.
  548. local $preprocess_preview=$preview if defined $preview;
  549. my $handle=sub {
  550. my $escape=shift;
  551. my $command=shift;
  552. my $params=shift;
  553. if (length $escape) {
  554. return "[[$command $params]]";
  555. }
  556. elsif (exists $hooks{preprocess}{$command}) {
  557. return "" if $scan && ! $hooks{preprocess}{$command}{scan};
  558. # Note: preserve order of params, some plugins may
  559. # consider it significant.
  560. my @params;
  561. while ($params =~ m{
  562. (?:(\w+)=)? # 1: named parameter key?
  563. (?:
  564. """(.*?)""" # 2: triple-quoted value
  565. |
  566. "([^"]+)" # 3: single-quoted value
  567. |
  568. (\S+) # 4: unquoted value
  569. )
  570. (?:\s+|$) # delimiter to next param
  571. }sgx) {
  572. my $key=$1;
  573. my $val;
  574. if (defined $2) {
  575. $val=$2;
  576. $val=~s/\r\n/\n/mg;
  577. $val=~s/^\n+//g;
  578. $val=~s/\n+$//g;
  579. }
  580. elsif (defined $3) {
  581. $val=$3;
  582. }
  583. elsif (defined $4) {
  584. $val=$4;
  585. }
  586. if (defined $key) {
  587. push @params, $key, $val;
  588. }
  589. else {
  590. push @params, $val, '';
  591. }
  592. }
  593. if ($preprocessing{$page}++ > 3) {
  594. # Avoid loops of preprocessed pages preprocessing
  595. # other pages that preprocess them, etc.
  596. #translators: The first parameter is a
  597. #translators: preprocessor directive name,
  598. #translators: the second a page name, the
  599. #translators: third a number.
  600. return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
  601. $command, $page, $preprocessing{$page}).
  602. "]]";
  603. }
  604. my $ret=$hooks{preprocess}{$command}{call}->(
  605. @params,
  606. page => $page,
  607. destpage => $destpage,
  608. preview => $preprocess_preview,
  609. );
  610. $preprocessing{$page}--;
  611. return $ret;
  612. }
  613. else {
  614. return "[[$command $params]]";
  615. }
  616. };
  617. $content =~ s{
  618. (\\?) # 1: escape?
  619. \[\[ # directive open
  620. (\w+) # 2: command
  621. \s+
  622. ( # 3: the parameters..
  623. (?:
  624. (?:\w+=)? # named parameter key?
  625. (?:
  626. """.*?""" # triple-quoted value
  627. |
  628. "[^"]+" # single-quoted value
  629. |
  630. [^\s\]]+ # unquoted value
  631. )
  632. \s* # whitespace or end
  633. # of directive
  634. )
  635. *) # 0 or more parameters
  636. \]\] # directive closed
  637. }{$handle->($1, $2, $3)}sexg;
  638. return $content;
  639. } #}}}
  640. sub filter ($$$) { #{{{
  641. my $page=shift;
  642. my $destpage=shift;
  643. my $content=shift;
  644. run_hooks(filter => sub {
  645. $content=shift->(page => $page, destpage => $destpage,
  646. content => $content);
  647. });
  648. return $content;
  649. } #}}}
  650. sub indexlink () { #{{{
  651. return "<a href=\"$config{url}\">$config{wikiname}</a>";
  652. } #}}}
  653. my $wikilock;
  654. sub lockwiki (;$) { #{{{
  655. my $wait=@_ ? shift : 1;
  656. # Take an exclusive lock on the wiki to prevent multiple concurrent
  657. # run issues. The lock will be dropped on program exit.
  658. if (! -d $config{wikistatedir}) {
  659. mkdir($config{wikistatedir});
  660. }
  661. open($wikilock, '>', "$config{wikistatedir}/lockfile") ||
  662. error ("cannot write to $config{wikistatedir}/lockfile: $!");
  663. if (! flock($wikilock, 2 | 4)) { # LOCK_EX | LOCK_NB
  664. if ($wait) {
  665. debug("wiki seems to be locked, waiting for lock");
  666. my $wait=600; # arbitrary, but don't hang forever to
  667. # prevent process pileup
  668. for (1..$wait) {
  669. return if flock($wikilock, 2 | 4);
  670. sleep 1;
  671. }
  672. error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
  673. }
  674. else {
  675. return 0;
  676. }
  677. }
  678. return 1;
  679. } #}}}
  680. sub unlockwiki () { #{{{
  681. return close($wikilock) if $wikilock;
  682. return;
  683. } #}}}
  684. my $commitlock;
  685. sub commit_hook_enabled () { #{{{
  686. open($commitlock, '+>', "$config{wikistatedir}/commitlock") ||
  687. error("cannot write to $config{wikistatedir}/commitlock: $!");
  688. if (! flock($commitlock, 1 | 4)) { # LOCK_SH | LOCK_NB to test
  689. close($commitlock) || error("failed closing commitlock: $!");
  690. return 0;
  691. }
  692. close($commitlock) || error("failed closing commitlock: $!");
  693. return 1;
  694. } #}}}
  695. sub disable_commit_hook () { #{{{
  696. open($commitlock, '>', "$config{wikistatedir}/commitlock") ||
  697. error("cannot write to $config{wikistatedir}/commitlock: $!");
  698. if (! flock($commitlock, 2)) { # LOCK_EX
  699. error("failed to get commit lock");
  700. }
  701. return 1;
  702. } #}}}
  703. sub enable_commit_hook () { #{{{
  704. return close($commitlock) if $commitlock;
  705. return;
  706. } #}}}
  707. sub loadindex () { #{{{
  708. %oldrenderedfiles=%pagectime=();
  709. if (! $config{rebuild}) {
  710. %pagesources=%pagemtime=%oldlinks=%links=%depends=
  711. %destsources=%renderedfiles=%pagecase=();
  712. }
  713. open (my $in, "<", "$config{wikistatedir}/index") || return;
  714. while (<$in>) {
  715. $_=possibly_foolish_untaint($_);
  716. chomp;
  717. my %items;
  718. $items{link}=[];
  719. $items{dest}=[];
  720. foreach my $i (split(/ /, $_)) {
  721. my ($item, $val)=split(/=/, $i, 2);
  722. push @{$items{$item}}, decode_entities($val);
  723. }
  724. next unless exists $items{src}; # skip bad lines for now
  725. my $page=pagename($items{src}[0]);
  726. if (! $config{rebuild}) {
  727. $pagesources{$page}=$items{src}[0];
  728. $pagemtime{$page}=$items{mtime}[0];
  729. $oldlinks{$page}=[@{$items{link}}];
  730. $links{$page}=[@{$items{link}}];
  731. $depends{$page}=$items{depends}[0] if exists $items{depends};
  732. $destsources{$_}=$page foreach @{$items{dest}};
  733. $renderedfiles{$page}=[@{$items{dest}}];
  734. $pagecase{lc $page}=$page;
  735. }
  736. $oldrenderedfiles{$page}=[@{$items{dest}}];
  737. $pagectime{$page}=$items{ctime}[0];
  738. }
  739. return close($in);
  740. } #}}}
  741. sub saveindex () { #{{{
  742. run_hooks(savestate => sub { shift->() });
  743. if (! -d $config{wikistatedir}) {
  744. mkdir($config{wikistatedir});
  745. }
  746. my $newfile="$config{wikistatedir}/index.new";
  747. my $cleanup = sub { unlink($newfile) };
  748. open (my $out, '>', $newfile) || error("cannot write to $newfile: $!", $cleanup);
  749. foreach my $page (keys %pagemtime) {
  750. next unless $pagemtime{$page};
  751. my $line="mtime=$pagemtime{$page} ".
  752. "ctime=$pagectime{$page} ".
  753. "src=$pagesources{$page}";
  754. $line.=" dest=$_" foreach @{$renderedfiles{$page}};
  755. my %count;
  756. $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
  757. if (exists $depends{$page}) {
  758. $line.=" depends=".encode_entities($depends{$page}, " \t\n");
  759. }
  760. print $out $line."\n" || error("failed writing to $newfile: $!", $cleanup);
  761. }
  762. close $out || error("failed saving to $newfile: $!", $cleanup);
  763. rename($newfile, "$config{wikistatedir}/index") ||
  764. error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
  765. return 1;
  766. } #}}}
  767. sub template_file ($) { #{{{
  768. my $template=shift;
  769. foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
  770. return "$dir/$template" if -e "$dir/$template";
  771. }
  772. return;
  773. } #}}}
  774. sub template_params (@) { #{{{
  775. my $filename=template_file(shift);
  776. if (! defined $filename) {
  777. return if wantarray;
  778. return "";
  779. }
  780. my @ret=(
  781. filter => sub {
  782. my $text_ref = shift;
  783. ${$text_ref} = decode_utf8(${$text_ref});
  784. },
  785. filename => $filename,
  786. loop_context_vars => 1,
  787. die_on_bad_params => 0,
  788. @_
  789. );
  790. return wantarray ? @ret : {@ret};
  791. } #}}}
  792. sub template ($;@) { #{{{
  793. require HTML::Template;
  794. return HTML::Template->new(template_params(@_));
  795. } #}}}
  796. sub misctemplate ($$;@) { #{{{
  797. my $title=shift;
  798. my $pagebody=shift;
  799. my $template=template("misc.tmpl");
  800. $template->param(
  801. title => $title,
  802. indexlink => indexlink(),
  803. wikiname => $config{wikiname},
  804. pagebody => $pagebody,
  805. baseurl => baseurl(),
  806. @_,
  807. );
  808. run_hooks(pagetemplate => sub {
  809. shift->(page => "", destpage => "", template => $template);
  810. });
  811. return $template->output;
  812. }#}}}
  813. sub hook (@) { # {{{
  814. my %param=@_;
  815. if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
  816. error 'hook requires type, call, and id parameters';
  817. }
  818. return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
  819. $hooks{$param{type}}{$param{id}}=\%param;
  820. return 1;
  821. } # }}}
  822. sub run_hooks ($$) { # {{{
  823. # Calls the given sub for each hook of the given type,
  824. # passing it the hook function to call.
  825. my $type=shift;
  826. my $sub=shift;
  827. if (exists $hooks{$type}) {
  828. my @deferred;
  829. foreach my $id (keys %{$hooks{$type}}) {
  830. if ($hooks{$type}{$id}{last}) {
  831. push @deferred, $id;
  832. next;
  833. }
  834. $sub->($hooks{$type}{$id}{call});
  835. }
  836. foreach my $id (@deferred) {
  837. $sub->($hooks{$type}{$id}{call});
  838. }
  839. }
  840. return 1;
  841. } #}}}
  842. sub globlist_to_pagespec ($) { #{{{
  843. my @globlist=split(' ', shift);
  844. my (@spec, @skip);
  845. foreach my $glob (@globlist) {
  846. if ($glob=~/^!(.*)/) {
  847. push @skip, $glob;
  848. }
  849. else {
  850. push @spec, $glob;
  851. }
  852. }
  853. my $spec=join(' or ', @spec);
  854. if (@skip) {
  855. my $skip=join(' and ', @skip);
  856. if (length $spec) {
  857. $spec="$skip and ($spec)";
  858. }
  859. else {
  860. $spec=$skip;
  861. }
  862. }
  863. return $spec;
  864. } #}}}
  865. sub is_globlist ($) { #{{{
  866. my $s=shift;
  867. return ( $s =~ /[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or" );
  868. } #}}}
  869. sub safequote ($) { #{{{
  870. my $s=shift;
  871. $s=~s/[{}]//g;
  872. return "q{$s}";
  873. } #}}}
  874. sub add_depends ($$) { #{{{
  875. my $page=shift;
  876. my $pagespec=shift;
  877. if (! exists $depends{$page}) {
  878. $depends{$page}=$pagespec;
  879. }
  880. else {
  881. $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
  882. }
  883. return 1;
  884. } # }}}
  885. sub file_pruned ($$) { #{{{
  886. require File::Spec;
  887. my $file=File::Spec->canonpath(shift);
  888. my $base=File::Spec->canonpath(shift);
  889. $file =~ s#^\Q$base\E/*##;
  890. my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
  891. return $file =~ m/$regexp/;
  892. } #}}}
  893. sub gettext { #{{{
  894. # Only use gettext in the rare cases it's needed.
  895. if ((exists $ENV{LANG} && length $ENV{LANG}) ||
  896. (exists $ENV{LC_ALL} && length $ENV{LC_ALL}) ||
  897. (exists $ENV{LC_MESSAGES} && length $ENV{LC_MESSAGES})) {
  898. if (! $gettext_obj) {
  899. $gettext_obj=eval q{
  900. use Locale::gettext q{textdomain};
  901. Locale::gettext->domain('ikiwiki')
  902. };
  903. if ($@) {
  904. print STDERR "$@";
  905. $gettext_obj=undef;
  906. return shift;
  907. }
  908. }
  909. return $gettext_obj->get(shift);
  910. }
  911. else {
  912. return shift;
  913. }
  914. } #}}}
  915. sub pagespec_merge ($$) { #{{{
  916. my $a=shift;
  917. my $b=shift;
  918. return $a if $a eq $b;
  919. # Support for old-style GlobLists.
  920. if (is_globlist($a)) {
  921. $a=globlist_to_pagespec($a);
  922. }
  923. if (is_globlist($b)) {
  924. $b=globlist_to_pagespec($b);
  925. }
  926. return "($a) or ($b)";
  927. } #}}}
  928. sub pagespec_translate ($) { #{{{
  929. # This assumes that $page is in scope in the function
  930. # that evalulates the translated pagespec code.
  931. my $spec=shift;
  932. # Support for old-style GlobLists.
  933. if (is_globlist($spec)) {
  934. $spec=globlist_to_pagespec($spec);
  935. }
  936. # Convert spec to perl code.
  937. my $code="";
  938. while ($spec=~m{
  939. \s* # ignore whitespace
  940. ( # 1: match a single word
  941. \! # !
  942. |
  943. \( # (
  944. |
  945. \) # )
  946. |
  947. \w+\([^\)]*\) # command(params)
  948. |
  949. [^\s()]+ # any other text
  950. )
  951. \s* # ignore whitespace
  952. }igx) {
  953. my $word=$1;
  954. if (lc $word eq 'and') {
  955. $code.=' &&';
  956. }
  957. elsif (lc $word eq 'or') {
  958. $code.=' ||';
  959. }
  960. elsif ($word eq "(" || $word eq ")" || $word eq "!") {
  961. $code.=' '.$word;
  962. }
  963. elsif ($word =~ /^(\w+)\((.*)\)$/) {
  964. if (exists $IkiWiki::PageSpec::{"match_$1"}) {
  965. $code.="IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).", \@params)";
  966. }
  967. else {
  968. $code.=' 0';
  969. }
  970. }
  971. else {
  972. $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \@params)";
  973. }
  974. }
  975. return $code;
  976. } #}}}
  977. sub pagespec_match ($$;@) { #{{{
  978. my $page=shift;
  979. my $spec=shift;
  980. my @params=@_;
  981. # Backwards compatability with old calling convention.
  982. if (@params == 1) {
  983. unshift @params, 'location';
  984. }
  985. my $ret=eval pagespec_translate($spec);
  986. return IkiWiki::FailReason->new('syntax error') if $@;
  987. return $ret;
  988. } #}}}
  989. package IkiWiki::FailReason;
  990. use overload ( #{{{
  991. '""' => sub { ${$_[0]} },
  992. '0+' => sub { 0 },
  993. '!' => sub { bless $_[0], 'IkiWiki::SuccessReason'},
  994. fallback => 1,
  995. ); #}}}
  996. sub new { #{{{
  997. return bless \$_[1], $_[0];
  998. } #}}}
  999. package IkiWiki::SuccessReason;
  1000. use overload ( #{{{
  1001. '""' => sub { ${$_[0]} },
  1002. '0+' => sub { 1 },
  1003. '!' => sub { bless $_[0], 'IkiWiki::FailReason'},
  1004. fallback => 1,
  1005. ); #}}}
  1006. sub new { #{{{
  1007. return bless \$_[1], $_[0];
  1008. }; #}}}
  1009. package IkiWiki::PageSpec;
  1010. sub match_glob ($$;@) { #{{{
  1011. my $page=shift;
  1012. my $glob=shift;
  1013. my %params=@_;
  1014. my $from=exists $params{location} ? $params{location} : '';
  1015. # relative matching
  1016. if ($glob =~ m!^\./!) {
  1017. $from=~s#/?[^/]+$##;
  1018. $glob=~s#^\./##;
  1019. $glob="$from/$glob" if length $from;
  1020. }
  1021. # turn glob into safe regexp
  1022. $glob=quotemeta($glob);
  1023. $glob=~s/\\\*/.*/g;
  1024. $glob=~s/\\\?/./g;
  1025. if ($page=~/^$glob$/i) {
  1026. return IkiWiki::SuccessReason->new("$glob matches $page");
  1027. }
  1028. else {
  1029. return IkiWiki::FailReason->new("$glob does not match $page");
  1030. }
  1031. } #}}}
  1032. sub match_link ($$;@) { #{{{
  1033. my $page=shift;
  1034. my $link=lc(shift);
  1035. my %params=@_;
  1036. my $from=exists $params{location} ? $params{location} : '';
  1037. # relative matching
  1038. if ($link =~ m!^\.! && defined $from) {
  1039. $from=~s#/?[^/]+$##;
  1040. $link=~s#^\./##;
  1041. $link="$from/$link" if length $from;
  1042. }
  1043. my $links = $IkiWiki::links{$page};
  1044. return IkiWiki::FailReason->new("$page has no links") unless $links && @{$links};
  1045. my $bestlink = IkiWiki::bestlink($from, $link);
  1046. foreach my $p (@{$links}) {
  1047. if (length $bestlink) {
  1048. return IkiWiki::SuccessReason->new("$page links to $link")
  1049. if $bestlink eq IkiWiki::bestlink($page, $p);
  1050. }
  1051. else {
  1052. return IkiWiki::SuccessReason->new("$page links to page $p matching $link")
  1053. if match_glob($p, $link, %params);
  1054. }
  1055. }
  1056. return IkiWiki::FailReason->new("$page does not link to $link");
  1057. } #}}}
  1058. sub match_backlink ($$;@) { #{{{
  1059. return match_link($_[1], $_[0], @_);
  1060. } #}}}
  1061. sub match_created_before ($$;@) { #{{{
  1062. my $page=shift;
  1063. my $testpage=shift;
  1064. if (exists $IkiWiki::pagectime{$testpage}) {
  1065. if ($IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage}) {
  1066. return IkiWiki::SuccessReason->new("$page created before $testpage");
  1067. }
  1068. else {
  1069. return IkiWiki::FailReason->new("$page not created before $testpage");
  1070. }
  1071. }
  1072. else {
  1073. return IkiWiki::FailReason->new("$testpage has no ctime");
  1074. }
  1075. } #}}}
  1076. sub match_created_after ($$;@) { #{{{
  1077. my $page=shift;
  1078. my $testpage=shift;
  1079. if (exists $IkiWiki::pagectime{$testpage}) {
  1080. if ($IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage}) {
  1081. return IkiWiki::SuccessReason->new("$page created after $testpage");
  1082. }
  1083. else {
  1084. return IkiWiki::FailReason->new("$page not created after $testpage");
  1085. }
  1086. }
  1087. else {
  1088. return IkiWiki::FailReason->new("$testpage has no ctime");
  1089. }
  1090. } #}}}
  1091. sub match_creation_day ($$;@) { #{{{
  1092. if ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift) {
  1093. return IkiWiki::SuccessReason->new('creation_day matched');
  1094. }
  1095. else {
  1096. return IkiWiki::FailReason->new('creation_day did not match');
  1097. }
  1098. } #}}}
  1099. sub match_creation_month ($$;@) { #{{{
  1100. if ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift) {
  1101. return IkiWiki::SuccessReason->new('creation_month matched');
  1102. }
  1103. else {
  1104. return IkiWiki::FailReason->new('creation_month did not match');
  1105. }
  1106. } #}}}
  1107. sub match_creation_year ($$;@) { #{{{
  1108. if ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift) {
  1109. return IkiWiki::SuccessReason->new('creation_year matched');
  1110. }
  1111. else {
  1112. return IkiWiki::FailReason->new('creation_year did not match');
  1113. }
  1114. } #}}}
  1115. sub match_user ($$;@) { #{{{
  1116. shift;
  1117. my $user=shift;
  1118. my %params=@_;
  1119. return IkiWiki::FailReason->new('cannot match user')
  1120. unless exists $params{user};
  1121. if ($user eq $params{user}) {
  1122. return IkiWiki::SuccessReason->new("user is $user")
  1123. }
  1124. else {
  1125. return IkiWiki::FailReason->new("user is not $user");
  1126. }
  1127. } #}}}
  1128. 1