1: # The LearningOnline Network with CAPA
2: # TeX Conversion Module
3: #
4: # $Id: lontexconvert.pm,v 1.82 2007/06/13 00:21:03 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::lonxml();
46: use Apache::lonlocal;
47: use Apache::lonnet;
48: use lib '/home/httpd/lib/perl/';
49: use LONCAPA;
50:
51:
52: # ====================================================================== Header
53:
54: sub init_tth {
55: my $options=$env{'course.'.$env{'request.course.id'}.'.tthoptions'};
56: if ($options =~ /\S/) {
57: $options = ' '.$options;
58: } else {
59: undef($options);
60: }
61: if ($env{'browser.mathml'}) {
62: &tth::ttminit();
63: if ($env{'browser.unicode'}) {
64: &tth::ttmoptions('-L -u1'.$options);
65: } else {
66: &tth::ttmoptions('-L -u0'.$options);
67: }
68: } else {
69: &tth::tthinit();
70: if ($env{'browser.unicode'}) {
71: &tth::tthoptions('-L -u1'.$options);
72: } else {
73: &tth::tthoptions('-L -u0'.$options);
74: }
75: }
76: }
77:
78: # ================================================================== Conversion
79:
80: $Apache::lontexconvert::messedup=0;
81:
82: # we need this routine because &converted can get called from inside
83: # of the safespace (through &xmlparse('<m>stuff</m>') which doesn't
84: # allow the opcode for alarm, so we need to compile this before we get
85: # into the safe space since opcode checks only occur at compile time
86: sub convert_real {
87: my ($texstring)=@_;
88: my ($xmlstring,$errorstring);
89: local $SIG{SEGV}=sub { $Apache::lontexconvert::messedup=1; die; };
90: local $SIG{ALRM}=sub {
91: &Apache::lonnet::logthis("ALRM");
92: $xmlstring='['.&mt("TeX unconverted due to errors").']';
93: $Apache::lontexconvert::messedup=1;
94: die &mt("TeX unconverted due to errors");
95: };
96: &Apache::lonxml::start_alarm();
97: if ($env{'browser.mathml'}) {
98: $xmlstring=&tth::ttm($$texstring);
99: $xmlstring=~s/\<math\>/\<math xmlns=\"\&mathns\;\"\>/g;
100: $xmlstring=~s/\<br\>/\<br\/\>/g;
101: $xmlstring=~s/\<p\>/\<p\>\<\/p\>/g;
102: $errorstring.=&tth::ttmerror();
103: } else {
104: $xmlstring=&tth::tth($$texstring);
105: $errorstring.=&tth::ttherror();
106: $xmlstring=~s-</font(\s*)>-</font>-g;
107: }
108: $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
109: $xmlstring=~s/^\s*//;
110: $xmlstring=~s/\s*$//;
111: &Apache::lonxml::end_alarm();
112: return ($xmlstring,$errorstring);
113: }
114:
115: sub tth_converted {
116: my $texstring=shift;
117: my $xmlstring='['.&mt('UNDISPLAYABLE').']';
118: if ($Apache::lontexconvert::messedup) {
119: return '['.&mt('TeX unconverted due to previous errors').']';
120: }
121: $$texstring ='\\documentstyle{article}'.$$texstring;
122:
123: eval(<<'ENDCONV');
124: ($xmlstring,$errorstring)=&convert_real($texstring)
125: ENDCONV
126: if ($@) {
127: $errorstring.=&mt("Evaluation Error: ").$@;
128: $Apache::lontexconvert::messedup=1;
129: }
130: if ($Apache::lontexconvert::messedup || &tth::tthmessedup() ||
131: $errorstring) {
132: &Apache::lonnet::logthis("Trying to kill myself");
133: $Apache::lontexconvert::messedup=1;
134: if (ref($Apache::lonxml::request)) {
135: $Apache::lonxml::request->child_terminate();
136: } else {
137: my $request;
138: eval { $request=Apache->request; };
139: if (!$request) {
140: eval { $request=Apache2::RequestUtil->request; };
141: }
142: if ($request) {
143: $request->child_terminate();
144: } else {
145: &Apache::lonnet::logthis("Unable to find a request to do child_terminate on");
146: }
147: }
148: }
149: return $xmlstring;
150: }
151:
152: sub clean_out_math_mode {
153: my ($texstring)=@_;
154: $$texstring=~s/(?<!\\)\$//g;
155: $$texstring=~s/\\[\)\(\]\[]//g;
156: $$texstring=~s/\\ensuremath//g;
157: return '';
158: }
159:
160: sub displaystyle {
161: my ($texstring)=@_;
162: #has a $$ or \[ or \displaystyle in it, guessinng it's display mode
163: if ($$texstring=~/[^\\]\$\$/ ||
164: $$texstring=~/\\\[/ ||
165: $$texstring=~/\\displaystyle/) { return 1; }
166: return 0;
167: }
168:
169: sub jsMath_converted {
170: my $texstring=shift;
171: my $tag='span';
172: if (&displaystyle($texstring)) { $tag='div'; }
173: &clean_out_math_mode($texstring);
174: return &jsMath_header().
175: '<'.$tag.' class="math">'.$$texstring.'</'.$tag.'>';
176: }
177:
178: {
179: my @jsMath_sent_header;
180: sub jsMath_reset {
181: undef(@jsMath_sent_header);
182: }
183: sub jsMath_push {
184: push(@jsMath_sent_header,0);
185: }
186: sub jsMath_header {
187: if (!@jsMath_sent_header) {
188: &Apache::lonnet::logthis("mismatched calls of jsMath_header and jsMath_process");
189: return '';
190: }
191: return '' if $jsMath_sent_header[-1];
192: $jsMath_sent_header[-1]=1;
193: return
194: '<script type="text/javascript">
195: function NoFontMessage () {}
196: jsMath = {Parser: {prototype: {environments: {\'eqnarray*\' :[\'Array\',null,null,\'rcl\',[5/18,5/18],3,\'D\']}}}};
197: </script>'."\n".
198: '<script type="text/javascript" src="/adm/jsMath/jsMath.js"></script>'."\n";
199: }
200: sub jsMath_process {
201: my $state = pop(@jsMath_sent_header);
202: return '' if !$state;
203: return "\n".
204: '<script type="text/javascript">jsMath.Process()</script>'."\n";
205: }
206: }
207:
208: sub init_math_support {
209: &init_tth();
210: &Apache::lontexconvert::jsMath_push();
211: if ($env{'environment.texengine'} eq 'jsMath' ||
212: $env{'form.texengine'} eq 'jsMath' ) {
213: return &Apache::lontexconvert::jsMath_header();
214: }
215: return;
216: }
217:
218: sub mimetex_converted {
219: my $texstring=shift;
220: my $displaystyle=&displaystyle($texstring);
221:
222: &clean_out_math_mode($texstring);
223:
224: if ($displaystyle) {
225: $$texstring='\\displaystyle \\Large '.$$texstring;
226: }
227: my $result='<img src="/cgi-bin/mimetex.cgi?'.&escape($$texstring).'" />';
228: if ($displaystyle) {
229: $result='<center>'.$result.'</center>';
230: }
231: return $result;
232: }
233:
234: sub converted {
235: my ($string,$mode)=@_;
236: if ($mode eq '') { $mode=$env{'environment.texengine'}; }
237: if ($mode =~ /tth/i) {
238: return &tth_converted($string);
239: } elsif ($mode =~ /jsmath/i) {
240: return &jsMath_converted($string);
241: } elsif ($mode =~ /mimetex/i) {
242: return &mimetex_converted($string);
243: }
244: return &tth_converted($string);
245: }
246:
247: # ------------------------------------------------------------ Message display
248:
249: sub to_convert {
250: my ($string) = @_;
251: $string=~s/\<br\s*\/?\>/ /gs;
252: # $string=~s/\s/ /gs;
253: $string=&HTML::Entities::decode($string);
254: return &converted(\$string);
255: }
256:
257: sub smiley {
258: my $expression=shift;
259: if ($env{'browser.imagesuppress'} eq 'on') { return $expression; }
260: my %smileys=('\:\-\)' => 'smiley',
261: '8\-\)' => 'coolsmile',
262: '8\-(I|\|)' => 'coolindiff',
263: ':\-(I|\|)' => 'neutral',
264: '\:\-(o|O|\(\))' => 'shocked',
265: ':\-\(' => 'frowny',
266: '\;\-\)' => 'wink',
267: '\:\-P' => 'baeh',
268: '\:\-(\\\|\\/)' => 'hrrm',
269: '\:\-D' => 'bigsmile',
270: '\:\-C' => 'angry',
271: '\:(\'|\`)\-\(' => 'cry',
272: '\:\-(X|\#)' => 'lipsrsealed',
273: '\:\-S' => 'huh');
274: my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
275: foreach my $smiley (keys(%smileys)) {
276: $expression=~s/$smiley/\<img src="$iconpath\/$smileys{$smiley}.gif" \/\>/gs;
277: }
278: return $expression;
279: }
280:
281: sub msgtexconverted {
282: my ($message,$email) = @_;
283: $errorstring='';
284: &init_tth();
285: my $outmessage='';
286: my $tex=0;
287: foreach my $fragment (split(/(?:\<\;|\<)\/*m\s*(?:\>\;|\>)/i,$message)) {
288: if ($tex) {
289: if ($email) {
290: $outmessage.='</pre><tt>'.&to_convert($fragment).'</tt><pre>';
291: $tex=0;
292: } else {
293: $outmessage.=&to_convert($fragment);
294: $tex=0;
295: }
296: } else {
297: $outmessage.=&smiley($fragment);
298: $tex=1;
299: }
300: }
301: $message=$outmessage; $outmessage=''; $tex=0;
302: foreach my $fragment (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i,
303: $message)) {
304: if ($tex) {
305: if ($email) {
306: $outmessage.='</pre><tt>'.&algebra($fragment,'web').'</tt><pre>';
307: $tex=0;
308: } else {
309: $outmessage.=&algebra($fragment,'web');
310: $tex=0;
311: }
312: } else {
313: $outmessage.=$fragment;
314: $tex=1;
315: }
316: }
317: if (wantarray) {
318: return ($outmessage,$errorstring);
319: } else {
320: return $outmessage.$errorstring;
321: }
322: }
323:
324: sub algebra {
325: use AlgParser;
326:
327: my ($string,$target,$style)=@_;
328: my $parser = new AlgParserWithImplicitExpand;
329: $string=&prepare_algebra($string);
330: my $ret = $parser->parse($string);
331: my $result='['.&mt('Algebra unconverted due to previous errors').']';
332: if ( ref($ret) ) {
333: #$parser->tostring();
334: $parser->normalize();
335: my $latex=$parser->tolatex();
336: $latex=&postprocess_algebra($latex);
337: if ($style eq 'display') {
338: $latex='$$'.$latex.'$$x';
339: } else {
340: # style is 'inline'
341: $latex='\\ensuremath{'.$latex.'}';
342: }
343: if ($target eq 'web' || $target eq 'analyze') {
344: $result = &converted(\$latex);
345: } else {
346: $result = $latex;
347: }
348: } else {
349: &Apache::lonxml::error($parser->{'htmlerror'});
350: }
351: }
352:
353: sub prepare_algebra {
354: my ($string)=@_;
355:
356: # makes the decision about what is a minus sign easier supposedly
357: $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
358:
359: return $string;
360: }
361:
362: sub postprocess_algebra {
363: my ($string)=@_;
364:
365: # moodle had these and I don't know why, ignoring them for now
366: # $string =~s/\\fun/ /g;
367:
368: # sqrt(3,4) means the 4 root of 3
369: $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
370:
371: # log(3,4) means the log base 4 of 3
372: $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
373:
374: # log(3,4) means the log base 4 of 3
375: $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
376:
377: # int(3,a,b) integral from a to b of 3
378: $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
379:
380: # int( ... dx) -> ...
381: $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
382:
383: #
384: $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
385: return $string;
386: }
387: 1;
388: __END__
389:
390:
391:
392:
393:
394:
395:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lontexconvert.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / xml