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/Webapi/Rest/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Webapi\Rest;
use Magento\Framework\Api\SimpleDataObjectConverter;
use Magento\Framework\Phrase;
/**
* REST API request.
*
* @api
* @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
*/
class Request extends \Magento\Framework\Webapi\Request
{
/**#@+
* HTTP methods supported by REST.
*/
public const HTTP_METHOD_GET = 'GET';
public const HTTP_METHOD_DELETE = 'DELETE';
public const HTTP_METHOD_PUT = 'PUT';
public const HTTP_METHOD_POST = 'POST';
/**#@-*/
/**
* Character set which must be used in request.
*/
public const REQUEST_CHARSET = 'utf-8';
public const DEFAULT_ACCEPT = '*/*';
/**
* @var string
*/
protected $_serviceName;
/**
* @var string
*/
protected $_serviceType;
/**
* @var \Magento\Framework\Webapi\Rest\Request\DeserializerInterface
*/
protected $_deserializer;
/**
* @var array
*/
protected $_bodyParams;
/**
* @var \Magento\Framework\Webapi\Rest\Request\DeserializerFactory
*/
protected $_deserializerFactory;
/**
* Initialize dependencies
*
* @param \Magento\Framework\Stdlib\Cookie\CookieReaderInterface $cookieReader
* @param \Magento\Framework\Stdlib\StringUtils $converter
* @param \Magento\Framework\App\AreaList $areaList
* @param \Magento\Framework\Config\ScopeInterface $configScope
* @param \Magento\Framework\Webapi\Rest\Request\DeserializerFactory $deserializerFactory
* @param null|string $uri
*/
public function __construct(
\Magento\Framework\Stdlib\Cookie\CookieReaderInterface $cookieReader,
\Magento\Framework\Stdlib\StringUtils $converter,
\Magento\Framework\App\AreaList $areaList,
\Magento\Framework\Config\ScopeInterface $configScope,
\Magento\Framework\Webapi\Rest\Request\DeserializerFactory $deserializerFactory,
$uri = null
) {
parent::__construct($cookieReader, $converter, $areaList, $configScope, $uri);
$this->_deserializerFactory = $deserializerFactory;
}
/**
* Get request deserializer.
*
* @return \Magento\Framework\Webapi\Rest\Request\DeserializerInterface
*/
protected function _getDeserializer()
{
if (null === $this->_deserializer) {
$this->_deserializer = $this->_deserializerFactory->get($this->getContentType());
}
return $this->_deserializer;
}
/**
* Retrieve accept types understandable by requester in a form of array sorted by quality in descending order.
*
* @return string[]
*/
public function getAcceptTypes()
{
$qualityToTypes = [];
$orderedTypes = [];
foreach (preg_split('/,\s*/', $this->getHeader('Accept') ?? '') as $definition) {
$typeWithQ = explode(';', $definition);
$mimeType = trim(array_shift($typeWithQ));
// check MIME type validity
if (!preg_match('~^([0-9a-z*+\-]+)(?:/([0-9a-z*+\-\.]+))?$~i', $mimeType)) {
continue;
}
$quality = '1.0';
// default value for quality
if ($typeWithQ) {
$qAndValue = explode('=', $typeWithQ[0]);
if (2 == count($qAndValue)) {
$quality = $qAndValue[1];
}
}
$qualityToTypes[$quality][$mimeType] = true;
}
krsort($qualityToTypes);
foreach ($qualityToTypes as $typeList) {
$orderedTypes += $typeList;
}
return empty($orderedTypes) ? [self::DEFAULT_ACCEPT] : array_keys($orderedTypes);
}
/**
* Fetch data from HTTP Request body.
*
* @return array
*/
public function getBodyParams()
{
if (null == $this->_bodyParams) {
$this->_bodyParams = [];
//avoid JSON decoding with empty string
if ($this->getContent()) {
$this->_bodyParams = (array)$this->_getDeserializer()->deserialize((string)$this->getContent());
}
}
return $this->_bodyParams;
}
/**
* Get Content-Type of request.
*
* @return string
* @throws \Magento\Framework\Exception\InputException
*/
public function getContentType()
{
$headerValue = $this->getHeader('Content-Type');
if (!$headerValue) {
throw new \Magento\Framework\Exception\InputException(new Phrase('Content-Type header is empty.'));
}
if (!preg_match('~^([a-z\d/\-+.]+)(?:; *charset=(.+))?$~Ui', $headerValue, $matches)) {
throw new \Magento\Framework\Exception\InputException(new Phrase('Content-Type header is invalid.'));
}
// request encoding check if it is specified in header
if (isset($matches[2]) && self::REQUEST_CHARSET != strtolower($matches[2])) {
throw new \Magento\Framework\Exception\InputException(new Phrase('UTF-8 is the only supported charset.'));
}
return $matches[1];
}
/**
* Retrieve current HTTP method.
*
* @return string
* @throws \Magento\Framework\Exception\InputException
*/
public function getHttpMethod()
{
if (!$this->isGet() && !$this->isPost() && !$this->isPut() && !$this->isDelete()) {
throw new \Magento\Framework\Exception\InputException(new Phrase('Request method is invalid.'));
}
return $this->getMethod();
}
/**
* Fetch and return parameter data from the request.
*
* @return array
*/
public function getRequestData()
{
$requestBodyParams = [];
$params = $this->getParams();
$httpMethod = $this->getMethod();
if ($httpMethod == self::HTTP_METHOD_POST ||
$httpMethod == self::HTTP_METHOD_PUT
) {
$requestBodyParams = $this->getBodyParams();
}
return array_merge($requestBodyParams, $params);
}
/**
* Override request body property value with matching url path parameter value
*
* This method assumes that webapi.xml url defines the substitution parameter as camelCase to the actual
* snake case key described as part of the api contract. example: /:parentId/nestedResource/:entityId.
* Here :entityId value will be used for overriding 'entity_id' property in the body.
* Since Webapi framework allows both camelCase and snakeCase, either of them will be substituted for now.
* If the request body is missing url path parameter as property, it will be added to the body.
* This method works only requests with scalar properties at top level or properties of single object embedded
* in the request body.
* Only the last path parameter value will be substituted from the url in case of multiple parameters.
*
* @param array $urlPathParams url path parameters as array
* @return array
*
* @deprecated 100.1.0
* @see \Magento\Webapi\Controller\Rest\ParamsOverrider::overrideRequestBodyIdWithPathParam
*/
protected function overrideRequestBodyIdWithPathParam($urlPathParams)
{
$requestBodyParams = $this->getBodyParams();
$pathParamValue = end($urlPathParams);
// Self apis should not be overridden
if ($pathParamValue === 'me') {
return $requestBodyParams;
}
$pathParamKey = key($urlPathParams);
// Check if the request data is a top level object of body
if (count($requestBodyParams) == 1 && is_array(end($requestBodyParams))) {
$requestDataKey = key($requestBodyParams);
$this->substituteParameters($requestBodyParams[$requestDataKey], $pathParamKey, $pathParamValue);
} else { // Else parameters passed as scalar values in body will be overridden
$this->substituteParameters($requestBodyParams, $pathParamKey, $pathParamValue);
}
return $requestBodyParams;
}
/**
* Check presence for both camelCase and snake_case keys in array and substitute if either is present
*
* @param array $requestData
* @param string $key
* @param string $value
* @return void
* @deprecated 100.1.0
* @see \Magento\Webapi\Controller\Rest\ParamsOverrider::substituteParameters
*/
protected function substituteParameters(&$requestData, $key, $value)
{
$snakeCaseKey = SimpleDataObjectConverter::camelCaseToSnakeCase($key);
$camelCaseKey = SimpleDataObjectConverter::snakeCaseToCamelCase($key);
if (isset($requestData[$camelCaseKey])) {
$requestData[$camelCaseKey] = $value;
} else {
$requestData[$snakeCaseKey] = $value;
}
}
}