wayland_server.cpp 20.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

Copyright (C) 2015 Martin Gräßlin <mgraesslin@kde.org>

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; either version 2 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 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 "wayland_server.h"
21
#include "client.h"
22
#include "platform.h"
23
#include "composite.h"
24
#include "screens.h"
25
#include "shell_client.h"
26
#include "workspace.h"
27

28 29
// Client
#include <KWayland/Client/connection_thread.h>
30
#include <KWayland/Client/event_queue.h>
31
#include <KWayland/Client/registry.h>
32
#include <KWayland/Client/shm_pool.h>
33
#include <KWayland/Client/surface.h>
34
// Server
35
#include <KWayland/Server/compositor_interface.h>
36
#include <KWayland/Server/datadevicemanager_interface.h>
37
#include <KWayland/Server/display.h>
38
#include <KWayland/Server/dpms_interface.h>
39
#include <KWayland/Server/idle_interface.h>
40
#include <KWayland/Server/output_interface.h>
41
#include <KWayland/Server/plasmashell_interface.h>
42
#include <KWayland/Server/plasmawindowmanagement_interface.h>
43
#include <KWayland/Server/qtsurfaceextension_interface.h>
44
#include <KWayland/Server/seat_interface.h>
45
#include <KWayland/Server/server_decoration_interface.h>
46
#include <KWayland/Server/shadow_interface.h>
47
#include <KWayland/Server/subcompositor_interface.h>
48
#include <KWayland/Server/blur_interface.h>
49
#include <KWayland/Server/shell_interface.h>
50 51
#include <KWayland/Server/outputmanagement_interface.h>
#include <KWayland/Server/outputconfiguration_interface.h>
52

53
// Qt
54
#include <QThread>
55 56
#include <QWindow>

57 58 59
// system
#include <sys/types.h>
#include <sys/socket.h>
60
#include <unistd.h>
61

62 63 64
//screenlocker
#include <KScreenLocker/KsldApp>

65 66 67 68 69 70 71 72 73 74
using namespace KWayland::Server;

namespace KWin
{

KWIN_SINGLETON_FACTORY(WaylandServer)

WaylandServer::WaylandServer(QObject *parent)
    : QObject(parent)
{
75
    qRegisterMetaType<KWayland::Server::SurfaceInterface *>("KWayland::Server::SurfaceInterface *");
76
    qRegisterMetaType<KWayland::Server::OutputInterface::DpmsMode>();
77 78

    connect(kwinApp(), &Application::screensCreated, this, &WaylandServer::initOutputs);
79
    connect(kwinApp(), &Application::x11ConnectionChanged, this, &WaylandServer::setupX11ClipboardSync);
80 81
}

82 83 84 85
WaylandServer::~WaylandServer()
{
    destroyInputMethodConnection();
}
86 87

void WaylandServer::destroyInternalConnection()
88
{
89
    emit terminatingInternalClientConnection();
90
    if (m_internalConnection.client) {
91 92
        delete m_internalConnection.registry;
        delete m_internalConnection.shm;
93
        dispatch();
94 95 96
        m_internalConnection.client->deleteLater();
        m_internalConnection.clientThread->quit();
        m_internalConnection.clientThread->wait();
97
        delete m_internalConnection.clientThread;
98
        m_internalConnection.client = nullptr;
99
        m_internalConnection.server->destroy();
100
        m_internalConnection.server = nullptr;
101 102
    }
}
103

104 105 106 107
void WaylandServer::terminateClientConnections()
{
    destroyInternalConnection();
    destroyInputMethodConnection();
108 109 110 111 112
    if (m_display) {
        const auto connections = m_display->connections();
        for (auto it = connections.begin(); it != connections.end(); ++it) {
            (*it)->destroy();
        }
113 114 115
    }
}

116
void WaylandServer::init(const QByteArray &socketName, InitalizationFlags flags)
117
{
118
    m_initFlags = flags;
119 120 121 122 123 124 125
    m_display = new KWayland::Server::Display(this);
    if (!socketName.isNull() && !socketName.isEmpty()) {
        m_display->setSocketName(QString::fromUtf8(socketName));
    }
    m_display->start();
    m_compositor = m_display->createCompositor(m_display);
    m_compositor->create();
126 127 128 129 130 131 132 133
    connect(m_compositor, &CompositorInterface::surfaceCreated, this,
        [this] (SurfaceInterface *surface) {
            // check whether we have a Toplevel with the Surface's id
            Workspace *ws = Workspace::self();
            if (!ws) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
134 135 136 137
            if (surface->client() != xWaylandConnection()) {
                // setting surface is only relevat for Xwayland clients
                return;
            }
138 139 140 141 142 143 144 145
            auto check = [surface] (const Toplevel *t) {
                return t->surfaceId() == surface->id();
            };
            if (Toplevel *t = ws->findToplevel(check)) {
                t->setSurface(surface);
            }
        }
    );
146 147
    m_shell = m_display->createShell(m_display);
    m_shell->create();
148 149
    connect(m_shell, &ShellInterface::surfaceCreated, this,
        [this] (ShellSurfaceInterface *surface) {
150 151 152 153
            if (!Workspace::self()) {
                // it's possible that a Surface gets created before Workspace is created
                return;
            }
154
            if (surface->client() == m_xwayland.client) {
155 156 157
                // skip Xwayland clients, those are created using standard X11 way
                return;
            }
158
            if (surface->client() == m_screenLockerClientConnection) {
159 160
                ScreenLocker::KSldApp::self()->lockScreenShown();
            }
161 162 163 164
            auto client = new ShellClient(surface);
            if (auto c = Compositor::self()) {
                connect(client, &Toplevel::needsRepaint, c, &Compositor::scheduleRepaint);
            }
165 166 167 168 169
            if (client->isInternal()) {
                m_internalClients << client;
            } else {
                m_clients << client;
            }
170 171 172
            if (client->readyForPainting()) {
                emit shellClientAdded(client);
            } else {
173
                connect(client, &ShellClient::windowShown, this, &WaylandServer::shellClientShown);
174
            }
175 176
        }
    );
177
    m_display->createShm();
178 179
    m_seat = m_display->createSeat(m_display);
    m_seat->create();
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
    auto ddm = m_display->createDataDeviceManager(m_display);
    ddm->create();
    connect(ddm, &DataDeviceManagerInterface::dataDeviceCreated, this,
        [this] (DataDeviceInterface *ddi) {
            if (ddi->client() == m_xclipbaordSync.client && m_xclipbaordSync.client != nullptr) {
                m_xclipbaordSync.ddi = QPointer<DataDeviceInterface>(ddi);
                connect(m_xclipbaordSync.ddi.data(), &DataDeviceInterface::selectionChanged, this,
                    [this] {
                        // testing whether the active client inherits Client
                        // it would be better to test for the keyboard focus, but we might get a clipboard update
                        // when the Client is already active, but no Surface is created yet.
                        if (workspace()->activeClient() && workspace()->activeClient()->inherits("KWin::Client")) {
                            m_seat->setSelection(m_xclipbaordSync.ddi.data());
                        }
                    }
                );
            }
        }
    );
199
    m_display->createIdle(m_display)->create();
200 201 202 203 204 205 206 207 208
    m_plasmaShell = m_display->createPlasmaShell(m_display);
    m_plasmaShell->create();
    connect(m_plasmaShell, &PlasmaShellInterface::surfaceCreated,
        [this] (PlasmaShellSurfaceInterface *surface) {
            if (ShellClient *client = findClient(surface->surface())) {
                client->installPlasmaShellSurface(surface);
            }
        }
    );
209 210 211 212 213 214 215 216 217
    m_qtExtendedSurface = m_display->createQtSurfaceExtension(m_display);
    m_qtExtendedSurface->create();
    connect(m_qtExtendedSurface, &QtSurfaceExtensionInterface::surfaceCreated,
        [this] (QtExtendedSurfaceInterface *surface) {
            if (ShellClient *client = findClient(surface->surface())) {
                client->installQtExtendedSurface(surface);
            }
        }
    );
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
    m_windowManagement = m_display->createPlasmaWindowManagement(m_display);
    m_windowManagement->create();
    m_windowManagement->setShowingDesktopState(PlasmaWindowManagementInterface::ShowingDesktopState::Disabled);
    connect(m_windowManagement, &PlasmaWindowManagementInterface::requestChangeShowingDesktop, this,
        [] (PlasmaWindowManagementInterface::ShowingDesktopState state) {
            if (!workspace()) {
                return;
            }
            bool set = false;
            switch (state) {
            case PlasmaWindowManagementInterface::ShowingDesktopState::Disabled:
                set = false;
                break;
            case PlasmaWindowManagementInterface::ShowingDesktopState::Enabled:
                set = true;
                break;
            default:
                Q_UNREACHABLE();
                break;
            }
            if (set == workspace()->showingDesktop()) {
                return;
            }
            workspace()->setShowingDesktop(set);
        }
    );
244 245
    auto shadowManager = m_display->createShadowManager(m_display);
    shadowManager->create();
246 247

    m_display->createDpmsManager(m_display)->create();
248 249 250 251 252 253 254 255 256 257

    m_decorationManager = m_display->createServerSideDecorationManager(m_display);
    connect(m_decorationManager, &ServerSideDecorationManagerInterface::decorationCreated, this,
        [this] (ServerSideDecorationInterface *deco) {
            if (ShellClient *c = findClient(deco->surface())) {
                c->installServerSideDecoration(deco);
            }
        }
    );
    m_decorationManager->create();
258 259 260 261

    m_outputManagement = m_display->createOutputManagement(m_display);
    connect(m_outputManagement, &OutputManagementInterface::configurationChangeRequested,
            this, [this](KWayland::Server::OutputConfigurationInterface *config) {
262
                kwinApp()->platform()->configurationChangeRequested(config);
263
    });
264
    m_outputManagement->create();
265 266

    m_display->createSubCompositor(m_display)->create();
267 268
}

269 270 271 272 273 274 275 276 277 278 279
void WaylandServer::shellClientShown(Toplevel *t)
{
    ShellClient *c = dynamic_cast<ShellClient*>(t);
    if (!c) {
        qCWarning(KWIN_CORE) << "Failed to cast a Toplevel which is supposed to be a ShellClient to ShellClient";
        return;
    }
    disconnect(c, &ShellClient::windowShown, this, &WaylandServer::shellClientShown);
    emit shellClientAdded(c);
}

280 281 282 283 284 285 286 287 288 289 290 291 292
void WaylandServer::initWorkspace()
{
    if (m_windowManagement) {
        connect(workspace(), &Workspace::showingDesktopChanged, this,
            [this] (bool set) {
                using namespace KWayland::Server;
                m_windowManagement->setShowingDesktopState(set ?
                    PlasmaWindowManagementInterface::ShowingDesktopState::Enabled :
                    PlasmaWindowManagementInterface::ShowingDesktopState::Disabled
                );
            }
        );
    }
293

294 295 296 297 298 299 300 301 302 303 304
    if (hasScreenLockerIntegration()) {
        ScreenLocker::KSldApp::self();
        ScreenLocker::KSldApp::self()->setWaylandDisplay(m_display);
        ScreenLocker::KSldApp::self()->setGreeterEnvironment(kwinApp()->processStartupEnvironment());
        ScreenLocker::KSldApp::self()->initialize();

        connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::greeterClientConnectionChanged, this,
            [this] () {
                m_screenLockerClientConnection = ScreenLocker::KSldApp::self()->greeterClientConnection();
            }
        );
305

306 307 308 309 310
        connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::unlocked, this,
            [this] () {
                m_screenLockerClientConnection = nullptr;
            }
        );
311

312 313 314
        if (m_initFlags.testFlag(InitalizationFlag::LockScreen)) {
            ScreenLocker::KSldApp::self()->lock(ScreenLocker::EstablishLock::Immediate);
        }
315
    }
316
}
317

318 319
void WaylandServer::initOutputs()
{
320
    if (kwinApp()->platform()->handlesOutputs()) {
321 322
        return;
    }
323 324 325 326
    Screens *s = screens();
    Q_ASSERT(s);
    for (int i = 0; i < s->count(); ++i) {
        OutputInterface *output = m_display->createOutput(m_display);
327 328 329 330
        const QRect &geo = s->geometry(i);
        output->setGlobalPosition(geo.topLeft());
        output->setPhysicalSize(geo.size() / 3.8);
        output->addMode(geo.size());
331 332
        output->create();
    }
333 334
}

335 336 337 338 339 340 341
int WaylandServer::createXWaylandConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
342 343
    m_xwayland.client = m_display->createClient(sx[0]);
    m_xwayland.destroyConnection = connect(m_xwayland.client, &KWayland::Server::ClientConnection::disconnected, this,
344 345 346 347
        [] {
            qFatal("Xwayland Connection died");
        }
    );
348 349 350
    return sx[1];
}

351 352 353 354 355
void WaylandServer::destroyXWaylandConnection()
{
    if (!m_xwayland.client) {
        return;
    }
356 357 358 359
    // first terminate the clipboard sync
    if (m_xclipbaordSync.process) {
        m_xclipbaordSync.process->terminate();
    }
360 361 362 363 364
    disconnect(m_xwayland.destroyConnection);
    m_xwayland.client->destroy();
    m_xwayland.client = nullptr;
}

365 366 367 368 369 370 371 372 373 374 375
int WaylandServer::createInputMethodConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
    m_inputMethodServerConnection = m_display->createClient(sx[0]);
    return sx[1];
}

376 377 378 379 380 381 382 383 384
void WaylandServer::destroyInputMethodConnection()
{
    if (!m_inputMethodServerConnection) {
        return;
    }
    m_inputMethodServerConnection->destroy();
    m_inputMethodServerConnection = nullptr;
}

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
int WaylandServer::createXclipboardSyncConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return -1;
    }
    m_xclipbaordSync.client = m_display->createClient(sx[0]);
    return sx[1];
}

void WaylandServer::setupX11ClipboardSync()
{
    if (m_xclipbaordSync.process) {
        return;
    }

    int socket = dup(createXclipboardSyncConnection());
    if (socket == -1) {
        delete m_xclipbaordSync.client;
        m_xclipbaordSync.client = nullptr;
        return;
    }
    if (socket >= 0) {
        QProcessEnvironment environment = kwinApp()->processStartupEnvironment();
        environment.insert(QStringLiteral("WAYLAND_SOCKET"), QByteArray::number(socket));
        environment.insert(QStringLiteral("DISPLAY"), QString::fromUtf8(qgetenv("DISPLAY")));
        environment.remove("WAYLAND_DISPLAY");
        m_xclipbaordSync.process = new Process(this);
        m_xclipbaordSync.process->setProcessChannelMode(QProcess::ForwardedErrorChannel);
        auto finishedSignal = static_cast<void (QProcess::*)(int, QProcess::ExitStatus)>(&QProcess::finished);
        connect(m_xclipbaordSync.process, finishedSignal, this,
            [this] {
                m_xclipbaordSync.process->deleteLater();
                m_xclipbaordSync.process = nullptr;
                m_xclipbaordSync.ddi.clear();
                m_xclipbaordSync.client->destroy();
                m_xclipbaordSync.client = nullptr;
                // TODO: restart
            }
        );
        m_xclipbaordSync.process->setProcessEnvironment(environment);
        m_xclipbaordSync.process->start(QStringLiteral(KWIN_XCLIPBOARD_SYNC_BIN));
    }
}

431 432 433 434 435 436 437 438 439
void WaylandServer::createInternalConnection()
{
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
        return;
    }
    m_internalConnection.server = m_display->createClient(sx[0]);
    using namespace KWayland::Client;
440
    m_internalConnection.client = new ConnectionThread();
441
    m_internalConnection.client->setSocketFd(sx[1]);
442 443 444 445
    m_internalConnection.clientThread = new QThread;
    m_internalConnection.client->moveToThread(m_internalConnection.clientThread);
    m_internalConnection.clientThread->start();

446 447
    connect(m_internalConnection.client, &ConnectionThread::connected, this,
        [this] {
448 449 450 451
            Registry *registry = new Registry(this);
            EventQueue *eventQueue = new EventQueue(this);
            eventQueue->setup(m_internalConnection.client);
            registry->setEventQueue(eventQueue);
452
            registry->create(m_internalConnection.client);
453
            m_internalConnection.registry = registry;
454
            connect(registry, &Registry::shmAnnounced, this,
455
                [this] (quint32 name, quint32 version) {
456
                    m_internalConnection.shm = m_internalConnection.registry->createShmPool(name, version, this);
457 458 459 460 461 462 463 464
                }
            );
            registry->setup();
        }
    );
    m_internalConnection.client->initConnection();
}

465 466 467
void WaylandServer::removeClient(ShellClient *c)
{
    m_clients.removeAll(c);
468
    m_internalClients.removeAll(c);
469 470 471
    emit shellClientRemoved(c);
}

472 473 474 475 476
void WaylandServer::dispatch()
{
    if (!m_display) {
        return;
    }
477 478
    if (m_internalConnection.server) {
        m_internalConnection.server->flush();
479 480 481 482
    }
    m_display->dispatchEvents(0);
}

483
static ShellClient *findClientInList(const QList<ShellClient*> &clients, quint32 id)
484
{
485
    auto it = std::find_if(clients.begin(), clients.end(),
486 487 488 489
        [id] (ShellClient *c) {
            return c->windowId() == id;
        }
    );
490
    if (it == clients.end()) {
491 492 493 494 495
        return nullptr;
    }
    return *it;
}

496 497 498 499 500 501 502 503 504 505 506 507 508
static ShellClient *findClientInList(const QList<ShellClient*> &clients, KWayland::Server::SurfaceInterface *surface)
{
    auto it = std::find_if(clients.begin(), clients.end(),
        [surface] (ShellClient *c) {
            return c->surface() == surface;
        }
    );
    if (it == clients.end()) {
        return nullptr;
    }
    return *it;
}

509 510 511 512 513 514 515 516 517 518 519 520 521 522
ShellClient *WaylandServer::findClient(quint32 id) const
{
    if (id == 0) {
        return nullptr;
    }
    if (ShellClient *c = findClientInList(m_clients, id)) {
        return c;
    }
    if (ShellClient *c = findClientInList(m_internalClients, id)) {
        return c;
    }
    return nullptr;
}

523 524 525 526 527 528 529 530 531 532 533 534 535 536
ShellClient *WaylandServer::findClient(SurfaceInterface *surface) const
{
    if (!surface) {
        return nullptr;
    }
    if (ShellClient *c = findClientInList(m_clients, surface)) {
        return c;
    }
    if (ShellClient *c = findClientInList(m_internalClients, surface)) {
        return c;
    }
    return nullptr;
}

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
ShellClient *WaylandServer::findClient(QWindow *w) const
{
    if (!w) {
        return nullptr;
    }
    auto it = std::find_if(m_internalClients.constBegin(), m_internalClients.constEnd(),
        [w] (const ShellClient *c) {
            return c->internalWindow() == w;
        }
    );
    if (it != m_internalClients.constEnd()) {
        return *it;
    }
    return nullptr;
}

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
quint32 WaylandServer::createWindowId(SurfaceInterface *surface)
{
    auto it = m_clientIds.constFind(surface->client());
    quint16 clientId = 0;
    if (it != m_clientIds.constEnd()) {
        clientId = it.value();
    } else {
        clientId = createClientId(surface->client());
    }
    Q_ASSERT(clientId != 0);
    quint32 id = clientId;
    // TODO: this does not prevent that two surfaces of same client get same id
    id = (id << 16) | (surface->id() & 0xFFFF);
    if (findClient(id)) {
        qCWarning(KWIN_CORE) << "Invalid client windowId generated:" << id;
        return 0;
    }
    return id;
}

quint16 WaylandServer::createClientId(ClientConnection *c)
{
    auto ids = m_clientIds.values().toSet();
    quint16 id = 1;
    if (!ids.isEmpty()) {
        for (quint16 i = ids.count() + 1; i >= 1 ; i--) {
            if (!ids.contains(i)) {
                id = i;
                break;
            }
        }
    }
    Q_ASSERT(!ids.contains(id));
    m_clientIds.insert(c, id);
    connect(c, &ClientConnection::disconnected, this,
        [this] (ClientConnection *c) {
            m_clientIds.remove(c);
        }
    );
    return id;
}

595 596
bool WaylandServer::isScreenLocked() const
{
597 598 599
    if (!hasScreenLockerIntegration()) {
        return false;
    }
600 601
    return ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::Locked ||
           ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::AcquiringLock;
602 603
}

604 605 606 607 608
bool WaylandServer::hasScreenLockerIntegration() const
{
    return !m_initFlags.testFlag(InitalizationFlag::NoLockScreenIntegration);
}

609
}