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