EpgDatabase.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 <memory>
#include <vector>

class CDateTime;

namespace PVR
{
  class CPVREpg;
  class CPVREpgInfoTag;
  class CPVREpgSearchFilter;

  struct PVREpgSearchData;

  static constexpr int EPG_COMMIT_QUERY_COUNT_LIMIT = 10000;

  class CPVREpgDatabase : public CDatabase, public std::enable_shared_from_this<CPVREpgDatabase>
  {
  public:
    CPVREpgDatabase() = default;

    ~CPVREpgDatabase() override = default;

    bool Open() override;

    void Close() override;

    void Lock();

    void Unlock();

    int GetSchemaVersion() const override { return 16; }

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


    bool DeleteEpg();

    bool QueueDeleteEpgQuery(const CPVREpg& table);

    bool QueueDeleteTagQuery(const CPVREpgInfoTag& tag);

    std::vector<std::shared_ptr<CPVREpg>> GetAll();

    std::vector<std::shared_ptr<CPVREpgInfoTag>> GetAllEpgTags(int iEpgID) const;

    std::vector<std::string> GetAllIconPaths(int iEpgID) const;

    bool HasTags(int iEpgID) const;

    CDateTime GetLastEndTime(int iEpgID) const;

    std::pair<CDateTime, CDateTime> GetFirstAndLastEPGDate() const;

    CDateTime GetMinStartTime(int iEpgID, const CDateTime& minStart) const;

    CDateTime GetMaxEndTime(int iEpgID, const CDateTime& maxEnd) const;

    std::vector<std::shared_ptr<CPVREpgInfoTag>> GetEpgTags(
        const PVREpgSearchData& searchData) const;

    std::shared_ptr<CPVREpgInfoTag> GetEpgTagByUniqueBroadcastID(
        int iEpgID, unsigned int iUniqueBroadcastId) const;

    std::shared_ptr<CPVREpgInfoTag> GetEpgTagByDatabaseID(int iEpgID, int iDatabaseId) const;

    std::shared_ptr<CPVREpgInfoTag> GetEpgTagByStartTime(int iEpgID,
                                                         const CDateTime& startTime) const;

    std::shared_ptr<CPVREpgInfoTag> GetEpgTagByMinStartTime(int iEpgID,
                                                            const CDateTime& minStartTime) const;

    std::shared_ptr<CPVREpgInfoTag> GetEpgTagByMaxEndTime(int iEpgID,
                                                          const CDateTime& maxEndTime) const;

    std::vector<std::shared_ptr<CPVREpgInfoTag>> GetEpgTagsByMinStartMaxEndTime(
        int iEpgID, const CDateTime& minStartTime, const CDateTime& maxEndTime) const;

    std::vector<std::shared_ptr<CPVREpgInfoTag>> GetEpgTagsByMinEndMaxStartTime(
        int iEpgID, const CDateTime& minEndTime, const CDateTime& maxStartTime) const;

    bool QueueDeleteEpgTagsByMinEndMaxStartTimeQuery(int iEpgID,
                                                     const CDateTime& minEndTime,
                                                     const CDateTime& maxStartTime);

    bool GetLastEpgScanTime(int iEpgId, CDateTime* lastScan) const;

    bool QueuePersistLastEpgScanTimeQuery(int iEpgId, const CDateTime& lastScanTime);

    bool QueueDeleteLastEpgScanTimeQuery(const CPVREpg& table);

    int Persist(const CPVREpg& epg, bool bQueueWrite);

    bool DeleteEpgTags(int iEpgId, const CDateTime& maxEndTime);

    bool DeleteEpgTags(int iEpgId);

    bool QueueDeleteEpgTags(int iEpgId);

    bool QueuePersistQuery(const CPVREpgInfoTag& tag);

    int GetLastEPGId() const;



    std::vector<std::shared_ptr<CPVREpgSearchFilter>> GetSavedSearches(bool bRadio) const;

    std::shared_ptr<CPVREpgSearchFilter> GetSavedSearchById(bool bRadio, int iId) const;

    bool Persist(CPVREpgSearchFilter& epgSearch);

    bool UpdateSavedSearchLastExecuted(const CPVREpgSearchFilter& epgSearch);

    bool Delete(const CPVREpgSearchFilter& epgSearch);

    bool DeleteSavedSearches();


  private:
    void CreateTables() override;

    void CreateAnalytics() override;

    void UpdateTables(int version) override;

    int GetMinSchemaVersion() const override { return 4; }

    std::shared_ptr<CPVREpgInfoTag> CreateEpgTag(
        const std::unique_ptr<dbiplus::Dataset>& pDS) const;

    std::shared_ptr<CPVREpgSearchFilter> CreateEpgSearchFilter(
        bool bRadio, const std::unique_ptr<dbiplus::Dataset>& pDS) const;

    mutable CCriticalSection m_critSection;
  };
}