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
|
/******************************************************************************
* Copyright (C) 2016 Kitsune Ral <kitsune-ral@users.sf.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include <QtCore/QSettings>
#include <QtCore/QUrl>
#include <QtCore/QVector>
class QVariant;
namespace Quotient {
class Settings : public QSettings {
Q_OBJECT
public:
/// Add a legacy organisation/application name to migrate settings from
/*!
* Use this function before creating any Settings objects in order
* to set a legacy location where configuration has previously been stored.
* This will provide an additional fallback in case of renaming
* the organisation/application. Values in legacy locations are _removed_
* when setValue() or remove() is called.
*/
static void setLegacyNames(const QString& organizationName,
const QString& applicationName = {});
explicit Settings(QObject* parent = nullptr);
/// Set the value for a given key
/*! If the key exists in the legacy location, it is removed. */
Q_INVOKABLE void setValue(const QString& key, const QVariant& value);
/// Remove the value from both the primary and legacy locations
Q_INVOKABLE void remove(const QString& key);
/// Obtain a value for a given key
/*!
* If the key doesn't exist in the primary settings location, the legacy
* location is checked. If neither location has the key,
* \p defaultValue is returned.
*
* This function returns a QVariant; use get<>() to get the unwrapped
* value if you know the type upfront.
*
* \sa setLegacyNames, get
*/
Q_INVOKABLE QVariant value(const QString& key,
const QVariant& defaultValue = {}) const;
/// Obtain a value for a given key, coerced to the given type
/*!
* On top of value(), this function unwraps the QVariant and returns
* its contents assuming the type passed as the template parameter.
* If the type is different from the one stored inside the QVariant,
* \p defaultValue is returned. In presence of legacy settings,
* only the first found value is checked; if its type does not match,
* further checks through legacy settings are not performed and
* \p defaultValue is returned.
*/
template <typename T>
T get(const QString& key, const T& defaultValue = {}) const
{
const auto qv = value(key, QVariant());
return qv.isValid() && qv.canConvert<T>() ? qv.value<T>() : defaultValue;
}
Q_INVOKABLE bool contains(const QString& key) const;
Q_INVOKABLE QStringList childGroups() const;
private:
static QString legacyOrganizationName;
static QString legacyApplicationName;
protected:
QSettings legacySettings { legacyOrganizationName, legacyApplicationName };
};
class SettingsGroup : public Settings {
public:
template <typename... ArgTs>
explicit SettingsGroup(QString path, ArgTs&&... qsettingsArgs)
: Settings(std::forward<ArgTs>(qsettingsArgs)...)
, groupPath(std::move(path))
{}
Q_INVOKABLE bool contains(const QString& key) const;
Q_INVOKABLE QVariant value(const QString& key,
const QVariant& defaultValue = {}) const;
template <typename T>
T get(const QString& key, const T& defaultValue = {}) const
{
const auto qv = value(key, QVariant());
return qv.isValid() && qv.canConvert<T>() ? qv.value<T>() : defaultValue;
}
Q_INVOKABLE QString group() const;
Q_INVOKABLE QStringList childGroups() const;
Q_INVOKABLE void setValue(const QString& key, const QVariant& value);
Q_INVOKABLE void remove(const QString& key);
private:
QString groupPath;
};
#define QTNT_DECLARE_SETTING(type, propname, setter) \
Q_PROPERTY(type propname READ propname WRITE setter) \
public: \
type propname() const; \
void setter(type newValue); \
\
private:
#define QTNT_DEFINE_SETTING(classname, type, propname, qsettingname, \
defaultValue, setter) \
type classname::propname() const \
{ \
return get<type>(QStringLiteral(qsettingname), defaultValue); \
} \
\
void classname::setter(type newValue) \
{ \
setValue(QStringLiteral(qsettingname), std::move(newValue)); \
}
class AccountSettings : public SettingsGroup {
Q_OBJECT
Q_PROPERTY(QString userId READ userId CONSTANT)
QTNT_DECLARE_SETTING(QString, deviceId, setDeviceId)
QTNT_DECLARE_SETTING(QString, deviceName, setDeviceName)
QTNT_DECLARE_SETTING(bool, keepLoggedIn, setKeepLoggedIn)
/** \deprecated \sa setAccessToken */
Q_PROPERTY(QString accessToken READ accessToken WRITE setAccessToken)
Q_PROPERTY(QByteArray encryptionAccountPickle READ encryptionAccountPickle
WRITE setEncryptionAccountPickle)
public:
template <typename... ArgTs>
explicit AccountSettings(const QString& accountId, ArgTs... qsettingsArgs)
: SettingsGroup("Accounts/" + accountId, qsettingsArgs...)
{}
QString userId() const;
QUrl homeserver() const;
void setHomeserver(const QUrl& url);
/** \deprecated \sa setToken */
QString accessToken() const;
/** \deprecated Storing accessToken in QSettings is unsafe,
* see quotient-im/Quaternion#181 */
void setAccessToken(const QString& accessToken);
Q_INVOKABLE void clearAccessToken();
QByteArray encryptionAccountPickle();
void setEncryptionAccountPickle(const QByteArray& encryptionAccountPickle);
Q_INVOKABLE void clearEncryptionAccountPickle();
};
} // namespace Quotient
|
