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