escoria setup and old branch archives

4 files changed, 259 insertions, 0 deletions

diff --git a/addons/escoria-core/game/core-scripts/migrations/esc_migration.gd b/addons/escoria-core/game/core-scripts/migrations/esc_migration.gd
new file mode 100644
index 0000000..1592f27
--- /dev/null
+++ b/addons/escoria-core/game/core-scripts/migrations/esc_migration.gd
@@ -0,0 +1,49 @@
+extends RefCounted
+class_name ESCMigration
+## Base class for all migration version scripts. Extending scripts should be
+## named like the version they migrate the savegame to. (e.g. 1.0.0.gd, 1.0.1.gd)
+
+## The savegame object to migrate
+var _savegame: ESCSaveGame:
+	get = get_savegame
+
+
+## Set the savegame[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |savegame|`ESCSaveGame`|Savegame to modify|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func set_savegame(savegame: ESCSaveGame):
+	_savegame = savegame
+
+
+## Get the savegame.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns a `ESCSaveGame` value. (`ESCSaveGame`)
+func get_savegame() -> ESCSaveGame:
+	return _savegame
+
+
+## Override this function in the version script with the things that need to be applied to the savegame[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func migrate():
+	pass
diff --git a/addons/escoria-core/game/core-scripts/migrations/esc_migration.gd.uid b/addons/escoria-core/game/core-scripts/migrations/esc_migration.gd.uid
new file mode 100644
index 0000000..3e4edb0
--- /dev/null
+++ b/addons/escoria-core/game/core-scripts/migrations/esc_migration.gd.uid
@@ -0,0 +1 @@
+uid://c6qkc3u4x23g4
diff --git a/addons/escoria-core/game/core-scripts/migrations/esc_migration_manager.gd b/addons/escoria-core/game/core-scripts/migrations/esc_migration_manager.gd
new file mode 100644
index 0000000..8db1a0d
--- /dev/null
+++ b/addons/escoria-core/game/core-scripts/migrations/esc_migration_manager.gd
@@ -0,0 +1,208 @@
+## Class that handles migrations between different game or escoria versions
+## @MANAGER
+extends RefCounted
+class_name ESCMigrationManager
+
+
+## Regular expression that matches a simple semver version string
+const VERSION_REGEX = "^(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)$"
+
+
+## Compiled regex
+var version_regex: RegEx
+
+## Constructor of the migration manager.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func _init() -> void:
+	version_regex = RegEx.new()
+	version_regex.compile(VERSION_REGEX)
+
+
+## Migrates the specified savegame from a specified version to another version based on a directory of migration scripts. The migration manager searches for scripts from after the given version up to the target version in this directory, loads them and applies the version. Each migration will return a modified version of the given savegame. The migrated savegame.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |savegame|`ESCSaveGame`|The `ESCSaveGame` object to migrate.|yes|[br]
+## |from|`String`|The source version string (e.g., "1.0.0").|yes|[br]
+## |to|`String`|The target version string (e.g., "1.1.0").|yes|[br]
+## |versions_directory|`String`|Directory path containing version migration scripts.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns a `ESCSaveGame` value. (`ESCSaveGame`)
+func migrate(
+	savegame: ESCSaveGame,
+	from: String,
+	to: String,
+	versions_directory: String
+) -> ESCSaveGame:
+	escoria.logger.info(
+		self,
+		"Migrating savegame from version %s to version %s."
+				% [from, to]
+	)
+
+	var from_info = version_regex.search(from)
+	var to_info = version_regex.search(to)
+
+	var wrong_version: bool = false
+	if from_info.get_string("major") > to_info.get_string("major"):
+		wrong_version = true
+	elif from_info.get_string("major") == to_info.get_string("major") and\
+			from_info.get_string("minor") > to_info.get_string("minor"):
+		wrong_version = true
+	elif from_info.get_string("major") == to_info.get_string("major") and\
+			from_info.get_string("minor") == to_info.get_string("minor") and\
+			from_info.get_string("patch") > to_info.get_string("patch"):
+		wrong_version = true
+
+	if wrong_version:
+		escoria.logger.error(
+			self,
+			"Can not migrate savegame from version %s to version %s." +
+			" \"To\" version must be later than \"from\" version."
+			% [from, to]
+		)
+
+	var versions = _find_versions(versions_directory, from, to)
+	versions.sort_custom(Callable(self, "_compare_version"))
+	if versions[0].get_file().get_basename() == from:
+		versions.pop_front()
+
+	for version in versions:
+		var migration_script = load(version).new()
+		if not migration_script is ESCMigration:
+			escoria.logger.error(
+				self,
+				"File %s is not a valid migration script." % version
+			)
+		escoria.logger.debug(
+			self,
+			"Migrating savegame to version %s." % version
+		)
+		(migration_script as ESCMigration).set_savegame(savegame)
+		(migration_script as ESCMigration).migrate()
+		savegame = (migration_script as ESCMigration).get_savegame()
+
+	return savegame
+
+
+## Find all fitting version scripts between the given versions in a directory and all its subdirectories.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |directory|`String`|Directory to search in|yes|[br]
+## |from|`String`|Start version to check|yes|[br]
+## |to|`String`|End version to check|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns a `Array` value. (`Array`)
+func _find_versions(directory: String, from: String, to: String) -> Array:
+	escoria.logger.trace(
+		self,
+		"Searching directory %s." % directory
+	)
+	var versions = []
+	var dir = DirAccess.open(directory)
+	dir.list_dir_begin()
+	var file_name = dir.get_next()
+	while file_name != "":
+		var version = file_name.get_basename()
+		var regex_result = version_regex.search(version)
+		if dir.current_is_dir():
+			versions += _find_versions(
+				directory.path_join(file_name),
+				from,
+				to
+			)
+		elif regex_result and _version_between(version, from, to):
+			escoria.logger.trace(
+				self,
+				"Found compatible savegame migration script for version %s." % version
+			)
+			versions.append(
+				directory.path_join(file_name)
+			)
+		file_name = dir.get_next()
+	return versions
+
+
+## Check, whether the given version is >= from and <= to[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |version|`String`|Version to check|yes|[br]
+## |from|`String`|Start version|yes|[br]
+## |to|`String`|End version|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns a `bool` value. (`bool`)
+func _version_between(version: String, from: String, to: String) -> bool:
+	var version_info = version_regex.search(version)
+	var from_info = version_regex.search(from)
+	var to_info = version_regex.search(to)
+
+	if from_info.get_string("major") < version_info.get_string("major") and \
+			version_info.get_string("major") < to_info.get_string("major"):
+		return true
+	elif from_info.get_string("major") == version_info.get_string("major") and \
+			from_info.get_string("minor") < version_info.get_string("minor"):
+		return true
+	elif from_info.get_string("major") == version_info.get_string("major") and \
+			from_info.get_string("minor") == \
+				version_info.get_string("minor") and \
+			from_info.get_string("patch") < version_info.get_string("patch"):
+		return true
+	elif to_info.get_string("major") == version_info.get_string("major") and \
+			to_info.get_string("minor") > version_info.get_string("minor"):
+		return true
+	elif to_info.get_string("major") == version_info.get_string("major") and \
+			to_info.get_string("minor") == version_info.get_string("minor") and\
+			to_info.get_string("patch") > version_info.get_string("patch"):
+		return true
+
+	return false
+
+
+## Comparator function for version strings.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |version_a|`String`|First version to compare|yes|[br]
+## |version_b|`String`|Second version to compare|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns a `bool` value. (`bool`)
+func _compare_version(version_a: String, version_b: String) -> bool:
+	var a_info = version_regex.search(version_a.get_file().get_basename())
+	var b_info = version_regex.search(version_b.get_file().get_basename())
+
+	if a_info.get_string("major") < b_info.get_string("major"):
+		return true
+	elif a_info.get_string("major") == b_info.get_string("major") and \
+			a_info.get_string("minor") < b_info.get_string("minor"):
+		return true
+	elif a_info.get_string("major") == b_info.get_string("major") and \
+			a_info.get_string("minor") == b_info.get_string("minor") and \
+			a_info.get_string("patch") < b_info.get_string("patch"):
+		return true
+
+	return false
diff --git a/addons/escoria-core/game/core-scripts/migrations/esc_migration_manager.gd.uid b/addons/escoria-core/game/core-scripts/migrations/esc_migration_manager.gd.uid
new file mode 100644
index 0000000..714e2fc
--- /dev/null
+++ b/addons/escoria-core/game/core-scripts/migrations/esc_migration_manager.gd.uid
@@ -0,0 +1 @@
+uid://bkcimcp3qsfvl