2010-02-17 13:55:05 +00:00
|
|
|
<?php
|
|
|
|
|
2010-07-09 09:05:26 +01:00
|
|
|
namespace Symfony\Bundle\FrameworkBundle\Util;
|
2010-02-17 13:55:05 +00:00
|
|
|
|
|
|
|
/*
|
2010-04-07 01:51:29 +01:00
|
|
|
* This file is part of the Symfony framework.
|
2010-02-17 13:55:05 +00:00
|
|
|
*
|
|
|
|
* (c) Fabien Potencier <fabien.potencier@symfony-project.com>
|
|
|
|
*
|
|
|
|
* This source file is subject to the MIT license that is bundled
|
|
|
|
* with this source code in the file LICENSE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Provides basic utility to manipulate the file system.
|
|
|
|
*
|
2010-10-17 12:45:15 +01:00
|
|
|
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
|
2010-02-17 13:55:05 +00:00
|
|
|
*/
|
|
|
|
class Filesystem
|
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Copies a file.
|
|
|
|
*
|
|
|
|
* This method only copies the file if the origin file is newer than the target file.
|
|
|
|
*
|
|
|
|
* By default, if the target already exists, it is not overridden.
|
|
|
|
*
|
|
|
|
* To override existing files, pass the "override" option.
|
|
|
|
*
|
|
|
|
* @param string $originFile The original filename
|
|
|
|
* @param string $targetFile The target filename
|
|
|
|
* @param array $options An array of options
|
|
|
|
*/
|
|
|
|
public function copy($originFile, $targetFile, $options = array())
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!array_key_exists('override', $options)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$options['override'] = false;
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-09-23 17:52:18 +01:00
|
|
|
$this->mkdirs(dirname($targetFile));
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$mostRecent = false;
|
2010-05-07 15:09:11 +01:00
|
|
|
if (file_exists($targetFile)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$statTarget = stat($targetFile);
|
|
|
|
$stat_origin = stat($originFile);
|
|
|
|
$mostRecent = ($stat_origin['mtime'] > $statTarget['mtime']) ? true : false;
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if ($options['override'] || !file_exists($targetFile) || $mostRecent) {
|
2010-05-06 12:25:53 +01:00
|
|
|
copy($originFile, $targetFile);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Creates a directory recursively.
|
|
|
|
*
|
|
|
|
* @param string $path The directory path
|
|
|
|
* @param int $mode The directory mode
|
|
|
|
*
|
|
|
|
* @return bool true if the directory has been created, false otherwise
|
|
|
|
*/
|
|
|
|
public function mkdirs($path, $mode = 0777)
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (is_dir($path)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
return true;
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return @mkdir($path, $mode, true);
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Creates empty files.
|
|
|
|
*
|
|
|
|
* @param mixed $files The filename, or an array of filenames
|
|
|
|
*/
|
|
|
|
public function touch($files)
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!is_array($files)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$files = array($files);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($files as $file) {
|
2010-05-06 12:25:53 +01:00
|
|
|
touch($file);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Removes files or directories.
|
|
|
|
*
|
|
|
|
* @param mixed $files A filename or an array of files to remove
|
|
|
|
*/
|
|
|
|
public function remove($files)
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!is_array($files)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$files = array($files);
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$files = array_reverse($files);
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($files as $file) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if (!file_exists($file)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
continue;
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (is_dir($file) && !is_link($file)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$fp = opendir($file);
|
2010-05-07 15:09:11 +01:00
|
|
|
while (false !== $item = readdir($fp)) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if (!in_array($item, array('.', '..'))) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->remove($file.'/'.$item);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
closedir($fp);
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
rmdir($file);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
unlink($file);
|
|
|
|
}
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Change mode for an array of files or directories.
|
|
|
|
*
|
|
|
|
* @param array $files An array of files or directories
|
|
|
|
* @param integer $mode The new mode
|
|
|
|
* @param integer $umask The mode mask (octal)
|
|
|
|
*/
|
|
|
|
public function chmod($files, $mode, $umask = 0000)
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
$currentUmask = umask();
|
|
|
|
umask($umask);
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!is_array($files)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$files = array($files);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
foreach ($files as $file) {
|
2010-05-06 12:25:53 +01:00
|
|
|
chmod($file, $mode);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
umask($currentUmask);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Renames a file.
|
|
|
|
*
|
|
|
|
* @param string $origin The origin filename
|
|
|
|
* @param string $target The new filename
|
|
|
|
*
|
|
|
|
* @throws \RuntimeException When target file already exists
|
|
|
|
*/
|
|
|
|
public function rename($origin, $target)
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-06 12:25:53 +01:00
|
|
|
// we check that target does not exist
|
2010-05-07 15:09:11 +01:00
|
|
|
if (is_readable($target)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \RuntimeException(sprintf('Cannot rename because the target "%" already exist.', $target));
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
rename($origin, $target);
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Creates a symbolic link or copy a directory.
|
|
|
|
*
|
|
|
|
* @param string $originDir The origin directory path
|
|
|
|
* @param string $targetDir The symbolic link name
|
|
|
|
* @param bool $copyOnWindows Whether to copy files if on windows
|
|
|
|
*/
|
|
|
|
public function symlink($originDir, $targetDir, $copyOnWindows = false)
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!function_exists('symlink') && $copyOnWindows) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->mirror($originDir, $targetDir);
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
return;
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
$ok = false;
|
2010-05-07 15:09:11 +01:00
|
|
|
if (is_link($targetDir)) {
|
2010-05-08 14:32:30 +01:00
|
|
|
if (readlink($targetDir) != $originDir) {
|
2010-05-06 12:25:53 +01:00
|
|
|
unlink($targetDir);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
$ok = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (!$ok) {
|
2010-05-06 12:25:53 +01:00
|
|
|
symlink($originDir, $targetDir);
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
|
2010-05-06 12:25:53 +01:00
|
|
|
/**
|
|
|
|
* Mirrors a directory to another.
|
|
|
|
*
|
2010-06-30 11:52:30 +01:00
|
|
|
* @param string $originDir The origin directory
|
|
|
|
* @param string $targetDir The target directory
|
|
|
|
* @param \Traversable $iterator A Traversable instance
|
|
|
|
* @param array $options An array of options (see copy())
|
2010-05-06 12:25:53 +01:00
|
|
|
*
|
|
|
|
* @throws \RuntimeException When file type is unknown
|
|
|
|
*/
|
2010-06-30 11:52:30 +01:00
|
|
|
public function mirror($originDir, $targetDir, \Traversable $iterator = null, $options = array())
|
2010-02-17 13:55:05 +00:00
|
|
|
{
|
2010-06-30 11:52:30 +01:00
|
|
|
if (null === $iterator) {
|
|
|
|
$iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($originDir, \FilesystemIterator::SKIP_DOTS), \RecursiveIteratorIterator::SELF_FIRST);
|
2010-05-06 12:25:53 +01:00
|
|
|
}
|
2010-04-21 10:18:41 +01:00
|
|
|
|
2010-09-23 17:52:18 +01:00
|
|
|
if ('/' === substr($targetDir, -1) || '\\' === substr($targetDir, -1)) {
|
|
|
|
$targetDir = substr($targetDir, 0, -1);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ('/' === substr($originDir, -1) || '\\' === substr($originDir, -1)) {
|
|
|
|
$originDir = substr($originDir, 0, -1);
|
|
|
|
}
|
|
|
|
|
2010-06-30 11:52:30 +01:00
|
|
|
foreach ($iterator as $file) {
|
2010-09-28 20:56:09 +01:00
|
|
|
$target = $targetDir.'/'.str_replace($originDir.DIRECTORY_SEPARATOR, '', $file->getPathname());
|
2010-05-06 12:25:53 +01:00
|
|
|
|
2010-05-07 15:09:11 +01:00
|
|
|
if (is_dir($file)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->mkdirs($target);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else if (is_file($file)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->copy($file, $target, $options);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else if (is_link($file)) {
|
2010-05-06 12:25:53 +01:00
|
|
|
$this->symlink($file, $target);
|
2010-05-07 15:09:11 +01:00
|
|
|
} else {
|
2010-05-06 12:25:53 +01:00
|
|
|
throw new \RuntimeException(sprintf('Unable to guess "%s" file type.', $file));
|
|
|
|
}
|
|
|
|
}
|
2010-02-17 13:55:05 +00:00
|
|
|
}
|
|
|
|
}
|