WP_Http_Encoding::compatible_gzinflate

Advertisement

Summery Summery

Decompression of deflated string while staying compatible with the majority of servers.

Syntax Syntax

WP_Http_Encoding::compatible_gzinflate( string $gzData )

Description Description

Certain Servers will return deflated data with headers which PHP’s gzinflate() function cannot handle out of the box. The following function has been created from various snippets on the gzinflate() PHP documentation.

Warning: Magic numbers within. Due to the potential different formats that the compressed data may be returned in, some "magic offsets" are needed to ensure proper decompression takes place. For a simple progmatic way to determine the magic offset in use, see: https://core.trac.wordpress.org/ticket/18273

Parameters Parameters

$gzData

(Required) String to decompress.

Return Return

(string|bool) False on failure.

Source Source

File: wp-includes/class-wp-http-encoding.php

	 * @return string|bool False on failure.
	 */
	public static function compatible_gzinflate( $gzData ) {

		// Compressed data might contain a full header, if so strip it for gzinflate().
		if ( "\x1f\x8b\x08" === substr( $gzData, 0, 3 ) ) {
			$i   = 10;
			$flg = ord( substr( $gzData, 3, 1 ) );
			if ( $flg > 0 ) {
				if ( $flg & 4 ) {
					list($xlen) = unpack( 'v', substr( $gzData, $i, 2 ) );
					$i          = $i + 2 + $xlen;
				}
				if ( $flg & 8 ) {
					$i = strpos( $gzData, "\0", $i ) + 1;
				}
				if ( $flg & 16 ) {
					$i = strpos( $gzData, "\0", $i ) + 1;
				}
				if ( $flg & 2 ) {
					$i = $i + 2;
				}
			}
			$decompressed = @gzinflate( substr( $gzData, $i, -8 ) );
			if ( false !== $decompressed ) {
				return $decompressed;
			}
		}

		// Compressed data from java.util.zip.Deflater amongst others.
		$decompressed = @gzinflate( substr( $gzData, 2 ) );
		if ( false !== $decompressed ) {
			return $decompressed;
		}

Advertisement

Changelog Changelog

Changelog
Version Description
2.8.1 Introduced.

Advertisement

Leave a Reply