1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
23 #include "ocserverrequest.h"
24 #include "ocresourcehandler.h"
25 #include "oic_malloc.h"
26 #include "oic_string.h"
27 #include "ocpayload.h"
28 #include "ocpayloadcbor.h"
31 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
32 #include "routingutility.h"
36 #include "cainterface.h"
42 #define VERIFY_NON_NULL(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
44 #define TAG "OIC_RI_SERVERREQUEST"
46 static struct OCServerRequest * serverRequestList = NULL;
47 static struct OCServerResponse * serverResponseList = NULL;
49 //-------------------------------------------------------------------------------------------------
51 //-------------------------------------------------------------------------------------------------
54 * Add a server response to the server response list
56 * @param response initialized server response that is created by this function
57 * @param requestHandle - handle of the response
62 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
66 return OC_STACK_INVALID_PARAM;
69 OCServerResponse * serverResponse = NULL;
71 serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
72 VERIFY_NON_NULL(serverResponse);
74 serverResponse->payload = NULL;
76 serverResponse->requestHandle = requestHandle;
78 *response = serverResponse;
79 OIC_LOG(INFO, TAG, "Server Response Added!!");
80 LL_APPEND (serverResponseList, serverResponse);
86 OICFree(serverResponse);
87 serverResponse = NULL;
90 return OC_STACK_NO_MEMORY;
94 * Delete a server request from the server request list
96 * @param serverRequest - server request to delete
98 static void DeleteServerRequest(OCServerRequest * serverRequest)
102 LL_DELETE(serverRequestList, serverRequest);
103 OICFree(serverRequest->requestToken);
104 OICFree(serverRequest);
105 serverRequest = NULL;
106 OIC_LOG(INFO, TAG, "Server Request Removed!!");
111 * Delete a server response from the server response list
113 * @param serverResponse - server response to delete
115 static void DeleteServerResponse(OCServerResponse * serverResponse)
119 LL_DELETE(serverResponseList, serverResponse);
120 OCPayloadDestroy(serverResponse->payload);
121 OICFree(serverResponse);
122 OIC_LOG(INFO, TAG, "Server Response Removed!!");
127 * Find a server response and delete it from the server response list
129 * @param serverResponse - server response to find and delete
131 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
133 OCServerResponse* tmp;
136 LL_FOREACH(serverResponseList, tmp)
138 if (serverResponse == tmp)
140 DeleteServerResponse(tmp);
148 * Ensure no accept header option is included when sending responses and add routing info to
151 * @param object CA remote endpoint.
152 * @param requestInfo CA request info.
154 * @return ::OC_STACK_OK on success, some other value upon failure.
156 static OCStackResult OCSendResponse(const CAEndpoint_t *object, CAResponseInfo_t *responseInfo)
158 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
159 // Add route info in RM option.
160 OCStackResult rmResult = RMAddInfo(object->routeData, responseInfo, false, NULL);
161 if(OC_STACK_OK != rmResult)
163 OIC_LOG(ERROR, TAG, "Add option failed");
168 // Do not include the accept header option
169 responseInfo->info.acceptFormat = CA_FORMAT_UNDEFINED;
170 CAResult_t result = CASendResponse(object, responseInfo);
171 if(CA_STATUS_OK != result)
173 OIC_LOG_V(ERROR, TAG, "CASendResponse failed with CA error %u", result);
174 return CAResultToOCResult(result);
179 //-------------------------------------------------------------------------------------------------
181 //-------------------------------------------------------------------------------------------------
184 * Get a server request from the server request list using the specified token.
186 * @param token - token of server request
187 * @param tokenLength - length of token
192 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
196 OIC_LOG(ERROR, TAG, "Invalid Parameter Token");
200 OCServerRequest * out = NULL;
201 OIC_LOG(INFO, TAG,"Get server request with token");
202 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
204 OIC_LOG(INFO, TAG,"Found token");
205 LL_FOREACH (serverRequestList, out)
207 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
208 if(memcmp(out->requestToken, token, tokenLength) == 0)
213 OIC_LOG(ERROR, TAG, "Server Request not found!!");
218 * Get a server request from the server request list using the specified handle
220 * @param handle - handle of server request
224 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
226 OCServerRequest * out = NULL;
227 LL_FOREACH (serverRequestList, out)
234 OIC_LOG(ERROR, TAG, "Server Request not found!!");
239 * Get a server response from the server response list using the specified handle
241 * @param handle - handle of server response
246 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
248 OCServerResponse * out = NULL;
249 LL_FOREACH (serverResponseList, out)
251 if(out->requestHandle == handle)
256 OIC_LOG(ERROR, TAG, "Server Response not found!!");
260 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
261 uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
262 uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
263 OCQualityOfService qos, char * query,
264 OCHeaderOption * rcvdVendorSpecificHeaderOptions,
265 uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
266 char * resourceUrl, size_t reqTotalSize, OCPayloadFormat acceptFormat,
267 const OCDevAddr *devAddr)
271 return OC_STACK_INVALID_PARAM;
274 OCServerRequest * serverRequest = NULL;
276 OIC_LOG_V(INFO, TAG, "addserverrequest entry!! [%s:%u]", devAddr->addr, devAddr->port);
278 serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
279 (reqTotalSize ? reqTotalSize : 1) - 1);
280 VERIFY_NON_NULL(devAddr);
281 VERIFY_NON_NULL(serverRequest);
283 serverRequest->coapID = coapID;
284 serverRequest->delayedResNeeded = delayedResNeeded;
285 serverRequest->notificationFlag = notificationFlag;
287 serverRequest->method = method;
288 serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
289 serverRequest->observationOption = observationOption;
290 serverRequest->observeResult = OC_STACK_ERROR;
291 serverRequest->qos = qos;
292 serverRequest->acceptFormat = acceptFormat;
293 serverRequest->ehResponseHandler = HandleSingleResponse;
294 serverRequest->numResponses = 1;
298 OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
301 if(rcvdVendorSpecificHeaderOptions)
303 memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
304 MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
306 if(payload && reqTotalSize)
308 // destination is at least 1 greater than the source, so a NULL always exists in the
310 memcpy(serverRequest->payload, payload, reqTotalSize);
311 serverRequest->payloadSize = reqTotalSize;
314 serverRequest->requestComplete = 0;
317 // If tokenLength is zero, the return value depends on the
318 // particular library implementation (it may or may not be a null pointer).
321 serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
322 VERIFY_NON_NULL(serverRequest->requestToken);
323 memcpy(serverRequest->requestToken, requestToken, tokenLength);
327 serverRequest->tokenLength = tokenLength;
331 OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
335 serverRequest->devAddr = *devAddr;
337 *request = serverRequest;
338 OIC_LOG(INFO, TAG, "Server Request Added!!");
339 LL_APPEND (serverRequestList, serverRequest);
345 OICFree(serverRequest);
346 serverRequest = NULL;
349 return OC_STACK_NO_MEMORY;
352 OCStackResult FormOCEntityHandlerRequest(
353 OCEntityHandlerRequest * entityHandlerRequest,
354 OCRequestHandle request,
357 OCResourceHandle resource,
359 OCPayloadType payloadType,
362 uint8_t numVendorOptions,
363 OCHeaderOption * vendorOptions,
364 OCObserveAction observeAction,
365 OCObservationId observeID,
368 if (entityHandlerRequest)
370 entityHandlerRequest->resource = (OCResourceHandle) resource;
371 entityHandlerRequest->requestHandle = request;
372 entityHandlerRequest->method = method;
373 entityHandlerRequest->devAddr = *endpoint;
374 entityHandlerRequest->query = queryBuf;
375 entityHandlerRequest->obsInfo.action = observeAction;
376 entityHandlerRequest->obsInfo.obsId = observeID;
377 entityHandlerRequest->messageID = messageID;
379 if(payload && payloadSize)
381 if(OCParsePayload(&entityHandlerRequest->payload, payloadType,
382 payload, payloadSize) != OC_STACK_OK)
384 return OC_STACK_ERROR;
389 entityHandlerRequest->payload = NULL;
392 entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
393 entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
398 return OC_STACK_INVALID_PARAM;
402 * Find a server request in the server request list and delete
404 * @param serverRequest - server request to find and delete
406 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
408 OCServerRequest* tmp;
411 LL_FOREACH(serverRequestList, tmp)
413 if (serverRequest == tmp)
415 DeleteServerRequest(tmp);
422 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result, OCMethod method)
424 CAResponseResult_t caResult = CA_BAD_REQ;
428 // Successful Client Request
429 case OC_EH_RESOURCE_CREATED: // 2.01
430 if (method == OC_REST_POST || method == OC_REST_PUT)
432 caResult = CA_CREATED;
435 case OC_EH_RESOURCE_DELETED: // 2.02
436 if (method == OC_REST_POST || method == OC_REST_DELETE)
438 caResult = CA_DELETED;
441 case OC_EH_SLOW: // 2.05
442 caResult = CA_CONTENT;
444 case OC_EH_OK: // 2.04/2.05
445 if (method == OC_REST_POST || method == OC_REST_PUT)
447 caResult = CA_CHANGED;
449 else if (method == OC_REST_GET)
451 caResult = CA_CONTENT;
454 case OC_EH_VALID: // 2.03
457 case OC_EH_CHANGED: // 2.04
458 caResult = CA_CHANGED;
460 // Unsuccessful Client Request
461 case OC_EH_UNAUTHORIZED_REQ: // 4.01
462 caResult = CA_UNAUTHORIZED_REQ;
464 case OC_EH_BAD_OPT: // 4.02
465 caResult = CA_BAD_OPT;
467 case OC_EH_FORBIDDEN: // 4.03
468 caResult = CA_FORBIDDEN_REQ;
470 case OC_EH_RESOURCE_NOT_FOUND: // 4.04
471 caResult = CA_NOT_FOUND;
473 case OC_EH_METHOD_NOT_ALLOWED: // 4.05
474 caResult = CA_METHOD_NOT_ALLOWED;
476 case OC_EH_NOT_ACCEPTABLE: // 4.06
477 caResult = CA_NOT_ACCEPTABLE;
479 case OC_EH_INTERNAL_SERVER_ERROR: // 5.00
480 caResult = CA_INTERNAL_SERVER_ERROR;
482 case OC_EH_RETRANSMIT_TIMEOUT: // 5.04
483 caResult = CA_RETRANSMIT_TIMEOUT;
486 caResult = CA_BAD_REQ;
494 * Handler function for sending a response from a single resource
496 * @param ehResponse - pointer to the response from the resource
501 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
503 OCStackResult result = OC_STACK_ERROR;
504 CAEndpoint_t responseEndpoint = {.adapter = CA_DEFAULT_ADAPTER};
505 CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
506 CAHeaderOption_t* optionsPointer = NULL;
508 if(!ehResponse || !ehResponse->requestHandle)
510 OIC_LOG(ERROR, TAG, "ehResponse/requestHandle is NULL");
511 return OC_STACK_ERROR;
514 OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
516 CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
518 responseInfo.info.messageId = serverRequest->coapID;
519 responseInfo.info.resourceUri = serverRequest->resourceUrl;
520 responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult, serverRequest->method);
522 if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
524 responseInfo.info.type = CA_MSG_CONFIRM;
526 else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
528 responseInfo.info.type = CA_MSG_NONCONFIRM;
530 else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
531 serverRequest->qos == OC_HIGH_QOS)
533 responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
535 else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
536 serverRequest->qos == OC_HIGH_QOS)
538 // To assign new messageId in CA.
539 responseInfo.info.messageId = 0;
540 responseInfo.info.type = CA_MSG_CONFIRM;
542 else if(!serverRequest->notificationFlag)
544 responseInfo.info.type = CA_MSG_NONCONFIRM;
548 OIC_LOG(ERROR, TAG, "default responseInfo type is NON");
549 responseInfo.info.type = CA_MSG_NONCONFIRM;
552 char rspToken[CA_MAX_TOKEN_LEN + 1] = {};
553 responseInfo.info.token = (CAToken_t)rspToken;
555 memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
556 responseInfo.info.tokenLength = serverRequest->tokenLength;
558 if(serverRequest->observeResult == OC_STACK_OK)
560 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
564 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
567 if(responseInfo.info.numOptions > 0)
569 responseInfo.info.options = (CAHeaderOption_t *)
570 OICCalloc(responseInfo.info.numOptions,
571 sizeof(CAHeaderOption_t));
573 if(!responseInfo.info.options)
575 OIC_LOG(FATAL, TAG, "Memory alloc for options failed");
576 return OC_STACK_NO_MEMORY;
579 optionsPointer = responseInfo.info.options;
581 // TODO: This exposes CoAP specific details. At some point, this should be
582 // re-factored and handled in the CA layer.
583 if(serverRequest->observeResult == OC_STACK_OK)
585 responseInfo.info.options[0].protocolID = CA_COAP_ID;
586 responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
587 responseInfo.info.options[0].optionLength = sizeof(uint32_t);
588 uint8_t* observationData = (uint8_t*)responseInfo.info.options[0].optionData;
589 uint32_t observationOption= serverRequest->observationOption;
591 for (size_t i=sizeof(uint32_t); i; --i)
593 observationData[i-1] = observationOption & 0xFF;
594 observationOption >>=8;
597 // Point to the next header option before copying vender specific header options
601 if (ehResponse->numSendVendorSpecificHeaderOptions)
603 memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
604 sizeof(OCHeaderOption) *
605 ehResponse->numSendVendorSpecificHeaderOptions);
610 responseInfo.info.options = NULL;
613 responseInfo.isMulticast = false;
614 responseInfo.info.payload = NULL;
615 responseInfo.info.payloadSize = 0;
616 responseInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
618 // Put the JSON prefix and suffix around the payload
619 if(ehResponse->payload)
621 if (ehResponse->payload->type == PAYLOAD_TYPE_PRESENCE)
623 responseInfo.isMulticast = true;
627 responseInfo.isMulticast = false;
630 switch(serverRequest->acceptFormat)
632 case OC_FORMAT_UNDEFINED:
633 // No preference set by the client, so default to CBOR then
635 if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
636 &responseInfo.info.payloadSize))
639 OIC_LOG(ERROR, TAG, "Error converting payload");
640 OICFree(responseInfo.info.options);
643 responseInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
646 responseInfo.result = CA_NOT_ACCEPTABLE;
651 CATransportAdapter_t CAConnTypes[] = {
653 CA_ADAPTER_GATT_BTLE,
654 CA_ADAPTER_RFCOMM_BTEDR,
657 , CA_ADAPTER_REMOTE_ACCESS
662 size_t size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
664 CATransportAdapter_t adapter = responseEndpoint.adapter;
665 // Default adapter, try to send response out on all adapters.
666 if (adapter == CA_DEFAULT_ADAPTER)
669 (CATransportAdapter_t)(
671 CA_ADAPTER_GATT_BTLE |
672 CA_ADAPTER_RFCOMM_BTEDR |
675 | CA_ADAPTER_REMOTE_ACCESS
681 result = OC_STACK_OK;
682 OCStackResult tempResult = OC_STACK_OK;
684 for(size_t i = 0; i < size; i++ )
686 responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
687 if(responseEndpoint.adapter)
689 //The result is set to OC_STACK_OK only if OCSendResponse succeeds in sending the
690 //response on all the n/w interfaces else it is set to OC_STACK_ERROR
691 tempResult = OCSendResponse(&responseEndpoint, &responseInfo);
693 if(OC_STACK_OK != tempResult)
700 OIC_LOG(INFO, TAG, "Calling OCSendResponse with:");
701 OIC_LOG_V(INFO, TAG, "\tEndpoint address: %s", responseEndpoint.addr);
702 OIC_LOG_V(INFO, TAG, "\tEndpoint adapter: %s", responseEndpoint.adapter);
703 OIC_LOG_V(INFO, TAG, "\tResponse result : %s", responseInfo.result);
704 OIC_LOG_V(INFO, TAG, "\tResponse for uri: %s", responseInfo.info.resourceUri);
706 result = OCSendResponse(&responseEndpoint, &responseInfo);
709 OICFree(responseInfo.info.payload);
710 OICFree(responseInfo.info.options);
712 FindAndDeleteServerRequest(serverRequest);
717 * Handler function for sending a response from multiple resources, such as a collection.
718 * Aggregates responses from multiple resource until all responses are received then sends the
719 * concatenated response
721 * TODO: Need to add a timeout in case a (remote?) resource does not respond
723 * @param ehResponse - pointer to the response from the resource
728 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
730 if(!ehResponse || !ehResponse->payload)
732 OIC_LOG(ERROR, TAG, "HandleAggregateResponse invalid parameters");
733 return OC_STACK_INVALID_PARAM;
736 OIC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
738 OCServerRequest *serverRequest = GetServerRequestUsingHandle((OCServerRequest *)
739 ehResponse->requestHandle);
740 OCServerResponse *serverResponse = GetServerResponseUsingHandle((OCServerRequest *)
741 ehResponse->requestHandle);
743 OCStackResult stackRet = OC_STACK_ERROR;
748 OIC_LOG(INFO, TAG, "This is the first response fragment");
749 stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
750 if (OC_STACK_OK != stackRet)
752 OIC_LOG(ERROR, TAG, "Error adding server response");
755 VERIFY_NON_NULL(serverResponse);
758 if(ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
760 stackRet = OC_STACK_ERROR;
761 OIC_LOG(ERROR, TAG, "Error adding payload, as it was the incorrect type");
765 OCRepPayload *newPayload = OCRepPayloadClone((OCRepPayload *)ehResponse->payload);
767 if(!serverResponse->payload)
769 serverResponse->payload = (OCPayload *)newPayload;
773 OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
774 (OCRepPayload*)newPayload);
777 (serverRequest->numResponses)--;
779 if(serverRequest->numResponses == 0)
781 OIC_LOG(INFO, TAG, "This is the last response fragment");
782 ehResponse->payload = serverResponse->payload;
783 stackRet = HandleSingleResponse(ehResponse);
784 //Delete the request and response
785 FindAndDeleteServerRequest(serverRequest);
786 FindAndDeleteServerResponse(serverResponse);
790 OIC_LOG(INFO, TAG, "More response fragments to come");
791 stackRet = OC_STACK_OK;