LootLockerConfig.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once

 
#include "Runtime/Launch/Resources/Version.h"
#if ENGINE_MAJOR_VERSION >= 5
#include <regex>
#endif
#include "CoreMinimal.h"
#include "Logging/LogVerbosity.h"
#include "LootLockerLogLevel.h"
#include "LootLockerFileConfig.h"
 
#include "LootLockerConfig.generated.h"

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FLootLockerConfigurationUpdateDelegate, const FString&, SettingName);

UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerMultiUserSessionMode : uint8
{
    NotSet          UMETA(Hidden),

    Hotseat         UMETA(DisplayName = "Hotseat"),

    SingleSession   UMETA(DisplayName = "Single Session"),

    ProfileSwitching UMETA(DisplayName = "Profile Switching"),
};
 
UCLASS(Config = Game, DefaultConfig, meta = (DisplayName = "LootLocker SDK Settings"))
class LOOTLOCKERSDK_API ULootLockerConfig : public UObject
{
    GENERATED_BODY()
public:
 
    UFUNCTION()
    static bool IsSemverString(const FString& str)
    {
#if ENGINE_MAJOR_VERSION >= 5
        return std::regex_match(TCHAR_TO_UTF8(*str), SemverPattern);
#else
        return true;
#endif
    }
    
    FLootLockerConfigurationUpdateDelegate OnConfigurationUpdated;

    static bool IsFileConfigActive();

    static TOptional<FLootLockerFileConfig> ParseFileConfigContent(const FString& Content);

#if ENGINE_MAJOR_VERSION >= 5
    inline static const FString PreConfigFileName = TEXT("LootLockerPreConfig.bytes");
#else
    static const FString PreConfigFileName;
#endif
 
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override
    {
        if (PropertyChangedEvent.GetPropertyName() == "GameVersion")
        {
            IsValidGameVersion = IsSemverString(GameVersion);
        }
        if (PropertyChangedEvent.GetPropertyName() == "bEnableFileLogging" || PropertyChangedEvent.GetPropertyName() == "LogFileName")
        {
            if (bEnableFileLogging)
            {
                EnableFileLogging(LogFileName.IsEmpty() ? "LootLockerLog" : LogFileName);
            }
            else
            {
                DisableFileLogging();
            }
        }
        OnConfigurationUpdated.Broadcast(PropertyChangedEvent.GetPropertyName().ToString());
        UObject::PostEditChangeProperty(PropertyChangedEvent);
    }
#endif //WITH_EDITOR
    virtual void PostInitProperties() override
    {
        IsValidGameVersion = IsSemverString(GameVersion);
        MigrateSettingsIfNeeded();
        LoadFileConfig();
        ApplyFileConfigIfPresent();
        // File logging is already handled by ApplyFileConfigIfPresent
        // when a file config is active. So skip it when file config is active.
        if (!bIsFileConfigLocked)
        {
            if(bEnableFileLogging)
            {
                EnableFileLogging(LogFileName.IsEmpty() ? "LootLockerLog" : LogFileName);
            }
            else
            {
                DisableFileLogging();
            }
        }
        UObject::PostInitProperties();
    }
 
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLocker", Meta = (EditCondition = "IsOutdatedSDK", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "WARNING:"), Transient)
    FString OutdatedSDKWarning = "This version of LootLocker is no longer updated through fab because of fab guidelines. Please use GitHub releases to update: https://github.com/lootlocker/unreal-sdk/releases";
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLocker", Meta = (EditCondition = "bIsFileConfigLocked", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "INFO:"), Transient)
    FString FileConfigActiveNotice = "Settings are governed by the pre-configured file config shipped with the plugin and cannot be changed from the editor.";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker", Meta = (DisplayName = "LootLocker API Key", EditCondition = "!bIsFileConfigLocked"))
    FString LootLockerGameKey = "";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker", Meta = (EditCondition = "!bIsFileConfigLocked"))
    FString GameVersion = "";
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLocker", Meta = (EditCondition = "!IsValidGameVersion", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "WARNING:"), Transient)
    FString InvalidGameVersionWarning = "Game version needs to follow a numeric Semantic Versioning pattern: X.Y.Z.B with the sections denoting MAJOR.MINOR.PATCH.BUILD and the last two being optional. Read more at https://docs.lootlocker.com/the-basics/core-concepts/glossary#game-version";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker", Meta = (EditCondition = "!bIsFileConfigLocked"))
    bool AllowTokenRefresh = true;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker", Meta = (EditCondition = "!bIsFileConfigLocked"))
    FString DomainKey = "";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker", Meta = (DisplayName = "Use Legacy HTTP Stack", EditCondition = "!bIsFileConfigLocked"))
    bool bUseLegacyHTTPStack = false;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Logging", Meta = (EditCondition = "!bIsFileConfigLocked"))
    bool LogOutsideOfEditor = false;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Logging", Meta = (DisplayName = "LootLocker Log Level", EditCondition = "!bIsFileConfigLocked"))
    ELootLockerLogLevel LootLockerLogLevel = ELootLockerLogLevel::Warning;
 
    UFUNCTION()
    static bool ShouldLog()
    {
#if WITH_EDITOR
        return true;
#else
        return GetDefault<ULootLockerConfig>()->LogOutsideOfEditor;
#endif
    }
 
    // Returns the configured log level from config or ini
    static ELootLockerLogLevel GetConfiguredLogLevel()
    {
        return GetDefault<ULootLockerConfig>()->LootLockerLogLevel;
    }

    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static void SetRuntimeLogLevel(ELootLockerLogLevel NewLevel);
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static ELootLockerLogLevel GetRuntimeLogLevel();
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static void EnableFileLogging(const FString& FileName);
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static void DisableFileLogging();
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static bool IsFileLoggingEnabled();
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static FString GetLogFilePath();
 
    // ========================================================================
    // PRESENCE CONFIGURATION ACCESSORS
    // ========================================================================

    UFUNCTION(BlueprintCallable, Category = "LootLocker|Presence")
    static bool IsPresenceEnabled();

    UFUNCTION(BlueprintCallable, Category = "LootLocker|Presence")
    static bool IsPresenceAutoConnectEnabled();

    UFUNCTION(BlueprintCallable, Category = "LootLocker|Presence")
    static bool IsPresenceAutoDisconnectOnFocusChangeEnabled();

    UFUNCTION(BlueprintCallable, Category = "LootLocker|Presence")
    static bool IsPresenceEnabledInEditor();
 
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Logging", Meta = (DisplayName = "Enable File Logging", EditCondition = "!bIsFileConfigLocked"))
    bool bEnableFileLogging = false;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Logging", Meta = (DisplayName = "Name of LootLocker Log File", EditCondition = "bEnableFileLogging && !bIsFileConfigLocked", EditConditionHides))
    FString LogFileName = TEXT("LootLockerLog");
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLocker|Logging", Meta = (EditCondition = "bEnableFileLogging", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "Actual Log File (on current device)"), Transient)
    FString LongLogFilePath = "";
 
    // ========================================================================
    // PRESENCE CONFIGURATION
    // ========================================================================
    
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Presence", Meta = (DisplayName = "Enable Presence System", EditCondition = "!bIsFileConfigLocked"))
    bool bEnablePresence = false;

    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Presence", Meta = (DisplayName = "Auto-Connect on Session Start", EditCondition = "bEnablePresence && !bIsFileConfigLocked", EditConditionHides))
    bool bEnablePresenceAutoConnect = true;

    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Presence", Meta = (DisplayName = "Auto-Disconnect on Focus Loss", EditCondition = "bEnablePresence && !bIsFileConfigLocked", EditConditionHides))
    bool bEnablePresenceAutoDisconnectOnFocusChange = true;

    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Presence", Meta = (DisplayName = "Enable In Editor", EditCondition = "bEnablePresence && !bIsFileConfigLocked", EditConditionHides))
    bool bEnablePresenceInEditor = true;
 
    // ========================================================================
    // MULTI USER CONFIGURATION
    // ========================================================================

    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLocker|Multi User", Meta = (DisplayName = "Multi User Session Mode", EditCondition = "!bIsFileConfigLocked"))
    ELootLockerMultiUserSessionMode MultiUserSessionMode = ELootLockerMultiUserSessionMode::NotSet;
private:
    FString LogFilePath = "";
    UPROPERTY(Config, VisibleInstanceOnly, Meta = (EditCondition = "false", EditConditionHides), Transient, Category = "LootLocker")
    bool IsValidGameVersion = true;
    UPROPERTY(Config, VisibleInstanceOnly, Meta = (EditCondition = "false", EditConditionHides), Transient, Category = "LootLocker")
    bool bIsFileConfigLocked = false;
#if ENGINE_MAJOR_VERSION >= 5
    inline static bool bFileConfigChecked = false;
    inline static TOptional<FLootLockerFileConfig> FileConfig;
#else
    static bool bFileConfigChecked;
    static TOptional<FLootLockerFileConfig> FileConfig;
#endif
    UPROPERTY(Config, VisibleInstanceOnly, Meta = (EditCondition = "false", EditConditionHides), Transient, Category = "LootLocker")
    bool IsOutdatedSDK 
#ifdef LOOTLOCKER_SHOW_OUTDATED_SDK_MESSAGE
        = true
#else
        = false
#endif
    ;
#if ENGINE_MAJOR_VERSION >= 5
    inline static const std::regex SemverPattern = std::regex("^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:\\.(0|[1-9]\\d*))?(?:\\.(0|[1-9]\\d*))?$" );
#endif

    void MigrateSettingsIfNeeded();
 
    static void LoadFileConfig();
    void ApplyFileConfigIfPresent();
};