From f06d347ae2a116c75836ca376cae1f3bcf3740c2 Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Tue, 3 Dec 2024 08:39:12 +0100
Subject: [PATCH] firmware: change this for symmetry

---
 src/opnsense/scripts/firmware/check.sh      | 10 +--
 src/opnsense/scripts/firmware/config.sh     |  6 +-
 src/opnsense/scripts/firmware/connection.sh | 14 ++--
 src/opnsense/scripts/firmware/health.sh     | 84 ++++++++++-----------
 src/opnsense/scripts/firmware/install.sh    |  2 +-
 src/opnsense/scripts/firmware/lock.sh       |  4 +-
 src/opnsense/scripts/firmware/sync.subr.sh  |  2 +-
 src/opnsense/scripts/firmware/unlock.sh     |  4 +-
 8 files changed, 63 insertions(+), 63 deletions(-)

diff --git a/src/opnsense/scripts/firmware/check.sh b/src/opnsense/scripts/firmware/check.sh
index 63a106792..b9e544217 100755
--- a/src/opnsense/scripts/firmware/check.sh
+++ b/src/opnsense/scripts/firmware/check.sh
@@ -91,17 +91,17 @@ fi
 
 # business subscriptions come with additional license metadata
 if [ -n "$(opnsense-update -x)" ]; then
-    output_text -n "Fetching subscription information, please wait... "
+    output_txt -n "Fetching subscription information, please wait... "
     if output_cmd fetch -qT 30 -o "${LICENSEFILE}" "$(opnsense-update -M)/subscription"; then
-        output_text "done"
+        output_txt "done"
     fi
 else
     rm -f ${LICENSEFILE}
 fi
 
-output_text -n "Fetching changelog information, please wait... "
+output_txt -n "Fetching changelog information, please wait... "
 if output_cmd ${BASEDIR}/changelog.sh fetch; then
-    output_text "done"
+    output_txt "done"
 fi
 
 : > ${OUTFILE}
@@ -154,7 +154,7 @@ else
     elif [ -z "$(${PKG} rquery %n ${product_id})" ]; then
         # although this should say "to update matching" we emulate for
         # check below as the package manager does not catch this
-        output_text -o ${OUTFILE} "self: No packages available to install matching '${product_id}'"
+        output_txt -o ${OUTFILE} "self: No packages available to install matching '${product_id}'"
     fi
 
     # Check for additional repository errors
diff --git a/src/opnsense/scripts/firmware/config.sh b/src/opnsense/scripts/firmware/config.sh
index dbbb9c9a4..bf2edaa2b 100755
--- a/src/opnsense/scripts/firmware/config.sh
+++ b/src/opnsense/scripts/firmware/config.sh
@@ -69,7 +69,7 @@ output_request()
 	echo "Currently running $(opnsense-version) at $(date)" >> ${LOCKFILE}
 }
 
-output_text()
+output_txt()
 {
 	DO_OPT=
 	DO_OUT=
@@ -117,7 +117,7 @@ output_cmd()
 
 		# single quote will not execute for safety
 		if [ -z "${ARG##*"'"*}" ]; then
-			output_text "firmware: safety violation in argument during ${REQUEST}"
+			output_txt "firmware: safety violation in argument during ${REQUEST}"
 			return 1
 		fi
 
@@ -155,7 +155,7 @@ env_init()
 {
 	if [ -n "$(opnsense-update -x)" -o -e /var/run/development ]; then
 		if [ -n "${REQUEST}" ]; then
-			output_text "Strict TLS 1.3 and CRL checking is enabled."
+			output_txt "Strict TLS 1.3 and CRL checking is enabled."
 		fi
 
 		# business mirror compliance requires
diff --git a/src/opnsense/scripts/firmware/connection.sh b/src/opnsense/scripts/firmware/connection.sh
index bd73322b7..36fc5203b 100755
--- a/src/opnsense/scripts/firmware/connection.sh
+++ b/src/opnsense/scripts/firmware/connection.sh
@@ -43,25 +43,25 @@ rm -rf ${PKG_DBDIR}
 mkdir -p ${PKG_DBDIR}
 
 if [ -n "${IPV4}" -a -z "${IPV4%%*.*}" ]; then
-	output_text "Checking connectivity for host: ${HOST} -> ${IPV4}"
+	output_txt "Checking connectivity for host: ${HOST} -> ${IPV4}"
 	output_cmd ping -4 ${POPT} "${IPV4}"
-	output_text "Checking connectivity for repository (IPv4): ${URL}"
+	output_txt "Checking connectivity for repository (IPv4): ${URL}"
 	output_cmd ${PKG} -4 update -f
 else
-	output_text "No IPv4 address could be found for host: ${HOST}"
+	output_txt "No IPv4 address could be found for host: ${HOST}"
 fi
 
 if [ -n "${IPV6}" -a -z "${IPV6%%*:*}" ]; then
-	output_text "Checking connectivity for host: ${HOST} -> ${IPV6}"
+	output_txt "Checking connectivity for host: ${HOST} -> ${IPV6}"
 	output_cmd ping -6 ${POPT} "${IPV6}"
-	output_text "Checking connectivity for repository (IPv6): ${URL}"
+	output_txt "Checking connectivity for repository (IPv6): ${URL}"
 	output_cmd ${PKG} -6 update -f
 else
-	output_text "No IPv6 address could be found for host: ${HOST}"
+	output_txt "No IPv6 address could be found for host: ${HOST}"
 fi
 
 for HOST in $(/usr/local/opnsense/scripts/firmware/hostnames.sh); do
-	output_text "Checking server certificate for host: ${HOST}"
+	output_txt "Checking server certificate for host: ${HOST}"
 	# XXX -crl_check and -crl_check_all are possible but -CRL pass is not working
 	echo | output_cmd openssl s_client -quiet -no_ign_eof "${HOST}:443"
 done
diff --git a/src/opnsense/scripts/firmware/health.sh b/src/opnsense/scripts/firmware/health.sh
index a8a552177..31eaa013c 100755
--- a/src/opnsense/scripts/firmware/health.sh
+++ b/src/opnsense/scripts/firmware/health.sh
@@ -72,30 +72,30 @@ set_check()
 
 	VER=$(opnsense-version -v ${SET})
 
-	output_text ">>> Check installed ${SET} version"
+	output_txt ">>> Check installed ${SET} version"
 
 	if [ -z "${VER}" -o -z "${VERSION}" ]; then
-		output_text "Failed to determine version info."
+		output_txt "Failed to determine version info."
 	elif [ "${VER}" != "${VERSION}" ]; then
-		output_text "Version ${VER} is incorrect, expected: ${VERSION}"
+		output_txt "Version ${VER} is incorrect, expected: ${VERSION}"
 	else
-		output_text "Version ${VER} is correct."
+		output_txt "Version ${VER} is correct."
 	fi
 
 	FILE=/usr/local/opnsense/version/${SET}.mtree
 
 	if [ ! -f ${FILE} ]; then
-		output_text "Cannot verify ${SET}: missing ${FILE}"
+		output_txt "Cannot verify ${SET}: missing ${FILE}"
 		return
 	fi
 
 	if [ ! -f ${FILE}.sig ]; then
-		output_text "Unverified consistency check for ${SET}: missing ${FILE}.sig"
+		output_txt "Unverified consistency check for ${SET}: missing ${FILE}.sig"
 	elif ! opnsense-verify -q ${FILE}; then
-		output_text "Unverified consistency check for ${SET}: invalid ${FILE}.sig"
+		output_txt "Unverified consistency check for ${SET}: invalid ${FILE}.sig"
 	fi
 
-	output_text ">>> Check for missing or altered ${SET} files"
+	output_txt ">>> Check for missing or altered ${SET} files"
 
 	echo "${MTREE_PATTERNS}" > ${TMPFILE}
 
@@ -107,14 +107,14 @@ set_check()
 
 	if [ ${MTREE_RET} -eq 0 ]; then
 		if [ "${MTREE_MIA}" = "0" ]; then
-			output_text "No problems detected."
+			output_txt "No problems detected."
 		else
-			output_text "Missing files: ${MTREE_MIA}"
-			output_text "${MTREE_OUT}"
+			output_txt "Missing files: ${MTREE_MIA}"
+			output_txt "${MTREE_OUT}"
 		fi
 	else
-		output_text "Error ${MTREE_RET} occurred."
-		output_text "${MTREE_OUT}"
+		output_txt "Error ${MTREE_RET} occurred."
+		output_txt "${MTREE_OUT}"
 	fi
 
 	rm ${TMPFILE}
@@ -122,29 +122,29 @@ set_check()
 
 core_check()
 {
-	output_text ">>> Check for core packages consistency"
+	output_txt ">>> Check for core packages consistency"
 
 	CORE=$(opnsense-version -n)
 	PROGRESS=
 
 	if [ -z "${CORE}" ]; then
-		output_text "Could not determine core package name."
+		output_txt "Could not determine core package name."
 		return
 	fi
 
 	if [ -z "$(${PKG} query %n ${CORE})" ]; then
-		output_text "Core package \"${CORE}\" not known to package database."
+		output_txt "Core package \"${CORE}\" not known to package database."
 		return
 	fi
 
-	output_text "Core package \"${CORE}\" at $(opnsense-version -v) has $(${PKG} query %#d ${CORE}) dependencies to check."
+	output_txt "Core package \"${CORE}\" at $(opnsense-version -v) has $(${PKG} query %#d ${CORE}) dependencies to check."
 
 	for DEP in $( (echo ${CORE}; ${PKG} query %dn ${CORE}) | sort -u); do
 		if [ -z "${PROGRESS}" ]; then
-			output_text -n "Checking packages: ."
+			output_txt -n "Checking packages: ."
 			PROGRESS=1
 		else
-			output_text -n "."
+			output_txt -n "."
 		fi
 
 		read REPO LVER AUTO VITA << EOF
@@ -153,33 +153,33 @@ EOF
 
 		if [ -z "${REPO}${LVER}${AUTO}${VITA}" ]; then
 			if [ -n "${PROGRESS}" ]; then
-				output_text
+				output_txt
 			fi
-			output_text "Package not installed: ${DEP}"
+			output_txt "Package not installed: ${DEP}"
 			PROGRESS=
 			continue
 		fi
 
 		if [ "${REPO}" != ${PRODUCT} ]; then
 			if [ -n "${PROGRESS}" ]; then
-				output_text
+				output_txt
 			fi
-			output_text "${DEP}-${LVER} repository mismatch: ${REPO}"
+			output_txt "${DEP}-${LVER} repository mismatch: ${REPO}"
 			PROGRESS=
 		fi
 
 		RVER=$(${PKG} rquery -r ${PRODUCT} %v ${DEP} 2> /dev/null)
 		if [ -z "${RVER}" ]; then
 			if [ -n "${PROGRESS}" ]; then
-				output_text
+				output_txt
 			fi
-			output_text "${DEP}-${LVER} has no upstream equivalent"
+			output_txt "${DEP}-${LVER} has no upstream equivalent"
 			PROGRESS=
 		elif [ "${RVER}" != "${LVER}" ]; then
 			if [ -n "${PROGRESS}" ]; then
-				output_text
+				output_txt
 			fi
-			output_text "${DEP}-${LVER} version mismatch, expected ${RVER}"
+			output_txt "${DEP}-${LVER} version mismatch, expected ${RVER}"
 			PROGRESS=
 		fi
 
@@ -200,27 +200,27 @@ EOF
 
 		if [ "${AUTO}" != ${AUTOEXPECT} ]; then
 			if [ -n "${PROGRESS}" ]; then
-				output_text
+				output_txt
 			fi
-			output_text "${DEP}-${LVER} is ${AUTOSET} to automatic"
+			output_txt "${DEP}-${LVER} is ${AUTOSET} to automatic"
 			PROGRESS=
 		fi
 
 		if [ "${VITA}" != ${VITAEXPECT} ]; then
 			if [ -n "${PROGRESS}" ]; then
-				output_text
+				output_txt
 			fi
-			output_text "${DEP}-${LVER} is ${VITASET} to vital"
+			output_txt "${DEP}-${LVER} is ${VITASET} to vital"
 			PROGRESS=
 		fi
 	done
 
 	if [ -n "${PROGRESS}" ]; then
-		output_text " done"
+		output_txt " done"
 	fi
 }
 
-output_text ">>> Root file system: $(mount | awk '$3 == "/" { print $1 }')"
+output_txt ">>> Root file system: $(mount | awk '$3 == "/" { print $1 }')"
 
 if [ -z "${CMD}" -o "${CMD}" = "kernel" ]; then
 	set_check kernel
@@ -231,35 +231,35 @@ if [ -z "${CMD}" -o "${CMD}" = "base" ]; then
 fi
 
 if [ -z "${CMD}" -o "${CMD}" = "repos" ]; then
-	output_text ">>> Check installed repositories"
+	output_txt ">>> Check installed repositories"
 	output_cmd opnsense-verify -l
 fi
 
 if [ -z "${CMD}" -o "${CMD}" = "plugins" ]; then
-	output_text ">>> Check installed plugins"
+	output_txt ">>> Check installed plugins"
 	PLUGINS=$(${PKG} query -g '%n %v' 'os-*' 2>&1)
 	if [ -n "${PLUGINS}" ]; then
-		output_text "${PLUGINS}"
+		output_txt "${PLUGINS}"
 	else
-		output_text "No plugins found."
+		output_txt "No plugins found."
 	fi
 fi
 
 if [ -z "${CMD}" -o "${CMD}" = "locked" ]; then
-	output_text ">>> Check locked packages"
+	output_txt ">>> Check locked packages"
 	LOCKED=$(${PKG} lock -lq 2>&1)
 	if [ -n "${LOCKED}" ]; then
-		output_text "${LOCKED}"
+		output_txt "${LOCKED}"
 	else
-		output_text "No locks found."
+		output_txt "No locks found."
 	fi
 fi
 
 if [ -z "${CMD}" -o "${CMD}" = "packages" ]; then
-	output_text ">>> Check for missing package dependencies"
+	output_txt ">>> Check for missing package dependencies"
 	output_cmd ${PKG} check -dan
 
-	output_text ">>> Check for missing or altered package files"
+	output_txt ">>> Check for missing or altered package files"
 	output_cmd ${PKG} check -sa
 fi
 
diff --git a/src/opnsense/scripts/firmware/install.sh b/src/opnsense/scripts/firmware/install.sh
index 5dde148d8..eb6445d96 100755
--- a/src/opnsense/scripts/firmware/install.sh
+++ b/src/opnsense/scripts/firmware/install.sh
@@ -38,7 +38,7 @@ if [ "${PACKAGE#os-}" != "${PACKAGE}" ]; then
 
 	# plugins must pass a version check on up-to-date core package
 	if [ "$(${PKG} version -t ${COREVER} ${REPOVER})" = "<" ]; then
-		output_text "Installation out of date. The update to ${COREPKG}-${REPOVER} is required."
+		output_txt "Installation out of date. The update to ${COREPKG}-${REPOVER} is required."
 		output_done
 	fi
 fi
diff --git a/src/opnsense/scripts/firmware/lock.sh b/src/opnsense/scripts/firmware/lock.sh
index 2d1d7a9fa..f2711f769 100755
--- a/src/opnsense/scripts/firmware/lock.sh
+++ b/src/opnsense/scripts/firmware/lock.sh
@@ -32,10 +32,10 @@ REQUEST="LOCK"
 PACKAGE=${1}
 
 if [ "${PACKAGE}" = "base" ]; then
-	output_text "Locking base set"
+	output_txt "Locking base set"
 	output_cmd opnsense-update -bL
 elif [ "${PACKAGE}" = "kernel" ]; then
-	output_text "Locking kernel set"
+	output_txt "Locking kernel set"
 	output_cmd opnsense-update -kL
 else
 	output_cmd ${PKG} lock -y "${PACKAGE}"
diff --git a/src/opnsense/scripts/firmware/sync.subr.sh b/src/opnsense/scripts/firmware/sync.subr.sh
index 7debc6917..c0efe8aa4 100755
--- a/src/opnsense/scripts/firmware/sync.subr.sh
+++ b/src/opnsense/scripts/firmware/sync.subr.sh
@@ -38,7 +38,7 @@ for PACKAGE in $(/usr/local/sbin/pluginctl -g system.firmware.plugins | \
 
 			# plugins must pass a version check on up-to-date core package
 			if [ "$(${PKG} version -t ${COREVER} ${REPOVER})" = "<" ]; then
-				output_text "Installation out of date. The update to ${COREPKG}-${REPOVER} is required."
+				output_txt "Installation out of date. The update to ${COREPKG}-${REPOVER} is required."
 				break
 			fi
 
diff --git a/src/opnsense/scripts/firmware/unlock.sh b/src/opnsense/scripts/firmware/unlock.sh
index 026e2c11b..022725300 100755
--- a/src/opnsense/scripts/firmware/unlock.sh
+++ b/src/opnsense/scripts/firmware/unlock.sh
@@ -32,10 +32,10 @@ REQUEST="UNLOCK"
 PACKAGE=${1}
 
 if [ "${PACKAGE}" = "base" ]; then
-	output_text "Unlocking base set"
+	output_txt "Unlocking base set"
 	output_cmd opnsense-update -bU
 elif [ "${PACKAGE}" = "kernel" ]; then
-	output_text "Unlocking kernel set"
+	output_txt "Unlocking kernel set"
 	output_cmd opnsense-update -kU
 else
 	output_cmd ${PKG} unlock -y "${PACKAGE}"