scripts/core/functions.sh

   1 #!/bin/bash
   2
   3 # This defines some general, useful functions.
   4
   5 #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?
   6
   7 ##############
   8
   9 # test whether we've been here before or not.
  10 skip_all=
  11 type function_sentinel &>/dev/null
  12 if [ $? -eq 0 ]; then
  13   # there was no error, so we can skip the inits.
  14   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  15     echo "skipping function definitions, because already defined."
  16   fi
  17   skip_all=yes
  18 else
  19   skip_all=
  20 fi
  21
  22 if [ -z "$skip_all" ]; then
  23
  24   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  25     echo "feisty meow function definitions beginning now..."
  26   fi
  27
  28   # a handy little method that can be used for date strings.  it was getting
  29   # really tiresome how many different ways the script did the date formatting.
  30   function date_stringer() {
  31     local sep="$1"; shift
  32     if [ -z "$sep" ]; then sep='_'; fi
  33     date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
  34   }
  35
  36   # makes a directory of the name specified and then tries to change the
  37   # current directory to that directory.
  38   function mcd() {
  39     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
  40     cd "$1"
  41   }
  42
  43   function is_array() {
  44     [[ "$(declare -p $1)" =~ "declare -a" ]]
  45   }
  46
  47   function is_alias() {
  48     alias $1 &>/dev/null
  49     return $?
  50   }
  51
  52   # displays the value of a variable in bash friendly format.
  53   function var() {
  54     HOLDIFS="$IFS"
  55     IFS=""
  56     while true; do
  57       local varname="$1"; shift
  58       if [ -z "$varname" ]; then
  59         break
  60       fi
  61
  62       if is_alias "$varname"; then
  63 #echo found $varname is alias
  64         local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
  65         alias $varname | sed -e 's/.*=//' >$tmpfile
  66         echo "alias $varname=$(cat $tmpfile)"
  67         \rm $tmpfile
  68       elif [ -z "${!varname}" ]; then
  69         echo "$varname undefined"
  70       else
  71         if is_array "$varname"; then
  72 #echo found $varname is array var
  73           local temparray
  74           eval temparray="(\${$varname[@]})"
  75           echo "$varname=(${temparray[@]})"
  76 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
  77 # see ones that have spaces in them.
  78         else
  79 #echo found $varname is simple
  80           echo "$varname=${!varname}"
  81         fi
  82       fi
  83     done | sort
  84     IFS="$HOLDIFS"
  85   }
  86
  87   # when passed a list of things, this will return the unique items from that list as an echo.
  88   function uniquify()
  89   {
  90     # do the uniquification: split the space separated items into separate lines, then
  91     # sort the list, then run the uniq tool on the list.  results will be packed back onto
  92     # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
  93     echo $* | tr ' ' '\n' | sort | uniq
  94   }
  95
  96   # sets the variable in parameter 1 to the value in parameter 2, but only if
  97   # that variable was undefined.
  98   function set_var_if_undefined()
  99   {
 100     local var_name="$1"; shift
 101     local var_value="$1"; shift
 102     if [ -z "${!var_name}" ]; then
 103       eval export $var_name="$var_value"
 104     fi
 105   }
 106
 107   function success_sound()
 108   {
 109     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
 110       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
 111     fi
 112   }
 113
 114   function error_sound()
 115   {
 116     if [ ! -z "$CLAM_ERROR_SOUND" ]; then
 117       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
 118     fi
 119   }
 120
 121   # checks the result of the last command that was run, and if that failed,
 122   # then this complains and exits from bash.  the function parameters are
 123   # used as the message to print as a complaint.
 124   function test_or_die()
 125   {
 126     if [ $? -ne 0 ]; then
 127       echo -e "\n\naction failed: $*\n\nExiting script..."
 128       error_sound
 129       exit 1
 130     fi
 131   }
 132
 133   # like test_or_die, but will keep going after complaining.
 134   function test_or_continue()
 135   {
 136     if [ $? -ne 0 ]; then
 137       echo -e "\n\nerror occurred: $*\n\nContinuing script..."
 138       error_sound
 139     fi
 140   }
 141
 142   # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
 143   function ssh()
 144   {
 145     local args=($*)
 146     save_terminal_title
 147     # we remember the old terminal title, then force the TERM variable to a more generic
 148     # version for the other side (just 'linux'); we don't want the remote side still
 149     # thinking it's running xterm.
 150     export TERM=linux
 151     /usr/bin/ssh -X -C "${args[@]}"
 152     restore_terminal_title
 153   }
 154
 155   # locates a process given a search pattern to match in the process list.
 156   # supports a single command line flag style parameter of "-u USERNAME";
 157   # if the -u flag is found, a username is expected afterwards, and only the
 158   # processes of that user are considered.
 159   function psfind() {
 160     local -a patterns=("${@}")
 161 #echo ====
 162 #echo patterns list is: "${patterns[@]}"
 163 #echo ====
 164
 165     local user_flag
 166     if [ "${patterns[0]}" == "-u" ]; then
 167       user_flag="-u ${patterns[1]}"
 168 #echo "found a -u parm and user=${patterns[1]}"
 169       # void the two elements with that user flag so we don't use them as patterns.
 170       unset patterns[0] patterns[1]=
 171     else
 172       # select all users.
 173       user_flag="-e"
 174     fi
 175
 176     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
 177     local -a PIDS_SOUGHT
 178
 179     if [ "$OS" == "Windows_NT" ]; then
 180       # gets cygwin's (god awful) ps to show windoze processes also.
 181       local EXTRA_DOZER_FLAGS="-W"
 182       # pattern to use for peeling off the process numbers.
 183       local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
 184
 185     else
 186       # flags which clean up the process listing output on unixes.
 187       # apparently cygwin doesn't count as a type of unix, because their
 188       # crummy specialized ps command doesn't support normal ps flags.
 189       local EXTRA_UNIX_FLAGS="-o pid,args"
 190       # pattern to use for peeling off the process numbers.
 191       local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
 192     fi
 193
 194     /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
 195 #echo ====
 196 #echo got all this stuff in the pid dump file:
 197 #cat $PID_DUMP
 198 #echo ====
 199
 200     # search for the pattern the user wants to find, and just pluck the process
 201     # ids out of the results.
 202     local i
 203     for i in "${patterns[@]}"; do
 204       PIDS_SOUGHT+=($(cat $PID_DUMP \
 205         | grep -i "$i" \
 206         | sed -n -e "$pid_finder_pattern"))
 207     done
 208 #echo ====
 209 #echo pids sought list became:
 210 #echo "${PIDS_SOUGHT[@]}"
 211 #echo ====
 212
 213     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 214       local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
 215       PIDS_SOUGHT=()
 216       PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
 217       echo ${PIDS_SOUGHT[*]}
 218     fi
 219     /bin/rm $PID_DUMP
 220   }
 221
 222   # finds all processes matching the pattern specified and shows their full
 223   # process listing (whereas psfind just lists process ids).
 224   function psa() {
 225     if [ -z "$1" ]; then
 226       echo "psa finds processes by pattern, but there was no pattern on the command line."
 227       return 1
 228     fi
 229     local -a patterns=("${@}")
 230     p=$(psfind "${patterns[@]}")
 231     if [ -z "$p" ]; then
 232       # no matches.
 233       return 0
 234     fi
 235
 236     if [ "${patterns[0]}" == "-u" ]; then
 237       # void the two elements with that user flag so we don't use them as patterns.
 238       unset patterns[0] patterns[1]=
 239     fi
 240
 241     echo ""
 242     echo "Processes matching ${patterns[@]}..."
 243     echo ""
 244     if [ -n "$IS_DARWIN" ]; then
 245       unset fuzil_sentinel
 246       for i in $p; do
 247         # only print the header the first time.
 248         if [ -z "$fuzil_sentinel" ]; then
 249           ps $i -w -u
 250         else
 251           ps $i -w -u | sed -e '1d'
 252         fi
 253         fuzil_sentinel=true
 254       done
 255     else
 256       # cases besides mac os x's darwin.
 257       if [ "$OS" == "Windows_NT" ]; then
 258         # special case for windows.
 259         ps | head -1
 260         for curr in $p; do
 261           ps -W -p $curr | tail -n +2
 262         done
 263       else
 264         # normal OSes can handle a nice simple query.
 265         ps wu $p
 266       fi
 267     fi
 268   }
 269
 270   # an unfortunately similarly named function to the above 'ps' as in process
 271   # methods, but this 'ps' stands for postscript.  this takes a postscript file
 272   # and converts it into pcl3 printer language and then ships it to the printer.
 273   # this mostly makes sense for an environment where one's default printer is
 274   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
 275   # some good success running ps2ps on the input file and using the cleaned
 276   # postscript file for printing.
 277   function ps2pcl2lpr() {
 278     for $i in $*; do
 279       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
 280     done
 281   }
 282
 283 #  function fix_alsa() {
 284 #    sudo /etc/init.d/alsasound restart
 285 #  }
 286
 287   function screen() {
 288     save_terminal_title
 289 #hmmm: ugly absolute path here.
 290     /usr/bin/screen $*
 291     restore_terminal_title
 292   }
 293
 294   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
 295   function unix_to_dos_path() {
 296     # we usually remove dos slashes in favor of forward slashes.
 297     local DOSSYHOME
 298     if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
 299       # fake this value for non-windows (non-cygwin) platforms.
 300       DOSSYHOME="$HOME"
 301     else
 302       # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
 303       # insists on the /home form instead of /c/cygwin/home being possible.  this is
 304       # super frustrating and nightmarish.
 305       DOSSYHOME="$(cygpath -am "$HOME")"
 306     fi
 307
 308     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
 309       # unless this flag is set, in which case we force dos slashes.
 310       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
 311     else
 312       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 313     fi
 314   }
 315
 316   # switches from an X:/ form to a /cygdrive/X/path form.  this is only useful
 317   # for the cygwin environment currently.
 318   function dos_to_unix_path() {
 319     # we always remove dos slashes in favor of forward slashes.
 320 #old:    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
 321          echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
 322   }
 323
 324   # returns a successful value (0) if this system is debian or ubuntu.
 325   function debian_like() {
 326     # decide if we think this is debian or ubuntu or a variant.
 327     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
 328         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
 329     if [ $DEBIAN_LIKE -eq 1 ]; then
 330       # success; this is debianish.
 331       return 0
 332     else
 333       # this seems like some other OS.
 334       return 1
 335     fi
 336   }
 337
 338   # su function: makes su perform a login.
 339   # for some OSes, this transfers the X authority information to the new login.
 340   function su() {
 341     if debian_like; then
 342       # debian currently requires the full version which imports X authority
 343       # information for su.
 344
 345       # get the x authority info for our current user.
 346       source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
 347
 348       if [ -z "$X_auth_info" ]; then
 349         # if there's no authentication info to pass along, we just do a normal su.
 350         /bin/su -l $*
 351       else
 352         # under X, we update the new login's authority info with the previous
 353         # user's info.
 354         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 355       fi
 356     else
 357       # non-debian supposedly doesn't need the extra overhead any more.
 358       # or at least suse doesn't, which is the other one we've tested on.
 359       /bin/su -l $*
 360     fi
 361   }
 362
 363   # sudo function wraps the normal sudo by ensuring we replace the terminal
 364   # label if they're doing an su with the sudo.
 365   function sudo() {
 366 #    local first_command="$1"
 367     save_terminal_title
 368     /usr/bin/sudo "$@"
 369     restore_terminal_title
 370 #    if [ "$first_command" == "su" ]; then
 371 #      # yep, they were doing an su, but they're back now.
 372 #      label_terminal_with_info
 373 #    fi
 374   }
 375
 376   # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
 377   # this kind of assumes you've already checked them for any salient facts.
 378   function clean_cvs_junk() {
 379     for i in $*; do
 380       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 381     done
 382   }
 383
 384   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 385   function nechung() {
 386     local wheres_nechung=$(which nechung 2>/dev/null)
 387     if [ -z "$wheres_nechung" ]; then
 388       echo "The nechung oracle program cannot be found.  You may want to consider"
 389       echo "rebuilding the feisty meow applications with this command:"
 390       echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
 391       echo
 392     else
 393       $wheres_nechung
 394     fi
 395   }
 396
 397   # recreates all the generated files that the feisty meow scripts use.
 398   function regenerate() {
 399     # do the bootstrapping process again.
 400     save_terminal_title
 401     echo "regenerating feisty meow script environment."
 402     bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
 403     echo
 404     # force a full reload by turning off sentinel variables and methods.
 405     unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
 406     unalias CORE_ALIASES_LOADED &>/dev/null
 407     unset -f function_sentinel
 408     # reload feisty meow environment in current shell.
 409     source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
 410     # run nechung oracle to give user a new fortune.
 411     nechung
 412     restore_terminal_title
 413   }
 414
 415   # copies a set of custom scripts into the proper location for feisty meow
 416   # to merge their functions and aliases with the standard set.
 417   function recustomize()
 418   {
 419     local custom_user="$1"; shift
 420     if [ -z "$custom_user" ]; then
 421       # use our default example user if there was no name provided.
 422       custom_user=fred
 423     fi
 424
 425     save_terminal_title
 426
 427     if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
 428       echo "The customization folder provided for $custom_user should be:"
 429       echo "  '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'"
 430       echo "but that folder does not exist.  Skipping customization."
 431       return 1
 432     fi
 433     regenerate >/dev/null
 434     pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
 435     incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
 436
 437     local fail_message="\nare the perl dependencies installed?  if you're on ubuntu or debian, try this:\n
 438     $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n"
 439
 440     #echo "the incongruous files list is: $incongruous_files"
 441     # disallow a single character result, since we get "*" as result when nothing exists yet.
 442     if [ ${#incongruous_files} -ge 2 ]; then
 443       echo "cleaning unknown older overrides..."
 444       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
 445       test_or_continue "running safedel.  $fail_message"
 446       echo
 447     fi
 448     popd &>/dev/null
 449     echo "copying custom overrides for $custom_user"
 450     mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
 451     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
 452     test_or_continue "running cpdiff.  $fail_message"
 453
 454     if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
 455       echo "copying custom scripts for $custom_user"
 456       netcp "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
 457 #hmmm: could save output to show if an error occurs.
 458     fi
 459     echo
 460     regenerate
 461
 462     restore_terminal_title
 463   }
 464
 465   # generates a random password where the first parameter is the number of characters
 466   # in the password (default 20) and the second parameter specifies whether to use
 467   # special characters (1) or not (0).
 468   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
 469   function random_password()
 470   {
 471     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 472     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 473     echo
 474   }
 475
 476   # a wrapper for the which command that finds items on the path.  some OSes
 477   # do not provide which, so we want to not be spewing errors when that
 478   # happens.
 479   function whichable()
 480   {
 481     to_find="$1"; shift
 482     which which &>/dev/null
 483     if [ $? -ne 0 ]; then
 484       # there is no which command here.  we produce nothing due to this.
 485       echo
 486     fi
 487     echo $(which $to_find)
 488   }
 489
 490 #hmmm: improve this by not adding the link
 491 # if already there, or if the drive is not valid.
 492   function add_cygwin_drive_mounts() {
 493     for i in c d e f g h q z ; do
 494       ln -s /cygdrive/$i $i
 495     done
 496   }
 497
 498   ############################
 499
 500   # takes a file to modify, and then it will replace any occurrences of the
 501   # pattern provided as the second parameter with the text in the third
 502   # parameter.
 503   function replace_pattern_in_file()
 504   {
 505     local file="$1"; shift
 506     local pattern="$1"; shift
 507     local replacement="$1"; shift
 508     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
 509       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
 510       echo "text to replace that pattern with."
 511       return 1
 512     fi
 513     sed -i -e "s%$pattern%$replacement%g" "$file"
 514   }
 515
 516   # similar to replace_pattern_in_file, but also will add the new value
 517   # when the old one did not already exist in the file.
 518   function replace_if_exists_or_add()
 519   {
 520     local file="$1"; shift
 521     local phrase="$1"; shift
 522     local replacement="$1"; shift
 523     if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
 524       echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
 525       echo "text to replace that phrase with."
 526       return 1
 527     fi
 528     grep "$phrase" "$file" >/dev/null
 529     # replace if the phrase is there, otherwise add it.
 530     if [ $? -eq 0 ]; then
 531       replace_pattern_in_file "$file" "$phrase" "$replacement"
 532     else
 533       # this had better be the complete line.
 534       echo "$replacement" >>"$file"
 535     fi
 536   }
 537
 538   ############################
 539
 540   # finds a variable (first parameter) in a particular property file
 541   # (second parameter).  the expected format for the file is:
 542   # varX=valueX
 543   function seek_variable()
 544   {
 545     local find_var="$1"; shift
 546     local file="$1"; shift
 547     if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
 548       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
 549       return 1
 550     fi
 551
 552     while read line; do
 553       if [ ${#line} -eq 0 ]; then continue; fi
 554       # split the line into the variable name and value.
 555       IFS='=' read -a assignment <<< "$line"
 556       local var="${assignment[0]}"
 557       local value="${assignment[1]}"
 558       if [ "${value:0:1}" == '"' ]; then
 559         # assume the entry was in quotes and remove them.
 560         value="${value:1:$((${#value} - 2))}"
 561       fi
 562       if [ "$find_var" == "$var" ]; then
 563         echo "$value"
 564       fi
 565     done < "$file"
 566   }
 567
 568   # finds a variable (first parameter) in a particular XML format file
 569   # (second parameter).  the expected format for the file is:
 570   # ... name="varX" value="valueX" ...
 571   function seek_variable_in_xml()
 572   {
 573     local find_var="$1"; shift
 574     local file="$1"; shift
 575     if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
 576       echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
 577       echo "secondly an XML file where the variable's value will be sought."
 578       return 1
 579     fi
 580
 581     while read line; do
 582       if [ ${#line} -eq 0 ]; then continue; fi
 583       # process the line to make it more conventional looking.
 584       line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
 585       # split the line into the variable name and value.
 586       IFS='=' read -a assignment <<< "$line"
 587       local var="${assignment[0]}"
 588       local value="${assignment[1]}"
 589       if [ "${value:0:1}" == '"' ]; then
 590         # assume the entry was in quotes and remove them.
 591         value="${value:1:$((${#value} - 2))}"
 592       fi
 593       if [ "$find_var" == "$var" ]; then
 594         echo "$value"
 595       fi
 596     done < "$file"
 597   }
 598
 599   ############################
 600
 601   # goes to a particular directory passed as parameter 1, and then removes all
 602   # the parameters after that from that directory.
 603   function push_whack_pop()
 604   {
 605     local dir="$1"; shift
 606     pushd "$dir" &>/dev/null
 607     if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
 608     rm -rf $* &>/dev/null
 609     if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
 610     popd &>/dev/null
 611   }
 612
 613   function spacem()
 614   {
 615     while [ $# -gt 0 ]; do
 616       arg="$1"; shift
 617       if [ ! -f "$arg" -a ! -d "$arg" ]; then
 618         echo "failure to find a file or directory named '$arg'."
 619         continue
 620       fi
 621
 622       # first we will capture the output of the character replacement operation for reporting.
 623       # this is done first since some filenames can't be properly renamed in perl (e.g. if they
 624       # have pipe characters apparently).
 625       intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
 626       local saw_intermediate_result=0
 627       if [ -z "$intermediate_name" ]; then
 628         # make sure we report something, if there are no further name changes.
 629         intermediate_name="'$arg'"
 630       else
 631         # now zap the first part of the name off (since original name isn't needed).
 632         intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
 633         saw_intermediate_result=1
 634       fi
 635
 636       # first we rename the file to be lower case.
 637       actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
 638       final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
 639       local saw_final_result=0
 640       if [ -z "$final_name" ]; then
 641         final_name="$intermediate_name"
 642       else
 643         final_name="$(echo $final_name | sed -e 's/.*=> //')"
 644         saw_final_result=1
 645       fi
 646 #echo intermed=$saw_intermediate_result
 647 #echo final=$saw_final_result
 648
 649       if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
 650         # printout the combined operation results.
 651         echo "'$arg' => $final_name"
 652       fi
 653     done
 654   }
 655
 656   ##############
 657
 658 # new breed of definer functions goes here.  still in progress.
 659
 660   # defines an alias and remembers that this is a new or modified definition.
 661   # if the feisty meow codebase is unloaded, then so are all the aliases that
 662   # were defined.
 663   function define_yeti_alias()
 664   {
 665 # if alias exists already, save old value for restore,
 666 # otherwise save null value for restore,
 667 # have to handle unaliasing if there was no prior value of one
 668 # we newly defined.
 669 # add alias name to a list of feisty defined aliases.
 670
 671 #hmmm: first implem, just do the alias and get that working...
 672 alias "${@}"
 673
 674
 675 return 0
 676   }
 677
 678   ##############
 679
 680 #hmmm: this points to an extended functions file being needed; not all of these are core.
 681
 682   # displays documentation in "md" formatted files.
 683   function show_md()
 684   {
 685     local file="$1"; shift
 686     pandoc "$file" | lynx -stdin
 687   }
 688
 689   ##############
 690
 691   # just shows a separator line for an 80 column console, or uses the first
 692   # parameter as the number of columns to expect.
 693   function separator()
 694   {
 695     count=$1; shift
 696     if [ -z "$count" ]; then
 697       count=79
 698     fi
 699     echo
 700     local i
 701     for ((i=0; i < $count - 1; i++)); do
 702       echo -n "="
 703     done
 704     echo
 705     echo
 706   }
 707   # alias for separator.
 708   function sep()
 709   {
 710     separator $*
 711   }
 712
 713   ##############
 714
 715   # count the number of sub-directories in a directory and echo the result.
 716   function count_directories()
 717   {
 718     local appsdir="$1"; shift
 719     numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
 720     echo $numdirs
 721   }
 722
 723   # takes a string and capitalizes just the first character.  any capital letters in the remainder of
 724   # the string are made lower case.  the processed string is returned by an echo.
 725   function capitalize_first_char()
 726   {
 727     local to_dromedary="$1"; shift
 728     to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
 729     echo "$to_dromedary"
 730   }
 731
 732   # given a source path and a target path, this will make a symbolic link from
 733   # the source to the destination, but only if the source actually exists.
 734   function make_safe_link()
 735   {
 736     local src="$1"; shift
 737     local target="$1"; shift
 738
 739     if [ -d "$src" ]; then
 740       ln -s "$src" "$target"
 741       test_or_die "Creating symlink from '$src' to '$target'"
 742     fi
 743     echo "Created symlink from '$src' to '$target'."
 744   }
 745
 746   # pretty prints the json files provided as parameters.
 747   function clean_json()
 748   {
 749     if [ -z "$*" ]; then return; fi
 750     local show_list=()
 751     while true; do
 752       local file="$1"; shift
 753       if [ -z "$file" ]; then break; fi
 754       if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
 755       temp_out="$TMP/$file.view"
 756       cat "$file" | python -m json.tool > "$temp_out"
 757       show_list+=($temp_out)
 758       test_or_continue "pretty printing '$file'"
 759     done
 760     filedump "${show_list[@]}"
 761     rm "${show_list[@]}"
 762   }
 763
 764   function json_text()
 765   {
 766     # only print our special headers or text fields.
 767     local CR=$'\r'
 768     local LF=$'\n'
 769     clean_json $* |
 770         grep -i "\"text\":\|^=.*" |
 771         sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
 772   }
 773
 774   ##############
 775
 776   # echoes the machine's hostname.  can be used like so:
 777   #   local my_host=$(get_hostname)
 778   function get_hostname()
 779   {
 780     # there used to be more variation in how to do this, but adopting mingw
 781     # and cygwin tools really helped out.
 782     local this_host=unknown
 783     if [ "$OS" == "Windows_NT" ]; then
 784       this_host=$(hostname)
 785     elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
 786       this_host=$(hostname)
 787     elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
 788       this_host=$(hostname --long)
 789     elif [ -x "$(which hostname 2>/dev/null)" ]; then
 790       this_host=$(hostname)
 791     fi
 792     echo "$this_host"
 793   }
 794
 795   # makes sure that the provided "folder" is a directory and is writable.
 796   function test_writeable()
 797   {
 798     local folder="$1"; shift
 799     if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
 800     return 0
 801   }
 802
 803   ##############
 804
 805   # NOTE: no more function definitions are allowed after this point.
 806
 807   function function_sentinel()
 808   {
 809     return 0;
 810   }
 811
 812   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
 813
 814   ##############
 815
 816   # test code for set_var_if_undefined.
 817   run_test=0
 818   if [ $run_test != 0 ]; then
 819     echo running tests on set_var_if_undefined.
 820     flagrant=petunia
 821     set_var_if_undefined flagrant forknordle
 822     test_or_die "testing if defined variable would be whacked"
 823     if [ $flagrant != petunia ]; then
 824       echo set_var_if_undefined failed to leave the test variable alone
 825       exit 1
 826     fi
 827     unset bobblehead_stomper
 828     set_var_if_undefined bobblehead_stomper endurance
 829     if [ $bobblehead_stomper != endurance ]; then
 830       echo set_var_if_undefined failed to set a variable that was not defined yet
 831       exit 1
 832     fi
 833   fi
 834
 835 fi
 836