POData\UriProcessor\QueryProcessor\OrderByParser\OrderByParser

Complexity

Total Complexity

53

Size/Duplication

Total Lines	458
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes	4
Bugs	2	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
F	_buildOrderByTree()	0	195	28
C	_createOrderInfo()	0	30	7
A	__construct()	0	4	1
B	parseOrderByClause()	0	33	2
A	_generateTopLevelComparisonFunction()	0	21	4
D	_readOrderBy()	0	42	9
A	_assertion()	0	6	2

<?php

namespace POData\UriProcessor\QueryProcessor\OrderByParser;

use POData\UriProcessor\QueryProcessor\ExpressionParser\ExpressionLexer;
use POData\UriProcessor\QueryProcessor\ExpressionParser\ExpressionTokenId;
use POData\Providers\ProvidersWrapper;
use POData\Providers\Metadata\Type\Binary;
use POData\Providers\Metadata\ResourceSetWrapper;
use POData\Providers\Metadata\ResourceType;
use POData\Providers\Metadata\ResourcePropertyKind;
use POData\Common\ODataException;
use POData\Common\Messages;

/**
 * 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 = array();

    /**
     * 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;

    /**
     * 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 errors
     * (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
     *
     * @return InternalOrderByInfo
     *
     * @throws ODataException If any error occur while parsing orderby clause
     */
    public static function parseOrderByClause(
        ResourceSetWrapper $resourceSetWrapper,
        ResourceType $resourceType,
        $orderBy,
        ProvidersWrapper $providerWrapper
    ) {
        $orderByParser = new self($providerWrapper);
        try {
            $orderByParser->_dummyObject = $resourceType->getInstanceType()->newInstance();

The method newInstance does only exist in ReflectionClass, but not in POData\Providers\Metadata\Type\IType.

        } catch (\ReflectionException $reflectionException) {
            throw ODataException::createInternalServerError(Messages::orderByParserFailedToCreateDummyObject());
        }
        $orderByParser->_rootOrderByNode = new OrderByRootNode($resourceSetWrapper, $resourceType);

The property _rootOrderByNode does not exist. Did you maybe forget to declare it?

        $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;
    }

    /**
     * Build 'OrderBy Tree' from the given orderby path segments, also build
     * comparsion 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 ODataException If any error occurs while processing the orderby path
     *                        segments
     */
    private function _buildOrderByTree(&$orderByPathSegments)
    {
        foreach ($orderByPathSegments as $index1 => &$orderBySubPathSegments) {
            $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 ($orderBySubPathSegments[$subPathCount - 1] === '*desc') {
                    $ascending = false;
                    unset($orderBySubPathSegments[$subPathCount - 1]);
                    --$subPathCount;
                } elseif ($orderBySubPathSegments[$subPathCount - 1] === '*asc') {
                    unset($orderBySubPathSegments[$subPathCount - 1]);
                    --$subPathCount;
                }
            }

            $ancestors = array($this->_rootOrderByNode->getResourceSetWrapper()->getName());
            foreach ($orderBySubPathSegments as $index2 => $orderBySubPathSegment) {
                $isLastSegment = ($index2 == $subPathCount - 1);
                $resourceSetWrapper = null;
                $resourceType = $currentNode->getResourceType();
                $resourceProperty = $resourceType->resolveProperty($orderBySubPathSegment);
                if (is_null($resourceProperty)) {
                    throw ODataException::createSyntaxError(
                        Messages::orderByParserPropertyNotFound(
                            $resourceType->getFullName(),
                            $orderBySubPathSegment
                        )
                    );
                }

                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 ($resourceProperty->getKind() == ResourcePropertyKind::RESOURCESET_REFERENCE
                    || $resourceProperty->getKind() == ResourcePropertyKind::RESOURCE_REFERENCE
                ) {
                    $this->_assertion($currentNode instanceof OrderByRootNode || $currentNode instanceof OrderByNode);
                    $resourceSetWrapper = $currentNode->getResourceSetWrapper();
                    $this->_assertion(!is_null($resourceSetWrapper));
                    $resourceSetWrapper
                        = $this->_providerWrapper->getResourceSetWrapperForNavigationProperty(
                            $resourceSetWrapper,
                            $resourceType,
                            $resourceProperty
                        );
                    if (is_null($resourceSetWrapper)) {
                        throw ODataException::createBadRequestError(
                            Messages::badRequestInvalidPropertyNameSpecified(
                                $resourceType->getFullName(),
                                $orderBySubPathSegment
                            )
                        );
                    }

                    if ($resourceProperty->getKind() == 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 (is_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

It seems like $resourceSetWrapper can be null; however, __construct() does not accept null, maybe add an additional type check?

                        );
                        // Initialize this member variable (identified by
                        // $resourceProperty) of parent object.
                        try {
                            $object = $resourceProperty->getInstanceType()->newInstance();
                            $resourceType->setPropertyValue($currentObject, $resourceProperty->getName(), $object);
                            $currentObject = $object;
                        } catch (\ReflectionException $reflectionException) {
                            throw ODataException::createInternalServerError(
                                Messages::orderByParserFailedToAccessOrInitializeProperty(
                                    $resourceProperty->getName(),
                                    $resourceType->getName()
                                )
                            );
                        }
                    } elseif ($resourceProperty->getKind() == ResourcePropertyKind::COMPLEX_TYPE) {
                        $node = new OrderByNode($orderBySubPathSegment, $resourceProperty, null);

null is of type null, but the function expects a object<POData\Providers\Metadata\ResourceSetWrapper>.

                        // Initialize this member variable
                        // (identified by $resourceProperty)of parent object.
                        try {
                            $object = $resourceProperty->getInstanceType()->newInstance();
                            $resourceType->setPropertyValue($currentObject, $resourceProperty->getName(), $object);
                            $currentObject = $object;
                        } catch (\ReflectionException $reflectionException) {
                            throw ODataException::createInternalServerError(
                                Messages::orderByParserFailedToAccessOrInitializeProperty(
                                    $resourceProperty->getName(),
                                    $resourceType->getName()
                                )
                            );
                        }
                    }

                    $currentNode->addNode($node);
                } else {
                    try {
                        // If a magic method for properties exists (eg Eloquent), dive into it directly and return value
                        if (method_exists($currentObject, '__get')) {
                            $targProperty = $resourceProperty->getName();

                            return $currentObject->$targProperty;
                        }
                        $reflectionClass = new \ReflectionClass(get_class($currentObject));
                        $reflectionProperty = $reflectionClass->getProperty($resourceProperty->getName());
                        $reflectionProperty->setAccessible(true);
                        $currentObject = $reflectionProperty->getValue($currentObject);

                        //$dummyProperty = new \ReflectionProperty(

38% of this comment could be valid code. Did you maybe forget this after debugging?

                        //    $currentObject, $resourceProperty->getName()

67% of this comment could be valid code. Did you maybe forget this after debugging?

                        //);
                        //$currentObject = $dummyProperty->getValue($currentObject);

64% of this comment could be valid code. Did you maybe forget this after debugging?

                    } catch (\ReflectionException $reflectionException) {
                        throw ODataException::createInternalServerError(
                            Messages::orderByParserFailedToAccessOrInitializeProperty(
                                $resourceProperty->getName(),
                                $resourceType->getName()
                            )
                        );
                    }

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

                $currentNode = $node;
            }
        }
    }

    /**
     * Traverse 'Order By Tree' and create 'OrderInfo' structure.
     *
     * @param array(array) $orderByPaths The orderby paths

The doc-type array(array) could not be parsed: Expected "|" or "end of type", but got "(" at position 5. (view supported doc-types)

     *
     * @return OrderByInfo
     *
     * @throws ODataException In case parser found any tree inconsisitent
     *                        state, throws unexpected state error
     */
    private function _createOrderInfo($orderByPaths)
    {
        $orderByPathSegments = array();
        $navigationPropertiesInThePath = array();
        foreach ($orderByPaths as $index => $orderBySubPaths) {
            $currentNode = $this->_rootOrderByNode;
            $orderBySubPathSegments = array();
            foreach ($orderBySubPaths as $orderBySubPath) {
                $node = $currentNode->findNode($orderBySubPath);
                $this->_assertion(!is_null($node));
                $resourceProperty = $node->getResourceProperty();
                if ($node instanceof OrderByNode && !is_null($node->getResourceSetWrapper())) {
                    if (!array_key_exists($index, $navigationPropertiesInThePath)) {
                        $navigationPropertiesInThePath[$index] = array();
                    }

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

                $orderBySubPathSegments[] = new OrderBySubPathSegment($resourceProperty);
                $currentNode = $node;
            }

            $this->_assertion($currentNode instanceof OrderByLeafNode);
            $orderByPathSegments[] = new OrderByPathSegment($orderBySubPathSegments, $currentNode->isAscending());
            unset($orderBySubPathSegments);
        }

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

    /**
     * Generates top level comparison function from sub comparison functions.
     */
    private function _generateTopLevelComparisonFunction()
    {
        $comparisonFunctionCount = count($this->_comparisonFunctions);
        $this->_assertion($comparisonFunctionCount > 0);
        if ($comparisonFunctionCount == 1) {
            $this->_topLevelComparisonFunction = $this->_comparisonFunctions[0];
        } else {
            $funcList = $this->_comparisonFunctions;
            $BigFunc = function($object1, $object2) use ($funcList) {
                $ret = 0;
                foreach ($funcList as $f) {
                    $ret = $f($object1, $object2);
                    if ($ret != 0) {
                        return $ret;
                    }
                }
                return $ret;
            };
            $this->_topLevelComparisonFunction = $BigFunc;
        }
    }

    /**
     * Read orderby clause.
     *
     * @param string $value orderby clause to read
     *
     * @return array(array) An array of 'OrderByPathSegment's, each of which

The doc-type array(array) could not be parsed: Expected "|" or "end of type", but got "(" at position 5. (view supported doc-types)

     *                      is array of 'OrderBySubPathSegment's
     *
     * @throws ODataException If any syntax error found while reading the clause
     */
    private function _readOrderBy($value)
    {
        $orderByPathSegments = array();
        $lexer = new ExpressionLexer($value);
        $i = 0;
        while ($lexer->getCurrentToken()->Id != ExpressionTokenId::END) {
            $orderBySubPathSegment = $lexer->readDottedIdentifier();
            if (!array_key_exists($i, $orderByPathSegments)) {
                $orderByPathSegments[$i] = array();
            }

            $orderByPathSegments[$i][] = $orderBySubPathSegment;
            $tokenId = $lexer->getCurrentToken()->Id;
            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()->Id;
                        if ($tokenId != ExpressionTokenId::END) {
                            $lexer->validateToken(ExpressionTokenId::COMMA);
                            ++$i;
                        }
                    } else {
                        ++$i;
                    }
                }

                $lexer->nextToken();
            }
        }

        return $orderByPathSegments;
    }

    /**
     * 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($condition)
    {
        if (!$condition) {
            throw ODataException::createInternalServerError(Messages::orderByParserUnExpectedState());
        }
    }
}