use ext-brotli if available

Author: codemasher

src/message_helpers.php

@@ -8,12 +8,12 @@
 
 namespace chillerlan\HTTP\Utils;
 
-use TypeError;
+use RuntimeException, TypeError;
 use Psr\Http\Message\{MessageInterface, RequestInterface, ResponseInterface, UriInterface};
 
-use function array_filter, array_map, explode, gzdecode, gzinflate, gzuncompress, implode,
+use function array_filter, array_map, explode, extension_loaded, function_exists, gzdecode, gzinflate, gzuncompress, implode,
 	is_array, is_scalar, json_decode, json_encode, parse_url, preg_match, preg_replace_callback, rawurldecode,
-	rawurlencode, simplexml_load_string, trim, urlencode;
+	rawurlencode, simplexml_load_string, strtolower, trim, urlencode;
 
 const CHILLERLAN_PSR7_UTIL_INCLUDES = true;
 
@@ -210,19 +210,32 @@ function message_to_string(MessageInterface $message):string{
  * @param \Psr\Http\Message\MessageInterface $message
  *
  * @return string
+ * @throws \RuntimeException
  */
 function decompress_content(MessageInterface $message):string{
-	$data = $message->getBody()->__toString();
+	$data     = (string)$message->getBody();
+	$encoding = strtolower($message->getHeaderLine('content-encoding'));
 	$message->getBody()->rewind();
 
-	switch($message->getHeaderLine('content-encoding')){
-#		case 'br'      : return brotli_uncompress($data); // @todo: https://github.com/kjdev/php-ext-brotli
-		case 'compress': return gzuncompress($data);
-		case 'deflate' : return gzinflate($data);
-		case 'gzip'    : return gzdecode($data);
-		default: return $data;
+	if($encoding === 'br'){
+		// https://github.com/kjdev/php-ext-brotli
+		if(extension_loaded('brotli') && function_exists('brotli_uncompress')){
+			return brotli_uncompress($data); // @codeCoverageIgnore
+		}
+
+		throw new RuntimeException('cannot decompress brotli compressed message body');
+	}
+	elseif($encoding === 'compress'){
+		return gzuncompress($data);
+	}
+	elseif($encoding === 'deflate'){
+		return gzinflate($data);
+	}
+	elseif($encoding === 'gzip' || $encoding === 'x-gzip'){
+		return gzdecode($data);
 	}
 
+	return $data;
 }
 
 const URI_DEFAULT_PORTS = [

tests/MessageHelpersTest.php

@@ -10,14 +10,15 @@
 
 namespace chillerlan\HTTPTest\Utils;
 
-use TypeError;
+use RuntimeException, TypeError;
 
 use function chillerlan\HTTP\Utils\{
 	decompress_content, get_json, get_xml, message_to_string, parseUrl, r_rawurlencode,
 	uriIsAbsolute, uriIsAbsolutePathReference, uriIsDefaultPort, uriIsNetworkPathReference,
 	uriIsRelativePathReference, uriWithoutQueryValue, uriWithQueryValue
 };
 
+use function extension_loaded, function_exists;
 use const chillerlan\HTTP\Utils\URI_DEFAULT_PORTS;
 
 class MessageHelpersTest extends TestAbstract{
@@ -106,6 +107,7 @@ public function testMessageToString():void{
 
 	public function decompressDataProvider():array{
 		return [
+			'br'       => ['brotli_compress', 'br'],
 			'compress' => ['gzcompress', 'compress'],
 			'deflate'  => ['gzdeflate', 'deflate'],
 			'gzip'     => ['gzencode', 'gzip'],
@@ -117,7 +119,14 @@ public function decompressDataProvider():array{
 	 * @dataProvider decompressDataProvider
 	 */
 	public function testDecompressContent(string $fn, string $encoding):void{
-		$data = $expected = str_repeat('compressed string ', 100);
+
+		// https://github.com/kjdev/php-ext-brotli
+		if($encoding === 'br' && (!extension_loaded('brotli') || !function_exists('brotli_compress'))){
+			$this::markTestSkipped('N/A (ext-brotli not isntalled)');
+		}
+
+		$data     = str_repeat('compressed string ', 100);
+		$expected = $data;
 		$response = $this->responseFactory->createResponse();
 
 		if($fn){
@@ -130,6 +139,22 @@ public function testDecompressContent(string $fn, string $encoding):void{
 		$this::assertSame($expected, decompress_content($response));
 	}
 
+	public function testDecompressContentUnableToDecompressBrotliException():void{
+
+		if(extension_loaded('brotli') && function_exists('brotli_uncompress')){
+			$this::markTestSkipped('N/A (ext-brotli isntalled)');
+		}
+
+		$this->expectException(RuntimeException::class);
+		$this->expectExceptionMessage('cannot decompress brotli compressed message body');
+
+		$response = $this->responseFactory
+			->createResponse()
+			->withHeader('Content-Encoding', 'br');
+
+		decompress_content($response);
+	}
+
 	public function testUriIsAbsolute():void{
 		$this::assertTrue(uriIsAbsolute($this->uriFactory->createUri('http://example.org')));
 		$this::assertFalse(uriIsAbsolute($this->uriFactory->createUri('//example.org')));