done refactoring version control library script
[feisty_meow.git] / scripts / core / functions.sh
index e70d6e57a8b65d0b92418609ad0c0d759e166bfc..a66d19398960a4e9d896081bb2910e6ac539ad55 100644 (file)
@@ -121,20 +121,20 @@ if [ -z "$skip_all" ]; then
   # 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 test_or_fail()
+  function test_or_die()
   {
     if [ $? -ne 0 ]; then
-      echo -e "\n\nfailed on: $*"
+      echo -e "\n\naction failed: $*\n\nExiting script..."
       error_sound
       exit 1
     fi
   }
 
-  # like test_or_fail, but will keep going after complaining.
+  # like test_or_die, but will keep going after complaining.
   function test_or_continue()
   {
     if [ $? -ne 0 ]; then
-      echo -e "\n\nfailed on: $*"
+      echo -e "\n\nerror occurred: $*\n\nContinuing script..."
       error_sound
     fi
   }
@@ -737,11 +737,68 @@ return 0
   
     if [ -d "$src" ]; then
       ln -s "$src" "$target"
-      test_or_fail "Creating symlink from '$src' to '$target'"
+      test_or_die "Creating symlink from '$src' to '$target'"
     fi
     echo "Created symlink from '$src' to '$target'."
   }
 
+  # pretty prints the json files provided as parameters.
+  function clean_json()
+  {
+    if [ -z "$*" ]; then return; fi
+    local show_list=()
+    while true; do
+      local file="$1"; shift
+      if [ -z "$file" ]; then break; fi
+      if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
+      temp_out="$TMP/$file.view"
+      cat "$file" | python -m json.tool > "$temp_out"
+      show_list+=($temp_out)
+      test_or_continue "pretty printing '$file'"
+    done
+    filedump "${show_list[@]}"
+    rm "${show_list[@]}"
+  }
+
+  function json_text()
+  {
+    # only print our special headers or text fields.
+    local CR=$'\r'
+    local LF=$'\n'
+    clean_json $* |
+        grep -i "\"text\":\|^=.*" | 
+        sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
+  }
+
+  ##############
+
+  # echoes the machine's hostname.  can be used like so:
+  #   local my_host=$(get_hostname)
+  function get_hostname()
+  {
+    # there used to be more variation in how to do this, but adopting mingw
+    # and cygwin tools really helped out.
+    local this_host=unknown
+    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)
+    elif [ -x "$(which hostname 2>/dev/null)" ]; then
+      this_host=$(hostname)
+    fi
+    echo "$this_host"
+  }
+
+  # makes sure that the provided "folder" is a directory and is writable.
+  function test_writeable()
+  {
+    local folder="$1"; shift
+    if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
+    return 0
+  }
+
   ##############
 
   # NOTE: no more function definitions are allowed after this point.
@@ -761,7 +818,7 @@ return 0
     echo running tests on set_var_if_undefined.
     flagrant=petunia
     set_var_if_undefined flagrant forknordle
-    test_or_fail "testing if defined variable would be whacked"
+    test_or_die "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