autoenv.zsh

   1 # Initially based on
   2 # https://github.com/joshuaclayton/dotfiles/blob/master/zsh_profile.d/autoenv.zsh
   3
   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
  11   else
  12     if [[ -n $XDG_DATA_HOME ]]; then
  13       AUTOENV_AUTH_FILE=$XDG_DATA_HOME/autoenv_auth
  14     else
  15       AUTOENV_AUTH_FILE=~/.local/share/autoenv_auth
  16     fi
  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
  21     fi
  22   fi
  23 fi
  24
  25 # Name of the file to look for when entering directories.
  26 : ${AUTOENV_FILE_ENTER:=.autoenv.zsh}
  27
  28 # Name of the file to look for when leaving directories.
  29 # Requires AUTOENV_HANDLE_LEAVE=1.
  30 : ${AUTOENV_FILE_LEAVE:=.autoenv_leave.zsh}
  31
  32 # Look for zsh-autoenv "enter" files in parent dirs?
  33 : ${AUTOENV_LOOK_UPWARDS:=1}
  34
  35 # Handle leave events when changing away from a subtree, where an "enter"
  36 # event was handled?
  37 : ${AUTOENV_HANDLE_LEAVE:=1}
  38
  39 # Enable debugging. Multiple levels are supported (max 2).
  40 : ${AUTOENV_DEBUG:=0}
  41
  42 # (Temporarily) disable zsh-autoenv. This gets looked at in the chpwd handler.
  43 : ${AUTOENV_DISABLED:=0}
  44
  45 # Public helper functions, which can be used from your .autoenv.zsh files:
  46 #
  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
  49 # subtree.
  50 autoenv_source_parent() {
  51   local look_until=${1:-/}
  52   local parent_env_file=$(_autoenv_get_file_upwards \
  53     ${autoenv_env_file:h} ${AUTOENV_FILE_ENTER} $look_until)
  54
  55   if [[ -n $parent_env_file ]] \
  56     && _autoenv_check_authorized_env_file $parent_env_file; then
  57     _autoenv_debug "Calling autoenv_source_parent: parent_env_file:$parent_env_file"
  58     _autoenv_source $parent_env_file enter
  59   fi
  60 }
  61
  62 # Internal functions. {{{
  63 # Internal: stack of entered (and handled) directories. {{{
  64 typeset -g -a _autoenv_stack_entered
  65 # -g: make it global, this is required when used with antigen.
  66 typeset -g -A _autoenv_stack_entered_mtime
  67
  68 # Add an entry to the stack, and remember its mtime.
  69 _autoenv_stack_entered_add() {
  70   local env_file=$1
  71
  72   # Remove any existing entry.
  73   _autoenv_stack_entered_remove $env_file
  74
  75   _autoenv_debug "[stack] adding: $env_file" 2
  76
  77   # Append it to the stack, and remember its mtime.
  78   _autoenv_stack_entered+=($env_file)
  79   _autoenv_stack_entered_mtime[$env_file]=$(_autoenv_get_file_mtime $env_file)
  80 }
  81
  82
  83 # zstat_mime helper, conditionally defined.
  84 # Load zstat module, but only its builtin `zstat`.
  85 if ! zmodload -F zsh/stat b:zstat 2>/dev/null; then
  86   # If the module is not available, define a wrapper around `stat`, and use its
  87   # terse output instead of format, which is not supported by busybox.
  88   # Assume '+mtime' as $1.
  89   _autoenv_get_file_mtime() {
  90     # setopt localoptions pipefail
  91     local stat
  92     stat=$(stat -t $1 2>/dev/null)
  93     if [[ -n $stat ]]; then
  94       echo ${${(s: :)stat}[13]}
  95     else
  96       echo 0
  97     fi
  98   }
  99 else
 100   _autoenv_get_file_mtime() {
 101     zstat +mtime $1 2>/dev/null || echo 0
 102   }
 103 fi
 104
 105
 106 # Remove an entry from the stack.
 107 _autoenv_stack_entered_remove() {
 108   local env_file=$1
 109   _autoenv_debug "[stack] removing: $env_file" 2
 110   _autoenv_stack_entered[$_autoenv_stack_entered[(i)$env_file]]=()
 111   _autoenv_stack_entered_mtime[$env_file]=
 112 }
 113
 114 # Is the given entry already in the stack?
 115 # This checks for the env_file ($1) as-is and with symlinks resolved.
 116 _autoenv_stack_entered_contains() {
 117   local env_file=$1
 118   local f i
 119   if (( ${+_autoenv_stack_entered[(r)${env_file}]} )); then
 120     # Entry is in stack.
 121     f=$env_file
 122   else
 123     for i in $_autoenv_stack_entered; do
 124       if [[ ${i:A} == ${env_file:A} ]]; then
 125         # Entry is in stack (compared with resolved symlinks).
 126         f=$i
 127         break
 128       fi
 129     done
 130   fi
 131   if [[ -n $f ]]; then
 132     if [[ $_autoenv_stack_entered_mtime[$f] == $(_autoenv_get_file_mtime $f) ]]; then
 133       # Entry has the expected mtime.
 134       return
 135     fi
 136   fi
 137   return 1
 138 }
 139 # }}}
 140
 141 # Internal function for debug output. {{{
 142 _autoenv_debug() {
 143   local msg="$1"  # Might trigger a bug in Zsh 5.0.5 with shwordsplit.
 144   local level=${2:-1}
 145   if [[ $AUTOENV_DEBUG -lt $level ]]; then
 146     return
 147   fi
 148   # Load zsh color support.
 149   if [[ -z $color ]]; then
 150     autoload colors
 151     colors
 152   fi
 153   # Build $indent prefix.
 154   local indent=
 155   if [[ $_autoenv_debug_indent -gt 0 ]]; then
 156     for i in {1..${_autoenv_debug_indent}}; do
 157       indent="  $indent"
 158     done
 159   fi
 160
 161   # Split $msg by \n (not newline).
 162   lines=(${(ps:\\n:)msg})
 163   for line in $lines; do
 164     echo -n "${fg_bold[blue]}[autoenv]${fg_no_bold[default]} " >&2
 165     echo ${indent}${line} >&2
 166   done
 167 }
 168 # }}}
 169
 170
 171 # Generate hash pair for a given file ($1).
 172 # A fixed hash value can be given as 2nd arg, but is used with tests only.
 173 # The format is ":$file:$hash:$version".
 174 _autoenv_hash_pair() {
 175   local env_file=${1:A}
 176   local env_cksum=${2:-}
 177   if [[ -z $env_cksum ]]; then
 178     if ! [[ -e $env_file ]]; then
 179       echo "Missing file argument for _autoenv_hash_pair!" >&2
 180       return 1
 181     fi
 182     # Get the output from `cksum` and join the first two words with a dot.
 183     env_cksum=${(j:.:)${:-$(cksum "$env_file")}[1,2]}
 184   fi
 185   echo ":${env_file}:${env_cksum}:1"
 186 }
 187
 188 _autoenv_authorized_env_file() {
 189   local env_file=$1
 190   local pair="$(_autoenv_hash_pair $env_file)"
 191   test -f $AUTOENV_AUTH_FILE \
 192     && \grep -qF $pair $AUTOENV_AUTH_FILE
 193 }
 194
 195 _autoenv_authorize() {
 196   local env_file=${1:A}
 197   _autoenv_deauthorize $env_file
 198   [[ -d ${AUTOENV_AUTH_FILE:h} ]] || mkdir -p ${AUTOENV_AUTH_FILE:h}
 199   _autoenv_hash_pair $env_file >>| $AUTOENV_AUTH_FILE
 200 }
 201
 202 # Deauthorize a given filename, by removing it from the auth file.
 203 # This uses `test -s` to only handle non-empty files, and a subshell to
 204 # allow for writing to the same file again.
 205 _autoenv_deauthorize() {
 206   local env_file=${1:A}
 207   if [[ -s $AUTOENV_AUTH_FILE ]]; then
 208     echo "$(\grep -vF :${env_file}: $AUTOENV_AUTH_FILE)" >| $AUTOENV_AUTH_FILE
 209   fi
 210 }
 211
 212 # This function can be mocked in tests
 213 _autoenv_ask_for_yes() {
 214   local answer
 215
 216   # Handle/catch Ctrl-C and return, instead of letting it potentially abort the
 217   # shell setup process.
 218   setopt localtraps
 219   trap 'return 1' INT
 220
 221   read answer
 222   if [[ $answer == "yes" ]]; then
 223     return 0
 224   else
 225     return 1
 226   fi
 227 }
 228
 229 # Args: 1: absolute path to env file (resolved symlinks).
 230 _autoenv_check_authorized_env_file() {
 231   if ! [[ -f $1 ]]; then
 232     return 1
 233   fi
 234   if ! _autoenv_authorized_env_file $1; then
 235     echo "Attempting to load unauthorized env file!" >&2
 236     command ls -l $1 >&2
 237     echo >&2
 238     echo "**********************************************" >&2
 239     echo >&2
 240     command cat $1 >&2
 241     echo >&2
 242     echo "**********************************************" >&2
 243     echo >&2
 244     echo -n "Would you like to authorize it? (type 'yes') " >&2
 245     # echo "Would you like to authorize it?"
 246     # echo "('yes' to allow, 'no' to not being asked again; otherwise ignore it for the shell) "
 247
 248     if ! _autoenv_ask_for_yes; then
 249       return 1
 250     fi
 251
 252     _autoenv_authorize $1
 253   fi
 254   return 0
 255 }
 256
 257 _autoenv_source() {
 258   # Public API for the .autoenv.zsh script.
 259   local autoenv_env_file=$1
 260   local autoenv_event=$2
 261   local autoenv_from_dir=$OLDPWD
 262   local autoenv_to_dir=$PWD
 263
 264   # Source varstash library once.
 265   # XXX: pollutes environment with e.g. `stash`, and `autostash` will cause
 266   # an overwritten `stash` function to be called!
 267   if [[ -z "$functions[(I)autostash]" ]]; then
 268     if \grep -qE '\b(autostash|autounstash|stash)\b' $autoenv_env_file; then
 269       source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
 270     fi
 271     # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
 272     # ${autoenv_env_file:h}.
 273   fi
 274
 275   # Source the env file.
 276   _autoenv_debug "== SOURCE: ${bold_color:-}$autoenv_env_file${reset_color:-}\n      PWD: $PWD"
 277   : $(( _autoenv_debug_indent++ ))
 278   source $autoenv_env_file
 279   : $(( _autoenv_debug_indent-- ))
 280   _autoenv_debug "== END SOURCE =="
 281
 282   if [[ $autoenv_event == enter ]]; then
 283     _autoenv_stack_entered_add $autoenv_env_file
 284   fi
 285 }
 286
 287 _autoenv_get_file_upwards() {
 288   local look_from=${1:-$PWD}
 289   local look_for=${2:-$AUTOENV_FILE_ENTER}
 290   local look_until=${${3:-/}:A}
 291
 292   # Manually look in parent dirs. An extended Zsh glob should use Y1 for
 293   # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
 294   local last
 295   local parent_dir="$look_from/.."
 296   while true; do
 297     parent_dir=${parent_dir:A}
 298     if [[ $parent_dir == $last ]]; then
 299       break
 300     fi
 301     local parent_file="${parent_dir}/${look_for}"
 302
 303     if [[ -f $parent_file ]]; then
 304       echo $parent_file
 305       break
 306     fi
 307
 308     if [[ $parent_dir == $look_until ]]; then
 309       break
 310     fi
 311     last=$parent_dir
 312     parent_dir="${parent_dir}/.."
 313   done
 314 }
 315
 316
 317 _autoenv_chpwd_handler() {
 318   _autoenv_debug "Calling chpwd handler: PWD=$PWD"
 319
 320   if (( $AUTOENV_DISABLED )); then
 321     _autoenv_debug "Disabled (AUTOENV_DISABLED)."
 322     return
 323   fi
 324
 325   local env_file="$PWD/$AUTOENV_FILE_ENTER"
 326   _autoenv_debug "env_file: $env_file"
 327
 328   # Handle leave event for previously sourced env files.
 329   if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
 330     local prev_file prev_dir
 331     for prev_file in ${_autoenv_stack_entered}; do
 332       prev_dir=${prev_file:h}
 333       if ! [[ ${PWD}/ == ${prev_dir}/* ]]; then
 334         local env_file_leave=$prev_dir/$AUTOENV_FILE_LEAVE
 335         if _autoenv_check_authorized_env_file $env_file_leave; then
 336           _autoenv_source $env_file_leave leave $prev_dir
 337         fi
 338
 339         # Unstash any autostashed stuff.
 340         if [[ -n "$functions[(I)autostash]" ]]; then
 341           varstash_dir=$prev_dir autounstash
 342         fi
 343
 344         _autoenv_stack_entered_remove $prev_file
 345       fi
 346     done
 347   fi
 348
 349   if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
 350     env_file=$(_autoenv_get_file_upwards $PWD)
 351     if [[ -z $env_file ]]; then
 352       return
 353     fi
 354   fi
 355
 356   # Load the env file only once: check if $env_file is in the stack of entered
 357   # directories.
 358   if _autoenv_stack_entered_contains $env_file; then
 359     _autoenv_debug "Already in stack: $env_file"
 360     return
 361   fi
 362
 363   if ! _autoenv_check_authorized_env_file $env_file; then
 364     return
 365   fi
 366
 367   # Source the enter env file.
 368   _autoenv_debug "Sourcing from chpwd handler: $env_file"
 369   _autoenv_source $env_file enter
 370
 371   : $(( _autoenv_debug_indent++ ))
 372 }
 373 # }}}
 374
 375 autoload -U add-zsh-hook
 376 add-zsh-hook chpwd _autoenv_chpwd_handler
 377
 378 # Look in current directory already.
 379 _autoenv_chpwd_handler