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 function definitions, because already defined."
  12   fi
  13   skip_all=yes
  14 fi
  15
  16 if [ -z "$skip_all" ]; then
  17
  18   if [ ! -z "$SHELL_DEBUG" ]; then
  19     echo "feisty meow function definitions beginning now..."
  20   fi
  21
  22   # a handy little method that can be used for date strings.  it was getting
  23   # really tiresome how many different ways the script did the date formatting.
  24   function date_stringer() {
  25     local sep="$1"; shift
  26     if [ -z "$sep" ]; then sep='_'; fi
  27     date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
  28   }
  29
  30   # makes a directory of the name specified and then tries to change the
  31   # current directory to that directory.
  32   function mcd() {
  33     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
  34     cd "$1"
  35   }
  36
  37   function is_array() {
  38     [[ "$(declare -p $1)" =~ "declare -a" ]]
  39   }
  40
  41   function is_alias() {
  42     alias $1 &>/dev/null
  43     return $?
  44   }
  45
  46   # displays the value of a variable in bash friendly format.
  47   function var() {
  48     HOLDIFS="$IFS"
  49     IFS=""
  50     while true; do
  51       local varname="$1"; shift
  52       if [ -z "$varname" ]; then
  53         break
  54       fi
  55
  56       if is_alias "$varname"; then
  57 #echo found $varname is alias
  58         local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
  59         alias $varname | sed -e 's/.*=//' >$tmpfile
  60         echo "alias $varname=$(cat $tmpfile)"
  61         \rm $tmpfile
  62       elif [ -z "${!varname}" ]; then
  63         echo "$varname undefined"
  64       else
  65         if is_array "$varname"; then
  66 #echo found $varname is array var
  67           local temparray
  68           eval temparray="(\${$varname[@]})"
  69           echo "$varname=(${temparray[@]})"
  70 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
  71 # see ones that have spaces in them.
  72         else
  73 #echo found $varname is simple
  74           echo "$varname=${!varname}"
  75         fi
  76       fi
  77     done
  78     IFS="$HOLDIFS"
  79   }
  80
  81   function success_sound()
  82   {
  83     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
  84       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
  85     fi
  86   }
  87
  88   function error_sound()
  89   {
  90     if [ ! -z "$CLAM_ERROR_SOUND" ]; then
  91       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
  92     fi
  93   }
  94
  95   # checks the result of the last command that was run, and if that failed,
  96   # then this complains and exits from bash.  the function parameters are
  97   # used as the message to print as a complaint.
  98   function check_result()
  99   {
 100     if [ $? -ne 0 ]; then
 101       echo -e "failed on: $*"
 102       error_sound
 103       exit 1
 104     fi
 105   }
 106
 107   # locates a process given a search pattern to match in the process list.
 108   function psfind() {
 109     local -a patterns=("${@}")
 110 #echo ====
 111 #echo patterns list is: "${patterns[@]}"
 112 #echo ====
 113     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
 114     local -a PIDS_SOUGHT
 115     if [ "$OS" == "Windows_NT" ]; then
 116       # windows case has some odd gyrations to get the user list.
 117       if [ ! -d c:/tmp ]; then
 118         mkdir c:/tmp
 119       fi
 120       # windows7 magical mystery tour lets us create a file c:\\tmp_pids.txt, but then it's not
 121       # really there in the root of drive c: when we look for it later.  hoping to fix that
 122       # problem by using a subdir, which also might be magical thinking from windows perspective.
 123       tmppid=c:\\tmp\\pids.txt
 124       # we have abandoned all hope of relying on ps on windows.  instead we use wmic to get full
 125       # command lines for processes.
 126       wmic /locale:ms_409 PROCESS get processid,commandline </dev/null >"$tmppid"
 127       local flag='/c'
 128       if [ ! -z "$(uname -a | grep "^MING" )" ]; then
 129         flag='//c'
 130       fi
 131       # we 'type' the file to get rid of the unicode result from wmic.
 132       # needs to be a windows format filename for 'type' to work.
 133       cmd $flag type "$tmppid" >$PID_DUMP
 134       \rm "$tmppid"
 135       local appropriate_pattern='s/^.*[[:space:]][[:space:]]*\([0-9][0-9]*\) *\$/\1/p'
 136       local i
 137       for i in "${patterns[@]}"; do
 138         PIDS_SOUGHT+=($(cat $PID_DUMP \
 139           | grep -i "$i" \
 140           | sed -n -e "$appropriate_pattern"))
 141       done
 142     else
 143       /bin/ps $extra_flags wuax >$PID_DUMP
 144 #echo ====
 145 #echo got all this stuff in the pid dump file:
 146 #cat $PID_DUMP
 147 #echo ====
 148       # pattern to use for peeling off the process numbers.
 149       local appropriate_pattern='s/^[-+a-zA-Z_0-9][-+a-zA-Z_0-9]*[[:space:]][[:space:]]*\([0-9][0-9]*\).*$/\1/p'
 150       # remove the first line of the file, search for the pattern the
 151       # user wants to find, and just pluck the process ids out of the
 152       # results.
 153       local i
 154       for i in "${patterns[@]}"; do
 155 #echo pattern is $i
 156 #echo phase 1: $(cat $PID_DUMP | sed -e '1d' )
 157 #echo phase 2: $(cat $PID_DUMP | sed -e '1d' | grep -i "$i" )
 158         PIDS_SOUGHT+=($(cat $PID_DUMP \
 159           | sed -e '1d' \
 160           | grep -i "$i" \
 161           | sed -n -e "$appropriate_pattern"))
 162       done
 163 #echo ====
 164 #echo pids sought list became:
 165 #echo "${PIDS_SOUGHT[@]}"
 166 #echo ====
 167     fi
 168     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 169       local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
 170       PIDS_SOUGHT=()
 171       PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
 172       echo ${PIDS_SOUGHT[*]}
 173     fi
 174     /bin/rm $PID_DUMP
 175   }
 176
 177   # finds all processes matching the pattern specified and shows their full
 178   # process listing (whereas psfind just lists process ids).
 179   function psa() {
 180     if [ -z "$1" ]; then
 181       echo "psa finds processes by pattern, but there was no pattern on the command line."
 182       return 1
 183     fi
 184     p=$(psfind "${@}")
 185     if [ -z "$p" ]; then
 186       # no matches.
 187       return 0
 188     fi
 189     echo ""
 190     echo "Processes matching ${@}..."
 191     echo ""
 192     if [ -n "$IS_DARWIN" ]; then
 193       unset fuzil_sentinel
 194       for i in $p; do
 195         # only print the header the first time.
 196         if [ -z "$fuzil_sentinel" ]; then
 197           ps $i -w -u
 198         else
 199           ps $i -w -u | sed -e '1d'
 200         fi
 201         fuzil_sentinel=true
 202       done
 203     else
 204       # cases besides mac os x's darwin.
 205       extra_flags=
 206       if [ "$OS" = "Windows_NT" ]; then
 207         # special case for windows.
 208         extra_flags=-W
 209         ps | head -1
 210         for curr in $p; do
 211           ps $extra_flags | grep "$curr"
 212         done
 213       else
 214         # normal OSes can handle a nice simple query.
 215         ps wu $p
 216       fi
 217     fi
 218   }
 219
 220   # an unfortunately similarly named function to the above 'ps' as in process
 221   # methods, but this 'ps' stands for postscript.  this takes a postscript file
 222   # and converts it into pcl3 printer language and then ships it to the printer.
 223   # this mostly makes sense for an environment where one's default printer is
 224   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
 225   # some good success running ps2ps on the input file and using the cleaned
 226   # postscript file for printing.
 227   function ps2pcl2lpr() {
 228     for $i in $*; do
 229       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
 230     done
 231   }
 232
 233   function fix_alsa() {
 234     sudo /etc/init.d/alsasound restart
 235   }
 236
 237   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
 238   function unix_to_dos_path() {
 239     # we usually remove dos slashes in favor of forward slashes.
 240     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
 241       # unless this flag is set, in which case we force dos slashes.
 242       echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
 243     else
 244       echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 245     fi
 246   }
 247
 248   # switches from an X:/ form to an /X/path form.
 249   function dos_to_unix_path() {
 250     # we always remove dos slashes in favor of forward slashes.
 251     echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
 252   }
 253
 254   # returns a successful value (0) if this system is debian or ubuntu.
 255   function debian_like() {
 256     # decide if we think this is debian or ubuntu or a variant.
 257     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
 258         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
 259     if [ $DEBIAN_LIKE -eq 1 ]; then
 260       # success; this is debianish.
 261       return 0
 262     else
 263       # this seems like some other OS.
 264       return 1
 265     fi
 266   }
 267
 268   # su function: makes su perform a login.
 269   # for some OSes, this transfers the X authority information to the new login.
 270   function su() {
 271     if debian_like; then
 272       # debian currently requires the full version which imports X authority
 273       # information for su.
 274
 275       # get the x authority info for our current user.
 276       source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
 277
 278       if [ -z "$X_auth_info" ]; then
 279         # if there's no authentication info to pass along, we just do a normal su.
 280         /bin/su -l $*
 281       else
 282         # under X, we update the new login's authority info with the previous
 283         # user's info.
 284         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 285       fi
 286     else
 287       # non-debian supposedly doesn't need the extra overhead any more.
 288       # or at least suse doesn't, which is the other one we've tested on.
 289       /bin/su -l $*
 290     fi
 291
 292     # relabel the console after returning.
 293     bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 294   }
 295
 296   # sudo function wraps the normal sudo by ensuring we replace the terminal
 297   # label if they're doing an su with the sudo.
 298   function sudo() {
 299     local first_command="$1"
 300     /usr/bin/sudo "$@"
 301     if [ "$first_command" == "su" ]; then
 302       # yep, they were doing an su, but they're back now.
 303       bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 304     fi
 305   }
 306
 307   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
 308   # this kind of assumes you've already checked them for any salient facts.
 309   function clean_cvs_junk() {
 310     for i in $*; do
 311       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 312     done
 313   }
 314
 315   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 316   function nechung() {
 317     local wheres_nechung=$(which nechung 2>/dev/null)
 318     if [ -z "$wheres_nechung" ]; then
 319       echo "The nechung oracle program cannot be found.  You may want to consider"
 320       echo "rebuilding the feisty meow applications with this command:"
 321       echo "bash $FEISTY_MEOW_SCRIPTS/generator/bootstrap_build.sh"
 322     else
 323       $wheres_nechung
 324     fi
 325   }
 326
 327   # recreates all the generated files that the feisty meow scripts use.
 328   function regenerate() {
 329     # do the bootstrapping process again.
 330     echo "regenerating feisty meow script environment."
 331     bash $FEISTY_MEOW_SCRIPTS/core/bootstrap_shells.sh
 332     echo
 333     # force a full reload by turning off sentinel variable and alias.
 334     # the nethack one is used by fred's customizations.
 335     # interesting note perhaps: found that the NETHACKOPTIONS variable was
 336     # not being unset correctly when preceded by an alias.  split them up
 337     # like they are now due to that bug.
 338     unset -v CORE_ALIASES_LOADED FEISTY_MEOW_GENERATED NECHUNG NETHACKOPTIONS
 339     unset -f function_sentinel
 340     # reload feisty meow environment in current shell.
 341     source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
 342     # run nechung oracle to give user a new fortune.
 343     nechung
 344   }
 345
 346   # generates a random password where the first parameter is the number of characters
 347   # in the password (default 20) and the second parameter specifies whether to use
 348   # special characters (1) or not (0).
 349   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
 350   function random_password()
 351   {
 352     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 353     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 354     echo
 355   }
 356
 357   # a wrapper for the which command that finds items on the path.  some OSes
 358   # do not provide which, so we want to not be spewing errors when that
 359   # happens.
 360   function whichable()
 361   {
 362     to_find="$1"; shift
 363     which which &>/dev/null
 364     if [ $? -ne 0 ]; then
 365       # there is no which command here.  we produce nothing due to this.
 366       echo
 367     fi
 368     echo $(which $to_find)
 369   }
 370
 371   # copies a set of custom scripts into the proper location for feisty meow
 372   # to merge their functions and aliases with the standard set.
 373   function recustomize()
 374   {
 375     user="$1"; shift
 376     if [ -z "$user" ]; then
 377       # use our default example user if there was no name provided.
 378       user=fred
 379     fi
 380     if [ ! -d "$FEISTY_MEOW_DIR/customizing/$user" ]; then
 381       echo "The customization folder provided for $user should be:"
 382       echo "  '$FEISTY_MEOW_DIR/customizing/$user'"
 383       echo "but that folder does not exist.  Skipping customization."
 384       return 1
 385     fi
 386     regenerate >/dev/null
 387     pushd "$FEISTY_MEOW_GENERATED/custom" &>/dev/null
 388     local incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom")"
 389     if [ ${#incongruous_files} -ge 1 ]; then
 390       echo "cleaning unknown older overrides..."
 391       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
 392       echo
 393     fi
 394     popd &>/dev/null
 395     echo "copying custom overrides for $user"
 396     mkdir "$FEISTY_MEOW_GENERATED/custom" 2>/dev/null
 397     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_DIR/customizing/$user" "$FEISTY_MEOW_GENERATED/custom"
 398     if [ -d "$FEISTY_MEOW_DIR/customizing/$user/scripts" ]; then
 399       echo "copying custom scripts for $user"
 400       \cp -R "$FEISTY_MEOW_DIR/customizing/$user/scripts" "$FEISTY_MEOW_GENERATED/custom/"
 401     fi
 402     echo
 403     regenerate
 404   }
 405
 406 #uhhh, this does what now?
 407   function add_cygwin_drive_mounts() {
 408     for i in c d e f g h q z ; do
 409       ln -s /cygdrive/$i $i
 410     done
 411   }
 412
 413   # takes a file to modify, and then it will replace any occurrences of the
 414   # pattern provided as the second parameter with the text in the third
 415   # parameter.
 416   function replace_pattern_in_file()
 417   {
 418     local file="$1"; shift
 419     local pattern="$1"; shift
 420     local replacement="$1"; shift
 421     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
 422       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
 423       echo "text to replace that pattern with."
 424       return 1
 425     fi
 426     sed -i -e "s%$pattern%$replacement%g" "$file"
 427   }
 428
 429   function spacem()
 430   {
 431     while [ $# -gt 0 ]; do
 432       arg="$1"; shift
 433       if [ ! -f "$arg" -a ! -d "$arg" ]; then
 434         echo "failure to find a file or directory named '$arg'."
 435         continue
 436       fi
 437       # first we rename the file to be lower case.
 438       perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$arg" &>/dev/null
 439       # oops, now the name is all lower-case.  we need to make the
 440       # same adjustment.
 441       arg2="$(echo "$arg" | tr A-Z a-z)"
 442       # we definitely wanted to adjust the case first, rather than doing all
 443       # the wacky stuff this script does to the filename...  we will capture
 444       # the output of the replace operaton for reporting.
 445       final_name="$(perl "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg2")"
 446       # now zap the intermediate part of the name off.
 447       final_name="$(echo $final_name | sed -e 's/.*=> //')"
 448       # printout the combined operation results.
 449       echo "'$arg' => $final_name"
 450     done
 451   }
 452
 453   ##############
 454
 455   function function_sentinel() { return 0; }
 456
 457   if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
 458
 459 fi
 460