vendor/symfony/debug/DebugClassLoader.php line 165

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 = [];
  30.     private static $caseCheck;
  31.     private static $checkedClasses = [];
  32.     private static $final = [];
  33.     private static $finalMethods = [];
  34.     private static $deprecated = [];
  35.     private static $internal = [];
  36.     private static $internalMethods = [];
  37.     private static $darwinCache = ['/' => ['/', []]];
  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 = [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.      * @return string|null
  128.      */
  129.     public function findFile($class)
  130.     {
  131.         return $this->isFinder ? $this->classLoader[0]->findFile($class) ?: null : null;
  132.     }
  134.     /**
  135.      * Loads the given class or interface.
  136.      *
  137.      * @param string $class The name of the class
  138.      *
  139.      * @throws \RuntimeException
  140.      */
  141.     public function loadClass($class)
  142.     {
  143.         $e = error_reporting(error_reporting() | E_PARSE | E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR);
  145.         try {
  146.             if ($this->isFinder && !isset($this->loaded[$class])) {
  147.                 $this->loaded[$class] = true;
  148.                 if (!$file = $this->classLoader[0]->findFile($class) ?: false) {
  149.                     // no-op
  150.                 } elseif (\function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file)) {
  151.                     require $file;
  153.                     return;
  154.                 } else {
  155.                     require $file;
  156.                 }
  157.             } else {
  158.                 ($this->classLoader)($class);
  159.                 $file = false;
  160.             }
  161.         } finally {
  162.             error_reporting($e);
  163.         }
  165.         $this->checkClass($class, $file);
  166.     }
  168.     private function checkClass($class, $file = null)
  169.     {
  170.         $exists = null === $file || \class_exists($class, false) || \interface_exists($class, false) || \trait_exists($class, false);
  172.         if (null !== $file && $class && '\\' === $class[0]) {
  173.             $class = substr($class, 1);
  174.         }
  176.         if ($exists) {
  177.             if (isset(self::$checkedClasses[$class])) {
  178.                 return;
  179.             }
  180.             self::$checkedClasses[$class] = true;
  182.             $refl = new \ReflectionClass($class);
  183.             if (null === $file && $refl->isInternal()) {
  184.                 return;
  185.             }
  186.             $name = $refl->getName();
  188.             if ($name !== $class && 0 === \strcasecmp($name, $class)) {
  189.                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  190.             }
  192.             $deprecations = $this->checkAnnotations($refl, $name);
  194.             foreach ($deprecations as $message) {
  195.                 @trigger_error($message, E_USER_DEPRECATED);
  196.             }
  197.         }
  199.         if (!$file) {
  200.             return;
  201.         }
  203.         if (!$exists) {
  204.             if (false !== strpos($class, '/')) {
  205.                 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));
  206.             }
  208.             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));
  209.         }
  211.         if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  212.             throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  213.         }
  214.     }
  216.     public function checkAnnotations(\ReflectionClass $refl, $class)
  217.     {
  218.         $deprecations = [];
  220.         // Don't trigger deprecations for classes in the same vendor
  221.         if (2 > $len = 1 + (\strpos($class, '\\') ?: \strpos($class, '_'))) {
  222.             $len = 0;
  223.             $ns = '';
  224.         } else {
  225.             $ns = \str_replace('_', '\\', \substr($class, 0, $len));
  226.         }
  228.         // Detect annotations on the class
  229.         if (false !== $doc = $refl->getDocComment()) {
  230.             foreach (['final', 'deprecated', 'internal'] as $annotation) {
  231.                 if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
  232.                     self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  233.                 }
  234.             }
  235.         }
  237.         $parent = \get_parent_class($class);
  238.         $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  239.         if ($parent) {
  240.             $parentAndOwnInterfaces[$parent] = $parent;
  242.             if (!isset(self::$checkedClasses[$parent])) {
  243.                 $this->checkClass($parent);
  244.             }
  246.             if (isset(self::$final[$parent])) {
  247.                 $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);
  248.             }
  249.         }
  251.         // Detect if the parent is annotated
  252.         foreach ($parentAndOwnInterfaces + \class_uses($class, false) as $use) {
  253.             if (!isset(self::$checkedClasses[$use])) {
  254.                 $this->checkClass($use);
  255.             }
  256.             if (isset(self::$deprecated[$use]) && \strncmp($ns, \str_replace('_', '\\', $use), $len)) {
  257.                 $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  258.                 $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  260.                 $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $class, $type, $verb, $use, self::$deprecated[$use]);
  261.             }
  262.             if (isset(self::$internal[$use]) && \strncmp($ns, \str_replace('_', '\\', $use), $len)) {
  263.                 $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);
  264.             }
  265.         }
  267.         if (\trait_exists($class)) {
  268.             return $deprecations;
  269.         }
  271.         // Inherit @final and @internal annotations for methods
  272.         self::$finalMethods[$class] = [];
  273.         self::$internalMethods[$class] = [];
  274.         foreach ($parentAndOwnInterfaces as $use) {
  275.             foreach (['finalMethods', 'internalMethods'] as $property) {
  276.                 if (isset(self::${$property}[$use])) {
  277.                     self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  278.                 }
  279.             }
  280.         }
  282.         foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  283.             if ($method->class !== $class) {
  284.                 continue;
  285.             }
  287.             if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  288.                 list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
  289.                 $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);
  290.             }
  292.             if (isset(self::$internalMethods[$class][$method->name])) {
  293.                 list($declaringClass, $message) = self::$internalMethods[$class][$method->name];
  294.                 if (\strncmp($ns, $declaringClass, $len)) {
  295.                     $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);
  296.                 }
  297.             }
  299.             // Detect method annotations
  300.             if (false === $doc = $method->getDocComment()) {
  301.                 continue;
  302.             }
  304.             foreach (['final', 'internal'] as $annotation) {
  305.                 if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
  306.                     $message = isset($notice[1]) ? preg_replace('#\.?\r?\n( \*)? *(?= |\r?\n|$)#', '', $notice[1]) : '';
  307.                     self::${$annotation.'Methods'}[$class][$method->name] = [$class, $message];
  308.                 }
  309.             }
  310.         }
  312.         return $deprecations;
  313.     }
  315.     public function checkCase(\ReflectionClass $refl, $file, $class)
  316.     {
  317.         $real = explode('\\', $class.strrchr($file, '.'));
  318.         $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  320.         $i = \count($tail) - 1;
  321.         $j = \count($real) - 1;
  323.         while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  324.             --$i;
  325.             --$j;
  326.         }
  328.         array_splice($tail, 0, $i + 1);
  330.         if (!$tail) {
  331.             return;
  332.         }
  334.         $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  335.         $tailLen = \strlen($tail);
  336.         $real = $refl->getFileName();
  338.         if (2 === self::$caseCheck) {
  339.             $real = $this->darwinRealpath($real);
  340.         }
  342.         if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  343.             && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  344.         ) {
  345.             return [substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1)];
  346.         }
  347.     }
  349.     /**
  350.      * `realpath` on MacOSX doesn't normalize the case of characters.
  351.      */
  352.     private function darwinRealpath($real)
  353.     {
  354.         $i = 1 + strrpos($real, '/');
  355.         $file = substr($real, $i);
  356.         $real = substr($real, 0, $i);
  358.         if (isset(self::$darwinCache[$real])) {
  359.             $kDir = $real;
  360.         } else {
  361.             $kDir = strtolower($real);
  363.             if (isset(self::$darwinCache[$kDir])) {
  364.                 $real = self::$darwinCache[$kDir][0];
  365.             } else {
  366.                 $dir = getcwd();
  367.                 chdir($real);
  368.                 $real = getcwd().'/';
  369.                 chdir($dir);
  371.                 $dir = $real;
  372.                 $k = $kDir;
  373.                 $i = \strlen($dir) - 1;
  374.                 while (!isset(self::$darwinCache[$k])) {
  375.                     self::$darwinCache[$k] = [$dir, []];
  376.                     self::$darwinCache[$dir] = &self::$darwinCache[$k];
  378.                     while ('/' !== $dir[--$i]) {
  379.                     }
  380.                     $k = substr($k, 0, ++$i);
  381.                     $dir = substr($dir, 0, $i--);
  382.                 }
  383.             }
  384.         }
  386.         $dirFiles = self::$darwinCache[$kDir][1];
  388.         if (isset($dirFiles[$file])) {
  389.             return $real .= $dirFiles[$file];
  390.         }
  392.         $kFile = strtolower($file);
  394.         if (!isset($dirFiles[$kFile])) {
  395.             foreach (scandir($real, 2) as $f) {
  396.                 if ('.' !== $f[0]) {
  397.                     $dirFiles[$f] = $f;
  398.                     if ($f === $file) {
  399.                         $kFile = $k = $file;
  400.                     } elseif ($f !== $k = strtolower($f)) {
  401.                         $dirFiles[$k] = $f;
  402.                     }
  403.                 }
  404.             }
  405.             self::$darwinCache[$kDir][1] = $dirFiles;
  406.         }
  408.         return $real .= $dirFiles[$kFile];
  409.     }
  411.     /**
  412.      * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  413.      *
  414.      * @param string       $class
  415.      * @param string|false $parent
  416.      *
  417.      * @return string[]
  418.      */
  419.     private function getOwnInterfaces($class, $parent)
  420.     {
  421.         $ownInterfaces = class_implements($class, false);
  423.         if ($parent) {
  424.             foreach (class_implements($parent, false) as $interface) {
  425.                 unset($ownInterfaces[$interface]);
  426.             }
  427.         }
  429.         foreach ($ownInterfaces as $interface) {
  430.             foreach (class_implements($interface) as $interface) {
  431.                 unset($ownInterfaces[$interface]);
  432.             }
  433.         }
  435.         return $ownInterfaces;
  436.     }
  437. }