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