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
43 # returns true if the variable is an array.
45 [[ "$(declare -p $1)" =~ "declare -a" ]]
48 # returns true if the name provided is a defined alias.
54 # makes the status of pipe number N (passed as first parameter) into the
55 # main return value (i.e., the value for $?). this is super handy to avoid
56 # repeating the awkward looking code below in multiple places.
57 function promote_pipe_return()
59 ( exit ${PIPESTATUS[$1]} )
64 # displays the value of a variable in bash friendly format.
69 local varname="$1"; shift
70 if [ -z "$varname" ]; then
74 if is_alias "$varname"; then
75 #echo found $varname is alias
76 local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
77 alias $varname | sed -e 's/.*=//' >$tmpfile
78 echo "alias $varname=$(cat $tmpfile)"
80 elif [ -z "${!varname}" ]; then
81 echo "$varname undefined"
83 if is_array "$varname"; then
84 #echo found $varname is array var
86 eval temparray="(\${$varname[@]})"
87 echo "$varname=(${temparray[@]})"
88 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
89 # see ones that have spaces in them.
91 #echo found $varname is simple
92 echo "$varname=${!varname}"
101 # when passed a list of things, this will return the unique items from that list as an echo.
104 # do the uniquification: split the space separated items into separate lines, then
105 # sort the list, then run the uniq tool on the list. results will be packed back onto
106 # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
107 echo $* | tr ' ' '\n' | sort | uniq
110 # sets the variable in parameter 1 to the value in parameter 2, but only if
111 # that variable was undefined.
112 function set_var_if_undefined()
114 local var_name="$1"; shift
115 local var_value="$1"; shift
116 if [ -z "${!var_name}" ]; then
117 eval export $var_name="$var_value"
123 function success_sound()
125 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
126 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
130 function error_sound()
132 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
133 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
139 # echoes the maximum number of columns that the terminal supports. usually
140 # anything you print to the terminal with length less than (but not equal to)
141 # maxcols will never wrap.
142 function get_maxcols()
144 # calculate the number of columsn in the terminal.
145 local cols=$(stty size | awk '{print $2}')
151 # checks the result of the last command that was run, and if that failed,
152 # then this complains and exits from bash. the function parameters are
153 # used as the message to print as a complaint.
154 function exit_on_error()
156 if [ $? -ne 0 ]; then
157 echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..."
163 # like exit_on_error, but will keep going after complaining.
164 function continue_on_error()
166 if [ $? -ne 0 ]; then
167 echo -e "\n\na problem occurred, but we can continue:\n\n$*\n\n=> Continuing script..."
174 # accepts any number of arguments and outputs them to the feisty meow event log.
175 function log_feisty_meow_event()
177 echo -e "$(date_stringer) -- ${USER}@$(hostname): $*" >> "$FEISTY_MEOW_EVENT_LOG"
182 # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
186 # we remember the old terminal title, then force the TERM variable to a more generic
187 # version for the other side (just 'linux'); we don't want the remote side still
188 # thinking it's running xterm.
191 #hmmm: why were we doing this? it scorches the user's logged in session, leaving it without proper terminal handling.
192 # # we save the value of TERM; we don't want to leave the user's terminal
193 # # brain dead once we come back from this function.
194 # local oldterm="$TERM"
197 /usr/bin/ssh -X -C "${args[@]}"
199 # # restore the terminal variable also.
202 restore_terminal_title
203 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
204 echo TERM title restored to prior value
210 # locates a process given a search pattern to match in the process list.
211 # supports a single command line flag style parameter of "-u USERNAME";
212 # if the -u flag is found, a username is expected afterwards, and only the
213 # processes of that user are considered.
215 local -a patterns=("${@}")
217 #echo patterns list is: "${patterns[@]}"
221 if [ "${patterns[0]}" == "-u" ]; then
222 user_flag="-u ${patterns[1]}"
223 #echo "found a -u parm and user=${patterns[1]}"
224 # void the two elements with that user flag so we don't use them as patterns.
225 unset patterns[0] patterns[1]=
231 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
234 if [ "$OS" == "Windows_NT" ]; then
235 # gets cygwin's (god awful) ps to show windoze processes also.
236 local EXTRA_DOZER_FLAGS="-W"
237 # pattern to use for peeling off the process numbers.
238 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
241 # flags which clean up the process listing output on unixes.
242 # apparently cygwin doesn't count as a type of unix, because their
243 # crummy specialized ps command doesn't support normal ps flags.
244 local EXTRA_UNIX_FLAGS="-o pid,args"
245 # pattern to use for peeling off the process numbers.
246 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
249 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
251 #echo got all this stuff in the pid dump file:
255 # search for the pattern the user wants to find, and just pluck the process
256 # ids out of the results.
258 for i in "${patterns[@]}"; do
259 PIDS_SOUGHT+=($(cat $PID_DUMP \
261 | sed -n -e "$pid_finder_pattern"))
264 #echo pids sought list became:
265 #echo "${PIDS_SOUGHT[@]}"
268 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
269 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
271 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
272 echo ${PIDS_SOUGHT[*]}
277 # finds all processes matching the pattern specified and shows their full
278 # process listing (whereas psfind just lists process ids).
281 echo "psa finds processes by pattern, but there was no pattern on the command line."
284 local -a patterns=("${@}")
285 p=$(psfind "${patterns[@]}")
291 if [ "${patterns[0]}" == "-u" ]; then
292 # void the two elements with that user flag so we don't use them as patterns.
293 unset patterns[0] patterns[1]=
297 echo "Processes matching ${patterns[@]}..."
299 if [ -n "$IS_DARWIN" ]; then
302 # only print the header the first time.
303 if [ -z "$fuzil_sentinel" ]; then
306 ps $i -w -u | sed -e '1d'
311 # cases besides mac os x's darwin.
312 if [ "$OS" == "Windows_NT" ]; then
313 # special case for windows.
316 ps -W -p $curr | tail -n +2
319 # normal OSes can handle a nice simple query.
327 #hmmm: holy crowbars, this is an old one. do we ever still have any need of it?
328 # an unfortunately similarly named function to the above 'ps' as in process
329 # methods, but this 'ps' stands for postscript. this takes a postscript file
330 # and converts it into pcl3 printer language and then ships it to the printer.
331 # this mostly makes sense for an environment where one's default printer is
332 # pcl. if the input postscript causes ghostscript to bomb out, there has been
333 # some good success running ps2ps on the input file and using the cleaned
334 # postscript file for printing.
335 function ps2pcl2lpr() {
337 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
341 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
342 # restarts the sound driver.
343 function fix_sound_driver() {
344 # stop bash complaining about blank function body.
347 # sudo service alsasound restart
348 #elif pulse something
359 #hmmm: ugly absolute path here.
361 restore_terminal_title
364 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
365 function unix_to_dos_path() {
366 # we usually remove dos slashes in favor of forward slashes.
368 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
369 # fake this value for non-windows (non-cygwin) platforms.
372 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
373 # insists on the /home form instead of /c/cygwin/home being possible. this is
374 # super frustrating and nightmarish.
375 DOSSYHOME="$(cygpath -am "$HOME")"
378 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
379 # unless this flag is set, in which case we force dos slashes.
380 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'
382 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
386 # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
387 # for the cygwin environment currently.
388 function dos_to_unix_path() {
389 # we always remove dos slashes in favor of forward slashes.
390 #old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
391 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
394 # returns a successful value (0) if this system is debian or ubuntu.
395 function debian_like() {
396 # decide if we think this is debian or ubuntu or a variant.
397 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
398 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
399 if [ $DEBIAN_LIKE -eq 1 ]; then
400 # success; this is debianish.
403 # this seems like some other OS.
408 # su function: makes su perform a login.
409 # for some OSes, this transfers the X authority information to the new login.
412 # debian currently requires the full version which imports X authority
413 # information for su.
415 # get the x authority info for our current user.
416 source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
418 if [ -z "$X_auth_info" ]; then
419 # if there's no authentication info to pass along, we just do a normal su.
422 # under X, we update the new login's authority info with the previous
424 (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
427 # non-debian supposedly doesn't need the extra overhead any more.
428 # or at least suse doesn't, which is the other one we've tested on.
433 # sudo function wraps the normal sudo by ensuring we replace the terminal
434 # label if they're doing an su with the sudo.
439 restore_terminal_title
440 # if [ "$first_command" == "su" ]; then
441 # # yep, they were doing an su, but they're back now.
442 # label_terminal_with_info
447 # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
448 # this kind of assumes you've already checked them for any salient facts.
449 function clean_cvs_junk() {
451 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
455 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
457 local wheres_nechung=$(which nechung 2>/dev/null)
458 if [ -z "$wheres_nechung" ]; then
459 echo "The nechung oracle program cannot be found. You may want to consider"
460 echo "rebuilding the feisty meow applications with this command:"
461 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
468 # recreates all the generated files that the feisty meow scripts use.
469 function regenerate() {
470 # do the bootstrapping process again.
472 echo "regenerating feisty meow script environment."
473 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
475 # force a full reload by turning off sentinel variables and methods.
476 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
477 unalias CORE_ALIASES_LOADED &>/dev/null
478 unset -f function_sentinel
479 # reload feisty meow environment in current shell.
480 log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell."
481 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
482 # run nechung oracle to give user a new fortune.
484 restore_terminal_title
487 # merges a set of custom scripts into the feisty meow environment. can be
488 # passed a name to use as the custom scripts source folder (found on path
489 # $FEISTY_MEOW_SCRIPTS/customize/{name}), or it will try to guess the name
490 # by using the login name.
491 function recustomize()
493 local custom_user="$1"; shift
494 if [ -z "$custom_user" ]; then
495 # default to login name if there was no name provided.
496 custom_user="$(logname)"
497 # we do intend to use logname here to get the login name and to ignore
498 # if the user has sudo root access; we don't want to provide a custom
504 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
505 echo -e "the customization folder for '$custom_user' is missing:
507 $FEISTY_MEOW_SCRIPTS/customize/$custom_user
509 we will skip recustomization, but these other customizations are available:
511 # a little tr and sed magic to fix the carriage returns into commas.
512 local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
513 # make the line feeds and carriage returns manageable with tr.
514 # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
515 # last touch with sed removes the last comma.
520 #hmmm: begin old custom section...
521 #hmmm: here is where it starts being wrong for a link due to current borked copy approach.
522 ## # prevent permission foul-ups.
524 ## # here we definitely want the effective user name (in USER), since
525 ## # we don't want, say, fred (as logname) to own all of root's loading
527 ###hmmm: argh, seems a bit heavyweight to do chowning here!
528 ## chown -R "$my_user:$my_user" \
529 ## "$FEISTY_MEOW_LOADING_DOCK"/* "$FEISTY_MEOW_GENERATED_STORE"/* 2>/dev/null
530 ## continue_on_error "chowning feisty meow generated directories to $my_user"
532 ## regenerate >/dev/null
534 ## pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
535 ## incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
537 ## local fail_message="\n
538 ##are the perl dependencies installed? if you're on ubuntu or debian, try this:\n
539 ## $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n
540 ##or if you're on cygwin, then try this (if apt-cyg is available):\n
541 ## $(grep "apt-cyg.*perl" $FEISTY_MEOW_APEX/readme.txt)\n";
543 ## #echo "the incongruous files list is: $incongruous_files"
544 ## # disallow a single character result, since we get "*" as result when nothing exists yet.
545 ## if [ ${#incongruous_files} -ge 2 ]; then
546 ## log_feisty_meow_event "cleaning unknown older overrides..."
547 ## perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
548 ## continue_on_error "running safedel. $fail_message"
551 ## log_feisty_meow_event "copying custom overrides for $custom_user"
552 ## mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
553 ## perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
554 ## continue_on_error "running cpdiff. $fail_message"
556 ## if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
557 ## log_feisty_meow_event "copying custom scripts for $custom_user"
558 ###hmmm: could save output to show if an error occurs.
559 ## rsync -avz "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
560 ## continue_on_error "copying customization scripts"
564 ## # prevent permission foul-ups, again.
565 ## chown -R "$my_user:$my_user" \
566 ## "$FEISTY_MEOW_LOADING_DOCK" "$FEISTY_MEOW_GENERATED_STORE" 2>/dev/null
567 ## continue_on_error "once more chowning feisty meow generated directories to $my_user"
568 #hmmm: begin old custom section.
572 #hmmm: begin new customization section...
573 # recreate the feisty meow loading dock.
574 regenerate >/dev/null
576 # jump into the loading dock and make our custom link.
577 pushd "$FEISTY_MEOW_LOADING_DOCK" &>/dev/null
578 if [ -h custom ]; then
579 # there's an existing link, so remove it.
582 if [ -h custom -o -d custom -o -f custom ]; then
584 Due to an over-abundance of caution, we are not going to remove an unexpected
585 'custom' object in the file system. This is located here:
592 # create the custom folder as a link to the customizations.
593 ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom
597 # now take into account all the customizations by regenerating the feisty meow environment.
599 #hmmm: end new customization section.
603 restore_terminal_title
606 # generates a random password where the first parameter is the number of characters
607 # in the password (default 20) and the second parameter specifies whether to use
608 # special characters (1) or not (0).
609 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
610 function random_password()
612 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
613 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
617 # a wrapper for the which command that finds items on the path. some OSes
618 # do not provide which, so we want to not be spewing errors when that
623 which which &>/dev/null
624 if [ $? -ne 0 ]; then
625 # there is no which command here. we produce nothing due to this.
628 echo $(which $to_find)
631 function add_cygwin_drive_mounts() {
632 for i in c d e f g h q z ; do
633 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
634 ln -s /cygdrive/$i $i
638 ############################
640 # takes a file to modify, and then it will replace any occurrences of the
641 # pattern provided as the second parameter with the text in the third
643 function replace_pattern_in_file()
645 local file="$1"; shift
646 local pattern="$1"; shift
647 local replacement="$1"; shift
648 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
649 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
650 echo "text to replace that pattern with."
653 sed -i -e "s%$pattern%$replacement%g" "$file"
656 # similar to replace_pattern_in_file, but also will add the new value
657 # when the old one did not already exist in the file.
658 function replace_if_exists_or_add()
660 local file="$1"; shift
661 local phrase="$1"; shift
662 local replacement="$1"; shift
663 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
664 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
665 echo "text to replace that phrase with."
668 grep "$phrase" "$file" >/dev/null
669 # replace if the phrase is there, otherwise add it.
670 if [ $? -eq 0 ]; then
671 replace_pattern_in_file "$file" "$phrase" "$replacement"
673 # this had better be the complete line.
674 echo "$replacement" >>"$file"
678 ############################
680 # finds a variable (first parameter) in a particular property file
681 # (second parameter). the expected format for the file is:
683 function seek_variable()
685 local find_var="$1"; shift
686 local file="$1"; shift
687 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
688 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
693 if [ ${#line} -eq 0 ]; then continue; fi
694 # split the line into the variable name and value.
695 IFS='=' read -a assignment <<< "$line"
696 local var="${assignment[0]}"
697 local value="${assignment[1]}"
698 if [ "${value:0:1}" == '"' ]; then
699 # assume the entry was in quotes and remove them.
700 value="${value:1:$((${#value} - 2))}"
702 if [ "$find_var" == "$var" ]; then
708 # finds a variable (first parameter) in a particular XML format file
709 # (second parameter). the expected format for the file is:
710 # ... name="varX" value="valueX" ...
711 function seek_variable_in_xml()
713 local find_var="$1"; shift
714 local file="$1"; shift
715 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
716 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
717 echo "secondly an XML file where the variable's value will be sought."
722 if [ ${#line} -eq 0 ]; then continue; fi
723 # process the line to make it more conventional looking.
724 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
725 # split the line into the variable name and value.
726 IFS='=' read -a assignment <<< "$line"
727 local var="${assignment[0]}"
728 local value="${assignment[1]}"
729 if [ "${value:0:1}" == '"' ]; then
730 # assume the entry was in quotes and remove them.
731 value="${value:1:$((${#value} - 2))}"
733 if [ "$find_var" == "$var" ]; then
739 ############################
741 # goes to a particular directory passed as parameter 1, and then removes all
742 # the parameters after that from that directory.
743 function push_whack_pop()
745 local dir="$1"; shift
746 pushd "$dir" &>/dev/null
747 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
748 rm -rf $* &>/dev/null
749 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
755 # new breed of definer functions goes here. still in progress.
757 # defines an alias and remembers that this is a new or modified definition.
758 # if the feisty meow codebase is unloaded, then so are all the aliases that
760 function define_yeti_alias()
762 # if alias exists already, save old value for restore,
763 # otherwise save null value for restore,
764 # have to handle unaliasing if there was no prior value of one
766 # add alias name to a list of feisty defined aliases.
768 #hmmm: first implem, just do the alias and get that working...
777 #hmmm: this points to an extended functions file being needed; not all of these are core.
779 # displays documentation in "md" formatted files.
782 local file="$1"; shift
783 pandoc "$file" | lynx -stdin
788 # just shows a separator line for an 80 column console, or uses the first
789 # parameter as the number of columns to expect.
793 if [ -z "$count" ]; then
798 for ((i=0; i < $count - 1; i++)); do
804 # alias for separator.
812 # count the number of sub-directories in a directory and echo the result.
813 function count_directories()
815 local subbydir="$1"; shift
816 numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
820 # takes a string and capitalizes just the first character. any capital letters in the remainder of
821 # the string are made lower case. the processed string is returned by an echo.
822 function capitalize_first_char()
824 local to_dromedary="$1"; shift
825 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
829 # given a source path and a target path, this will make a symbolic link from
830 # the source to the destination, but only if the source actually exists.
831 function make_safe_link()
833 local src="$1"; shift
834 local target="$1"; shift
836 if [ -d "$src" ]; then
837 ln -s "$src" "$target"
838 exit_on_error "Creating symlink from '$src' to '$target'"
840 echo "Created symlink from '$src' to '$target'."
843 # pretty prints the json files provided as parameters.
844 function clean_json()
846 if [ -z "$*" ]; then return; fi
849 local file="$1"; shift
850 if [ -z "$file" ]; then break; fi
851 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
852 temp_out="$TMP/$file.view"
853 cat "$file" | python -m json.tool > "$temp_out"
854 show_list+=($temp_out)
855 continue_on_error "pretty printing '$file'"
857 filedump "${show_list[@]}"
863 # only print our special headers or text fields.
867 grep -i "\"text\":\|^=.*" |
868 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
873 # echoes the machine's hostname. can be used like so:
874 # local my_host=$(get_hostname)
875 function get_hostname()
877 # there used to be more variation in how to do this, but adopting mingw
878 # and cygwin tools really helped out.
879 local this_host=unknown
880 if [ "$OS" == "Windows_NT" ]; then
881 this_host=$(hostname)
882 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
883 this_host=$(hostname)
884 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
885 this_host=$(hostname --long)
886 elif [ -x "$(which hostname 2>/dev/null)" ]; then
887 this_host=$(hostname)
892 # makes sure that the provided "folder" is a directory and is writable.
893 function test_writeable()
895 local folder="$1"; shift
896 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
902 # given a filename and a string to seek and a number of lines, then this
903 # function will remove the first occurrence of a line in the file that
904 # matches the string, and it will also axe the next N lines as specified.
905 function create_chomped_copy_of_file()
907 local filename="$1"; shift
908 local seeker="$1"; shift
909 local numlines=$1; shift
911 #echo into create_chomped_copy...
912 #var filename seeker numlines
914 # make a backup first, oy.
915 \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
916 exit_on_error "backing up file: $filename"
918 # make a temp file to write to before we move file into place in bind.
919 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
920 \rm -f "$new_version"
921 exit_on_error "cleaning out new version of file from: $new_version"
927 # don't bother looking at the lines if we're already in skip mode.
928 if [[ $skip_count == 0 ]]; then
929 # find the string they're seeking.
930 if [[ ! "$line" =~ .*${seeker}.* ]]; then
932 echo "$line" >> "$new_version"
934 # a match! start skipping. we will delete this line and the next N lines.
936 #echo first skip count is now $skip_count
940 # we're already skipping. let's keep going until we hit the limit.
942 #echo ongoing skip count is now $skip_count
943 if (( $skip_count > $numlines )); then
944 echo "Done skipping, and back to writing output file."
950 #echo file we created looks like this:
953 if [ ! -z "$found_any" ]; then
954 # put the file back into place under the original name.
955 \mv "$new_version" "$filename"
956 exit_on_error "moving the new version into place in: $filename"
958 # cannot always be considered an error, but we can at least gripe.
959 echo "Did not find any matches for seeker '$seeker' in file: $filename"
965 # space 'em all: fixes naming for all of the files of the appropriate types
966 # in the directories specified.
967 function spacemall() {
968 local -a dirs=("${@}")
969 if [ ${#dirs[@]} -eq 0 ]; then
973 local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)"
974 find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f | \
976 "docx\|eml\|html\|jpeg\|jpg\|m4a\|mov\|mp3\|ods\|odt\|pdf\|png\|pptx\|txt\|xlsx\|zip" | \
977 sed -e 's/^/"/' | sed -e 's/$/"/' | \
978 xargs bash "$FEISTY_MEOW_SCRIPTS/files/spacem.sh"
979 # drop the temp file now that we're done.
985 # site avenger aliases
988 THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
989 source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
995 # NOTE: no more function definitions are allowed after this point.
997 function function_sentinel()
1002 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
1006 # test code for set_var_if_undefined.
1008 if [ $run_test != 0 ]; then
1009 echo running tests on set_var_if_undefined.
1011 set_var_if_undefined flagrant forknordle
1012 exit_on_error "testing if defined variable would be whacked"
1013 if [ $flagrant != petunia ]; then
1014 echo set_var_if_undefined failed to leave the test variable alone
1017 unset bobblehead_stomper
1018 set_var_if_undefined bobblehead_stomper endurance
1019 if [ $bobblehead_stomper != endurance ]; then
1020 echo set_var_if_undefined failed to set a variable that was not defined yet