Translated using Weblate (Chinese (Simplified))

[oweals/minetest.git] / src / httpfetch.h

diff --git a/src/httpfetch.h b/src/httpfetch.h
index 56a198baf0014773e1ddf9f2596e0cceb46c29ac..ae8b5afb5b733332b8b55dae03ccbf7b5d7d617d 100644 (file)
--- a/src/httpfetch.h
+++ b/src/httpfetch.h
@@ -17,28 +17,28 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-#ifndef HTTPFETCH_HEADER
-#define HTTPFETCH_HEADER
+#pragma once
 
-#include <string>
 #include <vector>
+#include "util/string.h"
 #include "config.h"
 
 // Can be used in place of "caller" in asynchronous transfers to discard result
 // (used as default value of "caller")
 #define HTTPFETCH_DISCARD 0
+#define HTTPFETCH_SYNC 1
 
 struct HTTPFetchRequest
 {
-       std::string url;
+       std::string url = "";
 
        // Identifies the caller (for asynchronous requests)
        // Ignored by httpfetch_sync
-       unsigned long caller;
+       unsigned long caller = HTTPFETCH_DISCARD;
 
        // Some number that identifies the request
        // (when the same caller issues multiple httpfetch_async calls)
-       unsigned long request_id;
+       unsigned long request_id = 0;
 
        // Timeout for the whole transfer, in milliseconds
        long timeout;
@@ -46,52 +46,41 @@ struct HTTPFetchRequest
        // Timeout for the connection phase, in milliseconds
        long connect_timeout;
 
-       // POST data (should be application/x-www-form-urlencoded
-       // unless a Content-Type header is specified in extra_headers)
+       // Indicates if this is multipart/form-data or
+       // application/x-www-form-urlencoded.  POST-only.
+       bool multipart = false;
+
+       // POST fields.  Fields are escaped properly.
        // If this is empty a GET request is done instead.
-       std::string post_fields;
+       StringMap post_fields;
+
+       // Raw POST data, overrides post_fields.
+       std::string post_data;
 
        // If not empty, should contain entries such as "Accept: text/html"
        std::vector<std::string> extra_headers;
 
-       HTTPFetchRequest()
-       {
-               url = "";
-               caller = HTTPFETCH_DISCARD;
-               request_id = 0;
-               timeout = 0;
-               connect_timeout = 0;
-       }
+       // useragent to use
+       std::string useragent;
+
+       HTTPFetchRequest();
 };
 
 struct HTTPFetchResult
 {
-       bool succeeded;
-       bool timeout;
-       long response_code;
-       std::string data;
+       bool succeeded = false;
+       bool timeout = false;
+       long response_code = 0;
+       std::string data = "";
        // The caller and request_id from the corresponding HTTPFetchRequest.
-       unsigned long caller;
-       unsigned long request_id;
+       unsigned long caller = HTTPFETCH_DISCARD;
+       unsigned long request_id = 0;
 
-       HTTPFetchResult()
-       {
-               succeeded = false;
-               timeout = false;
-               response_code = 0;
-               data = "";
-               caller = HTTPFETCH_DISCARD;
-               request_id = 0;
-       }
+       HTTPFetchResult() = default;
 
-       HTTPFetchResult(const HTTPFetchRequest &fetchrequest)
+       HTTPFetchResult(const HTTPFetchRequest &fetch_request) :
+                       caller(fetch_request.caller), request_id(fetch_request.request_id)
        {
-               succeeded = false;
-               timeout = false;
-               response_code = 0;
-               data = "";
-               caller = fetchrequest.caller;
-               request_id = fetchrequest.request_id;
        }
 };
 
@@ -102,16 +91,19 @@ void httpfetch_init(int parallel_limit);
 void httpfetch_cleanup();
 
 // Starts an asynchronous HTTP fetch request
-void httpfetch_async(const HTTPFetchRequest &fetchrequest);
+void httpfetch_async(const HTTPFetchRequest &fetch_request);
 
 // If any fetch for the given caller ID is complete, removes it from the
-// result queue, sets fetchresult and returns true. Otherwise returns false.
-bool httpfetch_async_get(unsigned long caller, HTTPFetchResult &fetchresult);
+// result queue, sets the fetch result and returns true. Otherwise returns false.
+bool httpfetch_async_get(unsigned long caller, HTTPFetchResult &fetch_result);
 
 // Allocates a caller ID for httpfetch_async
 // Not required if you want to set caller = HTTPFETCH_DISCARD
 unsigned long httpfetch_caller_alloc();
 
+// Allocates a non-predictable caller ID for httpfetch_async
+unsigned long httpfetch_caller_alloc_secure();
+
 // Frees a caller ID allocated with httpfetch_caller_alloc
 // Note: This can be expensive, because the httpfetch thread is told
 // to stop any ongoing fetches for the given caller.
@@ -119,8 +111,4 @@ void httpfetch_caller_free(unsigned long caller);
 
 // Performs a synchronous HTTP request. This blocks and therefore should
 // only be used from background threads.
-void httpfetch_sync(const HTTPFetchRequest &fetchrequest,
-               HTTPFetchResult &fetchresult);
-
-
-#endif // !HTTPFETCH_HEADER
+void httpfetch_sync(const HTTPFetchRequest &fetch_request, HTTPFetchResult &fetch_result);