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)"
43 #>&2 echo "got whicher as: $WHICHER"
45 # there is no which command here. we produce nothing due to this.
49 local sporkenz # must be defined local here, before call, or we don't get exit value?!
50 sporkenz=$($WHICHER "$to_find" 2>/dev/null)
51 #>&2 echo "broken with this line, but here is exit val: $?"
53 #>&2 echo "got whicher as: $WHICHER"
58 # makes a directory of the name specified and then tries to change the
59 # current directory to that directory.
61 if [ ! -d "$1" ]; then mkdir -p "$1"; fi
65 # returns true if the variable is an array.
67 [[ "$(declare -p $1)" =~ "declare -a" ]]
70 # returns true if the name provided is a defined alias.
76 # makes the status of pipe number N (passed as first parameter) into the
77 # main return value (i.e., the value for $?). this is super handy to avoid
78 # repeating the awkward looking code below in multiple places.
79 function promote_pipe_return()
81 ( exit ${PIPESTATUS[$1]} )
86 function fm_username()
88 # see if we can get the user name from the login name. oddly this sometimes doesn't work.
89 local custom_user="$(logname 2>/dev/null)"
90 if [ -z "$custom_user" ]; then
91 # try the normal unix user variable.
94 if [ -z "$custom_user" ]; then
95 # try the windows user variable.
96 custom_user="$USERNAME"
103 # displays the value of a variable in bash friendly format.
108 local varname="$1"; shift
109 if [ -z "$varname" ]; then
113 if is_alias "$varname"; then
114 #echo found $varname is alias
115 local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
116 alias $varname | sed -e 's/.*=//' >$tmpfile
117 echo "alias $varname=$(cat $tmpfile)"
119 elif [ -z "${!varname}" ]; then
120 echo "$varname undefined"
122 if is_array "$varname"; then
123 #echo found $varname is array var
125 eval temparray="(\${$varname[@]})"
126 echo "$varname=(${temparray[@]})"
127 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
128 # see ones that have spaces in them.
130 #echo found $varname is simple
131 echo "$varname=${!varname}"
140 # when passed a list of things, this will return the unique items from that list as an echo.
143 # do the uniquification: split the space separated items into separate lines, then
144 # sort the list, then run the uniq tool on the list. results will be packed back onto
145 # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
146 echo $* | tr ' ' '\n' | sort | uniq
149 # sets the variable in parameter 1 to the value in parameter 2, but only if
150 # that variable was undefined.
151 function set_var_if_undefined()
153 local var_name="$1"; shift
154 local var_value="$1"; shift
155 if [ -z "${!var_name}" ]; then
156 eval export $var_name="$var_value"
162 function success_sound()
164 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
165 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
169 function error_sound()
171 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
172 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
178 # echoes the maximum number of columns that the terminal supports. usually
179 # anything you print to the terminal with length less than (but not equal to)
180 # maxcols will never wrap.
181 function get_maxcols()
183 # calculate the number of columsn in the terminal.
184 local cols=$(stty size | awk '{print $2}')
190 # checks the result of the last command that was run, and if that failed,
191 # then this complains and exits from bash. the function parameters are
192 # used as the message to print as a complaint.
193 function exit_on_error()
195 if [ $? -ne 0 ]; then
196 echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..."
202 # like exit_on_error, but will keep going after complaining.
203 function continue_on_error()
205 if [ $? -ne 0 ]; then
206 echo -e "\n\na problem occurred, but we can continue:\n\n$*\n\n=> Continuing script..."
213 # accepts any number of arguments and outputs them to the feisty meow event log.
214 function log_feisty_meow_event()
216 echo -e "$(date_stringer) -- ${USER}@$(hostname): $*" >> "$FEISTY_MEOW_EVENT_LOG"
221 # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
225 save_terminal_title # remember the current terminal title.
226 /usr/bin/ssh -C "${args[@]}"
227 #hmmm: removed -Y flag because considered dangerous to trust remote hosts to not abuse our X session.
228 restore_terminal_title
231 # this version of ssh preserves the use of the -Y flag for when X forwarding is needed.
235 save_terminal_title # remember the current terminal title.
236 /usr/bin/ssh -Y "${args[@]}"
237 restore_terminal_title
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 \
514 unalias CORE_ALIASES_LOADED &>/dev/null
515 unset -f function_sentinel
517 # reuse the original path if we can.
518 if [ ! -z "$FEISTY_MEOW_ORIGINAL_PATH" ]; then
519 export PATH="$FEISTY_MEOW_ORIGINAL_PATH"
522 # reload feisty meow environment in current shell.
523 log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell."
524 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
525 # run nechung oracle to give user a new fortune.
527 restore_terminal_title
530 # merges a set of custom scripts into the feisty meow environment. can be
531 # passed a name to use as the custom scripts source folder (found on path
532 # $FEISTY_MEOW_SCRIPTS/customize/{name}), or it will try to guess the name
533 # by using the login name.
534 function recustomize()
536 local custom_user="$1"; shift
537 if [ -z "$custom_user" ]; then
538 # default to login name if there was no name provided.
539 custom_user="$(fm_username)"
540 # we do intend to use the login name here to get the login name and to ignore
541 # if the user has sudo root access; we don't want to provide a custom
544 # chop off any email address style formatting to leave just the name.
545 custom_user="$(echo "$custom_user" | cut -f1 -d'@')"
549 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
550 echo -e "the customization folder for '$custom_user' is missing:
552 $FEISTY_MEOW_SCRIPTS/customize/$custom_user
554 we will skip recustomization, but these other customizations are available:
556 # a little tr and sed magic to fix the carriage returns into commas.
557 local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
558 # make the line feeds and carriage returns manageable with tr.
559 # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
560 # last touch with sed removes the last comma.
565 # recreate the feisty meow loading dock.
566 regenerate >/dev/null
568 # jump into the loading dock and make our custom link.
569 pushd "$FEISTY_MEOW_LOADING_DOCK" &>/dev/null
570 if [ -h custom ]; then
571 # there's an existing link, so remove it.
574 # make sure we cleaned up the area before we re-link.
575 if [ -h custom -o -d custom -o -f custom ]; then
577 Due to an over-abundance of caution, we are not going to remove an unexpected
578 'custom' object found in the file system. This object is located in the
579 feisty meow loading dock here: $(pwd)
580 And here is a description of the rogue 'custom' object:
584 If you are pretty sure that this is just a remnant of an older approach in
585 feisty meow, where we copied the custom directory rather than linking it
586 (and it most likely is just such a bit of cruft of that nature), then please
587 remove that old remnant 'custom' item, for example by saying:
588 /bin/rm -rf \"custom\" ; popd
589 Sorry for the interruption, but we want to make sure this removal wasn't
590 automatic if there is even a small amount of doubt about the issue."
594 # create the custom folder as a link to the customizations.
595 ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom
599 # now take into account all the customizations by regenerating the feisty meow environment.
602 restore_terminal_title
605 # generates a random password where the first parameter is the number of characters
606 # in the password (default 20) and the second parameter specifies whether to use
607 # special characters (1) or not (0).
608 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
609 function random_password()
611 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
612 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
616 function add_cygwin_drive_mounts() {
617 for i in c d e f g h q z ; do
618 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
619 ln -s /cygdrive/$i $i
623 ############################
625 # takes a file to modify, and then it will replace any occurrences of the
626 # pattern provided as the second parameter with the text in the third
628 function replace_pattern_in_file()
630 local file="$1"; shift
631 local pattern="$1"; shift
632 local replacement="$1"; shift
633 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
634 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
635 echo "text to replace that pattern with."
638 sed -i -e "s%$pattern%$replacement%g" "$file"
641 # similar to replace_pattern_in_file, but also will add the new value
642 # when the old one did not already exist in the file.
643 function replace_if_exists_or_add()
645 local file="$1"; shift
646 local phrase="$1"; shift
647 local replacement="$1"; shift
648 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
649 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
650 echo "text to replace that phrase with."
653 grep "$phrase" "$file" >/dev/null
654 # replace if the phrase is there, otherwise add it.
655 if [ $? -eq 0 ]; then
656 replace_pattern_in_file "$file" "$phrase" "$replacement"
658 # this had better be the complete line.
659 echo "$replacement" >>"$file"
663 ############################
665 # finds a variable (first parameter) in a particular property file
666 # (second parameter). the expected format for the file is:
668 function seek_variable()
670 local find_var="$1"; shift
671 local file="$1"; shift
672 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
673 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
678 if [ ${#line} -eq 0 ]; then continue; fi
679 # split the line into the variable name and value.
680 IFS='=' read -a assignment <<< "$line"
681 local var="${assignment[0]}"
682 local value="${assignment[1]}"
683 if [ "${value:0:1}" == '"' ]; then
684 # assume the entry was in quotes and remove them.
685 value="${value:1:$((${#value} - 2))}"
687 if [ "$find_var" == "$var" ]; then
693 # finds a variable (first parameter) in a particular XML format file
694 # (second parameter). the expected format for the file is:
695 # ... name="varX" value="valueX" ...
696 function seek_variable_in_xml()
698 local find_var="$1"; shift
699 local file="$1"; shift
700 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
701 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
702 echo "secondly an XML file where the variable's value will be sought."
707 if [ ${#line} -eq 0 ]; then continue; fi
708 # process the line to make it more conventional looking.
709 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
710 # split the line into the variable name and value.
711 IFS='=' read -a assignment <<< "$line"
712 local var="${assignment[0]}"
713 local value="${assignment[1]}"
714 if [ "${value:0:1}" == '"' ]; then
715 # assume the entry was in quotes and remove them.
716 value="${value:1:$((${#value} - 2))}"
718 if [ "$find_var" == "$var" ]; then
724 ############################
726 # goes to a particular directory passed as parameter 1, and then removes all
727 # the parameters after that from that directory.
728 function push_whack_pop()
730 local dir="$1"; shift
731 pushd "$dir" &>/dev/null
732 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
733 rm -rf $* &>/dev/null
734 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
740 # new breed of definer functions goes here. still in progress.
742 # defines an alias and remembers that this is a new or modified definition.
743 # if the feisty meow codebase is unloaded, then so are all the aliases that
745 function define_yeti_alias()
747 # if alias exists already, save old value for restore,
748 # otherwise save null value for restore,
749 # have to handle unaliasing if there was no prior value of one
751 # add alias name to a list of feisty defined aliases.
753 #hmmm: first implem, just do the alias and get that working...
762 #hmmm: this points to an extended functions file being needed; not all of these are core.
764 # displays documentation in "md" formatted files.
767 local file="$1"; shift
768 pandoc "$file" | lynx -stdin
773 # just shows a separator line for an 80 column console, or uses the first
774 # parameter as the number of columns to expect.
778 if [ -z "$count" ]; then
779 count=$(($COLUMNS - 1))
783 for ((i=0; i < $count; i++)); do
789 # alias for separator.
797 # count the number of sub-directories in a directory and echo the result.
798 function count_directories()
800 local subbydir="$1"; shift
801 numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
805 # takes a string and capitalizes just the first character. any capital letters in the remainder of
806 # the string are made lower case. the processed string is returned by an echo.
807 function capitalize_first_char()
809 local to_dromedary="$1"; shift
810 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
814 # given a source path and a target path, this will make a symbolic link from
815 # the source to the destination, but only if the source actually exists.
816 function make_safe_link()
818 local src="$1"; shift
819 local target="$1"; shift
821 if [ -d "$src" ]; then
822 ln -s "$src" "$target"
823 exit_on_error "Creating symlink from '$src' to '$target'"
825 echo "Created symlink from '$src' to '$target'."
828 # pretty prints the json files provided as parameters.
829 function clean_json()
831 if [ -z "$*" ]; then return; fi
834 local file="$1"; shift
835 if [ -z "$file" ]; then break; fi
836 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
837 temp_out="$TMP/$file.view"
838 cat "$file" | python -m json.tool > "$temp_out"
839 show_list+=($temp_out)
840 continue_on_error "pretty printing '$file'"
842 filedump "${show_list[@]}"
848 # only print our special headers or text fields.
852 grep -i "\"text\":\|^=.*" |
853 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
858 # echoes the machine's hostname. can be used like so:
859 # local my_host=$(get_hostname)
860 function get_hostname()
862 # there used to be more variation in how to do this, but adopting mingw
863 # and cygwin tools really helped out.
864 local this_host=unknown
865 if [ "$OS" == "Windows_NT" ]; then
866 this_host=$(hostname)
867 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
868 this_host=$(hostname)
869 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
870 this_host=$(hostname --long)
871 elif [ -x "$(whichable hostname)" ]; then
872 this_host=$(hostname)
877 # makes sure that the provided "folder" is a directory and is writable.
878 function test_writeable()
880 local folder="$1"; shift
881 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
887 # given a filename and a string to seek and a number of lines, then this
888 # function will remove the first occurrence of a line in the file that
889 # matches the string, and it will also axe the next N lines as specified.
890 function create_chomped_copy_of_file()
892 local filename="$1"; shift
893 local seeker="$1"; shift
894 local numlines=$1; shift
896 #echo into create_chomped_copy...
897 #var filename seeker numlines
899 # make a backup first, oy.
900 \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
901 exit_on_error "backing up file: $filename"
903 # make a temp file to write to before we move file into place in bind.
904 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
905 \rm -f "$new_version"
906 exit_on_error "cleaning out new version of file from: $new_version"
912 # don't bother looking at the lines if we're already in skip mode.
913 if [[ $skip_count == 0 ]]; then
914 # find the string they're seeking.
915 if [[ ! "$line" =~ .*${seeker}.* ]]; then
917 echo "$line" >> "$new_version"
919 # a match! start skipping. we will delete this line and the next N lines.
921 #echo first skip count is now $skip_count
925 # we're already skipping. let's keep going until we hit the limit.
927 #echo ongoing skip count is now $skip_count
928 if (( $skip_count > $numlines )); then
929 echo "Done skipping, and back to writing output file."
935 #echo file we created looks like this:
938 if [ ! -z "$found_any" ]; then
939 # put the file back into place under the original name.
940 \mv "$new_version" "$filename"
941 exit_on_error "moving the new version into place in: $filename"
943 # cannot always be considered an error, but we can at least gripe.
944 echo "Did not find any matches for seeker '$seeker' in file: $filename"
950 # space 'em all: fixes naming for all of the files of the appropriate types
951 # in the directories specified. we skip any file with a dot in front, to
952 # respect their hidden nature. currently the set of files we'll rename is
953 # very boutique; it's in this function, and just happens to be the types of
954 # files we work with a lot.
955 function spacemall() {
956 local -a dirs=("${@}")
957 if [ ${#dirs[@]} -eq 0 ]; then
961 local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)"
962 #hmmm: any way to do the below more nicely or reusably?
963 #hmmm: yes! a variable with a list of files that are considered TEXT_FILE_EXTENSIONS or something like that.
964 #hmmm: yes continued! also a variable for BINARY_FILE_EXTENSIONS to avoid those, where we need to in other scripts.
965 #hmmm: wait, we actually have a mix here, since this is a renaming function and not a searching function; get it straight!
966 #hmmm: would the composition of those two types of extensions cover all the files i want to rename? they have to be "important".
967 find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f -and -not -iname ".[a-zA-Z0-9]*" | \
969 "csv\|doc\|docx\|eml\|html\|jpeg\|jpg\|m4a\|mov\|mp3\|odp\|ods\|odt\|pdf\|png\|ppt\|pptx\|rtf\|txt\|vsd\|vsdx\|xls\|xlsx\|xml\|zip" | \
970 sed -e 's/^/"/' | sed -e 's/$/"/' | \
971 xargs bash "$FEISTY_MEOW_SCRIPTS/files/spacem.sh"
972 # drop the temp file now that we're done.
978 # tty relevant functions...
980 # keep_awake: sends a message to the screen from the background.
981 function keep_awake()
983 # just starts the keep_awake process in the background.
984 bash $FEISTY_MEOW_SCRIPTS/tty/keep_awake_process.sh &
985 # this should leave the job running as %1 or a higher number if there
986 # are pre-existing background jobs.
991 # site avenger functions...
995 THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
996 source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
1002 # you have hit the borderline functional zone...
1004 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
1005 # restarts the sound driver.
1006 function fix_sound_driver() {
1007 # stop bash complaining about blank function body.
1010 # sudo service alsasound restart
1011 #elif pulse something
1012 # sudo pulseaudio -k
1013 # sudo pulseaudio -D
1015 # something else...?
1020 # ...and here's the end of the borderline functional zone.
1024 # NOTE: no more function definitions are allowed after this point.
1026 function function_sentinel()
1031 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
1035 # test code for set_var_if_undefined.
1037 if [ $run_test != 0 ]; then
1038 echo running tests on set_var_if_undefined.
1040 set_var_if_undefined flagrant forknordle
1041 exit_on_error "testing if defined variable would be whacked"
1042 if [ $flagrant != petunia ]; then
1043 echo set_var_if_undefined failed to leave the test variable alone
1046 unset bobblehead_stomper
1047 set_var_if_undefined bobblehead_stomper endurance
1048 if [ $bobblehead_stomper != endurance ]; then
1049 echo set_var_if_undefined failed to set a variable that was not defined yet