BuildPatchServicesModule.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/IBuildPatchServicesModule.h"
#include "BuildPatchInstaller.h"
#include "Containers/Ticker.h"
 
class IAnalyticsProvider;
 
enum
{
    // Sizes
    FileBufferSize      = 1024*1024*4,      // When reading from files, how much to buffer
    StreamBufferSize    = FileBufferSize*4, // When reading from build data stream, how much to buffer.
};
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
class FBuildPatchServicesModule
    : public IBuildPatchServicesModule
{
public:
 
    // IModuleInterface interface begin.
    virtual void StartupModule() override;
    virtual void ShutdownModule() override;
    // IModuleInterface interface end.
 
    // IBuildPatchServicesModule interface begin.
    virtual IBuildInstallerRef CreateBuildInstaller(BuildPatchServices::FBuildInstallerConfiguration Configuration, FBuildPatchInstallerDelegate OnComplete) const override;
    virtual IBuildInstallerSharedContextRef CreateBuildInstallerSharedContext(const TCHAR* DebugName) const override;
    virtual BuildPatchServices::IBuildStatisticsRef CreateBuildStatistics(const IBuildInstallerRef& Installer) const override;
    virtual BuildPatchServices::IPatchDataEnumerationRef CreatePatchDataEnumeration(BuildPatchServices::FPatchDataEnumerationConfiguration Configuration) const override;
    virtual IBuildManifestPtr LoadManifestFromFile(const FString& Filename) override;
    virtual IBuildManifestPtr MakeManifestFromData(const TArray<uint8>& ManifestData) override;
    virtual bool SaveManifestToFile(const FString& Filename, IBuildManifestRef Manifest) override;
    virtual TSet<FString> GetInstalledPrereqIds() const override;
    virtual const TArray<IBuildInstallerRef>& GetInstallers() const override;
    virtual void SetStagingDirectory(const FString& StagingDir) override;
    virtual void SetCloudDirectory(FString CloudDir) override;
    virtual void SetCloudDirectories(TArray<FString> CloudDirs) override;
    virtual void SetBackupDirectory(const FString& BackupDir) override;
    virtual void SetAnalyticsProvider(TSharedPtr< IAnalyticsProvider > AnalyticsProvider) override;
    virtual void RegisterAppInstallation(IBuildManifestRef AppManifest, const FString AppInstallDirectory) override;
    virtual bool UnregisterAppInstallation(const FString AppInstallDirectory) override;
    virtual void CancelAllInstallers(bool WaitForThreads) override;
    virtual bool ChunkBuildDirectory(const BuildPatchServices::FChunkBuildConfiguration& Configuration) override;
    virtual bool OptimiseChunkDelta(const BuildPatchServices::FChunkDeltaOptimiserConfiguration& Configuration) override;
    virtual bool CompactifyCloudDirectory(const BuildPatchServices::FCompactifyConfiguration& Configuration) override;
    virtual bool EnumeratePatchData(const BuildPatchServices::FPatchDataEnumerationConfiguration& Configuration) override;
    virtual bool VerifyChunkData(const FString& SearchPath, const FString& OutputFile) override;
    virtual bool PackageChunkData(const BuildPatchServices::FPackageChunksConfiguration& Configuration) override;
    virtual bool MergeManifests(const FString& ManifestFilePathA, const FString& ManifestFilePathB, const FString& ManifestFilePathC, const FString& NewVersionString, const FString& SelectionDetailFilePath) override;
    virtual bool DiffManifests(const BuildPatchServices::FDiffManifestsConfiguration& Configuration) override;
    virtual FSimpleEvent& OnStartBuildInstall() override;
    virtual IBuildManifestPtr MakeManifestFromJSON(const FString& ManifestJSON) override;
    // IBuildPatchServicesModule interface end.
 
    static const FString& GetStagingDirectory();
 
    static FString GetCloudDirectory(int32 CloudIdx = 0);
 
    static TArray<FString> GetCloudDirectories();
 
    static const FString& GetBackupDirectory();
 
private:
    bool Tick(float Delta);
 
    void PreExit();
 
    void FixupLegacyConfig();
 
    void NormalizeCloudPaths(TArray<FString>& InOutCloudPaths);
 
private:
    // The analytics provider interface
    static TSharedPtr<IAnalyticsProvider> Analytics;
 
    // Holds the cloud directories where chunks should belong
    static TArray<FString> CloudDirectories;
 
    // Holds the staging directory where we can perform any temporary work
    static FString StagingDirectory;
 
    // Holds the backup directory where we can move files that will be clobbered by repair or patch
    static FString BackupDirectory;
 
    // Holds the filename for local machine config. This is instead of shipped or user config, to track machine installation config.
    FString LocalMachineConfigFile;
 
    // A flag specifying whether prerequisites install should be skipped
    bool bForceSkipPrereqs;
 
    // Array of running installers
    TArray<FBuildPatchInstallerRef> BuildPatchInstallers;
 
    // Array of running installers as exposable interface refs
    TArray<IBuildInstallerRef> BuildPatchInstallerInterfaces;
 
    // Holds available installations used for recycling install data
    TMultiMap<FString, FBuildPatchAppManifestRef> AvailableInstallations;
 
    // Handle to the registered Tick delegate
    FTSTicker::FDelegateHandle TickDelegateHandle;
 
    // Delegate to give to installers so we know when they have been started.
    FBuildPatchInstallerDelegate InstallerStartDelegate;
 
    // Event broadcast upon a new build install
    FSimpleEvent OnStartBuildInstallEvent;
};
PRAGMA_ENABLE_DEPRECATION_WARNINGS