/**
* Write in specific format
*
* @param DataService &$dataService Dataservice
* @param RequestDescription &$requestDescription Request description object
* @param Object &$odataModelInstance OData model instance
* @param String $responseContentType Content type of the response
* @param String $responseFormat Output format
*
* @return nothing
*/
public static function write(DataService &$dataService, RequestDescription &$requestDescription, &$odataModelInstance, $responseContentType, $responseFormat)
{
$responseBody = null;
$dataServiceVersion = $requestDescription->getResponseDataServiceVersion();
if ($responseFormat == ResponseFormat::METADATA_DOCUMENT) {
// /$metadata
$writer = new MetadataWriter($dataService->getMetadataQueryProviderWrapper());
$responseBody = $writer->writeMetadata();
$dataServiceVersion = $writer->getDataServiceVersion();
} else {
if ($responseFormat == ResponseFormat::TEXT) {
// /Customer('ALFKI')/CompanyName/$value
// /Customers/$count
$responseBody = utf8_encode($requestDescription->getTargetResult());
} else {
if ($responseFormat == ResponseFormat::BINARY) {
// Binary property or media resource
$targetKind = $requestDescription->getTargetKind();
if ($targetKind == RequestTargetKind::MEDIA_RESOURCE) {
$eTag = $dataService->getStreamProvider()->getStreamETag($requestDescription->getTargetResult(), $requestDescription->getResourceStreamInfo());
$dataService->getHost()->setResponseETag($eTag);
$responseBody = $dataService->getStreamProvider()->getReadStream($requestDescription->getTargetResult(), $requestDescription->getResourceStreamInfo());
} else {
$responseBody = $requestDescription->getTargetResult();
}
if (is_null($responseContentType)) {
$responseContentType = ODataConstants::MIME_APPLICATION_OCTETSTREAM;
}
} else {
$writer = null;
$absoluteServiceUri = $dataService->getHost()->getAbsoluteServiceUri()->getUrlAsString();
if ($responseFormat == ResponseFormat::ATOM || $responseFormat == ResponseFormat::PLAIN_XML) {
if (is_null($odataModelInstance)) {
$writer = new \ODataProducer\Writers\ServiceDocument\Atom\ServiceDocumentWriter($dataService->getMetadataQueryProviderWrapper(), $absoluteServiceUri);
} else {
$isPostV1 = $requestDescription->getResponseDataServiceVersion()->compare(new Version(1, 0)) == 1;
$writer = new ODataWriter($absoluteServiceUri, $isPostV1, 'atom');
}
} else {
if ($responseFormat == ResponseFormat::JSON) {
if (is_null($odataModelInstance)) {
$writer = new \ODataProducer\Writers\ServiceDocument\Json\ServiceDocumentWriter($dataService->getMetadataQueryProviderWrapper(), $absoluteServiceUri);
} else {
$isPostV1 = $requestDescription->getResponseDataServiceVersion()->compare(new Version(1, 0)) == 1;
$writer = new ODataWriter($absoluteServiceUri, $isPostV1, 'json');
}
}
}
$responseBody = $writer->writeRequest($odataModelInstance);
}
}
}
$dataService->getHost()->setResponseStatusCode(HttpStatus::CODE_OK);
$dataService->getHost()->setResponseContentType($responseContentType);
$dataService->getHost()->setResponseVersion($dataServiceVersion->toString() . ';');
$dataService->getHost()->setResponseCacheControl(ODataConstants::HTTPRESPONSE_HEADER_CACHECONTROL_NOCACHE);
$dataService->getHost()->getWebOperationContext()->outgoingResponse()->setStream($responseBody);
}
/**
* Process the given request Uri and creates an instance of
* RequestDescription from the processed uri.
*
* @param Url &$absoluteRequestUri The absolute request uri.
* @param DataService &$dataService Reference to the data service
* instance.
*
* @return RequestDescription
*
* @throws ODataException If any exception occurs while processing the segments
* or incase of any version incompatibility.
*/
public static function process(Url &$absoluteRequestUri, DataService &$dataService)
{
$absoluteRequestUri = $dataService->getHost()->getAbsoluteRequestUri();
$absoluteServiceUri = $dataService->getHost()->getAbsoluteServiceUri();
$requestUriSegments = array_slice($absoluteRequestUri->getSegments(), $absoluteServiceUri->getSegmentCount());
$segmentDescriptors = null;
try {
$segmentDescriptors = SegmentParser::parseRequestUriSegements($requestUriSegments, $dataService->getMetadataQueryProviderWrapper(), true);
} catch (ODataException $odataException) {
throw $odataException;
}
$requestDescription = new RequestDescription($segmentDescriptors, $absoluteRequestUri);
$requestTargetKind = $requestDescription->getTargetKind();
if ($requestTargetKind != RequestTargetKind::METADATA && $requestTargetKind != RequestTargetKind::BATCH && $requestTargetKind != RequestTargetKind::SERVICE_DIRECTORY) {
if ($requestTargetKind != RequestTargetKind::PRIMITIVE_VALUE && $requestTargetKind != RequestTargetKind::MEDIA_RESOURCE) {
$requestDescription->setContainerName($requestDescription->getIdentifier());
} else {
// http://odata/NW.svc/Orders/$count
// http://odata/NW.svc/Orders(123)/Customer/CustomerID/$value
// http://odata/NW.svc/Employees(1)/$value
// http://odata/NW.svc/Employees(1)/ThumbNail_48X48/$value
$requestDescription->setContainerName($segmentDescriptors[count($segmentDescriptors) - 2]->getIdentifier());
}
if ($requestDescription->getIdentifier() === ODataConstants::URI_COUNT_SEGMENT) {
if (!$dataService->getServiceConfiguration()->getAcceptCountRequests()) {
ODataException::createBadRequestError(Messages::dataServiceConfigurationCountNotAccepted());
}
$requestDescription->setRequestCountOption(RequestCountOption::VALUE_ONLY);
// use of $count requires request DataServiceVersion
// and MaxDataServiceVersion
// greater than or equal to 2.0
$requestDescription->raiseResponseVersion(2, 0, $dataService);
$requestDescription->raiseMinimumVersionRequirement(2, 0, $dataService);
} else {
if ($requestDescription->isNamedStream()) {
$requestDescription->raiseMinimumVersionRequirement(3, 0, $dataService);
} else {
if ($requestDescription->getTargetKind() == RequestTargetKind::RESOURCE) {
if (!$requestDescription->isLinkUri()) {
$resourceSetWrapper = $requestDescription->getTargetResourceSetWrapper();
//assert($resourceSetWrapper != null)
$hasNamedStream = $resourceSetWrapper->hasNamedStreams($dataService->getMetadataQueryProviderWrapper());
$hasBagProperty = $resourceSetWrapper->hasBagProperty($dataService->getMetadataQueryProviderWrapper());
if ($hasNamedStream || $hasBagProperty) {
$requestDescription->raiseResponseVersion(3, 0, $dataService);
}
}
} else {
if ($requestDescription->getTargetKind() == RequestTargetKind::BAG) {
$requestDescription->raiseResponseVersion(3, 0, $dataService);
}
}
}
}
}
return $requestDescription;
}
/**
* Is server side paging is configured, this function return true
* if the resource targetted by the resource path is applicable
* for paging and paging is enabled for the targetted resource set
* else false.
*
* @return boolean
*/
private function _isSSPagingRequired()
{
if ($this->_pagingApplicable) {
$targetResourceSetWrapper = $this->_requestDescription->getTargetResourceSetWrapper();
//assert($targetResourceSetWrapper != NULL)
return $targetResourceSetWrapper->getResourceSetPageSize() != 0;
}
return false;
}
/**
* Pushes information about the segment whose instance is going to be
* retrieved from the IDSQP implementation
* Note: Calls to this method should be balanced with calls to popSegment.
*
* @param string $segmentName Name of segment to push.
* @param ResourceSetWrapper &$resourceSetWrapper The resource set wrapper
* to push.
*
* @return true if the segment was push, false otherwise
*/
private function _pushSegment($segmentName, ResourceSetWrapper &$resourceSetWrapper)
{
$rootProjectionNode = $this->_requestDescription->getRootProjectionNode();
if (!is_null($rootProjectionNode) && $rootProjectionNode->isExpansionSpecified()) {
array_push($this->_segmentNames, $segmentName);
array_push($this->_segmentResourceSetWrappers, $resourceSetWrapper);
return true;
}
return false;
}
/**
* Wheter next link is needed for the current resource set (feed)
* being serialized.
*
* @param int $resultSetCount Number of entries in the current
* resource set.
*
* @return boolean true if the feed must have a next page link
*/
protected function needNextPageLink($resultSetCount)
{
$currentResourceSet = $this->getCurrentResourceSetWrapper();
$recursionLevel = count($this->_segmentNames);
//$this->assert($recursionLevel != 0, '$recursionLevel != 0');
$pageSize = $currentResourceSet->getResourceSetPageSize();
if ($recursionLevel == 1) {
//presence of $top option affect next link for root container
$topValueCount = $this->requestDescription->getTopOptionCount();
if (!is_null($topValueCount) && $topValueCount <= $pageSize) {
return false;
}
}
return $resultSetCount == $pageSize;
}
/**
* Gets the response format for the requested resource.
*
* @param RequestDescription &$requestDescription The request submitted by
* client and it's execution
* result.
* @param UriProcessor &$uriProcessor The reference to the
* UriProcessor.
* @param DataService &$dataService Reference to the data
* service instance
* @param string &$responseContentType On Return, this will hold
* the response content-type, a null value means the requested resource
* is named stream and IDSSP2::getStreamContentType returned null.
*
* @return ResponseFormat The format in which response needs to be serialized.
*
* @throws ODataException, HttpHeaderFailure
*/
public static function getResponseFormat(RequestDescription &$requestDescription, UriProcessor &$uriProcessor, DataService &$dataService, &$responseContentType)
{
// The Accept request-header field specifies media types which are
// acceptable for the response
$requestAcceptText = $dataService->getHost()->getRequestAccept();
$responseFormat = ResponseFormat::UNSUPPORTED;
$requestTargetKind = $requestDescription->getTargetKind();
if ($requestDescription->isLinkUri()) {
$requestTargetKind = RequestTargetKind::LINK;
}
if ($requestTargetKind == RequestTargetKind::METADATA) {
$responseContentType = HttpProcessUtility::selectMimeType($requestAcceptText, array(ODataConstants::MIME_APPLICATION_XML));
if (!is_null($responseContentType)) {
$responseFormat = ResponseFormat::METADATA_DOCUMENT;
}
} else {
if ($requestTargetKind == RequestTargetKind::SERVICE_DIRECTORY) {
$responseContentType = HttpProcessUtility::selectMimeType($requestAcceptText, array(ODataConstants::MIME_APPLICATION_XML, ODataConstants::MIME_APPLICATION_ATOMSERVICE, ODataConstants::MIME_APPLICATION_JSON));
if (!is_null($responseContentType)) {
$responseFormat = self::_getContentFormat($responseContentType);
}
} else {
if ($requestTargetKind == RequestTargetKind::PRIMITIVE_VALUE) {
$supportedResponseMimeTypes = array(ODataConstants::MIME_TEXTPLAIN);
$responseFormat = ResponseFormat::TEXT;
if ($requestDescription->getIdentifier() != '$count') {
$projectedProperty = $requestDescription->getProjectedProperty();
self::assert(!is_null($projectedProperty), '!is_null($projectedProperty)');
$type = $projectedProperty->getInstanceType();
self::assert(!is_null($type) && array_search('ODataProducer\\Providers\\Metadata\\Type\\IType', class_implements($type)) !== false, '!is_null($type) && array_search(\'ODataProducer\\Providers\\Metadata\\Type\\IType\', class_implements($type)) !== false');
if ($type instanceof Binary) {
$supportedResponseMimeTypes = array(ODataConstants::MIME_APPLICATION_OCTETSTREAM);
$responseFormat = ResponseFormat::BINARY;
}
}
$responseContentType = HttpProcessUtility::selectMimeType($requestAcceptText, $supportedResponseMimeTypes);
if (is_null($responseContentType)) {
$responseFormat = ResponseFormat::UNSUPPORTED;
}
} else {
if ($requestTargetKind == RequestTargetKind::PRIMITIVE || $requestTargetKind == RequestTargetKind::COMPLEX_OBJECT || $requestTargetKind == RequestTargetKind::BAG || $requestTargetKind == RequestTargetKind::LINK) {
$responseContentType = HttpProcessUtility::selectMimeType($requestAcceptText, array(ODataConstants::MIME_APPLICATION_XML, ODataConstants::MIME_TEXTXML, ODataConstants::MIME_APPLICATION_JSON));
if (!is_null($responseContentType)) {
$responseFormat = self::_getContentFormat($responseContentType);
}
} else {
if ($requestTargetKind == RequestTargetKind::RESOURCE) {
$responseContentType = HttpProcessUtility::selectMimeType($requestAcceptText, array(ODataConstants::MIME_APPLICATION_ATOM, ODataConstants::MIME_APPLICATION_JSON));
if (!is_null($responseContentType)) {
$responseFormat = self::_getContentFormat($responseContentType);
}
} else {
if ($requestTargetKind == RequestTargetKind::MEDIA_RESOURCE) {
$responseFormat = ResponseFormat::BINARY;
if ($requestDescription->isNamedStream() || $requestDescription->getTargetResourceType()->isMediaLinkEntry()) {
$streamInfo = $requestDescription->getResourceStreamInfo();
//Execute the query as we need media resource instance for
//further processing
$uriProcessor->execute();
$requestDescription->setExecuted();
// DSSW::getStreamContentType can throw error in 2 cases
// 1. If the required stream implementation not found
// 2. If IDSSP::getStreamContentType returns NULL for MLE
$contentType = $dataService->getStreamProvider()->getStreamContentType($requestDescription->getTargetResult(), $streamInfo);
if (!is_null($contentType)) {
$responseContentType = HttpProcessUtility::selectMimeType($requestAcceptText, array($contentType));
if (is_null($responseContentType)) {
$responseFormat = ResponseFormat::UNSUPPORTED;
}
} else {
// For NamedStream StreamWrapper::getStreamContentType
// can return NULL if the requested named stream has not
// yet been uploaded. But for an MLE if
// IDSSP::getStreamContentType
// returns NULL then StreamWrapper will throw error
$responseContentType = null;
}
} else {
ODataException::createBadRequestError(Messages::badRequestInvalidUriForMediaResource($dataService->getHost()->getAbsoluteRequestUri()->getUrlAsString()));
}
}
}
}
}
}
}
if ($responseFormat == ResponseFormat::UNSUPPORTED) {
throw new ODataException(Messages::dataServiceExceptionUnsupportedMediaType(), 415);
}
return $responseFormat;
}