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"
28 #include "cainterface.h"
34 #define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
36 #define TAG PCF("ocserverrequest")
38 static struct OCServerRequest * serverRequestList = NULL;
39 static struct OCServerResponse * serverResponseList = NULL;
41 //-------------------------------------------------------------------------------------------------
43 //-------------------------------------------------------------------------------------------------
46 * Add a server response to the server response list
48 * @param response initialized server response that is created by this function
49 * @param requestHandle - handle of the response
54 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
56 OCServerResponse * serverResponse = NULL;
58 serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
59 VERIFY_NON_NULL(serverResponse);
61 serverResponse->payload = (char *) OICCalloc(1, MAX_RESPONSE_LENGTH);
62 VERIFY_NON_NULL(serverResponse->payload);
64 serverResponse->remainingPayloadSize = MAX_RESPONSE_LENGTH;
65 serverResponse->requestHandle = requestHandle;
67 *response = serverResponse;
68 OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
69 LL_APPEND (serverResponseList, serverResponse);
75 OICFree(serverResponse);
76 serverResponse = NULL;
79 return OC_STACK_NO_MEMORY;
83 * Delete a server request from the server request list
85 * @param serverRequest - server request to delete
87 static void DeleteServerRequest(OCServerRequest * serverRequest)
91 LL_DELETE(serverRequestList, serverRequest);
92 OICFree(serverRequest->requestToken);
93 OICFree(serverRequest);
95 OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
100 * Delete a server response from the server response list
102 * @param serverResponse - server response to delete
104 static void DeleteServerResponse(OCServerResponse * serverResponse)
108 LL_DELETE(serverResponseList, serverResponse);
109 OICFree(serverResponse->payload);
110 OICFree(serverResponse);
111 OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
116 * Find a server response and delete it from the server response list
118 * @param serverResponse - server response to find and delete
120 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
122 OCServerResponse* tmp;
125 LL_FOREACH(serverResponseList, tmp)
127 if (serverResponse == tmp)
129 DeleteServerResponse(tmp);
136 //-------------------------------------------------------------------------------------------------
138 //-------------------------------------------------------------------------------------------------
141 * Get a server request from the server request list using the specified token.
143 * @param token - token of server request
144 * @param tokenLength - length of token
149 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
153 OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
157 OCServerRequest * out = NULL;
158 LL_FOREACH (serverRequestList, out)
160 OC_LOG(INFO, TAG,PCF("comparing tokens"));
161 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
162 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
163 if(memcmp(out->requestToken, token, tokenLength) == 0)
168 OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
173 * Get a server request from the server request list using the specified handle
175 * @param handle - handle of server request
179 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
181 OCServerRequest * out = NULL;
182 LL_FOREACH (serverRequestList, out)
189 OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
194 * Get a server response from the server response list using the specified handle
196 * @param handle - handle of server response
201 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
203 OCServerResponse * out = NULL;
204 LL_FOREACH (serverResponseList, out)
206 if(out->requestHandle == handle)
211 OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
216 * Add a server request to the server request list
218 * @param request - initialized server request that is created by this function
219 * @param coapID - ID of CoAP pdu
220 * @param delayedResNeeded - delayed response required 0=no 1=yes
221 * @param secured - secure endpoint 0=no 1=yes
222 * @param notificationFlag - //TODO: remove - does not appear to be used any longer
223 * @param method - RESTful method
224 * @param numRcvdVendorSpecificHeaderOptions - number of received vendor specific header options
225 * @param observationOption - value of observation option
226 * @param qos - request QOS
227 * @param query - request query
228 * @param rcvdVendorSpecificHeaderOptions - received vendor specific header options
229 * @param reqJSONPayload - request JSON payload
230 * @param requestToken - request token
231 * @param tokenLength - request token length
232 * @param resourceUrl - URL of resource
233 * @param reqTotalSize - total size of the request
234 * @param addressInfo - CA Address
235 * @param connectivityType - connection type
240 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
241 uint8_t delayedResNeeded, uint8_t secured, uint8_t notificationFlag, OCMethod method,
242 uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
243 OCQualityOfService qos, char * query,
244 OCHeaderOption * rcvdVendorSpecificHeaderOptions,
245 char * reqJSONPayload, CAToken_t requestToken,
247 char * resourceUrl, size_t reqTotalSize,
248 CAAddress_t *addressInfo, CATransportType_t connectivityType)
250 OCServerRequest * serverRequest = NULL;
252 //Note: OCServerRequest includes 1 byte for the JSON Payload. payloadSize is calculated
253 //as the required length of the string, so this will result in enough room for the
254 //null terminator as well.
255 serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
256 (reqTotalSize ? reqTotalSize : 1) - 1);
257 VERIFY_NON_NULL(serverRequest);
259 serverRequest->coapID = coapID;
260 serverRequest->delayedResNeeded = delayedResNeeded;
261 serverRequest->secured = secured;
262 serverRequest->notificationFlag = notificationFlag;
264 serverRequest->method = method;
265 serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
266 serverRequest->observationOption = observationOption;
267 serverRequest->observeResult = OC_STACK_ERROR;
268 serverRequest->qos = qos;
269 serverRequest->ehResponseHandler = HandleSingleResponse;
270 serverRequest->numResponses = 1;
274 strncpy((char*)serverRequest->query,
275 (const char*)query, sizeof(serverRequest->query) - 1);
278 if(rcvdVendorSpecificHeaderOptions)
280 memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
281 MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
283 if(reqJSONPayload && reqTotalSize)
285 // destination is at least 1 greater than the source, so a NULL always exists in the
287 strncpy((char*)serverRequest->reqJSONPayload,
288 (const char*)reqJSONPayload, reqTotalSize - 1);
290 serverRequest->requestComplete = 0;
293 // If tokenLength is zero, the return value depends on the
294 // particular library implementation (it may or may not be a null pointer).
297 serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
298 VERIFY_NON_NULL(serverRequest->requestToken);
299 memcpy(serverRequest->requestToken, requestToken, tokenLength);
303 serverRequest->tokenLength = tokenLength;
307 strncpy((char*)serverRequest->resourceUrl,
308 (const char*)resourceUrl, sizeof(serverRequest->resourceUrl) - 1);
313 serverRequest->addressInfo = *addressInfo;
315 serverRequest->connectivityType = connectivityType;
317 *request = serverRequest;
318 OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
319 LL_APPEND (serverRequestList, serverRequest);
325 OICFree(serverRequest);
326 serverRequest = NULL;
329 return OC_STACK_NO_MEMORY;
333 * Form the OCEntityHandlerRequest struct that is passed to a resource's entity handler
335 * @param entityHandlerRequest - pointer to the OCEntityHandlerRequest struct that is created
336 * @param request - request handle
337 * @param method - RESTful method
338 * @param resource - resource handle
339 * @param queryBuf - resource query of request
340 * @param bufReqPayload - JSON payload of request
341 * @param numVendorOptions - number of vendor options
342 * @param vendorOptions - vendor options
343 * @param observeAction - observe action flag
344 * @param observeID - observe ID
349 OCStackResult FormOCEntityHandlerRequest(
350 OCEntityHandlerRequest * entityHandlerRequest,
351 OCRequestHandle request,
353 OCResourceHandle resource,
355 char * bufReqPayload,
356 uint8_t numVendorOptions,
357 OCHeaderOption * vendorOptions,
358 OCObserveAction observeAction,
359 OCObservationId observeID)
361 if (entityHandlerRequest)
363 memset(entityHandlerRequest, 0, sizeof(OCEntityHandlerRequest));
364 entityHandlerRequest->requestHandle = request;
365 entityHandlerRequest->method = method;
366 entityHandlerRequest->resource = (OCResourceHandle) resource;
367 entityHandlerRequest->query = queryBuf;
368 entityHandlerRequest->reqJSONPayload = bufReqPayload;
369 entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
370 entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
372 entityHandlerRequest->obsInfo.action = observeAction;
373 entityHandlerRequest->obsInfo.obsId = observeID;
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)
403 CAResponseResult_t caResult = CA_BAD_REQ;
408 caResult = CA_SUCCESS;
411 caResult = CA_BAD_REQ;
413 case OC_EH_RESOURCE_CREATED:
414 caResult = CA_CREATED;
416 case OC_EH_RESOURCE_DELETED:
417 caResult = CA_DELETED;
420 caResult = CA_SUCCESS;
422 case OC_EH_FORBIDDEN:
423 caResult = CA_UNAUTHORIZED_REQ;
425 case OC_EH_RESOURCE_NOT_FOUND:
426 caResult = CA_NOT_FOUND;
429 caResult = CA_BAD_REQ;
437 * Handler function for sending a response from a single resource
439 * @param ehResponse - pointer to the response from the resource
445 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
447 OCStackResult result = OC_STACK_ERROR;
448 CARemoteEndpoint_t responseEndpoint = {};
449 CAResponseInfo_t responseInfo = {};
450 CAHeaderOption_t* optionsPointer = NULL;
452 OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
454 if(!ehResponse || !ehResponse->requestHandle)
456 return OC_STACK_ERROR;
459 if(ehResponse->payloadSize >= (MAX_RESPONSE_LENGTH))// - OC_JSON_PREFIX_LEN - OC_JSON_SUFFIX_LEN))
461 OC_LOG_V(ERROR, TAG, "Response payload size was too large. Max is %hu, payload size was %hu",
462 (MAX_RESPONSE_LENGTH - OC_JSON_PREFIX_LEN - OC_JSON_SUFFIX_LEN), ehResponse->payloadSize);
463 return OC_STACK_INVALID_PARAM;
466 OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
469 responseEndpoint.resourceUri = (CAURI_t) serverRequest->resourceUrl;
470 responseEndpoint.addressInfo = serverRequest->addressInfo;
471 responseEndpoint.transportType = serverRequest->connectivityType;
472 responseEndpoint.isSecured = serverRequest->secured;
474 responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult);
476 if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
478 responseInfo.info.type = CA_MSG_CONFIRM;
480 else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
482 responseInfo.info.type = CA_MSG_NONCONFIRM;
484 else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
485 serverRequest->qos == OC_HIGH_QOS)
487 responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
489 else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
490 serverRequest->qos == OC_HIGH_QOS)
492 responseInfo.info.type = CA_MSG_CONFIRM;
494 else if(!serverRequest->notificationFlag)
496 responseInfo.info.type = CA_MSG_NONCONFIRM;
499 responseInfo.info.messageId = serverRequest->coapID;
500 responseInfo.info.token = (CAToken_t)OICMalloc(CA_MAX_TOKEN_LEN+1);
501 if (!responseInfo.info.token)
503 OC_LOG(FATAL, TAG, "Response Info Token is NULL");
507 memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
508 responseInfo.info.tokenLength = serverRequest->tokenLength;
510 if(serverRequest->observeResult == OC_STACK_OK)
512 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
516 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
519 if(responseInfo.info.numOptions > 0)
521 responseInfo.info.options = (CAHeaderOption_t *)
522 OICCalloc(responseInfo.info.numOptions,
523 sizeof(CAHeaderOption_t));
525 if(!responseInfo.info.options)
527 OC_LOG(FATAL, TAG, PCF("options is NULL"));
528 OICFree(responseInfo.info.token);
529 return OC_STACK_NO_MEMORY;
532 optionsPointer = responseInfo.info.options;
534 // TODO: This exposes CoAP specific details. At some point, this should be
535 // re-factored and handled in the CA layer.
536 if(serverRequest->observeResult == OC_STACK_OK)
538 responseInfo.info.options[0].protocolID = CA_COAP_ID;
539 responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
540 responseInfo.info.options[0].optionLength = sizeof(uint32_t);
541 memcpy(responseInfo.info.options[0].optionData,
542 &(serverRequest->observationOption), sizeof(uint32_t));
544 // Point to the next header option before copying vender specific header options
548 if (ehResponse->numSendVendorSpecificHeaderOptions)
550 memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
551 sizeof(OCHeaderOption) *
552 ehResponse->numSendVendorSpecificHeaderOptions);
557 responseInfo.info.options = NULL;
560 char payload[MAX_RESPONSE_LENGTH + OC_JSON_PREFIX_LEN + OC_JSON_SUFFIX_LEN + 1] = {};
562 // Put the JSON prefix and suffix around the payload
563 strcpy(payload, (const char *)OC_JSON_PREFIX);
564 if(ehResponse->payloadSize)
566 strncat(payload, (const char *)ehResponse->payload,
567 ehResponse->payloadSize < MAX_RESPONSE_LENGTH ?
568 ehResponse->payloadSize : MAX_RESPONSE_LENGTH);
570 strcat(payload, (const char *)OC_JSON_SUFFIX);
571 responseInfo.info.payload = (CAPayload_t)payload;
574 //TODO: Add other connectivity types to CAConnTypes[] when enabled
575 CATransportType_t CAConnTypes[] = {CA_IPV4};
576 const char * connTypes[] = {"ip transport"};
577 int size = sizeof(CAConnTypes)/ sizeof(CATransportType_t);
578 CATransportType_t connType = responseEndpoint.transportType;
579 CAResult_t caResult = CA_STATUS_FAILED;
580 result = OC_STACK_OK;
582 //Sending response on all n/w interfaces
583 for(int i = 0; i < size; i++ )
585 responseEndpoint.transportType = (CATransportType_t)(connType & CAConnTypes[i]);
586 if(responseEndpoint.transportType)
588 //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
589 //response on all the n/w interfaces else it is set to OC_STACK_ERROR
590 caResult = CASendResponse(&responseEndpoint, &responseInfo);
591 if(caResult != CA_STATUS_OK)
593 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
594 result = CAResultToOCResult(caResult);
598 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
603 CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
604 if(caResult != CA_STATUS_OK)
606 OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
607 result = CAResultToOCResult(caResult);
611 result = OC_STACK_OK;
615 OICFree(responseInfo.info.token);
616 OICFree(responseInfo.info.options);
618 FindAndDeleteServerRequest(serverRequest);
623 * Handler function for sending a response from multiple resources, such as a collection.
624 * Aggregates responses from multiple resource until all responses are received then sends the
625 * concatenated response
627 * TODO: Need to add a timeout in case a (remote?) resource does not respond
629 * @param ehResponse - pointer to the response from the resource
634 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
636 OCStackResult stackRet = OC_STACK_ERROR;
637 OCServerRequest * serverRequest = NULL;
638 OCServerResponse * serverResponse = NULL;
639 uint16_t bufferNeeded = 0;
641 if(!ehResponse || !ehResponse->payload)
643 OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
644 return OC_STACK_INVALID_PARAM;
647 OC_LOG_V(INFO, TAG, "Inside HandleAggregateResponse: %s", ehResponse->payload);
649 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
650 serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
656 OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
657 stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
658 if (OC_STACK_OK != stackRet)
660 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
663 VERIFY_NON_NULL(serverResponse);
664 VERIFY_NON_NULL(serverResponse->payload);
667 // If there is more than 1 response, then we need to allow for a null-termination
668 // in the server response payload buffer AND the JSON response separator
669 bufferNeeded = ehResponse->payloadSize + 1;
670 if (serverRequest->numResponses > 1)
672 bufferNeeded += strlen(OC_JSON_SEPARATOR_STR);
674 if(serverResponse->remainingPayloadSize >= bufferNeeded)
676 OC_LOG(ERROR, TAG, PCF("There is room in response buffer"));
678 strncat((char *)serverResponse->payload,
679 (char *)ehResponse->payload,
680 serverResponse->remainingPayloadSize);
681 OC_LOG_V(INFO, TAG, "Current aggregated response ...%s", serverResponse->payload);
682 serverResponse->remainingPayloadSize -= strlen((char *)ehResponse->payload);
683 (serverRequest->numResponses)--;
684 if(serverRequest->numResponses == 0)
686 OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
687 ehResponse->payload = serverResponse->payload;
688 ehResponse->payloadSize = strlen((char *) serverResponse->payload) + 1;
689 stackRet = HandleSingleResponse(ehResponse);
690 //Delete the request and response
691 FindAndDeleteServerRequest(serverRequest);
692 FindAndDeleteServerResponse(serverResponse);
696 OC_LOG(INFO, TAG, PCF("More response fragments to come"));
697 strncat((char *)serverResponse->payload,
698 OC_JSON_SEPARATOR_STR,
699 serverResponse->remainingPayloadSize);
700 OC_LOG_V(INFO, TAG, "Current aggregated response ...%s", serverResponse->payload);
701 serverResponse->remainingPayloadSize -= strlen(OC_JSON_SEPARATOR_STR);
702 stackRet = OC_STACK_OK;
707 OC_LOG(ERROR, TAG, PCF("No room in response buffer"));
708 //Delete the request and response
709 FindAndDeleteServerRequest(serverRequest);
710 FindAndDeleteServerResponse(serverResponse);
711 stackRet = OC_STACK_NO_MEMORY;