I've wrote a little patch for the bug in teximg (can only include fomula on
[ikiwiki.git] / IkiWiki / Plugin / teximg.pm
1 #!/usr/bin/perl
2 # Licensed under GPL v2 or greater
3 # (c) 2007 Patrick Winnertz <patrick.winnertz@skolelinux.org>
4
5 package IkiWiki::Plugin::teximg;
6 use warnings;
7 use strict;
8 use Digest::MD5 qw(md5_hex);
9 use File::Temp qw(tempdir);
10 use HTML::Entities;
11 use IkiWiki 2.00;
12
13 sub import { #{{{
14         hook(type => "preprocess", id => "teximg", call => \&preprocess);
15 } #}}}
16
17 sub preprocess (@) { #{{{
18         my %params = @_;
19         
20         my $height = $params{height};
21         if (! defined $height || ! length $height) {
22                 $height = 12;
23         }
24         else {
25                 $height =~ s#(\d+)#$1#;
26         }
27         
28         my $code = $params{code};
29         if (! defined $code && ! length $code) {
30                 return "[[teximg ".gettext("missing tex code"). "]]";
31         }
32
33         if (check($code)) {
34                 return create($code, check_height($height), \%params);
35         }
36         else {
37                 return "[[teximg ".gettext("code includes disallowed latex commands"). "]]";
38         }
39 } #}}}
40
41 sub check_height ($) { #{{{
42         # Since latex doesn't support unlimited scaling this function
43         # returns the closest supported size.
44         my $height =shift;
45
46         my @allowed=(8,9,10,11,12,14,17,20);
47
48         my $ret;
49         my $fit;
50         foreach my $val (@allowed) {
51                 my $f = abs($val - $height);
52                 if (! defined($fit) || $f < $fit ) {
53                         $ret=$val;
54                         $fit=$f;
55                 }
56         }
57         return $ret;
58 } #}}}
59
60 sub create ($$$) { #{{{
61         # This function calls the image generating function and returns
62         # the <img .. /> for the generated image.
63         my $code = shift;
64         my $height = shift;
65         my $params = shift;
66
67         if (! defined($height) and not length($height) ) {
68                 $height = 12;
69         }
70
71         my $digest = md5_hex($code, $height);
72
73         my $imglink= $params->{page} . "/$digest.png";
74         my $imglog =  $params->{page} .  "/$digest.log";
75         will_render($params->{destpage}, $imglink);
76         will_render($params->{destpage}, $imglog);
77
78         my $imgurl;
79         my $logurl;
80         if (! $params->{preview}) {
81                 $imgurl = urlto($imglink, $params->{destpage});
82                 $logurl = urlto($imglog, $params->{destpage});
83         }
84         else {
85                 $imgurl="$params->{page}/$digest.png";
86                 $logurl="$params->{page}/$digest.log";
87         }
88         
89         if (-e "$config{destdir}/$imglink" ||
90             gen_image($code, $height, $digest, $params->{page})) {
91                 return qq{<img src="$imgurl" alt="}
92                         .(exists $params->{alt} ? $params->{alt} : encode_entities($code))
93                         .qq{" class="teximg" />};
94         }
95         else {
96                 return qq{[[teximg <a href="$logurl">}.gettext("failed to generate image from code")."</a>]]";
97         }
98 } #}}}
99
100 sub gen_image ($$$$) { #{{{
101         # Actually creates the image.
102         my $code = shift;
103         my $height = shift;
104         my $digest = shift;
105         my $imagedir = shift;
106
107         #TODO This should move into the setup file.
108         my $tex = '\documentclass['.$height.'pt]{scrartcl}';
109         $tex .= '\usepackage[version=3]{mhchem}';
110         $tex .= '\usepackage{amsmath}';
111         $tex .= '\usepackage{amsfonts}';
112         $tex .= '\usepackage{amssymb}';
113         $tex .= '\pagestyle{empty}';
114         $tex .= '\begin{document}';
115         $tex .= '$$'.$code.'$$';
116         $tex .= '\end{document}';
117
118         my $tmp = eval { create_tmp_dir($digest) };
119         if (! $@ &&
120             writefile("$digest.tex", $tmp, $tex) &&
121             system("cd $tmp; latex --interaction=nonstopmode $tmp/$digest.tex > /dev/null") == 0 &&
122             system("dvips -E $tmp/$digest.dvi -o $tmp/$digest.ps 2> $tmp/$digest.log") == 0 &&
123             # ensure destination directory exists
124             writefile("$imagedir/$digest.png", $config{destdir}, "") &&
125             system("convert -density 120  -trim -transparent \"#FFFFFF\" $tmp/$digest.ps $config{destdir}/$imagedir/$digest.png > $tmp/$digest.log") == 0) {
126                 return 1;
127         }
128         else {
129                 # store failure log
130                 my $log;
131                 {
132                         open(my $f, '<', "$tmp/$digest.log");
133                         local $/=undef;
134                         $log = <$f>;
135                         close($f);
136                 }
137                 writefile("$digest.log", "$config{destdir}/$imagedir", $log);
138
139                 return 0;
140         }
141 } #}}}
142
143 sub create_tmp_dir ($) { #{{{
144         # Create a temp directory, it will be removed when ikiwiki exits.
145         my $base = shift;
146
147         my $template = $base.".XXXXXXXXXX";
148         my $tmpdir = tempdir($template, TMPDIR => 1, CLEANUP => 1);
149         return $tmpdir;
150 } #}}}
151
152 sub check ($) { #{{{
153         # Check if the code is ok
154         my $code = shift;
155
156         my @badthings = (
157                 qr/\$\$/,
158                 qr/\\include/,
159                 qr/\\includegraphic/,
160                 qr/\\usepackage/,
161                 qr/\\newcommand/, 
162                 qr/\\renewcommand/,
163                 qr/\\def/,
164                 qr/\\input/,
165                 qr/\\open/,
166                 qr/\\loop/,
167                 qr/\\errorstopmode/,
168                 qr/\\scrollmode/,
169                 qr/\\batchmode/,
170                 qr/\\read/,
171                 qr/\\write/,
172         );
173         
174         foreach my $thing (@badthings) {
175                 if ($code =~ m/$thing/ ) {
176                         return 0;
177                 }
178         }
179         return 1;
180 } #}}}
181
182 1