forked from kalkin/qubes-desktop-linux-manager
-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
actionable_widgets.py
465 lines (370 loc) · 16.2 KB
/
actionable_widgets.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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
# -*- encoding: utf8 -*-
#
# The Qubes OS Project, http://www.qubes-os.org
#
# Copyright (C) 2023 Marta Marczykowska-Górecka
# <marmarta@invisiblethingslab.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 2.1 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with this program; if not, see <http://www.gnu.org/licenses/>.
"""
Generic widgets handling devices. Made in a way that makes them easy to pack in
other widgets, e.g. MenuItems and ListRows.
Use generate_wrapper_widget to get a wrapped widget.
"""
import pathlib
from typing import Iterable, Callable, List, Optional
import qubesadmin
import qubesadmin.devices
import qubesadmin.vm
import gi
gi.require_version('Gtk', '3.0') # isort:skip
from gi.repository import Gtk, GdkPixbuf, GLib # isort:skip
from . import backend
def load_icon(icon_name: str, backup_name: str, size: int = 24):
"""Load icon from provided name/path, if available. If not, load backup
icon. If icon not found in any of the above ways, load a blank icon of
specified size.
Returns GdkPixbuf.Pixbuf.
Size must be in pixels.
To enable local testing, there is a fallback that tries to load icons from
local directory.
"""
try:
image: GdkPixbuf.Pixbuf = Gtk.IconTheme.get_default().load_icon(
icon_name, size, 0)
return image
except (TypeError, GLib.Error):
try:
image: GdkPixbuf.Pixbuf = Gtk.IconTheme.get_default().load_icon(
backup_name, size, 0)
return image
except (TypeError, GLib.Error):
try:
# this is a workaround in case we are running this locally
icon_path = str(pathlib.Path().resolve()) + \
'/icons/scalable/' + icon_name + '.svg'
return GdkPixbuf.Pixbuf.new_from_file_at_size(
icon_path, size, size)
except (GLib.Error, TypeError):
# we are giving up and just using a blank icon
pixbuf: GdkPixbuf.Pixbuf = GdkPixbuf.Pixbuf.new(
GdkPixbuf.Colorspace.RGB, True, 8, size, size)
pixbuf.fill(0x000)
return pixbuf
class ActionableWidget:
"""abstract class to be used in various clickable items in menus and
list items"""
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
# should this widget be sensitive?
self.actionable: bool = True
def widget_action(self, *_args):
"""What should happen when this widget is activated/clicked"""
if not self.actionable:
return
### ICONS
class VariantIcon(Gtk.Image):
def __init__(self, icon_name, initial_variant: str, size: int):
"""
Initialize a new icon that has a light and dark variants.
:param icon_name: base name of the icon, e.g. 'key'
:param initial_variant: initial variant, one of 'light' and 'dark'
:param size: icon size
"""
super().__init__()
self.light_icon = load_icon(icon_name + '-light', icon_name, size)
self.dark_icon = load_icon(icon_name + '-dark', icon_name, size)
if initial_variant == 'light':
self.set_from_pixbuf(self.light_icon)
self.is_light = True
else:
self.set_from_pixbuf(self.dark_icon)
self.is_light = False
def toggle_icon(self):
if self.is_light:
self.set_from_pixbuf(self.dark_icon)
self.is_light = False
else:
self.set_from_pixbuf(self.light_icon)
self.is_light = True
class VMWithIcon(Gtk.Box):
def __init__(self, vm: backend.VM, size: int = 18, variant: str = 'dark'):
super().__init__(orientation=Gtk.Orientation.HORIZONTAL)
self.backend_icon = VariantIcon(vm.icon_name, variant, size)
self.backend_label = Gtk.Label(xalign=0)
self.backend_label.set_markup(vm.name)
self.pack_start(self.backend_icon, False, False, 4)
self.pack_start(self.backend_label, False, False, 0)
self.get_style_context().add_class('vm_item')
class VMAttachmentDiagram(Gtk.Box):
"""
Device attachment scheme, in the following form:
backend_vm [-> frontend_vm[, other_frontend+]]
"""
def __init__(self, backend_vm: backend.VM,
frontend_vms: Optional[List[backend.VM]],
variant: str = 'dark'):
super().__init__(orientation=Gtk.Orientation.HORIZONTAL)
# backend is always there
backend_vm_icon = VMWithIcon(backend_vm)
backend_vm_icon.get_style_context().add_class('main_device_vm')
self.pack_start(backend_vm_icon, False, False, 4)
if frontend_vms:
# arrow
self.arrow = VariantIcon('arrow', variant, 15)
self.pack_start(self.arrow, False, False, 4)
for vm in frontend_vms:
# vm
# potential topic to explore: commas
vm_name = VMWithIcon(vm)
vm_name.get_style_context().add_class('main_device_vm')
self.pack_start(vm_name, False, False, 4)
#### Non-interactive items
class InfoHeader(Gtk.Label, ActionableWidget):
"""
Simple header with a bolded name, left-aligned.
"""
def __init__(self, text):
super().__init__()
self.set_text(text)
self.get_style_context().add_class('device_header')
self.get_style_context().add_class('main_device_item')
self.set_halign(Gtk.Align.START)
self.actionable = False
class SeparatorItem(Gtk.Separator, ActionableWidget):
"""Separator item"""
def __init__(self):
super().__init__()
self.actionable = False
self.get_style_context().add_class('separator_item')
#### Attach/detach action items
class SimpleActionWidget(Gtk.Box):
def __init__(self, icon_name, text, variant: str = 'dark'):
"""Widget with an action and an icon."""
super().__init__()
self.set_orientation(Gtk.Orientation.HORIZONTAL)
self.icon = VariantIcon(icon_name, variant, 24)
self.text_label = Gtk.Label()
self.text_label.set_line_wrap_mode(Gtk.WrapMode.WORD)
self.text_label.set_markup(text)
self.text_label.set_xalign(0)
self.get_style_context().add_class('vm_item')
self.pack_start(self.icon, False, False, 5)
self.pack_start(self.text_label, True, True, 0)
class AttachWidget(ActionableWidget, VMWithIcon):
"""Attach device to qube action"""
def __init__(self, vm: backend.VM, device: backend.Device):
super().__init__(vm)
self.vm = vm
self.device = device
def widget_action(self, *_args):
self.device.attach_to_vm(self.vm)
class DetachWidget(ActionableWidget, SimpleActionWidget):
"""Detach device from a VM"""
def __init__(self, vm: backend.VM, device: backend.Device,
variant: str = 'dark'):
super().__init__('detach', '<b>Detach from ' + vm.name + '</b>',
variant)
self.vm = vm
self.device = device
def widget_action(self, *_args):
self.device.detach_from_vm(self.vm)
class DetachAndShutdownWidget(ActionableWidget, SimpleActionWidget):
"""Detach device from a disposable VM and shut it down."""
def __init__(self, vm: backend.VM, device: backend.Device,
variant: str = 'dark'):
super().__init__('detach', '<b>Detach and shut down ' +
vm.name + '</b>', variant)
self.vm = vm
self.device = device
def widget_action(self, *_args):
self.device.detach_from_vm(self.vm)
self.vm.vm_object.shutdown()
class DetachAndAttachWidget(ActionableWidget, VMWithIcon):
"""Detach device from current attachment(s) and attach to another"""
def __init__(self, vm: backend.VM, device: backend.Device,
variant: str = 'dark'):
super().__init__(vm, variant=variant)
self.vm = vm
self.device = device
def widget_action(self, *_args):
for vm in self.device.attachments:
self.device.detach_from_vm(vm)
self.device.attach_to_vm(self.vm)
class AttachDisposableWidget(ActionableWidget, VMWithIcon):
"""Attach to a new disposable qube"""
def __init__(self, vm: backend.VM, device: backend.Device,
variant: str = 'dark'):
super().__init__(vm, variant=variant)
self.vm = vm
self.device = device
def widget_action(self, *_args):
new_dispvm = qubesadmin.vm.DispVM.from_appvm(self.vm.vm_object.app,
self.vm)
new_dispvm.start()
self.device.attach_to_vm(backend.VM(new_dispvm))
class DetachAndAttachDisposableWidget(ActionableWidget, VMWithIcon):
"""Detach from all current attachments and attach to new disposable"""
def __init__(self, vm: backend.VM, device: backend.Device,
variant: str = 'dark'):
super().__init__(vm, variant=variant)
self.vm = vm
self.device = device
def widget_action(self, *_args):
self.device.detach_from_vm(self.vm)
new_dispvm = qubesadmin.vm.DispVM.from_appvm(self.vm.vm_object.app,
self.vm)
new_dispvm.start()
self.device.attach_to_vm(backend.VM(new_dispvm))
#### Other actions
class DeviceSettingsWidget(ActionableWidget, SimpleActionWidget):
"""
Not yet implemented.
"""
def __init__(self, device: backend.Device, variant: str = 'dark'):
super().__init__('settings', '<b>Device settings</b>',
variant)
self.device = device
def widget_action(self, *_args):
pass
class GlobalSettingsWidget(ActionableWidget, SimpleActionWidget):
"""
Not yet implemented.
"""
def __init__(self, device: backend.Device, variant: str = 'dark'):
super().__init__('settings', '<b>Global device settings</b>', variant)
self.device = device
def widget_action(self, *_args):
pass
class HelpWidget(ActionableWidget, SimpleActionWidget):
"""
Not yet implemented.
"""
def __init__(self, device: backend.Device, variant: str = 'dark'):
super().__init__('question-icon', '<b>Help</b>', variant)
self.device = device
def widget_action(self, *_args):
pass
#### Device info widget
class DeviceHeaderWidget(Gtk.Box, ActionableWidget):
def __init__(self, device: backend.Device, variant: str = 'dark'):
"""General information about the device - name, in the future also
a button to rename the device."""
super().__init__(orientation=Gtk.Orientation.VERTICAL)
# FUTURE: this is proposed layout for new API
# self.device_label = Gtk.Label()
# self.device_label.set_markup(device.name)
# self.device_label.get_style_context().add_class('device_name')
# self.edit_icon = VariantIcon('edit', 'dark', 24)
# self.detailed_description_label = Gtk.Label()
# self.detailed_description_label.set_text(device.description)
# self.backend_icon = VariantIcon(device.vm_icon, 'dark', 24)
# self.backend_label = Gtk.Label(xalign=0)
# self.backend_label.set_markup(str(device.backend_domain))
#
# self.title_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL)
# self.title_box.add(self.device_label)
# self.title_box.add(self.edit_icon)
#
# self.attachment_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL)
# self.attachment_box.add(self.backend_icon)
# self.attachment_box.add(self.backend_label)
#
# self.add(self.title_box)
# self.add(self.detailed_description_label)
# self.add(self.attachment_box)
self.device_label = Gtk.Label()
self.device_label.set_markup(device.name)
self.device_label.get_style_context().add_class('device_name')
self.device_label.set_xalign(Gtk.Align.CENTER)
self.device_label.set_halign(Gtk.Align.CENTER)
self.diagram = VMAttachmentDiagram(device.backend_domain,
list(device.attachments), variant)
self.diagram.set_halign(Gtk.Align.CENTER)
self.add(self.device_label)
self.add(self.diagram)
self.actionable = False
class MainDeviceWidget(ActionableWidget, Gtk.Grid):
"""
This is the widget that should live in the complete devices list and points
to other widgets.
Widget is a grid, filled in the following way:
| dev_icon | device_name |
| | backend_vm | (arrow) | frontend_vm[s] |
"""
def __init__(self, device: backend.Device, variant: str = 'dark'):
super().__init__()
self.device = device
self.variant = variant
self.get_style_context().add_class('main_device_item')
# the part that is common to all devices
self.device_icon = VariantIcon(device.device_icon, variant, 20)
self.device_icon.set_valign(Gtk.Align.CENTER)
self.device_label = Gtk.Label(xalign=0)
self.device_label.set_markup(device.name)
if self.device.attachments:
self.device_label.get_style_context().add_class("dev_attached")
self.device_label.get_style_context().add_class("main_device_label")
self.attach(self.device_icon, 0, 0, 1, 1)
self.attach(self.device_label, 1, 0, 3, 1)
self.vm_diagram = VMAttachmentDiagram(device.backend_domain,
list(device.attachments),
self.variant)
self.attach(self.vm_diagram, 1, 1, 3, 1)
def get_child_widgets(self, vms, disp_vm_templates) -> \
Iterable[ActionableWidget]:
"""
Get type-appropriate list of child widgets.
:return: iterable of ActionableWidgets, ready to be packed in somewhere
"""
# all devices have a header
yield DeviceHeaderWidget(self.device, self.variant)
yield SeparatorItem()
# if attached
if self.device.attachments:
for vm in self.device.attachments:
yield DetachWidget(vm, self.device, self.variant)
if vm.should_be_cleaned_up:
yield DetachAndShutdownWidget(vm, self.device, self.variant)
yield SeparatorItem()
yield InfoHeader("Detach and attach to other qube:")
for vm in vms:
yield DetachAndAttachWidget(vm, self.device, self.variant)
yield SeparatorItem()
yield InfoHeader("Detach and attach to new disposable qube:")
for vm in disp_vm_templates:
yield DetachAndAttachDisposableWidget(vm, self.device,
self.variant)
else:
yield InfoHeader("Attach to qube:")
for vm in vms:
yield AttachWidget(vm, self.device)
yield SeparatorItem()
yield InfoHeader("Attach to new disposable qube:")
for vm in disp_vm_templates:
yield AttachDisposableWidget(vm, self.device, self.variant)
def generate_wrapper_widget(widget_class: Callable,
signal: str, inside_widget: ActionableWidget):
"""
Wraps a provided
:param widget_class: "outside" widget class, e.g. Gtk.MenuItem
:param signal: name of the signal to which we should connect widget actions
:param inside_widget: inner widget
:return: a new widget_class instance with inside_widget in it
"""
widget = widget_class()
widget.add(inside_widget)
widget.connect(signal, inside_widget.widget_action)
widget.set_sensitive(inside_widget.actionable)
return widget