diff options
Diffstat (limited to 'xbmc/view/GUIViewState.cpp')
| -rw-r--r-- | xbmc/view/GUIViewState.cpp | 637 |
1 files changed, 637 insertions, 0 deletions
diff --git a/xbmc/view/GUIViewState.cpp b/xbmc/view/GUIViewState.cpp new file mode 100644 index 0000000..358bb63 --- /dev/null +++ b/xbmc/view/GUIViewState.cpp @@ -0,0 +1,637 @@ +/* + * Copyright (C) 2005-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. + */ + +#include "view/GUIViewState.h" + +#include "AutoSwitch.h" +#include "FileItem.h" +#include "GUIPassword.h" +#include "PlayListPlayer.h" +#include "ServiceBroker.h" +#include "URL.h" +#include "ViewDatabase.h" +#include "addons/Addon.h" +#include "addons/AddonManager.h" +#include "addons/PluginSource.h" +#include "addons/addoninfo/AddonType.h" +#include "addons/gui/GUIViewStateAddonBrowser.h" +#include "dialogs/GUIDialogSelect.h" +#include "events/windows/GUIViewStateEventLog.h" +#include "favourites/GUIViewStateFavourites.h" +#include "games/windows/GUIViewStateWindowGames.h" +#include "guilib/GUIComponent.h" +#include "guilib/GUIWindowManager.h" +#include "guilib/LocalizeStrings.h" +#include "guilib/TextureManager.h" +#include "music/GUIViewStateMusic.h" +#include "pictures/GUIViewStatePictures.h" +#include "profiles/ProfileManager.h" +#include "programs/GUIViewStatePrograms.h" +#include "pvr/windows/GUIViewStatePVR.h" +#include "settings/MediaSourceSettings.h" +#include "settings/SettingUtils.h" +#include "settings/Settings.h" +#include "settings/SettingsComponent.h" +#include "settings/lib/Setting.h" +#include "utils/URIUtils.h" +#include "video/GUIViewStateVideo.h" +#include "view/ViewState.h" + +#define PROPERTY_SORT_ORDER "sort.order" +#define PROPERTY_SORT_ASCENDING "sort.ascending" + +using namespace KODI; +using namespace ADDON; +using namespace PVR; + +std::string CGUIViewState::m_strPlaylistDirectory; +VECSOURCES CGUIViewState::m_sources; + +static const int SETTING_AUTOPLAYNEXT_MUSICVIDEOS = 0; +static const int SETTING_AUTOPLAYNEXT_TVSHOWS = 1; +static const int SETTING_AUTOPLAYNEXT_EPISODES = 2; +static const int SETTING_AUTOPLAYNEXT_MOVIES = 3; +static const int SETTING_AUTOPLAYNEXT_UNCATEGORIZED = 4; + +CGUIViewState* CGUIViewState::GetViewState(int windowId, const CFileItemList& items) +{ + // don't expect derived classes to clear the sources + m_sources.clear(); + + if (windowId == 0) + return GetViewState(CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow(),items); + + const CURL url=items.GetURL(); + + if (items.IsAddonsPath()) + return new CGUIViewStateAddonBrowser(items); + + if (items.HasSortDetails()) + return new CGUIViewStateFromItems(items); + + if (url.IsProtocol("musicdb")) + return new CGUIViewStateMusicDatabase(items); + + if (url.IsProtocol("musicsearch")) + return new CGUIViewStateMusicSearch(items); + + if (items.IsSmartPlayList() || url.IsProtocol("upnp") || + items.IsLibraryFolder()) + { + if (items.GetContent() == "songs" || + items.GetContent() == "albums" || + items.GetContent() == "mixed") + return new CGUIViewStateMusicSmartPlaylist(items); + else if (items.GetContent() == "musicvideos") + return new CGUIViewStateVideoMusicVideos(items); + else if (items.GetContent() == "tvshows") + return new CGUIViewStateVideoTVShows(items); + else if (items.GetContent() == "episodes") + return new CGUIViewStateVideoEpisodes(items); + else if (items.GetContent() == "movies") + return new CGUIViewStateVideoMovies(items); + } + + if (url.IsProtocol("library")) + return new CGUIViewStateLibrary(items); + + if (items.IsPlayList()) + { + // Playlists (like .strm) can be music or video type + if (windowId == WINDOW_VIDEO_NAV) + return new CGUIViewStateVideoPlaylist(items); + else + return new CGUIViewStateMusicPlaylist(items); + } + + if (items.GetPath() == "special://musicplaylists/") + return new CGUIViewStateWindowMusicNav(items); + + if (url.IsProtocol("androidapp")) + return new CGUIViewStateWindowPrograms(items); + + if (url.IsProtocol("activities")) + return new CGUIViewStateEventLog(items); + + if (windowId == WINDOW_MUSIC_NAV) + return new CGUIViewStateWindowMusicNav(items); + + if (windowId == WINDOW_MUSIC_PLAYLIST) + return new CGUIViewStateWindowMusicPlaylist(items); + + if (windowId == WINDOW_MUSIC_PLAYLIST_EDITOR) + return new CGUIViewStateWindowMusicNav(items); + + if (windowId == WINDOW_VIDEO_NAV) + return new CGUIViewStateWindowVideoNav(items); + + if (windowId == WINDOW_VIDEO_PLAYLIST) + return new CGUIViewStateWindowVideoPlaylist(items); + + if (windowId == WINDOW_TV_CHANNELS) + return new CGUIViewStateWindowPVRChannels(windowId, items); + + if (windowId == WINDOW_TV_RECORDINGS) + return new CGUIViewStateWindowPVRRecordings(windowId, items); + + if (windowId == WINDOW_TV_GUIDE) + return new CGUIViewStateWindowPVRGuide(windowId, items); + + if (windowId == WINDOW_TV_TIMERS) + return new CGUIViewStateWindowPVRTimers(windowId, items); + + if (windowId == WINDOW_TV_TIMER_RULES) + return new CGUIViewStateWindowPVRTimers(windowId, items); + + if (windowId == WINDOW_TV_SEARCH) + return new CGUIViewStateWindowPVRSearch(windowId, items); + + if (windowId == WINDOW_RADIO_CHANNELS) + return new CGUIViewStateWindowPVRChannels(windowId, items); + + if (windowId == WINDOW_RADIO_RECORDINGS) + return new CGUIViewStateWindowPVRRecordings(windowId, items); + + if (windowId == WINDOW_RADIO_GUIDE) + return new CGUIViewStateWindowPVRGuide(windowId, items); + + if (windowId == WINDOW_RADIO_TIMERS) + return new CGUIViewStateWindowPVRTimers(windowId, items); + + if (windowId == WINDOW_RADIO_TIMER_RULES) + return new CGUIViewStateWindowPVRTimers(windowId, items); + + if (windowId == WINDOW_RADIO_SEARCH) + return new CGUIViewStateWindowPVRSearch(windowId, items); + + if (windowId == WINDOW_PICTURES) + return new CGUIViewStateWindowPictures(items); + + if (windowId == WINDOW_PROGRAMS) + return new CGUIViewStateWindowPrograms(items); + + if (windowId == WINDOW_GAMES) + return new GAME::CGUIViewStateWindowGames(items); + + if (windowId == WINDOW_ADDON_BROWSER) + return new CGUIViewStateAddonBrowser(items); + + if (windowId == WINDOW_EVENT_LOG) + return new CGUIViewStateEventLog(items); + + if (windowId == WINDOW_FAVOURITES) + return new CGUIViewStateFavourites(items); + + // Use as fallback/default + return new CGUIViewStateGeneral(items); +} + +CGUIViewState::CGUIViewState(const CFileItemList& items) : m_items(items) +{ + m_currentViewAsControl = 0; + m_currentSortMethod = 0; + m_playlist = PLAYLIST::TYPE_NONE; +} + +CGUIViewState::~CGUIViewState() = default; + +SortOrder CGUIViewState::SetNextSortOrder() +{ + if (GetSortOrder() == SortOrderAscending) + SetSortOrder(SortOrderDescending); + else + SetSortOrder(SortOrderAscending); + + SaveViewState(); + + return GetSortOrder(); +} + +SortOrder CGUIViewState::GetSortOrder() const +{ + if (m_currentSortMethod >= 0 && m_currentSortMethod < (int)m_sortMethods.size()) + return m_sortMethods[m_currentSortMethod].m_sortDescription.sortOrder; + + return SortOrderAscending; +} + +int CGUIViewState::GetSortOrderLabel() const +{ + if (m_currentSortMethod >= 0 && m_currentSortMethod < (int)m_sortMethods.size()) + if (m_sortMethods[m_currentSortMethod].m_sortDescription.sortOrder == SortOrderDescending) + return 585; + + return 584; // default sort order label 'Ascending' +} + +int CGUIViewState::GetViewAsControl() const +{ + return m_currentViewAsControl; +} + +void CGUIViewState::SetViewAsControl(int viewAsControl) +{ + if (viewAsControl == DEFAULT_VIEW_AUTO) + m_currentViewAsControl = CAutoSwitch::GetView(m_items); + else + m_currentViewAsControl = viewAsControl; +} + +void CGUIViewState::SaveViewAsControl(int viewAsControl) +{ + SetViewAsControl(viewAsControl); + SaveViewState(); +} + +SortDescription CGUIViewState::GetSortMethod() const +{ + SortDescription sorting; + if (m_currentSortMethod >= 0 && m_currentSortMethod < (int)m_sortMethods.size()) + sorting = m_sortMethods[m_currentSortMethod].m_sortDescription; + + return sorting; +} + +bool CGUIViewState::HasMultipleSortMethods() const +{ + return m_sortMethods.size() > 1; +} + +int CGUIViewState::GetSortMethodLabel() const +{ + if (m_currentSortMethod >= 0 && m_currentSortMethod < (int)m_sortMethods.size()) + return m_sortMethods[m_currentSortMethod].m_buttonLabel; + + return 551; // default sort method label 'Name' +} + +void CGUIViewState::GetSortMethodLabelMasks(LABEL_MASKS& masks) const +{ + if (m_currentSortMethod >= 0 && m_currentSortMethod < (int)m_sortMethods.size()) + { + masks = m_sortMethods[m_currentSortMethod].m_labelMasks; + return; + } + + masks.m_strLabelFile.clear(); + masks.m_strLabel2File.clear(); + masks.m_strLabelFolder.clear(); + masks.m_strLabel2Folder.clear(); +} + +std::vector<SortDescription> CGUIViewState::GetSortDescriptions() const +{ + std::vector<SortDescription> descriptions; + for (const auto& desc : m_sortMethods) + { + descriptions.emplace_back(desc.m_sortDescription); + } + return descriptions; +} + +void CGUIViewState::AddSortMethod(SortBy sortBy, int buttonLabel, const LABEL_MASKS &labelMasks, SortAttribute sortAttributes /* = SortAttributeNone */, SortOrder sortOrder /* = SortOrderNone */) +{ + AddSortMethod(sortBy, sortAttributes, buttonLabel, labelMasks, sortOrder); +} + +void CGUIViewState::AddSortMethod(SortBy sortBy, SortAttribute sortAttributes, int buttonLabel, const LABEL_MASKS &labelMasks, SortOrder sortOrder /* = SortOrderNone */) +{ + for (size_t i = 0; i < m_sortMethods.size(); ++i) + if (m_sortMethods[i].m_sortDescription.sortBy == sortBy) + return; + + // handle unspecified sort order + if (sortBy != SortByNone && sortOrder == SortOrderNone) + { + // the following sort methods are sorted in descending order by default + if (sortBy == SortByDate || sortBy == SortBySize || sortBy == SortByPlaycount || + sortBy == SortByRating || sortBy == SortByProgramCount || + sortBy == SortByBitrate || sortBy == SortByListeners || + sortBy == SortByUserRating || sortBy == SortByLastPlayed) + sortOrder = SortOrderDescending; + else + sortOrder = SortOrderAscending; + } + + GUIViewSortDetails sort; + sort.m_sortDescription.sortBy = sortBy; + sort.m_sortDescription.sortOrder = sortOrder; + sort.m_sortDescription.sortAttributes = sortAttributes; + sort.m_buttonLabel = buttonLabel; + sort.m_labelMasks = labelMasks; + m_sortMethods.push_back(sort); +} + +void CGUIViewState::AddSortMethod(SortDescription sortDescription, int buttonLabel, const LABEL_MASKS &labelMasks) +{ + AddSortMethod(sortDescription.sortBy, sortDescription.sortAttributes, buttonLabel, labelMasks, sortDescription.sortOrder); +} + +void CGUIViewState::SetCurrentSortMethod(int method) +{ + SortBy sortBy = (SortBy)method; + if (sortBy < SortByNone || sortBy > SortByLastUsed) + return; // invalid + + SetSortMethod(sortBy); + SaveViewState(); +} + +void CGUIViewState::SetSortMethod(SortBy sortBy, SortOrder sortOrder /* = SortOrderNone */) +{ + for (int i = 0; i < (int)m_sortMethods.size(); ++i) + { + if (m_sortMethods[i].m_sortDescription.sortBy == sortBy) + { + m_currentSortMethod = i; + break; + } + } + + if (sortOrder != SortOrderNone) + SetSortOrder(sortOrder); +} + +void CGUIViewState::SetSortMethod(SortDescription sortDescription) +{ + return SetSortMethod(sortDescription.sortBy, sortDescription.sortOrder); +} + +bool CGUIViewState::ChooseSortMethod() +{ + + CGUIDialogSelect *dialog = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogSelect>(WINDOW_DIALOG_SELECT); + if (!dialog) + return false; + dialog->Reset(); + dialog->SetHeading(CVariant{ 39010 }); // Label "Sort by" + for (auto &sortMethod : m_sortMethods) + dialog->Add(g_localizeStrings.Get(sortMethod.m_buttonLabel)); + dialog->SetSelected(m_currentSortMethod); + dialog->Open(); + int newSelected = dialog->GetSelectedItem(); + // check if selection has changed + if (!dialog->IsConfirmed() || newSelected < 0 || newSelected == m_currentSortMethod) + return false; + + m_currentSortMethod = newSelected; + SaveViewState(); + return true; +} + +SortDescription CGUIViewState::SetNextSortMethod(int direction /* = 1 */) +{ + m_currentSortMethod += direction; + + if (m_currentSortMethod >= (int)m_sortMethods.size()) + m_currentSortMethod = 0; + if (m_currentSortMethod < 0) + m_currentSortMethod = m_sortMethods.size() ? (int)m_sortMethods.size() - 1 : 0; + + SaveViewState(); + + return GetSortMethod(); +} + +bool CGUIViewState::HideExtensions() +{ + return !CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(CSettings::SETTING_FILELISTS_SHOWEXTENSIONS); +} + +bool CGUIViewState::HideParentDirItems() +{ + return !CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(CSettings::SETTING_FILELISTS_SHOWPARENTDIRITEMS); +} + +bool CGUIViewState::DisableAddSourceButtons() +{ + const std::shared_ptr<CProfileManager> profileManager = CServiceBroker::GetSettingsComponent()->GetProfileManager(); + + if (profileManager->GetCurrentProfile().canWriteSources() || g_passwordManager.bMasterUser) + return !CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(CSettings::SETTING_FILELISTS_SHOWADDSOURCEBUTTONS); + + return true; +} + +PLAYLIST::Id CGUIViewState::GetPlaylist() const +{ + return m_playlist; +} + +const std::string& CGUIViewState::GetPlaylistDirectory() +{ + return m_strPlaylistDirectory; +} + +void CGUIViewState::SetPlaylistDirectory(const std::string& strDirectory) +{ + m_strPlaylistDirectory = strDirectory; + URIUtils::RemoveSlashAtEnd(m_strPlaylistDirectory); +} + +bool CGUIViewState::IsCurrentPlaylistDirectory(const std::string& strDirectory) +{ + if (CServiceBroker::GetPlaylistPlayer().GetCurrentPlaylist()!=GetPlaylist()) + return false; + + std::string strDir = strDirectory; + URIUtils::RemoveSlashAtEnd(strDir); + + return m_strPlaylistDirectory == strDir; +} + +bool CGUIViewState::AutoPlayNextItem() +{ + return false; +} + +std::string CGUIViewState::GetLockType() +{ + return ""; +} + +std::string CGUIViewState::GetExtensions() +{ + return ""; +} + +VECSOURCES& CGUIViewState::GetSources() +{ + return m_sources; +} + +void CGUIViewState::AddLiveTVSources() +{ + VECSOURCES *sources = CMediaSourceSettings::GetInstance().GetSources("video"); + for (IVECSOURCES it = sources->begin(); it != sources->end(); it++) + { + if (URIUtils::IsLiveTV((*it).strPath)) + { + CMediaSource source; + source.strPath = (*it).strPath; + source.strName = (*it).strName; + source.vecPaths = (*it).vecPaths; + source.m_strThumbnailImage = ""; + source.FromNameAndPaths("video", source.strName, source.vecPaths); + m_sources.push_back(source); + } + } +} + +void CGUIViewState::SetSortOrder(SortOrder sortOrder) +{ + if (sortOrder == SortOrderNone) + return; + + if (m_currentSortMethod < 0 || m_currentSortMethod >= (int)m_sortMethods.size()) + return; + + m_sortMethods[m_currentSortMethod].m_sortDescription.sortOrder = sortOrder; +} + +bool CGUIViewState::AutoPlayNextVideoItem() const +{ + if (GetPlaylist() != PLAYLIST::TYPE_VIDEO) + return false; + + int settingValue(-1); + if (m_items.GetContent() == "musicvideos") + settingValue = SETTING_AUTOPLAYNEXT_MUSICVIDEOS; + else if (m_items.GetContent() == "tvshows") + settingValue = SETTING_AUTOPLAYNEXT_TVSHOWS; + else if (m_items.GetContent() == "episodes") + settingValue = SETTING_AUTOPLAYNEXT_EPISODES; + else if (m_items.GetContent() == "movies") + settingValue = SETTING_AUTOPLAYNEXT_MOVIES; + else + settingValue = SETTING_AUTOPLAYNEXT_UNCATEGORIZED; + + const auto setting = std::dynamic_pointer_cast<CSettingList>( + CServiceBroker::GetSettingsComponent()->GetSettings()->GetSetting( + CSettings::SETTING_VIDEOPLAYER_AUTOPLAYNEXTITEM)); + + return settingValue >= 0 && setting != nullptr && + CSettingUtils::FindIntInList(setting, settingValue); +} + +void CGUIViewState::LoadViewState(const std::string &path, int windowID) +{ // get our view state from the db + CViewDatabase db; + if (!db.Open()) + return; + + CViewState state; + if (db.GetViewState(path, windowID, state, CServiceBroker::GetSettingsComponent()->GetSettings()->GetString(CSettings::SETTING_LOOKANDFEEL_SKIN)) || + db.GetViewState(path, windowID, state, "")) + { + SetViewAsControl(state.m_viewMode); + SetSortMethod(state.m_sortDescription); + } +} + +void CGUIViewState::SaveViewToDb(const std::string &path, int windowID, CViewState *viewState) +{ + CViewDatabase db; + if (!db.Open()) + return; + + SortDescription sorting = GetSortMethod(); + CViewState state(m_currentViewAsControl, sorting.sortBy, sorting.sortOrder, sorting.sortAttributes); + if (viewState != NULL) + *viewState = state; + + const std::shared_ptr<CSettings> settings = CServiceBroker::GetSettingsComponent()->GetSettings(); + db.SetViewState(path, windowID, state, settings->GetString(CSettings::SETTING_LOOKANDFEEL_SKIN)); + db.Close(); + + if (viewState != NULL) + settings->Save(); +} + +void CGUIViewState::AddPlaylistOrder(const CFileItemList& items, const LABEL_MASKS& label_masks) +{ + SortBy sortBy = SortByPlaylistOrder; + int sortLabel = 559; + SortOrder sortOrder = SortOrderAscending; + if (items.HasProperty(PROPERTY_SORT_ORDER)) + { + sortBy = (SortBy)items.GetProperty(PROPERTY_SORT_ORDER).asInteger(); + if (sortBy != SortByNone) + { + sortLabel = SortUtils::GetSortLabel(sortBy); + sortOrder = items.GetProperty(PROPERTY_SORT_ASCENDING).asBoolean() ? SortOrderAscending : SortOrderDescending; + } + } + + AddSortMethod(sortBy, sortLabel, label_masks, SortAttributeNone, sortOrder); + SetSortMethod(sortBy, sortOrder); +} + +CGUIViewStateGeneral::CGUIViewStateGeneral(const CFileItemList& items) : CGUIViewState(items) +{ + AddSortMethod(SortByLabel, 551, LABEL_MASKS("%F", "%I", "%L", "")); // Filename, size | Foldername, empty + SetSortMethod(SortByLabel); + + SetViewAsControl(DEFAULT_VIEW_LIST); +} + +CGUIViewStateFromItems::CGUIViewStateFromItems(const CFileItemList &items) : CGUIViewState(items) +{ + const std::vector<GUIViewSortDetails> &details = items.GetSortDetails(); + for (unsigned int i = 0; i < details.size(); i++) + { + const GUIViewSortDetails& sort = details[i]; + AddSortMethod(sort.m_sortDescription, sort.m_buttonLabel, sort.m_labelMasks); + } + //! @todo Should default sort/view mode be specified? + m_currentSortMethod = 0; + + SetViewAsControl(DEFAULT_VIEW_LIST); + + if (items.IsPlugin()) + { + CURL url(items.GetPath()); + AddonPtr addon; + if (CServiceBroker::GetAddonMgr().GetAddon(url.GetHostName(), addon, AddonType::PLUGIN, + OnlyEnabled::CHOICE_YES)) + { + const auto plugin = std::static_pointer_cast<CPluginSource>(addon); + if (plugin->Provides(CPluginSource::AUDIO)) + m_playlist = PLAYLIST::TYPE_MUSIC; + if (plugin->Provides(CPluginSource::VIDEO)) + m_playlist = PLAYLIST::TYPE_VIDEO; + } + } + + LoadViewState(items.GetPath(), CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow()); +} + +bool CGUIViewStateFromItems::AutoPlayNextItem() +{ + return AutoPlayNextVideoItem(); +} + +void CGUIViewStateFromItems::SaveViewState() +{ + SaveViewToDb(m_items.GetPath(), CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow()); +} + +CGUIViewStateLibrary::CGUIViewStateLibrary(const CFileItemList &items) : CGUIViewState(items) +{ + AddSortMethod(SortByNone, 551, LABEL_MASKS("%F", "%I", "%L", "")); // Filename, Size | Foldername, empty + SetSortMethod(SortByNone); + + SetViewAsControl(DEFAULT_VIEW_LIST); + + LoadViewState(items.GetPath(), CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow()); +} + +void CGUIViewStateLibrary::SaveViewState() +{ + SaveViewToDb(m_items.GetPath(), CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow()); +} |