vendor/symfony/error-handler/DebugClassLoader.php line 331

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Component\ErrorHandler;
  14. use Composer\InstalledVersions;
  15. use Doctrine\Common\Persistence\Proxy as LegacyProxy;
  16. use Doctrine\Persistence\Proxy;
  17. use Mockery\MockInterface;
  18. use Phake\IMock;
  19. use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;
  20. use PHPUnit\Framework\MockObject\MockObject;
  21. use Prophecy\Prophecy\ProphecySubjectInterface;
  22. use ProxyManager\Proxy\ProxyInterface;
  23. use Symfony\Component\ErrorHandler\Internal\TentativeTypes;
  24. use Symfony\Component\HttpClient\HttplugClient;
  26. /**
  27. * Autoloader checking if the class is really defined in the file found.
  28. *
  29. * The ClassLoader will wrap all registered autoloaders
  30. * and will throw an exception if a file is found but does
  31. * not declare the class.
  32. *
  33. * It can also patch classes to turn docblocks into actual return types.
  34. * This behavior is controlled by the SYMFONY_PATCH_TYPE_DECLARATIONS env var,
  35. * which is a url-encoded array with the follow parameters:
  36. * - "force": any value enables deprecation notices - can be any of:
  37. * - "phpdoc" to patch only docblock annotations
  38. * - "2" to add all possible return types
  39. * - "1" to add return types but only to tests/final/internal/private methods
  40. * - "php": the target version of PHP - e.g. "7.1" doesn't generate "object" types
  41. * - "deprecations": "1" to trigger a deprecation notice when a child class misses a
  42. * return type while the parent declares an "@return" annotation
  43. *
  44. * Note that patching doesn't care about any coding style so you'd better to run
  45. * php-cs-fixer after, with rules "phpdoc_trim_consecutive_blank_line_separation"
  46. * and "no_superfluous_phpdoc_tags" enabled typically.
  47. *
  48. * @author Fabien Potencier <fabien@symfony.com>
  49. * @author Christophe Coevoet <stof@notk.org>
  50. * @author Nicolas Grekas <p@tchwork.com>
  51. * @author Guilhem Niot <guilhem.niot@gmail.com>
  52. */
  53. class DebugClassLoader
  54. {
  55. private const SPECIAL_RETURN_TYPES = [
  56. 'void' => 'void',
  57. 'null' => 'null',
  58. 'resource' => 'resource',
  59. 'boolean' => 'bool',
  60. 'true' => 'true',
  61. 'false' => 'false',
  62. 'integer' => 'int',
  63. 'array' => 'array',
  64. 'bool' => 'bool',
  65. 'callable' => 'callable',
  66. 'float' => 'float',
  67. 'int' => 'int',
  68. 'iterable' => 'iterable',
  69. 'object' => 'object',
  70. 'string' => 'string',
  71. 'self' => 'self',
  72. 'parent' => 'parent',
  73. 'mixed' => 'mixed',
  74. 'static' => 'static',
  75. '$this' => 'static',
  76. 'list' => 'array',
  77. 'class-string' => 'string',
  78. 'never' => 'never',
  79. ];
  81. private const BUILTIN_RETURN_TYPES = [
  82. 'void' => true,
  83. 'array' => true,
  84. 'false' => true,
  85. 'bool' => true,
  86. 'callable' => true,
  87. 'float' => true,
  88. 'int' => true,
  89. 'iterable' => true,
  90. 'object' => true,
  91. 'string' => true,
  92. 'self' => true,
  93. 'parent' => true,
  94. 'mixed' => true,
  95. 'static' => true,
  96. 'null' => true,
  97. 'true' => true,
  98. 'never' => true,
  99. ];
  101. private const MAGIC_METHODS = [
  102. '__isset' => 'bool',
  103. '__sleep' => 'array',
  104. '__toString' => 'string',
  105. '__debugInfo' => 'array',
  106. '__serialize' => 'array',
  107. ];
  109. private $classLoader;
  110. private $isFinder;
  111. private $loaded = [];
  112. private $patchTypes;
  114. private static $caseCheck;
  115. private static $checkedClasses = [];
  116. private static $final = [];
  117. private static $finalMethods = [];
  118. private static $deprecated = [];
  119. private static $internal = [];
  120. private static $internalMethods = [];
  121. private static $annotatedParameters = [];
  122. private static $darwinCache = ['/' => ['/', []]];
  123. private static $method = [];
  124. private static $returnTypes = [];
  125. private static $methodTraits = [];
  126. private static $fileOffsets = [];
  128. public function __construct(callable $classLoader)
  129. {
  130. $this->classLoader = $classLoader;
  131. $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  132. parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: '', $this->patchTypes);
  133. $this->patchTypes += [
  134. 'force' => null,
  135. 'php' => \PHP_MAJOR_VERSION.'.'.\PHP_MINOR_VERSION,
  136. 'deprecations' => \PHP_VERSION_ID >= 70400,
  137. ];
  139. if ('phpdoc' === $this->patchTypes['force']) {
  140. $this->patchTypes['force'] = 'docblock';
  141. }
  143. if (!isset(self::$caseCheck)) {
  144. $file = is_file(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  145. $i = strrpos($file, \DIRECTORY_SEPARATOR);
  146. $dir = substr($file, 0, 1 + $i);
  147. $file = substr($file, 1 + $i);
  148. $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  149. $test = realpath($dir.$test);
  151. if (false === $test || false === $i) {
  152. // filesystem is case sensitive
  153. self::$caseCheck = 0;
  154. } elseif (substr($test, -\strlen($file)) === $file) {
  155. // filesystem is case insensitive and realpath() normalizes the case of characters
  156. self::$caseCheck = 1;
  157. } elseif ('Darwin' === \PHP_OS_FAMILY) {
  158. // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  159. self::$caseCheck = 2;
  160. } else {
  161. // filesystem case checks failed, fallback to disabling them
  162. self::$caseCheck = 0;
  163. }
  164. }
  165. }
  167. public function getClassLoader(): callable
  168. {
  169. return $this->classLoader;
  170. }
  172. /**
  173. * Wraps all autoloaders.
  174. */
  175. public static function enable(): void
  176. {
  177. // Ensures we don't hit https://bugs.php.net/42098
  178. class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  179. class_exists(\Psr\Log\LogLevel::class);
  181. if (!\is_array($functions = spl_autoload_functions())) {
  182. return;
  183. }
  185. foreach ($functions as $function) {
  186. spl_autoload_unregister($function);
  187. }
  189. foreach ($functions as $function) {
  190. if (!\is_array($function) || !$function[0] instanceof self) {
  191. $function = [new static($function), 'loadClass'];
  192. }
  194. spl_autoload_register($function);
  195. }
  196. }
  198. /**
  199. * Disables the wrapping.
  200. */
  201. public static function disable(): void
  202. {
  203. if (!\is_array($functions = spl_autoload_functions())) {
  204. return;
  205. }
  207. foreach ($functions as $function) {
  208. spl_autoload_unregister($function);
  209. }
  211. foreach ($functions as $function) {
  212. if (\is_array($function) && $function[0] instanceof self) {
  213. $function = $function[0]->getClassLoader();
  214. }
  216. spl_autoload_register($function);
  217. }
  218. }
  220. public static function checkClasses(): bool
  221. {
  222. if (!\is_array($functions = spl_autoload_functions())) {
  223. return false;
  224. }
  226. $loader = null;
  228. foreach ($functions as $function) {
  229. if (\is_array($function) && $function[0] instanceof self) {
  230. $loader = $function[0];
  231. break;
  232. }
  233. }
  235. if (null === $loader) {
  236. return false;
  237. }
  239. static $offsets = [
  240. 'get_declared_interfaces' => 0,
  241. 'get_declared_traits' => 0,
  242. 'get_declared_classes' => 0,
  243. ];
  245. foreach ($offsets as $getSymbols => $i) {
  246. $symbols = $getSymbols();
  248. for (; $i < \count($symbols); ++$i) {
  249. if (!is_subclass_of($symbols[$i], MockObject::class)
  250. && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  251. && !is_subclass_of($symbols[$i], Proxy::class)
  252. && !is_subclass_of($symbols[$i], ProxyInterface::class)
  253. && !is_subclass_of($symbols[$i], LegacyProxy::class)
  254. && !is_subclass_of($symbols[$i], MockInterface::class)
  255. && !is_subclass_of($symbols[$i], IMock::class)
  256. ) {
  257. $loader->checkClass($symbols[$i]);
  258. }
  259. }
  261. $offsets[$getSymbols] = $i;
  262. }
  264. return true;
  265. }
  267. public function findFile(string $class): ?string
  268. {
  269. return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  270. }
  272. /**
  273. * Loads the given class or interface.
  274. *
  275. * @throws \RuntimeException
  276. */
  277. public function loadClass(string $class): void
  278. {
  279. $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  281. try {
  282. if ($this->isFinder && !isset($this->loaded[$class])) {
  283. $this->loaded[$class] = true;
  284. if (!$file = $this->classLoader[0]->findFile($class) ?: '') {
  285. // no-op
  286. } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  287. include $file;
  289. return;
  290. } elseif (false === include $file) {
  291. return;
  292. }
  293. } else {
  294. ($this->classLoader)($class);
  295. $file = '';
  296. }
  297. } finally {
  298. error_reporting($e);
  299. }
  301. $this->checkClass($class, $file);
  302. }
  304. private function checkClass(string $class, ?string $file = null): void
  305. {
  306. $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  308. if (null !== $file && $class && '\\' === $class[0]) {
  309. $class = substr($class, 1);
  310. }
  312. if ($exists) {
  313. if (isset(self::$checkedClasses[$class])) {
  314. return;
  315. }
  316. self::$checkedClasses[$class] = true;
  318. $refl = new \ReflectionClass($class);
  319. if (null === $file && $refl->isInternal()) {
  320. return;
  321. }
  322. $name = $refl->getName();
  324. if ($name !== $class && 0 === strcasecmp($name, $class)) {
  325. throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  326. }
  328. $deprecations = $this->checkAnnotations($refl, $name);
  330. foreach ($deprecations as $message) {
  331. @trigger_error($message, \E_USER_DEPRECATED);
  332. }
  333. }
  335. if (!$file) {
  336. return;
  337. }
  339. if (!$exists) {
  340. if (false !== strpos($class, '/')) {
  341. throw new \RuntimeException(sprintf('Trying to autoload a class with an invalid name "%s". Be careful that the namespace separator is "\" in PHP, not "/".', $class));
  342. }
  344. throw new \RuntimeException(sprintf('The autoloader expected class "%s" to be defined in file "%s". The file was found but the class was not in it, the class name or namespace probably has a typo.', $class, $file));
  345. }
  347. if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  348. throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  349. }
  350. }
  352. public function checkAnnotations(\ReflectionClass $refl, string $class): array
  353. {
  354. if (
  355. 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  356. || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  357. ) {
  358. return [];
  359. }
  360. $deprecations = [];
  362. $className = false !== strpos($class, "@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : $class;
  364. // Don't trigger deprecations for classes in the same vendor
  365. if ($class !== $className) {
  366. $vendor = preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' : '';
  367. $vendorLen = \strlen($vendor);
  368. } elseif (2 > $vendorLen = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  369. $vendorLen = 0;
  370. $vendor = '';
  371. } else {
  372. $vendor = str_replace('_', '\\', substr($class, 0, $vendorLen));
  373. }
  375. $parent = get_parent_class($class) ?: null;
  376. self::$returnTypes[$class] = [];
  377. $classIsTemplate = false;
  379. // Detect annotations on the class
  380. if ($doc = $this->parsePhpDoc($refl)) {
  381. $classIsTemplate = isset($doc['template']);
  383. foreach (['final', 'deprecated', 'internal'] as $annotation) {
  384. if (null !== $description = $doc[$annotation][0] ?? null) {
  385. self::${$annotation}[$class] = '' !== $description ? ' '.$description.(preg_match('/[.!]$/', $description) ? '' : '.') : '.';
  386. }
  387. }
  389. if ($refl->isInterface() && isset($doc['method'])) {
  390. foreach ($doc['method'] as $name => [$static, $returnType, $signature, $description]) {
  391. self::$method[$class][] = [$class, $static, $returnType, $name.$signature, $description];
  393. if ('' !== $returnType) {
  394. $this->setReturnType($returnType, $refl->name, $name, $refl->getFileName(), $parent);
  395. }
  396. }
  397. }
  398. }
  400. $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  401. if ($parent) {
  402. $parentAndOwnInterfaces[$parent] = $parent;
  404. if (!isset(self::$checkedClasses[$parent])) {
  405. $this->checkClass($parent);
  406. }
  408. if (isset(self::$final[$parent])) {
  409. $deprecations[] = sprintf('The "%s" class is considered final%s It may change without further notice as of its next major version. You should not extend it from "%s".', $parent, self::$final[$parent], $className);
  410. }
  411. }
  413. // Detect if the parent is annotated
  414. foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  415. if (!isset(self::$checkedClasses[$use])) {
  416. $this->checkClass($use);
  417. }
  418. if (isset(self::$deprecated[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen) && !isset(self::$deprecated[$class])
  419. && !(HttplugClient::class === $class && \in_array($use, [\Http\Client\HttpClient::class, \Http\Message\RequestFactory::class, \Http\Message\StreamFactory::class, \Http\Message\UriFactory::class], true))
  420. ) {
  421. $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  422. $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  424. $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s', $className, $type, $verb, $use, self::$deprecated[$use]);
  425. }
  426. if (isset(self::$internal[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)) {
  427. $deprecations[] = sprintf('The "%s" %s is considered internal%s It may change without further notice. You should not use it from "%s".', $use, class_exists($use, false) ? 'class' : (interface_exists($use, false) ? 'interface' : 'trait'), self::$internal[$use], $className);
  428. }
  429. if (isset(self::$method[$use])) {
  430. if ($refl->isAbstract()) {
  431. if (isset(self::$method[$class])) {
  432. self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  433. } else {
  434. self::$method[$class] = self::$method[$use];
  435. }
  436. } elseif (!$refl->isInterface()) {
  437. if (!strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)
  438. && 0 === strpos($className, 'Symfony\\')
  439. && (!class_exists(InstalledVersions::class)
  440. || 'symfony/symfony' !== InstalledVersions::getRootPackage()['name'])
  441. ) {
  442. // skip "same vendor" @method deprecations for Symfony\* classes unless symfony/symfony is being tested
  443. continue;
  444. }
  445. $hasCall = $refl->hasMethod('__call');
  446. $hasStaticCall = $refl->hasMethod('__callStatic');
  447. foreach (self::$method[$use] as [$interface, $static, $returnType, $name, $description]) {
  448. if ($static ? $hasStaticCall : $hasCall) {
  449. continue;
  450. }
  451. $realName = substr($name, 0, strpos($name, '('));
  452. if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  453. $deprecations[] = sprintf('Class "%s" should implement method "%s::%s%s"%s', $className, ($static ? 'static ' : '').$interface, $name, $returnType ? ': '.$returnType : '', null === $description ? '.' : ': '.$description);
  454. }
  455. }
  456. }
  457. }
  458. }
  460. if (trait_exists($class)) {
  461. $file = $refl->getFileName();
  463. foreach ($refl->getMethods() as $method) {
  464. if ($method->getFileName() === $file) {
  465. self::$methodTraits[$file][$method->getStartLine()] = $class;
  466. }
  467. }
  469. return $deprecations;
  470. }
  472. // Inherit @final, @internal, @param and @return annotations for methods
  473. self::$finalMethods[$class] = [];
  474. self::$internalMethods[$class] = [];
  475. self::$annotatedParameters[$class] = [];
  476. foreach ($parentAndOwnInterfaces as $use) {
  477. foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes'] as $property) {
  478. if (isset(self::${$property}[$use])) {
  479. self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  480. }
  481. }
  483. if (null !== (TentativeTypes::RETURN_TYPES[$use] ?? null)) {
  484. foreach (TentativeTypes::RETURN_TYPES[$use] as $method => $returnType) {
  485. $returnType = explode('|', $returnType);
  486. foreach ($returnType as $i => $t) {
  487. if ('?' !== $t && !isset(self::BUILTIN_RETURN_TYPES[$t])) {
  488. $returnType[$i] = '\\'.$t;
  489. }
  490. }
  491. $returnType = implode('|', $returnType);
  493. self::$returnTypes[$class] += [$method => [$returnType, 0 === strpos($returnType, '?') ? substr($returnType, 1).'|null' : $returnType, $use, '']];
  494. }
  495. }
  496. }
  498. foreach ($refl->getMethods() as $method) {
  499. if ($method->class !== $class) {
  500. continue;
  501. }
  503. if (null === $ns = self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  504. $ns = $vendor;
  505. $len = $vendorLen;
  506. } elseif (2 > $len = 1 + (strpos($ns, '\\') ?: strpos($ns, '_'))) {
  507. $len = 0;
  508. $ns = '';
  509. } else {
  510. $ns = str_replace('_', '\\', substr($ns, 0, $len));
  511. }
  513. if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  514. [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  515. $deprecations[] = sprintf('The "%s::%s()" method is considered final%s It may change without further notice as of its next major version. You should not extend it from "%s".', $declaringClass, $method->name, $message, $className);
  516. }
  518. if (isset(self::$internalMethods[$class][$method->name])) {
  519. [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  520. if (strncmp($ns, $declaringClass, $len)) {
  521. $deprecations[] = sprintf('The "%s::%s()" method is considered internal%s It may change without further notice. You should not extend it from "%s".', $declaringClass, $method->name, $message, $className);
  522. }
  523. }
  525. // To read method annotations
  526. $doc = $this->parsePhpDoc($method);
  528. if (($classIsTemplate || isset($doc['template'])) && $method->hasReturnType()) {
  529. unset($doc['return']);
  530. }
  532. if (isset(self::$annotatedParameters[$class][$method->name])) {
  533. $definedParameters = [];
  534. foreach ($method->getParameters() as $parameter) {
  535. $definedParameters[$parameter->name] = true;
  536. }
  538. foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  539. if (!isset($definedParameters[$parameterName]) && !isset($doc['param'][$parameterName])) {
  540. $deprecations[] = sprintf($deprecation, $className);
  541. }
  542. }
  543. }
  545. $forcePatchTypes = $this->patchTypes['force'];
  547. if ($canAddReturnType = null !== $forcePatchTypes && false === strpos($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  548. if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  549. $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  550. }
  552. $canAddReturnType = 2 === (int) $forcePatchTypes
  553. || false !== stripos($method->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  554. || $refl->isFinal()
  555. || $method->isFinal()
  556. || $method->isPrivate()
  557. || ('.' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  558. || '.' === (self::$final[$class] ?? null)
  559. || '' === ($doc['final'][0] ?? null)
  560. || '' === ($doc['internal'][0] ?? null)
  561. ;
  562. }
  564. if (null !== ($returnType = self::$returnTypes[$class][$method->name] ?? null) && 'docblock' === $this->patchTypes['force'] && !$method->hasReturnType() && isset(TentativeTypes::RETURN_TYPES[$returnType[2]][$method->name])) {
  565. $this->patchReturnTypeWillChange($method);
  566. }
  568. if (null !== ($returnType ?? $returnType = self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !isset($doc['return'])) {
  569. [$normalizedType, $returnType, $declaringClass, $declaringFile] = \is_string($returnType) ? [$returnType, $returnType, '', ''] : $returnType;
  571. if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  572. $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  573. }
  574. if (!isset($doc['deprecated']) && strncmp($ns, $declaringClass, $len)) {
  575. if ('docblock' === $this->patchTypes['force']) {
  576. $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  577. } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  578. $deprecations[] = sprintf('Method "%s::%s()" might add "%s" as a native return type declaration in the future. Do the same in %s "%s" now to avoid errors or add an explicit @return annotation to suppress this message.', $declaringClass, $method->name, $normalizedType, interface_exists($declaringClass) ? 'implementation' : 'child class', $className);
  579. }
  580. }
  581. }
  583. if (!$doc) {
  584. $this->patchTypes['force'] = $forcePatchTypes;
  586. continue;
  587. }
  589. if (isset($doc['return']) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  590. $this->setReturnType($doc['return'] ?? self::MAGIC_METHODS[$method->name], $method->class, $method->name, $method->getFileName(), $parent, $method->getReturnType());
  592. if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  593. $this->fixReturnStatements($method, self::$returnTypes[$class][$method->name][0]);
  594. }
  596. if ($method->isPrivate()) {
  597. unset(self::$returnTypes[$class][$method->name]);
  598. }
  599. }
  601. $this->patchTypes['force'] = $forcePatchTypes;
  603. if ($method->isPrivate()) {
  604. continue;
  605. }
  607. $finalOrInternal = false;
  609. foreach (['final', 'internal'] as $annotation) {
  610. if (null !== $description = $doc[$annotation][0] ?? null) {
  611. self::${$annotation.'Methods'}[$class][$method->name] = [$class, '' !== $description ? ' '.$description.(preg_match('/[[:punct:]]$/', $description) ? '' : '.') : '.'];
  612. $finalOrInternal = true;
  613. }
  614. }
  616. if ($finalOrInternal || $method->isConstructor() || !isset($doc['param']) || StatelessInvocation::class === $class) {
  617. continue;
  618. }
  619. if (!isset(self::$annotatedParameters[$class][$method->name])) {
  620. $definedParameters = [];
  621. foreach ($method->getParameters() as $parameter) {
  622. $definedParameters[$parameter->name] = true;
  623. }
  624. }
  625. foreach ($doc['param'] as $parameterName => $parameterType) {
  626. if (!isset($definedParameters[$parameterName])) {
  627. self::$annotatedParameters[$class][$method->name][$parameterName] = sprintf('The "%%s::%s()" method will require a new "%s$%s" argument in the next major version of its %s "%s", not defining it is deprecated.', $method->name, $parameterType ? $parameterType.' ' : '', $parameterName, interface_exists($className) ? 'interface' : 'parent class', $className);
  628. }
  629. }
  630. }
  632. return $deprecations;
  633. }
  635. public function checkCase(\ReflectionClass $refl, string $file, string $class): ?array
  636. {
  637. $real = explode('\\', $class.strrchr($file, '.'));
  638. $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  640. $i = \count($tail) - 1;
  641. $j = \count($real) - 1;
  643. while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  644. --$i;
  645. --$j;
  646. }
  648. array_splice($tail, 0, $i + 1);
  650. if (!$tail) {
  651. return null;
  652. }
  654. $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  655. $tailLen = \strlen($tail);
  656. $real = $refl->getFileName();
  658. if (2 === self::$caseCheck) {
  659. $real = $this->darwinRealpath($real);
  660. }
  662. if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  663. && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  664. ) {
  665. return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  666. }
  668. return null;
  669. }
  671. /**
  672. * `realpath` on MacOSX doesn't normalize the case of characters.
  673. */
  674. private function darwinRealpath(string $real): string
  675. {
  676. $i = 1 + strrpos($real, '/');
  677. $file = substr($real, $i);
  678. $real = substr($real, 0, $i);
  680. if (isset(self::$darwinCache[$real])) {
  681. $kDir = $real;
  682. } else {
  683. $kDir = strtolower($real);
  685. if (isset(self::$darwinCache[$kDir])) {
  686. $real = self::$darwinCache[$kDir][0];
  687. } else {
  688. $dir = getcwd();
  690. if (!@chdir($real)) {
  691. return $real.$file;
  692. }
  694. $real = getcwd().'/';
  695. chdir($dir);
  697. $dir = $real;
  698. $k = $kDir;
  699. $i = \strlen($dir) - 1;
  700. while (!isset(self::$darwinCache[$k])) {
  701. self::$darwinCache[$k] = [$dir, []];
  702. self::$darwinCache[$dir] = &self::$darwinCache[$k];
  704. while ('/' !== $dir[--$i]) {
  705. }
  706. $k = substr($k, 0, ++$i);
  707. $dir = substr($dir, 0, $i--);
  708. }
  709. }
  710. }
  712. $dirFiles = self::$darwinCache[$kDir][1];
  714. if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  715. // Get the file name from "file_name.php(123) : eval()'d code"
  716. $file = substr($file, 0, strrpos($file, '(', -17));
  717. }
  719. if (isset($dirFiles[$file])) {
  720. return $real.$dirFiles[$file];
  721. }
  723. $kFile = strtolower($file);
  725. if (!isset($dirFiles[$kFile])) {
  726. foreach (scandir($real, 2) as $f) {
  727. if ('.' !== $f[0]) {
  728. $dirFiles[$f] = $f;
  729. if ($f === $file) {
  730. $kFile = $k = $file;
  731. } elseif ($f !== $k = strtolower($f)) {
  732. $dirFiles[$k] = $f;
  733. }
  734. }
  735. }
  736. self::$darwinCache[$kDir][1] = $dirFiles;
  737. }
  739. return $real.$dirFiles[$kFile];
  740. }
  742. /**
  743. * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  744. *
  745. * @return string[]
  746. */
  747. private function getOwnInterfaces(string $class, ?string $parent): array
  748. {
  749. $ownInterfaces = class_implements($class, false);
  751. if ($parent) {
  752. foreach (class_implements($parent, false) as $interface) {
  753. unset($ownInterfaces[$interface]);
  754. }
  755. }
  757. foreach ($ownInterfaces as $interface) {
  758. foreach (class_implements($interface) as $interface) {
  759. unset($ownInterfaces[$interface]);
  760. }
  761. }
  763. return $ownInterfaces;
  764. }
  766. private function setReturnType(string $types, string $class, string $method, string $filename, ?string $parent, ?\ReflectionType $returnType = null): void
  767. {
  768. if ('__construct' === $method) {
  769. return;
  770. }
  772. if ('null' === $types) {
  773. self::$returnTypes[$class][$method] = ['null', 'null', $class, $filename];
  775. return;
  776. }
  778. if ($nullable = 0 === strpos($types, 'null|')) {
  779. $types = substr($types, 5);
  780. } elseif ($nullable = '|null' === substr($types, -5)) {
  781. $types = substr($types, 0, -5);
  782. }
  783. $arrayType = ['array' => 'array'];
  784. $typesMap = [];
  785. $glue = false !== strpos($types, '&') ? '&' : '|';
  786. foreach (explode($glue, $types) as $t) {
  787. $t = self::SPECIAL_RETURN_TYPES[strtolower($t)] ?? $t;
  788. $typesMap[$this->normalizeType($t, $class, $parent, $returnType)][$t] = $t;
  789. }
  791. if (isset($typesMap['array'])) {
  792. if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  793. $typesMap['iterable'] = $arrayType !== $typesMap['array'] ? $typesMap['array'] : ['iterable'];
  794. unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  795. } elseif ($arrayType !== $typesMap['array'] && isset(self::$returnTypes[$class][$method]) && !$returnType) {
  796. return;
  797. }
  798. }
  800. if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  801. if ($arrayType !== $typesMap['array']) {
  802. $typesMap['iterable'] = $typesMap['array'];
  803. }
  804. unset($typesMap['array']);
  805. }
  807. $iterable = $object = true;
  808. foreach ($typesMap as $n => $t) {
  809. if ('null' !== $n) {
  810. $iterable = $iterable && (\in_array($n, ['array', 'iterable']) || false !== strpos($n, 'Iterator'));
  811. $object = $object && (\in_array($n, ['callable', 'object', '$this', 'static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  812. }
  813. }
  815. $phpTypes = [];
  816. $docTypes = [];
  818. foreach ($typesMap as $n => $t) {
  819. if ('null' === $n) {
  820. $nullable = true;
  821. continue;
  822. }
  824. $docTypes[] = $t;
  826. if ('mixed' === $n || 'void' === $n) {
  827. $nullable = false;
  828. $phpTypes = ['' => $n];
  829. continue;
  830. }
  832. if ('resource' === $n) {
  833. // there is no native type for "resource"
  834. return;
  835. }
  837. if (!isset($phpTypes[''])) {
  838. $phpTypes[] = $n;
  839. }
  840. }
  841. $docTypes = array_merge([], ...$docTypes);
  843. if (!$phpTypes) {
  844. return;
  845. }
  847. if (1 < \count($phpTypes)) {
  848. if ($iterable && '8.0' > $this->patchTypes['php']) {
  849. $phpTypes = $docTypes = ['iterable'];
  850. } elseif ($object && 'object' === $this->patchTypes['force']) {
  851. $phpTypes = $docTypes = ['object'];
  852. } elseif ('8.0' > $this->patchTypes['php']) {
  853. // ignore multi-types return declarations
  854. return;
  855. }
  856. }
  858. $phpType = sprintf($nullable ? (1 < \count($phpTypes) ? '%s|null' : '?%s') : '%s', implode($glue, $phpTypes));
  859. $docType = sprintf($nullable ? '%s|null' : '%s', implode($glue, $docTypes));
  861. self::$returnTypes[$class][$method] = [$phpType, $docType, $class, $filename];
  862. }
  864. private function normalizeType(string $type, string $class, ?string $parent, ?\ReflectionType $returnType): string
  865. {
  866. if (isset(self::SPECIAL_RETURN_TYPES[$lcType = strtolower($type)])) {
  867. if ('parent' === $lcType = self::SPECIAL_RETURN_TYPES[$lcType]) {
  868. $lcType = null !== $parent ? '\\'.$parent : 'parent';
  869. } elseif ('self' === $lcType) {
  870. $lcType = '\\'.$class;
  871. }
  873. return $lcType;
  874. }
  876. // We could resolve "use" statements to return the FQDN
  877. // but this would be too expensive for a runtime checker
  879. if ('[]' !== substr($type, -2)) {
  880. return $type;
  881. }
  883. if ($returnType instanceof \ReflectionNamedType) {
  884. $type = $returnType->getName();
  886. if ('mixed' !== $type) {
  887. return isset(self::SPECIAL_RETURN_TYPES[$type]) ? $type : '\\'.$type;
  888. }
  889. }
  891. return 'array';
  892. }
  894. /**
  895. * Utility method to add #[ReturnTypeWillChange] where php triggers deprecations.
  896. */
  897. private function patchReturnTypeWillChange(\ReflectionMethod $method)
  898. {
  899. if (\PHP_VERSION_ID >= 80000 && \count($method->getAttributes(\ReturnTypeWillChange::class))) {
  900. return;
  901. }
  903. if (!is_file($file = $method->getFileName())) {
  904. return;
  905. }
  907. $fileOffset = self::$fileOffsets[$file] ?? 0;
  909. $code = file($file);
  911. $startLine = $method->getStartLine() + $fileOffset - 2;
  913. if (false !== stripos($code[$startLine], 'ReturnTypeWillChange')) {
  914. return;
  915. }
  917. $code[$startLine] .= " #[\\ReturnTypeWillChange]\n";
  918. self::$fileOffsets[$file] = 1 + $fileOffset;
  919. file_put_contents($file, $code);
  920. }
  922. /**
  923. * Utility method to add @return annotations to the Symfony code-base where it triggers self-deprecations.
  924. */
  925. private function patchMethod(\ReflectionMethod $method, string $returnType, string $declaringFile, string $normalizedType)
  926. {
  927. static $patchedMethods = [];
  928. static $useStatements = [];
  930. if (!is_file($file = $method->getFileName()) || isset($patchedMethods[$file][$startLine = $method->getStartLine()])) {
  931. return;
  932. }
  934. $patchedMethods[$file][$startLine] = true;
  935. $fileOffset = self::$fileOffsets[$file] ?? 0;
  936. $startLine += $fileOffset - 2;
  937. if ($nullable = '|null' === substr($returnType, -5)) {
  938. $returnType = substr($returnType, 0, -5);
  939. }
  940. $glue = false !== strpos($returnType, '&') ? '&' : '|';
  941. $returnType = explode($glue, $returnType);
  942. $code = file($file);
  944. foreach ($returnType as $i => $type) {
  945. if (preg_match('/((?:\[\])+)$/', $type, $m)) {
  946. $type = substr($type, 0, -\strlen($m[1]));
  947. $format = '%s'.$m[1];
  948. } else {
  949. $format = null;
  950. }
  952. if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p = strrpos($type, '\\', 1))) {
  953. continue;
  954. }
  956. [$namespace, $useOffset, $useMap] = $useStatements[$file] ?? $useStatements[$file] = self::getUseStatements($file);
  958. if ('\\' !== $type[0]) {
  959. [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ?? $useStatements[$declaringFile] = self::getUseStatements($declaringFile);
  961. $p = strpos($type, '\\', 1);
  962. $alias = $p ? substr($type, 0, $p) : $type;
  964. if (isset($declaringUseMap[$alias])) {
  965. $type = '\\'.$declaringUseMap[$alias].($p ? substr($type, $p) : '');
  966. } else {
  967. $type = '\\'.$declaringNamespace.$type;
  968. }
  970. $p = strrpos($type, '\\', 1);
  971. }
  973. $alias = substr($type, 1 + $p);
  974. $type = substr($type, 1);
  976. if (!isset($useMap[$alias]) && (class_exists($c = $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  977. $useMap[$alias] = $c;
  978. }
  980. if (!isset($useMap[$alias])) {
  981. $useStatements[$file][2][$alias] = $type;
  982. $code[$useOffset] = "use $type;\n".$code[$useOffset];
  983. ++$fileOffset;
  984. } elseif ($useMap[$alias] !== $type) {
  985. $alias .= 'FIXME';
  986. $useStatements[$file][2][$alias] = $type;
  987. $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  988. ++$fileOffset;
  989. }
  991. $returnType[$i] = null !== $format ? sprintf($format, $alias) : $alias;
  992. }
  994. if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  995. $returnType = implode($glue, $returnType).($nullable ? '|null' : '');
  997. if (false !== strpos($code[$startLine], '#[')) {
  998. --$startLine;
  999. }
  1001. if ($method->getDocComment()) {
  1002. $code[$startLine] = " * @return $returnType\n".$code[$startLine];
  1003. } else {
  1004. $code[$startLine] .= <<<EOTXT
  1005. /**
  1006. * @return $returnType
  1007. */
  1009. EOTXT;
  1010. }
  1012. $fileOffset += substr_count($code[$startLine], "\n") - 1;
  1013. }
  1015. self::$fileOffsets[$file] = $fileOffset;
  1016. file_put_contents($file, $code);
  1018. $this->fixReturnStatements($method, $normalizedType);
  1019. }
  1021. private static function getUseStatements(string $file): array
  1022. {
  1023. $namespace = '';
  1024. $useMap = [];
  1025. $useOffset = 0;
  1027. if (!is_file($file)) {
  1028. return [$namespace, $useOffset, $useMap];
  1029. }
  1031. $file = file($file);
  1033. for ($i = 0; $i < \count($file); ++$i) {
  1034. if (preg_match('/^(class|interface|trait|abstract) /', $file[$i])) {
  1035. break;
  1036. }
  1038. if (0 === strpos($file[$i], 'namespace ')) {
  1039. $namespace = substr($file[$i], \strlen('namespace '), -2).'\\';
  1040. $useOffset = $i + 2;
  1041. }
  1043. if (0 === strpos($file[$i], 'use ')) {
  1044. $useOffset = $i;
  1046. for (; 0 === strpos($file[$i], 'use '); ++$i) {
  1047. $u = explode(' as ', substr($file[$i], 4, -2), 2);
  1049. if (1 === \count($u)) {
  1050. $p = strrpos($u[0], '\\');
  1051. $useMap[substr($u[0], false !== $p ? 1 + $p : 0)] = $u[0];
  1052. } else {
  1053. $useMap[$u[1]] = $u[0];
  1054. }
  1055. }
  1057. break;
  1058. }
  1059. }
  1061. return [$namespace, $useOffset, $useMap];
  1062. }
  1064. private function fixReturnStatements(\ReflectionMethod $method, string $returnType)
  1065. {
  1066. if ('docblock' !== $this->patchTypes['force']) {
  1067. if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType, '?')) {
  1068. return;
  1069. }
  1071. if ('7.4' > $this->patchTypes['php'] && $method->hasReturnType()) {
  1072. return;
  1073. }
  1075. if ('8.0' > $this->patchTypes['php'] && (false !== strpos($returnType, '|') || \in_array($returnType, ['mixed', 'static'], true))) {
  1076. return;
  1077. }
  1079. if ('8.1' > $this->patchTypes['php'] && false !== strpos($returnType, '&')) {
  1080. return;
  1081. }
  1082. }
  1084. if (!is_file($file = $method->getFileName())) {
  1085. return;
  1086. }
  1088. $fixedCode = $code = file($file);
  1089. $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  1091. if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  1092. $fixedCode[$i - 1] = preg_replace('/\)(?::[^;\n]++)?(;?\n)/', "): $returnType\\1", $code[$i - 1]);
  1093. }
  1095. $end = $method->isGenerator() ? $i : $method->getEndLine();
  1096. $inClosure = false;
  1097. $braces = 0;
  1098. for (; $i < $end; ++$i) {
  1099. if (!$inClosure) {
  1100. $inClosure = false !== strpos($code[$i], 'function (');
  1101. }
  1103. if ($inClosure) {
  1104. $braces += substr_count($code[$i], '{') - substr_count($code[$i], '}');
  1105. $inClosure = $braces > 0;
  1107. continue;
  1108. }
  1110. if ('void' === $returnType) {
  1111. $fixedCode[$i] = str_replace(' return null;', ' return;', $code[$i]);
  1112. } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  1113. $fixedCode[$i] = str_replace(' return;', ' return null;', $code[$i]);
  1114. } else {
  1115. $fixedCode[$i] = str_replace(' return;', " return $returnType!?;", $code[$i]);
  1116. }
  1117. }
  1119. if ($fixedCode !== $code) {
  1120. file_put_contents($file, $fixedCode);
  1121. }
  1122. }
  1124. /**
  1125. * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflector
  1126. */
  1127. private function parsePhpDoc(\Reflector $reflector): array
  1128. {
  1129. if (!$doc = $reflector->getDocComment()) {
  1130. return [];
  1131. }
  1133. $tagName = '';
  1134. $tagContent = '';
  1136. $tags = [];
  1138. foreach (explode("\n", substr($doc, 3, -2)) as $line) {
  1139. $line = ltrim($line);
  1140. $line = ltrim($line, '*');
  1142. if ('' === $line = trim($line)) {
  1143. if ('' !== $tagName) {
  1144. $tags[$tagName][] = $tagContent;
  1145. }
  1146. $tagName = $tagContent = '';
  1147. continue;
  1148. }
  1150. if ('@' === $line[0]) {
  1151. if ('' !== $tagName) {
  1152. $tags[$tagName][] = $tagContent;
  1153. $tagContent = '';
  1154. }
  1156. if (preg_match('{^@([-a-zA-Z0-9_:]++)(\s|$)}', $line, $m)) {
  1157. $tagName = $m[1];
  1158. $tagContent = str_replace("\t", ' ', ltrim(substr($line, 2 + \strlen($tagName))));
  1159. } else {
  1160. $tagName = '';
  1161. }
  1162. } elseif ('' !== $tagName) {
  1163. $tagContent .= ' '.str_replace("\t", ' ', $line);
  1164. }
  1165. }
  1167. if ('' !== $tagName) {
  1168. $tags[$tagName][] = $tagContent;
  1169. }
  1171. foreach ($tags['method'] ?? [] as $i => $method) {
  1172. unset($tags['method'][$i]);
  1174. $parts = preg_split('{(\s++|\((?:[^()]*+|(?R))*\)(?: *: *[^ ]++)?|<(?:[^<>]*+|(?R))*>|\{(?:[^{}]*+|(?R))*\})}', $method, -1, \PREG_SPLIT_DELIM_CAPTURE);
  1175. $returnType = '';
  1176. $static = 'static' === $parts[0];
  1178. for ($i = $static ? 2 : 0; null !== $p = $parts[$i] ?? null; $i += 2) {
  1179. if (\in_array($p, ['', '|', '&', 'callable'], true) || \in_array(substr($returnType, -1), ['|', '&'], true)) {
  1180. $returnType .= trim($parts[$i - 1] ?? '').$p;
  1181. continue;
  1182. }
  1184. $signature = '(' === ($parts[$i + 1][0] ?? '(') ? $parts[$i + 1] ?? '()' : null;
  1186. if (null === $signature && '' === $returnType) {
  1187. $returnType = $p;
  1188. continue;
  1189. }
  1191. if ($static && 2 === $i) {
  1192. $static = false;
  1193. $returnType = 'static';
  1194. }
  1196. if (\in_array($description = trim(implode('', \array_slice($parts, 2 + $i))), ['', '.'], true)) {
  1197. $description = null;
  1198. } elseif (!preg_match('/[.!]$/', $description)) {
  1199. $description .= '.';
  1200. }
  1202. $tags['method'][$p] = [$static, $returnType, $signature ?? '()', $description];
  1203. break;
  1204. }
  1205. }
  1207. foreach ($tags['param'] ?? [] as $i => $param) {
  1208. unset($tags['param'][$i]);
  1210. if (\strlen($param) !== strcspn($param, '<{(')) {
  1211. $param = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $param);
  1212. }
  1214. if (false === $i = strpos($param, '$')) {
  1215. continue;
  1216. }
  1218. $type = 0 === $i ? '' : rtrim(substr($param, 0, $i), ' &');
  1219. $param = substr($param, 1 + $i, (strpos($param, ' ', $i) ?: (1 + $i + \strlen($param))) - $i - 1);
  1221. $tags['param'][$param] = $type;
  1222. }
  1224. foreach (['var', 'return'] as $k) {
  1225. if (null === $v = $tags[$k][0] ?? null) {
  1226. continue;
  1227. }
  1228. if (\strlen($v) !== strcspn($v, '<{(')) {
  1229. $v = preg_replace('{\(([^()]*+|(?R))*\)(?: *: *[^ ]++)?|<([^<>]*+|(?R))*>|\{([^{}]*+|(?R))*\}}', '', $v);
  1230. }
  1232. $tags[$k] = substr($v, 0, strpos($v, ' ') ?: \strlen($v)) ?: null;
  1233. }
  1235. return $tags;
  1236. }
  1237. }