vendor/symfony/symfony/src/Symfony/Component/Debug/DebugClassLoader.php line 141

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 $final = array();
  32.     private static $finalMethods = array();
  33.     private static $deprecated = array();
  34.     private static $php7Reserved = array('int', 'float', 'bool', 'string', 'true', 'false', 'null');
  35.     private static $darwinCache = array('/' => array('/', array()));
  37.     public function __construct(callable $classLoader)
  38.     {
  39.         $this->classLoader = $classLoader;
  40.         $this->isFinder = is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  42.         if (!isset(self::$caseCheck)) {
  43.             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), DIRECTORY_SEPARATOR);
  44.             $i = strrpos($file, DIRECTORY_SEPARATOR);
  45.             $dir = substr($file, 0, 1 + $i);
  46.             $file = substr($file, 1 + $i);
  47.             $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  48.             $test = realpath($dir.$test);
  50.             if (false === $test || false === $i) {
  51.                 // filesystem is case sensitive
  52.                 self::$caseCheck = 0;
  53.             } elseif (substr($test, -strlen($file)) === $file) {
  54.                 // filesystem is case insensitive and realpath() normalizes the case of characters
  55.                 self::$caseCheck = 1;
  56.             } elseif (false !== stripos(PHP_OS, 'darwin')) {
  57.                 // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  58.                 self::$caseCheck = 2;
  59.             } else {
  60.                 // filesystem case checks failed, fallback to disabling them
  61.                 self::$caseCheck = 0;
  62.             }
  63.         }
  64.     }
  66.     /**
  67.      * Gets the wrapped class loader.
  68.      *
  69.      * @return callable The wrapped class loader
  70.      */
  71.     public function getClassLoader()
  72.     {
  73.         return $this->classLoader;
  74.     }
  76.     /**
  77.      * Wraps all autoloaders.
  78.      */
  79.     public static function enable()
  80.     {
  81.         // Ensures we don't hit https://bugs.php.net/42098
  82.         class_exists('Symfony\Component\Debug\ErrorHandler');
  83.         class_exists('Psr\Log\LogLevel');
  85.         if (!is_array($functions = spl_autoload_functions())) {
  86.             return;
  87.         }
  89.         foreach ($functions as $function) {
  90.             spl_autoload_unregister($function);
  91.         }
  93.         foreach ($functions as $function) {
  94.             if (!is_array($function) || !$function[0] instanceof self) {
  95.                 $function = array(new static($function), 'loadClass');
  96.             }
  98.             spl_autoload_register($function);
  99.         }
  100.     }
  102.     /**
  103.      * Disables the wrapping.
  104.      */
  105.     public static function disable()
  106.     {
  107.         if (!is_array($functions = spl_autoload_functions())) {
  108.             return;
  109.         }
  111.         foreach ($functions as $function) {
  112.             spl_autoload_unregister($function);
  113.         }
  115.         foreach ($functions as $function) {
  116.             if (is_array($function) && $function[0] instanceof self) {
  117.                 $function = $function[0]->getClassLoader();
  118.             }
  120.             spl_autoload_register($function);
  121.         }
  122.     }
  124.     /**
  125.      * Loads the given class or interface.
  126.      *
  127.      * @param string $class The name of the class
  128.      *
  129.      * @return bool|null True, if loaded
  130.      *
  131.      * @throws \RuntimeException
  132.      */
  133.     public function loadClass($class)
  134.     {
  135.         ErrorHandler::stackErrors();
  137.         try {
  138.             if ($this->isFinder && !isset($this->loaded[$class])) {
  139.                 $this->loaded[$class] = true;
  140.                 if ($file = $this->classLoader[0]->findFile($class)) {
  141.                     require $file;
  142.                 }
  143.             } else {
  144.                 call_user_func($this->classLoader, $class);
  145.                 $file = false;
  146.             }
  147.         } finally {
  148.             ErrorHandler::unstackErrors();
  149.         }
  151.         $exists = class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
  153.         if ($class && '\\' === $class[0]) {
  154.             $class = substr($class, 1);
  155.         }
  157.         if ($exists) {
  158.             $refl = new \ReflectionClass($class);
  159.             $name = $refl->getName();
  161.             if ($name !== $class && 0 === strcasecmp($name, $class)) {
  162.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  163.             }
  165.             $parent = get_parent_class($class);
  167.             // Not an interface nor a trait
  168.             if (class_exists($name, false)) {
  169.                 if (preg_match('#\n \* @final(?:( .+?)\.?)?\r?\n \*(?: @|/$)#s', $refl->getDocComment(), $notice)) {
  170.                     self::$final[$name] = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
  171.                 }
  173.                 if ($parent && isset(self::$final[$parent])) {
  174.                     @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);
  175.                 }
  177.                 // Inherit @final annotations
  178.                 self::$finalMethods[$name] = $parent && isset(self::$finalMethods[$parent]) ? self::$finalMethods[$parent] : array();
  180.                 foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  181.                     if ($method->class !== $name) {
  182.                         continue;
  183.                     }
  185.                     if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  186.                         @trigger_error(sprintf('%s It may change without further notice as of its next major version. You should not extend it from "%s".', self::$finalMethods[$parent][$method->name], $name), E_USER_DEPRECATED);
  187.                     }
  189.                     $doc = $method->getDocComment();
  190.                     if (false === $doc || false === strpos($doc, '@final')) {
  191.                         continue;
  192.                     }
  194.                     if (preg_match('#\n\s+\* @final(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
  195.                         $message = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
  196.                         self::$finalMethods[$name][$method->name] = sprintf('The "%s::%s()" method is considered final%s.', $name, $method->name, $message);
  197.                     }
  198.                 }
  199.             }
  201.             if (in_array(strtolower($refl->getShortName()), self::$php7Reserved)) {
  202.                 @trigger_error(sprintf('The "%s" class uses the reserved name "%s", it will break on PHP 7 and higher', $name, $refl->getShortName()), E_USER_DEPRECATED);
  203.             } elseif (preg_match('#\n \* @deprecated (.*?)\r?\n \*(?: @|/$)#s', $refl->getDocComment(), $notice)) {
  204.                 self::$deprecated[$name] = preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]);
  205.             } else {
  206.                 // Don't trigger deprecations for classes in the same vendor
  207.                 if (2 > $len = 1 + (strpos($name, '\\') ?: strpos($name, '_'))) {
  208.                     $len = 0;
  209.                     $ns = '';
  210.                 } else {
  211.                     $ns = substr($name, 0, $len);
  212.                 }
  214.                 if (!$parent || strncmp($ns, $parent, $len)) {
  215.                     if ($parent && isset(self::$deprecated[$parent]) && strncmp($ns, $parent, $len)) {
  216.                         @trigger_error(sprintf('The "%s" class extends "%s" that is deprecated %s', $name, $parent, self::$deprecated[$parent]), E_USER_DEPRECATED);
  217.                     }
  219.                     $parentInterfaces = array();
  220.                     $deprecatedInterfaces = array();
  221.                     if ($parent) {
  222.                         foreach (class_implements($parent) as $interface) {
  223.                             $parentInterfaces[$interface] = 1;
  224.                         }
  225.                     }
  227.                     foreach ($refl->getInterfaceNames() as $interface) {
  228.                         if (isset(self::$deprecated[$interface]) && strncmp($ns, $interface, $len)) {
  229.                             $deprecatedInterfaces[] = $interface;
  230.                         }
  231.                         foreach (class_implements($interface) as $interface) {
  232.                             $parentInterfaces[$interface] = 1;
  233.                         }
  234.                     }
  236.                     foreach ($deprecatedInterfaces as $interface) {
  237.                         if (!isset($parentInterfaces[$interface])) {
  238.                             @trigger_error(sprintf('The "%s" %s "%s" that is deprecated %s', $name, $refl->isInterface() ? 'interface extends' : 'class implements', $interface, self::$deprecated[$interface]), E_USER_DEPRECATED);
  239.                         }
  240.                     }
  241.                 }
  242.             }
  243.         }
  245.         if ($file) {
  246.             if (!$exists) {
  247.                 if (false !== strpos($class, '/')) {
  248.                     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));
  249.                 }
  251.                 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));
  252.             }
  253.             if (self::$caseCheck) {
  254.                 $real = explode('\\', $class.strrchr($file, '.'));
  255.                 $tail = explode(DIRECTORY_SEPARATOR, str_replace('/', DIRECTORY_SEPARATOR, $file));
  257.                 $i = count($tail) - 1;
  258.                 $j = count($real) - 1;
  260.                 while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  261.                     --$i;
  262.                     --$j;
  263.                 }
  265.                 array_splice($tail, 0, $i + 1);
  266.             }
  267.             if (self::$caseCheck && $tail) {
  268.                 $tail = DIRECTORY_SEPARATOR.implode(DIRECTORY_SEPARATOR, $tail);
  269.                 $tailLen = strlen($tail);
  270.                 $real = $refl->getFileName();
  272.                 if (2 === self::$caseCheck) {
  273.                     // realpath() on MacOSX doesn't normalize the case of characters
  275.                     $i = 1 + strrpos($real, '/');
  276.                     $file = substr($real, $i);
  277.                     $real = substr($real, 0, $i);
  279.                     if (isset(self::$darwinCache[$real])) {
  280.                         $kDir = $real;
  281.                     } else {
  282.                         $kDir = strtolower($real);
  284.                         if (isset(self::$darwinCache[$kDir])) {
  285.                             $real = self::$darwinCache[$kDir][0];
  286.                         } else {
  287.                             $dir = getcwd();
  288.                             chdir($real);
  289.                             $real = getcwd().'/';
  290.                             chdir($dir);
  292.                             $dir = $real;
  293.                             $k = $kDir;
  294.                             $i = strlen($dir) - 1;
  295.                             while (!isset(self::$darwinCache[$k])) {
  296.                                 self::$darwinCache[$k] = array($dir, array());
  297.                                 self::$darwinCache[$dir] = &self::$darwinCache[$k];
  299.                                 while ('/' !== $dir[--$i]) {
  300.                                 }
  301.                                 $k = substr($k, 0, ++$i);
  302.                                 $dir = substr($dir, 0, $i--);
  303.                             }
  304.                         }
  305.                     }
  307.                     $dirFiles = self::$darwinCache[$kDir][1];
  309.                     if (isset($dirFiles[$file])) {
  310.                         $kFile = $file;
  311.                     } else {
  312.                         $kFile = strtolower($file);
  314.                         if (!isset($dirFiles[$kFile])) {
  315.                             foreach (scandir($real, 2) as $f) {
  316.                                 if ('.' !== $f[0]) {
  317.                                     $dirFiles[$f] = $f;
  318.                                     if ($f === $file) {
  319.                                         $kFile = $k = $file;
  320.                                     } elseif ($f !== $k = strtolower($f)) {
  321.                                         $dirFiles[$k] = $f;
  322.                                     }
  323.                                 }
  324.                             }
  325.                             self::$darwinCache[$kDir][1] = $dirFiles;
  326.                         }
  327.                     }
  329.                     $real .= $dirFiles[$kFile];
  330.                 }
  332.                 if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  333.                   && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  334.                 ) {
  335.                     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)));
  336.                 }
  337.             }
  339.             return true;
  340.         }
  341.     }
  342. }