resource/csdk/stack/src/ocserverrequest.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 #include <string.h>
  21
  22 #include "ocstack.h"
  23 #include "ocserverrequest.h"
  24 #include "ocresourcehandler.h"
  25 #include "ocmalloc.h"
  26
  27 #include "cacommon.h"
  28 #include "cainterface.h"
  29
  30 #include "utlist.h"
  31 #include "pdu.h"
  32
  33 // Module Name
  34 #define VERIFY_NON_NULL(arg) { if (!arg) {OC_LOG(FATAL, TAG, #arg " is NULL"); goto exit;} }
  35
  36 #define TAG  PCF("ocserverrequest")
  37
  38 static struct OCServerRequest * serverRequestList = NULL;
  39 static struct OCServerResponse * serverResponseList = NULL;
  40
  41 OCServerRequest * GetServerRequestUsingToken (const CAToken_t token)
  42 {
  43     if(!token)
  44     {
  45         OC_LOG(ERROR, TAG, PCF("Invalid Parameter Token"));
  46         return NULL;
  47     }
  48
  49     OCServerRequest * out = NULL;
  50     LL_FOREACH (serverRequestList, out)
  51     {
  52         OC_LOG(INFO, TAG,PCF("comparing tokens"));
  53         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)token, CA_MAX_TOKEN_LEN);
  54         OC_LOG_BUFFER(INFO, TAG, (const uint8_t *)out->requestToken, CA_MAX_TOKEN_LEN);
  55         if(memcmp(out->requestToken, token, CA_MAX_TOKEN_LEN) == 0)
  56         {
  57             return out;
  58         }
  59     }
  60     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
  61     return NULL;
  62 }
  63
  64 OCServerRequest * GetServerRequestUsingHandle (const OCServerRequest * handle)
  65 {
  66     OCServerRequest * out = NULL;
  67     LL_FOREACH (serverRequestList, out)
  68     {
  69         if(out == handle)
  70         {
  71             return out;
  72         }
  73     }
  74     OC_LOG(ERROR, TAG, PCF("Server Request not found!!"));
  75     return NULL;
  76 }
  77
  78 OCServerResponse * GetServerResponseUsingHandle (const OCServerRequest * handle)
  79 {
  80     OCServerResponse * out = NULL;
  81     LL_FOREACH (serverResponseList, out)
  82     {
  83         if(out->requestHandle == handle)
  84         {
  85             return out;
  86         }
  87     }
  88     OC_LOG(ERROR, TAG, PCF("Server Response not found!!"));
  89     return NULL;
  90 }
  91
  92 OCStackResult AddServerRequest (OCServerRequest ** request, uint16_t coapID,
  93         uint8_t delayedResNeeded, uint8_t secured, uint8_t notificationFlag, OCMethod method,
  94         uint8_t numRcvdVendorSpecificHeaderOptions, uint32_t observationOption,
  95         OCQualityOfService qos, char * query,
  96         OCHeaderOption * rcvdVendorSpecificHeaderOptions,
  97         char * reqJSONPayload, CAToken_t * requestToken,
  98         char * resourceUrl, size_t reqTotalSize,
  99         CAAddress_t *addressInfo, CAConnectivityType_t connectivityType)
 100 {
 101     OCServerRequest * serverRequest = NULL;
 102
 103     //Note: OCServerRequest includes 1 byte for the JSON Payload.  payloadSize is calculated
 104     //as the required length of the string, so this will result in enough room for the
 105     //null terminator as well.
 106     serverRequest = (OCServerRequest *) OCCalloc(1, sizeof(OCServerRequest) +
 107         (reqTotalSize ? reqTotalSize : 1) - 1);
 108     VERIFY_NON_NULL(serverRequest);
 109
 110     serverRequest->coapID = coapID;
 111     serverRequest->delayedResNeeded = delayedResNeeded;
 112     serverRequest->secured = secured;
 113     serverRequest->notificationFlag = notificationFlag;
 114
 115     serverRequest->method = method;
 116     serverRequest->numRcvdVendorSpecificHeaderOptions = numRcvdVendorSpecificHeaderOptions;
 117     serverRequest->observationOption = observationOption;
 118     serverRequest->observeResult = OC_STACK_ERROR;
 119     serverRequest->qos = qos;
 120     serverRequest->ehResponseHandler = HandleSingleResponse;
 121     serverRequest->numResponses = 1;
 122
 123     if(query)
 124     {
 125         strncpy((char*)serverRequest->query,
 126                 (const char*)query, sizeof(serverRequest->query) - 1);
 127     }
 128
 129     if(rcvdVendorSpecificHeaderOptions)
 130     {
 131         memcpy(serverRequest->rcvdVendorSpecificHeaderOptions, rcvdVendorSpecificHeaderOptions,
 132             MAX_HEADER_OPTIONS * sizeof(OCHeaderOption));
 133     }
 134     if(reqJSONPayload && reqTotalSize)
 135     {
 136         // destination is at least 1 greater than the source, so a NULL always exists in the
 137         // last character
 138         strncpy((char*)serverRequest->reqJSONPayload,
 139                 (const char*)reqJSONPayload, reqTotalSize - 1);
 140     }
 141     serverRequest->requestComplete = 0;
 142     if(requestToken)
 143     {
 144         serverRequest->requestToken = (CAToken_t)OCMalloc(CA_MAX_TOKEN_LEN+1);
 145         VERIFY_NON_NULL (serverRequest->requestToken);
 146         memcpy(serverRequest->requestToken, *requestToken, CA_MAX_TOKEN_LEN);
 147         serverRequest->requestToken[CA_MAX_TOKEN_LEN]='\0';
 148     }
 149
 150     if(resourceUrl)
 151     {
 152         strncpy((char*)serverRequest->resourceUrl,
 153                 (const char*)resourceUrl, sizeof(serverRequest->resourceUrl) - 1);
 154     }
 155
 156     if (addressInfo)
 157     {
 158         serverRequest->addressInfo = *addressInfo;
 159     }
 160     serverRequest->connectivityType = connectivityType;
 161
 162     *request = serverRequest;
 163     OC_LOG(INFO, TAG, PCF("Server Request Added!!"));
 164     LL_APPEND (serverRequestList, serverRequest);
 165     return OC_STACK_OK;
 166
 167 exit:
 168     if (serverRequest)
 169     {
 170         OCFree(serverRequest);
 171         serverRequest = NULL;
 172     }
 173     *request = NULL;
 174     return OC_STACK_NO_MEMORY;
 175 }
 176
 177 OCStackResult AddServerResponse (OCServerResponse ** response, OCRequestHandle requestHandle)
 178 {
 179     OCServerResponse * serverResponse = NULL;
 180
 181     serverResponse = (OCServerResponse *) OCCalloc(1, sizeof(OCServerResponse));
 182     VERIFY_NON_NULL(serverResponse);
 183
 184     serverResponse->payload = (char *) OCCalloc(1, MAX_RESPONSE_LENGTH);
 185     VERIFY_NON_NULL(serverResponse->payload);
 186
 187     serverResponse->remainingPayloadSize = MAX_RESPONSE_LENGTH;
 188     serverResponse->requestHandle = requestHandle;
 189
 190     *response = serverResponse;
 191     OC_LOG(INFO, TAG, PCF("Server Response Added!!"));
 192     LL_APPEND (serverResponseList, serverResponse);
 193     return OC_STACK_OK;
 194
 195 exit:
 196     if (serverResponse)
 197     {
 198         OCFree(serverResponse);
 199         serverResponse = NULL;
 200     }
 201     *response = NULL;
 202     return OC_STACK_NO_MEMORY;
 203 }
 204
 205 // Form the OCEntityHandlerRequest struct
 206 OCStackResult FormOCEntityHandlerRequest(
 207         OCEntityHandlerRequest * entityHandlerRequest,
 208         OCRequestHandle request,
 209         OCMethod method,
 210         OCResourceHandle resource,
 211         char * queryBuf,
 212         char * bufReqPayload,
 213         uint8_t numVendorOptions,
 214         OCHeaderOption * vendorOptions,
 215         OCObserveAction observeAction,
 216         OCObservationId observeID)
 217 {
 218     if (entityHandlerRequest)
 219     {
 220         memset(entityHandlerRequest, 0, sizeof(OCEntityHandlerRequest));
 221         entityHandlerRequest->requestHandle = request;
 222         entityHandlerRequest->method = method;
 223         entityHandlerRequest->resource = (OCResourceHandle) resource;
 224         entityHandlerRequest->query = queryBuf;
 225         entityHandlerRequest->reqJSONPayload = bufReqPayload;
 226         entityHandlerRequest->numRcvdVendorSpecificHeaderOptions = numVendorOptions;
 227         entityHandlerRequest->rcvdVendorSpecificHeaderOptions = vendorOptions;
 228
 229         entityHandlerRequest->obsInfo.action = observeAction;
 230         entityHandlerRequest->obsInfo.obsId = observeID;
 231         return OC_STACK_OK;
 232     }
 233
 234     return OC_STACK_INVALID_PARAM;
 235 }
 236
 237 void FindAndDeleteServerResponse(OCServerResponse * serverResponse)
 238 {
 239     OCServerResponse* tmp;
 240     if(serverResponse)
 241     {
 242         LL_FOREACH(serverResponseList, tmp)
 243         {
 244             if (serverResponse == tmp)
 245             {
 246                 DeleteServerResponse(tmp);
 247                 return;
 248             }
 249         }
 250     }
 251 }
 252
 253 void DeleteServerResponse(OCServerResponse * serverResponse)
 254 {
 255     if(serverResponse) {
 256         LL_DELETE(serverResponseList, serverResponse);
 257         OCFree(serverResponse->payload);
 258         OCFree(serverResponse);
 259         OC_LOG(INFO, TAG, PCF("Server Response Removed!!"));
 260     }
 261 }
 262
 263 void FindAndDeleteServerRequest(OCServerRequest * serverRequest)
 264 {
 265     OCServerRequest* tmp;
 266     if(serverRequest)
 267     {
 268         LL_FOREACH(serverRequestList, tmp)
 269         {
 270             if (serverRequest == tmp)
 271             {
 272                 DeleteServerRequest(tmp);
 273                 return;
 274             }
 275         }
 276     }
 277 }
 278
 279 void DeleteServerRequest(OCServerRequest * serverRequest)
 280 {
 281     if(serverRequest) {
 282         LL_DELETE(serverRequestList, serverRequest);
 283         OCFree(serverRequest);
 284         serverRequest = NULL;
 285         OC_LOG(INFO, TAG, PCF("Server Request Removed!!"));
 286     }
 287 }
 288
 289 OCStackResult HandleSingleResponse(OCEntityHandlerResponse * ehResponse)
 290 {
 291     OCStackResult result = OC_STACK_ERROR;
 292     CARemoteEndpoint_t responseEndpoint = {};
 293     CAResponseInfo_t responseInfo = {};
 294     CAHeaderOption_t* optionsPointer;
 295
 296     OC_LOG_V(INFO, TAG, "Inside HandleSingleResponse: %s", ehResponse->payload);
 297
 298     OCServerRequest *serverRequest = (OCServerRequest *)ehResponse->requestHandle;
 299
 300     // Copy the address
 301     responseEndpoint.resourceUri      = (CAURI_t) serverRequest->resourceUrl;
 302     responseEndpoint.addressInfo      = serverRequest->addressInfo;
 303     responseEndpoint.connectivityType = serverRequest->connectivityType;
 304     responseEndpoint.isSecured        = serverRequest->secured;
 305
 306     // Copy the info
 307     switch (ehResponse->ehResult)
 308     {
 309         case OC_EH_OK:
 310             responseInfo.result = CA_SUCCESS;
 311             break;
 312         case OC_EH_ERROR:
 313             responseInfo.result = CA_BAD_REQ;
 314             break;
 315         case OC_EH_RESOURCE_CREATED:
 316             responseInfo.result = CA_CREATED;
 317             break;
 318         case OC_EH_RESOURCE_DELETED:
 319             responseInfo.result = CA_DELETED;
 320             break;
 321         case OC_EH_SLOW:
 322             responseInfo.result = CA_SUCCESS;
 323             break;
 324         case OC_EH_FORBIDDEN:
 325             responseInfo.result = CA_BAD_REQ;
 326             break;
 327         default:
 328             responseInfo.result = CA_BAD_REQ;
 329             break;
 330     }
 331
 332     switch (serverRequest->qos)
 333     {
 334         case OC_LOW_QOS:
 335             responseInfo.info.type = CA_MSG_NONCONFIRM;
 336             break;
 337         case OC_MEDIUM_QOS:
 338             responseInfo.info.type = CA_MSG_NONCONFIRM;
 339             break;
 340         case OC_HIGH_QOS:
 341             responseInfo.info.type = CA_MSG_CONFIRM;
 342             break;
 343         case OC_NA_QOS:
 344             responseInfo.info.type = CA_MSG_NONCONFIRM;
 345             break;
 346         default:
 347             responseInfo.info.type = CA_MSG_NONCONFIRM;
 348             break;
 349     }
 350
 351     responseInfo.info.token = (CAToken_t)OCCalloc(1, CA_MAX_TOKEN_LEN+1);
 352     if (!responseInfo.info.token)
 353     {
 354         OC_LOG(FATAL, TAG, "Response Info Token is NULL");
 355         return result;
 356     }
 357     memcpy(responseInfo.info.token, serverRequest->requestToken, CA_MAX_TOKEN_LEN);
 358
 359     if(serverRequest->observeResult == OC_STACK_OK)
 360     {
 361         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions + 1;
 362     }
 363     else
 364     {
 365         responseInfo.info.numOptions = ehResponse->numSendVendorSpecificHeaderOptions;
 366     }
 367
 368     responseInfo.info.options = (CAHeaderOption_t *)
 369                                   OCMalloc(sizeof(CAHeaderOption_t) * responseInfo.info.numOptions);
 370
 371     optionsPointer = responseInfo.info.options;
 372
 373     // TODO: This exposes CoAP specific details.  At some point, this should be
 374     // re-factored and handled in the CA layer.
 375     if(serverRequest->observeResult == OC_STACK_OK)
 376     {
 377         responseInfo.info.options[0].protocolID = CA_COAP_ID;
 378         responseInfo.info.options[0].optionID = COAP_OPTION_OBSERVE;
 379         responseInfo.info.options[0].optionLength = sizeof(uint32_t);
 380         memcpy(responseInfo.info.options[0].optionData,
 381                 &(serverRequest->observationOption), sizeof(uint32_t));
 382
 383         // Point to the next header option before copying vender specific header options
 384         optionsPointer += 1;
 385     }
 386
 387     if (ehResponse->numSendVendorSpecificHeaderOptions)
 388     {
 389         memcpy(optionsPointer, ehResponse->sendVendorSpecificHeaderOptions,
 390                         sizeof(OCHeaderOption) * ehResponse->numSendVendorSpecificHeaderOptions);
 391     }
 392
 393     // Allocate memory for the payload.
 394     char *payload = (char *)OCCalloc(1, MAX_RESPONSE_LENGTH);
 395     if(!payload)
 396     {
 397         return OC_STACK_NO_MEMORY;
 398     }
 399
 400     // Put the JSON prefix and suffix around the payload
 401     strcpy(payload, (const char *)OC_JSON_PREFIX);
 402     strcat(payload, (const char *)ehResponse->payload);
 403     strcat(payload, (const char *)OC_JSON_SUFFIX);
 404     responseInfo.info.payload = (CAPayload_t)payload;
 405
 406     #ifdef WITH_PRESENCE
 407     //TODO: Add other connectivity types to CAConnTypes[] when enabled
 408     CAConnectivityType_t CAConnTypes[] = {CA_ETHERNET, CA_WIFI};
 409     const char * connTypes[] = {"ethernet", "wifi"};
 410     int size = sizeof(CAConnTypes)/ sizeof(CAConnectivityType_t);
 411     CAConnectivityType_t connType = responseEndpoint.connectivityType;
 412     CAResult_t caResult = CA_STATUS_FAILED;
 413     result = OC_STACK_OK;
 414
 415     //Sending response on all n/w interfaces
 416     for(int i = 0; i < size; i++ )
 417     {
 418         responseEndpoint.connectivityType = (CAConnectivityType_t)(connType & CAConnTypes[i]);
 419         if(responseEndpoint.connectivityType)
 420         {
 421             //The result is set to OC_STACK_OK only if CASendResponse succeeds in sending the
 422             //response on all the n/w interfaces else it is set to OC_STACK_ERROR
 423             caResult = CASendResponse(&responseEndpoint, &responseInfo);
 424             if(caResult != CA_STATUS_OK)
 425             {
 426                 OC_LOG_V(ERROR, TAG, "CASendResponse failed on %s", connTypes[i]);
 427                 result = OC_STACK_ERROR;
 428             }
 429             else
 430             {
 431                 OC_LOG_V(INFO, TAG, "CASendResponse succeeded on %s", connTypes[i]);
 432             }
 433         }
 434     }
 435     #else
 436     CAResult_t caResult = CASendResponse(&responseEndpoint, &responseInfo);
 437     if(caResult != CA_STATUS_OK)
 438     {
 439         OC_LOG(ERROR, TAG, PCF("CASendResponse failed"));
 440     }
 441     else
 442     {
 443         result = OC_STACK_OK;
 444     }
 445     #endif
 446
 447     OCFree(payload);
 448     //Delete the request
 449     FindAndDeleteServerRequest(serverRequest);
 450     return result;
 451 }
 452
 453 OCStackResult HandleAggregateResponse(OCEntityHandlerResponse * ehResponse)
 454 {
 455     OCStackResult stackRet = OC_STACK_ERROR;
 456     OCServerRequest * serverRequest = NULL;
 457     OCServerResponse * serverResponse = NULL;
 458     uint16_t bufferNeeded = 0;
 459
 460     if(!ehResponse || !ehResponse->payload)
 461     {
 462         OC_LOG(ERROR, TAG, PCF("HandleAggregateResponse invalid parameters"));
 463         return OC_STACK_INVALID_PARAM;
 464     }
 465
 466     OC_LOG_V(INFO, TAG, "Inside HandleAggregateResponse: %s", ehResponse->payload);
 467
 468     serverRequest = GetServerRequestUsingHandle((OCServerRequest *)ehResponse->requestHandle);
 469     serverResponse = GetServerResponseUsingHandle((OCServerRequest *)ehResponse->requestHandle);
 470
 471     if(serverRequest)
 472     {
 473         if(!serverResponse)
 474         {
 475             OC_LOG(INFO, TAG, PCF("This is the first response fragment"));
 476             stackRet = AddServerResponse(&serverResponse, ehResponse->requestHandle);
 477             if (OC_STACK_OK != stackRet)
 478             {
 479                 OC_LOG(ERROR, TAG, PCF("Error adding server response"));
 480                 return stackRet;
 481             }
 482             VERIFY_NON_NULL(serverResponse);
 483             VERIFY_NON_NULL(serverResponse->payload);
 484         }
 485
 486         // If there is more than 1 response, then we need to allow for a null-termination
 487         // in the server response payload buffer AND the JSON response separator
 488         bufferNeeded = ehResponse->payloadSize + 1;
 489         if (serverRequest->numResponses > 1)
 490         {
 491             bufferNeeded += strlen(OC_JSON_SEPARATOR_STR);
 492         }
 493         if(serverResponse->remainingPayloadSize >= bufferNeeded)
 494         {
 495             OC_LOG(ERROR, TAG, PCF("There is room in response buffer"));
 496             // append
 497             strncat((char *)serverResponse->payload,
 498                     (char *)ehResponse->payload,
 499                     serverResponse->remainingPayloadSize);
 500             OC_LOG_V(INFO, TAG, "Current aggregated response  ...%s", serverResponse->payload);
 501             serverResponse->remainingPayloadSize -= strlen((char *)ehResponse->payload);
 502             (serverRequest->numResponses)--;
 503             if(serverRequest->numResponses == 0)
 504             {
 505                 OC_LOG(INFO, TAG, PCF("This is the last response fragment"));
 506                 ehResponse->payload = serverResponse->payload;
 507                 ehResponse->payloadSize = strlen((char *) serverResponse->payload) + 1;
 508                 stackRet = HandleSingleResponse(ehResponse);
 509                 //Delete the request and response
 510                 FindAndDeleteServerRequest(serverRequest);
 511                 FindAndDeleteServerResponse(serverResponse);
 512             }
 513             else
 514             {
 515                 OC_LOG(INFO, TAG, PCF("More response fragments to come"));
 516                 strncat((char *)serverResponse->payload,
 517                         OC_JSON_SEPARATOR_STR,
 518                         serverResponse->remainingPayloadSize);
 519                 OC_LOG_V(INFO, TAG, "Current aggregated response  ...%s", serverResponse->payload);
 520                 serverResponse->remainingPayloadSize -= strlen(OC_JSON_SEPARATOR_STR);
 521                 stackRet = OC_STACK_OK;
 522             }
 523         }
 524         else
 525         {
 526             OC_LOG(ERROR, TAG, PCF("No room in response buffer"));
 527             //Delete the request and response
 528             FindAndDeleteServerRequest(serverRequest);
 529             FindAndDeleteServerResponse(serverResponse);
 530             stackRet = OC_STACK_NO_MEMORY;
 531         }
 532     }
 533 exit:
 534     return stackRet;
 535 }
 536