LootLockerServerConfig.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "Runtime/Launch/Resources/Version.h"
#if ENGINE_MAJOR_VERSION >= 5
#include <regex>
#endif
#include "LootLockerServerLogger.h"
#include "LootLockerServerFileConfig.h"
#include "LootLockerServerConfig.generated.h"
 
UCLASS(Config = Game, DefaultConfig, meta = (DisplayName = "LootLocker Server SDK Settings"))
class LOOTLOCKERSERVERSDK_API ULootLockerServerConfig : public UObject
{
    GENERATED_BODY()
public:
    static bool IsFileConfigActive();
 
    static TOptional<FLootLockerServerFileConfig> ParseFileConfigContent(const FString& Content);
 
#if ENGINE_MAJOR_VERSION >= 5
    inline static const FString PreConfigFileName = TEXT("LootLockerServerPreConfig.bytes");
#else
    static const FString PreConfigFileName;
#endif
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLockerServer", 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 = "LootLockerServer", Meta = (EditCondition = "!bIsFileConfigLocked"))
    FString LootLockerServerKey = "";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer", Meta = (EditCondition = "!bIsFileConfigLocked"))
    FString LootLockerDomainKey = "";
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLockerServer", Meta = (EditCondition = "IsLegacyKey", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "WARNING:"), Transient)
    FString LegacyKeyWarning = "You are using a legacy API Key, please generate a new one here: https://console.lootlocker.com/settings/api-keys";
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLockerServer", Meta = (EditCondition = "!IsValidGameVersion", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "WARNING:"), Transient)
    FString InvalidGameVersionWarning = "";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer", Meta = (EditCondition = "!bIsFileConfigLocked"))
    FString GameVersion = "";
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Meta = (EditCondition = "false", EditConditionHides), Category = "LootLockerServer")
    FString LootLockerVersion = "2021-06-01";
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer|Logging", Meta = (EditCondition = "!bIsFileConfigLocked"))
    ELootLockerServerLogLevel LimitLogLevelTo = ELootLockerServerLogLevel::Warning;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer|Logging", Meta = (EditCondition = "!bIsFileConfigLocked"))
    bool LogOutsideOfEditor = false;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer|Logging", Meta = (EditCondition = "!bIsFileConfigLocked"))
    bool bEnableFileLogging = false;
    UPROPERTY(Config, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer|Logging", Meta = (EditCondition = "bEnableFileLogging && !bIsFileConfigLocked", EditConditionHides))
    FString LogFileName = TEXT("LootLockerServerLog");
    UPROPERTY(Config, VisibleAnywhere, BlueprintReadOnly, Category = "LootLockerServer|Logging", Meta = (EditCondition = "bEnableFileLogging", EditConditionHides), Meta = (MultiLine = true), Meta = (DisplayName = "Actual Log File (on current device)"), Transient)
    FString LongLogFilePath = "";
private:
    FString LogFilePath = "";
public:
    // Logging API
    static ELootLockerServerLogLevel GetConfiguredLogLevel()
    {
        return GetDefault<ULootLockerServerConfig>()->LimitLogLevelTo;
    }
 
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static void SetRuntimeLogLevel(ELootLockerServerLogLevel NewLevel);
 
    UFUNCTION(BlueprintCallable, Category = "LootLocker|Logging")
    static ELootLockerServerLogLevel 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();
    
private:
    
    UFUNCTION()
    bool IsLegacyAPIKey() const
    {
        return LootLockerServerKey.Find("dev_", ESearchCase::CaseSensitive) == -1 && LootLockerServerKey.Find("prod_", ESearchCase::CaseSensitive) == -1;
    }
 
    UFUNCTION()
    static bool ShouldLog()
    {
#if WITH_EDITOR
        return true;
#else
        return GetDefault<ULootLockerServerConfig>()->LogOutsideOfEditor;
#endif      
    }
 
    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
    }
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override
    {
        if (PropertyChangedEvent.GetPropertyName() == "LootLockerServerKey")
        {
            IsLegacyKey = IsLegacyAPIKey();
        }
        if (PropertyChangedEvent.GetPropertyName() == "GameVersion")
        {
            IsValidGameVersion = IsSemverString(GameVersion);
        }
        if (PropertyChangedEvent.GetPropertyName() == "bEnableFileLogging" || PropertyChangedEvent.GetPropertyName() == "LogFileName")
        {
            if (bEnableFileLogging)
            {
                EnableFileLogging(LogFileName.IsEmpty() ? "LootLockerServerLog" : LogFileName);
            }
            else
            {
                DisableFileLogging();
            }
        }
        UObject::PostEditChangeProperty(PropertyChangedEvent);
    }
#endif //WITH_EDITOR
    virtual void PostInitProperties() override
    {
        IsLegacyKey = IsLegacyAPIKey();
        IsValidGameVersion = IsSemverString(GameVersion);
        LoadFileConfig();
        ApplyFileConfigIfPresent();
        // File logging is already handled by ApplyFileConfigIfPresent
        // when a file config is active. Only apply the default behavior
        // when no file config is governing the setting.
        if (!bIsFileConfigLocked)
        {
            if(bEnableFileLogging)
            {
                EnableFileLogging(LogFileName.IsEmpty() ? "LootLockerServerLog" : LogFileName);
            }
            else
            {
                DisableFileLogging();
            }
        }
        UObject::PostInitProperties();
    }
private:
    UPROPERTY(Config, VisibleInstanceOnly, Meta = (EditCondition = "false", EditConditionHides), Transient, Category = "LootLockerServer")
    bool IsLegacyKey = false;
    UPROPERTY(Config, VisibleInstanceOnly, Meta = (EditCondition = "false", EditConditionHides), Transient, Category = "LootLockerServer")
    bool IsValidGameVersion = true;
    UPROPERTY(Config, VisibleInstanceOnly, Meta = (EditCondition = "false", EditConditionHides), Transient, Category = "LootLockerServer")
    bool bIsFileConfigLocked = false;
#if ENGINE_MAJOR_VERSION >= 5
    inline static bool bFileConfigChecked = false;
    inline static TOptional<FLootLockerServerFileConfig> FileConfig;
#else
    static bool bFileConfigChecked;
    static TOptional<FLootLockerServerFileConfig> FileConfig;
#endif
    static void LoadFileConfig();
    void ApplyFileConfigIfPresent();
#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
};