-
Notifications
You must be signed in to change notification settings - Fork 446
/
AutoloadSourceLocator.php
333 lines (288 loc) · 10.1 KB
/
AutoloadSourceLocator.php
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<?php declare(strict_types = 1);
namespace PHPStan\Reflection\BetterReflection\SourceLocator;
use PhpParser\Node;
use PhpParser\Node\Arg;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Name;
use PhpParser\Node\Scalar\String_;
use PHPStan\BetterReflection\Identifier\Identifier;
use PHPStan\BetterReflection\Identifier\IdentifierType;
use PHPStan\BetterReflection\Reflection\Reflection;
use PHPStan\BetterReflection\Reflection\ReflectionConstant;
use PHPStan\BetterReflection\Reflector\Reflector;
use PHPStan\BetterReflection\SourceLocator\Ast\Strategy\NodeToReflection;
use PHPStan\BetterReflection\SourceLocator\Located\LocatedSource;
use PHPStan\BetterReflection\SourceLocator\Type\SourceLocator;
use PHPStan\ShouldNotHappenException;
use ReflectionClass;
use ReflectionFunction;
use function array_key_exists;
use function array_keys;
use function class_exists;
use function constant;
use function count;
use function defined;
use function function_exists;
use function interface_exists;
use function is_file;
use function is_string;
use function restore_error_handler;
use function set_error_handler;
use function spl_autoload_functions;
use function strtolower;
use function trait_exists;
use const PHP_VERSION_ID;
/**
* Use PHP's built in autoloader to locate a class, without actually loading.
*
* There are some prerequisites...
* - we expect the autoloader to load classes from a file (i.e. using require/include)
*
* Modified code from Roave/BetterReflection, Copyright (c) 2017 Roave, LLC.
*/
class AutoloadSourceLocator implements SourceLocator
{
/** @var array<string, array<FetchedNode<Node\Stmt\ClassLike>>> */
private array $classNodes = [];
/** @var array<string, Reflection|null> */
private array $classReflections = [];
/** @var array<string, FetchedNode<Node\Stmt\Function_>> */
private array $functionNodes = [];
/** @var array<int, FetchedNode<Node\Stmt\Const_|Node\Expr\FuncCall>> */
private array $constantNodes = [];
/** @var array<string, true> */
private array $fetchedNodesByFile = [];
public function __construct(private FileNodesFetcher $fileNodesFetcher, private bool $disableRuntimeReflectionProvider)
{
}
public function locateIdentifier(Reflector $reflector, Identifier $identifier): ?Reflection
{
if ($identifier->isFunction()) {
$functionName = $identifier->getName();
$loweredFunctionName = strtolower($functionName);
if (array_key_exists($loweredFunctionName, $this->functionNodes)) {
$nodeToReflection = new NodeToReflection();
return $nodeToReflection->__invoke(
$reflector,
$this->functionNodes[$loweredFunctionName]->getNode(),
$this->functionNodes[$loweredFunctionName]->getLocatedSource(),
$this->functionNodes[$loweredFunctionName]->getNamespace(),
);
}
if (!function_exists($functionName)) {
return null;
}
$reflection = new ReflectionFunction($functionName);
$reflectionFileName = $reflection->getFileName();
if (!is_string($reflectionFileName)) {
return null;
}
if (!is_file($reflectionFileName)) {
return null;
}
return $this->findReflection($reflector, $reflectionFileName, $identifier, null);
}
if ($identifier->isConstant()) {
$constantName = $identifier->getName();
$nodeToReflection = new NodeToReflection();
foreach ($this->constantNodes as $stmtConst) {
if ($stmtConst->getNode() instanceof FuncCall) {
$constantReflection = $nodeToReflection->__invoke(
$reflector,
$stmtConst->getNode(),
$stmtConst->getLocatedSource(),
$stmtConst->getNamespace(),
);
if (!$constantReflection instanceof ReflectionConstant) {
throw new ShouldNotHappenException();
}
if ($constantReflection->getName() !== $identifier->getName()) {
continue;
}
return $constantReflection;
}
foreach (array_keys($stmtConst->getNode()->consts) as $i) {
$constantReflection = $nodeToReflection->__invoke(
$reflector,
$stmtConst->getNode(),
$stmtConst->getLocatedSource(),
$stmtConst->getNamespace(),
$i,
);
if (!$constantReflection instanceof ReflectionConstant) {
throw new ShouldNotHappenException();
}
if ($constantReflection->getName() !== $identifier->getName()) {
continue;
}
return $constantReflection;
}
}
if (!defined($constantName)) {
return null;
}
$reflection = ReflectionConstant::createFromNode(
$reflector,
new FuncCall(new Name('define'), [
new Arg(new String_($constantName)),
new Arg(new String_('')), // not actually used
]),
new LocatedSource('', $constantName, null),
null,
null,
);
$reflection->populateValue(@constant($constantName));
return $reflection;
}
if (!$identifier->isClass()) {
return null;
}
$loweredClassName = strtolower($identifier->getName());
if (array_key_exists($loweredClassName, $this->classReflections)) {
return $this->classReflections[$loweredClassName];
}
$locateResult = $this->locateClassByName($identifier->getName());
if ($locateResult === null) {
if (array_key_exists($loweredClassName, $this->classNodes)) {
foreach ($this->classNodes[$loweredClassName] as $classNode) {
$nodeToReflection = new NodeToReflection();
return $this->classReflections[$loweredClassName] = $nodeToReflection->__invoke(
$reflector,
$classNode->getNode(),
$classNode->getLocatedSource(),
$classNode->getNamespace(),
);
}
}
return null;
}
[$potentiallyLocatedFile, $className, $startLine] = $locateResult;
return $this->findReflection($reflector, $potentiallyLocatedFile, new Identifier($className, $identifier->getType()), $startLine);
}
private function findReflection(Reflector $reflector, string $file, Identifier $identifier, ?int $startLine): ?Reflection
{
if (!array_key_exists($file, $this->fetchedNodesByFile)) {
$result = $this->fileNodesFetcher->fetchNodes($file);
foreach ($result->getClassNodes() as $className => $fetchedClassNodes) {
foreach ($fetchedClassNodes as $fetchedClassNode) {
$this->classNodes[$className][] = $fetchedClassNode;
}
}
foreach ($result->getFunctionNodes() as $functionName => $fetchedFunctionNode) {
$this->functionNodes[$functionName] = $fetchedFunctionNode;
}
foreach ($result->getConstantNodes() as $fetchedConstantNode) {
$this->constantNodes[] = $fetchedConstantNode;
}
$this->fetchedNodesByFile[$file] = true;
}
$nodeToReflection = new NodeToReflection();
if ($identifier->isClass()) {
$identifierName = strtolower($identifier->getName());
if (array_key_exists($identifierName, $this->classReflections)) {
return $this->classReflections[$identifierName];
}
if (!array_key_exists($identifierName, $this->classNodes)) {
return null;
}
$classNodesCount = count($this->classNodes[$identifierName]);
foreach ($this->classNodes[$identifierName] as $classNode) {
if ($classNodesCount > 1 && $startLine !== null) {
if (count($classNode->getNode()->attrGroups) > 0 && PHP_VERSION_ID < 80000) {
$startLine--;
}
if ($startLine !== $classNode->getNode()->getStartLine()) {
continue;
}
}
return $this->classReflections[$identifierName] = $nodeToReflection->__invoke(
$reflector,
$classNode->getNode(),
$classNode->getLocatedSource(),
$classNode->getNamespace(),
);
}
return null;
}
if ($identifier->isFunction()) {
$identifierName = strtolower($identifier->getName());
if (!array_key_exists($identifierName, $this->functionNodes)) {
return null;
}
return $nodeToReflection->__invoke(
$reflector,
$this->functionNodes[$identifierName]->getNode(),
$this->functionNodes[$identifierName]->getLocatedSource(),
$this->functionNodes[$identifierName]->getNamespace(),
);
}
return null;
}
public function locateIdentifiersByType(Reflector $reflector, IdentifierType $identifierType): array
{
return [];
}
/**
* Attempt to locate a class by name.
*
* If class already exists, simply use internal reflection API to get the
* filename and store it.
*
* If class does not exist, we make an assumption that whatever autoloaders
* that are registered will be loading a file. We then override the file://
* protocol stream wrapper to "capture" the filename we expect the class to
* be in, and then restore it. Note that class_exists will cause an error
* that it cannot find the file, so we squelch the errors by overriding the
* error handler temporarily.
*
* @return array{string, string, int|null}|null
*/
private function locateClassByName(string $className): ?array
{
if (class_exists($className, !$this->disableRuntimeReflectionProvider) || interface_exists($className, !$this->disableRuntimeReflectionProvider) || trait_exists($className, !$this->disableRuntimeReflectionProvider)) {
$reflection = new ReflectionClass($className);
$filename = $reflection->getFileName();
if (!is_string($filename)) {
return null;
}
if (!is_file($filename)) {
return null;
}
return [$filename, $reflection->getName(), $reflection->getStartLine() !== false ? $reflection->getStartLine() : null];
}
if (!$this->disableRuntimeReflectionProvider) {
return null;
}
$this->silenceErrors();
try {
/** @var array{string, string, null}|null */
return FileReadTrapStreamWrapper::withStreamWrapperOverride(
static function () use ($className): ?array {
$functions = spl_autoload_functions();
if ($functions === false) {
return null;
}
foreach ($functions as $preExistingAutoloader) {
$preExistingAutoloader($className);
/**
* This static variable is populated by the side-effect of the stream wrapper
* trying to read the file path when `include()` is used by an autoloader.
*
* This will not be `null` when the autoloader tried to read a file.
*/
if (FileReadTrapStreamWrapper::$autoloadLocatedFile !== null) {
return [FileReadTrapStreamWrapper::$autoloadLocatedFile, $className, null];
}
}
return null;
},
);
} finally {
restore_error_handler();
}
}
private function silenceErrors(): void
{
set_error_handler(static fn (): bool => true);
}
}