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

// Table definitions and CCommsDatabase definitions

// 

//

/**

 @file

 @deprecated since v9.1. Functionality is replaced with commsdat.

*/

#include <e32math.h>

#include <f32file.h>

#include <cdbpreftable.h>

#include <e32property.h>

#include "CDBSTD.H"

#include "Commsdat_Log.h"

#include "commdb_impl.H"

#include <commsdattypesv1_1.h>

#include <commsdat_partner.h>

#include <commsdatutils.h>

using namespace CommsDat;

using namespace CommsDatUtils;

const TInt KGlobalSettingsRecordID = 1;

// TCommDbPublishSubscribeNotification definitions

CCommsDatabaseBase::

			TCommDbPublishSubscribeNotification::TCommDbPublishSubscribeNotification()

	: iUid(KNullUid), iValue(0)

/**

Default Constructor for the publish and susbcribe notificaton which initialises the Uid to zero.

*/

	{

	}

void CCommsDatabaseBase::

			TCommDbPublishSubscribeNotification::Set(TUid aUid,TInt aVal)

/**

Sets the given values of aUid and aVal to the members iUid and aVal.

@param aUid UID to be set

@param aVal Value to be set

*/

	{

	iUid=aUid;

	iValue=aVal;

	}

// TCommDbSystemAgentNotification definitions

// we still support this class from 9.0 onwards, but to work with pubsub its initialisation

// changes

CCommsDatabaseBase::

			TCommDbSystemAgentNotification::TCommDbSystemAgentNotification()

	: iUid(KNullUid), iValue(0)

/**

Default Constructor for the publish and subscribe notification with the old System Agent

name for compatibility which initialises the Uid to zero.

*/

	{

	}

void CCommsDatabaseBase::

			TCommDbSystemAgentNotification::Set(TUid aUid,TInt aVal)

/**

Sets the given values of aUid and aVal to the members iUid and aVal.

@param aUid UID to be set

@param aVal Value to be set

*/

	{

	iUid=aUid;

	iValue=aVal;

	}

// CCommsDatabaseBase definitions

EXPORT_C CCommsDatabaseBase::CCommsDatabaseBase():	iImplNotCreated(EFalse)

/** Default constructor for internal use only. */

	{

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("CCommsDatabaseBase::CCommsDatabaseBase()"));

	TRAPD(err,iImpl = new(ELeave) CCommsDatabaseImpl());

	if(err != KErrNone)

		{

		iImplNotCreated = ETrue;

		__FLOG_STATIC1(KLogComponent, KCommDbShim, _L("Creation of implementation class for CCommsDatabaseBase faild with Err:%d"),err);

		}

	}

EXPORT_C CCommsDatabaseBase::~CCommsDatabaseBase()

	{

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("CCommsDatabaseBase::~CCommsDatabaseBase()"));

	delete iImpl;

	}

EXPORT_C TVersion CCommsDatabaseBase::Version() const

/** Gets the version from CommsDat.

@return The object containing the version information. */

	{

	if (iImplNotCreated)

		{

		__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("Warning!!! - > Implementation object is not created at this point"));

		// return the most likely value

		return KCDVersion1_1;

		}

	TVersion versionInUse;

	versionInUse = iImpl->iDbs->VersionInUse();

	__FLOG_STMT(TPtrC name = versionInUse.Name();)

	__FLOG_STATIC1(KLogComponent, KCommDbShim, _L("Version() - > Version Number %S"), &name);

	return versionInUse;

	}

EXPORT_C TInt CCommsDatabaseBase::BeginTransaction()

/** Marks the start of a transaction and gets a shared read-lock on the database.

Other clients of the database can concurrently acquire a shared read-lock

but no client can gain an exclusive write-lock until this transaction (and

any transaction started by other clients) completes as a result of a call

to either CommitTransaction() or RollbackTransaction().

A transaction consists of one or more record updates and/or insertions and/or

deletions. The process of making changes to records within a view is part

of CCommsDbTableView behaviour.

@see CCommsDbTableView::InsertRecord(), CCommsDbTableView::UpdateRecord(),

CCommsDbTableView::DeleteRecord(), CCommsDbTableView::PutRecordChanges()

and CCommsDbTableView::CancelRecordChanges().

@return KErrNone if the database has been successfully locked; the transaction

can start. KErrLocked if another client already has an exclusive write-lock

on the database.

@capability Dependent on table, see the guide page referenced below. */

	{

	if(iImplNotCreated)

		{

		return KErrNoMemory;

		}

	TRAPD(err, iImpl->iDbs->OpenTransactionL());

	__FLOG_STATIC1(KLogComponent, KCommDbShim, _L("BeginTransaction Err:%d"),err);

	return err;

	}

EXPORT_C TInt CCommsDatabaseBase::CommitTransaction()

/** Marks the end of a transaction and commits any changes made since the start

of the transaction. The client's shared read-lock is removed if no write operations

were performed, or the exclusive write-lock is removed if write operations

were performed.

@return KErrNone if successful, otherwise another of the system-wide error

codes.

@capability Dependent on table, see the guide page referenced below. */

	{

	if(iImplNotCreated)

		{

		return KErrNoMemory;

		}

	TInt i(0);

	TInt err(KErrNone);

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("CommitTransaction Entry Point"));

	TRAP(err, iImpl->iDbs->CommitTransactionL());

    if(err == KErrNone)

        {

        // update client side transaction logic in views

        TInt count = iImpl->iTableViews.Count();

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

            {

            iImpl->iTableViews[i]->iTableExt->CommitTransaction();

            }

        count = iImpl->iConnPrefViews.Count();

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

            {

            iImpl->iConnPrefViews[i]->iTableExt->CommitTransaction();

            }

        }

	__FLOG_STATIC1(KLogComponent, KCommDbShim, _L("CommitTransaction Err:%d"),err);

	return err;

	}

EXPORT_C void CCommsDatabaseBase::RollbackTransaction()

/** Marks the end of a transaction and abandons any changes made since the start

of the transaction. The database is, in effect, rolled back to the state it

was in at the beginning of the transaction. The client's shared read-lock

is removed if no write operations were performed, or the exclusive write-lock

is removed if write operations were performed.

@capability Dependent on table, see the guide page referenced below. */

	{

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("RollbackTransaction Entry Point"));

	TInt err(KErrNone);

	if(iImplNotCreated)

		{

		return;

		}

    TRAP(err, iImpl->iDbs->RollbackTransactionL());

    if (err != KErrNone)

        {

        __FLOG_STATIC1(KLogComponent, KCommDbShim, _L("RollbackTransaction failed in commsdat Err:%d"),err);

        }

		// update client side transaction logic in views

		TInt count = iImpl->iTableViews.Count();

		TInt i;

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

			{

			iImpl->iTableViews[i]->iTableExt->RollBackTransaction();

			}

		count = iImpl->iConnPrefViews.Count();

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

			{

			iImpl->iConnPrefViews[i]->iTableExt->RollBackTransaction();

			}

    }

EXPORT_C TBool CCommsDatabaseBase::InTransaction()

/** Tests whether a transaction is in progress, i.e. whether a call to BeginTransaction()

has been called.

@return ETrue if a transaction is in progress (BeginTransaction() has been called but not

CommitTransaction() or RollbackTransaction()); EFalse otherwise. */

	{

	if(iImplNotCreated)

		{

		return EFalse;

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("InTransaction"));

	return iImpl->iDbs->IsInTransaction();

	}

EXPORT_C TBool CCommsDatabaseBase::IsDatabaseWriteLockedL()

/** Tests if the database is write locked.

Tries to open a transaction from another client.

@note Calling InTransaction() is not enough because if the transaction is automatic rather than

explicit, this will still return EFalse.

@return ETrue if the database is write locked, EFalse if not. */

	{

	if(iImplNotCreated)

		{

		User::Leave(KErrNoMemory);

		}

	TBool result = iImpl->iDbs->IsInTransaction();

	__FLOG_STATIC1(KLogComponent, KCommDbShim, _L("IsDatabaseWriteLockedL -> Result:%b"), result);

	return result;

	}

EXPORT_C void CCommsDatabaseBase::ShowHiddenRecords()

/** Ensures that hidden records are included in the search criteria when creating

views using the member functions:

OpenTableLC()

OpenViewMatchingUintLC()

OpenViewMatchingBoolLC()

OpenViewMatchingTextLC()

@capability Dependent on table, see the guide page referenced below. */

	{

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("ShowHiddenRecords"));

	iShowHiddenRecords = ETrue;

	// Set mask for hidden Attribute on CommsDat session

    iImpl->iDbs->SetAttributeMask(ECDHidden);

	}

EXPORT_C TInt CCommsDatabaseBase::RequestNotification(TRequestStatus& aStatus)

/** Requests notification when any change is made to the database, whether by this

client or any other.

(If the notifier is not successfully opened the function simply returns an error

code and none of the following applies).

When any change is made to the database the outstanding notification request

completes and TRequestStatus contains a value indicating what type of change

has occurred. The value is one of the enumerators of the RDbNotifier::TEvent

enumeration.

Alternatively, if an outstanding notification request is cancelled by a call

to this CCommsDatabase's CancelRequestNotification() member function, then

the request completes with aStatus set to KErrCancel.

An outstanding notification request is also cancelled if the connection to

the DBMS is severed through a call to DoClose().

This is an asynchonous request.

@param aStatus A reference to the request status object. If the request is

cancelled, this is set to KErrCancel. If the request completes normally, this

is set to one of the enumerators of the RDbNotifier::TEvent enumeration.

@return Any error from opening the notifier: KErrNone if successful, otherwise

another of the system-wide error codes. */

	{

	if(iImplNotCreated)

		{

		return KErrNoMemory;

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("CCommsDatabaseBase::RequestNotification(TRequestStatus& aStatus)"));

	return iImpl->RequestNotification(aStatus);

	}

EXPORT_C void CCommsDatabaseBase::CancelRequestNotification()

/** Cancels an outstanding request for notification of changes to the communications

database.

An outstanding request completes with KErrCancel. */

	{

	if(iImplNotCreated)

		{

		return;

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("CCommsDatabaseBase::CancelRequestNotification()"));

	iImpl->CancelRequestNotification();

	}

EXPORT_C CCommsDbTableView* CCommsDatabaseBase::OpenTableLC(const TDesC& aTableName)

/** Fills the container with all records from table and returns a pointer to view class. The view

excludes hidden records, unless access to them has previously been explicitly

requested by calling the ShowHiddenRecords() member function of this object.

If the process is succesful, the function constructs and returns a pointer

to a CCommsDbTableView object which encapsulates the information on that view.

The pointer is also put onto the cleanup stack.

@param aTableName A reference to a descriptor containing the name of the table

in the communications database to be opened.

@return A pointer to the view object.

@capability Dependent on table, see the guide page referenced below. */

	{

	if(iImplNotCreated)

		{

		User::Leave(KErrNoMemory);

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("CCommsDatabaseBase::OpenTableLC Entry Point"));

	CCommsDbTableView* tableView = CCommsDbTableView::NewLC(*this, aTableName);

    tableView->iTableExt->SetShowHiddenRecords(iShowHiddenRecords);

	__FLOG_STATIC2(KLogComponent, KCommDbShim, _L("CCommsDatabaseBase::OpenTableLC -> TableName=%S, Hidden=%b"), &aTableName, iShowHiddenRecords);

	return tableView;

	}

EXPORT_C CCommsDbTableView* CCommsDatabaseBase::OpenViewLC(const TDesC& /*aTableName*/,const TDesC& /*aSqlQuery*/)

/**

@deprecated This method is deprecated from 9.1 and always returns/leaves with KErrNotSupported instead of describing past operation/parameters.

@param aTableName A reference to a descriptor containing the name of a table

in the communications database.

@param aSqlQuery A reference to a descriptor containing the SQL query text.

@return A pointer to the view object.

@capability Dependent on table, see the guide page referenced below. */

	{

	User::Leave(KErrNotSupported);

	return NULL;

	}

EXPORT_C CCommsDbTableView* CCommsDatabaseBase::OpenViewMatchingUintLC(const TDesC& aTableName,

																	const TDesC& aColumnToMatch,

																	TUint32 aValueToMatch)

/** Opens a view onto a specified table based on a matching unsigned integer value,

and returns a pointer to that view. The view includes all those records where

the column, identified by aColumnToMatch, matches the unsigned integer value

aValueToMatch.

The view excludes hidden records, unless access to them has previously been

explicitly requested by calling the ShowHiddenRecords() member function of

this object.

If the open process is succesful, the function constructs and returns a pointer

to a CCommsDbTableView object which encapsulates the information on that view.

The pointer is also put onto the cleanup stack.

@param aTableName A reference to a descriptor containing the name of the table

in the communications database on which a view is to be opened.

@param aColumnToMatch A reference to a descriptor containing the name of the

column to be used in the selection process.

@param aValueToMatch The value to be matched with the content of column aColumnToMatch.

@return A pointer to the view object.

@capability Dependent on table, see the guide page referenced below. */

	{

	if(iImplNotCreated)

		{

		User::Leave(KErrNoMemory);

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("OpenViewMatchingUintLC Entry Point"));

	CCommsDbTableView* table = DoOpenViewMatchingUintL(aTableName,aColumnToMatch,aValueToMatch,iShowHiddenRecords);

	CleanupStack::PushL(table);

	return table;

	}

EXPORT_C CCommsDbTableView* CCommsDatabaseBase::OpenViewMatchingBoolLC(const TDesC& aTableName,

																	const TDesC& aColumnToMatch,

																	TBool aValueToMatch)

/** Opens a view onto a specified table based on a matching boolean value, and

returns a pointer to that view. The view includes all those records where

the column, identified by aColumnToMatch, matches the boolean value aValueToMatch.

The view excludes hidden records, unless access to them has previously been

explicitly requested by calling the ShowHiddenRecords() member function.

If the open process is successful, the function constructs and returns a pointer

to a CCommsDbTableView object which encapsulates the information on that view.

The pointer is also put onto the cleanup stack.

@param aTableName A reference to a descriptor containing the name of the table of

interest in the communications database.

@param aColumnToMatch A reference to a descriptor containing the name of the

column to be used in the selection process.

@param aValueToMatch The value to be matched with the content of column aColumnToMatch.

@return A pointer to the view object.

@capability Dependent on table, see the guide page referenced below. */

	{

	if(iImplNotCreated)

		{

		User::Leave(KErrNoMemory);

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("OpenViewMatchingBoolLC Entry Point"));

	// create table

	CCommsDbTableView* tableView = CCommsDbTableView::NewLC(*this, aTableName, aColumnToMatch, aValueToMatch);

	__FLOG_STATIC3(KLogComponent, KCommDbShim, _L("OpenViewMatchingBoolLC -> TableName:%S, Column Name:%S, MatchingValue:%b"),

					&aTableName, &aColumnToMatch, aValueToMatch);

	return tableView;

	}

EXPORT_C CCommsDbTableView* CCommsDatabaseBase::OpenViewMatchingTextLC(const TDesC& aTableName,

																	const TDesC& aColumnToMatch,

																	const TDesC8& aValueToMatch)

/** Opens a view onto a specified table based on a matching 8 bit text type, and

returns a pointer to that view.

The view includes all those records where the column, identified by aColumnToMatch,

matches the narrow text supplied in the descriptor aValueToMatch.

The view excludes hidden records, unless access to them has previously been

explicitly requested by calling the ShowHiddenRecords() member function of

this object.

If the open process is succesful, the function constructs and returns a pointer

to a CCommsDbTableView object which encapsulates the information on that view.

The pointer is also put onto the cleanup stack.

@param aTableName A reference to a descriptor containing the name of a table

in the communications database.

@param aColumnToMatch A reference to a descriptor containing the name of the

column to be used in the selection process.

@param aValueToMatch The narrow (ASCII) text to be matched with the content

of column aColumnToMatch.

@return A pointer to the view object.

@capability Dependent on table, see the guide page referenced below. */

	{

	if(iImplNotCreated)

		{

		User::Leave(KErrNoMemory);

		}

	__FLOG_STATIC0(KLogComponent, KCommDbShim, _L("OpenViewMatchingTextLC Entry Point"));

	CCommsDbTableView* table = DoOpenViewMatchingTextL(aTableName,aColumnToMatch,aValueToMatch,iShowHiddenRecords);

	CleanupStack::PushL(table);

	return table;

	}

EXPORT_C CCommsDbTableView* CCommsDatabaseBase::OpenViewMatchingTextLC(const TDesC& aTableName,

																	const TDesC& aColumnToMatch,

																	const TDesC16& aValueToMatch)

/** Opens a view onto a specified table based on a matching 16 bit text type, and

returns a pointer to that view. The view includes all those records where

the column, identified by aColumnToMatch, matches the wide text supplied in

the descriptor aValueToMatch.

The view excludes hidden records, unless access to them has previously been

explicitly requested by calling the ShowHiddenRecords() member function of

this object.

If the open process is successful, the function constructs and returns a pointer

to a CCommsDbTableView object which encapsulates the information on that view.

The pointer is also put onto the cleanup stack.

@param aTableName A reference to a descriptor containing the name of a table

in the communications database.

@param aColumnToMatch A reference to a descriptor containing the name of the

column to be used in the selection process.

@param aValueToMatch The wide (UNICODE) text to be matched with the content

of column aColumnToMatch.