added logfile (clears at 300 lines)

Author: wrecks-code

smct/config.py

@@ -4,9 +4,10 @@
 import requests
 
 from smct import paths, registry, ui
+from smct.logger import log
 
 # config.ini structure
-_ENCODING = "utf-8"
+ENCODING = "utf-8"
 
 _SETTINGS_SECTION = "Settings"
 
@@ -22,22 +23,26 @@
 def _check_for_missing_files():
     if not os.path.exists(paths.ASSETS_DIR_PATH):
         os.mkdir(paths.ASSETS_DIR_PATH)
+        log(f"Creating assets directory: {paths.ASSETS_DIR_PATH}")
 
     # Check for Icons
-    # ! maybe send error message here?
     if not os.path.exists(paths.ASSETS_ICO_PATH):
+        log(f"{paths.ASSETS_ICO_PATH} not found! Downloading...")
         download_assets_file(os.path.basename(paths.ASSETS_ICO_PATH))
         # sys.exit(1)
     if not os.path.exists(paths.ASSETS_ICON_ENABLED_PATH):
+        log(f"{paths.ASSETS_ICON_ENABLED_PATH} not found! Downloading...")
         download_assets_file(os.path.basename(paths.ASSETS_ICON_ENABLED_PATH))
         # sys.exit(1)
     if not os.path.exists(paths.ASSETS_ICON_DISABLED_PATH):
+        log(f"{paths.ASSETS_ICON_DISABLED_PATH} not found! Downloading...")
         download_assets_file(os.path.basename(paths.ASSETS_ICON_DISABLED_PATH))
         # sys.exit(1)
 
     # Check for temp folder
     if not os.path.exists(paths.MMT_DIR_PATH):
         os.makedirs(paths.MMT_DIR_PATH)
+        log(f"Creating {paths.MMT_DIR_PATH}")
 
 
 def download_assets_file(image_name):
@@ -50,10 +55,13 @@ def download_assets_file(image_name):
         with open(os.path.join(paths.ASSETS_DIR_PATH, filename), "wb") as f:
             for chunk in response.iter_content(1024):
                 f.write(chunk)
+    else:
+        log(f"Error occurred while downloading {image_name}: {response.status_code}")
 
 
 def init_config():
     if not os.path.exists(paths.CONFIG_PATH):
+        log("config.ini not found, creating default config")
         _create_default_config_file()
 
     _check_for_missing_files()
@@ -74,6 +82,7 @@ def get_mmt_path_value():
 
 
 def set_mmt_path_value(_value):
+    log(f"Config.ini - Setting mmt_path to {_value}")
     _configparser[_SETTINGS_SECTION][_MMT_PATH_KEY] = _value
     _write_to_config()
 
@@ -84,6 +93,7 @@ def get_monitor_name_value():
 
 
 def set_monitor_name_value(_value):
+    log(f"Config.ini - Setting monitor_name to {_value}")
     _configparser[_SETTINGS_SECTION][_MONITOR_NAME_KEY] = _value
     _write_to_config()
 
@@ -94,6 +104,7 @@ def get_monitor_serial_value():
 
 
 def set_monitor_serial_value(_value):
+    log(f"Config.ini - Setting monitor_serial to {_value}")
     _configparser[_SETTINGS_SECTION][_MONITOR_SERIAL_KEY] = _value
     _write_to_config()
 
@@ -105,6 +116,7 @@ def get_start_with_windows_value():
 
 def set_start_with_windows_value(_value):
     value_str = "yes" if _value else "no"
+    log(f"Config.ini - Setting start_with_windows to {value_str}")
     _configparser[_SETTINGS_SECTION][_START_WITH_WINDOWS_KEY] = value_str
     _write_to_config()
 
@@ -116,16 +128,17 @@ def get_first_start_value():
 
 def set_first_start_value(_value):
     value_str = "yes" if _value else "no"
+    log(f"Config.ini - Setting first_start to {value_str}")
     _configparser[_SETTINGS_SECTION][_FIRST_START_KEY] = value_str
     _write_to_config()
 
 
 def _read_from_config():
-    _configparser.read(paths.CONFIG_PATH, encoding=_ENCODING)
+    _configparser.read(paths.CONFIG_PATH, encoding=ENCODING)
 
 
 def _write_to_config():
-    with open(paths.CONFIG_PATH, "w", encoding=_ENCODING) as configfile:
+    with open(paths.CONFIG_PATH, "w", encoding=ENCODING) as configfile:
         _configparser.write(configfile)
 
 

smct/logger.py

@@ -0,0 +1,36 @@
+import logging
+import os
+from smct import paths
+
+LOGFILENAME = paths.LOG_PATH
+ENCODING = "utf-8"
+
+LOG = None
+STARTUP = True
+
+LOG_LINE_LIMIT = 300
+
+
+def log(text):
+    LOG.info(text)
+
+
+def clear_log_if_needed():
+    if os.path.exists(LOGFILENAME):
+        with open(LOGFILENAME, "r", encoding=ENCODING) as file:
+            lines = file.readlines()
+            if len(lines) > LOG_LINE_LIMIT:
+                with open(LOGFILENAME, "w", encoding=ENCODING) as file:
+                    file.write("")
+
+
+if STARTUP:
+    clear_log_if_needed()
+    logging.basicConfig(
+        filename=LOGFILENAME,
+        level=logging.INFO,
+        format="%(asctime)s - %(levelname)s - %(message)s",
+    )
+    LOG = logging.getLogger(__name__)
+    LOG.critical("Start")
+    STARTUP = False

smct/multimonitortool.py

@@ -1,6 +1,7 @@
 import subprocess
 import pandas as pd
 from smct import config, paths
+from smct.logger import log
 
 MMT_CSV_MONITOR_NAME = "Monitor Name"
 MMT_CSV_SERIAL_NUMBER = "Monitor Serial Number"
@@ -21,6 +22,7 @@ def get_monitor_selection_list():
         _monitor_selection_list.append(
             f"{_monitor_id} | {_monitor_name} | {_monitor_serial}"
         )
+        log(f"Monitor detected: {_monitor_id} | {_monitor_name} | {_monitor_serial}")
         _monitor_selection_list.sort()
     return _monitor_selection_list
 
@@ -41,8 +43,9 @@ def _run_mmt_command(command, destination):
             ],
             check=True,
         )
+        log(f"MultiMonitorTool.exe {command} {destination}")
     except subprocess.CalledProcessError as error:
-        print(f"{config.get_mmt_path_value} {command} {destination} failed: {error}")
+        log(f"MultiMonitorTool.exe {command} {destination} failed: {error}")
 
 
 def save_mmt_config():

smct/notification.py

@@ -25,6 +25,7 @@ def strip_package_name_from_path(path):
 EXE_PATH = BASE_PATH + "\\" + ui_strings.APP_NAME + ".exe"
 
 CONFIG_PATH = BASE_PATH + "\\config.ini"
+LOG_PATH = BASE_PATH + "\\smct.log"
 ASSETS_DIR_PATH = BASE_PATH + "\\assets"
 MMT_DIR_PATH = BASE_PATH + "\\mmt"
 

smct/paths.py

@@ -1,5 +1,6 @@
 import winreg
 from smct import paths, ui_strings
+from smct.logger import log
 
 KEY_NAME = ui_strings.APP_NAME
 REGISTRY_KEY = r"Software\Microsoft\Windows\CurrentVersion\Run"
@@ -23,9 +24,9 @@ def add_to_autostart():
         exe_path = paths.EXE_PATH[0].upper() + paths.EXE_PATH[1:]
         winreg.SetValueEx(key, KEY_NAME, 0, winreg.REG_SZ, exe_path)
         winreg.CloseKey(key)
-    except PermissionError:
-        # print(f"Error occurred while adding to autostart: {e}")
-        pass
+        log(f"Enabled autostart, wrote {KEY_NAME} to {REGISTRY_KEY}")
+    except PermissionError as e:
+        log(f"Failed to enable autostart: {e} in {REGISTRY_KEY}")
 
 
 def remove_from_autostart():
@@ -35,6 +36,6 @@ def remove_from_autostart():
         )
         winreg.DeleteValue(key, KEY_NAME)
         winreg.CloseKey(key)
-    except (FileNotFoundError, PermissionError):
-        # print(f"Error occurred while removing from autostart: {e}")
-        pass
+        log(f"Disabled autostart, removed {KEY_NAME} from {REGISTRY_KEY}")
+    except (FileNotFoundError, PermissionError) as e:
+        log(f"Failed to disable autostart: {e} in {REGISTRY_KEY}")