PVRProviders.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 "threads/CriticalSection.h"

#include <memory>
#include <vector>

namespace PVR
{
class CPVRClient;
class CPVRProvider;

enum class ProviderUpdateMode;

class CPVRProvidersContainer
{
public:
  bool UpdateFromClient(const std::shared_ptr<CPVRProvider>& provider);

  std::shared_ptr<CPVRProvider> GetByClient(int iClientId, int iUniqueId) const;

  std::vector<std::shared_ptr<CPVRProvider>> GetProvidersList() const;

  std::size_t GetNumProviders() const;

protected:
  void InsertEntry(const std::shared_ptr<CPVRProvider>& newProvider, ProviderUpdateMode updateMode);

  mutable CCriticalSection m_critSection;
  int m_iLastId = 0;
  std::vector<std::shared_ptr<CPVRProvider>> m_providers;
};

class CPVRProviders : public CPVRProvidersContainer
{
public:
  CPVRProviders() = default;
  ~CPVRProviders() = default;

  bool Update(const std::vector<std::shared_ptr<CPVRClient>>& clients);

  void Unload();

  bool UpdateFromClients(const std::vector<std::shared_ptr<CPVRClient>>& clients);

  bool LoadFromDatabase(const std::vector<std::shared_ptr<CPVRClient>>& clients);

  std::shared_ptr<CPVRProvider> CheckAndAddEntry(const std::shared_ptr<CPVRProvider>& newProvider,
                                                 ProviderUpdateMode updateMode);

  std::shared_ptr<CPVRProvider> CheckAndPersistEntry(
      const std::shared_ptr<CPVRProvider>& newProvider, ProviderUpdateMode updateMode);

  bool PersistUserChanges(const std::vector<std::shared_ptr<CPVRProvider>>& providers);

  std::shared_ptr<CPVRProvider> GetById(int iProviderId) const;

  int CleanupCachedImages();

private:
  void RemoveEntry(const std::shared_ptr<CPVRProvider>& provider);
  bool UpdateDefaultEntries(const CPVRProvidersContainer& newProviders);
  bool UpdateClientEntries(const CPVRProvidersContainer& newProviders,
                           const std::vector<int>& failedClients,
                           const std::vector<int>& disabledClients);

  bool m_bIsUpdating = false;
};
} // namespace PVR