vendor/symfony/debug/DebugClassLoader.php line 256

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. /**
  15.  * Autoloader checking if the class is really defined in the file found.
  16.  *
  17.  * The ClassLoader will wrap all registered autoloaders
  18.  * and will throw an exception if a file is found but does
  19.  * not declare the class.
  20.  *
  21.  * @author Fabien Potencier <fabien@symfony.com>
  22.  * @author Christophe Coevoet <stof@notk.org>
  23.  * @author Nicolas Grekas <p@tchwork.com>
  24.  */
  25. class DebugClassLoader
  26. {
  27.     private $classLoader;
  28.     private $isFinder;
  29.     private $loaded = array();
  30.     private static $caseCheck;
  31.     private static $checkedClasses = array();
  32.     private static $final = array();
  33.     private static $finalMethods = array();
  34.     private static $deprecated = array();
  35.     private static $internal = array();
  36.     private static $internalMethods = array();
  37.     private static $darwinCache = array('/' => array('/', array()));
  39.     public function __construct(callable $classLoader)
  40.     {
  41.         $this->classLoader = $classLoader;
  42.         $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  44.         if (!isset(self::$caseCheck)) {
  45.             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  46.             $i = strrpos($file, \DIRECTORY_SEPARATOR);
  47.             $dir = substr($file, 0, 1 + $i);
  48.             $file = substr($file, 1 + $i);
  49.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  50.             $test = realpath($dir.$test);
  52.             if (false === $test || false === $i) {
  53.                 // filesystem is case sensitive
  54.                 self::$caseCheck = 0;
  55.             } elseif (substr($test, -\strlen($file)) === $file) {
  56.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  57.                 self::$caseCheck = 1;
  58.             } elseif (false !== stripos(PHP_OS, 'darwin')) {
  59.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  60.                 self::$caseCheck = 2;
  61.             } else {
  62.                 // filesystem case checks failed, fallback to disabling them
  63.                 self::$caseCheck = 0;
  64.             }
  65.         }
  66.     }
  68.     /**
  69.      * Gets the wrapped class loader.
  70.      *
  71.      * @return callable The wrapped class loader
  72.      */
  73.     public function getClassLoader()
  74.     {
  75.         return $this->classLoader;
  76.     }
  78.     /**
  79.      * Wraps all autoloaders.
  80.      */
  81.     public static function enable()
  82.     {
  83.         // Ensures we don't hit https://bugs.php.net/42098
  84.         class_exists('Symfony\Component\Debug\ErrorHandler');
  85.         class_exists('Psr\Log\LogLevel');
  87.         if (!\is_array($functions = spl_autoload_functions())) {
  88.             return;
  89.         }
  91.         foreach ($functions as $function) {
  92.             spl_autoload_unregister($function);
  93.         }
  95.         foreach ($functions as $function) {
  96.             if (!\is_array($function) || !$function[0] instanceof self) {
  97.                 $function = array(new static($function), 'loadClass');
  98.             }
  100.             spl_autoload_register($function);
  101.         }
  102.     }
  104.     /**
  105.      * Disables the wrapping.
  106.      */
  107.     public static function disable()
  108.     {
  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.      * Loads the given class or interface.
  128.      *
  129.      * @param string $class The name of the class
  130.      *
  131.      * @return bool|null True, if loaded
  132.      *
  133.      * @throws \RuntimeException
  134.      */
  135.     public function loadClass($class)
  136.     {
  137.         $e = error_reporting(error_reporting() | E_PARSE | E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR);
  139.         try {
  140.             if ($this->isFinder && !isset($this->loaded[$class])) {
  141.                 $this->loaded[$class] = true;
  142.                 if ($file = $this->classLoader[0]->findFile($class) ?: false) {
  143.                     $wasCached = \function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file);
  145.                     require $file;
  147.                     if ($wasCached) {
  148.                         return;
  149.                     }
  150.                 }
  151.             } else {
  152.                 \call_user_func($this->classLoader, $class);
  153.                 $file = false;
  154.             }
  155.         } finally {
  156.             error_reporting($e);
  157.         }
  159.         $this->checkClass($class, $file);
  160.     }
  162.     private function checkClass($class, $file = null)
  163.     {
  164.         $exists = null === $file || \class_exists($class, false) || \interface_exists($class, false) || \trait_exists($class, false);
  166.         if (null !== $file && $class && '\\' === $class[0]) {
  167.             $class = substr($class, 1);
  168.         }
  170.         if ($exists) {
  171.             if (isset(self::$checkedClasses[$class])) {
  172.                 return;
  173.             }
  174.             self::$checkedClasses[$class] = true;
  176.             $refl = new \ReflectionClass($class);
  177.             if (null === $file && $refl->isInternal()) {
  178.                 return;
  179.             }
  180.             $name = $refl->getName();
  182.             if ($name !== $class && 0 === \strcasecmp($name, $class)) {
  183.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  184.             }
  186.             // Don't trigger deprecations for classes in the same vendor
  187.             if (2 > $len = 1 + (\strpos($name, '\\') ?: \strpos($name, '_'))) {
  188.                 $len = 0;
  189.                 $ns = '';
  190.             } else {
  191.                 $ns = \substr($name, 0, $len);
  192.             }
  194.             // Detect annotations on the class
  195.             if (false !== $doc = $refl->getDocComment()) {
  196.                 foreach (array('final', 'deprecated', 'internal') as $annotation) {
  197.                     if (false !== \strpos($doc, $annotation) && preg_match('#\n \* @'.$annotation.'(?:( .+?)\.?)?\r?\n \*(?: @|/$)#s', $doc, $notice)) {
  198.                         self::${$annotation}[$name] = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
  199.                     }
  200.                 }
  201.             }
  203.             $parentAndTraits = \class_uses($name, false);
  204.             if ($parent = \get_parent_class($class)) {
  205.                 $parentAndTraits[] = $parent;
  207.                 if (!isset(self::$checkedClasses[$parent])) {
  208.                     $this->checkClass($parent);
  209.                 }
  211.                 if (isset(self::$final[$parent])) {
  212.                     @trigger_error(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], $name), E_USER_DEPRECATED);
  213.                 }
  214.             }
  216.             // Detect if the parent is annotated
  217.             foreach ($parentAndTraits + $this->getOwnInterfaces($name, $parent) as $use) {
  218.                 if (!isset(self::$checkedClasses[$use])) {
  219.                     $this->checkClass($use);
  220.                 }
  221.                 if (isset(self::$deprecated[$use]) && \strncmp($ns, $use, $len)) {
  222.                     $type = class_exists($name, false) ? 'class' : (interface_exists($name, false) ? 'interface' : 'trait');
  223.                     $verb = class_exists($use, false) || interface_exists($name, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  225.                     @trigger_error(sprintf('The "%s" %s %s "%s" that is deprecated%s.', $name, $type, $verb, $use, self::$deprecated[$use]), E_USER_DEPRECATED);
  226.                 }
  227.                 if (isset(self::$internal[$use]) && \strncmp($ns, $use, $len)) {
  228.                     @trigger_error(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], $name), E_USER_DEPRECATED);
  229.                 }
  230.             }
  232.             // Inherit @final and @internal annotations for methods
  233.             self::$finalMethods[$name] = array();
  234.             self::$internalMethods[$name] = array();
  235.             foreach ($parentAndTraits as $use) {
  236.                 foreach (array('finalMethods', 'internalMethods') as $property) {
  237.                     if (isset(self::${$property}[$use])) {
  238.                         self::${$property}[$name] = self::${$property}[$name] ? self::${$property}[$use] + self::${$property}[$name] : self::${$property}[$use];
  239.                     }
  240.                 }
  241.             }
  243.             $isClass = \class_exists($name, false);
  244.             foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  245.                 if ($method->class !== $name) {
  246.                     continue;
  247.                 }
  249.                 // Method from a trait
  250.                 if ($method->getFilename() !== $refl->getFileName()) {
  251.                     continue;
  252.                 }
  254.                 if ($isClass && $parent && isset(self::$finalMethods[$parent][$method->name])) {
  255.                     list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
  256.                     @trigger_error(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, $name), E_USER_DEPRECATED);
  257.                 }
  259.                 foreach ($parentAndTraits as $use) {
  260.                     if (isset(self::$internalMethods[$use][$method->name])) {
  261.                         list($declaringClass, $message) = self::$internalMethods[$use][$method->name];
  262.                         if (\strncmp($ns, $declaringClass, $len)) {
  263.                             @trigger_error(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, $name), E_USER_DEPRECATED);
  264.                         }
  265.                     }
  266.                 }
  268.                 // Detect method annotations
  269.                 if (false === $doc = $method->getDocComment()) {
  270.                     continue;
  271.                 }
  273.                 foreach (array('final', 'internal') as $annotation) {
  274.                     if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
  275.                         $message = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
  276.                         self::${$annotation.'Methods'}[$name][$method->name] = array($name, $message);
  277.                     }
  278.                 }
  279.             }
  280.         }
  282.         if ($file) {
  283.             if (!$exists) {
  284.                 if (false !== strpos($class, '/')) {
  285.                     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));
  286.                 }
  288.                 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));
  289.             }
  290.             if (self::$caseCheck) {
  291.                 $real = explode('\\', $class.strrchr($file, '.'));
  292.                 $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  294.                 $i = \count($tail) - 1;
  295.                 $j = \count($real) - 1;
  297.                 while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  298.                     --$i;
  299.                     --$j;
  300.                 }
  302.                 array_splice($tail, 0, $i + 1);
  303.             }
  304.             if (self::$caseCheck && $tail) {
  305.                 $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  306.                 $tailLen = \strlen($tail);
  307.                 $real = $refl->getFileName();
  309.                 if (2 === self::$caseCheck) {
  310.                     // realpath() on MacOSX doesn't normalize the case of characters
  312.                     $i = 1 + strrpos($real, '/');
  313.                     $file = substr($real, $i);
  314.                     $real = substr($real, 0, $i);
  316.                     if (isset(self::$darwinCache[$real])) {
  317.                         $kDir = $real;
  318.                     } else {
  319.                         $kDir = strtolower($real);
  321.                         if (isset(self::$darwinCache[$kDir])) {
  322.                             $real = self::$darwinCache[$kDir][0];
  323.                         } else {
  324.                             $dir = getcwd();
  325.                             chdir($real);
  326.                             $real = getcwd().'/';
  327.                             chdir($dir);
  329.                             $dir = $real;
  330.                             $k = $kDir;
  331.                             $i = \strlen($dir) - 1;
  332.                             while (!isset(self::$darwinCache[$k])) {
  333.                                 self::$darwinCache[$k] = array($dir, array());
  334.                                 self::$darwinCache[$dir] = &self::$darwinCache[$k];
  336.                                 while ('/' !== $dir[--$i]) {
  337.                                 }
  338.                                 $k = substr($k, 0, ++$i);
  339.                                 $dir = substr($dir, 0, $i--);
  340.                             }
  341.                         }
  342.                     }
  344.                     $dirFiles = self::$darwinCache[$kDir][1];
  346.                     if (isset($dirFiles[$file])) {
  347.                         $kFile = $file;
  348.                     } else {
  349.                         $kFile = strtolower($file);
  351.                         if (!isset($dirFiles[$kFile])) {
  352.                             foreach (scandir($real, 2) as $f) {
  353.                                 if ('.' !== $f[0]) {
  354.                                     $dirFiles[$f] = $f;
  355.                                     if ($f === $file) {
  356.                                         $kFile = $k = $file;
  357.                                     } elseif ($f !== $k = strtolower($f)) {
  358.                                         $dirFiles[$k] = $f;
  359.                                     }
  360.                                 }
  361.                             }
  362.                             self::$darwinCache[$kDir][1] = $dirFiles;
  363.                         }
  364.                     }
  366.                     $real .= $dirFiles[$kFile];
  367.                 }
  369.                 if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  370.                   && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  371.                 ) {
  372.                     throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)));
  373.                 }
  374.             }
  375.         }
  376.     }
  378.     /**
  379.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  380.      *
  381.      * @param string       $class
  382.      * @param string|false $parent
  383.      *
  384.      * @return string[]
  385.      */
  386.     private function getOwnInterfaces($class, $parent)
  387.     {
  388.         $ownInterfaces = class_implements($class, false);
  390.         if ($parent) {
  391.             foreach (class_implements($parent, false) as $interface) {
  392.                 unset($ownInterfaces[$interface]);
  393.             }
  394.         }
  396.         foreach ($ownInterfaces as $interface) {
  397.             foreach (class_implements($interface) as $interface) {
  398.                 unset($ownInterfaces[$interface]);
  399.             }
  400.         }
  402.         return $ownInterfaces;
  403.     }
  404. }