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 # copies a set of custom scripts into the proper location for feisty meow
488 # to merge their functions and aliases with the standard set.
489 function recustomize()
491 local custom_user="$1"; shift
492 if [ -z "$custom_user" ]; then
493 # default to login name if there was no name provided.
494 custom_user="$(logname)"
495 # we do intend to use logname here to get the login name and to ignore
496 # if the user has sudo root access; we don't want to provide a custom
502 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
503 echo -e "the customization folder for '$custom_user' is missing:
505 $FEISTY_MEOW_SCRIPTS/customize/$custom_user
507 we will skip recustomization, but these other customizations are available:
509 # a little tr and sed magic to fix the carriage returns into commas.
510 local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
511 # make the line feeds and carriage returns manageable with tr.
512 # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
513 # last touch with sed removes the last comma.
518 # prevent permission foul-ups.
520 # here we definitely want the effective user name (in USER), since
521 # we don't want, say, fred (as logname) to own all of root's loading
523 chown -R "$my_user:$my_user" \
524 "$FEISTY_MEOW_LOADING_DOCK"/* "$FEISTY_MEOW_GENERATED_STORE"/* 2>/dev/null
525 continue_on_error "chowning feisty meow generated directories to $my_user"
527 regenerate >/dev/null
528 pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
529 incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
531 local fail_message="\n
532 are the perl dependencies installed? if you're on ubuntu or debian, try this:\n
533 $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n
534 or if you're on cygwin, then try this (if apt-cyg is available):\n
535 $(grep "apt-cyg.*perl" $FEISTY_MEOW_APEX/readme.txt)\n";
537 #echo "the incongruous files list is: $incongruous_files"
538 # disallow a single character result, since we get "*" as result when nothing exists yet.
539 if [ ${#incongruous_files} -ge 2 ]; then
540 log_feisty_meow_event "cleaning unknown older overrides..."
541 perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
542 continue_on_error "running safedel. $fail_message"
545 log_feisty_meow_event "copying custom overrides for $custom_user"
546 mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
547 perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
548 continue_on_error "running cpdiff. $fail_message"
550 if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
551 log_feisty_meow_event "copying custom scripts for $custom_user"
552 #hmmm: could save output to show if an error occurs.
553 rsync -avz "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
554 continue_on_error "copying customization scripts"
558 # prevent permission foul-ups, again.
559 chown -R "$my_user:$my_user" \
560 "$FEISTY_MEOW_LOADING_DOCK" "$FEISTY_MEOW_GENERATED_STORE" 2>/dev/null
561 continue_on_error "once more chowning feisty meow generated directories to $my_user"
563 restore_terminal_title
566 # generates a random password where the first parameter is the number of characters
567 # in the password (default 20) and the second parameter specifies whether to use
568 # special characters (1) or not (0).
569 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
570 function random_password()
572 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
573 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
577 # a wrapper for the which command that finds items on the path. some OSes
578 # do not provide which, so we want to not be spewing errors when that
583 which which &>/dev/null
584 if [ $? -ne 0 ]; then
585 # there is no which command here. we produce nothing due to this.
588 echo $(which $to_find)
591 function add_cygwin_drive_mounts() {
592 for i in c d e f g h q z ; do
593 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
594 ln -s /cygdrive/$i $i
598 ############################
600 # takes a file to modify, and then it will replace any occurrences of the
601 # pattern provided as the second parameter with the text in the third
603 function replace_pattern_in_file()
605 local file="$1"; shift
606 local pattern="$1"; shift
607 local replacement="$1"; shift
608 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
609 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
610 echo "text to replace that pattern with."
613 sed -i -e "s%$pattern%$replacement%g" "$file"
616 # similar to replace_pattern_in_file, but also will add the new value
617 # when the old one did not already exist in the file.
618 function replace_if_exists_or_add()
620 local file="$1"; shift
621 local phrase="$1"; shift
622 local replacement="$1"; shift
623 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
624 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
625 echo "text to replace that phrase with."
628 grep "$phrase" "$file" >/dev/null
629 # replace if the phrase is there, otherwise add it.
630 if [ $? -eq 0 ]; then
631 replace_pattern_in_file "$file" "$phrase" "$replacement"
633 # this had better be the complete line.
634 echo "$replacement" >>"$file"
638 ############################
640 # finds a variable (first parameter) in a particular property file
641 # (second parameter). the expected format for the file is:
643 function seek_variable()
645 local find_var="$1"; shift
646 local file="$1"; shift
647 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
648 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
653 if [ ${#line} -eq 0 ]; then continue; fi
654 # split the line into the variable name and value.
655 IFS='=' read -a assignment <<< "$line"
656 local var="${assignment[0]}"
657 local value="${assignment[1]}"
658 if [ "${value:0:1}" == '"' ]; then
659 # assume the entry was in quotes and remove them.
660 value="${value:1:$((${#value} - 2))}"
662 if [ "$find_var" == "$var" ]; then
668 # finds a variable (first parameter) in a particular XML format file
669 # (second parameter). the expected format for the file is:
670 # ... name="varX" value="valueX" ...
671 function seek_variable_in_xml()
673 local find_var="$1"; shift
674 local file="$1"; shift
675 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
676 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
677 echo "secondly an XML file where the variable's value will be sought."
682 if [ ${#line} -eq 0 ]; then continue; fi
683 # process the line to make it more conventional looking.
684 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
685 # split the line into the variable name and value.
686 IFS='=' read -a assignment <<< "$line"
687 local var="${assignment[0]}"
688 local value="${assignment[1]}"
689 if [ "${value:0:1}" == '"' ]; then
690 # assume the entry was in quotes and remove them.
691 value="${value:1:$((${#value} - 2))}"
693 if [ "$find_var" == "$var" ]; then
699 ############################
701 # goes to a particular directory passed as parameter 1, and then removes all
702 # the parameters after that from that directory.
703 function push_whack_pop()
705 local dir="$1"; shift
706 pushd "$dir" &>/dev/null
707 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
708 rm -rf $* &>/dev/null
709 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
715 # while [ $# -gt 0 ]; do
717 # if [ ! -f "$arg" -a ! -d "$arg" ]; then
718 # echo "=> did not find a file or directory named '$arg'."
722 # # first we will capture the output of the character replacement operation for reporting.
723 # # this is done first since some filenames can't be properly renamed in perl (e.g. if they
724 # # have pipe characters apparently).
725 # intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
726 # local saw_intermediate_result=0
727 # if [ -z "$intermediate_name" ]; then
728 # # make sure we report something, if there are no further name changes.
729 # intermediate_name="'$arg'"
731 # # now zap the first part of the name off (since original name isn't needed).
732 # intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
733 # saw_intermediate_result=1
736 # # first we rename the file to be lower case.
737 # actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
738 # final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
739 # local saw_final_result=0
740 # if [ -z "$final_name" ]; then
741 # final_name="$intermediate_name"
743 # final_name="$(echo $final_name | sed -e 's/.*=> //')"
746 ##echo intermed=$saw_intermediate_result
747 ##echo final=$saw_final_result
749 # if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
750 # # printout the combined operation results.
751 # echo "'$arg' => $final_name"
758 # new breed of definer functions goes here. still in progress.
760 # defines an alias and remembers that this is a new or modified definition.
761 # if the feisty meow codebase is unloaded, then so are all the aliases that
763 function define_yeti_alias()
765 # if alias exists already, save old value for restore,
766 # otherwise save null value for restore,
767 # have to handle unaliasing if there was no prior value of one
769 # add alias name to a list of feisty defined aliases.
771 #hmmm: first implem, just do the alias and get that working...
780 #hmmm: this points to an extended functions file being needed; not all of these are core.
782 # displays documentation in "md" formatted files.
785 local file="$1"; shift
786 pandoc "$file" | lynx -stdin
791 # just shows a separator line for an 80 column console, or uses the first
792 # parameter as the number of columns to expect.
796 if [ -z "$count" ]; then
801 for ((i=0; i < $count - 1; i++)); do
807 # alias for separator.
815 # count the number of sub-directories in a directory and echo the result.
816 function count_directories()
818 local subbydir="$1"; shift
819 numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
823 # takes a string and capitalizes just the first character. any capital letters in the remainder of
824 # the string are made lower case. the processed string is returned by an echo.
825 function capitalize_first_char()
827 local to_dromedary="$1"; shift
828 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
832 # given a source path and a target path, this will make a symbolic link from
833 # the source to the destination, but only if the source actually exists.
834 function make_safe_link()
836 local src="$1"; shift
837 local target="$1"; shift
839 if [ -d "$src" ]; then
840 ln -s "$src" "$target"
841 exit_on_error "Creating symlink from '$src' to '$target'"
843 echo "Created symlink from '$src' to '$target'."
846 # pretty prints the json files provided as parameters.
847 function clean_json()
849 if [ -z "$*" ]; then return; fi
852 local file="$1"; shift
853 if [ -z "$file" ]; then break; fi
854 if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
855 temp_out="$TMP/$file.view"
856 cat "$file" | python -m json.tool > "$temp_out"
857 show_list+=($temp_out)
858 continue_on_error "pretty printing '$file'"
860 filedump "${show_list[@]}"
866 # only print our special headers or text fields.
870 grep -i "\"text\":\|^=.*" |
871 sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
876 # echoes the machine's hostname. can be used like so:
877 # local my_host=$(get_hostname)
878 function get_hostname()
880 # there used to be more variation in how to do this, but adopting mingw
881 # and cygwin tools really helped out.
882 local this_host=unknown
883 if [ "$OS" == "Windows_NT" ]; then
884 this_host=$(hostname)
885 elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
886 this_host=$(hostname)
887 elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
888 this_host=$(hostname --long)
889 elif [ -x "$(which hostname 2>/dev/null)" ]; then
890 this_host=$(hostname)
895 # makes sure that the provided "folder" is a directory and is writable.
896 function test_writeable()
898 local folder="$1"; shift
899 if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
905 # given a filename and a string to seek and a number of lines, then this
906 # function will remove the first occurrence of a line in the file that
907 # matches the string, and it will also axe the next N lines as specified.
908 function create_chomped_copy_of_file()
910 local filename="$1"; shift
911 local seeker="$1"; shift
912 local numlines=$1; shift
914 #echo into create_chomped_copy...
915 #var filename seeker numlines
917 # make a backup first, oy.
918 \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
919 exit_on_error "backing up file: $filename"
921 # make a temp file to write to before we move file into place in bind.
922 local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
923 \rm -f "$new_version"
924 exit_on_error "cleaning out new version of file from: $new_version"
930 # don't bother looking at the lines if we're already in skip mode.
931 if [[ $skip_count == 0 ]]; then
932 # find the string they're seeking.
933 if [[ ! "$line" =~ .*${seeker}.* ]]; then
935 echo "$line" >> "$new_version"
937 # a match! start skipping. we will delete this line and the next N lines.
939 #echo first skip count is now $skip_count
943 # we're already skipping. let's keep going until we hit the limit.
945 #echo ongoing skip count is now $skip_count
946 if (( $skip_count > $numlines )); then
947 echo "Done skipping, and back to writing output file."
953 #echo file we created looks like this:
956 if [ ! -z "$found_any" ]; then
957 # put the file back into place under the original name.
958 \mv "$new_version" "$filename"
959 exit_on_error "moving the new version into place in: $filename"
961 # cannot always be considered an error, but we can at least gripe.
962 echo "Did not find any matches for seeker '$seeker' in file: $filename"
968 # site avenger aliases
971 THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
972 source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
978 # NOTE: no more function definitions are allowed after this point.
980 function function_sentinel()
985 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
989 # test code for set_var_if_undefined.
991 if [ $run_test != 0 ]; then
992 echo running tests on set_var_if_undefined.
994 set_var_if_undefined flagrant forknordle
995 exit_on_error "testing if defined variable would be whacked"
996 if [ $flagrant != petunia ]; then
997 echo set_var_if_undefined failed to leave the test variable alone
1000 unset bobblehead_stomper
1001 set_var_if_undefined bobblehead_stomper endurance
1002 if [ $bobblehead_stomper != endurance ]; then
1003 echo set_var_if_undefined failed to set a variable that was not defined yet