Improve logging in the stack.
[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 "oic_malloc.h"
26 #include "oic_string.h"
27 #include "ocpayload.h"
28 #include "ocpayloadcbor.h"
29
30 #include "cacommon.h"
31 #include "cainterface.h"
32
33 #include "utlist.h"
34 #include "pdu.h"
35
36 // Module Name
37 #define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
38
39 #define TAG  PCF("ocserverrequest")
40
41 static struct OCServerRequest * serverRequestList = NULL;
42 static struct OCServerResponse * serverResponseList = NULL;
43
44 //-------------------------------------------------------------------------------------------------
45 // Local functions
46 //-------------------------------------------------------------------------------------------------
47
48 /**
49  * Add a server response to the server response list
50  *
51  * @param response initialized server response that is created by this function
52  * @param requestHandle - handle of the response
53  *
54  * @return
55  *     OCStackResult
56  */
57 static OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
58 {
59     OCServerResponse * serverResponse = NULL;
60
61     serverResponse = (OCServerResponse *) OICCalloc(1, sizeof(OCServerResponse));
62     VERIFY_NON_NULL(serverResponse);
63
64     serverResponse->payload = NULL;
65
66     serverResponse->requestHandle = requestHandle;
67
68     *response = serverResponse;
69     OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
70     LL_APPEND (serverResponseList, serverResponse);
71     return OC_STACK_OK;
72
73 exit:
74     if (serverResponse)
75     {
76         OICFree(serverResponse);
77         serverResponse = NULL;
78     }
79     *response = NULL;
80     return OC_STACK_NO_MEMORY;
81 }
82
83 /**
84  * Delete a server request from the server request list
85  *
86  * @param serverRequest - server request to delete
87  */
88 static void DeleteServerRequest(OCServerRequest * serverRequest)
89 {
90     if(serverRequest)
91     {
92         LL_DELETE(serverRequestList, serverRequest);
93         OICFree(serverRequest->requestToken);
94         OICFree(serverRequest);
95         serverRequest = NULL;
96         OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
97     }
98 }
99
100 /**
101  * Delete a server response from the server response list
102  *
103  * @param serverResponse - server response to delete
104  */
105 static void DeleteServerResponse(OCServerResponse * serverResponse)
106 {
107     if(serverResponse)
108     {
109         LL_DELETE(serverResponseList, serverResponse);
110         OICFree(serverResponse->payload);
111         OICFree(serverResponse);
112         OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
113     }
114 }
115
116 /**
117  * Find a server response and delete it from the server response list
118  *
119  * @param serverResponse - server response to find and delete
120  */
121 static void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
122 {
123     OCServerResponse* tmp;
124     if(serverResponse)
125     {
126         LL_FOREACH(serverResponseList, tmp)
127         {
128             if (serverResponse == tmp)
129             {
130                 DeleteServerResponse(tmp);
131                 return;
132             }
133         }
134     }
135 }
136
137 //-------------------------------------------------------------------------------------------------
138 // Internal APIs
139 //-------------------------------------------------------------------------------------------------
140
141 /**
142  * Get a server request from the server request list using the specified token.
143  *
144  * @param token - token of server request
145  * @param tokenLength - length of token
146  *
147  * @return
148  *     OCServerRequest*
149  */
150 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token, uint8_t tokenLength)
151 {
152     if(!token)
153     {
154         OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
155         return NULL;
156     }
157
158     OCServerRequest * out = NULL;
159     OC_LOG(INFO, TAG,PCF("Get server request with token"));
160     OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, tokenLength);
161
162     OC_LOG(INFO, TAG,PCF("Found token"));
163     LL_FOREACH (serverRequestList, out)
164     {
165         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, tokenLength);
166         if(memcmp(out->requestToken, token, tokenLength) == 0)
167         {
168             return out;
169         }
170     }
171     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
172     return NULL;
173 }
174
175 /**
176  * Get a server request from the server request list using the specified handle
177  *
178  * @param handle - handle of server request
179  * @return
180  *     OCServerRequest*
181  */
182 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
183 {
184     OCServerRequest * out = NULL;
185     LL_FOREACH (serverRequestList, out)
186     {
187         if(out == handle)
188         {
189             return out;
190         }
191     }
192     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
193     return NULL;
194 }
195
196 /**
197  * Get a server response from the server response list using the specified handle
198  *
199  * @param handle - handle of server response
200  *
201  * @return
202  *     OCServerResponse*
203  */
204 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
205 {
206     OCServerResponse * out = NULL;
207     LL_FOREACH (serverResponseList, out)
208     {
209         if(out->requestHandle == handle)
210         {
211             return out;
212         }
213     }
214     OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
215     return NULL;
216 }
217
218 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
219         uint8_t delayedResNeeded, uint8_t notificationFlag, OCMethod method,
220         uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
221         OCQualityOfService qos, char * query,
222         OCHeaderOption * rcvdVendorSpecificHeaderOptions,
223         uint8_t * payload, CAToken_t requestToken, uint8_t tokenLength,
224         char * resourceUrl, size_t reqTotalSize, const OCDevAddr *devAddr)
225 {
226     OCServerRequest * serverRequest = NULL;
227
228     serverRequest = (OCServerRequest *) OICCalloc(1, sizeof(OCServerRequest) +
229         (reqTotalSize ? reqTotalSize : 1) - 1);
230     VERIFY_NON_NULL(devAddr);
231     VERIFY_NON_NULL(serverRequest);
232
233     serverRequest->coapID = coapID;
234     serverRequest->delayedResNeeded = delayedResNeeded;
235     serverRequest->notificationFlag = notificationFlag;
236
237     serverRequest->method = method;
238     serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
239     serverRequest->observationOption = observationOption;
240     serverRequest->observeResult = OC_STACK_ERROR;
241     serverRequest->qos = qos;
242     serverRequest->ehResponseHandler = HandleSingleResponse;
243     serverRequest->numResponses = 1;
244
245     if(query)
246     {
247         OICStrcpy(serverRequest->query, sizeof(serverRequest->query), query);
248     }
249
250     if(rcvdVendorSpecificHeaderOptions)
251     {
252         memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
253             MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
254     }
255     if(payload && reqTotalSize)
256     {
257        // destination is at least 1 greater than the source, so a NULL always exists in the
258         // last character
259         memcpy(serverRequest->payload, payload, reqTotalSize);
260         serverRequest->payloadSize = reqTotalSize;
261     }
262
263     serverRequest->requestComplete = 0;
264     if(requestToken)
265     {
266         // If tokenLength is zero, the return value depends on the
267         // particular library implementation (it may or may not be a null pointer).
268         if (tokenLength)
269         {
270             serverRequest->requestToken = (CAToken_t) OICMalloc(tokenLength);
271             VERIFY_NON_NULL(serverRequest->requestToken);
272             memcpy(serverRequest->requestToken, requestToken, tokenLength);
273         }
274
275     }
276     serverRequest->tokenLength = tokenLength;
277
278     if(resourceUrl)
279     {
280         OICStrcpy(serverRequest->resourceUrl, sizeof(serverRequest->resourceUrl),
281             resourceUrl);
282     }
283
284     serverRequest->devAddr = *devAddr;
285
286     *request = serverRequest;
287     OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
288     LL_APPEND (serverRequestList, serverRequest);
289     return OC_STACK_OK;
290
291 exit:
292     if (serverRequest)
293     {
294         OICFree(serverRequest);
295         serverRequest = NULL;
296     }
297     *request = NULL;
298     return OC_STACK_NO_MEMORY;
299 }
300
301 OCStackResult FormOCEntityHandlerRequest(
302         OCEntityHandlerRequest * entityHandlerRequest,
303         OCRequestHandle request,
304         OCMethod method,
305         OCResourceHandle resource,
306         char * queryBuf,
307         uint8_t * payload,
308         size_t payloadSize,
309         uint8_t numVendorOptions,
310         OCHeaderOption * vendorOptions,
311         OCObserveAction observeAction,
312         OCObservationId observeID)
313 {
314     if (entityHandlerRequest)
315     {
316         entityHandlerRequest->resource = (OCResourceHandle) resource;
317         entityHandlerRequest->requestHandle = request;
318         entityHandlerRequest->method = method;
319         entityHandlerRequest->query = queryBuf;
320         entityHandlerRequest->obsInfo.action = observeAction;
321         entityHandlerRequest->obsInfo.obsId = observeID;
322
323         if(payload && payloadSize)
324         {
325             if(OCParsePayload(&entityHandlerRequest->payload, payload, payloadSize) != OC_STACK_OK)
326             {
327                 return OC_STACK_ERROR;
328             }
329         }
330         else
331         {
332             entityHandlerRequest->payload = NULL;
333         }
334
335         entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
336         entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
337
338         return OC_STACK_OK;
339     }
340
341     return OC_STACK_INVALID_PARAM;
342 }
343
344 /**
345  * Find a server request in the server request list and delete
346  *
347  * @param serverRequest - server request to find and delete
348  */
349 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
350 {
351     OCServerRequest* tmp;
352     if(serverRequest)
353     {
354         LL_FOREACH(serverRequestList, tmp)
355         {
356             if (serverRequest == tmp)
357             {
358                 DeleteServerRequest(tmp);
359                 return;
360             }
361         }
362     }
363 }
364
365 CAResponseResult_t ConvertEHResultToCAResult (OCEntityHandlerResult result)
366 {
367     CAResponseResult_t caResult = CA_BAD_REQ;
368
369     switch (result)
370     {
371         case OC_EH_OK:
372             caResult = CA_SUCCESS;
373             break;
374         case OC_EH_ERROR:
375             caResult = CA_BAD_REQ;
376             break;
377         case OC_EH_RESOURCE_CREATED:
378             caResult = CA_CREATED;
379             break;
380         case OC_EH_RESOURCE_DELETED:
381             caResult = CA_DELETED;
382             break;
383         case OC_EH_SLOW:
384             caResult = CA_SUCCESS;
385             break;
386         case OC_EH_FORBIDDEN:
387             caResult = CA_UNAUTHORIZED_REQ;
388             break;
389         case OC_EH_RESOURCE_NOT_FOUND:
390             caResult = CA_NOT_FOUND;
391             break;
392         default:
393             caResult = CA_BAD_REQ;
394             break;
395     }
396     return caResult;
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
409 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
410 {
411     OCStackResult result = OC_STACK_ERROR;
412     CAEndpoint_t responseEndpoint = {};
413     CAResponseInfo_t responseInfo = {};
414     CAHeaderOption_t* optionsPointer = NULL;
415
416     if(!ehResponse || !ehResponse->requestHandle)
417     {
418         return OC_STACK_ERROR;
419     }
420
421     OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
422
423     CopyDevAddrToEndpoint(&serverRequest->devAddr, &responseEndpoint);
424
425     responseInfo.info.resourceUri = serverRequest->resourceUrl;
426     responseInfo.result = ConvertEHResultToCAResult(ehResponse->ehResult);
427
428     if(serverRequest->notificationFlag && serverRequest->qos == OC_HIGH_QOS)
429     {
430         responseInfo.info.type = CA_MSG_CONFIRM;
431     }
432     else if(serverRequest->notificationFlag && serverRequest->qos != OC_HIGH_QOS)
433     {
434         responseInfo.info.type = CA_MSG_NONCONFIRM;
435     }
436     else if(!serverRequest->notificationFlag && !serverRequest->slowFlag &&
437             serverRequest->qos == OC_HIGH_QOS)
438     {
439         responseInfo.info.type = CA_MSG_ACKNOWLEDGE;
440     }
441     else if(!serverRequest->notificationFlag && serverRequest->slowFlag &&
442             serverRequest->qos == OC_HIGH_QOS)
443     {
444         responseInfo.info.type = CA_MSG_CONFIRM;
445     }
446     else if(!serverRequest->notificationFlag)
447     {
448         responseInfo.info.type = CA_MSG_NONCONFIRM;
449     }
450
451     responseInfo.info.messageId = serverRequest->coapID;
452     responseInfo.info.token = (CAToken_t)OICMalloc(CA_MAX_TOKEN_LEN+1);
453     if (!responseInfo.info.token)
454     {
455         OC_LOG(FATAL, TAG, "Memory alloc for token failed");
456         return result;
457     }
458
459     memcpy(responseInfo.info.token, serverRequest->requestToken, serverRequest->tokenLength);
460     responseInfo.info.tokenLength = serverRequest->tokenLength;
461
462     if(serverRequest->observeResult == OC_STACK_OK)
463     {
464         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
465     }
466     else
467     {
468         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
469     }
470
471     if(responseInfo.info.numOptions > 0)
472     {
473         responseInfo.info.options = (CAHeaderOption_t *)
474                                       OICCalloc(responseInfo.info.numOptions,
475                                               sizeof(CAHeaderOption_t));
476
477         if(!responseInfo.info.options)
478         {
479             OC_LOG(FATAL, TAG, PCF("Memory alloc for options failed"));
480             OICFree(responseInfo.info.token);
481             return OC_STACK_NO_MEMORY;
482         }
483
484         optionsPointer = responseInfo.info.options;
485
486         // TODO: This exposes CoAP specific details.  At some point, this should be
487         // re-factored and handled in the CA layer.
488         if(serverRequest->observeResult == OC_STACK_OK)
489         {
490             responseInfo.info.options[0].protocolID = CA_COAP_ID;
491             responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
492             responseInfo.info.options[0].optionLength = sizeof(uint32_t);
493             memcpy(responseInfo.info.options[0].optionData,
494                     &(serverRequest->observationOption), sizeof(uint32_t));
495
496             // Point to the next header option before copying vender specific header options
497             optionsPointer += 1;
498         }
499
500         if (ehResponse->numSendVendorSpecificHeaderOptions)
501         {
502             memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
503                             sizeof(OCHeaderOption) *
504                             ehResponse->numSendVendorSpecificHeaderOptions);
505         }
506     }
507     else
508     {
509         responseInfo.info.options = NULL;
510     }
511
512     // Put the JSON prefix and suffix around the payload
513     if(ehResponse->payload)
514     {
515         OCStackResult result;
516         if((result = OCConvertPayload(ehResponse->payload, &responseInfo.info.payload,
517                     &responseInfo.info.payloadSize))
518                 != OC_STACK_OK)
519         {
520             OC_LOG(ERROR, TAG, "Error converting payload");
521             return result;
522         }
523
524         if(responseInfo.info.payloadSize > MAX_RESPONSE_LENGTH)
525         {
526             OICFree(responseInfo.info.payload);
527             OC_LOG(ERROR, TAG, "Payload too long!");
528             return OC_STACK_INVALID_PARAM;
529         }
530     }
531     else
532     {
533         responseInfo.info.payload = NULL;
534         responseInfo.info.payloadSize = 0;
535     }
536
537     #ifdef WITH_PRESENCE
538     //TODO: Add other connectivity types to CAConnTypes[] when enabled
539     CATransportAdapter_t CAConnTypes[] = {CA_ADAPTER_IP};
540     const char * connTypes[] = {"IP"};
541     int size = sizeof(CAConnTypes)/ sizeof(CATransportAdapter_t);
542     CATransportAdapter_t adapter = responseEndpoint.adapter;
543     CAResult_t caResult = CA_STATUS_FAILED;
544     result = OC_STACK_OK;
545
546     // Default adapter, try to send response out on all adapters.
547     if (adapter == CA_DEFAULT_ADAPTER)
548     {
549         adapter =
550             (CATransportAdapter_t)(CA_ADAPTER_IP | CA_ADAPTER_GATT_BTLE | CA_ADAPTER_RFCOMM_BTEDR);
551     }
552
553     for(int i = 0; i < size; i++ )
554     {
555         responseEndpoint.adapter = (CATransportAdapter_t)(adapter & CAConnTypes[i]);
556         if(responseEndpoint.adapter)
557         {
558             //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
559             //response on all the n/w interfaces else it is set to OC_STACK_ERROR
560             caResult = CASendResponse(&responseEndpoint, &responseInfo);
561             if(caResult != CA_STATUS_OK)
562             {
563                 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
564                 result = CAResultToOCResult(caResult);
565             }
566             else
567             {
568                 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
569             }
570         }
571     }
572     #else
573
574     OC_LOG(INFO, TAG, PCF("Calling CASendResponse with:"));
575     OC_LOG_V(INFO, TAG, "\tEndpoint address: %s", responseEndpoint.addr);
576     OC_LOG_V(INFO, TAG, "\tEndpoint adapter: %s", responseEndpoint.adapter);
577     OC_LOG_V(INFO, TAG, "\tResponse result : %s", responseInfo.result);
578     OC_LOG_V(INFO, TAG, "\tResponse for uri: %s", responseInfo.info.resourceUri);
579
580     CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
581     if(caResult != CA_STATUS_OK)
582     {
583         OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
584         result = CAResultToOCResult(caResult);
585     }
586     else
587     {
588         result = OC_STACK_OK;
589     }
590     #endif
591
592     OICFree(responseInfo.info.payload);
593     OICFree(responseInfo.info.token);
594     OICFree(responseInfo.info.options);
595     //Delete the request
596     FindAndDeleteServerRequest(serverRequest);
597     return result;
598 }
599
600 /**
601  * Handler function for sending a response from multiple resources, such as a collection.
602  * Aggregates responses from multiple resource until all responses are received then sends the
603  * concatenated response
604  *
605  * TODO: Need to add a timeout in case a (remote?) resource does not respond
606  *
607  * @param ehResponse - pointer to the response from the resource
608  *
609  * @return
610  *     OCStackResult
611  */
612 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
613 {
614     OCStackResult stackRet = OC_STACK_ERROR;
615     OCServerRequest * serverRequest = NULL;
616     OCServerResponse * serverResponse = NULL;
617
618     if(!ehResponse || !ehResponse->payload)
619     {
620         OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
621         return OC_STACK_INVALID_PARAM;
622     }
623
624     OC_LOG(INFO, TAG, "Inside HandleAggregateResponse");
625
626     serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
627     serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
628
629     if(serverRequest)
630     {
631         if(!serverResponse)
632         {
633             OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
634             stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
635             if (OC_STACK_OK != stackRet)
636             {
637                 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
638                 return stackRet;
639             }
640             VERIFY_NON_NULL(serverResponse);
641         }
642
643         if(serverResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION ||
644                 ehResponse->payload->type != PAYLOAD_TYPE_REPRESENTATION)
645         {
646             stackRet = OC_STACK_ERROR;
647             OC_LOG(ERROR, TAG, PCF("Error adding payload, as it was the incorrect type"));
648             goto exit;
649         }
650
651         OCRepPayloadAppend((OCRepPayload*)serverResponse->payload,
652                 (OCRepPayload*)ehResponse->payload);
653
654         (serverRequest->numResponses)--;
655
656         if(serverRequest->numResponses == 0)
657         {
658             OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
659             ehResponse->payload = serverResponse->payload;
660             stackRet = HandleSingleResponse(ehResponse);
661             //Delete the request and response
662             FindAndDeleteServerRequest(serverRequest);
663             FindAndDeleteServerResponse(serverResponse);
664         }
665         else
666         {
667             OC_LOG(INFO, TAG, PCF("More response fragments to come"));
668             stackRet = OC_STACK_OK;
669         }
670     }
671 exit:
672     return stackRet;
673 }
674