Expose gzipped file contents (#4)

* Fetch stream from S3 and local inputs

* Expose compressed contents as string instead of resource stream

Co-authored-by: Fayez Naccache <[email protected]>

Author: GromNaN

Diff for: composer.json

@@ -22,10 +22,12 @@
     },
     "require": {
         "php": ">=7.4",
+        "ext-zlib": "*",
         "async-aws/s3": "^1.5",
         "psr/log": "^1.1|^2.0|^3.0"
     },
     "require-dev": {
+        "ext-zip": "*",
         "symfony/phpunit-bridge": "^5.4|^6.0"
     }
 }

Diff for: src/Archive.php

@@ -1,14 +1,17 @@
 <?php
 
-
 namespace GromNaN\S3Zip;
 
 use GromNaN\S3Zip\Input\InputInterface;
 
 class Archive
 {
     private InputInterface $input;
+
+    /** @var array<int, File> */
     private array $filesByIndex;
+
+    /** @var array<string, File> */
     private array $filesByName;
 
     public function __construct(InputInterface $input)
@@ -76,11 +79,17 @@ private function initCentralDirectory()
         }
     }
 
+    /**
+     * @return string[]
+     */
     public function getFileNames(): array
     {
         return array_keys($this->filesByName);
     }
 
+    /**
+     * @return array<int, File>
+     */
     public function getFiles(): array
     {
         return $this->filesByIndex;

Diff for: src/File.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip;
 
 use GromNaN\S3Zip\Input\InputInterface;
@@ -14,6 +13,9 @@ class File
     private int $length;
     private array $options;
 
+    /**
+     * @internal
+     */
     public function __construct(InputInterface $input, array $options)
     {
         $this->input = $input;
@@ -33,14 +35,26 @@ public function getIndex(): int
         return $this->options['index'];
     }
 
+    /**
+     * Reads and extract file contents
+     */
     public function getContents($length = 0): string
+    {
+        return gzinflate($this->fetch(), $length);
+    }
+
+    /**
+     * Reads compressed file contents.
+     * Binary result can be sent as gzipped HTTP response.
+     */
+    public function fetch(): string
     {
         $chunk = $this->input->fetch($this->offset, $this->length, 'reading file '.$this->name);
 
         $headerSize = 30
             +unpack('v', $chunk, 26)[1]
             +unpack('v', $chunk, 28)[1];
 
-        return gzinflate(substr($chunk, $headerSize), $length);
+        return substr($chunk, $headerSize);
     }
 }

Diff for: src/Input/HttpInput.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Input;
 
 use AsyncAws\S3\S3Client;

Diff for: src/Input/InputInterface.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Input;
 
 interface InputInterface

Diff for: src/Input/LocalInput.php

@@ -1,18 +1,21 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Input;
 
 class LocalInput implements InputInterface
 {
     private string $filename;
+
+    /**
+     * @var resource
+     */
     private $handle;
 
     public function __construct(string $filename)
     {
         $this->filename = $filename;
-        $handle = fopen($filename, 'r');
-        if (false === $filename) {
+        $handle = fopen($filename, 'rb');
+        if (false === $handle) {
             throw new \RuntimeException('File not found: '.$filename);
         }
         $this->handle = $handle;

Diff for: src/Input/S3Input.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Input;
 
 use AsyncAws\S3\S3Client;

Diff for: tests/Integration/ArchiveTest.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Tests\Integration;
 
 use GromNaN\S3Zip\Archive;
@@ -34,6 +33,10 @@ public function testArchive()
 
         $this->assertInstanceOf(File::class, $files[0]);
         $this->assertSame($files[5], $archive->getFile($files[5]->getName()));
+
+        $contents = $files[3]->getContents();
+        $compressedContents = $files[3]->fetch();
+        $this->assertSame($contents, gzinflate($compressedContents));
     }
 
     /**

Diff for: tests/Integration/LocalArchiveTest.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Tests\Integration;
 
 use GromNaN\S3Zip\Input\InputInterface;

Diff for: tests/Integration/S3ArchiveTest.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace GromNaN\S3Zip\Tests\Integration;
 
 use AsyncAws\S3\S3Client;