/*

* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Container store implementation.

*

*/

// ========

// INCLUDES

// ========

#include <bautils.h>

#include "ContainerStore.h"

#include "ContainerStoreContainersTable.h"

#include "ContainerStoreContentManager.h"

#include "ContainerStoreDefs.h"

#include "ContainerStoreDeleteHandler.h"

#include "ContainerStoreEncryption.h"

#include "ContainerStoreGeneralTable.h"

#include "ContainerStoreAccountTable.h"

#include "ContainerStoreSortingTable.h"

#include "ContainerStoreUtils.h"

#include "MsgStoreSortResultRowSet.h"

#include "PropertiesSerializer.h"

#include "ContainerStoreSearchHandler.h"

#include "ContainerStoreSearchResultTable.h"

#include "MessageStoreEncryptHandler.h"

#include "ContainerStoreMRUAddressTable.h"

// =========

// CONSTANTS

// =========

_LIT8( KNullDes, "" );

// The maximum recursion depth for the recursive copy function.

const TUint KMaxRecursionDepth = 40;

// Priorities, in descending order.

const TInt KSearchPriorityOffset     = 0;

const TInt KEncryptPriorityOffset    = -1;

const TInt KDeletePriorityOffset     = -2;

const TInt KCompactionPriorityOffset = -3;

void RMsgStoreSortableFields::Close()

    {

    iSubject.Close();

    iFrom.Close();

    iTo.Close();

    }

// ======================

// METHOD IMPLEMENTATIONS

// ======================

// ==========================================================================

// FUNCTION: NewL

// ==========================================================================

CContainerStore* CContainerStore::NewL( const TDesC&                   aDbFilename,

									    TDriveNumber                   aDriveNumber, 

									    MCustomBehaviorProvider&       aCustomBehaviorProvider,

									    MBackgroundOperationsObserver& aBackgroundOperationsObserver, 

									    TInt                           aBasePriority )

	{

    CContainerStore* self = new( ELeave ) CContainerStore( aCustomBehaviorProvider, 

    													   aBasePriority );

    CleanupStack::PushL( self );

    self->ConstructL( aDbFilename, aBackgroundOperationsObserver, aDriveNumber );

    CleanupStack::Pop( self );

    return self;

	} // end NewL

// ==========================================================================

// FUNCTION: Constructor

// ==========================================================================

CContainerStore::CContainerStore( MCustomBehaviorProvider& aCustomBehaviorProvider, 

								  TInt                     aBasePriority ) :

	iCustomBehaviorProvider( aCustomBehaviorProvider ),

	iBasePriority( aBasePriority ),

    iNextSortSessionId( 0 )

	{

	__LOG_CONSTRUCT( "msg", "CContainerStore" )

	} // end Constructor

// ==========================================================================

// FUNCTION: ConstructL

// ==========================================================================

void CContainerStore::ConstructL( const TDesC&                   aDbFilename,

							      MBackgroundOperationsObserver& aBackgroundOperationsObserver,

                                  TDriveNumber                   aDriveNumber )

	{

	__LOG_ENTER( "ConstructL" )

    TUint quickPropertiesLength;

    iCustomBehaviorProvider.LengthsL( iCountsLength, quickPropertiesLength );

    iQuickProperties.CreateL( quickPropertiesLength );

	iTotalCountsDelta.CreateL( iCountsLength );

	iDeleteHandler = CDeleteHandler::NewL( *this, 

	                                       aBackgroundOperationsObserver, 

	                                       iBasePriority + KDeletePriorityOffset );

	iUtils = CContainerStoreUtils::NewL( aDriveNumber, 

	                                     iBasePriority + KCompactionPriorityOffset, 

	                                     aDbFilename,

	                                     *iDeleteHandler );

	iEncryption = CContainerStoreEncryption::NewL();

	// Open an existing database.

    TRAPD( err, iUtils->OpenDatabaseL(); OpenTablesL() );

	switch( err )

		{

		case KErrNone:

            // Success!  Nothing else to do.            

			break;

		case KErrPathNotFound: // private path does not yet exist

		case KErrNotFound:     // file not found, table not found

		case KErrEof:          // something is wrong with the file

		case KErrCorrupt:      // schema version mismatch

			__LOG_WRITE8_FORMAT1_ERROR( "open failed (%i), recreating database", err );

			CloseTables();

	        iUtils->CloseDatabaseL();

			// Unable to open the database. Create a new database.

    		iUtils->CreateDatabaseL();

    		CreateTablesL();

			break;

		default:

			// Something unexpected has occurred.

			__LOG_WRITE8_FORMAT1_ERROR( "unable to open database (%i)", err );			

			User::Leave( err );

			break;

		}; // end switch

    iEncryptHandler = CMessageStoreEncryptHandler::NewL( *iGeneralTable, *iUtils, iBasePriority + KEncryptPriorityOffset );

    iEncryptHandler->AddEncryptableTableL( this );

    iEncryptHandler->AddEncryptableTableL( iAccountTable );

    iEncryptHandler->AddEncryptableTableL( iSortingTable );

    iEncryptHandler->AddEncryptableTableL( iMruAddressTable );

    iEncryptHandler->StartL();

    iEncryption->SetAuthenticationRequired( iGeneralTable->IsAuthenticateRequiredL() );

	iEncryption->SetEncryptionFlag( iGeneralTable->IsEncryptionOnL() );

    //Initialize the MRU address list

    //It leaves if the DB is not authenticated, so trap it and ignore it

    TRAP_IGNORE( iMruAddressTable->InitializeIfNeededL() );

	iContentManager = CContainerStoreContentManager::NewL( *iUtils, *iEncryption );

	// Cleanup any uncommitted containers.

	MarkUncommittedContainersForDeleteL();

	// Start the background delete operation.

	iDeleteHandler->Start();

    // Read the total counts.

	iTotalCounts.CreateL( iCountsLength );

	__LOG_EXIT

	} // end ConstructL

// ==========================================================================

// FUNCTION: Destructor

// ==========================================================================

CContainerStore::~CContainerStore()

	{

	delete iDeleteHandler;

    for ( int i = 0 ; i < iSortSessions.Count() ; i++ )

        {

        delete iSortSessions[i].iResultRowSet;

        }

    iSortSessions.Close();

    CloseTables();

    if ( iUtils )

        {

        TRAP_IGNORE( iUtils->CloseDatabaseL() );

        }

    delete iEncryptHandler;

	delete iContentManager;

	delete iEncryption;

	delete iUtils;

	iObservers.Close();

	iHierarchy.Close();

	iQuickProperties.Close();

	iTotalCountsDelta.Close();

	iTotalCounts.Close();

	__LOG_DESTRUCT	

	} // end destructor

// ==========================================================================

// FUNCTION: WipeEverything

// ==========================================================================

TInt CContainerStore::WipeEverything( const TDesC& aDbFilename,

									  TDriveNumber aDriveNumber )

    {    

    RFs fs;

    TInt result = fs.Connect();

    if( result == KErrNone )

        {

        fs.SetSessionToPrivate( aDriveNumber );

        // Wipe the database file.

        BaflUtils::DeleteFile( fs, aDbFilename );

        // Wipe the content files.

        CContainerStoreContentManager::WipeContentFiles( fs );

        fs.Close();

        } // end if	

    return result;        

    } // end WipeEverything

// ==========================================================================

// FUNCTION: CreateTablesL

// ==========================================================================

void CContainerStore::CreateTablesL()

	{

	__LOG_ENTER( "CreateTablesL" )

	iUtils->BeginDatabaseTransactionLC();

	delete iGeneralTable;

	iGeneralTable = NULL;

	iGeneralTable = CContainerStoreGeneralTable::CreateL( *iUtils );		

	delete iAccountTable;

	iAccountTable = NULL;

	iAccountTable = CContainerStoreAccountTable::CreateL( *iUtils, *iEncryption, iCustomBehaviorProvider );		

	delete iContainersTable;

	iContainersTable = NULL;

	iContainersTable = CContainerStoreContainersTable::CreateL( *iUtils, iCustomBehaviorProvider, iCountsLength, *iEncryption );

	delete iSortingTable;

	iSortingTable = NULL;

	iSortingTable = CContainerStoreSortingTable::CreateL( *iUtils, *iEncryption, *this );

    delete iSearchResultTable;

    iSearchResultTable = NULL;

    iSearchResultTable = CContainerStoreSearchResultTable::CreateL( *iUtils );

    delete iMruAddressTable;

    iMruAddressTable = NULL;

    iMruAddressTable = CContainerStoreMruAddressTable::CreateL( *iUtils, *iEncryption, *iGeneralTable, *iAccountTable );

	iUtils->CommitDatabaseTransactionL();

	__LOG_EXIT

	} // end CreateTablesL

// ==========================================================================

// FUNCTION: OpenTablesL

// ==========================================================================

void CContainerStore::OpenTablesL()

	{

	__LOG_ENTER( "OpenTablesL" )

	delete iGeneralTable;

    iGeneralTable = NULL;

	iGeneralTable = CContainerStoreGeneralTable::OpenL( *iUtils );		

	delete iAccountTable;

	iAccountTable = NULL;

	iAccountTable = CContainerStoreAccountTable::OpenL( *iUtils, *iEncryption, iCustomBehaviorProvider );		

	delete iContainersTable;

	iContainersTable = NULL;

	iContainersTable = CContainerStoreContainersTable::OpenL( *iUtils, iCustomBehaviorProvider, iCountsLength, *iEncryption );

	delete iSortingTable;

	iSortingTable = NULL;

	iSortingTable = CContainerStoreSortingTable::OpenL( *iUtils, *iEncryption, *this );

    delete iSearchResultTable;

    iSearchResultTable = NULL;

    iSearchResultTable = CContainerStoreSearchResultTable::OpenL( *iUtils );

    delete iMruAddressTable;

    iMruAddressTable = NULL;

    iMruAddressTable = CContainerStoreMruAddressTable::OpenL( *iUtils, *iEncryption, *iGeneralTable, *iAccountTable );

	__LOG_EXIT

	} // end OpenTablesL

// ==========================================================================

// FUNCTION: CloseTables

// ==========================================================================

void CContainerStore::CloseTables()

	{

	__LOG_ENTER( "CloseTables" )

	delete iAccountTable;

	iAccountTable = NULL;

	delete iGeneralTable;

	iGeneralTable = NULL;

	delete iContainersTable;

	iContainersTable = NULL;

	delete iSortingTable;

	iSortingTable = NULL;

    delete iSearchResultTable;

    iSearchResultTable = NULL;

    delete iMruAddressTable;

    iMruAddressTable = NULL;

	__LOG_EXIT

	} // end CloseTables

// ==========================================================================

// FUNCTION: ObserveL

// ==========================================================================

void CContainerStore::ObserveL( MContainerStoreObserver* aObserver )

	{

	__LOG_ENTER( "ObserverL" )

	iObservers.AppendL( aObserver );

	__LOG_EXIT

	} // end ObserveL

// ==========================================================================

// FUNCTION: StopObserving

// ==========================================================================

void CContainerStore::StopObserving( MContainerStoreObserver* aObserver )

	{

	__LOG_ENTER( "StopObserving" )

	TBool found = EFalse;

	TInt index = 0;

	while( !found && index < iObservers.Count() )

		{

		if( iObservers[index] == aObserver )

			{

			found = ETrue;

			iObservers.Remove( index );

			}

		else

			{

			index++;

			} // end if		

		} // end while

    __LOG_EXIT		

	} // end StopObservingL

// ==========================================================================

// FUNCTION: NotifyObservers

// ==========================================================================

void CContainerStore::NotifyObservers( MContainerStoreObserver::TOperation aOperation,

									   const RArray<TContainerId>&         aHierarchy,

									   const TDesC8&                       aQuickProperties,

									   MContainerStoreObserver* 		   aDoNotNotify,

									   TContainerId                        aOtherId )		

	{

	__LOG_ENTER_SUPPRESS( "NotifyObservers" )

	if ( aHierarchy.Count() > 1 )

	    {

	__LOG_WRITE8_FORMAT4_INFO( "op=%i id=%x pid=%x otherid=%x", aOperation, aHierarchy[0], aHierarchy[1], aOtherId );

	    }

	// if aDoNotNotify is NULL or if the operation was for an uncommitted object then suppress this

	// notification entirely.

	if( aDoNotNotify && aHierarchy[aHierarchy.Count()-1] != KUncommittedContainers )

	    {	    

    	for( TInt index = 0; index < iObservers.Count(); index++ )

    		{

    		if( iObservers[index] != aDoNotNotify )

    			{

    			__LOG_WRITE8_FORMAT1_INFO( "Notifying observer %i", index );

    			iObservers[index]->ContainerModified( aOperation, aHierarchy, aOtherId, aQuickProperties );			

    			} // end if

    		} // end for

	    } // end if

    __LOG_EXIT	    

	} // end NotifyObservers

// ==========================================================================

// FUNCTION: NotifyObservers

// ==========================================================================

void CContainerStore::NotifyObservers( TBool aAuthenticated )

    {

	__LOG_ENTER_SUPPRESS( "NotifyObservers" )

    __LOG_WRITE8_FORMAT1_INFO( "authenticated=%i", aAuthenticated )

	for( TInt index = 0; index < iObservers.Count(); index++ )

		{

		iObservers[index]->AuthenticationChanged( aAuthenticated );

		} // end for

    __LOG_EXIT		

    } // end NotifyObservers

void CContainerStore::NotifyObservers( MContainerStoreObserver::TOperation aOperation,

									   TInt32 aOwnerId,

									   const TDesC8& aName,

									   const TDesC8& aNewName,

                                       TContainerId  aMailboxId,

									   MContainerStoreObserver* aDoNotNotify )

	{

	__LOG_ENTER_SUPPRESS( "NotifyObservers" )

	__LOG_WRITE8_FORMAT4_INFO( "op=%i id=%x name=%S newName=%S", aOperation, aOwnerId, &aName, &aNewName );

	if( aDoNotNotify )

		{

		for( TInt index = 0; index < iObservers.Count(); index++ )

			{

    		if( iObservers[index] != aDoNotNotify )

    			{

    			__LOG_WRITE8_FORMAT1_INFO( "Notifying observer %i", index );

    			iObservers[index]->AccountModified(  aOperation, aOwnerId, aName, aNewName, aMailboxId );

    			}

			} // end for

		}

    __LOG_EXIT		

	}

// ==========================================================================

// FUNCTION: CreatePredefinedContainerIfNeededL

// ==========================================================================

void CContainerStore::CreatePredefinedContainerIfNeededL( TContainerId  aId,

														  TContainerId  aType,

														  TContainerId  aParentId, 

														  const TDesC8& aProperties )

	{

	__LOG_ENTER_SUPPRESS( "CreatePredefinedContainerIfNeededL" )

	__LOG_WRITE8_FORMAT3_INFO( "id=%x type=%x pid=%x", aId, aType, aParentId )

	TRAPD( result, iContainersTable->SeekL( aId ) );

	if( result == KErrNotFound )

		{

		aId = aId | aType;

		iUtils->BeginDatabaseTransactionLC();	

		iContainersTable->CreateContainerL( aId, aParentId, aProperties, iQuickProperties );		

		iUtils->CommitDatabaseTransactionL();

		} // end if

	__LOG_EXIT

	} // end CreatePredefinedContainerIfNeededL

// ==========================================================================

// FUNCTION: Authenticated

// ==========================================================================

TBool CContainerStore::Authenticated()

    {

    return iEncryption->Authenticated();

    } // end Authenticated

// ==========================================================================

// FUNCTION: AuthenticateL

// ==========================================================================

TBool CContainerStore::AuthenticateL( const TDesC& aPassword )

	{

	__LOG_ENTER( "AuthenticateL" )

	CContainerStoreUtils::LeaveIfFalse( iEncryption->IsAuthenticationRequired(), KErrNotSupported );

    RBuf8 buffer;

    CleanupClosePushL( buffer );