|
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) { |
|
|
|
|
|
|
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
|
|
|
$targetKindToSeralizeMethod = [ |
|
456
|
|
|
TargetKind::COMPLEX_OBJECT()->getValue() => 'writeTopLevelComplexObject', |
|
457
|
|
|
TargetKind::BAG()->getValue() => 'writeTopLevelBagObject', |
|
458
|
|
|
TargetKind::PRIMITIVE()->getValue() => 'writeTopLevelPrimitive', |
|
459
|
|
|
]; |
|
460
|
|
|
$targetKindsRequiringProperties = [ |
|
461
|
|
|
TargetKind::COMPLEX_OBJECT(), |
|
462
|
|
|
TargetKind::BAG() |
|
463
|
|
|
]; |
|
464
|
|
|
$justWrite = [ |
|
465
|
|
|
TargetKind::COMPLEX_OBJECT(), |
|
466
|
|
|
TargetKind::BAG(), |
|
467
|
|
|
TargetKind::PRIMITIVE() |
|
468
|
|
|
]; |
|
469
|
|
|
|
|
470
|
|
|
|
|
471
|
|
|
$responseContentType = $this->getResponseContentType($request, $uriProcessor); |
|
472
|
|
|
|
|
473
|
|
|
if (null === $responseContentType && $request->getTargetKind() != TargetKind::MEDIA_RESOURCE()) { |
|
474
|
|
|
//the responseContentType can ONLY be null if it's a stream (media resource) and |
|
475
|
|
|
// that stream is storing null as the content type |
|
476
|
|
|
throw new ODataException(Messages::unsupportedMediaType(), 415); |
|
477
|
|
|
} |
|
478
|
|
|
|
|
479
|
|
|
$odataModelInstance = null; |
|
480
|
|
|
$hasResponseBody = true; |
|
481
|
|
|
// Execution required at this point if request points to any resource other than |
|
482
|
|
|
|
|
483
|
|
|
// (1) media resource - For Media resource 'getResponseContentType' already performed execution as |
|
484
|
|
|
// it needs to know the mime type of the stream |
|
485
|
|
|
// (2) metadata - internal resource |
|
486
|
|
|
// (3) service directory - internal resource |
|
487
|
|
|
if ($request->needExecution()) { |
|
488
|
|
|
$method = $this->getHost()->getOperationContext()->incomingRequest()->getMethod(); |
|
489
|
|
|
$uriProcessor->execute(); |
|
490
|
|
|
if (HTTPRequestMethod::DELETE() == $method) { |
|
491
|
|
|
$this->getHost()->setResponseStatusCode(HttpStatus::CODE_NOCONTENT); |
|
492
|
|
|
return; |
|
493
|
|
|
} |
|
494
|
|
|
|
|
495
|
|
|
$objectModelSerializer = $this->getObjectSerialiser(); |
|
496
|
|
|
$objectModelSerializer->setRequest($request); |
|
497
|
|
|
|
|
498
|
|
|
$targetResourceType = $request->getTargetResourceType(); |
|
499
|
|
|
if (null === $targetResourceType) { |
|
500
|
|
|
throw new InvalidOperationException('Target resource type cannot be null'); |
|
501
|
|
|
} |
|
502
|
|
|
|
|
503
|
|
|
$methodIsNotPost = (HTTPRequestMethod::POST() != $method); |
|
504
|
|
|
$methodIsNotDelete = (HTTPRequestMethod::DELETE() != $method); |
|
505
|
|
|
if (!$request->isSingleResult() && $methodIsNotPost) { |
|
506
|
|
|
// Code path for collection (feed or links) |
|
507
|
|
|
$entryObjects = $request->getTargetResult(); |
|
508
|
|
|
assert($entryObjects instanceof QueryResult, '!$entryObjects instanceof QueryResult'); |
|
509
|
|
|
assert(is_array($entryObjects->results), '!is_array($entryObjects->results)'); |
|
510
|
|
|
|
|
511
|
|
|
// If related resource set is empty for an entry then we should |
|
512
|
|
|
// not throw error instead response must be empty feed or empty links |
|
513
|
|
|
if ($request->isLinkUri()) { |
|
514
|
|
|
$odataModelInstance = $objectModelSerializer->writeUrlElements($entryObjects); |
|
515
|
|
|
assert($odataModelInstance instanceof ODataURLCollection, '$odataModelInstance instanceof ODataURLCollection'); |
|
516
|
|
|
} else { |
|
517
|
|
|
$odataModelInstance = $objectModelSerializer->writeTopLevelElements($entryObjects); |
|
518
|
|
|
assert ($odataModelInstance instanceof ODataFeed , '!$odataModelInstance instanceof ODataFeed'); |
|
519
|
|
|
} |
|
520
|
|
|
} else { |
|
521
|
|
|
// Code path for entity, complex, bag, resource reference link, |
|
522
|
|
|
// primitive type or primitive value |
|
523
|
|
|
$result = $request->getTargetResult(); |
|
524
|
|
|
if (!$result instanceof QueryResult) { |
|
525
|
|
|
$result = new QueryResult(); |
|
526
|
|
|
$result->results = $request->getTargetResult(); |
|
527
|
|
|
} |
|
528
|
|
|
$requestTargetKind = $request->getTargetKind(); |
|
529
|
|
|
$requestProperty = $request->getProjectedProperty(); |
|
530
|
|
|
if ($request->isLinkUri()) { |
|
531
|
|
|
// In the query 'Orders(1245)/$links/Customer', the targeted |
|
532
|
|
|
// Customer might be null |
|
533
|
|
|
if (null === $result->results && $methodIsNotPost && $methodIsNotDelete) { |
|
534
|
|
|
throw ODataException::createResourceNotFoundError($request->getIdentifier()); |
|
535
|
|
|
} |
|
536
|
|
|
if ($methodIsNotPost && $methodIsNotDelete) { |
|
537
|
|
|
$odataModelInstance = $objectModelSerializer->writeUrlElement($result); |
|
538
|
|
|
} |
|
539
|
|
|
} elseif (TargetKind::RESOURCE() == $requestTargetKind |
|
540
|
|
|
|| TargetKind::SINGLETON() == $requestTargetKind) { |
|
541
|
|
|
if (null !== $this->getHost()->getRequestIfMatch() |
|
542
|
|
|
&& null !== $this->getHost()->getRequestIfNoneMatch() |
|
543
|
|
|
) { |
|
544
|
|
|
throw ODataException::createBadRequestError( |
|
545
|
|
|
Messages::bothIfMatchAndIfNoneMatchHeaderSpecified() |
|
546
|
|
|
); |
|
547
|
|
|
} |
|
548
|
|
|
// handle entry resource |
|
549
|
|
|
$needToSerializeResponse = true; |
|
550
|
|
|
$eTag = $this->compareETag( |
|
551
|
|
|
$result, |
|
552
|
|
|
$targetResourceType, |
|
553
|
|
|
$needToSerializeResponse |
|
554
|
|
|
); |
|
555
|
|
|
if ($needToSerializeResponse) { |
|
556
|
|
|
if (null === $result || null === $result->results) { |
|
557
|
|
|
// In the query 'Orders(1245)/Customer', the targeted |
|
558
|
|
|
// Customer might be null |
|
559
|
|
|
// set status code to 204 => 'No Content' |
|
560
|
|
|
$this->getHost()->setResponseStatusCode(HttpStatus::CODE_NOCONTENT); |
|
561
|
|
|
$hasResponseBody = false; |
|
562
|
|
|
} else { |
|
563
|
|
|
$odataModelInstance = $objectModelSerializer->writeTopLevelElement($result); |
|
564
|
|
|
} |
|
565
|
|
|
} else { |
|
566
|
|
|
// Resource is not modified so set status code |
|
567
|
|
|
// to 304 => 'Not Modified' |
|
568
|
|
|
$this->getHost()->setResponseStatusCode(HttpStatus::CODE_NOT_MODIFIED); |
|
569
|
|
|
$hasResponseBody = false; |
|
570
|
|
|
} |
|
571
|
|
|
|
|
572
|
|
|
// if resource has eTagProperty then eTag header needs to written |
|
573
|
|
|
if (null !== $eTag) { |
|
574
|
|
|
$this->getHost()->setResponseETag($eTag); |
|
575
|
|
|
} |
|
576
|
|
|
} elseif (in_array($requestTargetKind, $justWrite)) { |
|
577
|
|
|
$needsRequestProperty = in_array($requestTargetKind, $targetKindsRequiringProperties); |
|
578
|
|
|
if (in_array($requestTargetKind, $targetKindsRequiringProperties) && null === $requestProperty) { |
|
579
|
|
|
throw new InvalidOperationException('Projected request property cannot be null'); |
|
580
|
|
|
} |
|
581
|
|
|
$property = $needsRequestProperty ? $requestProperty->getName() : $requestProperty; |
|
582
|
|
|
$odataModelInstance = $objectModelSerializer->{$targetKindToSeralizeMethod[$requestTargetKind->getValue()]}( |
|
583
|
|
|
$result, |
|
584
|
|
|
$property, |
|
585
|
|
|
$targetResourceType |
|
586
|
|
|
); |
|
587
|
|
|
} elseif (TargetKind::PRIMITIVE_VALUE() == $requestTargetKind) { |
|
588
|
|
|
// Code path for primitive value (Since its primitive no need for |
|
589
|
|
|
// object model serialization) |
|
590
|
|
|
// Customers('ANU')/CompanyName/$value => string |
|
591
|
|
|
// Employees(1)/Photo/$value => binary stream |
|
592
|
|
|
// Customers/$count => string |
|
593
|
|
|
} else { |
|
594
|
|
|
throw new InvalidOperationException('Unexpected resource target kind'); |
|
595
|
|
|
} |
|
596
|
|
|
} |
|
597
|
|
|
} |
|
598
|
|
|
|
|
599
|
|
|
//Note: Response content type can be null for named stream |
|
600
|
|
|
if ($hasResponseBody && null !== $responseContentType) { |
|
601
|
|
|
if (TargetKind::MEDIA_RESOURCE() != $request->getTargetKind() |
|
602
|
|
|
&& MimeTypes::MIME_APPLICATION_OCTETSTREAM != $responseContentType) { |
|
603
|
|
|
//append charset for everything except: |
|
604
|
|
|
//stream resources as they have their own content type |
|
605
|
|
|
//binary properties (they content type will be App Octet for those...is this a good way? |
|
606
|
|
|
//we could also decide based upon the projected property |
|
607
|
|
|
|
|
608
|
|
|
$responseContentType .= ';charset=utf-8'; |
|
609
|
|
|
} |
|
610
|
|
|
} |
|
611
|
|
|
|
|
612
|
|
|
if ($hasResponseBody) { |
|
613
|
|
|
ResponseWriter::write($this, $request, $odataModelInstance, $responseContentType); |
|
614
|
|
|
} |
|
615
|
|
|
} |
|
616
|
|
|
|
|
617
|
|
|
/** |
|
618
|
|
|
* Gets the response format for the requested resource. |
|
619
|
|
|
* |
|
620
|
|
|
* @param RequestDescription $request The request submitted by client and it's execution result |
|
621
|
|
|
* @param IUriProcessor $uriProcessor The reference to the IUriProcessor |
|
622
|
|
|
* |
|
623
|
|
|
* @throws Common\HttpHeaderFailure |
|
624
|
|
|
* @throws InvalidOperationException |
|
625
|
|
|
* @throws ODataException , HttpHeaderFailure |
|
626
|
|
|
* @throws ReflectionException |
|
627
|
|
|
* @throws Common\UrlFormatException |
|
628
|
|
|
* @return string|null the response content-type, a null value means the requested resource |
|
629
|
|
|
* is named stream and IDSSP2::getStreamContentType returned null |
|
630
|
|
|
*/ |
|
631
|
|
|
public function getResponseContentType( |
|
632
|
|
|
RequestDescription $request, |
|
633
|
|
|
IUriProcessor $uriProcessor |
|
634
|
|
|
): ?string { |
|
635
|
|
|
$baseMimeTypes = [ |
|
636
|
|
|
MimeTypes::MIME_APPLICATION_JSON, |
|
637
|
|
|
MimeTypes::MIME_APPLICATION_JSON_FULL_META, |
|
638
|
|
|
MimeTypes::MIME_APPLICATION_JSON_NO_META, |
|
639
|
|
|
MimeTypes::MIME_APPLICATION_JSON_MINIMAL_META, |
|
640
|
|
|
MimeTypes::MIME_APPLICATION_JSON_VERBOSE,]; |
|
641
|
|
|
|
|
642
|
|
|
// The Accept request-header field specifies media types which are acceptable for the response |
|
643
|
|
|
|
|
644
|
|
|
$host = $this->getHost(); |
|
645
|
|
|
$requestAcceptText = $host->getRequestAccept(); |
|
646
|
|
|
$requestVersion = $request->getResponseVersion(); |
|
647
|
|
|
|
|
648
|
|
|
//if the $format header is present it overrides the accepts header |
|
649
|
|
|
$format = $host->getQueryStringItem(ODataConstants::HTTPQUERY_STRING_FORMAT); |
|
650
|
|
|
if (null !== $format) { |
|
651
|
|
|
//There's a strange edge case..if application/json is supplied and it's V3 |
|
652
|
|
|
if (MimeTypes::MIME_APPLICATION_JSON == $format && Version::v3() == $requestVersion) { |
|
653
|
|
|
//then it's actual minimalmetadata |
|
654
|
|
|
//TODO: should this be done with the header text too? |
|
655
|
|
|
$format = MimeTypes::MIME_APPLICATION_JSON_MINIMAL_META; |
|
656
|
|
|
} |
|
657
|
|
|
|
|
658
|
|
|
$requestAcceptText = ServiceHost::translateFormatToMime($requestVersion, $format); |
|
659
|
|
|
} |
|
660
|
|
|
|
|
661
|
|
|
//The response format can be dictated by the target resource kind. IE a $value will be different then expected |
|
662
|
|
|
//getTargetKind doesn't deal with link resources directly and this can change things |
|
663
|
|
|
$targetKind = $request->isLinkUri() ? TargetKind::LINK() : $request->getTargetKind(); |
|
664
|
|
|
|
|
665
|
|
|
$availableMimeTypesByTarget = [ |
|
666
|
|
|
TargetKind::METADATA()->getValue() => [MimeTypes::MIME_APPLICATION_XML], |
|
667
|
|
|
TargetKind::SERVICE_DIRECTORY()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_ATOMSERVICE], $baseMimeTypes), |
|
668
|
|
|
TargetKind::PRIMITIVE()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes), |
|
669
|
|
|
TargetKind::COMPLEX_OBJECT()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes), |
|
670
|
|
|
TargetKind::BAG()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes), |
|
671
|
|
|
TargetKind::LINK()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_XML, MimeTypes::MIME_TEXTXML,], $baseMimeTypes), |
|
672
|
|
|
TargetKind::SINGLETON()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_ATOM], $baseMimeTypes), |
|
673
|
|
|
TargetKind::RESOURCE()->getValue() => array_merge([MimeTypes::MIME_APPLICATION_ATOM], $baseMimeTypes), |
|
674
|
|
|
]; |
|
675
|
|
|
|
|
676
|
|
|
if($targetKind && array_key_exists($targetKind->getValue(),$availableMimeTypesByTarget)){ |
|
677
|
|
|
return HttpProcessUtility::selectMimeType($requestAcceptText, $availableMimeTypesByTarget[$targetKind->getValue()]); |
|
678
|
|
|
|
|
679
|
|
|
} |
|
680
|
|
|
switch ($targetKind) { |
|
681
|
|
|
case TargetKind::PRIMITIVE_VALUE(): |
|
682
|
|
|
$supportedResponseMimeTypes = [MimeTypes::MIME_TEXTPLAIN]; |
|
683
|
|
|
|
|
684
|
|
|
if ('$count' != $request->getIdentifier()) { |
|
685
|
|
|
$projectedProperty = $request->getProjectedProperty(); |
|
686
|
|
|
if (null === $projectedProperty) { |
|
687
|
|
|
throw new InvalidOperationException('is_null($projectedProperty)'); |
|
688
|
|
|
} |
|
689
|
|
|
$type = $projectedProperty->getInstanceType(); |
|
690
|
|
|
if (!$type instanceof IType) { |
|
691
|
|
|
throw new InvalidOperationException('!$type instanceof IType'); |
|
692
|
|
|
} |
|
693
|
|
|
if ($type instanceof Binary) { |
|
694
|
|
|
$supportedResponseMimeTypes = [MimeTypes::MIME_APPLICATION_OCTETSTREAM]; |
|
695
|
|
|
} |
|
696
|
|
|
} |
|
697
|
|
|
|
|
698
|
|
|
return HttpProcessUtility::selectMimeType( |
|
699
|
|
|
$requestAcceptText, |
|
700
|
|
|
$supportedResponseMimeTypes |
|
701
|
|
|
); |
|
702
|
|
|
|
|
703
|
|
|
|
|
704
|
|
|
case TargetKind::MEDIA_RESOURCE(): |
|
705
|
|
|
if (!$request->isNamedStream() && !$request->getTargetResourceType()->isMediaLinkEntry()) { |
|
706
|
|
|
throw ODataException::createBadRequestError( |
|
707
|
|
|
Messages::badRequestInvalidUriForMediaResource( |
|
708
|
|
|
$host->getAbsoluteRequestUri()->getUrlAsString() |
|
709
|
|
|
) |
|
710
|
|
|
); |
|
711
|
|
|
} |
|
712
|
|
|
|
|
713
|
|
|
$uriProcessor->execute(); |
|
714
|
|
|
$request->setExecuted(); |
|
715
|
|
|
// DSSW::getStreamContentType can throw error in 2 cases |
|
716
|
|
|
// 1. If the required stream implementation not found |
|
717
|
|
|
// 2. If IDSSP::getStreamContentType returns NULL for MLE |
|
718
|
|
|
$responseContentType = $this->getStreamProviderWrapper() |
|
719
|
|
|
->getStreamContentType( |
|
720
|
|
|
$request->getTargetResult(), |
|
721
|
|
|
$request->getResourceStreamInfo() |
|
722
|
|
|
); |
|
723
|
|
|
|
|
724
|
|
|
// Note StreamWrapper::getStreamContentType can return NULL if the requested named stream has not |
|
725
|
|
|
// yet been uploaded. But for an MLE if IDSSP::getStreamContentType returns NULL |
|
726
|
|
|
// then StreamWrapper will throw error |
|
727
|
|
|
if (null !== $responseContentType) { |
|
|
|
|
|
|
728
|
|
|
$responseContentType = HttpProcessUtility::selectMimeType( |
|
729
|
|
|
$requestAcceptText, |
|
730
|
|
|
[$responseContentType] |
|
731
|
|
|
); |
|
732
|
|
|
} |
|
733
|
|
|
|
|
734
|
|
|
return $responseContentType; |
|
735
|
|
|
} |
|
736
|
|
|
|
|
737
|
|
|
//If we got here, we just don't know what it is... |
|
738
|
|
|
throw new ODataException(Messages::unsupportedMediaType(), 415); |
|
739
|
|
|
} |
|
740
|
|
|
|
|
741
|
|
|
/** |
|
742
|
|
|
* Gets reference to wrapper class instance over IDSSP implementation. |
|
743
|
|
|
* |
|
744
|
|
|
* @return StreamProviderWrapper |
|
745
|
|
|
*/ |
|
746
|
|
|
public function getStreamProviderWrapper() |
|
747
|
|
|
{ |
|
748
|
|
|
return $this->streamProvider; |
|
749
|
|
|
} |
|
750
|
|
|
|
|
751
|
|
|
/** |
|
752
|
|
|
* Get reference to object serialiser - bit wot turns PHP objects |
|
753
|
|
|
* into message traffic on wire. |
|
754
|
|
|
* |
|
755
|
|
|
* @return IObjectSerialiser |
|
756
|
|
|
*/ |
|
757
|
|
|
public function getObjectSerialiser(): IObjectSerialiser |
|
758
|
|
|
{ |
|
759
|
|
|
assert(null != $this->objectSerialiser); |
|
760
|
|
|
|
|
761
|
|
|
return $this->objectSerialiser; |
|
762
|
|
|
} |
|
763
|
|
|
|
|
764
|
|
|
/** |
|
765
|
|
|
* For the given entry object compare its eTag (if it has eTag properties) |
|
766
|
|
|
* with current eTag request headers (if present). |
|
767
|
|
|
* |
|
768
|
|
|
* @param mixed &$entryObject entity resource for which etag |
|
769
|
|
|
* needs to be checked |
|
770
|
|
|
* @param ResourceType &$resourceType Resource type of the entry |
|
771
|
|
|
* object |
|
772
|
|
|
* @param bool &$needToSerializeResponse On return, this will contain |
|
773
|
|
|
* True if response needs to be |
|
774
|
|
|
* serialized, False otherwise |
|
775
|
|
|
* |
|
776
|
|
|
* @throws InvalidOperationException |
|
777
|
|
|
* @throws ReflectionException |
|
778
|
|
|
* @throws ODataException |
|
779
|
|
|
* @return string|null The ETag for the entry object if it has eTag properties |
|
780
|
|
|
* NULL otherwise |
|
781
|
|
|
*/ |
|
782
|
|
|
protected function compareETag( |
|
783
|
|
|
&$entryObject, |
|
784
|
|
|
ResourceType &$resourceType, |
|
785
|
|
|
&$needToSerializeResponse |
|
786
|
|
|
): ?string { |
|
787
|
|
|
$needToSerializeResponse = true; |
|
788
|
|
|
$eTag = null; |
|
789
|
|
|
$ifMatch = $this->getHost()->getRequestIfMatch(); |
|
790
|
|
|
$ifNoneMatch = $this->getHost()->getRequestIfNoneMatch(); |
|
791
|
|
|
if (null === $entryObject) { |
|
792
|
|
|
if (null !== $ifMatch) { |
|
793
|
|
|
throw ODataException::createPreConditionFailedError( |
|
794
|
|
|
Messages::eTagNotAllowedForNonExistingResource() |
|
795
|
|
|
); |
|
796
|
|
|
} |
|
797
|
|
|
|
|
798
|
|
|
return null; |
|
799
|
|
|
} |
|
800
|
|
|
|
|
801
|
|
|
if ($this->getConfiguration()->getValidateETagHeader() && !$resourceType->hasETagProperties()) { |
|
802
|
|
|
if (null !== $ifMatch || null !== $ifNoneMatch) { |
|
803
|
|
|
// No eTag properties but request has eTag headers, bad request |
|
804
|
|
|
throw ODataException::createBadRequestError( |
|
805
|
|
|
Messages::noETagPropertiesForType() |
|
806
|
|
|
); |
|
807
|
|
|
} |
|
808
|
|
|
|
|
809
|
|
|
// We need write the response but no eTag header |
|
810
|
|
|
return null; |
|
811
|
|
|
} |
|
812
|
|
|
|
|
813
|
|
|
if (!$this->getConfiguration()->getValidateETagHeader()) { |
|
814
|
|
|
// Configuration says do not validate ETag, so we will not write ETag header in the |
|
815
|
|
|
// response even though the requested resource support it |
|
816
|
|
|
return null; |
|
817
|
|
|
} |
|
818
|
|
|
|
|
819
|
|
|
if (null === $ifMatch && null === $ifNoneMatch) { |
|
820
|
|
|
// No request eTag header, we need to write the response |
|
821
|
|
|
// and eTag header |
|
822
|
|
|
} elseif (0 === strcmp(strval($ifMatch), '*')) { |
|
823
|
|
|
// If-Match:* => we need to write the response and eTag header |
|
824
|
|
|
} elseif (0 === strcmp(strval($ifNoneMatch), '*')) { |
|
825
|
|
|
// if-None-Match:* => Do not write the response (304 not modified), |
|
826
|
|
|
// but write eTag header |
|
827
|
|
|
$needToSerializeResponse = false; |
|
828
|
|
|
} else { |
|
829
|
|
|
$eTag = $this->getETagForEntry($entryObject, $resourceType); |
|
830
|
|
|
// Note: The following code for attaching the prefix W\" |
|
831
|
|
|
// and the suffix " can be done in getETagForEntry function |
|
832
|
|
|
// but that is causing an issue in Linux env where the |
|
833
|
|
|
// firefox browser is unable to parse the ETag in this case. |
|
834
|
|
|
// Need to follow up PHP core devs for this. |
|
835
|
|
|
$eTag = ODataConstants::HTTP_WEAK_ETAG_PREFIX . $eTag . '"'; |
|
836
|
|
|
if (null !== $ifMatch) { |
|
837
|
|
|
if (0 != strcmp($eTag, $ifMatch)) { |
|
838
|
|
|
// Requested If-Match value does not match with current |
|
839
|
|
|
// eTag Value then pre-condition error |
|
840
|
|
|
// http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html |
|
841
|
|
|
throw ODataException::createPreConditionFailedError( |
|
842
|
|
|
Messages::eTagValueDoesNotMatch() |
|
843
|
|
|
); |
|
844
|
|
|
} |
|
845
|
|
|
} elseif (0 === strcmp($eTag, $ifNoneMatch)) { |
|
846
|
|
|
//304 not modified, but in write eTag header |
|
847
|
|
|
$needToSerializeResponse = false; |
|
848
|
|
|
} |
|
849
|
|
|
} |
|
850
|
|
|
|
|
851
|
|
|
if (null === $eTag) { |
|
852
|
|
|
$eTag = $this->getETagForEntry($entryObject, $resourceType); |
|
853
|
|
|
// Note: The following code for attaching the prefix W\" |
|
854
|
|
|
// and the suffix " can be done in getETagForEntry function |
|
855
|
|
|
// but that is causing an issue in Linux env where the |
|
856
|
|
|
// firefox browser is unable to parse the ETag in this case. |
|
857
|
|
|
// Need to follow up PHP core devs for this. |
|
858
|
|
|
$eTag = ODataConstants::HTTP_WEAK_ETAG_PREFIX . $eTag . '"'; |
|
859
|
|
|
} |
|
860
|
|
|
|
|
861
|
|
|
return $eTag; |
|
862
|
|
|
} |
|
863
|
|
|
|
|
864
|
|
|
/** |
|
865
|
|
|
* Returns the etag for the given resource. |
|
866
|
|
|
* Note: This function will not add W\" prefix and " suffix, that is caller's |
|
867
|
|
|
* responsibility. |
|
868
|
|
|
* |
|
869
|
|
|
* @param mixed &$entryObject Resource for which etag value needs to |
|
870
|
|
|
* be returned |
|
871
|
|
|
* @param ResourceType &$resourceType Resource type of the $entryObject |
|
872
|
|
|
* |
|
873
|
|
|
* @throws InvalidOperationException |
|
874
|
|
|
* @throws ReflectionException |
|
875
|
|
|
* @throws ODataException |
|
876
|
|
|
* @return string|null ETag value for the given resource (with values encoded |
|
877
|
|
|
* for use in a URI) there are etag properties, NULL if |
|
878
|
|
|
* there is no etag property |
|
879
|
|
|
*/ |
|
880
|
|
|
protected function getETagForEntry(&$entryObject, ResourceType &$resourceType): ?string |
|
881
|
|
|
{ |
|
882
|
|
|
$eTag = null; |
|
883
|
|
|
$comma = null; |
|
884
|
|
|
foreach ($resourceType->getETagProperties() as $eTagProperty) { |
|
885
|
|
|
$type = $eTagProperty->getInstanceType(); |
|
886
|
|
|
if (!$type instanceof IType) { |
|
887
|
|
|
throw new InvalidOperationException('!$type instanceof IType'); |
|
888
|
|
|
} |
|
889
|
|
|
|
|
890
|
|
|
$value = null; |
|
|
|
|
|
|
891
|
|
|
$property = $eTagProperty->getName(); |
|
892
|
|
|
try { |
|
893
|
|
|
//TODO #88...also this seems like dupe work |
|
894
|
|
|
$value = ReflectionHandler::getProperty($entryObject, $property); |
|
895
|
|
|
} catch (ReflectionException $reflectionException) { |
|
896
|
|
|
throw ODataException::createInternalServerError( |
|
897
|
|
|
Messages::failedToAccessProperty($property, $resourceType->getName()) |
|
898
|
|
|
); |
|
899
|
|
|
} |
|
900
|
|
|
|
|
901
|
|
|
$eTagBase = $eTag . $comma; |
|
902
|
|
|
$eTag = $eTagBase . ((null == $value) ? 'null' : $type->convertToOData($value)); |
|
903
|
|
|
|
|
904
|
|
|
$comma = ','; |
|
905
|
|
|
} |
|
906
|
|
|
|
|
907
|
|
|
if (null !== $eTag) { |
|
908
|
|
|
// If eTag is made up of datetime or string properties then the above |
|
909
|
|
|
// IType::convertToOData will perform utf8 and url encode. But we don't |
|
910
|
|
|
// want this for eTag value. |
|
911
|
|
|
$eTag = urldecode(utf8_decode($eTag)); |
|
912
|
|
|
|
|
913
|
|
|
return rtrim($eTag, ','); |
|
914
|
|
|
} |
|
915
|
|
|
return null; |
|
916
|
|
|
} |
|
917
|
|
|
|
|
918
|
|
|
/** |
|
919
|
|
|
* @return IStreamProvider2 |
|
920
|
|
|
*/ |
|
921
|
|
|
abstract public function getStreamProviderX(); |
|
922
|
|
|
} |
|
923
|
|
|
|