BuildPatchManifest.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Guid.h"
#include "Interfaces/IBuildManifest.h"
#include "Data/ChunkData.h"
#include "Data/ManifestData.h"
 
class FBuildPatchAppManifest;
class FBuildPatchCustomField;
 
typedef TSharedPtr< class FBuildPatchCustomField, ESPMode::ThreadSafe > FBuildPatchCustomFieldPtr;
typedef TSharedRef< class FBuildPatchCustomField, ESPMode::ThreadSafe > FBuildPatchCustomFieldRef;
typedef TSharedPtr< class FBuildPatchAppManifest, ESPMode::ThreadSafe > FBuildPatchAppManifestPtr;
typedef TSharedRef< class FBuildPatchAppManifest, ESPMode::ThreadSafe > FBuildPatchAppManifestRef;
 
class FBuildPatchCustomField
    : public IManifestField
{
public:
    FBuildPatchCustomField(const FString& Value);
 
    // START IBuildManifest Interface
    virtual FString AsString() const override;
    virtual double AsDouble() const override;
    virtual int64 AsInteger() const override;
    // END IBuildManifest Interface
 
private:
    FBuildPatchCustomField(){}
 
private:
    // Holds the underlying value
    FString CustomValue;
};
 
// Required to allow private access to manifest builder for now..
namespace BuildPatchServices
{
    class FBuildPatchInstaller;
    class FManifestBuilder;
    class FManifestData;
    class FChunkDeltaOptimiser;
    class FBuildPatchManifestSet;
}
 
class FBuildPatchAppManifest
    : public IBuildManifest
{
    // Allow access to build processor classes
    friend class FBuildDataGenerator;
    friend class FBuildDataFileProcessor;
    friend class BuildPatchServices::FBuildPatchInstaller;
    friend class BuildPatchServices::FManifestBuilder;
    friend class FBuildMergeManifests;
    friend class FBuildDiffManifests;
    friend class FManifestUObject;
    friend class BuildPatchServices::FManifestData;
    friend class BuildPatchServices::FChunkDeltaOptimiser;
    friend class BuildPatchServices::FBuildPatchManifestSet;
public:
 
    FBuildPatchAppManifest();
 
    FBuildPatchAppManifest(const uint32& InAppID, const FString& AppName);
 
    FBuildPatchAppManifest(const FBuildPatchAppManifest& Other);
 
    ~FBuildPatchAppManifest();
 
    // START IBuildManifest Interface
    virtual uint32  GetAppID() const override;
    virtual const FString& GetAppName() const override;
    virtual const FString& GetVersionString() const override;
    virtual const FString& GetLaunchExe() const override;
    virtual const FString& GetLaunchCommand() const override;
    virtual const TSet<FString>& GetPrereqIds() const override;
    virtual const FString& GetPrereqName() const override;
    virtual const FString& GetPrereqPath() const override;
    virtual const FString& GetPrereqArgs() const override;
    virtual int64 GetDownloadSize() const override;
    virtual int64 GetDownloadSize(const TSet<FString>& Tags) const override;
    virtual int64 GetDeltaDownloadSize(const TSet<FString>& Tags, const IBuildManifestRef& PreviousVersion) const override;
    virtual int64 GetDeltaDownloadSize(const TSet<FString>& Tags, const IBuildManifestRef& PreviousVersion, const TSet<FString>& PreviousTags) const override;
    virtual int64 GetBuildSize() const override;
    virtual int64 GetBuildSize(const TSet<FString>& Tags) const override;
    virtual TArray<FString> GetBuildFileList() const override;
    virtual TArray<FStringView> GetBuildFileListView() const override;
    virtual TArray<FString> GetBuildFileList(const TSet<FString>& Tags) const override;
    virtual TArray<FStringView> GetBuildFileListView(const TSet<FString>& Tags) const override;
    virtual int64 GetFileSize(FStringView Filename) const override;
    virtual int64 GetFileSize(const TArray<FString>& Filenames) const override;
    virtual int64 GetFileSize(const TSet  <FString>& Filenames) const override;
    virtual bool GetFileHash(const FString& Filename, FSHAHash& OutHash) const override;
    virtual TSet<FString> GetFileTagList() const override;
    virtual void GetFileTagList(TSet<FString>& Tags) const override;
    virtual void GetOutdatedFiles(const IBuildManifestRef& OldManifest, TSet<FString>& OutdatedFiles) const override;
    virtual void GetRemovableFiles(const IBuildManifestRef& OldManifest, TArray<FString>& RemovableFiles) const override;
    virtual void GetRemovableFiles(const TCHAR* InstallPath, TArray<FString>& RemovableFiles) const override;
    virtual bool NeedsResaving() const override;
    virtual void CopyCustomFields(const IBuildManifestRef& Other, bool bClobber) override;
    virtual const IManifestFieldPtr GetCustomField(const FString& FieldName) const override;
    virtual const IManifestFieldPtr SetCustomField(const FString& FieldName, const FString& Value) override;
    virtual const IManifestFieldPtr SetCustomField(const FString& FieldName, const double& Value) override;
    virtual const IManifestFieldPtr SetCustomField(const FString& FieldName, const int64& Value) override;
    virtual void RemoveCustomField(const FString& FieldName) override;
    virtual IBuildManifestRef Duplicate() const override;
    // END IBuildManifest Interface
 
    virtual const FString& GetBuildId() const;
 
    virtual bool LoadFromFile(const FString& Filename);
 
    virtual bool DeserializeFromData(const TArray<uint8>& DataInput);
 
    virtual bool DeserializeFromJSON(const FString& JSONInput);
 
    virtual bool SaveToFile(const FString& Filename, BuildPatchServices::EFeatureLevel SaveFormat = BuildPatchServices::EFeatureLevel::Latest);
 
    virtual void SerializeToJSON(FString& JSONOutput);
 
    virtual BuildPatchServices::EFeatureLevel GetFeatureLevel() const;
 
    virtual void GetChunksRequiredForFiles(const TSet<FString>& Filenames, TSet<FGuid>& RequiredChunks) const;
 
    virtual uint32 GetNumberOfChunkReferences(const FGuid& ChunkGuid) const;
 
    virtual int64 GetDataSize(const FGuid& DataGuid) const;
 
    virtual int64 GetDataSize(const TArray<FGuid>& DataGuids) const;
    virtual int64 GetDataSize(const TSet  <FGuid>& DataGuids) const;
 
    virtual uint32 GetNumFiles() const;
 
    virtual void GetFileList(TArray<FString>& Filenames) const;
    virtual void GetFileList(TArray<FStringView>& Filenames) const;
    virtual void GetFileList(TSet  <FString>& Filenames) const;
 
    virtual void GetTaggedFileList(const TSet<FString>& Tags, TArray<FString>&     TaggedFiles) const;
    virtual void GetTaggedFileList(const TSet<FString>& Tags, TArray<FStringView>& TaggedFiles) const;
    virtual void GetTaggedFileList(const TSet<FString>& Tags, TSet<FString>&       TaggedFiles) const;
 
    virtual void GetDataList(TArray<FGuid>& DataGuids) const;
    virtual void GetDataList(TSet  <FGuid>& DataGuids) const;
 
    virtual const BuildPatchServices::FFileManifest* GetFileManifest(const FString& Filename) const;
 
    virtual bool IsFileDataManifest() const;
 
    virtual bool GetChunkHash(const FGuid& ChunkGuid, uint64& OutHash) const;
 
    virtual bool GetChunkShaHash(const FGuid& ChunkGuid, FSHAHash& OutHash) const;
 
    virtual const BuildPatchServices::FChunkInfo* GetChunkInfo(const FGuid& ChunkGuid) const;
 
    virtual bool GetFileHash(const FGuid& FileGuid, FSHAHash& OutHash) const; // DEPRECATE ME
 
    virtual bool GetFilePartHash(const FGuid& FilePartGuid, uint64& OutHash) const;
 
 
    virtual int32 EnumerateProducibleChunks(const TSet<FString>& TagSet, const TSet<FGuid>& ChunksRequired, TSet<FGuid>& ChunksAvailable) const;
 
    virtual void GetOutdatedFiles(const FBuildPatchAppManifestPtr& OldManifest, const FString& InstallDirectory, TSet<FString>& OutDatedFiles) const;
    virtual void GetOutdatedFiles(const FBuildPatchAppManifest*    OldManifest, const FString& InstallDirectory, TSet<FString>& OutDatedFiles) const;
    virtual void GetOutdatedFiles(const FBuildPatchAppManifest*    OldManifest, const FString& InstallDirectory, const TSet<FString>& FilesToCheck, TSet<FString>& OutDatedFiles) const;
 
    virtual bool IsFileOutdated(const FBuildPatchAppManifestRef& OldManifest, const FString& Filename) const;
    virtual bool IsFileOutdated(const FBuildPatchAppManifest&    OldManifest, const FString& Filename) const;
 
    virtual void GetRemovableFiles(const FBuildPatchAppManifest& OldManifest, TArray<FString>& RemovableFiles) const;
 
 
    virtual bool HasFileAttributes() const;
 
private:
    void DestroyData();
 
protected:
    void InitLookups();
private:
 
    int32 EnumerateProducibleChunks_Internal(const TFunction<bool(const FString&)>& FileAccessChecker, const TSet<FGuid>& ChunksRequired, TSet<FGuid>& ChunksAvailable) const;
 
protected:
    BuildPatchServices::FManifestMeta ManifestMeta;
    BuildPatchServices::FChunkDataList ChunkDataList;
    BuildPatchServices::FFileManifestList FileManifestList;
    BuildPatchServices::FCustomFields CustomFields;
 
private:
 
    FDelegateHandle OnPreExitHandle;
 
    TMap<FGuid, const FString*> FileNameLookup;
    TMap<FStringView, const BuildPatchServices::FFileManifest*> FileManifestLookup;
    TMap<FString, TArray<const BuildPatchServices::FFileManifest*>> TaggedFilesLookup;
    TMap<FGuid, const BuildPatchServices::FChunkInfo*> ChunkInfoLookup;
 
    int64 TotalBuildSize;
    int64 TotalDownloadSize;
 
    bool bNeedsResaving;
};