Varaverk/Tools/docker_prune_images.sh

#!/bin/bash
# ==============================================================================================
# ============================= Docker Prune Images ============================================
# ==============================================================================================
#
# PURPOSE
# ─────────────────────────────────────────────────────────────────────────────
# Removes orphaned Docker images. Two modes:
#
# Default — dangling only (safe, fast):
#   Removes untagged images (no name, no container reference). These accumulate
#   after container updates pull a new image, leaving the old one untagged.
#   Running containers are never affected.
#
# --all — full orphan cleanup:
#   Step 1: removes stopped containers (exited/created state).
#   Step 2: removes all images not used by any running container.
#   Use this to clear tagged images left behind by removed or stopped apps.
#   CAUTION: also removes intentionally stopped containers — only run when you
#   know all stopped containers are safe to delete.
#
# ==============================================================================================
# DESIGN PRINCIPLES
# ==============================================================================================
#
# Safe Default, Explicit Escalation
#   The default mode (dangling only) is always safe — running containers are
#   never affected. The --all mode requires deliberate opt-in and carries an
#   explicit caution in the description, because it removes stopped containers
#   that may be intentionally paused.
#
# ==============================================================================================
# OPERATIONAL SAFEGUARDS
# ==============================================================================================
#
#   Root check   — Docker prune operations require root
#   acquire_lock — prevents concurrent prune runs
#   --dry-run    — shows what would be removed without taking any action
#   --status     — lists current dangling images and stopped containers; no changes
#
# ==============================================================================================
# RUNTIME MODES
# ==============================================================================================
#
# docker_prune_images.sh
#     Remove dangling (untagged) images only.
#
# docker_prune_images.sh --all
#     Remove stopped containers, then remove all unused images.
#
# docker_prune_images.sh --dry-run
#     Show what would be removed without making changes.
#
# docker_prune_images.sh --status
#     Show dangling images and stopped containers. No changes.
#
# ==============================================================================================

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

source "$SCRIPT_DIR/../load_config.sh"

# ── Handle --all before parse_args ────────────────────────────────────────────
ALL_MODE=false
FILTERED_ARGS=()
for _arg in "$@"; do
    [[ "$_arg" == "--all" ]] && ALL_MODE=true || FILTERED_ARGS+=("$_arg")
done
parse_args "${FILTERED_ARGS[@]}"

# ==============================================================================================
# ━━━ Setup ━━━
# ==============================================================================================
if [[ "$EUID" -ne 0 ]]; then
    error "Must be run as root"
    exit 1
fi

acquire_lock

# ==============================================================================================
# ━━━ Status ━━━
# ==============================================================================================
if [[ "$SHOW_STATUS" == true ]]; then
    echo ""
    echo "━━━━━ $ICON_SUMMARY DOCKER PRUNE IMAGES STATUS ━━━━━"

    DANGLING=$(docker images -f "dangling=true" --format "{{.ID}}\t{{.Repository}}:{{.Tag}}\t{{.Size}}\t{{.CreatedSince}}" 2>/dev/null)
    STOPPED=$(docker ps -a --filter "status=exited" --filter "status=created" \
        --format "{{.ID}}\t{{.Names}}\t{{.Image}}\t{{.Status}}" 2>/dev/null)

    echo ""
    echo "$ICON_CONTAINERS  Dangling images (no tag, no container):"
    if [[ -z "$DANGLING" ]]; then
        echo "    none"
    else
        echo "$DANGLING" | while IFS=$'\t' read -r id repo size age; do
            echo "    $id   $repo   $size   $age"
        done
    fi

    echo ""
    echo "$ICON_CONTAINERS  Stopped containers (--all would remove these first):"
    if [[ -z "$STOPPED" ]]; then
        echo "    none"
    else
        echo "$STOPPED" | while IFS=$'\t' read -r id name image status; do
            echo "    $name   ($image)   $status"
        done
    fi

    echo ""
    echo "━━━━━━━━━━━━━━━━━━━━━━━"
    exit 0
fi

# ==============================================================================================
# ━━━ Run ━━━
# ==============================================================================================
MODE_LABEL=$([[ "$ALL_MODE" == true ]] && echo "full orphan cleanup" || echo "dangling only")
log "$ICON_GEAR Config: mode=${MODE_LABEL} dry-run=${DRY_RUN}"
echo "━━━ $ICON_CONTAINERS Docker Prune Images ($MODE_LABEL) — $(date '+%Y-%m-%d %H:%M:%S') ━━━"

TOTAL_RECLAIMED=0

# ── Step 1 (--all only): remove stopped containers ────────────────────────────
if [[ "$ALL_MODE" == true ]]; then
    STOPPED_IDS=$(docker ps -a --filter "status=exited" --filter "status=created" -q 2>/dev/null)
    STOPPED_COUNT=$(echo "$STOPPED_IDS" | grep -c . || echo 0)

    if [[ "$STOPPED_COUNT" -eq 0 ]]; then
        echo "No stopped containers"
    elif [[ "$DRY_RUN" == true ]]; then
        warn "DRY RUN — would remove $STOPPED_COUNT stopped container(s):"
        docker ps -a --filter "status=exited" --filter "status=created" \
            --format "  {{.Names}}   {{.Image}}   {{.Status}}" 2>/dev/null
    else
        echo "Removing $STOPPED_COUNT stopped container(s)..."
        docker container prune -f 2>&1 | grep -v "^Total\|^$" || true
        success "Removed $STOPPED_COUNT stopped container(s)"
    fi
    echo ""
fi

# ── Step 2: prune images ───────────────────────────────────────────────────────
PRUNE_FLAGS=$([[ "$ALL_MODE" == true ]] && echo "-a" || echo "")
PRUNE_FILTER=$([[ "$ALL_MODE" == true ]] && echo "" || echo '-f "dangling=true"')

# Preview count
if [[ "$ALL_MODE" == true ]]; then
    # Images not used by any running container
    RUNNING_IMAGES=$(docker ps --format "{{.Image}}" 2>/dev/null)
    UNUSED_COUNT=$(docker images --format "{{.Repository}}:{{.Tag}}" 2>/dev/null \
        | grep -vxF "$RUNNING_IMAGES" | grep -c . || echo 0)
    TARGET_LABEL="$UNUSED_COUNT unused image(s)"
else
    DANGLING_IDS=$(docker images -f "dangling=true" -q 2>/dev/null)
    UNUSED_COUNT=$(echo "$DANGLING_IDS" | grep -c . || echo 0)
    TARGET_LABEL="$UNUSED_COUNT dangling image(s)"
fi

if [[ "$UNUSED_COUNT" -eq 0 ]]; then
    success "No images to remove"
    exit 0
fi

if [[ "$DRY_RUN" == true ]]; then
    warn "DRY RUN — would remove $TARGET_LABEL:"
    if [[ "$ALL_MODE" == true ]]; then
        docker images --format "  {{.Repository}}:{{.Tag}}   {{.Size}}   {{.CreatedSince}}" 2>/dev/null \
            | grep -vF "$(docker ps --format '{{.Image}}' 2>/dev/null)" || true
    else
        docker images -f "dangling=true" \
            --format "  {{.ID}}   {{.Size}}   created {{.CreatedSince}}" 2>/dev/null
    fi
    exit 0
fi

log "Pruning $TARGET_LABEL..."
OUTPUT=$(docker image prune $PRUNE_FLAGS -f 2>&1)
[[ "$ENABLE_LOGGING" == "true" ]] && echo "$OUTPUT" | sed 's/^/  /'
RECLAIMED=$(echo "$OUTPUT" | grep -E "^Total reclaimed" || echo "Total reclaimed space: unknown")
success "Done — $RECLAIMED"