summaryrefslogtreecommitdiffstats
path: root/src/manager-lib/plugincontainer.cpp
blob: 63a8792a44cdaa030303a7a3326027e3248ed72b (plain)
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
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#include <functional>
#include <utilities.h>
#include <application.h>
#include "plugincontainer.h"
#include "debugwrapper.h"
#include "sudo.h"
#include "unixsignalhandler.h"

using namespace Qt::StringLiterals;

QT_BEGIN_NAMESPACE_AM

PluginContainerManager::PluginContainerManager(ContainerManagerInterface *managerInterface, QObject *parent)
    : AbstractContainerManager(managerInterface->identifier(), parent)
    , m_interface(managerInterface)
    , m_helpers(new PluginContainerHelperFunctions)
{
}

PluginContainerManager::~PluginContainerManager()
{
    delete m_interface;
}

bool PluginContainerManager::initialize()
{
    return m_interface->initialize(m_helpers.get());
}

QString PluginContainerManager::defaultIdentifier()
{
    return u"invalid-plugin"_s;
}

bool PluginContainerManager::supportsQuickLaunch() const
{
    return m_interface->supportsQuickLaunch();
}

AbstractContainer *PluginContainerManager::create(Application *app, QVector<int> &&stdioRedirections,
                                                  const QMap<QString, QString> &debugWrapperEnvironment,
                                                  const QStringList &debugWrapperCommand)
{
    // stdioRedirections should really be changed to 'move', but we would break the plugin API.
    auto containerInterface = m_interface->create(app == nullptr, stdioRedirections,
                                                  debugWrapperEnvironment, debugWrapperCommand);
    if (!containerInterface) {
        closeAndClearFileDescriptors(stdioRedirections);
        return nullptr;
    }
    return new PluginContainer(this, app, containerInterface, !debugWrapperCommand.isEmpty());
}

void PluginContainerManager::setConfiguration(const QVariantMap &configuration)
{
    AbstractContainerManager::setConfiguration(configuration);
    m_interface->setConfiguration(configuration);
}


PluginContainer::~PluginContainer()
{ }

QString PluginContainer::controlGroup() const
{
    return m_interface->controlGroup();
}

bool PluginContainer::setControlGroup(const QString &groupName)
{
    return m_interface->setControlGroup(groupName);
}

bool PluginContainer::setProgram(const QString &program)
{
    if (AbstractContainer::setProgram(program))
        return m_interface->setProgram(program);
    return false;
}

void PluginContainer::setBaseDirectory(const QString &baseDirectory)
{
    AbstractContainer::setBaseDirectory(baseDirectory);
    m_interface->setBaseDirectory(baseDirectory);
}

bool PluginContainer::isReady()
{
    return m_interface->isReady();
}

bool PluginContainer::hasDebugWrapper() const
{
    return m_hasDebugWrapper;
}

QString PluginContainer::mapContainerPathToHost(const QString &containerPath) const
{
    return m_interface->mapContainerPathToHost(containerPath);
}

QString PluginContainer::mapHostPathToContainer(const QString &hostPath) const
{
    return m_interface->mapHostPathToContainer(hostPath);
}

AbstractContainerProcess *PluginContainer::start(const QStringList &arguments, const QMap<QString, QString> &env,
                                                 const QVariantMap &amConfig)
{
    if (m_startCalled)
        return nullptr;

    if (m_interface->start(arguments, env, amConfig)) {
        m_startCalled = true;
        return m_process;
    }
    return nullptr;
}

PluginContainer::PluginContainer(AbstractContainerManager *manager, Application *app,
                                 ContainerInterface *containerInterface, bool hasDebugWrapper)
    : AbstractContainer(manager, app)
    , m_interface(containerInterface)
    , m_hasDebugWrapper(hasDebugWrapper)
{
    m_process = new PluginContainerProcess(this);
    m_process->setParent(this);

    connect(containerInterface, &ContainerInterface::ready, this, &PluginContainer::ready);
    connect(containerInterface, &ContainerInterface::started, m_process, &PluginContainerProcess::started);
    connect(containerInterface, &ContainerInterface::errorOccured,
            m_process, [this](ContainerInterface::ProcessError processError) {
        emit m_process->errorOccured(static_cast<Am::ProcessError>(processError));
    });
    connect(containerInterface, &ContainerInterface::finished,
            m_process, [this](int exitCode, ContainerInterface::ExitStatus exitStatus) {
        emit m_process->finished(exitCode, static_cast<Am::ExitStatus>(exitStatus));
    });
    connect(containerInterface, &ContainerInterface::stateChanged,
            m_process, [this](ContainerInterface::RunState newState) {
        emit m_process->stateChanged(static_cast<Am::RunState>(newState));
    });
    connect(this, &AbstractContainer::applicationChanged, this, [this]() {
        m_interface->attachApplication(application()->info()->toVariantMap());
    });
    if (application())
        containerInterface->attachApplication(application()->info()->toVariantMap());
}

PluginContainerProcess::PluginContainerProcess(PluginContainer *container)
    : AbstractContainerProcess()
    , m_container(container)
{ }

qint64 PluginContainerProcess::processId() const
{
    return m_container->m_interface->processId();
}

Am::RunState PluginContainerProcess::state() const
{
    return static_cast<Am::RunState>(m_container->m_interface->state());
}

void PluginContainerProcess::stop(Am::ExitStatus exitStatus)
{
    m_container->m_interface->stop(static_cast<ContainerInterface::ExitStatus>(exitStatus));
}

void PluginContainerHelperFunctions::closeAndClearFileDescriptors(QVector<int> &fdList)
{
    ::QtAM::closeAndClearFileDescriptors(fdList);
}

QStringList PluginContainerHelperFunctions::substituteCommand(const QStringList &debugWrapperCommand,
                                                              const QString &program,
                                                              const QStringList &arguments)
{
    return DebugWrapper::substituteCommand(debugWrapperCommand, program, arguments);
}

bool PluginContainerHelperFunctions::hasRootPrivileges()
{
    return SudoClient::instance() && !SudoClient::instance()->isFallbackImplementation();
}

void PluginContainerHelperFunctions::bindMountFileSystem(const QString &from, const QString &to,
                                                         bool readOnly, quint64 namespacePid)
{
    auto sudo = SudoClient::instance();
    if (sudo && !sudo->isFallbackImplementation()) {
        if (!sudo->bindMountFileSystem(from, to, readOnly, namespacePid))
            throw std::runtime_error(sudo->lastError().toLocal8Bit());
    } else {
        throw std::runtime_error("Cannot call bindMountFileSystem: root privileges are required. Run appman via 'sudo' or 'chmod +s'.");
    }
}

int PluginContainerHelperFunctions::watchdogSignal()
{
    return UnixSignalHandler::watchdogSignal();
}

QString PluginContainerHelperFunctions::checkDBusSocketPath(const QString &dbusAddress, const QByteArray &typeHint)
{
    // parse the actual socket file name from the DBus address specification
    QString socketPath = dbusAddress;
    socketPath = socketPath.mid(socketPath.indexOf(u'=') + 1);
    socketPath = socketPath.left(socketPath.indexOf(u','));
    QFileInfo socketInfo(socketPath);
    if (!socketInfo.exists()) {
        QByteArray err = typeHint + " DBus socket doesn't exist: " + socketPath.toLocal8Bit();
        throw std::runtime_error(err);
    }
    return socketInfo.absoluteFilePath();
}

QString PluginContainerHelperFunctions::checkWaylandSocketPath(const QString &xdgRuntimeDir, const QString &waylandDisplay)
{
    // parse the wayland socket name from wayland env variables
    QString socketPath = xdgRuntimeDir + u'/' + waylandDisplay;
    QFileInfo socketInfo(socketPath);
    if (!socketInfo.exists()) {
        QByteArray err = "Wayland socket doesn't exist: " + socketPath.toLocal8Bit();
        throw std::runtime_error(err);
    }
    return socketInfo.absoluteFilePath();
}

QT_END_NAMESPACE_AM

#include "moc_plugincontainer.cpp"