X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=scripts%2Fcore%2Ffunctions.sh;h=a58e818fd5000bee4172a7fcf0f955e8d76d0656;hb=1acdaf5897bfed83c3a3d7cae9c6f9e6d5480835;hp=6797708525179750e9e84c5de98e4b211c44c2de;hpb=491bfd133c33e140bfb93ac47656bf429af42e2e;p=feisty_meow.git diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh index 67977085..a58e818f 100644 --- a/scripts/core/functions.sh +++ b/scripts/core/functions.sh @@ -40,15 +40,27 @@ if [ -z "$skip_all" ]; then cd "$1" } + # returns true if the variable is an array. function is_array() { [[ "$(declare -p $1)" =~ "declare -a" ]] } + # returns true if the name provided is a defined alias. function is_alias() { alias $1 &>/dev/null return $? } + # makes the status of pipe number N (passed as first parameter) into the + # main return value (i.e., the value for $?). this is super handy to avoid + # repeating the awkward looking code below in multiple places. + function promote_pipe_return() + { + ( exit ${PIPESTATUS[$1]} ) + } + + ############## + # displays the value of a variable in bash friendly format. function var() { HOLDIFS="$IFS" @@ -84,6 +96,8 @@ if [ -z "$skip_all" ]; then IFS="$HOLDIFS" } + ############## + # when passed a list of things, this will return the unique items from that list as an echo. function uniquify() { @@ -104,6 +118,8 @@ if [ -z "$skip_all" ]; then fi } + ############## + function success_sound() { if [ ! -z "$CLAM_FINISH_SOUND" ]; then @@ -118,40 +134,81 @@ if [ -z "$skip_all" ]; then fi } + ############## + + # echoes the maximum number of columns that the terminal supports. usually + # anything you print to the terminal with length less than (but not equal to) + # maxcols will never wrap. + function get_maxcols() + { + # calculate the number of columsn in the terminal. + local cols=$(stty size | awk '{print $2}') + echo $cols + } + + ############## + # 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 test_or_die() + function exit_on_error() { if [ $? -ne 0 ]; then - echo -e "\n\naction failed: $*\n\nExiting script..." + echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..." error_sound exit 1 fi } - # like test_or_die, but will keep going after complaining. - function test_or_continue() + # like exit_on_error, but will keep going after complaining. + function continue_on_error() { if [ $? -ne 0 ]; then - echo -e "\n\nerror occurred: $*\n\nContinuing script..." + echo -e "\n\na problem occurred, but we can continue:\n\n$*\n\n=> Continuing script..." error_sound fi } + ############## + + # accepts any number of arguments and outputs them to the feisty meow event log. + function log_feisty_meow_event() + { + echo -e "$(date_stringer) -- ${USER}@$(hostname): $*" >> "$FEISTY_MEOW_EVENT_LOG" + } + + ############## + # wraps secure shell with some parameters we like, most importantly to enable X forwarding. function ssh() { local args=($*) - save_terminal_title # we remember the old terminal title, then force the TERM variable to a more generic # version for the other side (just 'linux'); we don't want the remote side still # thinking it's running xterm. - export TERM=linux + save_terminal_title + if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then + echo TERM saved is: $PRIOR_TERMINAL_TITLE + fi +#hmmm: why were we doing this? it scorches the user's logged in session, leaving it without proper terminal handling. +# # we save the value of TERM; we don't want to leave the user's terminal +# # brain dead once we come back from this function. +# local oldterm="$TERM" +# export TERM=linux /usr/bin/ssh -X -C "${args[@]}" +# # restore the terminal variable also. +# TERM="$oldterm" + if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then + echo TERM before restore, will use prior title of: $PRIOR_TERMINAL_TITLE + fi restore_terminal_title + if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then + echo TERM title restored to prior value + fi } + ############## + # locates a process given a search pattern to match in the process list. # supports a single command line flag style parameter of "-u USERNAME"; # if the -u flag is found, a username is expected afterwards, and only the @@ -267,6 +324,9 @@ if [ -z "$skip_all" ]; then fi } + ############## + +#hmmm: holy crowbars, this is an old one. do we ever still have any need of it? # an unfortunately similarly named function to the above 'ps' as in process # methods, but this 'ps' stands for postscript. this takes a postscript file # and converts it into pcl3 printer language and then ships it to the printer. @@ -280,9 +340,21 @@ if [ -z "$skip_all" ]; then done } -# function fix_alsa() { -# sudo /etc/init.d/alsasound restart -# } +#hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04? + # restarts the sound driver. + function fix_sound_driver() { + # stop bash complaining about blank function body. + local nothing= +#if alsa something +# sudo service alsasound restart +#elif pulse something +# sudo pulseaudio -k +# sudo pulseaudio -D +#else +# something else...? +#fi + + } function screen() { save_terminal_title @@ -407,6 +479,7 @@ if [ -z "$skip_all" ]; then unalias CORE_ALIASES_LOADED &>/dev/null unset -f function_sentinel # reload feisty meow environment in current shell. + log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell." source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh" # run nechung oracle to give user a new fortune. nechung @@ -419,47 +492,76 @@ if [ -z "$skip_all" ]; then { local custom_user="$1"; shift if [ -z "$custom_user" ]; then - # use our default example user if there was no name provided. - custom_user=fred + # default to login name if there was no name provided. + custom_user="$(logname)" + # we do intend to use logname here to get the login name and to ignore + # if the user has sudo root access; we don't want to provide a custom + # profile for root. fi save_terminal_title if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then - echo "The customization folder provided for $custom_user should be:" - echo " '$FEISTY_MEOW_SCRIPTS/customize/$custom_user'" - echo "but that folder does not exist. Skipping customization." + echo -e "the customization folder for '$custom_user' is missing: + + $FEISTY_MEOW_SCRIPTS/customize/$custom_user + +we will skip recustomization, but these other customizations are available: +" + # a little tr and sed magic to fix the carriage returns into commas. + local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')" + # make the line feeds and carriage returns manageable with tr. + # convert the ampersand, our weird replacement for EOL, with a comma + space in sed. + # last touch with sed removes the last comma. + echo " $line" return 1 fi + + # prevent permission foul-ups. + my_user="$USER" + # here we definitely want the effective user name (in USER), since + # we don't want, say, fred (as logname) to own all of root's loading + # dock stuff. + chown -R "$my_user:$my_user" \ + "$FEISTY_MEOW_LOADING_DOCK"/* "$FEISTY_MEOW_GENERATED_STORE"/* 2>/dev/null + continue_on_error "chowning feisty meow generated directories to $my_user" + regenerate >/dev/null pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")" - local fail_message="\nare the perl dependencies installed? if you're on ubuntu or debian, try this:\n - $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n" - + local fail_message="\n +are the perl dependencies installed? if you're on ubuntu or debian, try this:\n + $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n +or if you're on cygwin, then try this (if apt-cyg is available):\n + $(grep "apt-cyg.*perl" $FEISTY_MEOW_APEX/readme.txt)\n"; + #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..." + log_feisty_meow_event "cleaning unknown older overrides..." perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files - test_or_continue "running safedel. $fail_message" - echo + continue_on_error "running safedel. $fail_message" fi popd &>/dev/null - echo "copying custom overrides for $custom_user" + log_feisty_meow_event "copying custom overrides for $custom_user" mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom" - test_or_continue "running cpdiff. $fail_message" + continue_on_error "running cpdiff. $fail_message" if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then - echo "copying custom scripts for $custom_user" - netcp "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null + log_feisty_meow_event "copying custom scripts for $custom_user" #hmmm: could save output to show if an error occurs. + rsync -avz "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null + continue_on_error "copying customization scripts" fi - echo regenerate + # prevent permission foul-ups, again. + chown -R "$my_user:$my_user" \ + "$FEISTY_MEOW_LOADING_DOCK" "$FEISTY_MEOW_GENERATED_STORE" 2>/dev/null + continue_on_error "once more chowning feisty meow generated directories to $my_user" + restore_terminal_title } @@ -488,10 +590,9 @@ if [ -z "$skip_all" ]; then 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 +#hmmm: improve this by not adding the link if already there, or if the drive is not valid. ln -s /cygdrive/$i $i done } @@ -616,7 +717,7 @@ if [ -z "$skip_all" ]; then while [ $# -gt 0 ]; do arg="$1"; shift if [ ! -f "$arg" -a ! -d "$arg" ]; then - echo "failure to find a file or directory named '$arg'." + echo "=> did not find a file or directory named '$arg'." continue fi @@ -716,8 +817,8 @@ return 0 # count the number of sub-directories in a directory and echo the result. function count_directories() { - local appsdir="$1"; shift - numdirs="$(find "$appsdir" -mindepth 1 -maxdepth 1 -type d | wc -l)" + local subbydir="$1"; shift + numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)" echo $numdirs } @@ -739,7 +840,7 @@ return 0 if [ -d "$src" ]; then ln -s "$src" "$target" - test_or_die "Creating symlink from '$src' to '$target'" + exit_on_error "Creating symlink from '$src' to '$target'" fi echo "Created symlink from '$src' to '$target'." } @@ -756,7 +857,7 @@ return 0 temp_out="$TMP/$file.view" cat "$file" | python -m json.tool > "$temp_out" show_list+=($temp_out) - test_or_continue "pretty printing '$file'" + continue_on_error "pretty printing '$file'" done filedump "${show_list[@]}" rm "${show_list[@]}" @@ -803,6 +904,79 @@ return 0 ############## + # given a filename and a string to seek and a number of lines, then this + # function will remove the first occurrence of a line in the file that + # matches the string, and it will also axe the next N lines as specified. + function create_chomped_copy_of_file() + { + local filename="$1"; shift + local seeker="$1"; shift + local numlines=$1; shift + +#echo into create_chomped_copy... +#var filename seeker numlines + + # make a backup first, oy. + \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}" + exit_on_error "backing up file: $filename" + + # make a temp file to write to before we move file into place in bind. + local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}" + \rm -f "$new_version" + exit_on_error "cleaning out new version of file from: $new_version" + + local line + local skip_count=0 + local found_any= + while read line; do + # don't bother looking at the lines if we're already in skip mode. + if [[ $skip_count == 0 ]]; then + # find the string they're seeking. + if [[ ! "$line" =~ .*${seeker}.* ]]; then + # no match. + echo "$line" >> "$new_version" + else + # a match! start skipping. we will delete this line and the next N lines. + ((skip_count++)) +#echo first skip count is now $skip_count + found_any=yes + fi + else + # we're already skipping. let's keep going until we hit the limit. + ((skip_count++)) +#echo ongoing skip count is now $skip_count + if (( $skip_count > $numlines )); then + echo "Done skipping, and back to writing output file." + skip_count=0 + fi + fi + done < "$filename" + +#echo file we created looks like this: +#cat "$new_version" + + if [ ! -z "$found_any" ]; then + # put the file back into place under the original name. + \mv "$new_version" "$filename" + exit_on_error "moving the new version into place in: $filename" + else + # cannot always be considered an error, but we can at least gripe. + echo "Did not find any matches for seeker '$seeker' in file: $filename" + fi + } + + ############## + + # site avenger aliases + function switchto() + { + THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger" + source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh" + switch_to "$1" + } + + ############## + # NOTE: no more function definitions are allowed after this point. function function_sentinel() @@ -820,7 +994,7 @@ return 0 echo running tests on set_var_if_undefined. flagrant=petunia set_var_if_undefined flagrant forknordle - test_or_die "testing if defined variable would be whacked" + exit_on_error "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