Parse JSON with JQ (#437)

* feat: Parse JSON with JQ

.github/workflows/build.yml

@@ -74,7 +74,7 @@ jobs:
           context: .
           push: true
           provenance: false
-          platforms: linux/amd64,linux/arm64
+          platforms: linux/amd64,linux/arm64,linux/arm
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           annotations: ${{ steps.meta.outputs.annotations }}

Dockerfile

@@ -14,7 +14,8 @@ ARG DEBIAN_FRONTEND noninteractive
 
 RUN apt-get update && apt-get -y upgrade && \
     apt-get --no-install-recommends -y install \
-        tini \    
+        jq \
+        tini \
         curl \
         cpio \
         wget \

src/check.sh

@@ -9,53 +9,40 @@ file="/run/dsm.url"
 if [ ! -f  "$file" ]; then
 
   # Retrieve IP from guest VM for Docker healthcheck
-  RESPONSE=$(curl -s -m 16 -S http://127.0.0.1:2210/read?command=10 2>&1)
 
-  if [[ ! "${RESPONSE}" =~ "\"success\"" ]] ; then
+  { json=$(curl -m 30 -sk http://127.0.0.1:2210/read?command=10); rc=$?; } || :
-    echo "Failed to connect to guest: $RESPONSE" && exit 1
+  (( rc != 0 )) && echo "Failed to connect to guest: curl error $rc" && exit 1
+
+  { result=$(echo "$json" | jq -r '.status'); rc=$?; } || :
+  (( rc != 0 )) && echo "Failed to parse response from guest: jq error $rc ( $json )" && exit 1
+  [[ "$result" == "null" ]] && echo "Guest returned invalid response: $json" && exit 1
+
+  if [[ "$result" != "success" ]] ; then
+    { msg=$(echo "$json" | jq -r '.message'); rc=$?; } || :
+    echo "Guest replied ${result}: $msg" && exit 1
   fi
 
-  # Retrieve the HTTP port number
+  { port=$(echo "$json" | jq -r '.data.data.dsm_setting.data.http_port'); rc=$?; } || :
-  if [[ ! "${RESPONSE}" =~ "\"http_port\"" ]] ; then
+  (( rc != 0 )) && echo "Failed to parse response from guest: jq error $rc ( $json )" && exit 1
-    echo "Failed to parse response from guest: $RESPONSE" && exit 1
+  [[ "$port" == "null" ]] && echo "Guest has not set a portnumber yet.." && exit 1
-  fi
+  [ -z "${port}" ] && echo "Guest has not set a portnumber yet.." && exit 1
 
-  rest=${RESPONSE#*http_port}
+  { ip=$(echo "$json" | jq -r '.data.data.ip.data[] | select((.name=="eth0") and has("ip")).ip'); rc=$?; } || :
-  rest=${rest#*:}
+  (( rc != 0 )) && echo "Failed to parse response from guest: jq error $rc ( $json )" && exit 1
-  rest=${rest%%,*}
+  [[ "$ip" == "null" ]] && echo "Guest returned invalid response: $json" && exit 1
-  PORT=${rest%%\"*}
+  [ -z "${ip}" ] && echo "Guest has not received an IP yet.." && exit 1
 
-  [ -z "${PORT}" ] && echo "Guest has not set a portnumber yet.." && exit 1
+  echo "${ip}:${port}" > $file
-
-  # Retrieve the IP address
-  if [[ ! "${RESPONSE}" =~ "eth0" ]] ; then
-    echo "Failed to parse response from guest: $RESPONSE" && exit 1
-  fi
-
-  rest=${RESPONSE#*eth0}
-  rest=${rest#*ip}
-  rest=${rest#*:}
-  rest=${rest#*\"}
-  IP=${rest%%\"*}
-
-  [ -z "${IP}" ] && echo "Guest has not received an IP yet.." && exit 1
-
-  echo "${IP}:${PORT}" > $file
 
 fi
 
-LOCATION=$(cat "$file")
+location=$(cat "$file")
 
-if ! curl -m 20 -ILfSs "http://${LOCATION}/" > /dev/null; then
+if ! curl -m 20 -ILfSs "http://${location}/" > /dev/null; then
   rm -f $file
-  echo "Failed to reach http://${LOCATION}"
+  echo "Failed to reach http://${location}"
   exit 1
 fi
 
-if [[ "$LOCATION" == "20.20"* ]]; then
+echo "Healthcheck OK"
-  echo "Healthcheck OK"
-else
-  echo "Healthcheck OK ( ${LOCATION%:*} )"
-fi
-
 exit 0

src/gpu.sh

@@ -18,28 +18,7 @@ fi
 chmod 666 /dev/dri/card0
 chmod 666 /dev/dri/renderD128
 
-if ! apt-mark showinstall | grep -q "xserver-xorg-video-intel"; then
+addPackage "xserver-xorg-video-intel" "Intel GPU drivers"
-
+addPackage "qemu-system-modules-opengl" "OpenGL module"
-  info "Installing Intel GPU drivers..."
-
-  export DEBCONF_NOWARNINGS="yes"
-  export DEBIAN_FRONTEND="noninteractive"
-
-  apt-get -qq update
-  apt-get -qq --no-install-recommends -y install xserver-xorg-video-intel > /dev/null
-
-fi
-
-if ! apt-mark showinstall | grep -q "qemu-system-modules-opengl"; then
-
-  info "Installing OpenGL module..."
-
-  export DEBCONF_NOWARNINGS="yes"
-  export DEBIAN_FRONTEND="noninteractive"
-
-  apt-get -qq update
-  apt-get -qq --no-install-recommends -y install qemu-system-modules-opengl > /dev/null
-
-fi
 
 return 0

src/install.sh

@@ -14,24 +14,30 @@ fi
 [ -n "$URL" ] && BASE=$(basename "$URL" .pat)
 
 if [[ -f "$STORAGE/$BASE.boot.img" ]] && [[ -f "$STORAGE/$BASE.system.img" ]]; then
-  # Previous installation found
+  return 0  # Previous installation found
-  return 0
 fi
 
 # Display wait message
 /run/server.sh 5000 install &
 
-# Download the required files from the Synology website
+DL=""
-DL="https://global.synologydownload.com/download/DSM"
+DL_CHINA="https://cndl.synology.cn/download/DSM"
+DL_GLOBAL="https://global.synologydownload.com/download/DSM"
+
+[[ "${URL,,}" == *"cndl.synology"* ]] && DL="$DL_CHINA"
+[[ "${URL,,}" == *"global.synology"* ]] && DL="$DL_GLOBAL"
+
+if [ -z "$DL" ]; then
+  [ -z "$COUNTRY" ] && setCountry
+  [[ "${COUNTRY^^}" == "CN" ]] && DL="$DL_CHINA" || DL="$DL_GLOBAL"
+fi
 
 if [ -z "$URL" ]; then
-
   if [ "$ARCH" == "amd64" ]; then
     URL="$DL/release/7.2.1/69057-1/DSM_VirtualDSM_69057.pat"
   else
     URL="$DL/release/7.0.1/42218/DSM_VirtualDSM_42218.pat"
   fi
-
 fi
 
 # Check if output is to interactive TTY
@@ -43,7 +49,10 @@ fi
 
 BASE=$(basename "$URL" .pat)
 
-rm -f "$STORAGE"/"$BASE".pat
+if [[ "$URL" != "file://${STORAGE}/${BASE}.pat" ]]; then
+  rm -f "$STORAGE"/"$BASE".pat
+fi
+
 rm -f "$STORAGE"/"$BASE".agent
 rm -f "$STORAGE"/"$BASE".boot.img
 rm -f "$STORAGE"/"$BASE".system.img
@@ -51,6 +60,7 @@ rm -f "$STORAGE"/"$BASE".system.img
 [[ "${DEBUG}" == [Yy1]* ]] && set -x
 
 # Check filesystem
+MIN_ROOT=471859200
 MIN_SPACE=6442450944
 FS=$(stat -f -c %T "$STORAGE")
 
@@ -73,6 +83,9 @@ fi
 rm -rf "$TMP" && mkdir -p "$TMP"
 
 # Check free diskspace
+SPACE=$(df --output=avail -B 1 / | tail -n 1)
+(( MIN_ROOT > SPACE )) && error "Not enough free space in container root, need at least 450 MB available." && exit 96
+
 SPACE=$(df --output=avail -B 1 "$TMP" | tail -n 1)
 SPACE_GB=$(( (SPACE + 1073741823)/1073741824 ))
 (( MIN_SPACE > SPACE )) && error "Not enough free space for installation in ${STORAGE}, have ${SPACE_GB} GB available but need at least 6 GB." && exit 95
@@ -83,6 +96,8 @@ if [[ "$TMP" != "$STORAGE/tmp" ]]; then
   (( MIN_SPACE > SPACE )) && error "Not enough free space for installation in ${STORAGE}, have ${SPACE_GB} GB available but need at least 6 GB." && exit 94
 fi
 
+# Download the required files from the Synology website
+
 RDC="$STORAGE/dsm.rd"
 
 if [ ! -f "${RDC}" ]; then
@@ -162,9 +177,17 @@ info "Install: Downloading $(basename "$URL")..."
 PAT="/$BASE.pat"
 rm -f "$PAT"
 
-{ wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+if [[ "$URL" == "file://"* ]]; then
+
+  cp "${URL:7}" "$PAT"
+
+else
+
+  { wget "$URL" -O "$PAT" -q --no-check-certificate --show-progress "$PROGRESS"; rc=$?; } || :
+  (( rc != 0 )) && error "Failed to download $URL, reason: $rc" && exit 69
+
+fi
 
-(( rc != 0 )) && error "Failed to download $URL, reason: $rc" && exit 69
 [ ! -f "$PAT" ] && error "Failed to download $URL" && exit 69
 
 SIZE=$(stat -c%s "$PAT")
@@ -180,17 +203,7 @@ if { tar tf "$PAT"; } >/dev/null 2>&1; then
 
 else
 
-  if [ "$ARCH" != "amd64" ]; then
+  [ "$ARCH" != "amd64" ] && addPackage "qemu-user" "QEMU"
-
-    info "Install: Installing QEMU..."
-
-    export DEBCONF_NOWARNINGS="yes"
-    export DEBIAN_FRONTEND="noninteractive"
-
-    apt-get -qq update
-    apt-get -qq --no-install-recommends -y install qemu-user > /dev/null
-
-  fi
 
   info "Install: Extracting downloaded image..."
 
@@ -288,7 +301,12 @@ rm -rf "$MOUNT"
 
 echo "$BASE" > "$STORAGE"/dsm.ver
 
-mv -f "$PAT" "$STORAGE"/"$BASE".pat
+if [[ "$URL" == "file://${STORAGE}/${BASE}.pat" ]]; then
+  rm -f "$PAT"
+else
+  mv -f "$PAT" "$STORAGE"/"$BASE".pat
+fi
+
 mv -f "$BOOT" "$STORAGE"/"$BASE".boot.img
 mv -f "$SYSTEM" "$STORAGE"/"$BASE".system.img
 

src/network.sh

@@ -11,7 +11,6 @@ set -Eeuo pipefail
 : ${VM_NET_MAC:="$MAC"}
 : ${VM_NET_HOST:='VirtualDSM'}
 
-: ${DNS_SERVERS:=''}
 : ${DNSMASQ_OPTS:=''}
 : ${DNSMASQ:='/usr/sbin/dnsmasq'}
 : ${DNSMASQ_CONF_DIR:='/etc/dnsmasq.d'}
@@ -78,33 +77,8 @@ configureDNS () {
   echo "0 $VM_NET_MAC $VM_NET_IP $VM_NET_HOST 01:${VM_NET_MAC}" > /var/lib/misc/dnsmasq.leases
   chmod 644 /var/lib/misc/dnsmasq.leases
 
-  # Build DNS options from container /etc/resolv.conf
+  # Set DNS server and gateway
-
+  DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-option=option:dns-server,${VM_NET_IP%.*}.1 --dhcp-option=option:router,${VM_NET_IP%.*}.1"
-  if [[ "${DEBUG}" == [Yy1]* ]]; then
-    echo "/etc/resolv.conf:" && echo && cat /etc/resolv.conf && echo
-  fi
-
-  mapfile -t nameservers < <( { grep '^nameserver' /etc/resolv.conf || true; } | sed 's/\t/ /g' | sed 's/nameserver //' | sed 's/ //g')
-  searchdomains=$( { grep '^search' /etc/resolv.conf || true; } | sed 's/\t/ /g' | sed 's/search //' | sed 's/#.*//' | sed 's/\s*$//g' | sed 's/ /,/g')
-  domainname=$(echo "$searchdomains" | awk -F"," '{print $1}')
-
-  for nameserver in "${nameservers[@]}"; do
-    nameserver=$(echo "$nameserver" | sed 's/#.*//' )
-    [[ "$nameserver" =~ .*:.* ]] && continue
-    [[ "$nameserver" == "127.0"* ]] && nameserver=$GATEWAY
-    [[ -z "$DNS_SERVERS" ]] && DNS_SERVERS="$nameserver" || DNS_SERVERS="$DNS_SERVERS,$nameserver"
-  done
-
-  [[ -z "$DNS_SERVERS" ]] && DNS_SERVERS=$GATEWAY
-
-  DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-option=option:dns-server,$DNS_SERVERS --dhcp-option=option:router,${VM_NET_IP%.*}.1"
-
-  if [ -n "$searchdomains" ] && [ "$searchdomains" != "." ]; then
-    DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-option=option:domain-search,$searchdomains --dhcp-option=option:domain-name,$domainname"
-  else
-    [[ -z $(hostname -d) ]] || DNSMASQ_OPTS="$DNSMASQ_OPTS --dhcp-option=option:domain-name,$(hostname -d)"
-  fi
-
   DNSMASQ_OPTS=$(echo "$DNSMASQ_OPTS" | sed 's/\t/ /g' | tr -s ' ' | sed 's/^ *//')
 
   [[ "${DEBUG}" == [Yy1]* ]] && set -x

src/power.sh

@@ -5,7 +5,6 @@ set -Eeuo pipefail
 
 QEMU_PORT=7100
 QEMU_TIMEOUT=50
-
 QEMU_PID=/run/qemu.pid
 QEMU_COUNT=/run/qemu.count
 
@@ -26,18 +25,18 @@ _graceful_shutdown() {
   [ ! -f "${QEMU_PID}" ] && exit 130
   [ -f "${QEMU_COUNT}" ] && return
 
-  echo && info "Received $1 signal, shutting down..."
   echo 0 > "${QEMU_COUNT}"
+  echo && info "Received $1 signal, shutting down..."
 
   # Don't send the powerdown signal because vDSM ignores ACPI signals
   # echo 'system_powerdown' | nc -q 1 -w 1 localhost "${QEMU_PORT}" > /dev/null
 
   # Send shutdown command to guest agent via serial port
-  RESPONSE=$(curl -s -m 5 -S http://127.0.0.1:2210/read?command=6 2>&1)
+  RESPONSE=$(curl -s -m 30 -S http://127.0.0.1:2210/read?command=6 2>&1)
 
-  if [[ ! "${RESPONSE}" =~ "\"success\"" ]] ; then
+  if [[ ! "${RESPONSE}" =~ "\"success\"" ]]; then
 
-    echo && error "Could not send shutdown command to the guest ($RESPONSE)"
+    echo && error "Failed to send shutdown command ( ${RESPONSE} )."
 
     kill -15 "$(cat "${QEMU_PID}")"
     pkill -f qemu-system-x86_64 || true

src/print.sh

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-info () { echo -e >&2 "\E[1;34m❯\E[1;36m $1\E[0m" ; }
+info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n" >&2; }
-error () { echo -e >&2 "\E[1;31m❯ ERROR: $1\E[0m" ; }
+error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
 
 file="/run/dsm.url"
 
@@ -14,53 +14,53 @@ do
 
   # Retrieve IP from guest VM
 
-  set +e
+  { json=$(curl -m 30 -sk http://127.0.0.1:2210/read?command=10); rc=$?; } || :
-  RESPONSE=$(curl -s -m 16 -S http://127.0.0.1:2210/read?command=10 2>&1)
+  (( rc != 0 )) && error "Failed to connect to guest: curl error $rc" && continue
-  set -e
 
-  if [[ ! "${RESPONSE}" =~ "\"success\"" ]] ; then
+  { result=$(echo "$json" | jq -r '.status'); rc=$?; } || :
-    error "Failed to connect to guest: $RESPONSE" && continue
+  (( rc != 0 )) && error "Failed to parse response from guest: jq error $rc ( $json )" && continue
+  [[ "$result" == "null" ]] && error "Guest returned invalid response: $json" && continue
+
+  if [[ "$result" != "success" ]] ; then
+    { msg=$(echo "$json" | jq -r '.message'); rc=$?; } || :
+    error "Guest replied ${result}: $msg" && continue
   fi
 
-  # Retrieve the HTTP port number
+  { port=$(echo "$json" | jq -r '.data.data.dsm_setting.data.http_port'); rc=$?; } || :
-  if [[ ! "${RESPONSE}" =~ "\"http_port\"" ]] ; then
+  (( rc != 0 )) && error "Failed to parse response from guest: jq error $rc ( $json )" && continue
-    error "Failed to parse response from guest: $RESPONSE" && continue
+  [[ "$port" == "null" ]] && error "Guest returned invalid response: $json" && continue
-  fi
+  [ -z "${port}" ] && continue
 
-  rest=${RESPONSE#*http_port}
+  { ip=$(echo "$json" | jq -r '.data.data.ip.data[] | select((.name=="eth0") and has("ip")).ip'); rc=$?; } || :
-  rest=${rest#*:}
+  (( rc != 0 )) && error "Failed to parse response from guest: jq error $rc ( $json )" && continue
-  rest=${rest%%,*}
+  [[ "$ip" == "null" ]] && error "Guest returned invalid response: $json" && continue
-  PORT=${rest%%\"*}
+  [ -z "${ip}" ] && continue
 
-  [ -z "${PORT}" ] && continue
+  echo "${ip}:${port}" > $file
-
-  # Retrieve the IP address
-  if [[ ! "${RESPONSE}" =~ "eth0" ]] ; then
-    error "Failed to parse response from guest: $RESPONSE" && continue
-  fi
-
-  rest=${RESPONSE#*eth0}
-  rest=${rest#*ip}
-  rest=${rest#*:}
-  rest=${rest#*\"}
-  IP=${rest%%\"*}
-
-  [ -z "${IP}" ] && continue
-
-  echo "${IP}:${PORT}" > $file
 
 done
 
-LOCATION=$(cat "$file")
+location=$(cat "$file")
+
+if [[ "$location" != "20.20"* ]]; then
+
+  msg="http://${location}"
 
-if [[ "$LOCATION" == "20.20"* ]]; then
-  MSG="port ${LOCATION##*:}"
 else
-  MSG="http://${LOCATION}"
+
+  ip=$(ip address show dev eth0 | grep inet | awk '/inet / { print $2 }' | cut -f1 -d/)
+  port="${location##*:}"
+
+  if [[ "$ip" == "172."* ]]; then
+    msg="port ${port}"
+  else
+    msg="http://${ip}:${port}"
+  fi
+
 fi
 
 echo "" >&2
 info "--------------------------------------------------------"
-info " You can now login to DSM at ${MSG}"
+info " You can now login to DSM at ${msg}"
 info "--------------------------------------------------------"
 echo "" >&2

src/reset.sh

@@ -1,8 +1,9 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-info () { echo -e "\E[1;34m❯ \E[1;36m$1\E[0m" ; }
+info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "$1" "\E[0m\n"; }
-error () { echo -e >&2 "\E[1;31m❯ ERROR: $1\E[0m" ; }
+error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: $1" "\E[0m\n" >&2; }
+
 trap 'error "Status $? while: ${BASH_COMMAND} (line $LINENO/$BASH_LINENO)"' ERR
 
 [ ! -f "/run/entry.sh" ] && error "Script must run inside Docker container!" && exit 11
@@ -12,6 +13,7 @@ trap 'error "Status $? while: ${BASH_COMMAND} (line $LINENO/$BASH_LINENO)"' ERR
 
 : ${GPU:='N'}           # Enable GPU passthrough
 : ${DEBUG:='N'}         # Enable debugging mode
+: ${COUNTRY:=''}        # Country code for mirror
 : ${CONSOLE:='N'}       # Start in console mode
 : ${ALLOCATE:='Y'}      # Preallocate diskspace
 : ${ARGUMENTS:=''}      # Extra QEMU parameters
@@ -42,4 +44,64 @@ rm -f /run/qemu.count
 rm -rf /tmp/dsm
 rm -rf "$STORAGE/tmp"
 
+# Helper functions
+
+getCountry () {
+
+  local rc
+  local json
+  local result
+  local url=$1
+  local query=$2
+
+  { json=$(curl -m 5 -H "Accept: application/json" -sfk "$url"); rc=$?; } || :
+  (( rc != 0 )) && return 0
+
+  { result=$(echo "$json" | jq -r "$query" 2> /dev/null); rc=$?; } || :
+  (( rc != 0 )) && return 0
+
+  [[ ${#result} -ne 2 ]] && return 0
+  [[ "${result^^}" == "XX" ]] && return 0
+
+  COUNTRY="${result^^}"
+
+  return 0
+}
+
+setCountry () {
+
+  [ -z "$COUNTRY" ] && getCountry "https://api.ipapi.is" ".location.country_code"
+  [ -z "$COUNTRY" ] && getCountry "https://ifconfig.co/json" ".country_iso"
+  [ -z "$COUNTRY" ] && getCountry "https://ipinfo.io/json" ".country"
+  [ -z "$COUNTRY" ] && getCountry "https://api.myip.com" ".cc"
+
+  return 0
+}
+
+addPackage () {
+
+  local pkg=$1
+  local desc=$2
+
+  if apt-mark showinstall | grep -qx "$pkg"; then
+    return 0
+  fi
+
+  info "Installing $desc..."
+
+  export DEBCONF_NOWARNINGS="yes"
+  export DEBIAN_FRONTEND="noninteractive"
+
+  [ -z "$COUNTRY" ] && setCountry
+
+  if [[ "${COUNTRY^^}" == "CN" ]]; then
+    sed -i 's/deb.debian.org/mirrors.ustc.edu.cn/g' /etc/apt/sources.list.d/debian.sources
+  fi
+
+  apt-get -qq update
+  apt-get -qq --no-install-recommends -y install "$pkg" > /dev/null
+
+  return 0
+}
+
 return 0

src/serial.sh

@@ -45,7 +45,7 @@ fi
 cnt=0
 sleep 0.2
 
-while ! nc -z -w1 127.0.0.1 2210 > /dev/null 2>&1; do
+while ! nc -z -w2 127.0.0.1 2210 > /dev/null 2>&1; do
   sleep 0.1
   cnt=$((cnt + 1))
   (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit 58
@@ -53,7 +53,7 @@ done
 
 cnt=0
 
-while ! nc -z -w1 127.0.0.1 12345 > /dev/null 2>&1; do
+while ! nc -z -w2 127.0.0.1 12345 > /dev/null 2>&1; do
   sleep 0.1
   cnt=$((cnt + 1))
   (( cnt > 50 )) && error "Failed to connect to qemu-host.." && exit 59