-
Notifications
You must be signed in to change notification settings - Fork 1
/
__init__.py
751 lines (701 loc) · 33.2 KB
/
__init__.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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
# All trademark and other rights reserved by their respective owners
# Copyright 2008-2022 Neongecko.com Inc.
# Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
# BSD-3 License
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from this
# software without specific prior written permission.
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import os
from random import randint
from threading import Event
from time import sleep
from typing import Optional
from neon_utils.validator_utils import numeric_confirmation_validator
from ovos_bus_client.message import dig_for_message, Message
from ovos_utils import classproperty
from ovos_utils.log import LOG
from ovos_utils.process_utils import RuntimeRequirements
from ovos_utils.network_utils import is_connected_http
from neon_utils.skills import NeonSkill
from neon_utils.user_utils import get_user_prefs
from ovos_workshop.decorators import intent_handler
from ovos_workshop.intents import IntentBuilder
class UpdateSkill(NeonSkill):
def __init__(self, **kwargs):
NeonSkill.__init__(self, **kwargs)
self._current_ver = None
self.latest_ver = None
self._update_filename = "update_signal"
self._os_updates_supported = None
self._default_prerelease = None
self._updating = False
self._download_completed = Event()
self._download_check_interval = 300
self.add_event('mycroft.ready', self._on_ready)
self.add_event("update.gui.continue_installation",
self.continue_os_installation)
self.add_event("update.gui.finish_installation",
self.finish_os_installation)
self.add_event("update.gui.install_update",
self.handle_update_device)
@classproperty
def runtime_requirements(self):
return RuntimeRequirements(network_before_load=False,
internet_before_load=False,
gui_before_load=False,
requires_internet=True,
requires_network=True,
requires_gui=False,
no_internet_fallback=False,
no_network_fallback=False,
no_gui_fallback=True)
@property
def current_ver(self) -> str:
if not self._current_ver:
message = (dig_for_message() or Message(""))
if self.os_updates_supported:
resp = self.bus.wait_for_response(message.forward(
"neon.device_updater.get_build_info"), timeout=15)
if resp:
self._current_ver = resp.data.get("build_version") or \
resp.data.get("core", {}).get("version")
LOG.info(f"Got build version: {self._current_ver}")
return self._current_ver
resp = self.bus.wait_for_response(message.forward(
"neon.core_updater.get_version"), timeout=15)
if resp:
self._current_ver = resp.data.get("version")
if not self._current_ver:
LOG.error("Installed core version unknown!")
return self._current_ver
@current_ver.setter
def current_ver(self, val: str):
self._current_ver = val
@property
def default_prerelease(self) -> bool:
"""
Returns True if the shipped core version was a pre-release. Used
to determine if updates should consider pre-releases or stable releases
by default; a user requested branch should take priority over this.
"""
if self._default_prerelease is None:
try:
import json
with open("/opt/neon/build_info.json") as f:
image_meta = json.load(f)
self._default_prerelease = 'b' in image_meta['build_version']
LOG.info(f"Determined image prerelease status: "
f"{self._default_prerelease}")
except Exception as e:
LOG.info(f"Assuming prerelease is false: {e}")
self._default_prerelease = False
return self._default_prerelease
@property
def os_updates_supported(self) -> bool:
"""
Returns True if OS updates are supported where this skill is running.
"""
if self._os_updates_supported is None:
try:
import neon_phal_plugin_device_updater
with open("/opt/neon/build_info.json", "r") as f:
import json
build_info = json.load(f)
build_time = build_info.get("base_os", {}).get("time", 0)
if isinstance(build_time, float) and build_time <= 1675350840.0:
LOG.info("Image too old for OS update support")
self._os_updates_supported = False
else:
LOG.info("Image should support OS updates")
self._os_updates_supported = True
except ImportError:
self._os_updates_supported = False
except FileNotFoundError:
self._os_updates_supported = False
except Exception as e:
LOG.exception(e)
self._os_updates_supported = False
return self._os_updates_supported
@property
def check_initramfs(self) -> bool:
"""
Returns True if InitramFS updates are enabled
"""
return bool(self.settings.get("update_initramfs",
self.os_updates_supported))
@property
def check_squashfs(self) -> bool:
"""
Returns True if SquashFS updates are enabled
"""
return bool(self.settings.get("update_squashfs",
self.os_updates_supported))
@property
def check_python(self) -> bool:
"""
Returns True if (Core) Python package updates are enabled
"""
return bool(self.settings.get("update_python",
not self.os_updates_supported))
@property
def notify_updates(self) -> bool:
"""
Returns True if the skill should generate notifications for available
updates.
"""
return self.settings.get("notify_updates", True)
@property
def include_prerelease(self) -> bool:
"""
Returns True if updates should include alpha/pre-release versions.
"""
return self.settings.get("include_prerelease", self.default_prerelease)
@include_prerelease.setter
def include_prerelease(self, value: bool):
"""
Explicitly set prerelease update inclusion
@param value: New pre-release setting
"""
self.settings['include_prerelease'] = value
self.settings.store()
@property
def image_url(self) -> Optional[str]:
"""
Return a configured URL to download a clean OS image from.
"""
return self.settings.get("image_url")
@property
def image_drive(self) -> str:
"""
Return a default device path to use for image creation
(default /dev/sdb).
"""
return self.settings.get("image_drive") or "/dev/sdb"
def _on_ready(self, message):
meta = None
if self.check_squashfs:
meta = self._check_squashfs_update(message)
if isinstance(meta, dict) and self.notify_updates:
version = meta.get("build_version") or \
meta.get("core", {}).get("version", "")
text = self.dialog_renderer.render("notify_os_update_available",
{"version": version})
LOG.info(f"OS Update Available: {meta['build_version']}")
callback_data = {**message.data, **{"notification": text}}
self.gui.show_notification(text,
action="update.gui.install_update",
callback_data=callback_data)
elif self.check_python:
LOG.debug("Checking latest core version")
self._check_latest_release(message)
update_stat = self._check_update_status()
LOG.debug(f"Update status is {update_stat}")
if not update_stat:
# No update was attempted
return
try:
speak_version = self.pronounce_version(self.current_ver)
except Exception as e:
LOG.error(e)
speak_version = ""
if update_stat is True:
LOG.debug("Update success")
self.speak_dialog("notify_update_success",
{"version": speak_version})
elif update_stat is False:
LOG.warning("Update failed")
self.speak_dialog("notify_update_failure",
{"version": speak_version})
def _check_latest_release(self, message):
"""
Handles checking for a new release version
:param message: message object associated with loaded emit
"""
response = None
if self.os_updates_supported:
response = self.bus.wait_for_response(message.forward(
"neon.device_updater.check_update",
{'include_prerelease': self.include_prerelease}), timeout=15)
response = response or self.bus.wait_for_response(
message.forward("neon.core_updater.check_update",
{'include_prerelease': self.include_prerelease}),
timeout=15)
if response:
LOG.debug(f"Got response: {response.data}")
self.current_ver = response.data.get("installed_version")
self.latest_ver = response.data.get("latest_version") or \
response.data.get("new_version")
if not self.latest_ver:
LOG.error(f"Expected string version and got none in response: "
f"{response.data}")
elif self.latest_ver != self.current_ver and \
self.notify_updates and \
message.msg_type in ("mycroft.ready", "neon.update.check"):
text = self.dialog_renderer.render(
"notify_update_available",
{"version": self.latest_ver})
LOG.info("Update Available")
callback_data = {**message.data, **{"notification": text}}
self.gui.show_notification(text,
action="update.gui.install_update",
callback_data=callback_data)
else:
LOG.error("No response from updater plugin")
def pronounce_version(self, version: str):
"""
Format a version spec into a speakable string
"""
if version is None:
raise ValueError("Expected string but got None")
if 'a' in version:
version = version.replace(
'a', f' {self.resources.render_dialog("alpha")} ')
if 'b' in version:
version = version.replace(
'b', f' {self.resources.render_dialog("beta")} ')
if '.' in version:
version = version.replace(
'.', f' {self.resources.render_dialog("point")} ')
return version
@intent_handler("update_device.intent")
def handle_update_device(self, message):
"""
Handle a user request to check for updates.
:param message: message object associated with request
"""
if self._updating:
LOG.warning("Requested update while already in-progress")
self.speak_dialog("update_in_progress")
return
# Explicitly enabled for initramfs checks that involve file downloads
if get_user_prefs(message)['response_mode'].get('hesitation'):
self.speak_dialog("check_updates")
initramfs_available = False
squashfs_available = False
new_core_ver = None
new_os_ver = None
if self.check_initramfs:
initramfs_available = self._check_initramfs_update(message)
LOG.info(f"initramfs_available={initramfs_available}")
if self.check_squashfs:
meta = self._check_squashfs_update(message)
if isinstance(meta, dict):
# Core version since it matches old behavior and is more variable
new_core_ver = meta.get("core", {}).get("version", "")
new_os_ver = meta.get(
'build_version') or meta.get("image", {}).get("version", "")
squashfs_available = True
LOG.info(f"squashfs_available={squashfs_available}")
if initramfs_available or squashfs_available:
if squashfs_available and (new_os_ver or new_core_ver):
if new_os_ver:
resp = self.ask_yesno(
"update_os",
{"version": self.pronounce_version(new_os_ver)})
elif new_core_ver != self.current_ver:
# New squashFS image with newer core package
resp = self.ask_yesno(
"update_core",
{"old": self.pronounce_version(self.current_ver),
"new": self.pronounce_version(new_core_ver)})
else:
# New squashFS image without newer core package
resp = self.ask_yesno("update_system")
else:
resp = self.ask_yesno("update_system")
if resp == "yes":
self._updating = True
self.speak_dialog("starting_update", wait=True)
self.gui.show_controlled_notification(
self.resources.render_dialog("notify_downloading_update"))
track = "dev" if self.include_prerelease else "master"
if initramfs_available:
LOG.info("Updating initramfs")
# Force update since we already checked for updates
resp = self.bus.wait_for_response(
message.forward("neon.update_initramfs",
{"force_update": True,
"track": track}), timeout=60)
if not resp:
LOG.error(f"initramfs update timeout")
self.speak_dialog("error_updating_os",
{"help": self.resources.render_dialog(
"help_support")})
self.gui.remove_controlled_notification()
self._updating = False
return
if resp.data.get("updated"):
LOG.info("initramfs updated")
self.speak_dialog("update_initramfs_success")
elif resp.data.get("error"):
LOG.warning(f"Error response: {resp.data}")
self.speak_dialog("error_updating_os",
{"help": self.resources.render_dialog(
"help_support")})
self.gui.remove_controlled_notification()
self._updating = False
return
else:
LOG.warning(f"Expected initramfs update: {resp.data}")
if squashfs_available:
self.speak_dialog("update_continuing")
else:
self._updating = False
self.speak_dialog("up_to_date",
{"version": self.pronounce_version(
self.current_ver)})
if squashfs_available:
self._download_completed.clear()
LOG.info("Updating squashfs")
self.add_event("neon.update_squashfs.response",
self._handle_download_completed, once=True)
self.bus.emit(message.forward("neon.update_squashfs",
{"track": track}))
while not self._download_completed.wait(
self._download_check_interval):
download_state_resp = (
self.bus.wait_for_response(message.forward(
"neon.device_updater.get_download_status")))
if download_state_resp and \
download_state_resp.data.get("downloading"):
LOG.debug("Still downloading")
elif download_state_resp and not \
download_state_resp.data.get("downloading"):
LOG.info(f"No active download")
sleep(1) # pad to ensure completed event is handled
if not self._download_completed.is_set():
LOG.error(f"Download completion not handled!")
self._handle_download_failure()
return
elif not download_state_resp:
# This could also be an older version of the plugin
LOG.error(f"No response from updater plugin")
self._handle_download_failure()
return
else:
self.gui.remove_controlled_notification()
else:
# User declined update
self.speak_dialog("not_updating")
elif self.check_python:
# OS Updates not supported
self._check_package_update(message)
else:
# OS already up to date
self.speak_dialog("up_to_date",
{"version": self.pronounce_version(
self.current_ver)})
def _handle_download_failure(self):
"""
Handle update download failure. Speak error and clean up.
"""
self.speak_dialog("error_updating_os",
{"help": self.resources.render_dialog(
"help_online")})
self.gui.remove_controlled_notification()
self.remove_event("neon.update_squashfs.response")
self._download_completed.set()
self._updating = False
def _handle_download_completed(self, message):
"""
Handle update download completed. Speak success or error and restart to
apply a successful update.
@param message: `neon.update_squashfs.response` Message
"""
self._download_completed.set()
self.gui.remove_controlled_notification()
self._write_update_signal("squashfs")
if message.data.get("new_version"):
LOG.info("squashfs updated")
self.speak_dialog("update_restarting", wait=True)
self.bus.emit(message.forward("system.reboot"))
else:
error = message.data.get("error") or message.data
LOG.error(f"squashfs update failed: {error}")
self.speak_dialog("error_updating_os", {"help": ""})
self.gui.remove_controlled_notification()
self._updating = False
def _check_initramfs_update(self, message) -> bool:
"""
Check for an updated initramfs image
"""
resp = self.bus.wait_for_response(message.forward(
"neon.check_update_initramfs",
{"track": "dev" if self.include_prerelease else "master"}),
timeout=10)
if resp and resp.data.get("update_available"):
LOG.info(f"Initramfs update available: {resp.data}")
return True
LOG.debug("No initramfs update")
return False
def _check_squashfs_update(self, message) -> Optional[dict]:
"""
Check for an updated squashfs image
@return: Dict metadata for new update if available, else None
"""
resp = self.bus.wait_for_response(message.forward(
"neon.check_update_squashfs",
{"track": "dev" if self.include_prerelease else "master"}),
timeout=10)
if resp and resp.data.get("update_available"):
LOG.info(f"Squashfs update available ({resp.data.get('track')})")
meta = resp.data.get('update_metadata', dict())
return meta
elif resp:
LOG.debug(f"No Squashfs update (track={resp.data.get('track')}")
return None
def _check_package_update(self, message):
self._check_latest_release(message)
if not all((self.current_ver, self.latest_ver)):
self.speak_dialog("check_error")
return
# TODO: Support alternate update sources?
if not is_connected_http("https://github.com"):
LOG.warning(f"GitHub not available. Skipping update")
self.speak_dialog("error_offline")
return
if self.current_ver == self.latest_ver:
self.speak_dialog(
"up_to_date",
{"version": self.pronounce_version(self.current_ver)},
wait=True)
resp = self.ask_yesno("ask_update_anyways")
else:
resp = self.ask_yesno(
"update_core",
{"new": self.pronounce_version(self.latest_ver),
"old": self.pronounce_version(self.current_ver)})
if resp == "yes":
if message.data.get('notification'):
self._dismiss_notification(message)
self._write_update_signal(self.latest_ver)
self.speak_dialog("starting_update", wait=True)
self.bus.emit(message.forward("neon.core_updater.start_update",
{"version": self.latest_ver}))
else:
self.speak_dialog("not_updating")
def _write_update_signal(self, new_ver: str):
"""
Write a file with the version being updated to that can be checked upon
next boot
:param new_ver: New core version being updated to
"""
with self.file_system.open(self._update_filename, 'w+') as f:
f.write(new_ver)
def _check_update_status(self) -> Optional[bool]:
"""
Check if an update was completed on startup.
Returns:
None if no update was attempted
True if an update was successful
False if an update failed
"""
update_filepath = os.path.join(self.file_system.path,
self._update_filename)
if not os.path.exists(update_filepath):
return None
with open(update_filepath, 'r') as f:
expected_ver = f.read()
os.remove(update_filepath)
LOG.info(f"Removed update signal at {update_filepath}")
if expected_ver == "squashfs":
LOG.info("Updated squashFS")
return True
if self.current_ver != expected_ver:
LOG.error(f"Update expected {expected_ver} but "
f"{self.current_ver} is installed")
return False
return True
@intent_handler("core_version.intent")
def handle_core_version(self, message):
"""
Handle a user request for the current installed version.
:param message: message object associated with request
"""
self._check_latest_release(message)
version = self.pronounce_version(self.current_ver)
LOG.debug(version)
self.speak_dialog("core_version", {"version": version})
@intent_handler("update_configuration.intent")
def handle_update_configuration(self, message):
"""
Handle a user request to update default configuration
:param message: message object associated with request
"""
resp = self.ask_yesno("ask_update_configuration")
if resp == "yes":
self.speak_dialog("starting_update", wait=True)
self.bus.emit(message.forward("neon.update_config",
{"skill_config": True,
"core_config": True}))
else:
self.speak_dialog("not_updating")
@intent_handler(IntentBuilder("CreateOSMediaIntent").require("create")
.require("os").require("media").build())
def handle_create_os_media(self, message):
"""
Handle a user request to create a new bootable drive
:param message: message object associated with request
"""
resp = self.ask_yesno("ask_download_image")
if resp == "yes":
self.add_event("neon.download_os_image.complete",
self.on_download_complete, once=True)
self.speak_dialog("downloading_image")
self.bus.emit(message.forward("neon.download_os_image",
{"url": self.image_url}))
self.speak_dialog("drive_instructions")
self.gui.show_controlled_notification(
self.resources.render_dialog("notify_downloading_os"))
else:
self.speak_dialog("not_updating")
@intent_handler(IntentBuilder("SwitchUpdateTrackIntent").require("change")
.one_of("stable", "beta").require("updates").build())
def handle_switch_update_track(self, message):
"""
Handle a user request to change to beta or stable release tracks
:param message: message object associated with request
"""
include_prereleases = True if message.data.get('beta') else False
LOG.debug(f"Update to include_prerelease={include_prereleases}")
if include_prereleases:
update_track = self.resources.render_dialog("word_beta")
else:
update_track = self.resources.render_dialog("word_stable")
if include_prereleases == self.settings.get("include_prerelease"):
# Already explicitly configured in settings
self.speak_dialog("update_track_already_set",
{"track": update_track})
return
resp = self.ask_yesno("ask_change_update_track",
{"track": update_track})
if resp == "yes":
self.include_prerelease = include_prereleases
self.speak_dialog("confirm_change_update_track",
{"track": update_track})
self._check_latest_release(
message.forward("neon.update.check"))
else:
if self.include_prerelease:
update_track = self.resources.render_dialog("word_beta")
else:
update_track = self.resources.render_dialog("word_stable")
self.speak_dialog("confirm_no_change_update_track",
{"track": update_track})
def on_download_complete(self, message):
"""
After `handle_create_os_media`, this method will be called with the OS
image download status. Displays a notification for the user to interact
with to continue installation.
:param message: message object associated with download completion
"""
self.gui.remove_controlled_notification()
if message.data.get("success"):
LOG.info(f"Showing Download Complete Notification")
text = self.resources.render_dialog("notify_download_complete")
self.gui.show_notification(
content=text,
action="update.gui.continue_installation",
callback_data={**message.data, **{"notification": text}})
else:
LOG.info(f"Showing Download Failed Notification")
text = self.resources.render_dialog("notify_download_failed")
self.gui.show_notification(content=text,
style="error",
callback_data={**message.data,
**{"notification": text}})
def continue_os_installation(self, message):
"""
After the user interacts with the completed download notification,
prompt confirmation to clear data
:param message: message object associated with notification interaction
"""
self._dismiss_notification(message)
image_file = message.data.get("image_file")
# TODO: Prompt user to select which device?
confirm_number = randint(100, 999)
LOG.debug(str(confirm_number))
validator = numeric_confirmation_validator(str(confirm_number))
resp = self.get_response('ask_overwrite_drive',
{'confirm': str(confirm_number)},
validator)
if resp:
self.speak_dialog("starting_installation")
self.add_event("neon.install_os_image.complete",
self.on_write_complete, once=True)
self.bus.emit(message.forward("neon.install_os_image",
{"device": self.image_drive,
"image_file": image_file}))
self.bus.emit(message.forward(
"ovos.notification.api.set.controlled",
{"sender": self.skill_id,
"text": self.resources.render_dialog("notify_writing_image")}))
else:
self.speak_dialog("not_updating")
def on_write_complete(self, message):
"""
After `continue_os_installation`, this method will be called with the
image write status. Displays a notification telling the user they may
restart and use the new image.
"""
self.bus.emit(message.forward(
"ovos.notification.api.remove.controlled"))
if message.data.get("success"):
LOG.info("Showing Write Complete Notification")
text = self.resources.render_dialog("notify_installation_complete")
self.gui.show_notification(content=text,
action="update.gui.finish_installation",
callback_data={**message.data,
**{"notification": text}})
else:
error = message.data.get("error") or "error_unknown"
# `no_valid_device`, `no_image_file`, something else
LOG.info(f"Showing Write Failed Notification: {error}")
text = self.resources.render_dialog("notify_installation_failed", {
"error": self.resources.render_dialog(error)})
self.gui.show_notification(content=text,
action="update.gui.finish_installation",
style="error",
callback_data={**message.data,
**{"notification": text}})
def finish_os_installation(self, message):
"""
After the user interacts with the installation complete message, speak
an error if installation failed or else speak instructions before
shutting down.
"""
self._dismiss_notification(message)
if not message.data.get("success"):
self.speak_dialog("error_installing_os")
else:
self.speak_dialog("installation_complete", wait=True)
self.bus.emit(message.forward("system.shutdown"))
def _dismiss_notification(self, message):
"""
Dismiss the notification the user interacted with to trigger a callback.
"""
LOG.debug(f"Clearing notification: {message.data}")
self.bus.emit(message.forward(
"ovos.notification.api.storage.clear.item",
{"notification": {"sender": self.skill_id,
"text": message.data.get("notification")}}))