From b3b723b4531a3781ab847a2652cf192303e78941 Mon Sep 17 00:00:00 2001
From: Mattes D <github@xoft.cz>
Date: Sun, 25 Dec 2016 18:29:21 +0100
Subject: Refactored to put URL Encoding / Decoding in a single place. (#3491)

---
 Server/Plugins/APIDump/APIDesc.lua          | 38 +++++++++++++++++++++++++++++
 Server/Plugins/APIDump/Classes/WebAdmin.lua |  3 ++-
 2 files changed, 40 insertions(+), 1 deletion(-)

(limited to 'Server/Plugins/APIDump')

diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua
index 3fc21b6a3..d4a814cb9 100644
--- a/Server/Plugins/APIDump/APIDesc.lua
+++ b/Server/Plugins/APIDump/APIDesc.lua
@@ -13534,6 +13534,44 @@ local CompressedString = cStringCompression.CompressStringGZIP("DataToCompress")
 					},
 					Notes = "Parses the Authority part of the URL. Parts that are not explicitly specified in the AuthPart are returned empty, the port is returned zero. If parsing fails, the function returns nil and an error message.",
 				},
+				UrlDecode =
+				{
+					IsStatic = true,
+					Params =
+					{
+						{
+							Name = "Text",
+							Type = "string",
+						},
+					},
+					Returns =
+					{
+						{
+							Name = "Decoded",
+							Type = "string",
+						},
+					},
+					Notes = "Returns the Text, URL-decoded. Returns nil if there is a problem while decoding (invalid input).",
+				},
+				UrlEncode =
+				{
+					IsStatic = true,
+					Params =
+					{
+						{
+							Name = "Text",
+							Type = "string",
+						},
+					},
+					Returns =
+					{
+						{
+							Name = "Encoded",
+							Type = "string",
+						},
+					},
+					Notes = "Returns the Text, URL-encoded.",
+				},
 			},
 			AdditionalInfo =
 			{
diff --git a/Server/Plugins/APIDump/Classes/WebAdmin.lua b/Server/Plugins/APIDump/Classes/WebAdmin.lua
index 583278e5f..f6ebe9da7 100644
--- a/Server/Plugins/APIDump/Classes/WebAdmin.lua
+++ b/Server/Plugins/APIDump/Classes/WebAdmin.lua
@@ -121,6 +121,7 @@ return
 			GetURLEncodedString =
 			{
 				IsStatic = true,
+				ObsoletedBy = "cUrlParser:UrlEncode",
 				Params =
 				{
 					{
@@ -134,7 +135,7 @@ return
 						Type = "string",
 					},
 				},
-				Notes = "Returns the string given to it escaped by URL encoding, which makes the string suitable for transmission in an URL. Invalid characters are turned into \"%xy\" values.",
+				Notes = "<b>OBSOLETE</b> - use {{cUrlParser}}:UrlEncode() instead.<br/>Returns the string given to it escaped by URL encoding, which makes the string suitable for transmission in an URL. Invalid characters are turned into \"%xy\" values.",
 			},
 			Reload =
 			{
-- 
cgit v1.2.3