8 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
9 %renderedfiles %pagesources %depends %hooks};
11 sub defaultconfig () { #{{{
12 wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
13 wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
14 wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,
15 wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
18 default_pageext => ".mdwn",
39 templatedir => "/usr/share/ikiwiki/templates",
40 underlaydir => "/usr/share/ikiwiki/basewiki",
44 plugin => [qw{inline htmlscrubber}],
48 sub checkconfig () { #{{{
49 if ($config{cgi} && ! length $config{url}) {
50 error("Must specify url to wiki with --url when using --cgi\n");
52 if ($config{rss} && ! length $config{url}) {
53 error("Must specify url to wiki with --url when using --rss\n");
56 $config{wikistatedir}="$config{srcdir}/.ikiwiki"
57 unless exists $config{wikistatedir};
60 eval qq{require IkiWiki::Rcs::$config{rcs}};
62 error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
66 require IkiWiki::Rcs::Stub;
69 foreach my $plugin (@{$config{plugin}}) {
70 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
73 error("Failed to load plugin $mod: $@");
77 if (exists $hooks{checkconfig}) {
78 foreach my $id (keys %{$hooks{checkconfig}}) {
79 $hooks{checkconfig}{$id}{call}->();
86 print "Content-type: text/html\n\n";
87 print misctemplate("Error", "<p>Error: @_</p>");
93 return unless $config{verbose};
102 sub possibly_foolish_untaint ($) { #{{{
104 my ($untainted)=$tainted=~/(.*)/;
108 sub basename ($) { #{{{
115 sub dirname ($) { #{{{
122 sub pagetype ($) { #{{{
125 if ($page =~ /\.mdwn$/) {
133 sub pagename ($) { #{{{
136 my $type=pagetype($file);
138 $page=~s/\Q$type\E*$// unless $type eq 'unknown';
142 sub htmlpage ($) { #{{{
145 return $page.".html";
148 sub srcfile ($) { #{{{
151 return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
152 return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
153 error("internal error: $file cannot be found");
156 sub readfile ($;$) { #{{{
161 error("cannot read a symlink ($file)");
165 open (IN, $file) || error("failed to read $file: $!");
167 binmode(IN, ":utf8");
177 sub writefile ($$$;$) { #{{{
178 my $file=shift; # can include subdirs
179 my $destdir=shift; # directory to put file in
184 while (length $test) {
185 if (-l "$destdir/$test") {
186 error("cannot write to a symlink ($test)");
188 $test=dirname($test);
191 my $dir=dirname("$destdir/$file");
194 foreach my $s (split(m!/+!, $dir)) {
197 mkdir($d) || error("failed to create directory $d: $!");
202 open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
204 binmode(OUT, ":utf8");
213 sub bestlink ($$) { #{{{
214 # Given a page and the text of a link on the page, determine which
215 # existing page that link best points to. Prefers pages under a
216 # subdirectory with the same name as the source page, failing that
217 # goes down the directory tree to the base looking for matching
225 $l.="/" if length $l;
228 if (exists $links{$l}) {
229 #debug("for $page, \"$link\", use $l");
232 } while $cwd=~s!/?[^/]+$!!;
234 #print STDERR "warning: page $page, broken link: $link\n";
238 sub isinlinableimage ($) { #{{{
241 $file=~/\.(png|gif|jpg|jpeg)$/i;
244 sub pagetitle ($) { #{{{
246 $page=~s/__(\d+)__/&#$1;/g;
251 sub titlepage ($) { #{{{
254 $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
258 sub cgiurl (@) { #{{{
261 return $config{cgiurl}."?".join("&", map "$_=$params{$_}", keys %params);
264 sub styleurl (;$) { #{{{
267 return "$config{url}/style.css" if ! defined $page;
270 $page=~s/[^\/]+\//..\//g;
271 return $page."style.css";
274 sub htmllink ($$$;$$$) { #{{{
275 my $lpage=shift; # the page doing the linking
276 my $page=shift; # the page that will contain the link (different for inline)
278 my $noimageinline=shift; # don't turn links into inline html images
279 my $forcesubpage=shift; # force a link to a subpage
280 my $linktext=shift; # set to force the link text to something
283 if (! $forcesubpage) {
284 $bestlink=bestlink($lpage, $link);
287 $bestlink="$lpage/".lc($link);
290 $linktext=pagetitle(basename($link)) unless defined $linktext;
292 return $linktext if length $bestlink && $page eq $bestlink;
294 # TODO BUG: %renderedfiles may not have it, if the linked to page
295 # was also added and isn't yet rendered! Note that this bug is
296 # masked by the bug that makes all new files be rendered twice.
297 if (! grep { $_ eq $bestlink } values %renderedfiles) {
298 $bestlink=htmlpage($bestlink);
300 if (! grep { $_ eq $bestlink } values %renderedfiles) {
301 return "<span><a href=\"".
302 cgiurl(do => "create", page => $link, from => $page).
303 "\">?</a>$linktext</span>"
307 $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
309 if (! $noimageinline && isinlinableimage($bestlink)) {
310 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
312 return "<a href=\"$bestlink\">$linktext</a>";
315 sub indexlink () { #{{{
316 return "<a href=\"$config{url}\">$config{wikiname}</a>";
319 sub lockwiki () { #{{{
320 # Take an exclusive lock on the wiki to prevent multiple concurrent
321 # run issues. The lock will be dropped on program exit.
322 if (! -d $config{wikistatedir}) {
323 mkdir($config{wikistatedir});
325 open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
326 error ("cannot write to $config{wikistatedir}/lockfile: $!");
327 if (! flock(WIKILOCK, 2 | 4)) {
328 debug("wiki seems to be locked, waiting for lock");
329 my $wait=600; # arbitrary, but don't hang forever to
330 # prevent process pileup
332 return if flock(WIKILOCK, 2 | 4);
335 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
339 sub unlockwiki () { #{{{
343 sub loadindex () { #{{{
344 open (IN, "<:utf8", "$config{wikistatedir}/index") || return;
346 $_=possibly_foolish_untaint($_);
350 foreach my $i (split(/ /, $_)) {
351 my ($item, $val)=split(/=/, $i, 2);
352 push @{$items{$item}}, $val;
355 next unless exists $items{src}; # skip bad lines for now
357 my $page=pagename($items{src}[0]);
358 if (! $config{rebuild}) {
359 $pagesources{$page}=$items{src}[0];
360 $oldpagemtime{$page}=$items{mtime}[0];
361 $oldlinks{$page}=[@{$items{link}}];
362 $links{$page}=[@{$items{link}}];
363 $depends{$page}=join(" ", @{$items{depends}})
364 if exists $items{depends};
365 $renderedfiles{$page}=$items{dest}[0];
367 $pagectime{$page}=$items{ctime}[0];
372 sub saveindex () { #{{{
373 if (! -d $config{wikistatedir}) {
374 mkdir($config{wikistatedir});
376 open (OUT, ">:utf8", "$config{wikistatedir}/index") ||
377 error("cannot write to $config{wikistatedir}/index: $!");
378 foreach my $page (keys %oldpagemtime) {
379 next unless $oldpagemtime{$page};
380 my $line="mtime=$oldpagemtime{$page} ".
381 "ctime=$pagectime{$page} ".
382 "src=$pagesources{$page} ".
383 "dest=$renderedfiles{$page}";
384 $line.=" link=$_" foreach @{$links{$page}};
385 if (exists $depends{$page}) {
386 $line.=" depends=$_" foreach split " ", $depends{$page};
388 print OUT $line."\n";
393 sub template_params (@) { #{{{
397 require HTML::Template;
398 return filter => sub {
399 my $text_ref = shift;
400 $$text_ref=&Encode::decode_utf8($$text_ref);
402 filename => "$config{templatedir}/$filename", @_;
405 sub template ($;@) { #{{{
406 HTML::Template->new(template_params(@_));
409 sub misctemplate ($$) { #{{{
413 my $template=template("misc.tmpl");
416 indexlink => indexlink(),
417 wikiname => $config{wikiname},
418 pagebody => $pagebody,
419 styleurl => styleurl(),
420 baseurl => "$config{url}/",
422 return $template->output;
425 sub glob_match ($$) { #{{{
429 if ($glob =~ /^link\((.+)\)$/) {
430 my $rev = $links{$page} or return undef;
431 foreach my $p (@$rev) {
432 return 1 if lc $p eq $1;
435 } elsif ($glob =~ /^backlink\((.+)\)$/) {
436 my $rev = $links{$1} or return undef;
437 foreach my $p (@$rev) {
438 return 1 if lc $p eq $page;
442 # turn glob into safe regexp
443 $glob=quotemeta($glob);
448 return $page=~/^$glob$/i;
452 sub globlist_match ($$) { #{{{
454 my @globlist=split(" ", shift);
456 # check any negated globs first
457 foreach my $glob (@globlist) {
458 return 0 if $glob=~/^!(.*)/ && glob_match($page, $1);
461 foreach my $glob (@globlist) {
462 return 1 if glob_match($page, $glob);
471 if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
472 error "hook requires type, call, and id parameters";
475 $hooks{$param{type}}{$param{id}}=\%param;