Changeset 10410

Timestamp:

01/22/2009 09:16:11 PM (18 years ago)

Author:

westi

Message:

First pass compression support for the HTTP API. See #8674 props jacobsantos.

File:

• trunk/wp-includes/http.php (modified) (10 diffs)

trunk/wp-includes/http.php

@@ -12 +12 @@
  * @author Jacob Santos <wordpress@santosj.name>
  */
+
+/**
+ * Implementation for deflate and gzip transfer encodings.
+ *
+ * Includes RFC 1950, RFC 1951, and RFC 1952.
+ *
+ * @since unknown
+ * @package WordPress
+ * @subpackage HTTP
+ */
+class WP_Http_Encoding {
+
+        /**
+         * Compress raw string using the deflate format.
+         *
+         * Supports the RFC 1951 standard.
+         *
+         * @since unknown
+         *
+         * @param string $raw String to compress.
+         * @param int $level Optional, default is 9. Compression level, 9 is highest.
+         * @param string $supports Optional, not used. When implemented it will choose the right compression based on what the server supports.
+         * @return string|bool False on failure.
+         */
+        function compress( $raw, $level = 9, $supports = null ) {
+                return gzdeflate( $raw, $level );
+        }
+
+        /**
+         * Decompression of deflated string.
+         *
+         * Will attempt to decompress using the RFC 1950 standard, and if that fails
+         * then the RFC 1951 standard deflate will be attempted. Finally, the RFC
+         * 1952 standard gzip decode will be attempted. If all fail, then the
+         * original compressed string will be returned.
+         *
+         * @since unknown
+         *
+         * @param string $compressed String to decompress.
+         * @param int $length The optional length of the compressed data.
+         * @return string|bool False on failure.
+         */
+        function decompress( $compressed, $length = null ) {
+                $decompressed = gzinflate( $compressed );
+
+                if( false !== $decompressed )
+                        return $decompressed;
+
+                $decompressed = gzuncompress( $compressed );
+
+                if( false !== $decompressed )
+                        return $decompressed;
+
+                $decompressed = gzdecode( $compressed );
+
+                if( false !== $decompressed )
+                        return $decompressed;
+
+                return $compressed;
+        }
+
+        /**
+         * What encoding types to accept and their priority values.
+         *
+         * @since unknown
+         *
+         * @return string Types of encoding to accept.
+         */
+        function accept_encoding() {
+                $type = array();
+                if( function_exists( 'gzinflate' ) )
+                        $type[] = 'deflate;q=1.0';
+
+                if( function_exists( 'gzuncompress' ) )
+                        $type[] = 'compress;q=0.5';
+
+                if( function_exists( 'gzdecode' ) )
+                        $type[] = 'gzip;q=0.5';
+
+                return implode(', ', $type);
+        }
+
+        /**
+         * What enconding the content used when it was compressed to send in the headers.
+         *
+         * @since unknown
+         *
+         * @return string Content-Encoding string to send in the header.
+         */
+        function content_encoding() {
+                return 'deflate';
+        }
+
+        /**
+         * Whether the content be decoded based on the headers.
+         *
+         * @since unknown
+         *
+         * @param array|string $headers All of the available headers.
+         * @return bool
+         */
+        function should_decode($headers) {
+                if( is_array( $headers ) ) {
+                        if( array_key_exists('content-encoding', $headers) && ! empty( $headers['content-encoding'] ) )
+                                return true;
+                } else if( is_string( $headers ) ) {
+                        return ( stripos($headers, 'content-encoding:') !== false );
+                }
+
+                return false;
+        }
+
+        /**
+         * Whether decompression and compression are supported by the PHP version.
+         *
+         * Each function is tested instead of checking for the zlib extension, to
+         * ensure that the functions all exist in the PHP version and aren't
+         * disabled.
+         *
+         * @since unknown
+         *
+         * @return bool
+         */
+        function is_available() {
+                return ( function_exists('gzuncompress') || function_exists('gzdeflate') ||
+                                 function_exists('gzinflate') );
+        }
+}
 
 /**
@@ -233 +361 @@
                         'user-agent' => apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version ),
                         'blocking' => true,
-                        'headers' => array(), 'body' => null
+                        'headers' => array(),
+                        'body' => null,
+                        'compress' => false,
+                        'decompress' => true
                 );
 
@@ -256 +387 @@
                         unset($r['headers']['user-agent']);
                 }
+
+                if( WP_Http_Encoding::is_available() )
+                        $r['headers']['Accept-Encoding'] = WP_Http_Encoding::accept_encoding();
 
                 if ( is_null($r['body']) ) {
@@ -596 +730 @@
                         $process['body'] = WP_Http::chunkTransferDecode($process['body']);
 
+                if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($arrHeaders) )
+                        $process['body'] = WP_Http_Encoding::decompress( $process['body'] );
+
                 return array('headers' => $arrHeaders['headers'], 'body' => $process['body'], 'response' => $arrHeaders['response']);
         }
@@ -706 +843 @@
                         $strResponse = WP_Http::chunkTransferDecode($strResponse);
 
+                if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($processedHeaders) )
+                        $strResponse = WP_Http_Encoding::decompress( $strResponse );
+
                 return array('headers' => $processedHeaders['headers'], 'body' => $strResponse, 'response' => $processedHeaders['response']);
         }
@@ -818 +958 @@
                 $meta = stream_get_meta_data($handle);
 
+                fclose($handle);
+
                 $processedHeaders = array();
                 if( isset( $meta['wrapper_data']['headers'] ) )
@@ -827 +969 @@
                         $strResponse = WP_Http::chunkTransferDecode($strResponse);
 
-                fclose($handle);
+                if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($processedHeaders) )
+                        $strResponse = WP_Http_Encoding::decompress( $strResponse );
 
                 return array('headers' => $processedHeaders['headers'], 'body' => $strResponse, 'response' => $processedHeaders['response']);
@@ -940 +1083 @@
                                 $theBody = http_chunked_decode($theBody);
                 }
+
+                if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($theHeaders) )
+                        $theBody = http_inflate( $theBody );
 
                 $theResponse = array();
@@ -1075 +1221 @@
                         $theBody = '';
                 }
+
                 $response = array();
                 $response['code'] = curl_getinfo( $handle, CURLINFO_HTTP_CODE );
@@ -1081 +1228 @@
                 curl_close( $handle );
 
+                if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($theHeaders) )
+                        $theBody = WP_Http_Encoding::decompress( $theBody );
+
                 return array('headers' => $theHeaders['headers'], 'body' => $theBody, 'response' => $response);
         }