RDK-56276: Add user settings inspector interface to user settings plugin. (rdkcentral#6131)

Dosakaya · web-flow · commit 711ff81b95b4 · 2025-03-12T09:07:28.000-04:00
* RDK-56276: Add user settings inspector interface to user settings plugin

* Update UserSettingsImplementation.cpp
diff --git a/Tests/L2Tests/patches/0001-Add-IAnalytics-interface-R4.4.patch b/Tests/L2Tests/patches/0001-Add-IAnalytics-interface-R4.4.patch
@@ -55,20 +55,18 @@ index 0000000..c33d8e0
 +}
 +}
 diff --git a/interfaces/Ids.h b/interfaces/Ids.h
-index 7d53320..0296d66 100644
+index 5128382..350d806 100644
 --- a/interfaces/Ids.h
 +++ b/interfaces/Ids.h
-@@ -368,7 +368,9 @@ namespace Exchange {
-         ID_DEVICE_OPTIMIZE_STATE_ACTIVATOR           = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x510,
+@@ -370,9 +370,9 @@ namespace Exchange {
  
+ 	ID_DEVICE_OPTIMIZE_STATE_ACTIVATOR           = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x510,
          ID_SYSTEM_MODE                               = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x520,
 -        ID_SYSTEM_MODE_NOTIFICATION                  = ID_SYSTEM_MODE + 1
+-
 +        ID_SYSTEM_MODE_NOTIFICATION                  = ID_SYSTEM_MODE + 1,
-+
-+        ID_ANALYTICS                                 = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x530,
+ 
++        ID_ANALYTICS                                 = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x530
+ 
      };
  }
- }
--- 
-2.25.1
-
diff --git a/Tests/L2Tests/patches/RDK-51362-System-Mode-Thunder-Plugin.patch b/Tests/L2Tests/patches/RDK-51362-System-Mode-Thunder-Plugin.patch
@@ -122,20 +122,19 @@ index 0000000..2c33b6d
 +} // namespace Exchange
 +} // namespace WPEFramework
 diff --git a/interfaces/Ids.h b/interfaces/Ids.h
-index e66cb22..7d53320 100644
+index 9f28fe0..5128382 100644
 --- a/interfaces/Ids.h
 +++ b/interfaces/Ids.h
-@@ -363,7 +363,12 @@ namespace Exchange {
-         ID_TEXT_TO_SPEECH_NOTIFICATION               = ID_TEXT_TO_SPEECH + 1,
+@@ -368,6 +368,12 @@ namespace Exchange {
+ 	ID_USER_SETTINGS_MIGRATION_STATE_ITERATOR    = ID_USER_SETTINGS + 3,
+ 
  
- 	ID_USER_SETTINGS                             = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x4D0,
--        ID_USER_SETTINGS_NOTIFICATION                = ID_USER_SETTINGS + 1
-+        ID_USER_SETTINGS_NOTIFICATION                = ID_USER_SETTINGS + 1,
-+
 +        ID_DEVICE_OPTIMIZE_STATE_ACTIVATOR           = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x510,
-+
 +        ID_SYSTEM_MODE                               = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x520,
 +        ID_SYSTEM_MODE_NOTIFICATION                  = ID_SYSTEM_MODE + 1
++
++
++
      };
  }
  }
diff --git a/Tests/L2Tests/patches/RDKV-48604-User-Settings-Thunder-Plugin.patch b/Tests/L2Tests/patches/RDKV-48604-User-Settings-Thunder-Plugin.patch
@@ -6,10 +6,10 @@ Date:   Fri Sep 6 12:49:05 2024 +0530
 
 diff --git a/interfaces/IUserSettings.h b/interfaces/IUserSettings.h
 new file mode 100755
-index 0000000..4adda17
+index 0000000..bd7ea1f
 --- /dev/null
 +++ b/interfaces/IUserSettings.h
-@@ -0,0 +1,353 @@
+@@ -0,0 +1,414 @@
 +/*
 + * If not stated otherwise in this file or this component's LICENSE file the
 + * following copyright and licenses apply:
@@ -33,57 +33,58 @@ index 0000000..4adda17
 +
 +#include "Module.h"
 +
++// @stubgen:include <com/IIteratorType.h>
 +namespace WPEFramework {
 +namespace Exchange {
 +
-+  // @json @text:keep
++// @json @text:keep
 +struct EXTERNAL IUserSettings : virtual public Core::IUnknown
 +{
-+  enum { ID = ID_USER_SETTINGS };
++    enum { ID = ID_USER_SETTINGS };
 +
-+  // @event
++    // @event
 +    struct EXTERNAL INotification : virtual public Core::IUnknown
 +    {
-+    enum { ID = ID_USER_SETTINGS_NOTIFICATION };
++        enum { ID = ID_USER_SETTINGS_NOTIFICATION };
 +
-+    // Constructor
-+    INotification() {};
++        // Constructor
++        INotification() {};
 +
-+    // Destructor
-+    virtual ~INotification() {};
++        // Destructor
++        virtual ~INotification() {};
 +
-+    // copy constructor
-+    INotification & operator=(const INotification &) = delete;
++        // copy constructor
++        INotification & operator=(const INotification &) = delete;
 +
-+    // @text onAudioDescriptionChanged
-+    // @brief The AudioDescription setting has changed.
-+    // @param enabled: Enabled/Disabled.
++        // @text onAudioDescriptionChanged
++        // @brief The AudioDescription setting has changed.
++        // @param enabled: audioDescription enabled or not
 +        virtual void OnAudioDescriptionChanged(const bool enabled) {};
 +
-+    // @text onPreferredAudioLanguagesChanged
-+    // @brief The preferredLanguages setting has changed.
-+    // @param preferredLanguages: PreferredLanguages.
++        // @text onPreferredAudioLanguagesChanged
++        // @brief The preferredLanguages setting has changed.
++        // @param preferredLanguages: the changed preferredLanguages.
 +        virtual void OnPreferredAudioLanguagesChanged(const string& preferredLanguages /* @text preferredLanguages */) {};
 +
-+    // @text onPresentationLanguageChanged
-+    // @brief The PresentationLanguages setting has changed.
-+    // @param presentationLanguage: PresentationLanguage.
++        // @text onPresentationLanguageChanged
++        // @brief The PresentationLanguages setting has changed.
++        // @param presentationLanguage: the changed presentationLanguage.
 +        virtual void OnPresentationLanguageChanged(const string& presentationLanguage /* @text presentationLanguage */) {};
 +
-+    // @text onCaptionsChanged
-+    // @brief The Captions setting has changed.
-+    // @param enabled: Enabled/Disabled.
++        // @text onCaptionsChanged
++        // @brief The Captions setting has changed.
++        // @param enabled: Captions enabled or not.
 +        virtual void OnCaptionsChanged(const bool enabled) {};
 +
-+    // @text onPreferredCaptionsLanguagesChanged
-+    // @brief The PreferredCaptionsLanguages setting has changed.
-+    // @param preferredLanguages: PreferredLanguages.
++        // @text onPreferredCaptionsLanguagesChanged
++        // @brief The PreferredCaptionsLanguages setting has changed.
++        // @param preferredLanguages: the changed preferredLanguages.
 +        virtual void OnPreferredCaptionsLanguagesChanged(const string& preferredLanguages /* @text preferredLanguages */) {};
 +
-+    // @text onPreferredClosedCaptionServiceChanged
++        // @text onPreferredClosedCaptionServiceChanged
 +        // @brief The PreferredClosedCaptionService setting has changed.Eg: "CC[1-4]", "TEXT[1-4]", "SERVICE[1-64]".
 +        // @param service: the changed preferredClosedCaptionService.
-+    virtual void OnPreferredClosedCaptionServiceChanged(const string& service) {};
++        virtual void OnPreferredClosedCaptionServiceChanged(const string& service) {};
 +
 +    // @text onPrivacyModeChanged
 +    // @brief The PrivacyMode setting has changed.
@@ -193,7 +194,7 @@ index 0000000..4adda17
 +  // of this state while a playback is active.
 +  // When media players start playback, they should also call the GetCaptions method to retrieve the current enabled state.
 +  // This holds true for media players that utilize TextTrack render sessions for text track decode-display and also for media
-+  // players or apps that decode-display internally 
++  // players or apps that decode-display internally
 +  // @param enabled: Sets the state
 +  virtual uint32_t SetCaptions(const bool enabled  /* @in */) = 0;
 +
@@ -208,7 +209,7 @@ index 0000000..4adda17
 +  // expressed as a comma separated lists of languages of zero of more elements.
 +  // The players will pick the subtitle track that has the best match compared with
 +  // this list. In the absence of a matching track, the player should by best
-+  // effort select the preferred subtitle track. 
++  // effort select the preferred subtitle track.
 +  // @param preferredLanguages: Is the list to set (e.g. "eng,fra")
 +  virtual uint32_t SetPreferredCaptionsLanguages(const string& preferredLanguages  /* @in @text preferredLanguages */) = 0;
 +
@@ -220,7 +221,7 @@ index 0000000..4adda17
 +  // @text setPreferredClosedCaptionService
 +  // @brief Sets the PreferredClosedCaptionService.
 +  // @details The setting should be honored by the player. The behaviour of AUTO may be player specific.
-+  // Valid input for service is "CC[1-4]", "TEXT[1-4]", "SERVICE[1-64]" 
++  // Valid input for service is "CC[1-4]", "TEXT[1-4]", "SERVICE[1-64]"
 +  // @param service: Identifies the service to display e.g. "CC3".
 +  virtual uint32_t SetPreferredClosedCaptionService(const string& service  /* @in */) = 0;
 +
@@ -268,7 +269,7 @@ index 0000000..4adda17
 +  // restrictions are to be applied, if applicable for the project
 +  // @param viewingRestrictionsWindow: A project-specific representation of the time interval.Eg: "ALWAYS"
 +  virtual uint32_t SetViewingRestrictionsWindow(const string &viewingRestrictionsWindow /* @in @text viewingRestrictionsWindow */) = 0;
-+  
++
 +  // @text getViewingRestrictionsWindow
 +  // @brief Gets the current ViewingRestrictionsWindow.
 +  // @param viewingRestrictionsWindow: A project-specific representation of the time interval.Eg: "ALWAYS"
@@ -360,22 +361,86 @@ index 0000000..4adda17
 +
 +};
 +
++/**
++ * If a setting was owned by an other component prior to being migrated into UserSettings,
++ * we require the ability to detect when this migration has completed.
++ * The component which was the previous owner of a given setting has the responsibility
++ * to always set the setting on UserSettings interface (During migration AND during first time install).
++ * Until this is done the setting is not considered valid, meaning the the MigrationState will contain requiresMigration=true
++ * All settings not requiring migration would immediately be valid.
++ */
++
++/* @json 1.0.0 @text:keep */
++struct EXTERNAL IUserSettingsInspector : virtual public Core::IUnknown
++{
++    enum { ID = ID_USER_SETTINGS_INSPECTOR };
++
++    ~IUserSettingsInspector() override = default;
++
++    enum SettingsKey : uint32_t
++    {
++        PREFERRED_AUDIO_LANGUAGES = 1,
++        AUDIO_DESCRIPTION = 2,
++        CAPTIONS = 3,
++        PREFERRED_CAPTIONS_LANGUAGES = 4,
++        PREFERRED_CLOSED_CAPTION_SERVICE = 5,
++        PRESENTATION_LANGUAGE = 6,
++        HIGH_CONTRAST = 7,
++        PIN_CONTROL = 8,
++        VIEWING_RESTRICTIONS = 9,
++        VIEWING_RESTRICTIONS_WINDOW = 10,
++        LIVE_WATERSHED = 11,
++        PLAYBACK_WATERSHED = 12,
++        BLOCK_NOT_RATED_CONTENT = 13,
++        PIN_ON_PURCHASE = 14,
++        VOICE_GUIDANCE = 15,
++        VOICE_GUIDANCE_RATE = 16,
++        VOICE_GUIDANCE_HINTS = 17
++    };
++
++    struct SettingsMigrationState
++    {
++        SettingsKey key             /* @text key which needs the migration information */ ;
++        bool requiresMigration      /* @text whether the key requires migration or not */;
++    };
++
++    using IUserSettingsMigrationStateIterator = RPC::IIteratorType<SettingsMigrationState, ID_USER_SETTINGS_MIGRATION_STATE_ITERATOR>;
++
++    /** Get the migration state of the respective key */
++    // @text getMigrationState
++    // @brief Get the migration state of the respective key
++    // @param key: one of UserSettingsKey
++    // @param migrationState: key and it's migration state.
++    virtual Core::hresult GetMigrationState(const SettingsKey key, bool &requiresMigration /* @out */) const = 0;
++
++    /** Get the migration state of all the defined keys */
++    // @text getMigrationStates
++    // @brief Get the migration state of all the defined keys
++    // @param states: array of migration status.
++    virtual Core::hresult GetMigrationStates(IUserSettingsMigrationStateIterator*& states /* @out */) const = 0;
++
++};
++
 +} // namespace Exchange
 +} // namespace WPEFramework
 +
 diff --git a/interfaces/Ids.h b/interfaces/Ids.h
-index a37db24..293dd73 100644
+index 64151cf..9f28fe0 100644
 --- a/interfaces/Ids.h
 +++ b/interfaces/Ids.h
-@@ -354,7 +354,10 @@ namespace Exchange {
+@@ -360,7 +360,14 @@ namespace Exchange {
          ID_SCRIPT_ENGINE_NOTIFICATION                = ID_SCRIPT_ENGINE + 1,
  
          ID_TEXT_TO_SPEECH                            = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x4C0,
 -        ID_TEXT_TO_SPEECH_NOTIFICATION               = ID_TEXT_TO_SPEECH + 1
 +        ID_TEXT_TO_SPEECH_NOTIFICATION               = ID_TEXT_TO_SPEECH + 1,
 +
 +	ID_USER_SETTINGS                             = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x4D0,
-+        ID_USER_SETTINGS_NOTIFICATION                = ID_USER_SETTINGS + 1
++        ID_USER_SETTINGS_NOTIFICATION                = ID_USER_SETTINGS + 1,
++	ID_USER_SETTINGS_INSPECTOR                   = ID_USER_SETTINGS + 2,
++	ID_USER_SETTINGS_MIGRATION_STATE_ITERATOR    = ID_USER_SETTINGS + 3,
++
++
      };
  }
  }
diff --git a/UserSettings/UserSettings.cpp b/UserSettings/UserSettings.cpp
@@ -48,7 +48,7 @@ namespace WPEFramework
      **/
     SERVICE_REGISTRATION(UserSettings, API_VERSION_NUMBER_MAJOR, API_VERSION_NUMBER_MINOR, API_VERSION_NUMBER_PATCH);
 
-    UserSettings::UserSettings() : _service(nullptr), _connectionId(0), _userSetting(nullptr), _usersettingsNotification(this)
+    UserSettings::UserSettings() : _service(nullptr), _connectionId(0), _userSetting(nullptr), _userSettingsInspector(nullptr), _usersettingsNotification(this)
     {
         SYSLOG(Logging::Startup, (_T("UserSettings Constructor")));
     }
@@ -95,6 +95,16 @@ namespace WPEFramework
             _userSetting->Register(&_usersettingsNotification);
             // Invoking Plugin API register to wpeframework
             Exchange::JUserSettings::Register(*this, _userSetting);
+
+            _userSettingsInspector = _userSetting->QueryInterface<Exchange::IUserSettingsInspector>();
+            if (_userSettingsInspector != nullptr)
+            {
+                Exchange::JUserSettingsInspector::Register(*this, _userSettingsInspector);
+            }
+            else
+            {
+                message = _T("UserSettings implementation did not provide a IUserSettingsInspector interface");
+            }
         }
         else
         {
@@ -123,8 +133,13 @@ namespace WPEFramework
         {
             _userSetting->Unregister(&_usersettingsNotification);
             Exchange::JUserSettings::Unregister(*this);
+            Exchange::JUserSettingsInspector::Unregister(*this);
 
             configure->Release();
+            _userSettingsInspector->Release();
+
+            configure = nullptr;
+            _userSettingsInspector = nullptr;
 
             // Stop processing:
             RPC::IRemoteConnection* connection = service->RemoteConnection(_connectionId);
diff --git a/UserSettings/UserSettings.h b/UserSettings/UserSettings.h
@@ -22,6 +22,8 @@
 #include "Module.h"
 #include <interfaces/json/JsonData_UserSettings.h>
 #include <interfaces/json/JUserSettings.h>
+#include <interfaces/json/JUserSettingsInspector.h>
+#include <interfaces/json/JsonData_UserSettingsInspector.h>
 #include <interfaces/IUserSettings.h>
 #include <interfaces/IConfiguration.h>
 #include "UtilsLogging.h"
@@ -194,6 +196,7 @@ namespace Plugin {
             INTERFACE_ENTRY(PluginHost::IPlugin)
             INTERFACE_ENTRY(PluginHost::IDispatcher)
             INTERFACE_AGGREGATE(Exchange::IUserSettings, _userSetting)
+            INTERFACE_AGGREGATE(Exchange::IUserSettingsInspector, _userSettingsInspector)
             END_INTERFACE_MAP
 
             //  IPlugin methods
@@ -209,6 +212,7 @@ namespace Plugin {
             PluginHost::IShell* _service{};
             uint32_t _connectionId{};
             Exchange::IUserSettings* _userSetting{};
+            Exchange::IUserSettingsInspector* _userSettingsInspector{};
             Core::Sink<Notification> _usersettingsNotification;
             Exchange::IConfiguration* configure;
     };
diff --git a/UserSettings/UserSettingsImplementation.cpp b/UserSettings/UserSettingsImplementation.cpp
diff --git a/UserSettings/UserSettingsImplementation.h b/UserSettings/UserSettingsImplementation.h
