From 9ff4ec856b0ce9f78fe15bedabbca731b36fd837 Mon Sep 17 00:00:00 2001
From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>
Date: Fri, 9 Aug 2024 16:00:10 +0200
Subject: [PATCH] introduced new function to get launcher storage and local dir

---
 client/ayon_core/lib/__init__.py       |  4 +++
 client/ayon_core/lib/local_settings.py | 49 ++++++++++++++++++++++++++
 2 files changed, 53 insertions(+)

diff --git a/client/ayon_core/lib/__init__.py b/client/ayon_core/lib/__init__.py
index 12c391d867..d4b161031e 100644
--- a/client/ayon_core/lib/__init__.py
+++ b/client/ayon_core/lib/__init__.py
@@ -9,6 +9,8 @@ from .local_settings import (
     AYONSettingsRegistry,
     OpenPypeSecureRegistry,
     OpenPypeSettingsRegistry,
+    get_launcher_local_dir,
+    get_launcher_storage_dir,
     get_local_site_id,
     get_ayon_username,
     get_openpype_username,
@@ -144,6 +146,8 @@ __all__ = [
     "AYONSettingsRegistry",
     "OpenPypeSecureRegistry",
     "OpenPypeSettingsRegistry",
+    "get_launcher_local_dir",
+    "get_launcher_storage_dir",
     "get_local_site_id",
     "get_ayon_username",
     "get_openpype_username",
diff --git a/client/ayon_core/lib/local_settings.py b/client/ayon_core/lib/local_settings.py
index 54432265d9..68ec48695f 100644
--- a/client/ayon_core/lib/local_settings.py
+++ b/client/ayon_core/lib/local_settings.py
@@ -30,6 +30,55 @@ import ayon_api
 _PLACEHOLDER = object()
 
 
+def get_launcher_storage_dir(*subdirs: str) -> str:
+    """Get storage directory for launcher.
+
+    Storage directory is used for storing shims, addons, dependencies, etc.
+
+    It is not recommended, but the location can be shared across
+        multiple machines.
+
+    Note:
+        This function should be called at least once on bootstrap.
+
+    Args:
+        *subdirs (str): Subdirectories relative to storage dir.
+
+    Returns:
+        str: Path to storage directory.
+
+    """
+    storage_dir = os.getenv("AYON_LAUNCHER_STORAGE_DIR")
+    if not storage_dir:
+        storage_dir = get_ayon_appdirs()
+
+    return os.path.join(storage_dir, *subdirs)
+
+
+def get_launcher_local_dir(*subdirs: str) -> str:
+    """Get local directory for launcher.
+
+    Local directory is used for storing machine or user specific data.
+
+    The location is user specific.
+
+    Note:
+        This function should be called at least once on bootstrap.
+
+    Args:
+        *subdirs (str): Subdirectories relative to local dir.
+
+    Returns:
+        str: Path to local directory.
+
+    """
+    storage_dir = os.getenv("AYON_LAUNCHER_LOCAL_DIR")
+    if not storage_dir:
+        storage_dir = get_ayon_appdirs()
+
+    return os.path.join(storage_dir, *subdirs)
+
+
 class AYONSecureRegistry:
     """Store information using keyring.