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
|
<?php
/**
* @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 = [];
/**
* @param string $prefix
* @param array $patterns
*/
public function __construct( string $prefix = '', array $patterns = [] ) {
$this->sPrefix = $prefix;
$this->init( $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 ): void {
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$/";
}
}
}
protected static function getValidKeyChars(): string {
static $valid = null;
if ( $valid === null ) {
global $wgLegalTitleChars;
$valid = strtr(
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable
$wgLegalTitleChars,
[
'=' => '', // equals sign, which is itself usef for escaping
'&' => '', // ampersand, for entities
'%' => '', // percent sign, which is used in URL encoding
]
);
}
return $valid;
}
/** @inheritDoc */
public function setConf( array $conf ): void {
$this->sPrefix = $conf['prefix'];
$this->init( $conf['patterns'] );
}
/** @inheritDoc */
public function matches( string $key ): bool {
if ( in_array( $key, $this->aExact ) ) {
return true;
}
foreach ( $this->aPrefix as $prefix => $len ) {
if ( strncmp( $key, $prefix, $len ) === 0 ) {
return true;
}
}
foreach ( $this->aRegex as $regex ) {
if ( preg_match( $regex, $key ) ) {
return true;
}
}
return false;
}
/** @inheritDoc */
public function mangle( string $key ): string {
if ( $this->matches( $key ) ) {
$key = $this->sPrefix . $key;
}
$escaper = static 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();
$key = preg_replace_callback( "/[^$valid]/", $escaper, $key );
// Additional limitations in MediaWiki, see MediaWikiTitleCodec::splitTitleString
$key = preg_replace_callback( '/(~~~|^[ _]|[ _]$|[ _]{2,}|^:)/', $escaper, $key );
// TODO: length check + truncation
// TODO: forbid path travels
return $key;
}
/** @inheritDoc */
public function mangleList( array $list ): array {
foreach ( $list as $index => $key ) {
$list[$index] = $this->mangle( $key );
}
return $list;
}
/** @inheritDoc */
public function mangleArray( array $array ): array {
$out = [];
foreach ( $array as $key => $value ) {
$out[$this->mangle( $key )] = $value;
}
return $out;
}
/** @inheritDoc */
public function unmangle( string $key ): string {
// Unescape the "quoted-printable"-like escaping,
// which is applied in mangle
$unescapedString = preg_replace_callback(
'/=([A-F0-9]{2})/',
static function ( $match ) {
return chr( hexdec( $match[1] ) );
},
$key
);
if ( strncmp( $unescapedString, $this->sPrefix, strlen( $this->sPrefix ) ) === 0 ) {
$unmangled = substr( $unescapedString, strlen( $this->sPrefix ) );
// Check if this string should be mangled / un-mangled to begin with
if ( $this->matches( $unmangled ) ) {
return $unmangled;
}
}
return $unescapedString;
}
/** @inheritDoc */
public function unmangleList( array $list ): array {
foreach ( $list as $index => $key ) {
$list[$index] = $this->unmangle( $key );
}
return $list;
}
/** @inheritDoc */
public function unmangleArray( array $array ): array {
$out = [];
foreach ( $array as $key => $value ) {
$out[$this->unmangle( $key )] = $value;
}
return $out;
}
/** @inheritDoc */
public static function getExtraSchema(): array {
$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;
}
}
|
GitWeb