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

**

** 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 "tst_qversitcontactexporter.h"

#include "qversitcontactexporter.h"

#include "qversitcontactexporter_p.h"

#include "qversitdocument.h"

#include "qversitproperty.h"

#include "qversitdefs_p.h"

#include <QString>

#include <QStringList>

#include <QList>

#include <QPixmap>

#include <QImageWriter>

#include <QtTest/QtTest>

#include <qcontact.h>

#include <qcontactaddress.h>

#include <qcontactemailaddress.h>

#include <qcontactname.h>

#include <qcontactphonenumber.h>

#include <qcontacturl.h>

#include <qcontactguid.h>

#include <qcontacttimestamp.h>

#include <qcontactbirthday.h>

#include <qcontactnote.h>

#include <qcontactgeolocation.h>

#include <qcontactorganization.h>

#include <qcontactavatar.h>

#include <qcontactgender.h>

#include <qcontactnickname.h>

#include <qcontactanniversary.h>

#include <qcontactonlineaccount.h>

#include <qcontactfamily.h>

#include <qcontactdisplaylabel.h>

QTM_BEGIN_NAMESPACE

class MyQVersitContactExporterDetailHandler : public QVersitContactExporterDetailHandler

{

public:

    MyQVersitContactExporterDetailHandler() : mPreProcess(false)

    {

    }

    bool preProcessDetail(const QContact& contact,

                          const QContactDetail& detail,

                          QVersitDocument* document)

    {

        Q_UNUSED(contact)

        Q_UNUSED(document)

        mPreProcessedDetails.append(detail);

        return mPreProcess;

    }

    bool postProcessDetail(const QContact& contact,

                           const QContactDetail& detail,

                           bool alreadyProcessed,

                           QVersitDocument* document)

    {

        Q_UNUSED(contact)

        Q_UNUSED(document)

        if (!alreadyProcessed)

            mUnknownDetails.append(detail);

        else

            mPostProcessedDetails.append(detail);

        return false;

    }

    void clear()

    {

        mPreProcess = false;

        mDefinitionNamesToProcess.clear();

        mUnknownDetails.clear();

        mPreProcessedDetails.clear();

        mPostProcessedDetails.clear();

    }

    // a hook to control what preProcess returns:

    bool mPreProcess;

    QStringList mDefinitionNamesToProcess;

    QList<QContactDetail> mUnknownDetails;

    QList<QContactDetail> mPreProcessedDetails;

    QList<QContactDetail> mPostProcessedDetails;

};

class MyQVersitResourceHandler : public QVersitResourceHandler

{

public:

    MyQVersitResourceHandler()

        : mLoadResourceCalled(false),

        mLoadSuccess(true)

    {

    }

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

    {

        mLocation = location;

        *contents = mSimulatedData;

        *mimeType = mSimulatedMimeType;

        mLoadResourceCalled = true;

        return mLoadSuccess;

    }

    bool saveResource(const QByteArray &contents, const QVersitProperty &property, QString *location)

    {

        Q_UNUSED(contents)

        Q_UNUSED(property)

        Q_UNUSED(location)

        return false;

    }

    void clear()

    {

        mSimulatedData.clear();

        mSimulatedMimeType.clear();

        mLocation.clear();

        mLoadResourceCalled = false;

        mLoadSuccess = true;

    }

    QByteArray mSimulatedData;

    QString mSimulatedMimeType;

    QString mLocation;

    bool mLoadResourceCalled;

    bool mLoadSuccess; // A hook to control what loadResource returns.

};

const static QByteArray SAMPLE_GIF(QByteArray::fromBase64(

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

        "wEtxUmlPzRDnzYGfN3KBaKGT6rDmGxQAOw=="));

// The number of vCard properties generated by a contact made with createContactWithName()

const static int BASE_PROPERTY_COUNT = 2;

QTM_END_NAMESPACE

QTM_USE_NAMESPACE

const QString TEST_PHOTO_FILE(QLatin1String("versitTest001.jpg"));

const QString TEST_AUDIO_FILE(QLatin1String("versitTest001.wav"));

// Checks that the property has a value of the given expectedType and the given expectedValue.

#define CHECK_VALUE(property,expectedValueType,expectedValue) {\

    QCOMPARE(property.valueType(), expectedValueType); \

    QVariant value = property.variantValue(); \

    QCOMPARE(value.type(), QVariant::StringList); \

    QCOMPARE(value.toStringList(), expectedValue); \

}

void tst_QVersitContactExporter::init()

{

    mExporter = new QVersitContactExporter();

    mDetailHandler = new MyQVersitContactExporterDetailHandler;

    mExporter->setDetailHandler(mDetailHandler);

    mResourceHandler = new MyQVersitResourceHandler;

    mExporter->setResourceHandler(mResourceHandler);

}

void tst_QVersitContactExporter::cleanup()

{

    QVERIFY(mExporter->detailHandler() == mDetailHandler);

    mExporter->setDetailHandler(0);

    delete mDetailHandler;

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

    mExporter->setResourceHandler(0);

    delete mResourceHandler;

    delete mExporter;

}

void tst_QVersitContactExporter::testConvertContact()

{

    QContact contact;

    // Adding name to the contact

    QContactName name;

    name.setFirstName(QString::fromAscii("Moido"));

    contact.saveDetail(&name);

    // Adding phone number to the Contact.

    QContactPhoneNumber phoneNumber;

    phoneNumber.setNumber(QString::fromAscii("12345678"));

    contact.saveDetail(&phoneNumber);

    // Convert contact into versit properties

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    QList<QVersitDocument> documents = mExporter->documents();

    // Each Contact has display label detail by default. Display label is enocded

    // if some value exist for the Label or if value for Name exist.

    QCOMPARE(documents.size(), 1);

    QCOMPARE(documents.first().properties().count(), 3);

}

void tst_QVersitContactExporter::testContactDetailHandler()

{

    // Test1: Un-supported Avatar Test

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QVersitDocument document;

    QContactDetail unknownDetail;

    unknownDetail.setValue(QLatin1String("Unknown"), QLatin1String("Detail"));

    contact.saveDetail(&unknownDetail);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT);

    QList<QContactDetail> unknownDetails = mDetailHandler->mUnknownDetails;

    QVERIFY(unknownDetails.size() > 0);

    QString definitionName = unknownDetail.definitionName();

    QContactDetail detail = searchDetail(unknownDetails,definitionName);

    QCOMPARE(definitionName, detail.definitionName());

    // Test2: Un-supported Online Account

    QContactOnlineAccount onlineAccount;

    QString testUri = QString::fromAscii("sip:abc@temp.com");

    onlineAccount.setAccountUri(testUri);

    onlineAccount.setSubTypes(QString::fromAscii("unsupported"));

    contact.saveDetail(&onlineAccount);

    mDetailHandler->clear();

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT);

    unknownDetails = mDetailHandler->mUnknownDetails;

    QVERIFY(unknownDetails.size() > 0);

    definitionName = onlineAccount.definitionName();

    detail = searchDetail(unknownDetails, definitionName);

    QCOMPARE(definitionName, detail.definitionName());

    // Test that preProcessDetail returns true stops the exporter from doing anything.

    contact.clearDetails();

    QContactName contactName;

    contactName.setFirstName(QLatin1String("John"));

    contact.saveDetail(&contactName);

    mDetailHandler->clear();

    mDetailHandler->mPreProcess = true;

    // Fails, with NoNameError

    QVERIFY(!mExporter->exportContacts(QList<QContact>() << contact,

            QVersitDocument::VCard30Type));

    QList<QVersitDocument> documents = mExporter->documents();

    QCOMPARE(documents.size(), 0);

    QVERIFY(mDetailHandler->mPreProcessedDetails.count() > BASE_PROPERTY_COUNT);

    QCOMPARE(mDetailHandler->mPostProcessedDetails.count(), 0);

    QCOMPARE(mDetailHandler->mUnknownDetails.count(), 0);

    QVERIFY(mExporter->detailHandler() == mDetailHandler);

}

void tst_QVersitContactExporter::testEncodeName()

{

    QContact contact;

    QContactName name;

    // Special characters are NOT backslash escaped by the exporter, only by the writer.

    name.setFirstName(QString::fromAscii("He;ido"));

    name.setLastName(QString::fromAscii("HH"));

    name.setMiddleName(QString::fromAscii("A"));

    name.setPrefix(QString::fromAscii("Mr."));

    name.setContexts(QContactDetail::ContextHome);

    contact.saveDetail(&name);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard21Type));

    QVersitDocument document = mExporter->documents().first();

    // Each Contact has display label detail by default. Display label is enocded

    // if some value exists for the Label or if value for Name exists.

    QCOMPARE(document.properties().count(), 2);

    QVersitProperty displayProperty = document.properties().at(0);

    // Check name

    QCOMPARE(displayProperty.name(), QString::fromAscii("FN"));

    // Check value

    QCOMPARE(displayProperty.value(), QString::fromAscii("He;ido HH"));

    QVersitProperty nameProperty = document.properties().at(1);

    // Check parameters, contexts not allowed for N property

    QCOMPARE(nameProperty.parameters().count(), 0);

    // Check name

    QCOMPARE(nameProperty.name(), QString::fromAscii("N"));

    CHECK_VALUE(nameProperty, QVersitProperty::CompoundType,

                QStringList() << QLatin1String("HH") << QLatin1String("He;ido")

                << QLatin1String("A") << QLatin1String("Mr.") << QString());

}

void tst_QVersitContactExporter::testEncodePhoneNumber()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QContactPhoneNumber phoneNumber;

    phoneNumber.setNumber(QString::fromAscii("12345678"));

    phoneNumber.setContexts(QContactDetail::ContextHome);

    phoneNumber.setSubTypes(QContactPhoneNumber::SubTypeMobile);

    contact.saveDetail(&phoneNumber);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("TEL"));

    QVERIFY(!property.isEmpty());

    // Check parameters

    QCOMPARE(property.parameters().count(), 2);

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("HOME")));

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("CELL")));

    // Check value

    QCOMPARE(property.value(), phoneNumber.number());

    QContactPhoneNumber assistantNumber;

    assistantNumber.setNumber(QLatin1String("4321"));

    assistantNumber.setContexts(QContactDetail::ContextWork);

    assistantNumber.setSubTypes(QContactPhoneNumber::SubTypeAssistant);

    contact.saveDetail(&assistantNumber);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+2);

    property = findPropertyByName(document, QLatin1String("X-ASSISTANT-TEL"));

    QVERIFY(!property.isEmpty());

    QCOMPARE(property.parameters().count(), 1);

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("WORK")));

    QCOMPARE(property.value(), assistantNumber.number());

}

void tst_QVersitContactExporter::testEncodeEmailAddress()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QContactEmailAddress email;

    email.setEmailAddress(QString::fromAscii("test@test"));

    email.setContexts(QContactDetail::ContextHome);

    contact.saveDetail(&email);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("EMAIL"));

    QVERIFY(!property.isEmpty());

    // Check parameters

    QCOMPARE(property.parameters().count(), 1);

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("HOME")));

    // Check value

    QCOMPARE(property.value(), email.emailAddress());

}

void tst_QVersitContactExporter::testEncodeStreetAddress()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QContactAddress address;

    address.setPostOfficeBox(QLatin1String("1234"));

    address.setCountry(QLatin1String("Finland"));

    address.setPostcode(QLatin1String("00440"));

    // Special characters are not escaped by the exporter, but by the writer

    address.setStreet(QLatin1String("HKKI; 1X 90"));

    address.setLocality(QLatin1String("Helsinki"));

    address.setContexts(QContactDetail::ContextHome);

    address.setSubTypes(QContactAddress::SubTypePostal);

    contact.saveDetail(&address);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard21Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("ADR"));

    QVERIFY(!property.isEmpty());

    // Check parameters

    QCOMPARE(property.parameters().count(), 2);

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("HOME")));

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("POSTAL")));

    // Check name

    QCOMPARE(property.name(), QString::fromAscii("ADR"));

    CHECK_VALUE(property, QVersitProperty::CompoundType,

                QStringList() << QLatin1String("1234") << QString() << QLatin1String("HKKI; 1X 90")

                << QLatin1String("Helsinki") << QString() << QLatin1String("00440")

                << QLatin1String("Finland"));

}

void tst_QVersitContactExporter::testEncodeUrl()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QContactUrl url;

    url.setUrl(QString::fromAscii("http://www.myhome.com"));

    url.setContexts(QContactDetail::ContextHome);

    url.setSubType(QContactUrl::SubTypeHomePage);

    contact.saveDetail(&url);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("URL"));

    QVERIFY(!property.isEmpty());

    // Check parameters

    QCOMPARE(property.parameters().count(), 1);

    QVERIFY(property.parameters().contains(

        QString::fromAscii("TYPE"),QString::fromAscii("HOME")));

    // Check value

    QCOMPARE(property.value(), url.url());

}

void tst_QVersitContactExporter::testEncodeUid()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QContactGuid guid;

    guid.setContexts(QContactDetail::ContextHome);

    guid.setGuid(QString::fromAscii("0101222"));

    contact.saveDetail(&guid);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard21Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("UID"));

    QVERIFY(!property.isEmpty());

    // Check parameters

    // Contexts are not allowed for UID

    QCOMPARE(property.parameters().count(), 0);

    // Check value

    QCOMPARE(property.value(), guid.guid());

}

void tst_QVersitContactExporter::testEncodeRev()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QContactTimestamp timeStamp;

    // Last modified time found

    QDateTime revisionTime =

        QDateTime::fromString(

            QString::fromAscii("M1d1y200906:01:02"),

            QString::fromAscii("'M'M'd'd'y'yyyyhh:mm:ss"));

    revisionTime.setTimeSpec(Qt::UTC);

    timeStamp.setLastModified(revisionTime);

    // Contexts not allowed in REV property, check that they are not added

    timeStamp.setContexts(QContactDetail::ContextHome);

    contact.saveDetail(&timeStamp);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("REV"));

    QVERIFY(!property.isEmpty());

    QCOMPARE(property.parameters().count(), 0);

    QString expectedValueUTCEncoded = QString::fromAscii("2009-01-01T06:01:02Z");

    QCOMPARE(property.value(), expectedValueUTCEncoded);

    // Last modified time not found, use the creation time

    QDateTime emptyTime;

    timeStamp.setLastModified(emptyTime);

    timeStamp.setCreated(revisionTime);

    contact.saveDetail(&timeStamp);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    property = findPropertyByName(document, QLatin1String("REV"));

    QVERIFY(!property.isEmpty());

    QCOMPARE(property.value(), expectedValueUTCEncoded);

    // Last modified time found, Local Time spec not UTC

    QDateTime localTime;

    revisionTime.setTimeSpec(Qt::LocalTime);

    timeStamp.setLastModified(revisionTime);

    localTime.setTimeSpec(Qt::LocalTime);

    timeStamp.setCreated(localTime);

    contact.saveDetail(&timeStamp);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    property = findPropertyByName(document, QLatin1String("REV"));

    QVERIFY(!property.isEmpty());

    QString expectedValueEncoded = QString::fromAscii("2009-01-01T06:01:02");

    QCOMPARE(property.value(), expectedValueEncoded);

    // Last modified time not found, creation time not found

    timeStamp.setLastModified(emptyTime);

    timeStamp.setCreated(emptyTime);

    contact.saveDetail(&timeStamp);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT);

}

void tst_QVersitContactExporter::testEncodeBirthDay()

{

    QContact contact(createContactWithName(QLatin1String("asdf")));

    QDate date(2009,1,1);

    QContactBirthday birthDay;

    birthDay.setDate(date);

    // Contexts not allowed in BDAY property, check that they are not added

    birthDay.setContexts(QContactDetail::ContextHome);

    contact.saveDetail(&birthDay);

    QVERIFY(mExporter->exportContacts(QList<QContact>() << contact, QVersitDocument::VCard30Type));

    QVersitDocument document = mExporter->documents().first();

    QCOMPARE(document.properties().count(), BASE_PROPERTY_COUNT+1);

    QVersitProperty property = findPropertyByName(document, QLatin1String("BDAY"));

    QVERIFY(!property.isEmpty());

    QCOMPARE(property.parameters().count(), 0);

    QCOMPARE(property.value(), QString::fromAscii("2009-01-01"));

}