more preflight checks, NO_CLEANUP; fixes #3

Author: mattieb

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+## 1.1.0 - 2025-11-19
+
+1.  Additional preflight checks were added to warn if trying to run this script on anything besides macOS (it's only designed and tested there) as well as error if "hdiutil" is missing.
+
+2.  The `NO_CLEANUP` environment variable was added to prevent the temporary directory from being removed on error or completion.
+
 ## 1.0.0 - 2024-10-15
 
 This is the first actual release. Before this point, windows-esd-to-iso was a rolling repository. All changes here are from the original version.

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2023, 2024 Mattie Behrens.
+Copyright (c) 2023, 2024, 2025 Mattie Behrens.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -18,6 +18,12 @@ windows-esd-to-iso ESD_FILE
 
 Converts the ESD in ESD_FILE to ISO format.
 
+On completion or on error, this tool removes its temporary directory (which can be large.) If you don't want this, set `NO_CLEANUP` to any value:
+
+```
+NO_CLEANUP=1 windows-esd-to-iso ESD_FILE
+```
+
 ## How it works
 
 [windows-esd-to-iso](./windows-esd-to-iso) will use the wimlib tools to inspect, deconstruct, and assemble into an installation tree the images inside an ESD.
@@ -35,11 +41,7 @@ If the script exits for any reason—successful or otherwise—the temporary dir
 
 ## Downloading ESDs
 
-There are a few ways you can get an ESD to convert with this tool.
-
-- [My own download-windows-esd tool](https://github.com/mattieb/download-windows-esd) will get the Windows 11 ESD catalog from Microsoft, then download any ESD you wish that is referenced in that catalog and verify its SHA1 checksum.
-- Paul Rockwell's [w11arm_esd2iso](https://communities.vmware.com/t5/VMware-Fusion-Documents/w11arm-esd2iso-a-utility-to-create-Windows-11-ARM-ISOs-from/ta-p/2957381) does both downloading and conversion of ARM images in a single shot.
-- Bogdan's [ESD to ISO on macOS](https://gist.github.com/b0gdanw/e36ea84828dbd19e03eff6158f1fc77c) explains how to get and search through the catalog and download manually.
+You can use [download-windows-esd](https://github.com/mattieb/download-windows-esd) to get the Windows 11 ESD catalog from Microsoft, then download any ESD you wish that is referenced in that catalog and verify its checksum.
 
 ## Converting to USB drives
 

windows-esd-to-iso

@@ -1,18 +1,18 @@
 #!/bin/sh
-# 
-# Copyright (c) 2023, 2024 Mattie Behrens.
-# 
+#
+# Copyright (c) 2023, 2024, 2025 Mattie Behrens.
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject
 # to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
@@ -22,75 +22,178 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-# Color support from portable-color <https://mattiebee.dev/portable-color>
+# MARK: color support
+# <https://mattiebee.dev/dye>
 
-_try_color() {
-	[ -n "${NO_COLOR}" ] && return 1
-	[ -n "${CLICOLOR_FORCE}" ] && return 0
+dye_detect() {
+	command -v tput >/dev/null || return 1
+	test -n "${NO_COLOR-}" && return 1
+	test -n "${CLICOLOR_FORCE-}" && return
 	test -t 1 || return 1
-	[ -n "${CLICOLOR}" ] && return 0
+	test -n "${CLICOLOR-}" && return
+	test "${1-}" = "default-off" && return 1
 	return 0
 }
-setup_color() {
-	TPUT=$(which tput 2>/dev/null) && _try_color || TPUT=true
-}
-_qtput() {
-	[ -z "${TPUT}" ] && return 0 # if not set up, don't do anything
-	"${TPUT}" "$@" 2>/dev/null || true
+
+dye_out() (
+	_1="$1"
+	_2="${2-}"
+	test -n "$1" && shift
+	test -n "${1-}" && shift
+	if [ -z "${DYE_COLORS-}" ]; then
+		printf "%s" "$*"
+		return
+	fi
+	if [ -z "${_2}" ] || [ -z "${1-}" ]; then
+		eval "tput ${_1}" || true
+		return
+	fi
+	eval "tput ${_1}" || true
+	printf "%s" "$*"
+	eval "tput ${_2}" || true
+)
+
+dye_color() (
+	case "$1" in
+	black) echo 0 ;;
+	red) echo 1 ;;
+	green) echo 2 ;;
+	yellow) echo 3 ;;
+	blue) echo 4 ;;
+	magenta) echo 5 ;;
+	cyan) echo 6 ;;
+	white | brightgray) echo 7 ;;
+	gray) echo 8 ;;
+	bright*)
+		base="$(dye_color "${1##*bright}")"
+		echo "$((8 + base))"
+		;;
+	'' | *[!0-9]*) return 1 ;;
+	*) echo "$1" ;;
+	esac
+)
+
+dye_synth() {
+	if [ "${DYE_COLORS}" = "8" ] && [ "$1" -ge 8 ] && [ "$1" -le 15 ]; then
+		echo $(($1 - 8))
+		return 1
+	fi
+	echo "$1"
 }
-_twrap() {
-	output="$1"
-	shift
-	_qtput "$@"
-	printf %s "$output"
-	_qtput sgr0
+
+dye() {
+	if [ "$1" = "setup" ]; then
+		shift
+		dye_detect "$@" && DYE_COLORS="$(tput colors)"
+		return 0
+	fi
+
+	(
+		_1="$1"
+		shift
+		case "${_1}" in
+		fg)
+			c="$(dye_color "$1")" || return
+			c="$(dye_synth "${c}")" || dye_out bold
+			shift
+			dye_out "setaf ${c}" "sgr0" "$@"
+			;;
+		bg)
+			c="$(dye_color "$1")" || return
+			c="$(dye_synth "${c}")" || true
+			shift
+			dye_out "setab ${c}" "sgr0" "$@"
+			;;
+		dim) dye_out "dim" "sgr0" "$@" ;;
+		bold) dye_out "bold" "sgr0" "$@" ;;
+		reverse) dye_out "rev" "sgr0" "$@" ;;
+		reset) dye_out "sgr0" ;;
+		i | italic) dye_out "sitm" "ritm" "$@" ;;
+		so | standout) dye_out "smso" "rmso" "$@" ;;
+		u | ul | underline) dye_out "smul" "rmul" "$@" ;;
+		begin) dye "$@" ;;
+		end)
+			case "$1" in
+			i | italic) dye_out "ritm" ;;
+			so | standout) dye_out "rmso" ;;
+			u | ul | underline) dye_out "rmul" ;;
+			*) return 1 ;;
+			esac
+			;;
+		*)
+			dye fg "${_1}" "$@"
+			;;
+		esac
+	)
 }
-bold() { _twrap "$1" bold; }
-red() { _twrap "$1" setaf 1; }
-green() { _twrap "$1" setaf 2; }
-blue() { _twrap "$1" setaf 4; }
 
-print_task() { echo "$(green "==>") $(bold "$@")"; }
-print_subtask() { echo "$(blue "==>") $(bold "$@")"; }
+# MARK: user interface
 
-set -e
-setup_color
+print_task() { echo "$(dye green "==>") $(dye bold "$*")"; }
+print_subtask() { echo "$(dye blue "==>") $(dye bold "$*")"; }
+print_error() { echo "$(dye red "Error:") $*"; }
+print_warning() { echo "$(dye yellow "Warning:") $*"; }
 
-if [ -z "$1" ] || [ "$1" = "-h" ]; then
-	echo "$(red "Usage:") $(basename "$0") ESD"
+set -eu
+
+dye setup
+
+# MARK: preflight checks
+
+script="$(basename "$0")"
+
+if [ "$(uname)" != "Darwin" ]; then
+	print_warning "$(dye bold "${script}") is currently for macOS and may not work here"
+fi
+
+if [ -z "${1-}" ] || [ "$1" = "-h" ]; then
+	echo "$(dye red "Usage:") ${script} ESD"
 	exit 0
 fi
 
-check_tool() {
+check_wimlib_tool() {
 	if ! which "$1" >/dev/null; then
-		echo "$(red "Error:") wimlib tools not found"
+		print_error "wimlib tools not found"
 		exit 1
 	fi
 }
-check_tool wiminfo
-check_tool wimapply
-check_tool wimexport
+check_wimlib_tool wiminfo
+check_wimlib_tool wimapply
+check_wimlib_tool wimexport
+
+if ! which hdiutil >/dev/null; then
+	print_error "hdiutil (a standard macOS tool) not found"
+	exit 1
+fi
 
 esd="$1"
 
 if [ ! -f "${esd}" ]; then
-	echo "$(red "Error:") ${esd} not found"
+	print_error "$(dye green "${esd}") not found"
 	exit 2
 fi
 
+# MARK: cleanup exit hook
+
 tmpdir=$(mktemp -d)
 
 __cleanup() {
-	print_task "Cleaning up $(green "${tmpdir}")"
-	rm -rf "${tmpdir}"
+	if [ -z "${NO_CLEANUP-}" ]; then
+		print_task "Cleaning up $(dye green "${tmpdir}")"
+		rm -rf "${tmpdir}"
+	else
+		print_warning "NO_CLEANUP was set; $(dye green "${tmpdir}") will not be removed"
+	fi
 }
 trap __cleanup EXIT
 
-print_task "Exporting images from $(green "${esd}")"
+# MARK: export images
+
+print_task "Exporting images from $(dye green "${esd}")"
 
 image_count=$(wiminfo "${esd}" --header | grep '^Image Count' | cut -d= -f 2)
 if ! [ "${image_count}" -gt 0 ] 2>/dev/null; then
-	echo "$(red "Error:") could not get ${esd} image count"
+	print_error "could not get image count"
 	exit 3
 fi
 echo "Found ${image_count} images."
@@ -115,11 +218,13 @@ for index in $(seq 4 "${image_count}"); do
 		--compress=LZMS --chunk-size 128K --recompress
 done
 
+# MARK: create ISO
+
 basename="$(basename "${esd}" .esd)"
 iso="${basename}.iso"
 
 rm -f "${iso}"
-print_task "Creating ${iso}"
+print_task "Creating $(dye green "${iso}")"
 hdiutil makehybrid \
 	-o "${iso}" \
 	-iso -udf \