[ Index ] |
PHP Cross Reference of phpBB-3.2.11-deutsch |
[Summary view] [Print] [Text view]
1 <?php 2 3 /* 4 * This file is part of the Symfony package. 5 * 6 * (c) Fabien Potencier <fabien@symfony.com> 7 * 8 * For the full copyright and license information, please view the LICENSE 9 * file that was distributed with this source code. 10 */ 11 12 namespace Symfony\Component\Filesystem; 13 14 use Symfony\Component\Filesystem\Exception\FileNotFoundException; 15 use Symfony\Component\Filesystem\Exception\IOException; 16 17 /** 18 * Provides basic utility to manipulate the file system. 19 * 20 * @author Fabien Potencier <fabien@symfony.com> 21 */ 22 class Filesystem 23 { 24 private static $lastError; 25 26 /** 27 * Copies a file. 28 * 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. 32 * 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 36 * 37 * @throws FileNotFoundException When originFile doesn't exist 38 * @throws IOException When copy fails 39 */ 40 public function copy($originFile, $targetFile, $overwriteNewerFiles = false) 41 { 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); 45 } 46 47 $this->mkdir(\dirname($targetFile)); 48 49 $doCopy = true; 50 if (!$overwriteNewerFiles && null === parse_url($originFile, PHP_URL_HOST) && is_file($targetFile)) { 51 $doCopy = filemtime($originFile) > filemtime($targetFile); 52 } 53 54 if ($doCopy) { 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); 58 } 59 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); 63 } 64 65 $bytesCopied = stream_copy_to_stream($source, $target); 66 fclose($source); 67 fclose($target); 68 unset($source, $target); 69 70 if (!is_file($targetFile)) { 71 throw new IOException(sprintf('Failed to copy "%s" to "%s".', $originFile, $targetFile), 0, null, $originFile); 72 } 73 74 if ($originIsLocal) { 75 // Like `cp`, preserve executable permission bits 76 @chmod($targetFile, fileperms($targetFile) | (fileperms($originFile) & 0111)); 77 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); 80 } 81 } 82 } 83 } 84 85 /** 86 * Creates a directory recursively. 87 * 88 * @param string|iterable $dirs The directory path 89 * @param int $mode The directory mode 90 * 91 * @throws IOException On any directory creation failure 92 */ 93 public function mkdir($dirs, $mode = 0777) 94 { 95 foreach ($this->toIterator($dirs) as $dir) { 96 if (is_dir($dir)) { 97 continue; 98 } 99 100 if (!self::box('mkdir', $dir, $mode, true)) { 101 if (!is_dir($dir)) { 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); 105 } 106 throw new IOException(sprintf('Failed to create "%s"', $dir), 0, null, $dir); 107 } 108 } 109 } 110 } 111 112 /** 113 * Checks the existence of files or directories. 114 * 115 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to check 116 * 117 * @return bool true if the file exists, false otherwise 118 */ 119 public function exists($files) 120 { 121 $maxPathLength = PHP_MAXPATHLEN - 2; 122 123 foreach ($this->toIterator($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); 126 } 127 128 if (!file_exists($file)) { 129 return false; 130 } 131 } 132 133 return true; 134 } 135 136 /** 137 * Sets access and modification time of file. 138 * 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 142 * 143 * @throws IOException When touch fails 144 */ 145 public function touch($files, $time = null, $atime = null) 146 { 147 foreach ($this->toIterator($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); 151 } 152 } 153 } 154 155 /** 156 * Removes files or directories. 157 * 158 * @param string|iterable $files A filename, an array of files, or a \Traversable instance to remove 159 * 160 * @throws IOException When removal fails 161 */ 162 public function remove($files) 163 { 164 if ($files instanceof \Traversable) { 165 $files = iterator_to_array($files, false); 166 } elseif (!\is_array($files)) { 167 $files = array($files); 168 } 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)); 175 } 176 } elseif (is_dir($file)) { 177 $this->remove(new \FilesystemIterator($file, \FilesystemIterator::CURRENT_AS_PATHNAME | \FilesystemIterator::SKIP_DOTS)); 178 179 if (!self::box('rmdir', $file) && file_exists($file)) { 180 throw new IOException(sprintf('Failed to remove directory "%s": %s.', $file, self::$lastError)); 181 } 182 } elseif (!self::box('unlink', $file) && file_exists($file)) { 183 throw new IOException(sprintf('Failed to remove file "%s": %s.', $file, self::$lastError)); 184 } 185 } 186 } 187 188 /** 189 * Change mode for an array of files or directories. 190 * 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 195 * 196 * @throws IOException When the change fail 197 */ 198 public function chmod($files, $mode, $umask = 0000, $recursive = false) 199 { 200 foreach ($this->toIterator($files) as $file) { 201 if (true !== @chmod($file, $mode & ~$umask)) { 202 throw new IOException(sprintf('Failed to chmod file "%s".', $file), 0, null, $file); 203 } 204 if ($recursive && is_dir($file) && !is_link($file)) { 205 $this->chmod(new \FilesystemIterator($file), $mode, $umask, true); 206 } 207 } 208 } 209 210 /** 211 * Change the owner of an array of files or directories. 212 * 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 216 * 217 * @throws IOException When the change fail 218 */ 219 public function chown($files, $user, $recursive = false) 220 { 221 foreach ($this->toIterator($files) as $file) { 222 if ($recursive && is_dir($file) && !is_link($file)) { 223 $this->chown(new \FilesystemIterator($file), $user, true); 224 } 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); 228 } 229 } else { 230 if (true !== @chown($file, $user)) { 231 throw new IOException(sprintf('Failed to chown file "%s".', $file), 0, null, $file); 232 } 233 } 234 } 235 } 236 237 /** 238 * Change the group of an array of files or directories. 239 * 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 243 * 244 * @throws IOException When the change fail 245 */ 246 public function chgrp($files, $group, $recursive = false) 247 { 248 foreach ($this->toIterator($files) as $file) { 249 if ($recursive && is_dir($file) && !is_link($file)) { 250 $this->chgrp(new \FilesystemIterator($file), $group, true); 251 } 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); 255 } 256 } else { 257 if (true !== @chgrp($file, $group)) { 258 throw new IOException(sprintf('Failed to chgrp file "%s".', $file), 0, null, $file); 259 } 260 } 261 } 262 } 263 264 /** 265 * Renames a file or a directory. 266 * 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 270 * 271 * @throws IOException When target file or directory already exists 272 * @throws IOException When origin cannot be renamed 273 */ 274 public function rename($origin, $target, $overwrite = false) 275 { 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); 279 } 280 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); 286 287 return; 288 } 289 throw new IOException(sprintf('Cannot rename "%s" to "%s".', $origin, $target), 0, null, $target); 290 } 291 } 292 293 /** 294 * Tells whether a file exists and is readable. 295 * 296 * @param string $filename Path to the file 297 * 298 * @return bool 299 * 300 * @throws IOException When windows path is longer than 258 characters 301 */ 302 private function isReadable($filename) 303 { 304 $maxPathLength = PHP_MAXPATHLEN - 2; 305 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); 308 } 309 310 return is_readable($filename); 311 } 312 313 /** 314 * Creates a symbolic link or copy a directory. 315 * 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 319 * 320 * @throws IOException When symlink fails 321 */ 322 public function symlink($originDir, $targetDir, $copyOnWindows = false) 323 { 324 if ('\\' === \DIRECTORY_SEPARATOR) { 325 $originDir = strtr($originDir, '/', '\\'); 326 $targetDir = strtr($targetDir, '/', '\\'); 327 328 if ($copyOnWindows) { 329 $this->mirror($originDir, $targetDir); 330 331 return; 332 } 333 } 334 335 $this->mkdir(\dirname($targetDir)); 336 337 if (is_link($targetDir)) { 338 if (readlink($targetDir) === $originDir) { 339 return; 340 } 341 $this->remove($targetDir); 342 } 343 344 if (!self::box('symlink', $originDir, $targetDir)) { 345 if (null !== self::$lastError) { 346 if ('\\' === \DIRECTORY_SEPARATOR && false !== strpos(self::$lastError, 'error code(1314)')) { 347 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); 348 } 349 } 350 throw new IOException(sprintf('Failed to create symbolic link from "%s" to "%s".', $originDir, $targetDir), 0, null, $targetDir); 351 } 352 } 353 354 /** 355 * Given an existing path, convert it to a path relative to a given starting path. 356 * 357 * @param string $endPath Absolute path of target 358 * @param string $startPath Absolute path where traversal begins 359 * 360 * @return string Path of target relative to starting path 361 */ 362 public function makePathRelative($endPath, $startPath) 363 { 364 // Normalize separators on Windows 365 if ('\\' === \DIRECTORY_SEPARATOR) { 366 $endPath = str_replace('\\', '/', $endPath); 367 $startPath = str_replace('\\', '/', $startPath); 368 } 369 370 $stripDriveLetter = function ($path) { 371 if (\strlen($path) > 2 && ':' === $path[1] && '/' === $path[2] && ctype_alpha($path[0])) { 372 return substr($path, 2); 373 } 374 375 return $path; 376 }; 377 378 $endPath = $stripDriveLetter($endPath); 379 $startPath = $stripDriveLetter($startPath); 380 381 // Split the paths into arrays 382 $startPathArr = explode('/', trim($startPath, '/')); 383 $endPathArr = explode('/', trim($endPath, '/')); 384 385 $normalizePathArray = function ($pathSegments, $absolute) { 386 $result = array(); 387 388 foreach ($pathSegments as $segment) { 389 if ('..' === $segment && ($absolute || \count($result))) { 390 array_pop($result); 391 } elseif ('.' !== $segment) { 392 $result[] = $segment; 393 } 394 } 395 396 return $result; 397 }; 398 399 $startPathArr = $normalizePathArray($startPathArr, static::isAbsolutePath($startPath)); 400 $endPathArr = $normalizePathArray($endPathArr, static::isAbsolutePath($endPath)); 401 402 // Find for which directory the common path stops 403 $index = 0; 404 while (isset($startPathArr[$index]) && isset($endPathArr[$index]) && $startPathArr[$index] === $endPathArr[$index]) { 405 ++$index; 406 } 407 408 // Determine how deep the start path is relative to the common path (ie, "web/bundles" = 2 levels) 409 if (1 === \count($startPathArr) && '' === $startPathArr[0]) { 410 $depth = 0; 411 } else { 412 $depth = \count($startPathArr) - $index; 413 } 414 415 // Repeated "../" for each level need to reach the common path 416 $traverser = str_repeat('../', $depth); 417 418 $endPathRemainder = implode('/', \array_slice($endPathArr, $index)); 419 420 // Construct $endPath from traversing to the common path, then to the remaining $endPath 421 $relativePath = $traverser.('' !== $endPathRemainder ? $endPathRemainder.'/' : ''); 422 423 return '' === $relativePath ? './' : $relativePath; 424 } 425 426 /** 427 * Mirrors a directory to another. 428 * 429 * Copies files and directories from the origin directory into the target directory. By default: 430 * 431 * - existing files in the target directory will be overwritten, except if they are newer (see the `override` option) 432 * - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option) 433 * 434 * @param string $originDir The origin directory 435 * @param string $targetDir The target directory 436 * @param \Traversable $iterator Iterator that filters which files and directories to copy 437 * @param array $options An array of boolean options 438 * Valid options are: 439 * - $options['override'] If true, target files newer than origin files are overwritten (see copy(), defaults to false) 440 * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false) 441 * - $options['delete'] Whether to delete files that are not in the source directory (defaults to false) 442 * 443 * @throws IOException When file type is unknown 444 */ 445 public function mirror($originDir, $targetDir, \Traversable $iterator = null, $options = array()) 446 { 447 $targetDir = rtrim($targetDir, '/\\'); 448 $originDir = rtrim($originDir, '/\\'); 449 $originDirLen = \strlen($originDir); 450 451 // Iterate in destination folder to remove obsolete entries 452 if ($this->exists($targetDir) && isset($options['delete']) && $options['delete']) { 453 $deleteIterator = $iterator; 454 if (null === $deleteIterator) { 455 $flags = \FilesystemIterator::SKIP_DOTS; 456 $deleteIterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($targetDir, $flags), \RecursiveIteratorIterator::CHILD_FIRST); 457 } 458 $targetDirLen = \strlen($targetDir); 459 foreach ($deleteIterator as $file) { 460 $origin = $originDir.substr($file->getPathname(), $targetDirLen); 461 if (!$this->exists($origin)) { 462 $this->remove($file); 463 } 464 } 465 } 466 467 $copyOnWindows = false; 468 if (isset($options['copy_on_windows'])) { 469 $copyOnWindows = $options['copy_on_windows']; 470 } 471 472 if (null === $iterator) { 473 $flags = $copyOnWindows ? \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS : \FilesystemIterator::SKIP_DOTS; 474 $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($originDir, $flags), \RecursiveIteratorIterator::SELF_FIRST); 475 } 476 477 if ($this->exists($originDir)) { 478 $this->mkdir($targetDir); 479 } 480 481 foreach ($iterator as $file) { 482 $target = $targetDir.substr($file->getPathname(), $originDirLen); 483 484 if ($copyOnWindows) { 485 if (is_file($file)) { 486 $this->copy($file, $target, isset($options['override']) ? $options['override'] : false); 487 } elseif (is_dir($file)) { 488 $this->mkdir($target); 489 } else { 490 throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file); 491 } 492 } else { 493 if (is_link($file)) { 494 $this->symlink($file->getLinkTarget(), $target); 495 } elseif (is_dir($file)) { 496 $this->mkdir($target); 497 } elseif (is_file($file)) { 498 $this->copy($file, $target, isset($options['override']) ? $options['override'] : false); 499 } else { 500 throw new IOException(sprintf('Unable to guess "%s" file type.', $file), 0, null, $file); 501 } 502 } 503 } 504 } 505 506 /** 507 * Returns whether the file path is an absolute path. 508 * 509 * @param string $file A file path 510 * 511 * @return bool 512 */ 513 public function isAbsolutePath($file) 514 { 515 return strspn($file, '/\\', 0, 1) 516 || (\strlen($file) > 3 && ctype_alpha($file[0]) 517 && ':' === substr($file, 1, 1) 518 && strspn($file, '/\\', 2, 1) 519 ) 520 || null !== parse_url($file, PHP_URL_SCHEME) 521 ; 522 } 523 524 /** 525 * Creates a temporary file with support for custom stream wrappers. 526 * 527 * @param string $dir The directory where the temporary filename will be created 528 * @param string $prefix The prefix of the generated temporary filename 529 * Note: Windows uses only the first three characters of prefix 530 * 531 * @return string The new temporary filename (with path), or throw an exception on failure 532 */ 533 public function tempnam($dir, $prefix) 534 { 535 list($scheme, $hierarchy) = $this->getSchemeAndHierarchy($dir); 536 537 // If no scheme or scheme is "file" or "gs" (Google Cloud) create temp file in local filesystem 538 if (null === $scheme || 'file' === $scheme || 'gs' === $scheme) { 539 $tmpFile = @tempnam($hierarchy, $prefix); 540 541 // If tempnam failed or no scheme return the filename otherwise prepend the scheme 542 if (false !== $tmpFile) { 543 if (null !== $scheme && 'gs' !== $scheme) { 544 return $scheme.'://'.$tmpFile; 545 } 546 547 return $tmpFile; 548 } 549 550 throw new IOException('A temporary file could not be created.'); 551 } 552 553 // Loop until we create a valid temp file or have reached 10 attempts 554 for ($i = 0; $i < 10; ++$i) { 555 // Create a unique filename 556 $tmpFile = $dir.'/'.$prefix.uniqid(mt_rand(), true); 557 558 // Use fopen instead of file_exists as some streams do not support stat 559 // Use mode 'x+' to atomically check existence and create to avoid a TOCTOU vulnerability 560 $handle = @fopen($tmpFile, 'x+'); 561 562 // If unsuccessful restart the loop 563 if (false === $handle) { 564 continue; 565 } 566 567 // Close the file if it was successfully opened 568 @fclose($handle); 569 570 return $tmpFile; 571 } 572 573 throw new IOException('A temporary file could not be created.'); 574 } 575 576 /** 577 * Atomically dumps content into a file. 578 * 579 * @param string $filename The file to be written to 580 * @param string $content The data to write into the file 581 * @param int|null $mode The file mode (octal). If null, file permissions are not modified 582 * Deprecated since version 2.3.12, to be removed in 3.0. 583 * 584 * @throws IOException if the file cannot be written to 585 */ 586 public function dumpFile($filename, $content, $mode = 0666) 587 { 588 $dir = \dirname($filename); 589 590 if (!is_dir($dir)) { 591 $this->mkdir($dir); 592 } 593 594 if (!is_writable($dir)) { 595 throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir); 596 } 597 598 $tmpFile = $this->tempnam($dir, basename($filename)); 599 600 if (false === @file_put_contents($tmpFile, $content)) { 601 throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename); 602 } 603 604 if (null !== $mode) { 605 if (\func_num_args() > 2) { 606 @trigger_error('Support for modifying file permissions is deprecated since Symfony 2.3.12 and will be removed in 3.0.', E_USER_DEPRECATED); 607 } 608 609 $this->chmod($tmpFile, $mode); 610 } elseif (file_exists($filename)) { 611 @chmod($tmpFile, fileperms($filename)); 612 } 613 614 $this->rename($tmpFile, $filename, true); 615 } 616 617 /** 618 * @param mixed $files 619 * 620 * @return \Traversable 621 */ 622 private function toIterator($files) 623 { 624 if (!$files instanceof \Traversable) { 625 $files = new \ArrayObject(\is_array($files) ? $files : array($files)); 626 } 627 628 return $files; 629 } 630 631 /** 632 * Gets a 2-tuple of scheme (may be null) and hierarchical part of a filename (e.g. file:///tmp -> array(file, tmp)). 633 * 634 * @param string $filename The filename to be parsed 635 * 636 * @return array The filename scheme and hierarchical part 637 */ 638 private function getSchemeAndHierarchy($filename) 639 { 640 $components = explode('://', $filename, 2); 641 642 return 2 === \count($components) ? array($components[0], $components[1]) : array(null, $components[0]); 643 } 644 645 private static function box($func) 646 { 647 self::$lastError = null; 648 \set_error_handler(__CLASS__.'::handleError'); 649 try { 650 $result = \call_user_func_array($func, \array_slice(\func_get_args(), 1)); 651 \restore_error_handler(); 652 653 return $result; 654 } catch (\Throwable $e) { 655 } catch (\Exception $e) { 656 } 657 \restore_error_handler(); 658 659 throw $e; 660 } 661 662 /** 663 * @internal 664 */ 665 public static function handleError($type, $msg) 666 { 667 self::$lastError = $msg; 668 } 669 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
Generated: Wed Nov 11 20:33:01 2020 | Cross-referenced by PHPXref 0.7.1 |