clan-core/pkgs/clan-cli/clan_cli/dirs.py

import logging
import os
import sys
from pathlib import Path
from typing import Optional

from .errors import ClanError
from .types import FlakeName

log = logging.getLogger(__name__)


def get_clan_flake_toplevel() -> Optional[Path]:
    return find_toplevel([".clan-flake", ".git", ".hg", ".svn", "flake.nix"])


def find_git_repo_root() -> Optional[Path]:
    try:
        return find_toplevel([".git"])
    except ClanError:
        return None


def find_toplevel(top_level_files: list[str]) -> Optional[Path]:
    """Returns the path to the toplevel of the clan flake"""
    for project_file in top_level_files:
        initial_path = Path(os.getcwd())
        path = Path(initial_path)
        while path.parent != path:
            if (path / project_file).exists():
                return path
            path = path.parent
    return None


def user_config_dir() -> Path:
    if sys.platform == "win32":
        return Path(os.getenv("APPDATA", os.path.expanduser("~\\AppData\\Roaming\\")))
    elif sys.platform == "darwin":
        return Path(os.path.expanduser("~/Library/Application Support/"))
    else:
        return Path(os.getenv("XDG_CONFIG_HOME", os.path.expanduser("~/.config")))


def clan_config_dir() -> Path:
    path = user_config_dir() / "clan"
    path.mkdir(parents=True, exist_ok=True)
    return path.resolve()


def clan_flakes_dir() -> Path:
    path = clan_config_dir() / "flakes"
    path.mkdir(parents=True, exist_ok=True)
    return path.resolve()


def specific_flake_dir(flake_name: FlakeName) -> Path:
    flake_dir = clan_flakes_dir() / flake_name
    if not flake_dir.exists():
        raise ClanError(f"Flake '{flake_name}' does not exist in {clan_flakes_dir()}")
    return flake_dir


def machines_dir(flake_name: FlakeName) -> Path:
    return specific_flake_dir(flake_name) / "machines"


def specific_machine_dir(flake_name: FlakeName, machine: str) -> Path:
    return machines_dir(flake_name) / machine


def machine_settings_file(flake_name: FlakeName, machine: str) -> Path:
    return specific_machine_dir(flake_name, machine) / "settings.json"


def module_root() -> Path:
    return Path(__file__).parent


def nixpkgs_flake() -> Path:
    return (module_root() / "nixpkgs").resolve()


def nixpkgs_source() -> Path:
    return (module_root() / "nixpkgs" / "path").resolve()


def unfree_nixpkgs() -> Path:
    return module_root() / "nixpkgs" / "unfree"