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 function fm_username()
66 # see if we can get the user name from the login name. oddly this sometimes doesn't work.
67 local custom_user="$(logname 2>/dev/null)"
68 if [ -z "$custom_user" ]; then
69 # try the normal unix user variable.
72 if [ -z "$custom_user" ]; then
73 # try the windows user variable.
74 custom_user="$USERNAME"
81 # displays the value of a variable in bash friendly format.
86 local varname="$1"; shift
87 if [ -z "$varname" ]; then
91 if is_alias "$varname"; then
92 #echo found $varname is alias
93 local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
94 alias $varname | sed -e 's/.*=//' >$tmpfile
95 echo "alias $varname=$(cat $tmpfile)"
97 elif [ -z "${!varname}" ]; then
98 echo "$varname undefined"
100 if is_array "$varname"; then
101 #echo found $varname is array var
103 eval temparray="(\${$varname[@]})"
104 echo "$varname=(${temparray[@]})"
105 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
106 # see ones that have spaces in them.
108 #echo found $varname is simple
109 echo "$varname=${!varname}"
118 # when passed a list of things, this will return the unique items from that list as an echo.
121 # do the uniquification: split the space separated items into separate lines, then
122 # sort the list, then run the uniq tool on the list. results will be packed back onto
123 # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
124 echo $* | tr ' ' '\n' | sort | uniq
127 # sets the variable in parameter 1 to the value in parameter 2, but only if
128 # that variable was undefined.
129 function set_var_if_undefined()
131 local var_name="$1"; shift
132 local var_value="$1"; shift
133 if [ -z "${!var_name}" ]; then
134 eval export $var_name="$var_value"
140 function success_sound()
142 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
143 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
147 function error_sound()
149 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
150 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
156 # echoes the maximum number of columns that the terminal supports. usually
157 # anything you print to the terminal with length less than (but not equal to)
158 # maxcols will never wrap.
159 function get_maxcols()
161 # calculate the number of columsn in the terminal.
162 local cols=$(stty size | awk '{print $2}')
168 # checks the result of the last command that was run, and if that failed,
169 # then this complains and exits from bash. the function parameters are
170 # used as the message to print as a complaint.
171 function exit_on_error()
173 if [ $? -ne 0 ]; then
174 echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..."
180 # like exit_on_error, but will keep going after complaining.
181 function continue_on_error()
183 if [ $? -ne 0 ]; then
184 echo -e "\n\na problem occurred, but we can continue:\n\n$*\n\n=> Continuing script..."
191 # accepts any number of arguments and outputs them to the feisty meow event log.
192 function log_feisty_meow_event()
194 echo -e "$(date_stringer) -- ${USER}@$(hostname): $*" >> "$FEISTY_MEOW_EVENT_LOG"
199 # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
203 # we remember the old terminal title, then force the TERM variable to a more generic
204 # version for the other side (just 'linux'); we don't want the remote side still
205 # thinking it's running xterm.
208 #hmmm: why were we doing this? it scorches the user's logged in session, leaving it without proper terminal handling.
209 # # we save the value of TERM; we don't want to leave the user's terminal
210 # # brain dead once we come back from this function.
211 # local oldterm="$TERM"
214 /usr/bin/ssh -Y -C "${args[@]}"
216 # # restore the terminal variable also.
219 restore_terminal_title
220 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
221 echo TERM title restored to prior value
227 # locates a process given a search pattern to match in the process list.
228 # supports a single command line flag style parameter of "-u USERNAME";
229 # if the -u flag is found, a username is expected afterwards, and only the
230 # processes of that user are considered.
232 local -a patterns=("${@}")
234 #echo patterns list is: "${patterns[@]}"
238 if [ "${patterns[0]}" == "-u" ]; then
239 user_flag="-u ${patterns[1]}"
240 #echo "found a -u parm and user=${patterns[1]}"
241 # void the two elements with that user flag so we don't use them as patterns.
242 unset patterns[0] patterns[1]=
248 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
251 if [ "$OS" == "Windows_NT" ]; then
252 # gets cygwin's (god awful) ps to show windoze processes also.
253 local EXTRA_DOZER_FLAGS="-W"
254 # pattern to use for peeling off the process numbers.
255 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
258 # flags which clean up the process listing output on unixes.
259 # apparently cygwin doesn't count as a type of unix, because their
260 # crummy specialized ps command doesn't support normal ps flags.
261 local EXTRA_UNIX_FLAGS="-o pid,args"
262 # pattern to use for peeling off the process numbers.
263 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
266 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
268 #echo got all this stuff in the pid dump file:
272 # search for the pattern the user wants to find, and just pluck the process
273 # ids out of the results.
275 for i in "${patterns[@]}"; do
276 PIDS_SOUGHT+=($(cat $PID_DUMP \
278 | sed -n -e "$pid_finder_pattern"))
281 #echo pids sought list became:
282 #echo "${PIDS_SOUGHT[@]}"
285 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
286 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
288 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
289 echo ${PIDS_SOUGHT[*]}
294 # finds all processes matching the pattern specified and shows their full
295 # process listing (whereas psfind just lists process ids).
298 echo "psa finds processes by pattern, but there was no pattern on the command line."
301 local -a patterns=("${@}")
302 p=$(psfind "${patterns[@]}")
308 if [ "${patterns[0]}" == "-u" ]; then
309 # void the two elements with that user flag so we don't use them as patterns.
310 unset patterns[0] patterns[1]=
314 echo "Processes matching ${patterns[@]}..."
316 if [ -n "$IS_DARWIN" ]; then
319 # only print the header the first time.
320 if [ -z "$fuzil_sentinel" ]; then
323 ps $i -w -u | sed -e '1d'
328 # cases besides mac os x's darwin.
329 if [ "$OS" == "Windows_NT" ]; then
330 # special case for windows.
333 ps -W -p $curr | tail -n +2
336 # normal OSes can handle a nice simple query.
344 #hmmm: holy crowbars, this is an old one. do we ever still have any need of it?
345 # an unfortunately similarly named function to the above 'ps' as in process
346 # methods, but this 'ps' stands for postscript. this takes a postscript file
347 # and converts it into pcl3 printer language and then ships it to the printer.
348 # this mostly makes sense for an environment where one's default printer is
349 # pcl. if the input postscript causes ghostscript to bomb out, there has been
350 # some good success running ps2ps on the input file and using the cleaned
351 # postscript file for printing.
352 function ps2pcl2lpr() {
354 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
360 #hmmm: ugly absolute path here.
362 restore_terminal_title
365 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
366 function unix_to_dos_path() {
367 # we usually remove dos slashes in favor of forward slashes.
369 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
370 # fake this value for non-windows (non-cygwin) platforms.
373 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
374 # insists on the /home form instead of /c/cygwin/home being possible. this is
375 # super frustrating and nightmarish.
376 DOSSYHOME="$(cygpath -am "$HOME")"
379 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
380 # unless this flag is set, in which case we force dos slashes.
381 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'
383 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
387 # # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
388 # # for the cygwin environment currently.
389 # function dos_to_unix_path() {
390 # # we always remove dos slashes in favor of forward slashes.
391 ##old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
392 # echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
395 # returns a successful value (0) if this system is debian or ubuntu.
396 function debian_like() {
397 # decide if we think this is debian or ubuntu or a variant.
398 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
399 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
400 if [ $DEBIAN_LIKE -eq 1 ]; then
401 # success; this is debianish.
404 # this seems like some other OS.
409 # this function wraps the normal sudo by ensuring we replace the terminal
410 # label before we launch what they're passing to sudo. we also preserve
411 # specific variables that enable the main user's ssh credentials to still
412 # be relied on for ssh forwarding, even if the '-i' flag is passed to cause
413 # a fresh shell (which normally doesn't get the launching user's environment
416 ##questioning our approach: we also ensure that
417 # # the feisty meow environment is recreated; normal subshells don't need
418 # # this, but when switching identity with sudo, it seems important. yet,
419 # # we also don't want to hose up their normal sudo actions, such as passing
420 # # along the current environment, should the user choose.
425 # hoist our X authorization info in case environment is passed along;
426 # this can allow root to use our display to show X.org windows.
427 if [ -z "$IMPORTED_XAUTH" -a ! -z "$DISPLAY" ]; then
428 export IMPORTED_XAUTH="$(xauth list $DISPLAY | head -n 1 | awk '{print $3}')"
431 # launch sudo with just the variables we want to reach the other side.
432 # we take an extra step to null out the PATH, since MacOS seems to want
433 # to pass that even for a login shell (-i) somehow.
434 PATH= /usr/bin/sudo --preserve-env=SSH_AUTH_SOCK,IMPORTED_XAUTH "$@"
435 #"SSH_AUTH_SOCK='$SSH_AUTH_SOCK'" "IMPORTED_XAUTH='$IMPORTED_XAUTH'" "$@"
439 restore_terminal_title
442 ##potential boneyard:
443 # prep a simple command string here, rather than messing with arguments
444 # in the already complicated command below. i was seeing some really
445 # screwy behavior trying to expand $@ when embedded for the bash -c flag,
446 # but making the variable ahead of time gets rid of that.
447 cmd="/usr/bin/sudo --preserve-env=SSH_AUTH_SOCK,IMPORTED_XAUTH ""$@"
449 # omit any variables that are either wrong for a different user or used
450 # to shield the feisty meow scripts from reconfiguring. when we do the
451 # sudo, we want a fresh start for feisty meow at least.
452 # our approach to launching sudo is further complicated by our sentinel
453 # alias, which normally is passed to any subshells (to prevent recreating
454 # aliases). we turn off the expand_aliases shell option to avoid passing
455 # the sentinel, which ensures aliases do get recreated for the new user.
457 CORE_VARIABLES_LOADED= \
458 FEISTY_MEOW_SCRIPTS_LOADED= \
462 bash +O expand_aliases -c "$cmd"
464 restore_terminal_title
468 # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
469 # this kind of assumes you've already checked them for any salient facts.
470 function clean_cvs_junk() {
472 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
476 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
478 local wheres_nechung=$(which nechung 2>/dev/null)
479 if [ -z "$wheres_nechung" ]; then
480 echo "The nechung oracle program cannot be found. You may want to consider"
481 echo "rebuilding the feisty meow applications with this command:"
482 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
489 # recreates all the generated files that the feisty meow scripts use.
490 function regenerate() {
491 # do the bootstrapping process again.
493 echo "regenerating feisty meow script environment."
494 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
496 # force a full reload by turning off sentinel variables and methods.
497 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
498 unalias CORE_ALIASES_LOADED &>/dev/null
499 unset -f function_sentinel
500 # reload feisty meow environment in current shell.
501 log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell."
502 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
503 # run nechung oracle to give user a new fortune.
505 restore_terminal_title
508 # merges a set of custom scripts into the feisty meow environment. can be
509 # passed a name to use as the custom scripts source folder (found on path
510 # $FEISTY_MEOW_SCRIPTS/customize/{name}), or it will try to guess the name
511 # by using the login name.
512 function recustomize()
514 local custom_user="$1"; shift
515 if [ -z "$custom_user" ]; then
516 # default to login name if there was no name provided.
517 custom_user="$(fm_username)"
518 # we do intend to use the login name here to get the login name and to ignore
519 # if the user has sudo root access; we don't want to provide a custom
522 # chop off any email address style formatting to leave just the name.
523 custom_user="$(echo "$custom_user" | cut -f1 -d'@')"
527 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
528 echo -e "the customization folder for '$custom_user' is missing:
530 $FEISTY_MEOW_SCRIPTS/customize/$custom_user
532 we will skip recustomization, but these other customizations are available:
534 # a little tr and sed magic to fix the carriage returns into commas.
535 local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
536 # make the line feeds and carriage returns manageable with tr.
537 # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
538 # last touch with sed removes the last comma.
543 # recreate the feisty meow loading dock.
544 regenerate >/dev/null
546 # jump into the loading dock and make our custom link.
547 pushd "$FEISTY_MEOW_LOADING_DOCK" &>/dev/null
548 if [ -h custom ]; then
549 # there's an existing link, so remove it.
552 # make sure we cleaned up the area before we re-link.
553 if [ -h custom -o -d custom -o -f custom ]; then
555 Due to an over-abundance of caution, we are not going to remove an unexpected
556 'custom' object found in the file system. This object is located in the
557 feisty meow loading dock here: $(pwd)
558 And here is a description of the rogue 'custom' object:
562 If you are pretty sure that this is just a remnant of an older approach in
563 feisty meow, where we copied the custom directory rather than linking it
564 (and it most likely is just such a bit of cruft of that nature), then please
565 remove that old remnant 'custom' item, for example by saying:
566 /bin/rm -rf \"custom\" ; popd
567 Sorry for the interruption, but we want to make sure this removal wasn't
568 automatic if there is even a small amount of doubt about the issue."
572 # create the custom folder as a link to the customizations.
573 ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom
577 # now take into account all the customizations by regenerating the feisty meow environment.
580 restore_terminal_title
583 # generates a random password where the first parameter is the number of characters
584 # in the password (default 20) and the second parameter specifies whether to use
585 # special characters (1) or not (0).
586 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
587 function random_password()
589 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
590 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
594 # a wrapper for the which command that finds items on the path. some OSes
595 # do not provide which, so we want to not be spewing errors when that
600 which which &>/dev/null
601 if [ $? -ne 0 ]; then
602 # there is no which command here. we produce nothing due to this.
605 echo $(which $to_find)
608 function add_cygwin_drive_mounts() {
609 for i in c d e f g h q z ; do
610 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
611 ln -s /cygdrive/$i $i
615 ############################
617 # takes a file to modify, and then it will replace any occurrences of the
618 # pattern provided as the second parameter with the text in the third
620 function replace_pattern_in_file()
622 local file="$1"; shift
623 local pattern="$1"; shift
624 local replacement="$1"; shift
625 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
626 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
627 echo "text to replace that pattern with."
630 sed -i -e "s%$pattern%$replacement%g" "$file"
633 # similar to replace_pattern_in_file, but also will add the new value
634 # when the old one did not already exist in the file.
635 function replace_if_exists_or_add()
637 local file="$1"; shift
638 local phrase="$1"; shift
639 local replacement="$1"; shift
640 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
641 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
642 echo "text to replace that phrase with."
645 grep "$phrase" "$file" >/dev/null
646 # replace if the phrase is there, otherwise add it.
647 if [ $? -eq 0 ]; then
648 replace_pattern_in_file "$file" "$phrase" "$replacement"
650 # this had better be the complete line.
651 echo "$replacement" >>"$file"
655 ############################
657 # finds a variable (first parameter) in a particular property file
658 # (second parameter). the expected format for the file is:
660 function seek_variable()
662 local find_var="$1"; shift
663 local file="$1"; shift
664 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
665 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
670 if [ ${#line} -eq 0 ]; then continue; fi
671 # split the line into the variable name and value.
672 IFS='=' read -a assignment <<< "$line"
673 local var="${assignment[0]}"
674 local value="${assignment[1]}"
675 if [ "${value:0:1}" == '"' ]; then
676 # assume the entry was in quotes and remove them.
677 value="${value:1:$((${#value} - 2))}"
679 if [ "$find_var" == "$var" ]; then
685 # finds a variable (first parameter) in a particular XML format file
686 # (second parameter). the expected format for the file is:
687 # ... name="varX" value="valueX" ...
688 function seek_variable_in_xml()
690 local find_var="$1"; shift
691 local file="$1"; shift
692 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
693 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
694 echo "secondly an XML file where the variable's value will be sought."
699 if [ ${#line} -eq 0 ]; then continue; fi
700 # process the line to make it more conventional looking.
701 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
702 # split the line into the variable name and value.
703 IFS='=' read -a assignment <<< "$line"
704 local var="${assignment[0]}"
705 local value="${assignment[1]}"
706 if [ "${value:0:1}" == '"' ]; then
707 # assume the entry was in quotes and remove them.
708 value="${value:1:$((${#value} - 2))}"
710 if [ "$find_var" == "$var" ]; then
716 ############################
718 # goes to a particular directory passed as parameter 1, and then removes all
719 # the parameters after that from that directory.
720 function push_whack_pop()
722 local dir="$1"; shift
723 pushd "$dir" &>/dev/null
724 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
725 rm -rf $* &>/dev/null
726 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
732 # new breed of definer functions goes here. still in progress.
734 # defines an alias and remembers that this is a new or modified definition.
735 # if the feisty meow codebase is unloaded, then so are all the aliases that
737 function define_yeti_alias()
739 # if alias exists already, save old value for restore,
740 # otherwise save null value for restore,
741 # have to handle unaliasing if there was no prior value of one
743 # add alias name to a list of feisty defined aliases.
745 #hmmm: first implem, just do the alias and get that working...
754 #hmmm: this points to an extended functions file being needed; not all of these are core.
756 # displays documentation in "md" formatted files.
759 local file="$1"; shift
760 pandoc "$file" | lynx -stdin
765 # just shows a separator line for an 80 column console, or uses the first
766 # parameter as the number of columns to expect.
770 if [ -z "$count" ]; then
775 for ((i=0; i < $count - 1; i++)); do
781 # alias for separator.
789 # count the number of sub-directories in a directory and echo the result.
790 function count_directories()
792 local subbydir="$1"; shift
793 numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
797 # takes a string and capitalizes just the first character. any capital letters in the remainder of
798 # the string are made lower case. the processed string is returned by an echo.
799 function capitalize_first_char()
801 local to_dromedary="$1"; shift
802 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
806 # given a source path and a target path, this will make a symbolic link from
807 # the source to the destination, but only if the source actually exists.
808 function make_safe_link()
810 local src="$1"; shift
811 local target="$1"; shift
813 if [ -d "$src" ]; then
814 ln -s "$src" "$target"
815 exit_on_error "Creating symlink from '$src' to '$target'"
817 echo "Created symlink from '$src' to '$target'."
820 # pretty prints the json files provided as parameters.
821 function clean_json()
823 if [ -z "$*" ]; then return; fi
826 local file="$1"; shift
827 if [ -z "$file" ]; then break; fi
828 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
829 temp_out="$TMP/$file.view"
830 cat "$file" | python -m json.tool > "$temp_out"
831 show_list+=($temp_out)
832 continue_on_error "pretty printing '$file'"
834 filedump "${show_list[@]}"
840 # only print our special headers or text fields.
844 grep -i "\"text\":\|^=.*" |
845 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
850 # echoes the machine's hostname. can be used like so:
851 # local my_host=$(get_hostname)
852 function get_hostname()
854 # there used to be more variation in how to do this, but adopting mingw
855 # and cygwin tools really helped out.
856 local this_host=unknown
857 if [ "$OS" == "Windows_NT" ]; then
858 this_host=$(hostname)
859 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
860 this_host=$(hostname)
861 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
862 this_host=$(hostname --long)
863 elif [ -x "$(which hostname 2>/dev/null)" ]; then
864 this_host=$(hostname)
869 # makes sure that the provided "folder" is a directory and is writable.
870 function test_writeable()
872 local folder="$1"; shift
873 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
879 # given a filename and a string to seek and a number of lines, then this
880 # function will remove the first occurrence of a line in the file that
881 # matches the string, and it will also axe the next N lines as specified.
882 function create_chomped_copy_of_file()
884 local filename="$1"; shift
885 local seeker="$1"; shift
886 local numlines=$1; shift
888 #echo into create_chomped_copy...
889 #var filename seeker numlines
891 # make a backup first, oy.
892 \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
893 exit_on_error "backing up file: $filename"
895 # make a temp file to write to before we move file into place in bind.
896 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
897 \rm -f "$new_version"
898 exit_on_error "cleaning out new version of file from: $new_version"
904 # don't bother looking at the lines if we're already in skip mode.
905 if [[ $skip_count == 0 ]]; then
906 # find the string they're seeking.
907 if [[ ! "$line" =~ .*${seeker}.* ]]; then
909 echo "$line" >> "$new_version"
911 # a match! start skipping. we will delete this line and the next N lines.
913 #echo first skip count is now $skip_count
917 # we're already skipping. let's keep going until we hit the limit.
919 #echo ongoing skip count is now $skip_count
920 if (( $skip_count > $numlines )); then
921 echo "Done skipping, and back to writing output file."
927 #echo file we created looks like this:
930 if [ ! -z "$found_any" ]; then
931 # put the file back into place under the original name.
932 \mv "$new_version" "$filename"
933 exit_on_error "moving the new version into place in: $filename"
935 # cannot always be considered an error, but we can at least gripe.
936 echo "Did not find any matches for seeker '$seeker' in file: $filename"
942 # space 'em all: fixes naming for all of the files of the appropriate types
943 # in the directories specified.
944 function spacemall() {
945 local -a dirs=("${@}")
946 if [ ${#dirs[@]} -eq 0 ]; then
950 local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)"
951 find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f | \
953 "doc\|docx\|eml\|html\|jpeg\|jpg\|m4a\|mov\|mp3\|ods\|odt\|pdf\|png\|ppt\|pptx\|txt\|vsd\|vsdx\|xls\|xlsx\|zip" | \
954 sed -e 's/^/"/' | sed -e 's/$/"/' | \
955 xargs bash "$FEISTY_MEOW_SCRIPTS/files/spacem.sh"
956 # drop the temp file now that we're done.
962 # site avenger aliases
965 THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
966 source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
972 # you have hit the borderline functional zone...
974 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
975 # restarts the sound driver.
976 function fix_sound_driver() {
977 # stop bash complaining about blank function body.
980 # sudo service alsasound restart
981 #elif pulse something
990 # ...and here's the end of the borderline functional zone.
994 # NOTE: no more function definitions are allowed after this point.
996 function function_sentinel()
1001 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
1005 # test code for set_var_if_undefined.
1007 if [ $run_test != 0 ]; then
1008 echo running tests on set_var_if_undefined.
1010 set_var_if_undefined flagrant forknordle
1011 exit_on_error "testing if defined variable would be whacked"
1012 if [ $flagrant != petunia ]; then
1013 echo set_var_if_undefined failed to leave the test variable alone
1016 unset bobblehead_stomper
1017 set_var_if_undefined bobblehead_stomper endurance
1018 if [ $bobblehead_stomper != endurance ]; then
1019 echo set_var_if_undefined failed to set a variable that was not defined yet