summaryrefslogtreecommitdiffstats
path: root/src/intent-server-lib/intentserver.h
blob: 1bf62adeea00c716778299114c676e8a8c43c24c (plain)
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
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Luxoft Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or 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.GPL2 and 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/

#pragma once

#include <QObject>
#include <QVariantMap>
#include <QVector>
#include <QUuid>
#include <QQueue>
#include <QtAppManCommon/global.h>
#include <QtAppManIntentServer/intent.h>


QT_BEGIN_NAMESPACE_AM

class AbstractRuntime;
class IntentServerRequest;
class IntentServerSystemInterface;

// We cannot expose a list of Q_GADGETs to QML in a type-safe way. We can however
// at least try to make the C++ side of the API a bit more descriptive.
typedef QVariantList IntentList;

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

    Q_PROPERTY(IntentList intentList READ intentList NOTIFY intentListChanged)

public:
    ~IntentServer() override;
    static IntentServer *createInstance(IntentServerSystemInterface *systemInterface);
    static IntentServer *instance();

    void setDisambiguationTimeout(int timeout);
    void setStartApplicationTimeout(int timeout);
    void setReplyFromApplicationTimeout(int timeout);

    bool addApplication(const QString &applicationId);
    void removeApplication(const QString &applicationId);

    bool addApplicationBackgroundHandler(const QString &applicationId, const QString &backgroundServiceId);
    void removeApplicationBackgroundHandler(const QString &applicationId, const QString &backgroundServiceId);

    Intent addIntent(const QString &id, const QString &applicationId, const QStringList &capabilities,
                     Intent::Visibility visibility, const QVariantMap &parameterMatch = QVariantMap());

    Intent addIntent(const QString &id, const QString &applicationId, const QString &backgroundHandlerId,
                     const QStringList &capabilities, Intent::Visibility visibility,
                     const QVariantMap &parameterMatch = QVariantMap());

    void removeIntent(const Intent &intent);

    QVector<Intent> all() const;
    QVector<Intent> filterByIntentId(const QVector<Intent> &intents, const QString &intentId,
                                     const QVariantMap &parameters = QVariantMap{}) const;
    QVector<Intent> filterByHandlingApplicationId(const QVector<Intent> &intents,
                                                  const QString &handlingApplicationId,
                                                  const QVariantMap &parameters = QVariantMap{}) const;
    QVector<Intent> filterByRequestingApplicationId(const QVector<Intent> &intents,
                                                    const QString &requestingApplicationId) const;

    // vvv QML API vvv

    IntentList intentList() const;

    Q_INVOKABLE Intent find(const QString &intentId, const QString &applicationId,
                            const QVariantMap &parameters = QVariantMap{}) const;

    Q_INVOKABLE void acknowledgeDisambiguationRequest(const QUuid &requestId, const Intent &selectedIntent);
    Q_INVOKABLE void rejectDisambiguationRequest(const QUuid &requestId);

signals:
    void intentAdded(const Intent &intent);
    void intentRemoved(const Intent &intent);
    void intentListChanged();

    void disambiguationRequest(const QUuid &requestId, const IntentList &potentialIntents,
                               const QVariantMap &parameters);
    /// ^^^ QML API ^^^

private:
    void internalDisambiguateRequest(const QUuid &requestId, bool reject, const Intent &selectedIntent);
    void applicationWasStarted(const QString &applicationId);
    void replyFromApplication(const QString &replyingApplicationId, const QUuid &requestId,
                              bool error, const QVariantMap &result);
    IntentServerRequest *requestToSystem(const QString &requestingApplicationId, const QString &intentId,
                                         const QString &applicationId, const QVariantMap &parameters);

    void triggerRequestQueue();
    void enqueueRequest(IntentServerRequest *isr);
    void processRequestQueue();

    static IntentList convertToQml(const QVector<Intent> &intents);

private:
    IntentServer(IntentServerSystemInterface *systemInterface, QObject *parent = nullptr);
    Q_DISABLE_COPY(IntentServer)
    static IntentServer *s_instance;

    QStringList m_knownApplications;
    QMap<QString, QStringList> m_knownBackgroundServices;

    QQueue<IntentServerRequest *> m_requestQueue;

    QQueue<IntentServerRequest *> m_disambiguationQueue;
    QQueue<IntentServerRequest *> m_startingAppQueue;
    QQueue<IntentServerRequest *> m_sentToAppQueue;

    int m_disambiguationTimeout = 10000;
    int m_startingAppTimeout = 3000;
    int m_sentToAppTimeout = 5000;

    QVector<Intent> m_intents;

    IntentServerSystemInterface *m_systemInterface;
    friend class IntentServerSystemInterface;
};

QT_END_NAMESPACE_AM