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 #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"
177 /usr/bin/ssh -X -C "${args[@]}"
178 # # restore the terminal variable also.
180 restore_terminal_title
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.
190 local -a patterns=("${@}")
192 #echo patterns list is: "${patterns[@]}"
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]=
206 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
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'
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'
224 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
226 #echo got all this stuff in the pid dump file:
230 # search for the pattern the user wants to find, and just pluck the process
231 # ids out of the results.
233 for i in "${patterns[@]}"; do
234 PIDS_SOUGHT+=($(cat $PID_DUMP \
236 | sed -n -e "$pid_finder_pattern"))
239 #echo pids sought list became:
240 #echo "${PIDS_SOUGHT[@]}"
243 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
244 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
246 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
247 echo ${PIDS_SOUGHT[*]}
252 # finds all processes matching the pattern specified and shows their full
253 # process listing (whereas psfind just lists process ids).
256 echo "psa finds processes by pattern, but there was no pattern on the command line."
259 local -a patterns=("${@}")
260 p=$(psfind "${patterns[@]}")
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]=
272 echo "Processes matching ${patterns[@]}..."
274 if [ -n "$IS_DARWIN" ]; then
277 # only print the header the first time.
278 if [ -z "$fuzil_sentinel" ]; then
281 ps $i -w -u | sed -e '1d'
286 # cases besides mac os x's darwin.
287 if [ "$OS" == "Windows_NT" ]; then
288 # special case for windows.
291 ps -W -p $curr | tail -n +2
294 # normal OSes can handle a nice simple query.
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() {
312 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
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.
322 # sudo service alsasound restart
323 #elif pulse something
334 #hmmm: ugly absolute path here.
336 restore_terminal_title
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.
343 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
344 # fake this value for non-windows (non-cygwin) platforms.
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")"
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'
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/'
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/'
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.
378 # this seems like some other OS.
383 # su function: makes su perform a login.
384 # for some OSes, this transfers the X authority information to the new login.
387 # debian currently requires the full version which imports X authority
388 # information for su.
390 # get the x authority info for our current user.
391 source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
393 if [ -z "$X_auth_info" ]; then
394 # if there's no authentication info to pass along, we just do a normal su.
397 # under X, we update the new login's authority info with the previous
399 (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
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.
408 # sudo function wraps the normal sudo by ensuring we replace the terminal
409 # label if they're doing an su with the sudo.
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
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() {
426 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
430 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
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"
443 # recreates all the generated files that the feisty meow scripts use.
444 function regenerate() {
445 # do the bootstrapping process again.
447 echo "regenerating feisty meow script environment."
448 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
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.
458 restore_terminal_title
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()
465 local custom_user="$1"; shift
466 if [ -z "$custom_user" ]; then
467 # use our default example user if there was no name provided.
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."
480 # prevent permission foul-ups.
481 chown -R "$(logname):$(logname)" "$FEISTY_MEOW_LOADING_DOCK"/* "$FEISTY_MEOW_GENERATED_STORE"/*
483 regenerate >/dev/null
484 pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
485 incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
487 local fail_message="\nare the perl dependencies installed? if you're on ubuntu or debian, try this:\n
488 $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n"
490 #echo "the incongruous files list is: $incongruous_files"
491 # disallow a single character result, since we get "*" as result when nothing exists yet.
492 if [ ${#incongruous_files} -ge 2 ]; then
493 echo "cleaning unknown older overrides..."
494 perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
495 test_or_continue "running safedel. $fail_message"
499 echo "copying custom overrides for $custom_user"
500 mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
501 perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
502 test_or_continue "running cpdiff. $fail_message"
504 if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
505 echo "copying custom scripts for $custom_user"
506 netcp "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
507 #hmmm: could save output to show if an error occurs.
512 # prevent permission foul-ups, again.
513 chown -R "$(logname):$(logname)" "$FEISTY_MEOW_LOADING_DOCK" "$FEISTY_MEOW_GENERATED_STORE"
515 restore_terminal_title
518 # generates a random password where the first parameter is the number of characters
519 # in the password (default 20) and the second parameter specifies whether to use
520 # special characters (1) or not (0).
521 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
522 function random_password()
524 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
525 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
529 # a wrapper for the which command that finds items on the path. some OSes
530 # do not provide which, so we want to not be spewing errors when that
535 which which &>/dev/null
536 if [ $? -ne 0 ]; then
537 # there is no which command here. we produce nothing due to this.
540 echo $(which $to_find)
543 #hmmm: improve this by not adding the link
544 # if already there, or if the drive is not valid.
545 function add_cygwin_drive_mounts() {
546 for i in c d e f g h q z ; do
547 ln -s /cygdrive/$i $i
551 ############################
553 # takes a file to modify, and then it will replace any occurrences of the
554 # pattern provided as the second parameter with the text in the third
556 function replace_pattern_in_file()
558 local file="$1"; shift
559 local pattern="$1"; shift
560 local replacement="$1"; shift
561 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
562 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
563 echo "text to replace that pattern with."
566 sed -i -e "s%$pattern%$replacement%g" "$file"
569 # similar to replace_pattern_in_file, but also will add the new value
570 # when the old one did not already exist in the file.
571 function replace_if_exists_or_add()
573 local file="$1"; shift
574 local phrase="$1"; shift
575 local replacement="$1"; shift
576 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
577 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
578 echo "text to replace that phrase with."
581 grep "$phrase" "$file" >/dev/null
582 # replace if the phrase is there, otherwise add it.
583 if [ $? -eq 0 ]; then
584 replace_pattern_in_file "$file" "$phrase" "$replacement"
586 # this had better be the complete line.
587 echo "$replacement" >>"$file"
591 ############################
593 # finds a variable (first parameter) in a particular property file
594 # (second parameter). the expected format for the file is:
596 function seek_variable()
598 local find_var="$1"; shift
599 local file="$1"; shift
600 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
601 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
606 if [ ${#line} -eq 0 ]; then continue; fi
607 # split the line into the variable name and value.
608 IFS='=' read -a assignment <<< "$line"
609 local var="${assignment[0]}"
610 local value="${assignment[1]}"
611 if [ "${value:0:1}" == '"' ]; then
612 # assume the entry was in quotes and remove them.
613 value="${value:1:$((${#value} - 2))}"
615 if [ "$find_var" == "$var" ]; then
621 # finds a variable (first parameter) in a particular XML format file
622 # (second parameter). the expected format for the file is:
623 # ... name="varX" value="valueX" ...
624 function seek_variable_in_xml()
626 local find_var="$1"; shift
627 local file="$1"; shift
628 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
629 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
630 echo "secondly an XML file where the variable's value will be sought."
635 if [ ${#line} -eq 0 ]; then continue; fi
636 # process the line to make it more conventional looking.
637 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
638 # split the line into the variable name and value.
639 IFS='=' read -a assignment <<< "$line"
640 local var="${assignment[0]}"
641 local value="${assignment[1]}"
642 if [ "${value:0:1}" == '"' ]; then
643 # assume the entry was in quotes and remove them.
644 value="${value:1:$((${#value} - 2))}"
646 if [ "$find_var" == "$var" ]; then
652 ############################
654 # goes to a particular directory passed as parameter 1, and then removes all
655 # the parameters after that from that directory.
656 function push_whack_pop()
658 local dir="$1"; shift
659 pushd "$dir" &>/dev/null
660 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
661 rm -rf $* &>/dev/null
662 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
668 while [ $# -gt 0 ]; do
670 if [ ! -f "$arg" -a ! -d "$arg" ]; then
671 echo "failure to find a file or directory named '$arg'."
675 # first we will capture the output of the character replacement operation for reporting.
676 # this is done first since some filenames can't be properly renamed in perl (e.g. if they
677 # have pipe characters apparently).
678 intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
679 local saw_intermediate_result=0
680 if [ -z "$intermediate_name" ]; then
681 # make sure we report something, if there are no further name changes.
682 intermediate_name="'$arg'"
684 # now zap the first part of the name off (since original name isn't needed).
685 intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
686 saw_intermediate_result=1
689 # first we rename the file to be lower case.
690 actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
691 final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
692 local saw_final_result=0
693 if [ -z "$final_name" ]; then
694 final_name="$intermediate_name"
696 final_name="$(echo $final_name | sed -e 's/.*=> //')"
699 #echo intermed=$saw_intermediate_result
700 #echo final=$saw_final_result
702 if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
703 # printout the combined operation results.
704 echo "'$arg' => $final_name"
711 # new breed of definer functions goes here. still in progress.
713 # defines an alias and remembers that this is a new or modified definition.
714 # if the feisty meow codebase is unloaded, then so are all the aliases that
716 function define_yeti_alias()
718 # if alias exists already, save old value for restore,
719 # otherwise save null value for restore,
720 # have to handle unaliasing if there was no prior value of one
722 # add alias name to a list of feisty defined aliases.
724 #hmmm: first implem, just do the alias and get that working...
733 #hmmm: this points to an extended functions file being needed; not all of these are core.
735 # displays documentation in "md" formatted files.
738 local file="$1"; shift
739 pandoc "$file" | lynx -stdin
744 # just shows a separator line for an 80 column console, or uses the first
745 # parameter as the number of columns to expect.
749 if [ -z "$count" ]; then
754 for ((i=0; i < $count - 1; i++)); do
760 # alias for separator.
768 # count the number of sub-directories in a directory and echo the result.
769 function count_directories()
771 local appsdir="$1"; shift
772 numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
776 # takes a string and capitalizes just the first character. any capital letters in the remainder of
777 # the string are made lower case. the processed string is returned by an echo.
778 function capitalize_first_char()
780 local to_dromedary="$1"; shift
781 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
785 # given a source path and a target path, this will make a symbolic link from
786 # the source to the destination, but only if the source actually exists.
787 function make_safe_link()
789 local src="$1"; shift
790 local target="$1"; shift
792 if [ -d "$src" ]; then
793 ln -s "$src" "$target"
794 test_or_die "Creating symlink from '$src' to '$target'"
796 echo "Created symlink from '$src' to '$target'."
799 # pretty prints the json files provided as parameters.
800 function clean_json()
802 if [ -z "$*" ]; then return; fi
805 local file="$1"; shift
806 if [ -z "$file" ]; then break; fi
807 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
808 temp_out="$TMP/$file.view"
809 cat "$file" | python -m json.tool > "$temp_out"
810 show_list+=($temp_out)
811 test_or_continue "pretty printing '$file'"
813 filedump "${show_list[@]}"
819 # only print our special headers or text fields.
823 grep -i "\"text\":\|^=.*" |
824 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
829 # echoes the machine's hostname. can be used like so:
830 # local my_host=$(get_hostname)
831 function get_hostname()
833 # there used to be more variation in how to do this, but adopting mingw
834 # and cygwin tools really helped out.
835 local this_host=unknown
836 if [ "$OS" == "Windows_NT" ]; then
837 this_host=$(hostname)
838 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
839 this_host=$(hostname)
840 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
841 this_host=$(hostname --long)
842 elif [ -x "$(which hostname 2>/dev/null)" ]; then
843 this_host=$(hostname)
848 # makes sure that the provided "folder" is a directory and is writable.
849 function test_writeable()
851 local folder="$1"; shift
852 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
858 # given a filename and a string to seek and a number of lines, then this
859 # function will remove the first occurrence of a line in the file that
860 # matches the string, and it will also axe the next N lines as specified.
861 function create_chomped_copy_of_file()
863 local filename="$1"; shift
864 local seeker="$1"; shift
865 local numlines=$1; shift
867 #echo into create_chomped_copy...
868 #var filename seeker numlines
870 # make a backup first, oy.
871 \cp -f "$filename" "$filename.bkup-${RANDOM}"
872 test_or_die "backing up file: $filename"
874 # make a temp file to write to before we move file into place in bind.
875 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
876 \rm -f "$new_version"
877 test_or_die "cleaning out new version of file from: $new_version"
883 # don't bother looking at the lines if we're already in skip mode.
884 if [[ $skip_count == 0 ]]; then
885 # find the string they're seeking.
886 if [[ ! "$line" =~ .*${seeker}.* ]]; then
888 echo "$line" >> "$new_version"
890 # a match! start skipping. we will delete this line and the next N lines.
892 #echo first skip count is now $skip_count
896 # we're already skipping. let's keep going until we hit the limit.
898 #echo ongoing skip count is now $skip_count
899 if (( $skip_count > $numlines )); then
900 echo "Done skipping, and back to writing output file."
906 #echo file we created looks like this:
909 if [ ! -z "$found_any" ]; then
910 # put the file back into place under the original name.
911 \mv "$new_version" "$filename"
912 test_or_die "moving the new version into place in: $filename"
914 # cannot always be considered an error, but we can at least gripe.
915 echo "Did not find any matches for seeker '$seeker' in file: $filename"
921 # NOTE: no more function definitions are allowed after this point.
923 function function_sentinel()
928 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
932 # test code for set_var_if_undefined.
934 if [ $run_test != 0 ]; then
935 echo running tests on set_var_if_undefined.
937 set_var_if_undefined flagrant forknordle
938 test_or_die "testing if defined variable would be whacked"
939 if [ $flagrant != petunia ]; then
940 echo set_var_if_undefined failed to leave the test variable alone
943 unset bobblehead_stomper
944 set_var_if_undefined bobblehead_stomper endurance
945 if [ $bobblehead_stomper != endurance ]; then
946 echo set_var_if_undefined failed to set a variable that was not defined yet