Annotation of loncom/xml/lontexconvert.pm, revision 1.67

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>