2 # https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
4 # File to store confirmed authentication into.
5 : ${AUTOENV_ENV_FILENAME:=~/.env_auth}
7 # Name of the file to look for when entering directories.
8 : ${AUTOENV_FILE_ENTER:=.env}
10 # Name of the file to look for when leaving directories.
11 # Requires AUTOENV_HANDLE_LEAVE=1.
12 : ${AUTOENV_FILE_LEAVE:=.env_leave}
14 # Look for .env files 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 # (Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler.
25 : ${AUTOENV_DISABLED:=0}
27 # Public helper functions, which can be used from your .env files:
29 # Source the next .env file from parent directories.
30 # This is useful if you want to use a base .env file for a directory subtree.
31 autoenv_source_parent() {
32 local parent_env_file=$(_autoenv_get_file_upwards ${autoenv_env_file:h})
34 if [[ -n $parent_env_file ]] \
35 && _autoenv_check_authorized_env_file $parent_env_file; then
36 _autoenv_debug "Calling autoenv_source_parent: parent_env_file:$parent_env_file"
37 _autoenv_source $parent_env_file enter
41 # Internal functions. {{{
42 # Internal: stack of entered (and handled) directories. {{{
43 typeset -g -a _autoenv_stack_entered
44 # -g: make it global, this is required when used with antigen.
45 typeset -g -A _autoenv_stack_entered_mtime
47 # Add an entry to the stack, and remember its mtime.
48 _autoenv_stack_entered_add() {
51 # Remove any existing entry.
52 _autoenv_stack_entered_remove $env_file
54 _autoenv_debug "[stack] adding: $env_file" 2
56 # Append it to the stack, and remember its mtime.
57 _autoenv_stack_entered+=($env_file)
58 _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
62 # zstat_mime helper, conditionally defined.
63 # Load zstat module, but only its builtin `zstat`.
64 if ! zmodload -F zsh/stat b:zstat 2>/dev/null; then
65 # If the module is not available, define a wrapper around `stat`, and use its
66 # terse output instead of format, which is not supported by busybox.
67 # Assume '+mtime' as $1.
68 _autoenv_get_file_mtime() {
69 # setopt localoptions pipefail
71 stat=$(stat -t $1 2>/dev/null)
72 if [[ -n $stat ]]; then
73 echo ${${(s: :)stat}[13]}
79 _autoenv_get_file_mtime() {
80 zstat +mtime $1 2>/dev/null || echo 0
85 # Remove an entry from the stack.
86 _autoenv_stack_entered_remove() {
88 _autoenv_debug "[stack] removing: $env_file" 2
89 _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
90 _autoenv_stack_entered_mtime[$env_file]=
93 # Is the given entry already in the stack?
94 # This checks for the env_file ($1) as-is and with symlinks resolved.
95 _autoenv_stack_entered_contains() {
98 if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
102 for i in $_autoenv_stack_entered; do
103 if [[ ${i:A} == ${env_file:A} ]]; then
104 # Entry is in stack (compared with resolved symlinks).
111 if [[ $_autoenv_stack_entered_mtime[$f] == $(_autoenv_get_file_mtime $f) ]]; then
112 # Entry has the expected mtime.
120 # Internal function for debug output. {{{
124 if [[ $AUTOENV_DEBUG -lt $level ]]; then
127 # Load zsh color support.
128 if [[ -z $color ]]; then
132 # Build $indent prefix.
134 if [[ $_autoenv_debug_indent -gt 0 ]]; then
135 for i in {1..${_autoenv_debug_indent}}; do
140 # Split $msg by \n (not newline).
141 lines=(${(ps:\\n:)msg})
142 for line in $lines; do
143 echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
144 echo ${indent}${line} >&2
150 # Generate hash pair for a given file ($1).
151 # A fixed hash value can be given as 2nd arg, but is used with tests only.
152 # The format is ":$file:$hash:$version".
153 _autoenv_hash_pair() {
154 local env_file=${1:A}
155 local env_shasum=${2:-}
156 if [[ -z $env_shasum ]]; then
157 if ! [[ -e $env_file ]]; then
158 echo "Missing file argument for _autoenv_hash_pair!" >&2
161 env_shasum=$(shasum $env_file | cut -d' ' -f1)
163 echo ":${env_file}:${env_shasum}:1"
166 _autoenv_authorized_env_file() {
168 local pair=$(_autoenv_hash_pair $env_file)
169 test -f $AUTOENV_ENV_FILENAME \
170 && \grep -qF $pair $AUTOENV_ENV_FILENAME
173 _autoenv_authorize() {
174 local env_file=${1:A}
175 _autoenv_deauthorize $env_file
176 _autoenv_hash_pair $env_file >>| $AUTOENV_ENV_FILENAME
179 # Deauthorize a given filename, by removing it from the auth file.
180 # This uses `test -s` to only handle non-empty files, and a subshell to
181 # allow for writing to the same file again.
182 _autoenv_deauthorize() {
183 local env_file=${1:A}
184 if [[ -s $AUTOENV_ENV_FILENAME ]]; then
185 echo "$(\grep -vF :${env_file}: $AUTOENV_ENV_FILENAME)" >| $AUTOENV_ENV_FILENAME
189 # This function can be mocked in tests
190 _autoenv_ask_for_yes() {
193 if [[ $answer == "yes" ]]; then
200 # Args: 1: absolute path to env file (resolved symlinks).
201 _autoenv_check_authorized_env_file() {
202 if ! [[ -f $1 ]]; then
205 if ! _autoenv_authorized_env_file $1; then
206 echo "Attempting to load unauthorized env file!"
209 echo "**********************************************"
213 echo "**********************************************"
215 echo -n "Would you like to authorize it? (type 'yes') "
217 if ! _autoenv_ask_for_yes; then
221 _autoenv_authorize $1
226 # Get directory of this file (absolute, with resolved symlinks).
227 _autoenv_source_dir=${0:A:h}
232 local _autoenv_envfile_dir=${3:-${1:A:h}}
234 autoenv_from_dir=$_autoenv_chpwd_prev_dir
236 autoenv_env_file=$env_file
238 # Source varstash library once.
239 if [[ -z "$functions[(I)autostash]" ]]; then
240 source $_autoenv_source_dir/lib/varstash
241 # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
245 # Source the env file.
246 _autoenv_debug "== SOURCE: ${bold_color:-}$env_file${reset_color:-}\n PWD: $PWD"
247 : $(( _autoenv_debug_indent++ ))
249 : $(( _autoenv_debug_indent-- ))
250 _autoenv_debug "== END SOURCE =="
252 if [[ $autoenv_event == enter ]]; then
253 _autoenv_stack_entered_add $env_file
256 # Unset vars set for enter/leave scripts.
257 # This should not get done for recursion (via autoenv_source_parent),
258 # and can be useful to have in general after autoenv was used.
259 # unset autoenv_event autoenv_from_dir autoenv_to_dir autoenv_env_file
260 if [[ $autoenv_event == leave ]]; then
261 unset autoenv_env_file
265 _autoenv_get_file_upwards() {
266 local look_from=${1:-$PWD}
267 local look_for=${2:-$AUTOENV_FILE_ENTER}
269 # Manually look in parent dirs. An extended Zsh glob should use Y1 for
270 # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
272 local parent_dir="$look_from/.."
274 parent_dir=${parent_dir:A}
275 if [[ $parent_dir == $last ]]; then
278 parent_file="${parent_dir}/${look_for}"
280 if [[ -f $parent_file ]]; then
286 parent_dir="${parent_dir}/.."
291 _autoenv_chpwd_prev_dir=$PWD
292 _autoenv_chpwd_handler() {
293 _autoenv_debug "Calling chpwd handler: PWD=$PWD"
295 if (( $AUTOENV_DISABLED )); then
296 _autoenv_debug "Disabled (AUTOENV_DISABLED)."
300 local env_file="$PWD/$AUTOENV_FILE_ENTER"
301 _autoenv_debug "env_file: $env_file"
303 # Handle leave event for previously sourced env files.
304 if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
305 local prev_file prev_dir
306 for prev_file in ${_autoenv_stack_entered}; do
307 prev_dir=${prev_file:h}
308 if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
309 local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
310 if _autoenv_check_authorized_env_file $env_file_leave; then
311 _autoenv_source $env_file_leave leave $prev_dir
314 # Unstash any autostashed stuff.
315 varstash_dir=$prev_dir autounstash
317 _autoenv_stack_entered_remove $prev_file
322 if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
323 env_file=$(_autoenv_get_file_upwards $PWD)
324 if [[ -z $env_file ]]; then
325 _autoenv_chpwd_prev_dir=$PWD
330 # Load the env file only once: check if $env_file is in the stack of entered
332 if _autoenv_stack_entered_contains $env_file; then
333 _autoenv_debug "Already in stack: $env_file"
334 _autoenv_chpwd_prev_dir=$PWD
338 if ! _autoenv_check_authorized_env_file $env_file; then
339 _autoenv_chpwd_prev_dir=$PWD
343 # Source the enter env file.
344 _autoenv_debug "Sourcing from chpwd handler: $env_file"
345 _autoenv_source $env_file enter
347 _autoenv_chpwd_prev_dir=$PWD
349 : $(( _autoenv_debug_indent++ ))
353 autoload -U add-zsh-hook
354 add-zsh-hook chpwd _autoenv_chpwd_handler
356 # Look in current directory already.
357 _autoenv_chpwd_handler