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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 Doctrine\Common\Persistence\Proxy as LegacyProxy;
  15. use Doctrine\Persistence\Proxy;
  16. use Mockery\MockInterface;
  17. use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;
  18. use PHPUnit\Framework\MockObject\MockObject;
  19. use Prophecy\Prophecy\ProphecySubjectInterface;
  20. use ProxyManager\Proxy\ProxyInterface;
  22. /**
  23.  * Autoloader checking if the class is really defined in the file found.
  24.  *
  25.  * The ClassLoader will wrap all registered autoloaders
  26.  * and will throw an exception if a file is found but does
  27.  * not declare the class.
  28.  *
  29.  * It can also patch classes to turn docblocks into actual return types.
  30.  * This behavior is controlled by the SYMFONY_PATCH_TYPE_DECLARATIONS env var,
  31.  * which is a url-encoded array with the follow parameters:
  32.  *  - "force": any value enables deprecation notices - can be any of:
  33.  *      - "docblock" to patch only docblock annotations
  34.  *      - "object" to turn union types to the "object" type when possible (not recommended)
  35.  *      - "1" to add all possible return types including magic methods
  36.  *      - "0" to add possible return types excluding magic methods
  37.  *  - "php": the target version of PHP - e.g. "7.1" doesn't generate "object" types
  38.  *  - "deprecations": "1" to trigger a deprecation notice when a child class misses a
  39.  *                    return type while the parent declares an "@return" annotation
  40.  *
  41.  * Note that patching doesn't care about any coding style so you'd better to run
  42.  * php-cs-fixer after, with rules "phpdoc_trim_consecutive_blank_line_separation"
  43.  * and "no_superfluous_phpdoc_tags" enabled typically.
  44.  *
  45.  * @author Fabien Potencier <[email protected]>
  46.  * @author Christophe Coevoet <[email protected]>
  47.  * @author Nicolas Grekas <[email protected]>
  48.  * @author Guilhem Niot <[email protected]>
  49.  */
  50. class DebugClassLoader
  51. {
  52.     private const SPECIAL_RETURN_TYPES = [
  53.         'void' => 'void',
  54.         'null' => 'null',
  55.         'resource' => 'resource',
  56.         'boolean' => 'bool',
  57.         'true' => 'bool',
  58.         'false' => 'bool',
  59.         'integer' => 'int',
  60.         'array' => 'array',
  61.         'bool' => 'bool',
  62.         'callable' => 'callable',
  63.         'float' => 'float',
  64.         'int' => 'int',
  65.         'iterable' => 'iterable',
  66.         'object' => 'object',
  67.         'string' => 'string',
  68.         'self' => 'self',
  69.         'parent' => 'parent',
  70.         'mixed' => 'mixed',
  71.     ] + (\PHP_VERSION_ID >= 80000 ? [
  72.         'static' => 'static',
  73.         '$this' => 'static',
  74.     ] : [
  75.         'static' => 'object',
  76.         '$this' => 'object',
  77.     ]);
  79.     private const BUILTIN_RETURN_TYPES = [
  80.         'void' => true,
  81.         'array' => true,
  82.         'bool' => true,
  83.         'callable' => true,
  84.         'float' => true,
  85.         'int' => true,
  86.         'iterable' => true,
  87.         'object' => true,
  88.         'string' => true,
  89.         'self' => true,
  90.         'parent' => true,
  91.     ] + (\PHP_VERSION_ID >= 80000 ? [
  92.         'mixed' => true,
  93.         'static' => true,
  94.     ] : []);
  96.     private const MAGIC_METHODS = [
  97.         '__set' => 'void',
  98.         '__isset' => 'bool',
  99.         '__unset' => 'void',
  100.         '__sleep' => 'array',
  101.         '__wakeup' => 'void',
  102.         '__toString' => 'string',
  103.         '__clone' => 'void',
  104.         '__debugInfo' => 'array',
  105.         '__serialize' => 'array',
  106.         '__unserialize' => 'void',
  107.     ];
  109.     private const INTERNAL_TYPES = [
  110.         'ArrayAccess' => [
  111.             'offsetExists' => 'bool',
  112.             'offsetSet' => 'void',
  113.             'offsetUnset' => 'void',
  114.         ],
  115.         'Countable' => [
  116.             'count' => 'int',
  117.         ],
  118.         'Iterator' => [
  119.             'next' => 'void',
  120.             'valid' => 'bool',
  121.             'rewind' => 'void',
  122.         ],
  123.         'IteratorAggregate' => [
  124.             'getIterator' => '\Traversable',
  125.         ],
  126.         'OuterIterator' => [
  127.             'getInnerIterator' => '\Iterator',
  128.         ],
  129.         'RecursiveIterator' => [
  130.             'hasChildren' => 'bool',
  131.         ],
  132.         'SeekableIterator' => [
  133.             'seek' => 'void',
  134.         ],
  135.         'Serializable' => [
  136.             'serialize' => 'string',
  137.             'unserialize' => 'void',
  138.         ],
  139.         'SessionHandlerInterface' => [
  140.             'open' => 'bool',
  141.             'close' => 'bool',
  142.             'read' => 'string',
  143.             'write' => 'bool',
  144.             'destroy' => 'bool',
  145.             'gc' => 'bool',
  146.         ],
  147.         'SessionIdInterface' => [
  148.             'create_sid' => 'string',
  149.         ],
  150.         'SessionUpdateTimestampHandlerInterface' => [
  151.             'validateId' => 'bool',
  152.             'updateTimestamp' => 'bool',
  153.         ],
  154.         'Throwable' => [
  155.             'getMessage' => 'string',
  156.             'getCode' => 'int',
  157.             'getFile' => 'string',
  158.             'getLine' => 'int',
  159.             'getTrace' => 'array',
  160.             'getPrevious' => '?\Throwable',
  161.             'getTraceAsString' => 'string',
  162.         ],
  163.     ];
  165.     private $classLoader;
  166.     private $isFinder;
  167.     private $loaded = [];
  168.     private $patchTypes;
  170.     private static $caseCheck;
  171.     private static $checkedClasses = [];
  172.     private static $final = [];
  173.     private static $finalMethods = [];
  174.     private static $deprecated = [];
  175.     private static $internal = [];
  176.     private static $internalMethods = [];
  177.     private static $annotatedParameters = [];
  178.     private static $darwinCache = ['/' => ['/', []]];
  179.     private static $method = [];
  180.     private static $returnTypes = [];
  181.     private static $methodTraits = [];
  182.     private static $fileOffsets = [];
  184.     public function __construct(callable $classLoader)
  185.     {
  186.         $this->classLoader = $classLoader;
  187.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  188.         parse_str(getenv('SYMFONY_PATCH_TYPE_DECLARATIONS') ?: '', $this->patchTypes);
  189.         $this->patchTypes += [
  190.             'force' => null,
  191.             'php' => null,
  192.             'deprecations' => false,
  193.         ];
  195.         if (!isset(self::$caseCheck)) {
  196.             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  197.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  198.             $dir = substr($file, 0, 1 + $i);
  199.             $file = substr($file, 1 + $i);
  200.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  201.             $test = realpath($dir.$test);
  203.             if (false === $test || false === $i) {
  204.                 // filesystem is case sensitive
  205.                 self::$caseCheck = 0;
  206.             } elseif (substr($test, -\strlen($file)) === $file) {
  207.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  208.                 self::$caseCheck = 1;
  209.             } elseif (false !== stripos(\PHP_OS, 'darwin')) {
  210.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  211.                 self::$caseCheck = 2;
  212.             } else {
  213.                 // filesystem case checks failed, fallback to disabling them
  214.                 self::$caseCheck = 0;
  215.             }
  216.         }
  217.     }
  219.     /**
  220.      * Gets the wrapped class loader.
  221.      *
  222.      * @return callable The wrapped class loader
  223.      */
  224.     public function getClassLoader(): callable
  225.     {
  226.         return $this->classLoader;
  227.     }
  229.     /**
  230.      * Wraps all autoloaders.
  231.      */
  232.     public static function enable(): void
  233.     {
  234.         // Ensures we don't hit https://bugs.php.net/42098
  235.         class_exists(\Symfony\Component\ErrorHandler\ErrorHandler::class);
  236.         class_exists(\Psr\Log\LogLevel::class);
  238.         if (!\is_array($functions = spl_autoload_functions())) {
  239.             return;
  240.         }
  242.         foreach ($functions as $function) {
  243.             spl_autoload_unregister($function);
  244.         }
  246.         foreach ($functions as $function) {
  247.             if (!\is_array($function) || !$function[0] instanceof self) {
  248.                 $function = [new static($function), 'loadClass'];
  249.             }
  251.             spl_autoload_register($function);
  252.         }
  253.     }
  255.     /**
  256.      * Disables the wrapping.
  257.      */
  258.     public static function disable(): void
  259.     {
  260.         if (!\is_array($functions = spl_autoload_functions())) {
  261.             return;
  262.         }
  264.         foreach ($functions as $function) {
  265.             spl_autoload_unregister($function);
  266.         }
  268.         foreach ($functions as $function) {
  269.             if (\is_array($function) && $function[0] instanceof self) {
  270.                 $function = $function[0]->getClassLoader();
  271.             }
  273.             spl_autoload_register($function);
  274.         }
  275.     }
  277.     public static function checkClasses(): bool
  278.     {
  279.         if (!\is_array($functions = spl_autoload_functions())) {
  280.             return false;
  281.         }
  283.         $loader = null;
  285.         foreach ($functions as $function) {
  286.             if (\is_array($function) && $function[0] instanceof self) {
  287.                 $loader = $function[0];
  288.                 break;
  289.             }
  290.         }
  292.         if (null === $loader) {
  293.             return false;
  294.         }
  296.         static $offsets = [
  297.             'get_declared_interfaces' => 0,
  298.             'get_declared_traits' => 0,
  299.             'get_declared_classes' => 0,
  300.         ];
  302.         foreach ($offsets as $getSymbols => $i) {
  303.             $symbols = $getSymbols();
  305.             for (; $i < \count($symbols); ++$i) {
  306.                 if (!is_subclass_of($symbols[$i], MockObject::class)
  307.                     && !is_subclass_of($symbols[$i], ProphecySubjectInterface::class)
  308.                     && !is_subclass_of($symbols[$i], Proxy::class)
  309.                     && !is_subclass_of($symbols[$i], ProxyInterface::class)
  310.                     && !is_subclass_of($symbols[$i], LegacyProxy::class)
  311.                     && !is_subclass_of($symbols[$i], MockInterface::class)
  312.                 ) {
  313.                     $loader->checkClass($symbols[$i]);
  314.                 }
  315.             }
  317.             $offsets[$getSymbols] = $i;
  318.         }
  320.         return true;
  321.     }
  323.     public function findFile(string $class): ?string
  324.     {
  325.         return $this->isFinder ? ($this->classLoader[0]->findFile($class) ?: null) : null;
  326.     }
  328.     /**
  329.      * Loads the given class or interface.
  330.      *
  331.      * @throws \RuntimeException
  332.      */
  333.     public function loadClass(string $class): void
  334.     {
  335.         $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  337.         try {
  338.             if ($this->isFinder && !isset($this->loaded[$class])) {
  339.                 $this->loaded[$class] = true;
  340.                 if (!$file = $this->classLoader[0]->findFile($class) ?: '') {
  341.                     // no-op
  342.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  343.                     include $file;
  345.                     return;
  346.                 } elseif (false === include $file) {
  347.                     return;
  348.                 }
  349.             } else {
  350.                 ($this->classLoader)($class);
  351.                 $file = '';
  352.             }
  353.         } finally {
  354.             error_reporting($e);
  355.         }
  357.         $this->checkClass($class, $file);
  358.     }
  360.     private function checkClass(string $class, string $file = null): void
  361.     {
  362.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  364.         if (null !== $file && $class && '\\' === $class[0]) {
  365.             $class = substr($class, 1);
  366.         }
  368.         if ($exists) {
  369.             if (isset(self::$checkedClasses[$class])) {
  370.                 return;
  371.             }
  372.             self::$checkedClasses[$class] = true;
  374.             $refl = new \ReflectionClass($class);
  375.             if (null === $file && $refl->isInternal()) {
  376.                 return;
  377.             }
  378.             $name = $refl->getName();
  380.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  381.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  382.             }
  384.             $deprecations = $this->checkAnnotations($refl, $name);
  386.             foreach ($deprecations as $message) {
  387.                 @trigger_error($message, \E_USER_DEPRECATED);
  388.             }
  389.         }
  391.         if (!$file) {
  392.             return;
  393.         }
  395.         if (!$exists) {
  396.             if (false !== strpos($class, '/')) {
  397.                 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));
  398.             }
  400.             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));
  401.         }
  403.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  404.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  405.         }
  406.     }
  408.     public function checkAnnotations(\ReflectionClass $refl, string $class): array
  409.     {
  410.         if (
  411.             'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV7' === $class
  412.             || 'Symfony\Bridge\PhpUnit\Legacy\SymfonyTestsListenerForV6' === $class
  413.             || 'Test\Symfony\Component\Debug\Tests' === $refl->getNamespaceName()
  414.         ) {
  415.             return [];
  416.         }
  417.         $deprecations = [];
  419.         $className = false !== strpos($class, "@anonymous\0") ? (get_parent_class($class) ?: key(class_implements($class)) ?: 'class').'@anonymous' : $class;
  421.         // Don't trigger deprecations for classes in the same vendor
  422.         if ($class !== $className) {
  423.             $vendor = preg_match('/^namespace ([^;\\\\\s]++)[;\\\\]/m', @file_get_contents($refl->getFileName()), $vendor) ? $vendor[1].'\\' : '';
  424.             $vendorLen = \strlen($vendor);
  425.         } elseif (2 > $vendorLen = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  426.             $vendorLen = 0;
  427.             $vendor = '';
  428.         } else {
  429.             $vendor = str_replace('_', '\\', substr($class, 0, $vendorLen));
  430.         }
  432.         // Detect annotations on the class
  433.         if (false !== $doc = $refl->getDocComment()) {
  434.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  435.                 if (false !== strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  436.                     self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  437.                 }
  438.             }
  440.             if ($refl->isInterface() && false !== strpos($doc, 'method') && preg_match_all('#\n \* @method\s+(static\s+)?+([\w\|&\[\]\\\]+\s+)?(\w+(?:\s*\([^\)]*\))?)+(.+?([[:punct:]]\s*)?)?(?=\r?\n \*(?: @|/$|\r?\n))#', $doc, $notice, \PREG_SET_ORDER)) {
  441.                 foreach ($notice as $method) {
  442.                     $static = '' !== $method[1] && !empty($method[2]);
  443.                     $name = $method[3];
  444.                     $description = $method[4] ?? null;
  445.                     if (false === strpos($name, '(')) {
  446.                         $name .= '()';
  447.                     }
  448.                     if (null !== $description) {
  449.                         $description = trim($description);
  450.                         if (!isset($method[5])) {
  451.                             $description .= '.';
  452.                         }
  453.                     }
  454.                     self::$method[$class][] = [$class, $name, $static, $description];
  455.                 }
  456.             }
  457.         }
  459.         $parent = get_parent_class($class) ?: null;
  460.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  461.         if ($parent) {
  462.             $parentAndOwnInterfaces[$parent] = $parent;
  464.             if (!isset(self::$checkedClasses[$parent])) {
  465.                 $this->checkClass($parent);
  466.             }
  468.             if (isset(self::$final[$parent])) {
  469.                 $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);
  470.             }
  471.         }
  473.         // Detect if the parent is annotated
  474.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  475.             if (!isset(self::$checkedClasses[$use])) {
  476.                 $this->checkClass($use);
  477.             }
  478.             if (isset(self::$deprecated[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen) && !isset(self::$deprecated[$class])) {
  479.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  480.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  482.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $className, $type, $verb, $use, self::$deprecated[$use]);
  483.             }
  484.             if (isset(self::$internal[$use]) && strncmp($vendor, str_replace('_', '\\', $use), $vendorLen)) {
  485.                 $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);
  486.             }
  487.             if (isset(self::$method[$use])) {
  488.                 if ($refl->isAbstract()) {
  489.                     if (isset(self::$method[$class])) {
  490.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  491.                     } else {
  492.                         self::$method[$class] = self::$method[$use];
  493.                     }
  494.                 } elseif (!$refl->isInterface()) {
  495.                     $hasCall = $refl->hasMethod('__call');
  496.                     $hasStaticCall = $refl->hasMethod('__callStatic');
  497.                     foreach (self::$method[$use] as $method) {
  498.                         [$interface, $name, $static, $description] = $method;
  499.                         if ($static ? $hasStaticCall : $hasCall) {
  500.                             continue;
  501.                         }
  502.                         $realName = substr($name, 0, strpos($name, '('));
  503.                         if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  504.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s"%s', $className, ($static ? 'static ' : '').$interface, $name, null == $description ? '.' : ': '.$description);
  505.                         }
  506.                     }
  507.                 }
  508.             }
  509.         }
  511.         if (trait_exists($class)) {
  512.             $file = $refl->getFileName();
  514.             foreach ($refl->getMethods() as $method) {
  515.                 if ($method->getFileName() === $file) {
  516.                     self::$methodTraits[$file][$method->getStartLine()] = $class;
  517.                 }
  518.             }
  520.             return $deprecations;
  521.         }
  523.         // Inherit @final, @internal, @param and @return annotations for methods
  524.         self::$finalMethods[$class] = [];
  525.         self::$internalMethods[$class] = [];
  526.         self::$annotatedParameters[$class] = [];
  527.         self::$returnTypes[$class] = [];
  528.         foreach ($parentAndOwnInterfaces as $use) {
  529.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters', 'returnTypes'] as $property) {
  530.                 if (isset(self::${$property}[$use])) {
  531.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  532.                 }
  533.             }
  535.             if (null !== (self::INTERNAL_TYPES[$use] ?? null)) {
  536.                 foreach (self::INTERNAL_TYPES[$use] as $method => $returnType) {
  537.                     if ('void' !== $returnType) {
  538.                         self::$returnTypes[$class] += [$method => [$returnType, $returnType, $use, '']];
  539.                     }
  540.                 }
  541.             }
  542.         }
  544.         foreach ($refl->getMethods() as $method) {
  545.             if ($method->class !== $class) {
  546.                 continue;
  547.             }
  549.             if (null === $ns = self::$methodTraits[$method->getFileName()][$method->getStartLine()] ?? null) {
  550.                 $ns = $vendor;
  551.                 $len = $vendorLen;
  552.             } elseif (2 > $len = 1 + (strpos($ns, '\\') ?: strpos($ns, '_'))) {
  553.                 $len = 0;
  554.                 $ns = '';
  555.             } else {
  556.                 $ns = str_replace('_', '\\', substr($ns, 0, $len));
  557.             }
  559.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  560.                 [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  561.                 $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);
  562.             }
  564.             if (isset(self::$internalMethods[$class][$method->name])) {
  565.                 [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  566.                 if (strncmp($ns, $declaringClass, $len)) {
  567.                     $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);
  568.                 }
  569.             }
  571.             // To read method annotations
  572.             $doc = $method->getDocComment();
  574.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  575.                 $definedParameters = [];
  576.                 foreach ($method->getParameters() as $parameter) {
  577.                     $definedParameters[$parameter->name] = true;
  578.                 }
  580.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  581.                     if (!isset($definedParameters[$parameterName]) && !($doc && preg_match("/\\n\\s+\\* @param +((?(?!callable *\().*?|callable *\(.*\).*?))(?<= )\\\${$parameterName}\\b/", $doc))) {
  582.                         $deprecations[] = sprintf($deprecation, $className);
  583.                     }
  584.                 }
  585.             }
  587.             $forcePatchTypes = $this->patchTypes['force'];
  589.             if ($canAddReturnType = null !== $forcePatchTypes && false === strpos($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  590.                 if ('void' !== (self::MAGIC_METHODS[$method->name] ?? 'void')) {
  591.                     $this->patchTypes['force'] = $forcePatchTypes ?: 'docblock';
  592.                 }
  594.                 $canAddReturnType = false !== strpos($refl->getFileName(), \DIRECTORY_SEPARATOR.'Tests'.\DIRECTORY_SEPARATOR)
  595.                     || $refl->isFinal()
  596.                     || $method->isFinal()
  597.                     || $method->isPrivate()
  598.                     || ('' === (self::$internal[$class] ?? null) && !$refl->isAbstract())
  599.                     || '' === (self::$final[$class] ?? null)
  600.                     || preg_match('/@(final|internal)$/m', $doc)
  601.                 ;
  602.             }
  604.             if (null !== ($returnType = self::$returnTypes[$class][$method->name] ?? self::MAGIC_METHODS[$method->name] ?? null) && !$method->hasReturnType() && !($doc && preg_match('/\n\s+\* @return +(\S+)/', $doc))) {
  605.                 [$normalizedType, $returnType, $declaringClass, $declaringFile] = \is_string($returnType) ? [$returnType, $returnType, '', ''] : $returnType;
  607.                 if ('void' === $normalizedType) {
  608.                     $canAddReturnType = false;
  609.                 }
  611.                 if ($canAddReturnType && 'docblock' !== $this->patchTypes['force']) {
  612.                     $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  613.                 }
  615.                 if (false === strpos($doc, '* @deprecated') && strncmp($ns, $declaringClass, $len)) {
  616.                     if ($canAddReturnType && 'docblock' === $this->patchTypes['force'] && false === strpos($method->getFileName(), \DIRECTORY_SEPARATOR.'vendor'.\DIRECTORY_SEPARATOR)) {
  617.                         $this->patchMethod($method, $returnType, $declaringFile, $normalizedType);
  618.                     } elseif ('' !== $declaringClass && $this->patchTypes['deprecations']) {
  619.                         $deprecations[] = sprintf('Method "%s::%s()" will return "%s" as of its next major version. Doing the same in %s "%s" will be required when upgrading.', $declaringClass, $method->name, $normalizedType, interface_exists($declaringClass) ? 'implementation' : 'child class', $className);
  620.                     }
  621.                 }
  622.             }
  624.             if (!$doc) {
  625.                 $this->patchTypes['force'] = $forcePatchTypes;
  627.                 continue;
  628.             }
  630.             $matches = [];
  632.             if (!$method->hasReturnType() && ((false !== strpos($doc, '@return') && preg_match('/\n\s+\* @return +(\S+)/', $doc, $matches)) || 'void' !== (self::MAGIC_METHODS[$method->name] ?? 'void'))) {
  633.                 $matches = $matches ?: [1 => self::MAGIC_METHODS[$method->name]];
  634.                 $this->setReturnType($matches[1], $method, $parent);
  636.                 if (isset(self::$returnTypes[$class][$method->name][0]) && $canAddReturnType) {
  637.                     $this->fixReturnStatements($method, self::$returnTypes[$class][$method->name][0]);
  638.                 }
  640.                 if ($method->isPrivate()) {
  641.                     unset(self::$returnTypes[$class][$method->name]);
  642.                 }
  643.             }
  645.             $this->patchTypes['force'] = $forcePatchTypes;
  647.             if ($method->isPrivate()) {
  648.                 continue;
  649.             }
  651.             $finalOrInternal = false;
  653.             foreach (['final', 'internal'] as $annotation) {
  654.                 if (false !== strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  655.                     $message = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  656.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, $message];
  657.                     $finalOrInternal = true;
  658.                 }
  659.             }
  661.             if ($finalOrInternal || $method->isConstructor() || false === strpos($doc, '@param') || StatelessInvocation::class === $class) {
  662.                 continue;
  663.             }
  664.             if (!preg_match_all('#\n\s+\* @param +((?(?!callable *\().*?|callable *\(.*\).*?))(?<= )\$([a-zA-Z0-9_\x7f-\xff]++)#', $doc, $matches, \PREG_SET_ORDER)) {
  665.                 continue;
  666.             }
  667.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  668.                 $definedParameters = [];
  669.                 foreach ($method->getParameters() as $parameter) {
  670.                     $definedParameters[$parameter->name] = true;
  671.                 }
  672.             }
  673.             foreach ($matches as [, $parameterType, $parameterName]) {
  674.                 if (!isset($definedParameters[$parameterName])) {
  675.                     $parameterType = trim($parameterType);
  676.                     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);
  677.                 }
  678.             }
  679.         }
  681.         return $deprecations;
  682.     }
  684.     public function checkCase(\ReflectionClass $refl, string $file, string $class): ?array
  685.     {
  686.         $real = explode('\\', $class.strrchr($file, '.'));
  687.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  689.         $i = \count($tail) - 1;
  690.         $j = \count($real) - 1;
  692.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  693.             --$i;
  694.             --$j;
  695.         }
  697.         array_splice($tail, 0, $i + 1);
  699.         if (!$tail) {
  700.             return null;
  701.         }
  703.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  704.         $tailLen = \strlen($tail);
  705.         $real = $refl->getFileName();
  707.         if (2 === self::$caseCheck) {
  708.             $real = $this->darwinRealpath($real);
  709.         }
  711.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  712.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  713.         ) {
  714.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  715.         }
  717.         return null;
  718.     }
  720.     /**
  721.      * `realpath` on MacOSX doesn't normalize the case of characters.
  722.      */
  723.     private function darwinRealpath(string $real): string
  724.     {
  725.         $i = 1 + strrpos($real, '/');
  726.         $file = substr($real, $i);
  727.         $real = substr($real, 0, $i);
  729.         if (isset(self::$darwinCache[$real])) {
  730.             $kDir = $real;
  731.         } else {
  732.             $kDir = strtolower($real);
  734.             if (isset(self::$darwinCache[$kDir])) {
  735.                 $real = self::$darwinCache[$kDir][0];
  736.             } else {
  737.                 $dir = getcwd();
  739.                 if (!@chdir($real)) {
  740.                     return $real.$file;
  741.                 }
  743.                 $real = getcwd().'/';
  744.                 chdir($dir);
  746.                 $dir = $real;
  747.                 $k = $kDir;
  748.                 $i = \strlen($dir) - 1;
  749.                 while (!isset(self::$darwinCache[$k])) {
  750.                     self::$darwinCache[$k] = [$dir, []];
  751.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  753.                     while ('/' !== $dir[--$i]) {
  754.                     }
  755.                     $k = substr($k, 0, ++$i);
  756.                     $dir = substr($dir, 0, $i--);
  757.                 }
  758.             }
  759.         }
  761.         $dirFiles = self::$darwinCache[$kDir][1];
  763.         if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  764.             // Get the file name from "file_name.php(123) : eval()'d code"
  765.             $file = substr($file, 0, strrpos($file, '(', -17));
  766.         }
  768.         if (isset($dirFiles[$file])) {
  769.             return $real .= $dirFiles[$file];
  770.         }
  772.         $kFile = strtolower($file);
  774.         if (!isset($dirFiles[$kFile])) {
  775.             foreach (scandir($real, 2) as $f) {
  776.                 if ('.' !== $f[0]) {
  777.                     $dirFiles[$f] = $f;
  778.                     if ($f === $file) {
  779.                         $kFile = $k = $file;
  780.                     } elseif ($f !== $k = strtolower($f)) {
  781.                         $dirFiles[$k] = $f;
  782.                     }
  783.                 }
  784.             }
  785.             self::$darwinCache[$kDir][1] = $dirFiles;
  786.         }
  788.         return $real .= $dirFiles[$kFile];
  789.     }
  791.     /**
  792.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  793.      *
  794.      * @return string[]
  795.      */
  796.     private function getOwnInterfaces(string $class, ?string $parent): array
  797.     {
  798.         $ownInterfaces = class_implements($class, false);
  800.         if ($parent) {
  801.             foreach (class_implements($parent, false) as $interface) {
  802.                 unset($ownInterfaces[$interface]);
  803.             }
  804.         }
  806.         foreach ($ownInterfaces as $interface) {
  807.             foreach (class_implements($interface) as $interface) {
  808.                 unset($ownInterfaces[$interface]);
  809.             }
  810.         }
  812.         return $ownInterfaces;
  813.     }
  815.     private function setReturnType(string $types, \ReflectionMethod $method, ?string $parent): void
  816.     {
  817.         $nullable = false;
  818.         $typesMap = [];
  819.         foreach (explode('|', $types) as $t) {
  820.             $typesMap[$this->normalizeType($t, $method->class, $parent)] = $t;
  821.         }
  823.         if (isset($typesMap['array'])) {
  824.             if (isset($typesMap['Traversable']) || isset($typesMap['\Traversable'])) {
  825.                 $typesMap['iterable'] = 'array' !== $typesMap['array'] ? $typesMap['array'] : 'iterable';
  826.                 unset($typesMap['array'], $typesMap['Traversable'], $typesMap['\Traversable']);
  827.             } elseif ('array' !== $typesMap['array'] && isset(self::$returnTypes[$method->class][$method->name])) {
  828.                 return;
  829.             }
  830.         }
  832.         if (isset($typesMap['array']) && isset($typesMap['iterable'])) {
  833.             if ('[]' === substr($typesMap['array'], -2)) {
  834.                 $typesMap['iterable'] = $typesMap['array'];
  835.             }
  836.             unset($typesMap['array']);
  837.         }
  839.         $iterable = $object = true;
  840.         foreach ($typesMap as $n => $t) {
  841.             if ('null' !== $n) {
  842.                 $iterable = $iterable && (\in_array($n, ['array', 'iterable']) || false !== strpos($n, 'Iterator'));
  843.                 $object = $object && (\in_array($n, ['callable', 'object', '$this', 'static']) || !isset(self::SPECIAL_RETURN_TYPES[$n]));
  844.             }
  845.         }
  847.         $normalizedType = key($typesMap);
  848.         $returnType = current($typesMap);
  850.         foreach ($typesMap as $n => $t) {
  851.             if ('null' === $n) {
  852.                 $nullable = true;
  853.             } elseif ('null' === $normalizedType) {
  854.                 $normalizedType = $t;
  855.                 $returnType = $t;
  856.             } elseif ($n !== $normalizedType || !preg_match('/^\\\\?[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+(?:\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*+)*+$/', $n)) {
  857.                 if ($iterable) {
  858.                     $normalizedType = $returnType = 'iterable';
  859.                 } elseif ($object && 'object' === $this->patchTypes['force']) {
  860.                     $normalizedType = $returnType = 'object';
  861.                 } else {
  862.                     // ignore multi-types return declarations
  863.                     return;
  864.                 }
  865.             }
  866.         }
  868.         if ('void' === $normalizedType || (\PHP_VERSION_ID >= 80000 && 'mixed' === $normalizedType)) {
  869.             $nullable = false;
  870.         } elseif (!isset(self::BUILTIN_RETURN_TYPES[$normalizedType]) && isset(self::SPECIAL_RETURN_TYPES[$normalizedType])) {
  871.             // ignore other special return types
  872.             return;
  873.         }
  875.         if ($nullable) {
  876.             $normalizedType = '?'.$normalizedType;
  877.             $returnType .= '|null';
  878.         }
  880.         self::$returnTypes[$method->class][$method->name] = [$normalizedType, $returnType, $method->class, $method->getFileName()];
  881.     }
  883.     private function normalizeType(string $type, string $class, ?string $parent): string
  884.     {
  885.         if (isset(self::SPECIAL_RETURN_TYPES[$lcType = strtolower($type)])) {
  886.             if ('parent' === $lcType = self::SPECIAL_RETURN_TYPES[$lcType]) {
  887.                 $lcType = null !== $parent ? '\\'.$parent : 'parent';
  888.             } elseif ('self' === $lcType) {
  889.                 $lcType = '\\'.$class;
  890.             }
  892.             return $lcType;
  893.         }
  895.         if ('[]' === substr($type, -2)) {
  896.             return 'array';
  897.         }
  899.         if (preg_match('/^(array|iterable|callable) *[<(]/', $lcType, $m)) {
  900.             return $m[1];
  901.         }
  903.         // We could resolve "use" statements to return the FQDN
  904.         // but this would be too expensive for a runtime checker
  906.         return $type;
  907.     }
  909.     /**
  910.      * Utility method to add @return annotations to the Symfony code-base where it triggers a self-deprecations.
  911.      */
  912.     private function patchMethod(\ReflectionMethod $method, string $returnType, string $declaringFile, string $normalizedType)
  913.     {
  914.         static $patchedMethods = [];
  915.         static $useStatements = [];
  917.         if (!file_exists($file = $method->getFileName()) || isset($patchedMethods[$file][$startLine = $method->getStartLine()])) {
  918.             return;
  919.         }
  921.         $patchedMethods[$file][$startLine] = true;
  922.         $fileOffset = self::$fileOffsets[$file] ?? 0;
  923.         $startLine += $fileOffset - 2;
  924.         $nullable = '?' === $normalizedType[0] ? '?' : '';
  925.         $normalizedType = ltrim($normalizedType, '?');
  926.         $returnType = explode('|', $returnType);
  927.         $code = file($file);
  929.         foreach ($returnType as $i => $type) {
  930.             if (preg_match('/((?:\[\])+)$/', $type, $m)) {
  931.                 $type = substr($type, 0, -\strlen($m[1]));
  932.                 $format = '%s'.$m[1];
  933.             } elseif (preg_match('/^(array|iterable)<([^,>]++)>$/', $type, $m)) {
  934.                 $type = $m[2];
  935.                 $format = $m[1].'<%s>';
  936.             } else {
  937.                 $format = null;
  938.             }
  940.             if (isset(self::SPECIAL_RETURN_TYPES[$type]) || ('\\' === $type[0] && !$p = strrpos($type, '\\', 1))) {
  941.                 continue;
  942.             }
  944.             [$namespace, $useOffset, $useMap] = $useStatements[$file] ?? $useStatements[$file] = self::getUseStatements($file);
  946.             if ('\\' !== $type[0]) {
  947.                 [$declaringNamespace, , $declaringUseMap] = $useStatements[$declaringFile] ?? $useStatements[$declaringFile] = self::getUseStatements($declaringFile);
  949.                 $p = strpos($type, '\\', 1);
  950.                 $alias = $p ? substr($type, 0, $p) : $type;
  952.                 if (isset($declaringUseMap[$alias])) {
  953.                     $type = '\\'.$declaringUseMap[$alias].($p ? substr($type, $p) : '');
  954.                 } else {
  955.                     $type = '\\'.$declaringNamespace.$type;
  956.                 }
  958.                 $p = strrpos($type, '\\', 1);
  959.             }
  961.             $alias = substr($type, 1 + $p);
  962.             $type = substr($type, 1);
  964.             if (!isset($useMap[$alias]) && (class_exists($c = $namespace.$alias) || interface_exists($c) || trait_exists($c))) {
  965.                 $useMap[$alias] = $c;
  966.             }
  968.             if (!isset($useMap[$alias])) {
  969.                 $useStatements[$file][2][$alias] = $type;
  970.                 $code[$useOffset] = "use $type;\n".$code[$useOffset];
  971.                 ++$fileOffset;
  972.             } elseif ($useMap[$alias] !== $type) {
  973.                 $alias .= 'FIXME';
  974.                 $useStatements[$file][2][$alias] = $type;
  975.                 $code[$useOffset] = "use $type as $alias;\n".$code[$useOffset];
  976.                 ++$fileOffset;
  977.             }
  979.             $returnType[$i] = null !== $format ? sprintf($format, $alias) : $alias;
  981.             if (!isset(self::SPECIAL_RETURN_TYPES[$normalizedType]) && !isset(self::SPECIAL_RETURN_TYPES[$returnType[$i]])) {
  982.                 $normalizedType = $returnType[$i];
  983.             }
  984.         }
  986.         if ('docblock' === $this->patchTypes['force'] || ('object' === $normalizedType && '7.1' === $this->patchTypes['php'])) {
  987.             $returnType = implode('|', $returnType);
  989.             if ($method->getDocComment()) {
  990.                 $code[$startLine] = "     * @return $returnType\n".$code[$startLine];
  991.             } else {
  992.                 $code[$startLine] .= <<<EOTXT
  993.     /**
  994.      * @return $returnType
  995.      */
  997. EOTXT;
  998.             }
  1000.             $fileOffset += substr_count($code[$startLine], "\n") - 1;
  1001.         }
  1003.         self::$fileOffsets[$file] = $fileOffset;
  1004.         file_put_contents($file, $code);
  1006.         $this->fixReturnStatements($method, $nullable.$normalizedType);
  1007.     }
  1009.     private static function getUseStatements(string $file): array
  1010.     {
  1011.         $namespace = '';
  1012.         $useMap = [];
  1013.         $useOffset = 0;
  1015.         if (!file_exists($file)) {
  1016.             return [$namespace, $useOffset, $useMap];
  1017.         }
  1019.         $file = file($file);
  1021.         for ($i = 0; $i < \count($file); ++$i) {
  1022.             if (preg_match('/^(class|interface|trait|abstract) /', $file[$i])) {
  1023.                 break;
  1024.             }
  1026.             if (0 === strpos($file[$i], 'namespace ')) {
  1027.                 $namespace = substr($file[$i], \strlen('namespace '), -2).'\\';
  1028.                 $useOffset = $i + 2;
  1029.             }
  1031.             if (0 === strpos($file[$i], 'use ')) {
  1032.                 $useOffset = $i;
  1034.                 for (; 0 === strpos($file[$i], 'use '); ++$i) {
  1035.                     $u = explode(' as ', substr($file[$i], 4, -2), 2);
  1037.                     if (1 === \count($u)) {
  1038.                         $p = strrpos($u[0], '\\');
  1039.                         $useMap[substr($u[0], false !== $p ? 1 + $p : 0)] = $u[0];
  1040.                     } else {
  1041.                         $useMap[$u[1]] = $u[0];
  1042.                     }
  1043.                 }
  1045.                 break;
  1046.             }
  1047.         }
  1049.         return [$namespace, $useOffset, $useMap];
  1050.     }
  1052.     private function fixReturnStatements(\ReflectionMethod $method, string $returnType)
  1053.     {
  1054.         if ('7.1' === $this->patchTypes['php'] && 'object' === ltrim($returnType, '?') && 'docblock' !== $this->patchTypes['force']) {
  1055.             return;
  1056.         }
  1058.         if (!file_exists($file = $method->getFileName())) {
  1059.             return;
  1060.         }
  1062.         $fixedCode = $code = file($file);
  1063.         $i = (self::$fileOffsets[$file] ?? 0) + $method->getStartLine();
  1065.         if ('?' !== $returnType && 'docblock' !== $this->patchTypes['force']) {
  1066.             $fixedCode[$i - 1] = preg_replace('/\)(;?\n)/', "): $returnType\\1", $code[$i - 1]);
  1067.         }
  1069.         $end = $method->isGenerator() ? $i : $method->getEndLine();
  1070.         for (; $i < $end; ++$i) {
  1071.             if ('void' === $returnType) {
  1072.                 $fixedCode[$i] = str_replace('    return null;', '    return;', $code[$i]);
  1073.             } elseif ('mixed' === $returnType || '?' === $returnType[0]) {
  1074.                 $fixedCode[$i] = str_replace('    return;', '    return null;', $code[$i]);
  1075.             } else {
  1076.                 $fixedCode[$i] = str_replace('    return;', "    return $returnType!?;", $code[$i]);
  1077.             }
  1078.         }
  1080.         if ($fixedCode !== $code) {
  1081.             file_put_contents($file, $fixedCode);
  1082.         }
  1083.     }
  1084. }