summaryrefslogtreecommitdiffstats
path: root/src/application-lib/packageinfo.h
blob: 1c59f64e9b8b72245bccdd73a870e365b8c0845b (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
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt 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 <QDir>
#include <QMap>
#include <QString>
#include <QStringList>
#include <QVariantMap>
#include <QVector>

#include <QtAppManCommon/global.h>

QT_FORWARD_DECLARE_CLASS(QDataStream)

class tst_Application;

QT_BEGIN_NAMESPACE_AM

class InstallationReport;
class IntentInfo;
class ApplicationInfo;
class YamlPackageScanner;

class PackageInfo
{
public:
    ~PackageInfo();

    void validate() const Q_DECL_NOEXCEPT_EXPR(false);

    QString id() const;

    QMap<QString, QString> names() const;
    QString name(const QString &language) const;
    QMap<QString, QString> descriptions() const;
    QString description(const QString &language) const;
    QString icon() const;
    QStringList categories() const;

    bool isBuiltIn() const;
    void setBuiltIn(bool builtIn);
    QString version() const;
    uint uid() const { return m_uid; }

    const QDir &baseDir() const;
    void setBaseDir(const QDir &dir);

    QVector<ApplicationInfo *> applications() const;
    QVector<IntentInfo *> intents() const;

    const InstallationReport *installationReport() const;
    void setInstallationReport(InstallationReport *report);

    void writeToDataStream(QDataStream &ds) const;
    static PackageInfo *readFromDataStream(QDataStream &ds);

    static bool isValidApplicationId(const QString &appId, QString *errorString = nullptr);
    static bool isValidIcon(const QString &icon, QString *errorString = nullptr);

    QString manifestPath() const;

    static PackageInfo *fromManifest(const QString &manifestPath);

private:
    PackageInfo();

    QString m_manifestName;
    QString m_id;
    QMap<QString, QString> m_names; // language -> name
    QMap<QString, QString> m_descriptions; // language -> description
    QStringList m_categories;
    QString m_icon; // relative to info.json location
    QString m_version;
    bool m_builtIn = false; // system package - not removable
    uint m_uid = uint(-1); // unix user id - move to installationReport
    QVector<ApplicationInfo *> m_applications;
    QVector<IntentInfo *> m_intents;

    // added by installer
    QScopedPointer<InstallationReport> m_installationReport;
    QDir m_baseDir;

    friend class YamlPackageScanner;
    friend class InstallationTask;
    Q_DISABLE_COPY(PackageInfo)
};

QT_END_NAMESPACE_AM