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         {
 503             return true;
 504         }
 505         interfacePtr = interfacePtr->next;
 506     }
 507
 508     OIC_LOG_V(INFO, TAG, "%s does not contain if=%s.", resource->uri, interfaceFilter);
 509     return false;
 510 }
 511
 512 /*
 513  * If the filters are null, they will be assumed to NOT be present
 514  * and the resource will not be matched against them.
 515  * Function will return true if all non null AND non empty filters passed in find a match.
 516  */
 517 static bool includeThisResourceInResponse(OCResource *resource,
 518                                                  char *interfaceFilter,
 519                                                  char *resourceTypeFilter)
 520 {
 521     if (!resource)
 522     {
 523         OIC_LOG(ERROR, TAG, "Invalid resource");
 524         return false;
 525     }
 526
 527     if ( resource->resourceProperties & OC_EXPLICIT_DISCOVERABLE)
 528     {
 529         /*
 530          * At least one valid filter should be available to
 531          * include the resource in discovery response
 532          */
 533         if (!((interfaceFilter && *interfaceFilter ) ||
 534               (resourceTypeFilter && *resourceTypeFilter)))
 535         {
 536             OIC_LOG_V(INFO, TAG, "%s no query string for EXPLICIT_DISCOVERABLE \
 537                 resource", resource->uri);
 538             return false;
 539         }
 540     }
 541     else if ( !(resource->resourceProperties & OC_ACTIVE) ||
 542          !(resource->resourceProperties & OC_DISCOVERABLE))
 543     {
 544         OIC_LOG_V(INFO, TAG, "%s not ACTIVE or DISCOVERABLE", resource->uri);
 545         return false;
 546     }
 547
 548     return resourceMatchesIFFilter(resource, interfaceFilter) &&
 549            resourceMatchesRTFilter(resource, resourceTypeFilter);
 550
 551 }
 552
 553 OCStackResult SendNonPersistantDiscoveryResponse(OCServerRequest *request, OCResource *resource,
 554                                 OCPayload *discoveryPayload, OCEntityHandlerResult ehResult)
 555 {
 556     OCEntityHandlerResponse response = {0};
 557
 558     response.ehResult = ehResult;
 559     response.payload = discoveryPayload;
 560     response.persistentBufferFlag = 0;
 561     response.requestHandle = (OCRequestHandle) request;
 562     response.resourceHandle = (OCResourceHandle) resource;
 563
 564     return OCDoResponse(&response);
 565 }
 566
 567 #ifdef WITH_RD
 568 static OCStackResult checkResourceExistsAtRD(const char *interfaceType, const char *resourceType,
 569      OCResource **payload, OCDevAddr *devAddr)
 570 {
 571     OCResourceCollectionPayload *repPayload;
 572     if (!payload)
 573     {
 574         return OC_STACK_ERROR;
 575     }
 576     if (OCRDCheckPublishedResource(interfaceType, resourceType, &repPayload, devAddr) == OC_STACK_OK)
 577     {
 578         if (!repPayload)
 579         {
 580             return OC_STACK_ERROR;
 581         }
 582         OCResource *ptr = ((OCResource *) OICCalloc(1, sizeof(OCResource)));
 583         if (!ptr)
 584         {
 585            return OC_STACK_NO_MEMORY;
 586         }
 587
 588         ptr->uri = OICStrdup(repPayload->setLinks->href);
 589         if (!ptr->uri)
 590         {
 591            return OC_STACK_NO_MEMORY;
 592         }
 593         OCStringLL *rt = repPayload->setLinks->rt;
 594         while (rt)
 595         {
 596             OCResourceType *temp = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
 597             if(!temp)
 598             {
 599                 OICFree(ptr->uri);
 600                 return OC_STACK_NO_MEMORY;
 601             }
 602             temp->next = NULL;
 603             temp->resourcetypename = OICStrdup(rt->value);
 604             if (!ptr->rsrcType)
 605             {
 606                 ptr->rsrcType = temp;
 607             }
 608             else
 609             {
 610                 OCResourceType *type = ptr->rsrcType;
 611                 while (type->next)
 612                 {
 613                     type = type->next;
 614                 }
 615                 type->next = temp;
 616             }
 617             rt = rt->next;
 618         }
 619
 620         OCStringLL *itf = repPayload->setLinks->itf;
 621         while (itf)
 622         {
 623             OCResourceInterface *temp = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
 624             if (!temp)
 625             {
 626                 OICFree(ptr->uri);
 627
 628                 return OC_STACK_NO_MEMORY;
 629             }
 630             temp->next = NULL;
 631             temp->name = OICStrdup(itf->value);
 632             if (!ptr->rsrcInterface)
 633             {
 634                 ptr->rsrcInterface = temp;
 635             }
 636             else
 637             {
 638                 OCResourceInterface *type = ptr->rsrcInterface;
 639                 while (type->next)
 640                 {
 641                     type = type->next;
 642                 }
 643                 type->next = temp;
 644             }
 645             itf = itf->next;
 646         }
 647
 648         ptr->resourceProperties = (OCResourceProperty) repPayload->tags->bitmap;
 649
 650         OCFreeCollectionResource(repPayload);
 651         *payload = ptr;
 652         return OC_STACK_OK;
 653     }
 654     else
 655     {
 656         OIC_LOG_V(ERROR, TAG, "The resource type or interface type doe not exist \
 657                              on the resource directory");
 658     }
 659     return OC_STACK_ERROR;
 660 }
 661 #endif
 662
 663 static OCStackResult HandleVirtualResource (OCServerRequest *request, OCResource* resource)
 664 {
 665     if (!request || !resource)
 666     {
 667         return OC_STACK_INVALID_PARAM;
 668     }
 669
 670     OCStackResult discoveryResult = OC_STACK_ERROR;
 671
 672     bool bMulticast    = false;     // Was the discovery request a multicast request?
 673     OCPayload* payload = NULL;
 674
 675     OIC_LOG(INFO, TAG, "Entering HandleVirtualResource");
 676
 677     OCVirtualResources virtualUriInRequest = GetTypeOfVirtualURI (request->resourceUrl);
 678
 679     // Step 1: Generate the response to discovery request
 680     if (virtualUriInRequest == OC_WELL_KNOWN_URI)
 681     {
 682         char *interfaceQuery = NULL;
 683         char *resourceTypeQuery = NULL;
 684
 685         discoveryResult = getQueryParamsForFiltering (virtualUriInRequest, request->query,
 686                 &interfaceQuery, &resourceTypeQuery);
 687
 688         if (discoveryResult == OC_STACK_OK)
 689         {
 690             payload = (OCPayload *)OCDiscoveryPayloadCreate();
 691
 692             if (payload)
 693             {
 694                 ((OCDiscoveryPayload*)payload)->sid = (char *)OICCalloc(1, UUID_STRING_SIZE);
 695                 VERIFY_NON_NULL(((OCDiscoveryPayload*)payload)->sid, ERROR, OC_STACK_NO_MEMORY);
 696                 memcpy(((OCDiscoveryPayload*)payload)->sid, OCGetServerInstanceIDString(), UUID_STRING_SIZE);
 697
 698                 if (interfaceQuery && 0 == strcmp(OC_RSRVD_INTERFACE_LL, interfaceQuery))
 699                 {
 700                     for (; resource && discoveryResult == OC_STACK_OK; resource = resource->next)
 701                     {
 702                         discoveryResult = BuildVirtualResourceResponse(resource,
 703                                 (OCDiscoveryPayload *)payload, &request->devAddr, false);
 704                     }
 705                 }
 706                 else
 707                 {
 708                     bool foundResourceAtRD = false;
 709                     for (;resource && discoveryResult == OC_STACK_OK; resource = resource->next)
 710                     {
 711 #ifdef WITH_RD
 712                         if (strcmp(resource->uri, OC_RSRVD_RD_URI) == 0)
 713                         {
 714                             OCResource *resource1 = NULL;
 715                             OCDevAddr devAddr;
 716                             discoveryResult = checkResourceExistsAtRD(interfaceQuery,
 717                                 resourceTypeQuery, &resource1, &devAddr);
 718                             if (discoveryResult != OC_STACK_OK)
 719                             {
 720                                  break;
 721                             }
 722                             discoveryResult = BuildVirtualResourceResponse(resource1,
 723                                 (OCDiscoveryPayload*)payload, &devAddr, true);
 724                             if (payload)
 725                             {
 726                                 ((OCDiscoveryPayload*)payload)->baseURI = OICStrdup(devAddr.addr);
 727                             }
 728                             OCDiscoveryResourceDestroy(resource1);
 729                             foundResourceAtRD = true;
 730                         }
 731 #endif
 732                         if (!foundResourceAtRD && includeThisResourceInResponse(resource, interfaceQuery, resourceTypeQuery))
 733                         {
 734                             discoveryResult = BuildVirtualResourceResponse(resource,
 735                                 (OCDiscoveryPayload*)payload, &request->devAddr, false);
 736                         }
 737                     }
 738                     // Set discoveryResult appropriately if no 'valid' resources are available
 739                     if (((OCDiscoveryPayload*)payload)->resources == NULL && !foundResourceAtRD)
 740                     {
 741                         discoveryResult = OC_STACK_NO_RESOURCE;
 742                     }
 743                 }
 744             }
 745             else
 746             {
 747                 discoveryResult = OC_STACK_NO_MEMORY;
 748             }
 749         }
 750         else
 751         {
 752             OIC_LOG_V(ERROR, TAG, "Error (%d) parsing query.", discoveryResult);
 753         }
 754     }
 755     else if (virtualUriInRequest == OC_DEVICE_URI)
 756     {
 757         const char* deviceId = OCGetServerInstanceIDString();
 758         if (!deviceId)
 759         {
 760             discoveryResult = OC_STACK_ERROR;
 761         }
 762         else
 763         {
 764             payload = (OCPayload*) OCDevicePayloadCreate(deviceId, savedDeviceInfo.deviceName,
 765                 savedDeviceInfo.types, OC_SPEC_VERSION, OC_DATA_MODEL_VERSION);
 766             if (!payload)
 767             {
 768                 discoveryResult = OC_STACK_NO_MEMORY;
 769             }
 770             else
 771             {
 772                 discoveryResult = OC_STACK_OK;
 773             }
 774         }
 775     }
 776     else if (virtualUriInRequest == OC_PLATFORM_URI)
 777     {
 778         payload = (OCPayload*)OCPlatformPayloadCreate(&savedPlatformInfo);
 779         if (!payload)
 780         {
 781             discoveryResult = OC_STACK_NO_MEMORY;
 782         }
 783         else
 784         {
 785             discoveryResult = OC_STACK_OK;
 786         }
 787     }
 788 #ifdef ROUTING_GATEWAY
 789     else if (OC_GATEWAY_URI == virtualUriInRequest)
 790     {
 791         // Received request for a gateway
 792         OIC_LOG(INFO, TAG, "Request is for Gateway Virtual Request");
 793         discoveryResult = RMHandleGatewayRequest(request, resource);
 794
 795     }
 796 #endif
 797
 798     /**
 799      * Step 2: Send the discovery response
 800      *
 801      * Iotivity should respond to discovery requests in below manner:
 802      * 1)If query filter matching fails and discovery request is multicast,
 803      *   it should NOT send any response.
 804      * 2)If query filter matching fails and discovery request is unicast,
 805      *   it should send an error(RESOURCE_NOT_FOUND - 404) response.
 806      * 3)If Server does not have any 'DISCOVERABLE' resources and discovery
 807      *   request is multicast, it should NOT send any response.
 808      * 4)If Server does not have any 'DISCOVERABLE' resources and discovery
 809      *   request is unicast, it should send an error(RESOURCE_NOT_FOUND - 404) response.
 810      */
 811
 812 #ifdef WITH_PRESENCE
 813     if ((virtualUriInRequest == OC_PRESENCE) &&
 814         (resource->resourceProperties & OC_ACTIVE))
 815     {
 816         // Presence uses observer notification api to respond via SendPresenceNotification.
 817         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
 818     }
 819     else
 820     #endif
 821 #ifdef ROUTING_GATEWAY
 822     // Gateway uses the RMHandleGatewayRequest to respond to the request.
 823     if (OC_GATEWAY_URI != virtualUriInRequest)
 824 #endif
 825     {
 826         if(discoveryResult == OC_STACK_OK)
 827         {
 828             SendNonPersistantDiscoveryResponse(request, resource, payload, OC_EH_OK);
 829         }
 830         else if(bMulticast == false && (request->devAddr.adapter != OC_ADAPTER_RFCOMM_BTEDR) &&
 831                (request->devAddr.adapter != OC_ADAPTER_GATT_BTLE))
 832         {
 833             OIC_LOG_V(ERROR, TAG, "Sending a (%d) error to (%d)  \
 834                 discovery request", discoveryResult, virtualUriInRequest);
 835             SendNonPersistantDiscoveryResponse(request, resource, NULL,
 836                 (discoveryResult == OC_STACK_NO_RESOURCE) ? OC_EH_RESOURCE_NOT_FOUND : OC_EH_ERROR);
 837         }
 838         else
 839         {
 840             // Ignoring the discovery request as per RFC 7252, Section #8.2
 841             OIC_LOG(INFO, TAG, "Silently ignoring the request since device does not have \
 842                 any useful data to send");
 843         }
 844     }
 845
 846     OCPayloadDestroy(payload);
 847
 848     return OC_STACK_OK;
 849 }
 850
 851 static OCStackResult
 852 HandleDefaultDeviceEntityHandler (OCServerRequest *request)
 853 {
 854     if(!request)
 855     {
 856         return OC_STACK_INVALID_PARAM;
 857     }
 858
 859     OCStackResult result = OC_STACK_OK;
 860     OCEntityHandlerResult ehResult = OC_EH_ERROR;
 861     OCEntityHandlerRequest ehRequest = {0};
 862
 863     OIC_LOG(INFO, TAG, "Entering HandleResourceWithDefaultDeviceEntityHandler");
 864     result = FormOCEntityHandlerRequest(&ehRequest,
 865                                         (OCRequestHandle) request,
 866                                         request->method,
 867                                         &request->devAddr,
 868                                         (OCResourceHandle) NULL, request->query,
 869                                         PAYLOAD_TYPE_REPRESENTATION,
 870                                         request->payload,
 871                                         request->payloadSize,
 872                                         request->numRcvdVendorSpecificHeaderOptions,
 873                                         request->rcvdVendorSpecificHeaderOptions,
 874                                         (OCObserveAction)request->observationOption,
 875                                         (OCObservationId)0);
 876     VERIFY_SUCCESS(result, OC_STACK_OK);
 877
 878     // At this point we know for sure that defaultDeviceHandler exists
 879     ehResult = defaultDeviceHandler(OC_REQUEST_FLAG, &ehRequest,
 880                                   (char*) request->resourceUrl, defaultDeviceHandlerCallbackParameter);
 881     if(ehResult == OC_EH_SLOW)
 882     {
 883         OIC_LOG(INFO, TAG, "This is a slow resource");
 884         request->slowFlag = 1;
 885     }
 886     else if(ehResult == OC_EH_ERROR)
 887     {
 888         FindAndDeleteServerRequest(request);
 889     }
 890     result = EntityHandlerCodeToOCStackCode(ehResult);
 891 exit:
 892     OCPayloadDestroy(ehRequest.payload);
 893     return result;
 894 }
 895
 896 static OCStackResult
 897 HandleResourceWithEntityHandler (OCServerRequest *request,
 898                                  OCResource *resource,
 899                                  uint8_t collectionResource)
 900 {
 901     if(!request || ! resource)
 902     {
 903         return OC_STACK_INVALID_PARAM;
 904     }
 905
 906     OCStackResult result = OC_STACK_ERROR;
 907     OCEntityHandlerResult ehResult = OC_EH_ERROR;
 908     OCEntityHandlerFlag ehFlag = OC_REQUEST_FLAG;
 909     ResourceObserver *resObs = NULL;
 910
 911     OCEntityHandlerRequest ehRequest = {0};
 912
 913     OIC_LOG(INFO, TAG, "Entering HandleResourceWithEntityHandler");
 914     OCPayloadType type = PAYLOAD_TYPE_REPRESENTATION;
 915     // check the security resource
 916     if (request && request->resourceUrl && SRMIsSecurityResourceURI(request->resourceUrl))
 917     {
 918         type = PAYLOAD_TYPE_SECURITY;
 919
 920     }
 921
 922     if (request && strcmp(request->resourceUrl, OC_RSRVD_RD_URI) == 0)
 923     {
 924         type = PAYLOAD_TYPE_RD;
 925     }
 926
 927     result = FormOCEntityHandlerRequest(&ehRequest,
 928                                         (OCRequestHandle)request,
 929                                         request->method,
 930                                         &request->devAddr,
 931                                         (OCResourceHandle)resource,
 932                                         request->query,
 933                                         type,
 934                                         request->payload,
 935                                         request->payloadSize,
 936                                         request->numRcvdVendorSpecificHeaderOptions,
 937                                         request->rcvdVendorSpecificHeaderOptions,
 938                                         (OCObserveAction)request->observationOption,
 939                                         0);
 940     VERIFY_SUCCESS(result, OC_STACK_OK);
 941
 942     if(ehRequest.obsInfo.action == OC_OBSERVE_NO_OPTION)
 943     {
 944         OIC_LOG(INFO, TAG, "No observation requested");
 945         ehFlag = OC_REQUEST_FLAG;
 946     }
 947     else if(ehRequest.obsInfo.action == OC_OBSERVE_REGISTER && !collectionResource)
 948     {
 949         OIC_LOG(INFO, TAG, "Observation registration requested");
 950
 951         ResourceObserver *obs = GetObserverUsingToken (request->requestToken,
 952                                     request->tokenLength);
 953
 954         if (obs)
 955         {
 956             OIC_LOG (INFO, TAG, "Observer with this token already present");
 957             OIC_LOG (INFO, TAG, "Possibly re-transmitted CON OBS request");
 958             OIC_LOG (INFO, TAG, "Not adding observer. Not responding to client");
 959             OIC_LOG (INFO, TAG, "The first request for this token is already ACKED.");
 960
 961             // server requests are usually free'd when the response is sent out
 962             // for the request in ocserverrequest.c : HandleSingleResponse()
 963             // Since we are making an early return and not responding, the server request
 964             // needs to be deleted.
 965             FindAndDeleteServerRequest (request);
 966             return OC_STACK_OK;
 967         }
 968
 969         result = GenerateObserverId(&ehRequest.obsInfo.obsId);
 970         VERIFY_SUCCESS(result, OC_STACK_OK);
 971
 972         result = AddObserver ((const char*)(request->resourceUrl),
 973                 (const char *)(request->query),
 974                 ehRequest.obsInfo.obsId, request->requestToken, request->tokenLength,
 975                 resource, request->qos, request->acceptFormat,
 976                 &request->devAddr);
 977
 978         if(result == OC_STACK_OK)
 979         {
 980             OIC_LOG(INFO, TAG, "Added observer successfully");
 981             request->observeResult = OC_STACK_OK;
 982             ehFlag = (OCEntityHandlerFlag)(OC_REQUEST_FLAG | OC_OBSERVE_FLAG);
 983         }
 984         else
 985         {
 986             result = OC_STACK_OK;
 987
 988             // The error in observeResult for the request will be used when responding to this
 989             // request by omitting the observation option/sequence number.
 990             request->observeResult = OC_STACK_ERROR;
 991             OIC_LOG(ERROR, TAG, "Observer Addition failed");
 992             ehFlag = OC_REQUEST_FLAG;
 993         }
 994
 995     }
 996     else if(ehRequest.obsInfo.action == OC_OBSERVE_DEREGISTER &&
 997             !collectionResource)
 998     {
 999         OIC_LOG(INFO, TAG, "Deregistering observation requested");
1000
1001         resObs = GetObserverUsingToken (request->requestToken, request->tokenLength);
1002
1003         if (NULL == resObs)
1004         {
1005             // Stack does not contain this observation request
1006             // Either token is incorrect or observation list is corrupted
1007             result = OC_STACK_ERROR;
1008             goto exit;
1009         }
1010         ehRequest.obsInfo.obsId = resObs->observeId;
1011         ehFlag = (OCEntityHandlerFlag)(ehFlag | OC_OBSERVE_FLAG);
1012
1013         result = DeleteObserverUsingToken (request->requestToken, request->tokenLength);
1014
1015         if(result == OC_STACK_OK)
1016         {
1017             OIC_LOG(INFO, TAG, "Removed observer successfully");
1018             request->observeResult = OC_STACK_OK;
1019         }
1020         else
1021         {
1022             result = OC_STACK_OK;
1023             request->observeResult = OC_STACK_ERROR;
1024             OIC_LOG(ERROR, TAG, "Observer Removal failed");
1025         }
1026     }
1027     else
1028     {
1029         result = OC_STACK_ERROR;
1030         goto exit;
1031     }
1032
1033     ehResult = resource->entityHandler(ehFlag, &ehRequest, resource->entityHandlerCallbackParam);
1034     if(ehResult == OC_EH_SLOW)
1035     {
1036         OIC_LOG(INFO, TAG, "This is a slow resource");
1037         request->slowFlag = 1;
1038     }
1039     else if(ehResult == OC_EH_ERROR)
1040     {
1041         FindAndDeleteServerRequest(request);
1042     }
1043     result = EntityHandlerCodeToOCStackCode(ehResult);
1044 exit:
1045     OCPayloadDestroy(ehRequest.payload);
1046     return result;
1047 }
1048
1049 static OCStackResult
1050 HandleCollectionResourceDefaultEntityHandler (OCServerRequest *request,
1051                                               OCResource *resource)
1052 {
1053     if(!request || !resource)
1054     {
1055         return OC_STACK_INVALID_PARAM;
1056     }
1057
1058     OCStackResult result = OC_STACK_ERROR;
1059     OCEntityHandlerRequest ehRequest = {0};
1060
1061     result = FormOCEntityHandlerRequest(&ehRequest,
1062                                         (OCRequestHandle)request,
1063                                         request->method,
1064                                         &request->devAddr,
1065                                         (OCResourceHandle)resource,
1066                                         request->query,
1067                                         PAYLOAD_TYPE_REPRESENTATION,
1068                                         request->payload,
1069                                         request->payloadSize,
1070                                         request->numRcvdVendorSpecificHeaderOptions,
1071                                         request->rcvdVendorSpecificHeaderOptions,
1072                                         (OCObserveAction)request->observationOption,
1073                                         (OCObservationId)0);
1074     if(result == OC_STACK_OK)
1075     {
1076         result = DefaultCollectionEntityHandler (OC_REQUEST_FLAG, &ehRequest);
1077     }
1078
1079     OCPayloadDestroy(ehRequest.payload);
1080     return result;
1081 }
1082
1083 OCStackResult
1084 ProcessRequest(ResourceHandling resHandling, OCResource *resource, OCServerRequest *request)
1085 {
1086     OCStackResult ret = OC_STACK_OK;
1087
1088     switch (resHandling)
1089     {
1090         case OC_RESOURCE_VIRTUAL:
1091         {
1092             ret = HandleVirtualResource (request, resource);
1093             break;
1094         }
1095         case OC_RESOURCE_DEFAULT_DEVICE_ENTITYHANDLER:
1096         {
1097             ret = HandleDefaultDeviceEntityHandler(request);
1098             break;
1099         }
1100         case OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER:
1101         {
1102             OIC_LOG(INFO, TAG, "OC_RESOURCE_NOT_COLLECTION_DEFAULT_ENTITYHANDLER");
1103             return OC_STACK_ERROR;
1104         }
1105         case OC_RESOURCE_NOT_COLLECTION_WITH_ENTITYHANDLER:
1106         {
1107             ret = HandleResourceWithEntityHandler (request, resource, 0);
1108             break;
1109         }
1110         case OC_RESOURCE_COLLECTION_WITH_ENTITYHANDLER:
1111         {
1112             ret = HandleResourceWithEntityHandler (request, resource, 1);
1113             break;
1114         }
1115         case OC_RESOURCE_COLLECTION_DEFAULT_ENTITYHANDLER:
1116         {
1117             ret = HandleCollectionResourceDefaultEntityHandler (request, resource);
1118             break;
1119         }
1120         case OC_RESOURCE_NOT_SPECIFIED:
1121         {
1122             ret = OC_STACK_NO_RESOURCE;
1123             break;
1124         }
1125         default:
1126         {
1127             OIC_LOG(INFO, TAG, "Invalid Resource Determination");
1128             return OC_STACK_ERROR;
1129         }
1130     }
1131     return ret;
1132 }
1133
1134 void DeletePlatformInfo()
1135 {
1136     OIC_LOG(INFO, TAG, "Deleting platform info.");
1137
1138     OICFree(savedPlatformInfo.platformID);
1139     savedPlatformInfo.platformID = NULL;
1140
1141     OICFree(savedPlatformInfo.manufacturerName);
1142     savedPlatformInfo.manufacturerName = NULL;
1143
1144     OICFree(savedPlatformInfo.manufacturerUrl);
1145     savedPlatformInfo.manufacturerUrl = NULL;
1146
1147     OICFree(savedPlatformInfo.modelNumber);
1148     savedPlatformInfo.modelNumber = NULL;
1149
1150     OICFree(savedPlatformInfo.dateOfManufacture);
1151     savedPlatformInfo.dateOfManufacture = NULL;
1152
1153     OICFree(savedPlatformInfo.platformVersion);
1154     savedPlatformInfo.platformVersion = NULL;
1155
1156     OICFree(savedPlatformInfo.operatingSystemVersion);
1157     savedPlatformInfo.operatingSystemVersion = NULL;
1158
1159     OICFree(savedPlatformInfo.hardwareVersion);
1160     savedPlatformInfo.hardwareVersion = NULL;
1161
1162     OICFree(savedPlatformInfo.firmwareVersion);
1163     savedPlatformInfo.firmwareVersion = NULL;
1164
1165     OICFree(savedPlatformInfo.supportUrl);
1166     savedPlatformInfo.supportUrl = NULL;
1167
1168     OICFree(savedPlatformInfo.systemTime);
1169     savedPlatformInfo.systemTime = NULL;
1170 }
1171
1172 static OCStackResult DeepCopyPlatFormInfo(OCPlatformInfo info)
1173 {
1174     savedPlatformInfo.platformID = OICStrdup(info.platformID);
1175     savedPlatformInfo.manufacturerName = OICStrdup(info.manufacturerName);
1176     savedPlatformInfo.manufacturerUrl = OICStrdup(info.manufacturerUrl);
1177     savedPlatformInfo.modelNumber = OICStrdup(info.modelNumber);
1178     savedPlatformInfo.dateOfManufacture = OICStrdup(info.dateOfManufacture);
1179     savedPlatformInfo.platformVersion = OICStrdup(info.platformVersion);
1180     savedPlatformInfo.operatingSystemVersion = OICStrdup(info.operatingSystemVersion);
1181     savedPlatformInfo.hardwareVersion = OICStrdup(info.hardwareVersion);
1182     savedPlatformInfo.firmwareVersion = OICStrdup(info.firmwareVersion);
1183     savedPlatformInfo.supportUrl = OICStrdup(info.supportUrl);
1184     savedPlatformInfo.systemTime = OICStrdup(info.systemTime);
1185
1186     if ((!savedPlatformInfo.platformID && info.platformID)||
1187         (!savedPlatformInfo.manufacturerName && info.manufacturerName)||
1188         (!savedPlatformInfo.manufacturerUrl && info.manufacturerUrl)||
1189         (!savedPlatformInfo.modelNumber && info.modelNumber)||
1190         (!savedPlatformInfo.dateOfManufacture && info.dateOfManufacture)||
1191         (!savedPlatformInfo.platformVersion && info.platformVersion)||
1192         (!savedPlatformInfo.operatingSystemVersion && info.operatingSystemVersion)||
1193         (!savedPlatformInfo.hardwareVersion && info.hardwareVersion)||
1194         (!savedPlatformInfo.firmwareVersion && info.firmwareVersion)||
1195         (!savedPlatformInfo.supportUrl && info.supportUrl)||
1196         (!savedPlatformInfo.systemTime && info.systemTime))
1197     {
1198         DeletePlatformInfo();
1199         return OC_STACK_INVALID_PARAM;
1200     }
1201
1202     return OC_STACK_OK;
1203
1204 }
1205
1206 OCStackResult SavePlatformInfo(OCPlatformInfo info)
1207 {
1208     DeletePlatformInfo();
1209
1210     OCStackResult res = DeepCopyPlatFormInfo(info);
1211
1212     if (res != OC_STACK_OK)
1213     {
1214         OIC_LOG_V(ERROR, TAG, "Failed to save platform info. errno(%d)", res);
1215     }
1216     else
1217     {
1218         OIC_LOG(INFO, TAG, "Platform info saved.");
1219     }
1220
1221     return res;
1222 }
1223
1224 void DeleteDeviceInfo()
1225 {
1226     OIC_LOG(INFO, TAG, "Deleting device info.");
1227
1228     OICFree(savedDeviceInfo.deviceName);
1229     OCFreeOCStringLL(savedDeviceInfo.types);
1230     savedDeviceInfo.deviceName = NULL;
1231
1232 }
1233
1234 static OCStackResult DeepCopyDeviceInfo(OCDeviceInfo info)
1235 {
1236     savedDeviceInfo.deviceName = OICStrdup(info.deviceName);
1237
1238     if(!savedDeviceInfo.deviceName && info.deviceName)
1239     {
1240         DeleteDeviceInfo();
1241         return OC_STACK_NO_MEMORY;
1242     }
1243
1244     if (info.types)
1245     {
1246         savedDeviceInfo.types = CloneOCStringLL(info.types);
1247         if(!savedDeviceInfo.types && info.types)
1248         {
1249             DeleteDeviceInfo();
1250             return OC_STACK_NO_MEMORY;
1251         }
1252     }
1253     return OC_STACK_OK;
1254 }
1255
1256 OCStackResult SaveDeviceInfo(OCDeviceInfo info)
1257 {
1258     OCStackResult res = OC_STACK_OK;
1259
1260     DeleteDeviceInfo();
1261
1262     res = DeepCopyDeviceInfo(info);
1263
1264     VERIFY_SUCCESS(res, OC_STACK_OK);
1265
1266     if (OCGetServerInstanceIDString() == NULL)
1267     {
1268         OIC_LOG(INFO, TAG, "Device ID generation failed");
1269         res =  OC_STACK_ERROR;
1270         goto exit;
1271     }
1272
1273     OIC_LOG(INFO, TAG, "Device initialized successfully.");
1274     return OC_STACK_OK;
1275
1276 exit:
1277     DeleteDeviceInfo();
1278     return res;
1279 }