Completed
Pull Request — master (#267)
by Alex
08:55
created

BaseService::getResponseContentType()   C

Complexity

Conditions 16
Paths 60

Size

Total Lines 108
Code Lines 58

Duplication

Lines 0
Ratio 0 %

Importance

Changes 3
Bugs 0 Features 0
Metric Value
cc 16
eloc 58
c 3
b 0
f 0
nc 60
nop 2
dl 0
loc 108
rs 5.5666

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
declare(strict_types=1);
4
5
namespace POData;
6
7
use Exception;
8
use POData\BatchProcessor\BatchProcessor;
9
use POData\Common\ErrorHandler;
10
use POData\Common\HttpStatus;
11
use POData\Common\InvalidOperationException;
12
use POData\Common\Messages;
13
use POData\Common\MimeTypes;
14
use POData\Common\ODataConstants;
15
use POData\Common\ODataException;
16
use POData\Common\ReflectionHandler;
17
use POData\Common\Version;
18
use POData\Configuration\IServiceConfiguration;
19
use POData\Configuration\ServiceConfiguration;
20
use POData\ObjectModel\IObjectSerialiser;
21
use POData\ObjectModel\ObjectModelSerializer;
22
use POData\ObjectModel\ODataFeed;
23
use POData\ObjectModel\ODataURLCollection;
24
use POData\OperationContext\HTTPRequestMethod;
25
use POData\OperationContext\IOperationContext;
26
use POData\OperationContext\ServiceHost;
27
use POData\Providers\Metadata\IMetadataProvider;
28
use POData\Providers\Metadata\ResourceType;
29
use POData\Providers\Metadata\Type\Binary;
30
use POData\Providers\Metadata\Type\IType;
31
use POData\Providers\ProvidersWrapper;
32
use POData\Providers\Query\IQueryProvider;
33
use POData\Providers\Query\QueryResult;
34
use POData\Providers\Stream\IStreamProvider2;
35
use POData\Providers\Stream\StreamProviderWrapper;
36
use POData\Readers\Atom\AtomODataReader;
37
use POData\Readers\ODataReaderRegistry;
38
use POData\UriProcessor\Interfaces\IUriProcessor;
39
use POData\UriProcessor\RequestDescription;
40
use POData\UriProcessor\ResourcePathProcessor\SegmentParser\TargetKind;
41
use POData\UriProcessor\UriProcessorNew;
42
use POData\Writers\Atom\AtomODataWriter;
43
use POData\Writers\Json\JsonLightMetadataLevel;
44
use POData\Writers\Json\JsonLightODataWriter;
45
use POData\Writers\Json\JsonODataV1Writer;
46
use POData\Writers\Json\JsonODataV2Writer;
47
use POData\Writers\ODataWriterRegistry;
48
use POData\Writers\ResponseWriter;
49
use ReflectionException;
50
51
/**
52
 * Class BaseService.
53
 *
54
 * The base class for all BaseService specific classes. This class implements
55
 * the following interfaces:
56
 *  (1) IRequestHandler
57
 *      Implementing this interface requires defining the function
58
 *      'handleRequest' that will be invoked by dispatcher
59
 *  (2) IService
60
 *      Force BaseService class to implement functions for custom
61
 *      data service providers
62
 */
63
abstract class BaseService implements IRequestHandler, IService
64
{
65
    /**
66
     * The wrapper over IStreamProvider implementation.
67
     *
68
     * @var StreamProviderWrapper
69
     */
70
    protected $streamProvider;
71
    /**
72
     * To hold reference to ServiceConfiguration instance where the
73
     * service specific rules (page limit, resource set access rights
74
     * etc...) are defined.
75
     *
76
     * @var IServiceConfiguration
77
     */
78
    protected $config;
79
    /**
80
     * Hold reference to object serialiser - bit wot turns PHP objects
81
     * into message traffic on wire.
82
     *
83
     * @var IObjectSerialiser
84
     */
85
    protected $objectSerialiser;
86
    /** @var ODataWriterRegistry */
87
    protected $writerRegistry;
88
    /** @var ODataReaderRegistry */
89
    protected $readerRegistry;
90
    /**
91
     * The wrapper over IQueryProvider and IMetadataProvider implementations.
92
     *
93
     * @var ProvidersWrapper
94
     */
95
    private $providersWrapper;
96
    /**
97
     * Hold reference to the ServiceHost instance created by dispatcher,
98
     * using this library can access headers and body of Http Request
99
     * dispatcher received and the Http Response Dispatcher is going to send.
100
     *
101
     * @var ServiceHost
102
     */
103
    private $serviceHost;
104
105
    /**
106
     * BaseService constructor.
107
     * @param  IObjectSerialiser|null     $serialiser
108
     * @param  IMetadataProvider|null     $metaProvider
109
     * @param  IServiceConfiguration|null $config
110
     * @throws Exception
111
     */
112
    protected function __construct(
113
        IObjectSerialiser $serialiser = null,
114
        IMetadataProvider $metaProvider = null,
115
        IServiceConfiguration $config = null
116
    ) {
117
        if (null != $serialiser) {
118
            $serialiser->setService($this);
119
        } else {
120
            $serialiser = new ObjectModelSerializer($this, null);
121
        }
122
        $this->config           = $config ?? $this->initializeDefaultConfig(new ServiceConfiguration($metaProvider));
123
        $this->objectSerialiser = $serialiser;
124
    }
125
126
    //TODO: shouldn't we hide this from the interface..if we need it at all.
127
128
    protected function initializeDefaultConfig(IServiceConfiguration $config)
129
    {
130
        return $config;
131
    }
132
133
    /**
134
     * Sets the data service host instance.
135
     *
136
     * @param ServiceHost $serviceHost The data service host instance
137
     */
138
    public function setHost(ServiceHost $serviceHost): void
139
    {
140
        $this->serviceHost = $serviceHost;
141
    }
142
143
    /**
144
     * To get reference to operation context where we have direct access to
145
     * headers and body of Http Request, we have received and the Http Response
146
     * We are going to send.
147
     *
148
     * @return IOperationContext
149
     */
150
    public function getOperationContext(): IOperationContext
151
    {
152
        return $this->getHost()->getOperationContext();
153
    }
154
155
    /**
156
     * Get reference to the data service host instance.
157
     *
158
     * @return ServiceHost
159
     */
160
    public function getHost(): ServiceHost
161
    {
162
        assert(null != $this->serviceHost);
163
164
        return $this->serviceHost;
165
    }
166
167
    /**
168
     * Get reference to the wrapper over IStreamProvider or
169
     * IStreamProvider2 implementations.
170
     *
171
     * @return StreamProviderWrapper
172
     */
173
    public function getStreamProvider(): StreamProviderWrapper
174
    {
175
        if (null === $this->streamProvider) {
176
            $this->streamProvider = new StreamProviderWrapper();
177
            $this->streamProvider->setService($this);
178
        }
179
180
        return $this->streamProvider;
181
    }
182
183
    /**
184
     * Top-level handler invoked by Dispatcher against any request to this
185
     * service. This method will hand over request processing task to other
186
     * functions which process the request, set required headers and Response
187
     * stream (if any in Atom/Json format) in
188
     * WebOperationContext::Current()::OutgoingWebResponseContext.
189
     * Once this function returns, dispatcher uses global WebOperationContext
190
     * to write out the request response to client.
191
     * This function will perform the following operations:
192
     * (1) Check whether the top level service class implements
193
     *     IServiceProvider which means the service is a custom service, in
194
     *     this case make sure the top level service class implements
195
     *     IMetaDataProvider and IQueryProvider.
196
     *     These are the minimal interfaces that a custom service to be
197
     *     implemented in order to expose its data as OData. Save reference to
198
     *     These interface implementations.
199
     *     NOTE: Here we will ensure only providers for IDSQP and IDSMP. The
200
     *     IDSSP will be ensured only when there is an GET request on MLE/Named
201
     *     stream.
202
     *
203
     * (2). Invoke 'Initialize' method of top level service for
204
     *      collecting the configuration rules set by the developer for this
205
     *      service.
206
     *
207
     * (3). Invoke the Uri processor to process the request URI. The uri
208
     *      processor will do the following:
209
     *      (a). Validate the request uri syntax using OData uri rules
210
     *      (b). Validate the request using metadata of this service
211
     *      (c). Parse the request uri and using, IQueryProvider
212
     *           implementation, fetches the resources pointed by the uri
213
     *           if required
214
     *      (d). Build a RequestDescription which encapsulate everything
215
     *           related to request uri (e.g. type of resource, result
216
     *           etc...)
217
     * (3). Invoke handleRequest2 for further processing
218
     * @throws ODataException
219
     */
220
    public function handleRequest()
221
    {
222
        try {
223
            $this->createProviders();
224
            $this->getHost()->validateQueryParameters();
225
            $uriProcessor = UriProcessorNew::process($this);
226
            $request      = $uriProcessor->getRequest();
227
            if (TargetKind::BATCH() == $request->getTargetKind()) {
228
                //dd($request);
229
                $this->getProvidersWrapper()->startTransaction(true);
230
                try {
231
                    $this->handleBatchRequest($request);
232
                } catch (Exception $ex) {
233
                    $this->getProvidersWrapper()->rollBackTransaction();
234
                    throw $ex;
235
                }
236
                $this->getProvidersWrapper()->commitTransaction();
237
            } else {
238
                $this->serializeResult($request, $uriProcessor);
239
            }
240
        } catch (Exception $exception) {
241
            ErrorHandler::handleException($exception, $this);
242
            // Return to dispatcher for writing serialized exception
243
            return;
244
        }
245
    }
246
247
    /**
248
     * This method will query and validates for IMetadataProvider and IQueryProvider implementations, invokes
249
     * BaseService::Initialize to initialize service specific policies.
250
     *
251
     * @throws ODataException
252
     * @throws Exception
253
     */
254
    protected function createProviders()
255
    {
256
        $metadataProvider = $this->getMetadataProvider();
257
        if (null === $metadataProvider) {
258
            throw ODataException::createInternalServerError(Messages::providersWrapperNull());
259
        }
260
261
        if (!$metadataProvider instanceof IMetadataProvider) {
0 ignored issues
show
introduced by
$metadataProvider is always a sub-type of POData\Providers\Metadata\IMetadataProvider.
Loading history...
262
            throw ODataException::createInternalServerError(Messages::invalidMetadataInstance());
263
        }
264
265
        $queryProvider = $this->getQueryProvider();
266
267
        if (null === $queryProvider) {
268
            throw ODataException::createInternalServerError(Messages::providersWrapperNull());
269
        }
270
271
        $this->providersWrapper = new ProvidersWrapper(
272
            $metadataProvider,
273
            $queryProvider,
274
            $this->config
275
        );
276
277
        $this->initialize($this->config);
278
279
        //TODO: this seems like a bad spot to do this
280
        $this->writerRegistry = new ODataWriterRegistry();
281
        $this->readerRegistry = new ODataReaderRegistry();
282
        $this->registerWriters();
283
        $this->registerReaders();
284
    }
285
286
    /**
287
     * @return IMetadataProvider
288
     */
289
    abstract public function getMetadataProvider();
290
291
    /**
292
     * @return IQueryProvider|null
293
     */
294
    abstract public function getQueryProvider(): ?IQueryProvider;
295
296
    /**
297
     * @throws Exception
298
     */
299
    public function registerWriters()
300
    {
301
        $registry       = $this->getODataWriterRegistry();
302
        $serviceVersion = $this->getConfiguration()->getMaxDataServiceVersion();
303
        $serviceURI     = $this->getHost()->getAbsoluteServiceUri()->getUrlAsString();
304
305
        //We always register the v1 stuff
306
        $registry->register(
307
            new JsonODataV1Writer(
308
                $this->getConfiguration()->getLineEndings(),
309
                $this->getConfiguration()->getPrettyOutput()
310
            )
311
        );
312
        $registry->register(
313
            new AtomODataWriter(
314
                $this->getConfiguration()->getLineEndings(),
315
                $this->getConfiguration()->getPrettyOutput(),
316
                $serviceURI
317
            )
318
        );
319
320
        if (-1 < $serviceVersion->compare(Version::v2())) {
321
            $registry->register(
322
                new JsonODataV2Writer(
323
                    $this->getConfiguration()->getLineEndings(),
324
                    $this->getConfiguration()->getPrettyOutput()
325
                )
326
            );
327
        }
328
329
        if (-1 < $serviceVersion->compare(Version::v3())) {
330
            $registry->register(
331
                new JsonLightODataWriter(
332
                    $this->getConfiguration()->getLineEndings(),
333
                    $this->getConfiguration()->getPrettyOutput(),
334
                    JsonLightMetadataLevel::NONE(),
335
                    $serviceURI
336
                )
337
            );
338
            $registry->register(
339
                new JsonLightODataWriter(
340
                    $this->getConfiguration()->getLineEndings(),
341
                    $this->getConfiguration()->getPrettyOutput(),
342
                    JsonLightMetadataLevel::MINIMAL(),
343
                    $serviceURI
344
                )
345
            );
346
            $registry->register(
347
                new JsonLightODataWriter(
348
                    $this->getConfiguration()->getLineEndings(),
349
                    $this->getConfiguration()->getPrettyOutput(),
350
                    JsonLightMetadataLevel::FULL(),
351
                    $serviceURI
352
                )
353
            );
354
        }
355
    }
356
357
    /**
358
     * Returns the ODataWriterRegistry to use when writing the response to a service document or resource request.
359
     *
360
     * @return ODataWriterRegistry
361
     */
362
    public function getODataWriterRegistry(): ODataWriterRegistry
363
    {
364
        assert(null != $this->writerRegistry);
365
366
        return $this->writerRegistry;
367
    }
368
369
    /**
370
     * Gets reference to ServiceConfiguration instance so that
371
     * service specific rules defined by the developer can be
372
     * accessed.
373
     *
374
     * @return IServiceConfiguration
375
     */
376
    public function getConfiguration(): IServiceConfiguration
377
    {
378
        assert(null != $this->config);
379
380
        return $this->config;
381
    }
382
383
    public function registerReaders()
384
    {
385
        $registry = $this->getODataReaderRegistry();
386
        //We always register the v1 stuff
387
        $registry->register(new AtomODataReader());
388
    }
389
390
    /**
391
     * Returns the ODataReaderRegistry to use when writing the response to a service document or resource request.
392
     *
393
     * @return ODataReaderRegistry
394
     */
395
    public function getODataReaderRegistry(): ODataReaderRegistry
396
    {
397
        assert(null != $this->writerRegistry);
398
399
        return $this->readerRegistry;
400
    }
401
402
    /**
403
     * Get the wrapper over developer's IQueryProvider and IMetadataProvider implementation.
404
     *
405
     * @return ProvidersWrapper
406
     */
407
    public function getProvidersWrapper(): ProvidersWrapper
408
    {
409
        return $this->providersWrapper;
410
    }
411
412
    /**
413
     * @param $request
414
     * @throws ODataException
415
     */
416
    private function handleBatchRequest($request)
417
    {
418
        $cloneThis      = clone $this;
419
        $batchProcessor = new BatchProcessor($cloneThis, $request);
420
        $batchProcessor->handleBatch();
421
        $response = $batchProcessor->getResponse();
422
        $this->getHost()->setResponseStatusCode(HttpStatus::CODE_ACCEPTED);
423
        $this->getHost()->setResponseContentType('multipart/mixed; boundary=' . $batchProcessor->getBoundary());
424
        // Hack: this needs to be sorted out in the future as we hookup other versions.
425
        $this->getHost()->setResponseVersion('3.0;');
426
        $this->getHost()->setResponseCacheControl(ODataConstants::HTTPRESPONSE_HEADER_CACHECONTROL_NOCACHE);
427
        $this->getHost()->getOperationContext()->outgoingResponse()->setStream($response);
428
    }
429
430
    //TODO: i don't want this to be public..but it's the only way to test it right now...
431
432
    /**
433
     * Serialize the requested resource.
434
     *
435
     * @param RequestDescription $request      The description of the request  submitted by the client
436
     * @param IUriProcessor      $uriProcessor Reference to the uri processor
437
     *
438
     * @throws Common\HttpHeaderFailure
439
     * @throws Common\UrlFormatException
440
     * @throws InvalidOperationException
441
     * @throws ODataException
442
     * @throws ReflectionException
443
     * @throws Exception
444
     */
445
    protected function serializeResult(RequestDescription $request, IUriProcessor $uriProcessor)
446
    {
447
448
        if ($this->getConfiguration()->getValidateETagHeader() && !$request->isETagHeaderAllowed() &&
449
            (null !== $this->getHost()->getRequestIfMatch() || null !== $this->getHost()->getRequestIfNoneMatch())) {
450
            throw ODataException::createBadRequestError(
451
                Messages::eTagCannotBeSpecified($this->getHost()->getAbsoluteRequestUri()->getUrlAsString())
452
            );
453
        }
454
455
        $responseContentType = $this->getResponseContentType($request, $uriProcessor);
456
457
        if (null === $responseContentType && $request->getTargetKind() != TargetKind::MEDIA_RESOURCE()) {
458
            //the responseContentType can ONLY be null if it's a stream (media resource) and
459
            // that stream is storing null as the content type
460
            throw new ODataException(Messages::unsupportedMediaType(), 415);
461
        }
462
463
        $odataModelInstance = null;
464
        $hasResponseBody    = true;
465
        // Execution required at this point if request points to any resource other than
466
467
        // (1) media resource - For Media resource 'getResponseContentType' already performed execution as
468
        // it needs to know the mime type of the stream
469
        // (2) metadata - internal resource
470
        // (3) service directory - internal resource
471
        if ($request->needExecution()) {
472
            $method = $this->getHost()->getOperationContext()->incomingRequest()->getMethod();
473
            $uriProcessor->execute();
474
            if (HTTPRequestMethod::DELETE() == $method) {
475
                $this->getHost()->setResponseStatusCode(HttpStatus::CODE_NOCONTENT);
476
                return;
477
            }
478
479
            $objectModelSerializer = $this->getObjectSerialiser();
480
            $objectModelSerializer->setRequest($request);
481
482
            $targetResourceType = $request->getTargetResourceType();
483
            if (null === $targetResourceType) {
484
                throw new InvalidOperationException('Target resource type cannot be null');
485
            }
486
487
            $methodIsNotPost   = (HTTPRequestMethod::POST() != $method);
488
            $methodIsNotDelete = (HTTPRequestMethod::DELETE() != $method);
489
            if (!$request->isSingleResult() && $methodIsNotPost) {
490
                // Code path for collection (feed or links)
491
                $entryObjects = $request->getTargetResult();
492
                assert($entryObjects instanceof QueryResult, '!$entryObjects instanceof QueryResult');
493
                assert(is_array($entryObjects->results), '!is_array($entryObjects->results)');
494
495
                // If related resource set is empty for an entry then we should
496
                // not throw error instead response must be empty feed or empty links
497
                $method = $request->isLinkUri() ? 'writeUrlElements' : 'writeTopLevelElements';
498
                $odataModelInstance = $objectModelSerializer->{$method}($entryObjects);
499
            } else {
500
                // Code path for entity, complex, bag, resource reference link,
501
                // primitive type or primitive value
502
                $result = $request->getTargetResult();
503
                if (!$result instanceof QueryResult) {
504
                    $result          = new QueryResult();
505
                    $result->results = $request->getTargetResult();
506
                }
507
                $requestTargetKind = $request->getTargetKind() ?? TargetKind::NOTHING();
508
                $requestProperty   = $request->getProjectedProperty();
509
                if ($request->isLinkUri() && $methodIsNotPost && $methodIsNotDelete) {
510
                    // In the query 'Orders(1245)/$links/Customer', the targeted
511
                    // Customer might be null
512
                    if (null === $result->results) {
513
                        throw ODataException::createResourceNotFoundError($request->getIdentifier());
514
                    }
515
                    $odataModelInstance = $objectModelSerializer->writeUrlElement($result);
516
                } elseif ($requestTargetKind->isRESOURCE() ||
517
                    $requestTargetKind->isSINGLETON()) {
518
                    if (null !== $this->getHost()->getRequestIfMatch()
519
                        && null !== $this->getHost()->getRequestIfNoneMatch()
520
                    ) {
521
                        throw ODataException::createBadRequestError(
522
                            Messages::bothIfMatchAndIfNoneMatchHeaderSpecified()
523
                        );
524
                    }
525
                    // handle entry resource
526
                    $needToSerializeResponse = true;
527
                    $eTag                    = $this->compareETag(
528
                        $result,
529
                        $targetResourceType,
530
                        $needToSerializeResponse
531
                    );
532
                    if ($needToSerializeResponse && null !== $result && null !== $result->results) {
533
                        $odataModelInstance = $objectModelSerializer->writeTopLevelElement($result);
534
                    } else {
535
                        // In the query 'Orders(1245)/Customer', the targeted
536
                        // Customer might be null
537
                        // set status code to 204 => 'No Content'
538
539
                        // Resource is not modified so set status code
540
                        // to 304 => 'Not Modified'
541
                        $status = $needToSerializeResponse ? HttpStatus::CODE_NOCONTENT : HttpStatus::CODE_NOT_MODIFIED ;
542
543
                        $this->getHost()->setResponseStatusCode($status);
544
                        $hasResponseBody = false;
545
                    }
546
547
                    // if resource has eTagProperty then eTag header needs to written
548
                    if (null !== $eTag) {
549
                        $this->getHost()->setResponseETag($eTag);
550
                    }
551
                } elseif ($requestTargetKind->isCOMPLEX_OBJECT() ||
552
                    $requestTargetKind->isBAG()) {
553
                    if ( null === $requestProperty) {
554
                        throw new InvalidOperationException('Projected request property cannot be null');
555
                    }
556
557
                    $serializeMethod = $requestTargetKind->isCOMPLEX_OBJECT() ? 'writeTopLevelComplexObject' : 'writeTopLevelBagObject';
558
                    $odataModelInstance = $objectModelSerializer->{$serializeMethod}(
559
                        $result,
560
                        $requestProperty->getName(),
561
                        $targetResourceType
562
                    );
563
                } elseif ($requestTargetKind->isPRIMITIVE()){
564
                    $odataModelInstance = $objectModelSerializer->writeTopLevelPrimitive(
565
                        $result,
566
                        $requestProperty
567
                    );
568
                } elseif ($requestTargetKind->isPRIMITIVE_VALUE()) {
569
                    // Code path for primitive value (Since its primitive no need for
570
                    // object model serialization)
571
                    // Customers('ANU')/CompanyName/$value => string
572
                    // Employees(1)/Photo/$value => binary stream
573
                    // Customers/$count => string
574
                } else {
575
                    throw new InvalidOperationException('Unexpected resource target kind');
576
                }
577
            }
578
        }
579
580
        //Note: Response content type can be null for named stream
581
        if ($hasResponseBody && null !== $responseContentType &&
582
            TargetKind::MEDIA_RESOURCE() != $request->getTargetKind() &&
583
            MimeTypes::MIME_APPLICATION_OCTETSTREAM != $responseContentType)
584
        {
585
            //append charset for everything except:
586
            //stream resources as they have their own content type
587
            //binary properties (they content type will be App Octet for those...is this a good way?
588
            //we could also decide based upon the projected property
589
590
            $responseContentType .= ';charset=utf-8';
591
        }
592
593
        if ($hasResponseBody) {
594
            ResponseWriter::write($this, $request, $odataModelInstance, $responseContentType);
595
        }
596
    }
597
598
    /**
599
     * Gets the response format for the requested resource.
600
     *
601
     * @param RequestDescription $request      The request submitted by client and it's execution result
602
     * @param IUriProcessor      $uriProcessor The reference to the IUriProcessor
603
     *
604
     * @throws Common\HttpHeaderFailure
605
     * @throws InvalidOperationException
606
     * @throws ODataException            , HttpHeaderFailure
607
     * @throws ReflectionException
608
     * @throws Common\UrlFormatException
609
     * @return string|null               the response content-type, a null value means the requested resource
610
     *                                   is named stream and IDSSP2::getStreamContentType returned null
611
     */
612
    public function getResponseContentType(
613
        RequestDescription $request,
614
        IUriProcessor $uriProcessor
615
    ): ?string {
616
        $baseMimeTypes = [
617
            MimeTypes::MIME_APPLICATION_JSON,
618
            MimeTypes::MIME_APPLICATION_JSON_FULL_META,
619
            MimeTypes::MIME_APPLICATION_JSON_NO_META,
620
            MimeTypes::MIME_APPLICATION_JSON_MINIMAL_META,
621
            MimeTypes::MIME_APPLICATION_JSON_VERBOSE,];
622
623
        // The Accept request-header field specifies media types which are acceptable for the response
624
625
        $host              = $this->getHost();
626
        $requestAcceptText = $host->getRequestAccept();
627
        $requestVersion    = $request->getResponseVersion();
628
629
        //if the $format header is present it overrides the accepts header
630
        $format = $host->getQueryStringItem(ODataConstants::HTTPQUERY_STRING_FORMAT);
631
        if (null !== $format) {
632
            //There's a strange edge case..if application/json is supplied and it's V3
633
            if (MimeTypes::MIME_APPLICATION_JSON == $format && Version::v3() == $requestVersion) {
634
                //then it's actual minimalmetadata
635
                //TODO: should this be done with the header text too?
636
                $format = MimeTypes::MIME_APPLICATION_JSON_MINIMAL_META;
637
            }
638
639
            $requestAcceptText = ServiceHost::translateFormatToMime($requestVersion, $format);
640
        }
641
642
        //The response format can be dictated by the target resource kind. IE a $value will be different then expected
643
        //getTargetKind doesn't deal with link resources directly and this can change things
644
        $targetKind = $request->isLinkUri() ? TargetKind::LINK() : $request->getTargetKind();
645
646
        $availableMimeTypesByTarget = [
647
            TargetKind::METADATA()->getValue()          => [MimeTypes::MIME_APPLICATION_XML],
648
            TargetKind::SERVICE_DIRECTORY()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_ATOMSERVICE], $baseMimeTypes),
649
            TargetKind::PRIMITIVE()->getValue()              => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes),
650
            TargetKind::COMPLEX_OBJECT()->getValue()              => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes),
651
            TargetKind::BAG()->getValue()              => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes),
652
            TargetKind::LINK()->getValue()              => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes),
653
            TargetKind::SINGLETON()->getValue()          => array_merge([MimeTypes::MIME_APPLICATION_ATOM], $baseMimeTypes),
654
            TargetKind::RESOURCE()->getValue()          => array_merge([MimeTypes::MIME_APPLICATION_ATOM], $baseMimeTypes),
655
        ];
656
657
        if($targetKind && array_key_exists($targetKind->getValue(),$availableMimeTypesByTarget)){
658
            return HttpProcessUtility::selectMimeType($requestAcceptText, $availableMimeTypesByTarget[$targetKind->getValue()]);
659
660
        }
661
        switch ($targetKind) {
662
            case TargetKind::PRIMITIVE_VALUE():
663
                $supportedResponseMimeTypes = [MimeTypes::MIME_TEXTPLAIN];
664
665
                if ('$count' != $request->getIdentifier()) {
666
                    $projectedProperty = $request->getProjectedProperty();
667
                    if (null === $projectedProperty) {
668
                        throw new InvalidOperationException('is_null($projectedProperty)');
669
                    }
670
                    $type = $projectedProperty->getInstanceType();
671
                    if (!$type instanceof IType) {
672
                        throw new InvalidOperationException('!$type instanceof IType');
673
                    }
674
                    if ($type instanceof Binary) {
675
                        $supportedResponseMimeTypes = [MimeTypes::MIME_APPLICATION_OCTETSTREAM];
676
                    }
677
                }
678
679
                return HttpProcessUtility::selectMimeType(
680
                    $requestAcceptText,
681
                    $supportedResponseMimeTypes
682
                );
683
684
685
            case TargetKind::MEDIA_RESOURCE():
686
                if (!$request->isNamedStream() && true !== $request->getTargetResourceType()->isMediaLinkEntry()) {
687
                    throw ODataException::createBadRequestError(
688
                        Messages::badRequestInvalidUriForMediaResource(
689
                            $host->getAbsoluteRequestUri()->getUrlAsString()
690
                        )
691
                    );
692
                }
693
694
                $uriProcessor->execute();
695
                $request->setExecuted();
696
                // DSSW::getStreamContentType can throw error in 2 cases
697
                // 1. If the required stream implementation not found
698
                // 2. If IDSSP::getStreamContentType returns NULL for MLE
699
                $responseContentType = $this->getStreamProviderWrapper()
700
                    ->getStreamContentType(
701
                        $request->getTargetResult(),
702
                        $request->getResourceStreamInfo()
703
                    );
704
705
                // Note StreamWrapper::getStreamContentType can return NULL if the requested named stream has not
706
                // yet been uploaded. But for an MLE if IDSSP::getStreamContentType returns NULL
707
                // then StreamWrapper will throw error
708
                if (null !== $responseContentType) {
0 ignored issues
show
introduced by
The condition null !== $responseContentType is always true.
Loading history...
709
                    $responseContentType = HttpProcessUtility::selectMimeType(
710
                        $requestAcceptText,
711
                        [$responseContentType]
712
                    );
713
                }
714
715
                return $responseContentType;
716
        }
717
718
        //If we got here, we just don't know what it is...
719
        throw new ODataException(Messages::unsupportedMediaType(), 415);
720
    }
721
722
    /**
723
     * Gets reference to wrapper class instance over IDSSP implementation.
724
     *
725
     * @return StreamProviderWrapper
726
     */
727
    public function getStreamProviderWrapper()
728
    {
729
        return $this->streamProvider;
730
    }
731
732
    /**
733
     * Get reference to object serialiser - bit wot turns PHP objects
734
     * into message traffic on wire.
735
     *
736
     * @return IObjectSerialiser
737
     */
738
    public function getObjectSerialiser(): IObjectSerialiser
739
    {
740
        assert(null != $this->objectSerialiser);
741
742
        return $this->objectSerialiser;
743
    }
744
745
    /**
746
     * For the given entry object compare its eTag (if it has eTag properties)
747
     * with current eTag request headers (if present).
748
     *
749
     * @param mixed        &$entryObject             entity resource for which etag
750
     *                                               needs to be checked
751
     * @param ResourceType &$resourceType            Resource type of the entry
752
     *                                               object
753
     * @param bool         &$needToSerializeResponse On return, this will contain
754
     *                                               True if response needs to be
755
     *                                               serialized, False otherwise
756
     *
757
     * @throws InvalidOperationException
758
     * @throws ReflectionException
759
     * @throws ODataException
760
     * @return string|null               The ETag for the entry object if it has eTag properties
761
     *                                   NULL otherwise
762
     */
763
    protected function compareETag(
764
        &$entryObject,
765
        ResourceType &$resourceType,
766
        &$needToSerializeResponse
767
    ): ?string {
768
        $needToSerializeResponse = true;
769
        $eTag                    = null;
770
        $ifMatch                 = $this->getHost()->getRequestIfMatch();
771
        $ifNoneMatch             = $this->getHost()->getRequestIfNoneMatch();
772
        if (null === $entryObject) {
773
            if (null !== $ifMatch) {
774
                throw ODataException::createPreConditionFailedError(
775
                    Messages::eTagNotAllowedForNonExistingResource()
776
                );
777
            }
778
779
            return null;
780
        }
781
782
        if ($this->getConfiguration()->getValidateETagHeader() && !$resourceType->hasETagProperties()) {
783
            if (null !== $ifMatch || null !== $ifNoneMatch) {
784
                // No eTag properties but request has eTag headers, bad request
785
                throw ODataException::createBadRequestError(
786
                    Messages::noETagPropertiesForType()
787
                );
788
            }
789
790
            // We need write the response but no eTag header
791
            return null;
792
        }
793
794
        if (!$this->getConfiguration()->getValidateETagHeader()) {
795
            // Configuration says do not validate ETag, so we will not write ETag header in the
796
            // response even though the requested resource support it
797
            return null;
798
        }
799
800
        if (null === $ifMatch && null === $ifNoneMatch) {
801
            // No request eTag header, we need to write the response
802
            // and eTag header
803
        } elseif (0 === strcmp(strval($ifMatch), '*')) {
804
            // If-Match:* => we need to write the response and eTag header
805
        } elseif (0 === strcmp(strval($ifNoneMatch), '*')) {
806
            // if-None-Match:* => Do not write the response (304 not modified),
807
            // but write eTag header
808
            $needToSerializeResponse = false;
809
        } else {
810
            $eTag = $this->getETagForEntry($entryObject, $resourceType);
811
            // Note: The following code for attaching the prefix W\"
812
            // and the suffix " can be done in getETagForEntry function
813
            // but that is causing an issue in Linux env where the
814
            // firefox browser is unable to parse the ETag in this case.
815
            // Need to follow up PHP core devs for this.
816
            $eTag = ODataConstants::HTTP_WEAK_ETAG_PREFIX . $eTag . '"';
817
            if (null !== $ifMatch) {
818
                if (0 != strcmp($eTag, $ifMatch)) {
819
                    // Requested If-Match value does not match with current
820
                    // eTag Value then pre-condition error
821
                    // http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
822
                    throw ODataException::createPreConditionFailedError(
823
                        Messages::eTagValueDoesNotMatch()
824
                    );
825
                }
826
            } elseif (0 === strcmp($eTag, $ifNoneMatch)) {
827
                //304 not modified, but in write eTag header
828
                $needToSerializeResponse = false;
829
            }
830
        }
831
832
        if (null === $eTag) {
833
            $eTag = $this->getETagForEntry($entryObject, $resourceType);
834
            // Note: The following code for attaching the prefix W\"
835
            // and the suffix " can be done in getETagForEntry function
836
            // but that is causing an issue in Linux env where the
837
            // firefox browser is unable to parse the ETag in this case.
838
            // Need to follow up PHP core devs for this.
839
            $eTag = ODataConstants::HTTP_WEAK_ETAG_PREFIX . $eTag . '"';
840
        }
841
842
        return $eTag;
843
    }
844
845
    /**
846
     * Returns the etag for the given resource.
847
     * Note: This function will not add W\" prefix and " suffix, that is caller's
848
     * responsibility.
849
     *
850
     * @param mixed        &$entryObject  Resource for which etag value needs to
851
     *                                    be returned
852
     * @param ResourceType &$resourceType Resource type of the $entryObject
853
     *
854
     * @throws InvalidOperationException
855
     * @throws ReflectionException
856
     * @throws ODataException
857
     * @return string|null               ETag value for the given resource (with values encoded
858
     *                                   for use in a URI) there are etag properties, NULL if
859
     *                                   there is no etag property
860
     */
861
    protected function getETagForEntry(&$entryObject, ResourceType &$resourceType): ?string
862
    {
863
        $eTag  = null;
864
        $comma = null;
865
        foreach ($resourceType->getETagProperties() as $eTagProperty) {
866
            $type = $eTagProperty->getInstanceType();
867
            if (!$type instanceof IType) {
868
                throw new InvalidOperationException('!$type instanceof IType');
869
            }
870
871
            $value    = null;
0 ignored issues
show
Unused Code introduced by
The assignment to $value is dead and can be removed.
Loading history...
872
            $property = $eTagProperty->getName();
873
            try {
874
                //TODO #88...also this seems like dupe work
875
                $value = ReflectionHandler::getProperty($entryObject, $property);
876
            } catch (ReflectionException $reflectionException) {
877
                throw ODataException::createInternalServerError(
878
                    Messages::failedToAccessProperty($property, $resourceType->getName())
879
                );
880
            }
881
882
            $eTagBase = $eTag . $comma;
883
            $eTag     = $eTagBase . ((null == $value) ? 'null' : $type->convertToOData($value));
884
885
            $comma = ',';
886
        }
887
888
        if (null !== $eTag) {
889
            // If eTag is made up of datetime or string properties then the above
890
            // IType::convertToOData will perform utf8 and url encode. But we don't
891
            // want this for eTag value.
892
            $eTag = urldecode(utf8_decode($eTag));
893
894
            return rtrim($eTag, ',');
895
        }
896
        return null;
897
    }
898
899
    /**
900
     * @return IStreamProvider2
901
     */
902
    abstract public function getStreamProviderX();
903
}
904