#include <CurlHandleManager.h>

Collaboration diagram for audacity::network_manager::CurlHandleManager::Handle:

Classes
struct	Result

Public Member Functions
	Handle (Handle &&rhs) noexcept

	~Handle () noexcept

Handle &	operator= (Handle &&rhs) noexcept

template<typename... Args>
CURLcode	setOption (CURLoption option, Args... value) noexcept

CURLcode	setOption (CURLoption option, const std::string &value) noexcept

CURLcode	appendCookie (const Cookie &cookie) noexcept

CURLcode	appendCookies (const CookiesList &cookie) noexcept

void	appendHeader (const Header &header)

void	appendHeaders (const HeadersList &headers)

Result	perform ()

void	markKeepAlive ()

bool	isHandleFromCache () const noexcept

unsigned	getHTTPCode () const noexcept

void	reset () noexcept

CURL *	getCurlHandle () const noexcept

void	disableSSLValidation ()

void	enableSSLValidation ()

Private Member Functions
	Handle (CurlHandleManager owner, CURL handle, RequestVerb verb, std::string url) noexcept

Private Attributes
CURL *	mHandle { nullptr }

CurlHandleManager *	mOwner { nullptr }

RequestVerb	mVerb

std::string	mUrl

CurlStringList	mHeaders

bool	mUserAgentSet { false }

bool	mReuse { false }

bool	mHandleFromCache { false }

Friends
class	CurlHandleManager

Detailed Description

Definition at line 34 of file CurlHandleManager.h.

Constructor & Destructor Documentation

◆ Handle() [1/2]

audacity::network_manager::CurlHandleManager::Handle::Handle	(	CurlHandleManager *	owner,
		CURL *	handle,
		RequestVerb	verb,
		std::string	url
	)

privatenoexcept

Definition at line 87 of file CurlHandleManager.cpp.

    : mHandle (handle),
    mOwner (owner),
    mVerb (verb),
    mUrl (std::move (url)),
    mHandleFromCache (handle != nullptr)
{
    if (mHandle == nullptr)
        mHandle = curl_easy_init ();
 
    setOption (CURLOPT_URL, mUrl);
        
    switch (verb)
    {
    case RequestVerb::Head:
        setOption (CURLOPT_NOBODY, 1);
        break;
    case RequestVerb::Get:
        // This is a default, no additional setup is needed
        // We cache handles by the verb, so there is no need to 
        // reset the handle state
        break;
    case RequestVerb::Post:
        setOption (CURLOPT_POST, 1);
        break;
    case RequestVerb::Put:
        setOption (CURLOPT_UPLOAD, 1);
        break;
    case RequestVerb::Delete:
        setOption (CURLOPT_CUSTOMREQUEST, "DELETE");
        break;
    case RequestVerb::Patch:
       setOption(CURLOPT_UPLOAD, 1);
       setOption(CURLOPT_CUSTOMREQUEST, "PATCH");
       break;
    }
 
    setOption (CURLOPT_NOSIGNAL, 1L);
 
    if (gCurlConfig.SSLValidation)
       enableSSLValidation();
    else
      disableSSLValidation();
 
    setOption (CURLOPT_ACCEPT_ENCODING, "");
}

References audacity::network_manager::Delete, audacity::network_manager::anonymous_namespace{CurlHandleManager.cpp}::gCurlConfig, audacity::network_manager::Get, audacity::network_manager::Head, audacity::network_manager::Patch, audacity::network_manager::Post, audacity::network_manager::Put, and audacity::network_manager::anonymous_namespace{CurlHandleManager.cpp}::CurlConfig::SSLValidation.

◆ Handle() [2/2]

audacity::network_manager::CurlHandleManager::Handle::Handle ( Handle && rhs )

noexcept

Definition at line 134 of file CurlHandleManager.cpp.

{
    *this = std::move (rhs);
}

◆ ~Handle()

audacity::network_manager::CurlHandleManager::Handle::~Handle ( )

noexcept

Definition at line 139 of file CurlHandleManager.cpp.

{
    if (mReuse)
        mOwner->cacheHandle (*this);
    else
        curl_easy_cleanup (mHandle);
}

References audacity::network_manager::CurlHandleManager::cacheHandle(), mHandle, mOwner, and mReuse.

Here is the call graph for this function:

Member Function Documentation

◆ appendCookie()

CURLcode audacity::network_manager::CurlHandleManager::Handle::appendCookie ( const Cookie & cookie )

noexcept

Definition at line 168 of file CurlHandleManager.cpp.

{
    return setOption(CURLOPT_COOKIE, "Set-Cookie: " + cookie.Name + "=" + cookie.Value);
}

◆ appendCookies()

CURLcode audacity::network_manager::CurlHandleManager::Handle::appendCookies ( const CookiesList & cookie )

noexcept

Definition at line 173 of file CurlHandleManager.cpp.

{
    for (const Cookie& cookie : cookies)
    {
        const CURLcode result = appendCookie (cookie);
 
        if (result != CURLE_OK)
            return result;
    }
 
    return CURLE_OK;
}

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the caller graph for this function:

◆ appendHeader()

void audacity::network_manager::CurlHandleManager::Handle::appendHeader ( const Header & header )

Definition at line 186 of file CurlHandleManager.cpp.

{
    if (header.hasSameName ("User-Agent"))
        mUserAgentSet = true;
 
    mHeaders.append(header.Name + ": " + header.Value);
}

References audacity::network_manager::Header::hasSameName(), audacity::network_manager::Header::Name, and audacity::network_manager::Header::Value.

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendHeaders()

void audacity::network_manager::CurlHandleManager::Handle::appendHeaders ( const HeadersList & headers )

Definition at line 194 of file CurlHandleManager.cpp.

{
    for (const Header& header : headers)
        appendHeader (header);
}

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the caller graph for this function:

◆ disableSSLValidation()

void audacity::network_manager::CurlHandleManager::Handle::disableSSLValidation ( )

Definition at line 254 of file CurlHandleManager.cpp.

{
   setOption(CURLOPT_SSL_VERIFYPEER, 0L);
   setOption(CURLOPT_SSL_VERIFYHOST, 0L);
}

◆ enableSSLValidation()

void audacity::network_manager::CurlHandleManager::Handle::enableSSLValidation ( )

Definition at line 260 of file CurlHandleManager.cpp.

{
   setOption(CURLOPT_SSL_VERIFYPEER, 1L);
   setOption(CURLOPT_SSL_VERIFYHOST, 2L);
}

◆ getCurlHandle()

CURL * audacity::network_manager::CurlHandleManager::Handle::getCurlHandle ( ) const

noexcept

Definition at line 249 of file CurlHandleManager.cpp.

{
   return mHandle;
}

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the caller graph for this function:

◆ getHTTPCode()

unsigned audacity::network_manager::CurlHandleManager::Handle::getHTTPCode ( ) const

noexcept

Definition at line 230 of file CurlHandleManager.cpp.

{
    long code = 0;
 
    if (CURLE_OK != curl_easy_getinfo(mHandle, CURLINFO_RESPONSE_CODE, &code))
        return 0;
 
    return code;
}

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the caller graph for this function:

◆ isHandleFromCache()

bool audacity::network_manager::CurlHandleManager::Handle::isHandleFromCache ( ) const

noexcept

Definition at line 225 of file CurlHandleManager.cpp.

{
    return mHandleFromCache;
}

◆ markKeepAlive()

void audacity::network_manager::CurlHandleManager::Handle::markKeepAlive ( )

Definition at line 220 of file CurlHandleManager.cpp.

{
    mReuse = true;
}

◆ operator=()

CurlHandleManager::Handle & audacity::network_manager::CurlHandleManager::Handle::operator= ( Handle && rhs )

noexcept

Definition at line 147 of file CurlHandleManager.cpp.

{
    std::swap (mHandle, rhs.mHandle);
    std::swap (mOwner, rhs.mOwner);
 
    std::swap (mVerb, rhs.mVerb);
    
    mUrl = std::move (rhs.mUrl);
    mHeaders = std::move (rhs.mHeaders);
 
    mReuse = rhs.mReuse;
    rhs.mReuse = false;
 
    return *this;
}

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

◆ perform()

CurlHandleManager::Handle::Result audacity::network_manager::CurlHandleManager::Handle::perform ( )

Definition at line 200 of file CurlHandleManager.cpp.

{
    if (!mUserAgentSet)
        mHeaders.append ("User-Agent: " + mOwner->getUserAgent ());
 
    CURLcode result = setOption (CURLOPT_HTTPHEADER, mHeaders.getCurlList ());
 
    if (result != CURLE_OK)
        return { result, std::string () };
 
    char currentError[CURL_ERROR_SIZE] = {};
    setOption(CURLOPT_ERRORBUFFER, currentError);
 
    result = curl_easy_perform (mHandle);
 
    mReuse = mReuse && result == CURLE_OK;
 
    return { result, std::string (currentError) };
}

Referenced by audacity::network_manager::CurlResponse::perform().

Here is the caller graph for this function:

◆ reset()

void audacity::network_manager::CurlHandleManager::Handle::reset ( )

noexcept

Definition at line 240 of file CurlHandleManager.cpp.

{
   setOption (CURLOPT_COOKIELIST, nullptr);
   setOption (CURLOPT_PROXY, nullptr);
   setOption (CURLOPT_SSL_OPTIONS, 0);
 
    mUserAgentSet = false;
}

Referenced by audacity::network_manager::CurlHandleManager::cacheHandle().

Here is the caller graph for this function:

◆ setOption() [1/2]

template<typename... Args>

CURLcode audacity::network_manager::CurlHandleManager::Handle::setOption	(	CURLoption	option,
		Args...	value
	)

inlinenoexcept

Definition at line 45 of file CurlHandleManager.h.

        {
            return curl_easy_setopt (mHandle, option, value...);
        }

References mHandle.

Referenced by audacity::network_manager::CurlHandleManager::getHandle(), and audacity::network_manager::CurlResponse::perform().

Here is the caller graph for this function:

◆ setOption() [2/2]

CURLcode audacity::network_manager::CurlHandleManager::Handle::setOption	(	CURLoption	option,
		const std::string &	value
	)

noexcept

Definition at line 163 of file CurlHandleManager.cpp.

{
    return setOption (option, value.c_str ());
}

Friends And Related Function Documentation

◆ CurlHandleManager

friend class CurlHandleManager

friend

Definition at line 36 of file CurlHandleManager.h.

Member Data Documentation

◆ mHandle

CURL* audacity::network_manager::CurlHandleManager::Handle::mHandle { nullptr }

private

Definition at line 79 of file CurlHandleManager.h.

Referenced by audacity::network_manager::CurlHandleManager::cacheHandle(), setOption(), and ~Handle().

◆ mHandleFromCache

bool audacity::network_manager::CurlHandleManager::Handle::mHandleFromCache { false }

private

Definition at line 89 of file CurlHandleManager.h.

◆ mHeaders

CurlStringList audacity::network_manager::CurlHandleManager::Handle::mHeaders

private

Definition at line 85 of file CurlHandleManager.h.

◆ mOwner

CurlHandleManager* audacity::network_manager::CurlHandleManager::Handle::mOwner { nullptr }

private

Definition at line 80 of file CurlHandleManager.h.

Referenced by ~Handle().

◆ mReuse

bool audacity::network_manager::CurlHandleManager::Handle::mReuse { false }

private

Definition at line 88 of file CurlHandleManager.h.

Referenced by ~Handle().

◆ mUrl

std::string audacity::network_manager::CurlHandleManager::Handle::mUrl

private

Definition at line 83 of file CurlHandleManager.h.

Referenced by audacity::network_manager::CurlHandleManager::cacheHandle().

◆ mUserAgentSet

bool audacity::network_manager::CurlHandleManager::Handle::mUserAgentSet { false }

private

Definition at line 87 of file CurlHandleManager.h.

◆ mVerb

RequestVerb audacity::network_manager::CurlHandleManager::Handle::mVerb

private

Definition at line 82 of file CurlHandleManager.h.

Referenced by audacity::network_manager::CurlHandleManager::cacheHandle().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Handle() [1/2]

◆ Handle() [2/2]

◆ ~Handle()

Member Function Documentation

◆ appendCookie()

◆ appendCookies()

◆ appendHeader()

◆ appendHeaders()

◆ disableSSLValidation()

◆ enableSSLValidation()

◆ getCurlHandle()

◆ getHTTPCode()

◆ isHandleFromCache()

◆ markKeepAlive()

◆ operator=()

◆ perform()

◆ reset()

◆ setOption() [1/2]

◆ setOption() [2/2]

Friends And Related Function Documentation

◆ CurlHandleManager

Member Data Documentation

◆ mHandle

◆ mHandleFromCache

◆ mHeaders

◆ mOwner

◆ mReuse

◆ mUrl

◆ mUserAgentSet

◆ mVerb