Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/framework/Filesystem/Driver/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Filesystem\Driver;
use Magento\Framework\Exception\FileSystemException;
use Magento\Framework\Filesystem\DriverInterface;
use Magento\Framework\Filesystem\Glob;
use Magento\Framework\Phrase;
/**
* Filesystem driver that uses the local filesystem.
*
* Assumed that stat cache is cleanup before test filesystem
*
* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
*/
class File implements DriverInterface
{
/**
* @var string
*/
protected $scheme = '';
/**
* Flag for checking whether or not to be the behavior of statefulFile
* @var bool
*/
private $stateful;
/**
* File constructor.
* @param bool $stateful
*/
public function __construct(bool $stateful = false)
{
$this->stateful = $stateful;
}
/**
* Returns last warning message string
*
* @return string
*/
protected function getWarningMessage()
{
$warning = error_get_last();
if ($warning && $warning['type'] == E_WARNING) {
return 'Warning!' . $warning['message'];
}
return null;
}
/**
* Is file or directory exist in file system
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isExists($path)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$result = @file_exists($filename);
if ($result === null) {
throw new FileSystemException(
new Phrase('An error occurred during "%1" execution.', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Gathers the statistics of the given path
*
* @param string $path
* @return array
* @throws FileSystemException
*/
public function stat($path)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$result = @stat($filename);
if (!$result) {
throw new FileSystemException(
new Phrase('Cannot gather stats! %1', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Check permissions for reading file or directory
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isReadable($path)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$result = @is_readable($filename);
if ($result === null) {
throw new FileSystemException(
new Phrase('An error occurred during "%1" execution.', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Tells whether the filename is a regular file
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isFile($path)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$result = @is_file($filename);
if ($result === null) {
throw new FileSystemException(
new Phrase('An error occurred during "%1" execution.', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Tells whether the filename is a regular directory
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isDirectory($path)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$result = @is_dir($filename);
if ($result === null) {
throw new FileSystemException(
new Phrase('An error occurred during "%1" execution.', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Retrieve file contents from given path
*
* @param string $path
* @param string|null $flag
* @param resource|null $context
* @return string
* @throws FileSystemException
*/
public function fileGetContents($path, $flag = null, $context = null)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$flag = $flag ?? false;
$result = @file_get_contents($filename, $flag, $context);
if (false === $result) {
throw new FileSystemException(
new Phrase(
'The contents from the "%1" file can\'t be read. %2',
[$path, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Check if given path is writable
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function isWritable($path)
{
$filename = $this->getScheme() . $path;
if (!$this->stateful) {
clearstatcache(false, $filename);
}
$result = @is_writable($filename);
if ($result === null) {
throw new FileSystemException(
new Phrase('An error occurred during "%1" execution.', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Returns parent directory's path
*
* @param string $path
* @return string
*/
public function getParentDirectory($path)
{
return dirname($this->getScheme() . $path);
}
/**
* Create directory
*
* @param string $path
* @param int $permissions
* @return bool
* @throws FileSystemException
*/
public function createDirectory($path, $permissions = 0777)
{
if ($this->stateful) {
clearstatcache(true, $path);
}
return $this->mkdirRecursive($path, $permissions);
}
/**
* Create a directory recursively taking into account race conditions
*
* @param string $path
* @param int $permissions
* @return bool
* @throws FileSystemException
*/
private function mkdirRecursive($path, $permissions = 0777)
{
$path = $this->getScheme() . $path;
if (is_dir($path)) {
return true;
}
$parentDir = dirname($path);
while (!is_dir($parentDir)) {
$this->mkdirRecursive($parentDir, $permissions);
}
$result = @mkdir($path, $permissions);
if ($this->stateful) {
clearstatcache(true, $path);
}
if (!$result) {
if (is_dir($path)) {
$result = true;
} else {
throw new FileSystemException(
new Phrase(
'Directory "%1" cannot be created %2',
[$path, $this->getWarningMessage()]
)
);
}
}
return $result;
}
/**
* Read directory
*
* @param string $path
* @return string[]
* @throws FileSystemException
*/
public function readDirectory($path)
{
try {
$flags = \FilesystemIterator::SKIP_DOTS |
\FilesystemIterator::UNIX_PATHS |
\RecursiveDirectoryIterator::FOLLOW_SYMLINKS;
$iterator = new \FilesystemIterator($path, $flags);
$result = [];
/** @var \FilesystemIterator $file */
foreach ($iterator as $file) {
$result[] = $file->getPathname();
}
sort($result);
return $result;
} catch (\Exception $e) {
throw new FileSystemException(new Phrase($e->getMessage()), $e);
}
}
/**
* Search paths by given regex
*
* @param string $pattern
* @param string $path
* @return string[]
* @throws FileSystemException
*/
public function search($pattern, $path)
{
if (!$this->stateful) {
clearstatcache();
}
$globPattern = rtrim((string)$path, '/') . '/' . ltrim((string)$pattern, '/');
$result = Glob::glob($globPattern, Glob::GLOB_BRACE);
return is_array($result) ? $result : [];
}
/**
* Renames a file or directory
*
* @param string $oldPath
* @param string $newPath
* @param DriverInterface|null $targetDriver
* @return bool
* @throws FileSystemException
*/
public function rename($oldPath, $newPath, DriverInterface $targetDriver = null)
{
$result = false;
$targetDriver = $targetDriver ?: $this;
if (get_class($targetDriver) === get_class($this)) {
$result = @rename($this->getScheme() . $oldPath, $newPath);
if ($this->stateful) {
clearstatcache(true, $this->getScheme() . $oldPath);
clearstatcache(true, $newPath);
}
$this->changePermissions($newPath, 0777 & ~umask());
} else {
$content = $this->fileGetContents($oldPath);
if (false !== $targetDriver->filePutContents($newPath, $content)) {
$result = $this->isFile($oldPath) ? $this->deleteFile($oldPath) : true;
}
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The path "%1" cannot be renamed into "%2" %3',
[$oldPath, $newPath, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Copy source into destination
*
* @param string $source
* @param string $destination
* @param DriverInterface|null $targetDriver
* @return bool
* @throws FileSystemException
*/
public function copy($source, $destination, DriverInterface $targetDriver = null)
{
$targetDriver = $targetDriver ?: $this;
if (get_class($targetDriver) === get_class($this)) {
$result = @copy($this->getScheme() . $source, $destination);
if ($this->stateful) {
clearstatcache(true, $destination);
}
} else {
$content = $this->fileGetContents($source);
$result = $targetDriver->filePutContents($destination, $content);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The file or directory "%1" cannot be copied to "%2" %3',
[
$source,
$destination,
$this->getWarningMessage()
]
)
);
}
return $result;
}
/**
* Create symlink on source and place it into destination
*
* @param string $source
* @param string $destination
* @param DriverInterface|null $targetDriver
* @return bool
* @throws FileSystemException
*/
public function symlink($source, $destination, DriverInterface $targetDriver = null)
{
$result = false;
if ($targetDriver === null || get_class($targetDriver) == get_class($this)) {
$result = @symlink($this->getScheme() . $source, $destination);
if ($this->stateful) {
clearstatcache(true, $destination);
}
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'A symlink for "%1" can\'t be created and placed to "%2". %3',
[
$source,
$destination,
$this->getWarningMessage()
]
)
);
}
return $result;
}
/**
* Delete file
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function deleteFile($path)
{
$result = @unlink($this->getScheme() . $path);
if ($this->stateful) {
clearstatcache(true, $this->getScheme() . $path);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The "%1" file can\'t be deleted. %2',
[$path, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Recursive delete directory
*
* @param string $path
* @return bool
* @throws FileSystemException
*/
public function deleteDirectory($path)
{
$exceptionMessages = [];
$flags = \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::UNIX_PATHS;
$iterator = new \FilesystemIterator($path, $flags);
/** @var \FilesystemIterator $entity */
foreach ($iterator as $entity) {
try {
if ($entity->isDir()) {
$this->deleteDirectory($entity->getPathname());
} else {
$this->deleteFile($entity->getPathname());
}
} catch (FileSystemException $exception) {
$exceptionMessages[] = $exception->getMessage();
}
}
if (!empty($exceptionMessages)) {
throw new FileSystemException(
new Phrase(
\implode(' ', $exceptionMessages)
)
);
}
$fullPath = $this->getScheme() . $path;
if (is_link($fullPath)) {
$result = @unlink($fullPath);
} else {
$result = @rmdir($fullPath);
}
if ($this->stateful) {
clearstatcache(true, $fullPath);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The directory "%1" cannot be deleted %2',
[$path, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Change permissions of given path
*
* @param string $path
* @param int $permissions
* @return bool
* @throws FileSystemException
*/
public function changePermissions($path, $permissions)
{
$result = @chmod($this->getScheme() . $path, $permissions);
if ($this->stateful) {
clearstatcache(false, $this->getScheme() . $path);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The permissions can\'t be changed for the "%1" path. %2.',
[$path, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Recursively change permissions of given path
*
* @param string $path
* @param int $dirPermissions
* @param int $filePermissions
* @return bool
* @throws FileSystemException
*/
public function changePermissionsRecursively($path, $dirPermissions, $filePermissions)
{
$result = true;
if ($this->isFile($path)) {
$result = @chmod($path, $filePermissions);
} else {
$result = @chmod($path, $dirPermissions);
}
if ($this->stateful) {
clearstatcache(false, $this->getScheme() . $path);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The permissions can\'t be changed for the "%1" path. %2.',
[$path, $this->getWarningMessage()]
)
);
}
$flags = \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::UNIX_PATHS;
$iterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator($path, $flags),
\RecursiveIteratorIterator::CHILD_FIRST
);
/** @var \FilesystemIterator $entity */
foreach ($iterator as $entity) {
if ($entity->isDir()) {
$result = @chmod($entity->getPathname(), $dirPermissions);
} else {
$result = @chmod($entity->getPathname(), $filePermissions);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The permissions can\'t be changed for the "%1" path. %2.',
[$path, $this->getWarningMessage()]
)
);
}
}
return $result;
}
/**
* Sets access and modification time of file.
*
* @param string $path
* @param int|null $modificationTime
* @return bool
* @throws FileSystemException
*/
public function touch($path, $modificationTime = null)
{
if (!$modificationTime) {
$result = @touch($this->getScheme() . $path);
} else {
$result = @touch($this->getScheme() . $path, $modificationTime);
}
if ($this->stateful) {
clearstatcache(true, $this->getScheme() . $path);
}
if (!$result) {
throw new FileSystemException(
new Phrase(
'The "%1" file or directory can\'t be touched. %2',
[$path, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Write contents to file in given path
*
* @param string $path
* @param string $content
* @param string|null $mode
* @return int The number of bytes that were written.
* @throws FileSystemException
*/
public function filePutContents($path, $content, $mode = null)
{
$mode = $mode ?? 0;
$result = @file_put_contents($this->getScheme() . $path, $content, $mode);
if ($this->stateful) {
clearstatcache(true, $this->getScheme() . $path);
}
if ($result === false) {
throw new FileSystemException(
new Phrase(
'The specified "%1" file couldn\'t be written. %2',
[$path, $this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Open file
*
* @param string $path
* @param string $mode
* @return resource file
* @throws FileSystemException
*/
public function fileOpen($path, $mode)
{
$result = @fopen($this->getScheme() . $path, $mode);
if ($this->stateful) {
clearstatcache(true, $this->getScheme() . $path);
}
if (!$result) {
throw new FileSystemException(
new Phrase('File "%1" cannot be opened %2', [$path, $this->getWarningMessage()])
);
}
return $result;
}
/**
* Reads the line content from file pointer (with specified number of bytes from the current position).
*
* @param resource $resource
* @param int $length
* @param string $ending [optional]
* @return string
* @throws FileSystemException
*/
public function fileReadLine($resource, $length, $ending = null)
{
// phpcs:disable
$result = @stream_get_line($resource, $length, $ending);
// phpcs:enable
if (false === $result) {
throw new FileSystemException(
new Phrase('File cannot be read %1', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Reads the specified number of bytes from the current position.
*
* @param resource $resource
* @param int $length
* @return string
* @throws FileSystemException
*/
public function fileRead($resource, $length)
{
$result = @fread($resource, $length);
if ($result === false) {
throw new FileSystemException(
new Phrase('File cannot be read %1', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Reads one CSV row from the file
*
* @param resource $resource
* @param int $length [optional]
* @param string $delimiter [optional]
* @param string $enclosure [optional]
* @param string $escape [optional]
* @return array|bool|null
* @throws FileSystemException
*/
public function fileGetCsv($resource, $length = 0, $delimiter = ',', $enclosure = '"', $escape = "\0")
{
$result = @fgetcsv($resource, $length, $delimiter, $enclosure, $escape);
if ($result === null) {
throw new FileSystemException(
new Phrase(
'The "%1" CSV handle is incorrect. Verify the handle and try again.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Returns position of read/write pointer
*
* @param resource $resource
* @return int
* @throws FileSystemException
*/
public function fileTell($resource)
{
$result = @ftell($resource);
if ($result === null) {
throw new FileSystemException(
new Phrase('An error occurred during "%1" execution.', [$this->getWarningMessage()])
);
}
return $result;
}
/**
* Seeks to the specified offset
*
* @param resource $resource
* @param int $offset
* @param int $whence
* @return int
* @throws FileSystemException
*/
public function fileSeek($resource, $offset, $whence = SEEK_SET)
{
$result = @fseek($resource, $offset, $whence);
if ($result === -1) {
throw new FileSystemException(
new Phrase(
'An error occurred during "%1" fileSeek execution.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Returns true if pointer at the end of file or in case of exception
*
* @param resource $resource
* @return bool
*/
public function endOfFile($resource)
{
return feof($resource);
}
/**
* Close file
*
* @param resource $resource
* @return bool
* @throws FileSystemException
*/
public function fileClose($resource)
{
$result = @fclose($resource);
if (!$result) {
throw new FileSystemException(
new Phrase(
'An error occurred during "%1" fileClose execution.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Writes data to file
*
* @param resource $resource
* @param string $data
* @return int
* @throws FileSystemException
*/
public function fileWrite($resource, $data)
{
$data = $data !== null ? $data : '';
$lenData = strlen($data);
for ($result = 0; $result < $lenData; $result += $fwrite) {
$fwrite = @fwrite($resource, substr($data, $result));
if (0 === $fwrite) {
$this->fileSystemException('Unable to write');
}
if (false === $fwrite) {
$this->fileSystemException(
'An error occurred during "%1" fileWrite execution.',
[$this->getWarningMessage()]
);
}
}
return $result;
}
/**
* Throw a FileSystemException with a Phrase of message and optional arguments
*
* @param string $message
* @param array $arguments
* @return void
* @throws FileSystemException
*/
private function fileSystemException($message, $arguments = [])
{
throw new FileSystemException(new Phrase($message, $arguments));
}
/**
* Writes one CSV row to the file.
*
* @param resource $resource
* @param array $data
* @param string $delimiter
* @param string $enclosure
* @return int
* @throws FileSystemException
*/
public function filePutCsv($resource, array $data, $delimiter = ',', $enclosure = '"')
{
/**
* Security enhancement for CSV data processing by Excel-like applications.
* @see https://bugzilla.mozilla.org/show_bug.cgi?id=1054702
*
* @var $value string|Phrase
*/
foreach ($data as $key => $value) {
if (!is_string($value)) {
$value = (string)$value;
}
if (isset($value[0]) && in_array($value[0], ['=', '+', '-'])) {
$data[$key] = ' ' . $value;
}
}
// Escape symbol is needed to fix known issue in PHP broken fputcsv escaping functionality
// where backslash followed by double quote breaks file consistency
$escape = "\0";
$result = @fputcsv($resource, $data, $delimiter, $enclosure, $escape);
if (!$result) {
throw new FileSystemException(
new Phrase(
'An error occurred during "%1" filePutCsv execution.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Flushes the output
*
* @param resource $resource
* @return bool
* @throws FileSystemException
*/
public function fileFlush($resource)
{
$result = @fflush($resource);
if (!$result) {
throw new FileSystemException(
new Phrase(
'An error occurred during "%1" fileFlush execution.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Lock file in selected mode
*
* @param resource $resource
* @param int $lockMode
* @return bool
* @throws FileSystemException
*/
public function fileLock($resource, $lockMode = LOCK_EX)
{
$result = @flock($resource, $lockMode);
if (!$result) {
throw new FileSystemException(
new Phrase(
'An error occurred during "%1" fileLock execution.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Unlock file
*
* @param resource $resource
* @return bool
* @throws FileSystemException
*/
public function fileUnlock($resource)
{
$result = @flock($resource, LOCK_UN);
if (!$result) {
throw new FileSystemException(
new Phrase(
'An error occurred during "%1" fileUnlock execution.',
[$this->getWarningMessage()]
)
);
}
return $result;
}
/**
* Returns an absolute path for the given one.
*
* @param string $basePath
* @param string $path
* @param string|null $scheme
* @return string
*/
public function getAbsolutePath($basePath, $path, $scheme = null)
{
// check if the path given is already an absolute path containing the
// basepath. so if the basepath starts at position 0 in the path, we
// must not concatinate them again because path is already absolute.
$path = $path !== null ? $path : '';
if ('' !== $basePath && strpos($path, (string)$basePath) === 0) {
return $this->getScheme($scheme) . $path;
}
return $this->getScheme($scheme) . $basePath . ltrim($this->fixSeparator($path), '/');
}
/**
* Retrieves relative path
*
* @param string $basePath
* @param string $path
* @return string
*/
public function getRelativePath($basePath, $path = null)
{
$path = $path !== null ? $this->fixSeparator($path) : '';
if ($basePath === null || strpos($path, $basePath) === 0 || $basePath == $path . '/') {
$result = substr($path, strlen($basePath));
} else {
$result = $path;
}
return $result;
}
/**
* Fixes path separator.
*
* Utility method.
*
* @param string $path
* @return string
*/
protected function fixSeparator($path)
{
return str_replace('\\', '/', $path);
}
/**
* Return path with scheme
*
* @param null|string $scheme
* @return string
*/
protected function getScheme($scheme = null)
{
return $scheme ? $scheme . '://' : '';
}
/**
* Read directory recursively
*
* @param string $path
* @return string[]
* @throws FileSystemException
*/
public function readDirectoryRecursively($path = null)
{
$result = [];
$flags = \FilesystemIterator::SKIP_DOTS |
\FilesystemIterator::UNIX_PATHS |
\RecursiveDirectoryIterator::FOLLOW_SYMLINKS;
try {
$iterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator($path, $flags),
\RecursiveIteratorIterator::CHILD_FIRST
);
/** @var \FilesystemIterator $file */
foreach ($iterator as $file) {
$result[] = $file->getPathname();
}
} catch (\Exception $e) {
throw new FileSystemException(new Phrase($e->getMessage()), $e);
}
return $result;
}
/**
* Get real path
*
* @param string $path
*
* @return string|bool
*/
public function getRealPath($path)
{
return realpath($path);
}
/**
* Return correct path for link
*
* @param string $path
* @return mixed
*/
public function getRealPathSafety($path)
{
if ($path === null) {
return '';
}
//Check backslashes
$path = preg_replace(
'/\\\\+/',
DIRECTORY_SEPARATOR,
$path
);
//Removing redundant directory separators.
$path = preg_replace(
'/\\' . DIRECTORY_SEPARATOR . '\\' . DIRECTORY_SEPARATOR . '+/',
DIRECTORY_SEPARATOR,
$path
);
if (strpos($path, DIRECTORY_SEPARATOR . '.') === false) {
return rtrim($path, DIRECTORY_SEPARATOR);
}
$pathParts = explode(DIRECTORY_SEPARATOR, $path);
if (end($pathParts) == '.') {
$pathParts[count($pathParts) - 1] = '';
}
$realPath = [];
foreach ($pathParts as $pathPart) {
if ($pathPart == '.') {
continue;
}
if ($pathPart == '..') {
array_pop($realPath);
continue;
}
$realPath[] = $pathPart;
}
return rtrim(implode(DIRECTORY_SEPARATOR, $realPath), DIRECTORY_SEPARATOR);
}
}