#!/usr/bin/bash

# heos-qclear  Copyright 2025-2026  Norman Carver

# Script program to Clear the Queue on a HEOS player/group.
#
# A player is specified with:
# (1) a (sub)string of the player's HEOS name, or
# (2) its IP num (i.e., host portion of its dotted quad IP address).
#
# With the -g option, a group is specified:
# (1) a (sub)string of the group's HEOS name, or
# (2) its Group ID (GID).
#
# Sends commands to the default HEOS master device, but can select alternative
# using the MASTER_IPNUM argument option.


function print_usage()
{
    echo -e "Clear the Queue list of a HEOS Player/Group.\n" >&2
    echo    "Usage: heos-qclear [-g] PLAYER [MASTER_IPNUM]" >&2
    echo    "where:" >&2
    echo    "  PLAYER -- a HEOS Player's Name (substring) or its IPNUM;" >&2
    echo    "  MASTER_IPNUM -- use a non-default HEOS master device;" >&2
    echo -e "  (IPNUM means the last quad of an IP address only: i.e., 0--255.)\n" >&2
    echo    "Options:" >&2
    echo    "  -g -- group: PLAYER is a group Name or GID;" >&2
}


if [[ "$1" == --help ]]; then
    print_usage
    exit 0
fi

# Process supplied options:
pgopt=--player
pidopt=""
debugopt=""
while [[ "$1" == -* ]]; do
    if [[ "$1" == -g ]]; then
        pgopt=--group
    elif [[ "$1" == --pid=?* ]]; then
        pidopt=$1
    elif [[ "$1" == -- ]]; then
        shift;break
    elif [[ "$1" == --debug ]]; then
        debugopt=--debug
    else
        echo "Error: invalid option '$1'" >&2
        echo "(use '--' to signal end of options, with -* arguments)" >&2
        exit 1
    fi
    shift
done

# Process command arguments:
if [[ $# == 0 || $# -gt 2 ]]; then
    print_usage
    exit 1
fi

player=$1
if [[ $# == 2 ]]; then
    master=${2}
else
    master=""
fi
heosdir=$(dirname "$0")


# heosutil-run-command error checking function (one json output):
# args: 1) command result variable; 2) error message; [3) error action]
# (default action on error is 'exit 1', use $3 of 'return 1' to continue execution)
function error_check_run_command()
{
    cmdresult=${!1}
    if [[ ($? != 0) || ("$cmdresult" != *'"result": "success"'*) ]]; then
        if [[ "$cmdresult" == Error:* || ($debugopt == --debug && "$cmdresult" == ERROR:*) ]]; then
            echo "$cmdresult" >&2
        fi
        if [[ -n "$2" ]]; then echo "$2" >&2; fi
        if [[ $# == 3 ]]; then $3; else exit 1; fi
    else
        return 0
    fi
}


# Clear Queue list:
qjson=$("$heosdir"/heosutils/heosutil-run-command ${pgopt}="$player" $pidopt "heos://player/clear_queue?pid=\${pid}" $master)
if ! error_check_run_command qjson "" "return 1"; then
    # Get Queue to check if it is empty:
    qjson=$("$heosdir"/heosutils/heosutil-run-command ${pgopt}="$player" $pidopt "heos://player/get_queue?pid=\${pid}" $master)
    if error_check_run_command qjson "" "return 1" && [[ "$qjson" == *'&count=0"'* ]]; then
        echo "Error: Queue is Empty on HEOS player '$player'!" >&2
    else
        echo "Error: failed Clearing Queue on HEOS player '$player'!" >&2
    fi
    exit 1
fi

echo "Clearing Queue on HEOS player '$player'..." >&2

#EOF
