import ctypes import os import platform import shlex import json import subprocess, signal import time from pathlib import Path from typing import Any, Optional, Sequence from typing import List, Dict, Tuple, Literal import concurrent.futures import Xlib import lxml.etree import pyautogui import requests import re from PIL import Image, ImageGrab from Xlib import display, X from flask import Flask, request, jsonify, send_file, abort # , send_from_directory from lxml.etree import _Element platform_name: str = platform.system() if platform_name == "Linux": import pyatspi from pyatspi import Accessible, StateType, STATE_SHOWING from pyatspi import Action as ATAction from pyatspi import Component # , Document from pyatspi import Text as ATText from pyatspi import Value as ATValue BaseWrapper = Any elif platform_name == "Windows": from pywinauto import Desktop from pywinauto.base_wrapper import BaseWrapper import pywinauto.application import win32ui, win32gui Accessible = Any elif platform_name == "Darwin": import plistlib import AppKit import ApplicationServices import Foundation import Quartz import oa_atomacos Accessible = Any BaseWrapper = Any else: # Platform not supported Accessible = None BaseWrapper = Any from pyxcursor import Xcursor # todo: need to reformat and organize this whole file app = Flask(__name__) pyautogui.PAUSE = 0 pyautogui.DARWIN_CATCH_UP_TIME = 0 TIMEOUT = 1800 # seconds logger = app.logger recording_process = None # fixme: this is a temporary solution for recording, need to be changed to support multiple-process recording_path = "/tmp/recording.mp4" @app.route('/setup/execute', methods=['POST']) @app.route('/execute', methods=['POST']) def execute_command(): data = request.json # The 'command' key in the JSON request should contain the command to be executed. shell = data.get('shell', False) command = data.get('command', "" if shell else []) if isinstance(command, str) and not shell: command = shlex.split(command) # Expand user directory for i, arg in enumerate(command): if arg.startswith("~/"): command[i] = os.path.expanduser(arg) # Execute the command without any safety checks. try: if platform_name == "Windows": flags = subprocess.CREATE_NO_WINDOW else: flags = 0 result = subprocess.run( command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=shell, text=True, timeout=120, creationflags=flags, ) return jsonify({ 'status': 'success', 'output': result.stdout, 'error': result.stderr, 'returncode': result.returncode }) except Exception as e: return jsonify({ 'status': 'error', 'message': str(e) }), 500 @app.route('/setup/execute_with_verification', methods=['POST']) @app.route('/execute_with_verification', methods=['POST']) def execute_command_with_verification(): """Execute command and verify the result based on provided verification criteria""" data = request.json shell = data.get('shell', False) command = data.get('command', "" if shell else []) verification = data.get('verification', {}) max_wait_time = data.get('max_wait_time', 10) # Maximum wait time in seconds check_interval = data.get('check_interval', 1) # Check interval in seconds if isinstance(command, str) and not shell: command = shlex.split(command) # Expand user directory for i, arg in enumerate(command): if arg.startswith("~/"): command[i] = os.path.expanduser(arg) # Execute the main command try: if platform_name == "Windows": flags = subprocess.CREATE_NO_WINDOW else: flags = 0 result = subprocess.run( command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=shell, text=True, timeout=120, creationflags=flags, ) # If no verification is needed, return immediately if not verification: return jsonify({ 'status': 'success', 'output': result.stdout, 'error': result.stderr, 'returncode': result.returncode }) # Wait and verify the result import time start_time = time.time() while time.time() - start_time < max_wait_time: verification_passed = True # Check window existence if specified if 'window_exists' in verification: window_name = verification['window_exists'] try: if platform_name == 'Linux': wmctrl_result = subprocess.run(['wmctrl', '-l'], capture_output=True, text=True, check=True) if window_name.lower() not in wmctrl_result.stdout.lower(): verification_passed = False elif platform_name in ['Windows', 'Darwin']: import pygetwindow as gw windows = gw.getWindowsWithTitle(window_name) if not windows: verification_passed = False except Exception: verification_passed = False # Check command execution if specified if 'command_success' in verification: verify_cmd = verification['command_success'] try: verify_result = subprocess.run(verify_cmd, shell=True, capture_output=True, text=True, timeout=5) if verify_result.returncode != 0: verification_passed = False except Exception: verification_passed = False if verification_passed: return jsonify({ 'status': 'success', 'output': result.stdout, 'error': result.stderr, 'returncode': result.returncode, 'verification': 'passed', 'wait_time': time.time() - start_time }) time.sleep(check_interval) # Verification failed return jsonify({ 'status': 'verification_failed', 'output': result.stdout, 'error': result.stderr, 'returncode': result.returncode, 'verification': 'failed', 'wait_time': max_wait_time }), 500 except Exception as e: return jsonify({ 'status': 'error', 'message': str(e) }), 500 def _get_machine_architecture() -> str: """ Get the machine architecture, e.g., x86_64, arm64, aarch64, i386, etc. """ architecture = platform.machine().lower() if architecture in ['amd32', 'amd64', 'x86', 'x86_64', 'x86-64', 'x64', 'i386', 'i686']: return 'amd' elif architecture in ['arm64', 'aarch64', 'aarch32']: return 'arm' else: return 'unknown' @app.route('/setup/launch', methods=["POST"]) def launch_app(): data = request.json shell = data.get("shell", False) command: List[str] = data.get("command", "" if shell else []) if isinstance(command, str) and not shell: command = shlex.split(command) # Expand user directory for i, arg in enumerate(command): if arg.startswith("~/"): command[i] = os.path.expanduser(arg) try: if 'google-chrome' in command and _get_machine_architecture() == 'arm': index = command.index('google-chrome') command[index] = 'chromium' # arm64 chrome is not available yet, can only use chromium subprocess.Popen(command, shell=shell) return "{:} launched successfully".format(command if shell else " ".join(command)) except Exception as e: return jsonify({"status": "error", "message": str(e)}), 500 @app.route('/screenshot', methods=['GET']) def capture_screen_with_cursor(): # fixme: when running on virtual machines, the cursor is not captured, don't know why file_path = os.path.join(os.path.dirname(__file__), "screenshots", "screenshot.png") user_platform = platform.system() # Ensure the screenshots directory exists os.makedirs(os.path.dirname(file_path), exist_ok=True) # fixme: This is a temporary fix for the cursor not being captured on Windows and Linux if user_platform == "Windows": def get_cursor(): hcursor = win32gui.GetCursorInfo()[1] hdc = win32ui.CreateDCFromHandle(win32gui.GetDC(0)) hbmp = win32ui.CreateBitmap() hbmp.CreateCompatibleBitmap(hdc, 36, 36) hdc = hdc.CreateCompatibleDC() hdc.SelectObject(hbmp) hdc.DrawIcon((0,0), hcursor) bmpinfo = hbmp.GetInfo() bmpstr = hbmp.GetBitmapBits(True) cursor = Image.frombuffer('RGB', (bmpinfo['bmWidth'], bmpinfo['bmHeight']), bmpstr, 'raw', 'BGRX', 0, 1).convert("RGBA") win32gui.DestroyIcon(hcursor) win32gui.DeleteObject(hbmp.GetHandle()) hdc.DeleteDC() pixdata = cursor.load() width, height = cursor.size for y in range(height): for x in range(width): if pixdata[x, y] == (0, 0, 0, 255): pixdata[x, y] = (0, 0, 0, 0) hotspot = win32gui.GetIconInfo(hcursor)[1:3] return (cursor, hotspot) ratio = ctypes.windll.shcore.GetScaleFactorForDevice(0) / 100 img = ImageGrab.grab(bbox=None, include_layered_windows=True) try: cursor, (hotspotx, hotspoty) = get_cursor() pos_win = win32gui.GetCursorPos() pos = (round(pos_win[0]*ratio - hotspotx), round(pos_win[1]*ratio - hotspoty)) img.paste(cursor, pos, cursor) except Exception as e: logger.warning(f"Failed to capture cursor on Windows, screenshot will not have a cursor. Error: {e}") img.save(file_path) elif user_platform == "Linux": cursor_obj = Xcursor() imgarray = cursor_obj.getCursorImageArrayFast() cursor_img = Image.fromarray(imgarray) screenshot = pyautogui.screenshot() cursor_x, cursor_y = pyautogui.position() screenshot.paste(cursor_img, (cursor_x, cursor_y), cursor_img) screenshot.save(file_path) elif user_platform == "Darwin": # (Mac OS) # Use the screencapture utility to capture the screen with the cursor subprocess.run(["screencapture", "-C", file_path]) else: logger.warning(f"The platform you're using ({user_platform}) is not currently supported") return send_file(file_path, mimetype='image/png') def _has_active_terminal(desktop: Accessible) -> bool: """ A quick check whether the terminal window is open and active. """ for app in desktop: if app.getRoleName() == "application" and app.name == "gnome-terminal-server": for frame in app: if frame.getRoleName() == "frame" and frame.getState().contains(pyatspi.STATE_ACTIVE): return True return False @app.route('/terminal', methods=['GET']) def get_terminal_output(): user_platform = platform.system() output: Optional[str] = None try: if user_platform == "Linux": desktop: Accessible = pyatspi.Registry.getDesktop(0) if _has_active_terminal(desktop): desktop_xml: _Element = _create_atspi_node(desktop) # 1. the terminal window (frame of application is st:active) is open and active # 2. the terminal tab (terminal status is st:focused) is focused xpath = '//application[@name="gnome-terminal-server"]/frame[@st:active="true"]//terminal[@st:focused="true"]' terminals: List[_Element] = desktop_xml.xpath(xpath, namespaces=_accessibility_ns_map_ubuntu) output = terminals[0].text.rstrip() if len(terminals) == 1 else None else: # windows and macos platform is not implemented currently # raise NotImplementedError return "Currently not implemented for platform {:}.".format(platform.platform()), 500 return jsonify({"output": output, "status": "success"}) except Exception as e: logger.error("Failed to get terminal output. Error: %s", e) return jsonify({"status": "error", "message": str(e)}), 500 _accessibility_ns_map = { "ubuntu": { "st": "https://accessibility.ubuntu.example.org/ns/state", "attr": "https://accessibility.ubuntu.example.org/ns/attributes", "cp": "https://accessibility.ubuntu.example.org/ns/component", "doc": "https://accessibility.ubuntu.example.org/ns/document", "docattr": "https://accessibility.ubuntu.example.org/ns/document/attributes", "txt": "https://accessibility.ubuntu.example.org/ns/text", "val": "https://accessibility.ubuntu.example.org/ns/value", "act": "https://accessibility.ubuntu.example.org/ns/action", }, "windows": { "st": "https://accessibility.windows.example.org/ns/state", "attr": "https://accessibility.windows.example.org/ns/attributes", "cp": "https://accessibility.windows.example.org/ns/component", "doc": "https://accessibility.windows.example.org/ns/document", "docattr": "https://accessibility.windows.example.org/ns/document/attributes", "txt": "https://accessibility.windows.example.org/ns/text", "val": "https://accessibility.windows.example.org/ns/value", "act": "https://accessibility.windows.example.org/ns/action", "class": "https://accessibility.windows.example.org/ns/class" }, "macos": { "st": "https://accessibility.macos.example.org/ns/state", "attr": "https://accessibility.macos.example.org/ns/attributes", "cp": "https://accessibility.macos.example.org/ns/component", "doc": "https://accessibility.macos.example.org/ns/document", "txt": "https://accessibility.macos.example.org/ns/text", "val": "https://accessibility.macos.example.org/ns/value", "act": "https://accessibility.macos.example.org/ns/action", "role": "https://accessibility.macos.example.org/ns/role", } } _accessibility_ns_map_ubuntu = _accessibility_ns_map['ubuntu'] _accessibility_ns_map_windows = _accessibility_ns_map['windows'] _accessibility_ns_map_macos = _accessibility_ns_map['macos'] # A11y tree getter for Ubuntu libreoffice_version_tuple: Optional[Tuple[int, ...]] = None MAX_DEPTH = 50 MAX_WIDTH = 1024 MAX_CALLS = 5000 def _get_libreoffice_version() -> Tuple[int, ...]: """Function to get the LibreOffice version as a tuple of integers.""" result = subprocess.run("libreoffice --version", shell=True, text=True, stdout=subprocess.PIPE) version_str = result.stdout.split()[1] # Assuming version is the second word in the command output return tuple(map(int, version_str.split("."))) def _create_atspi_node(node: Accessible, depth: int = 0, flag: Optional[str] = None) -> _Element: node_name = node.name attribute_dict: Dict[str, Any] = {"name": node_name} # States states: List[StateType] = node.getState().get_states() for st in states: state_name: str = StateType._enum_lookup[st] state_name: str = state_name.split("_", maxsplit=1)[1].lower() if len(state_name) == 0: continue attribute_dict["{{{:}}}{:}".format(_accessibility_ns_map_ubuntu["st"], state_name)] = "true" # Attributes attributes: Dict[str, str] = node.get_attributes() for attribute_name, attribute_value in attributes.items(): if len(attribute_name) == 0: continue attribute_dict["{{{:}}}{:}".format(_accessibility_ns_map_ubuntu["attr"], attribute_name)] = attribute_value # Component if attribute_dict.get("{{{:}}}visible".format(_accessibility_ns_map_ubuntu["st"]), "false") == "true" \ and attribute_dict.get("{{{:}}}showing".format(_accessibility_ns_map_ubuntu["st"]), "false") == "true": try: component: Component = node.queryComponent() except NotImplementedError: pass else: bbox: Sequence[int] = component.getExtents(pyatspi.XY_SCREEN) attribute_dict["{{{:}}}screencoord".format(_accessibility_ns_map_ubuntu["cp"])] = \ str(tuple(bbox[0:2])) attribute_dict["{{{:}}}size".format(_accessibility_ns_map_ubuntu["cp"])] = str(tuple(bbox[2:])) text = "" # Text try: text_obj: ATText = node.queryText() # only text shown on current screen is available # attribute_dict["txt:text"] = text_obj.getText(0, text_obj.characterCount) text: str = text_obj.getText(0, text_obj.characterCount) # if flag=="thunderbird": # appeared in thunderbird (uFFFC) (not only in thunderbird), "Object # Replacement Character" in Unicode, "used as placeholder in text for # an otherwise unspecified object; uFFFD is another "Replacement # Character", just in case text = text.replace("\ufffc", "").replace("\ufffd", "") except NotImplementedError: pass # Image, Selection, Value, Action try: node.queryImage() attribute_dict["image"] = "true" except NotImplementedError: pass try: node.querySelection() attribute_dict["selection"] = "true" except NotImplementedError: pass try: value: ATValue = node.queryValue() value_key = f"{{{_accessibility_ns_map_ubuntu['val']}}}" for attr_name, attr_func in [ ("value", lambda: value.currentValue), ("min", lambda: value.minimumValue), ("max", lambda: value.maximumValue), ("step", lambda: value.minimumIncrement) ]: try: attribute_dict[f"{value_key}{attr_name}"] = str(attr_func()) except: pass except NotImplementedError: pass try: action: ATAction = node.queryAction() for i in range(action.nActions): action_name: str = action.getName(i).replace(" ", "-") attribute_dict[ "{{{:}}}{:}_desc".format(_accessibility_ns_map_ubuntu["act"], action_name)] = action.getDescription( i) attribute_dict[ "{{{:}}}{:}_kb".format(_accessibility_ns_map_ubuntu["act"], action_name)] = action.getKeyBinding(i) except NotImplementedError: pass # Add from here if we need more attributes in the future... raw_role_name: str = node.getRoleName().strip() node_role_name = (raw_role_name or "unknown").replace(" ", "-") if not flag: if raw_role_name == "document spreadsheet": flag = "calc" if raw_role_name == "application" and node.name == "Thunderbird": flag = "thunderbird" xml_node = lxml.etree.Element( node_role_name, attrib=attribute_dict, nsmap=_accessibility_ns_map_ubuntu ) if len(text) > 0: xml_node.text = text if depth == MAX_DEPTH: logger.warning("Max depth reached") return xml_node if flag == "calc" and node_role_name == "table": # Maximum column: 1024 if ver<=7.3 else 16384 # Maximum row: 104 8576 # Maximun sheet: 1 0000 global libreoffice_version_tuple MAXIMUN_COLUMN = 1024 if libreoffice_version_tuple < (7, 4) else 16384 MAX_ROW = 104_8576 index_base = 0 first_showing = False column_base = None for r in range(MAX_ROW): for clm in range(column_base or 0, MAXIMUN_COLUMN): child_node: Accessible = node[index_base + clm] showing: bool = child_node.getState().contains(STATE_SHOWING) if showing: child_node: _Element = _create_atspi_node(child_node, depth + 1, flag) if not first_showing: column_base = clm first_showing = True xml_node.append(child_node) elif first_showing and column_base is not None or clm >= 500: break if first_showing and clm == column_base or not first_showing and r >= 500: break index_base += MAXIMUN_COLUMN return xml_node else: try: for i, ch in enumerate(node): if i == MAX_WIDTH: logger.warning("Max width reached") break xml_node.append(_create_atspi_node(ch, depth + 1, flag)) except: logger.warning("Error occurred during children traversing. Has Ignored. Node: %s", lxml.etree.tostring(xml_node, encoding="unicode")) return xml_node # A11y tree getter for Windows def _create_pywinauto_node(node, nodes, depth: int = 0, flag: Optional[str] = None) -> _Element: nodes = nodes or set() if node in nodes: return nodes.add(node) attribute_dict: Dict[str, Any] = {"name": node.element_info.name} base_properties = {} try: base_properties.update( node.get_properties()) # get all writable/not writable properties, but have bugs when landing on chrome and it's slower! except: logger.debug("Failed to call get_properties(), trying to get writable properites") try: _element_class = node.__class__ class TempElement(node.__class__): writable_props = pywinauto.base_wrapper.BaseWrapper.writable_props # Instantiate the subclass node.__class__ = TempElement # Retrieve properties using get_properties() properties = node.get_properties() node.__class__ = _element_class base_properties.update(properties) # only get all writable properties logger.debug("get writable properties") except Exception as e: logger.error(e) pass # Count-cnt for attr_name in ["control_count", "button_count", "item_count", "column_count"]: try: attribute_dict[f"{{{_accessibility_ns_map_windows['cnt']}}}{attr_name}"] = base_properties[ attr_name].lower() except: pass # Columns-cols try: attribute_dict[f"{{{_accessibility_ns_map_windows['cols']}}}columns"] = base_properties["columns"].lower() except: pass # Id-id for attr_name in ["control_id", "automation_id", "window_id"]: try: attribute_dict[f"{{{_accessibility_ns_map_windows['id']}}}{attr_name}"] = base_properties[attr_name].lower() except: pass # States # 19 sec out of 20 for attr_name, attr_func in [ ("enabled", lambda: node.is_enabled()), ("visible", lambda: node.is_visible()), # ("active", lambda: node.is_active()), # occupied most of the time: 20s out of 21s for slack, 51.5s out of 54s for WeChat # maybe use for cutting branches ("minimized", lambda: node.is_minimized()), ("maximized", lambda: node.is_maximized()), ("normal", lambda: node.is_normal()), ("unicode", lambda: node.is_unicode()), ("collapsed", lambda: node.is_collapsed()), ("checkable", lambda: node.is_checkable()), ("checked", lambda: node.is_checked()), ("focused", lambda: node.is_focused()), ("keyboard_focused", lambda: node.is_keyboard_focused()), ("selected", lambda: node.is_selected()), ("selection_required", lambda: node.is_selection_required()), ("pressable", lambda: node.is_pressable()), ("pressed", lambda: node.is_pressed()), ("expanded", lambda: node.is_expanded()), ("editable", lambda: node.is_editable()), ("has_keyboard_focus", lambda: node.has_keyboard_focus()), ("is_keyboard_focusable", lambda: node.is_keyboard_focusable()), ]: try: attribute_dict[f"{{{_accessibility_ns_map_windows['st']}}}{attr_name}"] = str(attr_func()).lower() except: pass # Component try: rectangle = node.rectangle() attribute_dict["{{{:}}}screencoord".format(_accessibility_ns_map_windows["cp"])] = \ "({:d}, {:d})".format(rectangle.left, rectangle.top) attribute_dict["{{{:}}}size".format(_accessibility_ns_map_windows["cp"])] = \ "({:d}, {:d})".format(rectangle.width(), rectangle.height()) except Exception as e: logger.error("Error accessing rectangle: ", e) # Text text: str = node.window_text() if text == attribute_dict["name"]: text = "" # Selection if hasattr(node, "select"): attribute_dict["selection"] = "true" # Value for attr_name, attr_funcs in [ ("step", [lambda: node.get_step()]), ("value", [lambda: node.value(), lambda: node.get_value(), lambda: node.get_position()]), ("min", [lambda: node.min_value(), lambda: node.get_range_min()]), ("max", [lambda: node.max_value(), lambda: node.get_range_max()]) ]: for attr_func in attr_funcs: if hasattr(node, attr_func.__name__): try: attribute_dict[f"{{{_accessibility_ns_map_windows['val']}}}{attr_name}"] = str(attr_func()) break # exit once the attribute is set successfully except: pass attribute_dict["{{{:}}}class".format(_accessibility_ns_map_windows["class"])] = str(type(node)) # class_name for attr_name in ["class_name", "friendly_class_name"]: try: attribute_dict[f"{{{_accessibility_ns_map_windows['class']}}}{attr_name}"] = base_properties[ attr_name].lower() except: pass node_role_name: str = node.class_name().lower().replace(" ", "-") node_role_name = "".join( map(lambda _ch: _ch if _ch.isidentifier() or _ch in {"-"} or _ch.isalnum() else "-", node_role_name)) if node_role_name.strip() == "": node_role_name = "unknown" if not node_role_name[0].isalpha(): node_role_name = "tag" + node_role_name xml_node = lxml.etree.Element( node_role_name, attrib=attribute_dict, nsmap=_accessibility_ns_map_windows ) if text is not None and len(text) > 0 and text != attribute_dict["name"]: xml_node.text = text if depth == MAX_DEPTH: logger.warning("Max depth reached") return xml_node # use multi thread to accelerate children fetching children = node.children() if children: with concurrent.futures.ThreadPoolExecutor() as executor: future_to_child = [executor.submit(_create_pywinauto_node, ch, nodes, depth + 1, flag) for ch in children[:MAX_WIDTH]] try: xml_node.extend([future.result() for future in concurrent.futures.as_completed(future_to_child)]) except Exception as e: logger.error(f"Exception occurred: {e}") return xml_node # A11y tree getter for macOS def _create_axui_node(node, nodes: set = None, depth: int = 0, bbox: tuple = None): nodes = nodes or set() if node in nodes: return nodes.add(node) reserved_keys = { "AXEnabled": "st", "AXFocused": "st", "AXFullScreen": "st", "AXTitle": "attr", "AXChildrenInNavigationOrder": "attr", "AXChildren": "attr", "AXFrame": "attr", "AXRole": "role", "AXHelp": "attr", "AXRoleDescription": "role", "AXSubrole": "role", "AXURL": "attr", "AXValue": "val", "AXDescription": "attr", "AXDOMIdentifier": "attr", "AXSelected": "st", "AXInvalid": "st", "AXRows": "attr", "AXColumns": "attr", } attribute_dict = {} if depth == 0: bbox = ( node["kCGWindowBounds"]["X"], node["kCGWindowBounds"]["Y"], node["kCGWindowBounds"]["X"] + node["kCGWindowBounds"]["Width"], node["kCGWindowBounds"]["Y"] + node["kCGWindowBounds"]["Height"] ) app_ref = ApplicationServices.AXUIElementCreateApplication(node["kCGWindowOwnerPID"]) attribute_dict["name"] = node["kCGWindowOwnerName"] if attribute_dict["name"] != "Dock": error_code, app_wins_ref = ApplicationServices.AXUIElementCopyAttributeValue( app_ref, "AXWindows", None) if error_code: logger.error("MacOS parsing %s encountered Error code: %d", app_ref, error_code) else: app_wins_ref = [app_ref] node = app_wins_ref[0] error_code, attr_names = ApplicationServices.AXUIElementCopyAttributeNames(node, None) if error_code: # -25202: AXError.invalidUIElement # The accessibility object received in this event is invalid. return value = None if "AXFrame" in attr_names: error_code, attr_val = ApplicationServices.AXUIElementCopyAttributeValue(node, "AXFrame", None) rep = repr(attr_val) x_value = re.search(r"x:(-?[\d.]+)", rep) y_value = re.search(r"y:(-?[\d.]+)", rep) w_value = re.search(r"w:(-?[\d.]+)", rep) h_value = re.search(r"h:(-?[\d.]+)", rep) type_value = re.search(r"type\s?=\s?(\w+)", rep) value = { "x": float(x_value.group(1)) if x_value else None, "y": float(y_value.group(1)) if y_value else None, "w": float(w_value.group(1)) if w_value else None, "h": float(h_value.group(1)) if h_value else None, "type": type_value.group(1) if type_value else None, } if not any(v is None for v in value.values()): x_min = max(bbox[0], value["x"]) x_max = min(bbox[2], value["x"] + value["w"]) y_min = max(bbox[1], value["y"]) y_max = min(bbox[3], value["y"] + value["h"]) if x_min > x_max or y_min > y_max: # No intersection return role = None text = None for attr_name, ns_key in reserved_keys.items(): if attr_name not in attr_names: continue if value and attr_name == "AXFrame": bb = value if not any(v is None for v in bb.values()): attribute_dict["{{{:}}}screencoord".format(_accessibility_ns_map_macos["cp"])] = \ "({:d}, {:d})".format(int(bb["x"]), int(bb["y"])) attribute_dict["{{{:}}}size".format(_accessibility_ns_map_macos["cp"])] = \ "({:d}, {:d})".format(int(bb["w"]), int(bb["h"])) continue error_code, attr_val = ApplicationServices.AXUIElementCopyAttributeValue(node, attr_name, None) full_attr_name = f"{{{_accessibility_ns_map_macos[ns_key]}}}{attr_name}" if attr_name == "AXValue" and not text: text = str(attr_val) continue if attr_name == "AXRoleDescription": role = attr_val continue # Set the attribute_dict if not (isinstance(attr_val, ApplicationServices.AXUIElementRef) or isinstance(attr_val, (AppKit.NSArray, list))): if attr_val is not None: attribute_dict[full_attr_name] = str(attr_val) node_role_name = role.lower().replace(" ", "_") if role else "unknown_role" xml_node = lxml.etree.Element( node_role_name, attrib=attribute_dict, nsmap=_accessibility_ns_map_macos ) if text is not None and len(text) > 0: xml_node.text = text if depth == MAX_DEPTH: logger.warning("Max depth reached") return xml_node future_to_child = [] with concurrent.futures.ThreadPoolExecutor() as executor: for attr_name, ns_key in reserved_keys.items(): if attr_name not in attr_names: continue error_code, attr_val = ApplicationServices.AXUIElementCopyAttributeValue(node, attr_name, None) if isinstance(attr_val, ApplicationServices.AXUIElementRef): future_to_child.append(executor.submit(_create_axui_node, attr_val, nodes, depth + 1, bbox)) elif isinstance(attr_val, (AppKit.NSArray, list)): for child in attr_val: future_to_child.append(executor.submit(_create_axui_node, child, nodes, depth + 1, bbox)) try: for future in concurrent.futures.as_completed(future_to_child): result = future.result() if result is not None: xml_node.append(result) except Exception as e: logger.error(f"Exception occurred: {e}") return xml_node @app.route("/accessibility", methods=["GET"]) def get_accessibility_tree(): os_name: str = platform.system() # AT-SPI works for KDE as well if os_name == "Linux": global libreoffice_version_tuple libreoffice_version_tuple = _get_libreoffice_version() desktop: Accessible = pyatspi.Registry.getDesktop(0) xml_node = lxml.etree.Element("desktop-frame", nsmap=_accessibility_ns_map_ubuntu) with concurrent.futures.ThreadPoolExecutor() as executor: futures = [executor.submit(_create_atspi_node, app_node, 1) for app_node in desktop] for future in concurrent.futures.as_completed(futures): xml_tree = future.result() xml_node.append(xml_tree) return jsonify({"AT": lxml.etree.tostring(xml_node, encoding="unicode")}) elif os_name == "Windows": # Attention: Windows a11y tree is implemented to be read through `pywinauto` module, however, # two different backends `win32` and `uia` are supported and different results may be returned desktop: Desktop = Desktop(backend="uia") xml_node = lxml.etree.Element("desktop", nsmap=_accessibility_ns_map_windows) with concurrent.futures.ThreadPoolExecutor() as executor: futures = [executor.submit(_create_pywinauto_node, wnd, {}, 1) for wnd in desktop.windows()] for future in concurrent.futures.as_completed(futures): xml_tree = future.result() xml_node.append(xml_tree) return jsonify({"AT": lxml.etree.tostring(xml_node, encoding="unicode")}) elif os_name == "Darwin": # TODO: Add Dock and MenuBar xml_node = lxml.etree.Element("desktop", nsmap=_accessibility_ns_map_macos) with concurrent.futures.ThreadPoolExecutor() as executor: foreground_windows = [ win for win in Quartz.CGWindowListCopyWindowInfo( (Quartz.kCGWindowListExcludeDesktopElements | Quartz.kCGWindowListOptionOnScreenOnly), Quartz.kCGNullWindowID ) if win["kCGWindowLayer"] == 0 and win["kCGWindowOwnerName"] != "Window Server" ] dock_info = [ win for win in Quartz.CGWindowListCopyWindowInfo( Quartz.kCGWindowListOptionAll, Quartz.kCGNullWindowID ) if win.get("kCGWindowName", None) == "Dock" ] futures = [ executor.submit(_create_axui_node, wnd, None, 0) for wnd in foreground_windows + dock_info ] for future in concurrent.futures.as_completed(futures): xml_tree = future.result() if xml_tree is not None: xml_node.append(xml_tree) return jsonify({"AT": lxml.etree.tostring(xml_node, encoding="unicode")}) else: return "Currently not implemented for platform {:}.".format(platform.platform()), 500 @app.route('/screen_size', methods=['POST']) def get_screen_size(): if platform_name == "Linux": d = display.Display() screen_width = d.screen().width_in_pixels screen_height = d.screen().height_in_pixels elif platform_name == "Windows": user32 = ctypes.windll.user32 screen_width: int = user32.GetSystemMetrics(0) screen_height: int = user32.GetSystemMetrics(1) return jsonify( { "width": screen_width, "height": screen_height } ) @app.route('/window_size', methods=['POST']) def get_window_size(): if 'app_class_name' in request.form: app_class_name = request.form['app_class_name'] else: return jsonify({"error": "app_class_name is required"}), 400 d = display.Display() root = d.screen().root window_ids = root.get_full_property(d.intern_atom('_NET_CLIENT_LIST'), X.AnyPropertyType).value for window_id in window_ids: try: window = d.create_resource_object('window', window_id) wm_class = window.get_wm_class() if wm_class is None: continue if app_class_name.lower() in [name.lower() for name in wm_class]: geom = window.get_geometry() return jsonify( { "width": geom.width, "height": geom.height } ) except Xlib.error.XError: # Ignore windows that give an error continue return None @app.route('/desktop_path', methods=['POST']) def get_desktop_path(): # Get the home directory in a platform-independent manner using pathlib home_directory = str(Path.home()) # Determine the desktop path based on the operating system desktop_path = { "Windows": os.path.join(home_directory, "Desktop"), "Darwin": os.path.join(home_directory, "Desktop"), # macOS "Linux": os.path.join(home_directory, "Desktop") }.get(platform.system(), None) # Check if the operating system is supported and the desktop path exists if desktop_path and os.path.exists(desktop_path): return jsonify(desktop_path=desktop_path) else: return jsonify(error="Unsupported operating system or desktop path not found"), 404 @app.route('/wallpaper', methods=['POST']) def get_wallpaper(): def get_wallpaper_windows(): SPI_GETDESKWALLPAPER = 0x73 MAX_PATH = 260 buffer = ctypes.create_unicode_buffer(MAX_PATH) ctypes.windll.user32.SystemParametersInfoW(SPI_GETDESKWALLPAPER, MAX_PATH, buffer, 0) return buffer.value def get_wallpaper_macos(): script = """ tell application "System Events" to tell every desktop to get picture """ process = subprocess.Popen(['osascript', '-e', script], stdout=subprocess.PIPE, stderr=subprocess.PIPE) output, error = process.communicate() if error: app.logger.error("Error: %s", error.decode('utf-8')) return None return output.strip().decode('utf-8') def get_wallpaper_linux(): try: output = subprocess.check_output( ["gsettings", "get", "org.gnome.desktop.background", "picture-uri"], stderr=subprocess.PIPE ) return output.decode('utf-8').strip().replace('file://', '').replace("'", "") except subprocess.CalledProcessError as e: app.logger.error("Error: %s", e) return None os_name = platform.system() wallpaper_path = None if os_name == 'Windows': wallpaper_path = get_wallpaper_windows() elif os_name == 'Darwin': wallpaper_path = get_wallpaper_macos() elif os_name == 'Linux': wallpaper_path = get_wallpaper_linux() else: app.logger.error(f"Unsupported OS: {os_name}") abort(400, description="Unsupported OS") if wallpaper_path: try: # Ensure the filename is secure return send_file(wallpaper_path, mimetype='image/png') except Exception as e: app.logger.error(f"An error occurred while serving the wallpaper file: {e}") abort(500, description="Unable to serve the wallpaper file") else: abort(404, description="Wallpaper file not found") @app.route('/list_directory', methods=['POST']) def get_directory_tree(): def _list_dir_contents(directory): """ List the contents of a directory recursively, building a tree structure. :param directory: The path of the directory to inspect. :return: A nested dictionary with the contents of the directory. """ tree = {'type': 'directory', 'name': os.path.basename(directory), 'children': []} try: # List all files and directories in the current directory for entry in os.listdir(directory): full_path = os.path.join(directory, entry) # If entry is a directory, recurse into it if os.path.isdir(full_path): tree['children'].append(_list_dir_contents(full_path)) else: tree['children'].append({'type': 'file', 'name': entry}) except OSError as e: # If the directory cannot be accessed, return the exception message tree = {'error': str(e)} return tree # Extract the 'path' parameter from the JSON request data = request.get_json() if 'path' not in data: return jsonify(error="Missing 'path' parameter"), 400 start_path = data['path'] # Ensure the provided path is a directory if not os.path.isdir(start_path): return jsonify(error="The provided path is not a directory"), 400 # Generate the directory tree starting from the provided path directory_tree = _list_dir_contents(start_path) return jsonify(directory_tree=directory_tree) @app.route('/file', methods=['POST']) def get_file(): # Retrieve filename from the POST request if 'file_path' in request.form: file_path = os.path.expandvars(os.path.expanduser(request.form['file_path'])) else: return jsonify({"error": "file_path is required"}), 400 try: # Check if the file exists and get its size if not os.path.exists(file_path): return jsonify({"error": "File not found"}), 404 file_size = os.path.getsize(file_path) logger.info(f"Serving file: {file_path} ({file_size} bytes)") # Check if the file exists and send it to the user return send_file(file_path, as_attachment=True) except FileNotFoundError: # If the file is not found, return a 404 error return jsonify({"error": "File not found"}), 404 except Exception as e: logger.error(f"Error serving file {file_path}: {e}") return jsonify({"error": f"Failed to serve file: {str(e)}"}), 500 @app.route("/setup/upload", methods=["POST"]) def upload_file(): # Retrieve filename from the POST request if 'file_path' in request.form and 'file_data' in request.files: file_path = os.path.expandvars(os.path.expanduser(request.form['file_path'])) file = request.files["file_data"] try: # Ensure target directory exists os.makedirs(os.path.dirname(file_path), exist_ok=True) # Save file and get size for verification file.save(file_path) uploaded_size = os.path.getsize(file_path) logger.info(f"File uploaded successfully: {file_path} ({uploaded_size} bytes)") return f"File Uploaded: {uploaded_size} bytes" except Exception as e: logger.error(f"Error uploading file to {file_path}: {e}") # Clean up partial file if it exists if os.path.exists(file_path): try: os.remove(file_path) except: pass return jsonify({"error": f"Failed to upload file: {str(e)}"}), 500 else: return jsonify({"error": "file_path and file_data are required"}), 400 @app.route('/platform', methods=['GET']) def get_platform(): return platform.system() @app.route('/cursor_position', methods=['GET']) def get_cursor_position(): pos = pyautogui.position() return jsonify(pos.x, pos.y) @app.route("/setup/change_wallpaper", methods=['POST']) def change_wallpaper(): data = request.json path = data.get('path', None) if not path: return "Path not supplied!", 400 path = Path(os.path.expandvars(os.path.expanduser(path))) if not path.exists(): return f"File not found: {path}", 404 try: user_platform = platform.system() if user_platform == "Windows": import ctypes ctypes.windll.user32.SystemParametersInfoW(20, 0, str(path), 3) elif user_platform == "Linux": import subprocess subprocess.run(["gsettings", "set", "org.gnome.desktop.background", "picture-uri", f"file://{path}"]) elif user_platform == "Darwin": # (Mac OS) import subprocess subprocess.run( ["osascript", "-e", f'tell application "Finder" to set desktop picture to POSIX file "{path}"']) return "Wallpaper changed successfully" except Exception as e: return f"Failed to change wallpaper. Error: {e}", 500 @app.route("/setup/download_file", methods=['POST']) def download_file(): data = request.json url = data.get('url', None) path = data.get('path', None) if not url or not path: return "Path or URL not supplied!", 400 path = Path(os.path.expandvars(os.path.expanduser(path))) path.parent.mkdir(parents=True, exist_ok=True) max_retries = 3 error: Optional[Exception] = None for i in range(max_retries): try: logger.info(f"Download attempt {i+1}/{max_retries} for {url}") response = requests.get(url, stream=True, timeout=300) response.raise_for_status() # Get expected file size if available total_size = int(response.headers.get('content-length', 0)) if total_size > 0: logger.info(f"Expected file size: {total_size / (1024*1024):.2f} MB") downloaded_size = 0 with open(path, 'wb') as f: for chunk in response.iter_content(chunk_size=8192): if chunk: f.write(chunk) downloaded_size += len(chunk) if total_size > 0 and downloaded_size % (1024*1024) == 0: # Log every MB progress = (downloaded_size / total_size) * 100 logger.info(f"Download progress: {progress:.1f}%") # Verify download completeness actual_size = os.path.getsize(path) if total_size > 0 and actual_size != total_size: raise Exception(f"Download incomplete. Expected {total_size} bytes, got {actual_size} bytes") logger.info(f"File downloaded successfully: {path} ({actual_size} bytes)") return f"File downloaded successfully: {actual_size} bytes" except (requests.RequestException, Exception) as e: error = e logger.error(f"Failed to download {url}: {e}. Retrying... ({max_retries - i - 1} attempts left)") # Clean up partial download if path.exists(): try: path.unlink() except: pass return f"Failed to download {url}. No retries left. Error: {error}", 500 @app.route("/setup/open_file", methods=['POST']) def open_file(): data = request.json path = data.get('path', None) if not path: return "Path not supplied!", 400 path_obj = Path(os.path.expandvars(os.path.expanduser(path))) # Check if it's a file path that exists is_file_path = path_obj.exists() # If it's not a file path, treat it as an application name/command if not is_file_path: # Check if it's a valid command by trying to find it in PATH import shutil if not shutil.which(path): return f"Application/file not found: {path}", 404 try: if is_file_path: # Handle file opening if platform.system() == "Windows": os.startfile(path_obj) else: open_cmd: str = "open" if platform.system() == "Darwin" else "xdg-open" subprocess.Popen([open_cmd, str(path_obj)]) file_name = path_obj.name file_name_without_ext, _ = os.path.splitext(file_name) else: # Handle application launching if platform.system() == "Windows": subprocess.Popen([path]) else: subprocess.Popen([path]) file_name = path file_name_without_ext = path # Wait for the file/application to open start_time = time.time() window_found = False while time.time() - start_time < TIMEOUT: os_name = platform.system() if os_name in ['Windows', 'Darwin']: import pygetwindow as gw # Check for window title containing file name or file name without extension windows = gw.getWindowsWithTitle(file_name) if not windows: windows = gw.getWindowsWithTitle(file_name_without_ext) if windows: # To be more specific, we can try to activate it windows[0].activate() window_found = True break elif os_name == 'Linux': try: # Using wmctrl to list windows and check if any window title contains the filename result = subprocess.run(['wmctrl', '-l'], capture_output=True, text=True, check=True) window_list = result.stdout.strip().split('\n') if not result.stdout.strip(): pass # No windows, just continue waiting else: for window in window_list: if file_name in window or file_name_without_ext in window: # a window is found, now activate it window_id = window.split()[0] subprocess.run(['wmctrl', '-i', '-a', window_id], check=True) window_found = True break if window_found: break except (subprocess.CalledProcessError, FileNotFoundError): # wmctrl might not be installed or the window manager isn't ready. # We just log it once and let the main loop retry. if 'wmctrl_failed_once' not in locals(): logger.warning("wmctrl command is not ready, will keep retrying...") wmctrl_failed_once = True pass # Let the outer loop retry time.sleep(1) if window_found: return "File opened and window activated successfully" else: return f"Failed to find window for {file_name} within {timeout} seconds.", 500 except Exception as e: return f"Failed to open {path}. Error: {e}", 500 @app.route("/setup/activate_window", methods=['POST']) def activate_window(): data = request.json window_name = data.get('window_name', None) if not window_name: return "window_name required", 400 strict: bool = data.get("strict", False) # compare case-sensitively and match the whole string by_class_name: bool = data.get("by_class", False) os_name = platform.system() if os_name == 'Windows': import pygetwindow as gw if by_class_name: return "Get window by class name is not supported on Windows currently.", 500 windows: List[gw.Window] = gw.getWindowsWithTitle(window_name) window: Optional[gw.Window] = None if len(windows) == 0: return "Window {:} not found (empty results)".format(window_name), 404 elif strict: for wnd in windows: if wnd.title == wnd: window = wnd if window is None: return "Window {:} not found (strict mode).".format(window_name), 404 else: window = windows[0] window.activate() elif os_name == 'Darwin': import pygetwindow as gw if by_class_name: return "Get window by class name is not supported on macOS currently.", 500 # Find the VS Code window windows = gw.getWindowsWithTitle(window_name) window: Optional[gw.Window] = None if len(windows) == 0: return "Window {:} not found (empty results)".format(window_name), 404 elif strict: for wnd in windows: if wnd.title == wnd: window = wnd if window is None: return "Window {:} not found (strict mode).".format(window_name), 404 else: window = windows[0] # Un-minimize the window and then bring it to the front window.unminimize() window.activate() elif os_name == 'Linux': # Attempt to activate VS Code window using wmctrl subprocess.run(["wmctrl" , "-{:}{:}a".format("x" if by_class_name else "" , "F" if strict else "" ) , window_name ] ) else: return f"Operating system {os_name} not supported.", 400 return "Window activated successfully", 200 @app.route("/setup/close_window", methods=["POST"]) def close_window(): data = request.json if "window_name" not in data: return "window_name required", 400 window_name: str = data["window_name"] strict: bool = data.get("strict", False) # compare case-sensitively and match the whole string by_class_name: bool = data.get("by_class", False) os_name: str = platform.system() if os_name == "Windows": import pygetwindow as gw if by_class_name: return "Get window by class name is not supported on Windows currently.", 500 windows: List[gw.Window] = gw.getWindowsWithTitle(window_name) window: Optional[gw.Window] = None if len(windows) == 0: return "Window {:} not found (empty results)".format(window_name), 404 elif strict: for wnd in windows: if wnd.title == wnd: window = wnd if window is None: return "Window {:} not found (strict mode).".format(window_name), 404 else: window = windows[0] window.close() elif os_name == "Linux": subprocess.run(["wmctrl" , "-{:}{:}c".format("x" if by_class_name else "" , "F" if strict else "" ) , window_name ] ) elif os_name == "Darwin": import pygetwindow as gw return "Currently not supported on macOS.", 500 else: return "Not supported platform {:}".format(os_name), 500 return "Window closed successfully.", 200 @app.route('/start_recording', methods=['POST']) def start_recording(): global recording_process if recording_process and recording_process.poll() is None: return jsonify({'status': 'error', 'message': 'Recording is already in progress.'}), 400 # Clean up previous recording if it exists if os.path.exists(recording_path): try: os.remove(recording_path) except OSError as e: logger.error(f"Error removing old recording file: {e}") return jsonify({'status': 'error', 'message': f'Failed to remove old recording file: {e}'}), 500 d = display.Display() screen_width = d.screen().width_in_pixels screen_height = d.screen().height_in_pixels start_command = f"ffmpeg -y -f x11grab -draw_mouse 1 -s {screen_width}x{screen_height} -i :0.0 -c:v libx264 -r 30 {recording_path}" # Use stderr=PIPE to capture potential errors from ffmpeg recording_process = subprocess.Popen(shlex.split(start_command), stdout=subprocess.DEVNULL, stderr=subprocess.PIPE, text=True # To get stderr as string ) # Wait a couple of seconds to see if ffmpeg starts successfully try: # Wait for 2 seconds. If ffmpeg exits within this time, it's an error. recording_process.wait(timeout=2) # If wait() returns, it means the process has terminated. error_output = recording_process.stderr.read() return jsonify({ 'status': 'error', 'message': f'Failed to start recording. ffmpeg terminated unexpectedly. Error: {error_output}' }), 500 except subprocess.TimeoutExpired: # This is the expected outcome: the process is still running after 2 seconds. return jsonify({'status': 'success', 'message': 'Started recording successfully.'}) @app.route('/end_recording', methods=['POST']) def end_recording(): global recording_process if not recording_process or recording_process.poll() is not None: recording_process = None # Clean up stale process object return jsonify({'status': 'error', 'message': 'No recording in progress to stop.'}), 400 error_output = "" try: # Send SIGINT for a graceful shutdown, allowing ffmpeg to finalize the file. recording_process.send_signal(signal.SIGINT) # Wait for ffmpeg to terminate. communicate() gets output and waits. _, error_output = recording_process.communicate(timeout=15) except subprocess.TimeoutExpired: logger.error("ffmpeg did not respond to SIGINT, killing the process.") recording_process.kill() # After killing, communicate to get any remaining output. _, error_output = recording_process.communicate() recording_process = None return jsonify({ 'status': 'error', 'message': f'Recording process was unresponsive and had to be killed. Stderr: {error_output}' }), 500 recording_process = None # Clear the process from global state # Check if the recording file was created and is not empty. if os.path.exists(recording_path) and os.path.getsize(recording_path) > 0: return send_file(recording_path, as_attachment=True) else: logger.error(f"Recording failed. The output file is missing or empty. ffmpeg stderr: {error_output}") return abort(500, description=f"Recording failed. The output file is missing or empty. ffmpeg stderr: {error_output}") if __name__ == '__main__': app.run(debug=True, host="0.0.0.0")