/*

* Copyright (c) 2005 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:  

*       See class description below.

*

*/

#ifndef __EPOS_CSUPLSETTINGSENGINE_H__

#define __EPOS_CSUPLSETTINGSENGINE_H__

//  INCLUDES

#include <e32base.h>

#include <etel.h>

#include <etelmm.h>

#include "epos_csuplsettings.h"

#include "epos_csuplsettingsinternal.h"

// FORWARD DECLARATIONS

class CRepository;

class CSuplEtelRequest;

class CServerParams;

class CTriggerParams;

class CServerExtensionParams;

class CSuplSettings;

class CSettingsDatabaseHandler;

// CONSTANTS

// CLASS DECLARATION

/**

*  This class is used for accessing central repository and to get

*  IMSI from ETEL. 

*

*  This is part of @lib epos_suplsettings.lib

*  @since 3.1

*/

class CSuplSettingsEngine : public CBase

    {

   public:

        enum TEtelReqState

	    {

        EUndefined,                

	    EImsi,

		ELoc

		};            

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        *

        * @returns A new instance of this class.

        */

        static CSuplSettingsEngine* NewL();

        /**

        * Destructor.

        */

        virtual ~CSuplSettingsEngine();

    private:

        /**

        * C++ default constructor.

        */

        CSuplSettingsEngine();

        /**

        * By default EPOC constructor is private.

        */

        void ConstructL();

    public: // New functions

        /**

        * This method connects to ETEL, instantiates ETEL request

        * active object.  This is an asynchronous call.  

        * It retrieves IMSI value from IMSI.

        */

        void Initialize(TRequestStatus& aStatus);        

        /**

        * This method connects to ETEL.

        */

        TInt ConnectToEtelL();

        /**

        * This method cancels initialization request. 

        */

        void CancelInitialize();

       /* *

        * This method sets HSLP address, IAP Name and changed by field

        * in SUPL settings. 

        TInt Set( 

         IN         const TDesC&  aHslpAddress, 

         IN         const TDesC&  aIapName,

         IN         const TInt aChangedBy

        );

        *

        * This method retrieves HSLP address, IAP Name, IMSI vlaue and 

        * changed by field from SUPL settings. 

        TInt Get(

         OUT        TDes&    aHslpAddress, 

         OUT        TDes&  aIapName, 

         OUT        TDes&  aImsi,

         OUT        TInt&     aChangedBy

        );

*/

        /**

        * This method generates HSLP address from the IMSI retrieved from

        * ETEL during initialization. 

        */

        TInt GetHslpAddressFromImsi(

        /* OUT */       TDes& aHslpAddr

        );

        /**

        * This method creates a concurrent read/write transaction.

        * The method leaves a clean-up item to clean-up stack to roll back

        * the changes in case of leave.

        * Remember to pop the item from the stack before making commit.

        */

        TInt LockEngineL();

        /**

        * This method commits a concurrent read/write transaction and pops

        * the roll-back clean-up item from the stack

        *

        * The method handles possible roll back in case of failure.

        * 

        */

        TInt UnLockEngine(TBool aWithCommit);

    /**

     * This method retrieves currently active IMSI.  Currently active IMSI

     * is retrieved during initialization time.

     *

     * @param aImsi will hold, on successful completion, currently active IMSI

     * @return one of the following error codes returned

     *  - KErrNone if method completed successfully

     *  - KErrNotReady if this method is called before @ref Initialize

     */

    TInt GetImsi(TDes& aImsi);

    /**

     * This method compares IMSI value currently stored in SUPL settings and

     * currently active IMSI. If both are same, this method returns false else

     * returns true.   

     * 

     * @param aChanged will hold, on successful completion, one of the following value

     *   - ETrue if currently active IMSI and IMSI value stored in SUPL settings

     *   are different.

     *   - EFalse if currently active IMSI and IMSI value stored in SUPL settings

     *   are same.

     * @return one of the following

     *  - KErrNone if method completed successfully

     *  - KErrNotReady if this method is called before @ref Initialize

     */

    TInt IsImsiChanged(TBool& aChanged);

       /**

        * This method is used to retrieve SUPL usage from settings storage.  

        *

        * @param [OUT] aUsage  will hold, upon successful completion, value indicating 

	    * current SUPL usage 

        * @return one of the following error codes: 

        *         - KErrNone if SUPL usage retrieved successfully.  

        *         - KErrNotFound if the SUPL State is not found in SUPL settings

        *         - KErrUnknown if retrieving SUPL usage from settings storage failed

        */

    TInt GetSuplUsage(TInt& aUsage);

       /**

        * This method is used to change SUPL usage.  Using this method, SUPL usage can be 

        * set to always ask or automatic or automatic in home network or disabled.  

        * By default, SUPL usage will be set to always ask. 

        *

        * Note that this method should be invoked only after settings are locked 

        * using @ref LockSettingsL() method. After changing SUPL usage, settings

        * should be unlocked using @ref UnlockSettings() method.

        *

        * @param [IN] aUsage Usage to be set for SUPL usage 

        * @return one of the following error codes: 

        *         - KErrNone if SUPL usage is changed successfully.  

        *         - KErrArgument if aUsage field is not in range

        *         - KErrNotReady if this method is invoked before @ref LockSettingsL()

        *         - KErrUnknown if changing SUPL usage in settings storage has failed

        */

    TInt SetSuplUsage(const TInt aUsage);

    /*

     * This method is used to check if the initialisation has been done  using @ref Initialize()

     * 

     * @return ETrue if init has been done

     *         EFalse otherwise

     */

    TBool IsInitDone();

    /*

     * This method is used to check if the initialisation has been successful 

     * 

     * @return ETrue if init has been succesful

     *         EFalse otherwise

     */

    TBool IsInitPassed();

    /**

     * This method is used to add new server into settings.  It is client's responsibility

     * to set all the parameters in aParamValues except SLP identification which will

     * generated automatically.

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aParamValues Server parameter values which which the server entry needs to be added 

     * @param [OUT] aSlpId SLP identification for the new server added 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     */ 

    TInt AddNewServer( 

            const CServerParams* aParamValues, 

            TInt64& aSlpId 

    );

    /**

     * This method is used to change server address parameter in server settings 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aServerAddres SUPL Server address 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if address passed is empty or if the SLP ID passed is not valid 

     */

    TInt SetServerAddress( 

            const TInt64 aSlpId, 

            const TDesC& aServerAddress

    );

    /**

     * This method is used to retrieve server address parameter from server settings.  Client

     * has to allocate memory for server address parameter.

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID of server for which the server address needs to be retrieved 

     * @param [OUT] aServerAddres SUPL Server address 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetServerAddress( 

            TInt64 aSlpId, 

            TDes& aServerAddress

    ) const;

    /**

     * This method is used to change protocol version supported by SUPL server.  The protocol

     * version consists of two parts : Major version and Minor version.  

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aMajor Major version number.  It can takes values from 0 to 255. 

     * @param [IN] aMinor Minor version number.  It can takes values from 0 to 255. 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if version parameters are not in range or if the SLP ID passed is not valid 

     */

    TInt SetVersion( 

            const TInt64 aSlpId, 

            const TInt aMajor,

            const TInt aMinor 

    );

    /**

     * This method is used to retrieve protocol version supported by SUPL server.  The protocol

     * version consists of two parts : Major version and Minor version.  

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be retrieved 

     * @param [OUT] aMajor Major version number.  It can takes values from 0 to 255. 

     * @param [OUT] aMinor Minor version number.  It can takes values from 0 to 255. 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetVersion( 

            const TInt64 aSlpId, 

            TInt& aMajor,

            TInt& aMinor 

    ) const;

    /**

     * This method is used to change IAP Name in server parameters. IAP name refers to 

     * the access point which is used to access the HSLP over the internet. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aIapName The Internet Access Point Name refers to the access point which is 

     * used to access the HSLP over the internet.  This can have maximum size of 100 characters. 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if IAP Name is empty or if the SLP ID passed is not valid 

     */

    TInt SetIapName( 

            const TInt64 aSlpId, 

            const TDesC& aIapName

    );

    /**

     * This method is used to retrieve IAP Name in server parameters. IAP name refers to 

     * the access point which is used to access the HSLP over the internet. It is client's

     * responsibility to allocate memory for IAP name before invoking this method.

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be retrieved 

     * @param [OUT] aIapName The Internet Access Point Name refers to the access point which is 

     * used to access the HSLP over the internet.  This can have maximum size of 100 characters. 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetIapName( 

            const TInt64 aSlpId, 

            TDes& aIapName

    ) const;

    /**

     * This method is used to change manufacturer in server parameters. Manufacturer name 

     * refers to the service provider who is providing SUPL service. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aManufacturer Manufacture name.  This can have maximum size of 100 characters. 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if manufacturer name is empty or if the SLP ID passed is not valid 

     */

    TInt SetManufacturerName( 

            const TInt64 aSlpId, 

            const TDesC& aManufacturer

    );

    /**

     * This method is used to retrieve manufacturer name in server parameters. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be retrieved 

     * @param [OUT] aManufacturer Manufacture name.  This can have maximum size of 100 characters. 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetManufacturerName( 

            const TInt64 aSlpId, 

            TDes& aManufacturerName

    ) const;

    /**

     * This method is used to change timestamp when the HSLP was used last time. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aTime Time stamp 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt SetLastUseTime( 

            const TInt64 aSlpId, 

            const TTime aTime 

    );

    /**

     * This method is used to retrieve timestamp when the SLP was used last time. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be retrieved 

     * @param [OUT] aTime Time stamp 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetLastUseTime( 

            const TInt64 aSlpId, 

            TTime& aTime 

    ) const;

    /**

     * This method is used to change timestamp when the HSLP was used tried last time. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aTime Time stamp 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt SetLastTriedTime( 

            const TInt64 aSlpId, 

            const TTime aTime 

    );

    /**

     * This method is used to retrieve timestamp when the HSLP was used tried last time. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be retrieved 

     * @param [OUT] aTime Time stamp 

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetLastTriedTime( 

            const TInt64 aSlpId, 

            TTime& aTime 

    ) const;

    /**

     * This method is used to change network information when the SUPL session was last done.

     * The SUPL session could be sucessful one or failed one. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aNetType The network type 

     * @param [IN] aMcc Mobile country code.  It can have value from 0 to 999 

     * @param [IN] aMnc Mobile network code.  It can have value from 0 to 999 

     * @param [IN] aCid Cell Identity.  It can have value from 0 to 65535 if aNetType is GSM or

     * it can have value from 0 to 268435455 if aNetType is WCDMA 

     * @param [IN] aLac Location Aread Code. This parameter is written to settings only if aNetType is GSM.

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if the SLP ID passed is not valid or any of the parameters passed is not in range 

     */

    TInt SetNetInfoLastUse( 

            const TInt64 aSlpId, 

            const CSuplSettingsInternal::TSuplSettingsNetworkType aNetType,

            const TInt aMcc,

            const TInt aMnc,

            const TInt aCid, 

            const TInt aLac=0

    );

    /**

     * This method is used to retrieve network information when the SUPL session was last done.

     * The SUPL session could be sucessful one or failed one. 

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be retrieved 

     * @param [OUT] aNetType The network type 

     * @param [OUT] aMcc Mobile country code.  It can have value from 0 to 999 

     * @param [OUT] aMnc Mobile network code.  It can have value from 0 to 999 

     * @param [OUT] aCid Cell Identity.  It can have value from 0 to 65535 if aNetType is GSM or

     * it can have value from 0 to 268435455 if aNetType is WCDMA 

     * @param [OUT] aLac Location Aread Code. This parameter is written to settings only if aNetType is GSM.

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrArgument if the SLP ID passed is not valid 

     */

    TInt GetNetInfoLastUse( 

            const TInt64 aSlpId, 

            CSuplSettingsInternal::TSuplSettingsNetworkType& aNetType,

            TInt& aMcc,

            TInt& aMnc,

            TInt& aCid, 

            TInt& aLac

    ) const;

    /**

     * This method is used to change network information when the SUPL session was last done sucessfully.

     *

     * @since S60 9.1TB 

     *

     * @param [IN] aSlpId SLP ID for which the parameter needs to be changed 

     * @param [IN] aNetType The network type 

     * @param [IN] aMcc Mobile country code.  It can have value from 0 to 999 

     * @param [IN] aMnc Mobile network code.  It can have value from 0 to 999 

     * @param [IN] aCid Cell Identity.  It can have value from 0 to 65535 if aNetType is GSM or

     * it can have value from 0 to 268435455 if aNetType is WCDMA 

     * @param [IN] aLac Location Aread Code. This parameter is written to settings only if aNetType is GSM.

     * @return one of the following error codes: 

     *         - KErrNone if SUPL settings are changed successfully.  

     *         - KErrNotReady if this method is invoked before invoked before @ref LockSettingsL()

     *         - KErrArgument if the SLP ID passed is not valid or any of the parameters passed is not in range 

     */

    TInt SetNetInfoLastSucess(