LootLockerRemoteSessionRequestHandler.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "LootLockerAuthenticationRequestHandler.h"
#include "LootLockerResponse.h"
#include "TimerManager.h"
#include "Kismet/BlueprintAsyncActionBase.h"
#include "LootLockerSDK/Private/Utils/LootLockerUtilities.h"
#include "GameAPI/LootLockerConnectedAccountsRequestHandler.h"
#include "LootLockerRemoteSessionRequestHandler.generated.h"
 
class UTexture2D;
 
//==================================================
// Data Type Definitions
//==================================================
UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerRemoteSessionLeaseStatus : uint8
{
    Created = 0,
    Claimed = 1,
    Verified = 2,
    Authorized = 3,
    Cancelled = 4,
    Timed_out = 5,
    Failed = 6
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerRemoteSessionLeaseIntent : uint8
{
    login = 0,
    link = 1
};


USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerRemoteSessionPlayerData
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_name = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 player_id = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString public_uid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_ulid = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool seen_before = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool check_grant_notifications = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool check_deactivation_notifications = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 xp = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 level = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerLevelThresholds level_thresholds;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 account_balance = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_identifier = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString player_created_at = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString wallet_id = "";
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerRemoteSessionLeaseData
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Code = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Nonce = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Redirect_url = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Redirect_url_qr_base64 = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    UTexture2D* Redirect_url_qr_texture = nullptr;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Display_url = "";
};
 
//==================================================
// Request Definitions
//==================================================

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerLeaseRemoteSessionRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Title_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Environment_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Game_version = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FString> Providers;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerStartRemoteSessionRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Game_api_key = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Game_version = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Lease_code = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Nonce = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerRefreshRemoteSessionRequest : public FLootLockerBaseAuthRequest
{
    GENERATED_BODY()
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "LootLocker")
    FString refresh_token = "";
};
 
//==================================================
// Response Definitions
//==================================================

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerLeaseRemoteSessionResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Code = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Nonce = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Redirect_url = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Redirect_url_qr_base64 = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Display_url = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerRemoteSessionLeaseStatus Status = ELootLockerRemoteSessionLeaseStatus::Created;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerRemoteSessionLeaseIntent Intent = ELootLockerRemoteSessionLeaseIntent::login;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerRemoteSessionStatusPollingResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerRemoteSessionLeaseStatus Lease_status = ELootLockerRemoteSessionLeaseStatus::Created;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerStartRemoteSessionResponse : public FLootLockerAuthenticationResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerRemoteSessionLeaseStatus Lease_Status = ELootLockerRemoteSessionLeaseStatus::Created;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Refresh_token = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerRemoteSessionLeaseIntent Intent = ELootLockerRemoteSessionLeaseIntent::login;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerRefreshRemoteSessionResponse : public FLootLockerAuthenticationResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Refresh_token = "";
};
 
//==================================================
// Delegate Definitions
//==================================================


DECLARE_DELEGATE_OneParam(FLootLockerLeaseRemoteSessionResponseDelegate, FLootLockerLeaseRemoteSessionResponse);
DECLARE_DELEGATE_OneParam(FLootLockerRemoteSessionStatusPollingResponseDelegate, FLootLockerRemoteSessionStatusPollingResponse);
DECLARE_DELEGATE_OneParam(FLootLockerStartRemoteSessionResponseDelegate, FLootLockerStartRemoteSessionResponse);
DECLARE_DELEGATE_OneParam(FLootLockerRefreshRemoteSessionResponseDelegate, FLootLockerRefreshRemoteSessionResponse);
 
 
//==================================================
// API Class Definition
//==================================================
 
struct FLootLockerRemoteSessionProcess
{
    static constexpr int RetryLimit = 5;
    FString LeaseCode = "";
    FString LeaseNonce = "";
    ELootLockerRemoteSessionLeaseStatus LastUpdatedStatus = ELootLockerRemoteSessionLeaseStatus::Failed;
    FDateTime LeasingProcessTimeoutTime;
    float PollingIntervalSeconds = 1.0f;
    FDateTime LastUpdatedAt;
    int Retries = 0;
    bool ShouldCancel = false;
    FTimerHandle RemoteSessionProcessTimerHandle;
 
    FLootLockerRemoteSessionProcess(float _PollingIntervalSeconds, float timeOutAfterMinutes);
};

UCLASS()
class LOOTLOCKERSDK_API ULootLockerRemoteSessionRequestHandler : public UObject
{
    GENERATED_BODY()
public:
    ULootLockerRemoteSessionRequestHandler() {};
 
    static void CancelRemoteSessionProcess(const FString& ProcessID);
    static FString StartRemoteSession(
        ELootLockerRemoteSessionLeaseIntent Intent = ELootLockerRemoteSessionLeaseIntent::login,
        const FLootLockerLeaseRemoteSessionResponseDelegate& RemoteSessionLeaseInformation = FLootLockerLeaseRemoteSessionResponseDelegate(),
        const FLootLockerRemoteSessionStatusPollingResponseDelegate& RemoteSessionLeaseStatusUpdate = FLootLockerRemoteSessionStatusPollingResponseDelegate(),
        const FLootLockerStartRemoteSessionResponseDelegate& OnComplete = FLootLockerStartRemoteSessionResponseDelegate(),
        float PollingIntervalSeconds = 1.0f,
        float TimeOutAfterMinutes = 5.0f,
        const FString& ForPlayerWithUlid = "",
        ELootLockerAccountProvider Provider = ELootLockerAccountProvider::Guest);
    static FString RefreshRemoteSession(const FString& RefreshToken, const FLootLockerRefreshRemoteSessionResponseDelegate& OnComplete);
    static FString ContinualPollingAction(const FString& ProcessID,
        const FLootLockerRemoteSessionStatusPollingResponseDelegate& RemoteSessionLeaseStatusUpdate = FLootLockerRemoteSessionStatusPollingResponseDelegate(),
        const FLootLockerStartRemoteSessionResponseDelegate& OnComplete = FLootLockerStartRemoteSessionResponseDelegate());
    static void KillProcess(const FString& ProcessID);
 
protected:
    static FString LeaseRemoteSession(
        const FString& TitleId,
        const FString& EnvironmentId,
        ELootLockerRemoteSessionLeaseIntent Intent,
        const FString& ForPlayerWithUlid,
        const LLAPI<FLootLockerLeaseRemoteSessionResponse>::FResponseInspectorCallback& OnCompleteCallback,
        ELootLockerAccountProvider Provider = ELootLockerAccountProvider::Guest);
    static FString StartRemoteSession(const FString& LeaseCode, const FString& LeaseNonce, const LLAPI<FLootLockerStartRemoteSessionResponse>::FResponseInspectorCallback& OnCompleteCallback);
    static void SetTimer(FTimerHandle TimerHandle, const FTimerDelegate& BaseDelegate, float TimeToNextPoll);
    static void ClearTimer(FTimerHandle TimerHandle);
private:
    
    static TMap<FString, FLootLockerRemoteSessionProcess> RemoteSessionProcesses;
};
 
//==================================================
// Async Blueprint Delegate Definitions
//==================================================

DECLARE_DYNAMIC_MULTICAST_DELEGATE_SevenParams(FLootLockerAsyncRemoteSessionMulticastDelegate, FString, LeaseProcessID, FLootLockerRemoteSessionLeaseData, LeaseData, bool, HasPlayerData, FString, SessionTokenOnSuccess, FString, RefreshTokenOnSuccess, FLootLockerRemoteSessionPlayerData, PlayerDataOnSuccess, FLootLockerResponse, ResponseOnFailure);
 
//==================================================
// Async Blueprint Node Definitions
//==================================================
 
/***/
UCLASS()
class ULootLockerAsyncStartRemoteSession : public UBlueprintAsyncActionBase
{
    GENERATED_BODY()
public:
    UFUNCTION(BlueprintCallable, meta = (BlueprintInternalUseOnly = "true", Category = "LootLocker Methods | Remote Session", WorldContext = "WorldContextObject", AdvancedDisplay = "PollingIntervalSeconds,TimeOutAfterMinutes,ForPlayerWithUlid,Provider", PollingIntervalSeconds = 1.0f, TimeOutAfterMinutes = 5.0f, ForPlayerWithUlid = ""))
    static LOOTLOCKERSDK_API ULootLockerAsyncStartRemoteSession* AsyncStartRemoteSession(UObject* WorldContextObjectfloat, float PollingIntervalSeconds, float TimeOutAfterMinutes, ELootLockerAccountProvider Provider = ELootLockerAccountProvider::Guest);

    UFUNCTION(BlueprintCallable, meta = (BlueprintInternalUseOnly = "true", Category = "LootLocker Methods | Remote Session", WorldContext = "WorldContextObject", AdvancedDisplay = "PollingIntervalSeconds,TimeOutAfterMinutes,ForPlayerWithUlid,Provider", PollingIntervalSeconds = 1.0f, TimeOutAfterMinutes = 5.0f, ForPlayerWithUlid = ""))
    static LOOTLOCKERSDK_API ULootLockerAsyncStartRemoteSession* AsyncStartRemoteSessionForLinking(UObject* WorldContextObject, FString ForPlayerWithUlid, float PollingIntervalSeconds, float TimeOutAfterMinutes, ELootLockerAccountProvider Provider = ELootLockerAccountProvider::Guest);
 

    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnProcessStarted;
    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnLeaseClaimed;
    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnLeaseVerified;
    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnProcessCancelled;
    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnProcessTimedOut;
    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnProcessFailed;
    UPROPERTY(BlueprintAssignable)
    FLootLockerAsyncRemoteSessionMulticastDelegate OnProcessFinished;

    LOOTLOCKERSDK_API virtual void Activate() override;
 
protected:
    FString ForPlayerWithUlid = "";
    ELootLockerRemoteSessionLeaseIntent Intent = ELootLockerRemoteSessionLeaseIntent::login;
    ELootLockerAccountProvider Provider = ELootLockerAccountProvider::Guest;
    FString LeaseProcessID = "";
    float PollingIntervalInSeconds = 0.0f;
    float TimeoutAfterMinutes = 0.0f;
    UPROPERTY()
    FLootLockerRemoteSessionLeaseData LeaseData;
 
    UFUNCTION()
    LOOTLOCKERSDK_API virtual void HandleLeaseProcessStarted(const FLootLockerLeaseRemoteSessionResponse& LeaseProcessStartedResponse);
    UFUNCTION()
    LOOTLOCKERSDK_API virtual void HandleLeaseProcessUpdate(const FLootLockerRemoteSessionStatusPollingResponse& LeaseProcessUpdateResponse);
    UFUNCTION()
    LOOTLOCKERSDK_API virtual void HandleLeaseProcessCompleted(const FLootLockerStartRemoteSessionResponse& LeaseProcessCompletedResponse);
};