Keep User Filament Presets on Printers Their Parent Listed in 2.4.2 (#16367)

* Keep User Filament Presets on Printers Their Parent Listed in 2.4.2 User presets store only their diff, so they inherit the parent's compatible_printers. Profile changes since 2.4.2 renamed and narrowed many system filament presets, so user presets made against them disappear from printers they were made for and the saved selection silently falls back to another filament at startup. orca_profile_tool.py legacy-compat writes, per current system filament preset, the printers it covered in an older release and no longer lists, kept only where a preset with the same filament_id still covers the printer and they share an extruder variant. The loader gives these printers to user presets that inherit their parent's list, without writing any file; saving a preset detached, cloned or with its own list drops them. * Ask Before Migrating User Filament Presets to Their Legacy Printers Instead of giving user presets their parent's 2.4.2 printers in memory, detect the user presets that inherit their parent's compatible_printers and are missing printers from the legacy map, and offer to migrate them at startup or from Help > Migrate Filament Presets. Migrating first backs up the user folder to filament_preset_migration_<datetime>_backup.zip in the configuration folder, and migrates nothing if that fails. It then writes the printers into each preset's compatible_printers, patching only that key so the preset keeps the parent name it was saved with and older releases can still resolve it. Cloud-synced presets are marked for upload. No asks again at the next launch; "Don't remind me again" stops the startup prompt. * Key the legacy filament preset map by the parent's 2.4.2 name * Check the legacy filament preset map in CI * Limit the 2.4.2 filament preset migration to presets that need it Only presets that still name their parent as 2.4.2 did and have no printer list of their own are offered, and a preset changed after it was found is left alone. The startup prompt appears once, after upgrading from 2.4.2 or earlier, as a standard dialog that keeps "Don't remind me again"; Help > Migrate Filament Presets is unchanged. Migrating no longer overwrites an unsaved printer-list edit or marks the project modified. * Ask on Every Start and Take the User Presets Lock Once When Migrating Filament Presets The startup prompt no longer depends on the version the previous run recorded: whoever still has user filament presets that lost printers is asked, including users already on a 2.5.0 nightly or alpha. Answering No asks again at the next start; "Don't remind me again" stops it. Migration takes the user presets lock once, around the backup and every file write, instead of once per preset. A lock another instance holds is reported once ("another OrcaSlicer instance is saving presets") with nothing written, rather than as one failed preset after another once the lock's cool-down kicks in. Detection records each preset's file and the list it will get, so the writes need no collection lock while the user presets lock is held, the order InstanceLock requires; the loaded presets are updated afterwards. * Run the Legacy Compatible Printers Map Check in check_profile.sh and .ps1 CI's "Check profiles" job checks resources/info/legacy_compatible_printers.json against the v2.4.2 profiles, and its failure message points at these scripts as the local reproduction, so they run the same check: legacy_compat, right after profile_tool. The v2.4.2 tree comes from git archive of the tag, is cached in the work dir like the other downloads, re-extracted with --refresh, and fetched from upstream first when the checkout lacks the tag. * Back Up Before the User Presets Lock and Merge Migrated Printers Into the Live List The lock guard is meant for a few file operations, and zipping a large user folder is not one, so the backup is taken before it and the guard covers the writes only; each write re-reads its file, so a save that slipped in before is still respected. The in-memory update adds the lost printers to the list the preset holds at that moment rather than replacing it with the one found at detection, and leaves a pending cloud sync state alone: a download waiting to be saved kept its newer list and its "save" flag, which "update" would have cancelled. The lock message no longer blames another instance alone, since the lock is also refused for a while after a miss and when the lock file cannot be opened. --------- Co-authored-by: SoftFever <softfeverever@gmail.com>
2026-10-14 11:21:18 +00:00 · 2026-10-14 00:02:34 +08:00
parent a0a4a33c72
commit 5c8a287b5e
16 changed files with 1753 additions and 14 deletions
@@ -1109,6 +1109,8 @@ void GUI_App::post_init()
            }

            this->check_new_version_sf();
+            if (!cw_showed)
+                this->check_legacy_user_filament_presets(false);
            const auto cloud_provider = get_printer_cloud_provider();
            if (is_user_login(cloud_provider) && !app_config->get_stealth_mode()) {
              // this->check_privacy_version(0);
@@ -6817,6 +6819,71 @@ void GUI_App::reload_settings()
    }
 }

+void GUI_App::check_legacy_user_filament_presets(bool by_user)
+{
+    if (!by_user && app_config->get_bool("legacy_user_filament_presets_dont_remind"))
+        return;
+    const std::vector<LegacyUserFilamentPreset> legacy_presets = preset_bundle->legacy_user_filament_presets();
+    if (legacy_presets.empty()) {
+        if (by_user)
+            MessageDialog(mainframe, _L("All your filament presets are available on the printers they were made for."),
+                          _L("Migrate Filament Presets"), wxOK | wxICON_INFORMATION).ShowModal();
+        return;
+    }
+
+    wxString message = _L("OrcaSlicer 2.5.0 restructured many system filament presets to fix incorrect profiles and prepare "
+                          "for future features. As a result, the presets below no longer show on some printers they were made "
+                          "for. Sorry for the trouble; this is a one-time fix.\n\n"
+                          "Add those printers back to your presets now? Your presets are backed up first. You can also do this "
+                          "later from Help > Migrate Filament Presets.") + "\n";
+    for (const LegacyUserFilamentPreset &legacy : legacy_presets) {
+        message += "\n" + format_wxstr(_L("%1% (based on %2%)"), legacy.preset, legacy.parent);
+        for (const std::string &printer : legacy.printers)
+            message += "\n    " + from_u8(printer);
+    }
+    RichMessageDialog dlg(mainframe, message, _L("Migrate Filament Presets"), wxYES | wxNO | wxICON_QUESTION);
+    if (!by_user)
+        dlg.ShowCheckBox(_L("Don't remind me again"));
+    const bool migrate = dlg.ShowModal() == wxID_YES;
+    if (dlg.IsCheckBoxChecked())
+        app_config->set_bool("legacy_user_filament_presets_dont_remind", true);
+    if (!migrate)
+        return;
+
+    const PresetBundle::LegacyUserFilamentPresetMigration migration = preset_bundle->migrate_legacy_user_filament_presets(legacy_presets);
+    const std::string              &backup = migration.backup;
+    const std::vector<std::string> &failed = migration.failed;
+    if (backup.empty()) {
+        show_error(mainframe, _L("Your presets could not be backed up, so they were not migrated."));
+        return;
+    }
+    if (!migration.locked) {
+        // The lock is also refused for a while after a miss, and when the lock file itself cannot be opened.
+        show_error(mainframe, _L("The user presets folder could not be locked, so nothing was migrated. Another OrcaSlicer "
+                                 "instance may be saving presets; try again later from Help > Migrate Filament Presets."));
+        return;
+    }
+    if (failed.size() == legacy_presets.size()) {
+        show_error(mainframe, format_wxstr(_L("Your filament presets could not be migrated. A backup of your presets was saved to:\n%1%"), backup));
+        return;
+    }
+    preset_bundle->update_compatible(PresetSelectCompatibleType::Never);
+    mainframe->update_side_preset_ui();
+    for (auto tab : tabs_list) {
+        tab->reload_config();
+        tab->update_changed_ui();
+    }
+
+    message = format_wxstr(_L("Your filament presets were migrated. Select them again in the filament list where you used them.\n\n"
+                              "A backup of your presets was saved to:\n%1%"), backup);
+    if (!failed.empty()) {
+        message += "\n\n" + _L("These presets could not be migrated:");
+        for (const std::string &name : failed)
+            message += "\n" + from_u8(name);
+    }
+    MessageDialog(mainframe, message, _L("Migrate Filament Presets"), wxOK | (failed.empty() ? wxICON_INFORMATION : wxICON_WARNING)).ShowModal();
+}
+
 //BBS reload when logout
 void GUI_App::remove_user_presets()
 {