[addons] make binary addon management independent

This changes add a new binary addon manager who handle the addons on request. This way allow the use of several instances on the same addon. Currently only used on Visualization and Screensaver, but other binary addon types becomes on next steps changed to use them here. Further becomes on next changes everything related to binary addons moved to the new folder "./xbmc/addons/binary-addons". The old system is not changed!
xbmc · Jun 17, 2017 · 2ce6afe · 2ce6afe
1 parent 63ccea5
commit 2ce6afe
Show file tree

Hide file tree

Showing 67 changed files with 1,272 additions and 89 deletions.
diff --git a/cmake/treedata/common/subdirs.txt b/cmake/treedata/common/subdirs.txt
@@ -1,5 +1,6 @@
 xbmc                                            xbmc
 xbmc/addons                                     addons
+xbmc/addons/binary-addons                       addons_binary-addons
 xbmc/addons/interfaces                          addonsBinaryInterfaces
 xbmc/addons/interfaces/Addon                    addonCallbacks_Addon
 xbmc/addons/interfaces/GUI                      addons_interfaces_gui

diff --git a/xbmc/ServiceBroker.cpp b/xbmc/ServiceBroker.cpp
@@ -28,6 +28,11 @@ ADDON::CAddonMgr &CServiceBroker::GetAddonMgr()
   return g_application.m_ServiceManager->GetAddonMgr();
 }
 
+ADDON::CBinaryAddonManager &CServiceBroker::GetBinaryAddonManager()
+{
+  return g_application.m_ServiceManager->GetBinaryAddonManager();
+}
+
 ADDON::CBinaryAddonCache &CServiceBroker::GetBinaryAddonCache()
 {
   return g_application.m_ServiceManager->GetBinaryAddonCache();

diff --git a/xbmc/ServiceBroker.h b/xbmc/ServiceBroker.h
@@ -22,6 +22,7 @@
 
 namespace ADDON {
 class CAddonMgr;
+class CBinaryAddonManager;
 class CBinaryAddonCache;
 }
 
@@ -68,6 +69,7 @@ class CServiceBroker
 {
 public:
   static ADDON::CAddonMgr &GetAddonMgr();
+  static ADDON::CBinaryAddonManager &GetBinaryAddonManager();
   static ADDON::CBinaryAddonCache &GetBinaryAddonCache();
   static ANNOUNCEMENT::CAnnouncementManager &GetAnnouncementManager();
   static XBPython &GetXBPython();

diff --git a/xbmc/ServiceManager.cpp b/xbmc/ServiceManager.cpp
@@ -20,6 +20,7 @@
 
 #include "ServiceManager.h"
 #include "addons/BinaryAddonCache.h"
+#include "addons/binary-addons/BinaryAddonManager.h"
 #include "ContextMenuManager.h"
 #include "cores/AudioEngine/Engines/ActiveAE/ActiveAE.h"
 #include "cores/DataCacheCore.h"
@@ -71,10 +72,17 @@ bool CServiceManager::Init2()
 {
   m_Platform->Init();
 
+  m_binaryAddonManager.reset(new ADDON::CBinaryAddonManager()); /* Need to constructed before, GetRunningInstance() of binary CAddonDll need to call them */
   m_addonMgr.reset(new ADDON::CAddonMgr());
   if (!m_addonMgr->Init())
   {
-    CLog::Log(LOGFATAL, "CServiceManager::Init: Unable to start CAddonMgr");
+    CLog::Log(LOGFATAL, "CServiceManager::%s: Unable to start CAddonMgr", __FUNCTION__);
+    return false;
+  }
+
+  if (!m_binaryAddonManager->Init())
+  {
+    CLog::Log(LOGFATAL, "CServiceManager::%s: Unable to initialize CBinaryAddonManager", __FUNCTION__);
     return false;
   }
 
@@ -113,7 +121,7 @@ bool CServiceManager::StartAudioEngine()
 {
   if (!m_ActiveAE)
   {
-    CLog::Log(LOGFATAL, "CServiceManager::StartAudioEngine: Unable to start ActiveAE");
+    CLog::Log(LOGFATAL, "CServiceManager::%s: Unable to start ActiveAE", __FUNCTION__);
     return false;
   }
 
@@ -141,6 +149,7 @@ void CServiceManager::Deinit()
   if (m_PVRManager)
     m_PVRManager->Deinit();
   m_PVRManager.reset();
+  m_binaryAddonManager.reset();
   m_addonMgr.reset();
 #ifdef HAS_PYTHON
   CScriptInvocationManager::GetInstance().UnregisterLanguageInvocationHandler(m_XBPython.get());
@@ -160,6 +169,11 @@ ADDON::CBinaryAddonCache &CServiceManager::GetBinaryAddonCache()
   return *m_binaryAddonCache.get();
 }
 
+ADDON::CBinaryAddonManager &CServiceManager::GetBinaryAddonManager()
+{
+  return *m_binaryAddonManager.get();
+}
+
 ANNOUNCEMENT::CAnnouncementManager& CServiceManager::GetAnnouncementManager()
 {
   return *m_announcementManager;

diff --git a/xbmc/ServiceManager.h b/xbmc/ServiceManager.h
@@ -25,6 +25,7 @@
 
 namespace ADDON {
 class CAddonMgr;
+class CBinaryAddonManager;
 class CBinaryAddonCache;
 }
 
@@ -83,6 +84,7 @@ class CServiceManager
   bool Init3();
   void Deinit();
   ADDON::CAddonMgr& GetAddonMgr();
+  ADDON::CBinaryAddonManager& GetBinaryAddonManager();
   ADDON::CBinaryAddonCache& GetBinaryAddonCache();
   ANNOUNCEMENT::CAnnouncementManager& GetAnnouncementManager();
 #ifdef HAS_PYTHON
@@ -126,6 +128,7 @@ class CServiceManager
   };
 
   std::unique_ptr<ADDON::CAddonMgr> m_addonMgr;
+  std::unique_ptr<ADDON::CBinaryAddonManager> m_binaryAddonManager;
   std::unique_ptr<ADDON::CBinaryAddonCache> m_binaryAddonCache;
   std::unique_ptr<ANNOUNCEMENT::CAnnouncementManager> m_announcementManager;
 #ifdef HAS_PYTHON

diff --git a/xbmc/addons/AddonBuilder.h b/xbmc/addons/AddonBuilder.h
@@ -61,7 +61,7 @@ class CAddonBuilder
   const std::string& GetId() const { return m_addonInfo.m_id; }
   const AddonVersion& GetVersion() const { return m_addonInfo.m_version; }
 
-  const CAddonInfo& GetAddonInfo() { return m_addonInfo; }
+  const CAddonInfo& GetAddonInfo() const { return m_addonInfo; }
 
 private:
   static std::shared_ptr<IAddon> FromProps(CAddonInfo addonInfo);

diff --git a/xbmc/addons/AddonManager.cpp b/xbmc/addons/AddonManager.cpp
@@ -567,6 +567,40 @@ bool CAddonMgr::FindInstallableById(const std::string& addonId, AddonPtr& result
   return true;
 }
 
+bool CAddonMgr::GetInstalledBinaryAddons(BINARY_ADDON_LIST& binaryAddonList)
+{
+  CSingleLock lock(m_critSection);
+  if (!m_cp_context)
+    return false;
+
+  std::vector<CAddonBuilder> builders;
+  m_database.GetInstalled(builders);
+
+  for (auto builder : builders)
+  {
+    cp_status_t status;
+    cp_plugin_info_t* cp_addon = m_cpluff->get_plugin_info(m_cp_context, builder.GetId().c_str(), &status);
+    if (status == CP_OK && cp_addon)
+    {
+      cp_extension_t* props = GetFirstExtPoint(cp_addon, ADDON_UNKNOWN);
+      if (props != nullptr)
+      {
+        std::string value = GetPlatformLibraryName(props->plugin->extensions->configuration);
+        if (!value.empty() &&
+            props->plugin->plugin_path &&
+            strcmp(props->plugin->plugin_path, "") != 0 &&
+            Factory(cp_addon, ADDON_UNKNOWN, builder, true))
+        {
+          binaryAddonList.push_back(BINARY_ADDON_LIST_ENTRY(!IsAddonDisabled(cp_addon->identifier), std::move(builder.GetAddonInfo())));
+        }
+      }
+      m_cpluff->release_info(m_cp_context, cp_addon);
+    }
+  }
+
+  return !binaryAddonList.empty();
+}
+
 bool CAddonMgr::GetAddonsInternal(const TYPE &type, VECADDONS &addons, bool enabledOnly)
 {
   CSingleLock lock(m_critSection);

diff --git a/xbmc/addons/AddonManager.h b/xbmc/addons/AddonManager.h
@@ -29,7 +29,6 @@
 #include <map>
 #include <deque>
 
-
 class DllLibCPluff;
 extern "C"
 {
@@ -42,6 +41,16 @@ namespace ADDON
   typedef std::map<TYPE, VECADDONS>::iterator IMAPADDONS;
   typedef std::vector<cp_cfg_element_t*> ELEMENTS;
 
+  /*!
+   * @brief The value binaryAddonList use a tuple in following construct:
+   * | Number | Type        | Description
+   * |:------:|------------:|:------------------------------------------------
+   * | first  | boolean     | If true addon is enabled, otherwise disabled
+   * | second | CAddonInfo  | Information data of addon
+   */
+  typedef std::pair<bool, CAddonInfo> BINARY_ADDON_LIST_ENTRY;
+  typedef std::vector<BINARY_ADDON_LIST_ENTRY> BINARY_ADDON_LIST;
+
   const std::string ADDON_PYTHON_EXT           = "*.py";
 
   /**
@@ -117,6 +126,18 @@ namespace ADDON
 
     bool GetInstallableAddons(VECADDONS& addons, const TYPE &type);
 
+    /*!
+     * @brief To get all installed binary addon on Kodi
+     *
+     * This function becomes used from ADDON::CBinaryAddonManager to get his
+     * related addons (whether enabled or disabled).
+     *
+     * @param[out] binaryAddonList The list where from here the binary addons
+     *                             becomes stored.
+     * @return                     If list is not empty becomes true returned
+     */
+    bool GetInstalledBinaryAddons(BINARY_ADDON_LIST& binaryAddonList);
+
     /*! Get the installable addon with the highest version. */
     bool FindInstallableById(const std::string& addonId, AddonPtr& addon);
 

diff --git a/xbmc/addons/AudioDecoder.h b/xbmc/addons/AudioDecoder.h
@@ -18,7 +18,7 @@
  */
 #pragma once
 
-#include "AddonDll.h"
+#include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-addon-dev-kit/include/kodi/kodi_audiodec_types.h"
 #include "cores/paplayer/ICodec.h"
 #include "music/tags/ImusicInfoTagLoader.h"

diff --git a/xbmc/addons/AudioEncoder.h b/xbmc/addons/AudioEncoder.h
@@ -18,7 +18,7 @@
  */
 #pragma once
 
-#include "AddonDll.h"
+#include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-addon-dev-kit/include/kodi/xbmc_audioenc_types.h"
 #include "cdrip/IEncoder.h"
 

diff --git a/xbmc/addons/CMakeLists.txt b/xbmc/addons/CMakeLists.txt
@@ -2,10 +2,8 @@ set(SOURCES Addon.cpp
             AddonBuilder.cpp
             BinaryAddonCache.cpp
             AddonDatabase.cpp
-            AddonDll.cpp
             AddonInfo.cpp
             AddonInstaller.cpp
-            AddonInstanceHandler.cpp
             AddonManager.cpp
             AddonStatusHandler.cpp
             AddonSystemSettings.cpp
@@ -41,10 +39,8 @@ set(HEADERS Addon.h
             AddonEvents.h
             BinaryAddonCache.h
             AddonDatabase.h
-            AddonDll.h
             AddonInfo.h
             AddonInstaller.h
-            AddonInstanceHandler.h
             AddonManager.h
             AddonStatusHandler.h
             AddonSystemSettings.h
@@ -53,7 +49,6 @@ set(HEADERS Addon.h
             AudioEncoder.h
             ContextMenuAddon.h
             ContextMenus.h
-            DllAddon.h
             DllLibCPluff.h
             FilesystemInstaller.h
             GameResource.h

diff --git a/xbmc/addons/ImageDecoder.h b/xbmc/addons/ImageDecoder.h
@@ -18,7 +18,7 @@
  */
 #pragma once
 
-#include "AddonDll.h"
+#include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-addon-dev-kit/include/kodi/kodi_imagedec_types.h"
 #include "guilib/iimage.h"
 

diff --git a/xbmc/addons/InputStream.h b/xbmc/addons/InputStream.h
@@ -18,7 +18,7 @@
  */
 #pragma once
 
-#include "AddonDll.h"
+#include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-addon-dev-kit/include/kodi/kodi_inputstream_types.h"
 #include "FileItem.h"
 #include "cores/VideoPlayer/DVDDemuxers/DVDDemuxUtils.h"

diff --git a/xbmc/addons/PVRClient.h b/xbmc/addons/PVRClient.h
@@ -25,7 +25,7 @@
 #include <vector>
 
 #include "addons/Addon.h"
-#include "addons/AddonDll.h"
+#include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-addon-dev-kit/include/kodi/xbmc_pvr_types.h"
 
 #include "pvr/channels/PVRChannel.h"

diff --git a/xbmc/addons/ScreenSaver.cpp b/xbmc/addons/ScreenSaver.cpp
@@ -27,8 +27,8 @@
 namespace ADDON
 {
 
-CScreenSaver::CScreenSaver(AddonDllPtr addonInfo)
- : IAddonInstanceHandler(ADDON_INSTANCE_SCREENSAVER, addonInfo)
+CScreenSaver::CScreenSaver(BinaryAddonBasePtr addonBase)
+ : IAddonInstanceHandler(ADDON_INSTANCE_SCREENSAVER, addonBase)
 {
   m_name = Name();
   m_presets = CSpecialProtocol::TranslatePath(Path());

diff --git a/xbmc/addons/ScreenSaver.h b/xbmc/addons/ScreenSaver.h
@@ -20,15 +20,15 @@
 #pragma once
 
 #include "addons/kodi-addon-dev-kit/include/kodi/addon-instance/Screensaver.h"
-#include "addons/AddonInstanceHandler.h"
+#include "addons/binary-addons/AddonInstanceHandler.h"
 
 namespace ADDON
 {
 
 class CScreenSaver : public IAddonInstanceHandler
 {
 public:
-  CScreenSaver(AddonDllPtr addonInfo);
+  CScreenSaver(BinaryAddonBasePtr addonBase);
   virtual ~CScreenSaver();
 
   bool Start();

diff --git a/xbmc/addons/VFSEntry.h b/xbmc/addons/VFSEntry.h
@@ -18,7 +18,7 @@
  */
 #pragma once
 
-#include "AddonDll.h"
+#include "addons/binary-addons/AddonDll.h"
 #include "addons/kodi-addon-dev-kit/include/kodi/kodi_vfs_types.h"
 #include "filesystem/IFile.h"
 #include "filesystem/IDirectory.h"

diff --git a/xbmc/addons/Visualization.cpp b/xbmc/addons/Visualization.cpp
@@ -30,8 +30,8 @@
 namespace ADDON
 {
 
-CVisualization::CVisualization(ADDON::AddonDllPtr addonInfo, float x, float y, float w, float h)
-  : IAddonInstanceHandler(ADDON_INSTANCE_VISUALIZATION, addonInfo)
+CVisualization::CVisualization(ADDON::BinaryAddonBasePtr addonBase, float x, float y, float w, float h)
+  : IAddonInstanceHandler(ADDON_INSTANCE_VISUALIZATION, addonBase)
 {
   // Setup new Visualization instance
   m_name = Name();

diff --git a/xbmc/addons/Visualization.h b/xbmc/addons/Visualization.h
@@ -20,15 +20,15 @@
  */
 
 #include "addons/kodi-addon-dev-kit/include/kodi/addon-instance/Visualization.h"
-#include "addons/AddonInstanceHandler.h"
+#include "addons/binary-addons/AddonInstanceHandler.h"
 
 namespace ADDON
 {
 
 class CVisualization : public IAddonInstanceHandler
 {
 public:
-  CVisualization(ADDON::AddonDllPtr addonInfo, float x, float y, float w, float h);
+  CVisualization(ADDON::BinaryAddonBasePtr addonBase, float x, float y, float w, float h);
   virtual ~CVisualization();
 
   bool Start(int channels, int samplesPerSec, int bitsPerSample, const std::string& songName);