* $loader = new Nette\Loaders\RobotLoader; * $loader->addDirectory('app'); * $loader->excludeDirectory('app/exclude'); * $loader->setTempDirectory('temp'); * $loader->register(); * */ class RobotLoader { use Nette\SmartObject; private const RETRY_LIMIT = 3; /** @var string[] */ public $ignoreDirs = ['.*', '*.old', '*.bak', '*.tmp', 'temp']; /** @var string[] */ public $acceptFiles = ['*.php']; /** @var bool */ private $autoRebuild = true; /** @var bool */ private $reportParseErrors = true; /** @var string[] */ private $scanPaths = []; /** @var string[] */ private $excludeDirs = []; /** @var array of class => [file, time] */ private $classes = []; /** @var bool */ private $cacheLoaded = false; /** @var bool */ private $refreshed = false; /** @var array of missing classes */ private $missing = []; /** @var string|null */ private $tempDirectory; public function __construct() { if (!extension_loaded('tokenizer')) { throw new Nette\NotSupportedException('PHP extension Tokenizer is not loaded.'); } } /** * Register autoloader. */ public function register(bool $prepend = false): self { spl_autoload_register([$this, 'tryLoad'], true, $prepend); return $this; } /** * Handles autoloading of classes, interfaces or traits. */ public function tryLoad(string $type): void { $this->loadCache(); $type = ltrim($type, '\\'); // PHP namespace bug #49143 $info = $this->classes[$type] ?? null; if ($this->autoRebuild) { if (!$info || !is_file($info['file'])) { $missing = &$this->missing[$type]; $missing++; if (!$this->refreshed && $missing <= self::RETRY_LIMIT) { $this->refreshClasses(); $this->saveCache(); } elseif ($info) { unset($this->classes[$type]); $this->saveCache(); } } elseif (!$this->refreshed && filemtime($info['file']) !== $info['time']) { $this->updateFile($info['file']); if (empty($this->classes[$type])) { $this->missing[$type] = 0; } $this->saveCache(); } $info = $this->classes[$type] ?? null; } if ($info) { (static function ($file) { require $file; })($info['file']); } } /** * Add path or paths to list. * @param string ...$paths absolute path */ public function addDirectory(...$paths): self { if (is_array($paths[0] ?? null)) { trigger_error(__METHOD__ . '() use variadics ...$paths to add an array of paths.', E_USER_WARNING); $paths = $paths[0]; } $this->scanPaths = array_merge($this->scanPaths, $paths); return $this; } public function reportParseErrors(bool $on = true): self { $this->reportParseErrors = $on; return $this; } /** * Excludes path or paths from list. * @param string ...$paths absolute path */ public function excludeDirectory(...$paths): self { if (is_array($paths[0] ?? null)) { trigger_error(__METHOD__ . '() use variadics ...$paths to add an array of paths.', E_USER_WARNING); $paths = $paths[0]; } $this->excludeDirs = array_merge($this->excludeDirs, $paths); return $this; } /** * @return array of class => filename */ public function getIndexedClasses(): array { $this->loadCache(); $res = []; foreach ($this->classes as $class => $info) { $res[$class] = $info['file']; } return $res; } /** * Rebuilds class list cache. */ public function rebuild(): void { $this->cacheLoaded = true; $this->classes = $this->missing = []; $this->refreshClasses(); if ($this->tempDirectory) { $this->saveCache(); } } /** * Refreshes class list cache. */ public function refresh(): void { $this->loadCache(); if (!$this->refreshed) { $this->refreshClasses(); $this->saveCache(); } } /** * Refreshes $classes. */ private function refreshClasses(): void { $this->refreshed = true; // prevents calling refreshClasses() or updateFile() in tryLoad() $files = []; foreach ($this->classes as $class => $info) { $files[$info['file']]['time'] = $info['time']; $files[$info['file']]['classes'][] = $class; } $this->classes = []; foreach ($this->scanPaths as $path) { $iterator = is_file($path) ? [new SplFileInfo($path)] : $this->createFileIterator($path); foreach ($iterator as $file) { $file = $file->getPathname(); if (isset($files[$file]) && $files[$file]['time'] == filemtime($file)) { $classes = $files[$file]['classes']; } else { $classes = $this->scanPhp($file); } $files[$file] = ['classes' => [], 'time' => filemtime($file)]; foreach ($classes as $class) { $info = &$this->classes[$class]; if (isset($info['file'])) { throw new Nette\InvalidStateException("Ambiguous class $class resolution; defined in {$info['file']} and in $file."); } $info = ['file' => $file, 'time' => filemtime($file)]; unset($this->missing[$class]); } } } } /** * Creates an iterator scaning directory for PHP files, subdirectories and 'netterobots.txt' files. * @throws Nette\IOException if path is not found */ private function createFileIterator(string $dir): Nette\Utils\Finder { if (!is_dir($dir)) { throw new Nette\IOException("File or directory '$dir' not found."); } if (is_string($ignoreDirs = $this->ignoreDirs)) { trigger_error(__CLASS__ . ': $ignoreDirs must be an array.', E_USER_WARNING); $ignoreDirs = preg_split('#[,\s]+#', $ignoreDirs); } $disallow = []; foreach (array_merge($ignoreDirs, $this->excludeDirs) as $item) { if ($item = realpath($item)) { $disallow[str_replace('\\', '/', $item)] = true; } } if (is_string($acceptFiles = $this->acceptFiles)) { trigger_error(__CLASS__ . ': $acceptFiles must be an array.', E_USER_WARNING); $acceptFiles = preg_split('#[,\s]+#', $acceptFiles); } $iterator = Nette\Utils\Finder::findFiles($acceptFiles) ->filter(function (SplFileInfo $file) use (&$disallow) { return $file->getRealPath() === false ? true : !isset($disallow[str_replace('\\', '/', $file->getRealPath())]); }) ->from($dir) ->exclude($ignoreDirs) ->filter($filter = function (SplFileInfo $dir) use (&$disallow) { if ($dir->getRealPath() === false) { return true; } $path = str_replace('\\', '/', $dir->getRealPath()); if (is_file("$path/netterobots.txt")) { foreach (file("$path/netterobots.txt") as $s) { if (preg_match('#^(?:disallow\\s*:)?\\s*(\\S+)#i', $s, $matches)) { $disallow[$path . rtrim('/' . ltrim($matches[1], '/'), '/')] = true; } } } return !isset($disallow[$path]); }); $filter(new SplFileInfo($dir)); return $iterator; } private function updateFile(string $file): void { foreach ($this->classes as $class => $info) { if (isset($info['file']) && $info['file'] === $file) { unset($this->classes[$class]); } } $classes = is_file($file) ? $this->scanPhp($file) : []; foreach ($classes as $class) { $info = &$this->classes[$class]; if (isset($info['file']) && @filemtime($info['file']) !== $info['time']) { // @ file may not exists $this->updateFile($info['file']); $info = &$this->classes[$class]; } if (isset($info['file'])) { throw new Nette\InvalidStateException("Ambiguous class $class resolution; defined in {$info['file']} and in $file."); } $info = ['file' => $file, 'time' => filemtime($file)]; } } /** * Searches classes, interfaces and traits in PHP file. * @return string[] */ private function scanPhp(string $file): array { $code = file_get_contents($file); $expected = false; $namespace = $name = ''; $level = $minLevel = 0; $classes = []; try { $tokens = token_get_all($code, TOKEN_PARSE); } catch (\ParseError $e) { if ($this->reportParseErrors) { $rp = new \ReflectionProperty($e, 'file'); $rp->setAccessible(true); $rp->setValue($e, $file); throw $e; } $tokens = []; } foreach ($tokens as $token) { if (is_array($token)) { switch ($token[0]) { case T_COMMENT: case T_DOC_COMMENT: case T_WHITESPACE: continue 2; case T_STRING: case PHP_VERSION_ID < 80000 ? T_NS_SEPARATOR : T_NAME_QUALIFIED: if ($expected) { $name .= $token[1]; } continue 2; case T_NAMESPACE: case T_CLASS: case T_INTERFACE: case T_TRAIT: $expected = $token[0]; $name = ''; continue 2; case T_CURLY_OPEN: case T_DOLLAR_OPEN_CURLY_BRACES: $level++; } } if ($expected) { switch ($expected) { case T_CLASS: case T_INTERFACE: case T_TRAIT: if ($name && $level === $minLevel) { $classes[] = $namespace . $name; } break; case T_NAMESPACE: $namespace = $name ? $name . '\\' : ''; $minLevel = $token === '{' ? 1 : 0; } $expected = null; } if ($token === '{') { $level++; } elseif ($token === '}') { $level--; } } return $classes; } /********************* caching ****************d*g**/ /** * Sets auto-refresh mode. */ public function setAutoRefresh(bool $on = true): self { $this->autoRebuild = $on; return $this; } /** * Sets path to temporary directory. */ public function setTempDirectory(string $dir): self { Nette\Utils\FileSystem::createDir($dir); $this->tempDirectory = $dir; return $this; } /** * Loads class list from cache. */ private function loadCache(): void { if ($this->cacheLoaded) { return; } $this->cacheLoaded = true; $file = $this->getCacheFile(); // Solving atomicity to work everywhere is really pain in the ass. // 1) We want to do as little as possible IO calls on production and also directory and file can be not writable (#19) // so on Linux we include the file directly without shared lock, therefore, the file must be created atomically by renaming. // 2) On Windows file cannot be renamed-to while is open (ie by include() #11), so we have to acquire a lock. $lock = defined('PHP_WINDOWS_VERSION_BUILD') ? $this->acquireLock("$file.lock", LOCK_SH) : null; $data = @include $file; // @ file may not exist if (is_array($data)) { [$this->classes, $this->missing] = $data; return; } if ($lock) { flock($lock, LOCK_UN); // release shared lock so we can get exclusive } $lock = $this->acquireLock("$file.lock", LOCK_EX); // while waiting for exclusive lock, someone might have already created the cache $data = @include $file; // @ file may not exist if (is_array($data)) { [$this->classes, $this->missing] = $data; return; } $this->classes = $this->missing = []; $this->refreshClasses(); $this->saveCache($lock); // On Windows concurrent creation and deletion of a file can cause a error 'permission denied', // therefore, we will not delete the lock file. Windows is peace of shit. } /** * Writes class list to cache. */ private function saveCache($lock = null): void { // we have to acquire a lock to be able safely rename file // on Linux: that another thread does not rename the same named file earlier // on Windows: that the file is not read by another thread $file = $this->getCacheFile(); $lock = $lock ?: $this->acquireLock("$file.lock", LOCK_EX); $code = "classes, $this->missing], true) . ";\n"; if (file_put_contents("$file.tmp", $code) !== strlen($code) || !rename("$file.tmp", $file)) { @unlink("$file.tmp"); // @ file may not exist throw new \RuntimeException("Unable to create '$file'."); } if (function_exists('opcache_invalidate')) { @opcache_invalidate($file, true); // @ can be restricted } } private function acquireLock(string $file, int $mode) { $handle = @fopen($file, 'w'); // @ is escalated to exception if (!$handle) { throw new \RuntimeException("Unable to create file '$file'. " . error_get_last()['message']); } elseif (!@flock($handle, $mode)) { // @ is escalated to exception throw new \RuntimeException('Unable to acquire ' . ($mode & LOCK_EX ? 'exclusive' : 'shared') . " lock on file '$file'. " . error_get_last()['message']); } return $handle; } private function getCacheFile(): string { if (!$this->tempDirectory) { throw new \LogicException('Set path to temporary directory using setTempDirectory().'); } return $this->tempDirectory . '/' . md5(serialize($this->getCacheKey())) . '.php'; } protected function getCacheKey(): array { return [$this->ignoreDirs, $this->acceptFiles, $this->scanPaths, $this->excludeDirs]; } }