vbox.bash

#!/usr/bin/bash
# SPDX-FileCopyrightText: Steven Ward
# SPDX-License-Identifier: OSL-3.0

# Script to install Arch Linux in a VirtualBox guest VM

# shellcheck disable=SC1091

declare -a ARGS=("$@")

# set -e is unreliable and convoluted
# https://mywiki.wooledge.org/BashFAQ/105
set -e

THIS_SCRIPT="$(realpath -- "${BASH_SOURCE[0]}")"

export LC_ALL=C

# Do not save history
unset HISTFILE

function setup_grub {
    cp --backup=numbered /etc/default/grub /etc/default/grub.bak

    # https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html
    cat <<EOT >> /etc/default/grub

# Added by $THIS_SCRIPT
GRUB_TIMEOUT=2
GRUB_CMDLINE_LINUX_DEFAULT="loglevel=3"
GRUB_CMDLINE_LINUX_DEFAULT+=" mitigations=off random.trust_cpu=on vconsole.font=Lat2-Terminus16"
GRUB_GFXMODE=1280x1024x32,auto
EOT

    if $ENCRYPT_ROOT_PARTITION
    then
        echo 'GRUB_CMDLINE_LINUX+=" cryptdevice=/dev/sda2:cryptroot"' >> /etc/default/grub
    fi
    grub-install /dev/sda
    grub-mkconfig -o /boot/grub/grub.cfg
}

function setup_hostname_hosts {

    source /usr/lib/os-release

    HOSTNAME="$ID"-vm
    # https://wiki.archlinux.org/title/Network_configuration#Set_the_hostname
    printf '%s\n' "$HOSTNAME" > /etc/hostname

    # https://wiki.archlinux.org/title/Chroot#Usage
    # Cannot be used inside a chroot
    #hostnamectl set-hostname "$HOSTNAME"
    #hostnamectl status

    cat <<EOT >> /etc/hosts
127.0.0.1 localhost
::1       localhost
127.0.1.1 $HOSTNAME.localdomain $HOSTNAME
EOT
}

function setup_reflector_service {

    # https://xyne.dev/projects/reflector/
    cat <<EOT >> /etc/xdg/reflector/reflector.conf

# Added by $THIS_SCRIPT
--country US
EOT

    # https://wiki.archlinux.org/title/Reflector#Automation
    # reflector.timer starts reflector.service weekly
    #systemctl start reflector.timer # Running in chroot, ignoring command 'start'
    systemctl enable reflector.timer
    # To run the reflector service manually:
    #sudo systemctl start reflector.service
}

function setup_paccache_timer {

    # https://wiki.archlinux.org/title/Pacman#Cleaning_the_package_cache
    #systemctl start paccache.timer # Running in chroot, ignoring command 'start'
    systemctl enable paccache.timer
}

function setup_vbox_service {

    systemctl enable vboxservice.service
    # OR
    #modprobe -a vboxguest vboxsf vboxvideo

    cat <<EOT > /etc/X11/xinit/xinitrc.d/99-vboxclient-all.sh
#!/usr/bin/sh
# SPDX-FileCopyrightText: Steven Ward
# SPDX-License-Identifier: OSL-3.0

if command -v VBoxClient-all > /dev/null
then
    VBoxClient-all
fi
EOT

    chmod --changes 755 -- /etc/X11/xinit/xinitrc.d/99-vboxclient-all.sh
}

function setup_0 {

    if ((EUID != 0))
    then
        echo 'Error: must run as root'
        exit 1
    fi

    # {{{ Set console font
    if command -v setfont > /dev/null
    then
        # To print the character set of the active font: showconsolefont

        # Fonts are in:
        # /usr/share/kbd/consolefonts (arch)
        # /lib/kbd/consolefonts (fedora)

        setfont Lat2-Terminus16
    fi
    # }}}

    ENCRYPT_PASSPHRASE=''

    if $ENCRYPT_ROOT_PARTITION
    then
        if [[ ! -t 0 ]]
        then
            echo 'Error: must run in an interactive shell'
            exit 1
        fi

        while true
        do
            read -r -s -p 'Enter encryption passphrase: ' ENCRYPT_PASSPHRASE
            echo
            if [[ -z "$ENCRYPT_PASSPHRASE" ]]
            then
                echo 'Error: passphrase for encrypting the root partition may not be empty'
                continue
            fi

            read -r -s -p 'Confirm encryption passphrase: ' ENCRYPT_PASSPHRASE2
            echo
            if [[ "$ENCRYPT_PASSPHRASE" != "$ENCRYPT_PASSPHRASE2" ]]
            then
                echo 'Error: passphrases do not match'
                continue
            fi

            break
        done
    fi

    # {{{ Partition /dev/sda
    #parted --script --align optimal /dev/sda mklabel msdos unit % mkpart primary 0 100
    parted --script --align optimal /dev/sda mklabel msdos \
    mkpart primary 1MiB 256MiB \
    mkpart primary 256MiB 100%
    parted --script /dev/sda set 1 boot on
    # }}}

    # {{{ Format root partition
    if $ENCRYPT_ROOT_PARTITION
    then
        # https://wiki.archlinux.org/title/Dm-crypt/Encrypting_an_entire_system
        # https://linuxhint.com/setup-luks-encryption-on-arch-linux/

        modprobe dm-crypt

        echo 'cryptsetup (1) ...'
        printf '%s' "$ENCRYPT_PASSPHRASE" | cryptsetup --verbose --batch-mode luksFormat /dev/sda2

        echo 'cryptsetup (2) ...'
        printf '%s' "$ENCRYPT_PASSPHRASE" | cryptsetup --verbose --batch-mode open /dev/sda2 cryptroot

        mkfs.ext4 -L root /dev/mapper/cryptroot
        mount --verbose -- /dev/mapper/cryptroot /mnt
    else
        mkfs.ext4 -L root /dev/sda2
        mount --verbose -- /dev/sda2 /mnt
    fi
    # }}}

    # {{{ Format boot partition
    mkfs.ext4 -L boot /dev/sda1
    mkdir --verbose -- /mnt/boot
    mount --verbose -- /dev/sda1 /mnt/boot
    # }}}

    # {{{ Update mirrorlist
    cp --verbose -- /etc/pacman.d/mirrorlist /etc/pacman.d/mirrorlist.bak
    reflector --save /etc/pacman.d/mirrorlist --protocol https --latest 5 --sort age --country US
    # }}}

    # {{{ Change pacman.conf misc options
    sed -E -i 's/^#(VerbosePkgLists)\>/\1/' /etc/pacman.conf
    sed -E -i 's/^#(ParallelDownloads)\>/\1/' /etc/pacman.conf
    # }}}

    # pacman-init.service won't start till this service finishes
    systemctl stop systemd-time-wait-sync.service

    # {{{ Wait for pacman-init.service to finish
    # pacman-init.service does the pacman-key --init and --populate.
    echo 'Waiting for pacman-init.service to finish ...'
    # https://unix.stackexchange.com/a/396633/439780
    while [[ "$(systemctl show -p SubState --value pacman-init.service)" != 'exited' ]]
    do
        sleep 1s
    done
    # }}}

    # {{{ Update the keyring if it's out-of-date
    # Do not use the "--needed" option
    pacman -S          --noconfirm -y archlinux-keyring
    #pacman -S --needed --noconfirm -u
    # }}}

    # {{{ Initialize the keyring and reload the default keys
    # Supposed to be fixed in pacman 6.0.1-8
    # https://github.com/archlinux/archinstall/issues/1511
    # https://github.com/archlinux/archinstall/issues/1389
    # https://bbs.archlinux.org/viewtopic.php?pid=2055012#p2055012
    # https://gitlab.archlinux.org/archlinux/archiso/-/issues/191
    #pacman-key --init
    #pacman-key --populate
    # }}}

    #pacstrap /mnt base linux
    pacstrap /mnt base

    genfstab -U /mnt >> /mnt/etc/fstab

    # Do not copy to /mnt/tmp because it is cleared after chroot
    cp --verbose -- "$THIS_SCRIPT" /mnt/

    # https://wiki.archlinux.org/title/Systemd-networkd#Wired_adapter_using_DHCP
    cp --verbose /etc/systemd/network/* /mnt/etc/systemd/network/

    # Must do basename of $THIS_SCRIPT because the parent path won't be present.
    # Example: /root/vbox.bash is copied to /mnt/vbox.bash, then run was /vbox.bash inside the chroot environment.
    arch-chroot /mnt bash /"$(basename -- "$THIS_SCRIPT")" "${ARGS[@]}"

    umount --verbose --recursive -- /mnt

    if findmnt -c -n --source /dev/cdrom -o TARGET > /dev/null
    then
        # https://lists.freedesktop.org/archives/systemd-devel/2012-September/006568.html

        # https://www.linux.org/docs/man8/systemd-shutdown.html
        #       Immediately before executing the actual system halt/poweroff/reboot/kexec systemd-shutdown will run all
        #       executables in /usr/lib/systemd/system-shutdown/ and pass one arguments to them: either "halt", "poweroff",
        #       "reboot" or "kexec", depending on the chosen action. All executables in this directory are executed in
        #       parallel, and execution of the action is not continued before all executables finished.

        cat <<EOT > /usr/lib/systemd/system-shutdown/eject.shutdown
#!/usr/bin/sh
/usr/bin/eject -v -T
EOT

        chmod 755 /usr/lib/systemd/system-shutdown/eject.shutdown
    else
        eject -v -T
    fi

    # if interactive
    if [[ -t 0 ]]
    then
        printf '\nTook %d seconds\n\n' "$SECONDS"

        # shellcheck disable=SC2034
        read -r -p 'Press Enter key to reboot now ' DUMMY
    fi

    systemctl reboot
}

# setup system, install packages
function setup_1 {

    if ((EUID != 0))
    then
        echo 'Error: must run as root'
        exit 1
    fi

    # https://stackoverflow.com/a/3403786
    exec &> >(tee --append --ignore-interrupts -- ./vbox.log)

    # {{{ Locale
    mv --backup=numbered -- /etc/locale.gen /etc/locale.gen.bak
    #sed -E -i 's/^#\s*\(en_US.UTF-8\)/\1/' /etc/locale.gen
    #sed -E -i 's/^#\(en_US.UTF-8\)/\1/' /etc/locale.gen
    echo 'en_US.UTF-8 UTF-8' > /etc/locale.gen
    locale-gen

    # {{{ Set console font
    # https://www.man7.org/linux/man-pages/man5/vconsole.conf.5.html
    # Should be set before mkinitcpio is called
#    cat <<EOT >> /etc/vconsole.conf
#FONT=Lat2-Terminus16
#EOT
    # }}}

    #export LANG=en_US.UTF-8
    #echo "LANG=$LANG" > /etc/locale.conf

    # https://wiki.archlinux.org/title/Chroot#Usage
    # Cannot be used inside a chroot
    #localectl set-locale LANG=en_US.UTF-8
    # }}}

    # {{{ Change pacman.conf misc options
    sed -E -i 's/^#(VerbosePkgLists)\>/\1/' /etc/pacman.conf
    sed -E -i 's/^#(ParallelDownloads)\>/\1/' /etc/pacman.conf
    # }}}

    # {{{ Edit /etc/mkinitcpio.conf
    if $ENCRYPT_ROOT_PARTITION
    then
        ENCRYPT_HOOK='encrypt'
    else
        # Must not add "encrypt" if the "crypt=" parameter won't be given to kernel
        ENCRYPT_HOOK=''
    fi

    # https://wiki.archlinux.org/title/Mkinitcpio#Common_hooks
    cat <<EOT >> /etc/mkinitcpio.conf

# Added by $THIS_SCRIPT
# Changes to HOOKS array:
#   Move "block" before "keyboard"
#   If encrypt, "encrypt" must be after "keyboard" to enter the passphrase
HOOKS=(base udev autodetect modconf kms block keyboard keymap consolefont $ENCRYPT_HOOK filesystems fsck)
EOT

    #mkinitcpio -p linux
    # OR
    #mkinitcpio -P # all presets
    # }}}

    # {{{ Install Linux
    pacman -S --needed --noconfirm \
        base grub linux
    # }}}

    # {{{ Install Arch packages
    curl -L https://raw.githubusercontent.com/planet36/arch-install/main/pkgs.txt | command grep -E -o '^[^# ]+' > /tmp/pkgs.txt

    until pacman -S --needed --noconfirm - < /tmp/pkgs.txt
    do
        echo 'Error: package installation failed.  Trying again in 5 seconds.'
        sleep 5s
    done
    # }}}

    # {{{ Configure grub
    setup_grub
    # }}}

    # {{{ System time zone, NTP
    # https://wiki.archlinux.org/title/Chroot#Usage
    # Cannot be used inside a chroot
    #timedatectl status
    #timedatectl set-timezone America/New_York
    #timedatectl set-ntp true
    #timedatectl status

    # https://wiki.archlinux.org/title/Systemd-timesyncd
    #systemctl enable systemd-timesyncd.service
    # }}}

    # Use static IP address
#    cat <<EOT >> /etc/systemd/network/20-ethernet.network
#
## Added by $THIS_SCRIPT
#[Network]
#DHCP=no
#Address=10.0.2.15/24
#Gateway=10.0.2.2
##DNS=8.8.8.8
##DNS=8.8.4.4
#EOT

#    cat <<EOT > /etc/resolv.conf.head
#nameserver 1.1.1.1
#nameserver 1.0.0.1
#EOT

#    cat <<EOT > /etc/resolv.conf.tail
#nameserver 1.1.1.1
#nameserver 1.0.0.1
#EOT
#nameserver 8.8.8.8
#nameserver 8.8.4.4


    #systemctl enable dhcpcd
    systemctl enable systemd-networkd
    systemctl enable systemd-resolved

    # Print DNS info
    #resolvectl status

    # {{{ Update mirrorlist service
    setup_reflector_service
    # }}}

    setup_paccache_timer

    setup_hostname_hosts

    # {{{ Virtualbox service
    setup_vbox_service
    # }}}

    # {{{ Disable systemd core dump archives, and use traditional Linux behavior
    # https://man7.org/linux/man-pages/man5/core.5.html
    echo 'kernel.core_pattern=core.%p' > /etc/sysctl.d/50-coredump.conf
    # }}}

    # {{{ Fix bash in /etc/shells
    # https://bugs.archlinux.org/task/33677
    # https://bugs.archlinux.org/task/33694
    # https://bugs.archlinux.org/task/69699
    # https://gitlab.archlinux.org/archlinux/packaging/packages/filesystem/-/commit/db8fce055a018aa7e581ff5901472ca350006d4f
    # https://gitlab.archlinux.org/archlinux/packaging/packages/bash/-/commit/20244daa4cca1e08f0d01db1bf68908176a5aa7e
    #echo '/usr/bin/bash' >> /etc/shells
    # }}}

    # Lock the root account
    passwd --lock root

    # {{{ Sudo
    echo '%wheel ALL=(ALL) ALL' > /etc/sudoers.d/01_group_wheel
    echo 'Defaults timestamp_timeout=-1' > /etc/sudoers.d/02_disable_timestamp_timeout
    echo 'Defaults timestamp_type=global' > /etc/sudoers.d/03_disable_per_terminal_sudo
    # }}}

    # {{{ Doas
    echo 'permit nopass keepenv :wheel' > /etc/doas.conf
#    cat <<EOT > /etc/doas.conf
#permit persist keepenv :wheel
#permit nopass keepenv root
#EOT
    #echo 'permit persist :wheel' > /etc/doas.conf
    # }}}

    # {{{ Modify defaults for all users

    # {{{ Create common directories in /etc/skel
    cd /etc/skel

    rm --verbose -- .bash_logout

    mkdir --verbose --parents -- Downloads
    # }}}

    # }}}

    # {{{ Create new user
    useradd \
        --create-home \
        --gid wheel \
        --groups vboxsf \
        -- "$NEW_USER"

    # The initial password is the user name
    printf '%s\n%s\n' "$NEW_USER" "$NEW_USER" | passwd --quiet -- "$NEW_USER"
    # }}}

    # Must use absolute path of $0
    su --login "$NEW_USER" -- "$THIS_SCRIPT" "${ARGS[@]}"
}

# setup user dotfiles and programs
function setup_2 {

    # {{{ Setup dotfiles
    cd

    if [[ ! -d .dotfiles ]]
    then
        git clone --quiet https://github.com/planet36/dotfiles.git .dotfiles
    fi

    bash .dotfiles/install.bash -r

    # The following may only be done after the dotfiles are installed

    # {{{ Copied from .bash_profile
    source "${XDG_CONFIG_HOME:-$HOME/.config}"/bash/xdg-envvars.bash
    source "$XDG_CONFIG_HOME"/bash/envvars.bash
    # }}}

    # Install programs after env vars are set
    # XXX: Do not run sequential targets (i.e. install, clean) in parallel
    # Install programs from dotfiles
    make -j"$(nproc)" -C .dotfiles/other/build-local install
    make -j"$(nproc)" -C .dotfiles/other/build-local clean
    # Install programs from external git repos
    make -j"$(nproc)" -C ~/.local/src install
    make -j"$(nproc)" -C ~/.local/src clean

    # Install neovim plugins
    bash "$XDG_DATA_HOME"/nvim/site/pack/myplugins/clone-plugins.bash
    # }}}

    # https://www.colour-science.org/installation-guide/
    # https://github.com/gtaylor/python-colormath
    # https://eyed3.readthedocs.io/en/latest/installation.html
    # https://github.com/Wazzaps/jqed#download--install
    #declare -a PIP_PACKAGES=(colour-science colormath eyed3 jqed snakeviz)
    #pip install --user ${PIP_PACKAGES[@]}
}

function parse_options {

    # Used in setup_1
    NEW_USER=''
    # Used in setup_0, setup_grub, setup_1
    ENCRYPT_ROOT_PARTITION=false

    while getopts 'u:e' OPTION "${ARGS[@]}"
    do
        case $OPTION in
            u) NEW_USER="$OPTARG" ;;
            e) ENCRYPT_ROOT_PARTITION=true ;;
            \?) exit 1 ;;
            *) ;;
        esac
    done
    # Do not shift because options will be re-used
    #shift $((OPTIND - 1))

    if [[ -z "$NEW_USER" ]]
    then
        if [[ ! -t 0 ]]
        then
            echo 'Error: must run in an interactive shell'
            exit 1
        fi

        read -r -p 'Enter new user: ' NEW_USER
        ARGS+=(-u "$NEW_USER")
    fi
}

function main {

    if ((EUID == 0))
    then # as root
        if ! systemd-detect-virt -r
        then # not in chroot
            setup_0 "${ARGS[@]}"
        else # in chroot
            setup_1 "${ARGS[@]}"
        fi
    else # not as root
        setup_2 "${ARGS[@]}"
    fi
}

parse_options "${ARGS[@]}"

main "${ARGS[@]}"

# vim: set expandtab shiftwidth=4 softtabstop=4 tabstop=4: