refactor: inline config file handling into Config

Author: deltragon

safeeyes/configuration.py

@@ -22,7 +22,10 @@
 """
 
 import copy
+import logging
 from packaging.version import parse
+import os
+import shutil
 import typing
 
 from safeeyes import utility
@@ -44,11 +47,11 @@ def load(cls) -> "Config":
         force_upgrade_keys: list[str] = []
         # force_upgrade_keys = ['long_breaks', 'short_breaks']
 
-        # if create_startup_entry finds a broken autostart symlink, it will repair
+        # if _create_startup_entry finds a broken autostart symlink, it will repair
         # it
-        utility.create_startup_entry(force=False)
+        cls._create_startup_entry(force=False)
         if user_config is None:
-            utility.initialize_safeeyes()
+            cls._initialize_config()
             user_config = copy.deepcopy(system_config)
             cfg = cls(user_config, system_config)
             cfg.save()
@@ -126,3 +129,86 @@ def __eq__(self, config):
 
     def __ne__(self, config):
         return self.__user_config != config.__user_config
+
+    @classmethod
+    def reset_config(cls) -> None:
+        # Remove the ~/.config/safeeyes/safeeyes.json and safeeyes_style.css
+        utility.delete(utility.CONFIG_FILE_PATH)
+
+        # Copy the safeeyes.json and safeeyes_style.css
+        shutil.copy2(utility.SYSTEM_CONFIG_FILE_PATH, utility.CONFIG_FILE_PATH)
+
+        # Add write permission (e.g. if original file was stored in /nix/store)
+        os.chmod(utility.CONFIG_FILE_PATH, 0o600)
+
+        cls._create_startup_entry()
+
+    @classmethod
+    def _initialize_config(cls) -> None:
+        """Create the config file in XDG_CONFIG_HOME(or
+        ~/.config)/safeeyes directory.
+        """
+        logging.info("Copy the config files to XDG_CONFIG_HOME(or ~/.config)/safeeyes")
+
+        # Remove the ~/.config/safeeyes/safeeyes.json file
+        utility.delete(utility.CONFIG_FILE_PATH)
+
+        if not os.path.isdir(utility.CONFIG_DIRECTORY):
+            utility.mkdir(utility.CONFIG_DIRECTORY)
+
+        # Copy the safeeyes.json
+        shutil.copy2(utility.SYSTEM_CONFIG_FILE_PATH, utility.CONFIG_FILE_PATH)
+        os.chmod(utility.CONFIG_FILE_PATH, 0o600)
+
+        # This method gets called when the configuration file is not present,
+        # which happens just after installation or manual deletion of
+        # .config/safeeyes/safeeyes.json file. In these cases, we want to force the
+        # creation of a startup entry
+        cls._create_startup_entry(force=True)
+
+    @classmethod
+    def _create_startup_entry(cls, force: bool = False) -> None:
+        """Create start up entry."""
+        startup_dir_path = os.path.join(utility.HOME_DIRECTORY, ".config/autostart")
+        startup_entry = os.path.join(
+            startup_dir_path, "io.github.slgobinath.SafeEyes.desktop"
+        )
+        # until Safe Eyes 2.1.5 the startup entry had another name
+        # https://github.com/slgobinath/safeeyes/commit/684d16265a48794bb3fd670da67283fe4e2f591b#diff-0863348c2143a4928518a4d3661f150ba86d042bf5320b462ea2e960c36ed275L398
+        obsolete_entry = os.path.join(startup_dir_path, "safeeyes.desktop")
+
+        create_link = False
+
+        if force:
+            # if force is True, just create the link
+            create_link = True
+        else:
+            # if force is False, we want to avoid creating the startup symlink if it was
+            # manually deleted by the user, we want to create it only if a broken one is
+            # found
+            if os.path.islink(startup_entry):
+                # if the link exists, check if it is broken
+                try:
+                    os.stat(startup_entry)
+                except FileNotFoundError:
+                    # a FileNotFoundError will get thrown if the startup symlink is
+                    # broken
+                    create_link = True
+
+            if os.path.islink(obsolete_entry):
+                # if a link with the old naming exists, delete it and create a new one
+                create_link = True
+                utility.delete(obsolete_entry)
+
+        if create_link:
+            # Create the folder if not exist
+            utility.mkdir(startup_dir_path)
+
+            # Remove existing files
+            utility.delete(startup_entry)
+
+            # Create the new startup entry
+            try:
+                os.symlink(utility.SYSTEM_DESKTOP_FILE, startup_entry)
+            except OSError:
+                logging.error("Failed to create startup entry at %s" % startup_entry)

safeeyes/ui/settings_dialog.py

@@ -172,7 +172,7 @@ def on_reset_menu_clicked(self, button: Gtk.Button) -> None:
         def __confirmation_dialog_response(dialog, result) -> None:
             response_id = dialog.choose_finish(result)
             if response_id == 1:
-                utility.reset_config()
+                Config.reset_config()
                 self.config = Config.load()
                 # Remove breaks from the container
                 self.__clear_children(self.box_short_breaks)

safeeyes/utility.py

@@ -415,29 +415,6 @@ def load_css_file(style_sheet_path, priority, required=True):
     Gtk.StyleContext.add_provider_for_display(display, css_provider, priority)
 
 
-def initialize_safeeyes():
-    """Create the config file in XDG_CONFIG_HOME(or
-    ~/.config)/safeeyes directory.
-    """
-    logging.info("Copy the config files to XDG_CONFIG_HOME(or ~/.config)/safeeyes")
-
-    # Remove the ~/.config/safeeyes/safeeyes.json file
-    delete(CONFIG_FILE_PATH)
-
-    if not os.path.isdir(CONFIG_DIRECTORY):
-        mkdir(CONFIG_DIRECTORY)
-
-    # Copy the safeeyes.json
-    shutil.copy2(SYSTEM_CONFIG_FILE_PATH, CONFIG_FILE_PATH)
-    os.chmod(CONFIG_FILE_PATH, 0o600)
-
-    # initialize_safeeyes gets called when the configuration file is not present, which
-    # happens just after installation or manual deletion of
-    # .config/safeeyes/safeeyes.json file. In these cases, we want to force the creation
-    # of a startup entry
-    create_startup_entry(force=True)
-
-
 def cleanup_old_user_stylesheet():
     # Create the XDG_CONFIG_HOME(or ~/.config)/safeeyes/style directory
     if not os.path.isdir(STYLE_SHEET_DIRECTORY):
@@ -474,52 +451,6 @@ def cleanup_old_user_stylesheet():
             )
 
 
-def create_startup_entry(force=False):
-    """Create start up entry."""
-    startup_dir_path = os.path.join(HOME_DIRECTORY, ".config/autostart")
-    startup_entry = os.path.join(
-        startup_dir_path, "io.github.slgobinath.SafeEyes.desktop"
-    )
-    # until Safe Eyes 2.1.5 the startup entry had another name
-    # https://github.com/slgobinath/safeeyes/commit/684d16265a48794bb3fd670da67283fe4e2f591b#diff-0863348c2143a4928518a4d3661f150ba86d042bf5320b462ea2e960c36ed275L398
-    obsolete_entry = os.path.join(startup_dir_path, "safeeyes.desktop")
-
-    create_link = False
-
-    if force:
-        # if force is True, just create the link
-        create_link = True
-    else:
-        # if force is False, we want to avoid creating the startup symlink if it was
-        # manually deleted by the user, we want to create it only if a broken one is
-        # found
-        if os.path.islink(startup_entry):
-            # if the link exists, check if it is broken
-            try:
-                os.stat(startup_entry)
-            except FileNotFoundError:
-                # a FileNotFoundError will get thrown if the startup symlink is broken
-                create_link = True
-
-        if os.path.islink(obsolete_entry):
-            # if a link with the old naming exists, delete it and create a new one
-            create_link = True
-            delete(obsolete_entry)
-
-    if create_link:
-        # Create the folder if not exist
-        mkdir(startup_dir_path)
-
-        # Remove existing files
-        delete(startup_entry)
-
-        # Create the new startup entry
-        try:
-            os.symlink(SYSTEM_DESKTOP_FILE, startup_entry)
-        except OSError:
-            logging.error("Failed to create startup entry at %s" % startup_entry)
-
-
 def initialize_platform():
     """Copy icons and generate desktop entries."""
     logging.debug("Initialize the platform")
@@ -589,19 +520,6 @@ def initialize_platform():
                 logging.error("Failed to create icon link at %s" % local_icon)
 
 
-def reset_config():
-    # Remove the ~/.config/safeeyes/safeeyes.json and safeeyes_style.css
-    delete(CONFIG_FILE_PATH)
-
-    # Copy the safeeyes.json and safeeyes_style.css
-    shutil.copy2(SYSTEM_CONFIG_FILE_PATH, CONFIG_FILE_PATH)
-
-    # Add write permission (e.g. if original file was stored in /nix/store)
-    os.chmod(CONFIG_FILE_PATH, 0o600)
-
-    create_startup_entry()
-
-
 def initialize_logging(debug):
     """Initialize the logging framework using the Safe Eyes specific
     configurations.