[favourites] Refactor GUI actions.

xbmc/favourites/CMakeLists.txt

@@ -3,13 +3,15 @@ set(SOURCES ContextMenus.cpp
             GUIViewStateFavourites.cpp
             GUIWindowFavourites.cpp
             FavouritesService.cpp
-            FavouritesURL.cpp)
+            FavouritesURL.cpp
+            FavouritesUtils.cpp)
 
 set(HEADERS ContextMenus.h
             GUIDialogFavourites.h
             GUIViewStateFavourites.h
             GUIWindowFavourites.h
             FavouritesService.h
-            FavouritesURL.h)
+            FavouritesURL.h
+            FavouritesUtils.h)
 
 core_add_library(favourites)

xbmc/favourites/ContextMenus.cpp

@@ -11,10 +11,9 @@
 #include "FileItem.h"
 #include "ServiceBroker.h"
 #include "favourites/FavouritesService.h"
-#include "favourites/GUIWindowFavourites.h"
+#include "favourites/FavouritesUtils.h"
 #include "utils/URIUtils.h"
 
-
 namespace CONTEXTMENU
 {
   bool CFavouriteContextMenuAction::IsVisible(const CFileItem& item) const
@@ -40,42 +39,42 @@ namespace CONTEXTMENU
   bool CMoveUpFavourite::DoExecute(CFileItemList& items,
                                    const std::shared_ptr<CFileItem>& item) const
   {
-    return CGUIWindowFavourites::MoveItem(items, item, -1);
+    return FAVOURITES_UTILS::MoveItem(items, item, -1);
   }
 
   bool CMoveUpFavourite::IsVisible(const CFileItem& item) const
   {
     return CFavouriteContextMenuAction::IsVisible(item) &&
-           CGUIWindowFavourites::ShouldEnableMoveItems();
+           FAVOURITES_UTILS::ShouldEnableMoveItems();
   }
 
   bool CMoveDownFavourite::DoExecute(CFileItemList& items,
                                      const std::shared_ptr<CFileItem>& item) const
   {
-    return CGUIWindowFavourites::MoveItem(items, item, +1);
+    return FAVOURITES_UTILS::MoveItem(items, item, +1);
   }
 
   bool CMoveDownFavourite::IsVisible(const CFileItem& item) const
   {
     return CFavouriteContextMenuAction::IsVisible(item) &&
-           CGUIWindowFavourites::ShouldEnableMoveItems();
+           FAVOURITES_UTILS::ShouldEnableMoveItems();
   }
 
   bool CRemoveFavourite::DoExecute(CFileItemList& items,
                                    const std::shared_ptr<CFileItem>& item) const
   {
-    return CGUIWindowFavourites::RemoveItem(items, item);
+    return FAVOURITES_UTILS::RemoveItem(items, item);
   }
 
   bool CRenameFavourite::DoExecute(CFileItemList&, const std::shared_ptr<CFileItem>& item) const
   {
-    return CGUIWindowFavourites::ChooseAndSetNewName(*item);
+    return FAVOURITES_UTILS::ChooseAndSetNewName(*item);
   }
 
   bool CChooseThumbnailForFavourite::DoExecute(CFileItemList&,
                                                const std::shared_ptr<CFileItem>& item) const
   {
-    return CGUIWindowFavourites::ChooseAndSetNewThumbnail(*item);
+    return FAVOURITES_UTILS::ChooseAndSetNewThumbnail(*item);
   }
 
 } // namespace CONTEXTMENU

xbmc/favourites/FavouritesUtils.cpp

@@ -0,0 +1,124 @@
+/*
+ *  Copyright (C) 2023 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 "FavouritesUtils.h"
+
+#include "FileItem.h"
+#include "ServiceBroker.h"
+#include "dialogs/GUIDialogFileBrowser.h"
+#include "favourites/GUIWindowFavourites.h"
+#include "guilib/GUIComponent.h"
+#include "guilib/GUIKeyboardFactory.h"
+#include "guilib/GUIWindowManager.h"
+#include "guilib/LocalizeStrings.h"
+#include "storage/MediaManager.h"
+#include "utils/Variant.h"
+#include "view/GUIViewState.h"
+
+#include <string>
+
+namespace FAVOURITES_UTILS
+{
+bool ChooseAndSetNewName(CFileItem& item)
+{
+  std::string label = item.GetLabel();
+  if (CGUIKeyboardFactory::ShowAndGetInput(label, CVariant{g_localizeStrings.Get(16008)},
+                                           false)) // Enter new title
+  {
+    item.SetLabel(label);
+    return true;
+  }
+  return false;
+}
+
+bool ChooseAndSetNewThumbnail(CFileItem& item)
+{
+  CFileItemList prefilledItems;
+  if (item.HasArt("thumb"))
+  {
+    const auto current = std::make_shared<CFileItem>("thumb://Current", false);
+    current->SetArt("thumb", item.GetArt("thumb"));
+    current->SetLabel(g_localizeStrings.Get(20016)); // Current thumb
+    prefilledItems.Add(current);
+  }
+
+  const auto none = std::make_shared<CFileItem>("thumb://None", false);
+  none->SetArt("icon", item.GetArt("icon"));
+  none->SetLabel(g_localizeStrings.Get(20018)); // No thumb
+  prefilledItems.Add(none);
+
+  std::string thumb;
+  VECSOURCES sources;
+  CServiceBroker::GetMediaManager().GetLocalDrives(sources);
+  if (CGUIDialogFileBrowser::ShowAndGetImage(prefilledItems, sources, g_localizeStrings.Get(1030),
+                                             thumb)) // Browse for image
+  {
+    item.SetArt("thumb", thumb);
+    return true;
+  }
+  return false;
+}
+
+bool MoveItem(CFileItemList& items, const std::shared_ptr<CFileItem>& item, int amount)
+{
+  if (items.Size() < 2 || amount == 0)
+    return false;
+
+  int itemPos = -1;
+  for (const auto& i : items)
+  {
+    itemPos++;
+
+    if (i->GetPath() == item->GetPath())
+      break;
+  }
+
+  if (itemPos < 0 || itemPos >= items.Size())
+    return false;
+
+  int nextItem = (itemPos + amount) % items.Size();
+  if (nextItem < 0)
+  {
+    const auto itemToAdd(item);
+    items.Remove(itemPos);
+    items.Add(itemToAdd);
+  }
+  else if (nextItem == 0)
+  {
+    const auto itemToAdd(item);
+    items.Remove(itemPos);
+    items.AddFront(itemToAdd, 0);
+  }
+  else
+  {
+    items.Swap(itemPos, nextItem);
+  }
+  return true;
+}
+
+bool RemoveItem(CFileItemList& items, const std::shared_ptr<CFileItem>& item)
+{
+  int iBefore = items.Size();
+  items.Remove(item.get());
+  return items.Size() == iBefore - 1;
+}
+
+bool ShouldEnableMoveItems()
+{
+  auto& mgr = CServiceBroker::GetGUI()->GetWindowManager();
+  CGUIWindowFavourites* window = mgr.GetWindow<CGUIWindowFavourites>(WINDOW_FAVOURITES);
+  if (window && window->IsActive())
+  {
+    const CGUIViewState* state = window->GetViewState();
+    if (state && state->GetSortMethod().sortBy != SortByUserPreference)
+      return false; // in favs window, allow move only if current sort method is by user preference
+  }
+  return true;
+}
+
+} // namespace FAVOURITES_UTILS

xbmc/favourites/FavouritesUtils.h

@@ -0,0 +1,24 @@
+/*
+ *  Copyright (C) 2023 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 <memory>
+
+class CFileItem;
+class CFileItemList;
+
+namespace FAVOURITES_UTILS
+{
+bool ChooseAndSetNewName(CFileItem& item);
+bool ChooseAndSetNewThumbnail(CFileItem& item);
+bool MoveItem(CFileItemList& items, const std::shared_ptr<CFileItem>& item, int amount);
+bool RemoveItem(CFileItemList& items, const std::shared_ptr<CFileItem>& item);
+bool ShouldEnableMoveItems();
+
+} // namespace FAVOURITES_UTILS

xbmc/favourites/GUIDialogFavourites.cpp

@@ -12,7 +12,7 @@
 #include "ServiceBroker.h"
 #include "dialogs/GUIDialogContextMenu.h"
 #include "favourites/FavouritesURL.h"
-#include "favourites/GUIWindowFavourites.h"
+#include "favourites/FavouritesUtils.h"
 #include "guilib/GUIComponent.h"
 #include "guilib/GUIMessage.h"
 #include "guilib/GUIWindowManager.h"
@@ -176,7 +176,7 @@ void CGUIDialogFavourites::OnRename(int item)
   if (item < 0 || item >= m_favourites->Size())
     return;
 
-  if (CGUIWindowFavourites::ChooseAndSetNewName(*(*m_favourites)[item]))
+  if (FAVOURITES_UTILS::ChooseAndSetNewName(*(*m_favourites)[item]))
   {
     m_favouritesService.Save(*m_favourites);
     UpdateList();
@@ -188,7 +188,7 @@ void CGUIDialogFavourites::OnSetThumb(int item)
   if (item < 0 || item >= m_favourites->Size())
     return;
 
-  if (CGUIWindowFavourites::ChooseAndSetNewThumbnail(*(*m_favourites)[item]))
+  if (FAVOURITES_UTILS::ChooseAndSetNewThumbnail(*(*m_favourites)[item]))
   {
     m_favouritesService.Save(*m_favourites);
     UpdateList();