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