resource/csdk/stack/src/ocpayloadconvert.c

   1 //******************************************************************
   2 //
   3 // Copyright 2015 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 #include "ocpayloadcbor.h"
  22 #include "platform_features.h"
  23 #include <stdlib.h>
  24 #include "oic_malloc.h"
  25 #include "oic_string.h"
  26 #include "logger.h"
  27 #include "ocpayload.h"
  28 #include "ocrandom.h"
  29 #include "ocresourcehandler.h"
  30 #include "cbor.h"
  31 #include "rdpayload.h"
  32
  33 #define TAG "OIC_RI_PAYLOADCONVERT"
  34
  35 // Arbitrarily chosen size that seems to contain the majority of packages
  36 #define INIT_SIZE (255)
  37
  38 // This is six times of the init_size to handle MAX payload.
  39 #define MAX_SIZE (1530)
  40
  41 // Discovery Links Map Length.
  42 #define LINKS_MAP_LEN 4
  43
  44 // Functions all return either a CborError, or a negative version of the OC_STACK return values
  45 static int64_t OCConvertPayloadHelper(OCPayload *payload, uint8_t *outPayload, size_t *size);
  46 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
  47         size_t *size);
  48 static int64_t OCConvertDevicePayload(OCDevicePayload *payload, uint8_t *outPayload,
  49         size_t *size);
  50 static int64_t OCConvertPlatformPayload(OCPlatformPayload *payload, uint8_t *outPayload,
  51         size_t *size);
  52 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size);
  53 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload);
  54 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
  55         size_t *size);
  56 static int64_t OCConvertSecurityPayload(OCSecurityPayload *payload, uint8_t *outPayload,
  57         size_t *size);
  58 static int64_t OCConvertSingleRepPayload(CborEncoder *parent, const OCRepPayload *payload);
  59 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray);
  60
  61 static int64_t AddTextStringToMap(CborEncoder *map, const char *key, size_t keylen,
  62         const char *value);
  63 static int64_t ConditionalAddTextStringToMap(CborEncoder *map, const char *key, size_t keylen,
  64         const char *value);
  65
  66 OCStackResult OCConvertPayload(OCPayload* payload, uint8_t** outPayload, size_t* size)
  67 {
  68     // TinyCbor Version 47a78569c0 or better on master is required for the re-allocation
  69     // strategy to work.  If you receive the following assertion error, please do a git-pull
  70     // from the extlibs/tinycbor/tinycbor directory
  71     #define CborNeedsUpdating  (CborErrorOutOfMemory < CborErrorDataTooLarge)
  72     OC_STATIC_ASSERT(!CborNeedsUpdating, "tinycbor needs to be updated to at least 47a78569c0");
  73     #undef CborNeedsUpdating
  74
  75     OCStackResult ret = OC_STACK_INVALID_PARAM;
  76     int64_t err;
  77     uint8_t *out = NULL;
  78     size_t curSize = INIT_SIZE;
  79
  80     VERIFY_PARAM_NON_NULL(TAG, payload, "Input param, payload is NULL");
  81     VERIFY_PARAM_NON_NULL(TAG, outPayload, "OutPayload parameter is NULL");
  82     VERIFY_PARAM_NON_NULL(TAG, size, "size parameter is NULL");
  83
  84     OIC_LOG_V(INFO, TAG, "Converting payload of type %d", payload->type);
  85
  86     out = (uint8_t *)OICCalloc(1, curSize);
  87     VERIFY_PARAM_NON_NULL(TAG, out, "Failed to allocate payload");
  88     err = OCConvertPayloadHelper(payload, out, &curSize);
  89     ret = OC_STACK_NO_MEMORY;
  90
  91     if (err == CborErrorOutOfMemory)
  92     {
  93         // reallocate "out" and try again!
  94         uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
  95         VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
  96         out = out2;
  97         err = OCConvertPayloadHelper(payload, out, &curSize);
  98         while (err == CborErrorOutOfMemory && curSize < MAX_SIZE)
  99         {
 100             uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
 101             VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
 102             out = out2;
 103             err = OCConvertPayloadHelper(payload, out, &curSize);
 104         }
 105     }
 106
 107     if (err == CborNoError)
 108     {
 109         if (curSize < INIT_SIZE && PAYLOAD_TYPE_SECURITY != payload->type)
 110         {
 111             uint8_t *out2 = (uint8_t *)OICRealloc(out, curSize);
 112             VERIFY_PARAM_NON_NULL(TAG, out2, "Failed to increase payload size");
 113             out = out2;
 114         }
 115
 116         *size = curSize;
 117         *outPayload = out;
 118         OIC_LOG_V(DEBUG, TAG, "Payload Size: %zd Payload : %s \n", *size, *outPayload);
 119         return OC_STACK_OK;
 120     }
 121
 122     //TODO: Proper conversion from CborError to OCStackResult.
 123     ret = (OCStackResult)-err;
 124
 125 exit:
 126     OICFree(out);
 127     return ret;
 128 }
 129
 130 static int64_t OCConvertPayloadHelper(OCPayload* payload, uint8_t* outPayload, size_t* size)
 131 {
 132     switch(payload->type)
 133     {
 134         case PAYLOAD_TYPE_DISCOVERY:
 135             return OCConvertDiscoveryPayload((OCDiscoveryPayload*)payload, outPayload, size);
 136         case PAYLOAD_TYPE_DEVICE:
 137             return OCConvertDevicePayload((OCDevicePayload*)payload, outPayload, size);
 138         case PAYLOAD_TYPE_PLATFORM:
 139             return OCConvertPlatformPayload((OCPlatformPayload*)payload, outPayload, size);
 140         case PAYLOAD_TYPE_REPRESENTATION:
 141             return OCConvertRepPayload((OCRepPayload*)payload, outPayload, size);
 142         case PAYLOAD_TYPE_PRESENCE:
 143             return OCConvertPresencePayload((OCPresencePayload*)payload, outPayload, size);
 144         case PAYLOAD_TYPE_SECURITY:
 145             return OCConvertSecurityPayload((OCSecurityPayload*)payload, outPayload, size);
 146         case PAYLOAD_TYPE_RD:
 147             return OCRDPayloadToCbor((OCRDPayload*)payload, outPayload, size);
 148         default:
 149             OIC_LOG_V(INFO,TAG, "ConvertPayload default %d", payload->type);
 150             return CborErrorUnknownType;
 151     }
 152 }
 153
 154 static int64_t checkError(int64_t err, CborEncoder* encoder, uint8_t* outPayload, size_t* size)
 155 {
 156     if (err == CborErrorOutOfMemory)
 157     {
 158         *size += encoder->ptr - encoder->end;
 159         return err;
 160     }
 161     else if (err != CborNoError)
 162     {
 163         OIC_LOG_V(ERROR, TAG, "Convert Payload failed : %s", cbor_error_string(err));
 164         return err;
 165     }
 166     else
 167     {
 168         *size = encoder->ptr - outPayload;
 169         return err;
 170     }
 171 }
 172
 173 static int64_t OCConvertSecurityPayload(OCSecurityPayload* payload, uint8_t* outPayload,
 174         size_t* size)
 175 {
 176     if (*size < payload->payloadSize)
 177     {
 178         uint8_t *out2 = (uint8_t *)OICRealloc(outPayload, payload->payloadSize);
 179         if (!out2)
 180         {
 181             OICFree(outPayload);
 182             return CborErrorOutOfMemory;
 183         }
 184         outPayload = out2;
 185     }
 186
 187     memcpy(outPayload, payload->securityData1, payload->payloadSize);
 188     *size = payload->payloadSize;
 189
 190     return CborNoError;
 191 }
 192
 193 static char* OCStringLLJoin(OCStringLL* val)
 194 {
 195     OCStringLL* temp = val;
 196     size_t size = strlen(temp->value);
 197
 198     while (temp->next)
 199     {
 200         ++size;
 201         temp = temp->next;
 202         size += strlen(temp->value);
 203     }
 204
 205     char* joinedStr = (char*)OICCalloc(sizeof(char), size + 1);
 206
 207     if (!joinedStr)
 208     {
 209         return NULL;
 210     }
 211
 212     OICStrcat(joinedStr, size + 1, val->value);
 213     while (val->next)
 214     {
 215         val = val->next;
 216         OICStrcat(joinedStr, size + 1, " ");
 217         OICStrcat(joinedStr, size + 1, val->value);
 218     }
 219     return joinedStr;
 220 }
 221
 222 static int64_t OCConvertDiscoveryPayload(OCDiscoveryPayload *payload, uint8_t *outPayload,
 223         size_t *size)
 224 {
 225     CborEncoder encoder;
 226     int64_t err = CborNoError;
 227
 228     cbor_encoder_init(&encoder, outPayload, *size, 0);
 229
 230     if (payload->resources)
 231     {
 232         /*
 233         The format for the payload is "modelled" as JSON.
 234
 235         [                                                       // rootArray
 236             {                                                   // rootMap
 237                 "di" : UUID,                                    // device ID
 238                 links :[                                        // linksArray contains maps of resources
 239                             {
 240                                 href, rt, if, policy            // Resource 1
 241                             },
 242                             {
 243                                 href, rt, if, policy            // Resource 2
 244                             },
 245                             .
 246                             .
 247                             .
 248                         ]
 249             }
 250         ]
 251         */
 252         // Open the main root array
 253         CborEncoder rootArray;
 254         size_t resourceCount =  OCDiscoveryPayloadGetResourceCount(payload);
 255         err |= cbor_encoder_create_array(&encoder, &rootArray, 1);
 256         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery root array");
 257
 258         // Open the root map in the root array
 259         CborEncoder rootMap;
 260         err |= cbor_encoder_create_map(&rootArray, &rootMap, CborIndefiniteLength);
 261         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating discovery map");
 262
 263         // Insert Device ID into the root map
 264         err |= AddTextStringToMap(&rootMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1, payload->sid);
 265         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting device id");
 266
 267         // Insert baseURI if present
 268         err |= ConditionalAddTextStringToMap(&rootMap, OC_RSRVD_BASE_URI,
 269                                             sizeof(OC_RSRVD_BASE_URI) - 1,
 270                                             payload->baseURI);
 271         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting baseURI");
 272
 273         // Insert Links into the root map.
 274         CborEncoder linkArray;
 275         err |= cbor_encode_text_string(&rootMap, OC_RSRVD_LINKS, sizeof(OC_RSRVD_LINKS) - 1);
 276         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array tag");
 277         err |= cbor_encoder_create_array(&rootMap, &linkArray, resourceCount);
 278         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting links array");
 279
 280         for(size_t i = 0; i < resourceCount; ++i)
 281         {
 282             CborEncoder linkMap;
 283             OCResourcePayload *resource = OCDiscoveryPayloadGetResource(payload, i);
 284             VERIFY_PARAM_NON_NULL(TAG, resource, "Failed retrieving resource");
 285
 286             // resource map inside the links array.
 287             err |= cbor_encoder_create_map(&linkArray, &linkMap, LINKS_MAP_LEN);
 288             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating links map");
 289
 290             // Below are insertions of the resource properties into the map.
 291             // Uri
 292             err |= AddTextStringToMap(&linkMap, OC_RSRVD_HREF, sizeof(OC_RSRVD_HREF) - 1,
 293                     resource->uri);
 294             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding uri to links map");
 295
 296             // Resource Type
 297             if (resource->types)
 298             {
 299                 err |= cbor_encode_text_string(&linkMap, OC_RSRVD_RESOURCE_TYPE,
 300                         sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
 301                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource types tag to links map");
 302                 char *joinedTypes = OCStringLLJoin(resource->types);
 303                 VERIFY_PARAM_NON_NULL(TAG, joinedTypes, "Failed creating joined string");
 304                 err |= cbor_encode_text_string(&linkMap, joinedTypes, strlen(joinedTypes));
 305                 OICFree(joinedTypes);
 306                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource types value to links map");
 307             }
 308             // Interface Types
 309             if (resource->interfaces)
 310             {
 311                 err |= cbor_encode_text_string(&linkMap, OC_RSRVD_INTERFACE,
 312                         sizeof(OC_RSRVD_INTERFACE) - 1);
 313                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interfaces tag to links map");
 314                 char* joinedInterfaces = OCStringLLJoin(resource->interfaces);
 315                 VERIFY_PARAM_NON_NULL(TAG, joinedInterfaces, "Failed creating joined string");
 316                 err |= cbor_encode_text_string(&linkMap, joinedInterfaces, strlen(joinedInterfaces));
 317                 OICFree(joinedInterfaces);
 318                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding interfaces value to links map");
 319             }
 320
 321             // Policy
 322             CborEncoder policyMap;
 323             err |= cbor_encode_text_string(&linkMap, OC_RSRVD_POLICY, sizeof(OC_RSRVD_POLICY) - 1);
 324             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy tag to links map");
 325             err |= cbor_encoder_create_map(&linkMap, &policyMap, CborIndefiniteLength);
 326             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding policy map to links map");
 327
 328             // Bitmap
 329             err |=  cbor_encode_text_string(&policyMap, OC_RSRVD_BITMAP, sizeof(OC_RSRVD_BITMAP) - 1);
 330             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap tag to policy map");
 331             err |= cbor_encode_uint(&policyMap, resource->bitmap);
 332             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding bitmap value to policy map");
 333
 334             if (resource->secure)
 335             {
 336                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_SECURE,
 337                         sizeof(OC_RSRVD_SECURE) - 1);
 338                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure tag to policy map");
 339                 err |= cbor_encode_boolean(&policyMap, OC_RESOURCE_SECURE);
 340                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure value to policy map");
 341             }
 342             if ((resource->secure && resource->port != 0) || payload->baseURI)
 343             {
 344                 err |= cbor_encode_text_string(&policyMap, OC_RSRVD_HOSTING_PORT,
 345                         sizeof(OC_RSRVD_HOSTING_PORT) - 1);
 346                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port tag");
 347                 err |= cbor_encode_uint(&policyMap, resource->port);
 348                 VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding secure port value");
 349             }
 350
 351             err |= cbor_encoder_close_container(&linkMap, &policyMap);
 352             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing policy map");
 353
 354             // Finsihed encoding a resource, close the map.
 355             err |= cbor_encoder_close_container(&linkArray, &linkMap);
 356             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link map");
 357         }
 358         // Close links array inside the root map.
 359         err |= cbor_encoder_close_container(&rootMap, &linkArray);
 360         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing link array");
 361         // close root map inside the root array.
 362         err |= cbor_encoder_close_container(&rootArray, &rootMap);
 363         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 364         // Close the final root array.
 365         err |= cbor_encoder_close_container(&encoder, &rootArray);
 366         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 367     }
 368
 369 exit:
 370     return checkError(err, &encoder, outPayload, size);
 371 }
 372
 373 static int64_t OCConvertDevicePayload(OCDevicePayload *payload, uint8_t *outPayload,
 374         size_t *size)
 375 {
 376     int64_t err = CborNoError;
 377     CborEncoder encoder;
 378
 379     cbor_encoder_init(&encoder, outPayload, *size, 0);
 380     CborEncoder repMap;
 381     err |= cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
 382     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating device map");
 383
 384     // Device ID
 385     err |= AddTextStringToMap(&repMap, OC_RSRVD_DEVICE_ID, sizeof(OC_RSRVD_DEVICE_ID) - 1 , payload->sid);
 386     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding device id");
 387
 388     // Device Name
 389     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DEVICE_NAME,
 390             sizeof(OC_RSRVD_DEVICE_NAME) - 1, payload->deviceName);
 391     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding device name");
 392
 393     // Device Spec Version
 394     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SPEC_VERSION,
 395             sizeof(OC_RSRVD_SPEC_VERSION) - 1, payload->specVersion);
 396     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data spec version");
 397
 398     // Device data Model Version
 399     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_DATA_MODEL_VERSION,
 400             sizeof(OC_RSRVD_DATA_MODEL_VERSION) - 1, payload->dataModelVersion);
 401     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding data model version");
 402
 403     err |= cbor_encoder_close_container(&encoder, &repMap);
 404     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing device map");
 405
 406 exit:
 407     return checkError(err, &encoder, outPayload, size);
 408 }
 409
 410 static int64_t OCConvertPlatformPayload(OCPlatformPayload *payload, uint8_t *outPayload,
 411         size_t *size)
 412 {
 413     int64_t err = CborNoError;
 414     CborEncoder encoder;
 415
 416     cbor_encoder_init(&encoder, outPayload, *size, 0);
 417
 418     CborEncoder repMap;
 419     err |= cbor_encoder_create_map(&encoder, &repMap, CborIndefiniteLength);
 420     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating platform map");
 421
 422     // Platform ID
 423     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_ID,
 424             sizeof(OC_RSRVD_PLATFORM_ID) - 1, payload->info.platformID);
 425     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform id");
 426
 427     // MFG Name
 428     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_NAME,
 429         sizeof(OC_RSRVD_MFG_NAME) - 1, payload->info.manufacturerName);
 430     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg name");
 431
 432     // MFG Url
 433     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_URL,
 434         sizeof(OC_RSRVD_MFG_URL) - 1, payload->info.manufacturerUrl);
 435     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg url");
 436
 437     // Model Num
 438     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MODEL_NUM,
 439             sizeof(OC_RSRVD_MODEL_NUM) -1, payload->info.modelNumber);
 440     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding model num");
 441
 442     // Date of Mfg
 443     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_MFG_DATE,
 444             sizeof(OC_RSRVD_MFG_DATE) - 1, payload->info.dateOfManufacture);
 445     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding mfg date");
 446
 447     // Platform Version
 448     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_PLATFORM_VERSION,
 449             sizeof(OC_RSRVD_PLATFORM_VERSION) - 1, payload->info.platformVersion);
 450     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform version");
 451
 452     // OS Version
 453     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_OS_VERSION,
 454             sizeof(OC_RSRVD_OS_VERSION) - 1, payload->info.operatingSystemVersion);
 455     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding OS version");
 456
 457     // Hardware Version
 458     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_HARDWARE_VERSION,
 459             sizeof(OC_RSRVD_HARDWARE_VERSION) - 1, payload->info.hardwareVersion);
 460     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding HW version");
 461
 462     // Firmware Version
 463     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_FIRMWARE_VERSION,
 464             sizeof(OC_RSRVD_FIRMWARE_VERSION) - 1, payload->info.firmwareVersion);
 465     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding firmware version");
 466
 467     // Support URL
 468     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SUPPORT_URL,
 469             sizeof(OC_RSRVD_SUPPORT_URL) - 1, payload->info.supportUrl);
 470     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding support url");
 471
 472     // System Time
 473     err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_SYSTEM_TIME,
 474             sizeof(OC_RSRVD_SYSTEM_TIME) - 1, payload->info.systemTime);
 475     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding system time");
 476
 477     // Resource type
 478     if (payload->rt)
 479     {
 480         err |= ConditionalAddTextStringToMap(&repMap, OC_RSRVD_RESOURCE_TYPE,
 481                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->rt);
 482         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type");
 483     }
 484
 485     // Resource interfaces
 486     if (payload->interfaces)
 487     {
 488         err |= cbor_encode_text_string(&repMap, OC_RSRVD_INTERFACE,
 489                 sizeof(OC_RSRVD_INTERFACE) - 1);
 490         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface tag");
 491         char* joinedInterfaces = OCStringLLJoin(payload->interfaces);
 492         VERIFY_PARAM_NON_NULL(TAG, joinedInterfaces, "Failed creating joined string");
 493         err |= cbor_encode_text_string(&repMap, joinedInterfaces, strlen(joinedInterfaces));
 494         OICFree(joinedInterfaces);
 495         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding platform interface value");
 496     }
 497
 498     // Close Map
 499     err |= cbor_encoder_close_container(&encoder, &repMap);
 500     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 501
 502 exit:
 503     return checkError(err, &encoder, outPayload, size);
 504 }
 505
 506 static int64_t OCConvertArrayItem(CborEncoder *array, const OCRepPayloadValueArray *valArray,
 507         size_t index)
 508 {
 509     int64_t err = CborNoError;
 510     switch (valArray->type)
 511     {
 512         case OCREP_PROP_NULL:
 513             OIC_LOG(ERROR, TAG, "ConvertArray Invalid NULL");
 514             err = CborUnknownError;
 515             break;
 516         case OCREP_PROP_INT:
 517             err |= cbor_encode_int(array, valArray->iArray[index]);
 518             break;
 519         case OCREP_PROP_DOUBLE:
 520             err |= cbor_encode_double(array, valArray->dArray[index]);
 521             break;
 522         case OCREP_PROP_BOOL:
 523             err |= cbor_encode_boolean(array, valArray->bArray[index]);
 524             break;
 525         case OCREP_PROP_STRING:
 526             if (!valArray->strArray[index])
 527             {
 528                 err |= cbor_encode_null(array);
 529             }
 530             else
 531             {
 532                 err |= cbor_encode_text_string(array, valArray->strArray[index],
 533                         strlen(valArray->strArray[index]));
 534             }
 535             break;
 536         case OCREP_PROP_BYTE_STRING:
 537             if (!valArray->strArray[index])
 538             {
 539                 err |= cbor_encode_null(array);
 540             }
 541             else
 542             {
 543                 err |= cbor_encode_byte_string(array, valArray->ocByteStrArray[index].bytes,
 544                         valArray->ocByteStrArray[index].len);
 545             }
 546             break;
 547         case OCREP_PROP_OBJECT:
 548             if (!valArray->objArray[index])
 549             {
 550                 err |= cbor_encode_null(array);
 551             }
 552             else
 553             {
 554                 err |= OCConvertRepMap(array, valArray->objArray[index]);
 555             }
 556             break;
 557         case OCREP_PROP_ARRAY:
 558             OIC_LOG(ERROR, TAG, "ConvertArray Invalid child array");
 559             err = CborUnknownError;
 560             break;
 561     }
 562
 563     return err;
 564 }
 565
 566 static int64_t OCConvertArray(CborEncoder *parent, const OCRepPayloadValueArray *valArray)
 567 {
 568     int64_t err = CborNoError;
 569     CborEncoder array;
 570     err |= cbor_encoder_create_array(parent, &array, valArray->dimensions[0]);
 571     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array");
 572
 573     for (size_t i = 0; i < valArray->dimensions[0]; ++i)
 574     {
 575         if (0 != valArray->dimensions[1])
 576         {
 577             CborEncoder array2;
 578             err |= cbor_encoder_create_array(&array, &array2, valArray->dimensions[1]);
 579             VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array2");
 580
 581             for (size_t j = 0; j < valArray->dimensions[1]; ++j)
 582             {
 583                 if (0 != valArray->dimensions[2])
 584                 {
 585                     CborEncoder array3;
 586                     err |= cbor_encoder_create_array(&array2, &array3, valArray->dimensions[2]);
 587                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep array3");
 588
 589                     for(size_t k = 0; k < valArray->dimensions[2]; ++k)
 590                     {
 591                         err |= OCConvertArrayItem(&array3, valArray,
 592                             j * valArray->dimensions[2] +
 593                             i * valArray->dimensions[2] * valArray->dimensions[1] +
 594                             k);
 595                         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array3 value");
 596                     }
 597                     err |= cbor_encoder_close_container(&array2, &array3);
 598                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array3");
 599                 }
 600                 else
 601                 {
 602                     err |= OCConvertArrayItem(&array2, valArray, i * valArray->dimensions[1] + j);
 603                     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array2 value");
 604                 }
 605             }
 606             err |= cbor_encoder_close_container(&array, &array2);
 607             VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array2");
 608         }
 609         else
 610         {
 611             err |= OCConvertArrayItem(&array, valArray, i);
 612             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep array value");
 613         }
 614     }
 615     err |= cbor_encoder_close_container(parent, &array);
 616     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep array");
 617
 618 exit:
 619     return err;
 620 }
 621
 622 static int64_t OCConvertRepMap(CborEncoder *map, const OCRepPayload *payload)
 623 {
 624     int64_t err = CborNoError;
 625     CborEncoder repMap;
 626     err |= cbor_encoder_create_map(map, &repMap, CborIndefiniteLength);
 627     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating rep map");
 628     err |= OCConvertSingleRepPayload(&repMap, payload);
 629     VERIFY_CBOR_SUCCESS(TAG, err, "Failed converting single rep payload");
 630     err |= cbor_encoder_close_container(map, &repMap);
 631     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing rep map");
 632 exit:
 633     return err;
 634 }
 635
 636 static int64_t OCConvertSingleRepPayload(CborEncoder *repMap, const OCRepPayload *payload)
 637 {
 638     int64_t err = CborNoError;
 639     OCRepPayloadValue *value = payload->values;
 640     while (value)
 641     {
 642         err |= cbor_encode_text_string(repMap, value->name, strlen(value->name));
 643         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding tag name");
 644
 645         switch (value->type)
 646         {
 647             case OCREP_PROP_NULL:
 648                 err |= cbor_encode_null(repMap);
 649                 break;
 650             case OCREP_PROP_INT:
 651                 err |= cbor_encode_int(repMap, value->i);
 652                 break;
 653             case OCREP_PROP_DOUBLE:
 654                 err |= cbor_encode_double(repMap, value->d);
 655                 break;
 656             case OCREP_PROP_BOOL:
 657                 err |= cbor_encode_boolean(repMap, value->b);
 658                 break;
 659             case OCREP_PROP_STRING:
 660                 err |= cbor_encode_text_string(repMap, value->str, strlen(value->str));
 661                 break;
 662             case OCREP_PROP_BYTE_STRING:
 663                 err |= cbor_encode_byte_string(repMap, value->ocByteStr.bytes, value->ocByteStr.len);
 664                 break;
 665             case OCREP_PROP_OBJECT:
 666                 err |= OCConvertRepMap(repMap, value->obj);
 667                 break;
 668             case OCREP_PROP_ARRAY:
 669                 err |= OCConvertArray(repMap, &value->arr);
 670                 break;
 671             default:
 672                 OIC_LOG_V(ERROR, TAG, "Invalid Prop type: %d", value->type);
 673                 break;
 674         }
 675         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding single rep value");
 676         value = value->next;
 677     }
 678
 679 exit:
 680     return err;
 681 }
 682
 683 static int64_t OCConvertRepPayload(OCRepPayload *payload, uint8_t *outPayload, size_t *size)
 684 {
 685     CborEncoder encoder;
 686     int64_t err = CborNoError;
 687
 688     cbor_encoder_init(&encoder, outPayload, *size, 0);
 689
 690     size_t arrayCount = 0;
 691     for (OCRepPayload *temp = payload; temp; temp = temp->next)
 692     {
 693         arrayCount++;
 694     }
 695     CborEncoder rootArray;
 696     if (arrayCount > 1)
 697     {
 698         err |= cbor_encoder_create_array(&encoder, &rootArray, arrayCount);
 699         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep root map");
 700     }
 701
 702     while (payload != NULL && (err == CborNoError))
 703     {
 704         CborEncoder rootMap;
 705         err |= cbor_encoder_create_map(((arrayCount == 1)? &encoder: &rootArray),
 706                                             &rootMap, CborIndefiniteLength);
 707         VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating root map");
 708
 709         // Only in case of collection href is included.
 710         if (arrayCount > 1 && payload->uri && strlen(payload->uri) > 0)
 711         {
 712             OIC_LOG(INFO, TAG, "Payload has uri");
 713             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_HREF, strlen(OC_RSRVD_HREF));
 714             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href tag");
 715             err |= cbor_encode_text_string(&rootMap, payload->uri, strlen(payload->uri));
 716             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep href value");
 717         }
 718         if (payload->types)
 719         {
 720             OIC_LOG(INFO, TAG, "Payload has types");
 721             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_RESOURCE_TYPE,
 722                     sizeof(OC_RSRVD_RESOURCE_TYPE) - 1);
 723             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep resource type tag");
 724             char* joinedTypes = OCStringLLJoin(payload->types);
 725             VERIFY_PARAM_NON_NULL(TAG, joinedTypes, "Failed creating joined string");
 726             err |= cbor_encode_text_string(&rootMap, joinedTypes, strlen(joinedTypes));
 727             OICFree(joinedTypes);
 728             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep resource type value");
 729         }
 730         if (payload->interfaces)
 731         {
 732             OIC_LOG(INFO, TAG, "Payload has interfaces");
 733             err |= cbor_encode_text_string(&rootMap, OC_RSRVD_INTERFACE,
 734                     sizeof(OC_RSRVD_INTERFACE) - 1);
 735             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep interface tag");
 736             char* joinedInterfaces = OCStringLLJoin(payload->interfaces);
 737             VERIFY_PARAM_NON_NULL(TAG, joinedInterfaces, "Failed creating joined string");
 738             err |= cbor_encode_text_string(&rootMap, joinedInterfaces, strlen(joinedInterfaces));
 739             OICFree(joinedInterfaces);
 740             VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding rep interface value");
 741         }
 742
 743         err |= OCConvertSingleRepPayload(&rootMap, payload);
 744         VERIFY_CBOR_SUCCESS(TAG, err, "Failed setting rep payload");
 745
 746         // Close main array
 747         err |= cbor_encoder_close_container(((arrayCount == 1) ? &encoder: &rootArray),
 748                 &rootMap);
 749         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root map");
 750         payload = payload->next;
 751     }
 752     if (arrayCount > 1)
 753     {
 754         err |= cbor_encoder_close_container(&encoder, &rootArray);
 755         VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing root array");
 756     }
 757
 758 exit:
 759     return checkError(err, &encoder, outPayload, size);
 760 }
 761
 762 static int64_t OCConvertPresencePayload(OCPresencePayload *payload, uint8_t *outPayload,
 763         size_t *size)
 764 {
 765     int64_t err = CborNoError;
 766     CborEncoder encoder;
 767
 768     cbor_encoder_init(&encoder, outPayload, *size, 0);
 769     CborEncoder map;
 770     err |= cbor_encoder_create_map(&encoder, &map, CborIndefiniteLength);
 771     VERIFY_CBOR_SUCCESS(TAG, err, "Failed creating presence map");
 772
 773     // Sequence Number
 774     err |= cbor_encode_text_string(&map, OC_RSRVD_NONCE, sizeof(OC_RSRVD_NONCE) - 1);
 775     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce tag to presence map");
 776     err |= cbor_encode_uint(&map, payload->sequenceNumber);
 777     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding nonce value to presence map");
 778
 779     // Max Age
 780     err |= cbor_encode_text_string(&map, OC_RSRVD_TTL, sizeof(OC_RSRVD_TTL) - 1);
 781     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl tag to presence map");
 782     err |= cbor_encode_uint(&map, payload->maxAge);
 783     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding ttl value to presence map");
 784
 785     // Trigger
 786     err |= cbor_encode_text_string(&map, OC_RSRVD_TRIGGER, sizeof(OC_RSRVD_TRIGGER) - 1);
 787     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger tag to presence map");
 788     err |= cbor_encode_simple_value(&map, payload->trigger);
 789     VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding trigger value to presence map");
 790
 791     // Resource type name
 792     if (payload->trigger != OC_PRESENCE_TRIGGER_DELETE)
 793     {
 794         err |= ConditionalAddTextStringToMap(&map, OC_RSRVD_RESOURCE_TYPE,
 795                 sizeof(OC_RSRVD_RESOURCE_TYPE) - 1, payload->resourceType);
 796         VERIFY_CBOR_SUCCESS(TAG, err, "Failed adding resource type to presence map");
 797     }
 798
 799     // Close Map
 800     err |= cbor_encoder_close_container(&encoder, &map);
 801     VERIFY_CBOR_SUCCESS(TAG, err, "Failed closing presence map");
 802
 803 exit:
 804     return checkError(err, &encoder, outPayload, size);
 805 }
 806
 807 static int64_t AddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 808         const char* value)
 809 {
 810     int64_t err = cbor_encode_text_string(map, key, keylen);
 811     if (CborNoError != err)
 812     {
 813         return err;
 814     }
 815     return cbor_encode_text_string(map, value, strlen(value));
 816 }
 817
 818 static int64_t ConditionalAddTextStringToMap(CborEncoder* map, const char* key, size_t keylen,
 819         const char* value)
 820 {
 821     return value ? AddTextStringToMap(map, key, keylen, value) : 0;
 822 }