feat: Refactor Samba code (#1803)

src/samba.sh

@@ -16,11 +16,12 @@ rm -f "$SMB_PID" "$NMB_PID" "$DDN_PID"
 disabled "$SAMBA" && return 0
 disabled "$NETWORK" && return 0
 
-if enabled "$DHCP"; then
+configureNetwork() {
+  if enabled "$DHCP"; then
     socket="$IP"
     hostname="$IP"
     interfaces="$VM_NET_DEV"
-else
+  else
     hostname="host.lan"
     case "${NETWORK,,}" in
       "passt" | "slirp" )
@@ -33,11 +34,37 @@ else
     if [ -n "${SAMBA_INTERFACE:-}" ]; then
       interfaces+=",$SAMBA_INTERFACE"
     fi
-fi
+  fi
 
-html "Initializing shared folder..."
+  return 0
-SAMBA_CONFIG="/etc/samba/smb.conf"
+}
-enabled "$DEBUG" && echo "Starting Samba daemon..."
+
+writeTmpReadme() {
+  local dir="$1"
+  local ref="$2"
+
+  {   echo "--------------------------------------------------------"
+      echo " $APP for $ENGINE v$(</etc/version)..."
+      echo " For support visit $SUPPORT"
+      echo "--------------------------------------------------------"
+      echo ""
+      echo "Using this folder you can exchange files with the host machine."
+      echo ""
+      echo "To select a folder on the host for this purpose, include the following bind mount in your compose file:"
+      echo ""
+      echo "  volumes:"
+      echo "    - \"./example:${ref}\""
+      echo ""
+      echo "Or in your run command:"
+      echo ""
+      echo "  -v \"\${PWD:-.}/example:${ref}\""
+      echo ""
+      echo "Replace the example path ./example with your desired shared folder, which then will become visible here."
+      echo ""
+  } | unix2dos > "$dir/readme.txt"
+
+  return 0
+}
 
 addShare() {
   local dir="$1"
@@ -77,27 +104,7 @@ addShare() {
   fi
 
   if [[ "$dir" == "$tmp" ]]; then
-
+    writeTmpReadme "$dir" "$ref"
-    {   echo "--------------------------------------------------------"
-        echo " $APP for $ENGINE v$(</etc/version)..."
-        echo " For support visit $SUPPORT"
-        echo "--------------------------------------------------------"
-        echo ""
-        echo "Using this folder you can exchange files with the host machine."
-        echo ""
-        echo "To select a folder on the host for this purpose, include the following bind mount in your compose file:"
-        echo ""
-        echo "  volumes:"
-        echo "    - \"./example:${ref}\""
-        echo ""
-        echo "Or in your run command:"
-        echo ""
-        echo "  -v \"\${PWD:-.}/example:${ref}\""
-        echo ""
-        echo "Replace the example path ./example with your desired shared folder, which then will become visible here."
-        echo ""
-    } | unix2dos > "$dir/readme.txt"
-
   fi
 
   {   echo ""
@@ -112,7 +119,8 @@ addShare() {
   return 0
 }
 
-{       echo "[global]"
+writeSambaConfig() {
+  {   echo "[global]"
       echo "    server string = Dockur"
       echo "    netbios name = $hostname"
       echo "    workgroup = WORKGROUP"
@@ -139,57 +147,72 @@ addShare() {
       echo "    printing = bsd"
       echo "    printcap name = /dev/null"
       echo "    disable spoolss = yes"
-} > "$SAMBA_CONFIG"
+  } > "$SAMBA_CONFIG"
 
-# Add shared folders
+  return 0
-share="/shared"
+}
-[ ! -d "$share" ] && [ -d "$STORAGE/shared" ] && share="$STORAGE/shared"
-[ ! -d "$share" ] && [ -d "/data" ] && share="/data"
-[ ! -d "$share" ] && [ -d "$STORAGE/data" ] && share="$STORAGE/data"
-[ ! -d "$share" ] && share="$tmp"
 
-! addShare "$share" "/shared" "Data" "Shared" "$SAMBA_CONFIG" && return 0
+selectPrimaryShare() {
+  share="/shared"
+  [ ! -d "$share" ] && [ -d "$STORAGE/shared" ] && share="$STORAGE/shared"
+  [ ! -d "$share" ] && [ -d "/data" ] && share="/data"
+  [ ! -d "$share" ] && [ -d "$STORAGE/data" ] && share="$STORAGE/data"
+  [ ! -d "$share" ] && share="$tmp"
 
-if [ -d "/shared2" ]; then
+  return 0
-  addShare "/shared2" "/shared2" "Data2" "Shared" "$SAMBA_CONFIG" || :
+}
-elif [ -d "/data2" ]; then
-  addShare "/data2" "/shared2" "Data2" "Shared" "$SAMBA_CONFIG" || :
-fi
 
-if [ -d "/shared3" ]; then
+addOptionalShare() {
-  addShare "/shared3" "/shared3" "Data3" "Shared" "$SAMBA_CONFIG" || :
+  local index="$1"
-elif [ -d "/data3" ]; then
+  local ref="/shared$index"
-  addShare "/data3" "/shared3" "Data3" "Shared" "$SAMBA_CONFIG" || :
+  local name="Data$index"
-fi
 
-# Create directories if missing
+  if [ -d "$ref" ]; then
-mkdir -p /var/lib/samba/sysvol
+    addShare "$ref" "$ref" "$name" "Shared" "$SAMBA_CONFIG" || :
-mkdir -p /var/lib/samba/private
+  elif [ -d "/data$index" ]; then
-mkdir -p /var/lib/samba/bind-dns
+    addShare "/data$index" "$ref" "$name" "Shared" "$SAMBA_CONFIG" || :
+  fi
 
-# Try to repair Samba permissions
+  return 0
-[ -d /run/samba/msg.lock ] && chmod -R 0755 /run/samba/msg.lock 2>/dev/null || :
+}
-[ -d /var/log/samba/cores ] && chmod -R 0700 /var/log/samba/cores 2>/dev/null || :
-[ -d /var/cache/samba/msg.lock ] && chmod -R 0755 /var/cache/samba/msg.lock 2>/dev/null || :
 
-rm -f /var/log/samba/log.smbd
+prepareSambaDirs() {
+  # Create directories if missing
+  mkdir -p /var/lib/samba/sysvol
+  mkdir -p /var/lib/samba/private
+  mkdir -p /var/lib/samba/bind-dns
 
-if ! smbd -l /var/log/samba; then
+  # Try to repair Samba permissions
+  [ -d /run/samba/msg.lock ] && chmod -R 0755 /run/samba/msg.lock 2>/dev/null || :
+  [ -d /var/log/samba/cores ] && chmod -R 0700 /var/log/samba/cores 2>/dev/null || :
+  [ -d /var/cache/samba/msg.lock ] && chmod -R 0755 /var/cache/samba/msg.lock 2>/dev/null || :
+
+  return 0
+}
+
+tailLogIfDebug() {
+  local file="$1"
+
+  if enabled "$SAMBA_DEBUG"; then
+    tail -fn +0 "$file" --pid=$$ &
+  fi
+
+  return 0
+}
+
+startSamba() {
+  rm -f /var/log/samba/log.smbd
+
+  if ! smbd -l /var/log/samba; then
     SAMBA_DEBUG="Y"
     error "Failed to start Samba daemon!"
-fi
+  fi
 
-if enabled "$SAMBA_DEBUG"; then
+  tailLogIfDebug /var/log/samba/log.smbd
-  tail -fn +0 /var/log/samba/log.smbd --pid=$$ &
+  return 0
-fi
+}
-
-case "${NETWORK,,}" in
-  "passt" | "slirp" )
-    return 0 ;;
-esac
-
-if [[ "${BOOT_MODE:-}" == "windows_legacy" ]]; then
 
+startNetbios() {
   # Enable NetBIOS on Windows 7 and lower
   enabled "$DEBUG" && echo "Starting NetBIOS daemon..."
 
@@ -200,12 +223,11 @@ if [[ "${BOOT_MODE:-}" == "windows_legacy" ]]; then
     error "Failed to start NetBIOS daemon!"
   fi
 
-  if enabled "$SAMBA_DEBUG"; then
+  tailLogIfDebug /var/log/samba/log.nmbd
-    tail -fn +0 /var/log/samba/log.nmbd --pid=$$ &
+  return 0
-  fi
+}
-
-else
 
+startWsddn() {
   # Enable Web Service Discovery on Vista and up
   enabled "$DEBUG" && echo "Starting wsddn daemon..."
   rm -f /var/log/wsddn.log
@@ -215,10 +237,37 @@ else
     error "Failed to start wsddn daemon!"
   fi
 
-  if enabled "$SAMBA_DEBUG"; then
+  tailLogIfDebug /var/log/wsddn.log
-    tail -fn +0 /var/log/wsddn.log --pid=$$ &
+  return 0
-  fi
+}
 
+configureNetwork
+
+html "Initializing shared folder..."
+SAMBA_CONFIG="/etc/samba/smb.conf"
+enabled "$DEBUG" && echo "Starting Samba daemon..."
+
+writeSambaConfig
+
+# Add shared folders
+selectPrimaryShare
+! addShare "$share" "/shared" "Data" "Shared" "$SAMBA_CONFIG" && return 0
+
+addOptionalShare "2"
+addOptionalShare "3"
+
+prepareSambaDirs
+startSamba
+
+case "${NETWORK,,}" in
+  "passt" | "slirp" )
+    return 0 ;;
+esac
+
+if [[ "${BOOT_MODE:-}" == "windows_legacy" ]]; then
+  startNetbios
+else
+  startWsddn
 fi
 
 return 0