File:  [LON-CAPA] / loncom / xml / lontexconvert.pm
Revision 1.74: download - view: text, annotated - select for diffs
Thu May 18 22:13:50 2006 UTC (18 years ago) by albertel
Branches: MAIN
CVS tags: HEAD
- tth doesn't lie the trailing space on the option list

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

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