entrypoint.gd

extends Node

const updates_path := "user://updates"
const update_pack_file := "user://updates/update.zip"
const update_pack_entrypoint := "user://updates/opengamepad-ui.x86_64"

var PackageVerifier := preload("res://core/global/package_verifier.tres") as PackageVerifier
var args := OS.get_cmdline_args()
var child_pid := -1
var logger := Log.get_logger("Entrypoint")

# We don't need this here, except we do. For some reason it won't load properly
# after the entrypoint anymore and I don't care why. Don't touch this.
var settings_manager := load("res://core/global/settings_manager.tres") as SettingsManager
var input_icons := load("res://core/systems/input/input_icon_manager.tres") as InputIconManager

# Called when the node enters the scene tree for the first time.
func _ready() -> void:
	var version := load("res://core/global/version.tres") as Version
	print("OpenGamepadUI v", version.core)
	var window := get_viewport()
	window.transparent_bg = true
	
	# Apply any update packs
	if not "--skip-update-pack" in args:
		_apply_update_packs()
	
	# Launch the main interface if no child pid exists
	if child_pid < 0:
		_change_to_scene("res://core/main.tscn")
		return
	
	logger.info("Supervising child process")
	
	# Resize the window
	window.title = "OpenGamepadUI Supervisor"
	window.size = Vector2(4, 4)
	
	# On timeout, check the child pid
	var on_timeout := func():
		if OS.is_process_running(child_pid):
			return
		logger.info("Child process exited")
		get_tree().quit()
		
	# Create a timer to supervise the child pid
	var timer := Timer.new()
	timer.timeout.connect(on_timeout)
	timer.wait_time = 2
	timer.autostart = true
	add_child(timer)


# Change to the given scene
func _change_to_scene(scene_path: String) -> void:
	var scene := load(scene_path) as PackedScene
	var root := get_window()
	root.add_child.call_deferred(scene.instantiate())
	queue_free()


# Applies any update packs to load newer scripts and resources
# TODO: Verify that pack version is not older than current version before
# loading
func _apply_update_packs() -> void:
	if not FileAccess.file_exists(update_pack_file):
		return
	logger.info("Update pack was found.")
	
	# Check if we should validate update archive signatures
	var verify_signatures := not "--skip-verify-packages" in args
	if not verify_signatures:
		logger.warn("Skipping validation of update pack. This could be dangerous!")

	# Read the metadata from the update zip
	var reader := ZIPReader.new()
	if reader.open(update_pack_file) != OK:
		logger.warn("Unable to read update pack file. Not loading update pack.")
		return
	var metadata := reader.read_file("metadata.json")
	if metadata.size() == 0:
		logger.warn("Unable to read metadata.json from update pack.")
		return
	
	# Parse the metadata from the zip file
	var parsed_metadata = JSON.parse_string(metadata.get_string_from_ascii())
	if not parsed_metadata is Dictionary:
		logger.warn("Unable to parse metadata.json")
		return
	if not "version" in parsed_metadata:
		logger.warn("No version found in metadata.json")
		return
	if not "files" in parsed_metadata:
		logger.warn("No files list found in metadata.json")
		return
	logger.info("Update pack version: " + parsed_metadata["version"])
	
	# Check if the update pack is a newer version than our version
	var version := load("res://core/global/version.tres") as Version
	if not SemanticVersion.is_greater_or_equal(version.core, parsed_metadata["version"]):
		logger.info("Update pack version is older than base version")
		return
	
	# Validate and extract each file in the update pack
	var files := parsed_metadata["files"] as Dictionary
	for filename in files.keys():
		var file_data := reader.read_file(filename)
		var hash := files[filename]["hash"] as String
		var sig_b64 := files[filename]["signature"] as String
		var sig := Marshalls.base64_to_raw(sig_b64)

		# Validate the file signatures
		if verify_signatures:
			if not PackageVerifier.has_valid_signature(file_data, sig):
				logger.warn("File " + filename + " in update.zip does not have a valid signature. Not loading update pack.")
				return
		
		# Validate the hash defined in the metadata
		if PackageVerifier.get_hash_string(file_data) != hash:
			logger.warn("File " + filename + " in update.zip does not have a valid hash. Not loading update pack.")
			return

		# Check to see if this file is already extracted
		var extracted_path := "/".join([updates_path, filename])
		if FileAccess.file_exists(extracted_path):
			logger.debug("File already exists: " + extracted_path)
			var extracted_hash := PackageVerifier.get_file_hash_string(extracted_path)
			if extracted_hash == hash:
				logger.debug("File hash matches, skipping")
				continue
	
		# Write the extracted file from the update pack
		var extracted_file := FileAccess.open(extracted_path, FileAccess.WRITE)
		extracted_file.store_buffer(file_data)
		extracted_file.flush()
		extracted_file.close()
		
		# Set execute permissions
		if filename == "opengamepad-ui.x86_64":
			var file_path := ProjectSettings.globalize_path(extracted_path)
			if OS.execute("chmod", ["+x", file_path]) != OK:
				logger.warn("Failed to set execute permissions. Not loading update pack")
				return
			
			# Try to run setcap to allow setting thread priorities
			if OS.execute("/usr/share/opengamepadui/scripts/make_nice", []) != OK:
				logger.warn("Unable to run setcap to enable thread priorities")

	# Launch the update pack executable and exit
	var update_bin := ProjectSettings.globalize_path(update_pack_entrypoint)
	var update_args := PackedStringArray([])
	update_args.append_array(OS.get_cmdline_args())
	update_args.append("--skip-update-pack")
	update_args.append("--")
	update_args.append_array(OS.get_cmdline_user_args())
	
	logger.info("Launching update pack: " + update_bin + " " + " ".join(update_args))
	child_pid = OS.create_process(update_bin, update_args)
	logger.info("Launched OpenGamepadUI with pid: " + str(child_pid))