Move locales and cleanup menu (#1814)

* Cleanup imports and unused code

* Cleanup imports and unused code

* Update build check

* Keep deprecation exception

* Simplify logging

* Move locale into new sub-menu

---------

Co-authored-by: Daniel Girtler <girtler.daniel@gmail.com>

3 files changed, 229 insertions, 0 deletions

diff --git a/archinstall/lib/locale/__init__.py b/archinstall/lib/locale/__init__.py
new file mode 100644
index 00000000..6c32d6f3
--- /dev/null
+++ b/archinstall/lib/locale/__init__.py
@@ -0,0 +1,6 @@
+from .locale_menu import LocaleConfiguration
+from .locale import (
+    list_keyboard_languages, list_locales, list_x11_keyboard_languages,
+    verify_keyboard_layout, verify_x11_keyboard_layout, set_kb_layout,
+    list_timezones
+)
diff --git a/archinstall/lib/locale/locale.py b/archinstall/lib/locale/locale.py
new file mode 100644
index 00000000..c3294e83
--- /dev/null
+++ b/archinstall/lib/locale/locale.py
@@ -0,0 +1,68 @@
+from typing import Iterator, List
+
+from ..exceptions import ServiceException, SysCallError
+from ..general import SysCommand
+from ..output import error
+
+
+def list_keyboard_languages() -> Iterator[str]:
+	for line in SysCommand("localectl --no-pager list-keymaps", environment_vars={'SYSTEMD_COLORS': '0'}):
+		yield line.decode('UTF-8').strip()
+
+
+def list_locales() -> List[str]:
+	with open('/etc/locale.gen', 'r') as fp:
+		locales = []
+		# before the list of locales begins there's an empty line with a '#' in front
+		# so we'll collect the localels from bottom up and halt when we're donw
+		entries = fp.readlines()
+		entries.reverse()
+
+		for entry in entries:
+			text = entry.replace('#', '').strip()
+			if text == '':
+				break
+			locales.append(text)
+
+		locales.reverse()
+		return locales
+
+
+def list_x11_keyboard_languages() -> Iterator[str]:
+	for line in SysCommand("localectl --no-pager list-x11-keymap-layouts", environment_vars={'SYSTEMD_COLORS': '0'}):
+		yield line.decode('UTF-8').strip()
+
+
+def verify_keyboard_layout(layout :str) -> bool:
+	for language in list_keyboard_languages():
+		if layout.lower() == language.lower():
+			return True
+	return False
+
+
+def verify_x11_keyboard_layout(layout :str) -> bool:
+	for language in list_x11_keyboard_languages():
+		if layout.lower() == language.lower():
+			return True
+	return False
+
+
+def set_kb_layout(locale :str) -> bool:
+	if len(locale.strip()):
+		if not verify_keyboard_layout(locale):
+			error(f"Invalid keyboard locale specified: {locale}")
+			return False
+
+		try:
+			SysCommand(f'localectl set-keymap {locale}')
+		except SysCallError as err:
+			raise ServiceException(f"Unable to set locale '{locale}' for console: {err}")
+
+		return True
+
+	return False
+
+
+def list_timezones() -> Iterator[str]:
+	for line in SysCommand("timedatectl --no-pager list-timezones", environment_vars={'SYSTEMD_COLORS': '0'}):
+		yield line.decode('UTF-8').strip()
diff --git a/archinstall/lib/locale/locale_menu.py b/archinstall/lib/locale/locale_menu.py
new file mode 100644
index 00000000..29dd775d
--- /dev/null
+++ b/archinstall/lib/locale/locale_menu.py
@@ -0,0 +1,155 @@
+from dataclasses import dataclass
+from typing import Dict, Any, TYPE_CHECKING, Optional
+
+from .locale import set_kb_layout, list_keyboard_languages, list_locales
+from ..menu import Selector, AbstractSubMenu, MenuSelectionType, Menu
+
+if TYPE_CHECKING:
+	_: Any
+
+
+@dataclass
+class LocaleConfiguration:
+	kb_layout: str
+	sys_lang: str
+	sys_enc: str
+
+	@staticmethod
+	def default() -> 'LocaleConfiguration':
+		return LocaleConfiguration('us', 'en_US', 'UTF-8')
+
+	def json(self) -> Dict[str, str]:
+		return {
+			'kb_layout': self.kb_layout,
+			'sys_lang': self.sys_lang,
+			'sys_enc': self.sys_enc
+		}
+
+	@classmethod
+	def _load_config(cls, config: 'LocaleConfiguration', args: Dict[str, Any]) -> 'LocaleConfiguration':
+		if 'sys_lang' in args:
+			config.sys_lang = args['sys_lang']
+		if 'sys_enc' in args:
+			config.sys_enc = args['sys_enc']
+		if 'kb_layout' in args:
+			config.kb_layout = args['kb_layout']
+
+		return config
+
+	@classmethod
+	def parse_arg(cls, args: Dict[str, Any]) -> 'LocaleConfiguration':
+		default = cls.default()
+
+		if 'locale_config' in args:
+			default = cls._load_config(default, args['locale_config'])
+		else:
+			default = cls._load_config(default, args)
+
+		return default
+
+
+class LocaleMenu(AbstractSubMenu):
+	def __init__(
+		self,
+		data_store: Dict[str, Any],
+		locele_conf: LocaleConfiguration
+	):
+		self._preset = locele_conf
+		super().__init__(data_store=data_store)
+
+	def setup_selection_menu_options(self):
+		self._menu_options['keyboard-layout'] = \
+			Selector(
+				_('Keyboard layout'),
+				lambda preset: self._select_kb_layout(preset),
+				default='us',
+				enabled=True)
+		self._menu_options['sys-language'] = \
+			Selector(
+				_('Locale language'),
+				lambda preset: select_locale_lang(preset),
+				default='en_US',
+				enabled=True)
+		self._menu_options['sys-encoding'] = \
+			Selector(
+				_('Locale encoding'),
+				lambda preset: select_locale_enc(preset),
+				default='UTF-8',
+				enabled=True)
+
+	def run(self, allow_reset: bool = True) -> LocaleConfiguration:
+		super().run(allow_reset=allow_reset)
+
+		return LocaleConfiguration(
+			self._data_store['keyboard-layout'],
+			self._data_store['sys-language'],
+			self._data_store['sys-encoding']
+		)
+
+	def _select_kb_layout(self, preset: Optional[str]) -> Optional[str]:
+		kb_lang = select_kb_layout(preset)
+		if kb_lang:
+			set_kb_layout(kb_lang)
+		return kb_lang
+
+
+def select_locale_lang(preset: Optional[str] = None) -> Optional[str]:
+	locales = list_locales()
+	locale_lang = set([locale.split()[0] for locale in locales])
+
+	choice = Menu(
+		_('Choose which locale language to use'),
+		list(locale_lang),
+		sort=True,
+		preset_values=preset
+	).run()
+
+	match choice.type_:
+		case MenuSelectionType.Selection: return choice.single_value
+		case MenuSelectionType.Skip: return preset
+
+	return None
+
+
+def select_locale_enc(preset: Optional[str] = None) -> Optional[str]:
+	locales = list_locales()
+	locale_enc = set([locale.split()[1] for locale in locales])
+
+	choice = Menu(
+		_('Choose which locale encoding to use'),
+		list(locale_enc),
+		sort=True,
+		preset_values=preset
+	).run()
+
+	match choice.type_:
+		case MenuSelectionType.Selection: return choice.single_value
+		case MenuSelectionType.Skip: return preset
+
+	return None
+
+
+def select_kb_layout(preset: Optional[str] = None) -> Optional[str]:
+	"""
+	Asks the user to select a language
+	Usually this is combined with :ref:`archinstall.list_keyboard_languages`.
+
+	:return: The language/dictionary key of the selected language
+	:rtype: str
+	"""
+	kb_lang = list_keyboard_languages()
+	# sort alphabetically and then by length
+	sorted_kb_lang = sorted(sorted(list(kb_lang)), key=len)
+
+	choice = Menu(
+		_('Select keyboard layout'),
+		sorted_kb_lang,
+		preset_values=preset,
+		sort=False
+	).run()
+
+	match choice.type_:
+		case MenuSelectionType.Skip: return preset
+		case MenuSelectionType.Selection: return choice.single_value
+
+	return None