Merge pull request #52 from picqer/handle-maximum-size-response

Fix: Check response body size to not exceed maximum before json_decoding
picqer · Jul 8, 2024 · 4a8e063 · 4a8e063
2 parents 8c42905 + 269ce10
commit 4a8e063
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 73 deletions.
diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
         }
     ],
     "require": {
-        "php": ">=7.2.0",
+        "php": ">=7.4.0",
         "guzzlehttp/guzzle": "~6.0|~7.0",
         "ext-json": "*"
     },

diff --git a/src/Picqer/Carriers/SendCloud/Connection.php b/src/Picqer/Carriers/SendCloud/Connection.php
@@ -9,22 +9,14 @@
 
 class Connection
 {
-    private $apiUrl = 'https://panel.sendcloud.sc/api/v2/';
-    private $apiKey;
-    private $apiSecret;
-    private $partnerId;
+    private string $apiUrl = 'https://panel.sendcloud.sc/api/v2/';
+    private string $apiKey;
+    private string $apiSecret;
+    private ?string $partnerId = null;
+    private ?int $maxResponseSizeInBytes = null;
 
-    /**
-     * Contains the HTTP client (Guzzle)
-     * @var Client
-     */
-    private $client;
-
-    /**
-     * Array of inserted middleWares
-     * @var array
-     */
-    protected $middleWares = [];
+    private ?Client $client = null;
+    protected array $middleWares = [];
 
     public function __construct(string $apiKey, string $apiSecret, ?string $partnerId = null)
     {
@@ -35,7 +27,7 @@ public function __construct(string $apiKey, string $apiSecret, ?string $partnerI
 
     public function client(): Client
     {
-        if ($this->client) {
+        if ($this->client instanceof Client) {
             return $this->client;
         }
 
@@ -63,7 +55,7 @@ public function client(): Client
         return $this->client;
     }
 
-    public function insertMiddleWare($middleWare)
+    public function insertMiddleWare($middleWare): void
     {
         $this->middleWares[] = $middleWare;
     }
@@ -73,13 +65,6 @@ public function apiUrl(): string
         return $this->apiUrl;
     }
 
-    /**
-     * Perform a GET request
-     * @param string $url
-     * @param array $params
-     * @return array
-     * @throws SendCloudApiException
-     */
     public function get($url, $params = []): array
     {
         try {
@@ -94,14 +79,6 @@ public function get($url, $params = []): array
         }
     }
 
-    /**
-     * Perform a POST request
-     * @param string $url
-     * @param mixed $body
-     * @param array $query
-     * @return array
-     * @throws SendCloudApiException
-     */
     public function post($url, $body, $query = []): array
     {
         try {
@@ -116,14 +93,6 @@ public function post($url, $body, $query = []): array
         }
     }
 
-    /**
-     * Perform PUT request
-     * @param string $url
-     * @param mixed $body
-     * @param array $query
-     * @return array
-     * @throws SendCloudApiException
-     */
     public function put($url, $body, $query = []): array
     {
         try {
@@ -138,14 +107,7 @@ public function put($url, $body, $query = []): array
         }
     }
 
-    /**
-     * Perform DELETE request
-     * @param string $url
-     * @param array $query
-     * @return array
-     * @throws SendCloudApiException
-     */
-    public function delete($url, $query = [])
+    public function delete($url, $query = []): array
     {
         try {
             $result = $this->client()->delete($url, ['query' => $query]);
@@ -159,18 +121,20 @@ public function delete($url, $query = [])
         }
     }
 
-    /**
-     * @param ResponseInterface $response
-     * @return array Parsed JSON result
-     * @throws SendCloudApiException
-     */
-    public function parseResponse(ResponseInterface $response)
+    public function parseResponse(ResponseInterface $response): array
     {
         try {
             // Rewind the response (middlewares might have read it already)
             $response->getBody()->rewind();
 
             $responseBody = $response->getBody()->getContents();
+
+            if (! is_null($this->maxResponseSizeInBytes)) {
+                if (strlen($responseBody) > $this->maxResponseSizeInBytes) {
+                    throw new MaximumResponseSizeException(sprintf('Response size exceeded maximum of %d bytes', $this->maxResponseSizeInBytes));
+                }
+            }
+
             $resultArray = json_decode($responseBody, true);
 
             if (! is_array($resultArray)) {
@@ -196,39 +160,34 @@ public function parseResponse(ResponseInterface $response)
     }
 
     /**
-     * Returns the selected environment
-     *
-     * @return string
      * @deprecated
      */
-    public function getEnvironment()
+    public function getEnvironment(): string
     {
         return 'live';
     }
 
     /**
-     * Set the environment for the client
-     *
-     * @param string $environment
-     * @throws SendCloudApiException
      * @deprecated
      */
-    public function setEnvironment($environment)
+    public function setEnvironment($environment): void
     {
         if ($environment === 'test') {
             throw new SendCloudApiException('SendCloud test environment is no longer available');
         }
     }
 
-    /**
-     * Download a resource.
-     *
-     * @param string $url
-     * @param array $headers
-     * @return string
-     * @throws SendCloudApiException
-     */
-    public function download($url, array $headers = ['Accept' => 'application/pdf'])
+    public function setMaxResponseSizeInBytes(?int $maxResponseSizeInBytes): void
+    {
+        $this->maxResponseSizeInBytes = $maxResponseSizeInBytes;
+    }
+
+    public function getMaxResponseSizeInBytes(): ?int
+    {
+        return $this->maxResponseSizeInBytes;
+    }
+
+    public function download($url, array $headers = ['Accept' => 'application/pdf']): string
     {
         try {
             $result = $this->client()->get($url, ['headers' => $headers]);

diff --git a/src/Picqer/Carriers/SendCloud/MaximumResponseSizeException.php b/src/Picqer/Carriers/SendCloud/MaximumResponseSizeException.php
@@ -0,0 +1,5 @@
+<?php
+
+namespace Picqer\Carriers\SendCloud;
+
+class MaximumResponseSizeException extends SendCloudApiException {}