Reorganised code, added procedures support and graceful shutdown

welcomehome

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-##### FUNCTIONS #####
+##### SNIPPETS #####
 
 log() {
     # Beautiful logs
@@ -8,6 +8,12 @@ log() {
     echo "[$date]" $1
 }
 
+display_err_arg() {
+    echo "Usage: welcomehome --start $(tput smul)configuration file$(tput rmul)"
+    echo "OR"
+    echo "Usage: welcomehome --stop"
+}
+
 parse_arg() {
     # Echoes the value of a given parameter in a given configuration file
     value=$(cat $1 | grep -E "^$2" | cut -d"=" -f2)
@@ -23,18 +29,11 @@ check_url() {
     return $?
 }
 
-check_volume() {
-    # Check if the volume value is valid
-    if [ $1 -gt 100 ] || [ $1 -lt 0 ]; then
-        echo "Invalid volume value"
-        exit 1
-    fi
-}
+##### STREAM CONTROL #####
 
 set_volume() {
     # Set the volume to the right value
     volume=$1
-    check_volume $volume
     log "Set volume to $volume"
 
     data='{"jsonrpc": "2.0", "id": 1, "method": "core.mixer.set_volume", "params": [VOLUME]}'
@@ -61,9 +60,6 @@ play_stream() {
     # Play dat sound
     curl -s -d "$data" http://localhost:6680/mopidy/rpc > /dev/null
     curl -s -d '{"jsonrpc": "2.0", "id": 1, "method": "core.playback.play"}' http://localhost:6680/mopidy/rpc > /dev/null
-
-    # The right music at the righ volume. Nothing's more perfect.
-    set_volume $2
 }
 
 stop_stream() {
@@ -72,48 +68,100 @@ stop_stream() {
     log "Stream stopped"
 }
 
-##### PROGRAM #####
+##### CONTROLLERS #####
 
-if [[ $# -eq 0 || ! -f $1 ]]; then
-    echo "I need a config file as first argument"
-    exit 1
-fi
+start_playing() {
+    touch $lock_file
+    play_stream $stream
+}
 
-config_file=$1
+stop_playing() {
+    if [ -f $lock_file ]; then
+        rm $lock_file
+    fi
+    stop_stream
+}
 
-log "Parsing the configuration file"
+##### MAIN FUNCTIONS #####
 
-# Get parameters from the given configuration file
-volume=$(parse_arg $config_file "volume")
-stream=$(parse_arg $config_file "stream")
-threshold=$(parse_arg $config_file "device_threshold")
-address=$(parse_arg $config_file "device_address")
+init() {
+    # Initialise the variables
+    config_file=$1
 
-if [ ! $(check_url $stream) ]; then
-    echo "Incorrect stream address"
-    exit 1
-fi
+    # Check if the config file exists
+    if [ ! -f $config_file ]; then
+        echo "$config_file is not a file"
+        exit 1
+    fi
+
+    log "Parsing the configuration file"
 
-log "Initialisation complete"
+    # Get parameters from the given configuration file
+    volume=$(parse_arg $config_file "volume")
+    stream=$(parse_arg $config_file "stream")
+    threshold=$(parse_arg $config_file "device_threshold")
+    address=$(parse_arg $config_file "device_address")
 
-while true; do
-    # Lock file
-    lock_file="/etc/welcomehome/home.lck"
+    # Check stream URL validity
+    if [ ! $(check_url $stream) ]; then
+        echo "Incorrect stream address"
+        exit 1
+    fi
 
-    count=$(ping -W 1 -c $threshold $address | grep ttl | wc -l)
+    # Check volume value validity
+    if [ $volume -gt 100 ] || [ $volume -lt 0 ]; then
+        echo "Invalid volume value"
+        exit 1
+    fi
 
-    if [ $count -gt 0 ]; then
-        # Lock file present = music already playing
-        if [ ! -f $lock_file ]; then
-            log "Device detected"
-            play_stream $stream $volume
-            touch $lock_file
-        fi
-    else
-        if [ -f $lock_file ]; then
-            log "Device lost"
-            stop_stream
-            rm $lock_file
+    # Set volume to the right value
+    set_volume $volume
+
+    log "Initialisation complete"
+}
+
+main() {
+    #Main loop
+    log "Looking for device"
+    while true; do
+        # Polling the device's IP address
+        count=$(ping -W 1 -c $threshold $address | grep ttl | wc -l)
+
+        if [ $count -gt 0 ]; then
+            # Lock file present = music already playing
+            if [ ! -f $lock_file ]; then
+                log "Device detected"
+                start_playing
+            fi
+        else
+            if [ -f $lock_file ]; then
+                log "Device lost"
+                stop_playing
+            fi
         fi
-    fi
-done
+    done
+}
+
+##### PROGRAM #####
+
+if [ $# -eq 0 ] || [ $# -gt 2 ]; then
+    echo "Wrong arguments number"
+    display_err_arg
+    exit 1
+fi
+
+# Setting lock file path
+lock_file="/etc/welcomehome/home.lck"
+
+# Check if we know the requested feature
+case "$1" in
+    "--start") init $2
+               main
+               ;;
+    "--stop") stop_playing
+              ;;
+    *) echo "Unknown argument $1"
+       display_err_arg
+       ;;
+esac
+

welcomehome.service

@@ -4,8 +4,8 @@ After=mopidy.service
 Requires=mopidy.service
 [Service]
 Type=simple
-ExecStart=/usr/local/bin/welcomehome /etc/welcomehome/welcomehome.conf
-ExecStopPost=-/bin/rm /etc/welcomehome/home.lck
+ExecStart=/usr/local/bin/welcomehome --start /etc/welcomehome/welcomehome.conf
+ExecStopPost=/usr/local/bin/welcomehome --stop
 Restart=on-abort
 [Install]
 WantedBy=multi-user.target