Filesystem.php 29 KB

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