From 8a7a838dfd3a36ede1d397f3f39e345a52f2e62d Mon Sep 17 00:00:00 2001
From: Martinski <119833648+Martinski4GitHub@users.noreply.github.com>
Date: Sat, 18 Jan 2025 22:41:58 -0800
Subject: [PATCH 1/2] More Code Improvements

- Added/modified the shell script to have the option to save/keep the current configuration file when uninstalling the add-on.
  This can be useful when a user needs to uninstalls all 3rd-party add-ons to do a full factory defaults reset, or simply wants to save the config file for re-install on a another (new?) router.

- Added/modified the ASP file so the WebGUI page extracts the current version string from the shared custom settings instead of having a hard-coded string.

- Some coding improvements.
---
 MerlinAU.asp | 198 ++++++++++++++++++++++++++++++---------------------
 MerlinAU.sh  |  30 ++++++--
 2 files changed, 142 insertions(+), 86 deletions(-)

diff --git a/MerlinAU.asp b/MerlinAU.asp
index b02d86fb..77cdaaf5 100644
--- a/MerlinAU.asp
+++ b/MerlinAU.asp
@@ -29,14 +29,14 @@
 <script language="JavaScript" type="text/javascript">
 
 /**----------------------------**/
-/** Last Modified: 2025-Jan-17 **/
+/** Last Modified: 2025-Jan-18 **/
 /** Intended for 1.4.0 Release **/
 /**----------------------------**/
 
 // Separate variables for server and AJAX settings //
 var advanced_settings = {};
 var custom_settings = {};
-var server_custom_settings = {};
+var shared_custom_settings = {};
 var ajax_custom_settings = {};
 let isFormSubmitting = false;
 
@@ -353,10 +353,39 @@ function FWVersionStrToNum(verStr)
     return (verNum);
 }
 
+/**----------------------------------------**/
+/** Modified by Martinski W. [2025-Jan-18] **/
+/**----------------------------------------**/
 function LoadCustomSettings()
 {
-    server_custom_settings = <% get_custom_settings(); %>;
-    console.log("Server Custom Settings Loaded:", server_custom_settings);
+    shared_custom_settings = <% get_custom_settings(); %>;
+    for (var prop in shared_custom_settings)
+    {
+		if (Object.prototype.hasOwnProperty.call(shared_custom_settings, prop))
+        {
+            // Remove any old entries that may have been left behind //
+			if (prop.indexOf('MerlinAU') != -1 && prop.indexOf('MerlinAU_version_') == -1)
+            { eval('delete shared_custom_settings.' + prop); }
+		}
+	}
+    console.log("Shared Custom Settings Loaded:", shared_custom_settings);
+}
+
+/**-------------------------------------**/
+/** Added by Martinski W. [2025-Jan-18] **/
+/**-------------------------------------**/
+function GetScriptVersion (versionType)
+{
+	var versionProp;
+	if (versionType == 'local')
+    { versionProp = shared_custom_settings.MerlinAU_version_local; }
+	else if (versionType == 'server')
+    { versionProp = shared_custom_settings.MerlinAU_version_server; }
+
+	if (typeof versionProp == 'undefined' || versionProp == null)
+    { return 'N/A'; }
+	else
+    { return versionProp; }
 }
 
 function prefixCustomSettings(settings, prefix)
@@ -661,79 +690,74 @@ function InitializeFields()
 }
 
 /**----------------------------------------**/
-/** Modified by Martinski W. [2025-Jan-16] **/
+/** Modified by Martinski W. [2025-Jan-18] **/
 /**----------------------------------------**/
-function get_conf_file()
+function GetConfigSettings()
 {
-        $.ajax({
-            url: '/ext/MerlinAU/config.htm',
-            dataType: 'text',
-            error: function(xhr)
-            {
-                console.error("Failed to fetch config.htm:", xhr.statusText);
-                setTimeout(get_conf_file, 1000); // Retry after 1 second
-            },
-            success: function(data)
+    $.ajax({
+        url: '/ext/MerlinAU/config.htm',
+        dataType: 'text',
+        error: function(xhr)
+        {
+            console.error("Failed to fetch config.htm:", xhr.statusText);
+            setTimeout(GetConfigSettings, 1000);
+        },
+        success: function(data)
+        {
+            // Tokenize the data while respecting quoted values
+            var tokenList = tokenize(data);
+
+            for (var i = 0; i < tokenList.length; i++)
             {
-                // Tokenize the data while respecting quoted values
-                var tokens = tokenize(data);
+                var token = tokenList[i];
+
+                if (token.includes('='))
+                {
+                    // Handle "key=value" format //
+                    var splitIndex = token.indexOf('=');
+                    var key = token.substring(0, splitIndex).trim();
+                    var value = token.substring(splitIndex + 1).trim();
 
-                // Iterate through tokens to extract key-value pairs
-                for (var i = 0; i < tokens.length; i++)
+                    // Remove surrounding quotes if present
+                    if (value.startsWith('"') && value.endsWith('"'))
+                    { value = value.substring(1, value.length - 1); }
+
+                    assignAjaxSetting(key, value);
+                }
+                else
                 {
-                    var token = tokens[i];
+                    // Handle "key value" format //
+                    var key = token.trim();
+                    var value = '';
 
-                    if (token.includes('='))
+                    // Ensure there's a next token for the value //
+                    if (i + 1 < tokenList.length)
                     {
-                        // Handle key=value format
-                        var splitIndex = token.indexOf('=');
-                        var key = token.substring(0, splitIndex).trim();
-                        var value = token.substring(splitIndex + 1).trim();
+                        value = tokenList[i + 1].trim();
 
-                        // Remove surrounding quotes if present
-                        if (value.startsWith('"') && value.endsWith('"')) {
-                            value = value.substring(1, value.length - 1);
-                        }
+                        // Remove surrounding quotes if present //
+                        if (value.startsWith('"') && value.endsWith('"'))
+                        { value = value.substring(1, value.length - 1); }
 
                         assignAjaxSetting(key, value);
+                        i++; // Skip the next token as it's already processed
                     }
                     else
-                    {
-                        // Handle key value format
-                        var key = token.trim();
-                        var value = '';
-
-                        // Ensure there's a next token for the value
-                        if (i + 1 < tokens.length)
-                        {
-                            value = tokens[i + 1].trim();
-
-                            // Remove surrounding quotes if present
-                            if (value.startsWith('"') && value.endsWith('"')) {
-                                value = value.substring(1, value.length - 1);
-                            }
-
-                            assignAjaxSetting(key, value);
-                            i++; // Skip the next token as it's already processed
-                        }
-                        else
-                        {
-                            console.warn(`No value found for key: ${key}`);
-                        }
-                    }
+                    { console.warn(`No value found for key: ${key}`); }
                 }
+            }
 
-                console.log("AJAX Custom Settings Loaded:", ajax_custom_settings);
+            console.log("AJAX Custom Settings Loaded:", ajax_custom_settings);
 
-                // Merge both server and AJAX settings
-                custom_settings = Object.assign({}, server_custom_settings, ajax_custom_settings);
-                console.log("Merged Custom Settings:", custom_settings);
+            // Merge both server and AJAX settings //
+            custom_settings = Object.assign({}, shared_custom_settings, ajax_custom_settings);
+            console.log("Merged Custom Settings:", custom_settings);
 
-                // Initialize fields with the merged settings
-                InitializeFields();
-                GetExternalCheckResults();
-            }
-        });
+            // Initialize fields with the merged settings //
+            InitializeFields();
+            GetExternalCheckResults();
+        }
+    });
 }
 
 // Helper function to tokenize the input string, respecting quoted substrings //
@@ -743,10 +767,10 @@ function tokenize(input)
     return input.match(regex) || [];
 }
 
-// Helper function to assign settings based on key
+// Helper function to assign settings based on key //
 function assignAjaxSetting(key, value)
 {
-        // Normalize key to uppercase for case-insensitive comparison
+        // Normalize key to uppercase for case-insensitive comparison //
         var keyUpper = key.toUpperCase();
 
         switch (true) {
@@ -829,10 +853,10 @@ function assignAjaxSetting(key, value)
                 ajax_custom_settings.FW_New_Update_Notifications_Date = value;
                 break;
 
-            // Additional AJAX settings can be handled here
+            // Additional AJAX settings can be handled here //
 
             default:
-                // Optionally handle or log unknown settings
+                // Optionally handle or log unknown settings //
                 break;
         }
 }
@@ -875,23 +899,35 @@ function SetCurrentPage()
 
 function convertToStatus(value)
 {
-        if (typeof value === 'boolean') return value ? 'ENABLED' : 'DISABLED';
-        if (typeof value === 'string') {
-            return (value.toLowerCase() === 'true' || value.toLowerCase() === 'enabled') ? 'ENABLED' : 'DISABLED';
-        }
-        return 'DISABLED';
+    if (typeof value === 'boolean') return value ? 'ENABLED' : 'DISABLED';
+    if (typeof value === 'string')
+    { return (value.toLowerCase() === 'true' || value.toLowerCase() === 'enabled') ? 'ENABLED' : 'DISABLED'; }
+    return 'DISABLED';
+}
+
+/**-------------------------------------**/
+/** Added by Martinski W. [2025-Jan-18] **/
+/**-------------------------------------**/
+function UpdateScriptVersion()
+{
+	var localVers = GetScriptVersion('local');
+	var serverVers = GetScriptVersion('server');
+
+    $('#headerTitle').text ('MerlinAU Dashboard v' + localVers);
+    $('#footerTitle').text ('MerlinAU v' + localVers + ' by ExtremeFiretop & Martinski W.');
 }
 
 /**----------------------------------------**/
-/** Modified by Martinski W. [2025-Jan-17] **/
+/** Modified by Martinski W. [2025-Jan-18] **/
 /**----------------------------------------**/
 function initial()
 {
     isFormSubmitting = false;
     SetCurrentPage();
     LoadCustomSettings();
-    get_conf_file();
+    GetConfigSettings();
     show_menu();
+    UpdateScriptVersion();
 
     // Debugging iframe behavior //
     var hiddenFrame = document.getElementById('hidden_frame');
@@ -966,12 +1002,12 @@ function SaveActionsConfig()
         "MerlinAU_FW_New_Update_TUFWBuildType"
     ];
     ADVANCED_KEYS.forEach(function (key){
-        if (server_custom_settings.hasOwnProperty(key))
-        { delete server_custom_settings[key]; }
+        if (shared_custom_settings.hasOwnProperty(key))
+        { delete shared_custom_settings[key]; }
     });
 
     // Merge Server Custom Settings and prefixed Action form settings //
-    var updatedSettings = Object.assign({}, server_custom_settings, prefixedActionSettings);
+    var updatedSettings = Object.assign({}, shared_custom_settings, prefixedActionSettings);
 
     // Save merged settings to the hidden input field //
     document.getElementById('amng_custom').value = JSON.stringify(updatedSettings);
@@ -1052,7 +1088,7 @@ function SaveAdvancedConfig()
     // Prefix only Advanced settings
     var prefixedAdvancedSettings = prefixCustomSettings(advanced_settings, 'MerlinAU_');
 
-    // Remove any action keys from server_custom_settings to avoid overwriting //
+    // Remove any action keys from shared_custom_settings to avoid overwriting //
     var ACTION_KEYS = [
         "MerlinAU_credentials_base64",
         "MerlinAU_FW_New_Update_Postponement_Days",
@@ -1060,12 +1096,12 @@ function SaveAdvancedConfig()
         "MerlinAU_FW_Update_Check"
     ];
     ACTION_KEYS.forEach(function (key){
-        if (server_custom_settings.hasOwnProperty(key))
-        { delete server_custom_settings[key]; }
+        if (shared_custom_settings.hasOwnProperty(key))
+        { delete shared_custom_settings[key]; }
     });
 
     // Merge Server Custom Settings and prefixed Advanced settings
-    var updatedSettings = Object.assign({}, server_custom_settings, prefixedAdvancedSettings);
+    var updatedSettings = Object.assign({}, shared_custom_settings, prefixedAdvancedSettings);
 
     // Save merged settings to the hidden input field
     document.getElementById('amng_custom').value = JSON.stringify(updatedSettings);
@@ -1284,7 +1320,7 @@ function initializeCollapsibleSections()
 <tr style="background-color:#4D595D;">
 <td valign="top">
 <div>&nbsp;</div>
-<div class="formfonttitle" style="text-align:center;">MerlinAU Dashboard v1.4.0</div>
+<div class="formfonttitle" id="headerTitle" style="text-align:center;">MerlinAU</div>
 <div style="margin:10px 0 10px 5px;" class="splitLine"></div>
 <div class="formfontdesc">This is the MerlinAU add-on integrated into the router WebUI.</div>
 <div style="line-height:10px;">&nbsp;</div>
@@ -1569,7 +1605,7 @@ function initializeCollapsibleSections()
     value="Save" class="button_gen savebutton" name="button">
 </div>
 </form></td></tr></tbody></table>
-<div style="margin-top:10px;text-align:center;">MerlinAU v1.4.0 by ExtremeFiretop &amp; Martinski W.</div>
+<div id="footerTitle" style="margin-top:10px;text-align:center;">MerlinAU</div>
 </td></tr></tbody></table></td></tr></table></td>
 <td width="10"></td>
 </tr></table></form>
diff --git a/MerlinAU.sh b/MerlinAU.sh
index ef9fadae..b8ff39e5 100644
--- a/MerlinAU.sh
+++ b/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-16
+# Last Modified: 2025-Jan-18
 ###################################################################
 set -u
 
@@ -8744,16 +8744,26 @@ _DoInstallation_()
    _MainMenu_
 }
 
-##------------------------------------------##
-## Modified by ExtremeFiretop [2024-Dec-21] ##
-##------------------------------------------##
+##----------------------------------------##
+## Modified by Martinski W. [2025-Jan-18] ##
+##----------------------------------------##
 _DoUnInstallation_()
 {
-   printf "\nAre you sure you want to uninstall $ScriptFileName script now"
+   printf "\n${BOLDct}Are you sure you want to uninstall $ScriptFileName script now${NOct}"
    ! _WaitForYESorNO_ && return 0
 
    if ! _AcquireLock_ cliFileLock ; then return 1 ; fi
 
+   local doSaveConfig=false
+   local savedCFGPath="${SCRIPTS_PATH}/${SCRIPT_NAME}_CFG.SAVED.TXT"
+
+   printf "\n${BOLDct}Do you want to keep/save the $SCRIPT_NAME configuration file${NOct}"
+   if _WaitForYESorNO_
+   then
+       doSaveConfig=true
+       mv -f "$CONFIG_FILE" "$savedCFGPath"
+   fi
+
    _DelFWAutoUpdateHook_
    _DelFWAutoUpdateCronJob_
    _DelScriptAutoUpdateHook_
@@ -8770,6 +8780,7 @@ _DoUnInstallation_()
    fi
 
    if rm -fr "${SETTINGS_DIR:?}" && \
+      rm -fr "${SCRIPT_WEB_DIR:?}" && \
       rm -fr "${FW_BIN_BASE_DIR:?}/$ScriptDirNameD" && \
       rm -fr "${FW_LOG_BASE_DIR:?}/$ScriptDirNameD" && \
       rm -fr "${FW_ZIP_BASE_DIR:?}/$ScriptDirNameD" && \
@@ -8779,6 +8790,15 @@ _DoUnInstallation_()
    else
        Say "${CRITct}**ERROR**: Uninstallation failed.${NOct}"
    fi
+
+   if "$doSaveConfig"
+   then
+       if mkdir -p "$SETTINGS_DIR"
+       then
+           chmod 755 "$SETTINGS_DIR"
+           mv -f "$savedCFGPath" "$CONFIG_FILE"
+       fi
+   fi
    _DoExit_ 0
 }
 

From 23195bdc19dfc0a8d3a8420ab8e2c24ad2358dac Mon Sep 17 00:00:00 2001
From: Martinski <119833648+Martinski4GitHub@users.noreply.github.com>
Date: Sun, 19 Jan 2025 13:20:26 -0800
Subject: [PATCH 2/2] Update MerlinAU.asp

Minor formatting changes.
---
 MerlinAU.asp | 46 +++++++++++++++++++++++-----------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

diff --git a/MerlinAU.asp b/MerlinAU.asp
index 77cdaaf5..44bdb493 100644
--- a/MerlinAU.asp
+++ b/MerlinAU.asp
@@ -29,7 +29,7 @@
 <script language="JavaScript" type="text/javascript">
 
 /**----------------------------**/
-/** Last Modified: 2025-Jan-18 **/
+/** Last Modified: 2025-Jan-19 **/
 /** Intended for 1.4.0 Release **/
 /**----------------------------**/
 
@@ -206,15 +206,15 @@ var externalCheckMsg = '';
 /**----------------------------------------**/
 function GetExternalCheckResults()
 {
-	$.ajax({
-		url: '/ext/MerlinAU/CheckHelper.js',
-		dataType: 'script',
-		timeout: 5000,
-		error: function(xhr){
-			setTimeout(GetExternalCheckResults,1000);
-		},
-		success: function()
-		{
+    $.ajax({
+        url: '/ext/MerlinAU/CheckHelper.js',
+        dataType: 'script',
+        timeout: 5000,
+        error: function(xhr){
+            setTimeout(GetExternalCheckResults,1000);
+        },
+        success: function()
+        {
             // Skip during form submission //
             if (isFormSubmitting) { return true ; }
 
@@ -237,8 +237,8 @@ function GetExternalCheckResults()
                     return false;
                 }
             }
-		}
-	});
+        }
+    });
 }
 
 /**-------------------------------------**/
@@ -361,13 +361,13 @@ function LoadCustomSettings()
     shared_custom_settings = <% get_custom_settings(); %>;
     for (var prop in shared_custom_settings)
     {
-		if (Object.prototype.hasOwnProperty.call(shared_custom_settings, prop))
+        if (Object.prototype.hasOwnProperty.call(shared_custom_settings, prop))
         {
             // Remove any old entries that may have been left behind //
-			if (prop.indexOf('MerlinAU') != -1 && prop.indexOf('MerlinAU_version_') == -1)
+            if (prop.indexOf('MerlinAU') != -1 && prop.indexOf('MerlinAU_version_') == -1)
             { eval('delete shared_custom_settings.' + prop); }
-		}
-	}
+        }
+    }
     console.log("Shared Custom Settings Loaded:", shared_custom_settings);
 }
 
@@ -376,15 +376,15 @@ function LoadCustomSettings()
 /**-------------------------------------**/
 function GetScriptVersion (versionType)
 {
-	var versionProp;
-	if (versionType == 'local')
+    var versionProp;
+    if (versionType == 'local')
     { versionProp = shared_custom_settings.MerlinAU_version_local; }
-	else if (versionType == 'server')
+    else if (versionType == 'server')
     { versionProp = shared_custom_settings.MerlinAU_version_server; }
 
-	if (typeof versionProp == 'undefined' || versionProp == null)
+    if (typeof versionProp == 'undefined' || versionProp == null)
     { return 'N/A'; }
-	else
+    else
     { return versionProp; }
 }
 
@@ -910,8 +910,8 @@ function convertToStatus(value)
 /**-------------------------------------**/
 function UpdateScriptVersion()
 {
-	var localVers = GetScriptVersion('local');
-	var serverVers = GetScriptVersion('server');
+    var localVers = GetScriptVersion('local');
+    var serverVers = GetScriptVersion('server');
 
     $('#headerTitle').text ('MerlinAU Dashboard v' + localVers);
     $('#footerTitle').text ('MerlinAU v' + localVers + ' by ExtremeFiretop & Martinski W.');