]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Render.pm
3be8e1c53ff96973891c758875b93d9ac3cc2bfc
[ikiwiki.git] / IkiWiki / Render.pm
1 #!/usr/bin/perl
2
3 package IkiWiki;
4
5 use warnings;
6 use strict;
7 use File::Spec;
8 use IkiWiki;
9
10 sub linkify ($$$) { #{{{
11         my $lpage=shift;
12         my $page=shift;
13         my $content=shift;
14
15         $content =~ s{(\\?)$config{wiki_link_regexp}}{
16                 $2 ? ( $1 ? "[[$2|$3]]" : htmllink($lpage, $page, titlepage($3), 0, 0, pagetitle($2)))
17                    : ( $1 ? "[[$3]]" :    htmllink($lpage, $page, titlepage($3)))
18         }eg;
19         
20         return $content;
21 } #}}}
22
23 sub htmlize ($$) { #{{{
24         my $type=shift;
25         my $content=shift;
26         
27         if (! $INC{"/usr/bin/markdown"}) {
28                 # Note: a proper perl module is available in Debian
29                 # for markdown, but not upstream yet.
30                 no warnings 'once';
31                 $blosxom::version="is a proper perl module too much to ask?";
32                 use warnings 'all';
33                 do "/usr/bin/markdown";
34                 require Encode;
35         }
36         
37         if ($type eq '.mdwn') {
38                 # Workaround for perl bug (#376329)
39                 $content=Encode::encode_utf8($content);
40                 $content=Encode::encode_utf8($content);
41                 $content=Markdown::Markdown($content);
42                 $content=Encode::decode_utf8($content);
43                 $content=Encode::decode_utf8($content);
44         }
45         else {
46                 error("htmlization of $type not supported");
47         }
48
49         if (exists $hooks{sanitize}) {
50                 foreach my $id (keys %{$hooks{sanitize}}) {
51                         $content=$hooks{sanitize}{$id}{call}->($content);
52                 }
53         }
54         
55         return $content;
56 } #}}}
57
58 sub backlinks ($) { #{{{
59         my $page=shift;
60
61         my @links;
62         foreach my $p (keys %links) {
63                 next if bestlink($page, $p) eq $page;
64                 if (grep { length $_ && bestlink($p, $_) eq $page } @{$links{$p}}) {
65                         my $href=File::Spec->abs2rel(htmlpage($p), dirname($page));
66                         
67                         # Trim common dir prefixes from both pages.
68                         my $p_trimmed=$p;
69                         my $page_trimmed=$page;
70                         my $dir;
71                         1 while (($dir)=$page_trimmed=~m!^([^/]+/)!) &&
72                                 defined $dir &&
73                                 $p_trimmed=~s/^\Q$dir\E// &&
74                                 $page_trimmed=~s/^\Q$dir\E//;
75                                        
76                         push @links, { url => $href, page => $p_trimmed };
77                 }
78         }
79
80         return sort { $a->{page} cmp $b->{page} } @links;
81 } #}}}
82
83 sub parentlinks ($) { #{{{
84         my $page=shift;
85         
86         my @ret;
87         my $pagelink="";
88         my $path="";
89         my $skip=1;
90         foreach my $dir (reverse split("/", $page)) {
91                 if (! $skip) {
92                         $path.="../";
93                         unshift @ret, { url => "$path$dir.html", page => $dir };
94                 }
95                 else {
96                         $skip=0;
97                 }
98         }
99         unshift @ret, { url => length $path ? $path : ".", page => $config{wikiname} };
100         return @ret;
101 } #}}}
102
103 sub preprocess ($$;$) { #{{{
104         my $page=shift;
105         my $content=shift;
106         my $onlystrip=shift || 0; # strip directives without processing
107
108         my $handle=sub {
109                 my $escape=shift;
110                 my $command=shift;
111                 my $params=shift;
112                 if (length $escape) {
113                         return "[[$command $params]]";
114                 }
115                 elsif ($onlystrip) {
116                         return "";
117                 }
118                 elsif (exists $hooks{preprocess}{$command}) {
119                         # Note: preserve order of params, some plugins may
120                         # consider it significant.
121                         my @params;
122                         while ($params =~ /(\w+)=\"?([^"]+)"?(\s+|$)/g) {
123                                 push @params, $1, $2;
124                         }
125                         return $hooks{preprocess}{$command}{call}->(@params, page => $page);
126                 }
127                 else {
128                         return "[[$command not processed]]";
129                 }
130         };
131         
132         $content =~ s{(\\?)$config{wiki_processor_regexp}}{$handle->($1, $2, $3)}eg;
133         return $content;
134 } #}}}
135
136 sub add_depends ($$) { #{{{
137         my $page=shift;
138         my $globlist=shift;
139         
140         if (! exists $depends{$page}) {
141                 $depends{$page}=$globlist;
142         }
143         else {
144                 $depends{$page}=globlist_merge($depends{$page}, $globlist);
145         }
146 } # }}}
147
148 sub globlist_merge ($$) { #{{{
149         my $a=shift;
150         my $b=shift;
151
152         my $ret="";
153         # Only add negated globs if they are not matched by the other globlist.
154         foreach my $i ((map { [ $a, $_ ] } split(" ", $b)), 
155                        (map { [ $b, $_ ] } split(" ", $a))) {
156                 if ($i->[1]=~/^!(.*)/) {
157                         if (! globlist_match($1, $i->[0])) {
158                                 $ret.=" ".$i->[1];
159                         }
160                 }
161                 else {
162                         $ret.=" ".$i->[1];
163                 }
164         }
165         
166         return $ret;
167 } #}}}
168
169 sub genpage ($$$) { #{{{
170         my $page=shift;
171         my $content=shift;
172         my $mtime=shift;
173
174         my $title=pagetitle(basename($page));
175         
176         my $template=template("page.tmpl", blind_cache => 1);
177         my $actions=0;
178
179         if (length $config{cgiurl}) {
180                 $template->param(editurl => cgiurl(do => "edit", page => $page));
181                 $template->param(prefsurl => cgiurl(do => "prefs"));
182                 if ($config{rcs}) {
183                         $template->param(recentchangesurl => cgiurl(do => "recentchanges"));
184                 }
185                 $actions++;
186         }
187
188         if (length $config{historyurl}) {
189                 my $u=$config{historyurl};
190                 $u=~s/\[\[file\]\]/$pagesources{$page}/g;
191                 $template->param(historyurl => $u);
192                 $actions++;
193         }
194         if ($config{discussion}) {
195                 $template->param(discussionlink => htmllink($page, $page, "Discussion", 1, 1));
196                 $actions++;
197         }
198
199         if ($actions) {
200                 $template->param(have_actions => 1);
201         }
202
203         $template->param(
204                 title => $title,
205                 wikiname => $config{wikiname},
206                 parentlinks => [parentlinks($page)],
207                 content => $content,
208                 backlinks => [backlinks($page)],
209                 mtime => displaytime($mtime),
210                 styleurl => styleurl($page),
211         );
212
213         if (exists $hooks{pagetemplate}) {
214                 foreach my $id (keys %{$hooks{pagetemplate}}) {
215                         $hooks{pagetemplate}{$id}{call}->($page, $template);
216                 }
217         }
218         
219         return $template->output;
220 } #}}}
221
222 sub check_overwrite ($$) { #{{{
223         # Important security check. Make sure to call this before saving
224         # any files to the source directory.
225         my $dest=shift;
226         my $src=shift;
227         
228         if (! exists $renderedfiles{$src} && -e $dest && ! $config{rebuild}) {
229                 error("$dest already exists and was rendered from ".
230                         join(" ",(grep { $renderedfiles{$_} eq $dest } keys
231                                 %renderedfiles)).
232                         ", before, so not rendering from $src");
233         }
234 } #}}}
235
236 sub displaytime ($) { #{{{
237         my $time=shift;
238
239         eval q{use POSIX};
240         # strftime doesn't know about encodings, so make sure
241         # its output is properly treated as utf8
242         return Encode::decode_utf8(POSIX::strftime(
243                         $config{timeformat}, localtime($time)));
244 } #}}}
245
246 sub mtime ($) { #{{{
247         my $file=shift;
248         
249         return (stat($file))[9];
250 } #}}}
251
252 sub findlinks ($$) { #{{{
253         my $page=shift;
254         my $content=shift;
255
256         my @links;
257         while ($content =~ /(?<!\\)$config{wiki_link_regexp}/g) {
258                 push @links, titlepage($2);
259         }
260         if ($config{discussion}) {
261                 # Discussion links are a special case since they're not in the
262                 # text of the page, but on its template.
263                 return @links, "$page/discussion";
264         }
265         else {
266                 return @links;
267         }
268 } #}}}
269
270 sub render ($) { #{{{
271         my $file=shift;
272         
273         my $type=pagetype($file);
274         my $srcfile=srcfile($file);
275         if ($type ne 'unknown') {
276                 my $content=readfile($srcfile);
277                 my $page=pagename($file);
278                 delete $depends{$page};
279                 
280                 if (exists $hooks{filter}) {
281                         foreach my $id (keys %{$hooks{filter}}) {
282                                 $content=$hooks{filter}{$id}{call}->(
283                                         page => $page,
284                                         content => $content
285                                 );
286                         }
287                 }
288                 
289                 $links{$page}=[findlinks($page, $content)];
290                 
291                 $content=linkify($page, $page, $content);
292                 $content=preprocess($page, $content);
293                 $content=htmlize($type, $content);
294                 
295                 check_overwrite("$config{destdir}/".htmlpage($page), $page);
296                 writefile(htmlpage($page), $config{destdir},
297                         genpage($page, $content, mtime($srcfile)));
298                 $oldpagemtime{$page}=time;
299                 $renderedfiles{$page}=htmlpage($page);
300         }
301         else {
302                 my $content=readfile($srcfile, 1);
303                 $links{$file}=[];
304                 delete $depends{$file};
305                 check_overwrite("$config{destdir}/$file", $file);
306                 writefile($file, $config{destdir}, $content, 1);
307                 $oldpagemtime{$file}=time;
308                 $renderedfiles{$file}=$file;
309         }
310 } #}}}
311
312 sub prune ($) { #{{{
313         my $file=shift;
314
315         unlink($file);
316         my $dir=dirname($file);
317         while (rmdir($dir)) {
318                 $dir=dirname($dir);
319         }
320 } #}}}
321
322 sub refresh () { #{{{
323         # find existing pages
324         my %exists;
325         my @files;
326         eval q{use File::Find};
327         find({
328                 no_chdir => 1,
329                 wanted => sub {
330                         if (/$config{wiki_file_prune_regexp}/) {
331                                 $File::Find::prune=1;
332                         }
333                         elsif (! -d $_ && ! -l $_) {
334                                 my ($f)=/$config{wiki_file_regexp}/; # untaint
335                                 if (! defined $f) {
336                                         warn("skipping bad filename $_\n");
337                                 }
338                                 else {
339                                         $f=~s/^\Q$config{srcdir}\E\/?//;
340                                         push @files, $f;
341                                         $exists{pagename($f)}=1;
342                                 }
343                         }
344                 },
345         }, $config{srcdir});
346         find({
347                 no_chdir => 1,
348                 wanted => sub {
349                         if (/$config{wiki_file_prune_regexp}/) {
350                                 $File::Find::prune=1;
351                         }
352                         elsif (! -d $_ && ! -l $_) {
353                                 my ($f)=/$config{wiki_file_regexp}/; # untaint
354                                 if (! defined $f) {
355                                         warn("skipping bad filename $_\n");
356                                 }
357                                 else {
358                                         # Don't add files that are in the
359                                         # srcdir.
360                                         $f=~s/^\Q$config{underlaydir}\E\/?//;
361                                         if (! -e "$config{srcdir}/$f" && 
362                                             ! -l "$config{srcdir}/$f") {
363                                                 push @files, $f;
364                                                 $exists{pagename($f)}=1;
365                                         }
366                                 }
367                         }
368                 },
369         }, $config{underlaydir});
370
371         my %rendered;
372
373         # check for added or removed pages
374         my @add;
375         foreach my $file (@files) {
376                 my $page=pagename($file);
377                 if (! $oldpagemtime{$page}) {
378                         debug("new page $page") unless exists $pagectime{$page};
379                         push @add, $file;
380                         $links{$page}=[];
381                         $pagesources{$page}=$file;
382                         if ($config{getctime} && -e "$config{srcdir}/$file") {
383                                 $pagectime{$page}=rcs_getctime("$config{srcdir}/$file");
384                         }
385                         elsif (! exists $pagectime{$page}) {
386                                 $pagectime{$page}=mtime(srcfile($file));
387                         }
388                 }
389         }
390         my @del;
391         foreach my $page (keys %oldpagemtime) {
392                 if (! $exists{$page}) {
393                         debug("removing old page $page");
394                         push @del, $pagesources{$page};
395                         prune($config{destdir}."/".$renderedfiles{$page});
396                         delete $renderedfiles{$page};
397                         $oldpagemtime{$page}=0;
398                         delete $pagesources{$page};
399                 }
400         }
401         
402         # render any updated files
403         foreach my $file (@files) {
404                 my $page=pagename($file);
405                 
406                 if (! exists $oldpagemtime{$page} ||
407                     mtime(srcfile($file)) > $oldpagemtime{$page}) {
408                         debug("rendering changed file $file");
409                         render($file);
410                         $rendered{$file}=1;
411                 }
412         }
413         
414         # if any files were added or removed, check to see if each page
415         # needs an update due to linking to them or inlining them.
416         # TODO: inefficient; pages may get rendered above and again here;
417         # problem is the bestlink may have changed and we won't know until
418         # now
419         if (@add || @del) {
420 FILE:           foreach my $file (@files) {
421                         my $page=pagename($file);
422                         foreach my $f (@add, @del) {
423                                 my $p=pagename($f);
424                                 foreach my $link (@{$links{$page}}) {
425                                         if (bestlink($page, $link) eq $p) {
426                                                 debug("rendering $file, which links to $p");
427                                                 render($file);
428                                                 $rendered{$file}=1;
429                                                 next FILE;
430                                         }
431                                 }
432                         }
433                 }
434         }
435
436         # Handle backlinks; if a page has added/removed links, update the
437         # pages it links to. Also handles rebuilding dependant pages.
438         # TODO: inefficient; pages may get rendered above and again here;
439         # problem is the backlinks could be wrong in the first pass render
440         # above
441         if (%rendered || @del) {
442                 foreach my $f (@files) {
443                         my $p=pagename($f);
444                         if (exists $depends{$p}) {
445                                 foreach my $file (keys %rendered, @del) {
446                                         next if $f eq $file;
447                                         my $page=pagename($file);
448                                         if (globlist_match($page, $depends{$p})) {
449                                                 debug("rendering $f, which depends on $page");
450                                                 render($f);
451                                                 $rendered{$f}=1;
452                                                 last;
453                                         }
454                                 }
455                         }
456                 }
457                 
458                 my %linkchanged;
459                 foreach my $file (keys %rendered, @del) {
460                         my $page=pagename($file);
461                         
462                         if (exists $links{$page}) {
463                                 foreach my $link (map { bestlink($page, $_) } @{$links{$page}}) {
464                                         if (length $link &&
465                                             (! exists $oldlinks{$page} ||
466                                              ! grep { bestlink($page, $_) eq $link } @{$oldlinks{$page}})) {
467                                                 $linkchanged{$link}=1;
468                                         }
469                                 }
470                         }
471                         if (exists $oldlinks{$page}) {
472                                 foreach my $link (map { bestlink($page, $_) } @{$oldlinks{$page}}) {
473                                         if (length $link &&
474                                             (! exists $links{$page} || 
475                                              ! grep { bestlink($page, $_) eq $link } @{$links{$page}})) {
476                                                 $linkchanged{$link}=1;
477                                         }
478                                 }
479                         }
480                 }
481                 foreach my $link (keys %linkchanged) {
482                         my $linkfile=$pagesources{$link};
483                         if (defined $linkfile) {
484                                 debug("rendering $linkfile, to update its backlinks");
485                                 render($linkfile);
486                                 $rendered{$linkfile}=1;
487                         }
488                 }
489         }
490
491         if (@del && exists $hooks{delete}) {
492                 foreach my $id (keys %{$hooks{delete}}) {
493                         $hooks{delete}{$id}{call}->(@del);
494                 }
495         }
496         if (%rendered && exists $hooks{change}) {
497                 foreach my $id (keys %{$hooks{change}}) {
498                         $hooks{change}{$id}{call}->(keys %rendered);
499                 }
500         }
501 } #}}}
502
503 1