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

// Definitions of commdb tables and associated columns.

// 

//

/**

 @file

 @internalComponent

*/

#ifndef GLOBALDEF_H

#define GLOBALDEF_H

#include <e32base.h>

#include <e32std.h>

#include <D32Comm.h>

#include <d32dbms.h>

#include <nifvar.h>

#include <etelMm.h>

#include "t_tabdef.h"

#include "Metadatabase.h"

//#include "commsdat.h"

#include "CommsDatTypesV1_1.h"

//#include "cedtablebase.h"

//#include <centralrepository.h>

using namespace CommsDat;

// Repository for comms data

const TUid KCDCommsRepositoryId = { 0xCCCCCC00 };

#define MAX_COL_NAME_LEN		64

/*Some definitions related to the Config File*/

/**

Macro for build independent literal ADD_SECTION

*/

#define BEGIN_ADD			_L("ADD_SECTION")

/**

Macro for build independent literal ADD_SECTION

*/

#define BEGIN_TEMPLATE		_L("ADD_TEMPLATE")

/**

Macro for build independent literal ADD_ATTRIBUTE

*/

#define BEGIN_ATTRIB		_L("ADD_ATTRIBUTES")

/**

Macro for build independent literal ADD_SECTION

*/

#define BEGIN_SET			_L("SET_SECTION")

/**

Macro for build independent literal END_ADD

*/

#define END_ADD				_L("END_ADD")

/**

Macro for build independent literal END_TEMPLATE

*/

#define END_TEMPLATE		_L("END_TEMPLATE")

/**

Macro for build independent literal END_SET

*/

#define END_SET				_L("END_SET")

/**

Macro for build independent literal END_ATTRIB

*/

#define END_ATTRIB			_L("END_ATTRIBUTES")

/**

Macro for build independent literal SET_CONDITION

*/

#define CONDITION			_L("SET_CONDITION")

/**

Macro for build independent literal _TABLE

*/

#define TABLE			_L("_TABLE{")

/**

Macro for build independent literal _TABLE

*/

#define TEMPLATE		_L("_TEMPLATE{")

/**

Macro for build independent literal _TABLE

*/

#define RECORD			_L("_RECORD{")

/**

Macro for build independent literal FIELD_COUNT

*/

#define FIELD_COUNT			_L("FIELD_COUNT")

#define E_UNKNOWN			0

#define E_ADD				1

#define E_SET				2

#define E_TEMPLATE			3

#define E_ATTRIB			4

#define E_TABLE				5

#define E_TPLATE			6

#define E_RECORD			7

#define E_DATA				8

/**/

/**

access to local error strings

@internalComponent

*/

extern TPtrC errorCode[];

/**

associated default working files

*/

#define DATABASE_TARGET			_S("c:\\system\\data\\cdbv3.dat")	// physical database

/**

end of array

*/

#define NO_MORE_RECORDS			_S("NO_MORE_RECORDS")

/**

all records in table

*/

#define ALL_RECORDS				_S("ALL_RECORDS")

/**

TRUE enum

*/

#define TRUE_VAL				_S("TRUE")

/**

FALSE enum

*/

#define FALSE_VAL				_S("FALSE")

/**

empty enum

*/

#define NOTHING					_S("")

/**

max amount of column updates per table we can handle

*/

#define MAX_DB_COLUMNS			100

/**

max length for column name

*/

#define MAX_COL_NAME_LEN		64

/**

max length of column contents

*/

#define MAX_COL_VAL_LEN			96

/**

max length of long text column contents

*/

#define MAX_COL_LONG_VAL_LEN	1024

/**

max length of queries

*/

#define MAX_QUERY_LEN			256

/**

initial value for bad text that must be replaced

*/

#define BADTEXTVAL				_S("NOTHING")

/**

initial value for bad number that must be replaced

*/

#define BADNUMVAL				(unsigned long)999999

/**

local CED defines, for values not already defined by CommDB

*/

/**

list of local error codes

@internalComponent

*/

#define E_NOTENOUGHDATA		0

#define E_INVALIDCOMMAND	1

#define E_INCORRECTTYPE		2

#define E_INCORRECTCOLNAME	3

#define E_ALREADYEXISTS		4

#define E_INCORRECTENUM		5

#define E_INCORRECTAGENT	6

#define E_BADFIELDCOUNT		7

#define E_NOFIELDS			8

#define E_NOTSUPPORTED		9

#define E_INCORRECTGLOBAL	10

#define E_BADESCAPEDCHAR	11

#define E_BADHEXADECIMAL	12

/**

These names are maintained for compatibility they are deprecated

and should be replaced in code by CDB_LIT declarations

@internalComponent

*/

#define SERVER_NAME					(const TText*)_SERVER_NAME

#define GLOBAL_SETTINGS				(const TText*)_GLOBAL_SETTINGS

#define CONNECTION_PREFERENCES		(const TText*)_CONNECTION_PREFERENCES

//#define AGENT						(const TText*)_AGENT

/**

Misc table names that don't need to be public

@internalComponent

*/

#define _GLOBAL_SETTINGS			_I("GlobalSettings")

#define _CONNECTION_PREFERENCES		_I("ConnectionPreferences")

#define _ACCESS_TABLE				_I("AccessTypeTable")

/**

Columns for Access Type table

@internalComponent

*/

#define ACCESS_TYPE_TABLE		_S("AccessTypeTable")

#define TABLE_ACC_NAME			_S("TableName")

#define TABLE_ACC_TYPE			_S("AccessType")

//

// Columns for Connection Preferences table

//

/** Ranking of this connection preference.

This information is used to specify the order in which attempts at a connection should be

carried out. The highest ranking is 1 and is always attempted. If this fails, a preference

with rank 2 is then attempted, and so on. Ranking of 0 indicates that a connection

preference is only being stored and is not used for connections.

For incoming connections, CommDb limits the ranking to 0 or 1. For outgoing connection

preferences, the maximum ranking is the value in CONNECTION_ATTEMPTS field in the Global

table.

Multiple records with the same ranking (except for 0) and the same direction are not allowed.

Field type: TUint32. This field may not be left as NULL.

@internalComponent

*/

#define _CONNECT_PREF_RANKING		_I("Ranking")

/**

The direction of the connection. The directions are defined by the enum 

TCommDbConnectionDirection.

Field type: TUint32. This field may not be left as NULL.

*/

#define _CONNECT_PREF_DIRECTION		_I("Direction")

/**

The bearers that can be used for this connection. 

The bearers are defined by the enum TCommDbBearer. Values can be OR'ed together to indicate 

that either of the bearers could be used.

Field type: TUint32. This field may not be left as NULL.

*/

#define _CONNECT_PREF_BEARER_SET	_I("BearerSet")

/**

Determines whether or not the user should be prompted or warned with a dialog 

that a connection is going to be made.

The options are defined by the enum TCommDbDialogPref.

Field type: TUint32. This field may not be left as NULL.

@see TCommDbDialogPref.

*/

#define _CONNECT_PREF_DIALOG_PREF	_I("DialogPref")

/**

Identifier of a preferred IAP for this connection, if this is an IAP type database.

For ISP type databases, see the subsequent fields..

Field type: TUint32. This field may be left as NULL.

*/

#define _CONNECT_PREF_IAP			_I("IAP")

/**

Ranking of this connection preference.

This information is used to specify the order in which attempts at a connection 

should be carried out. The highest ranking is 1 and is always attempted. If 

this fails, a preference with rank 2 is then attempted, and so on. A ranking 

of 0 indicates that a connection preference is only being stored and is not 

used for connections.

For incoming connections, CommDb limits the ranking to 0 or 1. For outgoing 

connection preferences, the maximum ranking is the value in CONNECTION_ATTEMPTS 

field in the Global table.

Multiple records with the same ranking (except for 0) and the same direction 

are not allowed.

Type: TUint32. Null: no

@see CONNECTION_ATTEMPTS 

*/

#define CONNECT_PREF_RANKING		(const TText*)_CONNECT_PREF_RANKING

/** 

The direction of the connection. The directions are defined by the enum 

TCommDbConnectionDirection.

Type: TUint32. Null: no 

@see TCommDbConnectionDirection

*/

#define CONNECT_PREF_DIRECTION		(const TText*)_CONNECT_PREF_DIRECTION

/** 

The bearers that can be used for this connection.

The bearers are defined by the enum TCommDbBearer. Values can be ORed together 

to indicate that either of the bearers could be used.

Type: TUint32. Null: no

@see TCommDbBearer 

*/

#define CONNECT_PREF_BEARER_SET		(const TText*)_CONNECT_PREF_BEARER_SET

/** 

Determines whether or not the user should be should be prompted or warned with 

a dialog that a connection is going to be made. 

The options are defined by the enum TCommDbDialogPref.

Type: TUint32. Null: no

@see TCommDbDialogPref 

*/

#define CONNECT_PREF_DIALOG_PREF	(const TText*)_CONNECT_PREF_DIALOG_PREF

/** 

Identifier of the preferred IAP for this connection, if this is an IAP type database.

For ISP type databases, see the subsequent fields.

Type: TUint32. Null: yes 

*/

#define CONNECT_PREF_IAP			(const TText*)_CONNECT_PREF_IAP

/**

types of commdb table access we can have.  This is because CommDB does not have a uniform structure to it's

tables and some tables must be accessed using specialist functions(!) so we must determine this during

the processing

@internalComponent

*/

typedef enum accessType

	{

	DBUnknown = 0,

	DBPrefIn = 1,

	DBPrefOut = 2,

	DBTable = 4,

	DBInsert = 8,

	DBUpdate = 16,

	DBAgent = 32,

	DBGlobal = 64,

	DBTemplate = 128

#ifdef __COMMDB_ROHID_SUPPORT__

	,DBExtendedProcessing = 256

#endif

	} ACCESSTYPE;

/**

holds information on a particular column of a table

@internalComponent

*/

typedef struct ColAttributes

	{

	TPtrC						Name;

	TBuf<MAX_COL_LONG_VAL_LEN>	Value;

	TDbColType					Type;

	} COLATTRIBUTES;

//

// ENUMERATION ARRAYS

//

#define PROTECTEDWRITE	_S("ProtectedWrite")

#define PRIVATE			_S("Private")

#define HIDDEN			_S("Hidden")

#define PROTECTEDREAD	_S("ProtectedRead")

/**

list of values in Attributes column

@internalComponent

*/

static const TText* const ATTRIBArray[] =

	{

	HIDDEN,

	PRIVATE,

	PROTECTEDWRITE,

	PROTECTEDREAD,

	NO_MORE_RECORDS

	};

//

// COLUMN ARRAYS

// These arrays define the column names in a particular table - not in any

// particular order, but only the ones we are allowed to modify

//

/**

list of columns in IAP table

@internalComponent

*/

const TText* const IAPcolumnArray[] =

	{

	COMMDB_NAME,

	IAP_SERVICE, IAP_SERVICE_TYPE, IAP_BEARER, IAP_BEARER_TYPE,

	IAP_NETWORK, IAP_NETWORK_WEIGHTING, IAP_LOCATION,

#ifdef SYMBIAN_NETWORKING_UMTSR5

	IAP_APPSID,

#endif

	NO_MORE_RECORDS

	};

/**

list of columns in ISP OUT table

@internalComponent

*/

const TText* const ISPOUTcolumnArray[] =

	{	

#ifdef __COMMDB_ROHID_SUPPORT__

	COMMDB_READ_ONLY,

	COMMDB_HIDDEN,

#endif

	COMMDB_NAME,	

	ISP_DESCRIPTION, ISP_TYPE, ISP_DEFAULT_TEL_NUM, ISP_DIAL_RESOLUTION,

	ISP_USE_LOGIN_SCRIPT, ISP_LOGIN_SCRIPT, ISP_PROMPT_FOR_LOGIN,

	ISP_LOGIN_NAME, ISP_LOGIN_PASS, ISP_CHARGECARD, ISP_DISPLAY_PCT,

	ISP_IF_PARAMS, ISP_IF_NETWORKS, ISP_IF_PROMPT_FOR_AUTH, ISP_IF_AUTH_NAME,

	ISP_IF_AUTH_PASS, ISP_IF_AUTH_RETRIES, ISP_IF_CALLBACK_ENABLED,

	ISP_IF_CALLBACK_TYPE, ISP_IF_CALLBACK_INFO, ISP_CALLBACK_TIMEOUT,

	ISP_IP_ADDR_FROM_SERVER, ISP_IP_ADDR, ISP_IP_NETMASK, ISP_IP_GATEWAY,

	ISP_IP_DNS_ADDR_FROM_SERVER, ISP_IP_NAME_SERVER1, ISP_IP_NAME_SERVER2,

	ISP_IP6_DNS_ADDR_FROM_SERVER, ISP_IP6_NAME_SERVER1, ISP_IP6_NAME_SERVER2,

	ISP_IP_ADDR_LEASE_VALID_FROM, ISP_IP_ADDR_LEASE_VALID_TO,

	ISP_CONFIG_DAEMON_MANAGER_NAME, ISP_CONFIG_DAEMON_NAME, ISP_ENABLE_IP_HEADER_COMP, 

	ISP_ENABLE_LCP_EXTENSIONS, ISP_DISABLE_PLAIN_TEXT_AUTH,

	ISP_ENABLE_SW_COMP, ISP_BEARER_NAME, ISP_BEARER_SPEED, ISP_BEARER_CE,

	ISP_INIT_STRING, ISP_BEARER_TYPE, ISP_CHANNEL_CODING, ISP_AIUR,

	ISP_REQUESTED_TIME_SLOTS, ISP_MAXIMUM_TIME_SLOTS,

	//new column

	ISP_BEARER_SERVICE, ISP_BEARER_PROTOCOL, ISP_RLP_VERSION, ISP_IWF_TO_MS, ISP_MS_TO_IWF,

	ISP_ACK_TIMER, ISP_RETRANSMISSION_ATTEMPTS, ISP_RESEQUENCE_PERIOD, ISP_V42_COMPRESSION,

	ISP_V42_CODEWORDS, ISP_V42_MAX_LENGTH, ISP_ASYMMETRY, ISP_USER_INIT_UPGRADE, ISP_USE_EDGE,

	ISP_IF_SERVER_MODE,

	ISP_SERVICE_ENABLE_LLMNR,

	NO_MORE_RECORDS

	};

/**

list of columns in ISP IN table

@internalComponent

*/

const TText* const ISPINcolumnArray[] =

	{	

#ifdef __COMMDB_ROHID_SUPPORT__

	COMMDB_READ_ONLY,

	COMMDB_HIDDEN,

#endif

	COMMDB_NAME,	

	ISP_DESCRIPTION, ISP_TYPE,

	ISP_USE_LOGIN_SCRIPT, ISP_LOGIN_SCRIPT, ISP_AUTHENTICATION,

	ISP_IF_AUTH_RETRIES, ISP_IF_PARAMS, ISP_IF_NETWORKS,

	ISP_IP_ADDR_FROM_SERVER, ISP_IP_ADDR, ISP_IP_NETMASK, ISP_IP_GATEWAY,

	ISP_IP_DNS_ADDR_FROM_SERVER, ISP_IP_NAME_SERVER1, ISP_IP_NAME_SERVER2,

	ISP_IP6_DNS_ADDR_FROM_SERVER, ISP_IP6_NAME_SERVER1, ISP_IP6_NAME_SERVER2,

	ISP_ENABLE_IP_HEADER_COMP, ISP_ENABLE_LCP_EXTENSIONS, ISP_DISABLE_PLAIN_TEXT_AUTH,

	ISP_ENABLE_SW_COMP, ISP_BEARER_NAME, ISP_BEARER_SPEED, ISP_BEARER_CE,

	ISP_INIT_STRING, ISP_USE_EDGE,

	NO_MORE_RECORDS

	};

/**

list of columns in GPRS IN and OUT table

@internalComponent

*/

const TText* const GPRScolumnArray[] =

	{	

#ifdef __COMMDB_ROHID_SUPPORT__

	COMMDB_READ_ONLY,

	COMMDB_HIDDEN,

#endif

	COMMDB_NAME,

	GPRS_APN, GPRS_PDP_TYPE, GPRS_REQ_PRECEDENCE,