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: // NTT DOCOMO, INC - Fix for Bug 1915 "SQL server panics when using long column type strings"
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include <s32mem.h>
sl@0: #include "SqlStmtSession.h"		//RSqlStatementSession
sl@0: #include "OstTraceDefinitions.h"
sl@0: #ifdef OST_TRACE_COMPILER_IN_USE
sl@0: #include "SqlStmtSessionTraces.h"
sl@0: #endif
sl@0: #include "SqlTraceDef.h"
sl@0: 
sl@0: /**
sl@0:  Sends a request to the SQL server to prepare 16-bit aSqlStmt statement.
sl@0:  
sl@0:  Usage of the IPC call arguments:
sl@0:  Arg 0: [in/out]        data buffer for the column and parameter count.
sl@0:  Arg 1: [out]       statement length in characters
sl@0:  Arg 2: [out]       16-bit statement
sl@0:  
sl@0:  @param aDbSession A reference to RSqlDbSession instance.
sl@0:  @param aSqlStmt 16-bit SQL statement.
sl@0:  @param aColumnCount Output parameter. Statement column count.
sl@0:  @param aParamCount Output parameter. Statement parameter count.
sl@0:  
sl@0:  @return KErrNoMemory, an out of memory condition has occured;
sl@0:  KErrArgument, bad argument, for example - the SQL string contains more than one SQL statements.
sl@0:  Note that the function may return some database specific errors categorised as 
sl@0:  ESqlDbError or other system-wide error codes;
sl@0:  KErrNone      The operation has completed successfully. 
sl@0:  
sl@0:  @panic SqlDb 7 In _DEBUG mode if the statement handle is 0.
sl@0: */
sl@0: TInt RSqlStatementSession::Prepare(RSqlDbSession& aDbSession, const TDesC& aSqlStmt, 
sl@0:                                           TInt& aColumnCount, TInt& aParamCount)
sl@0:     {
sl@0:     iDbSession = &aDbSession;
sl@0:     TSqlIpcData data;
sl@0:     TPckg<TSqlIpcData> pckg(data);
sl@0:     TUint stmtLen = aSqlStmt.Length();
sl@0:     iHandle = iDbSession->SendReceive(ESqlSrvStmtPrepare16, TIpcArgs(&pckg, stmtLen, &aSqlStmt));
sl@0:     __ASSERT_DEBUG(iHandle != 0, __SQLPANIC(ESqlPanicInternalError));   
sl@0:     aColumnCount = static_cast <TInt> (data.iPrm1);
sl@0:     aParamCount = static_cast <TInt> (data.iPrm2);
sl@0:     SQL_TRACE_SESSION(OstTraceExt2(TRACE_INTERNALS, RSQLSTATEMENTSESSION_PREPARE16, "0x%X;RSqlStatementSession::Prepare-16;iHandle=%d", (TUint)this, iHandle));
sl@0:     return iHandle > 0 ? KErrNone : iHandle;
sl@0:     }
sl@0: 
sl@0: /**
sl@0: Sends a request to the SQL server to prepare 8-bit aSqlStmt statement.
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [in/out]     data buffer for the column and parameter count.
sl@0: Arg 1: [out]        statement length in characters
sl@0: Arg 2: [out]        8-bit statement
sl@0: 
sl@0: @param aDbSession A reference to RSqlDbSession instance.
sl@0: @param aSqlStmt 8-bit SQL statement.
sl@0: @param aColumnCount Output parameter. Statement column count.
sl@0: @param aParamCount Output parameter. Statement parameter count.
sl@0: 
sl@0: @return KErrNoMemory, an out of memory condition has occured;
sl@0:         KErrArgument, bad argument, for example - the SQL string contains more than one SQL statements.
sl@0:                       Note that the function may return some database specific errors categorised as 
sl@0:                       ESqlDbError or other system-wide error codes;
sl@0:         KErrNone      The operation has completed successfully. 
sl@0: 
sl@0: @panic SqlDb 7 In _DEBUG mode if the statement handle is 0.
sl@0: */
sl@0: TInt RSqlStatementSession::Prepare(RSqlDbSession& aDbSession, const TDesC8& aSqlStmt, 
sl@0:                                           TInt& aColumnCount, TInt& aParamCount)
sl@0:     {
sl@0:     iDbSession = &aDbSession;
sl@0:     TSqlIpcData data;
sl@0:     TPckg<TSqlIpcData> pckg(data);
sl@0:     TUint stmtLen = aSqlStmt.Length();
sl@0:     iHandle = iDbSession->SendReceive(ESqlSrvStmtPrepare8, TIpcArgs(&pckg, stmtLen, &aSqlStmt));
sl@0:     __ASSERT_DEBUG(iHandle != 0, __SQLPANIC(ESqlPanicInternalError));
sl@0:     aColumnCount = static_cast <TInt> (data.iPrm1);
sl@0:     aParamCount = static_cast <TInt> (data.iPrm2);
sl@0:     SQL_TRACE_SESSION(OstTraceExt2(TRACE_INTERNALS, RSQLSTATEMENTSESSION_PREPARE8, "0x%X;RSqlStatementSession::Prepare-8;iHandle=%d", (TUint)this, iHandle));
sl@0:     return iHandle > 0 ? KErrNone : iHandle;
sl@0:     }
sl@0: 
sl@0: /**
sl@0: Sends a request to the server to close the statement handle.
sl@0: Closes the session object.
sl@0: */
sl@0: void RSqlStatementSession::Close()
sl@0: 	{
sl@0: 	SQL_TRACE_SESSION(OstTraceExt2(TRACE_INTERNALS, RSQLSTATEMENTSESSION_CLOSE, "0x%X;RSqlStatementSession::Close;iHandle=%d", (TUint)this, iHandle));
sl@0: 	if(iDbSession && iHandle > 0)
sl@0: 		{
sl@0: 		(void)iDbSession->SendReceive(::MakeMsgCode(ESqlSrvStmtClose, ESqlSrvStatementHandle, iHandle));
sl@0: 		}
sl@0: 	iDbSession = NULL;
sl@0: 	iHandle = -1;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Binds the statement parameters and sends a request to the SQL server to move to the next record which satisfies the 
sl@0: condition of the prepared SQL statement.
sl@0: If there is a valid next record, the method transfers the column values from the server.
sl@0: 
sl@0: @param aParamBuf  It references RSqlBufFlat object where the parameter values are stored.
sl@0: @param aColumnBuf It references RSqlBufFlat object where the column values will be stored.
sl@0: 
sl@0: @return KSqlAtRow,      the record data is ready for processing by the caller;
sl@0:         KSqlAtEnd,      there is no more record data;
sl@0:         KSqlErrBusy,    the database file is locked;
sl@0:         KErrNoMemory,   an out of memory condition has occurred - the statement
sl@0:                         will be reset;
sl@0:         KSqlErrGeneral, a run-time error has occured - this function must not
sl@0:                         be called again;        
sl@0:         KSqlErrMisuse,  this function has been called after a previous call
sl@0:                         returned KSqlAtEnd or KSqlErrGeneral.
sl@0:         KSqlErrStmtExpired, the SQL statement has expired (if new functions or
sl@0:                             collating sequences have been registered or if an
sl@0:                             authorizer function has been added or changed);
sl@0: */
sl@0: TInt RSqlStatementSession::BindNext(const RSqlBufFlat& aParamBuf, RSqlBufFlat& aColumnBuf)
sl@0: 	{
sl@0: 	TPtrC8 prmData(aParamBuf.BufDes());
sl@0: 	TIpcArgs ipcArgs;
sl@0: 	ipcArgs.Set(0, prmData.Length());
sl@0: 	ipcArgs.Set(1, &prmData);
sl@0: 	return DoBindNext(ESqlSrvStmtBindNext, ipcArgs, aColumnBuf);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Implements RSqlStatementSession::Next() and RSqlStatementSession::BindNext().
sl@0: Sends a "Next" command to the server combined with optional "Bind" command.
sl@0: In a single IPC call the statement parameters will be bound and the current row columns - returned.
sl@0: If the client side flat buffer is not big enough, a second IPC call will be made after reallocating the buffer.
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [out]		parameter buffer length in bytes
sl@0: Arg 1: [out]		parameter buffer
sl@0: Arg 2: [out]		column buffer length in bytes
sl@0: Arg 3: [in/out]		column buffer
sl@0: 
sl@0: @see RSqlStatementSession::Next()
sl@0: @see RSqlStatementSession::BindNext()
sl@0: */
sl@0: TInt RSqlStatementSession::DoBindNext(TSqlSrvFunction aFunction, TIpcArgs& aIpcArgs, RSqlBufFlat& aColumnBuf)
sl@0: 	{
sl@0: 	aColumnBuf.Reset();
sl@0: 	aIpcArgs.Set(2, aColumnBuf.MaxSize());
sl@0: 	aIpcArgs.Set(3, &aColumnBuf.BufPtr());
sl@0: 	TInt err = DbSession().SendReceive(::MakeMsgCode(aFunction, ESqlSrvStatementHandle, iHandle), aIpcArgs);
sl@0: 	if(err > KSqlClientBufOverflowCode)
sl@0: 		{
sl@0: 		err = Retry(aColumnBuf, err - KSqlClientBufOverflowCode, ESqlColumnValuesBuf);
sl@0: 		if(err == KErrNone)
sl@0: 			{
sl@0: 			err = KSqlAtRow;	
sl@0: 			}
sl@0: 		}
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sends a command to the server for retrieving parameter names or column names.
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [out]		buffer length in bytes
sl@0: Arg 1: [in/out]		buffer
sl@0: */	
sl@0: TInt RSqlStatementSession::GetNames(TSqlSrvFunction aFunction, RSqlBufFlat& aNameBuf)
sl@0: 	{
sl@0: 	aNameBuf.Reset();
sl@0: 	TPtr8& ptr = aNameBuf.BufPtr();
sl@0: 	TInt err = DbSession().SendReceive(::MakeMsgCode(aFunction, ESqlSrvStatementHandle, iHandle), TIpcArgs(ptr.MaxLength(), &ptr));
sl@0: 	if(err > KSqlClientBufOverflowCode)
sl@0: 		{
sl@0: 		err = Retry(aNameBuf, err - KSqlClientBufOverflowCode, aFunction == ESqlSrvStmtColumnNames ? ESqlColumnNamesBuf : ESqlParamNamesBuf);
sl@0: 		}
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sends a command to the server for retrieving specified data (aWhat parameter).
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [out]		The type of the data to be retrieved
sl@0: Arg 1: [in/out]		Data buffer
sl@0: */	
sl@0: TInt RSqlStatementSession::Retry(RSqlBufFlat& aBufFlat, TInt aSize, TSqlBufFlatType aWhat)
sl@0: 	{
sl@0: 	aBufFlat.Reset();
sl@0: 	TInt err = aBufFlat.ReAlloc(aSize);
sl@0: 	if(err == KErrNone)
sl@0: 		{
sl@0: 		TPtr8& ptr = aBufFlat.BufPtr();
sl@0: 		err = DbSession().SendReceive(::MakeMsgCode(ESqlSrvStmtBufFlat, ESqlSrvStatementHandle, iHandle), TIpcArgs(aWhat, &ptr));
sl@0: 		}
sl@0: 	return err;	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Sends a command to the server for retrieving the declared types of columns
sl@0: 
sl@0: Usage of the IPC call arguments:
sl@0: Arg 0: [out]		buffer length in bytes
sl@0: Arg 1: [in/out]		buffer
sl@0: */	 
sl@0: TInt RSqlStatementSession::GetDeclColumnTypes(RSqlBufFlat& aDeclColumnTypeBuf)
sl@0: 	{
sl@0: 	aDeclColumnTypeBuf.Reset();
sl@0: 	TPtr8& ptr = aDeclColumnTypeBuf.BufPtr();
sl@0: 	TInt err = DbSession().SendReceive(::MakeMsgCode(ESqlSrvStmtDeclColumnTypes, ESqlSrvStatementHandle, iHandle), TIpcArgs(ptr.MaxLength(), &ptr));	
sl@0: 	if(err > KSqlClientBufOverflowCode)
sl@0: 		{
sl@0: 		err = Retry(aDeclColumnTypeBuf, err - KSqlClientBufOverflowCode, ESqlDeclColumnTypesBuf);
sl@0: 		}
sl@0: 	return err;	
sl@0: 	}