forked from doronz88/pymobiledevice3
-
Notifications
You must be signed in to change notification settings - Fork 0
/
accessibilityaudit.py
337 lines (269 loc) · 11.5 KB
/
accessibilityaudit.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
import json
import typing
from dataclasses import dataclass
from enum import Enum
from packaging.version import Version
from pymobiledevice3.lockdown import LockdownClient
from pymobiledevice3.lockdown_service_provider import LockdownServiceProvider
from pymobiledevice3.services.remote_server import MessageAux, RemoteServer
class SerializedObject:
def __init__(self, fields: typing.Mapping):
self._fields = fields
class AXAuditInspectorFocus_v1(SerializedObject):
def __init__(self, fields):
super().__init__(fields)
@property
def caption(self) -> str:
return self._fields.get('CaptionTextValue_v1')
@property
def element(self) -> bytes:
return self._fields.get('ElementValue_v1')
def __str__(self):
return f'<Focused ElementCaption: {self.caption}>'
class AXAuditElement_v1(SerializedObject):
def __init__(self, fields):
super().__init__(fields)
@property
def identifier(self) -> bytes:
return self._fields['PlatformElementValue_v1'].NSdata
def __repr__(self):
return f'<Element: {self.identifier}>'
class AXAuditInspectorSection_v1(SerializedObject):
def __init__(self, fields):
super().__init__(fields)
class AXAuditElementAttribute_v1(SerializedObject):
def __init__(self, fields):
super().__init__(fields)
class AXAuditDeviceSetting_v1(SerializedObject):
FIELDS = ('IdentiifierValue_v1', 'CurrentValueNumber_v1')
def __init__(self, fields):
super().__init__(fields)
for k in self.FIELDS:
if k not in self._fields:
self._fields[k] = None
@property
def key(self) -> str:
return self._fields['IdentiifierValue_v1']
@property
def value(self) -> typing.Any:
return self._fields['CurrentValueNumber_v1']
def __str__(self) -> str:
return f'<AXAuditDeviceSetting_v1 {self.key} = {self.value}>'
class AXAuditIssue_v1(SerializedObject):
FIELDS = ('ElementRectValue_v1', 'IssueClassificationValue_v1',
'ElementRectValue_v1', 'FontSizeValue_v1', 'MLGeneratedDescriptionValue_v1')
def __init__(self, fields):
super().__init__(fields)
for k in self.FIELDS:
if k not in self._fields:
self._fields[k] = None
@property
def rect(self) -> str:
return self._fields['ElementRectValue_v1']
@property
def issue_type(self) -> typing.Any:
if self._fields['IssueClassificationValue_v1'] in AUDIT_TYPES:
return AUDIT_TYPES[self._fields['IssueClassificationValue_v1']]
else:
return self._fields['IssueClassificationValue_v1']
@property
def ml_generated_description(self) -> typing.Any:
return self._fields['MLGeneratedDescriptionValue_v1']
@property
def font_size(self) -> typing.Any:
return self._fields['FontSizeValue_v1']
def json(self) -> typing.Mapping:
resp = {}
resp['element_rect_value'] = self.rect
resp['issue_classification'] = self.issue_type
resp['font_size'] = self.font_size
resp['ml_generated_description'] = self.ml_generated_description
return resp
def __str__(self) -> str:
return json.dumps(self.json())
SERIALIZABLE_OBJECTS = {
'AXAuditDeviceSetting_v1': AXAuditDeviceSetting_v1,
'AXAuditInspectorFocus_v1': AXAuditInspectorFocus_v1,
'AXAuditElement_v1': AXAuditElement_v1,
'AXAuditInspectorSection_v1': AXAuditInspectorSection_v1,
'AXAuditElementAttribute_v1': AXAuditElementAttribute_v1,
'AXAuditIssue_v1': AXAuditIssue_v1
}
AUDIT_TYPES = {
3001: 'testTypeDynamicText',
3003: 'testTypeTextClipped',
1000: 'testTypeElementDetection',
5000: 'testTypeSufficientElementDescription',
100: 'testTypeHitRegion',
13: 'testTypeContrast'
}
@dataclass
class Event:
name: str
data: SerializedObject
class Direction(Enum):
Previous = 3
Next = 4
First = 5
Last = 6
def deserialize_object(d):
if not isinstance(d, dict):
if isinstance(d, list):
return [deserialize_object(x) for x in d]
return d
if 'ObjectType' not in d:
# simple dictionary
new_dict = {}
for k, v in d.items():
new_dict[k] = deserialize_object(v)
return new_dict
if d['ObjectType'] == 'passthrough':
return deserialize_object(d['Value'])
else:
return SERIALIZABLE_OBJECTS[d['ObjectType']](deserialize_object(d['Value']))
class AccessibilityAudit(RemoteServer):
SERVICE_NAME = 'com.apple.accessibility.axAuditDaemon.remoteserver'
RSD_SERVICE_NAME = 'com.apple.accessibility.axAuditDaemon.remoteserver.shim.remote'
def __init__(self, lockdown: LockdownServiceProvider):
if isinstance(lockdown, LockdownClient):
super().__init__(lockdown, self.SERVICE_NAME, remove_ssl_context=True, is_developer_service=False)
else:
super().__init__(lockdown, self.RSD_SERVICE_NAME, remove_ssl_context=True, is_developer_service=False)
# flush previously received messages
self.recv_plist()
self.product_version = Version(lockdown.product_version)
if Version(lockdown.product_version) >= Version('15.0'):
self.recv_plist()
@property
def capabilities(self) -> typing.List[str]:
self.broadcast.deviceCapabilities()
return self.recv_plist()[0]
def run_audit(self, value: typing.List) -> typing.List[AXAuditIssue_v1]:
if self.product_version >= Version('15.0'):
self.broadcast.deviceBeginAuditTypes_(MessageAux().append_obj(value))
else:
self.broadcast.deviceBeginAuditCaseIDs_(MessageAux().append_obj(value))
while True:
message = self.recv_plist()
if message[1] is None or message[0] != 'hostDeviceDidCompleteAuditCategoriesWithAuditIssues:':
continue
return deserialize_object(message[1])[0]['value']
def supported_audits_types(self) -> None:
if self.product_version >= Version('15.0'):
self.broadcast.deviceAllSupportedAuditTypes()
else:
self.broadcast.deviceAllAuditCaseIDs()
return deserialize_object(self.recv_plist()[0])
@property
def settings(self) -> typing.List[AXAuditDeviceSetting_v1]:
self.broadcast.deviceAccessibilitySettings()
return deserialize_object(self.recv_plist()[0])
def perform_handshake(self) -> None:
# this service acts differently from others, requiring no handshake
pass
def set_app_monitoring_enabled(self, value: bool) -> None:
self.broadcast.deviceSetAppMonitoringEnabled_(MessageAux().append_obj(value), expects_reply=False)
def set_monitored_event_type(self, event_type: int = None) -> None:
if event_type is None:
event_type = 0
self.broadcast.deviceInspectorSetMonitoredEventType_(MessageAux().append_obj(event_type), expects_reply=False)
def set_show_ignored_elements(self, value: bool) -> None:
self.broadcast.deviceInspectorShowIgnoredElements_(MessageAux().append_obj(int(value)), expects_reply=False)
def set_show_visuals(self, value: bool) -> None:
self.broadcast.deviceInspectorShowVisuals_(MessageAux().append_obj(int(value)), expects_reply=False)
def iter_events(self, app_monitoring_enabled=True, monitored_event_type: int = None) -> \
typing.Generator[Event, None, None]:
self.set_app_monitoring_enabled(app_monitoring_enabled)
self.set_monitored_event_type(monitored_event_type)
while True:
message = self.recv_plist()
if message[1] is None:
continue
data = [x['value'] for x in message[1]]
yield Event(name=message[0], data=deserialize_object(data))
def move_focus_next(self) -> None:
self.move_focus(Direction.Next)
def perform_press(self, element: bytes) -> None:
""" simulate click (can be used only for processes with task_for_pid-allow """
element = {
'ObjectType': 'AXAuditElement_v1',
'Value': {
'ObjectType': 'passthrough',
'Value': {
'PlatformElementValue_v1': {
'ObjectType': 'passthrough'
},
'Value': element,
}
}
}
action = {
'ObjectType': 'AXAuditElementAttribute_v1',
'Value': {
'ObjectType': 'passthrough',
'Value': {
'AttributeNameValue_v1': {
'ObjectType': 'passthrough',
'Value': 'AXAction-2010',
},
'DisplayAsTree_v1': {
'ObjectType': 'passthrough',
'Value': 0,
},
'HumanReadableNameValue_v1': {
'ObjectType': 'passthrough',
'Value': 'Activate',
},
'IsInternal_v1': {
'ObjectType': 'passthrough',
'Value': 0,
},
'PerformsActionValue_v1': {
'ObjectType': 'passthrough',
'Value': 1,
},
'SettableValue_v1': {
'ObjectType': 'passthrough',
'Value': 0,
},
'ValueTypeValue_v1': {
'ObjectType': 'passthrough',
'Value': 1,
},
}
}
}
self.broadcast.deviceElement_performAction_withValue_(
MessageAux().append_obj(element).append_obj(action).append_obj(0), expects_reply=False)
def move_focus(self, direction: Direction) -> None:
options = {
'ObjectType': 'passthrough',
'Value': {
'allowNonAX': {
'ObjectType': 'passthrough',
'Value': 0,
},
'direction': {
'ObjectType': 'passthrough',
'Value': direction.value,
},
'includeContainers': {
'ObjectType': 'passthrough',
'Value': 1,
}
}
}
self.broadcast.deviceInspectorMoveWithOptions_(MessageAux().append_obj(options), expects_reply=False)
def set_setting(self, name: str, value: typing.Any) -> None:
setting = {'ObjectType': 'AXAuditDeviceSetting_v1',
'Value': {'ObjectType': 'passthrough',
'Value': {'CurrentValueNumber_v1': {'ObjectType': 'passthrough',
'Value': True},
'EnabledValue_v1': {'ObjectType': 'passthrough', 'Value': True},
'IdentiifierValue_v1': {'ObjectType': 'passthrough',
'Value': name},
'SettingTypeValue_v1': {'ObjectType': 'passthrough', 'Value': 3},
'SliderTickMarksValue_v1': {'ObjectType': 'passthrough', 'Value': 0}}}}
self.broadcast.deviceUpdateAccessibilitySetting_withValue_(
MessageAux().append_obj(setting).append_obj({'ObjectType': 'passthrough', 'Value': value}),
expects_reply=False)