MACOS: Change default savepath to use the Application Support folder

The default savepath on macOS used to be in the user Document folder.
However ScummVM requires special permission to access that folder,
and if the user denied it, this caused various issues.
This implement ticket #11428.

This commit also contains migration code that that old configs that
used the default path are set explicitly to use the old default path.
So the change of savepath will only be for new users.

Author: criezy

backends/platform/sdl/macosx/macosx.cpp

@@ -117,6 +117,20 @@ void OSystem_MacOSX::initBackend() {
 	_textToSpeechManager = new MacOSXTextToSpeechManager();
 #endif
 
+	// Migrate savepath.
+	// It used to be in ~/Documents/ScummVM Savegames/, but was changed to use the application support
+	// directory. To migrate old config files we use a flag to indicate if the config file was migrated.
+	// This allows detecting old config files. If the flag is not set we:
+	// 1. Set the flag
+	// 2. If the config file has no custom savepath and has some games, we set the savepath to the old default.
+	if (!ConfMan.hasKey("macos_savepath_migrated", Common::ConfigManager::kApplicationDomain)) {
+		if (!ConfMan.hasKey("savepath", Common::ConfigManager::kApplicationDomain) && !ConfMan.getGameDomains().empty()) {
+			ConfMan.set("savepath", getDocumentsPathMacOSX() + "/ScummVM Savegames", Common::ConfigManager::kApplicationDomain);
+		}
+		ConfMan.setBool("macos_savepath_migrated", true, Common::ConfigManager::kApplicationDomain);
+		ConfMan.flushToDisk();
+	}
+
 	// Invoke parent implementation of this method
 	OSystem_POSIX::initBackend();
 }

backends/platform/sdl/macosx/macosx_wrapper.h

@@ -25,6 +25,7 @@
 #include <common/str.h>
 
 Common::String getDesktopPathMacOSX();
+Common::String getDocumentsPathMacOSX();
 Common::String getResourceAppBundlePathMacOSX();
 Common::String getAppSupportPathMacOSX();
 Common::String getMacBundleName();

backends/platform/sdl/macosx/macosx_wrapper.mm

@@ -46,6 +46,17 @@
 	return Common::String([path fileSystemRepresentation]);
 }
 
+Common::String getDocumentsPathMacOSX() {
+	// See comment in getDesktopPathMacOSX()
+	NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
+	if ([paths count] == 0)
+		return Common::String();
+	NSString *path = [paths objectAtIndex:0];
+	if (path == nil)
+		return Common::String();
+	return Common::String([path fileSystemRepresentation]);
+}
+
 Common::String getResourceAppBundlePathMacOSX() {
 	NSString *bundlePath = [[NSBundle mainBundle] resourcePath];
 	if (bundlePath == nil)

backends/saves/posix/posix-saves.cpp

@@ -32,6 +32,9 @@
 
 #include "backends/saves/posix/posix-saves.h"
 #include "backends/fs/posix/posix-fs.h"
+#if defined(MACOSX)
+#include "backends/platform/sdl/macosx/macosx_wrapper.h"
+#endif
 
 #include "common/config-manager.h"
 #include "common/savefile.h"
@@ -44,14 +47,11 @@ POSIXSaveFileManager::POSIXSaveFileManager() {
 	Common::Path savePath;
 
 #if defined(MACOSX)
-	const char *home = getenv("HOME");
-	if (home && *home && strlen(home) < MAXPATHLEN) {
-		savePath = home;
-		savePath.joinInPlace("Documents/ScummVM Savegames");
-
+	savePath = getAppSupportPathMacOSX();
+	if (!savePath.empty()) {
+		savePath.joinInPlace("Savegames");
 		ConfMan.registerDefault("savepath", savePath);
 	}
-
 #else
 	const char *envVar;
 

dists/macosx/Info.plist

@@ -78,8 +78,6 @@
 	<string>scummvm.docktileplugin</string>
 	<key>NSRequiresAquaSystemAppearance</key>
 	<false/>
-	<key>NSDocumentsFolderUsageDescription</key>
-	<string>ScummVM saves and loads savegames in the Documents folder by default.</string>
 	<key>SUPublicDSAKeyFile</key>
 	<string>dsa_pub.pem</string>
 	<key>NSHighResolutionCapable</key>

dists/macosx/Info.plist.in

@@ -78,8 +78,6 @@
 	<string>scummvm.docktileplugin</string>
 	<key>NSRequiresAquaSystemAppearance</key>
 	<false/>
-	<key>NSDocumentsFolderUsageDescription</key>
-	<string>ScummVM saves and loads savegames in the Documents folder by default.</string>
 	<key>SUPublicDSAKeyFile</key>
 	<string>dsa_pub.pem</string>
 	<key>NSHighResolutionCapable</key>

doc/cz/PrectiMe

@@ -1352,7 +1352,7 @@ Uložené hry jsou na některých platformách standardně umístěny do součas
 
 Platformy, které v současnosti mají jiné výchozí složky jsou:
     macOS:
-    $HOME/Documents/ScummVM Savegames/
+    $HOME/Library/Application Support/ScummVM/Savegames/
 
     Jiné unixy:
     Řídíme se specifikacemi základního adresáře XDG. To znamená, že nastavení lze nalézt v:

doc/de/LIESMICH

@@ -2017,7 +2017,7 @@ Sehen Sie sich das Beispiel weiter unten in dieser Liesmich-Datei an.
 
 Die folgenden Plattformen haben ein anderes Standard-Verzeichnis:
     macOS:
-    $HOME/Documents/ScummVM Savegames/
+    $HOME/Library/Application Support/ScummVM/Savegames/
 
     Andere UNIX-Systeme:
     Wir befolgen die Spezifikation XDG Base Directory. Dies bedeutet, dass

doc/docportal/use_scummvm/save_load_games.rst

@@ -60,7 +60,7 @@ Default saved game paths are shown below.
 
     .. tab-item:: macOS
 
-        ``~/Documents/ScummVM Savegames/``
+        ``~/Library/Application Support/ScummVM/Savegames/`` (with versions of ScummVM prior to 2.9 it was in ``~/Documents/ScummVM Savegames/``).
 
 
     .. tab-item:: Linux/Unix

doc/se/LasMig

@@ -1031,7 +1031,7 @@ Spardata lagras som standard i den aktiva katalogen på vissa plattformar och i
 
 Plattformar som för närvarande har annorlunda standardkataloger:
     macOS:
-    $HOME/Documents/ScummVM Savegames/
+    $HOME/Library/Application Support/ScummVM/Savegames/
 
     Övriga unix-system:
     $HOME/.scummvm/