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