123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- <?php
- /**
- * @package Grav\Common\Config
- *
- * @copyright Copyright (c) 2015 - 2023 Trilby Media, LLC. All rights reserved.
- * @license MIT License; see LICENSE file for details.
- */
- namespace Grav\Common\Config;
- use DirectoryIterator;
- use Grav\Common\Filesystem\Folder;
- use RecursiveDirectoryIterator;
- /**
- * Class ConfigFileFinder
- * @package Grav\Common\Config
- */
- class ConfigFileFinder
- {
- /** @var string */
- protected $base = '';
- /**
- * @param string $base
- * @return $this
- */
- public function setBase($base)
- {
- $this->base = $base ? "{$base}/" : '';
- return $this;
- }
- /**
- * Return all locations for all the files with a timestamp.
- *
- * @param array $paths List of folders to look from.
- * @param string $pattern Pattern to match the file. Pattern will also be removed from the key.
- * @param int $levels Maximum number of recursive directories.
- * @return array
- */
- public function locateFiles(array $paths, $pattern = '|\.yaml$|', $levels = -1)
- {
- $list = [];
- foreach ($paths as $folder) {
- $list += $this->detectRecursive($folder, $pattern, $levels);
- }
- return $list;
- }
- /**
- * Return all locations for all the files with a timestamp.
- *
- * @param array $paths List of folders to look from.
- * @param string $pattern Pattern to match the file. Pattern will also be removed from the key.
- * @param int $levels Maximum number of recursive directories.
- * @return array
- */
- public function getFiles(array $paths, $pattern = '|\.yaml$|', $levels = -1)
- {
- $list = [];
- foreach ($paths as $folder) {
- $path = trim(Folder::getRelativePath($folder), '/');
- $files = $this->detectRecursive($folder, $pattern, $levels);
- $list += $files[trim($path, '/')];
- }
- return $list;
- }
- /**
- * Return all paths for all the files with a timestamp.
- *
- * @param array $paths List of folders to look from.
- * @param string $pattern Pattern to match the file. Pattern will also be removed from the key.
- * @param int $levels Maximum number of recursive directories.
- * @return array
- */
- public function listFiles(array $paths, $pattern = '|\.yaml$|', $levels = -1)
- {
- $list = [];
- foreach ($paths as $folder) {
- $list = array_merge_recursive($list, $this->detectAll($folder, $pattern, $levels));
- }
- return $list;
- }
- /**
- * Find filename from a list of folders.
- *
- * Note: Only finds the last override.
- *
- * @param string $filename
- * @param array $folders
- * @return array
- */
- public function locateFileInFolder($filename, array $folders)
- {
- $list = [];
- foreach ($folders as $folder) {
- $list += $this->detectInFolder($folder, $filename);
- }
- return $list;
- }
- /**
- * Find filename from a list of folders.
- *
- * @param array $folders
- * @param string|null $filename
- * @return array
- */
- public function locateInFolders(array $folders, $filename = null)
- {
- $list = [];
- foreach ($folders as $folder) {
- $path = trim(Folder::getRelativePath($folder), '/');
- $list[$path] = $this->detectInFolder($folder, $filename);
- }
- return $list;
- }
- /**
- * Return all existing locations for a single file with a timestamp.
- *
- * @param array $paths Filesystem paths to look up from.
- * @param string $name Configuration file to be located.
- * @param string $ext File extension (optional, defaults to .yaml).
- * @return array
- */
- public function locateFile(array $paths, $name, $ext = '.yaml')
- {
- $filename = preg_replace('|[.\/]+|', '/', $name) . $ext;
- $list = [];
- foreach ($paths as $folder) {
- $path = trim(Folder::getRelativePath($folder), '/');
- if (is_file("{$folder}/{$filename}")) {
- $modified = filemtime("{$folder}/{$filename}");
- } else {
- $modified = 0;
- }
- $basename = $this->base . $name;
- $list[$path] = [$basename => ['file' => "{$path}/{$filename}", 'modified' => $modified]];
- }
- return $list;
- }
- /**
- * Detects all directories with a configuration file and returns them with last modification time.
- *
- * @param string $folder Location to look up from.
- * @param string $pattern Pattern to match the file. Pattern will also be removed from the key.
- * @param int $levels Maximum number of recursive directories.
- * @return array
- * @internal
- */
- protected function detectRecursive($folder, $pattern, $levels)
- {
- $path = trim(Folder::getRelativePath($folder), '/');
- if (is_dir($folder)) {
- // Find all system and user configuration files.
- $options = [
- 'levels' => $levels,
- 'compare' => 'Filename',
- 'pattern' => $pattern,
- 'filters' => [
- 'pre-key' => $this->base,
- 'key' => $pattern,
- 'value' => function (RecursiveDirectoryIterator $file) use ($path) {
- return ['file' => "{$path}/{$file->getSubPathname()}", 'modified' => $file->getMTime()];
- }
- ],
- 'key' => 'SubPathname'
- ];
- $list = Folder::all($folder, $options);
- ksort($list);
- } else {
- $list = [];
- }
- return [$path => $list];
- }
- /**
- * Detects all directories with the lookup file and returns them with last modification time.
- *
- * @param string $folder Location to look up from.
- * @param string|null $lookup Filename to be located (defaults to directory name).
- * @return array
- * @internal
- */
- protected function detectInFolder($folder, $lookup = null)
- {
- $folder = rtrim($folder, '/');
- $path = trim(Folder::getRelativePath($folder), '/');
- $base = $path === $folder ? '' : ($path ? substr($folder, 0, -strlen($path)) : $folder . '/');
- $list = [];
- if (is_dir($folder)) {
- $iterator = new DirectoryIterator($folder);
- foreach ($iterator as $directory) {
- if (!$directory->isDir() || $directory->isDot()) {
- continue;
- }
- $name = $directory->getFilename();
- $find = ($lookup ?: $name) . '.yaml';
- $filename = "{$path}/{$name}/{$find}";
- if (file_exists($base . $filename)) {
- $basename = $this->base . $name;
- $list[$basename] = ['file' => $filename, 'modified' => filemtime($base . $filename)];
- }
- }
- }
- return $list;
- }
- /**
- * Detects all plugins with a configuration file and returns them with last modification time.
- *
- * @param string $folder Location to look up from.
- * @param string $pattern Pattern to match the file. Pattern will also be removed from the key.
- * @param int $levels Maximum number of recursive directories.
- * @return array
- * @internal
- */
- protected function detectAll($folder, $pattern, $levels)
- {
- $path = trim(Folder::getRelativePath($folder), '/');
- if (is_dir($folder)) {
- // Find all system and user configuration files.
- $options = [
- 'levels' => $levels,
- 'compare' => 'Filename',
- 'pattern' => $pattern,
- 'filters' => [
- 'pre-key' => $this->base,
- 'key' => $pattern,
- 'value' => function (RecursiveDirectoryIterator $file) use ($path) {
- return ["{$path}/{$file->getSubPathname()}" => $file->getMTime()];
- }
- ],
- 'key' => 'SubPathname'
- ];
- $list = Folder::all($folder, $options);
- ksort($list);
- } else {
- $list = [];
- }
- return $list;
- }
- }
|