Send a pushover notification from Bash

pushover

#!/bin/bash
# ./pushover.sh  -t "Pushover via Bash" -m "Pushover message sent with bash from $(hostname -f)" -p1  -s siren -u http://www.google.com -n "Google"

USER_TOKEN=YOUR_USER_TOKEN_HERE

# YOUR APPS TOKENS / UPPERCASE NAME WITH _TOKEN (usage: "-a monitor" uses MONITOR_TOKEN)
MONITOR_TOKEN=APP_TOKEN
BACKUP_TOKEN=APP_TOKEN
ALERT_TOKEN=APP_TOKEN
APP_LIST="monitor, backup, alert" # FOR USAGE

APP_ID="monitor" # Default app

# v1.7
# 14-03-2018 : - Request send only necessary fields.
#              - Added message pipe.
#              - Added monospace option.
#              - Default monitor name
# 12-03-2018 : Added image attachment.
# 30-01-2016 : Added -getopts- arguments to set retry/expire.
# 23-04-2015 : HTML markup language option.

VERSION=1.7

usage()
{
cat << EOF

usage: $0 options

Send a notification via pushover.

OPTIONS:
  -a	Application name : "$APP_LIST" (required)
  -m	Message (required)

  -t	Title of your notification
  -d	Send to a specific device name
  -p	Priority of your message : -2 (Silent), -1 (Quiet), 1 (High), 2 (Emergency)
  -s	Sound (https://pushover.net/api#sounds)
  -i  Attach an image (up to 2.5mb)
  -u	URL Link
  -n	URL Title
  -r	Retry (seconds)
  -e	Expire (seconds)

  -f  HTML Format
  -k  Monospace Format
  -x	Debug
  -h	Show this message

EOF
}

ARGS=( -F "user=$USER_TOKEN" )

# MESSAGE PIPE
if [ -p /dev/stdin ]
then
  MESSAGE=$(</dev/stdin)
  ARGS+=( -F "message=$MESSAGE" )
else
  MESSAGE=
fi

TITLE="<empty>"
URL="<empty>"
URL_TITLE="untitled"
PRIORITY=0
RETRY=60
EXPIRE=86400
SOUND="pushover"
HTML=0
MONOSPACE=0
DEVICE="all"
IMAGE=
DEBUG=0

while getopts “hfkvt:r:e:u:n:p:s:m:a:d:i:x” OPTION
do
    case $OPTION in
        t) TITLE=$OPTARG
           ARGS+=( -F "title=$TITLE" ) ;;
        u) URL=$OPTARG
           ARGS+=( -F "url=$URL" ) ;;
        n) URL_TITLE=$OPTARG
           ARGS+=( -F "url_title=$URL_TITLE" ) ;;
        p) PRIORITY=$OPTARG
           ARGS+=( -F "priority=$PRIORITY" ) ;;
        s) SOUND=$OPTARG
           ARGS+=( -F "sound=$SOUND" ) ;;
        f) HTML=1
           ARGS+=( -F "html=$HTML" ) ;;
        k) MONOSPACE=1
           ARGS+=( -F "monospace=$MONOSPACE" ) ;;
        r) [ ! -z $OPTARG ] && RETRY=$OPTARG ;;
        e) [ ! -z $OPTARG ] && EXPIRE=$OPTARG ;;
        d) DEVICE=$OPTARG
           ARGS+=( -F "device=$DEVICE" ) ;;
        i) IMAGE="$OPTARG"
           ARGS+=( -F "attachment=@${IMAGE}" ) ;;
        a)
           APP_ID="$OPTARG"
        ;;
        m)
           if [[ -z $MESSAGE ]]
           then
             MESSAGE=$OPTARG
             ARGS+=( -F "message=$MESSAGE" )
           fi
           ;;
        v) echo "Pushover shell script version ${VERSION}" && exit 1 ;;
        x) DEBUG=1 ;;
        :) echo "Option -$OPTARG requires an argument." >&2; exit 1 ;;
        h) usage; exit 1 ;;
        ?) usage; exit ;;
    esac
done

# APP TOKEN
if [[ ! -z $APP_ID ]]
then
  APP_ID=`echo $APP_ID | tr '[:lower:]' '[:upper:]'`
  APP_NAME="${APP_ID}_TOKEN"
  APP_TOKEN="${!APP_NAME}"
  ARGS+=( -F "token=$APP_TOKEN" )
fi

# EMERGENCY PRIORITY
if [[ $PRIORITY == 2 ]]
then
  ARGS+=( -F "retry=$RETRY" )
  ARGS+=( -F "expire=$EXPIRE" )
fi

# REQUIRED FIELDS
if [[ -z $MESSAGE ]] || [[ -z $APP_TOKEN ]]
then
  echo -e "\n\\033[31mMessage and Application token are required.\\033[0m"
  usage
  exit 1
fi

# DEBUG PRINT
if [[ $DEBUG == 1 ]]
then
  echo "TITLE ...... $TITLE"
  echo "DEVICE ..... $DEVICE"
  echo "URL ........ ${URL} (${URL_TITLE})"
  echo "FORMAT ..... HTML ${HTML} MONOSPACE ${MONOSPACE}"
  echo "APP ........ ID:${APP_ID} TOKEN:${APP_TOKEN}"
  echo "PRIORITY ... $PRIORITY"
  if [[ $PRIORITY == 2 ]]
  then
  echo "RETRY ...... $RETRY"
  echo "EXPIRE ..... $EXPIRE"
  fi
  echo "SOUND ...... $SOUND"
  echo "IMAGE  ..... $IMAGE"
  echo "MESSAGE -----------------------------------------"
  echo "${MESSAGE}"
  echo "-------------------------------------------------"
  exit 0
fi

# SEND NOTIFICATION
curl -s "${ARGS[@]}" https://api.pushover.net/1/messages.json

First off, THANK YOU for your script. It saved me a lot of hassle in getting my other scripts to send me notifications.

The ONLY problem I discovered just today with your script is that it doesn't work if the message starts with an opening parentheses character.

Thanks!

Thanks. Could you give me an exemple of the command line ?

Sure thing! The command I was trying to send through looked like this:

pushover -m "($runcount/$totalcount) Encode completed!"$'\n'"$i"$'\n'"Elapsed: $runtime"

$runcount is numerical (i.e. "9")
$totalcount is numerical (i.e. "40")
$i is a filename string (i.e. "The Matrix (1999).mkv")
$runtime is a calculated elapsed time string (i.e. "1h 37m 22s")

It failed every single time until I moved the leading parenthesis and ONLY started the pushover message with an alphanumeric character (0-9,a-z, A-Z).

Once I figured out it was barfing on the parenthesis, I reworded to include the $runcount and $totalcount AFTER some text, but still enclosed in parentheses - No issues whatsoever.

Oh. I should also mention that I tried a few ways to escape the parenthesis as well...all failed.