Slic3r::Http Class Reference

Represetns a Http request. More...

#include <src/slic3r/Utils/Http.hpp>

Inheritance diagram for Slic3r::Http:

Collaboration diagram for Slic3r::Http:

Classes
struct	priv
struct	Progress

Public Types
typedef std::shared_ptr< Http >	Ptr
typedef std::function< void(std::string, unsigned)>	CompleteFn
typedef std::function< void(std::string, std::string, unsigned)>	ErrorFn
typedef std::function< void(Progress, bool &)>	ProgressFn
typedef std::function< void(std::string)>	IPResolveFn

Public Member Functions
	Http (Http &&other)
	~Http ()
	Http (const Http &)=delete
Http &	operator= (const Http &)=delete
Http &	operator= (Http &&)=delete
Http &	timeout_connect (long timeout)
Http &	timeout_max (long timeout)
Http &	size_limit (size_t sizeLimit)
Http &	set_range (const std::string &range)
Http &	header (std::string name, const std::string &value)
Http &	remove_header (std::string name)
Http &	auth_digest (const std::string &user, const std::string &password)
Http &	auth_basic (const std::string &user, const std::string &password)
Http &	ca_file (const std::string &filename)
Http &	form_add (const std::string &name, const std::string &contents)
Http &	form_add_file (const std::string &name, const boost::filesystem::path &path)
Http &	form_add_file (const std::string &name, const boost::filesystem::path &path, const std::string &filename)
Http &	set_post_body (const boost::filesystem::path &path)
Http &	set_post_body (const std::string &body)
Http &	set_put_body (const boost::filesystem::path &path)
Http &	on_complete (CompleteFn fn)
Http &	on_error (ErrorFn fn)
Http &	on_progress (ProgressFn fn)
Http &	on_ip_resolve (IPResolveFn fn)
Ptr	perform ()
void	perform_sync ()
void	cancel ()

Static Public Member Functions
static Http	get (std::string url)
static Http	post (std::string url)
static Http	put (std::string url)
static bool	ca_file_supported ()
static std::string	tls_global_init ()
static std::string	tls_system_cert_store ()
static std::string	url_encode (const std::string &str)

Private Member Functions
	Http (const std::string &url)

Private Attributes
std::unique_ptr< priv >	p

Detailed Description

Represetns a Http request.

Member Typedef Documentation

CompleteFn

typedef std::function<void(std::string , unsigned )> Slic3r::Http::CompleteFn

ErrorFn

typedef std::function<void(std::string , std::string , unsigned )> Slic3r::Http::ErrorFn

IPResolveFn

typedef std::function<void(std::string)> Slic3r::Http::IPResolveFn

ProgressFn

typedef std::function<void(Progress, bool& )> Slic3r::Http::ProgressFn

Ptr

typedef std::shared_ptr<Http> Slic3r::Http::Ptr

Constructor & Destructor Documentation

Http() [1/3]

Slic3r::Http::Http

(

Http &&

other

)

: p(std::move(other.p)) {}

~Http()

Slic3r::Http::~Http

(

)

{
    assert(! p || ! p->putFile);
  if (p && p->io_thread.joinable()) {
    p->io_thread.detach();
  }
}

References p.

Http() [2/3]

Slic3r::Http::Http ( const Http &  )

delete

Http() [3/3]

Slic3r::Http::Http ( const std::string &  url )

private

: p(new priv(url)) {}

Member Function Documentation

auth_basic()

Http & Slic3r::Http::auth_basic	(	const std::string &	user,
		const std::string &	password
	)

{
    curl_easy_setopt(p->curl, CURLOPT_USERNAME, user.c_str());
    curl_easy_setopt(p->curl, CURLOPT_PASSWORD, password.c_str());
    curl_easy_setopt(p->curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
 
    return *this;
}

References p.

auth_digest()

Http & Slic3r::Http::auth_digest	(	const std::string &	user,
		const std::string &	password
	)

{
  curl_easy_setopt(p->curl, CURLOPT_USERNAME, user.c_str());
  curl_easy_setopt(p->curl, CURLOPT_PASSWORD, password.c_str());
  curl_easy_setopt(p->curl, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
 
  return *this;
}

References p.

Referenced by Slic3r::PrusaLink::set_auth().

Here is the caller graph for this function:

ca_file()

Http & Slic3r::Http::ca_file

(

const std::string &

filename

)

{
  if (p && priv::ca_file_supported(p->curl)) {
    ::curl_easy_setopt(p->curl, CURLOPT_CAINFO, name.c_str());
  }
 
  return *this;
}

References Slic3r::Http::priv::ca_file_supported(), and p.

Referenced by Slic3r::AstroBox::set_auth(), Slic3r::Moonraker::set_auth(), Slic3r::OctoPrint::set_auth(), Slic3r::Repetier::set_auth(), and Slic3r::PrusaLink::set_auth().

Here is the call graph for this function:

Here is the caller graph for this function:

ca_file_supported()

bool Slic3r::Http::ca_file_supported ( )

static

{
  ::CURL *curl = ::curl_easy_init();
  bool res = priv::ca_file_supported(curl);
  if (curl != nullptr) { ::curl_easy_cleanup(curl); }
    return res;
}

References Slic3r::Http::priv::ca_file_supported().

Referenced by Slic3r::GUI::PhysicalPrinterDialog::build_printhost_settings().

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

void Slic3r::Http::cancel

(

)

{
  if (p) { p->cancel = true; }
}

References p.

Referenced by Slic3r::Http::priv::http_perform().

Here is the caller graph for this function:

form_add()

Http & Slic3r::Http::form_add	(	const std::string &	name,
		const std::string &	contents
	)

{
  if (p) {
    ::curl_formadd(&p->form, &p->form_end,
      CURLFORM_COPYNAME, name.c_str(),
      CURLFORM_COPYCONTENTS, contents.c_str(),
      CURLFORM_END
    );
  }
 
  return *this;
}

References p.

Referenced by Slic3r::PrusaLink::post_inner(), Slic3r::PrusaLink::set_http_post_header_args(), and Slic3r::PrusaConnect::set_http_post_header_args().

Here is the caller graph for this function:

form_add_file() [1/2]

Http & Slic3r::Http::form_add_file	(	const std::string &	name,
		const boost::filesystem::path &	path
	)

Referenced by Slic3r::PrusaLink::post_inner().

Here is the caller graph for this function:

form_add_file() [2/2]

Http & Slic3r::Http::form_add_file	(	const std::string &	name,
		const boost::filesystem::path &	path,
		const std::string &	filename
	)

get()

Http Slic3r::Http::get ( std::string  url )

static

{
    return Http{std::move(url)};
}

Referenced by Slic3r::Duet::connect(), Slic3r::Duet::disconnect(), Slic3r::PresetUpdater::priv::get_file(), Slic3r::Repetier::get_groups(), Slic3r::GUI::FileGet::priv::get_perform(), Slic3r::Repetier::get_printers(), Slic3r::PrusaLink::get_storage(), Slic3r::AppUpdater::priv::http_get_file(), Slic3r::Duet::start_print(), Slic3r::AstroBox::test(), Slic3r::FlashAir::test(), Slic3r::Moonraker::test(), Slic3r::OctoPrint::test(), Slic3r::PrusaLink::test(), Slic3r::Repetier::test(), Slic3r::PrusaLink::test_with_method_check(), and Slic3r::FlashAir::upload().

Here is the caller graph for this function:

header()

Http & Slic3r::Http::header	(	std::string	name,
		const std::string &	value
	)

{
  if (!p) { return * this; }
 
  if (name.size() > 0) {
    name.append(": ").append(value);
  } else {
    name.push_back(':');
  }
  p->headerlist = curl_slist_append(p->headerlist, name.c_str());
  return *this;
}

References p.

Referenced by Slic3r::PrusaLink::post_inner(), Slic3r::PrusaLink::put_inner(), Slic3r::GUI::SendSystemInfoDialog::send_info(), Slic3r::AstroBox::set_auth(), Slic3r::Moonraker::set_auth(), Slic3r::OctoPrint::set_auth(), Slic3r::Repetier::set_auth(), Slic3r::PrusaLink::set_auth(), and Slic3r::PrusaConnect::set_http_post_header_args().

Here is the caller graph for this function:

on_complete()

Http & Slic3r::Http::on_complete

(

CompleteFn

fn

)

{
  if (p) { p->completefn = std::move(fn); }
  return *this;
}

References p.

Referenced by Slic3r::PrusaLink::post_inner(), Slic3r::PrusaLink::put_inner(), and Slic3r::GUI::SendSystemInfoDialog::send_info().

Here is the caller graph for this function:

on_error()

Http & Slic3r::Http::on_error

(

ErrorFn

fn

)

{
  if (p) { p->errorfn = std::move(fn); }
  return *this;
}

References p.

on_ip_resolve()

Http & Slic3r::Http::on_ip_resolve

(

IPResolveFn

fn

)

{
  if (p) { p->ipresolvefn = std::move(fn); }
  return *this;
}

References p.

on_progress()

Http & Slic3r::Http::on_progress

(

ProgressFn

fn

)

{
  if (p) { p->progressfn = std::move(fn); }
  return *this;
}

References p.

Referenced by Slic3r::PresetUpdater::priv::get_file(), Slic3r::GUI::FileGet::priv::get_perform(), and Slic3r::AppUpdater::priv::http_get_file().

Here is the caller graph for this function:

operator=() [1/2]

Http & Slic3r::Http::operator= ( const Http &  )

delete

operator=() [2/2]

Http & Slic3r::Http::operator= ( Http &&  )

delete

perform()

Http::Ptr Slic3r::Http::perform

(

)

{
  auto self = std::make_shared<Http>(std::move(*this));
 
  if (self->p) {
    auto io_thread = std::thread([self](){
        self->p->http_perform();
      });
    self->p->io_thread = std::move(io_thread);
  }
 
  return self;
}

perform_sync()

void Slic3r::Http::perform_sync

(

)

{
  if (p) { p->http_perform(); }
}

References p.

Referenced by Slic3r::PrusaLink::post_inner(), and Slic3r::PrusaLink::put_inner().

Here is the caller graph for this function:

post()

Http Slic3r::Http::post ( std::string  url )

static

{
  Http http{std::move(url)};
  curl_easy_setopt(http.p->curl, CURLOPT_POST, 1L);
  return http;
}

Referenced by Slic3r::PrusaLink::post_inner(), Slic3r::GUI::SendSystemInfoDialog::send_info(), Slic3r::Duet::start_print(), Slic3r::AstroBox::upload(), Slic3r::Duet::upload(), Slic3r::FlashAir::upload(), Slic3r::MKS::upload(), Slic3r::Moonraker::upload(), Slic3r::Repetier::upload(), and Slic3r::OctoPrint::upload_inner_with_host().

Here is the caller graph for this function:

put()

Http Slic3r::Http::put ( std::string  url )

static

{
  Http http{std::move(url)};
  curl_easy_setopt(http.p->curl, CURLOPT_UPLOAD, 1L);
  return http;
}

Referenced by Slic3r::PrusaLink::put_inner(), and Slic3r::Duet::upload().

Here is the caller graph for this function:

remove_header()

Http & Slic3r::Http::remove_header

(

std::string

name

)

{
  if (p) {
    name.push_back(':');
    p->headerlist = curl_slist_append(p->headerlist, name.c_str());
  }
 
  return *this;
}

References p.

set_post_body() [1/2]

Http & Slic3r::Http::set_post_body

(

const boost::filesystem::path &

path

)

Referenced by Slic3r::GUI::SendSystemInfoDialog::send_info().

Here is the caller graph for this function:

set_post_body() [2/2]

Http & Slic3r::Http::set_post_body

(

const std::string &

body

)

{
  if (p) { p->set_post_body(body); }
  return *this;
}

References p.

set_put_body()

Http & Slic3r::Http::set_put_body

(

const boost::filesystem::path &

path

)

{
  if (p) { p->set_put_body(path);}
  return *this;
}

References p.

Referenced by Slic3r::PrusaLink::put_inner().

Here is the caller graph for this function:

set_range()

Http & Slic3r::Http::set_range

(

const std::string &

range

)

{
  if (p) { p->set_range(range); }
  return *this;
}

References p, and Slic3r::range().

Referenced by Slic3r::GUI::FileGet::priv::get_perform().

Here is the call graph for this function:

Here is the caller graph for this function:

size_limit()

Http & Slic3r::Http::size_limit

(

size_t

sizeLimit

)

{
  if (p) { p->limit = sizeLimit; }
  return *this;
}

References p.

Referenced by Slic3r::GUI::FileGet::priv::get_perform(), and Slic3r::AppUpdater::priv::http_get_file().

Here is the caller graph for this function:

timeout_connect()

Http & Slic3r::Http::timeout_connect

(

long

timeout

)

{
  if (timeout < 1) { timeout = priv::DEFAULT_TIMEOUT_CONNECT; }
  if (p) { p->set_timeout_connect(timeout); }
  return *this;
}

References Slic3r::Http::priv::DEFAULT_TIMEOUT_CONNECT, and p.

timeout_max()

Http & Slic3r::Http::timeout_max

(

long

timeout

)

{
    if (timeout < 1) { timeout = priv::DEFAULT_TIMEOUT_MAX; }
    if (p) { p->set_timeout_max(timeout); }
    return *this;
}

References Slic3r::Http::priv::DEFAULT_TIMEOUT_MAX, and p.

Referenced by Slic3r::GUI::SendSystemInfoDialog::send_info().

Here is the caller graph for this function:

tls_global_init()

std::string Slic3r::Http::tls_global_init ( )

static

{
    if (!CurlGlobalInit::instance)
        CurlGlobalInit::instance = std::make_unique<CurlGlobalInit>();
 
    return CurlGlobalInit::instance->message;
}

References Slic3r::CurlGlobalInit::instance.

Referenced by Slic3r::Http::priv::priv(), and Slic3r::GUI::GUI_App::on_init_inner().

Here is the caller graph for this function:

tls_system_cert_store()

std::string Slic3r::Http::tls_system_cert_store ( )

static

{
    std::string ret;
 
#ifdef OPENSSL_CERT_OVERRIDE
    ret = ::getenv(X509_get_default_cert_file_env());
#endif
 
    return ret;
}

References getenv().

Referenced by Slic3r::GUI::GUI_App::on_init_inner().

Here is the call graph for this function:

Here is the caller graph for this function:

url_encode()

std::string Slic3r::Http::url_encode ( const std::string &  str )

static

{
  ::CURL *curl = ::curl_easy_init();
  if (curl == nullptr) {
    return str;
  }
  char *ce = ::curl_easy_escape(curl, str.c_str(), str.length());
  std::string encoded = std::string(ce);
 
  ::curl_free(ce);
  ::curl_easy_cleanup(curl);
 
  return encoded;
}

Referenced by Slic3r::MKS::get_upload_url(), Slic3r::Duet::get_upload_url(), and Slic3r::Duet::start_print().

Here is the caller graph for this function:

Member Data Documentation

p

std::unique_ptr<priv> Slic3r::Http::p

private

Referenced by ~Http(), auth_basic(), auth_digest(), ca_file(), cancel(), form_add(), header(), on_complete(), on_error(), on_ip_resolve(), on_progress(), perform_sync(), remove_header(), set_post_body(), set_put_body(), set_range(), size_limit(), timeout_connect(), and timeout_max().

---

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

• src/slic3r/Utils/Http.hpp
• src/slic3r/Utils/Http.cpp