scripts/core/functions.sh

   1 #!/bin/bash
   2
   3 # This defines some general, useful functions.
   4
   5 #hmmm: starting to get a bit beefy in here.  perhaps there is a good way to refactor the functions into more specific folders, if they aren't really totally general purpose?
   6
   7 ##############
   8
   9 # test whether we've been here before or not.
  10 skip_all=
  11 type function_sentinel &>/dev/null
  12 if [ $? -eq 0 ]; then
  13   # there was no error, so we can skip the inits.
  14   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  15     echo "skipping function definitions, because already defined."
  16   fi
  17   skip_all=yes
  18 else
  19   skip_all=
  20 fi
  21
  22 if [ -z "$skip_all" ]; then
  23
  24   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
  25     echo "feisty meow function definitions beginning now..."
  26   fi
  27
  28   # a handy little method that can be used for date strings.  it was getting
  29   # really tiresome how many different ways the script did the date formatting.
  30   function date_stringer() {
  31     local sep="$1"; shift
  32     if [ -z "$sep" ]; then sep='_'; fi
  33     date +"%Y$sep%m$sep%d$sep%H%M$sep%S" | tr -d '/\n/'
  34   }
  35
  36   # makes a directory of the name specified and then tries to change the
  37   # current directory to that directory.
  38   function mcd() {
  39     if [ ! -d "$1" ]; then mkdir -p "$1"; fi
  40     cd "$1"
  41   }
  42
  43   # returns true if the variable is an array.
  44   function is_array() {
  45     [[ "$(declare -p $1)" =~ "declare -a" ]]
  46   }
  47
  48   # returns true if the name provided is a defined alias.
  49   function is_alias() {
  50     alias $1 &>/dev/null
  51     return $?
  52   }
  53
  54   # makes the status of pipe number N (passed as first parameter) into the
  55   # main return value (i.e., the value for $?).  this is super handy to avoid
  56   # repeating the awkward looking code below in multiple places.
  57   function promote_pipe_return()
  58   {
  59     ( exit ${PIPESTATUS[$1]} )
  60   }
  61
  62   ##############
  63
  64   # displays the value of a variable in bash friendly format.
  65   function var() {
  66     HOLDIFS="$IFS"
  67     IFS=""
  68     while true; do
  69       local varname="$1"; shift
  70       if [ -z "$varname" ]; then
  71         break
  72       fi
  73
  74       if is_alias "$varname"; then
  75 #echo found $varname is alias
  76         local tmpfile="$(mktemp $TMP/aliasout.XXXXXX)"
  77         alias $varname | sed -e 's/.*=//' >$tmpfile
  78         echo "alias $varname=$(cat $tmpfile)"
  79         \rm $tmpfile
  80       elif [ -z "${!varname}" ]; then
  81         echo "$varname undefined"
  82       else
  83         if is_array "$varname"; then
  84 #echo found $varname is array var
  85           local temparray
  86           eval temparray="(\${$varname[@]})"
  87           echo "$varname=(${temparray[@]})"
  88 #hmmm: would be nice to print above with elements enclosed in quotes, so that we can properly
  89 # see ones that have spaces in them.
  90         else
  91 #echo found $varname is simple
  92           echo "$varname=${!varname}"
  93         fi
  94       fi
  95     done | sort
  96     IFS="$HOLDIFS"
  97   }
  98
  99   ##############
 100
 101   # when passed a list of things, this will return the unique items from that list as an echo.
 102   function uniquify()
 103   {
 104     # do the uniquification: split the space separated items into separate lines, then
 105     # sort the list, then run the uniq tool on the list.  results will be packed back onto
 106     # one line when invoked like: local fredlist="$(uniquify a b c e d a e f a e d b)"
 107     echo $* | tr ' ' '\n' | sort | uniq
 108   }
 109
 110   # sets the variable in parameter 1 to the value in parameter 2, but only if
 111   # that variable was undefined.
 112   function set_var_if_undefined()
 113   {
 114     local var_name="$1"; shift
 115     local var_value="$1"; shift
 116     if [ -z "${!var_name}" ]; then
 117       eval export $var_name="$var_value"
 118     fi
 119   }
 120
 121   ##############
 122
 123   function success_sound()
 124   {
 125     if [ ! -z "$CLAM_FINISH_SOUND" ]; then
 126       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_FINISH_SOUND"
 127     fi
 128   }
 129
 130   function error_sound()
 131   {
 132     if [ ! -z "$CLAM_ERROR_SOUND" ]; then
 133       bash $FEISTY_MEOW_SCRIPTS/multimedia/sound_play.sh "$CLAM_ERROR_SOUND"
 134     fi
 135   }
 136
 137   ##############
 138
 139   # echoes the maximum number of columns that the terminal supports.  usually
 140   # anything you print to the terminal with length less than (but not equal to)
 141   # maxcols will never wrap.
 142   function get_maxcols()
 143   {
 144     # calculate the number of columsn in the terminal.
 145     local cols=$(stty size | awk '{print $2}')
 146     echo $cols
 147   }
 148
 149   ##############
 150
 151   # checks the result of the last command that was run, and if that failed,
 152   # then this complains and exits from bash.  the function parameters are
 153   # used as the message to print as a complaint.
 154   function exit_on_error()
 155   {
 156     if [ $? -ne 0 ]; then
 157       echo -e "\n\nan important action failed and this script will stop:\n\n$*\n\n*** Exiting script..."
 158       error_sound
 159       exit 1
 160     fi
 161   }
 162
 163   # like exit_on_error, but will keep going after complaining.
 164   function continue_on_error()
 165   {
 166     if [ $? -ne 0 ]; then
 167       echo -e "\n\na problem occurred, but we can continue:\n\n$*\n\n=> Continuing script..."
 168       error_sound
 169     fi
 170   }
 171
 172   ##############
 173
 174   # accepts any number of arguments and outputs them to the feisty meow event log.
 175   function log_feisty_meow_event()
 176   {
 177     echo -e "$(date_stringer) -- ${USER}@$(hostname): $*" >> "$FEISTY_MEOW_EVENT_LOG"
 178   }
 179
 180   ##############
 181
 182   # wraps secure shell with some parameters we like, most importantly to enable X forwarding.
 183   function ssh()
 184   {
 185     local args=($*)
 186     # we remember the old terminal title, then force the TERM variable to a more generic
 187     # version for the other side (just 'linux'); we don't want the remote side still
 188     # thinking it's running xterm.
 189     save_terminal_title
 190     if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
 191       echo TERM saved is: $PRIOR_TERMINAL_TITLE
 192     fi
 193 #hmmm: why were we doing this?  it scorches the user's logged in session, leaving it without proper terminal handling.
 194 #    # we save the value of TERM; we don't want to leave the user's terminal
 195 #    # brain dead once we come back from this function.
 196 #    local oldterm="$TERM"
 197 #    export TERM=linux
 198     /usr/bin/ssh -X -C "${args[@]}"
 199 #    # restore the terminal variable also.
 200 #    TERM="$oldterm"
 201     if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
 202       echo TERM before restore, will use prior title of: $PRIOR_TERMINAL_TITLE
 203     fi
 204     restore_terminal_title
 205     if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then
 206       echo TERM title restored to prior value
 207     fi
 208   }
 209
 210   ##############
 211
 212   # locates a process given a search pattern to match in the process list.
 213   # supports a single command line flag style parameter of "-u USERNAME";
 214   # if the -u flag is found, a username is expected afterwards, and only the
 215   # processes of that user are considered.
 216   function psfind() {
 217     local -a patterns=("${@}")
 218 #echo ====
 219 #echo patterns list is: "${patterns[@]}"
 220 #echo ====
 221
 222     local user_flag
 223     if [ "${patterns[0]}" == "-u" ]; then
 224       user_flag="-u ${patterns[1]}"
 225 #echo "found a -u parm and user=${patterns[1]}"
 226       # void the two elements with that user flag so we don't use them as patterns.
 227       unset patterns[0] patterns[1]=
 228     else
 229       # select all users.
 230       user_flag="-e"
 231     fi
 232
 233     local PID_DUMP="$(mktemp "$TMP/zz_pidlist.XXXXXX")"
 234     local -a PIDS_SOUGHT
 235
 236     if [ "$OS" == "Windows_NT" ]; then
 237       # gets cygwin's (god awful) ps to show windoze processes also.
 238       local EXTRA_DOZER_FLAGS="-W"
 239       # pattern to use for peeling off the process numbers.
 240       local pid_finder_pattern='s/ *\([0-9][0-9]*\) *.*$/\1/p'
 241
 242     else
 243       # flags which clean up the process listing output on unixes.
 244       # apparently cygwin doesn't count as a type of unix, because their
 245       # crummy specialized ps command doesn't support normal ps flags.
 246       local EXTRA_UNIX_FLAGS="-o pid,args"
 247       # pattern to use for peeling off the process numbers.
 248       local pid_finder_pattern='s/^[[:space:]]*\([0-9][0-9]*\).*$/\1/p'
 249     fi
 250
 251     /bin/ps $EXTRA_DOZER_FLAGS $EXTRA_UNIX_FLAGS $user_flag | tail -n +2 >$PID_DUMP
 252 #echo ====
 253 #echo got all this stuff in the pid dump file:
 254 #cat $PID_DUMP
 255 #echo ====
 256
 257     # search for the pattern the user wants to find, and just pluck the process
 258     # ids out of the results.
 259     local i
 260     for i in "${patterns[@]}"; do
 261       PIDS_SOUGHT+=($(cat $PID_DUMP \
 262         | grep -i "$i" \
 263         | sed -n -e "$pid_finder_pattern"))
 264     done
 265 #echo ====
 266 #echo pids sought list became:
 267 #echo "${PIDS_SOUGHT[@]}"
 268 #echo ====
 269
 270     if [ ${#PIDS_SOUGHT[*]} -ne 0 ]; then
 271       local PIDS_SOUGHT2=$(printf -- '%s\n' ${PIDS_SOUGHT[@]} | sort | uniq)
 272       PIDS_SOUGHT=()
 273       PIDS_SOUGHT=${PIDS_SOUGHT2[*]}
 274       echo ${PIDS_SOUGHT[*]}
 275     fi
 276     /bin/rm $PID_DUMP
 277   }
 278
 279   # finds all processes matching the pattern specified and shows their full
 280   # process listing (whereas psfind just lists process ids).
 281   function psa() {
 282     if [ -z "$1" ]; then
 283       echo "psa finds processes by pattern, but there was no pattern on the command line."
 284       return 1
 285     fi
 286     local -a patterns=("${@}")
 287     p=$(psfind "${patterns[@]}")
 288     if [ -z "$p" ]; then
 289       # no matches.
 290       return 0
 291     fi
 292
 293     if [ "${patterns[0]}" == "-u" ]; then
 294       # void the two elements with that user flag so we don't use them as patterns.
 295       unset patterns[0] patterns[1]=
 296     fi
 297
 298     echo ""
 299     echo "Processes matching ${patterns[@]}..."
 300     echo ""
 301     if [ -n "$IS_DARWIN" ]; then
 302       unset fuzil_sentinel
 303       for i in $p; do
 304         # only print the header the first time.
 305         if [ -z "$fuzil_sentinel" ]; then
 306           ps $i -w -u
 307         else
 308           ps $i -w -u | sed -e '1d'
 309         fi
 310         fuzil_sentinel=true
 311       done
 312     else
 313       # cases besides mac os x's darwin.
 314       if [ "$OS" == "Windows_NT" ]; then
 315         # special case for windows.
 316         ps | head -1
 317         for curr in $p; do
 318           ps -W -p $curr | tail -n +2
 319         done
 320       else
 321         # normal OSes can handle a nice simple query.
 322         ps wu $p
 323       fi
 324     fi
 325   }
 326
 327   ##############
 328
 329 #hmmm: holy crowbars, this is an old one.  do we ever still have any need of it?
 330   # an unfortunately similarly named function to the above 'ps' as in process
 331   # methods, but this 'ps' stands for postscript.  this takes a postscript file
 332   # and converts it into pcl3 printer language and then ships it to the printer.
 333   # this mostly makes sense for an environment where one's default printer is
 334   # pcl.  if the input postscript causes ghostscript to bomb out, there has been
 335   # some good success running ps2ps on the input file and using the cleaned
 336   # postscript file for printing.
 337   function ps2pcl2lpr() {
 338     for $i in $*; do
 339       gs -sDEVICE=pcl3 -sOutputFile=- -sPAPERSIZE=letter "$i" | lpr -l
 340     done
 341   }
 342
 343 #hmmm: not really doing anything yet; ubuntu seems to have changed from pulseaudio in 17.04?
 344   # restarts the sound driver.
 345   function fix_sound_driver() {
 346     # stop bash complaining about blank function body.
 347     local nothing=
 348 #if alsa something
 349 #    sudo service alsasound restart
 350 #elif pulse something
 351 #    sudo pulseaudio -k
 352 #    sudo pulseaudio -D
 353 #else
 354 #    something else...?
 355 #fi
 356
 357   }
 358
 359   function screen() {
 360     save_terminal_title
 361 #hmmm: ugly absolute path here.
 362     /usr/bin/screen $*
 363     restore_terminal_title
 364   }
 365
 366   # switches from a /X/path form to an X:/ form.  this also processes cygwin paths.
 367   function unix_to_dos_path() {
 368     # we usually remove dos slashes in favor of forward slashes.
 369     local DOSSYHOME
 370     if [[ ! "$OS" =~ ^[Ww][iI][nN] ]]; then
 371       # fake this value for non-windows (non-cygwin) platforms.
 372       DOSSYHOME="$HOME"
 373     else
 374       # for cygwin, we must replace the /home/X path with an absolute one, since cygwin
 375       # insists on the /home form instead of /c/cygwin/home being possible.  this is
 376       # super frustrating and nightmarish.
 377       DOSSYHOME="$(cygpath -am "$HOME")"
 378     fi
 379
 380     if [ ! -z "$SERIOUS_SLASH_TREATMENT" ]; then
 381       # unless this flag is set, in which case we force dos slashes.
 382       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'
 383     else
 384       echo "$1" | sed -e "s?^$HOME?$DOSSYHOME?g" | sed -e 's/\\/\//g' | sed -e 's/\/cygdrive//' | sed -e 's/\/\([a-zA-Z]\)\/\(.*\)/\1:\/\2/'
 385     fi
 386   }
 387
 388   # switches from an X:/ form to a /cygdrive/X/path form.  this is only useful
 389   # for the cygwin environment currently.
 390   function dos_to_unix_path() {
 391     # we always remove dos slashes in favor of forward slashes.
 392 #old:    echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/\1\/\2/'
 393          echo "$1" | sed -e 's/\\/\//g' | sed -e 's/\([a-zA-Z]\):\/\(.*\)/\/cygdrive\/\1\/\2/'
 394   }
 395
 396   # returns a successful value (0) if this system is debian or ubuntu.
 397   function debian_like() {
 398     # decide if we think this is debian or ubuntu or a variant.
 399     DEBIAN_LIKE=$(if [ ! -z "$(grep -i debian /etc/issue)" \
 400         -o ! -z "$(grep -i ubuntu /etc/issue)" ]; then echo 1; else echo 0; fi)
 401     if [ $DEBIAN_LIKE -eq 1 ]; then
 402       # success; this is debianish.
 403       return 0
 404     else
 405       # this seems like some other OS.
 406       return 1
 407     fi
 408   }
 409
 410   # su function: makes su perform a login.
 411   # for some OSes, this transfers the X authority information to the new login.
 412   function su() {
 413     if debian_like; then
 414       # debian currently requires the full version which imports X authority
 415       # information for su.
 416
 417       # get the x authority info for our current user.
 418       source "$FEISTY_MEOW_SCRIPTS/security/get_x_auth.sh"
 419
 420       if [ -z "$X_auth_info" ]; then
 421         # if there's no authentication info to pass along, we just do a normal su.
 422         /bin/su -l $*
 423       else
 424         # under X, we update the new login's authority info with the previous
 425         # user's info.
 426         (unset XAUTHORITY; /bin/su -l $* -c "$X_auth_info ; export DISPLAY=$DISPLAY ; bash")
 427       fi
 428     else
 429       # non-debian supposedly doesn't need the extra overhead any more.
 430       # or at least suse doesn't, which is the other one we've tested on.
 431       /bin/su -l $*
 432     fi
 433   }
 434
 435   # sudo function wraps the normal sudo by ensuring we replace the terminal
 436   # label if they're doing an su with the sudo.
 437   function sudo() {
 438     save_terminal_title
 439     /usr/bin/sudo "$@"
 440     retval=$?
 441     restore_terminal_title
 442 #    if [ "$first_command" == "su" ]; then
 443 #      # yep, they were doing an su, but they're back now.
 444 #      label_terminal_with_info
 445 #    fi
 446     return $retval
 447   }
 448
 449   # trashes the .#blah files that cvs and subversion leave behind when finding conflicts.
 450   # this kind of assumes you've already checked them for any salient facts.
 451   function clean_cvs_junk() {
 452     for i in $*; do
 453       find $i -follow -type f -iname ".#*" -exec perl $FEISTY_MEOW_SCRIPTS/files/safedel.pl {} ";"
 454     done
 455   }
 456
 457   # overlay for nechung binary so that we can complain less grossly about it when it's missing.
 458   function nechung() {
 459     local wheres_nechung=$(which nechung 2>/dev/null)
 460     if [ -z "$wheres_nechung" ]; then
 461       echo "The nechung oracle program cannot be found.  You may want to consider"
 462       echo "rebuilding the feisty meow applications with this command:"
 463       echo "bash $FEISTY_MEOW_SCRIPTS/generator/produce_feisty_meow.sh"
 464       echo
 465     else
 466       $wheres_nechung
 467     fi
 468   }
 469
 470   # recreates all the generated files that the feisty meow scripts use.
 471   function regenerate() {
 472     # do the bootstrapping process again.
 473     save_terminal_title
 474     echo "regenerating feisty meow script environment."
 475     bash $FEISTY_MEOW_SCRIPTS/core/reconfigure_feisty_meow.sh
 476     echo
 477     # force a full reload by turning off sentinel variables and methods.
 478     unset -v CORE_VARIABLES_LOADED FEISTY_MEOW_LOADING_DOCK USER_CUSTOMIZATIONS_LOADED
 479     unalias CORE_ALIASES_LOADED &>/dev/null
 480     unset -f function_sentinel
 481     # reload feisty meow environment in current shell.
 482     log_feisty_meow_event "reloading the feisty meow scripts for $USER in current shell."
 483     source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
 484     # run nechung oracle to give user a new fortune.
 485     nechung
 486     restore_terminal_title
 487   }
 488
 489   # copies a set of custom scripts into the proper location for feisty meow
 490   # to merge their functions and aliases with the standard set.
 491   function recustomize()
 492   {
 493     local custom_user="$1"; shift
 494     if [ -z "$custom_user" ]; then
 495       # default to login name if there was no name provided.
 496       custom_user="$(logname)"
 497         # we do intend to use logname here to get the login name and to ignore
 498         # if the user has sudo root access; we don't want to provide a custom
 499         # profile for root.
 500     fi
 501
 502     save_terminal_title
 503
 504     if [ ! -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" ]; then
 505       echo -e "the customization folder for '$custom_user' is missing:
 506
 507     $FEISTY_MEOW_SCRIPTS/customize/$custom_user
 508
 509 we will skip recustomization, but these other customizations are available:
 510 "
 511       # a little tr and sed magic to fix the carriage returns into commas.
 512       local line="$(find $FEISTY_MEOW_SCRIPTS/customize -mindepth 1 -maxdepth 1 -type d -exec basename {} ';' | tr '\n' '&' | sed 's/&/, /g' | sed -e 's/, $//')"
 513         # make the line feeds and carriage returns manageable with tr.
 514         # convert the ampersand, our weird replacement for EOL, with a comma + space in sed.
 515         # last touch with sed removes the last comma.
 516       echo "    $line"
 517       return 1
 518     fi
 519
 520     # prevent permission foul-ups.
 521     my_user="$USER"
 522       # here we definitely want the effective user name (in USER), since
 523       # we don't want, say, fred (as logname) to own all of root's loading
 524       # dock stuff.
 525     chown -R "$my_user:$my_user" \
 526         "$FEISTY_MEOW_LOADING_DOCK"/* "$FEISTY_MEOW_GENERATED_STORE"/* 2>/dev/null
 527     continue_on_error "chowning feisty meow generated directories to $my_user"
 528
 529     regenerate >/dev/null
 530     pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null
 531     incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom")"
 532
 533     local fail_message="\n
 534 are the perl dependencies installed?  if you're on ubuntu or debian, try this:\n
 535     $(grep "apt.*perl" $FEISTY_MEOW_APEX/readme.txt)\n
 536 or if you're on cygwin, then try this (if apt-cyg is available):\n
 537     $(grep "apt-cyg.*perl" $FEISTY_MEOW_APEX/readme.txt)\n";
 538
 539     #echo "the incongruous files list is: $incongruous_files"
 540     # disallow a single character result, since we get "*" as result when nothing exists yet.
 541     if [ ${#incongruous_files} -ge 2 ]; then
 542       log_feisty_meow_event "cleaning unknown older overrides..."
 543       perl "$FEISTY_MEOW_SCRIPTS/files/safedel.pl" $incongruous_files
 544       continue_on_error "running safedel.  $fail_message"
 545     fi
 546     popd &>/dev/null
 547     log_feisty_meow_event "copying custom overrides for $custom_user"
 548     mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null
 549     perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_SCRIPTS/customize/$custom_user" "$FEISTY_MEOW_LOADING_DOCK/custom"
 550     continue_on_error "running cpdiff.  $fail_message"
 551
 552     if [ -d "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" ]; then
 553       log_feisty_meow_event "copying custom scripts for $custom_user"
 554 #hmmm: could save output to show if an error occurs.
 555       rsync -avz "$FEISTY_MEOW_SCRIPTS/customize/$custom_user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" &>/dev/null
 556       continue_on_error "copying customization scripts"
 557     fi
 558     regenerate
 559
 560     # prevent permission foul-ups, again.
 561     chown -R "$my_user:$my_user" \
 562         "$FEISTY_MEOW_LOADING_DOCK" "$FEISTY_MEOW_GENERATED_STORE" 2>/dev/null
 563     continue_on_error "once more chowning feisty meow generated directories to $my_user"
 564
 565     restore_terminal_title
 566   }
 567
 568   # generates a random password where the first parameter is the number of characters
 569   # in the password (default 20) and the second parameter specifies whether to use
 570   # special characters (1) or not (0).
 571   # found function at http://legroom.net/2010/05/06/bash-random-password-generator
 572   function random_password()
 573   {
 574     [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
 575     cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-32}
 576     echo
 577   }
 578
 579   # a wrapper for the which command that finds items on the path.  some OSes
 580   # do not provide which, so we want to not be spewing errors when that
 581   # happens.
 582   function whichable()
 583   {
 584     to_find="$1"; shift
 585     which which &>/dev/null
 586     if [ $? -ne 0 ]; then
 587       # there is no which command here.  we produce nothing due to this.
 588       echo
 589     fi
 590     echo $(which $to_find)
 591   }
 592
 593   function add_cygwin_drive_mounts() {
 594     for i in c d e f g h q z ; do
 595 #hmmm: improve this by not adding the link if already there, or if the drive is not valid.
 596       ln -s /cygdrive/$i $i
 597     done
 598   }
 599
 600   ############################
 601
 602   # takes a file to modify, and then it will replace any occurrences of the
 603   # pattern provided as the second parameter with the text in the third
 604   # parameter.
 605   function replace_pattern_in_file()
 606   {
 607     local file="$1"; shift
 608     local pattern="$1"; shift
 609     local replacement="$1"; shift
 610     if [ -z "$file" -o -z "$pattern" -o -z "$replacement" ]; then
 611       echo "replace_pattern_in_file: needs a filename, a pattern to replace, and the"
 612       echo "text to replace that pattern with."
 613       return 1
 614     fi
 615     sed -i -e "s%$pattern%$replacement%g" "$file"
 616   }
 617
 618   # similar to replace_pattern_in_file, but also will add the new value
 619   # when the old one did not already exist in the file.
 620   function replace_if_exists_or_add()
 621   {
 622     local file="$1"; shift
 623     local phrase="$1"; shift
 624     local replacement="$1"; shift
 625     if [ -z "$file" -o ! -f "$file" -o -z "$phrase" -o -z "$replacement" ]; then
 626       echo "replace_if_exists_or_add: needs a filename, a phrase to replace, and the"
 627       echo "text to replace that phrase with."
 628       return 1
 629     fi
 630     grep "$phrase" "$file" >/dev/null
 631     # replace if the phrase is there, otherwise add it.
 632     if [ $? -eq 0 ]; then
 633       replace_pattern_in_file "$file" "$phrase" "$replacement"
 634     else
 635       # this had better be the complete line.
 636       echo "$replacement" >>"$file"
 637     fi
 638   }
 639
 640   ############################
 641
 642   # finds a variable (first parameter) in a particular property file
 643   # (second parameter).  the expected format for the file is:
 644   # varX=valueX
 645   function seek_variable()
 646   {
 647     local find_var="$1"; shift
 648     local file="$1"; shift
 649     if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
 650       echo -e "seek_variable: needs two parameters, firstly a variable name, and\nsecondly a file where the variable's value will be sought." 1>&2
 651       return 1
 652     fi
 653
 654     while read line; do
 655       if [ ${#line} -eq 0 ]; then continue; fi
 656       # split the line into the variable name and value.
 657       IFS='=' read -a assignment <<< "$line"
 658       local var="${assignment[0]}"
 659       local value="${assignment[1]}"
 660       if [ "${value:0:1}" == '"' ]; then
 661         # assume the entry was in quotes and remove them.
 662         value="${value:1:$((${#value} - 2))}"
 663       fi
 664       if [ "$find_var" == "$var" ]; then
 665         echo "$value"
 666       fi
 667     done < "$file"
 668   }
 669
 670   # finds a variable (first parameter) in a particular XML format file
 671   # (second parameter).  the expected format for the file is:
 672   # ... name="varX" value="valueX" ...
 673   function seek_variable_in_xml()
 674   {
 675     local find_var="$1"; shift
 676     local file="$1"; shift
 677     if [ -z "$find_var" -o -z "$file" -o ! -f "$file" ]; then
 678       echo "seek_variable_in_xml: needs two parameters, firstly a variable name, and"
 679       echo "secondly an XML file where the variable's value will be sought."
 680       return 1
 681     fi
 682
 683     while read line; do
 684       if [ ${#line} -eq 0 ]; then continue; fi
 685       # process the line to make it more conventional looking.
 686       line="$(echo "$line" | sed -e 's/.*name="\([^"]*\)" value="\([^"]*\)"/\1=\2/')"
 687       # split the line into the variable name and value.
 688       IFS='=' read -a assignment <<< "$line"
 689       local var="${assignment[0]}"
 690       local value="${assignment[1]}"
 691       if [ "${value:0:1}" == '"' ]; then
 692         # assume the entry was in quotes and remove them.
 693         value="${value:1:$((${#value} - 2))}"
 694       fi
 695       if [ "$find_var" == "$var" ]; then
 696         echo "$value"
 697       fi
 698     done < "$file"
 699   }
 700
 701   ############################
 702
 703   # goes to a particular directory passed as parameter 1, and then removes all
 704   # the parameters after that from that directory.
 705   function push_whack_pop()
 706   {
 707     local dir="$1"; shift
 708     pushd "$dir" &>/dev/null
 709     if [ $? -ne 0 ]; then echo failed to enter dir--quitting.; fi
 710     rm -rf $* &>/dev/null
 711     if [ $? -ne 0 ]; then echo received a failure code when removing.; fi
 712     popd &>/dev/null
 713   }
 714
 715   function spacem()
 716   {
 717     while [ $# -gt 0 ]; do
 718       arg="$1"; shift
 719       if [ ! -f "$arg" -a ! -d "$arg" ]; then
 720         echo "=> did not find a file or directory named '$arg'."
 721         continue
 722       fi
 723
 724       # first we will capture the output of the character replacement operation for reporting.
 725       # this is done first since some filenames can't be properly renamed in perl (e.g. if they
 726       # have pipe characters apparently).
 727       intermediate_name="$(bash "$FEISTY_MEOW_SCRIPTS/files/replace_spaces_with_underscores.sh" "$arg")"
 728       local saw_intermediate_result=0
 729       if [ -z "$intermediate_name" ]; then
 730         # make sure we report something, if there are no further name changes.
 731         intermediate_name="'$arg'"
 732       else
 733         # now zap the first part of the name off (since original name isn't needed).
 734         intermediate_name="$(echo $intermediate_name | sed -e 's/.*=> //')"
 735         saw_intermediate_result=1
 736       fi
 737
 738       # first we rename the file to be lower case.
 739       actual_file="$(echo $intermediate_name | sed -e "s/'\([^']*\)'/\1/")"
 740       final_name="$(perl $FEISTY_MEOW_SCRIPTS/files/renlower.pl "$actual_file")"
 741       local saw_final_result=0
 742       if [ -z "$final_name" ]; then
 743         final_name="$intermediate_name"
 744       else
 745         final_name="$(echo $final_name | sed -e 's/.*=> //')"
 746         saw_final_result=1
 747       fi
 748 #echo intermed=$saw_intermediate_result
 749 #echo final=$saw_final_result
 750
 751       if [[ $saw_intermediate_result != 0 || $saw_final_result != 0 ]]; then
 752         # printout the combined operation results.
 753         echo "'$arg' => $final_name"
 754       fi
 755     done
 756   }
 757
 758   ##############
 759
 760 # new breed of definer functions goes here.  still in progress.
 761
 762   # defines an alias and remembers that this is a new or modified definition.
 763   # if the feisty meow codebase is unloaded, then so are all the aliases that
 764   # were defined.
 765   function define_yeti_alias()
 766   {
 767 # if alias exists already, save old value for restore,
 768 # otherwise save null value for restore,
 769 # have to handle unaliasing if there was no prior value of one
 770 # we newly defined.
 771 # add alias name to a list of feisty defined aliases.
 772
 773 #hmmm: first implem, just do the alias and get that working...
 774 alias "${@}"
 775
 776
 777 return 0
 778   }
 779
 780   ##############
 781
 782 #hmmm: this points to an extended functions file being needed; not all of these are core.
 783
 784   # displays documentation in "md" formatted files.
 785   function show_md()
 786   {
 787     local file="$1"; shift
 788     pandoc "$file" | lynx -stdin
 789   }
 790
 791   ##############
 792
 793   # just shows a separator line for an 80 column console, or uses the first
 794   # parameter as the number of columns to expect.
 795   function separator()
 796   {
 797     count=$1; shift
 798     if [ -z "$count" ]; then
 799       count=79
 800     fi
 801     echo
 802     local i
 803     for ((i=0; i < $count - 1; i++)); do
 804       echo -n "="
 805     done
 806     echo
 807     echo
 808   }
 809   # alias for separator.
 810   function sep()
 811   {
 812     separator $*
 813   }
 814
 815   ##############
 816
 817   # count the number of sub-directories in a directory and echo the result.
 818   function count_directories()
 819   {
 820     local subbydir="$1"; shift
 821     numdirs="$(find "$subbydir" -mindepth 1 -maxdepth 1 -type d | wc -l)"
 822     echo $numdirs
 823   }
 824
 825   # takes a string and capitalizes just the first character.  any capital letters in the remainder of
 826   # the string are made lower case.  the processed string is returned by an echo.
 827   function capitalize_first_char()
 828   {
 829     local to_dromedary="$1"; shift
 830     to_dromedary="$(tr '[:lower:]' '[:upper:]' <<< ${to_dromedary:0:1})$(tr '[:upper:]' '[:lower:]' <<< ${to_dromedary:1})"
 831     echo "$to_dromedary"
 832   }
 833
 834   # given a source path and a target path, this will make a symbolic link from
 835   # the source to the destination, but only if the source actually exists.
 836   function make_safe_link()
 837   {
 838     local src="$1"; shift
 839     local target="$1"; shift
 840
 841     if [ -d "$src" ]; then
 842       ln -s "$src" "$target"
 843       exit_on_error "Creating symlink from '$src' to '$target'"
 844     fi
 845     echo "Created symlink from '$src' to '$target'."
 846   }
 847
 848   # pretty prints the json files provided as parameters.
 849   function clean_json()
 850   {
 851     if [ -z "$*" ]; then return; fi
 852     local show_list=()
 853     while true; do
 854       local file="$1"; shift
 855       if [ -z "$file" ]; then break; fi
 856       if [ ! -f "$file" ]; then "echo File '$file' does not exist."; continue; fi
 857       temp_out="$TMP/$file.view"
 858       cat "$file" | python -m json.tool > "$temp_out"
 859       show_list+=($temp_out)
 860       continue_on_error "pretty printing '$file'"
 861     done
 862     filedump "${show_list[@]}"
 863     rm "${show_list[@]}"
 864   }
 865
 866   function json_text()
 867   {
 868     # only print our special headers or text fields.
 869     local CR=$'\r'
 870     local LF=$'\n'
 871     clean_json $* |
 872         grep -i "\"text\":\|^=.*" |
 873         sed -e "s/\\\\r/$CR/g" -e "s/\\\\n/\\$LF/g"
 874   }
 875
 876   ##############
 877
 878   # echoes the machine's hostname.  can be used like so:
 879   #   local my_host=$(get_hostname)
 880   function get_hostname()
 881   {
 882     # there used to be more variation in how to do this, but adopting mingw
 883     # and cygwin tools really helped out.
 884     local this_host=unknown
 885     if [ "$OS" == "Windows_NT" ]; then
 886       this_host=$(hostname)
 887     elif [ ! -z "$(echo $MACHTYPE | grep apple)" ]; then
 888       this_host=$(hostname)
 889     elif [ ! -z "$(echo $MACHTYPE | grep suse)" ]; then
 890       this_host=$(hostname --long)
 891     elif [ -x "$(which hostname 2>/dev/null)" ]; then
 892       this_host=$(hostname)
 893     fi
 894     echo "$this_host"
 895   }
 896
 897   # makes sure that the provided "folder" is a directory and is writable.
 898   function test_writeable()
 899   {
 900     local folder="$1"; shift
 901     if [ ! -d "$folder" -o ! -w "$folder" ]; then return 1; fi
 902     return 0
 903   }
 904
 905   ##############
 906
 907   # given a filename and a string to seek and a number of lines, then this
 908   # function will remove the first occurrence of a line in the file that
 909   # matches the string, and it will also axe the next N lines as specified.
 910   function create_chomped_copy_of_file()
 911   {
 912     local filename="$1"; shift
 913     local seeker="$1"; shift
 914     local numlines=$1; shift
 915
 916 #echo into create_chomped_copy...
 917 #var filename seeker numlines
 918
 919     # make a backup first, oy.
 920     \cp -f "$filename" "/tmp/$(basename ${filename}).bkup-${RANDOM}"
 921     exit_on_error "backing up file: $filename"
 922
 923     # make a temp file to write to before we move file into place in bind.
 924     local new_version="/tmp/$(basename ${filename}).bkup-${RANDOM}"
 925     \rm -f "$new_version"
 926     exit_on_error "cleaning out new version of file from: $new_version"
 927
 928     local line
 929     local skip_count=0
 930     local found_any=
 931     while read line; do
 932       # don't bother looking at the lines if we're already in skip mode.
 933       if [[ $skip_count == 0 ]]; then
 934         # find the string they're seeking.
 935         if [[ ! "$line" =~ .*${seeker}.* ]]; then
 936           # no match.
 937           echo "$line" >> "$new_version"
 938         else
 939           # a match!  start skipping.  we will delete this line and the next N lines.
 940           ((skip_count++))
 941 #echo first skip count is now $skip_count
 942           found_any=yes
 943         fi
 944       else
 945         # we're already skipping.  let's keep going until we hit the limit.
 946         ((skip_count++))
 947 #echo ongoing skip count is now $skip_count
 948         if (( $skip_count > $numlines )); then
 949           echo "Done skipping, and back to writing output file."
 950           skip_count=0
 951         fi
 952       fi
 953     done < "$filename"
 954
 955 #echo file we created looks like this:
 956 #cat "$new_version"
 957
 958     if [ ! -z "$found_any" ]; then
 959       # put the file back into place under the original name.
 960       \mv "$new_version" "$filename"
 961       exit_on_error "moving the new version into place in: $filename"
 962     else
 963       # cannot always be considered an error, but we can at least gripe.
 964       echo "Did not find any matches for seeker '$seeker' in file: $filename"
 965     fi
 966   }
 967
 968   ##############
 969
 970   # site avenger aliases
 971   function switchto()
 972   {
 973     THISDIR="$FEISTY_MEOW_SCRIPTS/site_avenger"
 974     source "$FEISTY_MEOW_SCRIPTS/site_avenger/shared_site_mgr.sh"
 975     switch_to "$1"
 976   }
 977
 978   ##############
 979
 980   # NOTE: no more function definitions are allowed after this point.
 981
 982   function function_sentinel()
 983   {
 984     return 0;
 985   }
 986
 987   if [ ! -z "$DEBUG_FEISTY_MEOW" ]; then echo "feisty meow function definitions done."; fi
 988
 989   ##############
 990
 991   # test code for set_var_if_undefined.
 992   run_test=0
 993   if [ $run_test != 0 ]; then
 994     echo running tests on set_var_if_undefined.
 995     flagrant=petunia
 996     set_var_if_undefined flagrant forknordle
 997     exit_on_error "testing if defined variable would be whacked"
 998     if [ $flagrant != petunia ]; then
 999       echo set_var_if_undefined failed to leave the test variable alone
1000       exit 1
1001     fi
1002     unset bobblehead_stomper
1003     set_var_if_undefined bobblehead_stomper endurance
1004     if [ $bobblehead_stomper != endurance ]; then
1005       echo set_var_if_undefined failed to set a variable that was not defined yet
1006       exit 1
1007     fi
1008   fi
1009
1010 fi
1011