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
  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"
  95       local flag='/c'
  96       if [ ! -z "$(uname -a | grep "^MING" )" ]; then
  97         flag='//c'
  98       fi
  99       # we 'type' the file to get rid of the unicode result from wmic.
 100       cmd $flag type "$tmppid" >$PID_DUMP
 101       \rm "$tmppid"
 102       local CR='
 103 '  # embedded carriage return.
 104       local appropriate_pattern="s/^.*  *\([0-9][0-9]*\)[ $CR]*\$/\1/p"
 105       local -a PIDS_SOUGHT
 106       for i in "${patterns[@]}"; do
 107         PIDS_SOUGHT+=($(cat $PID_DUMP \
 108           | grep -i "$i" \
 109           | sed -n -e "$appropriate_pattern"))
 110       done
 111     else
 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
 117       # results.
 118       local -a PIDS_SOUGHT
 119       for i in "${patterns[@]}"; do
 120         PIDS_SOUGHT+=($(cat $PID_DUMP \
 121           | sed -e '1d' \
 122           | grep -i "$i" \
 123           | sed -n -e "$appropriate_pattern"))
 124       done
 125     fi
 126     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 127       PIDS_SOUGHT=$(echo ${PIDS_SOUGHT[*]} | sort | uniq)
 128       echo ${PIDS_SOUGHT[*]}
 129     fi
 130     /bin/rm $PID_DUMP
 131   }
 132
 133   # finds all processes matching the pattern specified and shows their full
 134   # process listing (whereas psfind just lists process ids).
 135   function psa() {
 136     if [ -z "$1" ]; then
 137       echo "psa finds processes by pattern, but there was no pattern on the command line."
 138       return 1
 139     fi
 140     p=$(psfind "$1")
 141     if [ -z "$p" ]; then
 142       # no matches.
 143       return 0
 144     fi
 145     echo ""
 146     echo "Processes containing \"$1\"..."
 147     echo ""
 148     if [ -n "$IS_DARWIN" ]; then
 149       unset fuzil_sentinel
 150       for i in $p; do
 151         # only print the header the first time.
 152         if [ -z "$fuzil_sentinel" ]; then
 153           ps $i -w -u
 154         else
 155           ps $i -w -u | sed -e '1d'
 156         fi
 157         fuzil_sentinel=true
 158       done
 159     else
 160       # cases besides mac os x's darwin.
 161       extra_flags=
 162       if [ "$OS" = "Windows_NT" ]; then
 163         # special case for windows.
 164         extra_flags=-W
 165         ps | head -1
 166         for curr in $p; do
 167           ps $extra_flags | grep "$curr"
 168         done
 169       else
 170         # normal OSes can handle a nice simple query.
 171         ps wu $p
 172       fi
 173     fi
 174   }
 175
 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() {
 184     for $i in $*; do
 185       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
 186     done
 187   }
 188
 189   function fix_alsa() {
 190     sudo /etc/init.d/alsasound restart
 191   }
 192
 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'
 199     else
 200       echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 201     fi
 202   }
 203
 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/'
 208   }
 209
 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.
 217       return 0
 218     else
 219       # this seems like some other OS.
 220       return 1
 221     fi
 222   }
 223
 224   # su function: makes su perform a login.
 225   # for some OSes, this transfers the X authority information to the new login.
 226   function su() {
 227     if debian_like; then
 228       # debian currently requires the full version which imports X authority
 229       # information for su.
 230
 231       # get the x authority info for our current user.
 232       source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
 233
 234       if [ -z "$X_auth_info" ]; then
 235         # if there's no authentication info to pass along, we just do a normal su.
 236         /bin/su -l $*
 237       else
 238         # under X, we update the new login's authority info with the previous
 239         # user's info.
 240         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 241       fi
 242     else
 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.
 245       /bin/su -l $*
 246     fi
 247
 248     # relabel the console after returning.
 249     bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 250   }
 251
 252   # sudo function wraps the normal sudo by ensuring we replace the terminal
 253   # label if they're doing an su with the sudo.
 254   function sudo() {
 255     local first_command="$1"
 256     /usr/bin/sudo "$@"
 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
 260     fi
 261   }
 262
 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() {
 266     for i in $*; do
 267       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 268     done
 269   }
 270
 271   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 272   function nechung() {
 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"
 278     else
 279       $wheres_nechung
 280     fi
 281   }
 282
 283   # recreates all the generated files that the feisty meow scripts use.
 284   function regenerate() {
 285     bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
 286     echo
 287     nechung
 288   }
 289
 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()
 295   {
 296     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 297     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 298     echo
 299   }
 300
 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
 303   # happens.
 304   function whichable()
 305   {
 306     to_find="$1"; shift
 307     which which &>/dev/null
 308     if [ $? -ne 0 ]; then
 309       # there is no which command here.  we produce nothing due to this.
 310       echo
 311     fi
 312     echo $(which $to_find)
 313   }
 314
 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()
 318   {
 319     user="$1"; shift
 320     if [ -z "$user" ]; then
 321       # use our default example user if there was no name provided.
 322       user=fred
 323     fi
 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."
 328       return 1
 329     fi
 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
 336       echo
 337     fi
 338     popd &>/dev/null
 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"
 342     regenerate
 343   }
 344
 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
 348     done
 349   }
 350
 351
 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
 354   # parameter.
 355   function replace_pattern_in_file()
 356   {
 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."
 363       return 1
 364     fi
 365     sed -i -e "s%$pattern%$replacement%g" "$file"
 366   }
 367
 368   ##############
 369
 370   function function_sentinel() { return 0; }
 371
 372   if [ ! -z "$SHELL_DEBUG" ]; then echo function definitions end....; fi
 373
 374 fi
 375