1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
use Wikimedia\AtEase\AtEase;
/**
* 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 substr( $data, 0, 11 ) === '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
* mw.loader.using( 'mediawiki.deflate' ).then( function () {
* var deflated = mw.deflate( myContent );
* } );
* @endcode
*
* @param string $data Deflated data
* @return StatusValue 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' );
}
AtEase::suppressWarnings();
$inflated = gzinflate( $deflated );
AtEase::restoreWarnings();
if ( $inflated === false ) {
return StatusValue::newFatal( 'deflate-invaliddeflate' );
}
return StatusValue::newGood( $inflated );
}
}
/** @deprecated class alias since 1.35 */
class_alias( Deflate::class, 'EasyDeflate' );
|
