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
|
<?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.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* Reads PHP code and returns the FQCN of every class defined within it.
*/
class ClassCollector {
/**
* @var string Current namespace
*/
protected $namespace = '';
/**
* @var array List of FQCN detected in this pass
*/
protected $classes;
/**
* @var array|null Token from token_get_all() that started an expect sequence
*/
protected $startToken;
/**
* @var array[]|string[] List of tokens that are members of the current expect sequence
*/
protected $tokens;
/**
* @var array|null Class alias with target/name fields
*/
protected $alias;
/**
* @param string $code PHP code (including <?php) to detect class names from
* @return array List of FQCN detected within the tokens
*/
public function getClasses( $code ) {
$this->namespace = '';
$this->classes = [];
$this->startToken = null;
$this->alias = null;
$this->tokens = [];
// HACK: The PHP tokenizer is slow (T225730).
// Speed it up by reducing the input to the three kinds of statement we care about:
// - namespace X;
// - [final] [abstract] class X … {}
// - class_alias( … );
$lines = [];
$matches = null;
preg_match_all(
// phpcs:ignore Generic.Files.LineLength.TooLong
'#^\t*(?:namespace |(final )?(abstract )?(class|interface|trait) |class_alias\()[^;{]+[;{]\s*\}?#m',
$code,
$matches
);
if ( isset( $matches[0][0] ) ) {
foreach ( $matches[0] as $match ) {
$match = trim( $match );
if ( substr( $match, -1 ) === '{' ) {
// Keep it balanced
$match .= '}';
}
$lines[] = $match;
}
}
$code = '<?php ' . implode( "\n", $lines ) . "\n";
foreach ( token_get_all( $code ) as $token ) {
if ( $this->startToken === null ) {
$this->tryBeginExpect( $token );
} else {
$this->tryEndExpect( $token );
}
}
return $this->classes;
}
/**
* Determine if $token begins the next expect sequence.
*
* @param array $token
*/
protected function tryBeginExpect( $token ) {
if ( is_string( $token ) ) {
return;
}
// Note: When changing class name discovery logic,
// AutoLoaderStructureTest.php may also need to be updated.
switch ( $token[0] ) {
case T_NAMESPACE:
case T_CLASS:
case T_INTERFACE:
case T_TRAIT:
case T_DOUBLE_COLON:
case T_NEW:
$this->startToken = $token;
break;
case T_STRING:
if ( $token[1] === 'class_alias' ) {
$this->startToken = $token;
$this->alias = [];
}
}
}
/**
* Accepts the next token in an expect sequence
*
* @param array|string $token
*/
protected function tryEndExpect( $token ) {
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable
switch ( $this->startToken[0] ) {
case T_DOUBLE_COLON:
// Skip over T_CLASS after T_DOUBLE_COLON because this is something like
// "self::static" which accesses the class name. It doesn't define a new class.
$this->startToken = null;
break;
case T_NEW:
// Skip over T_CLASS after T_NEW because this is a PHP 7 anonymous class.
if ( !is_array( $token ) || $token[0] !== T_WHITESPACE ) {
$this->startToken = null;
}
break;
case T_NAMESPACE:
if ( $token === ';' || $token === '{' ) {
$this->namespace = $this->implodeTokens() . '\\';
} else {
$this->tokens[] = $token;
}
break;
case T_STRING:
if ( $this->alias !== null ) {
// Flow 1 - Two string literals:
// - T_STRING class_alias
// - '('
// - T_CONSTANT_ENCAPSED_STRING 'TargetClass'
// - ','
// - T_WHITESPACE
// - T_CONSTANT_ENCAPSED_STRING 'AliasName'
// - ')'
// Flow 2 - Use of ::class syntax for first parameter
// - T_STRING class_alias
// - '('
// - T_STRING TargetClass
// - T_DOUBLE_COLON ::
// - T_CLASS class
// - ','
// - T_WHITESPACE
// - T_CONSTANT_ENCAPSED_STRING 'AliasName'
// - ')'
if ( $token === '(' ) {
// Start of a function call to class_alias()
$this->alias = [ 'target' => false, 'name' => false ];
} elseif ( $token === ',' ) {
// Record that we're past the first parameter
if ( $this->alias['target'] === false ) {
$this->alias['target'] = true;
}
} elseif ( is_array( $token ) && $token[0] === T_CONSTANT_ENCAPSED_STRING ) {
if ( $this->alias['target'] === true ) {
// We already saw a first argument, this must be the second.
// Strip quotes from the string literal.
$this->alias['name'] = self::stripQuotes( $token[1] );
}
} elseif ( $token === ')' ) {
// End of function call
$this->classes[] = $this->alias['name'];
$this->alias = null;
$this->startToken = null;
} elseif ( !is_array( $token ) || (
$token[0] !== T_STRING &&
$token[0] !== T_DOUBLE_COLON &&
$token[0] !== T_CLASS &&
$token[0] !== T_WHITESPACE
) ) {
// Ignore this call to class_alias() - compat/Timestamp.php
$this->alias = null;
$this->startToken = null;
}
}
break;
case T_CLASS:
case T_INTERFACE:
case T_TRAIT:
$this->tokens[] = $token;
if ( is_array( $token ) && $token[0] === T_STRING ) {
$this->classes[] = $this->namespace . $this->implodeTokens();
}
}
}
/**
* Decode a quoted PHP string, interpreting escape sequences, like eval($str).
* The implementation is half-baked, but the character set allowed in class
* names is pretty small. This could be replaced by a call to a fully-baked
* utility function.
*
* @param string $str
* @return string
*/
private static function stripQuotes( $str ) {
return str_replace( '\\\\', '\\', substr( $str, 1, -1 ) );
}
/**
* Returns the string representation of the tokens within the
* current expect sequence and resets the sequence.
*
* @return string
*/
protected function implodeTokens() {
$content = [];
foreach ( $this->tokens as $token ) {
$content[] = is_string( $token ) ? $token : $token[1];
}
$this->tokens = [];
$this->startToken = null;
return trim( implode( '', $content ), " \n\t" );
}
}
|
