summaryrefslogtreecommitdiff
path: root/sourcemod/scripting/include/GlobalAPI/requestdata.inc
diff options
context:
space:
mode:
Diffstat (limited to 'sourcemod/scripting/include/GlobalAPI/requestdata.inc')
-rw-r--r--sourcemod/scripting/include/GlobalAPI/requestdata.inc534
1 files changed, 0 insertions, 534 deletions
diff --git a/sourcemod/scripting/include/GlobalAPI/requestdata.inc b/sourcemod/scripting/include/GlobalAPI/requestdata.inc
deleted file mode 100644
index f055ee8..0000000
--- a/sourcemod/scripting/include/GlobalAPI/requestdata.inc
+++ /dev/null
@@ -1,534 +0,0 @@
-// ================== DOUBLE INCLUDE ========================= //
-
-#if defined _GlobalAPI_RequestData_included_
-#endinput
-#endif
-#define _GlobalAPI_RequestData_included_
-
-// =========================================================== //
-
-#include <json>
-
-// =========================================================== //
-
-/*
- Helper methodmap for wrapping data related to requests
-*/
-methodmap GlobalAPIRequestData < JSON_Object
-{
- /**
- * Creates a new GlobalAPIRequestData
- *
- * @note You can pass a plugin handle or name and/or version
- * @note Plugin handle is always preferred
- * @param plugin Handle to calling plugin
- * @param pluginName Name of the calling plugin
- * @param pluginVersion Version of the calling plugin
- * @return A new GlobalAPIRequestData handle
- */
- public GlobalAPIRequestData(Handle plugin = null, char[] pluginName = "Unknown", char[] pluginVersion = "Unknown")
- {
- JSON_Object requestData = new JSON_Object();
-
- if (plugin == null)
- {
- requestData.SetString("pluginName", pluginName);
- requestData.SetString("pluginVersion", pluginVersion);
- }
- else
- {
- requestData.SetString("pluginName", GetPluginDisplayName(plugin));
- requestData.SetString("pluginVersion", GetPluginVersion(plugin));
- }
-
- requestData.SetKeyHidden("pluginName", true);
- requestData.SetKeyHidden("pluginVersion", true);
-
- requestData.SetInt("acceptType", 0);
- requestData.SetKeyHidden("acceptType", true);
-
- requestData.SetInt("contentType", 0);
- requestData.SetKeyHidden("contentType", true);
-
- return view_as<GlobalAPIRequestData>(requestData);
- }
-
- /**
- * Sets a key as default
- *
- * @note This sets them as "Handle" type
- * @note - See GlobalAPI.inc for default values
- * @param key Key to set as default
- * @noreturn
- */
- public void SetDefault(char[] key)
- {
- this.SetHandle(key);
- this.SetKeyHidden(key, true);
- }
-
- /**
- * Sets url to the request data
- *
- * @param url Url to set
- * @noreturn
- */
- public void AddUrl(char[] url)
- {
- this.SetString("url", url);
- this.SetKeyHidden("url", true);
- }
-
- /**
- * Sets endpoint to the request data
- *
- * @param endpoint Endpoint to set
- * @noreturn
- */
- public void AddEndpoint(char[] endpoint)
- {
- this.SetString("endpoint", endpoint);
- this.SetKeyHidden("endpoint", true);
- }
-
- /**
- * Sets body file path to the request data
- *
- * @note Path to file with data to be posted
- * @param path Body file (path) to set
- * @noreturn
- */
- public void AddBodyFile(char[] path)
- {
- this.SetString("bodyFile", path);
- this.SetKeyHidden("bodyFile", true);
- }
-
- /**
- * Sets data file path to the request data
- *
- * @note Path for downloaded files
- * @param path Data path to set
- * @noreturn
- */
- public void AddDataPath(char[] path)
- {
- this.SetString("dataFilePath", path);
- this.SetKeyHidden("dataFilePath", true);
- }
-
- /*
- Get or set the request's "acceptType"
- */
- property int AcceptType
- {
- public get()
- {
- return this.GetInt("acceptType");
- }
- public set(int type)
- {
- this.SetInt("acceptType", type);
- }
- }
-
- /*
- Get or set the request's "contentType"
- */
- property int ContentType
- {
- public get()
- {
- return this.GetInt("contentType");
- }
- public set(int type)
- {
- this.SetInt("contentType", type);
- }
- }
-
- /*
- Get or set the request's "keyRequired"
- */
- property bool KeyRequired
- {
- public get()
- {
- return this.GetBool("keyRequired");
- }
- public set(bool required)
- {
- this.SetBool("keyRequired", required);
- this.SetKeyHidden("keyRequired", true);
- }
- }
-
- /*
- Get or set the request's "isRetried"
- */
- property bool IsRetried
- {
- public get()
- {
- return this.GetBool("isRetried");
- }
- public set(bool retried)
- {
- this.SetBool("isRetried", retried);
- this.SetKeyHidden("isRetried", true);
- }
- }
-
- /*
- Get or set the request's "bodyLength"
- */
- property int BodyLength
- {
- public get()
- {
- return this.GetInt("bodyLength");
- }
- public set(int length)
- {
- this.SetInt("bodyLength", length);
- this.SetKeyHidden("bodyLength", true);
- }
- }
-
- /*
- Get or set the request's "status"
- */
- property int Status
- {
- public get()
- {
- return this.GetInt("status");
- }
- public set(int status)
- {
- this.SetInt("status", status);
- this.SetKeyHidden("status", true);
- }
- }
-
- /*
- Get or set the request's "responseTime"
- */
- property int ResponseTime
- {
- public get()
- {
- return this.GetInt("responseTime");
- }
- public set(int responseTime)
- {
- this.SetInt("responseTime", responseTime);
- this.SetKeyHidden("responseTime", true);
- }
- }
-
- /*
- Get or set the request's "requestType"
- */
- property int RequestType
- {
- public get()
- {
- return this.GetInt("requestType");
- }
- public set(int type)
- {
- this.SetInt("requestType", type);
- this.SetKeyHidden("requestType", true);
- }
- }
-
- /*
- Get or set the request's "failure"
- */
- property bool Failure
- {
- public get()
- {
- return this.GetBool("failure");
- }
- public set(bool failure)
- {
- this.SetBool("failure", failure);
- this.SetKeyHidden("failure", true);
- }
- }
-
- /*
- Get or set the request's "callback"
- */
- property Handle Callback
- {
- public get()
- {
- return view_as<Handle>(this.GetInt("callback"));
- }
- public set(Handle hFwd)
- {
- this.SetHandle("callback", hFwd);
- this.SetKeyType("callback", Type_Int);
- this.SetKeyHidden("callback", true);
- }
- }
-
- /*
- Get or set the request's "data"
- */
- property any Data
- {
- public get()
- {
- return this.GetInt("data");
- }
- public set(any data)
- {
- this.SetInt("data", data);
- this.SetKeyHidden("data", true);
- }
- }
-
- /**
- * Adds a number to the request data
- *
- * @note Default values are added as "defaults"
- * @note See GlobalAPI.inc for the default values
- * @param key Key name to set
- * @param value Value of the key
- * @noreturn
- */
- public void AddNum(char[] key, int value)
- {
- if (value == -1)
- {
- this.SetDefault(key);
- }
- else
- {
- this.SetInt(key, value);
- }
- }
-
- /**
- * Adds a float to the request data
- *
- * @note Default values are added as "defaults"
- * @note See GlobalAPI.inc for the default values
- * @param key Key name to set
- * @param value Value of the key
- * @noreturn
- */
- public void AddFloat(char[] key, float value)
- {
- if (value == -1.000000)
- {
- this.SetDefault(key);
- }
- else
- {
- this.SetFloat(key, value);
- }
- }
-
- /**
- * Adds a string to the request data
- *
- * @note Default values are added as "defaults"
- * @note See GlobalAPI.inc for the default values
- * @param key Key name to set
- * @param value Value of the key
- * @noreturn
- */
- public void AddString(char[] key, char[] value)
- {
- if (StrEqual(value, ""))
- {
- this.SetDefault(key);
- }
- else
- {
- this.SetString(key, value);
- }
- }
-
- /**
- * Adds a boolean to the request data
- *
- * @note Default values are added as "defaults"
- * @note See GlobalAPI.inc for the default values
- * @param key Key name to set
- * @param value Value of the key
- * @noreturn
- */
- public void AddBool(char[] key, bool value)
- {
- if (value != true && value != false)
- {
- this.SetDefault(key);
- }
- else
- {
- this.SetBool(key, value);
- }
- }
-
- /**
- * Adds integer array to the request data
- *
- * @note Max length <= 0 are added as defaults
- * @param key Key name to set
- * @param value Values (array) of the key
- * @param maxlength Max length of the values array
- * @noreturn
- */
- public void AddIntArray(char[] key, int[] value, int maxlength)
- {
- if (maxlength <= 0)
- {
- this.SetDefault(key);
- }
- else
- {
- JSON_Object hArray = new JSON_Object(true);
-
- for (int i = 0; i < maxlength; i++)
- {
- hArray.PushInt(value[i]);
- }
-
- this.SetObject(key, hArray);
- }
- }
-
- /**
- * Adds string array to the request data
- *
- * @note Item count <= 0 are added as defaults
- * @param key Key name to set
- * @param itemCount Amount of strings in the array
- * @noreturn
- */
- public void AddStringArray(char[] key, char[][] value, int itemCount)
- {
- if (itemCount <= 0)
- {
- this.SetDefault(key);
- }
- else
- {
- JSON_Object hArray = new JSON_Object(true);
-
- for (int i = 0; i < itemCount; i++)
- {
- hArray.PushString(value[i]);
- }
-
- this.SetObject(key, hArray);
- }
- }
-
- /**
- * Converts all of the request data into a query string representation
- *
- * @note This ignores "hidden" keys
- * @param queryString Buffer to store the result in
- * @param maxlength Max length of the buffer
- * @noreturn
- */
- public void ToString(char[] queryString, int maxlength)
- {
- StringMapSnapshot paramsMap = this.Snapshot();
-
- char key[64];
- char value[1024];
-
- int paramCount = 0;
-
- for (int i = 0; i < paramsMap.Length; i++)
- {
- paramsMap.GetKey(i, key, sizeof(key));
- if (this.GetKeyHidden(key) || json_is_meta_key(key))
- {
- continue;
- }
-
- switch(this.GetKeyType(key))
- {
- case Type_String:
- {
- this.GetString(key, value, sizeof(value));
- AppendToQueryString(paramCount, queryString, maxlength, key, value);
- }
- case Type_Float:
- {
- float temp = this.GetFloat(key);
- FloatToString(temp, value, sizeof(value));
- AppendToQueryString(paramCount, queryString, maxlength, key, value);
- }
- case Type_Int:
- {
- int temp = this.GetInt(key);
- IntToString(temp, value, sizeof(value));
- AppendToQueryString(paramCount, queryString, maxlength, key, value);
- }
- case Type_Bool:
- {
- bool temp = this.GetBool(key);
- BoolToString(temp, value, sizeof(value));
- AppendToQueryString(paramCount, queryString, maxlength, key, value);
- }
- case Type_Object:
- {
- JSON_Object hObject = this.GetObject(key);
-
- if (!hObject.IsArray) continue;
-
- for (int x = 0; x < hObject.Length; x++)
- {
- switch (hObject.GetKeyTypeIndexed(x))
- {
- case Type_Int:
- {
- int temp = hObject.GetIntIndexed(x);
- IntToString(temp, value, sizeof(value));
- AppendToQueryString(paramCount, queryString, maxlength, key, value);
- }
- case Type_String:
- {
- hObject.GetStringIndexed(x, value, sizeof(value));
- AppendToQueryString(paramCount, queryString, maxlength, key, value);
- }
- }
- }
- }
- }
- }
-
- delete paramsMap;
- }
-}
-
-// =====[ PRIVATE ]=====
-
-static void BoolToString(bool value, char[] buffer, int maxlength)
-{
- FormatEx(buffer, maxlength, "%s", value ? "true" : "false");
-}
-
-static void AppendToQueryString(int &index, char[] buffer, int maxlength, char[] key, char[] value)
-{
- if (index == 0)
- {
- index++;
- Format(buffer, maxlength, "?%s=%s", key, value);
- }
- else
- {
- index++;
- Format(buffer, maxlength, "%s&%s=%s", buffer, key, value);
- }
-}
generated by cgit v1.2.3 (git 2.25.1) at 2026-02-18 18:21:08 +0000