src/intent-client-lib/intentclient.h


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

// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#pragma once

#include <QObject>
#include <QString>
#include <QVariantMap>
#include <QList>
#include <QMap>
#include <QPair>
#include <QElapsedTimer>

#include <QtAppManCommon/global.h>

QT_BEGIN_NAMESPACE_AM

class IntentHandler;
class IntentClientRequest;
class IntentClientSystemInterface;

/* internal interface used by IntentRequest and IntentHandler */

class IntentClient : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("AM-QmlType", "QtApplicationManager/IntentClient 2.0 SINGLETON")

public:
    ~IntentClient() override;
    static IntentClient *createInstance(IntentClientSystemInterface *systemInterface);
    static IntentClient *instance();

    void setReplyFromSystemTimeout(int timeout);
    void setReplyFromApplicationTimeout(int timeout);

    IntentClientRequest *requestToSystem(const QString &requestingApplicationId, const QString &intentId,
                                         const QString &applicationId, const QVariantMap &parameters);
    void replyFromApplication(IntentClientRequest *icr, const QVariantMap &result);
    void errorReplyFromApplication(IntentClientRequest *icr, const QString &errorMessage);

    void registerHandler(IntentHandler *handler);
    void unregisterHandler(IntentHandler *handler);

    Q_INVOKABLE QT_PREPEND_NAMESPACE_AM(IntentClientRequest) *sendIntentRequest(const QString &intentId,
                                                                                const QVariantMap &parameters);
    Q_INVOKABLE QT_PREPEND_NAMESPACE_AM(IntentClientRequest) *sendIntentRequest(const QString &intentId,
                                                                                const QString &applicationId,
                                                                                const QVariantMap &parameters);

private:
    void requestToSystemFinished(IntentClientRequest *icr, const QUuid &newRequestId,
                                 bool error, const QString &errorMessage);
    void replyFromSystem(const QUuid &requestId, bool error, const QVariantMap &result);

    void requestToApplication(const QUuid &requestId, const QString &intentId, const QString &requestingApplicationId,
                              const QString &applicationId, const QVariantMap &parameters);

private:
    IntentClient(IntentClientSystemInterface *systemInterface, QObject *parent = nullptr);
    Q_DISABLE_COPY(IntentClient)
    static IntentClient *s_instance;

    QList<QPointer<IntentClientRequest>> m_waiting;
    QElapsedTimer m_lastWaitingCleanup;
    QMap<QPair<QString, QString>, IntentHandler *> m_handlers; // intentId + appId -> handler

    // no timeouts by default -- these have to be set at runtime
    int m_replyFromSystemTimeout = 0;
    int m_replyFromApplicationTimeout = 0;

    IntentClientSystemInterface *m_systemInterface;
    friend class IntentClientSystemInterface;
};

QT_END_NAMESPACE_AM