autoenv.zsh

   1 # Initially based on
   2 # https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
   3
   4 export AUTOENV_ENV_FILENAME=$HOME/.env_auth
   5
   6 # Name of file to look for when entering directories.
   7 : ${DOTENV_FILE_ENTER:=.env}
   8
   9 # Name of file to look for when leaving directories.
  10 # Requires DOTENV_HANDLE_LEAVE=1.
  11 : ${DOTENV_FILE_LEAVE:=.env.leave}
  12
  13 # Look for .env in parent dirs?
  14 : ${DOTENV_LOOK_UPWARDS:=1}
  15
  16 # Handle leave events when changing away from a subtree, where an "enter"
  17 # event was handled?
  18 : ${DOTENV_HANDLE_LEAVE:=1}
  19
  20
  21 # Internal: stack of entered (and handled) directories.
  22 _dotenv_stack_entered=()
  23
  24
  25 _dotenv_hash_pair() {
  26   local env_file=$1
  27   if (( $+2 )); then
  28     env_shasum=$2
  29   else
  30     env_shasum=$(shasum $env_file | cut -d' ' -f1)
  31   fi
  32   echo "$env_file:$env_shasum:1"
  33 }
  34
  35 _dotenv_authorized_env_file() {
  36   local env_file=$1
  37   local pair=$(_dotenv_hash_pair $env_file)
  38   test -f $AUTOENV_ENV_FILENAME \
  39     && \grep -qF $pair $AUTOENV_ENV_FILENAME
  40 }
  41
  42 _dotenv_authorize() {
  43   local env_file=$1
  44   _dotenv_deauthorize $env_file
  45   _dotenv_hash_pair $env_file >> $AUTOENV_ENV_FILENAME
  46 }
  47
  48 _dotenv_deauthorize() {
  49   local env_file=$1
  50   if [[ -f $AUTOENV_ENV_FILENAME ]]; then
  51     echo $(\grep -vF $env_file $AUTOENV_ENV_FILENAME) > $AUTOENV_ENV_FILENAME
  52   fi
  53 }
  54
  55 # This function can be mocked in tests
  56 _dotenv_read_answer() {
  57   local answer
  58   read $=_AUTOENV_TEST_READ_ARGS -q answer
  59   echo $answer
  60 }
  61
  62 # Args: 1: absolute path to env file (resolved symlinks).
  63 _dotenv_check_authorized_env_file() {
  64   if ! [[ -f $1 ]]; then
  65     return 1
  66   fi
  67   if ! _dotenv_authorized_env_file $1; then
  68     echo "Attempting to load unauthorized env file: $1"
  69     echo ""
  70     echo "**********************************************"
  71     echo ""
  72     cat $1
  73     echo ""
  74     echo "**********************************************"
  75     echo ""
  76     echo -n "Would you like to authorize it? [y/N] "
  77
  78     local answer=$(_dotenv_read_answer)
  79     echo
  80     if [[ $answer != 'y' ]]; then
  81       return 1
  82     fi
  83
  84     _dotenv_authorize $1
  85   fi
  86   return 0
  87 }
  88
  89 # Initialize $_dotenv_sourced_varstash, but do not overwrite an existing one
  90 # from e.g. `exec zsh` (to reload your shell config).
  91 : ${_dotenv_sourced_varstash:=0}
  92
  93 # Get directory of this file (absolute, with resolved symlinks).
  94 _dotenv_this_dir=${0:A:h}
  95
  96 _dotenv_source() {
  97   local env_file=$1
  98   _dotenv_event=$2
  99   _dotenv_cwd=$3
 100
 101   # Source varstash library once.
 102   if [[ $_dotenv_sourced_varstash == 0 ]]; then
 103     source $_dotenv_this_dir/lib/varstash
 104     export _dotenv_sourced_varstash=1
 105     # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
 106     # ${env_file:h}.
 107   fi
 108
 109   # Change to directory of env file, source it and cd back.
 110   local new_dir=$PWD
 111   builtin cd -q $_dotenv_cwd
 112   source $env_file
 113   builtin cd -q $new_dir
 114
 115   unset _dotenv_event _dotenv_cwd
 116 }
 117
 118 _dotenv_chpwd_handler() {
 119   local env_file="$PWD/$DOTENV_FILE_ENTER"
 120
 121   # Handle leave event for previously sourced env files.
 122   if [[ $DOTENV_HANDLE_LEAVE == 1 ]] && (( $#_dotenv_stack_entered )); then
 123     for prev_dir in ${_dotenv_stack_entered}; do
 124       if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
 125         local env_file_leave=$prev_dir/$DOTENV_FILE_LEAVE
 126         if _dotenv_check_authorized_env_file $env_file_leave; then
 127           _dotenv_source $env_file_leave leave $prev_dir
 128         fi
 129         # Remove this entry from the stack.
 130         _dotenv_stack_entered=(${_dotenv_stack_entered#$prev_dir})
 131       fi
 132     done
 133   fi
 134
 135   if ! [[ -f $env_file ]] && [[ $DOTENV_LOOK_UPWARDS == 1 ]]; then
 136     # Look for files in parent dirs, using an extended Zsh glob.
 137     setopt localoptions extendedglob
 138     local m
 139     m=((../)#${DOTENV_FILE_ENTER}(N))
 140     if (( $#m )); then
 141       env_file=${${m[1]}:A}
 142     else
 143       return
 144     fi
 145   fi
 146
 147   if ! _dotenv_check_authorized_env_file $env_file; then
 148     return
 149   fi
 150
 151   # Load the env file only once: check if $env_file's parent
 152   # is in $_dotenv_stack_entered.
 153   local env_file_dir=${env_file:A:h}
 154   if (( ${+_dotenv_stack_entered[(r)${env_file_dir}]} )); then
 155     return
 156   fi
 157
 158   _dotenv_stack_entered+=(${env_file_dir})
 159
 160   _dotenv_source $env_file enter $PWD
 161 }
 162
 163 autoload -U add-zsh-hook
 164 add-zsh-hook chpwd _dotenv_chpwd_handler
 165
 166 # Look in current directory already.
 167 _dotenv_chpwd_handler