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