X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=scripts%2Fcore%2Ffunctions.sh;h=b068210cf244bca75b009120971e5a5a3db88478;hb=ae041eb1a51283e17d605e08784bad2b3f29fd99;hp=6b741d616aaf32244312140bc6cae03f24fb4842;hpb=a9aabcf6a7dfbc01e0564f62386e7a989c52588a;p=feisty_meow.git diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh index 6b741d61..b068210c 100644 --- a/scripts/core/functions.sh +++ b/scripts/core/functions.sh @@ -8,16 +8,17 @@ function_sentinel &>/dev/null if [ $? -eq 0 ]; then # there was no error, so we can skip the inits. if [ ! -z "$SHELL_DEBUG" ]; then - echo skipping functions.sh because already defined. + echo "skipping function definitions, because already defined." fi skip_all=yes fi if [ -z "$skip_all" ]; then + if [ ! -z "$SHELL_DEBUG" ]; then - echo function definitions begin... + echo "feisty meow function definitions beginning now..." fi - + # a handy little method that can be used for date strings. it was getting # really tiresome how many different ways the script did the date formatting. function date_stringer() { @@ -32,25 +33,64 @@ if [ -z "$skip_all" ]; then if [ ! -d "$1" ]; then mkdir -p "$1"; fi cd "$1" } - + + # displays the value of a variable in bash friendly format. + function var() { + while true; do + local varname="$1"; shift + if [ -z "$varname" ]; then + break + fi + if [ -z "${!varname}" ]; then + echo "$varname undefined" + else + echo "$varname=${!varname}" + fi + done + } + + function success_sound() + { + if [ ! -z "$CLAM_FINISH_SOUND" ]; then + bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND" + fi + } + + function error_sound() + { + if [ ! -z "$CLAM_ERROR_SOUND" ]; then + bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND" + fi + } + + # checks the result of the last command that was run, and if that failed, + # then this complains and exits from bash. the function parameters are + # used as the message to print as a complaint. + function check_result() + { + if [ $? -ne 0 ]; then + echo -e "failed on: $*" + error_sound + exit 1 + fi + } + # locates a process given a search pattern to match in the process list. function psfind() { + local -a patterns=("${@}") local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")" - local PIDS_SOUGHT=() - local patterns=($*) + local -a PIDS_SOUGHT if [ "$OS" == "Windows_NT" ]; then # needs to be a windows format filename for 'type' to work. if [ ! -d c:/tmp ]; then mkdir c:/tmp fi - # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not really there - # in the root of drive c: when we look for it later. hoping to fix that problem by using a subdir, which - # also might be magical thinking from windows perspective. + # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not + # really there in the root of drive c: when we look for it later. hoping to fix that + # problem by using a subdir, which also might be magical thinking from windows perspective. tmppid=c:\\tmp\\pids.txt - # we have abandoned all hope of relying on ps on windows. instead - # we use wmic to get full command lines for processes. - # this does not exist on windows home edition. we are hosed if that's - # what they insist on testing on. + # we have abandoned all hope of relying on ps on windows. instead we use wmic to get full + # command lines for processes. wmic /locale:ms_409 PROCESS get processid,commandline "$tmppid" local flag='/c' if [ ! -z "$(uname -a | grep "^MING" )" ]; then @@ -59,18 +99,11 @@ if [ -z "$skip_all" ]; then # we 'type' the file to get rid of the unicode result from wmic. cmd $flag type "$tmppid" >$PID_DUMP \rm "$tmppid" - local CR=' ' # embedded carriage return. - local appropriate_pattern="s/^.* *\([0-9][0-9]*\)[ $CR]*\$/\1/p" + local appropriate_pattern="s/^.* *\([0-9][0-9]*\) *\$/\1/p" for i in "${patterns[@]}"; do - PIDS_SOUGHT+=$(cat $PID_DUMP \ + PIDS_SOUGHT+=($(cat $PID_DUMP \ | grep -i "$i" \ - | sed -n -e "$appropriate_pattern") - if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then - # we want to bail as soon as we get matches, because on the same - # platform, the same set of patterns should work to find all - # occurrences of the genesis java. - break; - fi + | sed -n -e "$appropriate_pattern")) done else /bin/ps $extra_flags wuax >$PID_DUMP @@ -80,19 +113,18 @@ if [ -z "$skip_all" ]; then # user wants to find, and just pluck the process ids out of the # results. for i in "${patterns[@]}"; do - PIDS_SOUGHT=$(cat $PID_DUMP \ + PIDS_SOUGHT+=($(cat $PID_DUMP \ | sed -e '1d' \ | grep -i "$i" \ - | sed -n -e "$appropriate_pattern") - if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then - # we want to bail as soon as we get matches, because on the same - # platform, the same set of patterns should work to find all - # occurrences of the genesis java. - break; - fi + | sed -n -e "$appropriate_pattern")) done fi - if [ ! -z "$PIDS_SOUGHT" ]; then echo "$PIDS_SOUGHT"; fi + if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then + local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq) + PIDS_SOUGHT=() + PIDS_SOUGHT=${PIDS_SOUGHT2[*]} + echo ${PIDS_SOUGHT[*]} + fi /bin/rm $PID_DUMP } @@ -103,9 +135,13 @@ if [ -z "$skip_all" ]; then echo "psa finds processes by pattern, but there was no pattern on the command line." return 1 fi - p=$(psfind "$1") + p=$(psfind "${@}") + if [ -z "$p" ]; then + # no matches. + return 0 + fi echo "" - echo "Processes containing \"$1\"..." + echo "Processes matching ${@}..." echo "" if [ -n "$IS_DARWIN" ]; then unset fuzil_sentinel @@ -152,26 +188,41 @@ if [ -z "$skip_all" ]; then sudo /etc/init.d/alsasound restart } - # switches from a /X/path form to an X:/ form. - function msys_to_dos_path() { - # we always remove dos slashes in favor of forward slashes. - echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' + # switches from a /X/path form to an X:/ form. this also processes cygwin paths. + function unix_to_dos_path() { + # we usually remove dos slashes in favor of forward slashes. + if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then + # unless this flag is set, in which case we force dos slashes. + echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g' + else + echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' + fi } # switches from an X:/ form to an /X/path form. - function dos_to_msys_path() { + function dos_to_unix_path() { # we always remove dos slashes in favor of forward slashes. echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/' } - - # su function: makes su perform a login. - # for some OSes, this transfers the X authority information to the new login. - function su() { + + # returns a successful value (0) if this system is debian or ubuntu. + function debian_like() { # decide if we think this is debian or ubuntu or a variant. DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \ -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi) - if [ $DEBIAN_LIKE -eq 1 ]; then + # success; this is debianish. + return 0 + else + # this seems like some other OS. + return 1 + fi + } + + # su function: makes su perform a login. + # for some OSes, this transfers the X authority information to the new login. + function su() { + if debian_like; then # debian currently requires the full version which imports X authority # information for su. @@ -200,33 +251,13 @@ if [ -z "$skip_all" ]; then # label if they're doing an su with the sudo. function sudo() { local first_command="$1" - /usr/bin/sudo $* + /usr/bin/sudo "$@" if [ "$first_command" == "su" ]; then # yep, they were doing an su, but they're back now. bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh fi } - # buntar is a long needed uncompressing macro that feeds into tar -x. - # it takes a list of bz2 file names and extracts their contents into - # sequentially numbered directories. - function buntar() { - index=1 - for i in $*; do - mkdir buntar_$index - pushd buntar_$index &>/dev/null - file=$i - # if the filename has no directory component, we will assume it used to - # be above our unzipping directory here. - if [ "$(basename $file)" = $file ]; then - file=../$file - fi - bunzip2 -d -c $file | tar -xf - - popd &>/dev/null - index=$(expr $index + 1) - done - } - # trashes the .#blah files that cvs and svn leave behind when finding conflicts. # this kind of assumes you've already checked them for any salient facts. function clean_cvs_junk() { @@ -234,24 +265,164 @@ if [ -z "$skip_all" ]; then find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";" done } - - # recreates all the generated files that the feisty meow scripts use. - function regenerate() { - bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh - echo + + # overlay for nechung binary so that we can complain less grossly about it when it's missing. + function nechung() { local wheres_nechung=$(which nechung 2>/dev/null) if [ -z "$wheres_nechung" ]; then echo "The nechung oracle program cannot be found. You may want to consider" echo "rebuilding the feisty meow applications with this command:" - echo " bash $FEISTY_MEOW_DIR/scripts/generator/bootstrap_build.sh" + echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh" else - nechung + $wheres_nechung + fi + } + + # recreates all the generated files that the feisty meow scripts use. + function regenerate() { + # do the bootstrapping process again. + echo "regenerating feisty meow script environment." + bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh + echo + # force a full reload by turning off sentinel variable and alias. + # the nethack one is used by fred's customizations. + # interesting note perhaps: found that the NETHACKOPTIONS variable was + # not being unset correctly when preceded by an alias. split them up + # like they are now due to that bug. + unset -v CORE_ALIASES_LOADED FEISTY_MEOW_GENERATED NECHUNG NETHACKOPTIONS + unset -f function_sentinel + # reload feisty meow environment in current shell. + source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh + # run nechung oracle to give user a new fortune. + nechung + } + + # generates a random password where the first parameter is the number of characters + # in the password (default 20) and the second parameter specifies whether to use + # special characters (1) or not (0). + # found function at http://legroom.net/2010/05/06/bash-random-password-generator + function random_password() + { + [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]" + cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32} + echo + } + + # a wrapper for the which command that finds items on the path. some OSes + # do not provide which, so we want to not be spewing errors when that + # happens. + function whichable() + { + to_find="$1"; shift + which which &>/dev/null + if [ $? -ne 0 ]; then + # there is no which command here. we produce nothing due to this. + echo fi + echo $(which $to_find) } + # copies a set of custom scripts into the proper location for feisty meow + # to merge their functions and aliases with the standard set. + function recustomize() + { + user="$1"; shift + if [ -z "$user" ]; then + # use our default example user if there was no name provided. + user=fred + fi + if [ ! -d "$FEISTY_MEOW_DIR/customizing/$user" ]; then + echo "The customization folder provided for $user should be:" + echo " '$FEISTY_MEOW_DIR/customizing/$user'" + echo "but that folder does not exist. Skipping customization." + return 1 + fi + regenerate >/dev/null + pushd "$FEISTY_MEOW_GENERATED/custom" &>/dev/null + local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom")" + if [ ${#incongruous_files} -ge 1 ]; then + echo "cleaning unknown older overrides..." + perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files + echo + fi + popd &>/dev/null + echo "copying custom overrides for $user" + mkdir "$FEISTY_MEOW_GENERATED/custom" 2>/dev/null + perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom" + if [ -d "$FEISTY_MEOW_DIR/customizing/$user/scripts" ]; then + echo "copying custom scripts for $user" + \cp -R "$FEISTY_MEOW_DIR/customizing/$user/scripts" "$FEISTY_MEOW_GENERATED/custom/" + fi + echo + regenerate + } + +#uhhh, this does what now? + function add_cygwin_drive_mounts() { + for i in c d e f g h q z ; do + ln -s /cygdrive/$i $i + done + } + + # takes a file to modify, and then it will replace any occurrences of the + # pattern provided as the second parameter with the text in the third + # parameter. + function replace_pattern_in_file() + { + local file="$1"; shift + local pattern="$1"; shift + local replacement="$1"; shift + if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then + echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the" + echo "text to replace that pattern with." + return 1 + fi + sed -i -e "s%$pattern%$replacement%g" "$file" + } + + function spacem() + { +#hmmm: could really use that pattern of 'iterate across all the arguments and do same thing' here. + +#hmmm: it actually seems like the below IS the pattern. it's pretty short, but i wish it could be shorter, like a function in itself.... ah. +# couldn't we have a functionator deal that takes: +# 1) a command to run, and +# 2-n) arguments, +# where the function just blithely runs that command on all of those arguments!? +# yes! that does seem like the pattern being sought, much nicer than the goofy loop below, +# although this functionator deal needs to handle when there are more than one command also, +# or this very function couldn't be implemented... +# maybe a two step process: +# 1) build a list of commands to run on all arguments, +# 2) then run through all the arguments passed in using those established commands. +# yes again! this seems like it would meet all the needs involved and not be too irksome. +# for the example below, this would reduce the number of lines, i think. +# i had better stop bloviating and write this function so i can determine the number of +# lines omitted by the new approach. + while [ $# -gt 0 ]; do + arg="$1"; shift + # first we rename the file to be lower case. + perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$arg" &>/dev/null + # oops, now the name is all lower-case. we need to make the + # same adjustment. + arg2="$(echo "$arg" | tr A-Z a-z)" + # we definitely wanted to adjust the case first, rather than doing all + # the wacky stuff this script does to the filename... we will capture + # the output of the replace operaton for reporting. + final_name="$(perl "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg2")" + # now zap the intermediate part of the name off. + final_name="$(echo $final_name | sed -e 's/.*=> //')" + # printout the combined operation results. + echo "'$arg' => $final_name" + done +# + } + + ############## + function function_sentinel() { return 0; } - if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi + if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi fi