fixed extra quote in printout of name change.
[feisty_meow.git] / scripts / core / functions.sh
index 62e92d5b8fd543d66b0d68e5d63c743d49344aea..b068210cf244bca75b009120971e5a5a3db88478 100644 (file)
@@ -8,16 +8,17 @@ function_sentinel &>/dev/null
 if [ $? -eq 0 ]; then
   # there was no error, so we can skip the inits.
   if [ ! -z "$SHELL_DEBUG" ]; then
-    echo skipping functions.sh because already defined.
+    echo "skipping function definitions, because already defined."
   fi
   skip_all=yes
 fi
 
 if [ -z "$skip_all" ]; then
+
   if [ ! -z "$SHELL_DEBUG" ]; then
-    echo function definitions begin...
+    echo "feisty meow function definitions beginning now..."
   fi
-  
+
   # a handy little method that can be used for date strings.  it was getting
   # really tiresome how many different ways the script did the date formatting.
   function date_stringer() {
@@ -33,35 +34,63 @@ if [ -z "$skip_all" ]; then
     cd "$1"
   }
 
-  # checks the result of the last command that was run, and if it failed,
+  # displays the value of a variable in bash friendly format.
+  function var() {
+    while true; do
+      local varname="$1"; shift
+      if [ -z "$varname" ]; then
+        break
+      fi
+      if [ -z "${!varname}" ]; then
+        echo "$varname undefined"
+      else
+        echo "$varname=${!varname}"
+      fi
+    done
+  }
+
+  function success_sound()
+  {
+    if [ ! -z "$CLAM_FINISH_SOUND" ]; then
+      bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
+    fi
+  }
+
+  function error_sound()
+  {
+    if [ ! -z "$CLAM_ERROR_SOUND" ]; then
+      bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
+    fi
+  }
+
+  # checks the result of the last command that was run, and if that failed,
   # then this complains and exits from bash.  the function parameters are
   # used as the message to print as a complaint.
   function check_result()
   {
     if [ $? -ne 0 ]; then
       echo -e "failed on: $*"
+      error_sound
       exit 1
     fi
   }
 
   # locates a process given a search pattern to match in the process list.
   function psfind() {
+    local -a patterns=("${@}")
     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
-    local PIDS_SOUGHT=()
-    local patterns=($*)
+    local -a PIDS_SOUGHT
     if [ "$OS" == "Windows_NT" ]; then
       # needs to be a windows format filename for 'type' to work.
       if [ ! -d c:/tmp ]; then
         mkdir c:/tmp
       fi
-      # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not really there
-      # in the root of drive c: when we look for it later.  hoping to fix that problem by using a subdir, which
-      # also might be magical thinking from windows perspective.
+      # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not
+      # really there in the root of drive c: when we look for it later.  hoping to fix that
+      # problem by using a subdir, which also might be magical thinking from windows perspective.
       tmppid=c:\\tmp\\pids.txt
-      # we have abandoned all hope of relying on ps on windows.  instead
-      # we use wmic to get full command lines for processes.
-      # this does not exist on windows home edition.  we are hosed if that's
-      # what they insist on testing on.
+      # we have abandoned all hope of relying on ps on windows.  instead we use wmic to get full
+      # command lines for processes.
       wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
       local flag='/c'
       if [ ! -z "$(uname -a | grep "^MING" )" ]; then
@@ -70,18 +99,11 @@ if [ -z "$skip_all" ]; then
       # we 'type' the file to get rid of the unicode result from wmic.
       cmd $flag type "$tmppid" >$PID_DUMP
       \rm "$tmppid"
-      local CR='\r'  # embedded carriage return.
-      local appropriate_pattern="s/^.*  *\([0-9][0-9]*\)[ $CR]*\$/\1/p"
+      local appropriate_pattern="s/^.*  *\([0-9][0-9]*\) *\$/\1/p"
       for i in "${patterns[@]}"; do
-        PIDS_SOUGHT+=$(cat $PID_DUMP \
+        PIDS_SOUGHT+=($(cat $PID_DUMP \
           | grep -i "$i" \
-          | sed -n -e "$appropriate_pattern")
-        if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
-          # we want to bail as soon as we get matches, because on the same
-          # platform, the same set of patterns should work to find all
-          # occurrences of the genesis java.
-          break;
-        fi
+          | sed -n -e "$appropriate_pattern"))
       done
     else
       /bin/ps $extra_flags wuax >$PID_DUMP
@@ -91,19 +113,18 @@ if [ -z "$skip_all" ]; then
       # user wants to find, and just pluck the process ids out of the
       # results.
       for i in "${patterns[@]}"; do
-        PIDS_SOUGHT=$(cat $PID_DUMP \
+        PIDS_SOUGHT+=($(cat $PID_DUMP \
           | sed -e '1d' \
           | grep -i "$i" \
-          | sed -n -e "$appropriate_pattern")
-        if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
-          # we want to bail as soon as we get matches, because on the same
-          # platform, the same set of patterns should work to find all
-          # occurrences of the genesis java.
-          break;
-        fi
+          | sed -n -e "$appropriate_pattern"))
       done
     fi
-    if [ ! -z "$PIDS_SOUGHT" ]; then echo "$PIDS_SOUGHT"; fi
+    if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
+      local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
+      PIDS_SOUGHT=()
+      PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
+      echo ${PIDS_SOUGHT[*]}
+    fi
     /bin/rm $PID_DUMP
   }
   
@@ -114,13 +135,13 @@ if [ -z "$skip_all" ]; then
       echo "psa finds processes by pattern, but there was no pattern on the command line."
       return 1
     fi
-    p=$(psfind "$1")
+    p=$(psfind "${@}")
     if [ -z "$p" ]; then
       # no matches.
       return 0
     fi
     echo ""
-    echo "Processes containing \"$1\"..."
+    echo "Processes matching ${@}..."
     echo ""
     if [ -n "$IS_DARWIN" ]; then
       unset fuzil_sentinel
@@ -230,7 +251,7 @@ if [ -z "$skip_all" ]; then
   # label if they're doing an su with the sudo.
   function sudo() {
     local first_command="$1"
-    /usr/bin/sudo $*
+    /usr/bin/sudo "$@"
     if [ "$first_command" == "su" ]; then
       # yep, they were doing an su, but they're back now.
       bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
@@ -259,8 +280,20 @@ if [ -z "$skip_all" ]; then
   
   # recreates all the generated files that the feisty meow scripts use.
   function regenerate() {
+    # do the bootstrapping process again.
+    echo "regenerating feisty meow script environment."
     bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
     echo
+    # force a full reload by turning off sentinel variable and alias.
+    # the nethack one is used by fred's customizations.
+    # interesting note perhaps: found that the NETHACKOPTIONS variable was
+    # not being unset correctly when preceded by an alias.  split them up
+    # like they are now due to that bug.
+    unset -v CORE_ALIASES_LOADED FEISTY_MEOW_GENERATED NECHUNG NETHACKOPTIONS 
+    unset -f function_sentinel 
+    # reload feisty meow environment in current shell.
+    source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
+    # run nechung oracle to give user a new fortune.
     nechung
   }
 
@@ -316,18 +349,80 @@ if [ -z "$skip_all" ]; then
     echo "copying custom overrides for $user"
     mkdir "$FEISTY_MEOW_GENERATED/custom" 2>/dev/null
     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom"
+    if [ -d "$FEISTY_MEOW_DIR/customizing/$user/scripts" ]; then
+      echo "copying custom scripts for $user"
+      \cp -R "$FEISTY_MEOW_DIR/customizing/$user/scripts" "$FEISTY_MEOW_GENERATED/custom/"
+    fi
+    echo
     regenerate
   }
 
+#uhhh, this does what now?
   function add_cygwin_drive_mounts() {
     for i in c d e f g h q z ; do
       ln -s /cygdrive/$i $i
     done
   }
 
+  # takes a file to modify, and then it will replace any occurrences of the
+  # pattern provided as the second parameter with the text in the third
+  # parameter.
+  function replace_pattern_in_file()
+  {
+    local file="$1"; shift
+    local pattern="$1"; shift
+    local replacement="$1"; shift
+    if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
+      echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
+      echo "text to replace that pattern with."
+      return 1
+    fi
+    sed -i -e "s%$pattern%$replacement%g" "$file"
+  }
+
+  function spacem()
+  {
+#hmmm: could really use that pattern of 'iterate across all the arguments and do same thing' here.
+
+#hmmm: it actually seems like the below IS the pattern.  it's pretty short, but i wish it could be shorter, like a function in itself....  ah.
+# couldn't we have a functionator deal that takes:
+#  1) a command to run, and
+#  2-n) arguments,
+# where the function just blithely runs that command on all of those arguments!?
+# yes!  that does seem like the pattern being sought, much nicer than the goofy loop below,
+# although this functionator deal needs to handle when there are more than one command also,
+# or this very function couldn't be implemented...
+# maybe a two step process:
+# 1) build a list of commands to run on all arguments,
+# 2) then run through all the arguments passed in using those established commands.
+# yes again!  this seems like it would meet all the needs involved and not be too irksome.
+# for the example below, this would reduce the number of lines, i think.
+# i had better stop bloviating and write this function so i can determine the number of
+# lines omitted by the new approach.
+    while [ $# -gt 0 ]; do
+      arg="$1"; shift
+      # first we rename the file to be lower case.
+      perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$arg" &>/dev/null
+      # oops, now the name is all lower-case.  we need to make the
+      # same adjustment.
+      arg2="$(echo "$arg" | tr A-Z a-z)"
+      # we definitely wanted to adjust the case first, rather than doing all
+      # the wacky stuff this script does to the filename...  we will capture
+      # the output of the replace operaton for reporting.
+      final_name="$(perl "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg2")"
+      # now zap the intermediate part of the name off.
+      final_name="$(echo $final_name | sed -e 's/.*=> //')"
+      # printout the combined operation results.
+      echo "'$arg' => $final_name"
+    done
+#
+  }
+
+  ##############
+
   function function_sentinel() { return 0; }
   
-  if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi
+  if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
   
 fi