resource/csdk/stack/src/ocstack.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
  22 //-----------------------------------------------------------------------------
  23 // Includes
  24 //-----------------------------------------------------------------------------
  25
  26 // Defining _POSIX_C_SOURCE macro with 200112L (or greater) as value
  27 // causes header files to expose definitions
  28 // corresponding to the POSIX.1-2001 base
  29 // specification (excluding the XSI extension).
  30 // For POSIX.1-2001 base specification,
  31 // Refer http://pubs.opengroup.org/onlinepubs/009695399/
  32 #define _POSIX_C_SOURCE 200112L
  33 #include <string.h>
  34 #include <ctype.h>
  35
  36 #include "ocstack.h"
  37 #include "ocstackinternal.h"
  38 #include "ocresourcehandler.h"
  39 #include "occlientcb.h"
  40 #include "ocobserve.h"
  41 #include "ocrandom.h"
  42 #include "oic_malloc.h"
  43 #include "oic_string.h"
  44 #include "ocserverrequest.h"
  45 #include "secureresourcemanager.h"
  46 #include "cacommon.h"
  47 #include "cainterface.h"
  48 #include "ocpayload.h"
  49 #include "ocpayloadcbor.h"
  50
  51 #ifdef WITH_ARDUINO
  52 #include "Time.h"
  53 #else
  54 #include <sys/time.h>
  55 #endif
  56 #include "coap_time.h"
  57 #include "utlist.h"
  58 #include "pdu.h"
  59
  60 #ifndef ARDUINO
  61 #include <arpa/inet.h>
  62 #endif
  63
  64 #ifndef UINT32_MAX
  65 #define UINT32_MAX   (0xFFFFFFFFUL)
  66 #endif
  67
  68 //-----------------------------------------------------------------------------
  69 // Typedefs
  70 //-----------------------------------------------------------------------------
  71 typedef enum
  72 {
  73     OC_STACK_UNINITIALIZED = 0,
  74     OC_STACK_INITIALIZED,
  75     OC_STACK_UNINIT_IN_PROGRESS
  76 } OCStackState;
  77
  78 #ifdef WITH_PRESENCE
  79 typedef enum
  80 {
  81     OC_PRESENCE_UNINITIALIZED = 0,
  82     OC_PRESENCE_INITIALIZED
  83 } OCPresenceState;
  84 #endif
  85
  86 //-----------------------------------------------------------------------------
  87 // Private variables
  88 //-----------------------------------------------------------------------------
  89 static OCStackState stackState = OC_STACK_UNINITIALIZED;
  90
  91 OCResource *headResource = NULL;
  92 static OCResource *tailResource = NULL;
  93 #ifdef WITH_PRESENCE
  94 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
  95 static PresenceResource presenceResource;
  96 static uint8_t PresenceTimeOutSize = 0;
  97 static uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
  98 #endif
  99
 100 static OCMode myStackMode;
 101 #ifdef RA_ADAPTER
 102 //TODO: revisit this design
 103 static bool gRASetInfo = false;
 104 #endif
 105 OCDeviceEntityHandler defaultDeviceHandler;
 106 void* defaultDeviceHandlerCallbackParameter = NULL;
 107
 108 //-----------------------------------------------------------------------------
 109 // Macros
 110 //-----------------------------------------------------------------------------
 111 #define TAG  PCF("OCStack")
 112 #define VERIFY_SUCCESS(op, successCode) { if ((op) != (successCode)) \
 113             {OC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
 114 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OC_LOG((logLevel), \
 115              TAG, PCF(#arg " is NULL")); return (retVal); } }
 116 #define VERIFY_NON_NULL_NR(arg, logLevel) { if (!(arg)) { OC_LOG((logLevel), \
 117              TAG, PCF(#arg " is NULL")); return; } }
 118 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OC_LOG_V(FATAL, TAG, "%s is NULL", #arg);\
 119     goto exit;} }
 120
 121 //TODO: we should allow the server to define this
 122 #define MAX_OBSERVE_AGE (0x2FFFFUL)
 123
 124 #define MILLISECONDS_PER_SECOND   (1000)
 125
 126 //-----------------------------------------------------------------------------
 127 // Private internal function prototypes
 128 //-----------------------------------------------------------------------------
 129
 130 /**
 131  * Generate handle of OCDoResource invocation for callback management.
 132  *
 133  * @return Generated OCDoResource handle.
 134  */
 135 static OCDoHandle GenerateInvocationHandle();
 136
 137 /**
 138  * Initialize resource data structures, variables, etc.
 139  *
 140  * @return ::OC_STACK_OK on success, some other value upon failure.
 141  */
 142 static OCStackResult initResources();
 143
 144 /**
 145  * Add a resource to the end of the linked list of resources.
 146  *
 147  * @param resource Resource to be added
 148  */
 149 static void insertResource(OCResource *resource);
 150
 151 /**
 152  * Find a resource in the linked list of resources.
 153  *
 154  * @param resource Resource to be found.
 155  * @return Pointer to resource that was found in the linked list or NULL if the resource was not
 156  *         found.
 157  */
 158 static OCResource *findResource(OCResource *resource);
 159
 160 /**
 161  * Insert a resource type into a resource's resource type linked list.
 162  * If resource type already exists, it will not be inserted and the
 163  * resourceType will be free'd.
 164  * resourceType->next should be null to avoid memory leaks.
 165  * Function returns silently for null args.
 166  *
 167  * @param resource Resource where resource type is to be inserted.
 168  * @param resourceType Resource type to be inserted.
 169  */
 170 static void insertResourceType(OCResource *resource,
 171         OCResourceType *resourceType);
 172
 173 /**
 174  * Get a resource type at the specified index within a resource.
 175  *
 176  * @param handle Handle of resource.
 177  * @param index Index of resource type.
 178  *
 179  * @return Pointer to resource type if found, NULL otherwise.
 180  */
 181 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
 182         uint8_t index);
 183
 184 /**
 185  * Insert a resource interface into a resource's resource interface linked list.
 186  * If resource interface already exists, it will not be inserted and the
 187  * resourceInterface will be free'd.
 188  * resourceInterface->next should be null to avoid memory leaks.
 189  *
 190  * @param resource Resource where resource interface is to be inserted.
 191  * @param resourceInterface Resource interface to be inserted.
 192  */
 193 static void insertResourceInterface(OCResource *resource,
 194         OCResourceInterface *resourceInterface);
 195
 196 /**
 197  * Get a resource interface at the specified index within a resource.
 198  *
 199  * @param handle Handle of resource.
 200  * @param index Index of resource interface.
 201  *
 202  * @return Pointer to resource interface if found, NULL otherwise.
 203  */
 204 static OCResourceInterface *findResourceInterfaceAtIndex(
 205         OCResourceHandle handle, uint8_t index);
 206
 207 /**
 208  * Delete all of the dynamically allocated elements that were created for the resource type.
 209  *
 210  * @param resourceType Specified resource type.
 211  */
 212 static void deleteResourceType(OCResourceType *resourceType);
 213
 214 /**
 215  * Delete all of the dynamically allocated elements that were created for the resource interface.
 216  *
 217  * @param resourceInterface Specified resource interface.
 218  */
 219 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
 220
 221 /**
 222  * Delete all of the dynamically allocated elements that were created for the resource.
 223  *
 224  * @param resource Specified resource.
 225  */
 226 static void deleteResourceElements(OCResource *resource);
 227
 228 /**
 229  * Delete resource specified by handle.  Deletes resource and all resourcetype and resourceinterface
 230  * linked lists.
 231  *
 232  * @param handle Handle of resource to be deleted.
 233  *
 234  * @return ::OC_STACK_OK on success, some other value upon failure.
 235  */
 236 static OCStackResult deleteResource(OCResource *resource);
 237
 238 /**
 239  * Delete all of the resources in the resource list.
 240  */
 241 static void deleteAllResources();
 242
 243 /**
 244  * Increment resource sequence number.  Handles rollover.
 245  *
 246  * @param resPtr Pointer to resource.
 247  */
 248 static void incrementSequenceNumber(OCResource * resPtr);
 249
 250 /**
 251  * Verify the lengths of the URI and the query separately.
 252  *
 253  * @param inputUri Input URI and query.
 254  * @param uriLen The length of the initial URI with query.
 255  * @return ::OC_STACK_OK on success, some other value upon failure.
 256  */
 257 static OCStackResult verifyUriQueryLength(const char * inputUri,
 258         uint16_t uriLen);
 259
 260 /*
 261  * Attempts to initialize every network interface that the CA Layer might have compiled in.
 262  *
 263  * Note: At least one interface must succeed to initialize. If all calls to @ref CASelectNetwork
 264  * return something other than @ref CA_STATUS_OK, then this function fails.
 265  *
 266  * @return ::CA_STATUS_OK on success, some other value upon failure.
 267  */
 268 static CAResult_t OCSelectNetwork();
 269
 270 /**
 271  * Get the CoAP ticks after the specified number of milli-seconds.
 272  *
 273  * @param afterMilliSeconds Milli-seconds.
 274  * @return
 275  *     CoAP ticks
 276  */
 277 static uint32_t GetTicks(uint32_t afterMilliSeconds);
 278
 279 /**
 280  * Convert CAResponseResult_t to OCStackResult.
 281  *
 282  * @param caCode CAResponseResult_t code.
 283  * @return ::OC_STACK_OK on success, some other value upon failure.
 284  */
 285 static OCStackResult CAToOCStackResult(CAResponseResult_t caCode);
 286
 287 /**
 288  * Convert OCStackResult to CAResponseResult_t.
 289  *
 290  * @param caCode OCStackResult code.
 291  * @return ::CA_SUCCESS on success, some other value upon failure.
 292  */
 293 static CAResponseResult_t OCToCAStackResult(OCStackResult ocCode);
 294
 295 /**
 296  * Convert OCTransportFlags_t to CATransportModifiers_t.
 297  *
 298  * @param ocConType OCTransportFlags_t input.
 299  * @return CATransportFlags
 300  */
 301 static CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocConType);
 302
 303 /**
 304  * Convert CATransportFlags_t to OCTransportModifiers_t.
 305  *
 306  * @param caConType CATransportFlags_t input.
 307  * @return OCTransportFlags
 308  */
 309 static OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caConType);
 310
 311 /**
 312  * Handle response from presence request.
 313  *
 314  * @param endPoint CA remote endpoint.
 315  * @param responseInfo CA response info.
 316  * @return ::OC_STACK_OK on success, some other value upon failure.
 317  */
 318 static OCStackResult HandlePresenceResponse(const CAEndpoint_t *endPoint,
 319         const CAResponseInfo_t *responseInfo);
 320
 321 /**
 322  * This function will be called back by CA layer when a response is received.
 323  *
 324  * @param endPoint CA remote endpoint.
 325  * @param responseInfo CA response info.
 326  */
 327 static void HandleCAResponses(const CAEndpoint_t* endPoint,
 328         const CAResponseInfo_t* responseInfo);
 329
 330 /**
 331  * This function will be called back by CA layer when a request is received.
 332  *
 333  * @param endPoint CA remote endpoint.
 334  * @param requestInfo CA request info.
 335  */
 336 static void HandleCARequests(const CAEndpoint_t* endPoint,
 337         const CARequestInfo_t* requestInfo);
 338
 339 /**
 340  * Extract query from a URI.
 341  *
 342  * @param uri Full URI with query.
 343  * @param query Pointer to string that will contain query.
 344  * @param newURI Pointer to string that will contain URI.
 345  * @return ::OC_STACK_OK on success, some other value upon failure.
 346  */
 347 static OCStackResult getQueryFromUri(const char * uri, char** resourceType, char ** newURI);
 348
 349 /**
 350  * Finds a resource type in an OCResourceType link-list.
 351  *
 352  * @param resourceTypeList The link-list to be searched through.
 353  * @param resourceTypeName The key to search for.
 354  *
 355  * @return Resource type that matches the key (ie. resourceTypeName) or
 356  *      NULL if there is either an invalid parameter or this function was unable to find the key.
 357  */
 358 static OCResourceType *findResourceType(OCResourceType * resourceTypeList,
 359         const char * resourceTypeName);
 360
 361 /**
 362  * Reset presence TTL for a ClientCB struct. ttlLevel will be set to 0.
 363  * TTL will be set to maxAge.
 364  *
 365  * @param cbNode Callback Node for which presence ttl is to be reset.
 366  * @param maxAge New value of ttl in seconds.
 367
 368  * @return ::OC_STACK_OK on success, some other value upon failure.
 369  */
 370 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds);
 371
 372 //-----------------------------------------------------------------------------
 373 // Internal functions
 374 //-----------------------------------------------------------------------------
 375
 376 uint32_t GetTicks(uint32_t afterMilliSeconds)
 377 {
 378     coap_tick_t now;
 379     coap_ticks(&now);
 380
 381     // Guard against overflow of uint32_t
 382     if (afterMilliSeconds <= ((UINT32_MAX - (uint32_t)now) * MILLISECONDS_PER_SECOND) /
 383                              COAP_TICKS_PER_SECOND)
 384     {
 385         return now + (afterMilliSeconds * COAP_TICKS_PER_SECOND)/MILLISECONDS_PER_SECOND;
 386     }
 387     else
 388     {
 389         return UINT32_MAX;
 390     }
 391 }
 392
 393 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out)
 394 {
 395     VERIFY_NON_NULL_NR(in, FATAL);
 396     VERIFY_NON_NULL_NR(out, FATAL);
 397
 398     out->adapter = (OCTransportAdapter)in->adapter;
 399     out->flags = CAToOCTransportFlags(in->flags);
 400     strncpy(out->addr, in->addr, MAX_ADDR_STR_SIZE);
 401     out->addr[MAX_ADDR_STR_SIZE - 1] = '\0';
 402     out->port = in->port;
 403 }
 404
 405 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out)
 406 {
 407     VERIFY_NON_NULL_NR(in, FATAL);
 408     VERIFY_NON_NULL_NR(out, FATAL);
 409
 410     out->adapter = (CATransportAdapter_t)in->adapter;
 411     out->flags = OCToCATransportFlags(in->flags);
 412     strncpy(out->addr, in->addr, MAX_ADDR_STR_SIZE);
 413     out->port = in->port;
 414 }
 415
 416 static OCStackResult OCCreateEndpoint(OCDevAddr *devAddr, CAEndpoint_t **endpoint)
 417 {
 418     VERIFY_NON_NULL(devAddr, FATAL, OC_STACK_INVALID_PARAM);
 419     VERIFY_NON_NULL(endpoint, FATAL, OC_STACK_INVALID_PARAM);
 420
 421     CAEndpoint_t *ep = (CAEndpoint_t *)OICMalloc(sizeof (CAEndpoint_t));
 422     if (!ep)
 423     {
 424         return OC_STACK_NO_MEMORY;
 425     }
 426
 427     ep->adapter = (CATransportAdapter_t)devAddr->adapter;
 428     if (!ep->adapter)
 429     {
 430         ep->adapter = CA_ADAPTER_IP;
 431     }
 432     ep->flags = OCToCATransportFlags(devAddr->flags);
 433     strncpy(ep->addr, devAddr->addr, MAX_ADDR_STR_SIZE_CA);
 434     ep->port = devAddr->port;
 435
 436     *endpoint = ep;
 437
 438     return OC_STACK_OK;
 439 }
 440
 441 static void OCDestroyEndpoint(CAEndpoint_t *endpoint)
 442 {
 443     free(endpoint);
 444 }
 445
 446 void FixUpClientResponse(OCClientResponse *cr)
 447 {
 448     VERIFY_NON_NULL_NR(cr, FATAL);
 449
 450     cr->addr = &cr->devAddr;
 451     cr->connType = (OCConnectivityType)
 452         ((cr->devAddr.adapter << CT_ADAPTER_SHIFT) | (cr->devAddr.flags & CT_MASK_FLAGS));
 453 }
 454
 455 //-----------------------------------------------------------------------------
 456 // Internal API function
 457 //-----------------------------------------------------------------------------
 458
 459 // This internal function is called to update the stack with the status of
 460 // observers and communication failures
 461 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status)
 462 {
 463     OCStackResult result = OC_STACK_ERROR;
 464     ResourceObserver * observer = NULL;
 465     OCEntityHandlerRequest ehRequest = {};
 466
 467     switch(status)
 468     {
 469     case OC_OBSERVER_NOT_INTERESTED:
 470         OC_LOG(DEBUG, TAG, PCF("observer not interested in our notifications"));
 471         observer = GetObserverUsingToken (token, tokenLength);
 472         if(observer)
 473         {
 474             result = FormOCEntityHandlerRequest(&ehRequest,
 475                                                 (OCRequestHandle)NULL,
 476                                                 OC_REST_NOMETHOD,
 477                                                 &observer->devAddr,
 478                                                 (OCResourceHandle)NULL,
 479                                                 NULL, NULL, 0, 0, NULL,
 480                                                 OC_OBSERVE_DEREGISTER,
 481                                                 observer->observeId);
 482             if(result != OC_STACK_OK)
 483             {
 484                 return result;
 485             }
 486             observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
 487                             observer->resource->entityHandlerCallbackParam);
 488         }
 489
 490         result = DeleteObserverUsingToken (token, tokenLength);
 491         if(result == OC_STACK_OK)
 492         {
 493             OC_LOG(DEBUG, TAG, PCF("Removed observer successfully"));
 494         }
 495         else
 496         {
 497             result = OC_STACK_OK;
 498             OC_LOG(DEBUG, TAG, PCF("Observer Removal failed"));
 499         }
 500         break;
 501
 502     case OC_OBSERVER_STILL_INTERESTED:
 503         OC_LOG(DEBUG, TAG, PCF("observer still interested, reset the failedCount"));
 504         observer = GetObserverUsingToken (token, tokenLength);
 505         if(observer)
 506         {
 507             observer->forceHighQos = 0;
 508             observer->failedCommCount = 0;
 509             result = OC_STACK_OK;
 510         }
 511         else
 512         {
 513             result = OC_STACK_OBSERVER_NOT_FOUND;
 514         }
 515         break;
 516
 517     case OC_OBSERVER_FAILED_COMM:
 518         OC_LOG(DEBUG, TAG, PCF("observer is unreachable"));
 519         observer = GetObserverUsingToken (token, tokenLength);
 520         if(observer)
 521         {
 522             if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
 523             {
 524                 result = FormOCEntityHandlerRequest(&ehRequest,
 525                                                     (OCRequestHandle)NULL,
 526                                                     OC_REST_NOMETHOD,
 527                                                     &observer->devAddr,
 528                                                     (OCResourceHandle)NULL,
 529                                                     NULL, NULL, 0, 0, NULL,
 530                                                     OC_OBSERVE_DEREGISTER,
 531                                                     observer->observeId);
 532                 if(result != OC_STACK_OK)
 533                 {
 534                     return OC_STACK_ERROR;
 535                 }
 536                 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest,
 537                                     observer->resource->entityHandlerCallbackParam);
 538
 539                 result = DeleteObserverUsingToken (token, tokenLength);
 540                 if(result == OC_STACK_OK)
 541                 {
 542                     OC_LOG(DEBUG, TAG, PCF("Removed observer successfully"));
 543                 }
 544                 else
 545                 {
 546                     result = OC_STACK_OK;
 547                     OC_LOG(DEBUG, TAG, PCF("Observer Removal failed"));
 548                 }
 549             }
 550             else
 551             {
 552                 observer->failedCommCount++;
 553                 result = OC_STACK_CONTINUE;
 554             }
 555             observer->forceHighQos = 1;
 556             OC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",observer->failedCommCount);
 557         }
 558         break;
 559     default:
 560         OC_LOG(ERROR, TAG, PCF("Unknown status"));
 561         result = OC_STACK_ERROR;
 562         break;
 563         }
 564     return result;
 565 }
 566 OCStackResult CAToOCStackResult(CAResponseResult_t caCode)
 567 {
 568     OCStackResult ret = OC_STACK_ERROR;
 569
 570     switch(caCode)
 571     {
 572         case CA_SUCCESS:
 573             ret = OC_STACK_OK;
 574             break;
 575         case CA_CREATED:
 576             ret = OC_STACK_RESOURCE_CREATED;
 577             break;
 578         case CA_DELETED:
 579             ret = OC_STACK_RESOURCE_DELETED;
 580             break;
 581         case CA_BAD_REQ:
 582             ret = OC_STACK_INVALID_QUERY;
 583             break;
 584         case CA_UNAUTHORIZED_REQ:
 585             ret = OC_STACK_UNAUTHORIZED_REQ;
 586             break;
 587         case CA_BAD_OPT:
 588             ret = OC_STACK_INVALID_OPTION;
 589             break;
 590         case CA_NOT_FOUND:
 591             ret = OC_STACK_NO_RESOURCE;
 592             break;
 593         case CA_RETRANSMIT_TIMEOUT:
 594             ret = OC_STACK_COMM_ERROR;
 595             break;
 596         default:
 597             break;
 598     }
 599     return ret;
 600 }
 601
 602 CAResponseResult_t OCToCAStackResult(OCStackResult ocCode)
 603 {
 604     CAResponseResult_t ret = CA_INTERNAL_SERVER_ERROR;
 605
 606     switch(ocCode)
 607     {
 608         case OC_STACK_OK:
 609             ret = CA_SUCCESS;
 610             break;
 611         case OC_STACK_RESOURCE_CREATED:
 612             ret = CA_CREATED;
 613             break;
 614         case OC_STACK_RESOURCE_DELETED:
 615             ret = CA_DELETED;
 616             break;
 617         case OC_STACK_INVALID_QUERY:
 618             ret = CA_BAD_REQ;
 619             break;
 620         case OC_STACK_INVALID_OPTION:
 621             ret = CA_BAD_OPT;
 622             break;
 623         case OC_STACK_NO_RESOURCE:
 624             ret = CA_NOT_FOUND;
 625             break;
 626         case OC_STACK_COMM_ERROR:
 627             ret = CA_RETRANSMIT_TIMEOUT;
 628             break;
 629         case OC_STACK_UNAUTHORIZED_REQ:
 630             ret = CA_UNAUTHORIZED_REQ;
 631             break;
 632         default:
 633             break;
 634     }
 635     return ret;
 636 }
 637
 638 CATransportFlags_t OCToCATransportFlags(OCTransportFlags ocFlags)
 639 {
 640     CATransportFlags_t caFlags = (CATransportFlags_t)ocFlags;
 641
 642     // supply default behavior.
 643     if ((caFlags & (CA_IPV6|CA_IPV4)) == 0)
 644     {
 645         caFlags = (CATransportFlags_t)(caFlags|CA_IPV6|CA_IPV4);
 646     }
 647     if ((caFlags & OC_MASK_SCOPE) == 0)
 648     {
 649         caFlags = (CATransportFlags_t)(caFlags|OC_SCOPE_LINK);
 650     }
 651     return caFlags;
 652 }
 653
 654 OCTransportFlags CAToOCTransportFlags(CATransportFlags_t caFlags)
 655 {
 656     return (OCTransportFlags)caFlags;
 657 }
 658
 659 static OCStackResult ResetPresenceTTL(ClientCB *cbNode, uint32_t maxAgeSeconds)
 660 {
 661     uint32_t lowerBound  = 0;
 662     uint32_t higherBound = 0;
 663
 664     if (!cbNode || !cbNode->presence || !cbNode->presence->timeOut)
 665     {
 666         return OC_STACK_INVALID_PARAM;
 667     }
 668
 669     OC_LOG_V(INFO, TAG, "Update presence TTL, time is %u", GetTicks(0));
 670
 671     cbNode->presence->TTL = maxAgeSeconds;
 672
 673     for(int index = 0; index < PresenceTimeOutSize; index++)
 674     {
 675         // Guard against overflow
 676         if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index]))
 677                                      * 100)
 678         {
 679             lowerBound = GetTicks((PresenceTimeOut[index] *
 680                                   cbNode->presence->TTL *
 681                                   MILLISECONDS_PER_SECOND)/100);
 682         }
 683         else
 684         {
 685             lowerBound = GetTicks(UINT32_MAX);
 686         }
 687
 688         if (cbNode->presence->TTL < (UINT32_MAX/(MILLISECONDS_PER_SECOND*PresenceTimeOut[index+1]))
 689                                      * 100)
 690         {
 691             higherBound = GetTicks((PresenceTimeOut[index + 1] *
 692                                    cbNode->presence->TTL *
 693                                    MILLISECONDS_PER_SECOND)/100);
 694         }
 695         else
 696         {
 697             higherBound = GetTicks(UINT32_MAX);
 698         }
 699
 700         cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
 701
 702         OC_LOG_V(DEBUG, TAG, "lowerBound timeout  %d", lowerBound);
 703         OC_LOG_V(DEBUG, TAG, "higherBound timeout %d", higherBound);
 704         OC_LOG_V(DEBUG, TAG, "timeOut entry  %d", cbNode->presence->timeOut[index]);
 705     }
 706
 707     cbNode->presence->TTLlevel = 0;
 708
 709     OC_LOG_V(DEBUG, TAG, "this TTL level %d", cbNode->presence->TTLlevel);
 710     return OC_STACK_OK;
 711 }
 712
 713 const char *convertTriggerEnumToString(OCPresenceTrigger trigger)
 714 {
 715     if (trigger == OC_PRESENCE_TRIGGER_CREATE)
 716     {
 717         return OC_RSRVD_TRIGGER_CREATE;
 718     }
 719     else if (trigger == OC_PRESENCE_TRIGGER_CHANGE)
 720     {
 721         return OC_RSRVD_TRIGGER_CHANGE;
 722     }
 723     else
 724     {
 725         return OC_RSRVD_TRIGGER_DELETE;
 726     }
 727 }
 728
 729 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr)
 730 {
 731     if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CREATE) == 0)
 732     {
 733         return OC_PRESENCE_TRIGGER_CREATE;
 734     }
 735     else if(strcmp(triggerStr, OC_RSRVD_TRIGGER_CHANGE) == 0)
 736     {
 737         return OC_PRESENCE_TRIGGER_CHANGE;
 738     }
 739     else
 740     {
 741         return OC_PRESENCE_TRIGGER_DELETE;
 742     }
 743 }
 744
 745 /**
 746  * The cononical presence allows constructed URIs to be string compared.
 747  *
 748  * requestUri must be a char array of size CA_MAX_URI_LENGTH
 749  */
 750 static int FormCanonicalPresenceUri(const CAEndpoint_t *endpoint, char *resourceUri,
 751         char *presenceUri)
 752 {
 753     VERIFY_NON_NULL(endpoint   , FATAL, OC_STACK_INVALID_PARAM);
 754     VERIFY_NON_NULL(resourceUri, FATAL, OC_STACK_INVALID_PARAM);
 755     VERIFY_NON_NULL(presenceUri, FATAL, OC_STACK_INVALID_PARAM);
 756
 757     const char *format;
 758     CAEndpoint_t *ep = (CAEndpoint_t *)endpoint;
 759
 760     if (ep->adapter == CA_ADAPTER_IP)
 761     {
 762         if ((ep->flags & CA_IPV6) && !(ep->flags & CA_IPV4))
 763         {
 764             if ('\0' == ep->addr[0])  // multicast
 765             {
 766                 return snprintf(presenceUri, CA_MAX_URI_LENGTH, OC_RSRVD_PRESENCE_URI);
 767             }
 768             else
 769             {
 770                 format = "coap://[%s]:%u%s";
 771             }
 772         }
 773         else
 774         {
 775             if ('\0' == ep->addr[0])  // multicast
 776             {
 777                 OICStrcpy(ep->addr, sizeof(ep->addr), OC_MULTICAST_IP);
 778                 ep->port = OC_MULTICAST_PORT;
 779             }
 780             format = "coap://%s:%u%s";
 781         }
 782         return snprintf(presenceUri, CA_MAX_URI_LENGTH, format, ep->addr,
 783                         ep->port, OC_RSRVD_PRESENCE_URI);
 784     }
 785
 786     // might work for other adapters (untested, but better than nothing)
 787     format = "coap://%s%s";
 788     return snprintf(presenceUri, CA_MAX_URI_LENGTH, format, ep->addr,
 789                     OC_RSRVD_PRESENCE_URI);
 790 }
 791
 792
 793 OCStackResult HandlePresenceResponse(const CAEndpoint_t *endpoint,
 794                             const CAResponseInfo_t *responseInfo)
 795 {
 796     VERIFY_NON_NULL(endpoint, FATAL, OC_STACK_INVALID_PARAM);
 797     VERIFY_NON_NULL(responseInfo, FATAL, OC_STACK_INVALID_PARAM);
 798
 799     OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
 800     ClientCB * cbNode = NULL;
 801     char *resourceTypeName = NULL;
 802     OCClientResponse response;
 803     OCStackResult result = OC_STACK_ERROR;
 804     uint32_t maxAge = 0;
 805     int uriLen;
 806     char presenceUri[CA_MAX_URI_LENGTH];
 807
 808     int presenceSubscribe = 0;
 809     int multicastPresenceSubscribe = 0;
 810
 811     if (responseInfo->result != CA_SUCCESS)
 812     {
 813         OC_LOG_V(ERROR, TAG, "HandlePresenceResponse failed %d", responseInfo->result);
 814         return OC_STACK_ERROR;
 815     }
 816
 817     // check for unicast presence
 818     uriLen = FormCanonicalPresenceUri(endpoint, OC_RSRVD_PRESENCE_URI, presenceUri);
 819     if (uriLen < 0 || uriLen >= sizeof (presenceUri))
 820     {
 821         return OC_STACK_INVALID_URI;
 822     }
 823
 824     cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
 825     if (cbNode)
 826     {
 827         presenceSubscribe = 1;
 828     }
 829     else
 830     {
 831         // check for multiicast presence
 832         CAEndpoint_t ep = { endpoint->adapter, endpoint->flags };
 833         OICStrcpy(ep.addr, sizeof(ep.addr), OC_MULTICAST_IP);
 834         ep.port = OC_MULTICAST_PORT;
 835
 836         uriLen = FormCanonicalPresenceUri(&ep, OC_RSRVD_PRESENCE_URI, presenceUri);
 837
 838         cbNode = GetClientCB(NULL, 0, NULL, presenceUri);
 839         if (cbNode)
 840         {
 841             multicastPresenceSubscribe = 1;
 842         }
 843     }
 844
 845     if (!presenceSubscribe && !multicastPresenceSubscribe)
 846     {
 847          OC_LOG(ERROR, TAG, PCF("Received a presence notification, but no callback, ignoring"));
 848         goto exit;
 849     }
 850
 851     response.payload = NULL;
 852     response.result = OC_STACK_OK;
 853
 854     CopyEndpointToDevAddr(endpoint, &response.devAddr);
 855     FixUpClientResponse(&response);
 856
 857     if (responseInfo->info.payload)
 858     {
 859         result = OCParsePayload(&response.payload,  responseInfo->info.payload,
 860                 responseInfo->info.payloadSize);
 861
 862         if(result != OC_STACK_OK || response.payload->type != PAYLOAD_TYPE_PRESENCE)
 863         {
 864             OC_LOG(ERROR, TAG, PCF("Presence parse failed"));
 865             goto exit;
 866         }
 867         response.sequenceNumber = ((OCPresencePayload*)response.payload)->sequenceNumber;
 868         resourceTypeName = ((OCPresencePayload*)response.payload)->resourceType;
 869         maxAge = ((OCPresencePayload*)response.payload)->maxAge;
 870     }
 871
 872     if (presenceSubscribe)
 873     {
 874         if(cbNode->sequenceNumber == response.sequenceNumber)
 875         {
 876             OC_LOG(INFO, TAG, PCF("No presence change"));
 877             goto exit;
 878         }
 879
 880         if(maxAge == 0)
 881         {
 882             OC_LOG(INFO, TAG, PCF("Stopping presence"));
 883             response.result = OC_STACK_PRESENCE_STOPPED;
 884             if(cbNode->presence)
 885             {
 886                 OICFree(cbNode->presence->timeOut);
 887                 OICFree(cbNode->presence);
 888                 cbNode->presence = NULL;
 889             }
 890         }
 891         else
 892         {
 893             if(!cbNode->presence)
 894             {
 895                 cbNode->presence = (OCPresence *)OICMalloc(sizeof (OCPresence));
 896
 897                 if(!(cbNode->presence))
 898                 {
 899                     OC_LOG(ERROR, TAG, PCF("Could not allocate memory for cbNode->presence"));
 900                     result = OC_STACK_NO_MEMORY;
 901                     goto exit;
 902                 }
 903
 904                 VERIFY_NON_NULL_V(cbNode->presence);
 905                 cbNode->presence->timeOut = NULL;
 906                 cbNode->presence->timeOut = (uint32_t *)
 907                         OICMalloc(PresenceTimeOutSize * sizeof(uint32_t));
 908                 if(!(cbNode->presence->timeOut)){
 909                     OC_LOG(ERROR, TAG,
 910                                   PCF("Could not allocate memory for cbNode->presence->timeOut"));
 911                     OICFree(cbNode->presence);
 912                     result = OC_STACK_NO_MEMORY;
 913                     goto exit;
 914                 }
 915             }
 916
 917             ResetPresenceTTL(cbNode, maxAge);
 918
 919             cbNode->sequenceNumber = response.sequenceNumber;
 920
 921             // Ensure that a filter is actually applied.
 922             if( resourceTypeName && cbNode->filterResourceType)
 923             {
 924                 if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
 925                 {
 926                     goto exit;
 927                 }
 928             }
 929         }
 930     }
 931     else
 932     {
 933         // This is the multicast case
 934         OCMulticastNode* mcNode = NULL;
 935         mcNode = GetMCPresenceNode(presenceUri);
 936
 937         if(mcNode != NULL)
 938         {
 939             if(mcNode->nonce == response.sequenceNumber)
 940             {
 941                 OC_LOG(INFO, TAG, PCF("No presence change (Multicast)"));
 942                 goto exit;
 943             }
 944             mcNode->nonce = response.sequenceNumber;
 945
 946             if(maxAge == 0)
 947             {
 948                 OC_LOG(INFO, TAG, PCF("Stopping presence"));
 949                 response.result = OC_STACK_PRESENCE_STOPPED;
 950             }
 951         }
 952         else
 953         {
 954             char* uri = OICStrdup(presenceUri);
 955             if (!uri)
 956             {
 957                 OC_LOG(INFO, TAG,
 958                     PCF("No Memory for URI to store in the presence node"));
 959                 result = OC_STACK_NO_MEMORY;
 960                 goto exit;
 961             }
 962
 963             result = AddMCPresenceNode(&mcNode, uri, response.sequenceNumber);
 964             if(result == OC_STACK_NO_MEMORY)
 965             {
 966                 OC_LOG(INFO, TAG,
 967                     PCF("No Memory for Multicast Presence Node"));
 968                 OICFree(uri);
 969                 goto exit;
 970             }
 971             // presence node now owns uri
 972         }
 973
 974         // Ensure that a filter is actually applied.
 975         if(resourceTypeName && cbNode->filterResourceType)
 976         {
 977             if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
 978             {
 979                 goto exit;
 980             }
 981         }
 982     }
 983
 984     cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
 985
 986     if (cbResult == OC_STACK_DELETE_TRANSACTION)
 987     {
 988         FindAndDeleteClientCB(cbNode);
 989     }
 990
 991 exit:
 992     OICFree(resourceTypeName);
 993     return result;
 994 }
 995
 996 void HandleCAResponses(const CAEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
 997 {
 998     VERIFY_NON_NULL_NR(endPoint, FATAL);
 999     VERIFY_NON_NULL_NR(responseInfo, FATAL);
1000     VERIFY_NON_NULL_NR(responseInfo->info.resourceUri, FATAL);
1001     OC_LOG(INFO, TAG, PCF("Enter HandleCAResponses"));
1002
1003     if(strcmp(responseInfo->info.resourceUri, OC_RSRVD_PRESENCE_URI) == 0)
1004     {
1005         HandlePresenceResponse(endPoint, responseInfo);
1006         return;
1007     }
1008
1009     ClientCB *cbNode = GetClientCB(responseInfo->info.token,
1010             responseInfo->info.tokenLength, NULL, NULL);
1011
1012     ResourceObserver * observer = GetObserverUsingToken (responseInfo->info.token,
1013             responseInfo->info.tokenLength);
1014
1015     if(cbNode)
1016     {
1017         OC_LOG(INFO, TAG, PCF("There is a cbNode associated with the response token"));
1018         if(responseInfo->result == CA_EMPTY)
1019         {
1020             OC_LOG(INFO, TAG, PCF("Receiving A ACK/RESET for this token"));
1021             // We do not have a case for the client to receive a RESET
1022             if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1023             {
1024                 //This is the case of receiving an ACK on a request to a slow resource!
1025                 OC_LOG(INFO, TAG, PCF("This is a pure ACK"));
1026                 //TODO: should we inform the client
1027                 //      app that at least the request was received at the server?
1028             }
1029         }
1030         else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1031         {
1032             OC_LOG(INFO, TAG, PCF("Receiving A Timeout for this token"));
1033             OC_LOG(INFO, TAG, PCF("Calling into application address space"));
1034
1035             OCClientResponse response = {};
1036             CopyEndpointToDevAddr(endPoint, &response.devAddr);
1037             FixUpClientResponse(&response);
1038             response.resourceUri = responseInfo->info.resourceUri;
1039
1040             response.result = CAToOCStackResult(responseInfo->result);
1041             cbNode->callBack(cbNode->context,
1042                     cbNode->handle, &response);
1043             FindAndDeleteClientCB(cbNode);
1044         }
1045         else
1046         {
1047             OC_LOG(INFO, TAG, PCF("This is a regular response, A client call back is found"));
1048             OC_LOG(INFO, TAG, PCF("Calling into application address space"));
1049
1050             OCClientResponse response = {};
1051             response.sequenceNumber = OC_OBSERVE_NO_OPTION;
1052             CopyEndpointToDevAddr(endPoint, &response.devAddr);
1053             FixUpClientResponse(&response);
1054             response.resourceUri = responseInfo->info.resourceUri;
1055
1056             response.result = CAToOCStackResult(responseInfo->result);
1057             if(responseInfo->info.payload &&
1058                responseInfo->info.payloadSize &&
1059                OC_STACK_OK != OCParsePayload(&response.payload, responseInfo->info.payload,
1060                                            responseInfo->info.payloadSize))
1061             {
1062                 OC_LOG(ERROR, TAG, PCF("Error converting payload"));
1063                 return;
1064             }
1065
1066             response.numRcvdVendorSpecificHeaderOptions = 0;
1067             if(responseInfo->info.numOptions > 0)
1068             {
1069                 int start = 0;
1070                 //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
1071                 if(responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
1072                 {
1073                     memcpy (&(response.sequenceNumber),
1074                             &(responseInfo->info.options[0].optionData), sizeof(uint32_t));
1075                     response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
1076                     start = 1;
1077                 }
1078                 else
1079                 {
1080                     response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
1081                 }
1082
1083                 if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
1084                 {
1085                     OC_LOG(ERROR, TAG, PCF("#header options are more than MAX_HEADER_OPTIONS"));
1086                     return;
1087                 }
1088
1089                 for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
1090                 {
1091                     memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
1092                             &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
1093                 }
1094             }
1095
1096             if (cbNode->method == OC_REST_OBSERVE &&
1097                 response.sequenceNumber > OC_OFFSET_SEQUENCE_NUMBER &&
1098                 response.sequenceNumber <= cbNode->sequenceNumber)
1099             {
1100                 OC_LOG_V(INFO, TAG, PCF("Received stale notification. Number :%d"),
1101                                                  response.sequenceNumber);
1102             }
1103             else
1104             {
1105                 OCStackApplicationResult appFeedback = cbNode->callBack(cbNode->context,
1106                                                                         cbNode->handle,
1107                                                                         &response);
1108                 cbNode->sequenceNumber = response.sequenceNumber;
1109
1110                 if (appFeedback == OC_STACK_DELETE_TRANSACTION)
1111                 {
1112                     FindAndDeleteClientCB(cbNode);
1113                 }
1114                 else
1115                 {
1116                     // To keep discovery callbacks active.
1117                     cbNode->TTL = GetTicks(MAX_CB_TIMEOUT_SECONDS *
1118                                             MILLISECONDS_PER_SECOND);
1119                 }
1120                 OCPayloadDestroy(response.payload);
1121             }
1122
1123             //Need to send ACK when the response is CON
1124             if(responseInfo->info.type == CA_MSG_CONFIRM)
1125             {
1126                 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1127                         CA_MSG_ACKNOWLEDGE, 0, NULL, NULL, 0);
1128             }
1129         }
1130         return;
1131     }
1132
1133     if(observer)
1134     {
1135         OC_LOG(INFO, TAG, PCF("There is an observer associated with the response token"));
1136         if(responseInfo->result == CA_EMPTY)
1137         {
1138             OC_LOG(INFO, TAG, PCF("Receiving A ACK/RESET for this token"));
1139             if(responseInfo->info.type == CA_MSG_RESET)
1140             {
1141                 OC_LOG(INFO, TAG, PCF("This is a RESET"));
1142                 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1143                         OC_OBSERVER_NOT_INTERESTED);
1144             }
1145             else if(responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1146             {
1147                 OC_LOG(INFO, TAG, PCF("This is a pure ACK"));
1148                 OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1149                         OC_OBSERVER_STILL_INTERESTED);
1150             }
1151         }
1152         else if(responseInfo->result == CA_RETRANSMIT_TIMEOUT)
1153         {
1154             OC_LOG(INFO, TAG, PCF("Receiving Time Out for an observer"));
1155             OCStackFeedBack(responseInfo->info.token, responseInfo->info.tokenLength,
1156                     OC_OBSERVER_FAILED_COMM);
1157         }
1158         return;
1159     }
1160
1161     if(!cbNode && !observer)
1162     {
1163         if(myStackMode == OC_CLIENT || myStackMode == OC_CLIENT_SERVER)
1164         {
1165             OC_LOG(INFO, TAG, PCF("This is a client, but no cbNode was found for token"));
1166             if(responseInfo->result == CA_EMPTY)
1167             {
1168                 OC_LOG(INFO, TAG, PCF("Receiving CA_EMPTY in the ocstack"));
1169             }
1170             else
1171             {
1172                 OC_LOG(INFO, TAG, PCF("Received a response or notification,\
1173                         but I do not have callback. Sending RESET"));
1174                 SendDirectStackResponse(endPoint, responseInfo->info.messageId, CA_EMPTY,
1175                         CA_MSG_RESET, 0, NULL, NULL, 0);
1176             }
1177         }
1178
1179         if(myStackMode == OC_SERVER || myStackMode == OC_CLIENT_SERVER)
1180         {
1181             OC_LOG(INFO, TAG, PCF("This is a server, but no observer was found for token"));
1182             if (responseInfo->info.type == CA_MSG_ACKNOWLEDGE)
1183             {
1184                 OC_LOG_V(INFO, TAG, PCF("Received ACK at server for messageId : %d"),
1185                                             responseInfo->info.messageId);
1186             }
1187             if (responseInfo->info.type == CA_MSG_RESET)
1188             {
1189                 OC_LOG_V(INFO, TAG, PCF("Received RESET at server for messageId : %d"),
1190                                             responseInfo->info.messageId);
1191             }
1192         }
1193         return;
1194     }
1195
1196     OC_LOG(INFO, TAG, PCF("Exit HandleCAResponses"));
1197 }
1198
1199 /*
1200  * This function handles error response from CA
1201  * code shall be added to handle the errors
1202  */
1203 void HandleCAErrorResponse(const CAEndpoint_t *endPoint, const CAErrorInfo_t *errrorInfo)
1204 {
1205     OC_LOG(INFO, TAG, PCF("Enter HandleCAErrorResponse"));
1206
1207     if(NULL == endPoint)
1208     {
1209         OC_LOG(ERROR, TAG, PCF("endPoint is NULL"));
1210         return;
1211     }
1212
1213     if(NULL == errrorInfo)
1214     {
1215         OC_LOG(ERROR, TAG, PCF("errrorInfo is NULL"));
1216         return;
1217     }
1218     OC_LOG(INFO, TAG, PCF("Exit HandleCAErrorResponse"));
1219 }
1220
1221 /*
1222  * This function sends out Direct Stack Responses. These are responses that are not coming
1223  * from the application entity handler. These responses have no payload and are usually ACKs,
1224  * RESETs or some error conditions that were caught by the stack.
1225  */
1226 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
1227         const CAResponseResult_t responseResult, const CAMessageType_t type,
1228         const uint8_t numOptions, const CAHeaderOption_t *options,
1229         CAToken_t token, uint8_t tokenLength)
1230 {
1231     CAResponseInfo_t respInfo = {};
1232     respInfo.result = responseResult;
1233     respInfo.info.messageId = coapID;
1234     respInfo.info.numOptions = numOptions;
1235     respInfo.info.options = (CAHeaderOption_t*)options;
1236     respInfo.info.payload = NULL;
1237     respInfo.info.token = token;
1238     respInfo.info.tokenLength = tokenLength;
1239     respInfo.info.type = type;
1240
1241     CAResult_t caResult = CASendResponse(endPoint, &respInfo);
1242     if(caResult != CA_STATUS_OK)
1243     {
1244         OC_LOG(ERROR, TAG, PCF("CASendResponse error"));
1245         return OC_STACK_ERROR;
1246     }
1247     return OC_STACK_OK;
1248 }
1249
1250 //This function will be called back by CA layer when a request is received
1251 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1252 {
1253     OC_LOG(INFO, TAG, PCF("Enter HandleCARequests"));
1254     if(!endPoint)
1255     {
1256         OC_LOG(ERROR, TAG, PCF("endPoint is NULL"));
1257         return;
1258     }
1259
1260     if(!requestInfo)
1261     {
1262         OC_LOG(ERROR, TAG, PCF("requestInfo is NULL"));
1263         return;
1264     }
1265
1266     OCStackResult requestResult = OC_STACK_ERROR;
1267
1268     if(myStackMode == OC_CLIENT)
1269     {
1270         //TODO: should the client be responding to requests?
1271         return;
1272     }
1273
1274     OCServerProtocolRequest serverRequest = {};
1275
1276     OC_LOG_V(INFO, TAG, PCF("Endpoint URI : %s"), requestInfo->info.resourceUri);
1277
1278     char * uriWithoutQuery = NULL;
1279     char * query  = NULL;
1280
1281     requestResult = getQueryFromUri(requestInfo->info.resourceUri, &query, &uriWithoutQuery);
1282
1283     if (requestResult != OC_STACK_OK)
1284     {
1285         OC_LOG_V(ERROR, TAG, "getQueryFromUri() failed with OC error code %d\n", requestResult);
1286         return;
1287     }
1288     OC_LOG_V(INFO, TAG, PCF("URI without query: %s"), uriWithoutQuery);
1289     OC_LOG_V(INFO, TAG, PCF("Query : %s"), query);
1290
1291     if(strlen(uriWithoutQuery) < MAX_URI_LENGTH)
1292     {
1293         OICStrcpy(serverRequest.resourceUrl, sizeof(serverRequest.resourceUrl), uriWithoutQuery);
1294         OICFree(uriWithoutQuery);
1295     }
1296     else
1297     {
1298         OC_LOG(ERROR, TAG, PCF("URI length exceeds MAX_URI_LENGTH."));
1299         OICFree(uriWithoutQuery);
1300         OICFree(query);
1301         return;
1302     }
1303
1304     if(query)
1305     {
1306         if(strlen(query) < MAX_QUERY_LENGTH)
1307         {
1308             OICStrcpy(serverRequest.query, sizeof(serverRequest.query), query);
1309             OICFree(query);
1310         }
1311         else
1312         {
1313             OC_LOG(ERROR, TAG, PCF("Query length exceeds MAX_QUERY_LENGTH."));
1314             OICFree(query);
1315             return;
1316         }
1317     }
1318
1319     if (requestInfo->info.payload)
1320     {
1321         serverRequest.reqTotalSize = requestInfo->info.payloadSize;
1322         memcpy (&(serverRequest.payload), requestInfo->info.payload,
1323                 requestInfo->info.payloadSize);
1324     }
1325     else
1326     {
1327         serverRequest.reqTotalSize = 0;
1328     }
1329
1330     switch (requestInfo->method)
1331     {
1332         case CA_GET:
1333             serverRequest.method = OC_REST_GET;
1334             break;
1335         case CA_PUT:
1336             serverRequest.method = OC_REST_PUT;
1337             break;
1338         case CA_POST:
1339             serverRequest.method = OC_REST_POST;
1340             break;
1341         case CA_DELETE:
1342             serverRequest.method = OC_REST_DELETE;
1343             break;
1344         default:
1345             OC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1346             SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1347                         requestInfo->info.type, requestInfo->info.numOptions,
1348                         requestInfo->info.options, requestInfo->info.token,
1349                         requestInfo->info.tokenLength);
1350             return;
1351     }
1352
1353     OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1354             requestInfo->info.tokenLength);
1355     serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1356     serverRequest.tokenLength = requestInfo->info.tokenLength;
1357
1358     if (!serverRequest.requestToken)
1359     {
1360         OC_LOG(FATAL, TAG, "Allocation for token failed.");
1361         SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1362                 requestInfo->info.type, requestInfo->info.numOptions,
1363                 requestInfo->info.options, requestInfo->info.token,
1364                 requestInfo->info.tokenLength);
1365         return;
1366     }
1367     memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1368
1369     if (requestInfo->info.type == CA_MSG_CONFIRM)
1370     {
1371         serverRequest.qos = OC_HIGH_QOS;
1372     }
1373     else
1374     {
1375         serverRequest.qos = OC_LOW_QOS;
1376     }
1377     // CA does not need the following field
1378     // Are we sure CA does not need them? how is it responding to multicast
1379     serverRequest.delayedResNeeded = 0;
1380
1381     serverRequest.coapID = requestInfo->info.messageId;
1382
1383     CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1384
1385     // copy vendor specific header options
1386     uint8_t tempNum = (requestInfo->info.numOptions);
1387     GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1388     if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1389     {
1390         OC_LOG(ERROR, TAG,
1391                 PCF("The request info numOptions is greater than MAX_HEADER_OPTIONS"));
1392         SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1393                 requestInfo->info.type, requestInfo->info.numOptions,
1394                 requestInfo->info.options, requestInfo->info.token,
1395                 requestInfo->info.tokenLength);
1396         OICFree(serverRequest.requestToken);
1397         return;
1398     }
1399     serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1400     if (serverRequest.numRcvdVendorSpecificHeaderOptions)
1401     {
1402         memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1403             sizeof(CAHeaderOption_t)*tempNum);
1404     }
1405
1406     requestResult = HandleStackRequests (&serverRequest);
1407
1408     // Send ACK to client as precursor to slow response
1409     if(requestResult == OC_STACK_SLOW_RESOURCE)
1410     {
1411         SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1412                     CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0);
1413     }
1414     else if(requestResult != OC_STACK_OK)
1415     {
1416         OC_LOG_V(ERROR, TAG, PCF("HandleStackRequests failed. error: %d"), requestResult);
1417
1418         CAResponseResult_t stackResponse = OCToCAStackResult(requestResult);
1419
1420         SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1421                 requestInfo->info.type, requestInfo->info.numOptions,
1422                 requestInfo->info.options, requestInfo->info.token,
1423                 requestInfo->info.tokenLength);
1424     }
1425     // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1426     // The token is copied in there, and is thus still owned by this function.
1427     OICFree(serverRequest.requestToken);
1428     OC_LOG(INFO, TAG, PCF("Exit HandleCARequests"));
1429 }
1430
1431 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
1432 {
1433     OC_LOG(INFO, TAG, PCF("Entering HandleStackRequests (OCStack Layer)"));
1434     OCStackResult result = OC_STACK_ERROR;
1435     ResourceHandling resHandling;
1436     OCResource *resource;
1437     if(!protocolRequest)
1438     {
1439         OC_LOG(ERROR, TAG, PCF("protocolRequest is NULL"));
1440         return OC_STACK_INVALID_PARAM;
1441     }
1442
1443     OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken,
1444             protocolRequest->tokenLength);
1445     if(!request)
1446     {
1447         OC_LOG(INFO, TAG, PCF("This is a new Server Request"));
1448         result = AddServerRequest(&request, protocolRequest->coapID,
1449                 protocolRequest->delayedResNeeded, 0,
1450                 protocolRequest->method, protocolRequest->numRcvdVendorSpecificHeaderOptions,
1451                 protocolRequest->observationOption, protocolRequest->qos,
1452                 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
1453                 protocolRequest->payload, protocolRequest->requestToken,
1454                 protocolRequest->tokenLength,
1455                 protocolRequest->resourceUrl, protocolRequest->reqTotalSize,
1456                 &protocolRequest->devAddr);
1457         if (OC_STACK_OK != result)
1458         {
1459             OC_LOG(ERROR, TAG, PCF("Error adding server request"));
1460             return result;
1461         }
1462
1463         if(!request)
1464         {
1465             OC_LOG(ERROR, TAG, PCF("Out of Memory"));
1466             return OC_STACK_NO_MEMORY;
1467         }
1468
1469         if(!protocolRequest->reqMorePacket)
1470         {
1471             request->requestComplete = 1;
1472         }
1473     }
1474     else
1475     {
1476         OC_LOG(INFO, TAG, PCF("This is either a repeated or blocked Server Request"));
1477     }
1478
1479     if(request->requestComplete)
1480     {
1481         OC_LOG(INFO, TAG, PCF("This Server Request is complete"));
1482         result = DetermineResourceHandling (request, &resHandling, &resource);
1483         if (result == OC_STACK_OK)
1484         {
1485             result = ProcessRequest(resHandling, resource, request);
1486         }
1487     }
1488     else
1489     {
1490         OC_LOG(INFO, TAG, PCF("This Server Request is incomplete"));
1491         result = OC_STACK_CONTINUE;
1492     }
1493     return result;
1494 }
1495
1496 bool validatePlatformInfo(OCPlatformInfo info)
1497 {
1498
1499     if (!info.platformID)
1500     {
1501         OC_LOG(ERROR, TAG, PCF("No platform ID found."));
1502         return false;
1503     }
1504
1505     if (info.manufacturerName)
1506     {
1507         size_t lenManufacturerName = strlen(info.manufacturerName);
1508
1509         if(lenManufacturerName == 0 || lenManufacturerName > MAX_MANUFACTURER_NAME_LENGTH)
1510         {
1511             OC_LOG(ERROR, TAG, PCF("Manufacturer name fails length requirements."));
1512             return false;
1513         }
1514     }
1515     else
1516     {
1517         OC_LOG(ERROR, TAG, PCF("No manufacturer name present"));
1518         return false;
1519     }
1520
1521     if (info.manufacturerUrl)
1522     {
1523         if(strlen(info.manufacturerUrl) > MAX_MANUFACTURER_URL_LENGTH)
1524         {
1525             OC_LOG(ERROR, TAG, PCF("Manufacturer url fails length requirements."));
1526             return false;
1527         }
1528     }
1529     return true;
1530 }
1531
1532 //-----------------------------------------------------------------------------
1533 // Public APIs
1534 //-----------------------------------------------------------------------------
1535 #ifdef RA_ADAPTER
1536 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
1537 {
1538     if (!raInfo           ||
1539         !raInfo->username ||
1540         !raInfo->hostname ||
1541         !raInfo->xmpp_domain)
1542     {
1543
1544         return OC_STACK_INVALID_PARAM;
1545     }
1546     OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
1547     gRASetInfo = (result == OC_STACK_OK)? true : false;
1548
1549     return result;
1550 }
1551 #endif
1552
1553 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1554 {
1555     (void) ipAddr;
1556     (void) port;
1557 #ifdef RA_ADAPTER
1558     if(!gRASetInfo)
1559     {
1560         OC_LOG(ERROR, TAG, PCF("Need to call OCSetRAInfo before calling OCInit"));
1561         return OC_STACK_ERROR;
1562     }
1563 #endif
1564     return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
1565 }
1566
1567 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
1568 {
1569     if(stackState == OC_STACK_INITIALIZED)
1570     {
1571         OC_LOG(INFO, TAG, PCF("Subsequent calls to OCInit() without calling \
1572                 OCStop() between them are ignored."));
1573         return OC_STACK_OK;
1574     }
1575
1576     OCStackResult result = OC_STACK_ERROR;
1577     OC_LOG(INFO, TAG, PCF("Entering OCInit"));
1578
1579     // Validate mode
1580     if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)))
1581     {
1582         OC_LOG(ERROR, TAG, PCF("Invalid mode"));
1583         return OC_STACK_ERROR;
1584     }
1585     myStackMode = mode;
1586
1587     if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER)
1588     {
1589         caglobals.client = true;
1590     }
1591     if (mode == OC_SERVER || mode == OC_CLIENT_SERVER)
1592     {
1593         caglobals.server = true;
1594     }
1595
1596     caglobals.serverFlags = (CATransportFlags_t)serverFlags;
1597     if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
1598     {
1599         caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4);
1600     }
1601     caglobals.clientFlags = (CATransportFlags_t)clientFlags;
1602     if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
1603     {
1604         caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4);
1605     }
1606
1607     defaultDeviceHandler = NULL;
1608     defaultDeviceHandlerCallbackParameter = NULL;
1609     OCSeedRandom();
1610
1611     result = CAResultToOCResult(CAInitialize());
1612     VERIFY_SUCCESS(result, OC_STACK_OK);
1613
1614     result = CAResultToOCResult(OCSelectNetwork());
1615     VERIFY_SUCCESS(result, OC_STACK_OK);
1616
1617     switch (myStackMode)
1618     {
1619         case OC_CLIENT:
1620                         CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
1621             result = CAResultToOCResult(CAStartDiscoveryServer());
1622             OC_LOG(INFO, TAG, PCF("Client mode: CAStartDiscoveryServer"));
1623             break;
1624         case OC_SERVER:
1625                         SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
1626             result = CAResultToOCResult(CAStartListeningServer());
1627             OC_LOG(INFO, TAG, PCF("Server mode: CAStartListeningServer"));
1628             break;
1629         case OC_CLIENT_SERVER:
1630                         SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
1631             result = CAResultToOCResult(CAStartListeningServer());
1632             if(result == OC_STACK_OK)
1633             {
1634                 result = CAResultToOCResult(CAStartDiscoveryServer());
1635             }
1636             break;
1637     }
1638     VERIFY_SUCCESS(result, OC_STACK_OK);
1639
1640 #ifdef WITH_PRESENCE
1641     PresenceTimeOutSize = sizeof(PresenceTimeOut)/sizeof(PresenceTimeOut[0]) - 1;
1642 #endif // WITH_PRESENCE
1643
1644     //Update Stack state to initialized
1645     stackState = OC_STACK_INITIALIZED;
1646
1647     // Initialize resource
1648     if(myStackMode != OC_CLIENT)
1649     {
1650         result = initResources();
1651     }
1652
1653     // Initialize the SRM Policy Engine
1654     if(result == OC_STACK_OK)
1655     {
1656         result = SRMInitPolicyEngine();
1657         // TODO after BeachHead delivery: consolidate into single SRMInit()
1658     }
1659
1660 exit:
1661     if(result != OC_STACK_OK)
1662     {
1663         OC_LOG(ERROR, TAG, PCF("Stack initialization error"));
1664         deleteAllResources();
1665         CATerminate();
1666         stackState = OC_STACK_UNINITIALIZED;
1667     }
1668     return result;
1669 }
1670
1671 OCStackResult OCStop()
1672 {
1673     OC_LOG(INFO, TAG, PCF("Entering OCStop"));
1674
1675     if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
1676     {
1677         OC_LOG(DEBUG, TAG, PCF("Stack already stopping, exiting"));
1678         return OC_STACK_OK;
1679     }
1680     else if (stackState != OC_STACK_INITIALIZED)
1681     {
1682         OC_LOG(ERROR, TAG, PCF("Stack not initialized"));
1683         return OC_STACK_ERROR;
1684     }
1685
1686     stackState = OC_STACK_UNINIT_IN_PROGRESS;
1687
1688     #ifdef WITH_PRESENCE
1689     // Ensure that the TTL associated with ANY and ALL presence notifications originating from
1690     // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
1691     presenceResource.presenceTTL = 0;
1692     #endif // WITH_PRESENCE
1693
1694     // Free memory dynamically allocated for resources
1695     deleteAllResources();
1696     DeleteDeviceInfo();
1697     DeletePlatformInfo();
1698     CATerminate();
1699     // Remove all observers
1700     DeleteObserverList();
1701     // Remove all the client callbacks
1702     DeleteClientCBList();
1703
1704         // De-init the SRM Policy Engine
1705     // TODO after BeachHead delivery: consolidate into single SRMDeInit()
1706     SRMDeInitPolicyEngine();
1707
1708
1709     stackState = OC_STACK_UNINITIALIZED;
1710     return OC_STACK_OK;
1711 }
1712
1713 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
1714 {
1715     switch (qos)
1716     {
1717         case OC_HIGH_QOS:
1718             return CA_MSG_CONFIRM;
1719         case OC_LOW_QOS:
1720         case OC_MEDIUM_QOS:
1721         case OC_NA_QOS:
1722         default:
1723             return CA_MSG_NONCONFIRM;
1724     }
1725 }
1726
1727 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
1728 {
1729     char *query;
1730
1731     query = strchr (inputUri, '?');
1732
1733     if (query != NULL)
1734     {
1735         if((query - inputUri) > MAX_URI_LENGTH)
1736         {
1737             return OC_STACK_INVALID_URI;
1738         }
1739
1740         if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
1741         {
1742             return OC_STACK_INVALID_QUERY;
1743         }
1744     }
1745     else if(uriLen > MAX_URI_LENGTH)
1746     {
1747         return OC_STACK_INVALID_URI;
1748     }
1749     return OC_STACK_OK;
1750 }
1751
1752 /**
1753  *  A request uri consists of the following components in order:
1754  *                              example
1755  *  optional prefix             "coap://"
1756  *  optionally one of
1757  *      IPv6 address            "[1234::5678]"
1758  *      IPv4 address            "192.168.1.1"
1759  *  optional port               ":5683"
1760  *  resource uri                "/oc/core..."
1761  *
1762  *  for PRESENCE requests, extract resource type.
1763  */
1764 static OCStackResult ParseRequestUri(const char *fullUri,
1765                                         OCTransportAdapter adapter,
1766                                         OCTransportFlags flags,
1767                                         OCDevAddr **devAddr,
1768                                         char **resourceUri,
1769                                         char **resourceType)
1770 {
1771     VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
1772
1773     OCStackResult result = OC_STACK_OK;
1774     OCDevAddr *da = NULL;
1775     char *colon = NULL;
1776     char *end;
1777
1778     // provide defaults for all returned values
1779     if (devAddr)
1780     {
1781         *devAddr = NULL;
1782     }
1783     if (resourceUri)
1784     {
1785         *resourceUri = NULL;
1786     }
1787     if (resourceType)
1788     {
1789         *resourceType = NULL;
1790     }
1791
1792     // delimit url prefix, if any
1793     const char *start = fullUri;
1794     char *slash2 = strstr(start, "//");
1795     if (slash2)
1796     {
1797         start = slash2 + 2;
1798     }
1799     char *slash = strchr(start, '/');
1800     if (!slash)
1801     {
1802         return OC_STACK_INVALID_URI;
1803     }
1804
1805     // processs url prefix, if any
1806     size_t urlLen = slash - start;
1807     // port
1808     uint16_t port = 0;
1809     size_t len = 0;
1810     if (urlLen && devAddr)
1811     {   // construct OCDevAddr
1812         if (OC_ADAPTER_IP == adapter)
1813         {
1814             if (start[0] == '[')
1815             {   // ipv6 address
1816                 char *close = strchr(++start, ']');
1817                 if (!close || close > slash)
1818                 {
1819                     return OC_STACK_INVALID_URI;
1820                 }
1821                 end = close;
1822                 if (close[1] == ':')
1823                 {
1824                     colon = close + 1;
1825                 }
1826             }
1827             else
1828             {   // ipv4 address
1829                 end = slash;
1830                 colon = strchr(start, ':');
1831                 end = (colon && colon < slash) ? colon : slash;
1832             }
1833             len = end - start;
1834             if (len >= sizeof(da->addr))
1835             {
1836                 return OC_STACK_INVALID_URI;
1837             }
1838             // use standard multicast port
1839             if (colon && colon < slash)
1840             {
1841                 for (colon++; colon < slash; colon++)
1842                 {
1843                     char c = colon[0];
1844                     if (c < '0' || c > '9')
1845                     {
1846                         return OC_STACK_INVALID_URI;
1847                     }
1848                     port = 10 * port + c - '0';
1849                 }
1850             }
1851         }
1852         else
1853         {
1854             /**
1855              * This is for Non-IP adapters(EDR and BLE).
1856              * The address will be between "//" and "/" in the request URI.
1857              * [Ex. coap://AB:BC:CD:DE:EF:FG/resource_uri]
1858              */
1859             end = slash;
1860         }
1861
1862         len = end - start;
1863         if (len >= sizeof(da->addr))
1864         {
1865             return OC_STACK_INVALID_URI;
1866         }
1867
1868         da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
1869         if (!da)
1870         {
1871             return OC_STACK_NO_MEMORY;
1872         }
1873         OICStrcpyPartial(da->addr, sizeof(da->addr), start, len);
1874         da->port = port;
1875         da->adapter = adapter;
1876         da->flags = flags;
1877         if (!strncmp(fullUri, "coaps:", 6))
1878         {
1879             da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
1880         }
1881         *devAddr = da;
1882     }
1883
1884     // process resource uri, if any
1885     if (slash)
1886     {   // request uri and query
1887         size_t ulen = strlen(slash); // resource uri length
1888         size_t tlen = 0;      // resource type length
1889         char *type = NULL;
1890
1891         static const char strPresence[] = "/oic/ad?rt=";
1892         static const size_t lenPresence = sizeof(strPresence) - 1;
1893         if (!strncmp(slash, strPresence, lenPresence))
1894         {
1895             type = slash + lenPresence;
1896             tlen = ulen - lenPresence;
1897         }
1898         // resource uri
1899         if (resourceUri)
1900         {
1901             *resourceUri = (char *)OICMalloc(ulen + 1);
1902             if (!*resourceUri)
1903             {
1904                 result = OC_STACK_NO_MEMORY;
1905                 goto error;
1906             }
1907             strcpy(*resourceUri, slash);
1908         }
1909         // resource type
1910         if (type && resourceType)
1911         {
1912             *resourceType = (char *)OICMalloc(tlen + 1);
1913             if (!*resourceType)
1914             {
1915                 result = OC_STACK_NO_MEMORY;
1916                 goto error;
1917             }
1918
1919             OICStrcpy(*resourceType, (tlen+1), type);
1920         }
1921     }
1922
1923     return OC_STACK_OK;
1924
1925 error:
1926     // free all returned values
1927     if (devAddr)
1928     {
1929         OICFree(*devAddr);
1930     }
1931     if (resourceUri)
1932     {
1933         OICFree(*resourceUri);
1934     }
1935     if (resourceType)
1936     {
1937         OICFree(*resourceType);
1938     }
1939     return result;
1940 }
1941
1942 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
1943                                         char *resourceUri, char **requestUri)
1944 {
1945     char uri[CA_MAX_URI_LENGTH];
1946
1947     FormCanonicalPresenceUri(endpoint, resourceUri, uri);
1948
1949     *requestUri = (char *)OICMalloc(strlen(uri) + 1);
1950     if (!*requestUri)
1951     {
1952         return OC_STACK_NO_MEMORY;
1953     }
1954
1955     strcpy(*requestUri, uri);
1956     return OC_STACK_OK;
1957 }
1958
1959 /**
1960  * Discover or Perform requests on a specified resource
1961  */
1962 OCStackResult OCDoResource(OCDoHandle *handle,
1963                             OCMethod method,
1964                             const char *requestUri,
1965                             const OCDevAddr *destination,
1966                             OCPayload* payload,
1967                             OCConnectivityType connectivityType,
1968                             OCQualityOfService qos,
1969                             OCCallbackData *cbData,
1970                             OCHeaderOption *options,
1971                             uint8_t numOptions)
1972 {
1973     OC_LOG(INFO, TAG, PCF("Entering OCDoResource"));
1974
1975     // Validate input parameters
1976     VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
1977     VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
1978     VERIFY_NON_NULL(requestUri , FATAL, OC_STACK_INVALID_URI);
1979
1980     OCStackResult result = OC_STACK_ERROR;
1981     CAResult_t caResult;
1982     CAToken_t token = NULL;
1983     uint8_t tokenLength = CA_MAX_TOKEN_LEN;
1984     ClientCB *clientCB = NULL;
1985     OCDoHandle resHandle = NULL;
1986     CAEndpoint_t *endpoint = NULL;
1987     OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
1988     uint32_t ttl = 0;
1989     OCTransportAdapter adapter;
1990     OCTransportFlags flags;
1991     // the request contents are put here
1992     CARequestInfo_t requestInfo = { CA_GET };
1993     // requestUri  will be parsed into the following three variables
1994     OCDevAddr *devAddr = NULL;
1995     char *resourceUri = NULL;
1996     char *resourceType = NULL;
1997
1998     // To track if memory is allocated for additional header options
1999     uint8_t hdrOptionMemAlloc = 0;
2000
2001     // This validation is broken, but doesn't cause harm
2002     size_t uriLen = strlen(requestUri );
2003     if ((result = verifyUriQueryLength(requestUri , uriLen)) != OC_STACK_OK)
2004     {
2005         goto exit;
2006     }
2007
2008     /*
2009      * Support original behavior with address on resourceUri argument.
2010      */
2011     adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2012     flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2013
2014     result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2015
2016     if (result != OC_STACK_OK)
2017     {
2018         OC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2019         goto exit;
2020     }
2021
2022     switch (method)
2023     {
2024     case OC_REST_GET:
2025     case OC_REST_OBSERVE:
2026     case OC_REST_OBSERVE_ALL:
2027     case OC_REST_CANCEL_OBSERVE:
2028         requestInfo.method = CA_GET;
2029         break;
2030     case OC_REST_PUT:
2031         requestInfo.method = CA_PUT;
2032         break;
2033     case OC_REST_POST:
2034         requestInfo.method = CA_POST;
2035         break;
2036     case OC_REST_DELETE:
2037         requestInfo.method = CA_DELETE;
2038         break;
2039     case OC_REST_DISCOVER:
2040         qos = OC_LOW_QOS;
2041         if (!destination && !devAddr)
2042         {
2043             destination = &tmpDevAddr;
2044         }
2045         // CA_DISCOVER will become GET and isMulticast
2046         requestInfo.method = CA_GET;
2047         requestInfo.isMulticast = true;
2048         break;
2049     #ifdef WITH_PRESENCE
2050     case OC_REST_PRESENCE:
2051         // Replacing method type with GET because "presence"
2052         // is a stack layer only implementation.
2053         requestInfo.method = CA_GET;
2054         break;
2055     #endif
2056     default:
2057         result = OC_STACK_INVALID_METHOD;
2058         goto exit;
2059     }
2060
2061     if (!devAddr && !destination)
2062     {
2063         OC_LOG_V(DEBUG, TAG, "no devAddr and no destination");
2064         result = OC_STACK_INVALID_PARAM;
2065         goto exit;
2066     }
2067
2068     /* If not original behavior, use destination argument */
2069     if (destination && !devAddr)
2070     {
2071         devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2072         if (!devAddr)
2073         {
2074             result = OC_STACK_NO_MEMORY;
2075             goto exit;
2076         }
2077         *devAddr = *destination;
2078     }
2079
2080     resHandle = GenerateInvocationHandle();
2081     if (!resHandle)
2082     {
2083         result = OC_STACK_NO_MEMORY;
2084         goto exit;
2085     }
2086
2087     caResult = CAGenerateToken(&token, tokenLength);
2088     if (caResult != CA_STATUS_OK)
2089     {
2090         OC_LOG(ERROR, TAG, PCF("CAGenerateToken error"));
2091         goto exit;
2092     }
2093
2094     // fill in request data
2095     requestInfo.info.type = qualityOfServiceToMessageType(qos);
2096     requestInfo.info.token = token;
2097     requestInfo.info.tokenLength = tokenLength;
2098     requestInfo.info.resourceUri = resourceUri;
2099
2100     if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2101     {
2102         result = CreateObserveHeaderOption (&(requestInfo.info.options),
2103                                     options, numOptions, OC_OBSERVE_REGISTER);
2104         if (result != OC_STACK_OK)
2105         {
2106             goto exit;
2107         }
2108         hdrOptionMemAlloc = 1;
2109         requestInfo.info.numOptions = numOptions + 1;
2110     }
2111     else
2112     {
2113         requestInfo.info.options = (CAHeaderOption_t*)options;
2114         requestInfo.info.numOptions = numOptions;
2115     }
2116
2117     // create remote endpoint
2118     result = OCCreateEndpoint(devAddr, &endpoint);
2119     if(payload)
2120     {
2121         if((result =
2122             OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2123                 != OC_STACK_OK)
2124         {
2125             OC_LOG(ERROR, TAG, PCF("Failed to create CBOR Payload"));
2126             goto exit;
2127         }
2128     }
2129     else
2130     {
2131         requestInfo.info.payload = NULL;
2132         requestInfo.info.payloadSize = 0;
2133     }
2134
2135
2136
2137     if (result != OC_STACK_OK)
2138     {
2139         OC_LOG(ERROR, TAG, PCF("CACreateEndpoint error"));
2140         goto exit;
2141     }
2142
2143     // prepare for response
2144     #ifdef WITH_PRESENCE
2145     if (method == OC_REST_PRESENCE)
2146     {
2147         char *presenceUri = NULL;
2148         result = OCPreparePresence(endpoint, resourceUri, &presenceUri);
2149         if (OC_STACK_OK != result)
2150         {
2151             goto exit;
2152         }
2153
2154         // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2155         // Presence notification will form a canonical uri to
2156         // look for callbacks into the application.
2157         resourceUri = presenceUri;
2158     }
2159     #endif
2160
2161     ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2162     result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2163                             method, devAddr, resourceUri, resourceType, ttl);
2164     if (OC_STACK_OK != result)
2165     {
2166         goto exit;
2167     }
2168
2169     devAddr = NULL;       // Client CB list entry now owns it
2170     resourceUri = NULL;   // Client CB list entry now owns it
2171     resourceType = NULL;  // Client CB list entry now owns it
2172
2173     // send request
2174     caResult = CASendRequest(endpoint, &requestInfo);
2175     if (caResult != CA_STATUS_OK)
2176     {
2177         OC_LOG(ERROR, TAG, PCF("CASendRequest"));
2178         result = OC_STACK_COMM_ERROR;
2179         goto exit;
2180     }
2181
2182     if (handle)
2183     {
2184         *handle = resHandle;
2185     }
2186
2187 exit:
2188     if (result != OC_STACK_OK)
2189     {
2190         OC_LOG(ERROR, TAG, PCF("OCDoResource error"));
2191         FindAndDeleteClientCB(clientCB);
2192         CADestroyToken(token);
2193         if (handle)
2194         {
2195             *handle = NULL;
2196         }
2197         OICFree(resHandle);
2198     }
2199
2200     // This is the owner of the payload object, so we free it
2201     OCPayloadDestroy(payload);
2202     OICFree(requestInfo.info.payload);
2203     OICFree(devAddr);
2204     OICFree(resourceUri);
2205     OICFree(resourceType);
2206     OICFree(endpoint);
2207     if (hdrOptionMemAlloc)
2208     {
2209         OICFree(requestInfo.info.options);
2210     }
2211     return result;
2212 }
2213
2214 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2215         uint8_t numOptions)
2216 {
2217     /*
2218      * This ftn is implemented one of two ways in the case of observation:
2219      *
2220      * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2221      *      Remove the callback associated on client side.
2222      *      When the next notification comes in from server,
2223      *      reply with RESET message to server.
2224      *      Keep in mind that the server will react to RESET only
2225      *      if the last notification was sent as CON
2226      *
2227      * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2228      *      and it is associated with an observe request
2229      *      (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2230      *      Send CON Observe request to server with
2231      *      observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2232      *      Remove the callback associated on client side.
2233      */
2234     OCStackResult ret = OC_STACK_OK;
2235     CAEndpoint_t* endpoint = NULL;
2236     CAResult_t caResult;
2237     CAInfo_t requestData = {};
2238     CARequestInfo_t requestInfo = {};
2239
2240     if(!handle)
2241     {
2242         return OC_STACK_INVALID_PARAM;
2243     }
2244
2245     ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2246     if (!clientCB)
2247     {
2248         OC_LOG(ERROR, TAG, PCF("Client callback not found. Called OCCancel twice?"));
2249         goto Error;
2250     }
2251
2252     switch (clientCB->method)
2253     {
2254         case OC_REST_OBSERVE:
2255         case OC_REST_OBSERVE_ALL:
2256             OC_LOG_V(INFO, TAG, "Canceling observation for resource %s",
2257                                         clientCB->requestUri);
2258             if (qos != OC_HIGH_QOS)
2259             {
2260                 FindAndDeleteClientCB(clientCB);
2261                 break;
2262             }
2263             else
2264             {
2265                 OC_LOG(INFO, TAG, PCF("Cancelling observation as CONFIRMABLE"));
2266             }
2267
2268             requestData.type = qualityOfServiceToMessageType(qos);
2269             requestData.token = clientCB->token;
2270             requestData.tokenLength = clientCB->tokenLength;
2271             if (CreateObserveHeaderOption (&(requestData.options),
2272                     options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2273             {
2274                 return OC_STACK_ERROR;
2275             }
2276             requestData.numOptions = numOptions + 1;
2277             requestData.resourceUri = OICStrdup (clientCB->requestUri);
2278
2279             requestInfo.method = CA_GET;
2280             requestInfo.info = requestData;
2281
2282             ret = OCCreateEndpoint(clientCB->devAddr, &endpoint);
2283             if (ret != OC_STACK_OK)
2284             {
2285                 OC_LOG(ERROR, TAG, PCF("CACreateEndpoint error"));
2286                 goto Error;
2287             }
2288
2289             // send request
2290             caResult = CASendRequest(endpoint, &requestInfo);
2291             if (caResult != CA_STATUS_OK)
2292             {
2293                 OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
2294                 ret = OC_STACK_ERROR;
2295             }
2296             ret = CAResultToOCResult (caResult);
2297             break;
2298
2299         #ifdef WITH_PRESENCE
2300         case OC_REST_PRESENCE:
2301             FindAndDeleteClientCB(clientCB);
2302             break;
2303         #endif
2304
2305         default:
2306             ret = OC_STACK_INVALID_METHOD;
2307             break;
2308     }
2309
2310 Error:
2311     OCDestroyEndpoint(endpoint);
2312     if (requestData.numOptions > 0)
2313     {
2314         OICFree(requestData.options);
2315     }
2316     if (requestData.resourceUri)
2317     {
2318         OICFree (requestData.resourceUri);
2319     }
2320
2321     return ret;
2322 }
2323
2324 /**
2325  * @brief   Register Persistent storage callback.
2326  * @param   persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2327  * @return
2328  *     OC_STACK_OK    - No errors; Success
2329  *     OC_STACK_INVALID_PARAM - Invalid parameter
2330  */
2331 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2332 {
2333     OC_LOG(INFO, TAG, PCF("RegisterPersistentStorageHandler !!"));
2334     if(!persistentStorageHandler)
2335     {
2336         OC_LOG(ERROR, TAG, PCF("The persistent storage handler is invalid"));
2337         return OC_STACK_INVALID_PARAM;
2338     }
2339     else
2340     {
2341         if( !persistentStorageHandler->open ||
2342                 !persistentStorageHandler->close ||
2343                 !persistentStorageHandler->read ||
2344                 !persistentStorageHandler->unlink ||
2345                 !persistentStorageHandler->write)
2346         {
2347             OC_LOG(ERROR, TAG, PCF("The persistent storage handler is invalid"));
2348             return OC_STACK_INVALID_PARAM;
2349         }
2350     }
2351     return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2352 }
2353
2354 #ifdef WITH_PRESENCE
2355
2356 OCStackResult OCProcessPresence()
2357 {
2358     OCStackResult result = OC_STACK_OK;
2359
2360     // the following line floods the log with messages that are irrelevant
2361     // to most purposes.  Uncomment as needed.
2362     //OC_LOG(INFO, TAG, PCF("Entering RequestPresence"));
2363     ClientCB* cbNode = NULL;
2364     OCClientResponse clientResponse;
2365     OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2366
2367     LL_FOREACH(cbList, cbNode)
2368     {
2369         if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
2370         {
2371             continue;
2372         }
2373
2374         uint32_t now = GetTicks(0);
2375         OC_LOG_V(DEBUG, TAG, "this TTL level %d",
2376                                                 cbNode->presence->TTLlevel);
2377         OC_LOG_V(DEBUG, TAG, "current ticks %d", now);
2378
2379         if(cbNode->presence->TTLlevel >= (PresenceTimeOutSize + 1))
2380         {
2381             goto exit;
2382         }
2383
2384         if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
2385         {
2386             OC_LOG_V(DEBUG, TAG, "timeout ticks %d",
2387                     cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2388         }
2389
2390         if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2391         {
2392             OC_LOG(DEBUG, TAG, PCF("No more timeout ticks"));
2393
2394             clientResponse.sequenceNumber = 0;
2395             clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
2396             clientResponse.devAddr = *cbNode->devAddr;
2397             FixUpClientResponse(&clientResponse);
2398             clientResponse.payload = NULL;
2399
2400             // Increment the TTLLevel (going to a next state), so we don't keep
2401             // sending presence notification to client.
2402             cbNode->presence->TTLlevel++;
2403             OC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
2404                                         cbNode->presence->TTLlevel);
2405
2406             cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
2407             if (cbResult == OC_STACK_DELETE_TRANSACTION)
2408             {
2409                 FindAndDeleteClientCB(cbNode);
2410             }
2411         }
2412
2413         if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2414         {
2415             continue;
2416         }
2417
2418         CAResult_t caResult = CA_STATUS_OK;
2419         CAEndpoint_t* endpoint = NULL;
2420         CAInfo_t requestData ={};
2421         CARequestInfo_t requestInfo = {};
2422
2423         OC_LOG(DEBUG, TAG, PCF("time to test server presence"));
2424
2425         result = OCCreateEndpoint(cbNode->devAddr, &endpoint);
2426         if (result != OC_STACK_OK)
2427         {
2428             OC_LOG(ERROR, TAG, PCF("CACreateEndpoint error"));
2429             goto exit;
2430         }
2431
2432         requestData.type = CA_MSG_NONCONFIRM;
2433         requestData.token = cbNode->token;
2434         requestData.tokenLength = cbNode->tokenLength;
2435         requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
2436         requestInfo.method = CA_GET;
2437         requestInfo.info = requestData;
2438
2439         caResult = CASendRequest(endpoint, &requestInfo);
2440         OCDestroyEndpoint(endpoint);
2441
2442         if (caResult != CA_STATUS_OK)
2443         {
2444             OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
2445             goto exit;
2446         }
2447
2448         cbNode->presence->TTLlevel++;
2449         OC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
2450     }
2451 exit:
2452     if (result != OC_STACK_OK)
2453     {
2454         OC_LOG(ERROR, TAG, PCF("OCProcessPresence error"));
2455     }
2456     return result;
2457 }
2458 #endif // WITH_PRESENCE
2459
2460 OCStackResult OCProcess()
2461 {
2462     #ifdef WITH_PRESENCE
2463     OCProcessPresence();
2464     #endif
2465     CAHandleRequestResponse();
2466
2467     return OC_STACK_OK;
2468 }
2469
2470 #ifdef WITH_PRESENCE
2471 OCStackResult OCStartPresence(const uint32_t ttl)
2472 {
2473     uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2474     OCChangeResourceProperty(
2475             &(((OCResource *)presenceResource.handle)->resourceProperties),
2476             OC_ACTIVE, 1);
2477
2478     if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
2479     {
2480         presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
2481         OC_LOG(INFO, TAG, PCF("Setting Presence TTL to max value"));
2482     }
2483     else if (0 == ttl)
2484     {
2485         presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
2486         OC_LOG(INFO, TAG, PCF("Setting Presence TTL to default value"));
2487     }
2488     else
2489     {
2490         presenceResource.presenceTTL = ttl;
2491     }
2492     OC_LOG_V(DEBUG, TAG, "Presence TTL is %lu seconds", presenceResource.presenceTTL);
2493
2494     if (OC_PRESENCE_UNINITIALIZED == presenceState)
2495     {
2496         presenceState = OC_PRESENCE_INITIALIZED;
2497
2498         OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
2499         OICStrcpy(devAddr.addr, sizeof(devAddr.addr), OC_MULTICAST_IP);
2500         devAddr.port = OC_MULTICAST_PORT;
2501
2502         CAToken_t caToken = NULL;
2503         CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
2504         if (caResult != CA_STATUS_OK)
2505         {
2506             OC_LOG(ERROR, TAG, PCF("CAGenerateToken error"));
2507             CADestroyToken(caToken);
2508             return OC_STACK_ERROR;
2509         }
2510
2511         AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
2512                 (OCResource *)presenceResource.handle, OC_LOW_QOS, &devAddr);
2513         CADestroyToken(caToken);
2514     }
2515
2516     // Each time OCStartPresence is called
2517     // a different random 32-bit integer number is used
2518     ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2519
2520     return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
2521             OC_PRESENCE_TRIGGER_CREATE);
2522 }
2523
2524 OCStackResult OCStopPresence()
2525 {
2526     OCStackResult result = OC_STACK_ERROR;
2527
2528     if(presenceResource.handle)
2529     {
2530         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2531
2532     // make resource inactive
2533     result = OCChangeResourceProperty(
2534             &(((OCResource *) presenceResource.handle)->resourceProperties),
2535             OC_ACTIVE, 0);
2536     }
2537
2538     if(result != OC_STACK_OK)
2539     {
2540         OC_LOG(ERROR, TAG,
2541                       PCF("Changing the presence resource properties to ACTIVE not successful"));
2542         return result;
2543     }
2544
2545     return SendStopNotification();
2546 }
2547 #endif
2548
2549 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
2550                                             void* callbackParameter)
2551 {
2552     defaultDeviceHandler = entityHandler;
2553     defaultDeviceHandlerCallbackParameter = callbackParameter;
2554
2555     return OC_STACK_OK;
2556 }
2557
2558 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo)
2559 {
2560     OC_LOG(INFO, TAG, PCF("Entering OCSetPlatformInfo"));
2561
2562     if(myStackMode ==  OC_SERVER || myStackMode == OC_CLIENT_SERVER)
2563     {
2564         if (validatePlatformInfo(platformInfo))
2565         {
2566             return SavePlatformInfo(platformInfo);
2567         }
2568         else
2569         {
2570             return OC_STACK_INVALID_PARAM;
2571         }
2572     }
2573     else
2574     {
2575         return OC_STACK_ERROR;
2576     }
2577 }
2578
2579 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
2580 {
2581     OC_LOG(INFO, TAG, PCF("Entering OCSetDeviceInfo"));
2582
2583     if (!deviceInfo.deviceName || deviceInfo.deviceName[0] == '\0')
2584     {
2585         OC_LOG(ERROR, TAG, PCF("Null or empty device name."));
2586         return OC_STACK_INVALID_PARAM;
2587     }
2588
2589     return SaveDeviceInfo(deviceInfo);
2590 }
2591
2592 OCStackResult OCCreateResource(OCResourceHandle *handle,
2593         const char *resourceTypeName,
2594         const char *resourceInterfaceName,
2595         const char *uri, OCEntityHandler entityHandler,
2596         void* callbackParam,
2597         uint8_t resourceProperties)
2598 {
2599
2600     OCResource *pointer = NULL;
2601     char *str = NULL;
2602     OCStackResult result = OC_STACK_ERROR;
2603
2604     OC_LOG(INFO, TAG, PCF("Entering OCCreateResource"));
2605
2606     if(myStackMode == OC_CLIENT)
2607     {
2608         return OC_STACK_INVALID_PARAM;
2609     }
2610     // Validate parameters
2611     if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
2612     {
2613         OC_LOG(ERROR, TAG, PCF("URI is empty or too long"));
2614         return OC_STACK_INVALID_URI;
2615     }
2616     // Is it presented during resource discovery?
2617     if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
2618     {
2619         OC_LOG(ERROR, TAG, PCF("Input parameter is NULL"));
2620         return OC_STACK_INVALID_PARAM;
2621     }
2622
2623     if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
2624     {
2625         resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
2626     }
2627
2628     // Make sure resourceProperties bitmask has allowed properties specified
2629     if (resourceProperties
2630             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
2631                OC_EXPLICIT_DISCOVERABLE))
2632     {
2633         OC_LOG(ERROR, TAG, PCF("Invalid property"));
2634         return OC_STACK_INVALID_PARAM;
2635     }
2636
2637     // If the headResource is NULL, then no resources have been created...
2638     pointer = headResource;
2639     if (pointer)
2640     {
2641         // At least one resources is in the resource list, so we need to search for
2642         // repeated URLs, which are not allowed.  If a repeat is found, exit with an error
2643         while (pointer)
2644         {
2645             if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
2646             {
2647                 OC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
2648                 return OC_STACK_INVALID_PARAM;
2649             }
2650             pointer = pointer->next;
2651         }
2652     }
2653     // Create the pointer and insert it into the resource list
2654     pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
2655     if (!pointer)
2656     {
2657         result = OC_STACK_NO_MEMORY;
2658         goto exit;
2659     }
2660     pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
2661
2662     insertResource(pointer);
2663
2664     // Set the uri
2665     str = OICStrdup(uri);
2666     if (!str)
2667     {
2668         result = OC_STACK_NO_MEMORY;
2669         goto exit;
2670     }
2671     pointer->uri = str;
2672
2673     // Set properties.  Set OC_ACTIVE
2674     pointer->resourceProperties = (OCResourceProperty) (resourceProperties
2675             | OC_ACTIVE);
2676
2677     // Add the resourcetype to the resource
2678     result = BindResourceTypeToResource(pointer, resourceTypeName);
2679     if (result != OC_STACK_OK)
2680     {
2681         OC_LOG(ERROR, TAG, PCF("Error adding resourcetype"));
2682         goto exit;
2683     }
2684
2685     // Add the resourceinterface to the resource
2686     result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
2687     if (result != OC_STACK_OK)
2688     {
2689         OC_LOG(ERROR, TAG, PCF("Error adding resourceinterface"));
2690         goto exit;
2691     }
2692
2693     // If an entity handler has been passed, attach it to the newly created
2694     // resource.  Otherwise, set the default entity handler.
2695     if (entityHandler)
2696     {
2697         pointer->entityHandler = entityHandler;
2698         pointer->entityHandlerCallbackParam = callbackParam;
2699     }
2700     else
2701     {
2702         pointer->entityHandler = defaultResourceEHandler;
2703         pointer->entityHandlerCallbackParam = NULL;
2704     }
2705
2706     *handle = pointer;
2707     result = OC_STACK_OK;
2708
2709     #ifdef WITH_PRESENCE
2710     if(presenceResource.handle)
2711     {
2712         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2713         SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
2714     }
2715     #endif
2716 exit:
2717     if (result != OC_STACK_OK)
2718     {
2719         // Deep delete of resource and other dynamic elements that it contains
2720         deleteResource(pointer);
2721         OICFree(str);
2722     }
2723     return result;
2724 }
2725
2726
2727 OCStackResult OCBindResource(
2728         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
2729 {
2730     OCResource *resource = NULL;
2731     uint8_t i = 0;
2732
2733     OC_LOG(INFO, TAG, PCF("Entering OCBindResource"));
2734
2735     // Validate parameters
2736     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
2737     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
2738     // Container cannot contain itself
2739     if (collectionHandle == resourceHandle)
2740     {
2741         OC_LOG(ERROR, TAG, PCF("Added handle equals collection handle"));
2742         return OC_STACK_INVALID_PARAM;
2743     }
2744
2745     // Use the handle to find the resource in the resource linked list
2746     resource = findResource((OCResource *) collectionHandle);
2747     if (!resource)
2748     {
2749         OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
2750         return OC_STACK_INVALID_PARAM;
2751     }
2752
2753     // Look for an open slot to add add the child resource.
2754     // If found, add it and return success
2755     for (i = 0; i < MAX_CONTAINED_RESOURCES; i++)
2756     {
2757         if (!resource->rsrcResources[i])
2758         {
2759             resource->rsrcResources[i] = (OCResource *) resourceHandle;
2760             OC_LOG(INFO, TAG, PCF("resource bound"));
2761
2762             #ifdef WITH_PRESENCE
2763             if(presenceResource.handle)
2764             {
2765                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2766                 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
2767                         OC_PRESENCE_TRIGGER_CHANGE);
2768             }
2769             #endif
2770             return OC_STACK_OK;
2771
2772         }
2773     }
2774
2775     // Unable to add resourceHandle, so return error
2776     return OC_STACK_ERROR;
2777 }
2778
2779 OCStackResult OCUnBindResource(
2780         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
2781 {
2782     OCResource *resource = NULL;
2783     uint8_t i = 0;
2784
2785     OC_LOG(INFO, TAG, PCF("Entering OCUnBindResource"));
2786
2787     // Validate parameters
2788     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
2789     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
2790     // Container cannot contain itself
2791     if (collectionHandle == resourceHandle)
2792     {
2793         OC_LOG(ERROR, TAG, PCF("removing handle equals collection handle"));
2794         return OC_STACK_INVALID_PARAM;
2795     }
2796
2797     // Use the handle to find the resource in the resource linked list
2798     resource = findResource((OCResource *) collectionHandle);
2799     if (!resource)
2800     {
2801         OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
2802         return OC_STACK_INVALID_PARAM;
2803     }
2804
2805     // Look for an open slot to add add the child resource.
2806     // If found, add it and return success
2807     for (i = 0; i < MAX_CONTAINED_RESOURCES; i++)
2808     {
2809         if (resourceHandle == resource->rsrcResources[i])
2810         {
2811             resource->rsrcResources[i] = (OCResource *) NULL;
2812             OC_LOG(INFO, TAG, PCF("resource unbound"));
2813
2814             // Send notification when resource is unbounded successfully.
2815             #ifdef WITH_PRESENCE
2816             if(presenceResource.handle)
2817             {
2818                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2819                 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
2820                         OC_PRESENCE_TRIGGER_CHANGE);
2821             }
2822             #endif
2823             return OC_STACK_OK;
2824         }
2825     }
2826
2827     OC_LOG(INFO, TAG, PCF("resource not found in collection"));
2828
2829     // Unable to add resourceHandle, so return error
2830     return OC_STACK_ERROR;
2831 }
2832
2833 OCStackResult BindResourceTypeToResource(OCResource* resource,
2834                                             const char *resourceTypeName)
2835 {
2836     OCResourceType *pointer = NULL;
2837     char *str = NULL;
2838     OCStackResult result = OC_STACK_ERROR;
2839
2840     VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
2841
2842     pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
2843     if (!pointer)
2844     {
2845         result = OC_STACK_NO_MEMORY;
2846         goto exit;
2847     }
2848
2849     str = OICStrdup(resourceTypeName);
2850     if (!str)
2851     {
2852         result = OC_STACK_NO_MEMORY;
2853         goto exit;
2854     }
2855     pointer->resourcetypename = str;
2856
2857     insertResourceType(resource, pointer);
2858     result = OC_STACK_OK;
2859
2860     exit:
2861     if (result != OC_STACK_OK)
2862     {
2863         OICFree(pointer);
2864         OICFree(str);
2865     }
2866
2867     return result;
2868 }
2869
2870 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
2871         const char *resourceInterfaceName)
2872 {
2873     OCResourceInterface *pointer = NULL;
2874     char *str = NULL;
2875     OCStackResult result = OC_STACK_ERROR;
2876
2877     VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
2878
2879     OC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
2880
2881     pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
2882     if (!pointer)
2883     {
2884         result = OC_STACK_NO_MEMORY;
2885         goto exit;
2886     }
2887
2888     str = OICStrdup(resourceInterfaceName);
2889     if (!str)
2890     {
2891         result = OC_STACK_NO_MEMORY;
2892         goto exit;
2893     }
2894     pointer->name = str;
2895
2896     // Bind the resourceinterface to the resource
2897     insertResourceInterface(resource, pointer);
2898
2899     result = OC_STACK_OK;
2900
2901     exit:
2902     if (result != OC_STACK_OK)
2903     {
2904         OICFree(pointer);
2905         OICFree(str);
2906     }
2907
2908     return result;
2909 }
2910
2911 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
2912         const char *resourceTypeName)
2913 {
2914
2915     OCStackResult result = OC_STACK_ERROR;
2916     OCResource *resource = NULL;
2917
2918     resource = findResource((OCResource *) handle);
2919     if (!resource)
2920     {
2921         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2922         return OC_STACK_ERROR;
2923     }
2924
2925     result = BindResourceTypeToResource(resource, resourceTypeName);
2926
2927     #ifdef WITH_PRESENCE
2928     if(presenceResource.handle)
2929     {
2930         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2931         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
2932     }
2933     #endif
2934
2935     return result;
2936 }
2937
2938 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
2939         const char *resourceInterfaceName)
2940 {
2941
2942     OCStackResult result = OC_STACK_ERROR;
2943     OCResource *resource = NULL;
2944
2945     resource = findResource((OCResource *) handle);
2946     if (!resource)
2947     {
2948         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2949         return OC_STACK_ERROR;
2950     }
2951
2952     result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
2953
2954     #ifdef WITH_PRESENCE
2955     if(presenceResource.handle)
2956     {
2957         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2958         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
2959     }
2960     #endif
2961
2962     return result;
2963 }
2964
2965 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
2966 {
2967     OCResource *pointer = headResource;
2968
2969     VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
2970     *numResources = 0;
2971     while (pointer)
2972     {
2973         *numResources = *numResources + 1;
2974         pointer = pointer->next;
2975     }
2976     return OC_STACK_OK;
2977 }
2978
2979 OCResourceHandle OCGetResourceHandle(uint8_t index)
2980 {
2981     OCResource *pointer = headResource;
2982
2983     for( uint8_t i = 0; i < index && pointer; ++i)
2984     {
2985         pointer = pointer->next;
2986     }
2987     return (OCResourceHandle) pointer;
2988 }
2989
2990 OCStackResult OCDeleteResource(OCResourceHandle handle)
2991 {
2992     if (!handle)
2993     {
2994         OC_LOG(ERROR, TAG, PCF("Invalid handle for deletion"));
2995         return OC_STACK_INVALID_PARAM;
2996     }
2997
2998     OCResource *resource = findResource((OCResource *) handle);
2999     if (resource == NULL)
3000     {
3001         OC_LOG(ERROR, TAG, PCF("Resource not found"));
3002         return OC_STACK_NO_RESOURCE;
3003     }
3004
3005     if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3006     {
3007         OC_LOG(ERROR, TAG, PCF("Error deleting resource"));
3008         return OC_STACK_ERROR;
3009     }
3010
3011     return OC_STACK_OK;
3012 }
3013
3014 const char *OCGetResourceUri(OCResourceHandle handle)
3015 {
3016     OCResource *resource = NULL;
3017
3018     resource = findResource((OCResource *) handle);
3019     if (resource)
3020     {
3021         return resource->uri;
3022     }
3023     return (const char *) NULL;
3024 }
3025
3026 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3027 {
3028     OCResource *resource = NULL;
3029
3030     resource = findResource((OCResource *) handle);
3031     if (resource)
3032     {
3033         return resource->resourceProperties;
3034     }
3035     return (OCResourceProperty)-1;
3036 }
3037
3038 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3039         uint8_t *numResourceTypes)
3040 {
3041     OCResource *resource = NULL;
3042     OCResourceType *pointer = NULL;
3043
3044     VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3045     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3046
3047     *numResourceTypes = 0;
3048
3049     resource = findResource((OCResource *) handle);
3050     if (resource)
3051     {
3052         pointer = resource->rsrcType;
3053         while (pointer)
3054         {
3055             *numResourceTypes = *numResourceTypes + 1;
3056             pointer = pointer->next;
3057         }
3058     }
3059     return OC_STACK_OK;
3060 }
3061
3062 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3063 {
3064     OCResourceType *resourceType = NULL;
3065
3066     resourceType = findResourceTypeAtIndex(handle, index);
3067     if (resourceType)
3068     {
3069         return resourceType->resourcetypename;
3070     }
3071     return (const char *) NULL;
3072 }
3073
3074 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3075         uint8_t *numResourceInterfaces)
3076 {
3077     OCResourceInterface *pointer = NULL;
3078     OCResource *resource = NULL;
3079
3080     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3081     VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3082
3083     *numResourceInterfaces = 0;
3084     resource = findResource((OCResource *) handle);
3085     if (resource)
3086     {
3087         pointer = resource->rsrcInterface;
3088         while (pointer)
3089         {
3090             *numResourceInterfaces = *numResourceInterfaces + 1;
3091             pointer = pointer->next;
3092         }
3093     }
3094     return OC_STACK_OK;
3095 }
3096
3097 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3098 {
3099     OCResourceInterface *resourceInterface = NULL;
3100
3101     resourceInterface = findResourceInterfaceAtIndex(handle, index);
3102     if (resourceInterface)
3103     {
3104         return resourceInterface->name;
3105     }
3106     return (const char *) NULL;
3107 }
3108
3109 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3110         uint8_t index)
3111 {
3112     OCResource *resource = NULL;
3113
3114     if (index >= MAX_CONTAINED_RESOURCES)
3115     {
3116         return NULL;
3117     }
3118
3119     resource = findResource((OCResource *) collectionHandle);
3120     if (!resource)
3121     {
3122         return NULL;
3123     }
3124
3125     return resource->rsrcResources[index];
3126 }
3127
3128 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3129         OCEntityHandler entityHandler,
3130         void* callbackParam)
3131 {
3132     OCResource *resource = NULL;
3133
3134     // Validate parameters
3135     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3136
3137     // Use the handle to find the resource in the resource linked list
3138     resource = findResource((OCResource *)handle);
3139     if (!resource)
3140     {
3141         OC_LOG(ERROR, TAG, PCF("Resource not found"));
3142         return OC_STACK_ERROR;
3143     }
3144
3145     // Bind the handler
3146     resource->entityHandler = entityHandler;
3147     resource->entityHandlerCallbackParam = callbackParam;
3148
3149     #ifdef WITH_PRESENCE
3150     if(presenceResource.handle)
3151     {
3152         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3153         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3154     }
3155     #endif
3156
3157     return OC_STACK_OK;
3158 }
3159
3160 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3161 {
3162     OCResource *resource = NULL;
3163
3164     resource = findResource((OCResource *)handle);
3165     if (!resource)
3166     {
3167         OC_LOG(ERROR, TAG, PCF("Resource not found"));
3168         return NULL;
3169     }
3170
3171     // Bind the handler
3172     return resource->entityHandler;
3173 }
3174
3175 void incrementSequenceNumber(OCResource * resPtr)
3176 {
3177     // Increment the sequence number
3178     resPtr->sequenceNum += 1;
3179     if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3180     {
3181         resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3182     }
3183     return;
3184 }
3185
3186 #ifdef WITH_PRESENCE
3187 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3188         OCPresenceTrigger trigger)
3189 {
3190     OCResource *resPtr = NULL;
3191     OCStackResult result = OC_STACK_ERROR;
3192     OCMethod method = OC_REST_PRESENCE;
3193     uint32_t maxAge = 0;
3194     resPtr = findResource((OCResource *) presenceResource.handle);
3195     if(NULL == resPtr)
3196     {
3197         return OC_STACK_NO_RESOURCE;
3198     }
3199
3200     if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3201     {
3202         maxAge = presenceResource.presenceTTL;
3203
3204         result = SendAllObserverNotification(method, resPtr, maxAge,
3205                 trigger, resourceType, OC_LOW_QOS);
3206     }
3207
3208     return result;
3209 }
3210
3211 OCStackResult SendStopNotification()
3212 {
3213     OCResource *resPtr = NULL;
3214     OCStackResult result = OC_STACK_ERROR;
3215     OCMethod method = OC_REST_PRESENCE;
3216     resPtr = findResource((OCResource *) presenceResource.handle);
3217     if(NULL == resPtr)
3218     {
3219         return OC_STACK_NO_RESOURCE;
3220     }
3221
3222     // maxAge is 0. ResourceType is NULL.
3223     result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3224             NULL, OC_LOW_QOS);
3225
3226     return result;
3227 }
3228
3229 #endif // WITH_PRESENCE
3230 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3231 {
3232     OCResource *resPtr = NULL;
3233     OCStackResult result = OC_STACK_ERROR;
3234     OCMethod method = OC_REST_NOMETHOD;
3235     uint32_t maxAge = 0;
3236
3237     OC_LOG(INFO, TAG, PCF("Notifying all observers"));
3238     #ifdef WITH_PRESENCE
3239     if(handle == presenceResource.handle)
3240     {
3241         return OC_STACK_OK;
3242     }
3243     #endif // WITH_PRESENCE
3244     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3245
3246     // Verify that the resource exists
3247     resPtr = findResource ((OCResource *) handle);
3248     if (NULL == resPtr)
3249     {
3250         return OC_STACK_NO_RESOURCE;
3251     }
3252     else
3253     {
3254         //only increment in the case of regular observing (not presence)
3255         incrementSequenceNumber(resPtr);
3256         method = OC_REST_OBSERVE;
3257         maxAge = MAX_OBSERVE_AGE;
3258         #ifdef WITH_PRESENCE
3259         result = SendAllObserverNotification (method, resPtr, maxAge,
3260                 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3261         #else
3262         result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3263         #endif
3264         return result;
3265     }
3266 }
3267
3268 OCStackResult
3269 OCNotifyListOfObservers (OCResourceHandle handle,
3270                          OCObservationId  *obsIdList,
3271                          uint8_t          numberOfIds,
3272                          const OCRepPayload       *payload,
3273                          OCQualityOfService qos)
3274 {
3275     OC_LOG(INFO, TAG, PCF("Entering OCNotifyListOfObservers"));
3276
3277     OCResource *resPtr = NULL;
3278     //TODO: we should allow the server to define this
3279     uint32_t maxAge = MAX_OBSERVE_AGE;
3280
3281     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3282     VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3283     VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
3284
3285     resPtr = findResource ((OCResource *) handle);
3286     if (NULL == resPtr || myStackMode == OC_CLIENT)
3287     {
3288         return OC_STACK_NO_RESOURCE;
3289     }
3290     else
3291     {
3292         incrementSequenceNumber(resPtr);
3293     }
3294     return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3295             payload, maxAge, qos));
3296 }
3297
3298 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3299 {
3300     OCStackResult result = OC_STACK_ERROR;
3301     OCServerRequest *serverRequest = NULL;
3302
3303     OC_LOG(INFO, TAG, PCF("Entering OCDoResponse"));
3304
3305     // Validate input parameters
3306     VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3307     VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3308
3309     // Normal response
3310     // Get pointer to request info
3311     serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3312     if(serverRequest)
3313     {
3314         // response handler in ocserverrequest.c. Usually HandleSingleResponse.
3315         result = serverRequest->ehResponseHandler(ehResponse);
3316     }
3317
3318     return result;
3319 }
3320
3321 //-----------------------------------------------------------------------------
3322 // Private internal function definitions
3323 //-----------------------------------------------------------------------------
3324 static OCDoHandle GenerateInvocationHandle()
3325 {
3326     OCDoHandle handle = NULL;
3327     // Generate token here, it will be deleted when the transaction is deleted
3328     handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3329     if (handle)
3330     {
3331         OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3332     }
3333
3334     return handle;
3335 }
3336
3337 #ifdef WITH_PRESENCE
3338 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3339         OCResourceProperty resourceProperties, uint8_t enable)
3340 {
3341     if (!inputProperty)
3342     {
3343         return OC_STACK_INVALID_PARAM;
3344     }
3345     if (resourceProperties
3346             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
3347     {
3348         OC_LOG(ERROR, TAG, PCF("Invalid property"));
3349         return OC_STACK_INVALID_PARAM;
3350     }
3351     if(!enable)
3352     {
3353         *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3354     }
3355     else
3356     {
3357         *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3358     }
3359     return OC_STACK_OK;
3360 }
3361 #endif
3362
3363 OCStackResult initResources()
3364 {
3365     OCStackResult result = OC_STACK_OK;
3366
3367     headResource = NULL;
3368     tailResource = NULL;
3369     // Init Virtual Resources
3370     #ifdef WITH_PRESENCE
3371     presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
3372
3373     result = OCCreateResource(&presenceResource.handle,
3374             OC_RSRVD_RESOURCE_TYPE_PRESENCE,
3375             "core.r",
3376             OC_RSRVD_PRESENCE_URI,
3377             NULL,
3378             NULL,
3379             OC_OBSERVABLE);
3380     //make resource inactive
3381     result = OCChangeResourceProperty(
3382             &(((OCResource *) presenceResource.handle)->resourceProperties),
3383             OC_ACTIVE, 0);
3384     #endif
3385
3386     if (result == OC_STACK_OK)
3387     {
3388         result = SRMInitSecureResources();
3389     }
3390
3391     return result;
3392 }
3393
3394 void insertResource(OCResource *resource)
3395 {
3396     if (!headResource)
3397     {
3398         headResource = resource;
3399         tailResource = resource;
3400     }
3401     else
3402     {
3403         tailResource->next = resource;
3404         tailResource = resource;
3405     }
3406     resource->next = NULL;
3407 }
3408
3409 OCResource *findResource(OCResource *resource)
3410 {
3411     OCResource *pointer = headResource;
3412
3413     while (pointer)
3414     {
3415         if (pointer == resource)
3416         {
3417             return resource;
3418         }
3419         pointer = pointer->next;
3420     }
3421     return NULL;
3422 }
3423
3424 void deleteAllResources()
3425 {
3426     OCResource *pointer = headResource;
3427     OCResource *temp = NULL;
3428
3429     while (pointer)
3430     {
3431         temp = pointer->next;
3432         #ifdef WITH_PRESENCE
3433         if(pointer != (OCResource *) presenceResource.handle)
3434         {
3435         #endif // WITH_PRESENCE
3436             deleteResource(pointer);
3437         #ifdef WITH_PRESENCE
3438         }
3439         #endif // WITH_PRESENCE
3440         pointer = temp;
3441     }
3442
3443     SRMDeInitSecureResources();
3444
3445     #ifdef WITH_PRESENCE
3446     // Ensure that the last resource to be deleted is the presence resource. This allows for all
3447     // presence notification attributed to their deletion to be processed.
3448     deleteResource((OCResource *) presenceResource.handle);
3449     #endif // WITH_PRESENCE
3450 }
3451
3452 OCStackResult deleteResource(OCResource *resource)
3453 {
3454     OCResource *prev = NULL;
3455     OCResource *temp = NULL;
3456     if(!resource)
3457     {
3458         OC_LOG_V(DEBUG,TAG,"resource is NULL");
3459         return OC_STACK_INVALID_PARAM;
3460     }
3461
3462     OC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
3463
3464     temp = headResource;
3465     while (temp)
3466     {
3467         if (temp == resource)
3468         {
3469             // Invalidate all Resource Properties.
3470             resource->resourceProperties = (OCResourceProperty) 0;
3471             #ifdef WITH_PRESENCE
3472             if(resource != (OCResource *) presenceResource.handle)
3473             {
3474             #endif // WITH_PRESENCE
3475                 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
3476             #ifdef WITH_PRESENCE
3477             }
3478
3479             if(presenceResource.handle)
3480             {
3481                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3482                 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
3483             }
3484             #endif
3485             // Only resource in list.
3486             if (temp == headResource && temp == tailResource)
3487             {
3488                 headResource = NULL;
3489                 tailResource = NULL;
3490             }
3491             // Deleting head.
3492             else if (temp == headResource)
3493             {
3494                 headResource = temp->next;
3495             }
3496             // Deleting tail.
3497             else if (temp == tailResource)
3498             {
3499                 tailResource = prev;
3500                 tailResource->next = NULL;
3501             }
3502             else
3503             {
3504                 prev->next = temp->next;
3505             }
3506
3507             deleteResourceElements(temp);
3508             OICFree(temp);
3509             return OC_STACK_OK;
3510         }
3511         else
3512         {
3513             prev = temp;
3514             temp = temp->next;
3515         }
3516     }
3517
3518     return OC_STACK_ERROR;
3519 }
3520
3521 void deleteResourceElements(OCResource *resource)
3522 {
3523     if (!resource)
3524     {
3525         return;
3526     }
3527
3528     OICFree(resource->uri);
3529     deleteResourceType(resource->rsrcType);
3530     deleteResourceInterface(resource->rsrcInterface);
3531 }
3532
3533 void deleteResourceType(OCResourceType *resourceType)
3534 {
3535     OCResourceType *pointer = resourceType;
3536     OCResourceType *next = NULL;
3537
3538     while (pointer)
3539     {
3540         next = pointer->next;
3541         OICFree(pointer->resourcetypename);
3542         OICFree(pointer);
3543         pointer = next;
3544     }
3545 }
3546
3547 void deleteResourceInterface(OCResourceInterface *resourceInterface)
3548 {
3549     OCResourceInterface *pointer = resourceInterface;
3550     OCResourceInterface *next = NULL;
3551
3552     while (pointer)
3553     {
3554         next = pointer->next;
3555         OICFree(pointer->name);
3556         OICFree(pointer);
3557         pointer = next;
3558     }
3559 }
3560
3561 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
3562 {
3563     OCResourceType *pointer = NULL;
3564     OCResourceType *previous = NULL;
3565     if (!resource || !resourceType)
3566     {
3567         return;
3568     }
3569     // resource type list is empty.
3570     else if (!resource->rsrcType)
3571     {
3572         resource->rsrcType = resourceType;
3573     }
3574     else
3575     {
3576         pointer = resource->rsrcType;
3577
3578         while (pointer)
3579         {
3580             if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
3581             {
3582                 OC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
3583                 OICFree(resourceType->resourcetypename);
3584                 OICFree(resourceType);
3585                 return;
3586             }
3587             previous = pointer;
3588             pointer = pointer->next;
3589         }
3590         previous->next = resourceType;
3591     }
3592     resourceType->next = NULL;
3593
3594     OC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
3595 }
3596
3597 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
3598 {
3599     OCResource *resource = NULL;
3600     OCResourceType *pointer = NULL;
3601
3602     // Find the specified resource
3603     resource = findResource((OCResource *) handle);
3604     if (!resource)
3605     {
3606         return NULL;
3607     }
3608
3609     // Make sure a resource has a resourcetype
3610     if (!resource->rsrcType)
3611     {
3612         return NULL;
3613     }
3614
3615     // Iterate through the list
3616     pointer = resource->rsrcType;
3617     for(uint8_t i = 0; i< index && pointer; ++i)
3618     {
3619         pointer = pointer->next;
3620     }
3621     return pointer;
3622 }
3623
3624 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
3625 {
3626     if(resourceTypeList && resourceTypeName)
3627     {
3628         OCResourceType * rtPointer = resourceTypeList;
3629         while(resourceTypeName && rtPointer)
3630         {
3631             if(rtPointer->resourcetypename &&
3632                     strcmp(resourceTypeName, (const char *)
3633                     (rtPointer->resourcetypename)) == 0)
3634             {
3635                 break;
3636             }
3637             rtPointer = rtPointer->next;
3638         }
3639         return rtPointer;
3640     }
3641     return NULL;
3642 }
3643
3644 /*
3645  * Insert a new interface into interface linked list only if not already present.
3646  * If alredy present, 2nd arg is free'd.
3647  * Default interface will always be first if present.
3648  */
3649 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
3650 {
3651     OCResourceInterface *pointer = NULL;
3652     OCResourceInterface *previous = NULL;
3653
3654     newInterface->next = NULL;
3655
3656     OCResourceInterface **firstInterface = &(resource->rsrcInterface);
3657
3658     if (!*firstInterface)
3659     {
3660         *firstInterface = newInterface;
3661     }
3662     else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
3663     {
3664         if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
3665         {
3666             OICFree(newInterface->name);
3667             OICFree(newInterface);
3668             return;
3669         }
3670         else
3671         {
3672             newInterface->next = *firstInterface;
3673             *firstInterface = newInterface;
3674         }
3675     }
3676     else
3677     {
3678         pointer = *firstInterface;
3679         while (pointer)
3680         {
3681             if (strcmp(newInterface->name, pointer->name) == 0)
3682             {
3683                 OICFree(newInterface->name);
3684                 OICFree(newInterface);
3685                 return;
3686             }
3687             previous = pointer;
3688             pointer = pointer->next;
3689         }
3690         previous->next = newInterface;
3691     }
3692 }
3693
3694 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
3695         uint8_t index)
3696 {
3697     OCResource *resource = NULL;
3698     OCResourceInterface *pointer = NULL;
3699
3700     // Find the specified resource
3701     resource = findResource((OCResource *) handle);
3702     if (!resource)
3703     {
3704         return NULL;
3705     }
3706
3707     // Make sure a resource has a resourceinterface
3708     if (!resource->rsrcInterface)
3709     {
3710         return NULL;
3711     }
3712
3713     // Iterate through the list
3714     pointer = resource->rsrcInterface;
3715
3716     for (uint8_t i = 0; i < index && pointer; ++i)
3717     {
3718         pointer = pointer->next;
3719     }
3720     return pointer;
3721 }
3722
3723 /*
3724  * This function splits the uri using the '?' delimiter.
3725  * "uriWithoutQuery" is the block of characters between the beginning
3726  * till the delimiter or '\0' which ever comes first.
3727  * "query" is whatever is to the right of the delimiter if present.
3728  * No delimiter sets the query to NULL.
3729  * If either are present, they will be malloc'ed into the params 2, 3.
3730  * The first param, *uri is left untouched.
3731
3732  * NOTE: This function does not account for whitespace at the end of the uri NOR
3733  *       malformed uri's with '??'. Whitespace at the end will be assumed to be
3734  *       part of the query.
3735  */
3736 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
3737 {
3738     if(!uri)
3739     {
3740         return OC_STACK_INVALID_URI;
3741     }
3742     if(!query || !uriWithoutQuery)
3743     {
3744         return OC_STACK_INVALID_PARAM;
3745     }
3746
3747     *query           = NULL;
3748     *uriWithoutQuery = NULL;
3749
3750     size_t uriWithoutQueryLen = 0;
3751     size_t queryLen = 0;
3752     size_t uriLen = strlen(uri);
3753
3754     char *pointerToDelimiter = strstr(uri, "?");
3755
3756     uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : pointerToDelimiter - uri;
3757     queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
3758
3759     if (uriWithoutQueryLen)
3760     {
3761         *uriWithoutQuery =  (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
3762         if (!*uriWithoutQuery)
3763         {
3764             goto exit;
3765         }
3766         OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
3767     }
3768     if (queryLen)
3769     {
3770         *query = (char *) OICCalloc(queryLen + 1, 1);
3771         if (!*query)
3772         {
3773             OICFree(*uriWithoutQuery);
3774             *uriWithoutQuery = NULL;
3775             goto exit;
3776         }
3777         OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
3778     }
3779
3780     return OC_STACK_OK;
3781
3782     exit:
3783         return OC_STACK_NO_MEMORY;
3784 }
3785
3786 const uint8_t* OCGetServerInstanceID(void)
3787 {
3788     static bool generated = false;
3789     static ServerID sid;
3790     if(generated)
3791     {
3792         return sid;
3793     }
3794
3795     if (OCGenerateUuid(sid) != RAND_UUID_OK)
3796     {
3797         OC_LOG(FATAL, TAG, PCF("Generate UUID for Server Instance failed!"));
3798         return NULL;
3799     }
3800     generated = true;
3801     return sid;
3802 }
3803
3804 const char* OCGetServerInstanceIDString(void)
3805 {
3806     static bool generated = false;
3807     static char sidStr[UUID_STRING_SIZE];
3808
3809     if(generated)
3810     {
3811         return sidStr;
3812     }
3813
3814     const uint8_t* sid = OCGetServerInstanceID();
3815
3816     if(OCConvertUuidToString(sid, sidStr) != RAND_UUID_OK)
3817     {
3818         OC_LOG(FATAL, TAG, PCF("Generate UUID String for Server Instance failed!"));
3819         return NULL;
3820     }
3821
3822     generated = true;
3823     return sidStr;
3824 }
3825
3826 CAResult_t OCSelectNetwork()
3827 {
3828     CAResult_t retResult = CA_STATUS_FAILED;
3829     CAResult_t caResult = CA_STATUS_OK;
3830
3831     CATransportAdapter_t connTypes[] = {
3832             CA_ADAPTER_IP,
3833             CA_ADAPTER_RFCOMM_BTEDR,
3834             CA_ADAPTER_GATT_BTLE
3835
3836             #ifdef RA_ADAPTER
3837             ,CA_ADAPTER_REMOTE_ACCESS
3838             #endif
3839         };
3840     int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
3841
3842     for(int i = 0; i<numConnTypes; i++)
3843     {
3844         // Ignore CA_NOT_SUPPORTED error. The CA Layer may have not compiled in the interface.
3845         if(caResult == CA_STATUS_OK || caResult == CA_NOT_SUPPORTED)
3846         {
3847            caResult = CASelectNetwork(connTypes[i]);
3848            if(caResult == CA_STATUS_OK)
3849            {
3850                retResult = CA_STATUS_OK;
3851            }
3852         }
3853     }
3854
3855     if(retResult != CA_STATUS_OK)
3856     {
3857         return caResult; // Returns error of appropriate transport that failed fatally.
3858     }
3859
3860     return retResult;
3861 }
3862
3863 OCStackResult CAResultToOCResult(CAResult_t caResult)
3864 {
3865     switch (caResult)
3866     {
3867         case CA_STATUS_OK:
3868             return OC_STACK_OK;
3869         case CA_STATUS_INVALID_PARAM:
3870             return OC_STACK_INVALID_PARAM;
3871         case CA_ADAPTER_NOT_ENABLED:
3872             return OC_STACK_ADAPTER_NOT_ENABLED;
3873         case CA_SERVER_STARTED_ALREADY:
3874             return OC_STACK_OK;
3875         case CA_SERVER_NOT_STARTED:
3876             return OC_STACK_ERROR;
3877         case CA_DESTINATION_NOT_REACHABLE:
3878             return OC_STACK_COMM_ERROR;
3879         case CA_SOCKET_OPERATION_FAILED:
3880             return OC_STACK_COMM_ERROR;
3881         case CA_SEND_FAILED:
3882             return OC_STACK_COMM_ERROR;
3883         case CA_RECEIVE_FAILED:
3884             return OC_STACK_COMM_ERROR;
3885         case CA_MEMORY_ALLOC_FAILED:
3886             return OC_STACK_NO_MEMORY;
3887         case CA_REQUEST_TIMEOUT:
3888             return OC_STACK_TIMEOUT;
3889         case CA_DESTINATION_DISCONNECTED:
3890             return OC_STACK_COMM_ERROR;
3891         case CA_STATUS_FAILED:
3892             return OC_STACK_ERROR;
3893         case CA_NOT_SUPPORTED:
3894             return OC_STACK_NOTIMPL;
3895         default:
3896             return OC_STACK_ERROR;
3897     }
3898 }