mTokens = null; $this->mUniqPrefix = null; } /** * @param string $text * @return string */ public function getWrapped( $text ) { $this->mTokens = new ReplacementArray; $this->mUniqPrefix = "\x7fUNIQ" . dechex( mt_rand( 0, 0x7fffffff ) ) . dechex( mt_rand( 0, 0x7fffffff ) ); $this->mMarkerIndex = 0; // Replace elements with placeholders $wrappedtext = preg_replace_callback( ParserOutput::EDITSECTION_REGEX, array( &$this, 'replaceCallback' ), $text ); // ...and markers $wrappedtext = preg_replace_callback( '/\<\\/?mw:toc\>/', array( &$this, 'replaceCallback' ), $wrappedtext ); // ... and elements so they say and so // we can trick Tidy into not stripping them out by including them in tidy's new-empty-tags config $wrappedtext = preg_replace( '!<(link|meta)([^>]*?)(/{0,1}>)!', '' . '' . $wrappedtext . ''; return $wrappedtext; } /** * @param array $m * * @return string */ public function replaceCallback( $m ) { $marker = "{$this->mUniqPrefix}-item-{$this->mMarkerIndex}" . Parser::MARKER_SUFFIX; $this->mMarkerIndex++; $this->mTokens->setPair( $marker, $m[0] ); return $marker; } /** * @param string $text * @return string */ public function postprocess( $text ) { // Revert back to <{link,meta}> $text = preg_replace( '!]*?)(/{0,1}>)!', '<$1$2$3', $text ); // Restore the contents of placeholder tokens $text = $this->mTokens->replace( $text ); return $text; } } /** * Class to interact with HTML tidy * * Either the external tidy program or the in-process tidy extension * will be used depending on availability. Override the default * $wgTidyInternal setting to disable the internal if it's not working. * * @ingroup Parser */ class MWTidy { /** * Interface with html tidy, used if $wgUseTidy = true. * If tidy isn't able to correct the markup, the original will be * returned in all its glory with a warning comment appended. * * @param string $text Hideous HTML input * @return string Corrected HTML output */ public static function tidy( $text ) { $wrapper = new MWTidyWrapper; $wrappedtext = $wrapper->getWrapped( $text ); $retVal = null; list( $correctedtext, $errors ) = self::clean( $wrappedtext, $retVal ); if ( $retVal < 0 ) { wfDebug( "Possible tidy configuration error!\n" ); return $text . "\n\n"; } elseif ( $correctedtext === '' && $text !== '' ) { wfDebug( "Tidy error detected!\n" ); return $text . "\n\n"; } $correctedtext = $wrapper->postprocess( $correctedtext ); // restore any hidden tokens return $correctedtext; } /** * Check HTML for errors, used if $wgValidateAllHtml = true. * * @param string $text * @param string &$errorStr Return the error string * @return bool Whether the HTML is valid */ public static function checkErrors( $text, &$errorStr = null ) { $retval = 0; list( $outputStr, $errorStr ) = self::clean( $text, $retval ); return ( $retval < 0 && $errorStr == '' ) || $retval == 0; } /** * Perform a clean/repair operation * @param string $text HTML to check * @param int &$retval Exit code (-1 on internal error) * @return string|null */ private static function clean( $text, &$retval = null ) { global $wgTidyInternal; if ( $wgTidyInternal ) { return self::internalClean( $text, $retval ); } else { return self::externalClean( $text, $retval ); } } /** * Spawn an external HTML tidy process and get corrected markup back from it. * Also called in OutputHandler.php for full page validation * * @param string $text HTML to check * @param int &$retval Exit code (-1 on internal error) * @return string|null */ private static function externalClean( $text, &$retval = null ) { global $wgTidyConf, $wgTidyBin, $wgTidyOpts; wfProfileIn( __METHOD__ ); $opts = ' -utf8'; $descriptorspec = array( 0 => array( 'pipe', 'r' ), 1 => array( 'pipe', 'w' ), 2 => array( 'pipe', 'w' ), ); $outputBuffer = ''; $errorBuffer = ''; $pipes = array(); $process = proc_open( "$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes ); //NOTE: At least on linux, the process will be created even if tidy is not installed. // This means that missing tidy will be treated as a validation failure. if ( is_resource( $process ) ) { // Theoretically, this style of communication could cause a deadlock // here. If the stdout buffer fills up, then writes to stdin could // block. This doesn't appear to happen with tidy, because tidy only // writes to stdout after it's finished reading from stdin. Search // for tidyParseStdin and tidySaveStdout in console/tidy.c fwrite( $pipes[0], $text ); fclose( $pipes[0] ); while ( !feof( $pipes[1] ) ) { $outputBuffer .= fgets( $pipes[1], 1024 ); } fclose( $pipes[1] ); while ( !feof( $pipes[2] ) ) { $errorBuffer .= fgets( $pipes[2], 1024 ); } fclose( $pipes[2] ); $retval = proc_close( $process ); } else { wfWarn( "Unable to start external tidy process" ); $retval = -1; } wfProfileOut( __METHOD__ ); return array( $outputBuffer, $errorBuffer ); } /** * Use the HTML tidy extension to use the tidy library in-process, * saving the overhead of spawning a new process. * * @param string $text HTML to check * @param int &$retval Exit code (-1 on internal error) * @return string|null */ private static function internalClean( $text, &$retval = null ) { global $wgTidyConf, $wgDebugTidy; wfProfileIn( __METHOD__ ); if ( !class_exists( 'tidy' ) ) { wfWarn( "Unable to load internal tidy class." ); $retval = -1; wfProfileOut( __METHOD__ ); return null; } $outputBuffer = ''; $errorBuffer = ''; if ( wfIsHHVM() ) { // Use the tidy extension for HHVM from // https://github.com/wikimedia/mediawiki-php-tidy // // This currently does not support the object-oriented interface, but // tidy_repair_string() can be used for the most common tasks. $result = tidy_repair_string( $text, $wgTidyConf, 'utf8' ); $outputBuffer .= $result; $retval = $result === false ? -1 : 0; } else { $tidy = new tidy; $tidy->parseString( $text, $wgTidyConf, 'utf8' ); $tidy->cleanRepair(); $retval = $tidy->getStatus(); $outputBuffer .= tidy_get_output( $tidy ); if ( $retval > 0 ) { $errorBuffer .= $tidy->errorBuffer; } } if ( $wgDebugTidy && $errorBuffer && $retval > 0 ) { $outputBuffer .= "', '-->', $tidy->errorBuffer ) . "\n-->"; } wfProfileOut( __METHOD__ ); return array( $outputBuffer, $errorBuffer ); } }