Slic3r::AstroBox Class Reference

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

Inheritance diagram for Slic3r::AstroBox:

Collaboration diagram for Slic3r::AstroBox:

Public Types
typedef Http::ProgressFn	ProgressFn
typedef std::function< void(wxString)>	ErrorFn
typedef std::function< void(wxString, wxString)>	InfoFn

Public Member Functions
	AstroBox (DynamicPrintConfig *config)
	~AstroBox () override=default
const char *	get_name () const override
bool	test (wxString &curl_msg) const override
wxString	get_test_ok_msg () const override
wxString	get_test_failed_msg (wxString &msg) const override
bool	upload (PrintHostUpload upload_data, ProgressFn prorgess_fn, ErrorFn error_fn, InfoFn info_fn) const override
bool	has_auto_discovery () const override
bool	can_test () const override
PrintHostPostUploadActions	get_post_upload_actions () const override
std::string	get_host () const override
virtual bool	supports_multiple_printers () const
virtual bool	get_groups (wxArrayString &) const
virtual bool	get_printers (wxArrayString &) const
virtual bool	get_storage (wxArrayString &, wxArrayString &) const

Static Public Member Functions
static PrintHost *	get_print_host (DynamicPrintConfig *config)

Protected Member Functions
bool	validate_version_text (const boost::optional< std::string > &version_text) const
virtual wxString	format_error (const std::string &body, const std::string &error, unsigned status) const

Private Member Functions
void	set_auth (Http &http) const
std::string	make_url (const std::string &path) const

Private Attributes
std::string	host
std::string	apikey
std::string	cafile

Detailed Description

Member Typedef Documentation

ErrorFn

typedef std::function<void(wxString )> Slic3r::PrintHost::ErrorFn

inherited

InfoFn

typedef std::function<void(wxString , wxString )> Slic3r::PrintHost::InfoFn

inherited

ProgressFn

typedef Http::ProgressFn Slic3r::PrintHost::ProgressFn

inherited

Constructor & Destructor Documentation

AstroBox()

Slic3r::AstroBox::AstroBox

(

DynamicPrintConfig *

config

)

                                             :
    host(config->opt_string("print_host")),
    apikey(config->opt_string("printhost_apikey")),
    cafile(config->opt_string("printhost_cafile"))
{}

~AstroBox()

Slic3r::AstroBox::~AstroBox ( )

overridedefault

Member Function Documentation

can_test()

bool Slic3r::AstroBox::can_test ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return true; }

format_error()

wxString Slic3r::PrintHost::format_error ( const std::string &  body, const std::string &  error, unsigned  status  ) const

protectedvirtualinherited

{
    if (status != 0) {
        auto wxbody = wxString::FromUTF8(body.data());
        return wxString::Format("HTTP %u: %s", status, wxbody);
    } else {
        return wxString::FromUTF8(error.data());
    }
}

References error.

Referenced by Slic3r::Duet::connect(), Slic3r::PrusaLink::post_inner(), Slic3r::PrusaLink::put_inner(), Slic3r::Duet::start_print(), test(), Slic3r::FlashAir::test(), Slic3r::Moonraker::test(), Slic3r::OctoPrint::test(), Slic3r::PrusaLink::test(), Slic3r::Repetier::test(), Slic3r::PrusaLink::test_with_method_check(), 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:

get_groups()

virtual bool Slic3r::PrintHost::get_groups ( wxArrayString &  ) const

inlinevirtualinherited

Reimplemented in Slic3r::Repetier.

{ return false; }

get_host()

std::string Slic3r::AstroBox::get_host ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return host; }

References host.

get_name()

const char * Slic3r::AstroBox::get_name ( ) const

overridevirtual

Implements Slic3r::PrintHost.

{ return "AstroBox"; }

Referenced by test(), and upload().

Here is the caller graph for this function:

get_post_upload_actions()

PrintHostPostUploadActions Slic3r::AstroBox::get_post_upload_actions ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return PrintHostPostUploadAction::StartPrint; }

References Slic3r::StartPrint.

get_print_host()

PrintHost * Slic3r::PrintHost::get_print_host ( DynamicPrintConfig *  config )

staticinherited

{
    PrinterTechnology tech = ptFFF;
 
    {
        const auto opt = config->option<ConfigOptionEnum<PrinterTechnology>>("printer_technology");
        if (opt != nullptr) {
            tech = opt->value;
        }
    }
 
    if (tech == ptFFF) {
        const auto opt = config->option<ConfigOptionEnum<PrintHostType>>("host_type");
        const auto host_type = opt != nullptr ? opt->value : htOctoPrint;
 
        switch (host_type) {
            case htOctoPrint: return new OctoPrint(config);
            case htDuet:      return new Duet(config);
            case htFlashAir:  return new FlashAir(config);
            case htAstroBox:  return new AstroBox(config);
            case htRepetier:  return new Repetier(config);
            case htPrusaLink: return new PrusaLink(config);
            case htPrusaConnect: return new PrusaConnect(config);
            case htMKS:       return new MKS(config);
            case htMoonraker: return new Moonraker(config);
            default:          return nullptr;
        }
    } else {
        return new SL1Host(config);
    }
}

References Slic3r::htAstroBox, Slic3r::htDuet, Slic3r::htFlashAir, Slic3r::htMKS, Slic3r::htMoonraker, Slic3r::htOctoPrint, Slic3r::htPrusaConnect, Slic3r::htPrusaLink, Slic3r::htRepetier, Slic3r::ConfigBase::option(), Slic3r::ptFFF, and Slic3r::ConfigOptionSingle< T >::value.

Referenced by Slic3r::GUI::PhysicalPrinterDialog::build_printhost_settings(), Slic3r::GUI::PhysicalPrinterDialog::update_printers(), and Slic3r::GUI::PhysicalPrinterDialog::update_printhost_buttons().

Here is the call graph for this function:

Here is the caller graph for this function:

get_printers()

virtual bool Slic3r::PrintHost::get_printers ( wxArrayString &  ) const

inlinevirtualinherited

Reimplemented in Slic3r::Repetier.

{ return false; }

get_storage()

virtual bool Slic3r::PrintHost::get_storage ( wxArrayString &  , wxArrayString &    ) const

inlinevirtualinherited

Reimplemented in Slic3r::PrusaLink, and Slic3r::PrusaConnect.

{ return false; }

get_test_failed_msg()

wxString Slic3r::AstroBox::get_test_failed_msg ( wxString &  msg ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    return GUI::format_wxstr("%s: %s\n\n%s"
        , _L("Could not connect to AstroBox")
        , msg
        , _L("Note: AstroBox version at least 1.1.0 is required."));
}

References _L, and Slic3r::GUI::format_wxstr().

Here is the call graph for this function:

get_test_ok_msg()

wxString Slic3r::AstroBox::get_test_ok_msg ( ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    return _(L("Connection to AstroBox works correctly."));
}

References _, and L.

has_auto_discovery()

bool Slic3r::AstroBox::has_auto_discovery ( ) const

inlineoverridevirtual

Implements Slic3r::PrintHost.

{ return true; }

make_url()

std::string Slic3r::AstroBox::make_url ( const std::string &  path ) const

private

{
    if (host.find("http://") == 0 || host.find("https://") == 0) {
        if (host.back() == '/') {
            return (boost::format("%1%%2%") % host % path).str();
        } else {
            return (boost::format("%1%/%2%") % host % path).str();
        }
    } else {
        return (boost::format("http://%1%/%2%") % host % path).str();
    }
}

References host.

Referenced by test(), and upload().

Here is the caller graph for this function:

set_auth()

void Slic3r::AstroBox::set_auth ( Http &  http ) const

private

{
    http.header("X-Api-Key", apikey);
 
    if (! cafile.empty()) {
        http.ca_file(cafile);
    }
}

References apikey, Slic3r::Http::ca_file(), cafile, and Slic3r::Http::header().

Referenced by test(), and upload().

Here is the call graph for this function:

Here is the caller graph for this function:

supports_multiple_printers()

virtual bool Slic3r::PrintHost::supports_multiple_printers ( ) const

inlinevirtualinherited

Reimplemented in Slic3r::Repetier.

{ return false; }

test()

bool Slic3r::AstroBox::test ( wxString &  curl_msg ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    // Since the request is performed synchronously here,
    // it is ok to refer to `msg` from within the closure
 
    const char *name = get_name();
 
    bool res = true;
    auto url = make_url("api/version");
 
    BOOST_LOG_TRIVIAL(info) << boost::format("%1%: Get version at: %2%") % name % url;
 
    auto http = Http::get(std::move(url));
    set_auth(http);
    http.on_error([&](std::string body, std::string error, unsigned status) {
            BOOST_LOG_TRIVIAL(error) << boost::format("%1%: Error getting version: %2%, HTTP %3%, body: `%4%`") % name % error % status % body;
            res = false;
            msg = format_error(body, error, status);
        })
        .on_complete([&, this](std::string body, unsigned) {
            BOOST_LOG_TRIVIAL(debug) << boost::format("%1%: Got version: %2%") % name % body;
 
            try {
                std::stringstream ss(body);
                pt::ptree ptree;
                pt::read_json(ss, ptree);
 
                if (! ptree.get_optional<std::string>("api")) {
                    res = false;
                    return;
                }
 
                const auto text = ptree.get_optional<std::string>("text");
                res = validate_version_text(text);
                if (! res) {
                    msg = GUI::format_wxstr(_L("Mismatched type of print host: %s"), (text ? *text : "AstroBox"));
                }
            }
            catch (const std::exception &) {
                res = false;
                msg = "Could not parse server response";
            }
        })
        .perform_sync();
 
    return res;
}

References _L, error, Slic3r::PrintHost::format_error(), Slic3r::GUI::format_wxstr(), Slic3r::Http::get(), get_name(), make_url(), set_auth(), and validate_version_text().

Referenced by upload().

Here is the call graph for this function:

Here is the caller graph for this function:

upload()

bool Slic3r::AstroBox::upload ( PrintHostUpload  upload_data, ProgressFn  prorgess_fn, ErrorFn  error_fn, InfoFn  info_fn  ) const

overridevirtual

Implements Slic3r::PrintHost.

{
    const char *name = get_name();
 
    const auto upload_filename = upload_data.upload_path.filename();
    const auto upload_parent_path = upload_data.upload_path.parent_path();
 
    wxString test_msg;
    if (! test(test_msg)) {
        error_fn(std::move(test_msg));
        return false;
    }
 
    bool res = true;
 
    auto url = make_url("api/files/local");
 
    BOOST_LOG_TRIVIAL(info) << boost::format("%1%: Uploading file %2% at %3%, filename: %4%, path: %5%, print: %6%")
        % name
        % upload_data.source_path
        % url
        % upload_filename.string()
        % upload_parent_path.string()
        % (upload_data.post_action == PrintHostPostUploadAction::StartPrint ? "true" : "false");
 
    auto http = Http::post(std::move(url));
    set_auth(http);
    http.form_add("print", upload_data.post_action == PrintHostPostUploadAction::StartPrint ? "true" : "false")
        .form_add("path", upload_parent_path.string())      // XXX: slashes on windows ???
        .form_add_file("file", upload_data.source_path.string(), upload_filename.string())
        .on_complete([&](std::string body, unsigned status) {
            BOOST_LOG_TRIVIAL(debug) << boost::format("%1%: File uploaded: HTTP %2%: %3%") % name % status % body;
        })
        .on_error([&](std::string body, std::string error, unsigned status) {
            BOOST_LOG_TRIVIAL(error) << boost::format("%1%: Error uploading file: %2%, HTTP %3%, body: `%4%`") % name % error % status % body;
            error_fn(format_error(body, error, status));
            res = false;
        })
        .on_progress([&](Http::Progress progress, bool &cancel) {
            prorgess_fn(std::move(progress), cancel);
            if (cancel) {
                // Upload was canceled
                BOOST_LOG_TRIVIAL(info) << "AstroBox: Upload canceled";
                res = false;
            }
        })
        .perform_sync();
 
    return res;
}

References error, Slic3r::PrintHost::format_error(), get_name(), make_url(), Slic3r::Http::post(), Slic3r::PrintHostUpload::post_action, set_auth(), Slic3r::PrintHostUpload::source_path, Slic3r::StartPrint, test(), and Slic3r::PrintHostUpload::upload_path.

Here is the call graph for this function:

validate_version_text()

bool Slic3r::AstroBox::validate_version_text ( const boost::optional< std::string > &  version_text ) const

protected

{
    return version_text ? boost::starts_with(*version_text, "AstroBox") : true;
}

Referenced by test().

Here is the caller graph for this function:

Member Data Documentation

apikey

std::string Slic3r::AstroBox::apikey

private

Referenced by set_auth().

cafile

std::string Slic3r::AstroBox::cafile

private

Referenced by set_auth().

host

std::string Slic3r::AstroBox::host

private

Referenced by get_host(), and make_url().

---

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

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