8 use open qw{:utf8 :std};
10 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime %pagecase
11 %renderedfiles %oldrenderedfiles %pagesources %depends %hooks
12 %forcerebuild $gettext_obj};
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, next is ikiwiki version
20 our $version='unknown'; # VERSION_AUTOREPLACE done by Makefile, DNE
21 my $installdir=''; # INSTALLDIR_AUTOREPLACE done by Makefile, DNE
26 memoize("pagespec_translate");
27 memoize("file_pruned");
29 sub defaultconfig () { #{{{
30 wiki_file_prune_regexps => [qr/\.\./, qr/^\./, qr/\/\./,
31 qr/\.x?html?$/, qr/\.ikiwiki-new$/,
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",
58 gitorigin_branch => "origin",
59 gitmaster_branch => "master",
63 templatedir => "$installdir/share/ikiwiki/templates",
64 underlaydir => "$installdir/share/ikiwiki/basewiki",
68 plugin => [qw{mdwn inline htmlscrubber passwordauth signinedit
69 lockedit conditional}],
77 sub checkconfig () { #{{{
78 # locale stuff; avoid LC_ALL since it overrides everything
79 if (defined $ENV{LC_ALL}) {
80 $ENV{LANG} = $ENV{LC_ALL};
83 if (defined $config{locale}) {
86 if (POSIX::setlocale(&POSIX::LC_ALL, $config{locale})) {
87 $ENV{LANG}=$config{locale};
92 if ($config{w3mmode}) {
93 eval q{use Cwd q{abs_path}};
95 $config{srcdir}=possibly_foolish_untaint(abs_path($config{srcdir}));
96 $config{destdir}=possibly_foolish_untaint(abs_path($config{destdir}));
97 $config{cgiurl}="file:///\$LIB/ikiwiki-w3m.cgi/".$config{cgiurl}
98 unless $config{cgiurl} =~ m!file:///!;
99 $config{url}="file://".$config{destdir};
102 if ($config{cgi} && ! length $config{url}) {
103 error(gettext("Must specify url to wiki with --url when using --cgi"));
106 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
107 unless exists $config{wikistatedir};
110 eval qq{require IkiWiki::Rcs::$config{rcs}};
112 error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
116 require IkiWiki::Rcs::Stub;
119 run_hooks(checkconfig => sub { shift->() });
122 sub loadplugins () { #{{{
123 loadplugin($_) foreach @{$config{plugin}};
125 run_hooks(getopt => sub { shift->() });
126 if (grep /^-/, @ARGV) {
127 print STDERR "Unknown option: $_\n"
128 foreach grep /^-/, @ARGV;
133 sub loadplugin ($) { #{{{
136 return if grep { $_ eq $plugin} @{$config{disable_plugins}};
138 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
141 error("Failed to load plugin $mod: $@");
145 sub error ($;$) { #{{{
149 print "Content-type: text/html\n\n";
150 print misctemplate(gettext("Error"),
151 "<p>".gettext("Error").": $message</p>");
153 log_message(debug => $message) if $config{syslog};
154 if (defined $cleaner) {
161 return unless $config{verbose};
162 log_message(debug => @_);
166 sub log_message ($$) { #{{{
169 if ($config{syslog}) {
172 Sys::Syslog::setlogsock('unix');
173 Sys::Syslog::openlog('ikiwiki', '', 'user');
177 Sys::Syslog::syslog($type, "%s", join(" ", @_));
180 elsif (! $config{cgi}) {
188 sub possibly_foolish_untaint ($) { #{{{
190 my ($untainted)=$tainted=~/(.*)/;
194 sub basename ($) { #{{{
201 sub dirname ($) { #{{{
208 sub pagetype ($) { #{{{
211 if ($page =~ /\.([^.]+)$/) {
212 return $1 if exists $hooks{htmlize}{$1};
217 sub pagename ($) { #{{{
220 my $type=pagetype($file);
222 $page=~s/\Q.$type\E*$// if defined $type;
226 sub htmlpage ($) { #{{{
229 return $page.".html";
232 sub srcfile ($) { #{{{
235 return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
236 return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
237 error("internal error: $file cannot be found");
240 sub readfile ($;$$) { #{{{
246 error("cannot read a symlink ($file)");
250 open (IN, $file) || error("failed to read $file: $!");
251 binmode(IN) if ($binary);
252 return \*IN if $wantfd;
254 close IN || error("failed to read $file: $!");
258 sub writefile ($$$;$$) { #{{{
259 my $file=shift; # can include subdirs
260 my $destdir=shift; # directory to put file in
266 while (length $test) {
267 if (-l "$destdir/$test") {
268 error("cannot write to a symlink ($test)");
270 $test=dirname($test);
272 my $newfile="$destdir/$file.ikiwiki-new";
274 error("cannot write to a symlink ($newfile)");
277 my $dir=dirname($newfile);
280 foreach my $s (split(m!/+!, $dir)) {
283 mkdir($d) || error("failed to create directory $d: $!");
288 my $cleanup = sub { unlink($newfile) };
289 open (OUT, ">$newfile") || error("failed to write $newfile: $!", $cleanup);
290 binmode(OUT) if ($binary);
292 $writer->(\*OUT, $cleanup);
295 print OUT $content || error("failed writing to $newfile: $!", $cleanup);
297 close OUT || error("failed saving $newfile: $!", $cleanup);
298 rename($newfile, "$destdir/$file") ||
299 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
303 sub will_render ($$;$) { #{{{
308 # Important security check.
309 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
310 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
311 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
314 if (! $clear || $cleared{$page}) {
315 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
318 $renderedfiles{$page}=[$dest];
323 sub bestlink ($$) { #{{{
328 if ($link=~s/^\/+//) {
335 $l.="/" if length $l;
338 if (exists $links{$l}) {
341 elsif (exists $pagecase{lc $l}) {
342 return $pagecase{lc $l};
344 } while $cwd=~s!/?[^/]+$!!;
346 if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
347 return "$config{userdir}/".lc($link);
350 #print STDERR "warning: page $page, broken link: $link\n";
354 sub isinlinableimage ($) { #{{{
357 $file=~/\.(png|gif|jpg|jpeg)$/i;
360 sub pagetitle ($;$) { #{{{
365 $page=~s/__(\d+)__/chr($1)/eg;
368 $page=~s/__(\d+)__/&#$1;/g;
375 sub titlepage ($) { #{{{
378 $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
382 sub cgiurl (@) { #{{{
385 return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
388 sub baseurl (;$) { #{{{
391 return "$config{url}/" if ! defined $page;
394 $page=~s/[^\/]+\//..\//g;
398 sub abs2rel ($$) { #{{{
399 # Work around very innefficient behavior in File::Spec if abs2rel
400 # is passed two relative paths. It's much faster if paths are
401 # absolute! (Debian bug #376658; fixed in debian unstable now)
406 my $ret=File::Spec->abs2rel($path, $base);
407 $ret=~s/^// if defined $ret;
411 sub displaytime ($) { #{{{
416 # strftime doesn't know about encodings, so make sure
417 # its output is properly treated as utf8
418 return decode_utf8(POSIX::strftime(
419 $config{timeformat}, localtime($time)));
422 sub htmllink ($$$;$$$) { #{{{
423 my $lpage=shift; # the page doing the linking
424 my $page=shift; # the page that will contain the link (different for inline)
426 my $noimageinline=shift; # don't turn links into inline html images
427 my $forcesubpage=shift; # force a link to a subpage
428 my $linktext=shift; # set to force the link text to something
431 if (! $forcesubpage) {
432 $bestlink=bestlink($lpage, $link);
435 $bestlink="$lpage/".lc($link);
438 $linktext=pagetitle(basename($link)) unless defined $linktext;
440 return "<span class=\"selflink\">$linktext</span>"
441 if length $bestlink && $page eq $bestlink;
443 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
444 $bestlink=htmlpage($bestlink);
446 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
447 return $linktext unless length $config{cgiurl};
448 return "<span><a href=\"".
449 cgiurl(do => "create", page => lc($link), from => $page).
450 "\">?</a>$linktext</span>"
453 $bestlink=abs2rel($bestlink, dirname($page));
455 if (! $noimageinline && isinlinableimage($bestlink)) {
456 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
458 return "<a href=\"$bestlink\">$linktext</a>";
461 sub htmlize ($$$) { #{{{
466 if (exists $hooks{htmlize}{$type}) {
467 $content=$hooks{htmlize}{$type}{call}->(
473 error("htmlization of $type not supported");
476 run_hooks(sanitize => sub {
486 sub linkify ($$$) { #{{{
487 my $lpage=shift; # the page containing the links
488 my $page=shift; # the page the link will end up on (different for inline)
491 $content =~ s{(\\?)$config{wiki_link_regexp}}{
492 $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
493 : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3)))
500 sub preprocess ($$$;$) { #{{{
501 my $page=shift; # the page the data comes from
502 my $destpage=shift; # the page the data will appear in (different for inline)
510 if (length $escape) {
511 return "[[$command $params]]";
513 elsif (exists $hooks{preprocess}{$command}) {
514 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
515 # Note: preserve order of params, some plugins may
516 # consider it significant.
518 while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
535 push @params, $key, $val;
538 push @params, $val, '';
541 if ($preprocessing{$page}++ > 3) {
542 # Avoid loops of preprocessed pages preprocessing
543 # other pages that preprocess them, etc.
544 #translators: The first parameter is a
545 #translators: preprocessor directive name,
546 #translators: the second a page name, the
547 #translators: third a number.
548 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
549 $command, $page, $preprocessing{$page}).
552 my $ret=$hooks{preprocess}{$command}{call}->(
555 destpage => $destpage,
557 $preprocessing{$page}--;
561 return "[[$command $params]]";
565 $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
569 sub filter ($$) { #{{{
573 run_hooks(filter => sub {
574 $content=shift->(page => $page, content => $content);
580 sub indexlink () { #{{{
581 return "<a href=\"$config{url}\">$config{wikiname}</a>";
584 sub lockwiki () { #{{{
585 # Take an exclusive lock on the wiki to prevent multiple concurrent
586 # run issues. The lock will be dropped on program exit.
587 if (! -d $config{wikistatedir}) {
588 mkdir($config{wikistatedir});
590 open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
591 error ("cannot write to $config{wikistatedir}/lockfile: $!");
592 if (! flock(WIKILOCK, 2 | 4)) {
593 debug("wiki seems to be locked, waiting for lock");
594 my $wait=600; # arbitrary, but don't hang forever to
595 # prevent process pileup
597 return if flock(WIKILOCK, 2 | 4);
600 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
604 sub unlockwiki () { #{{{
608 sub loadindex () { #{{{
609 open (IN, "$config{wikistatedir}/index") || return;
611 $_=possibly_foolish_untaint($_);
616 foreach my $i (split(/ /, $_)) {
617 my ($item, $val)=split(/=/, $i, 2);
618 push @{$items{$item}}, decode_entities($val);
621 next unless exists $items{src}; # skip bad lines for now
623 my $page=pagename($items{src}[0]);
624 if (! $config{rebuild}) {
625 $pagesources{$page}=$items{src}[0];
626 $oldpagemtime{$page}=$items{mtime}[0];
627 $oldlinks{$page}=[@{$items{link}}];
628 $links{$page}=[@{$items{link}}];
629 $depends{$page}=$items{depends}[0] if exists $items{depends};
630 $renderedfiles{$page}=[@{$items{dest}}];
631 $oldrenderedfiles{$page}=[@{$items{dest}}];
632 $pagecase{lc $page}=$page;
634 $pagectime{$page}=$items{ctime}[0];
639 sub saveindex () { #{{{
640 run_hooks(savestate => sub { shift->() });
642 if (! -d $config{wikistatedir}) {
643 mkdir($config{wikistatedir});
645 my $newfile="$config{wikistatedir}/index.new";
646 my $cleanup = sub { unlink($newfile) };
647 open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup);
648 foreach my $page (keys %oldpagemtime) {
649 next unless $oldpagemtime{$page};
650 my $line="mtime=$oldpagemtime{$page} ".
651 "ctime=$pagectime{$page} ".
652 "src=$pagesources{$page}";
653 $line.=" dest=$_" foreach @{$renderedfiles{$page}};
655 $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
656 if (exists $depends{$page}) {
657 $line.=" depends=".encode_entities($depends{$page}, " \t\n");
659 print OUT $line."\n" || error("failed writing to $newfile: $!", $cleanup);
661 close OUT || error("failed saving to $newfile: $!", $cleanup);
662 rename($newfile, "$config{wikistatedir}/index") ||
663 error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
666 sub template_file ($) { #{{{
669 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
670 return "$dir/$template" if -e "$dir/$template";
675 sub template_params (@) { #{{{
676 my $filename=template_file(shift);
678 if (! defined $filename) {
683 require HTML::Template;
686 my $text_ref = shift;
687 $$text_ref=&Encode::decode_utf8($$text_ref);
689 filename => $filename,
690 loop_context_vars => 1,
691 die_on_bad_params => 0,
694 return wantarray ? @ret : {@ret};
697 sub template ($;@) { #{{{
698 HTML::Template->new(template_params(@_));
701 sub misctemplate ($$;@) { #{{{
705 my $template=template("misc.tmpl");
708 indexlink => indexlink(),
709 wikiname => $config{wikiname},
710 pagebody => $pagebody,
711 baseurl => baseurl(),
714 run_hooks(pagetemplate => sub {
715 shift->(page => "", destpage => "", template => $template);
717 return $template->output;
723 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
724 error "hook requires type, call, and id parameters";
727 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
729 $hooks{$param{type}}{$param{id}}=\%param;
732 sub run_hooks ($$) { # {{{
733 # Calls the given sub for each hook of the given type,
734 # passing it the hook function to call.
738 if (exists $hooks{$type}) {
740 foreach my $id (keys %{$hooks{$type}}) {
741 if ($hooks{$type}{$id}{last}) {
745 $sub->($hooks{$type}{$id}{call});
747 foreach my $id (@deferred) {
748 $sub->($hooks{$type}{$id}{call});
753 sub globlist_to_pagespec ($) { #{{{
754 my @globlist=split(' ', shift);
757 foreach my $glob (@globlist) {
758 if ($glob=~/^!(.*)/) {
766 my $spec=join(" or ", @spec);
768 my $skip=join(" and ", @skip);
770 $spec="$skip and ($spec)";
779 sub is_globlist ($) { #{{{
781 $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
784 sub safequote ($) { #{{{
790 sub add_depends ($$) { #{{{
794 if (! exists $depends{$page}) {
795 $depends{$page}=$pagespec;
798 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
802 sub file_pruned ($$) { #{{{
804 my $file=File::Spec->canonpath(shift);
805 my $base=File::Spec->canonpath(shift);
806 $file=~s#^\Q$base\E/*##;
808 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
813 # Only use gettext in the rare cases it's needed.
814 if (exists $ENV{LANG} || exists $ENV{LC_ALL} || exists $ENV{LC_MESSAGES}) {
815 if (! $gettext_obj) {
817 use Locale::gettext q{textdomain};
818 Locale::gettext->domain('ikiwiki')
826 return $gettext_obj->get(shift);
833 sub pagespec_merge ($$) { #{{{
837 return $a if $a eq $b;
839 # Support for old-style GlobLists.
840 if (is_globlist($a)) {
841 $a=globlist_to_pagespec($a);
843 if (is_globlist($b)) {
844 $b=globlist_to_pagespec($b);
847 return "($a) or ($b)";
850 sub pagespec_translate ($) { #{{{
851 # This assumes that $page is in scope in the function
852 # that evalulates the translated pagespec code.
855 # Support for old-style GlobLists.
856 if (is_globlist($spec)) {
857 $spec=globlist_to_pagespec($spec);
860 # Convert spec to perl code.
862 while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
864 if (lc $word eq "and") {
867 elsif (lc $word eq "or") {
870 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
873 elsif ($word =~ /^(\w+)\((.*)\)$/) {
874 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
875 $code.=" IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).")";
882 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)";
889 sub pagespec_match ($$;$) { #{{{
894 return eval pagespec_translate($spec);
897 package IkiWiki::PageSpec;
899 sub match_glob ($$$) { #{{{
903 if (! defined $from){
908 if ($glob =~ m!^\./!) {
911 $glob="$from/$glob" if length $from;
914 # turn glob into safe regexp
915 $glob=quotemeta($glob);
919 return $page=~/^$glob$/i;
922 sub match_link ($$) { #{{{
926 my $links = $IkiWiki::links{$page} or return undef;
927 foreach my $p (@$links) {
928 return 1 if lc $p eq $link;
933 sub match_backlink ($$) { #{{{
934 match_link(pop, pop);
937 sub match_created_before ($$) { #{{{
941 if (exists $IkiWiki::pagectime{$testpage}) {
942 return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage};
949 sub match_created_after ($$) { #{{{
953 if (exists $IkiWiki::pagectime{$testpage}) {
954 return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage};
961 sub match_creation_day ($$) { #{{{
962 return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);
965 sub match_creation_month ($$) { #{{{
966 return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
969 sub match_creation_year ($$) { #{{{
970 return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);