Added yii2tech\filestorage\BucketInterface::openFile()

Author: klimov-paul

BucketInterface.php

@@ -155,4 +155,16 @@ public function moveFileInternal($srcFile, $destFile);
      * @return string file web URL.
      */
     public function getFileUrl($fileName);
+
+    /**
+     * Opens a file as stream resource, e.g. like `fopen()` function.
+     * @param string $fileName - file name.
+     * @param string $mode - the type of access you require to the stream, e.g. `r`, `w`, `a` and so on.
+     * You should prefer usage of simple modes like `r` and `w`, avoiding complex ones like `w+`, as they
+     * may not supported by some storages.
+     * @param resource|null $context - stream context to be used.
+     * @return resource file pointer resource on success, or `false` on error.
+     * @since 1.1.0
+     */
+    public function openFile($fileName, $mode, $context = null);
 }

CHANGELOG.md

@@ -1,6 +1,12 @@
 Yii 2 File Storage extension Change Log
 =======================================
 
+1.1.0 under development
+-----------------------
+
+- Enh #4: Added `yii2tech\filestorage\BucketInterface::openFile()` allowing to open file as a PHP resource (klimov-paul)
+
+
 1.0.1, April 25, 2016
 ---------------------
 

amazon/Bucket.php

@@ -499,6 +499,30 @@ public function getFileUrl($fileName)
         return $amazonS3->getObjectUrl($this->getUrlName(), $fileName);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function openFile($fileName, $mode, $context = null)
+    {
+        $this->getStorage()->registerStreamWrapper();
+
+        $streamPath = 's3://' . $this->getUrlName() . '/' . $fileName;
+
+        if ($mode === 'r' && func_num_args() < 3) {
+            $context = stream_context_create([
+                's3' => [
+                    'seekable' => true
+                ]
+            ]);
+        }
+
+        if ($context === null) {
+            // avoid PHP warning: fopen() expects parameter 4 to be resource, null given
+            return fopen($streamPath, $mode);
+        }
+        return fopen($streamPath, $mode, null, $context);
+    }
+
     // Batch files upload :
 
     /**

amazon/Storage.php

@@ -67,10 +67,15 @@ class Storage extends BaseStorage
      * If constant 'AWS_SECRET_KEY' has been defined, this field can be left blank.
      */
     public $awsSecretKey = '';
+
     /**
      * @var S3Client instance of the Amazon S3 client.
      */
     private $_amazonS3;
+    /**
+     * @var boolean whether `s3` stream wrapper has been already registered.
+     */
+    private $streamWrapperRegistered = false;
 
 
     /**
@@ -108,4 +113,17 @@ protected function createAmazonS3()
         ];
         return S3Client::factory($amazonS3Options);
     }
+
+    /**
+     * Registers Amazon S3 stream wrapper for the `s3` protocol.
+     * @param boolean $force whether to enforce registration even wrapper has been already registered.
+     * @since 1.1.0
+     */
+    public function registerStreamWrapper($force = false)
+    {
+        if ($force || !$this->streamWrapperRegistered) {
+            $this->getAmazonS3()->registerStreamWrapper();
+            $this->streamWrapperRegistered = true;
+        }
+    }
 }

local/Bucket.php

@@ -401,4 +401,17 @@ public function getFileUrl($fileName)
         $fileUrl = $baseUrl . '/' . $fileName;
         return $fileUrl;
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function openFile($fileName, $mode, $context = null)
+    {
+        $fullFileName = $this->resolveFullFileName($fileName);
+        if ($context === null) {
+            // avoid PHP warning: fopen() expects parameter 4 to be resource, null given
+            return fopen($fullFileName, $mode);
+        }
+        return fopen($fullFileName, $mode, null, $context);
+    }
 }

tests/amazon/BucketTest.php

@@ -459,6 +459,35 @@ public function testGetFileUrl()
         $this->assertEquals( $expectedFileUrl, $returnedFileUrl, 'Wrong file URL returned!' );*/
     }
 
+    /**
+     * @depends testGetFileContent
+     */
+    public function testOpenFile()
+    {
+        $bucket = $this->createFileStorageBucket('test-bucket-open-file');
+
+        $testFileName = 'test_read_file_name.tmp';
+        $testFileContent = 'Test read file content';
+        $bucket->saveFileContent($testFileName, $testFileContent);
+
+        $resource = $bucket->openFile($testFileName, 'r');
+        $this->assertTrue(is_resource($resource));
+
+        $this->assertEquals($testFileContent, stream_get_contents($resource));
+        fclose($resource);
+
+        $testFileName = 'test_write_file_name.tmp';
+        $testFileContent = 'Test write file content';
+
+        $resource = $bucket->openFile($testFileName, 'w');
+        $this->assertTrue(is_resource($resource));
+
+        fwrite($resource, $testFileContent);
+        fclose($resource);
+
+        $this->assertEquals($testFileContent, $bucket->getFileContent($testFileName));
+    }
+
     /**
      * @depends testSaveFileContent
      */

tests/local/BucketTest.php

@@ -483,4 +483,35 @@ public function testSaveFileNameWithDirSeparator()
         $bucketFileName = $bucket->getFullFileName($testFileName);
         $this->assertTrue(file_exists($bucketFileName), 'Unable to create file with name, containing dir separator, in the bucket!');
     }
+
+    /**
+     * @depends testGetFileContent
+     */
+    public function testOpenFile()
+    {
+        $bucket = $this->createFileStorageBucket();
+        $testBucketName = 'test_get_file_content_bucket';
+        $bucket->setName($testBucketName);
+
+        $testFileName = 'test_read_file_name.tmp';
+        $testFileContent = 'Test read file content';
+        $bucket->saveFileContent($testFileName, $testFileContent);
+
+        $resource = $bucket->openFile($testFileName, 'r');
+        $this->assertTrue(is_resource($resource));
+
+        $this->assertEquals($testFileContent, stream_get_contents($resource));
+        fclose($resource);
+
+        $testFileName = 'test_write_file_name.tmp';
+        $testFileContent = 'Test write file content';
+
+        $resource = $bucket->openFile($testFileName, 'w');
+        $this->assertTrue(is_resource($resource));
+
+        fwrite($resource, $testFileContent);
+        fclose($resource);
+
+        $this->assertEquals($testFileContent, $bucket->getFileContent($testFileName));
+    }
 }