mirror of
https://github.com/OrcaSlicer/OrcaSlicer.git
synced 2026-10-14 03:11:19 +00:00
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>
This commit is contained in:
HanifKoh
@@ -82,6 +82,7 @@
|
||||
#include "LifecycleEvents.hpp"
|
||||
#include "Utils.hpp"
|
||||
#include "InstanceLock.hpp"
|
||||
#include "nlohmann/json.hpp"
|
||||
|
||||
#include <sstream>
|
||||
#include "PlaceholderParser.hpp"
|
||||
@@ -2758,6 +2759,118 @@ void PresetCollection::update_after_user_presets_loaded()
|
||||
return;
|
||||
}
|
||||
|
||||
// A user preset file as written: it holds only the keys the preset sets itself, and an inherits that names a
|
||||
// renamed parent by the old name the preset was made against. Throws if the file can not be read or parsed.
|
||||
static json read_user_preset_file(const std::string &file)
|
||||
{
|
||||
boost::nowide::ifstream in(file);
|
||||
return json::parse(in);
|
||||
}
|
||||
|
||||
std::vector<LegacyUserFilamentPreset> PresetCollection::legacy_user_filament_presets(const std::map<std::string, std::vector<std::string>> &printers_by_parent)
|
||||
{
|
||||
auto has_entry = [&printers_by_parent](const std::string &name) { return printers_by_parent.count(name) > 0; };
|
||||
std::vector<LegacyUserFilamentPreset> legacy_presets;
|
||||
// The preset sync thread can add or delete presets meanwhile.
|
||||
lock();
|
||||
for (const Preset &preset : m_presets) {
|
||||
if (!preset.is_user() || preset.inherits().empty())
|
||||
continue;
|
||||
const Preset *parent = get_preset_parent(preset);
|
||||
if (parent == nullptr || !parent->is_system)
|
||||
continue;
|
||||
// An empty list already covers every printer.
|
||||
const std::vector<std::string> &own = preset.config.option<ConfigOptionStrings>("compatible_printers")->values;
|
||||
if (own.empty())
|
||||
continue;
|
||||
// The parent's name in the older release is its current name or one in its renamed_from, so only the
|
||||
// files of presets whose parent has an entry under one of those are read.
|
||||
if (!has_entry(parent->name) && std::none_of(parent->renamed_from.begin(), parent->renamed_from.end(), has_entry))
|
||||
continue;
|
||||
LegacyUserFilamentPreset legacy{preset.name, parent->name, {}, {}, preset.file, own};
|
||||
try {
|
||||
const json j = read_user_preset_file(preset.file);
|
||||
// A preset whose file sets compatible_printers, even to an empty list, was given its printers on
|
||||
// purpose and keeps exactly those.
|
||||
if (j.contains("compatible_printers"))
|
||||
continue;
|
||||
legacy.inherits = j.value(BBL_JSON_KEY_INHERITS, std::string());
|
||||
} catch (const std::exception &err) {
|
||||
BOOST_LOG_TRIVIAL(warning) << __FUNCTION__ << ": can not read " << preset.file << ": " << err.what();
|
||||
continue;
|
||||
}
|
||||
auto it = printers_by_parent.find(legacy.inherits);
|
||||
if (it == printers_by_parent.end())
|
||||
continue;
|
||||
for (const std::string &printer : it->second)
|
||||
if (std::find(own.begin(), own.end(), printer) == own.end()) {
|
||||
legacy.printers.push_back(printer);
|
||||
legacy.compatible_printers.push_back(printer);
|
||||
}
|
||||
if (!legacy.printers.empty())
|
||||
legacy_presets.push_back(std::move(legacy));
|
||||
}
|
||||
unlock();
|
||||
return legacy_presets;
|
||||
}
|
||||
|
||||
bool PresetCollection::write_legacy_user_filament_preset(const LegacyUserFilamentPreset &legacy)
|
||||
{
|
||||
// Only compatible_printers changes in the file. Saving the whole preset would also rewrite an inherits that
|
||||
// names a renamed parent by its old name, the only name older releases know it by.
|
||||
try {
|
||||
json j = read_user_preset_file(legacy.file);
|
||||
// Changed by hand or by another instance since the preset was found: a list of its own stands, and
|
||||
// another parent would need other printers.
|
||||
if (j.contains("compatible_printers") || j.value(BBL_JSON_KEY_INHERITS, std::string()) != legacy.inherits)
|
||||
return false;
|
||||
j["compatible_printers"] = legacy.compatible_printers;
|
||||
if (const std::error_code ec = write_file_atomically(legacy.file, j.dump(1, '\t') + "\n")) {
|
||||
BOOST_LOG_TRIVIAL(error) << __FUNCTION__ << ": failed to save " << legacy.file << ": " << ec.message();
|
||||
return false;
|
||||
}
|
||||
} catch (const std::exception &err) {
|
||||
BOOST_LOG_TRIVIAL(error) << __FUNCTION__ << ": can not migrate " << legacy.file << ": " << err.what();
|
||||
return false;
|
||||
}
|
||||
BOOST_LOG_TRIVIAL(info) << __FUNCTION__ << ": user preset " << legacy.preset << " gets " << legacy.printers.size()
|
||||
<< " printer(s) its parent listed in an older release";
|
||||
return true;
|
||||
}
|
||||
|
||||
void PresetCollection::apply_legacy_user_filament_presets(const std::vector<LegacyUserFilamentPreset> &written)
|
||||
{
|
||||
lock();
|
||||
for (const LegacyUserFilamentPreset &legacy : written) {
|
||||
auto it = this->find_preset_internal(legacy.preset);
|
||||
if (it == m_presets.end() || it->name != legacy.preset)
|
||||
continue; // deleted by the preset sync thread meanwhile
|
||||
std::vector<std::string> &saved = it->config.option<ConfigOptionStrings>("compatible_printers", true)->values;
|
||||
std::vector<std::string> &edited = m_edited_preset.config.option<ConfigOptionStrings>("compatible_printers", true)->values;
|
||||
// Added to the list the preset holds now rather than replacing it: the cloud sync may have given the
|
||||
// preset a newer list since it was found, and that list is still to be written out.
|
||||
std::vector<std::string> printers = saved;
|
||||
for (const std::string &printer : legacy.printers)
|
||||
if (std::find(printers.begin(), printers.end(), printer) == printers.end())
|
||||
printers.push_back(printer);
|
||||
// A change to the list pending in the settings tab stays pending. Without one, the edited copy and the
|
||||
// snapshot unsaved changes are measured against take the written list, so nothing reads as modified.
|
||||
if (m_idx_selected == static_cast<size_t>(it - m_presets.begin()) && edited == saved) {
|
||||
edited = printers;
|
||||
if (m_saved_preset.name == it->name)
|
||||
m_saved_preset.config.option<ConfigOptionStrings>("compatible_printers", true)->values = printers;
|
||||
}
|
||||
saved = printers;
|
||||
// Push the change to the cloud copy, as an edit in the settings tab would. A sync already pending for
|
||||
// the preset (a download waiting to be saved, a deletion) keeps its state.
|
||||
if (!it->setting_id.empty() && it->sync_info.empty()) {
|
||||
it->sync_info = "update";
|
||||
it->save_info();
|
||||
}
|
||||
}
|
||||
unlock();
|
||||
}
|
||||
|
||||
//BBS: validate_preset
|
||||
bool PresetCollection::validate_preset(const std::string &preset_name, std::string &inherit_name)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user