Fix shellcheck warnings, pep 8 conformance, improved menu system, fix bug in call to get_zones, improved install/uninstall, bump minor version

Author: doctorfree

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+May 16, 2023 :
+RoonCommandLine version 2.0.8 release 5
+
+    This is a bug fix release:
+        * PEP 8 style guide conformance
+        * Improved interactive menu system
+        * Fix shellcheck warnings
+        * Fix bug in call to get_zones in Get/Set Zone
+
 May 2, 2023 :
 RoonCommandLine version 2.0.8 release 4
 

README.md

@@ -562,7 +562,7 @@ The Roon Command Line install creates two configuration files:
 and
 
     `/usr/local/Roon/etc/roon_api.ini`
-    
+
 These two configuration files are the first place to look when you encounter an issue.
 The /usr/local/Roon/etc/pyroonconf file contains 3 settings:
 
@@ -622,7 +622,7 @@ interface. It accepts a wide variety of arguments and sends a command to the
 Python Roon API system which then communicates with the Roon Core.
 
 If no arguments are provided to the `roon` command then an interactive dialog
-is presented from which the user can select commands and queries. 
+is presented from which the user can select commands and queries.
 
 Here is the current output of "roon -u" which displays a usage message.
 
@@ -760,7 +760,7 @@ If multiple matches are found, the first match in the list is played.
 To narrow a search, exclusion filtering can be performed. Use the `-x string`
 argument to specify an exclusion substring for artist, composer, and playlist
 library searches. Use the `-X string` argument to specify an exclusion
-substring for album and genre library searches. 
+substring for album and genre library searches.
 
 In a large Roon library where multiple matches may be frequent and large,
 one approach is to first list the media you wish to play and based on the
@@ -793,7 +793,7 @@ would list the "Violin Concerto No. 1, Op. 26" by Mozart fist. Alternately,
 would also list the concerto first. Another search route for this album
 would be by searching albums by composer rather than albums by genre:
 
-`roon -l comalbums -C Mozart -A "Violin Concerto"` 
+`roon -l comalbums -C Mozart -A "Violin Concerto"`
 
 Listing/playing media in the Roon Library "Composers" category searches the
 entire Roon database of available Composers rather than limiting the search
@@ -1036,13 +1036,11 @@ of this package will require little to no manual configuration.
 
 [**NOTICE**](NOTICE) - Copyright notice
 
-[**Install**](Install) - Installation script for Linux systems, Debian format install
-
-[**Uninstall**](Uninstall) - Removal script for Linux systems, Debian format uninstall
+[**Install**](Install) - Installation script
 
-[**macInstall**](macInstall) - Installation script for Mac OS
+[**Uninstall**](Uninstall) - Removal script
 
-[**macUninstall**](macUninstall) - Removal script for Mac OS
+[**macInstall**](macInstall) - Installation script for Mac OS (called from `Install`)
 
 [**usage.txt**](usage.txt) - Frontend "roon" script usage documentation
 

Uninstall

@@ -1,18 +1,88 @@
 #!/bin/bash
+#
+# shellcheck disable=SC1090,SC2220,SC2207,SC2068,SC2001
 
-have_fade=`type -p roon_fade`
+uninstall() {
+  LOCAL="/usr/local"
+  APPL=${LOCAL}/share/applications
+  DOC=${LOCAL}/share/doc
+  ROON=${LOCAL}/Roon
+  ROONBIN=${ROON}/bin
+
+  [ -d /usr/local/bin ] && {
+    cd /usr/local/bin || exit 1
+    for command in "${ROONBIN}"/*
+    do
+      [ "${command}" == "${ROONBIN}/*" ] && continue
+      b=$(basename "${command}")
+      [ -L "$b" ] && {
+        /bin/ls -l "$b" | grep ${ROON} > /dev/null && sudo rm -f "$b"
+      }
+    done
+  }
+
+  sudo rm -rf ${ROON}
+  sudo rm -rf ${DOC}/RoonCommandLine
+  sudo rm -f ${APPL}/rooncommand.desktop
+
+  ROON_SITE_DIR=
+  # Check the global site directories
+  have_python3=$(type -p python3)
+  if [ "${have_python3}" ]
+  then
+    SITES=($(sudo python3 -c 'import site; print(site.getsitepackages())' | tr -d '[],'))
+  else
+    SITES=($(sudo python -c 'import site; print(site.getsitepackages())' | tr -d '[],'))
+  fi
+  for site in ${SITES[@]}
+  do
+    site=$(echo "$site" | sed -e "s/'//g")
+    [ -d "${site}"/roonapi ] && {
+      ROON_SITE_DIR=${site}/roonapi
+      break
+    }
+  done
+
+  if [ "$ROON_SITE_DIR" ]
+  then
+    # Roll back the Python Roon API patch if it was applied
+    cd "$ROON_SITE_DIR" || exit 1
+    for i in *.orig
+    do
+      [ "$i" == "*.orig" ] && continue
+      j=$(echo "$i" | sed -e "s/.orig//")
+      sudo mv "$i" "$j"
+    done
+  else
+    echo "Could not locate the roonapi Python module installation directory"
+    echo "Python Roon API patch not reversed."
+  fi
+
+  # Don't uninstall roonapi Python module, they might be using it for something else
+  # if [ "${have_python3}" ]
+  # then
+  #     sudo python3 -m pip uninstall roonapi -y
+  # else
+  #     sudo python -m pip uninstall roonapi -y
+  # fi
+
+  echo ""
+  echo "RoonCommandLine uninstalled"
+}
+
+have_fade=$(type -p roon_fade)
 [ "${have_fade}" ] && roon_fade off
 
-plat=`uname -s`
+plat=$(uname -s)
 if [ "$plat" == "Darwin" ]
 then
-    ./macUninstall
+  uninstall
 else
   debian=
-  have_apt=`type -p apt`
-  have_dpkg=`type -p dpkg`
-  have_rpm=`type -p rpm`
-  have_yum=`type -p yum`
+  have_apt=$(type -p apt)
+  have_dpkg=$(type -p dpkg)
+  have_rpm=$(type -p rpm)
+  have_yum=$(type -p yum)
   [ -f /etc/os-release ] && . /etc/os-release
   [ "${ID_LIKE}" == "debian" ] && debian=1
   [ "${debian}" ] || [ -f /etc/debian_version ] && debian=1
@@ -24,26 +94,27 @@ else
   then
     if [ "${have_apt}" ]
     then
-      sudo apt remove "${PKG}" -y
+      sudo apt remove "${PKG}" -y > /dev/null 2>&1
     else
       if [ "${have_dpkg}" ]
       then
-        sudo dpkg -r "${PKG}"
+        sudo dpkg -r "${PKG}" > /dev/null 2>&1
       else
         echo "Cannot locate either apt or dpkg to remove. Skipping."
       fi
     fi
   else
     if [ "${have_yum}" ]
     then
-      sudo yum remove "${PKG}"
+      sudo yum remove "${PKG}" > /dev/null 2>&1
     else
       if [ "${have_rpm}" ]
       then
-        sudo rpm -e "${PKG}"
+        sudo rpm -e "${PKG}" > /dev/null 2>&1
       else
         echo "Cannot locate either yum or rpm to remove. Skipping."
       fi
     fi
   fi
+  uninstall
 fi

VERSION

@@ -1,2 +1,2 @@
 VERSION=2.0.8
-RELEASE=4
+RELEASE=5

api/get_core_ip.py

@@ -10,7 +10,7 @@
 release = config['DEFAULT']['RoonCommandLineRelease']
 fullver = version + "-" + release
 
-appinfo = {
+app = {
     "extension_id": "roon_command_line",
     "display_name": "Python library for Roon",
     "display_version": fullver,
@@ -21,11 +21,12 @@
 
 discover = RoonDiscovery(None)
 servers = discover.all()
-apis = [RoonApi(appinfo, None, server[0], server[1], False) for server in servers]
+apis = [RoonApi(app, None, server[0], server[1], False) for server in servers]
 
 auth_api = []
 while len(auth_api) == 0:
-    print("\nWaiting for authorization - in Roon, click \033[1mSettings -> Extensions -> Enable\033[0m\n", flush=True)
+    print("\nWaiting for authorization - in Roon, \
+        click \033[1mSettings -> Extensions -> Enable\033[0m\n", flush=True)
     time.sleep(15)
     auth_api = [api for api in apis if api.token is not None]
 

api/get_zone_attributes.py

@@ -3,6 +3,7 @@
 import json
 from os import path
 import sys
+from roonapi import RoonApi
 #
 # Get the volume of a zone's outputs
 #
@@ -18,7 +19,8 @@
 tokenfile = config['DEFAULT']['TokenFileName']
 
 parser = argparse.ArgumentParser()
-parser.add_argument("-g", "--grouped", default=False, action='store_true', help="return attributes for all zones in a grouped zone")
+parser.add_argument("-g", "--grouped", default=False, action='store_true',
+                    help="return attributes for all zones in a grouped zone")
 parser.add_argument("-z", "--zone", help="zone selection")
 args = parser.parse_args()
 
@@ -37,7 +39,6 @@
 release = config['DEFAULT']['RoonCommandLineRelease']
 fullver = version + "-" + release
 
-from roonapi import RoonApi
 appinfo = {
     "extension_id": "roon_command_line",
     "display_name": "Python library for Roon",
@@ -75,19 +76,19 @@
     result = []
     is_grouped = False
     if group is not None:
-      is_grouped = roonapi.is_grouped(output_id)
+        is_grouped = roonapi.is_grouped(output_id)
     if is_grouped:
-      # Get the attributes for all zones in a zone grouping
-      grouped_zone_names = roonapi.grouped_zone_names(output_id)
-      if grouped_zone_names is not None:
-        for zone_name in grouped_zone_names:
-          for (k, v) in outputs.items():
-            if zone_name in v["display_name"]:
-              result.append(v)
+        # Get the attributes for all zones in a zone grouping
+        grouped_zone_names = roonapi.grouped_zone_names(output_id)
+        if grouped_zone_names is not None:
+            for zone_name in grouped_zone_names:
+                for (k, v) in outputs.items():
+                    if zone_name in v["display_name"]:
+                        result.append(v)
     else:
-      # Get the attributes of the specified zone with the specified method
-      for (k, v) in outputs.items():
-        if zone_name in v["display_name"]:
-          result.append(v)
+        # Get the attributes of the specified zone with the specified method
+        for (k, v) in outputs.items():
+            if zone_name in v["display_name"]:
+                result.append(v)
 
     print(json.dumps(result))

api/get_zone_remaining.py

@@ -2,6 +2,7 @@
 import configparser
 from os import path
 import sys
+from roonapi import RoonApi
 #
 # Get the volume of a zone's outputs
 #
@@ -31,7 +32,6 @@
 release = config['DEFAULT']['RoonCommandLineRelease']
 fullver = version + "-" + release
 
-from roonapi import RoonApi
 appinfo = {
     "extension_id": "roon_command_line",
     "display_name": "Python library for Roon",
@@ -70,14 +70,15 @@
 else:
     zone = roonapi.zone_by_output_id(output_id)
     if zone is not None:
-      state = zone["state"]
-      length = zone["now_playing"]["length"]
-      position = zone["now_playing"]["seek_position"]
-      if length is not None:
-        if position is not None:
-          remaining = length - position
+        state = zone["state"]
+        length = zone["now_playing"]["length"]
+        position = zone["now_playing"]["seek_position"]
+        if length is not None:
+            if position is not None:
+                remaining = length - position
 
     if remaining is not None:
-        print(zone_name + ": Time remaining = " + str(remaining) + " seconds, State = " + state)
+        print(zone_name + ": Time remaining = " + str(remaining) +
+              " seconds, State = " + state)
     else:
         print(zone_name + ": State = " + state)

api/list_albums.py

@@ -2,6 +2,7 @@
 import configparser
 from os import path
 import sys
+from roonapi import RoonApi
 
 config = configparser.ConfigParser()
 config.read('/usr/local/Roon/etc/roon_api.ini')
@@ -36,7 +37,6 @@
 release = config['DEFAULT']['RoonCommandLineRelease']
 fullver = version + "-" + release
 
-from roonapi import RoonApi
 appinfo = {
     "extension_id": "roon_command_line",
     "display_name": "Python library for Roon",
@@ -73,12 +73,12 @@
 # List matching albums
 albums = roonapi.list_media(output_id, ["Library", "Albums", albumsearch])
 if exalbumsearch is not None and albums:
-    albums = [chkalbum for chkalbum in albums if not exalbumsearch in chkalbum]
+    albums = [chkalbum for chkalbum in albums if exalbumsearch not in chkalbum]
 if albums:
     if albumsearch == "__all__":
         print("\nAll Albums in Library:\n")
     else:
         print("\nAlbums with", albumsearch, "in title", ":\n")
-    print(*albums, sep = "\n")
+    print(*albums, sep="\n")
 else:
     print("No albums found matching ", albumsearch)