subiquity/system_setup/server/controllers/configure.py

255 lines
11 KiB
Python

# Copyright 2020 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/>.
import os
import shutil
import logging
import re
import apt
import apt_pkg
from subiquity.common.errorreport import ErrorReportKind
from subiquity.common.types import ApplicationState
from subiquity.common.resources import get_users_and_groups
from subiquity.server.controller import SubiquityController
from subiquitycore.context import with_context
from subiquitycore.utils import arun_command
from system_setup.common.wsl_conf import wsl_config_update
log = logging.getLogger("system_setup.server.controllers.configure")
class ConfigureController(SubiquityController):
def __init__(self, app):
super().__init__(app)
self.app = app
self.model = app.base_model
def start(self):
self.install_task = self.app.aio_loop.create_task(self.configure())
def _update_locale_gen(self, localeGenPath, lang):
""" Uncomments the line in locale.gen file where lang is found,
if found commented. A fully qualified language is expected,
since that would have passed thru the Locale
controller validation. e.g. en_UK.UTF-8. """
fileContents: str
locGenNeedsWrite = False
with open(localeGenPath, "r") as f:
fileContents = f.read()
lineFound = fileContents.find(lang)
if lineFound == -1:
# An unsupported locale coming from our UI is a bug
raise AssertionError("Selected language {} not supported."
.format(lang))
pattern = r'#+\s*({}.*)'.format(lang)
commented = re.compile(pattern)
(fileContents, n) = commented.subn(r'\1', fileContents, count=1)
locGenNeedsWrite = n == 1
if locGenNeedsWrite:
with open(localeGenPath, "wt") as f:
f.write(fileContents)
async def _install_check_lang_support_packages(self, lang, env):
""" Installs any packages recommended by
check-language-support command. """
clsCommand = "check-language-support"
cp = await arun_command([clsCommand, "-l", lang[0:5]], env=env)
if cp.returncode != 0:
log.error('Command \"%s\" failed with return code %d',
cp.args, cp.returncode)
return
packages = cp.stdout.strip('\n').split(' ')
if len(packages) == 0:
log.debug("%s didn't recommend any packages. Nothing to do.",
clsCommand)
return
cache = apt.Cache()
if self.app.opts.dry_run:
for package in packages:
# Downloading instead of installing. Doesn't require root.
packs_dir = os.path.join(self.model.root,
apt_pkg.config
.find_dir("Dir::Cache::Archives")[1:])
cmd = ["wget", cache[package].candidate.uri, "-O", packs_dir]
os.makedirs(packs_dir, exist_ok=True)
await arun_command(cmd, env=env)
else:
cache.update()
cache.open(None)
with cache.actiongroup():
for package in packages:
cache[package].mark_install()
cache.commit()
async def _activate_locale(self, lang, env):
""" Final commands to run for locale support """
cmds = [["locale-gen"],
["update-locale", "LANG={}".format(lang)]]
if self.app.opts.dry_run:
for cmd in cmds:
# TODO Figure out about mocks.
# It would be good if they offered a -P prefix option,
# but they don't.
# Chroot'ing is not an option.
log.debug('Would run: %s', ' '.join(cmd))
else:
for cmd in cmds:
cp = await arun_command(cmd, env=env)
if cp.returncode != 0:
raise SystemError('Command {} failed with return code {}'
.format(cp.args, cp.returncode))
@with_context(
description="final system configuration", level="INFO",
childlevel="DEBUG")
async def configure(self, *, context):
context.set('is-install-context', True)
try:
self.app.update_state(ApplicationState.WAITING)
await self.model.wait_install()
self.app.update_state(ApplicationState.NEEDS_CONFIRMATION)
self.app.update_state(ApplicationState.RUNNING)
await self.model.wait_postinstall()
self.app.update_state(ApplicationState.POST_WAIT)
# TODO WSL:
# 1. Use self.model to get all data to commit
# 2. Write directly (without wsl utilities) to wsl.conf and other
# fstab files
# 3. If not in reconfigure mode: create User, otherwise just write
# wsl.conf files.
# This must not use subprocesses.
# If dry-run: write in .subiquity
self.app.update_state(ApplicationState.POST_RUNNING)
localeGenPath = "/etc/locale.gen"
dryrun = self.app.opts.dry_run
variant = self.app.variant
root_dir = self.model.root
username = None
if variant == "wsl_setup":
wsl_id = self.model.identity.user
username = wsl_id.username
create_user_base = []
assign_grp_base = []
usergroups_list = get_users_and_groups()
lang = self.model.locale.selected_language
if dryrun:
log.debug("creating a mock-up env for user %s", username)
# creating folders and files for dryrun
etc_dir = os.path.join(root_dir, "etc")
os.makedirs(etc_dir, exist_ok=True)
home_dir = os.path.join(root_dir, "home")
os.makedirs(home_dir, exist_ok=True)
pseudo_files = ["passwd", "shadow", "gshadow", "group",
"subgid", "subuid"]
# locale
testLocGenPath = os.path.join(etc_dir,
os.path
.basename(localeGenPath))
shutil.copy(localeGenPath, testLocGenPath)
shutil.copy(localeGenPath,
"{}-".format(testLocGenPath))
# After copies are done, overwrite the original path
# because there is code outside of this 'if'
# depending on 'localeGenPath' being initialized.
localeGenPath = testLocGenPath
for file in pseudo_files:
filepath = os.path.join(etc_dir, file)
open(filepath, "a").close()
# mimic groupadd
group_id = 1000
for group in usergroups_list:
group_filepath = os.path.join(etc_dir, "group")
gshadow_filepath = os.path.join(etc_dir, "gshadow")
shutil.copy(group_filepath,
"{}-".format(group_filepath))
with open(group_filepath, "a") as group_file:
group_file.write("{}:x:{}:\n".
format(group, group_id))
group_id += 1
shutil.copy(gshadow_filepath,
"{}-".format(gshadow_filepath))
with open(gshadow_filepath, "a") as gshadow_file:
gshadow_file.write("{}:!::\n".format(group))
create_user_base = ["-P", root_dir]
assign_grp_base = ["-P", root_dir]
env = os.environ.copy()
self._update_locale_gen(localeGenPath, lang)
await self._install_check_lang_support_packages(lang, env)
await self._activate_locale(lang, env)
create_user_cmd = ["useradd"] + create_user_base + \
["-m", "-s", "/bin/bash",
"-c", wsl_id.realname,
"-p", wsl_id.password, username]
assign_grp_cmd = ["usermod"] + assign_grp_base + \
["-a", "-G", ",".join(usergroups_list),
username]
create_user_proc = await arun_command(create_user_cmd)
if create_user_proc.returncode != 0:
raise Exception("Failed to create user %s: %s"
% (username, create_user_proc.stderr))
log.debug("created user %s", username)
assign_grp_proc = await arun_command(assign_grp_cmd)
if assign_grp_proc.returncode != 0:
raise Exception(("Failed to assign group to user %s: %s")
% (username, assign_grp_proc.stderr))
else:
wsl_config_update(self.model.wslconfadvanced.wslconfadvanced,
root_dir)
# update advanced config when it is in autoinstall mode
if self.app.opts.autoinstall is not None and \
self.model.wslconfadvanced.wslconfadvanced is not None:
wsl_config_update(self.model.wslconfadvanced.wslconfadvanced,
root_dir)
wsl_config_update(self.model.wslconfbase.wslconfbase, root_dir,
default_user=username)
self.app.update_state(ApplicationState.DONE)
except Exception:
kw = {}
self.app.make_apport_report(
ErrorReportKind.INSTALL_FAIL, "configuration failed", **kw)
raise
def stop_uu(self):
# This is a no-op to allow Shutdown controller to depend on this one
pass