#ifndef CC_HTTP_H #define CC_HTTP_H #include "Constants.h" #include "Core.h" /* Aysnchronously performs http GET, HEAD, and POST requests Typically this is used to download skins, texture packs, etc Copyright 2014-2023 ClassiCube | Licensed under BSD-3 */ struct IGameComponent; struct ScheduledTask; struct StringsBuffer; #define URL_MAX_SIZE (STRING_SIZE * 2) #define HTTP_FLAG_PRIORITY 0x01 #define HTTP_FLAG_NOCACHE 0x02 extern struct IGameComponent Http_Component; enum HttpRequestType { REQUEST_TYPE_GET, REQUEST_TYPE_HEAD, REQUEST_TYPE_POST }; enum HttpProgress { HTTP_PROGRESS_NOT_WORKING_ON = -3, HTTP_PROGRESS_MAKING_REQUEST = -2, HTTP_PROGRESS_FETCHING_DATA = -1 }; struct HttpRequest { char url[URL_MAX_SIZE]; /* URL data is downloaded from/uploaded to. */ int id; /* Unique identifier for this request. */ volatile int progress; /* Progress with downloading this request */ TimeMS timeDownloaded; /* Time response contents were completely downloaded. */ int statusCode; /* HTTP status code returned in the response. */ cc_uint32 contentLength; /* HTTP content length returned in the response. */ cc_result result; /* 0 on success, otherwise platform-specific error. */ cc_uint8* data; /* Contents of the response. (i.e. result data) */ cc_uint32 size; /* Size of the contents. */ cc_uint32 _capacity; /* (private) Maximum size of data buffer */ void* meta; /* Pointer to backend specific data */ char* error; /* Pointer to dynamically allocated error message */ char lastModified[STRING_SIZE]; /* Time item cached at (if at all) */ char etag[STRING_SIZE]; /* ETag of cached item (if any) */ cc_uint8 requestType; /* See the various REQUEST_TYPE_ */ cc_bool success; /* Whether Result is 0, status is 200, and data is not NULL */ struct StringsBuffer* cookies; /* Cookie list sent in requests. May be modified by the response. */ }; /* Frees all dynamically allocated data from a HTTP request */ void HttpRequest_Free(struct HttpRequest* request); /* Aschronously performs a http GET request to download a skin. */ /* If url is a skin, downloads from there. (if not, downloads from SKIN_SERVER/[skinName].png) */ int Http_AsyncGetSkin(const cc_string* skinName, cc_uint8 flags); /* Asynchronously performs a http GET request. (e.g. to download data) */ int Http_AsyncGetData(const cc_string* url, cc_uint8 flags); /* Asynchronously performs a http HEAD request. (e.g. to get Content-Length header) */ int Http_AsyncGetHeaders(const cc_string* url, cc_uint8 flags); /* Asynchronously performs a http POST request. (e.g. to submit data) */ /* NOTE: You don't have to persist data, a copy is made of it. */ int Http_AsyncPostData(const cc_string* url, cc_uint8 flags, const void* data, cc_uint32 size, struct StringsBuffer* cookies); /* Asynchronously performs a http GET request. (e.g. to download data) */ /* Also sets the If-Modified-Since and If-None-Match headers. (if not NULL) */ int Http_AsyncGetDataEx(const cc_string* url, cc_uint8 flags, const cc_string* lastModified, const cc_string* etag, struct StringsBuffer* cookies); /* Attempts to remove given request from pending and finished request lists. */ /* NOTE: Won't cancel the request if it is currently in progress. */ void Http_TryCancel(int reqID); /* Encodes data using % or URL encoding. */ void Http_UrlEncode(cc_string* dst, const cc_uint8* data, int len); /* Converts characters to UTF8, then calls Http_UrlEncode on them. */ void Http_UrlEncodeUtf8(cc_string* dst, const cc_string* src); /* Outputs more detailed information about errors with http requests. */ cc_bool Http_DescribeError(cc_result res, cc_string* dst); /* Attempts to retrieve a fully completed request. */ /* NOTE: You MUST check Success for whether it completed successfully. */ /* (Data may still be non NULL even on error, e.g. on a http 404 error) */ cc_bool Http_GetResult(int reqID, struct HttpRequest* item); /* Retrieves information about the request currently being processed. */ cc_bool Http_GetCurrent(int* reqID, int* progress); /* Retrieves information about the download progress of the given request. */ /* NOTE: This may return HTTP_PROGRESS_NOT_WORKING_ON if download has finished. */ /* As such, this method should always be paired with a call to Http_GetResult. */ int Http_CheckProgress(int reqID); /* Clears the list of pending requests. */ void Http_ClearPending(void); void Http_LogError(const char* action, const struct HttpRequest* item); #endif