* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ /** * sfFilesystem provides basic utility to manipulate the file system. * * @package symfony * @subpackage util * @author Fabien Potencier * @version SVN: $Id: sfFilesystem.class.php 27816 2010-02-10 15:46:46Z FabianLange $ */ class sfFilesystem { protected $dispatcher = null, $formatter = null; /** * Constructor. * * @param sfEventDispatcher $dispatcher An sfEventDispatcher instance * @param sfFormatter $formatter An sfFormatter instance */ public function __construct(sfEventDispatcher $dispatcher = null, sfFormatter $formatter = null) { $this->dispatcher = $dispatcher; $this->formatter = $formatter; } /** * 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 overriden. * * 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()) { if (!array_key_exists('override', $options)) { $options['override'] = false; } // we create target_dir if needed if (!is_dir(dirname($targetFile))) { $this->mkdirs(dirname($targetFile)); } $mostRecent = false; if (file_exists($targetFile)) { $statTarget = stat($targetFile); $stat_origin = stat($originFile); $mostRecent = ($stat_origin['mtime'] > $statTarget['mtime']) ? true : false; } if ($options['override'] || !file_exists($targetFile) || $mostRecent) { $this->logSection('file+', $targetFile); copy($originFile, $targetFile); } } /** * 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) { if (is_dir($path)) { return true; } $this->logSection('dir+', $path); return @mkdir($path, $mode, true); } /** * Creates empty files. * * @param mixed $files The filename, or an array of filenames */ public function touch($files) { if (!is_array($files)) { $files = array($files); } foreach ($files as $file) { $this->logSection('file+', $file); touch($file); } } /** * Removes files or directories. * * @param mixed $files A filename or an array of files to remove */ public function remove($files) { if (!is_array($files)) { $files = array($files); } $files = array_reverse($files); foreach ($files as $file) { if (is_dir($file) && !is_link($file)) { $this->logSection('dir-', $file); rmdir($file); } else { $this->logSection(is_link($file) ? 'link-' : 'file-', $file); unlink($file); } } } /** * 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) { $currentUmask = umask(); umask($umask); if (!is_array($files)) { $files = array($files); } foreach ($files as $file) { $this->logSection(sprintf('chmod %o', $mode), $file); chmod($file, $mode); } umask($currentUmask); } /** * Renames a file. * * @param string $origin The origin filename * @param string $target The new filename */ public function rename($origin, $target) { // we check that target does not exist if (is_readable($target)) { throw new sfException(sprintf('Cannot rename because the target "%s" already exist.', $target)); } $this->logSection('rename', $origin.' > '.$target); rename($origin, $target); } /** * 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) { if (!function_exists('symlink') && $copyOnWindows) { $finder = sfFinder::type('any'); $this->mirror($originDir, $targetDir, $finder); return; } $ok = false; if (is_link($targetDir)) { if (readlink($targetDir) != $originDir) { unlink($targetDir); } else { $ok = true; } } if (!$ok) { $this->logSection('link+', $targetDir); symlink($originDir, $targetDir); } } /** * Creates a symbolic link using a relative path if possible. * * @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 relativeSymlink($originDir, $targetDir, $copyOnWindows = false) { if (function_exists('symlink') || !$copyOnWindows) { $originDir = $this->calculateRelativeDir($targetDir, $originDir); } $this->symlink($originDir, $targetDir, $copyOnWindows); } /** * Mirrors a directory to another. * * @param string $originDir The origin directory * @param string $targetDir The target directory * @param sfFinder $finder An sfFinder instance * @param array $options An array of options (see copy()) */ public function mirror($originDir, $targetDir, $finder, $options = array()) { foreach ($finder->relative()->in($originDir) as $file) { if (is_dir($originDir.DIRECTORY_SEPARATOR.$file)) { $this->mkdirs($targetDir.DIRECTORY_SEPARATOR.$file); } else if (is_file($originDir.DIRECTORY_SEPARATOR.$file)) { $this->copy($originDir.DIRECTORY_SEPARATOR.$file, $targetDir.DIRECTORY_SEPARATOR.$file, $options); } else if (is_link($originDir.DIRECTORY_SEPARATOR.$file)) { $this->symlink($originDir.DIRECTORY_SEPARATOR.$file, $targetDir.DIRECTORY_SEPARATOR.$file); } else { throw new sfException(sprintf('Unable to guess "%s" file type.', $file)); } } } /** * Executes a shell command. * * @param string $cmd The command to execute on the shell */ public function sh($cmd) { $this->logSection('exec ', $cmd); ob_start(); passthru($cmd.' 2>&1', $return); $content = ob_get_contents(); ob_end_clean(); if ($return > 0) { throw new sfException(sprintf('Problem executing command %s', "\n".$content)); } return $content; } /** * Replaces tokens in an array of files. * * @param array $files An array of filenames * @param string $beginToken The begin token delimiter * @param string $endToken The end token delimiter * @param array $tokens An array of token/value pairs */ public function replaceTokens($files, $beginToken, $endToken, $tokens) { if (!is_array($files)) { $files = array($files); } foreach ($files as $file) { $content = file_get_contents($file); foreach ($tokens as $key => $value) { $content = str_replace($beginToken.$key.$endToken, $value, $content, $count); } $this->logSection('tokens', $file); file_put_contents($file, $content); } } /** * Logs a message in a section. * * @param string $section The section name * @param string $message The message * @param int $size The maximum size of a line */ protected function logSection($section, $message, $size = null) { if (!$this->dispatcher) { return; } $message = $this->formatter ? $this->formatter->formatSection($section, $message, $size) : $section.' '.$message."\n"; $this->dispatcher->notify(new sfEvent($this, 'command.log', array($message))); } /** * Calculates the relative path from one to another directory. * If they share no common path the absolute target dir is returned * * @param string $from directory from that the relative path shall be calculated * @param string $to target directory */ protected function calculateRelativeDir($from, $to) { $from = $this->canonicalizePath($from); $to = $this->canonicalizePath($to); $commonLength = 0; $minPathLength = min(strlen($from), strlen($to)); // count how many chars the strings have in common for ($i = 0; $i < $minPathLength; $i++) { if ($from[$i] != $to[$i]) break; if ($from[$i] == DIRECTORY_SEPARATOR) $commonLength = $i + 1; } if ($commonLength) { $levelUp = substr_count($from, DIRECTORY_SEPARATOR, $commonLength); // up that many level $relativeDir = str_repeat("..".DIRECTORY_SEPARATOR, $levelUp); // down the remaining $to path $relativeDir .= substr($to, $commonLength); return $relativeDir; } return $to; } protected function canonicalizePath($path) { if (empty($path)) return ''; $out=array(); foreach( explode(DIRECTORY_SEPARATOR, $path) as $i => $fold) { if ($fold=='' || $fold=='.') continue; if ($fold=='..' && $i>0 && end($out)!='..') { array_pop($out); } else { $out[]= $fold; } } $result = $path{0} == DIRECTORY_SEPARATOR ? DIRECTORY_SEPARATOR : ''; $result .= join(DIRECTORY_SEPARATOR, $out); $result .= $path{strlen($path)-1} == DIRECTORY_SEPARATOR ? DIRECTORY_SEPARATOR : ''; return $result; } }