Merge pull request #155 from dylanljones/key-cache

Key cache

Author: dylanljones

CHANGELOG.md

@@ -9,6 +9,9 @@
 - **db:** **allow commiting if playlist is not found in XML ([#149](https://github.com/dylanljones/pyrekordbox/issues/149))**  
   This fixes an issue where the changes to the DB can not be commited if the playlist is missing 
   in the playlist-xml. A warning is now shown instead.
+- **config:** **move pyrekordbox cache file to appdir**  
+  The cache file is now stored in the appdata directory of the user. 
+  This avoids writing to the pyrekordbox package directory.
 
 
 <a name="v0.4.0"></a>

pyrekordbox/config.py

@@ -30,7 +30,7 @@
 
 # Cache file for pyrekordbox data
 _cache_file_version = 2
-_cache_file = Path(__file__).parent / "rb.cache"
+_cache_file_name = "rb.cache"
 
 # Define empty pyrekordbox configuration
 __config__ = {
@@ -48,6 +48,25 @@ class InvalidApplicationDirname(Exception):
     pass
 
 
+def get_appdata_dir() -> Path:
+    """Returns the path of the application data directory.
+
+    On Windows, the application data is stored in `/Users/user/AppData/Roaming`.
+    On macOS the application data is stored in `~/Libary/Application Support`.
+    """
+    if sys.platform == "win32":
+        # Windows: located in /Users/user/AppData/Roaming/
+        app_data = Path(os.environ["AppData"])
+    elif sys.platform == "darwin":
+        # MacOS: located in ~/Library/Application Support/
+        app_data = Path("~").expanduser() / "Library" / "Application Support"
+    else:
+        # Linux: not supported
+        logger.warning(f"OS {sys.platform} not supported!")
+        return Path("~").expanduser() / ".local" / "share"
+    return app_data
+
+
 def get_pioneer_install_dir(path: Union[str, Path] = None) -> Path:  # pragma: no cover
     """Returns the path of the Pioneer program installation directory.
 
@@ -426,12 +445,16 @@ def run(self):
 
 
 def write_db6_key_cache(key: str) -> None:  # pragma: no cover
-    """Writes the decrypted Rekordbox6 database key to the cache file.
+    r"""Writes the decrypted Rekordbox6 database key to the cache file.
 
     This method can also be used to manually cache the database key, provided
     the user has found the key somewhere else. The key can be, for example,
     found in some other projects that hard-coded it.
 
+    The cache file is stored in the application data directory of pyrekordbox:
+    Windows: `C:\Users\<user>\AppData\Roaming\pyrekordbox`
+    macOS: `~/Library/Application Support/pyrekordbox`
+
     Parameters
     ----------
     key : str
@@ -453,7 +476,12 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
     lines.append(f"version: {_cache_file_version}")
     lines.append("dp: " + key)
     text = "\n".join(lines)
-    with open(_cache_file, "w") as fh:
+
+    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+    if not cache_file.parent.exists():
+        cache_file.parent.mkdir()
+
+    with open(cache_file, "w") as fh:
         fh.write(text)
     # Set the config key to make sure the key is present after calling method
     if __config__["rekordbox6"]:
@@ -465,10 +493,13 @@ def write_db6_key_cache(key: str) -> None:  # pragma: no cover
 def _update_sqlite_key(opts, conf):
     cache_version = 0
     pw, dp = "", ""
-    if _cache_file.exists():  # pragma: no cover
-        logger.debug("Found cache file %s", _cache_file)
+
+    cache_file = get_appdata_dir() / "pyrekordbox" / _cache_file_name
+
+    if cache_file.exists():  # pragma: no cover
+        logger.debug("Found cache file %s", cache_file)
         # Read cache file
-        with open(_cache_file, "r") as fh:
+        with open(cache_file, "r") as fh:
             text = fh.read()
         lines = text.splitlines()
         if lines[0].startswith("version:"):