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         // Replacing method type with GET because "presence" is a stack layer only implementation.
1152         method = OC_REST_GET;
1153
1154         result = getResourceType(requiredUri, &resourceType, &newUri);
1155         if(resourceType) {
1156             OC_LOG_V(DEBUG, TAG, "Got Resource Type: %s", resourceType);
1157         }
1158         else
1159         {
1160             OC_LOG(DEBUG, TAG, PCF("Got Resource Type is NULL."));
1161         }
1162         if(result != OC_STACK_OK)
1163         {
1164             goto exit;
1165         }
1166     }
1167 #endif // WITH_PRESENCE
1168
1169     requestUri = (unsigned char *) OCMalloc(uriLen + 1);
1170     if(requestUri)
1171     {
1172         memcpy(requestUri, newUri, (uriLen + 1));
1173     }
1174     else
1175     {
1176         result = OC_STACK_NO_MEMORY;
1177         goto exit;
1178     }
1179
1180     *handle = GenerateInvocationHandle();
1181     if(!*handle)
1182     {
1183         result = OC_STACK_NO_MEMORY;
1184         goto exit;
1185     }
1186
1187 #ifdef CA_INT
1188     memset(&requestData, 0, sizeof(CAInfo_t));
1189     memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1190     switch (method)
1191     {
1192         case OC_REST_GET:
1193         case OC_REST_OBSERVE:
1194         case OC_REST_OBSERVE_ALL:
1195         case OC_REST_CANCEL_OBSERVE:
1196             {
1197                 requestInfo.method = CA_GET;
1198                 break;
1199             }
1200         case OC_REST_PUT:
1201             {
1202                 requestInfo.method = CA_PUT;
1203                 break;
1204             }
1205         case OC_REST_POST:
1206             {
1207                 requestInfo.method = CA_POST;
1208                 break;
1209             }
1210         case OC_REST_DELETE:
1211             {
1212                 requestInfo.method = CA_DELETE;
1213                 break;
1214             }
1215         #ifdef WITH_PRESENCE
1216         case OC_REST_PRESENCE:
1217             //TODO-CA: What should be the CA method?
1218             break;
1219         #endif
1220         default:
1221             result = OC_STACK_INVALID_METHOD;
1222             goto exit;
1223     }
1224
1225     // TODO-CA: Handle multi-cast scenario
1226     // Create remote end point
1227     caResult = CACreateRemoteEndpoint(newUri, CA_WIFI, &endpoint);
1228     // TODO-CA: Connectivity type should be passed to API
1229     endpoint->connectivityType = CA_WIFI;
1230     if (caResult != CA_STATUS_OK)
1231     {
1232         OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1233         goto exit;
1234     }
1235
1236     // create token
1237     caResult = CAGenerateToken(&caToken);
1238
1239     if (caResult != CA_STATUS_OK)
1240     {
1241         OC_LOG(ERROR, TAG, PCF("CAGenerateToken error"));
1242         caToken = NULL;
1243         goto exit;
1244     }
1245
1246     // TODO-CA: Map QoS to the right CA msg type
1247     requestData.type = CA_MSG_NONCONFIRM;
1248     requestData.token = caToken;
1249     if ((method == OC_REST_OBSERVE) || (method == OC_REST_OBSERVE_ALL))
1250     {
1251         result = CreateObserveHeaderOption (&(requestData.options), options,
1252                                     numOptions, OC_OBSERVE_REGISTER);
1253         if (result != OC_STACK_OK)
1254         {
1255             goto exit;
1256         }
1257         hdrOptionMemAlloc = 1;
1258         requestData.numOptions = numOptions + 1;
1259     }
1260     else
1261     {
1262         requestData.options = (CAHeaderOption_t*)options;
1263         requestData.numOptions = numOptions;
1264     }
1265     requestData.payload = (char *)request;
1266
1267     requestInfo.info = requestData;
1268
1269     // send request
1270     caResult = CASendRequest(endpoint, &requestInfo);
1271     if (caResult != CA_STATUS_OK)
1272     {
1273         OC_LOG(ERROR, TAG, PCF("CASendRequest"));
1274         goto exit;
1275     }
1276
1277     if((result = AddClientCB(&clientCB, cbData, &caToken, handle, method,
1278                              requestUri, resourceType)) != OC_STACK_OK)
1279     {
1280         result = OC_STACK_NO_MEMORY;
1281         goto exit;
1282     }
1283
1284 #else // CA_INT
1285
1286     // Generate token which will be used by OCStack to match responses received
1287     // with the request
1288     OCGenerateCoAPToken(&token);
1289
1290     if((result = AddClientCB(&clientCB, cbData, &token, handle, method, requestUri, resourceType))
1291             != OC_STACK_OK)
1292     {
1293         result = OC_STACK_NO_MEMORY;
1294         goto exit;
1295     }
1296
1297     // Make call to OCCoAP layer
1298     result = OCDoCoAPResource(method, qos, &token, newUri, request, options, numOptions);
1299 #endif // CA_INT
1300
1301 exit:
1302     if(newUri != requiredUri)
1303     {
1304         OCFree(newUri);
1305     }
1306     if (result != OC_STACK_OK)
1307     {
1308         OC_LOG(ERROR, TAG, PCF("OCDoResource error"));
1309         FindAndDeleteClientCB(clientCB);
1310     }
1311 #ifdef CA_INT
1312     CADestroyRemoteEndpoint(endpoint);
1313     if (hdrOptionMemAlloc)
1314     {
1315         OCFree(requestData.options);
1316     }
1317 #endif // CA_INT
1318     return result;
1319 }
1320
1321 /**
1322  * Cancel a request associated with a specific @ref OCDoResource invocation.
1323  *
1324  * @param handle - Used to identify a specific OCDoResource invocation.
1325  * @param qos    - used to specify Quality of Service (read below for more info)
1326  * @param options- used to specify vendor specific header options when sending
1327  *                 explicit observe cancellation
1328  * @param numOptions- Number of header options to be included
1329  *
1330  * @return
1331  *     OC_STACK_OK               - No errors; Success
1332  *     OC_STACK_INVALID_PARAM    - The handle provided is invalid.
1333  */
1334 OCStackResult OCCancel(OCDoHandle handle, OCQualityOfService qos, OCHeaderOption * options,
1335         uint8_t numOptions)
1336 {
1337     /*
1338      * This ftn is implemented one of two ways in the case of observation:
1339      *
1340      * 1. qos == OC_NON_CONFIRMABLE. When observe is unobserved..
1341      *      Remove the callback associated on client side.
1342      *      When the next notification comes in from server,
1343      *      reply with RESET message to server.
1344      *      Keep in mind that the server will react to RESET only
1345      *      if the last notification was sent ans CON
1346      *
1347      * 2. qos == OC_CONFIRMABLE. When OCCancel is called,
1348      *      and it is associated with an observe request
1349      *      (i.e. ClientCB->method == OC_REST_OBSERVE || OC_REST_OBSERVE_ALL),
1350      *      Send CON Observe request to server with
1351      *      observe flag = OC_RESOURCE_OBSERVE_DEREGISTER.
1352      *      Remove the callback associated on client side.
1353      */
1354     OCStackResult ret = OC_STACK_OK;
1355 #ifdef CA_INT
1356     CARemoteEndpoint_t* endpoint = NULL;
1357     CAResult_t caResult;
1358     CAInfo_t requestData;
1359     CARequestInfo_t requestInfo;
1360     // Track if memory is allocated for additional header options
1361     uint8_t hdrOptionMemAlloc = 0;
1362 #endif // CA_INT
1363
1364     if(!handle) {
1365         return OC_STACK_INVALID_PARAM;
1366     }
1367
1368     OC_LOG(INFO, TAG, PCF("Entering OCCancel"));
1369
1370     ClientCB *clientCB = GetClientCB(NULL, handle, NULL);
1371
1372     if(clientCB) {
1373         switch (clientCB->method)
1374         {
1375             case OC_REST_OBSERVE:
1376             case OC_REST_OBSERVE_ALL:
1377                 #ifdef CA_INT
1378                 caResult = CACreateRemoteEndpoint((char *)clientCB->requestUri, CA_WIFI,
1379                                                   &endpoint);
1380                 endpoint->connectivityType = CA_WIFI;
1381                 if (caResult != CA_STATUS_OK)
1382                 {
1383                     OC_LOG(ERROR, TAG, PCF("CACreateRemoteEndpoint error"));
1384                     return OC_STACK_ERROR;
1385                 }
1386
1387                 memset(&requestData, 0, sizeof(CAInfo_t));
1388                 // TODO-CA: Map QoS to the right CA msg type
1389                 requestData.type = CA_MSG_NONCONFIRM;
1390                 requestData.token = clientCB->token;
1391                 if (CreateObserveHeaderOption (&(requestData.options),
1392                             options, numOptions, OC_OBSERVE_DEREGISTER) != OC_STACK_OK)
1393                 {
1394                     return OC_STACK_ERROR;
1395                 }
1396                 hdrOptionMemAlloc = 1;
1397                 requestData.numOptions = numOptions + 1;
1398                 memset(&requestInfo, 0, sizeof(CARequestInfo_t));
1399                 requestInfo.method = CA_GET;
1400                 requestInfo.info = requestData;
1401                 // send request
1402                 caResult = CASendRequest(endpoint, &requestInfo);
1403                 if (caResult != CA_STATUS_OK)
1404                 {
1405                     OC_LOG(ERROR, TAG, PCF("CASendRequest error"));
1406                 }
1407                 if(caResult == CA_STATUS_OK)
1408                 {
1409                     ret = OC_STACK_OK;
1410                 }
1411                 #else // CA_INT
1412                 if(qos == OC_HIGH_QOS)
1413                 {
1414                     ret = OCDoCoAPResource(OC_REST_CANCEL_OBSERVE, qos,
1415                             &(clientCB->token), (const char *) clientCB->requestUri, NULL, options,
1416                             numOptions);
1417                 }
1418                 else
1419                 {
1420                     FindAndDeleteClientCB(clientCB);
1421                 }
1422                 break;
1423                 #endif // CA_INT
1424             #ifdef WITH_PRESENCE
1425             case OC_REST_PRESENCE:
1426                 FindAndDeleteClientCB(clientCB);
1427                 break;
1428             #endif
1429             default:
1430                 return OC_STACK_INVALID_METHOD;
1431         }
1432     }
1433 #ifdef CA_INT
1434     CADestroyRemoteEndpoint(endpoint);
1435     if (hdrOptionMemAlloc)
1436     {
1437         OCFree(requestData.options);
1438     }
1439 #endif // CA_INT
1440
1441     return ret;
1442 }
1443 #ifdef WITH_PRESENCE
1444 OCStackResult OCProcessPresence()
1445 {
1446     OCStackResult result = OC_STACK_OK;
1447     uint8_t ipAddr[4] = { 0 };
1448     uint16_t port = 0;
1449
1450     OC_LOG(INFO, TAG, PCF("Entering RequestPresence"));
1451     ClientCB* cbNode = NULL;
1452     OCDevAddr dst;
1453     OCClientResponse clientResponse;
1454     OCResponse * response = NULL;
1455
1456     LL_FOREACH(cbList, cbNode) {
1457         if(OC_REST_PRESENCE == cbNode->method)
1458         {
1459             if(cbNode->presence)
1460             {
1461                 uint32_t now = GetTime(0);
1462                 OC_LOG_V(DEBUG, TAG, "----------------this TTL level %d", cbNode->presence->TTLlevel);
1463                 OC_LOG_V(DEBUG, TAG, "----------------current ticks %d", now);
1464
1465
1466                 if(cbNode->presence->TTLlevel >= (PresenceTimeOutSize + 1))
1467                 {
1468                     goto exit;
1469                 }
1470
1471                 if(cbNode->presence->TTLlevel < PresenceTimeOutSize){
1472                     OC_LOG_V(DEBUG, TAG, "----------------timeout ticks %d",
1473                             cbNode->presence->timeOut[cbNode->presence->TTLlevel]);
1474                 }
1475
1476                 if(cbNode->presence->TTLlevel >= PresenceTimeOutSize)
1477                 {
1478                     OC_LOG(DEBUG, TAG, PCF("----------------No more timeout ticks"));
1479                     if (ParseIPv4Address( cbNode->requestUri, ipAddr, &port))
1480                     {
1481                         OCBuildIPv4Address(ipAddr[0], ipAddr[1], ipAddr[2], ipAddr[3], port,
1482                                 &dst);
1483                         result = FormOCClientResponse(&clientResponse, OC_STACK_PRESENCE_TIMEOUT,
1484                                 (OCDevAddr *) &dst, 0, NULL);
1485                         if(result != OC_STACK_OK)
1486                         {
1487                             goto exit;
1488                         }
1489                         result = FormOCResponse(&response, cbNode, 0, NULL, NULL,
1490                                 &cbNode->token, &clientResponse, NULL);
1491                         if(result != OC_STACK_OK)
1492                         {
1493                             goto exit;
1494                         }
1495
1496                         // Increment the TTLLevel (going to a next state), so we don't keep
1497                         // sending presence notification to client.
1498                         cbNode->presence->TTLlevel++;
1499                         OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d",
1500                                                 cbNode->presence->TTLlevel);
1501                     }
1502                     else
1503                     {
1504                         result = OC_STACK_INVALID_IP;
1505                         goto exit;
1506                     }
1507                     HandleStackResponses(response);
1508                 }
1509                 if(now >= cbNode->presence->timeOut[cbNode->presence->TTLlevel])
1510                 {
1511                     OC_LOG(DEBUG, TAG, PCF("time to test server presence =========="));
1512                     OCCoAPToken token;
1513                     OCGenerateCoAPToken(&token);
1514                     result = OCDoCoAPResource(OC_REST_GET, OC_LOW_QOS,
1515                             &token, (const char *)cbNode->requestUri, NULL, NULL, 0);
1516                     if(result != OC_STACK_OK)
1517                     {
1518                         goto exit;
1519                     }
1520                     cbNode->presence->TTLlevel++;
1521                     OC_LOG_V(DEBUG, TAG, "----------------moving to TTL level %d", cbNode->presence->TTLlevel);
1522                 }
1523             }
1524         }
1525     }
1526 exit:
1527     if (result != OC_STACK_OK)
1528     {
1529         OC_LOG(ERROR, TAG, PCF("OCProcessPresence error"));
1530     }
1531     return result;
1532 }
1533 #endif
1534
1535 /**
1536  * Called in main loop of OC client or server.  Allows low-level processing of
1537  * stack services.
1538  *
1539  * @return
1540  *     OC_STACK_OK    - no errors
1541  *     OC_STACK_ERROR - stack process error
1542  */
1543 OCStackResult OCProcess() {
1544
1545     OC_LOG(INFO, TAG, PCF("Entering OCProcess"));
1546     #ifdef WITH_PRESENCE
1547     OCProcessPresence();
1548     #endif
1549 #ifdef CA_INT
1550     CAHandleRequestResponse();
1551 #else
1552     OCProcessCoAP();
1553 #endif // CA_INT
1554
1555     return OC_STACK_OK;
1556 }
1557
1558 #ifdef WITH_PRESENCE
1559 /**
1560  * When operating in @ref OCServer or @ref OCClientServer mode, this API will start sending out
1561  * presence notifications to clients via multicast. Once this API has been called with a success,
1562  * clients may query for this server's presence and this server's stack will respond via multicast.
1563  *
1564  * Server can call this function when it comes online for the first time, or when it comes back
1565  * online from offline mode, or when it re enters network.
1566  *
1567  * @param ttl - Time To Live in seconds
1568  * Note: If ttl is '0', then the default stack value will be used (60 Seconds).
1569  *
1570  * @return
1571  *     OC_STACK_OK      - No errors; Success
1572  */
1573 OCStackResult OCStartPresence(const uint32_t ttl)
1574 {
1575     OCChangeResourceProperty(
1576             &(((OCResource *)presenceResource.handle)->resourceProperties),
1577             OC_ACTIVE, 1);
1578
1579     if(ttl > 0)
1580     {
1581         presenceResource.presenceTTL = ttl;
1582     }
1583
1584     if(OC_PRESENCE_UNINITIALIZED == presenceState)
1585     {
1586         OCDevAddr multiCastAddr;
1587         OCCoAPToken token;
1588
1589         presenceState = OC_PRESENCE_INITIALIZED;
1590         OCGenerateCoAPToken(&token);
1591         OCBuildIPv4Address(224, 0, 1, 187, 5683, &multiCastAddr);
1592         //add the presence observer
1593         AddObserver(OC_PRESENCE_URI, NULL, 0, &token, &multiCastAddr,
1594             (OCResource *)presenceResource.handle, OC_LOW_QOS);
1595     }
1596
1597     // Each time OCStartPresence is called
1598     // a different random 32-bit integer number is used
1599     ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
1600
1601     return SendPresenceNotification(NULL);
1602 }
1603
1604 /**
1605  * When operating in @ref OCServer or @ref OCClientServer mode, this API will stop sending out
1606  * presence notifications to clients via multicast. Once this API has been called with a success,
1607  * this server's stack will not respond to clients querying for this server's presence.
1608  *
1609  * Server can call this function when it is terminating, going offline, or when going
1610  * away from network.
1611  *
1612  * @return
1613  *     OC_STACK_OK      - No errors; Success
1614  */
1615 OCStackResult OCStopPresence()
1616 {
1617     OCStackResult result = OC_STACK_ERROR;
1618     //make resource inactive
1619     result = OCChangeResourceProperty(
1620             &(((OCResource *) presenceResource.handle)->resourceProperties),
1621             OC_ACTIVE, 0);
1622     result = SendPresenceNotification(NULL);
1623
1624     return result;
1625 }
1626 #endif
1627
1628
1629 OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler)
1630 {
1631     defaultDeviceHandler = entityHandler;
1632
1633     return OC_STACK_OK;
1634 }
1635
1636 OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo)
1637 {
1638     OC_LOG(INFO, TAG, PCF("Entering OCSetDeviceInfo"));
1639
1640     if(myStackMode == OC_CLIENT)
1641     {
1642         return OC_STACK_ERROR;
1643     }
1644
1645     return SaveDeviceInfo(deviceInfo);
1646 }
1647
1648 /**
1649  * Create a resource
1650  *
1651  * @param handle - pointer to handle to newly created resource.  Set by ocstack.  Used to refer to resource
1652  * @param resourceTypeName - name of resource type.  Example: "core.led"
1653  * @param resourceInterfaceName - name of resource interface.  Example: "core.rw"
1654  * @param uri - URI of the resource.  Example:  "/a/led"
1655  * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
1656  *                        NULL for default entity handler
1657  * @param resourceProperties - properties supported by resource.  Example: OC_DISCOVERABLE|OC_OBSERVABLE
1658  *
1659  * @return
1660  *     OC_STACK_OK    - no errors
1661  *     OC_STACK_ERROR - stack process error
1662  */
1663 OCStackResult OCCreateResource(OCResourceHandle *handle,
1664         const char *resourceTypeName,
1665         const char *resourceInterfaceName,
1666         const char *uri, OCEntityHandler entityHandler,
1667         uint8_t resourceProperties) {
1668
1669     OCResource *pointer = NULL;
1670     char *str = NULL;
1671     size_t size;
1672     OCStackResult result = OC_STACK_ERROR;
1673
1674     OC_LOG(INFO, TAG, PCF("Entering OCCreateResource"));
1675
1676     if(myStackMode == OC_CLIENT)
1677     {
1678         return result;
1679     }
1680     // Validate parameters
1681     if(!uri || (strlen(uri) == 0))
1682     {
1683         OC_LOG(ERROR, TAG, PCF("URI is invalid"));
1684         return OC_STACK_INVALID_URI;
1685     }
1686     // Is it presented during resource discovery?
1687     if (!handle || !resourceTypeName) {
1688         OC_LOG(ERROR, TAG, PCF("Input parameter is NULL"));
1689         return OC_STACK_INVALID_PARAM;
1690     }
1691
1692     if(!resourceInterfaceName || strlen(resourceInterfaceName) == 0) {
1693         resourceInterfaceName = OC_RSRVD_INTERFACE_DEFAULT;
1694     }
1695
1696     // Make sure resourceProperties bitmask has allowed properties specified
1697     if (resourceProperties
1698             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW | OC_SECURE)) {
1699         OC_LOG(ERROR, TAG, PCF("Invalid property"));
1700         return OC_STACK_INVALID_PARAM;
1701     }
1702
1703     // If the headResource is NULL, then no resources have been created...
1704     pointer = headResource;
1705     if (pointer) {
1706         // At least one resources is in the resource list, so we need to search for
1707         // repeated URLs, which are not allowed.  If a repeat is found, exit with an error
1708         while (pointer) {
1709             if (strcmp(uri, pointer->uri) == 0) {
1710                 OC_LOG(ERROR, TAG, PCF("URI already in use"));
1711                 return OC_STACK_INVALID_PARAM;
1712             }
1713             pointer = pointer->next;
1714         }
1715     }
1716     // Create the pointer and insert it into the resource list
1717     pointer = (OCResource *) OCCalloc(1, sizeof(OCResource));
1718     if (!pointer) {
1719         goto exit;
1720     }
1721     pointer->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER;
1722
1723     insertResource(pointer);
1724
1725     // Set the uri
1726     size = strlen(uri) + 1;
1727     str = (char *) OCMalloc(size);
1728     if (!str) {
1729         goto exit;
1730     }
1731     strncpy(str, uri, size);
1732     pointer->uri = str;
1733
1734     // Set properties.  Set OC_ACTIVE
1735     pointer->resourceProperties = (OCResourceProperty) (resourceProperties
1736             | OC_ACTIVE);
1737
1738     // Add the resourcetype to the resource
1739     result = BindResourceTypeToResource(pointer, resourceTypeName);
1740     if (result != OC_STACK_OK) {
1741         OC_LOG(ERROR, TAG, PCF("Error adding resourcetype"));
1742         goto exit;
1743     }
1744
1745     // Add the resourceinterface to the resource
1746     result = BindResourceInterfaceToResource(pointer, resourceInterfaceName);
1747     if (result != OC_STACK_OK) {
1748         OC_LOG(ERROR, TAG, PCF("Error adding resourceinterface"));
1749         goto exit;
1750     }
1751
1752     // If an entity handler has been passed, attach it to the newly created
1753     // resource.  Otherwise, set the default entity handler.
1754     if (entityHandler)
1755     {
1756         pointer->entityHandler = entityHandler;
1757     }
1758     else
1759     {
1760         pointer->entityHandler = defaultResourceEHandler;
1761     }
1762
1763     *handle = pointer;
1764     result = OC_STACK_OK;
1765
1766     #ifdef WITH_PRESENCE
1767     if(presenceResource.handle)
1768     {
1769         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
1770         SendPresenceNotification(pointer->rsrcType);
1771     }
1772     #endif
1773 exit:
1774     if (result != OC_STACK_OK)
1775     {
1776         // Deep delete of resource and other dynamic elements that it contains
1777         deleteResource(pointer);
1778         OCFree(str);
1779     }
1780     return result;
1781 }
1782
1783
1784
1785 /**
1786  * Create a resource. with host ip address for remote resource
1787  *
1788  * @param handle - pointer to handle to newly created resource.  Set by ocstack.
1789  *                 Used to refer to resource
1790  * @param resourceTypeName - name of resource type.  Example: "core.led"
1791  * @param resourceInterfaceName - name of resource interface.  Example: "core.rw"
1792  * @param host - HOST address of the remote resource.  Example:  "coap://xxx.xxx.xxx.xxx:xxxxx"
1793  * @param uri - URI of the resource.  Example:  "/a/led"
1794  * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
1795  *                        NULL for default entity handler
1796  * @param resourceProperties - properties supported by resource.
1797  *                             Example: OC_DISCOVERABLE|OC_OBSERVABLE
1798  *
1799  * @return
1800  *     OC_STACK_OK    - no errors
1801  *     OC_STACK_ERROR - stack process error
1802  */
1803
1804 OCStackResult OCCreateResourceWithHost(OCResourceHandle *handle,
1805         const char *resourceTypeName,
1806         const char *resourceInterfaceName,
1807         const char *host,
1808         const char *uri,
1809         OCEntityHandler entityHandler,
1810         uint8_t resourceProperties)
1811 {
1812     char *str = NULL;
1813     size_t size;
1814     OCStackResult result = OC_STACK_ERROR;
1815
1816     result = OCCreateResource(handle, resourceTypeName, resourceInterfaceName,
1817                                 uri, entityHandler, resourceProperties);
1818
1819     if (result != OC_STACK_ERROR)
1820     {
1821         // Set the uri
1822         size = strlen(host) + 1;
1823         str = (char *) OCMalloc(size);
1824         if (!str)
1825         {
1826             return OC_STACK_ERROR;
1827         }
1828         strncpy(str, host, size);
1829         ((OCResource *) *handle)->host = str;
1830     }
1831
1832     return result;
1833 }
1834
1835 /**
1836  * Add a resource to a collection resource.
1837  *
1838  * @param collectionHandle - handle to the collection resource
1839  * @param resourceHandle - handle to resource to be added to the collection resource
1840  *
1841  * @return
1842  *     OC_STACK_OK    - no errors
1843  *     OC_STACK_ERROR - stack process error
1844  *     OC_STACK_INVALID_PARAM - invalid collectionhandle
1845  */
1846 OCStackResult OCBindResource(
1847         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle) {
1848     OCResource *resource;
1849     uint8_t i;
1850
1851     OC_LOG(INFO, TAG, PCF("Entering OCBindResource"));
1852
1853     // Validate parameters
1854     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
1855     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
1856     // Container cannot contain itself
1857     if (collectionHandle == resourceHandle) {
1858         OC_LOG(ERROR, TAG, PCF("Added handle equals collection handle"));
1859         return OC_STACK_INVALID_PARAM;
1860     }
1861
1862     // Use the handle to find the resource in the resource linked list
1863     resource = findResource((OCResource *) collectionHandle);
1864     if (!resource) {
1865         OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
1866         return OC_STACK_INVALID_PARAM;
1867     }
1868
1869     // Look for an open slot to add add the child resource.
1870     // If found, add it and return success
1871     for (i = 0; i < MAX_CONTAINED_RESOURCES; i++) {
1872         if (!resource->rsrcResources[i]) {
1873             resource->rsrcResources[i] = (OCResource *) resourceHandle;
1874             OC_LOG(INFO, TAG, PCF("resource bound"));
1875             return OC_STACK_OK;
1876         }
1877     }
1878
1879     #ifdef WITH_PRESENCE
1880     if(presenceResource.handle)
1881     {
1882         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
1883         SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType);
1884     }
1885     #endif
1886
1887     // Unable to add resourceHandle, so return error
1888     return OC_STACK_ERROR;
1889 }
1890
1891 /**
1892  * Remove a resource from a collection resource.
1893  *
1894  * @param collectionHandle - handle to the collection resource
1895  * @param resourceHandle - handle to resource to be added to the collection resource
1896  *
1897  * @return
1898  *     OC_STACK_OK    - no errors
1899  *     OC_STACK_ERROR - stack process error
1900  *     OC_STACK_INVALID_PARAM - invalid collectionHandle
1901  */
1902 OCStackResult OCUnBindResource(
1903         OCResourceHandle collectionHandle, OCResourceHandle resourceHandle) {
1904     OCResource *resource;
1905     uint8_t i;
1906
1907     OC_LOG(INFO, TAG, PCF("Entering OCUnBindResource"));
1908
1909     // Validate parameters
1910     VERIFY_NON_NULL(collectionHandle, ERROR, OC_STACK_ERROR);
1911     VERIFY_NON_NULL(resourceHandle, ERROR, OC_STACK_ERROR);
1912     // Container cannot contain itself
1913     if (collectionHandle == resourceHandle) {
1914         OC_LOG(ERROR, TAG, PCF("removing handle equals collection handle"));
1915         return OC_STACK_INVALID_PARAM;
1916     }
1917
1918     // Use the handle to find the resource in the resource linked list
1919     resource = findResource((OCResource *) collectionHandle);
1920     if (!resource) {
1921         OC_LOG(ERROR, TAG, PCF("Collection handle not found"));
1922         return OC_STACK_INVALID_PARAM;
1923     }
1924
1925     // Look for an open slot to add add the child resource.
1926     // If found, add it and return success
1927     for (i = 0; i < MAX_CONTAINED_RESOURCES; i++) {
1928         if (resourceHandle == resource->rsrcResources[i]) {
1929             resource->rsrcResources[i] = (OCResource *) NULL;
1930             OC_LOG(INFO, TAG, PCF("resource unbound"));
1931             return OC_STACK_OK;
1932         }
1933     }
1934
1935     OC_LOG(INFO, TAG, PCF("resource not found in collection"));
1936
1937     #ifdef WITH_PRESENCE
1938     if(presenceResource.handle)
1939     {
1940         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
1941         SendPresenceNotification(((OCResource *) resourceHandle)->rsrcType);
1942     }
1943     #endif
1944
1945     // Unable to add resourceHandle, so return error
1946     return OC_STACK_ERROR;
1947 }
1948
1949 OCStackResult BindResourceTypeToResource(OCResource* resource,
1950                                             const char *resourceTypeName)
1951 {
1952     OCResourceType *pointer = NULL;
1953     char *str = NULL;
1954     size_t size;
1955     OCStackResult result = OC_STACK_ERROR;
1956
1957     OC_LOG(INFO, TAG, PCF("Entering BindResourceTypeToResource"));
1958
1959     // Validate parameters
1960     VERIFY_NON_NULL(resourceTypeName, ERROR, OC_STACK_INVALID_PARAM);
1961     // TODO:  Does resource attribute resentation really have to be maintained in stack?
1962     // Is it presented during resource discovery?
1963
1964     TODO ("Make sure that the resourcetypename doesn't already exist in the resource");
1965
1966     // Create the resourcetype and insert it into the resource list
1967     pointer = (OCResourceType *) OCCalloc(1, sizeof(OCResourceType));
1968     if (!pointer) {
1969         goto exit;
1970     }
1971
1972     // Set the resourceTypeName
1973     size = strlen(resourceTypeName) + 1;
1974     str = (char *) OCMalloc(size);
1975     if (!str) {
1976         goto exit;
1977     }
1978     strncpy(str, resourceTypeName, size);
1979     pointer->resourcetypename = str;
1980
1981     insertResourceType(resource, pointer);
1982     result = OC_STACK_OK;
1983
1984     exit: if (result != OC_STACK_OK) {
1985         OCFree(pointer);
1986         OCFree(str);
1987     }
1988
1989     return result;
1990 }
1991
1992 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
1993         const char *resourceInterfaceName)
1994 {
1995     OCResourceInterface *pointer = NULL;
1996     char *str = NULL;
1997     size_t size;
1998     OCStackResult result = OC_STACK_ERROR;
1999
2000     OC_LOG(INFO, TAG, PCF("Entering BindResourceInterfaceToResource"));
2001
2002     // Validate parameters
2003     VERIFY_NON_NULL(resourceInterfaceName, ERROR, OC_STACK_INVALID_PARAM);
2004
2005     TODO ("Make sure that the resourceinterface name doesn't already exist in the resource");
2006
2007     // Create the resourceinterface and insert it into the resource list
2008     pointer = (OCResourceInterface *) OCCalloc(1, sizeof(OCResourceInterface));
2009     if (!pointer) {
2010         goto exit;
2011     }
2012
2013     // Set the resourceinterface name
2014     size = strlen(resourceInterfaceName) + 1;
2015     str = (char *) OCMalloc(size);
2016     if (!str) {
2017         goto exit;
2018     }
2019     strncpy(str, resourceInterfaceName, size);
2020     pointer->name = str;
2021
2022     // Bind the resourceinterface to the resource
2023     insertResourceInterface(resource, pointer);
2024
2025     result = OC_STACK_OK;
2026
2027     exit: if (result != OC_STACK_OK) {
2028         OCFree(pointer);
2029         OCFree(str);
2030     }
2031
2032     return result;
2033 }
2034
2035 /**
2036  * Bind a resourcetype to a resource.
2037  *
2038  * @param handle - handle to the resource
2039  * @param resourceTypeName - name of resource type.  Example: "core.led"
2040  *
2041  * @return
2042  *     OC_STACK_OK    - no errors
2043  *     OC_STACK_ERROR - stack process error
2044  */
2045 OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
2046         const char *resourceTypeName) {
2047
2048     OCStackResult result = OC_STACK_ERROR;
2049     OCResource *resource;
2050
2051     // Make sure resource exists
2052     resource = findResource((OCResource *) handle);
2053     if (!resource) {
2054         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2055         return OC_STACK_ERROR;
2056     }
2057
2058     // call internal function
2059     result = BindResourceTypeToResource(resource, resourceTypeName);
2060
2061     #ifdef WITH_PRESENCE
2062     if(presenceResource.handle)
2063     {
2064         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2065         SendPresenceNotification(resource->rsrcType);
2066     }
2067     #endif
2068
2069     return result;
2070 }
2071
2072 /**
2073  * Bind a resourceinterface to a resource.
2074  *
2075  * @param handle - handle to the resource
2076  * @param resourceInterfaceName - name of resource interface.  Example: "oc.mi.b"
2077  *
2078  * @return
2079  *     OC_STACK_OK    - no errors
2080  *     OC_STACK_ERROR - stack process error
2081  */
2082
2083 OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
2084         const char *resourceInterfaceName) {
2085
2086     OCStackResult result = OC_STACK_ERROR;
2087     OCResource *resource;
2088
2089     // Make sure resource exists
2090     resource = findResource((OCResource *) handle);
2091     if (!resource) {
2092         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2093         return OC_STACK_ERROR;
2094     }
2095
2096     // call internal function
2097     result = BindResourceInterfaceToResource(resource, resourceInterfaceName);
2098
2099     #ifdef WITH_PRESENCE
2100     if(presenceResource.handle)
2101     {
2102         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2103         SendPresenceNotification(resource->rsrcType);
2104     }
2105     #endif
2106
2107     return result;
2108 }
2109
2110 /**
2111  * Get the number of resources that have been created in the stack.
2112  *
2113  * @param numResources - pointer to count variable
2114  *
2115  * @return
2116  *     OC_STACK_OK    - no errors
2117  *     OC_STACK_ERROR - stack process error
2118
2119  */
2120 OCStackResult OCGetNumberOfResources(uint8_t *numResources) {
2121     OCResource *pointer = headResource;
2122
2123     OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResources"));
2124     VERIFY_NON_NULL(numResources, ERROR, OC_STACK_INVALID_PARAM);
2125     *numResources = 0;
2126     while (pointer) {
2127         *numResources = *numResources + 1;
2128         pointer = pointer->next;
2129     }
2130     return OC_STACK_OK;
2131 }
2132
2133 /**
2134  * Get a resource handle by index.
2135  *
2136  * @param index - index of resource, 0 to Count - 1
2137  *
2138  * @return
2139  *    Resource handle - if found
2140  *    NULL - if not found
2141  */
2142 OCResourceHandle OCGetResourceHandle(uint8_t index) {
2143     OCResource *pointer = headResource;
2144     uint8_t i = 0;
2145
2146     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceHandle"));
2147
2148     // Iterate through the list
2149     while ((i < index) && pointer) {
2150         i++;
2151         pointer = pointer->next;
2152     }
2153     return (OCResourceHandle) pointer;
2154 }
2155
2156 /**
2157  * Delete resource specified by handle.  Deletes resource and all resourcetype and resourceinterface
2158  * linked lists.
2159  *
2160  * @param handle - handle of resource to be deleted
2161  *
2162  * @return
2163  *     OC_STACK_OK              - no errors
2164  *     OC_STACK_ERROR           - stack process error
2165  *     OC_STACK_NO_RESOURCE     - resource not found
2166  *     OC_STACK_INVALID_PARAM   - invalid param
2167  */
2168 OCStackResult OCDeleteResource(OCResourceHandle handle) {
2169     OC_LOG(INFO, TAG, PCF("Entering OCDeleteResource"));
2170
2171     if (!handle) {
2172         OC_LOG(ERROR, TAG, PCF("Invalid param"));
2173         return OC_STACK_INVALID_PARAM;
2174     }
2175
2176     OCResource *resource = findResource((OCResource *) handle);
2177     if (resource == NULL) {
2178         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2179         return OC_STACK_NO_RESOURCE;
2180     }
2181
2182     if (deleteResource((OCResource *) handle) == 0) {
2183         OC_LOG(ERROR, TAG, PCF("Error deleting resource"));
2184         return OC_STACK_ERROR;
2185     }
2186
2187     return OC_STACK_OK;
2188 }
2189
2190 /**
2191  * Get the URI of the resource specified by handle.
2192  *
2193  * @param handle - handle of resource
2194  * @return
2195  *    URI string - if resource found
2196  *    NULL - resource not found
2197  */
2198 const char *OCGetResourceUri(OCResourceHandle handle) {
2199     OCResource *resource;
2200     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceUri"));
2201
2202     resource = findResource((OCResource *) handle);
2203     if (resource) {
2204         return resource->uri;
2205     }
2206     return (const char *) NULL;
2207 }
2208
2209 /**
2210  * Get the properties of the resource specified by handle.
2211  * NOTE: that after a resource is created, the OC_ACTIVE property is set
2212  * for the resource by the stack.
2213  *
2214  * @param handle - handle of resource
2215  * @return
2216  *    property bitmap - if resource found
2217  *    NULL - resource not found
2218  */
2219 uint8_t OCGetResourceProperties(OCResourceHandle handle) {
2220     OCResource *resource;
2221     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceProperties"));
2222
2223     resource = findResource((OCResource *) handle);
2224     if (resource) {
2225         return resource->resourceProperties;
2226     }
2227     return 0;
2228 }
2229
2230 /**
2231  * Get the number of resource types of the resource.
2232  *
2233  * @param handle - handle of resource
2234  * @param numResourceTypes - pointer to count variable
2235  *
2236  * @return
2237  *     OC_STACK_OK    - no errors
2238  *     OC_STACK_ERROR - stack process error
2239  */
2240 OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle,
2241         uint8_t *numResourceTypes) {
2242     OCResource *resource;
2243     OCResourceType *pointer;
2244
2245     OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResourceTypes"));
2246     VERIFY_NON_NULL(numResourceTypes, ERROR, OC_STACK_INVALID_PARAM);
2247     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2248
2249     *numResourceTypes = 0;
2250
2251     resource = findResource((OCResource *) handle);
2252     if (resource) {
2253         pointer = resource->rsrcType;
2254         while (pointer) {
2255             *numResourceTypes = *numResourceTypes + 1;
2256             pointer = pointer->next;
2257         }
2258     }
2259     return OC_STACK_OK;
2260 }
2261
2262 /**
2263  * Get name of resource type of the resource.
2264  *
2265  * @param handle - handle of resource
2266  * @param index - index of resource, 0 to Count - 1
2267  *
2268  * @return
2269  *    resource type name - if resource found
2270  *    NULL - resource not found
2271  */
2272 const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index) {
2273     OCResourceType *resourceType;
2274
2275     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceTypeName"));
2276
2277     resourceType = findResourceTypeAtIndex(handle, index);
2278     if (resourceType) {
2279         return resourceType->resourcetypename;
2280     }
2281     return (const char *) NULL;
2282 }
2283
2284
2285
2286 /**
2287  * Get the number of resource interfaces of the resource.
2288  *
2289  * @param handle - handle of resource
2290  * @param numResources - pointer to count variable
2291  *
2292  * @return
2293  *     OC_STACK_OK    - no errors
2294  *     OC_STACK_ERROR - stack process error
2295  */
2296 OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
2297         uint8_t *numResourceInterfaces) {
2298     OCResourceInterface *pointer;
2299     OCResource *resource;
2300
2301     OC_LOG(INFO, TAG, PCF("Entering OCGetNumberOfResourceInterfaces"));
2302
2303     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2304     VERIFY_NON_NULL(numResourceInterfaces, ERROR, OC_STACK_INVALID_PARAM);
2305
2306     *numResourceInterfaces = 0;
2307     resource = findResource((OCResource *) handle);
2308     if (resource) {
2309         pointer = resource->rsrcInterface;
2310         while (pointer) {
2311             *numResourceInterfaces = *numResourceInterfaces + 1;
2312             pointer = pointer->next;
2313         }
2314     }
2315     return OC_STACK_OK;
2316 }
2317
2318 /**
2319  * Get name of resource interface of the resource.
2320  *
2321  * @param handle - handle of resource
2322  * @param index - index of resource, 0 to Count - 1
2323  *
2324  * @return
2325  *    resource interface name - if resource found
2326  *    NULL - resource not found
2327  */
2328 const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index) {
2329     OCResourceInterface *resourceInterface;
2330
2331     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceInterfaceName"));
2332
2333     resourceInterface = findResourceInterfaceAtIndex(handle, index);
2334     if (resourceInterface) {
2335         return resourceInterface->name;
2336     }
2337     return (const char *) NULL;
2338 }
2339
2340 /**
2341  * Get resource handle from the collection resource by index.
2342  *
2343  * @param collectionHandle - handle of collection resource
2344  * @param index - index of contained resource, 0 to Count - 1
2345  *
2346  * @return
2347  *    handle to resource - if resource found
2348  *    NULL - resource not found
2349  */
2350 OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
2351         uint8_t index) {
2352     OCResource *resource;
2353
2354     OC_LOG(INFO, TAG, PCF("Entering OCGetContainedResource"));
2355
2356     if (index >= MAX_CONTAINED_RESOURCES) {
2357         return NULL;
2358     }
2359
2360     resource = findResource((OCResource *) collectionHandle);
2361     if (!resource) {
2362         return NULL;
2363     }
2364
2365     return resource->rsrcResources[index];
2366 }
2367
2368 /**
2369  * Bind an entity handler to the resource.
2370  *
2371  * @param handle - handle to the resource that the contained resource is to be bound
2372  * @param entityHandler - entity handler function that is called by ocstack to handle requests, etc
2373  * @return
2374  *     OC_STACK_OK    - no errors
2375  *     OC_STACK_ERROR - stack process error
2376  */
2377 OCStackResult OCBindResourceHandler(OCResourceHandle handle,
2378         OCEntityHandler entityHandler) {
2379     OCResource *resource;
2380
2381     OC_LOG(INFO, TAG, PCF("Entering OCBindResourceHandler"));
2382
2383     // Validate parameters
2384     VERIFY_NON_NULL(handle, ERROR, OC_STACK_INVALID_PARAM);
2385     //VERIFY_NON_NULL(entityHandler, ERROR, OC_STACK_INVALID_PARAM);
2386
2387     // Use the handle to find the resource in the resource linked list
2388     resource = findResource((OCResource *)handle);
2389     if (!resource) {
2390         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2391         return OC_STACK_ERROR;
2392     }
2393
2394     // Bind the handler
2395     resource->entityHandler = entityHandler;
2396
2397     #ifdef WITH_PRESENCE
2398     if(presenceResource.handle)
2399     {
2400         ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2401         SendPresenceNotification(resource->rsrcType);
2402     }
2403     #endif
2404
2405     return OC_STACK_OK;
2406 }
2407
2408 /**
2409  * Get the entity handler for a resource.
2410  *
2411  * @param handle - handle of resource
2412  *
2413  * @return
2414  *    entity handler - if resource found
2415  *    NULL - resource not found
2416  */
2417 OCEntityHandler OCGetResourceHandler(OCResourceHandle handle) {
2418     OCResource *resource;
2419
2420     OC_LOG(INFO, TAG, PCF("Entering OCGetResourceHandler"));
2421
2422     // Use the handle to find the resource in the resource linked list
2423     resource = findResource((OCResource *)handle);
2424     if (!resource) {
2425         OC_LOG(ERROR, TAG, PCF("Resource not found"));
2426         return NULL;
2427     }
2428
2429     // Bind the handler
2430     return resource->entityHandler;
2431 }
2432
2433 void incrementSequenceNumber(OCResource * resPtr)
2434 {
2435     // Increment the sequence number
2436     resPtr->sequenceNum += 1;
2437     if (resPtr->sequenceNum == MAX_SEQUENCE_NUMBER)
2438     {
2439         resPtr->sequenceNum = OC_OFFSET_SEQUENCE_NUMBER+1;
2440     }
2441     return;
2442 }
2443
2444 /**
2445  * Notify Presence subscribers that a resource has been modified
2446  *
2447  * @param resourceType - Handle to the resourceType linked list of resource
2448  *                       that was modified.
2449  * @param qos          - Quality Of Service
2450  *
2451  */
2452 #ifdef WITH_PRESENCE
2453 OCStackResult SendPresenceNotification(OCResourceType *resourceType)
2454 {
2455     OCResource *resPtr = NULL;
2456     OCStackResult result;
2457     OCMethod method = OC_REST_PRESENCE;
2458     uint32_t maxAge = 0;
2459     resPtr = findResource((OCResource *) presenceResource.handle);
2460     if(NULL == resPtr)
2461     {
2462         return OC_STACK_NO_RESOURCE;
2463     }
2464     if((((OCResource *) presenceResource.handle)->resourceProperties) & OC_ACTIVE)
2465     {
2466         maxAge = presenceResource.presenceTTL;
2467     }
2468     else
2469     {
2470         maxAge = 0;
2471     }
2472
2473     result = SendAllObserverNotification(method, resPtr, maxAge, resourceType, OC_LOW_QOS);
2474     return result;
2475 }
2476 #endif // WITH_PRESENCE
2477 /**
2478  * Notify observers that an observed value has changed.
2479  *
2480  * @param handle - handle of resource
2481  *
2482  * @return
2483  *     OC_STACK_OK    - no errors
2484  *     OC_STACK_NO_RESOURCE - invalid resource handle
2485  *     OC_STACK_NO_OBSERVERS - no more observers intrested in resource
2486  */
2487 OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos) {
2488
2489     OC_LOG(INFO, TAG, PCF("Entering OCNotifyAllObservers"));
2490
2491     OCResource *resPtr = NULL;
2492     OCStackResult result;
2493     OCMethod method = OC_REST_NOMETHOD;
2494     uint32_t maxAge = 0;
2495
2496     OC_LOG(INFO, TAG, PCF("Entering OCNotifyAllObservers"));
2497     #ifdef WITH_PRESENCE
2498     if(handle == presenceResource.handle)
2499     {
2500         return OC_STACK_OK;
2501     }
2502     #endif // WITH_PRESENCE
2503     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
2504
2505     // Verify that the resource exists
2506     resPtr = findResource ((OCResource *) handle);
2507     if (NULL == resPtr)
2508     {
2509         return OC_STACK_NO_RESOURCE;
2510     }
2511     else
2512     {
2513         //only increment in the case of regular observing (not presence)
2514         incrementSequenceNumber(resPtr);
2515         method = OC_REST_OBSERVE;
2516         maxAge = MAX_OBSERVE_AGE;
2517         #ifdef WITH_PRESENCE
2518         result = SendAllObserverNotification (method, resPtr, maxAge, NULL, qos);
2519         #else
2520         result = SendAllObserverNotification (method, resPtr, maxAge, qos);
2521         #endif
2522         return result;
2523     }
2524 }
2525
2526 OCStackResult
2527 OCNotifyListOfObservers (OCResourceHandle handle,
2528                          OCObservationId  *obsIdList,
2529                          uint8_t          numberOfIds,
2530                          unsigned char    *notificationJSONPayload,
2531                          OCQualityOfService qos)
2532 {
2533     OC_LOG(INFO, TAG, PCF("Entering OCNotifyListOfObservers"));
2534
2535     OCResource *resPtr = NULL;
2536     //TODO: we should allow the server to define this
2537     uint32_t maxAge = MAX_OBSERVE_AGE;
2538
2539     VERIFY_NON_NULL(handle, ERROR, OC_STACK_ERROR);
2540     VERIFY_NON_NULL(obsIdList, ERROR, OC_STACK_ERROR);
2541     VERIFY_NON_NULL(notificationJSONPayload, ERROR, OC_STACK_ERROR);
2542
2543     // Verify that the resource exists
2544     resPtr = findResource ((OCResource *) handle);
2545     if (NULL == resPtr || myStackMode == OC_CLIENT)
2546     {
2547         return OC_STACK_NO_RESOURCE;
2548     }
2549     else
2550     {
2551         incrementSequenceNumber(resPtr);
2552     }
2553     return (SendListObserverNotification(resPtr, obsIdList, numberOfIds,
2554             notificationJSONPayload, maxAge, qos));
2555 }
2556
2557 /**
2558  * Send a response to a request.
2559  * The response can be a regular, slow, or block (i.e. a response that
2560  * is too large to be sent in a single PDU and must span multiple transmissions)
2561  *
2562  * @param response - pointer to structure that contains response parameters
2563  *
2564  * @return
2565  *     OC_STACK_OK                         - No errors; Success
2566  *     OC_STACK_INVALID_PARAM              - Invalid pointer to OCServerResponse
2567  *     OC_STACK_INVALID_REQUEST_HANDLE     - Request handle not found
2568  *     OC_STACK_PERSISTENT_BUFFER_REQUIRED - Block transfer needed for response, so a
2569  *                                           persistent response buffer is necessary
2570  */
2571 OCStackResult OCDoResponse(OCEntityHandlerResponse *ehResponse)
2572 {
2573     OCStackResult result = OC_STACK_ERROR;
2574     OCServerRequest *serverRequest = NULL;
2575
2576     OC_LOG(INFO, TAG, PCF("Entering OCDoResponse"));
2577
2578     // Validate input parameters
2579     VERIFY_NON_NULL(ehResponse, ERROR, OC_STACK_INVALID_PARAM);
2580     VERIFY_NON_NULL(ehResponse->requestHandle, ERROR, OC_STACK_INVALID_PARAM);
2581
2582     // TODO: Placeholder for creating a response entry when implementing
2583     // block transfer feature
2584
2585     // If a response payload is present, check if block transfer is required
2586     if (ehResponse->payload && OCIsPacketTransferRequired(NULL,
2587             (const char *)ehResponse->payload, ehResponse->payloadSize))
2588     {
2589         OC_LOG(INFO, TAG, PCF("Block transfer required"));
2590
2591         // Persistent response buffer is needed for block transfer
2592         if (!ehResponse->persistentBufferFlag)
2593         {
2594             OC_LOG(WARNING, TAG, PCF("Persistent response buffer required"));
2595             return OC_STACK_PERSISTENT_BUFFER_REQUIRED;
2596         }
2597         // TODO: Placeholder for block transfer handling
2598         // TODO: Placeholder for setting the the response handle in the OCServerResponse struct
2599             // when implementing the block transfer feature
2600     }
2601     else
2602     {
2603         // Normal response
2604
2605         // Get pointer to request info
2606         serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
2607         if(serverRequest)
2608         {
2609             result = serverRequest->ehResponseHandler(ehResponse);
2610         }
2611     }
2612     return result;
2613 }
2614
2615 /**
2616  * Cancel a response.  Applies to a block response
2617  *
2618  * @param responseHandle - response handle set by stack in OCServerResponse after
2619  *                         OCDoResponse is called
2620  *
2621  * @return
2622  *     OC_STACK_OK               - No errors; Success
2623  *     OC_STACK_INVALID_PARAM    - The handle provided is invalid.
2624  */
2625 OCStackResult OCCancelResponse(OCResponseHandle responseHandle)
2626 {
2627     OCStackResult result = OC_STACK_NOTIMPL;
2628
2629     OC_LOG(INFO, TAG, PCF("Entering OCCancelResponse"));
2630
2631     // TODO: validate response handle
2632
2633     return result;
2634 }
2635
2636 //-----------------------------------------------------------------------------
2637 // Private internal function definitions
2638 //-----------------------------------------------------------------------------
2639 /**
2640  * Generate handle of OCDoResource invocation for callback management.
2641  */
2642 static OCDoHandle GenerateInvocationHandle()
2643 {
2644     OCDoHandle handle = NULL;
2645     // Generate token here, it will be deleted when the transaction is deleted
2646     handle = (OCDoHandle) OCMalloc(sizeof(uint8_t[MAX_TOKEN_LENGTH]));
2647     if (handle)
2648     {
2649         OCFillRandomMem((uint8_t*)handle, sizeof(uint8_t[MAX_TOKEN_LENGTH]));
2650     }
2651
2652     return handle;
2653 }
2654 #ifdef WITH_PRESENCE
2655 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
2656         OCResourceProperty resourceProperties, uint8_t enable)
2657 {
2658     if (resourceProperties
2659             > (OC_ACTIVE | OC_DISCOVERABLE | OC_OBSERVABLE | OC_SLOW)) {
2660         OC_LOG(ERROR, TAG, PCF("Invalid property"));
2661         return OC_STACK_INVALID_PARAM;
2662     }
2663     if(!enable)
2664     {
2665         *inputProperty = (OCResourceProperty) (*inputProperty & ~(resourceProperties));
2666     }
2667     else
2668     {
2669         *inputProperty = (OCResourceProperty) (*inputProperty | resourceProperties);
2670     }
2671     return OC_STACK_OK;
2672 }
2673 #endif
2674
2675 /**
2676  * Initialize resource data structures, variables, etc.
2677  */
2678 OCStackResult initResources() {
2679     OCStackResult result = OC_STACK_OK;
2680     // Init application resource vars
2681     headResource = NULL;
2682     // Init Virtual Resources
2683     #ifdef WITH_PRESENCE
2684     presenceResource.presenceTTL = OC_DEFAULT_PRESENCE_TTL;
2685     //presenceResource.token = OCGenerateCoAPToken();
2686     result = OCCreateResource(&presenceResource.handle,
2687             OC_RSRVD_RESOURCE_TYPE_PRESENCE,
2688             "core.r",
2689             OC_PRESENCE_URI,
2690             NULL,
2691             OC_OBSERVABLE);
2692     //make resource inactive
2693     result = OCChangeResourceProperty(
2694             &(((OCResource *) presenceResource.handle)->resourceProperties),
2695             OC_ACTIVE, 0);
2696     #endif
2697     return result;
2698 }
2699
2700 /**
2701  * Add a resource to the end of the linked list of resources.
2702  *
2703  * @param resource - resource to be added
2704  */
2705 void insertResource(OCResource *resource) {
2706     OCResource *pointer;
2707
2708     if (!headResource) {
2709         headResource = resource;
2710     } else {
2711         pointer = headResource;
2712
2713         while (pointer->next) {
2714             pointer = pointer->next;
2715         }
2716         pointer->next = resource;
2717     }
2718     resource->next = NULL;
2719 }
2720
2721 /**
2722  * Find a resource in the linked list of resources.
2723  *
2724  * @param resource - resource to be found
2725  * @return
2726  *     NULL                - resource not found
2727  *     pointer to resource - pointer to resource that was found in the linked list
2728  */
2729 OCResource *findResource(OCResource *resource) {
2730     OCResource *pointer = headResource;
2731
2732     while (pointer) {
2733         if (pointer == resource) {
2734             return resource;
2735         }
2736         pointer = pointer->next;
2737     }
2738     return NULL;
2739 }
2740
2741 void deleteAllResources()
2742 {
2743     OCResource *pointer = headResource;
2744     OCResource *temp;
2745
2746     while (pointer)
2747     {
2748         temp = pointer->next;
2749         #ifdef WITH_PRESENCE
2750         if(pointer != (OCResource *) presenceResource.handle)
2751         {
2752             #endif // WITH_PRESENCE
2753             deleteResource(pointer);
2754             #ifdef WITH_PRESENCE
2755         }
2756         #endif // WITH_PRESENCE
2757         pointer = temp;
2758     }
2759
2760     #ifdef WITH_PRESENCE
2761     // Ensure that the last resource to be deleted is the presence resource. This allows for all
2762     // presence notification attributed to their deletion to be processed.
2763     deleteResource((OCResource *) presenceResource.handle);
2764     #endif // WITH_PRESENCE
2765 }
2766
2767 /**
2768  * Delete the resource from the linked list.
2769  *
2770  * @param resource - resource to be deleted
2771  * @return
2772  *    0 - error
2773  *    1 - success
2774  */
2775 int deleteResource(OCResource *resource) {
2776     OCResource *prev = NULL;
2777     OCResource *temp;
2778
2779     temp = headResource;
2780     while (temp) {
2781         if (temp == resource) {
2782             // Invalidate all Resource Properties.
2783             resource->resourceProperties = (OCResourceProperty) 0;
2784             #ifdef WITH_PRESENCE
2785             if(resource != (OCResource *) presenceResource.handle)
2786             {
2787             #endif // WITH_PRESENCE
2788                 OCNotifyAllObservers((OCResourceHandle)resource, OC_HIGH_QOS);
2789             #ifdef WITH_PRESENCE
2790             }
2791
2792             if(presenceResource.handle)
2793             {
2794                 ((OCResource *)presenceResource.handle)->sequenceNum = OCGetRandom();
2795                 if(resource != (OCResource *) presenceResource.handle)
2796                 {
2797                     SendPresenceNotification(resource->rsrcType);
2798                 }
2799                 else
2800                 {
2801                     SendPresenceNotification(NULL);
2802                 }
2803             }
2804         #endif
2805
2806             if (temp == headResource) {
2807                 headResource = temp->next;
2808             } else {
2809                 prev->next = temp->next;
2810             }
2811
2812             deleteResourceElements(temp);
2813             OCFree(temp);
2814             return 1;
2815         } else {
2816             prev = temp;
2817             temp = temp->next;
2818         }
2819     }
2820
2821     return 0;
2822 }
2823
2824 /**
2825  * Delete all of the dynamically allocated elements that were created for the resource.
2826  *
2827  * @param resource - specified resource
2828  */
2829 void deleteResourceElements(OCResource *resource) {
2830     if (!resource) {
2831         return;
2832     }
2833
2834     // remove URI
2835     OCFree(resource->uri);
2836
2837     // Delete resourcetype linked list
2838     deleteResourceType(resource->rsrcType);
2839
2840     // Delete resourceinterface linked list
2841     deleteResourceInterface(resource->rsrcInterface);
2842 }
2843
2844 /**
2845  * Delete all of the dynamically allocated elements that were created for the resource type.
2846  *
2847  * @param resourceType - specified resource type
2848  */
2849 void deleteResourceType(OCResourceType *resourceType) {
2850     OCResourceType *pointer = resourceType;
2851     OCResourceType *next;
2852
2853     while (pointer) {
2854         next = pointer->next;
2855         OCFree(pointer->resourcetypename);
2856         OCFree(pointer);
2857         pointer = next;
2858     }
2859 }
2860
2861 /**
2862  * Delete all of the dynamically allocated elements that were created for the resource interface.
2863  *
2864  * @param resourceInterface - specified resource interface
2865  */
2866 void deleteResourceInterface(OCResourceInterface *resourceInterface) {
2867     OCResourceInterface *pointer = resourceInterface;
2868     OCResourceInterface *next;
2869
2870     while (pointer) {
2871         next = pointer->next;
2872         OCFree(pointer->name);
2873         OCFree(pointer);
2874         pointer = next;
2875     }
2876 }
2877
2878 /**
2879  * Insert a resource type into a resource's resource type linked list.
2880  *
2881  * @param resource - resource where resource type is to be inserted
2882  * @param resourceType - resource type to be inserted
2883  */
2884 void insertResourceType(OCResource *resource, OCResourceType *resourceType) {
2885     OCResourceType *pointer;
2886
2887     if (resource && !resource->rsrcType) {
2888         resource->rsrcType = resourceType;
2889     } else {
2890         if(resource)
2891         {
2892             pointer = resource->rsrcType;
2893         }
2894         else
2895         {
2896             pointer = resourceType;
2897         }
2898         while (pointer->next) {
2899             pointer = pointer->next;
2900         }
2901         pointer->next = resourceType;
2902     }
2903     resourceType->next = NULL;
2904 }
2905
2906 /**
2907  * Get a resource type at the specified index within a resource.
2908  *
2909  * @param handle - handle of resource
2910  * @param index - index of resource type
2911  *
2912  * @return
2913  *    resourcetype - if found
2914  *    NULL - not found
2915  */
2916 OCResourceType *findResourceTypeAtIndex(OCResourceHandle handle, uint8_t index) {
2917     OCResource *resource;
2918     OCResourceType *pointer;
2919     uint8_t i;
2920
2921     // Find the specified resource
2922     resource = findResource((OCResource *) handle);
2923     if (!resource) {
2924         return NULL;
2925     }
2926
2927     // Make sure a resource has a resourcetype
2928     if (!resource->rsrcType) {
2929         return NULL;
2930     }
2931
2932     // Iterate through the list
2933     pointer = resource->rsrcType;
2934     i = 0;
2935     while ((i < index) && pointer) {
2936         i++;
2937         pointer = pointer->next;
2938     }
2939     return pointer;
2940 }
2941
2942 /**
2943  * Finds a resource type in an OCResourceType link-list.
2944  *
2945  * @param resourceTypeList - the link-list to be searched through
2946  * @param resourceTypeName - the key to search for
2947  *
2948  * @return
2949  *      resourceType that matches the key (ie. resourceTypeName)
2950  *      NULL - either an invalid parameter or this function was unable to find the key.
2951  */
2952 OCResourceType *findResourceType(OCResourceType * resourceTypeList, const char * resourceTypeName)
2953 {
2954     if(resourceTypeList && resourceTypeName)
2955     {
2956         OCResourceType * rtPointer = resourceTypeList;
2957         while(resourceTypeName && rtPointer)
2958         {
2959             if(rtPointer->resourcetypename &&
2960                     strcmp(resourceTypeName, (const char *)
2961                     (rtPointer->resourcetypename)) == 0)
2962             {
2963                 break;
2964             }
2965             rtPointer = rtPointer->next;
2966         }
2967         return rtPointer;
2968     }
2969     return NULL;
2970 }
2971 /**
2972  * Insert a resource interface into a resource's resource interface linked list.
2973  *
2974  * @param resource - resource where resource interface is to be inserted
2975  * @param resourceInterface - resource interface to be inserted
2976  */
2977 void insertResourceInterface(OCResource *resource,
2978         OCResourceInterface *resourceInterface) {
2979     OCResourceInterface *pointer;
2980
2981     if (!resource->rsrcInterface) {
2982         resource->rsrcInterface = resourceInterface;
2983     } else {
2984         pointer = resource->rsrcInterface;
2985         while (pointer->next) {
2986             pointer = pointer->next;
2987         }
2988         pointer->next = resourceInterface;
2989     }
2990     resourceInterface->next = NULL;
2991 }
2992
2993 /**
2994  * Get a resource interface at the specified index within a resource.
2995  *
2996  * @param handle - handle of resource
2997  * @param index - index of resource interface
2998  *
2999  * @return
3000  *    resourceinterface - if found
3001  *    NULL - not found
3002  */
3003 OCResourceInterface *findResourceInterfaceAtIndex(OCResourceHandle handle,
3004         uint8_t index) {
3005     OCResource *resource;
3006     OCResourceInterface *pointer;
3007     uint8_t i = 0;
3008
3009     // Find the specified resource
3010     resource = findResource((OCResource *) handle);
3011     if (!resource) {
3012         return NULL;
3013     }
3014
3015     // Make sure a resource has a resourceinterface
3016     if (!resource->rsrcInterface) {
3017         return NULL;
3018     }
3019
3020     // Iterate through the list
3021     pointer = resource->rsrcInterface;
3022
3023     while ((i < index) && pointer) {
3024         i++;
3025         pointer = pointer->next;
3026     }
3027     return pointer;
3028 }
3029
3030 /**
3031  * Determine if a request/response must be sent in a block transfer because it is too large to be
3032  * sent in a single PDU.  This function can be used for either a request or a response
3033  *
3034  * @param request  - NULL or pointer to request
3035  * @param response - NULL or pointer to response
3036  * @param size     - 0 or size of the request/response.  If 0, strlen is used for determining
3037  *                   the length of the request/response
3038  *
3039  * @return
3040  *    0 - packet transfer NOT required (i.e. normal request/response)
3041  *    1 - packet transfer required (i.e. block transfer needed)
3042  */
3043 uint8_t OCIsPacketTransferRequired(const char *request, const char *response, uint16_t size)
3044 {
3045     uint8_t result = 0;
3046
3047     // Determine if we are checking a request or a response
3048     if (request)
3049     {
3050         // If size is greater than 0, use it for the request size value, otherwise
3051         // assume request is null terminated and use strlen for size value
3052         if ((size > MAX_REQUEST_LENGTH) || (strlen(request) > MAX_REQUEST_LENGTH))
3053         {
3054             result = 1;
3055         }
3056     }
3057     else if (response)
3058     {
3059         // If size is greater than 0, use it for the response size value, otherwise
3060         // assume response is null terminated and use strlen for size value
3061         if ((size > MAX_RESPONSE_LENGTH) || (strlen(response) > MAX_RESPONSE_LENGTH))
3062         {
3063             result = 1;
3064         }
3065     }
3066     return result;
3067 }
3068
3069 /**
3070  * Retrieves a resource type based upon a uri string if the uri string contains only just one
3071  * resource attribute (and that has to be of type "rt").
3072  *
3073  * @remark This API malloc's memory for the resource type and newURI. Do not malloc resourceType
3074  * or newURI before passing in.
3075  *
3076  * @param uri - Valid URI for "requiredUri" parameter to OCDoResource API.
3077  * @param resourceType - The resource type to be populated; pass by reference.
3078  * @param newURI - Return URI without resourceType appended to the end of it. This is used to
3079  *                 ensure that the uri parameter is not modified; pass by reference.
3080  *
3081  * @return
3082  *  OC_STACK_INVALID_URI   - Returns this if the URI is invalid/NULL.
3083  *  OC_STACK_INVALID_PARAM - Returns this if the resourceType parameter is invalid/NULL.
3084  *  OC_STACK_OK            - Success
3085  */
3086 OCStackResult getResourceType(const char * uri, unsigned char** resourceType, char ** newURI)
3087 {
3088     if(!uri)
3089     {
3090         return OC_STACK_INVALID_URI;
3091     }
3092     if(!resourceType || !newURI)
3093     {
3094         return OC_STACK_INVALID_PARAM;
3095     }
3096     char * leftToken = NULL;
3097     char * tempURI = (char *) OCMalloc(strlen(uri) + 1);
3098     if(!tempURI)
3099     {
3100         goto exit;
3101     }
3102     strcpy(tempURI, uri);
3103     char* strTokPtr;
3104     leftToken = strtok_r((char *)tempURI, "?", &strTokPtr);
3105
3106     while(leftToken != NULL)
3107     {
3108         if(strncmp(leftToken, "rt=", 3) == 0)
3109         {
3110             *resourceType = (unsigned char *) OCMalloc(strlen(leftToken)-3);
3111             if(!*resourceType)
3112             {
3113                 goto exit;
3114             }
3115             strcpy((char *)*resourceType, ((const char *)&leftToken[3]));
3116             break;
3117         }
3118         leftToken = strtok_r(NULL, "?", &strTokPtr);
3119     }
3120
3121     *newURI = tempURI;
3122
3123     return OC_STACK_OK;
3124
3125     exit:
3126         return OC_STACK_NO_MEMORY;
3127 }
3128
3129 const ServerID OCGetServerInstanceID(void)
3130 {
3131     static bool generated = false;
3132     static ServerID sid;
3133
3134     if(generated)
3135     {
3136         return sid;
3137     }
3138
3139     sid = OCGetRandom();
3140     generated = true;
3141     return sid;
3142 }
3143
3144 const char* OCGetServerInstanceIDString(void)
3145 {
3146     // max printed length of a base 10
3147     // uint32 is 10 characters, so 11 includes null.
3148     // This will change as the representation gets switched
3149     // to another value
3150     static char buffer[11];
3151     int n = sprintf(buffer, "%u", OCGetServerInstanceID());
3152     if (n < 0)
3153     {
3154         buffer[0]='\0';
3155     }
3156
3157     return buffer;
3158 }