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