xbmc/filesystem/AddonsDirectory.h

   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 #pragma once
  10
  11 #include "IDirectory.h"
  12
  13 #include <memory>
  14 #include <vector>
  15
  16 class CFileItem;
  17 class CFileItemList;
  18 class CURL;
  19 typedef std::shared_ptr<CFileItem> CFileItemPtr;
  20
  21 namespace ADDON
  22 {
  23 class IAddon;
  24 using VECADDONS = std::vector<std::shared_ptr<IAddon>>;
  25 } // namespace ADDON
  26
  27 namespace XFILE
  28 {
  29
  30   /*!
  31   \ingroup windows
  32   \brief Get access to shares and it's directories.
  33   */
  34   class CAddonsDirectory : public IDirectory
  35   {
  36   public:
  37     CAddonsDirectory(void);
  38     ~CAddonsDirectory(void) override;
  39     bool GetDirectory(const CURL& url, CFileItemList &items) override;
  40     bool Create(const CURL& url) override { return true; }
  41     bool Exists(const CURL& url) override { return true; }
  42     bool AllowAll() const override { return true; }
  43
  44     /*! \brief Fetch script and plugin addons of a given content type
  45      \param content the content type to fetch
  46      \param addons the list of addons to fill with scripts and plugin content
  47      \return true if content is valid, false if it's invalid.
  48      */
  49     static bool GetScriptsAndPlugins(const std::string &content, ADDON::VECADDONS &addons);
  50
  51     /*! \brief Fetch scripts and plugins of a given content type
  52      \param content the content type to fetch
  53      \param items the list to fill with scripts and content
  54      \return true if more than one item is found, false otherwise.
  55      */
  56     static bool GetScriptsAndPlugins(const std::string &content, CFileItemList &items);
  57
  58     static void GenerateAddonListing(const CURL& path,
  59                                      const ADDON::VECADDONS& addons,
  60                                      CFileItemList& items,
  61                                      const std::string& label);
  62     static CFileItemPtr FileItemFromAddon(const std::shared_ptr<ADDON::IAddon>& addon,
  63                                           const std::string& path,
  64                                           bool folder = false);
  65
  66     /*! \brief Returns true if `path` is a path or subpath of the repository directory, otherwise false */
  67     static bool IsRepoDirectory(const CURL& path);
  68
  69   private:
  70     bool GetSearchResults(const CURL& path, CFileItemList &items);
  71   };
  72 }