X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FMath.php;h=638113770c8c1684012320727031b0e2c378a1d6;hb=fcd1cdeb930e1779af77b3747b7c60338d4e81d7;hp=3c6075f3ff8cd574ad69273819beaeb4d9811cec;hpb=0332f4c59809e5a89f626e8969cd76261819f432;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/Math.php b/includes/Math.php index 3c6075f3ff..638113770c 100644 --- a/includes/Math.php +++ b/includes/Math.php @@ -1,132 +1,263 @@ parsing + * @package MediaWiki + */ -function linkToMathImage ( $tex, $outputhash ) -{ - global $wgMathPath; - return "\"".wfEscapeHTML($tex)."\""; -} - -function renderMath( $tex ) -{ - global $wgUser, $wgMathDirectory, $wgTmpDirectory, $wgInputEncoding; - global $wgTexvc; - $mf = wfMsg( "math_failure" ); - $munk = wfMsg( "math_unknown_error" ); +/** + * Takes LaTeX fragments, sends them to a helper program (texvc) for rendering + * to rasterized PNG and HTML and MathML approximations. An appropriate + * rendering form is picked and returned. + * + * by Tomasz Wegrzanowski, with additions by Brion Vibber (2003, 2004) + * + * @package MediaWiki + */ +class MathRenderer { + var $mode = MW_MATH_MODERN; + var $tex = ''; + var $inputhash = ''; + var $hash = ''; + var $html = ''; + var $mathml = ''; + var $conservativeness = 0; - $fname = "renderMath"; + function MathRenderer( $tex ) { + $this->tex = $tex; + } - $math = $wgUser->getOption("math"); - if( $math == 3 ) { - return ('$ '.wfEscapeHTML($tex).' $'); + function setOutputMode( $mode ) { + $this->mode = $mode; } - $md5 = md5($tex); - $md5_sql = mysql_escape_string(pack("H32", $md5)); - if ($math == 0) { - $sql = "SELECT math_outputhash FROM math WHERE math_inputhash = '$md5_sql'"; - } else { - $sql = "SELECT math_outputhash,math_html_conservativeness,math_html FROM math WHERE math_inputhash = '$md5_sql'"; - } + function render() { + global $wgTmpDirectory, $wgInputEncoding; + global $wgTexvc; + $fname = 'MathRenderer::render'; + + if( $this->mode == MW_MATH_SOURCE ) { + # No need to render or parse anything more! + return ('$ '.htmlspecialchars( $this->tex ).' $'); + } + + if( !$this->_recall() ) { + # Ensure that the temp and output directories are available before continuing... + if( !file_exists( $wgTmpDirectory ) ) { + if( !@mkdir( $wgTmpDirectory ) ) { + return $this->_error( 'math_bad_tmpdir' ); + } + } elseif( !is_dir( $wgTmpDirectory ) || !is_writable( $wgTmpDirectory ) ) { + return $this->_error( 'math_bad_tmpdir' ); + } + + if( function_exists( 'is_executable' ) && !is_executable( $wgTexvc ) ) { + return $this->_error( 'math_notexvc' ); + } + $cmd = $wgTexvc . ' ' . + escapeshellarg( $wgTmpDirectory ).' '. + escapeshellarg( $wgTmpDirectory ).' '. + escapeshellarg( $this->tex ).' '. + escapeshellarg( $wgInputEncoding ); + + if ( wfIsWindows() ) { + # Invoke it within cygwin sh, because texvc expects sh features in its default shell + $cmd = 'sh -c ' . wfEscapeShellArg( $cmd ); + } + + wfDebug( "TeX: $cmd\n" ); + $contents = `$cmd`; + wfDebug( "TeX output:\n $contents\n---\n" ); - $res = wfQuery( $sql, DB_READ, $fname ); + if (strlen($contents) == 0) { + return $this->_error( 'math_unknown_error' ); + } + + $retval = substr ($contents, 0, 1); + if (($retval == 'C') || ($retval == 'M') || ($retval == 'L')) { + if ($retval == 'C') + $this->conservativeness = 2; + else if ($retval == 'M') + $this->conservativeness = 1; + else + $this->conservativeness = 0; + $outdata = substr ($contents, 33); + + $i = strpos($outdata, "\000"); - if( $rpage = wfFetchObject ( $res ) ) { - $outputhash = unpack( "H32md5", $rpage->math_outputhash . " " ); - $outputhash = $outputhash ['md5']; - if( file_exists( "$wgMathDirectory/$outputhash.png" ) ) { - if (($math == 0) || ($rpage->math_html == '') || (($math == 1) && ($rpage->math_html_conservativeness != 2)) || (($math == 4) && ($rpage->math_html_conservativeness == 0))) { - return linkToMathImage ( $tex, $outputhash ); + $this->html = substr($outdata, 0, $i); + $this->mathml = substr($outdata, $i+1); + } else if (($retval == 'c') || ($retval == 'm') || ($retval == 'l')) { + $this->html = substr ($contents, 33); + if ($retval == 'c') + $this->conservativeness = 2; + else if ($retval == 'm') + $this->conservativeness = 1; + else + $this->conservativeness = 0; + $this->mathml = NULL; + } else if ($retval == 'X') { + $this->html = NULL; + $this->mathml = substr ($contents, 33); + $this->conservativeness = 0; + } else if ($retval == '+') { + $this->html = NULL; + $this->mathml = NULL; + $this->conservativeness = 0; } else { - return $rpage->math_html; + $errbit = htmlspecialchars( substr($contents, 1) ); + switch( $retval ) { + case 'E': return $this->_error( 'math_lexing_error', $errbit ); + case 'S': return $this->_error( 'math_syntax_error', $errbit ); + case 'F': return $this->_error( 'math_unknown_function', $errbit ); + default: return $this->_error( 'math_unknown_error', $errbit ); + } + } + + $this->hash = substr ($contents, 1, 32); + if (!preg_match("/^[a-f0-9]{32}$/", $this->hash)) { + return $this->_error( 'math_unknown_error' ); + } + + if( !file_exists( "$wgTmpDirectory/{$this->hash}.png" ) ) { + return $this->_error( 'math_image_error' ); + } + + $hashpath = $this->_getHashPath(); + if( !file_exists( $hashpath ) ) { + if( !@wfMkdirParents( $hashpath, 0755 ) ) { + return $this->_error( 'math_bad_output' ); + } + } elseif( !is_dir( $hashpath ) || !is_writable( $hashpath ) ) { + return $this->_error( 'math_bad_output' ); } + + if( !rename( "$wgTmpDirectory/{$this->hash}.png", "$hashpath/{$this->hash}.png" ) ) { + return $this->_error( 'math_output_error' ); + } + + # Now save it back to the DB: + if ( !wfReadOnly() ) { + $outmd5_sql = pack('H32', $this->hash); + + $md5_sql = pack('H32', $this->md5); # Binary packed, not hex + + $dbw =& wfGetDB( DB_MASTER ); + $dbw->replace( 'math', array( 'math_inputhash' ), + array( + 'math_inputhash' => $md5_sql, + 'math_outputhash' => $outmd5_sql, + 'math_html_conservativeness' => $this->conservativeness, + 'math_html' => $this->html, + 'math_mathml' => $this->mathml, + ), $fname, array( 'IGNORE' ) + ); + } + } + + return $this->_doRender(); } - - $cmd = $wgTexvc." ". - escapeshellarg($wgTmpDirectory)." ". - escapeshellarg($wgMathDirectory)." ". - escapeshellarg($tex)." ". - escapeshellarg($wgInputEncoding); - wfDebug( "TeX: $cmd" ); - $contents = `$cmd`; - - if (strlen($contents) == 0) { - return "".$mf." (".$munk."): ".wfEscapeHTML($tex).""; + + function _error( $msg, $append = '' ) { + $mf = htmlspecialchars( wfMsg( 'math_failure' ) ); + $munk = htmlspecialchars( wfMsg( 'math_unknown_error' ) ); + $errmsg = htmlspecialchars( wfMsg( $msg ) ); + $source = htmlspecialchars( str_replace( "\n", ' ', $this->tex ) ); + return "$mf ($errmsg$append): $source\n"; } - - $retval = substr ($contents, 0, 1); - if (($retval == "C") || ($retval == "M") || ($retval == "L")) { - if ($retval == "C") - $conservativeness = 2; - else if ($retval == "M") - $conservativeness = 1; - else - $conservativeness = 0; - $outdata = substr ($contents, 33); - - $i = strpos($outdata, "\000"); - - $outhtml = substr($outdata, 0, $i); - $mathml = substr($outdata, $i+1); - - $sql_html = "'".mysql_escape_string($outhtml)."'"; - $sql_mathml = "'".mysql_escape_string($mathml)."'"; - } else if (($retval == "c") || ($retval == "m") || ($retval == "l")) { - $outhtml = substr ($contents, 33); - if ($retval == "c") - $conservativeness = 2; - else if ($retval == "m") - $conservativeness = 1; - else - $conservativeness = 0; - $sql_html = "'".mysql_escape_string($outhtml)."'"; - $mathml = ''; - $sql_mathml = 'NULL'; - } else if ($retval == "X") { - $outhtml = ''; - $mathml = substr ($contents, 33); - $sql_html = 'NULL'; - $sql_mathml = "'".mysql_escape_string($mathml)."'"; - $conservativeness = 0; - } else if ($retval == "+") { - $outhtml = ''; - $mathml = ''; - $sql_html = 'NULL'; - $sql_mathml = 'NULL'; - $conservativeness = 0; - } else { - if ($retval == "E") - $errmsg = wfMsg( "math_lexing_error" ); - else if ($retval == "S") - $errmsg = wfMsg( "math_syntax_error" ); - else if ($retval == "F") - $errmsg = wfMsg( "math_unknown_function" ); - else - $errmsg = $munk; - return "

".$mf." (".$errmsg.substr($contents, 1)."): ".wfEscapeHTML($tex)."

"; + + function _recall() { + global $wgMathDirectory; + $fname = 'MathRenderer::_recall'; + + $this->md5 = md5( $this->tex ); + $dbr =& wfGetDB( DB_SLAVE ); + $rpage = $dbr->selectRow( 'math', + array( 'math_outputhash','math_html_conservativeness','math_html','math_mathml' ), + array( 'math_inputhash' => pack("H32", $this->md5)), # Binary packed, not hex + $fname + ); + + if( $rpage !== false ) { + # Tailing 0x20s can get dropped by the database, add it back on if necessary: + $xhash = unpack( 'H32md5', $rpage->math_outputhash . " " ); + $this->hash = $xhash ['md5']; + + $this->conservativeness = $rpage->math_html_conservativeness; + $this->html = $rpage->math_html; + $this->mathml = $rpage->math_mathml; + + if( file_exists( $this->_getHashPath() . "/{$this->hash}.png" ) ) { + return true; + } + + if( file_exists( $wgMathDirectory . "/{$this->hash}.png" ) ) { + $hashpath = $this->_getHashPath(); + + if( !file_exists( $hashpath ) ) { + if( !@wfMkdirParents( $hashpath, 0755 ) ) { + return false; + } + } elseif( !is_dir( $hashpath ) || !is_writable( $hashpath ) ) { + return false; + } + if ( function_exists( "link" ) ) { + return link ( $wgMathDirectory . "/{$this->hash}.png", + $hashpath . "/{$this->hash}.png" ); + } else { + return rename ( $wgMathDirectory . "/{$this->hash}.png", + $hashpath . "/{$this->hash}.png" ); + } + } + + } + + # Missing from the database and/or the render cache + return false; } - $outmd5 = substr ($contents, 1, 32); - if (!preg_match("/^[a-f0-9]{32}$/", $outmd5)) { - return "".$mf." (".$munk."): ".wfEscapeHTML($tex).""; + /** + * Select among PNG, HTML, or MathML output depending on + */ + function _doRender() { + if( $this->mode == MW_MATH_MATHML && $this->mathml != '' ) { + return "{$this->mathml}"; + } + if (($this->mode == MW_MATH_PNG) || ($this->html == '') || + (($this->mode == MW_MATH_SIMPLE) && ($this->conservativeness != 2)) || + (($this->mode == MW_MATH_MODERN || $this->mode == MW_MATH_MATHML) && ($this->conservativeness == 0))) { + return $this->_linkToMathImage(); + } else { + return ''.$this->html.''; + } } - if( !file_exists( "$wgMathDirectory/$outmd5.png" ) ) { - $errmsg = wfMsg( "math_image_error" ); - return "

$mf ($errmsg): " . wfEscapeHTML($tex) . "

"; + function _linkToMathImage() { + global $wgMathPath; + $url = htmlspecialchars( "$wgMathPath/" . substr($this->hash, 0, 1) + .'/'. substr($this->hash, 1, 1) .'/'. substr($this->hash, 2, 1) + . "/{$this->hash}.png" ); + $alt = trim(str_replace("\n", ' ', htmlspecialchars( $this->tex ))); + return "\"$alt\""; } - $outmd5_sql = mysql_escape_string(pack("H32", $outmd5)); + function _getHashPath() { + global $wgMathDirectory; + $path = $wgMathDirectory .'/'. substr($this->hash, 0, 1) + .'/'. substr($this->hash, 1, 1) + .'/'. substr($this->hash, 2, 1); + wfDebug( "TeX: getHashPath, hash is: $this->hash, path is: $path\n" ); + return $path; + } - $sql = "REPLACE INTO math VALUES ('".$md5_sql."', '".$outmd5_sql."', ".$conservativeness.", ".$sql_html.", ".$sql_mathml.")"; - - $res = wfQuery( $sql, DB_READ, $fname ); - # we don't really care if it fails - if (($math == 0) || ($rpage->math_html == '') || (($math == 1) && ($conservativeness != 2)) || (($math == 4) && ($conservativeness == 0))) - return linkToMathImage($tex, $outmd5); - else - return $outhtml; +} + +function renderMath( $tex ) { + global $wgUser; + $math = new MathRenderer( $tex ); + $math->setOutputMode( $wgUser->getOption('math')); + return $math->render(); } ?>