use "use open" pragma to avoid manually needing to specify utf8 everywhere
[ikiwiki.git] / IkiWiki.pm
1 #!/usr/bin/perl
2
3 package IkiWiki;
4 use warnings;
5 use strict;
6 use Encode;
7 use open qw{:utf8 :std};
8
9 use vars qw{%config %links %oldlinks %oldpagemtime %pagectime
10             %renderedfiles %pagesources %depends %hooks};
11
12 sub defaultconfig () { #{{{
13         wiki_file_prune_regexp => qr{((^|/).svn/|\.\.|^\.|\/\.|\.html?$|\.rss$)},
14         wiki_link_regexp => qr/\[\[(?:([^\]\|]+)\|)?([^\s\]]+)\]\]/,
15         wiki_processor_regexp => qr/\[\[(\w+)\s+([^\]]*)\]\]/,
16         wiki_file_regexp => qr/(^[-[:alnum:]_.:\/+]+$)/,
17         verbose => 0,
18         wikiname => "wiki",
19         default_pageext => ".mdwn",
20         cgi => 0,
21         rcs => 'svn',
22         notify => 0,
23         url => '',
24         cgiurl => '',
25         historyurl => '',
26         diffurl => '',
27         anonok => 0,
28         rss => 0,
29         discussion => 1,
30         rebuild => 0,
31         refresh => 0,
32         getctime => 0,
33         wrapper => undef,
34         wrappermode => undef,
35         svnrepo => undef,
36         svnpath => "trunk",
37         srcdir => undef,
38         destdir => undef,
39         pingurl => [],
40         templatedir => "/usr/share/ikiwiki/templates",
41         underlaydir => "/usr/share/ikiwiki/basewiki",
42         setup => undef,
43         adminuser => undef,
44         adminemail => undef,
45         plugin => [qw{mdwn inline htmlscrubber}],
46         timeformat => '%c',
47 } #}}}
48             
49 sub checkconfig () { #{{{
50         if ($config{cgi} && ! length $config{url}) {
51                 error("Must specify url to wiki with --url when using --cgi\n");
52         }
53         if ($config{rss} && ! length $config{url}) {
54                 error("Must specify url to wiki with --url when using --rss\n");
55         }
56         
57         $config{wikistatedir}="$config{srcdir}/.ikiwiki"
58                 unless exists $config{wikistatedir};
59         
60         if ($config{rcs}) {
61                 eval qq{require IkiWiki::Rcs::$config{rcs}};
62                 if ($@) {
63                         error("Failed to load RCS module IkiWiki::Rcs::$config{rcs}: $@");
64                 }
65         }
66         else {
67                 require IkiWiki::Rcs::Stub;
68         }
69
70         foreach my $plugin (@{$config{plugin}}) {
71                 my $mod="IkiWiki::Plugin::".possibly_foolish_untaint($plugin);
72                 eval qq{use $mod};
73                 if ($@) {
74                         error("Failed to load plugin $mod: $@");
75                 }
76         }
77
78         if (exists $hooks{checkconfig}) {
79                 foreach my $id (keys %{$hooks{checkconfig}}) {
80                         $hooks{checkconfig}{$id}{call}->();
81                 }
82         }
83 } #}}}
84
85 sub error ($) { #{{{
86         if ($config{cgi}) {
87                 print "Content-type: text/html\n\n";
88                 print misctemplate("Error", "<p>Error: @_</p>");
89         }
90         die @_;
91 } #}}}
92
93 sub debug ($) { #{{{
94         return unless $config{verbose};
95         if (! $config{cgi}) {
96                 print "@_\n";
97         }
98         else {
99                 print STDERR "@_\n";
100         }
101 } #}}}
102
103 sub possibly_foolish_untaint ($) { #{{{
104         my $tainted=shift;
105         my ($untainted)=$tainted=~/(.*)/;
106         return $untainted;
107 } #}}}
108
109 sub basename ($) { #{{{
110         my $file=shift;
111
112         $file=~s!.*/+!!;
113         return $file;
114 } #}}}
115
116 sub dirname ($) { #{{{
117         my $file=shift;
118
119         $file=~s!/*[^/]+$!!;
120         return $file;
121 } #}}}
122
123 sub pagetype ($) { #{{{
124         my $page=shift;
125         
126         if ($page =~ /\.(.*)$/) {
127                 return $1 if exists $hooks{htmlize}{$1};
128         }
129         return undef;
130 } #}}}
131
132 sub pagename ($) { #{{{
133         my $file=shift;
134
135         my $type=pagetype($file);
136         my $page=$file;
137         $page=~s/\Q.$type\E*$// if defined $type;
138         return $page;
139 } #}}}
140
141 sub htmlpage ($) { #{{{
142         my $page=shift;
143
144         return $page.".html";
145 } #}}}
146
147 sub srcfile ($) { #{{{
148         my $file=shift;
149
150         return "$config{srcdir}/$file" if -e "$config{srcdir}/$file";
151         return "$config{underlaydir}/$file" if -e "$config{underlaydir}/$file";
152         error("internal error: $file cannot be found");
153 } #}}}
154
155 sub readfile ($;$) { #{{{
156         my $file=shift;
157         my $binary=shift;
158
159         if (-l $file) {
160                 error("cannot read a symlink ($file)");
161         }
162         
163         local $/=undef;
164         open (IN, $file) || error("failed to read $file: $!");
165         binmode(IN) if ($binary);
166         my $ret=<IN>;
167         close IN;
168         return $ret;
169 } #}}}
170
171 sub writefile ($$$;$) { #{{{
172         my $file=shift; # can include subdirs
173         my $destdir=shift; # directory to put file in
174         my $content=shift;
175         my $binary=shift;
176         
177         my $test=$file;
178         while (length $test) {
179                 if (-l "$destdir/$test") {
180                         error("cannot write to a symlink ($test)");
181                 }
182                 $test=dirname($test);
183         }
184
185         my $dir=dirname("$destdir/$file");
186         if (! -d $dir) {
187                 my $d="";
188                 foreach my $s (split(m!/+!, $dir)) {
189                         $d.="$s/";
190                         if (! -d $d) {
191                                 mkdir($d) || error("failed to create directory $d: $!");
192                         }
193                 }
194         }
195         
196         open (OUT, ">$destdir/$file") || error("failed to write $destdir/$file: $!");
197         binmode(OUT) if ($binary);
198         print OUT $content;
199         close OUT;
200 } #}}}
201
202 sub bestlink ($$) { #{{{
203         # Given a page and the text of a link on the page, determine which
204         # existing page that link best points to. Prefers pages under a
205         # subdirectory with the same name as the source page, failing that
206         # goes down the directory tree to the base looking for matching
207         # pages.
208         my $page=shift;
209         my $link=lc(shift);
210         
211         my $cwd=$page;
212         do {
213                 my $l=$cwd;
214                 $l.="/" if length $l;
215                 $l.=$link;
216
217                 if (exists $links{$l}) {
218                         #debug("for $page, \"$link\", use $l");
219                         return $l;
220                 }
221         } while $cwd=~s!/?[^/]+$!!;
222
223         #print STDERR "warning: page $page, broken link: $link\n";
224         return "";
225 } #}}}
226
227 sub isinlinableimage ($) { #{{{
228         my $file=shift;
229         
230         $file=~/\.(png|gif|jpg|jpeg)$/i;
231 } #}}}
232
233 sub pagetitle ($) { #{{{
234         my $page=shift;
235         $page=~s/__(\d+)__/&#$1;/g;
236         $page=~y/_/ /;
237         return $page;
238 } #}}}
239
240 sub titlepage ($) { #{{{
241         my $title=shift;
242         $title=~y/ /_/;
243         $title=~s/([^-[:alnum:]_:+\/.])/"__".ord($1)."__"/eg;
244         return $title;
245 } #}}}
246
247 sub cgiurl (@) { #{{{
248         my %params=@_;
249
250         return $config{cgiurl}."?".join("&amp;", map "$_=$params{$_}", keys %params);
251 } #}}}
252
253 sub styleurl (;$) { #{{{
254         my $page=shift;
255
256         return "$config{url}/style.css" if ! defined $page;
257         
258         $page=~s/[^\/]+$//;
259         $page=~s/[^\/]+\//..\//g;
260         return $page."style.css";
261 } #}}}
262
263 sub htmllink ($$$;$$$) { #{{{
264         my $lpage=shift; # the page doing the linking
265         my $page=shift; # the page that will contain the link (different for inline)
266         my $link=shift;
267         my $noimageinline=shift; # don't turn links into inline html images
268         my $forcesubpage=shift; # force a link to a subpage
269         my $linktext=shift; # set to force the link text to something
270
271         my $bestlink;
272         if (! $forcesubpage) {
273                 $bestlink=bestlink($lpage, $link);
274         }
275         else {
276                 $bestlink="$lpage/".lc($link);
277         }
278
279         $linktext=pagetitle(basename($link)) unless defined $linktext;
280         
281         return $linktext if length $bestlink && $page eq $bestlink;
282         
283         # TODO BUG: %renderedfiles may not have it, if the linked to page
284         # was also added and isn't yet rendered! Note that this bug is
285         # masked by the bug that makes all new files be rendered twice.
286         if (! grep { $_ eq $bestlink } values %renderedfiles) {
287                 $bestlink=htmlpage($bestlink);
288         }
289         if (! grep { $_ eq $bestlink } values %renderedfiles) {
290                 return "<span><a href=\"".
291                         cgiurl(do => "create", page => $link, from => $page).
292                         "\">?</a>$linktext</span>"
293         }
294         
295         require File::Spec;
296         $bestlink=File::Spec->abs2rel($bestlink, dirname($page));
297         
298         if (! $noimageinline && isinlinableimage($bestlink)) {
299                 return "<img src=\"$bestlink\" alt=\"$linktext\" />";
300         }
301         return "<a href=\"$bestlink\">$linktext</a>";
302 } #}}}
303
304 sub indexlink () { #{{{
305         return "<a href=\"$config{url}\">$config{wikiname}</a>";
306 } #}}}
307
308 sub lockwiki () { #{{{
309         # Take an exclusive lock on the wiki to prevent multiple concurrent
310         # run issues. The lock will be dropped on program exit.
311         if (! -d $config{wikistatedir}) {
312                 mkdir($config{wikistatedir});
313         }
314         open(WIKILOCK, ">$config{wikistatedir}/lockfile") ||
315                 error ("cannot write to $config{wikistatedir}/lockfile: $!");
316         if (! flock(WIKILOCK, 2 | 4)) {
317                 debug("wiki seems to be locked, waiting for lock");
318                 my $wait=600; # arbitrary, but don't hang forever to 
319                               # prevent process pileup
320                 for (1..600) {
321                         return if flock(WIKILOCK, 2 | 4);
322                         sleep 1;
323                 }
324                 error("wiki is locked; waited $wait seconds without lock being freed (possible stuck process or stale lock?)");
325         }
326 } #}}}
327
328 sub unlockwiki () { #{{{
329         close WIKILOCK;
330 } #}}}
331
332 sub loadindex () { #{{{
333         open (IN, "$config{wikistatedir}/index") || return;
334         while (<IN>) {
335                 $_=possibly_foolish_untaint($_);
336                 chomp;
337                 my %items;
338                 $items{link}=[];
339                 foreach my $i (split(/ /, $_)) {
340                         my ($item, $val)=split(/=/, $i, 2);
341                         push @{$items{$item}}, $val;
342                 }
343
344                 next unless exists $items{src}; # skip bad lines for now
345
346                 my $page=pagename($items{src}[0]);
347                 if (! $config{rebuild}) {
348                         $pagesources{$page}=$items{src}[0];
349                         $oldpagemtime{$page}=$items{mtime}[0];
350                         $oldlinks{$page}=[@{$items{link}}];
351                         $links{$page}=[@{$items{link}}];
352                         $depends{$page}=join(" ", @{$items{depends}})
353                                 if exists $items{depends};
354                         $renderedfiles{$page}=$items{dest}[0];
355                 }
356                 $pagectime{$page}=$items{ctime}[0];
357         }
358         close IN;
359 } #}}}
360
361 sub saveindex () { #{{{
362         if (! -d $config{wikistatedir}) {
363                 mkdir($config{wikistatedir});
364         }
365         open (OUT, ">$config{wikistatedir}/index") || 
366                 error("cannot write to $config{wikistatedir}/index: $!");
367         foreach my $page (keys %oldpagemtime) {
368                 next unless $oldpagemtime{$page};
369                 my $line="mtime=$oldpagemtime{$page} ".
370                         "ctime=$pagectime{$page} ".
371                         "src=$pagesources{$page} ".
372                         "dest=$renderedfiles{$page}";
373                 $line.=" link=$_" foreach @{$links{$page}};
374                 if (exists $depends{$page}) {
375                         $line.=" depends=$_" foreach split " ", $depends{$page};
376                 }
377                 print OUT $line."\n";
378         }
379         close OUT;
380 } #}}}
381
382 sub template_params (@) { #{{{
383         my $filename=shift;
384         
385         require HTML::Template;
386         return filter => sub {
387                         my $text_ref = shift;
388                         $$text_ref=&Encode::decode_utf8($$text_ref);
389                 },
390                 filename => "$config{templatedir}/$filename", @_;
391 } #}}}
392
393 sub template ($;@) { #{{{
394         HTML::Template->new(template_params(@_));
395 } #}}}
396
397 sub misctemplate ($$) { #{{{
398         my $title=shift;
399         my $pagebody=shift;
400         
401         my $template=template("misc.tmpl");
402         $template->param(
403                 title => $title,
404                 indexlink => indexlink(),
405                 wikiname => $config{wikiname},
406                 pagebody => $pagebody,
407                 styleurl => styleurl(),
408                 baseurl => "$config{url}/",
409         );
410         return $template->output;
411 }#}}}
412
413 sub glob_match ($$) { #{{{
414         my $page=shift;
415         my $glob=shift;
416
417         if ($glob =~ /^link\((.+)\)$/) {
418                 my $rev = $links{$page} or return undef;
419                 foreach my $p (@$rev) {
420                         return 1 if lc $p eq $1;
421                 }
422                 return 0;
423         } elsif ($glob =~ /^backlink\((.+)\)$/) {
424                 my $rev = $links{$1} or return undef;
425                 foreach my $p (@$rev) {
426                         return 1 if lc $p eq $page;
427                 }
428                 return 0;
429         } else {
430                 # turn glob into safe regexp
431                 $glob=quotemeta($glob);
432                 $glob=~s/\\\*/.*/g;
433                 $glob=~s/\\\?/./g;
434                 $glob=~s!\\/!/!g;
435                 
436                 return $page=~/^$glob$/i;
437         }
438 } #}}}
439
440 sub globlist_match ($$) { #{{{
441         my $page=shift;
442         my @globlist=split(" ", shift);
443
444         # check any negated globs first
445         foreach my $glob (@globlist) {
446                 return 0 if $glob=~/^!(.*)/ && glob_match($page, $1);
447         }
448
449         foreach my $glob (@globlist) {
450                 return 1 if glob_match($page, $glob);
451         }
452         
453         return 0;
454 } #}}}
455
456 sub hook (@) { # {{{
457         my %param=@_;
458         
459         if (! exists $param{type} || ! ref $param{call} || ! exists $param{id}) {
460                 error "hook requires type, call, and id parameters";
461         }
462         
463         $hooks{$param{type}}{$param{id}}=\%param;
464 } # }}}
465
466 1