Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/framework/HTTP/Client/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* Class to work with HTTP protocol using sockets
*
* @author Magento Core Team <[email protected]>
*/
namespace Magento\Framework\HTTP\Client;
/**
* Socket client
*
* @SuppressWarnings(PHPMD.UnusedPrivateField)
*/
class Socket implements \Magento\Framework\HTTP\ClientInterface
{
/**
* Hostname
* @var string
*/
private $_host = 'localhost';
/**
* @var int
*/
private $_port = 80;
/**
* Stream resource
* @var object
*/
private $_sock = null;
/**
* Request headers
* @var array
*/
private $_headers = [];
/**
* Fields for POST method - hash
* @var array
*/
private $_postFields = [];
/**
* Request cookies
* @var array
*/
private $_cookies = [];
/**
* @var array
*/
private $_responseHeaders = [];
/**
* @var string
*/
private $_responseBody = '';
/**
* @var int
*/
private $_responseStatus = 0;
/**
* Request timeout
* @var int
*/
private $_timeout = 300;
/**
* TODO
* @var int
*/
private $_redirectCount = 0;
/**
* Set request timeout, msec
*
* @param int $value
* @return void
*/
public function setTimeout($value)
{
$this->_timeout = (int)$value;
}
/**
* Constructor
*
* @param string $host
* @param int $port
*/
public function __construct($host = null, $port = 80)
{
if ($host) {
$this->connect($host, (int)$port);
}
}
/**
* Set connection params
*
* @param string $host
* @param int $port
* @return void
*/
public function connect($host, $port = 80)
{
$this->_host = $host;
$this->_port = (int)$port;
}
/**
* Disconnect
*
* @return void
*/
public function disconnect()
{
@fclose($this->_sock);
}
/**
* Set headers from hash
*
* @param array $headers
* @return void
*/
public function setHeaders($headers)
{
$this->_headers = $headers;
}
/**
* Add header
*
* @param string $name name, ex. "Location"
* @param string $value value ex. "http://google.com"
* @return void
*/
public function addHeader($name, $value)
{
$this->_headers[$name] = $value;
}
/**
* Remove specified header
*
* @param string $name
* @return void
*/
public function removeHeader($name)
{
unset($this->_headers[$name]);
}
/**
* Authorization: Basic header
*
* Login credentials support
*
* @param string $login username
* @param string $pass password
* @return void
*/
public function setCredentials($login, $pass)
{
$val = base64_encode("{$login}:{$pass}");
$this->addHeader("Authorization", "Basic {$val}");
}
/**
* Add cookie
*
* @param string $name
* @param string $value
* @return void
*/
public function addCookie($name, $value)
{
$this->_cookies[$name] = $value;
}
/**
* Remove cookie
*
* @param string $name
* @return void
*/
public function removeCookie($name)
{
unset($this->_cookies[$name]);
}
/**
* Set cookies array
*
* @param array $cookies
* @return void
*/
public function setCookies($cookies)
{
$this->_cookies = $cookies;
}
/**
* Clear cookies
*
* @return void
*/
public function removeCookies()
{
$this->setCookies([]);
}
/**
* Make GET request
*
* @param string $uri full uri path
* @return void
*/
public function get($uri)
{
$this->makeRequest("GET", $this->parseUrl($uri));
}
/**
* Set host, port from full url and return relative url
*
* @param string $uri ex. http://google.com/index.php?a=b
* @return string ex. /index.php?a=b
* @throws \InvalidArgumentException
*/
protected function parseUrl($uri)
{
$parts = parse_url($uri);
if (!empty($parts['user']) && !empty($parts['pass'])) {
$this->setCredentials($parts['user'], $parts['pass']);
}
if (!empty($parts['port'])) {
$this->_port = (int)$parts['port'];
}
if (!empty($parts['host'])) {
$this->_host = $parts['host'];
} else {
throw new \InvalidArgumentException("Uri doesn't contain host part");
}
if (!empty($parts['path'])) {
$requestUri = $parts['path'];
} else {
throw new \InvalidArgumentException("Uri doesn't contain path part");
}
if (!empty($parts['query'])) {
$requestUri .= "?" . $parts['query'];
}
return $requestUri;
}
/**
* Make POST request
*
* @param string $uri
* @param array|string $params use string in case of JSON or XML POST request
* @return void
*/
public function post($uri, $params)
{
$this->makeRequest("POST", $this->parseUrl($uri), $params);
}
/**
* Get response headers
*
* @return array
*/
public function getHeaders()
{
return $this->_responseHeaders;
}
/**
* Get response body
*
* @return string
*/
public function getBody()
{
return $this->_responseBody;
}
/**
* Get cookies response hash
*
* @return array
*/
public function getCookies()
{
if (empty($this->_responseHeaders['Set-Cookie'])) {
return [];
}
$out = [];
foreach ($this->_responseHeaders['Set-Cookie'] as $row) {
$values = explode("; ", $row ?? '');
$c = count($values);
if (!$c) {
continue;
}
list($key, $val) = explode("=", $values[0]);
if ($val === null) {
continue;
}
$out[trim($key)] = trim($val);
}
return $out;
}
/**
* Get cookies array with details
* (domain, expire time etc)
*
* @return array
*/
public function getCookiesFull()
{
if (empty($this->_responseHeaders['Set-Cookie'])) {
return [];
}
$out = [];
foreach ($this->_responseHeaders['Set-Cookie'] as $row) {
$values = explode("; ", $row ?? '');
$c = count($values);
if (!$c) {
continue;
}
list($key, $val) = explode("=", $values[0]);
if ($val === null) {
continue;
}
$out[trim($key)] = ['value' => trim($val)];
array_shift($values);
$c--;
if (!$c) {
continue;
}
for ($i = 0; $i < $c; $i++) {
list($subkey, $val) = explode("=", $values[$i]);
$out[trim($key)][trim($subkey)] = $val !== null ? trim($val) : '';
}
}
return $out;
}
/**
* Process response headers
*
* @return void
*/
protected function processResponseHeaders()
{
$crlf = "\r\n";
$this->_responseHeaders = [];
while (!feof($this->_sock)) {
$line = fgets($this->_sock, 1024);
if ($line === $crlf) {
return;
}
$name = $value = '';
$out = explode(": ", trim($line), 2);
if (count($out) == 2) {
$name = $out[0];
$value = $out[1];
}
if (!empty($value)) {
if ($name == "Set-Cookie") {
if (!isset($this->_responseHeaders[$name])) {
$this->_responseHeaders[$name] = [];
}
$this->_responseHeaders[$name][] = $value;
} else {
$this->_responseHeaders[$name] = $value;
}
}
}
}
/**
* Process response body
*
* @return void
*/
protected function processResponseBody()
{
$this->_responseBody = '';
while (!feof($this->_sock)) {
$this->_responseBody .= @fread($this->_sock, 1024);
}
}
/**
* Process response
*
* @return void
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
protected function processResponse()
{
$response = '';
$responseLine = trim(fgets($this->_sock, 1024));
$line = explode(" ", $responseLine, 3);
if (count($line) != 3) {
// phpstan:ignore "Result of method Magento\Framework\HTTP\Client\Socket::doError() (void) is used."
return $this->doError("Invalid response line returned from server: " . $responseLine);
}
$this->_responseStatus = (int)$line[1];
$this->processResponseHeaders();
$this->processRedirect();
$this->processResponseBody();
}
/**
* Process redirect
*
* @return void
*/
protected function processRedirect() // phpcs:ignore Magento2.CodeAnalysis.EmptyBlock
{
// TODO: implement redirects support
}
/**
* Get response status code
*
* @see \Magento\Framework\HTTP\Client#getStatus()
*
* @return int
*/
public function getStatus()
{
return $this->_responseStatus;
}
/**
* Make request
*
* @param string $method
* @param string $uri
* @param array|string $params use string in case of JSON or XML POST request
* @return void
* @throws \Exception
*/
protected function makeRequest($method, $uri, $params = [])
{
$errno = $errstr = '';
$this->_sock = @fsockopen($this->_host, $this->_port, $errno, $errstr, $this->_timeout);
if (!$this->_sock) {
// phpstan:ignore "Result of method Magento\Framework\HTTP\Client\Socket::doError() (void) is used."
return $this->doError(sprintf("[errno: %d] %s", $errno, $errstr));
}
$crlf = "\r\n";
$isPost = $method == "POST";
$appendHeaders = [];
$paramsStr = false;
if ($isPost && $params) {
$paramsStr = is_array($params) ? http_build_query($params) : $params;
$appendHeaders['Content-type'] = 'application/x-www-form-urlencoded';
$appendHeaders['Content-length'] = strlen($paramsStr);
}
$out = "{$method} {$uri} HTTP/1.1{$crlf}";
$out .= $this->headersToString($appendHeaders);
$out .= $crlf;
if ($paramsStr) {
$out .= $paramsStr . $crlf;
}
fwrite($this->_sock, $out);
$this->processResponse();
}
/**
* Throw error exception
*
* @param string $string
* @return void
* @throws \Exception
*/
public function doError($string)
{
// phpcs:ignore Magento2.Exceptions.DirectThrow
throw new \Exception($string);
}
/**
* Convert headers hash to string
*
* @param array $append
* @return string
*/
protected function headersToString($append = [])
{
$headers = [];
$headers["Host"] = $this->_host;
$headers['Connection'] = "close";
$headers = array_merge($headers, $this->_headers, $append);
$str = [];
foreach ($headers as $k => $v) {
$str[] = "{$k}: {$v}\r\n";
}
return implode($str);
}
/**
* TODO
*
* @param array $arr
* @return void
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function setOptions($arr) // phpcs:ignore Magento2.CodeAnalysis.EmptyBlock
{
// Stub
}
/**
* TODO
*
* @param string $name
* @param string $value
* @return void
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function setOption($name, $value) // phpcs:ignore Magento2.CodeAnalysis.EmptyBlock
{
// Stub
}
}