diff options
Diffstat (limited to 'xbmc/pvr/channels/PVRChannelGroup.h')
| -rw-r--r-- | xbmc/pvr/channels/PVRChannelGroup.h | 548 |
1 files changed, 548 insertions, 0 deletions
diff --git a/xbmc/pvr/channels/PVRChannelGroup.h b/xbmc/pvr/channels/PVRChannelGroup.h new file mode 100644 index 0000000..66c45d6 --- /dev/null +++ b/xbmc/pvr/channels/PVRChannelGroup.h @@ -0,0 +1,548 @@ +/* + * 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 "pvr/channels/PVRChannelGroupSettings.h" +#include "pvr/channels/PVRChannelNumber.h" +#include "pvr/channels/PVRChannelsPath.h" +#include "utils/EventStream.h" + +#include <map> +#include <memory> +#include <string> +#include <utility> +#include <vector> + +struct PVR_CHANNEL_GROUP; + +namespace PVR +{ +#define PVR_GROUP_TYPE_DEFAULT 0 +#define PVR_GROUP_TYPE_INTERNAL 1 +#define PVR_GROUP_TYPE_USER_DEFINED 2 + +enum class PVREvent; + +class CPVRChannel; +class CPVRChannelGroupMember; +class CPVRClient; +class CPVREpgInfoTag; + +enum RenumberMode +{ + NORMAL = 0, + IGNORE_NUMBERING_FROM_ONE = 1 +}; + +using GroupMemberPair = + std::pair<std::shared_ptr<CPVRChannelGroupMember>, std::shared_ptr<CPVRChannelGroupMember>>; + +class CPVRChannelGroup : public IChannelGroupSettingsCallback +{ + friend class CPVRDatabase; + +public: + static const int INVALID_GROUP_ID = -1; + + /*! + * @brief Create a new channel group instance. + * @param path The channel group path. + * @param allChannelsGroup The channel group containing all TV or radio channels. + */ + CPVRChannelGroup(const CPVRChannelsPath& path, + const std::shared_ptr<CPVRChannelGroup>& allChannelsGroup); + + /*! + * @brief Create a new channel group instance from a channel group provided by an add-on. + * @param group The channel group provided by the add-on. + * @param allChannelsGroup The channel group containing all TV or radio channels. + */ + CPVRChannelGroup(const PVR_CHANNEL_GROUP& group, + const std::shared_ptr<CPVRChannelGroup>& allChannelsGroup); + + ~CPVRChannelGroup() override; + + bool operator==(const CPVRChannelGroup& right) const; + bool operator!=(const CPVRChannelGroup& right) const; + + /*! + * @brief Copy over data to the given PVR_CHANNEL_GROUP instance. + * @param group The group instance to fill. + */ + void FillAddonData(PVR_CHANNEL_GROUP& group) const; + + /*! + * @brief Query the events available for CEventStream + */ + CEventStream<PVREvent>& Events() { return m_events; } + + /*! + * @brief Load the channels from the database. + * @param channels All available channels. + * @param clients The PVR clients data should be loaded for. Leave empty for all clients. + * @return True when loaded successfully, false otherwise. + */ + virtual bool LoadFromDatabase( + const std::map<std::pair<int, int>, std::shared_ptr<CPVRChannel>>& channels, + const std::vector<std::shared_ptr<CPVRClient>>& clients); + + /*! + * @brief Clear all data. + */ + virtual void Unload(); + + /*! + * @return The amount of group members + */ + size_t Size() const; + + /*! + * @brief Update data with channel group members from the given clients, sync with local data. + * @param clients The clients to fetch data from. Leave empty to fetch data from all created clients. + * @return True on success, false otherwise. + */ + virtual bool UpdateFromClients(const std::vector<std::shared_ptr<CPVRClient>>& clients); + + /*! + * @brief Get the path of this group. + * @return the path. + */ + const CPVRChannelsPath& GetPath() const; + + /*! + * @brief Set the path of this group. + * @param the path. + */ + void SetPath(const CPVRChannelsPath& path); + + /*! + * @brief Change the channelnumber of a group. Used by CGUIDialogPVRChannelManager. + * Call SortByChannelNumber() and Renumber() after all changes are done. + * @param channel The channel to change the channel number for. + * @param channelNumber The new channel number. + */ + bool SetChannelNumber(const std::shared_ptr<CPVRChannel>& channel, + const CPVRChannelNumber& channelNumber); + + /*! + * @brief Remove a channel from this container. + * @param channel The channel to remove. + * @return True if the channel was found and removed, false otherwise. + */ + virtual bool RemoveFromGroup(const std::shared_ptr<CPVRChannel>& channel); + + /*! + * @brief Append a channel to this container. + * @param channel The channel to append. + * @return True if the channel was appended, false otherwise. + */ + virtual bool AppendToGroup(const std::shared_ptr<CPVRChannel>& channel); + + /*! + * @brief Change the name of this group. + * @param strGroupName The new group name. + */ + void SetGroupName(const std::string& strGroupName); + + /*! + * @brief Persist changed or new data. + * @return True if the channel was persisted, false otherwise. + */ + bool Persist(); + + /*! + * @brief Check whether a channel is in this container. + * @param channel The channel to find. + * @return True if the channel was found, false otherwise. + */ + virtual bool IsGroupMember(const std::shared_ptr<CPVRChannel>& channel) const; + + /*! + * @brief Check if this group is the internal group containing all channels. + * @return True if it's the internal group, false otherwise. + */ + bool IsInternalGroup() const { return m_iGroupType == PVR_GROUP_TYPE_INTERNAL; } + + /*! + * @brief True if this group holds radio channels, false if it holds TV channels. + * @return True if this group holds radio channels, false if it holds TV channels. + */ + bool IsRadio() const; + + /*! + * @brief The database ID of this group. + * @return The database ID of this group. + */ + int GroupID() const; + + /*! + * @brief Set the database ID of this group. + * @param iGroupId The new database ID. + */ + void SetGroupID(int iGroupId); + + /*! + * @brief Set the type of this group. + * @param the new type for this group. + */ + void SetGroupType(int iGroupType); + + /*! + * @brief Return the type of this group. + */ + int GroupType() const; + + /*! + * @return Time group has been watched last. + */ + time_t LastWatched() const; + + /*! + * @brief Last time group has been watched + * @param iLastWatched The new value. + */ + void SetLastWatched(time_t iLastWatched); + + /*! + * @return Time in milliseconds from epoch this group was last opened. + */ + uint64_t LastOpened() const; + + /*! + * @brief Set the time in milliseconds from epoch this group was last opened. + * @param iLastOpened The new value. + */ + void SetLastOpened(uint64_t iLastOpened); + + /*! + * @brief The name of this group. + * @return The name of this group. + */ + std::string GroupName() const; + + /*! @name Sort methods + */ + //@{ + + /*! + * @brief Sort the group. + */ + void Sort(); + + /*! + * @brief Sort the group and fix up channel numbers. + * @return True when numbering changed, false otherwise + */ + bool SortAndRenumber(); + + /*! + * @brief Remove invalid channels and updates the channel numbers. + * @param mode the numbering mode to use + * @return True if something changed, false otherwise. + */ + bool Renumber(RenumberMode mode = NORMAL); + + //@} + + // IChannelGroupSettingsCallback implementation + void UseBackendChannelOrderChanged() override; + void UseBackendChannelNumbersChanged() override; + void StartGroupChannelNumbersFromOneChanged() override; + + /*! + * @brief Get the channel group member that was played last. + * @param iCurrentChannel The channelid of the current channel that is playing, or -1 if none + * @return The requested channel group member or nullptr. + */ + std::shared_ptr<CPVRChannelGroupMember> GetLastPlayedChannelGroupMember( + int iCurrentChannel = -1) const; + + /*! + * @brief Get the last and previous to last played channel group members. + * @return The members. pair.first contains the last, pair.second the previous to last member. + */ + GroupMemberPair GetLastAndPreviousToLastPlayedChannelGroupMember() const; + + /*! + * @brief Get a channel group member given it's active channel number + * @param channelNumber The channel number. + * @return The channel group member or nullptr if it wasn't found. + */ + std::shared_ptr<CPVRChannelGroupMember> GetByChannelNumber( + const CPVRChannelNumber& channelNumber) const; + + /*! + * @brief Get the channel number in this group of the given channel. + * @param channel The channel to get the channel number for. + * @return The channel number in this group. + */ + CPVRChannelNumber GetChannelNumber(const std::shared_ptr<CPVRChannel>& channel) const; + + /*! + * @brief Get the client channel number in this group of the given channel. + * @param channel The channel to get the channel number for. + * @return The client channel number in this group. + */ + CPVRChannelNumber GetClientChannelNumber(const std::shared_ptr<CPVRChannel>& channel) const; + + /*! + * @brief Get the next channel group member in this group. + * @param groupMember The current channel group member. + * @return The channel group member or nullptr if it wasn't found. + */ + std::shared_ptr<CPVRChannelGroupMember> GetNextChannelGroupMember( + const std::shared_ptr<CPVRChannelGroupMember>& groupMember) const; + + /*! + * @brief Get the previous channel group member in this group. + * @param groupMember The current channel group member. + * @return The channel group member or nullptr if it wasn't found. + */ + std::shared_ptr<CPVRChannelGroupMember> GetPreviousChannelGroupMember( + const std::shared_ptr<CPVRChannelGroupMember>& groupMember) const; + + /*! + * @brief Get a channel given it's channel ID. + * @param iChannelID The channel ID. + * @return The channel or NULL if it wasn't found. + */ + std::shared_ptr<CPVRChannel> GetByChannelID(int iChannelID) const; + + enum class Include + { + ALL, + ONLY_HIDDEN, + ONLY_VISIBLE + }; + + /*! + * @brief Get the current members of this group + * @param eFilter A filter to apply. + * @return The group members + */ + std::vector<std::shared_ptr<CPVRChannelGroupMember>> GetMembers( + Include eFilter = Include::ALL) const; + + /*! + * @brief Get the list of active channel numbers in a group. + * @param channelNumbers The list to store the numbers in. + */ + void GetChannelNumbers(std::vector<std::string>& channelNumbers) const; + + /*! + * @brief The amount of hidden channels in this container. + * @return The amount of hidden channels in this container. + */ + virtual size_t GetNumHiddenChannels() const { return 0; } + + /*! + * @brief Does this container holds channels. + * @return True if there is at least one channel in this container, otherwise false. + */ + bool HasChannels() const; + + /*! + * @return True if there is at least one new channel in this group that hasn't been persisted, false otherwise. + */ + bool HasNewChannels() const; + + /*! + * @return True if anything changed in this group that hasn't been persisted, false otherwise. + */ + bool HasChanges() const; + + /*! + * @return True if the group was never persisted, false otherwise. + */ + bool IsNew() const; + + /*! + * @brief Create an EPG table for each channel. + * @brief bForce Create the tables, even if they already have been created before. + * @return True if all tables were created successfully, false otherwise. + */ + virtual bool CreateChannelEpgs(bool bForce = false); + + /*! + * @brief Update a channel group member with given data. + * @param storageId The storage id of the channel. + * @param strChannelName The channel name to set. + * @param strIconPath The icon path to set. + * @param iEPGSource The EPG id. + * @param iChannelNumber The channel number to set. + * @param bHidden Set/Remove hidden flag for the channel group member identified by storage id. + * @param bEPGEnabled Set/Remove EPG enabled flag for the channel group member identified by storage id. + * @param bParentalLocked Set/Remove parental locked flag for the channel group member identified by storage id. + * @param bUserSetIcon Set/Remove user set icon flag for the channel group member identified by storage id. + * @param bUserSetHidden Set/Remove user set hidden flag for the channel group member identified by storage id. + * @return True on success, false otherwise. + */ + bool UpdateChannel(const std::pair<int, int>& storageId, + const std::string& strChannelName, + const std::string& strIconPath, + int iEPGSource, + int iChannelNumber, + bool bHidden, + bool bEPGEnabled, + bool bParentalLocked, + bool bUserSetIcon, + bool bUserSetHidden); + + /*! + * @brief Get a channel given the channel number on the client. + * @param iUniqueChannelId The unique channel id on the client. + * @param iClientID The ID of the client. + * @return The channel or NULL if it wasn't found. + */ + std::shared_ptr<CPVRChannel> GetByUniqueID(int iUniqueChannelId, int iClientID) const; + + /*! + * @brief Get a channel group member given its storage id. + * @param id The storage id (a pair of client id and unique channel id). + * @return The channel group member or nullptr if it wasn't found. + */ + std::shared_ptr<CPVRChannelGroupMember> GetByUniqueID(const std::pair<int, int>& id) const; + + bool SetHidden(bool bHidden); + bool IsHidden() const; + + int GetPosition() const; + void SetPosition(int iPosition); + + /*! + * @brief Check, whether data for a given pvr client are currently valid. For instance, data + * can be invalid because the client's backend was offline when data was last queried. + * @param iClientId The id of the client. + * @return True, if data is currently valid, false otherwise. + */ + bool HasValidDataForClient(int iClientId) const; + + /*! + * @brief Check, whether data for given pvr clients are currently valid. For instance, data + * can be invalid because the client's backend was offline when data was last queried. + * @param clients The clients to check. Check all active clients if vector is empty. + * @return True, if data is currently valid, false otherwise. + */ + bool HasValidDataForClients(const std::vector<std::shared_ptr<CPVRClient>>& clients) const; + + /*! + * @brief Update the channel numbers according to the all channels group and publish event. + * @return True, if a channel number was changed, false otherwise. + */ + bool UpdateChannelNumbersFromAllChannelsGroup(); + + /*! + * @brief Remove this group from database. + */ + void Delete(); + + /*! + * @brief Whether this group is deleted. + * @return True, if deleted, false otherwise. + */ + bool IsDeleted() const { return m_bDeleted; } + + /*! + * @brief Erase stale texture db entries and image files. + * @return number of cleaned up images. + */ + int CleanupCachedImages(); + +protected: + /*! + * @brief Remove deleted group members from this group. + * @param groupMembers The group members to use to update this list. + * @return The removed members . + */ + virtual std::vector<std::shared_ptr<CPVRChannelGroupMember>> RemoveDeletedGroupMembers( + const std::vector<std::shared_ptr<CPVRChannelGroupMember>>& groupMembers); + + /*! + * @brief Update the current channel group members with the given list. + * @param groupMembers The group members to use to update this list. + * @return True if everything went well, false otherwise. + */ + bool UpdateGroupEntries(const std::vector<std::shared_ptr<CPVRChannelGroupMember>>& groupMembers); + + /*! + * @brief Sort the current channel list by client channel number. + */ + void SortByClientChannelNumber(); + + /*! + * @brief Sort the current channel list by channel number. + */ + void SortByChannelNumber(); + + /*! + * @brief Update the priority for all members of all channel groups. + */ + bool UpdateClientPriorities(); + + std::shared_ptr<CPVRChannelGroupSettings> GetSettings() const; + + int m_iGroupType = PVR_GROUP_TYPE_DEFAULT; /*!< The type of this group */ + int m_iGroupId = INVALID_GROUP_ID; /*!< The ID of this group in the database */ + bool m_bLoaded = false; /*!< True if this container is loaded, false otherwise */ + bool m_bChanged = + false; /*!< true if anything changed in this group that hasn't been persisted, false otherwise */ + time_t m_iLastWatched = 0; /*!< last time group has been watched */ + uint64_t m_iLastOpened = 0; /*!< time in milliseconds from epoch this group was last opened */ + bool m_bHidden = false; /*!< true if this group is hidden, false otherwise */ + int m_iPosition = 0; /*!< the position of this group within the group list */ + std::vector<std::shared_ptr<CPVRChannelGroupMember>> + m_sortedMembers; /*!< members sorted by channel number */ + std::map<std::pair<int, int>, std::shared_ptr<CPVRChannelGroupMember>> + m_members; /*!< members with key clientid+uniqueid */ + mutable CCriticalSection m_critSection; + std::vector<int> m_failedClients; + CEventSource<PVREvent> m_events; + mutable std::shared_ptr<CPVRChannelGroupSettings> m_settings; + + // the settings singleton shared between all group instances + static CCriticalSection m_settingsSingletonCritSection; + static std::weak_ptr<CPVRChannelGroupSettings> m_settingsSingleton; + +private: + /*! + * @brief Load the channel group members stored in the database. + * @param clients The PVR clients to load data for. Leave empty for all clients. + * @return The amount of channel group members that were added. + */ + int LoadFromDatabase(const std::vector<std::shared_ptr<CPVRClient>>& clients); + + /*! + * @brief Delete channel group members from database. + * @param membersToDelete The channel group members. + */ + void DeleteGroupMembersFromDb( + const std::vector<std::shared_ptr<CPVRChannelGroupMember>>& membersToDelete); + + /*! + * @brief Update this group's data with a channel group member provided by a client. + * @param groupMember The updated group member. + * @return True if group member data were changed, false otherwise. + */ + bool UpdateFromClient(const std::shared_ptr<CPVRChannelGroupMember>& groupMember); + + /*! + * @brief Add new channel group members to this group; update data. + * @param groupMembers The group members to use to update this list. + * @return True if group member data were changed, false otherwise. + */ + bool AddAndUpdateGroupMembers( + const std::vector<std::shared_ptr<CPVRChannelGroupMember>>& groupMembers); + + void OnSettingChanged(); + + std::shared_ptr<CPVRChannelGroup> m_allChannelsGroup; + CPVRChannelsPath m_path; + bool m_bDeleted = false; +}; +} // namespace PVR |