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

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