#include <kicad_curl_easy.h>

Public Member Functions
	KICAD_CURL_EASY ()

	~KICAD_CURL_EASY ()

int	Perform ()
	Equivalent to curl_easy_perform. More...

void	SetHeader (const std::string &aName, const std::string &aValue)
	Set an arbitrary header for the HTTP(s) request. More...

bool	SetUserAgent (const std::string &aAgent)
	Set the request user agent. More...

bool	SetURL (const std::string &aURL)
	Set the request URL. More...

bool	SetFollowRedirects (bool aFollow)
	Enable the following of HTTP(s) and other redirects, by default curl does not follow redirects. More...

const std::string	GetErrorText (int aCode)
	Fetch CURL's "friendly" error string for a given error code. More...

int	GetTransferTotal (uint64_t &aDownloadedBytes) const

const std::string &	GetBuffer ()
	Return a reference to the received data buffer. More...

std::string	Escape (const std::string &aUrl)
	Escapes a string for use as a URL. More...

bool	SetTransferCallback (const TRANSFER_CALLBACK &aCallback, size_t aInterval)

bool	SetOutputStream (const std::ostream *aOutput)

CURL *	GetCurl ()

Private Member Functions
template<typename T >
int	setOption (int aOption, T aArg)
	Set a curl option, only supports single parameter curl options. More...

Private Attributes
CURL *	m_CURL

curl_slist *	m_headers

std::string	m_buffer

std::unique_ptr< CURL_PROGRESS >	progress

Detailed Description

Definition at line 66 of file kicad_curl_easy.h.

Constructor & Destructor Documentation

◆ KICAD_CURL_EASY()

KICAD_CURL_EASY::KICAD_CURL_EASY ( )

Definition at line 99 of file kicad_curl_easy.cpp.

  : m_headers( nullptr )
 {
  // Call KICAD_CURL::Init() from in here every time, but only the first time
  // will incur any overhead. This strategy ensures that libcurl is never loaded
  // unless it is needed.
 
  KICAD_CURL::Init();
 
  m_CURL = curl_easy_init();
 
  if( !m_CURL )
  {
  THROW_IO_ERROR( "Unable to initialize CURL session" );
  }
 
  curl_easy_setopt( m_CURL, CURLOPT_WRITEFUNCTION, write_callback );
  curl_easy_setopt( m_CURL, CURLOPT_WRITEDATA, (void*) &m_buffer );
 
  // Only allow HTTP and HTTPS protocols
  curl_easy_setopt( m_CURL, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS );
 
  wxPlatformInfo platformInfo;
  wxString application( Pgm().App().GetAppName() );
  wxString version( GetBuildVersion() );
  wxString platform = "(" + wxGetOsDescription() + ";" + platformInfo.GetArchName();
 
 #if defined( KICAD_BUILD_ARCH_X64 )
  platform << ";64-bit";
 #elif defined( KICAD_BUILD_ARCH_X86 )
  platform << ";32-bit";
 #elif defined( KICAD_BUILD_ARCH_ARM )
  platform << ";ARM 32-bit";
 #elif defined( KICAD_BUILD_ARCH_ARM64 )
  platform << ";ARM 64-bit";
 #endif
 
  platform << ")";
 
  wxString user_agent = "KiCad/" + version + " " + platform + " " + application;
 
  user_agent << "/" << GetBuildDate();
  setOption<const char*>( CURLOPT_USERAGENT, user_agent.ToStdString().c_str() );
  setOption( CURLOPT_ACCEPT_ENCODING, "gzip,deflate" );
 }

References GetBuildDate(), GetBuildVersion(), KICAD_CURL::Init(), m_buffer, m_CURL, Pgm(), setOption(), THROW_IO_ERROR, and write_callback().

◆ ~KICAD_CURL_EASY()

KICAD_CURL_EASY::~KICAD_CURL_EASY ( )

Definition at line 145 of file kicad_curl_easy.cpp.

 {
  if( m_headers )
  curl_slist_free_all( m_headers );
 
  curl_easy_cleanup( m_CURL );
 }

References m_CURL, and m_headers.

Member Function Documentation

◆ Escape()

std::string KICAD_CURL_EASY::Escape ( const std::string & aUrl )

Escapes a string for use as a URL.

Definition at line 223 of file kicad_curl_easy.cpp.

 {
  char* escaped = curl_easy_escape( m_CURL, aUrl.c_str(), aUrl.length() );
 
  std::string ret( escaped );
  curl_free( escaped );
 
  return ret;
 }

References m_CURL.

Referenced by COMMON_CONTROL::ReportBug().

◆ GetBuffer()

const std::string& KICAD_CURL_EASY::GetBuffer ( )

inline

Return a reference to the received data buffer.

Definition at line 123 of file kicad_curl_easy.h.

123 { return m_buffer; }

KICAD_CURL_EASY::m_buffer

std::string m_buffer

Definition: kicad_curl_easy.h:148

References m_buffer.

◆ GetCurl()

CURL* KICAD_CURL_EASY::GetCurl ( )

inline

Definition at line 132 of file kicad_curl_easy.h.

132 { return m_CURL; }

KICAD_CURL_EASY::m_CURL

CURL * m_CURL

Definition: kicad_curl_easy.h:146

References m_CURL.

Referenced by xferinfo().

◆ GetErrorText()

const std::string KICAD_CURL_EASY::GetErrorText ( int aCode )

Fetch CURL's "friendly" error string for a given error code.

Parameters

aCode is CURL error code.

Returns: The corresponding error string for the given code.

Definition at line 184 of file kicad_curl_easy.cpp.

 {
  return curl_easy_strerror( (CURLcode) aCode );
 }

Referenced by PLUGIN_CONTENT_MANAGER::DownloadToStream().

◆ GetTransferTotal()

int KICAD_CURL_EASY::GetTransferTotal ( uint64_t & aDownloadedBytes ) const

Definition at line 252 of file kicad_curl_easy.cpp.

 {
  curl_off_t dl;
  int result = curl_easy_getinfo( m_CURL, CURLINFO_SIZE_DOWNLOAD_T, &dl );
  aDownloadedBytes = (uint64_t) dl;
  return result;
 }

References m_CURL.

◆ Perform()

int KICAD_CURL_EASY::Perform ( )

Equivalent to curl_easy_perform.

Executes the request that was previously setup.

Definition at line 154 of file kicad_curl_easy.cpp.

 {
  if( m_headers )
  {
  curl_easy_setopt( m_CURL, CURLOPT_HTTPHEADER, m_headers );
  }
 
  // bonus: retain worst case memory allocation, should re-use occur
  m_buffer.clear();
 
  CURLcode res = curl_easy_perform( m_CURL );
 
  return res;
 }

References m_buffer, m_CURL, and m_headers.

Referenced by PLUGIN_CONTENT_MANAGER::DownloadToStream().

◆ SetFollowRedirects()

bool KICAD_CURL_EASY::SetFollowRedirects ( bool aFollow )

Enable the following of HTTP(s) and other redirects, by default curl does not follow redirects.

Parameters

aFollow is a boolean where true will enable following redirects.

Returns: True if successful, false if not.

Definition at line 212 of file kicad_curl_easy.cpp.

 {
  if( setOption<long>( CURLOPT_FOLLOWLOCATION, ( aFollow ? 1 : 0 ) ) == CURLE_OK )
  {
  return true;
  }
 
  return false;
 }

Referenced by PLUGIN_CONTENT_MANAGER::DownloadToStream().

◆ SetHeader()

void KICAD_CURL_EASY::SetHeader	(	const std::string &	aName,
		const std::string &	aValue
	)

Set an arbitrary header for the HTTP(s) request.

Parameters

aName	is the left hand side of the header, i.e. Accept without the colon.
aValue	is the right hand side of the header, i.e. application/json.

Definition at line 170 of file kicad_curl_easy.cpp.

 {
  std::string header = aName + ':' + aValue;
  m_headers = curl_slist_append( m_headers, header.c_str() );
 }

References m_headers.

◆ setOption()

template<typename T >

int KICAD_CURL_EASY::setOption	(	int	aOption,
		T	aArg
	)

private

Set a curl option, only supports single parameter curl options.

Parameters

aOption	is CURL option, see CURL manual for options.
aArg	is the argument being passed to CURL, ensure it is the right type per manual.

Returns: A CURL error code, will return CURLE_OK unless a problem was encountered.

Definition at line 178 of file kicad_curl_easy.cpp.

 {
  return curl_easy_setopt( m_CURL, (CURLoption) aOption, aArg );
 }

References m_CURL.

Referenced by KICAD_CURL_EASY(), and SetTransferCallback().

◆ SetOutputStream()

bool KICAD_CURL_EASY::SetOutputStream ( const std::ostream * aOutput )

Definition at line 244 of file kicad_curl_easy.cpp.

 {
  curl_easy_setopt( m_CURL, CURLOPT_WRITEFUNCTION, stream_write_callback );
  curl_easy_setopt( m_CURL, CURLOPT_WRITEDATA, (void*) aOutput );
  return true;
 }

References m_CURL, and stream_write_callback().

Referenced by PCM_TASK_MANAGER::downloadFile(), and PLUGIN_CONTENT_MANAGER::DownloadToStream().

◆ SetTransferCallback()

bool KICAD_CURL_EASY::SetTransferCallback	(	const TRANSFER_CALLBACK &	aCallback,
		size_t	aInterval
	)

Definition at line 234 of file kicad_curl_easy.cpp.

 {
  progress = std::make_unique<CURL_PROGRESS>( this, aCallback, (curl_off_t) aInterval );
  setOption( CURLOPT_XFERINFOFUNCTION, xferinfo );
  setOption( CURLOPT_XFERINFODATA, progress.get() );
  setOption( CURLOPT_NOPROGRESS, 0L );
  return true;
 }

References progress, setOption(), and xferinfo().

Referenced by PLUGIN_CONTENT_MANAGER::DownloadToStream().

◆ SetURL()

bool KICAD_CURL_EASY::SetURL ( const std::string & aURL )

Set the request URL.

Parameters

aURL	is the URL.

Returns: True if successful, false if not.

Definition at line 201 of file kicad_curl_easy.cpp.

 {
  if( setOption<const char*>( CURLOPT_URL, aURL.c_str() ) == CURLE_OK )
  {
  return true;
  }
 
  return false;
 }

Referenced by PLUGIN_CONTENT_MANAGER::DownloadToStream().

◆ SetUserAgent()

bool KICAD_CURL_EASY::SetUserAgent ( const std::string & aAgent )

Set the request user agent.

Parameters

aAgent is the string to set for the user agent.

Returns: True if successful, false if not.

Definition at line 190 of file kicad_curl_easy.cpp.

 {
  if( setOption<const char*>( CURLOPT_USERAGENT, aAgent.c_str() ) == CURLE_OK )
  {
  return true;
  }
 
  return false;
 }

Member Data Documentation

◆ m_buffer

std::string KICAD_CURL_EASY::m_buffer

private

Definition at line 148 of file kicad_curl_easy.h.

Referenced by GetBuffer(), KICAD_CURL_EASY(), and Perform().

◆ m_CURL

CURL* KICAD_CURL_EASY::m_CURL

private

Definition at line 146 of file kicad_curl_easy.h.

Referenced by Escape(), GetCurl(), GetTransferTotal(), KICAD_CURL_EASY(), Perform(), setOption(), SetOutputStream(), and ~KICAD_CURL_EASY().

◆ m_headers

curl_slist* KICAD_CURL_EASY::m_headers

private

Definition at line 147 of file kicad_curl_easy.h.

Referenced by Perform(), SetHeader(), and ~KICAD_CURL_EASY().

◆ progress

std::unique_ptr<CURL_PROGRESS> KICAD_CURL_EASY::progress

private

Definition at line 149 of file kicad_curl_easy.h.

Referenced by SetTransferCallback().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KICAD_CURL_EASY()

◆ ~KICAD_CURL_EASY()

Member Function Documentation

◆ Escape()

◆ GetBuffer()

◆ GetCurl()

◆ GetErrorText()

◆ GetTransferTotal()

◆ Perform()

◆ SetFollowRedirects()

◆ SetHeader()

◆ setOption()

◆ SetOutputStream()

◆ SetTransferCallback()

◆ SetURL()

◆ SetUserAgent()

Member Data Documentation

◆ m_buffer

◆ m_CURL

◆ m_headers

◆ progress