3 # This defines some general, useful functions.
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?
9 # test whether we've been here before or not.
11 type function_sentinel &>/dev/null
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."
22 if [ -z "$skip_all" ]; then
24 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
25 echo "feisty meow function definitions beginning now..."
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() {
32 if [ -z "$sep" ]; then sep='_'; fi
33 date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
36 # makes a directory of the name specified and then tries to change the
37 # current directory to that directory.
39 if [ ! -d "$1" ]; then mkdir -p "$1"; fi
44 [[ "$(declare -p $1)" =~ "declare -a" ]]
54 # displays the value of a variable in bash friendly format.
59 local varname="$1"; shift
60 if [ -z "$varname" ]; then
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)"
70 elif [ -z "${!varname}" ]; then
71 echo "$varname undefined"
73 if is_array "$varname"; then
74 #echo found $varname is array var
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.
81 #echo found $varname is simple
82 echo "$varname=${!varname}"
91 # when passed a list of things, this will return the unique items from that list as an echo.
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
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()
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"
113 function success_sound()
115 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
116 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
120 function error_sound()
122 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
123 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
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()
134 # calculate the number of columsn in the terminal.
135 local cols=$(stty size | awk '{print $2}')
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()
146 if [ $? -ne 0 ]; then
147 echo -e "\n\naction failed: $*\n\nExiting script..."
153 # like test_or_die, but will keep going after complaining.
154 function test_or_continue()
156 if [ $? -ne 0 ]; then
157 echo -e "\n\nerror occurred: $*\n\nContinuing script..."
164 # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
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.
172 # we save the value of TERM; we don't want to leave the user's terminal
173 # brain dead once we come back from this function.
174 local oldterm="$TERM"
176 /usr/bin/ssh -X -C "${args[@]}"
177 # restore the terminal variable also.
179 restore_terminal_title
184 # locates a process given a search pattern to match in the process list.
185 # supports a single command line flag style parameter of "-u USERNAME";
186 # if the -u flag is found, a username is expected afterwards, and only the
187 # processes of that user are considered.
189 local -a patterns=("${@}")
191 #echo patterns list is: "${patterns[@]}"
195 if [ "${patterns[0]}" == "-u" ]; then
196 user_flag="-u ${patterns[1]}"
197 #echo "found a -u parm and user=${patterns[1]}"
198 # void the two elements with that user flag so we don't use them as patterns.
199 unset patterns[0] patterns[1]=
205 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
208 if [ "$OS" == "Windows_NT" ]; then
209 # gets cygwin's (god awful) ps to show windoze processes also.
210 local EXTRA_DOZER_FLAGS="-W"
211 # pattern to use for peeling off the process numbers.
212 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
215 # flags which clean up the process listing output on unixes.
216 # apparently cygwin doesn't count as a type of unix, because their
217 # crummy specialized ps command doesn't support normal ps flags.
218 local EXTRA_UNIX_FLAGS="-o pid,args"
219 # pattern to use for peeling off the process numbers.
220 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
223 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
225 #echo got all this stuff in the pid dump file:
229 # search for the pattern the user wants to find, and just pluck the process
230 # ids out of the results.
232 for i in "${patterns[@]}"; do
233 PIDS_SOUGHT+=($(cat $PID_DUMP \
235 | sed -n -e "$pid_finder_pattern"))
238 #echo pids sought list became:
239 #echo "${PIDS_SOUGHT[@]}"
242 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
243 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
245 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
246 echo ${PIDS_SOUGHT[*]}
251 # finds all processes matching the pattern specified and shows their full
252 # process listing (whereas psfind just lists process ids).
255 echo "psa finds processes by pattern, but there was no pattern on the command line."
258 local -a patterns=("${@}")
259 p=$(psfind "${patterns[@]}")
265 if [ "${patterns[0]}" == "-u" ]; then
266 # void the two elements with that user flag so we don't use them as patterns.
267 unset patterns[0] patterns[1]=
271 echo "Processes matching ${patterns[@]}..."
273 if [ -n "$IS_DARWIN" ]; then
276 # only print the header the first time.
277 if [ -z "$fuzil_sentinel" ]; then
280 ps $i -w -u | sed -e '1d'
285 # cases besides mac os x's darwin.
286 if [ "$OS" == "Windows_NT" ]; then
287 # special case for windows.
290 ps -W -p $curr | tail -n +2
293 # normal OSes can handle a nice simple query.
301 #hmmm: holy crowbars, this is an old one. do we ever still have any need of it?
302 # an unfortunately similarly named function to the above 'ps' as in process
303 # methods, but this 'ps' stands for postscript. this takes a postscript file
304 # and converts it into pcl3 printer language and then ships it to the printer.
305 # this mostly makes sense for an environment where one's default printer is
306 # pcl. if the input postscript causes ghostscript to bomb out, there has been
307 # some good success running ps2ps on the input file and using the cleaned
308 # postscript file for printing.
309 function ps2pcl2lpr() {
311 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
315 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
316 # restarts the sound driver.
317 function fix_sound_driver() {
318 # stop bash complaining about blank function body.
321 # sudo service alsasound restart
322 #elif pulse something
333 #hmmm: ugly absolute path here.
335 restore_terminal_title
338 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
339 function unix_to_dos_path() {
340 # we usually remove dos slashes in favor of forward slashes.
342 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
343 # fake this value for non-windows (non-cygwin) platforms.
346 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
347 # insists on the /home form instead of /c/cygwin/home being possible. this is
348 # super frustrating and nightmarish.
349 DOSSYHOME="$(cygpath -am "$HOME")"
352 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
353 # unless this flag is set, in which case we force dos slashes.
354 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 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
360 # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
361 # for the cygwin environment currently.
362 function dos_to_unix_path() {
363 # we always remove dos slashes in favor of forward slashes.
364 #old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
365 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
368 # returns a successful value (0) if this system is debian or ubuntu.
369 function debian_like() {
370 # decide if we think this is debian or ubuntu or a variant.
371 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
372 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
373 if [ $DEBIAN_LIKE -eq 1 ]; then
374 # success; this is debianish.
377 # this seems like some other OS.
382 # su function: makes su perform a login.
383 # for some OSes, this transfers the X authority information to the new login.
386 # debian currently requires the full version which imports X authority
387 # information for su.
389 # get the x authority info for our current user.
390 source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
392 if [ -z "$X_auth_info" ]; then
393 # if there's no authentication info to pass along, we just do a normal su.
396 # under X, we update the new login's authority info with the previous
398 (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
401 # non-debian supposedly doesn't need the extra overhead any more.
402 # or at least suse doesn't, which is the other one we've tested on.
407 # sudo function wraps the normal sudo by ensuring we replace the terminal
408 # label if they're doing an su with the sudo.
413 restore_terminal_title
414 # if [ "$first_command" == "su" ]; then
415 # # yep, they were doing an su, but they're back now.
416 # label_terminal_with_info
421 # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
422 # this kind of assumes you've already checked them for any salient facts.
423 function clean_cvs_junk() {
425 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
429 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
431 local wheres_nechung=$(which nechung 2>/dev/null)
432 if [ -z "$wheres_nechung" ]; then
433 echo "The nechung oracle program cannot be found. You may want to consider"
434 echo "rebuilding the feisty meow applications with this command:"
435 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
442 # recreates all the generated files that the feisty meow scripts use.
443 function regenerate() {
444 # do the bootstrapping process again.
446 echo "regenerating feisty meow script environment."
447 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
449 # force a full reload by turning off sentinel variables and methods.
450 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
451 unalias CORE_ALIASES_LOADED &>/dev/null
452 unset -f function_sentinel
453 # reload feisty meow environment in current shell.
454 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
455 # run nechung oracle to give user a new fortune.
457 restore_terminal_title
460 # copies a set of custom scripts into the proper location for feisty meow
461 # to merge their functions and aliases with the standard set.
462 function recustomize()
464 local custom_user="$1"; shift
465 if [ -z "$custom_user" ]; then
466 # use our default example user if there was no name provided.
472 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
473 echo "The customization folder provided for $custom_user should be:"
474 echo " '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'"
475 echo "but that folder does not exist. Skipping customization."
478 regenerate >/dev/null
479 pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
480 incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
482 local fail_message="\nare the perl dependencies installed? if you're on ubuntu or debian, try this:\n
483 $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n"
485 #echo "the incongruous files list is: $incongruous_files"
486 # disallow a single character result, since we get "*" as result when nothing exists yet.
487 if [ ${#incongruous_files} -ge 2 ]; then
488 echo "cleaning unknown older overrides..."
489 perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
490 test_or_continue "running safedel. $fail_message"
494 echo "copying custom overrides for $custom_user"
495 mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
496 perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
497 test_or_continue "running cpdiff. $fail_message"
499 if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
500 echo "copying custom scripts for $custom_user"
501 netcp "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
502 #hmmm: could save output to show if an error occurs.
507 restore_terminal_title
510 # generates a random password where the first parameter is the number of characters
511 # in the password (default 20) and the second parameter specifies whether to use
512 # special characters (1) or not (0).
513 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
514 function random_password()
516 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
517 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
521 # a wrapper for the which command that finds items on the path. some OSes
522 # do not provide which, so we want to not be spewing errors when that
527 which which &>/dev/null
528 if [ $? -ne 0 ]; then
529 # there is no which command here. we produce nothing due to this.
532 echo $(which $to_find)
535 #hmmm: improve this by not adding the link
536 # if already there, or if the drive is not valid.
537 function add_cygwin_drive_mounts() {
538 for i in c d e f g h q z ; do
539 ln -s /cygdrive/$i $i
543 ############################
545 # takes a file to modify, and then it will replace any occurrences of the
546 # pattern provided as the second parameter with the text in the third
548 function replace_pattern_in_file()
550 local file="$1"; shift
551 local pattern="$1"; shift
552 local replacement="$1"; shift
553 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
554 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
555 echo "text to replace that pattern with."
558 sed -i -e "s%$pattern%$replacement%g" "$file"
561 # similar to replace_pattern_in_file, but also will add the new value
562 # when the old one did not already exist in the file.
563 function replace_if_exists_or_add()
565 local file="$1"; shift
566 local phrase="$1"; shift
567 local replacement="$1"; shift
568 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
569 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
570 echo "text to replace that phrase with."
573 grep "$phrase" "$file" >/dev/null
574 # replace if the phrase is there, otherwise add it.
575 if [ $? -eq 0 ]; then
576 replace_pattern_in_file "$file" "$phrase" "$replacement"
578 # this had better be the complete line.
579 echo "$replacement" >>"$file"
583 ############################
585 # finds a variable (first parameter) in a particular property file
586 # (second parameter). the expected format for the file is:
588 function seek_variable()
590 local find_var="$1"; shift
591 local file="$1"; shift
592 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
593 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
598 if [ ${#line} -eq 0 ]; then continue; fi
599 # split the line into the variable name and value.
600 IFS='=' read -a assignment <<< "$line"
601 local var="${assignment[0]}"
602 local value="${assignment[1]}"
603 if [ "${value:0:1}" == '"' ]; then
604 # assume the entry was in quotes and remove them.
605 value="${value:1:$((${#value} - 2))}"
607 if [ "$find_var" == "$var" ]; then
613 # finds a variable (first parameter) in a particular XML format file
614 # (second parameter). the expected format for the file is:
615 # ... name="varX" value="valueX" ...
616 function seek_variable_in_xml()
618 local find_var="$1"; shift
619 local file="$1"; shift
620 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
621 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
622 echo "secondly an XML file where the variable's value will be sought."
627 if [ ${#line} -eq 0 ]; then continue; fi
628 # process the line to make it more conventional looking.
629 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
630 # split the line into the variable name and value.
631 IFS='=' read -a assignment <<< "$line"
632 local var="${assignment[0]}"
633 local value="${assignment[1]}"
634 if [ "${value:0:1}" == '"' ]; then
635 # assume the entry was in quotes and remove them.
636 value="${value:1:$((${#value} - 2))}"
638 if [ "$find_var" == "$var" ]; then
644 ############################
646 # goes to a particular directory passed as parameter 1, and then removes all
647 # the parameters after that from that directory.
648 function push_whack_pop()
650 local dir="$1"; shift
651 pushd "$dir" &>/dev/null
652 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
653 rm -rf $* &>/dev/null
654 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
660 while [ $# -gt 0 ]; do
662 if [ ! -f "$arg" -a ! -d "$arg" ]; then
663 echo "failure to find a file or directory named '$arg'."
667 # first we will capture the output of the character replacement operation for reporting.
668 # this is done first since some filenames can't be properly renamed in perl (e.g. if they
669 # have pipe characters apparently).
670 intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
671 local saw_intermediate_result=0
672 if [ -z "$intermediate_name" ]; then
673 # make sure we report something, if there are no further name changes.
674 intermediate_name="'$arg'"
676 # now zap the first part of the name off (since original name isn't needed).
677 intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
678 saw_intermediate_result=1
681 # first we rename the file to be lower case.
682 actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
683 final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
684 local saw_final_result=0
685 if [ -z "$final_name" ]; then
686 final_name="$intermediate_name"
688 final_name="$(echo $final_name | sed -e 's/.*=> //')"
691 #echo intermed=$saw_intermediate_result
692 #echo final=$saw_final_result
694 if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
695 # printout the combined operation results.
696 echo "'$arg' => $final_name"
703 # new breed of definer functions goes here. still in progress.
705 # defines an alias and remembers that this is a new or modified definition.
706 # if the feisty meow codebase is unloaded, then so are all the aliases that
708 function define_yeti_alias()
710 # if alias exists already, save old value for restore,
711 # otherwise save null value for restore,
712 # have to handle unaliasing if there was no prior value of one
714 # add alias name to a list of feisty defined aliases.
716 #hmmm: first implem, just do the alias and get that working...
725 #hmmm: this points to an extended functions file being needed; not all of these are core.
727 # displays documentation in "md" formatted files.
730 local file="$1"; shift
731 pandoc "$file" | lynx -stdin
736 # just shows a separator line for an 80 column console, or uses the first
737 # parameter as the number of columns to expect.
741 if [ -z "$count" ]; then
746 for ((i=0; i < $count - 1; i++)); do
752 # alias for separator.
760 # count the number of sub-directories in a directory and echo the result.
761 function count_directories()
763 local appsdir="$1"; shift
764 numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
768 # takes a string and capitalizes just the first character. any capital letters in the remainder of
769 # the string are made lower case. the processed string is returned by an echo.
770 function capitalize_first_char()
772 local to_dromedary="$1"; shift
773 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
777 # given a source path and a target path, this will make a symbolic link from
778 # the source to the destination, but only if the source actually exists.
779 function make_safe_link()
781 local src="$1"; shift
782 local target="$1"; shift
784 if [ -d "$src" ]; then
785 ln -s "$src" "$target"
786 test_or_die "Creating symlink from '$src' to '$target'"
788 echo "Created symlink from '$src' to '$target'."
791 # pretty prints the json files provided as parameters.
792 function clean_json()
794 if [ -z "$*" ]; then return; fi
797 local file="$1"; shift
798 if [ -z "$file" ]; then break; fi
799 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
800 temp_out="$TMP/$file.view"
801 cat "$file" | python -m json.tool > "$temp_out"
802 show_list+=($temp_out)
803 test_or_continue "pretty printing '$file'"
805 filedump "${show_list[@]}"
811 # only print our special headers or text fields.
815 grep -i "\"text\":\|^=.*" |
816 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
821 # echoes the machine's hostname. can be used like so:
822 # local my_host=$(get_hostname)
823 function get_hostname()
825 # there used to be more variation in how to do this, but adopting mingw
826 # and cygwin tools really helped out.
827 local this_host=unknown
828 if [ "$OS" == "Windows_NT" ]; then
829 this_host=$(hostname)
830 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
831 this_host=$(hostname)
832 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
833 this_host=$(hostname --long)
834 elif [ -x "$(which hostname 2>/dev/null)" ]; then
835 this_host=$(hostname)
840 # makes sure that the provided "folder" is a directory and is writable.
841 function test_writeable()
843 local folder="$1"; shift
844 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
850 # NOTE: no more function definitions are allowed after this point.
852 function function_sentinel()
857 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
861 # test code for set_var_if_undefined.
863 if [ $run_test != 0 ]; then
864 echo running tests on set_var_if_undefined.
866 set_var_if_undefined flagrant forknordle
867 test_or_die "testing if defined variable would be whacked"
868 if [ $flagrant != petunia ]; then
869 echo set_var_if_undefined failed to leave the test variable alone
872 unset bobblehead_stomper
873 set_var_if_undefined bobblehead_stomper endurance
874 if [ $bobblehead_stomper != endurance ]; then
875 echo set_var_if_undefined failed to set a variable that was not defined yet