wayland_server.cpp 21.6 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/pointerconstraints_interface.h>
44
#include <KWayland/Server/pointergestures_interface.h>
45
#include <KWayland/Server/qtsurfaceextension_interface.h>
46
#include <KWayland/Server/seat_interface.h>
47
#include <KWayland/Server/server_decoration_interface.h>
48
#include <KWayland/Server/shadow_interface.h>
49
#include <KWayland/Server/subcompositor_interface.h>
50
#include <KWayland/Server/blur_interface.h>
51
#include <KWayland/Server/shell_interface.h>
52 53
#include <KWayland/Server/outputmanagement_interface.h>
#include <KWayland/Server/outputconfiguration_interface.h>
54
#include <KWayland/Server/xdgshell_interface.h>
55

56
// Qt
57
#include <QThread>
58 59
#include <QWindow>

60 61 62
// system
#include <sys/types.h>
#include <sys/socket.h>
63
#include <unistd.h>
64

65 66 67
//screenlocker
#include <KScreenLocker/KsldApp>

68 69 70 71 72 73 74 75 76 77
using namespace KWayland::Server;

namespace KWin
{

KWIN_SINGLETON_FACTORY(WaylandServer)

WaylandServer::WaylandServer(QObject *parent)
    : QObject(parent)
{
78
    qRegisterMetaType<KWayland::Server::OutputInterface::DpmsMode>();
79 80

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

84 85 86 87
WaylandServer::~WaylandServer()
{
    destroyInputMethodConnection();
}
88 89

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

106 107 108 109
void WaylandServer::terminateClientConnections()
{
    destroyInternalConnection();
    destroyInputMethodConnection();
110 111 112 113 114
    if (m_display) {
        const auto connections = m_display->connections();
        for (auto it = connections.begin(); it != connections.end(); ++it) {
            (*it)->destroy();
        }
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
template <class T>
void WaylandServer::createSurface(T *surface)
{
    if (!Workspace::self()) {
        // it's possible that a Surface gets created before Workspace is created
        return;
    }
    if (surface->client() == m_xwayland.client) {
        // skip Xwayland clients, those are created using standard X11 way
        return;
    }
    if (surface->client() == m_screenLockerClientConnection) {
        ScreenLocker::KSldApp::self()->lockScreenShown();
    }
    auto client = new ShellClient(surface);
    if (client->isInternal()) {
        m_internalClients << client;
    } else {
        m_clients << client;
    }
    if (client->readyForPainting()) {
        emit shellClientAdded(client);
    } else {
        connect(client, &ShellClient::windowShown, this, &WaylandServer::shellClientShown);
    }
}

145
bool WaylandServer::init(const QByteArray &socketName, InitalizationFlags flags)
146
{
147
    m_initFlags = flags;
148 149 150 151 152
    m_display = new KWayland::Server::Display(this);
    if (!socketName.isNull() && !socketName.isEmpty()) {
        m_display->setSocketName(QString::fromUtf8(socketName));
    }
    m_display->start();
153 154 155
    if (!m_display->isRunning()) {
        return false;
    }
156 157
    m_compositor = m_display->createCompositor(m_display);
    m_compositor->create();
158 159 160 161 162 163 164 165
    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;
            }
166 167 168 169
            if (surface->client() != xWaylandConnection()) {
                // setting surface is only relevat for Xwayland clients
                return;
            }
170 171 172 173 174 175 176 177
            auto check = [surface] (const Toplevel *t) {
                return t->surfaceId() == surface->id();
            };
            if (Toplevel *t = ws->findToplevel(check)) {
                t->setSurface(surface);
            }
        }
    );
178 179
    m_shell = m_display->createShell(m_display);
    m_shell->create();
180 181 182 183 184 185
    connect(m_shell, &ShellInterface::surfaceCreated, this, &WaylandServer::createSurface<ShellSurfaceInterface>);
    m_xdgShell = m_display->createXdgShell(XdgShellInterfaceVersion::UnstableV5, m_display);
    m_xdgShell->create();
    connect(m_xdgShell, &XdgShellInterface::surfaceCreated, this, &WaylandServer::createSurface<XdgShellSurfaceInterface>);
    // TODO: verify seat and serial
    connect(m_xdgShell, &XdgShellInterface::popupCreated, this, &WaylandServer::createSurface<XdgShellPopupInterface>);
186
    m_display->createShm();
187 188
    m_seat = m_display->createSeat(m_display);
    m_seat->create();
189
    m_display->createPointerGestures(PointerGesturesInterfaceVersion::UnstableV1, m_display)->create();
190
    m_display->createPointerConstraints(PointerConstraintsInterfaceVersion::UnstableV1, m_display)->create();
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    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());
                        }
                    }
                );
            }
        }
    );
210
    m_display->createIdle(m_display)->create();
211 212 213 214 215 216 217 218 219
    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);
            }
        }
    );
220 221 222 223 224 225 226 227 228
    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);
            }
        }
    );
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
    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);
        }
    );
255 256
    auto shadowManager = m_display->createShadowManager(m_display);
    shadowManager->create();
257 258

    m_display->createDpmsManager(m_display)->create();
259 260 261 262 263 264 265 266 267 268

    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();
269 270 271 272

    m_outputManagement = m_display->createOutputManagement(m_display);
    connect(m_outputManagement, &OutputManagementInterface::configurationChangeRequested,
            this, [this](KWayland::Server::OutputConfigurationInterface *config) {
273
                kwinApp()->platform()->configurationChangeRequested(config);
274
    });
275
    m_outputManagement->create();
276 277

    m_display->createSubCompositor(m_display)->create();
278 279

    return true;
280 281
}

282 283 284 285 286 287 288 289 290 291 292
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);
}

293 294 295 296 297 298 299 300 301 302 303 304 305
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
                );
            }
        );
    }
306

307 308 309 310 311 312 313 314 315 316 317
    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();
            }
        );
318

319 320 321 322 323
        connect(ScreenLocker::KSldApp::self(), &ScreenLocker::KSldApp::unlocked, this,
            [this] () {
                m_screenLockerClientConnection = nullptr;
            }
        );
324

325 326 327
        if (m_initFlags.testFlag(InitalizationFlag::LockScreen)) {
            ScreenLocker::KSldApp::self()->lock(ScreenLocker::EstablishLock::Immediate);
        }
328
    }
329
    emit initialized();
330
}
331

332 333
void WaylandServer::initOutputs()
{
334
    if (kwinApp()->platform()->handlesOutputs()) {
335 336
        return;
    }
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
    syncOutputsToWayland();
    connect(screens(), &Screens::changed, this,
        [this] {
            // when screens change we need to sync this to Wayland.
            // Unfortunately we don't have much information and cannot properly match a KWin screen
            // to a Wayland screen.
            // Thus we just recreate all outputs and delete the old ones
            const auto outputs = m_display->outputs();
            syncOutputsToWayland();
            qDeleteAll(outputs);
        }
    );
}

void WaylandServer::syncOutputsToWayland()
{
353 354 355 356
    Screens *s = screens();
    Q_ASSERT(s);
    for (int i = 0; i < s->count(); ++i) {
        OutputInterface *output = m_display->createOutput(m_display);
357 358 359 360
        const QRect &geo = s->geometry(i);
        output->setGlobalPosition(geo.topLeft());
        output->setPhysicalSize(geo.size() / 3.8);
        output->addMode(geo.size());
361 362
        output->create();
    }
363 364
}

365
WaylandServer::SocketPairConnection WaylandServer::createConnection()
366
{
367
    SocketPairConnection ret;
368 369 370
    int sx[2];
    if (socketpair(AF_UNIX, SOCK_STREAM | SOCK_CLOEXEC, 0, sx) < 0) {
        qCWarning(KWIN_CORE) << "Could not create socket";
371 372 373 374 375 376 377 378 379 380 381
        return ret;
    }
    ret.connection = m_display->createClient(sx[0]);
    ret.fd = sx[1];
    return ret;
}

int WaylandServer::createXWaylandConnection()
{
    const auto socket = createConnection();
    if (!socket.connection) {
382 383
        return -1;
    }
384
    m_xwayland.client = socket.connection;
385
    m_xwayland.destroyConnection = connect(m_xwayland.client, &KWayland::Server::ClientConnection::disconnected, this,
386 387 388 389
        [] {
            qFatal("Xwayland Connection died");
        }
    );
390
    return socket.fd;
391 392
}

393 394 395 396 397
void WaylandServer::destroyXWaylandConnection()
{
    if (!m_xwayland.client) {
        return;
    }
398 399 400 401
    // first terminate the clipboard sync
    if (m_xclipbaordSync.process) {
        m_xclipbaordSync.process->terminate();
    }
402 403 404 405 406
    disconnect(m_xwayland.destroyConnection);
    m_xwayland.client->destroy();
    m_xwayland.client = nullptr;
}

407 408
int WaylandServer::createInputMethodConnection()
{
409 410
    const auto socket = createConnection();
    if (!socket.connection) {
411 412
        return -1;
    }
413 414
    m_inputMethodServerConnection = socket.connection;
    return socket.fd;
415 416
}

417 418 419 420 421 422 423 424 425
void WaylandServer::destroyInputMethodConnection()
{
    if (!m_inputMethodServerConnection) {
        return;
    }
    m_inputMethodServerConnection->destroy();
    m_inputMethodServerConnection = nullptr;
}

426 427
int WaylandServer::createXclipboardSyncConnection()
{
428 429
    const auto socket = createConnection();
    if (!socket.connection) {
430 431
        return -1;
    }
432 433
    m_xclipbaordSync.client = socket.connection;
    return socket.fd;
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
}

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));
    }
}

471 472
void WaylandServer::createInternalConnection()
{
473 474
    const auto socket = createConnection();
    if (!socket.connection) {
475 476
        return;
    }
477
    m_internalConnection.server = socket.connection;
478
    using namespace KWayland::Client;
479
    m_internalConnection.client = new ConnectionThread();
480
    m_internalConnection.client->setSocketFd(socket.fd);
481 482 483 484
    m_internalConnection.clientThread = new QThread;
    m_internalConnection.client->moveToThread(m_internalConnection.clientThread);
    m_internalConnection.clientThread->start();

485 486
    connect(m_internalConnection.client, &ConnectionThread::connected, this,
        [this] {
487 488 489 490
            Registry *registry = new Registry(this);
            EventQueue *eventQueue = new EventQueue(this);
            eventQueue->setup(m_internalConnection.client);
            registry->setEventQueue(eventQueue);
491
            registry->create(m_internalConnection.client);
492
            m_internalConnection.registry = registry;
493
            connect(registry, &Registry::shmAnnounced, this,
494
                [this] (quint32 name, quint32 version) {
495
                    m_internalConnection.shm = m_internalConnection.registry->createShmPool(name, version, this);
496 497 498 499 500 501 502 503
                }
            );
            registry->setup();
        }
    );
    m_internalConnection.client->initConnection();
}

504 505 506
void WaylandServer::removeClient(ShellClient *c)
{
    m_clients.removeAll(c);
507
    m_internalClients.removeAll(c);
508 509 510
    emit shellClientRemoved(c);
}

511 512 513 514 515
void WaylandServer::dispatch()
{
    if (!m_display) {
        return;
    }
516 517
    if (m_internalConnection.server) {
        m_internalConnection.server->flush();
518 519 520 521
    }
    m_display->dispatchEvents(0);
}

522
static ShellClient *findClientInList(const QList<ShellClient*> &clients, quint32 id)
523
{
524
    auto it = std::find_if(clients.begin(), clients.end(),
525 526 527 528
        [id] (ShellClient *c) {
            return c->windowId() == id;
        }
    );
529
    if (it == clients.end()) {
530 531 532 533 534
        return nullptr;
    }
    return *it;
}

535 536 537 538 539 540 541 542 543 544 545 546 547
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;
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561
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;
}

562 563 564 565 566 567 568 569 570 571 572 573 574 575
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;
}

576 577 578 579 580
AbstractClient *WaylandServer::findAbstractClient(SurfaceInterface *surface) const
{
    return findClient(surface);
}

581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
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;
}

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
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;
}

639 640
bool WaylandServer::isScreenLocked() const
{
641 642 643
    if (!hasScreenLockerIntegration()) {
        return false;
    }
644 645
    return ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::Locked ||
           ScreenLocker::KSldApp::self()->lockState() == ScreenLocker::KSldApp::AcquiringLock;
646 647
}

648 649 650 651 652
bool WaylandServer::hasScreenLockerIntegration() const
{
    return !m_initFlags.testFlag(InitalizationFlag::NoLockScreenIntegration);
}

653
}