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 -C "${args[@]}"
229 # removed -Y flag because considered dangerous to trust remote hosts to not abuse our X session.
231 # # restore the terminal variable also.
234 restore_terminal_title
235 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
236 echo TERM title restored to prior value
242 # locates a process given a search pattern to match in the process list.
244 # + the -u flag specifies a user name, e.g. "-u joe", which causes only
245 # the processes of that user "joe" to be considered.
247 # + the -x flag specifies a pattern to exclude from the list, e.g. "-x pszap.sh"
248 # would ignore any processes that mention the phrase "pszap.sh".
251 # default user flag is for all users.
252 local excluder="ScrengeflebbitsAPhraseWeNeverExpecttomatchanythingYO298238"
253 # for our default, pick an exclusion string we would never match.
256 while [ $found_flag -eq 1 ]; do
257 # reset our sentinel now that we're safely in our loop.
260 # save the first argument, since we're going to shift the args.
262 if [ "$arg1" == "-u" ]; then
263 # handle the user flag.
265 #echo "found a -u parm and user=$2"
266 found_flag=1 # signal that we found one.
267 # skip these two arguments, since we've consumed them.
270 elif [ "$arg1" == "-x" ]; then
271 # handle the exclusion flag.
273 #echo "found a -x parm and excluder=$excluder"
274 found_flag=1 # signal that we found one.
275 # skip these two arguments, since we've consumed them.
281 # now that we've yanked any flags out, we can pull the rest of the
282 # arguments in as patterns to seek in the process list.
283 local -a patterns=("${@}")
285 #echo patterns list is: "${patterns[@]}"
288 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
291 if [ "$OS" == "Windows_NT" ]; then
292 # gets cygwin's (god awful) ps to show windoze processes also.
293 local EXTRA_DOZER_FLAGS="-W"
294 # pattern to use for peeling off the process numbers.
295 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
298 # flags which clean up the process listing output on unixes.
299 # apparently cygwin doesn't count as a type of unix, because their
300 # crummy specialized ps command doesn't support normal ps flags.
301 local EXTRA_UNIX_FLAGS="-o pid,args"
302 # pattern to use for peeling off the process numbers.
303 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
306 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
308 #echo got all this stuff in the pid dump file:
312 # search for the pattern the user wants to find, and just pluck the process
313 # ids out of the results.
315 for i in "${patterns[@]}"; do
316 #echo "pattern curr is '$i'"
317 PIDS_SOUGHT+=($(cat $PID_DUMP \
319 | grep -v "$excluder" \
320 | sed -n -e "$pid_finder_pattern"))
323 #echo pids sought list became:
324 #echo "${PIDS_SOUGHT[@]}"
327 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
328 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
330 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
331 echo ${PIDS_SOUGHT[*]}
336 # finds all processes matching the pattern specified and shows their full
337 # process listing (whereas psfind just lists process ids).
340 echo "psa finds processes by pattern, but there was no pattern on the command line."
343 local -a patterns=("${@}")
344 p=$(psfind "${patterns[@]}")
350 if [ "${patterns[0]}" == "-u" ]; then
351 # void the two elements with that user flag so we don't use them as patterns.
352 unset patterns[0] patterns[1]=
356 echo "Processes matching ${patterns[@]}..."
358 if [ -n "$IS_DARWIN" ]; then
361 # only print the header the first time.
362 if [ -z "$fuzil_sentinel" ]; then
365 ps $i -w -u | sed -e '1d'
370 # cases besides mac os x's darwin.
371 if [ "$OS" == "Windows_NT" ]; then
372 # special case for windows.
375 ps -W -p $curr | tail -n +2
378 # normal OSes can handle a nice simple query.
386 #hmmm: holy crowbars, this is an old one. do we ever still have any need of it?
387 # an unfortunately similarly named function to the above 'ps' as in process
388 # methods, but this 'ps' stands for postscript. this takes a postscript file
389 # and converts it into pcl3 printer language and then ships it to the printer.
390 # this mostly makes sense for an environment where one's default printer is
391 # pcl. if the input postscript causes ghostscript to bomb out, there has been
392 # some good success running ps2ps on the input file and using the cleaned
393 # postscript file for printing.
394 function ps2pcl2lpr() {
396 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
402 #hmmm: ugly absolute path here.
404 restore_terminal_title
407 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
408 function unix_to_dos_path() {
409 # we usually remove dos slashes in favor of forward slashes.
411 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
412 # fake this value for non-windows (non-cygwin) platforms.
415 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
416 # insists on the /home form instead of /c/cygwin/home being possible. this is
417 # super frustrating and nightmarish.
418 DOSSYHOME="$(cygpath -am "$HOME")"
421 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
422 # unless this flag is set, in which case we force dos slashes.
423 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'
425 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
429 # # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
430 # # for the cygwin environment currently.
431 # function dos_to_unix_path() {
432 # # we always remove dos slashes in favor of forward slashes.
433 ##old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
434 # echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
437 # returns a successful value (0) if this system is debian or ubuntu.
438 function debian_like() {
439 # decide if we think this is debian or ubuntu or a variant.
440 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
441 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
442 if [ $DEBIAN_LIKE -eq 1 ]; then
443 # success; this is debianish.
446 # this seems like some other OS.
451 # this function wraps the normal sudo by ensuring we replace the terminal
452 # label before we launch what they're passing to sudo. we also preserve
453 # specific variables that enable the main user's ssh credentials to still
454 # be relied on for ssh forwarding, even if the '-i' flag is passed to cause
455 # a fresh shell (which normally doesn't get the launching user's environment
460 # hoist our X authorization info in case environment is passed along;
461 # this can allow root to use our display to show X.org windows.
462 if [ -z "$IMPORTED_XAUTH" -a ! -z "$DISPLAY" ]; then
463 export IMPORTED_XAUTH="$(xauth list $DISPLAY | head -n 1 | awk '{print $3}')"
464 local REMOVE_IMP_XAUTH=true
467 # launch sudo with just the variables we want to reach the other side.
469 varmods+="OLD_HOME=$HOME "
470 if [ ! -z "$IMPORTED_XAUTH" ]; then varmods+="IMPORTED_XAUTH=$IMPORTED_XAUTH "; fi
471 if [ ! -z "$SSH_AUTH_SOCK" ]; then varmods+="SSH_AUTH_SOCK=$SSH_AUTH_SOCK "; fi
472 /usr/bin/sudo $varmods "$@"
475 # take the xauth info away again if it wasn't set already.
476 if [ ! -z "$REMOVE_IMP_XAUTH" ]; then
479 restore_terminal_title
483 # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
484 # this kind of assumes you've already checked them for any salient facts.
485 function clean_cvs_junk() {
487 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
491 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
493 local wheres_nechung=$(whichable nechung)
494 if [ -z "$wheres_nechung" ]; then
495 echo "The nechung oracle program cannot be found. You may want to consider"
496 echo "rebuilding the feisty meow applications with this command:"
497 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
504 # recreates all the generated files that the feisty meow scripts use.
505 function regenerate() {
506 # do the bootstrapping process again.
508 echo "regenerating feisty meow script environment."
509 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
511 # force a full reload by turning off sentinel variables and methods.
512 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
513 unalias CORE_ALIASES_LOADED &>/dev/null
514 unset -f function_sentinel
515 # reload feisty meow environment in current shell.
516 log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell."
517 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
518 # run nechung oracle to give user a new fortune.
520 restore_terminal_title
523 # merges a set of custom scripts into the feisty meow environment. can be
524 # passed a name to use as the custom scripts source folder (found on path
525 # $FEISTY_MEOW_SCRIPTS/customize/{name}), or it will try to guess the name
526 # by using the login name.
527 function recustomize()
529 local custom_user="$1"; shift
530 if [ -z "$custom_user" ]; then
531 # default to login name if there was no name provided.
532 custom_user="$(fm_username)"
533 # we do intend to use the login name here to get the login name and to ignore
534 # if the user has sudo root access; we don't want to provide a custom
537 # chop off any email address style formatting to leave just the name.
538 custom_user="$(echo "$custom_user" | cut -f1 -d'@')"
542 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
543 echo -e "the customization folder for '$custom_user' is missing:
545 $FEISTY_MEOW_SCRIPTS/customize/$custom_user
547 we will skip recustomization, but these other customizations are available:
549 # a little tr and sed magic to fix the carriage returns into commas.
550 local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
551 # make the line feeds and carriage returns manageable with tr.
552 # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
553 # last touch with sed removes the last comma.
558 # recreate the feisty meow loading dock.
559 regenerate >/dev/null
561 # jump into the loading dock and make our custom link.
562 pushd "$FEISTY_MEOW_LOADING_DOCK" &>/dev/null
563 if [ -h custom ]; then
564 # there's an existing link, so remove it.
567 # make sure we cleaned up the area before we re-link.
568 if [ -h custom -o -d custom -o -f custom ]; then
570 Due to an over-abundance of caution, we are not going to remove an unexpected
571 'custom' object found in the file system. This object is located in the
572 feisty meow loading dock here: $(pwd)
573 And here is a description of the rogue 'custom' object:
577 If you are pretty sure that this is just a remnant of an older approach in
578 feisty meow, where we copied the custom directory rather than linking it
579 (and it most likely is just such a bit of cruft of that nature), then please
580 remove that old remnant 'custom' item, for example by saying:
581 /bin/rm -rf \"custom\" ; popd
582 Sorry for the interruption, but we want to make sure this removal wasn't
583 automatic if there is even a small amount of doubt about the issue."
587 # create the custom folder as a link to the customizations.
588 ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom
592 # now take into account all the customizations by regenerating the feisty meow environment.
595 restore_terminal_title
598 # generates a random password where the first parameter is the number of characters
599 # in the password (default 20) and the second parameter specifies whether to use
600 # special characters (1) or not (0).
601 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
602 function random_password()
604 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
605 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
609 function add_cygwin_drive_mounts() {
610 for i in c d e f g h q z ; do
611 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
612 ln -s /cygdrive/$i $i
616 ############################
618 # takes a file to modify, and then it will replace any occurrences of the
619 # pattern provided as the second parameter with the text in the third
621 function replace_pattern_in_file()
623 local file="$1"; shift
624 local pattern="$1"; shift
625 local replacement="$1"; shift
626 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
627 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
628 echo "text to replace that pattern with."
631 sed -i -e "s%$pattern%$replacement%g" "$file"
634 # similar to replace_pattern_in_file, but also will add the new value
635 # when the old one did not already exist in the file.
636 function replace_if_exists_or_add()
638 local file="$1"; shift
639 local phrase="$1"; shift
640 local replacement="$1"; shift
641 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
642 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
643 echo "text to replace that phrase with."
646 grep "$phrase" "$file" >/dev/null
647 # replace if the phrase is there, otherwise add it.
648 if [ $? -eq 0 ]; then
649 replace_pattern_in_file "$file" "$phrase" "$replacement"
651 # this had better be the complete line.
652 echo "$replacement" >>"$file"
656 ############################
658 # finds a variable (first parameter) in a particular property file
659 # (second parameter). the expected format for the file is:
661 function seek_variable()
663 local find_var="$1"; shift
664 local file="$1"; shift
665 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
666 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
671 if [ ${#line} -eq 0 ]; then continue; fi
672 # split the line into the variable name and value.
673 IFS='=' read -a assignment <<< "$line"
674 local var="${assignment[0]}"
675 local value="${assignment[1]}"
676 if [ "${value:0:1}" == '"' ]; then
677 # assume the entry was in quotes and remove them.
678 value="${value:1:$((${#value} - 2))}"
680 if [ "$find_var" == "$var" ]; then
686 # finds a variable (first parameter) in a particular XML format file
687 # (second parameter). the expected format for the file is:
688 # ... name="varX" value="valueX" ...
689 function seek_variable_in_xml()
691 local find_var="$1"; shift
692 local file="$1"; shift
693 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
694 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
695 echo "secondly an XML file where the variable's value will be sought."
700 if [ ${#line} -eq 0 ]; then continue; fi
701 # process the line to make it more conventional looking.
702 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
703 # split the line into the variable name and value.
704 IFS='=' read -a assignment <<< "$line"
705 local var="${assignment[0]}"
706 local value="${assignment[1]}"
707 if [ "${value:0:1}" == '"' ]; then
708 # assume the entry was in quotes and remove them.
709 value="${value:1:$((${#value} - 2))}"
711 if [ "$find_var" == "$var" ]; then
717 ############################
719 # goes to a particular directory passed as parameter 1, and then removes all
720 # the parameters after that from that directory.
721 function push_whack_pop()
723 local dir="$1"; shift
724 pushd "$dir" &>/dev/null
725 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
726 rm -rf $* &>/dev/null
727 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
733 # new breed of definer functions goes here. still in progress.
735 # defines an alias and remembers that this is a new or modified definition.
736 # if the feisty meow codebase is unloaded, then so are all the aliases that
738 function define_yeti_alias()
740 # if alias exists already, save old value for restore,
741 # otherwise save null value for restore,
742 # have to handle unaliasing if there was no prior value of one
744 # add alias name to a list of feisty defined aliases.
746 #hmmm: first implem, just do the alias and get that working...
755 #hmmm: this points to an extended functions file being needed; not all of these are core.
757 # displays documentation in "md" formatted files.
760 local file="$1"; shift
761 pandoc "$file" | lynx -stdin
766 # just shows a separator line for an 80 column console, or uses the first
767 # parameter as the number of columns to expect.
771 if [ -z "$count" ]; then
776 for ((i=0; i < $count - 1; i++)); do
782 # alias for separator.
790 # count the number of sub-directories in a directory and echo the result.
791 function count_directories()
793 local subbydir="$1"; shift
794 numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
798 # takes a string and capitalizes just the first character. any capital letters in the remainder of
799 # the string are made lower case. the processed string is returned by an echo.
800 function capitalize_first_char()
802 local to_dromedary="$1"; shift
803 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
807 # given a source path and a target path, this will make a symbolic link from
808 # the source to the destination, but only if the source actually exists.
809 function make_safe_link()
811 local src="$1"; shift
812 local target="$1"; shift
814 if [ -d "$src" ]; then
815 ln -s "$src" "$target"
816 exit_on_error "Creating symlink from '$src' to '$target'"
818 echo "Created symlink from '$src' to '$target'."
821 # pretty prints the json files provided as parameters.
822 function clean_json()
824 if [ -z "$*" ]; then return; fi
827 local file="$1"; shift
828 if [ -z "$file" ]; then break; fi
829 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
830 temp_out="$TMP/$file.view"
831 cat "$file" | python -m json.tool > "$temp_out"
832 show_list+=($temp_out)
833 continue_on_error "pretty printing '$file'"
835 filedump "${show_list[@]}"
841 # only print our special headers or text fields.
845 grep -i "\"text\":\|^=.*" |
846 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
851 # echoes the machine's hostname. can be used like so:
852 # local my_host=$(get_hostname)
853 function get_hostname()
855 # there used to be more variation in how to do this, but adopting mingw
856 # and cygwin tools really helped out.
857 local this_host=unknown
858 if [ "$OS" == "Windows_NT" ]; then
859 this_host=$(hostname)
860 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
861 this_host=$(hostname)
862 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
863 this_host=$(hostname --long)
864 elif [ -x "$(whichable hostname)" ]; then
865 this_host=$(hostname)
870 # makes sure that the provided "folder" is a directory and is writable.
871 function test_writeable()
873 local folder="$1"; shift
874 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
880 # given a filename and a string to seek and a number of lines, then this
881 # function will remove the first occurrence of a line in the file that
882 # matches the string, and it will also axe the next N lines as specified.
883 function create_chomped_copy_of_file()
885 local filename="$1"; shift
886 local seeker="$1"; shift
887 local numlines=$1; shift
889 #echo into create_chomped_copy...
890 #var filename seeker numlines
892 # make a backup first, oy.
893 \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
894 exit_on_error "backing up file: $filename"
896 # make a temp file to write to before we move file into place in bind.
897 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
898 \rm -f "$new_version"
899 exit_on_error "cleaning out new version of file from: $new_version"
905 # don't bother looking at the lines if we're already in skip mode.
906 if [[ $skip_count == 0 ]]; then
907 # find the string they're seeking.
908 if [[ ! "$line" =~ .*${seeker}.* ]]; then
910 echo "$line" >> "$new_version"
912 # a match! start skipping. we will delete this line and the next N lines.
914 #echo first skip count is now $skip_count
918 # we're already skipping. let's keep going until we hit the limit.
920 #echo ongoing skip count is now $skip_count
921 if (( $skip_count > $numlines )); then
922 echo "Done skipping, and back to writing output file."
928 #echo file we created looks like this:
931 if [ ! -z "$found_any" ]; then
932 # put the file back into place under the original name.
933 \mv "$new_version" "$filename"
934 exit_on_error "moving the new version into place in: $filename"
936 # cannot always be considered an error, but we can at least gripe.
937 echo "Did not find any matches for seeker '$seeker' in file: $filename"
943 # space 'em all: fixes naming for all of the files of the appropriate types
944 # in the directories specified.
945 function spacemall() {
946 local -a dirs=("${@}")
947 if [ ${#dirs[@]} -eq 0 ]; then
951 local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)"
952 #hmmm: any way to do the below more nicely or reusably?
953 #hmmm: yes! a variable with a list of files that are considered TEXT_FILE_EXTENSIONS or something like that.
954 #hmmm: yes continued! also a variable for BINARY_FILE_EXTENSIONS to avoid those, where we need to in other scripts.
955 find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f -and -not -iname ".[a-zA-Z0-9]*" | \
957 "csv\|doc\|docx\|eml\|html\|jpeg\|jpg\|m4a\|mov\|mp3\|ods\|odt\|pdf\|png\|ppt\|pptx\|rtf\|txt\|vsd\|vsdx\|xls\|xlsx\|xml\|zip" | \
958 sed -e 's/^/"/' | sed -e 's/$/"/' | \
959 xargs bash "$FEISTY_MEOW_SCRIPTS/files/spacem.sh"
960 # drop the temp file now that we're done.
966 # tty relevant functions...
968 # keep_awake: sends a message to the screen from the background.
969 function keep_awake()
971 # just starts the keep_awake process in the background.
972 bash $FEISTY_MEOW_SCRIPTS/tty/keep_awake_process.sh &
973 # this should leave the job running as %1 or a higher number if there
974 # are pre-existing background jobs.
979 # site avenger functions...
983 THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
984 source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
990 # you have hit the borderline functional zone...
992 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
993 # restarts the sound driver.
994 function fix_sound_driver() {
995 # stop bash complaining about blank function body.
998 # sudo service alsasound restart
999 #elif pulse something
1000 # sudo pulseaudio -k
1001 # sudo pulseaudio -D
1003 # something else...?
1008 # ...and here's the end of the borderline functional zone.
1012 # NOTE: no more function definitions are allowed after this point.
1014 function function_sentinel()
1019 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
1023 # test code for set_var_if_undefined.
1025 if [ $run_test != 0 ]; then
1026 echo running tests on set_var_if_undefined.
1028 set_var_if_undefined flagrant forknordle
1029 exit_on_error "testing if defined variable would be whacked"
1030 if [ $flagrant != petunia ]; then
1031 echo set_var_if_undefined failed to leave the test variable alone
1034 unset bobblehead_stomper
1035 set_var_if_undefined bobblehead_stomper endurance
1036 if [ $bobblehead_stomper != endurance ]; then
1037 echo set_var_if_undefined failed to set a variable that was not defined yet