Improvements for Updating to WebGUI Version

Various code improvements and fine-tuning for updating to newer & latest 1.4.0 WebGUI version.

The goal is to allow for a "smooth transition" from previous 1.3.10 to new 1.4.0 version with WebGUI support.

The latest changes allow users to update to 1.4.0 using the 1.3.10 CLI menu option to update script or via a direct SSH command.

Author: Martinski4GitHub

MerlinAU.sh

@@ -4,7 +4,7 @@
 #
 # Original Creation Date: 2023-Oct-01 by @ExtremeFiretop.
 # Official Co-Author: @Martinski W. - Date: 2023-Nov-01
-# Last Modified: 2025-Jan-10
+# Last Modified: 2025-Feb-15
 ###################################################################
 set -u
 
@@ -56,18 +56,22 @@ MinSupportedFirmwareVers="3004.386.12.6"
 routerModelCheckFailed=false
 offlineUpdateTrigger=false
 
-##--------------------------------------------##
-## Modified by ExtremeFiretop [2023-Nov-26]   ##
-##--------------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2025-Feb-15] ##
+##----------------------------------------##
 readonly NOct="\e[0m"
+readonly BOLDct="\e[1m"
+readonly BLKct="\e[1;30m"
 readonly REDct="\e[1;31m"
 readonly GRNct="\e[1;32m"
-readonly BLKct="\e[1;30m"
 readonly YLWct="\e[1;33m"
 readonly BLUEct="\e[1;34m"
 readonly MAGENTAct="\e[1;35m"
 readonly CYANct="\e[1;36m"
 readonly WHITEct="\e[1;37m"
+readonly CRITct="\e[1;41m"
+readonly InvREDct="\e[1;41m"
+readonly InvGRNct="\e[1;42m"
 
 readonly ScriptFileName="${0##*/}"
 readonly ScriptFNameTag="${ScriptFileName%%.*}"
@@ -260,15 +264,16 @@ _UserLogMsg_()
 }
 
 ##----------------------------------------##
-## Modified by Martinski W. [2023-Dec-21] ##
+## Modified by Martinski W. [2025-Feb-15] ##
 ##----------------------------------------##
 Say()
 {
+   local logMsg
    "$isInteractive" && printf "${1}\n"
-   # Clean out the "color escape sequences" from the log file #
-   local logMsg="$(echo "$1" | sed 's/\\\e\[0m//g ; s/\\\e\[[0-1];3[0-9]m//g')"
+   # Remove all "color escape sequences" from the system log file entries #
+   logMsg="$(echo "$1" | sed 's/\\\e\[[0-1]m//g ; s/\\\e\[[0-1];[3-4][0-9]m//g')"
    _UserLogMsg_ "$logMsg"
-   printf "$logMsg" | logger -t "[$(basename "$0")] $$"
+   printf "$logMsg" | logger -t "[${SCRIPT_NAME}] $$"
 }
 
 ##----------------------------------------------##
@@ -1522,16 +1527,18 @@ _CheckForNewGUIVersionUpdate_()
 }
 
 ##----------------------------------------##
-## Modified by Martinski W. [2025-Jan-06] ##
+## Modified by Martinski W. [2025-Feb-15] ##
 ##----------------------------------------##
 _CurlFileDownload_()
 {
    if [ $# -lt 2 ] || [ -z "$1" ] || [ -z "$2" ]
    then return 1 ; fi
-   local retCode  tempFilePathDL="${2}.DL.TMP"
+   local retCode=1
+   local tempFilePathDL="${2}.DL.TMP"
+   local srceFilePathDL="${SCRIPT_URL_REPO}/$1"
 
    curl -LSs --retry 4 --retry-delay 5 --retry-connrefused \
-        "$1" -o "$tempFilePathDL"
+        "$srceFilePathDL" -o "$tempFilePathDL"
    if [ $? -ne 0 ] || [ ! -s "$tempFilePathDL" ] || \
       grep -iq "^404: Not Found" "$tempFilePathDL"
    then rm -f "$tempFilePathDL" ; retCode=1
@@ -1541,23 +1548,23 @@ _CurlFileDownload_()
 }
 
 ##----------------------------------------##
-## Modified by Martinski W. [2025-Jan-06] ##
+## Modified by Martinski W. [2025-Feb-15] ##
 ##----------------------------------------##
 _SCRIPTUPDATE_()
 {
-   local urlScriptVers  theScriptVers  extraParam=""
+   local extraParam=""
 
    _DownloadScriptFiles_()
    {
       local retCode
-      if _CurlFileDownload_ "${SCRIPT_URL_REPO}/version.txt" "$SCRIPTVERPATH"
+      if _CurlFileDownload_ "version.txt" "$SCRIPTVERPATH"
       then
           retCode=0 ; chmod 664 "$SCRIPTVERPATH"
       else
           retCode=1
           Say "${REDct}**ERROR**${NOct}: Unable to download latest version file for $SCRIPT_NAME."
       fi
-      if _CurlFileDownload_ "${SCRIPT_URL_REPO}/${SCRIPT_NAME}.sh" "$ScriptFilePath"
+      if _CurlFileDownload_ "${SCRIPT_NAME}.sh" "$ScriptFilePath"
       then
           retCode=0 ; chmod 755 "$ScriptFilePath"
       else
@@ -1570,19 +1577,19 @@ _SCRIPTUPDATE_()
    if [ $# -gt 0 ] && [ "$1" = "force" ]
    then
        printf "\n${CYANct}Force downloading latest script version...${NOct}\n"
-       theScriptVers="$SCRIPT_VERSION"
-       [ -s "$SCRIPTVERPATH" ] && theScriptVers="$(cat "$SCRIPTVERPATH")"
-       urlScriptVers="$(/usr/sbin/curl -LSs --retry 4 --retry-delay 5 "${SCRIPT_URL_REPO}/version.txt")"
-       printf "${CYANct}Downloading latest version ($urlScriptVers) of ${SCRIPT_NAME}${NOct}\n"
+       if ! _CheckForNewScriptUpdates_ -quietcheck
+       then
+           DLRepoVersion="$(/usr/sbin/curl -LSs --retry 4 --retry-delay 5 "${SCRIPT_URL_REPO}/version.txt")"
+       fi
+       if _CheckForNewGUIVersionUpdate_ "$SCRIPT_VERSION" "$DLRepoVersion"
+       then extraParam="install"
+       fi
+       printf "${CYANct}Downloading latest version [$DLRepoVersion] of ${SCRIPT_NAME}${NOct}\n"
 
        if _DownloadScriptFiles_
        then
            printf "${CYANct}$SCRIPT_NAME was successfully updated.${NOct}\n\n"
            sleep 1
-           [ -s "$SCRIPTVERPATH" ] && urlScriptVers="$(cat "$SCRIPTVERPATH")"
-           if [ $# -gt 1 ] && [ "$2" = "newgui" ] && \
-              _CheckForNewGUIVersionUpdate_ "$theScriptVers" "$urlScriptVers"
-           then extraParam="install" ; fi
            _ReleaseLock_
            exec "$ScriptFilePath" $extraParam
            exit 0
@@ -1609,7 +1616,7 @@ _SCRIPTUPDATE_()
           if _DownloadScriptFiles_
           then
               printf "\n${CYANct}Download successful!${NOct}\n"
-              printf "$(date) - $SCRIPT_NAME - Successfully downloaded $SCRIPT_NAME v${DLRepoVersion}\n"
+              printf "$(date) - Successfully downloaded $SCRIPT_NAME v${DLRepoVersion}\n"
           fi
           _WaitForEnterKey_
           return
@@ -1627,7 +1634,7 @@ _SCRIPTUPDATE_()
 
           if _DownloadScriptFiles_
           then
-              printf "\n$(date) - $SCRIPT_NAME - Successfully downloaded $SCRIPT_NAME v${DLRepoVersion}\n"
+              printf "\n$(date) - Successfully downloaded $SCRIPT_NAME v${DLRepoVersion}\n"
               printf "${CYANct}Update successful! Restarting script...${NOct}\n"
               sleep 1
               _CheckForNewGUIVersionUpdate_ && extraParam="install"
@@ -1647,18 +1654,16 @@ _SCRIPTUPDATE_()
 }
 
 ##----------------------------------------##
-## Modified by Martinski W. [2025-Jan-01] ##
+## Modified by Martinski W. [2025-Feb-15] ##
 ##----------------------------------------##
 _CheckForNewScriptUpdates_()
 {
-   local extraParam=""
-
    echo
    DLRepoVersion="$SCRIPT_VERSION"
    [ -s "$SCRIPTVERPATH" ] && DLRepoVersion="$(cat "$SCRIPTVERPATH")"
    rm -f "$SCRIPTVERPATH"
 
-   if ! _CurlFileDownload_ "${SCRIPT_URL_REPO}/version.txt" "$SCRIPTVERPATH"
+   if ! _CurlFileDownload_ "version.txt" "$SCRIPTVERPATH"
    then
        Say "${REDct}**ERROR**${NOct}: Unable to download latest version file for $SCRIPT_NAME."
        scriptUpdateNotify=0
@@ -1680,21 +1685,24 @@ _CheckForNewScriptUpdates_()
    then
        scriptUpdateNotify="New script update available.
 ${REDct}v${SCRIPT_VERSION}${NOct} --> ${GRNct}v${DLRepoVersion}${NOct}"
+
+       if [ $# -gt 0 ] && [ "$1" = "-quietcheck" ]
+       then return 0
+       fi
        Say "$myLAN_HostName - A new script version update (v$DLRepoVersion) is available to download."
        if [ "$ScriptAutoUpdateSetting" = "ENABLED" ]
        then
-           _CheckForNewGUIVersionUpdate_ && extraParam="newgui"
-           _SCRIPTUPDATE_ force $extraParam
+           _SCRIPTUPDATE_ force
        fi
    else
        scriptUpdateNotify=0
    fi
    return 0
 }
 
-##----------------------------------------------##
-## Added/Modified by Martinski W. [2023-Nov-22] ##
-##----------------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2023-Nov-22] ##
+##----------------------------------------##
 _GetLatestFWUpdateVersionFromRouter_()
 {
    local retCode=0  webState  newVersionStr
@@ -6227,8 +6235,9 @@ _CheckTimeToUpdateFirmware_()
    Say "The firmware update is expected to occur on ${GRNct}${nextCronTimeSecs}${NOct}."
    echo ""
 
-   # Check if running in a menu environment #
-   if "$isInteractive" && _WaitForYESorNO_ "Would you like to proceed with the update now?"
+   "$isInteractive" && \
+   printf "\n${BOLDct}Would you like to proceed with the update now${NOct}"
+   if _WaitForYESorNO_
    then return 0
    else return 1
    fi
@@ -6819,9 +6828,9 @@ _RunBackupmon_()
     return 0
 }
 
-##------------------------------------------##
-## Modified by ExtremeFiretop [2024-Oct-13] ##
-##------------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2025-Feb-15] ##
+##----------------------------------------##
 _RunOfflineUpdateNow_()
 {
     local retCode
@@ -6941,7 +6950,7 @@ _RunOfflineUpdateNow_()
                 _RunFirmwareUpdateNow_
                 _ClearOfflineUpdateState_
             else
-                Say "${REDct}**ERROR**${NOct}: No firmware release URL was found for [$PRODUCT_ID] router model."
+                Say "${REDct}**ERROR**${NOct}: No firmware release URL was found for [$MODEL_ID] router model."
                 _ClearOfflineUpdateState_ 1
                 return 1
             fi
@@ -6955,9 +6964,9 @@ _RunOfflineUpdateNow_()
     fi
 }
 
-##------------------------------------------##
-## Modified by ExtremeFiretop [2024-Jul-31] ##
-##------------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2025-Feb-15] ##
+##----------------------------------------##
 _RunFirmwareUpdateNow_()
 {
     # Double-check the directory exists before using it #
@@ -7077,7 +7086,7 @@ Please manually update to version ${GRNct}${MinSupportedFirmwareVers}${NOct} or
         if ! release_version="$(_GetLatestFWUpdateVersionFromRouter_)" || \
            ! _CheckNewUpdateFirmwareNotification_ "$current_version" "$release_version"
         then
-            Say "No new firmware version update is found for [$PRODUCT_ID] router model."
+            Say "No new firmware version update is found for [$MODEL_ID] router model."
             "$inMenuMode" && _WaitForEnterKey_ "$mainMenuReturnPromptStr"
             return 1
         fi
@@ -7102,7 +7111,7 @@ Please manually update to version ${GRNct}${MinSupportedFirmwareVers}${NOct} or
             release_version="$1"
             release_link="$2"
         else
-            Say "${REDct}**ERROR**${NOct}: No firmware release URL was found for [$PRODUCT_ID] router model."
+            Say "${REDct}**ERROR**${NOct}: No firmware release URL was found for [$MODEL_ID] router model."
             "$inMenuMode" && _WaitForEnterKey_ "$mainMenuReturnPromptStr"
             return 1
         fi
@@ -8058,7 +8067,7 @@ check_version_support
 _CheckEMailConfigFileFromAMTM_ 0
 
 ##----------------------------------------##
-## Modified by Martinski W. [2024-Dec-31] ##
+## Modified by Martinski W. [2025-Feb-15] ##
 ##----------------------------------------##
 if [ $# -gt 0 ] && [ -n "$1" ]
 then
@@ -8082,7 +8091,7 @@ then
            ;;
        checkupdates) _CheckForNewScriptUpdates_
            ;;
-       forceupdate) _SCRIPTUPDATE_ force "$([ $# -gt 1 ] && echo "$2" || echo)"
+       forceupdate) _SCRIPTUPDATE_ force
            ;;
        develop) _ChangeToDev_
            ;;
@@ -8471,7 +8480,7 @@ _InvalidMenuSelection_()
 }
 
 ##----------------------------------------##
-## Modified by Martinski W. [2024-Jul-03] ##
+## Modified by Martinski W. [2025-Feb-15] ##
 ##----------------------------------------##
 _ShowMainMenu_()
 {
@@ -8490,29 +8499,34 @@ _ShowMainMenu_()
    printf "${YLWct}============ By ExtremeFiretop & Martinski W. ============${NOct}\n\n"
 
    # New Script Update Notification #
-   if [ "$scriptUpdateNotify" != "0" ]; then
-      Say "${REDct}*WARNING*:${NOct} ${scriptUpdateNotify}\n"
+   if [ "$scriptUpdateNotify" != "0" ]
+   then
+      Say "${InvREDct}*NOTICE*:${NOct} ${scriptUpdateNotify}"
+      echo
    fi
 
    # Unsupported Model Check #
    if "$routerModelCheckFailed"
    then
       Say "${REDct}*WARNING*:${NOct} The current router model is not supported by this script.
- Please uninstall.\n"
+ Please uninstall."
+      echo
    fi
    if "$MinFirmwareVerCheckFailed"
    then
       Say "${REDct}*WARNING*:${NOct} The current firmware version is below the minimum supported.
- Please manually update to version ${GRNct}${MinSupportedFirmwareVers}${NOct} or higher to use this script.\n"
+ Please manually update to version ${GRNct}${MinSupportedFirmwareVers}${NOct} or higher to use this script."
+      echo
    fi
 
    if ! _HasRouterMoreThan256MBtotalRAM_ && ! _ValidateUSBMountPoint_ "$FW_ZIP_BASE_DIR"
    then
       Say "${REDct}*WARNING*:${NOct} Limited RAM detected (256MB).
- A USB drive is required for F/W updates.\n"
+ A USB drive is required for F/W updates."
+      echo
    fi
 
-   arrowStr=" ${REDct}<<---${NOct}"
+   arrowStr=" ${InvREDct} <<<< ${NOct}"
 
    _Calculate_NextRunTime_
 
@@ -8531,14 +8545,14 @@ _ShowMainMenu_()
    if [ "$HIDE_ROUTER_SECTION" = "false" ]
    then
       if ! FW_NewUpdateVerStr="$(_GetLatestFWUpdateVersionFromRouter_ 1)"
-      then FW_NewUpdateVerStr="${REDct}NONE FOUND${NOct}"
-      else FW_NewUpdateVerStr="${GRNct}${FW_NewUpdateVerStr}${NOct}$arrowStr"
+      then FW_NewUpdateVerStr=" ${REDct}NONE FOUND${NOct}"
+      else FW_NewUpdateVerStr="${InvGRNct} ${FW_NewUpdateVerStr} ${NOct}$arrowStr"
       fi
       printf "\n  Router's Product Name/Model ID:  ${FW_RouterModelID}${padStr}(H)ide"
       printf "\n  USB-Attached Storage Connected:  $USBConnected"
       printf "\n  F/W Variant Configuration Found: $FirmwareFlavor"
       printf "\n  F/W Version Currently Installed: $FW_InstalledVerStr"
-      printf "\n  F/W Update Version Available:    $FW_NewUpdateVerStr"
+      printf "\n  F/W Update Version Available:   $FW_NewUpdateVerStr"
       printf "\n  F/W Update Estimated Run Date:   $ExpectedFWUpdateRuntime"
    else
       printf "\n  Router's Product Name/Model ID:  ${FW_RouterModelID}${padStr}(S)how"
@@ -8553,11 +8567,11 @@ _ShowMainMenu_()
    [ -z "$FW_UpdateCheckState" ] && FW_UpdateCheckState=0
    if [ "$FW_UpdateCheckState" -eq 0 ]
    then
-       printf "\n  ${GRNct}3${NOct}.  Toggle F/W Update Check"
-       printf "\n${padStr}[Currently ${REDct}DISABLED${NOct}]"
+       printf "\n  ${GRNct}3${NOct}.  Toggle Automatic F/W Update Checks"
+       printf "\n${padStr}[Currently ${InvREDct} DISABLED ${NOct}]"
    else
-       printf "\n  ${GRNct}3${NOct}.  Toggle F/W Update Check"
-       printf "\n${padStr}[Currently ${GRNct}ENABLED${NOct}]"
+       printf "\n  ${GRNct}3${NOct}.  Toggle Automatic F/W Update Checks"
+       printf "\n${padStr}[Currently ${InvGRNct} ENABLED ${NOct}]"
    fi
    printf "\n${padStr}[Last Notification Date: $notificationStr]\n"
 
@@ -8589,7 +8603,7 @@ _ShowMainMenu_()
    if [ "$scriptUpdateNotify" != "0" ]
    then
       printf "\n ${GRNct}up${NOct}.  Update $SCRIPT_NAME Script"
-      printf "\n${padStr}[Version ${GRNct}${DLRepoVersion}${NOct} Available for Download]\n"
+      printf "\n${padStr}[Version ${InvGRNct} ${DLRepoVersion} ${NOct} Available for Download]\n"
    else
       printf "\n ${GRNct}up${NOct}.  Force Update $SCRIPT_NAME Script"
       printf "\n${padStr}[No Update Available]\n"