daemon_config.cpp

/*
 * Copyright (C) Canonical, Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 3.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include "daemon_config.h"

#include "custom_image_host.h"
#include "ubuntu_image_host.h"

#include <multipass/client_cert_store.h>
#include <multipass/constants.h>
#include <multipass/default_vm_blueprint_provider.h>
#include <multipass/logging/log.h>
#include <multipass/logging/standard_logger.h>
#include <multipass/name_generator.h>
#include <multipass/platform.h>
#include <multipass/ssh/openssh_key_provider.h>
#include <multipass/ssl_cert_provider.h>
#include <multipass/standard_paths.h>
#include <multipass/utils.h>

#include <QString>
#include <QSysInfo>
#include <QUrl>

#include <chrono>
#include <memory>
#include <optional>

namespace mp = multipass;
namespace mpl = multipass::logging;

namespace
{
constexpr auto manifest_ttl = std::chrono::minutes{5};

std::string server_name_from(const std::string& server_address)
{
    auto tokens = mp::utils::split(server_address, ":");
    const auto server_name = tokens[0];

    if (server_name == "unix")
        return "localhost";
    return server_name;
}

std::unique_ptr<QNetworkProxy> discover_http_proxy()
{
    std::unique_ptr<QNetworkProxy> proxy_ptr{nullptr};

    QString http_proxy{qgetenv("http_proxy")};
    if (http_proxy.isEmpty())
    {
        // Some OS's are case sensitive
        http_proxy = qgetenv("HTTP_PROXY");
    }

    if (!http_proxy.isEmpty())
    {
        if (!http_proxy.contains("://"))
        {
            http_proxy.prepend("http://");
        }

        QUrl proxy_url{http_proxy};
        const auto host = proxy_url.host();
        const auto port = proxy_url.port();

        auto network_proxy = QNetworkProxy(QNetworkProxy::HttpProxy, host, static_cast<quint16>(port),
                                           proxy_url.userName(), proxy_url.password());

        QNetworkProxy::setApplicationProxy(network_proxy);

        proxy_ptr = std::make_unique<QNetworkProxy>(network_proxy);
    }

    return proxy_ptr;
}
} // namespace

mp::DaemonConfig::~DaemonConfig()
{
    mpl::set_logger(nullptr);
}

std::unique_ptr<const mp::DaemonConfig> mp::DaemonConfigBuilder::build()
{
    // Install logger as early as possible
    if (logger == nullptr)
        logger = platform::make_logger(verbosity_level);
    // Fallback when platform does not have a logger
    if (logger == nullptr)
        logger = std::make_unique<mpl::StandardLogger>(verbosity_level);

    auto multiplexing_logger = std::make_shared<mpl::MultiplexingLogger>(std::move(logger));
    mpl::set_logger(multiplexing_logger);

    auto storage_path = MP_PLATFORM.multipass_storage_location();
    if (!storage_path.isEmpty())
        MP_UTILS.make_dir(storage_path, QFileDevice::ReadOwner | QFileDevice::WriteOwner | QFileDevice::ExeOwner);

    if (cache_directory.isEmpty())
    {
        if (!storage_path.isEmpty())
            cache_directory = MP_UTILS.make_dir(storage_path, "cache");
        else
            cache_directory = MP_STDPATHS.writableLocation(StandardPaths::CacheLocation);
    }
    if (data_directory.isEmpty())
    {
        if (!storage_path.isEmpty())
            data_directory = MP_UTILS.make_dir(storage_path, "data");
        else
            data_directory = MP_STDPATHS.writableLocation(StandardPaths::AppDataLocation);
    }

    if (url_downloader == nullptr)
        url_downloader = std::make_unique<URLDownloader>(cache_directory, std::chrono::seconds{10});
    if (factory == nullptr)
        factory = platform::vm_backend(data_directory);
    if (update_prompt == nullptr)
        update_prompt = platform::make_update_prompt();
    if (image_hosts.empty())
    {
        image_hosts.push_back(
            std::make_unique<mp::CustomVMImageHost>(QSysInfo::currentCpuArchitecture(), url_downloader.get()));
        image_hosts.push_back(std::make_unique<mp::UbuntuVMImageHost>(
            std::vector<std::pair<std::string, UbuntuVMImageRemote>>{
                {mp::release_remote, UbuntuVMImageRemote{"https://cloud-images.ubuntu.com/", "releases/",
                                                         std::make_optional<QString>(mp::mirror_key)}},
                {mp::daily_remote, UbuntuVMImageRemote{"https://cloud-images.ubuntu.com/", "daily/",
                                                       std::make_optional<QString>(mp::mirror_key)}},
                {mp::snapcraft_remote, UbuntuVMImageRemote{"https://cloud-images.ubuntu.com/", "buildd/daily/",
                                                           std::make_optional<QString>(mp::mirror_key)}},
                {mp::appliance_remote, UbuntuVMImageRemote{"https://cdimage.ubuntu.com/", "ubuntu-core/appliances/"}}},
            url_downloader.get()));
    }
    if (vault == nullptr)
    {
        std::vector<VMImageHost*> hosts;
        for (const auto& image : image_hosts)
        {
            hosts.push_back(image.get());
        }

        vault = factory->create_image_vault(
            hosts, url_downloader.get(), MP_UTILS.make_dir(cache_directory, factory->get_backend_directory_name()),
            mp::utils::backend_directory_path(data_directory, factory->get_backend_directory_name()), days_to_expire);
    }
    if (name_generator == nullptr)
        name_generator = mp::make_default_name_generator();
    if (server_address.empty())
        server_address = platform::default_server_address();
    if (ssh_key_provider == nullptr)
        ssh_key_provider = std::make_unique<OpenSSHKeyProvider>(data_directory);
    if (cert_provider == nullptr)
        cert_provider = std::make_unique<mp::SSLCertProvider>(MP_UTILS.make_dir(data_directory, "certificates"),
                                                              server_name_from(server_address));
    if (client_cert_store == nullptr)
        client_cert_store = std::make_unique<mp::ClientCertStore>(data_directory);
    if (ssh_username.empty())
        ssh_username = "ubuntu";

    if (network_proxy == nullptr)
        network_proxy = discover_http_proxy();

    if (blueprint_provider == nullptr)
    {
        auto blueprint_provider_url = MP_PLATFORM.get_blueprints_url_override();

        if (!blueprint_provider_url.isEmpty())
            blueprint_provider = std::make_unique<DefaultVMBlueprintProvider>(
                QUrl(blueprint_provider_url), url_downloader.get(), cache_directory, manifest_ttl);
        else
            blueprint_provider =
                std::make_unique<DefaultVMBlueprintProvider>(url_downloader.get(), cache_directory, manifest_ttl);
    }

    return std::unique_ptr<const DaemonConfig>(new DaemonConfig{
        std::move(url_downloader), std::move(factory), std::move(image_hosts), std::move(vault),
        std::move(name_generator), std::move(ssh_key_provider), std::move(cert_provider), std::move(client_cert_store),
        std::move(update_prompt), multiplexing_logger, std::move(network_proxy), std::move(blueprint_provider),
        cache_directory, data_directory, server_address, ssh_username, image_refresh_timer});
}