Mergining in PR #112. Reworked partitioning and added new functions

1 files changed, 270 insertions, 231 deletions

diff --git a/examples/guided.py b/examples/guided.py
index f0620b05..9339f969 100644
--- a/examples/guided.py
+++ b/examples/guided.py
@@ -1,14 +1,10 @@
 import getpass, time, json, sys, signal, os
 import archinstall
 
-# Create a storage structure for all our information.
-# We'll print this right before the user gets informed about the formatting timer.
-archinstall.storage['_guided'] = {}
-archinstall.storage['_guided_hidden'] = {} # This will simply be hidden from printouts and things.
-
 """
 This signal-handler chain (and global variable)
-is used to trigger the "Are you sure you want to abort?" question.
+is used to trigger the "Are you sure you want to abort?" question further down.
+It might look a bit odd, but have a look at the line: "if SIG_TRIGGER:"
 """
 SIG_TRIGGER = False
 def kill_handler(sig, frame):
@@ -23,13 +19,263 @@ def sig_handler(sig, frame):
 original_sigint_handler = signal.getsignal(signal.SIGINT)
 signal.signal(signal.SIGINT, sig_handler)
 
+
+def ask_user_questions():
+	"""
+	  First, we'll ask the user for a bunch of user input.
+	  Not until we're satisfied with what we want to install
+	  will we continue with the actual installation steps.
+	"""
+	if not archinstall.arguments.get('keyboard-language', None):
+		archinstall.arguments['keyboard-language'] = archinstall.select_language(archinstall.list_keyboard_languages()).strip()
+
+	# Before continuing, set the preferred keyboard layout/language in the current terminal.
+	# This will just help the user with the next following questions.
+	if len(archinstall.arguments['keyboard-language']):
+		archinstall.set_keyboard_language(archinstall.arguments['keyboard-language'])
+
+	# Set which region to download packages from during the installation
+	if not archinstall.arguments.get('mirror-region', None):
+		archinstall.arguments['mirror-region'] = archinstall.select_mirror_regions(archinstall.list_mirrors())
+	else:
+		selected_region = archinstall.arguments['mirror-region']
+		archinstall.arguments['mirror-region'] = {selected_region : archinstall.list_mirrors()[selected_region]}
+
+
+	# Ask which harddrive/block-device we will install to
+	if archinstall.arguments.get('harddrive', None):
+		archinstall.arguments['harddrive'] = archinstall.BlockDevice(archinstall.arguments['harddrive'])
+	else:
+		archinstall.arguments['harddrive'] = archinstall.select_disk(archinstall.all_disks())
+
+	# Perform a quick sanity check on the selected harddrive.
+	# 1. Check if it has partitions
+	# 3. Check that we support the current partitions
+	# 2. If so, ask if we should keep them or wipe everything
+	if archinstall.arguments['harddrive'].has_partitions():
+		archinstall.log(f"{archinstall.arguments['harddrive']} contains the following partitions:", fg='red')
+
+		# We curate a list pf supported paritions
+		# and print those that we don't support.
+		partition_mountpoints = {}
+		for partition in archinstall.arguments['harddrive']:
+			try:
+				if partition.filesystem_supported():
+					archinstall.log(f" {partition}")
+					partition_mountpoints[partition] = None
+			except archinstall.UnknownFilesystemFormat as err:
+				archinstall.log(f" {partition} (Filesystem not supported)", fg='red')
+
+		# We then ask what to do with the paritions.
+		if (option := archinstall.ask_for_disk_layout()) == 'abort':
+			archinstall.log(f"Safely aborting the installation. No changes to the disk or system has been made.")
+			exit(1)
+		elif option == 'keep-existing':
+			archinstall.arguments['harddrive'].keep_partitions = True
+
+			archinstall.log(f" ** You will now select which partitions to use by selecting mount points (inside the installation). **")
+			archinstall.log(f" ** The root would be a simple / and the boot partition /boot (as all paths are relative inside the installation). **")
+			while True:
+				# Select a partition
+				partition = archinstall.generic_select(partition_mountpoints.keys(),
+														"Select a partition by number that you want to set a mount-point for (leave blank when done): ")
+				if not partition:
+					break
+
+				# Select a mount-point
+				mountpoint = input(f"Enter a mount-point for {partition}: ").strip(' ')
+				if len(mountpoint):
+
+					# Get a valid & supported filesystem for the parition:
+					while 1:
+						new_filesystem = input(f"Enter a valid filesystem for {partition} (leave blank for {partition.filesystem}): ").strip(' ')
+						if len(new_filesystem) <= 0:
+							if partition.encrypted and partition.filesystem == 'crypto_LUKS':
+								if (autodetected_filesystem := partition.detect_inner_filesystem(archinstall.arguments.get('!encryption-password', None))):
+									new_filesystem = autodetected_filesystem
+								else:
+									archinstall.log(f"Could not auto-detect the filesystem inside the encrypted volume.", fg='red')
+									archinstall.log(f"A filesystem must be defined for the unlocked encrypted partition.")
+									continue
+							break
+
+						# Since the potentially new filesystem is new
+						# we have to check if we support it. We can do this by formatting /dev/null with the partitions filesystem.
+						# There's a nice wrapper for this on the partition object itself that supports a path-override during .format()
+						try:
+							partition.format(new_filesystem, path='/dev/null', log_formating=False, allow_formatting=True)
+						except archinstall.UnknownFilesystemFormat:
+							archinstall.log(f"Selected filesystem is not supported yet. If you want archinstall to support '{new_filesystem}', please create a issue-ticket suggesting it on github at https://github.com/Torxed/archinstall/issues.")
+							archinstall.log(f"Until then, please enter another supported filesystem.")
+							continue
+						except archinstall.SysCallError:
+							pass # Expected exception since mkfs.<format> can not format /dev/null.
+								 # But that means our .format() function supported it.
+						break
+
+					# When we've selected all three criterias,
+					# We can safely mark the partition for formatting and where to mount it.
+					# TODO: allow_formatting might be redundant since target_mountpoint should only be
+					#       set if we actually want to format it anyway.
+					partition.allow_formatting = True
+					partition.target_mountpoint = mountpoint
+					# Only overwrite the filesystem definition if we selected one:
+					if len(new_filesystem):
+						partition.filesystem = new_filesystem
+
+			archinstall.log('Using existing partition table reported above.')
+		elif option == 'format-all':
+			archinstall.arguments['filesystem'] = archinstall.ask_for_main_filesystem_format()
+			archinstall.arguments['harddrive'].keep_partitions = False
+
+	# Get disk encryption password (or skip if blank)
+	if not archinstall.arguments.get('!encryption-password', None):
+		archinstall.arguments['!encryption-password'] = archinstall.get_password(prompt='Enter disk encryption password (leave blank for no encryption): ')
+	archinstall.arguments['harddrive'].encryption_password = archinstall.arguments['!encryption-password']
+
+	# Get the hostname for the machine
+	if not archinstall.arguments.get('hostname', None):
+		archinstall.arguments['hostname'] = input('Desired hostname for the installation: ').strip(' ')
+
+	# Ask for a root password (optional, but triggers requirement for super-user if skipped)
+	if not archinstall.arguments.get('!root-password', None):
+		archinstall.arguments['!root-password'] = archinstall.get_password(prompt='Enter root password (Recommended: leave blank to leave root disabled): ')
+
+	# Ask for additional users (super-user if root pw was not set)
+	archinstall.arguments['users'] = {}
+	archinstall.arguments['superusers'] = {}
+	if not archinstall.arguments.get('!root-password', None):
+		archinstall.arguments['superusers'] = archinstall.ask_for_superuser_account('Create a required super-user with sudo privileges: ', forced=True)
+
+	users, superusers = archinstall.ask_for_additional_users('Any additional users to install (leave blank for no users): ')
+	archinstall.arguments['users'] = users
+	archinstall.arguments['superusers'] = {**archinstall.arguments['superusers'], **superusers}
+
+	# Ask for archinstall-specific profiles (such as desktop environments etc)
+	if not archinstall.arguments.get('profile', None):
+		archinstall.arguments['profile'] = archinstall.select_profile(archinstall.list_profiles())
+	else:
+		archinstall.arguments['profile'] = archinstall.list_profiles()[archinstall.arguments['profile']]
+
+	# Check the potentially selected profiles preperations to get early checks if some additional questions are needed.
+	if archinstall.arguments['profile'] and archinstall.arguments['profile'].has_prep_function():
+		with archinstall.arguments['profile'].load_instructions(namespace=f"{archinstall.arguments['profile'].namespace}.py") as imported:
+			if not imported._prep_function():
+				archinstall.log(
+					' * Profile\'s preparation requirements was not fulfilled.',
+					bg='black',
+					fg='red'
+				)
+				exit(1)
+
+	# Additional packages (with some light weight error handling for invalid package names)
+	if not archinstall.arguments.get('packages', None):
+		archinstall.arguments['packages'] = [package for package in input('Additional packages aside from base (space separated): ').split(' ') if len(package)]
+
+	# Verify packages that were given
+	try:
+		archinstall.validate_package_list(archinstall.arguments['packages'])
+	except archinstall.RequirementError as e:
+		archinstall.log(e, fg='red')
+		exit(1)
+
+	# Ask or Call the helper function that asks the user to optionally configure a network.
+	if not archinstall.arguments.get('nic', None):
+		archinstall.arguments['nic'] = archinstall.ask_to_configure_network()
+
+
+def perform_installation_steps():
+	global SIG_TRIGGER
+
+	print()
+	print('This is your chosen configuration:')
+	archinstall.log("-- Guided template chosen (with below config) --", level=archinstall.LOG_LEVELS.Debug)
+	archinstall.log(json.dumps(archinstall.arguments, indent=4, sort_keys=True, cls=archinstall.JSON), level=archinstall.LOG_LEVELS.Info)
+	print()
+
+	input('Press Enter to continue.')
+
+	"""
+		Issue a final warning before we continue with something un-revertable.
+		We mention the drive one last time, and count from 5 to 0.
+	"""
+
+	print(f" ! Formatting {archinstall.arguments['harddrive']} in ", end='')
+
+	for i in range(5, 0, -1):
+		print(f"{i}", end='')
+
+		for x in range(4):
+			sys.stdout.flush()
+			time.sleep(0.25)
+			print(".", end='')
+
+		if SIG_TRIGGER:
+			abort = input('\nDo you really want to abort (y/n)? ')
+			if abort.strip() != 'n':
+				exit(0)
+
+			if SIG_TRIGGER is False:
+				sys.stdin.read()
+			SIG_TRIGGER = False
+			signal.signal(signal.SIGINT, sig_handler)
+
+	# Put back the default/original signal handler now that we're done catching
+	# and interrupting SIGINT with "Do you really want to abort".
+	print()
+	signal.signal(signal.SIGINT, original_sigint_handler)
+
+	"""
+		Setup the blockdevice, filesystem (and optionally encryption).
+		Once that's done, we'll hand over to perform_installation()
+	"""
+	with archinstall.Filesystem(archinstall.arguments['harddrive'], archinstall.GPT) as fs:
+		# Wipe the entire drive if the disk flag `keep_partitions`is False.
+		if archinstall.arguments['harddrive'].keep_partitions is False:
+			fs.use_entire_disk(root_filesystem_type=archinstall.arguments.get('filesystem', 'btrfs'),
+								encrypt_root_partition=archinstall.arguments.get('!encryption-password', False))
+		# Otherwise, check if encryption is desired and mark the root partition as encrypted.
+		elif archinstall.arguments.get('!encryption-password', None):
+			root_partition = fs.find_partition('/')
+			root_partition.encrypted = True
+				
+		# After the disk is ready, iterate the partitions and check
+		# which ones are safe to format, and format those.
+		for partition in archinstall.arguments['harddrive']:
+			if partition.safe_to_format():
+				if partition.encrypted:
+					partition.encrypt(password=archinstall.arguments.get('!encryption-password', None))
+				else:
+					partition.format()
+			else:
+				archinstall.log(f"Did not format {partition} because .safe_to_format() returned False or .allow_formatting was False.", level=archinstall.LOG_LEVELS.Debug)
+
+		if archinstall.arguments.get('!encryption-password', None):
+			# First encrypt and unlock, then format the desired partition inside the encrypted part.
+			# archinstall.luks2() encrypts the partition when entering the with context manager, and
+			# unlocks the drive so that it can be used as a normal block-device within archinstall.
+			with archinstall.luks2(fs.find_partition('/'), 'luksloop', archinstall.arguments.get('!encryption-password', None)) as unlocked_device:
+				unlocked_device.format(fs.find_partition('/').filesystem)
+
+				perform_installation(device=unlocked_device,
+										boot_partition=fs.find_partition('/boot'),
+										language=archinstall.arguments['keyboard-language'],
+										mirrors=archinstall.arguments['mirror-region'])
+		else:
+			archinstall.arguments['harddrive'].partition[1].format('ext4')
+			perform_installation(device=fs.find_partition('/'),
+									boot_partition=fs.find_partition('/boot'),
+									language=archinstall.arguments['keyboard-language'],
+									mirrors=archinstall.arguments['mirror-region'])
+
+
 def perform_installation(device, boot_partition, language, mirrors):
 	"""
 	Performs the installation steps on a block device.
 	Only requirement is that the block devices are
 	formatted and setup prior to entering this function.
 	"""
-	with archinstall.Installer(device, boot_partition=boot_partition, hostname=archinstall.storage['_guided']['hostname']) as installation:
+	with archinstall.Installer(device, boot_partition=boot_partition, hostname=archinstall.arguments.get('hostname', 'Archinstall')) as installation:
 		## if len(mirrors):
 		# Certain services might be running that affects the system during installation.
 		# Currently, only one such service is "reflector.service" which updates /etc/pacman.d/mirrorlist
@@ -46,242 +292,35 @@ def perform_installation(device, boot_partition, language, mirrors):
 
 			# If user selected to copy the current ISO network configuration
 			# Perform a copy of the config
-			if archinstall.storage['_guided']['network'] == 'Copy ISO network configuration to installation':
+			if archinstall.arguments.get('nic', None) == 'Copy ISO network configuration to installation':
 				installation.copy_ISO_network_config(enable_services=True) # Sources the ISO network configuration to the install medium.
 
 			# Otherwise, if a interface was selected, configure that interface
-			elif archinstall.storage['_guided']['network']:
-				installation.configure_nic(**archinstall.storage['_guided']['network'])
+			elif archinstall.arguments.get('nic', None):
+				installation.configure_nic(**archinstall.arguments.get('nic', {}))
 				installation.enable_service('systemd-networkd')
 				installation.enable_service('systemd-resolved')
 
 
-			if archinstall.storage['_guided']['packages'] and archinstall.storage['_guided']['packages'][0] != '':
-				installation.add_additional_packages(archinstall.storage['_guided']['packages'])
+			if archinstall.arguments.get('packages', None) and archinstall.arguments.get('packages', None)[0] != '':
+				installation.add_additional_packages(archinstall.arguments.get('packages', None))
 
-			if 'profile' in archinstall.storage['_guided'] and len(profile := archinstall.storage['_guided']['profile']['path'].strip()):
+			if archinstall.arguments.get('profile', None) and len(profile := archinstall.arguments.get('profile').strip()):
 				installation.install_profile(profile)
 
-			if archinstall.storage['_guided']['users']:
-				for user in archinstall.storage['_guided']['users']:
+			if archinstall.arguments.get('users', None):
+				for user in archinstall.arguments.get('users'):
 					password = users[user]
+					installation.user_create(user, password, sudo=False)
+			if archinstall.arguments.get('superusers', None):
+				for user in archinstall.arguments.get('users'):
+					password = users[user]
+					installation.user_create(user, password, sudo=Tru)
 
-					sudo = False
-					if 'root_pw' not in archinstall.storage['_guided_hidden'] or len(archinstall.storage['_guided_hidden']['root_pw'].strip()) == 0:
-						sudo = True
-
-					installation.user_create(user, password, sudo=sudo)
-
-			if 'root_pw' in archinstall.storage['_guided_hidden'] and archinstall.storage['_guided_hidden']['root_pw']:
-				installation.user_set_pw('root', archinstall.storage['_guided_hidden']['root_pw'])
-
-# Unmount and close previous runs (in case the installer is restarted)
-archinstall.sys_command(f'umount -R /mnt', suppress_errors=True)
-archinstall.sys_command(f'cryptsetup close /dev/mapper/luksloop', suppress_errors=True)
-
-
-"""
-  First, we'll ask the user for a bunch of user input.
-  Not until we're satisfied with what we want to install
-  will we continue with the actual installation steps.
-"""
-
-if len(keyboard_language := archinstall.select_language(archinstall.list_keyboard_languages()).strip()):
-	archinstall.set_keyboard_language(keyboard_language)
-	archinstall.storage['_guided']['keyboard_layout'] = keyboard_language
-
-# Set which region to download packages from during the installation
-mirror_regions = archinstall.select_mirror_regions(archinstall.list_mirrors())
-archinstall.storage['_guided']['mirrors'] = mirror_regions
-
-# Ask which harddrive/block-device we will install to
-harddrive = archinstall.select_disk(archinstall.all_disks())
-while (disk_password := getpass.getpass(prompt='Enter disk encryption password (leave blank for no encryption): ')):
-	disk_password_verification = getpass.getpass(prompt='And one more time for verification: ')
-	if disk_password != disk_password_verification:
-		archinstall.log(' * Passwords did not match * ', bg='black', fg='red')
-		continue
-	archinstall.storage['_guided']['disk_encryption'] = True
-	break
-archinstall.storage['_guided']['harddrive'] = harddrive
-
-# Ask for a hostname
-hostname = input('Desired hostname for the installation: ')
-if len(hostname) == 0:
-	hostname = 'ArchInstall'
-archinstall.storage['_guided']['hostname'] = hostname
-
-# Ask for a root password (optional, but triggers requirement for super-user if skipped)
-while (root_pw := getpass.getpass(prompt='Enter root password (leave blank to leave root disabled): ')):
-	root_pw_verification = getpass.getpass(prompt='And one more time for verification: ')
-	if root_pw != root_pw_verification:
-		archinstall.log(' * Passwords did not match * ', bg='black', fg='red')
-		continue
-
-	# Storing things in _guided_hidden helps us avoid printing it
-	# when echoing user configuration: archinstall.storage['_guided']
-	archinstall.storage['_guided_hidden']['root_pw'] = root_pw
-	archinstall.storage['_guided']['root_unlocked'] = True
-	break
-
-# Ask for additional users (super-user if root pw was not set)
-users = {}
-new_user_text = 'Any additional users to install (leave blank for no users): '
-if len(root_pw.strip()) == 0:
-	new_user_text = 'Create a super-user with sudo privileges: '
-
-archinstall.storage['_guided']['users'] = None
-while 1:
-	new_user = input(new_user_text)
-	if len(new_user.strip()) == 0:
-		if len(root_pw.strip()) == 0:
-			archinstall.log(' * Since root is disabled, you need to create a least one (super) user!', bg='black', fg='red')
-			continue
-		break
-
-	if not archinstall.storage['_guided']['users']:
-		archinstall.storage['_guided']['users'] = []
-	archinstall.storage['_guided']['users'].append(new_user)
-
-	new_user_passwd = getpass.getpass(prompt=f'Password for user {new_user}: ')
-	new_user_passwd_verify = getpass.getpass(prompt=f'Enter password again for verification: ')
-	if new_user_passwd != new_user_passwd_verify:
-		archinstall.log(' * Passwords did not match * ', bg='black', fg='red')
-		continue
-
-	users[new_user] = new_user_passwd
-	break
-
-# Ask for archinstall-specific profiles (such as desktop environments etc)
-while 1:
-	profile = archinstall.select_profile(archinstall.list_profiles())
-	if profile:
-		archinstall.storage['_guided']['profile'] = profile
-
-		if type(profile) != str:  # Got a imported profile
-			archinstall.storage['_guided']['profile'] = profile[0]  # The second return is a module, and not a handle/object.
-			if not profile[1]._prep_function():
-				# TODO: See how we can incorporate this into
-				#       the general log flow. As this is pre-installation
-				#       session setup. Which creates the installation.log file.
-				archinstall.log(
-					' * Profile\'s preparation requirements was not fulfilled.',
-					bg='black',
-					fg='red'
-				)
-				continue
-			break
-	else:
-		break
-
-# Additional packages (with some light weight error handling for invalid package names)
-archinstall.storage['_guided']['packages'] = None
-while 1:
-	packages = [package for package in input('Additional packages aside from base (space separated): ').split(' ') if len(package)]
-
-	if not packages:
-		break
-
-	try:
-		if archinstall.validate_package_list(packages):
-			archinstall.storage['_guided']['packages'] = packages
-			break
-	except archinstall.RequirementError as e:
-		print(e)
-
-# Optionally configure one network interface.
-#while 1:
-# {MAC: Ifname}
-interfaces = {'ISO-CONFIG' : 'Copy ISO network configuration to installation', **archinstall.list_interfaces()}
-archinstall.storage['_guided']['network'] = None
-
-nic = archinstall.generic_select(interfaces.values(), "Select one network interface to configure (leave blank to skip): ")
-if nic and nic != 'Copy ISO network configuration to installation':
-	mode = archinstall.generic_select(['DHCP (auto detect)', 'IP (static)'], f"Select which mode to configure for {nic}: ")
-	if mode == 'IP (static)':
-		while 1:
-			ip = input(f"Enter the IP and subnet for {nic} (example: 192.168.0.5/24): ").strip()
-			if ip:
-				break
-			else:
-				ArchInstall.log(
-					"You need to enter a valid IP in IP-config mode.",
-					level=archinstall.LOG_LEVELS.Warning,
-					bg='black',
-					fg='red'
-				)
-
-		if not len(gateway := input('Enter your gateway (router) IP address or leave blank for none: ').strip()):
-			gateway = None
-
-		dns = None
-		if len(dns_input := input('Enter your DNS servers (space separated, blank for none): ').strip()):
-			dns = dns_input.split(' ')
-
-		archinstall.storage['_guided']['network'] = {'nic': nic, 'dhcp': False, 'ip': ip, 'gateway' : gateway, 'dns' : dns}
-	else:
-		archinstall.storage['_guided']['network'] = {'nic': nic}
-elif nic:
-	archinstall.storage['_guided']['network'] = nic
-
-print()
-print('This is your chosen configuration:')
-archinstall.log("-- Guided template chosen (with below config) --", level=archinstall.LOG_LEVELS.Debug)
-archinstall.log(json.dumps(archinstall.storage['_guided'], indent=4, sort_keys=True, cls=archinstall.JSON), level=archinstall.LOG_LEVELS.Info)
-print()
-
-input('Press Enter to continue.')
-
-"""
-	Issue a final warning before we continue with something un-revertable.
-	We mention the drive one last time, and count from 5 to 0.
-"""
-
-print(f' ! Formatting {harddrive} in ', end='')
-
-for i in range(5, 0, -1):
-	print(f"{i}", end='')
-
-	for x in range(4):
-		sys.stdout.flush()
-		time.sleep(0.25)
-		print(".", end='')
-
-	if SIG_TRIGGER:
-		abort = input('\nDo you really want to abort (y/n)? ')
-		if abort.strip() != 'n':
-			exit(0)
-
-		if SIG_TRIGGER is False:
-			sys.stdin.read()
-		SIG_TRIGGER = False
-		signal.signal(signal.SIGINT, sig_handler)
-print()
-signal.signal(signal.SIGINT, original_sigint_handler)
-
-"""
-	Setup the blockdevice, filesystem (and optionally encryption).
-	Once that's done, we'll hand over to perform_installation()
-"""
-with archinstall.Filesystem(harddrive, archinstall.GPT) as fs:
-	# Use partitioning helper to set up the disk partitions.
-	if disk_password:
-		fs.use_entire_disk('luks2')
-	else:
-		fs.use_entire_disk('ext4')
 
-	if harddrive.partition[1].size == '512M':
-		raise OSError('Trying to encrypt the boot partition for petes sake..')
-	harddrive.partition[0].format('fat32')
+			if (root_pw := archinstall.arguments.get('!root-password', None)) and len(root_pw):
+				installation.user_set_pw('root', root_pw)
 
-	if disk_password:
-		# First encrypt and unlock, then format the desired partition inside the encrypted part.
-		# archinstall.luks2() encrypts the partition when entering the with context manager, and
-		# unlocks the drive so that it can be used as a normal block-device within archinstall.
-		with archinstall.luks2(harddrive.partition[1], 'luksloop', disk_password) as unlocked_device:
-			unlocked_device.format('btrfs')
 
-			perform_installation(unlocked_device, harddrive.partition[0], keyboard_language, mirror_regions)
-	else:
-		harddrive.partition[1].format('ext4')
-		perform_installation(harddrive.partition[1], harddrive.partition[0], keyboard_language, mirror_regions)
\ No newline at end of file
+ask_user_questions()
+perform_installation_steps()
\ No newline at end of file