// limitations under the License.
//
//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+#include <string.h>
#include "ocstack.h"
#include "ocserverrequest.h"
#include "ocresourcehandler.h"
+#include "ocobserve.h"
+#include "oic_malloc.h"
+#include "oic_string.h"
+#include "ocpayload.h"
+#include "ocpayloadcbor.h"
+#include "logger.h"
+
+#if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
+#include "routingutility.h"
+#endif
+#include "cacommon.h"
+#include "cainterface.h"
-#ifdef CA_INT
- #include "cacommon.h"
- #include "cainterface.h"
-#endif
+#include <coap/utlist.h>
+#include <coap/pdu.h>
// Module Name
-#define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
+#define VERIFY_NON_NULL(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
-#define TAG PCF("ocserverrequest")
+#define TAG "OIC_RI_SERVERREQUEST"
static struct OCServerRequest * serverRequestList = NULL;
static struct OCServerResponse * serverResponseList = NULL;
-OCServerRequest * GetServerRequestUsingToken (const OCCoAPToken token)
+//-------------------------------------------------------------------------------------------------
+// Local functions
+//-------------------------------------------------------------------------------------------------
+
+/**
+ * Add a server response to the server response list
+ *
+ * @param response initialized server response that is created by this function
+ * @param requestHandle - handle of the response
+ *
+ * @return
+ * OCStackResult
+ */
+static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
+{
+ if (!response)
+ {
+ return OC_STACK_INVALID_PARAM;
+ }
+
+ OCServerResponse * serverResponse = NULL;
+
+ serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
+ VERIFY_NON_NULL(serverResponse);
+
+ serverResponse->payload = NULL;
+
+ serverResponse->requestHandle = requestHandle;
+
+ *response = serverResponse;
+ OIC_LOG(INFO, TAG, "Server Response Added!!");
+ LL_APPEND (serverResponseList, serverResponse);
+ return OC_STACK_OK;
+
+exit:
+ if (serverResponse)
+ {
+ OICFree(serverResponse);
+ serverResponse = NULL;
+ }
+ *response = NULL;
+ return OC_STACK_NO_MEMORY;
+}
+
+/**
+ * Delete a server request from the server request list
+ *
+ * @param serverRequest - server request to delete
+ */
+static void DeleteServerRequest(OCServerRequest * serverRequest)
+{
+ if(serverRequest)
+ {
+ LL_DELETE(serverRequestList, serverRequest);
+ OICFree(serverRequest->requestToken);
+ OICFree(serverRequest->rcvdVendorSpecificHeaderOptions);
+ OICFree(serverRequest);
+ serverRequest = NULL;
+ OIC_LOG(INFO, TAG, "Server Request Removed!!");
+ }
+}
+
+/**
+ * Delete a server response from the server response list
+ *
+ * @param serverResponse - server response to delete
+ */
+static void DeleteServerResponse(OCServerResponse * serverResponse)
+{
+ if(serverResponse)
+ {
+ LL_DELETE(serverResponseList, serverResponse);
+ OCPayloadDestroy(serverResponse->payload);
+ OICFree(serverResponse);
+ OIC_LOG(INFO, TAG, "Server Response Removed!!");
+ }
+}
+
+/**
+ * Find a server response and delete it from the server response list
+ *
+ * @param serverResponse - server response to find and delete
+ */
+static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
+{
+ OCServerResponse* tmp;
+ if(serverResponse)
+ {
+ LL_FOREACH(serverResponseList, tmp)
+ {
+ if (serverResponse == tmp)
+ {
+ DeleteServerResponse(tmp);
+ return;
+ }
+ }
+ }
+}
+
+/**
+ * Ensure no accept header option is included when sending responses and add routing info to
+ * outgoing response.
+ *
+ * @param object CA remote endpoint.
+ * @param requestInfo CA request info.
+ *
+ * @return ::OC_STACK_OK on success, some other value upon failure.
+ */
+static OCStackResult OCSendResponse(const CAEndpoint_t *object, CAResponseInfo_t *responseInfo)
{
+#if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
+ // Add route info in RM option.
+ OCStackResult rmResult = RMAddInfo(object->routeData, responseInfo, false, NULL);
+ if(OC_STACK_OK != rmResult)
+ {
+ OIC_LOG(ERROR, TAG, "Add option failed");
+ return rmResult;
+ }
+#endif
+
+ // Do not include the accept header option
+ responseInfo->info.acceptFormat = CA_FORMAT_UNDEFINED;
+ CAResult_t result = CASendResponse(object, responseInfo);
+ if(CA_STATUS_OK != result)
+ {
+ OIC_LOG_V(ERROR, TAG, "CASendResponse failed with CA error %u", result);
+ return CAResultToOCResult(result);
+ }
+ return OC_STACK_OK;
+}
+
+//-------------------------------------------------------------------------------------------------
+// Internal APIs
+//-------------------------------------------------------------------------------------------------
+
+/**
+ * Get a server request from the server request list using the specified token.
+ *
+ * @param token - token of server request
+ * @param tokenLength - length of token
+ *
+ * @return
+ * OCServerRequest*
+ */
+OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
+{
+ if(!token)
+ {
+ OIC_LOG(ERROR, TAG, "Invalid Parameter Token");
+ return NULL;
+ }
+
OCServerRequest * out = NULL;
+ OIC_LOG(INFO, TAG,"Get server request with token");
+ OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
+
+ OIC_LOG(INFO, TAG, "Found token");
LL_FOREACH (serverRequestList, out)
{
- OC_LOG(INFO, TAG,PCF("comparing tokens"));
- OC_LOG_BUFFER(INFO, TAG, token.token, token.tokenLength);
- OC_LOG_BUFFER(INFO, TAG, out->requestToken.token, out->requestToken.tokenLength);
- if((out->requestToken.tokenLength == token.tokenLength) &&
- (memcmp(out->requestToken.token, token.token, token.tokenLength) == 0))
+ if(out)
{
- return out;
+ OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, out->tokenLength);
+ if((tokenLength == out->tokenLength) &&
+ memcmp(out->requestToken, token, tokenLength) == 0)
+ {
+ return out;
+ }
}
}
- OC_LOG(INFO, TAG, PCF("Server Request not found!!"));
+ OIC_LOG(INFO, TAG, "Server Request not found!!");
return NULL;
}
-OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
+/**
+ * Get a server request from the server request list using the specified handle
+ *
+ * @param handle - handle of server request
+ * @return
+ * OCServerRequest*
+ */
+OCServerRequest * GetServerRequestUsingHandle (const OCRequestHandle handle)
{
OCServerRequest * out = NULL;
LL_FOREACH (serverRequestList, out)
{
- if(out == handle)
+ if(out->requestId == handle)
{
return out;
}
}
- OC_LOG(INFO, TAG, PCF("Server Request not found!!"));
+ OIC_LOG(ERROR, TAG, "Server Request not found!!");
return NULL;
}
-OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
+/**
+ * Get a server response from the server response list using the specified handle
+ *
+ * @param handle - handle of server response
+ *
+ * @return
+ * OCServerResponse*
+ */
+OCServerResponse * GetServerResponseUsingHandle (const OCRequestHandle handle)
{
OCServerResponse * out = NULL;
LL_FOREACH (serverResponseList, out)
return out;
}
}
- OC_LOG(INFO, TAG, PCF("Server Response not found!!"));
+ OIC_LOG(INFO, TAG, "Server Response not found!!");
return NULL;
}
OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
- uint8_t delayedResNeeded, uint8_t secured, uint8_t notificationFlag, OCMethod method,
+ uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
- OCQualityOfService qos, unsigned char * query,
+ OCQualityOfService qos, char * query,
OCHeaderOption * rcvdVendorSpecificHeaderOptions,
- unsigned char * reqJSONPayload, OCCoAPToken * requestToken,
- OCDevAddr * requesterAddr, unsigned char * resourceUrl, size_t reqTotalSize)
+ uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
+ char * resourceUrl, size_t reqTotalSize, OCPayloadFormat acceptFormat,
+ const OCDevAddr *devAddr)
{
- OCServerRequest * serverRequest = NULL;
-
- //Note: OCServerRequest includes 1 byte for the JSON Payload. payloadSize is calculated
- //as the required length of the string, so this will result in enough room for the
- //null terminator as well.
- serverRequest = (OCServerRequest *) OCCalloc(1, sizeof(OCServerRequest) + reqTotalSize - 1);
- VERIFY_NON_NULL(serverRequest);
-
- serverRequest->coapID = coapID;
- serverRequest->delayedResNeeded = delayedResNeeded;
- serverRequest->secured = secured;
- serverRequest->notificationFlag = notificationFlag;
-
- serverRequest->method = method;
- serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
- serverRequest->observationOption = observationOption;
- serverRequest->observeResult = OC_STACK_ERROR;
- serverRequest->qos = qos;
- serverRequest->ehResponseHandler = HandleSingleResponse;
- serverRequest->numResponses = 1;
- if(query)
- {
- memcpy(serverRequest->query, query, strlen((const char *)query) + 1);
- }
- if(rcvdVendorSpecificHeaderOptions)
- {
- memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
- MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
- }
- if(reqJSONPayload)
+ if (!request)
{
- // destination is at least 1 greater than the source, so a NULL always exists in the
- // last character
- strncpy((char*)serverRequest->reqJSONPayload,
- (const char*)reqJSONPayload, reqTotalSize - 1);
- }
- serverRequest->requestComplete = 0;
- if(requestToken)
- {
- memcpy(&serverRequest->requestToken, requestToken, sizeof(OCCoAPToken));
- }
- if(requesterAddr)
- {
- memcpy(&serverRequest->requesterAddr, requesterAddr, sizeof(OCDevAddr));
- }
- if(resourceUrl)
- {
- memcpy(serverRequest->resourceUrl, resourceUrl, strlen((const char *)resourceUrl) + 1);
+ return OC_STACK_INVALID_PARAM;
}
- *request = serverRequest;
- OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
- LL_APPEND (serverRequestList, serverRequest);
- return OC_STACK_OK;
-
-exit:
- if (serverRequest)
- {
- OCFree(serverRequest);
- serverRequest = NULL;
- }
- *request = NULL;
- return OC_STACK_NO_MEMORY;
-}
-
-#ifdef CA_INT
-OCStackResult AddServerCARequest (OCServerRequest ** request, uint16_t coapID,
- uint8_t delayedResNeeded, uint8_t secured, uint8_t notificationFlag, OCMethod method,
- uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
- OCQualityOfService qos, unsigned char * query,
- OCHeaderOption * rcvdVendorSpecificHeaderOptions,
- unsigned char * reqJSONPayload, OCCoAPToken * requestToken,
- OCDevAddr * requesterAddr, unsigned char * resourceUrl, size_t reqTotalSize,
- CAAddress_t *addressInfo, CAConnectivityType_t connectivityType, char *token)
-{
OCServerRequest * serverRequest = NULL;
- //Note: OCServerRequest includes 1 byte for the JSON Payload. payloadSize is calculated
- //as the required length of the string, so this will result in enough room for the
- //null terminator as well.
- serverRequest = (OCServerRequest *) OCCalloc(1, sizeof(OCServerRequest) + reqTotalSize - 1);
+ OIC_LOG_V(INFO, TAG, "addserverrequest entry!! [%s:%u]", devAddr->addr, devAddr->port);
+
+ serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
+ (reqTotalSize ? reqTotalSize : 1) - 1);
+ VERIFY_NON_NULL(devAddr);
VERIFY_NON_NULL(serverRequest);
serverRequest->coapID = coapID;
serverRequest->delayedResNeeded = delayedResNeeded;
- serverRequest->secured = secured;
serverRequest->notificationFlag = notificationFlag;
serverRequest->method = method;
serverRequest->observationOption = observationOption;
serverRequest->observeResult = OC_STACK_ERROR;
serverRequest->qos = qos;
+ serverRequest->acceptFormat = acceptFormat;
serverRequest->ehResponseHandler = HandleSingleResponse;
serverRequest->numResponses = 1;
+ serverRequest->requestId = OCGetRandom();
+
if(query)
{
- memcpy(serverRequest->query, query, strlen((const char *)query) + 1);
+ OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
}
+
if(rcvdVendorSpecificHeaderOptions)
{
+ serverRequest->rcvdVendorSpecificHeaderOptions =
+ (OCHeaderOption *) OICCalloc(numRcvdVendorSpecificHeaderOptions, sizeof(OCHeaderOption));
+ VERIFY_NON_NULL(serverRequest->rcvdVendorSpecificHeaderOptions);
+
memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
- MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
+ numRcvdVendorSpecificHeaderOptions * sizeof(OCHeaderOption));
}
- if(reqJSONPayload)
+ if(payload && reqTotalSize)
{
// destination is at least 1 greater than the source, so a NULL always exists in the
// last character
- strncpy((char*)serverRequest->reqJSONPayload,
- (const char*)reqJSONPayload, reqTotalSize - 1);
+ memcpy(serverRequest->payload, payload, reqTotalSize);
+ serverRequest->payloadSize = reqTotalSize;
}
+
serverRequest->requestComplete = 0;
if(requestToken)
{
- memcpy(&serverRequest->requestToken, requestToken, sizeof(OCCoAPToken));
- }
- if(requesterAddr)
- {
- memcpy(&serverRequest->requesterAddr, requesterAddr, sizeof(OCDevAddr));
+ // If tokenLength is zero, the return value depends on the
+ // particular library implementation (it may or may not be a null pointer).
+ if (tokenLength)
+ {
+ serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
+ VERIFY_NON_NULL(serverRequest->requestToken);
+ memcpy(serverRequest->requestToken, requestToken, tokenLength);
+ }
}
+ serverRequest->tokenLength = tokenLength;
+
if(resourceUrl)
{
- memcpy(serverRequest->resourceUrl, resourceUrl, strlen((const char *)resourceUrl) + 1);
+ OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
+ resourceUrl);
}
- if (addressInfo)
- {
- serverRequest->addressInfo = *addressInfo;
- }
- serverRequest->connectivityType = connectivityType;
- if (token)
- {
- strncpy(serverRequest->token, token, CA_MAX_TOKEN_LEN);
- }
+ serverRequest->devAddr = *devAddr;
*request = serverRequest;
- OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
+ OIC_LOG(INFO, TAG, "Server Request Added!!");
LL_APPEND (serverRequestList, serverRequest);
return OC_STACK_OK;
exit:
if (serverRequest)
{
- OCFree(serverRequest);
+ OICFree(serverRequest->requestToken);
+ OICFree(serverRequest->rcvdVendorSpecificHeaderOptions);
+ OICFree(serverRequest);
serverRequest = NULL;
}
*request = NULL;
return OC_STACK_NO_MEMORY;
}
-#endif
-
-OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
-{
- OCServerResponse * serverResponse = NULL;
-
- serverResponse = (OCServerResponse *) OCCalloc(1, sizeof(OCServerResponse));
- VERIFY_NON_NULL(serverResponse);
-
- serverResponse->payload = (unsigned char *) OCMalloc(MAX_RESPONSE_LENGTH);
- VERIFY_NON_NULL(serverResponse->payload);
- memset(serverResponse->payload, 0, sizeof(MAX_RESPONSE_LENGTH));
-
- serverResponse->remainingPayloadSize = MAX_RESPONSE_LENGTH;
- serverResponse->requestHandle = requestHandle;
-
- *response = serverResponse;
- OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
- LL_APPEND (serverResponseList, serverResponse);
- return OC_STACK_OK;
-
-exit:
- if (serverResponse)
- {
- OCFree(serverResponse);
- serverResponse = NULL;
- }
- *response = NULL;
- return OC_STACK_NO_MEMORY;
-}
-// Form the OCEntityHandlerRequest struct
-OCStackResult FormOCEntityHandlerRequest(OCEntityHandlerRequest * entityHandlerRequest, OCRequestHandle request,
- OCMethod method, OCResourceHandle resource, unsigned char * queryBuf, unsigned char * bufReqPayload,
- uint8_t numVendorOptions, OCHeaderOption * vendorOptions, OCObserveAction observeAction,
- OCObservationId observeID)
+OCStackResult FormOCEntityHandlerRequest(
+ OCEntityHandlerRequest * entityHandlerRequest,
+ OCRequestHandle request,
+ OCMethod method,
+ OCDevAddr *endpoint,
+ OCResourceHandle resource,
+ char * queryBuf,
+ OCPayloadType payloadType,
+ uint8_t * payload,
+ size_t payloadSize,
+ uint8_t numVendorOptions,
+ OCHeaderOption * vendorOptions,
+ OCObserveAction observeAction,
+ OCObservationId observeID,
+ uint16_t messageID)
{
if (entityHandlerRequest)
{
- memset(entityHandlerRequest, 0, sizeof(OCEntityHandlerRequest));
+ entityHandlerRequest->resource = (OCResourceHandle) resource;
entityHandlerRequest->requestHandle = request;
entityHandlerRequest->method = method;
- entityHandlerRequest->resource = (OCResourceHandle) resource;
+ entityHandlerRequest->devAddr = *endpoint;
entityHandlerRequest->query = queryBuf;
- entityHandlerRequest->reqJSONPayload = bufReqPayload;
- entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
- entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
-
entityHandlerRequest->obsInfo.action = observeAction;
entityHandlerRequest->obsInfo.obsId = observeID;
- return OC_STACK_OK;
- }
+ entityHandlerRequest->messageID = messageID;
- return OC_STACK_INVALID_PARAM;
-}
-
-void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
-{
- OCServerResponse* tmp;
- if(serverResponse)
- {
- LL_FOREACH(serverResponseList, tmp)
+ if(payload && payloadSize)
{
- if (serverResponse == tmp)
+ if(OCParsePayload(&entityHandlerRequest->payload, payloadType,
+ payload, payloadSize) != OC_STACK_OK)
{
- DeleteServerResponse(tmp);
- return;
+ return OC_STACK_ERROR;
}
}
- }
-}
+ else
+ {
+ entityHandlerRequest->payload = NULL;
+ }
-void DeleteServerResponse(OCServerResponse * serverResponse)
-{
- if(serverResponse) {
- LL_DELETE(serverResponseList, serverResponse);
- OCFree(serverResponse->payload);
- OCFree(serverResponse);
- OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
+ entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
+ entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
+
+ return OC_STACK_OK;
}
+
+ return OC_STACK_INVALID_PARAM;
}
+/**
+ * Find a server request in the server request list and delete
+ *
+ * @param serverRequest - server request to find and delete
+ */
void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
{
OCServerRequest* tmp;
}
}
-void DeleteServerRequest(OCServerRequest * serverRequest)
-{
- if(serverRequest) {
- LL_DELETE(serverRequestList, serverRequest);
- OCFree(serverRequest);
- serverRequest = NULL;
- OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
- }
-}
-
-OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
+CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result, OCMethod method)
{
-#ifdef CA_INT
- OCStackResult result = OC_STACK_ERROR;
- CARemoteEndpoint_t responseEndpoint;
- CAResponseInfo_t responseInfo;
- CAHeaderOption_t* optionsPointer;
-
- OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
-
- OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
+ CAResponseResult_t caResult = CA_BAD_REQ;
- // Copy the address
- responseEndpoint.resourceUri = (CAURI_t)serverRequest->resourceUrl;
- responseEndpoint.addressInfo = serverRequest->addressInfo;
- responseEndpoint.connectivityType = serverRequest->connectivityType;
- responseEndpoint.isSecured = serverRequest->secured;
-
- // Copy the info
- switch (ehResponse->ehResult)
+ switch (result)
{
+ // Successful Client Request
+ case OC_EH_RESOURCE_CREATED: // 2.01
+ if (method == OC_REST_POST || method == OC_REST_PUT)
+ {
+ caResult = CA_CREATED;
+ }
+ break;
+ case OC_EH_RESOURCE_DELETED: // 2.02
+ if (method == OC_REST_POST || method == OC_REST_DELETE)
+ {
+ caResult = CA_DELETED;
+ }
+ break;
+ case OC_EH_SLOW: // 2.05
+ caResult = CA_CONTENT;
+ break;
case OC_EH_OK:
- responseInfo.result = CA_SUCCESS;
+ case OC_EH_CHANGED: // 2.04
+ case OC_EH_CONTENT: // 2.05
+ if (method == OC_REST_POST || method == OC_REST_PUT)
+ {
+ caResult = CA_CHANGED;
+ }
+ else if (method == OC_REST_GET)
+ {
+ caResult = CA_CONTENT;
+ }
break;
- case OC_EH_ERROR:
- responseInfo.result = CA_BAD_REQ;
+ case OC_EH_VALID: // 2.03
+ caResult = CA_VALID;
break;
- case OC_EH_RESOURCE_CREATED:
- responseInfo.result = CA_CREATED;
+ // Unsuccessful Client Request
+ case OC_EH_UNAUTHORIZED_REQ: // 4.01
+ caResult = CA_UNAUTHORIZED_REQ;
break;
- case OC_EH_RESOURCE_DELETED:
- responseInfo.result = CA_DELETED;
+ case OC_EH_BAD_OPT: // 4.02
+ caResult = CA_BAD_OPT;
break;
- case OC_EH_SLOW:
- responseInfo.result = CA_SUCCESS;
+ case OC_EH_FORBIDDEN: // 4.03
+ caResult = CA_FORBIDDEN_REQ;
break;
- case OC_EH_FORBIDDEN:
- responseInfo.result = CA_BAD_REQ;
+ case OC_EH_RESOURCE_NOT_FOUND: // 4.04
+ caResult = CA_NOT_FOUND;
break;
- default:
- responseInfo.result = CA_BAD_REQ;
+ case OC_EH_METHOD_NOT_ALLOWED: // 4.05
+ caResult = CA_METHOD_NOT_ALLOWED;
break;
- }
-
- // TODO-CA: Need to do something with a slow response if a confirmed request was sent
- // from client
-
- // TODO-CA: Need to handle CA_MSG_RESET and CA_MSG_ACKNOWLEDGE
- switch (serverRequest->qos)
- {
- case OC_LOW_QOS:
- responseInfo.info.type = CA_MSG_NONCONFIRM;
+ case OC_EH_NOT_ACCEPTABLE: // 4.06
+ caResult = CA_NOT_ACCEPTABLE;
+ break;
+ case OC_EH_INTERNAL_SERVER_ERROR: // 5.00
+ caResult = CA_INTERNAL_SERVER_ERROR;
+ break;
+ case OC_EH_NOT_IMPLEMENTED: // 5.01
+ caResult = CA_NOT_IMPLEMENTED;
+ break;
+ case OC_EH_BAD_GATEWAY: // 5.02
+ caResult = CA_BAD_GATEWAY;
break;
- case OC_MEDIUM_QOS:
- responseInfo.info.type = CA_MSG_NONCONFIRM;
+ case OC_EH_SERVICE_UNAVAILABLE: // 5.03
+ caResult = CA_SERVICE_UNAVAILABLE;
break;
- case OC_HIGH_QOS:
- responseInfo.info.type = CA_MSG_CONFIRM;
+ case OC_EH_RETRANSMIT_TIMEOUT: // 5.04
+ caResult = CA_RETRANSMIT_TIMEOUT;
break;
- case OC_NA_QOS:
- responseInfo.info.type = CA_MSG_NONCONFIRM;
+ case OC_EH_PROXY_NOT_SUPPORTED: // 5.05
+ caResult = CA_PROXY_NOT_SUPPORTED;
break;
default:
- responseInfo.info.type = CA_MSG_NONCONFIRM;
+ caResult = CA_BAD_REQ;
break;
}
+ return caResult;
+}
+
- responseInfo.info.token = serverRequest->token;
+/**
+ * Handler function for sending a response from a single resource
+ *
+ * @param ehResponse - pointer to the response from the resource
+ *
+ * @return
+ * OCStackResult
+ */
+OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
+{
+ OCStackResult result = OC_STACK_ERROR;
+ CAEndpoint_t responseEndpoint = {.adapter = CA_DEFAULT_ADAPTER};
+ CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
+ CAHeaderOption_t* optionsPointer = NULL;
- if(serverRequest->observeResult == OC_STACK_OK)
+ if(!ehResponse || !ehResponse->requestHandle)
{
- responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
+ OIC_LOG(ERROR, TAG, "ehResponse/requestHandle is NULL");
+ return OC_STACK_ERROR;
}
- else
+
+ OCServerRequest *serverRequest = GetServerRequestUsingHandle(ehResponse->requestHandle);
+ if (NULL == serverRequest)
{
- responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
+ OIC_LOG(ERROR, TAG, "No serverRequest matching with ehResponse");
+ return OC_STACK_ERROR;
}
- responseInfo.info.options = (CAHeaderOption_t *)
- malloc(sizeof(CAHeaderOption_t) * responseInfo.info.numOptions);
+ CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
- optionsPointer = responseInfo.info.options;
+ responseInfo.info.messageId = serverRequest->coapID;
+ responseInfo.info.resourceUri = serverRequest->resourceUrl;
+ responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult, serverRequest->method);
+ responseInfo.info.dataType = CA_RESPONSE_DATA;
- if(serverRequest->observeResult == OC_STACK_OK)
+ if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
{
- responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
+ responseInfo.info.type = CA_MSG_CONFIRM;
}
-
- // TODO-CA Revisit this logic
- if(serverRequest->observeResult == OC_STACK_OK)
+ else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
{
- responseInfo.info.options[0].protocolID = CA_COAP_ID;
- responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
- responseInfo.info.options[0].optionLength = sizeof(uint32_t);
- memcpy(responseInfo.info.options[0].optionData,
- &(serverRequest->observationOption), sizeof(uint32_t));
-
- // Point to the next header option before copying vender specific header options
- optionsPointer += 1;
+ responseInfo.info.type = CA_MSG_NONCONFIRM;
}
-
- if (ehResponse->numSendVendorSpecificHeaderOptions)
+ else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
+ serverRequest->qos == OC_HIGH_QOS)
{
- memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
- sizeof(OCHeaderOption) * ehResponse->numSendVendorSpecificHeaderOptions);
+ responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
}
-
- // Allocate memory for the payload.
- char *payload = (char *)OCMalloc(MAX_RESPONSE_LENGTH);
- if(!payload)
+ else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
+ serverRequest->qos == OC_HIGH_QOS)
{
- return OC_STACK_NO_MEMORY;
+ // To assign new messageId in CA.
+ responseInfo.info.messageId = 0;
+ responseInfo.info.type = CA_MSG_CONFIRM;
}
- memset(payload, 0, MAX_RESPONSE_LENGTH);
- // Put the JSON prefix and suffix around the payload
- strcpy(payload, (const char *)OC_JSON_PREFIX);
- strcat(payload, (const char *)ehResponse->payload);
- strcat(payload, (const char *)OC_JSON_SUFFIX);
- responseInfo.info.payload = (CAPayload_t)payload;
+ else if(!serverRequest->notificationFlag)
+ {
+ responseInfo.info.type = CA_MSG_NONCONFIRM;
+ }
+ else
+ {
+ OIC_LOG(ERROR, TAG, "default responseInfo type is NON");
+ responseInfo.info.type = CA_MSG_NONCONFIRM;
+ }
+
+ char rspToken[CA_MAX_TOKEN_LEN + 1] = {0};
+ responseInfo.info.messageId = serverRequest->coapID;
+ responseInfo.info.token = (CAToken_t)rspToken;
+
+ memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
+ responseInfo.info.tokenLength = serverRequest->tokenLength;
- CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
- if(caResult != CA_STATUS_OK)
+ if((serverRequest->observeResult == OC_STACK_OK)&&
+ (serverRequest->observationOption != MAX_SEQUENCE_NUMBER + 1))
{
- OC_LOG(ERROR, TAG, PCF("CASendResponse error"));
+ responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
}
else
{
- result = OC_STACK_OK;
+ responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
}
- OCFree(payload);
- //Delete the request
- FindAndDeleteServerRequest(serverRequest);
- return result;
-#else
- OCStackResult result = OC_STACK_ERROR;
- OCServerProtocolResponse protocolResponse;
- memset(&protocolResponse, 0, sizeof(OCServerProtocolResponse));
+ if(responseInfo.info.numOptions > 0)
+ {
+ responseInfo.info.options = (CAHeaderOption_t *)
+ OICCalloc(responseInfo.info.numOptions,
+ sizeof(CAHeaderOption_t));
- OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
+ if(!responseInfo.info.options)
+ {
+ OIC_LOG(FATAL, TAG, "Memory alloc for options failed");
+ return OC_STACK_NO_MEMORY;
+ }
- OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
- // Format protocol response structure with data needed for
- // sending the response
- protocolResponse.qos = serverRequest->qos;
+ optionsPointer = responseInfo.info.options;
+
+ // TODO: This exposes CoAP specific details. At some point, this should be
+ // re-factored and handled in the CA layer.
+ if(serverRequest->observeResult == OC_STACK_OK)
+ {
+ responseInfo.info.options[0].protocolID = CA_COAP_ID;
+ responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
+ responseInfo.info.options[0].optionLength = sizeof(uint32_t);
+ uint8_t* observationData = (uint8_t*)responseInfo.info.options[0].optionData;
+ uint32_t observationOption= serverRequest->observationOption;
- if((OCResource *)ehResponse->resourceHandle &&
- ((OCResource *)ehResponse->resourceHandle)->resourceProperties == (OCResourceProperty) 0)
+ for (size_t i=sizeof(uint32_t); i; --i)
+ {
+ observationData[i-1] = observationOption & 0xFF;
+ observationOption >>=8;
+ }
+
+ // Point to the next header option before copying vender specific header options
+ optionsPointer += 1;
+ }
+
+ if (ehResponse->numSendVendorSpecificHeaderOptions)
+ {
+ memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
+ sizeof(OCHeaderOption) *
+ ehResponse->numSendVendorSpecificHeaderOptions);
+ }
+ }
+ else
{
- ehResponse->ehResult = OC_EH_RESOURCE_DELETED;
+ responseInfo.info.options = NULL;
}
- protocolResponse.result = EntityHandlerCodeToOCStackCode(ehResponse->ehResult);
- protocolResponse.requesterAddr = &serverRequest->requesterAddr;
- protocolResponse.requestToken = &serverRequest->requestToken;
- protocolResponse.numSendVendorSpecificHeaderOptions = ehResponse->numSendVendorSpecificHeaderOptions;
- protocolResponse.sendVendorSpecificHeaderOptions = ehResponse->sendVendorSpecificHeaderOptions;
- protocolResponse.resourceUri = ehResponse->resourceUri;
- protocolResponse.delayedResNeeded = serverRequest->delayedResNeeded;
- protocolResponse.secured = serverRequest->secured;
- protocolResponse.slowFlag = serverRequest->slowFlag;
- protocolResponse.notificationFlag = serverRequest->notificationFlag;
- //should we put the prefix and suffix here?
- protocolResponse.payload = (unsigned char *) OCMalloc(MAX_RESPONSE_LENGTH);
- if(!protocolResponse.payload)
+ responseInfo.isMulticast = false;
+ responseInfo.info.payload = NULL;
+ responseInfo.info.payloadSize = 0;
+ responseInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
+
+ // Put the JSON prefix and suffix around the payload
+ if(ehResponse->payload)
{
- return OC_STACK_NO_MEMORY;
+#ifdef WITH_PRESENCE
+ if (ehResponse->payload->type == PAYLOAD_TYPE_PRESENCE)
+ {
+ responseInfo.isMulticast = true;
+ }
+ else
+#endif
+ {
+ responseInfo.isMulticast = false;
+ }
+
+ switch(serverRequest->acceptFormat)
+ {
+ case OC_FORMAT_UNDEFINED:
+ // No preference set by the client, so default to CBOR then
+ case OC_FORMAT_CBOR:
+ if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
+ &responseInfo.info.payloadSize))
+ != OC_STACK_OK)
+ {
+ OIC_LOG(ERROR, TAG, "Error converting payload");
+ OICFree(responseInfo.info.options);
+ return result;
+ }
+ // Add CONTENT_FORMAT OPT if payload exist
+ if (responseInfo.info.payloadSize > 0)
+ {
+ responseInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
+ }
+ break;
+ default:
+ responseInfo.result = CA_NOT_ACCEPTABLE;
+ }
}
- strcpy((char *)protocolResponse.payload, (const char *)OC_JSON_PREFIX);
- strcat((char *)protocolResponse.payload, (const char *)ehResponse->payload);
- strcat((char *)protocolResponse.payload, (const char *)OC_JSON_SUFFIX);
- protocolResponse.payloadSize = strlen((const char *)protocolResponse.payload) + 1;
- protocolResponse.resourceUri = ehResponse->resourceUri;
- //revise the following
- protocolResponse.coapID = serverRequest->coapID;
- if(serverRequest->observeResult == OC_STACK_OK)
- {
- protocolResponse.observationOption = serverRequest->observationOption;
+#ifdef WITH_PRESENCE
+ CATransportAdapter_t CAConnTypes[] = {
+ CA_ADAPTER_IP,
+ CA_ADAPTER_GATT_BTLE,
+ CA_ADAPTER_RFCOMM_BTEDR,
+ CA_ADAPTER_NFC
+#ifdef RA_ADAPTER
+ , CA_ADAPTER_REMOTE_ACCESS
+#endif
+ , CA_ADAPTER_TCP
+ };
+
+ size_t size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
+
+ CATransportAdapter_t adapter = responseEndpoint.adapter;
+ // Default adapter, try to send response out on all adapters.
+ if (adapter == CA_DEFAULT_ADAPTER)
+ {
+ adapter =
+ (CATransportAdapter_t)(
+ CA_ADAPTER_IP |
+ CA_ADAPTER_GATT_BTLE |
+ CA_ADAPTER_RFCOMM_BTEDR |
+ CA_ADAPTER_NFC
+#ifdef RA_ADAP
+ | CA_ADAPTER_REMOTE_ACCESS
+#endif
+ | CA_ADAPTER_TCP
+ );
}
- else
+
+ result = OC_STACK_OK;
+ OCStackResult tempResult = OC_STACK_OK;
+
+ for(size_t i = 0; i < size; i++ )
{
- protocolResponse.observationOption = OC_OBSERVE_NO_OPTION;
+ responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
+ if(responseEndpoint.adapter)
+ {
+ //The result is set to OC_STACK_OK only if OCSendResponse succeeds in sending the
+ //response on all the n/w interfaces else it is set to OC_STACK_ERROR
+ tempResult = OCSendResponse(&responseEndpoint, &responseInfo);
+ }
+ if(OC_STACK_OK != tempResult)
+ {
+ result = tempResult;
+ }
}
- // Make call to OCCoAP layer
- result = OCDoCoAPResponse(&protocolResponse);
+#else
+
+ OIC_LOG(INFO, TAG, "Calling OCSendResponse with:");
+ OIC_LOG_V(INFO, TAG, "\tEndpoint address: %s", responseEndpoint.addr);
+ OIC_LOG_V(INFO, TAG, "\tEndpoint adapter: %s", responseEndpoint.adapter);
+ OIC_LOG_V(INFO, TAG, "\tResponse result : %s", responseInfo.result);
+ OIC_LOG_V(INFO, TAG, "\tResponse for uri: %s", responseInfo.info.resourceUri);
+
+ result = OCSendResponse(&responseEndpoint, &responseInfo);
+#endif
- OCFree(protocolResponse.payload);
+ OICFree(responseInfo.info.payload);
+ OICFree(responseInfo.info.options);
//Delete the request
FindAndDeleteServerRequest(serverRequest);
return result;
-#endif
}
+/**
+ * Handler function for sending a response from multiple resources, such as a collection.
+ * Aggregates responses from multiple resource until all responses are received then sends the
+ * concatenated response
+ *
+ * TODO: Need to add a timeout in case a (remote?) resource does not respond
+ *
+ * @param ehResponse - pointer to the response from the resource
+ *
+ * @return
+ * OCStackResult
+ */
OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
{
- OCStackResult stackRet = OC_STACK_ERROR;
- OCServerRequest * serverRequest = NULL;
- OCServerResponse * serverResponse = NULL;
+ if(!ehResponse || !ehResponse->payload)
+ {
+ OIC_LOG(ERROR, TAG, "HandleAggregateResponse invalid parameters");
+ return OC_STACK_INVALID_PARAM;
+ }
- OC_LOG_V(INFO, TAG, "Inside HandleAggregateResponse: %s", ehResponse->payload);
+ OIC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
- serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
- serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
+ OCServerRequest *serverRequest = GetServerRequestUsingHandle(ehResponse->requestHandle);
+ OCServerResponse *serverResponse = GetServerResponseUsingHandle(ehResponse->requestHandle);
+ OCStackResult stackRet = OC_STACK_ERROR;
if(serverRequest)
{
if(!serverResponse)
{
- OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
+ OIC_LOG(INFO, TAG, "This is the first response fragment");
stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
if (OC_STACK_OK != stackRet)
{
- OC_LOG(ERROR, TAG, PCF("Error adding server response"));
+ OIC_LOG(ERROR, TAG, "Error adding server response");
return stackRet;
}
VERIFY_NON_NULL(serverResponse);
- VERIFY_NON_NULL(serverResponse->payload);
}
- if((serverResponse->remainingPayloadSize >= ehResponse->payloadSize + 1 &&
- serverRequest->numResponses == 1) ||
- (serverResponse->remainingPayloadSize >= ehResponse->payloadSize + 2 &&
- serverRequest->numResponses > 1))
+ if(ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
{
- OC_LOG(INFO, TAG, PCF("There is room in response buffer"));
- // append
- snprintf((char *)serverResponse->payload, serverResponse->remainingPayloadSize, "%s%s", (char *)serverResponse->payload, (char *)ehResponse->payload);
- OC_LOG_V(INFO, TAG, "Current aggregated response ...%s", serverResponse->payload);
- serverResponse->remainingPayloadSize -= ehResponse->payloadSize;
- (serverRequest->numResponses)--;
- if(serverRequest->numResponses == 0)
- {
- OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
- ehResponse->payload = serverResponse->payload;
- ehResponse->payloadSize = strlen((char *) serverResponse->payload) + 1;
- stackRet = HandleSingleResponse(ehResponse);
- //Delete the request and response
- FindAndDeleteServerRequest(serverRequest);
- FindAndDeleteServerResponse(serverResponse);
- }
- else
- {
- OC_LOG(INFO, TAG, PCF("More response fragment to come"));
- // TODO: we should consider using strcat rather than setting a char by char here!
- snprintf((char *)serverResponse->payload, serverResponse->remainingPayloadSize, "%s%c", (char *)serverResponse->payload,OC_JSON_SEPARATOR);
- OC_LOG_V(INFO, TAG, "Current aggregated response ...%s", serverResponse->payload);
- (serverResponse->remainingPayloadSize)--;
- stackRet = OC_STACK_OK;
- }
+ stackRet = OC_STACK_ERROR;
+ OIC_LOG(ERROR, TAG, "Error adding payload, as it was the incorrect type");
+ goto exit;
+ }
+
+ OCRepPayload *newPayload = OCRepPayloadBatchClone((OCRepPayload *)ehResponse->payload);
+
+ if(!serverResponse->payload)
+ {
+ serverResponse->payload = (OCPayload *)newPayload;
}
else
{
- OC_LOG(INFO, TAG, PCF("No room in response buffer"));
+ OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
+ (OCRepPayload*)newPayload);
+ }
+
+ (serverRequest->numResponses)--;
+
+ if(serverRequest->numResponses == 0)
+ {
+ OIC_LOG(INFO, TAG, "This is the last response fragment");
+ ehResponse->payload = serverResponse->payload;
+ ehResponse->ehResult = OC_EH_OK;
+ stackRet = HandleSingleResponse(ehResponse);
//Delete the request and response
FindAndDeleteServerRequest(serverRequest);
FindAndDeleteServerResponse(serverResponse);
- stackRet = OC_STACK_NO_MEMORY;
+ }
+ else
+ {
+ OIC_LOG(INFO, TAG, "More response fragments to come");
+ stackRet = OC_STACK_OK;
}
}
exit:
+
return stackRet;
}
projects / platform / upstream / iotivity.git / blobdiff