eepp/include/eepp/ui/models/filesystemmodel.hpp

#ifndef EE_UI_MODELS_FILESYSTEMMODEL_HPP
#define EE_UI_MODELS_FILESYSTEMMODEL_HPP

#include <atomic>
#include <eepp/system/fileinfo.hpp>
#include <eepp/ui/models/model.hpp>
#include <eepp/ui/uiicon.hpp>
#include <memory>

namespace EE { namespace UI { namespace Models {

enum FileSystemEventType {
	/// Sent when a file is created or renamed
	Add = 1,
	/// Sent when a file is deleted or renamed
	Delete = 2,
	/// Sent when a file is modified
	Modified = 3,
	/// Sent when a file is moved
	Moved = 4
};

struct FileEvent {
	FileSystemEventType type;
	std::string directory;
	std::string filename;
	std::string oldFilename;

	FileEvent( const FileSystemEventType& action, const std::string& directory,
			   const std::string& filename, const std::string& oldFilename = "" ) :
		type( action ), directory( directory ), filename( filename ), oldFilename( oldFilename ) {}
};

class EE_API FileSystemModel : public Model {
  public:
	enum class Mode { DirectoriesOnly, FilesAndDirectories };

	struct DisplayConfig {
		DisplayConfig() {}
		DisplayConfig(
			bool sortByName, bool foldersFirst, bool ignoreHidden,
			std::vector<std::string> acceptedExtensions = {},
			std::function<bool( const std::string& filepath )> fileIsVisibleFn = nullptr ) :
			sortByName( sortByName ),
			foldersFirst( foldersFirst ),
			ignoreHidden( ignoreHidden ),
			acceptedExtensions( acceptedExtensions ),
			fileIsVisibleFn( fileIsVisibleFn ) {}
		bool sortByName{ true };
		bool foldersFirst{ true };
		bool ignoreHidden{ false };
		std::vector<std::string> acceptedExtensions;
		std::function<bool( const std::string& filepath )> fileIsVisibleFn;
		bool operator==( const DisplayConfig& other ) {
			return sortByName == other.sortByName && foldersFirst == other.foldersFirst &&
				   ignoreHidden == other.ignoreHidden &&
				   acceptedExtensions == other.acceptedExtensions;
		}
		bool operator!=( const DisplayConfig& other ) { return !( *this == other ); }
	};

	enum Column {
		Icon = 0,
		Name,
		Size,
		Owner,
		Group,
		Permissions,
		ModificationTime,
		Inode,
		Path,
		SymlinkTarget,
		Count,
	};

	struct EE_API Node {
	  public:
		Node( const std::string& rootPath, const FileSystemModel& model );

		Node( FileInfo&& info, Node* parent );

		const std::string& getName() const { return mName; }

		Node* getParent() const { return mParent; }

		const FileInfo& info() const { return mInfo; }

		const std::string& fullPath() const;

		const std::string& getMimeType() const { return mMimeType; }

		size_t childCount() const { return mChildren.size(); }

		const Node& getChild( const size_t& index );

		void invalidate();

		bool inParentTree( Node* parent ) const;

		Node* findChildName( const std::string& name, const FileSystemModel& model,
							 bool forceRefresh = false );

		Int64 findChildRowFromInternalData( void* internalData, const FileSystemModel& model,
											bool forceRefresh = false );

		Int64 findChildRowFromName( const std::string& name, const FileSystemModel& model,
									bool forceRefresh = false );

		void refresh( const FileSystemModel& model );

		~Node();

		FileSystemModel::Node* childWithPathExists( const std::string& path );

	  private:
		friend class FileSystemModel;

		Node() {}

		Node* createChild( const std::string& childName, const FileSystemModel& model );

		void rename( const FileInfo& file );

		friend class FileSystemModel;
		std::string mName;
		std::string mMimeType;
		Node* mParent{ nullptr };
		FileInfo mInfo;
		std::vector<Node*> mChildren;
		bool mHasTraversed{ false };
		bool mInfoDirty{ true };

		ModelIndex index( const FileSystemModel& model, int column ) const;

		void cleanChildren();

		void traverseIfNeeded( const FileSystemModel& );

		void refreshIfNeeded( const FileSystemModel& );

		bool fetchData( const String& fullPath );
	};

	static std::shared_ptr<FileSystemModel>
	New( const std::string& rootPath, const Mode& mode = Mode::FilesAndDirectories,
		 const DisplayConfig displayConfig = DisplayConfig() );

	const Mode& getMode() const { return mMode; }

	const std::string& getRootPath() const;

	void setRootPath( const std::string& rootPath );

	Node* getNodeFromPath( std::string path, bool folderNode = false, bool invalidateTree = true );

	void reload();

	void refresh();

	void update();

	const Node& node( const ModelIndex& index ) const;
	virtual size_t treeColumn() const { return Column::Name; }
	virtual size_t rowCount( const ModelIndex& = ModelIndex() ) const;
	virtual size_t columnCount( const ModelIndex& = ModelIndex() ) const;
	virtual std::string columnName( const size_t& column ) const;
	virtual Variant data( const ModelIndex&, ModelRole role = ModelRole::Display ) const;
	virtual ModelIndex parentIndex( const ModelIndex& ) const;
	virtual ModelIndex index( int row, int column = 0,
							  const ModelIndex& parent = ModelIndex() ) const;

	virtual UIIcon* iconFor( const Node& node, const ModelIndex& index ) const;

	void setMode( const Mode& mode );

	const DisplayConfig& getDisplayConfig() const;

	void setDisplayConfig( const DisplayConfig& displayConfig );

	const ModelIndex& getPreviouslySelectedIndex() const;

	void setPreviouslySelectedIndex( const ModelIndex& previouslySelectedIndex );

	bool handleFileEvent( const FileEvent& event );

	~FileSystemModel();

  protected:
	std::atomic<bool> mInitOK;
	std::string mRootPath;
	std::string mRealRootPath;
	std::unique_ptr<Node> mRoot{ nullptr };
	Mode mMode{ Mode::FilesAndDirectories };
	DisplayConfig mDisplayConfig;

	ModelIndex mPreviouslySelectedIndex{};

	Node& nodeRef( const ModelIndex& index ) const;

	FileSystemModel( const std::string& rootPath, const Mode& mode,
					 const DisplayConfig displayConfig );

	size_t getFileIndex( Node* parent, const FileInfo& file );

	bool handleFileEventLocked( const FileEvent& event );
};

class EE_API DiskDrivesModel : public Model {
  public:
	enum Column {
		Icon = 0,
		Name,
		Count,
	};

	static std::shared_ptr<DiskDrivesModel> create( const std::vector<std::string>& data );

	static std::shared_ptr<DiskDrivesModel> create();

	virtual ~DiskDrivesModel() {}

	virtual size_t rowCount( const ModelIndex& ) const { return mData.size(); }

	virtual size_t columnCount( const ModelIndex& ) const { return 2; }

	virtual std::string columnName( const size_t& index ) const {
		return index == 0 ? "Icon" : "Name";
	}

	UIIcon* diskIcon() const;

	virtual Variant data( const ModelIndex& index, ModelRole role = ModelRole::Display ) const;

	virtual void update() { onModelUpdate(); }

  private:
	explicit DiskDrivesModel( const std::vector<std::string>& data ) : mData( data ) {}

	std::vector<std::string> mData;
};

}}} // namespace EE::UI::Models

#endif // EE_UI_MODELS_FILESYSTEMMODEL_HPP