X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=scripts%2Fcore%2Ffunctions.sh;h=629bd59bec4a33088421470236591cfa1dcafa97;hb=22bbd7c6d7bbb09a5ba955d30ceebf93693d23fb;hp=535f5ecdaa1c2df8c79aa61ff637f6d5e865bd83;hpb=b33ab63436278c7de3c1dd6e0371d9e28788cfb8;p=feisty_meow.git diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh index 535f5ecd..629bd59b 100644 --- a/scripts/core/functions.sh +++ b/scripts/core/functions.sh @@ -4,13 +4,15 @@ # test whether we've been here before or not. skip_all= -function_sentinel &>/dev/null +type 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 function definitions, because already defined." fi skip_all=yes +else + skip_all= fi if [ -z "$skip_all" ]; then @@ -74,10 +76,21 @@ if [ -z "$skip_all" ]; then echo "$varname=${!varname}" fi fi - done + done | sort IFS="$HOLDIFS" } + # sets the variable in parameter 1 to the value in parameter 2, but only if + # that variable was undefined. + function set_var_if_undefined() + { + local var_name="$1"; shift + local var_value="$1"; shift + if [ -z "${!var_name}" ]; then + eval export $var_name="$var_value" + fi + } + function success_sound() { if [ ! -z "$CLAM_FINISH_SOUND" ]; then @@ -127,64 +140,40 @@ if [ -z "$skip_all" ]; then local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")" local -a PIDS_SOUGHT - if [ "$OS" == "Windows_NT" ]; then -#hmmm: windows isn't implementing the user flag yet! -#try collapsing back to the ps implementation from cygwin? -# that would simplify things a lot, if we can get it to print the right output. + if [ "$OS" == "Windows_NT" ]; then + # gets cygwin's (god awful) ps to show windoze processes also. + local EXTRA_DOZER_FLAGS="-W" + # pattern to use for peeling off the process numbers. + local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p' - # windows case has some odd gyrations to get the user list. - 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. - 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. - wmic /locale:ms_409 PROCESS get processid,commandline "$tmppid" - local flag='/c' - if [ ! -z "$(uname -a | grep "^MING" )" ]; then - flag='//c' - fi - # we 'type' the file to get rid of the unicode result from wmic. - # needs to be a windows format filename for 'type' to work. - cmd $flag type "$tmppid" >$PID_DUMP - \rm "$tmppid" - local pid_finder_pattern='s/^.*[[:space:]][[:space:]]*\([0-9][0-9]*\) *\$/\1/p' - local i - for i in "${patterns[@]}"; do - PIDS_SOUGHT+=($(cat $PID_DUMP \ - | grep -i "$i" \ - | sed -n -e "$pid_finder_pattern")) - done else - /bin/ps $user_flag -o pid,args >$PID_DUMP + # flags which clean up the output on unixes, which apparently cygwin + # doesn't count as. their crappy specialized ps doesn't support this. + local EXTRA_UNIX_FLAGS="-o pid,args" + # pattern to use for peeling off the process numbers. + local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p' + fi + + /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP #echo ==== #echo got all this stuff in the pid dump file: #cat $PID_DUMP #echo ==== - # pattern to use for peeling off the process numbers. - local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p' - # remove the first line of the file, search for the pattern the - # user wants to find, and just pluck the process ids out of the - # results. - local i - for i in "${patterns[@]}"; do -#echo pattern is $i -#echo phase 1: $(cat $PID_DUMP | sed -e '1d' ) -#echo phase 2: $(cat $PID_DUMP | sed -e '1d' | grep -i "$i" ) - PIDS_SOUGHT+=($(cat $PID_DUMP \ - | sed -e '1d' \ - | grep -i "$i" \ - | sed -n -e "$pid_finder_pattern")) - done + + # search for the pattern the user wants to find, and just pluck the process + # ids out of the results. + local i + for i in "${patterns[@]}"; do + PIDS_SOUGHT+=($(cat $PID_DUMP \ + | grep -i "$i" \ + | sed -n -e "$pid_finder_pattern")) + done #echo ==== #echo pids sought list became: #echo "${PIDS_SOUGHT[@]}" #echo ==== - fi + if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq) PIDS_SOUGHT=() @@ -233,7 +222,7 @@ if [ -z "$skip_all" ]; then # special case for windows. ps | head -1 for curr in $p; do - ps -W | grep "$curr" + ps -W -p $curr | tail -n +2 done else # normal OSes can handle a nice simple query. @@ -281,10 +270,12 @@ if [ -z "$skip_all" ]; then fi } - # switches from an X:/ form to an /X/path form. + # switches from an X:/ form to a /cygdrive/X/path form. this is only useful + # for the cygwin environment currently. 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/' +#old: echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/' + echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/' } # returns a successful value (0) if this system is debian or ubuntu. @@ -354,7 +345,7 @@ if [ -z "$skip_all" ]; then 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_SCRIPTS/generator/bootstrap_build.sh" + echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh" else $wheres_nechung fi @@ -364,14 +355,11 @@ if [ -z "$skip_all" ]; then function regenerate() { # do the bootstrapping process again. echo "regenerating feisty meow script environment." - bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh + bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.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 + # force a full reload by turning off sentinel variables and methods. + unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED + unalias CORE_ALIASES_LOADED unset -f function_sentinel # reload feisty meow environment in current shell. source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh @@ -379,31 +367,6 @@ if [ -z "$skip_all" ]; then 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() @@ -413,39 +376,70 @@ if [ -z "$skip_all" ]; then # use our default example user if there was no name provided. user=fred fi - if [ ! -d "$FEISTY_MEOW_DIR/customizing/$user" ]; then + if [ ! -d "$FEISTY_MEOW_APEX/customizing/$user" ]; then echo "The customization folder provided for $user should be:" - echo " '$FEISTY_MEOW_DIR/customizing/$user'" + echo " '$FEISTY_MEOW_APEX/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 + pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null + incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")" + + #echo "the incongruous files list is: $incongruous_files" + # disallow a single character result, since we get "*" as result when nothing exists yet. + if [ ${#incongruous_files} -ge 2 ]; 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 + mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null + perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom" + if [ -d "$FEISTY_MEOW_APEX/customizing/$user/scripts" ]; then echo "copying custom scripts for $user" - \cp -R "$FEISTY_MEOW_DIR/customizing/$user/scripts" "$FEISTY_MEOW_GENERATED/custom/" + \cp -R "$FEISTY_MEOW_APEX/customizing/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" fi echo regenerate } -#uhhh, this does what now? + # 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) + } + +#hmmm: improve this by not adding the link +# if already there, or if the drive is not valid. 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. @@ -462,6 +456,101 @@ if [ -z "$skip_all" ]; then sed -i -e "s%$pattern%$replacement%g" "$file" } + # similar to replace_pattern_in_file, but also will add the new value + # when the old one did not already exist in the file. + function replace_if_exists_or_add() + { + local file="$1"; shift + local phrase="$1"; shift + local replacement="$1"; shift + if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then + echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the" + echo "text to replace that phrase with." + return 1 + fi + grep "$phrase" "$file" >/dev/null + # replace if the phrase is there, otherwise add it. + if [ $? -eq 0 ]; then + replace_pattern_in_file "$file" "$phrase" "$replacement" + else + # this had better be the complete line. + echo "$replacement" >>"$file" + fi + } + + ############################ + + # finds a variable (first parameter) in a particular property file + # (second parameter). the expected format for the file is: + # varX=valueX + function seek_variable() + { + local find_var="$1"; shift + local file="$1"; shift + if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then + 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 + return 1 + fi + + while read line; do + if [ ${#line} -eq 0 ]; then continue; fi + # split the line into the variable name and value. + IFS='=' read -a assignment <<< "$line" + local var="${assignment[0]}" + local value="${assignment[1]}" + if [ "${value:0:1}" == '"' ]; then + # assume the entry was in quotes and remove them. + value="${value:1:$((${#value} - 2))}" + fi + if [ "$find_var" == "$var" ]; then + echo "$value" + fi + done < "$file" + } + + # finds a variable (first parameter) in a particular XML format file + # (second parameter). the expected format for the file is: + # ... name="varX" value="valueX" ... + function seek_variable_in_xml() + { + local find_var="$1"; shift + local file="$1"; shift + if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then + echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and" + echo "secondly an XML file where the variable's value will be sought." + return 1 + fi + + while read line; do + if [ ${#line} -eq 0 ]; then continue; fi + # process the line to make it more conventional looking. + line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')" + # split the line into the variable name and value. + IFS='=' read -a assignment <<< "$line" + local var="${assignment[0]}" + local value="${assignment[1]}" + if [ "${value:0:1}" == '"' ]; then + # assume the entry was in quotes and remove them. + value="${value:1:$((${#value} - 2))}" + fi + if [ "$find_var" == "$var" ]; then + echo "$value" + fi + done < "$file" + } + + ############################ + + # goes to a particular directory passed as parameter 1, and then removes all + # the parameters after that from that directory. + function push_whack_pop() + { + local dir="$1"; shift + pushd "$dir" &>/dev/null + rm -rf $* &>/dev/null + popd &>/dev/null + } + function spacem() { while [ $# -gt 0 ]; do @@ -470,19 +559,38 @@ if [ -z "$skip_all" ]; then echo "failure to find a file or directory named '$arg'." continue fi + + # first we will capture the output of the character replacement operation for reporting. + # this is done first since some filenames can't be properly renamed in perl (e.g. if they + # have pipe characters apparently). + intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")" + local saw_intermediate_result=0 + if [ -z "$intermediate_name" ]; then + # make sure we report something, if there are no further name changes. + intermediate_name="'$arg'" + else + # now zap the first part of the name off (since original name isn't needed). + intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')" + saw_intermediate_result=1 + fi + # 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" + actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")" + final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")" + local saw_final_result=0 + if [ -z "$final_name" ]; then + final_name="$intermediate_name" + else + final_name="$(echo $final_name | sed -e 's/.*=> //')" + saw_final_result=1 + fi +#echo intermed=$saw_intermediate_result +#echo final=$saw_final_result + + if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then + # printout the combined operation results. + echo "'$arg' => $final_name" + fi done } @@ -512,27 +620,75 @@ return 0 # this is a new or modified definition. if the feisty meow codebase is # unloaded, then so are all the variables that were defined. # this function always exports the variables it defines. - function define_yeti_variable() - { -# if variable exists already, save old value for restore, -# otherwise save null value for restore, -# have to handle unsetting if there was no prior value of one -# we newly defined. -# add variable name to a list of feisty defined variables. - -#hmmm: first implem just sets it up and exports the variable. -# i.e., this method always exports. -export "${@}" +# function define_yeti_variable() +# { +## if variable exists already, save old value for restore, +## otherwise save null value for restore, +## have to handle unsetting if there was no prior value of one +## we newly defined. +## add variable name to a list of feisty defined variables. +# +##hmmm: first implem just sets it up and exports the variable. +## i.e., this method always exports. +#export "${@}" +# +# +#return 0 +# } + ############## -return 0 + # just shows a separator line for an 80 column console, or uses the first + # parameter as the number of columns to expect. + function separator() + { + count=$1; shift + if [ -z "$count" ]; then + count=79 + fi + echo + local i + for ((i=0; i < $count - 1; i++)); do + echo -n "=" + done + echo + echo + } + # alias for separator. + function sep() + { + separator $* } ############## - function function_sentinel() { return 0; } + function function_sentinel() + { + return 0; + } if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi - + + ############## + + # test code for set_var_if_undefined. + run_test=0 + if [ $run_test != 0 ]; then + echo running tests on set_var_if_undefined. + flagrant=petunia + set_var_if_undefined flagrant forknordle + check_result "testing if defined variable would be whacked" + if [ $flagrant != petunia ]; then + echo set_var_if_undefined failed to leave the test variable alone + exit 1 + fi + unset bobblehead_stomper + set_var_if_undefined bobblehead_stomper endurance + if [ $bobblehead_stomper != endurance ]; then + echo set_var_if_undefined failed to set a variable that was not defined yet + exit 1 + fi + fi + fi