IDirectory.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "utils/Variant.h"

#include <string>

class CFileItemList;
class CProfileManager;
class CURL;
class CFileItem;

namespace XFILE
{
  enum DIR_CACHE_TYPE
  {
    DIR_CACHE_NEVER = 0, 
    DIR_CACHE_ONCE,      
    DIR_CACHE_ALWAYS     
  };

  enum DIR_FLAG
  {
    DIR_FLAG_DEFAULTS      = 0,
    DIR_FLAG_NO_FILE_DIRS  = (2 << 0), 
    DIR_FLAG_ALLOW_PROMPT  = (2 << 1), 
    DIR_FLAG_NO_FILE_INFO  = (2 << 2), 
    DIR_FLAG_GET_HIDDEN    = (2 << 3), 
    DIR_FLAG_READ_CACHE    = (2 << 4), 
    DIR_FLAG_BYPASS_CACHE  = (2 << 5)  
  };
class IDirectory
{
public:
  static void RegisterProfileManager(const CProfileManager &profileManager);
  static void UnregisterProfileManager();

  IDirectory();
  virtual ~IDirectory(void);
  virtual bool GetDirectory(const CURL& url, CFileItemList &items) = 0;
  virtual float GetProgress() const { return 0.0f; }
  virtual void CancelDirectory() {}
  virtual bool Create(const CURL& url) { return false; }
  virtual bool Exists(const CURL& url) { return false; }
  virtual bool Remove(const CURL& url) { return false; }

  virtual bool RemoveRecursive(const CURL& url) { return false; }

  virtual bool IsAllowed(const CURL& url) const;

  virtual bool AllowAll() const { return false; }

  virtual DIR_CACHE_TYPE GetCacheType(const CURL& url) const { return DIR_CACHE_ONCE; }

  void SetMask(const std::string& strMask);
  void SetFlags(int flags);

  bool ProcessRequirements();

  virtual bool Resolve(CFileItem& item) const { return true; };

protected:
  bool GetKeyboardInput(const CVariant &heading, std::string &input, bool hiddenInput = false);

  void SetErrorDialog(const CVariant &heading, const CVariant &line1, const CVariant &line2 = 0, const CVariant &line3 = 0);

  void RequireAuthentication(const CURL& url);

  static const CProfileManager *m_profileManager;

  std::string m_strFileMask;  

  int m_flags; 

  CVariant m_requirements;
};
}