@minecraft-docker/mcctl 1.6.13 → 1.6.15

package/scripts/lib/common.sh

@@ -0,0 +1,248 @@
+#!/bin/bash
+# =============================================================================
+# common.sh - Shared functions for mcctl scripts
+# =============================================================================
+# Source this file in other scripts:
+#   source "$(dirname "${BASH_SOURCE[0]}")/lib/common.sh"
+#
+# When running via npm package (mcctl CLI), these environment variables are set:
+#   MCCTL_ROOT     - User data directory (~/.minecraft-servers)
+#   MCCTL_SCRIPTS  - Package scripts directory
+#   MCCTL_TEMPLATES - Package templates directory
+# =============================================================================
+
+# Get script/platform directories
+# Support both direct execution and npm package execution
+if [[ -n "${MCCTL_ROOT:-}" ]]; then
+    # Running via npm package (mcctl CLI)
+    PLATFORM_DIR="$MCCTL_ROOT"
+    SCRIPT_DIR="${MCCTL_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)}"
+    TEMPLATES_DIR="${MCCTL_TEMPLATES:-$PLATFORM_DIR/servers/_template}"
+else
+    # Running directly (development mode)
+    SCRIPT_DIR="${SCRIPT_DIR:-$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)}"
+    PLATFORM_DIR="${PLATFORM_DIR:-$(dirname "$SCRIPT_DIR")}"
+    TEMPLATES_DIR="$PLATFORM_DIR/servers/_template"
+fi
+
+# Export for sub-scripts
+export PLATFORM_DIR SCRIPT_DIR TEMPLATES_DIR
+
+# Colors (disabled if not terminal or JSON output)
+setup_colors() {
+    if [[ -t 1 ]] && [[ "${JSON_OUTPUT:-}" != "true" ]]; then
+        RED='\033[0;31m'
+        GREEN='\033[0;32m'
+        YELLOW='\033[1;33m'
+        BLUE='\033[0;34m'
+        CYAN='\033[0;36m'
+        BOLD='\033[1m'
+        NC='\033[0m'
+    else
+        RED=''
+        GREEN=''
+        YELLOW=''
+        BLUE=''
+        CYAN=''
+        BOLD=''
+        NC=''
+    fi
+}
+setup_colors
+
+# =============================================================================
+# Output Functions
+# =============================================================================
+
+error() {
+    echo -e "${RED}[ERROR]${NC} $1" >&2
+}
+
+warn() {
+    echo -e "${YELLOW}[WARN]${NC} $1" >&2
+}
+
+info() {
+    echo -e "${GREEN}[INFO]${NC} $1"
+}
+
+debug() {
+    if [[ "${DEBUG:-}" == "true" ]]; then
+        echo -e "${BLUE}[DEBUG]${NC} $1" >&2
+    fi
+}
+
+# =============================================================================
+# Sudo Functions
+# =============================================================================
+# Supports MCCTL_SUDO_PASSWORD environment variable for automation
+# When set, uses sudo -S to pipe password via stdin
+
+# Run command with sudo, supporting MCCTL_SUDO_PASSWORD for automation
+# Usage: run_with_sudo <command> [args...]
+# Example: run_with_sudo tee -a /etc/avahi/hosts
+# Example: run_with_sudo systemctl restart avahi-daemon
+run_with_sudo() {
+    if [[ -z "$*" ]]; then
+        error "run_with_sudo: No command specified"
+        return 1
+    fi
+
+    if [[ -n "${MCCTL_SUDO_PASSWORD:-}" ]]; then
+        # Automation mode: use sudo -S to read password from stdin
+        debug "Using MCCTL_SUDO_PASSWORD for sudo"
+        echo "$MCCTL_SUDO_PASSWORD" | sudo -S "$@" 2>/dev/null
+    else
+        # Interactive mode: let sudo prompt for password
+        sudo "$@"
+    fi
+}
+
+# Run command with sudo and capture output (for commands like tee)
+# Usage: echo "content" | run_with_sudo_stdin <command> [args...]
+# Example: echo "$ip $hostname" | run_with_sudo_stdin tee -a /etc/avahi/hosts
+run_with_sudo_stdin() {
+    if [[ -z "$*" ]]; then
+        error "run_with_sudo_stdin: No command specified"
+        return 1
+    fi
+
+    if [[ -n "${MCCTL_SUDO_PASSWORD:-}" ]]; then
+        # Automation mode: need to handle both password and stdin content
+        # Use expect-like approach with heredoc
+        local stdin_content
+        stdin_content=$(cat)
+        debug "Using MCCTL_SUDO_PASSWORD for sudo with stdin"
+        {
+            echo "$MCCTL_SUDO_PASSWORD"
+            echo "$stdin_content"
+        } | sudo -S "$@" 2>/dev/null
+    else
+        # Interactive mode: let sudo prompt for password, pass stdin through
+        sudo "$@"
+    fi
+}
+
+# Check if sudo password is configured for automation
+has_sudo_password() {
+    [[ -n "${MCCTL_SUDO_PASSWORD:-}" ]]
+}
+
+# Validate sudo password (test if it works)
+validate_sudo_password() {
+    if [[ -z "${MCCTL_SUDO_PASSWORD:-}" ]]; then
+        return 1
+    fi
+    echo "$MCCTL_SUDO_PASSWORD" | sudo -S -v 2>/dev/null
+}
+
+# =============================================================================
+# Docker Functions
+# =============================================================================
+
+# Check if Docker is available
+check_docker() {
+    if ! command -v docker &> /dev/null; then
+        error "Docker is not installed or not in PATH"
+        return 1
+    fi
+    if ! docker info &> /dev/null; then
+        error "Docker daemon is not running or permission denied"
+        return 1
+    fi
+    return 0
+}
+
+# Get container status (running, exited, paused, etc.)
+get_container_status() {
+    local container="$1"
+    local status
+    status=$(docker inspect --format '{{.State.Status}}' "$container" 2>/dev/null) || status="not_found"
+    echo -n "$status"
+}
+
+# Check if container exists
+container_exists() {
+    local container="$1"
+    docker inspect "$container" &>/dev/null
+}
+
+# Get container health status
+get_container_health() {
+    local container="$1"
+    local health
+    health=$(docker inspect --format '{{if .State.Health}}{{.State.Health.Status}}{{else}}none{{end}}' "$container" 2>/dev/null) || health="unknown"
+    echo -n "$health"
+}
+
+# Get minecraft server containers (those starting with mc-)
+get_mc_containers() {
+    docker ps -a --filter "name=mc-" --format '{{.Names}}' | grep -v "mc-router" | sort
+}
+
+# Get running minecraft server containers
+get_running_mc_containers() {
+    docker ps --filter "name=mc-" --filter "status=running" --format '{{.Names}}' | grep -v "mc-router" | sort
+}
+
+# Get container's assigned world (from environment or volume mount)
+get_container_world() {
+    local container="$1"
+    # Check WORLD environment variable first
+    local world=$(docker inspect --format '{{range .Config.Env}}{{println .}}{{end}}' "$container" 2>/dev/null | grep "^WORLD=" | cut -d= -f2)
+    if [[ -n "$world" ]]; then
+        echo "$world"
+        return
+    fi
+    # Otherwise try to get from volume mount
+    echo "-"
+}
+
+# Get container's hostname label (mc-router.host)
+get_container_hostname() {
+    local container="$1"
+    local hostname
+    hostname=$(docker inspect --format '{{index .Config.Labels "mc-router.host"}}' "$container" 2>/dev/null) || hostname="-"
+    [[ -z "$hostname" ]] && hostname="-"
+    echo -n "$hostname"
+}
+
+# =============================================================================
+# JSON Output Functions
+# =============================================================================
+
+# Escape string for JSON
+json_escape() {
+    local str="$1"
+    str="${str//\\/\\\\}"
+    str="${str//\"/\\\"}"
+    str="${str//$'\n'/\\n}"
+    str="${str//$'\r'/\\r}"
+    str="${str//$'\t'/\\t}"
+    echo "$str"
+}
+
+# =============================================================================
+# Path Functions
+# =============================================================================
+
+get_servers_dir() {
+    echo "$PLATFORM_DIR/servers"
+}
+
+get_worlds_dir() {
+    echo "$PLATFORM_DIR/worlds"
+}
+
+get_locks_dir() {
+    echo "$PLATFORM_DIR/worlds/.locks"
+}
+
+# List all server directories
+get_server_names() {
+    local servers_dir
+    servers_dir=$(get_servers_dir)
+    if [[ -d "$servers_dir" ]]; then
+        find "$servers_dir" -maxdepth 1 -mindepth 1 -type d ! -name '_template' -exec basename {} \; 2>/dev/null | sort
+    fi
+}

package/scripts/lock.sh

@@ -0,0 +1,448 @@
+#!/bin/bash
+# =============================================================================
+# lock.sh - World locking system for Minecraft servers
+# =============================================================================
+# Provides flock-based exclusive locking to prevent simultaneous world access.
+#
+# Usage:
+#   ./scripts/lock.sh lock <world> <server>    # Acquire lock
+#   ./scripts/lock.sh unlock <world> <server>  # Release lock
+#   ./scripts/lock.sh check <world>            # Check lock status
+#   ./scripts/lock.sh list                     # List all locks
+#   ./scripts/lock.sh list --json              # JSON output
+#
+# Lock file format:
+#   worlds/.locks/<world-name>.lock
+#   Content: <server-name>:<timestamp>:<pid>
+#
+# Exit codes:
+#   0 - Success
+#   1 - Error (lock failed, invalid args, etc.)
+#   2 - Warning (lock already held, stale lock detected)
+# =============================================================================
+
+set -e
+
+# Get script/platform directories
+# Support both direct execution and npm package execution (mcctl CLI)
+if [[ -n "${MCCTL_ROOT:-}" ]]; then
+    # Running via npm package
+    PLATFORM_DIR="$MCCTL_ROOT"
+    SCRIPT_DIR="${MCCTL_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)}"
+else
+    # Running directly (development mode)
+    SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+    PLATFORM_DIR="$(dirname "$SCRIPT_DIR")"
+fi
+
+WORLDS_DIR="$PLATFORM_DIR/worlds"
+LOCKS_DIR="$WORLDS_DIR/.locks"
+
+# Configuration
+STALE_THRESHOLD=86400  # 24 hours in seconds
+
+# Colors (disabled if not terminal)
+if [[ -t 1 ]]; then
+    RED='\033[0;31m'
+    GREEN='\033[0;32m'
+    YELLOW='\033[1;33m'
+    BLUE='\033[0;34m'
+    NC='\033[0m'
+else
+    RED=''
+    GREEN=''
+    YELLOW=''
+    BLUE=''
+    NC=''
+fi
+
+# =============================================================================
+# Helper Functions
+# =============================================================================
+
+usage() {
+    cat <<EOF
+Usage: $(basename "$0") <command> [options]
+
+Commands:
+  lock <world> <server>    Acquire exclusive lock on world for server
+  unlock <world> <server>  Release lock (only owner can release)
+  check <world>            Check if world is locked
+  list [--json]            List all worlds and their lock status
+
+Options:
+  --json                   Output in JSON format (for list command)
+  --force                  Force unlock (admin override, use with caution)
+
+Exit codes:
+  0 - Success
+  1 - Error
+  2 - Warning (lock held by another, stale lock)
+
+Examples:
+  $(basename "$0") lock survival mc-ironwood
+  $(basename "$0") unlock survival mc-ironwood
+  $(basename "$0") check survival
+  $(basename "$0") list --json
+EOF
+}
+
+error() {
+    echo -e "${RED}[ERROR]${NC} $1" >&2
+}
+
+warn() {
+    echo -e "${YELLOW}[WARN]${NC} $1" >&2
+}
+
+info() {
+    echo -e "${GREEN}[INFO]${NC} $1"
+}
+
+debug() {
+    if [[ "${DEBUG:-}" == "true" ]]; then
+        echo -e "${BLUE}[DEBUG]${NC} $1" >&2
+    fi
+}
+
+# Ensure locks directory exists
+ensure_locks_dir() {
+    if [[ ! -d "$LOCKS_DIR" ]]; then
+        mkdir -p "$LOCKS_DIR"
+        debug "Created locks directory: $LOCKS_DIR"
+    fi
+}
+
+# Get lock file path for a world
+get_lock_file() {
+    local world="$1"
+    echo "$LOCKS_DIR/${world}.lock"
+}
+
+# Parse lock file content
+# Returns: server:timestamp:pid
+parse_lock_file() {
+    local lock_file="$1"
+    if [[ -f "$lock_file" ]]; then
+        cat "$lock_file"
+    fi
+}
+
+# Check if lock is stale (older than threshold)
+is_stale_lock() {
+    local lock_file="$1"
+    local lock_content
+    local lock_timestamp
+    local current_time
+    local age
+
+    if [[ ! -f "$lock_file" ]]; then
+        return 1  # No lock file, not stale
+    fi
+
+    lock_content=$(parse_lock_file "$lock_file")
+    lock_timestamp=$(echo "$lock_content" | cut -d: -f2)
+
+    if [[ -z "$lock_timestamp" ]]; then
+        return 0  # Invalid format, consider stale
+    fi
+
+    current_time=$(date +%s)
+    age=$((current_time - lock_timestamp))
+
+    if [[ $age -gt $STALE_THRESHOLD ]]; then
+        return 0  # Stale
+    fi
+
+    return 1  # Not stale
+}
+
+# Get all world directories
+get_worlds() {
+    if [[ -d "$WORLDS_DIR" ]]; then
+        find "$WORLDS_DIR" -maxdepth 1 -mindepth 1 -type d ! -name '.locks' -exec basename {} \; 2>/dev/null | sort
+    fi
+}
+
+# =============================================================================
+# Lock Functions
+# =============================================================================
+
+# Acquire lock on a world
+# Usage: lock_world <world> <server>
+lock_world() {
+    local world="$1"
+    local server="$2"
+    local lock_file
+    local lock_content
+    local current_holder
+    local timestamp
+    local pid
+
+    if [[ -z "$world" || -z "$server" ]]; then
+        error "Usage: lock <world> <server>"
+        return 1
+    fi
+
+    ensure_locks_dir
+    lock_file=$(get_lock_file "$world")
+    timestamp=$(date +%s)
+    pid=$$
+
+    # Use flock for atomic locking
+    (
+        flock -n 200 || {
+            # Lock is held, check who owns it
+            if [[ -f "$lock_file" ]]; then
+                lock_content=$(parse_lock_file "$lock_file")
+                current_holder=$(echo "$lock_content" | cut -d: -f1)
+
+                if [[ "$current_holder" == "$server" ]]; then
+                    warn "World '$world' is already locked by this server ($server)"
+                    exit 2
+                else
+                    error "World '$world' is locked by '$current_holder'"
+                    exit 1
+                fi
+            fi
+            error "Failed to acquire lock on '$world'"
+            exit 1
+        }
+
+        # Check for existing lock file
+        if [[ -f "$lock_file" ]]; then
+            lock_content=$(parse_lock_file "$lock_file")
+            current_holder=$(echo "$lock_content" | cut -d: -f1)
+
+            if [[ "$current_holder" == "$server" ]]; then
+                # Same server, update timestamp
+                echo "${server}:${timestamp}:${pid}" > "$lock_file"
+                info "Lock renewed: $world -> $server"
+                exit 0
+            fi
+
+            # Check for stale lock
+            if is_stale_lock "$lock_file"; then
+                warn "Removing stale lock on '$world' (was held by '$current_holder')"
+                rm -f "$lock_file"
+            else
+                error "World '$world' is locked by '$current_holder'"
+                exit 1
+            fi
+        fi
+
+        # Create lock file
+        echo "${server}:${timestamp}:${pid}" > "$lock_file"
+        info "Lock acquired: $world -> $server"
+        exit 0
+    ) 200>"$lock_file.flock"
+
+    local result=$?
+    rm -f "$lock_file.flock"
+    return $result
+}
+
+# Release lock on a world
+# Usage: unlock_world <world> <server> [--force]
+unlock_world() {
+    local world="$1"
+    local server="$2"
+    local force="${3:-}"
+    local lock_file
+    local lock_content
+    local current_holder
+
+    if [[ -z "$world" || -z "$server" ]]; then
+        error "Usage: unlock <world> <server>"
+        return 1
+    fi
+
+    lock_file=$(get_lock_file "$world")
+
+    if [[ ! -f "$lock_file" ]]; then
+        warn "World '$world' is not locked"
+        return 2
+    fi
+
+    lock_content=$(parse_lock_file "$lock_file")
+    current_holder=$(echo "$lock_content" | cut -d: -f1)
+
+    # Check ownership
+    if [[ "$current_holder" != "$server" ]]; then
+        if [[ "$force" == "--force" ]]; then
+            warn "Force unlocking '$world' (was held by '$current_holder')"
+        else
+            error "World '$world' is locked by '$current_holder', not '$server'"
+            error "Use --force to override (admin only)"
+            return 1
+        fi
+    fi
+
+    # Remove lock file
+    rm -f "$lock_file"
+    info "Lock released: $world (was held by $current_holder)"
+    return 0
+}
+
+# Check lock status of a world
+# Usage: check_lock <world>
+check_lock() {
+    local world="$1"
+    local lock_file
+    local lock_content
+    local holder
+    local timestamp
+    local lock_time
+    local age
+
+    if [[ -z "$world" ]]; then
+        error "Usage: check <world>"
+        return 1
+    fi
+
+    lock_file=$(get_lock_file "$world")
+
+    if [[ ! -f "$lock_file" ]]; then
+        echo "unlocked"
+        return 0
+    fi
+
+    lock_content=$(parse_lock_file "$lock_file")
+    holder=$(echo "$lock_content" | cut -d: -f1)
+    timestamp=$(echo "$lock_content" | cut -d: -f2)
+
+    if [[ -n "$timestamp" ]]; then
+        lock_time=$(date -d "@$timestamp" "+%Y-%m-%d %H:%M:%S" 2>/dev/null || date -r "$timestamp" "+%Y-%m-%d %H:%M:%S" 2>/dev/null || echo "unknown")
+        age=$(( $(date +%s) - timestamp ))
+
+        if is_stale_lock "$lock_file"; then
+            echo "stale:$holder:$lock_time (${age}s ago)"
+            return 2
+        else
+            echo "locked:$holder:$lock_time (${age}s ago)"
+            return 0
+        fi
+    else
+        echo "locked:$holder:unknown"
+        return 0
+    fi
+}
+
+# List all worlds and their lock status
+# Usage: list_locks [--json]
+list_locks() {
+    local json_output="${1:-}"
+    local worlds
+    local world
+    local lock_file
+    local lock_content
+    local holder
+    local timestamp
+    local lock_time
+    local status
+    local first=true
+
+    ensure_locks_dir
+
+    if [[ "$json_output" == "--json" ]]; then
+        echo "{"
+        echo '  "worlds": ['
+    else
+        printf "%-20s %-12s %-20s %s\n" "WORLD" "STATUS" "HOLDER" "LOCKED_AT"
+        printf "%-20s %-12s %-20s %s\n" "-----" "------" "------" "---------"
+    fi
+
+    worlds=$(get_worlds)
+
+    for world in $worlds; do
+        lock_file=$(get_lock_file "$world")
+        holder=""
+        timestamp=""
+        lock_time=""
+
+        if [[ -f "$lock_file" ]]; then
+            lock_content=$(parse_lock_file "$lock_file")
+            holder=$(echo "$lock_content" | cut -d: -f1)
+            timestamp=$(echo "$lock_content" | cut -d: -f2)
+
+            if [[ -n "$timestamp" ]]; then
+                lock_time=$(date -d "@$timestamp" "+%Y-%m-%d %H:%M:%S" 2>/dev/null || date -r "$timestamp" "+%Y-%m-%d %H:%M:%S" 2>/dev/null || echo "unknown")
+            fi
+
+            if is_stale_lock "$lock_file"; then
+                status="stale"
+            else
+                status="locked"
+            fi
+        else
+            status="available"
+            holder="-"
+            lock_time="-"
+        fi
+
+        if [[ "$json_output" == "--json" ]]; then
+            if [[ "$first" != "true" ]]; then
+                echo ","
+            fi
+            first=false
+            printf '    {"name": "%s", "status": "%s"' "$world" "$status"
+            if [[ "$status" != "available" ]]; then
+                printf ', "holder": "%s", "locked_at": "%s", "timestamp": %s' "$holder" "$lock_time" "${timestamp:-null}"
+            fi
+            printf "}"
+        else
+            printf "%-20s %-12s %-20s %s\n" "$world" "$status" "$holder" "$lock_time"
+        fi
+    done
+
+    if [[ "$json_output" == "--json" ]]; then
+        echo ""
+        echo "  ],"
+        echo "  \"locks_dir\": \"$LOCKS_DIR\","
+        echo "  \"stale_threshold_seconds\": $STALE_THRESHOLD"
+        echo "}"
+    fi
+}
+
+# =============================================================================
+# Main
+# =============================================================================
+
+main() {
+    local command="${1:-}"
+    shift || true
+
+    case "$command" in
+        lock)
+            lock_world "$@"
+            ;;
+        unlock)
+            unlock_world "$@"
+            ;;
+        check)
+            check_lock "$@"
+            ;;
+        list)
+            list_locks "$@"
+            ;;
+        -h|--help|help)
+            usage
+            exit 0
+            ;;
+        "")
+            error "No command specified"
+            usage
+            exit 1
+            ;;
+        *)
+            error "Unknown command: $command"
+            usage
+            exit 1
+            ;;
+    esac
+}
+
+# Run main if script is executed directly
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+    main "$@"
+fi