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 <e32svr.h>
sl@0: #include "SqlAssert.h"
sl@0: #include <sqldb.h>		//ESqlAtRow, ESqlAtEnd, ESqlErrGeneral
sl@0: #include "sqlite3.h"	//SQLITE_OK, SQLITE_ROW, SQLITE_DONE
sl@0: #include "OstTraceDefinitions.h"
sl@0: #ifdef OST_TRACE_COMPILER_IN_USE
sl@0: #include "SqlUtilTraces.h"
sl@0: #endif
sl@0: #include "SqlTraceDef.h"
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: const TInt KSqlLeavePanic = -359;//The (last-1) error code from the reserved area for the SQL component.
sl@0: 
sl@0: #define UNUSED_ARG(arg) arg = arg
sl@0: #define UNUSED_DES(arg) arg
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: #if defined OST_TRACE_COMPILER_IN_USE &&  defined _SQL_RDEBUG_PRINT
sl@0: 
sl@0: /**
sl@0: This class has been added here to avoid the crashes when _SQL_RDEBUG_PRINT macro is defined but the
sl@0: data to be printed out is too big and cannot fit into the buffer with size KSqlMaxPrnStrLen.
sl@0: @internalComponent   
sl@0: */
sl@0: class TSqlDes16Overflow : public TDes16Overflow
sl@0:     {
sl@0: public:    
sl@0:     virtual void Overflow(TDes16& /*aDes*/)
sl@0:         {
sl@0:         }
sl@0:     };
sl@0: 
sl@0: //Replaces:
sl@0: // 1) "%lld" with "%ld"
sl@0: // 2) "%s" with "%S"
sl@0: //These are the differences in format specification between RDebig::Print and OST functions.
sl@0: //The new format spec length should be less or equal than the old format spec length.
sl@0: static void ReplaceFmtSpec(TDes& aFormat, const TDesC& aFmtSpec, const TDesC& aNewFmtSpec)
sl@0: 	{
sl@0: 	TInt fmtLength = aFormat.Length();
sl@0: 	const TInt KDiff = aFmtSpec.Length() - aNewFmtSpec.Length();
sl@0:     TPtr ptr((TText*)aFormat.Ptr(), fmtLength, fmtLength);
sl@0:     TInt pos;
sl@0:     while((pos = ptr.Find(aFmtSpec)) >= 0)
sl@0:     	{
sl@0: 		ptr.Replace(pos, aFmtSpec.Length(), aNewFmtSpec);
sl@0: 		fmtLength -= KDiff;
sl@0: 		ptr.Set(ptr.MidTPtr(pos));
sl@0:     	}
sl@0:     aFormat.SetLength(fmtLength);
sl@0: 	}
sl@0: 
sl@0: void SqlPrintf(TInt /*aGroupName*/, TInt /*aTraceName*/, const char* aFormat, ...)
sl@0:     {
sl@0:     VA_LIST list;
sl@0:     VA_START(list, aFormat);
sl@0:     TBuf<128> format;
sl@0:     _LIT(KTraceIdent, "SQL;");
sl@0:     format.Copy(TPtrC8((const TUint8*)aFormat));
sl@0:     format.Insert(0, KTraceIdent);
sl@0:     format.Append(_L("\r\n"));
sl@0:     _LIT(KOstI64Fmt, "%lld");
sl@0:     _LIT(KDbgPrnI64Fmt, "%ld");
sl@0:     ReplaceFmtSpec(format, KOstI64Fmt, KDbgPrnI64Fmt);
sl@0:     _LIT(KOstDes8Fmt, "%s");
sl@0:     _LIT(KDbgPrnDesFmt, "%S");
sl@0:     ReplaceFmtSpec(format, KOstDes8Fmt, KDbgPrnDesFmt);
sl@0:     TBuf<KSqlMaxPrnStrLen> buf;
sl@0:     TSqlDes16Overflow overflowHandler;
sl@0:     buf.AppendFormatList(format, list, &overflowHandler);
sl@0: #ifdef _SQL_RDEBUG_PRINT    
sl@0:     RDebug::RawPrint(buf);
sl@0: #endif
sl@0:     }
sl@0: 
sl@0: const TDesC* SqlDes8to16Ptr(const TDesC8& aDes, TDes& aOut)
sl@0: 	{
sl@0: 	TPtrC8 ptr(aDes.Ptr(), Min(aDes.Length(), aOut.MaxLength()));
sl@0: 	aOut.Copy(ptr);
sl@0: 	return &aOut;
sl@0: 	}
sl@0: 
sl@0: #endif//defined OST_TRACE_COMPILER_IN_USE &&  defined _SQL_RDEBUG_PRINT 
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: SQL panic category.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: _LIT(KPanicCategory, "SqlDb");
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: Panics the caller with aPanicCode panic code.
sl@0: The call will terminate the thread where it is called from.
sl@0: 
sl@0: @param aPanicCode Panic code.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: static void SqlPanic(TSqlPanic aPanicCode)
sl@0: 	{
sl@0: 	User::Panic(KPanicCategory, aPanicCode);
sl@0: 	}
sl@0: 	
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: Panics the client with aPanicCode panic code.
sl@0: This function is used by the SQL server to panic the caller (the client).
sl@0: 
sl@0: @param aMessage Client's message
sl@0: @param aPanicCode Panic code.
sl@0: 
sl@0: @leave KSqlLeavePanic
sl@0: 
sl@0: @return KErrNone
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: static TInt SqlPanicClientL(const RMessage2& aMessage, TSqlPanic aPanicCode)
sl@0: 	{
sl@0: 	aMessage.Panic(KPanicCategory, aPanicCode);
sl@0: 	__SQLLEAVE2(KSqlLeavePanic);
sl@0: 	return KErrNone;
sl@0: 	}	
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: The function prints out a "SQL panic" message to the console and panics the thread where it is called from.
sl@0: It gives a useful information about the found error together with the source file name and line number where
sl@0: it occurred.
sl@0: 
sl@0: Note: this function  will output information regarding the panic only if _SQL_PANIC_TRACE_ENABLED macro is defined  
sl@0: 
sl@0: @param aFile Source file name
sl@0: @param aLine Source line number
sl@0: @param aPanicCode Panic code
sl@0: @param aHandle Numeric value, uniquely identfying the leaving location (the "this" pointer for example)
sl@0: 
sl@0: @return KErrNone
sl@0: 
sl@0: @internalComponent
sl@0: */  
sl@0: TInt TSqlUtil::Panic(const TText* aFile, TInt aLine, TInt aPanicCode, TUint aHandle)
sl@0:     {
sl@0: #if defined OST_TRACE_COMPILER_IN_USE && defined _SQL_PANIC_TRACE_ENABLED
sl@0:     TPtrC fname(FileName(aFile));
sl@0:     OstTraceExt5(TRACE_FATAL, TSQLUTIL_PANIC, "Panic;0x%X;%S;%d;%S;%d", aHandle, __SQLPRNSTR(fname), aLine, __SQLPRNSTR(KPanicCategory), aPanicCode);
sl@0: #else
sl@0:     UNUSED_ARG(aFile);
sl@0:     UNUSED_ARG(aLine);
sl@0:     UNUSED_ARG(aHandle);
sl@0: #endif      
sl@0:     ::SqlPanic(static_cast <TSqlPanic> (aPanicCode));
sl@0:     return KErrNone;
sl@0:     }
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: The function prints out a "SQL leave" message to the console and leaves with aError error code.
sl@0: It gives a usefull information about the found error together with the source file name and line number where
sl@0: it occured.
sl@0: 
sl@0: Note: this function  will output information regarding the panic only if _SQL_LEAVE_TRACE_ENABLED macro is defined  
sl@0: 
sl@0: @param aFile Source file name
sl@0: @param aLine Source line number
sl@0: @param aError Error code
sl@0: @param aHandle Numeric value, uniquely identfying the leaving location (the "this" pointer for example)
sl@0: 
sl@0: @internalComponent
sl@0: */  
sl@0: void TSqlUtil::Leave(const TText* aFile, TInt aLine, TInt aError, TUint aHandle)
sl@0:     {
sl@0: #if defined OST_TRACE_COMPILER_IN_USE && defined _SQL_LEAVE_TRACE_ENABLED     
sl@0:     TPtrC fname(FileName(aFile));
sl@0:     OstTraceExt4(TRACE_ERROR, TSQLUTIL_LEAVE, "Leave;0x%X;%S;%d;Error=%d", aHandle, __SQLPRNSTR(fname), aLine, aError);
sl@0: #else
sl@0:     UNUSED_ARG(aFile);
sl@0:     UNUSED_ARG(aLine);
sl@0:     UNUSED_ARG(aHandle);
sl@0: #endif
sl@0:     User::Leave(aError);
sl@0:     }
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: The function prints out a "SQL leave" message to the console and leaves with aError error code, if it is 
sl@0: negative.
sl@0: It gives a usefull information about the found error together with the source file name and line number where
sl@0: it occured.
sl@0: 
sl@0: Note: this function  will output information regarding the panic only if _SQL_LEAVE_TRACE_ENABLED macro is defined  
sl@0: 
sl@0: @param aFile Source file name
sl@0: @param aLine Source line number
sl@0: @param aError Error code
sl@0: 
sl@0: @internalComponent
sl@0: */  
sl@0: TInt TSqlUtil::LeaveIfError(const TText* aFile, TInt aLine, TInt aError, TUint aHandle)
sl@0:     {
sl@0:     if(aError < 0)
sl@0:         {
sl@0:         TSqlUtil::Leave(aFile, aLine, aError, aHandle);
sl@0:         }
sl@0:     return aError;
sl@0:     }
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: The function prints out a "SQL leave" message to the console and leaves with KErrNoMemory if 
sl@0: aPtr parameter is NULL.
sl@0: 
sl@0: Note: this function  will output information regarding the panic only if _SQL_LEAVE_TRACE_ENABLED macro is defined  
sl@0: 
sl@0: @param aFile Source file name
sl@0: @param aLine Source line number
sl@0: @param aPtr The pointer to be tested against NULL value.
sl@0: 
sl@0: @internalComponent
sl@0: */  
sl@0: void* TSqlUtil::LeaveIfNull(const TText* aFile, TInt aLine, void* aPtr, TUint aHandle)
sl@0:     {
sl@0:     if(!aPtr)
sl@0:         {
sl@0:         TSqlUtil::Leave(aFile, aLine, KErrNoMemory, aHandle);
sl@0:         }
sl@0:     return aPtr;
sl@0:     }
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: The function is used by the SQL server.
sl@0: It prints out a "SQL panic" message to the console and panic the client.
sl@0: It gives a usefull information about the found error together with the source file name and line number where
sl@0: it occured.
sl@0: 
sl@0: Note: this function  will output information regarding the panic only if _SQL_PANIC_TRACE_ENABLED macro is defined  
sl@0: 
sl@0: @param aFile Source file name
sl@0: @param aLine Source line number
sl@0: @param aMessage The client message, which processing caused the panic.
sl@0: @param aPanicCode Error code
sl@0: 
sl@0: @leave KSqlLeavePanic
sl@0: 
sl@0: @return KErrNone;
sl@0: 
sl@0: @internalComponent
sl@0: */  
sl@0: TInt TSqlUtil::PanicClientL(const TText* aFile, TInt aLine, const RMessage2& aMessage, TInt aPanicCode, TUint aHandle)
sl@0:     {
sl@0: #if defined OST_TRACE_COMPILER_IN_USE && defined  _SQL_PANIC_TRACE_ENABLED
sl@0:     TPtrC fname(FileName(aFile));
sl@0:     OstTraceExt5(TRACE_FATAL, TSQLUTIL_PANICCLIENTL, "Panic;%X;%S;%d;%S;%d", aHandle, __SQLPRNSTR(fname), aLine, __SQLPRNSTR(KPanicCategory), aPanicCode);
sl@0: #else
sl@0:     UNUSED_ARG(aFile);
sl@0:     UNUSED_ARG(aLine);
sl@0:     UNUSED_ARG(aHandle);
sl@0: #endif      
sl@0:     return ::SqlPanicClientL(aMessage, static_cast <TSqlPanic> (aPanicCode));
sl@0:     }
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: Processes SQL database error code and OS error code and returns unified error code.
sl@0: If aSqlError == SQLITE_ROW then the function returns KSqlAtRow.
sl@0: If aSqlError == SQLITE_DONE then the function returns KSqlAtEnd.
sl@0: If aSqlError == SQLITE_NOMEM then the function returns KErrNoMemory.
sl@0: If aOsError != KErrNone then the function returns aOsError.
sl@0: Otherwise the function converts aSqlError to one of error codes in [KSqlErrGeneral..KSqlErrStmtExpired] range.
sl@0: 
sl@0: @param aSqlError SQL database error code.
sl@0: @param aOsError OS error code.
sl@0: 
sl@0: @return Database specific error code.
sl@0: 
sl@0: @panic SqlDb 4 in debug mode - if aSqlError < 0
sl@0: @panic SqlDb 4 in debug mode - if aOsError > 0
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: TInt Sql2OsErrCode(TInt aSqlError, TInt aOsError)
sl@0: 	{
sl@0: 
sl@0: 	__ASSERT_DEBUG(aSqlError >= SQLITE_OK && aOsError <= KErrNone, __SQLPANIC2(ESqlPanicBadArgument));
sl@0: 	TInt err = KErrNone;
sl@0: 	if(aOsError == KErrDiskFull)
sl@0: 		{//Whatever is the aSqlError value, even SQLITE_OK, never ignore KErrDiskFull errors
sl@0: 		 //(For example: ROLLBACK statement execution, when the disk is full).
sl@0: 		err = aOsError;
sl@0: 		}
sl@0: 	else if(aSqlError == SQLITE_ROW)
sl@0: 		{
sl@0: 		err = KSqlAtRow;
sl@0: 		}
sl@0: 	else if(aSqlError == SQLITE_DONE)
sl@0: 		{
sl@0: 		err = KSqlAtEnd;
sl@0: 		}
sl@0: 	else if(aSqlError == SQLITE_NOMEM)
sl@0: 		{
sl@0: 		err = KErrNoMemory;
sl@0: 		}
sl@0: 	else if(aSqlError == SQLITE_AUTH)
sl@0: 		{
sl@0: 		err = KErrPermissionDenied;
sl@0: 		}
sl@0: 	else if(aSqlError == SQLITE_NOTADB)
sl@0: 		{
sl@0: 		err = KSqlErrNotDb;	
sl@0: 		}
sl@0: 	else if(aSqlError > SQLITE_OK)
sl@0: 		{
sl@0: 		err = aOsError != KErrNone ? aOsError : KSqlErrGeneral - aSqlError + 1;
sl@0: 		}
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: #if defined OST_TRACE_COMPILER_IN_USE && (defined _SQL_PANIC_TRACE_ENABLED || defined _SQL_LEAVE_TRACE_ENABLED) 
sl@0: 
sl@0: /**
sl@0: The function creates and returns TPtrC object which points to aFile parameter.
sl@0: 
sl@0: @param aFile File name
sl@0: @return TPtrC object pointing to aFile parameter.
sl@0: 
sl@0: @internalComponent
sl@0: */	
sl@0: TPtrC TSqlUtil::FileName(const TText* aFile)
sl@0: 	{
sl@0: 	TPtrC p(aFile);
sl@0: 	TInt ix = p.LocateReverse('\\');
sl@0: 	if(ix<0)
sl@0: 		ix=p.LocateReverse('/');
sl@0: 	if(ix>=0)
sl@0: 		p.Set(p.Mid(1+ix));
sl@0: 	return p;
sl@0: 	}
sl@0: 
sl@0: #endif //defined OST_TRACE_COMPILER_IN_USE && (defined _SQL_PANIC_TRACE_ENABLED || defined _SQL_LEAVE_TRACE_ENABLED)