trying again; was only getting the link for feisty meow code.
[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 functions.sh because already defined.
12   fi
13   skip_all=yes
14 fi
15
16 if [ -z "$skip_all" ]; then
17   if [ ! -z "$SHELL_DEBUG" ]; then
18     echo function definitions begin...
19   fi
20   
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() {
24     local sep="$1"; shift
25     if [ -z "$sep" ]; then sep='_'; fi
26     date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
27   }
28   
29   # makes a directory of the name specified and then tries to change the
30   # current directory to that directory.
31   function mcd() {
32     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
33     cd "$1"
34   }
35   
36   # locates a process given a search pattern to match in the process list.
37   function psfind() {
38     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
39     local PIDS_SOUGHT=()
40     local patterns=($*)
41     if [ "$OS" == "Windows_NT" ]; then
42       # needs to be a windows format filename for 'type' to work.
43       if [ ! -d c:/tmp ]; then
44         mkdir c:/tmp
45       fi
46       # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not really there
47       # in the root of drive c: when we look for it later.  hoping to fix that problem by using a subdir, which
48       # also might be magical thinking from windows perspective.
49       tmppid=c:\\tmp\\pids.txt
50       # we have abandoned all hope of relying on ps on windows.  instead
51       # we use wmic to get full command lines for processes.
52       # this does not exist on windows home edition.  we are hosed if that's
53       # what they insist on testing on.
54       wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
55       local flag='/c'
56       if [ ! -z "$(uname -a | grep "^MING" )" ]; then
57         flag='//c'
58       fi
59       # we 'type' the file to get rid of the unicode result from wmic.
60       cmd $flag type "$tmppid" >$PID_DUMP
61       \rm "$tmppid"
62       local CR='\r'  # embedded carriage return.
63       local appropriate_pattern="s/^.*  *\([0-9][0-9]*\)[ $CR]*\$/\1/p"
64       for i in "${patterns[@]}"; do
65         PIDS_SOUGHT+=$(cat $PID_DUMP \
66           | grep -i "$i" \
67           | sed -n -e "$appropriate_pattern")
68         if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
69           # we want to bail as soon as we get matches, because on the same
70           # platform, the same set of patterns should work to find all
71           # occurrences of the genesis java.
72           break;
73         fi
74       done
75     else
76       /bin/ps $extra_flags wuax >$PID_DUMP
77       # pattern to use for peeling off the process numbers.
78       local appropriate_pattern='s/^[-a-zA-Z_0-9][-a-zA-Z_0-9]*  *\([0-9][0-9]*\).*$/\1/p'
79       # remove the first line of the file, search for the pattern the
80       # user wants to find, and just pluck the process ids out of the
81       # results.
82       for i in "${patterns[@]}"; do
83         PIDS_SOUGHT=$(cat $PID_DUMP \
84           | sed -e '1d' \
85           | grep -i "$i" \
86           | sed -n -e "$appropriate_pattern")
87         if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
88           # we want to bail as soon as we get matches, because on the same
89           # platform, the same set of patterns should work to find all
90           # occurrences of the genesis java.
91           break;
92         fi
93       done
94     fi
95     if [ ! -z "$PIDS_SOUGHT" ]; then echo "$PIDS_SOUGHT"; fi
96     /bin/rm $PID_DUMP
97   }
98   
99   # finds all processes matching the pattern specified and shows their full
100   # process listing (whereas psfind just lists process ids).
101   function psa() {
102     if [ -z "$1" ]; then
103       echo "psa finds processes by pattern, but there was no pattern on the command line."
104       return 1
105     fi
106     p=$(psfind "$1")
107     if [ -z "$p" ]; then
108       # no matches.
109       return 0
110     fi
111     echo ""
112     echo "Processes containing \"$1\"..."
113     echo ""
114     if [ -n "$IS_DARWIN" ]; then
115       unset fuzil_sentinel
116       for i in $p; do
117         # only print the header the first time.
118         if [ -z "$fuzil_sentinel" ]; then
119           ps $i -w -u
120         else
121           ps $i -w -u | sed -e '1d'
122         fi
123         fuzil_sentinel=true
124       done
125     else 
126       # cases besides mac os x's darwin.
127       extra_flags=
128       if [ "$OS" = "Windows_NT" ]; then
129         # special case for windows.
130         extra_flags=-W
131         ps | head -1
132         for curr in $p; do
133           ps $extra_flags | grep "$curr" 
134         done
135       else
136         # normal OSes can handle a nice simple query.
137         ps wu $p
138       fi
139     fi
140   }
141   
142   # an unfortunately similarly named function to the above 'ps' as in process
143   # methods, but this 'ps' stands for postscript.  this takes a postscript file
144   # and converts it into pcl3 printer language and then ships it to the printer.
145   # this mostly makes sense for an environment where one's default printer is
146   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
147   # some good success running ps2ps on the input file and using the cleaned
148   # postscript file for printing.
149   function ps2pcl2lpr() {
150     for $i in $*; do
151       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l 
152     done
153   }
154   
155   function fix_alsa() {
156     sudo /etc/init.d/alsasound restart
157   }
158   
159   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
160   function msys_to_dos_path() {
161     # we always remove dos slashes in favor of forward slashes.
162     echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
163   }
164   
165   # switches from an X:/ form to an /X/path form.
166   function dos_to_msys_path() {
167     # we always remove dos slashes in favor of forward slashes.
168     echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
169   }
170   
171   # su function: makes su perform a login.
172   # for some OSes, this transfers the X authority information to the new login.
173   function su() {
174     # decide if we think this is debian or ubuntu or a variant.
175     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
176         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
177   
178     if [ $DEBIAN_LIKE -eq 1 ]; then
179       # debian currently requires the full version which imports X authority
180       # information for su.
181   
182       # get the x authority info for our current user.
183       source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
184   
185       if [ -z "$X_auth_info" ]; then
186         # if there's no authentication info to pass along, we just do a normal su.
187         /bin/su -l $*
188       else
189         # under X, we update the new login's authority info with the previous
190         # user's info.
191         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
192       fi
193     else
194       # non-debian supposedly doesn't need the extra overhead any more.
195       # or at least suse doesn't, which is the other one we've tested on.
196       /bin/su -l $*
197     fi
198   
199     # relabel the console after returning.
200     bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
201   }
202   
203   # sudo function wraps the normal sudo by ensuring we replace the terminal
204   # label if they're doing an su with the sudo.
205   function sudo() {
206     local first_command="$1"
207     /usr/bin/sudo $*
208     if [ "$first_command" == "su" ]; then
209       # yep, they were doing an su, but they're back now.
210       bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
211     fi
212   }
213   
214   # buntar is a long needed uncompressing macro that feeds into tar -x.
215   # it takes a list of bz2 file names and extracts their contents into
216   # sequentially numbered directories.
217   function buntar() {
218     index=1
219     for i in $*; do
220       mkdir buntar_$index
221       pushd buntar_$index &>/dev/null
222       file=$i
223       # if the filename has no directory component, we will assume it used to
224       # be above our unzipping directory here.
225       if [ "$(basename $file)" = $file ]; then
226         file=../$file
227       fi
228       bunzip2 -d -c $file | tar -xf -
229       popd &>/dev/null
230       index=$(expr $index + 1)
231     done
232   }
233   
234   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
235   # this kind of assumes you've already checked them for any salient facts.
236   function clean_cvs_junk() {
237     for i in $*; do
238       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";" 
239     done
240   }
241
242   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
243   function nechung() {
244     local wheres_nechung=$(which nechung 2>/dev/null)
245     if [ -z "$wheres_nechung" ]; then
246       echo "The nechung oracle program cannot be found.  You may want to consider"
247       echo "rebuilding the feisty meow applications with this command:"
248       echo "   bash $FEISTY_MEOW_DIR/scripts/generator/bootstrap_build.sh"
249     else
250       $wheres_nechung
251     fi
252   }
253   
254   # recreates all the generated files that the feisty meow scripts use.
255   function regenerate() {
256     bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
257     echo
258     nechung
259   }
260
261   function function_sentinel() { return 0; }
262   
263   if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi
264   
265 fi
266