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
|
/****************************************************************************
**
** This file is part of the $PACKAGE_NAME$.
**
** Copyright (C) $THISYEAR$ $COMPANY_NAME$.
**
** $QT_EXTENDED_DUAL_LICENSE$
**
****************************************************************************/
#include "qmailserviceconfiguration.h"
#include <qmailcodec.h>
/*!
\class QMailServiceConfiguration
\inpublicgroup QtMessagingModule
\inpublicgroup QtPimModule
\ingroup libmessageserver
\preliminary
\brief The QMailServiceConfiguration class provides a simple framework for creating
wrappers classes that simplify service configuration management.
QMailServiceConfiguration provides a simple interface for manipulating the configuration
parameters of a single service within an account configuration. For each specific
service implemented, a configuration class derived from QMailServiceConfiguration
should be implemented to make the configuration easily accessible.
\sa QMailAccountConfiguration::ServiceConfiguration
*/
/*!
\enum QMailServiceConfiguration::ServiceType
This enum type is used to describe the type of a service
\value Unknown The type of the service is unknown.
\value Source The service is a message source.
\value Sink The service is a message sink.
\value SourceAndSink The service is both a message source and a message sink.
\value Storage The service is a content manager.
\sa QMailMessageSource, QMailMessageSink
*/
/*!
Creates a configuration object accessing the parameters of the service \a service
within the account configuration object \a config.
*/
QMailServiceConfiguration::QMailServiceConfiguration(QMailAccountConfiguration *config, const QString &service)
: _config(config->services().contains(service) ? &config->serviceConfiguration(service) : 0)
{
}
/*!
Creates a configuration object accessing the parameters of the service \a service
within the account configuration object \a config.
*/
QMailServiceConfiguration::QMailServiceConfiguration(const QMailAccountConfiguration &config, const QString &service)
: _config(const_cast<QMailAccountConfiguration::ServiceConfiguration*>(config.services().contains(service) ? &config.serviceConfiguration(service) : 0))
{
}
/*!
Creates a configuration object accessing the service configuration parameters described by \a svcCfg.
*/
QMailServiceConfiguration::QMailServiceConfiguration(const QMailAccountConfiguration::ServiceConfiguration &svcCfg)
: _config(const_cast<QMailAccountConfiguration::ServiceConfiguration*>(&svcCfg))
{
}
/*! \internal */
QMailServiceConfiguration::~QMailServiceConfiguration()
{
}
/*!
Returns the service that this configuration pertains to.
*/
QString QMailServiceConfiguration::service() const
{
return _config->service();
}
/*!
Returns the identifier of the account that this configuration pertains to.
*/
QMailAccountId QMailServiceConfiguration::id() const
{
return _config->id();
}
/*!
Returns the version of the service configuration.
*/
int QMailServiceConfiguration::version() const
{
return value("version", "0").toInt();
}
/*!
Sets the version of the service configuration to \a version.
*/
void QMailServiceConfiguration::setVersion(int version)
{
setValue("version", QString::number(version));
}
/*!
Returns the type of the service.
*/
QMailServiceConfiguration::ServiceType QMailServiceConfiguration::type() const
{
QString svcType(value("servicetype"));
if (svcType == "source") {
return Source;
} else if (svcType == "sink") {
return Sink;
} else if (svcType == "source-sink") {
return SourceAndSink;
} else if (svcType == "storage") {
return Storage;
}
return Unknown;
}
/*!
Sets the type of the service to \a type.
*/
void QMailServiceConfiguration::setType(ServiceType type)
{
setValue("servicetype", (type == Source ? "source" : (type == Sink ? "sink" : (type == SourceAndSink ? "source-sink" : (type == Storage ? "storage" : "unknown")))));
}
/*!
Returns true if the service is present in the account configuration.
*/
bool QMailServiceConfiguration::isValid() const
{
return (_config != 0);
}
/*!
Returns true if no configuration parameters are recorded for the service.
*/
bool QMailServiceConfiguration::isEmpty() const
{
if (!_config)
return true;
return (_config->values().isEmpty());
}
/*!
Returns the string \a value encoded into base-64 encoded form.
*/
QString QMailServiceConfiguration::encodeValue(const QString &value)
{
// TODO: Shouldn't this be UTF-8?
QMailBase64Codec codec(QMailBase64Codec::Text);
QByteArray encoded(codec.encode(value, "ISO-8859-1"));
return QString::fromLatin1(encoded.constData(), encoded.length());
}
/*!
Returns the string \a value decoded from base-64 encoded form.
*/
QString QMailServiceConfiguration::decodeValue(const QString &value)
{
if (value.isEmpty())
return QString();
QByteArray encoded(value.toAscii());
QMailBase64Codec codec(QMailBase64Codec::Text);
return codec.decode(encoded, "ISO-8859-1");
}
/*!
Returns the value of the configuration parameter \a name, if present.
Otherwise returns \a defaultValue.
*/
QString QMailServiceConfiguration::value(const QString &name, const QString &defaultValue) const
{
if (!_config)
return defaultValue;
QString result = _config->value(name);
if (result.isNull() && !defaultValue.isNull())
return defaultValue;
return result;
}
/*!
Sets the configuration parameter \a name to have the value \a value.
*/
void QMailServiceConfiguration::setValue(const QString &name, const QString &value)
{
if (!_config) {
qWarning() << "Attempted to modify uninitialized configuration! (" << name << ":" << value << ")";
} else {
_config->setValue(name, value);
}
}
|
