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