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

1.1       harris41    1: # The LearningOnline Network with CAPA
                      2: # TeX Conversion Module
                      3: #
1.59    ! albertel    4: # $Id: lontexconvert.pm,v 1.58 2005/02/24 10:09:32 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.1       harris41   50: 
                     51: # ====================================================================== Header
                     52: 
1.29      albertel   53: sub init_tth {
                     54:     my $options=$ENV{'course.'.$ENV{'request.course.id'}.'.tthoptions'};
                     55:     if ($ENV{'browser.mathml'}) {
                     56: 	&tth::ttminit();
                     57: 	if ($ENV{'browser.unicode'}) {
                     58: 	    &tth::ttmoptions('-L -u1 '.$options);
                     59: 	} else {
                     60: 	    &tth::ttmoptions('-L -u0 '.$options);
                     61: 	}
                     62:     } else {
                     63: 	&tth::tthinit();
                     64: 	if ($ENV{'browser.unicode'}) {
                     65: 	    &tth::tthoptions('-L -u1 '.$options);
                     66: 	} else {
                     67: 	    &tth::tthoptions('-L -u0 '.$options);
                     68: 	}
                     69:     }
                     70: }
                     71: 
1.1       harris41   72: sub header {
1.31      albertel   73:     $errorstring='';
                     74:     my $time=time;
                     75:     &init_tth();
                     76:     return &Apache::lonxml::xmlbegin().
1.40      albertel   77: 	"\n<head>\n".
1.31      albertel   78: 	&Apache::lonxml::fontsettings().
                     79: 	&Apache::lonmenu::registerurl(undef,'tex').
                     80: 	"\n</head>\n";
1.1       harris41   81: }
                     82: 
                     83: # ================================================================== Conversion
                     84: 
1.19      albertel   85: $Apache::lontexconvert::messedup=0;
1.36      albertel   86: 
                     87: # we need this routine because &converted can get called from inside
                     88: # of the safespace (through &xmlparse('<m>stuff</m>') which doesn't
                     89: # allow the opcode for alarm, so we need to compile this before we get
                     90: # into the safe space since opcode checks only occur at compile time
                     91: sub convert_real {
                     92:     my ($texstring)=@_;
                     93:     my ($xmlstring,$errorstring);
                     94:     local $SIG{SEGV}=sub { $Apache::lontexconvert::messedup=1; die; };
                     95:     local $SIG{ALRM}=sub { 
1.37      albertel   96: 	&Apache::lonnet::logthis("ALRM");
1.36      albertel   97: 	$xmlstring='['.&mt("TeX unconverted due to errors").']';
                     98: 	$Apache::lontexconvert::messedup=1;
                     99: 	die &mt("TeX unconverted due to errors");
                    100:     };
                    101:     alarm($Apache::lonnet::perlvar{'lonScriptTimeout'});
                    102:     if ($ENV{'browser.mathml'}) {
                    103: 	$xmlstring=&tth::ttm($$texstring);
                    104: 	$xmlstring=~s/\<math\>/\<math xmlns=\"\&mathns\;\"\>/g;
                    105: 	$xmlstring=~s/\<br\>/\<br\/\>/g;
                    106: 	$xmlstring=~s/\<p\>/\<p\>\<\/p\>/g;
                    107: 	$errorstring.=&tth::ttmerror();
                    108:     } else {
                    109: 	$xmlstring=&tth::tth($$texstring);
                    110: 	$errorstring.=&tth::ttherror();
                    111: 	$xmlstring=~s-</font(\s*)>-</font>-g;
                    112:     }
1.43      www       113:     $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
1.36      albertel  114:     $xmlstring=~s/^\s*//;
                    115:     $xmlstring=~s/\s*$//;
                    116:     alarm(0);
                    117:     return ($xmlstring,$errorstring);
                    118: }
                    119: 
1.59    ! albertel  120: sub tth_converted {
1.31      albertel  121:     my $texstring=shift;
1.34      www       122:     my $xmlstring='['.&mt('UNDISPLAYABLE').']';
1.31      albertel  123:     if ($Apache::lontexconvert::messedup) {
1.35      albertel  124: 	return '['.&mt('TeX unconverted due to previous errors').']';
1.31      albertel  125:     }
1.59    ! albertel  126:     $$texstring ='\\documentstyle{article}'.$$texstring;
        !           127: 
1.31      albertel  128:     eval(<<'ENDCONV');
1.36      albertel  129:     ($xmlstring,$errorstring)=&convert_real($texstring)
1.12      www       130: ENDCONV
1.32      albertel  131:     if ($@) {
1.35      albertel  132: 	$errorstring.=&mt("Evaluation Error: ").$@;
1.32      albertel  133: 	$Apache::lontexconvert::messedup=1;
                    134:     }
1.37      albertel  135:     if ($Apache::lontexconvert::messedup || &tth::tthmessedup() || 
                    136: 	$errorstring) {
1.31      albertel  137: 	&Apache::lonnet::logthis("Trying to kill myself");
                    138: 	$Apache::lontexconvert::messedup=1;
                    139: 	my $request=Apache->request();
                    140: 	$request->child_terminate();
                    141:     }
                    142:     return $xmlstring;
1.1       harris41  143: }
                    144: 
1.59    ! albertel  145: sub jsMath_converted {
        !           146:     my $texstring=shift;
        !           147:     my $tag='span';
        !           148:     if ($$texstring=~/[^\\]\$\$/) {
        !           149: 	#has a $$ in it, guessinng it's display mode
        !           150: 	$tag='div';
        !           151:     }
        !           152:     &Apache::lonnet::logthis($$texstring);
        !           153:     $$texstring=~s/(?!\\)\$//g;
        !           154:     $$texstring=~s/\\ensuremath//g
        !           155:     &Apache::lonnet::logthis($$texstring);
        !           156:     return '<'.$tag.' class="math">'.$$texstring.'</'.$tag.'>';
        !           157: }
        !           158: 
        !           159: sub converted {
        !           160:     if ($ENV{'environment.texengine'} eq 'tth') {
        !           161: 	return &tth_converted;
        !           162:     } elsif ($ENV{'environment.texengine'} eq 'jsMath') {
        !           163: 	return &jsMath_converted;
        !           164:     }
        !           165:     return &tth_converted;
        !           166: }
        !           167: 
1.1       harris41  168: # ====================================================================== Footer
                    169: 
                    170: sub footer {
                    171:   my $xmlstring='';
                    172:   if ($ENV{'request.state'} eq 'construct') {
                    173:       $xmlstring.='<address>'.$errorstring.'</address>';
                    174:   } else {
                    175:       &Apache::lonmsg::author_res_msg($ENV{'request.filename'},$errorstring);
                    176:   }
                    177: # -------------------------------------------------------------------- End Body
1.3       www       178:   $xmlstring.=&Apache::lonxml::xmlend();
1.1       harris41  179:   return $xmlstring;
1.6       www       180: }
                    181: 
                    182: # ------------------------------------------------------------ Message display
                    183: 
1.9       albertel  184: sub to_convert {
                    185:     my ($string) = @_;
1.22      www       186:     $string=~s/\<br\s*\/?\>/ /gs;
1.30      albertel  187: #    $string=~s/\s/ /gs;
1.18      albertel  188:     $string=&HTML::Entities::decode($string);
1.9       albertel  189:     return &converted(\$string);
                    190: }
                    191: 
1.20      www       192: sub smiley {
1.31      albertel  193:     my $expression=shift;
                    194:     if ($ENV{'browser.imagesuppress'} eq 'on') { return $expression; }
                    195:     my %smileys=('\:\-\)' => 'smiley',
                    196: 		 '8\-\)'  => 'coolsmile',
                    197: 		 '8\-(I|\|)'   => 'coolindiff',
                    198: 		 ':\-(I|\|)'   => 'neutral',
                    199: 		 '\:\-(o|O|\(\))' => 'shocked',
                    200: 		 ':\-\('  => 'frowny',
                    201: 		 '\;\-\)' => 'wink',
                    202: 		 '\:\-P'  => 'baeh',
                    203: 		 '\:\-(\\\|\\/)' => 'hrrm',
                    204: 		 '\:\-D'  => 'bigsmile',
                    205: 		 '\:\-C'  => 'angry',
                    206: 		 '\:(\'|\`)\-\(' => 'cry',
                    207: 		 '\:\-(X|\#)' => 'lipsrsealed',
                    208: 		 '\:\-S' => 'huh');
                    209:     my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
                    210:     foreach (keys %smileys) {
                    211: 	$expression=~s/$_/\<img src="$iconpath\/$smileys{$_}.gif" \/\>/gs; 
                    212:     }
                    213:     return $expression;
1.20      www       214: }
                    215: 
1.6       www       216: sub msgtexconverted {
1.39      raeburn   217:     my ($message,$email) = @_;
1.17      albertel  218:     $errorstring='';
1.29      albertel  219:     &init_tth();
1.25      www       220:     my $outmessage='';
                    221:     my $tex=0;
                    222:     foreach (split(/(?:\&lt\;|\<)\/*m\s*(?:\&gt\;|\>)/i,$message)) {
                    223: 	if ($tex) {
1.30      albertel  224: 	    if ($email) {
                    225: 		$outmessage.='</pre><tt>'.&to_convert($_).'</tt><pre>'; $tex=0;
                    226: 	    } else {
                    227: 		$outmessage.=&to_convert($_); $tex=0;
                    228: 	    }
1.25      www       229: 	} else {
                    230:             $outmessage.=&smiley($_); $tex=1;
                    231: 	}
                    232:     }
1.24      albertel  233:     if (wantarray) {
1.25      www       234: 	return ($outmessage,$errorstring);
1.24      albertel  235:     } else {
1.25      www       236: 	return $outmessage.$errorstring;
1.24      albertel  237:     }
1.1       harris41  238: }
                    239: 
1.44      albertel  240: sub algebra {
1.49      albertel  241:     use AlgParser;
                    242: 
1.58      albertel  243:     my ($string,$target,$style)=@_;
1.44      albertel  244:     my $parser = new AlgParserWithImplicitExpand;
1.46      albertel  245:     $string=&prepare_algebra($string);
1.44      albertel  246:     my $ret = $parser->parse($string);
                    247:     my $result='['.&mt('Algebra unconverted due to previous errors').']';
                    248:     if ( ref($ret) ) {
1.50      albertel  249: 	#$parser->tostring();
1.44      albertel  250: 	$parser->normalize();
                    251: 	my $latex=$parser->tolatex();
1.49      albertel  252: 	$latex=&postprocess_algebra($latex);
1.58      albertel  253: 	if ($style eq 'display') {
                    254: 	    $latex='$$'.$latex.'$$x';
                    255: 	} else {
                    256: 	    $latex='\\ensuremath{'.$latex.'}';
                    257: 	}
1.44      albertel  258: 	if ($target eq 'web' || $target eq 'analyze') {
                    259: 	    $result = &converted(\$latex);
                    260: 	} else {
                    261: 	    $result = $latex;
                    262: 	}
                    263:     } else {
                    264: 	&Apache::lonxml::error($parser->{'htmlerror'});
                    265:     }
                    266: }
                    267: 
1.46      albertel  268: sub prepare_algebra {
                    269:     my ($string)=@_;
                    270: 
1.50      albertel  271:     # makes the decision about what is a minus sign easier supposedly
1.57      albertel  272:     $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
1.48      albertel  273: 
1.46      albertel  274:     return $string;
                    275: }
                    276: 
                    277: sub postprocess_algebra {
                    278:     my ($string)=@_;
1.48      albertel  279:     
1.50      albertel  280:     # moodle had these and I don't know why, ignoring them for now
1.51      albertel  281:     # $string =~s/\\fun/ /g;
1.47      albertel  282: 
1.51      albertel  283:     # sqrt(3,4) -> \sqrt\let{3,4\right}, which is annoying
                    284:     $string =~s/\\left\{/\{/g;
                    285:     $string =~s/\\right\}/\}/g;
1.55      albertel  286: 
                    287:     # remove the extra () in the denominator of a \frac
                    288:     $string =~s/\\frac{(.+?)}{\\left\((.+?)\\right\)}/\\frac{$1}{$2}/gs;
1.51      albertel  289:     
                    290:     # sqrt(3,4) means the 4 root of 3
1.52      albertel  291:     $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
                    292: 
1.53      albertel  293:     # log(3,4) means the log base 4 of 3
                    294:     $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
                    295: 
1.54      albertel  296:     # log(3,4) means the log base 4 of 3
                    297:     $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
                    298: 
1.55      albertel  299:     # int(3,a,b) integral from a to b of 3
                    300:     $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
                    301: 
                    302:     # int( ... dx) -> ...
                    303:     $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
1.51      albertel  304: 
1.56      albertel  305:     # 
                    306:     $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
1.51      albertel  307:     &Apache::lonnet::logthis($string);
1.46      albertel  308:     return $string;
                    309: }
1.1       harris41  310: 1;
                    311: __END__
                    312: 
                    313: 
                    314: 
                    315: 
                    316: 
                    317: 
                    318: 

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