Merge "Replace deprecated wfMsg* calls with Message class calls."
[lhc/web/wiklou.git] / includes / parser / Tidy.php
index a745eac..ed2d436 100644 (file)
@@ -2,7 +2,23 @@
 /**
  * HTML validation and correction
  *
+ * This program 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.
+ *
+ * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
+ * @ingroup Parser
  */
 
 /**
  * we may create a real postprocessor or something that will replace this.
  * It's called wrapper because for now it basically takes over MWTidy::tidy's task
  * of wrapping the text in a xhtml block
- * 
+ *
  * This re-uses some of the parser's UNIQ tricks, though some of it is private so it's
  * duplicated. Perhaps we should create an abstract marker hiding class.
+ *
+ * @ingroup Parser
  */
 class MWTidyWrapper {
 
-       protected $mTokens, $mUniqPrefix;
+       /**
+        * @var ReplacementArray
+        */
+       protected $mTokens;
+
+       protected $mUniqPrefix;
+
+       protected $mMarkerIndex;
 
        public function __construct() {
                $this->mTokens = null;
                $this->mUniqPrefix = null;
        }
 
+       /**
+        * @param $text string
+        * @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;
+
                $wrappedtext = preg_replace_callback( ParserOutput::EDITSECTION_REGEX,
                        array( &$this, 'replaceEditSectionLinksCallback' ), $text );
 
@@ -40,7 +70,9 @@ class MWTidyWrapper {
        }
 
        /**
-        * @private
+        * @param $m array
+        *
+        * @return string
         */
        function replaceEditSectionLinksCallback( $m ) {
                $marker = "{$this->mUniqPrefix}-item-{$this->mMarkerIndex}" . Parser::MARKER_SUFFIX;
@@ -49,6 +81,10 @@ class MWTidyWrapper {
                return $marker;
        }
 
+       /**
+        * @param $text string
+        * @return string
+        */
        public function postprocess( $text ) {
                return $this->mTokens->replace( $text );
        }
@@ -65,7 +101,6 @@ class MWTidyWrapper {
  * @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
@@ -80,12 +115,17 @@ class MWTidy {
                $wrapper = new MWTidyWrapper;
                $wrappedtext = $wrapper->getWrapped( $text );
 
-               if( $wgTidyInternal ) {
-                       $correctedtext = self::execInternalTidy( $wrappedtext );
+               $retVal = null;
+               if ( $wgTidyInternal ) {
+                       $correctedtext = self::execInternalTidy( $wrappedtext, false, $retVal );
                } else {
-                       $correctedtext = self::execExternalTidy( $wrappedtext );
+                       $correctedtext = self::execExternalTidy( $wrappedtext, false, $retVal );
                }
-               if( is_null( $correctedtext ) ) {
+
+               if ( $retVal < 0 ) {
+                       wfDebug( "Possible tidy configuration error!\n" );
+                       return $text . "\n<!-- Tidy was unable to run -->\n";
+               } elseif ( is_null( $correctedtext ) ) {
                        wfDebug( "Tidy error detected!\n" );
                        return $text . "\n<!-- Tidy found serious XHTML errors -->\n";
                }
@@ -94,10 +134,6 @@ class MWTidy {
 
                return $correctedtext;
        }
-       
-       function replaceEditSectionLinksCallback( $m ) {
-               
-       }
 
        /**
         * Check HTML for errors, used if $wgValidateAllHtml = true.
@@ -108,13 +144,14 @@ class MWTidy {
         */
        public static function checkErrors( $text, &$errorStr = null ) {
                global $wgTidyInternal;
-               
+
                $retval = 0;
                if( $wgTidyInternal ) {
                        $errorStr = self::execInternalTidy( $text, true, $retval );
                } else {
                        $errorStr = self::execExternalTidy( $text, true, $retval );
                }
+
                return ( $retval < 0 && $errorStr == '' ) || $retval == 0;
        }
 
@@ -123,8 +160,8 @@ class MWTidy {
         * Also called in OutputHandler.php for full page validation
         *
         * @param $text String: HTML to check
-        * @param $stderr Boolean: Whether to read from STDERR rather than STDOUT
-        * @param &$retval Exit code (-1 on internal error)
+        * @param $stderr Boolean: Whether to read result from STDERR rather than STDOUT
+        * @param &$retval int Exit code (-1 on internal error)
         * @return mixed String or null
         */
        private static function execExternalTidy( $text, $stderr = false, &$retval = null ) {
@@ -134,7 +171,7 @@ class MWTidy {
                $cleansource = '';
                $opts = ' -utf8';
 
-               if( $stderr ) {
+               if ( $stderr ) {
                        $descriptorspec = array(
                                0 => array( 'pipe', 'r' ),
                                1 => array( 'file', wfGetNull(), 'a' ),
@@ -147,77 +184,88 @@ class MWTidy {
                                2 => array( 'file', wfGetNull(), 'a' )
                        );
                }
-               
+
                $readpipe = $stderr ? 2 : 1;
                $pipes = array();
 
-               if( function_exists( 'proc_open' ) ) {
-                       $process = proc_open( "$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes );
-                       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[$readpipe] ) ) {
-                                       $cleansource .= fgets( $pipes[$readpipe], 1024 );
-                               }
-                               fclose( $pipes[$readpipe] );
-                               $retval = proc_close( $process );
-                       } else {
-                               $retval = -1;
+               $process = proc_open(
+                       "$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes );
+
+               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[$readpipe] ) ) {
+                               $cleansource .= fgets( $pipes[$readpipe], 1024 );
                        }
+                       fclose( $pipes[$readpipe] );
+                       $retval = proc_close( $process );
                } else {
-                       $retval = -1;   
+                       wfWarn( "Unable to start external tidy process" );
+                       $retval = -1;
                }
 
-               if( !$stderr && $cleansource == '' && $text != '' ) {
+               if ( !$stderr && $cleansource == '' && $text != '' ) {
                        // Some kind of error happened, so we couldn't get the corrected text.
                        // Just give up; we'll use the source text and append a warning.
                        $cleansource = null;
                }
+
                wfProfileOut( __METHOD__ );
                return $cleansource;
        }
 
        /**
-        * Use the HTML tidy PECL extension to use the tidy library in-process,
+        * Use the HTML tidy extension to use the tidy library in-process,
         * saving the overhead of spawning a new process.
         *
-        * 'pear install tidy' should be able to compile the extension module.
+        * @param $text String: HTML to check
+        * @param $stderr Boolean: Whether to read result from error status instead of output
+        * @param &$retval int Exit code (-1 on internal error)
+        * @return mixed String or null
         */
        private static function execInternalTidy( $text, $stderr = false, &$retval = null ) {
                global $wgTidyConf, $wgDebugTidy;
                wfProfileIn( __METHOD__ );
 
+               if ( !MWInit::classExists( 'tidy' ) ) {
+                       wfWarn( "Unable to load internal tidy class." );
+                       $retval = -1;
+
+                       wfProfileOut( __METHOD__ );
+                       return null;
+               }
+
                $tidy = new tidy;
                $tidy->parseString( $text, $wgTidyConf, 'utf8' );
 
-               if( $stderr ) {
+               if ( $stderr ) {
                        $retval = $tidy->getStatus();
+
                        wfProfileOut( __METHOD__ );
                        return $tidy->errorBuffer;
                } else {
                        $tidy->cleanRepair();
                        $retval = $tidy->getStatus();
-                       if( $retval == 2 ) {
+                       if ( $retval == 2 ) {
                                // 2 is magic number for fatal error
                                // http://www.php.net/manual/en/function.tidy-get-status.php
                                $cleansource = null;
                        } else {
                                $cleansource = tidy_get_output( $tidy );
+                               if ( $wgDebugTidy && $retval > 0 ) {
+                                       $cleansource .= "<!--\nTidy reports:\n" .
+                                               str_replace( '-->', '--&gt;', $tidy->errorBuffer ) .
+                                               "\n-->";
+                               }
                        }
-                       if ( $wgDebugTidy && $retval > 0 ) {
-                               $cleansource .= "<!--\nTidy reports:\n" .
-                                       str_replace( '-->', '--&gt;', $tidy->errorBuffer ) .
-                                       "\n-->";
-                       }
-       
+
                        wfProfileOut( __METHOD__ );
                        return $cleansource;
                }
        }
-
 }