3 # This defines some general, useful functions.
5 # test whether we've been here before or not.
7 function_sentinel &>/dev/null
9 # there was no error, so we can skip the inits.
10 if [ ! -z "$SHELL_DEBUG" ]; then
11 echo skipping functions.sh because already defined.
16 if [ -z "$skip_all" ]; then
17 if [ ! -z "$SHELL_DEBUG" ]; then
18 echo function definitions begin...
21 # a handy little method that can be used for date strings. it was getting
22 # really tiresome how many different ways the script did the date formatting.
23 function date_stringer() {
25 if [ -z "$sep" ]; then sep='_'; fi
26 date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
29 # makes a directory of the name specified and then tries to change the
30 # current directory to that directory.
32 if [ ! -d "$1" ]; then mkdir -p "$1"; fi
36 # displays the value of a variable in bash friendly format.
39 local varname="$1"; shift
40 if [ -z "$varname" ]; then
43 if [ -z "${!varname}" ]; then
44 echo "$varname undefined"
46 echo "$varname=${!varname}"
51 function success_sound()
53 if [ ! -z "$CLAM_FINISH_SOUND" ]; then
54 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
58 function error_sound()
60 if [ ! -z "$CLAM_ERROR_SOUND" ]; then
61 bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
65 # checks the result of the last command that was run, and if it failed,
66 # then this complains and exits from bash. the function parameters are
67 # used as the message to print as a complaint.
68 function check_result()
71 echo -e "failed on: $*"
77 # locates a process given a search pattern to match in the process list.
79 local -a patterns=("${@}")
80 mkdir $TEST_TEMP/grid_logs &>/dev/null
81 local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
83 if [ "$OS" == "Windows_NT" ]; then
84 # needs to be a windows format filename for 'type' to work.
85 if [ ! -d c:/tmp ]; then
88 # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not
89 # really there in the root of drive c: when we look for it later. hoping to fix that
90 # problem by using a subdir, which also might be magical thinking from windows perspective.
91 tmppid=c:\\tmp\\pids.txt
92 # we have abandoned all hope of relying on ps on windows. instead we use wmic to get full
93 # command lines for processes.
94 wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
96 if [ ! -z "$(uname -a | grep "^MING" )" ]; then
99 # we 'type' the file to get rid of the unicode result from wmic.
100 cmd $flag type "$tmppid" >$PID_DUMP
103 ' # embedded carriage return.
104 local appropriate_pattern="s/^.* *\([0-9][0-9]*\)[ $CR]*\$/\1/p"
106 for i in "${patterns[@]}"; do
107 PIDS_SOUGHT+=($(cat $PID_DUMP \
109 | sed -n -e "$appropriate_pattern"))
112 /bin/ps $extra_flags wuax >$PID_DUMP
113 # pattern to use for peeling off the process numbers.
114 local appropriate_pattern='s/^[-a-zA-Z_0-9][-a-zA-Z_0-9]* *\([0-9][0-9]*\).*$/\1/p'
115 # remove the first line of the file, search for the pattern the
116 # user wants to find, and just pluck the process ids out of the
119 for i in "${patterns[@]}"; do
120 PIDS_SOUGHT+=($(cat $PID_DUMP \
123 | sed -n -e "$appropriate_pattern"))
126 if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
127 PIDS_SOUGHT=$(echo ${PIDS_SOUGHT[*]} | sort | uniq)
128 echo ${PIDS_SOUGHT[*]}
133 # finds all processes matching the pattern specified and shows their full
134 # process listing (whereas psfind just lists process ids).
137 echo "psa finds processes by pattern, but there was no pattern on the command line."
146 echo "Processes containing \"$1\"..."
148 if [ -n "$IS_DARWIN" ]; then
151 # only print the header the first time.
152 if [ -z "$fuzil_sentinel" ]; then
155 ps $i -w -u | sed -e '1d'
160 # cases besides mac os x's darwin.
162 if [ "$OS" = "Windows_NT" ]; then
163 # special case for windows.
167 ps $extra_flags | grep "$curr"
170 # normal OSes can handle a nice simple query.
176 # an unfortunately similarly named function to the above 'ps' as in process
177 # methods, but this 'ps' stands for postscript. this takes a postscript file
178 # and converts it into pcl3 printer language and then ships it to the printer.
179 # this mostly makes sense for an environment where one's default printer is
180 # pcl. if the input postscript causes ghostscript to bomb out, there has been
181 # some good success running ps2ps on the input file and using the cleaned
182 # postscript file for printing.
183 function ps2pcl2lpr() {
185 gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
189 function fix_alsa() {
190 sudo /etc/init.d/alsasound restart
193 # switches from a /X/path form to an X:/ form. this also processes cygwin paths.
194 function unix_to_dos_path() {
195 # we usually remove dos slashes in favor of forward slashes.
196 if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
197 # unless this flag is set, in which case we force dos slashes.
198 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
200 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
204 # switches from an X:/ form to an /X/path form.
205 function dos_to_unix_path() {
206 # we always remove dos slashes in favor of forward slashes.
207 echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
210 # returns a successful value (0) if this system is debian or ubuntu.
211 function debian_like() {
212 # decide if we think this is debian or ubuntu or a variant.
213 DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
214 -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
215 if [ $DEBIAN_LIKE -eq 1 ]; then
216 # success; this is debianish.
219 # this seems like some other OS.
224 # su function: makes su perform a login.
225 # for some OSes, this transfers the X authority information to the new login.
228 # debian currently requires the full version which imports X authority
229 # information for su.
231 # get the x authority info for our current user.
232 source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
234 if [ -z "$X_auth_info" ]; then
235 # if there's no authentication info to pass along, we just do a normal su.
238 # under X, we update the new login's authority info with the previous
240 (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
243 # non-debian supposedly doesn't need the extra overhead any more.
244 # or at least suse doesn't, which is the other one we've tested on.
248 # relabel the console after returning.
249 bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
252 # sudo function wraps the normal sudo by ensuring we replace the terminal
253 # label if they're doing an su with the sudo.
255 local first_command="$1"
257 if [ "$first_command" == "su" ]; then
258 # yep, they were doing an su, but they're back now.
259 bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
263 # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
264 # this kind of assumes you've already checked them for any salient facts.
265 function clean_cvs_junk() {
267 find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
271 # overlay for nechung binary so that we can complain less grossly about it when it's missing.
273 local wheres_nechung=$(which nechung 2>/dev/null)
274 if [ -z "$wheres_nechung" ]; then
275 echo "The nechung oracle program cannot be found. You may want to consider"
276 echo "rebuilding the feisty meow applications with this command:"
277 echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
283 # recreates all the generated files that the feisty meow scripts use.
284 function regenerate() {
285 bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
290 # generates a random password where the first parameter is the number of characters
291 # in the password (default 20) and the second parameter specifies whether to use
292 # special characters (1) or not (0).
293 # found function at http://legroom.net/2010/05/06/bash-random-password-generator
294 function random_password()
296 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
297 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
301 # a wrapper for the which command that finds items on the path. some OSes
302 # do not provide which, so we want to not be spewing errors when that
307 which which &>/dev/null
308 if [ $? -ne 0 ]; then
309 # there is no which command here. we produce nothing due to this.
312 echo $(which $to_find)
315 # copies a set of custom scripts into the proper location for feisty meow
316 # to merge their functions and aliases with the standard set.
317 function recustomize()
320 if [ -z "$user" ]; then
321 # use our default example user if there was no name provided.
324 if [ ! -d "$FEISTY_MEOW_DIR/customizing/$user" ]; then
325 echo "The customization folder provided for $user should be:"
326 echo " '$FEISTY_MEOW_DIR/customizing/$user'"
327 echo "but that folder does not exist. Skipping customization."
330 regenerate >/dev/null
331 pushd "$FEISTY_MEOW_GENERATED/custom" &>/dev/null
332 local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom")"
333 if [ ${#incongruous_files} -ge 1 ]; then
334 echo "cleaning unknown older overrides..."
335 perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
339 echo "copying custom overrides for $user"
340 mkdir "$FEISTY_MEOW_GENERATED/custom" 2>/dev/null
341 perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom"
345 function add_cygwin_drive_mounts() {
346 for i in c d e f g h q z ; do
347 ln -s /cygdrive/$i $i
352 # takes a file to modify, and then it will replace any occurrences of the
353 # pattern provided as the second parameter with the text in the third
355 function replace_pattern_in_file()
357 local file="$1"; shift
358 local pattern="$1"; shift
359 local replacement="$1"; shift
360 if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
361 echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
362 echo "text to replace that pattern with."
365 sed -i -e "s%$pattern%$replacement%g" "$file"
370 function function_sentinel() { return 0; }
372 if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi