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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<?php
/**
* Default StringMangler implementation.
* @file
* @author Niklas Laxström
* @license GPL-2.0-or-later
*/
/**
* The versatile default implementation of StringMangler interface.
* It supports exact matches and patterns with any-wildcard (*).
* All matching strings are prefixed with the same prefix.
*/
class StringMatcher implements StringMangler, MetaYamlSchemaExtender {
/** @var string Prefix for mangled message keys */
protected $sPrefix = '';
/** @var string[] Exact message keys */
protected $aExact = [];
/** @var string[] Patterns of type foo* */
protected $aPrefix = [];
/** @var string[] Patterns that contain wildcard anywhere else than in the end */
protected $aRegex = [];
/**
* Alias for making NO-OP string mangler.
*
* @return StringMatcher
*/
public static function EmptyMatcher() {
return new StringMatcher();
}
/**
* Constructor, see EmptyMatcher();
*
* @param string $prefix
* @param array $patterns
*/
public function __construct( $prefix = '', array $patterns = [] ) {
$this->sPrefix = $prefix;
$this->init( $patterns );
}
protected static function getValidKeyChars() {
static $valid = null;
if ( $valid === null ) {
global $wgLegalTitleChars;
$valid = strtr( $wgLegalTitleChars, [
'=' => '', // equals sign, which is itself usef for escaping
'&' => '', // ampersand, for entities
'%' => '', // percent sign, which is used in URL encoding
] );
}
return $valid;
}
public function setConf( $conf ) {
$this->sPrefix = $conf['prefix'];
$this->init( $conf['patterns'] );
}
/**
* Preprocesses the patterns.
* They are split into exact keys, prefix matches and pattern matches to
* speed up matching process.
* @param string[] $strings Key patterns.
*/
protected function init( array $strings ) {
foreach ( $strings as $string ) {
$pos = strpos( $string, '*' );
if ( $pos === false ) {
$this->aExact[] = $string;
} elseif ( $pos + 1 === strlen( $string ) ) {
$prefix = substr( $string, 0, -1 );
$this->aPrefix[$prefix] = strlen( $prefix );
} else {
$string = str_replace( '\\*', '.+', preg_quote( $string, '/' ) );
$this->aRegex[] = "/^$string$/";
}
}
}
/**
* @param string $string
* @return bool
*/
public function match( $string ) {
if ( in_array( $string, $this->aExact ) ) {
return true;
}
foreach ( $this->aPrefix as $prefix => $len ) {
if ( strncmp( $string, $prefix, $len ) === 0 ) {
return true;
}
}
foreach ( $this->aRegex as $regex ) {
if ( preg_match( $regex, $string ) ) {
return true;
}
}
return false;
}
/**
* Mangles the input. Input can either be a plain string, a list of strings
* or an associative array. In the last case the keys of the array are
* mangled.
*
* @param string|string[]|array $data
* @return string|string[]|array
* @throws MWException
*/
public function mangle( $data ) {
if ( is_array( $data ) ) {
return $this->mangleArray( $data );
} elseif ( is_string( $data ) ) {
return $this->mangleString( $data );
} elseif ( $data === null ) {
return $data;
} else {
throw new MWException( __METHOD__ . ': Unsupported datatype' );
}
}
public function unmangle( $data ) {
if ( is_array( $data ) ) {
return $this->mangleArray( $data, true );
} elseif ( is_string( $data ) ) {
return $this->mangleString( $data, true );
} elseif ( $data === null ) {
return $data;
} else {
throw new MWException( __METHOD__ . ': Unsupported datatype' );
}
}
/**
* Mangles or unmangles single string.
* @param string $string Message key.
* @param bool $reverse Direction of mangling or unmangling.
* @return string
*/
protected function mangleString( $string, $reverse = false ) {
if ( $reverse ) {
return $this->unMangleString( $string );
}
if ( $this->match( $string ) ) {
$string = $this->sPrefix . $string;
}
$escaper = function ( $match ) {
$esc = '';
foreach ( str_split( $match[ 0 ] ) as $c ) {
$esc .= '=' . sprintf( '%02X', ord( $c ) );
}
return $esc;
};
// Apply a "quoted-printable"-like escaping
$valid = self::getValidKeyChars();
$string = preg_replace_callback( "/[^$valid]/", $escaper, $string );
// Additional limitations in MediaWiki, see MediaWikiTitleCodec::splitTitleString
$string = preg_replace_callback( '/(~~~|^[ _]|[ _]$|[ _]{2,}|^:)/', $escaper, $string );
// TODO: length check + truncation
// TODO: forbid path travels
return $string;
}
/**
* Unmangles the message key by removing the prefix it it exists.
* @param string $string Message key.
* @return string Unmangled message key.
*/
protected function unMangleString( $string ) {
// Unescape the "quoted-printable"-like escaping,
// which is applied in mangleString.
$unescapedString = preg_replace_callback( '/=([A-F0-9]{2})/',
function ( $match ) {
return chr( hexdec( $match[0] ) );
},
$string
);
if ( strncmp( $unescapedString, $this->sPrefix, strlen( $this->sPrefix ) ) === 0 ) {
return substr( $unescapedString, strlen( $this->sPrefix ) );
} else {
return $unescapedString;
}
}
/**
* Mangles or unmangles list of strings. If an associative array is given,
* the keys of the array will be mangled. For lists the values are mangled.
*
* @param string[]|array $array Strings.
* @param bool $reverse Direction of mangling or unmangling.
* @return string[]|array (Un)mangled strings.
*/
protected function mangleArray( array $array, $reverse = false ) {
$temp = [];
if ( !$this->isAssoc( $array ) ) {
foreach ( $array as $key => &$value ) {
$value = $this->mangleString( $value, $reverse );
$temp[$key] = $value; // Assign a reference
}
} else {
foreach ( $array as $key => &$value ) {
$key = $this->mangleString( $key, $reverse );
$temp[$key] = $value; // Assign a reference
}
}
return $temp;
}
protected function isAssoc( array $array ) {
$assoc = (bool)count( array_filter( array_keys( $array ), 'is_string' ) );
if ( $assoc ) {
return true;
}
// Also check that the indexing starts from zero
return !array_key_exists( 0, $array );
}
public static function getExtraSchema() {
$schema = [
'root' => [
'_type' => 'array',
'_children' => [
'MANGLER' => [
'_type' => 'array',
'_children' => [
'prefix' => [
'_type' => 'text',
'_not_empty' => true
],
'patterns' => [
'_type' => 'array',
'_required' => true,
'_ignore_extra_keys' => true,
'_children' => [],
],
]
]
]
]
];
return $schema;
}
}
|