# 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=
-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
+ if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
echo "skipping function definitions, because already defined."
fi
skip_all=yes
+else
+ skip_all=
fi
if [ -z "$skip_all" ]; then
- if [ ! -z "$SHELL_DEBUG" ]; then
+ if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
echo "feisty meow function definitions beginning now..."
fi
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"
echo "$varname=${!varname}"
fi
fi
- done
+ done | sort
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()
+ {
+ 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
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=($*)
+ # 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
+ 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
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 </dev/null >"$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 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'
+ 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=()
# 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.
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
+#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
+#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 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.
# information for su.
# get the x authority info for our current user.
- source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
+ source "$FEISTY_MEOW_SCRIPTS/security/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.
# 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.
function sudo() {
- local first_command="$1"
+ save_terminal_title
/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
+ 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
}
- # 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
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"
+ 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/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 &>/dev/null
unset -f function_sentinel
# 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.
+ function recustomize()
+ {
+ local custom_user="$1"; shift
+ if [ -z "$custom_user" ]; then
+ # 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 -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="\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
+ log_feisty_meow_event "cleaning unknown older overrides..."
+ perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
+ continue_on_error "running safedel. $fail_message"
+ fi
+ popd &>/dev/null
+ 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"
+ continue_on_error "running cpdiff. $fail_message"
+
+ if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
+ 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
+ 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
}
# generates a random password where the first parameter is the number of characters
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
+#hmmm: improve this by not adding the link if already there, or if the drive is not valid.
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.
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
+ if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
+ rm -rf $* &>/dev/null
+ if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
+ 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'."
+ echo "=> did not 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
}
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 "${@}"
+#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
+ }
-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; }
+ # 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 [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
+ 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 "$(which hostname 2>/dev/null)" ]; 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
+ }
+
+ ##############
+
+ # 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()
+ {
+ return 0;
+ }
+ if [ ! -z "$DEBUG_FEISTY_MEOW" ]; 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
+ 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
+ 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
projects / feisty_meow.git / blobdiff