xbmc/dialogs/GUIDialogGamepad.cpp

   1 /*
   2  *  Copyright (C) 2005-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 "GUIDialogGamepad.h"
  10
  11 #include "ServiceBroker.h"
  12 #include "guilib/GUIAudioManager.h"
  13 #include "guilib/GUIComponent.h"
  14 #include "guilib/GUIWindowManager.h"
  15 #include "guilib/LocalizeStrings.h"
  16 #include "input/actions/Action.h"
  17 #include "input/actions/ActionIDs.h"
  18 #include "input/keyboard/KeyIDs.h"
  19 #include "messaging/helpers/DialogOKHelper.h"
  20 #include "utils/Digest.h"
  21 #include "utils/StringUtils.h"
  22 #include "utils/Variant.h"
  23
  24 #include <utility>
  25
  26 using namespace KODI::MESSAGING;
  27 using KODI::UTILITY::CDigest;
  28
  29 CGUIDialogGamepad::CGUIDialogGamepad(void)
  30     : CGUIDialogBoxBase(WINDOW_DIALOG_GAMEPAD, "DialogConfirm.xml")
  31 {
  32   m_bCanceled = false;
  33   m_iRetries = 0;
  34   m_bUserInputCleanup = true;
  35   m_bHideInputChars = true;
  36   m_cHideInputChar = '*';
  37 }
  38
  39 CGUIDialogGamepad::~CGUIDialogGamepad(void) = default;
  40
  41 void CGUIDialogGamepad::OnInitWindow()
  42 {
  43   // hide all controls
  44   for (int i = 0; i < DIALOG_MAX_CHOICES; ++i)
  45     SET_CONTROL_HIDDEN(CONTROL_CHOICES_START + i);
  46   SET_CONTROL_HIDDEN(CONTROL_PROGRESS_BAR);
  47
  48   CGUIDialogBoxBase::OnInitWindow();
  49 }
  50
  51 bool CGUIDialogGamepad::OnAction(const CAction &action)
  52 {
  53   if ((action.GetButtonCode() >= KEY_BUTTON_A &&
  54        action.GetButtonCode() <= KEY_BUTTON_RIGHT_TRIGGER) ||
  55       (action.GetButtonCode() >= KEY_BUTTON_DPAD_UP &&
  56        action.GetButtonCode() <= KEY_BUTTON_DPAD_RIGHT) ||
  57       (action.GetID() >= ACTION_MOVE_LEFT &&
  58        action.GetID() <= ACTION_MOVE_DOWN) ||
  59       action.GetID() == ACTION_PLAYER_PLAY
  60      )
  61   {
  62     switch (action.GetButtonCode())
  63     {
  64     case KEY_BUTTON_A : m_strUserInput += "A"; break;
  65     case KEY_BUTTON_B : m_strUserInput += "B"; break;
  66     case KEY_BUTTON_X : m_strUserInput += "X"; break;
  67     case KEY_BUTTON_Y : m_strUserInput += "Y"; break;
  68     case KEY_BUTTON_BLACK : m_strUserInput += "K"; break;
  69     case KEY_BUTTON_WHITE : m_strUserInput += "W"; break;
  70     case KEY_BUTTON_LEFT_TRIGGER : m_strUserInput += "("; break;
  71     case KEY_BUTTON_RIGHT_TRIGGER : m_strUserInput += ")"; break;
  72     case KEY_BUTTON_DPAD_UP : m_strUserInput += "U"; break;
  73     case KEY_BUTTON_DPAD_DOWN : m_strUserInput += "D"; break;
  74     case KEY_BUTTON_DPAD_LEFT : m_strUserInput += "L"; break;
  75     case KEY_BUTTON_DPAD_RIGHT : m_strUserInput += "R"; break;
  76     default:
  77       switch (action.GetID())
  78       {
  79         case ACTION_MOVE_LEFT:   m_strUserInput += "L"; break;
  80         case ACTION_MOVE_RIGHT:  m_strUserInput += "R"; break;
  81         case ACTION_MOVE_UP:     m_strUserInput += "U"; break;
  82         case ACTION_MOVE_DOWN:   m_strUserInput += "D"; break;
  83         case ACTION_PLAYER_PLAY: m_strUserInput += "P"; break;
  84         default:
  85           return true;
  86       }
  87       break;
  88     }
  89
  90     std::string strHiddenInput(m_strUserInput);
  91     for (int i = 0; i < (int)strHiddenInput.size(); i++)
  92     {
  93       strHiddenInput[i] = m_cHideInputChar;
  94     }
  95     SetLine(2, CVariant{std::move(strHiddenInput)});
  96     return true;
  97   }
  98   else if (action.GetButtonCode() == KEY_BUTTON_BACK || action.GetID() == ACTION_PREVIOUS_MENU || action.GetID() == ACTION_NAV_BACK)
  99   {
 100     m_bConfirmed = false;
 101     m_bCanceled = true;
 102     m_strUserInput = "";
 103     m_bHideInputChars = true;
 104     Close();
 105     return true;
 106   }
 107   else if (action.GetButtonCode() == KEY_BUTTON_START || action.GetID() == ACTION_SELECT_ITEM)
 108   {
 109     m_bConfirmed = false;
 110     m_bCanceled = false;
 111
 112     std::string md5pword2 = CDigest::Calculate(CDigest::Type::MD5, m_strUserInput);
 113
 114     if (!StringUtils::EqualsNoCase(m_strPassword, md5pword2))
 115     {
 116       // incorrect password entered
 117       m_iRetries--;
 118
 119       // don't clean up if the calling code wants the bad user input
 120       if (m_bUserInputCleanup)
 121         m_strUserInput = "";
 122       else
 123         m_bUserInputCleanup = true;
 124
 125       m_bHideInputChars = true;
 126       Close();
 127       return true;
 128     }
 129
 130     // correct password entered
 131     m_bConfirmed = true;
 132     m_iRetries = 0;
 133     m_strUserInput = "";
 134     m_bHideInputChars = true;
 135     Close();
 136     return true;
 137   }
 138   else if (action.GetID() >= REMOTE_0 && action.GetID() <= REMOTE_9)
 139   {
 140     return true; // unhandled
 141   }
 142   else
 143   {
 144     return CGUIDialog::OnAction(action);
 145   }
 146 }
 147
 148 bool CGUIDialogGamepad::OnMessage(CGUIMessage& message)
 149 {
 150   switch ( message.GetMessage() )
 151   {
 152   case GUI_MSG_WINDOW_INIT:
 153     {
 154       m_bConfirmed = false;
 155       m_bCanceled = false;
 156       m_cHideInputChar = g_localizeStrings.Get(12322).c_str()[0];
 157       CGUIDialog::OnMessage(message);
 158       return true;
 159     }
 160     break;
 161
 162   case GUI_MSG_CLICKED:
 163     {
 164       m_bConfirmed = false;
 165       m_bCanceled = false;
 166     }
 167     break;
 168   }
 169   return CGUIDialogBoxBase::OnMessage(message);
 170 }
 171
 172 // \brief Show gamepad keypad and replace aTextString with user input.
 173 // \param aTextString String to preload into the keyboard accumulator. Overwritten with user input if return=true.
 174 // \param dlgHeading String shown on dialog title. Converts to localized string if contains a positive integer.
 175 // \param bHideUserInput Masks user input as asterisks if set as true.  Currently not yet implemented.
 176 // \return true if successful display and user input. false if unsuccessful display, no user input, or canceled editing.
 177 bool CGUIDialogGamepad::ShowAndGetInput(std::string& aTextString, const std::string &dlgHeading, bool bHideUserInput)
 178 {
 179   // Prompt user for input
 180   std::string strUserInput;
 181   if (ShowAndVerifyInput(strUserInput, dlgHeading, aTextString, "", "", true, bHideUserInput))
 182   {
 183     // user entry was blank
 184     return false;
 185   }
 186
 187   if (strUserInput.empty())
 188     // user canceled out
 189     return false;
 190
 191
 192   // We should have a string to return
 193   aTextString = strUserInput;
 194   return true;
 195 }
 196
 197 // \brief Show gamepad keypad twice to get and confirm a user-entered password string.
 198 // \param strNewPassword String to preload into the keyboard accumulator. Overwritten with user input if return=true.
 199 // \return true if successful display and user input entry/re-entry. false if unsuccessful display, no user input, or canceled editing.
 200 bool CGUIDialogGamepad::ShowAndVerifyNewPassword(std::string& strNewPassword)
 201 {
 202   // Prompt user for password input
 203   std::string strUserInput;
 204   if (ShowAndVerifyInput(strUserInput, "12340", "12330", "12331", "", true, true))
 205   {
 206     //! @todo Show error to user saying the password entry was blank
 207     HELPERS::ShowOKDialogText(CVariant{12357}, CVariant{12358}); // Password is empty/blank
 208     return false;
 209   }
 210
 211   if (strUserInput.empty())
 212     // user canceled out
 213     return false;
 214
 215   // Prompt again for password input, this time sending previous input as the password to verify
 216   if (!ShowAndVerifyInput(strUserInput, "12341", "12330", "12331", "", false, true))
 217   {
 218     //! @todo Show error to user saying the password re-entry failed
 219     HELPERS::ShowOKDialogText(CVariant{12357}, CVariant{12344}); // Password do not match
 220     return false;
 221   }
 222
 223   // password entry and re-entry succeeded
 224   strNewPassword = strUserInput;
 225   return true;
 226 }
 227
 228 // \brief Show gamepad keypad and verify user input against strPassword.
 229 // \param strPassword Value to compare against user input.
 230 // \param dlgHeading String shown on dialog title. Converts to localized string if contains a positive integer.
 231 // \param iRetries If greater than 0, shows "Incorrect password, %d retries left" on dialog line 2, else line 2 is blank.
 232 // \return 0 if successful display and user input. 1 if unsuccessful input. -1 if no user input or canceled editing.
 233 int CGUIDialogGamepad::ShowAndVerifyPassword(std::string& strPassword, const std::string& dlgHeading, int iRetries)
 234 {
 235   std::string strLine2;
 236   if (0 < iRetries)
 237   {
 238     // Show a string telling user they have iRetries retries left
 239     strLine2 = StringUtils::Format("{} {} {}", g_localizeStrings.Get(12342), iRetries,
 240                                    g_localizeStrings.Get(12343));
 241   }
 242
 243   // make a copy of strPassword to prevent from overwriting it later
 244   std::string strPassTemp = strPassword;
 245   if (ShowAndVerifyInput(strPassTemp, dlgHeading, g_localizeStrings.Get(12330), g_localizeStrings.Get(12331), strLine2, true, true))
 246   {
 247     // user entered correct password
 248     return 0;
 249   }
 250
 251   if (strPassTemp.empty())
 252     // user canceled out
 253     return -1;
 254
 255   // user must have entered an incorrect password
 256   return 1;
 257 }
 258
 259 // \brief Show gamepad keypad and verify user input against strToVerify.
 260 // \param strToVerify Value to compare against user input.
 261 // \param dlgHeading String shown on dialog title. Converts to localized string if contains a positive integer.
 262 // \param dlgLine0 String shown on dialog line 0. Converts to localized string if contains a positive integer.
 263 // \param dlgLine1 String shown on dialog line 1. Converts to localized string if contains a positive integer.
 264 // \param dlgLine2 String shown on dialog line 2. Converts to localized string if contains a positive integer.
 265 // \param bGetUserInput If set as true and return=true, strToVerify is overwritten with user input string.
 266 // \param bHideInputChars Masks user input as asterisks if set as true.  Currently not yet implemented.
 267 // \return true if successful display and user input. false if unsuccessful display, no user input, or canceled editing.
 268 bool CGUIDialogGamepad::ShowAndVerifyInput(std::string& strToVerify, const std::string& dlgHeading,
 269     const std::string& dlgLine0, const std::string& dlgLine1,
 270     const std::string& dlgLine2, bool bGetUserInput, bool bHideInputChars)
 271 {
 272   // Prompt user for password input
 273   CGUIDialogGamepad *pDialog = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogGamepad>(WINDOW_DIALOG_GAMEPAD);
 274   pDialog->m_strPassword = strToVerify;
 275   pDialog->m_bUserInputCleanup = !bGetUserInput;
 276   pDialog->m_bHideInputChars = bHideInputChars;
 277
 278   // HACK: This won't work if the label specified is actually a positive numeric value, but that's very unlikely
 279   if (!StringUtils::IsNaturalNumber(dlgHeading))
 280     pDialog->SetHeading(CVariant{dlgHeading});
 281   else
 282     pDialog->SetHeading(CVariant{atoi(dlgHeading.c_str())});
 283
 284   if (!StringUtils::IsNaturalNumber(dlgLine0))
 285     pDialog->SetLine(0, CVariant{dlgLine0});
 286   else
 287     pDialog->SetLine(0, CVariant{atoi(dlgLine0.c_str())});
 288
 289   if (!StringUtils::IsNaturalNumber(dlgLine1))
 290     pDialog->SetLine(1, CVariant{dlgLine1});
 291   else
 292     pDialog->SetLine(1, CVariant{atoi(dlgLine1.c_str())});
 293
 294   if (!StringUtils::IsNaturalNumber(dlgLine2))
 295     pDialog->SetLine(2, CVariant{dlgLine2});
 296   else
 297     pDialog->SetLine(2, CVariant{atoi(dlgLine2.c_str())});
 298
 299   CGUIComponent* gui = CServiceBroker::GetGUI();
 300   if (gui)
 301     gui->GetAudioManager().Enable(false); // don't do sounds during pwd input
 302
 303   pDialog->Open();
 304
 305   if (gui)
 306     gui->GetAudioManager().Enable(true);
 307
 308   if (bGetUserInput && !pDialog->IsCanceled())
 309   {
 310     strToVerify = CDigest::Calculate(CDigest::Type::MD5, pDialog->m_strUserInput);
 311     pDialog->m_strUserInput = "";
 312   }
 313
 314   if (!pDialog->IsConfirmed() || pDialog->IsCanceled())
 315   {
 316     // user canceled out or entered an incorrect password
 317     return false;
 318   }
 319
 320   // user entered correct password
 321   return true;
 322 }
 323
 324 bool CGUIDialogGamepad::IsCanceled() const
 325 {
 326   return m_bCanceled;
 327 }
 328