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