# This defines some general, useful functions.
+#hmmm: starting to get a bit beefy in here. perhaps there is a good way to refactor the functions into more specific folders, if they aren't really totally general purpose?
+
+##############
+
# test whether we've been here before or not.
skip_all=
type function_sentinel &>/dev/null
if [ $? -eq 0 ]; then
# there was no error, so we can skip the inits.
- if [ ! -z "$SHELL_DEBUG" ]; then
+ if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
echo "skipping function definitions, because already defined."
fi
skip_all=yes
if [ -z "$skip_all" ]; then
- if [ ! -z "$SHELL_DEBUG" ]; then
+ if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
echo "feisty meow function definitions beginning now..."
fi
date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
}
+ # 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
+ local WHICHER="$(/usr/bin/which which 2>/dev/null)"
+#>&2 echo "got whicher as: $WHICHER"
+ if [ $? -ne 0 ]; then
+ # there is no which command here. we produce nothing due to this.
+ echo
+ return 2
+ fi
+ local sporkenz # must be defined local here, before call, or we don't get exit value?!
+ sporkenz=$($WHICHER "$to_find" 2>/dev/null)
+#>&2 echo "broken with this line, but here is exit val: $?"
+ local err=$?
+#>&2 echo "got whicher as: $WHICHER"
+ echo $sporkenz
+ return $err
+ }
+
# makes a directory of the name specified and then tries to change the
# current directory to that directory.
function mcd() {
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.
+ # the numbering starts at zero, for the first item at the head of the pipe.
+ 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.
function var() {
HOLDIFS="$IFS"
IFS="$HOLDIFS"
}
+ ##############
+
+ # when passed a list of things, this will return the unique items from that list as an echo.
+ function uniquify()
+ {
+ # do the uniquification: split the space separated items into separate lines, then
+ # sort the list, then run the uniq tool on the list. results will be packed back onto
+ # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
+ echo $* | tr ' ' '\n' | sort | uniq
+ }
+
# sets the variable in parameter 1 to the value in parameter 2, but only if
# that variable was undefined.
function set_var_if_undefined()
fi
}
+ ##############
+
function success_sound()
{
if [ ! -z "$CLAM_FINISH_SOUND" ]; 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 check_result()
+ function exit_on_error()
{
if [ $? -ne 0 ]; then
- echo -e "failed on: $*"
+ echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..."
error_sound
exit 1
fi
}
+ # like exit_on_error, but will keep going after complaining.
+ function continue_on_error()
+ {
+ if [ $? -ne 0 ]; then
+ 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 # remember the current terminal title.
+ /usr/bin/ssh -C "${args[@]}"
+#hmmm: removed -Y flag because considered dangerous to trust remote hosts to not abuse our X session.
+ restore_terminal_title
+ }
+
+ # this version of ssh preserves the use of the -Y flag for when X forwarding is needed.
+ function yssh()
+ {
+ local args=($@)
+ save_terminal_title # remember the current terminal title.
+ /usr/bin/ssh -Y "${args[@]}"
+ restore_terminal_title
+ }
+
+ ##############
+
# 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
- # processes of that user are considered.
+ #
+ # + the -u flag specifies a user name, e.g. "-u joe", which causes only
+ # the processes of that user "joe" to be considered.
+ #
+ # + the -x flag specifies a pattern to exclude from the list, e.g. "-x pszap.sh"
+ # would ignore any processes that mention the phrase "pszap.sh".
function psfind() {
+ local user_flag="-e"
+ # default user flag is for all users.
+ local excluder="ScrengeflebbitsAPhraseWeNeverExpecttomatchanythingYO298238"
+ # for our default, pick an exclusion string we would never match.
+
+ local found_flag=1
+ while [ $found_flag -eq 1 ]; do
+ # reset our sentinel now that we're safely in our loop.
+ found_flag=0
+
+ # save the first argument, since we're going to shift the args.
+ local arg1="$1"
+ if [ "$arg1" == "-u" ]; then
+ # handle the user flag.
+ user_flag="-u $2"
+#echo "found a -u parm and user=$2"
+ found_flag=1 # signal that we found one.
+ # skip these two arguments, since we've consumed them.
+ shift
+ shift
+ elif [ "$arg1" == "-x" ]; then
+ # handle the exclusion flag.
+ excluder="$2"
+#echo "found a -x parm and excluder=$excluder"
+ found_flag=1 # signal that we found one.
+ # skip these two arguments, since we've consumed them.
+ shift
+ shift
+ fi
+ done
+
+ # now that we've yanked any flags out, we can pull the rest of the
+ # arguments in as patterns to seek in the process list.
local -a patterns=("${@}")
#echo ====
#echo patterns list is: "${patterns[@]}"
#echo ====
- local user_flag
- if [ "${patterns[0]}" == "-u" ]; then
- user_flag="-u ${patterns[1]}"
-#echo "found a -u parm and user=${patterns[1]}"
- # void the two elements with that user flag so we don't use them as patterns.
- unset patterns[0] patterns[1]=
- else
- # select all users.
- user_flag="-e"
- fi
-
local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
local -a PIDS_SOUGHT
local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
else
- # flags which clean up the output on unixes, which apparently cygwin
- # doesn't count as. their crappy specialized ps doesn't support this.
+ # flags which clean up the process listing output on unixes.
+ # apparently cygwin doesn't count as a type of unix, because their
+ # crummy specialized ps command doesn't support normal ps flags.
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'
# ids out of the results.
local i
for i in "${patterns[@]}"; do
+#echo "pattern curr is '$i'"
PIDS_SOUGHT+=($(cat $PID_DUMP \
| grep -i "$i" \
+ | grep -v "$excluder" \
| sed -n -e "$pid_finder_pattern"))
done
#echo ====
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.
done
}
- function fix_alsa() {
- sudo /etc/init.d/alsasound restart
+ function screen() {
+ save_terminal_title
+#hmmm: ugly absolute path here.
+ /usr/bin/screen $*
+ restore_terminal_title
}
# switches from a /X/path form to an X:/ form. this also processes cygwin paths.
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() {
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.
-
- # get the x authority info for our current user.
- source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
-
- if [ -z "$X_auth_info" ]; then
- # if there's no authentication info to pass along, we just do a normal su.
- /bin/su -l $*
- else
- # under X, we update the new login's authority info with the previous
- # user's info.
- (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
- fi
- else
- # non-debian supposedly doesn't need the extra overhead any more.
- # or at least suse doesn't, which is the other one we've tested on.
- /bin/su -l $*
- fi
-
- # relabel the console after returning.
- bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
- }
-
- # 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 preserve
+ # specific variables that enable the main user's ssh credentials to still
+ # be relied on for ssh forwarding, even if the '-i' flag is passed to cause
+ # a fresh shell (which normally doesn't get the launching user's environment
+ # variables).
function sudo() {
- local first_command="$1"
- /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
+ save_terminal_title
+
+ # hoist our X authorization info in case environment is passed along;
+ # this can allow root to use our display to show X.org windows.
+ if [ -z "$IMPORTED_XAUTH" -a ! -z "$DISPLAY" ]; then
+ export IMPORTED_XAUTH="$(xauth list $DISPLAY | head -n 1 | awk '{print $3}')"
+ local REMOVE_IMP_XAUTH=true
+ fi
+
+ # launch sudo with just the variables we want to reach the other side.
+ local varmods=
+ varmods+="OLD_HOME=$HOME "
+ if [ ! -z "$IMPORTED_XAUTH" ]; then varmods+="IMPORTED_XAUTH=$IMPORTED_XAUTH "; fi
+ if [ ! -z "$SSH_AUTH_SOCK" ]; then varmods+="SSH_AUTH_SOCK=$SSH_AUTH_SOCK "; fi
+ /usr/bin/sudo $varmods "$@"
+ retval=$?
+
+ # take the xauth info away again if it wasn't set already.
+ if [ ! -z "$REMOVE_IMP_XAUTH" ]; then
+ unset IMPORTED_XAUTH
fi
+ restore_terminal_title
+ return $retval
}
- # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
+ # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
# this kind of assumes you've already checked them for any salient facts.
function clean_cvs_junk() {
for i in $*; do
# 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)
+ local wheres_nechung=$(whichable nechung)
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/produce_feisty_meow.sh"
+ echo
else
$wheres_nechung
fi
# recreates all the generated files that the feisty meow scripts use.
function regenerate() {
# do the bootstrapping process again.
+ save_terminal_title
echo "regenerating feisty meow script environment."
bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
echo
# force a full reload by turning off sentinel variables and methods.
- unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
+ unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED \
+ BUILD_VARS_LOADED
unalias CORE_ALIASES_LOADED &>/dev/null
unset -f function_sentinel
+
+ # reuse the original path if we can.
+ if [ ! -z "$FEISTY_MEOW_ORIGINAL_PATH" ]; then
+ export PATH="$FEISTY_MEOW_ORIGINAL_PATH"
+ fi
+
# reload feisty meow environment in current shell.
- source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
+ 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()
{
- user="$1"; shift
- if [ -z "$user" ]; then
- # use our default example user if there was no name provided.
- user=fred
+ local custom_user="$1"; shift
+ if [ -z "$custom_user" ]; then
+ # 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
- if [ ! -d "$FEISTY_MEOW_APEX/customize/$user" ]; then
- echo "The customization folder provided for $user should be:"
- echo " '$FEISTY_MEOW_APEX/customize/$user'"
- echo "but that folder does not exist. Skipping customization."
+ # 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 -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
+
+ # 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_APEX/customize/$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
+
+ # 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
- popd &>/dev/null
- echo "copying custom overrides for $user"
- mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
- perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customize/$user" "$FEISTY_MEOW_LOADING_DOCK/custom"
- if [ -d "$FEISTY_MEOW_APEX/customize/$user/scripts" ]; then
- echo "copying custom scripts for $user"
- \cp -R "$FEISTY_MEOW_APEX/customize/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
+ # 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
- echo
+
+ # create the custom folder as a link to the customizations.
+ ln -s "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" custom
+
+ popd &>/dev/null
+
+ # now take into account all the customizations by regenerating the feisty meow environment.
regenerate
+
+ restore_terminal_title
}
# generates a random password where the first parameter is the number of characters
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
+#hmmm: improve this by not adding the link if already there, or if the drive is not valid.
ln -s /cygdrive/$i $i
done
}
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.
return 0
}
- # defines a variable within the feisty meow environment and remembers that
- # 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 "${@}"
-#
-#
-#return 0
-# }
+ ##############
+
+#hmmm: this points to an extended functions file being needed; not all of these are core.
+
+ # displays documentation in "md" formatted files.
+ function show_md()
+ {
+ local file="$1"; shift
+ pandoc "$file" | lynx -stdin
+ }
##############
{
count=$1; shift
if [ -z "$count" ]; then
- count=79
+ count=$(($COLUMNS - 1))
fi
echo
local i
- for ((i=0; i < $count - 1; i++)); do
+ for ((i=0; i < $count; i++)); do
echo -n "="
done
echo
##############
+ # count the number of sub-directories in a directory and echo the result.
+ function count_directories()
+ {
+ local subbydir="$1"; shift
+ numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
+ echo $numdirs
+ }
+
+ # takes a string and capitalizes just the first character. any capital letters in the remainder of
+ # the string are made lower case. the processed string is returned by an echo.
+ function capitalize_first_char()
+ {
+ local to_dromedary="$1"; shift
+ to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
+ echo "$to_dromedary"
+ }
+
+ # given a source path and a target path, this will make a symbolic link from
+ # the source to the destination, but only if the source actually exists.
+ function make_safe_link()
+ {
+ local src="$1"; shift
+ local target="$1"; shift
+
+ if [ -d "$src" ]; then
+ ln -s "$src" "$target"
+ exit_on_error "Creating symlink from '$src' to '$target'"
+ fi
+ echo "Created symlink from '$src' to '$target'."
+ }
+
+ # pretty prints the json files provided as parameters.
+ function clean_json()
+ {
+ if [ -z "$*" ]; then return; fi
+ local show_list=()
+ while true; do
+ local file="$1"; shift
+ if [ -z "$file" ]; then break; fi
+ if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
+ temp_out="$TMP/$file.view"
+ cat "$file" | python -m json.tool > "$temp_out"
+ show_list+=($temp_out)
+ continue_on_error "pretty printing '$file'"
+ done
+ filedump "${show_list[@]}"
+ rm "${show_list[@]}"
+ }
+
+ function json_text()
+ {
+ # only print our special headers or text fields.
+ local CR=$'\r'
+ local LF=$'\n'
+ clean_json $* |
+ grep -i "\"text\":\|^=.*" |
+ sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
+ }
+
+ ##############
+
+ # echoes the machine's hostname. can be used like so:
+ # local my_host=$(get_hostname)
+ function get_hostname()
+ {
+ # there used to be more variation in how to do this, but adopting mingw
+ # and cygwin tools really helped out.
+ local this_host=unknown
+ if [ "$OS" == "Windows_NT" ]; then
+ this_host=$(hostname)
+ elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
+ this_host=$(hostname)
+ elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
+ this_host=$(hostname --long)
+ elif [ -x "$(whichable hostname)" ]; then
+ this_host=$(hostname)
+ fi
+ echo "$this_host"
+ }
+
+ # makes sure that the provided "folder" is a directory and is writable.
+ function test_writeable()
+ {
+ local folder="$1"; shift
+ if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
+ 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
+ }
+
+ ##############
+
+ # space 'em all: fixes naming for all of the files of the appropriate types
+ # in the directories specified. we skip any file with a dot in front, to
+ # respect their hidden nature. currently the set of files we'll rename is
+ # very boutique; it's in this function, and just happens to be the types of
+ # files we work with a lot.
+ function spacemall() {
+ local -a dirs=("${@}")
+ if [ ${#dirs[@]} -eq 0 ]; then
+ dirs=(.)
+ fi
+
+ local charnfile="$(mktemp $TMP/zz_charn.XXXXXX)"
+#hmmm: any way to do the below more nicely or reusably?
+#hmmm: yes! a variable with a list of files that are considered TEXT_FILE_EXTENSIONS or something like that.
+#hmmm: yes continued! also a variable for BINARY_FILE_EXTENSIONS to avoid those, where we need to in other scripts.
+#hmmm: wait, we actually have a mix here, since this is a renaming function and not a searching function; get it straight!
+#hmmm: would the composition of those two types of extensions cover all the files i want to rename? they have to be "important".
+ find "${dirs[@]}" -follow -maxdepth 1 -mindepth 1 -type f -and -not -iname ".[a-zA-Z0-9]*" | \
+ grep -i \
+"csv\|doc\|docx\|eml\|html\|ics\|jpeg\|jpg\|m4a\|mov\|mp3\|odp\|ods\|odt\|pdf\|png\|ppt\|pptx\|rtf\|txt\|vsd\|vsdx\|wav\|xls\|xlsx\|xml\|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"
+ }
+
+ ##############
+
+ # tty relevant functions...
+
+ # keep_awake: sends a message to the screen from the background.
+ function keep_awake()
+ {
+ # just starts the keep_awake process in the background.
+ bash $FEISTY_MEOW_SCRIPTS/tty/keep_awake_process.sh &
+ # this should leave the job running as %1 or a higher number if there
+ # are pre-existing background jobs.
+ }
+
+ ##############
+
+ # site avenger functions...
+
+ function switchto()
+ {
+ THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
+ source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
+ switch_to "$1"
+ }
+
+ ##############
+
+ # you have hit the borderline functional zone...
+
+#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
+
+ }
+
+ # ...and here's the end of the borderline functional zone.
+
+ ##############
+
+ # NOTE: no more function definitions are allowed after this point.
+
function function_sentinel()
{
return 0;
}
- if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
+ if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
##############
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"
+ 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