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
44 [[ "$(declare -p $1)" =~ "declare -a" ]]
52 # displays the value of a variable in bash friendly format.
57 local varname="$1"; shift
58 if [ -z "$varname" ]; then
62 if is_alias "$varname"; then
63 #echo found $varname is alias
64 local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
65 alias $varname | sed -e 's/.*=//' >$tmpfile
66 echo "alias $varname=$(cat $tmpfile)"
68 elif [ -z "${!varname}" ]; then
69 echo "$varname undefined"
71 if is_array "$varname"; then
72 #echo found $varname is array var
74 eval temparray="(\${$varname[@]})"
75 echo "$varname=(${temparray[@]})"
76 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
77 # see ones that have spaces in them.
79 #echo found $varname is simple
80 echo "$varname=${!varname}"
87 # when passed a list of things, this will return the unique items from that list as an echo.
90 # do the uniquification: split the space separated items into separate lines, then
91 # sort the list, then run the uniq tool on the list. results will be packed back onto
92 # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
93 echo $* | tr ' ' '\n' | sort | uniq
96 # sets the variable in parameter 1 to the value in parameter 2, but only if
97 # that variable was undefined.
98 function set_var_if_undefined()
100 local var_name="$1"; shift
101 local var_value="$1"; shift
102 if [ -z "${!var_name}" ]; then
103 eval export $var_name="$var_value"
107 function success_sound()
109 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
110 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
114 function error_sound()
116 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
117 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
121 # checks the result of the last command that was run, and if that failed,
122 # then this complains and exits from bash. the function parameters are
123 # used as the message to print as a complaint.
124 function check_result()
126 if [ $? -ne 0 ]; then
127 echo -e "failed on: $*"
133 # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
138 # we remember the old terminal title, then force the TERM variable to a more generic
139 # version for the other side (just 'linux'); we don't want the remote side still
140 # thinking it's running xterm.
142 /usr/bin/ssh -X -C "${args[@]}"
143 restore_terminal_title
146 # locates a process given a search pattern to match in the process list.
147 # supports a single command line flag style parameter of "-u USERNAME";
148 # if the -u flag is found, a username is expected afterwards, and only the
149 # processes of that user are considered.
151 local -a patterns=("${@}")
153 #echo patterns list is: "${patterns[@]}"
157 if [ "${patterns[0]}" == "-u" ]; then
158 user_flag="-u ${patterns[1]}"
159 #echo "found a -u parm and user=${patterns[1]}"
160 # void the two elements with that user flag so we don't use them as patterns.
161 unset patterns[0] patterns[1]=
167 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
170 if [ "$OS" == "Windows_NT" ]; then
171 # gets cygwin's (god awful) ps to show windoze processes also.
172 local EXTRA_DOZER_FLAGS="-W"
173 # pattern to use for peeling off the process numbers.
174 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
177 # flags which clean up the process listing output on unixes.
178 # apparently cygwin doesn't count as a type of unix, because their
179 # crummy specialized ps command doesn't support normal ps flags.
180 local EXTRA_UNIX_FLAGS="-o pid,args"
181 # pattern to use for peeling off the process numbers.
182 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
185 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
187 #echo got all this stuff in the pid dump file:
191 # search for the pattern the user wants to find, and just pluck the process
192 # ids out of the results.
194 for i in "${patterns[@]}"; do
195 PIDS_SOUGHT+=($(cat $PID_DUMP \
197 | sed -n -e "$pid_finder_pattern"))
200 #echo pids sought list became:
201 #echo "${PIDS_SOUGHT[@]}"
204 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
205 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
207 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
208 echo ${PIDS_SOUGHT[*]}
213 # finds all processes matching the pattern specified and shows their full
214 # process listing (whereas psfind just lists process ids).
217 echo "psa finds processes by pattern, but there was no pattern on the command line."
220 local -a patterns=("${@}")
221 p=$(psfind "${patterns[@]}")
227 if [ "${patterns[0]}" == "-u" ]; then
228 # void the two elements with that user flag so we don't use them as patterns.
229 unset patterns[0] patterns[1]=
233 echo "Processes matching ${patterns[@]}..."
235 if [ -n "$IS_DARWIN" ]; then
238 # only print the header the first time.
239 if [ -z "$fuzil_sentinel" ]; then
242 ps $i -w -u | sed -e '1d'
247 # cases besides mac os x's darwin.
248 if [ "$OS" == "Windows_NT" ]; then
249 # special case for windows.
252 ps -W -p $curr | tail -n +2
255 # normal OSes can handle a nice simple query.
261 # an unfortunately similarly named function to the above 'ps' as in process
262 # methods, but this 'ps' stands for postscript. this takes a postscript file
263 # and converts it into pcl3 printer language and then ships it to the printer.
264 # this mostly makes sense for an environment where one's default printer is
265 # pcl. if the input postscript causes ghostscript to bomb out, there has been
266 # some good success running ps2ps on the input file and using the cleaned
267 # postscript file for printing.
268 function ps2pcl2lpr() {
270 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
274 # function fix_alsa() {
275 # sudo /etc/init.d/alsasound restart
280 #hmmm: ugly absolute path here.
282 restore_terminal_title
285 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
286 function unix_to_dos_path() {
287 # we usually remove dos slashes in favor of forward slashes.
289 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
290 # fake this value for non-windows (non-cygwin) platforms.
293 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
294 # insists on the /home form instead of /c/cygwin/home being possible. this is
295 # super frustrating and nightmarish.
296 DOSSYHOME="$(cygpath -am "$HOME")"
299 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
300 # unless this flag is set, in which case we force dos slashes.
301 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'
303 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
307 # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
308 # for the cygwin environment currently.
309 function dos_to_unix_path() {
310 # we always remove dos slashes in favor of forward slashes.
311 #old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
312 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
315 # returns a successful value (0) if this system is debian or ubuntu.
316 function debian_like() {
317 # decide if we think this is debian or ubuntu or a variant.
318 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
319 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
320 if [ $DEBIAN_LIKE -eq 1 ]; then
321 # success; this is debianish.
324 # this seems like some other OS.
329 # su function: makes su perform a login.
330 # for some OSes, this transfers the X authority information to the new login.
333 # debian currently requires the full version which imports X authority
334 # information for su.
336 # get the x authority info for our current user.
337 source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
339 if [ -z "$X_auth_info" ]; then
340 # if there's no authentication info to pass along, we just do a normal su.
343 # under X, we update the new login's authority info with the previous
345 (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
348 # non-debian supposedly doesn't need the extra overhead any more.
349 # or at least suse doesn't, which is the other one we've tested on.
354 # sudo function wraps the normal sudo by ensuring we replace the terminal
355 # label if they're doing an su with the sudo.
357 # local first_command="$1"
360 restore_terminal_title
361 # if [ "$first_command" == "su" ]; then
362 # # yep, they were doing an su, but they're back now.
363 # label_terminal_with_info
367 # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
368 # this kind of assumes you've already checked them for any salient facts.
369 function clean_cvs_junk() {
371 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
375 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
377 local wheres_nechung=$(which nechung 2>/dev/null)
378 if [ -z "$wheres_nechung" ]; then
379 echo "The nechung oracle program cannot be found. You may want to consider"
380 echo "rebuilding the feisty meow applications with this command:"
381 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
387 # recreates all the generated files that the feisty meow scripts use.
388 function regenerate() {
389 # do the bootstrapping process again.
391 echo "regenerating feisty meow script environment."
392 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
394 # force a full reload by turning off sentinel variables and methods.
395 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
396 unalias CORE_ALIASES_LOADED &>/dev/null
397 unset -f function_sentinel
398 # reload feisty meow environment in current shell.
399 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
400 # run nechung oracle to give user a new fortune.
402 restore_terminal_title
405 # copies a set of custom scripts into the proper location for feisty meow
406 # to merge their functions and aliases with the standard set.
407 function recustomize()
409 local custom_user="$1"; shift
410 if [ -z "$custom_user" ]; then
411 # use our default example user if there was no name provided.
417 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
418 echo "The customization folder provided for $custom_user should be:"
419 echo " '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'"
420 echo "but that folder does not exist. Skipping customization."
423 regenerate >/dev/null
424 pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
425 incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
427 #echo "the incongruous files list is: $incongruous_files"
428 # disallow a single character result, since we get "*" as result when nothing exists yet.
429 if [ ${#incongruous_files} -ge 2 ]; then
430 echo "cleaning unknown older overrides..."
431 perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
435 echo "copying custom overrides for $custom_user"
436 mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
437 perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
438 if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
439 echo "copying custom scripts for $custom_user"
440 \cp -R "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
445 restore_terminal_title
448 # generates a random password where the first parameter is the number of characters
449 # in the password (default 20) and the second parameter specifies whether to use
450 # special characters (1) or not (0).
451 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
452 function random_password()
454 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
455 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
459 # a wrapper for the which command that finds items on the path. some OSes
460 # do not provide which, so we want to not be spewing errors when that
465 which which &>/dev/null
466 if [ $? -ne 0 ]; then
467 # there is no which command here. we produce nothing due to this.
470 echo $(which $to_find)
473 #hmmm: improve this by not adding the link
474 # if already there, or if the drive is not valid.
475 function add_cygwin_drive_mounts() {
476 for i in c d e f g h q z ; do
477 ln -s /cygdrive/$i $i
481 ############################
483 # takes a file to modify, and then it will replace any occurrences of the
484 # pattern provided as the second parameter with the text in the third
486 function replace_pattern_in_file()
488 local file="$1"; shift
489 local pattern="$1"; shift
490 local replacement="$1"; shift
491 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
492 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
493 echo "text to replace that pattern with."
496 sed -i -e "s%$pattern%$replacement%g" "$file"
499 # similar to replace_pattern_in_file, but also will add the new value
500 # when the old one did not already exist in the file.
501 function replace_if_exists_or_add()
503 local file="$1"; shift
504 local phrase="$1"; shift
505 local replacement="$1"; shift
506 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
507 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
508 echo "text to replace that phrase with."
511 grep "$phrase" "$file" >/dev/null
512 # replace if the phrase is there, otherwise add it.
513 if [ $? -eq 0 ]; then
514 replace_pattern_in_file "$file" "$phrase" "$replacement"
516 # this had better be the complete line.
517 echo "$replacement" >>"$file"
521 ############################
523 # finds a variable (first parameter) in a particular property file
524 # (second parameter). the expected format for the file is:
526 function seek_variable()
528 local find_var="$1"; shift
529 local file="$1"; shift
530 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
531 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
536 if [ ${#line} -eq 0 ]; then continue; fi
537 # split the line into the variable name and value.
538 IFS='=' read -a assignment <<< "$line"
539 local var="${assignment[0]}"
540 local value="${assignment[1]}"
541 if [ "${value:0:1}" == '"' ]; then
542 # assume the entry was in quotes and remove them.
543 value="${value:1:$((${#value} - 2))}"
545 if [ "$find_var" == "$var" ]; then
551 # finds a variable (first parameter) in a particular XML format file
552 # (second parameter). the expected format for the file is:
553 # ... name="varX" value="valueX" ...
554 function seek_variable_in_xml()
556 local find_var="$1"; shift
557 local file="$1"; shift
558 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
559 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
560 echo "secondly an XML file where the variable's value will be sought."
565 if [ ${#line} -eq 0 ]; then continue; fi
566 # process the line to make it more conventional looking.
567 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
568 # split the line into the variable name and value.
569 IFS='=' read -a assignment <<< "$line"
570 local var="${assignment[0]}"
571 local value="${assignment[1]}"
572 if [ "${value:0:1}" == '"' ]; then
573 # assume the entry was in quotes and remove them.
574 value="${value:1:$((${#value} - 2))}"
576 if [ "$find_var" == "$var" ]; then
582 ############################
584 # goes to a particular directory passed as parameter 1, and then removes all
585 # the parameters after that from that directory.
586 function push_whack_pop()
588 local dir="$1"; shift
589 pushd "$dir" &>/dev/null
590 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
591 rm -rf $* &>/dev/null
592 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
598 while [ $# -gt 0 ]; do
600 if [ ! -f "$arg" -a ! -d "$arg" ]; then
601 echo "failure to find a file or directory named '$arg'."
605 # first we will capture the output of the character replacement operation for reporting.
606 # this is done first since some filenames can't be properly renamed in perl (e.g. if they
607 # have pipe characters apparently).
608 intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
609 local saw_intermediate_result=0
610 if [ -z "$intermediate_name" ]; then
611 # make sure we report something, if there are no further name changes.
612 intermediate_name="'$arg'"
614 # now zap the first part of the name off (since original name isn't needed).
615 intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
616 saw_intermediate_result=1
619 # first we rename the file to be lower case.
620 actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
621 final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
622 local saw_final_result=0
623 if [ -z "$final_name" ]; then
624 final_name="$intermediate_name"
626 final_name="$(echo $final_name | sed -e 's/.*=> //')"
629 #echo intermed=$saw_intermediate_result
630 #echo final=$saw_final_result
632 if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
633 # printout the combined operation results.
634 echo "'$arg' => $final_name"
641 # new breed of definer functions goes here. still in progress.
643 # defines an alias and remembers that this is a new or modified definition.
644 # if the feisty meow codebase is unloaded, then so are all the aliases that
646 function define_yeti_alias()
648 # if alias exists already, save old value for restore,
649 # otherwise save null value for restore,
650 # have to handle unaliasing if there was no prior value of one
652 # add alias name to a list of feisty defined aliases.
654 #hmmm: first implem, just do the alias and get that working...
663 #hmmm: this points to an extended functions file being needed; not all of these are core.
665 # displays documentation in "md" formatted files.
668 local file="$1"; shift
669 pandoc "$file" | lynx -stdin
674 # just shows a separator line for an 80 column console, or uses the first
675 # parameter as the number of columns to expect.
679 if [ -z "$count" ]; then
684 for ((i=0; i < $count - 1; i++)); do
690 # alias for separator.
698 # count the number of sub-directories in a directory and echo the result.
699 function count_directories()
701 local appsdir="$1"; shift
702 numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
706 # takes a string and capitalizes just the first character. any capital letters in the remainder of
707 # the string are made lower case. the processed string is returned by an echo.
708 function capitalize_first_char()
710 local to_dromedary="$1"; shift
711 to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
715 # given a source path and a target path, this will make a symbolic link from
716 # the source to the destination, but only if the source actually exists.
717 function make_safe_link()
719 local src="$1"; shift
720 local target="$1"; shift
722 if [ -d "$src" ]; then
723 ln -s "$src" "$target"
724 check_result "Creating symlink from '$src' to '$target'"
726 echo "Created symlink from '$src' to '$target'."
731 # NOTE: no more function definitions are allowed after this point.
733 function function_sentinel()
738 if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
742 # test code for set_var_if_undefined.
744 if [ $run_test != 0 ]; then
745 echo running tests on set_var_if_undefined.
747 set_var_if_undefined flagrant forknordle
748 check_result "testing if defined variable would be whacked"
749 if [ $flagrant != petunia ]; then
750 echo set_var_if_undefined failed to leave the test variable alone
753 unset bobblehead_stomper
754 set_var_if_undefined bobblehead_stomper endurance
755 if [ $bobblehead_stomper != endurance ]; then
756 echo set_var_if_undefined failed to set a variable that was not defined yet