DebugClassLoader.php 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Debug;
  11. /**
  12. * Autoloader checking if the class is really defined in the file found.
  13. *
  14. * The ClassLoader will wrap all registered autoloaders
  15. * and will throw an exception if a file is found but does
  16. * not declare the class.
  17. *
  18. * @author Fabien Potencier <fabien@symfony.com>
  19. * @author Christophe Coevoet <stof@notk.org>
  20. * @author Nicolas Grekas <p@tchwork.com>
  21. */
  22. class DebugClassLoader
  23. {
  24. private $classLoader;
  25. private $isFinder;
  26. private $loaded = array();
  27. private static $caseCheck;
  28. private static $checkedClasses = array();
  29. private static $final = array();
  30. private static $finalMethods = array();
  31. private static $deprecated = array();
  32. private static $internal = array();
  33. private static $internalMethods = array();
  34. private static $php7Reserved = array('int' => 1, 'float' => 1, 'bool' => 1, 'string' => 1, 'true' => 1, 'false' => 1, 'null' => 1);
  35. private static $darwinCache = array('/' => array('/', array()));
  36. public function __construct(callable $classLoader)
  37. {
  38. $this->classLoader = $classLoader;
  39. $this->isFinder = \is_array($classLoader) && method_exists($classLoader[0], 'findFile');
  40. if (!isset(self::$caseCheck)) {
  41. $file = file_exists(__FILE__) ? __FILE__ : rtrim(realpath('.'), \DIRECTORY_SEPARATOR);
  42. $i = strrpos($file, \DIRECTORY_SEPARATOR);
  43. $dir = substr($file, 0, 1 + $i);
  44. $file = substr($file, 1 + $i);
  45. $test = strtoupper($file) === $file ? strtolower($file) : strtoupper($file);
  46. $test = realpath($dir.$test);
  47. if (false === $test || false === $i) {
  48. // filesystem is case sensitive
  49. self::$caseCheck = 0;
  50. } elseif (substr($test, -\strlen($file)) === $file) {
  51. // filesystem is case insensitive and realpath() normalizes the case of characters
  52. self::$caseCheck = 1;
  53. } elseif (false !== stripos(PHP_OS, 'darwin')) {
  54. // on MacOSX, HFS+ is case insensitive but realpath() doesn't normalize the case of characters
  55. self::$caseCheck = 2;
  56. } else {
  57. // filesystem case checks failed, fallback to disabling them
  58. self::$caseCheck = 0;
  59. }
  60. }
  61. }
  62. /**
  63. * Gets the wrapped class loader.
  64. *
  65. * @return callable The wrapped class loader
  66. */
  67. public function getClassLoader()
  68. {
  69. return $this->classLoader;
  70. }
  71. /**
  72. * Wraps all autoloaders.
  73. */
  74. public static function enable()
  75. {
  76. // Ensures we don't hit https://bugs.php.net/42098
  77. class_exists('Symfony\Component\Debug\ErrorHandler');
  78. class_exists('Psr\Log\LogLevel');
  79. if (!\is_array($functions = spl_autoload_functions())) {
  80. return;
  81. }
  82. foreach ($functions as $function) {
  83. spl_autoload_unregister($function);
  84. }
  85. foreach ($functions as $function) {
  86. if (!\is_array($function) || !$function[0] instanceof self) {
  87. $function = array(new static($function), 'loadClass');
  88. }
  89. spl_autoload_register($function);
  90. }
  91. }
  92. /**
  93. * Disables the wrapping.
  94. */
  95. public static function disable()
  96. {
  97. if (!\is_array($functions = spl_autoload_functions())) {
  98. return;
  99. }
  100. foreach ($functions as $function) {
  101. spl_autoload_unregister($function);
  102. }
  103. foreach ($functions as $function) {
  104. if (\is_array($function) && $function[0] instanceof self) {
  105. $function = $function[0]->getClassLoader();
  106. }
  107. spl_autoload_register($function);
  108. }
  109. }
  110. /**
  111. * Loads the given class or interface.
  112. *
  113. * @param string $class The name of the class
  114. *
  115. * @throws \RuntimeException
  116. */
  117. public function loadClass($class)
  118. {
  119. $e = error_reporting(error_reporting() | E_PARSE | E_ERROR | E_CORE_ERROR | E_COMPILE_ERROR);
  120. try {
  121. if ($this->isFinder && !isset($this->loaded[$class])) {
  122. $this->loaded[$class] = true;
  123. if ($file = $this->classLoader[0]->findFile($class) ?: false) {
  124. $wasCached = \function_exists('opcache_is_script_cached') && @opcache_is_script_cached($file);
  125. require $file;
  126. if ($wasCached) {
  127. return;
  128. }
  129. }
  130. } else {
  131. \call_user_func($this->classLoader, $class);
  132. $file = false;
  133. }
  134. } finally {
  135. error_reporting($e);
  136. }
  137. $this->checkClass($class, $file);
  138. }
  139. private function checkClass($class, $file = null)
  140. {
  141. $exists = null === $file || \class_exists($class, false) || \interface_exists($class, false) || \trait_exists($class, false);
  142. if (null !== $file && $class && '\\' === $class[0]) {
  143. $class = substr($class, 1);
  144. }
  145. if ($exists) {
  146. if (isset(self::$checkedClasses[$class])) {
  147. return;
  148. }
  149. self::$checkedClasses[$class] = true;
  150. $refl = new \ReflectionClass($class);
  151. if (null === $file && $refl->isInternal()) {
  152. return;
  153. }
  154. $name = $refl->getName();
  155. if ($name !== $class && 0 === \strcasecmp($name, $class)) {
  156. throw new \RuntimeException(sprintf('Case mismatch between loaded and declared class names: "%s" vs "%s".', $class, $name));
  157. }
  158. $deprecations = $this->checkAnnotations($refl, $name);
  159. if (isset(self::$php7Reserved[\strtolower($refl->getShortName())])) {
  160. $deprecations[] = sprintf('The "%s" class uses the reserved name "%s", it will break on PHP 7 and higher', $name, $refl->getShortName());
  161. }
  162. foreach ($deprecations as $message) {
  163. @trigger_error($message, E_USER_DEPRECATED);
  164. }
  165. }
  166. if (!$file) {
  167. return;
  168. }
  169. if (!$exists) {
  170. if (false !== strpos($class, '/')) {
  171. 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));
  172. }
  173. 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));
  174. }
  175. if (self::$caseCheck && $message = $this->checkCase($refl, $file, $class)) {
  176. throw new \RuntimeException(sprintf('Case mismatch between class and real file names: "%s" vs "%s" in "%s".', $message[0], $message[1], $message[2]));
  177. }
  178. }
  179. public function checkAnnotations(\ReflectionClass $refl, $class)
  180. {
  181. $deprecations = array();
  182. // Don't trigger deprecations for classes in the same vendor
  183. if (2 > $len = 1 + (\strpos($class, '\\') ?: \strpos($class, '_'))) {
  184. $len = 0;
  185. $ns = '';
  186. } else {
  187. $ns = \substr($class, 0, $len);
  188. }
  189. // Detect annotations on the class
  190. if (false !== $doc = $refl->getDocComment()) {
  191. foreach (array('final', 'deprecated', 'internal') as $annotation) {
  192. if (false !== \strpos($doc, $annotation) && preg_match('#\n \* @'.$annotation.'(?:( .+?)\.?)?\r?\n \*(?: @|/$)#s', $doc, $notice)) {
  193. self::${$annotation}[$class] = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
  194. }
  195. }
  196. }
  197. $parent = \get_parent_class($class);
  198. $parentAndOwnInterfaces = $this->getOwnInterfaces($class, $parent);
  199. if ($parent) {
  200. $parentAndOwnInterfaces[$parent] = $parent;
  201. if (!isset(self::$checkedClasses[$parent])) {
  202. $this->checkClass($parent);
  203. }
  204. if (isset(self::$final[$parent])) {
  205. $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);
  206. }
  207. }
  208. // Detect if the parent is annotated
  209. foreach ($parentAndOwnInterfaces + \class_uses($class, false) as $use) {
  210. if (!isset(self::$checkedClasses[$use])) {
  211. $this->checkClass($use);
  212. }
  213. if (isset(self::$deprecated[$use]) && \strncmp($ns, $use, $len)) {
  214. $type = class_exists($class, false) ? 'class' : (interface_exists($class, false) ? 'interface' : 'trait');
  215. $verb = class_exists($use, false) || interface_exists($class, false) ? 'extends' : (interface_exists($use, false) ? 'implements' : 'uses');
  216. $deprecations[] = sprintf('The "%s" %s %s "%s" that is deprecated%s.', $class, $type, $verb, $use, self::$deprecated[$use]);
  217. }
  218. if (isset(self::$internal[$use]) && \strncmp($ns, $use, $len)) {
  219. $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);
  220. }
  221. }
  222. if (\trait_exists($class)) {
  223. return $deprecations;
  224. }
  225. // Inherit @final and @internal annotations for methods
  226. self::$finalMethods[$class] = array();
  227. self::$internalMethods[$class] = array();
  228. foreach ($parentAndOwnInterfaces as $use) {
  229. foreach (array('finalMethods', 'internalMethods') as $property) {
  230. if (isset(self::${$property}[$use])) {
  231. self::${$property}[$class] = self::${$property}[$class] ? self::${$property}[$use] + self::${$property}[$class] : self::${$property}[$use];
  232. }
  233. }
  234. }
  235. foreach ($refl->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $method) {
  236. if ($method->class !== $class) {
  237. continue;
  238. }
  239. if ($parent && isset(self::$finalMethods[$parent][$method->name])) {
  240. list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
  241. $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);
  242. }
  243. if (isset(self::$internalMethods[$class][$method->name])) {
  244. list($declaringClass, $message) = self::$internalMethods[$class][$method->name];
  245. if (\strncmp($ns, $declaringClass, $len)) {
  246. $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);
  247. }
  248. }
  249. // Detect method annotations
  250. if (false === $doc = $method->getDocComment()) {
  251. continue;
  252. }
  253. foreach (array('final', 'internal') as $annotation) {
  254. if (false !== \strpos($doc, $annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
  255. $message = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
  256. self::${$annotation.'Methods'}[$class][$method->name] = array($class, $message);
  257. }
  258. }
  259. }
  260. return $deprecations;
  261. }
  262. public function checkCase(\ReflectionClass $refl, $file, $class)
  263. {
  264. $real = explode('\\', $class.strrchr($file, '.'));
  265. $tail = explode(\DIRECTORY_SEPARATOR, str_replace('/', \DIRECTORY_SEPARATOR, $file));
  266. $i = \count($tail) - 1;
  267. $j = \count($real) - 1;
  268. while (isset($tail[$i], $real[$j]) && $tail[$i] === $real[$j]) {
  269. --$i;
  270. --$j;
  271. }
  272. array_splice($tail, 0, $i + 1);
  273. if (!$tail) {
  274. return;
  275. }
  276. $tail = \DIRECTORY_SEPARATOR.implode(\DIRECTORY_SEPARATOR, $tail);
  277. $tailLen = \strlen($tail);
  278. $real = $refl->getFileName();
  279. if (2 === self::$caseCheck) {
  280. $real = $this->darwinRealpath($real);
  281. }
  282. if (0 === substr_compare($real, $tail, -$tailLen, $tailLen, true)
  283. && 0 !== substr_compare($real, $tail, -$tailLen, $tailLen, false)
  284. ) {
  285. return array(substr($tail, -$tailLen + 1), substr($real, -$tailLen + 1), substr($real, 0, -$tailLen + 1));
  286. }
  287. }
  288. /**
  289. * `realpath` on MacOSX doesn't normalize the case of characters.
  290. */
  291. private function darwinRealpath($real)
  292. {
  293. $i = 1 + strrpos($real, '/');
  294. $file = substr($real, $i);
  295. $real = substr($real, 0, $i);
  296. if (isset(self::$darwinCache[$real])) {
  297. $kDir = $real;
  298. } else {
  299. $kDir = strtolower($real);
  300. if (isset(self::$darwinCache[$kDir])) {
  301. $real = self::$darwinCache[$kDir][0];
  302. } else {
  303. $dir = getcwd();
  304. chdir($real);
  305. $real = getcwd().'/';
  306. chdir($dir);
  307. $dir = $real;
  308. $k = $kDir;
  309. $i = \strlen($dir) - 1;
  310. while (!isset(self::$darwinCache[$k])) {
  311. self::$darwinCache[$k] = array($dir, array());
  312. self::$darwinCache[$dir] = &self::$darwinCache[$k];
  313. while ('/' !== $dir[--$i]) {
  314. }
  315. $k = substr($k, 0, ++$i);
  316. $dir = substr($dir, 0, $i--);
  317. }
  318. }
  319. }
  320. $dirFiles = self::$darwinCache[$kDir][1];
  321. if (isset($dirFiles[$file])) {
  322. return $real .= $dirFiles[$file];
  323. }
  324. $kFile = strtolower($file);
  325. if (!isset($dirFiles[$kFile])) {
  326. foreach (scandir($real, 2) as $f) {
  327. if ('.' !== $f[0]) {
  328. $dirFiles[$f] = $f;
  329. if ($f === $file) {
  330. $kFile = $k = $file;
  331. } elseif ($f !== $k = strtolower($f)) {
  332. $dirFiles[$k] = $f;
  333. }
  334. }
  335. }
  336. self::$darwinCache[$kDir][1] = $dirFiles;
  337. }
  338. return $real .= $dirFiles[$kFile];
  339. }
  340. /**
  341. * `class_implements` includes interfaces from the parents so we have to manually exclude them.
  342. *
  343. * @param string $class
  344. * @param string|false $parent
  345. *
  346. * @return string[]
  347. */
  348. private function getOwnInterfaces($class, $parent)
  349. {
  350. $ownInterfaces = class_implements($class, false);
  351. if ($parent) {
  352. foreach (class_implements($parent, false) as $interface) {
  353. unset($ownInterfaces[$interface]);
  354. }
  355. }
  356. foreach ($ownInterfaces as $interface) {
  357. foreach (class_implements($interface) as $interface) {
  358. unset($ownInterfaces[$interface]);
  359. }
  360. }
  361. return $ownInterfaces;
  362. }
  363. }