zshenv: clarify some comments

[dotfiles.git] / etc / zsh / .zshenv

diff --git a/etc/zsh/.zshenv b/etc/zsh/.zshenv
index 1248dbf6f9d23ddc9f4007eb3862748f2d68b3e2..bf8af5662fc0c89e6fb4714954696b4c33406cfb 100644 (file)
--- a/etc/zsh/.zshenv
+++ b/etc/zsh/.zshenv
@@ -86,7 +86,7 @@ function _sev_setpath {
     # shift valid system paths to the front if there are any left
     ((len > 0 && len < $#path)) && path=("${(@)path[len + 1, -1]}" "${(@)path[1, len]}")
     # include our zsh dir in fpath. unlike above, we always prefer our paths
     # shift valid system paths to the front if there are any left
     ((len > 0 && len < $#path)) && path=("${(@)path[len + 1, -1]}" "${(@)path[1, len]}")
     # include our zsh dir in fpath. unlike above, we always prefer our paths

-    fpath=({${ZDOTDIR:-~/.zsh},{${_sev_home:-~},~}/.zsh}/functions/**/*(/N) "$fpath[@]")
+    fpath=({${ZDOTDIR:-{${_sev_home:-~},~}/.zsh},{${_sev_home:-~},~}/.zsh}/functions/**/*(/N) "$fpath[@]")

     # remove bad paths
     for (( i = 1; i <= $#fpath; i++ )) {
         if [[ ! -d $fpath[$i] ]] {
     # remove bad paths
     for (( i = 1; i <= $#fpath; i++ )) {
         if [[ ! -d $fpath[$i] ]] {


@@ -127,14 +127,17 @@ if [[ ! -v _sev_setup_path || -o login ]] {
     # NOTE: do not set _sev_setup_path, it is set in zprofile
 }
 
     # NOTE: do not set _sev_setup_path, it is set in zprofile
 }
 

-### home dir setup & exports
+### home dir setup & additional exports

 # XXX: traditionally, zshenv should just contain exports, and not touch the
 # XXX: traditionally, zshenv should just contain exports, and not touch the

-#      filesystem. however, some system profile scripts that are sourced in the
-#      system zprofile may attempt to do things that rely on some of these
-#      vars. for example, `flatpak-bindir.sh` in the Arch Linux flatpak package
-#      references $XDG_DATA_HOME with no fallback. since we do special handling
-#      for these vars before we export them, we're forced to do it all here
-#      instead of zprofile.
+#      filesystem. however, our TMPDIR and XDG vars rely on mutable user paths
+#      that may not exist, and as such need to be set up before the rest of the
+#      system can use them. this is important as some environments include code
+#      in the global zprofile, or source scripts of other shells in the global
+#      zprofile, that may rely on our desired dir structure and vars pointing
+#      to it. for example, `flatpak-bindir.sh` in the Arch Linux flatpak
+#      package references $XDG_DATA_HOME with no fallback. since we do special
+#      handling for these vars before we export them, we're forced to do it all
+#      here instead of at the top of the zprofile.

 
 ## xdg local dir
 # NOTE: need this for tmp, so confirm it exists.
 
 ## xdg local dir
 # NOTE: need this for tmp, so confirm it exists.


@@ -152,12 +155,16 @@ if [[ ! -v _sev_setup_path || -o login ]] {
 #       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
 #       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.
+#       chances of that are slim. this also needs to be adjusted for usermode
+#       Xorg, as it requires $PREFIX/tmp/.X11-unix on most installs.

 if [[ ! -v _sev_tmp ]] {
 if [[ ! -v _sev_tmp ]] {

+    _sev_tmp=~/.local/tmp

     # create personal TMPDIR under system tmp
     # create personal TMPDIR under system tmp

-    t=${TMPDIR:-${TEMPDIR:-${TEMP:-${TMP:-${${TMPPREFIX%/zsh}:-/tmp}}}}}/.home-$LOGNAME
+    # NOTE: under proot with uid remapping, we can reuse old tmp, without
+    #       worrying about permission issues; intended for proot under termux.
+    # XXX: _sev_proot_old_user only works if /tmp is shared!
+    t=${TMPDIR:-${TEMPDIR:-${TEMP:-${TMP:-${${TMPPREFIX%/zsh}:-/tmp}}}}}/.home-${_sev_proot_old_username:-$LOGNAME}

     [[ -e $t ]] || mkdir -m700 $t 2>/dev/null
     [[ -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 ]] &&
     if [[ ! -d $t ]] {
         # fallback TMPDIR to bare local directory or existing softlink
         [[ -o interactive ]] &&


@@ -165,37 +172,38 @@ if [[ ! -v _sev_tmp ]] {
         [[ -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 ]] {
         [[ -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}
+            _sev_tmp=${$(mktemp 2>/dev/null):-/tmp}

             [[ -o interactive ]] &&
               print -P "%F{red}!!! Can't create tmp dir, using $_sev_tmp%f"
         }
             [[ -o interactive ]] &&
               print -P "%F{red}!!! Can't create tmp dir, using $_sev_tmp%f"
         }

-    } elif [[ -f $_sev_tmp || ( -d $_sev_tmp && ! -h $_sev_tmp ) ]] {
-        # file or non-softlink directory is on our local dir
+    } elif [[ -e $_sev_tmp && ! -h $_sev_tmp ]] {
+        # non-softlink node is on our local dir

         [[ -o interactive ]] &&
           print -P "%F{orange}*** $_sev_tmp exists, can't link to tmp dir $t, ignoring it%f"
         _sev_tmp=$t
     } else {
         [[ -o interactive ]] &&
           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 ]] &&
+        if [[ -h $_sev_tmp ]] {
+            [[ -o interactive && $_sev_tmp:P != $t:P ]] &&

               print -P "%F{orange}*** $_sev_tmp links to ${_sev_tmp:P} and not ${t:P}, unlinking it%f"
               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
+            # NOTE: ln -f doesn't seem to work reliably with softlink
+            #       directories, so explicitly remove the target if it exists
+            # XXX: potential race condition
+            # TODO: handle cleanup of old dir if it doesn't match?

             unlink $_sev_tmp 2>/dev/null
         }
             unlink $_sev_tmp 2>/dev/null
         }

+        # link local dir to tmp dir

         ln -s $t $_sev_tmp 2>/dev/null
     }
         ln -s $t $_sev_tmp 2>/dev/null
     }

-    if [[ -v _sev_tmp ]] {
-        # ensure dir is clean
-        _sev_zcleanup tmp
-        # finally create our subdir for this session
-        t=$_sev_tmp/.session.$$
-        if ! mkdir -m700 $t 2>/dev/null; then
-            [[ -o interactive ]] &&
-              print -P "%F{red}!!! Can't create session tmp subdir $t, using $_sev_tmp%f"
-            t=$_sev_tmp
-        fi
-        export _sev_tmp TMPDIR=$t TEMPDIR=$t TEMP=$t TMP=$t TMPPREFIX=$t/zsh
-    }
+    # ensure dir is clean
+    _sev_zcleanup tmp
+    # finally create our subdir for this session
+    t=$_sev_tmp/.session.$$
+    if ! mkdir -m700 $t 2>/dev/null; then
+        [[ -o interactive ]] &&
+          print -P "%F{red}!!! Can't create session tmp subdir $t, using $_sev_tmp%f"
+        t=$_sev_tmp
+    fi
+    export _sev_tmp TMPDIR=$t TEMPDIR=$t TEMP=$t TMP=$t TMPPREFIX=$t/zsh

     unset t
 }
 
     unset t
 }
 


@@ -215,52 +223,43 @@ if [[ ! -v _sev_setup_xdg ]] {
       emulate sh -c "source $XDG_CONFIG_HOME/user-dirs.dirs"
 
     typeset -UT XDG_DATA_DIRS xdg_data_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
-    } elif [[ ! -e ~/.local/share ]] {
-        mkdir -m760 ~/.local/share
-    }
-    xdg_data_dirs=($XDG_DATA_HOME /{opt,usr/local,usr/pkg,usr}/share
-      ${XDG_DATA_DIRS:+${xdg_data_dirs%%/}})
+    [[ -v XDG_DATA_HOME ]] && export XDG_DATA_HOME
+    [[ -e ${XDG_DATA_HOME:-~/.local/share} ]] ||
+      mkdir -m760 ${XDG_DATA_HOME:-~/.local/share}
+    xdg_data_dirs=($XDG_DATA_HOME ${XDG_DATA_DIRS:+${xdg_data_dirs%%/}}
+      /{usr{,/local,/pkg},opt{,/*{/*,}}}/share(N))
+    xdg_data_dirs=($xdg_data_dirs(/N))

     export XDG_DATA_DIRS
 
     typeset -UT XDG_CONFIG_DIRS xdg_config_dirs
     export XDG_DATA_DIRS
 
     typeset -UT XDG_CONFIG_DIRS xdg_config_dirs

-    if [[ -v XDG_CONFIG_HOME ]] {
-        export XDG_CONFIG_HOME
-    } elif [[ ! -e ~/.config ]] {
-        mkdir -m760 ~/.config
-    }
+    [[ -v XDG_CONFIG_HOME ]] && export XDG_CONFIG_HOME
+    [[ -e ${XDG_CONFIG_HOME:-~/.config} ]] ||
+      mkdir -m760 ${XDG_CONFIG_HOME:-~/.config}

     # I am of the belief .local should follow FHS /usr/local...
     # I am of the belief .local should follow FHS /usr/local...

-    [[ -e ~/.local/etc ]] || ln -s ~/.config ~/.local/etc
-    xdg_config_dirs=($XDG_CONFIG_HOME
-      ${XDG_CONFIG_DIRS:+${xdg_config_dirs%%/}}
-      {/opt,/usr/local,/usr/pkg,}/etc/xdg)
+    [[ -e ~/.local/etc ]] || ln -s ${XDG_CONFIG_HOME:-~/.config} ~/.local/etc
+    xdg_config_dirs=($XDG_CONFIG_HOME ${XDG_CONFIG_DIRS:+${xdg_config_dirs%%/}}
+      {,/usr{,/local,/pkg},opt{,/*{/*,}}}/etc/xdg(N))
+    xdg_config_dirs=($xdg_config_dirs(/N))

     export XDG_CONFIG_DIRS
 
     export XDG_CONFIG_DIRS
 

-    if [[ -v XDG_STATE_HOME ]] {
-        export XDG_STATE_HOME
-    } elif [[ ! -e ~/.local/state ]] {
-        mkdir -m760 ~/.local/state
-    }
+    [[ -v XDG_STATE_HOME ]] && export XDG_STATE_HOME
+    [[ -e ${XDG_STATE_HOME:-~/.local/state} ]] ||
+      mkdir -m760 ${XDG_STATE_HOME:-~/.local/state}

 
     if [[ -v XDG_CACHE_HOME ]] {
         export XDG_CACHE_HOME
     } else {
 
     if [[ -v XDG_CACHE_HOME ]] {
         export XDG_CACHE_HOME
     } else {

-        if [[ -v _sev_tmp ]] {
-            export XDG_CACHE_HOME=$_sev_tmp/.xdg.cache
-            [[ -e $XDG_CACHE_HOME ]] || mkdir -m700 $XDG_CACHE_HOME
-        } elif [[ ! -e ~/.cache ]] {
-            mkdir -m700 ~/.cache
-        }
+        export XDG_CACHE_HOME=$_sev_tmp/.xdg.cache

     }
     }

+    [[ -e ${XDG_CACHE_HOME:-~/.cache} ]] ||
+      mkdir -m700 ${XDG_CACHE_HOME:-~/.cache}

 
 

+    # NOTE: this can be set by systemd or other pre-shell supervisor, and if
+    #       any services were started such as pipewire, we need to use the
+    #       existing runtime dir to preserve runtime state

     if [[ -v XDG_RUNTIME_DIR ]] {
     if [[ -v XDG_RUNTIME_DIR ]] {

-        # NOTE: this can be set by systemd or other pre-shell supervisor, and
-        #       if any services were started such as pipewire, we need to use
-        #       the existing runtime dir so that we can get any existing
-        #       program sockets or other data

         export XDG_RUNTIME_DIR
         export XDG_RUNTIME_DIR

-    } elif [[ -v TMPDIR ]] {
+    } else {

         # 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
         # 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


@@ -269,8 +268,9 @@ if [[ ! -v _sev_setup_xdg ]] {
         } elif [[ -e $XDG_RUNTIME_DIR ]] {
             rm -rf $XDG_RUNTIME_DIR 2>/dev/null
         }
         } elif [[ -e $XDG_RUNTIME_DIR ]] {
             rm -rf $XDG_RUNTIME_DIR 2>/dev/null
         }

-        mkdir -m700 $XDG_RUNTIME_DIR 2>/dev/null

     }
     }

+    [[ ! -e $XDG_RUNTIME_DIR ]] &&
+      mkdir -m700 $XDG_RUNTIME_DIR 2>/dev/null

 
     export _sev_setup_xdg=
 }
 
     export _sev_setup_xdg=
 }