# event was handled?
: ${AUTOENV_HANDLE_LEAVE:=1}
+# Enable debugging. Multiple levels are supported (max 2).
+: ${AUTOENV_DEBUG:=0}
-# Internal: stack of entered (and handled) directories.
-_autoenv_stack_entered=()
+# Public helper functions, which can be used from your .env files:
+#
+# Source the next .env file from parent directories.
+# This is useful if you want to use a base .env file for a directory subtree.
+autoenv_source_parent() {
+ local parent_env_file=$(_autoenv_get_file_upwards $PWD)
+ if [[ -n $parent_env_file ]] \
+ && _autoenv_check_authorized_env_file $parent_env_file; then
+ _autoenv_debug "Calling autoenv_source_parent: parent_env_file:$parent_env_file"
-_autoenv_hash_pair() {
+ local parent_env_dir=${parent_env_file:A:h}
+
+ _autoenv_stack_entered_add $parent_env_file
+
+ _autoenv_source $parent_env_file enter $parent_env_dir
+ fi
+}
+
+# Internal functions. {{{
+# Internal: stack of entered (and handled) directories. {{{
+typeset -a _autoenv_stack_entered
+typeset -A _autoenv_stack_entered_mtime
+
+# Add an entry to the stack, and remember its mtime.
+_autoenv_stack_entered_add() {
local env_file=$1
- if (( $+2 )); then
- env_shasum=$2
+
+ _autoenv_debug "[stack] adding: $env_file" 2
+
+ # Remove any existing entry.
+ _autoenv_stack_entered_remove $env_file
+
+ # Append it to the stack, and remember its mtime.
+ _autoenv_stack_entered+=($env_file)
+ _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
+}
+
+_autoenv_get_file_mtime() {
+ if [[ -f $1 ]]; then
+ zstat +mtime $1
else
+ echo 0
+ fi
+}
+
+# Remove an entry from the stack.
+_autoenv_stack_entered_remove() {
+ local env_file=$1
+ _autoenv_debug "[stack] removing: $env_file" 2
+ _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
+ _autoenv_stack_entered_mtime[$env_file]=
+}
+
+# Is the given entry already in the stack?
+_autoenv_stack_entered_contains() {
+ local env_file=$1
+ if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
+ # Entry is in stack.
+ if [[ $_autoenv_stack_entered_mtime[$env_file] == $(_autoenv_get_file_mtime $env_file) ]]; then
+ # Entry has the expected mtime.
+ return
+ fi
+ fi
+ return 1
+}
+# }}}
+
+# Internal function for debug output. {{{
+_autoenv_debug() {
+ local msg=$1
+ local level=${2:-1}
+ if [[ $AUTOENV_DEBUG -lt $level ]]; then
+ return
+ fi
+ # Load zsh color support.
+ if [[ -z $colors ]]; then
+ autoload colors
+ colors
+ fi
+ # Build $indent prefix.
+ local indent=
+ if [[ $_autoenv_debug_indent -gt 0 ]]; then
+ for i in {1..${_autoenv_debug_indent}}; do
+ indent=" $indent"
+ done
+ fi
+
+ # Split $msg by \n (not newline).
+ lines=(${(ps:\\n:)msg})
+ for line in $lines; do
+ echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
+ echo ${indent}${line} >&2
+ done
+}
+# }}}
+
+# Load zstat module, but only its builtin `zstat`.
+zmodload -F zsh/stat b:zstat
+
+
+# Generate hash pair for a given file ($1).
+# A fixed hash value can be given as 2nd arg, but is used with tests only.
+_autoenv_hash_pair() {
+ local env_file=${1:A}
+ local env_shasum=${2:-}
+ if [[ -z $env_shasum ]]; then
+ if ! [[ -e $env_file ]]; then
+ echo "Missing file argument for _autoenv_hash_pair!" >&2
+ return 1
+ fi
env_shasum=$(shasum $env_file | cut -d' ' -f1)
fi
- echo "$env_file:$env_shasum:1"
+ echo ":${env_file}:${env_shasum}:1"
}
_autoenv_authorized_env_file() {
}
_autoenv_authorize() {
- local env_file=$1
+ local env_file=${1:A}
_autoenv_deauthorize $env_file
_autoenv_hash_pair $env_file >> $AUTOENV_ENV_FILENAME
}
+# Deauthorize a given filename, by removing it from the auth file.
+# This uses `test -s` to only handle non-empty files, and a subshell to
+# allow for writing to the same file again.
_autoenv_deauthorize() {
- local env_file=$1
- if [[ -f $AUTOENV_ENV_FILENAME ]]; then
- echo $(\grep -vF $env_file $AUTOENV_ENV_FILENAME) > $AUTOENV_ENV_FILENAME
+ local env_file=${1:A}
+ if [[ -s $AUTOENV_ENV_FILENAME ]]; then
+ echo "$(\grep -vF :${env_file}: $AUTOENV_ENV_FILENAME)" > $AUTOENV_ENV_FILENAME
fi
}
# This function can be mocked in tests
-_autoenv_read_answer() {
+_autoenv_ask_for_yes() {
local answer
- read $=_AUTOENV_TEST_READ_ARGS -q answer
- echo $answer
+ read answer
+ if [[ $answer == "yes" ]]; then
+ return 0
+ else
+ return 1
+ fi
}
# Args: 1: absolute path to env file (resolved symlinks).
return 1
fi
if ! _autoenv_authorized_env_file $1; then
- echo "Attempting to load unauthorized env file: $1"
+ echo "Attempting to load unauthorized env file!"
+ command ls -l $1
echo ""
echo "**********************************************"
echo ""
echo ""
echo "**********************************************"
echo ""
- echo -n "Would you like to authorize it? [y/N] "
+ echo -n "Would you like to authorize it? (type 'yes') "
- local answer=$(_autoenv_read_answer)
- echo
- if [[ $answer != 'y' ]]; then
+ if ! _autoenv_ask_for_yes; then
return 1
fi
return 0
}
-# Initialize $_autoenv_sourced_varstash, but do not overwrite an existing one
-# from e.g. `exec zsh` (to reload your shell config).
-: ${_autoenv_sourced_varstash:=0}
-
# Get directory of this file (absolute, with resolved symlinks).
-_autoenv_this_dir=${0:A:h}
+_autoenv_source_dir=${0:A:h}
_autoenv_source() {
local env_file=$1
- _autoenv_event=$2
- _autoenv_envfile_dir=$3
- _autoenv_from_dir=$_autoenv_chpwd_prev_dir
- _autoenv_to_dir=$PWD
+ autoenv_event=$2
+ local _autoenv_envfile_dir=${3:-${1:A:h}}
+
+ autoenv_from_dir=$_autoenv_chpwd_prev_dir
+ autoenv_to_dir=$PWD
# Source varstash library once.
- if [[ $_autoenv_sourced_varstash == 0 ]]; then
- source $_autoenv_this_dir/lib/varstash
- export _autoenv_sourced_varstash=1
+ if [[ -z "$functions[(I)autostash]" ]]; then
+ source $_autoenv_source_dir/lib/varstash
# NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
# ${env_file:h}.
fi
# Change to directory of env file, source it and cd back.
local new_dir=$PWD
builtin cd -q $_autoenv_envfile_dir
+ _autoenv_debug "== SOURCE: ${bold_color:-}$env_file${reset_color:-}\n PWD: $PWD"
+ (( _autoenv_debug_indent++ ))
source $env_file
+ (( _autoenv_debug_indent-- ))
+ _autoenv_debug "== END SOURCE =="
builtin cd -q $new_dir
- unset _autoenv_event _autoenv_from_dir
+ # Unset vars set for enter/leave scripts.
+ # This should not get done for recursion (via autoenv_source_parent),
+ # and can be useful to have in general after autoenv was used.
+ # unset autoenv_event autoenv_from_dir autoenv_to_dir
+}
+
+_autoenv_get_file_upwards() {
+ local look_from=${1:-$PWD}
+ local look_for=${2:-$AUTOENV_FILE_ENTER}
+
+ # Manually look in parent dirs. An extended Zsh glob should use Y1 for
+ # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
+ local last
+ local parent_dir="$look_from/.."
+ while true; do
+ parent_dir=${parent_dir:A}
+ if [[ $parent_dir == $last ]]; then
+ break
+ fi
+ parent_file="${parent_dir}/${look_for}"
+
+ if [[ -f $parent_file ]]; then
+ echo $parent_file
+ break
+ fi
+
+ last=$parent_dir
+ parent_dir="${parent_dir}/.."
+ done
}
+
_autoenv_chpwd_prev_dir=$PWD
_autoenv_chpwd_handler() {
local env_file="$PWD/$AUTOENV_FILE_ENTER"
+ _autoenv_debug "Calling chpwd handler: PWD=$PWD"
+
# Handle leave event for previously sourced env files.
if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
- for prev_dir in ${_autoenv_stack_entered}; do
- if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
+ local prev_file prev_dir
+ for prev_file in ${_autoenv_stack_entered}; do
+ prev_dir=${prev_file:A:h}
+ if ! [[ ${PWD:A}/ == ${prev_dir}/* ]]; then
local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
if _autoenv_check_authorized_env_file $env_file_leave; then
_autoenv_source $env_file_leave leave $prev_dir
fi
- # Remove this entry from the stack.
- _autoenv_stack_entered=(${_autoenv_stack_entered#$prev_dir})
+
+ # Unstash any autostashed stuff.
+ varstash_dir=$prev_dir autounstash
+
+ _autoenv_stack_entered_remove $prev_file
fi
done
fi
if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
- # Look for files in parent dirs, using an extended Zsh glob.
- setopt localoptions extendedglob
- local m
- m=((../)#${AUTOENV_FILE_ENTER}(N))
- if (( $#m )); then
- env_file=${${m[1]}:A}
- else
+ env_file=$(_autoenv_get_file_upwards $PWD)
+ if [[ -z $env_file ]]; then
_autoenv_chpwd_prev_dir=$PWD
return
fi
fi
- if ! _autoenv_check_authorized_env_file $env_file; then
+ # Load the env file only once: check if $env_file is in the stack of entered
+ # directories.
+ if _autoenv_stack_entered_contains $env_file; then
+ _autoenv_debug "Already in stack: $env_file"
_autoenv_chpwd_prev_dir=$PWD
return
fi
- # Load the env file only once: check if $env_file's parent
- # is in $_autoenv_stack_entered.
- local env_file_dir=${env_file:A:h}
- if (( ${+_autoenv_stack_entered[(r)${env_file_dir}]} )); then
+ if ! _autoenv_check_authorized_env_file $env_file; then
_autoenv_chpwd_prev_dir=$PWD
return
fi
- _autoenv_stack_entered+=(${env_file_dir})
+ _autoenv_stack_entered_add $env_file
- _autoenv_source $env_file enter $PWD
+ # Source the enter env file.
+ _autoenv_debug "Sourcing from chpwd handler: $env_file"
+ _autoenv_source $env_file enter
_autoenv_chpwd_prev_dir=$PWD
+
+ (( _autoenv_debug_indent++ ))
}
+# }}}
autoload -U add-zsh-hook
add-zsh-hook chpwd _autoenv_chpwd_handler