Archive.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
#include <string>
#include <unordered_map>
#include <mutex>
#include "ship/utils/binarytools/BinaryReader.h"
 
namespace tinyxml2 {
class XMLDocument;
class XMLElement;
} // namespace tinyxml2
 
namespace Ship {
class Keystore;
#define OTR_HEADER_SIZE ((size_t)64)
 
struct File;
struct ResourceInitData;
class ResourceManager;
 
struct ArchiveManifest {
    std::string Name;        
    std::string Icon;        
    std::string Author;      
    std::string Version;     
    std::string Website;     
    std::string Description; 
    std::string License;     
 
    uint32_t CodeVersion; 
    uint32_t GameVersion; 
 
    std::string Main;                                      
    std::unordered_map<std::string, std::string> Binaries; 
    std::vector<std::string> Dependencies;                 
 
    std::string Checksum;  
    std::string Signature; 
    std::string PublicKey; 
};
 
class Archive : public std::enable_shared_from_this<Archive> {
    friend class ArchiveManager;
 
  public:
    Archive(const std::string& path, std::shared_ptr<ResourceManager> resourceManager = nullptr,
            std::shared_ptr<Keystore> keystore = nullptr);
    ~Archive();
 
    bool operator==(const Archive& rhs) const;
 
    void Load();
 
    void Unload();
 
    virtual std::shared_ptr<File> LoadFile(const std::string& filePath) = 0;
 
    virtual std::shared_ptr<File> LoadFile(uint64_t hash) = 0;
 
    std::shared_ptr<std::unordered_map<uint64_t, std::string>> ListFiles();
 
    std::shared_ptr<std::unordered_map<uint64_t, std::string>> ListFiles(const std::string& filter);
 
    bool HasFile(const std::string& filePath);
 
    bool HasFile(uint64_t hash);
 
    bool HasGameVersion();
 
    uint32_t GetGameVersion();
 
    const ArchiveManifest& GetManifest();
 
    bool IsSigned();
 
    bool IsChecksumValid();
 
    const std::string& GetPath();
 
    bool IsInitialized();
 
    virtual bool Open() = 0;
 
    virtual bool Close() = 0;
 
    virtual bool WriteFile(const std::string& filename, const std::vector<uint8_t>& data) = 0;
 
  protected:
    void SetInitialized(bool isInitialized);
    void SetGameVersion(uint32_t gameVersion);
    void IndexFile(const std::string& filePath);
    void Validate();
 
    std::shared_ptr<ResourceManager> mResourceManager;
    std::shared_ptr<Keystore> mKeystore;
 
  private:
    bool mIsInitialized;
    bool mIsSigned;
    bool mIsChecksumValid;
    bool mHasGameVersion;
    uint32_t mGameVersion;
    ArchiveManifest mManifest;
    std::string mPath;
    std::shared_ptr<std::unordered_map<uint64_t, std::string>> mHashes;
};
} // namespace Ship