2015-08-18 16:29:56 +00:00
|
|
|
# Copyright 2015 Canonical, Ltd.
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
|
2016-11-01 23:44:04 +00:00
|
|
|
from abc import ABC, abstractmethod
|
2015-08-18 16:29:56 +00:00
|
|
|
import logging
|
2019-10-31 00:47:30 +00:00
|
|
|
import os
|
2015-08-18 16:29:56 +00:00
|
|
|
|
2016-06-30 18:17:01 +00:00
|
|
|
log = logging.getLogger("subiquitycore.controller")
|
2015-08-18 16:29:56 +00:00
|
|
|
|
|
|
|
|
2016-11-01 23:44:04 +00:00
|
|
|
class BaseController(ABC):
|
2016-07-26 02:16:46 +00:00
|
|
|
"""Base class for controllers."""
|
2015-08-18 16:29:56 +00:00
|
|
|
|
2016-10-10 23:48:28 +00:00
|
|
|
signals = []
|
|
|
|
|
2019-08-06 02:11:57 +00:00
|
|
|
def __init__(self, app):
|
2019-11-18 00:55:43 +00:00
|
|
|
self.name = type(self).__name__[:-len("Controller")]
|
2019-08-06 02:11:57 +00:00
|
|
|
self.ui = app.ui
|
|
|
|
self.signal = app.signal
|
|
|
|
self.opts = app.opts
|
2019-10-31 00:47:30 +00:00
|
|
|
self.debug_flags = ()
|
|
|
|
if self.opts.dry_run:
|
|
|
|
# Recognized flags are:
|
|
|
|
# - install-fail: makes curtin install fail, see
|
|
|
|
# scripts/replay-curtin-log.py
|
|
|
|
# - bpfail-full, bpfail-restricted: makes block probing fail, see
|
|
|
|
# subiquity/controllers/filesystem.py
|
|
|
|
# - copy-logs-fail: makes post-install copying of logs fail, see
|
|
|
|
# subiquity/controllers/installprogress.py
|
|
|
|
self.debug_flags = os.environ.get('SUBIQUITY_DEBUG', '').split(',')
|
2019-08-06 02:11:57 +00:00
|
|
|
self.loop = app.loop
|
|
|
|
self.run_in_bg = app.run_in_bg
|
2019-08-06 02:41:58 +00:00
|
|
|
self.app = app
|
2019-11-18 00:55:43 +00:00
|
|
|
self.answers = app.answers.get(self.name, {})
|
2015-08-18 16:29:56 +00:00
|
|
|
|
|
|
|
def register_signals(self):
|
2016-07-26 02:16:46 +00:00
|
|
|
"""Defines signals associated with controller from model."""
|
2016-09-29 01:52:11 +00:00
|
|
|
signals = []
|
|
|
|
for sig, cb in self.signals:
|
|
|
|
signals.append((sig, getattr(self, cb)))
|
|
|
|
self.signal.connect_signals(signals)
|
2016-09-27 02:33:54 +00:00
|
|
|
|
2019-03-07 02:31:39 +00:00
|
|
|
def start(self):
|
2019-09-03 01:04:47 +00:00
|
|
|
"""Called just before the main loop is started.
|
|
|
|
|
|
|
|
At the time this is called, all controllers and models and so on
|
|
|
|
have been created. This is when the controller should start
|
|
|
|
interacting with the outside world, e.g. probing for network
|
|
|
|
devices or start making connections to the snap store.
|
|
|
|
"""
|
2019-03-07 02:31:39 +00:00
|
|
|
pass
|
|
|
|
|
2016-11-01 23:44:04 +00:00
|
|
|
@abstractmethod
|
|
|
|
def cancel(self):
|
|
|
|
pass
|
|
|
|
|
2019-09-03 01:10:43 +00:00
|
|
|
@property
|
|
|
|
def showing(self):
|
2019-11-18 00:55:43 +00:00
|
|
|
return self.app.controllers.cur is self
|
2019-09-03 01:10:43 +00:00
|
|
|
|
2016-11-01 23:44:04 +00:00
|
|
|
@abstractmethod
|
2019-09-03 01:04:47 +00:00
|
|
|
def start_ui(self):
|
|
|
|
"""Start running this controller's UI.
|
|
|
|
|
|
|
|
This method should call self.ui.set_body.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def end_ui(self):
|
|
|
|
"""Stop running this controller's UI.
|
|
|
|
|
|
|
|
This method doesn't actually need to remove this controller's UI
|
|
|
|
as the next one is about to replace it, it's more of a hook to
|
|
|
|
stop any background tasks that can be stopped when the UI is not
|
|
|
|
running.
|
|
|
|
"""
|
2018-10-29 23:17:29 +00:00
|
|
|
|
2019-03-06 02:52:13 +00:00
|
|
|
def serialize(self):
|
|
|
|
return None
|
|
|
|
|
|
|
|
def deserialize(self, data):
|
|
|
|
if data is not None:
|
|
|
|
raise Exception("missing deserialize method on {}".format(self))
|
|
|
|
|
2018-10-29 23:17:29 +00:00
|
|
|
# Stuff for fine grained actions, used by filesystem and network
|
|
|
|
# controller at time of writing this comment.
|
|
|
|
|
|
|
|
def _enter_form_data(self, form, data, submit, clean_suffix=''):
|
|
|
|
for k, v in data.items():
|
|
|
|
c = getattr(
|
|
|
|
self, '_action_clean_{}_{}'.format(k, clean_suffix), None)
|
|
|
|
if c is None:
|
|
|
|
c = getattr(self, '_action_clean_{}'.format(k), lambda x: x)
|
|
|
|
field = getattr(form, k)
|
|
|
|
from subiquitycore.ui.selector import Selector
|
|
|
|
v = c(v)
|
|
|
|
if isinstance(field.widget, Selector):
|
|
|
|
field.widget._emit('select', v)
|
|
|
|
field.value = v
|
|
|
|
yield
|
|
|
|
yield
|
|
|
|
for bf in form._fields:
|
|
|
|
bf.validate()
|
|
|
|
form.validated()
|
|
|
|
if submit:
|
|
|
|
if not form.done_btn.enabled:
|
|
|
|
raise Exception("answers left form invalid!")
|
|
|
|
form._click_done(None)
|
|
|
|
|
|
|
|
def _run_actions(self, actions):
|
|
|
|
for action in actions:
|
|
|
|
yield from self._answers_action(action)
|
|
|
|
|
2019-02-21 08:45:40 +00:00
|
|
|
def _run_iterator(self, it, delay=None):
|
|
|
|
if delay is None:
|
2019-08-06 02:41:58 +00:00
|
|
|
delay = 0.2/self.app.scale_factor
|
2018-10-29 23:17:29 +00:00
|
|
|
try:
|
|
|
|
next(it)
|
|
|
|
except StopIteration:
|
|
|
|
return
|
|
|
|
self.loop.set_alarm_in(
|
|
|
|
delay,
|
|
|
|
lambda *args: self._run_iterator(it, delay/1.1))
|
2019-03-06 23:03:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
class RepeatedController(BaseController):
|
|
|
|
|
|
|
|
def __init__(self, orig, index):
|
2019-11-18 00:55:43 +00:00
|
|
|
self.name = "{}-{}".format(orig.name, index)
|
2019-03-06 23:03:54 +00:00
|
|
|
self.orig = orig
|
|
|
|
self.index = index
|
|
|
|
|
|
|
|
def register_signals(self):
|
|
|
|
pass
|
|
|
|
|
2019-09-03 01:04:47 +00:00
|
|
|
def start_ui(self):
|
|
|
|
self.orig.start_ui(self.index)
|
2019-03-06 23:03:54 +00:00
|
|
|
|
|
|
|
def cancel(self):
|
|
|
|
self.orig.cancel()
|