Enhancements in performance and reliability

* Added finer control over general usage settings.
* Enhanced usage descriptions for better clarity.
* Implemented various performance optimizations for increased efficiency.
* Introduced a maximum download size limit to improve stability.
* StreamDriver: Resolved issues with HTTP status code detection.

Author: brcontainer

.gitignore

@@ -47,3 +47,4 @@ Temporary Items
 .idea/
 .vscode/
 cache/*
+/README.html

README.md

@@ -83,33 +83,42 @@ html2canvas(document.getElementById('container'), {
 
 Method | Description
 --- | ---
+`setMaxDownloadSize(int $value): void` | Set the maximum allowed download size
+`getMaxDownloadSize(): int` | Get the maximum allowed download size
+`setMaxRedirs(int $value): void` | Set the maximum number of HTTP redirects
+`getMaxRedirs(): int` | Get the maximum number of HTTP redirects
+`setReferer(string $value): void` | Set the Referer request header
+`getReferer(): string` | Get the Referer request header
+`setTimeout(int $value): void` | Set connection timeout
+`getTimeout(): int` | Get connection timeout
+`setUserAgent(string $value): void` | Set the User-Agent request header
+`getUserAgent(): string` | Get the User-Agent request header
 `setDrivers(array $drivers): void` | Set drivers used to download the resource
 `setOptions(string $key, mixed $value): void` | Set generic options
 `getOptions([string $key]): mixed` | Get generic options
 `setAllowedUrls(array $urls): void` | Set allowed URLs
-`addAllowedType(string $type, bool $binary): void` | Add content-type to the allowed list
-`removeAllowedType(string $type): void` | Remove content-type from the allowed list
+`addAllowedType(string $type, bool $binary): void` | Add Content-Type to the allowed list
+`removeAllowedType(string $type): void` | Remove Content-Type from the allowed list
+`isAllowedType(string $type[, string &$errorMessage])` | Check if Content-Type is allowed
 `setTemporary(string $path): void` | Sets temporary handle path, eg.: `/mnt/storage/`, `php://temp`, `php://memory`
 `getTemporary(): resource` | Get temporary stream
 `download(string $url[, bool $ignoreDownloadError]): void` | Perform download
 `setResponseCacheTime(int $seconds): void` | Enable or disable cache for `Proxy::respose()` or `Proxy::jsonp()`
 `response(): void` | Dump response to output
 `jsonp(string $callback): void` | Output JSONP callback with URL or data URI content
 `getContents([int $length[, int $offset]]): string` | If last download was successful, contents will be returned
-`getContentType(): string` | If last download was successful, content-type will be returned
+`getContentType(): string` | If last download was successful, Content-Type will be returned
 `getHttpStatus(): int` | If last download was successful, HTTP status will be returned
-`getLastErrorCode(): int` | If last download was failed, error code will be returned
-`getLastErrorMessage(): string` | If last download was failed, error message will be returned
+`getErrorCode(): int` | If last download was failed, error code will be returned
+`getErrorMessage(): string` | If last download was failed, error message will be returned
 `reset(): void` | Reset last download
 
 ## Generic options
 
+Generic options are primarily used for driver configurations. Since each driver may require different types of settings, the most flexible approach is to allow these options to store any value. This is particularly useful when developing a new driver. Existing options include:
+
 Usage | Description
 --- | ---
-`setOptions('max_redirs', int $value)` | Set the redirect limit
-`setOptions('timeout', int $value)` | Set timeout for connections
-`setOptions('user_agent', string $value)` | Set Browser User-Agent
-`setOptions('referer', string $value)` | Set request header contains the absolute or partial address from which a resource has been requested
 `setOptions('curl', array $value)` | Options for `CurlDriver`. See: https://www.php.net/manual/en/curl.constants.php
 `setOptions('stream', array $value)` | Options for `StreamDriver`. See: https://www.php.net/manual/en/context.php
 
@@ -157,7 +166,7 @@ $proxy->setOptions('stream', [
 
 ## Content-Type allowed
 
-When executing the download() method a content-type validation will be performed, by default the following Content-Types are allowed:
+When executing the download() method a Content-Type validation will be performed, by default the following Content-Types are allowed:
 
 Content-Type | `Proxy::jsonp()`
 --- | ---
@@ -170,7 +179,7 @@ Content-Type | `Proxy::jsonp()`
 `image/svg+xml` | URL-encoded
 `image/svg-xml` | URL-encoded
 
-You can define another allowed content-type, example:
+You can define another allowed Content-Type, example:
 
 ```php
 $proxy->addAllowedType('image/x-icon', true);
@@ -231,39 +240,35 @@ try {
 }
 ```
 
-If you need to handle content or errors manually, you can use the `Proxy::getContents`, `Proxy::getContentType`, `Proxy::getHttpStatus`, `Proxy::getLastErrorCode`, `Proxy::getLastErrorMessage` methods:
+If you need to handle content, you can use the `Proxy::getContents`, `Proxy::getContentType`, `Proxy::getHttpStatus` methods:
 
 ```php
 use Inphinit\Proxy\Proxy;
 use Inphinit\Proxy\Drivers\CurlDriver;
 use Inphinit\Proxy\Drivers\StreamDriver;
 
-if (empty($_GET['callback'])) {
-    die('Missing callback');
-}
-
 $proxy = new Proxy();
 
 $proxy->setDrivers([
     CurlDriver::class,
     StreamDriver::class
 ]);
 
-$proxy->download($url, true);
-
-$errcode = $proxy->getLastErrorCode();
-$httpStatus = $proxy->getHttpStatus();
+try {
+    $proxy->download($url);
 
-if ($errcode) {
-    echo $code, ': ', $proxy->getLastErrorCode();
-} elseif ($httpStatus < 200 && $httpStatus > 299) {
-    echo 'HTTP request failed:', $httpStatus;
-} else {
-    // Sucesss
-    $type = $proxy->getContentType();
+    // Success
     $contents = $proxy->getContents();
+    $contentType = $proxy->getContentType();
+    $httpStatus = $proxy->getHttpStatus();
 
     ...
+
+} catch (Exception $ee) {
+    $code = $ee->getCode();
+    $message = $ee->getMessage();
+
+    echo 'Error: (', $code, ') ', $message;
 }
 ```
 

proxy.php

@@ -17,6 +17,42 @@
 
 $proxy = new Proxy();
 
+// Set drivers used for download
+$proxy->setDrivers([
+    //CurlDriver::class,
+    StreamDriver::class
+]);
+
+/*
+// PHP 5.4 sintax
+$proxy->setDrivers([
+    'Inphinit\Proxy\Drivers\CurlDriver',
+    'Inphinit\Proxy\Drivers\StreamDriver',
+]);
+*/
+
+// Set max download size
+// $proxy->setMaxDownloadSize(5242880);
+
+// Set max redirections
+// $proxy->setMaxRedirs(3);
+
+// Set current referer
+if (isset($_SERVER['HTTP_REFERER'])) {
+    $proxy->setReferer($_SERVER['HTTP_REFERER']);
+}
+
+// Set max timeout connection
+// $proxy->setTimeout(10);
+
+// Set current user-agent
+if (isset($_SERVER['HTTP_USER_AGENT'])) {
+    $proxy->setUserAgent($_SERVER['HTTP_USER_AGENT']);
+}
+
+// Use specific directory
+// $proxy->setTemporary(__DIR__ . '/cache');
+
 // Set allowed URLs
 /*
 $proxy->setAllowedUrls([
@@ -25,7 +61,7 @@
 ]);
 */
 
-// Set allowed content-types
+// Set allowed Content-Types
 // $proxy->addAllowedType('image/ico', true);
 
 // Extra configs for CurlDriver
@@ -44,31 +80,6 @@
 ]);
 */
 
-// Set max timeout connection
-// $proxy->setOptions('timeout', 10);
-
-// Set max redirections from location: header
-// $proxy->setOptions('max_redirs', 3);
-
-// Set current user-agent
-if (isset($_SERVER['HTTP_USER_AGENT'])) {
-    $proxy->setOptions('user_agent', $_SERVER['HTTP_USER_AGENT']);
-}
-
-// Set current referer
-if (isset($_SERVER['HTTP_REFERER'])) {
-    $proxy->setOptions('referer', $_SERVER['HTTP_REFERER']);
-}
-
-// Set drivers used for download
-$proxy->setDrivers([
-    CurlDriver::class,
-    StreamDriver::class
-]);
-
-// Use specific directory
-// $proxy->setTemporary(__DIR__ . '/cache');
-
 try {
     // Execute download
     $proxy->download($url);

src/Drivers/CurlDriver.php

@@ -13,10 +13,12 @@
 
 class CurlDriver
 {
-    private $proxy;
-    private $lastUpdate = 0;
-    private $timeout = 30;
+    private $errorMessage;
     private $handle;
+    private $httpStatus;
+    private $lastUpdate = 0;
+    private $maxDownloadSize;
+    private $proxy;
 
     /**
      * Create instace
@@ -59,13 +61,13 @@ public function exec($url, &$httpStatus, &$contentType, &$errorCode, &$errorMess
             $this->handle = curl_init();
 
             $ch = $this->handle;
-            $timeout = $this->proxy->getOptions('timeout');
+            $timeout = $this->proxy->getTimeout();
 
             $options = array(
-                CURLOPT_CONNECTTIMEOUT => $timeout ? $timeout : $this->timeout,
+                CURLOPT_CONNECTTIMEOUT => $timeout,
                 CURLOPT_FOLLOWLOCATION => true,
                 CURLOPT_HEADER => false,
-                CURLOPT_MAXREDIRS => $this->proxy->getOptions('max_redirs'),
+                CURLOPT_MAXREDIRS => $this->proxy->getMaxRedirs(),
                 CURLOPT_RETURNTRANSFER => false
             );
 
@@ -77,18 +79,34 @@ public function exec($url, &$httpStatus, &$contentType, &$errorCode, &$errorMess
 
             curl_setopt_array($ch, $options);
 
-            $referer = $this->proxy->getOptions('referer');
+            $referer = $this->proxy->getReferer();
 
             if ($referer) {
                 curl_setopt($ch, CURLOPT_REFERER, $referer);
             }
 
-            $userAgent = $this->proxy->getOptions('user_agent');
+            $userAgent = $this->proxy->getUserAgent();
 
             if ($userAgent) {
                 curl_setopt($ch, CURLOPT_USERAGENT, $userAgent);
             }
 
+            curl_setopt($ch, CURLOPT_NOPROGRESS, false);
+
+            $this->maxDownloadSize = $this->proxy->getMaxDownloadSize();
+
+            if (PHP_VERSION_ID < 50500) {
+                $progressCallback = function ($download_size, $downloaded, $upload_size, $uploaded) {
+                    return $this->abort($downloaded);
+                };
+            } else {
+                $progressCallback = function ($resource, $download_size, $downloaded, $upload_size, $uploaded) {
+                    return $this->abort($downloaded);
+                };
+            }
+
+            curl_setopt($ch, CURLOPT_PROGRESSFUNCTION, $progressCallback);
+
             $temp = $this->proxy->getTemporary();
 
             if (defined('CURLOPT_WRITEFUNCTION')) {
@@ -110,10 +128,40 @@ public function exec($url, &$httpStatus, &$contentType, &$errorCode, &$errorMess
 
         if ($code !== 0) {
             $errorCode = $code;
-            $errorMessage = 'cURL: ' . curl_error($ch);
-        } else {
-            $httpStatus = curl_getinfo($ch, CURLINFO_HTTP_CODE);
-            $contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
+            $errorMessage = $this->errorMessage ? $this->errorMessage : ('cURL: ' . curl_error($ch));
+
+            if ($this->httpStatus !== null) {
+                $httpStatus = $this->httpStatus;
+            }
+
+            return false;
         }
+
+        $httpStatus = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+        $contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
+
+        return true;
+    }
+
+    private function abort($downloaded)
+    {
+        if ($downloaded > $this->maxDownloadSize) {
+            return 1;
+        }
+
+        $code = curl_getinfo($this->handle, CURLINFO_HTTP_CODE);
+
+        if ($code >= 100 && ($code < 200 || $code >= 300)) {
+            $this->httpStatus = $code;
+            return 1;
+        }
+
+        $contentType = curl_getinfo($this->handle, CURLINFO_CONTENT_TYPE);
+
+        if ($contentType && $this->proxy->isAllowedType($contentType, $this->errorMessage) === false) {
+            return 1;
+        }
+
+        return 0;
     }
 }