2 # https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
4 # File to store confirmed authentication into.
5 # This handles the deprecated, old location(s).
6 if [[ -z $AUTOENV_AUTH_FILE ]]; then
7 if [[ -n $AUTOENV_ENV_FILENAME ]]; then
8 echo "zsh-autoenv: using deprecated setting for AUTOENV_AUTH_FILE from AUTOENV_ENV_FILENAME." >&2
9 echo "Please set AUTOENV_AUTH_FILE instead." >&2
10 AUTOENV_AUTH_FILE=$AUTOENV_ENV_FILENAME
12 if [[ -n $XDG_DATA_HOME ]]; then
13 AUTOENV_AUTH_FILE=$XDG_DATA_HOME/autoenv_auth
15 AUTOENV_AUTH_FILE=~/.local/share/autoenv_auth
17 if [[ -f ~/.env_auth ]]; then
18 echo "zsh-autoenv: using deprecated location for AUTOENV_AUTH_FILE." >&2
19 echo "Please move it: mv ~/.env_auth ${(D)AUTOENV_AUTH_FILE}." >&2
20 AUTOENV_AUTH_FILE=~/.env_auth
25 # Name of the file to look for when entering directories.
26 : ${AUTOENV_FILE_ENTER:=.autoenv.zsh}
28 # Name of the file to look for when leaving directories.
29 # Requires AUTOENV_HANDLE_LEAVE=1.
30 : ${AUTOENV_FILE_LEAVE:=.autoenv_leave.zsh}
32 # Look for zsh-autoenv "enter" files in parent dirs?
33 : ${AUTOENV_LOOK_UPWARDS:=1}
35 # Handle leave events when changing away from a subtree, where an "enter"
37 : ${AUTOENV_HANDLE_LEAVE:=1}
39 # Enable debugging. Multiple levels are supported (max 2).
42 # (Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler.
43 : ${AUTOENV_DISABLED:=0}
45 # Public helper functions, which can be used from your .autoenv.zsh files:
47 # Source the next .autoenv.zsh file from parent directories.
48 # This is useful if you want to use a base .autoenv.zsh file for a directory
50 autoenv_source_parent() {
51 local parent_env_file=$(_autoenv_get_file_upwards ${autoenv_env_file:h})
53 if [[ -n $parent_env_file ]] \
54 && _autoenv_check_authorized_env_file $parent_env_file; then
55 _autoenv_debug "Calling autoenv_source_parent: parent_env_file:$parent_env_file"
56 _autoenv_source $parent_env_file enter
60 # Internal functions. {{{
61 # Internal: stack of entered (and handled) directories. {{{
62 typeset -g -a _autoenv_stack_entered
63 # -g: make it global, this is required when used with antigen.
64 typeset -g -A _autoenv_stack_entered_mtime
66 # Add an entry to the stack, and remember its mtime.
67 _autoenv_stack_entered_add() {
70 # Remove any existing entry.
71 _autoenv_stack_entered_remove $env_file
73 _autoenv_debug "[stack] adding: $env_file" 2
75 # Append it to the stack, and remember its mtime.
76 _autoenv_stack_entered+=($env_file)
77 _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
81 # zstat_mime helper, conditionally defined.
82 # Load zstat module, but only its builtin `zstat`.
83 if ! zmodload -F zsh/stat b:zstat 2>/dev/null; then
84 # If the module is not available, define a wrapper around `stat`, and use its
85 # terse output instead of format, which is not supported by busybox.
86 # Assume '+mtime' as $1.
87 _autoenv_get_file_mtime() {
88 # setopt localoptions pipefail
90 stat=$(stat -t $1 2>/dev/null)
91 if [[ -n $stat ]]; then
92 echo ${${(s: :)stat}[13]}
98 _autoenv_get_file_mtime() {
99 zstat +mtime $1 2>/dev/null || echo 0
104 # Remove an entry from the stack.
105 _autoenv_stack_entered_remove() {
107 _autoenv_debug "[stack] removing: $env_file" 2
108 _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
109 _autoenv_stack_entered_mtime[$env_file]=
112 # Is the given entry already in the stack?
113 # This checks for the env_file ($1) as-is and with symlinks resolved.
114 _autoenv_stack_entered_contains() {
117 if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
121 for i in $_autoenv_stack_entered; do
122 if [[ ${i:A} == ${env_file:A} ]]; then
123 # Entry is in stack (compared with resolved symlinks).
130 if [[ $_autoenv_stack_entered_mtime[$f] == $(_autoenv_get_file_mtime $f) ]]; then
131 # Entry has the expected mtime.
139 # Internal function for debug output. {{{
143 if [[ $AUTOENV_DEBUG -lt $level ]]; then
146 # Load zsh color support.
147 if [[ -z $color ]]; then
151 # Build $indent prefix.
153 if [[ $_autoenv_debug_indent -gt 0 ]]; then
154 for i in {1..${_autoenv_debug_indent}}; do
159 # Split $msg by \n (not newline).
160 lines=(${(ps:\\n:)msg})
161 for line in $lines; do
162 echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
163 echo ${indent}${line} >&2
169 # Generate hash pair for a given file ($1).
170 # A fixed hash value can be given as 2nd arg, but is used with tests only.
171 # The format is ":$file:$hash:$version".
172 _autoenv_hash_pair() {
173 local env_file=${1:A}
174 local env_shasum=${2:-}
175 if [[ -z $env_shasum ]]; then
176 if ! [[ -e $env_file ]]; then
177 echo "Missing file argument for _autoenv_hash_pair!" >&2
180 env_shasum=$(shasum $env_file | cut -d' ' -f1)
182 echo ":${env_file}:${env_shasum}:1"
185 _autoenv_authorized_env_file() {
187 local pair=$(_autoenv_hash_pair $env_file)
188 test -f $AUTOENV_AUTH_FILE \
189 && \grep -qF $pair $AUTOENV_AUTH_FILE
192 _autoenv_authorize() {
193 local env_file=${1:A}
194 _autoenv_deauthorize $env_file
195 _autoenv_hash_pair $env_file >>| $AUTOENV_AUTH_FILE
198 # Deauthorize a given filename, by removing it from the auth file.
199 # This uses `test -s` to only handle non-empty files, and a subshell to
200 # allow for writing to the same file again.
201 _autoenv_deauthorize() {
202 local env_file=${1:A}
203 if [[ -s $AUTOENV_AUTH_FILE ]]; then
204 echo "$(\grep -vF :${env_file}: $AUTOENV_AUTH_FILE)" >| $AUTOENV_AUTH_FILE
208 # This function can be mocked in tests
209 _autoenv_ask_for_yes() {
212 if [[ $answer == "yes" ]]; then
219 # Args: 1: absolute path to env file (resolved symlinks).
220 _autoenv_check_authorized_env_file() {
221 if ! [[ -f $1 ]]; then
224 if ! _autoenv_authorized_env_file $1; then
225 echo "Attempting to load unauthorized env file!" >&2
228 echo "**********************************************" >&2
232 echo "**********************************************" >&2
234 echo -n "Would you like to authorize it? (type 'yes') " >&2
235 # echo "Would you like to authorize it?"
236 # echo "('yes' to allow, 'no' to not being asked again; otherwise ignore it for the shell) "
238 if ! _autoenv_ask_for_yes; then
242 _autoenv_authorize $1
250 local _autoenv_envfile_dir=${3:-${1:A:h}}
252 autoenv_from_dir=$OLDPWD
254 autoenv_env_file=$env_file
256 # Source varstash library once.
257 if [[ -z "$functions[(I)autostash]" ]]; then
258 source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
259 # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
263 # Source the env file.
264 _autoenv_debug "== SOURCE: ${bold_color:-}$env_file${reset_color:-}\n PWD: $PWD"
265 : $(( _autoenv_debug_indent++ ))
267 : $(( _autoenv_debug_indent-- ))
268 _autoenv_debug "== END SOURCE =="
270 if [[ $autoenv_event == enter ]]; then
271 _autoenv_stack_entered_add $env_file
274 # Unset vars set for enter/leave scripts.
275 # This should not get done for recursion (via autoenv_source_parent),
276 # and can be useful to have in general after autoenv was used.
277 # unset autoenv_event autoenv_from_dir autoenv_to_dir autoenv_env_file
278 if [[ $autoenv_event == leave ]]; then
279 unset autoenv_env_file
283 _autoenv_get_file_upwards() {
284 local look_from=${1:-$PWD}
285 local look_for=${2:-$AUTOENV_FILE_ENTER}
287 # Manually look in parent dirs. An extended Zsh glob should use Y1 for
288 # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
290 local parent_dir="$look_from/.."
292 parent_dir=${parent_dir:A}
293 if [[ $parent_dir == $last ]]; then
296 parent_file="${parent_dir}/${look_for}"
298 if [[ -f $parent_file ]]; then
304 parent_dir="${parent_dir}/.."
309 _autoenv_chpwd_handler() {
310 _autoenv_debug "Calling chpwd handler: PWD=$PWD"
312 if (( $AUTOENV_DISABLED )); then
313 _autoenv_debug "Disabled (AUTOENV_DISABLED)."
317 local env_file="$PWD/$AUTOENV_FILE_ENTER"
318 _autoenv_debug "env_file: $env_file"
320 # Handle leave event for previously sourced env files.
321 if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
322 local prev_file prev_dir
323 for prev_file in ${_autoenv_stack_entered}; do
324 prev_dir=${prev_file:h}
325 if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
326 local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
327 if _autoenv_check_authorized_env_file $env_file_leave; then
328 _autoenv_source $env_file_leave leave $prev_dir
331 # Unstash any autostashed stuff.
332 varstash_dir=$prev_dir autounstash
334 _autoenv_stack_entered_remove $prev_file
339 if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
340 env_file=$(_autoenv_get_file_upwards $PWD)
341 if [[ -z $env_file ]]; then
346 # Load the env file only once: check if $env_file is in the stack of entered
348 if _autoenv_stack_entered_contains $env_file; then
349 _autoenv_debug "Already in stack: $env_file"
353 if ! _autoenv_check_authorized_env_file $env_file; then
357 # Source the enter env file.
358 _autoenv_debug "Sourcing from chpwd handler: $env_file"
359 _autoenv_source $env_file enter
361 : $(( _autoenv_debug_indent++ ))
365 autoload -U add-zsh-hook
366 add-zsh-hook chpwd _autoenv_chpwd_handler
368 # Look in current directory already.
369 _autoenv_chpwd_handler