pygpt-net 2.6.57__py3-none-any.whl → 2.6.59__py3-none-any.whl

pygpt_net/plugin/cmd_system/config.py

@@ -6,7 +6,7 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2024.11.24 06:00:00                  #
+# Updated Date: 2025.09.23 07:00:00                  #
 # ================================================== #
 
 from pygpt_net.plugin.base.config import BaseConfig, BasePlugin
@@ -49,6 +49,7 @@ class Config(BaseConfig):
         }
         ports_items = []
 
+        # Sandbox / sys_exec (original)
         plugin.add_option(
             "sandbox_docker",
             type="bool",
@@ -134,4 +135,379 @@ class Config(BaseConfig):
             enabled=True,
             description="Allows system commands execution",
             tab="general",
+        )
+
+        # -------------------------------
+        # WinAPI options (new tab)
+        # -------------------------------
+        plugin.add_option(
+            "winapi_enabled",
+            type="bool",
+            value=True,
+            label="Enable WinAPI",
+            description="Enable Windows API features on Microsoft Windows.",
+            tab="winapi",
+        )
+        plugin.add_option(
+            "win_keys_per_char_delay_ms",
+            type="int",
+            value=2,
+            label="Keys: per-char delay (ms)",
+            description="Delay between characters for win_keys_text.",
+            tab="winapi",
+        )
+        plugin.add_option(
+            "win_keys_hold_ms",
+            type="int",
+            value=50,
+            label="Keys: hold (ms)",
+            description="Hold duration for modifiers in win_keys_send.",
+            tab="winapi",
+        )
+        plugin.add_option(
+            "win_keys_gap_ms",
+            type="int",
+            value=30,
+            label="Keys: gap (ms)",
+            description="Gap between normal key taps in win_keys_send.",
+            tab="winapi",
+        )
+        plugin.add_option(
+            "win_drag_step_delay_ms",
+            type="int",
+            value=10,
+            label="Drag: step delay (ms)",
+            description="Delay between intermediate drag steps in win_drag.",
+            tab="winapi",
+        )
+
+        # -------------------------------
+        # WinAPI commands
+        # -------------------------------
+        plugin.add_cmd(
+            "win_list",
+            instruction="List top-level windows. You can filter by title substring.",
+            params=[
+                {"name": "filter_title", "type": "str", "description": "Substring to filter by window title", "required": False},
+                {"name": "visible_only", "type": "bool", "description": "Only visible windows", "required": False},
+                {"name": "limit", "type": "int", "description": "Limit number of results", "required": False},
+            ],
+            enabled=True,
+            description="List top-level windows",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_find",
+            instruction="Find windows by multiple attributes.",
+            params=[
+                {"name": "title", "type": "str", "description": "Title or substring", "required": False},
+                {"name": "class_name", "type": "str", "description": "Exact class name", "required": False},
+                {"name": "exe", "type": "str", "description": "Process executable name", "required": False},
+                {"name": "pid", "type": "int", "description": "Process ID", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+                {"name": "visible_only", "type": "bool", "description": "Only visible", "required": False},
+            ],
+            enabled=True,
+            description="Find windows",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_children",
+            instruction="List child windows for a given parent HWND.",
+            params=[{"name": "hwnd", "type": "int", "description": "Parent window handle", "required": True}],
+            enabled=True,
+            description="List child windows",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_foreground",
+            instruction="Return info about the current foreground window.",
+            params=[],
+            enabled=True,
+            description="Foreground window info",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_rect",
+            instruction="Return window rectangle (geometry).",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Get window rect",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_get_state",
+            instruction="Return full window state and metadata.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Get window state",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_focus",
+            instruction="Bring a window to foreground.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Set focus to a window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_move_resize",
+            instruction="Move and/or resize a window. Omit any of x,y,width,height to keep current.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+                {"name": "x", "type": "int", "description": "Left position", "required": False},
+                {"name": "y", "type": "int", "description": "Top position", "required": False},
+                {"name": "width", "type": "int", "description": "Width", "required": False},
+                {"name": "height", "type": "int", "description": "Height", "required": False},
+            ],
+            enabled=True,
+            description="Move/resize window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_minimize",
+            instruction="Minimize a window.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Minimize window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_maximize",
+            instruction="Maximize a window.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Maximize window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_restore",
+            instruction="Restore a minimized or maximized window.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Restore window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_close",
+            instruction="Close a window (sends WM_CLOSE).",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Close window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_show",
+            instruction="Show a window.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Show window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_hide",
+            instruction="Hide a window.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Hide window",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_always_on_top",
+            instruction="Toggle window always-on-top (topmost).",
+            params=[
+                {"name": "topmost", "type": "bool", "description": "True to set, False to clear", "required": True},
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Always on top",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_set_opacity",
+            instruction="Set window opacity using layered style. Provide alpha (0..255) OR opacity (0..1).",
+            params=[
+                {"name": "alpha", "type": "int", "description": "Alpha 0..255", "required": False},
+                {"name": "opacity", "type": "float", "description": "Opacity 0..1", "required": False},
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+            ],
+            enabled=True,
+            description="Set window opacity",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_screenshot",
+            instruction="Take a window screenshot and save to a PNG file. Returns absolute path.",
+            params=[
+                {"name": "hwnd", "type": "int", "description": "Target window handle", "required": False},
+                {"name": "title", "type": "str", "description": "Title substring to match", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+                {"name": "path", "type": "str", "description": "Output path (relative to data/ if not absolute)", "required": False},
+            ],
+            enabled=True,
+            description="Window screenshot to PNG",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_area_screenshot",
+            instruction="Take a rectangular screenshot of the screen or relative to a window.",
+            params=[
+                {"name": "x", "type": "int", "description": "Left", "required": True},
+                {"name": "y", "type": "int", "description": "Top", "required": True},
+                {"name": "width", "type": "int", "description": "Width", "required": True},
+                {"name": "height", "type": "int", "description": "Height", "required": True},
+                {"name": "hwnd", "type": "int", "description": "Base window (optional)", "required": False},
+                {"name": "title", "type": "str", "description": "Base window by title (optional)", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+                {"name": "relative", "type": "bool", "description": "Coords relative to window when hwnd/title provided", "required": False},
+                {"name": "path", "type": "str", "description": "Output path", "required": False},
+            ],
+            enabled=True,
+            description="Area screenshot to PNG",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_clipboard_get",
+            instruction="Get clipboard text.",
+            params=[],
+            enabled=True,
+            description="Clipboard get",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_clipboard_set",
+            instruction="Set clipboard text.",
+            params=[{"name": "text", "type": "str", "description": "Text to set", "required": True}],
+            enabled=True,
+            description="Clipboard set",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_cursor_get",
+            instruction="Get cursor position.",
+            params=[],
+            enabled=True,
+            description="Cursor get",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_cursor_set",
+            instruction="Set cursor position.",
+            params=[
+                {"name": "x", "type": "int", "description": "X coordinate", "required": True},
+                {"name": "y", "type": "int", "description": "Y coordinate", "required": True},
+            ],
+            enabled=True,
+            description="Cursor set",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_keys_text",
+            instruction="Type Unicode text into the active window (uses SendInput).",
+            params=[
+                {"name": "text", "type": "str", "description": "Text to type", "required": True},
+                {"name": "per_char_delay_ms", "type": "int", "description": "Delay between characters in ms", "required": False},
+            ],
+            enabled=True,
+            description="Type text",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_keys_send",
+            instruction="Send key combinations, e.g. ['CTRL','ALT','T'] or ['F5'].",
+            params=[
+                {"name": "keys", "type": "list", "description": "List of key tokens", "required": True},
+                {"name": "hold_ms", "type": "int", "description": "Hold duration for modifiers", "required": False},
+                {"name": "gap_ms", "type": "int", "description": "Gap between taps", "required": False},
+            ],
+            enabled=True,
+            description="Send key combos",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_click",
+            instruction="Click at a screen point or relative to a window.",
+            params=[
+                {"name": "x", "type": "int", "description": "X coordinate", "required": True},
+                {"name": "y", "type": "int", "description": "Y coordinate", "required": True},
+                {"name": "button", "type": "str", "description": "left/right/middle", "required": False},
+                {"name": "double", "type": "bool", "description": "Double click", "required": False},
+                {"name": "hwnd", "type": "int", "description": "Base window", "required": False},
+                {"name": "title", "type": "str", "description": "Base window by title", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+                {"name": "relative", "type": "bool", "description": "Coords relative to window", "required": False},
+            ],
+            enabled=True,
+            description="Mouse click",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_drag",
+            instruction="Drag from (x1,y1) to (x2,y2), absolute or relative to a window.",
+            params=[
+                {"name": "x1", "type": "int", "description": "Start X", "required": True},
+                {"name": "y1", "type": "int", "description": "Start Y", "required": True},
+                {"name": "x2", "type": "int", "description": "End X", "required": True},
+                {"name": "y2", "type": "int", "description": "End Y", "required": True},
+                {"name": "hwnd", "type": "int", "description": "Base window", "required": False},
+                {"name": "title", "type": "str", "description": "Base window by title", "required": False},
+                {"name": "exact", "type": "bool", "description": "Exact title match", "required": False},
+                {"name": "relative", "type": "bool", "description": "Coords relative to window", "required": False},
+                {"name": "steps", "type": "int", "description": "Interpolation steps", "required": False},
+                {"name": "hold_ms", "type": "int", "description": "Delay between steps (ms)", "required": False},
+            ],
+            enabled=True,
+            description="Mouse drag",
+            tab="winapi",
+        )
+        plugin.add_cmd(
+            "win_monitors",
+            instruction="List monitors/screens and their geometry.",
+            params=[],
+            enabled=True,
+            description="List monitors",
+            tab="winapi",
         )

pygpt_net/plugin/cmd_system/plugin.py

@@ -6,9 +6,11 @@
 # GitHub:  https://github.com/szczyglis-dev/py-gpt   #
 # MIT License                                        #
 # Created By  : Marcin Szczygliński                  #
-# Updated Date: 2025.08.15 23:00:00                  #
+# Updated Date: 2025.09.23 07:00:00                  #
 # ================================================== #
 
+import platform
+
 from pygpt_net.plugin.base.plugin import BasePlugin
 from pygpt_net.core.events import Event
 from pygpt_net.item.ctx import CtxItem
@@ -32,9 +34,45 @@ class Plugin(BasePlugin):
             'os',
         ]
         self.order = 100
+
+        # Core command(s)
+        self.winapi_cmds = [
+            # Windows window/query
+            "win_list",
+            "win_find",
+            "win_children",
+            "win_foreground",
+            "win_rect",
+            "win_get_state",
+            # Window control
+            "win_focus",
+            "win_move_resize",
+            "win_minimize",
+            "win_maximize",
+            "win_restore",
+            "win_close",
+            "win_show",
+            "win_hide",
+            "win_always_on_top",
+            "win_set_opacity",
+            # Screenshots
+            "win_screenshot",
+            "win_area_screenshot",
+            # Clipboard / input / cursor / monitors
+            "win_clipboard_get",
+            "win_clipboard_set",
+            "win_cursor_get",
+            "win_cursor_set",
+            "win_keys_text",
+            "win_keys_send",
+            "win_click",
+            "win_drag",
+            "win_monitors",
+        ]
         self.allowed_cmds = [
             "sys_exec",
-        ]
+        ] + self.winapi_cmds
+
         self.use_locale = True
         self.docker = Docker(self)
         self.runner = Runner(self)
@@ -81,20 +119,26 @@ class Plugin(BasePlugin):
         :param data: event data dict
         """
         # get current working directory
-        os = self.window.core.platforms.get_as_string(env_suffix=False)
+        os_name = self.window.core.platforms.get_as_string(env_suffix=False)
         cwd = self.window.core.config.get_user_dir('data')
-        if self.get_option_value("sandbox_docker"):
-            cwd = "/data (in docker sandbox, mapped on our host machine to: {})".format(cwd)
-            os = "Linux"  # docker image
+        is_windows = (platform.system() == "Windows")
+        winapi_enabled = self.get_option_value("winapi_enabled")
+
         for item in self.allowed_cmds:
+            # Gate WinAPI commands to Windows platform (and enabled flag)
+            if item in self.winapi_cmds:
+                if not is_windows or not winapi_enabled:
+                    continue
+
             if self.has_cmd(item):
                 cmd = self.get_cmd(item)
+                # Keep original sys_exec instruction enhancement
                 if self.get_option_value("auto_cwd") and item == "sys_exec":
                     cmd["instruction"] += "\nIMPORTANT: ALWAYS use absolute (not relative) path when passing " \
                                           "ANY command to \"command\" param. Current workdir is: {cwd}. " \
                                           "Current OS is: {os}".format(
                         cwd=cwd,
-                        os=os)
+                        os=os_name)
                 data['cmd'].append(cmd)  # append command
 
     def cmd(self, ctx: CtxItem, cmds: list, silent: bool = False):
@@ -162,4 +206,4 @@ class Plugin(BasePlugin):
             worker.run_async()
 
         except Exception as e:
-            self.error(e)
+            self.error(e)