mirror of
https://github.com/Lastorder-DC/rhymix.git
synced 2026-01-07 10:41:40 +09:00
Add Rhymix Framework HTTP class to wrap Guzzle
This commit is contained in:
parent
1625683082
commit
c825fdaf43
1 changed files with 220 additions and 0 deletions
220
common/framework/HTTP.php
Normal file
220
common/framework/HTTP.php
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
<?php
|
||||
|
||||
namespace Rhymix\Framework;
|
||||
|
||||
/**
|
||||
* The HTTP class for making requests to external resources.
|
||||
*/
|
||||
class HTTP
|
||||
{
|
||||
/**
|
||||
* The default timeout for requests.
|
||||
*/
|
||||
public const DEFAULT_TIMEOUT = 3;
|
||||
|
||||
/**
|
||||
* Make a GET request.
|
||||
*
|
||||
* @param string $url
|
||||
* @param string|array $data
|
||||
* @param array $headers
|
||||
* @param array $cookies
|
||||
* @param array $settings
|
||||
* @return object
|
||||
*/
|
||||
public static function get(string $url, $data = null, array $headers = [], array $cookies = [], array $settings = []): object
|
||||
{
|
||||
return self::request($url, 'GET', $data, $headers, $cookies, $settings);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a HEAD request.
|
||||
*
|
||||
* @param string $url
|
||||
* @param string|array $data
|
||||
* @param array $headers
|
||||
* @param array $cookies
|
||||
* @param array $settings
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*/
|
||||
public static function head(string $url, $data = null, array $headers = [], array $cookies = [], array $settings = []): \Psr\Http\Message\ResponseInterface
|
||||
{
|
||||
return self::request($url, 'HEAD', $data, $headers, $cookies, $settings);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a POST request.
|
||||
*
|
||||
* @param string $url
|
||||
* @param string|array $data
|
||||
* @param array $headers
|
||||
* @param array $cookies
|
||||
* @param array $settings
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*/
|
||||
public static function post(string $url, $data = null, array $headers = [], array $cookies = [], array $settings = []): \Psr\Http\Message\ResponseInterface
|
||||
{
|
||||
return self::request($url, 'POST', $data, $headers, $cookies, $settings);
|
||||
}
|
||||
|
||||
/**
|
||||
* Download a file.
|
||||
*
|
||||
* This helps save memory when downloading large files,
|
||||
* by streaming the response body directly to the filesystem
|
||||
* instead of buffering it in memory.
|
||||
*
|
||||
* @param string $url
|
||||
* @param string $target_filename
|
||||
* @param string|array $data
|
||||
* @param array $headers
|
||||
* @param array $cookies
|
||||
* @param array $settings
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*/
|
||||
public static function download(string $url, string $target_filename, string $method = 'GET', $data = null, array $headers = [], array $cookies = [], array $settings = []): \Psr\Http\Message\ResponseInterface
|
||||
{
|
||||
// Try to create the parent directory to save the file.
|
||||
$target_dir = dirname($target_filename);
|
||||
if (!Storage::isDirectory($target_dir) && !Storage::createDirectory($target_dir))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// Pass to request() with appropriate settings for the filename.
|
||||
$settings['sink'] = $target_filename;
|
||||
return self::request($url, $method, $data, $headers, $cookies, $settings);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make any type of request.
|
||||
*
|
||||
* @param string $url
|
||||
* @param string $method
|
||||
* @param string|array $data
|
||||
* @param array $headers
|
||||
* @param array $cookies
|
||||
* @param array $settings
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*/
|
||||
public static function request(string $url, string $method = 'GET', $data = null, array $headers = [], array $cookies = [], array $settings = null): \Psr\Http\Message\ResponseInterface
|
||||
{
|
||||
// Apply default settings.
|
||||
if (!isset($settings['timeout']))
|
||||
{
|
||||
$settings['timeout'] = self::DEFAULT_TIMEOUT;
|
||||
}
|
||||
if (!isset($settings['http_errors']))
|
||||
{
|
||||
$settings['http_errors'] = false;
|
||||
}
|
||||
|
||||
// Set the body or POST data.
|
||||
if (is_string($data) && strlen($data) > 0)
|
||||
{
|
||||
$settings['body'] = $data;
|
||||
}
|
||||
elseif (is_array($data) && count($data) > 0)
|
||||
{
|
||||
if (isset($headers['Content-Type']) && $headers['Content-Type'] === 'multipart/form-data')
|
||||
{
|
||||
unset($headers['Content-Type']);
|
||||
$settings['multipart'] = [];
|
||||
foreach ($data as $key => $val)
|
||||
{
|
||||
$settings['multipart'][] = ['name' => $key, 'contents' => $val];
|
||||
}
|
||||
}
|
||||
elseif (isset($headers['Content-Type']) && $headers['Content-Type'] === 'application/json')
|
||||
{
|
||||
unset($headers['Content-Type']);
|
||||
$settings['json'] = $data;
|
||||
}
|
||||
elseif ($method !== 'GET')
|
||||
{
|
||||
$settings['form_params'] = $data;
|
||||
}
|
||||
else
|
||||
{
|
||||
$settings['query'] = $data;
|
||||
}
|
||||
}
|
||||
|
||||
// Set headers.
|
||||
if ($headers)
|
||||
{
|
||||
$settings['headers'] = $headers;
|
||||
}
|
||||
|
||||
// Set cookies.
|
||||
if ($cookies && !isset($settings['cookies']))
|
||||
{
|
||||
$jar = \GuzzleHttp\Cookie\CookieJar::fromArray($cookies, parse_url($url, \PHP_URL_HOST));
|
||||
$settings['cookies'] = $jar;
|
||||
}
|
||||
|
||||
// Set the proxy.
|
||||
if (!isset($settings['proxy']) && defined('__PROXY_SERVER__'))
|
||||
{
|
||||
$settings['proxy'] = constant('__PROXY_SERVER__');
|
||||
}
|
||||
|
||||
// Send the request.
|
||||
$guzzle = new \GuzzleHttp\Client();
|
||||
$start_time = microtime(true);
|
||||
$response = $guzzle->request($method, $url, $settings);
|
||||
$status_code = $response->getStatusCode() ?: 0;
|
||||
|
||||
// Measure elapsed time and add a debug entry.
|
||||
$elapsed_time = microtime(true) - $start_time;
|
||||
self::_debug($url, $status_code, $elapsed_time);
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Record a request with the Debug class.
|
||||
*
|
||||
* @param string $url
|
||||
* @param int $status_code
|
||||
* @param float $elapsed_time
|
||||
* @return void
|
||||
*/
|
||||
protected static function _debug(string $url, int $status_code, float $elapsed_time): void
|
||||
{
|
||||
if (!isset($GLOBALS['__remote_request_elapsed__']))
|
||||
{
|
||||
$GLOBALS['__remote_request_elapsed__'] = 0;
|
||||
}
|
||||
$GLOBALS['__remote_request_elapsed__'] += $elapsed_time;
|
||||
|
||||
if (Debug::isEnabledForCurrentUser())
|
||||
{
|
||||
$log = array();
|
||||
$log['url'] = $url;
|
||||
$log['status'] = $status_code;
|
||||
$log['elapsed_time'] = $elapsed_time;
|
||||
$log['called_file'] = $log['called_line'] = $log['called_method'] = null;
|
||||
$log['backtrace'] = [];
|
||||
|
||||
if (in_array('slow_remote_requests', config('debug.display_content')))
|
||||
{
|
||||
$bt = debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
|
||||
foreach ($bt as $no => $call)
|
||||
{
|
||||
if($call['file'] !== __FILE__ && $call['file'] !== \RX_BASEDIR . 'classes/file/FileHandler.class.php')
|
||||
{
|
||||
$log['called_file'] = $bt[$no]['file'];
|
||||
$log['called_line'] = $bt[$no]['line'];
|
||||
$next = $no + 1;
|
||||
$log['called_method'] = $bt[$next]['class'].$bt[$next]['type'].$bt[$next]['function'];
|
||||
$log['backtrace'] = array_slice($bt, $next, 1);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Debug::addRemoteRequest($log);
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue