C4HTTPClient Class Reference

#include <C4HTTP.h>

Inheritance diagram for C4HTTPClient:

Collaboration diagram for C4HTTPClient:

Public Types
enum	ResponseType { NoPreference , XML }

Public Member Functions
	C4HTTPClient ()
	~C4HTTPClient () override
bool	Init ()
bool	Query (const StdBuf &Data, bool fBinary)
bool	Query (const char *szData, bool fBinary)
bool	isBusy () const
bool	isConnected () const
bool	isSuccess () const
size_t	getTotalSize () const
size_t	getDownloadedSize () const
const StdBuf &	getResultBin () const
const char *	getResultString () const
const char *	getURL () const
const char *	getServerName () const
const C4NetIO::addr_t &	getServerAddress () const
virtual const char *	GetError () const
void	ResetError ()
void	Cancel (const char *szReason)
void	Clear ()
bool	SetServer (const char *szServerAddress)
void	SetExpectedResponseType (ResponseType type)
void	SetNotify (class C4InteractiveThread *pnNotify)
bool	Execute (int iMaxTime=-1, pollfd *readyfds=nullptr) override
C4TimeMilliseconds	GetNextTick (C4TimeMilliseconds tNow) override
void	GetFDs (std::vector< struct pollfd > &) override
bool	ExecuteUntil (int iTimeout=-1)
bool	IsSignaled ()
virtual bool	IsLowPriority ()
virtual bool	IsNotify ()
virtual uint32_t	TimerInterval ()

Protected Member Functions
void	SetError (const char *strnError)
void	Changed ()

Protected Attributes
StdCopyBuf	ResultBin
StdCopyStrBuf	ResultString
StdCopyStrBuf	Error

Detailed Description

Definition at line 33 of file C4HTTP.h.

Member Enumeration Documentation

ResponseType

enum C4HTTPClient::ResponseType

Enumerator
NoPreference
XML

Definition at line 103 of file C4HTTP.h.

{ NoPreference, XML };

Constructor & Destructor Documentation

C4HTTPClient()

C4HTTPClient::C4HTTPClient

(

)

Definition at line 27 of file C4HTTP.cpp.

{
}

~C4HTTPClient()

C4HTTPClient::~C4HTTPClient ( )

override

Definition at line 31 of file C4HTTP.cpp.

{
    Cancel(nullptr);
    if (MultiHandle)
        curl_multi_cleanup(MultiHandle);
#ifdef STDSCHEDULER_USE_EVENTS
    if (Event != nullptr)
        WSACloseEvent(Event);
#endif
}

References Cancel().

Here is the call graph for this function:

Member Function Documentation

Cancel()

void C4HTTPClient::Cancel

(

const char *

szReason

)

Definition at line 277 of file C4HTTP.cpp.

{
    if (CurlHandle)
    {
        curl_multi_remove_handle(MultiHandle, CurlHandle);
        curl_easy_cleanup(CurlHandle);
        CurlHandle = nullptr;
    }
    fBinary = false;
    iDownloadedSize = iTotalSize = 0;
    Error = szReason;
}

References Error.

Referenced by Clear(), C4StartupNetListEntry::Execute(), Query(), C4DownloadDlg::UserClose(), and ~C4HTTPClient().

Here is the caller graph for this function:

Changed()

void StdSchedulerProc::Changed ( )

protectedinherited

Definition at line 108 of file StdScheduler.cpp.

{
    auto s = scheduler;
    if (s)
        s->Changed(this);
}

References s.

Referenced by C4NetIOTCP::Accept(), C4NetIOTCP::AddConnectWait(), C4NetIOUDP::AddPeer(), C4NetIOTCP::Listen(), and CStdTimerProc::SetDelay().

Here is the caller graph for this function:

Clear()

void C4HTTPClient::Clear

(

)

Definition at line 290 of file C4HTTP.cpp.

{
    Cancel(nullptr);
    ServerAddr.Clear();
    ResultBin.Clear();
    ResultString.Clear();
}

References Cancel(), StdBuf::Clear(), StdStrBuf::Clear(), C4NetIO::EndpointAddress::Clear(), ResultBin, and ResultString.

Referenced by C4Network2::StreamOut().

Here is the call graph for this function:

Here is the caller graph for this function:

Execute()

bool C4HTTPClient::Execute ( int  iMaxTime = -1, pollfd *  readyfds = nullptr  )

overridevirtual

Implements StdSchedulerProc.

Definition at line 59 of file C4HTTP.cpp.

{
    int running;
#ifdef STDSCHEDULER_USE_EVENTS
    // On Windows, StdScheduler doesn't inform us about which fd triggered the
    // event, so we have to check manually.
    if (WaitForSingleObject(Event, 0) == WAIT_OBJECT_0)
    {
        // sockets might be modified during the call to curl_multi_socket_action() below.
        auto sockets_tmp = sockets;
        for (const auto& kv : sockets_tmp)
        {
            auto socket = kv.first;
            WSANETWORKEVENTS NetworkEvents;
            if (WSAEnumNetworkEvents(socket, Event, &NetworkEvents) != SOCKET_ERROR)
            {
                int ev_bitmask = 0;
                if (NetworkEvents.lNetworkEvents & (FD_READ|FD_ACCEPT|FD_CLOSE)) ev_bitmask |= CURL_CSELECT_IN;
                if (NetworkEvents.lNetworkEvents & (FD_WRITE|FD_CONNECT))        ev_bitmask |= CURL_CSELECT_OUT;
                curl_multi_socket_action(MultiHandle, socket, ev_bitmask, &running);
            }
        }
    }
#else
    if (readyfd)
    {
        int ev_bitmask = 0;
        if (readyfd->revents & POLLIN)  ev_bitmask |= CURL_CSELECT_IN;
        if (readyfd->revents & POLLOUT) ev_bitmask |= CURL_CSELECT_OUT;
        if (readyfd->revents & POLLERR) ev_bitmask |= CURL_CSELECT_ERR;
        curl_multi_socket_action(MultiHandle, readyfd->fd, ev_bitmask, &running);
    }
#endif
    else
    {
        curl_multi_socket_action(MultiHandle, CURL_SOCKET_TIMEOUT, 0, &running);
    }
 
    CURLMsg *m;
    do {
        int msgq = 0;
        m = curl_multi_info_read(MultiHandle, &msgq);
        if(m && (m->msg == CURLMSG_DONE)) {
            CURL *e = m->easy_handle;
            assert(e == CurlHandle);
            CurlHandle = nullptr;
            curl_multi_remove_handle(MultiHandle, e);
 
            // Check for errors and notify listeners. Note that curl fills
            // the Error buffer automatically.
            fSuccess = m->data.result == CURLE_OK;
            if (!fSuccess && !*Error.getData())
                Error.Copy(curl_easy_strerror(m->data.result));
            char *ip;
            curl_easy_getinfo(e, CURLINFO_PRIMARY_IP, &ip);
            ServerAddr.SetHost(StdStrBuf(ip));
            if (pNotify)
                pNotify->PushEvent(Ev_HTTP_Response, this);
 
            curl_easy_cleanup(e);
        }
    } while(m);
 
    return true;
}

References StdStrBuf::Copy(), Error, Ev_HTTP_Response, StdStrBuf::getData(), C4InteractiveThread::PushEvent(), C4NetIO::HostAddress::SetHost(), and SOCKET_ERROR.

Referenced by C4DownloadDlg::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

ExecuteUntil()

bool StdSchedulerProc::ExecuteUntil ( int  iTimeout = -1 )

inherited

Definition at line 33 of file StdScheduler.cpp.

{
    // Infinite?
    if (iTimeout < 0)
        for (;;)
            if (!Execute())
                return false;
    // Calculate endpoint
    C4TimeMilliseconds tStopTime = C4TimeMilliseconds::Now() + iTimeout;
    for (;;)
    {
        // Call execute with given timeout
        if (!Execute(std::max(iTimeout, 0)))
            return false;
        // Calculate timeout
        C4TimeMilliseconds tTime = C4TimeMilliseconds::Now();
        if (tTime >= tStopTime)
            break;
        iTimeout = tStopTime - tTime;
    }
    // All ok.
    return true;
}

References StdSchedulerProc::Execute(), and C4TimeMilliseconds::Now().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

getDownloadedSize()

size_t C4HTTPClient::getDownloadedSize ( ) const

inline

Definition at line 90 of file C4HTTP.h.

{ return iDownloadedSize; }

Referenced by C4DownloadDlg::OnIdle().

Here is the caller graph for this function:

GetError()

virtual const char* C4HTTPClient::GetError ( ) const

inlinevirtual

Definition at line 96 of file C4HTTP.h.

{ return Error.getData(); }

References Error, and StdStrBuf::getData().

Referenced by C4DownloadDlg::GetError(), C4Network2::InitLeague(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdate(), C4Network2::LeagueUpdateProcessReply(), C4StartupNetListEntry::OnReference(), and C4StartupNetListEntry::SetRefQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

GetFDs()

void C4HTTPClient::GetFDs ( std::vector< struct pollfd > &  pollfds )

overridevirtual

Reimplemented from StdSchedulerProc.

Definition at line 135 of file C4HTTP.cpp.

{
    for (const auto& kv : sockets)
    {
        pollfd pfd;
        pfd.fd = kv.first;
        pfd.revents = 0;
        switch (kv.second)
        {
        case CURL_POLL_IN:
            pfd.events = POLLIN; break;
        case CURL_POLL_OUT:
            pfd.events = POLLOUT; break;
        case CURL_POLL_INOUT:
            pfd.events = POLLIN | POLLOUT; break;
        default:
            pfd.events = 0;
        }
        pollfds.push_back(pfd);
    }
}

GetNextTick()

C4TimeMilliseconds C4HTTPClient::GetNextTick ( C4TimeMilliseconds  tNow )

overridevirtual

Reimplemented from StdSchedulerProc.

Definition at line 125 of file C4HTTP.cpp.

{
    long timeout;
    curl_multi_timeout(MultiHandle, &timeout);
    if (timeout < 0)
        timeout = 1000;
    return tNow + timeout;
}

getResultBin()

const StdBuf& C4HTTPClient::getResultBin ( ) const

inline

Definition at line 91 of file C4HTTP.h.

{ assert(fBinary); return ResultBin; }

References ResultBin.

Referenced by C4DownloadDlg::ShowModal().

Here is the caller graph for this function:

getResultString()

const char* C4HTTPClient::getResultString ( ) const

inline

Definition at line 92 of file C4HTTP.h.

{ assert(!fBinary); return ResultString.getData(); }

References StdStrBuf::getData(), and ResultString.

Here is the call graph for this function:

getServerAddress()

const C4NetIO::addr_t& C4HTTPClient::getServerAddress ( ) const

inline

Definition at line 95 of file C4HTTP.h.

{ return ServerAddr; }

Referenced by C4Network2RefClient::GetReferences().

Here is the caller graph for this function:

getServerName()

const char* C4HTTPClient::getServerName ( ) const

inline

Definition at line 94 of file C4HTTP.h.

{ return ServerName.getData(); }

References StdStrBuf::getData().

Referenced by C4StartupNetListEntry::GetJoinAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuth(), C4Network2::LeagueStart(), and C4StartupNetListEntry::SetRefQuery().

Here is the call graph for this function:

Here is the caller graph for this function:

getTotalSize()

size_t C4HTTPClient::getTotalSize ( ) const

inline

Definition at line 89 of file C4HTTP.h.

{ return iTotalSize; }

Referenced by C4DownloadDlg::OnIdle().

Here is the caller graph for this function:

getURL()

const char* C4HTTPClient::getURL ( ) const

inline

Definition at line 93 of file C4HTTP.h.

{ return URL.getData(); }

References StdStrBuf::getData().

Referenced by C4DownloadDlg::OnIdle().

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool C4HTTPClient::Init

(

)

Definition at line 42 of file C4HTTP.cpp.

{
    MultiHandle = curl_multi_init();
    if (!MultiHandle) return false;
#ifdef STDSCHEDULER_USE_EVENTS
    if ((Event = WSACreateEvent()) == WSA_INVALID_EVENT)
    {
        SetError("could not create socket event");
        curl_multi_cleanup(MultiHandle);
        return false;
    }
#endif
    curl_multi_setopt(MultiHandle, CURLMOPT_SOCKETFUNCTION, &C4HTTPClient::SSocketCallback);
    curl_multi_setopt(MultiHandle, CURLMOPT_SOCKETDATA, this);
    return true;
}

References SetError().

Referenced by C4StartupNetDlg::CheckVersionUpdate(), C4Network2::InitLeague(), C4Game::InitNetworkFromAddress(), C4StartupNetListEntry::SetRefQuery(), C4DownloadDlg::ShowModal(), and C4Network2::StartStreaming().

Here is the call graph for this function:

Here is the caller graph for this function:

isBusy()

bool C4HTTPClient::isBusy ( ) const

inline

Definition at line 86 of file C4HTTP.h.

{ return !!CurlHandle; }

Referenced by C4StartupNetListEntry::Execute(), C4Network2::Execute(), C4Network2RefClient::GetReferences(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuth(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdate(), C4Network2::LeagueUpdateProcessReply(), C4Network2::LeagueWaitNotBusy(), C4DownloadDlg::OnIdle(), C4StartupNetListEntry::OnReference(), and C4Network2::StreamOut().

Here is the caller graph for this function:

isConnected()

bool C4HTTPClient::isConnected ( ) const

inline

Definition at line 87 of file C4HTTP.h.

{ return iDownloadedSize + iTotalSize != 0; }

Referenced by C4DownloadDlg::OnIdle().

Here is the caller graph for this function:

IsLowPriority()

virtual bool StdSchedulerProc::IsLowPriority ( )

inlinevirtualinherited

Definition at line 82 of file StdScheduler.h.

{ return false; }

IsNotify()

virtual bool StdSchedulerProc::IsNotify ( )

inlinevirtualinherited

Reimplemented in CStdNotifyProc, and C4NetIO.

Definition at line 83 of file StdScheduler.h.

{ return false; }

IsSignaled()

bool StdSchedulerProc::IsSignaled ( )

inherited

isSuccess()

bool C4HTTPClient::isSuccess ( ) const

inline

Definition at line 88 of file C4HTTP.h.

{ return fSuccess; }

Referenced by C4Network2RefClient::GetReferences(), C4LeagueClient::GetStartReply(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), C4Game::InitNetworkFromAddress(), C4Network2::LeagueEnd(), C4Network2::LeaguePlrAuthCheck(), C4Network2::LeagueStart(), C4Network2::LeagueUpdateProcessReply(), C4DownloadDlg::OnIdle(), C4StartupNetListEntry::OnReference(), and C4Network2::StreamOut().

Here is the caller graph for this function:

Query() [1/2]

bool C4HTTPClient::Query ( const char *  szData, bool  fBinary  )

inline

Definition at line 84 of file C4HTTP.h.

{ return Query(StdBuf(szData, SLen(szData)), fBinary); }

References Query(), and SLen().

Referenced by Query().

Here is the call graph for this function:

Here is the caller graph for this function:

Query() [2/2]

bool C4HTTPClient::Query	(	const StdBuf &	Data,
		bool	fBinary
	)

Definition at line 158 of file C4HTTP.cpp.

{
    if (URL.isNull()) return false;
    // Cancel previous request
    if (CurlHandle)
        Cancel("Cancelled");
    // No result known yet
    ResultString.Clear();
    // store mode
    this->fBinary = fBinary;
    // Create request
    CURL *curl = curl_easy_init();
    if (!curl) return false;
#ifdef C4HTTP_DEBUG
    curl_easy_setopt(curl, CURLOPT_VERBOSE, 1);
#endif
    curl_easy_setopt(curl, CURLOPT_URL, URL.getData());
    curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");
    curl_easy_setopt(curl, CURLOPT_USERAGENT, C4ENGINENAME "/" C4VERSION );
    curl_easy_setopt(curl, CURLOPT_TIMEOUT, C4HTTPQueryTimeout);
    curl_slist *headers = nullptr;
    headers = curl_slist_append(headers, "Accept-Charset: utf-8");
    headers = curl_slist_append(headers, FormatString("Accept-Language: %s", Config.General.LanguageEx).getData());
    if (!headerAcceptedResponseType.empty())
        headers = curl_slist_append(headers, headerAcceptedResponseType.c_str());
 
    if (Data.getSize())
    {
        RequestData = Data;
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, RequestData.getData());
        curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, RequestData.getSize());
        // Disable the Expect: 100-Continue header which curl automatically
        // adds for POST requests.
        headers = curl_slist_append(headers, "Expect:");
        headers = curl_slist_append(headers, "Content-Type: text/plain; charset=utf-8");
    }
 
    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
    curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, &C4HTTPClient::SWriteCallback);
    curl_easy_setopt(curl, CURLOPT_WRITEDATA, this);
    curl_easy_setopt(curl, CURLOPT_XFERINFOFUNCTION, &C4HTTPClient::SProgressCallback);
    curl_easy_setopt(curl, CURLOPT_XFERINFODATA, this);
    Error.Clear();
    Error.SetLength(CURL_ERROR_SIZE);
    *Error.getMData() = '\0';
    curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, Error.getMData());
 
    curl_multi_add_handle(MultiHandle, curl);
    CurlHandle = curl;
    iDownloadedSize = iTotalSize = 0;
 
    int running;
    curl_multi_socket_action(MultiHandle, CURL_SOCKET_TIMEOUT, 0, &running);
 
    return true;
}

References C4HTTPQueryTimeout, Cancel(), StdStrBuf::Clear(), Config, Error, FormatString(), C4Config::General, StdBuf::getData(), StdStrBuf::getData(), StdStrBuf::getMData(), StdBuf::getSize(), StdStrBuf::isNull(), C4ConfigGeneral::LanguageEx, ResultString, and StdStrBuf::SetLength().

Referenced by C4LeagueClient::Auth(), C4LeagueClient::AuthCheck(), C4LeagueClient::End(), C4Network2RefClient::QueryReferences(), C4Network2UpdateClient::QueryUpdateURL(), C4LeagueClient::ReportDisconnect(), C4DownloadDlg::ShowModal(), C4LeagueClient::Start(), C4Network2::StreamOut(), and C4LeagueClient::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

ResetError()

void C4HTTPClient::ResetError ( )

inline

Definition at line 97 of file C4HTTP.h.

{ Error.Clear(); }

References StdStrBuf::Clear(), and Error.

Referenced by C4Network2RefClient::GetReferences().

Here is the call graph for this function:

Here is the caller graph for this function:

SetError()

void C4HTTPClient::SetError ( const char *  strnError )

inlineprotected

Definition at line 80 of file C4HTTP.h.

{ Error = strnError; }

References Error.

Referenced by C4Network2RefClient::GetReferences(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), Init(), and SetServer().

Here is the caller graph for this function:

SetExpectedResponseType()

void C4HTTPClient::SetExpectedResponseType

(

C4HTTPClient::ResponseType

type

)

Definition at line 315 of file C4HTTP.cpp.

{
    switch (type)
    {
    case C4HTTPClient::ResponseType::XML:
        headerAcceptedResponseType = "Accept: application/xml";
        break;
    case C4HTTPClient::ResponseType::NoPreference: // fallthrough
    default:
        headerAcceptedResponseType = "";
        break;
    };
}

SetNotify()

void C4HTTPClient::SetNotify ( class C4InteractiveThread *  pnNotify )

inline

Definition at line 106 of file C4HTTP.h.

{ pNotify = pnNotify; }

Referenced by C4StartupNetDlg::CheckVersionUpdate(), and C4StartupNetListEntry::SetRefQuery().

Here is the caller graph for this function:

SetServer()

bool C4HTTPClient::SetServer

(

const char *

szServerAddress

)

Definition at line 298 of file C4HTTP.cpp.

{
    static std::regex HostnameRegex(R"(^(:?[a-z]+:\/\/)?([^/:]+).*)", std::regex::icase);
    std::cmatch match;
    if (std::regex_match(szServerAddress, match, HostnameRegex))
    {
        // CURL validates URLs only on connect.
        URL.Copy(szServerAddress);
        ServerName.Copy(match[2].str().c_str());
        return true;
    }
    // The HostnameRegex above is pretty stupid, so we will reject only very
    // malformed URLs immediately.
    SetError("Malformed URL");
    return false;
}

References StdStrBuf::Copy(), and SetError().

Referenced by C4StartupNetDlg::CheckVersionUpdate(), C4Network2::InitLeague(), C4Game::InitNetworkFromAddress(), C4StartupNetListEntry::SetRefQuery(), C4DownloadDlg::ShowModal(), and C4Network2::StreamOut().

Here is the call graph for this function:

Here is the caller graph for this function:

TimerInterval()

virtual uint32_t StdSchedulerProc::TimerInterval ( )

inlinevirtualinherited

Reimplemented in CStdTimerProc.

Definition at line 84 of file StdScheduler.h.

{ return 0; }

Member Data Documentation

Error

StdCopyStrBuf C4HTTPClient::Error

protected

Definition at line 79 of file C4HTTP.h.

Referenced by Cancel(), Execute(), GetError(), Query(), ResetError(), and SetError().

ResultBin

StdCopyBuf C4HTTPClient::ResultBin

protected

Definition at line 77 of file C4HTTP.h.

Referenced by Clear(), and getResultBin().

ResultString

StdCopyStrBuf C4HTTPClient::ResultString

protected

Definition at line 78 of file C4HTTP.h.

Referenced by Clear(), C4LeagueClient::GetAuthCheckReply(), C4LeagueClient::GetAuthReply(), C4LeagueClient::GetEndReply(), C4Network2RefClient::GetReferences(), C4LeagueClient::GetReportDisconnectReply(), getResultString(), C4LeagueClient::GetStartReply(), C4LeagueClient::GetUpdateReply(), C4Network2UpdateClient::GetUpdateURL(), C4Network2UpdateClient::GetVersion(), and Query().

---

The documentation for this class was generated from the following files:

• C4HTTP.h
• C4HTTP.cpp