search status overhaul, READMe contributing

- Added contributing section to README.md
- Added number of files to compare
- Duplicated now updates the search status (indicator and menu bar)
- Globalised cache file from path and metadata from cache file operations
- Added new delete cache after two hours option
- Optimised cache deletion
- Changed Inactive to Idle and Searching to Active
- Reload files function now in FF_Menubar.py in prep. for adding it to duplicated
- Fixed loaded search giving search from data instead of cache file path
- Added warning, if cache is set to never
- Added new linux arm build to the workflow

Author: Pixel-Master

FF_Compare.py

@@ -27,7 +27,7 @@
 
 # The window
 class CompareUi:
-    def __init__(self, path_of_first_search, parent):
+    def __init__(self, path_of_first_search, cache_file, parent):
         # Debug
         logging.info("Setting up the Compare_Window")
 
@@ -70,7 +70,7 @@ def __init__(self, path_of_first_search, parent):
 
         # Setting up the menu bar...
         menu_bar = FF_Menubar.MenuBar(parent=self.Compare_Window, window="compare",
-                                      listbox=None)
+                                      listbox=None, cache_file_path=cache_file)
         logging.debug("Done building MenuBar\n")
 
         # Set up both list-boxes
@@ -110,13 +110,15 @@ def __init__(self, path_of_first_search, parent):
         # Labels
         # Added files
         self.added_files_label1, self.added_files_label2 = self.generate_title_label(
-            text="Added Files", text2=path_of_first_search, color=FF_Files.GREEN_COLOR)
+            text="Added Files", text2=path_of_first_search, color=FF_Files.GREEN_COLOR,
+            length_of_list=len(compared_searches.files_only_in_first_search))
         self.Compare_Layout.addWidget(self.added_files_label1, 0, 0)
         self.Compare_Layout.addWidget(self.added_files_label2, 1, 0)
 
         # Removed files
         self.removed_files_label1, self.removed_files_label2 = self.generate_title_label(
-            text="Removed Files", text2=compared_searches.path_of_second_search[0], color=FF_Files.RED_COLOR)
+            text="Removed Files", text2=compared_searches.path_of_second_search[0], color=FF_Files.RED_COLOR,
+        length_of_list=len(compared_searches.files_only_in_second_search))
         self.Compare_Layout.addWidget(self.removed_files_label1, 0, 1)
         self.Compare_Layout.addWidget(self.removed_files_label2, 1, 1)
 
@@ -160,7 +162,7 @@ def generate_button(self, text, command, icon=None):
         return button
 
     # Function for generating the added / removed files labels
-    def generate_title_label(self, text, text2, color) -> tuple[QLabel, QLabel]:
+    def generate_title_label(self, text, text2, color, length_of_list) -> tuple[QLabel, QLabel]:
         # Label 1
         label1 = QLabel(self.Compare_Window)
 
@@ -182,7 +184,7 @@ def generate_title_label(self, text, text2, color) -> tuple[QLabel, QLabel]:
 
         # Shorten the text string to only include the first to the 30th
         # and the last ten character if the string is longer then 43 characters
-        text2_shortened = f"Files only in:\n{FF_Files.display_path(text2)}"
+        text2_shortened = f"{length_of_list} files only in:\n{FF_Files.display_path(text2)}"
         # Set the label to the shortened string
         label2.setText(text2_shortened)
 
@@ -196,7 +198,7 @@ def generate_title_label(self, text, text2, color) -> tuple[QLabel, QLabel]:
 
 # The engine
 class CompareSearches:
-    def __init__(self, files_of_first_search: list, path_of_first_search, parent):
+    def __init__(self, files_of_first_search: list, path_of_first_search, cache_file, parent):
         # Debug
         logging.debug("User pressed Compare Search")
 
@@ -207,7 +209,7 @@ class SignalsClass(QObject):
 
             self.signals = SignalsClass()
             # Connecting the signal to the user-interface class
-            self.signals.finished.connect(lambda: CompareUi(path_of_first_search, parent))
+            self.signals.finished.connect(lambda: CompareUi(path_of_first_search, cache_file, parent))
 
             # Thread
             comparing_thread = QThreadPool(parent)

FF_Duplicated.py

@@ -12,6 +12,7 @@
 import logging
 import os
 from sys import platform
+from json import load
 from time import perf_counter, time, ctime
 import difflib
 import gc
@@ -25,6 +26,7 @@
 from PySide6.QtGui import QFont, QAction
 
 # Projects Libraries
+import FF_Main_UI
 import FF_Menubar
 import FF_Additional_UI
 import FF_Files
@@ -36,7 +38,7 @@
 
 
 class DuplicatedSettings:
-    def __init__(self, parent, search_path, matched_list):
+    def __init__(self, parent, search_path, matched_list, cache_file):
         # Debug
         logging.info("Setting up Duplicated UI...")
 
@@ -193,8 +195,16 @@ def store_value():
         self.button_box = QDialogButtonBox(parent=self.Duplicated_Settings)
         self.button_box.setStandardButtons(QDialogButtonBox.StandardButton.Cancel | QDialogButtonBox.StandardButton.Ok)
 
+
         # Connect events
         def start_duplicated():
+            # Update search status label
+            FF_Search.ACTIVE_SEARCH_THREADS += 1
+            FF_Main_UI.MainWindow.update_search_status_label()
+            # Initialising the ui logger
+            self.ui_logger = FF_Main_UI.SearchUpdate(search_path)
+            # Update the logger
+            self.ui_logger.update("Finding duplicated files...")
 
             # Default criteria
             criteria = {
@@ -210,7 +220,7 @@ def start_duplicated():
             class Events(QObject):
                 finished = Signal()
 
-            finished_event_class = Events()
+            self.event_class = Events()
 
             if self.mode_selector_combobox.currentText() == self.duplicated_mode_display_name_dict["name"]:
                 criteria["name"]["activated"] = True
@@ -219,17 +229,26 @@ class Events(QObject):
             elif self.mode_selector_combobox.currentText() == self.duplicated_mode_display_name_dict["content"]:
                 criteria["content"]["activated"] = True
 
+            # Connect UI to finished signal
+            self.event_class.finished.connect(
+                lambda: DuplicatedUI(
+                    parent, search_path, criteria, duplicated_dict, duplicated_parent_file_path_dict, time_dict,
+                    cache_file))
+
+            self.event_class.finished.connect(
+                lambda: logging.debug("Received finish finish signal"))
+
+            # Closing the menu bar logger
+            self.event_class.finished.connect(self.ui_logger.close)
+
             # Starting Thread
             QThreadPool(self.Duplicated_Settings).start(
                 lambda: FindDuplicated(
                     criteria=criteria,
                     matched_list=matched_list,
-                    finished_signal=finished_event_class))
+                    signals=self.event_class))
+
 
-            # Connect UI to finished signal
-            finished_event_class.finished.connect(
-                lambda: DuplicatedUI(
-                    parent, search_path, criteria, duplicated_dict, duplicated_parent_file_path_dict, time_dict))
 
         # Launch search algorithm
         self.button_box.button(
@@ -286,7 +305,7 @@ def __init__(
             self,
             parent,
             match_path,
-            criteria, matched_dict: dict, matched_parent_file_path_dict: dict, time_needed_dict: dict):
+            criteria, matched_dict: dict, matched_parent_file_path_dict: dict, time_needed_dict: dict, cache_file: str):
         # Debug
         logging.info("Setting up Duplicated UI...")
         # Saving time
@@ -420,7 +439,8 @@ def __init__(
 
         # Setup menu bar
         menu_bar = FF_Menubar.MenuBar(
-            parent=self.Duplicated_Window, window="duplicated", listbox=self.Duplicated_Tree, search_path=match_path)
+            parent=self.Duplicated_Window, window="duplicated", listbox=self.Duplicated_Tree, search_path=match_path,
+            cache_file_path=cache_file)
 
         # If item is double-clicked
         def open_double_clicked(item):
@@ -509,6 +529,11 @@ def show_time_stats():
             # Debug
             logging.debug("Displaying time stats.")
 
+            # Getting the creation time of the cache file which is stored separately
+            with open(FF_Files.get_metadata_file_from_cache_file(cache_file)) as time_file:
+                # Load time
+                cache_created_time = ctime(load(time_file)["c_time"])
+
             # Displaying infobox with time info
             FF_Additional_UI.PopUps.show_info_messagebox(
                 "Time Stats",
@@ -520,20 +545,26 @@ def show_time_stats():
                 f"Total: {round(time_needed_dict['time_after_building_ui'] - time_needed_dict['start_time'], 3)}s\n\n\n"
                 ""
                 f"Timestamps:\n"
-                f"Search opened: {ctime(time_stamp)}s",
-                self.Duplicated_Window)
+                f"Cache (basis for search results) created:\n{cache_created_time}\n"
+                f"Window opened:\n{ctime(time_stamp)}s",
+                large=True,
+                parent=self.Duplicated_Window)
 
         # Optimize label
         total_time = time_needed_dict["time_after_building_ui"] - time_needed_dict["start_time"]
         time_text.setText(f"Time needed: {round(total_time, 3)}s")
 
+        # Update search status label
+        FF_Search.ACTIVE_SEARCH_THREADS -= 1
+        FF_Main_UI.MainWindow.update_search_status_label()
+
         # Collect garbage
         gc.collect()
 
 
 # Algorithms to find duplicated files
 class FindDuplicated:
-    def __init__(self, criteria: dict, matched_list, finished_signal):
+    def __init__(self, criteria: dict, matched_list, signals):
         # Debug
         logging.info("Searching for duplicated files...")
         logging.info(f"{criteria=}")
@@ -817,9 +848,10 @@ def __init__(self, criteria: dict, matched_list, finished_signal):
                 # Finalize
                 duplicated_parent_file_path_dict = duplicated_size_parent_file_path_dict
                 duplicated_dict = duplicated_size_dict
-
+        # Debug
+        logging.info("Finished grouping, launching UI...")
         # Launch UI
-        finished_signal.finished.emit()
+        signals.finished.emit()
 
         gc.collect()
 

FF_Files.py

@@ -139,9 +139,15 @@ def path_to_cache_file(path, metadata=False):
         logging.fatal("Wrong arguments used with the convert_path_to_cache_file() function in FF_Files.py")
 
 
+# Takes a path to a cache file and returns the path to the metadata file
+def get_metadata_file_from_cache_file(cache_file):
+    return CACHE_METADATA_FOLDER + (cache_file.removeprefix(CACHED_SEARCHES_FOLDER))
+
+
 # Test if Cache should be deleted
 def cache_test(is_launching):
     logging.debug("Testing if cache should be deleted..")
+    allowed_time_difference = None
 
     # Loading Settings File
     with open(os.path.join(FF_LIB_FOLDER, "Settings")) as settings_file:
@@ -154,43 +160,38 @@ def cache_test(is_launching):
         logging.debug("Deleting Cache!")
         remove_cache()
 
+    elif cache_settings.lower() == "after two hours":
+        # Two hours are 7'200 seconds
+        allowed_time_difference = 7200
+
     # Deleting Cache after a Day
     elif cache_settings == "after a Day":
-
-        # Looping through every file in CACHED_SEARCHES_FOLDER and getting separately stored creation tie
-        # Iterating through all files in the cache folder
-        for file in os.listdir(CACHED_SEARCHES_FOLDER):
-            try:
-                with open(os.path.join(CACHE_METADATA_FOLDER, file)) as time_file:
-                    # Load creation time
-                    cache_created_time = load(time_file)["c_time"]
-            except JSONDecodeError:
-                continue
-
-            if cache_created_time < time() - SECONDS_OF_A_WEEK:
-                logging.debug(f"Deleting Cache for dir: {file} because it's older than a week")
-                os.remove(os.path.join(CACHED_SEARCHES_FOLDER, file))
+        allowed_time_difference = SECONDS_OF_A_DAY
 
     # Deleting Cache after a Week
     elif cache_settings == "after a Week":
+        allowed_time_difference = SECONDS_OF_A_WEEK
+
+    # Skipping
+    else:
+        logging.debug("Skipping deleting...")
 
+    if cache_settings.lower() in ("after a Week", "after a Day", "after two hours"):
         # Looping through every file in CACHED_SEARCHES_FOLDER and getting separately stored creation tie
         # Iterating through all files in the cache folder
         for file in os.listdir(CACHED_SEARCHES_FOLDER):
             try:
-                with open(os.path.join(CACHE_METADATA_FOLDER, file), "w") as time_file:
-                    # Load time
+                with open(os.path.join(CACHE_METADATA_FOLDER, file)) as time_file:
+                    # Load creation time
                     cache_created_time = load(time_file)["c_time"]
             except JSONDecodeError:
                 continue
 
-            if cache_created_time < time() - SECONDS_OF_A_DAY:
-                logging.debug(f"Deleting Cache for dir: {file} because it's older than a week")
+            if cache_created_time < time() - allowed_time_difference:
+                logging.debug(f"Deleting Cache for dir: {file} because it's older than the allowed time difference,"
+                              f" {allowed_time_difference=}sec.")
                 os.remove(os.path.join(CACHED_SEARCHES_FOLDER, file))
 
-    # Skipping
-    else:
-        logging.debug("Skipping deleting...")
 
     logging.debug("Finished Cache Testing!\n")
 

FF_Main_UI.py

@@ -1035,7 +1035,7 @@ def export_filters(self):
             return
 
         # Debug
-        logging.info(f"Exporting all filters to {export_path}, with {FF_Files.FF_FILTER_VERSION = }...")
+        logging.info(f"Exporting all filters to {export_path}, with {FF_Files.FF_FILTER_VERSION=}...")
         # Making user folder compatible
         directory = self.edit_directory.text()
         directory = directory.replace(FF_Files.USER_FOLDER, "USER_FOLDER")
@@ -1276,7 +1276,7 @@ def update_search_status_label(ui_building=False):
         logging.debug(f"Updating search status label, active searches: {FF_Search.ACTIVE_SEARCH_THREADS}")
         # If there are no active searches
         if FF_Search.ACTIVE_SEARCH_THREADS == 0:
-            search_status_label.setText("Inactive")
+            search_status_label.setText("Idle")
             search_status_label.setStyleSheet(f"color: {FF_Files.GREEN_COLOR};")
             search_status_label.adjustSize()
 
@@ -1286,7 +1286,7 @@ def update_search_status_label(ui_building=False):
 
         # If there are ongoing searches updating label
         else:
-            search_status_label.setText(f"Searching ({FF_Search.ACTIVE_SEARCH_THREADS}) ...")
+            search_status_label.setText(f"Active ({FF_Search.ACTIVE_SEARCH_THREADS}) ...")
             search_status_label.setStyleSheet(f"color: {FF_Files.RED_COLOR};")
             search_status_label.adjustSize()
 
@@ -1326,4 +1326,5 @@ def close(self):
         self.search_status_menu.removeAction(self.search_status)
         self.search_status_menu.removeAction(self.search_path)
 
+
 global menu_bar_icon_menu, search_status_menu, menu_bar_icon, search_status_label