clones/friendica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixing HTTPClient::post() and introduce HTTPRequestOptions

This commit is contained in:
Philipp 2021-08-25 21:09:14 +02:00
parent 660a3cd247
commit e9902401a5
No known key found for this signature in database
GPG Key ID: 9A28B7D4FF5667BD
3 changed files with 71 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/Network/HTTPClient.php
View File

@ -57,7 +57,7 @@ class HTTPClient implements IHTTPClient
} }
/** /**
* @throws HTTPException\InternalServerErrorException * {@inheritDoc}
*/ */
public function request(string $method, string $url, array $opts = []): IHTTPResult public function request(string $method, string $url, array $opts = []): IHTTPResult
{ {
@ -95,35 +95,39 @@ class HTTPClient implements IHTTPClient
$conf = []; $conf = [];
if (!empty($opts['cookiejar'])) { if (!empty($opts[HTTPRequestOptions::COOKIEJAR])) {
$jar = new FileCookieJar($opts['cookiejar']); $jar = new FileCookieJar($opts[HTTPRequestOptions::COOKIEJAR]);
$conf[RequestOptions::COOKIES] = $jar; $conf[RequestOptions::COOKIES] = $jar;
} }
$header = []; $headers = [];
if (!empty($opts['accept_content'])) { if (!empty($opts[HTTPRequestOptions::ACCEPT_CONTENT])) {
$header['Accept'] = $opts['accept_content']; $headers['Accept'] = $opts[HTTPRequestOptions::ACCEPT_CONTENT];
} }
if (!empty($opts['header'])) { if (!empty($opts[HTTPRequestOptions::LEGACY_HEADER])) {
$header = array_merge($opts['header'], $header);
}
if (!empty($opts['headers'])) {
$this->logger->notice('Wrong option \'headers\' used.'); $this->logger->notice('Wrong option \'headers\' used.');
$header = array_merge($opts['headers'], $header); $headers = array_merge($opts[HTTPRequestOptions::LEGACY_HEADER], $headers);
} }
$conf[RequestOptions::HEADERS] = array_merge($this->client->getConfig(RequestOptions::HEADERS), $header); if (!empty($opts[HTTPRequestOptions::HEADERS])) {
$headers = array_merge($opts[HTTPRequestOptions::HEADERS], $headers);
}
if (!empty($opts['timeout'])) { $conf[RequestOptions::HEADERS] = array_merge($this->client->getConfig(RequestOptions::HEADERS), $headers);
$conf[RequestOptions::TIMEOUT] = $opts['timeout'];
if (!empty($opts[HTTPRequestOptions::TIMEOUT])) {
$conf[RequestOptions::TIMEOUT] = $opts[HTTPRequestOptions::TIMEOUT];
}
if (!empty($opts[HTTPRequestOptions::BODY])) {
$conf[RequestOptions::BODY] = $opts[HTTPRequestOptions::BODY];
} }
$conf[RequestOptions::ON_HEADERS] = function (ResponseInterface $response) use ($opts) { $conf[RequestOptions::ON_HEADERS] = function (ResponseInterface $response) use ($opts) {
if (!empty($opts['content_length']) && if (!empty($opts[HTTPRequestOptions::CONTENT_LENGTH]) &&
$response->getHeaderLine('Content-Length') > $opts['content_length']) { (int)$response->getHeaderLine('Content-Length') > $opts[HTTPRequestOptions::CONTENT_LENGTH]) {
throw new TransferException('The file is too big!'); throw new TransferException('The file is too big!');
} }
}; };
@ -160,8 +164,6 @@ class HTTPClient implements IHTTPClient
} }
/** {@inheritDoc} /** {@inheritDoc}
*
* @throws HTTPException\InternalServerErrorException
*/ */
public function head(string $url, array $opts = []): IHTTPResult public function head(string $url, array $opts = []): IHTTPResult
{ {
@ -183,10 +185,10 @@ class HTTPClient implements IHTTPClient
{ {
$opts = []; $opts = [];
$opts[RequestOptions::JSON] = $params; $opts[RequestOptions::BODY] = $params;
if (!empty($headers)) { if (!empty($headers)) {
$opts['headers'] = $headers; $opts[RequestOptions::HEADERS] = $headers;
} }
if (!empty($timeout)) { if (!empty($timeout)) {

40
src/Network/HTTPRequestOptions.php Normal file
View File

@ -0,0 +1,40 @@
<?php
namespace Friendica\Network;
use GuzzleHttp\RequestOptions;
/**
* This class contains a list of possible HTTPClient request options.
*/
class HTTPRequestOptions
{
/**
* accept_content: (array) supply Accept: header with 'accept_content' as the value
*/
const ACCEPT_CONTENT = 'accept_content';
/**
* timeout: (int) out in seconds, default system config value or 60 seconds
*/
const TIMEOUT = RequestOptions::TIMEOUT;
/**
* cookiejar: (string) path to cookie jar file
*/
const COOKIEJAR = 'cookiejar';
/**
* headers: (array) header array
*/
const HEADERS = RequestOptions::HEADERS;
/**
* header: (array) header array (legacy version)
*/
const LEGACY_HEADER = 'header';
/**
* content_length: (int) maximum File content length
*/
const CONTENT_LENGTH = 'content_length';
/**
* body: (mixed) Setting the body for sending data
*/
const BODY = RequestOptions::BODY;
}

10
src/Network/IHTTPClient.php
View File

@ -88,9 +88,15 @@ interface IHTTPClient
/** /**
* Sends a HTTP request to a given url * Sends a HTTP request to a given url
* *
* @param string $method A HTTP request () * @param string $method A HTTP request
* @param string $url Url to send to * @param string $url Url to send to
* @param array $opts parameters * @param array $opts (optional parameters) associative array with:
* 'body' => (mixed) setting the body for sending data
* 'accept_content' => (string array) supply Accept: header with 'accept_content' as the value
* 'timeout' => int Timeout in seconds, default system config value or 60 seconds
* 'cookiejar' => path to cookie jar file
* 'header' => header array
* 'content_length' => int maximum File content length
* *
* @return IHTTPResult * @return IHTTPResult
*/ */