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 [ -e $AUTOENV_ENV_FILENAME ] || touch $AUTOENV_ENV_FILENAME
   6
   7 # Name of file to look for when entering directories.
   8 : ${AUTOENV_FILE_ENTER:=.env}
   9
  10 # Name of file to look for when leaving directories.
  11 # Requires AUTOENV_HANDLE_LEAVE=1.
  12 : ${AUTOENV_FILE_LEAVE:=.env.leave}
  13
  14 # Look for .env in parent dirs?
  15 : ${AUTOENV_LOOK_UPWARDS:=1}
  16
  17 # Handle leave events when changing away from a subtree, where an "enter"
  18 # event was handled?
  19 : ${AUTOENV_HANDLE_LEAVE:=1}
  20
  21 # Enable debugging. Multiple levels are supported (max 2).
  22 : ${AUTOENV_DEBUG:=0}
  23
  24 # Public helper functions, which can be used from your .env files:
  25 #
  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)
  30
  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
  35     local parent_env_dir=${parent_env_file:A:h}
  36
  37     _autoenv_stack_entered_add $parent_env_file
  38
  39     _autoenv_source $parent_env_file enter $parent_env_dir
  40   fi
  41 }
  42
  43 # Internal functions. {{{
  44 # Internal: stack of entered (and handled) directories. {{{
  45 typeset -g -a _autoenv_stack_entered
  46 _autoenv_stack_entered=()
  47 # -g: make it global, this is required when used with antigen.
  48 typeset -g -A _autoenv_stack_entered_mtime
  49 _autoenv_stack_entered_mtime=()
  50
  51 # Add an entry to the stack, and remember its mtime.
  52 _autoenv_stack_entered_add() {
  53   local env_file=$1
  54
  55   # Remove any existing entry.
  56   _autoenv_stack_entered_remove $env_file
  57
  58   _autoenv_debug "[stack] adding: $env_file" 2
  59
  60   # Append it to the stack, and remember its mtime.
  61   _autoenv_stack_entered+=($env_file)
  62   _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
  63 }
  64
  65 _autoenv_get_file_mtime() {
  66   if [[ -f $1 ]]; then
  67     zstat +mtime $1
  68   else
  69     echo 0
  70   fi
  71 }
  72
  73 # Remove an entry from the stack.
  74 _autoenv_stack_entered_remove() {
  75   local env_file=$1
  76   _autoenv_debug "[stack] removing: $env_file" 2
  77   _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
  78   _autoenv_stack_entered_mtime[$env_file]=
  79 }
  80
  81 # Is the given entry already in the stack?
  82 _autoenv_stack_entered_contains() {
  83   local env_file=$1
  84   if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
  85     # Entry is in stack.
  86     if [[ $_autoenv_stack_entered_mtime[$env_file] == $(_autoenv_get_file_mtime $env_file) ]]; then
  87       # Entry has the expected mtime.
  88       return
  89     fi
  90   fi
  91   return 1
  92 }
  93 # }}}
  94
  95 # Internal function for debug output. {{{
  96 _autoenv_debug() {
  97   local msg=$1
  98   local level=${2:-1}
  99   if [[ $AUTOENV_DEBUG -lt $level ]]; then
 100     return
 101   fi
 102   # Load zsh color support.
 103   if [[ -z $color ]]; then
 104     autoload colors
 105     colors
 106   fi
 107   # Build $indent prefix.
 108   local indent=
 109   if [[ $_autoenv_debug_indent -gt 0 ]]; then
 110     for i in {1..${_autoenv_debug_indent}}; do
 111       indent="  $indent"
 112     done
 113   fi
 114
 115   # Split $msg by \n (not newline).
 116   lines=(${(ps:\\n:)msg})
 117   for line in $lines; do
 118     echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
 119     echo ${indent}${line} >&2
 120   done
 121 }
 122 # }}}
 123
 124 # Load zstat module, but only its builtin `zstat`.
 125 zmodload -F zsh/stat b:zstat
 126
 127
 128 # Generate hash pair for a given file ($1).
 129 # A fixed hash value can be given as 2nd arg, but is used with tests only.
 130 _autoenv_hash_pair() {
 131   local env_file=${1:A}
 132   local env_shasum=${2:-}
 133   if [[ -z $env_shasum ]]; then
 134     if ! [[ -e $env_file ]]; then
 135       echo "Missing file argument for _autoenv_hash_pair!" >&2
 136       return 1
 137     fi
 138     env_shasum=$(shasum $env_file | cut -d' ' -f1)
 139   fi
 140   echo ":${env_file}:${env_shasum}:1"
 141 }
 142
 143 _autoenv_authorized_env_file() {
 144   local env_file=$1
 145   local pair=$(_autoenv_hash_pair $env_file)
 146   test -f $AUTOENV_ENV_FILENAME \
 147     && \grep -qF $pair $AUTOENV_ENV_FILENAME
 148 }
 149
 150 _autoenv_authorize() {
 151   local env_file=${1:A}
 152   _autoenv_deauthorize $env_file
 153   _autoenv_hash_pair $env_file >>| $AUTOENV_ENV_FILENAME
 154 }
 155
 156 # Deauthorize a given filename, by removing it from the auth file.
 157 # This uses `test -s` to only handle non-empty files, and a subshell to
 158 # allow for writing to the same file again.
 159 _autoenv_deauthorize() {
 160   local env_file=${1:A}
 161   if [[ -s $AUTOENV_ENV_FILENAME ]]; then
 162     echo "$(\grep -vF :${env_file}: $AUTOENV_ENV_FILENAME)" >| $AUTOENV_ENV_FILENAME
 163   fi
 164 }
 165
 166 # This function can be mocked in tests
 167 _autoenv_ask_for_yes() {
 168   local answer
 169   read answer
 170   if [[ $answer == "yes" ]]; then
 171     return 0
 172   else
 173     return 1
 174   fi
 175 }
 176
 177 # Args: 1: absolute path to env file (resolved symlinks).
 178 _autoenv_check_authorized_env_file() {
 179   if ! [[ -f $1 ]]; then
 180     return 1
 181   fi
 182   if ! _autoenv_authorized_env_file $1; then
 183     echo "Attempting to load unauthorized env file!"
 184     command ls -l $1
 185     echo ""
 186     echo "**********************************************"
 187     echo ""
 188     cat $1
 189     echo ""
 190     echo "**********************************************"
 191     echo ""
 192     echo -n "Would you like to authorize it? (type 'yes') "
 193
 194     if ! _autoenv_ask_for_yes; then
 195       return 1
 196     fi
 197
 198     _autoenv_authorize $1
 199   fi
 200   return 0
 201 }
 202
 203 # Get directory of this file (absolute, with resolved symlinks).
 204 _autoenv_source_dir=${0:A:h}
 205
 206 _autoenv_source() {
 207   local env_file=$1
 208   autoenv_event=$2
 209   local _autoenv_envfile_dir=${3:-${1:A:h}}
 210
 211   autoenv_from_dir=$_autoenv_chpwd_prev_dir
 212   autoenv_to_dir=$PWD
 213
 214   # Source varstash library once.
 215   if [[ -z "$functions[(I)autostash]" ]]; then
 216     source $_autoenv_source_dir/lib/varstash
 217     # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
 218     # ${env_file:h}.
 219   fi
 220
 221   # Change to directory of env file, source it and cd back.
 222   local new_dir=$PWD
 223   builtin cd -q $_autoenv_envfile_dir
 224   _autoenv_debug "== SOURCE: ${bold_color:-}$env_file${reset_color:-}\n      PWD: $PWD"
 225   (( _autoenv_debug_indent++ ))
 226   source $env_file
 227   (( _autoenv_debug_indent-- ))
 228   _autoenv_debug "== END SOURCE =="
 229   builtin cd -q $new_dir
 230
 231   # Unset vars set for enter/leave scripts.
 232   # This should not get done for recursion (via autoenv_source_parent),
 233   # and can be useful to have in general after autoenv was used.
 234   # unset autoenv_event autoenv_from_dir autoenv_to_dir
 235 }
 236
 237 _autoenv_get_file_upwards() {
 238   local look_from=${1:-$PWD}
 239   local look_for=${2:-$AUTOENV_FILE_ENTER}
 240
 241   # Manually look in parent dirs. An extended Zsh glob should use Y1 for
 242   # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
 243   local last
 244   local parent_dir="$look_from/.."
 245   while true; do
 246     parent_dir=${parent_dir:A}
 247     if [[ $parent_dir == $last ]]; then
 248       break
 249     fi
 250     parent_file="${parent_dir}/${look_for}"
 251
 252     if [[ -f $parent_file ]]; then
 253       echo $parent_file
 254       break
 255     fi
 256
 257     last=$parent_dir
 258     parent_dir="${parent_dir}/.."
 259   done
 260 }
 261
 262
 263 _autoenv_chpwd_prev_dir=$PWD
 264 _autoenv_chpwd_handler() {
 265   local env_file="$PWD/$AUTOENV_FILE_ENTER"
 266
 267   _autoenv_debug "Calling chpwd handler: PWD=$PWD"
 268
 269   # Handle leave event for previously sourced env files.
 270   if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
 271     local prev_file prev_dir
 272     for prev_file in ${_autoenv_stack_entered}; do
 273       prev_dir=${prev_file:A:h}
 274       if ! [[ ${PWD:A}/ == ${prev_dir}/* ]]; then
 275         local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
 276         if _autoenv_check_authorized_env_file $env_file_leave; then
 277           _autoenv_source $env_file_leave leave $prev_dir
 278         fi
 279
 280         # Unstash any autostashed stuff.
 281         varstash_dir=$prev_dir autounstash
 282
 283         _autoenv_stack_entered_remove $prev_file
 284       fi
 285     done
 286   fi
 287
 288   if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
 289     env_file=$(_autoenv_get_file_upwards $PWD)
 290     if [[ -z $env_file ]]; then
 291       _autoenv_chpwd_prev_dir=$PWD
 292       return
 293     fi
 294   fi
 295
 296   # Load the env file only once: check if $env_file is in the stack of entered
 297   # directories.
 298   if _autoenv_stack_entered_contains $env_file; then
 299     _autoenv_debug "Already in stack: $env_file"
 300     _autoenv_chpwd_prev_dir=$PWD
 301     return
 302   fi
 303
 304   if ! _autoenv_check_authorized_env_file $env_file; then
 305     _autoenv_chpwd_prev_dir=$PWD
 306     return
 307   fi
 308
 309   _autoenv_stack_entered_add $env_file
 310
 311   # Source the enter env file.
 312   _autoenv_debug "Sourcing from chpwd handler: $env_file"
 313   _autoenv_source $env_file enter
 314
 315   _autoenv_chpwd_prev_dir=$PWD
 316
 317   (( _autoenv_debug_indent++ ))
 318 }
 319 # }}}
 320
 321 autoload -U add-zsh-hook
 322 add-zsh-hook chpwd _autoenv_chpwd_handler
 323
 324 # Look in current directory already.
 325 _autoenv_chpwd_handler