Initial commit

Author: zhengpd

README.md

@@ -0,0 +1,49 @@
+# bash-bgnotify
+
+Cross-platform background notifications for long running commands! Supports OSX and Ubuntu linux.
+
+Forked from Tim O'Brien's awesome [zsh-background-notify](https://github.com/t413/zsh-background-notify) and slightly modified for Bash.
+
+## How to use!
+
+1. Install Bash-Preexec following the instructions on <https://github.com/rcaloras/bash-preexec#install>
+2. Clone the repository:
+  * `git clone https://github.com/zhengpd/bash-bgnotify.git ~/.bash-bgnotify`
+3. And add one line your `.bashrc`:
+  * `source $HOME/.bash-bgnotify/bgnotify.plugin.bash`
+4. Done!
+
+## Requirements:
+
+- On OS X you'll need [terminal-notifer](https://github.com/alloy/terminal-notifier)
+  * `brew install terminal-notifier` (or `gem install terminal-notifier`)
+- On ubuntu you're already all set!
+- On windows you can use [notifu](http://www.paralint.com/projects/notifu/) or the Cygwin Ports `libnotify` package
+
+## Configuration
+
+One can configure a few things:
+
+- `bgnotify_threshold` sets the notification threshold time (default 6 seconds)
+- `function notify_formatted` lets you change the notification
+
+Use these by adding a function definition before the your call to source. Example:
+
+~~~ sh
+bgnotify_threshold=4  ## set your own notification threshold
+
+function notify_formatted {
+  ## $1=exit_status, $2=command, $3=elapsed_time
+  [ $1 -eq 0 ] && title="Holy Smokes Batman!" || title="Holy Graf Zeppelin!"
+  bgnotify "$title -- after $3 s" "$2";
+}
+
+source $HOME/.bash-bgnotify/bgnotify.plugin.bash
+~~~
+
+
+## How it works
+
+[Bash-Preexec](https://github.com/rcaloras/bash-preexec) provides two hook functions for Bash in the style of Zsh: `preexec` that runs before executing a command and `precmd` that runs just before re-prompting. Timing the difference between them gives you execution time!
+
+To check if you're in the background we can use xprop to find the NET_ACTIVE_WINDOW in ubuntu and osascript to run a simple apple script to get the same thing (although slower).

bgnotify.plugin.bash

@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+
+## setup ##
+
+[[ $- != *i* ]] && return # interactive only!
+
+(( ${bgnotify_threshold} )) || bgnotify_threshold=3 #default 3 seconds
+
+
+## definitions ##
+
+if ! type -t bgnotify_formatted 1>/dev/null; then ## allow custom function override
+  function bgnotify_formatted { ## args: (exit_status, command, elapsed_seconds)
+    elapsed="$(( $3 % 60 ))s"
+    (( $3 >= 60 )) && elapsed="$((( $3 % 3600) / 60 ))m $elapsed"
+    (( $3 >= 3600 )) && elapsed="$(( $3 / 3600 ))h $elapsed"
+    [ $1 -eq 0 ] && bgnotify "#win (took $elapsed)" "$2" || bgnotify "#fail (took $elapsed)" "$2"
+  }
+fi
+
+get_timestamp() {
+  date +%s
+}
+
+currentWindowId () {
+  if hash osascript 2>/dev/null; then #osx
+    osascript -e 'tell application (path to frontmost application as text) to id of front window' 2> /dev/null || echo "0"
+  elif (hash notify-send 2>/dev/null || hash kdialog 2>/dev/null); then #ubuntu!
+    xprop -root 2> /dev/null | awk '/NET_ACTIVE_WINDOW/{print $5;exit} END{exit !$5}' || echo "0"
+  else
+    echo $(get_timestamp) # fallback for windows
+  fi
+}
+
+bgnotify () { ## args: (title, subtitle)
+  tput bel # ring the bell
+
+  if hash terminal-notifier 2>/dev/null; then #osx
+    [[ "$TERM_PROGRAM" == 'iTerm.app' ]] && term_id='com.googlecode.iterm2';
+    [[ "$TERM_PROGRAM" == 'Apple_Terminal' ]] && term_id='com.apple.terminal';
+    ## now call terminal-notifier, (hopefully with $term_id!)
+    [ -z "$term_id" ] && terminal-notifier -message "$2" -title "$1" >/dev/null ||
+    terminal-notifier -message "$2" -title "$1" -activate "$term_id" -sender "$term_id" >/dev/null
+  elif hash growlnotify 2>/dev/null; then #osx growl
+    growlnotify -m "$1" "$2"
+  elif hash notify-send 2>/dev/null; then #ubuntu gnome!
+    notify-send "$1" "$2"
+  elif hash kdialog 2>/dev/null; then #ubuntu kde!
+    kdialog  -title "$1" --passivepopup  "$2" 5
+  elif hash notifu 2>/dev/null; then #cygwyn support!
+    notifu /m "$2" /p "$1"
+  fi
+}
+
+
+## Hooks ##
+
+bgnotify_begin() {
+  bgnotify_timestamp=$(get_timestamp)
+  bgnotify_lastcmd="$1"
+  bgnotify_windowid=$(currentWindowId)
+}
+
+bgnotify_end() {
+  didexit=$?
+  elapsed=$(( $(get_timestamp) - bgnotify_timestamp ))
+  past_threshold=$(( elapsed >= bgnotify_threshold ))
+  if (( bgnotify_timestamp > 0 )) && (( past_threshold )); then
+    if [ $(currentWindowId) != "$bgnotify_windowid" ]; then
+      bgnotify_formatted "$didexit" "$bgnotify_lastcmd" "$elapsed"
+    fi
+  fi
+  bgnotify_timestamp=0 #reset it to 0!
+}
+
+## only enable if a local (non-ssh) connection
+if [ -z "$SSH_CLIENT" ] && [ -z "$SSH_TTY" ]; then
+  preexec_functions+=(bgnotify_begin)
+  precmd_functions+=(bgnotify_end)
+fi