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 PCF("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)
59 OCServerResponse * serverResponse = NULL;
61 serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
62 VERIFY_NON_NULL(serverResponse);
64 serverResponse->payload = NULL;
66 serverResponse->requestHandle = requestHandle;
68 *response = serverResponse;
69 OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
70 LL_APPEND (serverResponseList, serverResponse);
76 OICFree(serverResponse);
77 serverResponse = NULL;
80 return OC_STACK_NO_MEMORY;
84 * Delete a server request from the server request list
86 * @param serverRequest - server request to delete
88 static void DeleteServerRequest(OCServerRequest * serverRequest)
92 LL_DELETE(serverRequestList, serverRequest);
93 OICFree(serverRequest->requestToken);
94 OICFree(serverRequest);
96 OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
101 * Delete a server response from the server response list
103 * @param serverResponse - server response to delete
105 static void DeleteServerResponse(OCServerResponse * serverResponse)
109 LL_DELETE(serverResponseList, serverResponse);
110 OICFree(serverResponse->payload);
111 OICFree(serverResponse);
112 OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
117 * Find a server response and delete it from the server response list
119 * @param serverResponse - server response to find and delete
121 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
123 OCServerResponse* tmp;
126 LL_FOREACH(serverResponseList, tmp)
128 if (serverResponse == tmp)
130 DeleteServerResponse(tmp);
137 //-------------------------------------------------------------------------------------------------
139 //-------------------------------------------------------------------------------------------------
142 * Get a server request from the server request list using the specified token.
144 * @param token - token of server request
145 * @param tokenLength - length of token
150 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
154 OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
158 OCServerRequest * out = NULL;
159 LL_FOREACH (serverRequestList, out)
161 OC_LOG(INFO, TAG,PCF("comparing tokens"));
162 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
163 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
164 if(memcmp(out->requestToken, token, tokenLength) == 0)
169 OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
174 * Get a server request from the server request list using the specified handle
176 * @param handle - handle of server request
180 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
182 OCServerRequest * out = NULL;
183 LL_FOREACH (serverRequestList, out)
190 OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
195 * Get a server response from the server response list using the specified handle
197 * @param handle - handle of server response
202 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
204 OCServerResponse * out = NULL;
205 LL_FOREACH (serverResponseList, out)
207 if(out->requestHandle == handle)
212 OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
216 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
217 uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
218 uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
219 OCQualityOfService qos, char * query,
220 OCHeaderOption * rcvdVendorSpecificHeaderOptions,
221 uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
222 char * resourceUrl, size_t reqTotalSize, const OCDevAddr *devAddr)
224 OCServerRequest * serverRequest = NULL;
226 serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
227 (reqTotalSize ? reqTotalSize : 1) - 1);
228 VERIFY_NON_NULL(devAddr);
229 VERIFY_NON_NULL(serverRequest);
231 serverRequest->coapID = coapID;
232 serverRequest->delayedResNeeded = delayedResNeeded;
233 serverRequest->notificationFlag = notificationFlag;
235 serverRequest->method = method;
236 serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
237 serverRequest->observationOption = observationOption;
238 serverRequest->observeResult = OC_STACK_ERROR;
239 serverRequest->qos = qos;
240 serverRequest->ehResponseHandler = HandleSingleResponse;
241 serverRequest->numResponses = 1;
245 OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
248 if(rcvdVendorSpecificHeaderOptions)
250 memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
251 MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
253 if(payload && reqTotalSize)
255 // destination is at least 1 greater than the source, so a NULL always exists in the
257 memcpy(serverRequest->payload, payload, reqTotalSize);
258 serverRequest->payloadSize = reqTotalSize;
261 serverRequest->requestComplete = 0;
264 // If tokenLength is zero, the return value depends on the
265 // particular library implementation (it may or may not be a null pointer).
268 serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
269 VERIFY_NON_NULL(serverRequest->requestToken);
270 memcpy(serverRequest->requestToken, requestToken, tokenLength);
274 serverRequest->tokenLength = tokenLength;
278 OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
282 serverRequest->devAddr = *devAddr;
284 *request = serverRequest;
285 OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
286 LL_APPEND (serverRequestList, serverRequest);
292 OICFree(serverRequest);
293 serverRequest = NULL;
296 return OC_STACK_NO_MEMORY;
299 OCStackResult FormOCEntityHandlerRequest(
300 OCEntityHandlerRequest * entityHandlerRequest,
301 OCRequestHandle request,
303 OCResourceHandle resource,
307 uint8_t numVendorOptions,
308 OCHeaderOption * vendorOptions,
309 OCObserveAction observeAction,
310 OCObservationId observeID)
312 if (entityHandlerRequest)
314 entityHandlerRequest->resource = (OCResourceHandle) resource;
315 entityHandlerRequest->requestHandle = request;
316 entityHandlerRequest->method = method;
317 entityHandlerRequest->query = queryBuf;
318 entityHandlerRequest->obsInfo.action = observeAction;
319 entityHandlerRequest->obsInfo.obsId = observeID;
321 if(payload && payloadSize)
323 if(OCParsePayload(&entityHandlerRequest->payload, payload, payloadSize) != OC_STACK_OK)
325 return OC_STACK_ERROR;
330 entityHandlerRequest->payload = NULL;
333 entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
334 entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
339 return OC_STACK_INVALID_PARAM;
343 * Find a server request in the server request list and delete
345 * @param serverRequest - server request to find and delete
347 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
349 OCServerRequest* tmp;
352 LL_FOREACH(serverRequestList, tmp)
354 if (serverRequest == tmp)
356 DeleteServerRequest(tmp);
363 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result)
365 CAResponseResult_t caResult = CA_BAD_REQ;
370 caResult = CA_SUCCESS;
373 caResult = CA_BAD_REQ;
375 case OC_EH_RESOURCE_CREATED:
376 caResult = CA_CREATED;
378 case OC_EH_RESOURCE_DELETED:
379 caResult = CA_DELETED;
382 caResult = CA_SUCCESS;
384 case OC_EH_FORBIDDEN:
385 caResult = CA_UNAUTHORIZED_REQ;
387 case OC_EH_RESOURCE_NOT_FOUND:
388 caResult = CA_NOT_FOUND;
391 caResult = CA_BAD_REQ;
399 * Handler function for sending a response from a single resource
401 * @param ehResponse - pointer to the response from the resource
407 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
409 OCStackResult result = OC_STACK_ERROR;
410 CAEndpoint_t responseEndpoint = {};
411 CAResponseInfo_t responseInfo = {};
412 CAHeaderOption_t* optionsPointer = NULL;
414 if(!ehResponse || !ehResponse->requestHandle)
416 return OC_STACK_ERROR;
419 OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
421 CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
423 responseInfo.info.resourceUri = serverRequest->resourceUrl;
424 responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult);
426 if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
428 responseInfo.info.type = CA_MSG_CONFIRM;
430 else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
432 responseInfo.info.type = CA_MSG_NONCONFIRM;
434 else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
435 serverRequest->qos == OC_HIGH_QOS)
437 responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
439 else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
440 serverRequest->qos == OC_HIGH_QOS)
442 responseInfo.info.type = CA_MSG_CONFIRM;
444 else if(!serverRequest->notificationFlag)
446 responseInfo.info.type = CA_MSG_NONCONFIRM;
449 responseInfo.info.messageId = serverRequest->coapID;
450 responseInfo.info.token = (CAToken_t)OICMalloc(CA_MAX_TOKEN_LEN+1);
451 if (!responseInfo.info.token)
453 OC_LOG(FATAL, TAG, "Response Info Token is NULL");
457 memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
458 responseInfo.info.tokenLength = serverRequest->tokenLength;
460 if(serverRequest->observeResult == OC_STACK_OK)
462 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
466 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
469 if(responseInfo.info.numOptions > 0)
471 responseInfo.info.options = (CAHeaderOption_t *)
472 OICCalloc(responseInfo.info.numOptions,
473 sizeof(CAHeaderOption_t));
475 if(!responseInfo.info.options)
477 OC_LOG(FATAL, TAG, PCF("options is NULL"));
478 OICFree(responseInfo.info.token);
479 return OC_STACK_NO_MEMORY;
482 optionsPointer = responseInfo.info.options;
484 // TODO: This exposes CoAP specific details. At some point, this should be
485 // re-factored and handled in the CA layer.
486 if(serverRequest->observeResult == OC_STACK_OK)
488 responseInfo.info.options[0].protocolID = CA_COAP_ID;
489 responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
490 responseInfo.info.options[0].optionLength = sizeof(uint32_t);
491 memcpy(responseInfo.info.options[0].optionData,
492 &(serverRequest->observationOption), sizeof(uint32_t));
494 // Point to the next header option before copying vender specific header options
498 if (ehResponse->numSendVendorSpecificHeaderOptions)
500 memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
501 sizeof(OCHeaderOption) *
502 ehResponse->numSendVendorSpecificHeaderOptions);
507 responseInfo.info.options = NULL;
510 // Put the JSON prefix and suffix around the payload
511 if(ehResponse->payload)
513 OCStackResult result;
514 if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
515 &responseInfo.info.payloadSize))
518 OC_LOG(ERROR, TAG, "Error converting payload");
522 if(responseInfo.info.payloadSize > MAX_RESPONSE_LENGTH)
524 OICFree(responseInfo.info.payload);
525 OC_LOG(ERROR, TAG, "Payload too long!");
526 return OC_STACK_INVALID_PARAM;
531 responseInfo.info.payload = NULL;
532 responseInfo.info.payloadSize = 0;
536 //TODO: Add other connectivity types to CAConnTypes[] when enabled
537 CATransportAdapter_t CAConnTypes[] = {CA_ADAPTER_IP};
538 const char * connTypes[] = {"IP"};
539 int size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
540 CATransportAdapter_t adapter = responseEndpoint.adapter;
541 CAResult_t caResult = CA_STATUS_FAILED;
542 result = OC_STACK_OK;
544 // Default adapter, try to send response out on all adapters.
545 if (adapter == CA_DEFAULT_ADAPTER)
548 (CATransportAdapter_t)(CA_ADAPTER_IP | CA_ADAPTER_GATT_BTLE | CA_ADAPTER_RFCOMM_BTEDR);
551 for(int i = 0; i < size; i++ )
553 responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
554 if(responseEndpoint.adapter)
556 //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
557 //response on all the n/w interfaces else it is set to OC_STACK_ERROR
558 caResult = CASendResponse(&responseEndpoint, &responseInfo);
559 if(caResult != CA_STATUS_OK)
561 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
562 result = CAResultToOCResult(caResult);
566 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
571 CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
572 if(caResult != CA_STATUS_OK)
574 OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
575 result = CAResultToOCResult(caResult);
579 result = OC_STACK_OK;
583 OICFree(responseInfo.info.payload);
584 OICFree(responseInfo.info.token);
585 OICFree(responseInfo.info.options);
587 FindAndDeleteServerRequest(serverRequest);
592 * Handler function for sending a response from multiple resources, such as a collection.
593 * Aggregates responses from multiple resource until all responses are received then sends the
594 * concatenated response
596 * TODO: Need to add a timeout in case a (remote?) resource does not respond
598 * @param ehResponse - pointer to the response from the resource
603 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
605 OCStackResult stackRet = OC_STACK_ERROR;
606 OCServerRequest * serverRequest = NULL;
607 OCServerResponse * serverResponse = NULL;
609 if(!ehResponse || !ehResponse->payload)
611 OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
612 return OC_STACK_INVALID_PARAM;
615 OC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
617 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
618 serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
624 OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
625 stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
626 if (OC_STACK_OK != stackRet)
628 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
631 VERIFY_NON_NULL(serverResponse);
634 if(serverResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION ||
635 ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
637 stackRet = OC_STACK_ERROR;
638 OC_LOG(ERROR, TAG, PCF("Error adding payload, as it was the incorrect type"));
642 OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
643 (OCRepPayload*)ehResponse->payload);
645 (serverRequest->numResponses)--;
647 if(serverRequest->numResponses == 0)
649 OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
650 ehResponse->payload = serverResponse->payload;
651 stackRet = HandleSingleResponse(ehResponse);
652 //Delete the request and response
653 FindAndDeleteServerRequest(serverRequest);
654 FindAndDeleteServerResponse(serverResponse);
658 OC_LOG(INFO, TAG, PCF("More response fragments to come"));
659 stackRet = OC_STACK_OK;