/** * Common function to handle exceptions in the data service. * * @param Exception $exception exception occured * @param DataService &$dataService dataservice * * @return nothing */ public static function handleException($exception, DataService &$dataService) { $acceptTypesText = $dataService->getHost()->getRequestAccept(); $responseContentType = null; try { $responseContentType = HttpProcessUtility::selectMimeType($acceptTypesText, array(ODataConstants::MIME_APPLICATION_XML, ODataConstants::MIME_APPLICATION_JSON)); } catch (HttpHeaderFailure $exception) { $exception = new ODataException($exception->getMessage(), $exception->getStatusCode()); } catch (\Exception $exception) { // Never come here } if (is_null($responseContentType)) { $responseContentType = ODataConstants::MIME_APPLICATION_XML; } if (!$exception instanceof ODataException) { $exception = new ODataException($exception->getMessage(), HttpStatus::CODE_INTERNAL_SERVER_ERROR); } $dataService->getHost()->setResponseVersion(ODataConstants::DATASERVICEVERSION_1_DOT_0 . ';'); // At this point all kind of exceptions will be converted //to 'ODataException' if ($exception->getStatusCode() == HttpStatus::CODE_NOT_MODIFIED) { $dataService->getHost()->setResponseStatusCode(HttpStatus::CODE_NOT_MODIFIED); } else { $dataService->getHost()->setResponseStatusCode($exception->getStatusCode()); $dataService->getHost()->setResponseContentType($responseContentType); $responseBody = null; if (strcasecmp($responseContentType, ODataConstants::MIME_APPLICATION_XML) == 0) { $responseBody = AtomODataWriter::serializeException($exception, true); } else { $responseBody = JsonODataWriter::serializeException($exception, true); } $dataService->getHost()->getWebOperationContext()->outgoingResponse()->setStream($responseBody); } }
/** * Gets the quality factor associated with this media type. * * @return int The value associated with 'q' parameter (0-1000), * if absent return 1000. */ public function getQualityValue() { foreach ($this->_parameters as $parameter) { foreach ($parameter as $key => $value) { if (strcasecmp($key, 'q') === 0) { $textIndex = 0; $result; HttpProcessUtility::readQualityValue($value, $textIndex, $result); return $result; } } } return 1000; }
/** * 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; }