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 #define _POSIX_C_SOURCE 200112L
  26 #include <string.h>
  27
  28 #include "ocstack.h"
  29 #include "ocstackinternal.h"
  30 #include "ocresourcehandler.h"
  31 #include "occlientcb.h"
  32 #include "ocobserve.h"
  33 #include "ocrandom.h"
  34 #include "debug.h"
  35 #include "occoap.h"
  36 #include "ocmalloc.h"
  37 #include "ocserverrequest.h"
  38
  39 #ifdef CA_INT
  40     #include "cacommon.h"
  41     #include "cainterface.h"
  42 #endif
  43
  44 //-----------------------------------------------------------------------------
  45 // Typedefs
  46 //-----------------------------------------------------------------------------
  47 typedef enum {
  48     OC_STACK_UNINITIALIZED = 0, OC_STACK_INITIALIZED, OC_STACK_UNINIT_IN_PROGRESS
  49 } OCStackState;
  50
  51 #ifdef WITH_PRESENCE
  52 typedef enum {
  53     OC_PRESENCE_UNINITIALIZED = 0, OC_PRESENCE_INITIALIZED
  54 } OCPresenceState;
  55 #endif
  56
  57 //-----------------------------------------------------------------------------
  58 // Private variables
  59 //-----------------------------------------------------------------------------
  60 static OCStackState stackState = OC_STACK_UNINITIALIZED;
  61
  62 OCResource *headResource = NULL;
  63 #ifdef WITH_PRESENCE
  64 static OCPresenceState presenceState = OC_PRESENCE_UNINITIALIZED;
  65 static PresenceResource presenceResource;
  66 uint8_t PresenceTimeOutSize = 0;
  67 uint32_t PresenceTimeOut[] = {50, 75, 85, 95, 100};
  68 #endif
  69
  70 OCMode myStackMode;
  71 OCDeviceEntityHandler defaultDeviceHandler;
  72 OCStackResult getQueryFromUri(const char * uri, unsigned char** resourceType, char ** newURI);
  73
  74 //-----------------------------------------------------------------------------
  75 // Macros
  76 //-----------------------------------------------------------------------------
  77 #define TAG  PCF("OCStack")
  78 #define VERIFY_SUCCESS(op, successCode) { if (op != successCode) \
  79             {OC_LOG_V(FATAL, TAG, "%s failed!!", #op); goto exit;} }
  80 #define VERIFY_NON_NULL(arg, logLevel, retVal) { if (!(arg)) { OC_LOG((logLevel), \
  81              TAG, PCF(#arg " is NULL")); return (retVal); } }
  82 #define VERIFY_NON_NULL_V(arg) { if (!arg) {OC_LOG_V(FATAL, TAG, "%s is NULL", #arg);\
  83     goto exit;} }
  84
  85 //TODO: we should allow the server to define this
  86 #define MAX_OBSERVE_AGE (0x2FFFFUL)
  87
  88 //-----------------------------------------------------------------------------
  89 // Externs
  90 //-----------------------------------------------------------------------------
  91 extern void DeinitOCSecurityInfo();
  92
  93 //-----------------------------------------------------------------------------
  94 // Internal API function
  95 //-----------------------------------------------------------------------------
  96
  97 // This internal function is called to update the stack with the status of
  98 // observers and communication failures
  99 OCStackResult OCStackFeedBack(OCCoAPToken * token, uint8_t status)
 100 {
 101     OCStackResult result = OC_STACK_ERROR;
 102     ResourceObserver * observer = NULL;
 103     OCEntityHandlerRequest ehRequest = {0};
 104
 105     switch(status)
 106     {
 107     case OC_OBSERVER_NOT_INTERESTED:
 108         OC_LOG(DEBUG, TAG, PCF("observer is not interested in our notifications anymore"));
 109         #ifdef CA_INT
 110         observer = GetObserverUsingToken (token->token);
 111         #else
 112         observer = GetObserverUsingToken (token);
 113         #endif
 114         if(observer)
 115         {
 116             result = FormOCEntityHandlerRequest(&ehRequest, (OCRequestHandle) NULL,
 117                     OC_REST_NOMETHOD, (OCResourceHandle) NULL, NULL, NULL, 0,
 118                     NULL, OC_OBSERVE_DEREGISTER, observer->observeId);
 119             if(result != OC_STACK_OK)
 120             {
 121                 return result;
 122             }
 123             observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest);
 124         }
 125         //observer is not observing anymore
 126         #ifdef CA_INT
 127         result = DeleteObserverUsingToken (token->token);
 128         #else
 129         result = DeleteObserverUsingToken (token);
 130         #endif
 131         if(result == OC_STACK_OK)
 132         {
 133             OC_LOG(DEBUG, TAG, PCF("Removed observer successfully"));
 134         }
 135         else
 136         {
 137             result = OC_STACK_OK;
 138             OC_LOG(DEBUG, TAG, PCF("Observer Removal failed"));
 139         }
 140         break;
 141     case OC_OBSERVER_STILL_INTERESTED:
 142         //observer is still interested
 143         OC_LOG(DEBUG, TAG, PCF("observer is interested in our \
 144                 notifications, reset the failedCount"));
 145         #ifdef CA_INT
 146         observer = GetObserverUsingToken (token->token);
 147         #else
 148         observer = GetObserverUsingToken (token);
 149         #endif
 150         if(observer)
 151         {
 152             observer->forceHighQos = 0;
 153             observer->failedCommCount = 0;
 154             result = OC_STACK_OK;
 155         }
 156         else
 157         {
 158             result = OC_STACK_OBSERVER_NOT_FOUND;
 159         }
 160         break;
 161     case OC_OBSERVER_FAILED_COMM:
 162         //observer is not reachable
 163         OC_LOG(DEBUG, TAG, PCF("observer is unreachable"));
 164         #ifdef CA_INT
 165         observer = GetObserverUsingToken (token->token);
 166         #else
 167         observer = GetObserverUsingToken (token);
 168         #endif
 169         if(observer)
 170         {
 171             if(observer->failedCommCount >= MAX_OBSERVER_FAILED_COMM)
 172             {
 173                 result = FormOCEntityHandlerRequest(&ehRequest, (OCRequestHandle) NULL,
 174                         OC_REST_NOMETHOD, (OCResourceHandle) NULL, NULL, NULL, 0,
 175                         NULL, OC_OBSERVE_DEREGISTER, observer->observeId);
 176                 if(result != OC_STACK_OK)
 177                 {
 178                     return OC_STACK_ERROR;
 179                 }
 180                 observer->resource->entityHandler(OC_OBSERVE_FLAG, &ehRequest);
 181                 //observer is unreachable
 182                 result = DeleteObserverUsingToken (token);
 183                 if(result == OC_STACK_OK)
 184                 {
 185                     OC_LOG(DEBUG, TAG, PCF("Removed observer successfully"));
 186                 }
 187                 else
 188                 {
 189                     result = OC_STACK_OK;
 190                     OC_LOG(DEBUG, TAG, PCF("Observer Removal failed"));
 191                 }
 192             }
 193             else
 194             {
 195                 observer->failedCommCount++;
 196                 result = OC_STACK_CONTINUE;
 197             }
 198             observer->forceHighQos = 1;
 199             OC_LOG_V(DEBUG, TAG, "Failed count for this observer is %d",observer->failedCommCount);
 200         }
 201         break;
 202     default:
 203         OC_LOG(ERROR, TAG, PCF("Unknown status"));
 204         result = OC_STACK_ERROR;
 205         break;
 206         }
 207     return result;
 208 }
 209
 210 #ifdef CA_INT
 211 OCStackResult CAToOCStackResult(CAResponseResult_t caCode)
 212 {
 213     OCStackResult ret = OC_STACK_ERROR;
 214
 215     switch(caCode)
 216     {
 217         case CA_SUCCESS:
 218             ret = OC_STACK_OK;
 219             break;
 220         case CA_CREATED:
 221             ret = OC_STACK_RESOURCE_CREATED;
 222             break;
 223         case CA_DELETED:
 224             ret = OC_STACK_RESOURCE_DELETED;
 225             break;
 226         case CA_BAD_REQ:
 227             ret = OC_STACK_INVALID_QUERY;
 228             break;
 229         case CA_BAD_OPT:
 230             ret = OC_STACK_INVALID_OPTION;
 231             break;
 232         case CA_NOT_FOUND:
 233             ret = OC_STACK_NO_RESOURCE;
 234             break;
 235         default:
 236             break;
 237     }
 238     return ret;
 239 }
 240
 241 OCStackResult OCToCAConnectivityType(OCConnectivityType ocConType, CAConnectivityType_t* caConType)
 242 {
 243     OCStackResult ret = OC_STACK_OK;
 244
 245     switch(ocConType)
 246     {
 247         case OC_ETHERNET:
 248             *caConType = CA_ETHERNET;
 249             break;
 250         case OC_WIFI:
 251             *caConType = CA_WIFI;
 252             break;
 253         case OC_EDR:
 254             *caConType = CA_EDR;
 255             break;
 256         case OC_LE:
 257             *caConType = CA_LE;
 258             break;
 259         case OC_ALL:
 260             //TODO-CA Add other connectivity types as they are enabled
 261             *caConType = (CA_WIFI|CA_ETHERNET);
 262             break;
 263         default:
 264             ret = OC_STACK_INVALID_PARAM;
 265             break;
 266     }
 267     return ret;
 268 }
 269
 270 OCStackResult CAToOCConnectivityType(CAConnectivityType_t caConType, OCConnectivityType *ocConType)
 271 {
 272     OCStackResult ret = OC_STACK_OK;
 273
 274     switch(caConType)
 275     {
 276         case CA_ETHERNET:
 277             *ocConType = OC_ETHERNET;
 278             break;
 279         case CA_WIFI:
 280             *ocConType = OC_WIFI;
 281             break;
 282         case CA_EDR:
 283             *ocConType = OC_EDR;
 284             break;
 285         case CA_LE:
 286             *ocConType = OC_LE;
 287             break;
 288         default:
 289             ret = OC_STACK_INVALID_PARAM;
 290             break;
 291     }
 292     return ret;
 293 }
 294
 295 // update response.addr appropriately from endPoint.addressInfo
 296 OCStackResult UpdateResponseAddr(OCClientResponse *response, const CARemoteEndpoint_t* endPoint)
 297 {
 298     struct sockaddr_in sa;
 299     OCStackResult ret = OC_STACK_INVALID_PARAM;
 300     //TODO-CA Check validity of the endPoint pointer
 301     inet_pton(AF_INET, endPoint->addressInfo.IP.ipAddress, &(sa.sin_addr));
 302     sa.sin_port = htons(endPoint->addressInfo.IP.port);
 303     static OCDevAddr address;
 304     memcpy((void*)&address.addr, &(sa), sizeof(sa));
 305     if(response)
 306     {
 307         response->addr = &address;
 308         ret = CAToOCConnectivityType(endPoint->connectivityType, &(response->connType));
 309     }
 310     return ret;
 311 }
 312
 313 void parsePresencePayload(char* payload, uint32_t* seqNum, uint32_t* maxAge, char** resType)
 314 {
 315     char * tok = NULL;
 316
 317     // The format of the payload is {"oc":[%u:%u:%s]}
 318     // %u : sequence number,
 319     // %u : max age
 320     // %s : Resource Type (Optional)
 321     tok = strtok(payload, "[:]}");
 322     payload[strlen(payload)] = ':';
 323     tok = strtok(NULL, "[:]}");
 324     payload[strlen((char *)payload)] = ':';
 325     *seqNum = (uint32_t) atoi(tok);
 326     tok = strtok(NULL, "[:]}");
 327     *maxAge = (uint32_t) atoi(tok);
 328     tok = strtok(NULL, "[:]}");
 329
 330     if(tok)
 331     {
 332         *resType = (char *)OCMalloc(strlen(tok));
 333         if(!*resType)
 334         {
 335             return;
 336         }
 337         payload[strlen((char *)payload)] = ':';
 338         strcpy(*resType, tok);
 339         OC_LOG_V(DEBUG, TAG, "----------------resourceTypeName %s", *resType);
 340     }
 341     payload[strlen((char *)payload)] = ']';
 342 }
 343
 344 OCStackResult HandlePresenceResponse(const CARemoteEndpoint_t* endPoint,
 345                             const CAResponseInfo_t* responseInfo)
 346 {
 347     OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
 348     ClientCB * cbNode = NULL;
 349     char *resourceTypeName = NULL;
 350     OCClientResponse response;
 351     OCStackResult result = OC_STACK_ERROR;
 352     uint32_t lowerBound = 0;
 353     uint32_t higherBound = 0;
 354     uint32_t maxAge = 0;
 355
 356     char *fullUri = NULL;
 357     char *ipAddress = NULL;
 358     int presenceSubscribe = 0;
 359     int multicastPresenceSubscribe = 0;
 360
 361     fullUri = (char *) OCMalloc(MAX_URI_LENGTH );
 362
 363     if(NULL == fullUri)
 364     {
 365         OC_LOG(INFO, TAG, PCF("Memory could not be abllocated for fullUri"));
 366         result = OC_STACK_NO_MEMORY;
 367         goto exit;
 368     }
 369
 370     ipAddress = (char *) OCMalloc(strlen(endPoint->addressInfo.IP.ipAddress) + 1);
 371
 372     if(NULL == ipAddress)
 373     {
 374         OC_LOG(INFO, TAG, PCF("Memory could not be abllocated for ipAddress"));
 375         result = OC_STACK_NO_MEMORY;
 376         goto exit;
 377     }
 378
 379     strncpy(ipAddress, endPoint->addressInfo.IP.ipAddress,
 380                             strlen(endPoint->addressInfo.IP.ipAddress));
 381     ipAddress[strlen(endPoint->addressInfo.IP.ipAddress)] = '\0';
 382
 383     snprintf(fullUri, MAX_URI_LENGTH, "coap://%s:%u%s", ipAddress, endPoint->addressInfo.IP.port,
 384                 OC_PRESENCE_URI);
 385
 386     cbNode = GetClientCB(NULL, NULL, fullUri);
 387
 388     if(cbNode)
 389     {
 390         presenceSubscribe = 1;
 391     }
 392     else
 393     {
 394         snprintf(fullUri, MAX_URI_LENGTH, "%s%s", OC_MULTICAST_IP, endPoint->resourceUri);
 395         cbNode = GetClientCB(NULL, NULL, fullUri);
 396         if(cbNode)
 397         {
 398             multicastPresenceSubscribe = 1;
 399         }
 400     }
 401
 402     if(!presenceSubscribe && !multicastPresenceSubscribe)
 403     {
 404         OC_LOG(INFO, TAG, PCF("Received a presence notification, but I do not have callback \
 405                                                 ------------ ignoring"));
 406         goto exit;
 407     }
 408
 409     // No payload to the application in case of presence
 410     response.resJSONPayload = NULL;
 411     response.result = OC_STACK_OK;
 412
 413     UpdateResponseAddr(&response, endPoint);
 414
 415     if(responseInfo->info.payload)
 416     {
 417         parsePresencePayload(responseInfo->info.payload,
 418                                 &(response.sequenceNumber),
 419                                 &maxAge,
 420                                 &resourceTypeName);
 421     }
 422
 423     if(maxAge == 0)
 424     {
 425         OC_LOG(INFO, TAG, PCF("===============Stopping presence"));
 426         response.result = OC_STACK_PRESENCE_STOPPED;
 427         if(cbNode->presence)
 428         {
 429             OCFree(cbNode->presence->timeOut);
 430             OCFree(cbNode->presence);
 431             cbNode->presence = NULL;
 432         }
 433     }
 434     else if(presenceSubscribe)
 435     {
 436         if(!cbNode->presence)
 437         {
 438             cbNode->presence = (OCPresence *) OCMalloc(sizeof(OCPresence));
 439             VERIFY_NON_NULL_V(cbNode->presence);
 440             cbNode->presence->timeOut = NULL;
 441             cbNode->presence->timeOut = (uint32_t *)
 442                     OCMalloc(PresenceTimeOutSize * sizeof(uint32_t));
 443             if(!(cbNode->presence->timeOut)){
 444                 OCFree(cbNode->presence);
 445                 result = OC_STACK_NO_MEMORY;
 446             }
 447         }
 448
 449         OC_LOG_V(INFO, TAG, "===============Update presence TTL, now time is %u", GetTime(0));
 450         cbNode->presence->TTL = maxAge;
 451         for(int index = 0; index < PresenceTimeOutSize; index++)
 452         {
 453             lowerBound = GetTime(((float)(PresenceTimeOut[index])
 454                     /(float)100)*(float)cbNode->presence->TTL);
 455             higherBound = GetTime(((float)(PresenceTimeOut[index + 1])
 456                     /(float)100)*(float)cbNode->presence->TTL);
 457             cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
 458             OC_LOG_V(DEBUG, TAG, "----------------lowerBound timeout  %d", lowerBound);
 459             OC_LOG_V(DEBUG, TAG, "----------------higherBound timeout %d", higherBound);
 460             OC_LOG_V(DEBUG, TAG, "----------------timeOut entry  %d",
 461                     cbNode->presence->timeOut[index]);
 462         }
 463         cbNode->presence->TTLlevel = 0;
 464         OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
 465         if(cbNode->sequenceNumber == response.sequenceNumber)
 466         {
 467             OC_LOG(INFO, TAG, PCF("===============No presence change"));
 468             goto exit;
 469         }
 470         OC_LOG(INFO, TAG, PCF("===============Presence changed, calling up the stack"));
 471         cbNode->sequenceNumber = response.sequenceNumber;
 472
 473         // Ensure that a filter is actually applied.
 474         if(resourceTypeName && cbNode->filterResourceType)
 475         {
 476             if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
 477             {
 478                 goto exit;
 479             }
 480         }
 481     }
 482     else
 483     {
 484         // This is the multicast case
 485
 486         OCMulticastNode* mcNode = NULL;
 487         mcNode = GetMCPresenceNode((const unsigned char *)fullUri);
 488
 489         if(mcNode != NULL)
 490         {
 491             if(mcNode->nonce == response.sequenceNumber)
 492             {
 493                 OC_LOG(INFO, TAG, PCF("===============No presence change (Multicast)"));
 494                 goto exit;
 495             }
 496             mcNode->nonce = response.sequenceNumber;
 497         }
 498         else
 499         {
 500             uint32_t uriLen = strlen((char*)fullUri);
 501             unsigned char* uri = (unsigned char *) OCMalloc(uriLen + 1);
 502             if(uri)
 503             {
 504                 memcpy(uri, fullUri, (uriLen + 1));
 505             }
 506             else
 507             {
 508                 OC_LOG(INFO, TAG,
 509                     PCF("===============No Memory for URI to store in the presence node"));
 510                 result = OC_STACK_NO_MEMORY;
 511                 goto exit;
 512             }
 513             result = AddMCPresenceNode(&mcNode, (unsigned char*) uri, response.sequenceNumber);
 514             if(result == OC_STACK_NO_MEMORY)
 515             {
 516                 OC_LOG(INFO, TAG,
 517                     PCF("===============No Memory for Multicast Presence Node"));
 518                 result = OC_STACK_NO_MEMORY;
 519                 goto exit;
 520             }
 521         }
 522
 523         // Ensure that a filter is actually applied.
 524         if(resourceTypeName && cbNode->filterResourceType)
 525         {
 526             if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
 527             {
 528                 goto exit;
 529             }
 530         }
 531     }
 532
 533     cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &response);
 534
 535     if (cbResult == OC_STACK_DELETE_TRANSACTION)
 536     {
 537         FindAndDeleteClientCB(cbNode);
 538     }
 539
 540 exit:
 541 OCFree(fullUri);
 542 OCFree(ipAddress);
 543 OCFree(resourceTypeName);
 544 return result;
 545 }
 546
 547
 548 //This function will be called back by CA layer when a response is received
 549 void HandleCAResponses(const CARemoteEndpoint_t* endPoint, const CAResponseInfo_t* responseInfo)
 550 {
 551     OC_LOG(INFO, TAG, PCF("Enter HandleCAResponses"));
 552
 553     if(NULL == endPoint)
 554     {
 555         OC_LOG(ERROR, TAG, PCF("endPoint is NULL"));
 556         return;
 557     }
 558
 559     if(NULL == responseInfo)
 560     {
 561         OC_LOG(ERROR, TAG, PCF("responseInfo is NULL"));
 562         return;
 563     }
 564
 565     if(strcmp(endPoint->resourceUri, OC_PRESENCE_URI) == 0)
 566     {
 567         HandlePresenceResponse(endPoint, responseInfo);
 568         return;
 569     }
 570
 571     ClientCB *cbNode = GetClientCB((CAToken_t *)&responseInfo->info.token, NULL, NULL);
 572
 573     if (cbNode)
 574     {
 575         OC_LOG(INFO, TAG, PCF("Calling into application address space"));
 576         OCClientResponse response;
 577
 578         OCStackResult result = UpdateResponseAddr(&response, endPoint);
 579         if(result != OC_STACK_OK)
 580         {
 581             OC_LOG(ERROR, TAG, PCF("Invalid connectivity type in endpoint"));
 582             return;
 583         }
 584
 585         response.result = CAToOCStackResult(responseInfo->result);
 586         response.resJSONPayload = (unsigned char*)responseInfo->info.payload;
 587         response.numRcvdVendorSpecificHeaderOptions = 0;
 588         if(responseInfo->info.numOptions > 0)
 589         {
 590             int start = 0;
 591             //First option always with option ID is COAP_OPTION_OBSERVE if it is available.
 592             if(responseInfo->info.options[0].optionID == COAP_OPTION_OBSERVE)
 593             {
 594                 memcpy (&(response.sequenceNumber),
 595                             &(responseInfo->info.options[0].optionData), sizeof(uint32_t));
 596                 response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions - 1;
 597                 start = 1;
 598             }
 599             else
 600             {
 601                response.numRcvdVendorSpecificHeaderOptions = responseInfo->info.numOptions;
 602             }
 603
 604             if(response.numRcvdVendorSpecificHeaderOptions > MAX_HEADER_OPTIONS)
 605             {
 606                 OC_LOG(ERROR, TAG, PCF("#header options are more than MAX_HEADER_OPTIONS"));
 607                 return;
 608             }
 609
 610             for (uint8_t i = start; i < responseInfo->info.numOptions; i++)
 611             {
 612                 memcpy (&(response.rcvdVendorSpecificHeaderOptions[i-start]),
 613                  &(responseInfo->info.options[i]), sizeof(OCHeaderOption));
 614             }
 615         }
 616         result = cbNode->callBack(cbNode->context,
 617                 cbNode->handle, &response);
 618         if (result == OC_STACK_DELETE_TRANSACTION)
 619         {
 620             FindAndDeleteClientCB(cbNode);
 621         }
 622     }
 623     OC_LOG_V(INFO, TAG, PCF("Received payload: %s\n"), (char*)responseInfo->info.payload);
 624     OC_LOG(INFO, TAG, PCF("Exit HandleCAResponses"));
 625 }
 626
 627 //This function will be called back by CA layer when a request is received
 628 void HandleCARequests(const CARemoteEndpoint_t* endPoint, const CARequestInfo_t* requestInfo)
 629 {
 630     OC_LOG(INFO, TAG, PCF("Enter HandleCARequests"));
 631
 632 #if 1
 633     if(myStackMode == OC_CLIENT)
 634     {
 635         //TODO: should the client be responding to requests?
 636         return;
 637     }
 638
 639     OCServerProtocolRequest serverRequest;
 640
 641     memset (&serverRequest, 0, sizeof(OCServerProtocolRequest));
 642     OC_LOG_V(INFO, TAG, PCF("***** Endpoint URI ***** : %s\n"), (char*)endPoint->resourceUri);
 643
 644     char * newUri = (char *)endPoint->resourceUri;
 645     unsigned char * query = NULL;
 646     getQueryFromUri(endPoint->resourceUri, &query, &newUri);
 647     OC_LOG_V(INFO, TAG, PCF("**********URI without query ****: %s\n"), newUri);
 648     OC_LOG_V(INFO, TAG, PCF("**********Query ****: %s\n"), query);
 649     //copy URI
 650     memcpy (&(serverRequest.resourceUrl), newUri, strlen(newUri));
 651     //copy query
 652     if(query)
 653     {
 654         memcpy (&(serverRequest.query), query, strlen((char*)query));
 655     }
 656     //copy request payload
 657     if (requestInfo->info.payload)
 658     {
 659         serverRequest.reqTotalSize = strlen(requestInfo->info.payload) + 1;
 660         memcpy (&(serverRequest.reqJSONPayload), requestInfo->info.payload,
 661                 strlen(requestInfo->info.payload));
 662         serverRequest.reqTotalSize = strlen((const char *)requestInfo->info.payload) + 1;
 663     }
 664     else
 665     {
 666         serverRequest.reqTotalSize = 1;
 667     }
 668
 669     switch (requestInfo->method)
 670     {
 671         case CA_GET:
 672             {
 673                 serverRequest.method = OC_REST_GET;
 674                 break;
 675             }
 676         case CA_PUT:
 677             {
 678                 serverRequest.method = OC_REST_PUT;
 679                 break;
 680             }
 681         case CA_POST:
 682             {
 683                 serverRequest.method = OC_REST_POST;
 684                 break;
 685             }
 686         case CA_DELETE:
 687             {
 688                 serverRequest.method = OC_REST_DELETE;
 689                 break;
 690             }
 691         default:
 692             {
 693                 OC_LOG(ERROR, TAG, PCF("Received CA method %d not supported"));
 694                 return;
 695             }
 696     }
 697
 698     // copy token
 699     OC_LOG_V(INFO, TAG, "HandleCARequests: CA token length = %d", strlen(requestInfo->info.token));
 700     OC_LOG_BUFFER(INFO, TAG, requestInfo->info.token, strlen(requestInfo->info.token));
 701     // TODO-CA: For CA integration currently copying CAToken to OCCoapToken:
 702     // Need to remove OCCoapToken
 703     memcpy (&(serverRequest.requestToken.token), requestInfo->info.token,
 704             MAX_TOKEN_LENGTH);
 705     serverRequest.requestToken.tokenLength = MAX_TOKEN_LENGTH;
 706
 707     if (requestInfo->info.type == CA_MSG_CONFIRM)
 708     {
 709         serverRequest.qos = OC_HIGH_QOS;
 710     }
 711     else if (requestInfo->info.type == CA_MSG_NONCONFIRM)
 712     {
 713         serverRequest.qos = OC_LOW_QOS;
 714     }
 715     else if (requestInfo->info.type == CA_MSG_ACKNOWLEDGE)
 716     {
 717         // TODO-CA: Need to handle this
 718     }
 719     else if (requestInfo->info.type == CA_MSG_RESET)
 720     {
 721         // TODO-CA: Need to handle this
 722     }
 723     // CA does not need the following 3 fields
 724     serverRequest.coapID = 0;
 725     serverRequest.delayedResNeeded = 0;
 726     serverRequest.secured = endPoint->isSecured;
 727
 728     // copy the address
 729     serverRequest.addressInfo      = endPoint->addressInfo;
 730     serverRequest.connectivityType = endPoint->connectivityType;
 731     if (requestInfo->info.token)
 732     {
 733         strncpy(serverRequest.token, requestInfo->info.token, sizeof(serverRequest.token) - 1);
 734     }
 735
 736     // copy vendor specific header options
 737     // TODO-CA: CA is including non-vendor header options as well, like observe.
 738     // Need to filter those out
 739     GetObserveHeaderOption(&serverRequest.observationOption, requestInfo->info.options, &(requestInfo->info.numOptions));
 740     if (requestInfo->info.numOptions > MAX_HEADER_OPTIONS)
 741     {
 742         // TODO-CA: Need to send an error indicating the num of options is incorrect
 743         return;
 744     }
 745     serverRequest.numRcvdVendorSpecificHeaderOptions = requestInfo->info.numOptions;
 746     if (serverRequest.numRcvdVendorSpecificHeaderOptions)
 747     {
 748         memcpy (&(serverRequest.rcvdVendorSpecificHeaderOptions), requestInfo->info.options,
 749             sizeof(CAHeaderOption_t)*requestInfo->info.numOptions);
 750     }
 751
 752     if(HandleStackRequests (&serverRequest) != OC_STACK_OK)
 753     {
 754         OC_LOG(INFO, TAG, PCF("HandleStackRequests failed"));
 755     }
 756 #endif
 757
 758     OC_LOG(INFO, TAG, PCF("Exit HandleCARequests"));
 759 }
 760
 761 #endif // CA_INT
 762
 763 //This function will be called back by occoap layer when a request is received
 764 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest)
 765 {
 766     OC_LOG(INFO, TAG, PCF("Entering HandleStackRequests (OCStack Layer)"));
 767     OCStackResult result = OC_STACK_ERROR;
 768     ResourceHandling resHandling;
 769     OCResource *resource;
 770
 771     OCServerRequest * request = GetServerRequestUsingToken(protocolRequest->requestToken);
 772     if(!request)
 773     {
 774         OC_LOG(INFO, TAG, PCF("This is a new Server Request"));
 775 #ifdef CA_INT
 776         result = AddServerCARequest(&request, protocolRequest->coapID,
 777                 protocolRequest->delayedResNeeded, protocolRequest->secured, 0,
 778                 protocolRequest->method, protocolRequest->numRcvdVendorSpecificHeaderOptions,
 779                 protocolRequest->observationOption, protocolRequest->qos,
 780                 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
 781                 protocolRequest->reqJSONPayload, &protocolRequest->requestToken,
 782                 &protocolRequest->requesterAddr, protocolRequest->resourceUrl,
 783                 protocolRequest->reqTotalSize,
 784                 &protocolRequest->addressInfo, protocolRequest->connectivityType, protocolRequest->token);
 785 #else
 786         result = AddServerRequest(&request, protocolRequest->coapID,
 787                 protocolRequest->delayedResNeeded, protocolRequest->secured, 0,
 788                 protocolRequest->method, protocolRequest->numRcvdVendorSpecificHeaderOptions,
 789                 protocolRequest->observationOption, protocolRequest->qos,
 790                 protocolRequest->query, protocolRequest->rcvdVendorSpecificHeaderOptions,
 791                 protocolRequest->reqJSONPayload, &protocolRequest->requestToken,
 792                 &protocolRequest->requesterAddr, protocolRequest->resourceUrl,
 793                 protocolRequest->reqTotalSize);
 794 #endif
 795         if (OC_STACK_OK != result)
 796         {
 797             OC_LOG(ERROR, TAG, PCF("Error adding server request"));
 798             return result;
 799         }
 800         VERIFY_NON_NULL(request, ERROR, OC_STACK_NO_MEMORY);
 801
 802         if(!protocolRequest->reqMorePacket)
 803         {
 804             request->requestComplete = 1;
 805         }
 806     }
 807     else
 808     {
 809         OC_LOG(INFO, TAG, PCF("This is either a repeated Server Request or blocked Server Request"));
 810     }
 811
 812     if(request->requestComplete)
 813     {
 814         OC_LOG(INFO, TAG, PCF("This Server Request is complete"));
 815         result = DetermineResourceHandling (request, &resHandling, &resource);
 816         if (result == OC_STACK_OK)
 817         {
 818             result = ProcessRequest(resHandling, resource, request);
 819         }
 820         else
 821         {
 822             result = OC_STACK_ERROR;
 823         }
 824     }
 825     else
 826     {
 827         OC_LOG(INFO, TAG, PCF("This Server Request is incomplete"));
 828         result = OC_STACK_CONTINUE;
 829     }
 830     return result;
 831 }
 832
 833 //This function will be called back by occoap layer when a response is received
 834 OCStackResult HandleStackResponses(OCResponse * response)
 835 {
 836     OC_LOG(INFO, TAG, PCF("Entering HandleStackResponses (OCStack Layer)"));
 837     OCStackResult result = OC_STACK_OK;
 838     OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
 839     uint8_t isObserveNotification = 0;
 840     ClientCB * cbNode = NULL;
 841     #ifdef WITH_PRESENCE
 842     uint8_t isPresenceNotification = 0;
 843     uint8_t isMulticastPresence = 0;
 844     char * resourceTypeName = NULL;
 845     uint32_t lowerBound = 0;
 846     uint32_t higherBound = 0;
 847     char * tok = NULL;
 848     unsigned char * bufRes = response->bufRes;
 849     #endif // WITH_PRESENCE
 850
 851     cbNode = response->cbNode;
 852     if(!cbNode)
 853     {
 854         cbNode = GetClientCB(response->rcvdToken, NULL, NULL);
 855     }
 856
 857     if(response->clientResponse->sequenceNumber >= OC_OFFSET_SEQUENCE_NUMBER)
 858     {
 859         isObserveNotification = 1;
 860         OC_LOG(INFO, TAG, PCF("Received an observe notification"));
 861     }
 862
 863     OC_LOG_V(DEBUG, TAG, "The sequenceNumber/NONCE of this response %u",
 864             response->clientResponse->sequenceNumber);
 865     OC_LOG_V(DEBUG, TAG, "The maxAge/TTL of this response %u", response->maxAge);
 866     OC_LOG_V(DEBUG, TAG, "The response received is %s", bufRes);
 867
 868 #ifdef WITH_PRESENCE
 869     if(!strcmp((char *)response->rcvdUri, (char *)OC_PRESENCE_URI)){
 870         isPresenceNotification = 1;
 871         if(!bufRes)
 872         {
 873             result = OC_STACK_INVALID_PARAM;
 874             goto exit;
 875         }
 876         tok = strtok((char *)bufRes, "[:]}");
 877         bufRes[strlen((char *)bufRes)] = ':';
 878         tok = strtok(NULL, "[:]}");
 879         bufRes[strlen((char *)bufRes)] = ':';
 880         response->clientResponse->sequenceNumber = (uint32_t )atoi(tok);
 881         OC_LOG_V(DEBUG, TAG, "The received NONCE is %u", response->clientResponse->sequenceNumber);
 882         tok = strtok(NULL, "[:]}");
 883         response->maxAge = (uint32_t )atoi(tok);
 884         OC_LOG_V(DEBUG, TAG, "The received TTL is %u", response->maxAge);
 885         tok = strtok(NULL, "[:]}");
 886         if(tok)
 887         {
 888             resourceTypeName = (char *)OCMalloc(strlen(tok));
 889             if(!resourceTypeName)
 890             {
 891                 goto exit;
 892             }
 893             bufRes[strlen((char *)bufRes)] = ':';
 894             strcpy(resourceTypeName, tok);
 895             OC_LOG_V(DEBUG, TAG, "----------------resourceTypeName %s",
 896                     resourceTypeName);
 897         }
 898         bufRes[strlen((char *)bufRes)] = ']';
 899     }
 900
 901     // Check if the application subcribed for presence
 902     if(!cbNode)
 903     {
 904         cbNode = GetClientCB(NULL, NULL, response->fullUri);
 905     }
 906
 907     // Check if application subscribed for multicast presence
 908     if(!cbNode)
 909     {
 910         snprintf((char *)response->fullUri, MAX_URI_LENGTH, "%s%s",
 911                 OC_MULTICAST_IP, response->rcvdUri);
 912         cbNode = GetClientCB(NULL, NULL, response->fullUri);
 913         if(cbNode)
 914         {
 915             isMulticastPresence = 1;
 916             isPresenceNotification = 0;
 917         }
 918     }
 919
 920     if(cbNode && isPresenceNotification)
 921     {
 922         OC_LOG(INFO, TAG, PCF("Received a presence notification"));
 923         if(!cbNode->presence)
 924         {
 925             cbNode->presence = (OCPresence *) OCMalloc(sizeof(OCPresence));
 926             VERIFY_NON_NULL_V(cbNode->presence);
 927             cbNode->presence->timeOut = NULL;
 928             cbNode->presence->timeOut = (uint32_t *)
 929                     OCMalloc(PresenceTimeOutSize * sizeof(uint32_t));
 930             if(!(cbNode->presence->timeOut)){
 931                 OCFree(cbNode->presence);
 932                 result = OC_STACK_NO_MEMORY;
 933             }
 934         }
 935         if(response->maxAge == 0)
 936         {
 937             OC_LOG(INFO, TAG, PCF("===============Stopping presence"));
 938             response->clientResponse->result = OC_STACK_PRESENCE_STOPPED;
 939             if(cbNode->presence)
 940             {
 941                 OCFree(cbNode->presence->timeOut);
 942                 OCFree(cbNode->presence);
 943                 cbNode->presence = NULL;
 944             }
 945         }
 946         else
 947         {
 948             OC_LOG_V(INFO, TAG, "===============Update presence TTL, now time is %d", GetTime(0));
 949             cbNode->presence->TTL = response->maxAge;
 950             for(int index = 0; index < PresenceTimeOutSize; index++)
 951             {
 952                 lowerBound = GetTime(((float)(PresenceTimeOut[index])
 953                         /(float)100)*(float)cbNode->presence->TTL);
 954                 higherBound = GetTime(((float)(PresenceTimeOut[index + 1])
 955                         /(float)100)*(float)cbNode->presence->TTL);
 956                 cbNode->presence->timeOut[index] = OCGetRandomRange(lowerBound, higherBound);
 957                 OC_LOG_V(DEBUG, TAG, "----------------lowerBound timeout  %d", lowerBound);
 958                 OC_LOG_V(DEBUG, TAG, "----------------higherBound timeout %d", higherBound);
 959                 OC_LOG_V(DEBUG, TAG, "----------------timeOut entry  %d",
 960                         cbNode->presence->timeOut[index]);
 961             }
 962             cbNode->presence->TTLlevel = 0;
 963             OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
 964             if(cbNode->sequenceNumber == response->clientResponse->sequenceNumber)
 965             {
 966                 OC_LOG(INFO, TAG, PCF("===============No presence change"));
 967                 goto exit;
 968             }
 969             OC_LOG(INFO, TAG, PCF("===============Presence changed, calling up the stack"));
 970             cbNode->sequenceNumber = response->clientResponse->sequenceNumber;;
 971         }
 972
 973         // Ensure that a filter is actually applied.
 974         if(resourceTypeName && cbNode->filterResourceType)
 975         {
 976             if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
 977             {
 978                 goto exit;
 979             }
 980         }
 981     }
 982     else if(cbNode && isMulticastPresence)
 983     {
 984         // Check if the same nonce for a given host
 985         OCMulticastNode* mcNode = NULL;
 986         mcNode = GetMCPresenceNode(response->fullUri);
 987
 988         if(response->maxAge == 0)
 989         {
 990             OC_LOG(INFO, TAG, PCF("===============Stopping presence"));
 991             response->clientResponse->result = OC_STACK_PRESENCE_STOPPED;
 992             if(cbNode->presence)
 993             {
 994                 OCFree(cbNode->presence->timeOut);
 995                 OCFree(cbNode->presence);
 996                 cbNode->presence = NULL;
 997             }
 998         }
 999         else if(mcNode != NULL)
1000         {
1001             if(mcNode->nonce == response->clientResponse->sequenceNumber)
1002             {
1003                 OC_LOG(INFO, TAG, PCF("===============No presence change (Multicast)"));
1004                 result = OC_STACK_NO_MEMORY;
1005                 goto exit;
1006             }
1007             mcNode->nonce = response->clientResponse->sequenceNumber;
1008         }
1009         else
1010         {
1011             uint32_t uriLen = strlen((char*)response->fullUri);
1012             unsigned char* uri = (unsigned char *) OCMalloc(uriLen + 1);
1013             if(uri)
1014             {
1015                 memcpy(uri, response->fullUri, (uriLen + 1));
1016             }
1017             else
1018             {
1019                 OC_LOG(INFO, TAG,
1020                     PCF("===============No Memory for URI to store in the presence node"));
1021                 result = OC_STACK_NO_MEMORY;
1022                 goto exit;
1023             }
1024             result = AddMCPresenceNode(&mcNode, (unsigned char*) uri,
1025                     response->clientResponse->sequenceNumber);
1026             if(result == OC_STACK_NO_MEMORY)
1027             {
1028                 OC_LOG(INFO, TAG,
1029                     PCF("===============No Memory for Multicast Presence Node"));
1030                 result = OC_STACK_NO_MEMORY;
1031                 goto exit;
1032             }
1033         }
1034
1035         // Ensure that a filter is actually applied.
1036         if(resourceTypeName && cbNode->filterResourceType)
1037         {
1038             if(!findResourceType(cbNode->filterResourceType, resourceTypeName))
1039             {
1040                 goto exit;
1041             }
1042         }
1043     }
1044
1045     else if(!cbNode && isPresenceNotification)
1046     {
1047     OC_LOG(INFO, TAG, PCF("Received a presence notification, but I do not have callback \
1048                  ------------ ignoring"));
1049     }
1050     #endif // WITH_PRESENCE
1051
1052     if(cbNode)
1053     {
1054         if(isObserveNotification)
1055         {
1056             OC_LOG(INFO, TAG, PCF("Received an observe notification"));
1057             //TODO: check the standard for methods to detect wrap around condition
1058             if(cbNode->method == OC_REST_OBSERVE &&
1059                     (response->clientResponse->sequenceNumber <= cbNode->sequenceNumber ||
1060                             (response->clientResponse->sequenceNumber > cbNode->sequenceNumber &&
1061                                     response->clientResponse->sequenceNumber ==
1062                                             MAX_SEQUENCE_NUMBER)))
1063             {
1064                 OC_LOG_V(DEBUG, TAG, "Observe notification came out of order. \
1065                         Ignoring Incoming:%d  Against Current:%d.",
1066                         response->clientResponse->sequenceNumber, cbNode->sequenceNumber);
1067                 goto exit;
1068             }
1069             if(response->clientResponse->sequenceNumber > cbNode->sequenceNumber){
1070                 cbNode->sequenceNumber = response->clientResponse->sequenceNumber;
1071             }
1072         }
1073
1074         response->clientResponse->resJSONPayload = bufRes;
1075
1076         cbResult = cbNode->callBack(cbNode->context, cbNode->handle, response->clientResponse);
1077
1078         if (cbResult == OC_STACK_DELETE_TRANSACTION ||
1079                 response->clientResponse->result == OC_STACK_COMM_ERROR ||
1080                 (response->clientResponse->result == OC_STACK_RESOURCE_DELETED &&
1081                         !isPresenceNotification && !isMulticastPresence))
1082         {
1083             FindAndDeleteClientCB(cbNode);
1084         }
1085     }
1086     else
1087     {
1088         result = OC_STACK_ERROR;
1089     }
1090
1091     exit:
1092     #ifdef WITH_PRESENCE
1093     OCFree(resourceTypeName);
1094     #endif
1095     return result;
1096 }
1097
1098 int ParseIPv4Address(unsigned char * ipAddrStr, uint8_t * ipAddr, uint16_t * port)
1099 {
1100     size_t index = 0;
1101     unsigned char *itr, *coap;
1102     uint8_t dotCount = 0;
1103
1104     ipAddr[index] = 0;
1105     *port = 0;
1106     /* search for scheme */
1107     itr = ipAddrStr;
1108     if (!isdigit((unsigned char) *ipAddrStr))
1109     {
1110         coap = (unsigned char *) OC_COAP_SCHEME;
1111         while (*coap && tolower(*itr) == *coap)
1112         {
1113             coap++;
1114             itr++;
1115         }
1116     }
1117     ipAddrStr = itr;
1118
1119     while (*ipAddrStr) {
1120         if (isdigit((unsigned char) *ipAddrStr))
1121         {
1122             ipAddr[index] *= 10;
1123             ipAddr[index] += *ipAddrStr - '0';
1124         }
1125         else if ((unsigned char) *ipAddrStr == '.')
1126         {
1127             index++;
1128             dotCount++;
1129             ipAddr[index] = 0;
1130         }
1131         else
1132         {
1133             break;
1134         }
1135         ipAddrStr++;
1136     }
1137     if(*ipAddrStr == ':')
1138     {
1139         ipAddrStr++;
1140         while (*ipAddrStr){
1141             if (isdigit((unsigned char) *ipAddrStr))
1142             {
1143                 *port *= 10;
1144                 *port += *ipAddrStr - '0';
1145             }
1146             else
1147             {
1148                 break;
1149             }
1150             ipAddrStr++;
1151         }
1152     }
1153
1154
1155     if (ipAddr[0] < 255 && ipAddr[1] < 255 && ipAddr[2] < 255 && ipAddr[3] < 255
1156             && dotCount == 3)
1157     {
1158         return 1;
1159     }
1160     else
1161     {
1162         return 0;
1163     }
1164 }
1165
1166 //-----------------------------------------------------------------------------
1167 // Private internal function prototypes
1168 //-----------------------------------------------------------------------------
1169
1170 static OCDoHandle GenerateInvocationHandle();
1171 static OCStackResult initResources();
1172 static void insertResource(OCResource *resource);
1173 static OCResource *findResource(OCResource *resource);
1174 static void insertResourceType(OCResource *resource,
1175         OCResourceType *resourceType);
1176 static OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle,
1177         uint8_t index);
1178 static void insertResourceInterface(OCResource *resource,
1179         OCResourceInterface *resourceInterface);
1180 static OCResourceInterface *findResourceInterfaceAtIndex(
1181         OCResourceHandle handle, uint8_t index);
1182 static void deleteResourceType(OCResourceType *resourceType);
1183 static void deleteResourceInterface(OCResourceInterface *resourceInterface);
1184 static void deleteResourceElements(OCResource *resource);
1185 static int deleteResource(OCResource *resource);
1186 static void deleteAllResources();
1187 static void incrementSequenceNumber(OCResource * resPtr);
1188 static OCStackResult verifyUriQueryLength(const char * inputUri,
1189         uint16_t uriLen);
1190 static uint8_t OCIsPacketTransferRequired(const char *request, const char *response, uint16_t size);
1191 OCStackResult getResourceType(const char * query, unsigned char** resourceType);
1192
1193 //-----------------------------------------------------------------------------
1194 // Public APIs
1195 //-----------------------------------------------------------------------------
1196
1197 /**
1198  * Initialize the OC Stack.  Must be called prior to starting the stack.
1199  *
1200  * @param ipAddr
1201  *     IP Address of host device
1202  * @param port
1203  *     Port of host device
1204  * @param mode
1205  *     Host device is client, server, or client-server
1206  *
1207  * @return
1208  *     OC_STACK_OK    - no errors
1209  *     OC_STACK_ERROR - stack init error
1210  */
1211 OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode)
1212 {
1213     OCStackResult result = OC_STACK_ERROR;
1214     OC_LOG(INFO, TAG, PCF("Entering OCInit"));
1215
1216     if (ipAddr)
1217     {
1218         OC_LOG_V(INFO, TAG, "IP Address = %s", ipAddr);
1219     }
1220
1221     OCSeedRandom();
1222 #ifdef CA_INT
1223     CAInitialize();
1224     //It is ok to select network to CA_WIFI for now
1225     CAResult_t caResult = CASelectNetwork(CA_WIFI|CA_ETHERNET);
1226     if(caResult == CA_STATUS_OK)
1227     {
1228         OC_LOG(INFO, TAG, PCF("CASelectNetwork to WIFI"));
1229         CARegisterHandler(HandleCARequests, HandleCAResponses);
1230         {
1231             OC_LOG(INFO, TAG, PCF("CARegisterHandler..."));
1232             stackState = OC_STACK_INITIALIZED;
1233             result = OC_STACK_OK;
1234             switch (mode)
1235             {
1236                 case OC_CLIENT:
1237                     caResult = CAStartDiscoveryServer();
1238                     OC_LOG(INFO, TAG, PCF("Client mode: CAStartDiscoveryServer"));
1239                     break;
1240                 case OC_SERVER:
1241                     caResult = CAStartListeningServer();
1242                     OC_LOG(INFO, TAG, PCF("Server mode: CAStartListeningServer"));
1243                     break;
1244                 case OC_CLIENT_SERVER:
1245                     caResult = CAStartListeningServer();
1246                     if(caResult == CA_STATUS_OK)
1247                     {
1248                         caResult = CAStartDiscoveryServer();
1249                     }
1250                     OC_LOG(INFO, TAG, PCF("Client-server mode"));
1251                     break;
1252                 default:
1253                     OC_LOG(ERROR, TAG, PCF("Invalid mode"));
1254                     return OC_STACK_ERROR;
1255                     break;
1256             }
1257
1258         }
1259         if (caResult == CA_STATUS_OK)
1260         {
1261             result = OC_STACK_OK;
1262         }
1263         else
1264         {
1265             result = OC_STACK_ERROR;
1266         }
1267     }
1268 #else
1269     switch (mode)
1270     {
1271     case OC_CLIENT:
1272         OC_LOG(INFO, TAG, PCF("Client mode"));
1273         break;
1274     case OC_SERVER:
1275         OC_LOG(INFO, TAG, PCF("Server mode"));
1276         break;
1277     case OC_CLIENT_SERVER:
1278         OC_LOG(INFO, TAG, PCF("Client-server mode"));
1279         break;
1280     default:
1281         OC_LOG(ERROR, TAG, PCF("Invalid mode"));
1282         return OC_STACK_ERROR;
1283         break;
1284     }
1285
1286     // Make call to OCCoAP layer
1287     result = OCInitCoAP(ipAddr, (uint16_t) port, myStackMode);
1288 #endif //CA_INT
1289
1290     myStackMode = mode;
1291     defaultDeviceHandler = NULL;
1292
1293 #ifdef WITH_PRESENCE
1294     PresenceTimeOutSize = sizeof(PresenceTimeOut)/sizeof(PresenceTimeOut[0]) - 1;
1295 #endif // WITH_PRESENCE
1296
1297     if (result == OC_STACK_OK)
1298     {
1299         stackState = OC_STACK_INITIALIZED;
1300     }
1301     // Initialize resource
1302     if(result == OC_STACK_OK && myStackMode != OC_CLIENT)
1303     {
1304         result = initResources();
1305     }
1306     if(result != OC_STACK_OK)
1307     {
1308         OC_LOG(ERROR, TAG, PCF("Stack initialization error"));
1309     }
1310     return result;
1311 }
1312
1313 /**
1314  * Stop the OC stack.  Use for a controlled shutdown.
1315  * @return
1316  *     OC_STACK_OK    - no errors
1317  *     OC_STACK_ERROR - stack not initialized
1318  */
1319 OCStackResult OCStop()
1320 {
1321     OCStackResult result = OC_STACK_ERROR;
1322
1323     OC_LOG(INFO, TAG, PCF("Entering OCStop"));
1324
1325     if (stackState == OC_STACK_UNINIT_IN_PROGRESS)
1326     {
1327         OC_LOG(DEBUG, TAG, PCF("Stack already stopping, exiting"));
1328         return OC_STACK_OK;
1329     }
1330     else if (stackState != OC_STACK_INITIALIZED)
1331     {
1332         OC_LOG(ERROR, TAG, PCF("Stack not initialized"));
1333         return OC_STACK_ERROR;
1334     }
1335
1336     stackState = OC_STACK_UNINIT_IN_PROGRESS;
1337
1338     #ifdef WITH_PRESENCE
1339     // Ensure that the TTL associated with ANY and ALL presence notifications originating from
1340     // here send with the code "OC_STACK_PRESENCE_STOPPED" result.
1341     presenceResource.presenceTTL = 0;
1342     #endif // WITH_PRESENCE
1343
1344     // Free memory dynamically allocated for resources
1345     deleteAllResources();
1346     DeleteDeviceInfo();
1347 #ifdef CA_INT
1348     CATerminate();
1349     //CATerminate does not return any error code. It is OK to assign result to OC_STACK_OK.
1350     result = OC_STACK_OK;
1351 #else //CA_INT
1352     result = OCStopCoAP();
1353 #endif //CA_INT
1354
1355     if (result == OC_STACK_OK)
1356     {
1357         // Remove all observers
1358         DeleteObserverList();
1359         // Remove all the client callbacks
1360         DeleteClientCBList();
1361         stackState = OC_STACK_UNINITIALIZED;
1362         result = OC_STACK_OK;
1363     } else {
1364         stackState = OC_STACK_INITIALIZED;
1365         result = OC_STACK_ERROR;
1366     }
1367
1368     // Deinit security blob
1369     DeinitOCSecurityInfo();
1370
1371     if (result != OC_STACK_OK) {
1372         OC_LOG(ERROR, TAG, PCF("Stack stop error"));
1373     }
1374
1375     return result;
1376 }
1377
1378 /**
1379  * Map OCQualityOfService to CAMessageType
1380  *
1381  * @param OCQualityOfService - Input qos.
1382  *
1383  * Returns CA message type for a given qos.
1384  */
1385 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos)
1386 {
1387     switch (qos)
1388     {
1389         case OC_HIGH_QOS:
1390             return CA_MSG_CONFIRM;
1391         case OC_LOW_QOS:
1392         case OC_MEDIUM_QOS:
1393         case OC_NA_QOS:
1394         default:
1395             return CA_MSG_NONCONFIRM;
1396     }
1397 }
1398
1399 /**
1400  * Verify the lengths of the URI and the query separately
1401  *
1402  * @param inputUri       - Input URI and query.
1403  * @param uriLen         - The length of the initial URI with query.
1404  *
1405  * Note: The '?' that appears after the URI is not considered as
1406  * a part of the query.
1407  */
1408 OCStackResult verifyUriQueryLength(const char *inputUri, uint16_t uriLen)
1409 {
1410     char *query;
1411
1412     query = strchr (inputUri, '?');
1413
1414     if (query != NULL)
1415     {
1416         if((query - inputUri) > MAX_URI_LENGTH)
1417         {
1418             return OC_STACK_INVALID_URI;
1419         }
1420
1421         if((inputUri + uriLen - 1 - query) > MAX_QUERY_LENGTH)
1422         {
1423             return OC_STACK_INVALID_QUERY;
1424         }
1425     }
1426     else if(uriLen > MAX_URI_LENGTH)
1427     {
1428         return OC_STACK_INVALID_URI;
1429     }
1430     return OC_STACK_OK;
1431 }
1432
1433 /**
1434  * Discover or Perform requests on a specified resource (specified by that Resource's respective URI).
1435  *
1436  * @param handle             - @ref OCDoHandle to refer to the request sent out on behalf of calling this API.
1437  * @param method             - @ref OCMethod to perform on the resource
1438  * @param requiredUri        - URI of the resource to interact with
1439  * @param referenceUri       - URI of the reference resource
1440  * @param request            - JSON encoded request
1441  * @param qos                - quality of service
1442  * @param cbData             - struct that contains asynchronous callback function that is invoked
1443  *                             by the stack when discovery or resource interaction is complete
1444  * @param options            - The address of an array containing the vendor specific header
1445  *                             header options to be sent with the request
1446  * @param numOptions         - Number of vendor specific header options to be included
1447  *
1448  * @return
1449  *     OC_STACK_OK               - no errors
1450  *     OC_STACK_INVALID_CALLBACK - invalid callback function pointer
1451  *     OC_STACK_INVALID_METHOD   - invalid resource method
1452  *     OC_STACK_INVALID_URI      - invalid required or reference URI
1453  *
1454  * Note: IN case of CA, when using multicast, the required URI should not contain IP address.
1455  *       Instead, it just contains the URI to the resource such as "/oc/core".
1456  */
1457 #ifdef CA_INT
1458 OCStackResult OCDoResource(OCDoHandle *handle, OCMethod method, const char *requiredUri,
1459                            const char *referenceUri, const char *request, uint8_t conType,
1460                            OCQualityOfService qos, OCCallbackData *cbData,
1461                            OCHeaderOption * options, uint8_t numOptions)
1462 #else
1463 OCStackResult OCDoResource(OCDoHandle *handle, OCMethod method, const char *requiredUri,
1464                            const char *referenceUri, const char *request,
1465                            OCQualityOfService qos, OCCallbackData *cbData,
1466                            OCHeaderOption * options, uint8_t numOptions)
1467 #endif
1468 {
1469     OCStackResult result = OC_STACK_ERROR;
1470     OCCoAPToken token;
1471     ClientCB *clientCB = NULL;
1472     unsigned char * requestUri = NULL;
1473     unsigned char * resourceType = NULL;
1474     unsigned char * query = NULL;
1475     char * newUri = (char *)requiredUri;
1476     (void) referenceUri;
1477 #ifdef CA_INT
1478     CARemoteEndpoint_t* endpoint = NULL;
1479     CAResult_t caResult;
1480     CAToken_t caToken = NULL;
1481     CAInfo_t requestData;
1482     CARequestInfo_t requestInfo;
1483     CAGroupEndpoint_t grpEnd;
1484
1485     // To track if memory is allocated for additional header options
1486     uint8_t hdrOptionMemAlloc = 0;
1487 #endif // CA_INT
1488
1489     OC_LOG(INFO, TAG, PCF("Entering OCDoResource"));
1490
1491     // Validate input parameters
1492     VERIFY_NON_NULL(cbData, FATAL, OC_STACK_INVALID_CALLBACK);
1493     VERIFY_NON_NULL(cbData->cb, FATAL, OC_STACK_INVALID_CALLBACK);
1494
1495     TODO ("Need to form the final query by concatenating require and reference URI's");
1496     VERIFY_NON_NULL(requiredUri, FATAL, OC_STACK_INVALID_URI);
1497
1498     uint16_t uriLen = strlen(requiredUri);
1499
1500     // ToDo: We should also check if the requiredUri has a mutlicast address, then qos has to be OC_Low_QOS
1501     switch (method)
1502     {
1503         case OC_REST_GET:
1504         case OC_REST_PUT:
1505         case OC_REST_POST:
1506         case OC_REST_DELETE:
1507         case OC_REST_OBSERVE:
1508         case OC_REST_OBSERVE_ALL:
1509         case OC_REST_CANCEL_OBSERVE:
1510             break;
1511         #ifdef WITH_PRESENCE
1512         case OC_REST_PRESENCE:
1513             break;
1514         #endif
1515         default:
1516             result = OC_STACK_INVALID_METHOD;
1517             goto exit;
1518     }
1519
1520     if((result = verifyUriQueryLength(requiredUri, uriLen)) != OC_STACK_OK)
1521     {
1522         goto exit;
1523     }
1524
1525     if((request) && (strlen(request) > MAX_REQUEST_LENGTH))
1526     {
1527         result = OC_STACK_INVALID_PARAM;
1528         goto exit;
1529     }
1530
1531 #ifdef WITH_PRESENCE
1532     if(method == OC_REST_PRESENCE)
1533     {
1534         result = getQueryFromUri(requiredUri, &query, &newUri);
1535         if(query)
1536         {
1537             result = getResourceType((char *) query, &resourceType);
1538             if(resourceType)
1539             {
1540                 OC_LOG_V(DEBUG, TAG, "Got Resource Type: %s", resourceType);
1541             }
1542             else
1543             {
1544                 OC_LOG(DEBUG, TAG, PCF("Resource type is NULL."));
1545             }
1546         }
1547         else
1548         {
1549             OC_LOG(DEBUG, TAG, PCF("Query string is NULL."));
1550         }
1551         if(result != OC_STACK_OK)
1552         {
1553             goto exit;
1554         }
1555     }
1556 #endif // WITH_PRESENCE
1557
1558     requestUri = (unsigned char *) OCMalloc(uriLen + 1);
1559     if(requestUri)
1560     {
1561         memcpy(requestUri, newUri, (uriLen + 1));
1562     }
1563     else
1564     {
1565         result = OC_STACK_NO_MEMORY;
1566         goto exit;
1567     }
1568
1569     *handle = GenerateInvocationHandle();
1570     if(!*handle)
1571     {
1572         result = OC_STACK_NO_MEMORY;
1573         goto exit;
1574     }
1575
1576 #ifdef CA_INT
1577     memset(&requestData, 0, sizeof(CAInfo_t));
1578     memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1579     memset(&grpEnd, 0, sizeof(CAGroupEndpoint_t));
1580     switch (method)
1581     {
1582         case OC_REST_GET:
1583         case OC_REST_OBSERVE:
1584         case OC_REST_OBSERVE_ALL:
1585         case OC_REST_CANCEL_OBSERVE:
1586             {
1587                 requestInfo.method = CA_GET;
1588                 break;
1589             }
1590         case OC_REST_PUT:
1591             {
1592                 requestInfo.method = CA_PUT;
1593                 break;
1594             }
1595         case OC_REST_POST:
1596             {
1597                 requestInfo.method = CA_POST;
1598                 break;
1599             }
1600         case OC_REST_DELETE:
1601             {
1602                 requestInfo.method = CA_DELETE;
1603                 break;
1604             }
1605         #ifdef WITH_PRESENCE
1606         case OC_REST_PRESENCE:
1607             {
1608                 // Replacing method type with GET because "presence"
1609                 // is a stack layer only implementation.
1610                 requestInfo.method = CA_GET;
1611                 break;
1612             }
1613         #endif
1614         default:
1615             result = OC_STACK_INVALID_METHOD;
1616             goto exit;
1617     }
1618
1619     //High QoS is not supported
1620     if(qos == OC_HIGH_QOS)
1621     {
1622         result = OC_STACK_INVALID_PARAM;
1623         goto exit;
1624     }
1625
1626     // create token
1627     caResult = CAGenerateToken(&caToken);
1628
1629     if (caResult != CA_STATUS_OK)
1630     {
1631         OC_LOG(ERROR, TAG, PCF("CAGenerateToken error"));
1632         caToken = NULL;
1633         goto exit;
1634     }
1635
1636     requestData.type = qualityOfServiceToMessageType(qos);
1637     requestData.token = caToken;
1638     if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
1639     {
1640         result = CreateObserveHeaderOption (&(requestData.options), options,
1641                                     numOptions, OC_OBSERVE_REGISTER);
1642         if (result != OC_STACK_OK)
1643         {
1644             goto exit;
1645         }
1646         hdrOptionMemAlloc = 1;
1647         requestData.numOptions = numOptions + 1;
1648     }
1649     else
1650     {
1651         requestData.options = (CAHeaderOption_t*)options;
1652         requestData.numOptions = numOptions;
1653     }
1654     requestData.payload = (char *)request;
1655
1656     requestInfo.info = requestData;
1657
1658     CAConnectivityType_t caConType;
1659
1660     result = OCToCAConnectivityType(conType, &caConType);
1661     if (result != OC_STACK_OK)
1662     {
1663         OC_LOG(ERROR, TAG, PCF("Invalid Connectivity Type"));
1664         goto exit;
1665     }
1666
1667     // send request
1668     if(conType == OC_ALL)
1669     {
1670         grpEnd.connectivityType = caConType;
1671
1672         grpEnd.resourceUri = (CAURI_t) OCMalloc(uriLen + 1);
1673         strncpy(grpEnd.resourceUri, requiredUri, (uriLen + 1));
1674
1675         caResult = CASendRequestToAll(&grpEnd, &requestInfo);
1676     }
1677     else
1678     {
1679         caResult = CACreateRemoteEndpoint(newUri, caConType, &endpoint);
1680
1681         if (caResult != CA_STATUS_OK)
1682         {
1683             OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1684             goto exit;
1685         }
1686
1687         caResult = CASendRequest(endpoint, &requestInfo);
1688     }
1689
1690     if (caResult != CA_STATUS_OK)
1691     {
1692         OC_LOG(ERROR, TAG, PCF("CASendRequest"));
1693         goto exit;
1694     }
1695
1696     if((result = AddClientCB(&clientCB, cbData, &caToken, handle, method,
1697                              requestUri, resourceType)) != OC_STACK_OK)
1698     {
1699         result = OC_STACK_NO_MEMORY;
1700         goto exit;
1701     }
1702
1703 #else // CA_INT
1704
1705     // Generate token which will be used by OCStack to match responses received
1706     // with the request
1707     OCGenerateCoAPToken(&token);
1708
1709     if((result = AddClientCB(&clientCB, cbData, &token, handle, method, requestUri, resourceType))
1710             != OC_STACK_OK)
1711     {
1712         result = OC_STACK_NO_MEMORY;
1713         goto exit;
1714     }
1715
1716     // Make call to OCCoAP layer
1717     result = OCDoCoAPResource(method, qos, &token, newUri, request, options, numOptions);
1718 #endif // CA_INT
1719
1720 exit:
1721     if(newUri != requiredUri)
1722     {
1723         OCFree(newUri);
1724     }
1725     if (result != OC_STACK_OK)
1726     {
1727         OC_LOG(ERROR, TAG, PCF("OCDoResource error"));
1728         FindAndDeleteClientCB(clientCB);
1729     }
1730 #ifdef CA_INT
1731     CADestroyRemoteEndpoint(endpoint);
1732     OCFree(grpEnd.resourceUri);
1733     if (hdrOptionMemAlloc)
1734     {
1735         OCFree(requestData.options);
1736     }
1737 #endif // CA_INT
1738     return result;
1739 }
1740
1741 /**
1742  * Cancel a request associated with a specific @ref OCDoResource invocation.
1743  *
1744  * @param handle - Used to identify a specific OCDoResource invocation.
1745  * @param qos    - used to specify Quality of Service (read below for more info)
1746  * @param options- used to specify vendor specific header options when sending
1747  *                 explicit observe cancellation
1748  * @param numOptions- Number of header options to be included
1749  *
1750  * @return
1751  *     OC_STACK_OK               - No errors; Success
1752  *     OC_STACK_INVALID_PARAM    - The handle provided is invalid.
1753  */
1754 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
1755         uint8_t numOptions)
1756 {
1757     /*
1758      * This ftn is implemented one of two ways in the case of observation:
1759      *
1760      * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
1761      *      Remove the callback associated on client side.
1762      *      When the next notification comes in from server,
1763      *      reply with RESET message to server.
1764      *      Keep in mind that the server will react to RESET only
1765      *      if the last notification was sent ans CON
1766      *
1767      * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
1768      *      and it is associated with an observe request
1769      *      (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
1770      *      Send CON Observe request to server with
1771      *      observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
1772      *      Remove the callback associated on client side.
1773      */
1774     OCStackResult ret = OC_STACK_OK;
1775 #ifdef CA_INT
1776     CARemoteEndpoint_t* endpoint = NULL;
1777     CAResult_t caResult;
1778     CAInfo_t requestData;
1779     CARequestInfo_t requestInfo;
1780     // Track if memory is allocated for additional header options
1781     uint8_t hdrOptionMemAlloc = 0;
1782 #endif // CA_INT
1783
1784     if(!handle) {
1785         return OC_STACK_INVALID_PARAM;
1786     }
1787
1788     OC_LOG(INFO, TAG, PCF("Entering OCCancel"));
1789
1790     ClientCB *clientCB = GetClientCB(NULL, handle, NULL);
1791
1792     if(clientCB) {
1793         switch (clientCB->method)
1794         {
1795             case OC_REST_OBSERVE:
1796             case OC_REST_OBSERVE_ALL:
1797                 #ifdef CA_INT
1798                 //TODO-CA : Why CA_WIFI alone?
1799                 caResult = CACreateRemoteEndpoint((char *)clientCB->requestUri, CA_WIFI,
1800                                                   &endpoint);
1801                 if (caResult != CA_STATUS_OK)
1802                 {
1803                     OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1804                     return OC_STACK_ERROR;
1805                 }
1806
1807                 memset(&requestData, 0, sizeof(CAInfo_t));
1808                 requestData.type =  qualityOfServiceToMessageType(qos);
1809                 requestData.token = clientCB->token;
1810                 if (CreateObserveHeaderOption (&(requestData.options),
1811                             options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
1812                 {
1813                     return OC_STACK_ERROR;
1814                 }
1815                 hdrOptionMemAlloc = 1;
1816                 requestData.numOptions = numOptions + 1;
1817                 memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1818                 requestInfo.method = CA_GET;
1819                 requestInfo.info = requestData;
1820                 // send request
1821                 caResult = CASendRequest(endpoint, &requestInfo);
1822                 if (caResult != CA_STATUS_OK)
1823                 {
1824                     OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
1825                 }
1826                 if(caResult == CA_STATUS_OK)
1827                 {
1828                     ret = OC_STACK_OK;
1829                 }
1830                 #else // CA_INT
1831                 if(qos == OC_HIGH_QOS)
1832                 {
1833                     ret = OCDoCoAPResource(OC_REST_CANCEL_OBSERVE, qos,
1834                             &(clientCB->token), (const char *) clientCB->requestUri, NULL, options,
1835                             numOptions);
1836                 }
1837                 else
1838                 {
1839                     FindAndDeleteClientCB(clientCB);
1840                 }
1841                 break;
1842                 #endif // CA_INT
1843             #ifdef WITH_PRESENCE
1844             case OC_REST_PRESENCE:
1845                 FindAndDeleteClientCB(clientCB);
1846                 break;
1847             #endif
1848             default:
1849                 return OC_STACK_INVALID_METHOD;
1850         }
1851     }
1852 #ifdef CA_INT
1853     CADestroyRemoteEndpoint(endpoint);
1854     if (hdrOptionMemAlloc)
1855     {
1856         OCFree(requestData.options);
1857     }
1858 #endif // CA_INT
1859
1860     return ret;
1861 }
1862
1863 #ifdef WITH_PRESENCE
1864 #ifdef CA_INT
1865 OCStackResult OCProcessPresence()
1866 {
1867     OCStackResult result = OC_STACK_OK;
1868     uint8_t ipAddr[4] = { 0 };
1869     uint16_t port = 0;
1870
1871     OC_LOG(INFO, TAG, PCF("Entering RequestPresence"));
1872     ClientCB* cbNode = NULL;
1873     OCDevAddr dst;
1874     OCClientResponse clientResponse;
1875     OCResponse * response = NULL;
1876     OCStackApplicationResult cbResult = OC_STACK_DELETE_TRANSACTION;
1877
1878     LL_FOREACH(cbList, cbNode) {
1879         if(OC_REST_PRESENCE == cbNode->method)
1880         {
1881             if(cbNode->presence)
1882             {
1883                 uint32_t now = GetTime(0);
1884                 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d",
1885                                                         cbNode->presence->TTLlevel);
1886                 OC_LOG_V(DEBUG, TAG, "----------------current ticks %d", now);
1887
1888
1889                 if(cbNode->presence->TTLlevel >= (PresenceTimeOutSize + 1))
1890                 {
1891                     goto exit;
1892                 }
1893
1894                 if(cbNode->presence->TTLlevel < PresenceTimeOutSize){
1895                     OC_LOG_V(DEBUG, TAG, "----------------timeout ticks %d",
1896                             cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
1897                 }
1898
1899                 if(cbNode->presence->TTLlevel >= PresenceTimeOutSize)
1900                 {
1901                     OC_LOG(DEBUG, TAG, PCF("----------------No more timeout ticks"));
1902                     if (ParseIPv4Address( cbNode->requestUri, ipAddr, &port))
1903                     {
1904                         OCBuildIPv4Address(ipAddr[0], ipAddr[1], ipAddr[2], ipAddr[3], port,
1905                                 &dst);
1906                         result = FormOCClientResponse(&clientResponse, OC_STACK_PRESENCE_TIMEOUT,
1907                                 (OCDevAddr *) &dst, 0, NULL);
1908                         if(result != OC_STACK_OK)
1909                         {
1910                             goto exit;
1911                         }
1912                         result = FormOCResponse(&response, cbNode, 0, NULL, NULL,
1913                                 &cbNode->token, &clientResponse, NULL);
1914                         if(result != OC_STACK_OK)
1915                         {
1916                             goto exit;
1917                         }
1918
1919                         // Increment the TTLLevel (going to a next state), so we don't keep
1920                         // sending presence notification to client.
1921                         cbNode->presence->TTLlevel++;
1922                         OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
1923                                                 cbNode->presence->TTLlevel);
1924                     }
1925                     else
1926                     {
1927                         result = OC_STACK_INVALID_IP;
1928                         goto exit;
1929                     }
1930
1931                     cbResult = cbNode->callBack(cbNode->context, cbNode->handle, &clientResponse);
1932                     if (cbResult == OC_STACK_DELETE_TRANSACTION)
1933                     {
1934                         FindAndDeleteClientCB(cbNode);
1935                     }
1936                 }
1937
1938                 if(now >= cbNode->presence->timeOut[cbNode->presence->TTLlevel])
1939                 {
1940                     CAResult_t caResult;
1941                     CARemoteEndpoint_t* endpoint = NULL;
1942                     CAInfo_t requestData;
1943                     CARequestInfo_t requestInfo;
1944
1945                     OC_LOG(DEBUG, TAG, PCF("time to test server presence =========="));
1946
1947                     //TODO-CA : Why CA_WIFI alone?
1948                     caResult = CACreateRemoteEndpoint((char *)cbNode->requestUri, CA_WIFI,
1949                                                   &endpoint);
1950
1951                     if (caResult != CA_STATUS_OK)
1952                     {
1953                         OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1954                         goto exit;
1955                     }
1956
1957                     memset(&requestData, 0, sizeof(CAInfo_t));
1958                     requestData.type = CA_MSG_NONCONFIRM;
1959                     requestData.token = cbNode->token;
1960
1961                     memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1962                     requestInfo.method = CA_GET;
1963                     requestInfo.info = requestData;
1964
1965                     caResult = CASendRequest(endpoint, &requestInfo);
1966
1967                     if (caResult != CA_STATUS_OK)
1968                     {
1969                         OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
1970                         goto exit;
1971                     }
1972
1973                     cbNode->presence->TTLlevel++;
1974                     OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
1975                                                             cbNode->presence->TTLlevel);
1976                 }
1977             }
1978         }
1979     }
1980 exit:
1981     if (result != OC_STACK_OK)
1982     {
1983         OC_LOG(ERROR, TAG, PCF("OCProcessPresence error"));
1984     }
1985     return result;
1986 }
1987 #else
1988 OCStackResult OCProcessPresence()
1989 {
1990     OCStackResult result = OC_STACK_OK;
1991     uint8_t ipAddr[4] = { 0 };
1992     uint16_t port = 0;
1993
1994     ClientCB* cbNode = NULL;
1995     OCDevAddr dst;
1996     OCClientResponse clientResponse;
1997     OCResponse * response = NULL;
1998
1999     LL_FOREACH(cbList, cbNode) {
2000         if(OC_REST_PRESENCE == cbNode->method)
2001         {
2002             if(cbNode->presence)
2003             {
2004                 uint32_t now = GetTime(0);
2005                 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
2006                 OC_LOG_V(DEBUG, TAG, "----------------current ticks %d", now);
2007
2008
2009                 if(cbNode->presence->TTLlevel >= (PresenceTimeOutSize + 1))
2010                 {
2011                     goto exit;
2012                 }
2013
2014                 if(cbNode->presence->TTLlevel < PresenceTimeOutSize){
2015                     OC_LOG_V(DEBUG, TAG, "----------------timeout ticks %d",
2016                             cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
2017                 }
2018
2019                 if(cbNode->presence->TTLlevel >= PresenceTimeOutSize)
2020                 {
2021                     OC_LOG(DEBUG, TAG, PCF("----------------No more timeout ticks"));
2022                     if (ParseIPv4Address( cbNode->requestUri, ipAddr, &port))
2023                     {
2024                         OCBuildIPv4Address(ipAddr[0], ipAddr[1], ipAddr[2], ipAddr[3], port,
2025                                 &dst);
2026                         result = FormOCClientResponse(&clientResponse, OC_STACK_PRESENCE_TIMEOUT,
2027                                 (OCDevAddr *) &dst, 0, NULL);
2028                         if(result != OC_STACK_OK)
2029                         {
2030                             goto exit;
2031                         }
2032                         result = FormOCResponse(&response, cbNode, 0, NULL, NULL,
2033                                 &cbNode->token, &clientResponse, NULL);
2034                         if(result != OC_STACK_OK)
2035                         {
2036                             goto exit;
2037                         }
2038
2039                         // Increment the TTLLevel (going to a next state), so we don't keep
2040                         // sending presence notification to client.
2041                         cbNode->presence->TTLlevel++;
2042                         OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
2043                                                 cbNode->presence->TTLlevel);
2044                     }
2045                     else
2046                     {
2047                         result = OC_STACK_INVALID_IP;
2048                         goto exit;
2049                     }
2050                     HandleStackResponses(response);
2051                 }
2052                 if(now >= cbNode->presence->timeOut[cbNode->presence->TTLlevel])
2053                 {
2054                     OC_LOG(DEBUG, TAG, PCF("time to test server presence =========="));
2055
2056                     OCCoAPToken token;
2057                     OCGenerateCoAPToken(&token);
2058                     result = OCDoCoAPResource(OC_REST_GET, OC_LOW_QOS,
2059                             &token, (const char *)cbNode->requestUri, NULL, NULL, 0);
2060
2061                     if(result != OC_STACK_OK)
2062                     {
2063                         goto exit;
2064                     }
2065                     cbNode->presence->TTLlevel++;
2066                     OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d", cbNode->presence->TTLlevel);
2067                 }
2068             }
2069         }
2070     }
2071 exit:
2072     if (result != OC_STACK_OK)
2073     {
2074         OC_LOG(ERROR, TAG, PCF("OCProcessPresence error"));
2075     }
2076     return result;
2077 }
2078 #endif // CA_INT
2079 #endif // WITH_PRESENCE
2080
2081 /**
2082  * Called in main loop of OC client or server.  Allows low-level processing of
2083  * stack services.
2084  *
2085  * @return
2086  *     OC_STACK_OK    - no errors
2087  *     OC_STACK_ERROR - stack process error
2088  */
2089 OCStackResult OCProcess()
2090 {
2091     #ifdef WITH_PRESENCE
2092     OCProcessPresence();
2093     #endif
2094 #ifdef CA_INT
2095     CAHandleRequestResponse();
2096 #else
2097     OCProcessCoAP();
2098 #endif // CA_INT
2099
2100     return OC_STACK_OK;
2101 }
2102
2103 #ifdef WITH_PRESENCE
2104 /**
2105  * When operating in @ref OCServer or @ref OCClientServer mode, this API will start sending out
2106  * presence notifications to clients via multicast. Once this API has been called with a success,
2107  * clients may query for this server's presence and this server's stack will respond via multicast.
2108  *
2109  * Server can call this function when it comes online for the first time, or when it comes back
2110  * online from offline mode, or when it re enters network.
2111  *
2112  * @param ttl - Time To Live in seconds
2113  * Note: If ttl is '0', then the default stack value will be used (60 Seconds).
2114  *
2115  * @return
2116  *     OC_STACK_OK      - No errors; Success
2117  */
2118 OCStackResult OCStartPresence(const uint32_t ttl)
2119 {
2120     OCChangeResourceProperty(
2121             &(((OCResource *)presenceResource.handle)->resourceProperties),
2122             OC_ACTIVE, 1);
2123
2124     if(ttl > 0)
2125     {
2126         presenceResource.presenceTTL = ttl;
2127     }
2128
2129     if(OC_PRESENCE_UNINITIALIZED == presenceState)
2130     {
2131         OCDevAddr multiCastAddr;
2132         OCCoAPToken token;
2133
2134         presenceState = OC_PRESENCE_INITIALIZED;
2135         OCGenerateCoAPToken(&token);
2136         OCBuildIPv4Address(224, 0, 1, 187, 5683, &multiCastAddr);
2137 #ifdef CA_INT
2138         CAAddress_t addressInfo;
2139         strncpy(addressInfo.IP.ipAddress, "224.0.1.187", CA_IPADDR_SIZE);
2140         addressInfo.IP.port = 5683;
2141
2142         CAToken_t caToken = NULL;
2143        CAGenerateToken(&caToken);
2144
2145         AddCAObserver(OC_PRESENCE_URI, NULL, 0, &token,
2146                 &multiCastAddr, (OCResource *)presenceResource.handle, OC_LOW_QOS,
2147                 &addressInfo, CA_WIFI, caToken);
2148 #else
2149         //add the presence observer
2150         AddObserver(OC_PRESENCE_URI, NULL, 0, &token, &multiCastAddr,
2151             (OCResource *)presenceResource.handle, OC_LOW_QOS);
2152 #endif
2153     }
2154
2155     // Each time OCStartPresence is called
2156     // a different random 32-bit integer number is used
2157     ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2158
2159     return SendPresenceNotification(NULL);
2160 }
2161
2162 /**
2163  * When operating in @ref OCServer or @ref OCClientServer mode, this API will stop sending out
2164  * presence notifications to clients via multicast. Once this API has been called with a success,
2165  * this server's stack will not respond to clients querying for this server's presence.
2166  *
2167  * Server can call this function when it is terminating, going offline, or when going
2168  * away from network.
2169  *
2170  * @return
2171  *     OC_STACK_OK      - No errors; Success
2172  */
2173 OCStackResult OCStopPresence()
2174 {
2175     OCStackResult result = OC_STACK_ERROR;
2176     //make resource inactive
2177     result = OCChangeResourceProperty(
2178             &(((OCResource *) presenceResource.handle)->resourceProperties),
2179             OC_ACTIVE, 0);
2180     result = SendPresenceNotification(NULL);
2181
2182     return result;
2183 }
2184 #endif
2185
2186
2187 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler)
2188 {
2189     defaultDeviceHandler = entityHandler;
2190
2191     return OC_STACK_OK;
2192 }
2193
2194 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
2195 {
2196     OC_LOG(INFO, TAG, PCF("Entering OCSetDeviceInfo"));
2197
2198     if(myStackMode == OC_CLIENT)
2199     {
2200         return OC_STACK_ERROR;
2201     }
2202
2203     return SaveDeviceInfo(deviceInfo);
2204 }
2205
2206 /**
2207  * Create a resource
2208  *
2209  * @param handle - pointer to handle to newly created resource.  Set by ocstack.  Used to refer to resource
2210  * @param resourceTypeName - name of resource type.  Example: "core.led"
2211  * @param resourceInterfaceName - name of resource interface.  Example: "core.rw"
2212  * @param uri - URI of the resource.  Example:  "/a/led"
2213  * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2214  *                        NULL for default entity handler
2215  * @param resourceProperties - properties supported by resource.  Example: OC_DISCOVERABLE|OC_OBSERVABLE
2216  *
2217  * @return
2218  *     OC_STACK_OK    - no errors
2219  *     OC_STACK_ERROR - stack process error
2220  */
2221 OCStackResult OCCreateResource(OCResourceHandle *handle,
2222         const char *resourceTypeName,
2223         const char *resourceInterfaceName,
2224         const char *uri, OCEntityHandler entityHandler,
2225         uint8_t resourceProperties) {
2226
2227     OCResource *pointer = NULL;
2228     char *str = NULL;
2229     size_t size;
2230     OCStackResult result = OC_STACK_ERROR;
2231
2232     OC_LOG(INFO, TAG, PCF("Entering OCCreateResource"));
2233
2234     if(myStackMode == OC_CLIENT)
2235     {
2236         return result;
2237     }
2238     // Validate parameters
2239     if(!uri || (strlen(uri) == 0))
2240     {
2241         OC_LOG(ERROR, TAG, PCF("URI is invalid"));
2242         return OC_STACK_INVALID_URI;
2243     }
2244     // Is it presented during resource discovery?
2245     if (!handle || !resourceTypeName) {
2246         OC_LOG(ERROR, TAG, PCF("Input parameter is NULL"));
2247         return OC_STACK_INVALID_PARAM;
2248     }
2249
2250     if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0) {
2251         resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
2252     }
2253
2254     // Make sure resourceProperties bitmask has allowed properties specified
2255     if (resourceProperties
2256             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE)) {
2257         OC_LOG(ERROR, TAG, PCF("Invalid property"));
2258         return OC_STACK_INVALID_PARAM;
2259     }
2260
2261     // If the headResource is NULL, then no resources have been created...
2262     pointer = headResource;
2263     if (pointer) {
2264         // At least one resources is in the resource list, so we need to search for
2265         // repeated URLs, which are not allowed.  If a repeat is found, exit with an error
2266         while (pointer) {
2267             if (strcmp(uri, pointer->uri) == 0) {
2268                 OC_LOG(ERROR, TAG, PCF("URI already in use"));
2269                 return OC_STACK_INVALID_PARAM;
2270             }
2271             pointer = pointer->next;
2272         }
2273     }
2274     // Create the pointer and insert it into the resource list
2275     pointer = (OCResource *) OCCalloc(1, sizeof(OCResource));
2276     if (!pointer) {
2277         goto exit;
2278     }
2279     pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
2280
2281     insertResource(pointer);
2282
2283     // Set the uri
2284     size = strlen(uri) + 1;
2285     str = (char *) OCMalloc(size);
2286     if (!str) {
2287         goto exit;
2288     }
2289     strncpy(str, uri, size);
2290     pointer->uri = str;
2291
2292     // Set properties.  Set OC_ACTIVE
2293     pointer->resourceProperties = (OCResourceProperty) (resourceProperties
2294             | OC_ACTIVE);
2295
2296     // Add the resourcetype to the resource
2297     result = BindResourceTypeToResource(pointer, resourceTypeName);
2298     if (result != OC_STACK_OK) {
2299         OC_LOG(ERROR, TAG, PCF("Error adding resourcetype"));
2300         goto exit;
2301     }
2302
2303     // Add the resourceinterface to the resource
2304     result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
2305     if (result != OC_STACK_OK) {
2306         OC_LOG(ERROR, TAG, PCF("Error adding resourceinterface"));
2307         goto exit;
2308     }
2309
2310     // If an entity handler has been passed, attach it to the newly created
2311     // resource.  Otherwise, set the default entity handler.
2312     if (entityHandler)
2313     {
2314         pointer->entityHandler = entityHandler;
2315     }
2316     else
2317     {
2318         pointer->entityHandler = defaultResourceEHandler;
2319     }
2320
2321     *handle = pointer;
2322     result = OC_STACK_OK;
2323
2324     #ifdef WITH_PRESENCE
2325     if(presenceResource.handle)
2326     {
2327         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2328         SendPresenceNotification(pointer->rsrcType);
2329     }
2330     #endif
2331 exit:
2332     if (result != OC_STACK_OK)
2333     {
2334         // Deep delete of resource and other dynamic elements that it contains
2335         deleteResource(pointer);
2336         OCFree(str);
2337     }
2338     return result;
2339 }
2340
2341
2342
2343 /**
2344  * Create a resource. with host ip address for remote resource
2345  *
2346  * @param handle - pointer to handle to newly created resource.  Set by ocstack.
2347  *                 Used to refer to resource
2348  * @param resourceTypeName - name of resource type.  Example: "core.led"
2349  * @param resourceInterfaceName - name of resource interface.  Example: "core.rw"
2350  * @param host - HOST address of the remote resource.  Example:  "coap://xxx.xxx.xxx.xxx:xxxxx"
2351  * @param uri - URI of the resource.  Example:  "/a/led"
2352  * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2353  *                        NULL for default entity handler
2354  * @param resourceProperties - properties supported by resource.
2355  *                             Example: OC_DISCOVERABLE|OC_OBSERVABLE
2356  *
2357  * @return
2358  *     OC_STACK_OK    - no errors
2359  *     OC_STACK_ERROR - stack process error
2360  */
2361
2362 OCStackResult OCCreateResourceWithHost(OCResourceHandle *handle,
2363         const char *resourceTypeName,
2364         const char *resourceInterfaceName,
2365         const char *host,
2366         const char *uri,
2367         OCEntityHandler entityHandler,
2368         uint8_t resourceProperties)
2369 {
2370     char *str = NULL;
2371     size_t size;
2372     OCStackResult result = OC_STACK_ERROR;
2373
2374     result = OCCreateResource(handle, resourceTypeName, resourceInterfaceName,
2375                                 uri, entityHandler, resourceProperties);
2376
2377     if (result != OC_STACK_ERROR)
2378     {
2379         // Set the uri
2380         size = strlen(host) + 1;
2381         str = (char *) OCMalloc(size);
2382         if (!str)
2383         {
2384             return OC_STACK_ERROR;
2385         }
2386         strncpy(str, host, size);
2387         ((OCResource *) *handle)->host = str;
2388     }
2389
2390     return result;
2391 }
2392
2393 /**
2394  * Add a resource to a collection resource.
2395  *
2396  * @param collectionHandle - handle to the collection resource
2397  * @param resourceHandle - handle to resource to be added to the collection resource
2398  *
2399  * @return
2400  *     OC_STACK_OK    - no errors
2401  *     OC_STACK_ERROR - stack process error
2402  *     OC_STACK_INVALID_PARAM - invalid collectionhandle
2403  */
2404 OCStackResult OCBindResource(
2405         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle) {
2406     OCResource *resource;
2407     uint8_t i;
2408
2409     OC_LOG(INFO, TAG, PCF("Entering OCBindResource"));
2410
2411     // Validate parameters
2412     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
2413     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
2414     // Container cannot contain itself
2415     if (collectionHandle == resourceHandle) {
2416         OC_LOG(ERROR, TAG, PCF("Added handle equals collection handle"));
2417         return OC_STACK_INVALID_PARAM;
2418     }
2419
2420     // Use the handle to find the resource in the resource linked list
2421     resource = findResource((OCResource *) collectionHandle);
2422     if (!resource) {
2423         OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
2424         return OC_STACK_INVALID_PARAM;
2425     }
2426
2427     // Look for an open slot to add add the child resource.
2428     // If found, add it and return success
2429     for (i = 0; i < MAX_CONTAINED_RESOURCES; i++) {
2430         if (!resource->rsrcResources[i]) {
2431             resource->rsrcResources[i] = (OCResource *) resourceHandle;
2432             OC_LOG(INFO, TAG, PCF("resource bound"));
2433             return OC_STACK_OK;
2434         }
2435     }
2436
2437     #ifdef WITH_PRESENCE
2438     if(presenceResource.handle)
2439     {
2440         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2441         SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType);
2442     }
2443     #endif
2444
2445     // Unable to add resourceHandle, so return error
2446     return OC_STACK_ERROR;
2447 }
2448
2449 /**
2450  * Remove a resource from a collection resource.
2451  *
2452  * @param collectionHandle - handle to the collection resource
2453  * @param resourceHandle - handle to resource to be added to the collection resource
2454  *
2455  * @return
2456  *     OC_STACK_OK    - no errors
2457  *     OC_STACK_ERROR - stack process error
2458  *     OC_STACK_INVALID_PARAM - invalid collectionHandle
2459  */
2460 OCStackResult OCUnBindResource(
2461         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle) {
2462     OCResource *resource;
2463     uint8_t i;
2464
2465     OC_LOG(INFO, TAG, PCF("Entering OCUnBindResource"));
2466
2467     // Validate parameters
2468     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
2469     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
2470     // Container cannot contain itself
2471     if (collectionHandle == resourceHandle) {
2472         OC_LOG(ERROR, TAG, PCF("removing handle equals collection handle"));
2473         return OC_STACK_INVALID_PARAM;
2474     }
2475
2476     // Use the handle to find the resource in the resource linked list
2477     resource = findResource((OCResource *) collectionHandle);
2478     if (!resource) {
2479         OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
2480         return OC_STACK_INVALID_PARAM;
2481     }
2482
2483     // Look for an open slot to add add the child resource.
2484     // If found, add it and return success
2485     for (i = 0; i < MAX_CONTAINED_RESOURCES; i++) {
2486         if (resourceHandle == resource->rsrcResources[i]) {
2487             resource->rsrcResources[i] = (OCResource *) NULL;
2488             OC_LOG(INFO, TAG, PCF("resource unbound"));
2489             return OC_STACK_OK;
2490         }
2491     }
2492
2493     OC_LOG(INFO, TAG, PCF("resource not found in collection"));
2494
2495     #ifdef WITH_PRESENCE
2496     if(presenceResource.handle)
2497     {
2498         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2499         SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType);
2500     }
2501     #endif
2502
2503     // Unable to add resourceHandle, so return error
2504     return OC_STACK_ERROR;
2505 }
2506
2507 OCStackResult BindResourceTypeToResource(OCResource* resource,
2508                                             const char *resourceTypeName)
2509 {
2510     OCResourceType *pointer = NULL;
2511     char *str = NULL;
2512     size_t size;
2513     OCStackResult result = OC_STACK_ERROR;
2514
2515     OC_LOG(INFO, TAG, PCF("Entering BindResourceTypeToResource"));
2516
2517     // Validate parameters
2518     VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
2519     // TODO:  Does resource attribute resentation really have to be maintained in stack?
2520     // Is it presented during resource discovery?
2521
2522     TODO ("Make sure that the resourcetypename doesn't already exist in the resource");
2523
2524     // Create the resourcetype and insert it into the resource list
2525     pointer = (OCResourceType *) OCCalloc(1, sizeof(OCResourceType));
2526     if (!pointer) {
2527         goto exit;
2528     }
2529
2530     // Set the resourceTypeName
2531     size = strlen(resourceTypeName) + 1;
2532     str = (char *) OCMalloc(size);
2533     if (!str) {
2534         goto exit;
2535     }
2536     strncpy(str, resourceTypeName, size);
2537     pointer->resourcetypename = str;
2538
2539     insertResourceType(resource, pointer);
2540     result = OC_STACK_OK;
2541
2542     exit: if (result != OC_STACK_OK) {
2543         OCFree(pointer);
2544         OCFree(str);
2545     }
2546
2547     return result;
2548 }
2549
2550 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
2551         const char *resourceInterfaceName)
2552 {
2553     OCResourceInterface *pointer = NULL;
2554     char *str = NULL;
2555     size_t size;
2556     OCStackResult result = OC_STACK_ERROR;
2557
2558     OC_LOG(INFO, TAG, PCF("Entering BindResourceInterfaceToResource"));
2559
2560     // Validate parameters
2561     VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
2562
2563     TODO ("Make sure that the resourceinterface name doesn't already exist in the resource");
2564
2565     // Create the resourceinterface and insert it into the resource list
2566     pointer = (OCResourceInterface *) OCCalloc(1, sizeof(OCResourceInterface));
2567     if (!pointer) {
2568         goto exit;
2569     }
2570
2571     // Set the resourceinterface name
2572     size = strlen(resourceInterfaceName) + 1;
2573     str = (char *) OCMalloc(size);
2574     if (!str) {
2575         goto exit;
2576     }
2577     strncpy(str, resourceInterfaceName, size);
2578     pointer->name = str;
2579
2580     // Bind the resourceinterface to the resource
2581     insertResourceInterface(resource, pointer);
2582
2583     result = OC_STACK_OK;
2584
2585     exit: if (result != OC_STACK_OK) {
2586         OCFree(pointer);
2587         OCFree(str);
2588     }
2589
2590     return result;
2591 }
2592
2593 /**
2594  * Bind a resourcetype to a resource.
2595  *
2596  * @param handle - handle to the resource
2597  * @param resourceTypeName - name of resource type.  Example: "core.led"
2598  *
2599  * @return
2600  *     OC_STACK_OK    - no errors
2601  *     OC_STACK_ERROR - stack process error
2602  */
2603 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
2604         const char *resourceTypeName) {
2605
2606     OCStackResult result = OC_STACK_ERROR;
2607     OCResource *resource;
2608
2609     // Make sure resource exists
2610     resource = findResource((OCResource *) handle);
2611     if (!resource) {
2612         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2613         return OC_STACK_ERROR;
2614     }
2615
2616     // call internal function
2617     result = BindResourceTypeToResource(resource, resourceTypeName);
2618
2619     #ifdef WITH_PRESENCE
2620     if(presenceResource.handle)
2621     {
2622         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2623         SendPresenceNotification(resource->rsrcType);
2624     }
2625     #endif
2626
2627     return result;
2628 }
2629
2630 /**
2631  * Bind a resourceinterface to a resource.
2632  *
2633  * @param handle - handle to the resource
2634  * @param resourceInterfaceName - name of resource interface.  Example: "oc.mi.b"
2635  *
2636  * @return
2637  *     OC_STACK_OK    - no errors
2638  *     OC_STACK_ERROR - stack process error
2639  */
2640
2641 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
2642         const char *resourceInterfaceName) {
2643
2644     OCStackResult result = OC_STACK_ERROR;
2645     OCResource *resource;
2646
2647     // Make sure resource exists
2648     resource = findResource((OCResource *) handle);
2649     if (!resource) {
2650         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2651         return OC_STACK_ERROR;
2652     }
2653
2654     // call internal function
2655     result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
2656
2657     #ifdef WITH_PRESENCE
2658     if(presenceResource.handle)
2659     {
2660         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2661         SendPresenceNotification(resource->rsrcType);
2662     }
2663     #endif
2664
2665     return result;
2666 }
2667
2668 /**
2669  * Get the number of resources that have been created in the stack.
2670  *
2671  * @param numResources - pointer to count variable
2672  *
2673  * @return
2674  *     OC_STACK_OK    - no errors
2675  *     OC_STACK_ERROR - stack process error
2676
2677  */
2678 OCStackResult OCGetNumberOfResources(uint8_t *numResources) {
2679     OCResource *pointer = headResource;
2680
2681     OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResources"));
2682     VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
2683     *numResources = 0;
2684     while (pointer) {
2685         *numResources = *numResources + 1;
2686         pointer = pointer->next;
2687     }
2688     return OC_STACK_OK;
2689 }
2690
2691 /**
2692  * Get a resource handle by index.
2693  *
2694  * @param index - index of resource, 0 to Count - 1
2695  *
2696  * @return
2697  *    Resource handle - if found
2698  *    NULL - if not found
2699  */
2700 OCResourceHandle OCGetResourceHandle(uint8_t index) {
2701     OCResource *pointer = headResource;
2702     uint8_t i = 0;
2703
2704     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceHandle"));
2705
2706     // Iterate through the list
2707     while ((i < index) && pointer) {
2708         i++;
2709         pointer = pointer->next;
2710     }
2711     return (OCResourceHandle) pointer;
2712 }
2713
2714 /**
2715  * Delete resource specified by handle.  Deletes resource and all resourcetype and resourceinterface
2716  * linked lists.
2717  *
2718  * @param handle - handle of resource to be deleted
2719  *
2720  * @return
2721  *     OC_STACK_OK              - no errors
2722  *     OC_STACK_ERROR           - stack process error
2723  *     OC_STACK_NO_RESOURCE     - resource not found
2724  *     OC_STACK_INVALID_PARAM   - invalid param
2725  */
2726 OCStackResult OCDeleteResource(OCResourceHandle handle) {
2727     OC_LOG(INFO, TAG, PCF("Entering OCDeleteResource"));
2728
2729     if (!handle) {
2730         OC_LOG(ERROR, TAG, PCF("Invalid param"));
2731         return OC_STACK_INVALID_PARAM;
2732     }
2733
2734     OCResource *resource = findResource((OCResource *) handle);
2735     if (resource == NULL) {
2736         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2737         return OC_STACK_NO_RESOURCE;
2738     }
2739
2740     if (deleteResource((OCResource *) handle) == 0) {
2741         OC_LOG(ERROR, TAG, PCF("Error deleting resource"));
2742         return OC_STACK_ERROR;
2743     }
2744
2745     return OC_STACK_OK;
2746 }
2747
2748 /**
2749  * Get the URI of the resource specified by handle.
2750  *
2751  * @param handle - handle of resource
2752  * @return
2753  *    URI string - if resource found
2754  *    NULL - resource not found
2755  */
2756 const char *OCGetResourceUri(OCResourceHandle handle) {
2757     OCResource *resource;
2758     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceUri"));
2759
2760     resource = findResource((OCResource *) handle);
2761     if (resource) {
2762         return resource->uri;
2763     }
2764     return (const char *) NULL;
2765 }
2766
2767 /**
2768  * Get the properties of the resource specified by handle.
2769  * NOTE: that after a resource is created, the OC_ACTIVE property is set
2770  * for the resource by the stack.
2771  *
2772  * @param handle - handle of resource
2773  * @return
2774  *    property bitmap - if resource found
2775  *    NULL - resource not found
2776  */
2777 uint8_t OCGetResourceProperties(OCResourceHandle handle) {
2778     OCResource *resource;
2779     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceProperties"));
2780
2781     resource = findResource((OCResource *) handle);
2782     if (resource) {
2783         return resource->resourceProperties;
2784     }
2785     return 0;
2786 }
2787
2788 /**
2789  * Get the number of resource types of the resource.
2790  *
2791  * @param handle - handle of resource
2792  * @param numResourceTypes - pointer to count variable
2793  *
2794  * @return
2795  *     OC_STACK_OK    - no errors
2796  *     OC_STACK_ERROR - stack process error
2797  */
2798 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
2799         uint8_t *numResourceTypes) {
2800     OCResource *resource;
2801     OCResourceType *pointer;
2802
2803     OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResourceTypes"));
2804     VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
2805     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2806
2807     *numResourceTypes = 0;
2808
2809     resource = findResource((OCResource *) handle);
2810     if (resource) {
2811         pointer = resource->rsrcType;
2812         while (pointer) {
2813             *numResourceTypes = *numResourceTypes + 1;
2814             pointer = pointer->next;
2815         }
2816     }
2817     return OC_STACK_OK;
2818 }
2819
2820 /**
2821  * Get name of resource type of the resource.
2822  *
2823  * @param handle - handle of resource
2824  * @param index - index of resource, 0 to Count - 1
2825  *
2826  * @return
2827  *    resource type name - if resource found
2828  *    NULL - resource not found
2829  */
2830 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index) {
2831     OCResourceType *resourceType;
2832
2833     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceTypeName"));
2834
2835     resourceType = findResourceTypeAtIndex(handle, index);
2836     if (resourceType) {
2837         return resourceType->resourcetypename;
2838     }
2839     return (const char *) NULL;
2840 }
2841
2842
2843
2844 /**
2845  * Get the number of resource interfaces of the resource.
2846  *
2847  * @param handle - handle of resource
2848  * @param numResources - pointer to count variable
2849  *
2850  * @return
2851  *     OC_STACK_OK    - no errors
2852  *     OC_STACK_ERROR - stack process error
2853  */
2854 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
2855         uint8_t *numResourceInterfaces) {
2856     OCResourceInterface *pointer;
2857     OCResource *resource;
2858
2859     OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResourceInterfaces"));
2860
2861     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2862     VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
2863
2864     *numResourceInterfaces = 0;
2865     resource = findResource((OCResource *) handle);
2866     if (resource) {
2867         pointer = resource->rsrcInterface;
2868         while (pointer) {
2869             *numResourceInterfaces = *numResourceInterfaces + 1;
2870             pointer = pointer->next;
2871         }
2872     }
2873     return OC_STACK_OK;
2874 }
2875
2876 /**
2877  * Get name of resource interface of the resource.
2878  *
2879  * @param handle - handle of resource
2880  * @param index - index of resource, 0 to Count - 1
2881  *
2882  * @return
2883  *    resource interface name - if resource found
2884  *    NULL - resource not found
2885  */
2886 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index) {
2887     OCResourceInterface *resourceInterface;
2888
2889     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceInterfaceName"));
2890
2891     resourceInterface = findResourceInterfaceAtIndex(handle, index);
2892     if (resourceInterface) {
2893         return resourceInterface->name;
2894     }
2895     return (const char *) NULL;
2896 }
2897
2898 /**
2899  * Get resource handle from the collection resource by index.
2900  *
2901  * @param collectionHandle - handle of collection resource
2902  * @param index - index of contained resource, 0 to Count - 1
2903  *
2904  * @return
2905  *    handle to resource - if resource found
2906  *    NULL - resource not found
2907  */
2908 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
2909         uint8_t index) {
2910     OCResource *resource;
2911
2912     OC_LOG(INFO, TAG, PCF("Entering OCGetContainedResource"));
2913
2914     if (index >= MAX_CONTAINED_RESOURCES) {
2915         return NULL;
2916     }
2917
2918     resource = findResource((OCResource *) collectionHandle);
2919     if (!resource) {
2920         return NULL;
2921     }
2922
2923     return resource->rsrcResources[index];
2924 }
2925
2926 /**
2927  * Bind an entity handler to the resource.
2928  *
2929  * @param handle - handle to the resource that the contained resource is to be bound
2930  * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2931  * @return
2932  *     OC_STACK_OK    - no errors
2933  *     OC_STACK_ERROR - stack process error
2934  */
2935 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
2936         OCEntityHandler entityHandler) {
2937     OCResource *resource;
2938
2939     OC_LOG(INFO, TAG, PCF("Entering OCBindResourceHandler"));
2940
2941     // Validate parameters
2942     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2943     //VERIFY_NON_NULL(entityHandler, ERROR, OC_STACK_INVALID_PARAM);
2944
2945     // Use the handle to find the resource in the resource linked list
2946     resource = findResource((OCResource *)handle);
2947     if (!resource) {
2948         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2949         return OC_STACK_ERROR;
2950     }
2951
2952     // Bind the handler
2953     resource->entityHandler = entityHandler;
2954
2955     #ifdef WITH_PRESENCE
2956     if(presenceResource.handle)
2957     {
2958         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2959         SendPresenceNotification(resource->rsrcType);
2960     }
2961     #endif
2962
2963     return OC_STACK_OK;
2964 }
2965
2966 /**
2967  * Get the entity handler for a resource.
2968  *
2969  * @param handle - handle of resource
2970  *
2971  * @return
2972  *    entity handler - if resource found
2973  *    NULL - resource not found
2974  */
2975 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle) {
2976     OCResource *resource;
2977
2978     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceHandler"));
2979
2980     // Use the handle to find the resource in the resource linked list
2981     resource = findResource((OCResource *)handle);
2982     if (!resource) {
2983         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2984         return NULL;
2985     }
2986
2987     // Bind the handler
2988     return resource->entityHandler;
2989 }
2990
2991 void incrementSequenceNumber(OCResource * resPtr)
2992 {
2993     // Increment the sequence number
2994     resPtr->sequenceNum += 1;
2995     if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
2996     {
2997         resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
2998     }
2999     return;
3000 }
3001
3002 /**
3003  * Notify Presence subscribers that a resource has been modified
3004  *
3005  * @param resourceType - Handle to the resourceType linked list of resource
3006  *                       that was modified.
3007  * @param qos          - Quality Of Service
3008  *
3009  */
3010 #ifdef WITH_PRESENCE
3011 OCStackResult SendPresenceNotification(OCResourceType *resourceType)
3012 {
3013     OCResource *resPtr = NULL;
3014     OCStackResult result;
3015     OCMethod method = OC_REST_PRESENCE;
3016     uint32_t maxAge = 0;
3017     resPtr = findResource((OCResource *) presenceResource.handle);
3018     if(NULL == resPtr)
3019     {
3020         return OC_STACK_NO_RESOURCE;
3021     }
3022     if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
3023     {
3024         maxAge = presenceResource.presenceTTL;
3025     }
3026     else
3027     {
3028         maxAge = 0;
3029     }
3030
3031     result = SendAllObserverNotification(method, resPtr, maxAge, resourceType, OC_LOW_QOS);
3032
3033     return result;
3034 }
3035 #endif // WITH_PRESENCE
3036 /**
3037  * Notify observers that an observed value has changed.
3038  *
3039  * @param handle - handle of resource
3040  *
3041  * @return
3042  *     OC_STACK_OK    - no errors
3043  *     OC_STACK_NO_RESOURCE - invalid resource handle
3044  *     OC_STACK_NO_OBSERVERS - no more observers intrested in resource
3045  */
3046 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos) {
3047
3048     OC_LOG(INFO, TAG, PCF("Entering OCNotifyAllObservers"));
3049
3050     OCResource *resPtr = NULL;
3051     OCStackResult result;
3052     OCMethod method = OC_REST_NOMETHOD;
3053     uint32_t maxAge = 0;
3054
3055     OC_LOG(INFO, TAG, PCF("Entering OCNotifyAllObservers"));
3056     #ifdef WITH_PRESENCE
3057     if(handle == presenceResource.handle)
3058     {
3059         return OC_STACK_OK;
3060     }
3061     #endif // WITH_PRESENCE
3062     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3063
3064     // Verify that the resource exists
3065     resPtr = findResource ((OCResource *) handle);
3066     if (NULL == resPtr)
3067     {
3068         return OC_STACK_NO_RESOURCE;
3069     }
3070     else
3071     {
3072         //only increment in the case of regular observing (not presence)
3073         incrementSequenceNumber(resPtr);
3074         method = OC_REST_OBSERVE;
3075         maxAge = MAX_OBSERVE_AGE;
3076         #ifdef WITH_PRESENCE
3077         result = SendAllObserverNotification (method, resPtr, maxAge, NULL, qos);
3078         #else
3079         result = SendAllObserverNotification (method, resPtr, maxAge, qos);
3080         #endif
3081         return result;
3082     }
3083 }
3084
3085 OCStackResult
3086 OCNotifyListOfObservers (OCResourceHandle handle,
3087                          OCObservationId  *obsIdList,
3088                          uint8_t          numberOfIds,
3089                          unsigned char    *notificationJSONPayload,
3090                          OCQualityOfService qos)
3091 {
3092     OC_LOG(INFO, TAG, PCF("Entering OCNotifyListOfObservers"));
3093
3094     OCResource *resPtr = NULL;
3095     //TODO: we should allow the server to define this
3096     uint32_t maxAge = MAX_OBSERVE_AGE;
3097
3098     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
3099     VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
3100     VERIFY_NON_NULL(notificationJSONPayload, ERROR, OC_STACK_ERROR);
3101
3102     // Verify that the resource exists
3103     resPtr = findResource ((OCResource *) handle);
3104     if (NULL == resPtr || myStackMode == OC_CLIENT)
3105     {
3106         return OC_STACK_NO_RESOURCE;
3107     }
3108     else
3109     {
3110         incrementSequenceNumber(resPtr);
3111     }
3112     return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
3113             notificationJSONPayload, maxAge, qos));
3114 }
3115
3116 /**
3117  * Send a response to a request.
3118  * The response can be a regular, slow, or block (i.e. a response that
3119  * is too large to be sent in a single PDU and must span multiple transmissions)
3120  *
3121  * @param response - pointer to structure that contains response parameters
3122  *
3123  * @return
3124  *     OC_STACK_OK                         - No errors; Success
3125  *     OC_STACK_INVALID_PARAM              - Invalid pointer to OCServerResponse
3126  *     OC_STACK_INVALID_REQUEST_HANDLE     - Request handle not found
3127  *     OC_STACK_PERSISTENT_BUFFER_REQUIRED - Block transfer needed for response, so a
3128  *                                           persistent response buffer is necessary
3129  */
3130 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
3131 {
3132     OCStackResult result = OC_STACK_ERROR;
3133     OCServerRequest *serverRequest = NULL;
3134
3135     OC_LOG(INFO, TAG, PCF("Entering OCDoResponse"));
3136
3137     // Validate input parameters
3138     VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
3139     VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
3140
3141     // TODO: Placeholder for creating a response entry when implementing
3142     // block transfer feature
3143
3144     // If a response payload is present, check if block transfer is required
3145     if (ehResponse->payload && OCIsPacketTransferRequired(NULL,
3146             (const char *)ehResponse->payload, ehResponse->payloadSize))
3147     {
3148         OC_LOG(INFO, TAG, PCF("Block transfer required"));
3149
3150         // Persistent response buffer is needed for block transfer
3151         if (!ehResponse->persistentBufferFlag)
3152         {
3153             OC_LOG(WARNING, TAG, PCF("Persistent response buffer required"));
3154             return OC_STACK_PERSISTENT_BUFFER_REQUIRED;
3155         }
3156         // TODO: Placeholder for block transfer handling
3157         // TODO: Placeholder for setting the the response handle in the OCServerResponse struct
3158             // when implementing the block transfer feature
3159     }
3160     else
3161     {
3162         // Normal response
3163         // Get pointer to request info
3164         serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
3165         if(serverRequest)
3166         {
3167             result = serverRequest->ehResponseHandler(ehResponse);
3168         }
3169     }
3170     return result;
3171 }
3172
3173 /**
3174  * Cancel a response.  Applies to a block response
3175  *
3176  * @param responseHandle - response handle set by stack in OCServerResponse after
3177  *                         OCDoResponse is called
3178  *
3179  * @return
3180  *     OC_STACK_OK               - No errors; Success
3181  *     OC_STACK_INVALID_PARAM    - The handle provided is invalid.
3182  */
3183 OCStackResult OCCancelResponse(OCResponseHandle responseHandle)
3184 {
3185     OCStackResult result = OC_STACK_NOTIMPL;
3186
3187     OC_LOG(INFO, TAG, PCF("Entering OCCancelResponse"));
3188
3189     // TODO: validate response handle
3190
3191     return result;
3192 }
3193
3194 //-----------------------------------------------------------------------------
3195 // Private internal function definitions
3196 //-----------------------------------------------------------------------------
3197 /**
3198  * Generate handle of OCDoResource invocation for callback management.
3199  */
3200 static OCDoHandle GenerateInvocationHandle()
3201 {
3202     OCDoHandle handle = NULL;
3203     // Generate token here, it will be deleted when the transaction is deleted
3204     handle = (OCDoHandle) OCMalloc(sizeof(uint8_t[MAX_TOKEN_LENGTH]));
3205     if (handle)
3206     {
3207         OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[MAX_TOKEN_LENGTH]));
3208     }
3209
3210     return handle;
3211 }
3212 #ifdef WITH_PRESENCE
3213 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
3214         OCResourceProperty resourceProperties, uint8_t enable)
3215 {
3216     if (resourceProperties
3217             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW)) {
3218         OC_LOG(ERROR, TAG, PCF("Invalid property"));
3219         return OC_STACK_INVALID_PARAM;
3220     }
3221     if(!enable)
3222     {
3223         *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
3224     }
3225     else
3226     {
3227         *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
3228     }
3229     return OC_STACK_OK;
3230 }
3231 #endif
3232
3233 /**
3234  * Initialize resource data structures, variables, etc.
3235  */
3236 OCStackResult initResources() {
3237     OCStackResult result = OC_STACK_OK;
3238     // Init application resource vars
3239     headResource = NULL;
3240     // Init Virtual Resources
3241     #ifdef WITH_PRESENCE
3242     presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL;
3243     //presenceResource.token = OCGenerateCoAPToken();
3244     result = OCCreateResource(&presenceResource.handle,
3245             OC_RSRVD_RESOURCE_TYPE_PRESENCE,
3246             "core.r",
3247             OC_PRESENCE_URI,
3248             NULL,
3249             OC_OBSERVABLE);
3250     //make resource inactive
3251     result = OCChangeResourceProperty(
3252             &(((OCResource *) presenceResource.handle)->resourceProperties),
3253             OC_ACTIVE, 0);
3254     #endif
3255     return result;
3256 }
3257
3258 /**
3259  * Add a resource to the end of the linked list of resources.
3260  *
3261  * @param resource - resource to be added
3262  */
3263 void insertResource(OCResource *resource) {
3264     OCResource *pointer;
3265
3266     if (!headResource) {
3267         headResource = resource;
3268     } else {
3269         pointer = headResource;
3270
3271         while (pointer->next) {
3272             pointer = pointer->next;
3273         }
3274         pointer->next = resource;
3275     }
3276     resource->next = NULL;
3277 }
3278
3279 /**
3280  * Find a resource in the linked list of resources.
3281  *
3282  * @param resource - resource to be found
3283  * @return
3284  *     NULL                - resource not found
3285  *     pointer to resource - pointer to resource that was found in the linked list
3286  */
3287 OCResource *findResource(OCResource *resource) {
3288     OCResource *pointer = headResource;
3289
3290     while (pointer) {
3291         if (pointer == resource) {
3292             return resource;
3293         }
3294         pointer = pointer->next;
3295     }
3296     return NULL;
3297 }
3298
3299 void deleteAllResources()
3300 {
3301     OCResource *pointer = headResource;
3302     OCResource *temp;
3303
3304     while (pointer)
3305     {
3306         temp = pointer->next;
3307         #ifdef WITH_PRESENCE
3308         if(pointer != (OCResource *) presenceResource.handle)
3309         {
3310             #endif // WITH_PRESENCE
3311             deleteResource(pointer);
3312             #ifdef WITH_PRESENCE
3313         }
3314         #endif // WITH_PRESENCE
3315         pointer = temp;
3316     }
3317
3318     #ifdef WITH_PRESENCE
3319     // Ensure that the last resource to be deleted is the presence resource. This allows for all
3320     // presence notification attributed to their deletion to be processed.
3321     deleteResource((OCResource *) presenceResource.handle);
3322     #endif // WITH_PRESENCE
3323 }
3324
3325 /**
3326  * Delete the resource from the linked list.
3327  *
3328  * @param resource - resource to be deleted
3329  * @return
3330  *    0 - error
3331  *    1 - success
3332  */
3333 int deleteResource(OCResource *resource) {
3334     OCResource *prev = NULL;
3335     OCResource *temp;
3336
3337     temp = headResource;
3338     while (temp) {
3339         if (temp == resource) {
3340             // Invalidate all Resource Properties.
3341             resource->resourceProperties = (OCResourceProperty) 0;
3342             #ifdef WITH_PRESENCE
3343             if(resource != (OCResource *) presenceResource.handle)
3344             {
3345             #endif // WITH_PRESENCE
3346                 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
3347             #ifdef WITH_PRESENCE
3348             }
3349
3350             if(presenceResource.handle)
3351             {
3352                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
3353                 if(resource != (OCResource *) presenceResource.handle)
3354                 {
3355                     SendPresenceNotification(resource->rsrcType);
3356                 }
3357                 else
3358                 {
3359                     SendPresenceNotification(NULL);
3360                 }
3361             }
3362         #endif
3363
3364             if (temp == headResource) {
3365                 headResource = temp->next;
3366             } else {
3367                 prev->next = temp->next;
3368             }
3369
3370             deleteResourceElements(temp);
3371             OCFree(temp);
3372             return 1;
3373         } else {
3374             prev = temp;
3375             temp = temp->next;
3376         }
3377     }
3378
3379     return 0;
3380 }
3381
3382 /**
3383  * Delete all of the dynamically allocated elements that were created for the resource.
3384  *
3385  * @param resource - specified resource
3386  */
3387 void deleteResourceElements(OCResource *resource) {
3388     if (!resource) {
3389         return;
3390     }
3391
3392     // remove URI
3393     OCFree(resource->uri);
3394
3395     // Delete resourcetype linked list
3396     deleteResourceType(resource->rsrcType);
3397
3398     // Delete resourceinterface linked list
3399     deleteResourceInterface(resource->rsrcInterface);
3400 }
3401
3402 /**
3403  * Delete all of the dynamically allocated elements that were created for the resource type.
3404  *
3405  * @param resourceType - specified resource type
3406  */
3407 void deleteResourceType(OCResourceType *resourceType) {
3408     OCResourceType *pointer = resourceType;
3409     OCResourceType *next;
3410
3411     while (pointer) {
3412         next = pointer->next;
3413         OCFree(pointer->resourcetypename);
3414         OCFree(pointer);
3415         pointer = next;
3416     }
3417 }
3418
3419 /**
3420  * Delete all of the dynamically allocated elements that were created for the resource interface.
3421  *
3422  * @param resourceInterface - specified resource interface
3423  */
3424 void deleteResourceInterface(OCResourceInterface *resourceInterface) {
3425     OCResourceInterface *pointer = resourceInterface;
3426     OCResourceInterface *next;
3427
3428     while (pointer) {
3429         next = pointer->next;
3430         OCFree(pointer->name);
3431         OCFree(pointer);
3432         pointer = next;
3433     }
3434 }
3435
3436 /**
3437  * Insert a resource type into a resource's resource type linked list.
3438  *
3439  * @param resource - resource where resource type is to be inserted
3440  * @param resourceType - resource type to be inserted
3441  */
3442 void insertResourceType(OCResource *resource, OCResourceType *resourceType) {
3443     OCResourceType *pointer;
3444
3445     if (resource && !resource->rsrcType) {
3446         resource->rsrcType = resourceType;
3447     } else {
3448         if(resource)
3449         {
3450             pointer = resource->rsrcType;
3451         }
3452         else
3453         {
3454             pointer = resourceType;
3455         }
3456         while (pointer->next) {
3457             pointer = pointer->next;
3458         }
3459         pointer->next = resourceType;
3460     }
3461     resourceType->next = NULL;
3462 }
3463
3464 /**
3465  * Get a resource type at the specified index within a resource.
3466  *
3467  * @param handle - handle of resource
3468  * @param index - index of resource type
3469  *
3470  * @return
3471  *    resourcetype - if found
3472  *    NULL - not found
3473  */
3474 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index) {
3475     OCResource *resource;
3476     OCResourceType *pointer;
3477     uint8_t i;
3478
3479     // Find the specified resource
3480     resource = findResource((OCResource *) handle);
3481     if (!resource) {
3482         return NULL;
3483     }
3484
3485     // Make sure a resource has a resourcetype
3486     if (!resource->rsrcType) {
3487         return NULL;
3488     }
3489
3490     // Iterate through the list
3491     pointer = resource->rsrcType;
3492     i = 0;
3493     while ((i < index) && pointer) {
3494         i++;
3495         pointer = pointer->next;
3496     }
3497     return pointer;
3498 }
3499
3500 /**
3501  * Finds a resource type in an OCResourceType link-list.
3502  *
3503  * @param resourceTypeList - the link-list to be searched through
3504  * @param resourceTypeName - the key to search for
3505  *
3506  * @return
3507  *      resourceType that matches the key (ie. resourceTypeName)
3508  *      NULL - either an invalid parameter or this function was unable to find the key.
3509  */
3510 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
3511 {
3512     if(resourceTypeList && resourceTypeName)
3513     {
3514         OCResourceType * rtPointer = resourceTypeList;
3515         while(resourceTypeName && rtPointer)
3516         {
3517             if(rtPointer->resourcetypename &&
3518                     strcmp(resourceTypeName, (const char *)
3519                     (rtPointer->resourcetypename)) == 0)
3520             {
3521                 break;
3522             }
3523             rtPointer = rtPointer->next;
3524         }
3525         return rtPointer;
3526     }
3527     return NULL;
3528 }
3529 /**
3530  * Insert a resource interface into a resource's resource interface linked list.
3531  *
3532  * @param resource - resource where resource interface is to be inserted
3533  * @param resourceInterface - resource interface to be inserted
3534  */
3535 void insertResourceInterface(OCResource *resource,
3536         OCResourceInterface *resourceInterface) {
3537     OCResourceInterface *pointer;
3538
3539     if (!resource->rsrcInterface) {
3540         resource->rsrcInterface = resourceInterface;
3541     } else {
3542         pointer = resource->rsrcInterface;
3543         while (pointer->next) {
3544             pointer = pointer->next;
3545         }
3546         pointer->next = resourceInterface;
3547     }
3548     resourceInterface->next = NULL;
3549 }
3550
3551 /**
3552  * Get a resource interface at the specified index within a resource.
3553  *
3554  * @param handle - handle of resource
3555  * @param index - index of resource interface
3556  *
3557  * @return
3558  *    resourceinterface - if found
3559  *    NULL - not found
3560  */
3561 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
3562         uint8_t index) {
3563     OCResource *resource;
3564     OCResourceInterface *pointer;
3565     uint8_t i = 0;
3566
3567     // Find the specified resource
3568     resource = findResource((OCResource *) handle);
3569     if (!resource) {
3570         return NULL;
3571     }
3572
3573     // Make sure a resource has a resourceinterface
3574     if (!resource->rsrcInterface) {
3575         return NULL;
3576     }
3577
3578     // Iterate through the list
3579     pointer = resource->rsrcInterface;
3580
3581     while ((i < index) && pointer) {
3582         i++;
3583         pointer = pointer->next;
3584     }
3585     return pointer;
3586 }
3587
3588 /**
3589  * Determine if a request/response must be sent in a block transfer because it is too large to be
3590  * sent in a single PDU.  This function can be used for either a request or a response
3591  *
3592  * @param request  - NULL or pointer to request
3593  * @param response - NULL or pointer to response
3594  * @param size     - 0 or size of the request/response.  If 0, strlen is used for determining
3595  *                   the length of the request/response
3596  *
3597  * @return
3598  *    0 - packet transfer NOT required (i.e. normal request/response)
3599  *    1 - packet transfer required (i.e. block transfer needed)
3600  */
3601 uint8_t OCIsPacketTransferRequired(const char *request, const char *response, uint16_t size)
3602 {
3603     uint8_t result = 0;
3604
3605     // Determine if we are checking a request or a response
3606     if (request)
3607     {
3608         // If size is greater than 0, use it for the request size value, otherwise
3609         // assume request is null terminated and use strlen for size value
3610         if ((size > MAX_REQUEST_LENGTH) || (strlen(request) > MAX_REQUEST_LENGTH))
3611         {
3612             result = 1;
3613         }
3614     }
3615     else if (response)
3616     {
3617         // If size is greater than 0, use it for the response size value, otherwise
3618         // assume response is null terminated and use strlen for size value
3619         if ((size > MAX_RESPONSE_LENGTH) || (strlen(response) > MAX_RESPONSE_LENGTH))
3620         {
3621             result = 1;
3622         }
3623     }
3624     return result;
3625 }
3626
3627 /**
3628  * Retrieves a resource type based upon a query ontains only just one
3629  * resource attribute (and that has to be of type "rt").
3630  *
3631  * @remark This API malloc's memory for the resource type. Do not malloc resourceType
3632  * before passing in.
3633  *
3634  * @param query - The quert part of the URI
3635  * @param resourceType - The resource type to be populated; pass by reference.
3636  *
3637  * @return
3638  *  OC_STACK_INVALID_PARAM - Returns this if the resourceType parameter is invalid/NULL.
3639  *  OC_STACK_OK            - Success
3640  */
3641 OCStackResult getResourceType(const char * query, unsigned char** resourceType)
3642 {
3643     if(!query)
3644     {
3645         return OC_STACK_INVALID_PARAM;
3646     }
3647
3648     OCStackResult result = OC_STACK_ERROR;
3649
3650     if(strncmp(query, "rt=", 3) == 0)
3651     {
3652         *resourceType = (unsigned char *) OCMalloc(strlen(query)-3);
3653         if(!*resourceType)
3654         {
3655             result = OC_STACK_NO_MEMORY;
3656         }
3657
3658         strcpy((char *)*resourceType, ((const char *)&query[3]));
3659         result = OC_STACK_OK;
3660     }
3661
3662     return result;
3663 }
3664
3665 OCStackResult getQueryFromUri(const char * uri, unsigned char** query, char ** newURI)
3666 {
3667     if(!uri)
3668     {
3669         return OC_STACK_INVALID_URI;
3670     }
3671     if(!query || !newURI)
3672     {
3673         return OC_STACK_INVALID_PARAM;
3674     }
3675     char * leftToken = NULL;
3676     char * tempURI = (char *) OCMalloc(strlen(uri) + 1);
3677     if(!tempURI)
3678     {
3679         goto exit;
3680     }
3681     strcpy(tempURI, uri);
3682     char* strTokPtr;
3683     leftToken = strtok_r((char *)tempURI, "?", &strTokPtr);
3684
3685     //TODO-CA: This could be simplified. Clean up required.
3686     while(leftToken != NULL)
3687     {
3688         if(strncmp(leftToken, "rt=", 3) == 0 || strncmp(leftToken, "if=", 3) == 0)
3689         {
3690             *query = (unsigned char *) OCMalloc(strlen(leftToken));
3691             if(!*query)
3692             {
3693                 OCFree(tempURI);
3694                 goto exit;
3695             }
3696             strcpy((char *)*query, ((const char *)&leftToken[0]));
3697             break;
3698         }
3699         leftToken = strtok_r(NULL, "?", &strTokPtr);
3700     }
3701
3702     *newURI = tempURI;
3703
3704     return OC_STACK_OK;
3705
3706     exit:
3707         return OC_STACK_NO_MEMORY;
3708 }
3709
3710 const ServerID OCGetServerInstanceID(void)
3711 {
3712     static bool generated = false;
3713     static ServerID sid;
3714
3715     if(generated)
3716     {
3717         return sid;
3718     }
3719
3720     sid = OCGetRandom();
3721     generated = true;
3722     return sid;
3723 }
3724
3725 const char* OCGetServerInstanceIDString(void)
3726 {
3727     // max printed length of a base 10
3728     // uint32 is 10 characters, so 11 includes null.
3729     // This will change as the representation gets switched
3730     // to another value
3731     static char buffer[11];
3732     int n = sprintf(buffer, "%u", OCGetServerInstanceID());
3733     if (n < 0)
3734     {
3735         buffer[0]='\0';
3736     }
3737
3738     return buffer;
3739 }