/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: Private data and helper classes used by class CntCache.

*

*/

#include <qtcontacts.h>

#include <qcontactmanager.h>

#include <hbapplication.h>

#include <thumbnailmanager_qt.h>

#include <hbicon.h>

#include <QTimer>

#include "cntcache.h"

#include "cntcache_p.h"

#include "cntinfoprovider.h"

#include "cntdefaultinfoprovider.h"

#include "cntpresenceinfoprovider.h"

#include <cntdebug.h>

// maximum amount of info and icon jobs respectively -- if there are more jobs,

// then the oldest job is skipped and the client informed that this happened

// in this way the client can request the job again if wanted

static const int CntMaxInfoJobs = 20;

static const int CntMaxIconJobs = 20;

// amount of milliseconds to postpone the jobs if the UI is very active

static const int PostponeJobsMilliSeconds = 300;

// the id that states that no icon is currently pending from thumbnail manager

static const int NoIconRequest = -1;

// TODO: Provide a way (cenrep keys?) for UI to set which provider to use for

//       what info field (and what info fields are indeed even in use).

/*!

    Creates a new thread for fetching contact info and icons in the background.

 */

CntCacheThread::CntCacheThread()

    : mContactManager(new QContactManager()),

      mStarted(false),

      mPostponeJobs(false),

      mIconRequestId(NoIconRequest)

{

    CNT_ENTRY

    // create static provider plugins

    mDataProviders.insert(new CntDefaultInfoProvider(), ContactInfoAllFields);

    mDataProviders.insert(new CntPresenceInfoProvider(), ContactInfoIcon2Field);

    // TODO: create more static provider plugins

    // TODO: load dynamic provider plugins using QPluginLoader

    // connect the providers

    QMapIterator<CntInfoProvider*, ContactInfoFields> i(mDataProviders);

    while (i.hasNext()) {

        i.next();

        connect(qobject_cast<CntInfoProvider*>(i.key()),

                SIGNAL(infoFieldReady(CntInfoProvider*, int, ContactInfoField, const QString&)),

                this,

                SLOT(onInfoFieldReady(CntInfoProvider*, int, ContactInfoField, const QString&)));

    }

    // create & connect the thumbnail manager

    mThumbnailManager = new ThumbnailManager(this);

    mThumbnailManager->setMode(ThumbnailManager::Default);

    mThumbnailManager->setQualityPreference(ThumbnailManager::OptimizeForPerformance);

    mThumbnailManager->setThumbnailSize(ThumbnailManager::ThumbnailSmall);

    connect(mThumbnailManager, SIGNAL(thumbnailReady(QPixmap, void *, int, int)),

             this, SLOT(onIconReady(QPixmap, void *, int, int)));

    CNT_EXIT

}

/*!

    Cleans up and destructs the thread.

 */

CntCacheThread::~CntCacheThread()

{

    CNT_ENTRY

    delete mContactManager;

    disconnect(this);

    mJobMutex.lock();

    mInfoJobs.clear();

    mCancelledInfoJobs.clear();

    mIconJobs.clear();

    mCancelledIconJobs.clear();

    if (mIconRequestId != NoIconRequest) {

        mThumbnailManager->cancelRequest(mIconRequestId);

        mIconRequestId = NoIconRequest;

    }

    delete mThumbnailManager;

    mThumbnailManager = NULL;

    qDeleteAll(mDataProviders.keys());

    mDataProviders.clear();

    mJobMutex.unlock();

    exit();

    wait();

    CNT_EXIT

}

/*!

    Starts the event loop for this thread.

 */

void CntCacheThread::run()

{

    CNT_ENTRY

    exec();

    CNT_EXIT

}

/*!

    Schedules a info to be fetched for a contact. When info has been fetched

    infoFieldUpdated() signals will be emitted, once for each field.

    /param contactId the contact for which the info is wanted

 */

{

    CNT_ENTRY_ARGS( contactId )

    mJobMutex.lock();

    if (!mStarted) {

        // like updating the UI during scrolling

        start(QThread::IdlePriority);

        mStarted = true;

    }

    }

    if (mInfoJobs.count() >= CntMaxInfoJobs) {

        // the queue of jobs is full, so remove the oldest job

        CNT_LOG_ARGS( mCancelledInfoJobs.last() << "removed from joblist" )

    }

    // since this job has now been scheduled, remove it from the list of

    // cancelled jobs in case it is there

    mCancelledInfoJobs.removeOne(contactId);

    mJobMutex.unlock();

    CNT_EXIT

}

/*!

    Schedules an icon to be fetched. An iconUpdated() signal will be emitted when the icon

    has been fetched.

    /param iconName the name of the icon to be fetched

 */

{

    CNT_ENTRY_ARGS( iconName )

    mJobMutex.lock();

        // new job, so restart job loop

    }

    if (mIconJobs.count() >= CntMaxIconJobs) {

        // the queue of jobs is full, so remove the oldest job

        CNT_LOG_ARGS( mCancelledIconJobs.last() << "removed from joblist" );

    }

    // since this job has now been rescheduled, remove it from the list of

    // cancelled jobs in case it is there

    mCancelledIconJobs.removeOne(iconName);

    mJobMutex.unlock();

    CNT_EXIT

}

/*!

    Postpones outstanding jobs for a few tenths of a second. This should be called if

    the client wants to reserve more CPU time for some urgent task.

 */

void CntCacheThread::postponeJobs()

{

    CNT_ENTRY

    mPostponeJobs = true;

    CNT_EXIT

}

/*!

    Handles a class-specific event that is sent by the scheduleOrUpdate functions

    when there are jobs.

 */

bool CntCacheThread::event(QEvent* event)

{

        return true;

    }

    return QThread::event(event);

}

/*!

 */

{

    CNT_ENTRY

    forever {

        mJobMutex.lock();

        int infoJobs = mInfoJobs.count();

        int iconJobs = mIconJobs.count();

        int totalJobs = infoJobs + iconJobs + mCancelledInfoJobs.count() + mCancelledIconJobs.count();

        if (totalJobs == 0 || totalJobs == iconJobs && mIconRequestId != NoIconRequest || mPostponeJobs) {

            if (mPostponeJobs) {

                // client has requested a pause in activies (e.g. due to high UI activity)

                mPostponeJobs = false;

                if (totalJobs > 0) {

                }

                else {

                }

            }

            else {

            }

            mJobMutex.unlock();

            if (totalJobs == 0) {

                emit allJobsDone();

            }

            break;

        }

            // get next job

            mJobMutex.unlock();

            // fetch qcontact

            QContactFetchHint restrictions;

            restrictions.setOptimizationHints(QContactFetchHint::NoRelationships);

			QContact contact = mContactManager->contact(contactId, restrictions);

            // request contact info from providers

            QMapIterator<CntInfoProvider*, ContactInfoFields> i(mDataProviders);

            while (i.hasNext()) {

                i.next();

                if (i.value() != 0) {

                    i.key()->requestInfo(contact, i.value());

                }

            }

        }

        else if (iconJobs > 0 && mIconRequestId == NoIconRequest) {

            // request icon from thumbnail manager

            mIconRequestId = mThumbnailManager->getThumbnail(iconName, NULL, 0);

            mIconRequestName = iconName;

            mJobMutex.unlock();

        }

        else {

            if (mCancelledInfoJobs.count() > 0) {

                int contactId = mCancelledInfoJobs.takeLast();

                mJobMutex.unlock();

                emit infoCancelled(contactId);

            }

            else if (mCancelledIconJobs.count() > 0) {

                QString iconName = mCancelledIconJobs.takeFirst();

                mJobMutex.unlock();

                emit iconCancelled(iconName);

            }

        }

        // allow signals to be passed from providers and from the client

        HbApplication::processEvents();

    }

    CNT_EXIT

}

/*!

    Passes an info field from a data provider up to the client via signals. The

    client is not in the same thread, so Qt passes the signal as an event.

 */

void CntCacheThread::onInfoFieldReady(CntInfoProvider* sender, int contactId,

                                      ContactInfoField field, const QString& text)

{

    CNT_ENTRY

    // there can be 3rd party providers, so we cannot blindly trust them;

    // info is emitted only if:

    // 1) the sender is in the list of providers

    // 2) exactly one field bit is set in parameter 'field'

    // 3) the field bit has been assigned to this provider

    if (mDataProviders.contains(sender)

        && ((field & (field - 1)) == 0)

        && ((field & mDataProviders.value(sender)) != 0)) {

        emit infoFieldUpdated(contactId, field, text);

    }

    CNT_EXIT

}

/*!

    Passes an icon from thumbnail manager up to the client via a signal. The

    client is not in the same thread, so Qt passes the signal as an event.

 */

void CntCacheThread::onIconReady(const QPixmap& pixmap, void *data, int id, int error)

{

    CNT_ENTRY

    Q_UNUSED(id);

    Q_UNUSED(data);

    mJobMutex.lock();

    Q_ASSERT(id == mIconRequestId && !mIconRequestName.isEmpty());

        // job loop quit while waiting for this icon, so restart it

    }

    mIconRequestId = NoIconRequest;

    mJobMutex.unlock();

    if (error == 0) {

        emit iconUpdated(mIconRequestName, HbIcon(pixmap));

    }

    CNT_EXIT

}