smokeping.sh

#!/usr/bin/env bash
#===============================================================================
#          FILE: smokeping.sh
#
#         USAGE: ./smokeping.sh
#
#   DESCRIPTION: Entrypoint for smokeping docker container
#
#       OPTIONS: ---
#  REQUIREMENTS: ---
#          BUGS: ---
#         NOTES: ---
#        AUTHOR: David Personette (dperson@gmail.com),
#  ORGANIZATION:
#       CREATED: 2014-10-16 02:56
#      REVISION: 1.0
#===============================================================================

set -o nounset                              # Treat unset variables as an error

### gmail: Configure ssmtp for gmail
# Arguments:
#   user) gmail user
#   pass) gmail password
# Return: ssmtp will be able to send mail
gmail() { local user="$1" pass="$2" aliasfile=/etc/ssmtp/revaliases \
            conf=/etc/ssmtp/ssmtp.conf
    sed -i '/^root/d' $aliasfile
    echo "root:${user}+smokeping@gmail.com:smtp.gmail.com:587" >>$aliasfile

    sed -i 's|^\(root=\).*|\1'"$user"'+smokeping@gmail.com|
                s|^\(mailhub=\).*|\1smtp.gmail.com:587|
                s|^#*\(rewriteDomain=\).*|\1gmail.com|
                s|^\(hostname=\).*|\1localhost|
                /TLS/,/AuthPass/d
                /^hostname=localhost$/a \
\
# Use SSL/TLS before starting negotiation\
#UseTLS=Yes\
UseSTARTTLS=Yes\
\
# Username/Password\
AuthUser='"$user"'\
AuthPass='"$pass"'

                s|^#*\(FromLineOverride=\).*|\1YES|' $conf
}

### email: Configure owners email address
# Arguments:
#   email) your email address
# Return: setup owners email
email() { local email="$1" file=/etc/smokeping/config.d/General
    sed -i "s|^\(contact  = \).*|\\1$email|" $file
}

### owner: Configure owners name
# Arguments:
#   name) your name
# Return: setup owners name
owner() { local name="$1" file=/etc/smokeping/config.d/General
    sed -i "s|^\(owner    = \).*|\\1$name|" $file
}

### pingcount: Configure the ping count
# Arguments:
#   ping_count) ping count
# Return: setup ping count in /etc/smokeping/config.d/Database
pingcount() { local ping_count="$1" file=/etc/smokeping/config.d/Database
    sed -i "s|^\(pings.*=\).*$|\1 $ping_count|g" $file
}

### dbstep: Configure the default DB Step interval
# Arguments:
#   step_time) DB step time in seconds
# Return: setup DB step time in /etc/smokeping/config.d/Database
dbstep() { local step_time="$1" file=/etc/smokeping/config.d/Database
    sed -i "s|^\(step.*=\).*$|\1 $step_time|g" $file
}

### target: Configure a smokeping target
# Arguments:
#   site) name for site of tests
#   name) name for check
#   target) hostname or IP to check
#   alert) send emails on failures
# Return: setup smokeping target
target() { local site="$1" name="$2" target="$3" alert="${4:-""}" line="" \
            file=/etc/smokeping/config.d/Targets
    ## Site
    grep -q "^+ $site\$" $file || sed -i '$a \
\
+ '"$site"'\
menu = '"$site"'\
title = '"$site Network"'
                ' $file

    ## Target
    sed -i '/^++ '"$name"'$/,/^$/d; /^++ '"$name"'$/,$d' $file
    line="$(grep -n "^+ " $file | cut -d: -f1 |
                sed "0,/^$(grep -n "^+ $site\$" $file | cut -d: -f1)\$/d" |
                head -n 1 | grep '[0-9]' || echo '$')"
    sed -i "$line"'a \
\
++ '"$name"'\
menu = '"$name"'\
title = '"$name"'\
host = '"$target"'\
'"$([[ "${alert:-""}" ]] && echo "alerts = someloss")"'
                ' $file
    grep -iq '^http:' <<< "$target" && sed -i '/^host = '"${target/*\//.*}"'$/i\
probe = EchoPingHttp
                ' $file
    grep -iq '^https:' <<<"$target" && sed -i '/^host = '"${target/*\//.*}"'$/i\
probe = EchoPingHttps
                ' $file
}

### timezone: Set the timezone for the container
# Arguments:
#   timezone) for example EST5EDT
# Return: the correct zoneinfo file will be symlinked into place
timezone() { local timezone="${1:-EST5EDT}"
    [[ -e /usr/share/zoneinfo/$timezone ]] || {
        echo "ERROR: invalid timezone specified: $timezone" >&2
        return
    }

    if [[ -w /etc/timezone && $(cat /etc/timezone) != $timezone ]]; then
        echo "$timezone" >/etc/timezone
        ln -sf /usr/share/zoneinfo/$timezone /etc/localtime
        dpkg-reconfigure -f noninteractive tzdata >/dev/null 2>&1
    fi
}

### wipe: wipe out the current targets
# Arguments:
#   none)
# Return: no defined targets
wipe() { local file=/etc/smokeping/config.d/Targets
    sed -i '/^+/,$d' $file
}

### usage: Help
# Arguments:
#   none)
# Return: Help text
usage() { local RC="${1:-0}"
    echo "Usage: ${0##*/} [-opt] [command]
Options (fields in '[]' are optional, '<>' are required):
    -h          This help
    -c \"<count>\" Configure the default ping count
                possible arg: \"[integer]\" - ping count
    -e \"<email>\" Configure email address for owner of smokeping
                required arg: \"<email>\" - your email address
    -o \"<name>\" Configure name of the owner of smokeping
                required arg: \"<name>\" - your name
    -g \"<user;pass>\" Configure ssmtp so that email alerts can be sent
                required arg: \"<user>\" - your gmail username
                required arg: \"<pass>\" - your gmail password of app password
                These are only set in your docker container
    -s \"<step>\" Configure the time step for DB entries
                possible arg: \"[integer]\" - time step in seconds
    -t \"<site;name;target>[;alert]\" Configure smokeping targets
                required arg: \"<site>\" - name for site of tests
                required arg: \"<name>\" - name for check
                required arg: \"<target>\" - hostname or IP to check
                            Targets can also be http:// or https:// URLs
                possible arg: \"[alert]\" - send emails on failures
    -T \"\"       Configure timezone
                possible arg: \"[timezone]\" - zoneinfo timezone for container
    -w          Wipe the targets clean

The 'command' (if provided and valid) will be run instead of smokeping
" >&2
    exit $RC
}

while getopts ":hg:e:o:c:s:t:T:w" opt; do
    case "$opt" in
        h) usage ;;
        c) pingcount "$OPTARG" ;;
        g) eval gmail $(sed 's/^\|$/"/g; s/;/" "/g' <<< $OPTARG) ;;
        e) email "$OPTARG" ;;
        o) owner "$OPTARG" ;;
        s) dbstep "$OPTARG" ;;
        t) eval target $(sed 's/^\|$/"/g; s/;/" "/g' <<< $OPTARG) ;;
        T) timezone "$OPTARG" ;;
        w) wipe ;;
        "?") echo "Unknown option: -$OPTARG"; usage 1 ;;
        ":") echo "No argument value for option: -$OPTARG"; usage 2 ;;
    esac
done
shift $(( OPTIND - 1 ))

[[ "${WIPE:-""}" ]] && wipe
[[ "${SSMTP_GMAIL:-""}" ]] && eval gmail $(sed 's/^\|$/"/g; s/;/" "/g' <<< \
            $SSMTP_GMAIL)
[[ "${EMAIL:-""}" ]] && email "$EMAIL"
[[ "${OWNER:-""}" ]] && owner "$OWNER"
[[ "${PING:-""}" ]] && pingcount "$PING"
[[ "${STEP:-""}" ]] && dbstep "$STEP"
[[ "${TARGET:-""}" ]] && eval target $(sed 's/^\|$/"/g; s/;/" "/g' <<< $TARGET)
[[ "${TZ:-""}" ]] && timezone "$TZ"
[[ "${USERID:-""}" =~ ^[0-9]+$ ]] && usermod -u $USERID -o smokeping
[[ "${GROUPID:-""}" =~ ^[0-9]+$ ]] && groupmod -g $GROUPID -o smokeping

mkdir -p /run/smokeping
[[ -p /tmp/log ]] || mkfifo -m 0660 /tmp/log
chown -Rh smokeping:www-data /var/cache/smokeping /var/lib/smokeping \
            /run/smokeping /tmp/log 2>&1 | grep -iv 'Read-only' || :
chmod -R g+ws /var/cache/smokeping /var/lib/smokeping /run/smokeping 2>&1 |
            grep -iv 'Read-only' || :

if [[ $# -ge 1 && -x $(which $1 2>&-) ]]; then
    exec "$@"
elif [[ $# -ge 1 ]]; then
    echo "ERROR: command not found: $1"
    exit 13
elif ps -ef | egrep -v 'grep|smokeping.sh' | grep -q smokeping; then
    echo "Service already running, reloading configuration"
    su -l ${SPUSER:-smokeping} -s /bin/bash -c \
                "exec /usr/sbin/smokeping --reload"
    kill -HUP "$(pidof lighttpd-angel)"
else
    tail -F /tmp/log &
    su -l ${SPUSER:-smokeping} -s /bin/bash -c \
                "exec /usr/sbin/smokeping --logfile=/tmp/log ${DEBUG:+--debug}"
    exec lighttpd-angel -D -f /etc/lighttpd/lighttpd.conf
fi