/user/plugins/gantry5/src/classes/Gantry/Component/Filesystem/Folder.php
PHP | 346 lines | 228 code | 33 blank | 85 comment | 26 complexity | 230b90ddcd465669f18c4c7ccaa36ecb MD5 | raw file
- <?php
- /**
- * @package Gantry5
- * @author RocketTheme http://www.rockettheme.com
- * @copyright Copyright (C) 2007 - 2016 RocketTheme, LLC
- * @license Dual License: MIT or GNU/GPLv2 and later
- *
- * http://opensource.org/licenses/MIT
- * http://www.gnu.org/licenses/gpl-2.0.html
- *
- * Gantry Framework code that extends GPL code is considered GNU/GPLv2 and later
- */
- namespace Gantry\Component\Filesystem;
- /**
- * Folder helper class.
- *
- * @author RocketTheme
- * @license MIT
- */
- abstract class Folder
- {
- /**
- * Recursively find the last modified time under given path.
- *
- * @param string $path
- * @return int
- */
- public static function lastModifiedFolder($path)
- {
- $last_modified = 0;
- $directory = new \RecursiveDirectoryIterator($path, \RecursiveDirectoryIterator::SKIP_DOTS);
- $iterator = new \RecursiveIteratorIterator($directory, \RecursiveIteratorIterator::SELF_FIRST);
- /** @var \RecursiveDirectoryIterator $file */
- foreach ($iterator as $file) {
- $dir_modified = $file->getMTime();
- if ($dir_modified > $last_modified) {
- $last_modified = $dir_modified;
- }
- }
- return $last_modified;
- }
- /**
- * Get relative path between target and base path. If path isn't relative, return full path.
- *
- * @param string $path
- * @param string $base
- * @return string
- */
- public static function getRelativePath($path, $base = GANTRY5_ROOT)
- {
- $base = preg_replace('![\\\/]+!', '/', $base);
- $path = preg_replace('![\\\/]+!', '/', $path);
- if (strpos($path, $base) === 0) {
- $path = ltrim(substr($path, strlen($base)), '/');
- }
- return $path;
- }
- /**
- * Get relative path between target and base path. If path isn't relative, return full path.
- *
- * @param string $path
- * @param string $base
- * @return string
- */
- public static function getRelativePathDotDot($path, $base)
- {
- $base = preg_replace('![\\\/]+!', '/', $base);
- $path = preg_replace('![\\\/]+!', '/', $path);
- if ($path === $base) {
- return '';
- }
- $baseParts = explode('/', isset($base[0]) && '/' === $base[0] ? substr($base, 1) : $base);
- $pathParts = explode('/', isset($path[0]) && '/' === $path[0] ? substr($path, 1) : $path);
- array_pop($baseParts);
- $lastPart = array_pop($pathParts);
- foreach ($baseParts as $i => $directory) {
- if (isset($pathParts[$i]) && $pathParts[$i] === $directory) {
- unset($baseParts[$i], $pathParts[$i]);
- } else {
- break;
- }
- }
- $pathParts[] = $lastPart;
- $path = str_repeat('../', count($baseParts)) . implode('/', $pathParts);
- return '' === $path
- || '/' === $path[0]
- || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
- ? "./$path" : $path;
- }
- /**
- * Shift first directory out of the path.
- *
- * @param string $path
- * @return string
- */
- public static function shift(&$path)
- {
- $parts = explode('/', trim($path, '/'), 2);
- $result = array_shift($parts);
- $path = array_shift($parts);
- return $result ?: null;
- }
- /**
- * Return recursive list of all files and directories under given path.
- *
- * @param string $path
- * @param array $params
- * @return array
- * @throws \RuntimeException
- */
- public static function all($path, array $params = array())
- {
- if ($path === false) {
- throw new \RuntimeException("Path to {$path} doesn't exist.");
- }
- $compare = isset($params['compare']) ? 'get' . $params['compare'] : null;
- $pattern = isset($params['pattern']) ? $params['pattern'] : null;
- $filters = isset($params['filters']) ? $params['filters'] : null;
- $recursive = isset($params['recursive']) ? $params['recursive'] : true;
- $levels = isset($params['levels']) ? $params['levels'] : -1;
- $key = isset($params['key']) ? 'get' . $params['key'] : null;
- $value = isset($params['value']) ? 'get' . $params['value'] : ($recursive ? 'getSubPathname' : 'getFilename');
- $folders = isset($params['folders']) ? $params['folders'] : true;
- $files = isset($params['files']) ? $params['files'] : true;
- if ($recursive) {
- $directory = new \RecursiveDirectoryIterator($path,
- \RecursiveDirectoryIterator::SKIP_DOTS + \FilesystemIterator::UNIX_PATHS + \FilesystemIterator::CURRENT_AS_SELF);
- $iterator = new \RecursiveIteratorIterator($directory, \RecursiveIteratorIterator::SELF_FIRST);
- $iterator->setMaxDepth(max($levels, -1));
- } else {
- $iterator = new \FilesystemIterator($path);
- }
- $results = array();
- /** @var \RecursiveDirectoryIterator $file */
- foreach ($iterator as $file) {
- // Ignore hidden files.
- if ($file->getFilename()[0] == '.') {
- continue;
- }
- if (!$folders && $file->isDir()) {
- continue;
- }
- if (!$files && $file->isFile()) {
- continue;
- }
- if ($compare && $pattern && !preg_match($pattern, $file->{$compare}())) {
- continue;
- }
- $fileKey = $key ? $file->{$key}() : null;
- $filePath = $file->{$value}();
- if ($filters) {
- if (isset($filters['key'])) {
- $pre = !empty($filters['pre-key']) ? $filters['pre-key'] : '';
- $fileKey = $pre . preg_replace($filters['key'], '', $fileKey);
- }
- if (isset($filters['value'])) {
- $filter = $filters['value'];
- if (is_callable($filter)) {
- $filePath = call_user_func($filter, $file);
- } else {
- $filePath = preg_replace($filter, '', $filePath);
- }
- }
- }
- if ($fileKey !== null) {
- $results[$fileKey] = $filePath;
- } else {
- $results[] = $filePath;
- }
- }
- return $results;
- }
- /**
- * Recursively copy directory in filesystem.
- *
- * @param string $source
- * @param string $target
- * @param string $ignore Ignore files matching pattern (regular expression).
- * @throws \RuntimeException
- */
- public static function copy($source, $target, $ignore = null)
- {
- $source = rtrim($source, '\\/');
- $target = rtrim($target, '\\/');
- if (!is_dir($source)) {
- throw new \RuntimeException('Cannot copy non-existing folder.');
- }
- // Make sure that path to the target exists before copying.
- self::create($target);
- $success = true;
- // Go through all sub-directories and copy everything.
- $files = self::all($source);
- foreach ($files as $file) {
- if ($ignore && preg_match($ignore, $file)) {
- continue;
- }
- $src = $source .'/'. $file;
- $dst = $target .'/'. $file;
- if (is_dir($src)) {
- // Create current directory (if it doesn't exist).
- if (!is_dir($dst)) {
- $success &= @mkdir($dst, 0777, true);
- }
- } else {
- // Or copy current file.
- $success &= @copy($src, $dst);
- }
- }
- if (!$success) {
- $error = error_get_last();
- throw new \RuntimeException($error['message']);
- }
- // Make sure that the change will be detected when caching.
- @touch(dirname($target));
- }
- /**
- * Move directory in filesystem.
- *
- * @param string $source
- * @param string $target
- * @throws \RuntimeException
- */
- public static function move($source, $target)
- {
- if (!is_dir($source)) {
- throw new \RuntimeException('Cannot move non-existing folder.');
- }
- // Make sure that path to the target exists before moving.
- self::create(dirname($target));
- // Just rename the directory.
- $success = @rename($source, $target);
- if (!$success) {
- $error = error_get_last();
- throw new \RuntimeException($error['message']);
- }
- // Make sure that the change will be detected when caching.
- @touch(dirname($source));
- @touch(dirname($target));
- }
- /**
- * Recursively delete directory from filesystem.
- *
- * @param string $target
- * @param bool $include_target
- * @throws \RuntimeException
- */
- public static function delete($target, $include_target = true)
- {
- if (!$target) { return; }
- if (!is_dir($target)) {
- throw new \RuntimeException('Cannot delete non-existing folder.');
- }
- $success = self::doDelete($target, $include_target);
- if (!$success) {
- $error = error_get_last();
- throw new \RuntimeException($error['message']);
- }
- // Make sure that the change will be detected when caching.
- if ($include_target) {
- @touch(dirname($target));
- } else {
- @touch($target);
- }
- }
- /**
- * @param string $folder
- * @throws \RuntimeException
- * @internal
- */
- public static function create($folder)
- {
- if (is_dir($folder)) {
- return;
- }
- $success = @mkdir($folder, 0777, true);
- if (!$success) {
- $error = error_get_last();
- throw new \RuntimeException($error['message']);
- }
- }
- /**
- * @param string $folder
- * @param bool $include_target
- * @return bool
- * @internal
- */
- protected static function doDelete($folder, $include_target = true)
- {
- // Special case for symbolic links.
- if (is_link($folder)) {
- return @unlink($folder);
- }
- // Go through all items in filesystem and recursively remove everything.
- $files = array_diff(scandir($folder), array('.', '..'));
- foreach ($files as $file) {
- $path = "{$folder}/{$file}";
- (is_dir($path)) ? self::doDelete($path) : @unlink($path);
- }
- return $include_target ? @rmdir($folder) : true;
- }
- }