xbmc/guilib/GUIKeyboardFactory.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 "ServiceBroker.h"
  10 #include "GUIComponent.h"
  11 #include "messaging/ApplicationMessenger.h"
  12 #include "LocalizeStrings.h"
  13 #include "GUIKeyboardFactory.h"
  14 #include "GUIUserMessages.h"
  15 #include "GUIWindowManager.h"
  16 #include "messaging/helpers/DialogOKHelper.h"
  17 #include "settings/Settings.h"
  18 #include "settings/SettingsComponent.h"
  19 #include "utils/Digest.h"
  20 #include "utils/StringUtils.h"
  21 #include "utils/Variant.h"
  22
  23 #include "dialogs/GUIDialogKeyboardGeneric.h"
  24 #if defined(TARGET_DARWIN_EMBEDDED)
  25 #include "dialogs/GUIDialogKeyboardTouch.h"
  26
  27 #include "platform/darwin/ios-common/DarwinEmbedKeyboard.h"
  28 #endif
  29
  30 using namespace KODI::MESSAGING;
  31 using KODI::UTILITY::CDigest;
  32
  33 CGUIKeyboard *CGUIKeyboardFactory::g_activeKeyboard = NULL;
  34 FILTERING CGUIKeyboardFactory::m_filtering = FILTERING_NONE;
  35
  36 CGUIKeyboardFactory::CGUIKeyboardFactory(void) = default;
  37
  38 CGUIKeyboardFactory::~CGUIKeyboardFactory(void) = default;
  39
  40 void CGUIKeyboardFactory::keyTypedCB(CGUIKeyboard *ref, const std::string &typedString)
  41 {
  42   if(ref)
  43   {
  44     // send our search message in safe way (only the active window needs it)
  45     CGUIMessage message(GUI_MSG_NOTIFY_ALL, ref->GetWindowId(), 0);
  46     switch(m_filtering)
  47     {
  48       case FILTERING_SEARCH:
  49         message.SetParam1(GUI_MSG_SEARCH_UPDATE);
  50         message.SetStringParam(typedString);
  51         CServiceBroker::GetAppMessenger()->SendGUIMessage(
  52             message, CServiceBroker::GetGUI()->GetWindowManager().GetActiveWindow());
  53         break;
  54       case FILTERING_CURRENT:
  55         message.SetParam1(GUI_MSG_FILTER_ITEMS);
  56         message.SetStringParam(typedString);
  57         CServiceBroker::GetAppMessenger()->SendGUIMessage(message);
  58         break;
  59       case FILTERING_NONE:
  60         break;
  61     }
  62     ref->resetAutoCloseTimer();
  63   }
  64 }
  65
  66 bool CGUIKeyboardFactory::SendTextToActiveKeyboard(const std::string &aTextString, bool closeKeyboard /* = false */)
  67 {
  68   if (!g_activeKeyboard)
  69     return false;
  70   return g_activeKeyboard->SetTextToKeyboard(aTextString, closeKeyboard);
  71 }
  72
  73
  74 // Show keyboard with initial value (aTextString) and replace with result string.
  75 // Returns: true  - successful display and input (empty result may return true or false depending on parameter)
  76 //          false - unsuccessful display of the keyboard or cancelled editing
  77 bool CGUIKeyboardFactory::ShowAndGetInput(std::string& aTextString,
  78                                           const CVariant& heading,
  79                                           bool allowEmptyResult,
  80                                           bool hiddenInput /* = false */,
  81                                           unsigned int autoCloseMs /* = 0 */)
  82 {
  83   bool confirmed = false;
  84   //heading can be a string or a localization id
  85   std::string headingStr;
  86   if (heading.isString())
  87     headingStr = heading.asString();
  88   else if (heading.isInteger() && heading.asInteger())
  89     headingStr = g_localizeStrings.Get((uint32_t)heading.asInteger());
  90
  91   bool useKodiKeyboard = true;
  92 #if defined(TARGET_DARWIN_EMBEDDED)
  93 #if defined(TARGET_DARWIN_TVOS)
  94   useKodiKeyboard = CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(
  95       CSettings::SETTING_INPUT_TVOSUSEKODIKEYBOARD);
  96 #else
  97   useKodiKeyboard = CDarwinEmbedKeyboard::hasExternalKeyboard();
  98 #endif // defined(TARGET_DARWIN_TVOS)
  99 #endif
 100
 101   auto& winManager = CServiceBroker::GetGUI()->GetWindowManager();
 102   CGUIKeyboard* kb = nullptr;
 103   if (useKodiKeyboard)
 104     kb = winManager.GetWindow<CGUIDialogKeyboardGeneric>(WINDOW_DIALOG_KEYBOARD);
 105 #if defined(TARGET_DARWIN_EMBEDDED)
 106   else
 107     kb = winManager.GetWindow<CGUIDialogKeyboardTouch>(WINDOW_DIALOG_KEYBOARD_TOUCH);
 108 #endif // defined(TARGET_DARWIN_EMBEDDED)
 109
 110   if (kb)
 111   {
 112     g_activeKeyboard = kb;
 113     kb->startAutoCloseTimer(autoCloseMs);
 114     confirmed = kb->ShowAndGetInput(keyTypedCB, aTextString, aTextString, headingStr, hiddenInput);
 115     g_activeKeyboard = NULL;
 116   }
 117
 118   if (confirmed)
 119   {
 120     if (!allowEmptyResult && aTextString.empty())
 121       confirmed = false;
 122   }
 123
 124   return confirmed;
 125 }
 126
 127 bool CGUIKeyboardFactory::ShowAndGetInput(std::string& aTextString, bool allowEmptyResult, unsigned int autoCloseMs /* = 0 */)
 128 {
 129   return ShowAndGetInput(aTextString, CVariant{""}, allowEmptyResult, false, autoCloseMs);
 130 }
 131
 132 // Shows keyboard and prompts for a password.
 133 // Differs from ShowAndVerifyNewPassword() in that no second verification is necessary.
 134 bool CGUIKeyboardFactory::ShowAndGetNewPassword(std::string& newPassword,
 135                                                 const CVariant& heading,
 136                                                 bool allowEmpty,
 137                                                 unsigned int autoCloseMs /* = 0 */)
 138 {
 139   return ShowAndGetInput(newPassword, heading, allowEmpty, true, autoCloseMs);
 140 }
 141
 142 // Shows keyboard and prompts for a password.
 143 // Differs from ShowAndVerifyNewPassword() in that no second verification is necessary.
 144 bool CGUIKeyboardFactory::ShowAndGetNewPassword(std::string& newPassword, unsigned int autoCloseMs /* = 0 */)
 145 {
 146   return ShowAndGetNewPassword(newPassword, 12340, false, autoCloseMs);
 147 }
 148
 149 bool CGUIKeyboardFactory::ShowAndGetFilter(std::string &filter, bool searching, unsigned int autoCloseMs /* = 0 */)
 150 {
 151   m_filtering = searching ? FILTERING_SEARCH : FILTERING_CURRENT;
 152   bool ret = ShowAndGetInput(filter, searching ? 16017 : 16028, true, false, autoCloseMs);
 153   m_filtering = FILTERING_NONE;
 154   return ret;
 155 }
 156
 157
 158 // \brief Show keyboard twice to get and confirm a user-entered password string.
 159 // \param newPassword Overwritten with user input if return=true.
 160 // \param heading Heading to display
 161 // \param allowEmpty Whether a blank password is valid or not.
 162 // \return true if successful display and user input entry/re-entry. false if unsuccessful display, no user input, or canceled editing.
 163 bool CGUIKeyboardFactory::ShowAndVerifyNewPassword(std::string& newPassword,
 164                                                    const CVariant& heading,
 165                                                    bool allowEmpty,
 166                                                    unsigned int autoCloseMs /* = 0 */)
 167 {
 168   // Prompt user for password input
 169   std::string userInput;
 170   if (!ShowAndGetInput(userInput, heading, allowEmpty, true, autoCloseMs))
 171   { // user cancelled, or invalid input
 172     return false;
 173   }
 174   // success - verify the password
 175   std::string checkInput;
 176   if (!ShowAndGetInput(checkInput, 12341, allowEmpty, true, autoCloseMs))
 177   { // user cancelled, or invalid input
 178     return false;
 179   }
 180   // check the password
 181   if (checkInput == userInput)
 182   {
 183     newPassword = CDigest::Calculate(CDigest::Type::MD5, userInput);
 184     return true;
 185   }
 186   HELPERS::ShowOKDialogText(CVariant{12341}, CVariant{12344});
 187   return false;
 188 }
 189
 190 // \brief Show keyboard twice to get and confirm a user-entered password string.
 191 // \param strNewPassword Overwritten with user input if return=true.
 192 // \return true if successful display and user input entry/re-entry. false if unsuccessful display, no user input, or canceled editing.
 193 bool CGUIKeyboardFactory::ShowAndVerifyNewPassword(std::string& newPassword, unsigned int autoCloseMs /* = 0 */)
 194 {
 195   const std::string& heading = g_localizeStrings.Get(12340);
 196   return ShowAndVerifyNewPassword(newPassword, heading, false, autoCloseMs);
 197 }
 198
 199 // \brief Show keyboard and verify user input against strPassword.
 200 // \param strPassword Value to compare against user input.
 201 // \param dlgHeading String shown on dialog title. Converts to localized string if contains a positive integer.
 202 // \param iRetries If greater than 0, shows "Incorrect password, %d retries left" on dialog line 2, else line 2 is blank.
 203 // \return 0 if successful display and user input. 1 if unsuccessful input. -1 if no user input or canceled editing.
 204 int CGUIKeyboardFactory::ShowAndVerifyPassword(std::string& strPassword, const std::string& strHeading, int iRetries, unsigned int autoCloseMs /* = 0 */)
 205 {
 206   std::string strHeadingTemp;
 207   if (1 > iRetries && strHeading.size())
 208     strHeadingTemp = strHeading;
 209   else
 210     strHeadingTemp =
 211         StringUtils::Format("{} - {} {}", g_localizeStrings.Get(12326),
 212                             CServiceBroker::GetSettingsComponent()->GetSettings()->GetInt(
 213                                 CSettings::SETTING_MASTERLOCK_MAXRETRIES) -
 214                                 iRetries,
 215                             g_localizeStrings.Get(12343));
 216
 217   std::string strUserInput;
 218   //! @todo GUI Setting to enable disable this feature y/n?
 219   if (!ShowAndGetInput(strUserInput, strHeadingTemp, false, true, autoCloseMs))  //bool hiddenInput = false/true ?
 220     return -1; // user canceled out
 221
 222   if (!strPassword.empty())
 223   {
 224     std::string md5pword2 = CDigest::Calculate(CDigest::Type::MD5, strUserInput);
 225     if (StringUtils::EqualsNoCase(strPassword, md5pword2))
 226       return 0;     // user entered correct password
 227     else return 1;  // user must have entered an incorrect password
 228   }
 229   else
 230   {
 231     if (!strUserInput.empty())
 232     {
 233       strPassword = CDigest::Calculate(CDigest::Type::MD5, strUserInput);
 234       return 0; // user entered correct password
 235     }
 236     else return 1;
 237   }
 238 }
 239