vendor/symfony/debug/DebugClassLoader.php line 154

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
  29. {
  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.     {
  45.         $this->classLoader = $classLoader;
  46.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  48.         if (!isset(self::$caseCheck)) {
  49.             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  50.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  51.             $dir = substr($file, 0, 1 + $i);
  52.             $file = substr($file, 1 + $i);
  53.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  54.             $test = realpath($dir.$test);
  56.             if (false === $test || false === $i) {
  57.                 // filesystem is case sensitive
  58.                 self::$caseCheck = 0;
  59.             } elseif (substr($test, -\strlen($file)) === $file) {
  60.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  61.                 self::$caseCheck = 1;
  62.             } elseif (false !== stripos(PHP_OS, 'darwin')) {
  63.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  64.                 self::$caseCheck = 2;
  65.             } else {
  66.                 // filesystem case checks failed, fallback to disabling them
  67.                 self::$caseCheck = 0;
  68.             }
  69.         }
  70.     }
  72.     /**
  73.      * Gets the wrapped class loader.
  74.      *
  75.      * @return callable The wrapped class loader
  76.      */
  77.     public function getClassLoader()
  78.     {
  79.         return $this->classLoader;
  80.     }
  82.     /**
  83.      * Wraps all autoloaders.
  84.      */
  85.     public static function enable()
  86.     {
  87.         // Ensures we don't hit https://bugs.php.net/42098
  88.         class_exists('Symfony\Component\Debug\ErrorHandler');
  89.         class_exists('Psr\Log\LogLevel');
  91.         if (!\is_array($functions = spl_autoload_functions())) {
  92.             return;
  93.         }
  95.         foreach ($functions as $function) {
  96.             spl_autoload_unregister($function);
  97.         }
  99.         foreach ($functions as $function) {
  100.             if (!\is_array($function) || !$function[0] instanceof self) {
  101.                 $function = [new static($function), 'loadClass'];
  102.             }
  104.             spl_autoload_register($function);
  105.         }
  106.     }
  108.     /**
  109.      * Disables the wrapping.
  110.      */
  111.     public static function disable()
  112.     {
  113.         if (!\is_array($functions = spl_autoload_functions())) {
  114.             return;
  115.         }
  117.         foreach ($functions as $function) {
  118.             spl_autoload_unregister($function);
  119.         }
  121.         foreach ($functions as $function) {
  122.             if (\is_array($function) && $function[0] instanceof self) {
  123.                 $function = $function[0]->getClassLoader();
  124.             }
  126.             spl_autoload_register($function);
  127.         }
  128.     }
  130.     /**
  131.      * @return string|null
  132.      */
  133.     public function findFile($class)
  134.     {
  135.         return $this->isFinder ? $this->classLoader[0]->findFile($class) ?: null : null;
  136.     }
  138.     /**
  139.      * Loads the given class or interface.
  140.      *
  141.      * @param string $class The name of the class
  142.      *
  143.      * @throws \RuntimeException
  144.      */
  145.     public function loadClass($class)
  146.     {
  147.         $e = error_reporting(error_reporting() | E_PARSE | E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR);
  149.         try {
  150.             if ($this->isFinder && !isset($this->loaded[$class])) {
  151.                 $this->loaded[$class] = true;
  152.                 if (!$file = $this->classLoader[0]->findFile($class) ?: false) {
  153.                     // no-op
  154.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  155.                     require $file;
  157.                     return;
  158.                 } else {
  159.                     require $file;
  160.                 }
  161.             } else {
  162.                 ($this->classLoader)($class);
  163.                 $file = false;
  164.             }
  165.         } finally {
  166.             error_reporting($e);
  167.         }
  169.         $this->checkClass($class, $file);
  170.     }
  172.     private function checkClass($class, $file = null)
  173.     {
  174.         $exists = null === $file || \class_exists($class, false) || \interface_exists($class, false) || \trait_exists($class, false);
  176.         if (null !== $file && $class && '\\' === $class[0]) {
  177.             $class = substr($class, 1);
  178.         }
  180.         if ($exists) {
  181.             if (isset(self::$checkedClasses[$class])) {
  182.                 return;
  183.             }
  184.             self::$checkedClasses[$class] = true;
  186.             $refl = new \ReflectionClass($class);
  187.             if (null === $file && $refl->isInternal()) {
  188.                 return;
  189.             }
  190.             $name = $refl->getName();
  192.             if ($name !== $class && 0 === \strcasecmp($name, $class)) {
  193.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  194.             }
  196.             $deprecations = $this->checkAnnotations($refl, $name);
  198.             foreach ($deprecations as $message) {
  199.                 @trigger_error($message, E_USER_DEPRECATED);
  200.             }
  201.         }
  203.         if (!$file) {
  204.             return;
  205.         }
  207.         if (!$exists) {
  208.             if (false !== strpos($class, '/')) {
  209.                 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));
  210.             }
  212.             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));
  213.         }
  215.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  216.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  217.         }
  218.     }
  220.     public function checkAnnotations(\ReflectionClass $refl, $class)
  221.     {
  222.         $deprecations = [];
  224.         // Don't trigger deprecations for classes in the same vendor
  225.         if (2 > $len = 1 + (\strpos($class, '\\') ?: \strpos($class, '_'))) {
  226.             $len = 0;
  227.             $ns = '';
  228.         } else {
  229.             $ns = \str_replace('_', '\\', \substr($class, 0, $len));
  230.         }
  232.         // Detect annotations on the class
  233.         if (false !== $doc = $refl->getDocComment()) {
  234.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  235.                 if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  236.                     self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  237.                 }
  238.             }
  239.         }
  241.         $parent = \get_parent_class($class);
  242.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  243.         if ($parent) {
  244.             $parentAndOwnInterfaces[$parent] = $parent;
  246.             if (!isset(self::$checkedClasses[$parent])) {
  247.                 $this->checkClass($parent);
  248.             }
  250.             if (isset(self::$final[$parent])) {
  251.                 $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);
  252.             }
  253.         }
  255.         // Detect if the parent is annotated
  256.         foreach ($parentAndOwnInterfaces + \class_uses($class, false) as $use) {
  257.             if (!isset(self::$checkedClasses[$use])) {
  258.                 $this->checkClass($use);
  259.             }
  260.             if (isset(self::$deprecated[$use]) && \strncmp($ns, \str_replace('_', '\\', $use), $len) && !isset(self::$deprecated[$class])) {
  261.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  262.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  264.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $class, $type, $verb, $use, self::$deprecated[$use]);
  265.             }
  266.             if (isset(self::$internal[$use]) && \strncmp($ns, \str_replace('_', '\\', $use), $len)) {
  267.                 $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);
  268.             }
  269.         }
  271.         if (\trait_exists($class)) {
  272.             return $deprecations;
  273.         }
  275.         // Inherit @final, @internal and @param annotations for methods
  276.         self::$finalMethods[$class] = [];
  277.         self::$internalMethods[$class] = [];
  278.         self::$annotatedParameters[$class] = [];
  279.         foreach ($parentAndOwnInterfaces as $use) {
  280.             foreach (['finalMethods', 'internalMethods', 'annotatedParameters'] as $property) {
  281.                 if (isset(self::${$property}[$use])) {
  282.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  283.                 }
  284.             }
  285.         }
  287.         foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  288.             if ($method->class !== $class) {
  289.                 continue;
  290.             }
  292.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  293.                 list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
  294.                 $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);
  295.             }
  297.             if (isset(self::$internalMethods[$class][$method->name])) {
  298.                 list($declaringClass, $message) = self::$internalMethods[$class][$method->name];
  299.                 if (\strncmp($ns, $declaringClass, $len)) {
  300.                     $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);
  301.                 }
  302.             }
  304.             // To read method annotations
  305.             $doc = $method->getDocComment();
  307.             if (isset(self::$annotatedParameters[$class][$method->name])) {
  308.                 $definedParameters = [];
  309.                 foreach ($method->getParameters() as $parameter) {
  310.                     $definedParameters[$parameter->name] = true;
  311.                 }
  313.                 foreach (self::$annotatedParameters[$class][$method->name] as $parameterName => $deprecation) {
  314.                     if (!isset($definedParameters[$parameterName]) && !($doc && preg_match("/\\n\\s+\\* @param (.*?)(?<= )\\\${$parameterName}\\b/", $doc))) {
  315.                         $deprecations[] = sprintf($deprecation, $class);
  316.                     }
  317.                 }
  318.             }
  320.             if (!$doc) {
  321.                 continue;
  322.             }
  324.             $finalOrInternal = false;
  326.             foreach (['final', 'internal'] as $annotation) {
  327.                 if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$|\r?\n)#s', $doc, $notice)) {
  328.                     $message = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  329.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, $message];
  330.                     $finalOrInternal = true;
  331.                 }
  332.             }
  334.             if ($finalOrInternal || $method->isConstructor() || false === \strpos($doc, '@param') || StatelessInvocation::class === $class) {
  335.                 continue;
  336.             }
  337.             if (!preg_match_all('#\n\s+\* @param (.*?)(?<= )\$([a-zA-Z0-9_\x7f-\xff]++)#', $doc, $matches, PREG_SET_ORDER)) {
  338.                 continue;
  339.             }
  340.             if (!isset(self::$annotatedParameters[$class][$method->name])) {
  341.                 $definedParameters = [];
  342.                 foreach ($method->getParameters() as $parameter) {
  343.                     $definedParameters[$parameter->name] = true;
  344.                 }
  345.             }
  346.             foreach ($matches as list(, $parameterType, $parameterName)) {
  347.                 if (!isset($definedParameters[$parameterName])) {
  348.                     $parameterType = trim($parameterType);
  349.                     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);
  350.                 }
  351.             }
  352.         }
  354.         return $deprecations;
  355.     }
  357.     public function checkCase(\ReflectionClass $refl, $file, $class)
  358.     {
  359.         $real = explode('\\', $class.strrchr($file, '.'));
  360.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  362.         $i = \count($tail) - 1;
  363.         $j = \count($real) - 1;
  365.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  366.             --$i;
  367.             --$j;
  368.         }
  370.         array_splice($tail, 0, $i + 1);
  372.         if (!$tail) {
  373.             return;
  374.         }
  376.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  377.         $tailLen = \strlen($tail);
  378.         $real = $refl->getFileName();
  380.         if (2 === self::$caseCheck) {
  381.             $real = $this->darwinRealpath($real);
  382.         }
  384.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  385.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  386.         ) {
  387.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  388.         }
  389.     }
  391.     /**
  392.      * `realpath` on MacOSX doesn't normalize the case of characters.
  393.      */
  394.     private function darwinRealpath($real)
  395.     {
  396.         $i = 1 + strrpos($real, '/');
  397.         $file = substr($real, $i);
  398.         $real = substr($real, 0, $i);
  400.         if (isset(self::$darwinCache[$real])) {
  401.             $kDir = $real;
  402.         } else {
  403.             $kDir = strtolower($real);
  405.             if (isset(self::$darwinCache[$kDir])) {
  406.                 $real = self::$darwinCache[$kDir][0];
  407.             } else {
  408.                 $dir = getcwd();
  409.                 chdir($real);
  410.                 $real = getcwd().'/';
  411.                 chdir($dir);
  413.                 $dir = $real;
  414.                 $k = $kDir;
  415.                 $i = \strlen($dir) - 1;
  416.                 while (!isset(self::$darwinCache[$k])) {
  417.                     self::$darwinCache[$k] = [$dir, []];
  418.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  420.                     while ('/' !== $dir[--$i]) {
  421.                     }
  422.                     $k = substr($k, 0, ++$i);
  423.                     $dir = substr($dir, 0, $i--);
  424.                 }
  425.             }
  426.         }
  428.         $dirFiles = self::$darwinCache[$kDir][1];
  430.         if (!isset($dirFiles[$file]) && ') : eval()\'d code' === substr($file, -17)) {
  431.             // Get the file name from "file_name.php(123) : eval()'d code"
  432.             $file = substr($file, 0, strrpos($file, '(', -17));
  433.         }
  435.         if (isset($dirFiles[$file])) {
  436.             return $real .= $dirFiles[$file];
  437.         }
  439.         $kFile = strtolower($file);
  441.         if (!isset($dirFiles[$kFile])) {
  442.             foreach (scandir($real, 2) as $f) {
  443.                 if ('.' !== $f[0]) {
  444.                     $dirFiles[$f] = $f;
  445.                     if ($f === $file) {
  446.                         $kFile = $k = $file;
  447.                     } elseif ($f !== $k = strtolower($f)) {
  448.                         $dirFiles[$k] = $f;
  449.                     }
  450.                 }
  451.             }
  452.             self::$darwinCache[$kDir][1] = $dirFiles;
  453.         }
  455.         return $real .= $dirFiles[$kFile];
  456.     }
  458.     /**
  459.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  460.      *
  461.      * @param string       $class
  462.      * @param string|false $parent
  463.      *
  464.      * @return string[]
  465.      */
  466.     private function getOwnInterfaces($class, $parent)
  467.     {
  468.         $ownInterfaces = class_implements($class, false);
  470.         if ($parent) {
  471.             foreach (class_implements($parent, false) as $interface) {
  472.                 unset($ownInterfaces[$interface]);
  473.             }
  474.         }
  476.         foreach ($ownInterfaces as $interface) {
  477.             foreach (class_implements($interface) as $interface) {
  478.                 unset($ownInterfaces[$interface]);
  479.             }
  480.         }
  482.         return $ownInterfaces;
  483.     }
  484. }