RequestDescription::getTargetResult() - Code Metrics - balint777/POData - Measure and Improve Code Quality continuously with Scrutinizer

RequestDescription::getTargetResult() A
last analyzed 2025-01-15 07:35 UTC

↳ Parent: RequestDescription
Complexity

Conditions	3
Paths	3
Size

Total Lines	10
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	4.679
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
eloc	7
c	2
b	0
f	0
dl	0
loc	10
ccs	3
cts	7
cp	0.4286
rs	10
cc	3
nc	3
nop	0
crap	4.679
<?php

namespace POData\UriProcessor;

use POData\Common\Url;
use POData\Common\ODataConstants;
use POData\Common\Messages;
use POData\Common\MimeTypes;
use POData\Common\Version;
use POData\Common\ODataException;
use POData\IService;
use POData\Providers\Metadata\ResourceProperty;
use POData\Providers\Metadata\ResourceSetWrapper;
use POData\Providers\Metadata\ResourceStreamInfo;
use POData\UriProcessor\UriProcessor;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\SegmentParser;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetSource;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetKind;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\SegmentDescriptor;
use POData\UriProcessor\QueryProcessor\OrderByParser\InternalOrderByInfo;
use POData\UriProcessor\QueryProcessor\SkipTokenParser\InternalSkipTokenInfo;
use POData\UriProcessor\QueryProcessor\ExpressionParser\FilterInfo;
use POData\UriProcessor\QueryProcessor\ExpandProjectionParser\RootProjectionNode;
use POData\Providers\Metadata\ResourceType;
use POData\Providers\Query\QueryType;
/**
 * Class RequestDescription
 * @package POData\UriProcessor
 */
class RequestDescription
{
    /**
     * Holds the value of HTTP 'DataServiceVersion' header in the request,
     * DataServiceVersion header value states the version of the
     * Open Data Protocol used by the client to generate the request.
     * Refer http://www.odata.org/developers/protocols/overview#ProtocolVersioning
     *
     * @var Version
     */
    private $requestVersion = null;

    /**
     * Holds the value of HTTP 'MaxDataServiceVersion' header in the request,
     * MaxDataServiceVersion header value specifies the maximum version number
     * the client can accept in a response.
     * Refer http://www.odata.org/developers/protocols/overview#ProtocolVersioning
     *
     * @var Version
     */
    private $requestMaxVersion = null;

    /**
     * This is the value of 'DataServiceVersion' header to be output in the response. this header
     * value states the OData version the server used to generate the response.
     * While processing the query and result set this value will be keeps on
     * updating, after every update this is compared against the
     * 'MaxDataServiceVersion' header in the client request to see whether the
     * client can interpret the response or not. The client should use this
     * value to determine whether it can correctly interpret the response or not.
     * Refer http://www.odata.org/developers/protocols/overview#ProtocolVersioning
     *
     * @var Version
     */
    private $requiredMinResponseVersion;

    /**
     * The minimum client version requirement, This value keeps getting updated
     * during processing of query, this is compared against the
     * DataServiceVersion header in the client request and if the client request
     * is less than this value then we fail the request (e.g. $count request
     * was sent but client said it was Version 1.0).
     *
     * @var Version
     */
    private $requiredMinRequestVersion;

    /** @var Version */
    private $maxServiceVersion;

    /**
     * Collection of known data service versions.
     *
     * @var Version[]
     */
    private static $_knownDataServiceVersions = null;

    /**
     *
     * @var Url
     */
    private $requestUrl;

    /**
     * Collection of SegmentDescriptor containing information about
     * each segment in the resource path part of the request uri.
     *
     * @var SegmentDescriptor[]
     */
    private $segments;

    /**
     * Holds reference to the last segment descriptor.
     *
     * @var SegmentDescriptor
     */
    private $lastSegment;

    /**
     * The name of the container for results
     *
     * @var string|null
     */
    private $_containerName;


    /**
     * The count option specified in the request.
     *
     * @var string
     */
    public $queryType;

    /**
     * Number of segments.
     *
     * @var int
     */
    private $_segmentCount;

    /**
     * Holds the value of $skip query option, if no $skip option
     * found then this parameter will be NULL.
     *
     * @var int|null
     */
    private $_skipCount;

    /**
     * Holds the value of take count, this value is depends on
     * presence of $top option and configured page size.
     *
     * @var int|null
     */
    private $_topCount;

    /**
     * Holds the value of $top query option, if no $top option
     * found then this parameter will be NULL.
     *
     * @var int|null
     */
    private $_topOptionCount;

    /**
     * Holds the parsed details for sorting, this will
     * be set in 3 cases
     * (1) if $orderby option is specified in the request uri
     * (2) if $skip or $top option is specified in the request uri
     * (3) if server side paging is enabled for the resource
     *     targeted by the request uri.
     *
     * @var InternalOrderByInfo|null
     */
    private $internalOrderByInfo;

    /**
     * Holds the parsed details for $skiptoken option, this will
     * be NULL if $skiptoken option is absent.
     *
     * @var InternalSkipTokenInfo|null
     */
    private $_internalSkipTokenInfo;

    /**
     * Holds the parsed details for $filter option, this will be NULL if $filter option is absent.
     *
     * @var FilterInfo|null
     */
    private $_filterInfo;

    /**
     * Holds reference to the root of the tree describing expand
     * and select information, this field will be NULL if no
     * $expand or $select specified in the request uri.
     *
     * @var RootProjectionNode|null
     */
    private $_rootProjectionNode;

    /**
     * Holds number of entities in the result set, if either $count or
     * $inlinecount=allpages is specified, otherwise NULL
     *
     *
     * @var int|null
     */
    private $_countValue;

    /**
     * Data of request from request body
     *
     * @var array
     */
    private $_data;

    /**
     * Flag indicating status of query execution.
     *
     * @var boolean
     */
    private $_isExecuted;

    /**
     * Reference to Uri processor.
     *
     * @var UriProcessor
     */
    private $_uriProcessor;


    /**
     * Reference to the service
     * @var IService
     */
    private $_service;

    /**
     * The parts of a multipart request
     * @var array
     */
    private $_parts;

    /**
     * The content of the Content-ID header of a request part
     * @var string
     */
    private $_contentId;

    /**
     * The HTTP request method of a request part
     * @var string
     */
    private $_requestMethod;

    /**
     * @param SegmentDescriptor[] $segmentDescriptors Description of segments in the resource path.
     * @param Url $requestUri
     * @param Version $serviceMaxVersion
     * @param null|string $requestVersion
     * @param null|string $maxRequestVersion
     * @param string $dataType
     */
    public function __construct($segmentDescriptors, Url $requestUri, Version $serviceMaxVersion, $requestVersion, $maxRequestVersion, $dataType = null, IService $service = null, $contentId = null, $requestMethod = null)
    {
        $this->segments = $segmentDescriptors;
        $this->_segmentCount = count($this->segments);
        $this->requestUrl = $requestUri;
        $this->lastSegment = $segmentDescriptors[$this->_segmentCount - 1];
        $this->queryType = QueryType::ENTITIES;
        $this->_service = $service;
        $this->_parts = array();

        //we use this for validation checks down in validateVersions...but maybe we should check that outside of this object...
        $this->maxServiceVersion = $serviceMaxVersion;

        //Per OData 1 & 2 spec we must return the smallest size
        //We start at 1.0 and move it up as features are requested
        $this->requiredMinResponseVersion = clone Version::v1();
        $this->requiredMinRequestVersion = clone Version::v1();


        //see http://www.odata.org/documentation/odata-v2-documentation/overview/#ProtocolVersioning
        //if requestVersion isn't there, use Service Max Version
        $this->requestVersion = is_null($requestVersion) ? $serviceMaxVersion : self::parseVersionHeader($requestVersion, ODataConstants::ODATAVERSIONHEADER);

        //if max version isn't there, use the request version
        $this->requestMaxVersion = is_null($maxRequestVersion) ? $this->requestVersion : self::parseVersionHeader($maxRequestVersion, ODataConstants::ODATAMAXVERSIONHEADER);

        //if it's OData v3..things change a bit
        if ($this->maxServiceVersion == Version::v3()) {
            if (is_null($maxRequestVersion))
            {
                //if max request version isn't specified we use the service max version instead of the request version
                //thus we favour newer versions
                $this->requestMaxVersion = $this->maxServiceVersion;
            }

            //also we change min response version to be the max version, again favoring later things
            //note that if the request max version is specified, it is still respected
            $this->requiredMinResponseVersion = clone $this->requestMaxVersion;
        }



        $this->_containerName = null;
        $this->_skipCount = null;
        $this->_topCount = null;
        $this->_topOptionCount = null;
        $this->internalOrderByInfo = null;
        $this->_internalSkipTokenInfo = null;

        $this->_filterInfo = null;
        $this->_countValue = null;
        $this->_isExecuted = false;
        $this->_contentId = $contentId;
        $this->_requestMethod = $requestMethod;

        // Define data from request body
        if ($dataType) {
            $this->_readData($dataType);
        }
    }

    public function getParts() {
        return $this->_parts;
    }

    public function getContentID() {
        return $this->_contentId;
    }

    public function getRequestMethod() {
        return $this->_requestMethod;
    }

    const STATE_PART_START = 'STATE_PART_START';
    const STATE_HTTP_STATUS = 'STATE_HTTP_STATUS';
    const STATE_HEADERS = 'STATE_HEADERS';
    const STATE_BODY = 'STATE_BODY';

    private function _processData(string $string, string $dataType)
    {
        if ($dataType === MimeTypes::MIME_APPLICATION_XML) {
            $data = Xml2Array::createArray($string);
filter:
    dependency_paths: ["lib/*"]
            if (!empty($data['a:entry']['a:content']['m:properties'])) {
                $clearData = $data['a:entry']['a:content']['m:properties'];
                if (is_array($clearData)) {
                    foreach ($clearData as $key => $value) {
                        $this->_data[substr($key, 2)] = $value['@value'];
                    }
                }
            }
        } elseif ($dataType === MimeTypes::MIME_APPLICATION_JSON) {
            $data = json_decode($string, true);
            $this->_data = $data;
        } elseif (explode(';', $dataType)[0] === MimeTypes::MIME_MULTIPART_MIXED) {
            preg_match('/boundary=(.*)$/', $dataType, $matches);
            $boundary = $matches[1];

            // split content by boundary and get rid of last -- element
            $a_blocks = preg_split("/-+$boundary/", $string);
            array_pop($a_blocks);

            // loop data blocks
            foreach ($a_blocks as $id => $block)
            {
                if (empty($block)) {
                                continue;
                }

                $requestMethod = null;
                $requestUrl = null;

                $reader_state = RequestDescription::STATE_PART_START;
                $body = '';
                $headers = [];
                $part_headers = [];

                foreach (explode("\n", $block) as $line) {
                    if (empty($line)) {
                        if ($reader_state == RequestDescription::STATE_PART_START) {
                            $reader_state = RequestDescription::STATE_HTTP_STATUS;
                        } else if ($reader_state == RequestDescription::STATE_HEADERS) {
                            $reader_state = RequestDescription::STATE_BODY;
                            $body = '';
                        }
                        continue;
                    }
                    $m = array();
                    if (in_array($reader_state, [RequestDescription::STATE_HTTP_STATUS, RequestDescription::STATE_HEADERS]) && preg_match('/(?<key>[^:]+):\s*(?<value>.*?)\s*$/', $line, $m)) {
                        if ($reader_state == RequestDescription::STATE_HTTP_STATUS) {
                            $headers[$m['key']] = $m['value'];
                        } else if ($reader_state == RequestDescription::STATE_HEADERS) {
                            $part_headers[$m['key']] = $m['value'];
                        }
                    } else if (preg_match('/^(GET|PUT|POST|PATCH|DELETE)\s+(.*?)(\s+HTTP\/\d\.\d)?\s*$/', $line, $m)) {
                        $requestMethod = trim($m[1]);
                        $requestUrl = new Url(trim($m[2]), false);
                        $reader_state = RequestDescription::STATE_HEADERS;
                    } else if ($reader_state = RequestDescription::STATE_BODY) {
                        $body .= $line . "\n";
                    }
                }

                $host = $this->_service->getHost();
                $absoluteServiceUri = $host->getAbsoluteServiceUri();

                $requestUriSegments = array_slice(
                    $requestUrl->getSegments(),
                    $absoluteServiceUri->getSegmentCount()
                );

                $segments = SegmentParser::parseRequestUriSegments(
                    $requestUriSegments,
                    $this->_service->getProvidersWrapper(),
                    true
                );

                $contentType = $part_headers['Content-Type'] ?? '';

                // you'll have to var_dump $block to understand this and maybe replace \n or \r with a visibile char
                $request = new RequestDescription(
                    $segments,
                    $requestUrl,
                    /** @scrutinizer ignore-type */ $requestUrl,
                    $this->maxServiceVersion,
                    null, // $this->requestVersion,
                    null, // $this->requestMaxVersion,
                    $contentType,
                    null,
                    $headers['Content-ID'] ?? null,
                    $requestMethod
                );

                $request->_setBody($body, $contentType);

                $this->_parts[] = $request;
            }
        }
    }

    /**
     * Define request data from body
     * @param string $dataType
     */
    private function _readData(string $dataType) {
        $this->_data = null;
        $string = file_get_contents('php://input');
        $this->_processData($string, $dataType);
    }

    /**
     * Get request data from body
     */
    private function _setBody(string $string, string $dataType) {
        $this->_data = null;
        $this->_processData($string, $dataType);
    }
    /**
     * Get request data from body
     */
    public function getData() {
        return $this->_data;
    }

    /**
     * Raise the minimum client version requirement for this request and
     * perform capability negotiation.
     *
     * @param int $major The major segment of the version
     * @param int $minor The minor segment of the version
     *
     * @throws ODataException If capability negotiation fails.
     */
    public function raiseMinVersionRequirement($major, $minor) {
        if ($this->requiredMinRequestVersion->raiseVersion($major, $minor))
        {
            $this->validateVersions();
        }
    }

    /**
     * Raise the response version for this request and perform capability negotiation.
     *
     *
     * @param int $major The major segment of the version
     * @param int $minor The minor segment of the version
     *
     * @throws ODataException If capability negotiation fails.
     */
    public function raiseResponseVersion($major, $minor) {
        if ($this->requiredMinResponseVersion->raiseVersion($major, $minor)) {
            $this->validateVersions();
        }

    }

    /**
     * Gets collection of segment descriptors containing information about
     * each segment in the resource path part of the request uri.
     *
     * @return SegmentDescriptor[]
     */
    public function getSegments()
    {
        return $this->segments;
    }

    /**
     * Gets reference to the descriptor of last segment.
     *
     * @return SegmentDescriptor
     */
    public function getLastSegment()
    {
        return $this->lastSegment;
    }

    /**
     * Gets kind of resource targeted by the resource path.
     *
     * @return int
     */
    public function getTargetKind()
    {
        return $this->lastSegment->getTargetKind();
    }

    /**
     * Gets kind of 'source of data' targeted by the resource path.
     *
     * @return int
     */
    public function getTargetSource()
    {
        /*
        if (!empty($this->_parts)) {
            $results = array();
            foreach ($this->_parts as &$part) {
                $results[] = $part->lastSegment->getTargetSource();
            }
            return $results;
        }
        */
        return $this->lastSegment->getTargetSource();
    }

    /**
     * Gets reference to the ResourceSetWrapper instance targeted by
     * the resource path, ResourceSetWrapper will present in the
     * following cases:
     * if the last segment descriptor describes
     *      (a) resource set
     *          http://server/NW.svc/Customers
     *          http://server/NW.svc/Customers('ALFKI')
     *          http://server/NW.svc/Customers('ALFKI')/Orders
     *          http://server/NW.svc/Customers('ALFKI')/Orders(123)
     *          http://server/NW.svc/Customers('ALFKI')/$links/Orders
     *      (b) resource set reference
     *          http://server/NW.svc/Orders(123)/Customer
     *          http://server/NW.svc/Orders(123)/$links/Customer
     *      (c) $count
     *          http://server/NW.svc/Customers/$count
     * ResourceSet wrapper will be absent (NULL) in the following cases:
     * if the last segment descriptor describes
     *      (a) Primitive
     *          http://server/NW.svc/Customers('ALFKI')/Country
     *      (b) $value on primitive type
     *          http://server/NW.svc/Customers('ALFKI')/Country/$value
     *      (c) Complex
     *          http://server/NW.svc/Customers('ALFKI')/Address
     *      (d) Bag
     *          http://server/NW.svc/Employees(123)/Emails
     *      (e) MLE
     *          http://server/NW.svc/Employees(123)/$value
     *      (f) Named Stream
     *          http://server/NW.svc/Employees(123)/Thumnail48_48
     *      (g) metadata
     *          http://server/NW.svc/$metadata
     *      (h) service directory
     *          http://server/NW.svc
     *      (i) $bath
     *          http://server/NW.svc/$batch
     *
     * @return ResourceSetWrapper|null
     */
    public function getTargetResourceSetWrapper()
    {
        return $this->lastSegment->getTargetResourceSetWrapper();
    }

    /**
     * Gets reference to the ResourceType instance targeted by
     * the resource path, ResourceType will present in the
     * following cases:
     * if the last segment descriptor describes
     *      (a) resource set
     *          http://server/NW.svc/Customers
     *          http://server/NW.svc/Customers('ALFKI')
     *          http://server/NW.svc/Customers('ALFKI')/Orders
     *          http://server/NW.svc/Customers('ALFKI')/Orders(123)
     *          http://server/NW.svc/Customers('ALFKI')/$links/Orders
     *      (b) resource set reference
     *          http://server/NW.svc/Orders(123)/Customer
     *          http://server/NW.svc/Orders(123)/$links/Customer
     *      (c) $count
     *          http://server/NW.svc/Customers/$count
     *      (d) Primitive
     *          http://server/NW.svc/Customers('ALFKI')/Country
     *      (e) $value on primitive type
     *          http://server/NW.svc/Customers('ALFKI')/Country/$value
     *      (f) Complex
     *          http://server/NW.svc/Customers('ALFKI')/Address
     *      (g) Bag
     *          http://server/NW.svc/Employees(123)/Emails
     *      (h) MLE
     *          http://server/NW.svc/Employees(123)/$value
     *      (i) Named Stream
     *          http://server/NW.svc/Employees(123)/Thumnail48_48
     * ResourceType will be absent (NULL) in the following cases:
     * if the last segment descriptor describes
     *      (a) metadata
     *          http://server/NW.svc/$metadata
     *      (b) service directory
     *          http://server/NW.svc
     *      (c) $bath
     *          http://server/NW.svc/$batch
     *
     * @return ResourceType|null
     */
    public function getTargetResourceType()
    {
        return $this->lastSegment->getTargetResourceType();
    }

    /**
     * Gets reference to the ResourceProperty instance targeted by
     * the resource path, ResourceProperty will present in the
     * following cases:
     * if the last segment descriptor describes
     *      (a) resource set (after 1 level)
     *          http://server/NW.svc/Customers('ALFKI')/Orders
     *          http://server/NW.svc/Customers('ALFKI')/Orders(123)
     *          http://server/NW.svc/Customers('ALFKI')/$links/Orders
     *      (b) resource set reference
     *          http://server/NW.svc/Orders(123)/Customer
     *          http://server/NW.svc/Orders(123)/$links/Customer
     *      (c) $count
     *          http://server/NW.svc/Customers/$count
     *      (d) Primitive
     *          http://server/NW.svc/Customers('ALFKI')/Country
     *      (e) $value on primitive type
     *          http://server/NW.svc/Customers('ALFKI')/Country/$value
     *      (f) Complex
     *          http://server/NW.svc/Customers('ALFKI')/Address
     *      (g) Bag
     *          http://server/NW.svc/Employees(123)/Emails
     *      (h) MLE
     *          http://server/NW.svc/Employees(123)/$value
     *
     * ResourceType will be absent (NULL) in the following cases:
     * if the last segment descriptor describes
     *      (a) If last segment is the only segment pointing to
     *          ResourceSet (single or multiple)
     *          http://server/NW.svc/Customers
     *          http://server/NW.svc/Customers('ALFKI')
     *      (b) Named Stream
     *          http://server/NW.svc/Employees(123)/Thumnail48_48
     *      (c) metadata
     *          http://server/NW.svc/$metadata
     *      (d) service directory
     *          http://server/NW.svc
     *      (e) $bath
     *          http://server/NW.svc/$batch
     *
     * @return ResourceProperty|null
     */
    public function getProjectedProperty()
    {
        return  $this->lastSegment->getProjectedProperty();
    }

    /**
     * Gets the name of the container for results.
     *
     * @return string|null
     */
    public function getContainerName()
    {
        return $this->_containerName;
    }

    /**
     * Sets the name of the container for results.
     *
     * @param string $containerName The container name.
     *
     * @return void
     */
    public function setContainerName($containerName)
    {
        $this->_containerName = $containerName;
    }

    /**
     * Whether thr request targets a single result or not.
     *
     * @return boolean
     */
    public function isSingleResult()
    {
        return $this->lastSegment->isSingleResult();
    }

    /**
     * Gets the identifier associated with the the resource path.
     *
     * @return string
     */
    public function getIdentifier()
    {
        return $this->lastSegment->getIdentifier();
    }

    /**
     * Gets the request uri.
     *
     * @return Url
     */
    public function getRequestUrl()
    {
        return $this->requestUrl;
    }

    /**
     * Gets the value of $skip query option
     *
     * @return int|null The value of $skip query option, NULL if $skip is absent.
     *
     */
    public function getSkipCount()
    {
        return $this->_skipCount;
    }

    /**
     * Sets skip value
     *
     * @param int $skipCount The value of $skip query option.
     *
     * @return void
     */
    public function setSkipCount($skipCount)
    {
        $this->_skipCount = $skipCount;
    }

    /**
     * Gets the value of take count
     *
     * @return int|null The value of take, NULL if no take to be applied.
     *
     */
    public function getTopCount()
    {
        return $this->_topCount;
    }

    /**
     * Sets the value of take count
     *
     * @param int $topCount The value of take query option
     *
     * @return void
     */
    public function setTopCount($topCount)
    {
        $this->_topCount = $topCount;
    }

    /**
     * Gets the value of $top query option
     *
     * @return int|null The value of $top query option, NULL if $top is absent.
     *
     */
    public function getTopOptionCount()
    {
        return $this->_topOptionCount;
    }

    /**
     * Sets top value
     *
     * @param int $topOptionCount The value of $top query option
     *
     * @return void
     */
    public function setTopOptionCount($topOptionCount)
    {
        $this->_topOptionCount = $topOptionCount;
    }

    /**
     * Gets sorting (orderby) information, this function return
     * sorting information in 3 cases:
     * (1) if $orderby option is specified in the request uri
     * (2) if $skip or $top option is specified in the request uri
     * (3) if server side paging is enabled for the resource targeted
     *     by the request uri.
     *
     * @return InternalOrderByInfo|null
     */
    public function getInternalOrderByInfo()
    {
        return $this->internalOrderByInfo;
    }

    /**
     * Sets sorting (orderby) information.
     *
     * @param InternalOrderByInfo &$internalOrderByInfo The sorting information.
     *
     * @return void
     */
    public function setInternalOrderByInfo(InternalOrderByInfo &$internalOrderByInfo)
    {
        $this->internalOrderByInfo = $internalOrderByInfo;
    }

    /**
     * Gets the parsed details for $skiptoken option.
     *
     * @return InternalSkipTokenInfo|null Returns parsed details of $skiptoken option, NULL if $skiptoken is absent.
     *
     */
    public function getInternalSkipTokenInfo()
    {
        return $this->_internalSkipTokenInfo;
    }

    /**
     * Sets $skiptoken information.
     *
     * @param InternalSkipTokenInfo &$internalSkipTokenInfo The paging information.
     *
     * @return void
     */
    public function setInternalSkipTokenInfo(
        InternalSkipTokenInfo &$internalSkipTokenInfo
    ) {
        $this->_internalSkipTokenInfo = $internalSkipTokenInfo;
    }

    /**
     *
     * @return FilterInfo|null Returns parsed details of $filter option, NULL if $filter is absent.
     *
     */
    public function getFilterInfo()
    {
        return $this->_filterInfo;
    }

    /**
     *
     * @param FilterInfo $filterInfo The filter information.
     *
     */
    public function setFilterInfo(FilterInfo $filterInfo)
    {
        $this->_filterInfo = $filterInfo;
    }

    /**
     * Sets $expand and $select information.
     *
     * @param RootProjectionNode &$rootProjectionNode Root of the projection tree.
     *
     * @return void
     */
    public function setRootProjectionNode(RootProjectionNode &$rootProjectionNode)
    {
        $this->_rootProjectionNode = $rootProjectionNode;
    }

    /**
     * Gets the root of the tree describing expand and select options,
     *
     * @return RootProjectionNode|null Returns parsed details of $expand
     *                                 and $select options, NULL if
     *                                 $both options are absent.
     */
    public function getRootProjectionNode()
    {
        return $this->_rootProjectionNode;
    }


    /**
     * Gets the count of result set if $count or $inlinecount=allpages
     * has been applied otherwise NULL
     *
     * @return int|null
     */
    public function getCountValue()
    {
        return $this->_countValue;
    }

    /**
     * Sets the count of result set.
     *
     * @param int $countValue The count value.
     *
     * @return void
     */
    public function setCountValue($countValue)
    {
        $this->_countValue = $countValue;
    }

    /**
     * To set the flag indicating the execution status as true.
     *
     * @return void
     */
    public function setExecuted()
    {
        $this->_isExecuted = true;
    }

    /**
     * To check whether to execute the query using IDSQP.
     *
     * @return boolean True if query need to be executed, False otherwise.
     */
    public function needExecution()
    {
        return !$this->_isExecuted
            && ($this->lastSegment->getTargetKind() != TargetKind::METADATA)
            && ($this->lastSegment->getTargetKind() != TargetKind::SERVICE_DIRECTORY);
    }

    /**
     * To check if the resource path is a request for link uri.
     *
     * @return boolean True if request is for link uri else false.
     */
    public function isLinkUri()
    {
        return (($this->_segmentCount > 2) && ($this->segments[$this->_segmentCount - 2]->getTargetKind() == TargetKind::LINK));
    }

    /**
     * To check if the resource path is a request for meida resource
     *
     * @return boolean True if request is for media resource else false.
     */
    public function isMediaResource()
    {
        return ($this->lastSegment->getTargetKind() == TargetKind::MEDIA_RESOURCE);
    }

    /**
     * To check if the resource path is a request for named stream
     *
     * @return boolean True if request is for named stream else false.
     */
    public function isNamedStream()
    {
        return $this->isMediaResource() && !($this->lastSegment->getIdentifier() === ODataConstants::URI_VALUE_SEGMENT);
    }

    /**
     * Get ResourceStreamInfo for the media link entry or named stream request.
     *
     * @return ResourceStreamInfo|null Instance of ResourceStreamInfo if the
     *         current request targets named stream, NULL for MLE
     */
    public function getResourceStreamInfo()
    {
        //assert($this->isMediaResource)
        if ($this->isNamedStream()) {
            return $this->getTargetResourceType()
                ->tryResolveNamedStreamByName(
                    $this->lastSegment->getIdentifier()
                );
        }

        return null;
    }

    /**
     * Gets the resource instance targeted by the request uri.
     * Note: This value will be populated after query execution only.
     *
     * @return mixed
     */
    public function getTargetResult()
    {
        if (!empty($this->_parts)) {
            $results = array();
            foreach ($this->_parts as &$part) {
                $results[] = $part->lastSegment->getResult();
            }
            return $results;
        } else {
            return $this->lastSegment->getResult();
        }
    }

    /**
     * Gets the OData version the server used to generate the response.
     *
     * @return Version
     */
    public function getResponseVersion()
    {

        return $this->requiredMinResponseVersion;
    }

    /**
     * Checks whether etag headers are allowed for this request.
     *
     * @return boolean True if ETag header (If-Match or If-NoneMatch)
     *                 is allowed for the request, False otherwise.
     */
    public function isETagHeaderAllowed()
    {
        return $this->lastSegment->isSingleResult()
            && ($this->queryType != QueryType::COUNT)
            && !$this->isLinkUri()
            && (is_null($this->_rootProjectionNode)
                || !($this->_rootProjectionNode->isExpansionSpecified())
                );
    }

    /**
     * Gets collection of known data service versions, currently 1.0, 2.0 and 3.0.
     *
     * @return Version[]
     */
    public static function getKnownDataServiceVersions()
    {
        if (is_null(self::$_knownDataServiceVersions)) {

            self::$_knownDataServiceVersions = array(
                new Version(1, 0),
                new Version(2, 0),
                new Version(3, 0)
            );
        }

        return self::$_knownDataServiceVersions;
    }

    /**
     * This function is used to perform following checking (validation)
     * for capability negotiation.
     *  (1) Check client request's 'DataServiceVersion' header value is
     *      less than or equal to the minimum version required to intercept
     *      the response
     *  (2) Check client request's 'MaxDataServiceVersion' header value is
     *      less than or equal to the version of protocol required to generate
     *      the response
     *  (3) Check the configured maximum protocol version is less than or equal
     *      to the version of protocol required to generate the response
     *  In addition to these checking, this function is also responsible for
     *  initializing the properties representing 'DataServiceVersion' and
     *  'MaxDataServiceVersion'.
     *
     *
     * @throws ODataException If any of the above 3 check fails.
     */
    public function validateVersions() {

        //If the request version is below the minimum version required by supplied request arguments..throw an exception
        if ($this->requestVersion->compare($this->requiredMinRequestVersion) < 0) {
            throw ODataException::createBadRequestError(
                Messages::requestVersionTooLow(
                    $this->requestVersion->toString(),
                    $this->requiredMinRequestVersion->toString()
                )
            );
        }

        //If the requested max version is below the version required to fulfill the response...throw an exception
        if ($this->requestMaxVersion->compare($this->requiredMinResponseVersion) < 0) {
            throw ODataException::createBadRequestError(
                Messages::requestVersionTooLow(
                    $this->requestMaxVersion->toString(),
                    $this->requiredMinResponseVersion->toString()
                )
            );
        }

        //If the max version supported by the service is below the version required to fulfill the response..throw an exception
        if ($this->maxServiceVersion->compare($this->requiredMinResponseVersion) < 0) {
            throw ODataException::createBadRequestError(
                Messages::requestVersionIsBiggerThanProtocolVersion(
                    $this->requiredMinResponseVersion->toString(),
                    $this->maxServiceVersion->toString()
                )
            );
        }
    }

    /**
     * Validates the given version in string format and returns the version as instance of Version
     *
     * @param string $versionHeader The DataServiceVersion or MaxDataServiceVersion header value
     * @param string $headerName    The name of the header
     *
     * @return Version
     *
     * @throws ODataException If the version is malformed or not supported
     */
    private static function parseVersionHeader($versionHeader, $headerName)
    {
        $libName = null;

        $versionHeader = trim($versionHeader);
        $libNameIndex = strpos($versionHeader, ';');
        if ($libNameIndex !== false) {
            $libName = substr($versionHeader, $libNameIndex);
        } else {
            $libNameIndex = strlen($versionHeader);
        }

        $dotIndex = -1;
        for ($i = 0; $i < $libNameIndex; $i++) {
            if ($versionHeader[$i] == '.') {

                //Throw an exception if we find more than 1 dot
                if ($dotIndex != -1) {
                    throw ODataException::createBadRequestError(
                        Messages::requestDescriptionInvalidVersionHeader(
                            $versionHeader,
                            $headerName
                        )
                    );
                }

                $dotIndex = $i;
            } else if ($versionHeader[$i] < '0' || $versionHeader[$i] > '9') {
                throw ODataException::createBadRequestError(
                    Messages::requestDescriptionInvalidVersionHeader(
                        $versionHeader,
                        $headerName
                    )
                );
            }
        }


        $major = intval(substr($versionHeader, 0, $dotIndex));
        $minor = 0;

        //Apparently the . is optional
        if ($dotIndex != -1) {
            if ($dotIndex == 0) {
                //If it starts with a ., throw an exception
                throw ODataException::createBadRequestError(
                    Messages::requestDescriptionInvalidVersionHeader(
                        $versionHeader,
                        $headerName
                    )
                );
            }
            $minor = intval(substr($versionHeader, $dotIndex + 1, $libNameIndex));
        }


        $version = new Version($major, $minor);

        //TODO: move this somewhere...
        $isSupportedVersion = false;
        foreach (self::getKnownDataServiceVersions() as $version1) {
            if ($version->compare($version1) == 0) {
                $isSupportedVersion = true;
                break;
            }
        }

        if (!$isSupportedVersion) {
            $availableVersions = null;
            foreach (self::getKnownDataServiceVersions() as $version1) {
                $availableVersions .= $version1->toString() . ', ';
            }

            $availableVersions = rtrim($availableVersions, ', ');
            $availableVersions = rtrim(/** @scrutinizer ignore-type */ $availableVersions, ', ');
            throw ODataException::createBadRequestError(
                Messages::requestDescriptionUnSupportedVersion(
                    $headerName,
                    $versionHeader,
                    $availableVersions
                )
            );
        }

        return $version;
    }

    /**
     * Gets reference to the UriProcessor instance.
     *
     * @return UriProcessor
     */
    public function getUriProcessor()
    {
        return $this->_uriProcessor;
    }

    /**
     * Set reference to UriProcessor instance.
     *
     * @param UriProcessor $uriProcessor Reference to the UriProcessor
     *
     * @return void
     */
    public function setUriProcessor(UriProcessor $uriProcessor)
    {
        $this->_uriProcessor = $uriProcessor;
    }

    public function getQueryStringItem(string $item)
    {
        return $this->requestUrl->getQueryStringItem($item);
    }
}

balint777 / POData

RequestDescription::getTargetResult() A last analyzed 2025-01-15 07:35 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RequestDescription::getTargetResult() A
last analyzed 2025-01-15 07:35 UTC
