Make Psr7 Stream optional

Author: maennchen

README.md

@@ -41,7 +41,7 @@ require 'vendor/autoload.php';
 
 // create a new zipstream object
 $zip = new ZipStream\ZipStream(
-    fileName: 'example.zip',
+    outputName: 'example.zip',
 
     // enable output of HTTP headers
     sendHttpHeaders: true,

composer.json

@@ -24,7 +24,6 @@
   "require": {
     "php-64bit": "^8.1",
     "ext-mbstring": "*",
-    "psr/http-message": "^1.0",
     "ext-zlib": "*"
   },
   "require-dev": {
@@ -36,6 +35,10 @@
     "friendsofphp/php-cs-fixer": "^3.13",
     "vimeo/psalm": "^5.0"
   },
+  "suggest": {
+    "psr/http-message": "^1.0",
+    "guzzlehttp/psr7": "^2.4"
+  },
   "scripts": {
     "format": "PHP_CS_FIXER_IGNORE_ENV=true php-cs-fixer fix",
     "test": "composer run test:unit && composer run test:formatted && composer run test:lint",

guides/Options.rst

@@ -12,7 +12,11 @@ Here is the full list of options available to you. You can also have a look at
 
     $zip = new ZipStream(
         // Define output stream
-        // (argument is eiter a resource or implementing StreamInterface)
+        // (argument is eiter a resource or implementing
+        // `Psr\Http\Message\StreamInterface`)
+        //
+        // Setup with `psr/http-message` & `guzzlehttp/psr7` dependencies
+        // required when using `Psr\Http\Message\StreamInterface`.
         outputStream: $filePointer,
 
         // Set the deflate level (default is 6; use -1 to disable it)

guides/index.rst

@@ -22,11 +22,20 @@ Installation
 
 Simply add a dependency on ``maennchen/zipstream-php`` to your project's
 ``composer.json`` file if you use Composer to manage the dependencies of your
-project. Use following command to add the package to your project's dependencies:
+project. Use following command to add the package to your project's
+dependencies:
 
 .. code-block:: sh
    composer require maennchen/zipstream-php
 
+If you want to use``addFileFromPsr7Stream```
+(``Psr\Http\Message\StreamInterface``) or use a stream instead of a
+``resource`` as ``outputStream``, the following dependencies must be installed
+as well:
+
+.. code-block:: sh
+   composer require psr/http-message guzzlehttp/psr7
+
 If ``composer install`` yields the following error, your installation is missing
 the `mbstring extension <https://www.php.net/manual/en/book.mbstring.php>`_,
 either `install it <https://www.php.net/manual/en/mbstring.installation.php>`_
@@ -54,7 +63,7 @@ Here's a simple example:
 
    // create a new zipstream object
    $zip = new ZipStream\ZipStream(
-      fileName: 'example.zip',
+      outputName: 'example.zip',
 
       // enable output of HTTP headers
       sendHttpHeaders: true,
@@ -83,9 +92,10 @@ Here's a simple example:
    fclose($filePointer);
 
    // add a file named 'streamfile.txt' from the body of a `guzzle` response
+   // Setup with `psr/http-message` & `guzzlehttp/psr7` dependencies required.
    $zip->addFileFromPsr7Stream(
-   fileName: 'streamfile.txt',
-   stream: $response->getBody(),
+      fileName: 'streamfile.txt',
+      stream: $response->getBody(),
    );
 
    // finish the zip stream

src/Exception/ResourceActionException.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ZipStream\Exception;
+
+use ZipStream\Exception;
+
+/**
+ * This Exception gets invoked if a resource like `fread` returns false
+ */
+class ResourceActionException extends Exception
+{
+    /**
+     * @var ?resource
+     */
+    private $resource;
+
+    /**
+     * @param resource $resource
+     */
+    public function __construct(
+        private readonly string $function,
+        $resource = null,
+    ) {
+        $this->resource = $resource;
+        parent::__construct('Function ' . $function . 'failed on resource.');
+    }
+}

src/File.php

@@ -7,9 +7,9 @@
 use Closure;
 use DateTimeInterface;
 use DeflateContext;
-use Psr\Http\Message\StreamInterface;
 use RuntimeException;
 use ZipStream\Exception\OverflowException;
+use ZipStream\Exception\ResourceActionException;
 use ZipStream\Exception\StreamNotReadableException;
 use ZipStream\Exception\StreamNotSeekableException;
 
@@ -34,6 +34,14 @@ class File
 
     private int $totalSize = 0;
 
+    /**
+     * @var resource
+     */
+    private $stream;
+
+    /**
+     * @param resource $stream
+     */
     public function __construct(
         string $fileName,
         private int $startOffset,
@@ -45,7 +53,7 @@ public function __construct(
         private readonly bool $enableZip64,
         private readonly bool $enableZeroHeader,
         private readonly Closure $send,
-        private readonly StreamInterface $stream,
+        $stream,
     ) {
         $this->fileName = self::filterFilename($fileName);
         $this->checkEncoding();
@@ -56,12 +64,19 @@ public function __construct(
 
         $this->selectVersion();
 
-        if (!$this->enableZeroHeader && !$stream->isSeekable()) {
+        if (!$this->enableZeroHeader && !stream_get_meta_data($stream)['seekable']) {
             throw new StreamNotSeekableException();
         }
-        if (!$stream->isReadable()) {
+        if (!(
+            str_contains(stream_get_meta_data($stream)['mode'], 'r')
+            || str_contains(stream_get_meta_data($stream)['mode'], 'w+')
+            || str_contains(stream_get_meta_data($stream)['mode'], 'a+')
+            || str_contains(stream_get_meta_data($stream)['mode'], 'x+')
+            || str_contains(stream_get_meta_data($stream)['mode'], 'c+')
+        )) {
             throw new StreamNotReadableException();
         }
+        $this->stream = $stream;
     }
 
     /**
@@ -121,7 +136,9 @@ public function process(): string
     {
         if (!$this->enableZeroHeader) {
             $this->readStream(send: false);
-            $this->stream->rewind();
+            if (rewind($this->stream) === false) {
+                throw new ResourceActionException('rewind', $this->stream);
+            }
         }
 
         $this->addFileHeader();
@@ -234,10 +251,10 @@ private function readStream(bool $send): void
 
         $deflate = $this->compressionInit();
 
-        while (!$this->stream->eof() && ($this->maxSize === null || $this->uncompressedSize < $this->maxSize)) {
+        while (!feof($this->stream) && ($this->maxSize === null || $this->uncompressedSize < $this->maxSize)) {
             $readLength = min(($this->maxSize ?? PHP_INT_MAX) - $this->uncompressedSize, self::CHUNKED_READ_BLOCK_SIZE);
 
-            $data = $this->stream->read($readLength);
+            $data = fread($this->stream, $readLength);
 
             hash_update($hash, $data);
 
@@ -248,9 +265,7 @@ private function readStream(bool $send): void
                 $data =  deflate_add(
                     $deflate,
                     $data,
-                    $this->stream->eof()
-                        ? ZLIB_FINISH
-                        : ZLIB_NO_FLUSH
+                    feof($this->stream) ? ZLIB_FINISH : ZLIB_NO_FLUSH
                 );
             }