8 use open qw{:utf8 :std};
10 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
11 %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
14 use Exporter q{import};
15 our @EXPORT = qw(hook debug error template htmlpage add_depends pagespec_match
16 bestlink htmllink readfile writefile pagetype srcfile pagename
17 displaytime will_render gettext
18 %config %links %renderedfiles %pagesources);
19 our $VERSION = 1.01; # plugin interface version
24 memoize("pagespec_translate");
25 memoize("file_pruned");
27 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
28 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
30 sub defaultconfig () { #{{{
31 wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./, qr/\.x?html?$/,
32 qr/(^|\/).svn\//, qr/.arch-ids\//, qr/{arch}\//],
33 wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
34 wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
35 web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
39 default_pageext => "mdwn",
62 templatedir => "$installdir/share/ikiwiki/templates",
63 underlaydir => "$installdir/share/ikiwiki/basewiki",
67 plugin => [qw{mdwn inline htmlscrubber passwordauth}],
75 sub checkconfig () { #{{{
76 # locale stuff; avoid LC_ALL since it overrides everything
77 if (defined $ENV{LC_ALL}) {
78 $ENV{LANG} = $ENV{LC_ALL};
81 if (defined $config{locale}) {
84 $ENV{LANG} = $config{locale}
85 if POSIX::setlocale(&POSIX::LC_TIME, $config{locale});
88 if ($config{w3mmode}) {
89 eval q{use Cwd q{abs_path}};
91 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
92 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
93 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
94 unless $config{cgiurl} =~ m!file:///!;
95 $config{url}="file://".$config{destdir};
98 if ($config{cgi} && ! length $config{url}) {
99 error(gettext("Must specify url to wiki with --url when using --cgi"));
102 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
103 unless exists $config{wikistatedir};
106 eval qq{require IkiWiki::Rcs::$config{rcs}};
108 error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
112 require IkiWiki::Rcs::Stub;
115 run_hooks(checkconfig => sub { shift->() });
118 sub loadplugins () { #{{{
119 loadplugin($_) foreach @{$config{plugin}};
121 run_hooks(getopt => sub { shift->() });
122 if (grep /^-/, @ARGV) {
123 print STDERR "Unknown option: $_\n"
124 foreach grep /^-/, @ARGV;
129 sub loadplugin ($) { #{{{
132 return if grep { $_ eq $plugin} @{$config{disable_plugins}};
134 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
137 error("Failed to load plugin $mod: $@");
143 print "Content-type: text/html\n\n";
144 print misctemplate(gettext("Error"),
145 "<p>".gettext("Error").": @_</p>");
147 log_message(error => @_);
152 return unless $config{verbose};
153 log_message(debug => @_);
157 sub log_message ($$) { #{{{
160 if ($config{syslog}) {
163 Sys::Syslog::setlogsock('unix');
164 Sys::Syslog::openlog('ikiwiki', '', 'user');
168 Sys::Syslog::syslog($type, join(" ", @_));
171 elsif (! $config{cgi}) {
179 sub possibly_foolish_untaint ($) { #{{{
181 my ($untainted)=$tainted=~/(.*)/;
185 sub basename ($) { #{{{
192 sub dirname ($) { #{{{
199 sub pagetype ($) { #{{{
202 if ($page =~ /\.([^.]+)$/) {
203 return $1 if exists $hooks{htmlize}{$1};
208 sub pagename ($) { #{{{
211 my $type=pagetype($file);
213 $page=~s/\Q.$type\E*$// if defined $type;
217 sub htmlpage ($) { #{{{
220 return $page.".html";
223 sub srcfile ($) { #{{{
226 return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
227 return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
228 error("internal error: $file cannot be found");
231 sub readfile ($;$) { #{{{
236 error("cannot read a symlink ($file)");
240 open (IN, $file) || error("failed to read $file: $!");
241 binmode(IN) if ($binary);
247 sub writefile ($$$;$) { #{{{
248 my $file=shift; # can include subdirs
249 my $destdir=shift; # directory to put file in
254 while (length $test) {
255 if (-l "$destdir/$test") {
256 error("cannot write to a symlink ($test)");
258 $test=dirname($test);
261 my $dir=dirname("$destdir/$file");
264 foreach my $s (split(m!/+!, $dir)) {
267 mkdir($d) || error("failed to create directory $d: $!");
272 open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
273 binmode(OUT) if ($binary);
279 sub will_render ($$;$) { #{{{
284 # Important security check.
285 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
286 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
287 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
290 if (! $clear || $cleared{$page}) {
291 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
294 $renderedfiles{$page}=[$dest];
299 sub bestlink ($$) { #{{{
304 if ($link=~s/^\/+//) {
311 $l.="/" if length $l;
314 if (exists $links{$l}) {
317 elsif (exists $pagecase{lc $l}) {
318 return $pagecase{lc $l};
320 } while $cwd=~s!/?[^/]+$!!;
322 if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
323 return "$config{userdir}/".lc($link);
326 #print STDERR "warning: page $page, broken link: $link\n";
330 sub isinlinableimage ($) { #{{{
333 $file=~/\.(png|gif|jpg|jpeg)$/i;
336 sub pagetitle ($;$) { #{{{
341 $page=~s/__(\d+)__/chr($1)/eg;
344 $page=~s/__(\d+)__/&#$1;/g;
351 sub titlepage ($) { #{{{
354 $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
358 sub cgiurl (@) { #{{{
361 return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
364 sub baseurl (;$) { #{{{
367 return "$config{url}/" if ! defined $page;
370 $page=~s/[^\/]+\//..\//g;
374 sub abs2rel ($$) { #{{{
375 # Work around very innefficient behavior in File::Spec if abs2rel
376 # is passed two relative paths. It's much faster if paths are
377 # absolute! (Debian bug #376658; fixed in debian unstable now)
382 my $ret=File::Spec->abs2rel($path, $base);
383 $ret=~s/^// if defined $ret;
387 sub displaytime ($) { #{{{
392 # strftime doesn't know about encodings, so make sure
393 # its output is properly treated as utf8
394 return decode_utf8(POSIX::strftime(
395 $config{timeformat}, localtime($time)));
398 sub htmllink ($$$;$$$) { #{{{
399 my $lpage=shift; # the page doing the linking
400 my $page=shift; # the page that will contain the link (different for inline)
402 my $noimageinline=shift; # don't turn links into inline html images
403 my $forcesubpage=shift; # force a link to a subpage
404 my $linktext=shift; # set to force the link text to something
407 if (! $forcesubpage) {
408 $bestlink=bestlink($lpage, $link);
411 $bestlink="$lpage/".lc($link);
414 $linktext=pagetitle(basename($link)) unless defined $linktext;
416 return "<span class=\"selflink\">$linktext</span>"
417 if length $bestlink && $page eq $bestlink;
419 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
420 $bestlink=htmlpage($bestlink);
422 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
423 return $linktext unless length $config{cgiurl};
424 return "<span><a href=\"".
425 cgiurl(do => "create", page => lc($link), from => $page).
426 "\">?</a>$linktext</span>"
429 $bestlink=abs2rel($bestlink, dirname($page));
431 if (! $noimageinline && isinlinableimage($bestlink)) {
432 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
434 return "<a href=\"$bestlink\">$linktext</a>";
437 sub htmlize ($$$) { #{{{
442 if (exists $hooks{htmlize}{$type}) {
443 $content=$hooks{htmlize}{$type}{call}->(
449 error("htmlization of $type not supported");
452 run_hooks(sanitize => sub {
462 sub linkify ($$$) { #{{{
463 my $lpage=shift; # the page containing the links
464 my $page=shift; # the page the link will end up on (different for inline)
467 $content =~ s{(\\?)$config{wiki_link_regexp}}{
468 $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
469 : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3)))
476 sub preprocess ($$$;$) { #{{{
477 my $page=shift; # the page the data comes from
478 my $destpage=shift; # the page the data will appear in (different for inline)
486 if (length $escape) {
487 return "[[$command $params]]";
489 elsif (exists $hooks{preprocess}{$command}) {
490 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
491 # Note: preserve order of params, some plugins may
492 # consider it significant.
494 while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
511 push @params, $key, $val;
514 push @params, $val, '';
517 if ($preprocessing{$page}++ > 3) {
518 # Avoid loops of preprocessed pages preprocessing
519 # other pages that preprocess them, etc.
520 #translators: The first parameter is a
521 #translators: preprocessor directive name,
522 #translators: the second a page name, the
523 #translators: third a number.
524 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
525 $command, $page, $preprocessing{$page}).
528 my $ret=$hooks{preprocess}{$command}{call}->(
531 destpage => $destpage,
533 $preprocessing{$page}--;
537 return "[[$command $params]]";
541 $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
545 sub filter ($$) { #{{{
549 run_hooks(filter => sub {
550 $content=shift->(page => $page, content => $content);
556 sub indexlink () { #{{{
557 return "<a href=\"$config{url}\">$config{wikiname}</a>";
560 sub lockwiki () { #{{{
561 # Take an exclusive lock on the wiki to prevent multiple concurrent
562 # run issues. The lock will be dropped on program exit.
563 if (! -d $config{wikistatedir}) {
564 mkdir($config{wikistatedir});
566 open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
567 error ("cannot write to $config{wikistatedir}/lockfile: $!");
568 if (! flock(WIKILOCK, 2 | 4)) {
569 debug("wiki seems to be locked, waiting for lock");
570 my $wait=600; # arbitrary, but don't hang forever to
571 # prevent process pileup
573 return if flock(WIKILOCK, 2 | 4);
576 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
580 sub unlockwiki () { #{{{
584 sub loadindex () { #{{{
585 open (IN, "$config{wikistatedir}/index") || return;
587 $_=possibly_foolish_untaint($_);
592 foreach my $i (split(/ /, $_)) {
593 my ($item, $val)=split(/=/, $i, 2);
594 push @{$items{$item}}, decode_entities($val);
597 next unless exists $items{src}; # skip bad lines for now
599 my $page=pagename($items{src}[0]);
600 if (! $config{rebuild}) {
601 $pagesources{$page}=$items{src}[0];
602 $oldpagemtime{$page}=$items{mtime}[0];
603 $oldlinks{$page}=[@{$items{link}}];
604 $links{$page}=[@{$items{link}}];
605 $depends{$page}=$items{depends}[0] if exists $items{depends};
606 $renderedfiles{$page}=[@{$items{dest}}];
607 $oldrenderedfiles{$page}=[@{$items{dest}}];
608 $pagecase{lc $page}=$page;
610 $pagectime{$page}=$items{ctime}[0];
615 sub saveindex () { #{{{
616 run_hooks(savestate => sub { shift->() });
618 if (! -d $config{wikistatedir}) {
619 mkdir($config{wikistatedir});
621 open (OUT, ">$config{wikistatedir}/index") ||
622 error("cannot write to $config{wikistatedir}/index: $!");
623 foreach my $page (keys %oldpagemtime) {
624 next unless $oldpagemtime{$page};
625 my $line="mtime=$oldpagemtime{$page} ".
626 "ctime=$pagectime{$page} ".
627 "src=$pagesources{$page}";
628 $line.=" dest=$_" foreach @{$renderedfiles{$page}};
630 $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
631 if (exists $depends{$page}) {
632 $line.=" depends=".encode_entities($depends{$page}, " \t\n");
634 print OUT $line."\n";
639 sub template_params (@) { #{{{
642 require HTML::Template;
643 return filter => sub {
644 my $text_ref = shift;
645 $$text_ref=&Encode::decode_utf8($$text_ref);
647 filename => "$config{templatedir}/$filename",
648 loop_context_vars => 1,
649 die_on_bad_params => 0,
653 sub template ($;@) { #{{{
654 HTML::Template->new(template_params(@_));
657 sub misctemplate ($$;@) { #{{{
661 my $template=template("misc.tmpl");
664 indexlink => indexlink(),
665 wikiname => $config{wikiname},
666 pagebody => $pagebody,
667 baseurl => baseurl(),
670 run_hooks(pagetemplate => sub {
671 shift->(page => "", destpage => "", template => $template);
673 return $template->output;
679 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
680 error "hook requires type, call, and id parameters";
683 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
685 $hooks{$param{type}}{$param{id}}=\%param;
688 sub run_hooks ($$) { # {{{
689 # Calls the given sub for each hook of the given type,
690 # passing it the hook function to call.
694 if (exists $hooks{$type}) {
696 foreach my $id (keys %{$hooks{$type}}) {
697 if ($hooks{$type}{$id}{last}) {
701 $sub->($hooks{$type}{$id}{call});
703 foreach my $id (@deferred) {
704 $sub->($hooks{$type}{$id}{call});
709 sub globlist_to_pagespec ($) { #{{{
710 my @globlist=split(' ', shift);
713 foreach my $glob (@globlist) {
714 if ($glob=~/^!(.*)/) {
722 my $spec=join(" or ", @spec);
724 my $skip=join(" and ", @skip);
726 $spec="$skip and ($spec)";
735 sub is_globlist ($) { #{{{
737 $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
740 sub safequote ($) { #{{{
746 sub pagespec_merge ($$) { #{{{
750 return $a if $a eq $b;
752 # Support for old-style GlobLists.
753 if (is_globlist($a)) {
754 $a=globlist_to_pagespec($a);
756 if (is_globlist($b)) {
757 $b=globlist_to_pagespec($b);
760 return "($a) or ($b)";
763 sub pagespec_translate ($) { #{{{
764 # This assumes that $page is in scope in the function
765 # that evalulates the translated pagespec code.
768 # Support for old-style GlobLists.
769 if (is_globlist($spec)) {
770 $spec=globlist_to_pagespec($spec);
773 # Convert spec to perl code.
775 while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
777 if (lc $word eq "and") {
780 elsif (lc $word eq "or") {
783 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
786 elsif ($word =~ /^(link|backlink|created_before|created_after|creation_month|creation_year|creation_day)\((.+)\)$/) {
787 $code.=" match_$1(\$page, ".safequote($2).")";
790 $code.=" match_glob(\$page, ".safequote($word).")";
797 sub add_depends ($$) { #{{{
801 if (! exists $depends{$page}) {
802 $depends{$page}=$pagespec;
805 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
809 sub file_pruned ($$) { #{{{
811 my $file=File::Spec->canonpath(shift);
812 my $base=File::Spec->canonpath(shift);
813 $file=~s#^\Q$base\E/*##;
815 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
820 # Only use gettext in the rare cases it's needed.
821 # This overrides future calls of this function.
822 if (exists $ENV{LANG} || exists $ENV{LC_ALL} || exists $ENV{LC_MESSAGES}) {
823 eval q{use Locale::gettext};
824 textdomain('ikiwiki');
825 return Locale::gettext::gettext(shift);
832 sub pagespec_match ($$) { #{{{
836 return eval pagespec_translate($spec);
839 sub match_glob ($$) { #{{{
843 # turn glob into safe regexp
844 $glob=quotemeta($glob);
848 return $page=~/^$glob$/i;
851 sub match_link ($$) { #{{{
855 my $links = $links{$page} or return undef;
856 foreach my $p (@$links) {
857 return 1 if lc $p eq $link;
862 sub match_backlink ($$) { #{{{
863 match_link(pop, pop);
866 sub match_created_before ($$) { #{{{
870 if (exists $pagectime{$testpage}) {
871 return $pagectime{$page} < $pagectime{$testpage};
878 sub match_created_after ($$) { #{{{
882 if (exists $pagectime{$testpage}) {
883 return $pagectime{$page} > $pagectime{$testpage};
890 sub match_creation_day ($$) { #{{{
891 return ((gmtime($pagectime{shift()}))[3] == shift);
894 sub match_creation_month ($$) { #{{{
895 return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
898 sub match_creation_year ($$) { #{{{
899 return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);