OrderByParser::createOrderInfo() - Code Metrics - Algo-Web/POData - Measure and Improve Code Quality continuously with Scrutinizer

OrderByParser::createOrderInfo() B
last analyzed 2023-09-17 09:46 UTC

↳ Parent: OrderByParser

Complexity

Conditions	7
Paths	5

Size

Total Lines	36
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	22
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	36
rs	8.6346

<?php

declare(strict_types=1);

namespace POData\UriProcessor\QueryProcessor\OrderByParser;

use POData\Common\InvalidOperationException;
use POData\Common\Messages;
use POData\Common\ODataException;
use POData\Common\ReflectionHandler;
use POData\Providers\Metadata\ResourceEntityType;
use POData\Providers\Metadata\ResourceProperty;
use POData\Providers\Metadata\ResourcePropertyKind;
use POData\Providers\Metadata\ResourceSetWrapper;
use POData\Providers\Metadata\ResourceType;
use POData\Providers\Metadata\Type\Binary;
use POData\Providers\ProvidersWrapper;
use POData\UriProcessor\QueryProcessor\ExpressionParser\ExpressionLexer;
use POData\UriProcessor\QueryProcessor\ExpressionParser\ExpressionTokenId;
use ReflectionClass;
use ReflectionException;

/**
 * Class OrderByParser.
 *
 * Class to parse $orderby query option and perform syntax validation
 * and build 'OrderBy Tree' along with next level of validation, the
 * created tree is used for building sort functions and 'OrderByInfo' structure.
 *
 * The syntax of orderby clause is:
 *
 * OrderByClause         : OrderByPathSegment [, OrderByPathSegment]*
 * OrderByPathSegment    : OrderBySubPathSegment[/OrderBySubPathSegment]*[asc|desc]?
 * OrderBySubPathSegment : identifier
 */
class OrderByParser
{
    /**
     * Collection of anonymous sorter function corresponding to each orderby path segment.
     *
     * @var callable[]
     */
    private $comparisonFunctions = [];

    /**
     * The top level sorter function generated from orderby path segments.
     *
     * @var callable
     */
    private $topLevelComparisonFunction;

    /**
     * The structure holds information about the navigation properties
     * used in the orderby clause (if any), and orderby path if IDSQP
     * implementor want to perform sorting.
     *
     * @var OrderByInfo
     */
    private $orderByInfo;

    /**
     * Reference to metadata and query provider wrapper.
     *
     * @var ProvidersWrapper
     */
    private $providerWrapper;

    /**
     * This object will be of type of the resource set identified by the request uri.
     *
     * @var mixed
     */
    private $dummyObject;

    /**
     * Root node for tree ordering.
     *
     * @var OrderByNode
     */
    private $rootOrderByNode;

    /**
     * Creates new instance of OrderByParser.
     *
     * @param ProvidersWrapper $providerWrapper Reference to metadata
     *                                          and query provider
     *                                          wrapper
     */
    private function __construct(ProvidersWrapper $providerWrapper)
    {
        $this->providerWrapper = $providerWrapper;
    }

    /**
     * This function perform the following tasks with the help of internal helper
     * functions
     * (1) Read the orderby clause and perform basic syntax checks
     * (2) Build 'Order By Tree', creates anonymous sorter function for each leaf node and check for error
     * (3) Build 'OrderInfo' structure, holds information about the navigation
     *     properties used in the orderby clause (if any) and orderby path if
     *     IDSQP implementor want to perform sorting
     * (4) Build top level anonymous sorter function
     * (4) Release resources hold by the 'Order By Tree'
     * (5) Create 'InternalOrderInfo' structure, which wraps 'OrderInfo' and top
     *     level sorter function.
     *
     * @param ResourceSetWrapper $resourceSetWrapper ResourceSetWrapper for the resource targeted by resource path
     * @param ResourceType       $resourceType       ResourceType for the resource targeted by resource path
     * @param string             $orderBy            The orderby clause
     * @param ProvidersWrapper   $providerWrapper    Reference to the wrapper for IDSQP and IDSMP impl
     *
     * @throws InvalidOperationException
     * @throws ReflectionException
     * @throws ODataException            If any error occur while parsing orderby clause
     * @return InternalOrderByInfo
     */
    public static function parseOrderByClause(
        ResourceSetWrapper $resourceSetWrapper,
        ResourceType $resourceType,
        string $orderBy,
        ProvidersWrapper $providerWrapper
    ): InternalOrderByInfo {
        if (0 == strlen(trim($orderBy))) {
            throw new InvalidOperationException('OrderBy clause must not be trimmable to an empty string');
        }
        $orderByParser = new self($providerWrapper);
        try {
            $instance = $resourceType->getInstanceType();
            assert($instance instanceof ReflectionClass, get_class($instance));
            $orderByParser->dummyObject = $instance->newInstanceArgs([]);
        } catch (ReflectionException $reflectionException) {
            throw ODataException::createInternalServerError(Messages::orderByParserFailedToCreateDummyObject());
        }
        $orderByParser->rootOrderByNode = new OrderByRootNode($resourceSetWrapper, $resourceType);
        $orderByPathSegments            = $orderByParser->readOrderBy($orderBy);

        $orderByParser->buildOrderByTree($orderByPathSegments);
        $orderByParser->createOrderInfo($orderByPathSegments);
        $orderByParser->generateTopLevelComparisonFunction();
        //Recursively release the resources
        $orderByParser->rootOrderByNode->free();
        //creates internal order info wrapper
        $internalOrderInfo = new InternalOrderByInfo(
            $orderByParser->orderByInfo,
            $orderByParser->comparisonFunctions,
            $orderByParser->topLevelComparisonFunction,
            $orderByParser->dummyObject,
            $resourceType
        );
        unset($orderByParser->orderByInfo);
        unset($orderByParser->topLevelComparisonFunction);

        return $internalOrderInfo;
    }

    /**
     * Read orderby clause.
     *
     * @param string $value orderby clause to read
     *
     * @throws ODataException If any syntax error found while reading the clause
     * @return array<array>   An array of 'OrderByPathSegment's, each of which
     *                        is array of 'OrderBySubPathSegment's
     */
    private function readOrderBy(string $value): array
    {
        $orderByPathSegments = [];
        $lexer               = new ExpressionLexer($value);
        $i                   = 0;
        while ($lexer->getCurrentToken()->getId() != ExpressionTokenId::END()) {
            $orderBySubPathSegment = $lexer->readDottedIdentifier();
            if (!array_key_exists($i, $orderByPathSegments)) {
                $orderByPathSegments[$i] = [];
            }

            $orderByPathSegments[$i][] = $orderBySubPathSegment;
            $tokenId                   = $lexer->getCurrentToken()->getId();
            if ($tokenId != ExpressionTokenId::END()) {
                if ($tokenId != ExpressionTokenId::SLASH()) {
                    if ($tokenId != ExpressionTokenId::COMMA()) {
                        $lexer->validateToken(ExpressionTokenId::IDENTIFIER());
                        $identifier = $lexer->getCurrentToken()->Text;
                        if ($identifier !== 'asc' && $identifier !== 'desc') {
                            // force lexer to throw syntax error as we found
                            // unexpected identifier
                            $lexer->validateToken(ExpressionTokenId::DOT());
                        }

                        $orderByPathSegments[$i][] = '*' . $identifier;
                        $lexer->nextToken();
                        $tokenId = $lexer->getCurrentToken()->getId();
                        if ($tokenId != ExpressionTokenId::END()) {
                            $lexer->validateToken(ExpressionTokenId::COMMA());
                            ++$i;
                        }
                    } else {
                        ++$i;
                    }
                }

                $lexer->nextToken();
            }
        }

        return $orderByPathSegments;
    }

    /**
     * Build 'OrderBy Tree' from the given orderby path segments, also build
     * comparison function for each path segment.
     *
     * @param array(array) &$orderByPathSegments Collection of orderby path segments,
     *                                           this is passed by reference
     *                                           since we need this function to
     *                                           modify this array in two cases:
     *                                           1. if asc or desc present, then the
     *                                           corresponding sub path segment
     *                                           should be removed
     *                                           2. remove duplicate orderby path
     *                                           segment
     *
     * @throws ReflectionException
     * @throws ODataException      If any error occurs while processing the orderby path segments
     * @return mixed
     */
    private function buildOrderByTree(array &$orderByPathSegments)
    {
        foreach ($orderByPathSegments as $index1 => &$orderBySubPathSegments) {
            /** @var OrderByNode $currentNode */
            $currentNode   = $this->rootOrderByNode;
            $currentObject = $this->dummyObject;
            $ascending     = true;
            $subPathCount  = count($orderBySubPathSegments);
            // Check sort order is specified in the path, if so set a
            // flag and remove that segment
            if ($subPathCount > 1) {
                if ('*desc' === $orderBySubPathSegments[$subPathCount - 1]) {
                    $ascending = false;
                    unset($orderBySubPathSegments[$subPathCount - 1]);
                    --$subPathCount;
                } elseif ('*asc' === $orderBySubPathSegments[$subPathCount - 1]) {
                    unset($orderBySubPathSegments[$subPathCount - 1]);
                    --$subPathCount;
                }
            }
            $ancestors = [$this->rootOrderByNode->getResourceSetWrapper()->getName()];
            foreach ($orderBySubPathSegments as $index2 => $orderBySubPathSegment) {
                $isLastSegment      = ($index2 == $subPathCount - 1);
                $resourceSetWrapper = null;
                /** @var ResourceEntityType $resourceType */
                $resourceType = $currentNode->getResourceType();
                /** @var ResourceProperty $resourceProperty */
                $resourceProperty = $resourceType->resolveProperty($orderBySubPathSegment);
                if (null === $resourceProperty) {
                    throw ODataException::createSyntaxError(
                        Messages::orderByParserPropertyNotFound(
                            $resourceType->getFullName(),
                            $orderBySubPathSegment
                        )
                    );
                }
                /** @var ResourcePropertyKind $rKind */
                $rKind   = $resourceProperty->getKind();
                $rawKind = ($rKind instanceof ResourcePropertyKind) ? $rKind : $rKind;

                if ($resourceProperty->isKindOf(ResourcePropertyKind::BAG())) {
                    throw ODataException::createBadRequestError(
                        Messages::orderByParserBagPropertyNotAllowed(
                            $resourceProperty->getName()
                        )
                    );
                } elseif ($resourceProperty->isKindOf(ResourcePropertyKind::PRIMITIVE())) {
                    if (!$isLastSegment) {
                        throw ODataException::createBadRequestError(
                            Messages::orderByParserPrimitiveAsIntermediateSegment(
                                $resourceProperty->getName()
                            )
                        );
                    }

                    $type = $resourceProperty->getInstanceType();
                    if ($type instanceof Binary) {
                        throw ODataException::createBadRequestError(
                            Messages::orderByParserSortByBinaryPropertyNotAllowed($resourceProperty->getName())
                        );
                    }
                } elseif ($rawKind == ResourcePropertyKind::RESOURCESET_REFERENCE()
                    || $rawKind == ResourcePropertyKind::RESOURCE_REFERENCE()
                ) {
                    $this->assertion($currentNode instanceof OrderByRootNode || $currentNode instanceof OrderByNode);
                    $resourceSetWrapper = $currentNode->getResourceSetWrapper();
                    $this->assertion(null !== $resourceSetWrapper);
                    $resourceSetWrapper
                        = $this->providerWrapper->getResourceSetWrapperForNavigationProperty(
                            $resourceSetWrapper,
                            $resourceType,
                            $resourceProperty
                        );
                    if (null === $resourceSetWrapper) {
                        throw ODataException::createBadRequestError(
                            Messages::badRequestInvalidPropertyNameSpecified(
                                $resourceType->getFullName(),
                                $orderBySubPathSegment
                            )
                        );
                    }

                    if ($rKind == ResourcePropertyKind::RESOURCESET_REFERENCE()) {
                        throw ODataException::createBadRequestError(
                            Messages::orderByParserResourceSetReferenceNotAllowed(
                                $resourceProperty->getName(),
                                $resourceType->getFullName()
                            )
                        );
                    }

                    $resourceSetWrapper->checkResourceSetRightsForRead(true);
                    if ($isLastSegment) {
                        throw ODataException::createBadRequestError(
                            Messages::orderByParserSortByNavigationPropertyIsNotAllowed(
                                $resourceProperty->getName()
                            )
                        );
                    }

                    $ancestors[] = $orderBySubPathSegment;
                } elseif ($resourceProperty->isKindOf(ResourcePropertyKind::COMPLEX_TYPE())) {
                    if ($isLastSegment) {
                        throw ODataException::createBadRequestError(
                            Messages::orderByParserSortByComplexPropertyIsNotAllowed(
                                $resourceProperty->getName()
                            )
                        );
                    }

                    $ancestors[] = $orderBySubPathSegment;
                } else {
                    throw ODataException::createInternalServerError(
                        Messages::orderByParserUnexpectedPropertyType()
                    );
                }

                $node = $currentNode->findNode($orderBySubPathSegment);
                if (null === $node) {
                    if ($resourceProperty->isKindOf(ResourcePropertyKind::PRIMITIVE())) {
                        $node = new OrderByLeafNode(
                            $orderBySubPathSegment,
                            $resourceProperty,
                            $ascending
                        );
                        $this->comparisonFunctions[] = $node->buildComparisonFunction($ancestors);
                    } elseif ($resourceProperty->getKind() == ResourcePropertyKind::RESOURCE_REFERENCE()) {
                        $node = new OrderByNode(
                            $orderBySubPathSegment,
                            $resourceProperty,
                            $resourceSetWrapper
                        );
                        // Initialize this member variable (identified by
                        // $resourceProperty) of parent object.
                        try {
                            $instance = $resourceProperty->getInstanceType();
                            assert($instance instanceof ReflectionClass, get_class($instance));
                            $object = $instance->newInstanceArgs();
                            $resourceType->setPropertyValue($currentObject, $resourceProperty->getName(), $object);
                            $currentObject = $object;
                        } catch (ReflectionException $reflectionException) {
                            $this->throwBadAccessOrInitException($resourceProperty, $resourceType);
                        }
                    } elseif ($resourceProperty->getKind() == ResourcePropertyKind::COMPLEX_TYPE()) {
                        $node = new OrderByNode($orderBySubPathSegment, $resourceProperty, null);
                        // Initialize this member variable
                        // (identified by $resourceProperty)of parent object.
                        try {
                            $instance = $resourceProperty->getInstanceType();
                            assert($instance instanceof ReflectionClass, get_class($instance));
                            $object = $instance->newInstanceArgs();
                            $resourceType->setPropertyValue($currentObject, $resourceProperty->getName(), $object);
                            $currentObject = $object;
                        } catch (ReflectionException $reflectionException) {
                            $this->throwBadAccessOrInitException($resourceProperty, $resourceType);
                        }
                    }

                    $currentNode->addNode($node);
                } else {
                    try {
                        $currentObject = ReflectionHandler::getProperty($currentObject, $resourceProperty->getName());
                    } catch (ReflectionException $reflectionException) {
                        $this->throwBadAccessOrInitException($resourceProperty, $resourceType);
                    }

                    if ($node instanceof OrderByLeafNode) {
                        //remove duplicate orderby path
                        unset($orderByPathSegments[$index1]);
                    }
                }

                $currentNode = $node;
            }
        }
        return null;
    }

    /**
     * Assert that the given condition is true, if false throw ODataException for unexpected state.
     *
     * @param bool $condition The condition to assert
     *
     * @throws ODataException
     */
    private function assertion(bool $condition): void
    {
        if (!$condition) {
            throw ODataException::createInternalServerError(Messages::orderByParserUnExpectedState());
        }
    }

    /**
     * @param  ResourceProperty $resourceProperty
     * @param  ResourceType     $resourceType
     * @throws ODataException
     */
    private function throwBadAccessOrInitException(
        ResourceProperty $resourceProperty,
        ResourceType $resourceType
    ): void {
        throw ODataException::createInternalServerError(
            Messages::orderByParserFailedToAccessOrInitializeProperty(
                $resourceProperty->getName(),
                $resourceType->getName()
            )
        );
    }

    /**
     * Traverse 'Order By Tree' and create 'OrderInfo' structure.
     *
     * @param array<array> $orderByPaths The orderby paths
     *
     * @throws ODataException If parser finds an inconsistent-tree state, throws unexpected state error
     * @return void
     */
    private function createOrderInfo(array $orderByPaths): void
    {
        $orderByPathSegments           = [];
        $navigationPropertiesInThePath = [];
        foreach ($orderByPaths as $index => $orderBySubPaths) {
            /** @var OrderByNode $currentNode */
            $currentNode            = $this->rootOrderByNode;
            $orderBySubPathSegments = [];
            foreach ($orderBySubPaths as $orderBySubPath) {
                /** @var OrderByNode $node */
                $node = $currentNode->findNode($orderBySubPath);
                $this->assertion(null !== $node);
                $resourceProperty = $node->getResourceProperty();
                if ($node instanceof OrderByNode && null !== $node->getResourceSetWrapper()) {
                    if (!array_key_exists($index, $navigationPropertiesInThePath)) {
                        $navigationPropertiesInThePath[$index] = [];
                    }

                    $navigationPropertiesInThePath[$index][] = $resourceProperty;
                }

                $orderBySubPathSegments[] = new OrderBySubPathSegment($resourceProperty);
                /** @var OrderByLeafNode $currentNode */
                $currentNode = $node;
            }

            $this->assertion($currentNode instanceof OrderByLeafNode);
            /** @var OrderByLeafNode $newNode */
            $newNode               = $currentNode;
            $orderByPathSegments[] = new OrderByPathSegment($orderBySubPathSegments, $newNode->isAscending());
            unset($orderBySubPathSegments);
        }

        $this->orderByInfo = new OrderByInfo(
            $orderByPathSegments,
            empty($navigationPropertiesInThePath) ? null : $navigationPropertiesInThePath
        );
    }

    /**
     * Generates top level comparison function from sub comparison functions.
     * @throws ODataException
     */
    private function generateTopLevelComparisonFunction(): void
    {
        $comparisonFunctionCount = count($this->comparisonFunctions);
        $this->assertion(0 < $comparisonFunctionCount);
        if (1 == $comparisonFunctionCount) {
            $this->topLevelComparisonFunction = $this->comparisonFunctions[0];
        } else {
            $funcList                         = $this->comparisonFunctions;
            $this->topLevelComparisonFunction = function ($object1, $object2) use ($funcList) {
                $ret = 0;
                foreach ($funcList as $f) {
                    $ret = $f($object1, $object2);
                    if (0 != $ret) {
                        return $ret;
                    }
                }
                return $ret;
            };
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace POData\UriProcessor\QueryProcessor\OrderByParser;
6
7			use POData\Common\InvalidOperationException;
8			use POData\Common\Messages;
9			use POData\Common\ODataException;
10			use POData\Common\ReflectionHandler;
11			use POData\Providers\Metadata\ResourceEntityType;
12			use POData\Providers\Metadata\ResourceProperty;
13			use POData\Providers\Metadata\ResourcePropertyKind;
14			use POData\Providers\Metadata\ResourceSetWrapper;
15			use POData\Providers\Metadata\ResourceType;
16			use POData\Providers\Metadata\Type\Binary;
17			use POData\Providers\ProvidersWrapper;
18			use POData\UriProcessor\QueryProcessor\ExpressionParser\ExpressionLexer;
19			use POData\UriProcessor\QueryProcessor\ExpressionParser\ExpressionTokenId;
20			use ReflectionClass;
21			use ReflectionException;
22
23			/**
24			* Class OrderByParser.
25			*
26			* Class to parse $orderby query option and perform syntax validation
27			* and build 'OrderBy Tree' along with next level of validation, the
28			* created tree is used for building sort functions and 'OrderByInfo' structure.
29			*
30			* The syntax of orderby clause is:
31			*
32			* OrderByClause : OrderByPathSegment [, OrderByPathSegment]*
33			* OrderByPathSegment : OrderBySubPathSegment[/OrderBySubPathSegment]*[asc\|desc]?
34			* OrderBySubPathSegment : identifier
35			*/
36			class OrderByParser
37			{
38			/**
39			* Collection of anonymous sorter function corresponding to each orderby path segment.
40			*
41			* @var callable[]
42			*/
43			private $comparisonFunctions = [];
44
45			/**
46			* The top level sorter function generated from orderby path segments.
47			*
48			* @var callable
49			*/
50			private $topLevelComparisonFunction;
51
52			/**
53			* The structure holds information about the navigation properties
54			* used in the orderby clause (if any), and orderby path if IDSQP
55			* implementor want to perform sorting.
56			*
57			* @var OrderByInfo
58			*/
59			private $orderByInfo;
60
61			/**
62			* Reference to metadata and query provider wrapper.
63			*
64			* @var ProvidersWrapper
65			*/
66			private $providerWrapper;
67
68			/**
69			* This object will be of type of the resource set identified by the request uri.
70			*
71			* @var mixed
72			*/
73			private $dummyObject;
74
75			/**
76			* Root node for tree ordering.
77			*
78			* @var OrderByNode
79			*/
80			private $rootOrderByNode;
81
82			/**
83			* Creates new instance of OrderByParser.
84			*
85			* @param ProvidersWrapper $providerWrapper Reference to metadata
86			* and query provider
87			* wrapper
88			*/
89			private function __construct(ProvidersWrapper $providerWrapper)
90			{
91			$this->providerWrapper = $providerWrapper;
92			}
93
94			/**
95			* This function perform the following tasks with the help of internal helper
96			* functions
97			* (1) Read the orderby clause and perform basic syntax checks
98			* (2) Build 'Order By Tree', creates anonymous sorter function for each leaf node and check for error
99			* (3) Build 'OrderInfo' structure, holds information about the navigation
100			* properties used in the orderby clause (if any) and orderby path if
101			* IDSQP implementor want to perform sorting
102			* (4) Build top level anonymous sorter function
103			* (4) Release resources hold by the 'Order By Tree'
104			* (5) Create 'InternalOrderInfo' structure, which wraps 'OrderInfo' and top
105			* level sorter function.
106			*
107			* @param ResourceSetWrapper $resourceSetWrapper ResourceSetWrapper for the resource targeted by resource path
108			* @param ResourceType $resourceType ResourceType for the resource targeted by resource path
109			* @param string $orderBy The orderby clause
110			* @param ProvidersWrapper $providerWrapper Reference to the wrapper for IDSQP and IDSMP impl
111			*
112			* @throws InvalidOperationException
113			* @throws ReflectionException
114			* @throws ODataException If any error occur while parsing orderby clause
115			* @return InternalOrderByInfo
116			*/
117			public static function parseOrderByClause(
118			ResourceSetWrapper $resourceSetWrapper,
119			ResourceType $resourceType,
120			string $orderBy,
121			ProvidersWrapper $providerWrapper
122			): InternalOrderByInfo {
123			if (0 == strlen(trim($orderBy))) {
124			throw new InvalidOperationException('OrderBy clause must not be trimmable to an empty string');
125			}
126			$orderByParser = new self($providerWrapper);
127			try {
128			$instance = $resourceType->getInstanceType();
129			assert($instance instanceof ReflectionClass, get_class($instance));
130			$orderByParser->dummyObject = $instance->newInstanceArgs([]);
131			} catch (ReflectionException $reflectionException) {
132			throw ODataException::createInternalServerError(Messages::orderByParserFailedToCreateDummyObject());
133			}
134			$orderByParser->rootOrderByNode = new OrderByRootNode($resourceSetWrapper, $resourceType);
135			$orderByPathSegments = $orderByParser->readOrderBy($orderBy);
136
137			$orderByParser->buildOrderByTree($orderByPathSegments);
138			$orderByParser->createOrderInfo($orderByPathSegments);
139			$orderByParser->generateTopLevelComparisonFunction();
140			//Recursively release the resources
141			$orderByParser->rootOrderByNode->free();
142			//creates internal order info wrapper
143			$internalOrderInfo = new InternalOrderByInfo(
144			$orderByParser->orderByInfo,
145			$orderByParser->comparisonFunctions,
146			$orderByParser->topLevelComparisonFunction,
147			$orderByParser->dummyObject,
148			$resourceType
149			);
150			unset($orderByParser->orderByInfo);
151			unset($orderByParser->topLevelComparisonFunction);
152
153			return $internalOrderInfo;
154			}
155
156			/**
157			* Read orderby clause.
158			*
159			* @param string $value orderby clause to read
160			*
161			* @throws ODataException If any syntax error found while reading the clause
162			* @return array<array> An array of 'OrderByPathSegment's, each of which
163			* is array of 'OrderBySubPathSegment's
164			*/
165			private function readOrderBy(string $value): array
166			{
167			$orderByPathSegments = [];
168			$lexer = new ExpressionLexer($value);
169			$i = 0;
170			while ($lexer->getCurrentToken()->getId() != ExpressionTokenId::END()) {
171			$orderBySubPathSegment = $lexer->readDottedIdentifier();
172			if (!array_key_exists($i, $orderByPathSegments)) {
173			$orderByPathSegments[$i] = [];
174			}
175
176			$orderByPathSegments[$i][] = $orderBySubPathSegment;
177			$tokenId = $lexer->getCurrentToken()->getId();
178			if ($tokenId != ExpressionTokenId::END()) {
179			if ($tokenId != ExpressionTokenId::SLASH()) {
180			if ($tokenId != ExpressionTokenId::COMMA()) {
181			$lexer->validateToken(ExpressionTokenId::IDENTIFIER());
182			$identifier = $lexer->getCurrentToken()->Text;
183			if ($identifier !== 'asc' && $identifier !== 'desc') {
184			// force lexer to throw syntax error as we found
185			// unexpected identifier
186			$lexer->validateToken(ExpressionTokenId::DOT());
187			}
188
189			$orderByPathSegments[$i][] = '*' . $identifier;
190			$lexer->nextToken();
191			$tokenId = $lexer->getCurrentToken()->getId();
192			if ($tokenId != ExpressionTokenId::END()) {
193			$lexer->validateToken(ExpressionTokenId::COMMA());
194			++$i;
195			}
196			} else {
197			++$i;
198			}
199			}
200
201			$lexer->nextToken();
202			}
203			}
204
205			return $orderByPathSegments;
206			}
207
208			/**
209			* Build 'OrderBy Tree' from the given orderby path segments, also build
210			* comparison function for each path segment.
211			*
212			* @param array(array) &$orderByPathSegments Collection of orderby path segments,
213			* this is passed by reference
214			* since we need this function to
215			* modify this array in two cases:
216			* 1. if asc or desc present, then the
217			* corresponding sub path segment
218			* should be removed
219			* 2. remove duplicate orderby path
220			* segment
221			*
222			* @throws ReflectionException
223			* @throws ODataException If any error occurs while processing the orderby path segments
224			* @return mixed
225			*/
226			private function buildOrderByTree(array &$orderByPathSegments)
227			{
228			foreach ($orderByPathSegments as $index1 => &$orderBySubPathSegments) {
229			/** @var OrderByNode $currentNode */
230			$currentNode = $this->rootOrderByNode;
231			$currentObject = $this->dummyObject;
232			$ascending = true;
233			$subPathCount = count($orderBySubPathSegments);
234			// Check sort order is specified in the path, if so set a
235			// flag and remove that segment
236			if ($subPathCount > 1) {
237			if ('*desc' === $orderBySubPathSegments[$subPathCount - 1]) {
238			$ascending = false;
239			unset($orderBySubPathSegments[$subPathCount - 1]);
240			--$subPathCount;
241			} elseif ('*asc' === $orderBySubPathSegments[$subPathCount - 1]) {
242			unset($orderBySubPathSegments[$subPathCount - 1]);
243			--$subPathCount;
244			}
245			}
246			$ancestors = [$this->rootOrderByNode->getResourceSetWrapper()->getName()];
247			foreach ($orderBySubPathSegments as $index2 => $orderBySubPathSegment) {
248			$isLastSegment = ($index2 == $subPathCount - 1);
249			$resourceSetWrapper = null;
250			/** @var ResourceEntityType $resourceType */
251			$resourceType = $currentNode->getResourceType();
252			/** @var ResourceProperty $resourceProperty */
253			$resourceProperty = $resourceType->resolveProperty($orderBySubPathSegment);
254			if (null === $resourceProperty) {
255			throw ODataException::createSyntaxError(
256			Messages::orderByParserPropertyNotFound(
257			$resourceType->getFullName(),
258			$orderBySubPathSegment
259			)
260			);
261			}
262			/** @var ResourcePropertyKind $rKind */
263			$rKind = $resourceProperty->getKind();
264			$rawKind = ($rKind instanceof ResourcePropertyKind) ? $rKind : $rKind;
265
266			if ($resourceProperty->isKindOf(ResourcePropertyKind::BAG())) {
267			throw ODataException::createBadRequestError(
268			Messages::orderByParserBagPropertyNotAllowed(
269			$resourceProperty->getName()
270			)
271			);
272			} elseif ($resourceProperty->isKindOf(ResourcePropertyKind::PRIMITIVE())) {
273			if (!$isLastSegment) {
274			throw ODataException::createBadRequestError(
275			Messages::orderByParserPrimitiveAsIntermediateSegment(
276			$resourceProperty->getName()
277			)
278			);
279			}
280
281			$type = $resourceProperty->getInstanceType();
282			if ($type instanceof Binary) {
283			throw ODataException::createBadRequestError(
284			Messages::orderByParserSortByBinaryPropertyNotAllowed($resourceProperty->getName())
285			);
286			}
287			} elseif ($rawKind == ResourcePropertyKind::RESOURCESET_REFERENCE()
288			\|\| $rawKind == ResourcePropertyKind::RESOURCE_REFERENCE()
289			) {
290			$this->assertion($currentNode instanceof OrderByRootNode \|\| $currentNode instanceof OrderByNode);
291			$resourceSetWrapper = $currentNode->getResourceSetWrapper();
292			$this->assertion(null !== $resourceSetWrapper);
293			$resourceSetWrapper
294			= $this->providerWrapper->getResourceSetWrapperForNavigationProperty(
295			$resourceSetWrapper,
296			$resourceType,
297			$resourceProperty
298			);
299			if (null === $resourceSetWrapper) {
300			throw ODataException::createBadRequestError(
301			Messages::badRequestInvalidPropertyNameSpecified(
302			$resourceType->getFullName(),
303			$orderBySubPathSegment
304			)
305			);
306			}
307
308			if ($rKind == ResourcePropertyKind::RESOURCESET_REFERENCE()) {
309			throw ODataException::createBadRequestError(
310			Messages::orderByParserResourceSetReferenceNotAllowed(
311			$resourceProperty->getName(),
312			$resourceType->getFullName()
313			)
314			);
315			}
316
317			$resourceSetWrapper->checkResourceSetRightsForRead(true);
318			if ($isLastSegment) {
319			throw ODataException::createBadRequestError(
320			Messages::orderByParserSortByNavigationPropertyIsNotAllowed(
321			$resourceProperty->getName()
322			)
323			);
324			}
325
326			$ancestors[] = $orderBySubPathSegment;
327			} elseif ($resourceProperty->isKindOf(ResourcePropertyKind::COMPLEX_TYPE())) {
328			if ($isLastSegment) {
329			throw ODataException::createBadRequestError(
330			Messages::orderByParserSortByComplexPropertyIsNotAllowed(
331			$resourceProperty->getName()
332			)
333			);
334			}
335
336			$ancestors[] = $orderBySubPathSegment;
337			} else {
338			throw ODataException::createInternalServerError(
339			Messages::orderByParserUnexpectedPropertyType()
340			);
341			}
342
343			$node = $currentNode->findNode($orderBySubPathSegment);
344			if (null === $node) {
345			if ($resourceProperty->isKindOf(ResourcePropertyKind::PRIMITIVE())) {
346			$node = new OrderByLeafNode(
347			$orderBySubPathSegment,
348			$resourceProperty,
349			$ascending
350			);
351			$this->comparisonFunctions[] = $node->buildComparisonFunction($ancestors);
352			} elseif ($resourceProperty->getKind() == ResourcePropertyKind::RESOURCE_REFERENCE()) {
353			$node = new OrderByNode(
354			$orderBySubPathSegment,
355			$resourceProperty,
356			$resourceSetWrapper
357			);
358			// Initialize this member variable (identified by
359			// $resourceProperty) of parent object.
360			try {
361			$instance = $resourceProperty->getInstanceType();
362			assert($instance instanceof ReflectionClass, get_class($instance));
363			$object = $instance->newInstanceArgs();
364			$resourceType->setPropertyValue($currentObject, $resourceProperty->getName(), $object);
365			$currentObject = $object;
366			} catch (ReflectionException $reflectionException) {
367			$this->throwBadAccessOrInitException($resourceProperty, $resourceType);
368			}
369			} elseif ($resourceProperty->getKind() == ResourcePropertyKind::COMPLEX_TYPE()) {
370			$node = new OrderByNode($orderBySubPathSegment, $resourceProperty, null);
371			// Initialize this member variable
372			// (identified by $resourceProperty)of parent object.
373			try {
374			$instance = $resourceProperty->getInstanceType();
375			assert($instance instanceof ReflectionClass, get_class($instance));
376			$object = $instance->newInstanceArgs();
377			$resourceType->setPropertyValue($currentObject, $resourceProperty->getName(), $object);
378			$currentObject = $object;
379			} catch (ReflectionException $reflectionException) {
380			$this->throwBadAccessOrInitException($resourceProperty, $resourceType);
381			}
382			}
383
384			$currentNode->addNode($node);
385			} else {
386			try {
387			$currentObject = ReflectionHandler::getProperty($currentObject, $resourceProperty->getName());
388			} catch (ReflectionException $reflectionException) {
389			$this->throwBadAccessOrInitException($resourceProperty, $resourceType);
390			}
391
392			if ($node instanceof OrderByLeafNode) {
393			//remove duplicate orderby path
394			unset($orderByPathSegments[$index1]);
395			}
396			}
397
398			$currentNode = $node;
399			}
400			}
401			return null;
402			}
403
404			/**
405			* Assert that the given condition is true, if false throw ODataException for unexpected state.
406			*
407			* @param bool $condition The condition to assert
408			*
409			* @throws ODataException
410			*/
411			private function assertion(bool $condition): void
412			{
413			if (!$condition) {
414			throw ODataException::createInternalServerError(Messages::orderByParserUnExpectedState());
415			}
416			}
417
418			/**
419			* @param ResourceProperty $resourceProperty
420			* @param ResourceType $resourceType
421			* @throws ODataException
422			*/
423			private function throwBadAccessOrInitException(
424			ResourceProperty $resourceProperty,
425			ResourceType $resourceType
426			): void {
427			throw ODataException::createInternalServerError(
428			Messages::orderByParserFailedToAccessOrInitializeProperty(
429			$resourceProperty->getName(),
430			$resourceType->getName()
431			)
432			);
433			}
434
435			/**
436			* Traverse 'Order By Tree' and create 'OrderInfo' structure.
437			*
438			* @param array<array> $orderByPaths The orderby paths
439			*
440			* @throws ODataException If parser finds an inconsistent-tree state, throws unexpected state error
441			* @return void
442			*/
443			private function createOrderInfo(array $orderByPaths): void
444			{
445			$orderByPathSegments = [];
446			$navigationPropertiesInThePath = [];
447			foreach ($orderByPaths as $index => $orderBySubPaths) {
448			/** @var OrderByNode $currentNode */
449			$currentNode = $this->rootOrderByNode;
450			$orderBySubPathSegments = [];
451			foreach ($orderBySubPaths as $orderBySubPath) {
452			/** @var OrderByNode $node */
453			$node = $currentNode->findNode($orderBySubPath);
454			$this->assertion(null !== $node);
455			$resourceProperty = $node->getResourceProperty();
456			if ($node instanceof OrderByNode && null !== $node->getResourceSetWrapper()) {
457			if (!array_key_exists($index, $navigationPropertiesInThePath)) {
458			$navigationPropertiesInThePath[$index] = [];
459			}
460
461			$navigationPropertiesInThePath[$index][] = $resourceProperty;
462			}
463
464			$orderBySubPathSegments[] = new OrderBySubPathSegment($resourceProperty);
465			/** @var OrderByLeafNode $currentNode */
466			$currentNode = $node;
467			}
468
469			$this->assertion($currentNode instanceof OrderByLeafNode);
470			/** @var OrderByLeafNode $newNode */
471			$newNode = $currentNode;
472			$orderByPathSegments[] = new OrderByPathSegment($orderBySubPathSegments, $newNode->isAscending());
473			unset($orderBySubPathSegments);
474			}
475
476			$this->orderByInfo = new OrderByInfo(
477			$orderByPathSegments,
478			empty($navigationPropertiesInThePath) ? null : $navigationPropertiesInThePath
479			);
480			}
481
482			/**
483			* Generates top level comparison function from sub comparison functions.
484			* @throws ODataException
485			*/
486			private function generateTopLevelComparisonFunction(): void
487			{
488			$comparisonFunctionCount = count($this->comparisonFunctions);
489			$this->assertion(0 < $comparisonFunctionCount);
490			if (1 == $comparisonFunctionCount) {
491			$this->topLevelComparisonFunction = $this->comparisonFunctions[0];
492			} else {
493			$funcList = $this->comparisonFunctions;
494			$this->topLevelComparisonFunction = function ($object1, $object2) use ($funcList) {
495			$ret = 0;
496			foreach ($funcList as $f) {
497			$ret = $f($object1, $object2);
498			if (0 != $ret) {
499			return $ret;
500			}
501			}
502			return $ret;
503			};
504			}
505			}
506			}
507

Algo-Web / POData

OrderByParser::createOrderInfo() B last analyzed 2023-09-17 09:46 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

OrderByParser::createOrderInfo() B
last analyzed 2023-09-17 09:46 UTC