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

**

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

#include "qcontactdetail_p.h"

#include "qcontactmanager.h"

#include <QDebug>

QTM_BEGIN_NAMESPACE

/* Initialise our static private data member */

QAtomicInt QContactDetailPrivate::lastDetailKey(1);

/* Definitions of predefined string constants */

Q_DEFINE_LATIN1_CONSTANT(QContactDetail::FieldDetailUri, "DetailUri");

Q_DEFINE_LATIN1_CONSTANT(QContactDetail::FieldLinkedDetailUris, "LinkedDetailUris");

Q_DEFINE_LATIN1_CONSTANT(QContactDetail::FieldContext, "Context");

Q_DEFINE_LATIN1_CONSTANT(QContactDetail::ContextOther, "Other");

Q_DEFINE_LATIN1_CONSTANT(QContactDetail::ContextHome, "Home");

Q_DEFINE_LATIN1_CONSTANT(QContactDetail::ContextWork, "Work");

/* Storage */

QHash<QString, char*> QContactStringHolder::s_allocated;

QHash<const char *, QString> QContactStringHolder::s_qstrings;

/* Dtor function */

static int qClearAllocatedStringHash()

{

    QHash<QString, char*>::const_iterator it = QContactStringHolder::s_allocated.constBegin();

    while (it != QContactStringHolder::s_allocated.constEnd()) {

        delete[] it.value();

        it++;

    }

    QContactStringHolder::s_allocated.clear();

    QContactStringHolder::s_qstrings.clear();

    return 1;

}

Q_DESTRUCTOR_FUNCTION(qClearAllocatedStringHash);

/*!

  \class QContactDetail

  \brief The QContactDetail class represents a single, complete detail about a contact.

  \ingroup contacts-main

  All of the information for a contact is stored in one or more QContactDetail objects.

  A detail is a group of logically related bits of data - for example, a street address is a single

  detail that has multiple fields (number, region, country etc).  Every QContactDetail has the name of an

  associated QContactDetailDefinition that describes the fields, their data type, and any

  restrictions on their values.  Different contact managers might have different detail definitions

  for the same name, depending on their capabilities.  For example, for the QContactName definition name,

  one manager might not support the middle name field, while a different manager may add an extra field for

  specific extra information not present in the default schema.

  Both the names of all the fields, and the name of the associated QContactDetailDefinition are stored

  as 8-bit strings encoded in Latin 1 for memory conservation.  Note, however, that the values stored

  in each field are not constrained in this way, and full unicode QStrings or QVariant data can be stored.

  One field which is common to all details is the context field.  This field is intended to store one or

  more contexts that this detail is associated with.  Commonly this will be something like

  "Home" and/or "Work", although no limitations are placed on which values may be stored in this field

  in the default schema.

  There are two other, related fields which are common to all details.  The first is

  \a QContactDetail::FieldDetailUri, which stores the unique URI of the detail if one exists.

  The field is not mandatory, and backends are not required to verify that the given URI is indeed

  unique within the contact.  The second field is \a QContactDetail::LinkedDetailUris, which stores

  a list of detail URIs to which this detail is linked.  The link is one-way, and can be used to show

  how or where a detail was derived.  This is useful for things like presence information and avatars,

  which are linked to a particular online account detail of the contact.

  When a QContactDetail has been retrieved in a QContact from a QContactManager, it may have certain

  access constraints provided with it, like \l ReadOnly or \l Irremovable.  This might mean that the

  supplied detail is calculated or otherwise not modifiable by the user - presence information is a

  good example.  Also, some details may be marked \l Irremovable.  These are typically things that

  a contact has to have - like a QContactDisplayLabel or a QContactType.

  It is possible to inherit from QContactDetail to provide convenience or

  standardized access to values.  For example, \l QContactPhoneNumber provides

  a convenient API for manipulating a QContactDetail as a phone number, according

  to the schema.

  In general, QContactDetail and the built in subclasses (like \l QContactPhoneNumber) provide

  constants for the names of fields (like \l QContactPhoneNumber::FieldNumber), and for predefined

  common values like \l QContactDetail::ContextHome.  Typically the constants for field names start

  with \c Field, and the constants for predefined values of a field start with the name of that field

  (e.g. \c ContextHome is a predefined constant for \c FieldContext).

  If you wish to create your own, customized contact detail, you should use

  the \l Q_DECLARE_CUSTOM_CONTACT_DETAIL macro in order to ensure proper

  operation, and declare your own field constants with \l Q_DECLARE_LATIN1_CONSTANT.

  See the predefined detail subclasses (like \l QContactPhoneNumber,

  \l QContactAddress) for more information.

  QContactDetail objects act like type checked values.  In general, you can assign them

  to and fro and have reasonable behaviour, like the following example.

  \code

  QContactPhoneNumber number;

  number.setNumber("555-1212");

  // number.value(QContactPhoneNumber::FieldNumber) == "555-1212";

  // number.definitionName() == QContactPhoneNumber::DefinitionName

  QContactDetail detail = number;

  // detail.value(QContactPhoneNumber::FieldNumber) == "555-1212";

  // detail.definitionName() == QContactPhoneNumber::DefinitionName

  QContactPhoneNumber otherNumber = detail;

  // otherNumber.number() == "555-1212";

  // otherNumber.definitionName() == QContactPhoneNumber::DefinitionName

  QContactAddress address = detail;

  // address is now a default constructed QContactAddress

  // address.value(QContactPhoneNumber::FieldNumber) is empty

  // address.definitionName() == QContactAddress::DefinitionName

  QContactAddress otherAddress = number;

  // otherAddress is now a default constructed QContactAddress

  // otherAddress.value(QContactPhoneNumber::FieldNumber) is empty

  // otherAddress.definitionName() == QContactAddress::DefinitionName

  \endcode

  \sa QContact, QContactDetailDefinition, QContactDetailFilter, QContactDetailRangeFilter, Q_DECLARE_CUSTOM_CONTACT_DETAIL

 */

/*!

  \macro Q_DECLARE_CUSTOM_CONTACT_DETAIL

  \relates QContactDetail

  Macro for simplifying declaring custom (leaf) detail classes.

  The first argument is the name of the class, and the second argument

  is a Latin-1 string literal naming the detail type.

  If you are creating a convenience class for a type of QContactDetail,

  you should use this macro when declaring your class to ensure that

  it interoperates with other contact functionality.

  Here is an example of a class (\l QContactPhoneNumber) using this macro.

  Note that the class provides some predefined constants

  and some convenience methods that return values associated with schema

  fields.

  \snippet ../../src/contacts/details/qcontactphonenumber.h 0

 */

/*!

    \class QLatin1Constant

    \headerfile

    \brief The QLatin1Constant class holds a Latin 1 string constant

*/

/*!

    \fn QLatin1Constant::operator QString() const

    \internal

 */

/*!

    \fn QLatin1Constant::operator QLatin1String() const

    \internal

 */

/*!

    \fn QLatin1Constant::operator QVariant() const

    \internal

 */

/*!

    \fn bool QLatin1Constant::operator ==(const QLatin1Constant& other) const

    Returns true if this QLatin1Constant is the same as \a other (either same object or

    same string literal), and false otherwise.

 */

/*!

    \fn bool QLatin1Constant::operator !=(const QLatin1Constant& other) const

    Returns false if this QLatin1Constant is the same as \a other (either same object or

    same string literal), and true otherwise.

*/

/*!

    \fn inline const char * QLatin1Constant::latin1() const

    Returns the value of this literal as a C style string (null terminated).

*/

/*!

  \macro Q_DECLARE_LATIN1_CONSTANT

  \relates QLatin1Constant

  This macro, along with the related Q_DEFINE_LATIN1_CONSTANT macro,

  allows you to describe a "Latin 1 string constant".

  The resulting constant can be passed to functions accepting a

  QLatin1String, a QString, or a QVariant.

  The first parameter is the name of the variable to declare.  The

  second parameter is the value of the constant, as a string literal.

  For example:

  \code

  // in a header file

  Q_DECLARE_LATIN1_CONSTANT(MyConstant, "MYCONSTANT");

  \endcode

  The declaration should be paired with a matching Q_DEFINE_LATIN1_CONSTANT

  with the same arguments to actually define the constant.

  \sa Q_DEFINE_LATIN1_CONSTANT

*/

/*!

  \macro Q_DEFINE_LATIN1_CONSTANT

  \relates QLatin1Constant

  This macro, along with the related Q_DECLARE_LATIN1_CONSTANT macro,

  allows you to describe a "Latin 1 string constant".

  The resulting constant can be passed to functions accepting a

  QLatin1String, a QString, or a QVariant.

  The first parameter is the name of the variable to define.  The

  second parameter is the value of the constant, as a string literal.

  For example:

  \code

  // in a header file

  Q_DECLARE_LATIN1_CONSTANT(MyConstant, "MYCONSTANT");

  // in source file

  Q_DEFINE_LATIN1_CONSTANT(MyConstant, "MYCONSTANT");

  \endcode

  You can use this macro without the matching DECLARE macro if

  you are using the constant only in a single compilation unit.

  \sa Q_DECLARE_LATIN1_CONSTANT

*/

/*!

  \fn QContactDetail::operator!=(const QContactDetail& other) const

  Returns true if the values or id of this detail is different to those of the \a other detail

 */

/*!

  Constructs a new, empty detail

 */

QContactDetail::QContactDetail()

    : d(new QContactDetailPrivate)

{

}

/*!

    Constructs a new, empty detail of the definition identified by \a thisDefinitionId.

    The definitionId must be restricted to the Latin 1 character set.

 */

QContactDetail::QContactDetail(const QString& thisDefinitionId)

    : d(new QContactDetailPrivate)

{

    d->m_definitionName = thisDefinitionId;

}

/*!

    Constructs a new, empty detail of the definition identified by \a thisDefinitionId

    The supplied pointer must be valid for the lifetime of the program.  In general

    this means it should be a constant, and not allocated on the stack.  If you cannot

    meet this requirement, use the alternative constructor that takes a QString instead.

*/

QContactDetail::QContactDetail(const char* thisDefinitionId)

    : d(new QContactDetailPrivate)

{

    d->m_definitionName = thisDefinitionId;

}

/*! Constructs a detail that is a copy of \a other */

QContactDetail::QContactDetail(const QContactDetail& other)

    : d(other.d)

{

}

/*!

    \internal

    Constructs a detail that is a copy of \a other if \a other is of the expected definition

    identified by \a expectedDefinitionId, else constructs a new, empty detail of the

    definition identified by the \a expectedDefinitionId.

    The \a expectedDefinitionId pointer must be valid for the lifetime of the program.

*/

QContactDetail::QContactDetail(const QContactDetail& other, const char* expectedDefinitionId)

{

    if (other.d->m_definitionName == expectedDefinitionId) {

        d = other.d;

    } else {

        d = new QContactDetailPrivate;

        d->m_definitionName = expectedDefinitionId;

    }

}

/*!

    \internal

    Constructs a detail that is a copy of \a other if \a other is of the expected definition

    identified by \a expectedDefinitionId, else constructs a new, empty detail of the

    definition identified by the \a expectedDefinitionId

*/

QContactDetail::QContactDetail(const QContactDetail& other, const QString& expectedDefinitionId)

{

    if (other.d->m_definitionName == expectedDefinitionId) {

        d = other.d;

    } else {

        d = new QContactDetailPrivate;

        d->m_definitionName = expectedDefinitionId;

    }

}

/*! Assigns this detail to \a other */

QContactDetail& QContactDetail::operator=(const QContactDetail& other)

{

    if (this != &other)

        d = other.d;

    return *this;

}

/*!

    \internal

    Assigns this detail to \a other if the definition of \a other is that identified

    by the given \a expectedDefinitionId, else assigns this detail to be a new, empty

    detail of the definition identified by the given \a expectedDefinitionId

*/

QContactDetail& QContactDetail::assign(const QContactDetail& other, const char* expectedDefinitionId)

{

    if (this != &other) {

        if (other.d->m_definitionName == expectedDefinitionId) {

            d = other.d;

        } else {

            d = new QContactDetailPrivate;

            d->m_definitionName = expectedDefinitionId;

        }

    }

    return *this;

}

/*!

    \internal

    Assigns this detail to \a other if the definition of \a other is that identified

    by the given \a expectedDefinitionId, else assigns this detail to be a new, empty

    detail of the definition identified by the given \a expectedDefinitionId

*/

QContactDetail& QContactDetail::assign(const QContactDetail& other, const QString& expectedDefinitionId)

{

    if (this != &other) {

        if (other.d->m_definitionName == expectedDefinitionId) {

            d = other.d;

        } else {

            d = new QContactDetailPrivate;

            d->m_definitionName = expectedDefinitionId;

        }

    }

    return *this;

}

/*! Frees the memory used by this detail */

QContactDetail::~QContactDetail()

{

}

/*!

    Returns the (unique) name of the definition which defines the semantics and structure of this detail.

    The actual QContactDetailDefinition should be retrieved from the relevant QContactManager using this name.

 */

QString QContactDetail::definitionName() const

{

    return d.constData()->m_definitionName.toQString();

}

/*!

    Compares this detail to \a other.  Returns true if the definition, access constraints and values of \a other are equal to those of this detail.

    The keys of each detail are not considered during the comparison, in order to allow details from different contacts to

    be compared according to their values.

 */

bool QContactDetail::operator==(const QContactDetail& other) const

{

    if (! (d.constData()->m_definitionName == other.d.constData()->m_definitionName))

        return false;

    if (d.constData()->m_access != other.d.constData()->m_access)

        return false;

    if (d.constData()->m_values != other.d.constData()->m_values)

        return false;

    return true;

}

uint qHash(const QContactStringHolder& key)

{

    if (!key.m_str)

        return 0;

    uint h = 0;

    uint g;

    const register uchar*p = (const uchar*)key.m_str;

    while (*p) {

        h = (h << 4) + *p++;

        if ((g = (h & 0xf0000000)) != 0)

            h ^= g >> 23;

        h &= ~g;

    }

    return h;

}

/*! Returns the hash value for \a key. */

uint qHash(const QContactDetail &key)

{

    const QContactDetailPrivate* dptr= QContactDetailPrivate::detailPrivate(key);

    uint hash = qHash(dptr->m_definitionName)

                + QT_PREPEND_NAMESPACE(qHash)(dptr->m_access);

    QHash<QContactStringHolder, QVariant>::const_iterator it = dptr->m_values.constBegin();

    while(it != dptr->m_values.constEnd()) {

        hash += qHash(it.key())

                + QT_PREPEND_NAMESPACE(qHash)(it.value().toString());

        ++it;

    }

    return hash;

}

#ifndef QT_NO_DEBUG_STREAM

QDebug operator<<(QDebug dbg, const QContactDetail& detail)

{

    dbg.nospace() << "QContactDetail(name=" << detail.definitionName() << ", key=" << detail.key();

    QVariantMap fields = detail.variantValues();

    QVariantMap::const_iterator it;

    for (it = fields.constBegin(); it != fields.constEnd(); ++it) {

        dbg.nospace() << ", " << it.key() << '=' << it.value();

    }

    dbg.nospace() << ')';

    return dbg.maybeSpace();

}

#endif

/*!

    Returns true if no values are contained in this detail.  Note that context is stored as a value; hence, if a context is set, this function will return false.

 */

bool QContactDetail::isEmpty() const

{

    if (!d.constData()->m_values.isEmpty())

        return false;

    return true;

}

/*!

 * Returns the key of this detail.

 *

 * Be aware that if a contact is retrieved (or reloaded) from the backend, the

 * keys of any details it contains may have been changed by the backend, or other

 * threads may have modified the contact details in the backend.  Therefore,

 * clients should reload the detail that they wish to save in or remove from a contact

 * after retrieving the contact from the backend, in order to ascertain the keys of

 * any such details.

 */

int QContactDetail::key() const

{

    return d->m_id;

}

/*! Causes the implicitly-shared detail to be detached from any other copies, and generates a new key for it.

    This ensures that calling QContact::saveDetail() will result in a new detail being saved, rather than

    another detail being updated. */

void QContactDetail::resetKey()

{

    d->m_id = QContactDetailPrivate::lastDetailKey.fetchAndAddOrdered(1);

}

/*! \overload

  Returns the value stored in this detail for the given \a key as a QString, or an empty QString if

  no value for the given \a key exists */

QString QContactDetail::value(const QString& key) const

{

    return d.constData()->m_values.value(QContactStringHolder(key)).toString();

}

/*!

    \internal

    \overload

    Returns the value stored in this detail for the given \a key as a QString, or an empty QString if

    no value for the given \a key exists