// Copyright (c) 2008-2009 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:

// Internal implentation of the LBS Host Settings Interface

// 

//

/**

 @file

 @internalAll

 @deprecated 

*/

#include <e32base.h>

#include <centralrepository.h>

#include <e32debug.h>

#include <lbs/lbshostsettingsclasstypes.h>

#include <lbs/lbshostsettings.h>

#include "lbshostsettingsconsts.h"

#include "lbshostsettingsimpl.h"

#include "lbshostsettingsnotifier.h"

const TInt KFormattedDateSize = 22;

_LIT(KDateFormat,"%3%2%1%:1%H%T%S%.%C");

/**

Provides a seamless interface to the Central Repository.

The uniqueness of each key will be achieved by storing a key in the 

table, which in effect is a counter that represents the next key to

be used and that is incremented each time a group of settings is added

in the table. 

The group of settings associated with a SUPL account will be stored separately

in the Central Repository instead of storing them as one record. The last 24 bits 

of the 32-bit key will be used to represent a general key and we will vary the first 

8 bits to represent each particular setting. They could then be read back by masking 

those bits. The top 8 bits are defined in TLbsHostSettingRecordType.   

For example:

If the setting id is 4 then the associated record keys will be:

CreatorId(0x1):        0x10000004

ConnectionId(0x2):     0x20000004

ConnectionIdType(0x3): 0x30000004

HostAddress(0x4):      0x40000004

etc...

There is a reserved range of keys used for storing metadata values where the upper 4 bits 

are set to record type EMetaData and the bottom 28 bits are defined by 

TLbsHostSettingMetaRecordTypes. e.g:

NextKey(0x1):     0x00000001

DefaultHost(0x2): 0x00000002 

This class also offers the ability to update a group of settings associated

with an account, to set a particular account as default, to iterate over settings

and finally to delete them.

@see CRepository

@see CLbsHostSettingsStore 

*/

class CLbsHostSettingsStoreImpl : public CBase, public MLbsHostSettingsStoreImpl

	{

public:

	static CLbsHostSettingsStoreImpl* NewL(TLbsHostStoreId aStoreId, MLbsHostSettingsStoreObserver* aObserver);

	TInt CreateHostSettings(const TLbsHostSettingsBase& aSettings, TLbsHostCreatorId aCreatorId, TLbsHostSettingsId& aSettingsId);

	TInt UpdateHostSettings(TLbsHostSettingsId aSettingsId, const TLbsHostSettingsBase& aSettings);

	TInt GetHostSettings(TLbsHostSettingsId aSettingsId, TLbsHostSettingsBase& aSettings) const;

	TInt RewindHostSettings();

	TInt GetNextHostSettings(TLbsHostSettingsBase& aSettings, TLbsHostSettingsId& aSettingsId);

	TInt GetNextHostSettingsByCreator(TLbsHostCreatorId aCreator, TLbsHostSettingsBase& aSettings, TLbsHostSettingsId& aSettingsId);

	TInt SetDefaultHostSettings(TLbsHostSettingsId aSettingsId);

	TInt GetDefaultHostSettings(TLbsHostSettingsBase& aSettings, TLbsHostSettingsId& aSettingsId) const;

	TInt DeleteHostSettings(TLbsHostSettingsId aSettingsId);

	~CLbsHostSettingsStoreImpl();

protected:

	CLbsHostSettingsStoreImpl();

	void ConstructL(TLbsHostStoreId aStoreId, MLbsHostSettingsStoreObserver* aObserver);

private:

	TInt GetSettingNumber(const TUint32 aKey) const;

	TUint32 CreateKey(const TLbsHostSettingRecordType aRecordType, const TUint32 aSettingNumber) const;

	TInt UpdateTimestamp(TLbsHostSettingsId aSettingsId) const;

	TInt ValidateHostSettings(const TLbsHostSettingsSupl& aSettings) const;

	CRepository* 					iRepository;

	CLbsHostSettingsNotifier*		iStoreNotifier;

	// structure to hold setting addresses and 

	// creator ids

	struct TIdCreatorPair

		{

	    TInt iSettingId;

	    TUid iCreator;	   	

		};

	RArray<TIdCreatorPair> iCurrentView;	

	TInt iIterator;

	};

//=============================================================================

// CLbsHostSettingsStore::ConstructL()

//=============================================================================

/**

Creates and assigns the internal resources required by the data store

library.

@param aStoreId Specifies which host settings store to utilise.

@param aObserver If non NULL, the observer receives notifications about

updates to store specified by aStoreId.

@internalComponent

*/  

void CLbsHostSettingsStore::ConstructL(TLbsHostStoreId aStoreId, MLbsHostSettingsStoreObserver* aObserver)

	{

	iImplementation = CLbsHostSettingsStoreImpl::NewL(aStoreId, aObserver);

	iSettingsStore = iImplementation;

	}

/**

Closes the connection to the host settings store and disposes of all open

or used resources.

@deprecated

*/  

EXPORT_C CLbsHostSettingsStore::~CLbsHostSettingsStore()

	{

	delete iImplementation;

	iImplementation = NULL;

	}

//=============================================================================

// CLbsHostSettingsStoreImpl

//=============================================================================

CLbsHostSettingsStoreImpl::~CLbsHostSettingsStoreImpl()

	{

	iCurrentView.Close();

	delete iStoreNotifier;

	delete iRepository;

	}

/**

Creates a new connection to the host settings stored for the specified protocol

*/  

CLbsHostSettingsStoreImpl* CLbsHostSettingsStoreImpl::NewL(TLbsHostStoreId aStoreId, MLbsHostSettingsStoreObserver* aObserver)

	{

	CLbsHostSettingsStoreImpl* self = new (ELeave) CLbsHostSettingsStoreImpl();

	CleanupStack::PushL(self);

	self->ConstructL(aStoreId, aObserver);

	CleanupStack::Pop(self);

	return self;

	}

/**

Default constructor for the settings store.

*/  

CLbsHostSettingsStoreImpl::CLbsHostSettingsStoreImpl(): iIterator(KErrNotFound)

	{

	}

void CLbsHostSettingsStoreImpl::ConstructL(TLbsHostStoreId aStoreId, MLbsHostSettingsStoreObserver* aObserver)

	{

	iRepository = CRepository::NewL(aStoreId);

	// Create and start notifier if an observer exists

	if (aObserver)

		{

		iStoreNotifier = CLbsHostSettingsNotifier::NewL(aStoreId, *iRepository, aObserver);

		iStoreNotifier->RequestNotificationL();

		}

	}

/**

Resets the client's view of the data store.

@see CLbsHostSettingsStore::RewindHostSettings

*/  

TInt CLbsHostSettingsStoreImpl::RewindHostSettings()

	{

	// set iterator to -1

	// clear structure

	iIterator = KErrNotFound;

	iCurrentView.Reset();

	// rebuild our data structure

	RArray<TUint32> foundKeys; //method is non-leaving so no need to put this on the CUS

	const TUint32 KSettingNumberMask = 0;

	const TUint32 KPartialKey = CreateKey(ECreatorId, KSettingNumberMask); 

	// Find all the Creator id keys in the store so that we can generate a list of setting ids.

	TRAPD(err, err = iRepository->FindL(KPartialKey, KRecordTypeMask, foundKeys));

	if(err == KErrNone)

		{

		for(TInt i = 0, x = foundKeys.Count(); i < x; i++)

			{		

			// retrieve the CreatorId values foreach key	

			TInt creatorId;

			TIdCreatorPair keyPair;	

			err = iRepository->Get(foundKeys[i], creatorId);		

			if(err != KErrNone)

				{

				break;

				}

			// now add pair to structure

			// convert creatorValue to TUid for convenience

			keyPair.iSettingId = GetSettingNumber(foundKeys[i]);

			keyPair.iCreator = TUid::Uid(creatorId);

			err = iCurrentView.Append(keyPair);

			if(err != KErrNone)

				{

				break;

				}

			}

		}

	foundKeys.Close();

	return err;

	}

/**

Retrieves the settings for a particular host settings ID.

@see CLbsHostSettingsStore::GetHostSettings

*/  

TInt CLbsHostSettingsStoreImpl::GetHostSettings(TLbsHostSettingsId aSettingsId,	TLbsHostSettingsBase& aSettings) const

	{

	ASSERT(aSettingsId.iUid >= 0);

	if((aSettings.ClassType() & ELbsHostSettingsSuplClass))

		{

		TLbsHostSettingsSupl& tgt = (TLbsHostSettingsSupl&)aSettings;

		// Set the settings id

		tgt.SetHostSettingsId(aSettingsId);

		// Get the creator id

		TInt creatorId;

		TUint32 creatorIdKey = CreateKey(ECreatorId, aSettingsId.iUid);

		TInt err = iRepository->Get(creatorIdKey, creatorId);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetCreatorId(TUid::Uid(creatorId));

		// Get the connection id

		TInt connectionId;

		TUint32 connectionIdKey = CreateKey(EConnectionId, aSettingsId.iUid);

		err = iRepository->Get(connectionIdKey, connectionId);

		if(err != KErrNone)

			{

			return err;

			}

		// Get the connection id type

		TInt connectionIdType;

		TUint32 connectionIdTypeKey = CreateKey(EConnectionIdType, aSettingsId.iUid);

		err = iRepository->Get(connectionIdTypeKey, connectionIdType);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetConnectionPoint(connectionId, static_cast<TLbsHostSettingsSupl::TLbsConnectionType>(connectionIdType));

		// Get the host address

		TLbsHostNameAddress hostAddr;

		TUint32 hostAddrKey = CreateKey(EHostAddress, aSettingsId.iUid);

		err = iRepository->Get(hostAddrKey, hostAddr);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetHostNameAddress(hostAddr);

		// Get the read only flag

		TBool readOnly;

		TUint32 readOnlyKey = CreateKey(EReadOnly, aSettingsId.iUid);

		err = iRepository->Get(readOnlyKey, readOnly);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetReadOnly(readOnly);

		// Get the name

		TLbsHostName hostName;

		TUint32 hostNameKey = CreateKey(EHostName, aSettingsId.iUid);

		err = iRepository->Get(hostNameKey, hostName);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetName(hostName);

		// Get the port id

		TInt portId;

		TUint32 portIdKey = CreateKey(EHostPort, aSettingsId.iUid);

		err = iRepository->Get(portIdKey, portId);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetPortId(portId);

		// Get the providerId

		TLbsProviderId providerId;

		TUint32 providerIdKey = CreateKey(EProviderId, aSettingsId.iUid);

		err = iRepository->Get(providerIdKey, providerId);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetProviderId(providerId);

		// Get the MOLR auth modes

		TInt authmolr;

		TUint32 authmolrKey = CreateKey(EAuthMoLr, aSettingsId.iUid);

		err = iRepository->Get(authmolrKey, authmolr);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetAuthModesMOLR(authmolr);

		// Get the MTLR auth modes

		TInt authmtlr;

		TUint32 authmtlrKey = CreateKey(EAuthMtLr, aSettingsId.iUid);

		err = iRepository->Get(authmtlrKey, authmtlr);

		if(err != KErrNone)

			{

			return err;

			}

		tgt.SetAuthModesMTLR(authmtlr);

		//Get the last modified timestamp

		TBuf16<KFormattedDateSize> lastMod;

		TUint32 lastModKey = CreateKey(ETimestamp, aSettingsId.iUid);

		err = iRepository->Get(lastModKey, lastMod);

		if(err != KErrNone)

			{

			return err;

			}

		TRAP(err, tgt.SetLastModifiedL(lastMod));

		if(err != KErrNone)

			{

			return err;

			}

		return KErrNone;

		}

	return KErrArgument;

	}

/**

Retrieves the next host settings following on from the specified host

setttings ID.

@see CLbsHostSettingsStore::GetNextHostSettings

*/  

TInt CLbsHostSettingsStoreImpl::GetNextHostSettings(TLbsHostSettingsBase& aSettings, TLbsHostSettingsId& aSettingsId)

	{

	if((aSettings.ClassType() & ELbsHostSettingsSuplClass))

		{

		++iIterator;

		// check if we have reached end of iteration

		// return KErrNotFound

		// this also implies that we need to have called RewindHostSettings

		// in order to use this method

		if(iIterator >= iCurrentView.Count())

			{

			return KErrNotFound;

			}

		TIdCreatorPair currentPair = iCurrentView[iIterator];

		aSettingsId.iUid = currentPair.iSettingId;

		return GetHostSettings(aSettingsId, aSettings);

		}

	return KErrArgument;

	}

/**

Retrieves the next host settings that was provisioned by the specified

creator.

@see CLbsHostSettingsStore::GetNextHostSettingsByCreator

*/  

TInt CLbsHostSettingsStoreImpl::GetNextHostSettingsByCreator(TLbsHostCreatorId aCreator, TLbsHostSettingsBase& aSettings, TLbsHostSettingsId& aSettingsId)

	{

	ASSERT(aCreator.iUid >= 0);

	if((aSettings.ClassType() & ELbsHostSettingsSuplClass))

		{

		TIdCreatorPair currentPair;	

		for(;;) 

			{							

			++iIterator;

			// check if we have reached end of iteration

			// return KErrNotFound		

			if(iIterator >= iCurrentView.Count())

				{

				return KErrNotFound;

				}

			currentPair = iCurrentView[iIterator];

			// do we have the right creator id?

			if(aCreator == currentPair.iCreator)

				{

				break;

				}			

			}

		// at this stage we have the right creator

		// just return setting

		aSettingsId.iUid = currentPair.iSettingId;

		return GetHostSettings(aSettingsId, aSettings);

		}

	return KErrArgument;

	}

/**

Replaces the settings for an existing host settings entry in the data store.

@see CLbsHostSettingsStore::UpdateHostSettings

*/  

TInt CLbsHostSettingsStoreImpl::UpdateHostSettings(TLbsHostSettingsId aSettingsId, const TLbsHostSettingsBase& aSettings)

	{

	ASSERT(aSettingsId.iUid >= 0);

	if((aSettings.ClassType() & ELbsHostSettingsSuplClass))

		{

		//cast aSettings to a type we can use

		const TLbsHostSettingsSupl& src = reinterpret_cast<const TLbsHostSettingsSupl&>(aSettings);

		TInt err = ValidateHostSettings(src);

		if(err != KErrNone)

			{

			return err;

			}

		// Check the setting exists by getting the creator Id

		TInt creatorId;

		TUint32 creatorIdKey = CreateKey(ECreatorId, aSettingsId.iUid);

		err = iRepository->Get(creatorIdKey, creatorId);

		if(err != KErrNone)

			{

			return err;

			}

		//set connectionId & type

		TInt connectionId;

		TLbsHostSettingsSupl::TLbsConnectionType connectionIdType;

		src.GetConnectionPoint(connectionId, connectionIdType);

		TUint32 connectionIdKey = CreateKey(EConnectionId, aSettingsId.iUid);

		err = iRepository->Set(connectionIdKey, connectionId);

		if(err != KErrNone)

			{

			return err;

			}

		TUint32 connectionIdTypeKey = CreateKey(EConnectionIdType, aSettingsId.iUid);

		err = iRepository->Set(connectionIdTypeKey, connectionIdType);

		if(err != KErrNone)

			{

			return err;

			}

		//set hostAddr

		TLbsHostNameAddress hostAddr;

		TInt hostAddrKey = CreateKey(EHostAddress, aSettingsId.iUid);

		src.GetHostNameAddress(hostAddr);

		err = iRepository->Set(hostAddrKey, hostAddr);

		if(err != KErrNone)

			{

			return err;

			}

		// set read only

		TBool readOnly;

		TUint32 readOnlyKey = CreateKey(EReadOnly, aSettingsId.iUid);

		src.GetReadOnly(readOnly);

		err = iRepository->Set(readOnlyKey, readOnly);

		if(err != KErrNone)

			{

			return err;

			}

		//set hostName

		TLbsHostName hostName;

		TInt hostNameKey = CreateKey(EHostName, aSettingsId.iUid);

		src.GetName(hostName);

		err = iRepository->Set(hostNameKey, hostName);

		if(err != KErrNone)

			{

			return err;

			}

		//set port id

		TInt portId;

		TUint32 portIdKey = CreateKey(EHostPort, aSettingsId.iUid);

		src.GetPortId(portId);

		err = iRepository->Set(portIdKey, portId);

		if(err != KErrNone)

			{

			return err;

			}

		//set providerId setting

		TLbsProviderId providerId;

		TInt providerIdKey = CreateKey(EProviderId, aSettingsId.iUid);

		src.GetProviderId(providerId);

		err = iRepository->Set(providerIdKey, providerId);

		if(err != KErrNone)

			{

			return err;

			}