← Back to branch summary

~ubuntu-branches/ubuntu/utopic/kde-workspace/utopic-proposed

« back to all changes in this revision

Viewing changes to plasma/generic/applets/systemtray/protocols/fdo/fdoselectionmanager.cpp

  • Committer: Bazaar Package Importer
  • Author(s): Michał Zając
  • Date: 2011-07-09 08:31:15 UTC
  • Revision ID: james.westby@ubuntu.com-20110709083115-ohyxn6z93mily9fc
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
plasma/generic/applets/systemtray/protocols/fdo/fdoselectionmanager.cpp
 
1
/***************************************************************************
 
2
 *   fdoselectionmanager.cpp                                               *
 
3
 *                                                                         *
 
4
 *   Copyright (C) 2008 Jason Stubbs <jasonbstubbs@gmail.com>              *
 
5
 *                                                                         *
 
6
 *   This program is free software; you can redistribute it and/or modify  *
 
7
 *   it under the terms of the GNU General Public License as published by  *
 
8
 *   the Free Software Foundation; either version 2 of the License, or     *
 
9
 *   (at your option) any later version.                                   *
 
10
 *                                                                         *
 
11
 *   This program is distributed in the hope that it will be useful,       *
 
12
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 
13
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 
14
 *   GNU General Public License for more details.                          *
 
15
 *                                                                         *
 
16
 *   You should have received a copy of the GNU General Public License     *
 
17
 *   along with this program; if not, write to the                         *
 
18
 *   Free Software Foundation, Inc.,                                       *
 
19
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .        *
 
20
 ***************************************************************************/
 
21
 
 
22
#include "fdoselectionmanager.h"
 
23
#include "fdotask.h"
 
24
#include "x11embedpainter.h"
 
25
 
 
26
#include <KDebug>
 
27
 
 
28
#include <QtCore/QCoreApplication>
 
29
#include <QtCore/QHash>
 
30
#include <QtCore/QTimer>
 
31
 
 
32
#include <QtGui/QTextDocument>
 
33
#include <QtGui/QX11Info>
 
34
 
 
35
#include <KIconLoader>
 
36
 
 
37
#include <Plasma/DataEngine>
 
38
#include <Plasma/DataEngineManager>
 
39
#include <Plasma/ServiceJob>
 
40
 
 
41
#include <config-X11.h>
 
42
 
 
43
#include <X11/Xlib.h>
 
44
#include <X11/Xatom.h>
 
45
#include <X11/extensions/Xrender.h>
 
46
 
 
47
#ifdef HAVE_XFIXES
 
48
#  include <X11/extensions/Xfixes.h>
 
49
#endif
 
50
 
 
51
#ifdef HAVE_XDAMAGE
 
52
#  include <X11/extensions/Xdamage.h>
 
53
#endif
 
54
 
 
55
#ifdef HAVE_XCOMPOSITE
 
56
#  include <X11/extensions/Xcomposite.h>
 
57
#endif
 
58
 
 
59
#define SYSTEM_TRAY_REQUEST_DOCK    0
 
60
#define SYSTEM_TRAY_BEGIN_MESSAGE   1
 
61
#define SYSTEM_TRAY_CANCEL_MESSAGE  2
 
62
 
 
63
 
 
64
namespace SystemTray
 
65
{
 
66
 
 
67
static FdoSelectionManager *s_manager = 0;
 
68
static X11EmbedPainter *s_painter = 0;
 
69
 
 
70
#if defined(HAVE_XFIXES) && defined(HAVE_XDAMAGE) && defined(HAVE_XCOMPOSITE)
 
71
struct DamageWatch
 
72
{
 
73
    QWidget *container;
 
74
    Damage damage;
 
75
};
 
76
 
 
77
static int damageEventBase = 0;
 
78
static QMap<WId, DamageWatch*> damageWatches;
 
79
static QCoreApplication::EventFilter oldEventFilter;
 
80
 
 
81
// Global event filter for intercepting damage events
 
82
static bool x11EventFilter(void *message, long int *result)
 
83
{
 
84
    XEvent *event = reinterpret_cast<XEvent*>(message);
 
85
    if (event->type == damageEventBase + XDamageNotify) {
 
86
        XDamageNotifyEvent *e = reinterpret_cast<XDamageNotifyEvent*>(event);
 
87
        if (DamageWatch *damageWatch = damageWatches.value(e->drawable)) {
 
88
            // Create a new region and empty the damage region into it.
 
89
            // The window is small enough that we don't really care about the region;
 
90
            // we'll just throw it away and schedule a full repaint of the container.
 
91
            XserverRegion region = XFixesCreateRegion(e->display, 0, 0);
 
92
            XDamageSubtract(e->display, e->damage, None, region);
 
93
            XFixesDestroyRegion(e->display, region);
 
94
            damageWatch->container->update();
 
95
        }
 
96
    }
 
97
 
 
98
    if (oldEventFilter && oldEventFilter != x11EventFilter) {
 
99
        return oldEventFilter(message, result);
 
100
    } else {
 
101
        return false;
 
102
    }
 
103
}
 
104
#endif
 
105
 
 
106
 
 
107
struct MessageRequest
 
108
{
 
109
    long messageId;
 
110
    long timeout;
 
111
    long bytesRemaining;
 
112
    QByteArray message;
 
113
};
 
114
 
 
115
 
 
116
class FdoSelectionManagerPrivate
 
117
{
 
118
public:
 
119
    FdoSelectionManagerPrivate(FdoSelectionManager *q)
 
120
        : q(q),
 
121
          notificationsEngine(0),
 
122
          haveComposite(false)
 
123
    {
 
124
        display = QX11Info::display();
 
125
        selectionAtom = XInternAtom(display, "_NET_SYSTEM_TRAY_S" + QByteArray::number(QX11Info::appScreen()), false);
 
126
        opcodeAtom = XInternAtom(display, "_NET_SYSTEM_TRAY_OPCODE", false);
 
127
        messageAtom = XInternAtom(display, "_NET_SYSTEM_TRAY_MESSAGE_DATA", false);
 
128
        visualAtom = XInternAtom(display, "_NET_SYSTEM_TRAY_VISUAL", false);
 
129
 
 
130
#if defined(HAVE_XFIXES) && defined(HAVE_XDAMAGE) && defined(HAVE_XCOMPOSITE)
 
131
        int eventBase, errorBase;
 
132
        bool haveXfixes = XFixesQueryExtension(display, &eventBase, &errorBase);
 
133
        bool haveXdamage = XDamageQueryExtension(display, &damageEventBase, &errorBase);
 
134
        bool haveXComposite = XCompositeQueryExtension(display, &eventBase, &errorBase);
 
135
 
 
136
        if (haveXfixes && haveXdamage && haveXComposite) {
 
137
            haveComposite = true;
 
138
            oldEventFilter = QCoreApplication::instance()->setEventFilter(x11EventFilter);
 
139
        }
 
140
#endif
 
141
    }
 
142
 
 
143
    void createNotification(WId winId);
 
144
 
 
145
    void handleRequestDock(const XClientMessageEvent &event);
 
146
    void handleBeginMessage(const XClientMessageEvent &event);
 
147
    void handleMessageData(const XClientMessageEvent &event);
 
148
    void handleCancelMessage(const XClientMessageEvent &event);
 
149
 
 
150
    Display *display;
 
151
    Atom selectionAtom;
 
152
    Atom opcodeAtom;
 
153
    Atom messageAtom;
 
154
    Atom visualAtom;
 
155
 
 
156
    QHash<WId, MessageRequest> messageRequests;
 
157
    QHash<WId, FdoTask*> tasks;
 
158
 
 
159
    FdoSelectionManager *q;
 
160
    Plasma::DataEngine *notificationsEngine;
 
161
 
 
162
    bool haveComposite;
 
163
};
 
164
 
 
165
FdoSelectionManager::FdoSelectionManager()
 
166
    : d(new FdoSelectionManagerPrivate(this))
 
167
{
 
168
    // Init the selection later just to ensure that no signals are sent
 
169
    // until after construction is done and the creating object has a
 
170
    // chance to connect.
 
171
    QTimer::singleShot(0, this, SLOT(initSelection()));
 
172
}
 
173
 
 
174
 
 
175
FdoSelectionManager::~FdoSelectionManager()
 
176
{
 
177
#if defined(HAVE_XFIXES) && defined(HAVE_XDAMAGE) && defined(HAVE_XCOMPOSITE)
 
178
    if (d->haveComposite && QCoreApplication::instance()) {
 
179
        QCoreApplication::instance()->setEventFilter(oldEventFilter);
 
180
    }
 
181
#endif
 
182
 
 
183
    if (s_manager == this) {
 
184
        s_manager = 0;
 
185
        delete s_painter;
 
186
        s_painter = 0;
 
187
    }
 
188
 
 
189
    delete d;
 
190
}
 
191
 
 
192
FdoSelectionManager *FdoSelectionManager::manager()
 
193
{
 
194
    return s_manager;
 
195
}
 
196
 
 
197
X11EmbedPainter *FdoSelectionManager::painter()
 
198
{
 
199
    return s_painter;
 
200
}
 
201
 
 
202
void FdoSelectionManager::addDamageWatch(QWidget *container, WId client)
 
203
{
 
204
#if defined(HAVE_XFIXES) && defined(HAVE_XDAMAGE) && defined(HAVE_XCOMPOSITE)
 
205
    DamageWatch *damage = new DamageWatch;
 
206
    damage->container = container;
 
207
    damage->damage = XDamageCreate(QX11Info::display(), client, XDamageReportNonEmpty);
 
208
    damageWatches.insert(client, damage);
 
209
#endif
 
210
}
 
211
 
 
212
void FdoSelectionManager::removeDamageWatch(QWidget *container)
 
213
{
 
214
#if defined(HAVE_XFIXES) && defined(HAVE_XDAMAGE) && defined(HAVE_XCOMPOSITE)
 
215
    for (QMap<WId, DamageWatch*>::Iterator it = damageWatches.begin(); it != damageWatches.end(); ++it)
 
216
    {
 
217
        DamageWatch *damage = *(it);
 
218
        if (damage->container == container) {
 
219
             XDamageDestroy(QX11Info::display(), damage->damage);
 
220
             damageWatches.erase(it);
 
221
             delete damage;
 
222
             break;
 
223
        } 
 
224
    }
 
225
#endif
 
226
}
 
227
 
 
228
 
 
229
bool FdoSelectionManager::haveComposite() const
 
230
{
 
231
    return d->haveComposite;
 
232
}
 
233
 
 
234
 
 
235
bool FdoSelectionManager::x11Event(XEvent *event)
 
236
{
 
237
    if (event->type == ClientMessage) {
 
238
        if (event->xclient.message_type == d->opcodeAtom) {
 
239
            switch (event->xclient.data.l[1]) {
 
240
            case SYSTEM_TRAY_REQUEST_DOCK:
 
241
                d->handleRequestDock(event->xclient);
 
242
                return true;
 
243
            case SYSTEM_TRAY_BEGIN_MESSAGE:
 
244
                d->handleBeginMessage(event->xclient);
 
245
                return true;
 
246
            case SYSTEM_TRAY_CANCEL_MESSAGE:
 
247
                d->handleCancelMessage(event->xclient);
 
248
                return true;
 
249
            }
 
250
        } else if (event->xclient.message_type == d->messageAtom) {
 
251
            d->handleMessageData(event->xclient);
 
252
            return true;
 
253
        }
 
254
    }
 
255
 
 
256
    return QWidget::x11Event(event);
 
257
}
 
258
 
 
259
 
 
260
void FdoSelectionManager::initSelection()
 
261
{
 
262
    XSetSelectionOwner(d->display, d->selectionAtom, winId(), CurrentTime);
 
263
 
 
264
    WId selectionOwner = XGetSelectionOwner(d->display, d->selectionAtom);
 
265
    if (selectionOwner != winId()) {
 
266
        // FIXME: Hmmm... Reading the docs on XSetSelectionOwner,
 
267
        // this should not be possible.
 
268
        kDebug() << "Tried to set selection owner to" << winId() << "but it is set to" << selectionOwner;
 
269
        return;
 
270
    }
 
271
 
 
272
    // Prefer the ARGB32 visual if available
 
273
    int nvi;
 
274
    VisualID visual = XVisualIDFromVisual((Visual*)QX11Info::appVisual());
 
275
    XVisualInfo templ;
 
276
    templ.visualid = visual;
 
277
    XVisualInfo *xvi = XGetVisualInfo(d->display, VisualIDMask, &templ, &nvi);
 
278
    if (xvi && xvi[0].depth > 16) {
 
279
        templ.screen  = xvi[0].screen;
 
280
        templ.depth   = 32;
 
281
        templ.c_class = TrueColor;
 
282
        XFree(xvi);
 
283
        xvi = XGetVisualInfo(d->display, VisualScreenMask | VisualDepthMask | VisualClassMask,
 
284
                             &templ, &nvi);
 
285
        for (int i = 0; i < nvi; i++) {
 
286
            XRenderPictFormat *format = XRenderFindVisualFormat(d->display, xvi[i].visual);
 
287
            if (format && format->type == PictTypeDirect && format->direct.alphaMask) {
 
288
                visual = xvi[i].visualid;
 
289
                break;
 
290
            }
 
291
        }
 
292
        XFree(xvi);
 
293
    }
 
294
    XChangeProperty(d->display, winId(), d->visualAtom, XA_VISUALID, 32,
 
295
                    PropModeReplace, (const unsigned char*)&visual, 1);
 
296
 
 
297
    if (!s_painter) {
 
298
        s_painter = new X11EmbedPainter;
 
299
    }
 
300
    s_manager = this;
 
301
 
 
302
    WId root = QX11Info::appRootWindow();
 
303
    XClientMessageEvent xev;
 
304
 
 
305
    xev.type = ClientMessage;
 
306
    xev.window = root;
 
307
    xev.message_type = XInternAtom(d->display, "MANAGER", false);
 
308
    xev.format = 32;
 
309
    xev.data.l[0] = CurrentTime;
 
310
    xev.data.l[1] = d->selectionAtom;
 
311
    xev.data.l[2] = winId();
 
312
    xev.data.l[3] = 0;
 
313
    xev.data.l[4] = 0;
 
314
 
 
315
    XSendEvent(d->display, root, false, StructureNotifyMask, (XEvent*)&xev);
 
316
}
 
317
 
 
318
 
 
319
void FdoSelectionManagerPrivate::handleRequestDock(const XClientMessageEvent &event)
 
320
{
 
321
    const WId winId = (WId)event.data.l[2];
 
322
 
 
323
    if (tasks.contains(winId)) {
 
324
        kDebug() << "got a dock request from an already existing task";
 
325
        return;
 
326
    }
 
327
 
 
328
    FdoTask *task = new FdoTask(winId, q);
 
329
 
 
330
    tasks[winId] = task;
 
331
    q->connect(task, SIGNAL(taskDeleted(WId)), q, SLOT(cleanupTask(WId)));
 
332
 
 
333
    emit q->taskCreated(task);
 
334
}
 
335
 
 
336
 
 
337
void FdoSelectionManager::cleanupTask(WId winId)
 
338
{
 
339
    d->tasks.remove(winId);
 
340
}
 
341
 
 
342
 
 
343
void FdoSelectionManagerPrivate::handleBeginMessage(const XClientMessageEvent &event)
 
344
{
 
345
    const WId winId = event.window;
 
346
 
 
347
    MessageRequest request;
 
348
    request.messageId = event.data.l[4];
 
349
    request.timeout = event.data.l[2];
 
350
    request.bytesRemaining = event.data.l[3];
 
351
 
 
352
    if (request.bytesRemaining) {
 
353
        messageRequests[winId] = request;
 
354
    }
 
355
}
 
356
 
 
357
 
 
358
void FdoSelectionManagerPrivate::handleMessageData(const XClientMessageEvent &event)
 
359
{
 
360
    const WId winId = event.window;
 
361
    const char *messageData = event.data.b;
 
362
 
 
363
    if (!messageRequests.contains(winId)) {
 
364
        kDebug() << "Unexpected message data from" << winId;
 
365
        return;
 
366
    }
 
367
 
 
368
    MessageRequest &request = messageRequests[winId];
 
369
    const int messageSize = qMin(request.bytesRemaining, 20l);
 
370
    request.bytesRemaining -= messageSize;
 
371
    request.message += QByteArray(messageData, messageSize);
 
372
 
 
373
    if (request.bytesRemaining == 0) {
 
374
        createNotification(winId);
 
375
        messageRequests.remove(winId);
 
376
    }
 
377
}
 
378
 
 
379
 
 
380
void FdoSelectionManagerPrivate::createNotification(WId winId)
 
381
{
 
382
    if (!tasks.contains(winId)) {
 
383
        kDebug() << "message request from unknown task" << winId;
 
384
        return;
 
385
    }
 
386
 
 
387
    MessageRequest &request = messageRequests[winId];
 
388
    Task *task = tasks[winId];
 
389
 
 
390
    QString message = QString::fromUtf8(request.message);
 
391
    message = QTextDocument(message).toHtml();
 
392
 
 
393
    if (!notificationsEngine) {
 
394
        notificationsEngine = Plasma::DataEngineManager::self()->loadEngine("notifications");
 
395
    }
 
396
    //FIXME: who is the source in this case?
 
397
    Plasma::Service *service = notificationsEngine->serviceForSource("notification");
 
398
    KConfigGroup op = service->operationDescription("createNotification");
 
399
 
 
400
    if (op.isValid()) {
 
401
        op.writeEntry("appName", task->name());
 
402
        //FIXME: find a way to pass icons trough here
 
403
        op.writeEntry("appIcon", task->name());
 
404
 
 
405
        //op.writeEntry("summary", task->name());
 
406
        op.writeEntry("body", message);
 
407
        op.writeEntry("timeout", (int)request.timeout);
 
408
        KJob *job = service->startOperationCall(op);
 
409
        QObject::connect(job, SIGNAL(finished(KJob*)), service, SLOT(deleteLater()));
 
410
    } else {
 
411
        delete service;
 
412
        kDebug() << "invalid operation";
 
413
    }
 
414
}
 
415
 
 
416
 
 
417
void FdoSelectionManagerPrivate::handleCancelMessage(const XClientMessageEvent &event)
 
418
{
 
419
    const WId winId = event.window;
 
420
    const long messageId = event.data.l[2];
 
421
 
 
422
    if (messageRequests.contains(winId) && messageRequests[winId].messageId == messageId) {
 
423
        messageRequests.remove(winId);
 
424
    }
 
425
}
 
426
 
 
427
 
 
428
}