attempt alternate settings path on windows, use simpler getter for documents, and more informative appdata error messages (#3838)

benfry · benfry · commit 44ab414726bf · 2015-09-21T17:27:54.000-04:00
diff --git a/app/src/processing/app/Base.java b/app/src/processing/app/Base.java
@@ -1726,20 +1726,20 @@ static public File getSettingsFolder() {
 
     try {
       settingsFolder = Platform.getSettingsFolder();
+
+      // create the folder if it doesn't exist already
+      if (!settingsFolder.exists()) {
+        if (!settingsFolder.mkdirs()) {
+          Messages.showError("Settings issues",
+                             "Processing cannot run because it could not\n" +
+                             "create a folder to store your settings.\n" +
+                             settingsFolder.getAbsolutePath(), null);
+        }
+      }
     } catch (Exception e) {
       Messages.showError("Problem getting the settings folder",
                          "Error getting the Processing the settings folder.", e);
     }
-
-    // create the folder if it doesn't exist already
-    if (!settingsFolder.exists()) {
-      if (!settingsFolder.mkdirs()) {
-        Messages.showError("Settings issues",
-                           "Processing cannot run because it could not\n" +
-                           "create a folder to store your settings.\n" +
-                           settingsFolder.getAbsolutePath(), null);
-      }
-    }
     return settingsFolder;
   }
 
diff --git a/app/src/processing/app/platform/WindowsPlatform.java b/app/src/processing/app/platform/WindowsPlatform.java
@@ -28,19 +28,14 @@
 
 import com.sun.jna.Library;
 import com.sun.jna.Native;
-import com.sun.jna.platform.win32.Kernel32Util;
-import com.sun.jna.platform.win32.Shell32;
 import com.sun.jna.platform.win32.Shell32Util;
 import com.sun.jna.platform.win32.ShlObj;
-import com.sun.jna.platform.win32.WinDef;
-import com.sun.jna.platform.win32.WinError;
-import com.sun.jna.platform.win32.WinNT.HRESULT;
 
 import processing.app.Base;
 import processing.app.Messages;
 import processing.app.Preferences;
-import processing.app.platform.DefaultPlatform;
 import processing.app.platform.WindowsRegistry.REGISTRY_ROOT_KEY;
+
 import processing.core.PApplet;
 
 
@@ -260,11 +255,29 @@ protected void checkPath() {
 
   // looking for Documents and Settings/blah/Application Data/Processing
   public File getSettingsFolder() throws Exception {
-    String appData = getAppDataPath();
-    if (appData != null) {
-      return new File(appData, APP_NAME);
+    String appDataRoaming = getAppDataPath();
+    if (appDataRoaming != null) {
+      File settingsFolder = new File(appDataRoaming, APP_NAME);
+      if (settingsFolder.exists() || settingsFolder.mkdirs()) {
+        return settingsFolder;
+      }
+    }
+
+    String appDataLocal = getLocalAppDataPath();
+    if (appDataLocal != null) {
+      File settingsFolder = new File(appDataLocal, APP_NAME);
+      if (settingsFolder.exists() || settingsFolder.mkdirs()) {
+        return settingsFolder;
+      }
+    }
+
+    if (appDataRoaming == null && appDataLocal == null) {
+      throw new IOException("Could not get the AppData folder");
     }
-    throw new IOException("Could not get the Application Data folder");
+
+    // https://github.com/processing/processing/issues/3838
+    throw new IOException("Please fix permissions for either " +
+                          appDataRoaming + " or " + appDataLocal);
   }
 
 
@@ -279,31 +292,21 @@ public File getSettingsFolder() throws Exception {
 
     http://blogs.msdn.com/b/patricka/archive/2010/03/18/where-should-i-store-my-data-and-configuration-files-if-i-target-multiple-os-versions.aspx
    */
+
+
+  /** Get the Users\name\AppData\Roaming path to write settings files. */
   static private String getAppDataPath() throws Exception {
     return Shell32Util.getSpecialFolderPath(ShlObj.CSIDL_APPDATA, true);
+  }
 
-    /*
-    // this will be contain the path if SHGetFolderPath is successful
-    char[] pszPath = new char[WinDef.MAX_PATH];
-    HRESULT hResult =
-      Shell32.INSTANCE.SHGetFolderPath(null, ShlObj.CSIDL_APPDATA,
-                                       null, ShlObj.SHGFP_TYPE_CURRENT,
-                                       pszPath);
-
-    if (!hResult.equals(WinError.S_OK)) {
-      //System.err.println(Kernel32Util.formatMessageFromHR(hResult));
-      //throw new Exception("Problem city, population: your computer.");
-      throw new Exception(Kernel32Util.formatMessageFromHR(hResult));
-    }
 
-    String appDataPath = new String(pszPath);
-    int len = appDataPath.indexOf("\0");
-    return appDataPath.substring(0, len);
-    */
+  /** Get the Users\name\AppData\Local path as a settings fallback. */
+  static private String getLocalAppDataPath() throws Exception {
+    return Shell32Util.getSpecialFolderPath(ShlObj.CSIDL_LOCAL_APPDATA, true);
   }
 
 
-  // looking for Documents and Settings/blah/My Documents/Processing
+  /** Get the Documents and Settings\name\My Documents\Processing folder. */
   public File getDefaultSketchbookFolder() throws Exception {
     String documentsPath = getDocumentsPath();
     if (documentsPath != null) {
@@ -313,6 +316,12 @@ public File getDefaultSketchbookFolder() throws Exception {
   }
 
 
+  static private String getDocumentsPath() throws Exception {
+    return Shell32Util.getSpecialFolderPath(ShlObj.CSIDL_MYDOCUMENTS, true);
+  }
+
+
+  /*
   static private String getDocumentsPath() throws Exception {
     // heh, this is a little too cheeky
     //new JFileChooser().getFileSystemView().getDefaultDirectory().toString();
@@ -351,6 +360,7 @@ static private String getDocumentsPath() throws Exception {
     int len = personalPath.indexOf("\0");
     return personalPath.substring(0, len);
   }
+  */
 
 
 //  @Override
@@ -503,6 +513,8 @@ public void openFolder(File file) throws Exception {
   static WinLibC clib;
 
 
+  // moved to a getter so that we could handle errors in a single location
+  // and at a time when it was useful/possible (rather than a static block)
   static WinLibC getLibC() {
     if (clib == null) {
       try {
