Modifications based on RI comments.
[platform/upstream/iotivity.git] / resource / csdk / stack / src / ocserverrequest.c
1 //******************************************************************
2 //
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
4 //
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
6 //
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
10 //
11 //      http://www.apache.org/licenses/LICENSE-2.0
12 //
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.
18 //
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
20 #include <string.h>
21
22 #include "ocstack.h"
23 #include "ocserverrequest.h"
24 #include "ocresourcehandler.h"
25 #include "ocmalloc.h"
26
27 #include "cacommon.h"
28 #include "cainterface.h"
29
30 #include "utlist.h"
31 #include "pdu.h"
32
33 // Module Name
34 #define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
35
36 #define TAG  PCF("ocserverrequest")
37
38 static struct OCServerRequest * serverRequestList = NULL;
39 static struct OCServerResponse * serverResponseList = NULL;
40
41 //-------------------------------------------------------------------------------------------------
42 // Local functions
43 //-------------------------------------------------------------------------------------------------
44
45 /**
46  * Add a server response to the server response list
47  *
48  * @param response initialized server response that is created by this function
49  * @param requestHandle - handle of the response
50  *
51  * @return
52  *     OCStackResult
53  */
54 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
55 {
56     OCServerResponse * serverResponse = NULL;
57
58     serverResponse = (OCServerResponse *) OCCalloc(1, sizeof(OCServerResponse));
59     VERIFY_NON_NULL(serverResponse);
60
61     serverResponse->payload = (char *) OCCalloc(1, MAX_RESPONSE_LENGTH);
62     VERIFY_NON_NULL(serverResponse->payload);
63
64     serverResponse->remainingPayloadSize = MAX_RESPONSE_LENGTH;
65     serverResponse->requestHandle = requestHandle;
66
67     *response = serverResponse;
68     OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
69     LL_APPEND (serverResponseList, serverResponse);
70     return OC_STACK_OK;
71
72 exit:
73     if (serverResponse)
74     {
75         OCFree(serverResponse);
76         serverResponse = NULL;
77     }
78     *response = NULL;
79     return OC_STACK_NO_MEMORY;
80 }
81
82 /**
83  * Delete a server request from the server request list
84  *
85  * @param serverRequest - server request to delete
86  */
87 static void DeleteServerRequest(OCServerRequest * serverRequest)
88 {
89     if(serverRequest)
90     {
91         LL_DELETE(serverRequestList, serverRequest);
92         OCFree(serverRequest);
93         serverRequest = NULL;
94         OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
95     }
96 }
97
98 /**
99  * Delete a server response from the server response list
100  *
101  * @param serverResponse - server response to delete
102  */
103 static void DeleteServerResponse(OCServerResponse * serverResponse)
104 {
105     if(serverResponse)
106     {
107         LL_DELETE(serverResponseList, serverResponse);
108         OCFree(serverResponse->payload);
109         OCFree(serverResponse);
110         OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
111     }
112 }
113
114 /**
115  * Find a server response and delete it from the server response list
116  *
117  * @param serverResponse - server response to find and delete
118  */
119 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
120 {
121     OCServerResponse* tmp;
122     if(serverResponse)
123     {
124         LL_FOREACH(serverResponseList, tmp)
125         {
126             if (serverResponse == tmp)
127             {
128                 DeleteServerResponse(tmp);
129                 return;
130             }
131         }
132     }
133 }
134
135 //-------------------------------------------------------------------------------------------------
136 // Internal APIs
137 //-------------------------------------------------------------------------------------------------
138
139 /**
140  * Get a server request from the server request list using the specified token.
141  *
142  * @param token - token of server request
143  * @param tokenLength - length of token
144  *
145  * @return
146  *     OCServerRequest*
147  */
148 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
149 {
150     if(!token)
151     {
152         OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
153         return NULL;
154     }
155
156     OCServerRequest * out = NULL;
157     LL_FOREACH (serverRequestList, out)
158     {
159         OC_LOG(INFO, TAG,PCF("comparing tokens"));
160         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
161         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
162         if(memcmp(out->requestToken, token, tokenLength) == 0)
163         {
164             return out;
165         }
166     }
167     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
168     return NULL;
169 }
170
171 /**
172  * Get a server request from the server request list using the specified handle
173  *
174  * @param handle - handle of server request
175  * @return
176  *     OCServerRequest*
177  */
178 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
179 {
180     OCServerRequest * out = NULL;
181     LL_FOREACH (serverRequestList, out)
182     {
183         if(out == handle)
184         {
185             return out;
186         }
187     }
188     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
189     return NULL;
190 }
191
192 /**
193  * Get a server response from the server response list using the specified handle
194  *
195  * @param handle - handle of server response
196  *
197  * @return
198  *     OCServerResponse*
199  */
200 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
201 {
202     OCServerResponse * out = NULL;
203     LL_FOREACH (serverResponseList, out)
204     {
205         if(out->requestHandle == handle)
206         {
207             return out;
208         }
209     }
210     OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
211     return NULL;
212 }
213
214 /**
215  * Add a server request to the server request list
216  *
217  * @param request - initialized server request that is created by this function
218  * @param coapID - ID of CoAP pdu
219  * @param delayedResNeeded - delayed response required 0=no 1=yes
220  * @param secured - secure endpoint 0=no 1=yes
221  * @param notificationFlag - //TODO: remove - does not appear to be used any longer
222  * @param method - RESTful method
223  * @param numRcvdVendorSpecificHeaderOptions - number of received vendor specific header options
224  * @param observationOption - value of observation option
225  * @param qos - request QOS
226  * @param query - request query
227  * @param rcvdVendorSpecificHeaderOptions - received vendor specific header options
228  * @param reqJSONPayload - request JSON payload
229  * @param requestToken - request token
230  * @param tokenLength - request token length
231  * @param resourceUrl - URL of resource
232  * @param reqTotalSize - total size of the request
233  * @param addressInfo - CA Address
234  * @param connectivityType - connection type
235  *
236  * @return
237  *     OCStackResult
238  */
239 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
240         uint8_t delayedResNeeded, uint8_t secured, uint8_t notificationFlag, OCMethod method,
241         uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
242         OCQualityOfService qos, char * query,
243         OCHeaderOption * rcvdVendorSpecificHeaderOptions,
244         char * reqJSONPayload, CAToken_t * requestToken,
245         uint8_t tokenLength,
246         char * resourceUrl, size_t reqTotalSize,
247         CAAddress_t *addressInfo, CAConnectivityType_t connectivityType)
248 {
249     OCServerRequest * serverRequest = NULL;
250
251     //Note: OCServerRequest includes 1 byte for the JSON Payload.  payloadSize is calculated
252     //as the required length of the string, so this will result in enough room for the
253     //null terminator as well.
254     serverRequest = (OCServerRequest *) OCCalloc(1, sizeof(OCServerRequest) +
255         (reqTotalSize ? reqTotalSize : 1) - 1);
256     VERIFY_NON_NULL(serverRequest);
257
258     serverRequest->coapID = coapID;
259     serverRequest->delayedResNeeded = delayedResNeeded;
260     serverRequest->secured = secured;
261     serverRequest->notificationFlag = notificationFlag;
262
263     serverRequest->method = method;
264     serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
265     serverRequest->observationOption = observationOption;
266     serverRequest->observeResult = OC_STACK_ERROR;
267     serverRequest->qos = qos;
268     serverRequest->ehResponseHandler = HandleSingleResponse;
269     serverRequest->numResponses = 1;
270
271     if(query)
272     {
273         strncpy((char*)serverRequest->query,
274                 (const char*)query, sizeof(serverRequest->query) - 1);
275     }
276
277     if(rcvdVendorSpecificHeaderOptions)
278     {
279         memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
280             MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
281     }
282     if(reqJSONPayload && reqTotalSize)
283     {
284         // destination is at least 1 greater than the source, so a NULL always exists in the
285         // last character
286         strncpy((char*)serverRequest->reqJSONPayload,
287                 (const char*)reqJSONPayload, reqTotalSize - 1);
288     }
289     serverRequest->requestComplete = 0;
290     if(requestToken)
291     {
292         // If tokenLength is zero, the return value depends on the
293         // particular library implementation (it may or may not be a null pointer).
294         if (tokenLength)
295         {
296             serverRequest->requestToken = (CAToken_t) OCMalloc(tokenLength);
297             VERIFY_NON_NULL(serverRequest->requestToken);
298             memcpy(serverRequest->requestToken, *requestToken, tokenLength);
299         }
300
301     }
302     serverRequest->tokenLength = tokenLength;
303
304     if(resourceUrl)
305     {
306         strncpy((char*)serverRequest->resourceUrl,
307                 (const char*)resourceUrl, sizeof(serverRequest->resourceUrl) - 1);
308     }
309
310     if (addressInfo)
311     {
312         serverRequest->addressInfo = *addressInfo;
313     }
314     serverRequest->connectivityType = connectivityType;
315
316     *request = serverRequest;
317     OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
318     LL_APPEND (serverRequestList, serverRequest);
319     return OC_STACK_OK;
320
321 exit:
322     if (serverRequest)
323     {
324         OCFree(serverRequest);
325         serverRequest = NULL;
326     }
327     *request = NULL;
328     return OC_STACK_NO_MEMORY;
329 }
330
331 /**
332  * Form the OCEntityHandlerRequest struct that is passed to a resource's entity handler
333  *
334  * @param entityHandlerRequest - pointer to the OCEntityHandlerRequest struct that is created
335  * @param request          - request handle
336  * @param method           - RESTful method
337  * @param resource         - resource handle
338  * @param queryBuf         - resource query of request
339  * @param bufReqPayload    - JSON payload of request
340  * @param numVendorOptions - number of vendor options
341  * @param vendorOptions    - vendor options
342  * @param observeAction    - observe action flag
343  * @param observeID        - observe ID
344  *
345  * @return
346  *     OCStackResult
347  */
348 OCStackResult FormOCEntityHandlerRequest(
349         OCEntityHandlerRequest * entityHandlerRequest,
350         OCRequestHandle request,
351         OCMethod method,
352         OCResourceHandle resource,
353         char * queryBuf,
354         char * bufReqPayload,
355         uint8_t numVendorOptions,
356         OCHeaderOption * vendorOptions,
357         OCObserveAction observeAction,
358         OCObservationId observeID)
359 {
360     if (entityHandlerRequest)
361     {
362         memset(entityHandlerRequest, 0, sizeof(OCEntityHandlerRequest));
363         entityHandlerRequest->requestHandle = request;
364         entityHandlerRequest->method = method;
365         entityHandlerRequest->resource = (OCResourceHandle) resource;
366         entityHandlerRequest->query = queryBuf;
367         entityHandlerRequest->reqJSONPayload = bufReqPayload;
368         entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
369         entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
370
371         entityHandlerRequest->obsInfo.action = observeAction;
372         entityHandlerRequest->obsInfo.obsId = observeID;
373         return OC_STACK_OK;
374     }
375
376     return OC_STACK_INVALID_PARAM;
377 }
378
379 /**
380  * Find a server request in the server request list and delete
381  *
382  * @param serverRequest - server request to find and delete
383  */
384 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
385 {
386     OCServerRequest* tmp;
387     if(serverRequest)
388     {
389         LL_FOREACH(serverRequestList, tmp)
390         {
391             if (serverRequest == tmp)
392             {
393                 DeleteServerRequest(tmp);
394                 return;
395             }
396         }
397     }
398 }
399
400 /**
401  * Handler function for sending a response from a single resource
402  *
403  * @param ehResponse - pointer to the response from the resource
404  *
405  * @return
406  *     OCStackResult
407  */
408 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
409 {
410     OCStackResult result = OC_STACK_ERROR;
411     CARemoteEndpoint_t responseEndpoint = {};
412     CAResponseInfo_t responseInfo = {};
413     CAHeaderOption_t* optionsPointer = NULL;
414
415     if(!ehResponse)
416     {
417         OC_LOG(ERROR, TAG, PCF("HandleSingleResponse invalid parameters"));
418         return OC_STACK_INVALID_PARAM;
419     }
420
421     OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
422
423     OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
424
425     // Copy the address
426     responseEndpoint.resourceUri      = (CAURI_t) serverRequest->resourceUrl;
427     responseEndpoint.addressInfo      = serverRequest->addressInfo;
428     responseEndpoint.connectivityType = serverRequest->connectivityType;
429     responseEndpoint.isSecured        = serverRequest->secured;
430     // Copy the info
431     switch (ehResponse->ehResult)
432     {
433         case OC_EH_OK:
434             responseInfo.result = CA_SUCCESS;
435             break;
436         case OC_EH_ERROR:
437             responseInfo.result = CA_BAD_REQ;
438             break;
439         case OC_EH_RESOURCE_CREATED:
440             responseInfo.result = CA_CREATED;
441             break;
442         case OC_EH_RESOURCE_DELETED:
443             responseInfo.result = CA_DELETED;
444             break;
445         case OC_EH_SLOW:
446             responseInfo.result = CA_SUCCESS;
447             break;
448         case OC_EH_FORBIDDEN:
449             responseInfo.result = CA_BAD_REQ;
450             break;
451         default:
452             responseInfo.result = CA_BAD_REQ;
453             break;
454     }
455     responseInfo.info.type = qualityOfServiceToMessageType(serverRequest->qos);
456     char token[CA_MAX_TOKEN_LEN] = {};
457     responseInfo.info.token = token;
458     memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
459     responseInfo.info.tokenLength = serverRequest->tokenLength;
460
461     if(serverRequest->observeResult == OC_STACK_OK)
462     {
463         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
464     }
465     else
466     {
467         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
468     }
469
470     if(responseInfo.info.numOptions > 0)
471     {
472         responseInfo.info.options = (CAHeaderOption_t *)
473                                       OCCalloc(responseInfo.info.numOptions,
474                                               sizeof(CAHeaderOption_t));
475
476         if(!responseInfo.info.options)
477         {
478             OC_LOG(FATAL, TAG, PCF("options is NULL"));
479             return OC_STACK_NO_MEMORY;
480         }
481
482         optionsPointer = responseInfo.info.options;
483
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)
487         {
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));
493
494             // Point to the next header option before copying vender specific header options
495             optionsPointer += 1;
496         }
497
498         if (ehResponse->numSendVendorSpecificHeaderOptions)
499         {
500             memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
501                             sizeof(OCHeaderOption) *
502                             ehResponse->numSendVendorSpecificHeaderOptions);
503         }
504     }
505     else
506     {
507         responseInfo.info.options = NULL;
508     }
509
510     char payload[MAX_RESPONSE_LENGTH] = {};
511
512     // Put the JSON prefix and suffix around the payload
513     strcpy(payload, (const char *)OC_JSON_PREFIX);
514     strncat(payload, (const char *)ehResponse->payload, ehResponse->payloadSize);
515     strcat(payload, (const char *)OC_JSON_SUFFIX);
516     responseInfo.info.payload = (CAPayload_t)payload;
517
518     #ifdef WITH_PRESENCE
519     //TODO: Add other connectivity types to CAConnTypes[] when enabled
520     CAConnectivityType_t CAConnTypes[] = {CA_ETHERNET, CA_WIFI};
521     const char * connTypes[] = {"ethernet", "wifi"};
522     int size = sizeof(CAConnTypes)/ sizeof(CAConnectivityType_t);
523     CAConnectivityType_t connType = responseEndpoint.connectivityType;
524     CAResult_t caResult = CA_STATUS_FAILED;
525     result = OC_STACK_OK;
526
527     //Sending response on all n/w interfaces
528     for(int i = 0; i < size; i++ )
529     {
530         responseEndpoint.connectivityType = (CAConnectivityType_t)(connType & CAConnTypes[i]);
531         if(responseEndpoint.connectivityType)
532         {
533             //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
534             //response on all the n/w interfaces else it is set to OC_STACK_ERROR
535             caResult = CASendResponse(&responseEndpoint, &responseInfo);
536             if(caResult != CA_STATUS_OK)
537             {
538                 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
539                 result = CAResultToOCResult(caResult);
540             }
541             else
542             {
543                 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
544             }
545         }
546     }
547     #else
548     CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
549     if(caResult != CA_STATUS_OK)
550     {
551         OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
552         result = CAResultToOCResult(caResult);
553     }
554     else
555     {
556         result = OC_STACK_OK;
557     }
558     #endif
559
560     OCFree(responseInfo.info.options);
561     //Delete the request
562     FindAndDeleteServerRequest(serverRequest);
563     return result;
564 }
565
566 /**
567  * Handler function for sending a response from multiple resources, such as a collection.
568  * Aggregates responses from multiple resource until all responses are received then sends the
569  * concatenated response
570  *
571  * TODO: Need to add a timeout in case a (remote?) resource does not respond
572  *
573  * @param ehResponse - pointer to the response from the resource
574  *
575  * @return
576  *     OCStackResult
577  */
578 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
579 {
580     OCStackResult stackRet = OC_STACK_ERROR;
581     OCServerRequest * serverRequest = NULL;
582     OCServerResponse * serverResponse = NULL;
583     uint16_t bufferNeeded = 0;
584
585     if(!ehResponse || !ehResponse->payload)
586     {
587         OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
588         return OC_STACK_INVALID_PARAM;
589     }
590
591     OC_LOG_V(INFO, TAG, "Inside HandleAggregateResponse: %s", ehResponse->payload);
592
593     serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
594     serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
595
596     if(serverRequest)
597     {
598         if(!serverResponse)
599         {
600             OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
601             stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
602             if (OC_STACK_OK != stackRet)
603             {
604                 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
605                 return stackRet;
606             }
607             VERIFY_NON_NULL(serverResponse);
608             VERIFY_NON_NULL(serverResponse->payload);
609         }
610
611         // If there is more than 1 response, then we need to allow for a null-termination
612         // in the server response payload buffer AND the JSON response separator
613         bufferNeeded = ehResponse->payloadSize + 1;
614         if (serverRequest->numResponses > 1)
615         {
616             bufferNeeded += strlen(OC_JSON_SEPARATOR_STR);
617         }
618         if(serverResponse->remainingPayloadSize >= bufferNeeded)
619         {
620             OC_LOG(ERROR, TAG, PCF("There is room in response buffer"));
621             // append
622             strncat((char *)serverResponse->payload,
623                     (char *)ehResponse->payload,
624                     serverResponse->remainingPayloadSize);
625             OC_LOG_V(INFO, TAG, "Current aggregated response  ...%s", serverResponse->payload);
626             serverResponse->remainingPayloadSize -= strlen((char *)ehResponse->payload);
627             (serverRequest->numResponses)--;
628             if(serverRequest->numResponses == 0)
629             {
630                 OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
631                 ehResponse->payload = serverResponse->payload;
632                 ehResponse->payloadSize = strlen((char *) serverResponse->payload) + 1;
633                 stackRet = HandleSingleResponse(ehResponse);
634                 //Delete the request and response
635                 FindAndDeleteServerRequest(serverRequest);
636                 FindAndDeleteServerResponse(serverResponse);
637             }
638             else
639             {
640                 OC_LOG(INFO, TAG, PCF("More response fragments to come"));
641                 strncat((char *)serverResponse->payload,
642                         OC_JSON_SEPARATOR_STR,
643                         serverResponse->remainingPayloadSize);
644                 OC_LOG_V(INFO, TAG, "Current aggregated response  ...%s", serverResponse->payload);
645                 serverResponse->remainingPayloadSize -= strlen(OC_JSON_SEPARATOR_STR);
646                 stackRet = OC_STACK_OK;
647             }
648         }
649         else
650         {
651             OC_LOG(ERROR, TAG, PCF("No room in response buffer"));
652             //Delete the request and response
653             FindAndDeleteServerRequest(serverRequest);
654             FindAndDeleteServerResponse(serverResponse);
655             stackRet = OC_STACK_NO_MEMORY;
656         }
657     }
658 exit:
659     return stackRet;
660 }
661