PVRDatabase.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 "dbwrappers/Database.h"
#include "threads/CriticalSection.h"

#include <map>
#include <vector>

namespace PVR
{
  class CPVRChannel;
  class CPVRChannelGroup;
  class CPVRChannelGroupMember;
  class CPVRChannelGroups;
  class CPVRProvider;
  class CPVRProviders;
  class CPVRClient;
  class CPVRTimerInfoTag;
  class CPVRTimers;

  static constexpr int CHANNEL_COMMIT_QUERY_COUNT_LIMIT = 10000;

  class CPVRDatabase : public CDatabase
  {
  public:
    CPVRDatabase() = default;
    ~CPVRDatabase() override = default;

    bool Open() override;

    void Close() override;

    void Lock();

    void Unlock();

    int GetSchemaVersion() const override { return 44; }

    const char* GetBaseDBName() const override { return "TV"; }


    bool DeleteClients();

    bool Persist(const CPVRClient& client);

    bool Delete(const CPVRClient& client);

    int GetPriority(const CPVRClient& client) const;


    bool DeleteChannels();

    int Get(bool bRadio,
            const std::vector<std::shared_ptr<CPVRClient>>& clients,
            std::map<std::pair<int, int>, std::shared_ptr<CPVRChannel>>& results) const;

    bool Persist(CPVRChannel& channel, bool bCommit);

    bool QueueDeleteQuery(const CPVRChannel& channel);



    bool QueueDeleteQuery(const CPVRChannelGroupMember& groupMember);



    bool DeleteProviders();

    bool Persist(CPVRProvider& provider, bool updateRecord = false);

    bool Delete(const CPVRProvider& provider);

    bool Get(CPVRProviders& results, const std::vector<std::shared_ptr<CPVRClient>>& clients) const;

    int GetMaxProviderId() const;



    bool DeleteChannelGroups();

    bool Delete(const CPVRChannelGroup& group);

    int GetLocalGroups(CPVRChannelGroups& results) const;

    int Get(CPVRChannelGroups& results,
            const std::vector<std::shared_ptr<CPVRClient>>& clients) const;

    std::vector<std::shared_ptr<CPVRChannelGroupMember>> Get(
        const CPVRChannelGroup& group,
        const std::vector<std::shared_ptr<CPVRClient>>& clients) const;

    bool Persist(CPVRChannelGroup& group);

    bool ResetEPG();


    std::vector<std::shared_ptr<CPVRTimerInfoTag>> GetTimers(
        CPVRTimers& timers, const std::vector<std::shared_ptr<CPVRClient>>& clients) const;

    bool Persist(CPVRTimerInfoTag& timer);

    bool Delete(const CPVRTimerInfoTag& timer);

    bool DeleteTimers();


    bool UpdateLastWatched(const CPVRChannel& channel, int groupId);

    bool UpdateLastWatched(const CPVRChannelGroup& group);

    bool UpdateLastOpened(const CPVRChannelGroup& group);

  private:
    void CreateTables() override;
    void CreateAnalytics() override;
    void UpdateTables(int version) override;
    int GetMinSchemaVersion() const override { return 11; }

    int GetGroups(CPVRChannelGroups& results, const std::string& query) const;

    bool PersistGroupMembers(const CPVRChannelGroup& group);

    bool PersistChannels(const CPVRChannelGroup& group);

    bool RemoveChannelsFromGroup(const CPVRChannelGroup& group);

    mutable CCriticalSection m_critSection;
  };
}