PHPLIB-425: GridFS methods should throw if stream copying fails (#776)

* PHPLIB-425: GridFS methods should throw if stream copying fails

* Suppress error that occur during stream_copy_to_stream

* Use more expressive exception messages

* Print more usable information in stream exceptions

* Add tests for stream exceptions

* Fix phpcs violations

* Fix wrong regex in tests

* Skip test on PHP < 7.4

Apparently, the workaround of returning false to stream_read only works on PHP 7.4 but not on earlier versions

* Avoid using new PHPUnit assertion

Author: alcaeus

phpcs.xml.dist

@@ -109,6 +109,7 @@
     <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
         <exclude-pattern>/src/GridFS/StreamWrapper</exclude-pattern>
         <exclude-pattern>/tests/DocumentationExamplesTest.php</exclude-pattern>
+        <exclude-pattern>/tests/GridFS/UnusableStream.php</exclude-pattern>
     </rule>
 
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">

src/GridFS/Bucket.php

@@ -28,6 +28,7 @@
 use MongoDB\Exception\UnsupportedException;
 use MongoDB\GridFS\Exception\CorruptFileException;
 use MongoDB\GridFS\Exception\FileNotFoundException;
+use MongoDB\GridFS\Exception\StreamException;
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Operation\Find;
@@ -238,6 +239,7 @@ public function delete($id)
      * @param resource $destination Writable Stream
      * @throws FileNotFoundException if no file could be selected
      * @throws InvalidArgumentException if $destination is not a stream
+     * @throws StreamException if the file could not be uploaded
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function downloadToStream($id, $destination)
@@ -246,7 +248,10 @@ public function downloadToStream($id, $destination)
             throw InvalidArgumentException::invalidType('$destination', $destination, 'resource');
         }
 
-        stream_copy_to_stream($this->openDownloadStream($id), $destination);
+        $source = $this->openDownloadStream($id);
+        if (@stream_copy_to_stream($source, $destination) === false) {
+            throw StreamException::downloadFromIdFailed($id, $source, $destination);
+        }
     }
 
     /**
@@ -273,6 +278,7 @@ public function downloadToStream($id, $destination)
      * @param array    $options     Download options
      * @throws FileNotFoundException if no file could be selected
      * @throws InvalidArgumentException if $destination is not a stream
+     * @throws StreamException if the file could not be uploaded
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function downloadToStreamByName($filename, $destination, array $options = [])
@@ -281,7 +287,10 @@ public function downloadToStreamByName($filename, $destination, array $options =
             throw InvalidArgumentException::invalidType('$destination', $destination, 'resource');
         }
 
-        stream_copy_to_stream($this->openDownloadStreamByName($filename, $options), $destination);
+        $source = $this->openDownloadStreamByName($filename, $options);
+        if (@stream_copy_to_stream($source, $destination) === false) {
+            throw StreamException::downloadFromFilenameFailed($filename, $source, $destination);
+        }
     }
 
     /**
@@ -607,6 +616,7 @@ public function rename($id, $newFilename)
      * @param array    $options  Stream options
      * @return mixed ID of the newly created GridFS file
      * @throws InvalidArgumentException if $source is not a GridFS stream
+     * @throws StreamException if the file could not be uploaded
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
     public function uploadFromStream($filename, $source, array $options = [])
@@ -616,7 +626,11 @@ public function uploadFromStream($filename, $source, array $options = [])
         }
 
         $destination = $this->openUploadStream($filename, $options);
-        stream_copy_to_stream($source, $destination);
+
+        if (@stream_copy_to_stream($source, $destination) === false) {
+            $destinationUri = $this->createPathForFile($this->getRawFileDocumentForStream($destination));
+            throw StreamException::uploadFailed($filename, $source, $destinationUri);
+        }
 
         return $this->getFileIdForStream($destination);
     }

src/GridFS/Exception/StreamException.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace MongoDB\GridFS\Exception;
+
+use MongoDB\Exception\RuntimeException;
+use function MongoDB\BSON\fromPHP;
+use function MongoDB\BSON\toJSON;
+use function sprintf;
+use function stream_get_meta_data;
+
+class StreamException extends RuntimeException
+{
+    /**
+     * @param resource $source
+     * @param resource $destination
+     */
+    public static function downloadFromFilenameFailed(string $filename, $source, $destination) : self
+    {
+        $sourceMetadata = stream_get_meta_data($source);
+        $destinationMetadata = stream_get_meta_data($destination);
+
+        return new static(sprintf('Downloading file from "%s" to "%s" failed. GridFS filename: "%s"', $sourceMetadata['uri'], $destinationMetadata['uri'], $filename));
+    }
+
+    /**
+     * @param mixed    $id
+     * @param resource $source
+     * @param resource $destination
+     */
+    public static function downloadFromIdFailed($id, $source, $destination) : self
+    {
+        $idString = toJSON(fromPHP(['_id' => $id]));
+        $sourceMetadata = stream_get_meta_data($source);
+        $destinationMetadata = stream_get_meta_data($destination);
+
+        return new static(sprintf('Downloading file from "%s" to "%s" failed. GridFS identifier: "%s"', $sourceMetadata['uri'], $destinationMetadata['uri'], $idString));
+    }
+
+    /** @param resource $source */
+    public static function uploadFailed(string $filename, $source, string $destinationUri) : self
+    {
+        $sourceMetadata = stream_get_meta_data($source);
+
+        return new static(sprintf('Uploading file from "%s" to "%s" failed. GridFS filename: "%s"', $sourceMetadata['uri'], $destinationUri, $filename));
+    }
+}

tests/GridFS/BucketFunctionalTest.php

@@ -10,6 +10,7 @@
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\GridFS\Bucket;
 use MongoDB\GridFS\Exception\FileNotFoundException;
+use MongoDB\GridFS\Exception\StreamException;
 use MongoDB\Model\BSONDocument;
 use MongoDB\Model\IndexInfo;
 use MongoDB\Operation\ListCollections;
@@ -19,6 +20,7 @@
 use function call_user_func;
 use function current;
 use function fclose;
+use function fopen;
 use function fread;
 use function fwrite;
 use function hash_init;
@@ -29,6 +31,7 @@
 use function stream_get_contents;
 use function strlen;
 use function substr;
+use const PHP_VERSION_ID;
 
 /**
  * Functional tests for the Bucket class.
@@ -708,6 +711,38 @@ public function testExistingIndexIsReused()
         $this->assertIndexNotExists($this->chunksCollection->getCollectionName(), 'files_id_1_n_1');
     }
 
+    public function testDownloadToStreamFails()
+    {
+        $this->bucket->uploadFromStream('filename', $this->createStream('foo'), ['_id' => ['foo' => 'bar']]);
+
+        $this->expectException(StreamException::class);
+        $this->expectExceptionMessageRegExp('#^Downloading file from "gridfs://.*/.*/.*" to "php://temp" failed. GridFS identifier: "{ "_id" : { "foo" : "bar" } }"$#');
+        $this->bucket->downloadToStream(['foo' => 'bar'], fopen('php://temp', 'r'));
+    }
+
+    public function testDownloadToStreamByNameFails()
+    {
+        $this->bucket->uploadFromStream('filename', $this->createStream('foo'));
+
+        $this->expectException(StreamException::class);
+        $this->expectExceptionMessageRegExp('#^Downloading file from "gridfs://.*/.*/.*" to "php://temp" failed. GridFS filename: "filename"$#');
+        $this->bucket->downloadToStreamByName('filename', fopen('php://temp', 'r'));
+    }
+
+    public function testUploadFromStreamFails()
+    {
+        if (PHP_VERSION_ID < 70400) {
+            $this->markTestSkipped('Test only works on PHP 7.4 and newer');
+        }
+
+        UnusableStream::register();
+        $source = fopen('unusable://temp', 'w');
+
+        $this->expectException(StreamException::class);
+        $this->expectExceptionMessageRegExp('#^Uploading file from "unusable://temp" to "gridfs://.*/.*/.*" failed. GridFS filename: "filename"$#');
+        $this->bucket->uploadFromStream('filename', $source);
+    }
+
     /**
      * Asserts that a collection with the given name does not exist on the
      * server.

tests/GridFS/UnusableStream.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace MongoDB\Tests\GridFS;
+
+use function in_array;
+use function stream_get_wrappers;
+use function stream_wrapper_register;
+use function stream_wrapper_unregister;
+use const SEEK_SET;
+use const STREAM_IS_URL;
+
+final class UnusableStream
+{
+    public static function register($protocol = 'unusable')
+    {
+        if (in_array($protocol, stream_get_wrappers())) {
+            stream_wrapper_unregister($protocol);
+        }
+
+        stream_wrapper_register($protocol, static::class, STREAM_IS_URL);
+    }
+
+    public function stream_close()
+    {
+    }
+
+    public function stream_eof()
+    {
+        return true;
+    }
+
+    public function stream_open($path, $mode, $options, &$openedPath)
+    {
+        return true;
+    }
+
+    public function stream_read($length)
+    {
+        return false;
+    }
+
+    public function stream_seek($offset, $whence = SEEK_SET)
+    {
+        return true;
+    }
+
+    public function stream_stat()
+    {
+        return [];
+    }
+
+    public function stream_tell()
+    {
+        return 0;
+    }
+
+    public function stream_write($data)
+    {
+        return 0;
+    }
+}