449 lines
15 KiB
PHP
449 lines
15 KiB
PHP
<?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\ClassLoader;
|
|
|
|
if (\PHP_VERSION_ID >= 70000) {
|
|
@trigger_error('The '.__NAMESPACE__.'\ClassCollectionLoader class is deprecated since Symfony 3.3 and will be removed in 4.0.', E_USER_DEPRECATED);
|
|
}
|
|
|
|
/**
|
|
* ClassCollectionLoader.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* @deprecated since version 3.3, to be removed in 4.0.
|
|
*/
|
|
class ClassCollectionLoader
|
|
{
|
|
private static $loaded;
|
|
private static $seen;
|
|
private static $useTokenizer = true;
|
|
|
|
/**
|
|
* Loads a list of classes and caches them in one big file.
|
|
*
|
|
* @param array $classes An array of classes to load
|
|
* @param string $cacheDir A cache directory
|
|
* @param string $name The cache name prefix
|
|
* @param bool $autoReload Whether to flush the cache when the cache is stale or not
|
|
* @param bool $adaptive Whether to remove already declared classes or not
|
|
* @param string $extension File extension of the resulting file
|
|
*
|
|
* @throws \InvalidArgumentException When class can't be loaded
|
|
*/
|
|
public static function load($classes, $cacheDir, $name, $autoReload, $adaptive = false, $extension = '.php')
|
|
{
|
|
// each $name can only be loaded once per PHP process
|
|
if (isset(self::$loaded[$name])) {
|
|
return;
|
|
}
|
|
|
|
self::$loaded[$name] = true;
|
|
|
|
if ($adaptive) {
|
|
$declared = array_merge(get_declared_classes(), get_declared_interfaces(), get_declared_traits());
|
|
|
|
// don't include already declared classes
|
|
$classes = array_diff($classes, $declared);
|
|
|
|
// the cache is different depending on which classes are already declared
|
|
$name .= '-'.substr(hash('sha256', implode('|', $classes)), 0, 5);
|
|
}
|
|
|
|
$classes = array_unique($classes);
|
|
|
|
// cache the core classes
|
|
if (!is_dir($cacheDir) && !@mkdir($cacheDir, 0777, true) && !is_dir($cacheDir)) {
|
|
throw new \RuntimeException(sprintf('Class Collection Loader was not able to create directory "%s".', $cacheDir));
|
|
}
|
|
$cacheDir = rtrim(realpath($cacheDir) ?: $cacheDir, '/'.\DIRECTORY_SEPARATOR);
|
|
$cache = $cacheDir.'/'.$name.$extension;
|
|
|
|
// auto-reload
|
|
$reload = false;
|
|
if ($autoReload) {
|
|
$metadata = $cache.'.meta';
|
|
if (!is_file($metadata) || !is_file($cache)) {
|
|
$reload = true;
|
|
} else {
|
|
$time = filemtime($cache);
|
|
$meta = unserialize(file_get_contents($metadata));
|
|
|
|
sort($meta[1]);
|
|
sort($classes);
|
|
|
|
if ($meta[1] != $classes) {
|
|
$reload = true;
|
|
} else {
|
|
foreach ($meta[0] as $resource) {
|
|
if (!is_file($resource) || filemtime($resource) > $time) {
|
|
$reload = true;
|
|
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$reload && file_exists($cache)) {
|
|
require_once $cache;
|
|
|
|
return;
|
|
}
|
|
if (!$adaptive) {
|
|
$declared = array_merge(get_declared_classes(), get_declared_interfaces(), get_declared_traits());
|
|
}
|
|
|
|
$files = self::inline($classes, $cache, $declared);
|
|
|
|
if ($autoReload) {
|
|
// save the resources
|
|
self::writeCacheFile($metadata, serialize([array_values($files), $classes]));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates a file where classes and their parents are inlined.
|
|
*
|
|
* @param array $classes An array of classes to load
|
|
* @param string $cache The file where classes are inlined
|
|
* @param array $excluded An array of classes that won't be inlined
|
|
*
|
|
* @return array The source map of inlined classes, with classes as keys and files as values
|
|
*
|
|
* @throws \RuntimeException When class can't be loaded
|
|
*/
|
|
public static function inline($classes, $cache, array $excluded)
|
|
{
|
|
$declared = [];
|
|
foreach (self::getOrderedClasses($excluded) as $class) {
|
|
$declared[$class->getName()] = true;
|
|
}
|
|
|
|
// cache the core classes
|
|
$cacheDir = \dirname($cache);
|
|
if (!is_dir($cacheDir) && !@mkdir($cacheDir, 0777, true) && !is_dir($cacheDir)) {
|
|
throw new \RuntimeException(sprintf('Class Collection Loader was not able to create directory "%s".', $cacheDir));
|
|
}
|
|
|
|
$spacesRegex = '(?:\s*+(?:(?:\#|//)[^\n]*+\n|/\*(?:(?<!\*/).)++)?+)*+';
|
|
$dontInlineRegex = <<<REGEX
|
|
'(?:
|
|
^<\?php\s.declare.\(.strict_types.=.1.\).;
|
|
| \b__halt_compiler.\(.\)
|
|
| \b__(?:DIR|FILE)__\b
|
|
)'isx
|
|
REGEX;
|
|
$dontInlineRegex = str_replace('.', $spacesRegex, $dontInlineRegex);
|
|
|
|
$cacheDir = explode('/', str_replace(\DIRECTORY_SEPARATOR, '/', $cacheDir));
|
|
$files = [];
|
|
$content = '';
|
|
foreach (self::getOrderedClasses($classes) as $class) {
|
|
if (isset($declared[$class->getName()])) {
|
|
continue;
|
|
}
|
|
$declared[$class->getName()] = true;
|
|
|
|
$files[$class->getName()] = $file = $class->getFileName();
|
|
$c = file_get_contents($file);
|
|
|
|
if (preg_match($dontInlineRegex, $c)) {
|
|
$file = explode('/', str_replace(\DIRECTORY_SEPARATOR, '/', $file));
|
|
|
|
for ($i = 0; isset($file[$i], $cacheDir[$i]); ++$i) {
|
|
if ($file[$i] !== $cacheDir[$i]) {
|
|
break;
|
|
}
|
|
}
|
|
if (1 >= $i) {
|
|
$file = var_export(implode('/', $file), true);
|
|
} else {
|
|
$file = \array_slice($file, $i);
|
|
$file = str_repeat('../', \count($cacheDir) - $i).implode('/', $file);
|
|
$file = '__DIR__.'.var_export('/'.$file, true);
|
|
}
|
|
|
|
$c = "\nnamespace {require $file;}";
|
|
} else {
|
|
$c = preg_replace(['/^\s*<\?php/', '/\?>\s*$/'], '', $c);
|
|
|
|
// fakes namespace declaration for global code
|
|
if (!$class->inNamespace()) {
|
|
$c = "\nnamespace\n{\n".$c."\n}\n";
|
|
}
|
|
|
|
$c = self::fixNamespaceDeclarations('<?php '.$c);
|
|
$c = preg_replace('/^\s*<\?php/', '', $c);
|
|
}
|
|
|
|
$content .= $c;
|
|
}
|
|
self::writeCacheFile($cache, '<?php '.$content);
|
|
|
|
return $files;
|
|
}
|
|
|
|
/**
|
|
* Adds brackets around each namespace if it's not already the case.
|
|
*
|
|
* @param string $source Namespace string
|
|
*
|
|
* @return string Namespaces with brackets
|
|
*/
|
|
public static function fixNamespaceDeclarations($source)
|
|
{
|
|
if (!\function_exists('token_get_all') || !self::$useTokenizer) {
|
|
if (preg_match('/(^|\s)namespace(.*?)\s*;/', $source)) {
|
|
$source = preg_replace('/(^|\s)namespace(.*?)\s*;/', "$1namespace$2\n{", $source)."}\n";
|
|
}
|
|
|
|
return $source;
|
|
}
|
|
|
|
$rawChunk = '';
|
|
$output = '';
|
|
$inNamespace = false;
|
|
$tokens = token_get_all($source);
|
|
|
|
for ($i = 0; isset($tokens[$i]); ++$i) {
|
|
$token = $tokens[$i];
|
|
if (!isset($token[1]) || 'b"' === $token) {
|
|
$rawChunk .= $token;
|
|
} elseif (\in_array($token[0], [T_COMMENT, T_DOC_COMMENT])) {
|
|
// strip comments
|
|
continue;
|
|
} elseif (T_NAMESPACE === $token[0]) {
|
|
if ($inNamespace) {
|
|
$rawChunk .= "}\n";
|
|
}
|
|
$rawChunk .= $token[1];
|
|
|
|
// namespace name and whitespaces
|
|
while (isset($tokens[++$i][1]) && \in_array($tokens[$i][0], [T_WHITESPACE, T_NS_SEPARATOR, T_STRING])) {
|
|
$rawChunk .= $tokens[$i][1];
|
|
}
|
|
if ('{' === $tokens[$i]) {
|
|
$inNamespace = false;
|
|
--$i;
|
|
} else {
|
|
$rawChunk = rtrim($rawChunk)."\n{";
|
|
$inNamespace = true;
|
|
}
|
|
} elseif (T_START_HEREDOC === $token[0]) {
|
|
$output .= self::compressCode($rawChunk).$token[1];
|
|
do {
|
|
$token = $tokens[++$i];
|
|
$output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
|
|
} while (T_END_HEREDOC !== $token[0]);
|
|
$output .= "\n";
|
|
$rawChunk = '';
|
|
} elseif (T_CONSTANT_ENCAPSED_STRING === $token[0]) {
|
|
$output .= self::compressCode($rawChunk).$token[1];
|
|
$rawChunk = '';
|
|
} else {
|
|
$rawChunk .= $token[1];
|
|
}
|
|
}
|
|
|
|
if ($inNamespace) {
|
|
$rawChunk .= "}\n";
|
|
}
|
|
|
|
$output .= self::compressCode($rawChunk);
|
|
|
|
if (\PHP_VERSION_ID >= 70000) {
|
|
// PHP 7 memory manager will not release after token_get_all(), see https://bugs.php.net/70098
|
|
unset($tokens, $rawChunk);
|
|
gc_mem_caches();
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* This method is only useful for testing.
|
|
*/
|
|
public static function enableTokenizer($bool)
|
|
{
|
|
self::$useTokenizer = (bool) $bool;
|
|
}
|
|
|
|
/**
|
|
* Strips leading & trailing ws, multiple EOL, multiple ws.
|
|
*
|
|
* @param string $code Original PHP code
|
|
*
|
|
* @return string compressed code
|
|
*/
|
|
private static function compressCode($code)
|
|
{
|
|
return preg_replace(
|
|
['/^\s+/m', '/\s+$/m', '/([\n\r]+ *[\n\r]+)+/', '/[ \t]+/'],
|
|
['', '', "\n", ' '],
|
|
$code
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Writes a cache file.
|
|
*
|
|
* @param string $file Filename
|
|
* @param string $content Temporary file content
|
|
*
|
|
* @throws \RuntimeException when a cache file cannot be written
|
|
*/
|
|
private static function writeCacheFile($file, $content)
|
|
{
|
|
$dir = \dirname($file);
|
|
if (!is_writable($dir)) {
|
|
throw new \RuntimeException(sprintf('Cache directory "%s" is not writable.', $dir));
|
|
}
|
|
|
|
$tmpFile = tempnam($dir, basename($file));
|
|
|
|
if (false !== @file_put_contents($tmpFile, $content) && @rename($tmpFile, $file)) {
|
|
@chmod($file, 0666 & ~umask());
|
|
|
|
return;
|
|
}
|
|
|
|
throw new \RuntimeException(sprintf('Failed to write cache file "%s".', $file));
|
|
}
|
|
|
|
/**
|
|
* Gets an ordered array of passed classes including all their dependencies.
|
|
*
|
|
* @return \ReflectionClass[] An array of sorted \ReflectionClass instances (dependencies added if needed)
|
|
*
|
|
* @throws \InvalidArgumentException When a class can't be loaded
|
|
*/
|
|
private static function getOrderedClasses(array $classes)
|
|
{
|
|
$map = [];
|
|
self::$seen = [];
|
|
foreach ($classes as $class) {
|
|
try {
|
|
$reflectionClass = new \ReflectionClass($class);
|
|
} catch (\ReflectionException $e) {
|
|
throw new \InvalidArgumentException(sprintf('Unable to load class "%s".', $class));
|
|
}
|
|
|
|
$map = array_merge($map, self::getClassHierarchy($reflectionClass));
|
|
}
|
|
|
|
return $map;
|
|
}
|
|
|
|
private static function getClassHierarchy(\ReflectionClass $class)
|
|
{
|
|
if (isset(self::$seen[$class->getName()])) {
|
|
return [];
|
|
}
|
|
|
|
self::$seen[$class->getName()] = true;
|
|
|
|
$classes = [$class];
|
|
$parent = $class;
|
|
while (($parent = $parent->getParentClass()) && $parent->isUserDefined() && !isset(self::$seen[$parent->getName()])) {
|
|
self::$seen[$parent->getName()] = true;
|
|
|
|
array_unshift($classes, $parent);
|
|
}
|
|
|
|
$traits = [];
|
|
|
|
foreach ($classes as $c) {
|
|
foreach (self::resolveDependencies(self::computeTraitDeps($c), $c) as $trait) {
|
|
if ($trait !== $c) {
|
|
$traits[] = $trait;
|
|
}
|
|
}
|
|
}
|
|
|
|
return array_merge(self::getInterfaces($class), $traits, $classes);
|
|
}
|
|
|
|
private static function getInterfaces(\ReflectionClass $class)
|
|
{
|
|
$classes = [];
|
|
|
|
foreach ($class->getInterfaces() as $interface) {
|
|
$classes = array_merge($classes, self::getInterfaces($interface));
|
|
}
|
|
|
|
if ($class->isUserDefined() && $class->isInterface() && !isset(self::$seen[$class->getName()])) {
|
|
self::$seen[$class->getName()] = true;
|
|
|
|
$classes[] = $class;
|
|
}
|
|
|
|
return $classes;
|
|
}
|
|
|
|
private static function computeTraitDeps(\ReflectionClass $class)
|
|
{
|
|
$traits = $class->getTraits();
|
|
$deps = [$class->getName() => $traits];
|
|
while ($trait = array_pop($traits)) {
|
|
if ($trait->isUserDefined() && !isset(self::$seen[$trait->getName()])) {
|
|
self::$seen[$trait->getName()] = true;
|
|
$traitDeps = $trait->getTraits();
|
|
$deps[$trait->getName()] = $traitDeps;
|
|
$traits = array_merge($traits, $traitDeps);
|
|
}
|
|
}
|
|
|
|
return $deps;
|
|
}
|
|
|
|
/**
|
|
* Dependencies resolution.
|
|
*
|
|
* This function does not check for circular dependencies as it should never
|
|
* occur with PHP traits.
|
|
*
|
|
* @param array $tree The dependency tree
|
|
* @param \ReflectionClass $node The node
|
|
* @param \ArrayObject $resolved An array of already resolved dependencies
|
|
* @param \ArrayObject $unresolved An array of dependencies to be resolved
|
|
*
|
|
* @return \ArrayObject The dependencies for the given node
|
|
*
|
|
* @throws \RuntimeException if a circular dependency is detected
|
|
*/
|
|
private static function resolveDependencies(array $tree, $node, \ArrayObject $resolved = null, \ArrayObject $unresolved = null)
|
|
{
|
|
if (null === $resolved) {
|
|
$resolved = new \ArrayObject();
|
|
}
|
|
if (null === $unresolved) {
|
|
$unresolved = new \ArrayObject();
|
|
}
|
|
$nodeName = $node->getName();
|
|
|
|
if (isset($tree[$nodeName])) {
|
|
$unresolved[$nodeName] = $node;
|
|
foreach ($tree[$nodeName] as $dependency) {
|
|
if (!$resolved->offsetExists($dependency->getName())) {
|
|
self::resolveDependencies($tree, $dependency, $resolved, $unresolved);
|
|
}
|
|
}
|
|
$resolved[$nodeName] = $node;
|
|
unset($unresolved[$nodeName]);
|
|
}
|
|
|
|
return $resolved;
|
|
}
|
|
}
|