Cleanup

Author: vikdevelop

src/core/archive.py

@@ -6,6 +6,7 @@
 parser.add_argument("-u", "--unpack", help="Unpack archive", type=str)
 args = parser.parse_args()
 
+# Get password entered in the "Create a new password" dialog from the temporary file
 def get_password():
     temp_file = f"{CACHE}/temp_file"
     if os.path.exists(temp_file):
@@ -14,6 +15,7 @@ def get_password():
     else:
         return None
 
+# Remove above temporary file
 def remove_temp_file():
     try:
         os.remove(f"{CACHE}/temp_file")
@@ -39,8 +41,8 @@ def start_saving(self):
         print("Configuration saved successfully.")
         remove_temp_file()
 
+    # Cleanup the cache dir before saving
     def _cleanup_cache_dir(self):
-        # Cleanup the cache dir before importing
         print("Cleaning up the cache directory")
         save_cache_dir = f"{CACHE}/save_config"
         try:
@@ -50,6 +52,7 @@ def _cleanup_cache_dir(self):
         os.makedirs(save_cache_dir, exist_ok=True)
         os.chdir(save_cache_dir)
 
+    # Copy the configuration folder to the user-defined directory
     def _copy_config_to_folder(self):
         open(f"{CACHE}/save_config/.folder.sd", "w").close()
 
@@ -58,6 +61,7 @@ def _copy_config_to_folder(self):
 
         shutil.move(f"{CACHE}/save_config", f"{args.create}")
 
+    # Create a new ZIP archive with 7-Zip
     def _create_archive(self):
         password = get_password()
         cmd = ['7z', 'a', '-tzip', '-mx=3', '-x!*.zip', '-x!saving_status', 'cfg.sd.zip', '.']
@@ -84,16 +88,6 @@ def start_importing(self):
         self._cleanup_cache_dir()
         self._check_config_type()
 
-        # Check, if the input is folder or not
-        if self.is_folder:
-            self._copy_folder_to_cache()
-        else:
-            if self.import_file.endswith(".sd.zip"):
-                self._unpack_zip_archive()
-
-            elif ".sd.tar.gz" in self.import_file:
-                self._unpack_tar_archive()
-
         self._replace_home_in_files(".", home)
         subprocess.run([sys.executable, "-m", "savedesktop.core.config", "--import_"], check=True, env={**os.environ, "PYTHONPATH": f"{app_prefix}"})
 
@@ -116,15 +110,29 @@ def _cleanup_cache_dir(self):
         # Create a txt file to prevent removing the cache's content after closing the app window
         open("import_status", "w").close()
 
+    # Check, if the input is archive or folder
     def _check_config_type(self):
         if self.import_file.endswith(".sd.zip") or self.import_file.endswith(".sd.tar.gz"):
             self.is_folder = False
         else:
             self.is_folder = True
 
+        # Check, if the input is folder or not
+        if self.is_folder:
+            self._copy_folder_to_cache()
+        else:
+            if self.import_file.endswith(".sd.zip"):
+                self._unpack_zip_archive()
+            elif self.import_file.endswith(".sd.tar.gz"):
+                self._unpack_tar_archive()
+            else:
+                pass
+
+    # Copy the user-defined folder to the cache directory
     def _copy_folder_to_cache(self):
         shutil.copytree(self.import_folder, f"{CACHE}/import_config", dirs_exist_ok=True, ignore_dangling_symlinks=True)
 
+    # Unpack the ZIP archive with 7-Zip
     def _unpack_zip_archive(self):
         password = get_password()
 
@@ -144,6 +152,7 @@ def _unpack_zip_archive(self):
             capture_output=False, text=True, check=True
         )
 
+    # Unpack a legacy archive with Tarball (for backward compatibility)
     def _unpack_tar_archive(self):
         subprocess.run(["tar", "-xzf", self.import_file, "-C", f"{CACHE}/import_config"],capture_output=True, text=True, check=True)
 
@@ -162,6 +171,7 @@ def _replace_home_in_files(self, root, home, patterns=(".xml", ".ini")):
                             f.write(new_text)
                         print(f"Updated /home/$USER path in: {path}")
 
+    # Remove the "import_status" file if the condition is met
     def _remove_status_file(self):
         if all(not os.path.exists(p) for p in [
             f"{CACHE}/import_config/app",

src/core/periodic_saving.py

@@ -18,6 +18,7 @@ class PeriodicBackups:
     def __init__(self):
         self.last_backup_date = self.load_last_backup_date()
 
+    # Load last backup date from the {DATA}/periodic-saving.json file
     def load_last_backup_date(self):
         backup_file = f"{DATA}/periodic-saving.json"
         if os.path.exists(backup_file):
@@ -26,6 +27,8 @@ def load_last_backup_date(self):
             return date.fromisoformat(jp.get("last-saved", "2000-01-01"))
         return date(2000, 1, 1)
 
+    # Start periodic saving without checking last backup date (with --now parameter)
+    # or with checking it
     def run(self, now: bool) -> None:
         self.pbfolder = f'{settings["periodic-saving-folder"].format(download_dir)}'
 
@@ -35,6 +38,7 @@ def run(self, now: bool) -> None:
         else:
             self.get_interval()
 
+    # Get the periodic saving interval from GSettings
     def get_interval(self):
         if settings["periodic-saving"] == 'Never':
             print("Periodic saving is not set up.")
@@ -45,6 +49,7 @@ def get_interval(self):
         elif settings["periodic-saving"] == 'Monthly':
             self.check_and_backup(30)
 
+    # Check the number of days since the last backup
     def check_and_backup(self, interval):
         today = date.today()
         if (today - self.last_backup_date).days >= interval:
@@ -79,6 +84,7 @@ def backup(self):
         self.save_last_backup_date()
         self.config_saved()
 
+    # Get an encrypted password from the {DATA}/password file
     def get_password_from_file(self):
         try:
             ps = PasswordStore()
@@ -91,6 +97,7 @@ def get_password_from_file(self):
            subprocess.run(['7z', 'a', '-tzip', '-mx=6', '-x!*.zip', '-x!saving_status', 'cfg.sd.zip', '.'], check=True)
         shutil.copyfile('cfg.sd.zip', f'{self.pbfolder}/{self.filename}.sd.zip')
 
+    # Save today's date to the {DATA}/periodic-saving.json file
     def save_last_backup_date(self):
         with open(f"{DATA}/periodic-saving.json", "w") as pb:
             json.dump({"last-saved": date.today().isoformat()}, pb)

src/core/synchronization.py

@@ -77,6 +77,7 @@ def download_config(self):
             print("extracting the archive")
             self.get_zip_file_status()
 
+    # Send a notification about the started synchronization
     def _send_notification_at_startup(self):
         orig_str = _("<big><b>Importing configuration …</b></big>\nImporting configuration from:\n<i>{}</i>\n")
         status_str = orig_str

src/core/synchronization_setup.py

@@ -19,7 +19,12 @@ def set_up_auto_mount(mount_type):
 
     if not cfile_subtitle == "none":
         if "gvfs" in cfile_subtitle:
-            pattern = r'.*/gvfs/([^:]*):host=([^,]*),user=([^/]*).*' if "google-drive" in cfile_subtitle else r'.*/gvfs/([^:]+):host=([^,]+),user=([^/]+)' if "onedrive" in cfile_subtitle else r'.*/gvfs/([^:]*):host=([^,]*),ssl=([^,]*),user=([^,]*),prefix=([^/]*).*'
+            if "google-drive" in cfile_subtitle:
+                pattern = r'.*/gvfs/([^:]*):host=([^,]*),user=([^/]*).*'
+            elif "onedrive" in cfile_subtitle:
+                pattern = r'.*/gvfs/([^:]+):host=([^,]+),user=([^/]+)'
+            else:
+                pattern = r'.*/gvfs/([^:]*):host=([^,]*),ssl=([^,]*),user=([^,]*),prefix=([^/]*).*'
 
             match = re.search(pattern, cfile_subtitle)
 

src/globals.py

@@ -10,7 +10,6 @@ def get_app_environment():
     if os.path.exists("/.flatpak-info"):
         return {
             'type': 'flatpak',
-            'home': Path(os.getenv('HOME', Path.home())),
             'run_cmd': 'flatpak run io.github.vikdevelop.SaveDesktop',
             'cache': f'{GLib.get_user_cache_dir()}/tmp',
             'data': f'{GLib.get_user_data_dir()}'
@@ -19,15 +18,14 @@ def get_app_environment():
     else:
         return {
             'type': 'native',
-            'home': Path.home(),
             'run_cmd': 'savedesktop',
             'cache': os.path.join(f'{GLib.get_user_cache_dir()}', 'io.github.vikdevelop.SaveDesktop'),
             'data': os.path.join(f'{GLib.get_user_data_dir()}', 'io.github.vikdevelop.SaveDesktop')
         }
 
 env = get_app_environment()
 
-home = env['home']
+home = Path.home()
 
 # System paths
 download_dir = GLib.get_user_special_dir(GLib.UserDirectory.DIRECTORY_DOWNLOAD)
@@ -40,6 +38,9 @@ def get_app_environment():
 CACHE = env['cache']
 DATA = env['data']
 
+os.makedirs(CACHE, exist_ok=True)
+os.makedirs(DATA, exist_ok=True)
+
 # Commands
 periodic_saving_cmd = f'{env["run_cmd"]} --background'
 sync_cmd = f'{env["run_cmd"]} --sync'

src/gui/more_options_dialog.py

@@ -8,7 +8,8 @@
 class MoreOptionsDialog(Adw.AlertDialog):
     def __init__(self, parent):
         super().__init__()
-        self.parent = parent
+        self.parent = parent # Connect this dialog with MainWindow class
+
         self.set_heading(_("More options"))
 
         # Box for this dialog
@@ -18,6 +19,21 @@ def __init__(self, parent):
         self.set_extra_child(self.msBox)
 
         # Periodic saving section
+        self.load_periodic_saving_section()
+
+        # Manual saving section
+        self.load_manual_saving_section()
+
+        # Call _expand_periodic_row() method to expand "Periodic saving" section
+        self._expand_periodic_row()
+
+        # add response of this dialog
+        self.add_response('cancel', _("Cancel"))
+        self.add_response('ok', _("Apply"))
+        self.set_response_appearance('ok', Adw.ResponseAppearance.SUGGESTED)
+        self.connect('response', self.msDialog_closed)
+
+    def load_periodic_saving_section(self):
         # Expander row for showing options of the periodic saving
         self.periodic_row = Adw.ExpanderRow.new()
         self.periodic_row.set_title(_("Periodic saving"))
@@ -50,7 +66,7 @@ def __init__(self, parent):
         self.filefrmtButton.add_css_class('destructive-action')
         self.filefrmtButton.set_valign(Gtk.Align.CENTER)
         self.filefrmtButton.set_tooltip_text(_("Reset to default"))
-        self.filefrmtButton.connect("clicked", self.reset_fileformat)
+        self.filefrmtButton.connect("clicked", self._reset_fileformat)
 
         # Entry for selecting file name format
         self.filefrmtEntry = Adw.EntryRow.new()
@@ -63,7 +79,7 @@ def __init__(self, parent):
         self.folderButton = Gtk.Button.new_from_icon_name("document-open-symbolic")
         self.folderButton.set_valign(Gtk.Align.CENTER)
         self.folderButton.set_tooltip_text(_("Choose another folder"))
-        self.folderButton.connect("clicked", self.open_file_dialog)
+        self.folderButton.connect("clicked", self._open_file_dialog)
 
         # Adw.ActionRow for showing folder for periodic saving
         self.dirRow = Adw.ActionRow.new()
@@ -87,7 +103,7 @@ def __init__(self, parent):
         self.pswdgenButton.connect("clicked", self._get_generated_password)
         self.cpwdRow.add_suffix(self.pswdgenButton)
 
-        # Manual saving section
+    def load_manual_saving_section(self):
         self.manRow = Adw.ExpanderRow.new()
         self.manRow.set_title(_("Manual saving"))
         self.manRow.set_expanded(True)
@@ -97,7 +113,7 @@ def __init__(self, parent):
         self.encryptSwitch = Gtk.Switch.new()
         self.archSwitch = Gtk.Switch.new()
         self.encryptSwitch.set_valign(Gtk.Align.CENTER)
-        self.encryptSwitch.connect('notify::active', self.set_encryptswitch_sensitivity)
+        self.encryptSwitch.connect('notify::active', self._set_encryptswitch_sensitivity)
         if settings["enable-encryption"] == True:
             self.encryptSwitch.set_active(True)
             self.archSwitch.set_sensitive(False)
@@ -112,7 +128,7 @@ def __init__(self, parent):
 
         # action row and switch for showing the "Save a configuration without creating the archive" option
         self.archSwitch.set_valign(Gtk.Align.CENTER)
-        self.archSwitch.connect('notify::active', self.set_archswitch_sensitivity)
+        self.archSwitch.connect('notify::active', self._set_archswitch_sensitivity)
         if settings["save-without-archive"] == True:
             self.archSwitch.set_active(True)
             self.encryptSwitch.set_sensitive(False)
@@ -123,46 +139,43 @@ def __init__(self, parent):
         self.archRow.set_activatable_widget(self.archSwitch)
         self.manRow.add_row(self.archRow)
 
-        self._expand_periodic_row()
-
-        # add response of this dialog
-        self.add_response('cancel', _("Cancel"))
-        self.add_response('ok', _("Apply"))
-        self.set_response_appearance('ok', Adw.ResponseAppearance.SUGGESTED)
-        self.connect('response', self.msDialog_closed)
-
+    # Get an encrypted password from the {DATA}/password file
     def _get_password_from_file(self):
         if os.path.exists(f"{DATA}/password"):
             p = PasswordStore()
             self.cpwdRow.set_text(p.password)
         else:
             self.cpwdRow.set_text("")
 
+    # Call MainWindow's method (self.parent) to get auto-generated password
     def _get_generated_password(self, w):
         self.password = self.parent._password_generator()
         self.cpwdRow.set_text(self.password)
 
-    def open_file_dialog(self, w):
+    # Open the file chooser dialog for selecting  the periodic saving folder
+    # by calling the MainWindow's method (self.parent)
+    def _open_file_dialog(self, w):
         self.parent.select_pb_folder(w="")
 
-    # reset the file name format entry to the default value
-    def reset_fileformat(self, w):
+    # Reset the file name format entry to the default value
+    def _reset_fileformat(self, w):
         self.filefrmtEntry.set_text("Latest_configuration")
 
-    # set sensitivity of the encryptSwitch
-    def set_encryptswitch_sensitivity(self, GParamBoolean, encryptSwitch):
+    # Set sensitivity of the encryptSwitch
+    def _set_encryptswitch_sensitivity(self, GParamBoolean, encryptSwitch):
         if self.encryptSwitch.get_active():
             self.archSwitch.set_sensitive(False)
         else:
             self.archSwitch.set_sensitive(True)
 
-    # set sensitivity of the archSwitch
-    def set_archswitch_sensitivity(self, GParamBoolean, archSwitch):
+    # Set sensitivity of the archSwitch
+    def _set_archswitch_sensitivity(self, GParamBoolean, archSwitch):
         if self.archSwitch.get_active():
             self.encryptSwitch.set_sensitive(False)
         else:
             self.encryptSwitch.set_sensitive(True)
 
+    # Expand "Periodic saving" row if the below file exists
     def _expand_periodic_row(self):
         if os.path.exists(f"{CACHE}/expand_pb_row"):
             self.periodic_row.set_expanded(True)
@@ -206,6 +219,8 @@ def _save_password(self):
             except:
                 pass
 
+    # Open the "Set up the sync file" dialog after clicking on the Apply button
+    # in this dialog, if the below file exists
     def _call_set_dialog(self):
         if os.path.exists(f"{CACHE}/expand_pb_row"):
             self.parent._open_SetDialog()

src/gui/password_checker.py

@@ -65,6 +65,7 @@ def __init__(self, *args, **kwargs):
         self.applyButton.set_sensitive(False)
         self.winBox.append(self.applyButton)
 
+    # Set sensitivity of the Apply button based on the Password entry status
     def _empty_check(self, passEntry):
         if self.passEntry.get_text() == "":
             self.applyButton.set_sensitive(False)
@@ -86,7 +87,7 @@ def __init__(self, **kwargs):
                          application_id="io.github.vikdevelop.SaveDesktop")
         self.connect('activate', self.on_activate)
 
-    # Show the main window of the application
+    # Show the app window
     def on_activate(self, app):
         self.win = PasswordWindow(application=app)
         self.win.present()