[BACK]Return to lontexconvert.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / xml

Diff for /loncom/xml/lontexconvert.pm between versions 1.2 and 1.98

version 1.2, 2001/05/03 22:54:12 version 1.98, 2009/08/12 20:43:25
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # TeX Conversion Module  # TeX Conversion Module
 #  #
 # 05/29/00,05/30,10/11,10/20 Gerd Kortemeyer  # $Id$
 # 05/03/2001 Scott Harrison  #
   # Copyright Michigan State University Board of Trustees
   #
   # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   #
   # LON-CAPA is free software; you can redistribute it and/or modify
   # it under the terms of the GNU General Public License as published by
   # the Free Software Foundation; either version 2 of the License, or
   # (at your option) any later version.
   #
   # LON-CAPA is distributed in the hope that it will be useful,
   # but WITHOUT ANY WARRANTY; without even the implied warranty of
   # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   # GNU General Public License for more details.
   #
   # You should have received a copy of the GNU General Public License
   # along with LON-CAPA; if not, write to the Free Software
   # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   #
   # /home/httpd/html/adm/gpl.txt
   #
   # http://www.lon-capa.org/
   #
   # Copyright for TtHfunc and TtMfunc by Ian Hutchinson. 
   # TtHfunc and TtMfunc (the "Code") may be compiled and linked into 
   # binary executable programs or libraries distributed by the 
   # Michigan State University (the "Licensee"), but any binaries so 
   # distributed are hereby licensed only for use in the context
   # of a program or computational system for which the Licensee is the 
   # primary author or distributor, and which performs substantial 
   # additional tasks beyond the translation of (La)TeX into HTML.
   # The C source of the Code may not be distributed by the Licensee
   # to any other parties under any circumstances.
   #
   
 package Apache::lontexconvert;  package Apache::lontexconvert;
   
 use strict;  use strict;
 use tth;  use tth();
 use vars qw($errorstring);  use vars qw($errorstring);
 use Apache::lonmsg;  #use Apache::lonxml();
   use Apache::lonlocal;
   use Apache::lonnet;
   use lib '/home/httpd/lib/perl/';
   use LONCAPA;
   use URI::Escape;
   use IO::Socket::INET;
   use IO::Socket::SSL;
   
 # ====================================================================== Header  # ====================================================================== Header
   
 sub header {  sub init_tth {
   $errorstring='';      my $options=$env{'course.'.$env{'request.course.id'}.'.tthoptions'};
   my $time=time;      if ($options =~ /\S/) {
   my $addhead=<<END;   $options = ' '.$options;
 <script language="JavaScript">      } else {
     if (window.location.pathname!="/res/adm/pages/menu.html") {   undef($options);
  menu=window.open("","LONCAPAmenu");      }
  menu.currentURL=window.location.pathname;      if ($env{'browser.mathml'}) {
     }   &tth::ttminit();
 </script>   if ($env{'browser.unicode'}) {
 END      &tth::ttmoptions('-L -u1'.$options);
   if ($ENV{'browser.mathml'}) {   } else {
       &tth::ttminit();      &tth::ttmoptions('-L -u0'.$options);
       return '<?xml version="1.0"?>'   }
             .'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'      } else {
             .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '   &tth::tthinit();
             .'[<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">]>'   if ($env{'browser.unicode'}) {
             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '       &tth::tthoptions('-L -u1'.$options);
             .'xmlns="http://www.w3.org/TR/REC-html40">'   } else {
     ."<head>$addhead</head>"      &tth::tthoptions('-L -u0'.$options);
             ."\n";   }
   } else {      }
       &tth::tthinit();  
       my $headerstring='<html>';  
       if ($ENV{'browser.os'} eq 'mac') {   
          $headerstring.="<head>\n"  
              .'<meta Content-Type="text/html; charset=x-mac-roman">'  
      ."\n$addhead</head>\n";  
       }  
       else {  
   $headerstring.="<head>$addhead</head>";  
       }  
       return $headerstring."\n";  
   }  
 }  }
   
 # ================================================================== Conversion  # ================================================================== Conversion
   
 sub converted {  $Apache::lontexconvert::messedup=0;
   
   
   sub convert_real {
       my ($texstring)=@_;
       my ($xmlstring,$errorstring);
       local $SIG{SEGV}=sub { $Apache::lontexconvert::messedup=1; die; };
       local $SIG{ALRM}=sub { 
    &Apache::lonnet::logthis("ALRM");
    $xmlstring='['.&mt("TeX unconverted due to errors").']';
    $Apache::lontexconvert::messedup=1;
    die &mt("TeX unconverted due to errors");
       };
       &Apache::lonxml::start_alarm();
       if ($env{'browser.mathml'}) {
    $xmlstring=&tth::ttm($$texstring);
    $xmlstring=~s/\<math\>/\<math xmlns=\"\&mathns\;\"\>/g;
    $xmlstring=~s/\<br\>/\<br\/\>/g;
    $xmlstring=~s/\<p\>/\<p\>\<\/p\>/g;
    $errorstring.=&tth::ttmerror();
       } else {
    $xmlstring=&tth::tth($$texstring);
    $errorstring.=&tth::ttherror();
    $xmlstring=~s-</font(\s*)>-</font>-g;
       }
       $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
       $xmlstring=~s/^\s*//;
       $xmlstring=~s/\s*$//;
       #
       # \rightleftharpoons is not converted by tth but maps
       # reasonably well to &#8660;.  If we get many more of these,
       # we're going to need to have a translation sub.
       #
       my $lrharpoon = pack("U", 0x21cc);
       $xmlstring=~s/\\rightleftharpoons/$lrharpoon/g;
   
       &Apache::lonxml::end_alarm();
       return ($xmlstring,$errorstring);
   }
   
   sub tth_converted {
     my $texstring=shift;      my $texstring=shift;
     my $xmlstring;      my $xmlstring='['.&mt('UNDISPLAYABLE').']';
     if ($ENV{'browser.mathml'}) {      if ($Apache::lontexconvert::messedup) {
       $xmlstring=&tth::ttm($$texstring);   return '['.&mt('TeX unconverted due to previous errors').']';
       $xmlstring=~s/\<math\>/\<math xmlns=\"\&mathns\;\"\>/g;      }
       $xmlstring=~s/\<br\>/\<br\/\>/g;      $$texstring ='\\documentstyle{article}'.$$texstring;
       $xmlstring=~s/\<p\>/\<p\>\<\/p\>/g;  
       $errorstring.=&tth::ttmerror();      eval(<<'ENDCONV');
   } else {      ($xmlstring,$errorstring)=&convert_real($texstring)
       $xmlstring=&tth::tth($$texstring);  ENDCONV
       $errorstring.=&tth::ttherror();      if ($@) {
   }   $errorstring.=&mt("Evaluation Error: ").$@;
   return $xmlstring;   $Apache::lontexconvert::messedup=1;
 }      }
       if ($Apache::lontexconvert::messedup || &tth::tthmessedup() || 
 # ====================================================================== Footer   $errorstring) {
    &Apache::lonnet::logthis("Trying to kill myself");
 sub footer {   $Apache::lontexconvert::messedup=1;
   my $xmlstring='';   if (ref($Apache::lonxml::request)) {
   if ($ENV{'request.state'} eq 'construct') {      $Apache::lonxml::request->child_terminate();
       $xmlstring.='<address>'.$errorstring.'</address>';   } else {
   } else {      my $request;
       &Apache::lonmsg::author_res_msg($ENV{'request.filename'},$errorstring);      eval { $request=Apache->request; };
   }      if (!$request) {
 # -------------------------------------------------------------------- End Body   eval { $request=Apache2::RequestUtil->request; };
   $xmlstring.='</html>';      }
   return $xmlstring;      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/\\[\)\(\]\[]//g;
       $$texstring=~s/\\ensuremath//g;
       return '';
   }
   
   sub displaystyle {
       my ($texstring)=@_;
       #has a $$ or \[ or \displaystyle in it, guessinng it's display mode
       if ($$texstring=~/[^\\]\$\$/ ||
    $$texstring=~/\\\[/ ||
    $$texstring=~/\\displaystyle/) { return 1; }
       return 0;
   }
   
   sub jsMath_converted {
       my $texstring=shift;
       my $tag='span';
       if (&displaystyle($texstring)) { $tag='div'; }
       &clean_out_math_mode($texstring);
       return &jsMath_header().
    '<'.$tag.' class="math">'.$$texstring.'</'.$tag.'>';
   }
   
   {
       my @jsMath_sent_header;
       sub jsMath_reset {
    undef(@jsMath_sent_header);
       }
       sub jsMath_push {
    push(@jsMath_sent_header,0);
       }
       sub jsMath_header {
    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
               '<script type="text/javascript">
                        function NoFontMessage () {}
                        jsMath = {Parser: {prototype: {environments: {\'eqnarray*\' :[\'Array\',null,null,\'rcl\',[5/18,5/18],3,\'D\']}}}};
                      </script>'."\n".
       '<script type="text/javascript" src="/adm/jsMath/jsMath.js"></script>'."\n";
       }
       sub jsMath_process {
    my $state = pop(@jsMath_sent_header);
    return '' if !$state;
    return "\n".
       '<script type="text/javascript">jsMath.Process()</script>'."\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();
       }
       return;
   }
   
   sub mimetex_valign {
       my ($esc_texstring)=@_;
       my $valign = 0;
       my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
       my $hostname = &Apache::lonnet::hostname($lonhost);
       my $protocol = $Apache::lonnet::protocol{$lonhost};
       my $path = '/cgi-bin/mimetex.cgi?'.$esc_texstring;
       my $socket;
       &Apache::lonxml::start_alarm();
       if ($protocol eq 'https') {
           $socket = IO::Socket::SSL->new(PeerAddr => $hostname,
                                          PeerPort => 'https(443)',
                                          Proto    => 'tcp');
       } else {
           $socket = IO::Socket::INET->new(PeerAddr => $hostname,
                                           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;
               }
           }
           if ($protocol eq 'https') {
               $socket->close(SSL_no_shutdown => 1,
                              SSL_ctx_free => 1);
           } else {
               $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 $esc_texstring = &uri_escape($$texstring);
       my $valign = &mimetex_valign($esc_texstring);
       my $result='<img src="/cgi-bin/mimetex.cgi?'.$esc_texstring.'" style="vertical-align:'.$valign.'px" alt="'.$alt_string.'" />';
       if ($displaystyle) {
    $result='<center>'.$result.'</center>';
       }
       return $result;
   }
   
   sub converted {
       my ($string,$mode)=@_;
       if ($mode eq '') { $mode = &tex_engine(); }
       if ($mode =~ /tth/i) {
    return &tth_converted($string);
       } elsif ($mode =~ /jsmath/i) {
    return &jsMath_converted($string);
       } elsif ($mode =~ /mimetex/i) {
    return &mimetex_converted($string);
       } elsif ($mode =~ /raw/i) {
           return $$string;
       }
       return &tth_converted($string);
   }
   
   # ------------------------------------------------------------ Message display
   
   sub to_convert {
       my ($string) = @_;
       $string=~s/\<br\s*\/?\>/ /gs;
   #    $string=~s/\s/ /gs;
       $string=&HTML::Entities::decode($string);
       return &converted(\$string);
   }
   
   sub smiley {
       my $expression=shift;
       if ($env{'browser.imagesuppress'} eq 'on') { return $expression; }
       my %smileys=('\:\-\)' => 'smiley',
    '8\-\)'  => 'coolsmile',
    '8\-(I|\|)'   => 'coolindiff',
    ':\-(I|\|)'   => 'neutral',
    '\:\-(o|O|\(\))' => 'shocked',
    ':\-\('  => 'frowny',
    '\;\-\)' => 'wink',
    '\:\-P'  => 'baeh',
    '\:\-(\\\|\\/)' => 'hrrm',
    '\:\-D'  => 'bigsmile',
    '\:\-C'  => 'angry',
    '\:(\'|\`)\-\(' => 'cry',
    '\:\-(X|\#)' => 'lipsrsealed',
    '\:\-S' => 'huh');
       my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
       foreach my $smiley (keys(%smileys)) {
    $expression=~s/$smiley/\<img src="$iconpath\/$smileys{$smiley}.gif" \/\>/gs; 
       }
       return $expression;
   }
   
   sub msgtexconverted {
       my ($message,$email) = @_;
       $errorstring='';
       &init_tth();
       my $outmessage='';
       my $tex=0;
       foreach my $fragment (split(/(?:\&lt\;|\<)\/*m\s*(?:\&gt\;|\>)/i,$message)) {
    if ($tex) {
       if ($email) {
    $outmessage.='</pre><tt>'.&to_convert($fragment).'</tt><pre>';
    $tex=0;
       } else {
    $outmessage.=&to_convert($fragment);
    $tex=0;
       }
    } else {
               $outmessage.=&smiley($fragment);
       $tex=1;
    }
       }
       $message=$outmessage; $outmessage=''; $tex=0;
       foreach my $fragment (split(/(?:\&lt\;|\<)\/*algebra\s*(?:\&gt\;|\>)/i,
    $message)) {
    if ($tex) {
       if ($email) {
    $outmessage.='</pre><tt>'.&algebra($fragment,'web').'</tt><pre>';
    $tex=0;
       } else {
    $outmessage.=&algebra($fragment,'web');
    $tex=0;
       }
    } else {
               $outmessage.=$fragment;
       $tex=1;
    }
       }
       if (wantarray) {
    return ($outmessage,$errorstring);
       } else {
    return $outmessage.$errorstring;
       }
   }
   
   sub algebra {
       use AlgParser;
   
       my ($string,$target,$style,$parstack,$safeeval)=@_;
       my $parser = new AlgParserWithImplicitExpand;
       $string=&prepare_algebra($string);
       my $ret = $parser->parse($string);
       my $result='['.&mt('Algebra unconverted due to previous errors').']';
       if ( ref($ret) ) {
    #$parser->tostring();
    $parser->normalize();
    my $latex=$parser->tolatex();
    $latex=&postprocess_algebra($latex);
    if ($style eq 'display') {
       $latex='$$'.$latex.'$$x';
    } else {
       # style is 'inline'
       $latex='\\ensuremath{'.$latex.'}';
    }
    if ($target eq 'web' || $target eq 'analyze') {
               my $display=&Apache::lonxml::get_param('display',$parstack,$safeeval);
               $result = &converted(\$latex,$display);
   #    $result = &converted(\$latex);
    } else {
       $result = $latex;
    }
       } else {
    &Apache::lonxml::error($parser->{'htmlerror'});
       }
   }
   
   sub prepare_algebra {
       my ($string)=@_;
   
       # makes the decision about what is a minus sign easier supposedly
       $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
   
       return $string;
 }  }
   
   sub postprocess_algebra {
       my ($string)=@_;
       
       # moodle had these and I don't know why, ignoring them for now
       # $string =~s/\\fun/ /g;
   
       # sqrt(3,4) means the 4 root of 3
       $string =~s/\\sqrt{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
   
       # log(3,4) means the log base 4 of 3
       $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
   
       # log(3,4) means the log base 4 of 3
       $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
   
       # int(3,a,b) integral from a to b of 3
       $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
   
       # int( ... dx) -> ...
       $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
   
       # 
       $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
       return $string;
   }
 1;  1;
 __END__  __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('<m>stuff</m>') 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 tex_engine()
   
   
   =item init_math_support()
   
   
   =item mimetex_converted()
   
   
   =item converted()
   
   
   =item to_convert()
   
   message display
   
   =item smiley()
   
   ???
   
   =item msgtexconverted()
   
   =item algebra()
   
   =item prepare_algebra()
   
   =item postprocess_algebra()
   
   =back
   
   =cut
   
   
   
Removed from v.1.2  
changed lines
  Added in v.1.98

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