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