]> Sergey Matveev's repositories - zsh-autoenv.git/blobdiff - autoenv.zsh
Improve debug logging in _autoenv_chpwd_handler (#57)
[zsh-autoenv.git] / autoenv.zsh
index 7b6d8da04038632136792d4924f933915e1ea603..b64b6c7cc06985e324bc5fb146f08ede8b28c851 100644 (file)
@@ -16,7 +16,7 @@ if [[ -z $AUTOENV_AUTH_FILE ]]; then
     fi
     if [[ -f ~/.env_auth ]]; then
       echo "zsh-autoenv: using deprecated location for AUTOENV_AUTH_FILE." >&2
-      echo "Please move it: mv ~/.env_auth ${(D)AUTOENV_AUTH_FILE}." >&2
+      echo "Please move it: mv ~/.env_auth ${(D)AUTOENV_AUTH_FILE}" >&2
       AUTOENV_AUTH_FILE=~/.env_auth
     fi
   fi
@@ -43,7 +43,7 @@ fi
 : ${AUTOENV_DISABLED:=0}
 
 # Public helper functions, which can be used from your .autoenv.zsh files:
-#
+
 # Source the next .autoenv.zsh file from parent directories.
 # This is useful if you want to use a base .autoenv.zsh file for a directory
 # subtree.
@@ -60,7 +60,7 @@ autoenv_source_parent() {
 }
 
 # Internal functions. {{{
-# Internal: stack of entered (and handled) directories. {{{
+# Internal: stack of loaded env files (i.e. entered directories). {{{
 typeset -g -a _autoenv_stack_entered
 # -g: make it global, this is required when used with antigen.
 typeset -g -A _autoenv_stack_entered_mtime
@@ -168,48 +168,84 @@ _autoenv_debug() {
 # }}}
 
 
-# Generate hash pair for a given file ($1).
-# A fixed hash value can be given as 2nd arg, but is used with tests only.
+# Generate hash pair for a given file ($1) and version ($2).
+# A fixed hash value can be given as 3rd arg, but is used with tests only.
 # The format is ":$file:$hash:$version".
 _autoenv_hash_pair() {
   local env_file=${1:A}
-  local env_shasum=${2:-}
-  if [[ -z $env_shasum ]]; then
+  local cksum_version=${2:-2}
+  local env_cksum=${3:-}
+  if [[ -z $env_cksum ]]; then
     if ! [[ -e $env_file ]]; then
       echo "Missing file argument for _autoenv_hash_pair!" >&2
       return 1
     fi
-    env_shasum=$(shasum $env_file | cut -d' ' -f1)
+    if [ $cksum_version = 2 ]; then
+      # Get the output from `cksum` and join the first two words with a dot.
+      env_cksum=${(j:.:)${:-$(cksum "$env_file")}[1,2]}
+    elif [ $cksum_version = 1 ]; then
+      env_cksum=$(shasum $env_file | cut -d' ' -f1)
+    else
+      echo "Invalid version argument (${cksum_version}) for _autoenv_hash_pair!" >&2
+      return 1
+    fi
   fi
-  echo ":${env_file}:${env_shasum}:1"
+  echo ":${env_file}:${env_cksum}:${cksum_version}"
 }
 
-_autoenv_authorized_env_file() {
-  local env_file=$1
-  local pair=$(_autoenv_hash_pair $env_file)
+
+# Checks for the existence of a hash signature in the auth file
+_autoenv_authorized_pair() {
+  local pair=$1
   test -f $AUTOENV_AUTH_FILE \
     && \grep -qF $pair $AUTOENV_AUTH_FILE
 }
 
+
+_autoenv_authorized_env_file() {
+  local env_file=$1
+  local pair
+  pair=$(_autoenv_hash_pair $env_file)
+  _autoenv_debug "v2 pair: ${pair}"
+  if ! _autoenv_authorized_pair $pair; then
+    # Fallback for v1 (SHA-1) pairs
+    pair=$(_autoenv_hash_pair $env_file 1)
+    _autoenv_debug "v1 pair: ${pair}"
+    if _autoenv_authorized_pair $pair; then
+      # Upgrade v1 entries to v2
+      _autoenv_authorize $env_file
+    else
+      return 1
+    fi
+  fi
+}
+
 _autoenv_authorize() {
   local env_file=${1:A}
   _autoenv_deauthorize $env_file
+  [[ -d ${AUTOENV_AUTH_FILE:h} ]] || mkdir -p ${AUTOENV_AUTH_FILE:h}
   _autoenv_hash_pair $env_file >>| $AUTOENV_AUTH_FILE
 }
 
 # Deauthorize a given filename, by removing it from the auth file.
-# This uses `test -s` to only handle non-empty files, and a subshell to
-# allow for writing to the same file again.
+# This uses `test -s` to only handle non-empty files.
 _autoenv_deauthorize() {
   local env_file=${1:A}
   if [[ -s $AUTOENV_AUTH_FILE ]]; then
-    echo "$(\grep -vF :${env_file}: $AUTOENV_AUTH_FILE)" >| $AUTOENV_AUTH_FILE
+    \grep -vF :${env_file}: $AUTOENV_AUTH_FILE >| $AUTOENV_AUTH_FILE.tmp
+    \mv $AUTOENV_AUTH_FILE.tmp $AUTOENV_AUTH_FILE
   fi
 }
 
 # This function can be mocked in tests
 _autoenv_ask_for_yes() {
   local answer
+
+  # Handle/catch Ctrl-C and return, instead of letting it potentially abort the
+  # shell setup process.
+  setopt localtraps
+  trap 'return 1' INT
+
   read answer
   if [[ $answer == "yes" ]]; then
     return 0
@@ -254,8 +290,12 @@ _autoenv_source() {
   local autoenv_to_dir=$PWD
 
   # Source varstash library once.
-  if [[ -z "$functions[(I)autostash]" ]]; then
-    source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
+  # XXX: pollutes environment with e.g. `stash`, and `autostash` will cause
+  # an overwritten `stash` function to be called!
+  if ! (( $+functions[autostash] )); then
+    if \grep -qE '\b(autostash|autounstash|stash)\b' $autoenv_env_file; then
+      source ${${funcsourcetrace[1]%:*}:h}/lib/varstash
+    fi
     # NOTE: Varstash uses $PWD as default for varstash_dir, we might set it to
     # ${autoenv_env_file:h}.
   fi
@@ -263,7 +303,16 @@ _autoenv_source() {
   # Source the env file.
   _autoenv_debug "== SOURCE: ${bold_color:-}$autoenv_env_file${reset_color:-}\n      PWD: $PWD"
   : $(( _autoenv_debug_indent++ ))
+
+  local restore_xtrace
+  if [[ $AUTOENV_DEBUG -gt 2 && ! -o xtrace ]]; then
+    restore_xtrace=1
+    setopt localoptions xtrace
+  fi
   source $autoenv_env_file
+  if (( restore_xtrace )); then
+    setopt noxtrace
+  fi
   : $(( _autoenv_debug_indent-- ))
   _autoenv_debug "== END SOURCE =="
 
@@ -281,19 +330,24 @@ _autoenv_get_file_upwards() {
   # performance reasons, which is only available in zsh-5.0.5-146-g9381bb6.
   local last
   local parent_dir="$look_from/.."
+  local abs_parent_dir
   while true; do
-    parent_dir=${parent_dir:A}
-    if [[ $parent_dir == $last ]]; then
+    abs_parent_dir=${parent_dir:A}
+    if [[ $abs_parent_dir == $last ]]; then
       break
     fi
-    parent_file="${parent_dir}/${look_for}"
+    local parent_file="${parent_dir}/${look_for}"
 
     if [[ -f $parent_file ]]; then
-      echo $parent_file
+      if [[ ${parent_file[1,2]} == './' ]]; then
+        echo ${parent_file#./}
+      else
+        echo ${parent_file:A}
+      fi
       break
     fi
 
-    if [[ $parent_dir == $look_until ]]; then
+    if [[ $abs_parent_dir == $look_until ]]; then
       break
     fi
     last=$parent_dir
@@ -301,6 +355,37 @@ _autoenv_get_file_upwards() {
   done
 }
 
+autoenv-edit() {
+  local env_file
+  local -a files
+  local -A check
+  check[enter]=$AUTOENV_FILE_ENTER
+  if [[ "$AUTOENV_FILE_ENTER" != "$AUTOENV_FILE_LEAVE" ]]; then
+    check[leave]=$AUTOENV_FILE_LEAVE
+  fi
+  local f t
+  for t f in ${(kv)check}; do
+    env_file="$f"
+    if ! [[ -f $env_file ]]; then
+      env_file=$(_autoenv_get_file_upwards . $f)
+      if [[ -z $env_file ]]; then
+        echo "No $f file found ($t)." >&2
+        continue
+      fi
+      if ! [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
+        echo "Note: found $env_file, but AUTOENV_LOOK_UPWARDS is disabled."
+      fi
+    fi
+    files+=($env_file)
+  done
+  if [[ -z "$files" ]]; then
+    return 1
+  fi
+  echo "Editing $files.."
+  local editor
+  editor="${${AUTOENV_EDITOR:-$EDITOR}:-vim}"
+  eval $editor "$files"
+}
 
 _autoenv_chpwd_handler() {
   _autoenv_debug "Calling chpwd handler: PWD=$PWD"
@@ -311,7 +396,7 @@ _autoenv_chpwd_handler() {
   fi
 
   local env_file="$PWD/$AUTOENV_FILE_ENTER"
-  _autoenv_debug "env_file: $env_file"
+  _autoenv_debug "looking for env_file: $env_file"
 
   # Handle leave event for previously sourced env files.
   if [[ $AUTOENV_HANDLE_LEAVE == 1 ]] && (( $#_autoenv_stack_entered )); then
@@ -325,7 +410,9 @@ _autoenv_chpwd_handler() {
         fi
 
         # Unstash any autostashed stuff.
-        varstash_dir=$prev_dir autounstash
+        if (( $+functions[autostash] )); then
+          varstash_dir=$prev_dir autounstash
+        fi
 
         _autoenv_stack_entered_remove $prev_file
       fi
@@ -335,8 +422,10 @@ _autoenv_chpwd_handler() {
   if ! [[ -f $env_file ]] && [[ $AUTOENV_LOOK_UPWARDS == 1 ]]; then
     env_file=$(_autoenv_get_file_upwards $PWD)
     if [[ -z $env_file ]]; then
+      _autoenv_debug "No env_file found when looking upwards"
       return
     fi
+    _autoenv_debug "Found env_file: $env_file"
   fi
 
   # Load the env file only once: check if $env_file is in the stack of entered