/xbmc/addons/binary-addons/AddonInstanceHandler.cpp

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#include "AddonInstanceHandler.h"

#include "ServiceBroker.h"
#include "addons/settings/AddonSettings.h"
#include "filesystem/Directory.h"
#include "filesystem/SpecialProtocol.h"
#include "utils/StringUtils.h"
#include "utils/log.h"

namespace ADDON
{

CCriticalSection IAddonInstanceHandler::m_cdSec;

IAddonInstanceHandler::IAddonInstanceHandler(ADDON_TYPE type,
                                             const AddonInfoPtr& addonInfo,
                                             KODI_HANDLE parentInstance /* = nullptr*/,
                                             const std::string& instanceID /* = ""*/)
  : m_type(type), m_parentInstance(parentInstance), m_addonInfo(addonInfo)
{
  // if no special instance ID is given generate one from class pointer (is
  // faster as unique id and also safe enough for them).
  m_instanceId = !instanceID.empty() ? instanceID : StringUtils::Format("{}", fmt::ptr(this));
  m_addonBase = CServiceBroker::GetBinaryAddonManager().GetAddonBase(addonInfo, this, m_addon);

  KODI_ADDON_INSTANCE_INFO* info = new KODI_ADDON_INSTANCE_INFO();
  info->number = 0;
  info->id = m_instanceId.c_str();
  info->version = kodi::addon::GetTypeVersion(m_type);
  info->type = m_type;
  info->kodi = this;
  info->parent = m_parentInstance;
  info->first_instance = m_addon && !m_addon->Initialized();
  info->functions = new KODI_ADDON_INSTANCE_FUNC_CB();
  info->functions->get_instance_user_path = get_instance_user_path;
  info->functions->is_instance_setting_using_default = is_instance_setting_using_default;
  info->functions->get_instance_setting_bool = get_instance_setting_bool;
  info->functions->get_instance_setting_int = get_instance_setting_int;
  info->functions->get_instance_setting_float = get_instance_setting_float;
  info->functions->get_instance_setting_string = get_instance_setting_string;
  info->functions->set_instance_setting_bool = set_instance_setting_bool;
  info->functions->set_instance_setting_int = set_instance_setting_int;
  info->functions->set_instance_setting_float = set_instance_setting_float;
  info->functions->set_instance_setting_string = set_instance_setting_string;
  m_ifc.info = info;
  m_ifc.functions = new KODI_ADDON_INSTANCE_FUNC();
}

IAddonInstanceHandler::~IAddonInstanceHandler()
{
  CServiceBroker::GetBinaryAddonManager().ReleaseAddonBase(m_addonBase, this);

  delete m_ifc.functions;
  if (m_ifc.info)
    delete m_ifc.info->functions;
  delete m_ifc.info;
}

std::string IAddonInstanceHandler::ID() const
{
  return m_addon ? m_addon->ID() : "";
}

std::string IAddonInstanceHandler::Name() const
{
  return m_addon ? m_addon->Name() : "";
}

std::string IAddonInstanceHandler::Author() const
{
  return m_addon ? m_addon->Author() : "";
}

std::string IAddonInstanceHandler::Icon() const
{
  return m_addon ? m_addon->Icon() : "";
}

std::string IAddonInstanceHandler::Path() const
{
  return m_addon ? m_addon->Path() : "";
}

std::string IAddonInstanceHandler::Profile() const
{
  return m_addon ? m_addon->Profile() : "";
}

AddonVersion IAddonInstanceHandler::Version() const
{
  return m_addon ? m_addon->Version() : AddonVersion();
}

ADDON_STATUS IAddonInstanceHandler::CreateInstance()
{
  if (!m_addon)
    return ADDON_STATUS_UNKNOWN;

  CSingleLock lock(m_cdSec);

  ADDON_STATUS status = m_addon->CreateInstance(&m_ifc);
  if (status != ADDON_STATUS_OK)
  {
    CLog::Log(LOGERROR,
              "IAddonInstanceHandler::{}: {} returned bad status \"{}\" during instance creation",
              __func__, m_addon->ID(), kodi::addon::TranslateAddonStatus(status));
  }
  return status;
}

void IAddonInstanceHandler::DestroyInstance()
{
  CSingleLock lock(m_cdSec);
  if (m_addon)
    m_addon->DestroyInstance(&m_ifc);
}

std::shared_ptr<CSetting> IAddonInstanceHandler::GetSetting(const std::string& setting)
{
  if (!m_addon->HasSettings())
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - couldn't get settings for add-on '{}'",
              __func__, Name());
    return nullptr;
  }

  auto value = m_addon->GetSettings()->GetSetting(setting);
  if (value == nullptr)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - can't find setting '{}' in '{}'", __func__,
              setting, Name());
    return nullptr;
  }

  return value;
}

char* IAddonInstanceHandler::get_instance_user_path(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance)
    return nullptr;

  const std::string path = CSpecialProtocol::TranslatePath(instance->m_addon->Profile());

  XFILE::CDirectory::Create(path);
  return strdup(path.c_str());
}

bool IAddonInstanceHandler::is_instance_setting_using_default(
    const KODI_ADDON_INSTANCE_BACKEND_HDL hdl, const char* id)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id)
    return false;

  auto setting = instance->GetSetting(id);
  if (setting == nullptr)
    return false;

  return setting->IsDefault();
}

bool IAddonInstanceHandler::get_instance_setting_bool(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                      const char* id,
                                                      bool* value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id || !value)
    return false;

  auto setting = instance->GetSetting(id);
  if (setting == nullptr)
    return false;

  if (setting->GetType() != SettingType::Boolean)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - setting '{}' is not a boolean in '{}'",
              __func__, id, instance->Name());
    return false;
  }

  *value = std::static_pointer_cast<CSettingBool>(setting)->GetValue();
  return true;
}

bool IAddonInstanceHandler::get_instance_setting_int(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                     const char* id,
                                                     int* value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id || !value)
    return false;

  auto setting = instance->GetSetting(id);
  if (setting == nullptr)
    return false;

  if (setting->GetType() != SettingType::Integer && setting->GetType() != SettingType::Number)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - setting '{}' is not a integer in '{}'",
              __func__, id, instance->Name());
    return false;
  }

  if (setting->GetType() == SettingType::Integer)
    *value = std::static_pointer_cast<CSettingInt>(setting)->GetValue();
  else
    *value = static_cast<int>(std::static_pointer_cast<CSettingNumber>(setting)->GetValue());
  return true;
}

bool IAddonInstanceHandler::get_instance_setting_float(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                       const char* id,
                                                       float* value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id || !value)
    return false;

  auto setting = instance->GetSetting(id);
  if (setting == nullptr)
    return false;

  if (setting->GetType() != SettingType::Number)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - setting '{}' is not a number in '{}'",
              __func__, id, instance->Name());
    return false;
  }

  *value = static_cast<float>(std::static_pointer_cast<CSettingNumber>(setting)->GetValue());
  return true;
}

bool IAddonInstanceHandler::get_instance_setting_string(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                        const char* id,
                                                        char** value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id || !value)
    return false;

  auto setting = instance->GetSetting(id);
  if (setting == nullptr)
    return false;

  if (setting->GetType() != SettingType::String)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - setting '{}' is not a string in '{}'",
              __func__, id, instance->Name());
    return false;
  }

  *value = strdup(std::static_pointer_cast<CSettingString>(setting)->GetValue().c_str());
  return true;
}

bool IAddonInstanceHandler::set_instance_setting_bool(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                      const char* id,
                                                      bool value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id)
    return false;

  if (Interface_Base::UpdateSettingInActiveDialog(instance->m_addon.get(), id,
                                                  value ? "true" : "false"))
    return true;

  if (!instance->m_addon->UpdateSettingBool(id, value))
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - invalid setting type", __func__);
    return false;
  }

  instance->m_addon->SaveSettings();

  return true;
}

bool IAddonInstanceHandler::set_instance_setting_int(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                     const char* id,
                                                     int value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - invalid data (instance='{}', id='{}')",
              __func__, hdl, static_cast<const void*>(id));

    return false;
  }

  if (Interface_Base::UpdateSettingInActiveDialog(instance->m_addon.get(), id,
                                                  std::to_string(value)))
    return true;

  if (!instance->m_addon->UpdateSettingInt(id, value))
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - invalid setting type", __func__);
    return false;
  }

  instance->m_addon->SaveSettings();

  return true;
}

bool IAddonInstanceHandler::set_instance_setting_float(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                       const char* id,
                                                       float value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id)
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - invalid data (instance='{}', id='{}')",
              __func__, hdl, static_cast<const void*>(id));

    return false;
  }

  if (Interface_Base::UpdateSettingInActiveDialog(instance->m_addon.get(), id,
                                                  StringUtils::Format("{:f}", value)))
    return true;

  if (!instance->m_addon->UpdateSettingNumber(id, static_cast<double>(value)))
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - invalid setting type", __func__);
    return false;
  }

  instance->m_addon->SaveSettings();

  return true;
}

bool IAddonInstanceHandler::set_instance_setting_string(const KODI_ADDON_INSTANCE_BACKEND_HDL hdl,
                                                        const char* id,
                                                        const char* value)
{
  IAddonInstanceHandler* instance = static_cast<IAddonInstanceHandler*>(hdl);
  if (!instance || !id || !value)
  {
    CLog::Log(LOGERROR,
              "IAddonInstanceHandler::{} - invalid data (instance='{}', id='{}', value='{}')",
              __func__, hdl, static_cast<const void*>(id), static_cast<const void*>(value));

    return false;
  }

  if (Interface_Base::UpdateSettingInActiveDialog(instance->m_addon.get(), id, value))
    return true;

  if (!instance->m_addon->UpdateSettingString(id, value))
  {
    CLog::Log(LOGERROR, "IAddonInstanceHandler::{} - invalid setting type", __func__);
    return false;
  }

  instance->m_addon->SaveSettings();

  return true;
}

} /* namespace ADDON */