PresetUpdaterWrapper as resetable unique pointer.

This commit is contained in:
David Kocik 2025-02-05 13:08:30 +01:00 committed by Lukas Matena
parent 254776dd6c
commit f1261f8e01
2 changed files with 69 additions and 56 deletions

View File

@ -19,6 +19,7 @@ wxDEFINE_EVENT(EVT_CONFIG_UPDATER_SYNC_DONE, wxCommandEvent);
PresetUpdaterWrapper::PresetUpdaterWrapper()
: m_preset_updater(std::make_unique<PresetUpdater>())
, m_preset_archive_database(std::make_unique<PresetArchiveDatabase>())
, m_ui_status(std::make_unique<PresetUpdaterUIStatus>())
{
}
PresetUpdaterWrapper::~PresetUpdaterWrapper()
@ -27,11 +28,6 @@ PresetUpdaterWrapper::~PresetUpdaterWrapper()
if (m_ui_status)
m_ui_status->set_canceled(true);
m_worker_thread.join();
if (m_ui_status) {
delete m_ui_status;
m_ui_status = nullptr;
}
}
}
@ -40,27 +36,28 @@ bool PresetUpdaterWrapper::wizard_sync(const PresetBundle* preset_bundle, const
assert(!m_modal_thread.joinable());
// Cancel sync before starting wizard to prevent two downloads at same time.
cancel_worker_thread();
PresetUpdaterUIStatus* ui_status = new PresetUpdaterUIStatus(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_5_TRIES);
Slic3r::ScopeGuard sg([ui_status]() { delete ui_status; });
GUI::ProgressUpdaterDialog* dialog = new GUI::ProgressUpdaterDialog(ui_status, parent, headline);
ui_status->set_handler(dialog);
m_ui_status->reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_5_TRIES);
GUI::ProgressUpdaterDialog* dialog = new GUI::ProgressUpdaterDialog(m_ui_status.get(), parent, headline);
m_ui_status->set_handler(dialog);
VendorMap vendors_copy = preset_bundle->vendors;
auto worker_body = [ui_status, this, vendors_copy, full_sync]()
auto worker_body = [this, vendors_copy, full_sync]()
{
if (!m_preset_archive_database->sync_blocking(ui_status)) {
ui_status->end();
if (!m_preset_archive_database->sync_blocking(m_ui_status.get())) {
m_ui_status->end();
return;
}
if (ui_status->get_canceled()) { ui_status->end(); return; }
if (m_ui_status->get_canceled()) { m_ui_status->end(); return; }
if (full_sync) {
// Since there might be new repos, we need to sync preset updater
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
m_preset_updater->sync_blocking(vendors_copy, repos, ui_status);
if (ui_status->get_canceled()) { ui_status->end(); return; }
m_preset_updater->sync_blocking(vendors_copy, repos, m_ui_status.get());
if (m_ui_status->get_canceled()) { m_ui_status->end(); return; }
m_preset_updater->update_index_db();
}
ui_status->end();
m_ui_status->end();
};
m_modal_thread = std::thread(worker_body);
// We need to call ShowModal here instead of prompting it from event callback.
@ -70,28 +67,28 @@ bool PresetUpdaterWrapper::wizard_sync(const PresetBundle* preset_bundle, const
m_modal_thread.join();
parent->RemoveChild(dialog);
dialog->Destroy();
ui_status->set_handler(nullptr);
m_ui_status->set_handler(nullptr);
// Only now it is possible to work with ui_status, that was previously used in worker thread.
if (std::string s = ui_status->get_error(); !s.empty()) {
std::string err_text = GUI::format(_u8L("Failed to download %1%"), ui_status->get_target());
if (std::string s = m_ui_status->get_error(); !s.empty()) {
std::string err_text = GUI::format(_u8L("Failed to download %1%"), m_ui_status->get_target());
GUI::ErrorDialog err_msg(nullptr, err_text + "\n\n" + s, false);
err_msg.ShowModal();
return false;
}
// Should m_preset_updater->config_update run even if there is cancel?
if (ui_status->get_canceled() /*&& !full_sync*/) {
if (m_ui_status->get_canceled() /*&& !full_sync*/) {
return false;
}
// Offer update installation.
if (full_sync) {
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
m_preset_updater->config_update(old_slic3r_version, PresetUpdater::UpdateParams::SHOW_TEXT_BOX_YES_NO, repos, ui_status);
m_preset_updater->config_update(old_slic3r_version, PresetUpdater::UpdateParams::SHOW_TEXT_BOX_YES_NO, repos, m_ui_status.get());
}
bool res = !ui_status->get_canceled();
bool res = !m_ui_status->get_canceled();
return res;
}
@ -99,28 +96,35 @@ PresetUpdater::UpdateResult PresetUpdaterWrapper::check_updates_on_user_request(
{
assert(!m_modal_thread.joinable());
cancel_worker_thread();
PresetUpdaterUIStatus* ui_status = new PresetUpdaterUIStatus(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_5_TRIES);
Slic3r::ScopeGuard sg([ui_status]() { delete ui_status; });
m_ui_status->reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_5_TRIES);
// TRN: Headline of Progress dialog
GUI::ProgressUpdaterDialog* dialog = new GUI::ProgressUpdaterDialog(ui_status, parent, _L("Checking for Configuration Updates"));
ui_status->set_handler(dialog);
GUI::ProgressUpdaterDialog* dialog = new GUI::ProgressUpdaterDialog(m_ui_status.get(), parent, _L("Checking for Configuration Updates"));
m_ui_status->set_handler(dialog);
VendorMap vendors_copy = preset_bundle->vendors;
std::string failed_paths;
PresetUpdater::UpdateResult updater_result = PresetUpdater::UpdateResult::R_ALL_CANCELED;
auto worker_body = [ui_status, this, vendors_copy, &failed_paths]()
auto worker_body = [this, vendors_copy, &failed_paths]()
{
if (!m_preset_archive_database->sync_blocking(ui_status)) {
ui_status->end();
if (!m_preset_archive_database->sync_blocking(m_ui_status.get())) {
m_ui_status->end();
return;
}
if (ui_status->get_canceled()) { ui_status->end(); return; }
if (m_ui_status->get_canceled()) {
m_ui_status->end();
return;
}
m_preset_archive_database->extract_archives_with_check(failed_paths);
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
m_preset_updater->sync_blocking(vendors_copy, repos, ui_status);
if (ui_status->get_canceled()) { ui_status->end(); return; }
m_preset_updater->sync_blocking(vendors_copy, repos, m_ui_status.get());
if (m_ui_status->get_canceled()) {
m_ui_status->end();
return;
}
m_preset_updater->update_index_db();
ui_status->end();
m_ui_status->end();
};
m_modal_thread = std::thread(worker_body);
@ -131,18 +135,18 @@ PresetUpdater::UpdateResult PresetUpdaterWrapper::check_updates_on_user_request(
m_modal_thread.join();
parent->RemoveChild(dialog);
dialog->Destroy();
ui_status->set_handler(nullptr);
m_ui_status->set_handler(nullptr);
// Only now it is possible to work with ui_status, that was previously used in worker thread.
if (std::string s = ui_status->get_error(); !s.empty()) {
std::string err_text = GUI::format(_u8L("Failed to download %1%"), ui_status->get_target());
if (std::string s = m_ui_status->get_error(); !s.empty()) {
std::string err_text = GUI::format(_u8L("Failed to download %1%"), m_ui_status->get_target());
GUI::ErrorDialog err_msg(nullptr, s, false);
err_msg.ShowModal();
return PresetUpdater::UpdateResult::R_ALL_CANCELED;
}
if (ui_status->get_canceled()) {
if (m_ui_status->get_canceled()) {
return PresetUpdater::UpdateResult::R_ALL_CANCELED;
}
@ -155,7 +159,7 @@ PresetUpdater::UpdateResult PresetUpdaterWrapper::check_updates_on_user_request(
err_msg.ShowModal();
}
// preset_updater::config_update does show wxDialog
updater_result = m_preset_updater->config_update(old_slic3r_version, PresetUpdater::UpdateParams::SHOW_TEXT_BOX, m_preset_archive_database->get_selected_archive_repositories(), ui_status);
updater_result = m_preset_updater->config_update(old_slic3r_version, PresetUpdater::UpdateParams::SHOW_TEXT_BOX, m_preset_archive_database->get_selected_archive_repositories(), m_ui_status.get());
return updater_result;
}
@ -164,10 +168,11 @@ PresetUpdater::UpdateResult PresetUpdaterWrapper::check_updates_on_startup(const
if (m_modal_thread.joinable()) {
return PresetUpdater::UpdateResult::R_ALL_CANCELED;
}
PresetUpdaterUIStatus ui_status(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
m_ui_status->reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
// preset_updater::config_update does show wxDialog
m_preset_updater->update_index_db();
return m_preset_updater->config_update(old_slic3r_version, PresetUpdater::UpdateParams::SHOW_NOTIFICATION, m_preset_archive_database->get_selected_archive_repositories(), &ui_status);
return m_preset_updater->config_update(old_slic3r_version, PresetUpdater::UpdateParams::SHOW_NOTIFICATION, m_preset_archive_database->get_selected_archive_repositories(), m_ui_status.get());
}
void PresetUpdaterWrapper::on_update_notification_confirm()
@ -175,29 +180,30 @@ void PresetUpdaterWrapper::on_update_notification_confirm()
if (m_modal_thread.joinable()) {
return;
}
PresetUpdaterUIStatus ui_status(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
m_ui_status->reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
// preset_updater::on_update_notification_confirm does show wxDialog
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
m_preset_updater->on_update_notification_confirm(repos, &ui_status);
m_preset_updater->on_update_notification_confirm(repos, m_ui_status.get());
}
bool PresetUpdaterWrapper::install_bundles_rsrc_or_cache_vendor(std::vector<std::string> bundles, bool snapshot/* = true*/) const
{
PresetUpdaterUIStatus ui_status(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
return m_preset_updater->install_bundles_rsrc_or_cache_vendor(bundles, repos, &ui_status, snapshot);
m_ui_status->reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
return m_preset_updater->install_bundles_rsrc_or_cache_vendor(bundles, repos, m_ui_status.get(), snapshot);
}
void PresetUpdaterWrapper::sync_preset_updater(wxEvtHandler* end_evt_handler, const PresetBundle* preset_bundle)
{
cancel_worker_thread();
m_ui_status = new PresetUpdaterUIStatus(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
m_ui_status->reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY);
VendorMap vendors_copy = preset_bundle->vendors;
auto worker_body = [ this, vendors_copy, end_evt_handler]()
{
const SharedArchiveRepositoryVector &repos = m_preset_archive_database->get_selected_archive_repositories();
m_preset_updater->sync_blocking(vendors_copy, repos, this->m_ui_status);
m_preset_updater->sync_blocking(vendors_copy, repos, m_ui_status.get());
if (this->m_ui_status->get_canceled()) { return; }
wxCommandEvent* evt = new wxCommandEvent(EVT_CONFIG_UPDATER_SYNC_DONE);
wxQueueEvent(end_evt_handler, evt);
@ -214,11 +220,6 @@ void PresetUpdaterWrapper::cancel_worker_thread()
} else assert(false);
m_worker_thread.join();
if (m_ui_status) {
delete m_ui_status;
m_ui_status = nullptr;
}
}
}
@ -226,7 +227,11 @@ const std::map<PresetUpdaterUIStatus::PresetUpdaterRetryPolicy, HttpRetryOpt> Pr
{PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_5_TRIES, {500ms, 5s, 4}},
{PresetUpdaterUIStatus::PresetUpdaterRetryPolicy::PURP_NO_RETRY, {0ms}}
};
PresetUpdaterUIStatus::PresetUpdaterUIStatus(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy policy)
PresetUpdaterUIStatus::PresetUpdaterUIStatus()
{
}
void PresetUpdaterUIStatus::reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy policy)
{
if (auto it = policy_map.find(policy); it != policy_map.end()) {
m_retry_policy = it->second;
@ -234,7 +239,13 @@ PresetUpdaterUIStatus::PresetUpdaterUIStatus(PresetUpdaterUIStatus::PresetUpdate
assert(false);
m_retry_policy = {0ms};
}
m_canceled = false;
m_evt_handler = nullptr;
m_error_msg.clear();
m_target.clear();
}
bool PresetUpdaterUIStatus::on_attempt(int attempt, unsigned delay)
{
if (attempt == 1) {
@ -279,7 +290,7 @@ void ProgressUpdaterDialog::on_set_status(const PresetUpdaterStatusMessageEvent&
{
if (!Pulse(evt.data)) {
set_cancel(true);
}
}
}
void ProgressUpdaterDialog::on_end(const PresetUpdaterStatusSimpleEvent& evt)
{

View File

@ -40,10 +40,12 @@ public:
PURP_NO_RETRY,
};
// called from PresetUpdaterWrapper
PresetUpdaterUIStatus(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy policy);
PresetUpdaterUIStatus();
~PresetUpdaterUIStatus(){}
void set_handler(wxEvtHandler* evt_handler) {m_evt_handler = evt_handler;}
void reset(PresetUpdaterUIStatus::PresetUpdaterRetryPolicy policy);
// called from worker thread
bool on_attempt(int attempt, unsigned delay);
void set_target(const std::string& target);
@ -152,7 +154,7 @@ private:
// m_worker_thread runs on background while m_modal_thread runs only when modal window exists.
std::thread m_worker_thread;
PresetUpdaterUIStatus* m_ui_status {nullptr};
std::unique_ptr<PresetUpdaterUIStatus> m_ui_status;
std::thread m_modal_thread;
};