scripts/core/functions.sh

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