.bashrc

# shellcheck disable=1090,1091,2035,2154,2166
# ORIGINALLY ASSIMILATED FROM: *Last CVS Id: other.bashrc,v 1.14 2003/06/11 13:41:26 boyd Exp *
# Borg bashrc :: Resistance.sh is futile 8P
# Copyright © 2017 Steven Acres

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program; if not, see <http://www.gnu.org/licenses/>.

######################################################################
# COMMENTS & DOCUMENTATION {{{1
######################################################################
# NOTE!!!! Don't make changes to this file for a single machine. Use
# .bashrc.local. See "Local Customisations" below.
######################################################################
# General {{{2
######################################################################
# This file is designed on the assumption that bash is NOT our login
# shell. If it was then the env variable setting should be in the
# .bash_profile file, not the .bashrc. I've made a special effort to keep
# the number of external calls to a minimum, since it was getting to the
# point that it would take 5 seconds to fire up bash on an Sun Ultra 10!
# As a result, there are some unusual constructs in here. There are still
# some external calls left (e.g. calls to sed) but they are not in loops
# and I doubt they make that much difference to performance.
#
######################################################################
# Local Customisations {{{2
######################################################################
# It's best not to change this file on a machine-by-machine basis. For
# local extensions this file calls ~/.bashrc.local if it exists. It's
# called twice...  once before all processing with a single parameter ($1)
# "pre" and once after all processing with a single parameter "post".
#
# In addition, a number of variables are set and are available for use by
# the ~/.bashrc.local script. These variables are UNset before this file
# exits, so they are not available once the shell is interactive.
#
# The variables set by this script are:
#   _debugging                          Manually set (see below) to "1" if
#                                       parts of this and called scripts
#                                       should be verbose in their output.
#                                       Unset otherwise. NOTE that some
#                                       non-interactive tools (e.g. rsync)
#                                       get confused by stuff being
#                                       printed at shell startup so
#                                       normally this should be OFF.
#
#   _shell_is_interactive               Set to "1" if this is an interactive
#                                       session, and unset otherwise. No
#                                       output should be produced if this
#                                       is set.
#
#   _running_X                          Set to "1" if we are running under
#                                       X and appropriate stuff should be
#                                       done.  NOTE that when the "pre"
#                                       call to ~/.bashrc.local is made,
#                                       _running_X is based on a VERY
#                                       simple test (is DISPLAY set?).  By
#                                       the time the "post" call is made
#                                       _running_X reflects more thorough
#                                       probes for a usable X server. It's
#                                       best to wait for the "post" call
#                                       before using X since timeouts on
#                                       non-existant servers may cause
#                                       this script to appear to hang
#
######################################################################
# TODO: {{{2
######################################################################
#   It seems that I'm constantly adding new features that leap-frog the
#   TODO list below, so this is really a SHOULDDO list, but for what it's
#   worth:
#     - surround the ENV var and other once-only stuff with a big if,
#       testing $0 or something for login-shellness then call this file
#       from /.bash_profile with something like:
#       [ -f ~/.bashrc ] && . /.bashrc
#     - Policy question: Should stuff in the /usr/local tree be used in
#       preference to stuff in system directories like /usr/bin? At the
#       moment the path has the /usr/local stuff later. That means that a
#       newer version of software installed there won't get used.
#
######################################################################
# Folding {{{2
######################################################################
# The funny comments in this file, made from braces, like the ones before
# this paragraph, are for vim's folding mode. They make navigation in the
# file a lot easier  Unfortunately they require vim version >= 6.0. See
# ":help folding" in vim for more info. They should't affect any other
# editor, just think of them as marking the start and end of sections.
######################################################################

######################################################################
# Set up some variables for later {{{1
######################################################################
# NOTE: If a variable is added here it should be unset at the end of the
# file!

# _debugging=1

# $- contains the options provided to the shell
[[ $- == *i* ]] && _shell_is_interactive=1
[[ -n "$DISPLAY" ]] && _running_X=1

######################################################################
# Make the first call on the local settings file {{{1
######################################################################
# Disabled as unused (also it broke/mangled path munging when path vars set
# due to calling twice it seems)
# [ -f $HOME/.bashrc.local ] && . $HOME/.bashrc.local pre

# Source global definitions
if [ -f /etc/bashrc ]; then
   . /etc/bashrc
fi

######################################################################
# PATH, MANPATH, LD_LIBRARY_PATH {{{1
######################################################################
# Comments {{{2
# We do this first since we might need them later.
#
# LOCALPROGS allows programs to be installed in
# /usr/local/<progname>/{bin,man,sbin,lib} and still be found.  OPTPROGS
# does the same thing for /opt/<progname> - mostly for Solaris. MYOPTPROGS
# is the same thing for ~/opt, but I don't understand why you'd install
# stuff in your own home dir and then not want to run it!
#
# Here we add EVERY path we're likely to need, independant of OS. We will
# strip the ones that don't exist later
#
# Variable setup {{{2
# I don't normally set these to a complete list since not all users need
# all apps, but if either of the {LOCAL,OPT}PROGS variables is not set it
# will be automatically filled below with all values from the disk.

#LOCALPROGS=
OPTPROGS="SUNWcluster SUNWmd"
MYOPTPROGS=""
# The PATH gets cleaned/de-duped from the last call residing in .bashrc.local which s
# Basic Entries
PATH=/sbin:/usr/sbin:/usr/bin:/usr/dt/bin:$PATH
# Solaris entries
PATH=$PATH:/usr/ccs/bin:/usr/openwin/bin:/usr/sfw/bin:/usr/perl5/bin
# SunCluster entries (inc DTK)
PATH=$PATH:/usr/cluster/bin:/usr/cluster/lib/sc:/usr/cluster/dtk/bin
# SunFire 15k path
PATH=$PATH:/opt/SUNWSMS/bin
# Tru64 entries
PATH=$PATH:/usr/bin/X11:/usr/tcb/bin
# MacOSX entries
PATH=/sw/bin:/sw/sbin:/Developer/Tools:$PATH
# My entries
PATH=$PATH:~/bin:~/bin/admin:/usr/local/bin:/usr/kerberos/sbin:/opt/google:/opt/adt-bundle-linux-x86_64/sdk/platform-tools:/opt/Adobe/Reader9/bin:/opt/TeamSpeak3-Client-linux_amd64/:/opt/vagrant:/usr/local/array_vpn
# Android SDK & Atlassian path munge as below moved to bashrc.local (which is to be added to GH once crypto is finalized)
# ADDED .bashrc.local to GH Feb 14, 2017 **TODO**: extricate comments like above and throughout to CHANGELOG/HISTORY files**
#PATH=$PATH:$(find /opt/Android \( -iname 'bin' -printf ":%p" -o -iname 'adb' -printf ":%p\n" \))
# Late Solaris entries - definitely want these at the end
PATH=$PATH:/usr/ucb
MANPATH=/sw/share/man:/usr/share/man:/usr/dt/share/man
MANPATH=$MANPATH:/usr/local/man:/usr/openwin/man
MANPATH=$MANPATH:/usr/X11R6/man/:/usr/perl5/man
MANPATH=$MANPATH:/opt/SUNWSMS/man
MANPATH=$MANPATH:/usr/cluster/man:/usr/cluster/dtk/man:/usr/sfw/man
# #LD_LIBRARY_PATH=/usr/local/lib:/opt:/lib:/lib64:/usr/lib:/usr/lib64
# Localize timezone
# export TZ="America/Toronto"
# Set LANG etc.
LC_ALL=en_US.UTF-8
LANG=en_US.UTF-8
LANGUAGE=en_US.UTF-8
export LANG LC_ALL LANGUAGE
# Auto-add paths {{{2
# /usr/local {{{3
if [ -d /usr/local ]; then
    for PROG in ${LOCALPROGS:-$(cd /usr/local || return; echo *)}
    do
        if [ -d "/usr/local/$PROG/bin" ]; then
            PATH=/usr/local/$PROG/bin:$PATH
        fi
        if [ -d "/usr/local/$PROG/sbin" ]; then
            PATH=/usr/local/$PROG/sbin:$PATH
        fi
        if [ -d "/usr/local/$PROG/man" ]; then
            MANPATH=/usr/local/$PROG/man:$MANPATH
        fi
#        if [ -d /usr/local/$PROG/lib ]; then
#            #LD_LIBRARY_PATH=/usr/local/$PROG/lib:$LD_LIBRARY_PATH
#        fi
    done
fi

# /opt {{{3
if [ -d /opt ]; then
    for PROG in ${OPTPROGS:-$(cd /opt || return; echo *)}
    do
        if [ -d "/opt/$PROG/bin" ]; then
            PATH=$PATH:/opt/$PROG/bin
        fi
        if [ -d "/opt/$PROG/sbin" ]; then
            PATH=$PATH:/opt/$PROG/sbin
        fi
        if [ -d "/opt/$PROG/man" ]; then
            MANPATH=$MANPATH:/opt/$PROG/man
        fi
#        if [ -d /opt/$PROG/lib ]; then
#            #LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/$PROG/lib
#        fi
    done
fi

# $HOME/opt {{{3
# Don't do this if our home directory is /. This won't affect the
# resulting PATH but it will make the loop below faster
if [ -d "$HOME/opt" -a "$HOME" != "/" ]; then
    for PROG in ${MYOPTPROGS:-$(cd "$HOME/opt" || return; echo *)}
    do
        if [ -d "$HOME/opt/$PROG/bin" ]; then
            PATH="$HOME/opt/$PROG/bin":$PATH
        fi
        if [ -d "$HOME/opt/$PROG/sbin" ]; then
            PATH=$HOME/opt/$PROG/sbin:$PATH
        fi
        if [ -d "$HOME/opt/$PROG/man" ]; then
            MANPATH=$HOME/opt/$PROG/man:$MANPATH
        fi
#        if [ -d $HOME/opt/$PROG/lib ]; then
            #LD_LIBRARY_PATH=$HOME/opt/$PROG/lib:$LD_LIBRARY_PATH
#        fi
    done
fi

unset PROG OPTPROGS LOCALPROGS

######################################################################
# Terminal setup {{{1
######################################################################
# Set up the terminal (based on the TERM variable). Doesn't work properly
# on solaris (esp. in CDE) 'cos tset is Bezerkeley :-(
# TODO: I think there's a tset in /usr/ucb
if [[ "$_shell_is_interactive" == 1 && $OSTYPE != solaris* ]]; then
    if [[ $(type -p tset) ]]; then
        eval "$(SHELL=/bin/sh tset -s)"
    fi
fi

######################################################################
# Better X detection {{{1
######################################################################
# Ok, we now have the PATH set, so we can be more ambitious (and therefore
# reliable) about setting the _running_X variable.  The general idea here
# is that we want to check that the DISPLAY variable is not only set, but
# set to a valid value. The easiest way to do this is to run an innocuous
# X program, and check for exit status. Unfortunately, X applications have
# RIDICULOUSLY long timeouts (e.g. 2 1/2 _MINUTES_ on solaris 8). We don't
# want to have to wait that long if the DISPLAY variable points at a
# non-existent host. So we ping first, which should be quicker. But then,
# of course ping syntax has it's own issues...

if (( _running_X )); then
    declare displayhost=${DISPLAY%:*}
    declare pingcmd
    case $OSTYPE in
        solaris*)
            pingcmd="ping $displayhost 1"
            ;;
        linux*)
            pingcmd="ping -c 1 $displayhost"
            ;;
        *)
            ;;
        # TODO insert other flavors of ping here
    esac
    # If displayhost is blank DISPLAY is probably ":0" so we shouldn't ping
    [[ -z "$displayhost" ]] && pingcmd=""
    (( _debugging )) && echo Thorough X tests..
    if ! ( $pingcmd && xdpyinfo ) >/dev/null 2>&1; then
        # Either we can't ping the machine or xdpyinfo failed. Either way,
        # X is probably not going to work!
        (( _debugging )) && echo X seems to be broken!
        unset _running_X
    fi
    unset displayhost pingcmd
fi

######################################################################
# Shell options {{{1
######################################################################
# Set my preferred options
shopt -s cdspell checkwinsize histreedit

# If I hit <tab> on a blank line, I DON'T want to see a list of all the
# comands in my PATH - who would EVER want that??  This option appeared in
# bash 2.04, so it's not in the Solaris 8 version of bash.  Rather than
# checking for the version, check for the existance of the option:
[[ $(shopt) == *no_empty_cmd_completion* ]] &&
    shopt -s no_empty_cmd_completion

#Only put duplicate lines in the history once, delete dupes
shopt -s cmdhist

# Real-time history export amongst bash terminal windows (stackoverflow)
export HISTCONTROL=ignoredups:erasedups  # no duplicate entries
export HISTSIZE=100000                   # big big history
export HISTFILESIZE=100000               # big big history
shopt -s histappend                      # append to history, don't overwrite it
shopt -s histverify                      # enable history verification so that commands that are matched by the !, !!, and !? designators are not blindly executed [https://superuser.com/questions/7414/how-can-i-search-the-bash-history-and-rerun-a-command#74160]

######################################################################
# Prompt and other terminal settings {{{1
######################################################################
# Set the prompt {{{2
# If it's an xterm then set the window title to reflect $PWD
# If we're root, make the prompt red
# TODO: Should use tput for a lot of this stuff
# Declare some variables to work with
declare basicprompt='\h:\W\$'
# We need extglob turned on, so save the current value
oldextglob=$( shopt extglob )
declare oldextglob
shopt -s extglob
declare settitle setcoloron setcoloroff
# set up complicated prompt stuff based on terminal type
case $TERM in
    eterm|gnome-term*|dtterm*|*xterm*|screen*|linux)
        # These use the basic ANSI color sequences.
        setcoloroff="\[\033[0m\]"
        if (( ! "$UID" )); then
            # we are root... make the prompt red
            setcoloron="\[\033[1;31m\]"
        else
            # non-root, but I still like color
            setcoloron="\[\033[1;32m\]"
        fi
        if [[ $TERM == +(gnome-term*|*xterm*|dtterm*|screen*) ]]; then
            # These terminals have a title that can be set.
            # This magic came from one of the linux HOWTOs
            PS1='\[\033]0;\h: \w\007\]\u@\h:\W\$ '
            case $TERM in
               gnome-term*|eterm|*xterm*|dtterm*)
                    settitle="\[\033]0;\h: \w\007\]"
                    ;;
                screen*)
                    # for screen I want to set the window title to only
                    # the hostname, and use the hardstatus for the path.
                    # The escape sequences to set the hardstatus are the
                    # same as those to set the title in xterm.
                    settitle='\[\033k\h\033\\\033]0;\w\007\]'
                    ;;
            esac
        fi
        ;;
    *)
        # Nothing special here
        ;;
esac
PS1="${settitle}${setcoloron}${basicprompt}${setcoloroff} "

# Remove any exporting of PS1 since it looks hideous in other shells and
# bash will just re-read this file anyway
export -n PS1

#######################################################################
#                           Vagrant, virt*                            #
#######################################################################
# *** Moved to .bashrc.local ***
# export VAGRANT_VAGRANTFILE=Vagrantfile.local
# export VAGRANT_DEFAULT_PROVIDER=libvirt
# export VAGRANT_HOME=/run/media/$USER/DATA/.vagrant.d

# set extglob back to how we found it
[[ $oldextglob == *off ]] && shopt -u extglob
unset basicprompt settitle setcoloron setcoloroff oldextglob
######################################################################
# X related settings {{{1
######################################################################
# Perhaps these should be elsewhere, but I don't want to carry 23 files
# with me when I move from machine to machine
#
if (( _running_X )); then
    # use .xmodmaprc if it's there
    if [[ -f ~/.xmodmaprc ]]; then
        (( _debugging )) && echo Loading keyboard mapping from ~/.xmodmaprc
        xmodmap ~/.xmodmaprc
    else
        # Fix "Help" key on a Sun {{{2
        # Ok, the "Help" key on Sun keyboards drives me mental, since I'm
        # always hitting it instead of "Escape", so I remap it so that is
        # IS a second Escape key.
        if [[ $OSTYPE == solaris* ]]; then
            # if it's not already done
            if xmodmap -pk | grep -q Help; then
                (( _debugging )) && echo "Remapping Help key to Escape!"
                xmodmap -e "keysym Help = Escape" > /dev/null 2>&1
            fi
        fi
        # Turn off CAPSLOCK (I never use it deliberately) {{{2
        # if it's not already done
#        if [[ -n $(xmodmap | grep ^lock | sed 's/^lock *//') ]]; then
#          xmodmap -e "clear lock"
#           (( _debugging )) && echo "Disabling Caps Lock"
#        fi
# }}}
    fi  # End of no-modmaprc branch
fi      # End of X stuff


######################################################################
# Aliases {{{1
######################################################################
# Less is MORE {{{2
unalias less 2>/dev/null
if [[ $(type -p less) ]]; then
    # without less, man is CRAPPO (esp. on Solaris!).
    export PAGER="less -si"
else
    # We don't have less, but my fingers are ALWAYS typing it anyway. So
    # this prevents (even more) insanity.
    alias less=more
fi


# vi is good, but vim is better. {{{2
# I'm in the habit of typing 'vi' but if vim is there, I'd prefer that
if [[ $(type -p vim) ]]; then
    if [[ $OSTYPE == solaris* && $TERM == xterm ]]; then
        # I'm probably using putty on a PC so to get colors going:
        alias vi='TERM=xterm vim'
    else
        alias vi=vim
    fi
    EDITOR=$(type -p vim)
    VISUAL=$(type -p vim)
    export EDITOR VISUAL
else
    EDITOR=$(type -p vi)
    VISUAL=$(type -p vi)
fi

# If I have GNU ls then use color! {{{2
# TODO: This will break in the unfortunate circumstance when dircolors is
# present, but the first ls in the path is not GNU ls. Should fix this.
#if [[ $(type -p dircolors) ]]; then
#    eval $(dircolors --bourne-shell)
#    #then ls ='ls --color=auto '
#fi

# more useful ping results [[ to be added _back_ ]]
# "rebash" {{{2
# Let me easily re-run this in case of a new installation or change to this
# file. I know, how lazy is this?

alias rebash='. ~/.bashrc'

# Create a shorty-style alias for date with format of yyyy-month-day

alias dt='date +%F'

# Packer image creation command ... not Green Bay nor the other ones..

if [[ -f /usr/bin/packer ]] ; then
   alias Packer='/usr/bin/packer'
fi

unalias ls 2>/dev/null
######################################################################
# Functions {{{1
######################################################################
# ruler {{{2
# This one is sometimes handy. Once I'd written it, I realised I could
# have just used a static set of strings and extracted the needed
# substring, but this is niftier and more educational (for me) and a
# little more robust. By the way, the argument was really just meant so
# you could have a 0-based ruler, as well as a 1-based one. If you ask for
# one that will reach over 1000 or less than 0 it will look crappy, but
# you deserve what you get, IMHO!

# Unfortunately the for (( ... )) feature that I use here did not appear
# till bash 2.04, so it's not there on Solaris 8 and I have to put the
# function definition INSIDE an if statement. Ugh!. Worse, there's no easy
# way to test for its availability (a la no_empty_cmd_completion, above).
# As a result, I have to check for the bash version. Uerrgh! But wait.
# there's more!  There's no string >= operator, so this is particularly
# unpleasant - just look away if you are eating.
# Finally, of course the shell still processes  the contents of an if
# branch that it's not executing, so we have to put the entire function
# definition in a big string so we can eval it. I don't know why I bother!

if [[ ( ${BASH_VERSINFO[0]} = "2"  || ${BASH_VERSINFO[0]} -gt "2" )
   && ( ${BASH_VERSINFO[1]} = "04" || ${BASH_VERSINFO[1]} -gt "04" ) ]]; then
   eval ' function ruler {
        local start end col firstline secondline lastline
        declare -i start end col
        start="$1"
        [ -z "$1" ] && start=1
        (( end = COLUMNS + start ))
        # loop over the columns
        for (( col=start; col < end; col++ )); do
            # prepare the first line
            if (( col % 10 == 0 && col / 100 != 0 )); then
                firstline="$firstline"$(( col / 100 ))
            else
                firstline="$firstline-"
            fi
            # prepare the second line
            if (( col % 10 == 0 )); then
                secondline="${secondline}"$(( col / 10 % 10 ))
            else
                secondline="$secondline "
            fi
            # prepare the last line
            lastline="$lastline"$(( col % 10 ))
        done
        if (( start < 85 )); then
            printf "%4d %-10s%s" $COLUMNS "columns" "${firstline:15}"
        else
            echo "$firstline"
        fi
        echo "$secondline"
        echo "$lastline"
    }
    ' # end the eval
fi # End bash version test

# This function lets me use either the System V (-ef) or BSD (aux) style
# switches on Solaris. It just runs the appropriate ps based on whether
# there's a - there or not.
# Been meaning to do this for a while, then came across one at
# http://www.beaglebros.com/unix - so I stole it. I've since changed it,
# but when do I stop crediting the inspiration?
if [[ $OSTYPE == solaris* ]]; then
    function ps {
        if [ -n "$1" ]; then
            if [[ $1 == -* ]]; then
                /usr/bin/ps "$@"
            else
                /usr/ucb/ps "$@"
            fi
        else
            /usr/bin/ps "$@"
        fi
    }

fi # end solaris function
#######################################################################
#                                sudo                                 #
#######################################################################
######
# sudo trapping ( we're not always the only admin ;P )
######
if [[ "$(id -u)" = 0 ]] ; then
export HISTFILE=/root/.bash_history-$SUDO_USER
export HISTTIMEFORMAT="%F %T "

function log2syslog
{
   declare COMMAND
   COMMAND=$(fc -ln -0)
   logger -p local1.notice -t bash -i -- "${USER}:${SUDO_USER}:${COMMAND}"
}
trap log2syslog DEBUG
fi

# Editing system files
export SUDO_EDITOR=vim

#######################################################################
#                                Ruby                                 #
#######################################################################
# Moved rbenv => .bashrc.local (w/ conditional)

######################################################################
# Make the last call on the local settings file {{{1
# ** Stoked with GIT env, email, etc. and other _local_ settings **
######################################################################
if [[ "$(id -u)" -ne 0 && -e "$HOME/.bashrc.local" ]]; then
   [ -e "$HOME/.bashrc.local" ] && . "$HOME/.bashrc.local"
else
   [ -e "$HOME/.bashrc.pathclean" ] && . "$HOME/.bashrc.pathclean"
fi

if [[ "$(id -u)" -eq 0 ]]; then
   [ -e "$HOME/.bashrc.pathclean" ] && . "$HOME/.bashrc.pathclean"
fi

######################################################################
# Clean up {{{1
######################################################################
unset _shell_is_interactive
unset _running_X
unset _debugging

#######################################################################
#                               Python                                #
#######################################################################
# source ~/venv/bin/activate (Swapped out for pyenv:
# https://github.com/yyuu/pyenv ) & moved to .bashrc.local