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 # a wrapper for the which command that finds items on the path. some OSes
37 # do not provide which, so we want to not be spewing errors when that
42 local WHICHER="$(\which which 2>/dev/null)"
44 # there is no which command here. we produce nothing due to this.
47 echo $($WHICHER $to_find 2>/dev/null)
50 # makes a directory of the name specified and then tries to change the
51 # current directory to that directory.
53 if [ ! -d "$1" ]; then mkdir -p "$1"; fi
57 # returns true if the variable is an array.
59 [[ "$(declare -p $1)" =~ "declare -a" ]]
62 # returns true if the name provided is a defined alias.
68 # makes the status of pipe number N (passed as first parameter) into the
69 # main return value (i.e., the value for $?). this is super handy to avoid
70 # repeating the awkward looking code below in multiple places.
71 function promote_pipe_return()
73 ( exit ${PIPESTATUS[$1]} )
78 function fm_username()
80 # see if we can get the user name from the login name. oddly this sometimes doesn't work.
81 local custom_user="$(logname 2>/dev/null)"
82 if [ -z "$custom_user" ]; then
83 # try the normal unix user variable.
86 if [ -z "$custom_user" ]; then
87 # try the windows user variable.
88 custom_user="$USERNAME"
95 # displays the value of a variable in bash friendly format.
100 local varname="$1"; shift
101 if [ -z "$varname" ]; then
105 if is_alias "$varname"; then
106 #echo found $varname is alias
107 local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
108 alias $varname | sed -e 's/.*=//' >$tmpfile
109 echo "alias $varname=$(cat $tmpfile)"
111 elif [ -z "${!varname}" ]; then
112 echo "$varname undefined"
114 if is_array "$varname"; then
115 #echo found $varname is array var
117 eval temparray="(\${$varname[@]})"
118 echo "$varname=(${temparray[@]})"
119 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
120 # see ones that have spaces in them.
122 #echo found $varname is simple
123 echo "$varname=${!varname}"
132 # when passed a list of things, this will return the unique items from that list as an echo.
135 # do the uniquification: split the space separated items into separate lines, then
136 # sort the list, then run the uniq tool on the list. results will be packed back onto
137 # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
138 echo $* | tr ' ' '\n' | sort | uniq
141 # sets the variable in parameter 1 to the value in parameter 2, but only if
142 # that variable was undefined.
143 function set_var_if_undefined()
145 local var_name="$1"; shift
146 local var_value="$1"; shift
147 if [ -z "${!var_name}" ]; then
148 eval export $var_name="$var_value"
154 function success_sound()
156 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
157 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
161 function error_sound()
163 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
164 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
170 # echoes the maximum number of columns that the terminal supports. usually
171 # anything you print to the terminal with length less than (but not equal to)
172 # maxcols will never wrap.
173 function get_maxcols()
175 # calculate the number of columsn in the terminal.
176 local cols=$(stty size | awk '{print $2}')
182 # checks the result of the last command that was run, and if that failed,
183 # then this complains and exits from bash. the function parameters are
184 # used as the message to print as a complaint.
185 function exit_on_error()
187 if [ $? -ne 0 ]; then
188 echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..."
194 # like exit_on_error, but will keep going after complaining.
195 function continue_on_error()
197 if [ $? -ne 0 ]; then
198 echo -e "\n\na problem occurred, but we can continue:\n\n$*\n\n=> Continuing script..."
205 # accepts any number of arguments and outputs them to the feisty meow event log.
206 function log_feisty_meow_event()
208 echo -e "$(date_stringer) -- ${USER}@$(hostname): $*" >> "$FEISTY_MEOW_EVENT_LOG"
213 # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
217 # we remember the old terminal title, then force the TERM variable to a more generic
218 # version for the other side (just 'linux'); we don't want the remote side still
219 # thinking it's running xterm.
222 #hmmm: why were we doing this? it scorches the user's logged in session, leaving it without proper terminal handling.
223 # # we save the value of TERM; we don't want to leave the user's terminal
224 # # brain dead once we come back from this function.
225 # local oldterm="$TERM"
228 /usr/bin/ssh -Y -C "${args[@]}"
230 # # restore the terminal variable also.
233 restore_terminal_title
234 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
235 echo TERM title restored to prior value
241 # locates a process given a search pattern to match in the process list.
242 # supports a single command line flag style parameter of "-u USERNAME";
243 # if the -u flag is found, a username is expected afterwards, and only the
244 # processes of that user are considered.
246 local -a patterns=("${@}")
248 #echo patterns list is: "${patterns[@]}"
252 if [ "${patterns[0]}" == "-u" ]; then
253 user_flag="-u ${patterns[1]}"
254 #echo "found a -u parm and user=${patterns[1]}"
255 # void the two elements with that user flag so we don't use them as patterns.
256 unset patterns[0] patterns[1]=
262 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
265 if [ "$OS" == "Windows_NT" ]; then
266 # gets cygwin's (god awful) ps to show windoze processes also.
267 local EXTRA_DOZER_FLAGS="-W"
268 # pattern to use for peeling off the process numbers.
269 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
272 # flags which clean up the process listing output on unixes.
273 # apparently cygwin doesn't count as a type of unix, because their
274 # crummy specialized ps command doesn't support normal ps flags.
275 local EXTRA_UNIX_FLAGS="-o pid,args"
276 # pattern to use for peeling off the process numbers.
277 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
280 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
282 #echo got all this stuff in the pid dump file:
286 # search for the pattern the user wants to find, and just pluck the process
287 # ids out of the results.
289 for i in "${patterns[@]}"; do
290 PIDS_SOUGHT+=($(cat $PID_DUMP \
292 | sed -n -e "$pid_finder_pattern"))
295 #echo pids sought list became:
296 #echo "${PIDS_SOUGHT[@]}"
299 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
300 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
302 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
303 echo ${PIDS_SOUGHT[*]}
308 # finds all processes matching the pattern specified and shows their full
309 # process listing (whereas psfind just lists process ids).
312 echo "psa finds processes by pattern, but there was no pattern on the command line."
315 local -a patterns=("${@}")
316 p=$(psfind "${patterns[@]}")
322 if [ "${patterns[0]}" == "-u" ]; then
323 # void the two elements with that user flag so we don't use them as patterns.
324 unset patterns[0] patterns[1]=
328 echo "Processes matching ${patterns[@]}..."
330 if [ -n "$IS_DARWIN" ]; then
333 # only print the header the first time.
334 if [ -z "$fuzil_sentinel" ]; then
337 ps $i -w -u | sed -e '1d'
342 # cases besides mac os x's darwin.
343 if [ "$OS" == "Windows_NT" ]; then
344 # special case for windows.
347 ps -W -p $curr | tail -n +2
350 # normal OSes can handle a nice simple query.
358 #hmmm: holy crowbars, this is an old one. do we ever still have any need of it?
359 # an unfortunately similarly named function to the above 'ps' as in process
360 # methods, but this 'ps' stands for postscript. this takes a postscript file
361 # and converts it into pcl3 printer language and then ships it to the printer.
362 # this mostly makes sense for an environment where one's default printer is
363 # pcl. if the input postscript causes ghostscript to bomb out, there has been
364 # some good success running ps2ps on the input file and using the cleaned
365 # postscript file for printing.
366 function ps2pcl2lpr() {
368 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
374 #hmmm: ugly absolute path here.
376 restore_terminal_title
379 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
380 function unix_to_dos_path() {
381 # we usually remove dos slashes in favor of forward slashes.
383 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
384 # fake this value for non-windows (non-cygwin) platforms.
387 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
388 # insists on the /home form instead of /c/cygwin/home being possible. this is
389 # super frustrating and nightmarish.
390 DOSSYHOME="$(cygpath -am "$HOME")"
393 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
394 # unless this flag is set, in which case we force dos slashes.
395 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'
397 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
401 # # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
402 # # for the cygwin environment currently.
403 # function dos_to_unix_path() {
404 # # we always remove dos slashes in favor of forward slashes.
405 ##old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
406 # echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
409 # returns a successful value (0) if this system is debian or ubuntu.
410 function debian_like() {
411 # decide if we think this is debian or ubuntu or a variant.
412 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
413 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
414 if [ $DEBIAN_LIKE -eq 1 ]; then
415 # success; this is debianish.
418 # this seems like some other OS.
423 # this function wraps the normal sudo by ensuring we replace the terminal
424 # label before we launch what they're passing to sudo. we also preserve
425 # specific variables that enable the main user's ssh credentials to still
426 # be relied on for ssh forwarding, even if the '-i' flag is passed to cause
427 # a fresh shell (which normally doesn't get the launching user's environment
432 # hoist our X authorization info in case environment is passed along;
433 # this can allow root to use our display to show X.org windows.
434 if [ -z "$IMPORTED_XAUTH" -a ! -z "$DISPLAY" ]; then
435 export IMPORTED_XAUTH="$(xauth list $DISPLAY | head -n 1 | awk '{print $3}')"
436 local REMOVE_IMP_XAUTH=true
439 # launch sudo with just the variables we want to reach the other side.
440 # we take an extra step to null out the PATH, since MacOS seems to want
441 # to pass that even for a login shell (-i) somehow.
442 PATH= /usr/bin/sudo --preserve-env=SSH_AUTH_SOCK,IMPORTED_XAUTH "$@"
445 # take the xauth info away again if it wasn't set already.
446 if [ ! -z "$REMOVE_IMP_XAUTH" ]; then
449 restore_terminal_title
453 # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
454 # this kind of assumes you've already checked them for any salient facts.
455 function clean_cvs_junk() {
457 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
461 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
463 local wheres_nechung=$(whichable nechung)
464 if [ -z "$wheres_nechung" ]; then
465 echo "The nechung oracle program cannot be found. You may want to consider"
466 echo "rebuilding the feisty meow applications with this command:"
467 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
474 # recreates all the generated files that the feisty meow scripts use.
475 function regenerate() {
476 # do the bootstrapping process again.
478 echo "regenerating feisty meow script environment."
479 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
481 # force a full reload by turning off sentinel variables and methods.
482 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
483 unalias CORE_ALIASES_LOADED &>/dev/null
484 unset -f function_sentinel
485 # reload feisty meow environment in current shell.
486 log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell."
487 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
488 # run nechung oracle to give user a new fortune.
490 restore_terminal_title
493 # merges a set of custom scripts into the feisty meow environment. can be
494 # passed a name to use as the custom scripts source folder (found on path
495 # $FEISTY_MEOW_SCRIPTS/customize/{name}), or it will try to guess the name
496 # by using the login name.
497 function recustomize()
499 local custom_user="$1"; shift
500 if [ -z "$custom_user" ]; then
501 # default to login name if there was no name provided.
502 custom_user="$(fm_username)"
503 # we do intend to use the login name here to get the login name and to ignore
504 # if the user has sudo root access; we don't want to provide a custom
507 # chop off any email address style formatting to leave just the name.
508 custom_user="$(echo "$custom_user" | cut -f1 -d'@')"
512 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
513 echo -e "the customization folder for '$custom_user' is missing:
515 $FEISTY_MEOW_SCRIPTS/customize/$custom_user
517 we will skip recustomization, but these other customizations are available:
519 # a little tr and sed magic to fix the carriage returns into commas.
520 local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
521 # make the line feeds and carriage returns manageable with tr.
522 # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
523 # last touch with sed removes the last comma.
528 # recreate the feisty meow loading dock.
529 regenerate >/dev/null
531 # jump into the loading dock and make our custom link.
532 pushd "$FEISTY_MEOW_LOADING_DOCK" &>/dev/null
533 if [ -h custom ]; then
534 # there's an existing link, so remove it.
537 # make sure we cleaned up the area before we re-link.
538 if [ -h custom -o -d custom -o -f custom ]; then
540 Due to an over-abundance of caution, we are not going to remove an unexpected
541 'custom' object found in the file system. This object is located in the
542 feisty meow loading dock here: $(pwd)
543 And here is a description of the rogue 'custom' object:
547 If you are pretty sure that this is just a remnant of an older approach in
548 feisty meow, where we copied the custom directory rather than linking it
549 (and it most likely is just such a bit of cruft of that nature), then please
550 remove that old remnant 'custom' item, for example by saying:
551 /bin/rm -rf \"custom\" ; popd
552 Sorry for the interruption, but we want to make sure this removal wasn't
553 automatic if there is even a small amount of doubt about the issue."
557 # create the custom folder as a link to the customizations.
558 ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom
562 # now take into account all the customizations by regenerating the feisty meow environment.
565 restore_terminal_title
568 # generates a random password where the first parameter is the number of characters
569 # in the password (default 20) and the second parameter specifies whether to use
570 # special characters (1) or not (0).
571 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
572 function random_password()
574 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
575 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
579 function add_cygwin_drive_mounts() {
580 for i in c d e f g h q z ; do
581 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
582 ln -s /cygdrive/$i $i
586 ############################
588 # takes a file to modify, and then it will replace any occurrences of the
589 # pattern provided as the second parameter with the text in the third
591 function replace_pattern_in_file()
593 local file="$1"; shift
594 local pattern="$1"; shift
595 local replacement="$1"; shift
596 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
597 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
598 echo "text to replace that pattern with."
601 sed -i -e "s%$pattern%$replacement%g" "$file"
604 # similar to replace_pattern_in_file, but also will add the new value
605 # when the old one did not already exist in the file.
606 function replace_if_exists_or_add()
608 local file="$1"; shift
609 local phrase="$1"; shift
610 local replacement="$1"; shift
611 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
612 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
613 echo "text to replace that phrase with."
616 grep "$phrase" "$file" >/dev/null
617 # replace if the phrase is there, otherwise add it.
618 if [ $? -eq 0 ]; then
619 replace_pattern_in_file "$file" "$phrase" "$replacement"
621 # this had better be the complete line.
622 echo "$replacement" >>"$file"
626 ############################
628 # finds a variable (first parameter) in a particular property file
629 # (second parameter). the expected format for the file is:
631 function seek_variable()
633 local find_var="$1"; shift
634 local file="$1"; shift
635 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
636 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
641 if [ ${#line} -eq 0 ]; then continue; fi
642 # split the line into the variable name and value.
643 IFS='=' read -a assignment <<< "$line"
644 local var="${assignment[0]}"
645 local value="${assignment[1]}"
646 if [ "${value:0:1}" == '"' ]; then
647 # assume the entry was in quotes and remove them.
648 value="${value:1:$((${#value} - 2))}"
650 if [ "$find_var" == "$var" ]; then
656 # finds a variable (first parameter) in a particular XML format file
657 # (second parameter). the expected format for the file is:
658 # ... name="varX" value="valueX" ...
659 function seek_variable_in_xml()
661 local find_var="$1"; shift
662 local file="$1"; shift
663 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
664 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
665 echo "secondly an XML file where the variable's value will be sought."
670 if [ ${#line} -eq 0 ]; then continue; fi
671 # process the line to make it more conventional looking.
672 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
673 # split the line into the variable name and value.
674 IFS='=' read -a assignment <<< "$line"
675 local var="${assignment[0]}"
676 local value="${assignment[1]}"
677 if [ "${value:0:1}" == '"' ]; then
678 # assume the entry was in quotes and remove them.
679 value="${value:1:$((${#value} - 2))}"
681 if [ "$find_var" == "$var" ]; then
687 ############################
689 # goes to a particular directory passed as parameter 1, and then removes all
690 # the parameters after that from that directory.
691 function push_whack_pop()
693 local dir="$1"; shift
694 pushd "$dir" &>/dev/null
695 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
696 rm -rf $* &>/dev/null
697 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
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 subbydir="$1"; shift
764 numdirs="$(find "$subbydir" -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 exit_on_error "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 continue_on_error "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 "$(whichable hostname)" ]; 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 # given a filename and a string to seek and a number of lines, then this
851 # function will remove the first occurrence of a line in the file that
852 # matches the string, and it will also axe the next N lines as specified.
853 function create_chomped_copy_of_file()
855 local filename="$1"; shift
856 local seeker="$1"; shift
857 local numlines=$1; shift
859 #echo into create_chomped_copy...
860 #var filename seeker numlines
862 # make a backup first, oy.
863 \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
864 exit_on_error "backing up file: $filename"
866 # make a temp file to write to before we move file into place in bind.
867 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
868 \rm -f "$new_version"
869 exit_on_error "cleaning out new version of file from: $new_version"
875 # don't bother looking at the lines if we're already in skip mode.
876 if [[ $skip_count == 0 ]]; then
877 # find the string they're seeking.
878 if [[ ! "$line" =~ .*${seeker}.* ]]; then
880 echo "$line" >> "$new_version"
882 # a match! start skipping. we will delete this line and the next N lines.
884 #echo first skip count is now $skip_count
888 # we're already skipping. let's keep going until we hit the limit.
890 #echo ongoing skip count is now $skip_count
891 if (( $skip_count > $numlines )); then
892 echo "Done skipping, and back to writing output file."
898 #echo file we created looks like this:
901 if [ ! -z "$found_any" ]; then
902 # put the file back into place under the original name.
903 \mv "$new_version" "$filename"
904 exit_on_error "moving the new version into place in: $filename"
906 # cannot always be considered an error, but we can at least gripe.
907 echo "Did not find any matches for seeker '$seeker' in file: $filename"
913 # space 'em all: fixes naming for all of the files of the appropriate types
914 # in the directories specified.
915 function spacemall() {
916 local -a dirs=("${@}")
917 if [ ${#dirs[@]} -eq 0 ]; then
921 local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)"
922 find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f | \
924 "doc\|docx\|eml\|html\|jpeg\|jpg\|m4a\|mov\|mp3\|ods\|odt\|pdf\|png\|ppt\|pptx\|txt\|vsd\|vsdx\|xls\|xlsx\|zip" | \
925 sed -e 's/^/"/' | sed -e 's/$/"/' | \
926 xargs bash "$FEISTY_MEOW_SCRIPTS/files/spacem.sh"
927 # drop the temp file now that we're done.
933 # site avenger aliases
936 THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
937 source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
943 # you have hit the borderline functional zone...
945 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
946 # restarts the sound driver.
947 function fix_sound_driver() {
948 # stop bash complaining about blank function body.
951 # sudo service alsasound restart
952 #elif pulse something
961 # ...and here's the end of the borderline functional zone.
965 # NOTE: no more function definitions are allowed after this point.
967 function function_sentinel()
972 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
976 # test code for set_var_if_undefined.
978 if [ $run_test != 0 ]; then
979 echo running tests on set_var_if_undefined.
981 set_var_if_undefined flagrant forknordle
982 exit_on_error "testing if defined variable would be whacked"
983 if [ $flagrant != petunia ]; then
984 echo set_var_if_undefined failed to leave the test variable alone
987 unset bobblehead_stomper
988 set_var_if_undefined bobblehead_stomper endurance
989 if [ $bobblehead_stomper != endurance ]; then
990 echo set_var_if_undefined failed to set a variable that was not defined yet