made var function support multiple names.
[feisty_meow.git] / scripts / core / functions.sh
index d5ab21e10a5899d20d44372e8a52cda8c9c1e924..41d94b938e9144d29218e8fa31961b8a11f2a39f 100644 (file)
@@ -21,7 +21,9 @@ if [ -z "$skip_all" ]; then
   # 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() {
-    date +"%Y_%m_%d_%H%M_%S" | tr -d '/\n/'
+    local sep="$1"; shift
+    if [ -z "$sep" ]; then sep='_'; fi
+    date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
   }
   
   # makes a directory of the name specified and then tries to change the
@@ -30,7 +32,48 @@ if [ -z "$skip_all" ]; then
     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
     cd "$1"
   }
-  
+
+  # 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 it 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 PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
@@ -97,36 +140,42 @@ if [ -z "$skip_all" ]; then
   # finds all processes matching the pattern specified and shows their full
   # process listing (whereas psfind just lists process ids).
   function psa() {
+    if [ -z "$1" ]; then
+      echo "psa finds processes by pattern, but there was no pattern on the command line."
+      return 1
+    fi
     p=$(psfind "$1")
-    if [ ! -z "$p" ]; then
-      echo ""
-      echo "Processes containing \"$1\"..."
-      echo ""
-      if [ -n "$IS_DARWIN" ]; then
-        unset fuzil_sentinel
-        for i in $p; do
-          # only print the header the first time.
-          if [ -z "$fuzil_sentinel" ]; then
-            ps $i -w -u
-          else
-            ps $i -w -u | sed -e '1d'
-          fi
-          fuzil_sentinel=true
-        done
-      else 
-        # cases besides mac os x's darwin.
-        extra_flags=
-        if [ "$OS" = "Windows_NT" ]; then
-          # special case for windows.
-          extra_flags=-W
-          ps | head -1
-          for curr in $p; do
-            ps $extra_flags | grep "$curr" 
-          done
+    if [ -z "$p" ]; then
+      # no matches.
+      return 0
+    fi
+    echo ""
+    echo "Processes containing \"$1\"..."
+    echo ""
+    if [ -n "$IS_DARWIN" ]; then
+      unset fuzil_sentinel
+      for i in $p; do
+        # only print the header the first time.
+        if [ -z "$fuzil_sentinel" ]; then
+          ps $i -w -u
         else
-          # normal OSes can handle a nice simple query.
-          ps wu $p
+          ps $i -w -u | sed -e '1d'
         fi
+        fuzil_sentinel=true
+      done
+    else 
+      # cases besides mac os x's darwin.
+      extra_flags=
+      if [ "$OS" = "Windows_NT" ]; then
+        # special case for windows.
+        extra_flags=-W
+        ps | head -1
+        for curr in $p; do
+          ps $extra_flags | grep "$curr" 
+        done
+      else
+        # normal OSes can handle a nice simple query.
+        ps wu $p
       fi
     fi
   }
@@ -148,26 +197,41 @@ if [ -z "$skip_all" ]; then
     sudo /etc/init.d/alsasound restart
   }
   
-  # switches from a /X/path form to an X:/ form.
-  function msys_to_dos_path() {
-    # we always remove dos slashes in favor of forward slashes.
-    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
+  # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
+  function unix_to_dos_path() {
+    # we usually remove dos slashes in favor of forward slashes.
+    if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
+      # unless this flag is set, in which case we force dos slashes.
+      echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
+    else
+      echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
+    fi
   }
   
   # switches from an X:/ form to an /X/path form.
-  function dos_to_msys_path() {
+  function dos_to_unix_path() {
     # we always remove dos slashes in favor of forward slashes.
     echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
   }
-  
-  # su function: makes su perform a login.
-  # for some OSes, this transfers the X authority information to the new login.
-  function su() {
+
+  # returns a successful value (0) if this system is debian or ubuntu.
+  function debian_like() {
     # decide if we think this is debian or ubuntu or a variant.
     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
-  
     if [ $DEBIAN_LIKE -eq 1 ]; then
+      # success; this is debianish.
+      return 0
+    else
+      # this seems like some other OS.
+      return 1
+    fi
+  }
+  
+  # su function: makes su perform a login.
+  # for some OSes, this transfers the X authority information to the new login.
+  function su() {
+    if debian_like; then
       # debian currently requires the full version which imports X authority
       # information for su.
   
@@ -196,33 +260,13 @@ 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
     fi
   }
   
-  # buntar is a long needed uncompressing macro that feeds into tar -x.
-  # it takes a list of bz2 file names and extracts their contents into
-  # sequentially numbered directories.
-  function buntar() {
-    index=1
-    for i in $*; do
-      mkdir buntar_$index
-      pushd buntar_$index &>/dev/null
-      file=$i
-      # if the filename has no directory component, we will assume it used to
-      # be above our unzipping directory here.
-      if [ "$(basename $file)" = $file ]; then
-        file=../$file
-      fi
-      bunzip2 -d -c $file | tar -xf -
-      popd &>/dev/null
-      index=$(expr $index + 1)
-    done
-  }
-  
   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
   # this kind of assumes you've already checked them for any salient facts.
   function clean_cvs_junk() {
@@ -230,20 +274,105 @@ if [ -z "$skip_all" ]; then
       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";" 
     done
   }
-  
-  # recreates all the generated files that the feisty meow scripts use.
-  function regenerate() {
-    bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
-    echo
+
+  # overlay for nechung binary so that we can complain less grossly about it when it's missing.
+  function nechung() {
     local wheres_nechung=$(which nechung 2>/dev/null)
     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_DIR/scripts/generator/bootstrap_build.sh"
+      echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
     else
-      nechung
+      $wheres_nechung
     fi
   }
+  
+  # recreates all the generated files that the feisty meow scripts use.
+  function regenerate() {
+    bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
+    echo
+    nechung
+  }
+
+  # generates a random password where the first parameter is the number of characters
+  # in the password (default 20) and the second parameter specifies whether to use
+  # special characters (1) or not (0).
+  # found function at http://legroom.net/2010/05/06/bash-random-password-generator
+  function random_password()
+  {
+    [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
+    cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
+    echo
+  }
+
+  # a wrapper for the which command that finds items on the path.  some OSes
+  # do not provide which, so we want to not be spewing errors when that
+  # happens.
+  function whichable()
+  {
+    to_find="$1"; shift
+    which which &>/dev/null
+    if [ $? -ne 0 ]; then
+      # there is no which command here.  we produce nothing due to this.
+      echo
+    fi
+    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_DIR/customizing/$user" ]; then
+      echo "The customization folder provided for $user should be:"
+      echo "  '$FEISTY_MEOW_DIR/customizing/$user'"
+      echo "but that folder does not exist.  Skipping customization."
+      return 1
+    fi
+    regenerate >/dev/null
+    pushd "$FEISTY_MEOW_GENERATED/custom" &>/dev/null
+    local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom")"
+    if [ ${#incongruous_files} -ge 1 ]; 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 "$FEISTY_MEOW_GENERATED/custom" 2>/dev/null
+    perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom"
+    regenerate
+  }
+
+  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 function_sentinel() { return 0; }