PVRProvider.h

/*
 *  Copyright (C) 2012-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.
 */

#pragma once

#include "addons/kodi-dev-kit/include/kodi/c-api/addon-instance/pvr/pvr_providers.h"
#include "pvr/PVRCachedImage.h"
#include "threads/CriticalSection.h"
#include "utils/ISerializable.h"

#include <memory>
#include <string>
#include <vector>

namespace PVR
{

enum class ProviderUpdateMode
{
  BY_CLIENT,
  BY_DATABASE
};

static constexpr int PVR_PROVIDER_ADDON_UID = -1;
static constexpr int PVR_PROVIDER_INVALID_DB_ID = -1;

class CPVRProvider final : public ISerializable
{
public:
  static const std::string IMAGE_OWNER_PATTERN;

  CPVRProvider(int iUniqueId, int iClientId);
  CPVRProvider(const PVR_PROVIDER& provider, int iClientId);
  CPVRProvider(int iClientId,
               const std::string& addonProviderName,
               const std::string& addonIconPath,
               const std::string& addonThumbPath);

  bool operator==(const CPVRProvider& right) const;
  bool operator!=(const CPVRProvider& right) const;

  void Serialize(CVariant& value) const override;

  int GetDatabaseId() const;

  bool SetDatabaseId(int iDatabaseId);

  int GetUniqueId() const;

  int GetClientId() const;

  std::string GetName() const;

  bool SetName(const std::string& iName);

  bool HasType() const { return m_type != PVR_PROVIDER_TYPE_UNKNOWN; }

  PVR_PROVIDER_TYPE GetType() const;

  bool SetType(PVR_PROVIDER_TYPE type);

  std::string GetIconPath() const;

  bool SetIconPath(const std::string& strIconPath);

  std::string GetClientIconPath() const;

  std::vector<std::string> GetCountries() const;

  bool SetCountries(const std::vector<std::string>& countries);

  std::string GetCountriesDBString() const;

  bool SetCountriesFromDBString(const std::string& strCountries);

  std::vector<std::string> GetLanguages() const;

  bool SetLanguages(const std::vector<std::string>& languages);

  std::string GetLanguagesDBString() const;

  bool SetLanguagesFromDBString(const std::string& strLanguages);

  bool HasThumbPath() const;

  std::string GetThumbPath() const;

  std::string GetClientThumbPath() const;

  bool IsClientProvider() const { return m_bIsClientProvider; }

  bool UpdateEntry(const std::shared_ptr<CPVRProvider>& fromProvider,
                   ProviderUpdateMode updateMode);

  bool Persist(bool updateRecord = false);

  bool DeleteFromDatabase();

private:
  CPVRProvider(const CPVRProvider& provider) = delete;
  CPVRProvider& operator=(const CPVRProvider& orig) = delete;

  int m_iDatabaseId = PVR_PROVIDER_INVALID_DB_ID; 
  int m_iUniqueId = PVR_PROVIDER_ADDON_UID; 
  int m_iClientId; 
  std::string m_strName; 
  PVR_PROVIDER_TYPE m_type = PVR_PROVIDER_TYPE_UNKNOWN; 
  CPVRCachedImage m_iconPath; 
  std::string m_strCountries; 
  std::string m_strLanguages; 
  bool m_bIsClientProvider = false; 
  CPVRCachedImage m_thumbPath; 
  mutable CCriticalSection m_critSection;
};
} // namespace PVR