/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qversitdefs_p.h"

#include "tst_qversitcontactimporter.h"

#include "qversitcontactimporter.h"

#include "qversitcontactimporter_p.h"

#include <qversitproperty.h>

#include <qversitdocument.h>

#include <QtTest/QtTest>

#include <qcontact.h>

#include <qcontactdetail.h>

#include <qcontactname.h>

#include <qcontactaddress.h>

#include <qcontactphonenumber.h>

#include <qcontactemailaddress.h>

#include <qcontacturl.h>

#include <qcontactguid.h>

#include <qcontactorganization.h>

#include <qcontacttimestamp.h>

#include <qcontactanniversary.h>

#include <qcontactbirthday.h>

#include <qcontactgender.h>

#include <qcontactnickname.h>

#include <qcontactavatar.h>

#include <qcontactgeolocation.h>

#include <qcontactnote.h>

#include <qcontactonlineaccount.h>

#include <qcontactfamily.h>

#include <QDir>

QTM_BEGIN_NAMESPACE

class MyQVersitContactImporterPropertyHandler : public QVersitContactImporterPropertyHandler

{

public:

    MyQVersitContactImporterPropertyHandler()

        : mPreProcess(false)

    {

    }

    bool preProcessProperty(const QVersitDocument& document,

                            const QVersitProperty& property,

                            int contactIndex,

                            QContact* contact)

    {

        Q_UNUSED(document)

        Q_UNUSED(contact)

        Q_UNUSED(contactIndex);

        mPreProcessedProperties.append(property);

        return mPreProcess;

    }

    bool postProcessProperty(const QVersitDocument& document,

                             const QVersitProperty& property,

                             bool alreadyProcessed,

                             int contactIndex,

                             QContact* contact)

    {

        Q_UNUSED(document)

        Q_UNUSED(contact)

        Q_UNUSED(contactIndex)

        if (!alreadyProcessed)

            mUnknownProperties.append(property);

        else

            mPostProcessedProperties.append(property);

        return false;

    }

    void clear()

    {

        mPreProcess = false;

        mPropertyNamesToProcess.clear();

        mUnknownProperties.clear();

        mPreProcessedProperties.clear();

        mPostProcessedProperties.clear();

    }

    // a hook to control what preProcess returns:

    bool mPreProcess;

    QStringList mPropertyNamesToProcess;

    QList<QVersitProperty> mUnknownProperties;

    QList<QVersitProperty> mPreProcessedProperties;

    QList<QVersitProperty> mPostProcessedProperties;

};

class MyQVersitResourceHandler : public QVersitResourceHandler

{

public:

    MyQVersitResourceHandler() : mIndex(0)

    {

    }

    bool saveResource(const QByteArray& contents, const QVersitProperty& property,

                      QString* location)

    {

        Q_UNUSED(property);

        *location = QString::number(mIndex++);

        mObjects.insert(*location, contents);

        return true;

    }

    bool loadResource(const QString &location, QByteArray *contents, QString *mimeType)

    {

        Q_UNUSED(location)

        Q_UNUSED(contents)

        Q_UNUSED(mimeType)

        return false;

    }

    void clear()

    {

        mIndex = 0;

        mObjects.clear();

    }

    int mIndex;

    QMap<QUrl, QByteArray> mObjects;

};

const static QByteArray SAMPLE_GIF(QByteArray::fromBase64(

        "R0lGODlhEgASAIAAAAAAAP///yH5BAEAAAEALAAAAAASABIAAAIdjI+py+0G"

        "wEtxUmlPzRDnzYGfN3KBaKGT6rDmGxQAOw=="));

const static QByteArray NOKIA_GIF(QByteArray::fromBase64(

        "R0lGODdhOAAKAIQRAAAvwQAwwwAwxAAxxwAyygAzywAzzBBHwC9nz0+A0HCf35+/4LDQ78/f79/o"

        "8O/v8PD3/////////////////////////////////////////////////////////////ywAAAAA"

        "OAAKAAAFsCAiik9kRqPJHIfhGixjisuJpqk9Inb0vjaBC0UwFH+uhM+gNBUCw6Wh92vYDAXkCZhF"

        "apMmA3Qajppav6tr8TqUp0DqEIwtqsmRR/Kl2A4RfFKCcnBMbYR+Uw5xg2lAjIlLCS88dyYNLn1S"

        "TYwvk3NmkXSQLgVvXmQuBCcQXlI7Io9MpyWCbKgublgCNgxfP0eOs6dvUgsPyMgvEAUAeCafUWhe"

        "bpI2LQMFenuhZy8hADs="));

QTM_END_NAMESPACE

QTM_USE_NAMESPACE

void tst_QVersitContactImporter::init()

{

    mImporter = new QVersitContactImporter();

    mResourceHandler = new MyQVersitResourceHandler();

    mImporter->setResourceHandler(mResourceHandler);

    mPropertyHandler = new MyQVersitContactImporterPropertyHandler();

    mImporter->setPropertyHandler(mPropertyHandler);

}

void tst_QVersitContactImporter::cleanup()

{

    QVERIFY(mImporter->propertyHandler() == mPropertyHandler);

    mImporter->setPropertyHandler(0);

    delete mPropertyHandler;

    QVERIFY(mImporter->resourceHandler() == mResourceHandler);

    mImporter->setResourceHandler(0);

    delete mResourceHandler;

    delete mImporter;

}

void tst_QVersitContactImporter::testName()

{

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty nameProperty;

    QStringList value;

    value.append(QString::fromAscii("John"));//FirstName

    value.append(QString::fromAscii("Citizen"));//LastName

    value.append(QString::fromAscii("Anonymous"));//GivenName

    value.append(QString::fromAscii("Dr"));//PreFix

    value.append(QString::fromAscii("MSc"));//Suffix

    nameProperty.setName(QString::fromAscii("N"));

    nameProperty.setValue(value);

    nameProperty.setValueType(QVersitProperty::CompoundType);

    document.addProperty(nameProperty);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    QContact contact = mImporter->contacts().first();

    QContactName name = (QContactName)contact.detail(QContactName::DefinitionName);

    QCOMPARE(name.lastName(),value[0]);

    QCOMPARE(name.firstName(),value[1]);

    QCOMPARE(name.middleName(),value[2]);

    QCOMPARE(name.prefix(),value[3]);

    QCOMPARE(name.suffix(),value[4]);

    // Multiple names, first one will be picked and rest will be discarded

    nameProperty = QVersitProperty();

    QStringList anotherValue;

    anotherValue.append(QString::fromAscii("FakeJohn"));//FirstName

    anotherValue.append(QString::fromAscii("FakeCitizen"));//LastName

    anotherValue.append(QString::fromAscii("FakeAnonymous"));//GivenName

    anotherValue.append(QString::fromAscii("FakeDr"));//PreFix

    anotherValue.append(QString::fromAscii("FakeMSc"));//Suffix

    nameProperty.setName(QString::fromAscii("N"));

    nameProperty.setValue(anotherValue);

    nameProperty.setValueType(QVersitProperty::CompoundType);

    document.addProperty(nameProperty);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    QList<QContactDetail> names = contact.details(QContactName::DefinitionName);

    QCOMPARE(names.count(),1);

    // anotherValue should be discarded, so check for value

    name = (QContactName)names[0];

    QCOMPARE(name.lastName(),value[0]);

    QCOMPARE(name.firstName(),value[1]);

    QCOMPARE(name.middleName(),value[2]);

    QCOMPARE(name.prefix(),value[3]);

    QCOMPARE(name.suffix(),value[4]);

}

// check that it doesn't crash if the FN property comes before the N property.

void tst_QVersitContactImporter::testNameWithFormatted()

{

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty fnProperty;

    fnProperty.setName(QString::fromAscii("FN"));

    fnProperty.setValue(QString::fromAscii("First Last"));

    document.addProperty(fnProperty);

    QVersitProperty nProperty;

    nProperty.setName(QString::fromAscii("N"));

    nProperty.setValue(QStringList() << QLatin1String("Last") << QLatin1String("First") << QLatin1String("Middle") << QLatin1String("Prefix") << QLatin1String("Suffix"));

    nProperty.setValueType(QVersitProperty::CompoundType);

    document.addProperty(nProperty);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    QContact contact = mImporter->contacts().first();

    QContactName name = contact.detail<QContactName>();

    QCOMPARE(name.firstName(), QString::fromAscii("First"));

    QCOMPARE(name.lastName(), QString::fromAscii("Last"));

    QCOMPARE(name.middleName(), QString::fromAscii("Middle"));

    QCOMPARE(name.prefix(), QString::fromAscii("Prefix"));

    QCOMPARE(name.suffix(), QString::fromAscii("Suffix"));

    QCOMPARE(name.customLabel(), QString::fromAscii("First Last"));

}

void tst_QVersitContactImporter::testAddress()

{

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    property.setName(QString::fromAscii("ADR"));

    property.setValue(QStringList(QString()));

    property.setValueType(QVersitProperty::CompoundType);

    // Empty value for the address

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    QContact contact = mImporter->contacts().first();

    QContactAddress address = contact.detail<QContactAddress>();

    QCOMPARE(address.postOfficeBox(),QString());

    QCOMPARE(address.street(),QString());

    QCOMPARE(address.locality(),QString());

    QCOMPARE(address.region(),QString());

    QCOMPARE(address.postcode(),QString());

    QCOMPARE(address.country(),QString());

    // Address with all the fields filled

    property.setValue(QStringList()

                      << QLatin1String("PO Box")

                      << QLatin1String("E")

                      << QLatin1String("My Street")

                      << QLatin1String("My Town")

                      << QLatin1String("My State")

                      << QLatin1String("12345")

                      << QLatin1String("My Country")

                      );

    property.setValueType(QVersitProperty::CompoundType);

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    address = contact.detail<QContactAddress>();

    QCOMPARE(address.postOfficeBox(),QString::fromAscii("PO Box"));

    QCOMPARE(address.street(),QString::fromAscii("My Street"));

    QCOMPARE(address.locality(),QString::fromAscii("My Town"));

    QCOMPARE(address.region(),QString::fromAscii("My State"));

    QCOMPARE(address.postcode(),QString::fromAscii("12345"));

    QCOMPARE(address.country(),QString::fromAscii("My Country"));

    // Address with TYPE parameters converted to contexts and subtypes

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("HOME"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("WORK"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("DOM"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("INTL"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("POSTAL"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("PARCEL"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("X-EXTENSION"));

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    address = contact.detail<QContactAddress>();

    QStringList contexts = address.contexts();

    QVERIFY(contexts.contains(QContactDetail::ContextHome));

    QVERIFY(contexts.contains(QContactDetail::ContextWork));

    QStringList subTypes = address.subTypes();

    QVERIFY(subTypes.contains(QContactAddress::SubTypeDomestic));

    QVERIFY(subTypes.contains(QContactAddress::SubTypeInternational));

    QVERIFY(subTypes.contains(QContactAddress::SubTypePostal));

    QVERIFY(subTypes.contains(QContactAddress::SubTypeParcel));

}

void tst_QVersitContactImporter::testOrganizationName()

{

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    // Empty value for the organization

    property.setName(QString::fromAscii("ORG"));

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    QContact contact = mImporter->contacts().first();

    QContactOrganization organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.name(),QString());

    QCOMPARE(organization.department().count(),0);

    // Organization with single value

    property.setValueType(QVersitProperty::CompoundType);

    property.setValue(QStringList(QLatin1String("Nokia")));

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.name(),QString::fromAscii("Nokia"));

    QCOMPARE(organization.department().count(),0);

    // Organization with one Organizational Unit

    property.setValue(QStringList() << QLatin1String("Nokia") << QLatin1String("R&D"));

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.name(),QString::fromAscii("Nokia"));

    QCOMPARE(organization.department().count(),1);

    QCOMPARE(organization.department().at(0),QString::fromAscii("R&D"));

    // Organization with more Organizational Units

    property.setValue(QStringList()

                      << QLatin1String("Nokia")

                      << QLatin1String("R&D")

                      << QLatin1String("Devices")

                      << QLatin1String("Qt"));

    property.setValueType(QVersitProperty::CompoundType);

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.name(),QString::fromAscii("Nokia"));

    QCOMPARE(organization.department().count(),3);

    QCOMPARE(organization.department().at(0),QString::fromAscii("R&D"));

    QCOMPARE(organization.department().at(1),QString::fromAscii("Devices"));

    QCOMPARE(organization.department().at(2),QString::fromAscii("Qt"));

}

void tst_QVersitContactImporter::testOrganizationTitle()

{

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    // One title

    property.setName(QString::fromAscii("TITLE"));

    QString titleValue(QString::fromAscii("Developer"));

    property.setValue(titleValue);

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    QContact contact = mImporter->contacts().first();

    QList<QContactDetail> organizationDetails =

        contact.details(QContactOrganization::DefinitionName);

    QCOMPARE(organizationDetails.count(), 1);

    QContactOrganization organization = static_cast<QContactOrganization>(organizationDetails[0]);

    QCOMPARE(organization.title(),titleValue);

    // Two titles -> two QContactOrganizations created

    property.setName(QString::fromAscii("TITLE"));

    QString secondTitleValue(QString::fromAscii("Hacker"));

    property.setValue(secondTitleValue);

    document.addProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    organizationDetails = contact.details(QContactOrganization::DefinitionName);

    QCOMPARE(organizationDetails.count(), 2);

    QContactOrganization firstOrganization =

        static_cast<QContactOrganization>(organizationDetails[0]);

    QCOMPARE(firstOrganization.title(),titleValue);

    QContactOrganization secondOrganization =

        static_cast<QContactOrganization>(organizationDetails[1]);

    QCOMPARE(secondOrganization.title(),secondTitleValue);

    // Two titles and one organization name -> two QContactOrganizations created

    property.setName(QString::fromAscii("ORG"));

    property.setValueType(QVersitProperty::CompoundType);

    property.setValue(QStringList(QLatin1String("Nokia")));

    document.addProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    organizationDetails = contact.details(QContactOrganization::DefinitionName);

    QCOMPARE(organizationDetails.count(), 2);

    firstOrganization = static_cast<QContactOrganization>(organizationDetails[0]);

    QCOMPARE(firstOrganization.title(),titleValue);

    QCOMPARE(firstOrganization.name(),QLatin1String("Nokia"));

    secondOrganization = static_cast<QContactOrganization>(organizationDetails[1]);

    QCOMPARE(secondOrganization.title(),secondTitleValue);

    QCOMPARE(secondOrganization.name(),QString());

}

void tst_QVersitContactImporter::testOrganizationAssistant()

{

    QContact contact;

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    property.setName(QString::fromAscii("X-ASSISTANT"));

    QString assistantValue(QString::fromAscii("Jenny"));

    property.setValue(assistantValue);

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    QContactOrganization organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.assistantName(), assistantValue);

}

void tst_QVersitContactImporter::testOrganizationLogo()

{

    QContact contact;

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    // Embedded LOGO

    property.setName(QString::fromAscii("LOGO"));

    QByteArray logo(QByteArray::fromBase64(

            "R0lGODlhEgASAIAAAAAAAP///yH5BAEAAAEALAAAAAASABIAAAIdjI+py+0G"));

    property.setValue(logo);

    property.insertParameter(QString::fromAscii("TYPE"),

                          QString::fromAscii("GIF"));

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    QContactOrganization organization = contact.detail<QContactOrganization>();

    QByteArray content = mResourceHandler->mObjects.value(organization.logoUrl().toString());

    QCOMPARE(content, logo);

    // LOGO as a URL

    property.setName(QString::fromAscii("LOGO"));

    QString logoUrl(QString::fromAscii("http://www.organization.org/logo.gif"));

    property.setValue(logoUrl);

    property.insertParameter(QString::fromAscii("VALUE"),QString::fromAscii("URL"));

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.logoUrl().toString(),logoUrl);

}

void tst_QVersitContactImporter::testOrganizationRole()

{

    QContact contact;

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    // Setting the role is not yet supported by QContactOrganization

    property.setName(QString::fromAscii("ROLE"));

    QString roleValue(QString::fromAscii("Very important manager and proud of it"));

    property.setValue(roleValue);

    document = createDocumentWithProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    contact = mImporter->contacts().first();

    QContactOrganization organization = contact.detail<QContactOrganization>();

    QCOMPARE(organization.role(), roleValue);

}

void tst_QVersitContactImporter::testTel()

{

    QVersitDocument document(QVersitDocument::VCard30Type);

    QVersitProperty property;

    property.setName(QString::fromAscii("TEL"));

    QString value(QString::fromAscii("+35850987654321"));

    property.setValue(value);

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("VOICE"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("CELL"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("MODEM"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("CAR"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("VIDEO"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("FAX"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("BBS"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("PAGER"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("HOME"));

    property.insertParameter(QString::fromAscii("TYPE"),QString::fromAscii("WORK"));

    document.addProperty(property);

    QVERIFY(mImporter->importDocuments(QList<QVersitDocument>() << document));

    QContact contact = mImporter->contacts().first();

    const QContactPhoneNumber& phone = contact.detail<QContactPhoneNumber>();

    QCOMPARE(phone.number(),QString(value));

    const QStringList subTypes = phone.subTypes();

    QCOMPARE(subTypes.count(),8);

    QVERIFY(subTypes.contains(QContactPhoneNumber::SubTypeVoice));

    QVERIFY(subTypes.contains(QContactPhoneNumber::SubTypeMobile));

    QVERIFY(subTypes.contains(QContactPhoneNumber::SubTypeModem));

    QVERIFY(subTypes.contains(QContactPhoneNumber::SubTypeCar));

    QVERIFY(subTypes.contains(QContactPhoneNumber::SubTypeVideo));