Nosial/ncc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 11 Packages Wiki Activity Actions

Refactored HttpClient to support the ability to download files to disk.

Browse source
This commit is contained in:
Netkas 2022-12-15 18:16:44 -05:00
parent bfbd7b4828
commit 03b02774b6
1 changed files with 108 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

157
src/ncc/Utilities/HttpClient.php
View file

@ -2,6 +2,7 @@
namespace ncc\Utilities;
use CurlHandle;
use ncc\Abstracts\HttpRequestType;
use ncc\Exceptions\HttpException;
use ncc\Objects\HttpRequest;
@ -10,6 +11,64 @@
class HttpClient
{
/**
* Prepares the curl request
*
* @param HttpRequest $request
* @return CurlHandle
*/
private static function prepareCurl(HttpRequest $request): CurlHandle
{
$curl = curl_init($request->Url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_MAXREDIRS, 5);
curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($curl, CURLOPT_TIMEOUT, 10);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_HTTPHEADER, $request->Headers);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $request->Type);
switch($request->Type)
{
case HttpRequestType::GET:
curl_setopt($curl, CURLOPT_HTTPGET, true);
break;
case HttpRequestType::POST:
curl_setopt($curl, CURLOPT_POST, true);
if($request->Body !== null)
curl_setopt($curl, CURLOPT_POSTFIELDS, $request->Body);
break;
case HttpRequestType::PUT:
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
if($request->Body !== null)
curl_setopt($curl, CURLOPT_POSTFIELDS, $request->Body);
break;
case HttpRequestType::DELETE:
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
break;
}
if (is_array($request->Authentication))
{
curl_setopt($curl, CURLOPT_USERPWD, $request->Authentication[0] . ':' . $request->Authentication[1]);
}
else if (is_string($request->Authentication))
{
curl_setopt($curl, CURLOPT_USERPWD, $request->Authentication);
}
foreach ($request->Options as $option => $value)
curl_setopt($curl, $option, $value);
return $curl;
}
/**
* Creates a new HTTP request and returns the response.
*
@ -26,58 +85,12 @@
$cache = RuntimeCache::get(sprintf('http_cache_%s', $httpRequest->requestHash()));
if($cache !== null && $cache->getTtl() > time())
{
Console::outDebug(sprintf('using cached response for %s', $httpRequest->requestHash()));
return $cache->getHttpResponse();
}
}
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $httpRequest->Url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_MAXREDIRS, 10);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
foreach($httpRequest->Options as $option => $value)
curl_setopt($curl, $option, $value);
switch($httpRequest->Type)
{
case HttpRequestType::GET:
curl_setopt($curl, CURLOPT_HTTPGET, true);
break;
case HttpRequestType::POST:
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $httpRequest->Body);
break;
case HttpRequestType::PUT:
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($curl, CURLOPT_POSTFIELDS, $httpRequest->Body);
break;
case HttpRequestType::DELETE:
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
break;
default:
throw new HttpException(sprintf('Invalid HTTP request type: %s', $httpRequest->Type));
}
if (is_array($httpRequest->Authentication))
{
curl_setopt($curl, CURLOPT_USERPWD, $httpRequest->Authentication[0] . ':' . $httpRequest->Authentication[1]);
}
else if (is_string($httpRequest->Authentication))
{
curl_setopt($curl, CURLOPT_USERPWD, $httpRequest->Authentication);
}
if (count($httpRequest->Headers) > 0)
curl_setopt($curl, CURLOPT_HTTPHEADER, $httpRequest->Headers);
$curl = self::prepareCurl($httpRequest);
Console::outDebug(sprintf(' => %s request %s', $httpRequest->Type, $httpRequest->Url));
if($httpRequest->Headers !== null && count($httpRequest->Headers) > 0)
@ -114,13 +127,59 @@
if($cache)
{
$httpCacheObject = new HttpResponseCache($httpResponse, 60);
$httpCacheObject = new HttpResponseCache($httpResponse, time() + 60);
RuntimeCache::set(sprintf('http_cache_%s', $httpRequest->requestHash()), $httpCacheObject);
Console::outDebug(sprintf('cached response for %s', $httpRequest->requestHash()));
}
return $httpResponse;
}
/**
* Downloads a file from the given url and saves it to the given path.
*
* @param HttpRequest $httpRequest
* @param string $path
* @return void
* @throws HttpException
*/
public static function download(HttpRequest $httpRequest, string $path): void
{
$curl = self::prepareCurl($httpRequest);
$fp = fopen($path, 'w');
curl_setopt($curl, CURLOPT_FILE, $fp);
curl_setopt($curl, CURLOPT_HEADER, 0);
$response = curl_exec($curl);
if ($response === false)
{
$error = curl_error($curl);
curl_close($curl);
throw new HttpException($error);
}
curl_close($curl);
fclose($fp);
}
/**
* Displays the download progress in the console
*
* @param $resource
* @param $downloadSize
* @param $downloaded
* @param $uploadSize
* @param $uploaded
* @return void
*/
public static function displayProgress($resource, $downloadSize, $downloaded, $uploadSize, $uploaded): void
{
if ($downloadSize > 0)
Console::inlineProgressBar($downloaded, $downloadSize);
}
/**
* Takes the return headers of a cURL request and parses them into an array.
*