Annotation of loncom/xml/lontexconvert.pm, revision 1.84
1.1 harris41 1: # The LearningOnline Network with CAPA
2: # TeX Conversion Module
3: #
1.84 ! albertel 4: # $Id: lontexconvert.pm,v 1.83 2007/06/19 20:10:55 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)=@_;
1.82 albertel 154: $$texstring=~s/(?<!\\)\$//g;
1.62 albertel 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: {
1.76 albertel 179: my @jsMath_sent_header;
1.67 albertel 180: sub jsMath_reset {
1.76 albertel 181: undef(@jsMath_sent_header);
182: }
183: sub jsMath_push {
184: push(@jsMath_sent_header,0);
1.67 albertel 185: }
186: sub jsMath_header {
1.80 albertel 187: if (!@jsMath_sent_header) {
188: &Apache::lonnet::logthis("mismatched calls of jsMath_header and jsMath_process");
189: return '';
190: }
1.76 albertel 191: return '' if $jsMath_sent_header[-1];
192: $jsMath_sent_header[-1]=1;
1.67 albertel 193: return
194: '<script type="text/javascript">
195: function NoFontMessage () {}
1.78 albertel 196: jsMath = {Parser: {prototype: {environments: {\'eqnarray*\' :[\'Array\',null,null,\'rcl\',[5/18,5/18],3,\'D\']}}}};
1.67 albertel 197: </script>'."\n".
1.71 albertel 198: '<script type="text/javascript" src="/adm/jsMath/jsMath.js"></script>'."\n";
1.67 albertel 199: }
200: sub jsMath_process {
1.76 albertel 201: my $state = pop(@jsMath_sent_header);
202: return '' if !$state;
1.81 albertel 203: return "\n".
204: '<script type="text/javascript">jsMath.Process()</script>'."\n";
1.67 albertel 205: }
1.84 ! albertel 206: sub jsMath_state {
! 207: my ($level) = @_;
! 208: return $jsMath_sent_header[$level];
! 209: }
1.62 albertel 210: }
211:
1.83 albertel 212: sub tex_engine {
213: if (exists($env{'form.texengine'})) {
214: return $env{'form.texengine'};
215: }
216: if ($env{'request.course.id'}
217: && exists($env{'course.'.$env{'request.course.id'}.'.texengine'})) {
218: return $env{'course.'.$env{'request.course.id'}.'.texengine'};
219: }
220: if (exists($env{'environment.texengine'})) {
221: return $env{'environment.texengine'};
222: }
223: return 'tth';
224: }
225:
1.72 albertel 226: sub init_math_support {
1.84 ! albertel 227: my ($inherit_jsmath) = @_;
1.73 albertel 228: &init_tth();
1.76 albertel 229: &Apache::lontexconvert::jsMath_push();
1.84 ! albertel 230: if (lc(&tex_engine()) eq 'jsmath' ||
! 231: ($inherit_jsmath && &jsMath_state(-2))) {
1.72 albertel 232: return &Apache::lontexconvert::jsMath_header();
233: }
234: return;
235: }
236:
1.62 albertel 237: sub mimetex_converted {
238: my $texstring=shift;
239: my $displaystyle=&displaystyle($texstring);
240:
241: &clean_out_math_mode($texstring);
242:
243: if ($displaystyle) {
244: $$texstring='\\displaystyle \\Large '.$$texstring;
1.59 albertel 245: }
1.75 www 246: my $result='<img src="/cgi-bin/mimetex.cgi?'.&escape($$texstring).'" />';
1.62 albertel 247: if ($displaystyle) {
248: $result='<center>'.$result.'</center>';
249: }
250: return $result;
1.59 albertel 251: }
252:
253: sub converted {
1.67 albertel 254: my ($string,$mode)=@_;
1.83 albertel 255: if ($mode eq '') { $mode = &tex_engine(); }
1.68 albertel 256: if ($mode =~ /tth/i) {
1.67 albertel 257: return &tth_converted($string);
1.68 albertel 258: } elsif ($mode =~ /jsmath/i) {
1.67 albertel 259: return &jsMath_converted($string);
1.68 albertel 260: } elsif ($mode =~ /mimetex/i) {
1.67 albertel 261: return &mimetex_converted($string);
1.59 albertel 262: }
1.67 albertel 263: return &tth_converted($string);
1.59 albertel 264: }
265:
1.6 www 266: # ------------------------------------------------------------ Message display
267:
1.9 albertel 268: sub to_convert {
269: my ($string) = @_;
1.22 www 270: $string=~s/\<br\s*\/?\>/ /gs;
1.30 albertel 271: # $string=~s/\s/ /gs;
1.18 albertel 272: $string=&HTML::Entities::decode($string);
1.9 albertel 273: return &converted(\$string);
274: }
275:
1.20 www 276: sub smiley {
1.31 albertel 277: my $expression=shift;
1.65 albertel 278: if ($env{'browser.imagesuppress'} eq 'on') { return $expression; }
1.31 albertel 279: my %smileys=('\:\-\)' => 'smiley',
280: '8\-\)' => 'coolsmile',
281: '8\-(I|\|)' => 'coolindiff',
282: ':\-(I|\|)' => 'neutral',
283: '\:\-(o|O|\(\))' => 'shocked',
284: ':\-\(' => 'frowny',
285: '\;\-\)' => 'wink',
286: '\:\-P' => 'baeh',
287: '\:\-(\\\|\\/)' => 'hrrm',
288: '\:\-D' => 'bigsmile',
289: '\:\-C' => 'angry',
290: '\:(\'|\`)\-\(' => 'cry',
291: '\:\-(X|\#)' => 'lipsrsealed',
292: '\:\-S' => 'huh');
293: my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
1.79 albertel 294: foreach my $smiley (keys(%smileys)) {
295: $expression=~s/$smiley/\<img src="$iconpath\/$smileys{$smiley}.gif" \/\>/gs;
1.31 albertel 296: }
297: return $expression;
1.20 www 298: }
299:
1.6 www 300: sub msgtexconverted {
1.39 raeburn 301: my ($message,$email) = @_;
1.17 albertel 302: $errorstring='';
1.29 albertel 303: &init_tth();
1.25 www 304: my $outmessage='';
305: my $tex=0;
1.79 albertel 306: foreach my $fragment (split(/(?:\<\;|\<)\/*m\s*(?:\>\;|\>)/i,$message)) {
1.25 www 307: if ($tex) {
1.30 albertel 308: if ($email) {
1.79 albertel 309: $outmessage.='</pre><tt>'.&to_convert($fragment).'</tt><pre>';
310: $tex=0;
1.30 albertel 311: } else {
1.79 albertel 312: $outmessage.=&to_convert($fragment);
313: $tex=0;
1.30 albertel 314: }
1.25 www 315: } else {
1.79 albertel 316: $outmessage.=&smiley($fragment);
317: $tex=1;
1.25 www 318: }
319: }
1.64 albertel 320: $message=$outmessage; $outmessage=''; $tex=0;
1.79 albertel 321: foreach my $fragment (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i,
322: $message)) {
1.64 albertel 323: if ($tex) {
324: if ($email) {
1.79 albertel 325: $outmessage.='</pre><tt>'.&algebra($fragment,'web').'</tt><pre>';
326: $tex=0;
1.64 albertel 327: } else {
1.79 albertel 328: $outmessage.=&algebra($fragment,'web');
329: $tex=0;
1.64 albertel 330: }
331: } else {
1.79 albertel 332: $outmessage.=$fragment;
333: $tex=1;
1.64 albertel 334: }
335: }
1.24 albertel 336: if (wantarray) {
1.25 www 337: return ($outmessage,$errorstring);
1.24 albertel 338: } else {
1.25 www 339: return $outmessage.$errorstring;
1.24 albertel 340: }
1.1 harris41 341: }
342:
1.44 albertel 343: sub algebra {
1.49 albertel 344: use AlgParser;
345:
1.58 albertel 346: my ($string,$target,$style)=@_;
1.44 albertel 347: my $parser = new AlgParserWithImplicitExpand;
1.46 albertel 348: $string=&prepare_algebra($string);
1.44 albertel 349: my $ret = $parser->parse($string);
350: my $result='['.&mt('Algebra unconverted due to previous errors').']';
351: if ( ref($ret) ) {
1.50 albertel 352: #$parser->tostring();
1.44 albertel 353: $parser->normalize();
354: my $latex=$parser->tolatex();
1.49 albertel 355: $latex=&postprocess_algebra($latex);
1.58 albertel 356: if ($style eq 'display') {
357: $latex='$$'.$latex.'$$x';
358: } else {
1.61 albertel 359: # style is 'inline'
1.58 albertel 360: $latex='\\ensuremath{'.$latex.'}';
361: }
1.44 albertel 362: if ($target eq 'web' || $target eq 'analyze') {
363: $result = &converted(\$latex);
364: } else {
365: $result = $latex;
366: }
367: } else {
368: &Apache::lonxml::error($parser->{'htmlerror'});
369: }
370: }
371:
1.46 albertel 372: sub prepare_algebra {
373: my ($string)=@_;
374:
1.50 albertel 375: # makes the decision about what is a minus sign easier supposedly
1.57 albertel 376: $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
1.48 albertel 377:
1.46 albertel 378: return $string;
379: }
380:
381: sub postprocess_algebra {
382: my ($string)=@_;
1.48 albertel 383:
1.50 albertel 384: # moodle had these and I don't know why, ignoring them for now
1.51 albertel 385: # $string =~s/\\fun/ /g;
1.47 albertel 386:
1.51 albertel 387: # sqrt(3,4) means the 4 root of 3
1.52 albertel 388: $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
389:
1.53 albertel 390: # log(3,4) means the log base 4 of 3
391: $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
392:
1.54 albertel 393: # log(3,4) means the log base 4 of 3
394: $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
395:
1.55 albertel 396: # int(3,a,b) integral from a to b of 3
397: $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
398:
399: # int( ... dx) -> ...
400: $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
1.51 albertel 401:
1.56 albertel 402: #
403: $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
1.46 albertel 404: return $string;
405: }
1.1 harris41 406: 1;
407: __END__
408:
409:
410:
411:
412:
413:
414:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>