new fairly simple method for setting a variable to a value, but only if the variable...
[feisty_meow.git] / scripts / core / functions.sh
1 #!/bin/bash
2
3 # This defines some general, useful functions.
4
5 # test whether we've been here before or not.
6 skip_all=
7 function_sentinel &>/dev/null
8 if [ $? -eq 0 ]; then
9   # there was no error, so we can skip the inits.
10   if [ ! -z "$SHELL_DEBUG" ]; then
11     echo "skipping function definitions, because already defined."
12   fi
13   skip_all=yes
14 fi
15
16 if [ -z "$skip_all" ]; then
17
18   if [ ! -z "$SHELL_DEBUG" ]; then
19     echo "feisty meow function definitions beginning now..."
20   fi
21
22   # a handy little method that can be used for date strings.  it was getting
23   # really tiresome how many different ways the script did the date formatting.
24   function date_stringer() {
25     local sep="$1"; shift
26     if [ -z "$sep" ]; then sep='_'; fi
27     date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
28   }
29   
30   # makes a directory of the name specified and then tries to change the
31   # current directory to that directory.
32   function mcd() {
33     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
34     cd "$1"
35   }
36
37   function is_array() {
38     [[ "$(declare -p $1)" =~ "declare -a" ]]
39   }
40
41   function is_alias() {
42     alias $1 &>/dev/null
43     return $?
44   }
45
46   # displays the value of a variable in bash friendly format.
47   function var() {
48     HOLDIFS="$IFS"
49     IFS=""
50     while true; do
51       local varname="$1"; shift
52       if [ -z "$varname" ]; then
53         break
54       fi
55
56       if is_alias "$varname"; then
57 #echo found $varname is alias
58         local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
59         alias $varname | sed -e 's/.*=//' >$tmpfile
60         echo "alias $varname=$(cat $tmpfile)"
61         \rm $tmpfile
62       elif [ -z "${!varname}" ]; then
63         echo "$varname undefined"
64       else
65         if is_array "$varname"; then
66 #echo found $varname is array var 
67           local temparray
68           eval temparray="(\${$varname[@]})"
69           echo "$varname=(${temparray[@]})"
70 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
71 # see ones that have spaces in them.
72         else
73 #echo found $varname is simple
74           echo "$varname=${!varname}"
75         fi
76       fi
77     done
78     IFS="$HOLDIFS"
79   }
80
81   # sets the variable in parameter 1 to the value in parameter 2, but only if
82   # that variable was undefined.
83   function set_var_if_undefined()
84   {
85     local var_name="$1"; shift
86     local var_value="$1"; shift
87     if [ -z "${!var_name}" ]; then
88       eval export $var_name="$var_value"
89     fi
90   }
91
92   function success_sound()
93   {
94     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
95       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
96     fi
97   }
98
99   function error_sound()
100   {
101     if [ ! -z "$CLAM_ERROR_SOUND" ]; then
102       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
103     fi
104   }
105
106   # checks the result of the last command that was run, and if that failed,
107   # then this complains and exits from bash.  the function parameters are
108   # used as the message to print as a complaint.
109   function check_result()
110   {
111     if [ $? -ne 0 ]; then
112       echo -e "failed on: $*"
113       error_sound
114       exit 1
115     fi
116   }
117
118   # locates a process given a search pattern to match in the process list.
119   # supports a single command line flag style parameter of "-u USERNAME";
120   # if the -u flag is found, a username is expected afterwards, and only the
121   # processes of that user are considered.
122   function psfind() {
123     local -a patterns=("${@}")
124 #echo ====
125 #echo patterns list is: "${patterns[@]}"
126 #echo ====
127
128     local user_flag
129     if [ "${patterns[0]}" == "-u" ]; then
130       user_flag="-u ${patterns[1]}" 
131 #echo "found a -u parm and user=${patterns[1]}" 
132       # void the two elements with that user flag so we don't use them as patterns.
133       unset patterns[0] patterns[1]=
134     else
135       # select all users.
136       user_flag="-e"
137     fi
138
139     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
140     local -a PIDS_SOUGHT
141     if [ "$OS" == "Windows_NT" ]; then
142
143 #hmmm: windows isn't implementing the user flag yet!
144 #try collapsing back to the ps implementation from cygwin?
145 # that would simplify things a lot, if we can get it to print the right output.
146
147       # windows case has some odd gyrations to get the user list.
148       if [ ! -d c:/tmp ]; then
149         mkdir c:/tmp
150       fi
151       # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not
152       # really there in the root of drive c: when we look for it later.  hoping to fix that
153       # problem by using a subdir, which also might be magical thinking from windows perspective.
154       tmppid=c:\\tmp\\pids.txt
155       # we have abandoned all hope of relying on ps on windows.  instead we use wmic to get full
156       # command lines for processes.
157       wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
158       local flag='/c'
159       if [ ! -z "$(uname -a | grep "^MING" )" ]; then
160         flag='//c'
161       fi
162       # we 'type' the file to get rid of the unicode result from wmic.
163       # needs to be a windows format filename for 'type' to work.
164       cmd $flag type "$tmppid" >$PID_DUMP
165       \rm "$tmppid"
166       local pid_finder_pattern='s/^.*[[:space:]][[:space:]]*\([0-9][0-9]*\) *\$/\1/p'
167       local i
168       for i in "${patterns[@]}"; do
169         PIDS_SOUGHT+=($(cat $PID_DUMP \
170           | grep -i "$i" \
171           | sed -n -e "$pid_finder_pattern"))
172       done
173     else
174       /bin/ps $user_flag -o pid,args >$PID_DUMP
175 #echo ====
176 #echo got all this stuff in the pid dump file:
177 #cat $PID_DUMP
178 #echo ====
179       # pattern to use for peeling off the process numbers.
180       local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
181       # remove the first line of the file, search for the pattern the
182       # user wants to find, and just pluck the process ids out of the
183       # results.
184       local i
185       for i in "${patterns[@]}"; do
186 #echo pattern is $i
187 #echo phase 1: $(cat $PID_DUMP | sed -e '1d' )
188 #echo phase 2: $(cat $PID_DUMP | sed -e '1d' | grep -i "$i" )
189         PIDS_SOUGHT+=($(cat $PID_DUMP \
190           | sed -e '1d' \
191           | grep -i "$i" \
192           | sed -n -e "$pid_finder_pattern"))
193       done
194 #echo ====
195 #echo pids sought list became:
196 #echo "${PIDS_SOUGHT[@]}"
197 #echo ====
198     fi
199     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
200       local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
201       PIDS_SOUGHT=()
202       PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
203       echo ${PIDS_SOUGHT[*]}
204     fi
205     /bin/rm $PID_DUMP
206   }
207   
208   # finds all processes matching the pattern specified and shows their full
209   # process listing (whereas psfind just lists process ids).
210   function psa() {
211     if [ -z "$1" ]; then
212       echo "psa finds processes by pattern, but there was no pattern on the command line."
213       return 1
214     fi
215     local -a patterns=("${@}")
216     p=$(psfind "${patterns[@]}")
217     if [ -z "$p" ]; then
218       # no matches.
219       return 0
220     fi
221
222     if [ "${patterns[0]}" == "-u" ]; then
223       # void the two elements with that user flag so we don't use them as patterns.
224       unset patterns[0] patterns[1]=
225     fi
226
227     echo ""
228     echo "Processes matching ${patterns[@]}..."
229     echo ""
230     if [ -n "$IS_DARWIN" ]; then
231       unset fuzil_sentinel
232       for i in $p; do
233         # only print the header the first time.
234         if [ -z "$fuzil_sentinel" ]; then
235           ps $i -w -u
236         else
237           ps $i -w -u | sed -e '1d'
238         fi
239         fuzil_sentinel=true
240       done
241     else 
242       # cases besides mac os x's darwin.
243       if [ "$OS" == "Windows_NT" ]; then
244         # special case for windows.
245         ps | head -1
246         for curr in $p; do
247           ps -W | grep "$curr" 
248         done
249       else
250         # normal OSes can handle a nice simple query.
251         ps wu $p
252       fi
253     fi
254   }
255   
256   # an unfortunately similarly named function to the above 'ps' as in process
257   # methods, but this 'ps' stands for postscript.  this takes a postscript file
258   # and converts it into pcl3 printer language and then ships it to the printer.
259   # this mostly makes sense for an environment where one's default printer is
260   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
261   # some good success running ps2ps on the input file and using the cleaned
262   # postscript file for printing.
263   function ps2pcl2lpr() {
264     for $i in $*; do
265       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l 
266     done
267   }
268   
269   function fix_alsa() {
270     sudo /etc/init.d/alsasound restart
271   }
272   
273   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
274   function unix_to_dos_path() {
275     # we usually remove dos slashes in favor of forward slashes.
276     local DOSSYHOME
277     if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
278       # fake this value for non-windows (non-cygwin) platforms.
279       DOSSYHOME="$HOME"
280     else
281       # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
282       # insists on the /home form instead of /c/cygwin/home being possible.  this is
283       # super frustrating and nightmarish.
284       DOSSYHOME="$(cygpath -am "$HOME")"
285     fi
286
287     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
288       # unless this flag is set, in which case we force dos slashes.
289       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
290     else
291       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
292     fi
293   }
294   
295   # switches from an X:/ form to a /cygdrive/X/path form.  this is only useful
296   # for the cygwin environment currently.
297   function dos_to_unix_path() {
298     # we always remove dos slashes in favor of forward slashes.
299 #old:    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
300          echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
301   }
302
303   # returns a successful value (0) if this system is debian or ubuntu.
304   function debian_like() {
305     # decide if we think this is debian or ubuntu or a variant.
306     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
307         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
308     if [ $DEBIAN_LIKE -eq 1 ]; then
309       # success; this is debianish.
310       return 0
311     else
312       # this seems like some other OS.
313       return 1
314     fi
315   }
316   
317   # su function: makes su perform a login.
318   # for some OSes, this transfers the X authority information to the new login.
319   function su() {
320     if debian_like; then
321       # debian currently requires the full version which imports X authority
322       # information for su.
323   
324       # get the x authority info for our current user.
325       source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
326   
327       if [ -z "$X_auth_info" ]; then
328         # if there's no authentication info to pass along, we just do a normal su.
329         /bin/su -l $*
330       else
331         # under X, we update the new login's authority info with the previous
332         # user's info.
333         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
334       fi
335     else
336       # non-debian supposedly doesn't need the extra overhead any more.
337       # or at least suse doesn't, which is the other one we've tested on.
338       /bin/su -l $*
339     fi
340   
341     # relabel the console after returning.
342     bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
343   }
344   
345   # sudo function wraps the normal sudo by ensuring we replace the terminal
346   # label if they're doing an su with the sudo.
347   function sudo() {
348     local first_command="$1"
349     /usr/bin/sudo "$@"
350     if [ "$first_command" == "su" ]; then
351       # yep, they were doing an su, but they're back now.
352       bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
353     fi
354   }
355   
356   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
357   # this kind of assumes you've already checked them for any salient facts.
358   function clean_cvs_junk() {
359     for i in $*; do
360       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";" 
361     done
362   }
363
364   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
365   function nechung() {
366     local wheres_nechung=$(which nechung 2>/dev/null)
367     if [ -z "$wheres_nechung" ]; then
368       echo "The nechung oracle program cannot be found.  You may want to consider"
369       echo "rebuilding the feisty meow applications with this command:"
370       echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
371     else
372       $wheres_nechung
373     fi
374   }
375   
376   # recreates all the generated files that the feisty meow scripts use.
377   function regenerate() {
378     # do the bootstrapping process again.
379     echo "regenerating feisty meow script environment."
380     bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
381     echo
382     # force a full reload by turning off sentinel variable and alias.
383     # the nethack one is used by fred's customizations.
384     # interesting note perhaps: found that the NETHACKOPTIONS variable was
385     # not being unset correctly when preceded by an alias.  split them up
386     # like they are now due to that bug.
387     unset -v CORE_ALIASES_LOADED FEISTY_MEOW_LOADING_DOCK NECHUNG NETHACKOPTIONS 
388     unset -f function_sentinel 
389     # reload feisty meow environment in current shell.
390     source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
391     # run nechung oracle to give user a new fortune.
392     nechung
393   }
394
395   # generates a random password where the first parameter is the number of characters
396   # in the password (default 20) and the second parameter specifies whether to use
397   # special characters (1) or not (0).
398   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
399   function random_password()
400   {
401     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
402     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
403     echo
404   }
405
406   # a wrapper for the which command that finds items on the path.  some OSes
407   # do not provide which, so we want to not be spewing errors when that
408   # happens.
409   function whichable()
410   {
411     to_find="$1"; shift
412     which which &>/dev/null
413     if [ $? -ne 0 ]; then
414       # there is no which command here.  we produce nothing due to this.
415       echo
416     fi
417     echo $(which $to_find)
418   }
419
420   # copies a set of custom scripts into the proper location for feisty meow
421   # to merge their functions and aliases with the standard set.
422   function recustomize()
423   {
424     user="$1"; shift
425     if [ -z "$user" ]; then
426       # use our default example user if there was no name provided.
427       user=fred
428     fi
429     if [ ! -d "$FEISTY_MEOW_APEX/customizing/$user" ]; then
430       echo "The customization folder provided for $user should be:"
431       echo "  '$FEISTY_MEOW_APEX/customizing/$user'"
432       echo "but that folder does not exist.  Skipping customization."
433       return 1
434     fi
435     regenerate >/dev/null
436     pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
437     local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
438
439 #echo "the incongruous files list is: $incongruous_files"
440     # disallow a single character result, since we get "*" as result when nothing exists yet.
441     if [ ${#incongruous_files} -ge 2 ]; then
442       echo "cleaning unknown older overrides..."
443       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
444       echo
445     fi
446     popd &>/dev/null
447     echo "copying custom overrides for $user"
448     mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
449     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom"
450     if [ -d "$FEISTY_MEOW_APEX/customizing/$user/scripts" ]; then
451       echo "copying custom scripts for $user"
452       \cp -R "$FEISTY_MEOW_APEX/customizing/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
453     fi
454     echo
455     regenerate
456   }
457
458 #uhhh, this does what now?
459   function add_cygwin_drive_mounts() {
460     for i in c d e f g h q z ; do
461       ln -s /cygdrive/$i $i
462     done
463   }
464
465   # takes a file to modify, and then it will replace any occurrences of the
466   # pattern provided as the second parameter with the text in the third
467   # parameter.
468   function replace_pattern_in_file()
469   {
470     local file="$1"; shift
471     local pattern="$1"; shift
472     local replacement="$1"; shift
473     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
474       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
475       echo "text to replace that pattern with."
476       return 1
477     fi
478     sed -i -e "s%$pattern%$replacement%g" "$file"
479   }
480
481   # goes to a particular directory passed as parameter 1, and then removes all
482   # the parameters after that from that directory.
483   function push_whack_pop()
484   {
485     local dir="$1"; shift
486     pushd "$dir" &>/dev/null
487     rm -rf $* &>/dev/null
488     popd &>/dev/null
489   }
490
491   function spacem()
492   {
493     while [ $# -gt 0 ]; do
494       arg="$1"; shift
495       if [ ! -f "$arg" -a ! -d "$arg" ]; then
496         echo "failure to find a file or directory named '$arg'."
497         continue
498       fi
499
500       # first we will capture the output of the character replacement operation for reporting.
501       # this is done first since some filenames can't be properly renamed in perl (e.g. if they
502       # have pipe characters apparently).
503       intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
504       local saw_intermediate_result=0
505       if [ -z "$intermediate_name" ]; then
506         # make sure we report something, if there are no further name changes.
507         intermediate_name="'$arg'"
508       else 
509         # now zap the first part of the name off (since original name isn't needed).
510         intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
511         saw_intermediate_result=1
512       fi
513
514       # first we rename the file to be lower case.
515       actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
516       final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
517       local saw_final_result=0
518       if [ -z "$final_name" ]; then
519         final_name="$intermediate_name"
520       else
521         final_name="$(echo $final_name | sed -e 's/.*=> //')"
522         saw_final_result=1
523       fi
524 #echo intermed=$saw_intermediate_result 
525 #echo final=$saw_final_result 
526
527       if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
528         # printout the combined operation results.
529         echo "'$arg' => $final_name"
530       fi
531     done
532   }
533
534   ##############
535
536 # new breed of definer functions goes here.  still in progress.
537
538   # defines an alias and remembers that this is a new or modified definition.
539   # if the feisty meow codebase is unloaded, then so are all the aliases that
540   # were defined.
541   function define_yeti_alias()
542   {
543 # if alias exists already, save old value for restore,
544 # otherwise save null value for restore,
545 # have to handle unaliasing if there was no prior value of one
546 # we newly defined.
547 # add alias name to a list of feisty defined aliases.
548
549 #hmmm: first implem, just do the alias and get that working...
550 alias "${@}"
551
552
553 return 0
554   }
555
556   # defines a variable within the feisty meow environment and remembers that
557   # this is a new or modified definition.  if the feisty meow codebase is
558   # unloaded, then so are all the variables that were defined.
559   # this function always exports the variables it defines.
560 #  function define_yeti_variable()
561 #  {
562 ## if variable exists already, save old value for restore,
563 ## otherwise save null value for restore,
564 ## have to handle unsetting if there was no prior value of one
565 ## we newly defined.
566 ## add variable name to a list of feisty defined variables.
567 #
568 ##hmmm: first implem just sets it up and exports the variable.
569 ##  i.e., this method always exports.
570 #export "${@}" 
571 #
572 #
573 #return 0
574 #  }
575
576   ##############
577
578   function function_sentinel() { return 0; }
579   
580   if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
581
582   ##############
583
584   # test code for set_var_if_undefined.
585   run_test=0
586   if [ $run_test != 0 ]; then
587     echo running tests on set_var_if_undefined.
588     flagrant=petunia
589     set_var_if_undefined flagrant forknordle
590     check_result "testing if defined variable would be whacked"
591     if [ $flagrant != petunia ]; then
592       echo set_var_if_undefined failed to leave the test variable alone
593       exit 1
594     fi
595     unset bobblehead_stomper
596     set_var_if_undefined bobblehead_stomper endurance
597     if [ $bobblehead_stomper != endurance ]; then
598       echo set_var_if_undefined failed to set a variable that was not defined yet
599       exit 1
600     fi
601   fi
602
603 fi
604