feat/ovos_conf from ovos_utils (#34)

* feat/ovos_conf from ovos_utils

logic moved to ovos_utils OpenVoiceOS/ovos-utils#12

* bump ovos_utils
authored-by: jarbasai <jarbasai@mailfence.com>

Author: NeonJarbas

mycroft/client/text/text_client.py

@@ -32,8 +32,8 @@
 from mycroft.messagebus.client import MessageBusClient
 from mycroft.messagebus.message import Message
 from mycroft.util.log import LOG
-from mycroft.configuration import Configuration, BASE_FOLDER
-from mycroft.configuration.ovos import is_using_xdg
+from mycroft.configuration import Configuration
+from ovos_utils.configuration import is_using_xdg, get_xdg_base
 
 import locale
 
@@ -187,7 +187,7 @@ def load_settings():
 
     # Check XDG_CONFIG_DIR
     if config_file is None:
-        for conf_dir in xdg.BaseDirectory.load_config_paths(BASE_FOLDER):
+        for conf_dir in xdg.BaseDirectory.load_config_paths(get_xdg_base()):
             xdg_file = os.path.join(conf_dir, filename)
             if os.path.isfile(xdg_file):
                 config_file = xdg_file
@@ -230,7 +230,7 @@ def save_settings():
         config_file = path
     else:
         config_file = os.path.join(xdg.BaseDirectory.xdg_config_home,
-                                   BASE_FOLDER, filename)
+                                   get_xdg_base(), filename)
 
     with io.open(config_file, 'w') as f:
         f.write(str(json.dumps(config, ensure_ascii=False)))

mycroft/configuration/__init__.py

@@ -16,6 +16,5 @@
 from mycroft.configuration.locale import set_default_lf_lang, setup_locale, \
     set_default_tz, set_default_lang, get_default_tz, get_default_lang, \
     get_config_tz, get_primary_lang_code, load_languages, load_language
-from mycroft.configuration.locations import SYSTEM_CONFIG, USER_CONFIG, \
-    get_xdg_config_locations, BASE_FOLDER, DEFAULT_CONFIG
-from mycroft.configuration.ovos import is_using_xdg, get_ovos_config
+from mycroft.configuration.locations import SYSTEM_CONFIG, USER_CONFIG, DEFAULT_CONFIG
+from ovos_utils.configuration import get_ovos_config, is_using_xdg, get_xdg_config_locations

mycroft/configuration/config.py

@@ -20,7 +20,7 @@
 from requests import RequestException
 
 from mycroft.configuration.locations import *
-from mycroft.configuration.ovos import is_using_xdg
+from ovos_utils.configuration import is_using_xdg, get_xdg_config_locations
 from mycroft.util import camel_case_split
 from mycroft.util.json_helper import load_commented_json, merge_dict
 from mycroft.util.log import LOG
@@ -196,7 +196,7 @@ def _log_old_location_deprecation(old_user_config=OLD_USER_CONFIG):
     LOG.warning(" Note that this location is deprecated and will" +
                 " not be used in the future")
     LOG.warning(" Please move it to " + join(xdg.BaseDirectory.xdg_config_home,
-                                             BASE_FOLDER))
+                                             get_xdg_base()))
 
 
 def _get_system_constraints():

mycroft/configuration/locations.py

@@ -12,40 +12,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import os
-from time import sleep
 from os.path import join, dirname, expanduser, exists
+from time import sleep
 
 import xdg.BaseDirectory
 
-from mycroft.configuration.ovos import get_ovos_config
+from ovos_utils.configuration import get_ovos_config, get_xdg_config_locations
 
 # check for path overrides
 _ovos_cfg = get_ovos_config()
-BASE_FOLDER = _ovos_cfg["base_folder"]
-CONFIG_FILE_NAME = _ovos_cfg["config_filename"]
-DEFAULT_CONFIG = _ovos_cfg["default_config_path"] or \
-                 join(dirname(__file__), CONFIG_FILE_NAME)
 
+DEFAULT_CONFIG = _ovos_cfg["default_config_path"] or \
+                 join(dirname(__file__), "mycroft.conf")
 SYSTEM_CONFIG = os.environ.get('MYCROFT_SYSTEM_CONFIG',
-                               f'/etc/{BASE_FOLDER}/{CONFIG_FILE_NAME}')
+                               f'/etc/{_ovos_cfg["base_folder"]}/{_ovos_cfg["config_filename"]}')
 # TODO: remove in 22.02
 # Make sure we support the old location still
 # Deprecated and will be removed eventually
-OLD_USER_CONFIG = join(expanduser('~'), '.' + BASE_FOLDER, CONFIG_FILE_NAME)
-USER_CONFIG = join(xdg.BaseDirectory.xdg_config_home, BASE_FOLDER, CONFIG_FILE_NAME)
+OLD_USER_CONFIG = join(expanduser('~'), '.' + _ovos_cfg["base_folder"], _ovos_cfg["config_filename"])
+USER_CONFIG = join(xdg.BaseDirectory.xdg_config_home, _ovos_cfg["base_folder"], _ovos_cfg["config_filename"])
 REMOTE_CONFIG = "mycroft.ai"
 WEB_CONFIG_CACHE = os.environ.get('MYCROFT_WEB_CACHE') or \
-                   join(xdg.BaseDirectory.xdg_config_home, BASE_FOLDER, 'web_cache.json')
-
-
-def get_xdg_config_locations():
-    # This includes both the user config and
-    # /etc/xdg/mycroft/mycroft.conf
-    xdg_paths = list(reversed(
-        [join(p, CONFIG_FILE_NAME)
-         for p in xdg.BaseDirectory.load_config_paths(BASE_FOLDER)]
-    ))
-    return xdg_paths
+                   join(xdg.BaseDirectory.xdg_config_home, _ovos_cfg["base_folder"], 'web_cache.json')
 
 
 def __ensure_folder_exists(path):

mycroft/configuration/ovos.py

@@ -62,60 +62,4 @@
    }
 }
 """
-from importlib.util import find_spec
-from os.path import isfile, dirname, join
-
-import xdg.BaseDirectory
-from mycroft.util.json_helper import load_commented_json, merge_dict
-
-
-def get_ovos_config():
-    config = {"xdg": True,
-              "base_folder": "mycroft",
-              "config_filename": "mycroft.conf",
-              "default_config_path": join(dirname(__file__), "mycroft.conf")}
-
-    try:
-        if isfile("/etc/OpenVoiceOS/ovos.conf"):
-            config = merge_dict(config,
-                                load_commented_json(
-                                    "/etc/OpenVoiceOS/ovos.conf"))
-        elif isfile("/etc/mycroft/ovos.conf"):
-            config = merge_dict(config,
-                                load_commented_json("/etc/mycroft/ovos.conf"))
-    except:
-        # tolerate bad json TODO proper exception (?)
-        pass
-
-    # This includes both the user config and
-    # /etc/xdg/OpenVoiceOS/ovos.conf
-    for p in xdg.BaseDirectory.load_config_paths("OpenVoiceOS"):
-        if isfile(join(p, "ovos.conf")):
-            try:
-                xdg_cfg = load_commented_json(join(p, "ovos.conf"))
-                config = merge_dict(config, xdg_cfg)
-            except:
-                # tolerate bad json TODO proper exception (?)
-                pass
-
-    # let's check for derivatives specific configs
-    # the assumption is that these cores are exclusive to each other,
-    # this will never find more than one override
-    # TODO this works if using dedicated .venvs what about system installs?
-    cores = config.get("module_overrides") or {}
-    for k in cores:
-        if find_spec(k):
-            config = merge_dict(config, cores[k])
-            break
-    else:
-        subcores = config.get("submodule_mappings") or {}
-        for k in subcores:
-            if find_spec(k):
-                config = merge_dict(config, cores[subcores[k]])
-                break
-
-    return config
-
-
-def is_using_xdg():
-    return get_ovos_config().get("xdg", True)
+from ovos_utils.configuration import get_ovos_config, is_using_xdg

mycroft/filesystem/__init__.py

@@ -15,8 +15,8 @@
 import os
 import shutil
 from os.path import join, expanduser, isdir
-import mycroft.configuration
 import xdg.BaseDirectory
+from ovos_utils.configuration import is_using_xdg, get_xdg_base
 
 
 class FileSystemAccess:
@@ -35,11 +35,11 @@ def __init_path(path):
         if not isinstance(path, str) or len(path) == 0:
             raise ValueError("path must be initialized as a non empty string")
 
-        path = expanduser(f'~/.{mycroft.configuration.BASE_FOLDER}/{path}')
+        path = expanduser(f'~/.{get_xdg_base()}/{path}')
 
-        if mycroft.configuration.is_using_xdg():
+        if is_using_xdg():
             xdg_path = expanduser(
-                f'{xdg.BaseDirectory.xdg_config_home}/{mycroft.configuration.BASE_FOLDER}/{path}')
+                f'{xdg.BaseDirectory.xdg_config_home}/{get_xdg_base()}/{path}')
             # Migrate from the old location if it still exists
             if isdir(path) and not isdir(xdg_path):
                 shutil.move(path, xdg_path)

mycroft/lock/__init__.py

@@ -14,7 +14,7 @@
 #
 from signal import getsignal, signal, SIGKILL, SIGINT, SIGTERM, \
     SIG_DFL, default_int_handler, SIG_IGN  # signals
-from mycroft.configuration import BASE_FOLDER
+from ovos_utils.configuration import get_xdg_base
 import os  # Operating System functions
 
 #
@@ -98,7 +98,7 @@ class Lock:  # python 3+ 'class Lock'
 
     #
     # Class constants
-    DIRECTORY = get_temp_path(BASE_FOLDER)
+    DIRECTORY = get_temp_path(get_xdg_base())
     FILE = '/{}.pid'
 
     #

mycroft/skills/event_scheduler.py

@@ -23,8 +23,8 @@
 from os.path import isfile, join, expanduser
 import xdg.BaseDirectory
 
-from mycroft.configuration import Configuration, BASE_FOLDER
-from mycroft.configuration.ovos import is_using_xdg
+from mycroft.configuration import Configuration
+from ovos_utils.configuration import is_using_xdg, get_xdg_base
 from mycroft.messagebus.message import Message
 from mycroft.util.log import LOG
 from mycroft.skills.mycroft_skill.event_container import EventContainer, \
@@ -67,13 +67,13 @@ def __init__(self, bus, schedule_file='schedule.json', autostart=True):
         self.is_running = True
 
         core_conf = Configuration.get(remote=False)
-        data_dir = core_conf.get('data_dir', xdg.BaseDirectory.save_data_path(BASE_FOLDER))
+        data_dir = core_conf.get('data_dir', xdg.BaseDirectory.save_data_path(get_xdg_base()))
         old_schedule_path = join(expanduser(data_dir), schedule_file)
 
         self.schedule_file = old_schedule_path
         if is_using_xdg():
             new_schedule_path = join(
-                xdg.BaseDirectory.load_first_config(BASE_FOLDER), schedule_file)
+                xdg.BaseDirectory.load_first_config(get_xdg_base()), schedule_file)
             if isfile(old_schedule_path):
                 shutil.move(old_schedule_path, new_schedule_path)
             self.schedule_file = new_schedule_path

mycroft/skills/msm_wrapper.py

@@ -27,14 +27,15 @@
 from mycroft.configuration import Configuration
 from mycroft.configuration.ovos import is_using_xdg
 from combo_lock import ComboLock
-from mycroft.util.log import LOG
-from mycroft.util.file_utils import get_temp_path
-from mycroft.configuration import BASE_FOLDER
 
 from mock_msm import \
     MycroftSkillsManager as MockMSM, \
     SkillRepo as MockSkillRepo
 
+from ovos_utils.configuration import get_xdg_base
+from mycroft.util.file_utils import get_temp_path
+from mycroft.util.log import LOG
+
 try:
     from msm.exceptions import MsmException
     from msm import MycroftSkillsManager, SkillRepo
@@ -70,16 +71,16 @@ def get_skills_directory(conf=None):
     # if xdg is disabled, ignore it!
     elif not is_using_xdg():
         # old style mycroft-core skills path definition
-        data_dir = conf.get("data_dir") or "/opt/" + BASE_FOLDER
+        data_dir = conf.get("data_dir") or "/opt/" + get_xdg_base()
         folder = conf["skills"].get("msm", {}).get("directory", "skills")
         skills_folder = path.join(data_dir, folder)
     else:
-        skills_folder = xdg.BaseDirectory.save_data_path(BASE_FOLDER + '/skills')
+        skills_folder = xdg.BaseDirectory.save_data_path(get_xdg_base() + '/skills')
     # create folder if needed
     try:
         makedirs(skills_folder, exist_ok=True)
     except PermissionError:  # old style /opt/mycroft/skills not available
-        skills_folder = xdg.BaseDirectory.save_data_path(BASE_FOLDER + '/skills')
+        skills_folder = xdg.BaseDirectory.save_data_path(get_xdg_base() + '/skills')
         makedirs(skills_folder, exist_ok=True)
 
     return path.expanduser(skills_folder)
@@ -109,7 +110,7 @@ def build_msm_config(device_config: dict) -> MsmConfig:
     msm_config = device_config['skills'].get('msm', {})
     msm_repo_config = msm_config.get('repo', {})
     enclosure_config = device_config.get('enclosure', {})
-    data_dir = path.expanduser(device_config.get('data_dir', xdg.BaseDirectory.save_data_path(BASE_FOLDER)))
+    data_dir = path.expanduser(device_config.get('data_dir', xdg.BaseDirectory.save_data_path(get_xdg_base())))
     skills_dir = get_skills_directory(device_config)
     old_skills_dir = path.join(data_dir, msm_config.get('directory', "skills"))
 

mycroft/skills/mycroft_skill/mycroft_skill.py

@@ -33,7 +33,8 @@
 from mycroft.audio import wait_while_speaking
 from ovos_utils.enclosure.api import EnclosureAPI
 from mycroft.gui import SkillGUI
-from mycroft.configuration import Configuration, BASE_FOLDER
+from ovos_utils.configuration import is_using_xdg, get_xdg_base
+from mycroft.configuration import Configuration
 from mycroft.dialog import load_dialogs
 from mycroft.filesystem import FileSystemAccess
 from mycroft.messagebus.message import Message, dig_for_message
@@ -189,15 +190,15 @@ def _init_settings(self):
         # Otherwise save to XDG_CONFIG_DIR
         if not self.settings_write_path.joinpath('settings.json').exists():
             self.settings_write_path = Path(xdg.BaseDirectory.save_config_path(
-                BASE_FOLDER, 'skills', basename(self.root_dir)))
+                get_xdg_base(), 'skills', basename(self.root_dir)))
 
         # To not break existing setups,
         # read from skill directory if the settings file exists there
         settings_read_path = Path(self.root_dir)
 
         # Then, check XDG_CONFIG_DIR
         if not settings_read_path.joinpath('settings.json').exists():
-            for path in xdg.BaseDirectory.load_config_paths(BASE_FOLDER, 'skills',
+            for path in xdg.BaseDirectory.load_config_paths(get_xdg_base(), 'skills',
                                                             basename(self.root_dir)):
                 path = Path(path)
                 # If there is a settings file here, use it