This repository has been archived by the owner on Nov 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 316
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- CallURL helper - Helper functions library - Minor refactoring
- Loading branch information
Showing
9 changed files
with
222 additions
and
90 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // Copyright 2016 Vladimir Alyamkin. All Rights Reserved. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "Kismet/BlueprintFunctionLibrary.h" | ||
|
|
||
| #include "VaRestTypes.h" | ||
| #include "VaRestLibrary.generated.h" | ||
|
|
||
| class UVaRestRequestJSON; | ||
| class UVaRestJsonObject; | ||
|
|
||
| DECLARE_DYNAMIC_DELEGATE_OneParam(FVaRestCallDelegate, UVaRestRequestJSON*, Request); | ||
|
|
||
| USTRUCT() | ||
| struct FVaRestCallResponse | ||
| { | ||
| GENERATED_USTRUCT_BODY() | ||
|
|
||
| UPROPERTY() | ||
| UVaRestRequestJSON* Request; | ||
|
|
||
| UPROPERTY() | ||
| UObject* WorldContextObject; | ||
|
|
||
| UPROPERTY() | ||
| FVaRestCallDelegate Callback; | ||
|
|
||
| FDelegateHandle CompleteDelegateHandle; | ||
| FDelegateHandle FailDelegateHandle; | ||
|
|
||
| FVaRestCallResponse() | ||
| : Request(nullptr) | ||
| , WorldContextObject(nullptr) | ||
| { | ||
| } | ||
|
|
||
| }; | ||
|
|
||
| /** | ||
| * Usefull tools for REST communications | ||
| */ | ||
| UCLASS() | ||
| class UVaRestLibrary : public UBlueprintFunctionLibrary | ||
| { | ||
| GENERATED_BODY() | ||
|
|
||
|
|
||
| ////////////////////////////////////////////////////////////////////////// | ||
| // Helpers | ||
|
|
||
| public: | ||
| /** Applies percent-encoding to text */ | ||
| UFUNCTION(BlueprintCallable, Category = "VaRest|Utility") | ||
| static FString PercentEncode(const FString& Text); | ||
|
|
||
|
|
||
| ////////////////////////////////////////////////////////////////////////// | ||
| // Easy URL processing | ||
|
|
||
| public: | ||
| /** Easy way to process http requests */ | ||
| UFUNCTION(BlueprintCallable, Category = "VaRest|Library", meta = (WorldContext = "WorldContextObject")) | ||
| static void CallURL(UObject* WorldContextObject, const FString& URL, ERequestVerb Verb, ERequestContentType ContentType, UVaRestJsonObject* VaRestJson, const FVaRestCallDelegate& Callback); | ||
|
|
||
| /** Called when URL is processed (one for both success/unsuccess events)*/ | ||
| static void OnCallComplete(UVaRestRequestJSON* Request); | ||
|
|
||
| private: | ||
| static TMap<UVaRestRequestJSON*, FVaRestCallResponse> RequestMap; | ||
|
|
||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // Copyright 2016 Vladimir Alyamkin. All Rights Reserved. | ||
|
|
||
| #pragma once | ||
|
|
||
| /** Verb (GET, PUT, POST) used by the request */ | ||
| UENUM(BlueprintType) | ||
| enum class ERequestVerb : uint8 | ||
| { | ||
| GET, | ||
| POST, | ||
| PUT, | ||
| DEL UMETA(DisplayName = "DELETE"), | ||
| /** Set CUSTOM verb by SetCustomVerb() function */ | ||
| CUSTOM | ||
| }; | ||
|
|
||
| /** Content type (json, urlencoded, etc.) used by the request */ | ||
| UENUM(BlueprintType) | ||
| enum class ERequestContentType : uint8 | ||
| { | ||
| x_www_form_urlencoded_url UMETA(DisplayName = "x-www-form-urlencoded (URL)"), | ||
| x_www_form_urlencoded_body UMETA(DisplayName = "x-www-form-urlencoded (Request Body)"), | ||
| json, | ||
| binary | ||
| }; | ||
|
|
||
| /** Enumerates the current state of an Http request */ | ||
| UENUM(BlueprintType) | ||
| enum class ERequestStatus : uint8 | ||
| { | ||
| /** Has not been started via ProcessRequest() */ | ||
| NotStarted, | ||
| /** Currently being ticked and processed */ | ||
| Processing, | ||
| /** Finished but failed */ | ||
| Failed, | ||
| /** Failed because it was unable to connect (safe to retry) */ | ||
| Failed_ConnectionError, | ||
| /** Finished and was successful */ | ||
| Succeeded | ||
| }; |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // Copyright 2016 Vladimir Alyamkin. All Rights Reserved. | ||
|
|
||
| #include "VaRestPluginPrivatePCH.h" | ||
|
|
||
|
|
||
| ////////////////////////////////////////////////////////////////////////// | ||
| // Helpers | ||
|
|
||
| FString UVaRestLibrary::PercentEncode(const FString& Text) | ||
| { | ||
| FString OutText = Text; | ||
|
|
||
| OutText = OutText.Replace(TEXT(" "), TEXT("%20")); | ||
| OutText = OutText.Replace(TEXT("!"), TEXT("%21")); | ||
| OutText = OutText.Replace(TEXT("\""), TEXT("%22")); | ||
| OutText = OutText.Replace(TEXT("#"), TEXT("%23")); | ||
| OutText = OutText.Replace(TEXT("$"), TEXT("%24")); | ||
| OutText = OutText.Replace(TEXT("&"), TEXT("%26")); | ||
| OutText = OutText.Replace(TEXT("'"), TEXT("%27")); | ||
| OutText = OutText.Replace(TEXT("("), TEXT("%28")); | ||
| OutText = OutText.Replace(TEXT(")"), TEXT("%29")); | ||
| OutText = OutText.Replace(TEXT("*"), TEXT("%2A")); | ||
| OutText = OutText.Replace(TEXT("+"), TEXT("%2B")); | ||
| OutText = OutText.Replace(TEXT(","), TEXT("%2C")); | ||
| OutText = OutText.Replace(TEXT("/"), TEXT("%2F")); | ||
| OutText = OutText.Replace(TEXT(":"), TEXT("%3A")); | ||
| OutText = OutText.Replace(TEXT(";"), TEXT("%3B")); | ||
| OutText = OutText.Replace(TEXT("="), TEXT("%3D")); | ||
| OutText = OutText.Replace(TEXT("?"), TEXT("%3F")); | ||
| OutText = OutText.Replace(TEXT("@"), TEXT("%40")); | ||
| OutText = OutText.Replace(TEXT("["), TEXT("%5B")); | ||
| OutText = OutText.Replace(TEXT("]"), TEXT("%5D")); | ||
| OutText = OutText.Replace(TEXT("{"), TEXT("%7B")); | ||
| OutText = OutText.Replace(TEXT("}"), TEXT("%7D")); | ||
|
|
||
| return OutText; | ||
| } | ||
|
|
||
|
|
||
| ////////////////////////////////////////////////////////////////////////// | ||
| // Easy URL processing | ||
|
|
||
| TMap<UVaRestRequestJSON*, FVaRestCallResponse> UVaRestLibrary::RequestMap; | ||
|
|
||
| void UVaRestLibrary::CallURL(UObject* WorldContextObject, const FString& URL, ERequestVerb Verb, ERequestContentType ContentType, UVaRestJsonObject* VaRestJson, const FVaRestCallDelegate& Callback) | ||
| { | ||
| UWorld* World = GEngine->GetWorldFromContextObject(WorldContextObject); | ||
| if (World == nullptr) | ||
| { | ||
| UE_LOG(LogVaRest, Error, TEXT("UVaRestLibrary: Wrong world context")) | ||
| return; | ||
| } | ||
|
|
||
| // Check we have valid data json | ||
| if (VaRestJson == nullptr) | ||
| { | ||
| VaRestJson = UVaRestJsonObject::ConstructJsonObject(WorldContextObject); | ||
| } | ||
|
|
||
| UVaRestRequestJSON* Request = NewObject<UVaRestRequestJSON>(); | ||
|
|
||
| Request->SetVerb(Verb); | ||
| Request->SetContentType(ContentType); | ||
| Request->SetRequestObject(VaRestJson); | ||
|
|
||
| FVaRestCallResponse Response; | ||
| Response.Request = Request; | ||
| Response.WorldContextObject = WorldContextObject; | ||
| Response.Callback = Callback; | ||
|
|
||
| Response.CompleteDelegateHandle = Request->OnStaticRequestComplete.AddStatic(&UVaRestLibrary::OnCallComplete); | ||
| Response.FailDelegateHandle = Request->OnStaticRequestFail.AddStatic(&UVaRestLibrary::OnCallComplete); | ||
|
|
||
| RequestMap.Add(Request, Response); | ||
|
|
||
| Request->ResetResponseData(); | ||
| Request->ProcessURL(URL); | ||
| } | ||
|
|
||
| void UVaRestLibrary::OnCallComplete(UVaRestRequestJSON* Request) | ||
| { | ||
| if (!RequestMap.Contains(Request)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| FVaRestCallResponse* Response = RequestMap.Find(Request); | ||
|
|
||
| Request->OnStaticRequestComplete.Remove(Response->CompleteDelegateHandle); | ||
| Request->OnStaticRequestFail.Remove(Response->FailDelegateHandle); | ||
|
|
||
| Response->Callback.ExecuteIfBound(Request); | ||
|
|
||
| Response->WorldContextObject = nullptr; | ||
| Response->Request = nullptr; | ||
| RequestMap.Remove(Request); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters