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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
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
431
432
433
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
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
595
596
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
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtApplicationManager module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "global.h"
#if defined(AM_MULTI_PROCESS)
# include <QDBusMessage>
# include <QDBusConnection>
# include <QDBusPendingCallWatcher>
# include <QDBusPendingReply>
# include "intentinterface_adaptor.h"
# include "dbus-utilities.h"
# include "nativeruntime.h"
#endif
#include <QDebug>
#include <QMetaObject>
#include <QQmlEngine>
#include <QQmlExpression>
#include <QQmlContext>
#include <QQmlInfo>
#include "error.h"
#include "exception.h"
#include "logging.h"
#include "runtimefactory.h"
#include "intentserver.h"
#include "intentclient.h"
#include "intentserverrequest.h"
#include "intentclientrequest.h"
#include "intentaminterface.h"
#include "qmlinprocessruntime.h"
#include "application.h"
#include "applicationmanager.h"
#include "package.h"
#include "packagemanager.h"
#include "applicationinfo.h"
QT_BEGIN_NAMESPACE_AM
static QString sysUiId = qSL(":sysui:");
//////////////////////////////////////////////////////////////////////////
// vvv IntentAMImplementation vvv
IntentServer *IntentAMImplementation::createIntentServerAndClientInstance(PackageManager *packageManager,
int disambiguationTimeout,
int startApplicationTimeout,
int replyFromApplicationTimeout,
int replyFromSystemTimeout)
{
auto intentServerAMInterface = new IntentServerAMImplementation;
auto intentClientAMInterface = new IntentClientAMImplementation(intentServerAMInterface);
auto intentServer = IntentServer::createInstance(intentServerAMInterface);
auto intentClient = IntentClient::createInstance(intentClientAMInterface);
intentServer->setDisambiguationTimeout(disambiguationTimeout);
intentServer->setStartApplicationTimeout(startApplicationTimeout);
// These timeouts are for the same thing - the time needed for the application's handler to
// generate a reply - but one is for the server side, while the other for the client side.
// Having two separate config values would be confusing, so we set the application side to
// 90% of the server side, because the communication overhead is not included there.
{
int t = replyFromApplicationTimeout;
intentServer->setReplyFromApplicationTimeout(t);
intentClient->setReplyFromApplicationTimeout(t <= 0 ? t : int(t * 0.9));
}
intentClient->setReplyFromSystemTimeout(replyFromSystemTimeout);
// this way, deleting the server (the return value of this factory function) will get rid
// of both client and server as well as both their AM interfaces
intentClient->setParent(intentServer);
// connect the APIs of the PackageManager and the IntentServer
// the Intent API does not use AM internal types, so we have to translate using id strings:
// the idea behind this is that the Intent subsystem could be useful outside of the AM as well,
// so we try not to use AM specific classes in the intent-server and intent-client modules.
QObject::connect(packageManager, &PackageManager::packageAdded,
intentServer, &IntentServer::addPackage);
QObject::connect(packageManager, &PackageManager::packageAboutToBeRemoved,
intentServer, &IntentServer::removePackage);
QObject::connect(&packageManager->internalSignals, &PackageManagerInternalSignals::registerApplication,
intentServer, [intentServer](ApplicationInfo *applicationInfo, Package *package) {
intentServer->addApplication(applicationInfo->id(), package->id());
});
QObject::connect(&packageManager->internalSignals, &PackageManagerInternalSignals::unregisterApplication,
intentServer, [intentServer](ApplicationInfo *applicationInfo, Package *package) {
intentServer->removeApplication(applicationInfo->id(), package->id());
});
QObject::connect(&packageManager->internalSignals, &PackageManagerInternalSignals::registerIntent,
intentServer, [intentServer](IntentInfo *intentInfo, Package *package) {
if (!intentServer->addIntent(intentInfo->id(), package->id(), intentInfo->handlingApplicationId(),
intentInfo->requiredCapabilities(),
intentInfo->visibility() == IntentInfo::Public ? Intent::Public
: Intent::Private,
intentInfo->parameterMatch(), intentInfo->names(),
intentInfo->descriptions(),
QUrl::fromLocalFile(package->info()->baseDir().absoluteFilePath(intentInfo->icon())),
intentInfo->categories())) {
throw Exception(Error::Intents, "could not add intent %1 for package %2")
.arg(intentInfo->id()).arg(package->id());
}
qCDebug(LogSystem).nospace().noquote() << " ++ intent: " << intentInfo->id() << " [package: " << package->id() << "]";
});
QObject::connect(&packageManager->internalSignals, &PackageManagerInternalSignals::unregisterIntent,
intentServer, [intentServer](IntentInfo *intentInfo, Package *package) {
Intent *intent = intentServer->packageIntent(intentInfo->id(), package->id(),
intentInfo->parameterMatch());
qCDebug(LogSystem).nospace().noquote() << " -- intent: " << intentInfo->id() << " [package: " << package->id() << "]";
Q_ASSERT(intent);
intentServer->removeIntent(intent);
});
return intentServer;
}
// ^^^ IntentAMImplementation ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentServerAMImplementation vvv
void IntentServerAMImplementation::setIntentClientSystemInterface(IntentClientSystemInterface *iface)
{
m_icsi = iface;
}
IntentClientSystemInterface *IntentServerAMImplementation::intentClientSystemInterface() const
{
return m_icsi;
}
void IntentServerAMImplementation::initialize(IntentServer *server)
{
IntentServerSystemInterface::initialize(server);
// this is a dummy connection for the System UI, so that we can route replies
// back to it without any ugly hacks in the core IntentServer code.
IntentServerInProcessIpcConnection::createSystemUi(this);
// The IntentServer itself doesn't know about the p2p D-Bus or the AM itself, so we need to
// wire it up to both interfaces from the outside
connect(AbstractRuntime::signaler(), &RuntimeSignaler::aboutToStart,
intentServer(), [this](AbstractRuntime *runtime) {
#if defined(AM_MULTI_PROCESS)
if (NativeRuntime *nativeRuntime = qobject_cast<NativeRuntime *>(runtime)) {
connect(nativeRuntime, &NativeRuntime::applicationConnectedToPeerDBus,
intentServer(), [this](const QDBusConnection &connection, Application *application) {
qCDebug(LogIntents) << "IntentServer: applicationConnectedToPeerDBus"
<< (application ? application->id() : qSL("<launcher>"));
IntentServerDBusIpcConnection::create(connection, application, this);
});
connect(nativeRuntime, &NativeRuntime::applicationReadyOnPeerDBus,
intentServer(), [](const QDBusConnection &connection, Application *application) {
auto peer = IntentServerDBusIpcConnection::find(connection);
if (!peer) {
qCWarning(LogIntents) << "IntentServer: applicationReadyOnPeerDBus() was emitted, "
"but no previous applicationConnectedToPeerDBus() was seen";
return;
}
peer->setReady(application);
});
connect(nativeRuntime, &NativeRuntime::applicationDisconnectedFromPeerDBus,
intentServer(), [](const QDBusConnection &connection, Application *) {
delete IntentServerDBusIpcConnection::find(connection);
});
} else
#endif // defined(AM_MULTI_PROCESS)
if (QmlInProcessRuntime *qmlRuntime = qobject_cast<QmlInProcessRuntime *>(runtime)) {
connect(qmlRuntime, &QmlInProcessRuntime::stateChanged,
intentServer(), [this, qmlRuntime](Am::RunState newState) {
if (!qmlRuntime->application())
return;
if (newState == Am::Running)
IntentServerInProcessIpcConnection::create(qmlRuntime->application(), this);
else if (newState == Am::NotRunning)
delete IntentServerIpcConnection::find(qmlRuntime->application()->id());
});
}
});
}
bool IntentServerAMImplementation::checkApplicationCapabilities(const QString &applicationId,
const QStringList &requiredCapabilities)
{
if (applicationId == sysUiId) // The System UI bypasses the capabilities check
return true;
const auto app = ApplicationManager::instance()->application(applicationId);
if (!app)
return false;
auto capabilities = app->capabilities();
for (const auto &cap : requiredCapabilities) {
if (!capabilities.contains(cap))
return false;
}
return true;
}
IntentServerSystemInterface::IpcConnection *IntentServerAMImplementation::findClientIpc(const QString &appId)
{
auto peer = IntentServerIpcConnection::find(appId);
return (peer && peer->isReady()) ? reinterpret_cast<IpcConnection *>(peer) : nullptr;
}
void IntentServerAMImplementation::startApplication(const QString &appId)
{
ApplicationManager::instance()->startApplication(appId);
}
void IntentServerAMImplementation::requestToApplication(IntentServerSystemInterface::IpcConnection *clientIPC,
IntentServerRequest *irs)
{
reinterpret_cast<IntentServerIpcConnection *>(clientIPC)->requestToApplication(irs);
}
void IntentServerAMImplementation::replyFromSystem(IntentServerSystemInterface::IpcConnection *clientIPC,
IntentServerRequest *irs)
{
reinterpret_cast<IntentServerIpcConnection *>(clientIPC)->replyFromSystem(irs);
}
// ^^^ IntentServerAMImplementation ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentClientAMImplementation vvv
IntentClientAMImplementation::IntentClientAMImplementation(IntentServerAMImplementation *serverInterface)
: IntentClientSystemInterface()
, m_issi(serverInterface)
{
serverInterface->setIntentClientSystemInterface(this);
}
QString IntentClientAMImplementation::currentApplicationId(QObject *hint)
{
QmlInProcessRuntime *runtime = QmlInProcessRuntime::determineRuntime(hint);
return runtime ? runtime->application()->info()->id() : sysUiId;
}
void IntentClientAMImplementation::initialize(IntentClient *intentClient) Q_DECL_NOEXCEPT_EXPR(false)
{
IntentClientSystemInterface::initialize(intentClient);
qmlRegisterSingletonType<IntentClient>("QtApplicationManager", 2, 0, "IntentClient",
[](QQmlEngine *, QJSEngine *) -> QObject * {
QQmlEngine::setObjectOwnership(IntentClient::instance(), QQmlEngine::CppOwnership);
return IntentClient::instance();
});
qmlRegisterUncreatableType<IntentClientRequest>("QtApplicationManager", 2, 0, "IntentRequest",
qSL("Cannot create objects of type IntentRequest"));
qmlRegisterType<IntentHandler>("QtApplicationManager.Application", 2, 0, "IntentHandler");
qmlRegisterType<IntentServerHandler>("QtApplicationManager.SystemUI", 2, 0, "IntentServerHandler");
}
void IntentClientAMImplementation::requestToSystem(QPointer<IntentClientRequest> icr)
{
// we need to delay the request by one event loop iteration to (a) avoid a race condition
// on app startup and (b) have consistent behavior in single- and multi-process mode
QMetaObject::invokeMethod(m_ic, [icr, this]() {
IntentServerRequest *isr = m_issi->requestToSystem(icr->requestingApplicationId(), icr->intentId(),
icr->applicationId(), icr->parameters());
QUuid requestId = isr ? isr->requestId() : QUuid();
QMetaObject::invokeMethod(m_ic, [icr, requestId, this]() {
emit requestToSystemFinished(icr.data(), requestId, requestId.isNull(),
requestId.isNull() ? qL1S("No matching intent handler registered.") : QString());
}, Qt::QueuedConnection);
}, Qt::QueuedConnection);
}
void IntentClientAMImplementation::replyFromApplication(QPointer<IntentClientRequest> icr)
{
if (icr) {
emit m_issi->replyFromApplication(icr->applicationId(), icr->requestId(), !icr->succeeded(),
icr->result());
}
}
// ^^^ IntentClientAMImplementation ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentServerIpcConnection vvv
QList<IntentServerIpcConnection *> IntentServerIpcConnection::s_ipcConnections;
IntentServerIpcConnection::IntentServerIpcConnection(bool inProcess, Application *application,
IntentServerAMImplementation *iface)
: QObject()
, m_application(application)
, m_interface(iface)
, m_inprocess(inProcess)
{
connect(this, &IntentServerIpcConnection::applicationIsReady,
m_interface, &IntentServerSystemInterface::applicationWasStarted);
}
IntentServerIpcConnection::~IntentServerIpcConnection()
{
s_ipcConnections.removeOne(this);
}
bool IntentServerIpcConnection::isReady() const
{
return m_ready;
}
void IntentServerIpcConnection::setReady(Application *application)
{
if (m_ready)
return;
m_application = application;
m_ready = true;
emit applicationIsReady((isInProcess() && !application) ? sysUiId : application->id());
}
IntentServerIpcConnection *IntentServerIpcConnection::find(const QString &appId)
{
for (auto ipcConnection : qAsConst(s_ipcConnections)) {
if (ipcConnection->applicationId() == appId)
return ipcConnection;
}
return nullptr;
}
Application *IntentServerIpcConnection::application() const
{
return m_application;
}
QString IntentServerIpcConnection::applicationId() const
{
return m_application ? m_application->id() : QString();
}
bool IntentServerIpcConnection::isInProcess() const
{
return m_inprocess;
}
// ^^^ IntentServerIpcConnection ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentServerInProcessIpcConnection vvv
IntentServerInProcessIpcConnection::IntentServerInProcessIpcConnection(Application *application,
IntentServerAMImplementation *iface)
: IntentServerIpcConnection(true /*inProcess*/, application, iface)
{ }
IntentServerInProcessIpcConnection *IntentServerInProcessIpcConnection::create(Application *application,
IntentServerAMImplementation *iface)
{
auto ipcConnection = new IntentServerInProcessIpcConnection(application, iface);
if (application)
ipcConnection->setReady(application);
else
ipcConnection->m_ready = true;
s_ipcConnections << ipcConnection;
return ipcConnection;
}
IntentServerInProcessIpcConnection *IntentServerInProcessIpcConnection::createSystemUi(IntentServerAMImplementation *iface)
{
auto ipcConnection = create(nullptr, iface);
ipcConnection->m_isSystemUi = true;
ipcConnection->setParent(iface);
return ipcConnection;
}
QString IntentServerInProcessIpcConnection::applicationId() const
{
return m_isSystemUi ? sysUiId : IntentServerIpcConnection::applicationId();
}
void IntentServerInProcessIpcConnection::requestToApplication(IntentServerRequest *irs)
{
// we need decouple the server/client interface at this point to have a consistent
// behavior in single- and multi-process mode
QMetaObject::invokeMethod(this, [this, irs]() {
auto clientInterface = m_interface->intentClientSystemInterface();
emit clientInterface->requestToApplication(irs->requestId(), irs->intentId(),
irs->requestingApplicationId(),
irs->handlingApplicationId(), irs->parameters());
}, Qt::QueuedConnection);
}
void IntentServerInProcessIpcConnection::replyFromSystem(IntentServerRequest *irs)
{
// we need decouple the server/client interface at this point to have a consistent
// behavior in single- and multi-process mode
QMetaObject::invokeMethod(this, [this, irs]() {
auto clientInterface = m_interface->intentClientSystemInterface();
emit clientInterface->replyFromSystem(irs->requestId(), !irs->succeeded(), irs->result());
}, Qt::QueuedConnection);
}
// ^^^ IntentServerInProcessIpcConnection ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentServerDBusIpcConnection vvv
#if defined(AM_MULTI_PROCESS)
IntentServerDBusIpcConnection::IntentServerDBusIpcConnection(QDBusConnection connection,
Application *application,
IntentServerAMImplementation *iface)
: IntentServerIpcConnection(false /* !inProcess*/, application, iface)
{
m_connectionName = connection.name();
m_adaptor = new IntentInterfaceAdaptor(this);
connection.registerObject(qSL("/IntentServer"), this, QDBusConnection::ExportAdaptors);
}
IntentServerDBusIpcConnection::~IntentServerDBusIpcConnection()
{
QDBusConnection(m_connectionName).unregisterObject(qSL("/IntentServer"));
}
IntentServerDBusIpcConnection *IntentServerDBusIpcConnection::create(QDBusConnection connection,
Application *application,
IntentServerAMImplementation *iface)
{
auto ipcConnection = new IntentServerDBusIpcConnection(connection, application, iface);
s_ipcConnections << ipcConnection;
return ipcConnection;
}
IntentServerDBusIpcConnection *IntentServerDBusIpcConnection::find(QDBusConnection connection)
{
QString connectionName = connection.name();
for (auto ipcConnection : qAsConst(s_ipcConnections)) {
if (ipcConnection->isInProcess())
continue;
auto dbusIpcConnection = static_cast<IntentServerDBusIpcConnection *>(ipcConnection);
if (dbusIpcConnection->m_connectionName == connectionName)
return dbusIpcConnection;
}
return nullptr;
}
void IntentServerDBusIpcConnection::requestToApplication(IntentServerRequest *irs)
{
emit m_adaptor->requestToApplication(irs->requestId().toString(), irs->intentId(),
irs->handlingApplicationId(),
convertFromJSVariant(irs->parameters()).toMap());
}
void IntentServerDBusIpcConnection::replyFromSystem(IntentServerRequest *irs)
{
emit m_adaptor->replyFromSystem(irs->requestId().toString(), !irs->succeeded(),
convertFromJSVariant(irs->result()).toMap());
}
QString IntentServerDBusIpcConnection::requestToSystem(const QString &intentId,
const QString &applicationId,
const QVariantMap ¶meters)
{
auto requestingApplicationId = application() ? application()->id() : QString();
auto irs = m_interface->requestToSystem(requestingApplicationId, intentId, applicationId,
convertFromDBusVariant(parameters).toMap());
if (!irs) {
sendErrorReply(QDBusError::NotSupported, qL1S("No matching intent handler registered."));
return QString();
} else {
return irs->requestId().toString();
}
}
void IntentServerDBusIpcConnection::replyFromApplication(const QString &requestId, bool error,
const QVariantMap &result)
{
emit m_interface->replyFromApplication(application()->id(), QUuid::fromString(requestId), error,
convertFromDBusVariant(result).toMap());
}
#endif // defined(AM_MULTI_PROCESS)
// ^^^ IntentServerDBusIpcConnection ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentInterfaceAdaptor vvv
QT_END_NAMESPACE_AM
#if defined(AM_MULTI_PROCESS)
IntentInterfaceAdaptor::IntentInterfaceAdaptor(QObject *parent)
: QDBusAbstractAdaptor(parent)
{ }
IntentInterfaceAdaptor::~IntentInterfaceAdaptor()
{ }
void IntentInterfaceAdaptor::replyFromApplication(const QString &requestId, bool error,
const QVariantMap &result)
{
auto peer = static_cast<QT_PREPEND_NAMESPACE_AM(IntentServerDBusIpcConnection) *>(parent());
peer->replyFromApplication(requestId, error, result);
}
QString IntentInterfaceAdaptor::requestToSystem(const QString &intentId, const QString &applicationId,
const QVariantMap ¶meters)
{
auto peer = static_cast<QT_PREPEND_NAMESPACE_AM(IntentServerDBusIpcConnection) *>(parent());
return peer->requestToSystem(intentId, applicationId, parameters);
}
#endif // defined(AM_MULTI_PROCESS)
QT_BEGIN_NAMESPACE_AM
// ^^^ IntentInterfaceAdaptor ^^^
//////////////////////////////////////////////////////////////////////////
// vvv IntentServerHandler vvv
/*! \qmltype IntentServerHandler
\inqmlmodule QtApplicationManager.SystemUI
\inherits IntentHandler
\ingroup system-ui-instantiable
\brief A handler for intent requests received within the System UI.
If intents need to be handled from within the System UI, you need to have a corresponding
IntentServerHandler instance that is actually able to handle incoming requests. This class gives
you the flexibility to handle multiple, different intent ids via a single IntentServerHandler
instance or have a dedicated IntentServerHandler instance for every intent id (or any
combination of those).
\note For handling intent requests within an application, you have to use the application side
component IntentHandler, which works the same way, but provides all the necessary
meta-data in the application's info.yaml manifest file.
For more information see IntentHandler and the description of the \l{manifest-intent}
{meta-data in the manifest documentation}.
Callbacks connected to the onRequestReceived signal have access to the sender's application ID.
Due to security restrictions, this is \b not the case for such handlers implemented in an
application context via IntentHandler.
*/
/*! \qmlproperty url IntentServerHandler::icon
The intent's icon - see the \l{manifest-intent}{manifest documentation} for more
details.
\note Any changes to this property after component completion will have no effect.
*/
/*! \qmlproperty object IntentServerHandler::names
The intent's name - see the \l{manifest-intent}{manifest documentation} for more
details.
\note Any changes to this property after component completion will have no effect.
*/
/*! \qmlproperty list<string> IntentServerHandler::categories
The intent's categories - see the \l{manifest-intent}{manifest documentation} for more
details.
\note Any changes to this property after component completion will have no effect.
*/
/*! \qmlproperty enum IntentServerHandler::visibility
The intent's visibility - see the \l{manifest-intent}{manifest documentation} for more
details.
Can be either \c IntentObject.Public or \c IntentObject.Private (the default).
\note Any changes to this property after component completion will have no effect.
*/
/*! \qmlproperty list<string> IntentServerHandler::requiredCapabilities
The intent's required capabilities - see the \l{manifest-intent}{manifest documentation} for
more details.
\note Any changes to this property after component completion will have no effect.
*/
/*! \qmlproperty object IntentServerHandler::parameterMatch
The intent's parameter requirements - see the \l{manifest-intent}{manifest documentation} for
more details.
\note Any changes to this property after component completion will have no effect.
*/
IntentServerHandler::IntentServerHandler(QObject *parent)
: IntentHandler(parent)
, m_intent(new Intent())
{ }
IntentServerHandler::~IntentServerHandler()
{
IntentServer *is = IntentServer::instance();
for (const auto &intent : m_registeredIntents)
is->removeIntent(intent);
delete m_intent;
}
QUrl IntentServerHandler::icon() const
{
return m_intent->icon();
}
QVariantMap IntentServerHandler::names() const
{
return m_intent->names();
}
QVariantMap IntentServerHandler::descriptions() const
{
return m_intent->descriptions();
}
QStringList IntentServerHandler::categories() const
{
return m_intent->categories();
}
Intent::Visibility IntentServerHandler::visibility() const
{
return m_intent->visibility();
}
QStringList IntentServerHandler::requiredCapabilities() const
{
return m_intent->requiredCapabilities();
}
QVariantMap IntentServerHandler::parameterMatch() const
{
return m_intent->parameterMatch();
}
void IntentServerHandler::setIcon(const QUrl &icon)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the icon property of an IntentServerHandler after creation.";
return;
}
m_intent->m_icon = icon;
}
void IntentServerHandler::setNames(const QVariantMap &names)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the names property of an IntentServerHandler after creation.";
return;
}
m_intent->m_names.clear();
for (auto it = names.cbegin(); it != names.cend(); ++it)
m_intent->m_names.insert(it.key(), it.value().toString());
}
void IntentServerHandler::setDescriptions(const QVariantMap &descriptions)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the descriptions property of an IntentServerHandler after creation.";
return;
}
m_intent->m_descriptions.clear();
for (auto it = descriptions.cbegin(); it != descriptions.cend(); ++it)
m_intent->m_descriptions.insert(it.key(), it.value().toString());
}
void IntentServerHandler::setCategories(const QStringList &categories)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the categories property of an IntentServerHandler after creation.";
return;
}
m_intent->m_categories = categories;
}
void IntentServerHandler::setVisibility(Intent::Visibility visibility)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the visibility property of an IntentServerHandler after creation.";
return;
}
m_intent->m_visibility = visibility;
}
void IntentServerHandler::setRequiredCapabilities(const QStringList &requiredCapabilities)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the requiredCapabilities property of an IntentServerHandler after creation.";
return;
}
m_intent->m_requiredCapabilities = requiredCapabilities;
}
void IntentServerHandler::setParameterMatch(const QVariantMap ¶meterMatch)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the parameterMatch property of an IntentServerHandler after creation.";
return;
}
m_intent->m_parameterMatch = parameterMatch;
}
void IntentServerHandler::componentComplete()
{
if (QmlInProcessRuntime::determineRuntime(this)) {
qmlWarning(this) << "Using IntentServerHandler for handling events in an application "
"context does not work. Use IntentHandler instead";
return;
}
IntentServer *is = IntentServer::instance();
is->addPackage(sysUiId);
is->addApplication(sysUiId, sysUiId);
const auto ids = intentIds();
for (const auto &intentId : ids) {
// convert from QVariantMap to QMap<QString, QString>
QMap<QString, QString> names, descriptions;
const auto qvm_names = m_intent->names();
const auto qvm_descriptions = m_intent->descriptions();
for (auto it = qvm_names.cbegin(); it != qvm_names.cend(); ++it)
names.insert(it.key(), it.value().toString());
for (auto it = qvm_descriptions.cbegin(); it != qvm_descriptions.cend(); ++it)
descriptions.insert(it.key(), it.value().toString());
auto intent = is->addIntent(intentId, sysUiId, sysUiId, m_intent->requiredCapabilities(),
m_intent->visibility(), m_intent->parameterMatch(), names,
descriptions, m_intent->icon(), m_intent->categories());
if (intent)
m_registeredIntents << intent;
else
qmlWarning(this) << "IntentServerHandler: could not add intent" << intentId;
}
IntentHandler::componentComplete();
}
QT_END_NAMESPACE_AM
#include "moc_intentaminterface.cpp"
|