Source release 16.2.0

core/include/device_files.h

@@ -15,7 +15,7 @@
 #include "wv_cdm_types.h"
 
 #if defined(UNIT_TEST)
-#include <gtest/gtest_prod.h>
+#  include <gtest/gtest_prod.h>
 #endif
 
 namespace wvcdm {
@@ -53,6 +53,31 @@ class DeviceFiles {
     kLicenseNotPresent = kResponseTypeBase + 16,
   };
 
+  // CdmLicenseData represents all of the data that is stored in CDM
+  // license file.  License data is uniquely keyed using |key_set_id|.
+  struct CdmLicenseData {
+    std::string key_set_id;
+    LicenseState state;
+    CdmInitData pssh_data;
+    // License request / response.
+    CdmKeyMessage license_request;
+    CdmKeyResponse license;
+    // License renewal request / response.
+    CdmKeyMessage license_renewal_request;
+    CdmKeyResponse license_renewal;
+    // License release.
+    std::string release_server_url;
+    // License times.
+    int64_t playback_start_time;
+    int64_t last_playback_time;
+    int64_t grace_period_end_time;
+    // App parameters.
+    CdmAppParameterMap app_parameters;
+    // Usage entry and index.
+    CdmUsageEntry usage_entry;
+    uint32_t usage_entry_number;
+  };
+
   struct CdmUsageData {
     std::string provider_session_token;
     CdmKeyMessage license_request;
@@ -79,27 +104,13 @@ class DeviceFiles {
   virtual bool HasCertificate();
   virtual bool RemoveCertificate();
 
-  virtual bool StoreLicense(
-      const std::string& key_set_id, const LicenseState state,
-      const CdmInitData& pssh_data, const CdmKeyMessage& key_request,
-      const CdmKeyResponse& key_response,
-      const CdmKeyMessage& key_renewal_request,
-      const CdmKeyResponse& key_renewal_response,
-      const std::string& release_server_url, int64_t playback_start_time,
-      int64_t last_playback_time, int64_t grace_period_end_time,
-      const CdmAppParameterMap& app_parameters,
-      const CdmUsageEntry& usage_entry, uint32_t usage_entry_number,
-      ResponseType* result);
+  virtual bool StoreLicense(const CdmLicenseData& license_data,
+                            ResponseType* result);
+
+  virtual bool RetrieveLicense(const std::string& key_set_id,
+                               CdmLicenseData* license_data,
+                               ResponseType* result);
 
-  virtual bool RetrieveLicense(
-      const std::string& key_set_id, LicenseState* state,
-      CdmInitData* pssh_data, CdmKeyMessage* key_request,
-      CdmKeyResponse* key_response, CdmKeyMessage* key_renewal_request,
-      CdmKeyResponse* key_renewal_response, std::string* release_server_url,
-      int64_t* playback_start_time, int64_t* last_playback_time,
-      int64_t* grace_period_end_time, CdmAppParameterMap* app_parameters,
-      CdmUsageEntry* usage_entry, uint32_t* usage_entry_number,
-      ResponseType* result);
   virtual bool DeleteLicense(const std::string& key_set_id);
   virtual bool ListLicenses(std::vector<std::string>* key_set_ids);
   virtual bool DeleteAllFiles();
@@ -143,6 +154,27 @@ class DeviceFiles {
   virtual bool DeleteUsageInfo(const std::string& usage_info_file_name,
                                const std::string& provider_session_token);
 
+  // Deletes a set of provider sessions from the specified usage info.
+  // Sessions removed are based on the provided |key_set_ids|.  If
+  // there are no remaining sessions associated with the usage info
+  // then the file will be deleted; otherwise, the remaining sessions
+  // are written back to the usage info file.
+  //
+  // Args:
+  //   usage_info_file_name: name of the file containing the usage info
+  //       message.  This name should _not_ be the complete path, just
+  //       the file name.
+  //   key_set_ids: The list of key set IDs to be removed from the
+  //       usage info.  Note that any key set ids that are not present
+  //       in the usage info are silently ignored.
+  // Returns:
+  //   `true` if the file existed, and operations were completed as
+  //   expected.  `false` if the file does not exist or if there is an
+  //   issue writing the result back to file.
+  virtual bool DeleteMultipleUsageInfoByKeySetIds(
+      const std::string& usage_info_file_name,
+      const std::vector<std::string>& key_set_ids);
+
   // Delete usage information from the file system.  Puts a list of all the
   // psts that were deleted from the file into |provider_session_tokens|.
   virtual bool DeleteAllUsageInfoForApp(
@@ -201,17 +233,16 @@ class DeviceFiles {
       const CdmUsageTableHeader& usage_table_header,
       const std::vector<CdmUsageEntryInfo>& usage_entry_info);
 
+  // When retrieving usage table information from the file system; any
+  // table that has yet to be updated for the LRU attributes will be
+  // indicated by |lru_upgrade|.
   virtual bool RetrieveUsageTableInfo(
       CdmUsageTableHeader* usage_table_header,
-      std::vector<CdmUsageEntryInfo>* usage_entry_info);
+      std::vector<CdmUsageEntryInfo>* usage_entry_info, bool* lru_upgrade);
 
   virtual bool DeleteUsageTableInfo();
 
  private:
-  // Extract serial number and system ID from DRM Device certificate
-  bool ExtractDeviceInfo(const std::string& device_certificate,
-                         std::string* serial_number, uint32_t* system_id);
-
   // Helpers that wrap the File interface and automatically handle hashing, as
   // well as adding the device files base path to to the file name.
   ResponseType StoreFileWithHash(const std::string& name,
@@ -252,6 +283,7 @@ class DeviceFiles {
   FRIEND_TEST(DeviceFilesUsageInfoTest, Store);
   FRIEND_TEST(DeviceFilesUsageTableTest, Read);
   FRIEND_TEST(DeviceFilesUsageTableTest, Store);
+  FRIEND_TEST(DeviceFilesUsageTableTest, ReadWithoutLruData);
   FRIEND_TEST(WvCdmRequestLicenseTest, UnprovisionTest);
   FRIEND_TEST(WvCdmRequestLicenseTest, ForceL3Test);
   FRIEND_TEST(WvCdmRequestLicenseTest, UsageInfoRetryTest);