Refactor: harmonize tools/addon and move boilerplate into core.func (#16202)

misc/core.func

@@ -299,6 +299,72 @@ root_check() {
   fi
 }
 
+# ------------------------------------------------------------------------------
+# on_pve_host()
+#
+# - Returns 0 when executed on a Proxmox VE node, 1 otherwise
+# - Cheap probe used by the guards below; never exits on its own
+# ------------------------------------------------------------------------------
+on_pve_host() {
+  command -v pveversion &>/dev/null
+}
+
+# ------------------------------------------------------------------------------
+# require_pve_host()
+#
+# - Guard for tools that drive the node itself (pct/pveam/pvesm/pvesh/qm)
+# - Aborts when not on a PVE node, then validates the PVE version
+# ------------------------------------------------------------------------------
+require_pve_host() {
+  if ! on_pve_host; then
+    msg_error "${APP:-This script} must be run on the Proxmox VE host."
+    msg_error "Proxmox tooling (pct/pveam/pvesm/qm) is not available here."
+    exit 232
+  fi
+  pve_check
+}
+
+# ------------------------------------------------------------------------------
+# confirm_not_pve_host()
+#
+# - Guard for tools that belong inside an LXC/VM but would technically run
+#   on the node as well
+# - Warns and asks for confirmation instead of hard-failing
+# ------------------------------------------------------------------------------
+confirm_not_pve_host() {
+  on_pve_host || return 0
+
+  msg_error "Running on the Proxmox VE host is NOT recommended!"
+  msg_error "${APP:-This script} is meant to be executed inside an LXC container."
+  echo ""
+  echo -n "${TAB:-  }Continue anyway? (y/N): "
+  local confirm
+  read -r confirm
+  if [[ ! "${confirm,,}" =~ ^(y|yes)$ ]]; then
+    msg_warn "Aborted. Please run this inside an LXC container."
+    exit 0
+  fi
+  msg_warn "Proceeding on the Proxmox VE host at your own risk!"
+}
+
+# ------------------------------------------------------------------------------
+# require_debian_like()
+#
+# - Guard for addons that have no Alpine code path
+# - Aborts early instead of failing halfway through with apt/systemd errors
+# ------------------------------------------------------------------------------
+require_debian_like() {
+  if is_alpine; then
+    msg_error "${APP:-This script} does not support Alpine Linux."
+    msg_error "Please use a Debian or Ubuntu based LXC container."
+    exit 238
+  fi
+  if ! command -v apt-get &>/dev/null; then
+    msg_error "${APP:-This script} requires a Debian or Ubuntu based system."
+    exit 238
+  fi
+}
+
 # ------------------------------------------------------------------------------
 # pve_check()
 #
@@ -308,6 +374,10 @@ root_check() {
 # ------------------------------------------------------------------------------
 pve_check() {
   local PVE_VER
+  if ! on_pve_host; then
+    msg_error "${APP:-This script} must be run on the Proxmox VE host."
+    exit 232
+  fi
   PVE_VER="$(pveversion | awk -F'/' '{print $2}' | awk -F'-' '{print $1}')"
 
   # Check for Proxmox VE 8.x: allow 8.0–8.9

misc/tools.func

@@ -4628,6 +4628,53 @@ _docker_is_noninteractive() {
   [[ "${DOCKER_NONINTERACTIVE:-}" == "1" || "${DOCKER_NONINTERACTIVE:-}" == "true" || "${DOCKER_NONINTERACTIVE:-}" == "TRUE" ]] || [[ ! -t 0 ]]
 }
 
+# ------------------------------------------------------------------------------
+# ensure_docker()
+#
+# - Docker precondition for addon scripts that ship a compose stack
+# - Reuses an existing installation, otherwise offers to install Docker
+#   (Debian/Ubuntu via setup_docker, Alpine via apk)
+# - Aborts when the user declines or Compose is unavailable afterwards
+# ------------------------------------------------------------------------------
+ensure_docker() {
+  if command -v docker &>/dev/null; then
+    msg_ok "Docker $(docker --version | cut -d' ' -f3 | tr -d ',') is available"
+    if docker compose version &>/dev/null; then
+      msg_ok "Docker Compose is available"
+      return 0
+    fi
+    msg_error "Docker Compose plugin is not available. Please install it."
+    exit 237
+  fi
+
+  msg_warn "Docker is not installed."
+  echo -n "${TAB:-  }Install Docker now? (y/N): "
+  local install_docker_prompt
+  read -r install_docker_prompt
+  if [[ ! "${install_docker_prompt,,}" =~ ^(y|yes)$ ]]; then
+    msg_error "Docker is required for ${APP:-this script}. Exiting."
+    exit 254
+  fi
+
+  if is_alpine; then
+    msg_info "Installing Docker"
+    $STD apk add --no-cache docker docker-cli-compose
+    $STD rc-update add docker default
+    $STD rc-service docker start
+    msg_ok "Installed Docker"
+  else
+    setup_docker || {
+      msg_error "Docker installation failed."
+      exit 237
+    }
+  fi
+
+  if ! command -v docker &>/dev/null || ! docker compose version &>/dev/null; then
+    msg_error "Docker or the Compose plugin is still unavailable after installation."
+    exit 237
+  fi
+}
+
 setup_docker() {
   local docker_installed=false
   local USE_DOCKER_REPO="${USE_DOCKER_REPO:-true}"