Filesystem.php 29 KB

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