Skip to content

Refactor: Where possible, utilise native xq flags for XML parsing and extraction #406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Crosenhain wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Refactor: Where possible, utilise native xq flags for XML parsing and extraction #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
adb69d5
Extract arr config elements with xq -x and the XPath expression
Crosenhain Feb 23, 2026
bf15254
Use xq to parse XML into JSON, then use jq to do the rest since it ca…
Crosenhain Feb 23, 2026
699a955
Some more fixes to the universal functions that help with lidarr support
Crosenhain Feb 24, 2026
235ae96
fixing extra spacing
Crosenhain Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions lidarr/PlexNotify.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,26 @@ plexConnectionError () {
}

# Validate connection
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . | jq -r '.MediaContainer."@version"')
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq -x //MediaContainer/@version)
if [ "$plexVersion" == "null" ]; then
# Error out if version is null, indicates bad token
plexConnectionError
else
log "Plex Connection Established, version: $plexVersion"
fi
else
# Error out if error in curl | xq . command output
# Error out if error in curl | xq command output
plexConnectionError
fi

plexLibraries="$(curl -s "$plexUrl/library/sections?X-Plex-Token=$plexToken")"
if echo "$plexLibraries" | xq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")")
elif echo "$plexLibraries" | xq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")")
if echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")")
elif echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")")
else
log "ERROR: No Plex Music Type libraries found"
log "ERROR: Exiting..."
Expand Down
6 changes: 3 additions & 3 deletions radarr/Extras.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ fi


if [ -z "$arrUrl" ] || [ -z "$arrApiKey" ]; then
arrUrlBase="$(cat /config/config.xml | xq | jq -r .Config.UrlBase)"
arrUrlBase="$(cat /config/config.xml | xq -x //Config/UrlBase)"
if [ "$arrUrlBase" == "null" ]; then
arrUrlBase=""
else
arrUrlBase="/$(echo "$arrUrlBase" | sed "s/\///g")"
fi
arrApiKey="$(cat /config/config.xml | xq | jq -r .Config.ApiKey)"
arrPort="$(cat /config/config.xml | xq | jq -r .Config.Port)"
arrApiKey="$(cat /config/config.xml | xq -x //Config/ApiKey)"
arrPort="$(cat /config/config.xml | xq -x //Config/Port)"
arrUrl="http://127.0.0.1:${arrPort}${arrUrlBase}"
fi

Expand Down
14 changes: 7 additions & 7 deletions radarr/PlexNotify.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,26 +57,26 @@ PlexConnectionError () {
}

# Validate connection
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . | jq -r '.MediaContainer."@version"')
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq -x //MediaContainer/@version)
if [ "$plexVersion" == "null" ]; then
# Error out if version is null, indicates bad token
PlexConnectionError
else
log "Plex Connection Established, version: $plexVersion"
fi
else
# Error out if error in curl | xq . command output
# Error out if error in curl | xq command output
PlexConnectionError
fi

plexLibraries="$(curl -s "$plexUrl/library/sections?X-Plex-Token=$plexToken")"
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory")
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory")
if echo "$plexLibraryData" | grep "^\[" | read; then
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory[]")
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory[]" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | jq ".MediaContainer.Directory[]")
plexKeys=($(echo "$plexLibraries" | jq ".MediaContainer.Directory[]" | jq -r '."@key"'))
else
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory" | jq -r '."@key"'))
plexKeys=($(echo "$plexLibraries" | jq ".MediaContainer.Directory" | jq -r '."@key"'))
fi

if echo "$plexLibraryData" | grep "\"@path\": \"$arrRootFolderPath" | read; then
Expand Down
18 changes: 9 additions & 9 deletions readarr/PlexNotify.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,26 @@ plexConnectionError () {
}

# Validate connection
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . | jq -r '.MediaContainer."@version"')
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq -x //MediaContainer//@version)
if [ "$plexVersion" == "null" ]; then
# Error out if version is null, indicates bad token
plexConnectionError
else
log "Plex Connection Established, version: $plexVersion"
fi
else
# Error out if error in curl | xq . command output
# Error out if error in curl | xq command output
plexConnectionError
fi

plexLibraries="$(curl -s "$plexUrl/library/sections?X-Plex-Token=$plexToken")"
if echo "$plexLibraries" | xq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")")
elif echo "$plexLibraries" | xq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")")
if echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory | select(.\"@type\"==\"artist\")")
elif echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" &>/dev/null; then
plexKeys=($(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[] | select(.\"@type\"==\"artist\")")
else
log "ERROR: No Plex Music Type libraries found"
log "ERROR: Exiting..."
Expand Down
14 changes: 7 additions & 7 deletions sonarr/PlexNotify.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,26 +57,26 @@ plexConnectionError () {
}

# Validate connection
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq . | jq -r '.MediaContainer."@version"')
if curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq &>/dev/null; then
plexVersion=$(curl -s "$plexUrl/?X-Plex-Token=$plexToken" | xq -x //MediaContainer/@version)
if [ "$plexVersion" == "null" ]; then
# Error out if version is null, indicates bad token
plexConnectionError
else
log "Plex Connection Established, version: $plexVersion"
fi
else
# Error out if error in curl | xq . command output
# Error out if error in curl | xq command output
plexConnectionError
fi

plexLibraries="$(curl -s "$plexUrl/library/sections?X-Plex-Token=$plexToken")"
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory")
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory")
if echo "$plexLibraryData" | grep "^\[" | read; then
plexLibraryData=$(echo "$plexLibraries" | xq ".MediaContainer.Directory[]")
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory[]" | jq -r '."@key"'))
plexLibraryData=$(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[]")
plexKeys=($(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory[]" | jq -r '."@key"'))
else
plexKeys=($(echo "$plexLibraries" | xq ".MediaContainer.Directory" | jq -r '."@key"'))
plexKeys=($(echo "$plexLibraries" | xq -j | jq ".MediaContainer.Directory" | jq -r '."@key"'))
fi

if echo "$plexLibraryData" | grep "path" | grep "$arrRootFolderPath" | read; then
Expand Down
44 changes: 22 additions & 22 deletions universal/functions.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,41 +19,41 @@ logfileSetup () {
}

getArrAppInfo () {
# Get Arr App information
if [ -z "$arrUrl" ] || [ -z "$arrApiKey" ]; then
arrUrlBase="$(cat /config/config.xml | xq | jq -r .Config.UrlBase)"
if [ "$arrUrlBase" == "null" ]; then
arrUrlBase="$(xq -x //Config/UrlBase < /config/config.xml)"
arrName="$(xq -x //Config/InstanceName < /config/config.xml)"
arrApiKey="$(xq -x //Config/ApiKey < /config/config.xml)"
arrPort="$(xq -x //Config/Port < /config/config.xml)"
if [ "$arrUrlBase" == "null" ] || [ -z "$arrUrlBase" ] || [ "$arrUrlBase" == "/" ]; then
arrUrlBase=""
else
arrUrlBase="/$(echo "$arrUrlBase" | sed "s/\///")"
arrUrlBase=$(echo "$arrUrlBase" | sed -e 's/^\/*//' -e 's/\/*$//')
arrUrlBase="/$arrUrlBase"
fi
arrName="$(cat /config/config.xml | xq | jq -r .Config.InstanceName)"
arrApiKey="$(cat /config/config.xml | xq | jq -r .Config.ApiKey)"
arrPort="$(cat /config/config.xml | xq | jq -r .Config.Port)"
arrUrl="http://127.0.0.1:${arrPort}${arrUrlBase}"
fi
arrUrl="${arrUrl%/}"
}

verifyApiAccess () {
if ! command -v curl >/dev/null 2>&1 || ! command -v jq >/dev/null 2>&1; then
log "Fatal: 'curl' or 'jq' is not installed."
return 1
fi
until false
do
arrApiTest=""
arrApiVersion=""
if [ -z "$arrApiTest" ]; then
arrApiVersion="v3"
arrApiTest="$(curl -s "$arrUrl/api/$arrApiVersion/system/status?apikey=$arrApiKey" | jq -r .instanceName)"
fi
if [ -z "$arrApiTest" ]; then
arrApiVersion="v1"
arrApiTest="$(curl -s "$arrUrl/api/$arrApiVersion/system/status?apikey=$arrApiKey" | jq -r .instanceName)"
fi
if [ ! -z "$arrApiTest" ]; then
break
else
log "$arrName is not ready, sleeping until valid response..."
sleep 1
fi
for arrApiVersion in "v3" "v1"; do
echo "$arrUrl/api/$arrApiVersion/system/status?apikey=$arrApiKey"
arrApiTest="$(curl -s "$arrUrl/api/$arrApiVersion/system/status?apikey=$arrApiKey" | jq -r '.instanceName // empty' 2>/dev/null)"
if [ -n "$arrApiTest" ]; then
break 2
fi
done
log "$arrName is not ready, sleeping until valid response..."
sleep 1
done
log "$arrName ($arrApiTest) is ready!"
}

ConfValidationCheck () {
Expand Down