xbmc/games/windows/GUIWindowGames.cpp

   1 /*
   2  *  Copyright (C) 2012-2020 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 "GUIWindowGames.h"
  10
  11 #include "FileItem.h"
  12 #include "GUIPassword.h"
  13 #include "ServiceBroker.h"
  14 #include "URL.h"
  15 #include "Util.h"
  16 #include "addons/gui/GUIDialogAddonInfo.h"
  17 #include "application/Application.h"
  18 #include "dialogs/GUIDialogContextMenu.h"
  19 #include "dialogs/GUIDialogMediaSource.h"
  20 #include "dialogs/GUIDialogProgress.h"
  21 #include "guilib/GUIComponent.h"
  22 #include "guilib/GUIWindowManager.h"
  23 #include "guilib/WindowIDs.h"
  24 #include "input/actions/ActionIDs.h"
  25 #include "media/MediaLockState.h"
  26 #include "playlists/PlayListTypes.h"
  27 #include "settings/MediaSourceSettings.h"
  28 #include "settings/Settings.h"
  29 #include "settings/SettingsComponent.h"
  30 #include "utils/StringUtils.h"
  31 #include "utils/URIUtils.h"
  32
  33 #include <algorithm>
  34
  35 using namespace KODI;
  36 using namespace GAME;
  37
  38 #define CONTROL_BTNVIEWASICONS 2
  39 #define CONTROL_BTNSORTBY 3
  40 #define CONTROL_BTNSORTASC 4
  41
  42 CGUIWindowGames::CGUIWindowGames() : CGUIMediaWindow(WINDOW_GAMES, "MyGames.xml")
  43 {
  44 }
  45
  46 bool CGUIWindowGames::OnMessage(CGUIMessage& message)
  47 {
  48   switch (message.GetMessage())
  49   {
  50     case GUI_MSG_WINDOW_INIT:
  51     {
  52       m_rootDir.AllowNonLocalSources(true); //! @todo
  53
  54       // Is this the first time the window is opened?
  55       if (m_vecItems->GetPath() == "?" && message.GetStringParam().empty())
  56         message.SetStringParam(CMediaSourceSettings::GetInstance().GetDefaultSource("games"));
  57
  58       //! @todo
  59       m_dlgProgress = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogProgress>(
  60           WINDOW_DIALOG_PROGRESS);
  61
  62       break;
  63     }
  64     case GUI_MSG_CLICKED:
  65     {
  66       if (OnClickMsg(message.GetSenderId(), message.GetParam1()))
  67         return true;
  68       break;
  69     }
  70     default:
  71       break;
  72   }
  73   return CGUIMediaWindow::OnMessage(message);
  74 }
  75
  76 bool CGUIWindowGames::OnClickMsg(int controlId, int actionId)
  77 {
  78   if (!m_viewControl.HasControl(controlId)) // list/thumb control
  79     return false;
  80
  81   const int iItem = m_viewControl.GetSelectedItem();
  82
  83   CFileItemPtr pItem = m_vecItems->Get(iItem);
  84   if (!pItem)
  85     return false;
  86
  87   switch (actionId)
  88   {
  89     case ACTION_DELETE_ITEM:
  90     {
  91       // Is delete allowed?
  92       if (CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(
  93               CSettings::SETTING_FILELISTS_ALLOWFILEDELETION))
  94       {
  95         OnDeleteItem(iItem);
  96         return true;
  97       }
  98       break;
  99     }
 100     case ACTION_PLAYER_PLAY:
 101     {
 102       if (OnClick(iItem))
 103         return true;
 104       break;
 105     }
 106     case ACTION_SHOW_INFO:
 107     {
 108       if (!m_vecItems->IsPlugin())
 109       {
 110         if (pItem->HasAddonInfo())
 111         {
 112           CGUIDialogAddonInfo::ShowForItem(pItem);
 113           return true;
 114         }
 115       }
 116       break;
 117     }
 118     default:
 119       break;
 120   }
 121
 122   return false;
 123 }
 124
 125 void CGUIWindowGames::SetupShares()
 126 {
 127   CGUIMediaWindow::SetupShares();
 128
 129   // Don't convert zip files to directories. Otherwise, the files will be
 130   // opened and scanned for games with a valid extension. If none are found,
 131   // the .zip won't be shown.
 132   //
 133   // This is a problem for MAME roms, because the files inside the .zip don't
 134   // have standard extensions.
 135   //
 136   m_rootDir.SetFlags(XFILE::DIR_FLAG_NO_FILE_DIRS);
 137 }
 138
 139 bool CGUIWindowGames::OnClick(int iItem, const std::string& player /* = "" */)
 140 {
 141   CFileItemPtr item = m_vecItems->Get(iItem);
 142   if (item)
 143   {
 144     // Compensate for DIR_FLAG_NO_FILE_DIRS flag
 145     if (URIUtils::IsArchive(item->GetPath()))
 146     {
 147       bool bIsGame = false;
 148
 149       // If zip file contains no games, assume it is a game
 150       CFileItemList items;
 151       if (m_rootDir.GetDirectory(CURL(item->GetPath()), items))
 152       {
 153         if (items.Size() == 0)
 154           bIsGame = true;
 155       }
 156
 157       if (!bIsGame)
 158         item->m_bIsFolder = true;
 159     }
 160
 161     if (!item->m_bIsFolder)
 162     {
 163       PlayGame(*item);
 164       return true;
 165     }
 166   }
 167
 168   return CGUIMediaWindow::OnClick(iItem, player);
 169 }
 170
 171 void CGUIWindowGames::GetContextButtons(int itemNumber, CContextButtons& buttons)
 172 {
 173   CFileItemPtr item = m_vecItems->Get(itemNumber);
 174
 175   if (item && !item->GetProperty("pluginreplacecontextitems").asBoolean())
 176   {
 177     if (m_vecItems->IsVirtualDirectoryRoot() || m_vecItems->IsSourcesPath())
 178     {
 179       // Context buttons for a sources path, like "Add Source", "Remove Source", etc.
 180       CGUIDialogContextMenu::GetContextButtons("games", item, buttons);
 181     }
 182     else
 183     {
 184       if (item->IsGame())
 185       {
 186         buttons.Add(CONTEXT_BUTTON_PLAY_ITEM, 208); // Play
 187       }
 188
 189       if (CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(
 190               CSettings::SETTING_FILELISTS_ALLOWFILEDELETION) &&
 191           !item->IsReadOnly())
 192       {
 193         buttons.Add(CONTEXT_BUTTON_DELETE, 117);
 194         buttons.Add(CONTEXT_BUTTON_RENAME, 118);
 195       }
 196     }
 197   }
 198
 199   CGUIMediaWindow::GetContextButtons(itemNumber, buttons);
 200 }
 201
 202 bool CGUIWindowGames::OnContextButton(int itemNumber, CONTEXT_BUTTON button)
 203 {
 204   CFileItemPtr item = m_vecItems->Get(itemNumber);
 205   if (item)
 206   {
 207     if (m_vecItems->IsVirtualDirectoryRoot() || m_vecItems->IsSourcesPath())
 208     {
 209       if (CGUIDialogContextMenu::OnContextButton("games", item, button))
 210       {
 211         Update(m_vecItems->GetPath());
 212         return true;
 213       }
 214     }
 215     switch (button)
 216     {
 217       case CONTEXT_BUTTON_PLAY_ITEM:
 218         PlayGame(*item);
 219         return true;
 220       case CONTEXT_BUTTON_INFO:
 221         CGUIDialogAddonInfo::ShowForItem(item);
 222         return true;
 223       case CONTEXT_BUTTON_DELETE:
 224         OnDeleteItem(itemNumber);
 225         return true;
 226       case CONTEXT_BUTTON_RENAME:
 227         OnRenameItem(itemNumber);
 228         return true;
 229       default:
 230         break;
 231     }
 232   }
 233   return CGUIMediaWindow::OnContextButton(itemNumber, button);
 234 }
 235
 236 bool CGUIWindowGames::OnAddMediaSource()
 237 {
 238   return CGUIDialogMediaSource::ShowAndAddMediaSource("games");
 239 }
 240
 241 bool CGUIWindowGames::GetDirectory(const std::string& strDirectory, CFileItemList& items)
 242 {
 243   if (!CGUIMediaWindow::GetDirectory(strDirectory, items))
 244     return false;
 245
 246   // Set label
 247   std::string label;
 248   if (items.GetLabel().empty())
 249   {
 250     std::string source;
 251     if (m_rootDir.IsSource(items.GetPath(), CMediaSourceSettings::GetInstance().GetSources("games"),
 252                            &source))
 253       label = std::move(source);
 254   }
 255
 256   if (!label.empty())
 257     items.SetLabel(label);
 258
 259   // Set content
 260   std::string content;
 261   if (items.GetContent().empty())
 262   {
 263     if (!items.IsVirtualDirectoryRoot() && // Don't set content for root directory
 264         !items.IsPlugin()) // Don't set content for plugins
 265     {
 266       content = "games";
 267     }
 268   }
 269
 270   if (!content.empty())
 271     items.SetContent(content);
 272
 273   // Ensure a game info tag is created so that files are recognized as games
 274   for (const CFileItemPtr& item : items)
 275   {
 276     if (!item->m_bIsFolder)
 277       item->GetGameInfoTag();
 278   }
 279
 280   return true;
 281 }
 282
 283 std::string CGUIWindowGames::GetStartFolder(const std::string& dir)
 284 {
 285   // From CGUIWindowPictures::GetStartFolder()
 286
 287   if (StringUtils::EqualsNoCase(dir, "plugins") || StringUtils::EqualsNoCase(dir, "addons"))
 288   {
 289     return "addons://sources/game/";
 290   }
 291
 292   SetupShares();
 293   VECSOURCES shares;
 294   m_rootDir.GetSources(shares);
 295   bool bIsSourceName = false;
 296   int iIndex = CUtil::GetMatchingSource(dir, shares, bIsSourceName);
 297   if (iIndex >= 0)
 298   {
 299     if (iIndex < static_cast<int>(shares.size()) && shares[iIndex].m_iHasLock == LOCK_STATE_LOCKED)
 300     {
 301       CFileItem item(shares[iIndex]);
 302       if (!g_passwordManager.IsItemUnlocked(&item, "games"))
 303         return "";
 304     }
 305     if (bIsSourceName)
 306       return shares[iIndex].strPath;
 307     return dir;
 308   }
 309   return CGUIMediaWindow::GetStartFolder(dir);
 310 }
 311
 312 void CGUIWindowGames::OnItemInfo(int itemNumber)
 313 {
 314   CFileItemPtr item = m_vecItems->Get(itemNumber);
 315   if (!item)
 316     return;
 317
 318   if (!m_vecItems->IsPlugin())
 319   {
 320     if (item->IsPlugin() || item->IsScript())
 321       CGUIDialogAddonInfo::ShowForItem(item);
 322   }
 323
 324   //! @todo
 325   /*
 326   CGUIDialogGameInfo* gameInfo =
 327   CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogGameInfo>(WINDOW_DIALOG_PICTURE_INFO);
 328   if (gameInfo)
 329   {
 330     gameInfo->SetGame(item);
 331     gameInfo->Open();
 332   }
 333   */
 334 }
 335
 336 bool CGUIWindowGames::PlayGame(const CFileItem& item)
 337 {
 338   CFileItem itemCopy(item);
 339   return g_application.PlayMedia(itemCopy, "", PLAYLIST::TYPE_NONE);
 340 }