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

**

** Copyright (C) 2009 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 <QObject>

#include <QDateTime>

#include <limits.h>

#include "qgeopositioninfosource_s60_p.h"

#include "qgeopositioninfosource.h"

#include "qmlbackendao_s60_p.h"

QTM_BEGIN_NAMESPACE

// constructor

CQGeoPositionInfoSourceS60::CQGeoPositionInfoSourceS60(QObject* aParent) : QGeoPositionInfoSource(aParent),

        mCurrentModuleId(TUid::Null()),

        mReqModuleId(TUid::Null()),

        mDevStatusUpdateAO(NULL),

        mReqUpdateAO(NULL),

        mRegUpdateAO(NULL),

        mSupportedMethods(PositioningMethod(0)),

        mCurrentMethod(PositioningMethod(0)),

        mListSize(0),

        mStartUpdates(FALSE),

        mRegularUpdateTimedOut(FALSE),

        mModuleFlags(0)

{

    memset(mList, 0 , MAX_SIZE * sizeof(CPosMethodInfo));

}

// destructor

CQGeoPositionInfoSourceS60::~CQGeoPositionInfoSourceS60()

{

    if (mReqUpdateAO)

        delete mReqUpdateAO;

    if (mRegUpdateAO)

        delete mRegUpdateAO;

    if (mDevStatusUpdateAO)

        delete mDevStatusUpdateAO;

}

// static function NewLC

CQGeoPositionInfoSourceS60* CQGeoPositionInfoSourceS60::NewLC(QObject* aParent)

{

    CQGeoPositionInfoSourceS60* self =

        new(ELeave) CQGeoPositionInfoSourceS60(aParent);

    CleanupStack::PushL(self);

    self->ConstructL();

    return self;

}

// static function NewL

CQGeoPositionInfoSourceS60* CQGeoPositionInfoSourceS60::NewL(QObject * aParent)

{

    CQGeoPositionInfoSourceS60* self = CQGeoPositionInfoSourceS60::NewLC(aParent);

    CleanupStack::Pop();

    //check if the second phase construction is successful

    if (!self->isValid()) {

        delete self;

        self = NULL;

    }

    return self;

}

// 2nd phase constructor

void CQGeoPositionInfoSourceS60::ConstructL()

{

    TInt error = mPositionServer.Connect();

    if (error == KErrNone) {

        CleanupClosePushL(mPositionServer);

        mDevStatusUpdateAO = CQMLBackendAO::NewL(this, DeviceStatus);

        if (mDevStatusUpdateAO == NULL) {

            CleanupStack::Pop(1);

            return;

        }

        //update the list array with the available method initially

        updateDeviceStatus();

        // Set the PreferredPositioningMethods based on Supported methods

        QGeoPositionInfoSource::setPreferredPositioningMethods( mSupportedMethods );

        //devStatusUpdateAO->NotifyDeviceStatus(mStatusEvent);

        CleanupStack::PushL(mDevStatusUpdateAO);

        if (mCurrentModuleId != TUid::Null())

            mRegUpdateAO = CQMLBackendAO::NewL(this, RegularUpdate, mCurrentModuleId);

        CleanupStack::Pop(2);

    }

}

QGeoPositionInfo CQGeoPositionInfoSourceS60::lastKnownPosition(bool aFromSatellitePositioningMethodsOnly) const

{

    QGeoPositionInfo posUpdate;

    TPosition pos;

    TInt error = KErrNone;

    RPositioner iLastKnownpositioner;

    TRequestStatus status;

    error = iLastKnownpositioner.Open(*const_cast<RPositionServer*>(&mPositionServer));

    //request for lastknown position update and wait for the request to complete

    if (error == KErrNone) {

        TPositionInfo posInfo;

        iLastKnownpositioner.SetRequestor(CRequestor::ERequestorService ,

                                          CRequestor::EFormatApplication, _L("QTmobility_Location"));

        iLastKnownpositioner.GetLastKnownPosition(posInfo, status);

        User::WaitForRequest(status);

        error = status.Int();

        iLastKnownpositioner.Close();

        if ((error == KErrNone) || (error == KPositionPartialUpdate)) {

            TPositionModuleInfo modInfo;

            mPositionServer.GetModuleInfoById(posInfo.ModuleId(), modInfo);

            if(!aFromSatellitePositioningMethodsOnly || (aFromSatellitePositioningMethodsOnly && (modInfo.Capabilities() & TPositionModuleInfo::ECapabilitySatellite))){

                QGeoCoordinate  coord;

                posInfo.GetPosition(pos);

                coord.setLatitude(pos.Latitude());

                coord.setLongitude(pos.Longitude());

                coord.setAltitude(pos.Altitude());

                //store the QGeoCoordinate values

                posUpdate.setCoordinate(coord);

                TDateTime datetime = pos.Time().DateTime();

                QDateTime dt(QDate(datetime.Year(), datetime.Month() + 1, datetime.Day() + 1),

                             QTime(datetime.Hour(), datetime.Minute(), datetime.Second(),

                                   datetime.MicroSecond() / 1000),

                            Qt::UTC);

                //store the time stamp

                posUpdate.setTimestamp(dt);

                //store the horizontal accuracy

                posUpdate.setAttribute(QGeoPositionInfo::HorizontalAccuracy, pos.HorizontalAccuracy());

                //store the vertical accuracy

                posUpdate.setAttribute(QGeoPositionInfo::VerticalAccuracy, pos.VerticalAccuracy());

            }

        }

    }

    return posUpdate;

}

//

int CQGeoPositionInfoSourceS60::minimumUpdateInterval() const

{

    if (mCurrentModuleId == TUid::Null())

        return 0;

    TInt i = checkModule(mCurrentModuleId);

    if (i != -1)

        return mList[i].mTimeToNextFix.Int64() / 1000;           //divide by 1000, to convert microsecond to milisecond

    return 0;

}

//private function : to derive the supported positioning methods

void CQGeoPositionInfoSourceS60::updateAvailableTypes()

{

    PositioningMethods types;

    for (TInt i = 0; i < mListSize ; i++) {

        //check only for the available module without any device errors

        if (mList[i].mIsAvailable &&

                (mList[i].mStatus != TPositionModuleStatus::EDeviceUnknown) &&

                (mList[i].mStatus != TPositionModuleStatus::EDeviceError)) {

            types |= mList[i].mPosMethod;

        }

        //if both SatellitePositioningMethods and NonSatellitePositioningMethods return

        if (types.testFlag(AllPositioningMethods))

            break;

    }

    //update the supported methods based on types value, derived from the above steps

    mSupportedMethods = types;

}

//private function : to retrieve the index of the supplied module id from the mList array

TInt CQGeoPositionInfoSourceS60::checkModule(TPositionModuleId aId)const

{

    TInt i;

    for (i = 0; i < mListSize; i++)

        if (mList[i].mUid == aId)

            return i;

    return -1;

}

//private function : get the index of the mList that supports the preferred method if

//available,else returns the index of the default module

TInt CQGeoPositionInfoSourceS60::getIndexPositionModule(TUint8 aBits, PositioningMethods aPosMethods) const

{

    TInt index, error;

    TPositionModuleId modID;

    //get the default module Id, whose index is returned if the preferred methods are not

    //available

    error = mPositionServer.GetDefaultModuleId(modID);

    if (error != KErrNone)

        modID = TUid::Null();

    //index = -1 : no methods available in the mList that supports preferred methods

    index = -1;

    for (TInt i = 0; i < mListSize ; i++) {

        //check the module properties to select the preferred method,search should not

        //not select an unavailable method,error device or index matching aLastIndex

        if (mList[i].mIsAvailable && aPosMethods.testFlag(mList[i].mPosMethod)

                && (mList[i].mStatus != TPositionModuleStatus::EDeviceUnknown)

                && (mList[i].mStatus != TPositionModuleStatus::EDeviceError)

                && (((aBits >> i) & 1))) {

            return i;

        }

        //store the index of the default module

        if ((modID == mList[i].mUid) && ((aBits >> i) & 1))

            index = i;

    }

    return index;

}

//private function : to get the index of the positioning method with time to first fix

//lesser than timeout

TInt CQGeoPositionInfoSourceS60::getMoreAccurateMethod(TInt aTimeout, TUint8 aBits)

{

    TInt index = -1;

    double temp = -1.0;

    PositioningMethods posMethods;

    TTimeIntervalMicroSeconds microSeconds;

    posMethods = preferredPositioningMethods();

    //convert the timeout --> micro seconds

    microSeconds = aTimeout * 1000;

    for (TInt i = 0 ; i < mListSize; i++) {

        if (mList[i].mIsAvailable

                //&& posMethods.testFlag(mList[i].mPosMethod)

                && (mList[i].mStatus != TPositionModuleStatus::EDeviceUnknown)

                && (mList[i].mStatus != TPositionModuleStatus::EDeviceError)

                && (((aBits >> i) & 1))

                && (mList[i].mTimeToFirstFix < microSeconds)) {

            if ((temp == -1.0) || (mList[i].mHorizontalAccuracy < temp)) {

                index = i;

                temp = mList[i].mHorizontalAccuracy;

            }

        }

    }

    if (index != -1) {

        return index;

    }

    bool minSet = false;

    microSeconds = 0;

    for (TInt i = 0 ; i < mListSize; i++) {

        if (mList[i].mIsAvailable

                //&& posMethods.testFlag(mList[i].mPosMethod)

                && (mList[i].mStatus != TPositionModuleStatus::EDeviceUnknown)

                && (mList[i].mStatus != TPositionModuleStatus::EDeviceError)

                && (((aBits >> i) & 1))) {

            if (!minSet || (mList[i].mTimeToFirstFix < microSeconds)) {

                index = i;

                minSet = true;

                microSeconds = mList[i].mTimeToFirstFix;

            }

        }

    }

    return index;

}

//private function : to update the mList array

void CQGeoPositionInfoSourceS60::updateStatus(TPositionModuleInfo aModInfo, TInt aStatus)

{

    TInt i, index;

    TPositionModuleId id;

    PositioningMethod method;

    TBool available;

    TReal32 accuracy;

    TTimeIntervalMicroSeconds time_to_first_fix, time_to_next_fix;

    TPositionQuality quality;

    CQMLBackendAO *temp = NULL;

    //query for the following parameters

    id = aModInfo.ModuleId();

    //module with a satellite capability is assumed to be provided satellite based positioning

    //method

    method = (aModInfo.Capabilities() & TPositionModuleInfo::ECapabilitySatellite) ?

             SatellitePositioningMethods : NonSatellitePositioningMethods;

    //gets the device availability based on the user settings

    available = aModInfo.IsAvailable();

    //quality : holds the required metrics

    aModInfo.GetPositionQuality(quality);

    //Accuracy

    accuracy = quality.HorizontalAccuracy();

    //time taken for the first fix

    time_to_first_fix = quality.TimeToFirstFix();

    //time taken for the subsequent fix

    time_to_next_fix = quality.TimeToNextFix();

    if ((i = checkModule(id)) == -1) {

        //update the properties of the module

        //TPositionModuleId of the module

        mList[mListSize].mUid = id;

        //positioning method method type

        mList[mListSize].mPosMethod = method;

        //status of the device

        mList[mListSize].mStatus = aStatus;

        //availablility of the module

        mList[mListSize].mIsAvailable = available;

        //horizontal accuracy of the module

        mList[mListSize].mHorizontalAccuracy = accuracy;

        //time required to get the first fix

        mList[mListSize].mTimeToFirstFix = time_to_first_fix;

        //time required for subsequent fix

        mList[mListSize].mTimeToNextFix = time_to_next_fix;

        //count on the mList array size

        mListSize++;

        //update the supported source types based on the device status

        updateAvailableTypes();

        //store the correct method in use from the mCurrentModuleId retireved earlier

        if (id == mCurrentModuleId) {

            mCurrentMethod = method;

        }

    } else {

        //module's status has changed

        if (mList[i].mStatus != aStatus)

            mList[i].mStatus = aStatus;

        //module's availability has changed

        if (mList[i].mIsAvailable != available)

            mList[i].mIsAvailable = available;

        //module's horizontal accuracy has changed

        if (mList[i].mHorizontalAccuracy != accuracy)

            mList[i].mHorizontalAccuracy = accuracy;

        //module's time to first fix has changed

        if (mList[i].mTimeToFirstFix != time_to_first_fix)

            mList[i].mTimeToFirstFix = time_to_first_fix;

        //module's time to subsequent fix has changed

        if (mList[i].mTimeToNextFix != time_to_next_fix)

            mList[i].mTimeToFirstFix = time_to_next_fix;

        //update the supported source types based on the device status

        updateAvailableTypes();

        //if the mCurrentModuleId is NULL, try updating the reg update with the available

        //positioning method

        if (mCurrentModuleId == TUid::Null() && (available == TRUE) &&

                (aStatus != TPositionModuleStatus::EDeviceUnknown) &&

                (aStatus != TPositionModuleStatus::EDeviceError)) {

            TInt interval;

            interval = QGeoPositionInfoSource::updateInterval();

            TRAPD(ret, temp = CQMLBackendAO::NewL(this, RegularUpdate,

                                                  mList[i].mUid));

            if ((ret == KErrNone) && (temp != NULL)) {

                temp->setUpdateInterval(interval);

                if (mRegUpdateAO)

                    delete mRegUpdateAO;

                mRegUpdateAO = temp;

                //to be uncommented when startUpdates are done

                if (mStartUpdates)

                    mRegUpdateAO->startUpdates();

                mCurrentModuleId = mList[i].mUid;

                mCurrentMethod = mList[i].mPosMethod;

            }

        }

        //check if the status of the currently used modules for regular update or

        //request update has changed

        if (((id == mCurrentModuleId) || (id == mReqModuleId)) &&

                ((aStatus == TPositionModuleStatus::EDeviceUnknown) ||

                 (aStatus == TPositionModuleStatus::EDeviceError) ||

                 (available == FALSE))) {

            //if the change happened for regular update

            if (id == mCurrentModuleId) {

                TInt interval;

                TUint8 bits;

                interval = QGeoPositionInfoSource::updateInterval();

                if (mRegUpdateAO)

                    delete  mRegUpdateAO;

                bits = mModuleFlags;

                do {

                    //error = Get the index of the positioning module based on

                    //the preferred method if available , else get the default

                    //position module

                    index = getIndexPositionModule(bits);

                    if (index >= 0) {

                        TRAPD(ret, temp = CQMLBackendAO::NewL(this, RegularUpdate,

                                                              mList[index].mUid));

                        if ((ret == KErrNone) && (temp != NULL))

                            break;

                        bits = bits & (0XFF ^(1 << index));

                    }

                } while (index >= 0);

                if (temp != NULL) {

                    //successful in creating the subsession for the required

                    //method

                    mRegUpdateAO = temp;

                    mCurrentModuleId = mList[index].mUid;

                    mCurrentMethod = mList[index].mPosMethod;

                    mRegUpdateAO->setUpdateInterval(interval);

                    //to be uncommented when startUpdates are done

                    if (mStartUpdates)

                        mRegUpdateAO->startUpdates();

                } else {

                    //no methods available,clean up the resources

                    mRegUpdateAO = NULL;

                    mCurrentModuleId = TUid::Null();

                    mCurrentMethod = PositioningMethod(0);