Merge "[JobQueue] Added support for approximate FIFO job queues."
[lhc/web/wiklou.git] / includes / OutputHandler.php
index 3d123c3..78435e4 100644 (file)
@@ -1,12 +1,36 @@
 <?php
+/**
+ * Functions to be used with PHP's output buffer.
+ *
+ * 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
+ */
 
 /**
  * Standard output handler for use with ob_start
+ *
+ * @param $s string
+ *
+ * @return string
  */
 function wfOutputHandler( $s ) {
        global $wgDisableOutputCompression, $wgValidateAllHtml;
-    $s = wfMangleFlashPolicy( $s );
-    if ( $wgValidateAllHtml ) {
+       $s = wfMangleFlashPolicy( $s );
+       if ( $wgValidateAllHtml ) {
                $headers = apache_response_headers();
                $isHTML = true;
                foreach ( $headers as $name => $value ) {
@@ -35,9 +59,11 @@ function wfOutputHandler( $s ) {
  * the currently-requested URL.
  * This isn't on WebRequest because we need it when things aren't initialized
  * @private
+ *
+ * @return string
  */
 function wfRequestExtension() {
-       /// @fixme -- this sort of dupes some code in WebRequest::getRequestUrl()
+       /// @todo FIXME: this sort of dupes some code in WebRequest::getRequestUrl()
        if( isset( $_SERVER['REQUEST_URI'] ) ) {
                // Strip the query string...
                list( $path ) = explode( '?', $_SERVER['REQUEST_URI'], 2 );
@@ -59,9 +85,18 @@ function wfRequestExtension() {
 /**
  * Handler that compresses data with gzip if allowed by the Accept header.
  * Unlike ob_gzhandler, it works for HEAD requests too.
+ *
+ * @param $s string
+ *
+ * @return string
  */
 function wfGzipHandler( $s ) {
-       if( !function_exists( 'gzencode' ) || headers_sent() ) {
+       if( !function_exists( 'gzencode' ) ) {
+               wfDebug( __FUNCTION__ . "() skipping compression (gzencode unavaible)\n" );
+               return $s;
+       }
+       if( headers_sent() ) {
+               wfDebug( __FUNCTION__ . "() skipping compression (headers already sent)\n" );
                return $s;
        }
 
@@ -74,12 +109,10 @@ function wfGzipHandler( $s ) {
                return $s;
        }
 
-       if( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
-               $tokens = preg_split( '/[,; ]/', $_SERVER['HTTP_ACCEPT_ENCODING'] );
-               if ( in_array( 'gzip', $tokens ) ) {
-                       header( 'Content-Encoding: gzip' );
-                       $s = gzencode( $s, 3 );
-               }
+       if( wfClientAcceptsGzip() ) {
+               wfDebug( __FUNCTION__ . "() is compressing output\n" );
+               header( 'Content-Encoding: gzip' );
+               $s = gzencode( $s, 6 );
        }
 
        // Set vary header if it hasn't been set already
@@ -93,13 +126,20 @@ function wfGzipHandler( $s ) {
        }
        if ( !$foundVary ) {
                header( 'Vary: Accept-Encoding' );
-               header( 'X-Vary-Options: Accept-Encoding;list-contains=gzip' );
+               global $wgUseXVO;
+               if ( $wgUseXVO ) {
+                       header( 'X-Vary-Options: Accept-Encoding;list-contains=gzip' );
+               }
        }
        return $s;
 }
 
 /**
  * Mangle flash policy tags which open up the site to XSS attacks.
+ *
+ * @param $s string
+ *
+ * @return string
  */
 function wfMangleFlashPolicy( $s ) {
        # Avoid weird excessive memory usage in PCRE on big articles
@@ -112,6 +152,8 @@ function wfMangleFlashPolicy( $s ) {
 
 /**
  * Add a Content-Length header if possible. This makes it cooperate with squid better.
+ *
+ * @param $length int
  */
 function wfDoContentLength( $length ) {
        if ( !headers_sent() && $_SERVER['SERVER_PROTOCOL'] == 'HTTP/1.0' ) {
@@ -121,57 +163,23 @@ function wfDoContentLength( $length ) {
 
 /**
  * Replace the output with an error if the HTML is not valid
+ *
+ * @param $s string
+ *
+ * @return string
  */
 function wfHtmlValidationHandler( $s ) {
-       global $IP, $wgTidyInternal, $wgTidyConf;
-       if ( $wgTidyInternal ) {
-               $tidy = new tidy;
-       
-               $tidy->parseString( $s, $wgTidyConf, 'utf8' );
-               if ( $tidy->getStatus() == 0 ) {
-                       return $s;
-               }
 
-               $errors = $tidy->errorBuffer;
-       } else {
-               // Copied from Parser::externalTidy();
-               global $wgTidyBin, $wgTidyOpts;
-
-               $cleansource = '';
-               $opts = ' -utf8';
-
-               $descriptorspec = array(
-                       0 => array( 'pipe', 'r' ),
-                       1 => array( 'file', wfGetNull(), 'a' ),
-                       2 => array( 'pipe', 'w' )
-               );
-               $pipes = array();
-               if( function_exists( 'proc_open' ) ) {
-                       $process = proc_open("$wgTidyBin -config $wgTidyConf $wgTidyOpts$opts", $descriptorspec, $pipes );
-                       if ( is_resource( $process ) ) {
-                               fwrite( $pipes[0], $s );
-                               fclose( $pipes[0] );
-                               while( !feof( $pipes[2] ) ) {
-                                       $errors .= fgets( $pipes[2], 1024 );
-                               }
-                               fclose( $pipes[2] );
-                               $ret = proc_close( $process );
-                               if( ( $ret < 0 && $errors == '' ) || $ret == 0 )
-                                       return $s;
-                       } else {
-                               return $s;
-                       }
-                       
-               } else {
-                       return $s;
-               }
+       $errors = '';
+       if ( MWTidy::checkErrors( $s, $errors ) ) {
+               return $s;
        }
 
        header( 'Cache-Control: no-cache' );
 
        $out = <<<EOT
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" dir="ltr">
 <head>
 <title>HTML validation error</title>
 <style>
@@ -197,7 +205,7 @@ EOT;
 
        $out .= '</ul>';
        $out .= '<pre>' . htmlspecialchars( $errors ) . '</pre>';
-       $out .= '<ol>';
+       $out .= "<ol>\n";
        $line = strtok( $s, "\n" );
        $i = 1;
        while ( $line !== false ) {
@@ -206,7 +214,7 @@ EOT;
                } else {
                        $out .= '<li>';
                }
-               $out .= htmlspecialchars( $line ) . '</li>';
+               $out .= htmlspecialchars( $line ) . "</li>\n";
                $line = strtok( "\n" );
                $i++;
        }