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