refactor: move data from $XDG_CONFIG_HOME/SourceGit to $XDG_DATA_HOME/SourceGit on Linux (#2088)

Old datas will be migrated automatically

Signed-off-by: leo <longshuang@msn.cn>

Author: love-linger

README.md

@@ -70,13 +70,13 @@
 
 You can download the latest stable from [Releases](https://github.com/sourcegit-scm/sourcegit/releases/latest) or download workflow artifacts from [GitHub Actions](https://github.com/sourcegit-scm/sourcegit/actions) to try this app based on latest commits.
 
-This software creates a folder `$"{System.Environment.SpecialFolder.ApplicationData}/SourceGit"`, which is platform-dependent, to store user settings, downloaded avatars and crash logs.
+This software creates a folder, which is platform-dependent, to store user settings, downloaded avatars and crash logs.
 
-| OS      | PATH                                                |
-|---------|-----------------------------------------------------|
-| Windows | `%APPDATA%\SourceGit`                               |
-| Linux   | `${HOME}/.config/SourceGit` or `${HOME}/.sourcegit` |
-| macOS   | `${HOME}/Library/Application Support/SourceGit`     |
+| OS      | PATH                                            |
+|---------|-------------------------------------------------|
+| Windows | `%APPDATA%\SourceGit`                           |
+| Linux   | `${HOME}/.local/share/SourceGit`                |
+| macOS   | `${HOME}/Library/Application Support/SourceGit` |
 
 > [!TIP]
 > * You can open this data storage directory from the main menu `Open Data Storage Directory`.

src/Native/Linux.cs

@@ -33,6 +33,45 @@ public void SetupWindow(Window window)
             }
         }
 
+        public string GetDataDir()
+        {
+            // AppImage supports portable mode
+            var appImage = Environment.GetEnvironmentVariable("APPIMAGE");
+            if (!string.IsNullOrEmpty(appImage) && File.Exists(appImage))
+            {
+                var portableDir = Path.Combine(Path.GetDirectoryName(appImage)!, "data");
+                if (Directory.Exists(portableDir))
+                    return portableDir;
+            }
+
+            var home = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile);
+            var dataDir = Path.Combine(home, ".local", "share", "SourceGit"); // New data dir: $XDG_DATA_HOME/SourceGit
+
+            // Migrate old data.
+            if (!Directory.Exists(dataDir))
+            {
+                var oldDataDir = Path.Combine(home, ".config", "SourceGit"); // Old data dir: $XDG_CONFIG_HOME/SourceGit
+                var oldFallbackDir = Path.Combine(home, ".sourcegit"); // Old fallback folder: $HOME/.sourcegit
+                var moveDir = Directory.Exists(oldDataDir)
+                    ? oldDataDir
+                    : (Directory.Exists(oldFallbackDir) ? oldFallbackDir : string.Empty);
+
+                if (!string.IsNullOrEmpty(moveDir))
+                {
+                    try
+                    {
+                        Directory.Move(moveDir, dataDir);
+                    }
+                    catch
+                    {
+                        // Ignore errors
+                    }
+                }
+            }
+
+            return dataDir;
+        }
+
         public string FindGitExecutable()
         {
             return FindExecutable("git");

src/Native/MacOS.cs

@@ -44,6 +44,13 @@ public void SetupWindow(Window window)
             window.ExtendClientAreaToDecorationsHint = true;
         }
 
+        public string GetDataDir()
+        {
+            return Path.Combine(
+                Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
+                "SourceGit");
+        }
+
         public string FindGitExecutable()
         {
             var gitPathVariants = new List<string>() {

src/Native/OS.cs

@@ -17,6 +17,7 @@ public interface IBackend
             void SetupApp(AppBuilder builder);
             void SetupWindow(Window window);
 
+            string GetDataDir();
             string FindGitExecutable();
             string FindTerminal(Models.ShellOrTerminal shell);
             List<Models.ExternalTool> FindExternalTools();
@@ -132,47 +133,18 @@ static OS()
             }
         }
 
-        public static void SetupApp(AppBuilder builder)
-        {
-            _backend.SetupApp(builder);
-        }
-
         public static void SetupDataDir()
         {
-            if (OperatingSystem.IsWindows())
-            {
-                var execFile = Process.GetCurrentProcess().MainModule!.FileName;
-                var portableDir = Path.Combine(Path.GetDirectoryName(execFile)!, "data");
-                if (Directory.Exists(portableDir))
-                {
-                    DataDir = portableDir;
-                    return;
-                }
-            }
-            else if (OperatingSystem.IsLinux())
-            {
-                var appImage = Environment.GetEnvironmentVariable("APPIMAGE");
-                if (!string.IsNullOrEmpty(appImage) && File.Exists(appImage))
-                {
-                    var portableDir = Path.Combine(Path.GetDirectoryName(appImage)!, "data");
-                    if (Directory.Exists(portableDir))
-                    {
-                        DataDir = portableDir;
-                        return;
-                    }
-                }
-            }
-
-            var osAppDataDir = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
-            if (string.IsNullOrEmpty(osAppDataDir))
-                DataDir = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".sourcegit");
-            else
-                DataDir = Path.Combine(osAppDataDir, "SourceGit");
-
+            DataDir = _backend.GetDataDir();
             if (!Directory.Exists(DataDir))
                 Directory.CreateDirectory(DataDir);
         }
 
+        public static void SetupApp(AppBuilder builder)
+        {
+            _backend.SetupApp(builder);
+        }
+
         public static void SetupExternalTools()
         {
             ExternalTools = _backend.FindExternalTools();

src/Native/Windows.cs

@@ -114,6 +114,18 @@ public void SetupWindow(Window window)
             });
         }
 
+        public string GetDataDir()
+        {
+            var execFile = Process.GetCurrentProcess().MainModule!.FileName;
+            var portableDir = Path.Combine(Path.GetDirectoryName(execFile)!, "data");
+            if (Directory.Exists(portableDir))
+                return portableDir;
+
+            return Path.Combine(
+                Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData),
+                "SourceGit");
+        }
+
         public string FindGitExecutable()
         {
             var reg = Microsoft.Win32.RegistryKey.OpenBaseKey(