Public Path Prefix

Author: daniel-centore

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## \[v3.3.0\] - 2024-08-24
+
+- Add ability to override public path with a prefix, for the purposes of using a CDN
+
 ## \[v3.2.1\] - 2024-06-13
 
 - Add missing use statement in AzureFactory (#49)

config/module.ini

@@ -5,7 +5,7 @@ tags         = "amazon s3 aws, wasabi, azure, digital ocean, dropbox, google, sc
 author       = "Jared Howland, Jon Fackrell, & Julian Maurice"
 author_link  = "https://www.jaredhowland.com"
 ; Version is automatically updated using GitHub action `release.yml` in case you forget before releasing
-version      = "3.2.1"
+version      = "3.3.0"
 configurable = true
 module_link  = "https://github.com/HBLL-Collection-Development/omeka-s-any-cloud"
 support_link = "https://github.com/HBLL-Collection-Development/omeka-s-any-cloud/issues"

src/Form/ConfigForm.php

@@ -144,6 +144,17 @@ private function addS3($id, $name, $label = null): void
                 'id' => $id.'_endpoint',
             ],
         ]);
+        $awsFieldset->add([
+            'name'    => $id.'_public_path_prefix',
+            'type'    => Element\Text::class,
+            'options' => [
+                'label' => $label.'Public Path Prefix',
+                'info'  => 'Overrides the default public path generation with a custom prefix. Can usually leave blank unless you are using a CDN.',
+            ],
+            'attributes' => [
+                'id' => $id.'_public_path_prefix',
+            ],
+        ]);
     }
 
     /**

src/Service/File/Adapter/AwsS3V3/AwsS3V3AdapterWrapper.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace AnyCloud\Service\File\Adapter\AwsS3V3;
+
+use Aws\S3\S3ClientInterface;
+use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
+use League\Flysystem\Config;
+use League\Flysystem\PathPrefixer;
+
+class AwsS3V3AdapterWrapper extends AwsS3V3Adapter
+{
+    private ?PathPrefixer $prefixer;
+
+    public function __construct(
+        private S3ClientInterface $client,
+        private array $config,
+    ) {
+        parent::__construct($client, $config['bucket']);
+
+        $pathPrefix = $this->config['public_path_prefix'];
+        if ($pathPrefix) {
+            $this->prefixer = new PathPrefixer($pathPrefix, '/');
+        } else {
+            $this->prefixer = null;
+        }
+    }
+
+    public function publicUrl(string $path, Config $cnf): string
+    {
+        if ($this->prefixer) {
+            return $this->prefixer->prefixPath($path);
+        }
+        return parent::publicUrl($path, $cnf);
+    }
+}

src/Service/File/Store/AbstractAwsS3V3Factory.php

@@ -2,8 +2,8 @@
 
 namespace AnyCloud\Service\File\Store;
 
+use AnyCloud\Service\File\Adapter\AwsS3V3\AwsS3V3AdapterWrapper;
 use Aws\S3\S3Client;
-use League\Flysystem\AwsS3V3\AwsS3V3Adapter;
 use League\Flysystem\FilesystemAdapter;
 
 abstract class AbstractAwsS3V3Factory extends AbstractFlysystemFactory
@@ -20,7 +20,7 @@ protected function getFilesystemAdapter(array $config): FilesystemAdapter
             'version'  => 'latest',
         ];
         $client = new S3Client($options);
-        $adapter = new AwsS3V3Adapter($client, $config['bucket']);
+        $adapter = new AwsS3V3AdapterWrapper($client, $config);
 
         return $adapter;
     }