Merge pull request #17 from Azure-OSS/use-actual-public-urls

use actual public urls

Author: brecht-vermeersch

README.md

@@ -21,22 +21,42 @@
 composer require azure-oss/storage-blob-flysystem
 ```
 
-## Quickstart
+## Usage
 
 ```php
 use AzureOss\FlysystemAzureBlobStorage\AzureBlobStorageAdapter;
 use AzureOss\Storage\Blob\BlobServiceClient;
 use League\Flysystem\Filesystem;
 
-$blobServiceClient = BlobServiceClient::fromConnectionString('<connection-string>');
-$containerClient = $blobServiceClient->getContainerClient('quickstart');
+// Create a BlobContainerClient
+$containerClient = BlobServiceClient::fromConnectionString($connectionString)
+    ->getContainerClient('your-container-name');
 
-$adapter = new AzureBlobStorageAdapter($containerClient, "optional/prefix");
+// Create the adapter
+$adapter = new AzureBlobStorageAdapter(
+    $containerClient,
+    'optional-prefix',
+    useDirectPublicUrl: false, // Set to true to use direct public URLs instead of SAS tokens
+);
+
+// Create the filesystem
 $filesystem = new Filesystem($adapter);
+```
+
+### Public URLs
 
-$filesystem->write('hello', 'world!');
+By default, the adapter generates public URLs using SAS tokens with a 1000-year expiration. If you prefer to use direct public URLs without SAS tokens, you can set the `useDirectPublicUrl` parameter to `true`:
+
+```php
+$adapter = new AzureBlobStorageAdapter(
+    $containerClient,
+    'optional-prefix',
+    useDirectPublicUrl: true,
+);
 ```
 
+Note that for direct public URLs to work, your container must be configured with public access. If your container is private, you should use the default SAS token approach.
+
 ## Documentation
 
 For more information visit the documentation at [azure-oss.github.io](https://azure-oss.github.io/storage/flysystem/).

src/AzureBlobStorageAdapter.php

@@ -46,6 +46,7 @@ public function __construct(
         string $prefix = "",
         ?MimeTypeDetector $mimeTypeDetector = null,
         private readonly string $visibilityHandling = self::ON_VISIBILITY_THROW_ERROR,
+        private readonly bool $useDirectPublicUrl = false,
     ) {
         $this->prefixer = new PathPrefixer($prefix);
         $this->mimeTypeDetector = $mimeTypeDetector ?? new FinfoMimeTypeDetector();
@@ -287,10 +288,16 @@ public function copy(string $source, string $destination, Config $config): void
     }
 
     /**
-     * @description Azure doesn't support permanent URLs. Instead, we create one that lasts 1000 years.
+     * @description If useDirectPublicUrl is true, returns the direct public URL.
+     * Otherwise, Azure doesn't support permanent URLs, so we create one that lasts 1000 years.
      */
     public function publicUrl(string $path, Config $config): string
     {
+        if ($this->useDirectPublicUrl) {
+            $blobClient = $this->containerClient->getBlobClient($this->prefixer->prefixPath($path));
+            return (string) $blobClient->uri;
+        }
+
         return $this->temporaryUrl($path, (new \DateTimeImmutable())->modify("+1000 years"), $config);
     }
 

tests/AzureBlobStorageTest.php

@@ -214,4 +214,45 @@ public function listing_contents_deep(): void
             $this->assertContains('dir1/dir2/dir3/file3.txt', $paths);
         });
     }
+
+    #[Test]
+    public function public_url_uses_direct_uri_when_enabled(): void
+    {
+        $this->givenWeHaveAnExistingFile('test-file.txt');
+
+        $adapter = new AzureBlobStorageAdapter(
+            self::createContainerClient(),
+            'flysystem',
+            useDirectPublicUrl: true,
+        );
+
+        $url = $adapter->publicUrl('test-file.txt', new Config());
+
+        // Direct URL should not contain SAS token parameters
+        $this->assertStringNotContainsString('sig=', $url);
+        $this->assertStringNotContainsString('se=', $url);
+        $this->assertStringNotContainsString('sp=', $url);
+
+        // But should contain the container and blob name
+        $this->assertStringContainsString('flysystem', $url);
+        $this->assertStringContainsString('test-file.txt', $url);
+    }
+
+    #[Test]
+    public function public_url_uses_sas_token_by_default(): void
+    {
+        $this->givenWeHaveAnExistingFile('test-file.txt');
+
+        $adapter = new AzureBlobStorageAdapter(
+            self::createContainerClient(),
+            'flysystem',
+        );
+
+        $url = $adapter->publicUrl('test-file.txt', new Config());
+
+        // URL with SAS token should contain these parameters
+        $this->assertStringContainsString('sig=', $url);
+        $this->assertStringContainsString('se=', $url);
+        $this->assertStringContainsString('sp=', $url);
+    }
 }