resource/csdk/stack/src/ocstack.c

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