File:  [LON-CAPA] / loncom / xml / lontexconvert.pm
Revision 1.64: download - view: text, annotated - select for diffs
Tue Mar 1 03:21:05 2005 UTC (19 years, 3 months ago) by albertel
Branches: MAIN
CVS tags: HEAD
- <algebra> works in FDBK

    1: # The LearningOnline Network with CAPA
    2: # TeX Conversion Module
    3: #
    4: # $Id: lontexconvert.pm,v 1.64 2005/03/01 03:21:05 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();
   46: use Apache::lonmsg();
   47: use Apache::lonxml();
   48: use Apache::lonmenu();
   49: use Apache::lonlocal;
   50: 
   51: # ====================================================================== Header
   52: 
   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: 
   72: sub header {
   73:     $errorstring='';
   74:     my $time=time;
   75:     &init_tth();
   76:     return &Apache::lonxml::xmlbegin().
   77: 	"\n<head>\n".
   78: 	&Apache::lonxml::fontsettings().
   79: 	&Apache::lonmenu::registerurl(undef,'tex').
   80: 	"\n</head>\n";
   81: }
   82: 
   83: # ================================================================== Conversion
   84: 
   85: $Apache::lontexconvert::messedup=0;
   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 { 
   96: 	&Apache::lonnet::logthis("ALRM");
   97: 	$xmlstring='['.&mt("TeX unconverted due to errors").']';
   98: 	$Apache::lontexconvert::messedup=1;
   99: 	die &mt("TeX unconverted due to errors");
  100:     };
  101:     &Apache::lonxml::start_alarm();
  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:     }
  113:     $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
  114:     $xmlstring=~s/^\s*//;
  115:     $xmlstring=~s/\s*$//;
  116:     &Apache::lonxml::end_alarm();
  117:     return ($xmlstring,$errorstring);
  118: }
  119: 
  120: sub tth_converted {
  121:     my $texstring=shift;
  122:     my $xmlstring='['.&mt('UNDISPLAYABLE').']';
  123:     if ($Apache::lontexconvert::messedup) {
  124: 	return '['.&mt('TeX unconverted due to previous errors').']';
  125:     }
  126:     $$texstring ='\\documentstyle{article}'.$$texstring;
  127: 
  128:     eval(<<'ENDCONV');
  129:     ($xmlstring,$errorstring)=&convert_real($texstring)
  130: ENDCONV
  131:     if ($@) {
  132: 	$errorstring.=&mt("Evaluation Error: ").$@;
  133: 	$Apache::lontexconvert::messedup=1;
  134:     }
  135:     if ($Apache::lontexconvert::messedup || &tth::tthmessedup() || 
  136: 	$errorstring) {
  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;
  143: }
  144: 
  145: sub clean_out_math_mode {
  146:     my ($texstring)=@_;
  147:     $$texstring=~s/(?!\\)\$//g;
  148:     $$texstring=~s/\\[\)\(\]\[]//g;
  149:     $$texstring=~s/\\ensuremath//g;
  150:     return '';
  151: }
  152: 
  153: sub displaystyle {
  154:     my ($texstring)=@_;
  155:     #has a $$ or \[ or \displaystyle in it, guessinng it's display mode
  156:     if ($$texstring=~/[^\\]\$\$/ ||
  157: 	$$texstring=~/\\\[/ ||
  158: 	$$texstring=~/\\displaystyle/) { return 1; }
  159:     return 0;
  160: }
  161: 
  162: sub jsMath_converted {
  163:     my $texstring=shift;
  164:     my $tag='span';
  165:     if (&displaystyle($texstring)) { $tag='div'; }
  166:     &clean_out_math_mode($texstring);
  167:     return '<'.$tag.' class="math">'.$$texstring.'</'.$tag.'>';
  168: }
  169: 
  170: sub mimetex_converted {
  171:     my $texstring=shift;
  172:     my $displaystyle=&displaystyle($texstring);
  173: 
  174:     &clean_out_math_mode($texstring);
  175: 
  176:     if ($displaystyle) {
  177: 	$$texstring='\\displaystyle \\Large '.$$texstring;
  178:     }
  179:     my $result='<img src="/cgi-bin/mimetex.cgi?'.&Apache::lonnet::escape($$texstring).'" />';
  180:     if ($displaystyle) {
  181: 	$result='<center>'.$result.'</center>';
  182:     }
  183:     return $result;
  184: }
  185: 
  186: sub converted {
  187:     if ($ENV{'environment.texengine'} eq 'tth') {
  188: 	return &tth_converted;
  189:     } elsif ($ENV{'environment.texengine'} eq 'jsMath') {
  190: 	return &jsMath_converted;
  191:     } elsif ($ENV{'environment.texengine'} eq 'mimetex') {
  192: 	return &mimetex_converted;
  193:     }
  194:     return &tth_converted;
  195: }
  196: 
  197: # ====================================================================== Footer
  198: 
  199: sub footer {
  200:   my $xmlstring='';
  201:   if ($ENV{'request.state'} eq 'construct') {
  202:       $xmlstring.='<address>'.$errorstring.'</address>';
  203:   } else {
  204:       &Apache::lonmsg::author_res_msg($ENV{'request.filename'},$errorstring);
  205:   }
  206: # -------------------------------------------------------------------- End Body
  207:   $xmlstring.=&Apache::lonxml::xmlend();
  208:   return $xmlstring;
  209: }
  210: 
  211: # ------------------------------------------------------------ Message display
  212: 
  213: sub to_convert {
  214:     my ($string) = @_;
  215:     $string=~s/\<br\s*\/?\>/ /gs;
  216: #    $string=~s/\s/ /gs;
  217:     $string=&HTML::Entities::decode($string);
  218:     return &converted(\$string);
  219: }
  220: 
  221: sub smiley {
  222:     my $expression=shift;
  223:     if ($ENV{'browser.imagesuppress'} eq 'on') { return $expression; }
  224:     my %smileys=('\:\-\)' => 'smiley',
  225: 		 '8\-\)'  => 'coolsmile',
  226: 		 '8\-(I|\|)'   => 'coolindiff',
  227: 		 ':\-(I|\|)'   => 'neutral',
  228: 		 '\:\-(o|O|\(\))' => 'shocked',
  229: 		 ':\-\('  => 'frowny',
  230: 		 '\;\-\)' => 'wink',
  231: 		 '\:\-P'  => 'baeh',
  232: 		 '\:\-(\\\|\\/)' => 'hrrm',
  233: 		 '\:\-D'  => 'bigsmile',
  234: 		 '\:\-C'  => 'angry',
  235: 		 '\:(\'|\`)\-\(' => 'cry',
  236: 		 '\:\-(X|\#)' => 'lipsrsealed',
  237: 		 '\:\-S' => 'huh');
  238:     my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
  239:     foreach (keys %smileys) {
  240: 	$expression=~s/$_/\<img src="$iconpath\/$smileys{$_}.gif" \/\>/gs; 
  241:     }
  242:     return $expression;
  243: }
  244: 
  245: sub msgtexconverted {
  246:     my ($message,$email) = @_;
  247:     $errorstring='';
  248:     &init_tth();
  249:     my $outmessage='';
  250:     my $tex=0;
  251:     foreach (split(/(?:\&lt\;|\<)\/*m\s*(?:\&gt\;|\>)/i,$message)) {
  252: 	if ($tex) {
  253: 	    if ($email) {
  254: 		$outmessage.='</pre><tt>'.&to_convert($_).'</tt><pre>'; $tex=0;
  255: 	    } else {
  256: 		$outmessage.=&to_convert($_); $tex=0;
  257: 	    }
  258: 	} else {
  259:             $outmessage.=&smiley($_); $tex=1;
  260: 	}
  261:     }
  262:     $message=$outmessage; $outmessage=''; $tex=0;
  263:     foreach (split(/(?:\&lt\;|\<)\/*algebra\s*(?:\&gt\;|\>)/i,$message)) {
  264: 	if ($tex) {
  265: 	    if ($email) {
  266: 		$outmessage.='</pre><tt>'.&algebra($_,'web').'</tt><pre>'; $tex=0;
  267: 	    } else {
  268: 		$outmessage.=&algebra($_,'web'); $tex=0;
  269: 	    }
  270: 	} else {
  271:             $outmessage.=$_; $tex=1;
  272: 	}
  273:     }
  274:     if (wantarray) {
  275: 	return ($outmessage,$errorstring);
  276:     } else {
  277: 	return $outmessage.$errorstring;
  278:     }
  279: }
  280: 
  281: sub algebra {
  282:     use AlgParser;
  283: 
  284:     my ($string,$target,$style)=@_;
  285:     my $parser = new AlgParserWithImplicitExpand;
  286:     $string=&prepare_algebra($string);
  287:     my $ret = $parser->parse($string);
  288:     my $result='['.&mt('Algebra unconverted due to previous errors').']';
  289:     if ( ref($ret) ) {
  290: 	#$parser->tostring();
  291: 	$parser->normalize();
  292: 	my $latex=$parser->tolatex();
  293: 	$latex=&postprocess_algebra($latex);
  294: 	if ($style eq 'display') {
  295: 	    $latex='$$'.$latex.'$$x';
  296: 	} else {
  297: 	    # style is 'inline'
  298: 	    $latex='\\ensuremath{'.$latex.'}';
  299: 	}
  300: 	if ($target eq 'web' || $target eq 'analyze') {
  301: 	    $result = &converted(\$latex);
  302: 	} else {
  303: 	    $result = $latex;
  304: 	}
  305:     } else {
  306: 	&Apache::lonxml::error($parser->{'htmlerror'});
  307:     }
  308: }
  309: 
  310: sub prepare_algebra {
  311:     my ($string)=@_;
  312: 
  313:     # makes the decision about what is a minus sign easier supposedly
  314:     $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
  315: 
  316:     return $string;
  317: }
  318: 
  319: sub postprocess_algebra {
  320:     my ($string)=@_;
  321:     
  322:     # moodle had these and I don't know why, ignoring them for now
  323:     # $string =~s/\\fun/ /g;
  324: 
  325:     # sqrt(3,4) -> \sqrt\let{3,4\right}, which is annoying
  326:     $string =~s/\\left\{/\{/g;
  327:     $string =~s/\\right\}/\}/g;
  328: 
  329:     # remove the extra () in the denominator of a \frac
  330:     $string =~s/\\frac{(.+?)}{\\left\((.+?)\\right\)}/\\frac{$1}{$2}/gs;
  331:     
  332:     # sqrt(3,4) means the 4 root of 3
  333:     $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
  334: 
  335:     # log(3,4) means the log base 4 of 3
  336:     $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
  337: 
  338:     # log(3,4) means the log base 4 of 3
  339:     $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
  340: 
  341:     # int(3,a,b) integral from a to b of 3
  342:     $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
  343: 
  344:     # int( ... dx) -> ...
  345:     $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
  346: 
  347:     # 
  348:     $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
  349:     return $string;
  350: }
  351: 1;
  352: __END__
  353: 
  354: 
  355: 
  356: 
  357: 
  358: 
  359: 

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