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@0:     private static $caseCheck;
Chris@0:     private static $deprecated = array();
Chris@0:     private static $php7Reserved = array('int', 'float', 'bool', 'string', 'true', 'false', 'null');
Chris@0:     private static $darwinCache = array('/' => array('/', array()));
Chris@0: 
Chris@0:     /**
Chris@0:      * Constructor.
Chris@0:      *
Chris@0:      * @param callable $classLoader A class loader
Chris@0:      */
Chris@0:     public function __construct(callable $classLoader)
Chris@0:     {
Chris@0:         $this->classLoader = $classLoader;
Chris@0:         $this->isFinder = is_array($classLoader) && method_exists($classLoader[0], 'findFile');
Chris@0: 
Chris@0:         if (!isset(self::$caseCheck)) {
Chris@0:             $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), DIRECTORY_SEPARATOR);
Chris@0:             $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@0:             } 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@0:         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@0:             if (!is_array($function) || !$function[0] instanceof self) {
Chris@0:                 $function = array(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@0:         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@0:             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@0:      * Loads the given class or interface.
Chris@0:      *
Chris@0:      * @param string $class The name of the class
Chris@0:      *
Chris@0:      * @return bool|null True, if loaded
Chris@0:      *
Chris@0:      * @throws \RuntimeException
Chris@0:      */
Chris@0:     public function loadClass($class)
Chris@0:     {
Chris@0:         ErrorHandler::stackErrors();
Chris@0: 
Chris@0:         try {
Chris@0:             if ($this->isFinder) {
Chris@0:                 if ($file = $this->classLoader[0]->findFile($class)) {
Chris@0:                     require_once $file;
Chris@0:                 }
Chris@0:             } else {
Chris@0:                 call_user_func($this->classLoader, $class);
Chris@0:                 $file = false;
Chris@0:             }
Chris@0:         } finally {
Chris@0:             ErrorHandler::unstackErrors();
Chris@0:         }
Chris@0: 
Chris@0:         $exists = class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false);
Chris@0: 
Chris@0:         if ($class && '\\' === $class[0]) {
Chris@0:             $class = substr($class, 1);
Chris@0:         }
Chris@0: 
Chris@0:         if ($exists) {
Chris@0:             $refl = new \ReflectionClass($class);
Chris@0:             $name = $refl->getName();
Chris@0: 
Chris@0:             if ($name !== $class && 0 === strcasecmp($name, $class)) {
Chris@0:                 throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: %s vs %s', $class, $name));
Chris@0:             }
Chris@0: 
Chris@0:             if (in_array(strtolower($refl->getShortName()), self::$php7Reserved)) {
Chris@0:                 @trigger_error(sprintf('%s uses a reserved class name (%s) that will break on PHP 7 and higher', $name, $refl->getShortName()), E_USER_DEPRECATED);
Chris@0:             } elseif (preg_match('#\n \* @deprecated (.*?)\r?\n \*(?: @|/$)#s', $refl->getDocComment(), $notice)) {
Chris@0:                 self::$deprecated[$name] = preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]);
Chris@0:             } else {
Chris@0:                 if (2 > $len = 1 + (strpos($name, '\\', 1 + strpos($name, '\\')) ?: strpos($name, '_'))) {
Chris@0:                     $len = 0;
Chris@0:                     $ns = '';
Chris@0:                 } else {
Chris@0:                     switch ($ns = substr($name, 0, $len)) {
Chris@0:                         case 'Symfony\Bridge\\':
Chris@0:                         case 'Symfony\Bundle\\':
Chris@0:                         case 'Symfony\Component\\':
Chris@0:                             $ns = 'Symfony\\';
Chris@0:                             $len = strlen($ns);
Chris@0:                             break;
Chris@0:                     }
Chris@0:                 }
Chris@0:                 $parent = get_parent_class($class);
Chris@0: 
Chris@0:                 if (!$parent || strncmp($ns, $parent, $len)) {
Chris@0:                     if ($parent && isset(self::$deprecated[$parent]) && strncmp($ns, $parent, $len)) {
Chris@0:                         @trigger_error(sprintf('The %s class extends %s that is deprecated %s', $name, $parent, self::$deprecated[$parent]), E_USER_DEPRECATED);
Chris@0:                     }
Chris@0: 
Chris@0:                     $parentInterfaces = array();
Chris@0:                     $deprecatedInterfaces = array();
Chris@0:                     if ($parent) {
Chris@0:                         foreach (class_implements($parent) as $interface) {
Chris@0:                             $parentInterfaces[$interface] = 1;
Chris@0:                         }
Chris@0:                     }
Chris@0: 
Chris@0:                     foreach ($refl->getInterfaceNames() as $interface) {
Chris@0:                         if (isset(self::$deprecated[$interface]) && strncmp($ns, $interface, $len)) {
Chris@0:                             $deprecatedInterfaces[] = $interface;
Chris@0:                         }
Chris@0:                         foreach (class_implements($interface) as $interface) {
Chris@0:                             $parentInterfaces[$interface] = 1;
Chris@0:                         }
Chris@0:                     }
Chris@0: 
Chris@0:                     foreach ($deprecatedInterfaces as $interface) {
Chris@0:                         if (!isset($parentInterfaces[$interface])) {
Chris@0:                             @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);
Chris@0:                         }
Chris@0:                     }
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if ($file) {
Chris@0:             if (!$exists) {
Chris@0:                 if (false !== strpos($class, '/')) {
Chris@0:                     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@0:                 }
Chris@0: 
Chris@0:                 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@0:             }
Chris@0:             if (self::$caseCheck) {
Chris@0:                 $real = explode('\\', $class.strrchr($file, '.'));
Chris@0:                 $tail = explode(DIRECTORY_SEPARATOR, str_replace('/', DIRECTORY_SEPARATOR, $file));
Chris@0: 
Chris@0:                 $i = count($tail) - 1;
Chris@0:                 $j = count($real) - 1;
Chris@0: 
Chris@0:                 while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
Chris@0:                     --$i;
Chris@0:                     --$j;
Chris@0:                 }
Chris@0: 
Chris@0:                 array_splice($tail, 0, $i + 1);
Chris@0:             }
Chris@0:             if (self::$caseCheck && $tail) {
Chris@0:                 $tail = DIRECTORY_SEPARATOR.implode(DIRECTORY_SEPARATOR, $tail);
Chris@0:                 $tailLen = strlen($tail);
Chris@0:                 $real = $refl->getFileName();
Chris@0: 
Chris@0:                 if (2 === self::$caseCheck) {
Chris@0:                     // realpath() on MacOSX doesn't normalize the case of characters
Chris@0: 
Chris@0:                     $i = 1 + strrpos($real, '/');
Chris@0:                     $file = substr($real, $i);
Chris@0:                     $real = substr($real, 0, $i);
Chris@0: 
Chris@0:                     if (isset(self::$darwinCache[$real])) {
Chris@0:                         $kDir = $real;
Chris@0:                     } else {
Chris@0:                         $kDir = strtolower($real);
Chris@0: 
Chris@0:                         if (isset(self::$darwinCache[$kDir])) {
Chris@0:                             $real = self::$darwinCache[$kDir][0];
Chris@0:                         } else {
Chris@0:                             $dir = getcwd();
Chris@0:                             chdir($real);
Chris@0:                             $real = getcwd().'/';
Chris@0:                             chdir($dir);
Chris@0: 
Chris@0:                             $dir = $real;
Chris@0:                             $k = $kDir;
Chris@0:                             $i = strlen($dir) - 1;
Chris@0:                             while (!isset(self::$darwinCache[$k])) {
Chris@0:                                 self::$darwinCache[$k] = array($dir, array());
Chris@0:                                 self::$darwinCache[$dir] = &self::$darwinCache[$k];
Chris@0: 
Chris@0:                                 while ('/' !== $dir[--$i]) {
Chris@0:                                 }
Chris@0:                                 $k = substr($k, 0, ++$i);
Chris@0:                                 $dir = substr($dir, 0, $i--);
Chris@0:                             }
Chris@0:                         }
Chris@0:                     }
Chris@0: 
Chris@0:                     $dirFiles = self::$darwinCache[$kDir][1];
Chris@0: 
Chris@0:                     if (isset($dirFiles[$file])) {
Chris@0:                         $kFile = $file;
Chris@0:                     } else {
Chris@0:                         $kFile = strtolower($file);
Chris@0: 
Chris@0:                         if (!isset($dirFiles[$kFile])) {
Chris@0:                             foreach (scandir($real, 2) as $f) {
Chris@0:                                 if ('.' !== $f[0]) {
Chris@0:                                     $dirFiles[$f] = $f;
Chris@0:                                     if ($f === $file) {
Chris@0:                                         $kFile = $k = $file;
Chris@0:                                     } elseif ($f !== $k = strtolower($f)) {
Chris@0:                                         $dirFiles[$k] = $f;
Chris@0:                                     }
Chris@0:                                 }
Chris@0:                             }
Chris@0:                             self::$darwinCache[$kDir][1] = $dirFiles;
Chris@0:                         }
Chris@0:                     }
Chris@0: 
Chris@0:                     $real .= $dirFiles[$kFile];
Chris@0:                 }
Chris@0: 
Chris@0:                 if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
Chris@0:                   && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
Chris@0:                 ) {
Chris@0:                     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)));
Chris@0:                 }
Chris@0:             }
Chris@0: 
Chris@0:             return true;
Chris@0:         }
Chris@0:     }
Chris@0: }