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   # displays the value of a variable in bash friendly format.
  37   function var() {
  38     while true; do
  39       local varname="$1"; shift
  40       if [ -z "$varname" ]; then
  41         break
  42       fi
  43       if [ -z "${!varname}" ]; then
  44         echo "$varname undefined"
  45       else
  46         echo "$varname=${!varname}"
  47       fi
  48     done
  49   }
  50
  51   function success_sound()
  52   {
  53     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
  54       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
  55     fi
  56   }
  57
  58   function error_sound()
  59   {
  60     if [ ! -z "$CLAM_ERROR_SOUND" ]; then
  61       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
  62     fi
  63   }
  64
  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()
  69   {
  70     if [ $? -ne 0 ]; then
  71       echo -e "failed on: $*"
  72       error_sound
  73       exit 1
  74     fi
  75   }
  76
  77   # locates a process given a search pattern to match in the process list.
  78   function psfind() {
  79     local -a patterns=("${@}")
  80     mkdir $TEST_TEMP/grid_logs &>/dev/null
  81     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
  82     local PIDS_SOUGHT=()
  83     if [ "$OS" == "Windows_NT" ]; then
  84       # needs to be a windows format filename for 'type' to work.
  85       if [ ! -d c:/tmp ]; then
  86         mkdir c:/tmp
  87       fi
  88       # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not really there
  89       # in the root of drive c: when we look for it later.  hoping to fix that problem by using a subdir, which
  90       # 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
  93       # we use wmic to get full command lines for processes.
  94       # this does not exist on windows home edition.  we are hosed if that's
  95       # what they insist on testing on.
  96       wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
  97       local flag='/c'
  98       if [ ! -z "$(uname -a | grep "^MING" )" ]; then
  99         flag='//c'
 100       fi
 101       # we 'type' the file to get rid of the unicode result from wmic.
 102       cmd $flag type "$tmppid" >$PID_DUMP
 103       \rm "$tmppid"
 104       local CR='
 105 '  # embedded carriage return.
 106       local appropriate_pattern="s/^.*  *\([0-9][0-9]*\)[ $CR]*\$/\1/p"
 107       for i in "${patterns[@]}"; do
 108         local -a PIDS_SOUGHT+=($(cat $PID_DUMP \
 109           | grep -i "$i" \
 110           | sed -n -e "$appropriate_pattern"))
 111         if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 112           # we want to bail as soon as we get matches, because on the same
 113           # platform, the same set of patterns should work to find all
 114           # occurrences of the genesis java.
 115           break;
 116         fi
 117       done
 118     else
 119       /bin/ps $extra_flags wuax >$PID_DUMP
 120       # pattern to use for peeling off the process numbers.
 121       local appropriate_pattern='s/^[-a-zA-Z_0-9][-a-zA-Z_0-9]*  *\([0-9][0-9]*\).*$/\1/p'
 122       # remove the first line of the file, search for the pattern the
 123       # user wants to find, and just pluck the process ids out of the
 124       # results.
 125       for i in "${patterns[@]}"; do
 126         local -a PIDS_SOUGHT=($(cat $PID_DUMP \
 127           | sed -e '1d' \
 128           | grep -i "$i" \
 129           | sed -n -e "$appropriate_pattern"))
 130         if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 131           # we want to bail as soon as we get matches, because on the same
 132           # platform, the same set of patterns should work to find all
 133           # occurrences of the genesis java.
 134           break;
 135         fi
 136       done
 137     fi
 138     if [ ! -z "$PIDS_SOUGHT" ]; then echo "$PIDS_SOUGHT"; fi
 139     /bin/rm $PID_DUMP
 140   }
 141
 142   # finds all processes matching the pattern specified and shows their full
 143   # process listing (whereas psfind just lists process ids).
 144   function psa() {
 145     if [ -z "$1" ]; then
 146       echo "psa finds processes by pattern, but there was no pattern on the command line."
 147       return 1
 148     fi
 149     p=$(psfind "$1")
 150     if [ -z "$p" ]; then
 151       # no matches.
 152       return 0
 153     fi
 154     echo ""
 155     echo "Processes containing \"$1\"..."
 156     echo ""
 157     if [ -n "$IS_DARWIN" ]; then
 158       unset fuzil_sentinel
 159       for i in $p; do
 160         # only print the header the first time.
 161         if [ -z "$fuzil_sentinel" ]; then
 162           ps $i -w -u
 163         else
 164           ps $i -w -u | sed -e '1d'
 165         fi
 166         fuzil_sentinel=true
 167       done
 168     else
 169       # cases besides mac os x's darwin.
 170       extra_flags=
 171       if [ "$OS" = "Windows_NT" ]; then
 172         # special case for windows.
 173         extra_flags=-W
 174         ps | head -1
 175         for curr in $p; do
 176           ps $extra_flags | grep "$curr"
 177         done
 178       else
 179         # normal OSes can handle a nice simple query.
 180         ps wu $p
 181       fi
 182     fi
 183   }
 184
 185   # an unfortunately similarly named function to the above 'ps' as in process
 186   # methods, but this 'ps' stands for postscript.  this takes a postscript file
 187   # and converts it into pcl3 printer language and then ships it to the printer.
 188   # this mostly makes sense for an environment where one's default printer is
 189   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
 190   # some good success running ps2ps on the input file and using the cleaned
 191   # postscript file for printing.
 192   function ps2pcl2lpr() {
 193     for $i in $*; do
 194       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
 195     done
 196   }
 197
 198   function fix_alsa() {
 199     sudo /etc/init.d/alsasound restart
 200   }
 201
 202   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
 203   function unix_to_dos_path() {
 204     # we usually remove dos slashes in favor of forward slashes.
 205     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
 206       # unless this flag is set, in which case we force dos slashes.
 207       echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
 208     else
 209       echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 210     fi
 211   }
 212
 213   # switches from an X:/ form to an /X/path form.
 214   function dos_to_unix_path() {
 215     # we always remove dos slashes in favor of forward slashes.
 216     echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
 217   }
 218
 219   # returns a successful value (0) if this system is debian or ubuntu.
 220   function debian_like() {
 221     # decide if we think this is debian or ubuntu or a variant.
 222     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
 223         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
 224     if [ $DEBIAN_LIKE -eq 1 ]; then
 225       # success; this is debianish.
 226       return 0
 227     else
 228       # this seems like some other OS.
 229       return 1
 230     fi
 231   }
 232
 233   # su function: makes su perform a login.
 234   # for some OSes, this transfers the X authority information to the new login.
 235   function su() {
 236     if debian_like; then
 237       # debian currently requires the full version which imports X authority
 238       # information for su.
 239
 240       # get the x authority info for our current user.
 241       source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
 242
 243       if [ -z "$X_auth_info" ]; then
 244         # if there's no authentication info to pass along, we just do a normal su.
 245         /bin/su -l $*
 246       else
 247         # under X, we update the new login's authority info with the previous
 248         # user's info.
 249         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 250       fi
 251     else
 252       # non-debian supposedly doesn't need the extra overhead any more.
 253       # or at least suse doesn't, which is the other one we've tested on.
 254       /bin/su -l $*
 255     fi
 256
 257     # relabel the console after returning.
 258     bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 259   }
 260
 261   # sudo function wraps the normal sudo by ensuring we replace the terminal
 262   # label if they're doing an su with the sudo.
 263   function sudo() {
 264     local first_command="$1"
 265     /usr/bin/sudo "$@"
 266     if [ "$first_command" == "su" ]; then
 267       # yep, they were doing an su, but they're back now.
 268       bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 269     fi
 270   }
 271
 272   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
 273   # this kind of assumes you've already checked them for any salient facts.
 274   function clean_cvs_junk() {
 275     for i in $*; do
 276       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 277     done
 278   }
 279
 280   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 281   function nechung() {
 282     local wheres_nechung=$(which nechung 2>/dev/null)
 283     if [ -z "$wheres_nechung" ]; then
 284       echo "The nechung oracle program cannot be found.  You may want to consider"
 285       echo "rebuilding the feisty meow applications with this command:"
 286       echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
 287     else
 288       $wheres_nechung
 289     fi
 290   }
 291
 292   # recreates all the generated files that the feisty meow scripts use.
 293   function regenerate() {
 294     bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
 295     echo
 296     nechung
 297   }
 298
 299   # generates a random password where the first parameter is the number of characters
 300   # in the password (default 20) and the second parameter specifies whether to use
 301   # special characters (1) or not (0).
 302   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
 303   function random_password()
 304   {
 305     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 306     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 307     echo
 308   }
 309
 310   # a wrapper for the which command that finds items on the path.  some OSes
 311   # do not provide which, so we want to not be spewing errors when that
 312   # happens.
 313   function whichable()
 314   {
 315     to_find="$1"; shift
 316     which which &>/dev/null
 317     if [ $? -ne 0 ]; then
 318       # there is no which command here.  we produce nothing due to this.
 319       echo
 320     fi
 321     echo $(which $to_find)
 322   }
 323
 324   # copies a set of custom scripts into the proper location for feisty meow
 325   # to merge their functions and aliases with the standard set.
 326   function recustomize()
 327   {
 328     user="$1"; shift
 329     if [ -z "$user" ]; then
 330       # use our default example user if there was no name provided.
 331       user=fred
 332     fi
 333     if [ ! -d "$FEISTY_MEOW_DIR/customizing/$user" ]; then
 334       echo "The customization folder provided for $user should be:"
 335       echo "  '$FEISTY_MEOW_DIR/customizing/$user'"
 336       echo "but that folder does not exist.  Skipping customization."
 337       return 1
 338     fi
 339     regenerate >/dev/null
 340     pushd "$FEISTY_MEOW_GENERATED/custom" &>/dev/null
 341     local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom")"
 342     if [ ${#incongruous_files} -ge 1 ]; then
 343       echo "cleaning unknown older overrides..."
 344       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
 345       echo
 346     fi
 347     popd &>/dev/null
 348     echo "copying custom overrides for $user"
 349     mkdir "$FEISTY_MEOW_GENERATED/custom" 2>/dev/null
 350     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom"
 351     regenerate
 352   }
 353
 354   function add_cygwin_drive_mounts() {
 355     for i in c d e f g h q z ; do
 356       ln -s /cygdrive/$i $i
 357     done
 358   }
 359
 360
 361   # takes a file to modify, and then it will replace any occurrences of the
 362   # pattern provided as the second parameter with the text in the third
 363   # parameter.
 364   function replace_pattern_in_file()
 365   {
 366     local file="$1"; shift
 367     local pattern="$1"; shift
 368     local replacement="$1"; shift
 369     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
 370       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
 371       echo "text to replace that pattern with."
 372       return 1
 373     fi
 374     sed -i -e "s%$pattern%$replacement%g" "$file"
 375   }
 376
 377   ##############
 378
 379   function function_sentinel() { return 0; }
 380
 381   if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi
 382
 383 fi
 384