/**
* Process the $expand and $select option and update the request description.
*
* @return void
*
* @throws ODataException Throws bad request error in the following cases
* (1) If $expand or select cannot be applied to the
* requested resource.
* (2) If projection is disabled by the developer
* (3) If some error occurs while parsing the options
*/
private function _processExpandAndSelect()
{
$expand = $this->_dataService->getHost()->getQueryStringItem(ODataConstants::HTTPQUERY_STRING_EXPAND);
if (!is_null($expand)) {
$this->_checkExpandOrSelectApplicable(ODataConstants::HTTPQUERY_STRING_EXPAND);
}
$select = $this->_dataService->getHost()->getQueryStringItem(ODataConstants::HTTPQUERY_STRING_SELECT);
if (!is_null($select)) {
if (!$this->_dataService->getServiceConfiguration()->getAcceptProjectionRequests()) {
ODataException::createBadRequestError(Messages::dataServiceConfigurationProjectionsNotAccepted());
}
$this->_checkExpandOrSelectApplicable(ODataConstants::HTTPQUERY_STRING_SELECT);
}
// We will generate RootProjectionNode in case of $link request also, but
// expand and select in this case must be null (we are ensuring this above)
// 'RootProjectionNode' is required while generating next page Link
if ($this->_expandSelectApplicable || $this->_requestDescription->isLinkUri()) {
try {
$rootProjectionNode = ExpandProjectionParser::parseExpandAndSelectClause($this->_requestDescription->getTargetResourceSetWrapper(), $this->_requestDescription->getTargetResourceType(), $this->_requestDescription->getInternalOrderByInfo(), $this->_requestDescription->getSkipCount(), $this->_requestDescription->getTopCount(), $expand, $select, $this->_dataService->getMetadataQueryProviderWrapper());
if ($rootProjectionNode->isSelectionSpecified()) {
$this->_requestDescription->raiseMinimumVersionRequirement(2, 0, $this->_dataService);
}
if ($rootProjectionNode->hasPagedExpandedResult()) {
$this->_requestDescription->raiseResponseVersion(2, 0, $this->_dataService);
}
$this->_requestDescription->setRootProjectionNode($rootProjectionNode);
} catch (ODataException $odataException) {
throw $odataException;
}
}
}
/**
* 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;
}
/**
* 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;
}
