From 2ab6cad19359f24347257af90fd46178f861b25f Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Wed, 13 Nov 2024 11:34:17 +0100
Subject: [PATCH] firmware: use PKG variable for scripting, part 1

---
 src/opnsense/scripts/firmware/connection.sh |  4 ++--
 src/opnsense/scripts/firmware/details.sh    |  4 +++-
 src/opnsense/scripts/firmware/health.sh     | 18 +++++++++---------
 src/opnsense/scripts/firmware/install.sh    |  8 ++++----
 src/opnsense/scripts/firmware/license.sh    |  6 ++++--
 src/opnsense/scripts/firmware/lock.sh       |  2 +-
 src/opnsense/scripts/firmware/reinstall.sh  |  2 +-
 src/opnsense/scripts/firmware/remove.sh     |  4 ++--
 src/opnsense/scripts/firmware/security.sh   |  2 +-
 src/opnsense/scripts/firmware/sync.subr.sh  | 10 +++++-----
 src/opnsense/scripts/firmware/unlock.sh     |  2 +-
 11 files changed, 33 insertions(+), 29 deletions(-)

diff --git a/src/opnsense/scripts/firmware/connection.sh b/src/opnsense/scripts/firmware/connection.sh
index 6c30616f5..510beac32 100755
--- a/src/opnsense/scripts/firmware/connection.sh
+++ b/src/opnsense/scripts/firmware/connection.sh
@@ -50,7 +50,7 @@ if [ -n "${IPV4}" -a -z "${IPV4%%*.*}" ]; then
 	echo "Checking connectivity for host: ${HOST} -> ${IPV4}" | ${TEE} ${LOCKFILE}
 	(ping -4 ${POPT} ${IPV4} 2>&1) | ${TEE} ${LOCKFILE}
 	echo "Checking connectivity for repository (IPv4): ${URL}" | ${TEE} ${LOCKFILE}
-	(pkg -4 update -f 2>&1) | ${TEE} ${LOCKFILE}
+	(${PKG} -4 update -f 2>&1) | ${TEE} ${LOCKFILE}
 else
 	echo "No IPv4 address could be found for host: ${HOST}" | ${TEE} ${LOCKFILE}
 fi
@@ -59,7 +59,7 @@ if [ -n "${IPV6}" -a -z "${IPV6%%*:*}" ]; then
 	echo "Checking connectivity for host: ${HOST} -> ${IPV6}" | ${TEE} ${LOCKFILE}
 	(ping -6 ${POPT} ${IPV6} 2>&1) | ${TEE} ${LOCKFILE}
 	echo "Checking connectivity for repository (IPv6): ${URL}" | ${TEE} ${LOCKFILE}
-	(pkg -6 update -f 2>&1) | ${TEE} ${LOCKFILE}
+	(${PKG} -6 update -f 2>&1) | ${TEE} ${LOCKFILE}
 else
 	echo "No IPv6 address could be found for host: ${HOST}" | ${TEE} ${LOCKFILE}
 fi
diff --git a/src/opnsense/scripts/firmware/details.sh b/src/opnsense/scripts/firmware/details.sh
index f067fdead..530b854b3 100755
--- a/src/opnsense/scripts/firmware/details.sh
+++ b/src/opnsense/scripts/firmware/details.sh
@@ -26,4 +26,6 @@
 
 . /usr/local/opnsense/scripts/firmware/config.sh
 
-${PKG} rquery -U "%c\n\n%e\n\nMaintainer: %m" "${1}"
+PACKAGE=${1}
+
+${PKG} rquery -U "%c\n\n%e\n\nMaintainer: %m" ${PACKAGE}
diff --git a/src/opnsense/scripts/firmware/health.sh b/src/opnsense/scripts/firmware/health.sh
index f04b26371..6ea1c9b1e 100755
--- a/src/opnsense/scripts/firmware/health.sh
+++ b/src/opnsense/scripts/firmware/health.sh
@@ -131,14 +131,14 @@ core_check()
 		return
 	fi
 
-	if [ -z "$(pkg query %n ${CORE})" ]; then
+	if [ -z "$(${PKG} query %n ${CORE})" ]; then
 		echo "Core package \"${CORE}\" not known to package database." | ${TEE} ${LOCKFILE}
 		return
 	fi
 
-	echo "Core package \"${CORE}\" at $(opnsense-version -v) has $(pkg query %#d ${CORE}) dependencies to check." | ${TEE} ${LOCKFILE}
+	echo "Core package \"${CORE}\" at $(opnsense-version -v) has $(${PKG} query %#d ${CORE}) dependencies to check." | ${TEE} ${LOCKFILE}
 
-	for DEP in $( (echo ${CORE}; pkg query %dn ${CORE}) | sort -u); do
+	for DEP in $( (echo ${CORE}; ${PKG} query %dn ${CORE}) | sort -u); do
 		if [ -z "${PROGRESS}" ]; then
 			echo -n "Checking packages: ." | ${TEE} ${LOCKFILE}
 			PROGRESS=1
@@ -147,7 +147,7 @@ core_check()
 		fi
 
 		read REPO LVER AUTO VITA << EOF
-$(pkg query "%R %v %a %V" ${DEP})
+$(${PKG} query "%R %v %a %V" ${DEP})
 EOF
 
 		if [ -z "${REPO}${LVER}${AUTO}${VITA}" ]; then
@@ -167,7 +167,7 @@ EOF
 			PROGRESS=
 		fi
 
-		RVER=$(pkg rquery -r ${PRODUCT} %v ${DEP} 2> /dev/null)
+		RVER=$(${PKG} rquery -r ${PRODUCT} %v ${DEP} 2> /dev/null)
 		if [ -z "${RVER}" ]; then
 			if [ -n "${PROGRESS}" ]; then
 				echo | ${TEE} ${LOCKFILE}
@@ -239,7 +239,7 @@ fi
 
 if [ -z "${CMD}" -o "${CMD}" = "plugins" ]; then
 	echo ">>> Check installed plugins" | ${TEE} ${LOCKFILE}
-	PLUGINS=$(pkg query -g '%n %v' 'os-*' 2>&1)
+	PLUGINS=$(${PKG} query -g '%n %v' 'os-*' 2>&1)
 	if [ -n "${PLUGINS}" ]; then
 		(echo "${PLUGINS}") | ${TEE} ${LOCKFILE}
 	else
@@ -249,7 +249,7 @@ fi
 
 if [ -z "${CMD}" -o "${CMD}" = "locked" ]; then
 	echo ">>> Check locked packages" | ${TEE} ${LOCKFILE}
-	LOCKED=$(pkg lock -lq 2>&1)
+	LOCKED=$(${PKG} lock -lq 2>&1)
 	if [ -n "${LOCKED}" ]; then
 		(echo "${LOCKED}") | ${TEE} ${LOCKFILE}
 	else
@@ -259,10 +259,10 @@ fi
 
 if [ -z "${CMD}" -o "${CMD}" = "packages" ]; then
 	echo ">>> Check for missing package dependencies" | ${TEE} ${LOCKFILE}
-	(pkg check -dan 2>&1) | ${TEE} ${LOCKFILE}
+	(${PKG} check -dan 2>&1) | ${TEE} ${LOCKFILE}
 
 	echo ">>> Check for missing or altered package files" | ${TEE} ${LOCKFILE}
-	(pkg check -sa 2>&1) | ${TEE} ${LOCKFILE}
+	(${PKG} check -sa 2>&1) | ${TEE} ${LOCKFILE}
 fi
 
 if [ -z "${CMD}" -o "${CMD}" = "core" ]; then
diff --git a/src/opnsense/scripts/firmware/install.sh b/src/opnsense/scripts/firmware/install.sh
index 70612dda8..d0c1d0fe7 100755
--- a/src/opnsense/scripts/firmware/install.sh
+++ b/src/opnsense/scripts/firmware/install.sh
@@ -37,18 +37,18 @@ echo "Currently running $(opnsense-version) at $(date)" >> ${LOCKFILE}
 if [ "${PACKAGE#os-}" != "${PACKAGE}" ]; then
 	COREPKG=$(opnsense-version -n)
 	COREVER=$(opnsense-version -v)
-	REPOVER=$(pkg rquery %v ${COREPKG})
+	REPOVER=$(${PKG} rquery %v ${COREPKG})
 
 	# plugins must pass a version check on up-to-date core package
-	if [ "$(pkg version -t ${COREVER} ${REPOVER})" = "<" ]; then
+	if [ "$(${PKG} version -t ${COREVER} ${REPOVER})" = "<" ]; then
 		echo "Installation out of date. The update to ${COREPKG}-${REPOVER} is required." | ${TEE} ${LOCKFILE}
 		echo '***DONE***' >> ${LOCKFILE}
 		exit
 	fi
 fi
 
-(pkg install -y ${PACKAGE} 2>&1) | ${TEE} ${LOCKFILE}
+(${PKG} install -y ${PACKAGE} 2>&1) | ${TEE} ${LOCKFILE}
 (/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} 2>&1) | ${TEE} ${LOCKFILE}
-(pkg autoremove -y 2>&1) | ${TEE} ${LOCKFILE}
+(${PKG} autoremove -y 2>&1) | ${TEE} ${LOCKFILE}
 
 echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/license.sh b/src/opnsense/scripts/firmware/license.sh
index d28ffcb92..3547f8a1b 100755
--- a/src/opnsense/scripts/firmware/license.sh
+++ b/src/opnsense/scripts/firmware/license.sh
@@ -25,12 +25,14 @@
 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 # SUCH DAMAGE.
 
+. /usr/local/opnsense/scripts/firmware/config.sh
+
 LICENSEDIR="/usr/local/share/licenses"
 
 PACKAGE=${1}
 
-LICENSES=$(pkg query %L ${PACKAGE})
-VERSION=$(pkg query %v ${PACKAGE})
+LICENSES=$(${PKG} query %L ${PACKAGE})
+VERSION=$(${PKG} query %v ${PACKAGE})
 
 IFS=', '
 
diff --git a/src/opnsense/scripts/firmware/lock.sh b/src/opnsense/scripts/firmware/lock.sh
index 6b513fa9d..5de1f23b2 100755
--- a/src/opnsense/scripts/firmware/lock.sh
+++ b/src/opnsense/scripts/firmware/lock.sh
@@ -41,7 +41,7 @@ elif [ "${PACKAGE}" = "kernel" ]; then
 	echo "Locking kernel set" >> ${LOCKFILE}
 	opnsense-update -kL >> ${LOCKFILE} 2>&1
 else
-	pkg lock -y ${PACKAGE} >> ${LOCKFILE} 2>&1
+	${PKG} lock -y ${PACKAGE} >> ${LOCKFILE} 2>&1
 fi
 
 echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/reinstall.sh b/src/opnsense/scripts/firmware/reinstall.sh
index c0deff0d2..632334763 100755
--- a/src/opnsense/scripts/firmware/reinstall.sh
+++ b/src/opnsense/scripts/firmware/reinstall.sh
@@ -58,7 +58,7 @@ elif [ "${PACKAGE}" = "kernel" ]; then
 else
 	opnsense-revert -l ${PACKAGE} >> ${LOCKFILE} 2>&1
 	/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} >> ${LOCKFILE} 2>&1
-	pkg autoremove -y >> ${LOCKFILE} 2>&1
+	${PKG} autoremove -y >> ${LOCKFILE} 2>&1
 fi
 
 if [ -n "${REBOOT}" ]; then
diff --git a/src/opnsense/scripts/firmware/remove.sh b/src/opnsense/scripts/firmware/remove.sh
index 80e446842..58f1b0ddb 100755
--- a/src/opnsense/scripts/firmware/remove.sh
+++ b/src/opnsense/scripts/firmware/remove.sh
@@ -34,8 +34,8 @@ PACKAGE=${1}
 echo "***GOT REQUEST TO REMOVE***" >> ${LOCKFILE}
 echo "Currently running $(opnsense-version) at $(date)" >> ${LOCKFILE}
 
-pkg remove -y ${PACKAGE} >> ${LOCKFILE} 2>&1
+${PKG} remove -y ${PACKAGE} >> ${LOCKFILE} 2>&1
 /usr/local/opnsense/scripts/firmware/register.php remove ${PACKAGE} >> ${LOCKFILE} 2>&1
-pkg autoremove -y >> ${LOCKFILE} 2>&1
+${PKG} autoremove -y >> ${LOCKFILE} 2>&1
 
 echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/security.sh b/src/opnsense/scripts/firmware/security.sh
index 485eba4df..59d4c1214 100755
--- a/src/opnsense/scripts/firmware/security.sh
+++ b/src/opnsense/scripts/firmware/security.sh
@@ -30,5 +30,5 @@
 
 echo "***GOT REQUEST TO AUDIT SECURITY***" >> ${LOCKFILE}
 echo "Currently running $(opnsense-version) at $(date)" >> ${LOCKFILE}
-(pkg audit -F 2>&1) | ${TEE} ${LOCKFILE}
+(${PKG} audit -F 2>&1) | ${TEE} ${LOCKFILE}
 echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/sync.subr.sh b/src/opnsense/scripts/firmware/sync.subr.sh
index 1e5be1022..9633d9d6c 100755
--- a/src/opnsense/scripts/firmware/sync.subr.sh
+++ b/src/opnsense/scripts/firmware/sync.subr.sh
@@ -30,14 +30,14 @@ MUSTCHECK="yes"
 
 for PACKAGE in $(/usr/local/sbin/pluginctl -g system.firmware.plugins | \
     /usr/bin/sed 's/,/ /g'); do
-	if ! pkg query %n ${PACKAGE} > /dev/null; then
+	if ! ${PKG} query %n ${PACKAGE} > /dev/null; then
 		if [ -n "${MUSTCHECK}" ] ; then
 			COREPKG=$(opnsense-version -n)
 			COREVER=$(opnsense-version -v)
-			REPOVER=$(pkg rquery %v ${COREPKG})
+			REPOVER=$(${PKG} rquery %v ${COREPKG})
 
 			# plugins must pass a version check on up-to-date core package
-			if [ "$(pkg version -t ${COREVER} ${REPOVER})" = "<" ]; then
+			if [ "$(${PKG} version -t ${COREVER} ${REPOVER})" = "<" ]; then
 				echo "Installation out of date. The update to ${COREPKG}-${REPOVER} is required." | ${TEE} ${LOCKFILE}
 				break
 			fi
@@ -45,11 +45,11 @@ for PACKAGE in $(/usr/local/sbin/pluginctl -g system.firmware.plugins | \
 			MUSTCHECK=
 		fi
 
-		(pkg install -y ${PACKAGE} 2>&1) | ${TEE} ${LOCKFILE}
+		(${PKG} install -y ${PACKAGE} 2>&1) | ${TEE} ${LOCKFILE}
 		(/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} 2>&1) | ${TEE} ${LOCKFILE}
 	fi
 done
 
 if [ -z "${MUSTCHECK}" ]; then
-	(pkg autoremove -y 2>&1) | ${TEE} ${LOCKFILE}
+	(${PKG} autoremove -y 2>&1) | ${TEE} ${LOCKFILE}
 fi
diff --git a/src/opnsense/scripts/firmware/unlock.sh b/src/opnsense/scripts/firmware/unlock.sh
index 7158b97c0..50316e0e1 100755
--- a/src/opnsense/scripts/firmware/unlock.sh
+++ b/src/opnsense/scripts/firmware/unlock.sh
@@ -41,7 +41,7 @@ elif [ "${PACKAGE}" = "kernel" ]; then
 	echo "Unlocking kernel set" >> ${LOCKFILE}
 	opnsense-update -kU >> ${LOCKFILE} 2>&1
 else
-	pkg unlock -y ${PACKAGE} >> ${LOCKFILE} 2>&1
+	${PKG} unlock -y ${PACKAGE} >> ${LOCKFILE} 2>&1
 fi
 
 echo '***DONE***' >> ${LOCKFILE}