download.h

//@AUTOHEADER@BEGIN@
/***********************************************************************\
|                    Drift Standard Libraries v1.01                     |
|            Copyright 2010-2023 Drift Solutions / Indy Sams            |
| Docs and more information available at https://www.driftsolutions.dev |
|          This file released under the 3-clause BSD license,           |
|            see included DSL.LICENSE.TXT file for details.             |
\***********************************************************************/
//@AUTOHEADER@END@
 
#ifndef __DSL_DOWNLOAD_H__
#define __DSL_DOWNLOAD_H__
 
#include <drift/rwops.h>
#include <drift/sockets3.h>
 
typedef bool (*DSL_Download_Callback)(uint64 got, uint64 fullsize, void * user_ptr);
 
enum DSL_Download_Errors : uint8 {
    TD_NO_ERROR,
 
    TD_FILE_ACCESS,
    TD_ERROR_CONNECTING,
    TD_INVALID_RESPONSE,
    TD_ERROR_CREATING_SOCKET,
    TD_ERROR_INITIALIZING_LIB,
 
    TD_FILE_WRITE_ERROR,
    TD_INVALID_URL,
    TD_CALLBACK_ABORT, // when the callback returns false, Download returns false and sets error to this
    TD_INVALID_PROTOCOL,
    TD_FILE_NOT_FOUND,
    TD_REDIRECT,
    TD_TIMEOUT,
    TD_BAD_USER_PASS,
    TD_NUM_ERRORS
};
 
class DSL_API_CLASS DSL_Download_Base {
protected:
    DSL_Download_Errors error = TD_INVALID_PROTOCOL;
public:
#ifndef DOXYGEN_SKIP
    virtual ~DSL_Download_Base();
#endif
 
    virtual bool SetURL(const string& url) = 0;
    virtual void SetCallback(DSL_Download_Callback callback, void * user_ptr = NULL) = 0;
    virtual void SetUserPass(const string& user, const string& pass) = 0;
 
    virtual bool Download(const string& SaveAs); 
    virtual bool Download(FILE * fWriteTo); 
    virtual bool Download(DSL_FILE * fWriteTo) = 0;
    virtual void SetTimeout(uint32 millisec) = 0;
    virtual void SetUserAgent(const string& ua) = 0;
    virtual void FollowRedirects(bool follow) = 0;
 
    virtual DSL_Download_Errors GetError();
    virtual const char * GetErrorString();
};
 
class DSL_API_CLASS DSL_Download_NoCurl: public DSL_Download_Base {
private:
    string host, path, user_agent;
    uint16 port = 0;
    bool followRedirects = false;
    uint32 timeo = 0;
    string user, pass;
    DSL_Sockets3_Base * socks = NULL;
    DSL_Download_Callback callback = NULL;
    void * u_ptr = NULL; 
public:
    DSL_Download_NoCurl(const string& url = "", DSL_Download_Callback callback = NULL, const string& user = "", const string& pass = "", void * user_ptr = NULL);
    virtual ~DSL_Download_NoCurl();
 
    virtual bool SetURL(const string& url);
    virtual bool GetURL(string& str);
    virtual void SetCallback(DSL_Download_Callback callback, void * user_ptr = NULL);
    virtual void SetUserPass(const string& user, const string& pass);
 
    virtual bool Download(DSL_FILE * fWriteTo);
    virtual bool Download(FILE * fWriteTo) { return DSL_Download_Base::Download(fWriteTo); }
    virtual bool Download(const string& fSaveAs) { return DSL_Download_Base::Download(fSaveAs); }
 
    virtual void SetTimeout(uint32 millisec);
    virtual void SetUserAgent(const string& ua);
    virtual void FollowRedirects(bool follow = true);
};
 
#if defined(ENABLE_CURL) || defined(DOXYGEN_SKIP)
#include <drift/curl/curl.h>
#define DSL_Download DSL_Download_Curl
#else
#define DSL_Download DSL_Download_NoCurl
#endif
 
#endif // __DSL_DOWNLOAD_H__