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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
//TESTED_COMPONENT=src/versit
#include "tst_qvcard21writer.h"
#ifdef QT_BUILD_INTERNAL
#include <QtVersit/private/qvcard21writer_p.h>
#endif
#include <QtVersit/qversitproperty.h>
#include <QtVersit/qversitdocument.h>
#include <QtTest/QtTest>
#include <QByteArray>
#include <QVariant>
// This says "NOKIA" in Katakana
const QString KATAKANA_NOKIA(QString::fromUtf8("\xe3\x83\x8e\xe3\x82\xad\xe3\x82\xa2"));
QTVERSIT_USE_NAMESPACE
Q_DECLARE_METATYPE(QVersitProperty)
// Because the QFETCH macro balks on the comma in QMultiHash<QString,QString>
typedef QMultiHash<QString,QString> StringHash;
Q_DECLARE_METATYPE(StringHash)
#ifdef QT_BUILD_INTERNAL
void tst_QVCard21Writer::init()
{
mWriter = new QVCard21Writer(QVersitDocument::VCard21Type);
mWriter->setCodec(QTextCodec::codecForName("ISO_8859-1"));
}
void tst_QVCard21Writer::cleanup()
{
delete mWriter;
}
void tst_QVCard21Writer::testEncodeVersitProperty()
{
QFETCH(QVersitProperty, property);
QFETCH(QByteArray, expectedResult);
QFETCH(QByteArray, codec);
QTextCodec* textCodec = QTextCodec::codecForName(codec);
QByteArray encodedProperty;
QBuffer buffer(&encodedProperty);
mWriter->setDevice(&buffer);
mWriter->setCodec(textCodec);
buffer.open(QIODevice::WriteOnly);
mWriter->encodeVersitProperty(property);
if (encodedProperty != expectedResult) {
qDebug() << "Encoded: " << encodedProperty;
qDebug() << "Expected: " << expectedResult;
QVERIFY(false);
}
}
void tst_QVCard21Writer::testEncodeVersitProperty_data()
{
QTest::addColumn<QVersitProperty>("property");
QTest::addColumn<QByteArray>("expectedResult");
QTest::addColumn<QByteArray>("codec");
QVersitProperty property;
QByteArray expectedResult;
QByteArray codec("ISO-8859_1");
// normal case
property.setName(QString::fromLatin1("FN"));
property.setValue(QString::fromLatin1("John Citizen"));
property.setValueType(QVersitProperty::PlainType);
expectedResult = "FN:John Citizen\r\n";
QTest::newRow("No parameters") << property << expectedResult << codec;
// Structured N - escaping should happen for semicolons, not for commas
property.setName(QStringLiteral("N"));
property.setValue(QStringList()
<< QStringLiteral("La;st") // needs to be backslash escaped
<< QStringLiteral("Fi,rst")
<< QStringLiteral("Mi:ddle")
<< QStringLiteral("Pr\\efix") // needs to be QP encoded
<< QStringLiteral("Suffix"));
property.setValueType(QVersitProperty::CompoundType);
expectedResult = "N;ENCODING=QUOTED-PRINTABLE:La\\;st;Fi,rst;Mi:ddle;Pr=5Cefix;Suffix\r\n";
QTest::newRow("N property") << property << expectedResult << codec;
// Structured N - there was a bug where if two fields had to be escaped,
// two ENCODING parameters were added
property.setName(QStringLiteral("N"));
property.setValue(QStringList()
<< QStringLiteral("La\\st")
<< QStringLiteral("Fi\\rst")
<< QString()
<< QString()
<< QString());
property.setValueType(QVersitProperty::CompoundType);
expectedResult = "N;ENCODING=QUOTED-PRINTABLE:La=5Cst;Fi=5Crst;;;\r\n";
QTest::newRow("N property, double-encoded") << property << expectedResult << codec;
// Structured N - one field needs to be encoded in UTF-8 while the other doesn't
// correct behaviour is to encode the whole thing in UTF-8
property.setName(QStringLiteral("N"));
property.setValue(QStringList()
<< QString::fromUtf8("\xE2\x82\xAC") // euro sign
<< QString::fromLatin1("\xA3") // pound sign (upper Latin-1)
<< QString()
<< QString()
<< QString());
property.setValueType(QVersitProperty::CompoundType);
expectedResult = "N;CHARSET=UTF-8;ENCODING=QUOTED-PRINTABLE:=E2=82=AC;=C2=A3;;;\r\n";
QTest::newRow("N property, double-encoded") << property << expectedResult << codec;
// Structured CATEGORIES - escaping should happen for commas, not semicolons
property.setName(QStringLiteral("CATEGORIES"));
property.setValue(QStringList()
<< QStringLiteral("re;d")
<< QStringLiteral("gr,een")
<< QStringLiteral("bl:ue"));
property.setValueType(QVersitProperty::ListType);
expectedResult = "CATEGORIES:re;d,gr\\,een,bl:ue\r\n";
QTest::newRow("CATEGORIES property") << property << expectedResult << codec;
// With parameter(s). No special characters in the value.
// -> No need to Quoted-Printable encode the value.
expectedResult = "TEL;HOME:123\r\n";
property.setName(QString::fromLatin1("TEL"));
property.setValue(QString::fromLatin1("123"));
property.insertParameter(QString::fromLatin1("TYPE"),QString::fromLatin1("HOME"));
QTest::newRow("With parameters, plain value") << property << expectedResult << codec;
expectedResult = "EMAIL;ENCODING=QUOTED-PRINTABLE;HOME:john.citizen=40example.com\r\n";
property.setName(QString::fromLatin1("EMAIL"));
property.setValue(QString::fromLatin1("john.citizen@example.com"));
QTest::newRow("With parameters, special value") << property << expectedResult << codec;
// AGENT property with parameter
expectedResult =
"AGENT;X-PARAMETER=VALUE:\r\n\
BEGIN:VCARD\r\n\
VERSION:2.1\r\n\
FN:Secret Agent\r\n\
END:VCARD\r\n\
\r\n";
property.setParameters(QMultiHash<QString,QString>());
property.setName(QString::fromLatin1("AGENT"));
property.setValue(QString());
property.insertParameter(QString::fromLatin1("X-PARAMETER"),QString::fromLatin1("VALUE"));
QVersitDocument document(QVersitDocument::VCard21Type);
document.setComponentType(QStringLiteral("VCARD"));
QVersitProperty embeddedProperty;
embeddedProperty.setName(QString(QString::fromLatin1("FN")));
embeddedProperty.setValue(QString::fromLatin1("Secret Agent"));
document.addProperty(embeddedProperty);
property.setValue(QVariant::fromValue(document));
QTest::newRow("AGENT property") << property << expectedResult << codec;
// Value is base64 encoded.
// Check that the extra folding and the line break are added
QByteArray value("value");
expectedResult = "Springfield.HOUSE.PHOTO;ENCODING=BASE64:\r\n " + value.toBase64() + "\r\n\r\n";
QStringList groups(QString::fromLatin1("Springfield"));
groups.append(QString::fromLatin1("HOUSE"));
property.setGroups(groups);
property.setParameters(QMultiHash<QString,QString>());
property.setName(QString::fromLatin1("PHOTO"));
property.setValue(value);
QTest::newRow("base64 encoded") << property << expectedResult << codec;
// Characters other than ASCII:
// Note: KATAKANA_NOKIA is defined as: QString::fromUtf8("\xe3\x83\x8e\xe3\x82\xad\xe3\x82\xa2")
// The expected behaviour is to convert to UTF8, then encode with quoted-printable.
// Because the result overflows one line, it should be split onto two lines using a
// quoted-printable soft line break (EQUALS-CR-LF). (Note: Versit soft line breaks
// (CR-LF-SPACE) are not supported by the native Symbian vCard importers).
expectedResult = "ORG;CHARSET=UTF-8;ENCODING=QUOTED-PRINTABLE:=E3=83=8E=E3=82=AD=E3=82=A2=E3=\r\n"
"=83=8E=E3=82=AD=E3=82=A2\r\n";
property = QVersitProperty();
property.setName(QStringLiteral("ORG"));
property.setValue(KATAKANA_NOKIA + KATAKANA_NOKIA);
QTest::newRow("non-ASCII 1") << property << expectedResult << codec;
expectedResult = "ORG;CHARSET=UTF-8;ENCODING=QUOTED-PRINTABLE:a=E3=83=8E=E3=82=AD=E3=82=A2=E3=\r\n"
"=83=8E=E3=82=AD=E3=82=A2\r\n";
property = QVersitProperty();
property.setName(QStringLiteral("ORG"));
property.setValue("a" + KATAKANA_NOKIA + KATAKANA_NOKIA);
QTest::newRow("non-ASCII 2") << property << expectedResult << codec;
expectedResult = "ORG;CHARSET=UTF-8;ENCODING=QUOTED-PRINTABLE:aa=E3=83=8E=E3=82=AD=E3=82=A2=\r\n"
"=E3=83=8E=E3=82=AD=E3=82=A2\r\n";
property = QVersitProperty();
property.setName(QStringLiteral("ORG"));
property.setValue("aa" + KATAKANA_NOKIA + KATAKANA_NOKIA);
QTest::newRow("non-ASCII 3") << property << expectedResult << codec;
// In Shift-JIS codec.
QTextCodec* jisCodec = QTextCodec::codecForName("Shift-JIS");
expectedResult = jisCodec->fromUnicode(
QStringLiteral("ORG:") + KATAKANA_NOKIA + QStringLiteral("\r\n"));
property = QVersitProperty();
property.setName(QStringLiteral("ORG"));
property.setValue(KATAKANA_NOKIA);
QTest::newRow("JIS codec") << property << expectedResult << QByteArray("Shift-JIS");
}
void tst_QVCard21Writer::testEncodeParameters()
{
QFETCH(StringHash, parameters);
QFETCH(QByteArray, expected);
QByteArray encodedParameters;
QBuffer buffer(&encodedParameters);
mWriter->setDevice(&buffer);
buffer.open(QIODevice::WriteOnly);
// No parameters
mWriter->encodeParameters(parameters);
if (encodedParameters != expected) {
qDebug() << "Encoded: " << encodedParameters;
qDebug() << "Expected: " << expected;
QVERIFY(false);
}
}
void tst_QVCard21Writer::testEncodeParameters_data()
{
QTest::addColumn< QMultiHash<QString, QString> >("parameters");
QTest::addColumn<QByteArray>("expected");
QMultiHash<QString,QString> parameters;
QTest::newRow("No parameters") << parameters << QByteArray("");
parameters.insert(QStringLiteral("TYPE"), QString::fromLatin1("HOME"));
QTest::newRow("One TYPE parameter") << parameters << QByteArray(";HOME");
// HOME should appear before VOICE because it is more "important" and some vCard
// parsers may ignore everything after the first TYPE
parameters.insert(QStringLiteral("TYPE"), QString::fromLatin1("VOICE"));
QTest::newRow("Two TYPE parameters") << parameters << QByteArray(";HOME;VOICE");
parameters.clear();
parameters.insert(QStringLiteral("ENCODING"), QString::fromLatin1("8BIT"));
QTest::newRow("One ENCODING parameter") << parameters << QByteArray(";ENCODING=8BIT");
parameters.insert(QString::fromLatin1("X-PARAM"),QString::fromLatin1("VALUE"));
QTest::newRow("Two parameters") << parameters << QByteArray(";ENCODING=8BIT;X-PARAM=VALUE");
parameters.clear();
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("VOICE"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("CELL"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("MODEM"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("CAR"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("VIDEO"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("FAX"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("BBS"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("PAGER"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("HOME"));
parameters.insert(QStringLiteral("TYPE"), QStringLiteral("WORK"));
// Ensure CELL and FAX are at the front because they are "more important" and some vCard
// parsers may ignore everything after the first TYPE
// Ensure WORK and HOME come next.
// Besides these conditions, there are no other ordering constraints. The data here is simply
// what the writer produces (as dictated by its internal data structures).
QTest::newRow("TYPE parameters order") << parameters
<< QByteArray(";FAX;CELL;WORK;HOME;PAGER;BBS;VIDEO;CAR;MODEM;VOICE");
}
void tst_QVCard21Writer::testEncodeGroupsAndName()
{
QVersitProperty property;
QByteArray result;
QBuffer buffer(&result);
mWriter->setDevice(&buffer);
buffer.open(QIODevice::WriteOnly);
// No groups
property.setName(QString::fromLatin1("name"));
QByteArray expected("NAME");
mWriter->encodeGroupsAndName(property);
QCOMPARE(result, expected);
// One group
mWriter->writeCrlf(); // so it doesn't start folding
buffer.close();
result.clear();
buffer.open(QIODevice::WriteOnly);
property.setGroups(QStringList(QString::fromLatin1("group")));
expected = "group.NAME";
mWriter->encodeGroupsAndName(property);
QCOMPARE(result, expected);
// Two groups
mWriter->writeCrlf(); // so it doesn't start folding
buffer.close();
result.clear();
buffer.open(QIODevice::WriteOnly);
QStringList groups(QString::fromLatin1("group1"));
groups.append(QString::fromLatin1("group2"));
property.setGroups(groups);
expected = "group1.group2.NAME";
mWriter->encodeGroupsAndName(property);
QCOMPARE(result, expected);
}
void tst_QVCard21Writer::testQuotedPrintableEncode()
{
QByteArray encodedBytes;
// Nothing to encode
QString nothingToEncode(QStringLiteral("nothing to encode"));
QVERIFY(!mWriter->quotedPrintableEncode(nothingToEncode));
// Special characters
QString inputOutput(QStringLiteral("\n"));
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=0A"));
inputOutput = QStringLiteral("\r");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=0D"));
inputOutput = QStringLiteral("!");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=21"));
inputOutput = QStringLiteral("\"");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=22"));
inputOutput = QStringLiteral("#");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=23"));
inputOutput = QStringLiteral("$");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=24"));
inputOutput = QStringLiteral("=");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=3D"));
inputOutput = QStringLiteral("@");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=40"));
inputOutput = QStringLiteral("[");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=5B"));
inputOutput = QStringLiteral("\\");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=5C"));
inputOutput = QStringLiteral("]");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=5D"));
inputOutput = QStringLiteral("^");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=5E"));
inputOutput = QStringLiteral("`");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=60"));
inputOutput = QStringLiteral("{");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=7B"));
inputOutput = QStringLiteral("|");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=7C"));
inputOutput = QStringLiteral("}");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=7D"));
inputOutput = QStringLiteral("~");
QVERIFY(mWriter->quotedPrintableEncode(inputOutput));
QCOMPARE(inputOutput, QStringLiteral("=7E"));
}
#endif
QTEST_MAIN(tst_QVCard21Writer)
|
