xbmc/settings/SettingPath.cpp

   1 /*
   2  *  Copyright (C) 2013-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 "SettingPath.h"
  10
  11 #include "settings/lib/SettingsManager.h"
  12 #include "utils/FileExtensionProvider.h"
  13 #include "utils/StringUtils.h"
  14 #include "utils/XBMCTinyXML.h"
  15 #include "utils/XMLUtils.h"
  16 #include "utils/log.h"
  17
  18 #include <mutex>
  19
  20 #define XML_ELM_DEFAULT     "default"
  21 #define XML_ELM_CONSTRAINTS "constraints"
  22
  23 CSettingPath::CSettingPath(const std::string &id, CSettingsManager *settingsManager /* = nullptr */)
  24   : CSettingString(id, settingsManager)
  25 { }
  26
  27 CSettingPath::CSettingPath(const std::string &id, int label, const std::string &value, CSettingsManager *settingsManager /* = nullptr */)
  28   : CSettingString(id, label, value, settingsManager)
  29 { }
  30
  31 CSettingPath::CSettingPath(const std::string &id, const CSettingPath &setting)
  32   : CSettingString(id, setting)
  33 {
  34   copy(setting);
  35 }
  36
  37 SettingPtr CSettingPath::Clone(const std::string &id) const
  38 {
  39   return std::make_shared<CSettingPath>(id, *this);
  40 }
  41
  42 bool CSettingPath::Deserialize(const TiXmlNode *node, bool update /* = false */)
  43 {
  44   std::unique_lock<CSharedSection> lock(m_critical);
  45
  46   if (!CSettingString::Deserialize(node, update))
  47     return false;
  48
  49   if (m_control != nullptr &&
  50      (m_control->GetType() != "button" || (m_control->GetFormat() != "path" && m_control->GetFormat() != "file" && m_control->GetFormat() != "image")))
  51   {
  52     CLog::Log(LOGERROR, "CSettingPath: invalid <control> of \"{}\"", m_id);
  53     return false;
  54   }
  55
  56   auto constraints = node->FirstChild(XML_ELM_CONSTRAINTS);
  57   if (constraints != nullptr)
  58   {
  59     // get writable
  60     XMLUtils::GetBoolean(constraints, "writable", m_writable);
  61     // get hide extensions
  62     XMLUtils::GetBoolean(constraints, "hideextensions", m_hideExtension);
  63
  64     // get sources
  65     auto sources = constraints->FirstChild("sources");
  66     if (sources != nullptr)
  67     {
  68       m_sources.clear();
  69       auto source = sources->FirstChild("source");
  70       while (source != nullptr)
  71       {
  72         auto child = source->FirstChild();
  73         if (child != nullptr)
  74         {
  75           const std::string& strSource = child->ValueStr();
  76           if (!strSource.empty())
  77             m_sources.push_back(strSource);
  78         }
  79
  80         source = source->NextSibling("source");
  81       }
  82     }
  83
  84     // get masking
  85     auto masking = constraints->FirstChild("masking");
  86     if (masking != nullptr)
  87       m_masking = masking->FirstChild()->ValueStr();
  88   }
  89
  90   return true;
  91 }
  92
  93 bool CSettingPath::SetValue(const std::string &value)
  94 {
  95   // for backwards compatibility to Frodo
  96   if (StringUtils::EqualsNoCase(value, "select folder") ||
  97       StringUtils::EqualsNoCase(value, "select writable folder"))
  98     return CSettingString::SetValue("");
  99
 100   return CSettingString::SetValue(value);
 101 }
 102
 103 std::string CSettingPath::GetMasking(const CFileExtensionProvider& fileExtensionProvider) const
 104 {
 105   if (m_masking.empty())
 106     return m_masking;
 107
 108   // setup masking
 109   auto audioMask = fileExtensionProvider.GetMusicExtensions();
 110   auto videoMask = fileExtensionProvider.GetVideoExtensions();
 111   auto imageMask = fileExtensionProvider.GetPictureExtensions();
 112   auto execMask = "";
 113 #if defined(TARGET_WINDOWS)
 114   execMask = ".exe|.bat|.cmd|.py";
 115 #endif // defined(TARGET_WINDOWS)
 116
 117   std::string masking = m_masking;
 118   if (masking == "video")
 119     return videoMask;
 120   if (masking == "audio")
 121     return audioMask;
 122   if (masking == "image")
 123     return imageMask;
 124   if (masking == "executable")
 125     return execMask;
 126
 127   // convert mask qualifiers
 128   StringUtils::Replace(masking, "$AUDIO", audioMask);
 129   StringUtils::Replace(masking, "$VIDEO", videoMask);
 130   StringUtils::Replace(masking, "$IMAGE", imageMask);
 131   StringUtils::Replace(masking, "$EXECUTABLE", execMask);
 132
 133   return masking;
 134 }
 135
 136 void CSettingPath::copy(const CSettingPath& setting)
 137 {
 138   CSettingString::Copy(setting);
 139
 140   std::unique_lock<CSharedSection> lock(m_critical);
 141   m_writable = setting.m_writable;
 142   m_sources = setting.m_sources;
 143   m_hideExtension = setting.m_hideExtension;
 144   m_masking = setting.m_masking;
 145 }