From 38b0e8ff6cf2672cfcdf780377862e9fcf153c15 Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Fri, 19 Feb 2021 11:43:03 +0100
Subject: [PATCH] firmware: get rid of old naming convention; closes #4718

---
 src/opnsense/scripts/firmware/install.sh   | 19 ++++++++--------
 src/opnsense/scripts/firmware/lock.sh      | 19 ++++++++--------
 src/opnsense/scripts/firmware/reinstall.sh | 25 +++++++++++-----------
 src/opnsense/scripts/firmware/remove.sh    | 15 ++++++-------
 src/opnsense/scripts/firmware/resync.sh    | 11 +++++-----
 src/opnsense/scripts/firmware/sync.sh      | 15 ++++++-------
 src/opnsense/scripts/firmware/unlock.sh    | 19 ++++++++--------
 7 files changed, 58 insertions(+), 65 deletions(-)

diff --git a/src/opnsense/scripts/firmware/install.sh b/src/opnsense/scripts/firmware/install.sh
index 7f51a90e5..19174e662 100755
--- a/src/opnsense/scripts/firmware/install.sh
+++ b/src/opnsense/scripts/firmware/install.sh
@@ -25,13 +25,12 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 PACKAGE=${1}
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO INSTALL***" >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO INSTALL***" >> ${LOCKFILE}
 if [ "${PACKAGE#os-}" != "${PACKAGE}" ]; then
 	COREPKG=$(opnsense-version -n)
 	COREVER=$(opnsense-version -v)
@@ -39,12 +38,12 @@ if [ "${PACKAGE#os-}" != "${PACKAGE}" ]; then
 
 	# plugins must pass a version check on up-to-date core package
 	if ! php -r "exit(version_compare('${COREVER}','${REPOVER}') >= 0 ? 0 : 1);"; then
-		echo "Installation out of date. The update to ${COREPKG}-${REPOVER} is required." >> ${PKG_PROGRESS_FILE} 2>&1
-		echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+		echo "Installation out of date. The update to ${COREPKG}-${REPOVER} is required." >> ${LOCKFILE} 2>&1
+		echo '***DONE***' >> ${LOCKFILE}
 		exit
 	fi
 fi
-pkg install -y ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-pkg autoremove -y >> ${PKG_PROGRESS_FILE} 2>&1
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+pkg install -y ${PACKAGE} >> ${LOCKFILE} 2>&1
+/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} >> ${LOCKFILE} 2>&1
+pkg autoremove -y >> ${LOCKFILE} 2>&1
+echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/lock.sh b/src/opnsense/scripts/firmware/lock.sh
index 1fe25e7b9..e452dfb77 100755
--- a/src/opnsense/scripts/firmware/lock.sh
+++ b/src/opnsense/scripts/firmware/lock.sh
@@ -25,20 +25,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 PACKAGE=${1}
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO LOCK***" >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO LOCK***" >> ${LOCKFILE}
 if [ "${PACKAGE}" = "base" ]; then
-	echo "Locking base set" >> ${PKG_PROGRESS_FILE}
-	opnsense-update -bL >> ${PKG_PROGRESS_FILE} 2>&1
+	echo "Locking base set" >> ${LOCKFILE}
+	opnsense-update -bL >> ${LOCKFILE} 2>&1
 elif [ "${PACKAGE}" = "kernel" ]; then
-	echo "Locking kernel set" >> ${PKG_PROGRESS_FILE}
-	opnsense-update -kL >> ${PKG_PROGRESS_FILE} 2>&1
+	echo "Locking kernel set" >> ${LOCKFILE}
+	opnsense-update -kL >> ${LOCKFILE} 2>&1
 else
-	pkg lock -y ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
+	pkg lock -y ${PACKAGE} >> ${LOCKFILE} 2>&1
 fi
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/reinstall.sh b/src/opnsense/scripts/firmware/reinstall.sh
index 943906069..a9dc01c65 100755
--- a/src/opnsense/scripts/firmware/reinstall.sh
+++ b/src/opnsense/scripts/firmware/reinstall.sh
@@ -25,46 +25,45 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 PACKAGE=${1}
 REBOOT=
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO REINSTALL***" >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO REINSTALL***" >> ${LOCKFILE}
 
 if [ "${PACKAGE}" = "base" ]; then
 	if opnsense-update -Tb; then
 		# force reinstall intended
-		if opnsense-update -bf >> ${PKG_PROGRESS_FILE} 2>&1; then
+		if opnsense-update -bf >> ${LOCKFILE} 2>&1; then
 			REBOOT=1
 		fi
 	else
 		# for locked message only
-		opnsense-update -b >> ${PKG_PROGRESS_FILE} 2>&1
+		opnsense-update -b >> ${LOCKFILE} 2>&1
 	fi
 elif [ "${PACKAGE}" = "kernel" ]; then
 	if opnsense-update -Tk; then
 		# force reinstall intended
-		if opnsense-update -kf >> ${PKG_PROGRESS_FILE} 2>&1; then
+		if opnsense-update -kf >> ${LOCKFILE} 2>&1; then
 			REBOOT=1
 		fi
 	else
 		# for locked message only
-		opnsense-update -k >> ${PKG_PROGRESS_FILE} 2>&1
+		opnsense-update -k >> ${LOCKFILE} 2>&1
 	fi
 else
-	opnsense-revert -l ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-	/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-	pkg autoremove -y >> ${PKG_PROGRESS_FILE} 2>&1
+	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
 fi
 
 if [ -n "${REBOOT}" ]; then
-	echo '***REBOOT***' >> ${PKG_PROGRESS_FILE}
+	echo '***REBOOT***' >> ${LOCKFILE}
 	# give the frontend some time to figure out that a reboot is coming
 	sleep 5
 	/usr/local/etc/rc.reboot
 fi
 
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/remove.sh b/src/opnsense/scripts/firmware/remove.sh
index 4ce153570..14c343e52 100755
--- a/src/opnsense/scripts/firmware/remove.sh
+++ b/src/opnsense/scripts/firmware/remove.sh
@@ -25,14 +25,13 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 PACKAGE=$1
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO REMOVE***" >> ${PKG_PROGRESS_FILE}
-pkg remove -y ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-/usr/local/opnsense/scripts/firmware/register.php remove ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-pkg autoremove -y >> ${PKG_PROGRESS_FILE} 2>&1
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO REMOVE***" >> ${LOCKFILE}
+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
+echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/resync.sh b/src/opnsense/scripts/firmware/resync.sh
index 4949ee6b5..44be68f3a 100755
--- a/src/opnsense/scripts/firmware/resync.sh
+++ b/src/opnsense/scripts/firmware/resync.sh
@@ -24,11 +24,10 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO RESYNC***" >> ${PKG_PROGRESS_FILE}
-/usr/local/opnsense/scripts/firmware/register.php resync >> ${PKG_PROGRESS_FILE} 2>&1
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO RESYNC***" >> ${LOCKFILE}
+/usr/local/opnsense/scripts/firmware/register.php resync >> ${LOCKFILE} 2>&1
+echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/sync.sh b/src/opnsense/scripts/firmware/sync.sh
index 258092326..4d31058d3 100755
--- a/src/opnsense/scripts/firmware/sync.sh
+++ b/src/opnsense/scripts/firmware/sync.sh
@@ -25,18 +25,17 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 PACKAGES=$(/usr/local/sbin/pluginctl -g system.firmware.plugins | /usr/bin/sed 's/,/ /g')
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO SYNC***" >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO SYNC***" >> ${LOCKFILE}
 for PACKAGE in ${PACKAGES}; do
 	if ! pkg query %n ${PACKAGE} > /dev/null; then
-		pkg install -y ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
-		/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
+		pkg install -y ${PACKAGE} >> ${LOCKFILE} 2>&1
+		/usr/local/opnsense/scripts/firmware/register.php install ${PACKAGE} >> ${LOCKFILE} 2>&1
 	fi
 done
-pkg autoremove -y >> ${PKG_PROGRESS_FILE} 2>&1
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+pkg autoremove -y >> ${LOCKFILE} 2>&1
+echo '***DONE***' >> ${LOCKFILE}
diff --git a/src/opnsense/scripts/firmware/unlock.sh b/src/opnsense/scripts/firmware/unlock.sh
index b012a5622..efa2920b8 100755
--- a/src/opnsense/scripts/firmware/unlock.sh
+++ b/src/opnsense/scripts/firmware/unlock.sh
@@ -25,20 +25,19 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-PKG_PROGRESS_FILE=/tmp/pkg_upgrade.progress
+LOCKFILE=/tmp/pkg_upgrade.progress
 PACKAGE=${1}
 
-# Truncate upgrade progress file
-: > ${PKG_PROGRESS_FILE}
+: > ${LOCKFILE}
 
-echo "***GOT REQUEST TO UNLOCK***" >> ${PKG_PROGRESS_FILE}
+echo "***GOT REQUEST TO UNLOCK***" >> ${LOCKFILE}
 if [ "${PACKAGE}" = "base" ]; then
-	echo "Unlocking base set" >> ${PKG_PROGRESS_FILE}
-	opnsense-update -bU >> ${PKG_PROGRESS_FILE} 2>&1
+	echo "Unlocking base set" >> ${LOCKFILE}
+	opnsense-update -bU >> ${LOCKFILE} 2>&1
 elif [ "${PACKAGE}" = "kernel" ]; then
-	echo "Unlocking kernel set" >> ${PKG_PROGRESS_FILE}
-	opnsense-update -kU >> ${PKG_PROGRESS_FILE} 2>&1
+	echo "Unlocking kernel set" >> ${LOCKFILE}
+	opnsense-update -kU >> ${LOCKFILE} 2>&1
 else
-	pkg unlock -y ${PACKAGE} >> ${PKG_PROGRESS_FILE} 2>&1
+	pkg unlock -y ${PACKAGE} >> ${LOCKFILE} 2>&1
 fi
-echo '***DONE***' >> ${PKG_PROGRESS_FILE}
+echo '***DONE***' >> ${LOCKFILE}