123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Debug;
- /**
- * Autoloader checking if the class is really defined in the file found.
- *
- * The ClassLoader will wrap all registered autoloaders
- * and will throw an exception if a file is found but does
- * not declare the class.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- * @author Christophe Coevoet <stof@notk.org>
- * @author Nicolas Grekas <p@tchwork.com>
- */
- class DebugClassLoader
- {
- private $classLoader;
- private $isFinder;
- private $loaded = array();
- private static $caseCheck;
- private static $checkedClasses = array();
- private static $final = array();
- private static $finalMethods = array();
- private static $deprecated = array();
- private static $internal = array();
- private static $internalMethods = array();
- private static $php7Reserved = array('int' => 1, 'float' => 1, 'bool' => 1, 'string' => 1, 'true' => 1, 'false' => 1, 'null' => 1);
- private static $darwinCache = array('/' => array('/', array()));
- public function __construct(callable $classLoader)
- {
- $this->classLoader = $classLoader;
- $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
- if (!isset(self::$caseCheck)) {
- $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
- $i = strrpos($file, \DIRECTORY_SEPARATOR);
- $dir = substr($file, 0, 1 + $i);
- $file = substr($file, 1 + $i);
- $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
- $test = realpath($dir.$test);
- if (false === $test || false === $i) {
- // filesystem is case sensitive
- self::$caseCheck = 0;
- } elseif (substr($test, -\strlen($file)) === $file) {
- // filesystem is case insensitive and realpath() normalizes the case of characters
- self::$caseCheck = 1;
- } elseif (false !== stripos(PHP_OS, 'darwin')) {
- // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
- self::$caseCheck = 2;
- } else {
- // filesystem case checks failed, fallback to disabling them
- self::$caseCheck = 0;
- }
- }
- }
- /**
- * Gets the wrapped class loader.
- *
- * @return callable The wrapped class loader
- */
- public function getClassLoader()
- {
- return $this->classLoader;
- }
- /**
- * Wraps all autoloaders.
- */
- public static function enable()
- {
- // Ensures we don't hit https://bugs.php.net/42098
- class_exists('Symfony\Component\Debug\ErrorHandler');
- class_exists('Psr\Log\LogLevel');
- if (!\is_array($functions = spl_autoload_functions())) {
- return;
- }
- foreach ($functions as $function) {
- spl_autoload_unregister($function);
- }
- foreach ($functions as $function) {
- if (!\is_array($function) || !$function[0] instanceof self) {
- $function = array(new static($function), 'loadClass');
- }
- spl_autoload_register($function);
- }
- }
- /**
- * Disables the wrapping.
- */
- public static function disable()
- {
- if (!\is_array($functions = spl_autoload_functions())) {
- return;
- }
- foreach ($functions as $function) {
- spl_autoload_unregister($function);
- }
- foreach ($functions as $function) {
- if (\is_array($function) && $function[0] instanceof self) {
- $function = $function[0]->getClassLoader();
- }
- spl_autoload_register($function);
- }
- }
- /**
- * Loads the given class or interface.
- *
- * @param string $class The name of the class
- *
- * @throws \RuntimeException
- */
- public function loadClass($class)
- {
- $e = error_reporting(error_reporting() | E_PARSE | E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR);
- try {
- if ($this->isFinder && !isset($this->loaded[$class])) {
- $this->loaded[$class] = true;
- if ($file = $this->classLoader[0]->findFile($class) ?: false) {
- $wasCached = \function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file);
- require $file;
- if ($wasCached) {
- return;
- }
- }
- } else {
- \call_user_func($this->classLoader, $class);
- $file = false;
- }
- } finally {
- error_reporting($e);
- }
- $this->checkClass($class, $file);
- }
- private function checkClass($class, $file = null)
- {
- $exists = null === $file || \class_exists($class, false) || \interface_exists($class, false) || \trait_exists($class, false);
- if (null !== $file && $class && '\\' === $class[0]) {
- $class = substr($class, 1);
- }
- if ($exists) {
- if (isset(self::$checkedClasses[$class])) {
- return;
- }
- self::$checkedClasses[$class] = true;
- $refl = new \ReflectionClass($class);
- if (null === $file && $refl->isInternal()) {
- return;
- }
- $name = $refl->getName();
- if ($name !== $class && 0 === \strcasecmp($name, $class)) {
- throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
- }
- $deprecations = $this->checkAnnotations($refl, $name);
- if (isset(self::$php7Reserved[\strtolower($refl->getShortName())])) {
- $deprecations[] = sprintf('The "%s" class uses the reserved name "%s", it will break on PHP 7 and higher', $name, $refl->getShortName());
- }
- foreach ($deprecations as $message) {
- @trigger_error($message, E_USER_DEPRECATED);
- }
- }
- if (!$file) {
- return;
- }
- if (!$exists) {
- if (false !== strpos($class, '/')) {
- 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));
- }
- 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));
- }
- if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
- throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
- }
- }
- public function checkAnnotations(\ReflectionClass $refl, $class)
- {
- $deprecations = array();
- // Don't trigger deprecations for classes in the same vendor
- if (2 > $len = 1 + (\strpos($class, '\\') ?: \strpos($class, '_'))) {
- $len = 0;
- $ns = '';
- } else {
- $ns = \substr($class, 0, $len);
- }
- // Detect annotations on the class
- if (false !== $doc = $refl->getDocComment()) {
- foreach (array('final', 'deprecated', 'internal') as $annotation) {
- if (false !== \strpos($doc, $annotation) && preg_match('#\n \* @'.$annotation.'(?:( .+?)\.?)?\r?\n \*(?: @|/$)#s', $doc, $notice)) {
- self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
- }
- }
- }
- $parent = \get_parent_class($class);
- $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
- if ($parent) {
- $parentAndOwnInterfaces[$parent] = $parent;
- if (!isset(self::$checkedClasses[$parent])) {
- $this->checkClass($parent);
- }
- if (isset(self::$final[$parent])) {
- $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);
- }
- }
- // Detect if the parent is annotated
- foreach ($parentAndOwnInterfaces + \class_uses($class, false) as $use) {
- if (!isset(self::$checkedClasses[$use])) {
- $this->checkClass($use);
- }
- if (isset(self::$deprecated[$use]) && \strncmp($ns, $use, $len)) {
- $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
- $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
- $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $class, $type, $verb, $use, self::$deprecated[$use]);
- }
- if (isset(self::$internal[$use]) && \strncmp($ns, $use, $len)) {
- $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);
- }
- }
- if (\trait_exists($class)) {
- return $deprecations;
- }
- // Inherit @final and @internal annotations for methods
- self::$finalMethods[$class] = array();
- self::$internalMethods[$class] = array();
- foreach ($parentAndOwnInterfaces as $use) {
- foreach (array('finalMethods', 'internalMethods') as $property) {
- if (isset(self::${$property}[$use])) {
- self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
- }
- }
- }
- foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
- if ($method->class !== $class) {
- continue;
- }
- if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
- list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
- $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);
- }
- if (isset(self::$internalMethods[$class][$method->name])) {
- list($declaringClass, $message) = self::$internalMethods[$class][$method->name];
- if (\strncmp($ns, $declaringClass, $len)) {
- $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);
- }
- }
- // Detect method annotations
- if (false === $doc = $method->getDocComment()) {
- continue;
- }
- foreach (array('final', 'internal') as $annotation) {
- if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
- $message = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
- self::${$annotation.'Methods'}[$class][$method->name] = array($class, $message);
- }
- }
- }
- return $deprecations;
- }
- public function checkCase(\ReflectionClass $refl, $file, $class)
- {
- $real = explode('\\', $class.strrchr($file, '.'));
- $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
- $i = \count($tail) - 1;
- $j = \count($real) - 1;
- while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
- --$i;
- --$j;
- }
- array_splice($tail, 0, $i + 1);
- if (!$tail) {
- return;
- }
- $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
- $tailLen = \strlen($tail);
- $real = $refl->getFileName();
- if (2 === self::$caseCheck) {
- $real = $this->darwinRealpath($real);
- }
- if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
- && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
- ) {
- return array(substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1));
- }
- }
- /**
- * `realpath` on MacOSX doesn't normalize the case of characters.
- */
- private function darwinRealpath($real)
- {
- $i = 1 + strrpos($real, '/');
- $file = substr($real, $i);
- $real = substr($real, 0, $i);
- if (isset(self::$darwinCache[$real])) {
- $kDir = $real;
- } else {
- $kDir = strtolower($real);
- if (isset(self::$darwinCache[$kDir])) {
- $real = self::$darwinCache[$kDir][0];
- } else {
- $dir = getcwd();
- chdir($real);
- $real = getcwd().'/';
- chdir($dir);
- $dir = $real;
- $k = $kDir;
- $i = \strlen($dir) - 1;
- while (!isset(self::$darwinCache[$k])) {
- self::$darwinCache[$k] = array($dir, array());
- self::$darwinCache[$dir] = &self::$darwinCache[$k];
- while ('/' !== $dir[--$i]) {
- }
- $k = substr($k, 0, ++$i);
- $dir = substr($dir, 0, $i--);
- }
- }
- }
- $dirFiles = self::$darwinCache[$kDir][1];
- if (isset($dirFiles[$file])) {
- return $real .= $dirFiles[$file];
- }
- $kFile = strtolower($file);
- if (!isset($dirFiles[$kFile])) {
- foreach (scandir($real, 2) as $f) {
- if ('.' !== $f[0]) {
- $dirFiles[$f] = $f;
- if ($f === $file) {
- $kFile = $k = $file;
- } elseif ($f !== $k = strtolower($f)) {
- $dirFiles[$k] = $f;
- }
- }
- }
- self::$darwinCache[$kDir][1] = $dirFiles;
- }
- return $real .= $dirFiles[$kFile];
- }
- /**
- * `class_implements` includes interfaces from the parents so we have to manually exclude them.
- *
- * @param string $class
- * @param string|false $parent
- *
- * @return string[]
- */
- private function getOwnInterfaces($class, $parent)
- {
- $ownInterfaces = class_implements($class, false);
- if ($parent) {
- foreach (class_implements($parent, false) as $interface) {
- unset($ownInterfaces[$interface]);
- }
- }
- foreach ($ownInterfaces as $interface) {
- foreach (class_implements($interface) as $interface) {
- unset($ownInterfaces[$interface]);
- }
- }
- return $ownInterfaces;
- }
- }
|