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   # restarts the sound driver.
 311   function fix_sound_driver() {
 312 #if something
 313 #    sudo service alsasound restart
 314 #else
 315     sudo service pulseaudio restart
 316 #fi
 317
 318   }
 319
 320   function screen() {
 321     save_terminal_title
 322 #hmmm: ugly absolute path here.
 323     /usr/bin/screen $*
 324     restore_terminal_title
 325   }
 326
 327   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
 328   function unix_to_dos_path() {
 329     # we usually remove dos slashes in favor of forward slashes.
 330     local DOSSYHOME
 331     if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
 332       # fake this value for non-windows (non-cygwin) platforms.
 333       DOSSYHOME="$HOME"
 334     else
 335       # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
 336       # insists on the /home form instead of /c/cygwin/home being possible.  this is
 337       # super frustrating and nightmarish.
 338       DOSSYHOME="$(cygpath -am "$HOME")"
 339     fi
 340
 341     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
 342       # unless this flag is set, in which case we force dos slashes.
 343       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'
 344     else
 345       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 346     fi
 347   }
 348
 349   # switches from an X:/ form to a /cygdrive/X/path form.  this is only useful
 350   # for the cygwin environment currently.
 351   function dos_to_unix_path() {
 352     # we always remove dos slashes in favor of forward slashes.
 353 #old:    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
 354          echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
 355   }
 356
 357   # returns a successful value (0) if this system is debian or ubuntu.
 358   function debian_like() {
 359     # decide if we think this is debian or ubuntu or a variant.
 360     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
 361         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
 362     if [ $DEBIAN_LIKE -eq 1 ]; then
 363       # success; this is debianish.
 364       return 0
 365     else
 366       # this seems like some other OS.
 367       return 1
 368     fi
 369   }
 370
 371   # su function: makes su perform a login.
 372   # for some OSes, this transfers the X authority information to the new login.
 373   function su() {
 374     if debian_like; then
 375       # debian currently requires the full version which imports X authority
 376       # information for su.
 377
 378       # get the x authority info for our current user.
 379       source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
 380
 381       if [ -z "$X_auth_info" ]; then
 382         # if there's no authentication info to pass along, we just do a normal su.
 383         /bin/su -l $*
 384       else
 385         # under X, we update the new login's authority info with the previous
 386         # user's info.
 387         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 388       fi
 389     else
 390       # non-debian supposedly doesn't need the extra overhead any more.
 391       # or at least suse doesn't, which is the other one we've tested on.
 392       /bin/su -l $*
 393     fi
 394   }
 395
 396   # sudo function wraps the normal sudo by ensuring we replace the terminal
 397   # label if they're doing an su with the sudo.
 398   function sudo() {
 399     save_terminal_title
 400     /usr/bin/sudo "$@"
 401     retval=$?
 402     restore_terminal_title
 403 #    if [ "$first_command" == "su" ]; then
 404 #      # yep, they were doing an su, but they're back now.
 405 #      label_terminal_with_info
 406 #    fi
 407     return $retval
 408   }
 409
 410   # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
 411   # this kind of assumes you've already checked them for any salient facts.
 412   function clean_cvs_junk() {
 413     for i in $*; do
 414       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 415     done
 416   }
 417
 418   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 419   function nechung() {
 420     local wheres_nechung=$(which nechung 2>/dev/null)
 421     if [ -z "$wheres_nechung" ]; then
 422       echo "The nechung oracle program cannot be found.  You may want to consider"
 423       echo "rebuilding the feisty meow applications with this command:"
 424       echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
 425       echo
 426     else
 427       $wheres_nechung
 428     fi
 429   }
 430
 431   # recreates all the generated files that the feisty meow scripts use.
 432   function regenerate() {
 433     # do the bootstrapping process again.
 434     save_terminal_title
 435     echo "regenerating feisty meow script environment."
 436     bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
 437     echo
 438     # force a full reload by turning off sentinel variables and methods.
 439     unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
 440     unalias CORE_ALIASES_LOADED &>/dev/null
 441     unset -f function_sentinel
 442     # reload feisty meow environment in current shell.
 443     source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
 444     # run nechung oracle to give user a new fortune.
 445     nechung
 446     restore_terminal_title
 447   }
 448
 449   # copies a set of custom scripts into the proper location for feisty meow
 450   # to merge their functions and aliases with the standard set.
 451   function recustomize()
 452   {
 453     local custom_user="$1"; shift
 454     if [ -z "$custom_user" ]; then
 455       # use our default example user if there was no name provided.
 456       custom_user=fred
 457     fi
 458
 459     save_terminal_title
 460
 461     if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
 462       echo "The customization folder provided for $custom_user should be:"
 463       echo "  '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'"
 464       echo "but that folder does not exist.  Skipping customization."
 465       return 1
 466     fi
 467     regenerate >/dev/null
 468     pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
 469     incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
 470
 471     local fail_message="\nare the perl dependencies installed?  if you're on ubuntu or debian, try this:\n
 472     $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n"
 473
 474     #echo "the incongruous files list is: $incongruous_files"
 475     # disallow a single character result, since we get "*" as result when nothing exists yet.
 476     if [ ${#incongruous_files} -ge 2 ]; then
 477       echo "cleaning unknown older overrides..."
 478       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
 479       test_or_continue "running safedel.  $fail_message"
 480       echo
 481     fi
 482     popd &>/dev/null
 483     echo "copying custom overrides for $custom_user"
 484     mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
 485     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
 486     test_or_continue "running cpdiff.  $fail_message"
 487
 488     if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
 489       echo "copying custom scripts for $custom_user"
 490       netcp "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
 491 #hmmm: could save output to show if an error occurs.
 492     fi
 493     echo
 494     regenerate
 495
 496     restore_terminal_title
 497   }
 498
 499   # generates a random password where the first parameter is the number of characters
 500   # in the password (default 20) and the second parameter specifies whether to use
 501   # special characters (1) or not (0).
 502   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
 503   function random_password()
 504   {
 505     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 506     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 507     echo
 508   }
 509
 510   # a wrapper for the which command that finds items on the path.  some OSes
 511   # do not provide which, so we want to not be spewing errors when that
 512   # happens.
 513   function whichable()
 514   {
 515     to_find="$1"; shift
 516     which which &>/dev/null
 517     if [ $? -ne 0 ]; then
 518       # there is no which command here.  we produce nothing due to this.
 519       echo
 520     fi
 521     echo $(which $to_find)
 522   }
 523
 524 #hmmm: improve this by not adding the link
 525 # if already there, or if the drive is not valid.
 526   function add_cygwin_drive_mounts() {
 527     for i in c d e f g h q z ; do
 528       ln -s /cygdrive/$i $i
 529     done
 530   }
 531
 532   ############################
 533
 534   # takes a file to modify, and then it will replace any occurrences of the
 535   # pattern provided as the second parameter with the text in the third
 536   # parameter.
 537   function replace_pattern_in_file()
 538   {
 539     local file="$1"; shift
 540     local pattern="$1"; shift
 541     local replacement="$1"; shift
 542     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
 543       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
 544       echo "text to replace that pattern with."
 545       return 1
 546     fi
 547     sed -i -e "s%$pattern%$replacement%g" "$file"
 548   }
 549
 550   # similar to replace_pattern_in_file, but also will add the new value
 551   # when the old one did not already exist in the file.
 552   function replace_if_exists_or_add()
 553   {
 554     local file="$1"; shift
 555     local phrase="$1"; shift
 556     local replacement="$1"; shift
 557     if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
 558       echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
 559       echo "text to replace that phrase with."
 560       return 1
 561     fi
 562     grep "$phrase" "$file" >/dev/null
 563     # replace if the phrase is there, otherwise add it.
 564     if [ $? -eq 0 ]; then
 565       replace_pattern_in_file "$file" "$phrase" "$replacement"
 566     else
 567       # this had better be the complete line.
 568       echo "$replacement" >>"$file"
 569     fi
 570   }
 571
 572   ############################
 573
 574   # finds a variable (first parameter) in a particular property file
 575   # (second parameter).  the expected format for the file is:
 576   # varX=valueX
 577   function seek_variable()
 578   {
 579     local find_var="$1"; shift
 580     local file="$1"; shift
 581     if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
 582       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
 583       return 1
 584     fi
 585
 586     while read line; do
 587       if [ ${#line} -eq 0 ]; then continue; fi
 588       # split the line into the variable name and value.
 589       IFS='=' read -a assignment <<< "$line"
 590       local var="${assignment[0]}"
 591       local value="${assignment[1]}"
 592       if [ "${value:0:1}" == '"' ]; then
 593         # assume the entry was in quotes and remove them.
 594         value="${value:1:$((${#value} - 2))}"
 595       fi
 596       if [ "$find_var" == "$var" ]; then
 597         echo "$value"
 598       fi
 599     done < "$file"
 600   }
 601
 602   # finds a variable (first parameter) in a particular XML format file
 603   # (second parameter).  the expected format for the file is:
 604   # ... name="varX" value="valueX" ...
 605   function seek_variable_in_xml()
 606   {
 607     local find_var="$1"; shift
 608     local file="$1"; shift
 609     if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
 610       echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
 611       echo "secondly an XML file where the variable's value will be sought."
 612       return 1
 613     fi
 614
 615     while read line; do
 616       if [ ${#line} -eq 0 ]; then continue; fi
 617       # process the line to make it more conventional looking.
 618       line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
 619       # split the line into the variable name and value.
 620       IFS='=' read -a assignment <<< "$line"
 621       local var="${assignment[0]}"
 622       local value="${assignment[1]}"
 623       if [ "${value:0:1}" == '"' ]; then
 624         # assume the entry was in quotes and remove them.
 625         value="${value:1:$((${#value} - 2))}"
 626       fi
 627       if [ "$find_var" == "$var" ]; then
 628         echo "$value"
 629       fi
 630     done < "$file"
 631   }
 632
 633   ############################
 634
 635   # goes to a particular directory passed as parameter 1, and then removes all
 636   # the parameters after that from that directory.
 637   function push_whack_pop()
 638   {
 639     local dir="$1"; shift
 640     pushd "$dir" &>/dev/null
 641     if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
 642     rm -rf $* &>/dev/null
 643     if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
 644     popd &>/dev/null
 645   }
 646
 647   function spacem()
 648   {
 649     while [ $# -gt 0 ]; do
 650       arg="$1"; shift
 651       if [ ! -f "$arg" -a ! -d "$arg" ]; then
 652         echo "failure to find a file or directory named '$arg'."
 653         continue
 654       fi
 655
 656       # first we will capture the output of the character replacement operation for reporting.
 657       # this is done first since some filenames can't be properly renamed in perl (e.g. if they
 658       # have pipe characters apparently).
 659       intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
 660       local saw_intermediate_result=0
 661       if [ -z "$intermediate_name" ]; then
 662         # make sure we report something, if there are no further name changes.
 663         intermediate_name="'$arg'"
 664       else
 665         # now zap the first part of the name off (since original name isn't needed).
 666         intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
 667         saw_intermediate_result=1
 668       fi
 669
 670       # first we rename the file to be lower case.
 671       actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
 672       final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
 673       local saw_final_result=0
 674       if [ -z "$final_name" ]; then
 675         final_name="$intermediate_name"
 676       else
 677         final_name="$(echo $final_name | sed -e 's/.*=> //')"
 678         saw_final_result=1
 679       fi
 680 #echo intermed=$saw_intermediate_result
 681 #echo final=$saw_final_result
 682
 683       if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
 684         # printout the combined operation results.
 685         echo "'$arg' => $final_name"
 686       fi
 687     done
 688   }
 689
 690   ##############
 691
 692 # new breed of definer functions goes here.  still in progress.
 693
 694   # defines an alias and remembers that this is a new or modified definition.
 695   # if the feisty meow codebase is unloaded, then so are all the aliases that
 696   # were defined.
 697   function define_yeti_alias()
 698   {
 699 # if alias exists already, save old value for restore,
 700 # otherwise save null value for restore,
 701 # have to handle unaliasing if there was no prior value of one
 702 # we newly defined.
 703 # add alias name to a list of feisty defined aliases.
 704
 705 #hmmm: first implem, just do the alias and get that working...
 706 alias "${@}"
 707
 708
 709 return 0
 710   }
 711
 712   ##############
 713
 714 #hmmm: this points to an extended functions file being needed; not all of these are core.
 715
 716   # displays documentation in "md" formatted files.
 717   function show_md()
 718   {
 719     local file="$1"; shift
 720     pandoc "$file" | lynx -stdin
 721   }
 722
 723   ##############
 724
 725   # just shows a separator line for an 80 column console, or uses the first
 726   # parameter as the number of columns to expect.
 727   function separator()
 728   {
 729     count=$1; shift
 730     if [ -z "$count" ]; then
 731       count=79
 732     fi
 733     echo
 734     local i
 735     for ((i=0; i < $count - 1; i++)); do
 736       echo -n "="
 737     done
 738     echo
 739     echo
 740   }
 741   # alias for separator.
 742   function sep()
 743   {
 744     separator $*
 745   }
 746
 747   ##############
 748
 749   # count the number of sub-directories in a directory and echo the result.
 750   function count_directories()
 751   {
 752     local appsdir="$1"; shift
 753     numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
 754     echo $numdirs
 755   }
 756
 757   # takes a string and capitalizes just the first character.  any capital letters in the remainder of
 758   # the string are made lower case.  the processed string is returned by an echo.
 759   function capitalize_first_char()
 760   {
 761     local to_dromedary="$1"; shift
 762     to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
 763     echo "$to_dromedary"
 764   }
 765
 766   # given a source path and a target path, this will make a symbolic link from
 767   # the source to the destination, but only if the source actually exists.
 768   function make_safe_link()
 769   {
 770     local src="$1"; shift
 771     local target="$1"; shift
 772
 773     if [ -d "$src" ]; then
 774       ln -s "$src" "$target"
 775       test_or_die "Creating symlink from '$src' to '$target'"
 776     fi
 777     echo "Created symlink from '$src' to '$target'."
 778   }
 779
 780   # pretty prints the json files provided as parameters.
 781   function clean_json()
 782   {
 783     if [ -z "$*" ]; then return; fi
 784     local show_list=()
 785     while true; do
 786       local file="$1"; shift
 787       if [ -z "$file" ]; then break; fi
 788       if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
 789       temp_out="$TMP/$file.view"
 790       cat "$file" | python -m json.tool > "$temp_out"
 791       show_list+=($temp_out)
 792       test_or_continue "pretty printing '$file'"
 793     done
 794     filedump "${show_list[@]}"
 795     rm "${show_list[@]}"
 796   }
 797
 798   function json_text()
 799   {
 800     # only print our special headers or text fields.
 801     local CR=$'\r'
 802     local LF=$'\n'
 803     clean_json $* |
 804         grep -i "\"text\":\|^=.*" |
 805         sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
 806   }
 807
 808   ##############
 809
 810   # echoes the machine's hostname.  can be used like so:
 811   #   local my_host=$(get_hostname)
 812   function get_hostname()
 813   {
 814     # there used to be more variation in how to do this, but adopting mingw
 815     # and cygwin tools really helped out.
 816     local this_host=unknown
 817     if [ "$OS" == "Windows_NT" ]; then
 818       this_host=$(hostname)
 819     elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
 820       this_host=$(hostname)
 821     elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
 822       this_host=$(hostname --long)
 823     elif [ -x "$(which hostname 2>/dev/null)" ]; then
 824       this_host=$(hostname)
 825     fi
 826     echo "$this_host"
 827   }
 828
 829   # makes sure that the provided "folder" is a directory and is writable.
 830   function test_writeable()
 831   {
 832     local folder="$1"; shift
 833     if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
 834     return 0
 835   }
 836
 837   ##############
 838
 839   # NOTE: no more function definitions are allowed after this point.
 840
 841   function function_sentinel()
 842   {
 843     return 0;
 844   }
 845
 846   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
 847
 848   ##############
 849
 850   # test code for set_var_if_undefined.
 851   run_test=0
 852   if [ $run_test != 0 ]; then
 853     echo running tests on set_var_if_undefined.
 854     flagrant=petunia
 855     set_var_if_undefined flagrant forknordle
 856     test_or_die "testing if defined variable would be whacked"
 857     if [ $flagrant != petunia ]; then
 858       echo set_var_if_undefined failed to leave the test variable alone
 859       exit 1
 860     fi
 861     unset bobblehead_stomper
 862     set_var_if_undefined bobblehead_stomper endurance
 863     if [ $bobblehead_stomper != endurance ]; then
 864       echo set_var_if_undefined failed to set a variable that was not defined yet
 865       exit 1
 866     fi
 867   fi
 868
 869 fi
 870