BuildPatchInstaller.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    BuildPatchInstaller.h: Declares the FBuildPatchInstaller class which
    controls the process of installing a build described by a build manifest.
=============================================================================*/
 
#pragma once
 
#include "HAL/Runnable.h"
#include "HAL/ThreadSafeBool.h"
#include "Templates/SharedPointer.h"
#include "CoreMinimal.h"
 
#include "Interfaces/IBuildInstaller.h"
#include "Interfaces/IBuildPatchServicesModule.h"
#include "BuildPatchSettings.h"
 
#include "Common/HttpManager.h"
#include "Core/AsyncHelpers.h"
#include "Core/Platform.h"
#include "Core/ProcessTimer.h"
#include "BuildPatchManifest.h"
#include "BuildPatchProgress.h"
#include "IBuildManifestSet.h"
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
 
namespace BuildPatchServices
{
    struct FChunkDbSourceConfig;
    struct FCloudSourceConfig;
    struct FDownloadConnectionCountConfig;
    struct FInstallSourceConfig;
    class IInstallerError;
    class IFileOperationTracker;
    class IMemoryChunkStoreStatistics;
    class IDiskChunkStoreStatistics;
    class ISpeedRecorder;
    class IChunkDataSizeProvider;
    class IDownloadServiceStatistics;
    class IChunkDbChunkSourceStatistics;
    class ICloudChunkSourceStatistics;
    class IInstallChunkSourceStatistics;
    class IFileConstructorStatistics;
    class IVerifierStatistics;
    class IInstallerAnalytics;
    class IDownloadService;
    class IOptimisedDelta;
    class IMessagePump;
    class IVerifier;
    class IBuildManifestSet;
 
    class FBuildPatchInstaller
        : public IBuildInstaller
        , public FRunnable
        , public TSharedFromThis<FBuildPatchInstaller, ESPMode::ThreadSafe>
    {
    private:
        // Simple unique installer guid to help logging functions have context.
        FGuid SessionId;
 
        // Hold a pointer to my thread for easier deleting.
        IBuildInstallerThread* Thread;
 
        // The delegates that we will be calling when started.
        const FBuildPatchInstallerDelegate StartDelegate;
 
        // The delegates that we will be calling on complete.
        const FBuildPatchInstallerDelegate CompleteDelegate;
 
        // The installer configuration.
        FBuildInstallerConfiguration Configuration;
 
        // The Configuration.InstallerActions array converted into private class type.
        TArray<FBuildPatchInstallerAction> InstallerActions;
 
        // The directory created in staging, to store local patch data.
        FString DataStagingDir;
 
        // The directory created in staging to construct install files to.
        FString InstallStagingDir;
 
        // The directory created in staging to store any required meta, such as resume info.
        FString MetaStagingDir;
 
        // The filename used to mark a previous install that did not complete but moved staged files into the install directory.
        FString PreviousMoveMarker;
 
        // A critical section to protect variables.
        mutable FCriticalSection ThreadLock;
 
        // A flag storing whether the process was a success.
        FThreadSafeBool bSuccess;
 
        // A flag marking that we a running.
        FThreadSafeBool bIsRunning;
 
        // A flag marking that we initialized correctly.
        FThreadSafeBool bIsInited;
 
        // A flag that stores whether we are on the first install iteration.
        FThreadSafeBool bFirstInstallIteration;
 
        // Tracks required download data between install retries.
        FThreadSafeInt64 PreviousTotalDownloadRequired;
 
        // Keep track of build stats.
        FBuildInstallStats BuildStats;
 
        // Keep track of install progress.
        FBuildPatchProgress BuildProgress;
 
        // Whether we are currently paused.
        bool bIsPaused;
 
        // Whether we are needing to abort.
        bool bShouldAbort;
 
        // Holds a list of files that have been placed into the install directory.
        TArray<FString> FilesInstalled;
 
        // Holds the files which are all required.
        TSet<FString> TaggedFiles;
 
        // Holds the files which are outdated.
        TSet<FString> OutdatedFiles;
 
        // The files to be constructed in the current install attempt.
        TSet<FString> FilesToConstruct;
 
        // The files that were removed during installation due to destructive patch behavior.
        TSet<FString> OldFilesRemovedBySystem;
 
        // With bInstallToMemory, files end up here after construction.
        TMap<FString, TArray64<uint8>> FilesInstalledToMemory;
 
        // Map of registered installations.
        TMultiMap<FString, FBuildPatchAppManifestRef> InstallationInfo;
 
        // The file which contains per machine configuration information.
        FString LocalMachineConfigFile;
 
        // HTTP manager used to make requests for download data.
        TUniquePtr<IHttpManager> HttpManager;
 
        // File systems for classes requiring disk access.
        TUniquePtr<IFileSystem> FileSystem;
 
        // Platform abstraction.
        TUniquePtr<IPlatform> Platform;
 
        // Installer error tracking system.
        TUniquePtr<IInstallerError> InstallerError;
 
        // The analytics provider interface.
        TSharedPtr<IAnalyticsProvider> Analytics;
 
        // Installer analytics handler.
        TUniquePtr<IInstallerAnalytics> InstallerAnalytics;
 
        // Installer statistics tracking.
        TUniquePtr<IFileOperationTracker> FileOperationTracker;
        TUniquePtr<ISpeedRecorder> DownloadSpeedRecorder;
        TUniquePtr<ISpeedRecorder> DiskReadSpeedRecorder;
        TUniquePtr<ISpeedRecorder> DiskWriteSpeedRecorder;
        TUniquePtr<IChunkDataSizeProvider> ChunkDataSizeProvider;
        TUniquePtr<IDownloadServiceStatistics> DownloadServiceStatistics;
        TUniquePtr<IChunkDbChunkSourceStatistics> ChunkDbChunkSourceStatistics;
        TUniquePtr<IInstallChunkSourceStatistics> InstallChunkSourceStatistics;
        TUniquePtr<ICloudChunkSourceStatistics> CloudChunkSourceStatistics;
        TUniquePtr<IFileConstructorStatistics> FileConstructorStatistics;
        TUniquePtr<IVerifierStatistics> VerifierStatistics;
 
        // Download service.
        TUniquePtr<IDownloadService> DownloadService;
 
        // The message pump controller.
        TUniquePtr<IMessagePump> MessagePump;
 
        // The interface for manifest data aggregation.
        TUniquePtr<IBuildManifestSet> ManifestSet;
 
        // The interface for verification of files built.
        TUniquePtr<IVerifier> Verifier;
 
        // List of controllable classes that have been constructed.
        TArray<IControllable*> Controllables;
 
        // Stage timers for build stats.
        FProcessTimer InitializeTimer;
        FProcessTimer ConstructTimer;
        FProcessTimer MoveFromStageTimer;
        FProcessTimer FileAttributesTimer;
        FProcessTimer VerifyTimer;
        FProcessTimer CleanUpTimer;
        FProcessTimer PrereqTimer;
        FProcessTimer ProcessPausedTimer;
        FProcessTimer ProcessActiveTimer;
        FProcessTimer ProcessExecuteTimer;
 
        // Caches verification errors encountered each run.
        TMap<BuildPatchServices::EVerifyError, int32> CachedVerifyErrorCounts;
 
    public:
        FBuildPatchInstaller(FBuildInstallerConfiguration Configuration, TMultiMap<FString, FBuildPatchAppManifestRef> InstallationInfo, const FString& LocalMachineConfigFile, TSharedPtr<IAnalyticsProvider> Analytics, FBuildPatchInstallerDelegate StartDelegate, FBuildPatchInstallerDelegate CompleteDelegate);
 
        ~FBuildPatchInstaller();
 
        // FRunnable interface begin.
        uint32 Run() override;
        // FRunnable interface end.
 
        // IBuildInstaller interface begin.
        virtual bool StartInstallation() override;
        virtual bool IsComplete() const override;
        virtual bool IsCanceled() const override;
        virtual bool IsPaused() const override;
        virtual bool IsResumable() const override;
        virtual bool IsUpdate() const override;
        virtual bool CompletedSuccessfully() const override;
        virtual bool HasError() const override;
        virtual EBuildPatchInstallError GetErrorType() const override;
        virtual FString GetErrorCode() const override;
        //@todo this is deprecated and shouldn't be used anymore [6/4/2014 justin.sargent]
        virtual FText GetPercentageText() const override;
        //@todo this is deprecated and shouldn't be used anymore [6/4/2014 justin.sargent]
        virtual FText GetDownloadSpeedText() const override;
        virtual double GetDownloadSpeed() const override;
        virtual int64 GetTotalDownloadRequired() const override;
        virtual int64 GetTotalDownloaded() const override;
        virtual EBuildPatchState GetState() const override;
        virtual FText GetStatusText() const override;
        virtual float GetUpdateProgress() const override;
        virtual FBuildInstallStats GetBuildStatistics() const override;
        virtual EBuildPatchDownloadHealth GetDownloadHealth() const override;
        virtual FText GetErrorText() const override;
        virtual void CancelInstall() override;
        virtual bool TogglePauseInstall() override;
        virtual void RegisterMessageHandler(FMessageHandler* MessageHandler) override;
        virtual void UnregisterMessageHandler(FMessageHandler* MessageHandler) override;
        virtual const FBuildInstallerConfiguration& GetConfiguration() const override;
#if !UE_BUILD_SHIPPING
        virtual void GetDebugText(TArray<FString>& Output) override;
#endif
        virtual TMap<FString, TArray64<uint8>>& GetFilesInstalledToMemory() override;
        // IBuildInstaller interface end.
 
        bool Tick();
 
        void PreExit();
 
        const IFileOperationTracker* GetFileOperationTracker() const;
 
        const ISpeedRecorder* GetDownloadSpeedRecorder() const;
 
        const ISpeedRecorder* GetDiskReadSpeedRecorder() const;
 
        const ISpeedRecorder* GetDiskWriteSpeedRecorder() const;
 
        const IDownloadServiceStatistics* GetDownloadServiceStatistics() const;
 
        const IInstallChunkSourceStatistics* GetInstallChunkSourceStatistics() const;
 
        const ICloudChunkSourceStatistics* GetCloudChunkSourceStatistics() const;
 
        const IFileConstructorStatistics* GetFileConstructorStatistics() const;
 
        const IChunkDbChunkSourceStatistics* GetChunkDbChunkSourceStatistics() const;
 
        const IVerifierStatistics* GetVerifierStatistics() const;
 
 
    private:
 
        bool Initialize();
 
        void ExecuteCompleteDelegate();
 
        void PumpMessages();
 
        bool CheckForExternallyInstalledFiles(const TSet<FString>& FilesToCheck);
 
        bool RunInstallation(TArray<FString>& CorruptFiles);
 
        bool RunPrerequisites();
 
        bool RunBackupAndMove();
 
        bool RunFileAttributes();
 
        bool RunVerification(TArray<FString>& CorruptFiles);
 
        bool BackupFileIfNecessary(const FString& Filename, bool bDiscoveredByVerification = false);
 
        void CleanupEmptyDirectories(const FString& RootDirectory);
 
        void FilterToExistingFiles(const FString& RootDirectory, TSet<FString>& Files);
 
        bool RemoveFileWithRetries(const FString& FullFilename, uint32& ErrorCode);
 
        bool RelocateFileWithRetries(const FString& ToFullFilename, const FString& FromFullFilename, uint32& RenameErrorCode, uint32& CopyErrorCode);
 
        FDownloadConnectionCountConfig BuildConnectionCountConfig();
 
        void CleanupThread();
    };
}
 
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
typedef TSharedPtr< BuildPatchServices::FBuildPatchInstaller, ESPMode::ThreadSafe > FBuildPatchInstallerPtr;
typedef TSharedRef< BuildPatchServices::FBuildPatchInstaller, ESPMode::ThreadSafe > FBuildPatchInstallerRef;
typedef TWeakPtr< BuildPatchServices::FBuildPatchInstaller, ESPMode::ThreadSafe > FBuildPatchInstallerWeakPtr;