IOT-982 Query handling for /oic/res
[platform/upstream/iotivity.git] / resource / csdk / stack / src / ocresource.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
21 // Defining _POSIX_C_SOURCE macro with 200112L (or greater) as value
22 // causes header files to expose definitions
23 // corresponding to the POSIX.1-2001 base
24 // specification (excluding the XSI extension).
25 // For POSIX.1-2001 base specification,
26 // Refer http://pubs.opengroup.org/onlinepubs/009695399/
27 #define _POSIX_C_SOURCE 200112L
28
29 #ifdef WITH_ARDUINO
30 #include <string.h>
31 #else
32 #include <strings.h>
33 #endif
34
35 #include "ocresource.h"
36 #include "ocresourcehandler.h"
37 #include "ocobserve.h"
38 #include "occollection.h"
39 #include "oic_malloc.h"
40 #include "oic_string.h"
41 #include "logger.h"
42 #include "cJSON.h"
43 #include "ocpayload.h"
44 #include "secureresourcemanager.h"
45 #include "cacommon.h"
46 #include "cainterface.h"
47 #include "rdpayload.h"
48 #include "ocpayload.h"
49
50 #ifdef WITH_RD
51 #include "rd_server.h"
52 #endif
53
54 #ifdef ROUTING_GATEWAY
55 #include "routingmanager.h"
56 #endif
57
58 /// Module Name
59 #define TAG "OIC_RI_RESOURCE"
60
61 #define VERIFY_SUCCESS(op, successCode) { if (op != successCode) \
62             {OIC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
63
64 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OIC_LOG((logLevel), \
65              TAG, #arg " is NULL"); return (retVal); } }
66
67 extern OCResource *headResource;
68 static OCPlatformInfo savedPlatformInfo = {0};
69 static OCDeviceInfo savedDeviceInfo = {0};
70
71 /**
72  * Prepares a Payload for response.
73  */
74 static OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
75                                                   OCDiscoveryPayload* payload,
76                                                   OCDevAddr *endpoint,
77                                                   bool rdResponse);
78
79 //-----------------------------------------------------------------------------
80 // Default resource entity handler function
81 //-----------------------------------------------------------------------------
82 OCEntityHandlerResult defaultResourceEHandler(OCEntityHandlerFlag flag,
83         OCEntityHandlerRequest * request, void* callbackParam)
84 {
85     //TODO ("Implement me!!!!");
86     // TODO:  remove silence unused param warnings
87     (void) flag;
88     (void) request;
89     (void) callbackParam;
90     return  OC_EH_OK; // Making sure that the Default EH and the Vendor EH have matching signatures
91 }
92
93 /* This method will retrieve the port at which the secure resource is hosted */
94 static OCStackResult GetSecurePortInfo(OCDevAddr *endpoint, uint16_t *port)
95 {
96     uint16_t p = 0;
97
98     if (endpoint->adapter == OC_ADAPTER_IP)
99     {
100         if (endpoint->flags & OC_IP_USE_V6)
101         {
102             p = caglobals.ip.u6s.port;
103         }
104         else if (endpoint->flags & OC_IP_USE_V4)
105         {
106             p = caglobals.ip.u4s.port;
107         }
108     }
109
110     *port = p;
111     return OC_STACK_OK;
112 }
113
114 /*
115  * Function will extract 0, 1 or 2 filters from query.
116  * More than 2 filters or unsupported filters will result in error.
117  * If both filters are of the same supported type, the 2nd one will be picked.
118  * Resource and device filters in the SAME query are NOT validated
119  * and resources will likely not clear filters.
120  */
121 static OCStackResult ExtractFiltersFromQuery(char *query, char **filterOne, char **filterTwo)
122 {
123
124     char *key = NULL;
125     char *value = NULL;
126     char *restOfQuery = NULL;
127     int numKeyValuePairsParsed = 0;
128
129     *filterOne = NULL;
130     *filterTwo = NULL;
131
132     OIC_LOG_V(INFO, TAG, "Extracting params from %s", query);
133
134     char *keyValuePair = strtok_r (query, OC_QUERY_SEPARATOR, &restOfQuery);
135
136     while(keyValuePair)
137     {
138         if (numKeyValuePairsParsed >= 2)
139         {
140             OIC_LOG(ERROR, TAG, "More than 2 queries params in URI.");
141             return OC_STACK_INVALID_QUERY;
142         }
143
144         key = strtok_r(keyValuePair, OC_KEY_VALUE_DELIMITER, &value);
145
146         if (!key || !value)
147         {
148             return OC_STACK_INVALID_QUERY;
149         }
150         else if (strncasecmp(key, OC_RSRVD_INTERFACE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
151         {
152             *filterOne = value;     // if
153         }
154         else if (strncasecmp(key, OC_RSRVD_RESOURCE_TYPE, sizeof(OC_RSRVD_INTERFACE) - 1) == 0)
155         {
156             *filterTwo = value;     // rt
157         }
158         else
159         {
160             OIC_LOG_V(ERROR, TAG, "Unsupported query key: %s", key);
161             return OC_STACK_INVALID_QUERY;
162         }
163         ++numKeyValuePairsParsed;
164
165         keyValuePair = strtok_r(NULL, OC_QUERY_SEPARATOR, &restOfQuery);
166     }
167
168     OIC_LOG_V(INFO, TAG, "Extracted params if: %s and rt: %s.", *filterOne, *filterTwo);
169     return OC_STACK_OK;
170 }
171
172 static OCVirtualResources GetTypeOfVirtualURI(const char *uriInRequest)
173 {
174     if (strcmp(uriInRequest, OC_RSRVD_WELL_KNOWN_URI) == 0)
175     {
176         return OC_WELL_KNOWN_URI;
177     }
178     else if (strcmp(uriInRequest, OC_RSRVD_DEVICE_URI) == 0)
179     {
180         return OC_DEVICE_URI;
181     }
182     else if (strcmp(uriInRequest, OC_RSRVD_PLATFORM_URI) == 0)
183     {
184         return OC_PLATFORM_URI;
185     }
186     else if (strcmp(uriInRequest, OC_RSRVD_RESOURCE_TYPES_URI) == 0)
187     {
188         return OC_RESOURCE_TYPES_URI;
189     }
190 #ifdef ROUTING_GATEWAY
191     else if (0 == strcmp(uriInRequest, OC_RSRVD_GATEWAY_URI))
192     {
193         return OC_GATEWAY_URI;
194     }
195 #endif
196 #ifdef WITH_PRESENCE
197     else if (strcmp(uriInRequest, OC_RSRVD_PRESENCE_URI) == 0)
198     {
199         return OC_PRESENCE;
200     }
201 #endif //WITH_PRESENCE
202     return OC_UNKNOWN_URI;
203 }
204
205 static OCStackResult getQueryParamsForFiltering (OCVirtualResources uri, char *query,
206                                             char **filterOne, char **filterTwo)
207 {
208     if(!filterOne || !filterTwo)
209     {
210         return OC_STACK_INVALID_PARAM;
211     }
212
213     *filterOne = NULL;
214     *filterTwo = NULL;
215
216     #ifdef WITH_PRESENCE
217     if (uri == OC_PRESENCE)
218     {
219         //Nothing needs to be done, except for pass a OC_PRESENCE query through as OC_STACK_OK.
220         OIC_LOG(INFO, TAG, "OC_PRESENCE Request for virtual resource.");
221         return OC_STACK_OK;
222     }
223     #endif
224
225     OCStackResult result = OC_STACK_OK;
226
227     if (query && *query)
228     {
229         result = ExtractFiltersFromQuery(query, filterOne, filterTwo);
230     }
231
232     return result;
233 }
234
235 OCStackResult BuildResponseRepresentation(const OCResource *resourcePtr,
236                     OCRepPayload** payload)
237 {
238     OCRepPayload *tempPayload = OCRepPayloadCreate();
239
240     if (!resourcePtr)
241     {
242         OCRepPayloadDestroy(tempPayload);
243         return OC_STACK_INVALID_PARAM;
244     }
245
246     if(!tempPayload)
247     {
248         return OC_STACK_NO_MEMORY;
249     }
250
251     OCRepPayloadSetUri(tempPayload, resourcePtr->uri);
252
253     OCResourceType *resType = resourcePtr->rsrcType;
254     while(resType)
255     {
256         OCRepPayloadAddResourceType(tempPayload, resType->resourcetypename);
257         resType = resType->next;
258     }
259
260     OCResourceInterface *resInterface = resourcePtr->rsrcInterface;
261     while(resInterface)
262     {
263         OCRepPayloadAddInterface(tempPayload, resInterface->name);
264         resInterface = resInterface->next;
265     }
266
267     OCAttribute *resAttrib = resourcePtr->rsrcAttributes;
268     while(resAttrib)
269     {
270         OCRepPayloadSetPropString(tempPayload, resAttrib->attrName,
271                                 resAttrib->attrValue);
272         resAttrib = resAttrib->next;
273     }
274
275     if(!*payload)
276     {
277         *payload = tempPayload;
278     }
279     else
280     {
281         OCRepPayloadAppend(*payload, tempPayload);
282     }
283
284     return OC_STACK_OK;
285 }
286
287 OCStackResult BuildVirtualResourceResponse(const OCResource *resourcePtr,
288                         OCDiscoveryPayload *payload, OCDevAddr *devAddr, bool rdResponse)
289 {
290     if (!resourcePtr || !payload)
291     {
292         return OC_STACK_INVALID_PARAM;
293     }
294     uint16_t port = 0;
295     if (resourcePtr->resourceProperties & OC_SECURE)
296     {
297        if (GetSecurePortInfo(devAddr, &port) != OC_STACK_OK)
298        {
299            port = 0;
300        }
301     }
302
303     if (rdResponse)
304     {
305         port = devAddr->port;
306     }
307
308     OCDiscoveryPayloadAddResource(payload, resourcePtr, port);
309     return OC_STACK_OK;
310 }
311
312 uint8_t IsCollectionResource (OCResource *resource)
313 {
314     if(!resource)
315     {
316         return 0;
317     }
318
319     if(resource->rsrcChildResourcesHead != NULL)
320     {
321         return 1;
322     }
323
324     return 0;
325 }
326
327 OCResource *FindResourceByUri(const char* resourceUri)
328 {
329     if(!resourceUri)
330     {
331         return NULL;
332     }
333
334     OCResource * pointer = headResource;
335     while (pointer)
336     {
337         if (strcmp(resourceUri, pointer->uri) == 0)
338         {
339             return pointer;
340         }
341         pointer = pointer->next;
342     }
343     OIC_LOG_V(INFO, TAG, "Resource %s not found", resourceUri);
344     return NULL;
345 }
346
347
348 OCStackResult DetermineResourceHandling (const OCServerRequest *request,
349                                          ResourceHandling *handling,
350                                          OCResource **resource)
351 {
352     if(!request || !handling || !resource)
353     {
354         return OC_STACK_INVALID_PARAM;
355     }
356
357     OIC_LOG_V(INFO, TAG, "DetermineResourceHandling for %s", request->resourceUrl);
358
359     // Check if virtual resource
360     if (GetTypeOfVirtualURI(request->resourceUrl) != OC_UNKNOWN_URI)
361     {
362         OIC_LOG_V (INFO, TAG, "%s is virtual", request->resourceUrl);
363         *handling = OC_RESOURCE_VIRTUAL;
364         *resource = headResource;
365         return OC_STACK_OK;
366     }
367     if (strlen((const char*)(request->resourceUrl)) == 0)
368     {
369         // Resource URL not specified
370         *handling = OC_RESOURCE_NOT_SPECIFIED;
371         return OC_STACK_NO_RESOURCE;
372     }
373     else
374     {
375         OCResource *resourcePtr = FindResourceByUri((const char*)request->resourceUrl);
376         *resource = resourcePtr;
377         if (!resourcePtr)
378         {
379             if(defaultDeviceHandler)
380             {
381                 *handling = OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER;
382                 return OC_STACK_OK;
383             }
384
385             // Resource does not exist
386             // and default device handler does not exist
387             *handling = OC_RESOURCE_NOT_SPECIFIED;
388             return OC_STACK_NO_RESOURCE;
389         }
390
391         if (IsCollectionResource (resourcePtr))
392         {
393             // Collection resource
394             if (resourcePtr->entityHandler != defaultResourceEHandler)
395             {
396                 *handling = OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER;
397                 return OC_STACK_OK;
398             }
399             else
400             {
401                 *handling = OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER;
402                 return OC_STACK_OK;
403             }
404         }
405         else
406         {
407             // Resource not a collection
408             if (resourcePtr->entityHandler != defaultResourceEHandler)
409             {
410                 *handling = OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER;
411                 return OC_STACK_OK;
412             }
413             else
414             {
415                 *handling = OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER;
416                 return OC_STACK_OK;
417             }
418         }
419     }
420 }
421
422 OCStackResult EntityHandlerCodeToOCStackCode(OCEntityHandlerResult ehResult)
423 {
424     OCStackResult result;
425
426     switch (ehResult)
427     {
428         case OC_EH_OK:
429             result = OC_STACK_OK;
430             break;
431         case OC_EH_SLOW:
432             result = OC_STACK_SLOW_RESOURCE;
433             break;
434         case OC_EH_ERROR:
435             result = OC_STACK_ERROR;
436             break;
437         case OC_EH_FORBIDDEN:
438             result = OC_STACK_RESOURCE_ERROR;
439             break;
440         case OC_EH_RESOURCE_CREATED:
441             result = OC_STACK_RESOURCE_CREATED;
442             break;
443         case OC_EH_RESOURCE_DELETED:
444             result = OC_STACK_RESOURCE_DELETED;
445             break;
446         case OC_EH_RESOURCE_NOT_FOUND:
447             result = OC_STACK_NO_RESOURCE;
448             break;
449         default:
450             result = OC_STACK_ERROR;
451     }
452
453     return result;
454 }
455
456 static bool resourceMatchesRTFilter(OCResource *resource, char *resourceTypeFilter)
457 {
458     if (!resource)
459     {
460         return false;
461     }
462
463     // Null or empty is analogous to no filter.
464     if (resourceTypeFilter == NULL || *resourceTypeFilter == 0)
465     {
466         return true;
467     }
468
469     OCResourceType *resourceTypePtr = resource->rsrcType;
470
471     while (resourceTypePtr)
472     {
473         if (strcmp (resourceTypePtr->resourcetypename, resourceTypeFilter) == 0)
474         {
475             return true;
476         }
477         resourceTypePtr = resourceTypePtr->next;
478     }
479
480     OIC_LOG_V(INFO, TAG, "%s does not contain rt=%s.", resource->uri, resourceTypeFilter);
481     return false;
482 }
483
484 static bool resourceMatchesIFFilter(OCResource *resource, char *interfaceFilter)
485 {
486     if (!resource)
487     {
488         return false;
489     }
490
491     // Null or empty is analogous to no filter.
492     if (interfaceFilter == NULL || *interfaceFilter == 0)
493     {
494         return true;
495     }
496
497     OCResourceInterface *interfacePtr = resource->rsrcInterface;
498
499     while (interfacePtr)
500     {
501         if ((strcmp (interfacePtr->name, interfaceFilter) == 0) &&
502             (strcmp (OC_RSRVD_INTERFACE_LL, interfaceFilter) == 0 ||
503              strcmp (OC_RSRVD_INTERFACE_DEFAULT, interfaceFilter) == 0))
504         {
505             return true;
506         }
507         interfacePtr = interfacePtr->next;
508     }
509
510     OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
511     return false;
512 }
513
514 /*
515  * If the filters are null, they will be assumed to NOT be present
516  * and the resource will not be matched against them.
517  * Function will return true if all non null AND non empty filters passed in find a match.
518  */
519 static bool includeThisResourceInResponse(OCResource *resource,
520                                           char *interfaceFilter,
521                                           char *resourceTypeFilter)
522 {
523     if (!resource)
524     {
525         OIC_LOG(ERROR, TAG, "Invalid resource");
526         return false;
527     }
528
529     if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
530     {
531         /*
532          * At least one valid filter should be available to
533          * include the resource in discovery response
534          */
535         if (!(resourceTypeFilter && *resourceTypeFilter))
536         {
537             OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
538                 resource", resource->uri);
539             return false;
540         }
541     }
542     else if ( !(resource->resourceProperties & OC_ACTIVE) ||
543          !(resource->resourceProperties & OC_DISCOVERABLE))
544     {
545         OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
546         return false;
547     }
548
549     return resourceMatchesIFFilter(resource, interfaceFilter) &&
550            resourceMatchesRTFilter(resource, resourceTypeFilter);
551
552 }
553
554 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
555                                 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
556 {
557     OCEntityHandlerResponse response = {0};
558
559     response.ehResult = ehResult;
560     response.payload = discoveryPayload;
561     response.persistentBufferFlag = 0;
562     response.requestHandle = (OCRequestHandle) request;
563     response.resourceHandle = (OCResourceHandle) resource;
564
565     return OCDoResponse(&response);
566 }
567
568 #ifdef WITH_RD
569 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
570      OCResource **payload, OCDevAddr *devAddr)
571 {
572     OCResourceCollectionPayload *repPayload;
573     if (!payload)
574     {
575         return OC_STACK_ERROR;
576     }
577     if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
578     {
579         if (!repPayload)
580         {
581             return OC_STACK_ERROR;
582         }
583         OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
584         if (!ptr)
585         {
586            return OC_STACK_NO_MEMORY;
587         }
588
589         ptr->uri = OICStrdup(repPayload->setLinks->href);
590         if (!ptr->uri)
591         {
592            return OC_STACK_NO_MEMORY;
593         }
594         OCStringLL *rt = repPayload->setLinks->rt;
595         while (rt)
596         {
597             OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
598             if(!temp)
599             {
600                 OICFree(ptr->uri);
601                 return OC_STACK_NO_MEMORY;
602             }
603             temp->next = NULL;
604             temp->resourcetypename = OICStrdup(rt->value);
605             if (!ptr->rsrcType)
606             {
607                 ptr->rsrcType = temp;
608             }
609             else
610             {
611                 OCResourceType *type = ptr->rsrcType;
612                 while (type->next)
613                 {
614                     type = type->next;
615                 }
616                 type->next = temp;
617             }
618             rt = rt->next;
619         }
620
621         OCStringLL *itf = repPayload->setLinks->itf;
622         while (itf)
623         {
624             OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
625             if (!temp)
626             {
627                 OICFree(ptr->uri);
628
629                 return OC_STACK_NO_MEMORY;
630             }
631             temp->next = NULL;
632             temp->name = OICStrdup(itf->value);
633             if (!ptr->rsrcInterface)
634             {
635                 ptr->rsrcInterface = temp;
636             }
637             else
638             {
639                 OCResourceInterface *type = ptr->rsrcInterface;
640                 while (type->next)
641                 {
642                     type = type->next;
643                 }
644                 type->next = temp;
645             }
646             itf = itf->next;
647         }
648
649         ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
650
651         OCFreeCollectionResource(repPayload);
652         *payload = ptr;
653         return OC_STACK_OK;
654     }
655     else
656     {
657         OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
658                              on the resource directory");
659     }
660     return OC_STACK_ERROR;
661 }
662 #endif
663
664 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
665 {
666     if (!request || !resource)
667     {
668         return OC_STACK_INVALID_PARAM;
669     }
670
671     OCStackResult discoveryResult = OC_STACK_ERROR;
672
673     bool bMulticast    = false;     // Was the discovery request a multicast request?
674     OCPayload* payload = NULL;
675
676     OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
677
678     OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
679
680     // Step 1: Generate the response to discovery request
681     if (virtualUriInRequest == OC_WELL_KNOWN_URI)
682     {
683         char *interfaceQuery = NULL;
684         char *resourceTypeQuery = NULL;
685
686         discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
687                 &interfaceQuery, &resourceTypeQuery);
688         bool interfaceQueryAllocated = false;
689         if (!interfaceQuery && !resourceTypeQuery)
690         {
691             interfaceQueryAllocated = true;
692             interfaceQuery = OICStrdup(OC_RSRVD_INTERFACE_LL);
693         }
694
695         if (discoveryResult == OC_STACK_OK)
696         {
697             payload = (OCPayload *)OCDiscoveryPayloadCreate();
698
699             if (payload)
700             {
701                 OCDiscoveryPayload *discPayload = (OCDiscoveryPayload *)payload;
702                 discPayload->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
703                 VERIFY_NON_NULL(discPayload->sid, ERROR, OC_STACK_NO_MEMORY);
704                 memcpy(discPayload->sid, OCGetServerInstanceIDString(), UUID_STRING_SIZE);
705                 if (!resourceTypeQuery && interfaceQuery && (0 == strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL)))
706                 {
707                     for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
708                     {
709                         bool result = false;
710                         if (resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
711                         {
712                             if (resourceTypeQuery && resourceMatchesRTFilter(resource, resourceTypeQuery))
713                             {
714                                 result = true;
715                             }
716                         }
717                         if (resource->resourceProperties & OC_DISCOVERABLE)
718                         {
719                             result = true;
720                         }
721
722                         if (result)
723                         {
724                             discoveryResult = BuildVirtualResourceResponse(resource,
725                             discPayload, &request->devAddr, false);
726                         }
727                     }
728                 }
729                 else
730                 {
731                     if ((interfaceQuery && (0 != strcmp(interfaceQuery, OC_RSRVD_INTERFACE_LL))) ||
732                         !interfaceQuery)
733                     {
734                         discPayload->uri = OICStrdup(OC_RSRVD_WELL_KNOWN_URI);
735                         VERIFY_NON_NULL(discPayload->uri, ERROR, OC_STACK_NO_MEMORY);
736                         if (savedDeviceInfo.deviceName)
737                         {
738                             discPayload->name = OICStrdup(savedDeviceInfo.deviceName);
739                             VERIFY_NON_NULL(discPayload->name, ERROR, OC_STACK_NO_MEMORY);
740                         }
741                         discPayload->type = OICStrdup(OC_RSRVD_RESOURCE_TYPE_RES);
742                         VERIFY_NON_NULL(discPayload->type, ERROR, OC_STACK_NO_MEMORY);
743                         OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_LL);
744                         OCResourcePayloadAddStringLL(&discPayload->interface, OC_RSRVD_INTERFACE_DEFAULT);
745                         VERIFY_NON_NULL(discPayload->interface, ERROR, OC_STACK_NO_MEMORY);
746                     }
747                     bool foundResourceAtRD = false;
748                     for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
749                     {
750 #ifdef WITH_RD
751                         if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
752                         {
753                             OCResource *resource1 = NULL;
754                             OCDevAddr devAddr;
755                             discoveryResult = checkResourceExistsAtRD(interfaceQuery,
756                                 resourceTypeQuery, &resource1, &devAddr);
757                             if (discoveryResult != OC_STACK_OK)
758                             {
759                                  break;
760                             }
761                             discoveryResult = BuildVirtualResourceResponse(resource1,
762                                 discPayload, &devAddr, true);
763                             if (payload)
764                             {
765                                 discPayload->baseURI = OICStrdup(devAddr.addr);
766                             }
767                             OICFree(resource1->uri);
768                             for (OCResourceType *rsrcRt = resource1->rsrcType, *rsrcRtNext = NULL; rsrcRt; )
769                             {
770                                 rsrcRtNext = rsrcRt->next;
771                                 OICFree(rsrcRt->resourcetypename);
772                                 OICFree(rsrcRt);
773                                 rsrcRt = rsrcRtNext;
774                             }
775
776                             for (OCResourceInterface *rsrcPtr = resource1->rsrcInterface, *rsrcNext = NULL; rsrcPtr; )
777                             {
778                                 rsrcNext = rsrcPtr->next;
779                                 OICFree(rsrcPtr->name);
780                                 OICFree(rsrcPtr);
781                                 rsrcPtr = rsrcNext;
782                             }
783                             foundResourceAtRD = true;
784                         }
785 #endif
786                         if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
787                         {
788                             discoveryResult = BuildVirtualResourceResponse(resource,
789                                 discPayload, &request->devAddr, false);
790                         }
791                     }
792                     // Set discoveryResult appropriately if no 'valid' resources are available
793                     if (discPayload->resources == NULL && !foundResourceAtRD)
794                     {
795                         discoveryResult = OC_STACK_NO_RESOURCE;
796                     }
797                 }
798             }
799             else
800             {
801                 discoveryResult = OC_STACK_NO_MEMORY;
802             }
803         }
804         else
805         {
806             OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
807         }
808         if (interfaceQueryAllocated)
809         {
810             OICFree(interfaceQuery);
811         }
812     }
813     else if (virtualUriInRequest == OC_DEVICE_URI)
814     {
815         const char* deviceId = OCGetServerInstanceIDString();
816         if (!deviceId)
817         {
818             discoveryResult = OC_STACK_ERROR;
819         }
820         else
821         {
822             payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
823                 savedDeviceInfo.types, OC_SPEC_VERSION, OC_DATA_MODEL_VERSION);
824             if (!payload)
825             {
826                 discoveryResult = OC_STACK_NO_MEMORY;
827             }
828             else
829             {
830                 discoveryResult = OC_STACK_OK;
831             }
832         }
833     }
834     else if (virtualUriInRequest == OC_PLATFORM_URI)
835     {
836         payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
837         if (!payload)
838         {
839             discoveryResult = OC_STACK_NO_MEMORY;
840         }
841         else
842         {
843             discoveryResult = OC_STACK_OK;
844         }
845     }
846 #ifdef ROUTING_GATEWAY
847     else if (OC_GATEWAY_URI == virtualUriInRequest)
848     {
849         // Received request for a gateway
850         OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
851         discoveryResult = RMHandleGatewayRequest(request, resource);
852
853     }
854 #endif
855
856     /**
857      * Step 2: Send the discovery response
858      *
859      * Iotivity should respond to discovery requests in below manner:
860      * 1)If query filter matching fails and discovery request is multicast,
861      *   it should NOT send any response.
862      * 2)If query filter matching fails and discovery request is unicast,
863      *   it should send an error(RESOURCE_NOT_FOUND - 404) response.
864      * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
865      *   request is multicast, it should NOT send any response.
866      * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
867      *   request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
868      */
869
870 #ifdef WITH_PRESENCE
871     if ((virtualUriInRequest == OC_PRESENCE) &&
872         (resource->resourceProperties & OC_ACTIVE))
873     {
874         // Presence uses observer notification api to respond via SendPresenceNotification.
875         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
876     }
877     else
878     #endif
879 #ifdef ROUTING_GATEWAY
880     // Gateway uses the RMHandleGatewayRequest to respond to the request.
881     if (OC_GATEWAY_URI != virtualUriInRequest)
882 #endif
883     {
884         if(discoveryResult == OC_STACK_OK)
885         {
886             SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
887         }
888         else if(bMulticast == false && (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
889                (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
890         {
891             OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d)  \
892                 discovery request", discoveryResult, virtualUriInRequest);
893             SendNonPersistantDiscoveryResponse(request, resource, NULL,
894                 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
895         }
896         else
897         {
898             // Ignoring the discovery request as per RFC 7252, Section #8.2
899             OIC_LOG(INFO, TAG, "Silently ignoring the request since device does not have \
900                 any useful data to send");
901         }
902     }
903
904     OCPayloadDestroy(payload);
905
906     return OC_STACK_OK;
907 }
908
909 static OCStackResult
910 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
911 {
912     if(!request)
913     {
914         return OC_STACK_INVALID_PARAM;
915     }
916
917     OCStackResult result = OC_STACK_OK;
918     OCEntityHandlerResult ehResult = OC_EH_ERROR;
919     OCEntityHandlerRequest ehRequest = {0};
920
921     OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
922     result = FormOCEntityHandlerRequest(&ehRequest,
923                                         (OCRequestHandle) request,
924                                         request->method,
925                                         &request->devAddr,
926                                         (OCResourceHandle) NULL, request->query,
927                                         PAYLOAD_TYPE_REPRESENTATION,
928                                         request->payload,
929                                         request->payloadSize,
930                                         request->numRcvdVendorSpecificHeaderOptions,
931                                         request->rcvdVendorSpecificHeaderOptions,
932                                         (OCObserveAction)request->observationOption,
933                                         (OCObservationId)0);
934     VERIFY_SUCCESS(result, OC_STACK_OK);
935
936     // At this point we know for sure that defaultDeviceHandler exists
937     ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
938                                   (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
939     if(ehResult == OC_EH_SLOW)
940     {
941         OIC_LOG(INFO, TAG, "This is a slow resource");
942         request->slowFlag = 1;
943     }
944     else if(ehResult == OC_EH_ERROR)
945     {
946         FindAndDeleteServerRequest(request);
947     }
948     result = EntityHandlerCodeToOCStackCode(ehResult);
949 exit:
950     OCPayloadDestroy(ehRequest.payload);
951     return result;
952 }
953
954 static OCStackResult
955 HandleResourceWithEntityHandler (OCServerRequest *request,
956                                  OCResource *resource,
957                                  uint8_t collectionResource)
958 {
959     if(!request || ! resource)
960     {
961         return OC_STACK_INVALID_PARAM;
962     }
963
964     OCStackResult result = OC_STACK_ERROR;
965     OCEntityHandlerResult ehResult = OC_EH_ERROR;
966     OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
967     ResourceObserver *resObs = NULL;
968
969     OCEntityHandlerRequest ehRequest = {0};
970
971     OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
972     OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
973     // check the security resource
974     if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
975     {
976         type = PAYLOAD_TYPE_SECURITY;
977
978     }
979
980     if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
981     {
982         type = PAYLOAD_TYPE_RD;
983     }
984
985     result = FormOCEntityHandlerRequest(&ehRequest,
986                                         (OCRequestHandle)request,
987                                         request->method,
988                                         &request->devAddr,
989                                         (OCResourceHandle)resource,
990                                         request->query,
991                                         type,
992                                         request->payload,
993                                         request->payloadSize,
994                                         request->numRcvdVendorSpecificHeaderOptions,
995                                         request->rcvdVendorSpecificHeaderOptions,
996                                         (OCObserveAction)request->observationOption,
997                                         0);
998     VERIFY_SUCCESS(result, OC_STACK_OK);
999
1000     if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
1001     {
1002         OIC_LOG(INFO, TAG, "No observation requested");
1003         ehFlag = OC_REQUEST_FLAG;
1004     }
1005     else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
1006     {
1007         OIC_LOG(INFO, TAG, "Observation registration requested");
1008
1009         ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
1010                                     request->tokenLength);
1011
1012         if (obs)
1013         {
1014             OIC_LOG (INFO, TAG, "Observer with this token already present");
1015             OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
1016             OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
1017             OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
1018
1019             // server requests are usually free'd when the response is sent out
1020             // for the request in ocserverrequest.c : HandleSingleResponse()
1021             // Since we are making an early return and not responding, the server request
1022             // needs to be deleted.
1023             FindAndDeleteServerRequest (request);
1024             return OC_STACK_OK;
1025         }
1026
1027         result = GenerateObserverId(&ehRequest.obsInfo.obsId);
1028         VERIFY_SUCCESS(result, OC_STACK_OK);
1029
1030         result = AddObserver ((const char*)(request->resourceUrl),
1031                 (const char *)(request->query),
1032                 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
1033                 resource, request->qos, request->acceptFormat,
1034                 &request->devAddr);
1035
1036         if(result == OC_STACK_OK)
1037         {
1038             OIC_LOG(INFO, TAG, "Added observer successfully");
1039             request->observeResult = OC_STACK_OK;
1040             ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
1041         }
1042         else
1043         {
1044             result = OC_STACK_OK;
1045
1046             // The error in observeResult for the request will be used when responding to this
1047             // request by omitting the observation option/sequence number.
1048             request->observeResult = OC_STACK_ERROR;
1049             OIC_LOG(ERROR, TAG, "Observer Addition failed");
1050             ehFlag = OC_REQUEST_FLAG;
1051         }
1052
1053     }
1054     else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
1055             !collectionResource)
1056     {
1057         OIC_LOG(INFO, TAG, "Deregistering observation requested");
1058
1059         resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1060
1061         if (NULL == resObs)
1062         {
1063             // Stack does not contain this observation request
1064             // Either token is incorrect or observation list is corrupted
1065             result = OC_STACK_ERROR;
1066             goto exit;
1067         }
1068         ehRequest.obsInfo.obsId = resObs->observeId;
1069         ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1070
1071         result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1072
1073         if(result == OC_STACK_OK)
1074         {
1075             OIC_LOG(INFO, TAG, "Removed observer successfully");
1076             request->observeResult = OC_STACK_OK;
1077         }
1078         else
1079         {
1080             result = OC_STACK_OK;
1081             request->observeResult = OC_STACK_ERROR;
1082             OIC_LOG(ERROR, TAG, "Observer Removal failed");
1083         }
1084     }
1085     else
1086     {
1087         result = OC_STACK_ERROR;
1088         goto exit;
1089     }
1090
1091     ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1092     if(ehResult == OC_EH_SLOW)
1093     {
1094         OIC_LOG(INFO, TAG, "This is a slow resource");
1095         request->slowFlag = 1;
1096     }
1097     else if(ehResult == OC_EH_ERROR)
1098     {
1099         FindAndDeleteServerRequest(request);
1100     }
1101     result = EntityHandlerCodeToOCStackCode(ehResult);
1102 exit:
1103     OCPayloadDestroy(ehRequest.payload);
1104     return result;
1105 }
1106
1107 static OCStackResult
1108 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1109                                               OCResource *resource)
1110 {
1111     if(!request || !resource)
1112     {
1113         return OC_STACK_INVALID_PARAM;
1114     }
1115
1116     OCStackResult result = OC_STACK_ERROR;
1117     OCEntityHandlerRequest ehRequest = {0};
1118
1119     result = FormOCEntityHandlerRequest(&ehRequest,
1120                                         (OCRequestHandle)request,
1121                                         request->method,
1122                                         &request->devAddr,
1123                                         (OCResourceHandle)resource,
1124                                         request->query,
1125                                         PAYLOAD_TYPE_REPRESENTATION,
1126                                         request->payload,
1127                                         request->payloadSize,
1128                                         request->numRcvdVendorSpecificHeaderOptions,
1129                                         request->rcvdVendorSpecificHeaderOptions,
1130                                         (OCObserveAction)request->observationOption,
1131                                         (OCObservationId)0);
1132     if(result == OC_STACK_OK)
1133     {
1134         result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1135     }
1136
1137     OCPayloadDestroy(ehRequest.payload);
1138     return result;
1139 }
1140
1141 OCStackResult
1142 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1143 {
1144     OCStackResult ret = OC_STACK_OK;
1145
1146     switch (resHandling)
1147     {
1148         case OC_RESOURCE_VIRTUAL:
1149         {
1150             ret = HandleVirtualResource (request, resource);
1151             break;
1152         }
1153         case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1154         {
1155             ret = HandleDefaultDeviceEntityHandler(request);
1156             break;
1157         }
1158         case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1159         {
1160             OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1161             return OC_STACK_ERROR;
1162         }
1163         case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1164         {
1165             ret = HandleResourceWithEntityHandler (request, resource, 0);
1166             break;
1167         }
1168         case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1169         {
1170             ret = HandleResourceWithEntityHandler (request, resource, 1);
1171             break;
1172         }
1173         case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1174         {
1175             ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1176             break;
1177         }
1178         case OC_RESOURCE_NOT_SPECIFIED:
1179         {
1180             ret = OC_STACK_NO_RESOURCE;
1181             break;
1182         }
1183         default:
1184         {
1185             OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1186             return OC_STACK_ERROR;
1187         }
1188     }
1189     return ret;
1190 }
1191
1192 void DeletePlatformInfo()
1193 {
1194     OIC_LOG(INFO, TAG, "Deleting platform info.");
1195
1196     OICFree(savedPlatformInfo.platformID);
1197     savedPlatformInfo.platformID = NULL;
1198
1199     OICFree(savedPlatformInfo.manufacturerName);
1200     savedPlatformInfo.manufacturerName = NULL;
1201
1202     OICFree(savedPlatformInfo.manufacturerUrl);
1203     savedPlatformInfo.manufacturerUrl = NULL;
1204
1205     OICFree(savedPlatformInfo.modelNumber);
1206     savedPlatformInfo.modelNumber = NULL;
1207
1208     OICFree(savedPlatformInfo.dateOfManufacture);
1209     savedPlatformInfo.dateOfManufacture = NULL;
1210
1211     OICFree(savedPlatformInfo.platformVersion);
1212     savedPlatformInfo.platformVersion = NULL;
1213
1214     OICFree(savedPlatformInfo.operatingSystemVersion);
1215     savedPlatformInfo.operatingSystemVersion = NULL;
1216
1217     OICFree(savedPlatformInfo.hardwareVersion);
1218     savedPlatformInfo.hardwareVersion = NULL;
1219
1220     OICFree(savedPlatformInfo.firmwareVersion);
1221     savedPlatformInfo.firmwareVersion = NULL;
1222
1223     OICFree(savedPlatformInfo.supportUrl);
1224     savedPlatformInfo.supportUrl = NULL;
1225
1226     OICFree(savedPlatformInfo.systemTime);
1227     savedPlatformInfo.systemTime = NULL;
1228 }
1229
1230 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1231 {
1232     savedPlatformInfo.platformID = OICStrdup(info.platformID);
1233     savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1234     savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1235     savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1236     savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1237     savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1238     savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1239     savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1240     savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1241     savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1242     savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1243
1244     if ((!savedPlatformInfo.platformID && info.platformID)||
1245         (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1246         (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1247         (!savedPlatformInfo.modelNumber && info.modelNumber)||
1248         (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1249         (!savedPlatformInfo.platformVersion && info.platformVersion)||
1250         (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1251         (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1252         (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1253         (!savedPlatformInfo.supportUrl && info.supportUrl)||
1254         (!savedPlatformInfo.systemTime && info.systemTime))
1255     {
1256         DeletePlatformInfo();
1257         return OC_STACK_INVALID_PARAM;
1258     }
1259
1260     return OC_STACK_OK;
1261
1262 }
1263
1264 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1265 {
1266     DeletePlatformInfo();
1267
1268     OCStackResult res = DeepCopyPlatFormInfo(info);
1269
1270     if (res != OC_STACK_OK)
1271     {
1272         OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1273     }
1274     else
1275     {
1276         OIC_LOG(INFO, TAG, "Platform info saved.");
1277     }
1278
1279     return res;
1280 }
1281
1282 void DeleteDeviceInfo()
1283 {
1284     OIC_LOG(INFO, TAG, "Deleting device info.");
1285
1286     OICFree(savedDeviceInfo.deviceName);
1287     OCFreeOCStringLL(savedDeviceInfo.types);
1288     savedDeviceInfo.deviceName = NULL;
1289
1290 }
1291
1292 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1293 {
1294     savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1295
1296     if(!savedDeviceInfo.deviceName && info.deviceName)
1297     {
1298         DeleteDeviceInfo();
1299         return OC_STACK_NO_MEMORY;
1300     }
1301
1302     if (info.types)
1303     {
1304         savedDeviceInfo.types = CloneOCStringLL(info.types);
1305         if(!savedDeviceInfo.types && info.types)
1306         {
1307             DeleteDeviceInfo();
1308             return OC_STACK_NO_MEMORY;
1309         }
1310     }
1311     return OC_STACK_OK;
1312 }
1313
1314 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1315 {
1316     OCStackResult res = OC_STACK_OK;
1317
1318     DeleteDeviceInfo();
1319
1320     res = DeepCopyDeviceInfo(info);
1321
1322     VERIFY_SUCCESS(res, OC_STACK_OK);
1323
1324     if (OCGetServerInstanceIDString() == NULL)
1325     {
1326         OIC_LOG(INFO, TAG, "Device ID generation failed");
1327         res =  OC_STACK_ERROR;
1328         goto exit;
1329     }
1330
1331     OIC_LOG(INFO, TAG, "Device initialized successfully.");
1332     return OC_STACK_OK;
1333
1334 exit:
1335     DeleteDeviceInfo();
1336     return res;
1337 }