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 else
  15   skip_all=
  16 fi
  17
  18 if [ -z "$skip_all" ]; then
  19
  20   if [ ! -z "$SHELL_DEBUG" ]; then
  21     echo "feisty meow function definitions beginning now..."
  22   fi
  23
  24   # a handy little method that can be used for date strings.  it was getting
  25   # really tiresome how many different ways the script did the date formatting.
  26   function date_stringer() {
  27     local sep="$1"; shift
  28     if [ -z "$sep" ]; then sep='_'; fi
  29     date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
  30   }
  31
  32   # makes a directory of the name specified and then tries to change the
  33   # current directory to that directory.
  34   function mcd() {
  35     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
  36     cd "$1"
  37   }
  38
  39   function is_array() {
  40     [[ "$(declare -p $1)" =~ "declare -a" ]]
  41   }
  42
  43   function is_alias() {
  44     alias $1 &>/dev/null
  45     return $?
  46   }
  47
  48   # displays the value of a variable in bash friendly format.
  49   function var() {
  50     HOLDIFS="$IFS"
  51     IFS=""
  52     while true; do
  53       local varname="$1"; shift
  54       if [ -z "$varname" ]; then
  55         break
  56       fi
  57
  58       if is_alias "$varname"; then
  59 #echo found $varname is alias
  60         local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
  61         alias $varname | sed -e 's/.*=//' >$tmpfile
  62         echo "alias $varname=$(cat $tmpfile)"
  63         \rm $tmpfile
  64       elif [ -z "${!varname}" ]; then
  65         echo "$varname undefined"
  66       else
  67         if is_array "$varname"; then
  68 #echo found $varname is array var
  69           local temparray
  70           eval temparray="(\${$varname[@]})"
  71           echo "$varname=(${temparray[@]})"
  72 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
  73 # see ones that have spaces in them.
  74         else
  75 #echo found $varname is simple
  76           echo "$varname=${!varname}"
  77         fi
  78       fi
  79     done | sort
  80     IFS="$HOLDIFS"
  81   }
  82
  83   # sets the variable in parameter 1 to the value in parameter 2, but only if
  84   # that variable was undefined.
  85   function set_var_if_undefined()
  86   {
  87     local var_name="$1"; shift
  88     local var_value="$1"; shift
  89     if [ -z "${!var_name}" ]; then
  90       eval export $var_name="$var_value"
  91     fi
  92   }
  93
  94   function success_sound()
  95   {
  96     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
  97       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
  98     fi
  99   }
 100
 101   function error_sound()
 102   {
 103     if [ ! -z "$CLAM_ERROR_SOUND" ]; then
 104       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
 105     fi
 106   }
 107
 108   # checks the result of the last command that was run, and if that failed,
 109   # then this complains and exits from bash.  the function parameters are
 110   # used as the message to print as a complaint.
 111   function check_result()
 112   {
 113     if [ $? -ne 0 ]; then
 114       echo -e "failed on: $*"
 115       error_sound
 116       exit 1
 117     fi
 118   }
 119
 120   # locates a process given a search pattern to match in the process list.
 121   # supports a single command line flag style parameter of "-u USERNAME";
 122   # if the -u flag is found, a username is expected afterwards, and only the
 123   # processes of that user are considered.
 124   function psfind() {
 125     local -a patterns=("${@}")
 126 #echo ====
 127 #echo patterns list is: "${patterns[@]}"
 128 #echo ====
 129
 130     local user_flag
 131     if [ "${patterns[0]}" == "-u" ]; then
 132       user_flag="-u ${patterns[1]}"
 133 #echo "found a -u parm and user=${patterns[1]}"
 134       # void the two elements with that user flag so we don't use them as patterns.
 135       unset patterns[0] patterns[1]=
 136     else
 137       # select all users.
 138       user_flag="-e"
 139     fi
 140
 141     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
 142     local -a PIDS_SOUGHT
 143
 144     if [ "$OS" == "Windows_NT" ]; then
 145       # gets cygwin's (god awful) ps to show windoze processes also.
 146       local EXTRA_DOZER_FLAGS="-W"
 147       # pattern to use for peeling off the process numbers.
 148       local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
 149
 150     else
 151       # flags which clean up the output on unixes, which apparently cygwin
 152       # doesn't count as.  their crappy specialized ps doesn't support this.
 153       local EXTRA_UNIX_FLAGS="-o pid,args"
 154       # pattern to use for peeling off the process numbers.
 155       local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
 156     fi
 157
 158     /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
 159 #echo ====
 160 #echo got all this stuff in the pid dump file:
 161 #cat $PID_DUMP
 162 #echo ====
 163
 164     # search for the pattern the user wants to find, and just pluck the process
 165     # ids out of the results.
 166     local i
 167     for i in "${patterns[@]}"; do
 168       PIDS_SOUGHT+=($(cat $PID_DUMP \
 169         | grep -i "$i" \
 170         | sed -n -e "$pid_finder_pattern"))
 171     done
 172 #echo ====
 173 #echo pids sought list became:
 174 #echo "${PIDS_SOUGHT[@]}"
 175 #echo ====
 176
 177     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 178       local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
 179       PIDS_SOUGHT=()
 180       PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
 181       echo ${PIDS_SOUGHT[*]}
 182     fi
 183     /bin/rm $PID_DUMP
 184   }
 185
 186   # finds all processes matching the pattern specified and shows their full
 187   # process listing (whereas psfind just lists process ids).
 188   function psa() {
 189     if [ -z "$1" ]; then
 190       echo "psa finds processes by pattern, but there was no pattern on the command line."
 191       return 1
 192     fi
 193     local -a patterns=("${@}")
 194     p=$(psfind "${patterns[@]}")
 195     if [ -z "$p" ]; then
 196       # no matches.
 197       return 0
 198     fi
 199
 200     if [ "${patterns[0]}" == "-u" ]; then
 201       # void the two elements with that user flag so we don't use them as patterns.
 202       unset patterns[0] patterns[1]=
 203     fi
 204
 205     echo ""
 206     echo "Processes matching ${patterns[@]}..."
 207     echo ""
 208     if [ -n "$IS_DARWIN" ]; then
 209       unset fuzil_sentinel
 210       for i in $p; do
 211         # only print the header the first time.
 212         if [ -z "$fuzil_sentinel" ]; then
 213           ps $i -w -u
 214         else
 215           ps $i -w -u | sed -e '1d'
 216         fi
 217         fuzil_sentinel=true
 218       done
 219     else
 220       # cases besides mac os x's darwin.
 221       if [ "$OS" == "Windows_NT" ]; then
 222         # special case for windows.
 223         ps | head -1
 224         for curr in $p; do
 225           ps -W -p $curr | tail -n +2
 226         done
 227       else
 228         # normal OSes can handle a nice simple query.
 229         ps wu $p
 230       fi
 231     fi
 232   }
 233
 234   # an unfortunately similarly named function to the above 'ps' as in process
 235   # methods, but this 'ps' stands for postscript.  this takes a postscript file
 236   # and converts it into pcl3 printer language and then ships it to the printer.
 237   # this mostly makes sense for an environment where one's default printer is
 238   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
 239   # some good success running ps2ps on the input file and using the cleaned
 240   # postscript file for printing.
 241   function ps2pcl2lpr() {
 242     for $i in $*; do
 243       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
 244     done
 245   }
 246
 247   function fix_alsa() {
 248     sudo /etc/init.d/alsasound restart
 249   }
 250
 251   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
 252   function unix_to_dos_path() {
 253     # we usually remove dos slashes in favor of forward slashes.
 254     local DOSSYHOME
 255     if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
 256       # fake this value for non-windows (non-cygwin) platforms.
 257       DOSSYHOME="$HOME"
 258     else
 259       # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
 260       # insists on the /home form instead of /c/cygwin/home being possible.  this is
 261       # super frustrating and nightmarish.
 262       DOSSYHOME="$(cygpath -am "$HOME")"
 263     fi
 264
 265     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
 266       # unless this flag is set, in which case we force dos slashes.
 267       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/' | sed -e 's/\//\\/g'
 268     else
 269       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 270     fi
 271   }
 272
 273   # switches from an X:/ form to a /cygdrive/X/path form.  this is only useful
 274   # for the cygwin environment currently.
 275   function dos_to_unix_path() {
 276     # we always remove dos slashes in favor of forward slashes.
 277 #old:    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
 278          echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
 279   }
 280
 281   # returns a successful value (0) if this system is debian or ubuntu.
 282   function debian_like() {
 283     # decide if we think this is debian or ubuntu or a variant.
 284     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
 285         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
 286     if [ $DEBIAN_LIKE -eq 1 ]; then
 287       # success; this is debianish.
 288       return 0
 289     else
 290       # this seems like some other OS.
 291       return 1
 292     fi
 293   }
 294
 295   # su function: makes su perform a login.
 296   # for some OSes, this transfers the X authority information to the new login.
 297   function su() {
 298     if debian_like; then
 299       # debian currently requires the full version which imports X authority
 300       # information for su.
 301
 302       # get the x authority info for our current user.
 303       source $FEISTY_MEOW_SCRIPTS/x_win/get_x_auth.sh
 304
 305       if [ -z "$X_auth_info" ]; then
 306         # if there's no authentication info to pass along, we just do a normal su.
 307         /bin/su -l $*
 308       else
 309         # under X, we update the new login's authority info with the previous
 310         # user's info.
 311         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 312       fi
 313     else
 314       # non-debian supposedly doesn't need the extra overhead any more.
 315       # or at least suse doesn't, which is the other one we've tested on.
 316       /bin/su -l $*
 317     fi
 318
 319     # relabel the console after returning.
 320     bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 321   }
 322
 323   # sudo function wraps the normal sudo by ensuring we replace the terminal
 324   # label if they're doing an su with the sudo.
 325   function sudo() {
 326     local first_command="$1"
 327     /usr/bin/sudo "$@"
 328     if [ "$first_command" == "su" ]; then
 329       # yep, they were doing an su, but they're back now.
 330       bash $FEISTY_MEOW_SCRIPTS/tty/label_terminal_with_infos.sh
 331     fi
 332   }
 333
 334   # trashes the .#blah files that cvs and svn leave behind when finding conflicts.
 335   # this kind of assumes you've already checked them for any salient facts.
 336   function clean_cvs_junk() {
 337     for i in $*; do
 338       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 339     done
 340   }
 341
 342   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 343   function nechung() {
 344     local wheres_nechung=$(which nechung 2>/dev/null)
 345     if [ -z "$wheres_nechung" ]; then
 346       echo "The nechung oracle program cannot be found.  You may want to consider"
 347       echo "rebuilding the feisty meow applications with this command:"
 348       echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
 349     else
 350       $wheres_nechung
 351     fi
 352   }
 353
 354   # recreates all the generated files that the feisty meow scripts use.
 355   function regenerate() {
 356     # do the bootstrapping process again.
 357     echo "regenerating feisty meow script environment."
 358     bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
 359     echo
 360     # force a full reload by turning off sentinel variable and alias.
 361     # the nethack one is used by fred's customizations.
 362     # interesting note perhaps: found that the NETHACKOPTIONS variable was
 363     # not being unset correctly when preceded by an alias.  split them up
 364     # like they are now due to that bug.
 365     unset -v CORE_ALIASES_LOADED FEISTY_MEOW_LOADING_DOCK NECHUNG NETHACKOPTIONS
 366     unset -f function_sentinel
 367     # reload feisty meow environment in current shell.
 368     source $FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh
 369     # run nechung oracle to give user a new fortune.
 370     nechung
 371   }
 372
 373   # copies a set of custom scripts into the proper location for feisty meow
 374   # to merge their functions and aliases with the standard set.
 375   function recustomize()
 376   {
 377     user="$1"; shift
 378     if [ -z "$user" ]; then
 379       # use our default example user if there was no name provided.
 380       user=fred
 381     fi
 382     if [ ! -d "$FEISTY_MEOW_APEX/customizing/$user" ]; then
 383       echo "The customization folder provided for $user should be:"
 384       echo "  '$FEISTY_MEOW_APEX/customizing/$user'"
 385       echo "but that folder does not exist.  Skipping customization."
 386       return 1
 387     fi
 388     regenerate >/dev/null
 389     pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
 390     incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
 391
 392     #echo "the incongruous files list is: $incongruous_files"
 393     # disallow a single character result, since we get "*" as result when nothing exists yet.
 394     if [ ${#incongruous_files} -ge 2 ]; then
 395       echo "cleaning unknown older overrides..."
 396       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
 397       echo
 398     fi
 399     popd &>/dev/null
 400     echo "copying custom overrides for $user"
 401     mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
 402     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom"
 403     if [ -d "$FEISTY_MEOW_APEX/customizing/$user/scripts" ]; then
 404       echo "copying custom scripts for $user"
 405       \cp -R "$FEISTY_MEOW_APEX/customizing/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/"
 406     fi
 407     echo
 408     regenerate
 409   }
 410
 411   # generates a random password where the first parameter is the number of characters
 412   # in the password (default 20) and the second parameter specifies whether to use
 413   # special characters (1) or not (0).
 414   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
 415   function random_password()
 416   {
 417     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 418     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 419     echo
 420   }
 421
 422   # a wrapper for the which command that finds items on the path.  some OSes
 423   # do not provide which, so we want to not be spewing errors when that
 424   # happens.
 425   function whichable()
 426   {
 427     to_find="$1"; shift
 428     which which &>/dev/null
 429     if [ $? -ne 0 ]; then
 430       # there is no which command here.  we produce nothing due to this.
 431       echo
 432     fi
 433     echo $(which $to_find)
 434   }
 435
 436 #hmmm: improve this by not adding the link
 437 # if already there, or if the drive is not valid.
 438   function add_cygwin_drive_mounts() {
 439     for i in c d e f g h q z ; do
 440       ln -s /cygdrive/$i $i
 441     done
 442   }
 443
 444   # takes a file to modify, and then it will replace any occurrences of the
 445   # pattern provided as the second parameter with the text in the third
 446   # parameter.
 447   function replace_pattern_in_file()
 448   {
 449     local file="$1"; shift
 450     local pattern="$1"; shift
 451     local replacement="$1"; shift
 452     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
 453       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
 454       echo "text to replace that pattern with."
 455       return 1
 456     fi
 457     sed -i -e "s%$pattern%$replacement%g" "$file"
 458   }
 459
 460   # goes to a particular directory passed as parameter 1, and then removes all
 461   # the parameters after that from that directory.
 462   function push_whack_pop()
 463   {
 464     local dir="$1"; shift
 465     pushd "$dir" &>/dev/null
 466     rm -rf $* &>/dev/null
 467     popd &>/dev/null
 468   }
 469
 470   function spacem()
 471   {
 472     while [ $# -gt 0 ]; do
 473       arg="$1"; shift
 474       if [ ! -f "$arg" -a ! -d "$arg" ]; then
 475         echo "failure to find a file or directory named '$arg'."
 476         continue
 477       fi
 478
 479       # first we will capture the output of the character replacement operation for reporting.
 480       # this is done first since some filenames can't be properly renamed in perl (e.g. if they
 481       # have pipe characters apparently).
 482       intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
 483       local saw_intermediate_result=0
 484       if [ -z "$intermediate_name" ]; then
 485         # make sure we report something, if there are no further name changes.
 486         intermediate_name="'$arg'"
 487       else
 488         # now zap the first part of the name off (since original name isn't needed).
 489         intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
 490         saw_intermediate_result=1
 491       fi
 492
 493       # first we rename the file to be lower case.
 494       actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
 495       final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
 496       local saw_final_result=0
 497       if [ -z "$final_name" ]; then
 498         final_name="$intermediate_name"
 499       else
 500         final_name="$(echo $final_name | sed -e 's/.*=> //')"
 501         saw_final_result=1
 502       fi
 503 #echo intermed=$saw_intermediate_result
 504 #echo final=$saw_final_result
 505
 506       if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
 507         # printout the combined operation results.
 508         echo "'$arg' => $final_name"
 509       fi
 510     done
 511   }
 512
 513   ##############
 514
 515 # new breed of definer functions goes here.  still in progress.
 516
 517   # defines an alias and remembers that this is a new or modified definition.
 518   # if the feisty meow codebase is unloaded, then so are all the aliases that
 519   # were defined.
 520   function define_yeti_alias()
 521   {
 522 # if alias exists already, save old value for restore,
 523 # otherwise save null value for restore,
 524 # have to handle unaliasing if there was no prior value of one
 525 # we newly defined.
 526 # add alias name to a list of feisty defined aliases.
 527
 528 #hmmm: first implem, just do the alias and get that working...
 529 alias "${@}"
 530
 531
 532 return 0
 533   }
 534
 535   # defines a variable within the feisty meow environment and remembers that
 536   # this is a new or modified definition.  if the feisty meow codebase is
 537   # unloaded, then so are all the variables that were defined.
 538   # this function always exports the variables it defines.
 539 #  function define_yeti_variable()
 540 #  {
 541 ## if variable exists already, save old value for restore,
 542 ## otherwise save null value for restore,
 543 ## have to handle unsetting if there was no prior value of one
 544 ## we newly defined.
 545 ## add variable name to a list of feisty defined variables.
 546 #
 547 ##hmmm: first implem just sets it up and exports the variable.
 548 ##  i.e., this method always exports.
 549 #export "${@}"
 550 #
 551 #
 552 #return 0
 553 #  }
 554
 555   ##############
 556
 557   # just shows a separator line for an 80 column console, or uses the first
 558   # parameter as the number of columns to expect.
 559   function separator()
 560   {
 561     count=$1; shift
 562     if [ -z "$count" ]; then
 563       count=79
 564     fi
 565     echo
 566     local i
 567     for ((i=0; i < $count - 1; i++)); do
 568       echo -n "="
 569     done
 570     echo
 571     echo
 572   }
 573   # alias for separator.
 574   function sep()
 575   {
 576     separator $*
 577   }
 578
 579   ##############
 580
 581   function function_sentinel() { return 0; }
 582
 583   if [ ! -z "$SHELL_DEBUG" ]; then echo "feisty meow function definitions done."; fi
 584
 585   ##############
 586
 587   # test code for set_var_if_undefined.
 588   run_test=0
 589   if [ $run_test != 0 ]; then
 590     echo running tests on set_var_if_undefined.
 591     flagrant=petunia
 592     set_var_if_undefined flagrant forknordle
 593     check_result "testing if defined variable would be whacked"
 594     if [ $flagrant != petunia ]; then
 595       echo set_var_if_undefined failed to leave the test variable alone
 596       exit 1
 597     fi
 598     unset bobblehead_stomper
 599     set_var_if_undefined bobblehead_stomper endurance
 600     if [ $bobblehead_stomper != endurance ]; then
 601       echo set_var_if_undefined failed to set a variable that was not defined yet
 602       exit 1
 603     fi
 604   fi
 605
 606 fi
 607