xbmc/input/KeyboardLayoutManager.cpp

   1 /*
   2  *  Copyright (C) 2015-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 "KeyboardLayoutManager.h"
  10
  11 #include "FileItem.h"
  12 #include "ServiceBroker.h"
  13 #include "URL.h"
  14 #include "filesystem/Directory.h"
  15 #include "settings/lib/Setting.h"
  16 #include "settings/lib/SettingDefinitions.h"
  17 #include "utils/XBMCTinyXML.h"
  18 #include "utils/log.h"
  19
  20 #include <algorithm>
  21
  22 #define KEYBOARD_LAYOUTS_PATH "special://xbmc/system/keyboardlayouts"
  23
  24 CKeyboardLayoutManager::~CKeyboardLayoutManager()
  25 {
  26   Unload();
  27 }
  28
  29 bool CKeyboardLayoutManager::Load(const std::string& path /* = "" */)
  30 {
  31   std::string layoutDirectory = path;
  32   if (layoutDirectory.empty())
  33     layoutDirectory = KEYBOARD_LAYOUTS_PATH;
  34
  35   if (!XFILE::CDirectory::Exists(layoutDirectory))
  36   {
  37     CLog::Log(LOGWARNING,
  38               "CKeyboardLayoutManager: unable to load keyboard layouts from non-existing directory "
  39               "\"{}\"",
  40               layoutDirectory);
  41     return false;
  42   }
  43
  44   CFileItemList layouts;
  45   if (!XFILE::CDirectory::GetDirectory(CURL(layoutDirectory), layouts, ".xml",
  46                                        XFILE::DIR_FLAG_DEFAULTS) ||
  47       layouts.IsEmpty())
  48   {
  49     CLog::Log(LOGWARNING, "CKeyboardLayoutManager: no keyboard layouts found in {}",
  50               layoutDirectory);
  51     return false;
  52   }
  53
  54   CLog::Log(LOGINFO, "CKeyboardLayoutManager: loading keyboard layouts from {}...",
  55             layoutDirectory);
  56   size_t oldLayoutCount = m_layouts.size();
  57   for (int i = 0; i < layouts.Size(); i++)
  58   {
  59     std::string layoutPath = layouts[i]->GetPath();
  60     if (layoutPath.empty())
  61       continue;
  62
  63     CXBMCTinyXML xmlDoc;
  64     if (!xmlDoc.LoadFile(layoutPath))
  65     {
  66       CLog::Log(LOGWARNING, "CKeyboardLayoutManager: unable to open {}", layoutPath);
  67       continue;
  68     }
  69
  70     const TiXmlElement* rootElement = xmlDoc.RootElement();
  71     if (rootElement == NULL)
  72     {
  73       CLog::Log(LOGWARNING, "CKeyboardLayoutManager: missing or invalid XML root element in {}",
  74                 layoutPath);
  75       continue;
  76     }
  77
  78     if (rootElement->ValueStr() != "keyboardlayouts")
  79     {
  80       CLog::Log(LOGWARNING, "CKeyboardLayoutManager: unexpected XML root element \"{}\" in {}",
  81                 rootElement->Value(), layoutPath);
  82       continue;
  83     }
  84
  85     const TiXmlElement* layoutElement = rootElement->FirstChildElement("layout");
  86     while (layoutElement != NULL)
  87     {
  88       CKeyboardLayout layout;
  89       if (!layout.Load(layoutElement))
  90         CLog::Log(LOGWARNING, "CKeyboardLayoutManager: failed to load {}", layoutPath);
  91       else if (m_layouts.find(layout.GetIdentifier()) != m_layouts.end())
  92         CLog::Log(LOGWARNING,
  93                   "CKeyboardLayoutManager: duplicate layout with identifier \"{}\" in {}",
  94                   layout.GetIdentifier(), layoutPath);
  95       else
  96       {
  97         CLog::Log(LOGDEBUG, "CKeyboardLayoutManager: keyboard layout \"{}\" successfully loaded",
  98                   layout.GetIdentifier());
  99         m_layouts.insert(std::make_pair(layout.GetIdentifier(), layout));
 100       }
 101
 102       layoutElement = layoutElement->NextSiblingElement();
 103     }
 104   }
 105
 106   return m_layouts.size() > oldLayoutCount;
 107 }
 108
 109 void CKeyboardLayoutManager::Unload()
 110 {
 111   m_layouts.clear();
 112 }
 113
 114 bool CKeyboardLayoutManager::GetLayout(const std::string& name, CKeyboardLayout& layout) const
 115 {
 116   if (name.empty())
 117     return false;
 118
 119   KeyboardLayouts::const_iterator it = m_layouts.find(name);
 120   if (it == m_layouts.end())
 121     return false;
 122
 123   layout = it->second;
 124   return true;
 125 }
 126
 127 namespace
 128 {
 129 inline bool LayoutSort(const StringSettingOption& i, const StringSettingOption& j)
 130 {
 131   return (i.value < j.value);
 132 }
 133 } // namespace
 134
 135 void CKeyboardLayoutManager::SettingOptionsKeyboardLayoutsFiller(
 136     const SettingConstPtr& setting,
 137     std::vector<StringSettingOption>& list,
 138     std::string& current,
 139     void* data)
 140 {
 141   for (const auto& it : CServiceBroker::GetKeyboardLayoutManager()->m_layouts)
 142   {
 143     std::string name = it.second.GetName();
 144     list.emplace_back(name, name);
 145   }
 146
 147   std::sort(list.begin(), list.end(), LayoutSort);
 148 }