From: sev Date: Mon, 16 Oct 2023 23:41:05 +0000 (-0500) Subject: more zsh refactoring X-Git-Url: https://git.sev.monster/~sev/dotfiles.git/commitdiff_plain/b31a3fb1d2a23158add217e47783cce2f887e0e7?ds=sidebyside more zsh refactoring - fixed bug where zshenv would not be called after setting ZDOTDIR since it lives in $HOME - moved some stuff from .zprofile to .zshenv and fixed ordering - added load-site-dotfile instead of sourcing per-file - _sev_home still not done yet... just ignore it --- diff --git a/base/.zshenv b/base/.zshenv index 274fc10..50281d2 100644 --- a/base/.zshenv +++ b/base/.zshenv @@ -1,30 +1,3 @@ -[[ -v _sev_home ]] || export _sev_home=$HOME - +# wrapper around ZDOTDIR zshenv export ZDOTDIR=${XDG_CONFIG_HOME:-~/.config}/zsh - -### fix broken term -if [[ ! -v TERM ]] { - TERM=xterm-256color >/dev/null 2>&1 -} -if [[ -o interactive && $#terminfo -eq 0 ]] { - _oldterm=$TERM - export TERM=xterm >/dev/null 2>&1 - print -P "%F{red}!!! Can't find terminfo for $_oldterm, using $TERM%f" - unset _oldterm -} - -# NOTE: see .zprofile comment for rationale on sourcing -if [[ ! -v _sev_first_display && ( -v DISPLAY || -v WAYLAND_DISPLAY ) ]] { - ### update gpgagent to use graphical pinentry - # XXX: will be sourced by every new child shell if zsh is not used to - # start the graphical session and the _sev_first_display var isn't - # exported; for example, this previously happened with sway without a - # display manager or launcher in front of it - export _sev_first_display= - _sev_refresh_gpgagent= - [[ ! -o login ]] && source ${ZDOTDIR:-~}/.zprofile -} elif [[ ! -o login && $SHLVL -eq 1 && ${+TERMUX_VERSION} -eq 0 ]] { - ### early zprofile sourcing for first shell even if not a login shell, - ### since Termux does not start login shell as first process - source ${ZDOTDIR:-~}/.zprofile -} +source $ZDOTDIR/.zshenv diff --git a/etc/zsh/.zprofile b/etc/zsh/.zprofile index 4f11459..05544ed 100644 --- a/etc/zsh/.zprofile +++ b/etc/zsh/.zprofile @@ -1,17 +1,14 @@ # NOTE: # our .zprofile can be expensive, so we keep track of what has been run -# already, and only set up what is necessary. additionally, we want to ensure -# that our environment is set up as early as possible, so we also source -# .zprofile in .zshenv for new non-login shells. +# already, and only set up what is necessary. this also allows us to re-source +# the file to reinitialize specific parts when desired. # -# these issues are handled by using these methods: -# * the parent shell that starts the user's session after logging in to some -# graphical environments may not be a login shell—due to misconfiguration -# or otherwise—which means .zprofile is not ran and the environment is not -# properly configured for any child processes. -# * some desktop environments/graphical terminal emulators will start new -# terminal windows with login shells, which runs .zprofile every time and -# leads to noticably slow startup times if we have not already ran it. +# in order to ensure future interactive environments are set up as early as +# possible, we source this file from .zshenv for non-login shells, under some +# specific conditions outlined there. +# +# this file respects non-interactive sessions and will not intentionally emit +# output. ### cleanup # XXX: only call after relevant vars have been set up, defined early so that @@ -62,60 +59,12 @@ function _sev_zcleanup { unset x p y } -### path -# NOTE: we utilize the fact that unique arrays keep the first occurrence and -# remove any further occurences to capture elements from the old PATH -# that we did not anticipate and shift them to the front, since they are -# probably important to the system -if [[ ! -v _sev_setup_path || -o login ]] { - typeset -U path fpath - # add as many generic paths as possible to keep the order we want - # NOTE: /usr/{local,pkg,games} are unix/bsdisms - # XXX: PREFIX not validated, non-posix but Termux uses it, maybe others - # XXX: XDG specifies ~/.local/bin as the only user-writable dir for - # executables, but we specify more; technically this is against spec - syspath=("$path[@]") - path=({{${_sev_home:-~},~}{/.local,},{$PREFIX,}{,/opt,/usr{,/local,/pkg}}}/{s,}bin - /usr/{X11R{7,6}/bin,games}) - ((len=$#path)) - path=("$path[@]" "$syspath[@]") - # remove nonexistent and duplicate paths - for (( i = 1; i <= $#path; i++ )) { - if [[ ! -e $path[$i] ]] { - path[$i]=() - ((i <= len)) && ((len--)) - ((i--)) - continue - } - } - # shift valid system paths to the front if there are any left - ((len > 0 && len < $#path)) && path=("${(@)path[len + 1, -1]}" "${(@)path[1, len]}") - unset syspath len i - # include our zsh dir in fpath. unlike above, we always prefer our paths - fpath=(${ZDOTDIR:-~/.zsh}/functions/{*,Completions/*}(N) "$fpath[@]") - # FPATH is not exported by default - export FPATH - typeset +U path fpath - export _sev_setup_path= -} - -### autoload to load site specific dotfiles now that fpath is set -autoload -Uz load-site-dotfile - -### load zshenv site-specific -# NOTE: this has to be here since fpath isn't set in .zshenv -load-site-dotfile zshenv - -### lang -export CHARSET=${CHARSET:-UTF-8} -export LANG=${LANG:-en_US.UTF-8} - ### xdg local dir # NOTE: need this for tmp, so confirm it exists. # XXX: perms are not specified for XDG dirs except runtime, but I think 760 # makes the most sense. shouldn't break anything since no one else should # be poking around in our dir. -[[ -e ${_sev_home:-~}/.local ]] || mkdir -m760 ${_sev_home:-~}/.local +[[ -e ~/.local ]] || mkdir -m760 ~/.local ### tmp # NOTE: specs say that POSIX tmp and XDG runtime directories should exist @@ -123,31 +72,39 @@ export LANG=${LANG:-en_US.UTF-8} # since we can't reliably keep track of sessions in a cross-platform # manner, the current implementation should use a separate directory per # toplevel session (i.e. SHLVL=1). this should placate most applications, -# though it is not expressly spec compliant. +# though it is not expressly spec compliant. this may also cause problems +# with disowned applications that still try to use the directories after +# the toplevel shell has already logged out and the dirs removed, but the +# chances of that are slim. if [[ ! -v _sev_tmp ]] { - _sev_tmp=${_sev_home:-~}/.local/tmp - # NOTE: race condition/remove in use files - [[ -h $_sev_tmp ]] && unlink $_sev_tmp 2>/dev/null - t=${TMPDIR:-${TEMP:-${TMP:-/tmp}}}/.home-$LOGNAME - # create personal tmp dir under system tmp + # create personal TMPDIR under system tmp + t=${TMPDIR:-${TEMPDIR:-${TEMP:-${TMP:-/tmp}}}}/.home-$LOGNAME [[ -e $t ]] || mkdir -m700 $t 2>/dev/null + _sev_tmp=~/.local/tmp if [[ ! -d $t ]] { + # fallback TMPDIR to bare local directory or existing softlink [[ -o interactive ]] && - print -P "%F{orange}*** Can't create TMPDIR $t, using $_sev_tmp%f" - # fallback bare directory - [[ -e $_sev_tmp ]] || mkdir -m700 $_sev_tmp 2>/dev/null + print -P "%F{orange}*** Can't create tmp dir $t, using $_sev_tmp%f" + [[ -h $_sev_tmp && ! -d _sev_tmp ]] && unlink $_sev_tmp 2>/dev/null + [[ ! -e $_sev_tmp ]] && mkdir -m700 $_sev_tmp 2>/dev/null if [[ ! -d $_sev_tmp ]] { + _sev_tmp=${$(mktemp 2>/dev/null):/tmp} [[ -o interactive ]] && - print -P "%F{red}!!! No usable TMPDIR%f" - unset _sev_tmp - } else { - t=$_sev_tmp + print -P "%F{red}!!! Can't create tmp dir, using $_sev_tmp%f" } - } elif [[ -e $_sev_tmp ]] { + } elif [[ -f $_sev_tmp || ( -d $_sev_tmp && ! -h $_sev_tmp ) ]] { + # file or non-softlink directory is on our local dir [[ -o interactive ]] && - print -P "%F{orange}*** $_sev_tmp occluded, can't link to TMPDIR $t%f" + print -P "%F{orange}*** $_sev_tmp exists, can't link to tmp dir $t, ignoring it%f" _sev_tmp=$t } else { + # link local dir to tmp dir + if [[ -h $_sev_tmp && $_sev_tmp:P != $t:P ]] { + [[ -o interactive ]] && + print -P "%F{orange}*** $_sev_tmp links to ${_sev_tmp:P} and not ${t:P}, unlinking it%f" + # XXX: race condition for existing sessions still using this dir + unlink $_sev_tmp 2>/dev/null + } ln -s $t $_sev_tmp 2>/dev/null } if [[ -v _sev_tmp ]] { @@ -157,12 +114,12 @@ if [[ ! -v _sev_tmp ]] { t=$_sev_tmp/.session.$$ if ! mkdir -m700 $t 2>/dev/null; then [[ -o interactive ]] && - print -P "%F{red}!!! Can't create session subdir $t, using $_sev_tmp%f" + print -P "%F{red}!!! Can't create session tmp subdir $t, using $_sev_tmp%f" t=$_sev_tmp fi - export _sev_tmp TMPDIR=$t TEMP=$t TMP=$t - unset t + export _sev_tmp TMPDIR=$t TEMPDIR=$t TEMP=$t TMP=$t } + unset t } ### xdg @@ -172,6 +129,14 @@ if [[ ! -v _sev_setup_xdg ]] { # if it wasn't set, we just use default and leave it unset # NOTE: include and then remove CONFIG_HOME and DATA_HOME to ensure they # are not present in the array if it was added before we got to it + + # source user dirs before other vars; technically it is against spec to + # include any of the below dirs there, but you never know what crazy shit + # people will do. I rather handle them sanely with our own code than let + # them override after the fact. + [[ -e $XDG_CONFIG_HOME/user-dirs.dirs ]] && + emulate sh -c "source $XDG_CONFIG_HOME/user-dirs.dirs" + typeset -UT XDG_DATA_DIRS xdg_data_dirs if [[ -v XDG_DATA_HOME ]] { export XDG_DATA_HOME @@ -181,6 +146,7 @@ if [[ ! -v _sev_setup_xdg ]] { xdg_data_dirs=($XDG_DATA_HOME /{opt,usr/local,usr/pkg,usr}/share "${XDG_DATA_DIRS:+${xdg_data_dirs[@]}}") # XXX: if colons are not escaped, could remove unintended part of string + # TODO: remove empty element via array not scalar export XDG_DATA_DIRS=${XDG_DATA_DIRS#$XDG_DATA_HOME:} typeset -UT XDG_CONFIG_DIRS xdg_config_dirs @@ -194,6 +160,7 @@ if [[ ! -v _sev_setup_xdg ]] { xdg_config_dirs=($XDG_CONFIG_HOME ${XDG_CONFIG_DIRS:+"$xdg_config_dirs[@]"} {/opt,/usr/local,/usr/pkg,}/etc/xdg) # XXX: if colons are not escaped, could remove unintended part of string + # TODO: remove empty element via array not scalar export XDG_CONFIG_DIRS=${XDG_CONFIG_DIRS#$XDG_CONFIG_HOME:} if [[ -v XDG_STATE_HOME ]] { @@ -215,7 +182,7 @@ if [[ ! -v _sev_setup_xdg ]] { if [[ -v XDG_RUNTIME_DIR ]] { export XDG_RUNTIME_DIR - } else { + } elif [[ -v TMPDIR ]] { # make runtime dir in our session-specific tmpdir export XDG_RUNTIME_DIR=$TMPDIR/.xdg.runtime # same as in tmpdir creation, ensure dir doesn't exist @@ -227,9 +194,6 @@ if [[ ! -v _sev_setup_xdg ]] { mkdir -m700 $XDG_RUNTIME_DIR 2>/dev/null } - # source user dirs after other vars - [[ -e $XDG_CONFIG_HOME/user-dirs.dirs ]] && - emulate sh -c "source $XDG_CONFIG_HOME/user-dirs.dirs" export _sev_setup_xdg= } @@ -242,34 +206,54 @@ if [[ ! -v DBUS_SESSION_BUS_ADDRESS && -v commands[dbus-launch] ]] { ### gpg home if [[ ! -v GNUPGHOME ]] { export GNUPGHOME=${XDG_CONFIG_HOME:-~/.config}/gnupg - if [[ -d ~/.gnupg ]] { - mv ~/.gnupg ${XDG_CONFIG_HOME:-~/.config}/gnupg + # move existing gnupg dir to our new home + if [[ -d ~/.gnupg && ! -d $GNUPGHOME ]] { + mv ~/.gnupg $GNUPGHOME } } ### gpg agent + forwarding -# NOTE: while ssh manages its auth sock in its protocol when ForwardSsh is -# enabled, GPG must be forwarded manually over Unix socket. to support -# this, we forward the restricted gpg-agent extra socket to the remote -# host with a RemoteForward rule in ~/.ssh/config that uses the -# _GNUPG_SOCK_* env vars. to avoid conflicts with other ssh sessions -# where the same user is connecting to the same host from different -# machines, gpg in each environment should utilize its own forwarded -# socket, rather than replace the sockets in GNUPGHOME which will be -# overridden on the next connection. previously, you could provide a path -# to the agent socket in GPG_AGENT_INFO, but that was deprecated in GPG -# v2.1. instead, we must clone GNUPGHOME with links and replace the agent -# sockets there with the forwarded one. +# NOTE: while ssh manages its auth sock in-protocol when ForwardSsh is enabled, +# GPG must be forwarded manually over Unix socket. to support this, we +# forward the restricted gpg-agent extra socket to the remote host with a +# RemoteForward rule in ~/.ssh/config that uses the _GNUPG_SOCK_* vars. +# +# to avoid conflicts with other ssh sessions where the same user is +# connecting to the same host from different machines, gpg should utilize +# its own forwarded socket for each session. previously, you could +# provide a path to the agent socket in GPG_AGENT_INFO, but that was +# deprecated in GPG v2.1; instead, we must replace the socket in gpg's +# socket dir. +# +# gnupg commits fb88f37–aab8a0b moved sockets from GNUPGHOME by default +# to directories under /run. aab8a0b in particular solidifies the +# functionality shift to utilize systemd-logind's user runtime +# directories. if the dir isn't found, gpg will fall back to the homedir. +# since previous functionality allowed multiple homedirs with multiple +# sockets, a provision was added where changing GNUPGHOME will also +# change the socket dir to a hashed dir under the usual runtime dir. +# +# utilizing this information, we can conclude: +# - on systems with user runtime dirs, changing GNUPGHOME will also +# give us a unique socket dir under the user runtime dir; +# - on other systems, the socket dir follows GNUPGHOME. +# therefore, the safest way to ensure unique sockets while not having to +# write specific logic for both scenarios is to simply change GNUPGHOME. +# the easiest way to do this is to create a new dir and link the contents +# of GNUPGHOME to the new home. we can then replace the agent sockets +# there with the forwarded one. +# # NOTE: since Unix sockets are not supported under Windows, this will not work # under msys, cygwin, mingw, etc., but may work under wsl2. +# # HACK: without SendEnv, which is disabled by default in most sshd configs, -# there is no foolproof way to prevent race conditions via filename -# collisions or to pass the desired forward path to the remote host -# environment. we just have to guess the path we choose is good on the -# desination, and assume the newest matching socket is the correct one -# after connecting. in theory, we could occlude the ssh binary on PATH -# with an alias or script that would allow us to communicate with the -# remote host before opening a shell, so that we can have the host +# there is no foolproof way to prevent race conditions via socket +# filename collisions or to pass the desired forward path to the remote +# host environment. we just have to guess the path we choose is good on +# the desination, and assume the newest matching socket is the correct +# one after connecting. in theory, we could occlude the ssh binary on +# PATH with an alias or script that would allow us to communicate with +# the remote host before opening a shell, so that we can have the host # communicate back to the client where it wants a socket created or ask # the host if the path the client wants to use is writable. however, this # would open up too many edge cases where it wouldn't work or be too @@ -279,11 +263,11 @@ function _gpg_socketpath { echo ${1//(#b)%([[:xdigit:]](#c2))/${(#):-0x$match[1]}} } if [[ ! -v _sev_setup_gpg_forward && -v commands[gpg] ]] { - # XXX: assuming /tmo exists and is writable on destination + # XXX: assuming /tmp exists and is writable on destination export _GNUPG_SOCK_DEST_BASE=/tmp/.gpg-agent-forward export _GNUPG_SOCK_DEST_EXT=$(date +%s).$RANDOM export _GNUPG_SOCK_DEST=$_GNUPG_SOCK_DEST_BASE.$_GNUPG_SOCK_DEST_EXT - export _sev_gpg_forward_dir=${GNUPGHOME:-~/.gnupg}/.ssh_forward + export _sev_gpg_forward_dir=$XDG_RUNTIME_DIR/gnupg/.ssh_forward _sev_zcleanup gpg-forward # find our forwarded socket @@ -293,8 +277,7 @@ if [[ ! -v _sev_setup_gpg_forward && -v commands[gpg] ]] { export _sev_setup_gpg_forward= h=$_sev_gpg_forward_dir/$$ mkdir -pm700 $h - # XXX: is it safe to link scdaemon socket? can its name be changed? - for x (S.scdaemon gpg.conf gpg-agent.conf sshcontrol random_seed + for x (gpg{,-agent}.conf sshcontrol random_seed pubring.kbx{,~} trustdb.gpg private-keys-v1.d crls.d) { ln -s ${GNUPGHOME:-~/.gnupg}/$x $h } @@ -302,17 +285,17 @@ if [[ ! -v _sev_setup_gpg_forward && -v commands[gpg] ]] { unset h for x in $(gpgconf --list-dirs | grep 'agent-.*-\?socket:'); do x=$(_gpg_socketpath ${x/#agent-*socket:}) - if [[ ! -v orig ]] { + if [[ ! -v primary ]] { # move forwarded socket to first valid agent socket path # XXX: if tmp is on different filesystem this may not work mv $s $x - orig=$x + primary=$x } else { # make links to forwarded socket for any others - ln -s $orig $x + ln -s $primary $x } done - unset x orig + unset x primary } unset s @@ -354,7 +337,7 @@ if [[ -v commands[gpg-connect-agent] && # XXX: don't know if gpg-agent supports comments after directives # XXX: path could have # # XXX: we are assuming this is our pinentry from .local/bin - sed -Ei 's#^([[:space:]]*pinentry-program[[:space:]]).*$#\1'${commands[pinentry]:-/dev/null}'#' \ + sed -Ei 's#^([[:space:]]*pinentry-program[[:space:]]).*$#\1'$HOME'/.local/bin/pinentry#' \ ${GNUPGHOME:-~/.gnupg}/gpg-agent.conf 2>/dev/null # XXX: could check for changes before doing this to save perf gpg-connect-agent RELOADAGENT UPDATESTARTUPTTY /bye >/dev/null 2>&1 @@ -435,6 +418,5 @@ unfunction _gpg_socketpath eval $(perl -I$XDG_DATA_HOME/perl5/lib/perl5 \ -Mlocal::lib=$XDG_DATA_HOME/perl5 2>/dev/null) - ### load site-specific load-site-dotfile zprofile diff --git a/etc/zsh/.zshenv b/etc/zsh/.zshenv new file mode 100644 index 0000000..f14590e --- /dev/null +++ b/etc/zsh/.zshenv @@ -0,0 +1,87 @@ +### critical exports, the rest are in zprofile +export CHARSET=${CHARSET:-UTF-8} +export LANG=${LANG:-en_US.UTF-8} +## alternative home for pulling in bin & config, used for zsu +[[ -v _sev_home ]] || export _sev_home=$HOME + +## fix broken term +# NOTE: we do this here instead of .zshrc since we might echo stuff +if [[ -t 1 ]] { # only if stdout is tty + [[ ! -v TERM ]] && export TERM=xterm-256color >/dev/null 2>&1 + if [[ $#terminfo -eq 0 ]] { + _oldterm=$TERM + export TERM=xterm >/dev/null 2>&1 + [[ -o interactive ]] && + print -P "%F{red}!!! Can't find terminfo for $_oldterm, using $TERM%f" + unset _oldterm + } +} + +## path +# NOTE: we utilize the fact that unique arrays keep the first occurrence and +# remove any further occurences to capture elements from the old PATH +# that we did not anticipate and shift them to the front, since they are +# probably important to the system +if [[ ! -v _sev_setup_path || -o login ]] { + typeset -U path fpath + # add as many generic paths as possible to keep the order we want + # NOTE: /usr/{local,pkg,games} are unix/bsdisms + # XXX: PREFIX not validated, non-posix but Termux uses it, maybe others + # XXX: XDG specifies ~/.local/bin as the only user-writable dir for + # executables, but we specify more; technically this is against spec + syspath=("$path[@]") + path=({{${_sev_home:-~},~}{/.local,},{$PREFIX,}{,/opt,/usr{,/local,/pkg}}}/{s,}bin + /usr/{X11R{7,6}/bin,games}) + ((len=$#path)) + path=("$path[@]" "$syspath[@]") + # remove bad paths + for (( i = 1; i <= $#path; i++ )) { + if [[ ! -d $path[$i] ]] { + path[$i]=() + ((i <= len)) && ((len--)) + ((i--)) + continue + } + } + # shift valid system paths to the front if there are any left + ((len > 0 && len < $#path)) && path=("${(@)path[len + 1, -1]}" "${(@)path[1, len]}") + unset syspath len i + # include our zsh dir in fpath. unlike above, we always prefer our paths + fpath=({${ZDOTDIR:-~/.zsh},{${_sev_home:-~},~}/.zsh}/functions/**/*(/N) "$fpath[@]") + # FPATH is not exported by default + export FPATH + typeset +U path fpath + export _sev_setup_path= +} + +### load zshenv site-specific +autoload -Uz load-site-dotfile +load-site-dotfile zshenv + +### source .zprofile early for non-login shells to fix issues +if [[ ! -v _sev_first_display && ( -v DISPLAY || -v WAYLAND_DISPLAY ) ]] { + # most graphical login/session managers will spawn the user's shell as a + # parent of all child processes for that session. however, if the parent shell + # isn't a login shell for some reason, our .zprofile won't be run, and the + # environment won't be configured for child processes. + # + # XXX: .zprofile will be sourced by every new child shell if zsh is not + # used to start the graphical session and the _sev_first_display var + # isn't exported; for example, this previously happened when using + # sway without a display manager in front of it to run a login shell. + # + # this issue is not mitigated by .zprofile only loading what has not + # already been loaded if the env vars preventing the load are not set; + # in that case, every shell will think it is a fresh login shell. + + # update gpgagent to use graphical pinentry + # XXX: will steal display from any other logged in graphical sessions, but + # I consider this to be an unlikely scenario + _sev_refresh_gpgagent= + + export _sev_first_display= + [[ ! -o login ]] && source ${ZDOTDIR:-~}/.zprofile +} elif [[ ${+TERMUX_VERSION} -eq 0 && ! -o login && $SHLVL -eq 1 ]] { + ## Termux first process isn't login shell, so source early + source ${ZDOTDIR:-~}/.zprofile +} diff --git a/etc/zsh/functions/Misc/load-site-dotfile b/etc/zsh/functions/Misc/load-site-dotfile index 275912d..32fc695 100644 --- a/etc/zsh/functions/Misc/load-site-dotfile +++ b/etc/zsh/functions/Misc/load-site-dotfile @@ -4,7 +4,5 @@ emulate -L zsh local x p typeset -aU p -p=({${ZDOTDIR:-~},~}/{.,}${1#.}.local) -for x ($p) { - [[ -f $x ]] && source $x -} +p=({${ZDOTDIR:-~},{${_sev_home:-~},~}{/.zsh,}}/{.,}${1#.}.local(.N)) +for x ($p) source $x