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 #include "cainterface.h"
37 #define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
39 #define TAG "ocserverrequest"
41 static struct OCServerRequest * serverRequestList = NULL;
42 static struct OCServerResponse * serverResponseList = NULL;
44 //-------------------------------------------------------------------------------------------------
46 //-------------------------------------------------------------------------------------------------
49 * Add a server response to the server response list
51 * @param response initialized server response that is created by this function
52 * @param requestHandle - handle of the response
57 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
61 return OC_STACK_INVALID_PARAM;
64 OCServerResponse * serverResponse = NULL;
66 serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
67 VERIFY_NON_NULL(serverResponse);
69 serverResponse->payload = NULL;
71 serverResponse->requestHandle = requestHandle;
73 *response = serverResponse;
74 OC_LOG(INFO, TAG, "Server Response Added!!");
75 LL_APPEND (serverResponseList, serverResponse);
81 OICFree(serverResponse);
82 serverResponse = NULL;
85 return OC_STACK_NO_MEMORY;
89 * Delete a server request from the server request list
91 * @param serverRequest - server request to delete
93 static void DeleteServerRequest(OCServerRequest * serverRequest)
97 LL_DELETE(serverRequestList, serverRequest);
98 OICFree(serverRequest->requestToken);
99 OICFree(serverRequest);
100 serverRequest = NULL;
101 OC_LOG(INFO, TAG, "Server Request Removed!!");
106 * Delete a server response from the server response list
108 * @param serverResponse - server response to delete
110 static void DeleteServerResponse(OCServerResponse * serverResponse)
114 LL_DELETE(serverResponseList, serverResponse);
115 OICFree(serverResponse->payload);
116 OICFree(serverResponse);
117 OC_LOG(INFO, TAG, "Server Response Removed!!");
122 * Find a server response and delete it from the server response list
124 * @param serverResponse - server response to find and delete
126 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
128 OCServerResponse* tmp;
131 LL_FOREACH(serverResponseList, tmp)
133 if (serverResponse == tmp)
135 DeleteServerResponse(tmp);
143 * Ensure no accept header option is included when sending responses
145 * @param object CA remote endpoint.
146 * @param requestInfo CA request info.
148 * @return ::OC_STACK_OK on success, some other value upon failure.
150 static OCStackResult OCSendResponse(const CAEndpoint_t *object, CAResponseInfo_t *responseInfo)
152 // Do not include the accept header option
153 responseInfo->info.acceptFormat = CA_FORMAT_UNDEFINED;
154 CAResult_t result = CASendResponse(object, responseInfo);
155 if(CA_STATUS_OK != result)
157 OC_LOG_V(ERROR, TAG, "CASendResponse failed with CA error %u", result);
158 return CAResultToOCResult(result);
163 //-------------------------------------------------------------------------------------------------
165 //-------------------------------------------------------------------------------------------------
168 * Get a server request from the server request list using the specified token.
170 * @param token - token of server request
171 * @param tokenLength - length of token
176 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
180 OC_LOG(ERROR, TAG, "Invalid Parameter Token");
184 OCServerRequest * out = NULL;
185 OC_LOG(INFO, TAG,"Get server request with token");
186 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
188 OC_LOG(INFO, TAG,"Found token");
189 LL_FOREACH (serverRequestList, out)
191 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
192 if(memcmp(out->requestToken, token, tokenLength) == 0)
197 OC_LOG(ERROR, TAG, "Server Request not found!!");
202 * Get a server request from the server request list using the specified handle
204 * @param handle - handle of server request
208 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
210 OCServerRequest * out = NULL;
211 LL_FOREACH (serverRequestList, out)
218 OC_LOG(ERROR, TAG, "Server Request not found!!");
223 * Get a server response from the server response list using the specified handle
225 * @param handle - handle of server response
230 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
232 OCServerResponse * out = NULL;
233 LL_FOREACH (serverResponseList, out)
235 if(out->requestHandle == handle)
240 OC_LOG(ERROR, TAG, "Server Response not found!!");
244 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
245 uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
246 uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
247 OCQualityOfService qos, char * query,
248 OCHeaderOption * rcvdVendorSpecificHeaderOptions,
249 uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
250 char * resourceUrl, size_t reqTotalSize, OCPayloadFormat acceptFormat,
251 const OCDevAddr *devAddr)
255 return OC_STACK_INVALID_PARAM;
258 OCServerRequest * serverRequest = NULL;
260 serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
261 (reqTotalSize ? reqTotalSize : 1) - 1);
262 VERIFY_NON_NULL(devAddr);
263 VERIFY_NON_NULL(serverRequest);
265 serverRequest->coapID = coapID;
266 serverRequest->delayedResNeeded = delayedResNeeded;
267 serverRequest->notificationFlag = notificationFlag;
269 serverRequest->method = method;
270 serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
271 serverRequest->observationOption = observationOption;
272 serverRequest->observeResult = OC_STACK_ERROR;
273 serverRequest->qos = qos;
274 serverRequest->acceptFormat = acceptFormat;
275 serverRequest->ehResponseHandler = HandleSingleResponse;
276 serverRequest->numResponses = 1;
280 OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
283 if(rcvdVendorSpecificHeaderOptions)
285 memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
286 MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
288 if(payload && reqTotalSize)
290 // destination is at least 1 greater than the source, so a NULL always exists in the
292 memcpy(serverRequest->payload, payload, reqTotalSize);
293 serverRequest->payloadSize = reqTotalSize;
296 serverRequest->requestComplete = 0;
299 // If tokenLength is zero, the return value depends on the
300 // particular library implementation (it may or may not be a null pointer).
303 serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
304 VERIFY_NON_NULL(serverRequest->requestToken);
305 memcpy(serverRequest->requestToken, requestToken, tokenLength);
309 serverRequest->tokenLength = tokenLength;
313 OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
317 serverRequest->devAddr = *devAddr;
319 *request = serverRequest;
320 OC_LOG(INFO, TAG, "Server Request Added!!");
321 LL_APPEND (serverRequestList, serverRequest);
327 OICFree(serverRequest);
328 serverRequest = NULL;
331 return OC_STACK_NO_MEMORY;
334 OCStackResult FormOCEntityHandlerRequest(
335 OCEntityHandlerRequest * entityHandlerRequest,
336 OCRequestHandle request,
339 OCResourceHandle resource,
343 uint8_t numVendorOptions,
344 OCHeaderOption * vendorOptions,
345 OCObserveAction observeAction,
346 OCObservationId observeID)
348 if (entityHandlerRequest)
350 entityHandlerRequest->resource = (OCResourceHandle) resource;
351 entityHandlerRequest->requestHandle = request;
352 entityHandlerRequest->method = method;
353 entityHandlerRequest->devAddr = *endpoint;
354 entityHandlerRequest->query = queryBuf;
355 entityHandlerRequest->obsInfo.action = observeAction;
356 entityHandlerRequest->obsInfo.obsId = observeID;
358 if(payload && payloadSize)
360 if(OCParsePayload(&entityHandlerRequest->payload, PAYLOAD_TYPE_REPRESENTATION,
361 payload, payloadSize) != OC_STACK_OK)
363 return OC_STACK_ERROR;
368 entityHandlerRequest->payload = NULL;
371 entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
372 entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
377 return OC_STACK_INVALID_PARAM;
381 * Find a server request in the server request list and delete
383 * @param serverRequest - server request to find and delete
385 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
387 OCServerRequest* tmp;
390 LL_FOREACH(serverRequestList, tmp)
392 if (serverRequest == tmp)
394 DeleteServerRequest(tmp);
401 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result, OCMethod method)
403 CAResponseResult_t caResult;
412 // This Response Code is like HTTP 204 "No Content" but only used in
413 // response to POST and PUT requests.
414 caResult = CA_CHANGED;
417 // This Response Code is like HTTP 200 "OK" but only used in response to
419 caResult = CA_CONTENT;
422 // This should not happen but,
423 // give it a value just in case but output an error
424 caResult = CA_CONTENT;
425 OC_LOG_V(ERROR, TAG, "Unexpected OC_EH_OK return code for method [d].", method);
429 caResult = CA_BAD_REQ;
431 case OC_EH_RESOURCE_CREATED:
432 caResult = CA_CREATED;
434 case OC_EH_RESOURCE_DELETED:
435 caResult = CA_DELETED;
438 caResult = CA_CONTENT;
440 case OC_EH_FORBIDDEN:
441 caResult = CA_UNAUTHORIZED_REQ;
443 case OC_EH_RESOURCE_NOT_FOUND:
444 caResult = CA_NOT_FOUND;
447 caResult = CA_BAD_REQ;
455 * Handler function for sending a response from a single resource
457 * @param ehResponse - pointer to the response from the resource
463 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
465 OCStackResult result = OC_STACK_ERROR;
466 CAEndpoint_t responseEndpoint = {.adapter = CA_DEFAULT_ADAPTER};
467 CAResponseInfo_t responseInfo = {.result = CA_EMPTY};
468 CAHeaderOption_t* optionsPointer = NULL;
470 if(!ehResponse || !ehResponse->requestHandle)
472 return OC_STACK_ERROR;
475 OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
477 CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
479 responseInfo.info.resourceUri = serverRequest->resourceUrl;
480 responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult, serverRequest->method);
482 if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
484 responseInfo.info.type = CA_MSG_CONFIRM;
486 else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
488 responseInfo.info.type = CA_MSG_NONCONFIRM;
490 else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
491 serverRequest->qos == OC_HIGH_QOS)
493 responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
495 else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
496 serverRequest->qos == OC_HIGH_QOS)
498 responseInfo.info.type = CA_MSG_CONFIRM;
500 else if(!serverRequest->notificationFlag)
502 responseInfo.info.type = CA_MSG_NONCONFIRM;
506 OC_LOG(ERROR, TAG, "default responseInfo type is NON");
507 responseInfo.info.type = CA_MSG_NONCONFIRM;
510 char rspToken[CA_MAX_TOKEN_LEN + 1] = {};
511 responseInfo.info.messageId = serverRequest->coapID;
512 responseInfo.info.token = (CAToken_t)rspToken;
514 memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
515 responseInfo.info.tokenLength = serverRequest->tokenLength;
517 if(serverRequest->observeResult == OC_STACK_OK)
519 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
523 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
526 if(responseInfo.info.numOptions > 0)
528 responseInfo.info.options = (CAHeaderOption_t *)
529 OICCalloc(responseInfo.info.numOptions,
530 sizeof(CAHeaderOption_t));
532 if(!responseInfo.info.options)
534 OC_LOG(FATAL, TAG, "Memory alloc for options failed");
535 return OC_STACK_NO_MEMORY;
538 optionsPointer = responseInfo.info.options;
540 // TODO: This exposes CoAP specific details. At some point, this should be
541 // re-factored and handled in the CA layer.
542 if(serverRequest->observeResult == OC_STACK_OK)
544 responseInfo.info.options[0].protocolID = CA_COAP_ID;
545 responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
546 responseInfo.info.options[0].optionLength = sizeof(uint32_t);
547 uint8_t* observationData = (uint8_t*)responseInfo.info.options[0].optionData;
548 uint32_t observationOption= serverRequest->observationOption;
550 for (size_t i=sizeof(uint32_t); i; --i)
552 observationData[i-1] = observationOption & 0xFF;
553 observationOption >>=8;
556 // Point to the next header option before copying vender specific header options
560 if (ehResponse->numSendVendorSpecificHeaderOptions)
562 memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
563 sizeof(OCHeaderOption) *
564 ehResponse->numSendVendorSpecificHeaderOptions);
569 responseInfo.info.options = NULL;
572 responseInfo.isMulticast = false;
573 responseInfo.info.payload = NULL;
574 responseInfo.info.payloadSize = 0;
575 responseInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
577 // Put the JSON prefix and suffix around the payload
578 if(ehResponse->payload)
580 if (ehResponse->payload->type == PAYLOAD_TYPE_PRESENCE)
582 responseInfo.isMulticast = true;
586 responseInfo.isMulticast = false;
589 switch(serverRequest->acceptFormat)
591 case OC_FORMAT_UNDEFINED:
592 // No preference set by the client, so default to CBOR then
594 if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
595 &responseInfo.info.payloadSize))
598 OC_LOG(ERROR, TAG, "Error converting payload");
599 OICFree(responseInfo.info.options);
602 responseInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
605 responseInfo.result = CA_NOT_ACCEPTABLE;
610 CATransportAdapter_t CAConnTypes[] = {
612 CA_ADAPTER_GATT_BTLE,
613 CA_ADAPTER_RFCOMM_BTEDR
616 , CA_ADAPTER_REMOTE_ACCESS
624 size_t size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
626 CATransportAdapter_t adapter = responseEndpoint.adapter;
627 // Default adapter, try to send response out on all adapters.
628 if (adapter == CA_DEFAULT_ADAPTER)
631 (CATransportAdapter_t)(
633 CA_ADAPTER_GATT_BTLE |
634 CA_ADAPTER_RFCOMM_BTEDR
637 | CA_ADAPTER_REMOTE_ACCESS
646 result = OC_STACK_OK;
647 OCStackResult tempResult = OC_STACK_OK;
649 for(size_t i = 0; i < size; i++ )
651 responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
652 if(responseEndpoint.adapter)
654 //The result is set to OC_STACK_OK only if OCSendResponse succeeds in sending the
655 //response on all the n/w interfaces else it is set to OC_STACK_ERROR
656 tempResult = OCSendResponse(&responseEndpoint, &responseInfo);
658 if(OC_STACK_OK != tempResult)
665 OC_LOG(INFO, TAG, "Calling OCSendResponse with:");
666 OC_LOG_V(INFO, TAG, "\tEndpoint address: %s", responseEndpoint.addr);
667 OC_LOG_V(INFO, TAG, "\tEndpoint adapter: %s", responseEndpoint.adapter);
668 OC_LOG_V(INFO, TAG, "\tResponse result : %s", responseInfo.result);
669 OC_LOG_V(INFO, TAG, "\tResponse for uri: %s", responseInfo.info.resourceUri);
671 result = OCSendResponse(&responseEndpoint, &responseInfo);
674 OICFree(responseInfo.info.payload);
675 OICFree(responseInfo.info.options);
677 FindAndDeleteServerRequest(serverRequest);
682 * Handler function for sending a response from multiple resources, such as a collection.
683 * Aggregates responses from multiple resource until all responses are received then sends the
684 * concatenated response
686 * TODO: Need to add a timeout in case a (remote?) resource does not respond
688 * @param ehResponse - pointer to the response from the resource
693 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
695 if(!ehResponse || !ehResponse->payload)
697 OC_LOG(ERROR, TAG, "HandleAggregateResponse invalid parameters");
698 return OC_STACK_INVALID_PARAM;
701 OC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
703 OCServerRequest *serverRequest = GetServerRequestUsingHandle((OCServerRequest *)
704 ehResponse->requestHandle);
705 OCServerResponse *serverResponse = GetServerResponseUsingHandle((OCServerRequest *)
706 ehResponse->requestHandle);
708 OCStackResult stackRet = OC_STACK_ERROR;
713 OC_LOG(INFO, TAG, "This is the first response fragment");
714 stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
715 if (OC_STACK_OK != stackRet)
717 OC_LOG(ERROR, TAG, "Error adding server response");
720 VERIFY_NON_NULL(serverResponse);
723 if(ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
725 stackRet = OC_STACK_ERROR;
726 OC_LOG(ERROR, TAG, "Error adding payload, as it was the incorrect type");
730 if(!serverResponse->payload)
732 serverResponse->payload = ehResponse->payload;
736 OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
737 (OCRepPayload*)ehResponse->payload);
741 (serverRequest->numResponses)--;
743 if(serverRequest->numResponses == 0)
745 OC_LOG(INFO, TAG, "This is the last response fragment");
746 ehResponse->payload = serverResponse->payload;
747 stackRet = HandleSingleResponse(ehResponse);
748 //Delete the request and response
749 FindAndDeleteServerRequest(serverRequest);
750 FindAndDeleteServerResponse(serverResponse);
754 OC_LOG(INFO, TAG, "More response fragments to come");
755 stackRet = OC_STACK_OK;