--- loncom/xml/lontexconvert.pm 2005/07/05 18:59:03 1.67 +++ loncom/xml/lontexconvert.pm 2012/02/28 10:38:14 1.110 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # TeX Conversion Module # -# $Id: lontexconvert.pm,v 1.67 2005/07/05 18:59:03 albertel Exp $ +# $Id: lontexconvert.pm,v 1.110 2012/02/28 10:38:14 foxr Exp $ # # Copyright Michigan State University Board of Trustees # @@ -42,53 +42,78 @@ package Apache::lontexconvert; use strict; use tth(); use vars qw($errorstring); -use Apache(); -use Apache::lonmsg(); -use Apache::lonxml(); -use Apache::lonmenu(); +#use Apache::lonxml(); use Apache::lonlocal; use Apache::lonnet; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; +use URI::Escape; +use IO::Socket::INET; + + +# +# Table of substitutions to unicode characters. +# +my %unicode_translations = ( + '\rightleftharpoons' => 0x21cc, + '' => 0x23a1, + '' => 0x23a2, + '' => 0x23a3, + '' => 0x23a4, + '' => 0x23a5, + '' => 0x23a6 +); + +## +# Utility to convert elements of a string to unicode: +# +# @param input - Input string +# @param pattern - Pattern to convert +# @param unicode - Unicode to substitute for pattern. +# +# @return string - resulting string. +# +sub unicode_subst { + my ($input, $pattern, $unicode) = @_; + + my $char = pack('U', $unicode); + + $input =~ s/$pattern/$char/g; + + return $input; +} # ====================================================================== Header sub init_tth { my $options=$env{'course.'.$env{'request.course.id'}.'.tthoptions'}; + if ($options =~ /\S/) { + $options = ' '.$options; + } else { + undef($options); + } if ($env{'browser.mathml'}) { &tth::ttminit(); if ($env{'browser.unicode'}) { - &tth::ttmoptions('-L -u1 '.$options); + &tth::ttmoptions('-L -u1'.$options); } else { - &tth::ttmoptions('-L -u0 '.$options); + &tth::ttmoptions('-L -u0'.$options); } } else { &tth::tthinit(); if ($env{'browser.unicode'}) { - &tth::tthoptions('-L -u1 '.$options); + &tth::tthoptions('-L -u1'.$options); } else { - &tth::tthoptions('-L -u0 '.$options); + &tth::tthoptions('-L -u0'.$options); } } } -sub header { - $errorstring=''; - my $time=time; - &init_tth(); - return &Apache::lonxml::xmlbegin(). - "\n
/\
\<\/p\>/g; $errorstring.=&tth::ttmerror(); } else { + &Apache::lonnet::logthis("tth"); $xmlstring=&tth::tth($$texstring); $errorstring.=&tth::ttherror(); $xmlstring=~s---g; @@ -115,6 +142,19 @@ sub convert_real { $xmlstring=~s/^\s*//; $xmlstring=~s/\s*$//; &Apache::lonxml::end_alarm(); + + # + # Several strings produced by tth require + # transliteration -> unicode equivalents to render reliably + # in browsers. %unicode_translations is a table of + # string->substitution which we now apply: + + foreach my $pattern (keys(%unicode_translations)) { + my $unicode = $unicode_translations{$pattern}; + $xmlstring = &unicode_subst($xmlstring, $pattern, $unicode); + } + + return ($xmlstring,$errorstring); } @@ -137,15 +177,27 @@ ENDCONV $errorstring) { &Apache::lonnet::logthis("Trying to kill myself"); $Apache::lontexconvert::messedup=1; - my $request=Apache->request(); - $request->child_terminate(); + if (ref($Apache::lonxml::request)) { + $Apache::lonxml::request->child_terminate(); + } else { + my $request; + eval { $request=Apache->request; }; + if (!$request) { + eval { $request=Apache2::RequestUtil->request; }; + } + if ($request) { + $request->child_terminate(); + } else { + &Apache::lonnet::logthis("Unable to find a request to do child_terminate on"); + } + } } return $xmlstring; } sub clean_out_math_mode { my ($texstring)=@_; - $$texstring=~s/(?!\\)\$//g; + $$texstring=~s/(?'.$$texstring.''; +} + +{ + #Relies heavily on the previous jsMath installation + my @MathJax_sent_header; + sub MathJax_reset { + undef(@MathJax_sent_header); + } + sub MathJax_push { + push(@MathJax_sent_header,0); + } + sub MathJax_header { + if (!@MathJax_sent_header) { + &Apache::lonnet::logthis("mismatched calls of MathJax_header and MathJax_process"); + return ''; + } + return '' if $MathJax_sent_header[-1]; + $MathJax_sent_header[-1]=1; + return + ''."\n"; + } + #sub MathJax_process { + # my $state = pop(@MathJax_sent_header); + # return '' if !$state; + # return "\n". + # ''."\n"; + #} + #sub MathJax_state { + # my ($level) = @_; + # return $MathJax_sent_header[$level]; + #} +} + + sub jsMath_converted { my $texstring=shift; my $tag='span'; @@ -170,72 +265,143 @@ sub jsMath_converted { } { - my $jsMath_sent_header; + my @jsMath_sent_header; sub jsMath_reset { - $jsMath_sent_header=0; + undef(@jsMath_sent_header); + } + sub jsMath_push { + push(@jsMath_sent_header,0); } sub jsMath_header { - return '' if $jsMath_sent_header; - $jsMath_sent_header=1; + if (!@jsMath_sent_header) { + &Apache::lonnet::logthis("mismatched calls of jsMath_header and jsMath_process"); + return ''; + } + return '' if $jsMath_sent_header[-1]; + $jsMath_sent_header[-1]=1; return ''."\n". - ''."\n"; + ''."\n"; } sub jsMath_process { - return '' if !$jsMath_sent_header; - return ''; + my $state = pop(@jsMath_sent_header); + return '' if !$state; + return "\n". + ''."\n"; + } + sub jsMath_state { + my ($level) = @_; + return $jsMath_sent_header[$level]; } } +sub tex_engine { + if (exists($env{'form.texengine'})) { + if ($env{'form.texengine'} ne '') { + return $env{'form.texengine'}; + } + } + if ($env{'request.course.id'} + && exists($env{'course.'.$env{'request.course.id'}.'.texengine'})) { + return $env{'course.'.$env{'request.course.id'}.'.texengine'}; + } + if (exists($env{'environment.texengine'})) { + return $env{'environment.texengine'}; + } + return 'tth'; +} + +sub init_math_support { + my ($inherit_jsmath) = @_; + &init_tth(); + &Apache::lontexconvert::jsMath_push(); + if (lc(&tex_engine()) eq 'jsmath' || + ($inherit_jsmath && &jsMath_state(-2))) { + return &Apache::lontexconvert::jsMath_header(); + } + &Apache::lontexconvert::MathJax_push(); + if (lc(&tex_engine()) eq 'mathjax') { # || + #($inherit_jsmath && &jsMath_state(-2))) { + return &Apache::lontexconvert::MathJax_header(); + } + return; +} + +sub mimetex_valign { + my ($esc_texstring)=@_; + my $valign = 0; + my $path = '/cgi-bin/mimetex.cgi?'.$esc_texstring; + my $socket; + &Apache::lonxml::start_alarm(); + $socket = IO::Socket::INET->new(PeerAddr => 'localhost', + PeerPort => 'http(80)', + Proto => 'tcp'); + if ($socket) { + my $headreq = "HEAD $path HTTP/1.0\r\n\r\n"; + print $socket $headreq; + while (<$socket>) { + if (/Vertical\-Align\:\s*?([\-\d]+)/) { + $valign = $1; + } + } + $socket->close(); + } + &Apache::lonxml::end_alarm(); + return $valign; +} + sub mimetex_converted { my $texstring=shift; + +# Alt-Argument for screen readers + my $alt_string=$$texstring; + $alt_string=~s/\"/\'\'/g; + +# Is this displaystyle? + my $displaystyle=&displaystyle($texstring); +# Remove math environment delimiters + &clean_out_math_mode($texstring); if ($displaystyle) { $$texstring='\\displaystyle \\Large '.$$texstring; } - my $result=''; + my $esc_texstring = &uri_escape($$texstring); + my $valign = &mimetex_valign($esc_texstring); + my $result=''; if ($displaystyle) { - $result='
'; $tex=0; + $outmessage.='
'; + $tex=0; } else { - $outmessage.=&to_convert($_); $tex=0; + $outmessage.=&to_convert($fragment); + $tex=0; } } else { - $outmessage.=&smiley($_); $tex=1; + $outmessage.=&smiley($fragment); + $tex=1; } } $message=$outmessage; $outmessage=''; $tex=0; - foreach (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i,$message)) { + foreach my $fragment (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i, + $message)) { if ($tex) { + my $algebra = &algebra($fragment, 'web', undef, undef, undef, undef, 'tth'); if ($email) { - $outmessage.='
'; + $tex=0; } else { - $outmessage.=&algebra($_,'web'); $tex=0; + $outmessage.=$algebra; + $tex=0; } } else { - $outmessage.=$_; $tex=1; + $outmessage.=$fragment; + $tex=1; } } if (wantarray) { @@ -304,9 +490,9 @@ sub msgtexconverted { sub algebra { use AlgParser; - - my ($string,$target,$style)=@_; + my ($string,$target,$style,$parstack,$safeeval,$tth)=@_; my $parser = new AlgParserWithImplicitExpand; + if ($tth eq 'tth') {&init_tth();} $string=&prepare_algebra($string); my $ret = $parser->parse($string); my $result='['.&mt('Algebra unconverted due to previous errors').']'; @@ -322,7 +508,9 @@ sub algebra { $latex='\\ensuremath{'.$latex.'}'; } if ($target eq 'web' || $target eq 'analyze') { - $result = &converted(\$latex); + my $display=&Apache::lonxml::get_param('display',$parstack,$safeeval); + $result = &converted(\$latex,$display); +# $result = &converted(\$latex); } else { $result = $latex; } @@ -346,9 +534,6 @@ sub postprocess_algebra { # moodle had these and I don't know why, ignoring them for now # $string =~s/\\fun/ /g; - # remove the extra () in the denominator of a \frac - $string =~s/\\frac{(.+?)}{\\left\((.+?)\\right\)}/\\frac{$1}{$2}/gs; - # sqrt(3,4) means the 4 root of 3 $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs; @@ -372,8 +557,113 @@ sub postprocess_algebra { __END__ +=pod + +=head1 NAME + +Apache::lontexconvert; + +=head1 SYNOPSIS + +Access to tth/ttm + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + + +=head1 SUBROUTINES + +=over + +=item init_tth() + +Header + +=item convert_real() + + we need this routine because &converted can get called from inside + of the safespace (through &xmlparse('stuff') which doesn't + allow the opcode for alarm, so we need to compile this before we get + into the safe space since opcode checks only occur at compile time + +=item tth_converted() + + +=item clean_out_math_mode() + + +=item displaystyle() + + +=item jsMath_converted() + +=item MathJax_converted() + - Mimics the jsMath functionality + +=item tex_engine() + + +=item init_math_support() + +=item mimetex_valign() + + Makes a HEAD call to /cgi-bin/mimetex.cgi via IO:: to retrieve the + vertical alignment, before the subsequent call to mimetex_converted() + which generates the tag and the corresponding image. + + Input: 1. $esc_texstring (escaped TeX to be rendered by mimetex). + Output: 1. $valign - number of pixels: positive or negative integer + which will be included in tag for mimetex image to + support vertical alignment of image within a line of text. + + If a server is running SSL, and Apache rewrite rules are in place + to rewrite requests for http to https, modification will most likely + be needed for pass through for HEAD requests for /cgi-bin/mimetex.cgi. + + Example rewrite rules which rewrite all http traffic to https, + except HEAD requests for /cgi-bin/mimetex.cgi are: + + + RewriteEngine On + RewriteLogLevel 0 + + RewriteCond %{HTTPS} off + RewriteCond %{HTTP:Host} (.*) + RewriteCond %{REQUEST_METHOD} !HEAD + RewriteRule ^/(.*) https://%1/$1 [R=301,L] + + RewriteCond %{HTTPS} off + RewriteCond %{HTTP:Host} (.*) + RewriteCond %{REQUEST_METHOD} HEAD + RewriteCond %{REQUEST_URI} !^/cgi-bin/mimetex.cgi + RewriteRule ^/(.*) https://%1/$1 [R=301,L] + + +=item mimetex_converted() + + +=item converted() + + +=item to_convert() + +message display + +=item smiley() + +??? + +=item msgtexconverted() + +=item algebra() + +=item prepare_algebra() + +=item postprocess_algebra() +=back +=cut