namespace Symfony\Component\Filesystem;
-use Symfony\Component\Filesystem\Exception\IOException;
use Symfony\Component\Filesystem\Exception\FileNotFoundException;
+use Symfony\Component\Filesystem\Exception\IOException;
/**
* Provides basic utility to manipulate the file system.
*/
class Filesystem
{
+ private static $lastError;
+
/**
* Copies a file.
*
*/
public function copy($originFile, $targetFile, $overwriteNewerFiles = false)
{
- if (stream_is_local($originFile) && !is_file($originFile)) {
+ $originIsLocal = stream_is_local($originFile) || 0 === stripos($originFile, 'file://');
+ if ($originIsLocal && !is_file($originFile)) {
throw new FileNotFoundException(sprintf('Failed to copy "%s" because file does not exist.', $originFile), 0, null, $originFile);
}
- $this->mkdir(dirname($targetFile));
+ $this->mkdir(\dirname($targetFile));
$doCopy = true;
if (!$overwriteNewerFiles && null === parse_url($originFile, PHP_URL_HOST) && is_file($targetFile)) {
throw new IOException(sprintf('Failed to copy "%s" to "%s".', $originFile, $targetFile), 0, null, $originFile);
}
- // Like `cp`, preserve executable permission bits
- @chmod($targetFile, fileperms($targetFile) | (fileperms($originFile) & 0111));
+ if ($originIsLocal) {
+ // Like `cp`, preserve executable permission bits
+ @chmod($targetFile, fileperms($targetFile) | (fileperms($originFile) & 0111));
- if (stream_is_local($originFile) && $bytesCopied !== ($bytesOrigin = filesize($originFile))) {
- throw new IOException(sprintf('Failed to copy the whole content of "%s" to "%s" (%g of %g bytes copied).', $originFile, $targetFile, $bytesCopied, $bytesOrigin), 0, null, $originFile);
+ if ($bytesCopied !== $bytesOrigin = filesize($originFile)) {
+ throw new IOException(sprintf('Failed to copy the whole content of "%s" to "%s" (%g of %g bytes copied).', $originFile, $targetFile, $bytesCopied, $bytesOrigin), 0, null, $originFile);
+ }
}
}
}
/**
* Creates a directory recursively.
*
- * @param string|array|\Traversable $dirs The directory path
- * @param int $mode The directory mode
+ * @param string|iterable $dirs The directory path
+ * @param int $mode The directory mode
*
* @throws IOException On any directory creation failure
*/
public function mkdir($dirs, $mode = 0777)
{
- foreach ($this->toIterator($dirs) as $dir) {
+ foreach ($this->toIterable($dirs) as $dir) {
if (is_dir($dir)) {
continue;
}
- if (true !== @mkdir($dir, $mode, true)) {
- $error = error_get_last();
+ if (!self::box('mkdir', $dir, $mode, true)) {
if (!is_dir($dir)) {
// The directory was not created by a concurrent process. Let's throw an exception with a developer friendly error message if we have one
- if ($error) {
- throw new IOException(sprintf('Failed to create "%s": %s.', $dir, $error['message']), 0, null, $dir);
+ if (self::$lastError) {
+ throw new IOException(sprintf('Failed to create "%s": %s.', $dir, self::$lastError), 0, null, $dir);
}
throw new IOException(sprintf('Failed to create "%s"', $dir), 0, null, $dir);
}
/**
* Checks the existence of files or directories.
*
- * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to check
+ * @param string|iterable $files A filename, an array of files, or a \Traversable instance to check
*
* @return bool true if the file exists, false otherwise
*/
public function exists($files)
{
- foreach ($this->toIterator($files) as $file) {
- if ('\\' === DIRECTORY_SEPARATOR && strlen($file) > 258) {
- throw new IOException('Could not check if file exist because path length exceeds 258 characters.', 0, null, $file);
+ $maxPathLength = PHP_MAXPATHLEN - 2;
+
+ foreach ($this->toIterable($files) as $file) {
+ if (\strlen($file) > $maxPathLength) {
+ throw new IOException(sprintf('Could not check if file exist because path length exceeds %d characters.', $maxPathLength), 0, null, $file);
}
if (!file_exists($file)) {
/**
* Sets access and modification time of file.
*
- * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to create
- * @param int $time The touch time as a Unix timestamp
- * @param int $atime The access time as a Unix timestamp
+ * @param string|iterable $files A filename, an array of files, or a \Traversable instance to create
+ * @param int $time The touch time as a Unix timestamp
+ * @param int $atime The access time as a Unix timestamp
*
* @throws IOException When touch fails
*/
public function touch($files, $time = null, $atime = null)
{
- foreach ($this->toIterator($files) as $file) {
+ foreach ($this->toIterable($files) as $file) {
$touch = $time ? @touch($file, $time, $atime) : @touch($file);
if (true !== $touch) {
throw new IOException(sprintf('Failed to touch "%s".', $file), 0, null, $file);
/**
* Removes files or directories.
*
- * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to remove
+ * @param string|iterable $files A filename, an array of files, or a \Traversable instance to remove
*
* @throws IOException When removal fails
*/
{
if ($files instanceof \Traversable) {
$files = iterator_to_array($files, false);
- } elseif (!is_array($files)) {
+ } elseif (!\is_array($files)) {
$files = array($files);
}
$files = array_reverse($files);
foreach ($files as $file) {
if (is_link($file)) {
// See https://bugs.php.net/52176
- if (!@(unlink($file) || '\\' !== DIRECTORY_SEPARATOR || rmdir($file)) && file_exists($file)) {
- $error = error_get_last();
- throw new IOException(sprintf('Failed to remove symlink "%s": %s.', $file, $error['message']));
+ if (!(self::box('unlink', $file) || '\\' !== \DIRECTORY_SEPARATOR || self::box('rmdir', $file)) && file_exists($file)) {
+ throw new IOException(sprintf('Failed to remove symlink "%s": %s.', $file, self::$lastError));
}
} elseif (is_dir($file)) {
$this->remove(new \FilesystemIterator($file, \FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS));
- if (!@rmdir($file) && file_exists($file)) {
- $error = error_get_last();
- throw new IOException(sprintf('Failed to remove directory "%s": %s.', $file, $error['message']));
+ if (!self::box('rmdir', $file) && file_exists($file)) {
+ throw new IOException(sprintf('Failed to remove directory "%s": %s.', $file, self::$lastError));
}
- } elseif (!@unlink($file) && file_exists($file)) {
- $error = error_get_last();
- throw new IOException(sprintf('Failed to remove file "%s": %s.', $file, $error['message']));
+ } elseif (!self::box('unlink', $file) && file_exists($file)) {
+ throw new IOException(sprintf('Failed to remove file "%s": %s.', $file, self::$lastError));
}
}
}
/**
* Change mode for an array of files or directories.
*
- * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to change mode
- * @param int $mode The new mode (octal)
- * @param int $umask The mode mask (octal)
- * @param bool $recursive Whether change the mod recursively or not
+ * @param string|iterable $files A filename, an array of files, or a \Traversable instance to change mode
+ * @param int $mode The new mode (octal)
+ * @param int $umask The mode mask (octal)
+ * @param bool $recursive Whether change the mod recursively or not
*
* @throws IOException When the change fail
*/
public function chmod($files, $mode, $umask = 0000, $recursive = false)
{
- foreach ($this->toIterator($files) as $file) {
+ foreach ($this->toIterable($files) as $file) {
if (true !== @chmod($file, $mode & ~$umask)) {
throw new IOException(sprintf('Failed to chmod file "%s".', $file), 0, null, $file);
}
/**
* Change the owner of an array of files or directories.
*
- * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to change owner
- * @param string $user The new owner user name
- * @param bool $recursive Whether change the owner recursively or not
+ * @param string|iterable $files A filename, an array of files, or a \Traversable instance to change owner
+ * @param string $user The new owner user name
+ * @param bool $recursive Whether change the owner recursively or not
*
* @throws IOException When the change fail
*/
public function chown($files, $user, $recursive = false)
{
- foreach ($this->toIterator($files) as $file) {
+ foreach ($this->toIterable($files) as $file) {
if ($recursive && is_dir($file) && !is_link($file)) {
$this->chown(new \FilesystemIterator($file), $user, true);
}
- if (is_link($file) && function_exists('lchown')) {
+ if (is_link($file) && \function_exists('lchown')) {
if (true !== @lchown($file, $user)) {
throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
}
/**
* Change the group of an array of files or directories.
*
- * @param string|array|\Traversable $files A filename, an array of files, or a \Traversable instance to change group
- * @param string $group The group name
- * @param bool $recursive Whether change the group recursively or not
+ * @param string|iterable $files A filename, an array of files, or a \Traversable instance to change group
+ * @param string $group The group name
+ * @param bool $recursive Whether change the group recursively or not
*
* @throws IOException When the change fail
*/
public function chgrp($files, $group, $recursive = false)
{
- foreach ($this->toIterator($files) as $file) {
+ foreach ($this->toIterable($files) as $file) {
if ($recursive && is_dir($file) && !is_link($file)) {
$this->chgrp(new \FilesystemIterator($file), $group, true);
}
- if (is_link($file) && function_exists('lchgrp')) {
- if (true !== @lchgrp($file, $group) || (defined('HHVM_VERSION') && !posix_getgrnam($group))) {
+ if (is_link($file) && \function_exists('lchgrp')) {
+ if (true !== @lchgrp($file, $group) || (\defined('HHVM_VERSION') && !posix_getgrnam($group))) {
throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
}
} else {
}
if (true !== @rename($origin, $target)) {
+ if (is_dir($origin)) {
+ // See https://bugs.php.net/bug.php?id=54097 & http://php.net/manual/en/function.rename.php#113943
+ $this->mirror($origin, $target, null, array('override' => $overwrite, 'delete' => $overwrite));
+ $this->remove($origin);
+
+ return;
+ }
throw new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target), 0, null, $target);
}
}
*/
private function isReadable($filename)
{
- if ('\\' === DIRECTORY_SEPARATOR && strlen($filename) > 258) {
- throw new IOException('Could not check if file is readable because path length exceeds 258 characters.', 0, null, $filename);
+ $maxPathLength = PHP_MAXPATHLEN - 2;
+
+ if (\strlen($filename) > $maxPathLength) {
+ throw new IOException(sprintf('Could not check if file is readable because path length exceeds %d characters.', $maxPathLength), 0, null, $filename);
}
return is_readable($filename);
*/
public function symlink($originDir, $targetDir, $copyOnWindows = false)
{
- if ('\\' === DIRECTORY_SEPARATOR) {
+ if ('\\' === \DIRECTORY_SEPARATOR) {
$originDir = strtr($originDir, '/', '\\');
$targetDir = strtr($targetDir, '/', '\\');
}
}
- $this->mkdir(dirname($targetDir));
+ $this->mkdir(\dirname($targetDir));
- $ok = false;
if (is_link($targetDir)) {
- if (readlink($targetDir) != $originDir) {
- $this->remove($targetDir);
- } else {
- $ok = true;
+ if (readlink($targetDir) === $originDir) {
+ return;
}
+ $this->remove($targetDir);
+ }
+
+ if (!self::box('symlink', $originDir, $targetDir)) {
+ $this->linkException($originDir, $targetDir, 'symbolic');
}
+ }
- if (!$ok && true !== @symlink($originDir, $targetDir)) {
- $report = error_get_last();
- if (is_array($report)) {
- if ('\\' === DIRECTORY_SEPARATOR && false !== strpos($report['message'], 'error code(1314)')) {
- throw new IOException('Unable to create symlink due to error code 1314: \'A required privilege is not held by the client\'. Do you have the required Administrator-rights?', 0, null, $targetDir);
+ /**
+ * Creates a hard link, or several hard links to a file.
+ *
+ * @param string $originFile The original file
+ * @param string|string[] $targetFiles The target file(s)
+ *
+ * @throws FileNotFoundException When original file is missing or not a file
+ * @throws IOException When link fails, including if link already exists
+ */
+ public function hardlink($originFile, $targetFiles)
+ {
+ if (!$this->exists($originFile)) {
+ throw new FileNotFoundException(null, 0, null, $originFile);
+ }
+
+ if (!is_file($originFile)) {
+ throw new FileNotFoundException(sprintf('Origin file "%s" is not a file', $originFile));
+ }
+
+ foreach ($this->toIterable($targetFiles) as $targetFile) {
+ if (is_file($targetFile)) {
+ if (fileinode($originFile) === fileinode($targetFile)) {
+ continue;
}
+ $this->remove($targetFile);
+ }
+
+ if (!self::box('link', $originFile, $targetFile)) {
+ $this->linkException($originFile, $targetFile, 'hard');
}
- throw new IOException(sprintf('Failed to create symbolic link from "%s" to "%s".', $originDir, $targetDir), 0, null, $targetDir);
}
}
+ /**
+ * @param string $origin
+ * @param string $target
+ * @param string $linkType Name of the link type, typically 'symbolic' or 'hard'
+ */
+ private function linkException($origin, $target, $linkType)
+ {
+ if (self::$lastError) {
+ if ('\\' === \DIRECTORY_SEPARATOR && false !== strpos(self::$lastError, 'error code(1314)')) {
+ throw new IOException(sprintf('Unable to create %s link due to error code 1314: \'A required privilege is not held by the client\'. Do you have the required Administrator-rights?', $linkType), 0, null, $target);
+ }
+ }
+ throw new IOException(sprintf('Failed to create %s link from "%s" to "%s".', $linkType, $origin, $target), 0, null, $target);
+ }
+
+ /**
+ * Resolves links in paths.
+ *
+ * With $canonicalize = false (default)
+ * - if $path does not exist or is not a link, returns null
+ * - if $path is a link, returns the next direct target of the link without considering the existence of the target
+ *
+ * With $canonicalize = true
+ * - if $path does not exist, returns null
+ * - if $path exists, returns its absolute fully resolved final version
+ *
+ * @param string $path A filesystem path
+ * @param bool $canonicalize Whether or not to return a canonicalized path
+ *
+ * @return string|null
+ */
+ public function readlink($path, $canonicalize = false)
+ {
+ if (!$canonicalize && !is_link($path)) {
+ return;
+ }
+
+ if ($canonicalize) {
+ if (!$this->exists($path)) {
+ return;
+ }
+
+ if ('\\' === \DIRECTORY_SEPARATOR) {
+ $path = readlink($path);
+ }
+
+ return realpath($path);
+ }
+
+ if ('\\' === \DIRECTORY_SEPARATOR) {
+ return realpath($path);
+ }
+
+ return readlink($path);
+ }
+
/**
* Given an existing path, convert it to a path relative to a given starting path.
*
*/
public function makePathRelative($endPath, $startPath)
{
+ if (!$this->isAbsolutePath($endPath) || !$this->isAbsolutePath($startPath)) {
+ @trigger_error(sprintf('Support for passing relative paths to %s() is deprecated since Symfony 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);
+ }
+
// Normalize separators on Windows
- if ('\\' === DIRECTORY_SEPARATOR) {
+ if ('\\' === \DIRECTORY_SEPARATOR) {
$endPath = str_replace('\\', '/', $endPath);
$startPath = str_replace('\\', '/', $startPath);
}
+ $stripDriveLetter = function ($path) {
+ if (\strlen($path) > 2 && ':' === $path[1] && '/' === $path[2] && ctype_alpha($path[0])) {
+ return substr($path, 2);
+ }
+
+ return $path;
+ };
+
+ $endPath = $stripDriveLetter($endPath);
+ $startPath = $stripDriveLetter($startPath);
+
// Split the paths into arrays
$startPathArr = explode('/', trim($startPath, '/'));
$endPathArr = explode('/', trim($endPath, '/'));
- if ('/' !== $startPath[0]) {
- array_shift($startPathArr);
- }
-
- if ('/' !== $endPath[0]) {
- array_shift($endPathArr);
- }
-
- $normalizePathArray = function ($pathSegments) {
+ $normalizePathArray = function ($pathSegments, $absolute) {
$result = array();
foreach ($pathSegments as $segment) {
- if ('..' === $segment) {
+ if ('..' === $segment && ($absolute || \count($result))) {
array_pop($result);
- } else {
+ } elseif ('.' !== $segment) {
$result[] = $segment;
}
}
return $result;
};
- $startPathArr = $normalizePathArray($startPathArr);
- $endPathArr = $normalizePathArray($endPathArr);
+ $startPathArr = $normalizePathArray($startPathArr, static::isAbsolutePath($startPath));
+ $endPathArr = $normalizePathArray($endPathArr, static::isAbsolutePath($endPath));
// Find for which directory the common path stops
$index = 0;
}
// Determine how deep the start path is relative to the common path (ie, "web/bundles" = 2 levels)
- if (count($startPathArr) === 1 && $startPathArr[0] === '') {
+ if (1 === \count($startPathArr) && '' === $startPathArr[0]) {
$depth = 0;
} else {
- $depth = count($startPathArr) - $index;
+ $depth = \count($startPathArr) - $index;
}
- // When we need to traverse from the start, and we are starting from a root path, don't add '../'
- if ('/' === $startPath[0] && 0 === $index && 0 === $depth) {
- $traverser = '';
- } else {
- // Repeated "../" for each level need to reach the common path
- $traverser = str_repeat('../', $depth);
- }
+ // Repeated "../" for each level need to reach the common path
+ $traverser = str_repeat('../', $depth);
- $endPathRemainder = implode('/', array_slice($endPathArr, $index));
+ $endPathRemainder = implode('/', \array_slice($endPathArr, $index));
// Construct $endPath from traversing to the common path, then to the remaining $endPath
$relativePath = $traverser.('' !== $endPathRemainder ? $endPathRemainder.'/' : '');
/**
* Mirrors a directory to another.
*
+ * Copies files and directories from the origin directory into the target directory. By default:
+ *
+ * - existing files in the target directory will be overwritten, except if they are newer (see the `override` option)
+ * - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option)
+ *
* @param string $originDir The origin directory
* @param string $targetDir The target directory
- * @param \Traversable $iterator A Traversable instance
+ * @param \Traversable $iterator Iterator that filters which files and directories to copy
* @param array $options An array of boolean options
* Valid options are:
- * - $options['override'] Whether to override an existing file on copy or not (see copy())
- * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink())
+ * - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false)
+ * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
* - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
*
* @throws IOException When file type is unknown
{
$targetDir = rtrim($targetDir, '/\\');
$originDir = rtrim($originDir, '/\\');
+ $originDirLen = \strlen($originDir);
// Iterate in destination folder to remove obsolete entries
if ($this->exists($targetDir) && isset($options['delete']) && $options['delete']) {
$flags = \FilesystemIterator::SKIP_DOTS;
$deleteIterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($targetDir, $flags), \RecursiveIteratorIterator::CHILD_FIRST);
}
+ $targetDirLen = \strlen($targetDir);
foreach ($deleteIterator as $file) {
- $origin = str_replace($targetDir, $originDir, $file->getPathname());
+ $origin = $originDir.substr($file->getPathname(), $targetDirLen);
if (!$this->exists($origin)) {
$this->remove($file);
}
}
foreach ($iterator as $file) {
- $target = str_replace($originDir, $targetDir, $file->getPathname());
+ $target = $targetDir.substr($file->getPathname(), $originDirLen);
if ($copyOnWindows) {
if (is_file($file)) {
public function isAbsolutePath($file)
{
return strspn($file, '/\\', 0, 1)
- || (strlen($file) > 3 && ctype_alpha($file[0])
- && substr($file, 1, 1) === ':'
+ || (\strlen($file) > 3 && ctype_alpha($file[0])
+ && ':' === $file[1]
&& strspn($file, '/\\', 2, 1)
)
|| null !== parse_url($file, PHP_URL_SCHEME)
/**
* Atomically dumps content into a file.
*
- * @param string $filename The file to be written to
- * @param string $content The data to write into the file
- * @param null|int $mode The file mode (octal). If null, file permissions are not modified
- * Deprecated since version 2.3.12, to be removed in 3.0.
+ * @param string $filename The file to be written to
+ * @param string $content The data to write into the file
*
- * @throws IOException If the file cannot be written to.
+ * @throws IOException if the file cannot be written to
*/
- public function dumpFile($filename, $content, $mode = 0666)
+ public function dumpFile($filename, $content)
{
- $dir = dirname($filename);
+ $dir = \dirname($filename);
if (!is_dir($dir)) {
$this->mkdir($dir);
throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
}
+ // Will create a temp file with 0600 access rights
+ // when the filesystem supports chmod.
$tmpFile = $this->tempnam($dir, basename($filename));
if (false === @file_put_contents($tmpFile, $content)) {
throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
}
- if (null !== $mode) {
- if (func_num_args() > 2) {
- @trigger_error('Support for modifying file permissions is deprecated since version 2.3.12 and will be removed in 3.0.', E_USER_DEPRECATED);
- }
-
- $this->chmod($tmpFile, $mode);
- } elseif (file_exists($filename)) {
- @chmod($tmpFile, fileperms($filename));
- }
+ @chmod($tmpFile, file_exists($filename) ? fileperms($filename) : 0666 & ~umask());
$this->rename($tmpFile, $filename, true);
}
/**
- * @param mixed $files
+ * Appends content to an existing file.
+ *
+ * @param string $filename The file to which to append content
+ * @param string $content The content to append
*
- * @return \Traversable
+ * @throws IOException If the file is not writable
*/
- private function toIterator($files)
+ public function appendToFile($filename, $content)
{
- if (!$files instanceof \Traversable) {
- $files = new \ArrayObject(is_array($files) ? $files : array($files));
+ $dir = \dirname($filename);
+
+ if (!is_dir($dir)) {
+ $this->mkdir($dir);
}
- return $files;
+ if (!is_writable($dir)) {
+ throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
+ }
+
+ if (false === @file_put_contents($filename, $content, FILE_APPEND)) {
+ throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
+ }
+ }
+
+ /**
+ * @param mixed $files
+ *
+ * @return array|\Traversable
+ */
+ private function toIterable($files)
+ {
+ return \is_array($files) || $files instanceof \Traversable ? $files : array($files);
}
/**
{
$components = explode('://', $filename, 2);
- return 2 === count($components) ? array($components[0], $components[1]) : array(null, $components[0]);
+ return 2 === \count($components) ? array($components[0], $components[1]) : array(null, $components[0]);
+ }
+
+ private static function box($func)
+ {
+ self::$lastError = null;
+ \set_error_handler(__CLASS__.'::handleError');
+ try {
+ $result = \call_user_func_array($func, \array_slice(\func_get_args(), 1));
+ \restore_error_handler();
+
+ return $result;
+ } catch (\Throwable $e) {
+ } catch (\Exception $e) {
+ }
+ \restore_error_handler();
+
+ throw $e;
+ }
+
+ /**
+ * @internal
+ */
+ public static function handleError($type, $msg)
+ {
+ self::$lastError = $msg;
}
}
projects / yaffs-website / blobdiff