diff --git a/src/Symfony/Component/Filesystem/CHANGELOG.md b/src/Symfony/Component/Filesystem/CHANGELOG.md
index a4c0479f7d9a7..aee6e804b0d02 100644
--- a/src/Symfony/Component/Filesystem/CHANGELOG.md
+++ b/src/Symfony/Component/Filesystem/CHANGELOG.md
@@ -1,6 +1,11 @@
CHANGELOG
=========
+2.8.0
+-----
+
+ * added tempnam() a stream aware version of PHP's native tempnam()
+
2.6.0
-----
diff --git a/src/Symfony/Component/Filesystem/Filesystem.php b/src/Symfony/Component/Filesystem/Filesystem.php
index 93a1f0de4c530..7b19706e6cedd 100644
--- a/src/Symfony/Component/Filesystem/Filesystem.php
+++ b/src/Symfony/Component/Filesystem/Filesystem.php
@@ -452,6 +452,58 @@ public function isAbsolutePath($file)
);
}
+ /**
+ * Creates a temporary file with support for custom stream wrappers.
+ *
+ * @param string $dir The directory where the temporary filename will be created.
+ * @param string $prefix The prefix of the generated temporary filename.
+ * Note: Windows uses only the first three characters of prefix.
+ *
+ * @return string The new temporary filename (with path), or throw an exception on failure.
+ */
+ public function tempnam($dir, $prefix)
+ {
+ list($scheme, $hierarchy) = $this->getSchemeAndHierarchy($dir);
+
+ // If no scheme or scheme is "file" create temp file in local filesystem
+ if (null === $scheme || 'file' === $scheme) {
+ $tmpFile = tempnam($hierarchy, $prefix);
+
+ // If tempnam failed or no scheme return the filename otherwise prepend the scheme
+ if (false !== $tmpFile) {
+ if (null !== $scheme) {
+ return $scheme.'://'.$tmpFile;
+ }
+
+ return $tmpFile;
+ }
+
+ throw new IOException('A temporary file could not be created.');
+ }
+
+ // Loop until we create a valid temp file or have reached 10 attempts
+ for ($i = 0; $i < 10; ++$i) {
+ // Create a unique filename
+ $tmpFile = $dir.'/'.$prefix.uniqid(mt_rand(), true);
+
+ // Use fopen instead of file_exists as some streams do not support stat
+ // Use mode 'x+' to atomically check existence and create to avoid a TOCTOU vulnerability
+ $handle = @fopen($tmpFile, 'x+');
+
+ // If unsuccessful restart the loop
+ if (false === $handle) {
+ continue;
+ }
+
+ // Close the file if it was successfully opened
+ @fclose($handle);
+
+ return $tmpFile;
+ }
+
+ throw new IOException('A temporary file could not be created.');
+ }
+
/**
* Atomically dumps content into a file.
*
@@ -472,7 +524,7 @@ public function dumpFile($filename, $content, $mode = 0666)
throw new IOException(sprintf('Unable to write to the "%s" directory.', $dir), 0, null, $dir);
}
- $tmpFile = tempnam($dir, basename($filename));
+ $tmpFile = $this->tempnam($dir, basename($filename));
if (false === @file_put_contents($tmpFile, $content)) {
throw new IOException(sprintf('Failed to write file "%s".', $filename), 0, null, $filename);
@@ -501,4 +553,18 @@ private function toIterator($files)
return $files;
}
+
+ /**
+ * Gets a 2-tuple of scheme (may be null) and hierarchical part of a filename (e.g. file:///tmp -> array(file, tmp)).
+ *
+ * @param string $filename The filename to be parsed.
+ *
+ * @return array The filename scheme and hierarchical part
+ */
+ private function getSchemeAndHierarchy($filename)
+ {
+ $components = explode('://', $filename, 2);
+
+ return 2 === count($components) ? array($components[0], $components[1]) : array(null, $components[0]);
+ }
}
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
index 45254c3c712e6..ea38e17df567e 100644
--- a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
+++ b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -946,6 +946,110 @@ public function providePathsForIsAbsolutePath()
);
}
+ public function testTempnam()
+ {
+ $dirname = $this->workspace;
+
+ $filename = $this->filesystem->tempnam($dirname, 'foo');
+
+ $this->assertFileExists($filename);
+ }
+
+ public function testTempnamWithFileScheme()
+ {
+ $scheme = 'file://';
+ $dirname = $scheme.$this->workspace;
+
+ $filename = $this->filesystem->tempnam($dirname, 'foo');
+
+ $this->assertStringStartsWith($scheme, $filename);
+ $this->assertFileExists($filename);
+ }
+
+ public function testTempnamWithMockScheme()
+ {
+ stream_wrapper_register('mock', 'Symfony\Component\Filesystem\Tests\Fixtures\MockStream\MockStream');
+
+ $scheme = 'mock://';
+ $dirname = $scheme.$this->workspace;
+
+ $filename = $this->filesystem->tempnam($dirname, 'foo');
+
+ $this->assertStringStartsWith($scheme, $filename);
+ $this->assertFileExists($filename);
+ }
+
+ /**
+ * @expectedException \Symfony\Component\Filesystem\Exception\IOException
+ */
+ public function testTempnamWithZlibSchemeFails()
+ {
+ $scheme = 'compress.zlib://';
+ $dirname = $scheme.$this->workspace;
+
+ // The compress.zlib:// stream does not support mode x: creates the file, errors "failed to open stream: operation failed" and returns false
+ $this->filesystem->tempnam($dirname, 'bar');
+
+ }
+
+ public function testTempnamWithPHPTempSchemeFails()
+ {
+ $scheme = 'php://temp';
+ $dirname = $scheme;
+
+ $filename = $this->filesystem->tempnam($dirname, 'bar');
+
+ $this->assertStringStartsWith($scheme, $filename);
+
+ // The php://temp stream deletes the file after close
+ $this->assertFileNotExists($filename);
+ }
+
+ /**
+ * @expectedException \Symfony\Component\Filesystem\Exception\IOException
+ */
+ public function testTempnamWithPharSchemeFails()
+ {
+ // Skip test if Phar disabled phar.readonly must be 0 in php.ini
+ if (!\Phar::canWrite()) {
+ $this->markTestSkipped('This test cannot run when phar.readonly is 1.');
+ }
+
+ $scheme = 'phar://';
+ $dirname = $scheme.$this->workspace;
+ $pharname = 'foo.phar';
+
+ new \Phar($this->workspace.'/'.$pharname, 0, $pharname);
+ // The phar:// stream does not support mode x: fails to create file, errors "failed to open stream: phar error: "$filename" is not a file in phar "$pharname"" and returns false
+ $this->filesystem->tempnam($dirname, $pharname.'/bar');
+ }
+
+ /**
+ * @expectedException \Symfony\Component\Filesystem\Exception\IOException
+ */
+ public function testTempnamWithHTTPSchemeFails()
+ {
+ $scheme = 'http://';
+ $dirname = $scheme.$this->workspace;
+
+ // The http:// scheme is read-only
+ $this->filesystem->tempnam($dirname, 'bar');
+ }
+
+ public function testTempnamOnUnwritableFallsBackToSysTmp()
+ {
+ $scheme = 'file://';
+ $dirname = $scheme.$this->workspace.DIRECTORY_SEPARATOR.'does_not_exist';
+
+ $filename = $this->filesystem->tempnam($dirname, 'bar');
+
+ $this->assertStringStartsWith(rtrim($scheme.sys_get_temp_dir(), DIRECTORY_SEPARATOR), $filename);
+ $this->assertFileExists($filename);
+
+ // Tear down
+ @unlink($filename);
+ }
+
public function testDumpFile()
{
$filename = $this->workspace.DIRECTORY_SEPARATOR.'foo'.DIRECTORY_SEPARATOR.'baz.txt';
@@ -1000,6 +1104,33 @@ public function testDumpFileOverwritesAnExistingFile()
$this->assertSame('bar', file_get_contents($filename));
}
+ public function testDumpFileWithFileScheme()
+ {
+ if (defined('HHVM_VERSION')) {
+ $this->markTestSkipped('HHVM does not handle the file:// scheme correctly');
+ }
+
+ $scheme = 'file://';
+ $filename = $scheme.$this->workspace.DIRECTORY_SEPARATOR.'foo'.DIRECTORY_SEPARATOR.'baz.txt';
+
+ $this->filesystem->dumpFile($filename, 'bar', null);
+
+ $this->assertFileExists($filename);
+ $this->assertSame('bar', file_get_contents($filename));
+ }
+
+ public function testDumpFileWithZlibScheme()
+ {
+ $scheme = 'compress.zlib://';
+ $filename = $this->workspace.DIRECTORY_SEPARATOR.'foo'.DIRECTORY_SEPARATOR.'baz.txt';
+
+ $this->filesystem->dumpFile($filename, 'bar', null);
+
+ // Zlib stat uses file:// wrapper so remove scheme
+ $this->assertFileExists(str_replace($scheme, '', $filename));
+ $this->assertSame('bar', file_get_contents($filename));
+ }
+
public function testCopyShouldKeepExecutionPermission()
{
$this->markAsSkippedIfChmodIsMissing();
diff --git a/src/Symfony/Component/Filesystem/Tests/Fixtures/MockStream/MockStream.php b/src/Symfony/Component/Filesystem/Tests/Fixtures/MockStream/MockStream.php
new file mode 100644
index 0000000000000..f14420fb60a1a
--- /dev/null
+++ b/src/Symfony/Component/Filesystem/Tests/Fixtures/MockStream/MockStream.php
@@ -0,0 +1,46 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Filesystem\Tests\Fixtures\MockStream;
+
+/**
+ * Mock stream class to be used with stream_wrapper_register.
+ * stream_wrapper_register('mock', 'Symfony\Component\Filesystem\Tests\Fixtures\MockStream\MockStream').
+ */
+class MockStream
+{
+ /**
+ * Opens file or URL.
+ *
+ * @param string $path Specifies the URL that was passed to the original function
+ * @param string $mode The mode used to open the file, as detailed for fopen()
+ * @param int $options Holds additional flags set by the streams API
+ * @param string $opened_path If the path is opened successfully, and STREAM_USE_PATH is set in options,
+ * opened_path should be set to the full path of the file/resource that was actually opened
+ *
+ * @return bool
+ */
+ public function stream_open($path, $mode, $options, &$opened_path)
+ {
+ return true;
+ }
+
+ /**
+ * @param string $path The file path or URL to stat
+ * @param array $flags Holds additional flags set by the streams API
+ *
+ * @return array File stats
+ */
+ public function url_stat($path, $flags)
+ {
+ return array();
+ }
+}
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy