473 lines
16 KiB
Python
473 lines
16 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import Any, List, Optional, Dict, TYPE_CHECKING
|
|
|
|
from . import disk
|
|
from .general import secret
|
|
from .hardware import SysInfo
|
|
from .locale.locale_menu import LocaleConfiguration, LocaleMenu
|
|
from .menu import Selector, AbstractMenu
|
|
from .mirrors import MirrorConfiguration, MirrorMenu
|
|
from .models import NetworkConfiguration, NicType
|
|
from .models.bootloader import Bootloader
|
|
from .models.audio_configuration import Audio, AudioConfiguration
|
|
from .models.users import User
|
|
from .output import FormattedOutput
|
|
from .profile.profile_menu import ProfileConfiguration
|
|
from .configuration import save_config
|
|
from .interactions import add_number_of_parallel_downloads
|
|
from .interactions import ask_additional_packages_to_install
|
|
from .interactions import ask_for_additional_users
|
|
from .interactions import ask_for_audio_selection
|
|
from .interactions import ask_for_bootloader
|
|
from .interactions import ask_for_uki
|
|
from .interactions import ask_for_swap
|
|
from .interactions import ask_hostname
|
|
from .interactions import ask_to_configure_network
|
|
from .interactions import get_password, ask_for_a_timezone
|
|
from .interactions import select_additional_repositories
|
|
from .interactions import select_kernel
|
|
from .utils.util import format_cols
|
|
from .interactions import ask_ntp
|
|
|
|
if TYPE_CHECKING:
|
|
_: Any
|
|
|
|
|
|
class GlobalMenu(AbstractMenu):
|
|
def __init__(self, data_store: Dict[str, Any]):
|
|
super().__init__(data_store=data_store, auto_cursor=True, preview_size=0.3)
|
|
|
|
def setup_selection_menu_options(self) -> None:
|
|
# archinstall.Language will not use preset values
|
|
self._menu_options['archinstall-language'] = \
|
|
Selector(
|
|
_('Archinstall language'),
|
|
lambda x: self._select_archinstall_language(x),
|
|
display_func=lambda x: x.display_name,
|
|
default=self.translation_handler.get_language_by_abbr('en'))
|
|
self._menu_options['locale_config'] = \
|
|
Selector(
|
|
_('Locales'),
|
|
lambda preset: self._locale_selection(preset),
|
|
preview_func=self._prev_locale,
|
|
display_func=lambda x: self.defined_text if x else '')
|
|
self._menu_options['mirror_config'] = \
|
|
Selector(
|
|
_('Mirrors'),
|
|
lambda preset: self._mirror_configuration(preset),
|
|
display_func=lambda x: self.defined_text if x else '',
|
|
preview_func=self._prev_mirror_config
|
|
)
|
|
self._menu_options['disk_config'] = \
|
|
Selector(
|
|
_('Disk configuration'),
|
|
lambda preset: self._select_disk_config(preset),
|
|
preview_func=self._prev_disk_config,
|
|
display_func=lambda x: self.defined_text if x else '',
|
|
)
|
|
self._menu_options['disk_encryption'] = \
|
|
Selector(
|
|
_('Disk encryption'),
|
|
lambda preset: self._disk_encryption(preset),
|
|
preview_func=self._prev_disk_encryption,
|
|
display_func=lambda x: self._display_disk_encryption(x),
|
|
dependencies=['disk_config']
|
|
)
|
|
self._menu_options['swap'] = \
|
|
Selector(
|
|
_('Swap'),
|
|
lambda preset: ask_for_swap(preset),
|
|
default=True)
|
|
self._menu_options['bootloader'] = \
|
|
Selector(
|
|
_('Bootloader'),
|
|
lambda preset: ask_for_bootloader(preset),
|
|
display_func=lambda x: x.value,
|
|
default=Bootloader.get_default())
|
|
self._menu_options['uki'] = \
|
|
Selector(
|
|
_('Unified kernel images'),
|
|
lambda preset: ask_for_uki(preset),
|
|
default=False)
|
|
self._menu_options['hostname'] = \
|
|
Selector(
|
|
_('Hostname'),
|
|
lambda preset: ask_hostname(preset),
|
|
default='archlinux')
|
|
# root password won't have preset value
|
|
self._menu_options['!root-password'] = \
|
|
Selector(
|
|
_('Root password'),
|
|
lambda preset: self._set_root_password(),
|
|
display_func=lambda x: secret(x) if x else '')
|
|
self._menu_options['!users'] = \
|
|
Selector(
|
|
_('User account'),
|
|
lambda x: self._create_user_account(x),
|
|
default=[],
|
|
display_func=lambda x: f'{len(x)} {_("User(s)")}' if len(x) > 0 else '',
|
|
preview_func=self._prev_users)
|
|
self._menu_options['profile_config'] = \
|
|
Selector(
|
|
_('Profile'),
|
|
lambda preset: self._select_profile(preset),
|
|
display_func=lambda x: x.profile.name if x else '',
|
|
preview_func=self._prev_profile
|
|
)
|
|
self._menu_options['audio_config'] = \
|
|
Selector(
|
|
_('Audio'),
|
|
lambda preset: self._select_audio(preset),
|
|
display_func=lambda x: self._display_audio(x)
|
|
)
|
|
self._menu_options['parallel downloads'] = \
|
|
Selector(
|
|
_('Parallel Downloads'),
|
|
lambda preset: add_number_of_parallel_downloads(preset),
|
|
display_func=lambda x: x if x else '0',
|
|
default=0
|
|
)
|
|
self._menu_options['kernels'] = \
|
|
Selector(
|
|
_('Kernels'),
|
|
lambda preset: select_kernel(preset),
|
|
display_func=lambda x: ', '.join(x) if x else None,
|
|
default=['linux'])
|
|
self._menu_options['packages'] = \
|
|
Selector(
|
|
_('Additional packages'),
|
|
lambda preset: ask_additional_packages_to_install(preset),
|
|
display_func=lambda x: self.defined_text if x else '',
|
|
preview_func=self._prev_additional_pkgs,
|
|
default=[])
|
|
self._menu_options['additional-repositories'] = \
|
|
Selector(
|
|
_('Optional repositories'),
|
|
lambda preset: select_additional_repositories(preset),
|
|
display_func=lambda x: ', '.join(x) if x else None,
|
|
default=[])
|
|
self._menu_options['network_config'] = \
|
|
Selector(
|
|
_('Network configuration'),
|
|
lambda preset: ask_to_configure_network(preset),
|
|
display_func=lambda x: self._display_network_conf(x),
|
|
preview_func=self._prev_network_config,
|
|
default={})
|
|
self._menu_options['timezone'] = \
|
|
Selector(
|
|
_('Timezone'),
|
|
lambda preset: ask_for_a_timezone(preset),
|
|
default='UTC')
|
|
self._menu_options['ntp'] = \
|
|
Selector(
|
|
_('Automatic time sync (NTP)'),
|
|
lambda preset: ask_ntp(preset),
|
|
default=True)
|
|
self._menu_options['__separator__'] = \
|
|
Selector('')
|
|
self._menu_options['save_config'] = \
|
|
Selector(
|
|
_('Save configuration'),
|
|
lambda preset: save_config(self._data_store),
|
|
no_store=True)
|
|
self._menu_options['install'] = \
|
|
Selector(
|
|
self._install_text(),
|
|
exec_func=lambda n, v: self._is_config_valid(),
|
|
preview_func=self._prev_install_invalid_config,
|
|
no_store=True)
|
|
|
|
self._menu_options['abort'] = Selector(_('Abort'), exec_func=lambda n, v: exit(1))
|
|
|
|
def _missing_configs(self) -> List[str]:
|
|
def check(s: str) -> bool:
|
|
obj = self._menu_options.get(s)
|
|
if obj and obj.has_selection():
|
|
return True
|
|
return False
|
|
|
|
def has_superuser() -> bool:
|
|
sel = self._menu_options['!users']
|
|
if sel.current_selection:
|
|
return any([u.sudo for u in sel.current_selection])
|
|
return False
|
|
|
|
mandatory_fields = dict(filter(lambda x: x[1].is_mandatory(), self._menu_options.items()))
|
|
missing = set()
|
|
|
|
for key, selector in mandatory_fields.items():
|
|
if key in ['!root-password', '!users']:
|
|
if not check('!root-password') and not has_superuser():
|
|
missing.add(
|
|
str(_('Either root-password or at least 1 user with sudo privileges must be specified'))
|
|
)
|
|
elif key == 'disk_config':
|
|
if not check('disk_config'):
|
|
missing.add(self._menu_options['disk_config'].description)
|
|
|
|
return list(missing)
|
|
|
|
def _is_config_valid(self) -> bool:
|
|
"""
|
|
Checks the validity of the current configuration.
|
|
"""
|
|
if len(self._missing_configs()) != 0:
|
|
return False
|
|
return self._validate_bootloader() is None
|
|
|
|
def _update_uki_display(self, name: Optional[str] = None) -> None:
|
|
if bootloader := self._menu_options['bootloader'].current_selection:
|
|
if not SysInfo.has_uefi() or not bootloader.has_uki_support():
|
|
self._menu_options['uki'].set_current_selection(False)
|
|
self._menu_options['uki'].set_enabled(False)
|
|
elif name and name == 'bootloader':
|
|
self._menu_options['uki'].set_enabled(True)
|
|
|
|
def _update_install_text(self, name: Optional[str] = None, value: Any = None) -> None:
|
|
text = self._install_text()
|
|
self._menu_options['install'].update_description(text)
|
|
|
|
def post_callback(self, name: Optional[str] = None, value: Any = None) -> None:
|
|
self._update_uki_display(name)
|
|
self._update_install_text(name, value)
|
|
|
|
def _install_text(self) -> str:
|
|
missing = len(self._missing_configs())
|
|
if missing > 0:
|
|
return _('Install ({} config(s) missing)').format(missing)
|
|
return _('Install')
|
|
|
|
def _display_network_conf(self, config: Optional[NetworkConfiguration]) -> str:
|
|
if not config:
|
|
return str(_('Not configured, unavailable unless setup manually'))
|
|
|
|
return config.type.display_msg()
|
|
|
|
def _disk_encryption(self, preset: Optional[disk.DiskEncryption]) -> Optional[disk.DiskEncryption]:
|
|
disk_config: Optional[disk.DiskLayoutConfiguration] = self._menu_options['disk_config'].current_selection
|
|
|
|
if not disk_config:
|
|
# this should not happen as the encryption menu has the disk_config as dependency
|
|
raise ValueError('No disk layout specified')
|
|
|
|
if not disk.DiskEncryption.validate_enc(disk_config):
|
|
return None
|
|
|
|
data_store: Dict[str, Any] = {}
|
|
disk_encryption = disk.DiskEncryptionMenu(disk_config, data_store, preset=preset).run()
|
|
return disk_encryption
|
|
|
|
def _locale_selection(self, preset: LocaleConfiguration) -> LocaleConfiguration:
|
|
data_store: Dict[str, Any] = {}
|
|
locale_config = LocaleMenu(data_store, preset).run()
|
|
return locale_config
|
|
|
|
def _prev_locale(self) -> Optional[str]:
|
|
selector = self._menu_options['locale_config']
|
|
if selector.has_selection():
|
|
config: LocaleConfiguration = selector.current_selection # type: ignore
|
|
output = '{}: {}\n'.format(str(_('Keyboard layout')), config.kb_layout)
|
|
output += '{}: {}\n'.format(str(_('Locale language')), config.sys_lang)
|
|
output += '{}: {}'.format(str(_('Locale encoding')), config.sys_enc)
|
|
return output
|
|
return None
|
|
|
|
def _prev_network_config(self) -> Optional[str]:
|
|
selector: Optional[NetworkConfiguration] = self._menu_options['network_config'].current_selection
|
|
if selector:
|
|
if selector.type == NicType.MANUAL:
|
|
output = FormattedOutput.as_table(selector.nics)
|
|
return output
|
|
return None
|
|
|
|
def _prev_additional_pkgs(self) -> Optional[str]:
|
|
selector = self._menu_options['packages']
|
|
if selector.current_selection:
|
|
packages: List[str] = selector.current_selection
|
|
return format_cols(packages, None)
|
|
return None
|
|
|
|
def _prev_disk_config(self) -> Optional[str]:
|
|
selector = self._menu_options['disk_config']
|
|
disk_layout_conf: Optional[disk.DiskLayoutConfiguration] = selector.current_selection
|
|
|
|
output = ''
|
|
if disk_layout_conf:
|
|
output += str(_('Configuration type: {}')).format(disk_layout_conf.config_type.display_msg())
|
|
|
|
if disk_layout_conf.lvm_config:
|
|
output += '\n{}: {}'.format(str(_('LVM configuration type')), disk_layout_conf.lvm_config.config_type.display_msg())
|
|
|
|
if output:
|
|
return output
|
|
|
|
return None
|
|
|
|
def _display_disk_config(self, current_value: Optional[disk.DiskLayoutConfiguration] = None) -> str:
|
|
if current_value:
|
|
return current_value.config_type.display_msg()
|
|
return ''
|
|
|
|
def _prev_disk_encryption(self) -> Optional[str]:
|
|
disk_config: Optional[disk.DiskLayoutConfiguration] = self._menu_options['disk_config'].current_selection
|
|
|
|
if disk_config and not disk.DiskEncryption.validate_enc(disk_config):
|
|
return str(_('LVM disk encryption with more than 2 partitions is currently not supported'))
|
|
|
|
encryption: Optional[disk.DiskEncryption] = self._menu_options['disk_encryption'].current_selection
|
|
|
|
if encryption:
|
|
enc_type = disk.EncryptionType.type_to_text(encryption.encryption_type)
|
|
output = str(_('Encryption type')) + f': {enc_type}\n'
|
|
output += str(_('Password')) + f': {secret(encryption.encryption_password)}\n'
|
|
|
|
if encryption.partitions:
|
|
output += 'Partitions: {} selected'.format(len(encryption.partitions)) + '\n'
|
|
elif encryption.lvm_volumes:
|
|
output += 'LVM volumes: {} selected'.format(len(encryption.lvm_volumes)) + '\n'
|
|
|
|
if encryption.hsm_device:
|
|
output += f'HSM: {encryption.hsm_device.manufacturer}'
|
|
|
|
return output
|
|
|
|
return None
|
|
|
|
def _display_disk_encryption(self, current_value: Optional[disk.DiskEncryption]) -> str:
|
|
if current_value:
|
|
return disk.EncryptionType.type_to_text(current_value.encryption_type)
|
|
return ''
|
|
|
|
def _validate_bootloader(self) -> Optional[str]:
|
|
"""
|
|
Checks the selected bootloader is valid for the selected filesystem
|
|
type of the boot partition.
|
|
|
|
Returns [`None`] if the bootloader is valid, otherwise returns a
|
|
string with the error message.
|
|
|
|
XXX: The caller is responsible for wrapping the string with the translation
|
|
shim if necessary.
|
|
"""
|
|
bootloader = self._menu_options['bootloader'].current_selection
|
|
boot_partition: Optional[disk.PartitionModification] = None
|
|
|
|
if disk_config := self._menu_options['disk_config'].current_selection:
|
|
for layout in disk_config.device_modifications:
|
|
if boot_partition := layout.get_boot_partition():
|
|
break
|
|
else:
|
|
return "No disk layout selected"
|
|
|
|
if boot_partition is None:
|
|
return "Boot partition not found"
|
|
|
|
if bootloader == Bootloader.Limine:
|
|
if boot_partition.fs_type != disk.FilesystemType.Fat32:
|
|
return "Limine does not support booting from filesystems other than FAT32"
|
|
|
|
return None
|
|
|
|
def _prev_install_invalid_config(self) -> Optional[str]:
|
|
if missing := self._missing_configs():
|
|
text = str(_('Missing configurations:\n'))
|
|
for m in missing:
|
|
text += f'- {m}\n'
|
|
return text[:-1] # remove last new line
|
|
|
|
if error := self._validate_bootloader():
|
|
return str(_(f"Invalid configuration: {error}"))
|
|
|
|
return None
|
|
|
|
def _prev_users(self) -> Optional[str]:
|
|
selector = self._menu_options['!users']
|
|
users: Optional[List[User]] = selector.current_selection
|
|
|
|
if users:
|
|
return FormattedOutput.as_table(users)
|
|
return None
|
|
|
|
def _prev_profile(self) -> Optional[str]:
|
|
selector = self._menu_options['profile_config']
|
|
profile_config: Optional[ProfileConfiguration] = selector.current_selection
|
|
|
|
if profile_config and profile_config.profile:
|
|
output = str(_('Profiles')) + ': '
|
|
if profile_names := profile_config.profile.current_selection_names():
|
|
output += ', '.join(profile_names) + '\n'
|
|
else:
|
|
output += profile_config.profile.name + '\n'
|
|
|
|
if profile_config.gfx_driver:
|
|
output += str(_('Graphics driver')) + ': ' + profile_config.gfx_driver.value + '\n'
|
|
|
|
if profile_config.greeter:
|
|
output += str(_('Greeter')) + ': ' + profile_config.greeter.value + '\n'
|
|
|
|
return output
|
|
|
|
return None
|
|
|
|
def _set_root_password(self) -> Optional[str]:
|
|
prompt = str(_('Enter root password (leave blank to disable root): '))
|
|
password = get_password(prompt=prompt)
|
|
return password
|
|
|
|
def _select_disk_config(
|
|
self,
|
|
preset: Optional[disk.DiskLayoutConfiguration] = None
|
|
) -> Optional[disk.DiskLayoutConfiguration]:
|
|
data_store: Dict[str, Any] = {}
|
|
disk_config = disk.DiskLayoutConfigurationMenu(preset, data_store).run()
|
|
|
|
if disk_config != preset:
|
|
self._menu_options['disk_encryption'].set_current_selection(None)
|
|
|
|
return disk_config
|
|
|
|
def _select_profile(self, current_profile: Optional[ProfileConfiguration]):
|
|
from .profile.profile_menu import ProfileMenu
|
|
store: Dict[str, Any] = {}
|
|
profile_config = ProfileMenu(store, preset=current_profile).run()
|
|
return profile_config
|
|
|
|
def _select_audio(
|
|
self,
|
|
current: Optional[AudioConfiguration] = None
|
|
) -> Optional[AudioConfiguration]:
|
|
selection = ask_for_audio_selection(current)
|
|
return selection
|
|
|
|
def _display_audio(self, current: Optional[AudioConfiguration]) -> str:
|
|
if not current:
|
|
return Audio.no_audio_text()
|
|
else:
|
|
return current.audio.name
|
|
|
|
def _create_user_account(self, defined_users: List[User]) -> List[User]:
|
|
users = ask_for_additional_users(defined_users=defined_users)
|
|
return users
|
|
|
|
def _mirror_configuration(self, preset: Optional[MirrorConfiguration] = None) -> Optional[MirrorConfiguration]:
|
|
data_store: Dict[str, Any] = {}
|
|
mirror_configuration = MirrorMenu(data_store, preset=preset).run()
|
|
return mirror_configuration
|
|
|
|
def _prev_mirror_config(self) -> Optional[str]:
|
|
selector = self._menu_options['mirror_config']
|
|
|
|
if selector.has_selection():
|
|
mirror_config: MirrorConfiguration = selector.current_selection # type: ignore
|
|
output = ''
|
|
if mirror_config.regions:
|
|
output += '{}: {}\n\n'.format(str(_('Mirror regions')), mirror_config.regions)
|
|
if mirror_config.custom_mirrors:
|
|
table = FormattedOutput.as_table(mirror_config.custom_mirrors)
|
|
output += '{}\n{}'.format(str(_('Custom mirrors')), table)
|
|
|
|
return output.strip()
|
|
|
|
return None
|