Log invalid values stored in termux.properties file during load time

All external and internal values were already logged and required log level to be set to "Verbose" in Termux Settings, but now invalid values and the default value used instead will be logged at log level "Normal" as well. The `TermuxPropertyConstants` class has been updated to `v0.10.0`. Check its Changelog sections for info on changes.
termux · May 15, 2021 · f8ccbb4 · f8ccbb4
1 parent 31298b8
commit f8ccbb4
Show file tree

Hide file tree

Showing 5 changed files with 179 additions and 61 deletions.
diff --git a/app/src/main/java/com/termux/app/terminal/io/extrakeys/ExtraKeysInfo.java b/app/src/main/java/com/termux/app/terminal/io/extrakeys/ExtraKeysInfo.java
@@ -1,5 +1,9 @@
 package com.termux.app.terminal.io.extrakeys;
 
+import com.termux.shared.logger.Logger;
+import com.termux.shared.settings.properties.TermuxPropertyConstants;
+import com.termux.shared.settings.properties.TermuxSharedProperties;
+
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -238,6 +242,8 @@ CharDisplayMap getSelectedCharMap() {
             case "none":
                 return new CharDisplayMap();
             default:
+                if (!TermuxPropertyConstants.DEFAULT_IVALUE_EXTRA_KEYS_STYLE.equals(style))
+                    Logger.logError(TermuxSharedProperties.LOG_TAG, "The style \"" + style + "\" for the key \"" + TermuxPropertyConstants.KEY_EXTRA_KEYS_STYLE + "\" is invalid. Using default style instead.");
                 return defaultCharDisplay;
         }
     }

diff --git a/app/src/main/java/com/termux/app/utils/PluginUtils.java b/app/src/main/java/com/termux/app/utils/PluginUtils.java
@@ -322,7 +322,7 @@ public static void setupPluginCommandErrorsNotificationChannel(final Context con
      */
     public static String checkIfRunCommandServiceAllowExternalAppsPolicyIsViolated(final Context context) {
         String errmsg = null;
-        if (!SharedProperties.isPropertyValueTrue(context, TermuxPropertyConstants.getTermuxPropertiesFile(), TermuxConstants.PROP_ALLOW_EXTERNAL_APPS)) {
+        if (!SharedProperties.isPropertyValueTrue(context, TermuxPropertyConstants.getTermuxPropertiesFile(), TermuxConstants.PROP_ALLOW_EXTERNAL_APPS, true)) {
             errmsg = context.getString(R.string.error_run_command_service_allow_external_apps_ungranted);
         }
 

diff --git a/termux-shared/src/main/java/com/termux/shared/settings/properties/SharedProperties.java b/termux-shared/src/main/java/com/termux/shared/settings/properties/SharedProperties.java
@@ -3,6 +3,7 @@
 import android.content.Context;
 import android.widget.Toast;
 
+import com.google.common.collect.BiMap;
 import com.google.common.collect.ImmutableBiMap;
 import com.google.common.primitives.Primitives;
 import com.termux.shared.logger.Logger;
@@ -289,12 +290,14 @@ public static Object getInternalProperty(Context context, File propertiesFile, S
      * @param context The {@link Context} for the {@link #getPropertiesFromFile(Context,File)}call.
      * @param propertiesFile The {@link File} to read the {@link Properties} from.
      * @param key The key to read.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if key value
+     *                               was found in {@link Properties} but was invalid.
      * @return Returns the {@code true} if the {@link Properties} key {@link String} value equals "true",
      * regardless of case. If the key does not exist in the file or does not equal "true", then
      * {@code false} will be returned.
      */
-    public static boolean isPropertyValueTrue(Context context, File propertiesFile, String key) {
-        return (boolean) getBooleanValueForStringValue((String) getProperty(context, propertiesFile, key, null), false);
+    public static boolean isPropertyValueTrue(Context context, File propertiesFile, String key, boolean logErrorOnInvalidValue) {
+        return (boolean) getBooleanValueForStringValue(key, (String) getProperty(context, propertiesFile, key, null), false, logErrorOnInvalidValue, LOG_TAG);
     }
 
     /**
@@ -304,12 +307,14 @@ public static boolean isPropertyValueTrue(Context context, File propertiesFile,
      * @param context The {@link Context} for the {@link #getPropertiesFromFile(Context,File)} call.
      * @param propertiesFile The {@link File} to read the {@link Properties} from.
      * @param key The key to read.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if key value
+     *                               was found in {@link Properties} but was invalid.
      * @return Returns the {@code true} if the {@link Properties} key {@link String} value equals "false",
      * regardless of case. If the key does not exist in the file or does not equal "false", then
      * {@code true} will be returned.
      */
-    public static boolean isPropertyValueFalse(Context context, File propertiesFile, String key) {
-        return (boolean) getInvertedBooleanValueForStringValue((String) getProperty(context, propertiesFile, key, null), true);
+    public static boolean isPropertyValueFalse(Context context, File propertiesFile, String key, boolean logErrorOnInvalidValue) {
+        return (boolean) getInvertedBooleanValueForStringValue(key, (String) getProperty(context, propertiesFile, key, null), true, logErrorOnInvalidValue, LOG_TAG);
     }
 
 
@@ -413,28 +418,128 @@ public static Map<String, Object> getMapCopy(Map<String, Object> map) {
 
 
 
+
     /**
      * Get the boolean value for the {@link String} value.
      *
      * @param value The {@link String} value to convert.
      * @param def The default {@link boolean} value to return.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if {@code value}
+     *                               was not {@code null} and was invalid.
+     * @param logTag If log tag to use for logging errors.
      * @return Returns {@code true} or {@code false} if value is the literal string "true" or "false" respectively,
      * regardless of case. Otherwise returns default value.
      */
-    public static boolean getBooleanValueForStringValue(String value, boolean def) {
-        return (boolean) getDefaultIfNull(MAP_GENERIC_BOOLEAN.get(toLowerCase(value)), def);
+    public static boolean getBooleanValueForStringValue(String key, String value, boolean def, boolean logErrorOnInvalidValue, String logTag) {
+        return (boolean) getDefaultIfNotInMap(key, MAP_GENERIC_BOOLEAN, toLowerCase(value), def, logErrorOnInvalidValue, logTag);
     }
 
     /**
      * Get the inverted boolean value for the {@link String} value.
      *
      * @param value The {@link String} value to convert.
      * @param def The default {@link boolean} value to return.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if {@code value}
+     *                               was not {@code null} and was invalid.
+     * @param logTag If log tag to use for logging errors.
      * @return Returns {@code true} or {@code false} if value is the literal string "false" or "true" respectively,
      * regardless of case. Otherwise returns default value.
      */
-    public static boolean getInvertedBooleanValueForStringValue(String value, boolean def) {
-        return (boolean) getDefaultIfNull(MAP_GENERIC_INVERTED_BOOLEAN.get(toLowerCase(value)), def);
+    public static boolean getInvertedBooleanValueForStringValue(String key, String value, boolean def, boolean logErrorOnInvalidValue, String logTag) {
+        return (boolean) getDefaultIfNotInMap(key, MAP_GENERIC_INVERTED_BOOLEAN, toLowerCase(value), def, logErrorOnInvalidValue, logTag);
+    }
+
+    /**
+     * Get the value for the {@code inputValue} {@link Object} key from a {@link BiMap<>}, otherwise
+     * default value if key not found in {@code map}.
+     *
+     * @param key The shared properties {@link String} key value for which the value is being returned.
+     * @param map The {@link BiMap<>} value to get the value from.
+     * @param inputValue The {@link Object} key value of the map.
+     * @param defaultOutputValue The default {@link boolean} value to return if {@code inputValue} not found in map.
+     *            The default value must exist as a value in the {@link BiMap<>} passed.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if {@code inputValue}
+     *                               was not {@code null} and was not found in the map.
+     * @param logTag If log tag to use for logging errors.
+     * @return Returns the value for the {@code inputValue} key from the map if it exists. Otherwise
+     * returns default value.
+     */
+    public static Object getDefaultIfNotInMap(String key, @Nonnull BiMap<?, ?> map, Object inputValue, Object defaultOutputValue, boolean logErrorOnInvalidValue, String logTag) {
+        Object outputValue = map.get(inputValue);
+        if (outputValue == null) {
+            Object defaultInputValue = map.inverse().get(defaultOutputValue);
+            if (defaultInputValue == null)
+                Logger.logError(LOG_TAG, "The default output value \"" + defaultOutputValue + "\" for the key \"" + key + "\" does not exist as a value in the BiMap passed to getDefaultIfNotInMap(): " + map.values());
+
+            if (logErrorOnInvalidValue && inputValue != null) {
+                if (key != null)
+                    Logger.logError(logTag, "The value \"" + inputValue + "\" for the key \"" + key + "\" is invalid. Using default value \"" + defaultInputValue + "\" instead.");
+                else
+                    Logger.logError(logTag, "The value \"" + inputValue + "\" is invalid. Using default value \"" + defaultInputValue + "\" instead.");
+            }
+
+            return defaultOutputValue;
+        } else {
+            return outputValue;
+        }
+    }
+
+    /**
+     * Get the {@code int} {@code value} as is if between {@code min} and {@code max} (inclusive), otherwise
+     * return default value.
+     *
+     * @param key The shared properties {@link String} key value for which the value is being returned.
+     * @param value The {@code int} value to check.
+     * @param def The default {@code int} value if {@code value} not in range.
+     * @param min The min allowed {@code int} value.
+     * @param max The max allowed {@code int} value.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if {@code value}
+     *                               not in range.
+     * @param ignoreErrorIfValueZero If logging error should be ignored if value equals 0.
+     * @param logTag If log tag to use for logging errors.
+     * @return Returns the {@code value} as is if within range. Otherwise returns default value.
+     */
+    public static int getDefaultIfNotInRange(String key, int value, int def, int min, int max, boolean logErrorOnInvalidValue, boolean ignoreErrorIfValueZero, String logTag) {
+        if (value < min || value > max) {
+            if (logErrorOnInvalidValue && (!ignoreErrorIfValueZero || value != 0)) {
+                if (key != null)
+                    Logger.logError(logTag, "The value \"" + value + "\" for the key \"" + key + "\" is not within the range " + min +  "-" + max +  " (inclusive). Using default value \"" + def + "\" instead.");
+                else
+                    Logger.logError(logTag, "The value \"" + value + "\" is not within the range " + min +  "-" + max +  " (inclusive). Using default value \"" + def + "\" instead.");
+            }
+            return def;
+        } else {
+            return value;
+        }
+    }
+
+    /**
+     * Get the {@code float} {@code value} as is if between {@code min} and {@code max} (inclusive), otherwise
+     * return default value.
+     *
+     * @param key The shared properties {@link String} key value for which the value is being returned.
+     * @param value The {@code float} value to check.
+     * @param def The default {@code float} value if {@code value} not in range.
+     * @param min The min allowed {@code float} value.
+     * @param max The max allowed {@code float} value.
+     * @param logErrorOnInvalidValue If {@code true}, then an error will be logged if {@code value}
+     *                               not in range.
+     * @param ignoreErrorIfValueZero If logging error should be ignored if value equals 0.
+     * @param logTag If log tag to use for logging errors.
+     * @return Returns the {@code value} as is if within range. Otherwise returns default value.
+     */
+    public static float getDefaultIfNotInRange(String key, float value, float def, float min, float max, boolean logErrorOnInvalidValue, boolean ignoreErrorIfValueZero, String logTag) {
+        if (value < min || value > max) {
+            if (logErrorOnInvalidValue && (!ignoreErrorIfValueZero || value != 0)) {
+                if (key != null)
+                    Logger.logError(logTag, "The value \"" + value + "\" for the key \"" + key + "\" is not within the range " + min +  "-" + max +  " (inclusive). Using default value \"" + def + "\" instead.");
+                else
+                    Logger.logError(logTag, "The value \"" + value + "\" is not within the range " + min +  "-" + max +  " (inclusive). Using default value \"" + def + "\" instead.");
+            }
+            return def;
+        } else {
+            return value;
+        }
     }
 
     /**

diff --git a/...x-shared/src/main/java/com/termux/shared/settings/properties/TermuxPropertyConstants.java b/...x-shared/src/main/java/com/termux/shared/settings/properties/TermuxPropertyConstants.java
@@ -10,7 +10,7 @@
 import java.util.Set;
 
 /*
- * Version: v0.9.0
+ * Version: v0.10.0
  *
  * Changelog
  *
@@ -45,6 +45,9 @@
  * - 0.9.0 (2021-05-14)
  *      - Add `*KEY_TERMINAL_CURSOR_BLINK_RATE*`.
  *
+ * - 0.10.0 (2021-05-15)
+ *      - Add `MAP_BACK_KEY_BEHAVIOUR`, `MAP_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR`, `MAP_VOLUME_KEYS_BEHAVIOUR`.
+ *
  */
 
 /**
@@ -179,6 +182,13 @@ public final class TermuxPropertyConstants {
     public static final String IVALUE_BACK_KEY_BEHAVIOUR_ESCAPE = "escape";
     public static final String DEFAULT_IVALUE_BACK_KEY_BEHAVIOUR = IVALUE_BACK_KEY_BEHAVIOUR_BACK;
 
+    /** Defines the bidirectional map for back key behaviour values and their internal values */
+    public static final ImmutableBiMap<String, String> MAP_BACK_KEY_BEHAVIOUR =
+        new ImmutableBiMap.Builder<String, String>()
+            .put(IVALUE_BACK_KEY_BEHAVIOUR_BACK, IVALUE_BACK_KEY_BEHAVIOUR_BACK)
+            .put(IVALUE_BACK_KEY_BEHAVIOUR_ESCAPE, IVALUE_BACK_KEY_BEHAVIOUR_ESCAPE)
+            .build();
+
 
 
     /** Defines the key for the default working directory */
@@ -205,6 +215,13 @@ public final class TermuxPropertyConstants {
     public static final String IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR_ENABLE_DISABLE = "enable/disable";
     public static final String DEFAULT_IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR = IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR_SHOW_HIDE;
 
+    /** Defines the bidirectional map for toggle soft keyboard behaviour values and their internal values */
+    public static final ImmutableBiMap<String, String> MAP_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR =
+        new ImmutableBiMap.Builder<String, String>()
+            .put(IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR_SHOW_HIDE, IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR_SHOW_HIDE)
+            .put(IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR_ENABLE_DISABLE, IVALUE_SOFT_KEYBOARD_TOGGLE_BEHAVIOUR_ENABLE_DISABLE)
+            .build();
+
 
 
     /** Defines the key for whether volume keys will behave as virtual or literal volume keys */
@@ -214,6 +231,13 @@ public final class TermuxPropertyConstants {
     public static final String IVALUE_VOLUME_KEY_BEHAVIOUR_VOLUME = "volume";
     public static final String DEFAULT_IVALUE_VOLUME_KEYS_BEHAVIOUR = IVALUE_VOLUME_KEY_BEHAVIOUR_VIRTUAL;
 
+    /** Defines the bidirectional map for volume keys behaviour values and their internal values */
+    public static final ImmutableBiMap<String, String> MAP_VOLUME_KEYS_BEHAVIOUR =
+        new ImmutableBiMap.Builder<String, String>()
+            .put(IVALUE_VOLUME_KEY_BEHAVIOUR_VIRTUAL, IVALUE_VOLUME_KEY_BEHAVIOUR_VIRTUAL)
+            .put(IVALUE_VOLUME_KEY_BEHAVIOUR_VOLUME, IVALUE_VOLUME_KEY_BEHAVIOUR_VOLUME)
+            .build();
+