Annotation of loncom/xml/lontexconvert.pm, revision 1.75
1.1 harris41 1: # The LearningOnline Network with CAPA
2: # TeX Conversion Module
3: #
1.75 ! www 4: # $Id: lontexconvert.pm,v 1.74 2006/05/18 22:13:50 albertel Exp $
1.4 www 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: #
1.1 harris41 39:
40: package Apache::lontexconvert;
41:
42: use strict;
1.33 albertel 43: use tth();
1.1 harris41 44: use vars qw($errorstring);
1.73 albertel 45: #use Apache::lonxml();
1.33 albertel 46: use Apache::lonlocal;
1.65 albertel 47: use Apache::lonnet;
1.75 ! www 48: use lib '/home/httpd/lib/perl/';
! 49: use LONCAPA;
! 50:
1.1 harris41 51:
52: # ====================================================================== Header
53:
1.29 albertel 54: sub init_tth {
1.65 albertel 55: my $options=$env{'course.'.$env{'request.course.id'}.'.tthoptions'};
1.74 albertel 56: if ($options =~ /\S/) {
57: $options = ' '.$options;
58: } else {
59: undef($options);
60: }
1.65 albertel 61: if ($env{'browser.mathml'}) {
1.29 albertel 62: &tth::ttminit();
1.65 albertel 63: if ($env{'browser.unicode'}) {
1.74 albertel 64: &tth::ttmoptions('-L -u1'.$options);
1.29 albertel 65: } else {
1.74 albertel 66: &tth::ttmoptions('-L -u0'.$options);
1.29 albertel 67: }
68: } else {
69: &tth::tthinit();
1.65 albertel 70: if ($env{'browser.unicode'}) {
1.74 albertel 71: &tth::tthoptions('-L -u1'.$options);
1.29 albertel 72: } else {
1.74 albertel 73: &tth::tthoptions('-L -u0'.$options);
1.29 albertel 74: }
75: }
76: }
77:
1.1 harris41 78: # ================================================================== Conversion
79:
1.19 albertel 80: $Apache::lontexconvert::messedup=0;
1.36 albertel 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 {
1.37 albertel 91: &Apache::lonnet::logthis("ALRM");
1.36 albertel 92: $xmlstring='['.&mt("TeX unconverted due to errors").']';
93: $Apache::lontexconvert::messedup=1;
94: die &mt("TeX unconverted due to errors");
95: };
1.63 albertel 96: &Apache::lonxml::start_alarm();
1.65 albertel 97: if ($env{'browser.mathml'}) {
1.36 albertel 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: }
1.43 www 108: $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
1.36 albertel 109: $xmlstring=~s/^\s*//;
110: $xmlstring=~s/\s*$//;
1.63 albertel 111: &Apache::lonxml::end_alarm();
1.36 albertel 112: return ($xmlstring,$errorstring);
113: }
114:
1.59 albertel 115: sub tth_converted {
1.31 albertel 116: my $texstring=shift;
1.34 www 117: my $xmlstring='['.&mt('UNDISPLAYABLE').']';
1.31 albertel 118: if ($Apache::lontexconvert::messedup) {
1.35 albertel 119: return '['.&mt('TeX unconverted due to previous errors').']';
1.31 albertel 120: }
1.59 albertel 121: $$texstring ='\\documentstyle{article}'.$$texstring;
122:
1.31 albertel 123: eval(<<'ENDCONV');
1.36 albertel 124: ($xmlstring,$errorstring)=&convert_real($texstring)
1.12 www 125: ENDCONV
1.32 albertel 126: if ($@) {
1.35 albertel 127: $errorstring.=&mt("Evaluation Error: ").$@;
1.32 albertel 128: $Apache::lontexconvert::messedup=1;
129: }
1.37 albertel 130: if ($Apache::lontexconvert::messedup || &tth::tthmessedup() ||
131: $errorstring) {
1.31 albertel 132: &Apache::lonnet::logthis("Trying to kill myself");
133: $Apache::lontexconvert::messedup=1;
1.70 albertel 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: }
1.31 albertel 148: }
149: return $xmlstring;
1.1 harris41 150: }
151:
1.62 albertel 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:
1.59 albertel 169: sub jsMath_converted {
170: my $texstring=shift;
171: my $tag='span';
1.62 albertel 172: if (&displaystyle($texstring)) { $tag='div'; }
173: &clean_out_math_mode($texstring);
1.67 albertel 174: return &jsMath_header().
175: '<'.$tag.' class="math">'.$$texstring.'</'.$tag.'>';
176: }
177:
178: {
179: my $jsMath_sent_header;
180: sub jsMath_reset {
181: $jsMath_sent_header=0;
182: }
183: sub jsMath_header {
184: return '' if $jsMath_sent_header;
185: $jsMath_sent_header=1;
186: return
187: '<script type="text/javascript">
188: function NoFontMessage () {}
189: </script>'."\n".
1.71 albertel 190: '<script type="text/javascript" src="/adm/jsMath/jsMath.js"></script>'."\n";
1.67 albertel 191: }
192: sub jsMath_process {
193: return '' if !$jsMath_sent_header;
194: return '<script type="text/javascript">jsMath.Process()</script>';
195: }
1.62 albertel 196: }
197:
1.72 albertel 198: sub init_math_support {
1.73 albertel 199: &init_tth();
1.72 albertel 200: &Apache::lontexconvert::jsMath_reset();
201: if ($env{'environment.texengine'} eq 'jsMath' ||
202: $env{'form.texengine'} eq 'jsMath' ) {
203: return &Apache::lontexconvert::jsMath_header();
204: }
205: return;
206: }
207:
1.62 albertel 208: sub mimetex_converted {
209: my $texstring=shift;
210: my $displaystyle=&displaystyle($texstring);
211:
212: &clean_out_math_mode($texstring);
213:
214: if ($displaystyle) {
215: $$texstring='\\displaystyle \\Large '.$$texstring;
1.59 albertel 216: }
1.75 ! www 217: my $result='<img src="/cgi-bin/mimetex.cgi?'.&escape($$texstring).'" />';
1.62 albertel 218: if ($displaystyle) {
219: $result='<center>'.$result.'</center>';
220: }
221: return $result;
1.59 albertel 222: }
223:
224: sub converted {
1.67 albertel 225: my ($string,$mode)=@_;
226: if ($mode eq '') { $mode=$env{'environment.texengine'}; }
1.68 albertel 227: if ($mode =~ /tth/i) {
1.67 albertel 228: return &tth_converted($string);
1.68 albertel 229: } elsif ($mode =~ /jsmath/i) {
1.67 albertel 230: return &jsMath_converted($string);
1.68 albertel 231: } elsif ($mode =~ /mimetex/i) {
1.67 albertel 232: return &mimetex_converted($string);
1.59 albertel 233: }
1.67 albertel 234: return &tth_converted($string);
1.59 albertel 235: }
236:
1.6 www 237: # ------------------------------------------------------------ Message display
238:
1.9 albertel 239: sub to_convert {
240: my ($string) = @_;
1.22 www 241: $string=~s/\<br\s*\/?\>/ /gs;
1.30 albertel 242: # $string=~s/\s/ /gs;
1.18 albertel 243: $string=&HTML::Entities::decode($string);
1.9 albertel 244: return &converted(\$string);
245: }
246:
1.20 www 247: sub smiley {
1.31 albertel 248: my $expression=shift;
1.65 albertel 249: if ($env{'browser.imagesuppress'} eq 'on') { return $expression; }
1.31 albertel 250: my %smileys=('\:\-\)' => 'smiley',
251: '8\-\)' => 'coolsmile',
252: '8\-(I|\|)' => 'coolindiff',
253: ':\-(I|\|)' => 'neutral',
254: '\:\-(o|O|\(\))' => 'shocked',
255: ':\-\(' => 'frowny',
256: '\;\-\)' => 'wink',
257: '\:\-P' => 'baeh',
258: '\:\-(\\\|\\/)' => 'hrrm',
259: '\:\-D' => 'bigsmile',
260: '\:\-C' => 'angry',
261: '\:(\'|\`)\-\(' => 'cry',
262: '\:\-(X|\#)' => 'lipsrsealed',
263: '\:\-S' => 'huh');
264: my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
265: foreach (keys %smileys) {
266: $expression=~s/$_/\<img src="$iconpath\/$smileys{$_}.gif" \/\>/gs;
267: }
268: return $expression;
1.20 www 269: }
270:
1.6 www 271: sub msgtexconverted {
1.39 raeburn 272: my ($message,$email) = @_;
1.17 albertel 273: $errorstring='';
1.29 albertel 274: &init_tth();
1.25 www 275: my $outmessage='';
276: my $tex=0;
277: foreach (split(/(?:\<\;|\<)\/*m\s*(?:\>\;|\>)/i,$message)) {
278: if ($tex) {
1.30 albertel 279: if ($email) {
280: $outmessage.='</pre><tt>'.&to_convert($_).'</tt><pre>'; $tex=0;
281: } else {
282: $outmessage.=&to_convert($_); $tex=0;
283: }
1.25 www 284: } else {
285: $outmessage.=&smiley($_); $tex=1;
286: }
287: }
1.64 albertel 288: $message=$outmessage; $outmessage=''; $tex=0;
289: foreach (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i,$message)) {
290: if ($tex) {
291: if ($email) {
292: $outmessage.='</pre><tt>'.&algebra($_,'web').'</tt><pre>'; $tex=0;
293: } else {
294: $outmessage.=&algebra($_,'web'); $tex=0;
295: }
296: } else {
297: $outmessage.=$_; $tex=1;
298: }
299: }
1.24 albertel 300: if (wantarray) {
1.25 www 301: return ($outmessage,$errorstring);
1.24 albertel 302: } else {
1.25 www 303: return $outmessage.$errorstring;
1.24 albertel 304: }
1.1 harris41 305: }
306:
1.44 albertel 307: sub algebra {
1.49 albertel 308: use AlgParser;
309:
1.58 albertel 310: my ($string,$target,$style)=@_;
1.44 albertel 311: my $parser = new AlgParserWithImplicitExpand;
1.46 albertel 312: $string=&prepare_algebra($string);
1.44 albertel 313: my $ret = $parser->parse($string);
314: my $result='['.&mt('Algebra unconverted due to previous errors').']';
315: if ( ref($ret) ) {
1.50 albertel 316: #$parser->tostring();
1.44 albertel 317: $parser->normalize();
318: my $latex=$parser->tolatex();
1.49 albertel 319: $latex=&postprocess_algebra($latex);
1.58 albertel 320: if ($style eq 'display') {
321: $latex='$$'.$latex.'$$x';
322: } else {
1.61 albertel 323: # style is 'inline'
1.58 albertel 324: $latex='\\ensuremath{'.$latex.'}';
325: }
1.44 albertel 326: if ($target eq 'web' || $target eq 'analyze') {
327: $result = &converted(\$latex);
328: } else {
329: $result = $latex;
330: }
331: } else {
332: &Apache::lonxml::error($parser->{'htmlerror'});
333: }
334: }
335:
1.46 albertel 336: sub prepare_algebra {
337: my ($string)=@_;
338:
1.50 albertel 339: # makes the decision about what is a minus sign easier supposedly
1.57 albertel 340: $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
1.48 albertel 341:
1.46 albertel 342: return $string;
343: }
344:
345: sub postprocess_algebra {
346: my ($string)=@_;
1.48 albertel 347:
1.50 albertel 348: # moodle had these and I don't know why, ignoring them for now
1.51 albertel 349: # $string =~s/\\fun/ /g;
1.47 albertel 350:
1.55 albertel 351: # remove the extra () in the denominator of a \frac
352: $string =~s/\\frac{(.+?)}{\\left\((.+?)\\right\)}/\\frac{$1}{$2}/gs;
1.51 albertel 353:
354: # sqrt(3,4) means the 4 root of 3
1.52 albertel 355: $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
356:
1.53 albertel 357: # log(3,4) means the log base 4 of 3
358: $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
359:
1.54 albertel 360: # log(3,4) means the log base 4 of 3
361: $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
362:
1.55 albertel 363: # int(3,a,b) integral from a to b of 3
364: $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
365:
366: # int( ... dx) -> ...
367: $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
1.51 albertel 368:
1.56 albertel 369: #
370: $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
1.46 albertel 371: return $string;
372: }
1.1 harris41 373: 1;
374: __END__
375:
376:
377:
378:
379:
380:
381:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>