EmbStorage.h

Go to the documentation of this file.

/*****************************************************************
|
|   EMBB Object Storage
|
|   $Id: EmbStorage.h 2017-10-03
|   Original author: Kiran Kumar G
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2017-2018 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _EMB_STORAGE_H_
#define _EMB_STORAGE_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "EmbProcessor.h"
#include "EmbItem.h"

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/

typedef struct EMB_Storage EMB_Storage;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

EMB_EXPORT EMB_Result
EMB_Storage_Open(EMB_Storage** storage);

EMB_EXPORT EMB_Result
EMB_Storage_FindItemsByIds(EMB_Storage*     storage,
                           EMB_ItemType     item_type,
                           EMB_UInt32       id_count,
                           EMB_ByteArray**  ids,
                           EMB_Bool         hash_content_ids,
                           SHI_Data**       items);
/*
 * Finds the epl items (both expired and non-expired) targeted to a given group id.
 *
 * This method returns EMB_ERROR_STORAGE_NO_ITEM if no match was found, or
 * EMB_ERROR_STORAGE_LOOKUP if an error occurred during lookup.
 *
 * @param storage   An EMBB Storage
 * @param item_type Supported item type is EMB_IT_EPL.
 * @param group_id  The EPL items targeted to a group id.
 * @param items     Address of a SHI_Data pointer that will, upon successful return,
 *                  be set to point to a SHI_Data object representing an array of
 *                  one or more items.
 *                  This SHI_Data object will have a value of type
 *                  SHI_DATA_TYPE_ARRAY, where each element in the array will be of
 *                  type SHI_DATA_TYPE_POINTER, so its value is a SHI_TypedPointer.
 *                  Each SHI_TypedPointer structure in the array will have its
 *                  type_id field set to EMB_TYPE_ID_EMBB_OBJ and its pointer field
 *                  pointing to an EMB_Item.
 *                  The caller is responsible for calling SHI_Data_Release to
 *                  release the SHI_Data object containing the array when it is no
 *                  longer needed. The EMB_Object pointed to by the array are no
 *                  longer valid and should not be accessed after the caller has
 *                  called SHI_Data_Release.
 */
EMB_EXPORT EMB_Result
EMB_Storage_FindItemsTargetAtGroup(EMB_Storage* storage,
                                EMB_ItemType item_type,
                                EMB_ByteArray group_id,
                                SHI_Data** items);

EMB_EXPORT EMB_Result
EMB_Storage_GetItemByItemId(EMB_Storage* storage, 
                            EMB_ItemType item_type,
                            EMB_UInt32 item_id, 
                            SHI_Data** item);

EMB_EXPORT EMB_Result
EMB_Storage_RemoveItemsByIds(EMB_Storage*   storage,
                           EMB_ItemType     item_type,
                           EMB_UInt32       id_count,
                           EMB_ByteArray**  ids);

EMB_EXPORT EMB_Result
EMB_Storage_RemoveItem(EMB_Storage* storage, EMB_ItemType item_type, EMB_UInt32 item_id);

EMB_EXPORT EMB_Result
EMB_Storage_ExpungeExpiredItems(EMB_Storage* storage, EMB_ItemType item_type);

EMB_EXPORT EMB_Result
EMB_Storage_Close(EMB_Storage* storage);

EMB_EXPORT EMB_Result
EMB_Storage_Wipe();
    
#include <time.h>

typedef void *EPD_Storage;

#define INVALID_EPD_STORAGE (void *)NULL
    
EMB_EXPORT EMB_Result
EMB_Storage_GetEntitlementStorage(EMB_Storage *storage, EPD_Storage *epds);
    
EMB_EXPORT EMB_Result
EMB_Storage_ReleaseEntitlementStorage(EMB_Storage *storage, EPD_Storage epds);
    
EMB_EXPORT EMB_Result
EMB_Storage_CleanupEntitlementStorage(EMB_Storage *storage, time_t expirationDate);
    
    
/*
 * EPD_Storage
 *
 * The EPD_Storage is part of the EMBB storage. 
 * An handle to the EPD_Storage is obtained by calling \e EMB_Storage_GetEntitlementStorage 
 * and released by calling \e EMB_Storage_ReleaseEntitlementStorage. More than one handle can be 
 * created and used at any point in time.
 * The EPD_Storage contains information about Entitlement Package Descriptions (EPDs) 
 * and can be queried according the criteria defined by the following functions:
 * - \e EPD_Storage_GetPackageById
 * - \e EPD_Storage_GetPackagesForContent
 * - \e EPD_Storage_GetPackages
 * - \e EPD_Storage_GetContentForPackage
 *
 * The above functions allocates memory to return a result set. Such result set must be released by calling the corresponding function 
 * when no longer needed. 
 * 
 */
    
#include <stdint.h>

typedef int XPCA_package_type_t; 
#define MIN_XPCA_PACKAGE_TYPE 1
#define MAX_XPCA_PACKAGE_TYPE 15
#define ANY_XPCA_PACKAGE_TYPE 0

typedef int XPCA_package_access_t; 
#define MIN_XPCA_PACKAGE_ACCESS 1
#define MAX_XPCA_PACKAGE_ACCESS 15
#define ANY_XPCA_PACKAGE_ACCESS 0
    
typedef struct {
    uint32_t id;                      
    char name[20];                    
    time_t startDate;                 
    time_t endDate;                   
    XPCA_package_type_t type;         
    XPCA_package_access_t access;     
    int lcidSize;                     
    uint32_t lcid[1];                 
} XPCA_Package;


#define XPCA_CONTENT_STATUS_IS_IN_EPD(status) (((status) & 0x01) == 0x01)
#define XPCA_CONTENT_STATUS_IS_IN_EPL(status) (((status) & 0x02) == 0x02)
#define XPCA_CONTENT_STATUS_CHECK_ERROR(status) (((status) & 0x80) == 0x80)
    
typedef struct {
    uint8_t  contentId[EMB_CONTENT_ID_HASH_LENGTH];    
    uint32_t status;                                   
    int32_t  eplGroupId;                               
} XPCA_Content;

typedef struct {
    int32_t  pkgGroupId;       
    uint32_t size;           
    XPCA_Content content[1]; 
} XPCA_PackageContentArray;

typedef struct {
    uint32_t size;      
    uint32_t value[1];  
} XPCA_UintArray;

#define EPD_INFINITE_TIME ((time_t)(-1))

EMB_EXPORT EMB_Result 
EPD_Storage_GetPackageById(EPD_Storage epds, uint32_t id, XPCA_Package **package);

EMB_EXPORT EMB_Result 
EPD_Storage_GetPackagesForContent(EPD_Storage epds, uint32_t lcid, XPCA_package_type_t type, XPCA_package_access_t access, XPCA_UintArray **array);

EMB_EXPORT EMB_Result 
EPD_Storage_GetPackages(EPD_Storage epds, XPCA_package_type_t type, XPCA_package_access_t access, XPCA_UintArray **array);

EMB_EXPORT EMB_Result 
EPD_Storage_GetContentForPackage(EPD_Storage epds, uint32_t id, XPCA_PackageContentArray **array);

EMB_EXPORT EMB_Result
EPD_Storage_ReleasePackage(EPD_Storage epds, XPCA_Package *package);

EMB_EXPORT EMB_Result
EPD_Storage_ReleaseUintArray(EPD_Storage epds, XPCA_UintArray *array);

EMB_EXPORT EMB_Result
EPD_Storage_ReleasePackageContentArray(EPD_Storage epds, XPCA_PackageContentArray *array);
  
#if defined(__cplusplus)
}
#endif /* __cplusplus */

#endif /* _EMB_STORAGE_H_ */