Merge pull request slgobinath#726 from deltragon/lock-screen-now

screensaver: add tray action to lock screen now

Author: deltragon

safeeyes/glade/break_screen.glade

@@ -25,9 +25,6 @@
     <property name="decorated">0</property>
     <property name="deletable">0</property>
     <child>
-      <placeholder/>
-    </child>
-    <property name="child">
       <object class="GtkGrid" id="grid1">
         <property name="row_homogeneous">1</property>
         <property name="column_homogeneous">1</property>
@@ -151,7 +148,6 @@
             <child>
               <object class="GtkBox" id="toolbar">
                 <property name="css-classes">toolbar</property>
-                <property name="can_focus">0</property>
                 <property name="halign">end</property>
                 <property name="valign">start</property>
                 <style>
@@ -174,7 +170,7 @@
           </object>
         </child>
       </object>
-    </property>
+    </child>
     <style>
       <class name="window_main"/>
     </style>

safeeyes/model.py

@@ -474,21 +474,32 @@ def __ne__(self, config):
 class TrayAction:
     """Data object wrapping name, icon and action."""
 
-    def __init__(self, name, icon, action, system_icon):
+    __toolbar_buttons: list[Gtk.Button]
+
+    def __init__(
+        self,
+        name: str,
+        icon: str,
+        action: typing.Callable,
+        system_icon: bool,
+        single_use: bool,
+    ) -> None:
         self.name = name
         self.__icon = icon
         self.action = action
         self.system_icon = system_icon
         self.__toolbar_buttons = []
+        self.single_use = single_use
 
-    def get_icon(self):
-        if self.system_icon:
-            image = Gtk.Image.new_from_icon_name(self.__icon)
-            return image
-        else:
+    def get_icon(self) -> Gtk.Image:
+        if not self.system_icon:
             image = utility.load_and_scale_image(self.__icon, 16, 16)
-            image.show()
-            return image
+            if image is not None:
+                image.show()
+                return image
+
+        image = Gtk.Image.new_from_icon_name(self.__icon)
+        return image
 
     def add_toolbar_button(self, button):
         self.__toolbar_buttons.append(button)
@@ -499,12 +510,20 @@ def reset(self):
         self.__toolbar_buttons.clear()
 
     @classmethod
-    def build(cls, name, icon_path, icon_id, action):
-        image = utility.load_and_scale_image(icon_path, 12, 12)
-        if image is None:
-            return TrayAction(name, icon_id, action, True)
-        else:
-            return TrayAction(name, icon_path, action, False)
+    def build(
+        cls,
+        name: str,
+        icon_path: typing.Optional[str],
+        icon_id: str,
+        action: typing.Callable,
+        single_use: bool = True,
+    ) -> "TrayAction":
+        if icon_path is not None:
+            image = utility.load_and_scale_image(icon_path, 12, 12)
+            if image is not None:
+                return TrayAction(name, icon_path, action, False, single_use)
+
+        return TrayAction(name, icon_id, action, True, single_use)
 
 
 @dataclass

safeeyes/plugin_manager.py

@@ -24,9 +24,7 @@
     |- plugin.py
     |- icon.png (Optional)
 
-The plugin.py can have following methods but all are optional:
- - description()
-    If a custom description has to be displayed, use this function
+The plugin.py can have following lifecycle methods but all are optional:
  - init(context, safeeyes_config, plugin_config)
     Initialize the plugin. Will be called after loading and after every changes in
     configuration
@@ -50,6 +48,20 @@
     Executes once the plugin.py is loaded as a module
  - disable()
     Executes if the plugin is disabled at the runtime by the user
+
+The plugin.py can additionally have the following methods:
+ - get_widget_title(break_obj)
+    Returns title of this plugin's widget on the break screen
+    If this is used, it must also use get_widget_content to work correctly
+ - get_widget_content(break_obj)
+    Returns content of this plugin's widget on the break screen
+    If this is used, it must also use get_widget_title to work correctly
+ - get_tray_action(break_obj) -> TrayAction | list[TrayAction]
+    Display button(s) on the break screen's tray that triggers an action
+
+This method is unused:
+ - description()
+    If a custom description has to be displayed, use this function
 """
 
 import importlib
@@ -58,7 +70,7 @@
 import sys
 
 from safeeyes import utility
-from safeeyes.model import PluginDependency, RequiredPluginException
+from safeeyes.model import Break, PluginDependency, RequiredPluginException, TrayAction
 
 sys.path.append(os.path.abspath(utility.SYSTEM_PLUGINS_DIR))
 sys.path.append(os.path.abspath(utility.USER_PLUGINS_DIR))
@@ -207,15 +219,19 @@ def get_break_screen_widgets(self, break_obj):
                 continue
         return widget.strip()
 
-    def get_break_screen_tray_actions(self, break_obj):
+    def get_break_screen_tray_actions(self, break_obj: Break) -> list[TrayAction]:
         """Return Tray Actions."""
         actions = []
         for plugin in self.__plugins.values():
             action = plugin.call_plugin_method_break_obj(
                 "get_tray_action", 1, break_obj
             )
-            if action:
+            if isinstance(action, TrayAction):
                 actions.append(action)
+            elif isinstance(action, list):
+                for a in action:
+                    if isinstance(a, TrayAction):
+                        actions.append(a)
 
         return actions
 

safeeyes/plugins/screensaver/plugin.py

@@ -33,6 +33,7 @@
 min_seconds = 0
 seconds_passed = 0
 tray_icon_path = None
+icon_lock_later_path = None
 
 
 def __lock_screen_command():
@@ -102,21 +103,29 @@ def __lock_screen_command():
     return None
 
 
-def __lock_screen():
+def __lock_screen_later():
     global user_locked_screen
     user_locked_screen = True
 
 
+def __lock_screen_now() -> None:
+    utility.execute_command(lock_screen_command)
+
+
 def init(ctx, safeeyes_config, plugin_config):
     """Initialize the screensaver plugin."""
     global context
     global lock_screen_command
     global min_seconds
     global tray_icon_path
+    global icon_lock_later_path
     logging.debug("Initialize Screensaver plugin")
     context = ctx
     min_seconds = plugin_config["min_seconds"]
     tray_icon_path = os.path.join(plugin_config["path"], "resource/lock.png")
+    icon_lock_later_path = os.path.join(
+        plugin_config["path"], "resource/rotation-lock-symbolic.svg"
+    )
     if plugin_config["command"]:
         lock_screen_command = plugin_config["command"].split()
     else:
@@ -147,10 +156,22 @@ def on_stop_break():
     min_seconds.
     """
     if user_locked_screen or (lock_screen and seconds_passed >= min_seconds):
-        utility.execute_command(lock_screen_command)
-
-
-def get_tray_action(break_obj):
-    return TrayAction.build(
-        "Lock screen", tray_icon_path, "dialog-password", __lock_screen
-    )
+        __lock_screen_now()
+
+
+def get_tray_action(break_obj) -> list[TrayAction]:
+    return [
+        TrayAction.build(
+            "Lock screen now",
+            tray_icon_path,
+            "system-lock-screen",
+            __lock_screen_now,
+            single_use=False,
+        ),
+        TrayAction.build(
+            "Lock screen after break",
+            icon_lock_later_path,
+            "dialog-password",
+            __lock_screen_later,
+        ),
+    ]

safeeyes/plugins/screensaver/resource/rotation-lock-symbolic.svg

@@ -23,6 +23,7 @@
 
 import gi
 from safeeyes import utility
+from safeeyes.model import TrayAction
 from safeeyes.translations import translate as _
 import Xlib
 from Xlib.display import Display
@@ -139,13 +140,14 @@ def close(self):
         # Destroy other windows if exists
         GLib.idle_add(lambda: self.__destroy_all_screens())
 
-    def __tray_action(self, button, tray_action):
+    def __tray_action(self, button, tray_action: TrayAction):
         """Tray action handler.
 
-        Hides all toolbar buttons for this action and call the action
-        provided by the plugin.
+        Hides all toolbar buttons for this action, if it is single use,
+        and call the action provided by the plugin.
         """
-        tray_action.reset()
+        if tray_action.single_use:
+            tray_action.reset()
         tray_action.action()
 
     def __show_break_screen(self, message, image_path, widget, tray_actions):

safeeyes/ui/break_screen.py

@@ -31,6 +31,7 @@
 import shutil
 import subprocess
 import threading
+import typing
 from logging.handlers import RotatingFileHandler
 from pathlib import Path
 
@@ -732,7 +733,9 @@ def create_gtk_builder(glade_file):
     return builder
 
 
-def load_and_scale_image(path, width, height):
+def load_and_scale_image(
+    path: str, width: int, height: int
+) -> typing.Optional[Gtk.Image]:
     if not os.path.isfile(path):
         return None
     pixbuf = GdkPixbuf.Pixbuf.new_from_file_at_scale(