/*!
* Finds a property in the \a document with the given \a propertyName, adds it to \a toBeRemoved,
* and returns it.
*/
QVersitProperty VersitUtils::takeProperty(const QVersitDocument& document,
const QString& propertyName,
QList<QVersitProperty>* toBeRemoved) {
foreach (const QVersitProperty& currentProperty, document.properties()) {
if (currentProperty.name() == propertyName) {
*toBeRemoved << currentProperty;
return currentProperty;
}
}
return QVersitProperty();
}
void tst_QVersitDocument::testHash()
{
QVersitDocument document1;
document1.setType(QVersitDocument::VCard30Type);
QVersitProperty property1;
property1.setName(QLatin1String("name"));
property1.setValue(QLatin1String("value"));
document1.addProperty(property1);
QVersitDocument document2;
document2.setType(QVersitDocument::VCard30Type);
document2.addProperty(property1);
QVersitDocument document3;
document3.setType(QVersitDocument::VCard30Type);
QVersitProperty property3;
property3.setName(QLatin1String("name"));
property3.setValue(QLatin1String("another value"));
document3.addProperty(property3);
QVersitDocument document4; // no properties
document4.setType(QVersitDocument::VCard30Type);
QVersitDocument document5 = document1;
document5.addSubDocument(document4);
QVersitDocument document6 = document1;
document6.setComponentType(QLatin1String("VEVENT"));
QVersitDocument document7 = document1;
document7.addProperty(QVersitProperty());
QVERIFY(qHash(document1) == qHash(document2));
QVERIFY(qHash(document1) != qHash(document3));
QVERIFY(qHash(document1) != qHash(document4));
QVERIFY(qHash(document1) != qHash(document5));
QVERIFY(qHash(document1) != qHash(document6));
QVERIFY(qHash(document1) != qHash(document7));
}
void tst_QVCard30Writer::testEncodeVersitProperty_data()
{
QTest::addColumn<QVersitProperty>("property");
QTest::addColumn<QByteArray>("expectedResult");
QVersitProperty property;
QByteArray expectedResult;
// No parameters
expectedResult = "FN:John Citizen\r\n";
property.setName(QString::fromAscii("FN"));
property.setValue(QString::fromAscii("John Citizen"));
QTest::newRow("No parameters") << property << expectedResult;
// With parameter(s)
expectedResult = "TEL;TYPE=HOME:123\r\n";
property.setName(QString::fromAscii("TEL"));
property.setValue(QString::fromAscii("123"));
property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("HOME"));
QTest::newRow("With parameters, plain value") << property << expectedResult;
// normal FN property is backslash escaped
property.clear();
property.setName(QLatin1String("FN"));
property.setValue(QLatin1String(";,:\\"));
// semicolons, commas and backslashes are escaped (not colons, as per RFC2426)
expectedResult = "FN:\\;\\,:\\\\\r\n";
QTest::newRow("FN property") << property << expectedResult;
// Structured N
property.setName(QLatin1String("N"));
property.setValue(QStringList()
<< QLatin1String("La;st") // needs to be backslash escaped
<< QLatin1String("Fi,rst")
<< QLatin1String("Mi:ddle")
<< QLatin1String("Pr\\efix") // needs to be QP encoded
<< QLatin1String("Suffix"));
property.setValueType(QVersitProperty::CompoundType);
expectedResult = "N:La\\;st;Fi\\,rst;Mi:ddle;Pr\\\\efix;Suffix\r\n";
QTest::newRow("N property") << property << expectedResult;
// Structured CATEGORIES
property.setName(QLatin1String("CATEGORIES"));
property.setValue(QStringList()
<< QLatin1String("re;d")
<< QLatin1String("gr,een")
<< QLatin1String("bl:ue")
<< QLatin1String("ye\\llow"));
property.setValueType(QVersitProperty::ListType);
expectedResult = "CATEGORIES:re\\;d,gr\\,een,bl:ue,ye\\\\llow\r\n";
QTest::newRow("CATEGORIES property") << property << expectedResult;
// Convert X-NICKNAME to NICKNAME
expectedResult = "NICKNAME:Jack\r\n";
property.setParameters(QMultiHash<QString,QString>());
property.setName(QString::fromAscii("X-NICKNAME"));
property.setValue(QString::fromAscii("Jack"));
QTest::newRow("NICKNAME property") << property << expectedResult;
// Convert X-IMPP to IMPP;
expectedResult = "IMPP:msn:msn-address\r\n";
property.setParameters(QMultiHash<QString,QString>());
property.setName(QString::fromAscii("X-IMPP"));
property.setValue(QString::fromAscii("msn:msn-address"));
QTest::newRow("IMPP property") << property << expectedResult;
// AGENT property
expectedResult = "AGENT:BEGIN:VCARD\\nVERSION:3.0\\nFN:Secret Agent\\nEND:VCARD\\n\r\n";
property.setName(QString::fromAscii("AGENT"));
property.setValue(QString());
QVersitDocument document(QVersitDocument::VCard30Type);
document.setComponentType(QLatin1String("VCARD"));
QVersitProperty embeddedProperty;
embeddedProperty.setName(QString(QString::fromAscii("FN")));
embeddedProperty.setValue(QString::fromAscii("Secret Agent"));
document.addProperty(embeddedProperty);
property.setValue(QVariant::fromValue(document));
QTest::newRow("AGENT property") << property << expectedResult;
// Value is base64 encoded.
QByteArray value("value");
expectedResult = "Springfield.HOUSE.PHOTO;ENCODING=b:" + value.toBase64() + "\r\n";
QStringList groups(QString::fromAscii("Springfield"));
groups.append(QString::fromAscii("HOUSE"));
property.setGroups(groups);
property.setParameters(QMultiHash<QString,QString>());
property.setName(QString::fromAscii("PHOTO"));
property.setValue(value);
QTest::newRow("base64 encoded") << property << expectedResult;
// Characters other than ASCII:
expectedResult = "ORG:" + KATAKANA_NOKIA.toUtf8() + "\r\n";
property = QVersitProperty();
property.setName(QLatin1String("ORG"));
property.setValue(KATAKANA_NOKIA);
QTest::newRow("non-ASCII") << property << expectedResult;
// No CHARSET and QUOTED-PRINTABLE parameters
expectedResult = "EMAIL:john@" + KATAKANA_NOKIA.toUtf8() + ".com\r\n";
property = QVersitProperty();
property.setName(QLatin1String("EMAIL"));
property.setValue(QString::fromAscii("john@%1.com").arg(KATAKANA_NOKIA));
QTest::newRow("special chars") << property << expectedResult;
}
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;HOME;ENCODING=QUOTED-PRINTABLE:john.citizen=40example.com\r\n";
property.setName(QString::fromLatin1("EMAIL"));
property.setValue(QString::fromLatin1("*****@*****.**"));
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");
}
