feat: add new streamwrapper to access private bucket

Author: carlalexander

grumphp.yml

@@ -33,7 +33,7 @@ grumphp:
         - 'pluggable.php'
         - 'src/Autoloader.php'
         - 'src/Configuration'
-        - 'src/CloudStorage/CloudStorageStreamWrapper.php'
+        - 'src/CloudStorage/AbstractCloudStorageStreamWrapper.php'
         - 'src/Email/Email.php'
         - 'src/ObjectCache/AbstractPersistentObjectCache.php'
         - 'src/Subscriber/ContentDeliveryNetworkPageCachingSubscriber.php'

src/Attachment/ImagickImageEditor.php

@@ -69,7 +69,7 @@ public function save($destfilename = null, $mime_type = null)
      */
     protected function _save($image, $filename = null, $mime_type = null)
     {
-        // Imagick by default can't handle cloudstorage:// paths so have it save the file locally.
+        // Imagick by default can't handle ymir-public:// paths so have it save the file locally.
         if (is_string($filename) && $this->fileManager->isInUploadsDirectory($filename)) {
             $filename = $this->fileManager->getTempFilePath($filename);
         }

…oudStorage/CloudStorageStreamWrapper.php …ge/AbstractCloudStorageStreamWrapper.phpsrc/CloudStorage/CloudStorageStreamWrapper.php renamed to src/CloudStorage/AbstractCloudStorageStreamWrapper.php src/CloudStorage/CloudStorageStreamWrapper.php renamed to src/CloudStorage/AbstractCloudStorageStreamWrapper.php

@@ -18,15 +18,8 @@
  *
  * @see https://www.php.net/manual/en/class.streamwrapper.php
  */
-class CloudStorageStreamWrapper
+abstract class AbstractCloudStorageStreamWrapper
 {
-    /**
-     * Name of the protocol used by the wrapper.
-     *
-     * @var string
-     */
-    public const PROTOCOL = 'cloudstorage';
-
     /**
      * The resource handled by the stream which is set by PHP.
      *
@@ -39,69 +32,77 @@ class CloudStorageStreamWrapper
      *
      * @var \ArrayObject|null
      */
-    private $cache;
+    protected $cache;
 
     /**
      * The cloud storage objects retrieved with "dir_opendir".
      *
      * @var \ArrayIterator|null
      */
-    private $openedDirectoryObjects;
+    protected $openedDirectoryObjects;
 
     /**
      * The path when "dir_opendir" was called.
      *
      * @var string|null
      */
-    private $openedDirectoryPath;
+    protected $openedDirectoryPath;
 
     /**
      * The prefix used to get the cloud storage objects with "dir_opendir".
      *
      * @var string|null
      */
-    private $openedDirectoryPrefix;
+    protected $openedDirectoryPrefix;
 
     /**
      * Mode used when the stream was opened.
      *
      * @var string
      */
-    private $openedStreamMode;
+    protected $openedStreamMode;
 
     /**
      * The key for the cloud storage object opened by "stream_open".
      *
      * @var string
      */
-    private $openedStreamObjectKey;
+    protected $openedStreamObjectKey;
 
     /**
      * The resource containing the cloud storage object opened by "stream_open".
      *
      * @var resource|null
      */
-    private $openedStreamObjectResource;
+    protected $openedStreamObjectResource;
+
+    /**
+     * Get the protocol used by the stream wrapper.
+     */
+    public static function getProtocol(): string
+    {
+        throw new \RuntimeException('Must overrider "getProtocol" method');
+    }
 
     /**
      * Register the cloud storage stream wrapper.
      */
     public static function register(CloudStorageClientInterface $client, \ArrayObject $cache = null)
     {
-        if (in_array(self::PROTOCOL, stream_get_wrappers())) {
-            stream_wrapper_unregister(self::PROTOCOL);
+        if (in_array(static::getProtocol(), stream_get_wrappers())) {
+            stream_wrapper_unregister(static::getProtocol());
         }
 
-        stream_wrapper_register(self::PROTOCOL, self::class, STREAM_IS_URL);
+        stream_wrapper_register(static::getProtocol(), static::class, STREAM_IS_URL);
 
         $defaultOptions = stream_context_get_options(stream_context_get_default());
 
-        $defaultOptions[self::PROTOCOL]['client'] = $client;
+        $defaultOptions[static::getProtocol()]['client'] = $client;
 
         if ($cache instanceof \ArrayObject) {
-            $defaultOptions[self::PROTOCOL]['cache'] = $cache;
-        } elseif (!isset($defaultOptions[self::PROTOCOL]['cache'])) {
-            $defaultOptions[self::PROTOCOL]['cache'] = new \ArrayObject();
+            $defaultOptions[static::getProtocol()]['cache'] = $cache;
+        } elseif (!isset($defaultOptions[static::getProtocol()]['cache'])) {
+            $defaultOptions[static::getProtocol()]['cache'] = new \ArrayObject();
         }
 
         stream_context_set_default($defaultOptions);
@@ -312,7 +313,7 @@ public function stream_flush()
 
             $this->getClient()->putObject($this->openedStreamObjectKey, stream_get_contents($this->openedStreamObjectResource), $this->getMimetype());
 
-            $this->removeCacheValue(self::PROTOCOL.'://'.$this->openedStreamObjectKey);
+            $this->removeCacheValue(static::getProtocol().'://'.$this->openedStreamObjectKey);
         });
     }
 
@@ -356,7 +357,7 @@ public function stream_open(string $path, string $mode): bool
                 // Remove the cache value in case we interacted with the file before using something
                 // like "file_exists". If we don't write to the file, there won't be any cache busting
                 // so this is the only opportunity to do so.
-                $this->removeCacheValue(self::PROTOCOL.'://'.$this->openedStreamObjectKey);
+                $this->removeCacheValue(static::getProtocol().'://'.$this->openedStreamObjectKey);
             }
 
             $this->openedStreamObjectResource = fopen('php://temp', 'r+');
@@ -649,8 +650,8 @@ private function getOptions(): array
             $context = stream_context_get_options($this->context);
         }
 
-        $context = $context[self::PROTOCOL] ?? [];
-        $default = $default[self::PROTOCOL] ?? [];
+        $context = $context[static::getProtocol()] ?? [];
+        $default = $default[static::getProtocol()] ?? [];
 
         return $context + $default;
     }
@@ -737,7 +738,7 @@ private function parseMode(string $key, string $mode): string
      */
     private function parsePath(string $path): string
     {
-        $protocol = self::PROTOCOL.'://';
+        $protocol = static::getProtocol().'://';
 
         if (0 !== strpos($path, $protocol)) {
             throw new \InvalidArgumentException(sprintf('Invalid protocol for "%s"', $path));

src/CloudStorage/PrivateCloudStorageStreamWrapper.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir WordPress plugin.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Plugin\CloudStorage;
+
+class PrivateCloudStorageStreamWrapper extends AbstractCloudStorageStreamWrapper
+{
+    /**
+     * {@inheritdoc}
+     */
+    public static function getProtocol(): string
+    {
+        return 'ymir-private';
+    }
+}

src/CloudStorage/PublicCloudStorageStreamWrapper.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Ymir WordPress plugin.
+ *
+ * (c) Carl Alexander <support@ymirapp.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Ymir\Plugin\CloudStorage;
+
+class PublicCloudStorageStreamWrapper extends AbstractCloudStorageStreamWrapper
+{
+    /**
+     * {@inheritdoc}
+     */
+    public static function getProtocol(): string
+    {
+        return 'ymir-public';
+    }
+}

src/Configuration/CloudProviderConfiguration.php

@@ -46,8 +46,11 @@ public function modify(Container $container)
         $container['cloud_provider_secret'] = $container->service(function () {
             return getenv('AWS_SECRET_ACCESS_KEY') ?: (defined('YMIR_CLOUD_PROVIDER_SECRET') ? YMIR_CLOUD_PROVIDER_SECRET : '');
         });
-        $container['cloud_provider_store'] = $container->service(function () {
-            return getenv('YMIR_PUBLIC_STORE') ?: (defined('YMIR_CLOUD_PROVIDER_STORE') ? YMIR_CLOUD_PROVIDER_STORE : '');
+        $container['cloud_provider_private_store'] = $container->service(function () {
+            return getenv('YMIR_PRIVATE_STORE') ?: (defined('YMIR_CLOUD_PROVIDER_PRIVATE_STORE') ? YMIR_CLOUD_PROVIDER_PRIVATE_STORE : '');
+        });
+        $container['cloud_provider_public_store'] = $container->service(function () {
+            return getenv('YMIR_PUBLIC_STORE') ?: (defined('YMIR_CLOUD_PROVIDER_PUBLIC_STORE') ? YMIR_CLOUD_PROVIDER_PUBLIC_STORE : '');
         });
     }
 }

src/Configuration/CloudStorageConfiguration.php

@@ -14,7 +14,8 @@
 namespace Ymir\Plugin\Configuration;
 
 use Ymir\Plugin\CloudProvider\Aws\S3Client;
-use Ymir\Plugin\CloudStorage\CloudStorageStreamWrapper;
+use Ymir\Plugin\CloudStorage\PrivateCloudStorageStreamWrapper;
+use Ymir\Plugin\CloudStorage\PublicCloudStorageStreamWrapper;
 use Ymir\Plugin\DependencyInjection\Container;
 use Ymir\Plugin\DependencyInjection\ContainerConfigurationInterface;
 
@@ -28,9 +29,13 @@ class CloudStorageConfiguration implements ContainerConfigurationInterface
      */
     public function modify(Container $container)
     {
-        $container['cloud_storage_client'] = $container->service(function (Container $container) {
-            return new S3Client($container['ymir_http_client'], $container['cloud_provider_store'], $container['cloud_provider_key'], $container['cloud_provider_region'], $container['cloud_provider_secret']);
+        $container['private_cloud_storage_client'] = $container->service(function (Container $container) {
+            return new S3Client($container['ymir_http_client'], $container['cloud_provider_private_store'], $container['cloud_provider_key'], $container['cloud_provider_region'], $container['cloud_provider_secret']);
         });
-        $container['cloud_storage_protocol'] = CloudStorageStreamWrapper::PROTOCOL.'://';
+        $container['private_cloud_storage_protocol'] = PrivateCloudStorageStreamWrapper::getProtocol().'://';
+        $container['public_cloud_storage_client'] = $container->service(function (Container $container) {
+            return new S3Client($container['ymir_http_client'], $container['cloud_provider_public_store'], $container['cloud_provider_key'], $container['cloud_provider_region'], $container['cloud_provider_secret']);
+        });
+        $container['public_cloud_storage_protocol'] = PublicCloudStorageStreamWrapper::getProtocol().'://';
     }
 }

src/Configuration/EventManagementConfiguration.php

@@ -37,7 +37,7 @@ public function modify(Container $container)
         $container['priority_subscribers'] = $container->service(function (Container $container) {
             return [
                 new Subscriber\BedrockSubscriber($container['ymir_project_type']),
-                new Subscriber\UploadsSubscriber($container['content_directory'], $container['content_url'], $container['cloud_storage_protocol'], $container['upload_url'], $container['upload_limit']),
+                new Subscriber\UploadsSubscriber($container['content_directory'], $container['content_url'], $container['public_cloud_storage_protocol'], $container['upload_url'], $container['upload_limit']),
             ];
         });
 

src/Configuration/RestApiConfiguration.php

@@ -30,8 +30,8 @@ public function modify(Container $container)
         $container['rest_namespace'] = 'ymir/v1';
         $container['rest_endpoints'] = $container->service(function (Container $container) {
             return [
-                new RestApi\CreateAttachmentEndpoint($container['cloud_storage_client'], $container['console_client'], $container['uploads_basedir'], $container['uploads_baseurl'], $container['force_async_attachment_creation']),
-                new RestApi\GetFileDetailsEndpoint($container['cloud_storage_client'], $container['uploads_path'], $container['uploads_subdir']),
+                new RestApi\CreateAttachmentEndpoint($container['public_cloud_storage_client'], $container['console_client'], $container['uploads_basedir'], $container['uploads_baseurl'], $container['force_async_attachment_creation']),
+                new RestApi\GetFileDetailsEndpoint($container['public_cloud_storage_client'], $container['uploads_path'], $container['uploads_subdir']),
             ];
         });
     }

src/Plugin.php

@@ -13,7 +13,8 @@
 
 namespace Ymir\Plugin;
 
-use Ymir\Plugin\CloudStorage\CloudStorageStreamWrapper;
+use Ymir\Plugin\CloudStorage\PrivateCloudStorageStreamWrapper;
+use Ymir\Plugin\CloudStorage\PublicCloudStorageStreamWrapper;
 use Ymir\Plugin\Console\CommandInterface;
 use Ymir\Plugin\DependencyInjection\Container;
 
@@ -125,7 +126,8 @@ public function load()
         $this->container['plugin_dir_url'] = plugin_dir_url($this->filePath);
         $this->container['plugin_relative_path'] = '/'.trim(str_replace($this->container['root_directory'], '', plugin_dir_path($this->filePath)), '/');
 
-        CloudStorageStreamWrapper::register($this->container['cloud_storage_client']);
+        PrivateCloudStorageStreamWrapper::register($this->container['private_cloud_storage_client']);
+        PublicCloudStorageStreamWrapper::register($this->container['public_cloud_storage_client']);
 
         foreach ($this->container['local_commands'] as $command) {
             $this->registerCommand($command);