sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). sl@0: // All rights reserved. sl@0: // This component and the accompanying materials are made available sl@0: // under the terms of "Eclipse Public License v1.0" sl@0: // which accompanies this distribution, and is available sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html". sl@0: // sl@0: // Initial Contributors: sl@0: // Nokia Corporation - initial contribution. sl@0: // sl@0: // Contributors: sl@0: // sl@0: // Description: sl@0: // sl@0: sl@0: #ifndef __SQLSRVDATABASE_H__ sl@0: #define __SQLSRVDATABASE_H__ sl@0: sl@0: #include sl@0: #include //RSqlDatabase::TIsolationLevel sl@0: #include "SqlSrvSecurityMap.h" sl@0: #include "sqlite3.h" sl@0: #include "SqliteSymbian.h" //sqlite3SymbianLastOsError() sl@0: #include "SqlSrvStatementUtil.h"//Global sql statement related functions sl@0: #include "SqlSrvStrings.h" sl@0: #include "SqlSrvCollation.h" //User defined collations sl@0: #include "SqlSrvDbSysSettings.h"//TSqlDbSysSettings sl@0: #include "SqlSecurityImpl.h" //CSqlSecurityPolicy sl@0: #include "SqlUtil.h" //TSqlLikeWildcard sl@0: sl@0: //Forward declarations sl@0: class TSqlSrvFileData; sl@0: struct TSqlSrvConfigParams; sl@0: sl@0: ////////////////////////////////////////////////////////////////////////////////////////////////////// sl@0: ///////////////////////////// CSqlSrvDatabase class ///////////////////////////////////////////// sl@0: ////////////////////////////////////////////////////////////////////////////////////////////////////// sl@0: sl@0: /** sl@0: SQL database connection manager. (SQL database handle) sl@0: sl@0: CSqlSrvDatabase is a server side class which processes the client side requests for: sl@0: - creating a SQL database (CSqlSrvDatabase::Create()); sl@0: - opening an existing SQL database (CSqlSrvDatabase::Open()); sl@0: - retrieving the last SQL error message (CSqlSrvDatabase::LastErrorMessage()); sl@0: - executing 8-bit and 16-bit SQL statements (CSqlSrvDatabase::ExecL()); sl@0: - setting the transaction isolation level (CSqlSrvDatabase::SetIsolationLevelL()); sl@0: - retrieving the database security policy (CSqlSrvDatabase::SecurityPolicy()); sl@0: - attaching an existing SQL database to current connection (CSqlSrvDatabase::AttachDbL()); sl@0: - detaching previously attached SQL database from current connection (CSqlSrvDatabase::DetachDbL()); sl@0: sl@0: CSqlSrvDatabase class also manages all platform security related activities for secure databases: sl@0: - loading/storing database security policies when creating/opening a database connection; sl@0: - asserting client rights to perform a specific database operation; sl@0: - maintaining security related internal data structures in tact; sl@0: sl@0: @see CSqlSrvDatabase::Create() sl@0: @see CSqlSrvDatabase::Open() sl@0: @see CSqlSrvDatabase::LastErrorMessage() sl@0: @see CSqlSrvDatabase::ExecL() sl@0: @see CSqlSrvDatabase::SetIsolationLevelL() sl@0: @see CSqlSrvDatabase::SecurityPolicy() sl@0: @see CSqlSrvDatabase::AttachDbL() sl@0: @see CSqlSrvDatabase::DetachDbL() sl@0: @see CSqlSrvDatabase::LastChangesCount() sl@0: sl@0: @internalComponent sl@0: */ sl@0: NONSHARABLE_CLASS(CSqlSrvDatabase) : public CBase sl@0: { sl@0: public: sl@0: //Object creation methods sl@0: static CSqlSrvDatabase* CreateSecureL(const TSqlSrvFileData& aFileData, CSqlSecurityPolicy* aSecurityPolicy); sl@0: static CSqlSrvDatabase* CreateL(const TSqlSrvFileData& aFileData); sl@0: static CSqlSrvDatabase* OpenL(const TSqlSrvFileData& aFileData); sl@0: virtual ~CSqlSrvDatabase(); sl@0: //Interface methods sl@0: inline TPtrC LastErrorMessage() const; sl@0: inline void ExecL(TDes16& aSqlStmt); sl@0: inline void ExecL(const TDesC8& aSqlStmt); sl@0: inline void SetIsolationLevelL(RSqlDatabase::TIsolationLevel aLevel); sl@0: inline sqlite3* RawDbHandle() const; sl@0: inline const CSqlSecurityPolicy* SecurityPolicy() const; sl@0: void AttachDbL(const TSqlSrvFileData& aFileData, const TDesC& aDbName); sl@0: void DetachDbL(const TDesC& aDbName); sl@0: inline TInt LastChangesCount(); sl@0: inline TInt64 LastInsertedRowId(); sl@0: inline TBool InTransaction() const; sl@0: TInt64 SizeL(const TDesC& aDbName = KNullDesC); sl@0: TInt64 FreeSpaceL(const TDesC& aDbName = KNullDesC); sl@0: void QueryConfigL(TDes8& aDest); sl@0: TInt CompactL(TInt aSize, const TDesC& aDbName = KNullDesC); sl@0: static TInt AuthorizeCallback(void* aDb, TInt aDbOpType, sl@0: const char* aDbObjName1, const char* aDbObjName2, sl@0: const char* aDbName, const char* aTrgOrViewName); sl@0: sl@0: private: sl@0: CSqlSrvDatabase(); sl@0: void CreateNewDbFileL(const TSqlSrvFileData& aFileData); sl@0: void OpenExistingDbFileL(const TSqlSrvFileData& aFileData); sl@0: void InstallAuthorizerL(); sl@0: inline void InstallCollationsL(); sl@0: void InstallUDFsL(); sl@0: const TUint8* SecurityMapKeyL(const TDesC& aDbFileName); sl@0: void UpdateSecurityMapL(TBool aAttachedDb, const TSqlSrvFileData& aFileData, sl@0: const TUint8*& aMapKey, const CSqlSecurityPolicy*& aSecurityPolicy); sl@0: void RemoveFromMapsL(const TDesC& aDbName); sl@0: void InsertInAttachDbMapL(const TDesC& aDbFileName, const TDesC& aDbName); sl@0: void InitAttachedDbL(const TSqlSrvFileData& aFileData, const TDesC& aDbName); sl@0: TInt FinalizeAttachedDb(const TDesC& aDbName); sl@0: static void AttachCleanup(void* aCleanup); sl@0: enum TAttachState {EAStNone, EAStDbAttached, EAStSecurityMapUpdated}; sl@0: void DoAttachSecureDbL(TAttachState& aState, const TSqlSrvFileData& aFileData, const TDesC& aDbName, const TUint8*& aMapKey); sl@0: inline void BasicSecurityPolicyCheckL(const CSqlSecurityPolicy& aSecurityPolicy); sl@0: inline void StoreSettingsL(const TDesC& aCollationDllName, TInt aDbConfigFileVersion, TSqlCompactionMode aCompactionMode); sl@0: void ProcessSettingsL(const TSqlSrvFileData& aFileData, const TDesC& aDbName); sl@0: void ApplyConfigUpdatesL(const TDesC& aStoredCollationDllName, const TInt& aStoredDbConfigFileVersion, sl@0: const TSqlSrvFileData& aFileData, const TDesC& aDbName); sl@0: void SetConfigL(const TSqlSrvConfigParams& aConfigParams, TBool aSetPageSize, const TDesC& aLogicalDbName = KNullDesC); sl@0: void InitCompactionL(TSqlCompactionMode aCompactionMode, TInt aFreePageThresholdKb, sl@0: const TDesC& aDbFileName, TSqliteVacuumMode aCurrentVacuumMode, const TDesC& aDbName = KMainDb16); sl@0: void NewCompactEntryL(TInt aFreePageThresholdKb, const TDesC& aDbFileName, const TDesC& aDbName); sl@0: void ReleaseCompactEntry(const TDesC& aDbName); sl@0: static void CompactCleanup(void* aCleanup); sl@0: TInt PageSizeL(const TDesC& aDbName = KNullDesC); sl@0: //ConstructL() methods sl@0: void ConstructCreateSecureL(const TSqlSrvFileData& aFileData, CSqlSecurityPolicy* aSecurityPolicy); sl@0: void ConstructCreateL(const TSqlSrvFileData& aFileData); sl@0: void DoCommonConstructCreateL(const TSqlSrvFileData& aFileData, TBool aSecureDb); sl@0: void ConstructOpenSecureL(const TSqlSrvFileData& aFileData); sl@0: void ConstructOpenL(const TSqlSrvFileData& aFileData); sl@0: void DoCommonConstructOpenL(const TSqlSrvFileData& aFileData, TBool aSecureDb); sl@0: // sl@0: static void LikeSqlFunc(sqlite3_context* aContext, int aArgc, sqlite3_value** aArgv); sl@0: sl@0: private: sl@0: sqlite3* iDbHandle;//The database handle, owned by CSqlSrvDatabase. sl@0: const CSqlSecurityPolicy* iSecurityPolicy;//The main database security policy, not owned by CSqlSrvDatabase (owned by the CSqlServer::iSecurityMap object). sl@0: TUint8 iFileNameBuf[KMaxFileName + 1];//Temporary buffer for storing UTF8 encoded, zero terminated database names. sl@0: TBool iAuthorizerInstalled;//If non-zero then the authorizer callback is already installed. sl@0: //Fact: the authorizer callback must be installed for each sl@0: //secure CSqlSrvDatabase object. But it is possible that sl@0: // - there is one secure database object; sl@0: // - a second secure database is attached to the first one. sl@0: // in this case there is no need to install the authorizer again. sl@0: // sl@0: //Or there is another situation: non-secure main database + secure attached database. sl@0: TBool iAuthorizerDisabled; //See the comments for iAuthorizerInstalled. sl@0: //This flag is used only when attaching a secure database. sl@0: //Since during this operation the system tables are read/writen, sl@0: //The authorizer callback has to be temporary disabled. sl@0: RSqlAttachDbMap iAttachDbMap;//["dbName":"dbFileName"] map, owned by CSqlSrvDatabase. sl@0: const TUint8* iSecureDbName;//, used as a key in the security map. Not owned by CSqlSrvDatabase. sl@0: RSqlCompactDbMap iCompactDbMap; //["dbName":"Compact db entry"] map, owned by CSqlSrvDatabase. sl@0: TInt iPageSize; //Main database page size in bytes sl@0: sl@0: }; sl@0: sl@0: #include "SqlSrvDatabase.inl" sl@0: sl@0: #endif//__SQLSRVDATABASE_H__