Review FirstTimePopup wizard

rsubtil · rsubtil · commit fba974db11a4 · 2023-08-04T14:11:30.000+01:00
diff --git a/scenes/config/settings/system/SelectExtensionsPopup.gd b/scenes/config/settings/system/SelectExtensionsPopup.gd
@@ -21,7 +21,7 @@ func start(system_name: String, _extensions: Array):
 		create_curr_extension_button(ext)
 
 	# Add new extensions
-	var game_path : String = RetroHubConfig.config.games_dir + "/" + system_name
+	var game_path : String = RetroHubConfig.config.games_dir.path_join(system_name)
 	var dir := DirAccess.open(game_path)
 	if dir:
 		#warning-ignore:return_value_discarded
diff --git a/scenes/popups/first_time/DoneSection.tscn b/scenes/popups/first_time/DoneSection.tscn
@@ -11,6 +11,8 @@ layout_mode = 3
 anchors_preset = 15
 anchor_right = 1.0
 anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
 size_flags_horizontal = 3
 size_flags_vertical = 3
 script = ExtResource("3")
diff --git a/scenes/popups/first_time/EmulatorsSection.gd b/scenes/popups/first_time/EmulatorsSection.gd
@@ -96,7 +96,7 @@ func handle_emulator_info(system_raw: Dictionary) -> bool:
 					continue
 				var corepaths := []
 				for core in avail_cores:
-					corepaths.push_back(corespath + "/" + core["file"])
+					corepaths.push_back(corespath.path_join(core["file"]))
 				var corepath := FileUtils.test_for_valid_path(corepaths)
 				if not corepath.is_empty():
 					for core in avail_cores:
diff --git a/scenes/popups/first_time/FirstTimePopups.gd b/scenes/popups/first_time/FirstTimePopups.gd
@@ -47,6 +47,7 @@ func _on_MainContent_tab_changed(tab):
 		counter += 1
 
 
-func _on_FirstTimePopup_popup_hide():
-	RetroHubConfig.emit_signal("config_ready", RetroHubConfig.config)
-	queue_free()
+func _on_visibility_changed():
+	if not visible:
+		RetroHubConfig.emit_signal("config_ready", RetroHubConfig.config)
+		queue_free()
diff --git a/scenes/popups/first_time/FirstTimePopups.tscn b/scenes/popups/first_time/FirstTimePopups.tscn
@@ -220,6 +220,7 @@ size_flags_horizontal = 2
 text = "for scrolling information"
 
 [connection signal="about_to_popup" from="." to="." method="_on_FirstTimePopup_about_to_show"]
+[connection signal="visibility_changed" from="." to="." method="_on_visibility_changed"]
 [connection signal="tab_changed" from="Panel/HBoxContainer/MainContent" to="." method="_on_MainContent_tab_changed"]
 [connection signal="advance_section" from="Panel/HBoxContainer/MainContent/IntroductionSection" to="." method="advance_section"]
 [connection signal="advance_section" from="Panel/HBoxContainer/MainContent/RegionSection" to="." method="advance_section"]
diff --git a/scenes/popups/scraper/ScraperPopup.gd b/scenes/popups/scraper/ScraperPopup.gd
@@ -303,11 +303,10 @@ func prepare_media_scrape_from_search(game_entry: RetroHubScraperGameEntry, sear
 func t_on_media_scrape_finished(game_data: RetroHubGameData, type: int, data: PackedByteArray, extension: String):
 	if pending_medias.has(game_data):
 		# Save media
-		var path := RetroHubConfig.get_gamemedia_dir() + "/" + \
-					game_data.system.name + "/" + \
-					RetroHubMedia.convert_type_to_media_path(type) + "/" + \
-					game_data.path.get_file().get_basename() + \
-					"." + extension
+		var path := RetroHubConfig.get_gamemedia_dir() \
+						.path_join(game_data.system.name) \
+						.path_join(RetroHubMedia.convert_type_to_media_path(type)) \
+						.path_join(game_data.path.get_file().get_basename() + "." + extension)
 		FileUtils.ensure_path(path)
 		var file := FileAccess.open(path, FileAccess.WRITE)
 		if file:
diff --git a/scenes/root/Root.gd b/scenes/root/Root.gd
@@ -25,11 +25,11 @@ func _enter_tree():
 	#resources_remap.append_array([
 	#])
 
-func _input(event: InputEvent):
+func _raw_input(event: InputEvent):
 	if not RetroHub._running_game:
 		if event.is_action_pressed("rh_menu") and not RetroHubConfig.config.is_first_time:
-			get_viewport().set_input_as_handled()
 			if not $ConfigPopup.visible:
+				get_viewport().set_input_as_handled()
 				$ConfigPopup.popup()
 
 func _ready():
diff --git a/source/Config.gd b/source/Config.gd
@@ -294,7 +294,7 @@ func load_game_data_files():
 		if dir.current_is_dir() and \
 			((_systems_raw.has(file_name) and not _systems_raw[file_name].has("#delete")) or \
 			_system_renames.has(file_name)):
-			load_system_gamelists_files(config.games_dir + "/" + file_name, file_name)
+			load_system_gamelists_files(config.games_dir.path_join(file_name), file_name)
 		# We are not interested in files, only folders
 		file_name = dir.get_next()
 	dir.list_dir_end()
@@ -310,7 +310,7 @@ func load_system_gamelists_files(folder_path: String, system_name: String):
 		return
 	var file_name := dir.get_next()
 	while file_name != "":
-		var full_path := folder_path + "/" + file_name
+		var full_path := folder_path.path_join(file_name)
 		if dir.current_is_dir():
 			# Recurse
 			# TODO: prevent infinite recursion with shortcuts/symlinks
@@ -350,10 +350,9 @@ func load_system_gamelists_files(folder_path: String, system_name: String):
 	dir.list_dir_end()
 
 func make_system_folder(system_raw: Dictionary):
-	var path : String = config.games_dir + "/" + system_raw["name"]
-	var dir := DirAccess.open(path)
-	if dir and not dir.dir_exists(path):
-		if dir.make_dir_recursive(path):
+	var path : String = config.games_dir.path_join(system_raw["name"])
+	if not DirAccess.dir_exists_absolute(path):
+		if DirAccess.make_dir_recursive_absolute(path):
 			push_error("Failed to create system folder " + path)
 
 func fetch_game_data(path: String, game: RetroHubGameData) -> bool:
@@ -378,7 +377,7 @@ func fetch_game_data(path: String, game: RetroHubGameData) -> bool:
 	return true
 
 func get_game_data_path_from_file(system_name: String, file_name: String) -> String:
-	return get_gamelists_dir() + "/" + system_name + "/" + file_name.get_file().trim_suffix(file_name.get_extension()) + "json"
+	return get_gamelists_dir().path_join(system_name).path_join(file_name.get_file().trim_suffix(file_name.get_extension()) + "json")
 
 func save_game_data(game_data: RetroHubGameData) -> bool:
 	var metadata_path := get_game_data_path_from_file(game_data.system.name, game_data.path)
@@ -424,9 +423,9 @@ func is_file_from_system(file_name: String, system_name: String) -> bool:
 func load_theme() -> bool:
 	var current_theme := config.current_theme
 	if current_theme.ends_with(".pck"):
-		theme_path = get_themes_dir() + "/" + current_theme
+		theme_path = get_themes_dir().path_join(current_theme)
 	else:
-		theme_path = get_default_themes_dir() + "/" + current_theme + ".pck"
+		theme_path = get_default_themes_dir().path_join(current_theme + ".pck")
 	# FIXME: Theme hot-reloading is disabled until nasty GDScript bug is solved
 	if not ProjectSettings.is_pack_loaded(theme_path):
 		if not ProjectSettings.load_resource_pack(theme_path, false):
diff --git a/source/Media.gd b/source/Media.gd
@@ -126,7 +126,7 @@ func retrieve_media_data(game_data: RetroHubGameData, types: int = Type.ALL) ->
 		_media_cache[game_data] = RetroHubGameMediaData.new()
 	var game_media_data : RetroHubGameMediaData = _media_cache[game_data]
 
-	var media_path := RetroHubConfig.get_gamemedia_dir() + "/" + game_data.system_path
+	var media_path := RetroHubConfig.get_gamemedia_dir().path_join(game_data.system_path)
 	var game_path := game_data.path.get_file().get_basename()
 
 	var path : String
diff --git a/source/emulators/RetroarchEmulator.gd b/source/emulators/RetroarchEmulator.gd
@@ -51,7 +51,7 @@ func _init(emulator_raw : Dictionary, game_data : RetroHubGameData, system_cores
 	for core_name in system_cores:
 		for core_info in emulator_raw["cores"]:
 			if core_info["name"] == core_name:
-				var core_file_path : String = corepath + "/" + core_info["file"]
+				var core_file_path : String = corepath.path_join(core_info["file"])
 				if FileAccess.file_exists(core_file_path):
 					corefile = core_info["file"]
 					_substitutes["corefile"] = corefile
diff --git a/source/importers/EmulationStationImporter.gd b/source/importers/EmulationStationImporter.gd
@@ -78,7 +78,7 @@ func get_estimated_size() -> int:
 			var next := dir.get_next()
 			while not next.is_empty():
 				if dir.current_is_dir():
-					folder_size += FileUtils.get_folder_size(media_path + "/" + next, ES_MEDIA_NAMES)
+					folder_size += FileUtils.get_folder_size(media_path.path_join(next), ES_MEDIA_NAMES)
 				next = dir.get_next()
 	return folder_size
 
@@ -99,7 +99,7 @@ func is_available() -> bool:
 		var next := dir.get_next()
 		while not next.is_empty():
 			if dir.current_is_dir():
-				config_level = int(max(config_level, check_theme_config_level(theme_path + "/" + next)))
+				config_level = int(max(config_level, check_theme_config_level(theme_path.path_join(next))))
 			next = dir.get_next()
 
 	if config_level <= MAXIMUM_SUPPORTED_CONFIG_LEVEL:
@@ -125,7 +125,7 @@ func check_theme_config_level(base_path: String) -> int:
 
 	var path := dir.get_next()
 	while not path.is_empty():
-		var file := base_path + "/" + path + "/theme.xml"
+		var file := base_path.path_join(path).path_join("theme.xml")
 		if dir.file_exists(file):
 			var config_level := inspect_theme_xml(file)
 			if config_level != -1:
@@ -195,7 +195,7 @@ func import_metadata():
 		var next_folder := dir.get_next()
 		while not next_folder.is_empty():
 			if dir.current_is_dir():
-				var gamelist_path := gamelists_path + "/" + next_folder + "/gamelist.xml"
+				var gamelist_path := gamelists_path.path_join(next_folder).path_join("gamelist.xml")
 				progress_minor("Reading gamedata from \"%s\"..." % next_folder)
 				var gamelist_dict := XML2JSON.parse(gamelist_path)
 				if not gamelist_dict.is_empty() and gamelist_dict.has("gameList"):
@@ -210,7 +210,7 @@ func import_metadata():
 			next_folder = dir.get_next()
 	reset_minor(total_games)
 	for system in gamelists.keys():
-		var base_path := RetroHubConfig.get_gamelists_dir() + "/" + (system as String)
+		var base_path := RetroHubConfig.get_gamelists_dir().path_join(system as String)
 		FileUtils.ensure_path(base_path)
 		var data = gamelists[system]
 		if data is Array:
@@ -221,9 +221,9 @@ func import_metadata():
 
 func process_metadata(system: String, dict: Dictionary):
 	var game_data := RetroHubGameData.new()
-	var root_path := RetroHubConfig.config.games_dir + "/" + system
+	var root_path := RetroHubConfig.config.games_dir.path_join(system)
 	game_data.has_metadata = true
-	game_data.path = root_path + "/" + dict["path"].substr(2)
+	game_data.path = root_path.path_join(dict["path"].substr(2))
 	progress_minor("Converting \"%s\" (\"%s\")" % [game_data.path.get_file(), system])
 	if dict.has("name"):
 		game_data.name = dict["name"]
@@ -252,7 +252,10 @@ func process_metadata(system: String, dict: Dictionary):
 		game_data.last_played = dict["lastplayed"]
 	if dict.has("favorite"):
 		game_data.favorite = bool(dict["favorite"])
-	var short_path := system + "/" + game_data.path.get_file().get_basename()
+	var short_path := system.path_join(game_data.path.get_file().get_basename())
+	if(RetroHubConfig.systems.has(system)):
+		game_data.system = RetroHubConfig.systems[system]
+	game_data.system_path = system
 	game_datas[short_path] = game_data
 
 
@@ -263,16 +266,16 @@ func import_media(copy: bool):
 		var next := dir.get_next()
 		while not next.is_empty():
 			if dir.current_is_dir():
-				count += FileUtils.get_file_count(media_path + "/" + next, ES_MEDIA_NAMES)
+				count += FileUtils.get_file_count(media_path.path_join(next), ES_MEDIA_NAMES)
 			next = dir.get_next()
 	reset_minor(count)
 	if not dir.list_dir_begin() :# TODOGODOT4 fill missing arguments https://github.com/godotengine/godot/pull/40547
 		var next := dir.get_next()
 		while not next.is_empty():
 			if dir.current_is_dir():
-				var base_path := RetroHubConfig.get_gamemedia_dir() + "/" + next
+				var base_path := RetroHubConfig.get_gamemedia_dir().path_join(next)
 				FileUtils.ensure_path(base_path)
-				process_media_subfolder(media_path + "/" + next, next, copy)
+				process_media_subfolder(media_path.path_join(next), next, copy)
 			next = dir.get_next()
 
 func process_media_subfolder(path: String, system: String, copy: bool):
@@ -281,7 +284,7 @@ func process_media_subfolder(path: String, system: String, copy: bool):
 		var next := dir.get_next()
 		while not next.is_empty():
 			if dir.current_is_dir() and next in ES_MEDIA_NAMES:
-				process_media(path + "/" + next, system, RH_MEDIA_NAMES[ES_MEDIA_NAMES.find(next)], copy)
+				process_media(path.path_join(next), system, RH_MEDIA_NAMES[ES_MEDIA_NAMES.find(next)], copy)
 			next = dir.get_next()
 
 func process_media(path: String, system: String, media_name: String, copy: bool):
@@ -290,8 +293,8 @@ func process_media(path: String, system: String, media_name: String, copy: bool)
 		var next := dir.get_next()
 		while not next.is_empty():
 			if not dir.current_is_dir():
-				var from_path := path + "/" + next
-				var to_path := RetroHubConfig.get_gamemedia_dir() + "/" + system + "/" + media_name + "/" + from_path.get_file()
+				var from_path := path.path_join(next)
+				var to_path := RetroHubConfig.get_gamemedia_dir().path_join(system).path_join(media_name).path_join(from_path.get_file())
 				FileUtils.ensure_path(to_path)
 				if copy:
 					progress_minor("Copying \"%s\" (\"%s\")" % [from_path.get_file(), system])
@@ -301,7 +304,7 @@ func process_media(path: String, system: String, media_name: String, copy: bool)
 					progress_minor("Moving \"%s\" (\"%s\")" % [from_path.get_file(), system])
 					if dir.rename(from_path, to_path):
 						push_error("Failed to move \"%s\" to \"%s\"" % [from_path, to_path])
-				var short_path := system + "/" + from_path.get_file().get_basename()
+				var short_path := system.path_join(from_path.get_file().get_basename())
 				if game_datas.has(short_path):
 					game_datas[short_path].has_media = true
 			next = dir.get_next()
diff --git a/source/importers/RetroArchImporter.gd b/source/importers/RetroArchImporter.gd
@@ -65,7 +65,7 @@ func get_estimated_size() -> int:
 			var next := dir.get_next()
 			while not next.is_empty():
 				if dir.current_is_dir() and next != "cheevos":
-					folder_size += FileUtils.get_folder_size(thumbnails_path + "/" + next, RA_MEDIA_NAMES)
+					folder_size += FileUtils.get_folder_size(thumbnails_path.path_join(next), RA_MEDIA_NAMES)
 				next = dir.get_next()
 	return folder_size
 
@@ -108,15 +108,15 @@ func import_metadata():
 		var next := dir.get_next()
 		while not next.is_empty():
 			if not dir.current_is_dir() and next.to_lower().ends_with(".lpl"):
-				var lpl_file := playlists_path + "/" + next
+				var lpl_file := playlists_path.path_join(next)
 				progress_minor("Reading gamedata from \"%s\"..." % next)
 				var system_name := guess_system_name(lpl_file)
 				if not system_name.is_empty():
 					gamelists[system_name] = process_lpl_file(lpl_file)
 			next = dir.get_next()
 	reset_minor(total_games)
 	for system in gamelists.keys():
-		var base_path := RetroHubConfig.get_gamelists_dir() + "/" + (system as String)
+		var base_path := RetroHubConfig.get_gamelists_dir().path_join(system as String)
 		FileUtils.ensure_path(base_path)
 		for child in gamelists[system]:
 			process_metadata(system, child)
@@ -158,13 +158,16 @@ func process_lpl_file(path: String) -> Array:
 
 func process_metadata(system: String, dict: Dictionary):
 	var game_data := RetroHubGameData.new()
-	var root_path := RetroHubConfig.config.games_dir + "/" + system
+	var root_path := RetroHubConfig.config.games_dir.path_join(system)
 	game_data.has_metadata = true
-	game_data.path = root_path + "/" + dict["path"].substr(2)
+	game_data.path = root_path.path_join(dict["path"].substr(2))
 	progress_minor("Converting \"%s\" (\"%s\")" % [game_data.path.get_file(), system])
 	if dict.has("name"):
 		game_data.name = dict["name"]
-	var short_path := system + "/" + game_data.path.get_file().get_basename()
+	var short_path := system.path_join(game_data.path.get_file().get_basename())
+	if RetroHubConfig.systems.has(system):
+		game_data.system = RetroHubConfig.systems[system]
+	game_data.system_path = system
 	game_datas[short_path] = game_data
 
 
@@ -175,7 +178,7 @@ func import_media(copy: bool):
 		var next := dir.get_next()
 		while not next.is_empty():
 			if dir.current_is_dir() and next != "cheevos":
-				count += FileUtils.get_file_count(thumbnails_path + "/" + next, RA_MEDIA_NAMES)
+				count += FileUtils.get_file_count(thumbnails_path.path_join(next), RA_MEDIA_NAMES)
 			next = dir.get_next()
 	reset_minor(count)
 	if not dir.list_dir_begin() :# TODOGODOT4 fill missing arguments https://github.com/godotengine/godot/pull/40547
@@ -184,9 +187,9 @@ func import_media(copy: bool):
 			if dir.current_is_dir() and next != "cheevos":
 				var system_name := guess_system_name(next)
 				if not system_name.is_empty():
-					var base_path := RetroHubConfig.get_gamemedia_dir() + "/" + system_name
+					var base_path := RetroHubConfig.get_gamemedia_dir().path_join(system_name)
 					FileUtils.ensure_path(base_path)
-					process_media_subfolder(thumbnails_path + "/" + next, system_name, copy)
+					process_media_subfolder(thumbnails_path.path_join(next), system_name, copy)
 			next = dir.get_next()
 
 func process_media_subfolder(path: String, system: String, copy: bool):
@@ -195,21 +198,21 @@ func process_media_subfolder(path: String, system: String, copy: bool):
 		var next := dir.get_next()
 		while not next.is_empty():
 			if dir.current_is_dir() and next in RA_MEDIA_NAMES:
-				process_media(path + "/" + next, system, RH_MEDIA_NAMES[RA_MEDIA_NAMES.find(next)], copy)
+				process_media(path.path_join(next), system, RH_MEDIA_NAMES[RA_MEDIA_NAMES.find(next)], copy)
 			next = dir.get_next()
 
 func process_media(path: String, system: String, media_name: String, copy: bool):
 	var dir := DirAccess.open(path)
 	if dir and not dir.list_dir_begin() :# TODOGODOT4 fill missing arguments https://github.com/godotengine/godot/pull/40547
 		var next := dir.get_next()
-		var base_path := RetroHubConfig.get_gamemedia_dir() + "/" + system + "/" + media_name
+		var base_path := RetroHubConfig.get_gamemedia_dir().path_join(system).path_join(media_name)
 		while not next.is_empty():
 			if not dir.current_is_dir():
-				var from_path := path + "/" + next
+				var from_path := path.path_join(next)
 				# RetroHub uses game name for media names.
 				var game_data := find_game_data_with_label(next.get_basename())
 				if game_data:
-					var to_path := base_path + "/" + game_data.path.get_file().get_basename() + "." + next.get_extension()
+					var to_path := base_path.path_join(game_data.path.get_file().get_basename() + "." + next.get_extension())
 					FileUtils.ensure_path(to_path)
 					if copy:
 						progress_minor("Copying \"%s\" (\"%s\")" % [from_path.get_file(), system])
diff --git a/source/utils/FileUtils.gd b/source/utils/FileUtils.gd
@@ -47,7 +47,7 @@ func get_folder_size(path: String, filter_folders: Array = []) -> int:
 	if dir and not dir.list_dir_begin() :# TODOGODOT4 fill missing arguments https://github.com/godotengine/godot/pull/40547
 		var next := dir.get_next()
 		while not next.is_empty():
-			var fullpath := path + "/" + next
+			var fullpath := path.path_join(next)
 			if dir.current_is_dir():
 				if filter_folders.is_empty() or next in filter_folders:
 					size += get_folder_size(fullpath)
@@ -71,7 +71,7 @@ func get_file_count(path: String, filter_folders: Array = []):
 		while not next.is_empty():
 			if dir.current_is_dir():
 				if filter_folders.is_empty() or next in filter_folders:
-					count += get_file_count(path + "/" + next)
+					count += get_file_count(path.path_join(next))
 			else:
 				count += 1
 			next = dir.get_next()
diff --git a/tests/TestImporter.gd b/tests/TestImporter.gd
@@ -1,8 +1,8 @@
 extends Control
 
 func _ready():
-	var importer := RetroArchImporter.new()
+	var importer := EmulationStationImporter.new()
 	print("Availability: ", importer.is_available())
 	print("Size: ", importer.get_estimated_size())
 	print("Avail size: ", FileUtils.get_space_left())
-	#importer.begin_import(false)
+	importer.begin_import(true)
diff --git a/tests/TestImporter.tscn b/tests/TestImporter.tscn
