Deflate.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

Deflate.php
View Options

	<?php
	/**
	* @license GPL-2.0-or-later
	*/

	/**
	* Server-side helper for client-side compressed content.
	*
	* @since 1.32
	*/
	class Deflate {

	/**
	* Whether the content is deflated
	*
	* @param string $data
	*
	* @return bool
	*/
	public static function isDeflated( string $data ): bool {
	return str_starts_with( $data, 'rawdeflate,' );
	}

	/**
	* For content that has been compressed with deflate in the client,
	* try to uncompress it with inflate.
	*
	* If data is not prefixed with 'rawdeflate,' it will be returned unmodified.
	*
	* Data can be compressed in the client using the 'mediawiki.deflate' module:
	*
	* @code
	* return mw.loader.using( 'mediawiki.deflate' ).then( () => mw.deflateAsync( html ) );
	* @endcode
	*
	* @param string $data Deflated data
	* @return StatusValue<string> Inflated data will be set as the value
	* @throws InvalidArgumentException If the data wasn't deflated
	*/
	public static function inflate( string $data ): StatusValue {
	if ( !self::isDeflated( $data ) ) {
	throw new InvalidArgumentException( 'Data does not begin with deflated prefix' );
	}
	$deflated = base64_decode( substr( $data, 11 ), true );
	if ( $deflated === false ) {
	return StatusValue::newFatal( 'deflate-invaliddeflate' );
	}
	// phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
	$inflated = @gzinflate( $deflated );
	if ( $inflated === false ) {
	return StatusValue::newFatal( 'deflate-invaliddeflate' );
	}
	return StatusValue::newGood( $inflated );
	}
	}