oh-my-bash/lib/base.sh

348 lines
12 KiB
Bash

#! bash oh-my-bash.module
#------------------------------------------------------------------------------
# Note on copyright (2022-08-23): The contents of this file seems to have been
# originally introduced in a blog post [1]. The author also put it on Gist
# [2]. The blog post says "feel free to take whatever", but the license is not
# explicitly specified. Aliases are moved to general.aliases.sh.
#
# [1] Nathaniel Landau, "My Mac OSX Bash Profile",
# https://natelandau.com/my-mac-osx-bash_profile/, 2013-07-02.
# [2] https://gist.github.com/natelandau/10654137
#
#------------------------------------------------------------------------------
#
# Description: This file holds all base BASH functions
#
# Sections:
# 1. Make Terminal Better (remapping defaults and adding functionality)
# 2. File and Folder Management
# 3. Searching
# 4. Process Management
# 5. Networking
# 6. System Operations & Information
# 7. Date & Time Management
# 8. Web Development
# 9. <your_section>
#
# X. Reminders & Notes
#
#------------------------------------------------------------------------------
# -----------------------------
# 1. MAKE TERMINAL BETTER
# -----------------------------
# mcd: Makes new Dir and jumps inside
# --------------------------------------------------------------------
function mcd { mkdir -p -- "$*" ; cd -- "$*" || exit ; }
# mans: Search manpage given in agument '1' for term given in argument '2' (case insensitive)
# displays paginated result with colored search terms and two lines surrounding each hit.
# Example: mans mplayer codec
# --------------------------------------------------------------------
function mans { man "$1" | grep -iC2 --color=always "$2" | less ; }
# showa: to remind yourself of an alias (given some part of it)
# ------------------------------------------------------------
function showa { /usr/bin/grep --color=always -i -a1 "$@" ~/Library/init/bash/aliases.bash | grep -v '^\s*$' | less -FSRXc ; }
# quiet: mute output of a command
# ------------------------------------------------------------
function quiet {
"$*" &> /dev/null &
}
# lsgrep: search through directory contents with grep
# ------------------------------------------------------------
# shellcheck disable=SC2010
function lsgrep { ls | grep "$*" ; }
# banish-cookies: redirect .adobe and .macromedia files to /dev/null
# ------------------------------------------------------------
function banish-cookies {
rm -r ~/.macromedia ~/.adobe
ln -s /dev/null ~/.adobe
ln -s /dev/null ~/.macromedia
}
# show the n most used commands. defaults to 10
# ------------------------------------------------------------
function hstats {
if [[ $# -lt 1 ]]; then
NUM=10
else
NUM=${1}
fi
history | awk '{print $2}' | sort | uniq -c | sort -rn | head -"$NUM"
}
# -------------------------------
# 2. FILE AND FOLDER MANAGEMENT
# -------------------------------
function zipf { zip -r "$1".zip "$1" ; } # zipf: To create a ZIP archive of a folder
# extract: Extract most know archives with one command
# ---------------------------------------------------------
function extract {
if [ -f "$1" ] ; then
case "$1" in
*.tar.bz2) tar xjf "$1" ;;
*.tar.gz) tar xzf "$1" ;;
*.bz2) bunzip2 "$1" ;;
*.rar) unrar e "$1" ;;
*.gz) gunzip "$1" ;;
*.tar) tar xf "$1" ;;
*.tbz2) tar xjf "$1" ;;
*.tgz) tar xzf "$1" ;;
*.zip) unzip "$1" ;;
*.Z) uncompress "$1" ;;
*.7z) 7z x "$1" ;;
*) echo "'$1' cannot be extracted via extract()" ;;
esac
else
echo "'$1' is not a valid file"
fi
}
# buf: back up file with timestamp
# ---------------------------------------------------------
function buf {
local filename filetime
filename=$1
filetime=$(date +%Y%m%d_%H%M%S)
cp -a "${filename}" "${filename}_${filetime}"
}
# del: move files to hidden folder in tmp, that gets cleared on each reboot
# ---------------------------------------------------------
function del {
mkdir -p /tmp/.trash && mv "$@" /tmp/.trash;
}
# mkiso: creates iso from current dir in the parent dir (unless defined)
# ---------------------------------------------------------
function mkiso {
if _omb_util_command_exists mkisofs; then
if [ -z ${1+x} ]; then
local isoname=${PWD##*/}
else
local isoname=$1
fi
if [ -z ${2+x} ]; then
local destpath=../
else
local destpath=$2
fi
if [ -z ${3+x} ]; then
local srcpath=${PWD}
else
local srcpath=$3
fi
if [ ! -f "${destpath}${isoname}.iso" ]; then
echo "writing ${isoname}.iso to ${destpath} from ${srcpath}"
mkisofs -V "${isoname}" -iso-level 3 -r -o "${destpath}${isoname}.iso" "${srcpath}"
else
echo "${destpath}${isoname}.iso already exists"
fi
else
echo "mkisofs cmd does not exist, please install cdrtools"
fi
}
# ---------------------------
# 3. SEARCHING
# ---------------------------
function ff { /usr/bin/find . -name "$@" ; } # ff: Find file under the current directory
# shellcheck disable=SC2145
function ffs { /usr/bin/find . -name "$@"'*' ; } # ffs: Find file whose name starts with a given string
# shellcheck disable=SC2145
function ffe { /usr/bin/find . -name '*'"$@" ; } # ffe: Find file whose name ends with a given string
function bigfind {
if [[ $# -lt 1 ]]; then
echo_warn "Usage: bigfind DIRECTORY"
return
fi
du -a "$1" | sort -n -r | head -n 10
}
# ---------------------------
# 4. PROCESS MANAGEMENT
# ---------------------------
# findPid: find out the pid of a specified process
# -----------------------------------------------------
# Note that the command name can be specified via a regex
# E.g. findPid '/d$/' finds pids of all processes with names ending in 'd'
# Without the 'sudo' it will only find processes of the current user
# -----------------------------------------------------
function findPid { lsof -t -c "$@" ; }
# my_ps: List processes owned by my user:
# ------------------------------------------------------------
function my_ps { ps "$@" -u "$USER" -o pid,%cpu,%mem,start,time,bsdtime,command ; }
# ---------------------------
# 5. NETWORKING
# ---------------------------
# ips: display all ip addresses for this host
# -------------------------------------------------------------------
function ips {
if _omb_util_command_exists ifconfig
then
ifconfig | awk '/inet /{ print $2 }'
elif _omb_util_command_exists ip
then
ip addr | grep -oP 'inet \K[\d.]+'
else
echo "You don't have ifconfig or ip command installed!"
fi
}
# down4me: checks whether a website is down for you, or everybody
# -------------------------------------------------------------------
function down4me {
curl -s "http://www.downforeveryoneorjustme.com/$1" | sed '/just you/!d;s/<[^>]*>//g'
}
# myip: displays your ip address, as seen by the Internet
# -------------------------------------------------------------------
function myip {
res=$(curl -s checkip.dyndns.org | grep -Eo '[0-9\.]+')
echo -e "Your public IP is: ${_omb_term_bold_green} $res ${_omb_term_normal}"
}
# ii: display useful host related informaton
# -------------------------------------------------------------------
function ii {
echo -e "\\nYou are logged on ${_omb_term_brown}$HOST"
echo -e "\\nAdditionnal information:$NC " ; uname -a
echo -e "\\n${_omb_term_brown}Users logged on:$NC " ; w -h
echo -e "\\n${_omb_term_brown}Current date :$NC " ; date
echo -e "\\n${_omb_term_brown}Machine stats :$NC " ; uptime
[[ "$OSTYPE" == darwin* ]] && echo -e "\\n${_omb_term_brown}Current network location :$NC " ; scselect
echo -e "\\n${_omb_term_brown}Public facing IP Address :$NC " ;myip
[[ "$OSTYPE" == darwin* ]] && echo -e "\\n${_omb_term_brown}DNS Configuration:$NC " ; scutil --dns
echo
}
# ---------------------------------------
# 6. SYSTEMS OPERATIONS & INFORMATION
# ---------------------------------------
# batch_chmod: Batch chmod for all files & sub-directories in the current one
# -------------------------------------------------------------------
function batch_chmod {
echo -ne "${_omb_term_bold_navy}Applying 0755 permission for all directories..."
(find . -type d -print0 | xargs -0 chmod 0755) &
spinner
echo -ne "${_omb_term_normal}"
echo -ne "${_omb_term_bold_navy}Applying 0644 permission for all files..."
(find . -type f -print0 | xargs -0 chmod 0644) &
spinner
echo -ne "${_omb_term_normal}"
}
# usage: disk usage per directory, in Mac OS X and Linux
# -------------------------------------------------------------------
function usage {
if [ "$(uname)" = "Darwin" ]; then
if [ -n "$1" ]; then
du -hd 1 "$1"
else
du -hd 1
fi
elif [ "$(uname)" = "Linux" ]; then
if [ -n "$1" ]; then
du -h --max-depth=1 "$1"
else
du -h --max-depth=1
fi
fi
}
# pickfrom: picks random line from file
# -------------------------------------------------------------------
function pickfrom {
local file=$1
[ -z "$file" ] && reference "$FUNCNAME" && return
length=$(wc -l < "$file")
n=$( ($RANDOM \* "$length" / 32768 + 1))
head -n "$n" "$file" | tail -1
}
# passgen: generates random password from dictionary words
# Note default length of generated password is 4, you can pass it to the command
# E.g. passgen 15
# -------------------------------------------------------------------
# shellcheck disable=SC2046
# shellcheck disable=SC2005
# shellcheck disable=SC2034
# shellcheck disable=SC2086
function passgen {
local i pass length=${1:-4}
pass=$(echo $(for i in $(eval echo "{1..$length}"); do pickfrom /usr/share/dict/words; done))
echo "With spaces (easier to memorize): $pass"
echo "Without (use this as the password): $(echo $pass | tr -d ' ')"
}
# ---------------------------------------
# 7. DATE & TIME MANAGEMENT
# ---------------------------------------
# ---------------------------------------
# 8. WEB DEVELOPMENT
# ---------------------------------------
function httpHeaders { /usr/bin/curl -I -L "$@" ; } # httpHeaders: Grabs headers from web page
# httpDebug: Download a web page and show info on what took time
# -------------------------------------------------------------------
function httpDebug { /usr/bin/curl "$@" -o /dev/null -w "dns: %{time_namelookup} connect: %{time_connect} pretransfer: %{time_pretransfer} starttransfer: %{time_starttransfer} total: %{time_total}\\n" ; }
# ---------------------------------------
# X. REMINDERS & NOTES
# ---------------------------------------
# remove_disk: spin down unneeded disk
# ---------------------------------------
# diskutil eject /dev/disk1s3
# to change the password on an encrypted disk image:
# ---------------------------------------
# hdiutil chpass /path/to/the/diskimage
# to mount a read-only disk image as read-write:
# ---------------------------------------
# hdiutil attach example.dmg -shadow /tmp/example.shadow -noverify
# mounting a removable drive (of type msdos or hfs)
# ---------------------------------------
# mkdir /Volumes/Foo
# ls /dev/disk* to find out the device to use in the mount command)
# mount -t msdos /dev/disk1s1 /Volumes/Foo
# mount -t hfs /dev/disk1s1 /Volumes/Foo
# to create a file of a given size: /usr/sbin/mkfile or /usr/bin/hdiutil
# ---------------------------------------
# e.g.: mkfile 10m 10MB.dat
# e.g.: hdiutil create -size 10m 10MB.dmg
# the above create files that are almost all zeros - if random bytes are desired
# then use: ~/Dev/Perl/randBytes 1048576 > 10MB.dat