FileSystemModel.h

#pragma once
 
#include <ToolsFoundation/ToolsFoundationDLL.h>
 
#if PL_ENABLED(PL_SUPPORTS_DIRECTORY_WATCHER) && PL_ENABLED(PL_SUPPORTS_FILE_ITERATORS)
 
#  include <Foundation/Application/Config/FileSystemConfig.h>
#  include <Foundation/Configuration/Singleton.h>
#  include <Foundation/Threading/LockedObject.h>
#  include <Foundation/Types/UniquePtr.h>
#  include <ToolsFoundation/FileSystem/DataDirPath.h>
#  include <ToolsFoundation/FileSystem/Declarations.h>
 
class plFileSystemWatcher;
struct plFileSystemWatcherEvent;
struct plFileStats;
 
struct PL_TOOLSFOUNDATION_DLL plFolderChangedEvent
{
  enum class Type
  {
    None,
    FolderAdded,
    FolderRemoved,
    ModelReset, 
  };
 
  plFolderChangedEvent() = default;
  plFolderChangedEvent(const plDataDirPath& file, Type type);
 
  plDataDirPath m_Path;
  Type m_Type = Type::None;
};
 
struct PL_TOOLSFOUNDATION_DLL plFileChangedEvent
{
  enum class Type
  {
    None,
    FileAdded,
    FileChanged,
    DocumentLinked,
    DocumentUnlinked,
    FileRemoved,
    ModelReset 
  };
 
  plFileChangedEvent() = default;
  plFileChangedEvent(const plDataDirPath& file, plFileStatus status, Type type);
 
  plDataDirPath m_Path;
  plFileStatus m_Status;
  Type m_Type = Type::None;
};
 
class PL_TOOLSFOUNDATION_DLL plFileSystemModel
{
  PL_DECLARE_SINGLETON(plFileSystemModel);
 
public:
  using FilesMap = plMap<plDataDirPath, plFileStatus, plCompareDataDirPath>;
  using FoldersMap = plMap<plDataDirPath, plFileStatus::Status, plCompareDataDirPath>;
 
  using LockedFiles = plLockedObject<plMutex, const FilesMap>;
  using LockedFolders = plLockedObject<plMutex, const FoldersMap>;
 
public:
  static bool IsSameFile(const plStringView sAbsolutePathA, const plStringView sAbsolutePathB);
 
  static plUInt64 HashFile(plStreamReader& ref_inputStream, plStreamWriter* pPassThroughStream);
 
public:
 
  plFileSystemModel();
  ~plFileSystemModel();
 
  void Initialize(const plApplicationFileSystemConfig& fileSystemConfig, FilesMap&& referencedFiles, FoldersMap&& referencedFolders);
 
  void Deinitialize(FilesMap* out_pReferencedFiles = nullptr, FoldersMap* out_pReferencedFolders = nullptr);
 
  void MainThreadTick();
 
  const plApplicationFileSystemConfig& GetFileSystemConfig() const { return m_FileSystemConfig; }
  plArrayPtr<const plString> GetDataDirectoryRoots() const { return m_DataDirRoots.GetArrayPtr(); }
 
 
  const LockedFiles GetFiles() const;
 
  const LockedFolders GetFolders() const;
 
  plResult FindFile(plStringView sPath, plFileStatus& out_stat) const;
 
  plResult FindFile(plDelegate<bool(const plDataDirPath&, const plFileStatus&)> visitor) const;
 
 
  void NotifyOfChange(plStringView sAbsolutePath);
 
  void CheckFolder(plStringView sAbsolutePath);
 
  void CheckFileSystem();
 
 
  plResult LinkDocument(plStringView sAbsolutePath, const plUuid& documentId);
 
  plResult UnlinkDocument(plStringView sAbsolutePath);
 
  plResult ReadDocument(plStringView sAbsolutePath, const plDelegate<void(const plFileStatus&, plStreamReader&)>& callback);
 
  plResult HashFile(plStringView sAbsolutePath, plFileStatus& out_stat);
 
 
public:
  plCopyOnBroadcastEvent<const plFolderChangedEvent&, plMutex> m_FolderChangedEvents;
  plCopyOnBroadcastEvent<const plFileChangedEvent&, plMutex> m_FileChangedEvents;
 
private:
  void SetAllStatusUnknown();
  void RemoveStaleFileInfos();
 
  void OnAssetWatcherEvent(const plFileSystemWatcherEvent& e);
  plFileStatus HandleSingleFile(plDataDirPath absolutePath, bool bRecurseIntoFolders);
  plFileStatus HandleSingleFile(plDataDirPath absolutePath, const plFileStats& FileStat, bool bRecurseIntoFolders);
 
  void RemoveFileOrFolder(const plDataDirPath& absolutePath, bool bRecurseIntoFolders);
 
  void MarkFileLocked(plStringView sAbsolutePath);
 
  void FireFileChangedEvent(const plDataDirPath& file, plFileStatus fileStatus, plFileChangedEvent::Type type);
  void FireFolderChangedEvent(const plDataDirPath& file, plFolderChangedEvent::Type type);
 
private:
  // Immutable data after Initialize
  plApplicationFileSystemConfig m_FileSystemConfig;
  plDynamicArray<plString> m_DataDirRoots;
  plUniquePtr<plFileSystemWatcher> m_pWatcher;
  plEventSubscriptionID m_WatcherSubscription = {};
 
  // Actual file system data
  mutable plMutex m_FilesMutex;
  plAtomicBool m_bInitialized = false;
 
  FilesMap m_ReferencedFiles;     // Absolute path to stat map
  FoldersMap m_ReferencedFolders; // Absolute path to status map
  plSet<plString> m_LockedFiles;
  plMap<plString, plFileStatus> m_TransiendFiles; // Absolute path to stat for files outside the data directories.
};
 
#endif