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 "ocobserve.h"
26 #include "oic_malloc.h"
27 #include "oic_string.h"
28 #include "ocpayload.h"
29 #include "ocpayloadcbor.h"
32 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
33 #include "routingutility.h"
37 #include "cainterface.h"
39 #include <coap/utlist.h>
43 #define VERIFY_NON_NULL(arg) { if (!arg) {OIC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
45 #define TAG "OIC_RI_SERVERREQUEST"
47 static struct OCServerRequest * serverRequestList = NULL;
48 static struct OCServerResponse * serverResponseList = NULL;
50 //-------------------------------------------------------------------------------------------------
52 //-------------------------------------------------------------------------------------------------
55 * Add a server response to the server response list
57 * @param response initialized server response that is created by this function
58 * @param requestHandle - handle of the response
63 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
67 return OC_STACK_INVALID_PARAM;
70 OCServerResponse * serverResponse = NULL;
72 serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
73 VERIFY_NON_NULL(serverResponse);
75 serverResponse->payload = NULL;
77 serverResponse->requestHandle = requestHandle;
79 *response = serverResponse;
80 OIC_LOG(INFO, TAG, "Server Response Added!!");
81 LL_APPEND (serverResponseList, serverResponse);
87 OICFree(serverResponse);
88 serverResponse = NULL;
91 return OC_STACK_NO_MEMORY;
95 * Delete a server request from the server request list
97 * @param serverRequest - server request to delete
99 static void DeleteServerRequest(OCServerRequest * serverRequest)
103 LL_DELETE(serverRequestList, serverRequest);
104 OICFree(serverRequest->requestToken);
105 OICFree(serverRequest->rcvdVendorSpecificHeaderOptions);
106 OICFree(serverRequest);
107 serverRequest = NULL;
108 OIC_LOG(INFO, TAG, "Server Request Removed!!");
113 * Delete a server response from the server response list
115 * @param serverResponse - server response to delete
117 static void DeleteServerResponse(OCServerResponse * serverResponse)
121 LL_DELETE(serverResponseList, serverResponse);
122 OCPayloadDestroy(serverResponse->payload);
123 OICFree(serverResponse);
124 OIC_LOG(INFO, TAG, "Server Response Removed!!");
129 * Find a server response and delete it from the server response list
131 * @param serverResponse - server response to find and delete
133 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
135 OCServerResponse* tmp;
138 LL_FOREACH(serverResponseList, tmp)
140 if (serverResponse == tmp)
142 DeleteServerResponse(tmp);
150 * Ensure no accept header option is included when sending responses and add routing info to
153 * @param object CA remote endpoint.
154 * @param requestInfo CA request info.
156 * @return ::OC_STACK_OK on success, some other value upon failure.
158 static OCStackResult OCSendResponse(const CAEndpoint_t *object, CAResponseInfo_t *responseInfo)
160 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
161 // Add route info in RM option.
162 OCStackResult rmResult = RMAddInfo(object->routeData, responseInfo, false, NULL);
163 if(OC_STACK_OK != rmResult)
165 OIC_LOG(ERROR, TAG, "Add option failed");
170 // Do not include the accept header option
171 responseInfo->info.acceptFormat = CA_FORMAT_UNDEFINED;
172 CAResult_t result = CASendResponse(object, responseInfo);
173 if(CA_STATUS_OK != result)
175 OIC_LOG_V(ERROR, TAG, "CASendResponse failed with CA error %u", result);
176 return CAResultToOCResult(result);
181 //-------------------------------------------------------------------------------------------------
183 //-------------------------------------------------------------------------------------------------
186 * Get a server request from the server request list using the specified token.
188 * @param token - token of server request
189 * @param tokenLength - length of token
194 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
198 OIC_LOG(ERROR, TAG, "Invalid Parameter Token");
202 OCServerRequest * out = NULL;
203 OIC_LOG(INFO, TAG,"Get server request with token");
204 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
206 OIC_LOG(INFO, TAG, "Found token");
207 LL_FOREACH (serverRequestList, out)
211 OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, out->tokenLength);
212 if((tokenLength == out->tokenLength) &&
213 memcmp(out->requestToken, token, tokenLength) == 0)
219 OIC_LOG(INFO, TAG, "Server Request not found!!");
224 * Get a server request from the server request list using the specified handle
226 * @param handle - handle of server request
230 OCServerRequest * GetServerRequestUsingHandle (const OCRequestHandle handle)
232 OCServerRequest * out = NULL;
233 LL_FOREACH (serverRequestList, out)
235 if(out->requestId == handle)
240 OIC_LOG(ERROR, TAG, "Server Request not found!!");
245 * Get a server response from the server response list using the specified handle
247 * @param handle - handle of server response
252 OCServerResponse * GetServerResponseUsingHandle (const OCRequestHandle handle)
254 OCServerResponse * out = NULL;
255 LL_FOREACH (serverResponseList, out)
257 if(out->requestHandle == handle)
262 OIC_LOG(INFO, TAG, "Server Response not found!!");
266 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
267 uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
268 uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
269 OCQualityOfService qos, char * query,
270 OCHeaderOption * rcvdVendorSpecificHeaderOptions,
271 uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
272 char * resourceUrl, size_t reqTotalSize, OCPayloadFormat acceptFormat,
273 const OCDevAddr *devAddr)
277 return OC_STACK_INVALID_PARAM;
280 OCServerRequest * serverRequest = NULL;
282 OIC_LOG_V(INFO, TAG, "addserverrequest entry!! [%s:%u]", devAddr->addr, devAddr->port);
284 serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
285 (reqTotalSize ? reqTotalSize : 1) - 1);
286 VERIFY_NON_NULL(devAddr);
287 VERIFY_NON_NULL(serverRequest);
289 serverRequest->coapID = coapID;
290 serverRequest->delayedResNeeded = delayedResNeeded;
291 serverRequest->notificationFlag = notificationFlag;
293 serverRequest->method = method;
294 serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
295 serverRequest->observationOption = observationOption;
296 serverRequest->observeResult = OC_STACK_ERROR;
297 serverRequest->qos = qos;
298 serverRequest->acceptFormat = acceptFormat;
299 serverRequest->ehResponseHandler = HandleSingleResponse;
300 serverRequest->numResponses = 1;
301 serverRequest->requestId = OCGetRandom();
305 OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
308 if(rcvdVendorSpecificHeaderOptions)
310 serverRequest->rcvdVendorSpecificHeaderOptions =
311 (OCHeaderOption *) OICCalloc(numRcvdVendorSpecificHeaderOptions, sizeof(OCHeaderOption));
312 VERIFY_NON_NULL(serverRequest->rcvdVendorSpecificHeaderOptions);
314 memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
315 numRcvdVendorSpecificHeaderOptions * sizeof(OCHeaderOption));
317 if(payload && reqTotalSize)
319 // destination is at least 1 greater than the source, so a NULL always exists in the
321 memcpy(serverRequest->payload, payload, reqTotalSize);
322 serverRequest->payloadSize = reqTotalSize;
325 serverRequest->requestComplete = 0;
328 // If tokenLength is zero, the return value depends on the
329 // particular library implementation (it may or may not be a null pointer).
332 serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
333 VERIFY_NON_NULL(serverRequest->requestToken);
334 memcpy(serverRequest->requestToken, requestToken, tokenLength);
337 serverRequest->tokenLength = tokenLength;
341 OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
345 serverRequest->devAddr = *devAddr;
347 *request = serverRequest;
348 OIC_LOG(INFO, TAG, "Server Request Added!!");
349 LL_APPEND (serverRequestList, serverRequest);
355 OICFree(serverRequest->requestToken);
356 OICFree(serverRequest->rcvdVendorSpecificHeaderOptions);
357 OICFree(serverRequest);
358 serverRequest = NULL;
361 return OC_STACK_NO_MEMORY;
364 OCStackResult FormOCEntityHandlerRequest(
365 OCEntityHandlerRequest * entityHandlerRequest,
366 OCRequestHandle request,
369 OCResourceHandle resource,
371 OCPayloadType payloadType,
374 uint8_t numVendorOptions,
375 OCHeaderOption * vendorOptions,
376 OCObserveAction observeAction,
377 OCObservationId observeID,
380 if (entityHandlerRequest)
382 entityHandlerRequest->resource = (OCResourceHandle) resource;
383 entityHandlerRequest->requestHandle = request;
384 entityHandlerRequest->method = method;
385 entityHandlerRequest->devAddr = *endpoint;
386 entityHandlerRequest->query = queryBuf;
387 entityHandlerRequest->obsInfo.action = observeAction;
388 entityHandlerRequest->obsInfo.obsId = observeID;
389 entityHandlerRequest->messageID = messageID;
391 if(payload && payloadSize)
393 if(OCParsePayload(&entityHandlerRequest->payload, payloadType,
394 payload, payloadSize) != OC_STACK_OK)
396 return OC_STACK_ERROR;
401 entityHandlerRequest->payload = NULL;
404 entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
405 entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
410 return OC_STACK_INVALID_PARAM;
414 * Find a server request in the server request list and delete
416 * @param serverRequest - server request to find and delete
418 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
420 OCServerRequest* tmp;
423 LL_FOREACH(serverRequestList, tmp)
425 if (serverRequest == tmp)
427 DeleteServerRequest(tmp);
434 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result, OCMethod method)
436 CAResponseResult_t caResult = CA_BAD_REQ;
440 // Successful Client Request
441 case OC_EH_RESOURCE_CREATED: // 2.01
442 if (method == OC_REST_POST || method == OC_REST_PUT)
444 caResult = CA_CREATED;
447 case OC_EH_RESOURCE_DELETED: // 2.02
448 if (method == OC_REST_POST || method == OC_REST_DELETE)
450 caResult = CA_DELETED;
453 case OC_EH_SLOW: // 2.05
454 caResult = CA_CONTENT;
457 case OC_EH_CHANGED: // 2.04
458 case OC_EH_CONTENT: // 2.05
459 if (method == OC_REST_POST || method == OC_REST_PUT)
461 caResult = CA_CHANGED;
463 else if (method == OC_REST_GET)
465 caResult = CA_CONTENT;
468 case OC_EH_VALID: // 2.03
471 // Unsuccessful Client Request
472 case OC_EH_UNAUTHORIZED_REQ: // 4.01
473 caResult = CA_UNAUTHORIZED_REQ;
475 case OC_EH_BAD_OPT: // 4.02
476 caResult = CA_BAD_OPT;
478 case OC_EH_FORBIDDEN: // 4.03
479 caResult = CA_FORBIDDEN_REQ;
481 case OC_EH_RESOURCE_NOT_FOUND: // 4.04
482 caResult = CA_NOT_FOUND;
484 case OC_EH_METHOD_NOT_ALLOWED: // 4.05
485 caResult = CA_METHOD_NOT_ALLOWED;
487 case OC_EH_NOT_ACCEPTABLE: // 4.06
488 caResult = CA_NOT_ACCEPTABLE;
490 case OC_EH_INTERNAL_SERVER_ERROR: // 5.00
491 caResult = CA_INTERNAL_SERVER_ERROR;
493 case OC_EH_NOT_IMPLEMENTED: // 5.01
494 caResult = CA_NOT_IMPLEMENTED;
496 case OC_EH_BAD_GATEWAY: // 5.02
497 caResult = CA_BAD_GATEWAY;
499 case OC_EH_SERVICE_UNAVAILABLE: // 5.03
500 caResult = CA_SERVICE_UNAVAILABLE;
502 case OC_EH_RETRANSMIT_TIMEOUT: // 5.04
503 caResult = CA_RETRANSMIT_TIMEOUT;
505 case OC_EH_PROXY_NOT_SUPPORTED: // 5.05
506 caResult = CA_PROXY_NOT_SUPPORTED;
509 caResult = CA_BAD_REQ;
517 * Handler function for sending a response from a single resource
519 * @param ehResponse - pointer to the response from the resource
524 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
526 OCStackResult result = OC_STACK_ERROR;
527 CAEndpoint_t responseEndpoint = {.adapter = CA_DEFAULT_ADAPTER};
528 CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
529 CAHeaderOption_t* optionsPointer = NULL;
531 if(!ehResponse || !ehResponse->requestHandle)
533 OIC_LOG(ERROR, TAG, "ehResponse/requestHandle is NULL");
534 return OC_STACK_ERROR;
537 OCServerRequest *serverRequest = GetServerRequestUsingHandle(ehResponse->requestHandle);
538 if (NULL == serverRequest)
540 OIC_LOG(ERROR, TAG, "No serverRequest matching with ehResponse");
541 return OC_STACK_ERROR;
544 CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
546 responseInfo.info.messageId = serverRequest->coapID;
547 responseInfo.info.resourceUri = serverRequest->resourceUrl;
548 responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult, serverRequest->method);
549 responseInfo.info.dataType = CA_RESPONSE_DATA;
551 if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
553 responseInfo.info.type = CA_MSG_CONFIRM;
555 else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
557 responseInfo.info.type = CA_MSG_NONCONFIRM;
559 else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
560 serverRequest->qos == OC_HIGH_QOS)
562 responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
564 else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
565 serverRequest->qos == OC_HIGH_QOS)
567 // To assign new messageId in CA.
568 responseInfo.info.messageId = 0;
569 responseInfo.info.type = CA_MSG_CONFIRM;
571 else if(!serverRequest->notificationFlag)
573 responseInfo.info.type = CA_MSG_NONCONFIRM;
577 OIC_LOG(ERROR, TAG, "default responseInfo type is NON");
578 responseInfo.info.type = CA_MSG_NONCONFIRM;
581 char rspToken[CA_MAX_TOKEN_LEN + 1] = {0};
582 responseInfo.info.messageId = serverRequest->coapID;
583 responseInfo.info.token = (CAToken_t)rspToken;
585 memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
586 responseInfo.info.tokenLength = serverRequest->tokenLength;
588 if((serverRequest->observeResult == OC_STACK_OK)&&
589 (serverRequest->observationOption != MAX_SEQUENCE_NUMBER + 1))
591 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
595 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
598 if(responseInfo.info.numOptions > 0)
600 responseInfo.info.options = (CAHeaderOption_t *)
601 OICCalloc(responseInfo.info.numOptions,
602 sizeof(CAHeaderOption_t));
604 if(!responseInfo.info.options)
606 OIC_LOG(FATAL, TAG, "Memory alloc for options failed");
607 return OC_STACK_NO_MEMORY;
610 optionsPointer = responseInfo.info.options;
612 // TODO: This exposes CoAP specific details. At some point, this should be
613 // re-factored and handled in the CA layer.
614 if(serverRequest->observeResult == OC_STACK_OK)
616 responseInfo.info.options[0].protocolID = CA_COAP_ID;
617 responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
618 responseInfo.info.options[0].optionLength = sizeof(uint32_t);
619 uint8_t* observationData = (uint8_t*)responseInfo.info.options[0].optionData;
620 uint32_t observationOption= serverRequest->observationOption;
622 for (size_t i=sizeof(uint32_t); i; --i)
624 observationData[i-1] = observationOption & 0xFF;
625 observationOption >>=8;
628 // Point to the next header option before copying vender specific header options
632 if (ehResponse->numSendVendorSpecificHeaderOptions)
634 memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
635 sizeof(OCHeaderOption) *
636 ehResponse->numSendVendorSpecificHeaderOptions);
641 responseInfo.info.options = NULL;
644 responseInfo.isMulticast = false;
645 responseInfo.info.payload = NULL;
646 responseInfo.info.payloadSize = 0;
647 responseInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
649 // Put the JSON prefix and suffix around the payload
650 if(ehResponse->payload)
653 if (ehResponse->payload->type == PAYLOAD_TYPE_PRESENCE)
655 responseInfo.isMulticast = true;
660 responseInfo.isMulticast = false;
663 switch(serverRequest->acceptFormat)
665 case OC_FORMAT_UNDEFINED:
666 // No preference set by the client, so default to CBOR then
668 if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
669 &responseInfo.info.payloadSize))
672 OIC_LOG(ERROR, TAG, "Error converting payload");
673 OICFree(responseInfo.info.options);
676 // Add CONTENT_FORMAT OPT if payload exist
677 if (responseInfo.info.payloadSize > 0)
679 responseInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
683 responseInfo.result = CA_NOT_ACCEPTABLE;
688 CATransportAdapter_t CAConnTypes[] = {
690 CA_ADAPTER_GATT_BTLE,
691 CA_ADAPTER_RFCOMM_BTEDR,
694 , CA_ADAPTER_REMOTE_ACCESS
699 size_t size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
701 CATransportAdapter_t adapter = responseEndpoint.adapter;
702 // Default adapter, try to send response out on all adapters.
703 if (adapter == CA_DEFAULT_ADAPTER)
706 (CATransportAdapter_t)(
708 CA_ADAPTER_GATT_BTLE |
709 CA_ADAPTER_RFCOMM_BTEDR |
712 | CA_ADAPTER_REMOTE_ACCESS
718 result = OC_STACK_OK;
719 OCStackResult tempResult = OC_STACK_OK;
721 for(size_t i = 0; i < size; i++ )
723 responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
724 if(responseEndpoint.adapter)
726 //The result is set to OC_STACK_OK only if OCSendResponse succeeds in sending the
727 //response on all the n/w interfaces else it is set to OC_STACK_ERROR
728 tempResult = OCSendResponse(&responseEndpoint, &responseInfo);
730 if(OC_STACK_OK != tempResult)
737 OIC_LOG(INFO, TAG, "Calling OCSendResponse with:");
738 OIC_LOG_V(INFO, TAG, "\tEndpoint address: %s", responseEndpoint.addr);
739 OIC_LOG_V(INFO, TAG, "\tEndpoint adapter: %s", responseEndpoint.adapter);
740 OIC_LOG_V(INFO, TAG, "\tResponse result : %s", responseInfo.result);
741 OIC_LOG_V(INFO, TAG, "\tResponse for uri: %s", responseInfo.info.resourceUri);
743 result = OCSendResponse(&responseEndpoint, &responseInfo);
746 OICFree(responseInfo.info.payload);
747 OICFree(responseInfo.info.options);
749 FindAndDeleteServerRequest(serverRequest);
754 * Handler function for sending a response from multiple resources, such as a collection.
755 * Aggregates responses from multiple resource until all responses are received then sends the
756 * concatenated response
758 * TODO: Need to add a timeout in case a (remote?) resource does not respond
760 * @param ehResponse - pointer to the response from the resource
765 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
767 if(!ehResponse || !ehResponse->payload)
769 OIC_LOG(ERROR, TAG, "HandleAggregateResponse invalid parameters");
770 return OC_STACK_INVALID_PARAM;
773 OIC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
775 OCServerRequest *serverRequest = GetServerRequestUsingHandle(ehResponse->requestHandle);
776 OCServerResponse *serverResponse = GetServerResponseUsingHandle(ehResponse->requestHandle);
778 OCStackResult stackRet = OC_STACK_ERROR;
783 OIC_LOG(INFO, TAG, "This is the first response fragment");
784 stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
785 if (OC_STACK_OK != stackRet)
787 OIC_LOG(ERROR, TAG, "Error adding server response");
790 VERIFY_NON_NULL(serverResponse);
793 if(ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
795 stackRet = OC_STACK_ERROR;
796 OIC_LOG(ERROR, TAG, "Error adding payload, as it was the incorrect type");
800 OCRepPayload *newPayload = OCRepPayloadBatchClone((OCRepPayload *)ehResponse->payload);
802 if(!serverResponse->payload)
804 serverResponse->payload = (OCPayload *)newPayload;
808 OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
809 (OCRepPayload*)newPayload);
812 (serverRequest->numResponses)--;
814 if(serverRequest->numResponses == 0)
816 OIC_LOG(INFO, TAG, "This is the last response fragment");
817 ehResponse->payload = serverResponse->payload;
818 ehResponse->ehResult = OC_EH_OK;
819 stackRet = HandleSingleResponse(ehResponse);
820 //Delete the request and response
821 FindAndDeleteServerRequest(serverRequest);
822 FindAndDeleteServerResponse(serverResponse);
826 OIC_LOG(INFO, TAG, "More response fragments to come");
827 stackRet = OC_STACK_OK;