vendor/symfony/debug/DebugClassLoader.php line 163

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\Debug;
  14. use PHPUnit\Framework\MockObject\Matcher\StatelessInvocation;
  16. @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.4, use "%s" instead.', DebugClassLoader::class, \Symfony\Component\ErrorHandler\DebugClassLoader::class), \E_USER_DEPRECATED);
  18. /**
  19.  * Autoloader checking if the class is really defined in the file found.
  20.  *
  21.  * The ClassLoader will wrap all registered autoloaders
  22.  * and will throw an exception if a file is found but does
  23.  * not declare the class.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  * @author Christophe Coevoet <stof@notk.org>
  27.  * @author Nicolas Grekas <p@tchwork.com>
  28.  * @author Guilhem Niot <guilhem.niot@gmail.com>
  29.  *
  30.  * @deprecated since Symfony 4.4, use Symfony\Component\ErrorHandler\DebugClassLoader instead.
  31.  */
  32. class DebugClassLoader
  33. {
  34.     private $classLoader;
  35.     private $isFinder;
  36.     private $loaded = [];
  37.     private static $caseCheck;
  38.     private static $checkedClasses = [];
  39.     private static $final = [];
  40.     private static $finalMethods = [];
  41.     private static $deprecated = [];
  42.     private static $internal = [];
  43.     private static $internalMethods = [];
  44.     private static $annotatedParameters = [];
  45.     private static $darwinCache = ['/' => ['/', []]];
  46.     private static $method = [];
  48.     public function __construct(callable $classLoader)
  49.     {
  50.         $this->classLoader = $classLoader;
  51.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  53.         if (!isset(self::$caseCheck)) {
  54.             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  55.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  56.             $dir = substr($file, 0, 1 + $i);
  57.             $file = substr($file, 1 + $i);
  58.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  59.             $test = realpath($dir.$test);
  61.             if (false === $test || false === $i) {
  62.                 // filesystem is case sensitive
  63.                 self::$caseCheck = 0;
  64.             } elseif (substr($test, -\strlen($file)) === $file) {
  65.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  66.                 self::$caseCheck = 1;
  67.             } elseif (false !== stripos(\PHP_OS, 'darwin')) {
  68.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  69.                 self::$caseCheck = 2;
  70.             } else {
  71.                 // filesystem case checks failed, fallback to disabling them
  72.                 self::$caseCheck = 0;
  73.             }
  74.         }
  75.     }
  77.     /**
  78.      * Gets the wrapped class loader.
  79.      *
  80.      * @return callable The wrapped class loader
  81.      */
  82.     public function getClassLoader()
  83.     {
  84.         return $this->classLoader;
  85.     }
  87.     /**
  88.      * Wraps all autoloaders.
  89.      */
  90.     public static function enable()
  91.     {
  92.         // Ensures we don't hit https://bugs.php.net/42098
  93.         class_exists(\Symfony\Component\Debug\ErrorHandler::class);
  94.         class_exists(\Psr\Log\LogLevel::class);
  96.         if (!\is_array($functions = spl_autoload_functions())) {
  97.             return;
  98.         }
  100.         foreach ($functions as $function) {
  101.             spl_autoload_unregister($function);
  102.         }
  104.         foreach ($functions as $function) {
  105.             if (!\is_array($function) || !$function[0] instanceof self) {
  106.                 $function = [new static($function), 'loadClass'];
  107.             }
  109.             spl_autoload_register($function);
  110.         }
  111.     }
  113.     /**
  114.      * Disables the wrapping.
  115.      */
  116.     public static function disable()
  117.     {
  118.         if (!\is_array($functions = spl_autoload_functions())) {
  119.             return;
  120.         }
  122.         foreach ($functions as $function) {
  123.             spl_autoload_unregister($function);
  124.         }
  126.         foreach ($functions as $function) {
  127.             if (\is_array($function) && $function[0] instanceof self) {
  128.                 $function = $function[0]->getClassLoader();
  129.             }
  131.             spl_autoload_register($function);
  132.         }
  133.     }
  135.     /**
  136.      * @return string|null
  137.      */
  138.     public function findFile($class)
  139.     {
  140.         return $this->isFinder ? $this->classLoader[0]->findFile($class) ?: null : null;
  141.     }
  143.     /**
  144.      * Loads the given class or interface.
  145.      *
  146.      * @param string $class The name of the class
  147.      *
  148.      * @throws \RuntimeException
  149.      */
  150.     public function loadClass($class)
  151.     {
  152.         $e = error_reporting(error_reporting() | \E_PARSE | \E_ERROR | \E_CORE_ERROR | \E_COMPILE_ERROR);
  154.         try {
  155.             if ($this->isFinder && !isset($this->loaded[$class])) {
  156.                 $this->loaded[$class] = true;
  157.                 if (!$file = $this->classLoader[0]->findFile($class) ?: false) {
  158.                     // no-op
  159.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  160.                     include $file;
  162.                     return;
  163.                 } elseif (false === include $file) {
  164.                     return;
  165.                 }
  166.             } else {
  167.                 ($this->classLoader)($class);
  168.                 $file = false;
  169.             }
  170.         } finally {
  171.             error_reporting($e);
  172.         }
  174.         $this->checkClass($class, $file);
  175.     }
  177.     private function checkClass(string $class, string $file = null)
  178.     {
  179.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  181.         if (null !== $file && $class && '\\' === $class[0]) {
  182.             $class = substr($class, 1);
  183.         }
  185.         if ($exists) {
  186.             if (isset(self::$checkedClasses[$class])) {
  187.                 return;
  188.             }
  189.             self::$checkedClasses[$class] = true;
  191.             $refl = new \ReflectionClass($class);
  192.             if (null === $file && $refl->isInternal()) {
  193.                 return;
  194.             }
  195.             $name = $refl->getName();
  197.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  198.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  199.             }
  201.             $deprecations = $this->checkAnnotations($refl, $name);
  203.             foreach ($deprecations as $message) {
  204.                 @trigger_error($message, \E_USER_DEPRECATED);
  205.             }
  206.         }
  208.         if (!$file) {
  209.             return;
  210.         }
  212.         if (!$exists) {
  213.             if (false !== strpos($class, '/')) {
  214.                 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));
  215.             }
  217.             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));
  218.         }
  220.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  221.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  222.         }
  223.     }
  225.     public function checkAnnotations(\ReflectionClass $refl, $class)
  226.     {
  227.         $deprecations = [];
  229.         // Don't trigger deprecations for classes in the same vendor
  230.         if (2 > $len = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  231.             $len = 0;
  232.             $ns = '';
  233.         } else {
  234.             $ns = str_replace('_', '\\', substr($class, 0, $len));
  235.         }
  237.         // Detect annotations on the class
  238.         if (false !== $doc = $refl->getDocComment()) {
  239.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  240.                 if (false !== strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  241.                     self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  242.                 }
  243.             }
  245.             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)) {
  246.                 foreach ($notice as $method) {
  247.                     $static = '' !== $method[1];
  248.                     $name = $method[2];
  249.                     $description = $method[3] ?? null;
  250.                     if (false === strpos($name, '(')) {
  251.                         $name .= '()';
  252.                     }
  253.                     if (null !== $description) {
  254.                         $description = trim($description);
  255.                         if (!isset($method[4])) {
  256.                             $description .= '.';
  257.                         }
  258.                     }
  259.                     self::$method[$class][] = [$class, $name, $static, $description];
  260.                 }
  261.             }
  262.         }
  264.         $parent = get_parent_class($class);
  265.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent ?: null);
  266.         if ($parent) {
  267.             $parentAndOwnInterfaces[$parent] = $parent;
  269.             if (!isset(self::$checkedClasses[$parent])) {
  270.                 $this->checkClass($parent);
  271.             }
  273.             if (isset(self::$final[$parent])) {
  274.                 $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], $class);
  275.             }
  276.         }
  278.         // Detect if the parent is annotated
  279.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  280.             if (!isset(self::$checkedClasses[$use])) {
  281.                 $this->checkClass($use);
  282.             }
  283.             if (isset(self::$deprecated[$use]) && strncmp($ns, str_replace('_', '\\', $use), $len) && !isset(self::$deprecated[$class])) {
  284.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  285.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  287.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $class, $type, $verb, $use, self::$deprecated[$use]);
  288.             }
  289.             if (isset(self::$internal[$use]) && strncmp($ns, str_replace('_', '\\', $use), $len)) {
  290.                 $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], $class);
  291.             }
  292.             if (isset(self::$method[$use])) {
  293.                 if ($refl->isAbstract()) {
  294.                     if (isset(self::$method[$class])) {
  295.                         self::$method[$class] = array_merge(self::$method[$class], self::$method[$use]);
  296.                     } else {
  297.                         self::$method[$class] = self::$method[$use];
  298.                     }
  299.                 } elseif (!$refl->isInterface()) {
  300.                     $hasCall = $refl->hasMethod('__call');
  301.                     $hasStaticCall = $refl->hasMethod('__callStatic');
  302.                     foreach (self::$method[$use] as $method) {
  303.                         [$interface, $name, $static, $description] = $method;
  304.                         if ($static ? $hasStaticCall : $hasCall) {
  305.                             continue;
  306.                         }
  307.                         $realName = substr($name, 0, strpos($name, '('));
  308.                         if (!$refl->hasMethod($realName) || !($methodRefl = $refl->getMethod($realName))->isPublic() || ($static && !$methodRefl->isStatic()) || (!$static && $methodRefl->isStatic())) {
  309.                             $deprecations[] = sprintf('Class "%s" should implement method "%s::%s"%s', $class, ($static ? 'static ' : '').$interface, $name, null == $description ? '.' : ': '.$description);
  310.                         }
  311.                     }
  312.                 }
  313.             }
  314.         }
  316.         if (trait_exists($class)) {
  317.             return $deprecations;
  318.         }
  320.         // Inherit @final, @internal and @param annotations for methods
  321.         self::$finalMethods[$class] = [];
  322.         self::$internalMethods[$class] = [];
  323.         self::$annotatedParameters[$class] = [];
  324.         foreach ($parentAndOwnInterfaces as $use) {
  325.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters'] as $property) {
  326.                 if (isset(self::${$property}[$use])) {
  327.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  328.                 }
  329.             }
  330.         }
  332.         foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  333.             if ($method->class !== $class) {
  334.                 continue;
  335.             }
  337.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  338.                 [$declaringClass, $message] = self::$finalMethods[$parent][$method->name];
  339.                 $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, $class);
  340.             }
  342.             if (isset(self::$internalMethods[$class][$method->name])) {
  343.                 [$declaringClass, $message] = self::$internalMethods[$class][$method->name];
  344.                 if (strncmp($ns, $declaringClass, $len)) {
  345.                     $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, $class);
  346.                 }
  347.             }
  349.             // To read method annotations
  350.             $doc = $method->getDocComment();
  352.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  353.                 $definedParameters = [];
  354.                 foreach ($method->getParameters() as $parameter) {
  355.                     $definedParameters[$parameter->name] = true;
  356.                 }
  358.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  359.                     if (!isset($definedParameters[$parameterName]) && !($doc && preg_match("/\\n\\s+\\* @param +((?(?!callable *\().*?|callable *\(.*\).*?))(?<= )\\\${$parameterName}\\b/", $doc))) {
  360.                         $deprecations[] = sprintf($deprecation, $class);
  361.                     }
  362.                 }
  363.             }
  365.             if (!$doc) {
  366.                 continue;
  367.             }
  369.             $finalOrInternal = false;
  371.             foreach (['final', 'internal'] as $annotation) {
  372.                 if (false !== strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  373.                     $message = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  374.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, $message];
  375.                     $finalOrInternal = true;
  376.                 }
  377.             }
  379.             if ($finalOrInternal || $method->isConstructor() || false === strpos($doc, '@param') || StatelessInvocation::class === $class) {
  380.                 continue;
  381.             }
  382.             if (!preg_match_all('#\n\s+\* @param +((?(?!callable *\().*?|callable *\(.*\).*?))(?<= )\$([a-zA-Z0-9_\x7f-\xff]++)#', $doc, $matches, \PREG_SET_ORDER)) {
  383.                 continue;
  384.             }
  385.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  386.                 $definedParameters = [];
  387.                 foreach ($method->getParameters() as $parameter) {
  388.                     $definedParameters[$parameter->name] = true;
  389.                 }
  390.             }
  391.             foreach ($matches as [, $parameterType, $parameterName]) {
  392.                 if (!isset($definedParameters[$parameterName])) {
  393.                     $parameterType = trim($parameterType);
  394.                     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($class) ? 'interface' : 'parent class', $method->class);
  395.                 }
  396.             }
  397.         }
  399.         return $deprecations;
  400.     }
  402.     /**
  403.      * @param string $file
  404.      * @param string $class
  405.      *
  406.      * @return array|null
  407.      */
  408.     public function checkCase(\ReflectionClass $refl, $file, $class)
  409.     {
  410.         $real = explode('\\', $class.strrchr($file, '.'));
  411.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  413.         $i = \count($tail) - 1;
  414.         $j = \count($real) - 1;
  416.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  417.             --$i;
  418.             --$j;
  419.         }
  421.         array_splice($tail, 0, $i + 1);
  423.         if (!$tail) {
  424.             return null;
  425.         }
  427.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  428.         $tailLen = \strlen($tail);
  429.         $real = $refl->getFileName();
  431.         if (2 === self::$caseCheck) {
  432.             $real = $this->darwinRealpath($real);
  433.         }
  435.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  436.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  437.         ) {
  438.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  439.         }
  441.         return null;
  442.     }
  444.     /**
  445.      * `realpath` on MacOSX doesn't normalize the case of characters.
  446.      */
  447.     private function darwinRealpath(string $real): string
  448.     {
  449.         $i = 1 + strrpos($real, '/');
  450.         $file = substr($real, $i);
  451.         $real = substr($real, 0, $i);
  453.         if (isset(self::$darwinCache[$real])) {
  454.             $kDir = $real;
  455.         } else {
  456.             $kDir = strtolower($real);
  458.             if (isset(self::$darwinCache[$kDir])) {
  459.                 $real = self::$darwinCache[$kDir][0];
  460.             } else {
  461.                 $dir = getcwd();
  463.                 if (!@chdir($real)) {
  464.                     return $real.$file;
  465.                 }
  467.                 $real = getcwd().'/';
  468.                 chdir($dir);
  470.                 $dir = $real;
  471.                 $k = $kDir;
  472.                 $i = \strlen($dir) - 1;
  473.                 while (!isset(self::$darwinCache[$k])) {
  474.                     self::$darwinCache[$k] = [$dir, []];
  475.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  477.                     while ('/' !== $dir[--$i]) {
  478.                     }
  479.                     $k = substr($k, 0, ++$i);
  480.                     $dir = substr($dir, 0, $i--);
  481.                 }
  482.             }
  483.         }
  485.         $dirFiles = self::$darwinCache[$kDir][1];
  487.         if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  488.             // Get the file name from "file_name.php(123) : eval()'d code"
  489.             $file = substr($file, 0, strrpos($file, '(', -17));
  490.         }
  492.         if (isset($dirFiles[$file])) {
  493.             return $real.$dirFiles[$file];
  494.         }
  496.         $kFile = strtolower($file);
  498.         if (!isset($dirFiles[$kFile])) {
  499.             foreach (scandir($real, 2) as $f) {
  500.                 if ('.' !== $f[0]) {
  501.                     $dirFiles[$f] = $f;
  502.                     if ($f === $file) {
  503.                         $kFile = $k = $file;
  504.                     } elseif ($f !== $k = strtolower($f)) {
  505.                         $dirFiles[$k] = $f;
  506.                     }
  507.                 }
  508.             }
  509.             self::$darwinCache[$kDir][1] = $dirFiles;
  510.         }
  512.         return $real.$dirFiles[$kFile];
  513.     }
  515.     /**
  516.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  517.      *
  518.      * @return string[]
  519.      */
  520.     private function getOwnInterfaces(string $class, ?string $parent): array
  521.     {
  522.         $ownInterfaces = class_implements($class, false);
  524.         if ($parent) {
  525.             foreach (class_implements($parent, false) as $interface) {
  526.                 unset($ownInterfaces[$interface]);
  527.             }
  528.         }
  530.         foreach ($ownInterfaces as $interface) {
  531.             foreach (class_implements($interface) as $interface) {
  532.                 unset($ownInterfaces[$interface]);
  533.             }
  534.         }
  536.         return $ownInterfaces;
  537.     }
  538. }