4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Filesystem;
14 use Symfony\Component\Filesystem\Exception\FileNotFoundException;
15 use Symfony\Component\Filesystem\Exception\IOException;
18 * Provides basic utility to manipulate the file system.
20 * @author Fabien Potencier <fabien@symfony.com>
24 private static $lastError;
29 * If the target file is older than the origin file, it's always overwritten.
30 * If the target file is newer, it is overwritten only when the
31 * $overwriteNewerFiles option is set to true.
33 * @param string $originFile The original filename
34 * @param string $targetFile The target filename
35 * @param bool $overwriteNewerFiles If true, target files newer than origin files are overwritten
37 * @throws FileNotFoundException When originFile doesn't exist
38 * @throws IOException When copy fails
40 public function copy($originFile, $targetFile, $overwriteNewerFiles = false)
42 $originIsLocal = stream_is_local($originFile) || 0 === stripos($originFile, 'file://');
43 if ($originIsLocal && !is_file($originFile)) {
44 throw new FileNotFoundException(sprintf('Failed to copy "%s" because file does not exist.', $originFile), 0, null, $originFile);
47 $this->mkdir(\dirname($targetFile));
50 if (!$overwriteNewerFiles && null === parse_url($originFile, PHP_URL_HOST) && is_file($targetFile)) {
51 $doCopy = filemtime($originFile) > filemtime($targetFile);
55 // https://bugs.php.net/bug.php?id=64634
56 if (false === $source = @fopen($originFile, 'r')) {
57 throw new IOException(sprintf('Failed to copy "%s" to "%s" because source file could not be opened for reading.', $originFile, $targetFile), 0, null, $originFile);
60 // Stream context created to allow files overwrite when using FTP stream wrapper - disabled by default
61 if (false === $target = @fopen($targetFile, 'w', null, stream_context_create(array('ftp' => array('overwrite' => true))))) {
62 throw new IOException(sprintf('Failed to copy "%s" to "%s" because target file could not be opened for writing.', $originFile, $targetFile), 0, null, $originFile);
65 $bytesCopied = stream_copy_to_stream($source, $target);
68 unset($source, $target);
70 if (!is_file($targetFile)) {
71 throw new IOException(sprintf('Failed to copy "%s" to "%s".', $originFile, $targetFile), 0, null, $originFile);
75 // Like `cp`, preserve executable permission bits
76 @chmod($targetFile, fileperms($targetFile) | (fileperms($originFile) & 0111));
78 if ($bytesCopied !== $bytesOrigin = filesize($originFile)) {
79 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);
86 * Creates a directory recursively.
88 * @param string|iterable $dirs The directory path
89 * @param int $mode The directory mode
91 * @throws IOException On any directory creation failure
93 public function mkdir($dirs, $mode = 0777)
95 foreach ($this->toIterable($dirs) as $dir) {
100 if (!self::box('mkdir', $dir, $mode, true)) {
102 // The directory was not created by a concurrent process. Let's throw an exception with a developer friendly error message if we have one
103 if (self::$lastError) {
104 throw new IOException(sprintf('Failed to create "%s": %s.', $dir, self::$lastError), 0, null, $dir);
106 throw new IOException(sprintf('Failed to create "%s"', $dir), 0, null, $dir);
113 * Checks the existence of files or directories.
115 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to check
117 * @return bool true if the file exists, false otherwise
119 public function exists($files)
121 $maxPathLength = PHP_MAXPATHLEN - 2;
123 foreach ($this->toIterable($files) as $file) {
124 if (\strlen($file) > $maxPathLength) {
125 throw new IOException(sprintf('Could not check if file exist because path length exceeds %d characters.', $maxPathLength), 0, null, $file);
128 if (!file_exists($file)) {
137 * Sets access and modification time of file.
139 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to create
140 * @param int $time The touch time as a Unix timestamp
141 * @param int $atime The access time as a Unix timestamp
143 * @throws IOException When touch fails
145 public function touch($files, $time = null, $atime = null)
147 foreach ($this->toIterable($files) as $file) {
148 $touch = $time ? @touch($file, $time, $atime) : @touch($file);
149 if (true !== $touch) {
150 throw new IOException(sprintf('Failed to touch "%s".', $file), 0, null, $file);
156 * Removes files or directories.
158 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to remove
160 * @throws IOException When removal fails
162 public function remove($files)
164 if ($files instanceof \Traversable) {
165 $files = iterator_to_array($files, false);
166 } elseif (!\is_array($files)) {
167 $files = array($files);
169 $files = array_reverse($files);
170 foreach ($files as $file) {
171 if (is_link($file)) {
172 // See https://bugs.php.net/52176
173 if (!(self::box('unlink', $file) || '\\' !== \DIRECTORY_SEPARATOR || self::box('rmdir', $file)) && file_exists($file)) {
174 throw new IOException(sprintf('Failed to remove symlink "%s": %s.', $file, self::$lastError));
176 } elseif (is_dir($file)) {
177 $this->remove(new \FilesystemIterator($file, \FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS));
179 if (!self::box('rmdir', $file) && file_exists($file)) {
180 throw new IOException(sprintf('Failed to remove directory "%s": %s.', $file, self::$lastError));
182 } elseif (!self::box('unlink', $file) && file_exists($file)) {
183 throw new IOException(sprintf('Failed to remove file "%s": %s.', $file, self::$lastError));
189 * Change mode for an array of files or directories.
191 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to change mode
192 * @param int $mode The new mode (octal)
193 * @param int $umask The mode mask (octal)
194 * @param bool $recursive Whether change the mod recursively or not
196 * @throws IOException When the change fail
198 public function chmod($files, $mode, $umask = 0000, $recursive = false)
200 foreach ($this->toIterable($files) as $file) {
201 if (true !== @chmod($file, $mode & ~$umask)) {
202 throw new IOException(sprintf('Failed to chmod file "%s".', $file), 0, null, $file);
204 if ($recursive && is_dir($file) && !is_link($file)) {
205 $this->chmod(new \FilesystemIterator($file), $mode, $umask, true);
211 * Change the owner of an array of files or directories.
213 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to change owner
214 * @param string $user The new owner user name
215 * @param bool $recursive Whether change the owner recursively or not
217 * @throws IOException When the change fail
219 public function chown($files, $user, $recursive = false)
221 foreach ($this->toIterable($files) as $file) {
222 if ($recursive && is_dir($file) && !is_link($file)) {
223 $this->chown(new \FilesystemIterator($file), $user, true);
225 if (is_link($file) && \function_exists('lchown')) {
226 if (true !== @lchown($file, $user)) {
227 throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
230 if (true !== @chown($file, $user)) {
231 throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file);
238 * Change the group of an array of files or directories.
240 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to change group
241 * @param string $group The group name
242 * @param bool $recursive Whether change the group recursively or not
244 * @throws IOException When the change fail
246 public function chgrp($files, $group, $recursive = false)
248 foreach ($this->toIterable($files) as $file) {
249 if ($recursive && is_dir($file) && !is_link($file)) {
250 $this->chgrp(new \FilesystemIterator($file), $group, true);
252 if (is_link($file) && \function_exists('lchgrp')) {
253 if (true !== @lchgrp($file, $group) || (\defined('HHVM_VERSION') && !posix_getgrnam($group))) {
254 throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
257 if (true !== @chgrp($file, $group)) {
258 throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file);
265 * Renames a file or a directory.
267 * @param string $origin The origin filename or directory
268 * @param string $target The new filename or directory
269 * @param bool $overwrite Whether to overwrite the target if it already exists
271 * @throws IOException When target file or directory already exists
272 * @throws IOException When origin cannot be renamed
274 public function rename($origin, $target, $overwrite = false)
276 // we check that target does not exist
277 if (!$overwrite && $this->isReadable($target)) {
278 throw new IOException(sprintf('Cannot rename because the target "%s" already exists.', $target), 0, null, $target);
281 if (true !== @rename($origin, $target)) {
282 if (is_dir($origin)) {
283 // See https://bugs.php.net/bug.php?id=54097 & http://php.net/manual/en/function.rename.php#113943
284 $this->mirror($origin, $target, null, array('override' => $overwrite, 'delete' => $overwrite));
285 $this->remove($origin);
289 throw new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target), 0, null, $target);
294 * Tells whether a file exists and is readable.
296 * @param string $filename Path to the file
300 * @throws IOException When windows path is longer than 258 characters
302 private function isReadable($filename)
304 $maxPathLength = PHP_MAXPATHLEN - 2;
306 if (\strlen($filename) > $maxPathLength) {
307 throw new IOException(sprintf('Could not check if file is readable because path length exceeds %d characters.', $maxPathLength), 0, null, $filename);
310 return is_readable($filename);
314 * Creates a symbolic link or copy a directory.
316 * @param string $originDir The origin directory path
317 * @param string $targetDir The symbolic link name
318 * @param bool $copyOnWindows Whether to copy files if on Windows
320 * @throws IOException When symlink fails
322 public function symlink($originDir, $targetDir, $copyOnWindows = false)
324 if ('\\' === \DIRECTORY_SEPARATOR) {
325 $originDir = strtr($originDir, '/', '\\');
326 $targetDir = strtr($targetDir, '/', '\\');
328 if ($copyOnWindows) {
329 $this->mirror($originDir, $targetDir);
335 $this->mkdir(\dirname($targetDir));
337 if (is_link($targetDir)) {
338 if (readlink($targetDir) === $originDir) {
341 $this->remove($targetDir);
344 if (!self::box('symlink', $originDir, $targetDir)) {
345 $this->linkException($originDir, $targetDir, 'symbolic');
350 * Creates a hard link, or several hard links to a file.
352 * @param string $originFile The original file
353 * @param string|string[] $targetFiles The target file(s)
355 * @throws FileNotFoundException When original file is missing or not a file
356 * @throws IOException When link fails, including if link already exists
358 public function hardlink($originFile, $targetFiles)
360 if (!$this->exists($originFile)) {
361 throw new FileNotFoundException(null, 0, null, $originFile);
364 if (!is_file($originFile)) {
365 throw new FileNotFoundException(sprintf('Origin file "%s" is not a file', $originFile));
368 foreach ($this->toIterable($targetFiles) as $targetFile) {
369 if (is_file($targetFile)) {
370 if (fileinode($originFile) === fileinode($targetFile)) {
373 $this->remove($targetFile);
376 if (!self::box('link', $originFile, $targetFile)) {
377 $this->linkException($originFile, $targetFile, 'hard');
383 * @param string $origin
384 * @param string $target
385 * @param string $linkType Name of the link type, typically 'symbolic' or 'hard'
387 private function linkException($origin, $target, $linkType)
389 if (self::$lastError) {
390 if ('\\' === \DIRECTORY_SEPARATOR && false !== strpos(self::$lastError, 'error code(1314)')) {
391 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);
394 throw new IOException(sprintf('Failed to create %s link from "%s" to "%s".', $linkType, $origin, $target), 0, null, $target);
398 * Resolves links in paths.
400 * With $canonicalize = false (default)
401 * - if $path does not exist or is not a link, returns null
402 * - if $path is a link, returns the next direct target of the link without considering the existence of the target
404 * With $canonicalize = true
405 * - if $path does not exist, returns null
406 * - if $path exists, returns its absolute fully resolved final version
408 * @param string $path A filesystem path
409 * @param bool $canonicalize Whether or not to return a canonicalized path
411 * @return string|null
413 public function readlink($path, $canonicalize = false)
415 if (!$canonicalize && !is_link($path)) {
420 if (!$this->exists($path)) {
424 if ('\\' === \DIRECTORY_SEPARATOR) {
425 $path = readlink($path);
428 return realpath($path);
431 if ('\\' === \DIRECTORY_SEPARATOR) {
432 return realpath($path);
435 return readlink($path);
439 * Given an existing path, convert it to a path relative to a given starting path.
441 * @param string $endPath Absolute path of target
442 * @param string $startPath Absolute path where traversal begins
444 * @return string Path of target relative to starting path
446 public function makePathRelative($endPath, $startPath)
448 if (!$this->isAbsolutePath($endPath) || !$this->isAbsolutePath($startPath)) {
449 @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);
452 // Normalize separators on Windows
453 if ('\\' === \DIRECTORY_SEPARATOR) {
454 $endPath = str_replace('\\', '/', $endPath);
455 $startPath = str_replace('\\', '/', $startPath);
458 $stripDriveLetter = function ($path) {
459 if (\strlen($path) > 2 && ':' === $path[1] && '/' === $path[2] && ctype_alpha($path[0])) {
460 return substr($path, 2);
466 $endPath = $stripDriveLetter($endPath);
467 $startPath = $stripDriveLetter($startPath);
469 // Split the paths into arrays
470 $startPathArr = explode('/', trim($startPath, '/'));
471 $endPathArr = explode('/', trim($endPath, '/'));
473 $normalizePathArray = function ($pathSegments, $absolute) {
476 foreach ($pathSegments as $segment) {
477 if ('..' === $segment && ($absolute || \count($result))) {
479 } elseif ('.' !== $segment) {
480 $result[] = $segment;
487 $startPathArr = $normalizePathArray($startPathArr, static::isAbsolutePath($startPath));
488 $endPathArr = $normalizePathArray($endPathArr, static::isAbsolutePath($endPath));
490 // Find for which directory the common path stops
492 while (isset($startPathArr[$index]) && isset($endPathArr[$index]) && $startPathArr[$index] === $endPathArr[$index]) {
496 // Determine how deep the start path is relative to the common path (ie, "web/bundles" = 2 levels)
497 if (1 === \count($startPathArr) && '' === $startPathArr[0]) {
500 $depth = \count($startPathArr) - $index;
503 // Repeated "../" for each level need to reach the common path
504 $traverser = str_repeat('../', $depth);
506 $endPathRemainder = implode('/', \array_slice($endPathArr, $index));
508 // Construct $endPath from traversing to the common path, then to the remaining $endPath
509 $relativePath = $traverser.('' !== $endPathRemainder ? $endPathRemainder.'/' : '');
511 return '' === $relativePath ? './' : $relativePath;
515 * Mirrors a directory to another.
517 * Copies files and directories from the origin directory into the target directory. By default:
519 * - existing files in the target directory will be overwritten, except if they are newer (see the `override` option)
520 * - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option)
522 * @param string $originDir The origin directory
523 * @param string $targetDir The target directory
524 * @param \Traversable $iterator Iterator that filters which files and directories to copy
525 * @param array $options An array of boolean options
527 * - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false)
528 * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
529 * - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
531 * @throws IOException When file type is unknown
533 public function mirror($originDir, $targetDir, \Traversable $iterator = null, $options = array())
535 $targetDir = rtrim($targetDir, '/\\');
536 $originDir = rtrim($originDir, '/\\');
537 $originDirLen = \strlen($originDir);
539 // Iterate in destination folder to remove obsolete entries
540 if ($this->exists($targetDir) && isset($options['delete']) && $options['delete']) {
541 $deleteIterator = $iterator;
542 if (null === $deleteIterator) {
543 $flags = \FilesystemIterator::SKIP_DOTS;
544 $deleteIterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($targetDir, $flags), \RecursiveIteratorIterator::CHILD_FIRST);
546 $targetDirLen = \strlen($targetDir);
547 foreach ($deleteIterator as $file) {
548 $origin = $originDir.substr($file->getPathname(), $targetDirLen);
549 if (!$this->exists($origin)) {
550 $this->remove($file);
555 $copyOnWindows = false;
556 if (isset($options['copy_on_windows'])) {
557 $copyOnWindows = $options['copy_on_windows'];
560 if (null === $iterator) {
561 $flags = $copyOnWindows ? \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS : \FilesystemIterator::SKIP_DOTS;
562 $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($originDir, $flags), \RecursiveIteratorIterator::SELF_FIRST);
565 if ($this->exists($originDir)) {
566 $this->mkdir($targetDir);
569 foreach ($iterator as $file) {
570 $target = $targetDir.substr($file->getPathname(), $originDirLen);
572 if ($copyOnWindows) {
573 if (is_file($file)) {
574 $this->copy($file, $target, isset($options['override']) ? $options['override'] : false);
575 } elseif (is_dir($file)) {
576 $this->mkdir($target);
578 throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file);
581 if (is_link($file)) {
582 $this->symlink($file->getLinkTarget(), $target);
583 } elseif (is_dir($file)) {
584 $this->mkdir($target);
585 } elseif (is_file($file)) {
586 $this->copy($file, $target, isset($options['override']) ? $options['override'] : false);
588 throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file);
595 * Returns whether the file path is an absolute path.
597 * @param string $file A file path
601 public function isAbsolutePath($file)
603 return strspn($file, '/\\', 0, 1)
604 || (\strlen($file) > 3 && ctype_alpha($file[0])
606 && strspn($file, '/\\', 2, 1)
608 || null !== parse_url($file, PHP_URL_SCHEME)
613 * Creates a temporary file with support for custom stream wrappers.
615 * @param string $dir The directory where the temporary filename will be created
616 * @param string $prefix The prefix of the generated temporary filename
617 * Note: Windows uses only the first three characters of prefix
619 * @return string The new temporary filename (with path), or throw an exception on failure
621 public function tempnam($dir, $prefix)
623 list($scheme, $hierarchy) = $this->getSchemeAndHierarchy($dir);
625 // If no scheme or scheme is "file" or "gs" (Google Cloud) create temp file in local filesystem
626 if (null === $scheme || 'file' === $scheme || 'gs' === $scheme) {
627 $tmpFile = @tempnam($hierarchy, $prefix);
629 // If tempnam failed or no scheme return the filename otherwise prepend the scheme
630 if (false !== $tmpFile) {
631 if (null !== $scheme && 'gs' !== $scheme) {
632 return $scheme.'://'.$tmpFile;
638 throw new IOException('A temporary file could not be created.');
641 // Loop until we create a valid temp file or have reached 10 attempts
642 for ($i = 0; $i < 10; ++$i) {
643 // Create a unique filename
644 $tmpFile = $dir.'/'.$prefix.uniqid(mt_rand(), true);
646 // Use fopen instead of file_exists as some streams do not support stat
647 // Use mode 'x+' to atomically check existence and create to avoid a TOCTOU vulnerability
648 $handle = @fopen($tmpFile, 'x+');
650 // If unsuccessful restart the loop
651 if (false === $handle) {
655 // Close the file if it was successfully opened
661 throw new IOException('A temporary file could not be created.');
665 * Atomically dumps content into a file.
667 * @param string $filename The file to be written to
668 * @param string $content The data to write into the file
670 * @throws IOException if the file cannot be written to
672 public function dumpFile($filename, $content)
674 $dir = \dirname($filename);
680 if (!is_writable($dir)) {
681 throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
684 // Will create a temp file with 0600 access rights
685 // when the filesystem supports chmod.
686 $tmpFile = $this->tempnam($dir, basename($filename));
688 if (false === @file_put_contents($tmpFile, $content)) {
689 throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
692 @chmod($tmpFile, file_exists($filename) ? fileperms($filename) : 0666 & ~umask());
694 $this->rename($tmpFile, $filename, true);
698 * Appends content to an existing file.
700 * @param string $filename The file to which to append content
701 * @param string $content The content to append
703 * @throws IOException If the file is not writable
705 public function appendToFile($filename, $content)
707 $dir = \dirname($filename);
713 if (!is_writable($dir)) {
714 throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
717 if (false === @file_put_contents($filename, $content, FILE_APPEND)) {
718 throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
723 * @param mixed $files
725 * @return array|\Traversable
727 private function toIterable($files)
729 return \is_array($files) || $files instanceof \Traversable ? $files : array($files);
733 * Gets a 2-tuple of scheme (may be null) and hierarchical part of a filename (e.g. file:///tmp -> array(file, tmp)).
735 * @param string $filename The filename to be parsed
737 * @return array The filename scheme and hierarchical part
739 private function getSchemeAndHierarchy($filename)
741 $components = explode('://', $filename, 2);
743 return 2 === \count($components) ? array($components[0], $components[1]) : array(null, $components[0]);
746 private static function box($func)
748 self::$lastError = null;
749 \set_error_handler(__CLASS__.'::handleError');
751 $result = \call_user_func_array($func, \array_slice(\func_get_args(), 1));
752 \restore_error_handler();
755 } catch (\Throwable $e) {
756 } catch (\Exception $e) {
758 \restore_error_handler();
766 public static function handleError($type, $msg)
768 self::$lastError = $msg;