<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* HTTP API: WP_Http_Encoding class

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage HTTP

[5] Fix | Delete

* @since 4.4.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class used to implement deflate and gzip transfer encoding support for HTTP requests.

[10] Fix | Delete

*

[11] Fix | Delete

* Includes RFC 1950, RFC 1951, and RFC 1952.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 2.8.0

[14] Fix | Delete

*/

[15] Fix | Delete

#[AllowDynamicProperties]

[16] Fix | Delete

class WP_Http_Encoding {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Compress raw string using the deflate format.

[20] Fix | Delete

*

[21] Fix | Delete

* Supports the RFC 1951 standard.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 2.8.0

[24] Fix | Delete

*

[25] Fix | Delete

* @param string $raw String to compress.

[26] Fix | Delete

* @param int $level Optional. Compression level, 9 is highest. Default 9.

[27] Fix | Delete

* @param string $supports Optional, not used. When implemented it will choose

[28] Fix | Delete

* the right compression based on what the server supports.

[29] Fix | Delete

* @return string|false Compressed string on success, false on failure.

[30] Fix | Delete

*/

[31] Fix | Delete

public static function compress( $raw, $level = 9, $supports = null ) {

[32] Fix | Delete

return gzdeflate( $raw, $level );

[33] Fix | Delete

}

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Decompression of deflated string.

[37] Fix | Delete

*

[38] Fix | Delete

* Will attempt to decompress using the RFC 1950 standard, and if that fails

[39] Fix | Delete

* then the RFC 1951 standard deflate will be attempted. Finally, the RFC

[40] Fix | Delete

* 1952 standard gzip decode will be attempted. If all fail, then the

[41] Fix | Delete

* original compressed string will be returned.

[42] Fix | Delete

*

[43] Fix | Delete

* @since 2.8.0

[44] Fix | Delete

*

[45] Fix | Delete

* @param string $compressed String to decompress.

[46] Fix | Delete

* @param int $length The optional length of the compressed data.

[47] Fix | Delete

* @return string|false Decompressed string on success, false on failure.

[48] Fix | Delete

*/

[49] Fix | Delete

public static function decompress( $compressed, $length = null ) {

[50] Fix | Delete

[51] Fix | Delete

if ( empty( $compressed ) ) {

[52] Fix | Delete

return $compressed;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

$decompressed = @gzinflate( $compressed );

[56] Fix | Delete

if ( false !== $decompressed ) {

[57] Fix | Delete

return $decompressed;

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

$decompressed = self::compatible_gzinflate( $compressed );

[61] Fix | Delete

if ( false !== $decompressed ) {

[62] Fix | Delete

return $decompressed;

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

$decompressed = @gzuncompress( $compressed );

[66] Fix | Delete

if ( false !== $decompressed ) {

[67] Fix | Delete

return $decompressed;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

if ( function_exists( 'gzdecode' ) ) {

[71] Fix | Delete

$decompressed = @gzdecode( $compressed );

[72] Fix | Delete

[73] Fix | Delete

if ( false !== $decompressed ) {

[74] Fix | Delete

return $decompressed;

[75] Fix | Delete

}

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

return $compressed;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

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

[83] Fix | Delete

*

[84] Fix | Delete

* Certain Servers will return deflated data with headers which PHP's gzinflate()

[85] Fix | Delete

* function cannot handle out of the box. The following function has been created from

[86] Fix | Delete

* various snippets on the gzinflate() PHP documentation.

[87] Fix | Delete

*

[88] Fix | Delete

* Warning: Magic numbers within. Due to the potential different formats that the compressed

[89] Fix | Delete

* data may be returned in, some "magic offsets" are needed to ensure proper decompression

[90] Fix | Delete

* takes place. For a simple pragmatic way to determine the magic offset in use, see:

[91] Fix | Delete

* https://core.trac.wordpress.org/ticket/18273

[92] Fix | Delete

*

[93] Fix | Delete

* @since 2.8.1

[94] Fix | Delete

*

[95] Fix | Delete

* @link https://core.trac.wordpress.org/ticket/18273

[96] Fix | Delete

* @link https://www.php.net/manual/en/function.gzinflate.php#70875

[97] Fix | Delete

* @link https://www.php.net/manual/en/function.gzinflate.php#77336

[98] Fix | Delete

*

[99] Fix | Delete

* @param string $gz_data String to decompress.

[100] Fix | Delete

* @return string|false Decompressed string on success, false on failure.

[101] Fix | Delete

*/

[102] Fix | Delete

public static function compatible_gzinflate( $gz_data ) {

[103] Fix | Delete

[104] Fix | Delete

// Compressed data might contain a full header, if so strip it for gzinflate().

[105] Fix | Delete

if ( str_starts_with( $gz_data, "\x1f\x8b\x08" ) ) {

[106] Fix | Delete

$i = 10;

[107] Fix | Delete

$flg = ord( substr( $gz_data, 3, 1 ) );

[108] Fix | Delete

if ( $flg > 0 ) {

[109] Fix | Delete

if ( $flg & 4 ) {

[110] Fix | Delete

list($xlen) = unpack( 'v', substr( $gz_data, $i, 2 ) );

[111] Fix | Delete

$i = $i + 2 + $xlen;

[112] Fix | Delete

}

[113] Fix | Delete

if ( $flg & 8 ) {

[114] Fix | Delete

$i = strpos( $gz_data, "\0", $i ) + 1;

[115] Fix | Delete

}

[116] Fix | Delete

if ( $flg & 16 ) {

[117] Fix | Delete

$i = strpos( $gz_data, "\0", $i ) + 1;

[118] Fix | Delete

}

[119] Fix | Delete

if ( $flg & 2 ) {

[120] Fix | Delete

$i = $i + 2;

[121] Fix | Delete

}

[122] Fix | Delete

}

[123] Fix | Delete

$decompressed = @gzinflate( substr( $gz_data, $i, -8 ) );

[124] Fix | Delete

if ( false !== $decompressed ) {

[125] Fix | Delete

return $decompressed;

[126] Fix | Delete

}

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

// Compressed data from java.util.zip.Deflater amongst others.

[130] Fix | Delete

$decompressed = @gzinflate( substr( $gz_data, 2 ) );

[131] Fix | Delete

if ( false !== $decompressed ) {

[132] Fix | Delete

return $decompressed;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

return false;

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

/**

[139] Fix | Delete

* What encoding types to accept and their priority values.

[140] Fix | Delete

*

[141] Fix | Delete

* @since 2.8.0

[142] Fix | Delete

*

[143] Fix | Delete

* @param string $url

[144] Fix | Delete

* @param array $args

[145] Fix | Delete

* @return string Types of encoding to accept.

[146] Fix | Delete

*/

[147] Fix | Delete

public static function accept_encoding( $url, $args ) {

[148] Fix | Delete

$type = array();

[149] Fix | Delete

$compression_enabled = self::is_available();

[150] Fix | Delete

[151] Fix | Delete

if ( ! $args['decompress'] ) { // Decompression specifically disabled.

[152] Fix | Delete

$compression_enabled = false;

[153] Fix | Delete

} elseif ( $args['stream'] ) { // Disable when streaming to file.

[154] Fix | Delete

$compression_enabled = false;

[155] Fix | Delete

} elseif ( isset( $args['limit_response_size'] ) ) { // If only partial content is being requested, we won't be able to decompress it.

[156] Fix | Delete

$compression_enabled = false;

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

if ( $compression_enabled ) {

[160] Fix | Delete

if ( function_exists( 'gzinflate' ) ) {

[161] Fix | Delete

$type[] = 'deflate;q=1.0';

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

if ( function_exists( 'gzuncompress' ) ) {

[165] Fix | Delete

$type[] = 'compress;q=0.5';

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

if ( function_exists( 'gzdecode' ) ) {

[169] Fix | Delete

$type[] = 'gzip;q=0.5';

[170] Fix | Delete

}

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Filters the allowed encoding types.

[175] Fix | Delete

*

[176] Fix | Delete

* @since 3.6.0

[177] Fix | Delete

*

[178] Fix | Delete

* @param string[] $type Array of what encoding types to accept and their priority values.

[179] Fix | Delete

* @param string $url URL of the HTTP request.

[180] Fix | Delete

* @param array $args HTTP request arguments.

[181] Fix | Delete

*/

[182] Fix | Delete

$type = apply_filters( 'wp_http_accept_encoding', $type, $url, $args );

[183] Fix | Delete

[184] Fix | Delete

return implode( ', ', $type );

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* What encoding the content used when it was compressed to send in the headers.

[189] Fix | Delete

*

[190] Fix | Delete

* @since 2.8.0

[191] Fix | Delete

*

[192] Fix | Delete

* @return string Content-Encoding string to send in the header.

[193] Fix | Delete

*/

[194] Fix | Delete

public static function content_encoding() {

[195] Fix | Delete

return 'deflate';

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* Whether the content be decoded based on the headers.

[200] Fix | Delete

*

[201] Fix | Delete

* @since 2.8.0

[202] Fix | Delete

*

[203] Fix | Delete

* @param array|string $headers All of the available headers.

[204] Fix | Delete

* @return bool

[205] Fix | Delete

*/

[206] Fix | Delete

public static function should_decode( $headers ) {

[207] Fix | Delete

if ( is_array( $headers ) ) {

[208] Fix | Delete

if ( array_key_exists( 'content-encoding', $headers ) && ! empty( $headers['content-encoding'] ) ) {

[209] Fix | Delete

return true;

[210] Fix | Delete

}

[211] Fix | Delete

} elseif ( is_string( $headers ) ) {

[212] Fix | Delete

return ( stripos( $headers, 'content-encoding:' ) !== false );

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

return false;

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Whether decompression and compression are supported by the PHP version.

[220] Fix | Delete

*

[221] Fix | Delete

* Each function is tested instead of checking for the zlib extension, to

[222] Fix | Delete

* ensure that the functions all exist in the PHP version and aren't

[223] Fix | Delete

* disabled.

[224] Fix | Delete

*

[225] Fix | Delete

* @since 2.8.0

[226] Fix | Delete

*

[227] Fix | Delete

* @return bool

[228] Fix | Delete

*/

[229] Fix | Delete

public static function is_available() {

[230] Fix | Delete

return ( function_exists( 'gzuncompress' ) || function_exists( 'gzdeflate' ) || function_exists( 'gzinflate' ) );

[231] Fix | Delete

}

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete