Changeset 15496 in josm for trunk/src/org/openstreetmap/josm/data/Preferences.java

Timestamp:

2019-11-02T15:11:34+01:00 (6 years ago)

Author:

Don-vip

Message:

fix #16796 - Rework of GPX track colors / layer preferences (patch by Bjoeni)

File:

• trunk/src/org/openstreetmap/josm/data/Preferences.java (modified) (8 diffs)

trunk/src/org/openstreetmap/josm/data/Preferences.java

@@ -22 +22 @@
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -30 +31 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.Predicate;
+import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -82 +84 @@
 public class Preferences extends AbstractPreferences {
 
+    /** remove if key equals */
     private static final String[] OBSOLETE_PREF_KEYS = {
         "remotecontrol.https.enabled", /* remove entry after Dec. 2019 */
@@ -87 +90 @@
     };
 
+    /** remove if key starts with */
+    private static final String[] OBSOLETE_PREF_KEYS_START = {
+            //only remove layer specific prefs
+            "draw.rawgps.layer.wpt.",
+            "draw.rawgps.layer.audiowpt.",
+            "draw.rawgps.lines.force.",
+            "draw.rawgps.lines.alpha-blend.",
+            "draw.rawgps.lines.",
+            "markers.show ", //uses space as separator
+            "marker.makeautomarker.",
+            "clr.layer.",
+
+            //remove both layer specific and global prefs
+            "draw.rawgps.colors",
+            "draw.rawgps.direction",
+            "draw.rawgps.alternatedirection",
+            "draw.rawgps.linewidth",
+            "draw.rawgps.max-line-length.local",
+            "draw.rawgps.max-line-length",
+            "draw.rawgps.large",
+            "draw.rawgps.large.size",
+            "draw.rawgps.hdopcircle",
+            "draw.rawgps.min-arrow-distance",
+            "draw.rawgps.colorTracksTune",
+            "draw.rawgps.colors.dynamic",
+            "draw.rawgps.lines.local",
+            "draw.rawgps.heatmap"
+    };
+
+    /** keep subkey even if it starts with any of {@link #OBSOLETE_PREF_KEYS_START} */
+    private static final List<String> KEEP_PREF_KEYS = Arrays.asList(
+            "draw.rawgps.lines.alpha-blend",
+            "draw.rawgps.lines.arrows",
+            "draw.rawgps.lines.arrows.fast",
+            "draw.rawgps.lines.arrows.min-distance",
+            "draw.rawgps.lines.force",
+            "draw.rawgps.lines.max-length",
+            "draw.rawgps.lines.max-length.local",
+            "draw.rawgps.lines.width"
+    );
+
+    /** rename keys that equal */
+    private final static Map<String, String> UPDATE_PREF_KEYS = getUpdatePrefKeys();
+
+    private static Map<String, String> getUpdatePrefKeys() {
+        HashMap<String, String> m = new HashMap<>();
+        m.put("draw.rawgps.direction", "draw.rawgps.lines.arrows");
+        m.put("draw.rawgps.alternatedirection", "draw.rawgps.lines.arrows.fast");
+        m.put("draw.rawgps.min-arrow-distance", "draw.rawgps.lines.arrows.min-distance");
+        m.put("draw.rawgps.linewidth", "draw.rawgps.lines.width");
+        m.put("draw.rawgps.max-line-length.local", "draw.rawgps.lines.max-length.local");
+        m.put("draw.rawgps.max-line-length", "draw.rawgps.lines.max-length");
+        m.put("draw.rawgps.large", "draw.rawgps.points.large");
+        m.put("draw.rawgps.large.alpha", "draw.rawgps.points.large.alpha");
+        m.put("draw.rawgps.large.size", "draw.rawgps.points.large.size");
+        m.put("draw.rawgps.hdopcircle", "draw.rawgps.points.hdopcircle");
+        m.put("draw.rawgps.layer.wpt.pattern", "draw.rawgps.markers.pattern");
+        m.put("draw.rawgps.layer.audiowpt.pattern", "draw.rawgps.markers.audio.pattern");
+        m.put("draw.rawgps.colors", "draw.rawgps.colormode");
+        m.put("draw.rawgps.colorTracksTune", "draw.rawgps.colormode.velocity.tune");
+        m.put("draw.rawgps.colors.dynamic", "draw.rawgps.colormode.dynamic-range");
+        m.put("draw.rawgps.heatmap.line-extra", "draw.rawgps.colormode.heatmap.line-extra");
+        m.put("draw.rawgps.heatmap.colormap", "draw.rawgps.colormode.heatmap.colormap");
+        m.put("draw.rawgps.heatmap.use-points", "draw.rawgps.colormode.heatmap.use-points");
+        m.put("draw.rawgps.heatmap.gain", "draw.rawgps.colormode.heatmap.gain");
+        m.put("draw.rawgps.heatmap.lower-limit", "draw.rawgps.colormode.heatmap.lower-limit");
+        m.put("draw.rawgps.date-coloring-min-dt", "draw.rawgps.colormode.time.min-distance");
+        return Collections.unmodifiableMap(m);
+    }
+
     private static final long MAX_AGE_DEFAULT_PREFERENCES = TimeUnit.DAYS.toSeconds(50);
 
     private final IBaseDirectories dirs;
+    boolean modifiedDefault;
 
     /**
@@ -416 +490 @@
         settingsMap.clear();
         settingsMap.putAll(reader.getSettings());
-        removeObsolete(reader.getVersion());
+        removeAndUpdateObsolete(reader.getVersion());
     }
 
@@ -521 +595 @@
             return;
         }
+        File def = getDefaultsCacheFile();
+        if (def.exists()) {
+            try {
+                loadDefaults();
+            } catch (IOException | XMLStreamException | SAXException e) {
+                Logging.error(e);
+                Logging.warn(tr("Failed to load defaults cache file: {0}", def));
+                defaultsMap.clear();
+                if (!def.delete()) {
+                    Logging.warn(tr("Failed to delete faulty defaults cache file: {0}", def));
+                }
+            }
+        }
         try {
             load();
@@ -544 +631 @@
                 Logging.error(e1);
                 Logging.warn(tr("Failed to initialize preferences. Failed to reset preference file to default: {0}", getPreferenceFile()));
-            }
-        }
-        File def = getDefaultsCacheFile();
-        if (def.exists()) {
-            try {
-                loadDefaults();
-            } catch (IOException | XMLStreamException | SAXException e) {
-                Logging.error(e);
-                Logging.warn(tr("Failed to load defaults cache file: {0}", def));
-                defaultsMap.clear();
-                if (!def.delete()) {
-                    Logging.warn(tr("Failed to delete faulty defaults cache file: {0}", def));
-                }
             }
         }
@@ -756 +830 @@
 
     /**
-     * Removes obsolete preference settings. If you throw out a once-used preference
+     * Removes and updates obsolete preference settings. If you throw out a once-used preference
      * setting, add it to the list here with an expiry date (written as comment). If you
      * see something with an expiry date in the past, remove it from the list.
      * @param loadedVersion JOSM version when the preferences file was written
      */
-    private void removeObsolete(int loadedVersion) {
+    private void removeAndUpdateObsolete(int loadedVersion) {
+        Logging.trace("Update obsolete preference keys for version {0}", Integer.toString(loadedVersion));
+        for (Entry<String, String> e : UPDATE_PREF_KEYS.entrySet()) {
+            String oldkey = e.getKey();
+            String newkey = e.getValue();
+            if (settingsMap.containsKey(oldkey)) {
+                Setting<?> value = settingsMap.remove(oldkey);
+                settingsMap.putIfAbsent(newkey, value);
+                Logging.info(tr("Updated preference setting {0} to {1}", oldkey, newkey));
+            }
+        }
+
         Logging.trace("Remove obsolete preferences for version {0}", Integer.toString(loadedVersion));
         for (String key : OBSOLETE_PREF_KEYS) {
             if (settingsMap.containsKey(key)) {
                 settingsMap.remove(key);
-                Logging.info(tr("Preference setting {0} has been removed since it is no longer used.", key));
-            }
+                Logging.info(tr("Removed preference setting {0} since it is no longer used", key));
+            }
+            if (defaultsMap.containsKey(key)) {
+                defaultsMap.remove(key);
+                Logging.info(tr("Removed preference default {0} since it is no longer used", key));
+                modifiedDefault = true;
+            }
+        }
+        for (String key : OBSOLETE_PREF_KEYS_START) {
+            settingsMap.entrySet().stream()
+            .filter(e -> e.getKey().startsWith(key))
+            .collect(Collectors.toSet())
+            .forEach(e -> {
+                String k = e.getKey();
+                if (!KEEP_PREF_KEYS.contains(k)) {
+                    settingsMap.remove(k);
+                    Logging.info(tr("Removed preference setting {0} since it is no longer used", k));
+                }
+            });
+            defaultsMap.entrySet().stream()
+            .filter(e -> e.getKey().startsWith(key))
+            .collect(Collectors.toSet())
+            .forEach(e -> {
+                String k = e.getKey();
+                if (!KEEP_PREF_KEYS.contains(k)) {
+                    defaultsMap.remove(k);
+                    Logging.info(tr("Removed preference default {0} since it is no longer used", k));
+                    modifiedDefault = true;
+                }
+            });
+        }
+        if (modifiedDefault) {
+            try {
+                saveDefaults();
+                Logging.info(tr("Saved updated default preferences."));
+            } catch (IOException ex) {
+                Logging.log(Logging.LEVEL_WARN, tr("Failed to save default preferences."), ex);
+            }
+            modifiedDefault = false;
         }
     }