xbmc/favourites/ContextMenus.cpp

   1 /*
   2  *  Copyright (C) 2016-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #include "ContextMenus.h"
  10
  11 #include "ContextMenuManager.h"
  12 #include "FileItem.h"
  13 #include "ServiceBroker.h"
  14 #include "favourites/FavouritesService.h"
  15 #include "favourites/FavouritesURL.h"
  16 #include "favourites/FavouritesUtils.h"
  17 #include "guilib/LocalizeStrings.h"
  18 #include "utils/URIUtils.h"
  19 #include "utils/Variant.h"
  20 #include "utils/guilib/GUIBuiltinsUtils.h"
  21 #include "utils/guilib/GUIContentUtils.h"
  22 #include "video/VideoUtils.h"
  23 #include "video/guilib/VideoGUIUtils.h"
  24
  25 using namespace CONTEXTMENU;
  26 using namespace KODI;
  27 using namespace KODI::UTILS::GUILIB;
  28
  29 bool CFavouriteContextMenuAction::IsVisible(const CFileItem& item) const
  30 {
  31   return URIUtils::IsProtocol(item.GetPath(), "favourites");
  32 }
  33
  34 bool CFavouriteContextMenuAction::Execute(const std::shared_ptr<CFileItem>& item) const
  35 {
  36   CFileItemList items;
  37   CServiceBroker::GetFavouritesService().GetAll(items);
  38
  39   const auto it = std::find_if(items.cbegin(), items.cend(), [&item](const auto& favourite) {
  40     return favourite->GetPath() == item->GetPath();
  41   });
  42
  43   if ((it != items.cend()) && DoExecute(items, *it))
  44     return CServiceBroker::GetFavouritesService().Save(items);
  45
  46   return false;
  47 }
  48
  49 bool CMoveUpFavourite::DoExecute(CFileItemList& items, const std::shared_ptr<CFileItem>& item) const
  50 {
  51   return FAVOURITES_UTILS::MoveItem(items, item, -1);
  52 }
  53
  54 bool CMoveUpFavourite::IsVisible(const CFileItem& item) const
  55 {
  56   return CFavouriteContextMenuAction::IsVisible(item) && FAVOURITES_UTILS::ShouldEnableMoveItems();
  57 }
  58
  59 bool CMoveDownFavourite::DoExecute(CFileItemList& items,
  60                                    const std::shared_ptr<CFileItem>& item) const
  61 {
  62   return FAVOURITES_UTILS::MoveItem(items, item, +1);
  63 }
  64
  65 bool CMoveDownFavourite::IsVisible(const CFileItem& item) const
  66 {
  67   return CFavouriteContextMenuAction::IsVisible(item) && FAVOURITES_UTILS::ShouldEnableMoveItems();
  68 }
  69
  70 bool CRemoveFavourite::DoExecute(CFileItemList& items, const std::shared_ptr<CFileItem>& item) const
  71 {
  72   return FAVOURITES_UTILS::RemoveItem(items, item);
  73 }
  74
  75 bool CRenameFavourite::DoExecute(CFileItemList&, const std::shared_ptr<CFileItem>& item) const
  76 {
  77   return FAVOURITES_UTILS::ChooseAndSetNewName(*item);
  78 }
  79
  80 bool CChooseThumbnailForFavourite::DoExecute(CFileItemList&,
  81                                              const std::shared_ptr<CFileItem>& item) const
  82 {
  83   return FAVOURITES_UTILS::ChooseAndSetNewThumbnail(*item);
  84 }
  85
  86 namespace
  87 {
  88 std::shared_ptr<CFileItem> ResolveFavouriteItem(const CFileItem& item)
  89 {
  90   std::shared_ptr<CFileItem> targetItem{
  91       CServiceBroker::GetFavouritesService().ResolveFavourite(item)};
  92   if (targetItem)
  93     targetItem->SetProperty("hide_add_remove_favourite", CVariant{true});
  94
  95   return targetItem;
  96 }
  97
  98 bool IsPlayMediaFavourite(const CFileItem& item)
  99 {
 100   if (item.IsFavourite())
 101   {
 102     const CFavouritesURL favURL{item, -1};
 103     if (favURL.IsValid())
 104       return favURL.GetAction() == CFavouritesURL::Action::PLAY_MEDIA;
 105   }
 106   return false;
 107 }
 108
 109 bool IsActivateWindowFavourite(const CFileItem& item)
 110 {
 111   if (item.IsFavourite())
 112   {
 113     const CFavouritesURL favURL{item, -1};
 114     if (favURL.IsValid())
 115       return favURL.GetAction() == CFavouritesURL::Action::ACTIVATE_WINDOW;
 116   }
 117   return false;
 118 }
 119 } // unnamed namespace
 120
 121 bool CFavouritesTargetBrowse::IsVisible(const CFileItem& item) const
 122 {
 123   return IsActivateWindowFavourite(item);
 124 }
 125
 126 bool CFavouritesTargetBrowse::Execute(const std::shared_ptr<CFileItem>& item) const
 127 {
 128   return FAVOURITES_UTILS::ExecuteAction({*item, -1}, item);
 129 }
 130
 131 std::string CFavouritesTargetResume::GetLabel(const CFileItem& item) const
 132 {
 133   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(item)};
 134   if (targetItem)
 135     return VIDEO::UTILS::GetResumeString(*targetItem);
 136
 137   return {};
 138 }
 139
 140 bool CFavouritesTargetResume::IsVisible(const CFileItem& item) const
 141 {
 142   if (IsPlayMediaFavourite(item))
 143   {
 144     const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(item)};
 145     if (targetItem)
 146       return VIDEO::UTILS::GetItemResumeInformation(*targetItem).isResumable;
 147   }
 148   return false;
 149 }
 150
 151 bool CFavouritesTargetResume::Execute(const std::shared_ptr<CFileItem>& item) const
 152 {
 153   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(*item)};
 154   if (targetItem)
 155     return CGUIBuiltinsUtils::ExecutePlayMediaTryResume(targetItem);
 156
 157   return false;
 158 }
 159
 160 std::string CFavouritesTargetPlay::GetLabel(const CFileItem& item) const
 161 {
 162   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(item)};
 163   if (targetItem && VIDEO::UTILS::GetItemResumeInformation(*targetItem).isResumable)
 164     return g_localizeStrings.Get(12021); // Play from beginning
 165
 166   return g_localizeStrings.Get(208); // Play
 167 }
 168
 169 bool CFavouritesTargetPlay::IsVisible(const CFileItem& item) const
 170 {
 171   return IsPlayMediaFavourite(item);
 172 }
 173
 174 bool CFavouritesTargetPlay::Execute(const std::shared_ptr<CFileItem>& item) const
 175 {
 176   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(*item)};
 177   if (targetItem)
 178     return CGUIBuiltinsUtils::ExecutePlayMediaNoResume(targetItem);
 179
 180   return false;
 181 }
 182
 183 bool CFavouritesTargetInfo::IsVisible(const CFileItem& item) const
 184 {
 185   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(item)};
 186   if (targetItem)
 187     return UTILS::GUILIB::CGUIContentUtils::HasInfoForItem(*targetItem);
 188
 189   return false;
 190 }
 191
 192 bool CFavouritesTargetInfo::Execute(const std::shared_ptr<CFileItem>& item) const
 193 {
 194   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(*item)};
 195   if (targetItem)
 196     return UTILS::GUILIB::CGUIContentUtils::ShowInfoForItem(*targetItem);
 197
 198   return false;
 199 }
 200
 201 bool CFavouritesTargetContextMenu::IsVisible(const CFileItem& item) const
 202 {
 203   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(item)};
 204   if (targetItem)
 205     return CONTEXTMENU::HasAnyMenuItemsFor(targetItem, CContextMenuManager::MAIN);
 206
 207   return false;
 208 }
 209
 210 bool CFavouritesTargetContextMenu::Execute(const std::shared_ptr<CFileItem>& item) const
 211 {
 212   const std::shared_ptr<CFileItem> targetItem{ResolveFavouriteItem(*item)};
 213   if (targetItem)
 214   {
 215     CONTEXTMENU::ShowFor(targetItem, CContextMenuManager::MAIN);
 216     return true;
 217   }
 218   return false;
 219 }