3 # This defines some general, useful functions.
5 # test whether we've been here before or not.
7 type function_sentinel &>/dev/null
9 # there was no error, so we can skip the inits.
10 if [ ! -z "$SHELL_DEBUG" ]; then
11 echo "skipping function definitions, because already defined."
18 if [ -z "$skip_all" ]; then
20 if [ ! -z "$SHELL_DEBUG" ]; then
21 echo "feisty meow function definitions beginning now..."
24 # a handy little method that can be used for date strings. it was getting
25 # really tiresome how many different ways the script did the date formatting.
26 function date_stringer() {
28 if [ -z "$sep" ]; then sep='_'; fi
29 date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
32 # makes a directory of the name specified and then tries to change the
33 # current directory to that directory.
35 if [ ! -d "$1" ]; then mkdir -p "$1"; fi
40 [[ "$(declare -p $1)" =~ "declare -a" ]]
48 # displays the value of a variable in bash friendly format.
53 local varname="$1"; shift
54 if [ -z "$varname" ]; then
58 if is_alias "$varname"; then
59 #echo found $varname is alias
60 local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
61 alias $varname | sed -e 's/.*=//' >$tmpfile
62 echo "alias $varname=$(cat $tmpfile)"
64 elif [ -z "${!varname}" ]; then
65 echo "$varname undefined"
67 if is_array "$varname"; then
68 #echo found $varname is array var
70 eval temparray="(\${$varname[@]})"
71 echo "$varname=(${temparray[@]})"
72 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
73 # see ones that have spaces in them.
75 #echo found $varname is simple
76 echo "$varname=${!varname}"
83 # sets the variable in parameter 1 to the value in parameter 2, but only if
84 # that variable was undefined.
85 function set_var_if_undefined()
87 local var_name="$1"; shift
88 local var_value="$1"; shift
89 if [ -z "${!var_name}" ]; then
90 eval export $var_name="$var_value"
94 function success_sound()
96 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
97 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
101 function error_sound()
103 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
104 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
108 # checks the result of the last command that was run, and if that failed,
109 # then this complains and exits from bash. the function parameters are
110 # used as the message to print as a complaint.
111 function check_result()
113 if [ $? -ne 0 ]; then
114 echo -e "failed on: $*"
120 # locates a process given a search pattern to match in the process list.
121 # supports a single command line flag style parameter of "-u USERNAME";
122 # if the -u flag is found, a username is expected afterwards, and only the
123 # processes of that user are considered.
125 local -a patterns=("${@}")
127 #echo patterns list is: "${patterns[@]}"
131 if [ "${patterns[0]}" == "-u" ]; then
132 user_flag="-u ${patterns[1]}"
133 #echo "found a -u parm and user=${patterns[1]}"
134 # void the two elements with that user flag so we don't use them as patterns.
135 unset patterns[0] patterns[1]=
141 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
144 if [ "$OS" == "Windows_NT" ]; then
145 # gets cygwin's (god awful) ps to show windoze processes also.
146 local EXTRA_DOZER_FLAGS="-W"
147 # pattern to use for peeling off the process numbers.
148 local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
151 # flags which clean up the process listing output on unixes.
152 # apparently cygwin doesn't count as a type of unix, because their
153 # crummy specialized ps command doesn't support normal ps flags.
154 local EXTRA_UNIX_FLAGS="-o pid,args"
155 # pattern to use for peeling off the process numbers.
156 local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
159 /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
161 #echo got all this stuff in the pid dump file:
165 # search for the pattern the user wants to find, and just pluck the process
166 # ids out of the results.
168 for i in "${patterns[@]}"; do
169 PIDS_SOUGHT+=($(cat $PID_DUMP \
171 | sed -n -e "$pid_finder_pattern"))
174 #echo pids sought list became:
175 #echo "${PIDS_SOUGHT[@]}"
178 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
179 local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
181 PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
182 echo ${PIDS_SOUGHT[*]}
187 # finds all processes matching the pattern specified and shows their full
188 # process listing (whereas psfind just lists process ids).
191 echo "psa finds processes by pattern, but there was no pattern on the command line."
194 local -a patterns=("${@}")
195 p=$(psfind "${patterns[@]}")
201 if [ "${patterns[0]}" == "-u" ]; then
202 # void the two elements with that user flag so we don't use them as patterns.
203 unset patterns[0] patterns[1]=
207 echo "Processes matching ${patterns[@]}..."
209 if [ -n "$IS_DARWIN" ]; then
212 # only print the header the first time.
213 if [ -z "$fuzil_sentinel" ]; then
216 ps $i -w -u | sed -e '1d'
221 # cases besides mac os x's darwin.
222 if [ "$OS" == "Windows_NT" ]; then
223 # special case for windows.
226 ps -W -p $curr | tail -n +2
229 # normal OSes can handle a nice simple query.
235 # an unfortunately similarly named function to the above 'ps' as in process
236 # methods, but this 'ps' stands for postscript. this takes a postscript file
237 # and converts it into pcl3 printer language and then ships it to the printer.
238 # this mostly makes sense for an environment where one's default printer is
239 # pcl. if the input postscript causes ghostscript to bomb out, there has been
240 # some good success running ps2ps on the input file and using the cleaned
241 # postscript file for printing.
242 function ps2pcl2lpr() {
244 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
248 # function fix_alsa() {
249 # sudo /etc/init.d/alsasound restart
254 #hmmm: ugly absolute path here.
256 restore_terminal_title
259 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
260 function unix_to_dos_path() {
261 # we usually remove dos slashes in favor of forward slashes.
263 if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
264 # fake this value for non-windows (non-cygwin) platforms.
267 # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
268 # insists on the /home form instead of /c/cygwin/home being possible. this is
269 # super frustrating and nightmarish.
270 DOSSYHOME="$(cygpath -am "$HOME")"
273 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
274 # unless this flag is set, in which case we force dos slashes.
275 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'
277 echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
281 # switches from an X:/ form to a /cygdrive/X/path form. this is only useful
282 # for the cygwin environment currently.
283 function dos_to_unix_path() {
284 # we always remove dos slashes in favor of forward slashes.
285 #old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
286 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
289 # returns a successful value (0) if this system is debian or ubuntu.
290 function debian_like() {
291 # decide if we think this is debian or ubuntu or a variant.
292 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
293 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
294 if [ $DEBIAN_LIKE -eq 1 ]; then
295 # success; this is debianish.
298 # this seems like some other OS.
303 # su function: makes su perform a login.
304 # for some OSes, this transfers the X authority information to the new login.
307 # debian currently requires the full version which imports X authority
308 # information for su.
310 # get the x authority info for our current user.
311 source "$FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh"
313 if [ -z "$X_auth_info" ]; then
314 # if there's no authentication info to pass along, we just do a normal su.
317 # under X, we update the new login's authority info with the previous
319 (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
322 # non-debian supposedly doesn't need the extra overhead any more.
323 # or at least suse doesn't, which is the other one we've tested on.
328 # sudo function wraps the normal sudo by ensuring we replace the terminal
329 # label if they're doing an su with the sudo.
331 # local first_command="$1"
334 restore_terminal_title
335 # if [ "$first_command" == "su" ]; then
336 # # yep, they were doing an su, but they're back now.
337 # label_terminal_with_info
341 # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
342 # this kind of assumes you've already checked them for any salient facts.
343 function clean_cvs_junk() {
345 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
349 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
351 local wheres_nechung=$(which nechung 2>/dev/null)
352 if [ -z "$wheres_nechung" ]; then
353 echo "The nechung oracle program cannot be found. You may want to consider"
354 echo "rebuilding the feisty meow applications with this command:"
355 echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
361 # recreates all the generated files that the feisty meow scripts use.
362 function regenerate() {
363 # do the bootstrapping process again.
365 echo "regenerating feisty meow script environment."
366 bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
368 # force a full reload by turning off sentinel variables and methods.
369 unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
370 unalias CORE_ALIASES_LOADED &>/dev/null
371 unset -f function_sentinel
372 # reload feisty meow environment in current shell.
373 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
374 # run nechung oracle to give user a new fortune.
376 restore_terminal_title
379 # copies a set of custom scripts into the proper location for feisty meow
380 # to merge their functions and aliases with the standard set.
381 function recustomize()
383 local custom_user="$1"; shift
384 if [ -z "$custom_user" ]; then
385 # use our default example user if there was no name provided.
391 if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
392 echo "The customization folder provided for $custom_user should be:"
393 echo " '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'"
394 echo "but that folder does not exist. Skipping customization."
397 regenerate >/dev/null
398 pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
399 incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
401 #echo "the incongruous files list is: $incongruous_files"
402 # disallow a single character result, since we get "*" as result when nothing exists yet.
403 if [ ${#incongruous_files} -ge 2 ]; then
404 echo "cleaning unknown older overrides..."
405 perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
409 echo "copying custom overrides for $custom_user"
410 mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
411 perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
412 if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
413 echo "copying custom scripts for $custom_user"
414 \cp -R "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
419 restore_terminal_title
422 # generates a random password where the first parameter is the number of characters
423 # in the password (default 20) and the second parameter specifies whether to use
424 # special characters (1) or not (0).
425 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
426 function random_password()
428 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
429 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
433 # a wrapper for the which command that finds items on the path. some OSes
434 # do not provide which, so we want to not be spewing errors when that
439 which which &>/dev/null
440 if [ $? -ne 0 ]; then
441 # there is no which command here. we produce nothing due to this.
444 echo $(which $to_find)
447 #hmmm: improve this by not adding the link
448 # if already there, or if the drive is not valid.
449 function add_cygwin_drive_mounts() {
450 for i in c d e f g h q z ; do
451 ln -s /cygdrive/$i $i
455 ############################
457 # takes a file to modify, and then it will replace any occurrences of the
458 # pattern provided as the second parameter with the text in the third
460 function replace_pattern_in_file()
462 local file="$1"; shift
463 local pattern="$1"; shift
464 local replacement="$1"; shift
465 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
466 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
467 echo "text to replace that pattern with."
470 sed -i -e "s%$pattern%$replacement%g" "$file"
473 # similar to replace_pattern_in_file, but also will add the new value
474 # when the old one did not already exist in the file.
475 function replace_if_exists_or_add()
477 local file="$1"; shift
478 local phrase="$1"; shift
479 local replacement="$1"; shift
480 if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
481 echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
482 echo "text to replace that phrase with."
485 grep "$phrase" "$file" >/dev/null
486 # replace if the phrase is there, otherwise add it.
487 if [ $? -eq 0 ]; then
488 replace_pattern_in_file "$file" "$phrase" "$replacement"
490 # this had better be the complete line.
491 echo "$replacement" >>"$file"
495 ############################
497 # finds a variable (first parameter) in a particular property file
498 # (second parameter). the expected format for the file is:
500 function seek_variable()
502 local find_var="$1"; shift
503 local file="$1"; shift
504 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
505 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
510 if [ ${#line} -eq 0 ]; then continue; fi
511 # split the line into the variable name and value.
512 IFS='=' read -a assignment <<< "$line"
513 local var="${assignment[0]}"
514 local value="${assignment[1]}"
515 if [ "${value:0:1}" == '"' ]; then
516 # assume the entry was in quotes and remove them.
517 value="${value:1:$((${#value} - 2))}"
519 if [ "$find_var" == "$var" ]; then
525 # finds a variable (first parameter) in a particular XML format file
526 # (second parameter). the expected format for the file is:
527 # ... name="varX" value="valueX" ...
528 function seek_variable_in_xml()
530 local find_var="$1"; shift
531 local file="$1"; shift
532 if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
533 echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
534 echo "secondly an XML file where the variable's value will be sought."
539 if [ ${#line} -eq 0 ]; then continue; fi
540 # process the line to make it more conventional looking.
541 line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
542 # split the line into the variable name and value.
543 IFS='=' read -a assignment <<< "$line"
544 local var="${assignment[0]}"
545 local value="${assignment[1]}"
546 if [ "${value:0:1}" == '"' ]; then
547 # assume the entry was in quotes and remove them.
548 value="${value:1:$((${#value} - 2))}"
550 if [ "$find_var" == "$var" ]; then
556 ############################
558 # goes to a particular directory passed as parameter 1, and then removes all
559 # the parameters after that from that directory.
560 function push_whack_pop()
562 local dir="$1"; shift
563 pushd "$dir" &>/dev/null
564 if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
565 rm -rf $* &>/dev/null
566 if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
572 while [ $# -gt 0 ]; do
574 if [ ! -f "$arg" -a ! -d "$arg" ]; then
575 echo "failure to find a file or directory named '$arg'."
579 # first we will capture the output of the character replacement operation for reporting.
580 # this is done first since some filenames can't be properly renamed in perl (e.g. if they
581 # have pipe characters apparently).
582 intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
583 local saw_intermediate_result=0
584 if [ -z "$intermediate_name" ]; then
585 # make sure we report something, if there are no further name changes.
586 intermediate_name="'$arg'"
588 # now zap the first part of the name off (since original name isn't needed).
589 intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
590 saw_intermediate_result=1
593 # first we rename the file to be lower case.
594 actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
595 final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
596 local saw_final_result=0
597 if [ -z "$final_name" ]; then
598 final_name="$intermediate_name"
600 final_name="$(echo $final_name | sed -e 's/.*=> //')"
603 #echo intermed=$saw_intermediate_result
604 #echo final=$saw_final_result
606 if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
607 # printout the combined operation results.
608 echo "'$arg' => $final_name"
615 # new breed of definer functions goes here. still in progress.
617 # defines an alias and remembers that this is a new or modified definition.
618 # if the feisty meow codebase is unloaded, then so are all the aliases that
620 function define_yeti_alias()
622 # if alias exists already, save old value for restore,
623 # otherwise save null value for restore,
624 # have to handle unaliasing if there was no prior value of one
626 # add alias name to a list of feisty defined aliases.
628 #hmmm: first implem, just do the alias and get that working...
635 # defines a variable within the feisty meow environment and remembers that
636 # this is a new or modified definition. if the feisty meow codebase is
637 # unloaded, then so are all the variables that were defined.
638 # this function always exports the variables it defines.
639 # function define_yeti_variable()
641 ## if variable exists already, save old value for restore,
642 ## otherwise save null value for restore,
643 ## have to handle unsetting if there was no prior value of one
645 ## add variable name to a list of feisty defined variables.
647 ##hmmm: first implem just sets it up and exports the variable.
648 ## i.e., this method always exports.
657 #hmmm: this points to an extended functions file being needed; not all of these are core.
659 # displays documentation in "md" formatted files.
662 local file="$1"; shift
663 pandoc "$file" | lynx -stdin
668 # just shows a separator line for an 80 column console, or uses the first
669 # parameter as the number of columns to expect.
673 if [ -z "$count" ]; then
678 for ((i=0; i < $count - 1; i++)); do
684 # alias for separator.
692 function function_sentinel()
697 if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
701 # test code for set_var_if_undefined.
703 if [ $run_test != 0 ]; then
704 echo running tests on set_var_if_undefined.
706 set_var_if_undefined flagrant forknordle
707 check_result "testing if defined variable would be whacked"
708 if [ $flagrant != petunia ]; then
709 echo set_var_if_undefined failed to leave the test variable alone
712 unset bobblehead_stomper
713 set_var_if_undefined bobblehead_stomper endurance
714 if [ $bobblehead_stomper != endurance ]; then
715 echo set_var_if_undefined failed to set a variable that was not defined yet