sl@0: // Copyright (c) 2005-2010 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: #include "SqlSecurityImpl.h"	//CSqlSecurityPolicy
sl@0: #include "SqlDatabaseImpl.h"	//CSqlDatabaseImpl
sl@0: #include <e32debug.h>
sl@0: 
sl@0: /**
sl@0: Manual compaction - max compacton step execution time in microseconds.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: static const TInt KCompactMaxStepTimeUs = 100000;
sl@0: 
sl@0: /**
sl@0: Minimal amount of free database space to be removed by the compaction steps.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: static const TInt KCompactMinStepSize =  2 * 1024;
sl@0: 
sl@0: /**
sl@0: The amount of free database space to be removed by the first compaction step.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: static const TInt KCompactStartStepSize = 32 * 1024;
sl@0: 
sl@0: /**
sl@0: The aim of the function is to determine the maximum size of space to be freed, which fits within the time constraint.
sl@0: The decision is based on the time spent on the pervious compaction step.
sl@0: If the time is bigger than KCompactMaxStepTimeUs then the space will be reduced by factor of 2 (slow media),
sl@0: bet will never be less than KCompactMinStepSize.
sl@0: If the time is less than the KCompactMaxStepTimeUs/2 then the space will be increased by factor of 2 (fast media).
sl@0: 
sl@0: @param aRemaining The remaining free database space.
sl@0: @param aStep The size of the space removed by the previous compaction step.
sl@0: @param aTime The execution time of the previous compaction step.
sl@0: 
sl@0: @return The size in bytes if the next comaction step - the amount of space to be removed.
sl@0: 
sl@0: @see KMaxStepTimeUs
sl@0: @see KMinStepSize
sl@0: @see KStartStepSize
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: static TInt CalcCompactionStep(TInt aRemaining, TInt aStep, TInt aTime)
sl@0: 	{
sl@0: 	if(aTime > KCompactMaxStepTimeUs)
sl@0: 		{
sl@0: 		aStep /= 2;
sl@0: 		if(aStep < KCompactMinStepSize)
sl@0: 			{
sl@0: 			aStep = KCompactMinStepSize; 
sl@0: 			}
sl@0: 		}
sl@0: 	else if(aTime <= (KCompactMaxStepTimeUs / 2))
sl@0: 		{
sl@0: 		aStep *= 2;
sl@0: 		}
sl@0: 	if(aRemaining < aStep)
sl@0: 		{//If, for example, aStep is 4000 bytes, aRemaining is 2000 bytes, then the step should be 2000,  
sl@0: 		 //because that is what is left in the database as a free space.
sl@0: 		aStep = aRemaining;
sl@0: 		}
sl@0: 	return aStep;
sl@0: 	}
sl@0:  
sl@0: /**
sl@0: Creates a new CSqlDatabaseImpl instance.
sl@0: 
sl@0: CSqlDatabaseImpl implements RSqlDatabase, which means that CSqlDatabaseImpl instance will be created from 
sl@0: RSqlDatabase functions doing RSqlDatabase instance initialization - Create() and Open().
sl@0: 
sl@0: @param aFunction It may have one of the following values: 																																																																																																																																																																																																																																																																																																																																																																																																							
sl@0:  ESqlSrvDbCreate       - Create a shared non-secure or private secure database;
sl@0:  ESqlSrvDbCreateSecure - Create a shared secure database;
sl@0:  ESqlSrvDbOpen         - Open a shared non-secure, shared secure or private secure database;
sl@0: 	
sl@0: @param aDbFileName The name of the file that is to host the database.
sl@0: 				   If it is a secure database, then the format of the name is 
sl@0: 				   \<drive\>:\<[SID]database file name excluding the path\>. "[SID]" refers to the application SID.
sl@0: 				   If it is a non-secure database then aDbFileName should contain the full path name of the file 
sl@0: 				   that is to host the database.
sl@0: @param aSecurityPolicy The container for the security policies. 
sl@0: 				   aSecurityPolicy is NULL if aDbFileName refers to a non-secure database.
sl@0: @param aConfig the configuration string "PARAM=VALUE;...."
sl@0: 
sl@0: @return A pointer to the created CSqlDatabaseImpl instance.
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occurred;
sl@0:        KErrBadName, the file name is invalid - it has either a zero length or it is the name of a directory;
sl@0:        KErrArgument, system table name found in the security policies (aSecurityPolicy);
sl@0:        KErrAlreadyExists, the file already exists;
sl@0:        KErrNotReady, the drive does not exist or is not ready;
sl@0:        KErrInUse, the file is already open;
sl@0:        KErrNotFound, database file not found;
sl@0:        KErrGeneral, missing or invalid security policies (if the database to be opened is a secure database);
sl@0:        KErrNotSupported, incompatible SQL security version (if the database to be opened is a secure database).
sl@0:        KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
sl@0:                       Note that the function may leave with database specific errors categorised as ESqlDbError and
sl@0:                       other system-wide error codes.
sl@0:                       
sl@0: @see RSqlDatabase
sl@0: @see RSqlDatabase::Create()
sl@0: @see RSqlDatabase::Open()
sl@0: @see TSqlSrvFunction
sl@0: @see CSqlSecurityPolicy
sl@0: */
sl@0: CSqlDatabaseImpl* CSqlDatabaseImpl::NewL(TSqlSrvFunction aFunction, const TDesC& aDbFileName, 
sl@0: 										 const CSqlSecurityPolicy* aSecurityPolicy,
sl@0: 										 const TDesC8* aConfig)
sl@0: 	{
sl@0: 	CSqlDatabaseImpl* self = new (ELeave) CSqlDatabaseImpl;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aFunction, aDbFileName, aSecurityPolicy, aConfig);
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Initializes the created CSqlDatabaseImpl instance.
sl@0: 
sl@0: @param aFunction It may have one of the following values:
sl@0:   ESqlSrvDbCreate       - Create a shared non-secure or private secure database;
sl@0:   ESqlSrvDbCreateSecure - Create a shared secure database;
sl@0:   ESqlSrvDbOpen         - Open a shared non-secure, shared secure or private secure database;
sl@0: 
sl@0: @param aDbFileName The name of the file that is to host the database.
sl@0: 				   If it is a secure database, then the format of the name is 
sl@0: 				   \<drive\>:\<[SID]database file name excluding the path\>. "[SID]" refers to the application SID.
sl@0: 				   If it is a non-secure database then aDbFileName should contain the full path name of the file 
sl@0: 				   that is to host the database.
sl@0: @param aSecurityPolicy The container for the security policies. 
sl@0: 				   aSecurityPolicy is NULL if aDbFileName refers to a non-secure database.
sl@0: @param aConfig the configuration string "PARAM=VALUE;...."
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occurred;
sl@0:        KErrBadName, the file name is invalid - it has either a zero length or it is the name of a directory;
sl@0:        KErrArgument, system table name found in the security policies (aSecurityPolicy);
sl@0:        KErrAlreadyExists, the file already exists;
sl@0:        KErrNotReady, the drive does not exist or is not ready;
sl@0:        KErrInUse, the file is already open;
sl@0:        KErrNotFound, database file not found;
sl@0:        KErrGeneral, missing or invalid security policies (if the database to be opened is a secure database);
sl@0:        KErrNotSupported, incompatible SQL security version (if the database to be opened is a secure database).
sl@0:        KErrPermissionDenied, the caller does not satisfy the relevant database security policies.
sl@0:                       Note that the function may leave with database specific errors categorised as ESqlDbError and
sl@0:                       other system-wide error codes.
sl@0: 
sl@0: @see CSqlDatabaseImpl::NewL()
sl@0: 
sl@0: @panic SqlDb 4 In _DEBUG mode. aSecurityPolicy is NULL, but the request is for opening/creating a secure database.
sl@0: */
sl@0: void CSqlDatabaseImpl::ConstructL(TSqlSrvFunction aFunction, const TDesC& aDbFileName, 
sl@0: 								  const CSqlSecurityPolicy* aSecurityPolicy, const TDesC8* aConfig)
sl@0: 	{
sl@0: 	TPtrC8 securityPolicyData;
sl@0: 	if(aFunction == ESqlSrvDbCreateSecure)	
sl@0: 		{
sl@0: 		__ASSERT_DEBUG(aSecurityPolicy != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 		const RSqlBufFlat& bufFlat = aSecurityPolicy->BufFlat();
sl@0: 		securityPolicyData.Set(bufFlat.BufDes());
sl@0: 		}
sl@0: 	__SQLLEAVE_IF_ERROR(Session().Connect(aFunction, aDbFileName, securityPolicyData, aConfig));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Frees the allocated by CSqlDatabaseImpl instance memory and other resources.
sl@0: */
sl@0: CSqlDatabaseImpl::~CSqlDatabaseImpl()
sl@0: 	{
sl@0: 	Session().Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Creates and returns a copy of the database security policies object.
sl@0: The caller is responsible for destroying the returned CSqlSecurityPolicy instance.
sl@0: 
sl@0: Implements RSqlDatabase::GetSecurityPolicyL().
sl@0: 
sl@0: @return A copy of the database security policies object. 
sl@0:         The returned copy must be destroyed by the caller.
sl@0:         
sl@0: @leave KErrNotSupported, the current database is not a secure database;
sl@0:        KErrNoMemory, an out of memory condition has occurred;
sl@0: 
sl@0: @see RSqlDatabase
sl@0: @see RSqlDatabase::GetSecurityPolicyL()
sl@0: */
sl@0: CSqlSecurityPolicy* CSqlDatabaseImpl::CloneSecurityPolicyL()
sl@0: 	{
sl@0: 	TSecurityPolicy defaultPolicy(TSecurityPolicy::EAlwaysFail);
sl@0: 	CSqlSecurityPolicy* dbPolicy = CSqlSecurityPolicy::NewLC(defaultPolicy);
sl@0: 	__SQLLEAVE_IF_ERROR(Session().GetSecurityPolicy(dbPolicy->BufFlat()));
sl@0: 	CleanupStack::Pop(dbPolicy);
sl@0: 	return dbPolicy;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Implements RSqlDatabase::Compact().
sl@0: 
sl@0: @param aSize Can be one of:
sl@0: 				 RSqlDatabase::EMaxCompaction - requests a full database compaction. All free pages
sl@0: 				  (if any exists) will be removed;
sl@0: 				 Positive integer value - the server will attempt to compact the database removing 
sl@0: 				  at most aSize bytes from the database file, rounded up to the nearest page count, 
sl@0: 				  e.g. request for removing 1 byte will remove one free page from the database;
sl@0: @param aDbName The attached database name or KNullDesC for the main database
sl@0: 
sl@0: @return Zero or positive integer - the operation has completed succesfully, the return value is the
sl@0:          						   size of the removed free space in bytes,
sl@0: 		KErrArgument, Invalid aSize value;
sl@0:         KErrBadName, Invalid (too long) attached database name;
sl@0:         KSqlErrReadOnly, Read-only database;
sl@0:         KSqlErrGeneral, There is no an attached database with aDbName name;
sl@0:                   Note that database specific errors categorised as ESqlDbError, and
sl@0:                   other system-wide error codes may also be returned.
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [out]	How much space in bytes should be compacted, all free pages should be removed if the
sl@0: 				parameter value is RSqlDatabase::EMaxCompaction.
sl@0: Arg 1: [out]	The database name length in characters
sl@0: Arg 2: [out]	The attached database name or KNullDesC for the main database
sl@0: */
sl@0: TInt CSqlDatabaseImpl::Compact(TInt aSize, const TDesC& aDbName)
sl@0: 	{
sl@0: 	if(aSize < 0)
sl@0: 		{
sl@0: 		if(aSize != RSqlDatabase::EMaxCompaction)
sl@0: 			{
sl@0: 			return KErrArgument;
sl@0: 			}
sl@0: 		aSize = KMaxTInt;
sl@0: 		}
sl@0: 	TInt remaining = aSize;
sl@0: 	TInt compacted = 0;
sl@0: 	TInt step = KCompactStartStepSize;
sl@0: 	TInt rc = 0;
sl@0: 	TTimeIntervalMicroSeconds interval(0);
sl@0: 	while(remaining > 0)
sl@0: 		{
sl@0: 		step = ::CalcCompactionStep(remaining, step, interval.Int64());
sl@0: 		TTime start;
sl@0: 		start.HomeTime();
sl@0: 		rc = Session().SendReceive(ESqlSrvDbCompact, TIpcArgs(step, aDbName.Length(), &aDbName));
sl@0: 		if(rc <= 0)
sl@0: 			{
sl@0: 			break;	
sl@0: 			}
sl@0: 		TTime end;
sl@0: 		end.HomeTime();
sl@0: 		interval = end.MicroSecondsFrom(start);
sl@0: 		remaining -= rc;				
sl@0: 		compacted += rc;
sl@0: 		}
sl@0: 	return rc < 0 ? rc : compacted;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [out]	How much space in bytes should be compacted, all free pages should be removed if the
sl@0: 				parameter value is RSqlDatabase::EMaxCompaction.
sl@0: Arg 1: [out]	The database name length in characters
sl@0: Arg 2: [out]	The attached database name or KNullDesC for the main database
sl@0: */
sl@0: void CSqlDatabaseImpl::Compact(TInt aSize, const TDesC& aDbName, TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	if(aSize == 0)
sl@0: 		{
sl@0: 		TRequestStatus* stat = &aStatus;
sl@0: 		User::RequestComplete(stat, 0);
sl@0: 		return;
sl@0: 		}
sl@0: 	Session().SendReceive(ESqlSrvDbCompact, TIpcArgs(aSize, aDbName.Length(), &aDbName), aStatus);
sl@0: 	}