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"
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 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token)
45 OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
49 OCServerRequest * out = NULL;
50 LL_FOREACH (serverRequestList, out)
52 OC_LOG(INFO, TAG,PCF("comparing tokens"));
53 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, CA_MAX_TOKEN_LEN);
54 OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, CA_MAX_TOKEN_LEN);
55 if(memcmp(out->requestToken, token, CA_MAX_TOKEN_LEN) == 0)
60 OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
64 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
66 OCServerRequest * out = NULL;
67 LL_FOREACH (serverRequestList, out)
74 OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
78 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
80 OCServerResponse * out = NULL;
81 LL_FOREACH (serverResponseList, out)
83 if(out->requestHandle == handle)
88 OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
92 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
93 uint8_t delayedResNeeded, uint8_t secured, uint8_t notificationFlag, OCMethod method,
94 uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
95 OCQualityOfService qos, char * query,
96 OCHeaderOption * rcvdVendorSpecificHeaderOptions,
97 char * reqJSONPayload, CAToken_t * requestToken,
98 char * resourceUrl, size_t reqTotalSize,
99 CAAddress_t *addressInfo, CAConnectivityType_t connectivityType)
101 OCServerRequest * serverRequest = NULL;
103 //Note: OCServerRequest includes 1 byte for the JSON Payload. payloadSize is calculated
104 //as the required length of the string, so this will result in enough room for the
105 //null terminator as well.
106 serverRequest = (OCServerRequest *) OCCalloc(1, sizeof(OCServerRequest) + reqTotalSize - 1);
107 VERIFY_NON_NULL(serverRequest);
109 serverRequest->coapID = coapID;
110 serverRequest->delayedResNeeded = delayedResNeeded;
111 serverRequest->secured = secured;
112 serverRequest->notificationFlag = notificationFlag;
114 serverRequest->method = method;
115 serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
116 serverRequest->observationOption = observationOption;
117 serverRequest->observeResult = OC_STACK_ERROR;
118 serverRequest->qos = qos;
119 serverRequest->ehResponseHandler = HandleSingleResponse;
120 serverRequest->numResponses = 1;
124 strncpy((char*)serverRequest->query,
125 (const char*)query, sizeof(serverRequest->query) - 1);
128 if(rcvdVendorSpecificHeaderOptions)
130 memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
131 MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
135 // destination is at least 1 greater than the source, so a NULL always exists in the
137 strncpy((char*)serverRequest->reqJSONPayload,
138 (const char*)reqJSONPayload, reqTotalSize - 1);
140 serverRequest->requestComplete = 0;
143 serverRequest->requestToken = (CAToken_t)OCMalloc(CA_MAX_TOKEN_LEN+1);
144 VERIFY_NON_NULL (serverRequest->requestToken);
145 memcpy(serverRequest->requestToken, *requestToken, CA_MAX_TOKEN_LEN);
146 serverRequest->requestToken[CA_MAX_TOKEN_LEN]='\0';
151 strncpy((char*)serverRequest->resourceUrl,
152 (const char*)resourceUrl, sizeof(serverRequest->resourceUrl) - 1);
157 serverRequest->addressInfo = *addressInfo;
159 serverRequest->connectivityType = connectivityType;
161 *request = serverRequest;
162 OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
163 LL_APPEND (serverRequestList, serverRequest);
169 OCFree(serverRequest);
170 serverRequest = NULL;
173 return OC_STACK_NO_MEMORY;
176 OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
178 OCServerResponse * serverResponse = NULL;
180 serverResponse = (OCServerResponse *) OCCalloc(1, sizeof(OCServerResponse));
181 VERIFY_NON_NULL(serverResponse);
183 serverResponse->payload = (char *) OCCalloc(1, MAX_RESPONSE_LENGTH);
184 VERIFY_NON_NULL(serverResponse->payload);
186 serverResponse->remainingPayloadSize = MAX_RESPONSE_LENGTH;
187 serverResponse->requestHandle = requestHandle;
189 *response = serverResponse;
190 OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
191 LL_APPEND (serverResponseList, serverResponse);
197 OCFree(serverResponse);
198 serverResponse = NULL;
201 return OC_STACK_NO_MEMORY;
204 // Form the OCEntityHandlerRequest struct
205 OCStackResult FormOCEntityHandlerRequest(
206 OCEntityHandlerRequest * entityHandlerRequest,
207 OCRequestHandle request,
209 OCResourceHandle resource,
211 char * bufReqPayload,
212 uint8_t numVendorOptions,
213 OCHeaderOption * vendorOptions,
214 OCObserveAction observeAction,
215 OCObservationId observeID)
217 if (entityHandlerRequest)
219 memset(entityHandlerRequest, 0, sizeof(OCEntityHandlerRequest));
220 entityHandlerRequest->requestHandle = request;
221 entityHandlerRequest->method = method;
222 entityHandlerRequest->resource = (OCResourceHandle) resource;
223 entityHandlerRequest->query = queryBuf;
224 entityHandlerRequest->reqJSONPayload = bufReqPayload;
225 entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
226 entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
228 entityHandlerRequest->obsInfo.action = observeAction;
229 entityHandlerRequest->obsInfo.obsId = observeID;
233 return OC_STACK_INVALID_PARAM;
236 void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
238 OCServerResponse* tmp;
241 LL_FOREACH(serverResponseList, tmp)
243 if (serverResponse == tmp)
245 DeleteServerResponse(tmp);
252 void DeleteServerResponse(OCServerResponse * serverResponse)
255 LL_DELETE(serverResponseList, serverResponse);
256 OCFree(serverResponse->payload);
257 OCFree(serverResponse);
258 OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
262 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
264 OCServerRequest* tmp;
267 LL_FOREACH(serverRequestList, tmp)
269 if (serverRequest == tmp)
271 DeleteServerRequest(tmp);
278 void DeleteServerRequest(OCServerRequest * serverRequest)
281 LL_DELETE(serverRequestList, serverRequest);
282 OCFree(serverRequest);
283 serverRequest = NULL;
284 OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
288 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
290 OCStackResult result = OC_STACK_ERROR;
291 CARemoteEndpoint_t responseEndpoint = {};
292 CAResponseInfo_t responseInfo = {};
293 CAHeaderOption_t* optionsPointer;
295 OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
297 OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
300 responseEndpoint.resourceUri = (CAURI_t) serverRequest->resourceUrl;
301 responseEndpoint.addressInfo = serverRequest->addressInfo;
302 responseEndpoint.connectivityType = serverRequest->connectivityType;
303 responseEndpoint.isSecured = serverRequest->secured;
306 switch (ehResponse->ehResult)
309 responseInfo.result = CA_SUCCESS;
312 responseInfo.result = CA_BAD_REQ;
314 case OC_EH_RESOURCE_CREATED:
315 responseInfo.result = CA_CREATED;
317 case OC_EH_RESOURCE_DELETED:
318 responseInfo.result = CA_DELETED;
321 responseInfo.result = CA_SUCCESS;
323 case OC_EH_FORBIDDEN:
324 responseInfo.result = CA_BAD_REQ;
327 responseInfo.result = CA_BAD_REQ;
331 switch (serverRequest->qos)
334 responseInfo.info.type = CA_MSG_NONCONFIRM;
337 responseInfo.info.type = CA_MSG_NONCONFIRM;
340 responseInfo.info.type = CA_MSG_CONFIRM;
343 responseInfo.info.type = CA_MSG_NONCONFIRM;
346 responseInfo.info.type = CA_MSG_NONCONFIRM;
350 responseInfo.info.token = (CAToken_t)OCCalloc(1, CA_MAX_TOKEN_LEN+1);
351 if (!responseInfo.info.token)
353 OC_LOG(FATAL, TAG, "Response Info Token is NULL");
356 memcpy(responseInfo.info.token, serverRequest->requestToken, CA_MAX_TOKEN_LEN);
358 if(serverRequest->observeResult == OC_STACK_OK)
360 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
364 responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
367 responseInfo.info.options = (CAHeaderOption_t *)
368 OCMalloc(sizeof(CAHeaderOption_t) * responseInfo.info.numOptions);
370 optionsPointer = responseInfo.info.options;
372 // TODO: This exposes CoAP specific details. At some point, this should be
373 // re-factored and handled in the CA layer.
374 if(serverRequest->observeResult == OC_STACK_OK)
376 responseInfo.info.options[0].protocolID = CA_COAP_ID;
377 responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
378 responseInfo.info.options[0].optionLength = sizeof(uint32_t);
379 memcpy(responseInfo.info.options[0].optionData,
380 &(serverRequest->observationOption), sizeof(uint32_t));
382 // Point to the next header option before copying vender specific header options
386 if (ehResponse->numSendVendorSpecificHeaderOptions)
388 memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
389 sizeof(OCHeaderOption) * ehResponse->numSendVendorSpecificHeaderOptions);
392 // Allocate memory for the payload.
393 char *payload = (char *)OCCalloc(1, MAX_RESPONSE_LENGTH);
396 return OC_STACK_NO_MEMORY;
399 // Put the JSON prefix and suffix around the payload
400 strcpy(payload, (const char *)OC_JSON_PREFIX);
401 strcat(payload, (const char *)ehResponse->payload);
402 strcat(payload, (const char *)OC_JSON_SUFFIX);
403 responseInfo.info.payload = (CAPayload_t)payload;
406 //TODO: Add other connectivity types to CAConnTypes[] when enabled
407 CAConnectivityType_t CAConnTypes[] = {CA_ETHERNET, CA_WIFI};
408 const char * connTypes[] = {"ethernet", "wifi"};
409 int size = sizeof(CAConnTypes)/ sizeof(CAConnectivityType_t);
410 CAConnectivityType_t connType = responseEndpoint.connectivityType;
411 CAResult_t caResult = CA_STATUS_FAILED;
412 result = OC_STACK_OK;
414 //Sending response on all n/w interfaces
415 for(int i = 0; i < size; i++ )
417 responseEndpoint.connectivityType = (CAConnectivityType_t)(connType & CAConnTypes[i]);
418 if(responseEndpoint.connectivityType)
420 //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
421 //response on all the n/w interfaces else it is set to OC_STACK_ERROR
422 caResult = CASendResponse(&responseEndpoint, &responseInfo);
423 if(caResult != CA_STATUS_OK)
425 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
426 result = OC_STACK_ERROR;
430 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
435 CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
436 if(caResult != CA_STATUS_OK)
438 OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
442 result = OC_STACK_OK;
448 FindAndDeleteServerRequest(serverRequest);
452 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
454 OCStackResult stackRet = OC_STACK_ERROR;
455 OCServerRequest * serverRequest = NULL;
456 OCServerResponse * serverResponse = NULL;
457 uint16_t bufferNeeded = 0;
459 if(!ehResponse || !ehResponse->payload)
461 OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
462 return OC_STACK_INVALID_PARAM;
465 OC_LOG_V(INFO, TAG, "Inside HandleAggregateResponse: %s", ehResponse->payload);
467 serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
468 serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
474 OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
475 stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
476 if (OC_STACK_OK != stackRet)
478 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
481 VERIFY_NON_NULL(serverResponse);
482 VERIFY_NON_NULL(serverResponse->payload);
485 // If there is more than 1 response, then we need to allow for a null-termination
486 // in the server response payload buffer AND the JSON response separator
487 bufferNeeded = ehResponse->payloadSize + 1;
488 if (serverRequest->numResponses > 1)
490 bufferNeeded += strlen(OC_JSON_SEPARATOR_STR);
492 if(serverResponse->remainingPayloadSize >= bufferNeeded)
494 OC_LOG(ERROR, TAG, PCF("There is room in response buffer"));
496 strncat((char *)serverResponse->payload,
497 (char *)ehResponse->payload,
498 serverResponse->remainingPayloadSize);
499 OC_LOG_V(INFO, TAG, "Current aggregated response ...%s", serverResponse->payload);
500 serverResponse->remainingPayloadSize -= strlen((char *)ehResponse->payload);
501 (serverRequest->numResponses)--;
502 if(serverRequest->numResponses == 0)
504 OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
505 ehResponse->payload = serverResponse->payload;
506 ehResponse->payloadSize = strlen((char *) serverResponse->payload) + 1;
507 stackRet = HandleSingleResponse(ehResponse);
508 //Delete the request and response
509 FindAndDeleteServerRequest(serverRequest);
510 FindAndDeleteServerResponse(serverResponse);
514 OC_LOG(INFO, TAG, PCF("More response fragments to come"));
515 strncat((char *)serverResponse->payload,
516 OC_JSON_SEPARATOR_STR,
517 serverResponse->remainingPayloadSize);
518 OC_LOG_V(INFO, TAG, "Current aggregated response ...%s", serverResponse->payload);
519 serverResponse->remainingPayloadSize -= strlen(OC_JSON_SEPARATOR_STR);
520 stackRet = OC_STACK_OK;
525 OC_LOG(ERROR, TAG, PCF("No room in response buffer"));
526 //Delete the request and response
527 FindAndDeleteServerRequest(serverRequest);
528 FindAndDeleteServerResponse(serverResponse);
529 stackRet = OC_STACK_NO_MEMORY;