summaryrefslogtreecommitdiffstats
path: root/src/application-lib/application.h
blob: bed89b1236a4236d745a48df3d06cd8fc965c944 (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
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
/****************************************************************************
**
** Copyright (C) 2017 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Pelagicore 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 <QString>
#include <QUrl>
#include <QMap>
#include <QVariant>
#include <QStringList>
#include <QDir>
#include <QObject>

#include <QtAppManCommon/global.h>
#include <QtAppManCommon/exception.h>
#include <QtAppManApplication/installationreport.h>

QT_BEGIN_NAMESPACE_AM

class AbstractRuntime;
class ApplicationManager;
class JsonApplicationScanner;
class InstallationReport;

class Application : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("AM-QmlType", "QtApplicationManager/Application 1.0")

    Q_PROPERTY(QString id READ id CONSTANT)
    Q_PROPERTY(QString runtimeName READ runtimeName NOTIFY bulkChange)
    Q_PROPERTY(QVariantMap runtimeParameters READ runtimeParameters NOTIFY bulkChange)
    Q_PROPERTY(QUrl icon READ iconUrl NOTIFY bulkChange)
    Q_PROPERTY(QString documentUrl READ documentUrl NOTIFY bulkChange)
    Q_PROPERTY(qreal importance READ importance NOTIFY bulkChange)
    Q_PROPERTY(bool builtIn READ isBuiltIn CONSTANT)
    Q_PROPERTY(bool alias READ isAlias CONSTANT)
    Q_PROPERTY(bool preload READ isPreloaded NOTIFY bulkChange)
    Q_PROPERTY(const Application *nonAliased READ nonAliased CONSTANT)
    Q_PROPERTY(QStringList capabilities READ capabilities NOTIFY bulkChange)
    Q_PROPERTY(QStringList supportedMimeTypes READ supportedMimeTypes NOTIFY bulkChange)
    Q_PROPERTY(QStringList categories READ categories NOTIFY bulkChange)
    Q_PROPERTY(QVariantMap applicationProperties READ applicationProperties NOTIFY bulkChange)
    Q_PROPERTY(AbstractRuntime *runtime READ currentRuntime NOTIFY runtimeChanged)
    Q_PROPERTY(int lastExitCode READ lastExitCode NOTIFY lastExitCodeChanged)
    Q_PROPERTY(ExitStatus lastExitStatus READ lastExitStatus NOTIFY lastExitStatusChanged)
    Q_PROPERTY(QString version READ version NOTIFY bulkChange)
    Q_PROPERTY(BackgroundMode backgroundMode READ backgroundMode NOTIFY bulkChange)
    Q_PROPERTY(bool supportsApplicationInterface READ supportsApplicationInterface NOTIFY bulkChange)

public:
    enum ExitStatus { NormalExit, CrashExit, ForcedExit };
    Q_ENUM(ExitStatus)

    QString id() const;
    int uniqueNumber() const;
    QString absoluteCodeFilePath() const;
    QString codeFilePath() const;
    QString runtimeName() const;
    QVariantMap runtimeParameters() const;
    QVariantMap environmentVariables() const;
    QMap<QString, QString> names() const;
    Q_INVOKABLE QString name(const QString &language) const;
    QString icon() const;
    QUrl iconUrl() const;
    QString documentUrl() const;

    bool supportsApplicationInterface() const;
    bool isPreloaded() const;
    qreal importance() const;
    bool isBuiltIn() const;
    bool isAlias() const;
    const Application *nonAliased() const;

    QStringList capabilities() const;
    QStringList supportedMimeTypes() const;
    QStringList categories() const;
    QVariantMap applicationProperties() const;
    QVariantMap allAppProperties() const;

    enum BackgroundMode
    {
        Auto,
        Never,
        ProvidesVoIP,
        PlaysAudio,
        TracksLocation
    };
    Q_ENUM(BackgroundMode)

    BackgroundMode backgroundMode() const;

    QString version() const;

    void validate() const Q_DECL_NOEXCEPT_EXPR(false);
    QVariantMap toVariantMap() const;
    static Application *fromVariantMap(const QVariantMap &map, QString *error = 0);
    void mergeInto(Application *app) const;

    const InstallationReport *installationReport() const;
    void setInstallationReport(InstallationReport *report);
    QDir manifestDir() const;
    QDir codeDir() const;
    uint uid() const;

    // dynamic part
    AbstractRuntime *currentRuntime() const;
    void setCurrentRuntime(AbstractRuntime *rt) const;
    bool isBlocked() const;
    bool block() const;
    bool unblock() const;

    enum State {
        Installed,
        BeingInstalled,
        BeingUpdated,
        BeingRemoved
    };
    State state() const;
    qreal progress() const;

    void setSupportsApplicationInterface(bool supportsAppInterface);
    void setCodeDir(const QString &path);
    void setManifestDir(const QString &path);
    void setBuiltIn(bool builtIn);

    int lastExitCode() const;
    ExitStatus lastExitStatus() const;

signals:
    void bulkChange() const;
    void runtimeChanged() const;
    void lastExitCodeChanged() const;
    void lastExitStatusChanged() const;

private:
    Application();

    // static part from info.json
    QString m_id;
    int m_uniqueNumber;

    QString m_codeFilePath; // relative to info.json location
    QString m_runtimeName;
    QVariantMap m_runtimeParameters;
    QVariantMap m_environmentVariables;
    QMap<QString, QString> m_name; // language -> name
    QString m_icon; // relative to info.json location
    QString m_documentUrl;
    QVariantMap m_allAppProperties;
    QVariantMap m_sysAppProperties;
    bool m_supportsApplicationInterface = false;

    bool m_preload = false;
    qreal m_importance = 0; // relative to all others, with 0 being "normal"
    bool m_builtIn = false; // system app - not removable
    const Application *m_nonAliased = nullptr; // builtin only - multiple icons for the same app

    QStringList m_capabilities;
    QStringList m_categories;
    QStringList m_mimeTypes;

    BackgroundMode m_backgroundMode = Auto;

    QString m_version;

    // added by installer
    QScopedPointer<InstallationReport> m_installationReport;
    QDir m_manifestDir;
    QDir m_codeDir;
    uint m_uid = uint(-1); // unix user id - move to installationReport

    // dynamic part
    mutable AbstractRuntime *m_runtime = 0;
    mutable QAtomicInt m_blocked;
    mutable QAtomicInt m_mounted;

    mutable State m_state = Installed;
    mutable qreal m_progress = 0;

    mutable int m_lastExitCode = 0;
    mutable ExitStatus m_lastExitStatus = NormalExit;

    friend class YamlApplicationScanner;
    friend class ApplicationManager; // needed to update installation status
    friend class ApplicationDatabase; // needed to create Application objects
    friend class InstallationTask; // needed to set m_uid and m_builtin during the installation

    static Application *readFromDataStream(QDataStream &ds, const QVector<const Application *> &applicationDatabase) Q_DECL_NOEXCEPT_EXPR(false);
    void writeToDataStream(QDataStream &ds, const QVector<const Application *> &applicationDatabase) const Q_DECL_NOEXCEPT_EXPR(false);

    Q_DISABLE_COPY(Application)
};

QT_END_NAMESPACE_AM

Q_DECLARE_METATYPE(const QT_PREPEND_NAMESPACE_AM(Application *))

QDebug operator<<(QDebug debug, const QT_PREPEND_NAMESPACE_AM(Application) *app);