1: # The LearningOnline Network with CAPA
2: # TeX Conversion Module
3: #
4: # $Id: lontexconvert.pm,v 1.69 2006/01/27 23:55:15 albertel Exp $
5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28: # Copyright for TtHfunc and TtMfunc by Ian Hutchinson.
29: # TtHfunc and TtMfunc (the "Code") may be compiled and linked into
30: # binary executable programs or libraries distributed by the
31: # Michigan State University (the "Licensee"), but any binaries so
32: # distributed are hereby licensed only for use in the context
33: # of a program or computational system for which the Licensee is the
34: # primary author or distributor, and which performs substantial
35: # additional tasks beyond the translation of (La)TeX into HTML.
36: # The C source of the Code may not be distributed by the Licensee
37: # to any other parties under any circumstances.
38: #
39:
40: package Apache::lontexconvert;
41:
42: use strict;
43: use tth();
44: use vars qw($errorstring);
45: use Apache();
46: use Apache::lonmsg();
47: use Apache::lonxml();
48: use Apache::lonmenu();
49: use Apache::lonlocal;
50: use Apache::lonnet;
51:
52: # ====================================================================== Header
53:
54: sub init_tth {
55: my $options=$env{'course.'.$env{'request.course.id'}.'.tthoptions'};
56: if ($env{'browser.mathml'}) {
57: &tth::ttminit();
58: if ($env{'browser.unicode'}) {
59: &tth::ttmoptions('-L -u1 '.$options);
60: } else {
61: &tth::ttmoptions('-L -u0 '.$options);
62: }
63: } else {
64: &tth::tthinit();
65: if ($env{'browser.unicode'}) {
66: &tth::tthoptions('-L -u1 '.$options);
67: } else {
68: &tth::tthoptions('-L -u0 '.$options);
69: }
70: }
71: }
72:
73: sub header {
74: $errorstring='';
75: my $time=time;
76: &init_tth();
77: return &Apache::lonxml::xmlbegin().
78: "\n<head>\n".
79: &Apache::lonxml::fontsettings().
80: &Apache::lonmenu::registerurl(undef,'tex').
81: "\n</head>\n";
82: }
83:
84: # ================================================================== Conversion
85:
86: $Apache::lontexconvert::messedup=0;
87:
88: # we need this routine because &converted can get called from inside
89: # of the safespace (through &xmlparse('<m>stuff</m>') which doesn't
90: # allow the opcode for alarm, so we need to compile this before we get
91: # into the safe space since opcode checks only occur at compile time
92: sub convert_real {
93: my ($texstring)=@_;
94: my ($xmlstring,$errorstring);
95: local $SIG{SEGV}=sub { $Apache::lontexconvert::messedup=1; die; };
96: local $SIG{ALRM}=sub {
97: &Apache::lonnet::logthis("ALRM");
98: $xmlstring='['.&mt("TeX unconverted due to errors").']';
99: $Apache::lontexconvert::messedup=1;
100: die &mt("TeX unconverted due to errors");
101: };
102: &Apache::lonxml::start_alarm();
103: if ($env{'browser.mathml'}) {
104: $xmlstring=&tth::ttm($$texstring);
105: $xmlstring=~s/\<math\>/\<math xmlns=\"\&mathns\;\"\>/g;
106: $xmlstring=~s/\<br\>/\<br\/\>/g;
107: $xmlstring=~s/\<p\>/\<p\>\<\/p\>/g;
108: $errorstring.=&tth::ttmerror();
109: } else {
110: $xmlstring=&tth::tth($$texstring);
111: $errorstring.=&tth::ttherror();
112: $xmlstring=~s-</font(\s*)>-</font>-g;
113: }
114: $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
115: $xmlstring=~s/^\s*//;
116: $xmlstring=~s/\s*$//;
117: &Apache::lonxml::end_alarm();
118: return ($xmlstring,$errorstring);
119: }
120:
121: sub tth_converted {
122: my $texstring=shift;
123: my $xmlstring='['.&mt('UNDISPLAYABLE').']';
124: if ($Apache::lontexconvert::messedup) {
125: return '['.&mt('TeX unconverted due to previous errors').']';
126: }
127: $$texstring ='\\documentstyle{article}'.$$texstring;
128:
129: eval(<<'ENDCONV');
130: ($xmlstring,$errorstring)=&convert_real($texstring)
131: ENDCONV
132: if ($@) {
133: $errorstring.=&mt("Evaluation Error: ").$@;
134: $Apache::lontexconvert::messedup=1;
135: }
136: if ($Apache::lontexconvert::messedup || &tth::tthmessedup() ||
137: $errorstring) {
138: &Apache::lonnet::logthis("Trying to kill myself");
139: $Apache::lontexconvert::messedup=1;
140: $Apache::lonxml::request->child_terminate();
141: }
142: return $xmlstring;
143: }
144:
145: sub clean_out_math_mode {
146: my ($texstring)=@_;
147: $$texstring=~s/(?!\\)\$//g;
148: $$texstring=~s/\\[\)\(\]\[]//g;
149: $$texstring=~s/\\ensuremath//g;
150: return '';
151: }
152:
153: sub displaystyle {
154: my ($texstring)=@_;
155: #has a $$ or \[ or \displaystyle in it, guessinng it's display mode
156: if ($$texstring=~/[^\\]\$\$/ ||
157: $$texstring=~/\\\[/ ||
158: $$texstring=~/\\displaystyle/) { return 1; }
159: return 0;
160: }
161:
162: sub jsMath_converted {
163: my $texstring=shift;
164: my $tag='span';
165: if (&displaystyle($texstring)) { $tag='div'; }
166: &clean_out_math_mode($texstring);
167: return &jsMath_header().
168: '<'.$tag.' class="math">'.$$texstring.'</'.$tag.'>';
169: }
170:
171: {
172: my $jsMath_sent_header;
173: sub jsMath_reset {
174: $jsMath_sent_header=0;
175: }
176: sub jsMath_header {
177: return '' if $jsMath_sent_header;
178: $jsMath_sent_header=1;
179: return
180: '<script type="text/javascript">
181: function NoFontMessage () {}
182: </script>'."\n".
183: '<script src="/adm/jsMath/jsMath.js"></script>'."\n";
184: }
185: sub jsMath_process {
186: return '' if !$jsMath_sent_header;
187: return '<script type="text/javascript">jsMath.Process()</script>';
188: }
189: }
190:
191: sub mimetex_converted {
192: my $texstring=shift;
193: my $displaystyle=&displaystyle($texstring);
194:
195: &clean_out_math_mode($texstring);
196:
197: if ($displaystyle) {
198: $$texstring='\\displaystyle \\Large '.$$texstring;
199: }
200: my $result='<img src="/cgi-bin/mimetex.cgi?'.&Apache::lonnet::escape($$texstring).'" />';
201: if ($displaystyle) {
202: $result='<center>'.$result.'</center>';
203: }
204: return $result;
205: }
206:
207: sub converted {
208: my ($string,$mode)=@_;
209: if ($mode eq '') { $mode=$env{'environment.texengine'}; }
210: if ($mode =~ /tth/i) {
211: return &tth_converted($string);
212: } elsif ($mode =~ /jsmath/i) {
213: return &jsMath_converted($string);
214: } elsif ($mode =~ /mimetex/i) {
215: return &mimetex_converted($string);
216: }
217: return &tth_converted($string);
218: }
219:
220: # ====================================================================== Footer
221:
222: sub footer {
223: my $xmlstring='';
224: if ($env{'request.state'} eq 'construct') {
225: $xmlstring.='<address>'.$errorstring.'</address>';
226: } else {
227: &Apache::lonmsg::author_res_msg($env{'request.filename'},$errorstring);
228: }
229: # -------------------------------------------------------------------- End Body
230: $xmlstring.=&Apache::lonxml::xmlend();
231: return $xmlstring;
232: }
233:
234: # ------------------------------------------------------------ Message display
235:
236: sub to_convert {
237: my ($string) = @_;
238: $string=~s/\<br\s*\/?\>/ /gs;
239: # $string=~s/\s/ /gs;
240: $string=&HTML::Entities::decode($string);
241: return &converted(\$string);
242: }
243:
244: sub smiley {
245: my $expression=shift;
246: if ($env{'browser.imagesuppress'} eq 'on') { return $expression; }
247: my %smileys=('\:\-\)' => 'smiley',
248: '8\-\)' => 'coolsmile',
249: '8\-(I|\|)' => 'coolindiff',
250: ':\-(I|\|)' => 'neutral',
251: '\:\-(o|O|\(\))' => 'shocked',
252: ':\-\(' => 'frowny',
253: '\;\-\)' => 'wink',
254: '\:\-P' => 'baeh',
255: '\:\-(\\\|\\/)' => 'hrrm',
256: '\:\-D' => 'bigsmile',
257: '\:\-C' => 'angry',
258: '\:(\'|\`)\-\(' => 'cry',
259: '\:\-(X|\#)' => 'lipsrsealed',
260: '\:\-S' => 'huh');
261: my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
262: foreach (keys %smileys) {
263: $expression=~s/$_/\<img src="$iconpath\/$smileys{$_}.gif" \/\>/gs;
264: }
265: return $expression;
266: }
267:
268: sub msgtexconverted {
269: my ($message,$email) = @_;
270: $errorstring='';
271: &init_tth();
272: my $outmessage='';
273: my $tex=0;
274: foreach (split(/(?:\<\;|\<)\/*m\s*(?:\>\;|\>)/i,$message)) {
275: if ($tex) {
276: if ($email) {
277: $outmessage.='</pre><tt>'.&to_convert($_).'</tt><pre>'; $tex=0;
278: } else {
279: $outmessage.=&to_convert($_); $tex=0;
280: }
281: } else {
282: $outmessage.=&smiley($_); $tex=1;
283: }
284: }
285: $message=$outmessage; $outmessage=''; $tex=0;
286: foreach (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i,$message)) {
287: if ($tex) {
288: if ($email) {
289: $outmessage.='</pre><tt>'.&algebra($_,'web').'</tt><pre>'; $tex=0;
290: } else {
291: $outmessage.=&algebra($_,'web'); $tex=0;
292: }
293: } else {
294: $outmessage.=$_; $tex=1;
295: }
296: }
297: if (wantarray) {
298: return ($outmessage,$errorstring);
299: } else {
300: return $outmessage.$errorstring;
301: }
302: }
303:
304: sub algebra {
305: use AlgParser;
306:
307: my ($string,$target,$style)=@_;
308: my $parser = new AlgParserWithImplicitExpand;
309: $string=&prepare_algebra($string);
310: my $ret = $parser->parse($string);
311: my $result='['.&mt('Algebra unconverted due to previous errors').']';
312: if ( ref($ret) ) {
313: #$parser->tostring();
314: $parser->normalize();
315: my $latex=$parser->tolatex();
316: $latex=&postprocess_algebra($latex);
317: if ($style eq 'display') {
318: $latex='$$'.$latex.'$$x';
319: } else {
320: # style is 'inline'
321: $latex='\\ensuremath{'.$latex.'}';
322: }
323: if ($target eq 'web' || $target eq 'analyze') {
324: $result = &converted(\$latex);
325: } else {
326: $result = $latex;
327: }
328: } else {
329: &Apache::lonxml::error($parser->{'htmlerror'});
330: }
331: }
332:
333: sub prepare_algebra {
334: my ($string)=@_;
335:
336: # makes the decision about what is a minus sign easier supposedly
337: $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
338:
339: return $string;
340: }
341:
342: sub postprocess_algebra {
343: my ($string)=@_;
344:
345: # moodle had these and I don't know why, ignoring them for now
346: # $string =~s/\\fun/ /g;
347:
348: # remove the extra () in the denominator of a \frac
349: $string =~s/\\frac{(.+?)}{\\left\((.+?)\\right\)}/\\frac{$1}{$2}/gs;
350:
351: # sqrt(3,4) means the 4 root of 3
352: $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
353:
354: # log(3,4) means the log base 4 of 3
355: $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
356:
357: # log(3,4) means the log base 4 of 3
358: $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
359:
360: # int(3,a,b) integral from a to b of 3
361: $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
362:
363: # int( ... dx) -> ...
364: $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
365:
366: #
367: $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
368: return $string;
369: }
370: 1;
371: __END__
372:
373:
374:
375:
376:
377:
378:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>