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