[PHP-Client] Allow Content-Type merge-match+json for encoding (#19479)

* Allow Content-Type merge-match+json for encoding * Changes JSON recognition to more flexible regex * Removes now useless JSON format list * Removes empty spaces * Adds explanatory PHPDoc comment * Moves Json-detection to class HeaderSelector
OpenAPITools · Oct 3, 2024 · 2437d7f · 2437d7f
1 parent d521cdd
commit 2437d7f
Show file tree

Hide file tree

Showing 12 changed files with 159 additions and 74 deletions.
diff --git a/.ddev/web-build/Dockerfile.maven b/.ddev/web-build/Dockerfile.maven
@@ -0,0 +1 @@
+RUN apt update && apt install -y maven
diff --git a/modules/openapi-generator/src/main/resources/php/HeaderSelector.mustache b/modules/openapi-generator/src/main/resources/php/HeaderSelector.mustache
@@ -76,7 +76,7 @@ class HeaderSelector
         }
 
         # If none of the available Accept headers is of type "json", then just use all them
-        $headersWithJson = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept);
+        $headersWithJson = $this->selectJsonMimeList($accept);
         if (count($headersWithJson) === 0) {
             return implode(',', $accept);
         }
@@ -86,6 +86,34 @@ class HeaderSelector
         return $this->getAcceptHeaderWithAdjustedWeight($accept, $headersWithJson);
     }
 
+    /**
+    * Detects whether a string contains a valid JSON mime type
+    *
+    * @param string $searchString
+    * @return bool
+    */
+    public function isJsonMime(string $searchString): bool
+    {
+        return preg_match('~^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)~', $searchString) === 1;
+    }
+
+    /**
+    * Select all items from a list containing a JSON mime type
+    *
+    * @param array $mimeList
+    * @return array
+    */
+    private function selectJsonMimeList(array $mimeList): array {
+        $jsonMimeList = [];
+        foreach ($mimeList as $mime) {
+            if($this->isJsonMime($mime)) {
+                $jsonMimeList[] = $mime;
+            }
+        }
+        return $jsonMimeList;
+    }
+
+
     /**
     * Create an Accept header string from the given "Accept" headers array, recalculating all weights
     *

diff --git a/modules/openapi-generator/src/main/resources/php/libraries/psr-18/api.mustache b/modules/openapi-generator/src/main/resources/php/libraries/psr-18/api.mustache
@@ -613,7 +613,7 @@ use function sprintf;
         // for model (json/xml)
         {{#bodyParams}}
         if (isset(${{paramName}})) {
-            if ($headers['Content-Type'] === 'application/json') {
+            if ($this->headerSelector->isJsonMime($headers['Content-Type'])) {
                 $httpBody = json_encode(ObjectSerializer::sanitizeForSerialization(${{paramName}}));
             } else {
                 $httpBody = ${{paramName}};
@@ -637,7 +637,7 @@ use function sprintf;
                 // for HTTP post (form)
                 $httpBody = new MultipartStream($multipartContents);
 
-            } elseif ($headers['Content-Type'] === 'application/json') {
+            } elseif ($this->headerSelector->isJsonMime($headers['Content-Type'])) {
                 $httpBody = json_encode($formParams);
 
             } else {

diff --git a/samples/client/petstore/php/OpenAPIClient-php/lib/HeaderSelector.php b/samples/client/petstore/php/OpenAPIClient-php/lib/HeaderSelector.php
@@ -85,7 +85,7 @@ private function selectAcceptHeader(array $accept): ?string
         }
 
         # If none of the available Accept headers is of type "json", then just use all them
-        $headersWithJson = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept);
+        $headersWithJson = $this->selectJsonMimeList($accept);
         if (count($headersWithJson) === 0) {
             return implode(',', $accept);
         }
@@ -95,6 +95,34 @@ private function selectAcceptHeader(array $accept): ?string
         return $this->getAcceptHeaderWithAdjustedWeight($accept, $headersWithJson);
     }
 
+    /**
+    * Detects whether a string contains a valid JSON mime type
+    *
+    * @param string $searchString
+    * @return bool
+    */
+    public function isJsonMime(string $searchString): bool
+    {
+        return preg_match('~^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)~', $searchString) === 1;
+    }
+
+    /**
+    * Select all items from a list containing a JSON mime type
+    *
+    * @param array $mimeList
+    * @return array
+    */
+    private function selectJsonMimeList(array $mimeList): array {
+        $jsonMimeList = [];
+        foreach ($mimeList as $mime) {
+            if($this->isJsonMime($mime)) {
+                $jsonMimeList[] = $mime;
+            }
+        }
+        return $jsonMimeList;
+    }
+
+
     /**
     * Create an Accept header string from the given "Accept" headers array, recalculating all weights
     *

diff --git a/samples/client/petstore/php/psr-18/lib/Api/AnotherFakeApi.php b/samples/client/petstore/php/psr-18/lib/Api/AnotherFakeApi.php
@@ -376,7 +376,7 @@ public function call123TestSpecialTagsRequest($client)
 
         // for model (json/xml)
         if (isset($client)) {
-            if ($headers['Content-Type'] === 'application/json') {
+            if ($this->headerSelector->isJsonMime($headers['Content-Type'])) {
                 $httpBody = json_encode(ObjectSerializer::sanitizeForSerialization($client));
             } else {
                 $httpBody = $client;
@@ -396,7 +396,7 @@ public function call123TestSpecialTagsRequest($client)
                 // for HTTP post (form)
                 $httpBody = new MultipartStream($multipartContents);
 
-            } elseif ($headers['Content-Type'] === 'application/json') {
+            } elseif ($this->headerSelector->isJsonMime($headers['Content-Type'])) {
                 $httpBody = json_encode($formParams);
 
             } else {

diff --git a/samples/client/petstore/php/psr-18/lib/Api/DefaultApi.php b/samples/client/petstore/php/psr-18/lib/Api/DefaultApi.php
@@ -371,7 +371,7 @@ public function fooGetRequest()
                 // for HTTP post (form)
                 $httpBody = new MultipartStream($multipartContents);
 
-            } elseif ($headers['Content-Type'] === 'application/json') {
+            } elseif ($this->headerSelector->isJsonMime($headers['Content-Type'])) {
                 $httpBody = json_encode($formParams);
 
             } else {