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.02; # 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\]#]+)(?:#([^\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 if (length $content) {
296 print OUT $content || error("failed writing to $newfile: $!", $cleanup);
299 close OUT || error("failed saving $newfile: $!", $cleanup);
300 rename($newfile, "$destdir/$file") ||
301 error("failed renaming $newfile to $destdir/$file: $!", $cleanup);
305 sub will_render ($$;$) { #{{{
310 # Important security check.
311 if (-e "$config{destdir}/$dest" && ! $config{rebuild} &&
312 ! grep { $_ eq $dest } (@{$renderedfiles{$page}}, @{$oldrenderedfiles{$page}})) {
313 error("$config{destdir}/$dest independently created, not overwriting with version from $page");
316 if (! $clear || $cleared{$page}) {
317 $renderedfiles{$page}=[$dest, grep { $_ ne $dest } @{$renderedfiles{$page}}];
320 $renderedfiles{$page}=[$dest];
325 sub bestlink ($$) { #{{{
330 if ($link=~s/^\/+//) {
337 $l.="/" if length $l;
340 if (exists $links{$l}) {
343 elsif (exists $pagecase{lc $l}) {
344 return $pagecase{lc $l};
346 } while $cwd=~s!/?[^/]+$!!;
348 if (length $config{userdir} && exists $links{"$config{userdir}/".lc($link)}) {
349 return "$config{userdir}/".lc($link);
352 #print STDERR "warning: page $page, broken link: $link\n";
356 sub isinlinableimage ($) { #{{{
359 $file=~/\.(png|gif|jpg|jpeg)$/i;
362 sub pagetitle ($;$) { #{{{
367 $page=~s/__(\d+)__/chr($1)/eg;
370 $page=~s/__(\d+)__/&#$1;/g;
377 sub titlepage ($) { #{{{
380 $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
384 sub cgiurl (@) { #{{{
387 return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
390 sub baseurl (;$) { #{{{
393 return "$config{url}/" if ! defined $page;
396 $page=~s/[^\/]+\//..\//g;
400 sub abs2rel ($$) { #{{{
401 # Work around very innefficient behavior in File::Spec if abs2rel
402 # is passed two relative paths. It's much faster if paths are
403 # absolute! (Debian bug #376658; fixed in debian unstable now)
408 my $ret=File::Spec->abs2rel($path, $base);
409 $ret=~s/^// if defined $ret;
413 sub displaytime ($) { #{{{
418 # strftime doesn't know about encodings, so make sure
419 # its output is properly treated as utf8
420 return decode_utf8(POSIX::strftime(
421 $config{timeformat}, localtime($time)));
424 sub htmllink ($$$;@) { #{{{
425 my $lpage=shift; # the page doing the linking
426 my $page=shift; # the page that will contain the link (different for inline)
431 if (! $opts{forcesubpage}) {
432 $bestlink=bestlink($lpage, $link);
435 $bestlink="$lpage/".lc($link);
439 if (defined $opts{linktext}) {
440 $linktext=$opts{linktext};
443 $linktext=pagetitle(basename($link));
446 return "<span class=\"selflink\">$linktext</span>"
447 if length $bestlink && $page eq $bestlink;
449 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
450 $bestlink=htmlpage($bestlink);
452 if (! grep { $_ eq $bestlink } map { @{$_} } values %renderedfiles) {
453 return $linktext unless length $config{cgiurl};
454 return "<span><a href=\"".
455 cgiurl(do => "create", page => lc($link), from => $page).
456 "\">?</a>$linktext</span>"
459 $bestlink=abs2rel($bestlink, dirname($page));
461 if (! $opts{noimageinline} && isinlinableimage($bestlink)) {
462 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
465 if (defined $opts{anchor}) {
466 $bestlink.="#".$opts{anchor};
469 return "<a href=\"$bestlink\">$linktext</a>";
472 sub htmlize ($$$) { #{{{
477 if (exists $hooks{htmlize}{$type}) {
478 $content=$hooks{htmlize}{$type}{call}->(
484 error("htmlization of $type not supported");
487 run_hooks(sanitize => sub {
497 sub linkify ($$$) { #{{{
498 my $lpage=shift; # the page containing the links
499 my $page=shift; # the page the link will end up on (different for inline)
502 $content =~ s{(\\?)$config{wiki_link_regexp}}{
504 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), anchor => $4, linktext => pagetitle($2)))
505 : ( $1 ? "[[$3]]" : htmllink($lpage, $page, titlepage($3), anchor => $4))
512 sub preprocess ($$$;$) { #{{{
513 my $page=shift; # the page the data comes from
514 my $destpage=shift; # the page the data will appear in (different for inline)
522 if (length $escape) {
523 return "[[$command $params]]";
525 elsif (exists $hooks{preprocess}{$command}) {
526 return "" if $scan && ! $hooks{preprocess}{$command}{scan};
527 # Note: preserve order of params, some plugins may
528 # consider it significant.
530 while ($params =~ /(?:(\w+)=)?(?:"""(.*?)"""|"([^"]+)"|(\S+))(?:\s+|$)/sg) {
547 push @params, $key, $val;
550 push @params, $val, '';
553 if ($preprocessing{$page}++ > 3) {
554 # Avoid loops of preprocessed pages preprocessing
555 # other pages that preprocess them, etc.
556 #translators: The first parameter is a
557 #translators: preprocessor directive name,
558 #translators: the second a page name, the
559 #translators: third a number.
560 return "[[".sprintf(gettext("%s preprocessing loop detected on %s at depth %i"),
561 $command, $page, $preprocessing{$page}).
564 my $ret=$hooks{preprocess}{$command}{call}->(
567 destpage => $destpage,
569 $preprocessing{$page}--;
573 return "[[$command $params]]";
577 $content =~ s{(\\?)\[\[(\w+)\s+((?:(?:\w+=)?(?:""".*?"""|"[^"]+"|[^\s\]]+)\s*)*)\]\]}{$handle->($1, $2, $3)}seg;
581 sub filter ($$) { #{{{
585 run_hooks(filter => sub {
586 $content=shift->(page => $page, content => $content);
592 sub indexlink () { #{{{
593 return "<a href=\"$config{url}\">$config{wikiname}</a>";
596 sub lockwiki () { #{{{
597 # Take an exclusive lock on the wiki to prevent multiple concurrent
598 # run issues. The lock will be dropped on program exit.
599 if (! -d $config{wikistatedir}) {
600 mkdir($config{wikistatedir});
602 open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
603 error ("cannot write to $config{wikistatedir}/lockfile: $!");
604 if (! flock(WIKILOCK, 2 | 4)) {
605 debug("wiki seems to be locked, waiting for lock");
606 my $wait=600; # arbitrary, but don't hang forever to
607 # prevent process pileup
609 return if flock(WIKILOCK, 2 | 4);
612 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
616 sub unlockwiki () { #{{{
620 sub loadindex () { #{{{
621 open (IN, "$config{wikistatedir}/index") || return;
623 $_=possibly_foolish_untaint($_);
628 foreach my $i (split(/ /, $_)) {
629 my ($item, $val)=split(/=/, $i, 2);
630 push @{$items{$item}}, decode_entities($val);
633 next unless exists $items{src}; # skip bad lines for now
635 my $page=pagename($items{src}[0]);
636 if (! $config{rebuild}) {
637 $pagesources{$page}=$items{src}[0];
638 $oldpagemtime{$page}=$items{mtime}[0];
639 $oldlinks{$page}=[@{$items{link}}];
640 $links{$page}=[@{$items{link}}];
641 $depends{$page}=$items{depends}[0] if exists $items{depends};
642 $renderedfiles{$page}=[@{$items{dest}}];
643 $oldrenderedfiles{$page}=[@{$items{dest}}];
644 $pagecase{lc $page}=$page;
646 $pagectime{$page}=$items{ctime}[0];
651 sub saveindex () { #{{{
652 run_hooks(savestate => sub { shift->() });
654 if (! -d $config{wikistatedir}) {
655 mkdir($config{wikistatedir});
657 my $newfile="$config{wikistatedir}/index.new";
658 my $cleanup = sub { unlink($newfile) };
659 open (OUT, ">$newfile") || error("cannot write to $newfile: $!", $cleanup);
660 foreach my $page (keys %oldpagemtime) {
661 next unless $oldpagemtime{$page};
662 my $line="mtime=$oldpagemtime{$page} ".
663 "ctime=$pagectime{$page} ".
664 "src=$pagesources{$page}";
665 $line.=" dest=$_" foreach @{$renderedfiles{$page}};
667 $line.=" link=$_" foreach grep { ++$count{$_} == 1 } @{$links{$page}};
668 if (exists $depends{$page}) {
669 $line.=" depends=".encode_entities($depends{$page}, " \t\n");
671 print OUT $line."\n" || error("failed writing to $newfile: $!", $cleanup);
673 close OUT || error("failed saving to $newfile: $!", $cleanup);
674 rename($newfile, "$config{wikistatedir}/index") ||
675 error("failed renaming $newfile to $config{wikistatedir}/index", $cleanup);
678 sub template_file ($) { #{{{
681 foreach my $dir ($config{templatedir}, "$installdir/share/ikiwiki/templates") {
682 return "$dir/$template" if -e "$dir/$template";
687 sub template_params (@) { #{{{
688 my $filename=template_file(shift);
690 if (! defined $filename) {
695 require HTML::Template;
698 my $text_ref = shift;
699 $$text_ref=&Encode::decode_utf8($$text_ref);
701 filename => $filename,
702 loop_context_vars => 1,
703 die_on_bad_params => 0,
706 return wantarray ? @ret : {@ret};
709 sub template ($;@) { #{{{
710 HTML::Template->new(template_params(@_));
713 sub misctemplate ($$;@) { #{{{
717 my $template=template("misc.tmpl");
720 indexlink => indexlink(),
721 wikiname => $config{wikiname},
722 pagebody => $pagebody,
723 baseurl => baseurl(),
726 run_hooks(pagetemplate => sub {
727 shift->(page => "", destpage => "", template => $template);
729 return $template->output;
735 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
736 error "hook requires type, call, and id parameters";
739 return if $param{no_override} && exists $hooks{$param{type}}{$param{id}};
741 $hooks{$param{type}}{$param{id}}=\%param;
744 sub run_hooks ($$) { # {{{
745 # Calls the given sub for each hook of the given type,
746 # passing it the hook function to call.
750 if (exists $hooks{$type}) {
752 foreach my $id (keys %{$hooks{$type}}) {
753 if ($hooks{$type}{$id}{last}) {
757 $sub->($hooks{$type}{$id}{call});
759 foreach my $id (@deferred) {
760 $sub->($hooks{$type}{$id}{call});
765 sub globlist_to_pagespec ($) { #{{{
766 my @globlist=split(' ', shift);
769 foreach my $glob (@globlist) {
770 if ($glob=~/^!(.*)/) {
778 my $spec=join(" or ", @spec);
780 my $skip=join(" and ", @skip);
782 $spec="$skip and ($spec)";
791 sub is_globlist ($) { #{{{
793 $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or";
796 sub safequote ($) { #{{{
802 sub add_depends ($$) { #{{{
806 if (! exists $depends{$page}) {
807 $depends{$page}=$pagespec;
810 $depends{$page}=pagespec_merge($depends{$page}, $pagespec);
814 sub file_pruned ($$) { #{{{
816 my $file=File::Spec->canonpath(shift);
817 my $base=File::Spec->canonpath(shift);
818 $file=~s#^\Q$base\E/*##;
820 my $regexp='('.join('|', @{$config{wiki_file_prune_regexps}}).')';
825 # Only use gettext in the rare cases it's needed.
826 if (exists $ENV{LANG} || exists $ENV{LC_ALL} || exists $ENV{LC_MESSAGES}) {
827 if (! $gettext_obj) {
829 use Locale::gettext q{textdomain};
830 Locale::gettext->domain('ikiwiki')
838 return $gettext_obj->get(shift);
845 sub pagespec_merge ($$) { #{{{
849 return $a if $a eq $b;
851 # Support for old-style GlobLists.
852 if (is_globlist($a)) {
853 $a=globlist_to_pagespec($a);
855 if (is_globlist($b)) {
856 $b=globlist_to_pagespec($b);
859 return "($a) or ($b)";
862 sub pagespec_translate ($) { #{{{
863 # This assumes that $page is in scope in the function
864 # that evalulates the translated pagespec code.
867 # Support for old-style GlobLists.
868 if (is_globlist($spec)) {
869 $spec=globlist_to_pagespec($spec);
872 # Convert spec to perl code.
874 while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) {
876 if (lc $word eq "and") {
879 elsif (lc $word eq "or") {
882 elsif ($word eq "(" || $word eq ")" || $word eq "!") {
885 elsif ($word =~ /^(\w+)\((.*)\)$/) {
886 if (exists $IkiWiki::PageSpec::{"match_$1"}) {
887 $code.=" IkiWiki::PageSpec::match_$1(\$page, ".safequote($2).")";
894 $code.=" IkiWiki::PageSpec::match_glob(\$page, ".safequote($word).", \$from)";
901 sub pagespec_match ($$;$) { #{{{
906 return eval pagespec_translate($spec);
909 package IkiWiki::PageSpec;
911 sub match_glob ($$$) { #{{{
915 if (! defined $from){
920 if ($glob =~ m!^\./!) {
923 $glob="$from/$glob" if length $from;
926 # turn glob into safe regexp
927 $glob=quotemeta($glob);
931 return $page=~/^$glob$/i;
934 sub match_link ($$) { #{{{
938 my $links = $IkiWiki::links{$page} or return undef;
939 foreach my $p (@$links) {
940 return 1 if lc $p eq $link;
945 sub match_backlink ($$) { #{{{
946 match_link(pop, pop);
949 sub match_created_before ($$) { #{{{
953 if (exists $IkiWiki::pagectime{$testpage}) {
954 return $IkiWiki::pagectime{$page} < $IkiWiki::pagectime{$testpage};
961 sub match_created_after ($$) { #{{{
965 if (exists $IkiWiki::pagectime{$testpage}) {
966 return $IkiWiki::pagectime{$page} > $IkiWiki::pagectime{$testpage};
973 sub match_creation_day ($$) { #{{{
974 return ((gmtime($IkiWiki::pagectime{shift()}))[3] == shift);
977 sub match_creation_month ($$) { #{{{
978 return ((gmtime($IkiWiki::pagectime{shift()}))[4] + 1 == shift);
981 sub match_creation_year ($$) { #{{{
982 return ((gmtime($IkiWiki::pagectime{shift()}))[5] + 1900 == shift);