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