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