X-Git-Url: https://feistymeow.org/gitweb/?a=blobdiff_plain;f=scripts%2Fcore%2Ffunctions.sh;h=24b162ef49d6471f60bafccada97366a745420ba;hb=5cf92aab81bd652d22783e0cf3725e1bd9722526;hp=c60c94319e4e24d126e700465c66e9ece8edcecd;hpb=00e8a2f35de87987880cd5b46a1c7e4bee8c68dd;p=feisty_meow.git diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh index c60c9431..24b162ef 100644 --- a/scripts/core/functions.sh +++ b/scripts/core/functions.sh @@ -40,15 +40,42 @@ 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]} ) + } + + ############## + + function fm_username() + { + # see if we can get the user name from the login name. oddly this sometimes doesn't work. + local custom_user="$(logname 2>/dev/null)" + if [ -z "$custom_user" ]; then + # try the normal unix user variable. + custom_user="$USER" + fi + if [ -z "$custom_user" ]; then + # try the windows user variable. + custom_user="$USERNAME" + fi + echo "$custom_user" + } + ############## # displays the value of a variable in bash friendly format. @@ -141,43 +168,58 @@ if [ -z "$skip_all" ]; then # 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=($*) + local args=($@) # 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. save_terminal_title + #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" + restore_terminal_title + if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then + echo TERM title restored to prior value + fi } ############## @@ -358,13 +400,13 @@ if [ -z "$skip_all" ]; then fi } - # 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. -#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/' - } +# # 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. +##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. function debian_like() { @@ -405,17 +447,38 @@ if [ -z "$skip_all" ]; then fi } - # sudo function wraps the normal sudo by ensuring we replace the terminal - # label if they're doing an su with the sudo. + # this function wraps the normal sudo by ensuring we replace the terminal + # label before we launch what they're passing to sudo. we also ensure that + # the feisty meow environment is recreated; normal subshells don't need + # this, but when switching identity with sudo, it seems important. yet, + # we also don't want to hose up their normal sudo actions, such as passing + # along the current environment, should the user choose. function sudo() { save_terminal_title - /usr/bin/sudo "$@" + # hoist our X authorization info in case environment is passed along; + # this can allow root to use our display to show Xorg windows. + if [ ! -z "$DISPLAY" ]; then + export IMPORTED_XAUTH="$(xauth list $DISPLAY | head -n 1 | awk '{print $3}')" + fi + # prep a simple string here, rather than messing with arguments in the + # already complicated command below. + cmd="/usr/bin/sudo ""$@" + + # omit any variables that are either wrong for a different user or used + # to shield the feisty meow scripts from reconfiguring. when we do the + # sudo, we want a fresh start for feisty meow at least. this approach + # is complicated by our sentinel alias, which normally is passed to any + # subshells. + BUILD_VARS_LOADED= \ + CORE_VARIABLES_LOADED= \ + FEISTY_MEOW_SCRIPTS_LOADED= \ + function_sentinel= \ + MAIL= \ + bash +O expand_aliases -c "$cmd" + # the above does cause an extra shell, but we need it to work + # identically to the normal sudo syntax, and that gets us this. retval=$? restore_terminal_title -# if [ "$first_command" == "su" ]; then -# # yep, they were doing an su, but they're back now. -# label_terminal_with_info -# fi return $retval } @@ -452,76 +515,85 @@ 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 restore_terminal_title } - # copies a set of custom scripts into the proper location for feisty meow - # to merge their functions and aliases with the standard set. + # merges a set of custom scripts into the feisty meow environment. can be + # passed a name to use as the custom scripts source folder (found on path + # $FEISTY_MEOW_SCRIPTS/customize/{name}), or it will try to guess the name + # by using the login name. function recustomize() { 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="$(fm_username)" + # we do intend to use the login name 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 + # chop off any email address style formatting to leave just the name. + custom_user="$(echo "$custom_user" | cut -f1 -d'@')" 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. -#hmmm: save error output here instead of muting it. -#hmmm: better yet actually, just don't complain on freaking cygwin, since that's where this happens - chown -R "$(logname):$(logname)" \ - "$FEISTY_MEOW_LOADING_DOCK"/* "$FEISTY_MEOW_GENERATED_STORE"/* 2>/dev/null - test_or_continue "chowning to $(logname) didn't happen." - + # recreate the feisty meow loading dock. 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="\n -are the perl dependencies installed? if you're on ubuntu or debian, try this:\n - $(grep "apt-get.*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..." - perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files - test_or_continue "running safedel. $fail_message" - echo + + # jump into the loading dock and make our custom link. + pushd "$FEISTY_MEOW_LOADING_DOCK" &>/dev/null + if [ -h custom ]; then + # there's an existing link, so remove it. + \rm custom + fi + # make sure we cleaned up the area before we re-link. + if [ -h custom -o -d custom -o -f custom ]; then + echo " +Due to an over-abundance of caution, we are not going to remove an unexpected +'custom' object found in the file system. This object is located in the +feisty meow loading dock here: $(pwd) +And here is a description of the rogue 'custom' object: +" + ls -al custom + echo " +If you are pretty sure that this is just a remnant of an older approach in +feisty meow, where we copied the custom directory rather than linking it +(and it most likely is just such a bit of cruft of that nature), then please +remove that old remnant 'custom' item, for example by saying: + /bin/rm -rf \"custom\" ; popd +Sorry for the interruption, but we want to make sure this removal wasn't +automatic if there is even a small amount of doubt about the issue." + return 1 fi + + # create the custom folder as a link to the customizations. + ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom + popd &>/dev/null - echo "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" - if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then - echo "copying custom scripts for $custom_user" - rsync -avz "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null - test_or_continue "copying customization scripts" -#hmmm: could save output to show if an error occurs. - fi - echo + # now take into account all the customizations by regenerating the feisty meow environment. regenerate - # prevent permission foul-ups, again. - chown -R "$(logname):$(logname)" \ - "$FEISTY_MEOW_LOADING_DOCK" "$FEISTY_MEOW_GENERATED_STORE" 2>/dev/null - test_or_continue "chowning to $(logname) didn't happen." - restore_terminal_title } @@ -550,10 +622,9 @@ or if you're on cygwin, then try this (if apt-cyg is available):\n 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 } @@ -673,49 +744,6 @@ or if you're on cygwin, then try this (if apt-cyg is available):\n popd &>/dev/null } - function spacem() - { - while [ $# -gt 0 ]; do - arg="$1"; shift - if [ ! -f "$arg" -a ! -d "$arg" ]; 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. - 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 - } - ############## # new breed of definer functions goes here. still in progress. @@ -778,8 +806,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 } @@ -801,7 +829,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'." } @@ -818,7 +846,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[@]}" @@ -879,12 +907,12 @@ return 0 # make a backup first, oy. \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}" - test_or_die "backing up file: $filename" + 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" - test_or_die "cleaning out new version of file from: $new_version" + exit_on_error "cleaning out new version of file from: $new_version" local line local skip_count=0 @@ -919,7 +947,7 @@ return 0 if [ ! -z "$found_any" ]; then # put the file back into place under the original name. \mv "$new_version" "$filename" - test_or_die "moving the new version into place in: $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" @@ -928,6 +956,36 @@ return 0 ############## + # space 'em all: fixes naming for all of the files of the appropriate types + # in the directories specified. + function spacemall() { + local -a dirs=("${@}") + if [ ${#dirs[@]} -eq 0 ]; then + dirs=(.) + fi + + local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)" + find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f | \ + grep -i \ +"doc\|docx\|eml\|html\|jpeg\|jpg\|m4a\|mov\|mp3\|ods\|odt\|pdf\|png\|ppt\|pptx\|txt\|vsd\|vsdx\|xls\|xlsx\|zip" | \ + sed -e 's/^/"/' | sed -e 's/$/"/' | \ + xargs bash "$FEISTY_MEOW_SCRIPTS/files/spacem.sh" + # drop the temp file now that we're done. + rm "$charnfile" + } + + ############## + + # 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() @@ -945,7 +1003,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