dropping probably useless step
[feisty_meow.git] / scripts / rev_control / version_control.sh
index 01ca3c56ea15f4df5d25c0cd3836304d5215ee85..f3f433d3eebd837eef27362e80cb98cf6460294b 100644 (file)
@@ -3,6 +3,9 @@
 # these are helper functions for doing localized revision control.
 # this script should be sourced into other scripts that use it.
 
+# Author: Chris Koeritz
+# Author: Kevin Wentworth
+
 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
 source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
 
@@ -11,13 +14,20 @@ 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...
+# use our splitter tool for lengthy output if it's available.
+if [ ! -z "$(which splitter)" ]; then
+  TO_SPLITTER="$(which splitter)"
+else
+  TO_SPLITTER=cat
+fi
+
+##############
+
 # 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 GFFS testing, so that blows.
 # to get past this, TMP gets changed below to a hopefully generic and safe place.
-
 if [[ "$TMP" =~ .:.* ]]; then
-  echo making weirdo temporary directory for DOS path.
+  echo "making weirdo temporary directory for PCDOS-style path."
   export TMP=/tmp/rev_control_$USER
 fi
 if [ ! -d "$TMP" ]; then
@@ -28,92 +38,9 @@ if [ ! -d "$TMP" ]; then
   echo "this script will not work properly without an existing TMP directory."
 fi
 
-this_host=
-# gets the machine's hostname and stores it in the variable "this_host".
-function get_our_hostname()
-{
-  if [ "$OS" == "Windows_NT" ]; then
-    this_host=$(hostname)
-  elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
-    this_host=$(hostname)
-  elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
-    this_host=$(hostname --long)
-  else
-    this_host=$(hostname)
-  fi
-  #echo "hostname is $this_host"
-}
-
-# 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.
-function is_home_system()
-{
-  # load up the name of the host.
-  get_our_hostname
-  # reset the variable that we'll be setting.
-  unset home_system
-  export home_system
-  if [[ $this_host == *.gruntose.blurgh ]]; then
-    home_system=true
-  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()
-{
-  if [ "$USER" == "fred" ]; then
-    export SVNUSER=fred_t_hamster@
-    export EXTRA_PROTOCOL=+ssh
-  else
-    export SVNUSER=
-    export EXTRA_PROTOCOL=
-  fi
-}
-
-# calculates the right modifier for hostnames / repositories.
-modifier=
-function compute_modifier()
-{
-  modifier=
-  directory="$1"; shift
-  in_or_out="$1"; shift
-  check_user
-  # some project specific overrides.
-  if [[ "$directory" == hoople* ]]; then
-    modifier="svn${EXTRA_PROTOCOL}://${SVNUSER}svn.code.sf.net/p/hoople2/svn/"
-  fi
-  if [[ "$directory" == yeti* ]]; then
-    modifier="svn${EXTRA_PROTOCOL}://${SVNUSER}svn.code.sf.net/p/yeti/svn/"
-  fi
-  # see if we're on one of fred's home machines.
-  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.
-      modifier=
-    else 
-      # no modifier for checkin.
-      modifier=
-    fi
-  fi
-}
-
 ##############
 
-# selects the method for check-in based on where we are.
+# checks the directory provided into the revision control system repository it belongs to.
 function do_checkin()
 {
   local directory="$1"; shift
@@ -127,11 +54,8 @@ function do_checkin()
   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."
+  test_or_die "repository update--this should be fixed before check-in."
 
   pushd "$directory" &>/dev/null
   if [ -f ".no-checkin" ]; then
@@ -140,52 +64,52 @@ function do_checkin()
     if test_writeable "CVS"; then
       $blatt
       cvs ci .
-      retval=$?
+      test_or_die "cvs checkin"
     fi
   elif [ -d ".svn" ]; then
     if test_writeable ".svn"; then
       $blatt
       svn ci .
-      retval=$?
+      test_or_die "svn checkin"
     fi
   elif [ -d ".git" ]; then
     if test_writeable ".git"; then
       $blatt
-      # snag all new files.  not to everyone's liking.
+
+      # put all changed and new files in the commit.  not to everyone's liking.
       git add --all .
-      retval=$?
-echo A: retval=$retval
+      test_or_die "git add all new files"
 
       # see if there are any changes in the local repository.
       if ! git diff-index --quiet HEAD --; then
         # tell git about all the files and get a check-in comment.
         git commit .
-        retval+=$?
-echo B.1: retval=$retval
+        test_or_die "git commit"
       fi
-      # catch if the diff-index failed somehow.
-      retval+=$?
-echo B.2: retval=$retval
+
+      # a new set of steps we have to take to make sure the branch integrity is good.
+      careful_git_update 
+
+      # we continue on to the push, even if there were no changes this time, because
+      # there could already be committed changes that haven't been pushed yet.
 
       # upload any changes to the upstream repo so others can see them.
-      git push 2>&1 
-#| grep -v "X11 forwarding request failed"
-#have to do pipestatus if want to keep the above.
-      retval+=$?
-echo C: retval=$retval
+      git push origin "$(my_branch_name)" 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
+      test_or_die "git push"
+
     fi
   else
     # nothing there.  it's not an error though.
     echo no repository in $directory
-    retval=0
   fi
   popd &>/dev/null
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
+# shows the local changes in a repository.
 function do_diff
 {
   local directory="$1"; shift
@@ -193,27 +117,27 @@ function do_diff
   save_terminal_title
 
   pushd "$directory" &>/dev/null
-  local retval=0  # normally successful.
 
   # only update if we see a repository living there.
   if [ -d ".svn" ]; then
     svn diff .
-    retval+=$?
+    test_or_die "subversion diff"
   elif [ -d ".git" ]; then
     git diff 
-    retval+=$?
+    test_or_die "git diff"
   elif [ -d "CVS" ]; then
     cvs diff .
-    retval+=$?
+    test_or_die "cvs diff"
   fi
 
   popd &>/dev/null
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
+# reports any files that are not already known to the upstream repository.
 function do_report_new
 {
   local directory="$1"; shift
@@ -221,7 +145,6 @@ function do_report_new
   save_terminal_title
 
   pushd "$directory" &>/dev/null
-  local retval=0  # normally successful.
 
   # only update if we see a repository living there.
   if [ -f ".no-checkin" ]; then
@@ -229,17 +152,17 @@ function do_report_new
   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=$?
+    test_or_die "svn diff"
   elif [ -d ".git" ]; then
     git status -u
-    retval=$?
+    test_or_die "git status -u"
   fi
 
   popd &>/dev/null
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # checks in all the folders in a specified list.
@@ -261,7 +184,7 @@ function checkin_list()
       # 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"
+      test_or_die "running check-in (absolute) on path: $outer"
       sep 28
     else
       for inner in $list; do
@@ -269,7 +192,7 @@ function checkin_list()
         local path="$inner/$outer"
         if [ ! -d "$path" ]; then continue; fi
         do_checkin $path
-        test_or_die "running check-in on: $path"
+        test_or_die "running check-in (relative) on path: $path"
         sep 28
       done
     fi
@@ -296,7 +219,95 @@ function squash_first_few_crs()
   fi
 }
 
-# selects the checkout method based on where we are (the host the script runs on).
+# a helpful method that reports the git branch for the current directory's
+# git repository.
+function my_branch_name()
+{
+  echo "$(git branch | grep '\*' | cut -d ' ' -f2)"
+}
+
+#this had a -> in it at one point for not matching, didn't it?
+# this reports the upstream branch for the current repo.
+##function parent_branch_name()
+##{
+  ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
+##}
+
+# this exits with 0 for success (normal bash behavior) when up to date.  if the branch is not up to date,
+# then these values are returned:
+#DOCUMENT THE VALUES
+# reference: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
+function check_branch_state()
+{
+  local branch="$1"; shift
+
+  local to_return=120  # unknown issue.
+
+sep
+
+  LOCAL=$(git rev-parse @)
+  REMOTE=$(git rev-parse "$branch")
+  BASE=$(git merge-base @ "$branch")
+var branch LOCAL REMOTE BASE
+
+  if [ "$LOCAL" == "$REMOTE" ]; then
+    echo "Up-to-date"
+    to_return=0
+  elif [ "$LOCAL" == "$BASE" ]; then
+    echo "Need to pull"
+    to_return=1
+  elif [ "$REMOTE" == "$BASE" ]; then
+    echo "Need to push"
+    to_return=2
+  else
+    echo "Diverged"
+    to_return=3
+  fi
+
+sep
+
+  return $to_return
+}
+
+# the git update process just gets more and more complex when you bring in
+# branches, so we've moved this here to avoid having a ton of code in the
+# other methods.
+function careful_git_update()
+{
+  local this_branch="$(my_branch_name)"
+
+#appears to be useless; reports no changes when we need to know about remote changes that do exist:
+#  check_branch_state "$this_branch"
+#  state=$?
+#  test_or_continue "branch state check"
+#  echo the branch state is $state
+
+  # the above are just not enough.  this code is now doing what i have to do when i repair the repo.
+  local branch_list=$(git branch |grep -v '^\*')
+  local bran
+  for bran in $branch_list; do
+#    echo "synchronizing remote branch: $bran"
+    git checkout "$bran"
+    test_or_die "git checking out remote branch: $bran"
+    git pull --no-ff
+    test_or_die "git pull of remote branch: $bran"
+  done
+  # now switch back to our branch.
+  git checkout "$this_branch"
+  test_or_die "git checking out our current branch: $this_branch"
+
+#this step didn't help before, and it seems redundant now.
+#  # first update all our remote branches to their current state from the repos.
+#  git remote update
+#  test_or_die "git remote update"
+
+  # now pull down any changes in our own origin in the repo, to stay in synch
+  # with any changes from others.
+  git pull --no-ff --all
+  test_or_die "git pulling all upstream"
+}
+
+# gets the latest versions of the assets from the upstream repository.
 function do_update()
 {
   directory="$1"; shift
@@ -310,25 +321,25 @@ function do_update()
   fi
   local blatt="echo retrieving '$nicedir'..."
 
-  local retval=0  # plan on success for now.
   pushd "$directory" &>/dev/null
   if [ -d "CVS" ]; then
     if test_writeable "CVS"; then
       $blatt
-      cvs update . | squash_first_few_crs
-      retval=${PIPESTATUS[0]}
+      cvs update . | $TO_SPLITTER
+      test_or_die "cvs update"
     fi
   elif [ -d ".svn" ]; then
     if test_writeable ".svn"; then
       $blatt
-      svn update . | squash_first_few_crs
-      retval=${PIPESTATUS[0]}
+      svn update . | $TO_SPLITTER
+      test_or_die "svn update"
     fi
   elif [ -d ".git" ]; then
     if test_writeable ".git"; then
       $blatt
-      git pull 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
-      retval=${PIPESTATUS[0]}
+      git pull --no-ff 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
+      if [ ${PIPESTATUS[0]} -ne 0 ]; then false; fi
+      test_or_die "git pull of origin without fast forwards"
     fi
   else
     # this is not an error necessarily; we'll just pretend they planned this.
@@ -338,7 +349,7 @@ function do_update()
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # gets all the updates for a list of folders under revision control.
@@ -411,8 +422,14 @@ function perform_revctrl_action_on_file()
 
   save_terminal_title
 
+  local did_anything=
+
   while read -u 3 dirname; do
-    if [ -z "$dirname" ]; then continue; fi
+    if [ -z "$dirname" ]; then
+      # we often have blank lines in the input file for some reason.
+      continue
+    fi
+    did_anything=yes
     pushd "$dirname" &>/dev/null
     echo "[$(pwd)]"
     $action .
@@ -421,9 +438,12 @@ function perform_revctrl_action_on_file()
     popd &>/dev/null
   done 3<"$tempfile"
 
+  if [ -z "$did_anything" ]; then
+    echo "There was nothing to do the action '$action' on."
+  fi
+
   restore_terminal_title
 
   rm $tempfile
 }
 
-