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