Merge pull request #4 from Slamdunk/optional_compression

Split Compression from Encryption to allow encryption-only

Author: Slamdunk

README.md

@@ -21,19 +21,20 @@ $ composer require slam/flysystem-compress-and-encrypt-proxy
 
 ```php
 
-use SlamCompressAndEncryptProxy\CompressAndEncryptAdapter;
+use SlamCompressAndEncryptProxy\CompressAdapter;
+use SlamCompressAndEncryptProxy\EncryptAdapter;
 use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
 
 // Create a strong key and save it somewhere
-$key = EncryptedZipProxyAdapter::generateKey();
+$key = EncryptAdapter::generateKey();
 
 // Create the final FilesystemAdapter, for example Aws S3
 $remoteAdapter = new AwsS3V3Adapter(/* ... */);
 
-$adapter = new CompressAndEncryptAdapter(
+$adapter = new CompressAdapter(new EncryptAdapter(
     $remoteAdapter,
     $key
-);
+));
 
 // The FilesystemOperator
 $filesystem = new \League\Flysystem\Filesystem($adapter);
@@ -63,16 +64,25 @@ space required.
 
 GZip's `zlib.deflate` and `zlib.inflate` compression filters are used.
 
+You can opt-out compression by using just the `EncryptAdapter`.
+
 ## Encryption
 
 [Sodium](https://www.php.net/manual/en/book.sodium.php) extension provides the backend for the
 encrypted stream with [`XChaCha20-Poly1305`](https://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-init-push.php) algorithm.
 
-## MIME types detection caveat
+## Caveats
+
+### MIME types detection
 
 Some Flysystem adapters like the Local one try to guess the file mime type by
 its nature (content or extension): in such cases it will fail due to the custom
 extention and the encrypted content.
 Other adapters like the Aws S3 one allow you to specify it manually (for ex.
 with the `ContentType` key in the Config): it is a good idea to always manually
 inject it, if you like the `Filesystem::mimeType($path)` call to be reliable.
+
+### File size
+
+The file size returned relates to the compressed and encrypted file, not the
+original one.

infection.json.dist

@@ -15,7 +15,7 @@
         "@default": true,
         "global-ignoreSourceCodeByRegex": [
             "\\\\assert\\(.+\\);",
-            "\\$consumed .= .+;"
+            "\\$consumed ..?= .+;"
         ],
         "FunctionCallRemoval": {
             "ignoreSourceCodeByRegex": [

src/AbstractProxyAdapter.php

@@ -0,0 +1,173 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlamCompressAndEncryptProxy;
+
+use League\Flysystem\Config;
+use League\Flysystem\FileAttributes;
+use League\Flysystem\FilesystemAdapter;
+
+/**
+ * @internal
+ */
+abstract class AbstractProxyAdapter implements FilesystemAdapter
+{
+    public function __construct(
+        private FilesystemAdapter $remoteAdapter
+    ) {
+    }
+
+    abstract public static function getRemoteFileExtension(): string;
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function fileExists(string $path): bool
+    {
+        return $this->remoteAdapter->fileExists($this->getRemotePath($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function write(string $path, string $contents, Config $config): void
+    {
+        $stream = fopen('php://temp', 'w+');
+        fwrite($stream, $contents);
+        rewind($stream);
+
+        $this->writeStream($path, $stream, $config);
+
+        fclose($stream);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function read(string $path): string
+    {
+        return stream_get_contents($this->readStream($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function delete(string $path): void
+    {
+        $this->remoteAdapter->delete($this->getRemotePath($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function deleteDirectory(string $path): void
+    {
+        $this->remoteAdapter->deleteDirectory($path);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function createDirectory(string $path, Config $config): void
+    {
+        $this->remoteAdapter->createDirectory($path, $config);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function setVisibility(string $path, string $visibility): void
+    {
+        $this->remoteAdapter->setVisibility($this->getRemotePath($path), $visibility);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function visibility(string $path): FileAttributes
+    {
+        return $this->remoteAdapter->visibility($this->getRemotePath($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function mimeType(string $path): FileAttributes
+    {
+        return $this->remoteAdapter->mimeType($this->getRemotePath($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function lastModified(string $path): FileAttributes
+    {
+        return $this->remoteAdapter->lastModified($this->getRemotePath($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function fileSize(string $path): FileAttributes
+    {
+        return $this->remoteAdapter->fileSize($this->getRemotePath($path));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function listContents(string $path, bool $deep): iterable
+    {
+        $remoteList = $this->remoteAdapter->listContents($path, $deep);
+
+        foreach ($remoteList as $content) {
+            if ($content instanceof FileAttributes) {
+                $content = new FileAttributes(
+                    substr($content->path(), 0, -\strlen(static::getRemoteFileExtension())),
+                    $content->fileSize(),
+                    $content->visibility(),
+                    $content->lastModified(),
+                    $content->mimeType(),
+                    $content->extraMetadata()
+                );
+            }
+
+            yield $content;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function move(string $source, string $destination, Config $config): void
+    {
+        $this->remoteAdapter->move(
+            $this->getRemotePath($source),
+            $this->getRemotePath($destination),
+            $config
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    final public function copy(string $source, string $destination, Config $config): void
+    {
+        $this->remoteAdapter->copy(
+            $this->getRemotePath($source),
+            $this->getRemotePath($destination),
+            $config
+        );
+    }
+
+    final protected function getRemoteAdapter(): FilesystemAdapter
+    {
+        return $this->remoteAdapter;
+    }
+
+    final protected function getRemotePath(string $path): string
+    {
+        return $path.static::getRemoteFileExtension();
+    }
+}

src/CompressAdapter.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlamCompressAndEncryptProxy;
+
+use League\Flysystem\Config;
+
+final class CompressAdapter extends AbstractProxyAdapter
+{
+    public static function getRemoteFileExtension(): string
+    {
+        return '.gz';
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function writeStream(string $path, $contents, Config $config): void
+    {
+        $zlibFilter = stream_filter_append($contents, 'zlib.deflate');
+        \assert(false !== $zlibFilter);
+
+        $this->getRemoteAdapter()->writeStream($this->getRemotePath($path), $contents, $config);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function readStream(string $path)
+    {
+        $contents = $this->getRemoteAdapter()->readStream($this->getRemotePath($path));
+
+        $zlibFilter = stream_filter_append($contents, 'zlib.inflate');
+        \assert(false !== $zlibFilter);
+
+        return $contents;
+    }
+}