WP_Http_Encoding::compatible_gzinflate │ public static │ WP 2.8.1

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

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 pragmatic way to determine the magic offset in use, see: https://core.trac.wordpress.org/ticket/18273

Method of the class: WP_Http_Encoding{}

No Hooks.

Returns

String|false. Decompressed string on success, false on failure.

Usage

$result = WP_Http_Encoding::compatible_gzinflate( $gz_data );

$gz_data(string) (required)

String to decompress.

Changelog

WP_Http_Encoding::compatible_gzinflate() WP Http Encoding::compatible gzinflate code ^{WP 7.0}

public static function compatible_gzinflate( $gz_data ) {

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

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

	return false;
}