Slic3r::GUI::Downloader Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Downloader.hpp>

Inheritance diagram for Slic3r::GUI::Downloader:

Collaboration diagram for Slic3r::GUI::Downloader:

Public Member Functions
	Downloader ()
bool	get_initialized ()
void	init (const boost::filesystem::path &dest_folder)
void	start_download (const std::string &full_url)
bool	user_action_callback (DownloaderUserAction action, int id)

Private Member Functions
size_t	get_next_id ()
void	on_progress (wxCommandEvent &event)
void	on_error (wxCommandEvent &event)
void	on_complete (wxCommandEvent &event)
void	on_name_change (wxCommandEvent &event)
void	on_paused (wxCommandEvent &event)
void	on_canceled (wxCommandEvent &event)
void	set_download_state (int id, DownloadState state)

Private Attributes
bool	m_initialized { false }
std::vector< std::unique_ptr< Download > >	m_downloads
boost::filesystem::path	m_dest_folder
size_t	m_next_id { 0 }

Detailed Description

Constructor & Destructor Documentation

Downloader()

Slic3r::GUI::Downloader::Downloader

(

)

  : wxEvtHandler()
{
  //Bind(EVT_DWNLDR_FILE_COMPLETE, [](const wxCommandEvent& evt) {});
  //Bind(EVT_DWNLDR_FILE_PROGRESS, [](const wxCommandEvent& evt) {});
  //Bind(EVT_DWNLDR_FILE_ERROR, [](const wxCommandEvent& evt) {});
  //Bind(EVT_DWNLDR_FILE_NAME_CHANGE, [](const wxCommandEvent& evt) {});
 
  Bind(EVT_DWNLDR_FILE_COMPLETE, &Downloader::on_complete, this);
  Bind(EVT_DWNLDR_FILE_PROGRESS, &Downloader::on_progress, this);
  Bind(EVT_DWNLDR_FILE_ERROR, &Downloader::on_error, this);
  Bind(EVT_DWNLDR_FILE_NAME_CHANGE, &Downloader::on_name_change, this);
  Bind(EVT_DWNLDR_FILE_PAUSED, &Downloader::on_paused, this);
  Bind(EVT_DWNLDR_FILE_CANCELED, &Downloader::on_canceled, this);
}

References on_canceled(), on_complete(), on_error(), on_name_change(), on_paused(), and on_progress().

Here is the call graph for this function:

Member Function Documentation

get_initialized()

bool Slic3r::GUI::Downloader::get_initialized ( )

inline

{ return m_initialized; }

References m_initialized.

get_next_id()

size_t Slic3r::GUI::Downloader::get_next_id ( )

inlineprivate

{ return ++m_next_id; }

References m_next_id.

Referenced by start_download().

Here is the caller graph for this function:

init()

void Slic3r::GUI::Downloader::init ( const boost::filesystem::path & dest_folder )

inline

    { 
        m_dest_folder = dest_folder;
        m_initialized = true; 
    }

References m_dest_folder, and m_initialized.

on_canceled()

void Slic3r::GUI::Downloader::on_canceled ( wxCommandEvent & event )

private

{
  size_t id = event.GetInt();
  NotificationManager* ntf_mngr = wxGetApp().notification_manager();
  ntf_mngr->set_download_URL_canceled(id);
}

References Slic3r::GUI::NotificationManager::set_download_URL_canceled().

Referenced by Downloader().

Here is the call graph for this function:

Here is the caller graph for this function:

on_complete()

void Slic3r::GUI::Downloader::on_complete ( wxCommandEvent & event )

private

{
  // TODO: is this always true? :
  // here we open the file itself, notification should get 1.f progress from on progress.
    set_download_state(event.GetInt(), DownloadState::DownloadDone);
  wxArrayString paths;
  paths.Add(event.GetString());
  wxGetApp().plater()->load_files(paths);
}

References Slic3r::GUI::DownloadDone, and set_download_state().

Referenced by Downloader().

Here is the call graph for this function:

Here is the caller graph for this function:

on_error()

void Slic3r::GUI::Downloader::on_error ( wxCommandEvent & event )

private

{
  size_t id = event.GetInt();
    set_download_state(event.GetInt(), DownloadState::DownloadError);
    BOOST_LOG_TRIVIAL(error) << "Download error: " << event.GetString();
  NotificationManager* ntf_mngr = wxGetApp().notification_manager();
    ntf_mngr->set_download_URL_error(id, into_u8(event.GetString()));
  show_error(nullptr, format_wxstr(L"%1%\n%2%", _L("The download has failed") + ":", event.GetString()));
}

References _L, Slic3r::GUI::DownloadError, Slic3r::GUI::format_wxstr(), Slic3r::GUI::into_u8(), L, set_download_state(), Slic3r::GUI::NotificationManager::set_download_URL_error(), and Slic3r::GUI::show_error().

Referenced by Downloader().

Here is the call graph for this function:

Here is the caller graph for this function:

on_name_change()

void Slic3r::GUI::Downloader::on_name_change ( wxCommandEvent & event )

private

{
   
}

Referenced by Downloader().

Here is the caller graph for this function:

on_paused()

void Slic3r::GUI::Downloader::on_paused ( wxCommandEvent & event )

private

{
  size_t id = event.GetInt();
  NotificationManager* ntf_mngr = wxGetApp().notification_manager();
  ntf_mngr->set_download_URL_paused(id);
}

References Slic3r::GUI::NotificationManager::set_download_URL_paused().

Referenced by Downloader().

Here is the call graph for this function:

Here is the caller graph for this function:

on_progress()

void Slic3r::GUI::Downloader::on_progress ( wxCommandEvent & event )

private

{
  size_t id = event.GetInt();
  float percent = (float)std::stoi(into_u8(event.GetString())) / 100.f;
  //BOOST_LOG_TRIVIAL(error) << "progress " << id << ": " << percent;
  NotificationManager* ntf_mngr = wxGetApp().notification_manager();
  BOOST_LOG_TRIVIAL(trace) << "Download "<< id << ": " << percent;
  ntf_mngr->set_download_URL_progress(id, percent);
}

References Slic3r::GUI::into_u8(), Slic3r::GUI::NotificationManager::set_download_URL_progress(), and Slic3r::trace().

Referenced by Downloader().

Here is the call graph for this function:

Here is the caller graph for this function:

set_download_state()

void Slic3r::GUI::Downloader::set_download_state ( int id, DownloadState state )

private

{
    for (size_t i = 0; i < m_downloads.size(); ++i) {
        if (m_downloads[i]->get_id() == id) {
            m_downloads[i]->set_state(state);
            return;
        }
    }
}

References m_downloads.

Referenced by on_complete(), and on_error().

Here is the caller graph for this function:

start_download()

void Slic3r::GUI::Downloader::start_download

(

const std::string &

full_url

)

{
  assert(m_initialized);
 
    // Orca: Move to the 3D view
    MainFrame* mainframe = wxGetApp().mainframe;
    Plater* plater = wxGetApp().plater();
 
    mainframe->Freeze();
    mainframe->select_tab(TAB_ID_PREPARE);
    plater->select_view_3D("3D");
    plater->select_view("plate");
    plater->get_current_canvas3D()->zoom_to_bed();
    mainframe->Thaw();
 
    // Orca: Replace PS workaround for "mysterious slash" with a more dynamic approach
    // Windows seems to have fixed the issue and this provides backwards compatability for those it still affects
  boost::regex re(R"(^(orcaslicer|prusaslicer|bambustudio|cura):\/\/open[\/]?\?file=)", boost::regbase::icase);
  boost::regex re2(R"(^(bambustudioopen):\/\/)", boost::regex::icase);
    boost::smatch results;
 
  if (!boost::regex_search(full_url, results, re) && !boost::regex_search(full_url, results, re2)) {
    BOOST_LOG_TRIVIAL(error) << "Could not start download due to wrong URL: " << full_url;
        // Orca: show error
        NotificationManager* ntf_mngr = wxGetApp().notification_manager();
        ntf_mngr->push_notification(NotificationType::CustomNotification, NotificationManager::NotificationLevel::ErrorNotificationLevel,
                                    _u8L("Could not start download due to malformed URL"));
    return;
  }
    size_t id = get_next_id();
    std::string escaped_url = FileGet::escape_url(full_url.substr(results.length()));
    if (is_bambustudio_open(full_url) || (is_orca_open(full_url) && is_makerworld_link(full_url)))
        plater->request_model_download(wxString::FromUTF8(escaped_url));
    else {
        std::string text(escaped_url);
        m_downloads.emplace_back(std::make_unique<Download>(id, std::move(escaped_url), this, m_dest_folder));
        NotificationManager* ntf_mngr = wxGetApp().notification_manager();
        ntf_mngr->push_download_URL_progress_notification(id, m_downloads.back()->get_filename(),
                                                          std::bind(&Downloader::user_action_callback, this, std::placeholders::_1,
                                                                    std::placeholders::_2));
        m_downloads.back()->start();
    }
    BOOST_LOG_TRIVIAL(debug) << "started download";
}

References _u8L, Slic3r::GUI::CustomNotification, Slic3r::GUI::NotificationManager::ErrorNotificationLevel, Slic3r::GUI::FileGet::escape_url(), get_next_id(), Slic3r::is_bambustudio_open(), Slic3r::is_makerworld_link(), Slic3r::is_orca_open(), m_dest_folder, m_downloads, m_initialized, Slic3r::GUI::plater(), Slic3r::GUI::NotificationManager::push_download_URL_progress_notification(), Slic3r::GUI::NotificationManager::push_notification(), Slic3r::GUI::MainFrame::select_tab(), TAB_ID_PREPARE, and user_action_callback().

Here is the call graph for this function:

user_action_callback()

bool Slic3r::GUI::Downloader::user_action_callback	(	DownloaderUserAction	action,
		int	id )

{
  for (size_t i = 0; i < m_downloads.size(); ++i) {
    if (m_downloads[i]->get_id() == id) {
      switch (action) {
      case DownloadUserCanceled:
        m_downloads[i]->cancel();
        return true;
      case DownloadUserPaused:
        m_downloads[i]->pause();
        return true;
      case DownloadUserContinued:
        m_downloads[i]->resume();
        return true;
      case DownloadUserOpenedFolder:
        open_folder(m_downloads[i]->get_dest_folder());
        return true;
      default:
        return false;
      }
    }
  }
  return false;
}

References Slic3r::GUI::DownloadUserCanceled, Slic3r::GUI::DownloadUserContinued, Slic3r::GUI::DownloadUserOpenedFolder, Slic3r::GUI::DownloadUserPaused, and m_downloads.

Referenced by start_download().

Here is the caller graph for this function:

Member Data Documentation

m_dest_folder

boost::filesystem::path Slic3r::GUI::Downloader::m_dest_folder

private

Referenced by init(), and start_download().

m_downloads

std::vector<std::unique_ptr<Download> > Slic3r::GUI::Downloader::m_downloads

private

Referenced by set_download_state(), start_download(), and user_action_callback().

m_initialized

bool Slic3r::GUI::Downloader::m_initialized { false }

private

{ false };

Referenced by get_initialized(), init(), and start_download().

m_next_id

size_t Slic3r::GUI::Downloader::m_next_id { 0 }

private

{ 0 };

Referenced by get_next_id().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Downloader.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Downloader.cpp