Slic3r::PresetUpdater Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/PresetUpdater.hpp>

Collaboration diagram for Slic3r::PresetUpdater:

Classes
struct	priv

Public Types
enum	UpdateResult {   R_NOOP , R_INCOMPAT_EXIT , R_INCOMPAT_CONFIGURED , R_UPDATE_INSTALLED ,   R_UPDATE_REJECT , R_UPDATE_NOTIFICATION , R_ALL_CANCELED }
enum class	UpdateParams { SHOW_TEXT_BOX , SHOW_NOTIFICATION , FORCED_BEFORE_WIZARD }

Public Member Functions
	PresetUpdater ()
	PresetUpdater (PresetUpdater &&)=delete
	PresetUpdater (const PresetUpdater &)=delete
PresetUpdater &	operator= (PresetUpdater &&)=delete
PresetUpdater &	operator= (const PresetUpdater &)=delete
	~PresetUpdater ()
void	sync (std::string http_url, std::string language, std::string plugin_version, PresetBundle *preset_bundle)
void	slic3r_update_notify ()
UpdateResult	config_update (const Semver &old_slic3r_version, UpdateParams params) const
bool	install_bundles_rsrc (std::vector< std::string > bundles, bool snapshot=true) const
void	on_update_notification_confirm ()
void	do_printer_config_update ()
void	check_vendor_update (const std::string &vendor_id)
void	check_new_vendors (const std::set< std::string > &system_vendors, std::function< void(std::vector< std::string > installed_vendors, bool declined)> callback)
bool	version_check_enabled () const

Private Attributes
std::unique_ptr< priv >	p

Detailed Description

Member Enumeration Documentation

UpdateParams

enum class Slic3r::PresetUpdater::UpdateParams

strong

Enumerator
SHOW_TEXT_BOX
SHOW_NOTIFICATION
FORCED_BEFORE_WIZARD

                          {
    SHOW_TEXT_BOX,        // force modal textbox
    SHOW_NOTIFICATION,      // only shows notification
    FORCED_BEFORE_WIZARD    // indicates that check of updated is forced before ConfigWizard opening
  };

UpdateResult

enum Slic3r::PresetUpdater::UpdateResult

Enumerator
R_NOOP
R_INCOMPAT_EXIT
R_INCOMPAT_CONFIGURED
R_UPDATE_INSTALLED
R_UPDATE_REJECT
R_UPDATE_NOTIFICATION
R_ALL_CANCELED

                    {
    R_NOOP,
    R_INCOMPAT_EXIT,
    R_INCOMPAT_CONFIGURED,
    R_UPDATE_INSTALLED,
    R_UPDATE_REJECT,
    R_UPDATE_NOTIFICATION,
    R_ALL_CANCELED
  };

Constructor & Destructor Documentation

PresetUpdater() [1/3]

Slic3r::PresetUpdater::PresetUpdater

(

)

                             :
  p(new priv())
{}

References p.

Referenced by PresetUpdater(), PresetUpdater(), operator=(), and operator=().

Here is the caller graph for this function:

PresetUpdater() [2/3]

Slic3r::PresetUpdater::PresetUpdater ( PresetUpdater && )

delete

References PresetUpdater().

Here is the call graph for this function:

PresetUpdater() [3/3]

Slic3r::PresetUpdater::PresetUpdater ( const PresetUpdater & )

delete

References PresetUpdater().

Here is the call graph for this function:

~PresetUpdater()

Slic3r::PresetUpdater::~PresetUpdater

(

)

{
  if (p && p->thread.joinable()) {
    // This will stop transfers being done by the thread, if any.
    // Cancelling takes some time, but should complete soon enough.
    p->cancel = true;
    p->thread.join();
  }
  if (p) {
    p->vendor_check_cancel = true;
    for (auto& t : p->vendor_check_threads)
      if (t.joinable())
        t.join();
  }
}

References p.

Member Function Documentation

check_new_vendors()

void Slic3r::PresetUpdater::check_new_vendors	(	const std::set< std::string > &	system_vendors,
		std::function< void(std::vector< std::string > installed_vendors, bool declined)>	callback )

{
    p->check_new_vendors(system_vendors, std::move(callback));
}

References p.

check_vendor_update()

void Slic3r::PresetUpdater::check_vendor_update

(

const std::string &

vendor_id

)

{
    if (!p->enabled_config_update) return;
    if (vendor_id.empty()) return;
 
    if (!p->checked_vendors.insert(vendor_id).second)
        return;
 
    p->vendor_check_threads.emplace_back([this, vendor_id]() {
        try {
            this->p->prune_tmp(vendor_id);
            this->p->sync_vendor_config(vendor_id);
        } catch (const std::exception& e) {
            BOOST_LOG_TRIVIAL(error) << "[Orca Updater] vendor update failed for " << vendor_id << ": " << e.what();
        } catch (...) {
            BOOST_LOG_TRIVIAL(error) << "[Orca Updater] vendor update failed for " << vendor_id << " with an unknown exception";
        }
    });
}

References p.

config_update()

PresetUpdater::UpdateResult Slic3r::PresetUpdater::config_update	(	const Semver &	old_slic3r_version,
		UpdateParams	params ) const

{
    if (! p->enabled_config_update) { return R_NOOP; }
 
    auto updates = p->get_config_updates(old_slic3r_version);
 
    if (updates.updates.size() > 0) {
 
        bool force_update = false;
        for (const auto& update : updates.updates) {
            force_update = (update.forced_update ? true : force_update);
        }
 
        //forced update
        if (force_update)
        {
            BOOST_LOG_TRIVIAL(info) << format("[Orca Updater]:Force updating will start, size %1% ", updates.updates.size());
            std::vector<std::string> bundles;
            for (const auto& update : updates.updates) {
                if (update.is_directory)
                    continue;
                bundles.push_back(update.vendor);
            }
            bool ret = p->perform_updates(std::move(updates));
            if (!ret) {
                BOOST_LOG_TRIVIAL(warning) << format("[Orca Updater]:perform_updates failed");
                return R_INCOMPAT_EXIT;
            }
 
            ret = reload_configs_update_gui();
            if (!ret) {
                BOOST_LOG_TRIVIAL(warning) << format("[Orca Updater]:reload_configs_update_gui failed");
                return R_INCOMPAT_EXIT;
            }
            for(auto b : bundles){
            Semver cur_ver = GUI::wxGetApp().preset_bundle->get_vendor_profile_version(b);
            GUI::wxGetApp()
                .plater()
                ->get_notification_manager()
                ->push_notification(GUI::NotificationType::PresetUpdateFinished,
                                    GUI::NotificationManager::NotificationLevel::ImportantNotificationLevel,
                                    Slic3r::format(_u8L("Configuration package: %1% updated to %2%"), b, cur_ver.to_string()));
            }
            return R_UPDATE_INSTALLED;
        }
 
        // regular update
        if (params == UpdateParams::SHOW_NOTIFICATION) {
            p->set_waiting_updates(updates);
            GUI::wxGetApp().plater()->get_notification_manager()->push_notification(GUI::NotificationType::PresetUpdateAvailable);
        }
        else {
            BOOST_LOG_TRIVIAL(info) << format("[Orca Updater]:Configuration package available. size %1%, need to confirm...", p->waiting_updates.updates.size());
 
            std::vector<GUI::MsgUpdateConfig::Update> updates_msg;
            for (const auto& update : updates.updates) {
                if (update.is_directory)
                    continue;
                std::string changelog = update.change_log;
                updates_msg.emplace_back(update.vendor, update.version.config_version, update.descriptions, std::move(changelog));
            }
 
            GUI::MsgUpdateConfig dlg(updates_msg, params == UpdateParams::FORCED_BEFORE_WIZARD);
 
            const auto res = dlg.ShowModal();
            if (res == wxID_OK) {
                BOOST_LOG_TRIVIAL(debug) << "[Orca Updater]:selected yes to update";
                if (! p->perform_updates(std::move(updates)) ||
                    ! reload_configs_update_gui())
                    return R_ALL_CANCELED;
                return R_UPDATE_INSTALLED;
            }
            else {
                BOOST_LOG_TRIVIAL(info) << "[Orca Updater]:selected no for updating";
                if (params == UpdateParams::FORCED_BEFORE_WIZARD && res == wxID_CANCEL)
                    return R_ALL_CANCELED;
                return R_UPDATE_REJECT;
            }
        }
 
        // MsgUpdateConfig will show after the notificaation is clicked
    } else {
        BOOST_LOG_TRIVIAL(info) << "[Orca Updater]:No configuration updates available.";
    }
 
  return R_NOOP;
}

References _u8L, FORCED_BEFORE_WIZARD, Slic3r::format(), Slic3r::GUI::NotificationManager::ImportantNotificationLevel, p, Slic3r::GUI::PresetUpdateAvailable, Slic3r::GUI::PresetUpdateFinished, R_ALL_CANCELED, R_INCOMPAT_EXIT, R_NOOP, R_UPDATE_INSTALLED, R_UPDATE_REJECT, Slic3r::reload_configs_update_gui(), SHOW_NOTIFICATION, Slic3r::GUI::DPIAware< P >::ShowModal(), and Slic3r::Semver::to_string().

Here is the call graph for this function:

do_printer_config_update()

void Slic3r::PresetUpdater::do_printer_config_update

(

)

{
    if (!p->has_waiting_printer_updates)
        return;
    BOOST_LOG_TRIVIAL(info) << "Update of printer configs available. Asking for confirmation ...";
 
    std::vector<GUI::MsgUpdateConfig::Update> updates_msg;
    for (const auto &update : p->waiting_printer_updates.updates) {
        std::string changelog = update.change_log;
        updates_msg.emplace_back(update.vendor, update.version.config_version, update.descriptions, std::move(changelog));
    }
 
    GUI::MsgUpdateConfig dlg(updates_msg);
 
    const auto res = dlg.ShowModal();
    if (res == wxID_OK) {
        BOOST_LOG_TRIVIAL(debug) << "User agreed to perform the update";
        if (p->perform_updates(std::move(p->waiting_printer_updates)))
            p->has_waiting_printer_updates = false;
    } else {
        BOOST_LOG_TRIVIAL(info) << "User refused the update";
    }
}

References p, and Slic3r::GUI::DPIAware< P >::ShowModal().

Here is the call graph for this function:

install_bundles_rsrc()

bool Slic3r::PresetUpdater::install_bundles_rsrc	(	std::vector< std::string >	bundles,
		bool	snapshot = true ) const

{
  return p->install_bundles_rsrc(bundles, snapshot);
}

References p.

Referenced by Slic3r::GUI::ConfigWizard::priv::apply_config(), and Slic3r::PresetUpdater::priv::check_installed_vendor_profiles().

Here is the caller graph for this function:

on_update_notification_confirm()

void Slic3r::PresetUpdater::on_update_notification_confirm

(

)

{
  if (!p->has_waiting_updates)
    return;
  BOOST_LOG_TRIVIAL(info) << format("Update of %1% bundles available. Asking for confirmation ...", p->waiting_updates.updates.size());
 
  std::vector<GUI::MsgUpdateConfig::Update> updates_msg;
  for (const auto& update : p->waiting_updates.updates) {
    //BBS: skip directory
    if (update.is_directory)
      continue;
    std::string changelog = update.change_log;
    updates_msg.emplace_back(update.vendor, update.version.config_version, update.descriptions, std::move(changelog));
  }
 
  GUI::MsgUpdateConfig dlg(updates_msg);
 
  const auto res = dlg.ShowModal();
  if (res == wxID_OK) {
    BOOST_LOG_TRIVIAL(debug) << "User agreed to perform the update";
    if (p->perform_updates(std::move(p->waiting_updates)) &&
      reload_configs_update_gui()) {
      p->has_waiting_updates = false;
    }
  }
  else {
    BOOST_LOG_TRIVIAL(info) << "User refused the update";
  }
}

References Slic3r::format(), p, Slic3r::reload_configs_update_gui(), and Slic3r::GUI::DPIAware< P >::ShowModal().

Here is the call graph for this function:

operator=() [1/2]

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

delete

References PresetUpdater().

Here is the call graph for this function:

operator=() [2/2]

PresetUpdater & Slic3r::PresetUpdater::operator= ( PresetUpdater && )

delete

References PresetUpdater().

Here is the call graph for this function:

slic3r_update_notify()

void Slic3r::PresetUpdater::slic3r_update_notify

(

)

{
  if (! p->enabled_version_check)
    return;
}

References p.

sync()

void Slic3r::PresetUpdater::sync	(	std::string	http_url,
		std::string	language,
		std::string	plugin_version,
		PresetBundle *	preset_bundle )

{
  //p->set_download_prefs(GUI::wxGetApp().app_config);
  if (!p->enabled_version_check && !p->enabled_config_update) { return; }
 
  p->thread = std::thread([this, http_url, language, plugin_version]() {
    try {
      this->p->sync_version();
      if (p->cancel)
        return;
      // Vendor profile updates are triggered by check_vendor_update()
      // after the startup printer preset has been restored.
            this->p->sync_plugins(http_url, plugin_version);
            this->p->sync_printer_config(http_url);
            // Orca (PR #130): the filament library is always installed, so refresh it
            // from the updater on every startup sync rather than deferring to check_vendor_update().
            this->p->sync_vendor_config(PresetBundle::ORCA_FILAMENT_LIBRARY);
      //if (p->cancel)
      //  return;
      //remove the tooltip currently
      //this->p->sync_tooltip(http_url, language);
    } catch (const std::exception &e) {
      BOOST_LOG_TRIVIAL(error) << "[Orca Updater] background sync failed: " << e.what();
    } catch (...) {
      BOOST_LOG_TRIVIAL(error) << "[Orca Updater] background sync failed with an unknown exception";
    }
  });
}

References Slic3r::PresetBundle::ORCA_FILAMENT_LIBRARY, and p.

version_check_enabled()

bool Slic3r::PresetUpdater::version_check_enabled

(

)

const

{
  return p->enabled_version_check;
}

References p.

Member Data Documentation

p

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

private

Referenced by PresetUpdater(), ~PresetUpdater(), check_new_vendors(), check_vendor_update(), config_update(), do_printer_config_update(), install_bundles_rsrc(), on_update_notification_confirm(), slic3r_update_notify(), sync(), and version_check_enabled().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/PresetUpdater.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/PresetUpdater.cpp