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
18 %config %links %renderedfiles %pagesources);
19 our $VERSION = 1.01; # plugin interface version
24 memoize("pagespec_translate");
26 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
27 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
29 sub defaultconfig () { #{{{
30 wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.x?html?$|\.rss$|\.atom$|.arch-ids/|{arch}/)},
31 wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
32 wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
33 web_commit_regexp => qr/^web commit (by (.*?(?=: |$))|from (\d+\.\d+\.\d+\.\d+)):?(.*)/,
37 default_pageext => "mdwn",
60 templatedir => "$installdir/share/ikiwiki/templates",
61 underlaydir => "$installdir/share/ikiwiki/basewiki",
65 plugin => [qw{mdwn inline htmlscrubber passwordauth}],
72 sub checkconfig () { #{{{
73 # locale stuff; avoid LC_ALL since it overrides everything
74 if (defined $ENV{LC_ALL}) {
75 $ENV{LANG} = $ENV{LC_ALL};
78 if (defined $config{locale}) {
81 $ENV{LANG} = $config{locale}
82 if POSIX::setlocale(&POSIX::LC_TIME, $config{locale});
85 if ($config{w3mmode}) {
86 eval q{use Cwd q{abs_path}};
88 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
89 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
90 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
91 unless $config{cgiurl} =~ m!file:///!;
92 $config{url}="file://".$config{destdir};
95 if ($config{cgi} && ! length $config{url}) {
96 error("Must specify url to wiki with --url when using --cgi\n");
98 if (($config{rss} || $config{atom}) && ! length $config{url}) {
99 error("Must specify url to wiki with --url when using --rss or --atom\n");
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 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
135 error("Failed to load plugin $mod: $@");
141 print "Content-type: text/html\n\n";
142 print misctemplate("Error", "<p>Error: @_</p>");
144 log_message(error => @_);
149 return unless $config{verbose};
150 log_message(debug => @_);
154 sub log_message ($$) { #{{{
157 if ($config{syslog}) {
160 Sys::Syslog::setlogsock('unix');
161 Sys::Syslog::openlog('ikiwiki', '', 'user');
165 Sys::Syslog::syslog($type, join(" ", @_));
168 elsif (! $config{cgi}) {
176 sub possibly_foolish_untaint ($) { #{{{
178 my ($untainted)=$tainted=~/(.*)/;
182 sub basename ($) { #{{{
189 sub dirname ($) { #{{{
196 sub pagetype ($) { #{{{
199 if ($page =~ /\.([^.]+)$/) {
200 return $1 if exists $hooks{htmlize}{$1};
205 sub pagename ($) { #{{{
208 my $type=pagetype($file);
210 $page=~s/\Q.$type\E*$// if defined $type;
214 sub htmlpage ($) { #{{{
217 return $page.".html";
220 sub srcfile ($) { #{{{
223 return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
224 return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
225 error("internal error: $file cannot be found");
228 sub readfile ($;$) { #{{{
233 error("cannot read a symlink ($file)");
237 open (IN, $file) || error("failed to read $file: $!");
238 binmode(IN) if ($binary);
244 sub writefile ($$$;$) { #{{{
245 my $file=shift; # can include subdirs
246 my $destdir=shift; # directory to put file in
251 while (length $test) {
252 if (-l "$destdir/$test") {
253 error("cannot write to a symlink ($test)");
255 $test=dirname($test);
258 my $dir=dirname("$destdir/$file");
261 foreach my $s (split(m!/+!, $dir)) {
264 mkdir($d) || error("failed to create directory $d: $!");
269 open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
270 binmode(OUT) if ($binary);
276 sub will_render ($$;$) { #{{{
281 # Important security check.
282 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
283 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
284 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
287 if (! $clear || $cleared{$page}) {
288 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
291 $renderedfiles{$page}=[$dest];
296 sub bestlink ($$) { #{{{
303 $l.="/" if length $l;
306 if (exists $links{$l}) {
309 elsif (exists $pagecase{lc $l}) {
310 return $pagecase{lc $l};
312 } while $cwd=~s!/?[^/]+$!!;
314 #print STDERR "warning: page $page, broken link: $link\n";
318 sub isinlinableimage ($) { #{{{
321 $file=~/\.(png|gif|jpg|jpeg)$/i;
324 sub pagetitle ($) { #{{{
326 $page=~s/__(\d+)__/&#$1;/g;
331 sub titlepage ($) { #{{{
334 $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
338 sub cgiurl (@) { #{{{
341 return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
344 sub baseurl (;$) { #{{{
347 return "$config{url}/" if ! defined $page;
350 $page=~s/[^\/]+\//..\//g;
354 sub abs2rel ($$) { #{{{
355 # Work around very innefficient behavior in File::Spec if abs2rel
356 # is passed two relative paths. It's much faster if paths are
357 # absolute! (Debian bug #376658)
362 my $ret=File::Spec->abs2rel($path, $base);
363 $ret=~s/^// if defined $ret;
367 sub displaytime ($) { #{{{
372 # strftime doesn't know about encodings, so make sure
373 # its output is properly treated as utf8
374 return decode_utf8(POSIX::strftime(
375 $config{timeformat}, localtime($time)));
378 sub htmllink ($$$;$$$) { #{{{
379 my $lpage=shift; # the page doing the linking
380 my $page=shift; # the page that will contain the link (different for inline)
382 my $noimageinline=shift; # don't turn links into inline html images
383 my $forcesubpage=shift; # force a link to a subpage
384 my $linktext=shift; # set to force the link text to something
387 if (! $forcesubpage) {
388 $bestlink=bestlink($lpage, $link);
391 $bestlink="$lpage/".lc($link);
394 $linktext=pagetitle(basename($link)) unless defined $linktext;
396 return "<span class=\"selflink\">$linktext</span>"
397 if length $bestlink && $page eq $bestlink;
399 # TODO BUG: %renderedfiles may not have it, if the linked to page
400 # was also added and isn't yet rendered! Note that this bug is
401 # masked by the bug that makes all new files be rendered twice.
402 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
403 $bestlink=htmlpage($bestlink);
405 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
406 return "<span><a href=\"".
407 cgiurl(do => "create", page => lc($link), from => $page).
408 "\">?</a>$linktext</span>"
411 $bestlink=abs2rel($bestlink, dirname($page));
413 if (! $noimageinline && isinlinableimage($bestlink)) {
414 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
416 return "<a href=\"$bestlink\">$linktext</a>";
419 sub htmlize ($$$) { #{{{
424 if (exists $hooks{htmlize}{$type}) {
425 $content=$hooks{htmlize}{$type}{call}->(
431 error("htmlization of $type not supported");
434 run_hooks(sanitize => sub {
444 sub linkify ($$$) { #{{{
445 my $lpage=shift; # the page containing the links
446 my $page=shift; # the page the link will end up on (different for inline)
449 $content =~ s{(\\?)$config{wiki_link_regexp}}{
450 $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
451 : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3)))
458 sub preprocess ($$$;$) { #{{{
459 my $page=shift; # the page the data comes from
460 my $destpage=shift; # the page the data will appear in (different for inline)
468 if (length $escape) {
469 return "[[$command $params]]";
471 elsif (exists $hooks{preprocess}{$command}) {
472 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
473 # Note: preserve order of params, some plugins may
474 # consider it significant.
476 while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
493 push @params, $key, $val;
496 push @params, $val, '';
499 if ($preprocessing{$page}++ > 3) {
500 # Avoid loops of preprocessed pages preprocessing
501 # other pages that preprocess them, etc.
502 return "[[$command preprocessing loop detected on $page at depth $preprocessing{$page}]]";
504 my $ret=$hooks{preprocess}{$command}{call}->(
507 destpage => $destpage,
509 $preprocessing{$page}--;
513 return "[[$command $params]]";
517 $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
521 sub filter ($$) { #{{{
525 run_hooks(filter => sub {
526 $content=shift->(page => $page, content => $content);
532 sub indexlink () { #{{{
533 return "<a href=\"$config{url}\">$config{wikiname}</a>";
536 sub lockwiki () { #{{{
537 # Take an exclusive lock on the wiki to prevent multiple concurrent
538 # run issues. The lock will be dropped on program exit.
539 if (! -d $config{wikistatedir}) {
540 mkdir($config{wikistatedir});
542 open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
543 error ("cannot write to $config{wikistatedir}/lockfile: $!");
544 if (! flock(WIKILOCK, 2 | 4)) {
545 debug("wiki seems to be locked, waiting for lock");
546 my $wait=600; # arbitrary, but don't hang forever to
547 # prevent process pileup
549 return if flock(WIKILOCK, 2 | 4);
552 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
556 sub unlockwiki () { #{{{
560 sub loadindex () { #{{{
561 open (IN, "$config{wikistatedir}/index") || return;
563 $_=possibly_foolish_untaint($_);
568 foreach my $i (split(/ /, $_)) {
569 my ($item, $val)=split(/=/, $i, 2);
570 push @{$items{$item}}, decode_entities($val);
573 next unless exists $items{src}; # skip bad lines for now
575 my $page=pagename($items{src}[0]);
576 if (! $config{rebuild}) {
577 $pagesources{$page}=$items{src}[0];
578 $oldpagemtime{$page}=$items{mtime}[0];
579 $oldlinks{$page}=[@{$items{link}}];
580 $links{$page}=[@{$items{link}}];
581 $depends{$page}=$items{depends}[0] if exists $items{depends};
582 $renderedfiles{$page}=[@{$items{dest}}];
583 $oldrenderedfiles{$page}=[@{$items{dest}}];
584 $pagecase{lc $page}=$page;
586 $pagectime{$page}=$items{ctime}[0];
591 sub saveindex () { #{{{
592 run_hooks(savestate => sub { shift->() });
594 if (! -d $config{wikistatedir}) {
595 mkdir($config{wikistatedir});
597 open (OUT, ">$config{wikistatedir}/index") ||
598 error("cannot write to $config{wikistatedir}/index: $!");
599 foreach my $page (keys %oldpagemtime) {
600 next unless $oldpagemtime{$page};
601 my $line="mtime=$oldpagemtime{$page} ".
602 "ctime=$pagectime{$page} ".
603 "src=$pagesources{$page}";
604 $line.=" dest=$_" foreach @{$renderedfiles{$page}};
606 $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
607 if (exists $depends{$page}) {
608 $line.=" depends=".encode_entities($depends{$page}, " \t\n");
610 print OUT $line."\n";
615 sub template_params (@) { #{{{
618 require HTML::Template;
619 return filter => sub {
620 my $text_ref = shift;
621 $$text_ref=&Encode::decode_utf8($$text_ref);
623 filename => "$config{templatedir}/$filename",
624 loop_context_vars => 1,
625 die_on_bad_params => 0,
629 sub template ($;@) { #{{{
630 HTML::Template->new(template_params(@_));
633 sub misctemplate ($$;@) { #{{{
637 my $template=template("misc.tmpl");
640 indexlink => indexlink(),
641 wikiname => $config{wikiname},
642 pagebody => $pagebody,
643 baseurl => baseurl(),
646 run_hooks(pagetemplate => sub {
647 shift->(page => "", destpage => "", template => $template);
649 return $template->output;
655 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
656 error "hook requires type, call, and id parameters";
659 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
661 $hooks{$param{type}}{$param{id}}=\%param;
664 sub run_hooks ($$) { # {{{
665 # Calls the given sub for each hook of the given type,
666 # passing it the hook function to call.
670 if (exists $hooks{$type}) {
672 foreach my $id (keys %{$hooks{$type}}) {
673 if ($hooks{$type}{$id}{last}) {
677 $sub->($hooks{$type}{$id}{call});
679 foreach my $id (@deferred) {
680 $sub->($hooks{$type}{$id}{call});
685 sub globlist_to_pagespec ($) { #{{{
686 my @globlist=split(' ', shift);
689 foreach my $glob (@globlist) {
690 if ($glob=~/^!(.*)/) {
698 my $spec=join(" or ", @spec);
700 my $skip=join(" and ", @skip);
702 $spec="$skip and ($spec)";
711 sub is_globlist ($) { #{{{
713 $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
716 sub safequote ($) { #{{{
722 sub pagespec_merge ($$) { #{{{
726 return $a if $a eq $b;
728 # Support for old-style GlobLists.
729 if (is_globlist($a)) {
730 $a=globlist_to_pagespec($a);
732 if (is_globlist($b)) {
733 $b=globlist_to_pagespec($b);
736 return "($a) or ($b)";
739 sub pagespec_translate ($) { #{{{
740 # This assumes that $page is in scope in the function
741 # that evalulates the translated pagespec code.
744 # Support for old-style GlobLists.
745 if (is_globlist($spec)) {
746 $spec=globlist_to_pagespec($spec);
749 # Convert spec to perl code.
751 while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
753 if (lc $word eq "and") {
756 elsif (lc $word eq "or") {
759 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
762 elsif ($word =~ /^(link|backlink|created_before|created_after|creation_month|creation_year|creation_day)\((.+)\)$/) {
763 $code.=" match_$1(\$page, ".safequote($2).")";
766 $code.=" match_glob(\$page, ".safequote($word).")";
773 sub add_depends ($$) { #{{{
777 if (! exists $depends{$page}) {
778 $depends{$page}=$pagespec;
781 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
785 sub pagespec_match ($$) { #{{{
789 return eval pagespec_translate($spec);
792 sub match_glob ($$) { #{{{
796 # turn glob into safe regexp
797 $glob=quotemeta($glob);
801 return $page=~/^$glob$/i;
804 sub match_link ($$) { #{{{
808 my $links = $links{$page} or return undef;
809 foreach my $p (@$links) {
810 return 1 if lc $p eq $link;
815 sub match_backlink ($$) { #{{{
816 match_link(pop, pop);
819 sub match_created_before ($$) { #{{{
823 if (exists $pagectime{$testpage}) {
824 return $pagectime{$page} < $pagectime{$testpage};
831 sub match_created_after ($$) { #{{{
835 if (exists $pagectime{$testpage}) {
836 return $pagectime{$page} > $pagectime{$testpage};
843 sub match_creation_day ($$) { #{{{
844 return ((gmtime($pagectime{shift()}))[3] == shift);
847 sub match_creation_month ($$) { #{{{
848 return ((gmtime($pagectime{shift()}))[4] + 1 == shift);
851 sub match_creation_year ($$) { #{{{
852 return ((gmtime($pagectime{shift()}))[5] + 1900 == shift);