base.bashrc

#!/bin/bash
#
# Copyright (c) 2000-2025 Matthew Pearson <matthewpearson@gmail.com>.
#
# These scripts are free. There is no warranty; your mileage may vary.
# Visit http://creativecommons.org/licenses/by-nc-sa/4.0/ for more details.
#
# shell commands executed each time a bash shell is invoked
#

# quick function that consolidates history files among similar hosts
get_histfile_name()
{
	case "$1" in
		adenine)	echo "login-hosts" ;;
		cytosine)	echo "login-hosts" ;;
		guanine)	echo "login-hosts" ;;
		thymine)	echo "login-hosts" ;;
		pipeline-*) echo "qlogin-hosts" ;;
		*)			echo "$1" ;;
	esac
}

# create a unique history file for each host
[ -d "$HOME/.bash_histories" ] || mkdir "$HOME/.bash_histories"
histfile_name="$(get_histfile_name "$THOST")"
[ "$histfile_name" ] || histfile_name="$(get_histfile_name "$HOST")"

# configure history to have quite a long memory
HISTCONTROL=ignoredups
HISTFILE="$HOME/.bash_histories/$histfile_name"
[ -f "$HISTFILE" ] || touch "$HISTFILE"
HISTSIZE=$((64 * 1024 - 1))
HISTFILESIZE=$((64 * 1024 - 1))
unset histfile_name

# update history on disk with current commands, then reload from disk
function history_update
{
	[ -f "$HISTFILE" ] || return

	history -a

	. "$HOME/.isinstalled"
	if [ "$(isinstalled python3)" ]
	then
		uniq_history -i "$HISTFILE"
	else
		sort -u "$HISTFILE" >| "$HISTFILE.tmp.$$"
		mv -f "$HISTFILE.tmp.$$" "$HISTFILE"
	fi

	history -c
	history -r
}

# run .bash_logout for all shells, not just login ones
# shellcheck source=base.bash_logout
trap '[ -f "$HOME/.bash_logout" ] && . "$HOME/.bash_logout"' EXIT

# don't run the remainder of this code if shell is not interactive
[[ $- == *i* ]] || return

# don't run the remainder of this code if shell was started by an IDE
if [[ "$TERM_PROGRAM" == "vscode" ]] || \
   [[ "$TERMINAL_EMULATOR" == "JetBrains-JediTerm" ]]
then
	PS1='bash(ide) $ '
	return
fi

#
# This file may be sourced by the user running under a different uid;
# e.g., root or gk. In that case, we need to override HOME in order
# to source other files like .profile and .common.ksh properly. Once
# these files are loaded in, we can restore HOME to its previous value.
#
if [ ! "$HOME" ] || [ "$(basename "$HOME")" != __G_USER__ ]
then
	old_home="$HOME"				# cache old HOME
	# first, check NIS for the proper passwd entry
	passl="$(ypcat passwd 2>/dev/null | grep '^__G_USER__:')"
	# check local passwd file if nis lookup fails
	[ "$passl" ] || passl="$(grep '^__G_USER__:' /etc/passwd 2>/dev/null)"
	HOME="$(echo "$passl" | awk -F: '{print $6}' 2>/dev/null)"

	# unreliable: last resort
	if [ ! "$HOME" ]
	then
		if [ "$(uname -s)" = 'Darwin' ]
		then
			HOME=/Users/__G_USER__
		else
			HOME=/home/__G_USER__
		fi
	fi

	export HOME
fi

# load up commands common to bash and ksh
# shellcheck source=base.common.ksh
[ -f "$HOME/.common.ksh" ] && . "$HOME/.common.ksh"
[ -f "$HOME/.inputrc" ] && export INPUTRC="$HOME/.inputrc"

TIMEFORMAT="		elapsed: %lR @ %P""%% (u:%lU|s:%lS)"

set -b					# immediately notify of terminated processes
set -C					# i.e., noclobber
set +o posix			# strict posix compatibility breaks autocomplete
set -P					# cd ../ follows physical not logical structure

shopt -s cdspell		# look for minor typos in cd cmds
shopt -s cmdhist		# save multiline cmds in one hist entry
shopt -s checkwinsize	# update LINES and COLUMNS more often
shopt -s histappend		# save history across sessions
shopt -s histreedit		# edit failed history changes
shopt -s histverify		# print changed cmd before running
shopt -u huponexit		# don't send SIGHUP to children on exit
shopt -u lithist		# save multiline commands with ';' delimiters not newlines
shopt -u nullglob		# conflicts with bash completion, otherwise it's really useful
shopt -s progcomp		# enable programmable completion
shopt -u sourcepath		# don't use PATH for `.' commands

# the following shopts work only for 2.05 or greater
shopt -s no_empty_cmd_completion 2>/dev/null	# don't freeze on an accidental tab
shopt -s xpg_echo 2>/dev/null					# use xpg4 semantics for echo
[ "$?" -eq 0 ] || alias echo="/bin/echo"		# use /bin/echo if above fails

if [ -f "${HOME}/.git-prompt.sh" ]
then
	. "${HOME}/.git-prompt.sh"
	export GIT_PS1_SHOWCOLORHINTS=1
	export GIT_PS1_SHOWDIRTYSTATE=1
	export GIT_PS1_SHOWSTASHSTATE=1
	export GIT_PS1_SHOWUNTRACKEDFILES=1
	export GIT_PS1_SHOWUPSTREAM="auto verbose"
else
	echo " (you may want to install git-prompt in ~/.git-prompt.sh)" >&2
	echo " (available at https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh)" >&2
fi

function init_bash_prompt
{
	if [ "$THOST" ] && [ "$THOST" != "$HOST" ]
	then
		nn="$THOST"
		dn=
	else
		nn=$HOST
		dn=
	fi

	if [ "$USER" = root ]
	then
		pchar='#'
	else
		pchar='\$'
	fi

	if [ "$BUTTONS" ]
	then
		PS1="\h console \$ "
	elif [ "$TERM" ] && [ -f "$HOME/.dircolors" ] && \
	  [ "$(grep -c "[^-a-z]${TERM}$" "$HOME/.dircolors")" -eq 1 ]
	then
		#
		# attribute codes:
		#  00=none 01=bold 02=dim 03=italic 04=u-line 05=blink 07=rev 08=hidden
		# text color codes [add 10 for background color]:
		#  30=blk 31=red 32=grn 33=yel 34=blu 35=mag 36=cyn 37=wht
		# separate multiple codes with semicolons.
		#
		if [ "$USER" != __G_USER__ ] || [ "$USER" = admin ]
		then					# running as different user:
			cf='31'				# red prompt
			include_username=1
		elif [ "$(is_remote_tty)" ]
		then					# remote host:
			cf='35'				# magenta prompt
			include_username=1
		else					# local:
			cf='01'				# bold prompt
			nn="localhost"		# override hostname
			include_username=1
		fi

		uf="${cf}"				# use selected color for username
		af="${cf};02"			# dim coloring for at-sign
		hf="${cf};03"			# italic hostname
		if="${cf};00;02"		# dim history count
		pf="${cf};01"			# bold prompt

		if [ "$include_username" ]
		then
			userstr="\[\e[${uf}m\]\u\[\e[0m\]\[\e[${af}m\]@\[\e[0m\]"
		else
			userstr=""
		fi
		hoststr="\[\e[${hf}m\]$nn\[\e[0m\]${dn:+:$dn}"
		histstr="\[\e[${if}m\]\!\[\e[0m\]"
		hashstr="\[\e[${pf}m\]${pchar}\[\e[0m\]"
		contstr="\[\e[${pf}m\]>\[\e[0m\]"

		PS1_FIRST="${userstr}${hoststr}"
		PS1_SECOND="${histstr} ${hashstr} "
		PS1="${PS1_FIRST} ${PS1_SECOND}"
		PS2="${contstr} "

		unset contstr hashstr histstr hoststr infostr userstr
		unset hf pf uf
		unset include_username wholine
	else
		PS1_FIRST="\u@$nn${dn:+:$dn}"
		PS1_SECOND="\! $pchar "
		PS1="${PS1_FIRST} ${PS1_SECOND}"
	fi

	export PS1
	unset nn dn shellabbr pchar
}

if [ "$(declare -f __git_ps1)" ]
then
	#
	# __git_ps1 depends on a few global variables which can be overridden here.
	#
	# $b -- branch name or equivalent (but not accessible here)
	# $c -- set before anything prints
	# $i -- set to "+" when something is staged
	# $p -- set to [=<>] or "u-21" to indicate differences with upstream branch
	# $r -- contains "REBASE" or other terms when you are doing something complicated
	# $s -- set to "$" when the stash contains something; immediately follows workspace name
	# $u -- set to "%" when something is unstaged
	# $w -- set to "*" when something has been modified in the repository
	#
	__git_ps1_colorize_gitstring()
	{
		__GIT_PS1_AHEAD_FMT='\[\e[34;03m\]'		# local ahead of remote - blue italic
		__GIT_PS1_BEHIND_FMT='\[\e[35;03m\]'	# remote ahead of local - magenta italic
		__GIT_PS1_BRANCH_FMT='\[\e[02m\]'		# branch name in normal circumstances
		__GIT_PS1_DETACHED_FMT='\[\e[31;01m\]'	# detached/special branch status
		__GIT_PS1_MODIFIED_FMT='\[\e[33;01m\]'	# flag that modified, unstaged files exist - bold yellow
		__GIT_PS1_REBASE_FMT='\[\e[31m\]'		# text in the midst of a rebase
		__GIT_PS1_RESET_FMT='\[\e[00m\]'		# reset these crazy colors
		__GIT_PS1_STAGED_FMT='\[\e[32;01m\]'	# flag that staged files exist - bold green
		__GIT_PS1_STASH_FMT='\[\e[01;02;04m\]'	# flag that stashed files exist - bold gray underlined
		__GIT_PS1_UNTRACKED_FMT='\[\e[31;01m\]' # flag that untracked files exist - bold red

		# this variable is set in the git-prompt.sh script
		# shellcheck disable=SC2154
		if [ "$detached" = 'yes' ]
		then
			c="${__GIT_PS1_DETACHED_FMT}${c}"
		else
			c="${__GIT_PS1_BRANCH_FMT}${c}"
		fi
		if [ -n "$upstream" ]
		then
			# adjust display of upstream/downstream state
			upstream="$(echo "$upstream" | sed \
			  -e 's/|//' \
			  -e 's/u//' \
			  -e 's/=//' \
			  -e 's/\(\+[0-9]*\)/${__GIT_PS1_AHEAD_FMT}\1${__GIT_PS1_RESET_FMT}/' \
			  -e 's/\(-[0-9]*\)/${__GIT_PS1_BEHIND_FMT}\1${__GIT_PS1_RESET_FMT}/')"
			upstream="|$(eval echo "$upstream")"
			[ "$upstream" = '|' ] && upstream=
		fi
		if [ -n "$r" ]
		then
			# adjust how rebase status is displayed
			r=$(echo "$r" | sed \
			  -e 's/|//' \
			  -e 's/\([A-Za-z-]*\)/${__GIT_PS1_REBASE_FMT}\1${__GIT_PS1_RESET_FMT}/')
			r="${__GIT_PS1_RESET_FMT}|$(eval echo "$r")"
		else
			r="${__GIT_PS1_RESET_FMT}${r}"
		fi
		if [ -n "$w" ]
		then
			# adjust how modified files are flagged
			w="${__GIT_PS1_RESET_FMT}${__GIT_PS1_MODIFIED_FMT}m"
		fi
		if [ -n "$i" ]
		then
			# adjust how modified, staged files are flagged
			i="${__GIT_PS1_RESET_FMT}${__GIT_PS1_STAGED_FMT}s"
		fi
		if [ -n "$s" ]
		then
			# adjust how stashed files are flagged
			s="${__GIT_PS1_RESET_FMT}${__GIT_PS1_STASH_FMT}s"
		fi
		if [ -n "$u" ]
		then
			# adjust how untracked files are flagged
			u="${__GIT_PS1_RESET_FMT}${__GIT_PS1_UNTRACKED_FMT}u"
		fi
	}
fi

function prompt_update
{
	update_titles

	if [ "$(declare -f __git_ps1)" ]
	then
		use_git_prompt=1

		if [ "$GIT_PS1_DISABLEPROMPT" ]
		then
			unset use_git_prompt
		else
			case "$PWD" in
				/Volumes/*)
					unset use_git_prompt
					;;
				/locus/*)
					[ "$(uname)" = 'Darwin' ] && unset use_git_prompt
					;;
			esac
		fi

		if [ "$use_git_prompt" ]
		then
			__git_ps1 "${PS1_FIRST} " "${PS1_SECOND}" "{$(git_repo_name)|%s} "
		else
			PS1="${PS1_FIRST} ${PS1_SECOND}"
		fi
	fi
}
PROMPT_COMMAND='prompt_update $?'

function log_error
{
	_errno="$?"
	_cmd="$*"

	if [ "$_errno" ] && [ "$_errno" -ne 0 ]
	then
		[ "$_pre_val" ] || _pre_val=$( (tput setaf 1; tput bold) 2>/dev/null)
		[ "$_post_val" ] || _post_val=$(tput sgr0 2>/dev/null)
		echo "${_pre_val}\`$_cmd\` returned error code ${_pre_val}${_errno}.${_post_val}"
	fi
	unset _errno _cmd
}
trap 'log_error $BASH_COMMAND' ERR

# automatically call ls after cd if the listing is six lines or less
function cd_wrapper
{
	thispwd="$PWD"

	eval builtin cd "${1+\"$*\"}" >/dev/null

	if [ "$thispwd" != "$PWD" ]
	then
		# undo prompt customizations of autoenv scripts when cd'ing away
		unset OLDPS1
		# see base.common.ksh for definition of WSNAME
		# shellcheck disable=SC2034
		WSNAME="None"
		autoenv_init

		echo "cd: working directory now $PWD"
		[ "$(\ls -C | wc -l)" -le 6 ] && ls
	fi
	unset thispwd
}
alias cd='cd_wrapper'

init_bash_prompt

# command-line completions generally use more bash-isms than I am willing to write
. "$HOME/.isinstalled"
trap - ERR
if shopt -qo posix
then
	set +o posix
	restore_posix_flag=1
fi

if [ "$(isinstalled brew)" ]
then
	_brew_prefix="$(brew --prefix)"

	if [ -f "${_brew_prefix}/etc/profile.d/bash_completion.sh" ]
	then
		. "${_brew_prefix}/etc/profile.d/bash_completion.sh"
	fi

	unset _brew_prefix
fi

if [ -f "${HOME}/.git-completion.bash" ]
then
	. "$HOME/.git-completion.bash"
else
	echo " (you may want to install git-completion in ~/.git-completion.bash)" >&2
	echo " (available at https://github.com/git/git/blob/master/contrib/completion/git-completion.bash)" >&2
fi

if [ -f /usr/local/bin/aws_completer ]
then
	complete -C '/usr/local/bin/aws_completer' aws
fi

[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"

if [ "$(isinstalled kubectl)" ]
then
	source <(kubectl completion bash)
fi

# restore shell settings after command-line completion magic is done
if [ "$restore_posix_flag" ]
then
	set -o posix
	unset restore_posix_flag
fi
trap 'log_error $BASH_COMMAND' ERR
unset isinstalled

if [ "$old_home" ]
then
	HOME=$old_home
	unset old_home
fi

#EOF __TAGGED__