src/httpfetch.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef HTTPFETCH_HEADER
  21 #define HTTPFETCH_HEADER
  22
  23 #include <vector>
  24 #include "util/string.h"
  25 #include "config.h"
  26
  27 // Can be used in place of "caller" in asynchronous transfers to discard result
  28 // (used as default value of "caller")
  29 #define HTTPFETCH_DISCARD 0
  30 #define HTTPFETCH_SYNC 1
  31
  32 struct HTTPFetchRequest
  33 {
  34         std::string url;
  35
  36         // Identifies the caller (for asynchronous requests)
  37         // Ignored by httpfetch_sync
  38         unsigned long caller;
  39
  40         // Some number that identifies the request
  41         // (when the same caller issues multiple httpfetch_async calls)
  42         unsigned long request_id;
  43
  44         // Timeout for the whole transfer, in milliseconds
  45         long timeout;
  46
  47         // Timeout for the connection phase, in milliseconds
  48         long connect_timeout;
  49
  50         // Indicates if this is multipart/form-data or
  51         // application/x-www-form-urlencoded.  POST-only.
  52         bool multipart;
  53
  54         // POST fields.  Fields are escaped properly.
  55         // If this is empty a GET request is done instead.
  56         StringMap post_fields;
  57
  58         // Raw POST data, overrides post_fields.
  59         std::string post_data;
  60
  61         // If not empty, should contain entries such as "Accept: text/html"
  62         std::vector<std::string> extra_headers;
  63
  64         // useragent to use
  65         std::string useragent;
  66
  67         HTTPFetchRequest();
  68 };
  69
  70 struct HTTPFetchResult
  71 {
  72         bool succeeded;
  73         bool timeout;
  74         long response_code;
  75         std::string data;
  76         // The caller and request_id from the corresponding HTTPFetchRequest.
  77         unsigned long caller;
  78         unsigned long request_id;
  79
  80         HTTPFetchResult()
  81             : succeeded(false), timeout(false), response_code(0), data(""),
  82               caller(HTTPFETCH_DISCARD), request_id(0)
  83         {
  84         }
  85
  86         HTTPFetchResult(const HTTPFetchRequest &fetch_request)
  87             : succeeded(false), timeout(false), response_code(0), data(""),
  88               caller(fetch_request.caller), request_id(fetch_request.request_id)
  89         {
  90         }
  91 };
  92
  93 // Initializes the httpfetch module
  94 void httpfetch_init(int parallel_limit);
  95
  96 // Stops the httpfetch thread and cleans up resources
  97 void httpfetch_cleanup();
  98
  99 // Starts an asynchronous HTTP fetch request
 100 void httpfetch_async(const HTTPFetchRequest &fetch_request);
 101
 102 // If any fetch for the given caller ID is complete, removes it from the
 103 // result queue, sets the fetch result and returns true. Otherwise returns false.
 104 bool httpfetch_async_get(unsigned long caller, HTTPFetchResult &fetch_result);
 105
 106 // Allocates a caller ID for httpfetch_async
 107 // Not required if you want to set caller = HTTPFETCH_DISCARD
 108 unsigned long httpfetch_caller_alloc();
 109
 110 // Allocates a non-predictable caller ID for httpfetch_async
 111 unsigned long httpfetch_caller_alloc_secure();
 112
 113 // Frees a caller ID allocated with httpfetch_caller_alloc
 114 // Note: This can be expensive, because the httpfetch thread is told
 115 // to stop any ongoing fetches for the given caller.
 116 void httpfetch_caller_free(unsigned long caller);
 117
 118 // Performs a synchronous HTTP request. This blocks and therefore should
 119 // only be used from background threads.
 120 void httpfetch_sync(const HTTPFetchRequest &fetch_request, HTTPFetchResult &fetch_result);
 121
 122 #endif // !HTTPFETCH_HEADER