Epg.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 "XBDateTime.h"
#include "addons/kodi-dev-kit/include/kodi/c-api/addon-instance/pvr/pvr_epg.h"
#include "pvr/epg/EpgTagsContainer.h"
#include "threads/CriticalSection.h"
#include "utils/EventStream.h"

#include <atomic>
#include <map>
#include <memory>
#include <string>
#include <vector>

namespace PVR
{
  enum class PVREvent;

  class CPVREpgChannelData;
  class CPVREpgDatabase;
  class CPVREpgInfoTag;

  class CPVREpg
  {
    friend class CPVREpgDatabase;

  public:
    CPVREpg(int iEpgID,
            const std::string& strName,
            const std::string& strScraperName,
            const std::shared_ptr<CPVREpgDatabase>& database);

    CPVREpg(int iEpgID,
            const std::string& strName,
            const std::string& strScraperName,
            const std::shared_ptr<CPVREpgChannelData>& channelData,
            const std::shared_ptr<CPVREpgDatabase>& database);

    virtual ~CPVREpg();

    std::shared_ptr<CPVREpgChannelData> GetChannelData() const;

    void SetChannelData(const std::shared_ptr<CPVREpgChannelData>& data);

    int ChannelID() const;

    const std::string& ScraperName() const;

    bool UpdatePending() const;

    void ForceUpdate();

    const std::string& Name() const;

    int EpgID() const;

    void Cleanup(const CDateTime& time);

    void Clear();

    std::shared_ptr<CPVREpgInfoTag> GetTagNow() const;

    std::shared_ptr<CPVREpgInfoTag> GetTagNext() const;

    std::shared_ptr<CPVREpgInfoTag> GetTagPrevious() const;

    std::shared_ptr<CPVREpgInfoTag> GetTagBetween(const CDateTime& beginTime, const CDateTime& endTime, bool bUpdateFromClient = false);

    std::shared_ptr<CPVREpgInfoTag> GetTagByBroadcastId(unsigned int iUniqueBroadcastId) const;

    std::shared_ptr<CPVREpgInfoTag> GetTagByDatabaseId(int iDatabaseId) const;

    bool UpdateEntry(const EPG_TAG* data, int iClientId);

    bool UpdateEntry(const std::shared_ptr<CPVREpgInfoTag>& tag, EPG_EVENT_STATE newState);

    bool Update(time_t start, time_t end, int iUpdateTime, int iPastDays, const std::shared_ptr<CPVREpgDatabase>& database, bool bForceUpdate = false);

    std::vector<std::shared_ptr<CPVREpgInfoTag>> GetTags() const;

    std::vector<std::shared_ptr<CPVREpgInfoTag>> GetTimeline(const CDateTime& timelineStart,
                                                             const CDateTime& timelineEnd,
                                                             const CDateTime& minEventEnd,
                                                             const CDateTime& maxEventStart) const;

    bool QueuePersistQuery(const std::shared_ptr<CPVREpgDatabase>& database);

    bool QueueDeleteQueries(const std::shared_ptr<CPVREpgDatabase>& database);

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

    bool CheckPlayingEvent();

    static const std::string& ConvertGenreIdToString(int iID, int iSubID);

    bool NeedsSave() const;

    bool IsValid() const;

    CEventStream<PVREvent>& Events() { return m_events; }

    void Lock() { m_critSection.lock(); }

    void Unlock() { m_critSection.unlock(); }

    void RemovedFromContainer();

    int CleanupCachedImages(const std::shared_ptr<CPVREpgDatabase>& database);

  private:
    CPVREpg() = delete;
    CPVREpg(const CPVREpg&) = delete;
    CPVREpg& operator =(const CPVREpg&) = delete;

    bool UpdateFromScraper(time_t start, time_t end, bool bForceUpdate);

    bool UpdateEntries(const CPVREpg& epg);

    void Cleanup(int iPastDays);

    bool m_bChanged = false; 
    std::atomic<bool> m_bUpdatePending = {false}; 
    int m_iEpgID = 0; 
    std::string m_strName; 
    std::string m_strScraperName; 
    CDateTime m_lastScanTime; 
    mutable CCriticalSection m_critSection; 
    bool m_bUpdateLastScanTime = false;
    std::shared_ptr<CPVREpgChannelData> m_channelData;
    CPVREpgTagsContainer m_tags;

    CEventSource<PVREvent> m_events;
  };
}