vendor/symfony/debug/DebugClassLoader.php line 192

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. /**
  17.  * Autoloader checking if the class is really defined in the file found.
  18.  *
  19.  * The ClassLoader will wrap all registered autoloaders
  20.  * and will throw an exception if a file is found but does
  21.  * not declare the class.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  * @author Christophe Coevoet <stof@notk.org>
  25.  * @author Nicolas Grekas <p@tchwork.com>
  26.  * @author Guilhem Niot <guilhem.niot@gmail.com>
  27.  */
  28. class DebugClassLoader {
  30.     private $classLoader;
  31.     private $isFinder;
  32.     private $loaded = [];
  33.     private static $caseCheck;
  34.     private static $checkedClasses = [];
  35.     private static $final = [];
  36.     private static $finalMethods = [];
  37.     private static $deprecated = [];
  38.     private static $internal = [];
  39.     private static $internalMethods = [];
  40.     private static $annotatedParameters = [];
  41.     private static $darwinCache = ['/' => ['/', []]];
  43.     public function __construct(callable $classLoader) {
  44.         $this->classLoader = $classLoader;
  45.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  47.         if (!isset(self::$caseCheck)) {
  48.             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  49.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  50.             $dir = substr($file, 0, 1 + $i);
  51.             $file = substr($file, 1 + $i);
  52.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  53.             $test = realpath($dir . $test);
  55.             if (false === $test || false === $i) {
  56.                 // filesystem is case sensitive
  57.                 self::$caseCheck = 0;
  58.             } elseif (substr($test, -\strlen($file)) === $file) {
  59.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  60.                 self::$caseCheck = 1;
  61.             } elseif (false !== stripos(PHP_OS, 'darwin')) {
  62.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  63.                 self::$caseCheck = 2;
  64.             } else {
  65.                 // filesystem case checks failed, fallback to disabling them
  66.                 self::$caseCheck = 0;
  67.             }
  68.         }
  69.     }
  71.     /**
  72.      * Gets the wrapped class loader.
  73.      *
  74.      * @return callable The wrapped class loader
  75.      */
  76.     public function getClassLoader() {
  77.         return $this->classLoader;
  78.     }
  80.     /**
  81.      * Wraps all autoloaders.
  82.      */
  83.     public static function enable() {
  84.         // Ensures we don't hit https://bugs.php.net/42098
  85.         class_exists('Symfony\Component\Debug\ErrorHandler');
  86.         class_exists('Psr\Log\LogLevel');
  88.         if (!\is_array($functions = spl_autoload_functions())) {
  89.             return;
  90.         }
  92.         foreach ($functions as $function) {
  93.             spl_autoload_unregister($function);
  94.         }
  96.         foreach ($functions as $function) {
  97.             if (!\is_array($function) || !$function[0] instanceof self) {
  98.                 $function = [new static($function), 'loadClass'];
  99.             }
  101.             spl_autoload_register($function);
  102.         }
  103.     }
  105.     /**
  106.      * Disables the wrapping.
  107.      */
  108.     public static function disable() {
  109.         if (!\is_array($functions = spl_autoload_functions())) {
  110.             return;
  111.         }
  113.         foreach ($functions as $function) {
  114.             spl_autoload_unregister($function);
  115.         }
  117.         foreach ($functions as $function) {
  118.             if (\is_array($function) && $function[0] instanceof self) {
  119.                 $function = $function[0]->getClassLoader();
  120.             }
  122.             spl_autoload_register($function);
  123.         }
  124.     }
  126.     /**
  127.      * @return string|null
  128.      */
  129.     public function findFile($class) {
  130.         return $this->isFinder ? $this->classLoader[0]->findFile($class) ?: null : null;
  131.     }
  133.     /**
  134.      * Loads the given class or interface.
  135.      *
  136.      * @param string $class The name of the class
  137.      *
  138.      * @throws \RuntimeException
  139.      */
  140.     public function loadClass($class) {
  141.         $e = error_reporting(error_reporting() | E_PARSE | E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR);
  143.         try {
  144.             if ($this->isFinder && !isset($this->loaded[$class])) {
  145.                 $this->loaded[$class] = true;
  146.                 if (!$file = $this->classLoader[0]->findFile($class) ?: false) {
  147.                     // no-op
  148.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  149.                     include $file;
  151.                     return;
  152.                 } elseif (false === include $file) {
  153.                     return;
  154.                 }
  155.             } else {
  156.                 ($this->classLoader)($class);
  157.                 $file = false;
  158.             }
  159.         } finally {
  160.             error_reporting($e);
  161.         }
  163.         $this->checkClass($class, $file);
  164.     }
  166.     private function checkClass($class, $file = null) {
  167.         $exists = null === $file || class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  169.         if (null !== $file && $class && '\\' === $class[0]) {
  170.             $class = substr($class, 1);
  171.         }
  173.         if ($exists) {
  174.             if (isset(self::$checkedClasses[$class])) {
  175.                 return;
  176.             }
  177.             self::$checkedClasses[$class] = true;
  179.             $refl = new \ReflectionClass($class);
  180.             if (null === $file && $refl->isInternal()) {
  181.                 return;
  182.             }
  183.             $name = $refl->getName();
  185.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  186.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  187.             }
  189.             $deprecations = $this->checkAnnotations($refl, $name);
  191.             foreach ($deprecations as $message) {
  192.                 @trigger_error($message, E_USER_DEPRECATED);
  193.             }
  194.         }
  196.         if (!$file) {
  197.             return;
  198.         }
  200.         if (!$exists) {
  201.             if (false !== strpos($class, '/')) {
  202.                 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));
  203.             }
  205.             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));
  206.         }
  208.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  209.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  210.         }
  211.     }
  213.     public function checkAnnotations(\ReflectionClass $refl, $class) {
  214.         $deprecations = [];
  216.         // Don't trigger deprecations for classes in the same vendor
  217.         if (2 > $len = 1 + (strpos($class, '\\') ?: strpos($class, '_'))) {
  218.             $len = 0;
  219.             $ns = '';
  220.         } else {
  221.             $ns = str_replace('_', '\\', substr($class, 0, $len));
  222.         }
  224.         // Detect annotations on the class
  225.         if (false !== $doc = $refl->getDocComment()) {
  226.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  227.                 if (false !== strpos($doc, $annotation) && preg_match('#\n\s+\* @' . $annotation . '(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  228.                     self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  229.                 }
  230.             }
  231.         }
  233.         $parent = get_parent_class($class);
  234.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  235.         if ($parent) {
  236.             $parentAndOwnInterfaces[$parent] = $parent;
  238.             if (!isset(self::$checkedClasses[$parent])) {
  239.                 $this->checkClass($parent);
  240.             }
  242.             if (isset(self::$final[$parent])) {
  243.                 $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);
  244.             }
  245.         }
  247.         // Detect if the parent is annotated
  248.         foreach ($parentAndOwnInterfaces + class_uses($class, false) as $use) {
  249.             if (!isset(self::$checkedClasses[$use])) {
  250.                 $this->checkClass($use);
  251.             }
  252.             if (isset(self::$deprecated[$use]) && strncmp($ns, str_replace('_', '\\', $use), $len) && !isset(self::$deprecated[$class])) {
  253.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  254.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  256.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $class, $type, $verb, $use, self::$deprecated[$use]);
  257.             }
  258.             if (isset(self::$internal[$use]) && strncmp($ns, str_replace('_', '\\', $use), $len)) {
  259.                 $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);
  260.             }
  261.         }
  263.         if (trait_exists($class)) {
  264.             return $deprecations;
  265.         }
  267.         // Inherit @final, @internal and @param annotations for methods
  268.         self::$finalMethods[$class] = [];
  269.         self::$internalMethods[$class] = [];
  270.         self::$annotatedParameters[$class] = [];
  271.         foreach ($parentAndOwnInterfaces as $use) {
  272.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters'] as $property) {
  273.                 if (isset(self::${$property}[$use])) {
  274.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  275.                 }
  276.             }
  277.         }
  279.         foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  280.             if ($method->class !== $class) {
  281.                 continue;
  282.             }
  284.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  285.                 list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
  286.                 $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);
  287.             }
  289.             if (isset(self::$internalMethods[$class][$method->name])) {
  290.                 list($declaringClass, $message) = self::$internalMethods[$class][$method->name];
  291.                 if (strncmp($ns, $declaringClass, $len)) {
  292.                     $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);
  293.                 }
  294.             }
  296.             // To read method annotations
  297.             $doc = $method->getDocComment();
  299.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  300.                 $definedParameters = [];
  301.                 foreach ($method->getParameters() as $parameter) {
  302.                     $definedParameters[$parameter->name] = true;
  303.                 }
  305.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  306.                     if (!isset($definedParameters[$parameterName]) && !($doc && preg_match("/\\n\\s+\\* @param (.*?)(?<= )\\\${$parameterName}\\b/", $doc))) {
  307.                         $deprecations[] = sprintf($deprecation, $class);
  308.                     }
  309.                 }
  310.             }
  312.             if (!$doc) {
  313.                 continue;
  314.             }
  316.             $finalOrInternal = false;
  318.             foreach (['final', 'internal'] as $annotation) {
  319.                 if (false !== strpos($doc, $annotation) && preg_match('#\n\s+\* @' . $annotation . '(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  320.                     $message = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  321.                     self::${$annotation . 'Methods'}[$class][$method->name] = [$class, $message];
  322.                     $finalOrInternal = true;
  323.                 }
  324.             }
  326.             if ($finalOrInternal || $method->isConstructor() || false === strpos($doc, '@param') || StatelessInvocation::class === $class) {
  327.                 continue;
  328.             }
  329.             if (!preg_match_all('#\n\s+\* @param (.*?)(?<= )\$([a-zA-Z0-9_\x7f-\xff]++)#', $doc, $matches, PREG_SET_ORDER)) {
  330.                 continue;
  331.             }
  332.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  333.                 $definedParameters = [];
  334.                 foreach ($method->getParameters() as $parameter) {
  335.                     $definedParameters[$parameter->name] = true;
  336.                 }
  337.             }
  338.             foreach ($matches as list(, $parameterType, $parameterName)) {
  339.                 if (!isset($definedParameters[$parameterName])) {
  340.                     $parameterType = trim($parameterType);
  341.                     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, $method->class);
  342.                 }
  343.             }
  344.         }
  346.         return $deprecations;
  347.     }
  349.     public function checkCase(\ReflectionClass $refl, $file, $class) {
  350.         $real = explode('\\', $class . strrchr($file, '.'));
  351.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  353.         $i = \count($tail) - 1;
  354.         $j = \count($real) - 1;
  356.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  357.             --$i;
  358.             --$j;
  359.         }
  361.         array_splice($tail, 0, $i + 1);
  363.         if (!$tail) {
  364.             return;
  365.         }
  367.         $tail = \DIRECTORY_SEPARATOR . implode(\DIRECTORY_SEPARATOR, $tail);
  368.         $tailLen = \strlen($tail);
  369.         $real = $refl->getFileName();
  371.         if (2 === self::$caseCheck) {
  372.             $real = $this->darwinRealpath($real);
  373.         }
  375.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true) && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  376.         ) {
  377.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  378.         }
  379.     }
  381.     /**
  382.      * `realpath` on MacOSX doesn't normalize the case of characters.
  383.      */
  384.     private function darwinRealpath($real) {
  385.         $i = 1 + strrpos($real, '/');
  386.         $file = substr($real, $i);
  387.         $real = substr($real, 0, $i);
  389.         if (isset(self::$darwinCache[$real])) {
  390.             $kDir = $real;
  391.         } else {
  392.             $kDir = strtolower($real);
  394.             if (isset(self::$darwinCache[$kDir])) {
  395.                 $real = self::$darwinCache[$kDir][0];
  396.             } else {
  397.                 $dir = getcwd();
  398.                 chdir($real);
  399.                 $real = getcwd() . '/';
  400.                 chdir($dir);
  402.                 $dir = $real;
  403.                 $k = $kDir;
  404.                 $i = \strlen($dir) - 1;
  405.                 while (!isset(self::$darwinCache[$k])) {
  406.                     self::$darwinCache[$k] = [$dir, []];
  407.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  409.                     while ('/' !== $dir[--$i]) {
  410.                         
  411.                     }
  412.                     $k = substr($k, 0, ++$i);
  413.                     $dir = substr($dir, 0, $i--);
  414.                 }
  415.             }
  416.         }
  418.         $dirFiles = self::$darwinCache[$kDir][1];
  420.         if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  421.             // Get the file name from "file_name.php(123) : eval()'d code"
  422.             $file = substr($file, 0, strrpos($file, '(', -17));
  423.         }
  425.         if (isset($dirFiles[$file])) {
  426.             return $real .= $dirFiles[$file];
  427.         }
  429.         $kFile = strtolower($file);
  431.         if (!isset($dirFiles[$kFile])) {
  432.             foreach (scandir($real, 2) as $f) {
  433.                 if ('.' !== $f[0]) {
  434.                     $dirFiles[$f] = $f;
  435.                     if ($f === $file) {
  436.                         $kFile = $k = $file;
  437.                     } elseif ($f !== $k = strtolower($f)) {
  438.                         $dirFiles[$k] = $f;
  439.                     }
  440.                 }
  441.             }
  442.             self::$darwinCache[$kDir][1] = $dirFiles;
  443.         }
  445.         return $real .= $dirFiles[$kFile];
  446.     }
  448.     /**
  449.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  450.      *
  451.      * @param string       $class
  452.      * @param string|false $parent
  453.      *
  454.      * @return string[]
  455.      */
  456.     private function getOwnInterfaces($class, $parent) {
  457.         $ownInterfaces = class_implements($class, false);
  459.         if ($parent) {
  460.             foreach (class_implements($parent, false) as $interface) {
  461.                 unset($ownInterfaces[$interface]);
  462.             }
  463.         }
  465.         foreach ($ownInterfaces as $interface) {
  466.             foreach (class_implements($interface) as $interface) {
  467.                 unset($ownInterfaces[$interface]);
  468.             }
  469.         }
  471.         return $ownInterfaces;
  472.     }
  474. }