frontengine 1.0.68__tar.gz → 1.0.69__tar.gz

{frontengine-1.0.68 → frontengine-1.0.69}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frontengine
-Version: 1.0.68
+Version: 1.0.69
 Summary: FrontEngine is use-define frontview or only use like screen saver
 Author-email: JE-Chen <jechenmailman@gmail.com>
 Project-URL: Homepage, https://github.com/Intergration-Automation-Testing/FrontEngine

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/ui/main_ui.py

@@ -52,6 +52,7 @@ from frontengine.utils.steam.steam_language import steam_language
 from frontengine.utils.critical_exit.critical_exit import CriticalExit
 from frontengine.utils.critical_exit.win32_vk import keyboard_keys_table
 from frontengine.utils.hotkey.hotkey_service import HotkeyService
+from frontengine.utils.keep_awake.keep_awake import KeepAwake
 from frontengine.utils.logging.loggin_instance import front_engine_logger
 from frontengine.utils.multi_language.language_wrapper import language_wrapper
 from frontengine.utils.multi_language.retranslate import retranslator
@@ -330,6 +331,12 @@ class FrontEngineMainUI(QMainWindow):
         )
         self.preset_schedule_service.start()
 
+        # 保持喚醒：覆蓋層放著的時候別讓螢幕睡著
+        # Keep awake: do not let the display sleep while an overlay is up
+        self.keep_awake = KeepAwake()
+        if user_setting_dict.get("keep_awake"):
+            self.keep_awake.enable()
+
         # 閒置夠久就把選定的覆蓋層放上來 / Show the chosen overlay once idle
         self._screensaver_overlays: list = []
         self.screensaver_service = ScreensaverService(
@@ -858,6 +865,11 @@ class FrontEngineMainUI(QMainWindow):
         if user_setting_dict.get("restore_last_session"):
             save_last_session(self)
         self._stop_services()
+        # 執行緒執行狀態跟著行程活著，不放開的話關掉程式之後螢幕還是不會睡。
+        # The execution state lives with the process: without releasing it the
+        # display keeps refusing to sleep after the application is gone.
+        if getattr(self, "keep_awake", None) is not None:
+            self.keep_awake.disable()
         self._save_page_state()
         self._save_window_geometry()
         write_user_setting()

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/ui/menu/settings_menu.py

@@ -13,6 +13,7 @@ from frontengine.ui.dialog.reminder_dialog import ReminderDialog
 from frontengine.ui.dialog.remote_control_dialog import RemoteControlDialog
 from frontengine.ui.dialog.screen_privacy_dialog import ScreenPrivacyDialog
 from frontengine.ui.dialog.screensaver_dialog import ScreensaverDialog
+from frontengine.utils.keep_awake.keep_awake import available as keep_awake_available
 from frontengine.ui.dialog.signage_dialog import SignageDialog
 from frontengine.ui.dialog.smart_pause_dialog import SmartPauseDialog
 from frontengine.ui.dialog.usage_report_dialog import UsageReportDialog
@@ -73,6 +74,15 @@ def build_settings_menu(ui: "FrontEngineMainUI") -> None:
     menu.addAction(autostart_action)
     ui.autostart_action = autostart_action
 
+    keep_awake_action = QAction(_t("settings_menu_keep_awake", "Keep the screen awake"), menu)
+    retranslator.bind(keep_awake_action, "settings_menu_keep_awake", "Keep the screen awake")
+    keep_awake_action.setCheckable(True)
+    keep_awake_action.setChecked(bool(user_setting_dict.get("keep_awake")))
+    keep_awake_action.setEnabled(keep_awake_available())
+    keep_awake_action.toggled.connect(lambda checked: _toggle_keep_awake(ui, checked))
+    menu.addAction(keep_awake_action)
+    ui.keep_awake_action = keep_awake_action
+
     restore_action = QAction(_t("settings_menu_restore_session", "Restore last session"), menu)
     retranslator.bind(restore_action, "settings_menu_restore_session", "Restore last session")
     restore_action.setCheckable(True)
@@ -180,6 +190,25 @@ def _dispose(dialog: QDialog) -> None:
     dialog.deleteLater()
 
 
+def _toggle_keep_awake(ui: "FrontEngineMainUI", enabled: bool) -> None:
+    """開關保持喚醒，並把選擇記下來。做不到時把勾勾拿掉，不要留一個假的開著。"""
+    service = getattr(ui, "keep_awake", None)
+    if service is None:
+        return
+    if enabled and not service.enable():
+        # 開不起來就把選單的勾勾收回去：勾著卻沒生效比沒有這個選項更糟。
+        # If it could not be held, untick: a ticked box that does nothing is
+        # worse than no box at all.
+        action = getattr(ui, "keep_awake_action", None)
+        if action is not None:
+            action.setChecked(False)
+        return
+    if not enabled:
+        service.disable()
+    user_setting_dict["keep_awake"] = bool(enabled)
+    write_user_setting()
+
+
 def _open_signage_dialog(ui: "FrontEngineMainUI") -> None:
     """開看板設定；按下確定後立刻套用新的輪播狀態。"""
     front_engine_logger.info("[SettingsMenu] open SignageDialog")

frontengine-1.0.69/frontengine/utils/keep_awake/keep_awake.py

@@ -0,0 +1,154 @@
+"""
+保持喚醒：開著覆蓋層的時候別讓螢幕睡著。
+
+這是螢幕保護的另一面。放了影片、看板或簡報層在畫面上，系統照樣會在幾分鐘後把
+螢幕關掉——那正是最不該關的時候。
+
+三個平台各自用系統既有的方式，都不需要新相依：Windows 是一個 Win32 呼叫，
+macOS 與 Linux 是常駐一個系統本來就有的小程式（`caffeinate` / `systemd-inhibit`）
+並在結束時終止它。做不到的平台照實回報，不假裝成功。
+
+Keep awake: stop the screen sleeping while an overlay is up.
+
+This is the other side of the screensaver. With a video, a signage rotation or a
+presenting layer on screen, the system still blanks the display after a few
+minutes - exactly when it should not.
+
+Each platform uses what it already has, with no new dependency: one Win32 call on
+Windows, and on macOS and Linux a small program that ships with the system
+(`caffeinate` / `systemd-inhibit`) held open and terminated on release. A
+platform that cannot do it says so rather than pretending.
+"""
+from __future__ import annotations
+
+import shutil
+import subprocess  # nosec B404 - only runs the fixed argv in _HELPERS below
+import sys
+from typing import List, Optional
+
+from frontengine.utils.logging.loggin_instance import front_engine_logger
+
+# SetThreadExecutionState 的旗標 / Flags for SetThreadExecutionState
+ES_CONTINUOUS = 0x80000000
+ES_SYSTEM_REQUIRED = 0x00000001
+ES_DISPLAY_REQUIRED = 0x00000002
+
+# 非 Windows 平台用的常駐小程式。argv 全部寫死在這裡，沒有任何外部輸入。
+# The helper held open on the other platforms. Every argv is literal here; no
+# outside input reaches it.
+_HELPERS = {
+    "darwin": ["/usr/bin/caffeinate", "-dimsu"],
+    "linux": ["systemd-inhibit", "--what=idle:sleep",
+              "--who=FrontEngine", "--why=Overlay on screen", "--mode=block",
+              "sleep", "infinity"],
+}
+
+
+def helper_command() -> Optional[List[str]]:
+    """這個平台要跑哪一個小程式；Windows 或找不到程式時回傳 None。"""
+    command = _HELPERS.get(sys.platform)
+    if command is None:
+        return None
+    return command if shutil.which(command[0]) else None
+
+
+def available() -> bool:
+    """這個平台能不能阻止螢幕睡著。"""
+    if sys.platform == "win32":
+        return True
+    return helper_command() is not None
+
+
+class KeepAwake:
+    """
+    保持喚醒的開關。enable() 開始、disable() 放開，兩者重複呼叫都是安全的。
+
+    **一定要記得放開。** Windows 的執行緒執行狀態會跟著行程活著，忘了還原的話，
+    使用者關掉這個選項、甚至關掉整個程式之後，螢幕還是不會依設定睡著——而且看不出
+    是誰造成的。
+    A keep-awake switch. enable() holds it, disable() lets go, and both are safe
+    to call twice.
+
+    **Releasing matters.** The Windows execution state lives as long as the
+    process: forget to restore it and the display stops sleeping even after the
+    user switches the option off, with nothing on screen to say why.
+    """
+
+    def __init__(self) -> None:
+        self._active = False
+        self._process: Optional[subprocess.Popen] = None
+
+    @property
+    def active(self) -> bool:
+        return self._active
+
+    def enable(self, keep_display_on: bool = True) -> bool:
+        """開始保持喚醒；做不到就回傳 False。"""
+        if self._active:
+            return True
+        if not available():
+            front_engine_logger.info("[KeepAwake] not supported on this platform")
+            return False
+        if sys.platform == "win32":
+            if not self._windows_state(keep_display_on):
+                return False
+        elif not self._start_helper():
+            return False
+        self._active = True
+        front_engine_logger.info(f"[KeepAwake] on | display={keep_display_on}")
+        return True
+
+    def disable(self) -> None:
+        """放開，讓系統回到原本的睡眠設定。重複呼叫是安全的。"""
+        if not self._active:
+            return
+        if sys.platform == "win32":
+            self._windows_state(False, release=True)
+        self._stop_helper()
+        self._active = False
+        front_engine_logger.info("[KeepAwake] off")
+
+    # --- platform boundaries ---------------------------------------------
+    @staticmethod
+    def _windows_state(keep_display_on: bool, release: bool = False) -> bool:  # pragma: no cover - Win32
+        try:
+            import ctypes
+
+            if release:
+                flags = ES_CONTINUOUS
+            else:
+                flags = ES_CONTINUOUS | ES_SYSTEM_REQUIRED
+                if keep_display_on:
+                    flags |= ES_DISPLAY_REQUIRED
+            # 回傳 0 代表失敗；不檢查的話會以為已經開著，其實螢幕照樣會睡。
+            # A zero return means it failed; unchecked, this would report success
+            # while the display goes on sleeping anyway.
+            return bool(ctypes.windll.kernel32.SetThreadExecutionState(ctypes.c_uint(flags)))
+        except Exception as error:
+            front_engine_logger.warning(f"[KeepAwake] SetThreadExecutionState failed: {error!r}")
+            return False
+
+    def _start_helper(self) -> bool:  # pragma: no cover - process boundary
+        command = helper_command()
+        if command is None:
+            return False
+        try:
+            self._process = subprocess.Popen(  # nosec B603 # nosemgrep - literal argv, shell=False
+                command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
+                stdin=subprocess.DEVNULL, shell=False)
+            return True
+        except OSError as error:
+            front_engine_logger.warning(f"[KeepAwake] helper failed: {error!r}")
+            self._process = None
+            return False
+
+    def _stop_helper(self) -> None:  # pragma: no cover - process boundary
+        process = self._process
+        self._process = None
+        if process is None:
+            return
+        try:
+            process.terminate()
+            process.wait(timeout=5)
+        except Exception as error:
+            front_engine_logger.warning(f"[KeepAwake] helper stop failed: {error!r}")

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/english.py

@@ -465,6 +465,7 @@ english_word_dict = {
     "pet_chatter_battery": "Battery's low - plug me in?|Low power, careful!|Find a charger soon?|Running on fumes here~",
     "pet_start": "Spawn pet",
     "pet_message_box_text": "Pet image not found",
+    "settings_menu_keep_awake": "Keep the screen awake",
     "settings_menu_smart_pause": "Smart pause...",
     "settings_menu_app_profiles": "App profiles...",
     "settings_menu_reminders": "Reminders...",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/france.py

@@ -455,6 +455,7 @@ french_word_dict = {
     "pet_chatter_battery": "La batterie est faible — tu me branches ?|Peu d'énergie, attention !|On trouve un chargeur ?|Je suis sur la réserve~",
     "pet_start": "Faire apparaître la mascotte",
     "pet_message_box_text": "Image de mascotte introuvable",
+    "settings_menu_keep_awake": "Garder l'écran allumé",
     "settings_menu_smart_pause": "Pause intelligente…",
     "settings_menu_app_profiles": "Profils d'application…",
     "settings_menu_reminders": "Rappels…",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/germany.py

@@ -457,6 +457,7 @@ germany_word_dict = {
     "pet_chatter_battery": "Der Akku ist fast leer – steckst du mich an?|Wenig Energie, pass auf!|Bald ein Ladegerät finden?|Ich laufe auf Reserve~",
     "pet_start": "Haustier erzeugen",
     "pet_message_box_text": "Haustier-Bild nicht gefunden",
+    "settings_menu_keep_awake": "Bildschirm wach halten",
     "settings_menu_smart_pause": "Intelligente Pause …",
     "settings_menu_app_profiles": "App-Profile …",
     "settings_menu_reminders": "Erinnerungen …",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/italy.py

@@ -455,6 +455,7 @@ italian_word_dict = {
     "pet_chatter_battery": "La batteria è quasi scarica — mi attacchi alla presa?|Poca energia, attenta!|Cerchiamo un caricabatterie?|Sono agli sgoccioli~",
     "pet_start": "Fai comparire la mascotte",
     "pet_message_box_text": "Immagine della mascotte non trovata",
+    "settings_menu_keep_awake": "Mantieni lo schermo attivo",
     "settings_menu_smart_pause": "Pausa intelligente…",
     "settings_menu_app_profiles": "Profili applicazione…",
     "settings_menu_reminders": "Promemoria…",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/russian.py

@@ -455,6 +455,7 @@ russian_word_dict = {
     "pet_chatter_battery": "Батарея на исходе — подключишь меня?|Мало заряда, осторожнее!|Найдём зарядку?|Я на последних каплях~",
     "pet_start": "Призвать питомца",
     "pet_message_box_text": "Изображение питомца не найдено",
+    "settings_menu_keep_awake": "Не давать экрану гаснуть",
     "settings_menu_smart_pause": "Умная пауза…",
     "settings_menu_app_profiles": "Профили приложений…",
     "settings_menu_reminders": "Напоминания…",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/simplified_chinese.py

@@ -456,6 +456,7 @@ simplified_chinese_word_dict = {
     "pet_chatter_battery": "电池快没了 — 帮我插电?|电量低，小心点!|快找个充电器?|快撑不住了~",
     "pet_start": "召唤宠物",
     "pet_message_box_text": "找不到宠物图档",
+    "settings_menu_keep_awake": "保持屏幕唤醒",
     "settings_menu_smart_pause": "智慧暂停…",
     "settings_menu_app_profiles": "应用情境…",
     "settings_menu_reminders": "提醒…",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine/utils/multi_language/traditional_chinese.py

@@ -464,6 +464,7 @@ traditional_chinese_word_dict = {
     "pet_chatter_battery": "電量很低，幫我插電好嗎？|快沒電了，小心！|該找充電器囉？|我快撐不住了～",
     "pet_start": "召喚寵物",
     "pet_message_box_text": "找不到寵物圖片",
+    "settings_menu_keep_awake": "保持螢幕喚醒",
     "settings_menu_smart_pause": "智慧暫停…",
     "settings_menu_app_profiles": "程式對應預設集…",
     "settings_menu_reminders": "自訂提醒…",

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frontengine
-Version: 1.0.68
+Version: 1.0.69
 Summary: FrontEngine is use-define frontview or only use like screen saver
 Author-email: JE-Chen <jechenmailman@gmail.com>
 Project-URL: Homepage, https://github.com/Intergration-Automation-Testing/FrontEngine

{frontengine-1.0.68 → frontengine-1.0.69}/frontengine.egg-info/SOURCES.txt

@@ -188,6 +188,8 @@ frontengine/utils/input_watch/typing_watch.py
 frontengine/utils/json/__init__.py
 frontengine/utils/json/json_file.py
 frontengine/utils/json/json_repository.py
+frontengine/utils/keep_awake/__init__.py
+frontengine/utils/keep_awake/keep_awake.py
 frontengine/utils/logging/__init__.py
 frontengine/utils/logging/loggin_instance.py
 frontengine/utils/measure/__init__.py

{frontengine-1.0.68 → frontengine-1.0.69}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "frontengine"
-version = "1.0.68"
+version = "1.0.69"
 authors = [
     { name = "JE-Chen", email = "jechenmailman@gmail.com" },
 ]