Files
omarchycn/install/provisioning/setup-form.sh
T

227 lines
9.0 KiB
Bash

# The setup form: every question Omarchy asks a human to describe their machine
# — keyboard, account, hostname, timezone — plus the rules those answers are
# checked against. Shared by the two places that ask them: the ISO
# configurator's user step and this package's first-boot owner setup
# (omarchy-provision-owner). Sourced by both, so the copies cannot drift the way
# the keyboard list already did.
#
# Every prompt reports one of three statuses, and both callers read them the
# same way:
#
# 0 field is set, move on
# 1 Esc — unwind to the start of the form
# 130 Ctrl+C — a per-caller side channel (the installer arms deferred
# provisioning or toggles encryption; first-boot setup offers a reboot)
#
# gum is the reason those two are the whole vocabulary: Esc and Ctrl+C are the
# only keys any gum widget exits on, and Ctrl+C arrives as a byte in raw mode,
# so it never reaches the shell as SIGINT. Act on the status, never on a trap.
#
# Callers supply `notice <message> <seconds>` for validation feedback, and set
# the variables these prompts write: keyboard, keyboard_label, username,
# password, password_confirmation, full_name, email_address, hostname, timezone.
OMARCHY_FORM_BACK=1
OMARCHY_FORM_SIGNAL=130
# Prompt strings; the ISO's graphical console exports OMARCHY_INSTALL_LANG=zh
if [[ ${OMARCHY_INSTALL_LANG:-} == zh ]]; then
OMARCHY_L_KEYBOARD_HEADER="选择键盘布局"
OMARCHY_L_USERNAME_PROMPT="用户名> "
OMARCHY_L_USERNAME_HINT="仅限字母数字、不含空格(如 dhh)"
OMARCHY_L_USERNAME_RESERVED="该用户名已被系统保留"
OMARCHY_L_USERNAME_TAKEN="该用户名在本机已存在"
OMARCHY_L_USERNAME_INVALID="用户名必须为字母数字且不含空格"
OMARCHY_L_PASSWORD_PROMPT="密码> "
OMARCHY_L_PASSWORD_HINT="用于用户与 root,启用加密时也用于磁盘解锁"
OMARCHY_L_CONFIRM_PROMPT="确认密码> "
OMARCHY_L_CONFIRM_HINT="需与刚输入的密码一致"
OMARCHY_L_PASSWORD_BLANK="密码不能为空!"
OMARCHY_L_PASSWORD_MISMATCH="两次输入的密码不一致!"
OMARCHY_L_FULLNAME_PROMPT="姓名> "
OMARCHY_L_IDENTITY_HINT="用于 git 身份(回车跳过)"
OMARCHY_L_EMAIL_PROMPT="邮箱> "
OMARCHY_L_HOSTNAME_PROMPT="主机名> "
OMARCHY_L_HOSTNAME_HINT="字母、数字与连字符(回车默认 omarchy)"
OMARCHY_L_HOSTNAME_INVALID="主机名须为 1-63 位字母/数字/连字符,且不能以连字符开头或结尾"
OMARCHY_L_TIMEZONE_HEADER="时区"
else
OMARCHY_L_KEYBOARD_HEADER="Select keyboard layout"
OMARCHY_L_USERNAME_PROMPT="Username> "
OMARCHY_L_USERNAME_HINT="Alphanumeric without spaces (like dhh)"
OMARCHY_L_USERNAME_RESERVED="Username is reserved for system"
OMARCHY_L_USERNAME_TAKEN="That username already exists on this machine"
OMARCHY_L_USERNAME_INVALID="Username must be alphanumeric with no spaces"
OMARCHY_L_PASSWORD_PROMPT="Password> "
OMARCHY_L_PASSWORD_HINT="Used for user + root, and disk encryption when enabled"
OMARCHY_L_CONFIRM_PROMPT="Confirm> "
OMARCHY_L_CONFIRM_HINT="Must match the password you just typed"
OMARCHY_L_PASSWORD_BLANK="Your password can'"'"'t be blank!"
OMARCHY_L_PASSWORD_MISMATCH="Passwords didn'"'"'t match!"
OMARCHY_L_FULLNAME_PROMPT="Full name> "
OMARCHY_L_IDENTITY_HINT="Used for git authentication (hit return to skip)"
OMARCHY_L_EMAIL_PROMPT="Email address> "
OMARCHY_L_HOSTNAME_PROMPT="Hostname> "
OMARCHY_L_HOSTNAME_HINT="Letters, digits, and dashes (or return for '"'"'omarchy'"'"')"
OMARCHY_L_HOSTNAME_INVALID="Hostname must be 1-63 letters, digits, or dashes, and cannot start or end with a dash"
OMARCHY_L_TIMEZONE_HEADER="Timezone"
fi
# The English layouts lead, then everything else alphabetically. gum choose
# paginates in --height-sized pages and jumps to the page holding --selected,
# so an alphabetical English (US) landed deep enough to sit alone at the edge
# of a page of layouts nobody scanning for it reads. Up here the default and
# its variants are the first thing on screen no matter how the list grows.
OMARCHY_KEYBOARD_LAYOUTS=$'English (US)|us
English (UK)|uk
English (US, Dvorak)|dvorak
English (US, Colemak)|colemak
Azerbaijani|azerty
Belarusian|by
Belgian|be-latin1
Bulgarian|bg-cp1251
Croatian|croat
Czech|cz
Danish|dk-latin1
Dutch|nl
Estonian|et
Finnish|fi
French|fr
French (Canada)|cf
French (Switzerland)|fr_CH
Georgian|ge
German|de
German (Switzerland)|de_CH-latin1
Greek|gr
Hebrew|il
Hungarian|hu
Icelandic|is-latin1
Irish|ie
Italian|it
Japanese|jp106
Kazakh|kazakh
Kyrgyz|kyrgyz
Lao|la-latin1
Latvian|lv
Lithuanian|lt
Macedonian|mk-utf
Norwegian|no-latin1
Polish|pl
Portuguese|pt-latin1
Portuguese (Brazil)|br-abnt2
Romanian|ro
Russian|ru
Serbian|sr-latin
Slovak|sk-qwertz
Slovenian|slovene
Spanish|es
Spanish (Latin American)|la-latin1
Swedish|sv-latin1
Tajik|tj_alt-UTF8
Turkish|trq
Ukrainian|ua'
OMARCHY_USERNAME_PATTERN='^[a-z_][a-z0-9_-]*[$]?$'
OMARCHY_RESERVED_USERNAMES='^(root|bin|daemon|mail|ftp|http|nobody|dbus|systemd-coredump|systemd-network|systemd-oom|systemd-journal-remote|systemd-resolve|systemd-timesync|tss|uuidd|alpm|git|avahi|cups|lp|_talkd|polkitd|rtkit|qemu|brltty|gluster|rpc|libvirt-qemu|pcscd|nvidia-persistenced|sddm)$'
OMARCHY_HOSTNAME_PATTERN='^[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?$'
OMARCHY_HOSTNAME_DEFAULT='omarchy'
# Installer targets are empty, so any account is fair game; first-boot setup
# overrides this because its machine already has users.
omarchy_username_taken() { return 1; }
# `x=$(gum ...) && status=0 || status=$?` rather than a bare assignment followed
# by `status=$?`: one caller runs under `set -e`, where a cancelled prompt is a
# failing assignment that would kill the script before the status is read.
omarchy_prompt_keyboard() {
local choice status
choice=$(printf '%s\n' "$OMARCHY_KEYBOARD_LAYOUTS" | cut -d'|' -f1 |
gum choose --height 10 --selected "English (US)" --header "$OMARCHY_L_KEYBOARD_HEADER") && status=0 || status=$?
((status == 0)) || return $status
keyboard_label="$choice"
keyboard=$(printf '%s\n' "$OMARCHY_KEYBOARD_LAYOUTS" | awk -F'|' -v c="$choice" '$1==c{print $2; exit}')
}
omarchy_prompt_username() {
local status
while true; do
username=$(gum input --placeholder "$OMARCHY_L_USERNAME_HINT" --prompt.foreground="#845DF9" --prompt "$OMARCHY_L_USERNAME_PROMPT") && status=0 || status=$?
((status == 0)) || return $status
if [[ "$username" =~ $OMARCHY_USERNAME_PATTERN ]]; then
if [[ "$username" =~ $OMARCHY_RESERVED_USERNAMES ]]; then
notice "$OMARCHY_L_USERNAME_RESERVED" 1
elif omarchy_username_taken "$username"; then
notice "$OMARCHY_L_USERNAME_TAKEN" 1
else
return 0
fi
else
notice "$OMARCHY_L_USERNAME_INVALID" 1
fi
done
}
omarchy_prompt_password() {
local status
while true; do
password=$(gum input --placeholder "$OMARCHY_L_PASSWORD_HINT" --prompt.foreground="#845DF9" --password --prompt "$OMARCHY_L_PASSWORD_PROMPT") && status=0 || status=$?
((status == 0)) || return $status
password_confirmation=$(gum input --placeholder "$OMARCHY_L_CONFIRM_HINT" --prompt.foreground="#845DF9" --password --prompt "$OMARCHY_L_CONFIRM_PROMPT") && status=0 || status=$?
((status == 0)) || return $status
if [[ -n "$password" && "$password" == "$password_confirmation" ]]; then
return 0
elif [[ -z "$password" ]]; then
notice "$OMARCHY_L_PASSWORD_BLANK" 1
else
notice "$OMARCHY_L_PASSWORD_MISMATCH" 1
fi
done
}
# Both fields are skippable with Return, so an empty value is a real answer and
# only Esc/Ctrl+C end the prompt early.
omarchy_prompt_identity() {
local status
full_name=$(gum input --placeholder "$OMARCHY_L_IDENTITY_HINT" --prompt.foreground="#845DF9" --prompt "$OMARCHY_L_FULLNAME_PROMPT") && status=0 || status=$?
((status == 0)) || return $status
email_address=$(gum input --placeholder "$OMARCHY_L_IDENTITY_HINT" --prompt.foreground="#845DF9" --prompt "$OMARCHY_L_EMAIL_PROMPT") && status=0 || status=$?
return $status
}
omarchy_prompt_hostname() {
local status
while true; do
hostname=$(gum input --placeholder "$OMARCHY_L_HOSTNAME_HINT" --prompt.foreground="#845DF9" --prompt "$OMARCHY_L_HOSTNAME_PROMPT") && status=0 || status=$?
((status == 0)) || return $status
if [[ -z $hostname ]]; then
hostname="$OMARCHY_HOSTNAME_DEFAULT"
return 0
elif [[ "$hostname" =~ $OMARCHY_HOSTNAME_PATTERN ]]; then
return 0
else
notice "$OMARCHY_L_HOSTNAME_INVALID" 1
fi
done
}
# A fresh machine often hasn't joined a network yet, so the geo guess fails
# often; guard it or a `set -e` caller dies before the filter fallback.
omarchy_prompt_timezone() {
local guess status
guess=$(tzupdate -p 2>/dev/null) || guess=""
if [[ -n $guess ]]; then
timezone=$(timedatectl list-timezones | gum choose --height 10 --selected "$guess" --header "$OMARCHY_L_TIMEZONE_HEADER") && status=0 || status=$?
else
timezone=$(timedatectl list-timezones | gum filter --height 10 --header "$OMARCHY_L_TIMEZONE_HEADER") && status=0 || status=$?
fi
((status == 0)) || return $status
[[ -n $timezone ]] || timezone="UTC"
}