fix: Remove non-printable characters (#949)

.devcontainer.json

@@ -0,0 +1,6 @@
+{
+  "name": "dsm",
+  "service": "dsm",
+  "forwardPorts": [5000],
+  "dockerComposeFile": "compose.yml"
+}

readme.md

@@ -22,7 +22,7 @@ Virtual DSM in a Docker container.
  
 ## Usage  🐳
 
-Via Docker Compose:
+##### Via Docker Compose:
 
 ```yaml
 services:
@@ -44,27 +44,21 @@ services:
     stop_grace_period: 2m
 ```
 
-Via Docker CLI:
+##### Via Docker CLI:
 
 ```bash
 docker run -it --rm --name dsm -p 5000:5000 --device=/dev/kvm --device=/dev/net/tun --cap-add NET_ADMIN -v ${PWD:-.}/dsm:/storage --stop-timeout 120 vdsm/virtual-dsm
 ```
 
-Via Kubernetes:
+##### Via Kubernetes:
 
 ```shell
 kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/master/kubernetes.yml
 ```
 
-## Compatibility ⚙️
+##### Via Github Codespaces:
 
-| **Product**  | **Platform**   | |
+[`Click here to launch this container in the cloud!`](https://github.com/codespaces/new?skip_quickstart=true&machine=basicLinux32gb&repo=619260050&ref=master&devcontainer_path=.devcontainer.json)
-|---|---|---|
-| Docker Engine | Linux| ✅ |
-| Docker Desktop | Linux | ❌ |
-| Docker Desktop | macOS | ❌ |
-| Docker Desktop | Windows 11 | ✅ |
-| Docker Desktop | Windows 10 | ❌ |
 
 ## FAQ 💬
 
@@ -159,9 +153,16 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
 ### How do I verify if my system supports KVM?
 
-  Only Linux and Windows 11 support KVM virtualization, macOS and Windows 10 do not unfortunately.
+  First check if your software is compatible using this chart:
 
-  You can run the following commands in Linux to check your system:
+  | **Product**  | **Linux** | **Win11** | **Win10** | **macOS** |
+  |---|---|---|---|---|
+  | Docker CLI        | ✅   | ✅       | ❌        | ❌ |
+  | Docker Desktop    | ❌   | ✅       | ❌        | ❌ | 
+  | Podman CLI        | ✅   | ✅       | ❌        | ❌ | 
+  | Podman Desktop    | ✅   | ✅       | ❌        | ❌ | 
+
+  After that you can run the following commands in Linux to check your system:
 
   ```bash
   sudo apt install cpu-checker
@@ -176,11 +177,7 @@ kubectl apply -f https://raw.githubusercontent.com/vdsm/virtual-dsm/refs/heads/m
 
   - you are not using a cloud provider, as most of them do not allow nested virtualization for their VPS's.
 
-  If you do not receive any error from `kvm-ok` but the container still complains about KVM, please check whether:
+  If you did not receive any error from `kvm-ok` but the container still complains about a missing KVM device, it could help to add `privileged: true` to your compose file (or `sudo` to your `docker` command) to rule out any permission issue.
-
-  - you are not using "Docker Desktop for Linux" as it does not support KVM, instead make use of Docker Engine directly.
- 
-  - it could help to add `privileged: true` to your compose file (or `sudo` to your `docker run` command), to rule out any permission issue.
 
 ### How do I assign an individual IP address to the container?
 

src/config.sh

@@ -37,7 +37,7 @@ if [[ "$RAM_CHECK" != [Nn]* ]]; then
 fi
 
 if [[ "$DEBUG" == [Yy1]* ]]; then
-  printf "Arguments:\n\n%s" "${ARGS// -/$'\n-'}" && echo
+  printf "Arguments:\n\n%s\n\n" "${ARGS// -/$'\n-'}"
 fi
 
 return 0

src/entry.sh

@@ -6,6 +6,7 @@ set -Eeuo pipefail
 
 cd /run
 
+. utils.sh      # Load functions
 . reset.sh      # Initialize system
 . install.sh    # Run installation
 . disk.sh       # Initialize disks

src/install.sh

@@ -5,6 +5,7 @@ set -Eeuo pipefail
 
 if [ -f "$STORAGE/dsm.ver" ]; then
   BASE=$(<"$STORAGE/dsm.ver")
+  BASE="${BASE//[![:print:]]/}"
   [ -z "$BASE" ] && BASE="DSM_VirtualDSM_69057"
 else
   # Fallback for old installs

src/network.sh

@@ -104,15 +104,21 @@ configureDHCP() {
 
 configureDNS() {
 
-  # dnsmasq configuration:
-  DNSMASQ_OPTS+=" --dhcp-range=$VM_NET_IP,$VM_NET_IP --dhcp-host=$VM_NET_MAC,,$VM_NET_IP,$VM_NET_HOST,infinite --dhcp-option=option:netmask,255.255.255.0"
-
   # Create lease file for faster resolve
   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
 
+  # dnsmasq configuration:
+  DNSMASQ_OPTS+=" --dhcp-authoritative"
+
+  # Set DHCP range and host
+  DNSMASQ_OPTS+=" --dhcp-range=$VM_NET_IP,$VM_NET_IP"
+  DNSMASQ_OPTS+=" --dhcp-host=$VM_NET_MAC,,$VM_NET_IP,$VM_NET_HOST,infinite"
+
   # Set DNS server and gateway
-  DNSMASQ_OPTS+=" --dhcp-option=option:dns-server,${VM_NET_IP%.*}.1 --dhcp-option=option:router,${VM_NET_IP%.*}.1"
+  DNSMASQ_OPTS+=" --dhcp-option=option:netmask,255.255.255.0"
+  DNSMASQ_OPTS+=" --dhcp-option=option:router,${VM_NET_IP%.*}.1"
+  DNSMASQ_OPTS+=" --dhcp-option=option:dns-server,${VM_NET_IP%.*}.1"
 
   # Add DNS entry for container
   DNSMASQ_OPTS+=" --address=/host.lan/${VM_NET_IP%.*}.1"
@@ -193,14 +199,16 @@ configureNAT() {
   fi
 
   if [ ! -c /dev/net/tun ]; then
-    error "$tuntap" && return 1
+    [[ "$PODMAN" != [Yy1]* ]] && error "$tuntap"  
+    return 1
   fi
 
   # Check port forwarding flag
   if [[ $(< /proc/sys/net/ipv4/ip_forward) -eq 0 ]]; then
     { sysctl -w net.ipv4.ip_forward=1 > /dev/null; rc=$?; } || :
     if (( rc != 0 )) || [[ $(< /proc/sys/net/ipv4/ip_forward) -eq 0 ]]; then
-      error "IP forwarding is disabled. $ADD_ERR --sysctl net.ipv4.ip_forward=1" && return 1
+      [[ "$PODMAN" != [Yy1]* ]] && error "IP forwarding is disabled. $ADD_ERR --sysctl net.ipv4.ip_forward=1"
+      return 1
     fi
   fi
 
@@ -365,7 +373,13 @@ getInfo() {
 
   if [ ! -d "/sys/class/net/$VM_NET_DEV" ]; then
     error "Network interface '$VM_NET_DEV' does not exist inside the container!"
-    error "$ADD_ERR -e \"VM_NET_DEV=NAME\" to specify another interface name." && exit 27
+    error "$ADD_ERR -e \"VM_NET_DEV=NAME\" to specify another interface name." && exit 26
+  fi
+
+  BASE_IP="${VM_NET_IP%.*}."
+
+  if [ "${VM_NET_IP/$BASE_IP/}" -lt "3" ]; then
+    error "Invalid VM_NET_IP, must end in a higher number than .3" && exit 27
   fi
   
   if [ -z "$MTU" ]; then
@@ -385,6 +399,7 @@ getInfo() {
   if [ -z "$VM_NET_MAC" ]; then
     local file="$STORAGE/dsm.mac"
     [ -s "$file" ] && VM_NET_MAC=$(<"$file")
+    VM_NET_MAC="${VM_NET_MAC//[![:print:]]/}"
     if [ -z "$VM_NET_MAC" ]; then
       # Generate MAC address based on Docker container ID in hostname
       VM_NET_MAC=$(echo "$HOST" | md5sum | sed 's/^\(..\)\(..\)\(..\)\(..\)\(..\).*$/02:11:32:\3:\4:\5/')
@@ -414,6 +429,7 @@ getInfo() {
     [ -n "$IP6" ] && IP6=$(echo "$IP6" | sed -e's/^.*inet6 \([^ ]*\)\/.*$/\1/;t;d' | head -n 1)
   fi
 
+  [ -f "/run/.containerenv" ] && PODMAN="Y" || PODMAN="N"
   echo "$IP" > /run/shm/qemu.ip
 
   return 0
@@ -436,7 +452,10 @@ if [[ "$DEBUG" == [Yy1]* ]]; then
   line="Host: $HOST  IP: $IP  Gateway: $GATEWAY  Interface: $VM_NET_DEV  MAC: $VM_NET_MAC  MTU: $mtu"
   [[ "$MTU" != "0" ]] && [[ "$MTU" != "$mtu" ]] && line+=" ($MTU)"
   info "$line"
-  [ -f /etc/resolv.conf ] && grep '^nameserver*' /etc/resolv.conf
+  if [ -f /etc/resolv.conf ]; then
+    nameservers=$(grep '^nameserver*' /etc/resolv.conf | head -c -1 | sed 's/nameserver //g;' | sed -z 's/\n/, /g')
+    [ -n "$nameservers" ] && info "Nameservers: $nameservers"
+  fi
   echo
 fi
 
@@ -480,7 +499,14 @@ else
 
       closeBridge
       NETWORK="user"
-      warn "falling back to user-mode networking! Performance will be bad and port mapping will not work."
+      msg="falling back to user-mode networking!"
+      if [[ "$PODMAN" != [Yy1]* ]]; then
+        msg="an error occured, $msg"
+      else
+        msg="podman detected, $msg"
+      fi
+      warn "$msg"
+      [ -z "$USER_PORTS" ] && info "Notice: port mapping will not work without \"USER_PORTS\" now."
 
     fi
 

src/proc.sh

@@ -10,19 +10,20 @@ set -Eeuo pipefail
 : "${DEF_MODEL:="qemu64"}"
 
 CLOCKSOURCE="tsc"
-[[ "${ARCH,,}" == "arm64" ]] && CLOCKSOURCE="arch_sys_counter"
+[[ "${ARCH,,}" == "arm64" ]] && CLOCKSOURCE="arch_sys_counter"
 CLOCK="/sys/devices/system/clocksource/clocksource0/current_clocksource"
 
 if [ ! -f "$CLOCK" ]; then
   warn "file \"$CLOCK\" cannot not found?"
 else
   result=$(<"$CLOCK")
+  result="${result//[![:print:]]/}"
   case "${result,,}" in
     "${CLOCKSOURCE,,}" ) ;;
     "kvm-clock" ) info "Nested KVM virtualization detected.." ;;
     "hyperv_clocksource_tsc_page" ) info "Nested Hyper-V virtualization detected.." ;;
-    "hpet" ) warn "unsupported clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'" ;;
+    "hpet" ) warn "unsupported clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'." ;;
-    *) warn "unexpected clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'" ;;
+    *) warn "unexpected clock source detected: '$result'. Please set host clock source to '$CLOCKSOURCE'." ;;
   esac
 fi
 

src/reset.sh

@@ -1,10 +1,6 @@
 #!/usr/bin/env bash
 set -Eeuo pipefail
 
-info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "${1:-}" "\E[0m\n"; }
-error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: ${1:-}" "\E[0m\n" >&2; }
-warn () { printf "%b%s%b" "\E[1;31m❯ " "Warning: ${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
@@ -38,7 +34,7 @@ TEMPLATE="/var/www/index.html"
 FOOTER1="$APP for Docker v$(</run/version)"
 FOOTER2="<a href='$SUPPORT'>$SUPPORT</a>"
 
-CPI=$(lscpu)
+CPU=$(cpu)
 SYS=$(uname -r)
 HOST=$(hostname -s)
 KERNEL=$(echo "$SYS" | cut -b 1)
@@ -46,41 +42,12 @@ MINOR=$(echo "$SYS" | cut -d '.' -f2)
 ARCH=$(dpkg --print-architecture)
 CORES=$(grep -c '^processor' /proc/cpuinfo)
 
-if ! grep -qi "socket(s)" <<< "$CPI"; then
+if ! grep -qi "socket(s)" <<< "$(lscpu)"; then
   SOCKETS=1
 else
-  SOCKETS=$(echo "$CPI" | grep -m 1 -i 'socket(s)' | awk '{print $(2)}')
+  SOCKETS=$(lscpu | grep -m 1 -i 'socket(s)' | awk '{print $(2)}')
 fi
 
-if ! grep -qi "model name" <<< "$CPI"; then
-  CPU=""
-else
-  CPU=$(echo "$CPI" | grep -m 1 -i 'model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
-fi
-
-if [ -z "${CPU// /}" ] && grep -qi "model:" <<< "$CPI"; then
-  CPU=$(echo "$CPI" | grep -m 1 -i 'model:' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
-fi
-
-CPU="${CPU// CPU/}"
-CPU="${CPU// 6 Core/}"
-CPU="${CPU// 8 Core/}"
-CPU="${CPU// 16 Core/}"
-CPU="${CPU// 32 Core/}"
-CPU="${CPU// 64 Core/}"
-CPU="${CPU//10th Gen /}"
-CPU="${CPU//11th Gen /}"
-CPU="${CPU//12th Gen /}"
-CPU="${CPU//13th Gen /}"
-CPU="${CPU//14th Gen /}"
-CPU="${CPU//15th Gen /}"
-CPU="${CPU// Processor/}"
-CPU="${CPU// Quad core/}"
-CPU="${CPU// Core TM/ Core}"
-CPU="${CPU// with Radeon Graphics/}"
-CPU="${CPU// with Radeon Vega Graphics/}"
-
-[ -z "${CPU// /}" ] && CPU="Unknown"
 [ -n "${CPU_CORES//[0-9 ]}" ] && error "Invalid amount of CPU_CORES: $CPU_CORES" && exit 15
 
 # Check system
@@ -110,30 +77,6 @@ if [[ "${FS,,}" == "ecryptfs" ]] || [[ "${FS,,}" == "tmpfs" ]]; then
   DISK_CACHE="writeback"
 fi
 
-formatBytes() {
-  local result
-  result=$(numfmt --to=iec "$1")
-  local unit="${result//[0-9. ]}"
-  if [ -z "$unit" ]; then
-    unit="bytes"
-  else
-    unit=$(echo "${unit^^}" | sed 's/K/KB/g;s/M/MB/g;s/G/GB/g;s/T/TB/g')
-  fi
-  result="${result//[a-zA-Z ]/}"
-  if [[ "${2:-}" == "up" ]]; then
-    if [[ "$result" == *"."* ]]; then
-      result="${result%%.*}"
-      result=$((result+1))
-    fi
-  else
-    if [[ "${2:-}" == "down" ]]; then
-      result="${result%%.*}"
-    fi
-  fi
-  echo "$result $unit"
-  return 0
-}
-
 # Read memory
 RAM_SPARE=500000000
 RAM_AVAIL=$(free -b | grep -m 1 Mem: | awk '{print $7}')
@@ -181,91 +124,6 @@ rm -f /run/shm/dsm.url
 rm -rf /tmp/dsm
 rm -rf "$STORAGE/tmp"
 
-# Helper functions
-
-isAlive() {
-  local pid="$1"
-
-  if kill -0 "$pid" 2>/dev/null; then
-    return 0
-  fi
-
-  return 1
-}
-
-pKill() {
-  local pid="$1"
-
-  { kill -15 "$pid" || true; } 2>/dev/null
-
-  while isAlive "$pid"; do
-    sleep 0.2
-  done
-
-  return 0
-}
-
-fWait() {
-  local name="$1"
-
-  while pgrep -f -l "$name" >/dev/null; do
-    sleep 0.2
-  done
-
-  return 0
-}
-
-fKill() {
-  local name="$1"
-
-  { pkill -f "$name" || true; } 2>/dev/null
-  fWait "$name"
-
-  return 0
-}
-
-escape () {
-    local s
-    s=${1//&/\&amp;}
-    s=${s//</\&lt;}
-    s=${s//>/\&gt;}
-    s=${s//'"'/\&quot;}
-    printf -- %s "$s"
-    return 0
-}
-
-html()
-{
-    local title
-    local body
-    local script
-    local footer
-
-    title=$(escape "$APP")
-    title="<title>$title</title>"
-    footer=$(escape "$FOOTER1")
-
-    body=$(escape "$1")
-    if [[ "$body" == *"..." ]]; then
-      body="<p class=\"loading\">${body/.../}</p>"
-    fi
-
-    [ -n "${2:-}" ] && script="$2" || script=""
-
-    local HTML
-    HTML=$(<"$TEMPLATE")
-    HTML="${HTML/\[1\]/$title}"
-    HTML="${HTML/\[2\]/$script}"
-    HTML="${HTML/\[3\]/$body}"
-    HTML="${HTML/\[4\]/$footer}"
-    HTML="${HTML/\[5\]/$FOOTER2}"
-
-    echo "$HTML" > "$PAGE"
-    echo "$body" > "$INFO"
-
-    return 0
-}
-
 getCountry() {
   local url=$1
   local query=$2

src/utils.sh

@@ -0,0 +1,171 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# Helper functions
+
+info () { printf "%b%s%b" "\E[1;34m❯ \E[1;36m" "${1:-}" "\E[0m\n"; }
+error () { printf "%b%s%b" "\E[1;31m❯ " "ERROR: ${1:-}" "\E[0m\n" >&2; }
+warn () { printf "%b%s%b" "\E[1;31m❯ " "Warning: ${1:-}" "\E[0m\n" >&2; }
+
+formatBytes() {
+  local result
+  result=$(numfmt --to=iec --suffix=B "$1" | sed -r 's/([A-Z])/ \1/' | sed 's/ B/ bytes/g;')
+  local unit="${result//[0-9. ]}"
+  result="${result//[a-zA-Z ]/}"
+  if [[ "${2:-}" == "up" ]]; then
+    if [[ "$result" == *"."* ]]; then
+      result="${result%%.*}"
+      result=$((result+1))
+    fi
+  else
+    if [[ "${2:-}" == "down" ]]; then
+      result="${result%%.*}"
+    fi
+  fi
+  echo "$result $unit"
+  return 0
+}
+
+isAlive() {
+  local pid="$1"
+
+  if kill -0 "$pid" 2>/dev/null; then
+    return 0
+  fi
+
+  return 1
+}
+
+pKill() {
+  local pid="$1"
+
+  { kill -15 "$pid" || true; } 2>/dev/null
+
+  while isAlive "$pid"; do
+    sleep 0.2
+  done
+
+  return 0
+}
+
+fWait() {
+  local name="$1"
+
+  while pgrep -f -l "$name" >/dev/null; do
+    sleep 0.2
+  done
+
+  return 0
+}
+
+fKill() {
+  local name="$1"
+
+  { pkill -f "$name" || true; } 2>/dev/null
+  fWait "$name"
+
+  return 0
+}
+
+escape () {
+  local s
+  s=${1//&/\&}
+  s=${s//</\&lt;}
+  s=${s//>/\&gt;}
+  s=${s//'"'/\&quot;}
+  printf -- %s "$s"
+  return 0
+}
+
+html() {
+  local title
+  local body
+  local script
+  local footer
+
+  title=$(escape "$APP")
+  title="<title>$title</title>"
+  footer=$(escape "$FOOTER1")
+
+  body=$(escape "$1")
+  if [[ "$body" == *"..." ]]; then
+    body="<p class=\"loading\">${body/.../}</p>"
+  fi
+
+  [ -n "${2:-}" ] && script="$2" || script=""
+
+  local HTML
+  HTML=$(<"$TEMPLATE")
+  HTML="${HTML/\[1\]/$title}"
+  HTML="${HTML/\[2\]/$script}"
+  HTML="${HTML/\[3\]/$body}"
+  HTML="${HTML/\[4\]/$footer}"
+  HTML="${HTML/\[5\]/$FOOTER2}"
+
+  echo "$HTML" > "$PAGE"
+  echo "$body" > "$INFO"
+
+  return 0
+}
+
+cpu() {
+  local ret
+  local cpu=""
+
+  ret=$(lscpu)
+  
+  if grep -qi "model name" <<< "$ret"; then
+    cpu=$(echo "$ret" | grep -m 1 -i 'model name' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+  fi
+  
+  if [ -z "${cpu// /}" ] && grep -qi "model:" <<< "$ret"; then
+    cpu=$(echo "$ret" | grep -m 1 -i 'model:' | cut -f 2 -d ":" | awk '{$1=$1}1' | sed 's# @.*##g' | sed s/"(R)"//g | sed 's/[^[:alnum:] ]\+/ /g' | sed 's/  */ /g')
+  fi
+  
+  cpu="${cpu// CPU/}"
+  cpu="${cpu// 4 Core/}"
+  cpu="${cpu// 6 Core/}"
+  cpu="${cpu// 8 Core/}"
+  cpu="${cpu// 10 Core/}"
+  cpu="${cpu// 12 Core/}"
+  cpu="${cpu// 16 Core/}"
+  cpu="${cpu// 32 Core/}"
+  cpu="${cpu// 64 Core/}"
+  cpu="${cpu//7th Gen /}"
+  cpu="${cpu//8th Gen /}"
+  cpu="${cpu//9th Gen /}"
+  cpu="${cpu//10th Gen /}"
+  cpu="${cpu//11th Gen /}"
+  cpu="${cpu//12th Gen /}"
+  cpu="${cpu//13th Gen /}"
+  cpu="${cpu//14th Gen /}"
+  cpu="${cpu//15th Gen /}"
+  cpu="${cpu// Processor/}"
+  cpu="${cpu// Quad core/}"
+  cpu="${cpu// Dual core/}"
+  cpu="${cpu// Octa core/}"
+  cpu="${cpu// Core TM/ Core}"
+  cpu="${cpu// with Radeon Graphics/}"
+  cpu="${cpu// with Radeon Vega Graphics/}"
+  
+  [ -z "${cpu// /}" ] && cpu="Unknown"
+
+  echo "$cpu"
+  return 0
+}
+
+hasDisk() {
+
+  [ -b "/disk" ] && return 0
+  [ -b "/disk1" ] && return 0
+  [ -b "/dev/disk1" ] && return 0
+  [ -b "${DEVICE:-}" ] && return 0
+
+  [ -z "${DISK_NAME:-}" ] && DISK_NAME="data"
+  [ -s "$STORAGE/$DISK_NAME.img" ]  && return 0
+  [ -s "$STORAGE/$DISK_NAME.qcow2" ] && return 0
+
+  return 1
+}
+
+return 0