Initial commit

Author: wilr

.editorconfig

@@ -0,0 +1,21 @@
+# For more information about the properties used in
+# this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,js,json,css,scss,eslintrc,feature}]
+indent_size = 2
+indent_style = space
+
+[composer.json]
+indent_size = 4

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -0,0 +1,32 @@
+# Silverstripe Azure Blob Storage
+
+Silverstripe module to store assets in Azure Blob Storage rather than on the
+local filesystem. This leverages Flysystem in Silverstripe 4.
+
+## Environment setup
+
+The module requires a few environment variables to be set
+
+* `AZURE_CONNECTION_URL`: The connection URL as from the dashboard
+* `AZURE_CONTAINER_NAME`: The name of the container to store assets in.
+
+## Installation
+
+```
+composer require fullscreeninteractive/silverstripe-azure-blob-storage
+```
+
+**Note:** This currently immediately replaces the built-in local asset store that comes with
+SilverStripe with one based on Azure. Any files that had previously been uploaded to an existing
+asset store will be unavailable (though they won't be lost - just run `composer remove
+fullscreeninteractive/silverstripe-azure-blob-storage` to remove the module and restore access).
+
+## Configuration
+
+Assets are classed as either 'public' or 'protected' by SilverStripe. Public assets can be
+freely downloaded, whereas protected assets (e.g. assets not yet published) shouldn't be
+directly accessed.
+
+The module supports this by streaming the contents of protected files down to the browser
+via the web server (as opposed to linking directly) by default. To ensure that
+protected assets can't be accessed, ensure you setup an appropriate policy.

_config/assetadmin.yml

@@ -0,0 +1,10 @@
+---
+Name: silverstripe-azure-assetadmin
+Only:
+  moduleexists: silverstripe/asset-admin
+---
+# Ensure we use links and not inline thumbnails for all assets
+SilverStripe\AssetAdmin\Model\ThumbnailGenerator:
+  thumbnail_links:
+    protected: url
+    public: url

_config/assets.yml

@@ -0,0 +1,54 @@
+---
+Name: silverstripe-azure-flysystem
+Only:
+  envvarset: AZURE_CONNECTION_URL
+After:
+  - '#assetsflysystem'
+---
+SilverStripe\Core\Injector\Injector:
+  League\Flysystem\Adapter\Local:
+    class: League\Flysystem\Adapter\Local
+    constructor:
+      root: '`TEMP_PATH`'
+  FullscreenInteractive\SilverStripe\AzureStorage\Adapter\PublicAdapter:
+    constructor:
+      connectionUrl: '`AZURE_CONNECTION_URL`'
+      containerName: '`AZURE_CONTAINER_NAME`'
+  League\Flysystem\Cached\Storage\Memory.public:
+    class: League\Flysystem\Cached\Storage\Memory
+  League\Flysystem\Cached\Storage\Adapter.public:
+    class: League\Flysystem\Cached\Storage\Adapter
+    constructor:
+      adapter: '%$League\Flysystem\Adapter\Local'
+      file: 'azuremetadata/public'
+      expire: 259200
+  SilverStripe\Assets\Flysystem\PublicAdapter:
+    class: FullscreenInteractive\SilverStripe\AzureStorage\Adapter\PublicCachedAdapter
+    constructor:
+      adapter: '%$FullscreenInteractive\SilverStripe\AzureStorage\Adapter\PublicAdapter'
+      cache: '%$League\Flysystem\Cached\Storage\Adapter.public'
+  FullscreenInteractive\SilverStripe\AzureStorage\Adapter\ProtectedAdapter:
+    constructor:
+      connectionUrl: '`AZURE_CONNECTION_URL`'
+      containerName: '`AZURE_CONTAINER_NAME`'
+  League\Flysystem\Cached\Storage\Adapter.protected:
+      class: League\Flysystem\Cached\Storage\Adapter
+      constructor:
+        adapter: '%$League\Flysystem\Adapter\Local'
+        file: 'azuremetadata/protected'
+        expire: 259200
+  SilverStripe\Assets\Flysystem\ProtectedAdapter:
+    class: FullscreenInteractive\SilverStripe\AzureStorage\Adapter\ProtectedCachedAdapter
+    constructor:
+      adapter: '%$FullscreenInteractive\SilverStripe\AzureStorage\Adapter\ProtectedAdapter'
+      cache: '%$League\Flysystem\Cached\Storage\Adapter.protected'
+---
+Name: silverstripe-azure-assetscore
+Only:
+  envvarset: AZURE_CONNECTION_URL
+After:
+  - '#assetscore'
+---
+SilverStripe\Core\Injector\Injector:
+  SilverStripe\Assets\Storage\AssetStore:
+    class: SilverStripe\Assets\Flysystem\FlysystemAssetStore

_config/tinymce.yml

@@ -0,0 +1,18 @@
+---
+After:
+  - '#corehtml'
+---
+SilverStripe\Core\Injector\Injector:
+  League\Flysystem\Filesystem.localpublic:
+    class: 'League\Flysystem\Filesystem'
+    constructor:
+      FilesystemAdapter: '%$FullscreenInteractive\SilverStripe\AzureStorage\Adapter\TinyMceAdapter'
+      FilesystemConfig:
+        visibility: public
+  LocalGeneratedAssetHandler:
+    class: 'SilverStripe\Assets\Flysystem\GeneratedAssets'
+    properties:
+      Filesystem: '%$League\Flysystem\Filesystem.localpublic'
+  SilverStripe\Forms\HTMLEditor\TinyMCECombinedGenerator:
+    properties:
+      AssetHandler: '%$LocalGeneratedAssetHandler'

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "fullscreeninteractive/silverstripe-azure-blob-storage",
+    "type": "silverstripe-vendormodule",
+    "description": "Adds Silverstripe Flysystem support for using the Azure Blob adapter",
+    "license": "BSD-3-Clause",
+    "keywords": [
+        "silverstripe",
+        "flysystem",
+        "azure"
+    ],
+    "authors": [
+        {
+            "name": "Will Rossiter",
+            "homepage": "https://www.fullscreen.io"
+        }
+    ],
+    "require": {
+        "silverstripe/framework": "^4",
+        "silverstripe/vendor-plugin": "^1.0",
+        "league/flysystem-azure-blob-storage": "^1.0",
+        "league/flysystem-cached-adapter": "^1.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "FullscreenInteractive\\SilverStripe\\AzureStorage\\": "src/"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

src/Adapter/ProtectedAdapter.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace FullscreenInteractive\SilverStripe\AzureStorage\Adapter;
+
+use Exception;
+use InvalidArgumentException;
+use League\Flysystem\AzureBlobStorage\AzureBlobStorageAdapter;
+use MicrosoftAzure\Storage\Blob\BlobRestProxy;
+use SilverStripe\Assets\Flysystem\ProtectedAdapter as SilverstripeProtectedAdapter;
+
+class ProtectedAdapter extends AzureBlobStorageAdapter implements SilverstripeProtectedAdapter
+{
+    /**
+     * Pre-signed request expiration time in seconds, or relative string
+     *
+     * @var int|string
+     */
+    protected $expiry = 300;
+
+    public function __construct($connectionUrl = '', $containerName = '')
+    {
+        if (!$connectionUrl) {
+            throw new InvalidArgumentException("AZURE_CONNECTION_URL environment variable not set");
+        }
+
+        if (!$containerName) {
+            throw new InvalidArgumentException("AZURE_CONTAINER_NAME environment variable not set");
+        }
+
+        $client = BlobRestProxy::createBlobService($connectionUrl);
+
+        parent::__construct($client, $containerName);
+    }
+
+    /**
+     * @return int|string
+     */
+    public function getExpiry()
+    {
+        return $this->expiry;
+    }
+
+    /**
+     * Set expiry. Supports either number of seconds (in int) or
+     * a literal relative string.
+     *
+     * @param int|string $expiry
+     * @return $this
+     */
+    public function setExpiry($expiry)
+    {
+        $this->expiry = $expiry;
+        return $this;
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return string
+     */
+    public function getProtectedUrl($path)
+    {
+        throw new Exception('Not implemented yet');
+    }
+
+    public function getVisibility($path)
+    {
+        // Save an API call
+        return [
+            'path' => $path,
+            'visibility' => self::VISIBILITY_PRIVATE
+        ];
+    }
+}

src/Adapter/ProtectedCachedAdapter.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace FullscreenInteractive\SilverStripe\AzureStorage\Adapter;
+
+use League\Flysystem\Cached\CachedAdapter;
+use SilverStripe\Assets\Flysystem\ProtectedAdapter;
+
+class ProtectedCachedAdapter extends CachedAdapter implements ProtectedAdapter
+{
+    public function getProtectedUrl($path)
+    {
+        return $this->getAdapter()->getProtectedUrl($path);
+    }
+}

src/Adapter/PublicAdapter.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace FullscreenInteractive\SilverStripe\AzureStorage\Adapter;
+
+use InvalidArgumentException;
+use League\Flysystem\AzureBlobStorage\AzureBlobStorageAdapter;
+use MicrosoftAzure\Storage\Blob\BlobRestProxy;
+use SilverStripe\Assets\Flysystem\PublicAdapter as SilverstripePublicAdapter;
+
+class PublicAdapter extends AzureBlobStorageAdapter implements SilverstripePublicAdapter
+{
+    public function __construct($connectionUrl = '', $containerName = '')
+    {
+        if (!$connectionUrl) {
+            throw new InvalidArgumentException("AZURE_CONNECTION_URL environment variable not set");
+        }
+
+        if (!$containerName) {
+            throw new InvalidArgumentException("AZURE_CONTAINER_NAME environment variable not set");
+        }
+
+        $client = BlobRestProxy::createBlobService($connectionUrl);
+
+        parent::__construct($client, $containerName);
+    }
+
+    /**
+     * @param string $path
+     *
+     * @return string
+     */
+    public function getPublicUrl($path)
+    {
+        if ($meta = $this->getMetadata($path)) {
+            return $meta['url'];
+        }
+
+        return '';
+    }
+}