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 OCHandleResponse");
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         if (!serverRequest.payload)
1680         {
1681             OIC_LOG(ERROR, TAG, "Allocation for payload failed.");
1682             return;
1683         }
1684         memcpy (serverRequest.payload, requestInfo->info.payload,
1685                 requestInfo->info.payloadSize);
1686     }
1687     else
1688     {
1689         serverRequest.reqTotalSize = 0;
1690     }
1691
1692     switch (requestInfo->method)
1693     {
1694         case CA_GET:
1695             serverRequest.method = OC_REST_GET;
1696             break;
1697         case CA_PUT:
1698             serverRequest.method = OC_REST_PUT;
1699             break;
1700         case CA_POST:
1701             serverRequest.method = OC_REST_POST;
1702             break;
1703         case CA_DELETE:
1704             serverRequest.method = OC_REST_DELETE;
1705             break;
1706         default:
1707             OIC_LOG_V(ERROR, TAG, "Received CA method %d not supported", requestInfo->method);
1708             SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_REQ,
1709                         requestInfo->info.type, requestInfo->info.numOptions,
1710                         requestInfo->info.options, requestInfo->info.token,
1711                         requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1712             OICFree(serverRequest.payload);
1713             return;
1714     }
1715
1716     OIC_LOG_BUFFER(INFO, TAG, (const uint8_t *)requestInfo->info.token,
1717             requestInfo->info.tokenLength);
1718
1719     serverRequest.tokenLength = requestInfo->info.tokenLength;
1720     if (serverRequest.tokenLength) {
1721         // Non empty token
1722         serverRequest.requestToken = (CAToken_t)OICMalloc(requestInfo->info.tokenLength);
1723
1724         if (!serverRequest.requestToken)
1725         {
1726             OIC_LOG(FATAL, TAG, "Allocation for token failed.");
1727             SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_INTERNAL_SERVER_ERROR,
1728                     requestInfo->info.type, requestInfo->info.numOptions,
1729                     requestInfo->info.options, requestInfo->info.token,
1730                     requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1731             OICFree(serverRequest.payload);
1732             return;
1733         }
1734         memcpy(serverRequest.requestToken, requestInfo->info.token, requestInfo->info.tokenLength);
1735     }
1736
1737     switch (requestInfo->info.acceptFormat)
1738     {
1739         case CA_FORMAT_APPLICATION_CBOR:
1740             serverRequest.acceptFormat = OC_FORMAT_CBOR;
1741             break;
1742         case CA_FORMAT_UNDEFINED:
1743             serverRequest.acceptFormat = OC_FORMAT_UNDEFINED;
1744             break;
1745         default:
1746             serverRequest.acceptFormat = OC_FORMAT_UNSUPPORTED;
1747     }
1748
1749     if (requestInfo->info.type == CA_MSG_CONFIRM)
1750     {
1751         serverRequest.qos = OC_HIGH_QOS;
1752     }
1753     else
1754     {
1755         serverRequest.qos = OC_LOW_QOS;
1756     }
1757     // CA does not need the following field
1758     // Are we sure CA does not need them? how is it responding to multicast
1759     serverRequest.delayedResNeeded = 0;
1760
1761     serverRequest.coapID = requestInfo->info.messageId;
1762
1763     CopyEndpointToDevAddr(endPoint, &serverRequest.devAddr);
1764
1765     // copy vendor specific header options
1766     uint8_t tempNum = (requestInfo->info.numOptions);
1767
1768     // Assume no observation requested and it is a pure GET.
1769     // If obs registration/de-registration requested it'll be fetched from the
1770     // options in GetObserveHeaderOption()
1771     serverRequest.observationOption = OC_OBSERVE_NO_OPTION;
1772
1773     GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &tempNum);
1774     if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
1775     {
1776         OIC_LOG(ERROR, TAG,
1777                 "The request info numOptions is greater than MAX_HEADER_OPTIONS");
1778         SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_BAD_OPT,
1779                 requestInfo->info.type, requestInfo->info.numOptions,
1780                 requestInfo->info.options, requestInfo->info.token,
1781                 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1782         OICFree(serverRequest.payload);
1783         OICFree(serverRequest.requestToken);
1784         return;
1785     }
1786     serverRequest.numRcvdVendorSpecificHeaderOptions = tempNum;
1787     if (serverRequest.numRcvdVendorSpecificHeaderOptions)
1788     {
1789         memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
1790             sizeof(CAHeaderOption_t)*tempNum);
1791     }
1792
1793     requestResult = HandleStackRequests (&serverRequest);
1794
1795     // Send ACK to client as precursor to slow response
1796     if (requestResult == OC_STACK_SLOW_RESOURCE)
1797     {
1798         if (requestInfo->info.type == CA_MSG_CONFIRM)
1799         {
1800             SendDirectStackResponse(endPoint, requestInfo->info.messageId, CA_EMPTY,
1801                                     CA_MSG_ACKNOWLEDGE,0, NULL, NULL, 0, NULL);
1802         }
1803     }
1804     else if(requestResult != OC_STACK_OK)
1805     {
1806         OIC_LOG_V(ERROR, TAG, "HandleStackRequests failed. error: %d", requestResult);
1807
1808         CAResponseResult_t stackResponse =
1809             OCToCAStackResult(requestResult, serverRequest.method);
1810
1811         SendDirectStackResponse(endPoint, requestInfo->info.messageId, stackResponse,
1812                 requestInfo->info.type, requestInfo->info.numOptions,
1813                 requestInfo->info.options, requestInfo->info.token,
1814                 requestInfo->info.tokenLength, requestInfo->info.resourceUri);
1815     }
1816     // requestToken is fed to HandleStackRequests, which then goes to AddServerRequest.
1817     // The token is copied in there, and is thus still owned by this function.
1818     OICFree(serverRequest.payload);
1819     OICFree(serverRequest.requestToken);
1820     OIC_LOG(INFO, TAG, "Exit OCHandleRequests");
1821 }
1822
1823 //This function will be called back by CA layer when a request is received
1824 void HandleCARequests(const CAEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
1825 {
1826     OIC_LOG(INFO, TAG, "Enter HandleCARequests");
1827     if(!endPoint)
1828     {
1829         OIC_LOG(ERROR, TAG, "endPoint is NULL");
1830         return;
1831     }
1832
1833     if(!requestInfo)
1834     {
1835         OIC_LOG(ERROR, TAG, "requestInfo is NULL");
1836         return;
1837     }
1838
1839 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
1840 #ifdef ROUTING_GATEWAY
1841     bool needRIHandling = false;
1842     bool isEmptyMsg = false;
1843     /*
1844      * Routing manager is going to update either of endpoint or request or both.
1845      * This typecasting is done to avoid unnecessary duplication of Endpoint and requestInfo
1846      * RM can update "routeData" option in endPoint so that future RI requests can be sent to proper
1847      * destination. It can also remove "RM" coap header option before passing request / response to
1848      * RI as this option will make no sense to either RI or application.
1849      */
1850     OCStackResult ret = RMHandleRequest((CARequestInfo_t *)requestInfo, (CAEndpoint_t *)endPoint,
1851                                         &needRIHandling, &isEmptyMsg);
1852     if(OC_STACK_OK != ret || !needRIHandling)
1853     {
1854         OIC_LOG_V(INFO, TAG, "Routing status![%d]. Not forwarding to RI", ret);
1855         return;
1856     }
1857 #endif
1858
1859     /*
1860      * Put source in sender endpoint so that the next packet from application can be routed to
1861      * proper destination and remove RM header option.
1862      */
1863     RMUpdateInfo((CAHeaderOption_t **) &(requestInfo->info.options),
1864                  (uint8_t *) &(requestInfo->info.numOptions),
1865                  (CAEndpoint_t *) endPoint);
1866
1867 #ifdef ROUTING_GATEWAY
1868     if (isEmptyMsg)
1869     {
1870         /*
1871          * In Gateways, the MSGType in route option is used to check if the actual
1872          * response is EMPTY message(4 bytes CoAP Header).  In case of Client, the
1873          * EMPTY response is sent in the form of POST request which need to be changed
1874          * to a EMPTY response by RM.  This translation is done in this part of the code.
1875          */
1876         OIC_LOG(INFO, TAG, "This is a Empty response from the Client");
1877         CAResponseInfo_t respInfo = {.result = CA_EMPTY,
1878                                      .info.messageId = requestInfo->info.messageId,
1879                                      .info.type = CA_MSG_ACKNOWLEDGE};
1880         OCHandleResponse(endPoint, &respInfo);
1881     }
1882     else
1883 #endif
1884 #endif
1885     {
1886         // Normal handling of the packet
1887         OCHandleRequests(endPoint, requestInfo);
1888     }
1889     OIC_LOG(INFO, TAG, "Exit HandleCARequests");
1890 }
1891
1892 bool validatePlatformInfo(OCPlatformInfo info)
1893 {
1894
1895     if (!info.platformID)
1896     {
1897         OIC_LOG(ERROR, TAG, "No platform ID found.");
1898         return false;
1899     }
1900
1901     if (info.manufacturerName)
1902     {
1903         size_t lenManufacturerName = strlen(info.manufacturerName);
1904
1905         if(lenManufacturerName == 0 || lenManufacturerName > MAX_MANUFACTURER_NAME_LENGTH)
1906         {
1907             OIC_LOG(ERROR, TAG, "Manufacturer name fails length requirements.");
1908             return false;
1909         }
1910     }
1911     else
1912     {
1913         OIC_LOG(ERROR, TAG, "No manufacturer name present");
1914         return false;
1915     }
1916
1917     if (info.manufacturerUrl)
1918     {
1919         if(strlen(info.manufacturerUrl) > MAX_MANUFACTURER_URL_LENGTH)
1920         {
1921             OIC_LOG(ERROR, TAG, "Manufacturer url fails length requirements.");
1922             return false;
1923         }
1924     }
1925     return true;
1926 }
1927
1928 //-----------------------------------------------------------------------------
1929 // Public APIs
1930 //-----------------------------------------------------------------------------
1931 #ifdef RA_ADAPTER
1932 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo)
1933 {
1934     if (!raInfo           ||
1935         !raInfo->username ||
1936         !raInfo->hostname ||
1937         !raInfo->xmpp_domain)
1938     {
1939
1940         return OC_STACK_INVALID_PARAM;
1941     }
1942     OCStackResult result = CAResultToOCResult(CASetRAInfo((const CARAInfo_t *) raInfo));
1943     gRASetInfo = (result == OC_STACK_OK)? true : false;
1944
1945     return result;
1946 }
1947 #endif
1948
1949 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1950 {
1951     (void) ipAddr;
1952     (void) port;
1953     return OCInit1(mode, OC_DEFAULT_FLAGS, OC_DEFAULT_FLAGS);
1954 }
1955
1956 OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags)
1957 {
1958     if(stackState == OC_STACK_INITIALIZED)
1959     {
1960         OIC_LOG(INFO, TAG, "Subsequent calls to OCInit() without calling \
1961                 OCStop() between them are ignored.");
1962         return OC_STACK_OK;
1963     }
1964
1965 #ifndef ROUTING_GATEWAY
1966     if (OC_GATEWAY == mode)
1967     {
1968         OIC_LOG(ERROR, TAG, "Routing Manager not supported");
1969         return OC_STACK_INVALID_PARAM;
1970     }
1971 #endif
1972
1973 #ifdef RA_ADAPTER
1974     if(!gRASetInfo)
1975     {
1976         OIC_LOG(ERROR, TAG, "Need to call OCSetRAInfo before calling OCInit");
1977         return OC_STACK_ERROR;
1978     }
1979 #endif
1980
1981     OCStackResult result = OC_STACK_ERROR;
1982     OIC_LOG(INFO, TAG, "Entering OCInit");
1983
1984     // Validate mode
1985     if (!((mode == OC_CLIENT) || (mode == OC_SERVER) || (mode == OC_CLIENT_SERVER)
1986         || (mode == OC_GATEWAY)))
1987     {
1988         OIC_LOG(ERROR, TAG, "Invalid mode");
1989         return OC_STACK_ERROR;
1990     }
1991     myStackMode = mode;
1992
1993     if (mode == OC_CLIENT || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1994     {
1995         caglobals.client = true;
1996     }
1997     if (mode == OC_SERVER || mode == OC_CLIENT_SERVER || mode == OC_GATEWAY)
1998     {
1999         caglobals.server = true;
2000     }
2001
2002     caglobals.serverFlags = (CATransportFlags_t)serverFlags;
2003     if (!(caglobals.serverFlags & CA_IPFAMILY_MASK))
2004     {
2005         caglobals.serverFlags = (CATransportFlags_t)(caglobals.serverFlags|CA_IPV4|CA_IPV6);
2006     }
2007     caglobals.clientFlags = (CATransportFlags_t)clientFlags;
2008     if (!(caglobals.clientFlags & CA_IPFAMILY_MASK))
2009     {
2010         caglobals.clientFlags = (CATransportFlags_t)(caglobals.clientFlags|CA_IPV4|CA_IPV6);
2011     }
2012
2013     defaultDeviceHandler = NULL;
2014     defaultDeviceHandlerCallbackParameter = NULL;
2015
2016     result = CAResultToOCResult(CAInitialize());
2017     VERIFY_SUCCESS(result, OC_STACK_OK);
2018
2019     result = CAResultToOCResult(OCSelectNetwork());
2020     VERIFY_SUCCESS(result, OC_STACK_OK);
2021
2022     switch (myStackMode)
2023     {
2024         case OC_CLIENT:
2025             CARegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2026             result = CAResultToOCResult(CAStartDiscoveryServer());
2027             OIC_LOG(INFO, TAG, "Client mode: CAStartDiscoveryServer");
2028             break;
2029         case OC_SERVER:
2030             SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2031             result = CAResultToOCResult(CAStartListeningServer());
2032             OIC_LOG(INFO, TAG, "Server mode: CAStartListeningServer");
2033             break;
2034         case OC_CLIENT_SERVER:
2035         case OC_GATEWAY:
2036             SRMRegisterHandler(HandleCARequests, HandleCAResponses, HandleCAErrorResponse);
2037             result = CAResultToOCResult(CAStartListeningServer());
2038             if(result == OC_STACK_OK)
2039             {
2040                 result = CAResultToOCResult(CAStartDiscoveryServer());
2041             }
2042             break;
2043     }
2044     VERIFY_SUCCESS(result, OC_STACK_OK);
2045
2046 #ifdef TCP_ADAPTER
2047     CARegisterKeepAliveHandler(HandleKeepAliveConnCB);
2048 #endif
2049
2050 #ifdef WITH_PRESENCE
2051     PresenceTimeOutSize = sizeof (PresenceTimeOut) / sizeof (PresenceTimeOut[0]) - 1;
2052 #endif // WITH_PRESENCE
2053
2054     //Update Stack state to initialized
2055     stackState = OC_STACK_INITIALIZED;
2056
2057     // Initialize resource
2058     if(myStackMode != OC_CLIENT)
2059     {
2060         result = initResources();
2061     }
2062
2063     // Initialize the SRM Policy Engine
2064     if(result == OC_STACK_OK)
2065     {
2066         result = SRMInitPolicyEngine();
2067         // TODO after BeachHead delivery: consolidate into single SRMInit()
2068     }
2069 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
2070     RMSetStackMode(mode);
2071 #ifdef ROUTING_GATEWAY
2072     if (OC_GATEWAY == myStackMode)
2073     {
2074         result = RMInitialize();
2075     }
2076 #endif
2077 #endif
2078
2079 #ifdef TCP_ADAPTER
2080     if (result == OC_STACK_OK)
2081     {
2082         result = InitializeKeepAlive(myStackMode);
2083     }
2084 #endif
2085
2086 exit:
2087     if(result != OC_STACK_OK)
2088     {
2089         OIC_LOG(ERROR, TAG, "Stack initialization error");
2090         deleteAllResources();
2091         CATerminate();
2092         stackState = OC_STACK_UNINITIALIZED;
2093     }
2094     return result;
2095 }
2096
2097 OCStackResult OCStop()
2098 {
2099     OIC_LOG(INFO, TAG, "Entering OCStop");
2100
2101     if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
2102     {
2103         OIC_LOG(DEBUG, TAG, "Stack already stopping, exiting");
2104         return OC_STACK_OK;
2105     }
2106     else if (stackState != OC_STACK_INITIALIZED)
2107     {
2108         OIC_LOG(ERROR, TAG, "Stack not initialized");
2109         return OC_STACK_ERROR;
2110     }
2111
2112     stackState = OC_STACK_UNINIT_IN_PROGRESS;
2113
2114 #ifdef WITH_PRESENCE
2115     // Ensure that the TTL associated with ANY and ALL presence notifications originating from
2116     // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
2117     presenceResource.presenceTTL = 0;
2118 #endif // WITH_PRESENCE
2119
2120 #ifdef ROUTING_GATEWAY
2121     if (OC_GATEWAY == myStackMode)
2122     {
2123         RMTerminate();
2124     }
2125 #endif
2126
2127 #ifdef TCP_ADAPTER
2128     TerminateKeepAlive(myStackMode);
2129 #endif
2130
2131     // Free memory dynamically allocated for resources
2132     deleteAllResources();
2133     DeleteDeviceInfo();
2134     DeletePlatformInfo();
2135     CATerminate();
2136     // Remove all observers
2137     DeleteObserverList();
2138     // Remove all the client callbacks
2139     DeleteClientCBList();
2140
2141     // De-init the SRM Policy Engine
2142     // TODO after BeachHead delivery: consolidate into single SRMDeInit()
2143     SRMDeInitPolicyEngine();
2144
2145
2146     stackState = OC_STACK_UNINITIALIZED;
2147     return OC_STACK_OK;
2148 }
2149
2150 OCStackResult OCStartMulticastServer()
2151 {
2152     if(stackState != OC_STACK_INITIALIZED)
2153     {
2154         OIC_LOG(ERROR, TAG, "OCStack is not initalized. Cannot start multicast server.");
2155         return OC_STACK_ERROR;
2156     }
2157     CAResult_t ret = CAStartListeningServer();
2158     if (CA_STATUS_OK != ret)
2159     {
2160         OIC_LOG_V(ERROR, TAG, "Failed starting listening server: %d", ret);
2161         return OC_STACK_ERROR;
2162     }
2163     return OC_STACK_OK;
2164 }
2165
2166 OCStackResult OCStopMulticastServer()
2167 {
2168     CAResult_t ret = CAStopListeningServer();
2169     if (CA_STATUS_OK != ret)
2170     {
2171         OIC_LOG_V(ERROR, TAG, "Failed stopping listening server: %d", ret);
2172         return OC_STACK_ERROR;
2173     }
2174     return OC_STACK_OK;
2175 }
2176
2177 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
2178 {
2179     switch (qos)
2180     {
2181         case OC_HIGH_QOS:
2182             return CA_MSG_CONFIRM;
2183         case OC_LOW_QOS:
2184         case OC_MEDIUM_QOS:
2185         case OC_NA_QOS:
2186         default:
2187             return CA_MSG_NONCONFIRM;
2188     }
2189 }
2190
2191 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
2192 {
2193     char *query;
2194
2195     query = strchr (inputUri, '?');
2196
2197     if (query != NULL)
2198     {
2199         if((query - inputUri) > MAX_URI_LENGTH)
2200         {
2201             return OC_STACK_INVALID_URI;
2202         }
2203
2204         if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
2205         {
2206             return OC_STACK_INVALID_QUERY;
2207         }
2208     }
2209     else if(uriLen > MAX_URI_LENGTH)
2210     {
2211         return OC_STACK_INVALID_URI;
2212     }
2213     return OC_STACK_OK;
2214 }
2215
2216 /**
2217  *  A request uri consists of the following components in order:
2218  *                              example
2219  *  optionally one of
2220  *      CoAP over UDP prefix    "coap://"
2221  *      CoAP over TCP prefix    "coap+tcp://"
2222  *  optionally one of
2223  *      IPv6 address            "[1234::5678]"
2224  *      IPv4 address            "192.168.1.1"
2225  *  optional port               ":5683"
2226  *  resource uri                "/oc/core..."
2227  *
2228  *  for PRESENCE requests, extract resource type.
2229  */
2230 static OCStackResult ParseRequestUri(const char *fullUri,
2231                                         OCTransportAdapter adapter,
2232                                         OCTransportFlags flags,
2233                                         OCDevAddr **devAddr,
2234                                         char **resourceUri,
2235                                         char **resourceType)
2236 {
2237     VERIFY_NON_NULL(fullUri, FATAL, OC_STACK_INVALID_CALLBACK);
2238
2239     OCStackResult result = OC_STACK_OK;
2240     OCDevAddr *da = NULL;
2241     char *colon = NULL;
2242     char *end;
2243
2244     // provide defaults for all returned values
2245     if (devAddr)
2246     {
2247         *devAddr = NULL;
2248     }
2249     if (resourceUri)
2250     {
2251         *resourceUri = NULL;
2252     }
2253     if (resourceType)
2254     {
2255         *resourceType = NULL;
2256     }
2257
2258     // delimit url prefix, if any
2259     const char *start = fullUri;
2260     char *slash2 = strstr(start, "//");
2261     if (slash2)
2262     {
2263         start = slash2 + 2;
2264     }
2265     char *slash = strchr(start, '/');
2266     if (!slash)
2267     {
2268         return OC_STACK_INVALID_URI;
2269     }
2270
2271     // process url scheme
2272     size_t prefixLen = slash2 - fullUri;
2273     bool istcp = false;
2274     if (prefixLen)
2275     {
2276         if ((prefixLen == sizeof(COAP_TCP) - 1) && (!strncmp(fullUri, COAP_TCP, prefixLen)))
2277         {
2278             istcp = true;
2279         }
2280     }
2281
2282     // TODO: this logic should come in with unit tests exercising the various strings
2283     // processs url prefix, if any
2284     size_t urlLen = slash - start;
2285     // port
2286     uint16_t port = 0;
2287     size_t len = 0;
2288     if (urlLen && devAddr)
2289     {   // construct OCDevAddr
2290         if (start[0] == '[')
2291         {   // ipv6 address
2292             char *close = strchr(++start, ']');
2293             if (!close || close > slash)
2294             {
2295                 return OC_STACK_INVALID_URI;
2296             }
2297             end = close;
2298             if (close[1] == ':')
2299             {
2300                 colon = close + 1;
2301             }
2302
2303             if (istcp)
2304             {
2305                 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2306             }
2307             else
2308             {
2309                 adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2310             }
2311             flags = (OCTransportFlags)(flags | OC_IP_USE_V6);
2312         }
2313         else
2314         {
2315             char *dot = strchr(start, '.');
2316             if (dot && dot < slash)
2317             {   // ipv4 address
2318                 colon = strchr(start, ':');
2319                 end = (colon && colon < slash) ? colon : slash;
2320
2321                 if (istcp)
2322                 {
2323                     // coap over tcp
2324                     adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_TCP);
2325                 }
2326                 else
2327                 {
2328                     adapter = (OCTransportAdapter)(adapter | OC_ADAPTER_IP);
2329                 }
2330                 flags = (OCTransportFlags)(flags | OC_IP_USE_V4);
2331             }
2332             else
2333             {   // MAC address
2334                 end = slash;
2335             }
2336         }
2337         len = end - start;
2338         if (len >= sizeof(da->addr))
2339         {
2340             return OC_STACK_INVALID_URI;
2341         }
2342         // collect port, if any
2343         if (colon && colon < slash)
2344         {
2345             for (colon++; colon < slash; colon++)
2346             {
2347                 char c = colon[0];
2348                 if (c < '0' || c > '9')
2349                 {
2350                     return OC_STACK_INVALID_URI;
2351                 }
2352                 port = 10 * port + c - '0';
2353             }
2354         }
2355
2356         len = end - start;
2357         if (len >= sizeof(da->addr))
2358         {
2359             return OC_STACK_INVALID_URI;
2360         }
2361
2362         da = (OCDevAddr *)OICCalloc(sizeof (OCDevAddr), 1);
2363         if (!da)
2364         {
2365             return OC_STACK_NO_MEMORY;
2366         }
2367         OICStrcpyPartial(da->addr, sizeof(da->addr), start, len);
2368         da->port = port;
2369         da->adapter = adapter;
2370         da->flags = flags;
2371         if (!strncmp(fullUri, "coaps:", 6))
2372         {
2373             da->flags = (OCTransportFlags)(da->flags|CA_SECURE);
2374         }
2375         *devAddr = da;
2376     }
2377
2378     // process resource uri, if any
2379     if (slash)
2380     {   // request uri and query
2381         size_t ulen = strlen(slash); // resource uri length
2382         size_t tlen = 0;      // resource type length
2383         char *type = NULL;
2384
2385         static const char strPresence[] = "/oic/ad?rt=";
2386         static const size_t lenPresence = sizeof(strPresence) - 1;
2387         if (!strncmp(slash, strPresence, lenPresence))
2388         {
2389             type = slash + lenPresence;
2390             tlen = ulen - lenPresence;
2391         }
2392         // resource uri
2393         if (resourceUri)
2394         {
2395             *resourceUri = (char *)OICMalloc(ulen + 1);
2396             if (!*resourceUri)
2397             {
2398                 result = OC_STACK_NO_MEMORY;
2399                 goto error;
2400             }
2401             strcpy(*resourceUri, slash);
2402         }
2403         // resource type
2404         if (type && resourceType)
2405         {
2406             *resourceType = (char *)OICMalloc(tlen + 1);
2407             if (!*resourceType)
2408             {
2409                 result = OC_STACK_NO_MEMORY;
2410                 goto error;
2411             }
2412
2413             OICStrcpy(*resourceType, (tlen+1), type);
2414         }
2415     }
2416
2417     return OC_STACK_OK;
2418
2419 error:
2420     // free all returned values
2421     if (devAddr)
2422     {
2423         OICFree(*devAddr);
2424     }
2425     if (resourceUri)
2426     {
2427         OICFree(*resourceUri);
2428     }
2429     if (resourceType)
2430     {
2431         OICFree(*resourceType);
2432     }
2433     return result;
2434 }
2435
2436 static OCStackResult OCPreparePresence(CAEndpoint_t *endpoint,
2437                                         char *resourceUri, char **requestUri)
2438 {
2439     char uri[CA_MAX_URI_LENGTH];
2440
2441     FormCanonicalPresenceUri(endpoint, resourceUri, uri);
2442
2443     *requestUri = OICStrdup(uri);
2444     if (!*requestUri)
2445     {
2446         return OC_STACK_NO_MEMORY;
2447     }
2448
2449     return OC_STACK_OK;
2450 }
2451
2452 /**
2453  * Discover or Perform requests on a specified resource
2454  */
2455 OCStackResult OCDoResource(OCDoHandle *handle,
2456                             OCMethod method,
2457                             const char *requestUri,
2458                             const OCDevAddr *destination,
2459                             OCPayload* payload,
2460                             OCConnectivityType connectivityType,
2461                             OCQualityOfService qos,
2462                             OCCallbackData *cbData,
2463                             OCHeaderOption *options,
2464                             uint8_t numOptions)
2465 {
2466     OIC_LOG(INFO, TAG, "Entering OCDoResource");
2467
2468     // Validate input parameters
2469     VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
2470     VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
2471     VERIFY_NON_NULL(requestUri , FATAL, OC_STACK_INVALID_URI);
2472
2473     OCStackResult result = OC_STACK_ERROR;
2474     CAResult_t caResult;
2475     CAToken_t token = NULL;
2476     uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2477     ClientCB *clientCB = NULL;
2478     OCDoHandle resHandle = NULL;
2479     CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2480     OCDevAddr tmpDevAddr = { OC_DEFAULT_ADAPTER };
2481     uint32_t ttl = 0;
2482     OCTransportAdapter adapter;
2483     OCTransportFlags flags;
2484     // the request contents are put here
2485     CARequestInfo_t requestInfo = {.method = CA_GET};
2486     // requestUri  will be parsed into the following three variables
2487     OCDevAddr *devAddr = NULL;
2488     char *resourceUri = NULL;
2489     char *resourceType = NULL;
2490
2491     /*
2492      * Support original behavior with address on resourceUri argument.
2493      */
2494     adapter = (OCTransportAdapter)(connectivityType >> CT_ADAPTER_SHIFT);
2495     flags = (OCTransportFlags)(connectivityType & CT_MASK_FLAGS);
2496
2497     result = ParseRequestUri(requestUri, adapter, flags, &devAddr, &resourceUri, &resourceType);
2498
2499     if (result != OC_STACK_OK)
2500     {
2501         OIC_LOG_V(DEBUG, TAG, "Unable to parse uri: %s", requestUri);
2502         goto exit;
2503     }
2504
2505     switch (method)
2506     {
2507     case OC_REST_GET:
2508     case OC_REST_OBSERVE:
2509     case OC_REST_OBSERVE_ALL:
2510     case OC_REST_CANCEL_OBSERVE:
2511         requestInfo.method = CA_GET;
2512         break;
2513     case OC_REST_PUT:
2514         requestInfo.method = CA_PUT;
2515         break;
2516     case OC_REST_POST:
2517         requestInfo.method = CA_POST;
2518         break;
2519     case OC_REST_DELETE:
2520         requestInfo.method = CA_DELETE;
2521         break;
2522     case OC_REST_DISCOVER:
2523         qos = OC_LOW_QOS;
2524         if (destination || devAddr)
2525         {
2526             requestInfo.isMulticast = false;
2527         }
2528         else
2529         {
2530             tmpDevAddr.adapter = adapter;
2531             tmpDevAddr.flags = flags;
2532             destination = &tmpDevAddr;
2533             requestInfo.isMulticast = true;
2534         }
2535         // CA_DISCOVER will become GET and isMulticast
2536         requestInfo.method = CA_GET;
2537         break;
2538 #ifdef WITH_PRESENCE
2539     case OC_REST_PRESENCE:
2540         // Replacing method type with GET because "presence"
2541         // is a stack layer only implementation.
2542         requestInfo.method = CA_GET;
2543         break;
2544 #endif
2545     default:
2546         result = OC_STACK_INVALID_METHOD;
2547         goto exit;
2548     }
2549
2550     if (!devAddr && !destination)
2551     {
2552         OIC_LOG(DEBUG, TAG, "no devAddr and no destination");
2553         result = OC_STACK_INVALID_PARAM;
2554         goto exit;
2555     }
2556
2557     /* If not original behavior, use destination argument */
2558     if (destination && !devAddr)
2559     {
2560         devAddr = (OCDevAddr *)OICMalloc(sizeof (OCDevAddr));
2561         if (!devAddr)
2562         {
2563             result = OC_STACK_NO_MEMORY;
2564             goto exit;
2565         }
2566         *devAddr = *destination;
2567     }
2568
2569     resHandle = GenerateInvocationHandle();
2570     if (!resHandle)
2571     {
2572         result = OC_STACK_NO_MEMORY;
2573         goto exit;
2574     }
2575
2576     caResult = CAGenerateToken(&token, tokenLength);
2577     if (caResult != CA_STATUS_OK)
2578     {
2579         OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2580         result= OC_STACK_ERROR;
2581         goto exit;
2582     }
2583
2584     // fill in request data
2585     requestInfo.info.type = qualityOfServiceToMessageType(qos);
2586     requestInfo.info.token = token;
2587     requestInfo.info.tokenLength = tokenLength;
2588     requestInfo.info.resourceUri = resourceUri;
2589
2590     if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
2591     {
2592         result = CreateObserveHeaderOption (&(requestInfo.info.options),
2593                                     options, numOptions, OC_OBSERVE_REGISTER);
2594         if (result != OC_STACK_OK)
2595         {
2596             goto exit;
2597         }
2598         requestInfo.info.numOptions = numOptions + 1;
2599     }
2600     else
2601     {
2602         requestInfo.info.numOptions = numOptions;
2603         requestInfo.info.options =
2604             (CAHeaderOption_t*) OICCalloc(numOptions, sizeof(CAHeaderOption_t));
2605         memcpy(requestInfo.info.options, (CAHeaderOption_t*)options,
2606                numOptions * sizeof(CAHeaderOption_t));
2607     }
2608
2609     CopyDevAddrToEndpoint(devAddr, &endpoint);
2610
2611     if(payload)
2612     {
2613         if((result =
2614             OCConvertPayload(payload, &requestInfo.info.payload, &requestInfo.info.payloadSize))
2615                 != OC_STACK_OK)
2616         {
2617             OIC_LOG(ERROR, TAG, "Failed to create CBOR Payload");
2618             goto exit;
2619         }
2620         requestInfo.info.payloadFormat = CA_FORMAT_APPLICATION_CBOR;
2621     }
2622     else
2623     {
2624         requestInfo.info.payload = NULL;
2625         requestInfo.info.payloadSize = 0;
2626         requestInfo.info.payloadFormat = CA_FORMAT_UNDEFINED;
2627     }
2628
2629     if (result != OC_STACK_OK)
2630     {
2631         OIC_LOG(ERROR, TAG, "CACreateEndpoint error");
2632         goto exit;
2633     }
2634
2635     // prepare for response
2636 #ifdef WITH_PRESENCE
2637     if (method == OC_REST_PRESENCE)
2638     {
2639         char *presenceUri = NULL;
2640         result = OCPreparePresence(&endpoint, resourceUri, &presenceUri);
2641         if (OC_STACK_OK != result)
2642         {
2643             goto exit;
2644         }
2645
2646         // Assign full presence uri as coap://ip:port/oic/ad to add to callback list.
2647         // Presence notification will form a canonical uri to
2648         // look for callbacks into the application.
2649         resourceUri = presenceUri;
2650     }
2651 #endif
2652
2653     ttl = GetTicks(MAX_CB_TIMEOUT_SECONDS * MILLISECONDS_PER_SECOND);
2654     result = AddClientCB(&clientCB, cbData, token, tokenLength, &resHandle,
2655                             method, devAddr, resourceUri, resourceType, ttl);
2656     if (OC_STACK_OK != result)
2657     {
2658         goto exit;
2659     }
2660
2661     devAddr = NULL;       // Client CB list entry now owns it
2662     resourceUri = NULL;   // Client CB list entry now owns it
2663     resourceType = NULL;  // Client CB list entry now owns it
2664
2665     // send request
2666     result = OCSendRequest(&endpoint, &requestInfo);
2667     if (OC_STACK_OK != result)
2668     {
2669         goto exit;
2670     }
2671
2672     if (handle)
2673     {
2674         *handle = resHandle;
2675     }
2676
2677 exit:
2678     if (result != OC_STACK_OK)
2679     {
2680         OIC_LOG(ERROR, TAG, "OCDoResource error");
2681         FindAndDeleteClientCB(clientCB);
2682         CADestroyToken(token);
2683         if (handle)
2684         {
2685             *handle = NULL;
2686         }
2687         OICFree(resHandle);
2688     }
2689
2690     // This is the owner of the payload object, so we free it
2691     OCPayloadDestroy(payload);
2692     OICFree(requestInfo.info.payload);
2693     OICFree(devAddr);
2694     OICFree(resourceUri);
2695     OICFree(resourceType);
2696     OICFree(requestInfo.info.options);
2697     return result;
2698 }
2699
2700 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
2701         uint8_t numOptions)
2702 {
2703     /*
2704      * This ftn is implemented one of two ways in the case of observation:
2705      *
2706      * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
2707      *      Remove the callback associated on client side.
2708      *      When the next notification comes in from server,
2709      *      reply with RESET message to server.
2710      *      Keep in mind that the server will react to RESET only
2711      *      if the last notification was sent as CON
2712      *
2713      * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
2714      *      and it is associated with an observe request
2715      *      (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
2716      *      Send CON Observe request to server with
2717      *      observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
2718      *      Remove the callback associated on client side.
2719      */
2720     OCStackResult ret = OC_STACK_OK;
2721     CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2722     CARequestInfo_t requestInfo = {.method = CA_GET};
2723
2724     if(!handle)
2725     {
2726         return OC_STACK_INVALID_PARAM;
2727     }
2728
2729     ClientCB *clientCB = GetClientCB(NULL, 0, handle, NULL);
2730     if (!clientCB)
2731     {
2732         OIC_LOG(ERROR, TAG, "Callback not found. Called OCCancel on same resource twice?");
2733         return OC_STACK_ERROR;
2734     }
2735
2736     switch (clientCB->method)
2737     {
2738         case OC_REST_OBSERVE:
2739         case OC_REST_OBSERVE_ALL:
2740
2741             OIC_LOG_V(INFO, TAG, "Canceling observation for resource %s", clientCB->requestUri);
2742
2743             CopyDevAddrToEndpoint(clientCB->devAddr, &endpoint);
2744
2745             if ((endpoint.adapter & CA_ADAPTER_IP) && qos != OC_HIGH_QOS)
2746             {
2747                 FindAndDeleteClientCB(clientCB);
2748                 break;
2749             }
2750
2751             OIC_LOG(INFO, TAG, "Cancelling observation as CONFIRMABLE");
2752
2753             requestInfo.info.type = qualityOfServiceToMessageType(qos);
2754             requestInfo.info.token = clientCB->token;
2755             requestInfo.info.tokenLength = clientCB->tokenLength;
2756
2757             if (CreateObserveHeaderOption (&(requestInfo.info.options),
2758                     options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
2759             {
2760                 return OC_STACK_ERROR;
2761             }
2762             requestInfo.info.numOptions = numOptions + 1;
2763             requestInfo.info.resourceUri = OICStrdup (clientCB->requestUri);
2764
2765
2766             ret = OCSendRequest(&endpoint, &requestInfo);
2767
2768             if (requestInfo.info.options)
2769             {
2770                 OICFree (requestInfo.info.options);
2771             }
2772             if (requestInfo.info.resourceUri)
2773             {
2774                 OICFree (requestInfo.info.resourceUri);
2775             }
2776
2777             break;
2778
2779         case OC_REST_DISCOVER:
2780             OIC_LOG_V(INFO, TAG, "Cancelling discovery callback for resource %s",
2781                                            clientCB->requestUri);
2782             FindAndDeleteClientCB(clientCB);
2783             break;
2784
2785 #ifdef WITH_PRESENCE
2786         case OC_REST_PRESENCE:
2787             FindAndDeleteClientCB(clientCB);
2788             break;
2789 #endif
2790
2791         default:
2792             ret = OC_STACK_INVALID_METHOD;
2793             break;
2794     }
2795
2796     return ret;
2797 }
2798
2799 /**
2800  * @brief   Register Persistent storage callback.
2801  * @param   persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers.
2802  * @return
2803  *     OC_STACK_OK    - No errors; Success
2804  *     OC_STACK_INVALID_PARAM - Invalid parameter
2805  */
2806 OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler)
2807 {
2808     OIC_LOG(INFO, TAG, "RegisterPersistentStorageHandler !!");
2809     if(!persistentStorageHandler)
2810     {
2811         OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2812         return OC_STACK_INVALID_PARAM;
2813     }
2814     else
2815     {
2816         if( !persistentStorageHandler->open ||
2817                 !persistentStorageHandler->close ||
2818                 !persistentStorageHandler->read ||
2819                 !persistentStorageHandler->unlink ||
2820                 !persistentStorageHandler->write)
2821         {
2822             OIC_LOG(ERROR, TAG, "The persistent storage handler is invalid");
2823             return OC_STACK_INVALID_PARAM;
2824         }
2825     }
2826     return SRMRegisterPersistentStorageHandler(persistentStorageHandler);
2827 }
2828
2829 #ifdef WITH_PRESENCE
2830
2831 OCStackResult OCProcessPresence()
2832 {
2833     OCStackResult result = OC_STACK_OK;
2834
2835     // the following line floods the log with messages that are irrelevant
2836     // to most purposes.  Uncomment as needed.
2837     //OIC_LOG(INFO, TAG, "Entering RequestPresence");
2838     ClientCB* cbNode = NULL;
2839     OCClientResponse clientResponse;
2840     OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
2841
2842     LL_FOREACH(cbList, cbNode)
2843     {
2844         if (OC_REST_PRESENCE != cbNode->method || !cbNode->presence)
2845         {
2846             continue;
2847         }
2848
2849         uint32_t now = GetTicks(0);
2850         OIC_LOG_V(DEBUG, TAG, "this TTL level %d",
2851                                                 cbNode->presence->TTLlevel);
2852         OIC_LOG_V(DEBUG, TAG, "current ticks %d", now);
2853
2854         if (cbNode->presence->TTLlevel > PresenceTimeOutSize)
2855         {
2856             goto exit;
2857         }
2858
2859         if (cbNode->presence->TTLlevel < PresenceTimeOutSize)
2860         {
2861             OIC_LOG_V(DEBUG, TAG, "timeout ticks %d",
2862                     cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2863         }
2864         if (cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2865         {
2866             OIC_LOG(DEBUG, TAG, "No more timeout ticks");
2867
2868             clientResponse.sequenceNumber = 0;
2869             clientResponse.result = OC_STACK_PRESENCE_TIMEOUT;
2870             clientResponse.devAddr = *cbNode->devAddr;
2871             FixUpClientResponse(&clientResponse);
2872             clientResponse.payload = NULL;
2873
2874             // Increment the TTLLevel (going to a next state), so we don't keep
2875             // sending presence notification to client.
2876             cbNode->presence->TTLlevel++;
2877             OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d",
2878                                         cbNode->presence->TTLlevel);
2879
2880             cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
2881             if (cbResult == OC_STACK_DELETE_TRANSACTION)
2882             {
2883                 FindAndDeleteClientCB(cbNode);
2884             }
2885         }
2886
2887         if (now < cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2888         {
2889             continue;
2890         }
2891
2892         CAEndpoint_t endpoint = {.adapter = CA_DEFAULT_ADAPTER};
2893         CAInfo_t requestData = {.type = CA_MSG_CONFIRM};
2894         CARequestInfo_t requestInfo = {.method = CA_GET};
2895
2896         OIC_LOG(DEBUG, TAG, "time to test server presence");
2897
2898         CopyDevAddrToEndpoint(cbNode->devAddr, &endpoint);
2899
2900         requestData.type = CA_MSG_NONCONFIRM;
2901         requestData.token = cbNode->token;
2902         requestData.tokenLength = cbNode->tokenLength;
2903         requestData.resourceUri = OC_RSRVD_PRESENCE_URI;
2904         requestInfo.method = CA_GET;
2905         requestInfo.info = requestData;
2906
2907         result = OCSendRequest(&endpoint, &requestInfo);
2908         if (OC_STACK_OK != result)
2909         {
2910             goto exit;
2911         }
2912
2913         cbNode->presence->TTLlevel++;
2914         OIC_LOG_V(DEBUG, TAG, "moving to TTL level %d", cbNode->presence->TTLlevel);
2915     }
2916 exit:
2917     if (result != OC_STACK_OK)
2918     {
2919         OIC_LOG(ERROR, TAG, "OCProcessPresence error");
2920     }
2921
2922     return result;
2923 }
2924 #endif // WITH_PRESENCE
2925
2926 OCStackResult OCProcess()
2927 {
2928 #ifdef WITH_PRESENCE
2929     OCProcessPresence();
2930 #endif
2931     CAHandleRequestResponse();
2932
2933 #ifdef ROUTING_GATEWAY
2934     RMProcess();
2935 #endif
2936
2937 #ifdef TCP_ADAPTER
2938     ProcessKeepAlive();
2939 #endif
2940     return OC_STACK_OK;
2941 }
2942
2943 #ifdef WITH_PRESENCE
2944 OCStackResult OCStartPresence(const uint32_t ttl)
2945 {
2946     uint8_t tokenLength = CA_MAX_TOKEN_LEN;
2947     OCChangeResourceProperty(
2948             &(((OCResource *)presenceResource.handle)->resourceProperties),
2949             OC_ACTIVE, 1);
2950
2951     if (OC_MAX_PRESENCE_TTL_SECONDS < ttl)
2952     {
2953         presenceResource.presenceTTL = OC_MAX_PRESENCE_TTL_SECONDS;
2954         OIC_LOG(INFO, TAG, "Setting Presence TTL to max value");
2955     }
2956     else if (0 == ttl)
2957     {
2958         presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
2959         OIC_LOG(INFO, TAG, "Setting Presence TTL to default value");
2960     }
2961     else
2962     {
2963         presenceResource.presenceTTL = ttl;
2964     }
2965     OIC_LOG_V(DEBUG, TAG, "Presence TTL is %" PRIu32 " seconds", presenceResource.presenceTTL);
2966
2967     if (OC_PRESENCE_UNINITIALIZED == presenceState)
2968     {
2969         presenceState = OC_PRESENCE_INITIALIZED;
2970
2971         OCDevAddr devAddr = { OC_DEFAULT_ADAPTER };
2972
2973         CAToken_t caToken = NULL;
2974         CAResult_t caResult = CAGenerateToken(&caToken, tokenLength);
2975         if (caResult != CA_STATUS_OK)
2976         {
2977             OIC_LOG(ERROR, TAG, "CAGenerateToken error");
2978             CADestroyToken(caToken);
2979             return OC_STACK_ERROR;
2980         }
2981
2982         AddObserver(OC_RSRVD_PRESENCE_URI, NULL, 0, caToken, tokenLength,
2983                 (OCResource *)presenceResource.handle, OC_LOW_QOS, OC_FORMAT_UNDEFINED, &devAddr);
2984         CADestroyToken(caToken);
2985     }
2986
2987     // Each time OCStartPresence is called
2988     // a different random 32-bit integer number is used
2989     ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2990
2991     return SendPresenceNotification(((OCResource *)presenceResource.handle)->rsrcType,
2992             OC_PRESENCE_TRIGGER_CREATE);
2993 }
2994
2995 OCStackResult OCStopPresence()
2996 {
2997     OCStackResult result = OC_STACK_ERROR;
2998
2999     if(presenceResource.handle)
3000     {
3001         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3002
3003     // make resource inactive
3004     result = OCChangeResourceProperty(
3005             &(((OCResource *) presenceResource.handle)->resourceProperties),
3006             OC_ACTIVE, 0);
3007     }
3008
3009     if(result != OC_STACK_OK)
3010     {
3011         OIC_LOG(ERROR, TAG,
3012                       "Changing the presence resource properties to ACTIVE not successful");
3013         return result;
3014     }
3015
3016     return SendStopNotification();
3017 }
3018 #endif
3019
3020 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler,
3021                                             void* callbackParameter)
3022 {
3023     defaultDeviceHandler = entityHandler;
3024     defaultDeviceHandlerCallbackParameter = callbackParameter;
3025
3026     return OC_STACK_OK;
3027 }
3028
3029 OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo)
3030 {
3031     OIC_LOG(INFO, TAG, "Entering OCSetPlatformInfo");
3032
3033     if(myStackMode ==  OC_SERVER || myStackMode == OC_CLIENT_SERVER || myStackMode == OC_GATEWAY)
3034     {
3035         if (validatePlatformInfo(platformInfo))
3036         {
3037             return SavePlatformInfo(platformInfo);
3038         }
3039         else
3040         {
3041             return OC_STACK_INVALID_PARAM;
3042         }
3043     }
3044     else
3045     {
3046         return OC_STACK_ERROR;
3047     }
3048 }
3049
3050 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
3051 {
3052     OIC_LOG(INFO, TAG, "Entering OCSetDeviceInfo");
3053
3054     if (!deviceInfo.deviceName || deviceInfo.deviceName[0] == '\0')
3055     {
3056         OIC_LOG(ERROR, TAG, "Null or empty device name.");
3057         return OC_STACK_INVALID_PARAM;
3058     }
3059
3060     if (deviceInfo.types)
3061     {
3062         OCStringLL *type =  deviceInfo.types;
3063         OCResource *resource = findResource((OCResource *) deviceResource);
3064         if (!resource)
3065         {
3066             return OC_STACK_INVALID_PARAM;
3067         }
3068         deleteResourceType(resource->rsrcType);
3069         resource->rsrcType = NULL;
3070
3071         while (type)
3072         {
3073             OCBindResourceTypeToResource(deviceResource, type->value);
3074             type = type->next;
3075         }
3076     }
3077     return SaveDeviceInfo(deviceInfo);
3078 }
3079
3080 OCStackResult OCCreateResource(OCResourceHandle *handle,
3081         const char *resourceTypeName,
3082         const char *resourceInterfaceName,
3083         const char *uri, OCEntityHandler entityHandler,
3084         void* callbackParam,
3085         uint8_t resourceProperties)
3086 {
3087
3088     OCResource *pointer = NULL;
3089     OCStackResult result = OC_STACK_ERROR;
3090
3091     OIC_LOG(INFO, TAG, "Entering OCCreateResource");
3092
3093     if(myStackMode == OC_CLIENT)
3094     {
3095         return OC_STACK_INVALID_PARAM;
3096     }
3097     // Validate parameters
3098     if(!uri || uri[0]=='\0' || strlen(uri)>=MAX_URI_LENGTH )
3099     {
3100         OIC_LOG(ERROR, TAG, "URI is empty or too long");
3101         return OC_STACK_INVALID_URI;
3102     }
3103     // Is it presented during resource discovery?
3104     if (!handle || !resourceTypeName || resourceTypeName[0] == '\0' )
3105     {
3106         OIC_LOG(ERROR, TAG, "Input parameter is NULL");
3107         return OC_STACK_INVALID_PARAM;
3108     }
3109
3110     if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0)
3111     {
3112         resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
3113     }
3114
3115     // Make sure resourceProperties bitmask has allowed properties specified
3116     if (resourceProperties
3117             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE |
3118                OC_EXPLICIT_DISCOVERABLE))
3119     {
3120         OIC_LOG(ERROR, TAG, "Invalid property");
3121         return OC_STACK_INVALID_PARAM;
3122     }
3123
3124     // If the headResource is NULL, then no resources have been created...
3125     pointer = headResource;
3126     if (pointer)
3127     {
3128         // At least one resources is in the resource list, so we need to search for
3129         // repeated URLs, which are not allowed.  If a repeat is found, exit with an error
3130         while (pointer)
3131         {
3132             if (strncmp(uri, pointer->uri, MAX_URI_LENGTH) == 0)
3133             {
3134                 OIC_LOG_V(ERROR, TAG, "Resource %s already exists", uri);
3135                 return OC_STACK_INVALID_PARAM;
3136             }
3137             pointer = pointer->next;
3138         }
3139     }
3140     // Create the pointer and insert it into the resource list
3141     pointer = (OCResource *) OICCalloc(1, sizeof(OCResource));
3142     if (!pointer)
3143     {
3144         result = OC_STACK_NO_MEMORY;
3145         goto exit;
3146     }
3147     pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
3148
3149     insertResource(pointer);
3150
3151     // Set the uri
3152     pointer->uri = OICStrdup(uri);
3153     if (!pointer->uri)
3154     {
3155         result = OC_STACK_NO_MEMORY;
3156         goto exit;
3157     }
3158
3159     // Set properties.  Set OC_ACTIVE
3160     pointer->resourceProperties = (OCResourceProperty) (resourceProperties
3161             | OC_ACTIVE);
3162
3163     // Add the resourcetype to the resource
3164     result = BindResourceTypeToResource(pointer, resourceTypeName);
3165     if (result != OC_STACK_OK)
3166     {
3167         OIC_LOG(ERROR, TAG, "Error adding resourcetype");
3168         goto exit;
3169     }
3170
3171     // Add the resourceinterface to the resource
3172     result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
3173     if (result != OC_STACK_OK)
3174     {
3175         OIC_LOG(ERROR, TAG, "Error adding resourceinterface");
3176         goto exit;
3177     }
3178
3179     // If an entity handler has been passed, attach it to the newly created
3180     // resource.  Otherwise, set the default entity handler.
3181     if (entityHandler)
3182     {
3183         pointer->entityHandler = entityHandler;
3184         pointer->entityHandlerCallbackParam = callbackParam;
3185     }
3186     else
3187     {
3188         pointer->entityHandler = defaultResourceEHandler;
3189         pointer->entityHandlerCallbackParam = NULL;
3190     }
3191
3192     // Initialize a pointer indicating child resources in case of collection
3193     pointer->rsrcChildResourcesHead = NULL;
3194
3195     *handle = pointer;
3196     result = OC_STACK_OK;
3197
3198 #ifdef WITH_PRESENCE
3199     if (presenceResource.handle)
3200     {
3201         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3202         SendPresenceNotification(pointer->rsrcType, OC_PRESENCE_TRIGGER_CREATE);
3203     }
3204 #endif
3205 exit:
3206     if (result != OC_STACK_OK)
3207     {
3208         // Deep delete of resource and other dynamic elements that it contains
3209         deleteResource(pointer);
3210     }
3211     return result;
3212 }
3213
3214 OCStackResult OCBindResource(
3215         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3216 {
3217     OCResource *resource = NULL;
3218     OCChildResource *tempChildResource = NULL;
3219     OCChildResource *newChildResource = NULL;
3220
3221     OIC_LOG(INFO, TAG, "Entering OCBindResource");
3222
3223     // Validate parameters
3224     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3225     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3226     // Container cannot contain itself
3227     if (collectionHandle == resourceHandle)
3228     {
3229         OIC_LOG(ERROR, TAG, "Added handle equals collection handle");
3230         return OC_STACK_INVALID_PARAM;
3231     }
3232
3233     // Use the handle to find the resource in the resource linked list
3234     resource = findResource((OCResource *) collectionHandle);
3235     if (!resource)
3236     {
3237         OIC_LOG(ERROR, TAG, "Collection handle not found");
3238         return OC_STACK_INVALID_PARAM;
3239     }
3240
3241     // Look for an open slot to add add the child resource.
3242     // If found, add it and return success
3243
3244     tempChildResource = resource->rsrcChildResourcesHead;
3245
3246     while(resource->rsrcChildResourcesHead && tempChildResource->next)
3247     {
3248         // TODO: what if one of child resource was deregistered without unbinding?
3249         tempChildResource = tempChildResource->next;
3250     }
3251
3252     // Do memory allocation for child resource
3253     newChildResource = (OCChildResource *) OICCalloc(1, sizeof(OCChildResource));
3254     if(!newChildResource)
3255     {
3256         OIC_LOG(ERROR, TAG, "Adding new child resource is failed due to memory allocation failure");
3257         return OC_STACK_ERROR;
3258     }
3259
3260     newChildResource->rsrcResource = (OCResource *) resourceHandle;
3261     newChildResource->next = NULL;
3262
3263     if(!resource->rsrcChildResourcesHead)
3264     {
3265         resource->rsrcChildResourcesHead = newChildResource;
3266     }
3267     else {
3268         tempChildResource->next = newChildResource;
3269     }
3270
3271     OIC_LOG(INFO, TAG, "resource bound");
3272
3273 #ifdef WITH_PRESENCE
3274     if (presenceResource.handle)
3275     {
3276         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3277         SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3278                 OC_PRESENCE_TRIGGER_CHANGE);
3279     }
3280 #endif
3281
3282     return OC_STACK_OK;
3283 }
3284
3285 OCStackResult OCUnBindResource(
3286         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle)
3287 {
3288     OCResource *resource = NULL;
3289     OCChildResource *tempChildResource = NULL;
3290     OCChildResource *tempLastChildResource = NULL;
3291
3292     OIC_LOG(INFO, TAG, "Entering OCUnBindResource");
3293
3294     // Validate parameters
3295     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
3296     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
3297     // Container cannot contain itself
3298     if (collectionHandle == resourceHandle)
3299     {
3300         OIC_LOG(ERROR, TAG, "removing handle equals collection handle");
3301         return OC_STACK_INVALID_PARAM;
3302     }
3303
3304     // Use the handle to find the resource in the resource linked list
3305     resource = findResource((OCResource *) collectionHandle);
3306     if (!resource)
3307     {
3308         OIC_LOG(ERROR, TAG, "Collection handle not found");
3309         return OC_STACK_INVALID_PARAM;
3310     }
3311
3312     // Look for an open slot to add add the child resource.
3313     // If found, add it and return success
3314     if(!resource->rsrcChildResourcesHead)
3315     {
3316         OIC_LOG(INFO, TAG, "resource not found in collection");
3317
3318         // Unable to add resourceHandle, so return error
3319         return OC_STACK_ERROR;
3320
3321     }
3322
3323     tempChildResource = resource->rsrcChildResourcesHead;
3324
3325     while (tempChildResource)
3326     {
3327         if(tempChildResource->rsrcResource == resourceHandle)
3328         {
3329             // if resource going to be unbinded is the head one.
3330             if( tempChildResource == resource->rsrcChildResourcesHead )
3331             {
3332                 OCChildResource *temp = resource->rsrcChildResourcesHead->next;
3333                 OICFree(resource->rsrcChildResourcesHead);
3334                 resource->rsrcChildResourcesHead = temp;
3335                 temp = NULL;
3336             }
3337             else
3338             {
3339                 OCChildResource *temp = tempChildResource->next;
3340                 OICFree(tempChildResource);
3341                 tempLastChildResource->next = temp;
3342                 temp = NULL;
3343             }
3344
3345             OIC_LOG(INFO, TAG, "resource unbound");
3346
3347             // Send notification when resource is unbounded successfully.
3348 #ifdef WITH_PRESENCE
3349             if (presenceResource.handle)
3350             {
3351                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3352                 SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType,
3353                         OC_PRESENCE_TRIGGER_CHANGE);
3354             }
3355 #endif
3356             tempChildResource = NULL;
3357             tempLastChildResource = NULL;
3358
3359             return OC_STACK_OK;
3360
3361         }
3362
3363         tempLastChildResource = tempChildResource;
3364         tempChildResource = tempChildResource->next;
3365     }
3366
3367     OIC_LOG(INFO, TAG, "resource not found in collection");
3368
3369     tempChildResource = NULL;
3370     tempLastChildResource = NULL;
3371
3372     // Unable to add resourceHandle, so return error
3373     return OC_STACK_ERROR;
3374 }
3375
3376 // Precondition is that the parameter has been checked to not equal NULL.
3377 static bool ValidateResourceTypeInterface(const char *resourceItemName)
3378 {
3379     if (resourceItemName[0] < 'a' || resourceItemName[0] > 'z')
3380     {
3381         return false;
3382     }
3383
3384     size_t index = 1;
3385     while (resourceItemName[index] != '\0')
3386     {
3387         if (resourceItemName[index] != '.' &&
3388                 resourceItemName[index] != '-' &&
3389                 (resourceItemName[index] < 'a' || resourceItemName[index] > 'z') &&
3390                 (resourceItemName[index] < '0' || resourceItemName[index] > '9'))
3391         {
3392             return false;
3393         }
3394         ++index;
3395     }
3396
3397     return true;
3398 }
3399 OCStackResult BindResourceTypeToResource(OCResource* resource,
3400                                             const char *resourceTypeName)
3401 {
3402     OCResourceType *pointer = NULL;
3403     char *str = NULL;
3404     OCStackResult result = OC_STACK_ERROR;
3405
3406     VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
3407
3408     if (!ValidateResourceTypeInterface(resourceTypeName))
3409     {
3410         OIC_LOG(ERROR, TAG, "resource type illegal (see RFC 6690)");
3411         return OC_STACK_INVALID_PARAM;
3412     }
3413
3414     pointer = (OCResourceType *) OICCalloc(1, sizeof(OCResourceType));
3415     if (!pointer)
3416     {
3417         result = OC_STACK_NO_MEMORY;
3418         goto exit;
3419     }
3420
3421     str = OICStrdup(resourceTypeName);
3422     if (!str)
3423     {
3424         result = OC_STACK_NO_MEMORY;
3425         goto exit;
3426     }
3427     pointer->resourcetypename = str;
3428     pointer->next = NULL;
3429
3430     insertResourceType(resource, pointer);
3431     result = OC_STACK_OK;
3432
3433 exit:
3434     if (result != OC_STACK_OK)
3435     {
3436         OICFree(pointer);
3437         OICFree(str);
3438     }
3439
3440     return result;
3441 }
3442
3443 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
3444         const char *resourceInterfaceName)
3445 {
3446     OCResourceInterface *pointer = NULL;
3447     char *str = NULL;
3448     OCStackResult result = OC_STACK_ERROR;
3449
3450     VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
3451
3452     if (!ValidateResourceTypeInterface(resourceInterfaceName))
3453     {
3454         OIC_LOG(ERROR, TAG, "resource /interface illegal (see RFC 6690)");
3455         return OC_STACK_INVALID_PARAM;
3456     }
3457
3458     OIC_LOG_V(INFO, TAG, "Binding %s interface to %s", resourceInterfaceName, resource->uri);
3459
3460     pointer = (OCResourceInterface *) OICCalloc(1, sizeof(OCResourceInterface));
3461     if (!pointer)
3462     {
3463         result = OC_STACK_NO_MEMORY;
3464         goto exit;
3465     }
3466
3467     str = OICStrdup(resourceInterfaceName);
3468     if (!str)
3469     {
3470         result = OC_STACK_NO_MEMORY;
3471         goto exit;
3472     }
3473     pointer->name = str;
3474
3475     // Bind the resourceinterface to the resource
3476     insertResourceInterface(resource, pointer);
3477
3478     result = OC_STACK_OK;
3479
3480     exit:
3481     if (result != OC_STACK_OK)
3482     {
3483         OICFree(pointer);
3484         OICFree(str);
3485     }
3486
3487     return result;
3488 }
3489
3490 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
3491         const char *resourceTypeName)
3492 {
3493
3494     OCStackResult result = OC_STACK_ERROR;
3495     OCResource *resource = NULL;
3496
3497     resource = findResource((OCResource *) handle);
3498     if (!resource)
3499     {
3500         OIC_LOG(ERROR, TAG, "Resource not found");
3501         return OC_STACK_ERROR;
3502     }
3503
3504     result = BindResourceTypeToResource(resource, resourceTypeName);
3505
3506 #ifdef WITH_PRESENCE
3507     if(presenceResource.handle)
3508     {
3509         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3510         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3511     }
3512 #endif
3513
3514     return result;
3515 }
3516
3517 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
3518         const char *resourceInterfaceName)
3519 {
3520
3521     OCStackResult result = OC_STACK_ERROR;
3522     OCResource *resource = NULL;
3523
3524     resource = findResource((OCResource *) handle);
3525     if (!resource)
3526     {
3527         OIC_LOG(ERROR, TAG, "Resource not found");
3528         return OC_STACK_ERROR;
3529     }
3530
3531     result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
3532
3533 #ifdef WITH_PRESENCE
3534     if (presenceResource.handle)
3535     {
3536         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3537         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3538     }
3539 #endif
3540
3541     return result;
3542 }
3543
3544 OCStackResult OCGetNumberOfResources(uint8_t *numResources)
3545 {
3546     OCResource *pointer = headResource;
3547
3548     VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
3549     *numResources = 0;
3550     while (pointer)
3551     {
3552         *numResources = *numResources + 1;
3553         pointer = pointer->next;
3554     }
3555     return OC_STACK_OK;
3556 }
3557
3558 OCResourceHandle OCGetResourceHandle(uint8_t index)
3559 {
3560     OCResource *pointer = headResource;
3561
3562     for( uint8_t i = 0; i < index && pointer; ++i)
3563     {
3564         pointer = pointer->next;
3565     }
3566     return (OCResourceHandle) pointer;
3567 }
3568
3569 OCStackResult OCDeleteResource(OCResourceHandle handle)
3570 {
3571     if (!handle)
3572     {
3573         OIC_LOG(ERROR, TAG, "Invalid handle for deletion");
3574         return OC_STACK_INVALID_PARAM;
3575     }
3576
3577     OCResource *resource = findResource((OCResource *) handle);
3578     if (resource == NULL)
3579     {
3580         OIC_LOG(ERROR, TAG, "Resource not found");
3581         return OC_STACK_NO_RESOURCE;
3582     }
3583
3584     if (deleteResource((OCResource *) handle) != OC_STACK_OK)
3585     {
3586         OIC_LOG(ERROR, TAG, "Error deleting resource");
3587         return OC_STACK_ERROR;
3588     }
3589
3590     return OC_STACK_OK;
3591 }
3592
3593 const char *OCGetResourceUri(OCResourceHandle handle)
3594 {
3595     OCResource *resource = NULL;
3596
3597     resource = findResource((OCResource *) handle);
3598     if (resource)
3599     {
3600         return resource->uri;
3601     }
3602     return (const char *) NULL;
3603 }
3604
3605 OCResourceProperty OCGetResourceProperties(OCResourceHandle handle)
3606 {
3607     OCResource *resource = NULL;
3608
3609     resource = findResource((OCResource *) handle);
3610     if (resource)
3611     {
3612         return resource->resourceProperties;
3613     }
3614     return (OCResourceProperty)-1;
3615 }
3616
3617 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
3618         uint8_t *numResourceTypes)
3619 {
3620     OCResource *resource = NULL;
3621     OCResourceType *pointer = NULL;
3622
3623     VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
3624     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3625
3626     *numResourceTypes = 0;
3627
3628     resource = findResource((OCResource *) handle);
3629     if (resource)
3630     {
3631         pointer = resource->rsrcType;
3632         while (pointer)
3633         {
3634             *numResourceTypes = *numResourceTypes + 1;
3635             pointer = pointer->next;
3636         }
3637     }
3638     return OC_STACK_OK;
3639 }
3640
3641 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index)
3642 {
3643     OCResourceType *resourceType = NULL;
3644
3645     resourceType = findResourceTypeAtIndex(handle, index);
3646     if (resourceType)
3647     {
3648         return resourceType->resourcetypename;
3649     }
3650     return (const char *) NULL;
3651 }
3652
3653 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
3654         uint8_t *numResourceInterfaces)
3655 {
3656     OCResourceInterface *pointer = NULL;
3657     OCResource *resource = NULL;
3658
3659     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3660     VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
3661
3662     *numResourceInterfaces = 0;
3663     resource = findResource((OCResource *) handle);
3664     if (resource)
3665     {
3666         pointer = resource->rsrcInterface;
3667         while (pointer)
3668         {
3669             *numResourceInterfaces = *numResourceInterfaces + 1;
3670             pointer = pointer->next;
3671         }
3672     }
3673     return OC_STACK_OK;
3674 }
3675
3676 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index)
3677 {
3678     OCResourceInterface *resourceInterface = NULL;
3679
3680     resourceInterface = findResourceInterfaceAtIndex(handle, index);
3681     if (resourceInterface)
3682     {
3683         return resourceInterface->name;
3684     }
3685     return (const char *) NULL;
3686 }
3687
3688 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
3689         uint8_t index)
3690 {
3691     OCResource *resource = NULL;
3692     OCChildResource *tempChildResource = NULL;
3693     uint8_t num = 0;
3694
3695     resource = findResource((OCResource *) collectionHandle);
3696     if (!resource)
3697     {
3698         return NULL;
3699     }
3700
3701     tempChildResource = resource->rsrcChildResourcesHead;
3702
3703     while(tempChildResource)
3704     {
3705         if( num == index )
3706         {
3707             return tempChildResource->rsrcResource;
3708         }
3709         num++;
3710         tempChildResource = tempChildResource->next;
3711     }
3712
3713     // In this case, the number of resource handles in the collection exceeds the index
3714     tempChildResource = NULL;
3715     return NULL;
3716 }
3717
3718 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
3719         OCEntityHandler entityHandler,
3720         void* callbackParam)
3721 {
3722     OCResource *resource = NULL;
3723
3724     // Validate parameters
3725     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
3726
3727     // Use the handle to find the resource in the resource linked list
3728     resource = findResource((OCResource *)handle);
3729     if (!resource)
3730     {
3731         OIC_LOG(ERROR, TAG, "Resource not found");
3732         return OC_STACK_ERROR;
3733     }
3734
3735     // Bind the handler
3736     resource->entityHandler = entityHandler;
3737     resource->entityHandlerCallbackParam = callbackParam;
3738
3739 #ifdef WITH_PRESENCE
3740     if (presenceResource.handle)
3741     {
3742         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3743         SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_CHANGE);
3744     }
3745 #endif
3746
3747     return OC_STACK_OK;
3748 }
3749
3750 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle)
3751 {
3752     OCResource *resource = NULL;
3753
3754     resource = findResource((OCResource *)handle);
3755     if (!resource)
3756     {
3757         OIC_LOG(ERROR, TAG, "Resource not found");
3758         return NULL;
3759     }
3760
3761     // Bind the handler
3762     return resource->entityHandler;
3763 }
3764
3765 void incrementSequenceNumber(OCResource * resPtr)
3766 {
3767     // Increment the sequence number
3768     resPtr->sequenceNum += 1;
3769     if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
3770     {
3771         resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
3772     }
3773     return;
3774 }
3775
3776 #ifdef WITH_PRESENCE
3777 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
3778         OCPresenceTrigger trigger)
3779 {
3780     OCResource *resPtr = NULL;
3781     OCStackResult result = OC_STACK_ERROR;
3782     OCMethod method = OC_REST_PRESENCE;
3783     uint32_t maxAge = 0;
3784     resPtr = findResource((OCResource *) presenceResource.handle);
3785     if(NULL == resPtr)
3786     {
3787         return OC_STACK_NO_RESOURCE;
3788     }
3789
3790     if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3791     {
3792         maxAge = presenceResource.presenceTTL;
3793
3794         result = SendAllObserverNotification(method, resPtr, maxAge,
3795                 trigger, resourceType, OC_LOW_QOS);
3796     }
3797
3798     return result;
3799 }
3800
3801 OCStackResult SendStopNotification()
3802 {
3803     OCResource *resPtr = NULL;
3804     OCStackResult result = OC_STACK_ERROR;
3805     OCMethod method = OC_REST_PRESENCE;
3806     resPtr = findResource((OCResource *) presenceResource.handle);
3807     if(NULL == resPtr)
3808     {
3809         return OC_STACK_NO_RESOURCE;
3810     }
3811
3812     // maxAge is 0. ResourceType is NULL.
3813     result = SendAllObserverNotification(method, resPtr, 0, OC_PRESENCE_TRIGGER_DELETE,
3814             NULL, OC_LOW_QOS);
3815
3816     return result;
3817 }
3818
3819 #endif // WITH_PRESENCE
3820 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos)
3821 {
3822     OCResource *resPtr = NULL;
3823     OCStackResult result = OC_STACK_ERROR;
3824     OCMethod method = OC_REST_NOMETHOD;
3825     uint32_t maxAge = 0;
3826
3827     OIC_LOG(INFO, TAG, "Notifying all observers");
3828 #ifdef WITH_PRESENCE
3829     if(handle == presenceResource.handle)
3830     {
3831         return OC_STACK_OK;
3832     }
3833 #endif // WITH_PRESENCE
3834     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3835
3836     // Verify that the resource exists
3837     resPtr = findResource ((OCResource *) handle);
3838     if (NULL == resPtr)
3839     {
3840         return OC_STACK_NO_RESOURCE;
3841     }
3842     else
3843     {
3844         //only increment in the case of regular observing (not presence)
3845         incrementSequenceNumber(resPtr);
3846         method = OC_REST_OBSERVE;
3847         maxAge = MAX_OBSERVE_AGE;
3848 #ifdef WITH_PRESENCE
3849         result = SendAllObserverNotification (method, resPtr, maxAge,
3850                 OC_PRESENCE_TRIGGER_DELETE, NULL, qos);
3851 #else
3852         result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3853 #endif
3854         return result;
3855     }
3856 }
3857
3858 OCStackResult
3859 OCNotifyListOfObservers (OCResourceHandle handle,
3860                          OCObservationId  *obsIdList,
3861                          uint8_t          numberOfIds,
3862                          const OCRepPayload       *payload,
3863                          OCQualityOfService qos)
3864 {
3865     OIC_LOG(INFO, TAG, "Entering OCNotifyListOfObservers");
3866
3867     OCResource *resPtr = NULL;
3868     //TODO: we should allow the server to define this
3869     uint32_t maxAge = MAX_OBSERVE_AGE;
3870
3871     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3872     VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3873     VERIFY_NON_NULL(payload, ERROR, OC_STACK_ERROR);
3874
3875     resPtr = findResource ((OCResource *) handle);
3876     if (NULL == resPtr || myStackMode == OC_CLIENT)
3877     {
3878         return OC_STACK_NO_RESOURCE;
3879     }
3880     else
3881     {
3882         incrementSequenceNumber(resPtr);
3883     }
3884     return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3885             payload, maxAge, qos));
3886 }
3887
3888 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3889 {
3890     OCStackResult result = OC_STACK_ERROR;
3891     OCServerRequest *serverRequest = NULL;
3892
3893     OIC_LOG(INFO, TAG, "Entering OCDoResponse");
3894
3895     // Validate input parameters
3896     VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3897     VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3898
3899     // Normal response
3900     // Get pointer to request info
3901     serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3902     if(serverRequest)
3903     {
3904         // response handler in ocserverrequest.c. Usually HandleSingleResponse.
3905         result = serverRequest->ehResponseHandler(ehResponse);
3906     }
3907
3908     return result;
3909 }
3910
3911 //#ifdef DIRECT_PAIRING
3912 const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime)
3913 {
3914     OIC_LOG(INFO, TAG, "Start OCDiscoverDirectPairingDevices");
3915     if(OC_STACK_OK != DPDeviceDiscovery(waittime))
3916     {
3917         OIC_LOG(ERROR, TAG, "Fail to discover Direct-Pairing device");
3918         return NULL;
3919     }
3920
3921     return (const OCDPDev_t*)DPGetDiscoveredDevices();
3922 }
3923
3924 const OCDPDev_t* OCGetDirectPairedDevices()
3925 {
3926     return (const OCDPDev_t*)DPGetPairedDevices();
3927 }
3928
3929 void DirectPairingCB (OCDirectPairingDev_t * peer, OCStackResult result)
3930 {
3931     if (gDirectpairingCallback)
3932     {
3933         gDirectpairingCallback((OCDPDev_t*)peer, result);
3934         gDirectpairingCallback = NULL;
3935     }
3936 }
3937
3938 OCStackResult OCDoDirectPairing(OCDPDev_t* peer, OCPrm_t pmSel, char *pinNumber,
3939                                                      OCDirectPairingCB resultCallback)
3940 {
3941     OIC_LOG(INFO, TAG, "Start OCDoDirectPairing");
3942     if(NULL ==  peer || NULL == pinNumber)
3943     {
3944         OIC_LOG(ERROR, TAG, "Invalid parameters");
3945         return OC_STACK_INVALID_PARAM;
3946     }
3947     if (NULL == resultCallback)
3948     {
3949         OIC_LOG(ERROR, TAG, "Invalid callback");
3950         return OC_STACK_INVALID_CALLBACK;
3951     }
3952
3953     gDirectpairingCallback = resultCallback;
3954     return DPDirectPairing((OCDirectPairingDev_t*)peer, (OicSecPrm_t)pmSel,
3955                                            pinNumber, DirectPairingCB);
3956 }
3957 //#endif // DIRECT_PAIRING
3958
3959 //-----------------------------------------------------------------------------
3960 // Private internal function definitions
3961 //-----------------------------------------------------------------------------
3962 static OCDoHandle GenerateInvocationHandle()
3963 {
3964     OCDoHandle handle = NULL;
3965     // Generate token here, it will be deleted when the transaction is deleted
3966     handle = (OCDoHandle) OICMalloc(sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3967     if (handle)
3968     {
3969         OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[CA_MAX_TOKEN_LEN]));
3970     }
3971
3972     return handle;
3973 }
3974
3975 #ifdef WITH_PRESENCE
3976 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3977         OCResourceProperty resourceProperties, uint8_t enable)
3978 {
3979     if (!inputProperty)
3980     {
3981         return OC_STACK_INVALID_PARAM;
3982     }
3983     if (resourceProperties
3984             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW))
3985     {
3986         OIC_LOG(ERROR, TAG, "Invalid property");
3987         return OC_STACK_INVALID_PARAM;
3988     }
3989     if(!enable)
3990     {
3991         *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3992     }
3993     else
3994     {
3995         *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3996     }
3997     return OC_STACK_OK;
3998 }
3999 #endif
4000
4001 OCStackResult initResources()
4002 {
4003     OCStackResult result = OC_STACK_OK;
4004
4005     headResource = NULL;
4006     tailResource = NULL;
4007     // Init Virtual Resources
4008 #ifdef WITH_PRESENCE
4009     presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL_SECONDS;
4010
4011     result = OCCreateResource(&presenceResource.handle,
4012             OC_RSRVD_RESOURCE_TYPE_PRESENCE,
4013             "core.r",
4014             OC_RSRVD_PRESENCE_URI,
4015             NULL,
4016             NULL,
4017             OC_OBSERVABLE);
4018     //make resource inactive
4019     result = OCChangeResourceProperty(
4020             &(((OCResource *) presenceResource.handle)->resourceProperties),
4021             OC_ACTIVE, 0);
4022 #endif
4023 #ifndef WITH_ARDUINO
4024     if (result == OC_STACK_OK)
4025     {
4026         result = SRMInitSecureResources();
4027     }
4028 #endif
4029
4030     if(result == OC_STACK_OK)
4031     {
4032         result = OCCreateResource(&deviceResource,
4033                                   OC_RSRVD_RESOURCE_TYPE_DEVICE,
4034                                   OC_RSRVD_INTERFACE_DEFAULT,
4035                                   OC_RSRVD_DEVICE_URI,
4036                                   NULL,
4037                                   NULL,
4038                                   OC_DISCOVERABLE);
4039         if(result == OC_STACK_OK)
4040         {
4041             result = BindResourceInterfaceToResource((OCResource *)deviceResource,
4042                                                      OC_RSRVD_INTERFACE_READ);
4043         }
4044     }
4045
4046     if(result == OC_STACK_OK)
4047     {
4048         result = OCCreateResource(&platformResource,
4049                                   OC_RSRVD_RESOURCE_TYPE_PLATFORM,
4050                                   OC_RSRVD_INTERFACE_DEFAULT,
4051                                   OC_RSRVD_PLATFORM_URI,
4052                                   NULL,
4053                                   NULL,
4054                                   OC_DISCOVERABLE);
4055         if(result == OC_STACK_OK)
4056         {
4057             result = BindResourceInterfaceToResource((OCResource *)platformResource,
4058                                                      OC_RSRVD_INTERFACE_READ);
4059         }
4060     }
4061
4062     return result;
4063 }
4064
4065 void insertResource(OCResource *resource)
4066 {
4067     if (!headResource)
4068     {
4069         headResource = resource;
4070         tailResource = resource;
4071     }
4072     else
4073     {
4074         tailResource->next = resource;
4075         tailResource = resource;
4076     }
4077     resource->next = NULL;
4078 }
4079
4080 OCResource *findResource(OCResource *resource)
4081 {
4082     OCResource *pointer = headResource;
4083
4084     while (pointer)
4085     {
4086         if (pointer == resource)
4087         {
4088             return resource;
4089         }
4090         pointer = pointer->next;
4091     }
4092     return NULL;
4093 }
4094
4095 void deleteAllResources()
4096 {
4097     OCResource *pointer = headResource;
4098     OCResource *temp = NULL;
4099
4100     while (pointer)
4101     {
4102         temp = pointer->next;
4103 #ifdef WITH_PRESENCE
4104         if (pointer != (OCResource *) presenceResource.handle)
4105         {
4106 #endif // WITH_PRESENCE
4107             deleteResource(pointer);
4108 #ifdef WITH_PRESENCE
4109         }
4110 #endif // WITH_PRESENCE
4111         pointer = temp;
4112     }
4113
4114     SRMDeInitSecureResources();
4115
4116 #ifdef WITH_PRESENCE
4117     // Ensure that the last resource to be deleted is the presence resource. This allows for all
4118     // presence notification attributed to their deletion to be processed.
4119     deleteResource((OCResource *) presenceResource.handle);
4120 #endif // WITH_PRESENCE
4121 }
4122
4123 OCStackResult deleteResource(OCResource *resource)
4124 {
4125     OCResource *prev = NULL;
4126     OCResource *temp = NULL;
4127     if(!resource)
4128     {
4129         OIC_LOG(DEBUG,TAG,"resource is NULL");
4130         return OC_STACK_INVALID_PARAM;
4131     }
4132
4133     OIC_LOG_V (INFO, TAG, "Deleting resource %s", resource->uri);
4134
4135     temp = headResource;
4136     while (temp)
4137     {
4138         if (temp == resource)
4139         {
4140             // Invalidate all Resource Properties.
4141             resource->resourceProperties = (OCResourceProperty) 0;
4142 #ifdef WITH_PRESENCE
4143             if(resource != (OCResource *) presenceResource.handle)
4144             {
4145 #endif // WITH_PRESENCE
4146                 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
4147 #ifdef WITH_PRESENCE
4148             }
4149
4150             if(presenceResource.handle)
4151             {
4152                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
4153                 SendPresenceNotification(resource->rsrcType, OC_PRESENCE_TRIGGER_DELETE);
4154             }
4155 #endif
4156             // Only resource in list.
4157             if (temp == headResource && temp == tailResource)
4158             {
4159                 headResource = NULL;
4160                 tailResource = NULL;
4161             }
4162             // Deleting head.
4163             else if (temp == headResource)
4164             {
4165                 headResource = temp->next;
4166             }
4167             // Deleting tail.
4168             else if (temp == tailResource)
4169             {
4170                 tailResource = prev;
4171                 tailResource->next = NULL;
4172             }
4173             else
4174             {
4175                 prev->next = temp->next;
4176             }
4177
4178             deleteResourceElements(temp);
4179             OICFree(temp);
4180             return OC_STACK_OK;
4181         }
4182         else
4183         {
4184             prev = temp;
4185             temp = temp->next;
4186         }
4187     }
4188
4189     return OC_STACK_ERROR;
4190 }
4191
4192 void deleteResourceElements(OCResource *resource)
4193 {
4194     if (!resource)
4195     {
4196         return;
4197     }
4198
4199     OICFree(resource->uri);
4200     deleteResourceType(resource->rsrcType);
4201     deleteResourceInterface(resource->rsrcInterface);
4202 }
4203
4204 void deleteResourceType(OCResourceType *resourceType)
4205 {
4206     OCResourceType *pointer = resourceType;
4207     OCResourceType *next = NULL;
4208
4209     while (pointer)
4210     {
4211         next = pointer->next;
4212         OICFree(pointer->resourcetypename);
4213         OICFree(pointer);
4214         pointer = next;
4215     }
4216 }
4217
4218 void deleteResourceInterface(OCResourceInterface *resourceInterface)
4219 {
4220     OCResourceInterface *pointer = resourceInterface;
4221     OCResourceInterface *next = NULL;
4222
4223     while (pointer)
4224     {
4225         next = pointer->next;
4226         OICFree(pointer->name);
4227         OICFree(pointer);
4228         pointer = next;
4229     }
4230 }
4231
4232 void insertResourceType(OCResource *resource, OCResourceType *resourceType)
4233 {
4234     OCResourceType *pointer = NULL;
4235     OCResourceType *previous = NULL;
4236     if (!resource || !resourceType)
4237     {
4238         return;
4239     }
4240     // resource type list is empty.
4241     else if (!resource->rsrcType)
4242     {
4243         resource->rsrcType = resourceType;
4244     }
4245     else
4246     {
4247         pointer = resource->rsrcType;
4248
4249         while (pointer)
4250         {
4251             if (!strcmp(resourceType->resourcetypename, pointer->resourcetypename))
4252             {
4253                 OIC_LOG_V(INFO, TAG, "Type %s already exists", resourceType->resourcetypename);
4254                 OICFree(resourceType->resourcetypename);
4255                 OICFree(resourceType);
4256                 return;
4257             }
4258             previous = pointer;
4259             pointer = pointer->next;
4260         }
4261
4262         if (previous)
4263         {
4264             previous->next = resourceType;
4265         }
4266     }
4267     resourceType->next = NULL;
4268
4269     OIC_LOG_V(INFO, TAG, "Added type %s to %s", resourceType->resourcetypename, resource->uri);
4270 }
4271
4272 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index)
4273 {
4274     OCResource *resource = NULL;
4275     OCResourceType *pointer = NULL;
4276
4277     // Find the specified resource
4278     resource = findResource((OCResource *) handle);
4279     if (!resource)
4280     {
4281         return NULL;
4282     }
4283
4284     // Make sure a resource has a resourcetype
4285     if (!resource->rsrcType)
4286     {
4287         return NULL;
4288     }
4289
4290     // Iterate through the list
4291     pointer = resource->rsrcType;
4292     for(uint8_t i = 0; i< index && pointer; ++i)
4293     {
4294         pointer = pointer->next;
4295     }
4296     return pointer;
4297 }
4298
4299 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
4300 {
4301     if(resourceTypeList && resourceTypeName)
4302     {
4303         OCResourceType * rtPointer = resourceTypeList;
4304         while(resourceTypeName && rtPointer)
4305         {
4306             if(rtPointer->resourcetypename &&
4307                     strcmp(resourceTypeName, (const char *)
4308                     (rtPointer->resourcetypename)) == 0)
4309             {
4310                 break;
4311             }
4312             rtPointer = rtPointer->next;
4313         }
4314         return rtPointer;
4315     }
4316     return NULL;
4317 }
4318
4319 /*
4320  * Insert a new interface into interface linked list only if not already present.
4321  * If alredy present, 2nd arg is free'd.
4322  * Default interface will always be first if present.
4323  */
4324 void insertResourceInterface(OCResource *resource, OCResourceInterface *newInterface)
4325 {
4326     OCResourceInterface *pointer = NULL;
4327     OCResourceInterface *previous = NULL;
4328
4329     newInterface->next = NULL;
4330
4331     OCResourceInterface **firstInterface = &(resource->rsrcInterface);
4332
4333     if (!*firstInterface)
4334     {
4335         // If first interface is not oic.if.baseline, by default add it as first interface type.
4336         if (0 == strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT))
4337         {
4338             *firstInterface = newInterface;
4339         }
4340         else
4341         {
4342             OCStackResult result = BindResourceInterfaceToResource(resource, OC_RSRVD_INTERFACE_DEFAULT);
4343             if (result != OC_STACK_OK)
4344             {
4345                 OICFree(newInterface->name);
4346                 OICFree(newInterface);
4347                 return;
4348             }
4349             if (*firstInterface)
4350             {
4351                 (*firstInterface)->next = newInterface;
4352             }
4353         }
4354     }
4355     // If once add oic.if.baseline, later too below code take care of freeing memory.
4356     else if (strcmp(newInterface->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4357     {
4358         if (strcmp((*firstInterface)->name, OC_RSRVD_INTERFACE_DEFAULT) == 0)
4359         {
4360             OICFree(newInterface->name);
4361             OICFree(newInterface);
4362             return;
4363         }
4364         // This code will not hit anymore, keeping
4365         else
4366         {
4367             newInterface->next = *firstInterface;
4368             *firstInterface = newInterface;
4369         }
4370     }
4371     else
4372     {
4373         pointer = *firstInterface;
4374         while (pointer)
4375         {
4376             if (strcmp(newInterface->name, pointer->name) == 0)
4377             {
4378                 OICFree(newInterface->name);
4379                 OICFree(newInterface);
4380                 return;
4381             }
4382             previous = pointer;
4383             pointer = pointer->next;
4384         }
4385         previous->next = newInterface;
4386     }
4387 }
4388
4389 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
4390         uint8_t index)
4391 {
4392     OCResource *resource = NULL;
4393     OCResourceInterface *pointer = NULL;
4394
4395     // Find the specified resource
4396     resource = findResource((OCResource *) handle);
4397     if (!resource)
4398     {
4399         return NULL;
4400     }
4401
4402     // Make sure a resource has a resourceinterface
4403     if (!resource->rsrcInterface)
4404     {
4405         return NULL;
4406     }
4407
4408     // Iterate through the list
4409     pointer = resource->rsrcInterface;
4410
4411     for (uint8_t i = 0; i < index && pointer; ++i)
4412     {
4413         pointer = pointer->next;
4414     }
4415     return pointer;
4416 }
4417
4418 /*
4419  * This function splits the uri using the '?' delimiter.
4420  * "uriWithoutQuery" is the block of characters between the beginning
4421  * till the delimiter or '\0' which ever comes first.
4422  * "query" is whatever is to the right of the delimiter if present.
4423  * No delimiter sets the query to NULL.
4424  * If either are present, they will be malloc'ed into the params 2, 3.
4425  * The first param, *uri is left untouched.
4426
4427  * NOTE: This function does not account for whitespace at the end of the uri NOR
4428  *       malformed uri's with '??'. Whitespace at the end will be assumed to be
4429  *       part of the query.
4430  */
4431 OCStackResult getQueryFromUri(const char * uri, char** query, char ** uriWithoutQuery)
4432 {
4433     if(!uri)
4434     {
4435         return OC_STACK_INVALID_URI;
4436     }
4437     if(!query || !uriWithoutQuery)
4438     {
4439         return OC_STACK_INVALID_PARAM;
4440     }
4441
4442     *query           = NULL;
4443     *uriWithoutQuery = NULL;
4444
4445     size_t uriWithoutQueryLen = 0;
4446     size_t queryLen = 0;
4447     size_t uriLen = strlen(uri);
4448
4449     char *pointerToDelimiter = strstr(uri, "?");
4450
4451     uriWithoutQueryLen = pointerToDelimiter == NULL ? uriLen : (size_t)(pointerToDelimiter - uri);
4452     queryLen = pointerToDelimiter == NULL ? 0 : uriLen - uriWithoutQueryLen - 1;
4453
4454     if (uriWithoutQueryLen)
4455     {
4456         *uriWithoutQuery =  (char *) OICCalloc(uriWithoutQueryLen + 1, 1);
4457         if (!*uriWithoutQuery)
4458         {
4459             goto exit;
4460         }
4461         OICStrcpy(*uriWithoutQuery, uriWithoutQueryLen +1, uri);
4462     }
4463     if (queryLen)
4464     {
4465         *query = (char *) OICCalloc(queryLen + 1, 1);
4466         if (!*query)
4467         {
4468             OICFree(*uriWithoutQuery);
4469             *uriWithoutQuery = NULL;
4470             goto exit;
4471         }
4472         OICStrcpy(*query, queryLen + 1, pointerToDelimiter + 1);
4473     }
4474
4475     return OC_STACK_OK;
4476
4477     exit:
4478         return OC_STACK_NO_MEMORY;
4479 }
4480
4481 static const OicUuid_t* OCGetServerInstanceID(void)
4482 {
4483     static bool generated = false;
4484     static OicUuid_t sid;
4485     if (generated)
4486     {
4487         return &sid;
4488     }
4489
4490     if (OC_STACK_OK != GetDoxmDeviceID(&sid))
4491     {
4492         OIC_LOG(FATAL, TAG, "Generate UUID for Server Instance failed!");
4493         return NULL;
4494     }
4495     generated = true;
4496     return &sid;
4497 }
4498
4499 const char* OCGetServerInstanceIDString(void)
4500 {
4501     static bool generated = false;
4502     static char sidStr[UUID_STRING_SIZE];
4503
4504     if(generated)
4505     {
4506         return sidStr;
4507     }
4508
4509     const OicUuid_t *sid = OCGetServerInstanceID();
4510     if(OCConvertUuidToString(sid->id, sidStr) != RAND_UUID_OK)
4511     {
4512         OIC_LOG(FATAL, TAG, "Generate UUID String for Server Instance failed!");
4513         return NULL;
4514     }
4515
4516     generated = true;
4517     return sidStr;
4518 }
4519
4520 CAResult_t OCSelectNetwork()
4521 {
4522     CAResult_t retResult = CA_STATUS_FAILED;
4523     CAResult_t caResult = CA_STATUS_OK;
4524
4525     CATransportAdapter_t connTypes[] = {
4526             CA_ADAPTER_IP,
4527             CA_ADAPTER_RFCOMM_BTEDR,
4528             CA_ADAPTER_GATT_BTLE,
4529             CA_ADAPTER_NFC
4530 #ifdef RA_ADAPTER
4531             ,CA_ADAPTER_REMOTE_ACCESS
4532 #endif
4533
4534 #ifdef TCP_ADAPTER
4535             ,CA_ADAPTER_TCP
4536 #endif
4537         };
4538     int numConnTypes = sizeof(connTypes)/sizeof(connTypes[0]);
4539
4540     for(int i = 0; i<numConnTypes; i++)
4541     {
4542         // Ignore CA_NOT_SUPPORTED error. The CA Layer may have not compiled in the interface.
4543         if(caResult == CA_STATUS_OK || caResult == CA_NOT_SUPPORTED)
4544         {
4545            caResult = CASelectNetwork(connTypes[i]);
4546            if(caResult == CA_STATUS_OK)
4547            {
4548                retResult = CA_STATUS_OK;
4549            }
4550         }
4551     }
4552
4553     if(retResult != CA_STATUS_OK)
4554     {
4555         return caResult; // Returns error of appropriate transport that failed fatally.
4556     }
4557
4558     return retResult;
4559 }
4560
4561 OCStackResult CAResultToOCResult(CAResult_t caResult)
4562 {
4563     switch (caResult)
4564     {
4565         case CA_STATUS_OK:
4566             return OC_STACK_OK;
4567         case CA_STATUS_INVALID_PARAM:
4568             return OC_STACK_INVALID_PARAM;
4569         case CA_ADAPTER_NOT_ENABLED:
4570             return OC_STACK_ADAPTER_NOT_ENABLED;
4571         case CA_SERVER_STARTED_ALREADY:
4572             return OC_STACK_OK;
4573         case CA_SERVER_NOT_STARTED:
4574             return OC_STACK_ERROR;
4575         case CA_DESTINATION_NOT_REACHABLE:
4576             return OC_STACK_COMM_ERROR;
4577         case CA_SOCKET_OPERATION_FAILED:
4578             return OC_STACK_COMM_ERROR;
4579         case CA_SEND_FAILED:
4580             return OC_STACK_COMM_ERROR;
4581         case CA_RECEIVE_FAILED:
4582             return OC_STACK_COMM_ERROR;
4583         case CA_MEMORY_ALLOC_FAILED:
4584             return OC_STACK_NO_MEMORY;
4585         case CA_REQUEST_TIMEOUT:
4586             return OC_STACK_TIMEOUT;
4587         case CA_DESTINATION_DISCONNECTED:
4588             return OC_STACK_COMM_ERROR;
4589         case CA_STATUS_FAILED:
4590             return OC_STACK_ERROR;
4591         case CA_NOT_SUPPORTED:
4592             return OC_STACK_NOTIMPL;
4593         default:
4594             return OC_STACK_ERROR;
4595     }
4596 }