GenericPlatformHttp.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/Set.h"
#include "Containers/StringFwd.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "HAL/Platform.h"
#include "Misc/Optional.h"
 
class FHttpManager;
class IHttpRequest;
 
class FDefaultUserAgentBuilder
{
public:
    HTTP_API FDefaultUserAgentBuilder();
 
    // Build the user agent string. Passing a filter will limit the comments to only those allowed.
    // Passing nullptr for a filter implies that all comments are allowed.
    HTTP_API FString BuildUserAgentString(const TSet<FString>* AllowedProjectCommentsFilter = nullptr, const TSet<FString>* AllowedPlatformCommentsFilter = nullptr) const;
 
    HTTP_API void SetProjectName(const FString& InProjectName);
    HTTP_API void SetProjectVersion(const FString& InProjectVersion);
    HTTP_API void AddProjectComment(const FString& InComment);
    HTTP_API void SetPlatformName(const FString& InPlatformName);
    HTTP_API void SetPlatformVersion(const FString& InPlatformVersion);
    HTTP_API void AddPlatformComment(const FString& InComment);
 
    // Get the builder version. The version is used for tracking app changes to the default user
    // agent and is not included in the user agent string.
    HTTP_API uint32 GetAgentVersion() const;
 
private:
    static FString BuildCommentString(const TArray<FString>& Comments, const TSet<FString>* AllowedCommentsFilter);
 
    FString ProjectName;
    FString ProjectVersion;
    TArray<FString> ProjectComments;
    FString PlatformName;
    FString PlatformVersion;
    TArray<FString> PlatformComments;
    uint32 AgentVersion;
};
 
class FGenericPlatformHttp
{
public:
 
    static HTTP_API void Init();
 
    static FHttpManager* CreatePlatformHttpManager()
    {
        return nullptr;
    }
 
    static HTTP_API void Shutdown();
 
    static void ShutdownPlatformCustomSsl() {}
 
    static HTTP_API IHttpRequest* ConstructRequest();
 
    static HTTP_API FString UrlEncode(const FStringView UnencodedString);
 
    static HTTP_API FString UrlDecode(const FStringView EncodedString);
 
    static HTTP_API FString HtmlEncode(const FStringView UnencodedString);
 
    static HTTP_API FString GetUrlDomainAndPort(const FStringView Url);
 
    static HTTP_API FString GetUrlDomain(const FStringView Url);
 
    static HTTP_API FString GetUrlBase(const FStringView Url);
 
    static HTTP_API FString GetMimeType(const FString& FilePath);
 
    static HTTP_API FString GetDefaultUserAgent();
    static HTTP_API FString EscapeUserAgentString(const FString& UnescapedString);
 
    static HTTP_API void AddDefaultUserAgentProjectComment(const FString& Comment);
 
    static HTTP_API void AddDefaultUserAgentPlatformComment(const FString& Comment);
 
    static HTTP_API uint32 GetDefaultUserAgentVersion();
 
    static HTTP_API FDefaultUserAgentBuilder GetDefaultUserAgentBuilder();
 
    static HTTP_API TOptional<FString> GetOperatingSystemProxyAddress();
 
    static HTTP_API bool IsOperatingSystemProxyInformationSupported();
 
    static HTTP_API bool IsURLEncoded(const TArray<uint8>& Payload);
 
    static HTTP_API TOptional<FString> GetUrlParameter(const FStringView Url, const FStringView ParameterName);
 
    static HTTP_API TOptional<uint16> GetUrlPort(const FStringView Url);
 
    static HTTP_API FString GetUrlPath(const FStringView Url, const bool bIncludeQueryString = false, const bool bIncludeFragment = false);
 
    static HTTP_API TOptional<bool> IsSecureProtocol(const FStringView Url);
};