debugging
[feisty_meow.git] / scripts / rev_control / version_control.sh
index 86cfaeffb710e9db84524279eb88903246a5d4f7..777e51b4231b1ccd4b1ac10cd79e8188baa874f4 100644 (file)
@@ -3,8 +3,17 @@
 # these are helper functions for doing localized revision control.
 # this script should be sourced into other scripts that use it.
 
+source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
+source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
+
+##############
+
+# the maximum depth that the recursive functions will try to go below the starting directory.
+export MAX_DEPTH=5
+
+#hmmm: re-address this code, since it doesn't make a lot of sense to me right now...
 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
-# is a DOS path, but we need it to be a DOS path for our XSEDE testing, so that blows.
+# is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
 # to get past this, TMP gets changed below to a hopefully generic and safe place.
 
 if [[ "$TMP" =~ .:.* ]]; then
@@ -12,11 +21,11 @@ if [[ "$TMP" =~ .:.* ]]; then
   export TMP=/tmp/rev_control_$USER
 fi
 if [ ! -d "$TMP" ]; then
-  mkdir $TMP
+  mkdir -p $TMP
 fi
 if [ ! -d "$TMP" ]; then
-  echo "Could not create the temporary directory TMP in: $TMP"
-  echo "This script will not work properly without an existing TMP directory."
+  echo "could not create the temporary directory TMP in: $TMP"
+  echo "this script will not work properly without an existing TMP directory."
 fi
 
 this_host=
@@ -38,24 +47,28 @@ function get_our_hostname()
 # this function sets a variable called "home_system" to "true" if the
 # machine is considered one of fred's home machines.  if you are not
 # fred, you may want to change the machine choices.
-export home_system=
 function is_home_system()
 {
   # load up the name of the host.
   get_our_hostname
   # reset the variable that we'll be setting.
-  home_system=
+  unset home_system
+  export home_system
   if [[ $this_host == *.gruntose.blurgh ]]; then
     home_system=true
-#temp code
-elif [[ $this_host == buildy ]]; then
-home_system=true
-elif [[ $this_host == simmy ]]; then
-home_system=true
-#temp code
   fi
 }
 
+#hmmm: move to core.
+# makes sure that the "folder" is a directory and is writable.
+# remember that bash successful returns are zeroes...
+function test_writeable()
+{
+  local folder="$1"; shift
+  if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
+  return 0
+}
+
 # we only want to totally personalize this script if the user is right.
 function check_user()
 {
@@ -87,9 +100,9 @@ function compute_modifier()
   is_home_system
   # special override to pick local servers when at home.
   if [ "$home_system" == "true" ]; then
+#hmmm: this "home system" feature seems to be unnecessary?
     if [ "$in_or_out" == "out" ]; then
       # need the right home machine for modifier when checking out.
-#huhhh?      modifier="svn://shaggy/"
       modifier=
     else 
       # no modifier for checkin.
@@ -98,98 +111,172 @@ function compute_modifier()
   fi
 }
 
+##############
+
 # selects the method for check-in based on where we are.
 function do_checkin()
 {
   local directory="$1"; shift
+
+  save_terminal_title
+
+  # make a nice echoer since we want to use it inside conditions below.
+  local nicedir="$directory"
+  if [ $nicedir == "." ]; then
+    nicedir=$(\pwd)
+  fi
+  local blatt="echo checking in '$nicedir'..."
+
+  local retval=0  # normally successful.
+
+  do_update "$directory"
+  retval=$?
+  test_or_die "repository update failed; this should be fixed before check-in."
+
   pushd "$directory" &>/dev/null
-  retval=0  # normally successful.
-  if [ -d "CVS" ]; then
-    cvs ci .
-    retval=$?
+  if [ -f ".no-checkin" ]; then
+    echo "skipping check-in due to presence of .no-checkin sentinel file."
+  elif [ -d "CVS" ]; then
+    if test_writeable "CVS"; then
+      $blatt
+      cvs ci .
+      retval=$?
+    fi
   elif [ -d ".svn" ]; then
-    svn ci .
-    retval=$?
+    if test_writeable ".svn"; then
+      $blatt
+      svn ci .
+      retval=$?
+    fi
   elif [ -d ".git" ]; then
-    # snag all new files.  not to everyone's liking.
-    git add --all .
-    retval=$?
-    # tell git about all the files and get a check-in comment.
-    git commit .
-    retval+=$?
-    # upload the files to the server so others can see them.
-    git push 2>&1 | grep -v "X11 forwarding request failed"
-    retval+=$?
+    if test_writeable ".git"; then
+      $blatt
+      # snag all new files.  not to everyone's liking.
+      git add --all .
+      retval=$?
+echo A: retval=$retval
+      # tell git about all the files and get a check-in comment.
+      git commit .
+      retval+=$?
+echo B: retval=$retval
+      # upload the files to the server so others can see them.
+      git push 2>&1 | grep -v "X11 forwarding request failed"
+      retval+=$?
+echo C: retval=$retval
+    fi
   else
     echo no repository in $directory
     retval=1
   fi
   popd &>/dev/null
+
+  restore_terminal_title
+
   return $retval
 }
 
 function do_diff
 {
   local directory="$1"; shift
+
+  save_terminal_title
+
   pushd "$directory" &>/dev/null
-  retval=0  # normally successful.
+  local retval=0  # normally successful.
 
   # only update if we see a repository living there.
   if [ -d ".svn" ]; then
     svn diff .
+    retval+=$?
   elif [ -d ".git" ]; then
     git diff 
+    retval+=$?
   elif [ -d "CVS" ]; then
     cvs diff .
+    retval+=$?
   fi
 
   popd &>/dev/null
+
+  restore_terminal_title
+
   return $retval
 }
 
 function do_report_new
 {
   local directory="$1"; shift
+
+  save_terminal_title
+
   pushd "$directory" &>/dev/null
-  retval=0  # normally successful.
+  local retval=0  # normally successful.
 
   # only update if we see a repository living there.
-  if [ -d ".svn" ]; then
+  if [ -f ".no-checkin" ]; then
+    echo "skipping reporting due to presence of .no-checkin sentinel file."
+  elif [ -d ".svn" ]; then
     # this action so far only makes sense and is needed for svn.
     bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
+    retval=$?
+  elif [ -d ".git" ]; then
+    git status -u
+    retval=$?
   fi
 
   popd &>/dev/null
+
+  restore_terminal_title
+
   return $retval
 }
 
 # checks in all the folders in a specified list.
 function checkin_list()
 {
-  local list=$*
-  for i in $list; do
-    # turn repo list back into an array.
-    eval "repository_list=( ${REPOSITORY_LIST[*]} )"
-    for j in "${repository_list[@]}"; do
-      # add in the directory component.
-      j="$i/$j"
-      if [ ! -d "$j" ]; then continue; fi
-      echo "checking in '$j'..."
-      do_checkin $j
-    done
+  # make the list of directories unique.
+  local list="$(uniquify $*)"
+
+  save_terminal_title
+
+  # turn repo list back into an array.
+  eval "repository_list=( ${REPOSITORY_LIST[*]} )"
+
+  local outer inner
+
+  for outer in "${repository_list[@]}"; do
+    # check the repository first, since it might be an absolute path.
+    if [[ $outer =~ /.* ]]; then
+      # yep, this path is absolute.  just handle it directly.
+      if [ ! -d "$outer" ]; then continue; fi
+      do_checkin $outer
+      test_or_die "running check-in on: $outer"
+      sep 28
+    else
+      for inner in $list; do
+        # add in the directory component to see if we can find the folder.
+        local path="$inner/$outer"
+        if [ ! -d "$path" ]; then continue; fi
+        do_checkin $path
+        test_or_die "running check-in on: $path"
+        sep 28
+      done
+    fi
   done
+
+  restore_terminal_title
 }
 
 # takes out the first few carriage returns that are in the input.
 function squash_first_few_crs()
 {
   i=0
-  while read line; do
+  while read input_text; do
     i=$((i+1))
-    if [ $i -le 3 ]; then
-      echo -n "$line  "
+    if [ $i -le 5 ]; then
+      echo -n "$input_text  "
     else
-      echo $line
+      echo $input_text
     fi
   done
   if [ $i -le 3 ]; then
@@ -202,40 +289,80 @@ function squash_first_few_crs()
 function do_update()
 {
   directory="$1"; shift
+
+  save_terminal_title
+
+  # make a nice echoer since we want to use it inside conditions below.
+  local nicedir="$directory"
+  if [ $nicedir == "." ]; then
+    nicedir=$(\pwd)
+  fi
+  local blatt="echo retrieving '$nicedir'..."
+
+  local retval=0  # plan on success for now.
   pushd "$directory" &>/dev/null
   if [ -d "CVS" ]; then
-    cvs update . | squash_first_few_crs
+    if test_writeable "CVS"; then
+      $blatt
+      cvs update . | squash_first_few_crs
+      retval=${PIPESTATUS[0]}
+    fi
   elif [ -d ".svn" ]; then
-    svn update . | squash_first_few_crs
+    if test_writeable ".svn"; then
+      $blatt
+      svn update . | squash_first_few_crs
+      retval=${PIPESTATUS[0]}
+    fi
   elif [ -d ".git" ]; then
-    git pull 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
+    if test_writeable ".git"; then
+      $blatt
+      git pull 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
+      retval=${PIPESTATUS[0]}
+    fi
   else
+    # this is not an error necessarily; we'll just pretend they planned this.
     echo no repository in $directory
   fi
   popd &>/dev/null
+
+  restore_terminal_title
+
+  return $retval
 }
 
 # gets all the updates for a list of folders under revision control.
-function checkout_list {
-  list=$*
-  for i in $list; do
-    # turn repo list back into an array.
-    eval "repository_list=( ${REPOSITORY_LIST[*]} )"
-    for j in "${repository_list[@]}"; do
-      # add in the directory for our purposes here.
-      j="$i/$j"
-      if [ ! -d $j ]; then
-        if [ ! -z "$SHELL_DEBUG" ]; then
-          echo "No directory called $j exists."
-        fi
-        continue
-      fi
-
-      echo -n "retrieving '$j'...  "
-      do_update $j
-    done
+function checkout_list()
+{
+  local list="$(uniquify $*)"
+
+  save_terminal_title
+
+  # turn repo list back into an array.
+  eval "repository_list=( ${REPOSITORY_LIST[*]} )"
+
+  local outer inner
+
+  for outer in "${repository_list[@]}"; do
+    # check the repository first, since it might be an absolute path.
+    if [[ $outer =~ /.* ]]; then
+      # yep, this path is absolute.  just handle it directly.
+      if [ ! -d "$outer" ]; then continue; fi
+      do_update $outer
+      test_or_die "running update on: $path"
+      sep 28
+    else
+      for inner in $list; do
+        # add in the directory component to see if we can find the folder.
+        local path="$inner/$outer"
+        if [ ! -d "$path" ]; then continue; fi
+        do_update $path
+        test_or_die "running update on: $path"
+        sep 28
+      done
+    fi
   done
+
+  restore_terminal_title
 }
 
 # provides a list of absolute paths of revision control directories
@@ -244,14 +371,21 @@ function generate_rev_ctrl_filelist()
 {
   local dir="$1"; shift
   pushd "$dir" &>/dev/null
-  local dirhere="$(\pwd)"
-  local tempfile=$(mktemp /tmp/zz_rev_checkin.XXXXXX)
+  local dirhere="$( \cd "$(\dirname "$dir")" && /bin/pwd )"
+  local tempfile=$(mktemp /tmp/zz_checkins.XXXXXX)
   echo >$tempfile
-  find $dirhere -maxdepth 5 -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile
-  find $dirhere -maxdepth 5 -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile
+  local additional_filter
+  find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".svn" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
+  find $dirhere -follow -maxdepth $MAX_DEPTH -type d -iname ".git" -exec echo {}/.. ';' >>$tempfile 2>/dev/null
   # CVS is not well behaved like git and (now) svn, and we seldom use it anymore.
   popd &>/dev/null
-  local sortfile=$(mktemp /tmp/zz_rev_checkin_sort.XXXXXX)
+
+  # see if they've warned us not to try checking in within vendor hierarchies.
+  if [ ! -z "NO_CHECKIN_VENDOR" ]; then
+    sed -i -e '/.*\/vendor\/.*/d' "$tempfile"
+  fi
+
+  local sortfile=$(mktemp /tmp/zz_checkin_sort.XXXXXX)
   sort <"$tempfile" >"$sortfile"
   \rm "$tempfile"
   echo "$sortfile"
@@ -259,21 +393,24 @@ function generate_rev_ctrl_filelist()
 
 # iterates across a list of directories contained in a file (first parameter).
 # on each directory name, it performs the action (second parameter) provided.
-function perform_action_on_file()
+function perform_revctrl_action_on_file()
 {
   local tempfile="$1"; shift
   local action="$1"; shift
 
-  dirs=($(cat $tempfile))
+  save_terminal_title
 
-  for dirname in ${dirs[@]}; do
+  while read -u 3 dirname; do
     if [ -z "$dirname" ]; then continue; fi
-    pushd $dirname &>/dev/null
+    pushd "$dirname" &>/dev/null
     echo "[$(pwd)]"
     $action .
-    echo "======="
+    test_or_die "performing action $action on: $(pwd)"
+    sep 28
     popd &>/dev/null
-  done 
+  done 3<"$tempfile"
+
+  restore_terminal_title
 
   rm $tempfile
 }