xbmc/filesystem/IDirectory.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 "IDirectory.h"
  10
  11 #include "PasswordManager.h"
  12 #include "URL.h"
  13 #include "guilib/GUIKeyboardFactory.h"
  14 #include "messaging/helpers/DialogOKHelper.h"
  15 #include "utils/StringUtils.h"
  16 #include "utils/URIUtils.h"
  17
  18 using namespace KODI::MESSAGING;
  19 using namespace XFILE;
  20
  21 const CProfileManager *IDirectory::m_profileManager = nullptr;
  22
  23 void IDirectory::RegisterProfileManager(const CProfileManager &profileManager)
  24 {
  25   m_profileManager = &profileManager;
  26 }
  27
  28 void IDirectory::UnregisterProfileManager()
  29 {
  30   m_profileManager = nullptr;
  31 }
  32
  33 IDirectory::IDirectory()
  34 {
  35   m_flags = DIR_FLAG_DEFAULTS;
  36 }
  37
  38 IDirectory::~IDirectory(void) = default;
  39
  40 /*!
  41  \brief Test if file have an allowed extension, as specified with SetMask()
  42  \param strFile File to test
  43  \return \e true if file is allowed
  44  \note If extension is ".ifo", filename format must be "vide_ts.ifo" or
  45        "vts_##_0.ifo". If extension is ".dat", filename format must be
  46        "AVSEQ##(#).DAT", "ITEM###(#).DAT" or "MUSIC##(#).DAT".
  47  */
  48 bool IDirectory::IsAllowed(const CURL& url) const
  49 {
  50   if (m_strFileMask.empty())
  51     return true;
  52
  53   // Check if strFile have an allowed extension
  54   if (!URIUtils::HasExtension(url, m_strFileMask))
  55     return false;
  56
  57   // We should ignore all non dvd/vcd related ifo and dat files.
  58   if (URIUtils::HasExtension(url, ".ifo"))
  59   {
  60     std::string fileName = URIUtils::GetFileName(url);
  61
  62     // Allow filenames of the form video_ts.ifo or vts_##_0.ifo
  63
  64     return StringUtils::EqualsNoCase(fileName, "video_ts.ifo") ||
  65           (fileName.length() == 12 &&
  66            StringUtils::StartsWithNoCase(fileName, "vts_") &&
  67            StringUtils::EndsWithNoCase(fileName, "_0.ifo"));
  68   }
  69
  70   if (URIUtils::HasExtension(url, ".dat"))
  71   {
  72     std::string fileName = URIUtils::GetFileName(url);
  73     std::string folder = URIUtils::GetDirectory(fileName);
  74     URIUtils::RemoveSlashAtEnd(folder);
  75     folder = URIUtils::GetFileName(folder);
  76     if (StringUtils::EqualsNoCase(folder, "vcd") ||
  77         StringUtils::EqualsNoCase(folder, "mpegav") ||
  78         StringUtils::EqualsNoCase(folder, "cdda"))
  79     {
  80       // Allow filenames of the form AVSEQ##(#).DAT, ITEM###(#).DAT
  81       // and MUSIC##(#).DAT
  82       return (fileName.length() == 11 || fileName.length() == 12) &&
  83              (StringUtils::StartsWithNoCase(fileName, "AVSEQ") ||
  84               StringUtils::StartsWithNoCase(fileName, "MUSIC") ||
  85               StringUtils::StartsWithNoCase(fileName, "ITEM"));
  86     }
  87   }
  88   return true;
  89 }
  90
  91 /*!
  92  \brief Set a mask of extensions for the files in the directory.
  93  \param strMask Mask of file extensions that are allowed.
  94
  95  The mask has to look like the following: \n
  96  \verbatim
  97  .m4a|.flac|.aac|
  98  \endverbatim
  99  So only *.m4a, *.flac, *.aac files will be retrieved with GetDirectory().
 100  */
 101 void IDirectory::SetMask(const std::string& strMask)
 102 {
 103   m_strFileMask = strMask;
 104   // ensure it's completed with a | so that filtering is easy.
 105   StringUtils::ToLower(m_strFileMask);
 106   if (m_strFileMask.size() && m_strFileMask[m_strFileMask.size() - 1] != '|')
 107     m_strFileMask += '|';
 108 }
 109
 110 /*!
 111  \brief Set the flags for this directory handler.
 112  \param flags - \sa XFILE::DIR_FLAG for a description.
 113  */
 114 void IDirectory::SetFlags(int flags)
 115 {
 116   m_flags = flags;
 117 }
 118
 119 bool IDirectory::ProcessRequirements()
 120 {
 121   std::string type = m_requirements["type"].asString();
 122   if (type == "keyboard")
 123   {
 124     std::string input;
 125     if (CGUIKeyboardFactory::ShowAndGetInput(input, m_requirements["heading"], false, m_requirements["hidden"].asBoolean()))
 126     {
 127       m_requirements["input"] = input;
 128       return true;
 129     }
 130   }
 131   else if (type == "authenticate")
 132   {
 133     CURL url(m_requirements["url"].asString());
 134     if (CPasswordManager::GetInstance().PromptToAuthenticateURL(url))
 135     {
 136       m_requirements.clear();
 137       return true;
 138     }
 139   }
 140   else if (type == "error")
 141   {
 142     HELPERS::ShowOKDialogLines(CVariant{m_requirements["heading"]}, CVariant{m_requirements["line1"]}, CVariant{m_requirements["line2"]}, CVariant{m_requirements["line3"]});
 143   }
 144   m_requirements.clear();
 145   return false;
 146 }
 147
 148 bool IDirectory::GetKeyboardInput(const CVariant &heading, std::string &input, bool hiddenInput)
 149 {
 150   if (!m_requirements["input"].asString().empty())
 151   {
 152     input = m_requirements["input"].asString();
 153     return true;
 154   }
 155   m_requirements.clear();
 156   m_requirements["type"] = "keyboard";
 157   m_requirements["heading"] = heading;
 158   m_requirements["hidden"] = hiddenInput;
 159   return false;
 160 }
 161
 162 void IDirectory::SetErrorDialog(const CVariant &heading, const CVariant &line1, const CVariant &line2, const CVariant &line3)
 163 {
 164   m_requirements.clear();
 165   m_requirements["type"] = "error";
 166   m_requirements["heading"] = heading;
 167   m_requirements["line1"] = line1;
 168   m_requirements["line2"] = line2;
 169   m_requirements["line3"] = line3;
 170 }
 171
 172 void IDirectory::RequireAuthentication(const CURL &url)
 173 {
 174   m_requirements.clear();
 175   m_requirements["type"] = "authenticate";
 176   m_requirements["url"] = url.Get();
 177 }