#!/bin/bash
################################################################################
# LIQUID PROMPT
# An intelligent and non intrusive prompt for bash
################################################################################
# Licensed under the AGPL version 3
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
###########
# AUTHORS #
###########
# nojhan # Main author.
# Aurelien Requiem # Major clean refactoring, variable path length, error codes, several bugfixes.
# Joris Dedieu # Portability framework, FreeBSD support, bugfixes.
# Ludovic Rousseau # Lot of bugfixes.
# Yann 'Ze' Richard # Do not fail on missing commands.
# François Schmidts # Simpler SSH_IP acquiring method.
# Thomas Debesse # Fix columns use.
# Florian Le Frioux # Use ± mark when root in VCS dir.
# See the README.md file for a summary of features.
# Check for recent enough version of bash.
[[ -z "$BASH_VERSION" || -z "$PS1" || -z "$TERM" ]] && return;
bash=${BASH_VERSION%.*}; bmajor=${bash%.*}; bminor=${bash#*.}
if [[ $bmajor -lt 3 ]] || [[ $bmajor -eq 3 && $bminor -lt 2 ]]; then
unset bash bmajor bminor
return
fi
unset bash bmajor bminor
#################
# CONFIGURATION #
#################
# Default values
LP_BATTERY_THRESHOLD=${LP_BATTERY_THRESHOLD:-75}
LP_LOAD_THRESHOLD=${LP_LOAD_THRESHOLD:-60}
LP_PATH_LENGTH=${LP_PATH_LENGTH:-35}
LP_PATH_KEEP=${LP_PATH_KEEP:-2}
LP_REVERSE=${LP_REVERSE:-0}
LP_HOSTNAME_ALWAYS=${LP_HOSTNAME_ALWAYS:-0}
LP_PS1=${LP_PS1:-""}
# Default config file may be the XDG standard ~/.config/liquidpromptrc,
# but heirloom dotfile has priority.
if [[ -f "$HOME/.liquidpromptrc" ]]
then
configfile="$HOME/.liquidpromptrc"
elif [[ -z "$XDG_HOME_DIR" ]]
then
configfile="$HOME/.config/liquidpromptrc"
else
configfile="$XDG_HOME_DIR/liquidpromptrc"
fi
if [[ -f "$configfile" ]]
then
source "$configfile"
fi
###############
# OS specific #
###############
# OS detection, default to Linux
OS="Linux"
case $(uname) in
"Linux" ) OS="Linux" ;;
"FreeBSD") OS="FreeBSD" ;;
"Darwin") OS="Darwin" ;;
"DragonFly") OS="FreeBSD" ;;
"SunOS") OS="SunOS" ;;
esac
# Colors declarations
if [[ "$OS" == "FreeBSD" ]] ; then
BLACK="\[$(tput AF 0)\]"
BOLD_GRAY="\[$(tput md ; tput AF 0)\]"
WHITE="\[$(tput AF 7)\]"
BOLD_WHITE="\[$(tput md ; tput AF 7)\]"
RED="\[$(tput AF 1)\]"
BOLD_RED="\[$(tput md ; tput AF 1)\]"
WARN_RED="\[$(tput AF 0 ; tput setab 1)\]"
CRIT_RED="\[$(tput md; tput AF 7 ; tput setab 1)\]"
GREEN="\[$(tput AF 2)\]"
BOLD_GREEN="\[$(tput md ; tput AF 2)\]"
YELLOW="\[$(tput AF 3)\]"
BOLD_YELLOW="\[$(tput md ; tput AF 3)\]"
BLUE="\[$(tput AF 4)\]"
BOLD_BLUE="\[$(tput md ; tput AF 4)\]"
PURPLE="\[$(tput AF 5)\]"
PINK="\[$(tput md ; tput AF 5)\]"
CYAN="\[$(tput AF 6)\]"
BOLD_CYAN="\[$(tput md ; tput AF 6)\]"
NO_COL="\[$(tput me)\]"
else
# default to Linux
BLACK="\[$(tput setaf 0)\]"
BOLD_GRAY="\[$(tput bold ; tput setaf 0)\]"
WHITE="\[$(tput setaf 7)\]"
BOLD_WHITE="\[$(tput bold ; tput setaf 7)\]"
RED="\[$(tput setaf 1)\]"
BOLD_RED="\[$(tput bold ; tput setaf 1)\]"
WARN_RED="\[$(tput setaf 0 ; tput setab 1)\]"
CRIT_RED="\[$(tput bold; tput setaf 7 ; tput setab 1)\]"
GREEN="\[$(tput setaf 2)\]"
BOLD_GREEN="\[$(tput bold ; tput setaf 2)\]"
YELLOW="\[$(tput setaf 3)\]"
BOLD_YELLOW="\[$(tput bold ; tput setaf 3)\]"
BLUE="\[$(tput setaf 4)\]"
BOLD_BLUE="\[$(tput bold ; tput setaf 4)\]"
PURPLE="\[$(tput setaf 5)\]"
PINK="\[$(tput bold ; tput setaf 5)\]"
CYAN="\[$(tput setaf 6)\]"
BOLD_CYAN="\[$(tput bold ; tput setaf 6)\]"
NO_COL="\[$(tput sgr0)\]"
fi
# Foreground colors
# can be set to white or black
FG=$WHITE
BOLD_FG=$BOLD_WHITE
if [[ $LP_REVERSE == 1 ]] ; then
FG=$BLACK
BOLD_FG=$BOLD_GRAY
fi
# get cpu number
__cpunum_Linux()
{
grep ^[Pp]rocessor /proc/cpuinfo | wc -l
}
__cpunum_FreeBSD()
{
sysctl -n hw.ncpu
}
__cpunum_Darwin()
{
__cpunum_FreeBSD
}
__cpunum_SunOS()
{
kstat -m cpu_info | grep "module: cpu_info" | wc -l
}
__CPUNUM=$(__cpunum_$OS)
# get current load
__load_Linux()
{
load=$(awk '{print $1}' /proc/loadavg)
echo -n "$load"
}
__load_FreeBSD()
{
load=$(LANG=C sysctl -n vm.loadavg | awk '{print $2}')
echo -n "$load"
}
__load_Darwin()
{
__load_FreeBSD
}
__load_SunOS()
{
load=$(LANG=C uptime | awk '{print $10}'| sed -e 's/,//')
echo -n "$load"
}
###############
# Who are we? #
###############
# Yellow for root, light grey if the user is not the login one, else no color.
__user()
{
# if user is not root
if [[ "$EUID" -ne "0" ]] ; then
# if user is not login user
if [[ ${USER} != "$(logname 2>/dev/null)" ]]; then
user="${FG}\u${NO_COL}"
else
user="\u"
fi
else
user="${BOLD_YELLOW}\u${NO_COL}"
fi
echo -ne $user
}
#################
# Where are we? #
#################
__connection()
{
THIS_TTY=tty$(ps aux | grep $$ | grep bash | awk '{ print $7 }')
SESS_SRC=$(who | grep $THIS_TTY | awk '{ print $6 }')
# Are we in an SSH connexion?
SSH_FLAG=0
SSH_IP=${SSH_CLIENT%% *}
if [[ $SSH_IP ]] ; then
SSH_FLAG=1
fi
SSH2_IP=$(echo $SSH2_CLIENT | awk '{ print $1 }')
if [[ $SSH2_IP ]] ; then
SSH_FLAG=1
fi
if [[ $SSH_FLAG -eq 1 ]] ; then
CONN="ssh"
elif [[ -z $SESS_SRC ]] ; then
CONN="lcl"
elif [[ $SESS_SRC = "(:0.0)" || $SESS_SRC = "" ]] ; then
CONN="lcl"
else
CONN="tel"
fi
echo -ne $CONN
}
# Put the hostname if not locally connected
# color it in cyan within SSH, and a warning red if within telnet
# else diplay the host without color
__host_color()
{
conn=$(__connection)
ret="${NO_COL}"
if [[ "$conn" == "lcl" ]] ; then
if [[ $LP_HOSTNAME_ALWAYS == 0 ]] ; then
ret="${ret}" # no hostname if local
else
ret="${ret}@\h"
fi
elif [[ "$conn" == "ssh" ]] ; then
ret="${ret}@${BOLD_CYAN}\h"
elif [[ "$conn" == "tel" ]] ; then
ret="${ret}@${WARN_RED}\h"
else
ret="${ret}@\h"
fi
echo -ne "${ret}${NO_COL}"
}
# put an arrow if an http proxy is set
__proxy()
{
if [[ ! -z "$http_proxy" ]] ; then
echo -ne "↥"
fi
}
# BASH function that shortens
# a very long path for display by removing
# the left most parts and replacing them
# with a leading ...
#
# the first argument is the path
#
# the second argument is the maximum allowed
# length including the '/'s and ...
# http://hbfs.wordpress.com/2009/09/01/short-pwd-in-bash-prompts/
#
# + keep some left part of the path if asked
__shorten_path()
{
# the character that will replace the part of the path that is masked
local mask=" … "
# index of the directory to keep from the root (starts at 0)
local keep=$((LP_PATH_KEEP-1))
local len_percent=$2
local p=$(echo "$1" | sed -e "s|$HOME|~|")
local len="${#p}"
local max_len=$((${COLUMNS:-80}*$len_percent/100))
local mask_len="${#mask}"
local slashes=0
if [[ "$len" -gt "$max_len" ]]
then
# finds all the '/' in
# the path and stores their
# positions
#
local pos=()
for ((i=0;i $slashes ]] ; then
i=$slashes
fi
while [[ "$((len-pos[i]))" -gt "$((max_len-mask_len))" ]]
do
i=$((i+1))
done
# let us check if it's OK to
# print the whole thing
#
if [[ "${pos[i]}" -eq "0" ]]
then
# the path is shorter than
# the maximum allowed length,
# so no need for ...
#
echo "$p"
elif [[ "${pos[i]}" = "$len" ]]
then
# constraints are broken because
# the maximum allowed size is smaller
# than the last part of the path, plus
# ' … '
#
echo "${p:0:((${pos[${keep}]}+1))}${mask}${p:((len-max_len+mask_len))}"
else
# constraints are satisfied, at least
# some parts of the path, plus ' … ', are
# shorter than the maximum allowed size
#
echo "${p:0:((${pos[${keep}]}+1))}${mask}${p:pos[i]}"
fi
else
echo "$p"
fi
}
# Display a ":"
# colored in green if user have write permission on the current directory
# colored in red if it have not.
__permissions_color()
{
if [[ -w "${PWD}" ]]; then
echo "${GREEN}:${NO_COL}"
else
echo "${RED}:${NO_COL}"
fi
}
################
# Related jobs #
################
# Either attached running jobs (started with $ myjob &)
# or attached stopped jobs (suspended with Ctrl-Z)
# or detached screens sessions running on the host
__jobcount_color()
{
local running=$(jobs -r | wc -l | tr -d " ")
local stopped=$(jobs -s | wc -l | tr -d " ")
local screens=$(screen -ls 2> /dev/null | grep -c Detach )
local m_detached="d"
local m_stop="z"
local m_run="&"
# d/&/z
if [[ $screens != "0" && $running != "0" && $stopped != "0" ]] ; then
rep="${NO_COL}${YELLOW}${screens}${m_detached}${NO_COL}/${YELLOW}${running}${m_run}${NO_COL}/${BOLD_YELLOW}${stopped}${m_stop}${NO_COL}"
# _/&/_
elif [[ $screens == "0" && $running != "0" && $stopped == "0" ]] ; then
rep="${NO_COL}${YELLOW}${running}${m_run}${NO_COL}"
# _/_/z
elif [[ $screens == "0" && $running == "0" && $stopped != "0" ]] ; then
rep="${NO_COL}${BOLD_YELLOW}${stopped}${m_stop}${NO_COL}"
# d/_/_
elif [[ $screens != "0" && $running == "0" && $stopped == "0" ]] ; then
rep="${NO_COL}${YELLOW}${screens}${m_detached}${NO_COL}"
# d/&/_
elif [[ $screens != "0" && $running != "0" && $stopped == "0" ]] ; then
rep="${NO_COL}${YELLOW}${screens}${m_detached}${NO_COL}/${YELLOW}${running}${m_run}${NO_COL}"
# d/_/z
elif [[ $screens != "0" && $running == "0" && $stopped != "0" ]] ; then
rep="${NO_COL}${YELLOW}${screens}${m_detached}${NO_COL}/${BOLD_YELLOW}${stopped}${m_stop}${NO_COL}"
# _/&/z
elif [[ $screens == "0" && $running != "0" && $stopped != "0" ]] ; then
rep="${NO_COL}${YELLOW}${running}${m_run}${NO_COL}/${BOLD_YELLOW}${stopped}${m_stop}${NO_COL}"
fi
echo -ne "$rep"
}
# Display the return value of the last command, if different from zero
__return_value()
{
if [[ "$1" -ne "0" ]]
then
echo -ne "$1"
fi
}
######################
# VCS branch display #
######################
# GIT #
# Get the branch name of the current directory
__git_branch()
{
if git rev-parse --git-dir >/dev/null 2>&1 && [[ ! -z "$(git branch)" ]] ; then
echo -n "$(git branch 2>/dev/null | sed -n '/^\*/s/^\* //p;')"
fi
}
# Set a color depending on the branch state:
# - green if the repository is up to date
# - yellow if there is some commits not pushed
# - red if there is changes to commit
#
# Add the number of pending commits and the impacted lines.
__git_branch_color()
{
command -v git >/dev/null 2>&1 || return 1;
branch=$(__git_branch)
if [[ ! -z "$branch" ]] ; then
git diff --quiet >/dev/null 2>&1
GD=$?
git diff --cached --quiet >/dev/null 2>&1
GDC=$?
has_commit=$(git rev-list --no-merges --count origin/${branch}..${branch} 2>/dev/null)
if [[ -z "$has_commit" ]] ; then
has_commit=0
fi
if [[ "$GD" -eq 1 || "$GDC" -eq "1" ]] ; then
has_lines=$(git diff --numstat | awk 'NF==3 {plus+=$1; minus+=$2} END {printf("+%d/-%d\n", plus, minus)}')
if [[ "$has_commit" -gt "0" ]] ; then
# Changes to commit and commits to push
ret="${RED}${branch}${NO_COL}(${PURPLE}$has_lines${NO_COL},${YELLOW}$has_commit${NO_COL})"
else
ret="${RED}${branch}${NO_COL}(${PURPLE}$has_lines${NO_COL})" # changes to commit
fi
else
if [[ "$has_commit" -gt "0" ]] ; then
# some commit(s) to push
ret="${YELLOW}${branch}${NO_COL}(${YELLOW}$has_commit${NO_COL})"
else
ret="${GREEN}${branch}${NO_COL}" # nothing to commit or push
fi
fi
echo -ne "$ret"
fi
}
# MERCURIAL #
# Get the branch name of the current directory
__hg_branch()
{
branch="$(hg branch 2>/dev/null)"
if [[ $? -eq 0 ]] && [[ ! -z "$(hg branch)" ]] ; then
echo -n "$(hg branch)"
fi
}
# Set a color depending on the branch state:
# - green if the repository is up to date
# - red if there is changes to commit
# - TODO: yellow if there is some commits not pushed
__hg_branch_color()
{
command -v hg >/dev/null 2>&1 || return 1;
branch=$(__hg_branch)
if [[ ! -z "$branch" ]] ; then
if [[ $(hg status --quiet -n | wc -l | sed -e "s/ //g") = 0 ]] ; then
ret="${GREEN}${branch}${NO_COL}"
else
ret="${RED}${branch}${NO_COL}" # changes to commit
fi
echo -ne "$ret"
fi
}
# SUBVERSION #
# Get the branch name of the current directory
# For the first level of the repository, gives the repository name
__svn_branch()
{
infos=$(svn info --xml 2>/dev/null)
ret=$?
if [[ $ret -eq 0 ]] ; then
root=$(echo "$infos" | grep "^" | sed "s/^.*\/\([^\/]*\)<\/root>$/\1/")
subrep=$(echo "$infos" | grep "^" | sed "s/^.*\/$root\/\(.*\)<\/url>$/\1/")
if [[ "$subrep" == *"url>"* ]] ; then
echo -n $root
else
branch=$(basename $subrep)
echo -n $branch
fi
fi
}
# Set a color depending on the branch state:
# - green if the repository is up to date
# - red if there is changes to commit
# Note that, due to subversion way of managing changes,
# informations are only displayed for the CURRENT directory.
__svn_branch_color()
{
command -v svn >/dev/null 2>&1 || return 1;
branch=$(__svn_branch)
if [[ ! -z "$branch" ]] ; then
commits=$(svn status | grep -v "?" | wc -l)
commits=$((commits))
if [[ $commits = 0 ]] ; then
ret="${GREEN}${branch}${NO_COL}"
else
ret="${RED}${branch}${NO_COL}(${YELLOW}$commits${NO_COL})" # changes to commit
fi
echo -ne "$ret"
fi
}
##################
# Battery status #
##################
# Get the battery status in percent
# returns 1 if no battery support
__battery()
{
command -v acpi >/dev/null 2>&1 || return 1;
bat=$(acpi --battery 2>/dev/null | sed "s/^Battery .*, \([0-9]*\)%.*$/\1/")
if [[ "${bat}" == "" ]] ; then
return 1
fi
if [[ ${bat} -le $LP_BATTERY_THRESHOLD ]] ; then
echo -n "${bat}"
return 0
else
return 1
fi
}
# Compute a gradient of background/foreground colors depending on the battery status
__battery_color()
{
bat=$(__battery)
if [[ "$?" = "1" ]] ; then return; fi; # no battery support
if [[ "$bat" != "" ]] ; then
if [[ ${bat} -gt $LP_BATTERY_THRESHOLD ]] ; then
return; # nothing displayed above 75%
fi
ret="⌁${NO_COL}"
if [[ ${bat} -le 75 ]] && [[ ${bat} -gt 50 ]] ; then
ret="${ret}${BOLD_GREEN}"
elif [[ ${bat} -le 40 ]] && [[ ${bat} -gt 20 ]] ; then
ret="${ret}${BOLD_YELLOW}"
elif [[ ${bat} -le 20 ]] && [[ ${bat} -gt 10 ]] ; then
ret="${ret}${BOLD_RED}"
elif [[ ${bat} -le 10 ]] && [[ ${bat} -gt 5 ]] ; then
ret="${ret}${WARN_RED}"
else
ret="${ret}${CRIT_RED}"
fi
echo -ne "${ret}${bat}%${NO_COL}"
fi
}
###############
# System load #
###############
# Compute a gradient of background/forground colors depending on the battery status
__load_color()
{
# Colour progression is important ...
# bold gray -> bold green -> bold yellow -> bold red ->
# black on red -> bold white on red
#
# Then we have to choose the values at which the colours switch, with
# anything past yellow being pretty important.
loadval=$(__load_$OS)
load=$(echo $loadval | sed 's/\.//g;s/^0*//g' )
if [[ -z "$load" ]] ; then
load=0
fi
let "load=$load/$__CPUNUM"
if [[ $load -ge $LP_LOAD_THRESHOLD ]]
then
ret="⌂${NO_COL}"
if [[ $load -lt 70 ]] ; then
ret="${ret}${FG}"
elif [[ $load -ge 1 ]] && [[ $load -lt 80 ]] ; then
ret="${ret}${BOLD_GREEN}"
elif [[ $load -ge 80 ]] && [[ $load -lt 95 ]] ; then
ret="${ret}${BOLD_YELLOW}"
elif [[ $load -ge 95 ]] && [[ $load -lt 150 ]] ; then
ret="${ret}${BOLD_RED}"
elif [[ $load -ge 150 ]] && [[ $load -lt 200 ]] ; then
ret="${ret}${WARN_RED}"
else
ret="${ret}${CRIT_RED}"
fi
ret="${ret}$load%${NO_COL}"
echo -ne "${ret}"
fi
}
##########
# DESIGN #
##########
# Set the prompt mark to ± if git, to ☿ if mercurial, to ‡ if subversion
# to # if root and else $
__smart_mark()
{
local COL=${BOLD_FG}
if [[ "$EUID" -eq "0" ]] ; then
COL=${BOLD_RED}
fi
local mark="\\\$"
if [[ ! -z $(__git_branch) ]] ; then
mark="±"
elif [[ ! -z $(__hg_branch) ]] ; then
mark="☿"
elif [[ ! -z $(__svn_branch) ]] ; then
mark="‡"
fi
echo -ne "${COL}${mark}${NO_COL}"
}
# insert a space on the right
__sr()
{
if [[ ! -z "$1" ]] ; then
echo -n "$1 "
fi
}
# insert a space on the left
__sl()
{
if [[ ! -z "$1" ]] ; then
echo -n " $1"
fi
}
# insert two space, before and after
__sb()
{
if [[ ! -z "$1" ]] ; then
echo -n " $1 "
fi
}
########################
# Construct the prompt #
########################
__set_bash_prompt()
{
# as this get the last returned code, it should be called first
__RET=$(__sl "$(__return_value $?)")
# execute the old prompt
$LP_OLD_PROMPT_COMMAND
# left of main prompt: space at right
__JOBS=$(__sr "$(__jobcount_color)")
__LOAD=$(__sr "$(__load_color)")
__BATT=$(__sr "$(__battery_color)")
# in main prompt: no space
__USER=$(__user)
__HOST=$(__host_color)
__PERM=$(__permissions_color)
__PWD=$(__shorten_path "$PWD" $LP_PATH_LENGTH)
__PROXY=$(__proxy)
# right of main prompt: space at left
__GIT=$(__sl "$(__git_branch_color)")
__HG=$(__sl "$(__hg_branch_color)")
__SVN=$(__sl "$(__svn_branch_color)")
# end of the prompt line: double spaces
__MARK=$(__sb "$(__smart_mark)")
if [[ -z $LP_PS1 ]] ; then
# add jobs, load and battery
PS1="${__BATT}${__LOAD}${__JOBS}"
# add user, host and permissions colon
PS1="${PS1}[${__USER}${__HOST}${NO_COL}${__PERM}"
# if not root
if [[ "$EUID" -ne "0" ]]
then
# path in foreground color
PS1="${PS1}${BOLD_FG}${__PWD}${NO_COL}]${__PROXY}"
# add VCS infos
PS1="${PS1}${__GIT}${__HG}${__SVN}"
else
# path in yellow
PS1="${PS1}${YELLOW}${__PWD}${NO_COL}]${__PROXY}"
# do not add VCS infos
fi
# add return code and prompt mark
PS1="${PS1}${PURPLE}${__RET}${NO_COL}${__MARK}"
# Glue the bash prompt always go to the first column.
# Avoid glitches after interrupting a command with Ctrl-C
# Does not seem to be necessary anymore?
#PS1="\[\033[G\]${PS1}${NO_COL}"
else
PS1=$LP_PS1
fi
}
# Activate the liquid prompt
prompt_on()
{
# if liquidprompt has not been already set
if [[ -z "$LP_LIQUIDPROMPT" ]] ; then
LP_OLD_PS1="$PS1"
LP_OLD_PROMPT_COMMAND="$PROMPT_COMMAND"
fi
PROMPT_COMMAND=__set_bash_prompt
# Keep in mind that LP has been sourced
# (to avoid recursive prompt command).
LP_LIQUIDPROMPT=1
}
# Come back to the old prompt
prompt_off()
{
PS1=$LP_OLD_PS1
PROMPT_COMMAND=$LP_OLD_PROMPT_COMMAND
}
# Use an empty prompt: just the \$ mark
prompt_OFF()
{
PS1="\$ "
PROMPT_COMMAND=$LP_OLD_PROMPT_COMMAND
}
# By default, sourcing liquidprompt.bash will activate the liquid prompt
prompt_on
# vim: set ts=4 sw=4 tw=120 :