UriProcessorNew::getService() - Code Metrics - Inspection of "Merge pull request #112 from CyberiaResurrection/R..." - Algo-Web/POData - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 2b99ce...30750d )

by Christopher

created 2017-07-12 04:55 UTC

UriProcessorNew::getService() A

↳ Parent: UriProcessorNew

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace POData\UriProcessor;

use POData\Common\Messages;
use POData\Common\ODataConstants;
use POData\Common\ODataException;
use POData\IService;
use POData\OperationContext\HTTPRequestMethod;
use POData\Providers\Metadata\ResourcePropertyKind;
use POData\Providers\ProvidersWrapper;
use POData\Providers\Query\QueryResult;
use POData\Providers\Query\QueryType;
use POData\UriProcessor\Interfaces\IUriProcessor;
use POData\UriProcessor\QueryProcessor\QueryProcessor;
use POData\UriProcessor\ResourcePathProcessor\ResourcePathProcessor;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\SegmentDescriptor;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetKind;
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetSource;

/**
 * Class UriProcessorNew.
 *
 * A type to process client's requested URI
 * The syntax of request URI is:
 *  Scheme Host Port ServiceRoot ResourcePath ? QueryOption
 * For more details refer:
 * http://www.odata.org/developers/protocols/uri-conventions#UriComponents
 */
class UriProcessorNew implements IUriProcessor
{
    /**
     * Description of the OData request that a client has submitted.
     *
     * @var RequestDescription
     */
    private $request;

    /**
     * Holds reference to the data service instance.
     *
     * @var IService
     */
    private $service;

    /**
     * Holds reference to the wrapper over IDSMP and IDSQP implementation.
     *
     * @var ProvidersWrapper
     */
    private $providers;

    /**
     * Holds reference to request expander.
     *
     * @var RequestExpander
     */
    private $expander;

    /**
     * Constructs a new instance of UriProcessor.
     *
     * @param IService $service Reference to the data service instance
     */
    private function __construct(IService $service)
    {
        $this->service = $service;
        $this->providers = $service->getProvidersWrapper();
        $this->request = ResourcePathProcessor::process($service);
        $this->expander = new RequestExpander(
            $this->getRequest(),
            $this->getService(),
            $this->getProviders()
        );
        $this->getRequest()->setUriProcessor($this);
    }

    /**
     * Process the resource path and query options of client's request uri.
     *
     * @param IService $service Reference to the data service instance
     *
     * @throws ODataException
     *
     * @return IUriProcessor
     */
    public static function process(IService $service)
    {
        $absRequestUri = $service->getHost()->getAbsoluteRequestUri();
        $absServiceUri = $service->getHost()->getAbsoluteServiceUri();

        if (!$absServiceUri->isBaseOf($absRequestUri)) {
            throw ODataException::createInternalServerError(
                Messages::uriProcessorRequestUriDoesNotHaveTheRightBaseUri(
                    $absRequestUri->getUrlAsString(),
                    $absServiceUri->getUrlAsString()
                )
            );
        }

        $processor = new self($service);

        return $processor;
    }

    /**
     * Gets reference to the request submitted by client.
     *
     * @return RequestDescription
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Gets reference to the request submitted by client.
     *
     * @return ProvidersWrapper
     */
    public function getProviders()
    {
        return $this->providers;
    }

    /**
     * Gets the data service instance.
     *
     * @return IService
     */
    public function getService()
    {
        return $this->service;
    }

    /**
     * Gets the request expander instance.
     *
     * @return RequestExpander
     */
    public function getExpander()
    {
        return $this->expander;
    }

    /**
     * Execute the client submitted request against the data source.
     */
    public function execute()
    {
        $service = $this->getService();
        $context = $service->getOperationContext();
        $method = $context->incomingRequest()->getMethod();

        switch ($method) {
            case HTTPRequestMethod::GET():
                $this->executeGet();
                break;
            case HTTPRequestMethod::DELETE():
                $this->executeGet();
                $this->executeDelete();
                break;
            case HTTPRequestMethod::PUT():
                $this->executeGet();
                $this->executePut();
                break;
            case HTTPRequestMethod::POST():
                $this->executePost();
                break;
            default:
                throw ODataException::createNotImplementedError(Messages::onlyReadSupport($method));
        }

        // Apply $select and $expand options to result set, this function will be always applied
        // irrespective of return value of IDSQP2::canApplyQueryOptions which means library will
        // not delegate $expand/$select operation to IDSQP2 implementation
        $this->getExpander()->handleExpansion();
    }

    /**
     * Execute the client submitted request against the data source (GET).
     */
    protected function executeGet()
    {
        $segments = $this->getRequest()->getSegments();

        foreach ($segments as $segment) {
            $requestTargetKind = $segment->getTargetKind();

            switch ($requestTargetKind) {
                case TargetKind::SINGLETON():
                    $this->executeGetSingleton($segment);
                    break;
                case TargetKind::RESOURCE():
                    $this->executeGetResource($segment);
                    break;
                case TargetKind::MEDIA_RESOURCE():
                    $segment->setResult($segment->getPrevious()->getResult());
                    // a media resource means we're done - bail out of segment processing
                    break 2;
                case TargetKind::LINK():
                    $this->executeGetLink($segment);
                    break;
                case TargetKind::PRIMITIVE():
                case TargetKind::PRIMITIVE_VALUE():
                case TargetKind::COMPLEX_OBJECT():
                case TargetKind::BAG():
                    break;
                default:
                    assert(false, "Not implemented yet");
            }
        }
    }

    /**
     * Execute the client submitted request against the data source (DELETE).
     */
    protected function executeDelete()
    {
        $segment = $this->getFinalEffectiveSegment();
        $requestMethod = $this->getService()->getOperationContext()->incomingRequest()->getMethod();
        $resourceSet = $segment->getTargetResourceSetWrapper();
        $keyDescriptor = $segment->getKeyDescriptor();

        $this->checkUriValidForSuppliedVerb($resourceSet, $keyDescriptor, $requestMethod);
        $this->getProviders()->deleteResource($resourceSet, $segment->getResult());
    }

    /**
     * Execute the client submitted request against the data source (PUT).
     */
    protected function executePut()
    {
        $segment = $this->getFinalEffectiveSegment();
        $requestMethod = $this->getService()->getOperationContext()->incomingRequest()->getMethod();
        $resourceSet = $segment->getTargetResourceSetWrapper();
        $keyDescriptor = $segment->getKeyDescriptor();

        $this->checkUriValidForSuppliedVerb($resourceSet, $keyDescriptor, $requestMethod);

        $data = $this->getRequest()->getData();
        if (!$data) {
            throw ODataException::createBadRequestError(Messages::noDataForThisVerb($requestMethod));
        }

        $queryResult = $this->getProviders()->updateResource(
            $resourceSet,
            $segment->getResult(),
            $keyDescriptor,
            $data,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            false
        );
        $segment->setResult($queryResult);
    }

    /**
     * Execute the client submitted request against the data source (POST).
     */
    protected function executePost()
    {
        $segments = $this->getRequest()->getSegments();
        $requestMethod = $this->getService()->getOperationContext()->incomingRequest()->getMethod();

        foreach ($segments as $segment) {
            $requestTargetKind = $segment->getTargetKind();
            if ($requestTargetKind == TargetKind::RESOURCE()) {
                $resourceSet = $segment->getTargetResourceSetWrapper();
                $keyDescriptor = $segment->getKeyDescriptor();

                $data = $this->getRequest()->getData();
                if (empty($data)) {
                    throw ODataException::createBadRequestError(Messages::noDataForThisVerb($requestMethod));
                }
                $queryResult = $this->getProviders()->createResourceforResourceSet($resourceSet, $keyDescriptor, $data);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $segment->setResult($queryResult);
            }
        }
    }

    /**
     * @return null|SegmentDescriptor
     */
    protected function getFinalEffectiveSegment()
    {
        $segment = $this->getRequest()->getLastSegment();
        // if last segment is $count, back up one
        if (ODataConstants::URI_COUNT_SEGMENT == $segment->getIdentifier()) {
            $segment = $segment->getPrevious();
            return $segment;
        }
        return $segment;
    }

    /**
     * @param $resourceSet
     * @param $keyDescriptor
     * @param $requestMethod
     * @throws ODataException
     */
    protected function checkUriValidForSuppliedVerb($resourceSet, $keyDescriptor, $requestMethod)

    {
        if (!$resourceSet || !$keyDescriptor) {
            $url = $this->getService()->getHost()->getAbsoluteRequestUri()->getUrlAsString();
            throw ODataException::createBadRequestError(
                Messages::badRequestInvalidUriForThisVerb($url, $requestMethod)
            );
        }
    }

    /**
     * @param $segment
     */
    private function executeGetSingleton($segment)
    {
        $segmentId = $segment->getIdentifier();
        $singleton = $this->getService()->getProvidersWrapper()->resolveSingleton($segmentId);
        $segment->setResult($singleton->get());
    }

    /**
     * @param $segment
     */
    private function executeGetResource($segment)
    {
        if ($segment->isSingleResult()) {
            $queryResult = $this->getProviders()->getResourceFromResourceSet(
                $segment->getTargetResourceSetWrapper(),
                $segment->getKeyDescriptor()
            );
        } else {
            $skip = $this->getRequest()->getSkipCount();
            $skip = (null === $skip) ? 0 : $skip;
            $skipToken = $this->getRequest()->getInternalSkipTokenInfo();
            $skipToken = (null != $skipToken) ? $skipToken->getSkipTokenInfo() : null;
            $queryResult = $this->getProviders()->getResourceSet(
                $this->getRequest()->queryType,
                $segment->getTargetResourceSetWrapper(),
                $this->getRequest()->getFilterInfo(),
                $this->getRequest()->getInternalOrderByInfo(),
                $this->getRequest()->getTopCount(),
                $skip,
                $skipToken
            );
        }
        $segment->setResult($queryResult);
    }

    /**
     * @param $segment
     */
    private function executeGetLink($segment)
    {
        $previous = $segment->getPrevious();
        assert(isset($previous));
        $segment->setResult($previous->getResult());
    }
}


1		<?php
2
3		namespace POData\UriProcessor;
4
5		use POData\Common\Messages;
6		use POData\Common\ODataConstants;
7		use POData\Common\ODataException;
8		use POData\IService;
9		use POData\OperationContext\HTTPRequestMethod;
10		use POData\Providers\Metadata\ResourcePropertyKind;
11		use POData\Providers\ProvidersWrapper;
12		use POData\Providers\Query\QueryResult;
13		use POData\Providers\Query\QueryType;
14		use POData\UriProcessor\Interfaces\IUriProcessor;
15		use POData\UriProcessor\QueryProcessor\QueryProcessor;
16		use POData\UriProcessor\ResourcePathProcessor\ResourcePathProcessor;
17		use POData\UriProcessor\ResourcePathProcessor\SegmentParser\SegmentDescriptor;
18		use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetKind;
19		use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetSource;
20
21		/**
22		* Class UriProcessorNew.
23		*
24		* A type to process client's requested URI
25		* The syntax of request URI is:
26		* Scheme Host Port ServiceRoot ResourcePath ? QueryOption
27		* For more details refer:
28		* http://www.odata.org/developers/protocols/uri-conventions#UriComponents
29		*/
30		class UriProcessorNew implements IUriProcessor
31		{
32		/**
33		* Description of the OData request that a client has submitted.
34		*
35		* @var RequestDescription
36		*/
37		private $request;
38
39		/**
40		* Holds reference to the data service instance.
41		*
42		* @var IService
43		*/
44		private $service;
45
46		/**
47		* Holds reference to the wrapper over IDSMP and IDSQP implementation.
48		*
49		* @var ProvidersWrapper
50		*/
51		private $providers;
52
53		/**
54		* Holds reference to request expander.
55		*
56		* @var RequestExpander
57		*/
58		private $expander;
59
60		/**
61		* Constructs a new instance of UriProcessor.
62		*
63		* @param IService $service Reference to the data service instance
64		*/
65		private function __construct(IService $service)
66		{
67		$this->service = $service;
68		$this->providers = $service->getProvidersWrapper();
69		$this->request = ResourcePathProcessor::process($service);
70		$this->expander = new RequestExpander(
71		$this->getRequest(),
72		$this->getService(),
73		$this->getProviders()
74		);
75		$this->getRequest()->setUriProcessor($this);
76		}
77
78		/**
79		* Process the resource path and query options of client's request uri.
80		*
81		* @param IService $service Reference to the data service instance
82		*
83		* @throws ODataException
84		*
85		* @return IUriProcessor
86		*/
87		public static function process(IService $service)
88		{
89		$absRequestUri = $service->getHost()->getAbsoluteRequestUri();
90		$absServiceUri = $service->getHost()->getAbsoluteServiceUri();
91
92		if (!$absServiceUri->isBaseOf($absRequestUri)) {
93		throw ODataException::createInternalServerError(
94		Messages::uriProcessorRequestUriDoesNotHaveTheRightBaseUri(
95		$absRequestUri->getUrlAsString(),
96		$absServiceUri->getUrlAsString()
97		)
98		);
99		}
100
101		$processor = new self($service);
102
103		return $processor;
104		}
105
106		/**
107		* Gets reference to the request submitted by client.
108		*
109		* @return RequestDescription
110		*/
111		public function getRequest()
112		{
113		return $this->request;
114		}
115
116		/**
117		* Gets reference to the request submitted by client.
118		*
119		* @return ProvidersWrapper
120		*/
121		public function getProviders()
122		{
123		return $this->providers;
124		}
125
126		/**
127		* Gets the data service instance.
128		*
129		* @return IService
130		*/
131		public function getService()
132		{
133		return $this->service;
134		}
135
136		/**
137		* Gets the request expander instance.
138		*
139		* @return RequestExpander
140		*/
141		public function getExpander()
142		{
143		return $this->expander;
144		}
145
146		/**
147		* Execute the client submitted request against the data source.
148		*/
149		public function execute()
150		{
151		$service = $this->getService();
152		$context = $service->getOperationContext();
153		$method = $context->incomingRequest()->getMethod();
154
155		switch ($method) {
156		case HTTPRequestMethod::GET():
157		$this->executeGet();
158		break;
159		case HTTPRequestMethod::DELETE():
160		$this->executeGet();
161		$this->executeDelete();
162		break;
163		case HTTPRequestMethod::PUT():
164		$this->executeGet();
165		$this->executePut();
166		break;
167		case HTTPRequestMethod::POST():
168		$this->executePost();
169		break;
170		default:
171		throw ODataException::createNotImplementedError(Messages::onlyReadSupport($method));
172		}
173
174		// Apply $select and $expand options to result set, this function will be always applied
175		// irrespective of return value of IDSQP2::canApplyQueryOptions which means library will
176		// not delegate $expand/$select operation to IDSQP2 implementation
177		$this->getExpander()->handleExpansion();
178		}
179
180		/**
181		* Execute the client submitted request against the data source (GET).
182		*/
183		protected function executeGet()
184		{
185		$segments = $this->getRequest()->getSegments();
186
187		foreach ($segments as $segment) {
188		$requestTargetKind = $segment->getTargetKind();
189
190		switch ($requestTargetKind) {
191		case TargetKind::SINGLETON():
192		$this->executeGetSingleton($segment);
193		break;
194		case TargetKind::RESOURCE():
195		$this->executeGetResource($segment);
196		break;
197		case TargetKind::MEDIA_RESOURCE():
198		$segment->setResult($segment->getPrevious()->getResult());
199		// a media resource means we're done - bail out of segment processing
200		break 2;
201		case TargetKind::LINK():
202		$this->executeGetLink($segment);
203		break;
204		case TargetKind::PRIMITIVE():
205		case TargetKind::PRIMITIVE_VALUE():
206		case TargetKind::COMPLEX_OBJECT():
207		case TargetKind::BAG():
208		break;
209		default:
210		assert(false, "Not implemented yet");
211		}
212		}
213		}
214
215		/**
216		* Execute the client submitted request against the data source (DELETE).
217		*/
218		protected function executeDelete()
219		{
220		$segment = $this->getFinalEffectiveSegment();
221		$requestMethod = $this->getService()->getOperationContext()->incomingRequest()->getMethod();
222		$resourceSet = $segment->getTargetResourceSetWrapper();
223		$keyDescriptor = $segment->getKeyDescriptor();
224
225		$this->checkUriValidForSuppliedVerb($resourceSet, $keyDescriptor, $requestMethod);
226		$this->getProviders()->deleteResource($resourceSet, $segment->getResult());
227		}
228
229		/**
230		* Execute the client submitted request against the data source (PUT).
231		*/
232		protected function executePut()
233		{
234		$segment = $this->getFinalEffectiveSegment();
235		$requestMethod = $this->getService()->getOperationContext()->incomingRequest()->getMethod();
236		$resourceSet = $segment->getTargetResourceSetWrapper();
237		$keyDescriptor = $segment->getKeyDescriptor();
238
239		$this->checkUriValidForSuppliedVerb($resourceSet, $keyDescriptor, $requestMethod);
240
241		$data = $this->getRequest()->getData();
242		if (!$data) {
243		throw ODataException::createBadRequestError(Messages::noDataForThisVerb($requestMethod));
244		}
245
246		$queryResult = $this->getProviders()->updateResource(
247		$resourceSet,
248		$segment->getResult(),
249		$keyDescriptor,
250		$data,
		1 ignored issue – show Documentation introduced 2017-07-10 06:21 UTC by Report Bug Copy Issue Report `$data` is of type `array`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
251		false
252		);
253		$segment->setResult($queryResult);
254		}
255
256		/**
257		* Execute the client submitted request against the data source (POST).
258		*/
259		protected function executePost()
260		{
261		$segments = $this->getRequest()->getSegments();
262		$requestMethod = $this->getService()->getOperationContext()->incomingRequest()->getMethod();
263
264		foreach ($segments as $segment) {
265		$requestTargetKind = $segment->getTargetKind();
266		if ($requestTargetKind == TargetKind::RESOURCE()) {
267		$resourceSet = $segment->getTargetResourceSetWrapper();
268		$keyDescriptor = $segment->getKeyDescriptor();
269
270		$data = $this->getRequest()->getData();
271		if (empty($data)) {
272		throw ODataException::createBadRequestError(Messages::noDataForThisVerb($requestMethod));
273		}
274		$queryResult = $this->getProviders()->createResourceforResourceSet($resourceSet, $keyDescriptor, $data);
		1 ignored issue – show Documentation introduced 2017-07-10 06:21 UTC by Report Bug Copy Issue Report `$data` is of type `array`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
275		$segment->setResult($queryResult);
276		}
277		}
278		}
279
280		/**
281		* @return null\|SegmentDescriptor
282		*/
283		protected function getFinalEffectiveSegment()
284		{
285		$segment = $this->getRequest()->getLastSegment();
286		// if last segment is $count, back up one
287		if (ODataConstants::URI_COUNT_SEGMENT == $segment->getIdentifier()) {
288		$segment = $segment->getPrevious();
289		return $segment;
290		}
291		return $segment;
292		}
293
294		/**
295		* @param $resourceSet
296		* @param $keyDescriptor
297		* @param $requestMethod
298		* @throws ODataException
299		*/
300	View Code Duplication	protected function checkUriValidForSuppliedVerb($resourceSet, $keyDescriptor, $requestMethod)
		0 ignored issues – show Duplication introduced 2017-07-10 06:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
301		{
302		if (!$resourceSet \|\| !$keyDescriptor) {
303		$url = $this->getService()->getHost()->getAbsoluteRequestUri()->getUrlAsString();
304		throw ODataException::createBadRequestError(
305		Messages::badRequestInvalidUriForThisVerb($url, $requestMethod)
306		);
307		}
308		}
309
310		/**
311		* @param $segment
312		*/
313		private function executeGetSingleton($segment)
314		{
315		$segmentId = $segment->getIdentifier();
316		$singleton = $this->getService()->getProvidersWrapper()->resolveSingleton($segmentId);
317		$segment->setResult($singleton->get());
318		}
319
320		/**
321		* @param $segment
322		*/
323		private function executeGetResource($segment)
324		{
325		if ($segment->isSingleResult()) {
326		$queryResult = $this->getProviders()->getResourceFromResourceSet(
327		$segment->getTargetResourceSetWrapper(),
328		$segment->getKeyDescriptor()
329		);
330		} else {
331		$skip = $this->getRequest()->getSkipCount();
332		$skip = (null === $skip) ? 0 : $skip;
333		$skipToken = $this->getRequest()->getInternalSkipTokenInfo();
334		$skipToken = (null != $skipToken) ? $skipToken->getSkipTokenInfo() : null;
335		$queryResult = $this->getProviders()->getResourceSet(
336		$this->getRequest()->queryType,
337		$segment->getTargetResourceSetWrapper(),
338		$this->getRequest()->getFilterInfo(),
339		$this->getRequest()->getInternalOrderByInfo(),
340		$this->getRequest()->getTopCount(),
341		$skip,
342		$skipToken
343		);
344		}
345		$segment->setResult($queryResult);
346		}
347
348		/**
349		* @param $segment
350		*/
351		private function executeGetLink($segment)
352		{
353		$previous = $segment->getPrevious();
354		assert(isset($previous));
355		$segment->setResult($previous->getResult());
356		}
357		}
358

Algo-Web / POData

Push — master ( 2b99ce...30750d )

UriProcessorNew::getService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like