Add version upgrade for 4.0

Contributes to CURA-6011 and CURA-5995

cura/CuraApplication.py

@@ -143,7 +143,7 @@ class CuraApplication(QtApplication):
     # SettingVersion represents the set of settings available in the machine/extruder definitions.
     # You need to make sure that this version number needs to be increased if there is any non-backwards-compatible
     # changes of the settings.
-    SettingVersion = 5
+    SettingVersion = 6
 
     Created = False
 

plugins/VersionUpgrade/VersionUpgrade35to40/VersionUpgrade35to40.py

@@ -0,0 +1,68 @@
+import configparser
+from typing import Tuple, List, Set
+import io
+from UM.VersionUpgrade import VersionUpgrade
+from cura.PrinterOutputDevice import ConnectionType
+deleted_settings = {"bridge_wall_max_overhang"}  # type: Set[str]
+
+
+class VersionUpgrade35to40(VersionUpgrade):
+    #  Upgrades stacks to have the new version number.
+    def upgradeStack(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
+        parser = configparser.ConfigParser(interpolation=None)
+        parser.read_string(serialized)
+
+        # Update version number.
+        parser["general"]["version"] = "4"
+        parser["metadata"]["setting_version"] = "6"
+
+        if parser["metadata"].get("um_network_key") is not None or parser["metadata"].get("octoprint_api_key") is not None:
+            # Set the connection type if um_network_key or the octoprint key is set.
+            parser["metadata"]["connection_type"] = str(ConnectionType.NetworkConnection.value)
+
+        result = io.StringIO()
+        parser.write(result)
+        return [filename], [result.getvalue()]
+        pass
+
+    def getCfgVersion(self, serialised: str) -> int:
+        parser = configparser.ConfigParser(interpolation = None)
+        parser.read_string(serialised)
+        format_version = int(parser.get("general", "version")) #Explicitly give an exception when this fails. That means that the file format is not recognised.
+        setting_version = int(parser.get("metadata", "setting_version", fallback = "0"))
+        return format_version * 1000000 + setting_version
+
+    ##  Upgrades Preferences to have the new version number.
+    def upgradePreferences(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
+        parser = configparser.ConfigParser(interpolation=None)
+        parser.read_string(serialized)
+
+        if "metadata" not in parser:
+            parser["metadata"] = {}
+        parser["general"]["version"] = "6"
+        parser["metadata"]["setting_version"] = "6"
+
+        result = io.StringIO()
+        parser.write(result)
+        return [filename], [result.getvalue()]
+
+    ##  Upgrades instance containers to have the new version
+    #   number.
+    def upgradeInstanceContainer(self, serialized: str, filename: str) -> Tuple[List[str], List[str]]:
+        parser = configparser.ConfigParser(interpolation=None)
+        parser.read_string(serialized)
+
+        # Update version number.
+        parser["general"]["version"] = "4"
+        parser["metadata"]["setting_version"] = "6"
+
+        #self._resetConcentric3DInfillPattern(parser)
+        if "values" in parser:
+            for deleted_setting in deleted_settings:
+                if deleted_setting not in parser["values"]:
+                    continue
+                del parser["values"][deleted_setting]
+
+        result = io.StringIO()
+        parser.write(result)
+        return [filename], [result.getvalue()]

plugins/VersionUpgrade/VersionUpgrade35to40/__init__.py

@@ -0,0 +1,56 @@
+from typing import Dict, Any
+
+from . import VersionUpgrade35to40
+
+upgrade = VersionUpgrade35to40.VersionUpgrade35to40()
+
+
+def getMetaData() -> Dict[str, Any]:
+    return {
+        "version_upgrade": {
+            # From                           To                              Upgrade function
+            ("preferences", 6000005):        ("preferences", 6000006,        upgrade.upgradePreferences),
+
+            ("definition_changes", 4000005): ("definition_changes", 4000006, upgrade.upgradeInstanceContainer),
+            ("quality_changes", 4000005):    ("quality_changes", 4000006,    upgrade.upgradeInstanceContainer),
+            ("quality", 4000005):            ("quality", 4000006,            upgrade.upgradeInstanceContainer),
+            ("user", 4000005):               ("user", 4000006,               upgrade.upgradeInstanceContainer),
+
+            ("machine_stack", 4000005):      ("machine_stack", 4000006,      upgrade.upgradeStack),
+            ("extruder_train", 4000005):     ("extruder_train", 4000006,     upgrade.upgradeStack),
+        },
+        "sources": {
+            "preferences": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"."}
+            },
+            "machine_stack": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"./machine_instances"}
+            },
+            "extruder_train": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"./extruders"}
+            },
+            "definition_changes": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"./definition_changes"}
+            },
+            "quality_changes": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"./quality_changes"}
+            },
+            "quality": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"./quality"}
+            },
+            "user": {
+                "get_version": upgrade.getCfgVersion,
+                "location": {"./user"}
+            }
+        }
+    }
+
+
+def register(app) -> Dict[str, Any]:
+    return {"version_upgrade": upgrade}

plugins/VersionUpgrade/VersionUpgrade35to40/plugin.json

@@ -0,0 +1,8 @@
+ {
+    "name": "Version Upgrade 3.5 to 4.0",
+    "author": "Ultimaker B.V.",
+    "version": "1.0.0",
+    "description": "Upgrades configurations from Cura 3.5 to Cura 4.0.",
+    "api": "6.0",
+    "i18n-catalog": "cura"
+}

resources/quality/abax_pri3/apri3_pla_fast.inst.cfg

@@ -4,7 +4,7 @@ name = Fine
 definition = abax_pri3
 
 [metadata]
-setting_version = 5
+setting_version = 6
 type = quality
 quality_type = normal
 weight = -1

resources/quality/abax_pri3/apri3_pla_high.inst.cfg

@@ -4,7 +4,7 @@ name = Extra Fine
 definition = abax_pri3
 
 [metadata]
-setting_version = 5
+setting_version = 6
 type = quality
 quality_type = high
 weight = 1

resources/quality/abax_pri3/apri3_pla_normal.inst.cfg

@@ -4,7 +4,7 @@ name = Fine
 definition = abax_pri3
 
 [metadata]
-setting_version = 5
+setting_version = 6
 type = quality
 quality_type = normal
 weight = 0

resources/quality/abax_pri5/apri5_pla_fast.inst.cfg

@@ -4,7 +4,7 @@ name = Fine
 definition = abax_pri5
 
 [metadata]
-setting_version = 5
+setting_version = 6
 type = quality
 quality_type = normal
 weight = -1

resources/quality/abax_pri5/apri5_pla_high.inst.cfg

@@ -4,7 +4,7 @@ name = Extra Fine
 definition = abax_pri5
 
 [metadata]
-setting_version = 5
+setting_version = 6
 type = quality
 quality_type = high
 weight = 1

resources/quality/abax_pri5/apri5_pla_normal.inst.cfg

@@ -4,7 +4,7 @@ name = Fine
 definition = abax_pri5
 
 [metadata]
-setting_version = 5
+setting_version = 6
 type = quality
 quality_type = normal
 weight = 0