sl@0: // Copyright (c) 2008-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 "sqlite3.h"
sl@0: #include "SqlAssert.h"
sl@0: #include "SqlSrvBlob.h"
sl@0: #include "SqliteSymbian.h"
sl@0: #include "SqlSrvUtil.h"
sl@0: #include "SqlSrvStrings.h"
sl@0: #include "SqlDb.h"
sl@0: #include "OstTraceDefinitions.h"
sl@0: #ifdef OST_TRACE_COMPILER_IN_USE
sl@0: #include "SqlSrvBlobTraces.h"
sl@0: #endif
sl@0: #include "SqlTraceDef.h"
sl@0: 
sl@0: #define UNUSED_VAR(var) var = var
sl@0: 
sl@0: /**
sl@0: Creates a new HBlobBuf instance.
sl@0: 
sl@0: @param aDb 			 The database handle
sl@0: @param aDbName 		 The database name, zero-terminated. If the blob belongs to one of the attached databases, 
sl@0: 					 then the attached database name should be used as the value of aDbName, otherwise the
sl@0: 					 value should be "main"
sl@0: @param aTableName    The name of the table to which the blob belongs, zero-terminated.
sl@0: @param aColumnName   The name of the blob column, zero-terminated.
sl@0: @param aRowId        The ROWID of the row to which the blob belongs
sl@0: @param aMode		 Specifies the blob access mode, either HBlobBuf::EReadOnly or HBlobBuf::EReadWrite
sl@0: 
sl@0: @leave KErrNoMemory, An out of memory condition has occurred;
sl@0:                      Note that the function may also leave with some other system wide errors or 
sl@0:                      database specific errors categorised as ESqlDbError.
sl@0: 
sl@0: @return A pointer to the created HBlobBuf instance
sl@0:                      
sl@0: @panic SqlDb 4 In _DEBUG mode. NULL aDb parameter.
sl@0: @panic SqlDb 4 In _DEBUG mode. Negative or zero aRowId.
sl@0: @panic SqlDb 4 In _DEBUG mode. aMode parameter is not HBlobBuf::EReadOnly or HBlobBuf::EReadWrite.
sl@0: */
sl@0: HBlobBuf* HBlobBuf::NewL(sqlite3* aDb, const TDesC8& aDbName, const TDesC8& aTableName, const TDesC8& aColumnName, TInt64 aRowId, TMode aMode)
sl@0: 	{
sl@0: 	__SQLTRACE_BLOBVAR(TBuf<100> des16prnbuf);
sl@0: 	SQL_TRACE_BLOB(OstTraceExt4(TRACE_INTERNALS, HBLOBBUF_NEWL_ENTRY1, "Entry;0;HBlobBuf::NewL;sqlite3*=0x%X;aDbName=%s;aRowId=%lld;aMode=%d", (TUint)aDb, __SQLPRNSTR8(aDbName, des16prnbuf), aRowId, (TInt)aMode));
sl@0: 	SQL_TRACE_BLOB(OstTraceExt1(TRACE_INTERNALS, HBLOBBUF_NEWL_ENTRY2, "Entry;0;HBlobBuf::NewL;aTableName=%s", __SQLPRNSTR8(aTableName, des16prnbuf)));
sl@0: 	SQL_TRACE_BLOB(OstTraceExt1(TRACE_INTERNALS, HBLOBBUF_NEWL_ENTRY3, "Entry;0;HBlobBuf::NewL;aColumnName=%s", __SQLPRNSTR8(aColumnName, des16prnbuf)));
sl@0: 	__ASSERT_DEBUG(aDb != NULL, __SQLPANIC2(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(aRowId > 0, __SQLPANIC2(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(aMode == HBlobBuf::EReadOnly || aMode == HBlobBuf::EReadWrite, __SQLPANIC2(ESqlPanicBadArgument));
sl@0: 	
sl@0: 	HBlobBuf* self = new (ELeave) HBlobBuf;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aDb, aDbName, aTableName, aColumnName, aRowId, aMode);
sl@0: 	CleanupStack::Pop(self);
sl@0: 	SQL_TRACE_BLOB(OstTraceExt2(TRACE_INTERNALS, HBLOBBUF_NEWL_EXIT, "Exit;0x%X;HBlobBuf::NewL;sqlite3_blob*=0x%X", (TUint)self, (TUint)self->iBlobHandle));
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Initializes HBlobBuf data members with their default values.
sl@0: */
sl@0: HBlobBuf::HBlobBuf() :
sl@0: 	iBlobHandle(NULL),
sl@0: 	iWrPos(KMinTInt),
sl@0: 	iRdPos(KMinTInt)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Initializes a new HBlobBuf instance.
sl@0: 
sl@0: @param aDb 			 The database handle
sl@0: @param aDbName 		 The database name, zero-terminated. If the blob belongs to one of the attached databases, 
sl@0: 					 then the attached database name should be used as a value of aDbName, otherwise the
sl@0: 					 value should be "main"
sl@0: @param aTableName    The name of the table to which the blob belongs, zero-terminated.
sl@0: @param aColumnName   The name of the blob column, zero-terminated.
sl@0: @param aRowId        The ROWID of the row to which the blob belongs
sl@0: @param aMode		 Specifies the blob access mode, either HBlobBuf::EReadOnly or HBlobBuf::EReadWrite
sl@0: 
sl@0: @leave KErrNoMemory, 	An out of memory condition has occurred;
sl@0:                      	Note that the function may also leave with some other system wide errors or 
sl@0:                     	database specific errors categorised as ESqlDbError.
sl@0:                      
sl@0: @panic SqlDb 4 In _DEBUG mode. NULL aDb parameter.
sl@0: @panic SqlDb 4 In _DEBUG mode. Negative or zero aRowId.
sl@0: @panic SqlDb 4 In _DEBUG mode. aMode parameter is not HBlobBuf::EReadOnly or HBlobBuf::EReadWrite.
sl@0: @panic SqlDb 7 In _DEBUG mode. NULL blob handle.
sl@0: */
sl@0: void HBlobBuf::ConstructL(sqlite3* aDb, const TDesC8& aDbName, const TDesC8& aTableName, const TDesC8& aColumnName, TInt64 aRowId, TMode aMode)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aDb != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(aRowId > 0, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(aMode == HBlobBuf::EReadOnly || aMode == HBlobBuf::EReadWrite, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	
sl@0: 	(void)sqlite3SymbianLastOsError();//clear last OS error
sl@0: 			
sl@0: 	TInt err = sqlite3_blob_open(aDb, (const char*)aDbName.Ptr(), (const char*)aTableName.Ptr(), (const char*)aColumnName.Ptr(), 
sl@0: 								 aRowId, aMode & HBlobBuf::EReadWrite, &iBlobHandle);
sl@0: 	__SQLLEAVE_IF_ERROR(::Sql2OsErrCode(err, sqlite3SymbianLastOsError()));
sl@0: 	__ASSERT_DEBUG(iBlobHandle != NULL, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	iBlobSize = sqlite3_blob_bytes(iBlobHandle);
sl@0: 	iWrPos = iRdPos = 0;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Closes the blob handle as part of the HBlobBuf object being destroyed.
sl@0: */
sl@0: void HBlobBuf::DoRelease()
sl@0: 	{
sl@0: 	SQL_TRACE_BLOB(OstTraceExt2(TRACE_INTERNALS, HBLOBBUF_DORELEASE_ENTRY, "Entry;0x%X;HBlobBuf::DoRelease;sqlite3_blob*=0x%X", (TUint)this, (TUint)iBlobHandle));
sl@0: 	TRAPD(err, DoSynchL());
sl@0: 	SQL_TRACE_BLOB(OstTraceExt2(TRACE_INTERNALS, HBLOBBUF_DORELEASE_EXIT, "Exit;0x%X;HBlobBuf::DoRelease;err=%d", (TUint)this, err));
sl@0:     UNUSED_VAR(err);
sl@0:     }
sl@0: 	
sl@0: /**
sl@0: Closes the blob handle.
sl@0: Any buffered data is delivered to the stream.
sl@0: */	
sl@0: void HBlobBuf::DoSynchL()
sl@0: 	{
sl@0: 	if(iBlobHandle)
sl@0: 		{
sl@0: 		TInt err = sqlite3_blob_close(iBlobHandle);
sl@0: 		SQL_TRACE_BLOB(OstTraceExt2(TRACE_INTERNALS, HBLOBBUF_DOSYNCHL, "0x%X;HBlobBuf::DoSynchL;err=%d", (TUint)this, err));
sl@0: 		iBlobHandle = NULL; // the close is unconditional, even if an error occurs
sl@0: 		__SQLLEAVE_IF_ERROR(::Sql2OsErrCode(err, sqlite3SymbianLastOsError()));
sl@0: 		}	
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Reads a data block from the blob with the specified length.
sl@0: 
sl@0: @param aPtr Pointer to the location where the blob data will be copied
sl@0: @param aMaxLength The length of the data block to be read
sl@0: 
sl@0: @leave KErrNoMemory,  An out of memory condition has occurred;
sl@0:        KErrEof, 	  An attempt has been made to read beyond the end of the blob;
sl@0:        KErrBadHandle, NULL blob handle;
sl@0:                       Note that the function may also leave with some other system 
sl@0:                       wide errors or database specific errors categorised as ESqlDbError.
sl@0: 
sl@0: @return The number of bytes read.
sl@0: 
sl@0: @panic SqlDb 4 In _DEBUG mode. NULL aPtr parameter.
sl@0: @panic SqlDb 4 In _DEBUG mode. Negative aMaxLength parameter.
sl@0: @panic SqlDb 2 In _DEBUG mode. NULL iBlobHandle.
sl@0: */
sl@0: TInt HBlobBuf::DoReadL(TAny* aPtr, TInt aMaxLength)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aPtr != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(aMaxLength >= 0, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(iBlobHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	
sl@0: 	SQL_TRACE_BLOB(OstTraceExt5(TRACE_INTERNALS, HBLOBBUF_DOREADL, "0x%X;HBlobBuf::DoReadL;aMaxLength=%d;iBlobSize=%d;iWrPos=%d;iRdPos=%d", (TUint)this, aMaxLength, iBlobSize, iWrPos, iRdPos));
sl@0: 	
sl@0: 	if(aMaxLength <= 0)
sl@0: 		{
sl@0: 		return 0;	
sl@0: 		}
sl@0: 	
sl@0: 	(void)sqlite3SymbianLastOsError();//clear last OS error
sl@0: 	
sl@0: 	if(iRdPos >= iBlobSize)
sl@0: 		{
sl@0: 		__SQLLEAVE(KErrEof);	
sl@0: 		}
sl@0: 	if((aMaxLength + iRdPos) > iBlobSize)
sl@0: 		{
sl@0: 		aMaxLength = iBlobSize - iRdPos;
sl@0: 		}
sl@0: 	TInt err = sqlite3_blob_read(BlobHandleL(), aPtr, aMaxLength, iRdPos);
sl@0: 	__SQLLEAVE_IF_ERROR(::Sql2OsErrCode(err, sqlite3SymbianLastOsError()));
sl@0: 	iRdPos += aMaxLength;
sl@0: 	return aMaxLength;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Writes a data block with the specified length to the blob.
sl@0: 
sl@0: @param aPtr Pointer to the location with the blob data to be written
sl@0: @param aLength The length of the data block to be written
sl@0: 
sl@0: @leave KErrNoMemory,  An out of memory condition has occurred;
sl@0:        KErrEof,       An attempt has been made to write beyond the end of the blob;
sl@0:        KErrBadHandle, NULL blob handle;
sl@0:                       Note that the function may also leave with some other system 
sl@0:                       wide errors or database specific errors categorised as ESqlDbError.
sl@0: 
sl@0: @panic SqlDb 4 In _DEBUG mode. NULL aPtr parameter.
sl@0: @panic SqlDb 4 In _DEBUG mode. Negative aLength parameter.
sl@0: @panic SqlDb 2 In _DEBUG mode. NULL iBlobHandle.
sl@0: */
sl@0: void HBlobBuf::DoWriteL(const TAny* aPtr, TInt aLength)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aPtr != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(aLength >= 0, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(iBlobHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	
sl@0: 	SQL_TRACE_BLOB(OstTraceExt5(TRACE_INTERNALS, HBLOBBUF_DOWRITEL, "0x%X;HBlobBuf::DoWriteL;aLength=%d;iBlobSize=%d;iWrPos=%d;iRdPos=%d", (TUint)this, aLength, iBlobSize, iWrPos, iRdPos));
sl@0: 	
sl@0: 	if(aLength <= 0)
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 		
sl@0: 	if((iWrPos + aLength) > iBlobSize)
sl@0: 		{
sl@0: 		__SQLLEAVE(KErrEof);
sl@0: 		}
sl@0: 
sl@0: 	(void)sqlite3SymbianLastOsError();//clear last OS error
sl@0: 	TInt err = sqlite3_blob_write(BlobHandleL(), aPtr, aLength, iWrPos);
sl@0: 	err = ::Sql2OsErrCode(err, sqlite3SymbianLastOsError());
sl@0: 	
sl@0: 	__SQLLEAVE_IF_ERROR(err);
sl@0: 	iWrPos += aLength;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Positions the mark(s) indicated by aMark at aOffset from aLocation.
sl@0: 
sl@0: @leave KErrEof,       An attempt has been made to seek beyond the end of the blob;
sl@0: 	   KErrBadHandle, NULL blob handle;
sl@0:                       Note that the function may also leave with some other system wide errors or 
sl@0:                       database specific errors categorised as ESqlDbError.
sl@0: 
sl@0: @return The new stream position (read or write)
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. NULL iBlobHandle.
sl@0: @panic SqlDb 4 In _DEBUG mode. Negative aOffset parameter.
sl@0: @panic SqlDb 8 In _DEBUG mode. Invalid aMark parameter.
sl@0: @panic SqlDb 9 In _DEBUG mode. Invalid aLocation parameter.
sl@0: */
sl@0: TStreamPos HBlobBuf::DoSeekL(MStreamBuf::TMark aMark, TStreamLocation aLocation, TInt aOffset)
sl@0: 	{
sl@0: 	SQL_TRACE_BLOB(OstTraceExt5(TRACE_INTERNALS, HBLOBBUF_DOSEEKL, "0x%X;HBlobBuf::DoSeekL;aMark=%d;aLocation=%d;aOffset=%d;iBlobSize=%d", (TUint)this, (TInt)aMark, (TInt)aLocation, aOffset, iBlobSize));
sl@0: 	__ASSERT_ALWAYS(!(aMark & ~(ERead | EWrite)), __SQLPANIC(ESqlPanicStreamMarkInvalid));
sl@0: 	__ASSERT_DEBUG(aOffset >= 0, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(iBlobHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	
sl@0: 	TInt newPos = 0;
sl@0: 	switch(aLocation)
sl@0: 		{
sl@0: 	case EStreamBeginning:
sl@0: 		newPos = aOffset;
sl@0: 		break;
sl@0: 	case EStreamMark:
sl@0: 		newPos = (aMark & MStreamBuf::EWrite ? iWrPos : iRdPos) + aOffset;
sl@0: 		break;
sl@0: 	case EStreamEnd:
sl@0: 		newPos = iBlobSize + aOffset;
sl@0: 		break;
sl@0: 	default:
sl@0: 		__ASSERT_DEBUG(0, __SQLPANIC(ESqlPanicStreamLocationInvalid));
sl@0: 		newPos = -1;
sl@0: 		break;
sl@0: 		}
sl@0: 	if(newPos < 0 || newPos > iBlobSize)
sl@0: 		{
sl@0: 		__SQLLEAVE(KErrEof);
sl@0: 		}
sl@0: 	if(aMark & MStreamBuf::EWrite)
sl@0: 		{
sl@0: 		iWrPos = newPos;
sl@0: 		}
sl@0: 	else if(aMark & MStreamBuf::ERead)
sl@0: 		{
sl@0: 		iRdPos = newPos;	
sl@0: 		}
sl@0: 	return TStreamPos(newPos);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the blob handle, if it is not NULL.
sl@0: 
sl@0: @leave KErrBadHandle, The blob handle is NULL.
sl@0: 
sl@0: @return The blob handle
sl@0: */
sl@0: sqlite3_blob* HBlobBuf::BlobHandleL()
sl@0: 	{
sl@0: 	if(!iBlobHandle)
sl@0: 		{
sl@0: 		__SQLLEAVE(KErrBadHandle);
sl@0: 		}
sl@0: 	return iBlobHandle;
sl@0: 	}