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

**

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

#include "qversitdocument.h"

#include "qversitproperty.h"

#include "qmobilityglobal.h"

#include <qcontactmanagerengine.h>

#include <qcontact.h>

#include <qcontactdetail.h>

#include <qcontactname.h>

#include <qcontactphonenumber.h>

#include <qcontactaddress.h>

#include <qcontactemailaddress.h>

#include <qcontactorganization.h>

#include <qcontacturl.h>

#include <qcontactguid.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 <qcontactdisplaylabel.h>

#include <qcontactthumbnail.h>

#include <qcontactringtone.h>

#include <QHash>

#include <QFile>

QTM_USE_NAMESPACE

/*!

 * Constructor.

 */

QVersitContactImporterPrivate::QVersitContactImporterPrivate() :

    mPropertyHandler(NULL),

    mPropertyHandler2(NULL),

    mPropertyHandlerVersion(0),

    mDefaultResourceHandler(new QVersitDefaultResourceHandler),

    mResourceHandler(mDefaultResourceHandler)

{

    // Contact detail mappings

    int versitPropertyCount =

        sizeof(versitContactDetailMappings)/sizeof(VersitContactDetailMapping);

    for (int i=0; i < versitPropertyCount; i++) {

        QString versitPropertyName =

            QLatin1String(versitContactDetailMappings[i].versitPropertyName);

        QPair<QString,QString> contactDetail;

        contactDetail.first =

            QLatin1String(versitContactDetailMappings[i].contactDetailDefinitionName);

        contactDetail.second =

            QLatin1String(versitContactDetailMappings[i].contactDetailValueKey);

        mDetailMappings.insert(versitPropertyName,contactDetail);

    }

    // Context mappings

    int contextCount = sizeof(versitContextMappings)/sizeof(VersitMapping);

    for (int i=0; i < contextCount; i++) {

        mContextMappings.insert(

            QLatin1String(versitContextMappings[i].versitString),

            QLatin1String(versitContextMappings[i].contactString));

    }

    // Subtype mappings

    int subTypeCount = sizeof(versitSubTypeMappings)/sizeof(VersitMapping);

    for (int i=0; i < subTypeCount; i++) {

        mSubTypeMappings.insert(

            QLatin1String(versitSubTypeMappings[i].versitString),

            QLatin1String(versitSubTypeMappings[i].contactString));

    }

}

/*!

 * Destructor.

 */

QVersitContactImporterPrivate::~QVersitContactImporterPrivate()

{

    delete mDefaultResourceHandler;

}

/*!

 * Generates a QContact from \a versitDocument.

 */

bool QVersitContactImporterPrivate::importContact(

        const QVersitDocument& document, int contactIndex, QContact* contact,

        QVersitContactImporter::Error* error)

{

    if (document.type() != QVersitDocument::VCard21Type

        && document.type() != QVersitDocument::VCard30Type) {

        *error = QVersitContactImporter::InvalidDocumentError;

        return false;

    }

    const QList<QVersitProperty> properties = document.properties();

    if (properties.size() == 0) {

        *error = QVersitContactImporter::EmptyDocumentError;

        return false;

    }

    // First, do the properties with PREF set so they appear first in the contact details

    foreach (const QVersitProperty& property, properties) {

        QStringList typeParameters = property.parameters().values(QLatin1String("TYPE"));

        if (typeParameters.contains(QLatin1String("PREF"), Qt::CaseInsensitive))

            importProperty(document, property, contactIndex, contact);

    }

    // ... then, do the rest of the properties.

    foreach (const QVersitProperty& property, properties) {

        QStringList typeParameters = property.parameters().values(QLatin1String("TYPE"));

        if (!typeParameters.contains(QLatin1String("PREF"), Qt::CaseInsensitive))

            importProperty(document, property, contactIndex, contact);

    }

    contact->setType(QContactType::TypeContact);

    QContactManagerEngine::setContactDisplayLabel(contact, QVersitContactImporterPrivate::synthesizedDisplayLabel(*contact));

    if (mPropertyHandler2 && mPropertyHandlerVersion > 1) {

        mPropertyHandler2->documentProcessed(document, contact);

    }

    return true;

}

void QVersitContactImporterPrivate::importProperty(

        const QVersitDocument& document, const QVersitProperty& property, int contactIndex,

        QContact* contact)

{

    if (mPropertyHandler

        && mPropertyHandlerVersion == 1

        && mPropertyHandler->preProcessProperty(document, property, contactIndex, contact))

        return;

    QPair<QString,QString> detailDefinition =

        mDetailMappings.value(property.name());

    QString detailDefinitionName = detailDefinition.first;

    QList<QContactDetail> updatedDetails;

    bool success = false;

    // The following functions create and save the details to the contact

    if (detailDefinitionName == QContactAddress::DefinitionName) {

        success = createAddress(property, contact, &updatedDetails); // pass in group

    } else if (detailDefinitionName == QContactName::DefinitionName) {

        success = createName(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactBirthday::DefinitionName) {

        success = createBirthday(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactGeoLocation::DefinitionName){

        success = createGeoLocation(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactOrganization::DefinitionName) {

        success = createOrganization(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactNickname::DefinitionName) {

        success = createNicknames(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactRingtone::DefinitionName) {

        success = createRingtone(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactThumbnail::DefinitionName) {

        success = createThumbnail(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactTimestamp::DefinitionName) {

        success = createTimeStamp(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactPhoneNumber::DefinitionName) {

        success = createPhone(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactAnniversary::DefinitionName) {

        success = createAnniversary(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactFamily::DefinitionName) {

        success = createFamily(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactOnlineAccount::DefinitionName) {

        success = createOnlineAccount(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactTag::DefinitionName) {

        success = createTags(property, contact, &updatedDetails);

    } else if (detailDefinitionName == QContactDisplayLabel::DefinitionName) {

        success = createCustomLabel(property, contact, &updatedDetails);

    } else {

        // Look up mDetailMappings for a simple mapping from property to detail.

        success = createNameValueDetail(property, contact, &updatedDetails);

    }

    if (mPropertyHandler2 && mPropertyHandlerVersion > 1) {

        mPropertyHandler2->propertyProcessed(document, property, success, *contact, &updatedDetails);

    }

    foreach (QContactDetail detail, updatedDetails) {

        contact->saveDetail(&detail);

    }

    if (mPropertyHandler && mPropertyHandlerVersion == 1)

        mPropertyHandler->postProcessProperty(document, property, success, contactIndex, contact);

}

/*!

 * Creates a QContactName from \a property

 */

bool QVersitContactImporterPrivate::createName(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    QContactName name;

    QContactDetail detail = contact->detail(QContactName::DefinitionName);

    if (!detail.isEmpty()) {

        // If multiple name properties exist,

        // discard all except the first occurrence

        if (!detail.value(QContactName::FieldFirstName).isEmpty())

            return false;

        else

            name = QContactName(static_cast<QContactName>(detail));

    }

    QVariant variant = property.variantValue();

    if (property.valueType() != QVersitProperty::CompoundType

            || variant.type() != QVariant::StringList)

        return false;

    QStringList values = variant.toStringList();

    QString value(takeFirst(values));

    if (!value.isEmpty())

        name.setLastName(value);

    value = takeFirst(values);

    if (!value.isEmpty())

        name.setFirstName(value);

    value = takeFirst(values);

    if (!value.isEmpty())

        name.setMiddleName(value);

    value = takeFirst(values);

    if (!value.isEmpty())

        name.setPrefix(value);

    value = takeFirst(values);

    if (!value.isEmpty())

        name.setSuffix(value);

    saveDetailWithContext(updatedDetails, name, extractContexts(property));

    return true;

}

/*!

 * Creates a QContactPhoneNumber from \a property

 */

bool QVersitContactImporterPrivate::createPhone(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QContactPhoneNumber phone;

    QString value(property.value());

    if (value.isEmpty())

        return false;

    phone.setNumber(property.value());

    QStringList subTypes(extractSubTypes(property));

    if (property.name() == QLatin1String("X-ASSISTANT-TEL"))

        subTypes << QContactPhoneNumber::SubTypeAssistant;

    if (!subTypes.isEmpty())

        phone.setSubTypes(subTypes);

    saveDetailWithContext(updatedDetails, phone, extractContexts(property));

    return true;

}

/*!

 * Creates a QContactAddress from \a property

 */

bool QVersitContactImporterPrivate::createAddress(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QContactAddress address;

    QVariant variant = property.variantValue();

    if (property.valueType() != QVersitProperty::CompoundType

            || variant.type() != QVariant::StringList)

        return false;

    QStringList addressParts = variant.toStringList();

    QString value(takeFirst(addressParts));

    if (!value.isEmpty())

        address.setPostOfficeBox(value);

    // There is no setter for the Extended Address in QContactAddress:

    if (!addressParts.isEmpty())

        addressParts.removeFirst();

    value = takeFirst(addressParts);

    if (!value.isEmpty())

        address.setStreet(value);

    value = takeFirst(addressParts);

    if (!value.isEmpty())

        address.setLocality(value);

    value = takeFirst(addressParts);

    if (!value.isEmpty())

        address.setRegion(value);

    value = takeFirst(addressParts);

    if (!value.isEmpty())

        address.setPostcode(value);

    value = takeFirst(addressParts);

    if (!value.isEmpty())

        address.setCountry(value);

    QStringList subTypes(extractSubTypes(property));

    if (!subTypes.isEmpty())

        address.setSubTypes(subTypes);

    saveDetailWithContext(updatedDetails, address, extractContexts(property));

    return true;

}

/*!

 * Creates a QContactOrganization from \a property

 */

bool QVersitContactImporterPrivate::createOrganization(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    QContactOrganization organization;

    QPair<QString,QString> detailNameAndFieldName =

        mDetailMappings.value(property.name());

    QString fieldName = detailNameAndFieldName.second;

    QList<QContactOrganization> organizations = contact->details<QContactOrganization>();

    foreach(const QContactOrganization& current, organizations) {

        if (current.value(fieldName).length() == 0) {

            organization = current;

            break;

        }

    }

    if (fieldName == QContactOrganization::FieldName) {

        setOrganizationNames(organization, property);

    } else if (fieldName == QContactOrganization::FieldTitle) {

        organization.setTitle(property.value());

    } else if (fieldName == QContactOrganization::FieldRole) {

        organization.setRole(property.value());

    } else if (fieldName == QContactOrganization::FieldLogoUrl) {

        setOrganizationLogo(organization, property);

    } else if (fieldName == QContactOrganization::FieldAssistantName) {

        organization.setAssistantName(property.value());

    } else {

        return false;

    }

    saveDetailWithContext(updatedDetails, organization, extractContexts(property));

    return true;

}

/*!

 * Set the organization name and department(s) from \a property.

 */

void QVersitContactImporterPrivate::setOrganizationNames(

    QContactOrganization& organization, const QVersitProperty& property) const

{

    QVariant variant = property.variantValue();

    if (property.valueType() == QVersitProperty::CompoundType

        && variant.type() == QVariant::StringList) {

        QStringList values = variant.toStringList();

        QString name(takeFirst(values));

        if (!name.isEmpty())

            organization.setName(name);

        if (!values.isEmpty())

            organization.setDepartment(values);

    }

}

/*!

 * Set the organization logo from \a property.

 */

void QVersitContactImporterPrivate::setOrganizationLogo(

    QContactOrganization& org, const QVersitProperty& property) const

{

    QString location;

    QByteArray data;

    saveDataFromProperty(property, &location, &data);

    if (!location.isEmpty())

        org.setLogoUrl(QUrl(location));

}

/*!

 * Creates a QContactTimeStamp from \a property

 */

bool QVersitContactImporterPrivate::createTimeStamp(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QContactTimestamp timeStamp;

    QString value(property.value());

    bool utc = value.endsWith(QLatin1Char('Z'), Qt::CaseInsensitive);

    if (utc)

        value.chop(1); // take away z from end;

    QDateTime dateTime = parseDateTime(value,QLatin1String("yyyyMMddThhmmss"));

    if (!dateTime.isValid())

        return false;

    if (utc)

        dateTime.setTimeSpec(Qt::UTC);

    timeStamp.setLastModified(dateTime);

    saveDetailWithContext(updatedDetails, timeStamp, extractContexts(property));

    return true;

}

/*!

 * Creates a QContactAnniversary from \a property

 */

bool QVersitContactImporterPrivate::createAnniversary(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QContactAnniversary anniversary;

    QDateTime dateTime = parseDateTime(property.value(), QLatin1String("yyyyMMdd"));

    if (!dateTime.isValid())

        return false;

    anniversary.setOriginalDate(dateTime.date());

    saveDetailWithContext(updatedDetails, anniversary, extractContexts(property));

    return true;

}

/*!

 * Creates a QContactBirthday from \a property

 */

bool QVersitContactImporterPrivate::createBirthday(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QContactBirthday bday;

    QDateTime dateTime = parseDateTime(property.value(), QLatin1String("yyyyMMdd"));

    if (!dateTime.isValid())

        return false;

    bday.setDate(dateTime.date());

    saveDetailWithContext(updatedDetails, bday, extractContexts(property));

    return true;

}

/*!

 * Creates QContactNicknames from \a property

 */

bool QVersitContactImporterPrivate::createNicknames(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QVariant variant = property.variantValue();

    if (property.valueType() != QVersitProperty::ListType

            || variant.type() != QVariant::StringList)

        return false;

    QStringList values = variant.toStringList();

    QStringList contexts = extractContexts(property);

    foreach(const QString& value, values) {

        if (!value.isEmpty()) {

            QContactNickname nickName;

            nickName.setNickname(value);

            saveDetailWithContext(updatedDetails, nickName, contexts);

        }

    }

    return true;

}

/*!

 * Creates QContactTags from \a property

 */

bool QVersitContactImporterPrivate::createTags(

    const QVersitProperty& property,

    QContact* contact,

    QList<QContactDetail>* updatedDetails)

{

    Q_UNUSED(contact)

    QVariant variant = property.variantValue();

    if (property.valueType() != QVersitProperty::ListType

            || variant.type() != QVariant::StringList)

        return false;

    QStringList values = variant.toStringList();

    QStringList contexts = extractContexts(property);

    foreach(const QString& value, values) {

        if (!value.isEmpty()) {

            QContactTag tag;

            tag.setTag(value);

            saveDetailWithContext(updatedDetails, tag, contexts);

        }

    }

    return true;

}

/*!

 * Creates a QContactOnlineAccount from \a property

 */

bool QVersitContactImporterPrivate::createOnlineAccount(

    const QVersitProperty& property,

    QContact* contact,