Refactor for Task Scheduler autostart and update checks

- Implement Task Scheduler for autostart management.
- Conduct general code refactoring.
- Add update checking functionality.

Author: SystemXFiles

.gitignore

@@ -163,8 +163,9 @@ cython_debug/
 /downloads_for_van/
 /dist/
 /config.json
-/config/config.json
+/config_build/config.json
 /logging.txt
 
 /pg.lock
 /sandbox.py
+/versionfile.txt

build_portable.py

@@ -1,14 +1,58 @@
+import glob
+import os
+import shutil
+
 import PyInstaller.__main__
+import pyinstaller_versionfile
+
+from constants.any import CONFIG_FILE_NAME
+from constants.app_info import APP_NAME, APP_VERSION, APP_AUTHOR, APP_NAME_WITH_VERSION
+
+# Setting paths and configuration parameters
+VERSION_FILE = "versionfile.txt"
+DIST = os.path.join(os.getcwd(), 'dist')
+APP_DIST = os.path.join(DIST, APP_NAME)
+APP_DIST_WITH_VERSION = os.path.join(DIST, APP_NAME_WITH_VERSION)
+CONFIG_FILE_FOR_TESTS = os.path.join(os.getcwd(), CONFIG_FILE_NAME)
+CONFIG_FILE_IN_APP_DIST = os.path.join(APP_DIST, CONFIG_FILE_NAME)
+SPEC_FILES = r".\*.spec"
+
+# Deleting existing .spec files to clean up the directory
+for filename in glob.glob(SPEC_FILES):
+    os.remove(filename)
 
+# Creating a version file for the executable
+pyinstaller_versionfile.create_versionfile(
+    output_file=VERSION_FILE,
+    version=APP_VERSION,
+    company_name=APP_AUTHOR,
+    file_description=APP_NAME,
+    internal_name=APP_NAME,
+    legal_copyright=f"© {APP_AUTHOR}",
+    original_filename=f"{APP_NAME}.exe",
+    product_name=APP_NAME
+)
+
+# Running PyInstaller to build the application
 PyInstaller.__main__.run([
-    'process-governor.py',
-    '--noconfirm',
-    '--onedir',
-    '--uac-admin',
-    '--hide-console', 'hide-early',
-    '--add-data', './resources/*;./resources',
-    '--contents-directory', 'scripts',
-    '--icon', 'resources/app.ico',
-    '--name', 'Process Governor',
-    '--debug', 'noarchive',
-])
+    'process-governor.py',                      # Source script file
+    '--clean',                                  # Clean previous builds
+    '--noconfirm',                              # No confirmation when deleting dist directory
+    '--onedir',                                 # Build the app in one directory
+    '--uac-admin',                              # Request admin rights on launch
+    '--hide-console', 'hide-early',             # Hide the console on startup
+    '--add-data', './resources/*;./resources',  # Add additional resources
+    '--contents-directory', 'scripts',          # Directory for Python and app scripts in the built package
+    '--icon', 'resources/app.ico',              # Application icon
+    '--debug', 'noarchive',                     # Disables bundling of application scripts inside the exe
+    '--name', APP_NAME,                         # Name of the executable file
+    '--version-file', VERSION_FILE,             # Path to the version file
+    '--distpath', DIST,                         # Directory to save the built application
+])
+
+# Creating an archive of the built application
+shutil.make_archive(APP_DIST_WITH_VERSION, 'zip', APP_DIST)
+
+# Copying the configuration file for tests into the built application
+if os.path.isfile(CONFIG_FILE_FOR_TESTS):
+    shutil.copyfile(CONFIG_FILE_FOR_TESTS, CONFIG_FILE_IN_APP_DIST)

config/create_config.py config_build/create_config.pyconfig/create_config.py renamed to config_build/create_config.py

@@ -1,4 +1,4 @@
-from psutil._pswindows import Priority, IOPriority
+from psutil._pswindows import Priority
 
 from configuration.rule import Rule
 from service.config_service import ConfigService
@@ -51,4 +51,3 @@
     ]
 
     ConfigService.save_config(config)
-

config/create_example_config.py config_build/create_example_config.pyconfig/create_example_config.py renamed to config_build/create_example_config.py

@@ -3,18 +3,19 @@
 
 import pyuac
 
+from constants.app_info import APP_NAME, APP_NAME_WITH_VERSION
 from main_loop import start_app
 from util.lock_instance import create_lock_file, remove_lock_file
-from util.messages import show_info, show_error
+from util.messages import show_error
 
 if __name__ == "__main__":
     if not platform.system() == "Windows":
-        print("Process Governor is intended to run on Windows only.")
+        print(f"{APP_NAME} is intended to run on Windows only.")
         sys.exit(1)
 
     if not pyuac.isUserAdmin():
         show_error(
-            "Process Governor",
+            APP_NAME_WITH_VERSION,
             "This program requires administrator privileges to run.\n"
             "Please run the program as an administrator to ensure proper functionality."
         )

config/create_tutorial_config.py config_build/create_tutorial_config.pyconfig/create_tutorial_config.py renamed to config_build/create_tutorial_config.py

@@ -1,4 +1,6 @@
 @echo off
-REM Workaround for start with UAC
-start "" "%~1"
+set "exe_path=%~1"
+set "working_directory=%~dp1"
+cd /d "%working_directory%"
+start /B "" "%exe_path%"
 exit

process-governor.py

@@ -8,7 +8,7 @@
 
 class Config(BaseModel):
     """
-    The Config class represents a configuration object for Process Governor.
+    The Config class represents a configuration object for application.
 
     It defines the structure of the configuration, including rule application interval, logging settings, and rules.
     """
@@ -19,13 +19,13 @@ class Config(BaseModel):
     Default is 1 second.
     """
 
-    logging: Logs = Field(default_factory=Logs)
+    logging: Logs = Field(default_factory=Logs, )
     """
-    An instance of the Logs class that defines logging settings for Process Governor.
+    An instance of the Logs class that defines logging settings for application.
     Default settings are provided by the Logs class.
     """
 
     rules: List[Rule] = Field(default_factory=list)
     """
-    A list of Rule objects that specify how Process Governor manages processes and services based on user-defined rules.
+    A list of Rule objects that specify how application manages processes and services based on user-defined rules.
     """

requirements.txt

@@ -2,44 +2,18 @@
 from pydantic import BeforeValidator, PlainSerializer, WithJsonSchema
 from typing_extensions import Annotated
 
-__iopriority_to_str_mapping = {
-    IOPriority.IOPRIO_VERYLOW: 'VeryLow',
-    IOPriority.IOPRIO_LOW: 'Low',
-    IOPriority.IOPRIO_NORMAL: 'Normal',
-    IOPriority.IOPRIO_HIGH: 'High',
-}
-
-__str_to_iopriority_mapping = {
-    'VeryLow': IOPriority.IOPRIO_VERYLOW,
-    'Low': IOPriority.IOPRIO_LOW,
-    'Normal': IOPriority.IOPRIO_NORMAL,
-    'High': IOPriority.IOPRIO_HIGH,
-}
+from constants.priority_mappings import iopriority_to_str, str_to_iopriority
 
 
 def __to_enum(value):
     if isinstance(value, IOPriority):
         return value
-    return __str_to_iopriority_mapping.get(value)
+    return str_to_iopriority[value]
 
 
 IOPriorityStr = Annotated[
     IOPriority,
     BeforeValidator(__to_enum),
-    PlainSerializer(lambda value: __iopriority_to_str_mapping.get(value), return_type=str),
+    PlainSerializer(lambda value: iopriority_to_str[value], return_type=str),
     WithJsonSchema({'type': 'string'}, mode='serialization'),
 ]
-
-
-def iopriority_to_str(value: IOPriority):
-    """
-    Convert a IO priority value to its corresponding string representation.
-
-    Args:
-        value (int): The IO priority value to convert.
-
-    Returns:
-        str: The string representation of the IO priority value, or None if no
-            mapping is found.
-    """
-    return __iopriority_to_str_mapping.get(value)