# Initially based on
# https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
-export AUTOENV_ENV_FILENAME=$HOME/.env_auth
-[ -e $AUTOENV_ENV_FILENAME ] || touch $AUTOENV_ENV_FILENAME
+# File to store confirmed authentication into.
+# This handles the deprecated, old location(s).
+if [[ -z $AUTOENV_AUTH_FILE ]]; then
+ if [[ -n $AUTOENV_ENV_FILENAME ]]; then
+ echo "zsh-autoenv: using deprecated setting for AUTOENV_AUTH_FILE from AUTOENV_ENV_FILENAME." >&2
+ echo "Please set AUTOENV_AUTH_FILE instead." >&2
+ AUTOENV_AUTH_FILE=$AUTOENV_ENV_FILENAME
+ else
+ if [[ -n $XDG_DATA_HOME ]]; then
+ AUTOENV_AUTH_FILE=$XDG_DATA_HOME/autoenv_auth
+ else
+ AUTOENV_AUTH_FILE=~/.local/share/autoenv_auth
+ fi
+ if [[ -f ~/.env_auth ]]; then
+ echo "zsh-autoenv: using deprecated location for AUTOENV_AUTH_FILE." >&2
+ echo "Please move it: mv ~/.env_auth ${(D)AUTOENV_AUTH_FILE}." >&2
+ AUTOENV_AUTH_FILE=~/.env_auth
+ fi
+ fi
+fi
-# Name of file to look for when entering directories.
-: ${AUTOENV_FILE_ENTER:=.env}
+# Name of the file to look for when entering directories.
+: ${AUTOENV_FILE_ENTER:=.autoenv.zsh}
-# Name of file to look for when leaving directories.
+# Name of the file to look for when leaving directories.
# Requires AUTOENV_HANDLE_LEAVE=1.
-: ${AUTOENV_FILE_LEAVE:=.env.leave}
+: ${AUTOENV_FILE_LEAVE:=.autoenv_leave.zsh}
-# Look for .env in parent dirs?
+# Look for zsh-autoenv "enter" files in parent dirs?
: ${AUTOENV_LOOK_UPWARDS:=1}
# Handle leave events when changing away from a subtree, where an "enter"
# (Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler.
: ${AUTOENV_DISABLED:=0}
-# Public helper functions, which can be used from your .env files:
+# Public helper functions, which can be used from your .autoenv.zsh 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.
+# Source the next .autoenv.zsh file from parent directories.
+# This is useful if you want to use a base .autoenv.zsh file for a directory
+# subtree.
autoenv_source_parent() {
- local parent_env_file=$(_autoenv_get_file_upwards ${autoenv_env_file:h})
+ local look_until=${1:-/}
+ local parent_env_file=$(_autoenv_get_file_upwards \
+ ${autoenv_env_file:h} ${AUTOENV_FILE_ENTER} $look_until)
if [[ -n $parent_env_file ]] \
&& _autoenv_check_authorized_env_file $parent_env_file; then
# Internal function for debug output. {{{
_autoenv_debug() {
- local msg=$1
+ local msg="$1" # Might trigger a bug in Zsh 5.0.5 with shwordsplit.
local level=${2:-1}
if [[ $AUTOENV_DEBUG -lt $level ]]; then
return
# Generate hash pair for a given file ($1).
# A fixed hash value can be given as 2nd arg, but is used with tests only.
+# The format is ":$file:$hash:$version".
_autoenv_hash_pair() {
local env_file=${1:A}
local env_shasum=${2:-}
_autoenv_authorized_env_file() {
local env_file=$1
- local pair=$(_autoenv_hash_pair $env_file)
- test -f $AUTOENV_ENV_FILENAME \
- && \grep -qF $pair $AUTOENV_ENV_FILENAME
+ local pair="$(_autoenv_hash_pair $env_file)"
+ test -f $AUTOENV_AUTH_FILE \
+ && \grep -qF $pair $AUTOENV_AUTH_FILE
}
_autoenv_authorize() {
local env_file=${1:A}
_autoenv_deauthorize $env_file
- _autoenv_hash_pair $env_file >>| $AUTOENV_ENV_FILENAME
+ _autoenv_hash_pair $env_file >>| $AUTOENV_AUTH_FILE
}
# Deauthorize a given filename, by removing it from the auth file.
# allow for writing to the same file again.
_autoenv_deauthorize() {
local env_file=${1:A}
- if [[ -s $AUTOENV_ENV_FILENAME ]]; then
- echo "$(\grep -vF :${env_file}: $AUTOENV_ENV_FILENAME)" >| $AUTOENV_ENV_FILENAME
+ if [[ -s $AUTOENV_AUTH_FILE ]]; then
+ echo "$(\grep -vF :${env_file}: $AUTOENV_AUTH_FILE)" >| $AUTOENV_AUTH_FILE
fi
}
# This function can be mocked in tests
_autoenv_ask_for_yes() {
local answer
+
+ # Handle/catch Ctrl-C and return, instead of letting it potentially abort the
+ # shell setup process.
+ setopt localtraps
+ trap 'return 1' INT
+
read answer
if [[ $answer == "yes" ]]; then
return 0
return 1
fi
if ! _autoenv_authorized_env_file $1; then
- echo "Attempting to load unauthorized env file!"
- command ls -l $1
- echo ""
- echo "**********************************************"
- echo ""
- cat $1
- echo ""
- echo "**********************************************"
- echo ""
- echo -n "Would you like to authorize it? (type 'yes') "
+ echo "Attempting to load unauthorized env file!" >&2
+ command ls -l $1 >&2
+ echo >&2
+ echo "**********************************************" >&2
+ echo >&2
+ command cat $1 >&2
+ echo >&2
+ echo "**********************************************" >&2
+ echo >&2
+ echo -n "Would you like to authorize it? (type 'yes') " >&2
+ # echo "Would you like to authorize it?"
+ # echo "('yes' to allow, 'no' to not being asked again; otherwise ignore it for the shell) "
if ! _autoenv_ask_for_yes; then
return 1
return 0
}
-# Get directory of this file (absolute, with resolved symlinks).
-_autoenv_source_dir=${0:A:h}
-
_autoenv_source() {
- local env_file=$1
- autoenv_event=$2
- local _autoenv_envfile_dir=${3:-${1:A:h}}
-
- autoenv_from_dir=$_autoenv_chpwd_prev_dir
- autoenv_to_dir=$PWD
- autoenv_env_file=$env_file
+ # Public API for the .autoenv.zsh script.
+ local autoenv_env_file=$1
+ local autoenv_event=$2
+ local autoenv_from_dir=$OLDPWD
+ local autoenv_to_dir=$PWD
# Source varstash library once.
+ # XXX: pollutes environment with e.g. `stash`, and `autostash` will cause
+ # an overwritten `stash` function to be called!
if [[ -z "$functions[(I)autostash]" ]]; then
- source $_autoenv_source_dir/lib/varstash
+ if \grep -qE '\b(autostash|autounstash|stash)\b' $autoenv_env_file; then
+ source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
+ fi
# NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
- # ${env_file:h}.
+ # ${autoenv_env_file:h}.
fi
# Source the env file.
- _autoenv_debug "== SOURCE: ${bold_color:-}$env_file${reset_color:-}\n PWD: $PWD"
+ _autoenv_debug "== SOURCE: ${bold_color:-}$autoenv_env_file${reset_color:-}\n PWD: $PWD"
: $(( _autoenv_debug_indent++ ))
- source $env_file
+ source $autoenv_env_file
: $(( _autoenv_debug_indent-- ))
_autoenv_debug "== END SOURCE =="
if [[ $autoenv_event == enter ]]; then
- _autoenv_stack_entered_add $env_file
+ _autoenv_stack_entered_add $autoenv_env_file
fi
-
- # 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_env_file
}
_autoenv_get_file_upwards() {
local look_from=${1:-$PWD}
local look_for=${2:-$AUTOENV_FILE_ENTER}
+ local look_until=${${3:-/}:A}
# 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.
if [[ $parent_dir == $last ]]; then
break
fi
- parent_file="${parent_dir}/${look_for}"
+ local parent_file="${parent_dir}/${look_for}"
if [[ -f $parent_file ]]; then
echo $parent_file
break
fi
+ if [[ $parent_dir == $look_until ]]; then
+ break
+ fi
last=$parent_dir
parent_dir="${parent_dir}/.."
done
}
-_autoenv_chpwd_prev_dir=$PWD
_autoenv_chpwd_handler() {
_autoenv_debug "Calling chpwd handler: PWD=$PWD"
fi
# Unstash any autostashed stuff.
- varstash_dir=$prev_dir autounstash
+ if [[ -n "$functions[(I)autostash]" ]]; then
+ varstash_dir=$prev_dir autounstash
+ fi
_autoenv_stack_entered_remove $prev_file
fi
if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
env_file=$(_autoenv_get_file_upwards $PWD)
if [[ -z $env_file ]]; then
- _autoenv_chpwd_prev_dir=$PWD
return
fi
fi
# directories.
if _autoenv_stack_entered_contains $env_file; then
_autoenv_debug "Already in stack: $env_file"
- _autoenv_chpwd_prev_dir=$PWD
return
fi
if ! _autoenv_check_authorized_env_file $env_file; then
- _autoenv_chpwd_prev_dir=$PWD
return
fi
_autoenv_debug "Sourcing from chpwd handler: $env_file"
_autoenv_source $env_file enter
- _autoenv_chpwd_prev_dir=$PWD
-
: $(( _autoenv_debug_indent++ ))
}
# }}}