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

Timestamp:

2014-12-19T15:05:33+01:00 (11 years ago)

Author:

Don-vip

Message:

see #10026 - use recommended user data directory on OSX (distinct from preferences directory). Linux and Windows behaviour is unchanged.

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.Collection;
 import java.util.Collections;
+import java.util.HashSet;
 import java.util.Iterator;
 import java.util.LinkedHashMap;
@@ -30 +31 @@
 import java.util.Objects;
 import java.util.ResourceBundle;
+import java.util.Set;
 import java.util.SortedMap;
 import java.util.TreeMap;
@@ -84 +86 @@
      * Internal storage for the preference directory.
      * Do not access this variable directly!
-     * @see #getPreferencesDirFile()
-     */
-    private File preferencesDirFile = null;
+     * @see #getPreferencesDirectory()
+     */
+    private File preferencesDir = null;
 
     /**
      * Internal storage for the cache directory.
      */
-    private File cacheDirFile = null;
+    private File cacheDir = null;
 
     /**
@@ -530 +532 @@
      * Returns the location of the user defined preferences directory
      * @return The location of the user defined preferences directory
-     */
+     * @deprecated use #getPreferencesDirectory() to access preferences directory
+     * or #getUserDataDirectory to access user data directory
+     */
+    @Deprecated
     public String getPreferencesDir() {
-        final String path = getPreferencesDirFile().getPath();
+        final String path = getPreferencesDirectory().getPath();
         if (path.endsWith(File.separator))
             return path;
@@ -539 +544 @@
 
     /**
-     * Returns the user defined preferences directory
-     * @return The user defined preferences directory
-     */
-    public File getPreferencesDirFile() {
-        if (preferencesDirFile != null)
-            return preferencesDirFile;
+     * Returns the user defined preferences directory, containing the preferences.xml file
+     * @return The user defined preferences directory, containing the preferences.xml file
+     * @since 7834
+     */
+    public File getPreferencesDirectory() {
+        if (preferencesDir != null)
+            return preferencesDir;
         String path;
         path = System.getProperty("josm.home");
         if (path != null) {
-            preferencesDirFile = new File(path).getAbsoluteFile();
+            preferencesDir = new File(path).getAbsoluteFile();
         } else {
-            preferencesDirFile = Main.platform.getDefaultPrefDirectory();
-        }
-        return preferencesDirFile;
-    }
-
-    /**
-     * Returns the user preferences file
-     * @return The user preferences file
+            preferencesDir = Main.platform.getDefaultPrefDirectory();
+        }
+        return preferencesDir;
+    }
+
+    /**
+     * Returns the user data directory, containing autosave, plugins, etc.
+     * Depending on the OS it may be the same directory as preferences directory.
+     * @return The user data directory, containing autosave, plugins, etc.
+     * @since 7834
+     */
+    public File getUserDataDirectory() {
+        return Main.platform.getDefaultUserDataDirectory();
+    }
+
+    /**
+     * Returns the user preferences file (preferences.xml)
+     * @return The user preferences file (preferences.xml)
      */
     public File getPreferenceFile() {
-        return new File(getPreferencesDirFile(), "preferences.xml");
+        return new File(getPreferencesDirectory(), "preferences.xml");
     }
 
@@ -568 +584 @@
      */
     public File getPluginsDirectory() {
-        return new File(getPreferencesDirFile(), "plugins");
+        return new File(getUserDataDirectory(), "plugins");
     }
 
@@ -580 +596 @@
      */
     public File getCacheDirectory() {
-        if (cacheDirFile != null)
-            return cacheDirFile;
+        if (cacheDir != null)
+            return cacheDir;
         String path = System.getProperty("josm.cache");
         if (path != null) {
-            cacheDirFile = new File(path).getAbsoluteFile();
+            cacheDir = new File(path).getAbsoluteFile();
         } else {
             path = get("cache.folder", null);
             if (path != null) {
-                cacheDirFile = new File(path);
+                cacheDir = new File(path);
             } else {
-                cacheDirFile = Main.platform.getDefaultCacheDirectory();
-            }
-        }
-        if (!cacheDirFile.exists() && !cacheDirFile.mkdirs()) {
-            Main.warn(tr("Failed to create missing cache directory: {0}", cacheDirFile.getAbsoluteFile()));
+                cacheDir = Main.platform.getDefaultCacheDirectory();
+            }
+        }
+        if (!cacheDir.exists() && !cacheDir.mkdirs()) {
+            Main.warn(tr("Failed to create missing cache directory: {0}", cacheDir.getAbsoluteFile()));
             JOptionPane.showMessageDialog(
                     Main.parent,
-                    tr("<html>Failed to create missing cache directory: {0}</html>", cacheDirFile.getAbsoluteFile()),
+                    tr("<html>Failed to create missing cache directory: {0}</html>", cacheDir.getAbsoluteFile()),
                     tr("Error"),
                     JOptionPane.ERROR_MESSAGE
             );
         }
-        return cacheDirFile;
-    }
-
-    /**
-     * @return A list of all existing directories where resources could be stored.
+        return cacheDir;
+    }
+
+    private void addPossibleResourceDir(Set<String> locations, String s) {
+        if (s != null) {
+            if (!s.endsWith(File.separator)) {
+                s += File.separator;
+            }
+            locations.add(s);
+        }
+    }
+
+    /**
+     * Returns a set of all existing directories where resources could be stored.
+     * @return A set of all existing directories where resources could be stored.
      */
     public Collection<String> getAllPossiblePreferenceDirs() {
-        LinkedList<String> locations = new LinkedList<>();
-        locations.add(getPreferencesDir());
-        String s;
-        if ((s = System.getenv("JOSM_RESOURCES")) != null) {
-            if (!s.endsWith(File.separator)) {
-                s = s + File.separator;
-            }
-            locations.add(s);
-        }
-        if ((s = System.getProperty("josm.resources")) != null) {
-            if (!s.endsWith(File.separator)) {
-                s = s + File.separator;
-            }
-            locations.add(s);
-        }
-        String appdata = System.getenv("APPDATA");
-        if (System.getenv("ALLUSERSPROFILE") != null && appdata != null
-                && appdata.lastIndexOf(File.separator) != -1) {
-            appdata = appdata.substring(appdata.lastIndexOf(File.separator));
-            locations.add(new File(new File(System.getenv("ALLUSERSPROFILE"),
-                    appdata), "JOSM").getPath());
-        }
-        locations.add("/usr/local/share/josm/");
-        locations.add("/usr/local/lib/josm/");
-        locations.add("/usr/share/josm/");
-        locations.add("/usr/lib/josm/");
+        Set<String> locations = new HashSet<>();
+        addPossibleResourceDir(locations, getPreferencesDirectory().getPath());
+        addPossibleResourceDir(locations, getUserDataDirectory().getPath());
+        addPossibleResourceDir(locations, System.getenv("JOSM_RESOURCES"));
+        addPossibleResourceDir(locations, System.getProperty("josm.resources"));
+        if (Main.isPlatformWindows()) {
+            String appdata = System.getenv("APPDATA");
+            if (System.getenv("ALLUSERSPROFILE") != null && appdata != null
+                    && appdata.lastIndexOf(File.separator) != -1) {
+                appdata = appdata.substring(appdata.lastIndexOf(File.separator));
+                locations.add(new File(new File(System.getenv("ALLUSERSPROFILE"),
+                        appdata), "JOSM").getPath());
+            }
+        } else {
+            locations.add("/usr/local/share/josm/");
+            locations.add("/usr/local/lib/josm/");
+            locations.add("/usr/share/josm/");
+            locations.add("/usr/lib/josm/");
+        }
         return locations;
     }
@@ -811 +830 @@
     public void init(boolean reset) {
         // get the preferences.
-        File prefDir = getPreferencesDirFile();
+        File prefDir = getPreferencesDirectory();
         if (prefDir.exists()) {
             if(!prefDir.isDirectory()) {