CrashUpload.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Interfaces/IHttpRequest.h"
#include "Internationalization/Text.h"
#include "PlatformErrorReport.h"
#include "ProfilingDebugging/ScopedTimers.h"
#include "Templates/SharedPointer.h"
 
struct FCompressedData;
struct FCompressedHeader;
 
class FCrashUploadBase
{
public:
    FCrashUploadBase();
 
    virtual ~FCrashUploadBase();
 
    bool IsEnabled() const { return State != EUploadState::Disabled; }
 
    bool IsUploadCalled() const { return bUploadCalled; }
 
    const FText& GetStatusText() const { return UploadStateText; }
 
    bool IsFinished() const
    {
        return State >= EUploadState::FirstCompletedState;
    }
 
    bool IsFinishedSuccessfully() const
    {
        return State == EUploadState::Finished;
    }
 
    void Cancel()
    {
        SetCurrentState(EUploadState::Cancelled);
    }
 
    static bool IsInitialized() { return bInitialized; }
 
    static void StaticInitialize(const FPlatformErrorReport& PlatformErrorReport);
 
    static void StaticShutdown();
 
protected:
    struct EUploadState
    {
        enum Type
        {
            NotSet,
 
            PingingServer,
            Ready,
            CheckingReport,
            CheckingReportDetail,
            CompressAndSendData,
            WaitingToPostReportComplete,
            PostingReportComplete,
            Finished,
 
            ServerNotAvailable,
            UploadError,
            Cancelled,
            Disabled,
 
            FirstCompletedState = Finished,
        };
    };
 
    static bool CompressData(const TArray<FString>& InPendingFiles, struct FCompressedData& OutCompressedData, TArray<uint8>& OutPostData, struct FCompressedHeader* OptionalHeader = nullptr);
 
    static const TCHAR* ToString(EUploadState::Type InState);
 
    void SetCurrentState(EUploadState::Type InState);
 
    void AddReportToFailedList() const;
 
    void CleanCrashReportDirectory(const FString& CrashReportDirectory);
 
protected:
    bool bUploadCalled;
 
    EUploadState::Type State;
 
    FText UploadStateText;
 
    EUploadState::Type PauseState;
 
    TArray<FString> PendingFiles;
 
    FPlatformErrorReport ErrorReport;
 
    TArray<uint8> PostData;
 
    int32 PendingReportDirectoryIndex;
 
protected:
    static bool bInitialized;
 
    static TArray<FString> PendingReportDirectories;
 
    static TArray<FString> FailedReportDirectories;
};
 
 
class FCrashUploadToReceiver : public FCrashUploadBase
{
public:
    explicit FCrashUploadToReceiver(const FString& InReceiverAddress);
 
    virtual ~FCrashUploadToReceiver();
 
    void BeginUpload(const FPlatformErrorReport& PlatformErrorReport);
 
private:
    bool SendCheckReportRequest();
 
    void CompressAndSendData();
 
    void AssignReportIdToPostDataBuffer();
 
    void PostReportComplete();
 
    void OnProcessRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded);
 
    void OnPingSuccess();
 
    bool PingTimeout(float DeltaTime);
 
    void CheckPendingReportsForFilesToUpload();
 
    void BeginUploadImpl();
 
    TSharedRef<IHttpRequest, ESPMode::ThreadSafe> CreateHttpRequest();
 
    void SendPingRequest();
 
    static bool ParseServerResponse(FHttpResponsePtr Response, bool& OutValidReport);
 
    FString UrlPrefix;
};
 
class FCrashUploadToDataRouter : public FCrashUploadBase
{
public:
    explicit FCrashUploadToDataRouter(const FString& InDataRouterUrl, const FString& InOptionalDataRouterUnixSocket);
 
    virtual ~FCrashUploadToDataRouter();
 
    void BeginUpload(const FPlatformErrorReport& PlatformErrorReport);
 
    void BeginUploadOptionalAttachments(const FPlatformErrorReport& PlatformErrorReport);
 
    void CompressAndSendData();
 
    TSharedRef<IHttpRequest, ESPMode::ThreadSafe> CreateHttpRequest();
 
    void OnProcessRequestComplete(FHttpRequestPtr HttpRequest, FHttpResponsePtr HttpResponse, bool bSucceeded);
 
private:
    void CheckPendingReportsForFilesToUpload();
 
private:
    FString DataRouterUrl;
 
    FString DataRouterUnixSocket;
 
    bool bResult = false;
    
    int32 ResponseCode = 0;
 
    uint32 PayloadSize = 0;
 
    uint32 ReportCount = 0;
 
    double Duration = 0.0;
 
    FDurationTimer Timer;
};