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