Merge branch 'develop'

DerSpiegel · Feb 27, 2024 · a8ae4d7 · a8ae4d7
2 parents 589bf75 + cc5cd98
commit a8ae4d7
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## 6.2.0 - 2024-02-27
+
+Add AssetsUtils::replaceInvalidFilenameCharacters().
+
+Improve error logging in CreateRequest, UpdateRequest.
+
 ## 6.1.0 - 2024-02-26
 
 Fix CreateRequest::$parseMetadataModifications and CreateRequest::$metadataToReturn parameters being ignored. Add 

diff --git a/src/AssetsUtils.php b/src/AssetsUtils.php
@@ -134,6 +134,22 @@ public static function escapeForElasticsearch(string $queryTerm): string
     }
 
 
+    /**
+     * Invalid file name characters in Assets Server
+     * @see https://helpcenter.woodwing.com/hc/en-us/articles/360042269611-Invalid-file-name-characters-in-Assets-Server
+     */
+    public static function getInvalidFilenameCharacters(): array
+    {
+        return ['\\', '/', ':', '*', '?', '"', '<', '>', '|', '#', ';'];
+    }
+
+
+    public static function replaceInvalidFilenameCharacters(string $subject, string $replace): string
+    {
+        return str_replace(self::getInvalidFilenameCharacters(), $replace, $subject);
+    }
+
+
     /**
      * Get a Twig template for building an Assets query
      *

diff --git a/src/Service/CreateRequest.php b/src/Service/CreateRequest.php
@@ -15,11 +15,11 @@
 class CreateRequest extends CreateRequestBase
 {
     public function __construct(
-        AssetsClient $assetsClient,
-        mixed $filedata = null,
-        array $metadata = [],
-        array $metadataToReturn = ['all'],
-        bool $parseMetadataModification = false,
+        AssetsClient  $assetsClient,
+        mixed         $filedata = null,
+        array         $metadata = [],
+        array         $metadataToReturn = ['all'],
+        bool          $parseMetadataModification = false,
         readonly bool $autoRename = false
     )
     {
@@ -48,7 +48,18 @@ public function __invoke(): AssetResponse
         try {
             $response = $this->assetsClient->serviceRequest('create', $requestData);
         } catch (Exception $e) {
-            throw new AssetsException(sprintf('%s: Create failed: %s', __METHOD__, $e->getMessage()), $e->getCode(), $e);
+            $logData = array_filter($requestData, fn($key) => ($key !== 'Filedata'), ARRAY_FILTER_USE_KEY);
+
+            throw new AssetsException(
+                sprintf(
+                    '%s: Create failed - <%s> - <%s>',
+                    __METHOD__,
+                    $e->getMessage(),
+                    json_encode($logData)
+                ),
+                $e->getCode(),
+                $e
+            );
         }
 
         $assetResponse = AssetResponse::createFromJson($response);

diff --git a/src/Service/UpdateRequest.php b/src/Service/UpdateRequest.php
@@ -51,13 +51,15 @@ public function __invoke(): void
         try {
             $this->assetsClient->serviceRequest('update', $requestData);
         } catch (Exception $e) {
+            $logData = array_filter($requestData, fn($key) => ($key !== 'Filedata'), ARRAY_FILTER_USE_KEY);
+
             throw new AssetsException(
                 sprintf(
                     '%s: Update failed for asset <%s> - <%s> - <%s>',
                     __METHOD__,
                     $this->id->id,
                     $e->getMessage(),
-                    json_encode($requestData)
+                    json_encode($logData)
                 ),
                 $e->getCode(),
                 $e

diff --git a/tests/Unit/AssetsUtilsTest.php b/tests/Unit/AssetsUtilsTest.php
@@ -39,6 +39,17 @@ public static function elasticsearchEscapeProvider(): array
     }
 
 
+    public function testReplaceInvalidFilenameCharacters(): void
+    {
+        $invalidCharacters = AssetsUtils::getInvalidFilenameCharacters();
+        $input = 'test' . implode('', $invalidCharacters);
+        $replace = '-';
+        $expected = 'test' . str_repeat($replace, count($invalidCharacters));
+
+        $this->assertEquals($expected, AssetsUtils::replaceInvalidFilenameCharacters($input, $replace));
+    }
+
+
     public function testGetQueryTemplate(): void
     {
         $templateStr = '{% if ID %} title:"prefix {{ ID }}" {% endif %}';