1: # The LearningOnline Network with CAPA
2: # TeX Conversion Module
3: #
4: # $Id: lontexconvert.pm,v 1.112.2.8 2019/02/15 17:52:54 raeburn 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: use lib '/home/httpd/lib/perl/';
49: use LONCAPA;
50: use URI::Escape;
51: use IO::Socket::INET;
52:
53:
54: #
55: # Table of substitutions to unicode characters.
56: #
57:
58: my %unicode_harpoons = (
59: '\rightleftharpoons' => 0x21cc,
60: );
61:
62: my %unicode_translations = (
63:
64: # Brackets - unicode for browsers/OS which support it.
65:
66: '' => 0x23a1,
67: '' => 0x23a2,
68: '' => 0x23a3,
69: '' => 0x23a4,
70: '' => 0x23a5,
71: '' => 0x23a6,
72:
73: # Parens - unicode for browsers/OS which support it
74:
75: '' => 0x239b,
76: '' => 0x239c,
77: '' => 0x239d,
78: '' => 0x239e,
79: '' => 0x239f,
80: '' => 0x23a0,
81:
82: );
83:
84: my %ascii_8bit_translations = (
85:
86: # Brackets - pure 8-bit ascii ugliness for browsers/OS which can't handle unicode
87:
88: '' => 0x5b,
89: '' => 0x5b, # '['
90: '' => 0x5b,
91: '' => 0x5d, # ']'
92: '' => 0x5d,
93: '' => 0x5d,
94:
95: # Parens - pure 8-bit ascii ugliness for browsers/OS which can't handle unicode
96:
97: '' => 0x28,
98: '' => 0x28, # '('
99: '' => 0x28,
100: '' => 0x29,
101: '' => 0x29, # '('
102: '' => 0x29,
103:
104: );
105:
106: ##
107: # Utility to convert elements of a string to unicode:
108: #
109: # @param input - Input string
110: # @param pattern - Pattern to convert
111: # @param unicode - Unicode to substitute for pattern.
112: #
113: # @return string - resulting string.
114: #
115: sub unicode_subst {
116: my ($input, $pattern, $unicode) = @_;
117:
118: my $char = pack('U', $unicode);
119:
120: $input =~ s/$pattern/$char/g;
121:
122: return $input;
123: }
124:
125: # ====================================================================== Header
126:
127: sub init_tth {
128: my $options=$env{'course.'.$env{'request.course.id'}.'.tthoptions'};
129: if ($options =~ /\S/) {
130: $options = ' '.$options;
131: } else {
132: undef($options);
133: }
134: if ($env{'browser.mathml'}) {
135: &tth::ttminit();
136: if ($env{'browser.unicode'}) {
137: &tth::ttmoptions('-L -u1'.$options);
138: } else {
139: &tth::ttmoptions('-L -u0'.$options);
140: }
141: } else {
142: &tth::tthinit();
143: if ($env{'browser.unicode'}) {
144: &tth::tthoptions('-L -u1'.$options);
145: } else {
146: &tth::tthoptions('-L -u0'.$options);
147: }
148: }
149: }
150:
151: # ================================================================== Conversion
152:
153: $Apache::lontexconvert::messedup=0;
154:
155:
156: sub convert_real {
157: my ($texstring)=@_;
158: my ($xmlstring,$errorstring);
159: local $SIG{SEGV}=sub { $Apache::lontexconvert::messedup=1; die; };
160: local $SIG{ALRM}=sub {
161: &Apache::lonnet::logthis("ALRM");
162: $xmlstring='['.&mt("TeX unconverted due to errors").']';
163: $Apache::lontexconvert::messedup=1;
164: die &mt("TeX unconverted due to errors");
165: };
166: &Apache::lonxml::start_alarm();
167: if ($env{'browser.mathml'}) {
168: $xmlstring=&tth::ttm($$texstring);
169: $xmlstring=~s/\<math\>/\<math xmlns=\"\&mathns\;\"\>/g;
170: $xmlstring=~s/\<br\>/\<br\/\>/g;
171: $xmlstring=~s/\<p\>/\<p\>\<\/p\>/g;
172: $errorstring.=&tth::ttmerror();
173: } else {
174: $xmlstring=&tth::tth($$texstring);
175: $errorstring.=&tth::ttherror();
176: $xmlstring=~s-</font(\s*)>-</font>-g;
177: }
178: $xmlstring=~s/^\s*\<br clear\=\"all\"/\<br/s;
179: $xmlstring=~s/^\s*//;
180: $xmlstring=~s/\s*$//;
181: &Apache::lonxml::end_alarm();
182:
183: #
184: # Several strings produced by tth require
185: # transliteration -> unicode equivalents to render reliably
186: # in browsers. %unicode_translations and %unicode_harpoons are tables of
187: # string->substitution which we now apply. (%ascii_8bit_translations used
188: # instead for Windows XP and mobile devices.
189:
190: my $use_ascii;
191: if ($env{'browser.os'} eq 'win') {
192: if (($env{'browser.osversion'}) && ($env{'browser.osversion'} < 6.0)) {
193: $use_ascii = 1;
194: }
195: }
196: if ($env{'browser.mobile'}) {
197: $use_ascii = 1;
198: }
199:
200: foreach my $pattern (keys(%unicode_translations)) {
201: my $unicode = $unicode_translations{$pattern};
202: if ($use_ascii) {
203: $unicode = $ascii_8bit_translations{$pattern};
204: }
205: $xmlstring = &unicode_subst($xmlstring, $pattern, $unicode);
206: }
207:
208: foreach my $pattern (keys(%unicode_harpoons)) {
209: $xmlstring = &unicode_subst($xmlstring, $pattern, $unicode_harpoons{$pattern});
210: }
211:
212: return ($xmlstring,$errorstring);
213: }
214:
215: sub tth_converted {
216: my $texstring=shift;
217: my $xmlstring='['.&mt('UNDISPLAYABLE').']';
218: if ($Apache::lontexconvert::messedup) {
219: return '['.&mt('TeX unconverted due to previous errors').']';
220: }
221: $$texstring ='\\documentstyle{article}'.$$texstring;
222:
223: eval(<<'ENDCONV');
224: ($xmlstring,$errorstring)=&convert_real($texstring)
225: ENDCONV
226: if ($@) {
227: $errorstring.=&mt("Evaluation Error: ").$@;
228: $Apache::lontexconvert::messedup=1;
229: }
230: if ($Apache::lontexconvert::messedup || &tth::tthmessedup() ||
231: $errorstring) {
232: &Apache::lonnet::logthis("Trying to kill myself");
233: $Apache::lontexconvert::messedup=1;
234: if (ref($Apache::lonxml::request)) {
235: $Apache::lonxml::request->child_terminate();
236: } else {
237: my $request;
238: eval { $request=Apache->request; };
239: if (!$request) {
240: eval { $request=Apache2::RequestUtil->request; };
241: }
242: if ($request) {
243: $request->child_terminate();
244: } else {
245: &Apache::lonnet::logthis("Unable to find a request to do child_terminate on");
246: }
247: }
248: }
249: return $xmlstring;
250: }
251:
252: sub clean_out_math_mode {
253: my ($texstring)=@_;
254: $$texstring=~s/(?<!\\)\$//g;
255: $$texstring=~s/\\[\)\(\]\[]//g;
256: $$texstring=~s/\\ensuremath//g;
257: return '';
258: }
259:
260: sub displaystyle {
261: my ($texstring)=@_;
262: #has a $$ or \[ or \displaystyle or eqnarray in it, guessinng it's display mode
263: if ($$texstring=~/[^\\]\$\$/ ||
264: $$texstring=~/\\\[/ ||
265: $$texstring=~/\\displaystyle/ ||
266: $$texstring=~/eqnarray/
267: ) { return 1; }
268: return 0;
269: }
270:
271: sub MathJax_converted {
272: my $texstring=shift;
273: my ($tag,$startspan,$endspan);
274: $tag='math/tex;';
275: if (&displaystyle($texstring)) {
276: $tag='math/tex; mode=display';
277: $startspan='';
278: $endspan='';
279: } else {
280: $startspan='<span style="display:inline-block;">';
281: $endspan='</span>';
282: }
283: &clean_out_math_mode($texstring);
284: return &MathJax_header().$startspan.
285: '<script type="'.$tag.'">'.$$texstring.'</script>'.$endspan;
286: }
287:
288: {
289: #Relies heavily on the previous jsMath installation
290: my @MathJax_sent_header;
291: sub MathJax_reset {
292: undef(@MathJax_sent_header);
293: }
294: sub MathJax_push {
295: push(@MathJax_sent_header,0);
296: }
297: sub MathJax_header {
298: if (!@MathJax_sent_header) {
299: &Apache::lonnet::logthis("mismatched calls of MathJax_header and MathJax_process");
300: return '';
301: }
302: return '' if $MathJax_sent_header[-1];
303: $MathJax_sent_header[-1]=1;
304: return
305: '<script type="text/javascript" src="/adm/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>'."\n";
306: }
307: }
308:
309: sub tex_engine {
310: if (exists($env{'form.texengine'})) {
311: if ($env{'form.texengine'} ne '') {
312: if (lc($env{'form.texengine'}) eq 'jsmath') {
313: return 'MathJax';
314: }
315: return $env{'form.texengine'};
316: }
317: }
318: if ($env{'request.course.id'}
319: && exists($env{'course.'.$env{'request.course.id'}.'.texengine'})) {
320: if (lc($env{'course.'.$env{'request.course.id'}.'.texengine'}) eq 'jsmath') {
321: return 'MathJax';
322: }
323: return $env{'course.'.$env{'request.course.id'}.'.texengine'};
324: }
325: if (exists($env{'environment.texengine'})) {
326: if (lc($env{'environment.texengine'}) eq 'jsmath') {
327: return 'MathJax';
328: }
329: return $env{'environment.texengine'};
330: }
331: my $dom = $env{'request.role.domain'} || $env{'user.domain'};
332: my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
333: if ($domdefaults{'texengine'} ne '') {
334: return $domdefaults{'texengine'};
335: }
336: return 'tth';
337: }
338:
339: sub init_math_support {
340: &init_tth();
341: &Apache::lontexconvert::MathJax_push();
342: if (lc(&tex_engine()) eq 'mathjax') {
343: return &Apache::lontexconvert::MathJax_header();
344: }
345: return;
346: }
347:
348: sub mimetex_valign {
349: my ($esc_texstring)=@_;
350: my $valign = 0;
351: my $path = '/cgi-bin/mimetex.cgi?'.$esc_texstring;
352: my $socket;
353: &Apache::lonxml::start_alarm();
354: $socket = IO::Socket::INET->new(PeerAddr => 'localhost',
355: PeerPort => 'http(80)',
356: Proto => 'tcp');
357: if ($socket) {
358: my $headreq = "HEAD $path HTTP/1.0\r\n\r\n";
359: print $socket $headreq;
360: while (<$socket>) {
361: if (/Vertical\-Align\:\s*?([\-\d]+)/) {
362: $valign = $1;
363: }
364: }
365: $socket->close();
366: }
367: &Apache::lonxml::end_alarm();
368: return $valign;
369: }
370:
371: sub mimetex_converted {
372: my $texstring=shift;
373:
374: # Alt-Argument for screen readers
375: my $alt_string=$$texstring;
376: $alt_string=~s/\"/\'\'/g;
377:
378: # Is this displaystyle?
379:
380: my $displaystyle=&displaystyle($texstring);
381:
382: # Remove math environment delimiters
383:
384: &clean_out_math_mode($texstring);
385:
386: if ($displaystyle) {
387: $$texstring='\\displaystyle \\Large '.$$texstring;
388: }
389: my $esc_texstring = &uri_escape($$texstring);
390: my $valign = &mimetex_valign($esc_texstring);
391: my $result='<img src="/cgi-bin/mimetex.cgi?'.$esc_texstring.'" style="vertical-align:'.$valign.'px" alt="'.$alt_string.'" />';
392: if ($displaystyle) {
393: $result='<div style="text-align:center">'.$result.'</div>';
394: }
395: return $result;
396: }
397:
398: sub converted {
399: my ($string,$mode)=@_;
400: if ($mode eq '') { $mode = &tex_engine(); }
401: if ($mode =~ /tth/i) {
402: return &tth_converted($string);
403: } elsif ($mode =~ /jsmath/i) {
404: return &MathJax_converted($string);
405: } elsif ($mode =~ /mathjax/i) {
406: return &MathJax_converted($string);
407: } elsif ($mode =~ /mimetex/i) {
408: return &mimetex_converted($string);
409: } elsif ($mode =~ /raw/i) {
410: return $$string;
411: }
412: return &tth_converted($string);
413: }
414:
415: # ------------------------------------------------------------ Message display
416:
417: sub to_convert {
418: my ($string) = @_;
419: &init_tth();
420: $string=~s/\<br\s*\/?\>/ /gs;
421: # $string=~s/\s/ /gs;
422: $string=&HTML::Entities::decode($string);
423: return &converted(\$string);
424: }
425:
426: sub smiley {
427: my $expression=shift;
428: my %smileys=(
429: '\:\-*\)' => 'face-smile.png',
430: '8\-\)' => 'face-cool.png',
431: '8\-(I|\|)' => 'face-glasses.png',
432: '\:\-(I|\|)' => 'face-plain.png',
433: '\:\-(o|O|\(\))' => 'face-surprise.png',
434: ':\-\(' => 'face-sad.png',
435: '\;\-\)' => 'face-wink.png',
436: '\:\-(P|p)' => 'face-raspberry.png',
437: '\:\-(\\\|\\/)' => 'face-uncertain.png',
438: '\:\-D' => 'face-smile-big.png',
439: '\:\-(C|\@)' => 'face-angry.png',
440: '\:(\'|\`)\-*\(' => 'face-crying.png',
441: '\:\-(X|x|\#)' => 'face-quiet.png',
442: '\:\-(s|S)' => 'face-uncertain.png',
443: '\:\-\$' => 'face-embarrassed.png',
444: '\:\-\*' => 'face-kiss.png',
445: '\+O\(' => 'face-sick.png',
446: '(\<\;3|\(heart\))' => 'heart.png',
447: '\(rose\)' => 'rose.png',
448: '\(pizza\)' => 'food-pizza.png',
449: '\(cake\)' => 'food-cake.png',
450: '\(ninja\)' => 'face-ninja.png',
451: '\(pirate\)' => 'face-pirate.png',
452: '\((agree|yes)\)' => 'opinion-agree.png',
453: '\((disagree|nay)\)' => 'opinion-disagree.png',
454: '(o|O)\-\)' => 'face-angel.png',
455: );
456: my $iconpath=$Apache::lonnet::perlvar{'lonIconsURL'};
457: foreach my $smiley (keys(%smileys)) {
458: $expression=~s/$smiley/\<img src="$iconpath\/$smileys{$smiley}" \/\>/gs;
459: }
460: return $expression;
461: }
462:
463: sub msgtexconverted {
464: my ($message,$email) = @_;
465: $errorstring='';
466: my $outmessage='';
467: my $tex=0;
468: foreach my $fragment (split(/(?:\<\;|\<)\/*m\s*(?:\>\;|\>)/i,$message)) {
469: if ($tex) {
470: if ($email) {
471: $outmessage.='</pre><tt>'.&to_convert($fragment).'</tt><pre>';
472: $tex=0;
473: } else {
474: $outmessage.=&to_convert($fragment);
475: $tex=0;
476: }
477: } else {
478: $outmessage.=&smiley($fragment);
479: $tex=1;
480: }
481: }
482: $message=$outmessage; $outmessage=''; $tex=0;
483: foreach my $fragment (split(/(?:\<\;|\<)\/*algebra\s*(?:\>\;|\>)/i,
484: $message)) {
485: if ($tex) {
486: my $algebra = &algebra($fragment, 'web', undef, undef, undef, 'tth');
487: if ($email) {
488: $outmessage.='</pre><tt>'.$algebra.'</tt><pre>';
489: $tex=0;
490: } else {
491: $outmessage.=$algebra;
492: $tex=0;
493: }
494: } else {
495: $outmessage.=$fragment;
496: $tex=1;
497: }
498: }
499: if (wantarray) {
500: return ($outmessage,$errorstring);
501: } else {
502: return $outmessage.$errorstring;
503: }
504: }
505:
506: sub algebra {
507: use AlgParser;
508: my ($string,$target,$style,$parstack,$safeeval,$tth)=@_;
509: my $parser = new AlgParserWithImplicitExpand;
510: if ($tth eq 'tth') {&init_tth();}
511: $string=&prepare_algebra($string);
512: my $ret = $parser->parse($string);
513: my $result='['.&mt('Algebra unconverted due to previous errors').']';
514: if ( ref($ret) ) {
515: #$parser->tostring();
516: $parser->normalize();
517: my $latex=$parser->tolatex();
518: $latex=&postprocess_algebra($latex);
519: if ($style eq 'display') {
520: $latex='$$'.$latex.'$$x';
521: } else {
522: # style is 'inline'
523: $latex='\\ensuremath{'.$latex.'}';
524: }
525: if ($target eq 'web' || $target eq 'analyze') {
526: my $display=&Apache::lonxml::get_param('display',$parstack,$safeeval);
527: $result = &converted(\$latex,$display);
528: # $result = &converted(\$latex);
529: } else {
530: $result = $latex;
531: }
532: } else {
533: &Apache::lonxml::error($parser->{'htmlerror'});
534: }
535: }
536:
537: sub prepare_algebra {
538: my ($string)=@_;
539:
540: # makes the decision about what is a minus sign easier supposedly
541: $string =~ s/(\<\>|\<\=|\>\=[\=\>\<] *)-/$1 zeroplace -/g;
542:
543: return $string;
544: }
545:
546: sub postprocess_algebra {
547: my ($string)=@_;
548:
549: # moodle had these and I don't know why, ignoring them for now
550: # $string =~s/\\fun/ /g;
551:
552: # sqrt(3,4) means the 4 root of 3
553: $string =~s/\\sqrt\{([^,]+),([^\}]+)}/\\sqrt[$2]{$1}/gs;
554:
555: # log(3,4) means the log base 4 of 3
556: $string =~s/\\log\\left\((.+?),(.+?)\\right\)/\\log_{$2}\\left($1\\right)/gs;
557:
558: # log(3,4) means the log base 4 of 3
559: $string =~s/\\((?:sin|cos|tan|sec|csc|cot)(?:h)?)\\left\((.+?),(.+?)\\right\)/\\$1^{$3}\\left($2\\right)/gs;
560:
561: # int(3,a,b) integral from a to b of 3
562: $string =~s/\\int\\left\((.+?),(.+?),(.+?)\\right\)/\\int_{$2}^{$3}\\left($1\\right)/gs;
563:
564: # int( ... dx) -> ...
565: $string =~s/\\int\\left\((.+?)d[a-z]\\right\)/$1/gs;
566:
567: #
568: $string =~s/\\lim\\left\((.+?),(.+?),(.+?)\\right\)/\\lim_{$2\\to $3}$1/gs;
569: return $string;
570: }
571:
572:
573: 1;
574: __END__
575:
576:
577: =pod
578:
579: =head1 NAME
580:
581: Apache::lontexconvert;
582:
583: =head1 SYNOPSIS
584:
585: Access to tth/ttm
586:
587: This is part of the LearningOnline Network with CAPA project
588: described at http://www.lon-capa.org.
589:
590:
591: =head1 SUBROUTINES
592:
593: =over
594:
595: =item init_tth()
596:
597: Header
598:
599: =item convert_real()
600:
601: we need this routine because &converted can get called from inside
602: of the safespace (through &xmlparse('<m>stuff</m>') which doesn't
603: allow the opcode for alarm, so we need to compile this before we get
604: into the safe space since opcode checks only occur at compile time
605:
606: =item tth_converted()
607:
608:
609: =item clean_out_math_mode()
610:
611:
612: =item displaystyle()
613:
614:
615: =item MathJax_converted()
616:
617: =item tex_engine()
618:
619: =item init_math_support()
620:
621: =item mimetex_valign()
622:
623: Makes a HEAD call to /cgi-bin/mimetex.cgi via IO:: to retrieve the
624: vertical alignment, before the subsequent call to mimetex_converted()
625: which generates the <img> tag and the corresponding image.
626:
627: Input: 1. $esc_texstring (escaped TeX to be rendered by mimetex).
628: Output: 1. $valign - number of pixels: positive or negative integer
629: which will be included in <img> tag for mimetex image to
630: support vertical alignment of image within a line of text.
631:
632: If a server is running SSL, and Apache rewrite rules are in place
633: to rewrite requests for http to https, modification will most likely
634: be needed for pass through for HEAD requests for /cgi-bin/mimetex.cgi.
635:
636: Example rewrite rules which rewrite all http traffic to https,
637: except HEAD requests for /cgi-bin/mimetex.cgi are:
638:
639: <IfModule mod_rewrite.c>
640: RewriteEngine On
641: RewriteLogLevel 0
642:
643: RewriteCond %{HTTPS} off
644: RewriteCond %{HTTP:Host} (.*)
645: RewriteCond %{REQUEST_METHOD} !HEAD
646: RewriteRule ^/(.*) https://%1/$1 [R=301,L]
647:
648: RewriteCond %{HTTPS} off
649: RewriteCond %{HTTP:Host} (.*)
650: RewriteCond %{REQUEST_METHOD} HEAD
651: RewriteCond %{REQUEST_URI} !^/cgi-bin/mimetex.cgi
652: RewriteRule ^/(.*) https://%1/$1 [R=301,L]
653: </IfModule>
654:
655: =item mimetex_converted()
656:
657:
658: =item converted()
659:
660:
661: =item to_convert()
662:
663: message display
664:
665: =item smiley()
666:
667: ???
668:
669: =item msgtexconverted()
670:
671: =item algebra()
672:
673: =item prepare_algebra()
674:
675: =item postprocess_algebra()
676:
677: =back
678:
679: =cut
680:
681:
682:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lontexconvert.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / xml