Improved system_paths list generation for Windows.

core/system_paths.py

@@ -5,6 +5,7 @@
 custom paths.
 """
 
+import os.path
 from pathlib import Path
 
 from talon import Module, actions, app
@@ -28,32 +29,146 @@ def on_ready():
 
     default_system_paths = {
         "user": home,
-        "desktop": home / "Desktop",
-        "desk": home / "Desktop",
-        "documents": home / "Documents",
-        "docks": home / "Documents",
-        "downloads": home / "Downloads",
-        "music": home / "Music",
-        "pictures": home / "Pictures",
-        "videos": home / "Videos",
         "talon home": talon_home,
         "talon recordings": talon_home / "recordings",
         "talon user": actions.path.talon_user(),
     }
 
     if app.platform == "windows":
-        default_system_paths["profile"] = home
-        onedrive_path = home / "OneDrive"
-
-        # this is probably not the correct way to check for OneDrive, quick and dirty
-        if (onedrive_path / "Desktop").is_dir():
-            default_system_paths["desktop"] = onedrive_path / "Desktop"
-            default_system_paths["documents"] = onedrive_path / "Documents"
-            default_system_paths["one drive"] = onedrive_path
-            default_system_paths["pictures"] = onedrive_path / "Pictures"
+        import winreg
+
+        # Virtual folders.
+        default_system_paths.update(
+            {
+                # Virtual-only folders.
+                "quick access": "shell:::{679F85CB-0220-4080-B29B-5540CC05AAB6}",
+                "this pc": "shell:MyComputerFolder",  # Or `shell:::{20D04FE0-3AEA-1069-A2D8-08002B30309D}`, also without `shell:`.
+                "network": "shell:NetworkPlacesFolder",  # Or `shell:::{F02C1A0D-BE21-4350-88B0-7367FC96EF3C}`, also without `shell:`.
+                "recycle bin": "shell:RecycleBinFolder",  # Or `shell:::{645FF040-5081-101B-9F08-00AA002F954E}`, also without `shell:`.
+                # Folders with virtual and resolved form.
+                "virtual desktop": "shell:Desktop",
+                # More like, e.g., `shell:Downloads` can be found under the registry key
+                # `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\FolderDescriptions`.
+                # You can also find a long list of GUIDs under
+                # <https://www.autohotkey.com/docs/v2/misc/CLSID-List.htm>.
+            }
+        )
+
+        # Resolved forms of virtual folders whose locations the user may have changed.
+        with winreg.OpenKey(
+            winreg.HKEY_CURRENT_USER,
+            r"SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders",
+        ) as key:
+
+            def get_path(value_name, fallback):
+                try:
+                    path_str, value_type = winreg.QueryValueEx(key, value_name)
+                    assert value_type == winreg.REG_EXPAND_SZ
+                except (FileNotFoundError, AssertionError):
+                    path_str = str(fallback)
+                return Path(os.path.expandvars(path_str))
+
+            local_downloads_path = get_path(
+                "{7D83EE9B-2244-4E70-B1F5-5393042AF1E4}", r"%USERPROFILE%\Downloads"
+            )
+
+            default_system_paths.update(
+                {
+                    "desktop": get_path("Desktop", r"%USERPROFILE%\Desktop"),
+                    "documents": get_path("Personal", r"%USERPROFILE%\Documents"),
+                    "downloads": get_path(
+                        "{374DE290-123F-4565-9164-39C4925E467B}", local_downloads_path
+                    ),
+                    "local downloads": local_downloads_path,
+                    "music": get_path("My Music", r"%USERPROFILE%\Music"),
+                    "pictures": get_path("My Pictures", r"%USERPROFILE%\Pictures"),
+                    "videos": get_path("My Video", r"%USERPROFILE%\Videos"),
+                }
+            )
+
+        # Paths from environment variables.
+        def get_env_path(var_name):
+            try:
+                return Path(os.environ[var_name])
+            except KeyError:
+                return None
+
+        onedrive_path = get_env_path("OneDrive")
+
+        default_system_paths.update(
+            {
+                spoken_form: path
+                for spoken_form, path in {
+                    "system root": get_env_path("SystemRoot"),
+                    "program files": get_env_path("ProgramFiles"),
+                    "program files ex eighty six": get_env_path("ProgramFiles(x86)"),
+                    "all users profile": get_env_path("ALLUSERSPROFILE"),
+                    "public user profile": get_env_path("PUBLIC"),
+                    "app data": get_env_path("APPDATA"),
+                    "local app data": get_env_path("LOCALAPPDATA"),
+                    "program data": get_env_path("ProgramData"),
+                    "temp dir": get_env_path("TEMP"),
+                    "one drive": onedrive_path,
+                }.items()
+                if path is not None
+            }
+        )
+
+        # OneDrive subpaths.
+        if onedrive_path:
+            # this is probably not the correct way to check for OneDrive, quick and dirty
+            onedrive_desktop_path = onedrive_path / "Desktop"
+            if onedrive_desktop_path.is_dir():
+                default_system_paths.update(
+                    {
+                        "desktop": onedrive_desktop_path,
+                        "documents": onedrive_path / "Documents",
+                        "pictures": onedrive_path / "Pictures",
+                    }
+                )
+    else:  # Mac and Linux.
+        default_system_paths.update(
+            {
+                # TODO: Correct this for Mac and Linux.
+                "desktop": home / "Desktop",
+                "documents": home / "Documents",
+                "downloads": home / "Downloads",
+                "music": home / "Music",
+                "pictures": home / "Pictures",
+                "videos": home / "Videos",
+            }
+        )
+
+    # Aliases.
+    default_system_paths.update(
+        {
+            "desk": default_system_paths["desktop"],
+            "docks": default_system_paths["documents"],
+        }
+    )
+
+    if app.platform == "windows":
+        default_system_paths.update(
+            {
+                "virtual desk": default_system_paths["virtual desktop"],
+                "vee desk": default_system_paths["virtual desktop"],
+                "trash": default_system_paths["recycle bin"],
+                "win dir": default_system_paths["system root"],
+                "user profile": default_system_paths["user"],
+                "profile": default_system_paths["user"],
+                "public profile": default_system_paths["public user profile"],
+                "temp files": default_system_paths["temp dir"],
+                "temporary": default_system_paths["temp dir"],
+            }
+        )
     else:
-        default_system_paths["home"] = home
+        default_system_paths.update(
+            {
+                "home": default_system_paths["user"],
+            }
+        )
 
+    # Build .talon-list file.
     with open(system_paths, "x") as f:
         print("list: user.system_paths", file=f)
         print(f"hostname: {hostname}", file=f)