Merge branch 'source/bandcamp' into experimental

music_kraken/utils/path_manager/__init__.py

@@ -0,0 +1,3 @@
+from .locations import Locations
+
+LOCATIONS = Locations()

music_kraken/utils/path_manager/config_directory.py

@@ -0,0 +1,7 @@
+from pathlib import Path
+
+import platformdirs
+
+
+def get_config_directory(application_name: str) -> Path:
+    return platformdirs.user_config_path(appname=application_name)

music_kraken/utils/path_manager/locations.py

@@ -0,0 +1,88 @@
+import configparser
+from pathlib import Path
+import os
+from os.path import expandvars
+import logging
+from sys import platform
+
+import tempfile
+from typing import Optional
+
+from pyffmpeg import FFmpeg
+
+
+from .music_directory import get_music_directory
+from .config_directory import get_config_directory
+
+
+class Locations:
+    @staticmethod
+    def _get_env(key: str, default: Path, default_for_windows: bool = True) -> Optional[Path]:
+        res = os.environ.get(key.upper())
+        if res is not None:
+            return res
+
+        xdg_user_dirs_file = os.environ.get("XDG_CONFIG_HOME") or Path(Path.home(), ".config", "user-dirs.dirs")
+        xdg_user_dirs_default_file = Path("/etc/xdg/user-dirs.defaults")
+
+        def get_dir_from_xdg_file(xdg_file_path: os.PathLike) -> Optional[Path]:
+            nonlocal key
+
+            try:
+                with open(xdg_file_path, 'r') as f:
+                    data = "[XDG_USER_DIRS]\n" + f.read()
+                config = configparser.ConfigParser(allow_no_value=True)
+                config.read_string(data)
+                xdg_config = config['XDG_USER_DIRS']
+
+                return Path(expandvars(xdg_config[key.lower()].strip('"')))
+
+            except (FileNotFoundError, KeyError) as e:
+                logging.warning(
+                    f"Missing file or No entry found for \"{key}\" in: \"{xdg_file_path}\".\n"
+                )
+                logging.debug(str(e))
+
+        res = get_dir_from_xdg_file(xdg_user_dirs_file)
+        if res is not None:
+            return res
+
+        res = get_dir_from_xdg_file(xdg_user_dirs_default_file)
+        if res is not None:
+            return res
+
+        logging.warning(f"couldn't find a {key}, falling back to: {default}")
+
+        if not default_for_windows and platform == "linux":
+            return
+
+        return default
+
+    def __init__(self, application_name: os.PathLike = "music-kraken"):
+        self.FILE_ENCODING: str = "utf-8"
+        
+        self.TEMP_DIRECTORY = Path(tempfile.gettempdir(), application_name)
+        self.TEMP_DIRECTORY.mkdir(exist_ok=True, parents=True)
+
+        self.MUSIC_DIRECTORY = get_music_directory()
+
+        self.CONFIG_DIRECTORY = get_config_directory(str(application_name))
+        self.CONFIG_DIRECTORY.mkdir(exist_ok=True, parents=True)
+        self.CONFIG_FILE = Path(self.CONFIG_DIRECTORY, f"{application_name}.conf")
+        self.LEGACY_CONFIG_FILE = Path(self.CONFIG_DIRECTORY, f"{application_name}.conf")
+
+        self.CACHE_DIRECTORY = self._get_env("XDG_CACHE_HOME", Path(Path.home(), ".cache"))
+        if self.CACHE_DIRECTORY is None:
+            logging.warning(f"Could not find a cache dir. Falling back to the temp dir: {self.TEMP_DIRECTORY}")
+            self.CACHE_DIRECTORY = self.TEMP_DIRECTORY
+        else:
+            self.CACHE_DIRECTORY = Path(self.CACHE_DIRECTORY, application_name)
+        self.CACHE_DIRECTORY.mkdir(parents=True, exist_ok=True)
+        
+        self.FFMPEG_BIN = Path(FFmpeg(enable_log=False).get_ffmpeg_bin())
+
+    def get_config_file(self, config_name: str) -> Path:
+        return Path(self.CONFIG_DIRECTORY, f"{config_name}.toml")
+
+    def get_log_file(self, file_name: os.PathLike) -> Path:
+        return Path(self.TEMP_DIRECTORY, file_name)

music_kraken/utils/path_manager/music_directory.py

@@ -0,0 +1,58 @@
+import os
+from pathlib import Path
+from typing import Optional
+
+from sys import platform
+import logging
+from os.path import expandvars
+
+import configparser
+
+DEFAULT_MUSIC_DIRECTORY = Path(Path.home(), "Music")
+
+
+def get_xdg_music_directory() -> Path:
+    """
+    gets the xdg music directory, for all the linux or bsd folks!
+    Thanks to Distant Thunder, as well as Kevin Gruber for making that pull request:
+    https://github.com/HeIIow2/music-downloader/pull/6
+
+    XDG_USER_DIRS_FILE reference:
+    https://freedesktop.org/wiki/Software/xdg-user-dirs/
+    https://web.archive.org/web/20230322012953/https://freedesktop.org/wiki/Software/xdg-user-dirs/
+    """
+
+    xdg_user_dirs_file = Path(os.environ.get("XDG_CONFIG_HOME") or Path(Path.home(), ".config"), "user-dirs.dirs")
+    xdg_user_dirs_default_file = Path("/etc/xdg/user-dirs.defaults")
+
+    def get_music_dir_from_xdg_file(xdg_file_path: os.PathLike) -> Optional[Path]:
+        try:
+            with open(xdg_file_path, 'r', encoding="utf-8") as f:
+                data = "[XDG_USER_DIRS]\n" + f.read()
+            config = configparser.ConfigParser(allow_no_value=True)
+            config.read_string(data)
+            xdg_config = config['XDG_USER_DIRS']
+            return Path(expandvars(xdg_config['xdg_music_dir'].strip('"')))
+
+        except (FileNotFoundError, KeyError) as e:
+            logging.warning(
+                f"Missing file or No entry found for \"xdg_music_dir\" in: \"{xdg_file_path}\".\n"
+            )
+            logging.debug(str(e))
+
+    music_dir = get_music_dir_from_xdg_file(xdg_user_dirs_file)
+    if music_dir is not None:
+        return music_dir
+    music_dir = get_music_dir_from_xdg_file(xdg_user_dirs_default_file)
+    if music_dir is not None:
+        return music_dir
+
+    logging.warning(f"couldn't find a XDG music dir, falling back to: {DEFAULT_MUSIC_DIRECTORY}")
+    return DEFAULT_MUSIC_DIRECTORY
+
+
+def get_music_directory() -> Path:
+    if platform != "linux":
+        return DEFAULT_MUSIC_DIRECTORY
+
+    return get_xdg_music_directory()