Debian Codegraph @

tests/pyportaltest/templates/screencast.py

raw
1 # SPDX-License-Identifier: LGPL-3.0-only
2 #
3 # This file is formatted with Python Black
4
5 from pyportaltest.templates import Request, Response, Session, ASVType, MockParams
6 from typing import Dict, List, Tuple, Iterator
7 from itertools import count
8
9 import dbus
10 import dbus.service
11 import logging
12 import socket
13
14 logger = logging.getLogger(f"templates.{__name__}")
15
16 BUS_NAME = "org.freedesktop.portal.Desktop"
17 MAIN_OBJ = "/org/freedesktop/portal/desktop"
18 SYSTEM_BUS = False
19 MAIN_IFACE = "org.freedesktop.portal.ScreenCast"
20
21 _restore_tokens = count()
22
23
24 def load(mock, parameters):
25 logger.debug(f"loading {MAIN_IFACE} template")
26
27 params = MockParams.get(mock, MAIN_IFACE)
28 params.delay = 500
29 params.version = parameters.get("version", 4)
30 params.response = parameters.get("response", 0)
31 # streams returned in Start
32 params.streams = parameters.get("streams", [])
33 # persist_mode returned in Start
34 params.persist_mode = parameters.get("persist-mode", 0)
35 params.sessions: Dict[str, Session] = {}
36
37 mock.AddProperties(
38 MAIN_IFACE,
39 dbus.Dictionary(
40 {
41 "version": dbus.UInt32(params.version),
42 "AvailableSourceTypes": dbus.UInt32(
43 parameters.get("source-types", 0b111)
44 ),
45 "AvailableCursorModes": dbus.UInt32(
46 parameters.get("cursor-modes", 0b111)
47 ),
48 }
49 ),
50 )
51
52
53 @dbus.service.method(
54 MAIN_IFACE,
55 sender_keyword="sender",
56 in_signature="a{sv}",
57 out_signature="o",
58 )
59 def CreateSession(self, options, sender):
60 try:
61 logger.debug(f"CreateSession: {options}")
62 params = MockParams.get(self, MAIN_IFACE)
63 request = Request(bus_name=self.bus_name, sender=sender, options=options)
64
65 session = Session(bus_name=self.bus_name, sender=sender, options=options)
66 params.sessions[session.handle] = session
67
68 response = Response(params.response, {})
69
70 request.respond(response, delay=params.delay)
71
72 return request.handle
73 except Exception as e:
74 logger.critical(e)
75
76
77 @dbus.service.method(
78 MAIN_IFACE,
79 sender_keyword="sender",
80 in_signature="oa{sv}",
81 out_signature="o",
82 )
83 def SelectSources(self, session_handle, options, sender):
84 try:
85 logger.debug(f"SelectSources: {session_handle} {options}")
86 params = MockParams.get(self, MAIN_IFACE)
87 request = Request(bus_name=self.bus_name, sender=sender, options=options)
88
89 response = Response(params.response, {})
90
91 request.respond(response, delay=params.delay)
92
93 return request.handle
94 except Exception as e:
95 logger.critical(e)
96
97
98 @dbus.service.method(
99 MAIN_IFACE,
100 sender_keyword="sender",
101 in_signature="osa{sv}",
102 out_signature="o",
103 )
104 def Start(self, session_handle, parent_window, options, sender):
105 try:
106 logger.debug(f"Start: {session_handle} {options}")
107 params = MockParams.get(self, MAIN_IFACE)
108 request = Request(bus_name=self.bus_name, sender=sender, options=options)
109
110 results = {
111 "streams": params.streams,
112 }
113
114 if params.version >= 4:
115 results["persist_mode"] = dbus.UInt32(params.persist_mode)
116 if params.persist_mode != 0:
117 results["restore_token"] = f"restore_token{next(_restore_tokens)}"
118
119 response = Response(params.response, results)
120
121 request.respond(response, delay=params.delay)
122
123 return request.handle
124 except Exception as e:
125 logger.critical(e)
126
127
128 @dbus.service.method(
129 MAIN_IFACE,
130 sender_keyword="sender",
131 in_signature="oa{sv}",
132 out_signature="h",
133 )
134 def OpenPipeWireRemote(self, session_handle, options, sender):
135 try:
136 logger.debug(f"OpenPipeWireRemote: {session_handle} {options}")
137
138 # libportal doesn't care about the socket, so let's use something we
139 # can easily check
140 sockets = socket.socketpair()
141
142 pw_socket = sockets[0]
143 pw_socket.send(b"I AM GROO^WPIPEWIRE")
144
145 fd = sockets[1]
146
147 logger.debug(f"OpenPipeWireRemote with fd {fd.fileno()}")
148
149 return dbus.types.UnixFd(fd)
150 except Exception as e:
151 logger.critical(e)