PresetUpdater: Bundle incompatibility / Slic3r downgrade scnario

xs/src/slic3r/GUI/ConfigWizard.cpp

@@ -207,7 +207,7 @@ PageWelcome::PageWelcome(ConfigWizard *parent) :
 	others_buttons(new wxPanel(parent)),
 	cbox_reset(nullptr)
 {
-	if (wizard_p()->flag_startup && wizard_p()->flag_empty_datadir) {
+	if (wizard_p()->run_reason == ConfigWizard::RR_DATA_EMPTY) {
 		wxString::Format(_(L("Run %s")), ConfigWizard::name());
 		append_text(wxString::Format(
 			_(L("Hello, welcome to Slic3r Prusa Edition! This %s helps you with the initial configuration; just a few settings and you will be ready to print.")),
@@ -709,7 +709,7 @@ void ConfigWizard::priv::on_custom_setup()
 	set_page(page_firmware);
 }
 
-void ConfigWizard::priv::apply_config(AppConfig *app_config, PresetBundle *preset_bundle, PresetUpdater *updater)
+void ConfigWizard::priv::apply_config(AppConfig *app_config, PresetBundle *preset_bundle, const PresetUpdater *updater)
 {
 	const bool is_custom_setup = page_welcome->page_next() == page_firmware;
 
@@ -730,8 +730,14 @@ void ConfigWizard::priv::apply_config(AppConfig *app_config, PresetBundle *prese
 			install_bundles.emplace_back(vendor_rsrc.second);
 		}
 
-		// If the datadir was empty don't take a snapshot (it would just be an empty snapshot)
-		const bool snapshot = !flag_empty_datadir || page_welcome->reset_user_profile();
+		// Decide whether to create snapshot based on run_reason and the reset profile checkbox
+		bool snapshot = true;
+		switch (run_reason) {
+			case ConfigWizard::RR_DATA_EMPTY:    snapshot = false; break;
+			case ConfigWizard::RR_DATA_LEGACY:   snapshot = true; break;
+			case ConfigWizard::RR_DATA_INCOMPAT: snapshot = false; break;      // In this case snapshot is done by PresetUpdater with the appropriate reason
+			case ConfigWizard::RR_USER:          snapshot = page_welcome->reset_user_profile(); break;
+		}
 		if (install_bundles.size() > 0) {
 			// Install bundles from resources.
 			updater->install_bundles_rsrc(std::move(install_bundles), snapshot);
@@ -744,8 +750,7 @@ void ConfigWizard::priv::apply_config(AppConfig *app_config, PresetBundle *prese
 		app_config->set_vendors(appconfig_vendors);
 		app_config->set("version_check", page_update->version_check ? "1" : "0");
 		app_config->set("preset_update", page_update->preset_update ? "1" : "0");
-		if (flag_startup)
-			app_config->reset_selections();
+		app_config->reset_selections();
 		// ^ TODO: replace with appropriate printer selection
 		preset_bundle->load_presets(*app_config);
 	} else {
@@ -760,12 +765,11 @@ void ConfigWizard::priv::apply_config(AppConfig *app_config, PresetBundle *prese
 
 // Public
 
-ConfigWizard::ConfigWizard(wxWindow *parent, bool startup, bool empty_datadir) :
+ConfigWizard::ConfigWizard(wxWindow *parent, RunReason reason) :
 	wxDialog(parent, wxID_ANY, name(), wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER),
 	p(new priv(this))
 {
-	p->flag_startup = startup;
-	p->flag_empty_datadir = empty_datadir;
+	p->run_reason = reason;
 
 	p->load_vendors();
 	p->custom_config.reset(DynamicPrintConfig::new_from_defaults_keys({
@@ -822,10 +826,13 @@ ConfigWizard::ConfigWizard(wxWindow *parent, bool startup, bool empty_datadir) :
 
 ConfigWizard::~ConfigWizard() {}
 
-void ConfigWizard::run(PresetBundle *preset_bundle, PresetUpdater *updater)
+bool ConfigWizard::run(PresetBundle *preset_bundle, const PresetUpdater *updater)
 {
 	if (ShowModal() == wxID_OK) {
 		p->apply_config(GUI::get_app_config(), preset_bundle, updater);
+		return true;
+	} else {
+		return false;
 	}
 }
 

xs/src/slic3r/GUI/ConfigWizard.hpp

@@ -16,14 +16,23 @@ namespace GUI {
 class ConfigWizard: public wxDialog
 {
 public:
-	ConfigWizard(wxWindow *parent, bool startup, bool empty_datadir);
+	// Why is the Wizard run
+	enum RunReason {
+		RR_DATA_EMPTY,                  // No or empty datadir
+		RR_DATA_LEGACY,                 // Pre-updating datadir
+		RR_DATA_INCOMPAT,               // Incompatible datadir - Slic3r downgrade situation
+		RR_USER,                        // User requested the Wizard from the menus
+	};
+
+	ConfigWizard(wxWindow *parent, RunReason run_reason);
 	ConfigWizard(ConfigWizard &&) = delete;
 	ConfigWizard(const ConfigWizard &) = delete;
 	ConfigWizard &operator=(ConfigWizard &&) = delete;
 	ConfigWizard &operator=(const ConfigWizard &) = delete;
 	~ConfigWizard();
 
-	void run(PresetBundle *preset_bundle, PresetUpdater *updater);
+	// Run the Wizard. Return whether it was completed.
+	bool run(PresetBundle *preset_bundle, const PresetUpdater *updater);
 
 	static const wxString& name();
 private:

xs/src/slic3r/GUI/ConfigWizard_private.hpp

@@ -190,8 +190,7 @@ private:
 struct ConfigWizard::priv
 {
 	ConfigWizard *q;
-	bool flag_startup;
-	bool flag_empty_datadir;
+	ConfigWizard::RunReason run_reason;
 	AppConfig appconfig_vendors;
 	std::unordered_map<std::string, VendorProfile> vendors;
 	std::unordered_map<std::string, std::string> vendors_rsrc;
@@ -228,7 +227,7 @@ struct ConfigWizard::priv
 	void on_other_vendors();
 	void on_custom_setup();
 
-	void apply_config(AppConfig *app_config, PresetBundle *preset_bundle, PresetUpdater *updater);
+	void apply_config(AppConfig *app_config, PresetBundle *preset_bundle, const PresetUpdater *updater);
 };
 
 

xs/src/slic3r/GUI/GUI.cpp

@@ -390,7 +390,7 @@ void add_config_menu(wxMenuBar *menu, int event_preferences_changed, int event_l
 	local_menu->Bind(wxEVT_MENU, [config_id_base, event_language_change, event_preferences_changed](wxEvent &event){
 		switch (event.GetId() - config_id_base) {
 		case ConfigMenuWizard:
-            config_wizard(false, false);
+            config_wizard(ConfigWizard::RR_USER);
             break;
 		case ConfigMenuTakeSnapshot:
 			// Take a configuration snapshot.
@@ -469,10 +469,11 @@ bool check_unsaved_changes()
 	return dialog->ShowModal() == wxID_YES;
 }
 
-void config_wizard_startup(bool app_config_exists)
+bool config_wizard_startup(bool app_config_exists)
 {
 	if (! app_config_exists || g_PresetBundle->has_defauls_only()) {
-		config_wizard(true, true);
+		config_wizard(ConfigWizard::RR_DATA_EMPTY);
+		return true;
 	} else if (g_AppConfig->legacy_datadir()) {
 		// Looks like user has legacy pre-vendorbundle data directory,
 		// explain what this is and run the wizard
@@ -496,20 +497,19 @@ void config_wizard_startup(bool app_config_exists)
 		dlg.SetExtendedMessage(ext_msg);
 		const auto res = dlg.ShowModal();
 
-		config_wizard(true, false);
+		config_wizard(ConfigWizard::RR_DATA_LEGACY);
+		return true;
 	}
+	return false;
 }
 
-void config_wizard(bool startup, bool empty_datadir)
+void config_wizard(int reason)
 {
-	if (g_wxMainFrame == nullptr)
-		throw std::runtime_error("Main frame not set");
-
     // Exit wizard if there are unsaved changes and the user cancels the action.
     if (! check_unsaved_changes())
     	return;
 
-	ConfigWizard wizard(g_wxMainFrame, startup, empty_datadir);
+	ConfigWizard wizard(nullptr, static_cast<ConfigWizard::RunReason>(reason));
 	wizard.run(g_PresetBundle, g_PresetUpdater);
 
     // Load the currently selected preset into the GUI, update the preset selection box.
@@ -686,6 +686,11 @@ wxApp* get_app(){
 	return g_wxApp;
 }
 
+PresetBundle* get_preset_bundle()
+{
+	return g_PresetBundle;
+}
+
 const wxColour& get_modified_label_clr() {
 	return g_color_label_modified;
 }

xs/src/slic3r/GUI/GUI.hpp

@@ -82,6 +82,7 @@ void set_preset_updater(PresetUpdater *updater);
 
 AppConfig*	get_app_config();
 wxApp*		get_app();
+PresetBundle* get_preset_bundle();
 
 const wxColour& get_modified_label_clr();
 const wxColour& get_sys_label_clr();
@@ -93,11 +94,13 @@ extern void add_config_menu(wxMenuBar *menu, int event_preferences_changed, int
 // to notify the user whether he is aware that some preset changes will be lost.
 extern bool check_unsaved_changes();
 
-// Checks if configuration wizard needs to run, calls config_wizard if so
-extern void config_wizard_startup(bool app_config_exists);
+// Checks if configuration wizard needs to run, calls config_wizard if so.
+// Returns whether the Wizard ran.
+extern bool config_wizard_startup(bool app_config_exists);
 
 // Opens the configuration wizard, returns true if wizard is finished & accepted.
-extern void config_wizard(bool startup, bool empty_datadir);
+// The run_reason argument is actually ConfigWizard::RunReason, but int is used here because of Perl.
+extern void config_wizard(int run_reason);
 
 // Create "Preferences" dialog after selecting menu "Preferences" in Perl part
 extern void open_preferences_dialog(int event_preferences);

xs/src/slic3r/GUI/UpdateDialogs.cpp

@@ -0,0 +1,203 @@
+#include "UpdateDialogs.hpp"
+
+#include <wx/settings.h>
+#include <wx/sizer.h>
+#include <wx/event.h>
+#include <wx/stattext.h>
+#include <wx/button.h>
+#include <wx/hyperlink.h>
+#include <wx/statbmp.h>
+#include <wx/checkbox.h>
+
+#include "libslic3r/libslic3r.h"
+#include "libslic3r/Utils.hpp"
+#include "GUI.hpp"
+
+namespace Slic3r {
+namespace GUI {
+
+
+enum {
+	CONTENT_WIDTH = 400,
+	BORDER = 30,
+	VERT_SPACING = 15,
+	HORIZ_SPACING = 5,
+};
+
+
+MsgDialog::MsgDialog(const wxString &title, const wxString &headline, wxWindowID button_id) :
+	MsgDialog(title, headline, wxBitmap(from_u8(Slic3r::var("Slic3r_192px.png")), wxBITMAP_TYPE_PNG), button_id)
+{}
+
+MsgDialog::MsgDialog(const wxString &title, const wxString &headline, wxBitmap bitmap, wxWindowID button_id) :
+	wxDialog(nullptr, wxID_ANY, title),
+	boldfont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT)),
+	content_sizer(new wxBoxSizer(wxVERTICAL)),
+	btn_sizer(new wxBoxSizer(wxHORIZONTAL))
+{
+	boldfont.SetWeight(wxFONTWEIGHT_BOLD);
+
+	auto *topsizer = new wxBoxSizer(wxHORIZONTAL);
+	auto *rightsizer = new wxBoxSizer(wxVERTICAL);
+
+	auto *headtext = new wxStaticText(this, wxID_ANY, headline);
+	headtext->SetFont(boldfont);
+	headtext->Wrap(CONTENT_WIDTH);
+	rightsizer->Add(headtext);
+	rightsizer->AddSpacer(VERT_SPACING);
+
+	rightsizer->Add(content_sizer);
+
+	if (button_id != wxID_NONE) {
+		auto *button = new wxButton(this, button_id);
+		button->SetFocus();
+		btn_sizer->Add(button);
+	}
+
+	rightsizer->Add(btn_sizer, 0, wxALIGN_CENTRE_HORIZONTAL);
+
+	auto *logo = new wxStaticBitmap(this, wxID_ANY, std::move(bitmap));
+
+	topsizer->Add(logo, 0, wxALL, BORDER);
+	topsizer->Add(rightsizer, 0, wxALL, BORDER);
+
+	SetSizerAndFit(topsizer);
+}
+
+MsgDialog::~MsgDialog() {}
+
+
+// MsgUpdateSlic3r
+
+MsgUpdateSlic3r::MsgUpdateSlic3r(const Semver &ver_current, const Semver &ver_online) :
+	MsgDialog(_(L("Update available")), _(L("New version of Slic3r PE is available"))),
+	ver_current(ver_current),
+	ver_online(ver_online)
+{
+	const auto url = wxString::Format("https://github.com/prusa3d/Slic3r/releases/tag/version_%s", ver_online.to_string());
+	auto *link = new wxHyperlinkCtrl(this, wxID_ANY, url, url);
+
+	auto *text = new wxStaticText(this, wxID_ANY, _(L("To download, follow the link below.")));
+	const auto link_width = link->GetSize().GetWidth();
+	text->Wrap(CONTENT_WIDTH > link_width ? CONTENT_WIDTH : link_width);
+	content_sizer->Add(text);
+	content_sizer->AddSpacer(VERT_SPACING);
+
+	auto *versions = new wxFlexGridSizer(2, 0, VERT_SPACING);
+	versions->Add(new wxStaticText(this, wxID_ANY, _(L("Current version:"))));
+	versions->Add(new wxStaticText(this, wxID_ANY, ver_current.to_string()));
+	versions->Add(new wxStaticText(this, wxID_ANY, _(L("New version:"))));
+	versions->Add(new wxStaticText(this, wxID_ANY, ver_online.to_string()));
+	content_sizer->Add(versions);
+	content_sizer->AddSpacer(VERT_SPACING);
+
+	content_sizer->Add(link);
+	content_sizer->AddSpacer(2*VERT_SPACING);
+
+	cbox = new wxCheckBox(this, wxID_ANY, _(L("Don't notify about new releases any more")));
+	content_sizer->Add(cbox);
+	content_sizer->AddSpacer(VERT_SPACING);
+
+	Fit();
+}
+
+MsgUpdateSlic3r::~MsgUpdateSlic3r() {}
+
+bool MsgUpdateSlic3r::disable_version_check() const
+{
+	return cbox->GetValue();
+}
+
+
+// MsgUpdateConfig
+
+MsgUpdateConfig::MsgUpdateConfig(const std::unordered_map<std::string, std::string> &updates) :
+	MsgDialog(_(L("Configuration update")), _(L("Configuration update is available")), wxID_NONE)
+{
+	auto *text = new wxStaticText(this, wxID_ANY, _(L(
+		"Would you like to install it?\n\n"
+		"Note that a full configuration snapshot will be created first. It can then be restored at any time "
+		"should there be a problem with the new version.\n\n"
+		"Updated configuration bundles:"
+	)));
+	text->Wrap(CONTENT_WIDTH);
+	content_sizer->Add(text);
+	content_sizer->AddSpacer(VERT_SPACING);
+
+	auto *versions = new wxFlexGridSizer(2, 0, VERT_SPACING);
+	for (const auto &update : updates) {
+		auto *text_vendor = new wxStaticText(this, wxID_ANY, update.first);
+		text_vendor->SetFont(boldfont);
+		versions->Add(text_vendor);
+		versions->Add(new wxStaticText(this, wxID_ANY, update.second));
+	}
+
+	content_sizer->Add(versions);
+	content_sizer->AddSpacer(2*VERT_SPACING);
+
+	auto *btn_cancel = new wxButton(this, wxID_CANCEL);
+	btn_sizer->Add(btn_cancel);
+	btn_sizer->AddSpacer(HORIZ_SPACING);
+	auto *btn_ok = new wxButton(this, wxID_YES);
+	btn_sizer->Add(btn_ok);
+	btn_ok->SetFocus();
+
+	Fit();
+}
+
+MsgUpdateConfig::~MsgUpdateConfig() {}
+
+
+// MsgDataIncompatible
+
+MsgDataIncompatible::MsgDataIncompatible(const std::unordered_map<std::string, std::string> &incompats) :
+	MsgDialog(_(L("Slic3r incompatibility")), _(L("Slic3r configuration is incompatible")), wxBitmap(from_u8(Slic3r::var("Slic3r_192px_grayscale.png"))), wxID_NONE)
+{
+	auto *text = new wxStaticText(this, wxID_ANY, _(L(
+		"This version of Slic3r PE is not compatible with currently installed configuration bundles.\n"
+		"This probably happened as a result of running an older Slic3r PE after using a newer one.\n\n"
+		"TODO: more instrs\n"
+	)));
+	text->Wrap(CONTENT_WIDTH);
+	content_sizer->Add(text);
+
+	auto *text2 = new wxStaticText(this, wxID_ANY, wxString::Format(_(L("This Slic3r PE version: %s")), SLIC3R_VERSION));
+	text2->Wrap(CONTENT_WIDTH);
+	content_sizer->Add(text2);
+	content_sizer->AddSpacer(VERT_SPACING);
+
+	auto *text3 = new wxStaticText(this, wxID_ANY, _(L("Incompatible bundles:")));
+	text3->Wrap(CONTENT_WIDTH);
+	content_sizer->Add(text3);
+	content_sizer->AddSpacer(VERT_SPACING);
+
+	auto *versions = new wxFlexGridSizer(2, 0, VERT_SPACING);
+	for (const auto &incompat : incompats) {
+		auto *text_vendor = new wxStaticText(this, wxID_ANY, incompat.first);
+		text_vendor->SetFont(boldfont);
+		versions->Add(text_vendor);
+		versions->Add(new wxStaticText(this, wxID_ANY, incompat.second));
+	}
+
+	content_sizer->Add(versions);
+	content_sizer->AddSpacer(2*VERT_SPACING);
+
+	auto *btn_exit = new wxButton(this, wxID_EXIT, _(L("Exit Slic3r")));
+	btn_sizer->Add(btn_exit);
+	btn_sizer->AddSpacer(HORIZ_SPACING);
+	auto *btn_reconf = new wxButton(this, wxID_REPLACE, _(L("Re-configure")));
+	btn_sizer->Add(btn_reconf);
+	btn_exit->SetFocus();
+
+	auto exiter = [this](const wxCommandEvent& evt) { this->EndModal(evt.GetId()); };
+	btn_exit->Bind(wxEVT_BUTTON, exiter);
+	btn_reconf->Bind(wxEVT_BUTTON, exiter);
+
+	Fit();
+}
+
+MsgDataIncompatible::~MsgDataIncompatible() {}
+
+
+}
+}

xs/src/slic3r/GUI/UpdateDialogs.hpp

@@ -0,0 +1,92 @@
+#ifndef slic3r_UpdateDialogs_hpp_
+#define slic3r_UpdateDialogs_hpp_
+
+#include <string>
+#include <unordered_map>
+
+#include <wx/dialog.h>
+#include <wx/font.h>
+#include <wx/bitmap.h>
+
+#include "slic3r/Utils/Semver.hpp"
+
+class wxBoxSizer;
+class wxCheckBox;
+
+namespace Slic3r {
+
+namespace GUI {
+
+
+// A message / query dialog with a bitmap on the left and any content on the right
+// with buttons underneath.
+struct MsgDialog : wxDialog
+{
+	MsgDialog(MsgDialog &&) = delete;
+	MsgDialog(const MsgDialog &) = delete;
+	MsgDialog &operator=(MsgDialog &&) = delete;
+	MsgDialog &operator=(const MsgDialog &) = delete;
+	virtual ~MsgDialog();
+
+protected:
+	// button_id is an id of a button that can be added by default, use wxID_NONE to disable
+	MsgDialog(const wxString &title, const wxString &headline, wxWindowID button_id = wxID_OK);
+	MsgDialog(const wxString &title, const wxString &headline, wxBitmap bitmap, wxWindowID button_id = wxID_OK);
+
+	wxFont boldfont;
+	wxBoxSizer *content_sizer;
+	wxBoxSizer *btn_sizer;
+};
+
+// A confirmation dialog listing configuration updates
+class MsgUpdateSlic3r : public MsgDialog
+{
+public:
+	MsgUpdateSlic3r(const Semver &ver_current, const Semver &ver_online);
+	MsgUpdateSlic3r(MsgUpdateSlic3r &&) = delete;
+	MsgUpdateSlic3r(const MsgUpdateSlic3r &) = delete;
+	MsgUpdateSlic3r &operator=(MsgUpdateSlic3r &&) = delete;
+	MsgUpdateSlic3r &operator=(const MsgUpdateSlic3r &) = delete;
+	virtual ~MsgUpdateSlic3r();
+
+	// Tells whether the user checked the "don't bother me again" checkbox
+	bool disable_version_check() const;
+
+private:
+	const Semver &ver_current;
+	const Semver &ver_online;
+	wxCheckBox *cbox;
+};
+
+
+// Confirmation dialog informing about configuration update. Lists updated bundles & their versions.
+class MsgUpdateConfig : public MsgDialog
+{
+public:
+	// updates is a map of "vendor name" -> "version (comment)"
+	MsgUpdateConfig(const std::unordered_map<std::string, std::string> &updates);
+	MsgUpdateConfig(MsgUpdateConfig &&) = delete;
+	MsgUpdateConfig(const MsgUpdateConfig &) = delete;
+	MsgUpdateConfig &operator=(MsgUpdateConfig &&) = delete;
+	MsgUpdateConfig &operator=(const MsgUpdateConfig &) = delete;
+	~MsgUpdateConfig();
+};
+
+// Informs about currently installed bundles not being compatible with the running Slic3r. Asks about action.
+class MsgDataIncompatible : public MsgDialog
+{
+public:
+	// incompats is a map of "vendor name" -> "version restrictions"
+	MsgDataIncompatible(const std::unordered_map<std::string, std::string> &incompats);
+	MsgDataIncompatible(MsgDataIncompatible &&) = delete;
+	MsgDataIncompatible(const MsgDataIncompatible &) = delete;
+	MsgDataIncompatible &operator=(MsgDataIncompatible &&) = delete;
+	MsgDataIncompatible &operator=(const MsgDataIncompatible &) = delete;
+	~MsgDataIncompatible();
+};
+
+
+}
+}
+
+#endif