tasty revision to load feisty for full use
[feisty_meow.git] / scripts / core / functions.sh
index d6beda886cd5326e00e268dc87d839eda5d165a6..67c58455f90ed54a6324e27db32185bc1f77981d 100644 (file)
@@ -4,13 +4,15 @@
 
 # test whether we've been here before or not.
 skip_all=
-function_sentinel &>/dev/null
+type 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 function definitions, because already defined."
   fi
   skip_all=yes
+else
+  skip_all=
 fi
 
 if [ -z "$skip_all" ]; then
@@ -74,10 +76,21 @@ if [ -z "$skip_all" ]; then
           echo "$varname=${!varname}"
         fi
       fi
-    done
+    done | sort
     IFS="$HOLDIFS"
   }
 
+  # sets the variable in parameter 1 to the value in parameter 2, but only if
+  # that variable was undefined.
+  function set_var_if_undefined()
+  {
+    local var_name="$1"; shift
+    local var_value="$1"; shift
+    if [ -z "${!var_name}" ]; then
+      eval export $var_name="$var_value"
+    fi
+  }
+
   function success_sound()
   {
     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
@@ -127,64 +140,40 @@ if [ -z "$skip_all" ]; then
 
     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
     local -a PIDS_SOUGHT
-    if [ "$OS" == "Windows_NT" ]; then
 
-#hmmm: windows isn't implementing the user flag yet!
-#try collapsing back to the ps implementation from cygwin?
-# that would simplify things a lot, if we can get it to print the right output.
+    if [ "$OS" == "Windows_NT" ]; then
+      # gets cygwin's (god awful) ps to show windoze processes also.
+      local EXTRA_DOZER_FLAGS="-W"
+      # pattern to use for peeling off the process numbers.
+      local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
 
-      # windows case has some odd gyrations to get the user list.
-      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.
-      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.
-      wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
-      local flag='/c'
-      if [ ! -z "$(uname -a | grep "^MING" )" ]; then
-        flag='//c'
-      fi
-      # we 'type' the file to get rid of the unicode result from wmic.
-      # needs to be a windows format filename for 'type' to work.
-      cmd $flag type "$tmppid" >$PID_DUMP
-      \rm "$tmppid"
-      local pid_finder_pattern='s/^.*[[:space:]][[:space:]]*\([0-9][0-9]*\) *\$/\1/p'
-      local i
-      for i in "${patterns[@]}"; do
-        PIDS_SOUGHT+=($(cat $PID_DUMP \
-          | grep -i "$i" \
-          | sed -n -e "$pid_finder_pattern"))
-      done
     else
-      /bin/ps $user_flag -o pid,args >$PID_DUMP
+      # flags which clean up the output on unixes, which apparently cygwin
+      # doesn't count as.  their crappy specialized ps doesn't support this.
+      local EXTRA_UNIX_FLAGS="-o pid,args"
+      # pattern to use for peeling off the process numbers.
+      local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
+    fi
+
+    /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
 #echo ====
 #echo got all this stuff in the pid dump file:
 #cat $PID_DUMP
 #echo ====
-      # pattern to use for peeling off the process numbers.
-      local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
-      # remove the first line of the file, search for the pattern the
-      # user wants to find, and just pluck the process ids out of the
-      # results.
-      local i
-      for i in "${patterns[@]}"; do
-#echo pattern is $i
-#echo phase 1: $(cat $PID_DUMP | sed -e '1d' )
-#echo phase 2: $(cat $PID_DUMP | sed -e '1d' | grep -i "$i" )
-        PIDS_SOUGHT+=($(cat $PID_DUMP \
-          | sed -e '1d' \
-          | grep -i "$i" \
-          | sed -n -e "$pid_finder_pattern"))
-      done
+
+    # search for the pattern the user wants to find, and just pluck the process
+    # ids out of the results.
+    local i
+    for i in "${patterns[@]}"; do
+      PIDS_SOUGHT+=($(cat $PID_DUMP \
+        | grep -i "$i" \
+        | sed -n -e "$pid_finder_pattern"))
+    done
 #echo ====
 #echo pids sought list became:
 #echo "${PIDS_SOUGHT[@]}"
 #echo ====
-    fi
+
     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
       local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
       PIDS_SOUGHT=()
@@ -233,7 +222,7 @@ if [ -z "$skip_all" ]; then
         # special case for windows.
         ps | head -1
         for curr in $p; do
-          ps -W | grep "$curr" 
+          ps -W -p $curr | tail -n +2
         done
       else
         # normal OSes can handle a nice simple query.
@@ -255,8 +244,15 @@ if [ -z "$skip_all" ]; then
     done
   }
   
-  function fix_alsa() {
-    sudo /etc/init.d/alsasound restart
+#  function fix_alsa() {
+#    sudo /etc/init.d/alsasound restart
+#  }
+
+  function screen() {
+    save_terminal_title
+#hmmm: ugly absolute path here.
+    /usr/bin/screen $*
+    restore_terminal_title
   }
   
   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
@@ -311,7 +307,7 @@ if [ -z "$skip_all" ]; then
       # information for su.
   
       # get the x authority info for our current user.
-      source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
+      source "$FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh"
   
       if [ -z "$X_auth_info" ]; then
         # if there's no authentication info to pass along, we just do a normal su.
@@ -326,20 +322,19 @@ if [ -z "$skip_all" ]; then
       # or at least suse doesn't, which is the other one we've tested on.
       /bin/su -l $*
     fi
-  
-    # relabel the console after returning.
-    bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
   }
   
   # sudo function wraps the normal sudo by ensuring we replace the terminal
   # label if they're doing an su with the sudo.
   function sudo() {
-    local first_command="$1"
+#    local first_command="$1"
+    save_terminal_title
     /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
-    fi
+    restore_terminal_title
+#    if [ "$first_command" == "su" ]; then
+#      # yep, they were doing an su, but they're back now.
+#      label_terminal_with_info
+#    fi
   }
   
   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
@@ -356,7 +351,7 @@ if [ -z "$skip_all" ]; then
     if [ -z "$wheres_nechung" ]; then
       echo "The nechung oracle program cannot be found.  You may want to consider"
       echo "rebuilding the feisty meow applications with this command:"
-      echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
+      echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
     else
       $wheres_nechung
     fi
@@ -365,20 +360,62 @@ if [ -z "$skip_all" ]; then
   # recreates all the generated files that the feisty meow scripts use.
   function regenerate() {
     # do the bootstrapping process again.
+    save_terminal_title
     echo "regenerating feisty meow script environment."
-    bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
+    bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.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_LOADING_DOCK NECHUNG NETHACKOPTIONS 
+    # force a full reload by turning off sentinel variables and methods.
+    unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
+    unalias CORE_ALIASES_LOADED &>/dev/null
     unset -f function_sentinel 
     # reload feisty meow environment in current shell.
-    source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
+    source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
     # run nechung oracle to give user a new fortune.
     nechung
+    restore_terminal_title
+  }
+
+  # copies a set of custom scripts into the proper location for feisty meow
+  # to merge their functions and aliases with the standard set.
+  function recustomize()
+  {
+    local custom_user="$1"; shift
+    if [ -z "$custom_user" ]; then
+      # use our default example user if there was no name provided.
+      custom_user=fred
+    fi
+
+    save_terminal_title
+
+    if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
+      echo "The customization folder provided for $custom_user should be:"
+      echo "  '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'"
+      echo "but that folder does not exist.  Skipping customization."
+      return 1
+    fi
+    regenerate >/dev/null
+    pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
+    incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
+    
+    #echo "the incongruous files list is: $incongruous_files"
+    # disallow a single character result, since we get "*" as result when nothing exists yet.
+    if [ ${#incongruous_files} -ge 2 ]; then
+      echo "cleaning unknown older overrides..."
+      perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
+      echo
+    fi
+    popd &>/dev/null
+    echo "copying custom overrides for $custom_user"
+    mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
+    perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
+    if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
+      echo "copying custom scripts for $custom_user"
+      \cp -R "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
+    fi
+    echo
+    regenerate
+
+    restore_terminal_title
   }
 
   # generates a random password where the first parameter is the number of characters
@@ -406,51 +443,16 @@ if [ -z "$skip_all" ]; then
     echo $(which $to_find)
   }
 
-  # copies a set of custom scripts into the proper location for feisty meow
-  # to merge their functions and aliases with the standard set.
-  function recustomize()
-  {
-    user="$1"; shift
-    if [ -z "$user" ]; then
-      # use our default example user if there was no name provided.
-      user=fred
-    fi
-    if [ ! -d "$FEISTY_MEOW_APEX/customizing/$user" ]; then
-      echo "The customization folder provided for $user should be:"
-      echo "  '$FEISTY_MEOW_APEX/customizing/$user'"
-      echo "but that folder does not exist.  Skipping customization."
-      return 1
-    fi
-    regenerate >/dev/null
-    pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
-    local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
-
-#echo "the incongruous files list is: $incongruous_files"
-    # disallow a single character result, since we get "*" as result when nothing exists yet.
-    if [ ${#incongruous_files} -ge 2 ]; then
-      echo "cleaning unknown older overrides..."
-      perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
-      echo
-    fi
-    popd &>/dev/null
-    echo "copying custom overrides for $user"
-    mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
-    perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom"
-    if [ -d "$FEISTY_MEOW_APEX/customizing/$user/scripts" ]; then
-      echo "copying custom scripts for $user"
-      \cp -R "$FEISTY_MEOW_APEX/customizing/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
-    fi
-    echo
-    regenerate
-  }
-
-#uhhh, this does what now?
+#hmmm: improve this by not adding the link
+# if already there, or if the drive is not valid.
   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.
@@ -467,13 +469,100 @@ if [ -z "$skip_all" ]; then
     sed -i -e "s%$pattern%$replacement%g" "$file"
   }
 
+  # similar to replace_pattern_in_file, but also will add the new value
+  # when the old one did not already exist in the file.
+  function replace_if_exists_or_add()
+  {
+    local file="$1"; shift
+    local phrase="$1"; shift
+    local replacement="$1"; shift
+    if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
+      echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
+      echo "text to replace that phrase with."
+      return 1
+    fi
+    grep "$phrase" "$file" >/dev/null
+    # replace if the phrase is there, otherwise add it.
+    if [ $? -eq 0 ]; then
+      replace_pattern_in_file "$file" "$phrase" "$replacement"
+    else
+      # this had better be the complete line.
+      echo "$replacement" >>"$file"
+    fi
+  }
+
+  ############################
+
+  # finds a variable (first parameter) in a particular property file
+  # (second parameter).  the expected format for the file is:
+  # varX=valueX
+  function seek_variable()
+  {
+    local find_var="$1"; shift
+    local file="$1"; shift
+    if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
+      echo -e "seek_variable: needs two parameters, firstly a variable name, and\nsecondly a file where the variable's value will be sought." 1>&2
+      return 1
+    fi
+  
+    while read line; do
+      if [ ${#line} -eq 0 ]; then continue; fi
+      # split the line into the variable name and value.
+      IFS='=' read -a assignment <<< "$line"
+      local var="${assignment[0]}"
+      local value="${assignment[1]}"
+      if [ "${value:0:1}" == '"' ]; then
+        # assume the entry was in quotes and remove them.
+        value="${value:1:$((${#value} - 2))}"
+      fi
+      if [ "$find_var" == "$var" ]; then
+        echo "$value"
+      fi
+    done < "$file"
+  }
+  
+  # finds a variable (first parameter) in a particular XML format file
+  # (second parameter).  the expected format for the file is:
+  # ... name="varX" value="valueX" ...
+  function seek_variable_in_xml()
+  {
+    local find_var="$1"; shift
+    local file="$1"; shift
+    if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
+      echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
+      echo "secondly an XML file where the variable's value will be sought."
+      return 1
+    fi
+  
+    while read line; do
+      if [ ${#line} -eq 0 ]; then continue; fi
+      # process the line to make it more conventional looking.
+      line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
+      # split the line into the variable name and value.
+      IFS='=' read -a assignment <<< "$line"
+      local var="${assignment[0]}"
+      local value="${assignment[1]}"
+      if [ "${value:0:1}" == '"' ]; then
+        # assume the entry was in quotes and remove them.
+        value="${value:1:$((${#value} - 2))}"
+      fi
+      if [ "$find_var" == "$var" ]; then
+        echo "$value"
+      fi
+    done < "$file"
+  }
+  
+  ############################
+
   # goes to a particular directory passed as parameter 1, and then removes all
   # the parameters after that from that directory.
   function push_whack_pop()
   {
     local dir="$1"; shift
     pushd "$dir" &>/dev/null
-    rm $* &>/dev/null
+    if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
+    rm -rf $* &>/dev/null
+    if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
     popd &>/dev/null
   }
 
@@ -564,9 +653,68 @@ return 0
 
   ##############
 
-  function function_sentinel() { return 0; }
+#hmmm: this points to an extended functions file being needed; not all of these are core.
+
+  # displays documentation in "md" formatted files.
+  function show_md()
+  {
+    local file="$1"; shift
+    pandoc "$file" | lynx -stdin
+  }
+
+  ##############
+
+  # just shows a separator line for an 80 column console, or uses the first
+  # parameter as the number of columns to expect.
+  function separator()
+  {
+    count=$1; shift
+    if [ -z "$count" ]; then
+      count=79
+    fi
+    echo
+    local i
+    for ((i=0; i < $count - 1; i++)); do
+      echo -n "="
+    done
+    echo
+    echo
+  }
+  # alias for separator.
+  function sep()
+  {
+    separator $*
+  }
+
+  ##############
+
+  function function_sentinel()
+  {
+    return 0; 
+  }
   
   if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
-  
+
+  ##############
+
+  # test code for set_var_if_undefined.
+  run_test=0
+  if [ $run_test != 0 ]; then
+    echo running tests on set_var_if_undefined.
+    flagrant=petunia
+    set_var_if_undefined flagrant forknordle
+    check_result "testing if defined variable would be whacked"
+    if [ $flagrant != petunia ]; then
+      echo set_var_if_undefined failed to leave the test variable alone
+      exit 1
+    fi
+    unset bobblehead_stomper
+    set_var_if_undefined bobblehead_stomper endurance
+    if [ $bobblehead_stomper != endurance ]; then
+      echo set_var_if_undefined failed to set a variable that was not defined yet
+      exit 1
+    fi
+  fi
+
 fi