#include "fs.h"
#include "libcurl.h"
#include "thread.h"
-
+#include "com_list.h"
#include "image.h"
#include "jpeg.h"
#include "image_png.h"
-static cvar_t cl_curl_maxdownloads = {CVAR_CLIENT | CVAR_SAVE, "cl_curl_maxdownloads","1", "maximum number of concurrent HTTP/FTP downloads"};
-static cvar_t cl_curl_maxspeed = {CVAR_CLIENT | CVAR_SAVE, "cl_curl_maxspeed","300", "maximum download speed (KiB/s)"};
-static cvar_t sv_curl_defaulturl = {CVAR_SERVER | CVAR_SAVE, "sv_curl_defaulturl","", "default autodownload source URL"};
-static cvar_t sv_curl_serverpackages = {CVAR_SERVER | CVAR_SAVE, "sv_curl_serverpackages","", "list of required files for the clients, separated by spaces"};
-static cvar_t sv_curl_maxspeed = {CVAR_SERVER | CVAR_SAVE, "sv_curl_maxspeed","0", "maximum download speed for clients downloading from sv_curl_defaulturl (KiB/s)"};
-static cvar_t cl_curl_enabled = {CVAR_CLIENT | CVAR_SAVE, "cl_curl_enabled","1", "whether client's download support is enabled"};
-static cvar_t cl_curl_useragent = {CVAR_CLIENT, "cl_curl_useragent","1", "send the User-Agent string (note: turning this off may break stuff)"};
-static cvar_t cl_curl_useragent_append = {CVAR_CLIENT, "cl_curl_useragent_append","", "a string to append to the User-Agent string (useful for name and version number of your mod)"};
+static cvar_t cl_curl_maxdownloads = {CF_CLIENT | CF_ARCHIVE, "cl_curl_maxdownloads","1", "maximum number of concurrent HTTP/FTP downloads"};
+static cvar_t cl_curl_maxspeed = {CF_CLIENT | CF_ARCHIVE, "cl_curl_maxspeed","300", "maximum download speed (KiB/s)"};
+static cvar_t sv_curl_defaulturl = {CF_SERVER | CF_ARCHIVE, "sv_curl_defaulturl","", "default autodownload source URL"};
+static cvar_t sv_curl_serverpackages = {CF_SERVER | CF_ARCHIVE, "sv_curl_serverpackages","", "list of required files for the clients, separated by spaces"};
+static cvar_t sv_curl_maxspeed = {CF_SERVER | CF_ARCHIVE, "sv_curl_maxspeed","0", "maximum download speed for clients downloading from sv_curl_defaulturl (KiB/s)"};
+static cvar_t cl_curl_enabled = {CF_CLIENT | CF_ARCHIVE, "cl_curl_enabled","1", "whether client's download support is enabled"};
+static cvar_t cl_curl_useragent = {CF_CLIENT, "cl_curl_useragent","1", "send the User-Agent string (note: turning this off may break stuff)"};
+static cvar_t cl_curl_useragent_append = {CF_CLIENT, "cl_curl_useragent_append","", "a string to append to the User-Agent string (useful for name and version number of your mod)"};
+static cvar_t developer_curl = {CF_CLIENT | CF_SERVER, "developer_curl","0", "whether verbose curl output should be printed to stderr"};
/*
=================================================================
CINIT(LOW_SPEED_TIME, LONG, 20),
CINIT(RESUME_FROM, LONG, 21),
CINIT(HTTPHEADER, OBJECTPOINT, 23),
+ CINIT(VERBOSE, LONG, 41),
CINIT(POST, LONG, 47), /* HTTP POST method */
CINIT(FOLLOWLOCATION, LONG, 52), /* use Location: Luke! */
CINIT(POSTFIELDSIZE, LONG, 60),
static CURLM * (*qcurl_multi_init) (void);
static CURLMcode (*qcurl_multi_perform) (CURLM *multi_handle, int *running_handles);
+static CURLMcode (*qcurl_multi_poll) (CURLM *multi_handle, void*, unsigned int extra_nfds, int timeout_ms, int *ret);
static CURLMcode (*qcurl_multi_add_handle) (CURLM *multi_handle, CURL *easy_handle);
static CURLMcode (*qcurl_multi_remove_handle) (CURLM *multi_handle, CURL *easy_handle);
static CURLMsg * (*qcurl_multi_info_read) (CURLM *multi_handle, int *msgs_in_queue);
{"curl_easy_getinfo", (void **) &qcurl_easy_getinfo},
{"curl_multi_init", (void **) &qcurl_multi_init},
{"curl_multi_perform", (void **) &qcurl_multi_perform},
+ {"curl_multi_poll", (void **) &qcurl_multi_poll},
{"curl_multi_add_handle", (void **) &qcurl_multi_add_handle},
{"curl_multi_remove_handle",(void **) &qcurl_multi_remove_handle},
{"curl_multi_info_read", (void **) &qcurl_multi_info_read},
qfile_t *stream;
fs_offset_t startpos;
CURL *curle;
- qboolean started;
+ qbool started;
int loadtype;
size_t bytes_received; // for buffer
double bytes_received_curl; // for throttling
double bytes_sent_curl; // for throttling
- struct downloadinfo_s *next, *prev;
- qboolean forthismap;
+ llist_t list;
+ qbool forthismap;
double maxspeed;
curl_slist *slist; // http headers
const char *extraheaders;
}
downloadinfo;
-static downloadinfo *downloads = NULL;
+LIST_HEAD(downloads);
static int numdownloads = 0;
-static qboolean noclear = false;
+static qbool noclear = false;
static int numdownloads_fail = 0;
static int numdownloads_success = 0;
if(noclear)
return;
if (curl_mutex) Thread_LockMutex(curl_mutex);
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
di->forthismap = false;
Curl_CommandWhenError(NULL);
Curl_CommandWhenDone(NULL);
Returns true if a download needed for the current game is running.
====================
*/
-qboolean Curl_Have_forthismap(void)
+qbool Curl_Have_forthismap(void)
{
return numdownloads_added != 0;
}
if(numdownloads_fail == 0)
{
Con_DPrintf("cURL downloads occurred, executing %s\n", command_when_done);
- Cbuf_AddText(&cmd_client, "\n");
- Cbuf_AddText(&cmd_client, command_when_done);
- Cbuf_AddText(&cmd_client, "\n");
+ Cbuf_AddText(cmd_local, "\n");
+ Cbuf_AddText(cmd_local, command_when_done);
+ Cbuf_AddText(cmd_local, "\n");
}
else
{
Con_DPrintf("cURL downloads FAILED, executing %s\n", command_when_error);
- Cbuf_AddText(&cmd_client, "\n");
- Cbuf_AddText(&cmd_client, command_when_error);
- Cbuf_AddText(&cmd_client, "\n");
+ Cbuf_AddText(cmd_local, "\n");
+ Cbuf_AddText(cmd_local, command_when_error);
+ Cbuf_AddText(cmd_local, "\n");
}
Curl_Clear_forthismap();
}
Load the cURL DLL
====================
*/
-static qboolean CURL_OpenLibrary (void)
+static qbool CURL_OpenLibrary (void)
{
const char* dllnames [] =
{
return true;
// Load the DLL
- return Sys_LoadLibrary (dllnames, &curl_dll, curlfuncs);
+ return Sys_LoadDependency (dllnames, &curl_dll, curlfuncs);
}
*/
static void CURL_CloseLibrary (void)
{
- Sys_UnloadLibrary (&curl_dll);
+ Sys_FreeLibrary (&curl_dll);
}
di->bytes_received += bytes;
+ //Con_Printf("CURL_fwrite callback timestamp: %f bytes: %ld\n", host.realtime, ret);
+
return ret;
// Why not ret / nmemb?
// Because CURLOPT_WRITEFUNCTION docs say to return the number of bytes.
code from libcurl, or 0, if another error has occurred.
====================
*/
-static qboolean Curl_Begin(const char *URL, const char *extraheaders, double maxspeed, const char *name, int loadtype, qboolean forthismap, const char *post_content_type, const unsigned char *postbuf, size_t postbufsize, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata);
+static qbool Curl_Begin(const char *URL, const char *extraheaders, double maxspeed, const char *name, int loadtype, qbool forthismap, const char *post_content_type, const unsigned char *postbuf, size_t postbufsize, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata);
static void Curl_EndDownload(downloadinfo *di, CurlStatus status, CURLcode error, const char *content_type_)
{
char content_type[64];
- qboolean ok = false;
+ qbool ok = false;
if(!curl_dll)
return;
switch(status)
if(ok && di->loadtype == LOADTYPE_PAK)
{
- ok = FS_AddPack(di->filename, NULL, true);
+ ok = FS_AddPack(di->filename, NULL, true, true);
if(!ok)
CLEAR_AND_RETRY();
}
CLEAR_AND_RETRY();
}
- if(di->prev)
- di->prev->next = di->next;
- else
- downloads = di->next;
- if(di->next)
- di->next->prev = di->prev;
+ List_Delete(&di->list);
--numdownloads;
if(di->forthismap)
if(numdownloads < cl_curl_maxdownloads.integer)
{
downloadinfo *di;
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
{
if(!di->started)
{
}
else
qcurl_easy_setopt(di->curle, CURLOPT_USERAGENT, "");
+ if(developer_curl.integer)
+ qcurl_easy_setopt(di->curle, CURLOPT_VERBOSE, (long) 1);
qcurl_easy_setopt(di->curle, CURLOPT_REFERER, di->referer);
qcurl_easy_setopt(di->curle, CURLOPT_RESUME_FROM, (long) di->startpos);
qcurl_easy_setopt(di->curle, CURLOPT_FOLLOWLOCATION, 1);
if(!curl_dll)
return;
if (Thread_HasThreads()) curl_mutex = Thread_CreateMutex();
- qcurl_global_init(CURL_GLOBAL_NOTHING);
+ qcurl_global_init(CURL_GLOBAL_SSL);
curlm = qcurl_multi_init();
}
downloadinfo *di;
if(!curl_dll)
return NULL;
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
if(!strcasecmp(di->filename, filename))
return di;
return NULL;
void Curl_Cancel_ToMemory(curl_callback_t callback, void *cbdata)
{
- downloadinfo *di;
+ downloadinfo *di, *ndi;
if(!curl_dll)
return;
- for(di = downloads; di; )
+ List_For_Each_Entry_Safe(di, ndi, &downloads, downloadinfo, list)
{
if(di->callback == callback && di->callback_data == cbdata)
{
di->callback = curl_quiet_callback; // do NOT call the callback
Curl_EndDownload(di, CURL_DOWNLOAD_ABORTED, CURLE_OK, NULL);
- di = downloads;
}
- else
- di = di->next;
}
}
if given) in the "dlcache/" folder.
====================
*/
-static qboolean Curl_Begin(const char *URL, const char *extraheaders, double maxspeed, const char *name, int loadtype, qboolean forthismap, const char *post_content_type, const unsigned char *postbuf, size_t postbufsize, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata)
+static qbool Curl_Begin(const char *URL, const char *extraheaders, double maxspeed, const char *name, int loadtype, qbool forthismap, const char *post_content_type, const unsigned char *postbuf, size_t postbufsize, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata)
{
if(buf)
if(loadtype != LOADTYPE_NONE)
{
if(loadtype == LOADTYPE_PAK)
{
- qboolean already_loaded;
- if(FS_AddPack(fn, &already_loaded, true))
+ qbool already_loaded;
+ if(FS_AddPack(fn, &already_loaded, true, true))
{
Con_DPrintf("%s already exists, not downloading!\n", fn);
if(already_loaded)
di->bytes_received_curl = 0;
di->bytes_sent_curl = 0;
di->extraheaders = extraheaders;
- di->next = downloads;
- di->prev = NULL;
- if(di->next)
- di->next->prev = di;
-
di->buffer = buf;
di->buffersize = bufsize;
if(callback == NULL)
di->postbufsize = 0;
}
- downloads = di;
- if (curl_mutex) Thread_UnlockMutex(curl_mutex);
+ List_Add(&di->list, &downloads);
+
+ if (curl_mutex)
+ Thread_UnlockMutex(curl_mutex);
+
return true;
}
}
-qboolean Curl_Begin_ToFile(const char *URL, double maxspeed, const char *name, int loadtype, qboolean forthismap)
+qbool Curl_Begin_ToFile(const char *URL, double maxspeed, const char *name, int loadtype, qbool forthismap)
{
return Curl_Begin(URL, NULL, maxspeed, name, loadtype, forthismap, NULL, NULL, 0, NULL, 0, NULL, NULL);
}
-qboolean Curl_Begin_ToMemory(const char *URL, double maxspeed, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata)
+qbool Curl_Begin_ToMemory(const char *URL, double maxspeed, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata)
{
return Curl_Begin(URL, NULL, maxspeed, NULL, false, false, NULL, NULL, 0, buf, bufsize, callback, cbdata);
}
-qboolean Curl_Begin_ToMemory_POST(const char *URL, const char *extraheaders, double maxspeed, const char *post_content_type, const unsigned char *postbuf, size_t postbufsize, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata)
+qbool Curl_Begin_ToMemory_POST(const char *URL, const char *extraheaders, double maxspeed, const char *post_content_type, const unsigned char *postbuf, size_t postbufsize, unsigned char *buf, size_t bufsize, curl_callback_t callback, void *cbdata)
{
return Curl_Begin(URL, extraheaders, maxspeed, NULL, false, false, post_content_type, postbuf, postbufsize, buf, bufsize, callback, cbdata);
}
/*
====================
-Curl_Run
+Curl_Frame
call this regularily as this will always download as much as possible without
blocking.
====================
*/
-void Curl_Run(void)
+void Curl_Frame(void)
{
double maxspeed;
downloadinfo *di;
Curl_CheckCommandWhenDone();
- if(!downloads)
+ if(List_Is_Empty(&downloads))
{
if (curl_mutex) Thread_UnlockMutex(curl_mutex);
return;
}
- if(realtime < curltime) // throttle
+ if(host.realtime < curltime) // throttle
{
if (curl_mutex) Thread_UnlockMutex(curl_mutex);
return;
}
while(mc == CURLM_CALL_MULTI_PERFORM);
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
{
double b = 0;
if(di->curle)
// use the slowest allowing download to derive the maxspeed... this CAN
// be done better, but maybe later
maxspeed = cl_curl_maxspeed.value;
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
if(di->maxspeed > 0)
if(di->maxspeed < maxspeed || maxspeed <= 0)
maxspeed = di->maxspeed;
if(maxspeed > 0)
{
double bytes = bytes_sent + bytes_received; // maybe smoothen a bit?
- curltime = realtime + bytes / (maxspeed * 1024.0);
+ curltime = host.realtime + bytes / (maxspeed * 1024.0);
bytes_sent = 0;
bytes_received = 0;
}
else
- curltime = realtime;
+ curltime = host.realtime;
if (curl_mutex) Thread_UnlockMutex(curl_mutex);
}
+/*
+====================
+Curl_Select
+
+Sleeps until there's some transfer progress or a timeout is reached,
+unfortunately the timeout is only in milliseconds.
+This allows good throughput even at very low FPS.
+====================
+*/
+void Curl_Select(double *microseconds)
+{
+ if (List_Is_Empty(&downloads))
+ return;
+ if (qcurl_multi_poll(curlm, NULL, 0, *microseconds / 1000, NULL) == CURLM_OK)
+ *microseconds = 0; // either we finished waiting or a transfer progressed
+ else
+ Con_Print("There's an emergency going on!\nIt's still going on!\nMaybe you need to upgrade libcurl?\n");
+}
+
/*
====================
Curl_CancelAll
if (curl_mutex) Thread_LockMutex(curl_mutex);
- while(downloads)
+ while(!List_Is_Empty(&downloads))
{
- Curl_EndDownload(downloads, CURL_DOWNLOAD_ABORTED, CURLE_OK, NULL);
+ Curl_EndDownload(List_First_Entry(&downloads, downloadinfo, list), CURL_DOWNLOAD_ABORTED, CURLE_OK, NULL);
// INVARIANT: downloads will point to the next download after that!
}
====================
Curl_Running
-returns true iff there is a download running.
+returns true if there is a download running.
====================
*/
-qboolean Curl_Running(void)
+qbool Curl_Running(void)
{
if(!curl_dll)
return false;
- return downloads != NULL;
+ return !List_Is_Empty(&downloads);
}
/*
{
if (curl_mutex) Thread_LockMutex(curl_mutex);
Con_Print("Currently running downloads:\n");
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
{
double speed, percent;
Con_Printf(" %s -> %s ", CleanURL(di->url, urlbuf, sizeof(urlbuf)), di->filename);
int i;
int end;
int loadtype = LOADTYPE_NONE;
- qboolean forthismap = false;
+ qbool forthismap = false;
const char *url;
const char *name = 0;
Cvar_RegisterVariable (&sv_curl_maxspeed);
Cvar_RegisterVariable (&cl_curl_useragent);
Cvar_RegisterVariable (&cl_curl_useragent_append);
- Cmd_AddCommand(CMD_CLIENT | CMD_CLIENT_FROM_SERVER, "curl", Curl_Curl_f, "download data from an URL and add to search path");
- //Cmd_AddCommand(&cmd_client, "curlcat", Curl_CurlCat_f, "display data from an URL (debugging command)");
+ Cvar_RegisterVariable (&developer_curl);
+ Cmd_AddCommand(CF_CLIENT | CF_CLIENT_FROM_SERVER, "curl", Curl_Curl_f, "download data from an URL and add to search path");
+ //Cmd_AddCommand(cmd_local, "curlcat", Curl_CurlCat_f, "display data from an URL (debugging command)");
}
/*
if (curl_mutex) Thread_LockMutex(curl_mutex);
i = 0;
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
++i;
downinfo = (Curl_downloadinfo_t *) Z_Malloc(sizeof(*downinfo) * i);
i = 0;
- for(di = downloads; di; di = di->next)
+ List_For_Each_Entry(di, &downloads, downloadinfo, list)
{
// do not show infobars for background downloads
if(developer.integer <= 0)
// read lines of format "pattern url"
char *p = buf;
char *pattern = NULL, *patternend = NULL, *url = NULL, *urlend = NULL;
- qboolean eof = false;
+ qbool eof = false;
pattern = p;
while(!eof)
curl --finish_autodownload
====================
*/
-static qboolean Curl_SendRequirement(const char *filename, qboolean foundone, char *sendbuffer, size_t sendbuffer_len)
+static qbool Curl_SendRequirement(const char *filename, qbool foundone, char *sendbuffer, size_t sendbuffer_len)
{
const char *p;
const char *thispack = FS_WhichPack(filename);
// for each requirement, find the pack name
char sendbuffer[4096] = "";
requirement *req;
- qboolean foundone = false;
+ qbool foundone = false;
const char *p;
for(req = requirements; req; req = req->next)
strlcat(sendbuffer, "curl --finish_autodownload\n", sizeof(sendbuffer));
if(strlen(sendbuffer) + 1 < sizeof(sendbuffer))
- Host_ClientCommands("%s", sendbuffer);
+ SV_ClientCommands("%s", sendbuffer);
else
Con_Printf("Could not initiate autodownload due to URL buffer overflow\n");
}