Components/IFS/src/include/IFS/HYFS/FileSystem.h

Go to the documentation of this file.

/*
 * 
 * Files on SPIFFS are used in preference to FW.
 *
 * Formatting this system wipes SPIFFS to reset to a 'factory default' state.
 *
 * Images are created using a python script.
 *
 * @todo
 *  When a file is deleted, if it exists on FW then a zero-length file should be placed on SPIFFS
 *  with an attribute to indicate it has been deleted.
 *  An 'undelete' could be added which would remove this to restore the FW file. It probably wouldn't
 *  be useful on any other filing system though, and may not always succeed.
 *
 */

#pragma once

#include "../FWFS/FileSystem.h"
#include "../SPIFFS/FileSystem.h"
#include "../Types.h"

#ifndef HYFS_HIDE_FLAGS
#define HYFS_HIDE_FLAGS 1
#endif

#if HYFS_HIDE_FLAGS == 1
#include "WVector.h"
#endif

namespace IFS
{
namespace HYFS
{
class FileSystem : public IFileSystem
{
public:
    FileSystem(IObjectStore* fwStore, Storage::Partition ffsPartition) : fwfs(fwStore), ffs(ffsPartition)
    {
    }

    // IFileSystem methods
    int mount() override;
    int getinfo(Info& info) override;
    String getErrorString(int err) override;
    int opendir(const char* path, DirHandle& dir) override;
    int readdir(DirHandle dir, Stat& stat) override;
    int rewinddir(DirHandle dir) override;
    int closedir(DirHandle dir) override;
    int mkdir(const char* path) override;
    int stat(const char* path, Stat* stat) override;
    int fstat(FileHandle file, Stat* stat) override;
    int fcontrol(FileHandle file, ControlCode code, void* buffer, size_t bufSize) override;
    int setacl(FileHandle file, const ACL& acl) override;
    int setattr(const char* path, FileAttributes attr) override;
    int settime(FileHandle file, time_t mtime) override;
    int setcompression(FileHandle file, const Compression& compression) override;
    FileHandle open(const char* path, OpenFlags flags) override;
    FileHandle fopen(const Stat& stat, OpenFlags flags) override;
    int close(FileHandle file) override;
    int read(FileHandle file, void* data, size_t size) override;
    int write(FileHandle file, const void* data, size_t size) override;
    int lseek(FileHandle file, int offset, SeekOrigin origin) override;
    int eof(FileHandle file) override;
    int32_t tell(FileHandle file) override;
    int ftruncate(FileHandle file, size_t new_size) override;
    int flush(FileHandle file) override;
    int rename(const char* oldpath, const char* newpath) override;
    int remove(const char* path) override;
    int fremove(FileHandle file) override;
    int format() override;
    int check() override;

private:
    int hideFWFile(const char* path, bool hide);
    bool isFWFileHidden(const Stat& fwstat);

private:
    FWFS::FileSystem fwfs;
    SPIFFS::FileSystem ffs;
#if HYFS_HIDE_FLAGS == 1
    Vector<FileID> hiddenFwFiles;
#endif
};

} // namespace HYFS

} // namespace IFS