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