2 # https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
4 export AUTOENV_ENV_FILENAME=$HOME/.env_auth
5 [ -e $AUTOENV_ENV_FILENAME ] || touch $AUTOENV_ENV_FILENAME
7 # Name of file to look for when entering directories.
8 : ${AUTOENV_FILE_ENTER:=.env}
10 # Name of file to look for when leaving directories.
11 # Requires AUTOENV_HANDLE_LEAVE=1.
12 : ${AUTOENV_FILE_LEAVE:=.env.leave}
14 # Look for .env in parent dirs?
15 : ${AUTOENV_LOOK_UPWARDS:=1}
17 # Handle leave events when changing away from a subtree, where an "enter"
19 : ${AUTOENV_HANDLE_LEAVE:=1}
21 # Enable debugging. Multiple levels are supported (max 2).
24 # Public helper functions, which can be used from your .env files:
26 # Source the next .env file from parent directories.
27 # This is useful if you want to use a base .env file for a directory subtree.
28 autoenv_source_parent() {
29 local parent_env_file=$(_autoenv_get_file_upwards $PWD)
31 if [[ -n $parent_env_file ]] \
32 && _autoenv_check_authorized_env_file $parent_env_file; then
33 _autoenv_debug "Calling autoenv_source_parent: parent_env_file:$parent_env_file"
34 _autoenv_source $parent_env_file enter
38 # Internal functions. {{{
39 # Internal: stack of entered (and handled) directories. {{{
40 typeset -g -a _autoenv_stack_entered
41 _autoenv_stack_entered=()
42 # -g: make it global, this is required when used with antigen.
43 typeset -g -A _autoenv_stack_entered_mtime
44 _autoenv_stack_entered_mtime=()
46 # Add an entry to the stack, and remember its mtime.
47 _autoenv_stack_entered_add() {
50 # Remove any existing entry.
51 _autoenv_stack_entered_remove $env_file
53 _autoenv_debug "[stack] adding: $env_file" 2
55 # Append it to the stack, and remember its mtime.
56 _autoenv_stack_entered+=($env_file)
57 _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
60 _autoenv_get_file_mtime() {
68 # Remove an entry from the stack.
69 _autoenv_stack_entered_remove() {
71 _autoenv_debug "[stack] removing: $env_file" 2
72 _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
73 _autoenv_stack_entered_mtime[$env_file]=
76 # Is the given entry already in the stack?
77 _autoenv_stack_entered_contains() {
79 if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
81 if [[ $_autoenv_stack_entered_mtime[$env_file] == $(_autoenv_get_file_mtime $env_file) ]]; then
82 # Entry has the expected mtime.
90 # Internal function for debug output. {{{
94 if [[ $AUTOENV_DEBUG -lt $level ]]; then
97 # Load zsh color support.
98 if [[ -z $color ]]; then
102 # Build $indent prefix.
104 if [[ $_autoenv_debug_indent -gt 0 ]]; then
105 for i in {1..${_autoenv_debug_indent}}; do
110 # Split $msg by \n (not newline).
111 lines=(${(ps:\\n:)msg})
112 for line in $lines; do
113 echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
114 echo ${indent}${line} >&2
119 # Load zstat module, but only its builtin `zstat`.
120 if ! zmodload -F zsh/stat b:zstat 2>/dev/null; then
121 # If the module is not available, define a wrapper around `stat`, and use its
122 # terse output instead of format, which is not supported by busybox.
123 # Assume '+mtime' as $1.
125 stat -t $2 | cut -f13 -d ' '
130 # Generate hash pair for a given file ($1).
131 # A fixed hash value can be given as 2nd arg, but is used with tests only.
132 _autoenv_hash_pair() {
133 local env_file=${1:A}
134 local env_shasum=${2:-}
135 if [[ -z $env_shasum ]]; then
136 if ! [[ -e $env_file ]]; then
137 echo "Missing file argument for _autoenv_hash_pair!" >&2
140 env_shasum=$(shasum $env_file | cut -d' ' -f1)
142 echo ":${env_file}:${env_shasum}:1"
145 _autoenv_authorized_env_file() {
147 local pair=$(_autoenv_hash_pair $env_file)
148 test -f $AUTOENV_ENV_FILENAME \
149 && \grep -qF $pair $AUTOENV_ENV_FILENAME
152 _autoenv_authorize() {
153 local env_file=${1:A}
154 _autoenv_deauthorize $env_file
155 _autoenv_hash_pair $env_file >>| $AUTOENV_ENV_FILENAME
158 # Deauthorize a given filename, by removing it from the auth file.
159 # This uses `test -s` to only handle non-empty files, and a subshell to
160 # allow for writing to the same file again.
161 _autoenv_deauthorize() {
162 local env_file=${1:A}
163 if [[ -s $AUTOENV_ENV_FILENAME ]]; then
164 echo "$(\grep -vF :${env_file}: $AUTOENV_ENV_FILENAME)" >| $AUTOENV_ENV_FILENAME
168 # This function can be mocked in tests
169 _autoenv_ask_for_yes() {
172 if [[ $answer == "yes" ]]; then
179 # Args: 1: absolute path to env file (resolved symlinks).
180 _autoenv_check_authorized_env_file() {
181 if ! [[ -f $1 ]]; then
184 if ! _autoenv_authorized_env_file $1; then
185 echo "Attempting to load unauthorized env file!"
188 echo "**********************************************"
192 echo "**********************************************"
194 echo -n "Would you like to authorize it? (type 'yes') "
196 if ! _autoenv_ask_for_yes; then
200 _autoenv_authorize $1
205 # Get directory of this file (absolute, with resolved symlinks).
206 _autoenv_source_dir=${0:A:h}
211 local _autoenv_envfile_dir=${3:-${1:A:h}}
213 autoenv_from_dir=$_autoenv_chpwd_prev_dir
215 autoenv_env_file=$env_file
217 # Source varstash library once.
218 if [[ -z "$functions[(I)autostash]" ]]; then
219 source $_autoenv_source_dir/lib/varstash
220 # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
224 # Change to directory of env file, source it and cd back.
226 builtin cd -q $_autoenv_envfile_dir
227 _autoenv_debug "== SOURCE: ${bold_color:-}$env_file${reset_color:-}\n PWD: $PWD"
228 (( _autoenv_debug_indent++ ))
230 (( _autoenv_debug_indent-- ))
231 _autoenv_debug "== END SOURCE =="
232 builtin cd -q $new_dir
234 if [[ $autoenv_event == enter ]]; then
235 _autoenv_stack_entered_add $env_file
238 # Unset vars set for enter/leave scripts.
239 # This should not get done for recursion (via autoenv_source_parent),
240 # and can be useful to have in general after autoenv was used.
241 # unset autoenv_event autoenv_from_dir autoenv_to_dir autoenv_env_file
244 _autoenv_get_file_upwards() {
245 local look_from=${1:-$PWD}
246 local look_for=${2:-$AUTOENV_FILE_ENTER}
248 # Manually look in parent dirs. An extended Zsh glob should use Y1 for
249 # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
251 local parent_dir="$look_from/.."
253 parent_dir=${parent_dir:A}
254 if [[ $parent_dir == $last ]]; then
257 parent_file="${parent_dir}/${look_for}"
259 if [[ -f $parent_file ]]; then
265 parent_dir="${parent_dir}/.."
270 _autoenv_chpwd_prev_dir=$PWD
271 _autoenv_chpwd_handler() {
272 local env_file="$PWD/$AUTOENV_FILE_ENTER"
274 _autoenv_debug "Calling chpwd handler: PWD=$PWD"
276 # Handle leave event for previously sourced env files.
277 if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
278 local prev_file prev_dir
279 for prev_file in ${_autoenv_stack_entered}; do
280 prev_dir=${prev_file:A:h}
281 if ! [[ ${PWD:A}/ == ${prev_dir}/* ]]; then
282 local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
283 if _autoenv_check_authorized_env_file $env_file_leave; then
284 _autoenv_source $env_file_leave leave $prev_dir
287 # Unstash any autostashed stuff.
288 varstash_dir=$prev_dir autounstash
290 _autoenv_stack_entered_remove $prev_file
295 if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
296 env_file=$(_autoenv_get_file_upwards $PWD)
297 if [[ -z $env_file ]]; then
298 _autoenv_chpwd_prev_dir=$PWD
303 # Load the env file only once: check if $env_file is in the stack of entered
305 if _autoenv_stack_entered_contains $env_file; then
306 _autoenv_debug "Already in stack: $env_file"
307 _autoenv_chpwd_prev_dir=$PWD
311 if ! _autoenv_check_authorized_env_file $env_file; then
312 _autoenv_chpwd_prev_dir=$PWD
316 # Source the enter env file.
317 _autoenv_debug "Sourcing from chpwd handler: $env_file"
318 _autoenv_source $env_file enter
320 _autoenv_chpwd_prev_dir=$PWD
322 (( _autoenv_debug_indent++ ))
326 autoload -U add-zsh-hook
327 add-zsh-hook chpwd _autoenv_chpwd_handler
329 # Look in current directory already.
330 _autoenv_chpwd_handler