SandboxedFile.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/SandboxedFile.hpp
// \brief A directory-sandboxed wrapper around Os::File
// ======================================================================
#ifndef Os_SandboxedFile_hpp_
#define Os_SandboxedFile_hpp_

#include <Fw/Types/FileNameString.hpp>
#include <Os/File.hpp>
#include <Os/FilePathUtils.hpp>

namespace Os {

class SandboxedFile {
  public:
    SandboxedFile(const SandboxedFile&) = delete;             
    SandboxedFile& operator=(const SandboxedFile&) = delete;  

    SandboxedFile();

    ~SandboxedFile();

    void configure(const char* allowedDirectory);

    bool isConfigured() const;

    // -------------------------------------------------------
    // Os::File-equivalent interface
    // -------------------------------------------------------

    Os::FileInterface::Status open(const char* path,
                                   Os::FileInterface::Mode mode,
                                   Os::FileInterface::OverwriteType overwrite = Os::FileInterface::NO_OVERWRITE);

    void close();

    bool isOpen() const;

    Os::FileInterface::Status size(FwSizeType& size_result);

    Os::FileInterface::Status position(FwSizeType& position_result);

    Os::FileInterface::Status preallocate(FwSizeType offset, FwSizeType length);

    Os::FileInterface::Status seek(FwSignedSizeType offset, Os::FileInterface::SeekType seekType);

    Os::FileInterface::Status flush();

    Os::FileInterface::Status read(U8* buffer, FwSizeType& size, Os::FileInterface::WaitType wait);

    Os::FileInterface::Status read(U8* buffer, FwSizeType& size);

    Os::FileInterface::Status write(const U8* buffer, FwSizeType& size, Os::FileInterface::WaitType wait);

    Os::FileInterface::Status write(const U8* buffer, FwSizeType& size);

    Os::FileInterface::Status calculateCrc(U32& crc);

    const char* getSandboxDirectory() const;

  private:
    Os::File m_file;

    Fw::FileNameString m_allowedDirectory;

    bool m_configured;
};

}  // namespace Os

#endif