reenabled ssh function

[feisty_meow.git] / scripts / core / functions.sh

diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh
index 1fe45e6c4d84cc2e8ea3ae242fcbf4ab5359d0d4..7240866c1f8bd1c8c4bf0d511b8c796640549009 100644 (file)
--- a/scripts/core/functions.sh
+++ b/scripts/core/functions.sh
@@ -2,12 +2,16 @@
 
 # This defines some general, useful functions.
 
+#hmmm: starting to get a bit beefy in here.  perhaps there is a good way to refactor the functions into more specific folders, if they aren't really totally general purpose?
+
+##############
+
 # test whether we've been here before or not.
 skip_all=
 type function_sentinel &>/dev/null
 if [ $? -eq 0 ]; then
   # there was no error, so we can skip the inits.
-  if [ ! -z "$SHELL_DEBUG" ]; then
+  if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
     echo "skipping function definitions, because already defined."
   fi
   skip_all=yes
@@ -17,7 +21,7 @@ fi
 
 if [ -z "$skip_all" ]; then
 
-  if [ ! -z "$SHELL_DEBUG" ]; then
+  if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
     echo "feisty meow function definitions beginning now..."
   fi
 
@@ -80,6 +84,15 @@ if [ -z "$skip_all" ]; then
     IFS="$HOLDIFS"
   }
 
+  # when passed a list of things, this will return the unique items from that list as an echo.
+  function uniquify()
+  {
+    # do the uniquification: split the space separated items into separate lines, then
+    # sort the list, then run the uniq tool on the list.  results will be packed back onto
+    # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
+    echo $* | tr ' ' '\n' | sort | uniq
+  }
+
   # sets the variable in parameter 1 to the value in parameter 2, but only if
   # that variable was undefined.
   function set_var_if_undefined()
@@ -117,6 +130,19 @@ if [ -z "$skip_all" ]; then
     fi
   }
 
+  # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
+  function ssh()
+  {
+    local args=($*)
+    save_terminal_title
+    # we remember the old terminal title, then force the TERM variable to a more generic
+    # version for the other side (just 'linux'); we don't want the remote side still
+    # thinking it's running xterm.
+    export TERM=linux
+    /usr/bin/ssh -X -C "${args[@]}"
+    restore_terminal_title
+  }
+
   # locates a process given a search pattern to match in the process list.
   # supports a single command line flag style parameter of "-u USERNAME";
   # if the -u flag is found, a username is expected afterwards, and only the
@@ -338,7 +364,7 @@ if [ -z "$skip_all" ]; then
 #    fi
   }
   
-  # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
+  # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
   # this kind of assumes you've already checked them for any salient facts.
   function clean_cvs_junk() {
     for i in $*; do
@@ -632,26 +658,6 @@ alias "${@}"
 return 0
   }
 
-  # defines a variable within the feisty meow environment and remembers that
-  # this is a new or modified definition.  if the feisty meow codebase is
-  # unloaded, then so are all the variables that were defined.
-  # this function always exports the variables it defines.
-#  function define_yeti_variable()
-#  {
-## if variable exists already, save old value for restore,
-## otherwise save null value for restore,
-## have to handle unsetting if there was no prior value of one
-## we newly defined.
-## add variable name to a list of feisty defined variables.
-#
-##hmmm: first implem just sets it up and exports the variable.
-##  i.e., this method always exports.
-#export "${@}" 
-#
-#
-#return 0
-#  }
-
   ##############
 
 #hmmm: this points to an extended functions file being needed; not all of these are core.
@@ -689,12 +695,47 @@ return 0
 
   ##############
 
+  # count the number of sub-directories in a directory and echo the result.
+  function count_directories()
+  {
+    local appsdir="$1"; shift
+    numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
+    echo $numdirs
+  }
+
+  # takes a string and capitalizes just the first character.  any capital letters in the remainder of
+  # the string are made lower case.  the processed string is returned by an echo.
+  function capitalize_first_char()
+  {
+    local to_dromedary="$1"; shift
+    to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
+    echo "$to_dromedary"
+  }
+
+  # given a source path and a target path, this will make a symbolic link from
+  # the source to the destination, but only if the source actually exists.
+  function make_safe_link()
+  {
+    local src="$1"; shift
+    local target="$1"; shift
+  
+    if [ -d "$src" ]; then
+      ln -s "$src" "$target"
+      check_result "Creating symlink from '$src' to '$target'"
+    fi
+    echo "Created symlink from '$src' to '$target'."
+  }
+
+  ##############
+
+  # NOTE: no more function definitions are allowed after this point.
+
   function function_sentinel()
   {
     return 0; 
   }
   
-  if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
+  if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
 
   ##############